src/allmydata/web/directory.py

   1
   2 import simplejson
   3 import urllib
   4
   5 from zope.interface import implements
   6 from twisted.internet import defer
   7 from twisted.internet.interfaces import IPushProducer
   8 from twisted.python.failure import Failure
   9 from twisted.web import http, html
  10 from nevow import url, rend, inevow, tags as T
  11 from nevow.inevow import IRequest
  12
  13 from foolscap.api import fireEventually
  14
  15 from allmydata.util import base32, time_format
  16 from allmydata.uri import from_string_dirnode, is_writeable_directory_uri
  17 from allmydata.interfaces import IDirectoryNode, IFileNode, IFilesystemNode, \
  18      IImmutableFileNode, IMutableFileNode, ExistingChildError, \
  19      NoSuchChildError, EmptyPathnameComponentError, SDMF_VERSION, MDMF_VERSION
  20 from allmydata.blacklist import ProhibitedNode
  21 from allmydata.monitor import Monitor, OperationCancelledError
  22 from allmydata import dirnode
  23 from allmydata.web.common import text_plain, WebError, \
  24      IOpHandleTable, NeedOperationHandleError, \
  25      boolean_of_arg, get_arg, get_root, parse_replace_arg, \
  26      should_create_intermediate_directories, \
  27      getxmlfile, RenderMixin, humanize_failure, convert_children_json, \
  28      get_format, get_mutable_type
  29 from allmydata.web.filenode import ReplaceMeMixin, \
  30      FileNodeHandler, PlaceHolderNodeHandler
  31 from allmydata.web.check_results import CheckResultsRenderer, \
  32      CheckAndRepairResultsRenderer, DeepCheckResultsRenderer, \
  33      DeepCheckAndRepairResultsRenderer, LiteralCheckResultsRenderer
  34 from allmydata.web.info import MoreInfo
  35 from allmydata.web.operations import ReloadMixin
  36 from allmydata.web.check_results import json_check_results, \
  37      json_check_and_repair_results
  38
  39 class BlockingFileError(Exception):
  40     # TODO: catch and transform
  41     """We cannot auto-create a parent directory, because there is a file in
  42     the way"""
  43
  44 def make_handler_for(node, client, parentnode=None, name=None):
  45     if parentnode:
  46         assert IDirectoryNode.providedBy(parentnode)
  47     if IFileNode.providedBy(node):
  48         return FileNodeHandler(client, node, parentnode, name)
  49     if IDirectoryNode.providedBy(node):
  50         return DirectoryNodeHandler(client, node, parentnode, name)
  51     return UnknownNodeHandler(client, node, parentnode, name)
  52
  53 class DirectoryNodeHandler(RenderMixin, rend.Page, ReplaceMeMixin):
  54     addSlash = True
  55
  56     def __init__(self, client, node, parentnode=None, name=None):
  57         rend.Page.__init__(self)
  58         self.client = client
  59         assert node
  60         self.node = node
  61         self.parentnode = parentnode
  62         self.name = name
  63
  64     def childFactory(self, ctx, name):
  65         name = name.decode("utf-8")
  66         if not name:
  67             raise EmptyPathnameComponentError()
  68         d = self.node.get(name)
  69         d.addBoth(self.got_child, ctx, name)
  70         # got_child returns a handler resource: FileNodeHandler or
  71         # DirectoryNodeHandler
  72         return d
  73
  74     def got_child(self, node_or_failure, ctx, name):
  75         DEBUG = False
  76         if DEBUG: print "GOT_CHILD", name, node_or_failure
  77         req = IRequest(ctx)
  78         method = req.method
  79         nonterminal = len(req.postpath) > 1
  80         t = get_arg(req, "t", "").strip()
  81         if isinstance(node_or_failure, Failure):
  82             f = node_or_failure
  83             f.trap(NoSuchChildError)
  84             # No child by this name. What should we do about it?
  85             if DEBUG: print "no child", name
  86             if DEBUG: print "postpath", req.postpath
  87             if nonterminal:
  88                 if DEBUG: print " intermediate"
  89                 if should_create_intermediate_directories(req):
  90                     # create intermediate directories
  91                     if DEBUG: print " making intermediate directory"
  92                     d = self.node.create_subdirectory(name)
  93                     d.addCallback(make_handler_for,
  94                                   self.client, self.node, name)
  95                     return d
  96             else:
  97                 if DEBUG: print " terminal"
  98                 # terminal node
  99                 if (method,t) in [ ("POST","mkdir"), ("PUT","mkdir"),
 100                                    ("POST", "mkdir-with-children"),
 101                                    ("POST", "mkdir-immutable") ]:
 102                     if DEBUG: print " making final directory"
 103                     # final directory
 104                     kids = {}
 105                     if t in ("mkdir-with-children", "mkdir-immutable"):
 106                         req.content.seek(0)
 107                         kids_json = req.content.read()
 108                         kids = convert_children_json(self.client.nodemaker,
 109                                                      kids_json)
 110                     file_format = get_format(req, None)
 111                     mutable = True
 112                     mt = get_mutable_type(file_format)
 113                     if t == "mkdir-immutable":
 114                         mutable = False
 115
 116                     d = self.node.create_subdirectory(name, kids,
 117                                                       mutable=mutable,
 118                                                       mutable_version=mt)
 119                     d.addCallback(make_handler_for,
 120                                   self.client, self.node, name)
 121                     return d
 122                 if (method,t) in ( ("PUT",""), ("PUT","uri"), ):
 123                     if DEBUG: print " PUT, making leaf placeholder"
 124                     # we were trying to find the leaf filenode (to put a new
 125                     # file in its place), and it didn't exist. That's ok,
 126                     # since that's the leaf node that we're about to create.
 127                     # We make a dummy one, which will respond to the PUT
 128                     # request by replacing itself.
 129                     return PlaceHolderNodeHandler(self.client, self.node, name)
 130             if DEBUG: print " 404"
 131             # otherwise, we just return a no-such-child error
 132             return f
 133
 134         node = node_or_failure
 135         if nonterminal and should_create_intermediate_directories(req):
 136             if not IDirectoryNode.providedBy(node):
 137                 # we would have put a new directory here, but there was a
 138                 # file in the way.
 139                 if DEBUG: print "blocking"
 140                 raise WebError("Unable to create directory '%s': "
 141                                "a file was in the way" % name,
 142                                http.CONFLICT)
 143         if DEBUG: print "good child"
 144         return make_handler_for(node, self.client, self.node, name)
 145
 146     def render_DELETE(self, ctx):
 147         assert self.parentnode and self.name
 148         d = self.parentnode.delete(self.name)
 149         d.addCallback(lambda res: self.node.get_uri())
 150         return d
 151
 152     def render_GET(self, ctx):
 153         req = IRequest(ctx)
 154         # This is where all of the directory-related ?t=* code goes.
 155         t = get_arg(req, "t", "").strip()
 156         if not t:
 157             # render the directory as HTML, using the docFactory and Nevow's
 158             # whole templating thing.
 159             return DirectoryAsHTML(self.node,
 160                                    self.client.mutable_file_default)
 161
 162         if t == "json":
 163             return DirectoryJSONMetadata(ctx, self.node)
 164         if t == "info":
 165             return MoreInfo(self.node)
 166         if t == "uri":
 167             return DirectoryURI(ctx, self.node)
 168         if t == "readonly-uri":
 169             return DirectoryReadonlyURI(ctx, self.node)
 170         if t == 'rename-form':
 171             return RenameForm(self.node)
 172         if t == 'move-form':
 173             return MoveForm(self.node)
 174
 175         raise WebError("GET directory: bad t=%s" % t)
 176
 177     def render_PUT(self, ctx):
 178         req = IRequest(ctx)
 179         t = get_arg(req, "t", "").strip()
 180         replace = parse_replace_arg(get_arg(req, "replace", "true"))
 181
 182         if t == "mkdir":
 183             # our job was done by the traversal/create-intermediate-directory
 184             # process that got us here.
 185             return text_plain(self.node.get_uri(), ctx) # TODO: urlencode
 186         if t == "uri":
 187             if not replace:
 188                 # they're trying to set_uri and that name is already occupied
 189                 # (by us).
 190                 raise ExistingChildError()
 191             d = self.replace_me_with_a_childcap(req, self.client, replace)
 192             # TODO: results
 193             return d
 194
 195         raise WebError("PUT to a directory")
 196
 197     def render_POST(self, ctx):
 198         req = IRequest(ctx)
 199         t = get_arg(req, "t", "").strip()
 200
 201         if t == "mkdir":
 202             d = self._POST_mkdir(req)
 203         elif t == "mkdir-with-children":
 204             d = self._POST_mkdir_with_children(req)
 205         elif t == "mkdir-immutable":
 206             d = self._POST_mkdir_immutable(req)
 207         elif t == "mkdir-p":
 208             # TODO: docs, tests
 209             d = self._POST_mkdir_p(req)
 210         elif t == "upload":
 211             d = self._POST_upload(ctx) # this one needs the context
 212         elif t == "uri":
 213             d = self._POST_uri(req)
 214         elif t == "delete" or t == "unlink":
 215             d = self._POST_unlink(req)
 216         elif t == "rename":
 217             d = self._POST_rename(req)
 218         elif t == "move":
 219             d = self._POST_move(req)
 220         elif t == "check":
 221             d = self._POST_check(req)
 222         elif t == "start-deep-check":
 223             d = self._POST_start_deep_check(ctx)
 224         elif t == "stream-deep-check":
 225             d = self._POST_stream_deep_check(ctx)
 226         elif t == "start-manifest":
 227             d = self._POST_start_manifest(ctx)
 228         elif t == "start-deep-size":
 229             d = self._POST_start_deep_size(ctx)
 230         elif t == "start-deep-stats":
 231             d = self._POST_start_deep_stats(ctx)
 232         elif t == "stream-manifest":
 233             d = self._POST_stream_manifest(ctx)
 234         elif t == "set_children" or t == "set-children":
 235             d = self._POST_set_children(req)
 236         else:
 237             raise WebError("POST to a directory with bad t=%s" % t)
 238
 239         when_done = get_arg(req, "when_done", None)
 240         if when_done:
 241             d.addCallback(lambda res: url.URL.fromString(when_done))
 242         return d
 243
 244     def _POST_mkdir(self, req):
 245         name = get_arg(req, "name", "")
 246         if not name:
 247             # our job is done, it was handled by the code in got_child
 248             # which created the final directory (i.e. us)
 249             return defer.succeed(self.node.get_uri()) # TODO: urlencode
 250         name = name.decode("utf-8")
 251         replace = boolean_of_arg(get_arg(req, "replace", "true"))
 252         kids = {}
 253         mt = get_mutable_type(get_format(req, None))
 254         d = self.node.create_subdirectory(name, kids, overwrite=replace,
 255                                           mutable_version=mt)
 256         d.addCallback(lambda child: child.get_uri()) # TODO: urlencode
 257         return d
 258
 259     def _POST_mkdir_with_children(self, req):
 260         name = get_arg(req, "name", "")
 261         if not name:
 262             # our job is done, it was handled by the code in got_child
 263             # which created the final directory (i.e. us)
 264             return defer.succeed(self.node.get_uri()) # TODO: urlencode
 265         name = name.decode("utf-8")
 266         # TODO: decide on replace= behavior, see #903
 267         #replace = boolean_of_arg(get_arg(req, "replace", "false"))
 268         req.content.seek(0)
 269         kids_json = req.content.read()
 270         kids = convert_children_json(self.client.nodemaker, kids_json)
 271         mt = get_mutable_type(get_format(req, None))
 272         d = self.node.create_subdirectory(name, kids, overwrite=False,
 273                                           mutable_version=mt)
 274         d.addCallback(lambda child: child.get_uri()) # TODO: urlencode
 275         return d
 276
 277     def _POST_mkdir_immutable(self, req):
 278         name = get_arg(req, "name", "")
 279         if not name:
 280             # our job is done, it was handled by the code in got_child
 281             # which created the final directory (i.e. us)
 282             return defer.succeed(self.node.get_uri()) # TODO: urlencode
 283         name = name.decode("utf-8")
 284         # TODO: decide on replace= behavior, see #903
 285         #replace = boolean_of_arg(get_arg(req, "replace", "false"))
 286         req.content.seek(0)
 287         kids_json = req.content.read()
 288         kids = convert_children_json(self.client.nodemaker, kids_json)
 289         d = self.node.create_subdirectory(name, kids, overwrite=False, mutable=False)
 290         d.addCallback(lambda child: child.get_uri()) # TODO: urlencode
 291         return d
 292
 293     def _POST_mkdir_p(self, req):
 294         path = get_arg(req, "path")
 295         if not path:
 296             raise WebError("mkdir-p requires a path")
 297         path_ = tuple([seg.decode("utf-8") for seg in path.split('/') if seg ])
 298         # TODO: replace
 299         d = self._get_or_create_directories(self.node, path_)
 300         d.addCallback(lambda node: node.get_uri())
 301         return d
 302
 303     def _get_or_create_directories(self, node, path):
 304         if not IDirectoryNode.providedBy(node):
 305             # unfortunately it is too late to provide the name of the
 306             # blocking directory in the error message.
 307             raise BlockingFileError("cannot create directory because there "
 308                                     "is a file in the way")
 309         if not path:
 310             return defer.succeed(node)
 311         d = node.get(path[0])
 312         def _maybe_create(f):
 313             f.trap(NoSuchChildError)
 314             return node.create_subdirectory(path[0])
 315         d.addErrback(_maybe_create)
 316         d.addCallback(self._get_or_create_directories, path[1:])
 317         return d
 318
 319     def _POST_upload(self, ctx):
 320         req = IRequest(ctx)
 321         charset = get_arg(req, "_charset", "utf-8")
 322         contents = req.fields["file"]
 323         assert contents.filename is None or isinstance(contents.filename, str)
 324         name = get_arg(req, "name")
 325         name = name or contents.filename
 326         if name is not None:
 327             name = name.strip()
 328         if not name:
 329             # this prohibts empty, missing, and all-whitespace filenames
 330             raise WebError("upload requires a name")
 331         assert isinstance(name, str)
 332         name = name.decode(charset)
 333         if "/" in name:
 334             raise WebError("name= may not contain a slash", http.BAD_REQUEST)
 335         assert isinstance(name, unicode)
 336
 337         # since POST /uri/path/file?t=upload is equivalent to
 338         # POST /uri/path/dir?t=upload&name=foo, just do the same thing that
 339         # childFactory would do. Things are cleaner if we only do a subset of
 340         # them, though, so we don't do: d = self.childFactory(ctx, name)
 341
 342         d = self.node.get(name)
 343         def _maybe_got_node(node_or_failure):
 344             if isinstance(node_or_failure, Failure):
 345                 f = node_or_failure
 346                 f.trap(NoSuchChildError)
 347                 # create a placeholder which will see POST t=upload
 348                 return PlaceHolderNodeHandler(self.client, self.node, name)
 349             else:
 350                 node = node_or_failure
 351                 return make_handler_for(node, self.client, self.node, name)
 352         d.addBoth(_maybe_got_node)
 353         # now we have a placeholder or a filenodehandler, and we can just
 354         # delegate to it. We could return the resource back out of
 355         # DirectoryNodeHandler.renderHTTP, and nevow would recurse into it,
 356         # but the addCallback() that handles when_done= would break.
 357         d.addCallback(lambda child: child.renderHTTP(ctx))
 358         return d
 359
 360     def _POST_uri(self, req):
 361         childcap = get_arg(req, "uri")
 362         if not childcap:
 363             raise WebError("set-uri requires a uri")
 364         name = get_arg(req, "name")
 365         if not name:
 366             raise WebError("set-uri requires a name")
 367         charset = get_arg(req, "_charset", "utf-8")
 368         name = name.decode(charset)
 369         replace = boolean_of_arg(get_arg(req, "replace", "true"))
 370
 371         # We mustn't pass childcap for the readcap argument because we don't
 372         # know whether it is a read cap. Passing a read cap as the writecap
 373         # argument will work (it ends up calling NodeMaker.create_from_cap,
 374         # which derives a readcap if necessary and possible).
 375         d = self.node.set_uri(name, childcap, None, overwrite=replace)
 376         d.addCallback(lambda res: childcap)
 377         return d
 378
 379     def _POST_unlink(self, req):
 380         name = get_arg(req, "name")
 381         if name is None:
 382             # apparently an <input type="hidden" name="name" value="">
 383             # won't show up in the resulting encoded form.. the 'name'
 384             # field is completely missing. So to allow unlinking of a
 385             # child with a name that is the empty string, we have to
 386             # pretend that None means ''. The only downside of this is
 387             # a slightly confusing error message if someone does a POST
 388             # without a name= field. For our own HTML this isn't a big
 389             # deal, because we create the 'unlink' POST buttons ourselves.
 390             name = ''
 391         charset = get_arg(req, "_charset", "utf-8")
 392         name = name.decode(charset)
 393         d = self.node.delete(name)
 394         d.addCallback(lambda res: "thing unlinked")
 395         return d
 396
 397     def _POST_rename(self, req):
 398         charset = get_arg(req, "_charset", "utf-8")
 399         from_name = get_arg(req, "from_name")
 400         if from_name is not None:
 401             from_name = from_name.strip()
 402             from_name = from_name.decode(charset)
 403             assert isinstance(from_name, unicode)
 404         to_name = get_arg(req, "to_name")
 405         if to_name is not None:
 406             to_name = to_name.strip()
 407             to_name = to_name.decode(charset)
 408             assert isinstance(to_name, unicode)
 409         if not from_name or not to_name:
 410             raise WebError("rename requires from_name and to_name")
 411         if from_name == to_name:
 412             return defer.succeed("redundant rename")
 413
 414         # allow from_name to contain slashes, so they can fix names that were
 415         # accidentally created with them. But disallow them in to_name, to
 416         # discourage the practice.
 417         if "/" in to_name:
 418             raise WebError("to_name= may not contain a slash", http.BAD_REQUEST)
 419
 420         replace = boolean_of_arg(get_arg(req, "replace", "true"))
 421         d = self.node.move_child_to(from_name, self.node, to_name, replace)
 422         d.addCallback(lambda res: "thing renamed")
 423         return d
 424
 425     def _POST_move(self, req):
 426         charset = get_arg(req, "_charset", "utf-8")
 427         from_name = get_arg(req, "from_name")
 428         if from_name is not None:
 429             from_name = from_name.strip()
 430             from_name = from_name.decode(charset)
 431             assert isinstance(from_name, unicode)
 432         to_name = get_arg(req, "to_name")
 433         if to_name is not None:
 434             to_name = to_name.strip()
 435             to_name = to_name.decode(charset)
 436             assert isinstance(to_name, unicode)
 437         if not to_name:
 438             to_name = from_name
 439         to_dir = get_arg(req, "to_dir")
 440         if to_dir is not None:
 441             to_dir = to_dir.strip()
 442             to_dir = to_dir.decode(charset)
 443             assert isinstance(to_dir, unicode)
 444         if not from_name or not to_dir:
 445             raise WebError("move requires from_name and to_dir")
 446         replace = boolean_of_arg(get_arg(req, "replace", "true"))
 447
 448         # allow from_name to contain slashes, so they can fix names that
 449         # were accidentally created with them. But disallow them in to_name
 450         # (if it's specified), to discourage the practice.
 451         if to_name and "/" in to_name:
 452             raise WebError("to_name= may not contain a slash", http.BAD_REQUEST)
 453
 454         d = self.node.has_child(to_dir.split('/')[0])
 455         def get_target_node(isname):
 456             if isname or not is_writeable_directory_uri(str(to_dir)):
 457                 return self.node.get_child_at_path(to_dir)
 458             else:
 459                 return self.client.create_node_from_uri(str(to_dir))
 460         d.addCallback(get_target_node)
 461         def is_target_node_usable(target_node):
 462             if not IDirectoryNode.providedBy(target_node):
 463                 raise WebError("to_dir is not a usable directory", http.GONE)
 464             return target_node
 465         d.addCallback(is_target_node_usable)
 466         d.addCallback(lambda new_parent: self.node.move_child_to(
 467                       from_name, new_parent, to_name, replace))
 468         d.addCallback(lambda res: "thing moved")
 469         return d
 470
 471     def _maybe_literal(self, res, Results_Class):
 472         if res:
 473             return Results_Class(self.client, res)
 474         return LiteralCheckResultsRenderer(self.client)
 475
 476     def _POST_check(self, req):
 477         # check this directory
 478         verify = boolean_of_arg(get_arg(req, "verify", "false"))
 479         repair = boolean_of_arg(get_arg(req, "repair", "false"))
 480         add_lease = boolean_of_arg(get_arg(req, "add-lease", "false"))
 481         if repair:
 482             d = self.node.check_and_repair(Monitor(), verify, add_lease)
 483             d.addCallback(self._maybe_literal, CheckAndRepairResultsRenderer)
 484         else:
 485             d = self.node.check(Monitor(), verify, add_lease)
 486             d.addCallback(self._maybe_literal, CheckResultsRenderer)
 487         return d
 488
 489     def _start_operation(self, monitor, renderer, ctx):
 490         table = IOpHandleTable(ctx)
 491         table.add_monitor(ctx, monitor, renderer)
 492         return table.redirect_to(ctx)
 493
 494     def _POST_start_deep_check(self, ctx):
 495         # check this directory and everything reachable from it
 496         if not get_arg(ctx, "ophandle"):
 497             raise NeedOperationHandleError("slow operation requires ophandle=")
 498         verify = boolean_of_arg(get_arg(ctx, "verify", "false"))
 499         repair = boolean_of_arg(get_arg(ctx, "repair", "false"))
 500         add_lease = boolean_of_arg(get_arg(ctx, "add-lease", "false"))
 501         if repair:
 502             monitor = self.node.start_deep_check_and_repair(verify, add_lease)
 503             renderer = DeepCheckAndRepairResultsRenderer(self.client, monitor)
 504         else:
 505             monitor = self.node.start_deep_check(verify, add_lease)
 506             renderer = DeepCheckResultsRenderer(self.client, monitor)
 507         return self._start_operation(monitor, renderer, ctx)
 508
 509     def _POST_stream_deep_check(self, ctx):
 510         verify = boolean_of_arg(get_arg(ctx, "verify", "false"))
 511         repair = boolean_of_arg(get_arg(ctx, "repair", "false"))
 512         add_lease = boolean_of_arg(get_arg(ctx, "add-lease", "false"))
 513         walker = DeepCheckStreamer(ctx, self.node, verify, repair, add_lease)
 514         monitor = self.node.deep_traverse(walker)
 515         walker.setMonitor(monitor)
 516         # register to hear stopProducing. The walker ignores pauseProducing.
 517         IRequest(ctx).registerProducer(walker, True)
 518         d = monitor.when_done()
 519         def _done(res):
 520             IRequest(ctx).unregisterProducer()
 521             return res
 522         d.addBoth(_done)
 523         def _cancelled(f):
 524             f.trap(OperationCancelledError)
 525             return "Operation Cancelled"
 526         d.addErrback(_cancelled)
 527         def _error(f):
 528             # signal the error as a non-JSON "ERROR:" line, plus exception
 529             msg = "ERROR: %s(%s)\n" % (f.value.__class__.__name__,
 530                                        ", ".join([str(a) for a in f.value.args]))
 531             msg += str(f)
 532             return msg
 533         d.addErrback(_error)
 534         return d
 535
 536     def _POST_start_manifest(self, ctx):
 537         if not get_arg(ctx, "ophandle"):
 538             raise NeedOperationHandleError("slow operation requires ophandle=")
 539         monitor = self.node.build_manifest()
 540         renderer = ManifestResults(self.client, monitor)
 541         return self._start_operation(monitor, renderer, ctx)
 542
 543     def _POST_start_deep_size(self, ctx):
 544         if not get_arg(ctx, "ophandle"):
 545             raise NeedOperationHandleError("slow operation requires ophandle=")
 546         monitor = self.node.start_deep_stats()
 547         renderer = DeepSizeResults(self.client, monitor)
 548         return self._start_operation(monitor, renderer, ctx)
 549
 550     def _POST_start_deep_stats(self, ctx):
 551         if not get_arg(ctx, "ophandle"):
 552             raise NeedOperationHandleError("slow operation requires ophandle=")
 553         monitor = self.node.start_deep_stats()
 554         renderer = DeepStatsResults(self.client, monitor)
 555         return self._start_operation(monitor, renderer, ctx)
 556
 557     def _POST_stream_manifest(self, ctx):
 558         walker = ManifestStreamer(ctx, self.node)
 559         monitor = self.node.deep_traverse(walker)
 560         walker.setMonitor(monitor)
 561         # register to hear stopProducing. The walker ignores pauseProducing.
 562         IRequest(ctx).registerProducer(walker, True)
 563         d = monitor.when_done()
 564         def _done(res):
 565             IRequest(ctx).unregisterProducer()
 566             return res
 567         d.addBoth(_done)
 568         def _cancelled(f):
 569             f.trap(OperationCancelledError)
 570             return "Operation Cancelled"
 571         d.addErrback(_cancelled)
 572         def _error(f):
 573             # signal the error as a non-JSON "ERROR:" line, plus exception
 574             msg = "ERROR: %s(%s)\n" % (f.value.__class__.__name__,
 575                                        ", ".join([str(a) for a in f.value.args]))
 576             msg += str(f)
 577             return msg
 578         d.addErrback(_error)
 579         return d
 580
 581     def _POST_set_children(self, req):
 582         replace = boolean_of_arg(get_arg(req, "replace", "true"))
 583         req.content.seek(0)
 584         body = req.content.read()
 585         try:
 586             children = simplejson.loads(body)
 587         except ValueError, le:
 588             le.args = tuple(le.args + (body,))
 589             # TODO test handling of bad JSON
 590             raise
 591         cs = {}
 592         for name, (file_or_dir, mddict) in children.iteritems():
 593             name = unicode(name) # simplejson-2.0.1 returns str *or* unicode
 594             writecap = mddict.get('rw_uri')
 595             if writecap is not None:
 596                 writecap = str(writecap)
 597             readcap = mddict.get('ro_uri')
 598             if readcap is not None:
 599                 readcap = str(readcap)
 600             cs[name] = (writecap, readcap, mddict.get('metadata'))
 601         d = self.node.set_children(cs, replace)
 602         d.addCallback(lambda res: "Okay so I did it.")
 603         # TODO: results
 604         return d
 605
 606 def abbreviated_dirnode(dirnode):
 607     u = from_string_dirnode(dirnode.get_uri())
 608     return u.abbrev_si()
 609
 610 SPACE = u"\u00A0"*2
 611
 612 class DirectoryAsHTML(rend.Page):
 613     # The remainder of this class is to render the directory into
 614     # human+browser -oriented HTML.
 615     docFactory = getxmlfile("directory.xhtml")
 616     addSlash = True
 617
 618     def __init__(self, node, default_mutable_format):
 619         rend.Page.__init__(self)
 620         self.node = node
 621
 622         assert default_mutable_format in (MDMF_VERSION, SDMF_VERSION)
 623         self.default_mutable_format = default_mutable_format
 624
 625     def beforeRender(self, ctx):
 626         # attempt to get the dirnode's children, stashing them (or the
 627         # failure that results) for later use
 628         d = self.node.list()
 629         def _good(children):
 630             # Deferreds don't optimize out tail recursion, and the way
 631             # Nevow's flattener handles Deferreds doesn't take this into
 632             # account. As a result, large lists of Deferreds that fire in the
 633             # same turn (i.e. the output of defer.succeed) will cause a stack
 634             # overflow. To work around this, we insert a turn break after
 635             # every 100 items, using foolscap's fireEventually(). This gives
 636             # the stack a chance to be popped. It would also work to put
 637             # every item in its own turn, but that'd be a lot more
 638             # inefficient. This addresses ticket #237, for which I was never
 639             # able to create a failing unit test.
 640             output = []
 641             for i,item in enumerate(sorted(children.items())):
 642                 if i % 100 == 0:
 643                     output.append(fireEventually(item))
 644                 else:
 645                     output.append(item)
 646             self.dirnode_children = output
 647             return ctx
 648         def _bad(f):
 649             text, code = humanize_failure(f)
 650             self.dirnode_children = None
 651             self.dirnode_children_error = text
 652             return ctx
 653         d.addCallbacks(_good, _bad)
 654         return d
 655
 656     def render_title(self, ctx, data):
 657         si_s = abbreviated_dirnode(self.node)
 658         header = ["Tahoe-LAFS - Directory SI=%s" % si_s]
 659         if self.node.is_unknown():
 660             header.append(" (unknown)")
 661         elif not self.node.is_mutable():
 662             header.append(" (immutable)")
 663         elif self.node.is_readonly():
 664             header.append(" (read-only)")
 665         else:
 666             header.append(" (modifiable)")
 667         return ctx.tag[header]
 668
 669     def render_header(self, ctx, data):
 670         si_s = abbreviated_dirnode(self.node)
 671         header = ["Tahoe-LAFS Directory SI=", T.span(class_="data-chars")[si_s]]
 672         if self.node.is_unknown():
 673             header.append(" (unknown)")
 674         elif not self.node.is_mutable():
 675             header.append(" (immutable)")
 676         elif self.node.is_readonly():
 677             header.append(" (read-only)")
 678         return ctx.tag[header]
 679
 680     def render_welcome(self, ctx, data):
 681         link = get_root(ctx)
 682         return ctx.tag[T.a(href=link)["Return to Welcome page"]]
 683
 684     def render_show_readonly(self, ctx, data):
 685         if self.node.is_unknown() or self.node.is_readonly():
 686             return ""
 687         rocap = self.node.get_readonly_uri()
 688         root = get_root(ctx)
 689         uri_link = "%s/uri/%s/" % (root, urllib.quote(rocap))
 690         return ctx.tag[T.a(href=uri_link)["Read-Only Version"]]
 691
 692     def render_try_children(self, ctx, data):
 693         # if the dirnode can be retrived, render a table of children.
 694         # Otherwise, render an apologetic error message.
 695         if self.dirnode_children is not None:
 696             return ctx.tag
 697         else:
 698             return T.div[T.p["Error reading directory:"],
 699                          T.p[self.dirnode_children_error]]
 700
 701     def data_children(self, ctx, data):
 702         return self.dirnode_children
 703
 704     def render_row(self, ctx, data):
 705         name, (target, metadata) = data
 706         name = name.encode("utf-8")
 707         assert not isinstance(name, unicode)
 708         nameurl = urllib.quote(name, safe="") # encode any slashes too
 709
 710         root = get_root(ctx)
 711         here = "%s/uri/%s/" % (root, urllib.quote(self.node.get_uri()))
 712         if self.node.is_unknown() or self.node.is_readonly():
 713             unlink = "-"
 714             rename = "-"
 715             move = "-"
 716         else:
 717             # this creates a button which will cause our _POST_unlink method
 718             # to be invoked, which unlinks the file and then redirects the
 719             # browser back to this directory
 720             unlink = T.form(action=here, method="post")[
 721                 T.input(type='hidden', name='t', value='unlink'),
 722                 T.input(type='hidden', name='name', value=name),
 723                 T.input(type='hidden', name='when_done', value="."),
 724                 T.input(type='submit', value='unlink', name="unlink"),
 725                 ]
 726
 727             rename = T.form(action=here, method="get")[
 728                 T.input(type='hidden', name='t', value='rename-form'),
 729                 T.input(type='hidden', name='name', value=name),
 730                 T.input(type='hidden', name='when_done', value="."),
 731                 T.input(type='submit', value='rename', name="rename"),
 732                 ]
 733
 734             move = T.form(action=here, method="get")[
 735                 T.input(type='hidden', name='t', value='move-form'),
 736                 T.input(type='hidden', name='name', value=name),
 737                 T.input(type='hidden', name='when_done', value="."),
 738                 T.input(type='submit', value='move', name="move"),
 739                 ]
 740
 741         ctx.fillSlots("unlink", unlink)
 742         ctx.fillSlots("rename", rename)
 743         ctx.fillSlots("move", move)
 744
 745         times = []
 746         linkcrtime = metadata.get('tahoe', {}).get("linkcrtime")
 747         if linkcrtime is not None:
 748             times.append("lcr: " + time_format.iso_local(linkcrtime))
 749         else:
 750             # For backwards-compatibility with links last modified by Tahoe < 1.4.0:
 751             if "ctime" in metadata:
 752                 ctime = time_format.iso_local(metadata["ctime"])
 753                 times.append("c: " + ctime)
 754         linkmotime = metadata.get('tahoe', {}).get("linkmotime")
 755         if linkmotime is not None:
 756             if times:
 757                 times.append(T.br())
 758             times.append("lmo: " + time_format.iso_local(linkmotime))
 759         else:
 760             # For backwards-compatibility with links last modified by Tahoe < 1.4.0:
 761             if "mtime" in metadata:
 762                 mtime = time_format.iso_local(metadata["mtime"])
 763                 if times:
 764                     times.append(T.br())
 765                 times.append("m: " + mtime)
 766         ctx.fillSlots("times", times)
 767
 768         assert IFilesystemNode.providedBy(target), target
 769         target_uri = target.get_uri() or ""
 770         quoted_uri = urllib.quote(target_uri, safe="") # escape slashes too
 771
 772         if IMutableFileNode.providedBy(target):
 773             # to prevent javascript in displayed .html files from stealing a
 774             # secret directory URI from the URL, send the browser to a URI-based
 775             # page that doesn't know about the directory at all
 776             dlurl = "%s/file/%s/@@named=/%s" % (root, quoted_uri, nameurl)
 777
 778             ctx.fillSlots("filename",
 779                           T.a(href=dlurl)[html.escape(name)])
 780             ctx.fillSlots("type", "SSK")
 781
 782             ctx.fillSlots("size", "?")
 783
 784             info_link = "%s/uri/%s?t=info" % (root, quoted_uri)
 785
 786         elif IImmutableFileNode.providedBy(target):
 787             dlurl = "%s/file/%s/@@named=/%s" % (root, quoted_uri, nameurl)
 788
 789             ctx.fillSlots("filename",
 790                           T.a(href=dlurl)[html.escape(name)])
 791             ctx.fillSlots("type", "FILE")
 792
 793             ctx.fillSlots("size", target.get_size())
 794
 795             info_link = "%s/uri/%s?t=info" % (root, quoted_uri)
 796
 797         elif IDirectoryNode.providedBy(target):
 798             # directory
 799             uri_link = "%s/uri/%s/" % (root, urllib.quote(target_uri))
 800             ctx.fillSlots("filename",
 801                           T.a(href=uri_link)[html.escape(name)])
 802             if not target.is_mutable():
 803                 dirtype = "DIR-IMM"
 804             elif target.is_readonly():
 805                 dirtype = "DIR-RO"
 806             else:
 807                 dirtype = "DIR"
 808             ctx.fillSlots("type", dirtype)
 809             ctx.fillSlots("size", "-")
 810             info_link = "%s/uri/%s/?t=info" % (root, quoted_uri)
 811
 812         elif isinstance(target, ProhibitedNode):
 813             ctx.fillSlots("filename", T.strike[name])
 814             if IDirectoryNode.providedBy(target.wrapped_node):
 815                 blacklisted_type = "DIR-BLACKLISTED"
 816             else:
 817                 blacklisted_type = "BLACKLISTED"
 818             ctx.fillSlots("type", blacklisted_type)
 819             ctx.fillSlots("size", "-")
 820             info_link = None
 821             ctx.fillSlots("info", ["Access Prohibited:", T.br, target.reason])
 822
 823         else:
 824             # unknown
 825             ctx.fillSlots("filename", html.escape(name))
 826             if target.get_write_uri() is not None:
 827                 unknowntype = "?"
 828             elif not self.node.is_mutable() or target.is_alleged_immutable():
 829                 unknowntype = "?-IMM"
 830             else:
 831                 unknowntype = "?-RO"
 832             ctx.fillSlots("type", unknowntype)
 833             ctx.fillSlots("size", "-")
 834             # use a directory-relative info link, so we can extract both the
 835             # writecap and the readcap
 836             info_link = "%s?t=info" % urllib.quote(name)
 837
 838         if info_link:
 839             ctx.fillSlots("info", T.a(href=info_link)["More Info"])
 840
 841         return ctx.tag
 842
 843     # XXX: similar to render_upload_form and render_mkdir_form in root.py.
 844     def render_forms(self, ctx, data):
 845         forms = []
 846
 847         if self.node.is_readonly():
 848             return T.div["No upload forms: directory is read-only"]
 849         if self.dirnode_children is None:
 850             return T.div["No upload forms: directory is unreadable"]
 851
 852         mkdir_sdmf = T.input(type='radio', name='format',
 853                              value='sdmf', id='mkdir-sdmf',
 854                              checked='checked')
 855         mkdir_mdmf = T.input(type='radio', name='format',
 856                              value='mdmf', id='mkdir-mdmf')
 857
 858         mkdir_form = T.form(action=".", method="post",
 859                             enctype="multipart/form-data")[
 860             T.fieldset[
 861             T.input(type="hidden", name="t", value="mkdir"),
 862             T.input(type="hidden", name="when_done", value="."),
 863             T.legend(class_="freeform-form-label")["Create a new directory in this directory"],
 864             "New directory name:"+SPACE,
 865             T.input(type="text", name="name"), SPACE,
 866             T.input(type="submit", value="Create"), SPACE*2,
 867             mkdir_sdmf, T.label(for_='mutable-directory-sdmf')[" SDMF"], SPACE,
 868             mkdir_mdmf, T.label(for_='mutable-directory-mdmf')[" MDMF (experimental)"],
 869             ]]
 870         forms.append(T.div(class_="freeform-form")[mkdir_form])
 871
 872         upload_chk  = T.input(type='radio', name='format',
 873                               value='chk', id='upload-chk',
 874                               checked='checked')
 875         upload_sdmf = T.input(type='radio', name='format',
 876                               value='sdmf', id='upload-sdmf')
 877         upload_mdmf = T.input(type='radio', name='format',
 878                               value='mdmf', id='upload-mdmf')
 879
 880         upload_form = T.form(action=".", method="post",
 881                              enctype="multipart/form-data")[
 882             T.fieldset[
 883             T.input(type="hidden", name="t", value="upload"),
 884             T.input(type="hidden", name="when_done", value="."),
 885             T.legend(class_="freeform-form-label")["Upload a file to this directory"],
 886             "Choose a file to upload:"+SPACE,
 887             T.input(type="file", name="file", class_="freeform-input-file"), SPACE,
 888             T.input(type="submit", value="Upload"),                          SPACE*2,
 889             upload_chk,  T.label(for_="upload-chk") [" Immutable"],          SPACE,
 890             upload_sdmf, T.label(for_="upload-sdmf")[" SDMF"],               SPACE,
 891             upload_mdmf, T.label(for_="upload-mdmf")[" MDMF (experimental)"],
 892             ]]
 893         forms.append(T.div(class_="freeform-form")[upload_form])
 894
 895         attach_form = T.form(action=".", method="post",
 896                              enctype="multipart/form-data")[
 897             T.fieldset[
 898             T.input(type="hidden", name="t", value="uri"),
 899             T.input(type="hidden", name="when_done", value="."),
 900             T.legend(class_="freeform-form-label")["Add a link to a file or directory which is already in Tahoe-LAFS."],
 901             "New child name:"+SPACE,
 902             T.input(type="text", name="name"), SPACE*2,
 903             "URI of new child:"+SPACE,
 904             T.input(type="text", name="uri"), SPACE,
 905             T.input(type="submit", value="Attach"),
 906             ]]
 907         forms.append(T.div(class_="freeform-form")[attach_form])
 908         return forms
 909
 910     def render_results(self, ctx, data):
 911         req = IRequest(ctx)
 912         return get_arg(req, "results", "")
 913
 914
 915 def DirectoryJSONMetadata(ctx, dirnode):
 916     d = dirnode.list()
 917     def _got(children):
 918         kids = {}
 919         for name, (childnode, metadata) in children.iteritems():
 920             assert IFilesystemNode.providedBy(childnode), childnode
 921             rw_uri = childnode.get_write_uri()
 922             ro_uri = childnode.get_readonly_uri()
 923             if IFileNode.providedBy(childnode):
 924                 kiddata = ("filenode", {'size': childnode.get_size(),
 925                                         'mutable': childnode.is_mutable(),
 926                                         })
 927                 if childnode.is_mutable():
 928                     mutable_type = childnode.get_version()
 929                     assert mutable_type in (SDMF_VERSION, MDMF_VERSION)
 930                     if mutable_type == MDMF_VERSION:
 931                         file_format = "MDMF"
 932                     else:
 933                         file_format = "SDMF"
 934                 else:
 935                     file_format = "CHK"
 936                 kiddata[1]['format'] = file_format
 937
 938             elif IDirectoryNode.providedBy(childnode):
 939                 kiddata = ("dirnode", {'mutable': childnode.is_mutable()})
 940             else:
 941                 kiddata = ("unknown", {})
 942
 943             kiddata[1]["metadata"] = metadata
 944             if rw_uri:
 945                 kiddata[1]["rw_uri"] = rw_uri
 946             if ro_uri:
 947                 kiddata[1]["ro_uri"] = ro_uri
 948             verifycap = childnode.get_verify_cap()
 949             if verifycap:
 950                 kiddata[1]['verify_uri'] = verifycap.to_string()
 951
 952             kids[name] = kiddata
 953
 954         drw_uri = dirnode.get_write_uri()
 955         dro_uri = dirnode.get_readonly_uri()
 956         contents = { 'children': kids }
 957         if dro_uri:
 958             contents['ro_uri'] = dro_uri
 959         if drw_uri:
 960             contents['rw_uri'] = drw_uri
 961         verifycap = dirnode.get_verify_cap()
 962         if verifycap:
 963             contents['verify_uri'] = verifycap.to_string()
 964         contents['mutable'] = dirnode.is_mutable()
 965         data = ("dirnode", contents)
 966         json = simplejson.dumps(data, indent=1) + "\n"
 967         return json
 968     d.addCallback(_got)
 969     d.addCallback(text_plain, ctx)
 970     return d
 971
 972
 973 def DirectoryURI(ctx, dirnode):
 974     return text_plain(dirnode.get_uri(), ctx)
 975
 976 def DirectoryReadonlyURI(ctx, dirnode):
 977     return text_plain(dirnode.get_readonly_uri(), ctx)
 978
 979 class RenameForm(rend.Page):
 980     addSlash = True
 981     docFactory = getxmlfile("rename-form.xhtml")
 982
 983     def render_title(self, ctx, data):
 984         return ctx.tag["Directory SI=%s" % abbreviated_dirnode(self.original)]
 985
 986     def render_header(self, ctx, data):
 987         header = ["Rename "
 988                   "in directory SI=%s" % abbreviated_dirnode(self.original),
 989                   ]
 990
 991         if self.original.is_readonly():
 992             header.append(" (readonly!)")
 993         header.append(":")
 994         return ctx.tag[header]
 995
 996     def render_when_done(self, ctx, data):
 997         return T.input(type="hidden", name="when_done", value=".")
 998
 999     def render_get_name(self, ctx, data):
1000         req = IRequest(ctx)
1001         name = get_arg(req, "name", "")
1002         ctx.tag.attributes['value'] = name
1003         return ctx.tag
1004
1005 class MoveForm(rend.Page):
1006     addSlash = True
1007     docFactory = getxmlfile("move-form.xhtml")
1008
1009     def render_title(self, ctx, data):
1010         return ctx.tag["Directory SI=%s" % abbreviated_dirnode(self.original)]
1011
1012     def render_header(self, ctx, data):
1013         header = ["Move "
1014                   "from directory SI=%s" % abbreviated_dirnode(self.original),
1015                   ]
1016
1017         if self.original.is_readonly():
1018             header.append(" (readonly!)")
1019         header.append(":")
1020         return ctx.tag[header]
1021
1022     def render_when_done(self, ctx, data):
1023         return T.input(type="hidden", name="when_done", value=".")
1024
1025     def render_get_name(self, ctx, data):
1026         req = IRequest(ctx)
1027         name = get_arg(req, "name", "")
1028         ctx.tag.attributes['value'] = name
1029         return ctx.tag
1030
1031
1032 class ManifestResults(rend.Page, ReloadMixin):
1033     docFactory = getxmlfile("manifest.xhtml")
1034
1035     def __init__(self, client, monitor):
1036         self.client = client
1037         self.monitor = monitor
1038
1039     def renderHTTP(self, ctx):
1040         req = inevow.IRequest(ctx)
1041         output = get_arg(req, "output", "html").lower()
1042         if output == "text":
1043             return self.text(req)
1044         if output == "json":
1045             return self.json(req)
1046         return rend.Page.renderHTTP(self, ctx)
1047
1048     def slashify_path(self, path):
1049         if not path:
1050             return ""
1051         return "/".join([p.encode("utf-8") for p in path])
1052
1053     def text(self, req):
1054         req.setHeader("content-type", "text/plain")
1055         lines = []
1056         is_finished = self.monitor.is_finished()
1057         lines.append("finished: " + {True: "yes", False: "no"}[is_finished])
1058         for (path, cap) in self.monitor.get_status()["manifest"]:
1059             lines.append(self.slashify_path(path) + " " + cap)
1060         return "\n".join(lines) + "\n"
1061
1062     def json(self, req):
1063         req.setHeader("content-type", "text/plain")
1064         m = self.monitor
1065         s = m.get_status()
1066
1067         if m.origin_si:
1068             origin_base32 = base32.b2a(m.origin_si)
1069         else:
1070             origin_base32 = ""
1071         status = { "stats": s["stats"],
1072                    "finished": m.is_finished(),
1073                    "origin": origin_base32,
1074                    }
1075         if m.is_finished():
1076             # don't return manifest/verifycaps/SIs unless the operation is
1077             # done, to save on CPU/memory (both here and in the HTTP client
1078             # who has to unpack the JSON). Tests show that the ManifestWalker
1079             # needs about 1092 bytes per item, the JSON we generate here
1080             # requires about 503 bytes per item, and some internal overhead
1081             # (perhaps transport-layer buffers in twisted.web?) requires an
1082             # additional 1047 bytes per item.
1083             status.update({ "manifest": s["manifest"],
1084                             "verifycaps": [i for i in s["verifycaps"]],
1085                             "storage-index": [i for i in s["storage-index"]],
1086                             })
1087             # simplejson doesn't know how to serialize a set. We use a
1088             # generator that walks the set rather than list(setofthing) to
1089             # save a small amount of memory (4B*len) and a moderate amount of
1090             # CPU.
1091         return simplejson.dumps(status, indent=1)
1092
1093     def _si_abbrev(self):
1094         si = self.monitor.origin_si
1095         if not si:
1096             return "<LIT>"
1097         return base32.b2a(si)[:6]
1098
1099     def render_title(self, ctx):
1100         return T.title["Manifest of SI=%s" % self._si_abbrev()]
1101
1102     def render_header(self, ctx):
1103         return T.p["Manifest of SI=%s" % self._si_abbrev()]
1104
1105     def data_items(self, ctx, data):
1106         return self.monitor.get_status()["manifest"]
1107
1108     def render_row(self, ctx, (path, cap)):
1109         ctx.fillSlots("path", self.slashify_path(path))
1110         root = get_root(ctx)
1111         # TODO: we need a clean consistent way to get the type of a cap string
1112         if cap:
1113             if cap.startswith("URI:CHK") or cap.startswith("URI:SSK"):
1114                 nameurl = urllib.quote(path[-1].encode("utf-8"))
1115                 uri_link = "%s/file/%s/@@named=/%s" % (root, urllib.quote(cap),
1116                                                        nameurl)
1117             else:
1118                 uri_link = "%s/uri/%s" % (root, urllib.quote(cap, safe=""))
1119             ctx.fillSlots("cap", T.a(href=uri_link)[cap])
1120         else:
1121             ctx.fillSlots("cap", "")
1122         return ctx.tag
1123
1124 class DeepSizeResults(rend.Page):
1125     def __init__(self, client, monitor):
1126         self.client = client
1127         self.monitor = monitor
1128
1129     def renderHTTP(self, ctx):
1130         req = inevow.IRequest(ctx)
1131         output = get_arg(req, "output", "html").lower()
1132         req.setHeader("content-type", "text/plain")
1133         if output == "json":
1134             return self.json(req)
1135         # plain text
1136         is_finished = self.monitor.is_finished()
1137         output = "finished: " + {True: "yes", False: "no"}[is_finished] + "\n"
1138         if is_finished:
1139             stats = self.monitor.get_status()
1140             total = (stats.get("size-immutable-files", 0)
1141                      + stats.get("size-mutable-files", 0)
1142                      + stats.get("size-directories", 0))
1143             output += "size: %d\n" % total
1144         return output
1145
1146     def json(self, req):
1147         status = {"finished": self.monitor.is_finished(),
1148                   "size": self.monitor.get_status(),
1149                   }
1150         return simplejson.dumps(status)
1151
1152 class DeepStatsResults(rend.Page):
1153     def __init__(self, client, monitor):
1154         self.client = client
1155         self.monitor = monitor
1156
1157     def renderHTTP(self, ctx):
1158         # JSON only
1159         inevow.IRequest(ctx).setHeader("content-type", "text/plain")
1160         s = self.monitor.get_status().copy()
1161         s["finished"] = self.monitor.is_finished()
1162         return simplejson.dumps(s, indent=1)
1163
1164 class ManifestStreamer(dirnode.DeepStats):
1165     implements(IPushProducer)
1166
1167     def __init__(self, ctx, origin):
1168         dirnode.DeepStats.__init__(self, origin)
1169         self.req = IRequest(ctx)
1170
1171     def setMonitor(self, monitor):
1172         self.monitor = monitor
1173     def pauseProducing(self):
1174         pass
1175     def resumeProducing(self):
1176         pass
1177     def stopProducing(self):
1178         self.monitor.cancel()
1179
1180     def add_node(self, node, path):
1181         dirnode.DeepStats.add_node(self, node, path)
1182         d = {"path": path,
1183              "cap": node.get_uri()}
1184
1185         if IDirectoryNode.providedBy(node):
1186             d["type"] = "directory"
1187         elif IFileNode.providedBy(node):
1188             d["type"] = "file"
1189         else:
1190             d["type"] = "unknown"
1191
1192         v = node.get_verify_cap()
1193         if v:
1194             v = v.to_string()
1195         d["verifycap"] = v or ""
1196
1197         r = node.get_repair_cap()
1198         if r:
1199             r = r.to_string()
1200         d["repaircap"] = r or ""
1201
1202         si = node.get_storage_index()
1203         if si:
1204             si = base32.b2a(si)
1205         d["storage-index"] = si or ""
1206
1207         j = simplejson.dumps(d, ensure_ascii=True)
1208         assert "\n" not in j
1209         self.req.write(j+"\n")
1210
1211     def finish(self):
1212         stats = dirnode.DeepStats.get_results(self)
1213         d = {"type": "stats",
1214              "stats": stats,
1215              }
1216         j = simplejson.dumps(d, ensure_ascii=True)
1217         assert "\n" not in j
1218         self.req.write(j+"\n")
1219         return ""
1220
1221 class DeepCheckStreamer(dirnode.DeepStats):
1222     implements(IPushProducer)
1223
1224     def __init__(self, ctx, origin, verify, repair, add_lease):
1225         dirnode.DeepStats.__init__(self, origin)
1226         self.req = IRequest(ctx)
1227         self.verify = verify
1228         self.repair = repair
1229         self.add_lease = add_lease
1230
1231     def setMonitor(self, monitor):
1232         self.monitor = monitor
1233     def pauseProducing(self):
1234         pass
1235     def resumeProducing(self):
1236         pass
1237     def stopProducing(self):
1238         self.monitor.cancel()
1239
1240     def add_node(self, node, path):
1241         dirnode.DeepStats.add_node(self, node, path)
1242         data = {"path": path,
1243                 "cap": node.get_uri()}
1244
1245         if IDirectoryNode.providedBy(node):
1246             data["type"] = "directory"
1247         elif IFileNode.providedBy(node):
1248             data["type"] = "file"
1249         else:
1250             data["type"] = "unknown"
1251
1252         v = node.get_verify_cap()
1253         if v:
1254             v = v.to_string()
1255         data["verifycap"] = v or ""
1256
1257         r = node.get_repair_cap()
1258         if r:
1259             r = r.to_string()
1260         data["repaircap"] = r or ""
1261
1262         si = node.get_storage_index()
1263         if si:
1264             si = base32.b2a(si)
1265         data["storage-index"] = si or ""
1266
1267         if self.repair:
1268             d = node.check_and_repair(self.monitor, self.verify, self.add_lease)
1269             d.addCallback(self.add_check_and_repair, data)
1270         else:
1271             d = node.check(self.monitor, self.verify, self.add_lease)
1272             d.addCallback(self.add_check, data)
1273         d.addCallback(self.write_line)
1274         return d
1275
1276     def add_check_and_repair(self, crr, data):
1277         data["check-and-repair-results"] = json_check_and_repair_results(crr)
1278         return data
1279
1280     def add_check(self, cr, data):
1281         data["check-results"] = json_check_results(cr)
1282         return data
1283
1284     def write_line(self, data):
1285         j = simplejson.dumps(data, ensure_ascii=True)
1286         assert "\n" not in j
1287         self.req.write(j+"\n")
1288
1289     def finish(self):
1290         stats = dirnode.DeepStats.get_results(self)
1291         d = {"type": "stats",
1292              "stats": stats,
1293              }
1294         j = simplejson.dumps(d, ensure_ascii=True)
1295         assert "\n" not in j
1296         self.req.write(j+"\n")
1297         return ""
1298
1299
1300 class UnknownNodeHandler(RenderMixin, rend.Page):
1301     def __init__(self, client, node, parentnode=None, name=None):
1302         rend.Page.__init__(self)
1303         assert node
1304         self.node = node
1305         self.parentnode = parentnode
1306         self.name = name
1307
1308     def render_GET(self, ctx):
1309         req = IRequest(ctx)
1310         t = get_arg(req, "t", "").strip()
1311         if t == "info":
1312             return MoreInfo(self.node)
1313         if t == "json":
1314             is_parent_known_immutable = self.parentnode and not self.parentnode.is_mutable()
1315             if self.parentnode and self.name:
1316                 d = self.parentnode.get_metadata_for(self.name)
1317             else:
1318                 d = defer.succeed(None)
1319             d.addCallback(lambda md: UnknownJSONMetadata(ctx, self.node, md, is_parent_known_immutable))
1320             return d
1321         raise WebError("GET unknown URI type: can only do t=info and t=json, not t=%s.\n"
1322                        "Using a webapi server that supports a later version of Tahoe "
1323                        "may help." % t)
1324
1325 def UnknownJSONMetadata(ctx, node, edge_metadata, is_parent_known_immutable):
1326     rw_uri = node.get_write_uri()
1327     ro_uri = node.get_readonly_uri()
1328     data = ("unknown", {})
1329     if ro_uri:
1330         data[1]['ro_uri'] = ro_uri
1331     if rw_uri:
1332         data[1]['rw_uri'] = rw_uri
1333         data[1]['mutable'] = True
1334     elif is_parent_known_immutable or node.is_alleged_immutable():
1335         data[1]['mutable'] = False
1336     # else we don't know whether it is mutable.
1337
1338     if edge_metadata is not None:
1339         data[1]['metadata'] = edge_metadata
1340     return text_plain(simplejson.dumps(data, indent=1) + "\n", ctx)