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