src/allmydata/web/directory.py

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