src/allmydata/web/directory.py

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