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
  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_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 = parse_replace_arg(get_arg(req, "replace", "true"))
 159
 160         if t == "mkdir":
 161             # our job was done by the traversal/create-intermediate-directory
 162             # process that got us here.
 163             return text_plain(self.node.get_uri(), ctx) # TODO: urlencode
 164         if t == "uri":
 165             if not replace:
 166                 # they're trying to set_uri and that name is already occupied
 167                 # (by us).
 168                 raise ExistingChildError()
 169             d = self.replace_me_with_a_childcap(req, self.client, replace)
 170             # TODO: results
 171             return d
 172
 173         raise WebError("PUT to a directory")
 174
 175     def render_POST(self, ctx):
 176         req = IRequest(ctx)
 177         t = get_arg(req, "t", "").strip()
 178
 179         if t == "mkdir":
 180             d = self._POST_mkdir(req)
 181         elif t == "mkdir-p":
 182             # TODO: docs, tests
 183             d = self._POST_mkdir_p(req)
 184         elif t == "upload":
 185             d = self._POST_upload(ctx) # this one needs the context
 186         elif t == "uri":
 187             d = self._POST_uri(req)
 188         elif t == "delete":
 189             d = self._POST_delete(req)
 190         elif t == "rename":
 191             d = self._POST_rename(req)
 192         elif t == "check":
 193             d = self._POST_check(req)
 194         elif t == "start-deep-check":
 195             d = self._POST_start_deep_check(ctx)
 196         elif t == "stream-deep-check":
 197             d = self._POST_stream_deep_check(ctx)
 198         elif t == "start-manifest":
 199             d = self._POST_start_manifest(ctx)
 200         elif t == "start-deep-size":
 201             d = self._POST_start_deep_size(ctx)
 202         elif t == "start-deep-stats":
 203             d = self._POST_start_deep_stats(ctx)
 204         elif t == "stream-manifest":
 205             d = self._POST_stream_manifest(ctx)
 206         elif t == "set_children":
 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, 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             writecap = mddict.get('rw_uri')
 474             if writecap is not None:
 475                 writecap = str(writecap)
 476             readcap = mddict.get('ro_uri')
 477             if readcap is not None:
 478                 readcap = str(readcap)
 479             cs[name] = (writecap, readcap, mddict.get('metadata'))
 480         d = self.node.set_children(cs, replace)
 481         d.addCallback(lambda res: "Okay so I did it.")
 482         # TODO: results
 483         return d
 484
 485 def abbreviated_dirnode(dirnode):
 486     u = from_string_dirnode(dirnode.get_uri())
 487     return u.abbrev_si()
 488
 489 class DirectoryAsHTML(rend.Page):
 490     # The remainder of this class is to render the directory into
 491     # human+browser -oriented HTML.
 492     docFactory = getxmlfile("directory.xhtml")
 493     addSlash = True
 494
 495     def __init__(self, node):
 496         rend.Page.__init__(self)
 497         self.node = node
 498
 499     def beforeRender(self, ctx):
 500         # attempt to get the dirnode's children, stashing them (or the
 501         # failure that results) for later use
 502         d = self.node.list()
 503         def _good(children):
 504             # Deferreds don't optimize out tail recursion, and the way
 505             # Nevow's flattener handles Deferreds doesn't take this into
 506             # account. As a result, large lists of Deferreds that fire in the
 507             # same turn (i.e. the output of defer.succeed) will cause a stack
 508             # overflow. To work around this, we insert a turn break after
 509             # every 100 items, using foolscap's fireEventually(). This gives
 510             # the stack a chance to be popped. It would also work to put
 511             # every item in its own turn, but that'd be a lot more
 512             # inefficient. This addresses ticket #237, for which I was never
 513             # able to create a failing unit test.
 514             output = []
 515             for i,item in enumerate(sorted(children.items())):
 516                 if i % 100 == 0:
 517                     output.append(fireEventually(item))
 518                 else:
 519                     output.append(item)
 520             self.dirnode_children = output
 521             return ctx
 522         def _bad(f):
 523             text, code = humanize_failure(f)
 524             self.dirnode_children = None
 525             self.dirnode_children_error = text
 526             return ctx
 527         d.addCallbacks(_good, _bad)
 528         return d
 529
 530     def render_title(self, ctx, data):
 531         si_s = abbreviated_dirnode(self.node)
 532         header = ["TahoeLAFS - Directory SI=%s" % si_s]
 533         if self.node.is_readonly():
 534             header.append(" (read-only)")
 535         else:
 536             header.append(" (modifiable)")
 537         return ctx.tag[header]
 538
 539     def render_header(self, ctx, data):
 540         si_s = abbreviated_dirnode(self.node)
 541         header = ["TahoeLAFS Directory SI=", T.span(class_="data-chars")[si_s]]
 542         if self.node.is_readonly():
 543             header.append(" (read-only)")
 544         return ctx.tag[header]
 545
 546     def render_welcome(self, ctx, data):
 547         link = get_root(ctx)
 548         return T.div[T.a(href=link)["Return to Welcome page"]]
 549
 550     def render_show_readonly(self, ctx, data):
 551         if self.node.is_readonly():
 552             return ""
 553         rocap = self.node.get_readonly_uri()
 554         root = get_root(ctx)
 555         uri_link = "%s/uri/%s/" % (root, urllib.quote(rocap))
 556         return ctx.tag[T.a(href=uri_link)["Read-Only Version"]]
 557
 558     def render_try_children(self, ctx, data):
 559         # if the dirnode can be retrived, render a table of children.
 560         # Otherwise, render an apologetic error message.
 561         if self.dirnode_children is not None:
 562             return ctx.tag
 563         else:
 564             return T.div[T.p["Error reading directory:"],
 565                          T.p[self.dirnode_children_error]]
 566
 567     def data_children(self, ctx, data):
 568         return self.dirnode_children
 569
 570     def render_row(self, ctx, data):
 571         name, (target, metadata) = data
 572         name = name.encode("utf-8")
 573         assert not isinstance(name, unicode)
 574         nameurl = urllib.quote(name, safe="") # encode any slashes too
 575
 576         root = get_root(ctx)
 577         here = "%s/uri/%s/" % (root, urllib.quote(self.node.get_uri()))
 578         if self.node.is_readonly():
 579             delete = "-"
 580             rename = "-"
 581         else:
 582             # this creates a button which will cause our child__delete method
 583             # to be invoked, which deletes the file and then redirects the
 584             # browser back to this directory
 585             delete = T.form(action=here, method="post")[
 586                 T.input(type='hidden', name='t', value='delete'),
 587                 T.input(type='hidden', name='name', value=name),
 588                 T.input(type='hidden', name='when_done', value="."),
 589                 T.input(type='submit', value='del', name="del"),
 590                 ]
 591
 592             rename = T.form(action=here, method="get")[
 593                 T.input(type='hidden', name='t', value='rename-form'),
 594                 T.input(type='hidden', name='name', value=name),
 595                 T.input(type='hidden', name='when_done', value="."),
 596                 T.input(type='submit', value='rename', name="rename"),
 597                 ]
 598
 599         ctx.fillSlots("delete", delete)
 600         ctx.fillSlots("rename", rename)
 601
 602         times = []
 603         linkcrtime = metadata.get('tahoe', {}).get("linkcrtime")
 604         if linkcrtime is not None:
 605             times.append("lcr: " + time_format.iso_local(linkcrtime))
 606         else:
 607             # For backwards-compatibility with links last modified by Tahoe < 1.4.0:
 608             if "ctime" in metadata:
 609                 ctime = time_format.iso_local(metadata["ctime"])
 610                 times.append("c: " + ctime)
 611         linkmotime = metadata.get('tahoe', {}).get("linkmotime")
 612         if linkmotime is not None:
 613             if times:
 614                 times.append(T.br())
 615             times.append("lmo: " + time_format.iso_local(linkmotime))
 616         else:
 617             # For backwards-compatibility with links last modified by Tahoe < 1.4.0:
 618             if "mtime" in metadata:
 619                 mtime = time_format.iso_local(metadata["mtime"])
 620                 if times:
 621                     times.append(T.br())
 622                 times.append("m: " + mtime)
 623         ctx.fillSlots("times", times)
 624
 625         assert IFilesystemNode.providedBy(target), target
 626         writecap = target.get_uri() or ""
 627         quoted_uri = urllib.quote(writecap, safe="") # escape slashes too
 628
 629         if IMutableFileNode.providedBy(target):
 630             # to prevent javascript in displayed .html files from stealing a
 631             # secret directory URI from the URL, send the browser to a URI-based
 632             # page that doesn't know about the directory at all
 633             dlurl = "%s/file/%s/@@named=/%s" % (root, quoted_uri, nameurl)
 634
 635             ctx.fillSlots("filename",
 636                           T.a(href=dlurl)[html.escape(name)])
 637             ctx.fillSlots("type", "SSK")
 638
 639             ctx.fillSlots("size", "?")
 640
 641             info_link = "%s/uri/%s?t=info" % (root, quoted_uri)
 642
 643         elif IFileNode.providedBy(target):
 644             dlurl = "%s/file/%s/@@named=/%s" % (root, quoted_uri, nameurl)
 645
 646             ctx.fillSlots("filename",
 647                           T.a(href=dlurl)[html.escape(name)])
 648             ctx.fillSlots("type", "FILE")
 649
 650             ctx.fillSlots("size", target.get_size())
 651
 652             info_link = "%s/uri/%s?t=info" % (root, quoted_uri)
 653
 654         elif IDirectoryNode.providedBy(target):
 655             # directory
 656             uri_link = "%s/uri/%s/" % (root, urllib.quote(writecap))
 657             ctx.fillSlots("filename",
 658                           T.a(href=uri_link)[html.escape(name)])
 659             if target.is_readonly():
 660                 dirtype = "DIR-RO"
 661             else:
 662                 dirtype = "DIR"
 663             ctx.fillSlots("type", dirtype)
 664             ctx.fillSlots("size", "-")
 665             info_link = "%s/uri/%s/?t=info" % (root, quoted_uri)
 666
 667         else:
 668             # unknown
 669             ctx.fillSlots("filename", html.escape(name))
 670             ctx.fillSlots("type", "?")
 671             ctx.fillSlots("size", "-")
 672             # use a directory-relative info link, so we can extract both the
 673             # writecap and the readcap
 674             info_link = "%s?t=info" % urllib.quote(name)
 675
 676         ctx.fillSlots("info", T.a(href=info_link)["More Info"])
 677
 678         return ctx.tag
 679
 680     def render_forms(self, ctx, data):
 681         forms = []
 682
 683         if self.node.is_readonly():
 684             return T.div["No upload forms: directory is read-only"]
 685         if self.dirnode_children is None:
 686             return T.div["No upload forms: directory is unreadable"]
 687
 688         mkdir = T.form(action=".", method="post",
 689                        enctype="multipart/form-data")[
 690             T.fieldset[
 691             T.input(type="hidden", name="t", value="mkdir"),
 692             T.input(type="hidden", name="when_done", value="."),
 693             T.legend(class_="freeform-form-label")["Create a new directory in this directory"],
 694             "New directory name: ",
 695             T.input(type="text", name="name"), " ",
 696             T.input(type="submit", value="Create"),
 697             ]]
 698         forms.append(T.div(class_="freeform-form")[mkdir])
 699
 700         upload = T.form(action=".", method="post",
 701                         enctype="multipart/form-data")[
 702             T.fieldset[
 703             T.input(type="hidden", name="t", value="upload"),
 704             T.input(type="hidden", name="when_done", value="."),
 705             T.legend(class_="freeform-form-label")["Upload a file to this directory"],
 706             "Choose a file to upload: ",
 707             T.input(type="file", name="file", class_="freeform-input-file"),
 708             " ",
 709             T.input(type="submit", value="Upload"),
 710             " Mutable?:",
 711             T.input(type="checkbox", name="mutable"),
 712             ]]
 713         forms.append(T.div(class_="freeform-form")[upload])
 714
 715         mount = T.form(action=".", method="post",
 716                         enctype="multipart/form-data")[
 717             T.fieldset[
 718             T.input(type="hidden", name="t", value="uri"),
 719             T.input(type="hidden", name="when_done", value="."),
 720             T.legend(class_="freeform-form-label")["Add a link to a file or directory which is already in TahoeLAFS."],
 721             "New child name: ",
 722             T.input(type="text", name="name"), " ",
 723             "URI of new child: ",
 724             T.input(type="text", name="uri"), " ",
 725             T.input(type="submit", value="Attach"),
 726             ]]
 727         forms.append(T.div(class_="freeform-form")[mount])
 728         return forms
 729
 730     def render_results(self, ctx, data):
 731         req = IRequest(ctx)
 732         return get_arg(req, "results", "")
 733
 734
 735 def DirectoryJSONMetadata(ctx, dirnode):
 736     d = dirnode.list()
 737     def _got(children):
 738         kids = {}
 739         for name, (childnode, metadata) in children.iteritems():
 740             assert IFilesystemNode.providedBy(childnode), childnode
 741             rw_uri = childnode.get_uri()
 742             ro_uri = childnode.get_readonly_uri()
 743             if (IDirectoryNode.providedBy(childnode)
 744                 or IFileNode.providedBy(childnode)):
 745                 if childnode.is_readonly():
 746                     rw_uri = None
 747             if IFileNode.providedBy(childnode):
 748                 kiddata = ("filenode", {'size': childnode.get_size(),
 749                                         'mutable': childnode.is_mutable(),
 750                                         })
 751             elif IDirectoryNode.providedBy(childnode):
 752                 kiddata = ("dirnode", {'mutable': childnode.is_mutable(),
 753                                        })
 754             else:
 755                 kiddata = ("unknown", {})
 756             kiddata[1]["metadata"] = metadata
 757             if ro_uri:
 758                 kiddata[1]["ro_uri"] = ro_uri
 759             if rw_uri:
 760                 kiddata[1]["rw_uri"] = rw_uri
 761             verifycap = childnode.get_verify_cap()
 762             if verifycap:
 763                 kiddata[1]['verify_uri'] = verifycap.to_string()
 764             kids[name] = kiddata
 765         if dirnode.is_readonly():
 766             drw_uri = None
 767             dro_uri = dirnode.get_uri()
 768         else:
 769             drw_uri = dirnode.get_uri()
 770             dro_uri = dirnode.get_readonly_uri()
 771         contents = { 'children': kids }
 772         if dro_uri:
 773             contents['ro_uri'] = dro_uri
 774         if drw_uri:
 775             contents['rw_uri'] = drw_uri
 776         verifycap = dirnode.get_verify_cap()
 777         if verifycap:
 778             contents['verify_uri'] = verifycap.to_string()
 779         contents['mutable'] = dirnode.is_mutable()
 780         data = ("dirnode", contents)
 781         return simplejson.dumps(data, indent=1) + "\n"
 782     d.addCallback(_got)
 783     d.addCallback(text_plain, ctx)
 784     return d
 785
 786
 787
 788 def DirectoryURI(ctx, dirnode):
 789     return text_plain(dirnode.get_uri(), ctx)
 790
 791 def DirectoryReadonlyURI(ctx, dirnode):
 792     return text_plain(dirnode.get_readonly_uri(), ctx)
 793
 794 class RenameForm(rend.Page):
 795     addSlash = True
 796     docFactory = getxmlfile("rename-form.xhtml")
 797
 798     def render_title(self, ctx, data):
 799         return ctx.tag["Directory SI=%s" % abbreviated_dirnode(self.original)]
 800
 801     def render_header(self, ctx, data):
 802         header = ["Rename "
 803                   "in directory SI=%s" % abbreviated_dirnode(self.original),
 804                   ]
 805
 806         if self.original.is_readonly():
 807             header.append(" (readonly!)")
 808         header.append(":")
 809         return ctx.tag[header]
 810
 811     def render_when_done(self, ctx, data):
 812         return T.input(type="hidden", name="when_done", value=".")
 813
 814     def render_get_name(self, ctx, data):
 815         req = IRequest(ctx)
 816         name = get_arg(req, "name", "")
 817         ctx.tag.attributes['value'] = name
 818         return ctx.tag
 819
 820
 821 class ManifestResults(rend.Page, ReloadMixin):
 822     docFactory = getxmlfile("manifest.xhtml")
 823
 824     def __init__(self, client, monitor):
 825         self.client = client
 826         self.monitor = monitor
 827
 828     def renderHTTP(self, ctx):
 829         req = inevow.IRequest(ctx)
 830         output = get_arg(req, "output", "html").lower()
 831         if output == "text":
 832             return self.text(req)
 833         if output == "json":
 834             return self.json(req)
 835         return rend.Page.renderHTTP(self, ctx)
 836
 837     def slashify_path(self, path):
 838         if not path:
 839             return ""
 840         return "/".join([p.encode("utf-8") for p in path])
 841
 842     def text(self, req):
 843         req.setHeader("content-type", "text/plain")
 844         lines = []
 845         is_finished = self.monitor.is_finished()
 846         lines.append("finished: " + {True: "yes", False: "no"}[is_finished])
 847         for (path, cap) in self.monitor.get_status()["manifest"]:
 848             lines.append(self.slashify_path(path) + " " + cap)
 849         return "\n".join(lines) + "\n"
 850
 851     def json(self, req):
 852         req.setHeader("content-type", "text/plain")
 853         m = self.monitor
 854         s = m.get_status()
 855
 856         status = { "stats": s["stats"],
 857                    "finished": m.is_finished(),
 858                    "origin": base32.b2a(m.origin_si),
 859                    }
 860         if m.is_finished():
 861             # don't return manifest/verifycaps/SIs unless the operation is
 862             # done, to save on CPU/memory (both here and in the HTTP client
 863             # who has to unpack the JSON). Tests show that the ManifestWalker
 864             # needs about 1092 bytes per item, the JSON we generate here
 865             # requires about 503 bytes per item, and some internal overhead
 866             # (perhaps transport-layer buffers in twisted.web?) requires an
 867             # additional 1047 bytes per item.
 868             status.update({ "manifest": s["manifest"],
 869                             "verifycaps": [i for i in s["verifycaps"]],
 870                             "storage-index": [i for i in s["storage-index"]],
 871                             })
 872             # simplejson doesn't know how to serialize a set. We use a
 873             # generator that walks the set rather than list(setofthing) to
 874             # save a small amount of memory (4B*len) and a moderate amount of
 875             # CPU.
 876         return simplejson.dumps(status, indent=1)
 877
 878     def _si_abbrev(self):
 879         return base32.b2a(self.monitor.origin_si)[:6]
 880
 881     def render_title(self, ctx):
 882         return T.title["Manifest of SI=%s" % self._si_abbrev()]
 883
 884     def render_header(self, ctx):
 885         return T.p["Manifest of SI=%s" % self._si_abbrev()]
 886
 887     def data_items(self, ctx, data):
 888         return self.monitor.get_status()["manifest"]
 889
 890     def render_row(self, ctx, (path, cap)):
 891         ctx.fillSlots("path", self.slashify_path(path))
 892         root = get_root(ctx)
 893         # TODO: we need a clean consistent way to get the type of a cap string
 894         if cap:
 895             if cap.startswith("URI:CHK") or cap.startswith("URI:SSK"):
 896                 nameurl = urllib.quote(path[-1].encode("utf-8"))
 897                 uri_link = "%s/file/%s/@@named=/%s" % (root, urllib.quote(cap),
 898                                                        nameurl)
 899             else:
 900                 uri_link = "%s/uri/%s" % (root, urllib.quote(cap, safe=""))
 901             ctx.fillSlots("cap", T.a(href=uri_link)[cap])
 902         else:
 903             ctx.fillSlots("cap", "")
 904         return ctx.tag
 905
 906 class DeepSizeResults(rend.Page):
 907     def __init__(self, client, monitor):
 908         self.client = client
 909         self.monitor = monitor
 910
 911     def renderHTTP(self, ctx):
 912         req = inevow.IRequest(ctx)
 913         output = get_arg(req, "output", "html").lower()
 914         req.setHeader("content-type", "text/plain")
 915         if output == "json":
 916             return self.json(req)
 917         # plain text
 918         is_finished = self.monitor.is_finished()
 919         output = "finished: " + {True: "yes", False: "no"}[is_finished] + "\n"
 920         if is_finished:
 921             stats = self.monitor.get_status()
 922             total = (stats.get("size-immutable-files", 0)
 923                      + stats.get("size-mutable-files", 0)
 924                      + stats.get("size-directories", 0))
 925             output += "size: %d\n" % total
 926         return output
 927
 928     def json(self, req):
 929         status = {"finished": self.monitor.is_finished(),
 930                   "size": self.monitor.get_status(),
 931                   }
 932         return simplejson.dumps(status)
 933
 934 class DeepStatsResults(rend.Page):
 935     def __init__(self, client, monitor):
 936         self.client = client
 937         self.monitor = monitor
 938
 939     def renderHTTP(self, ctx):
 940         # JSON only
 941         inevow.IRequest(ctx).setHeader("content-type", "text/plain")
 942         s = self.monitor.get_status().copy()
 943         s["finished"] = self.monitor.is_finished()
 944         return simplejson.dumps(s, indent=1)
 945
 946 class ManifestStreamer(dirnode.DeepStats):
 947     implements(IPushProducer)
 948
 949     def __init__(self, ctx, origin):
 950         dirnode.DeepStats.__init__(self, origin)
 951         self.req = IRequest(ctx)
 952
 953     def setMonitor(self, monitor):
 954         self.monitor = monitor
 955     def pauseProducing(self):
 956         pass
 957     def resumeProducing(self):
 958         pass
 959     def stopProducing(self):
 960         self.monitor.cancel()
 961
 962     def add_node(self, node, path):
 963         dirnode.DeepStats.add_node(self, node, path)
 964         d = {"path": path,
 965              "cap": node.get_uri()}
 966
 967         if IDirectoryNode.providedBy(node):
 968             d["type"] = "directory"
 969         elif IFileNode.providedBy(node):
 970             d["type"] = "file"
 971         else:
 972             d["type"] = "unknown"
 973
 974         v = node.get_verify_cap()
 975         if v:
 976             v = v.to_string()
 977         d["verifycap"] = v
 978
 979         r = node.get_repair_cap()
 980         if r:
 981             r = r.to_string()
 982         d["repaircap"] = r
 983
 984         si = node.get_storage_index()
 985         if si:
 986             si = base32.b2a(si)
 987         d["storage-index"] = si
 988
 989         j = simplejson.dumps(d, ensure_ascii=True)
 990         assert "\n" not in j
 991         self.req.write(j+"\n")
 992
 993     def finish(self):
 994         stats = dirnode.DeepStats.get_results(self)
 995         d = {"type": "stats",
 996              "stats": stats,
 997              }
 998         j = simplejson.dumps(d, ensure_ascii=True)
 999         assert "\n" not in j
1000         self.req.write(j+"\n")
1001         return ""
1002
1003 class DeepCheckStreamer(dirnode.DeepStats):
1004     implements(IPushProducer)
1005
1006     def __init__(self, ctx, origin, verify, repair, add_lease):
1007         dirnode.DeepStats.__init__(self, origin)
1008         self.req = IRequest(ctx)
1009         self.verify = verify
1010         self.repair = repair
1011         self.add_lease = add_lease
1012
1013     def setMonitor(self, monitor):
1014         self.monitor = monitor
1015     def pauseProducing(self):
1016         pass
1017     def resumeProducing(self):
1018         pass
1019     def stopProducing(self):
1020         self.monitor.cancel()
1021
1022     def add_node(self, node, path):
1023         dirnode.DeepStats.add_node(self, node, path)
1024         data = {"path": path,
1025                 "cap": node.get_uri()}
1026
1027         if IDirectoryNode.providedBy(node):
1028             data["type"] = "directory"
1029         else:
1030             data["type"] = "file"
1031
1032         v = node.get_verify_cap()
1033         if v:
1034             v = v.to_string()
1035         data["verifycap"] = v
1036
1037         r = node.get_repair_cap()
1038         if r:
1039             r = r.to_string()
1040         data["repaircap"] = r
1041
1042         si = node.get_storage_index()
1043         if si:
1044             si = base32.b2a(si)
1045         data["storage-index"] = si
1046
1047         if self.repair:
1048             d = node.check_and_repair(self.monitor, self.verify, self.add_lease)
1049             d.addCallback(self.add_check_and_repair, data)
1050         else:
1051             d = node.check(self.monitor, self.verify, self.add_lease)
1052             d.addCallback(self.add_check, data)
1053         d.addCallback(self.write_line)
1054         return d
1055
1056     def add_check_and_repair(self, crr, data):
1057         data["check-and-repair-results"] = json_check_and_repair_results(crr)
1058         return data
1059
1060     def add_check(self, cr, data):
1061         data["check-results"] = json_check_results(cr)
1062         return data
1063
1064     def write_line(self, data):
1065         j = simplejson.dumps(data, ensure_ascii=True)
1066         assert "\n" not in j
1067         self.req.write(j+"\n")
1068
1069     def finish(self):
1070         stats = dirnode.DeepStats.get_results(self)
1071         d = {"type": "stats",
1072              "stats": stats,
1073              }
1074         j = simplejson.dumps(d, ensure_ascii=True)
1075         assert "\n" not in j
1076         self.req.write(j+"\n")
1077         return ""
1078
1079 class UnknownNodeHandler(RenderMixin, rend.Page):
1080
1081     def __init__(self, client, node, parentnode=None, name=None):
1082         rend.Page.__init__(self)
1083         assert node
1084         self.node = node
1085
1086     def render_GET(self, ctx):
1087         req = IRequest(ctx)
1088         t = get_arg(req, "t", "").strip()
1089         if t == "info":
1090             return MoreInfo(self.node)
1091         raise WebError("GET unknown URI type: can only do t=info, not t=%s" % t)
1092
1093