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