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