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