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