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