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