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