src/allmydata/web/directory.py

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