src/allmydata/web/directory.py

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