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
13 from foolscap.api import fireEventually
15 from allmydata.util import base32, time_format
16 from allmydata.uri import from_string_dirnode
17 from allmydata.interfaces import IDirectoryNode, IFileNode, IFilesystemNode, \
18 IImmutableFileNode, IMutableFileNode, ExistingChildError, \
19 NoSuchChildError, EmptyPathnameComponentError
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, parse_replace_arg, \
25 should_create_intermediate_directories, \
26 getxmlfile, RenderMixin, humanize_failure, convert_children_json
27 from allmydata.web.filenode import ReplaceMeMixin, \
28 FileNodeHandler, PlaceHolderNodeHandler
29 from allmydata.web.check_results import CheckResults, \
30 CheckAndRepairResults, DeepCheckResults, DeepCheckAndRepairResults, \
32 from allmydata.web.info import MoreInfo
33 from allmydata.web.operations import ReloadMixin
34 from allmydata.web.check_results import json_check_results, \
35 json_check_and_repair_results
37 class BlockingFileError(Exception):
38 # TODO: catch and transform
39 """We cannot auto-create a parent directory, because there is a file in
42 def make_handler_for(node, client, parentnode=None, name=None):
44 assert IDirectoryNode.providedBy(parentnode)
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)
51 class DirectoryNodeHandler(RenderMixin, rend.Page, ReplaceMeMixin):
54 def __init__(self, client, node, parentnode=None, name=None):
55 rend.Page.__init__(self)
59 self.parentnode = parentnode
62 def childFactory(self, ctx, name):
63 name = name.decode("utf-8")
65 raise EmptyPathnameComponentError()
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
72 def got_child(self, node_or_failure, ctx, name):
74 if DEBUG: print "GOT_CHILD", name, node_or_failure
77 nonterminal = len(req.postpath) > 1
78 t = get_arg(req, "t", "").strip()
79 if isinstance(node_or_failure, 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
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_subdirectory(name)
91 d.addCallback(make_handler_for,
92 self.client, self.node, name)
95 if DEBUG: print " terminal"
97 if (method,t) in [ ("POST","mkdir"), ("PUT","mkdir"),
98 ("POST", "mkdir-with-children"),
99 ("POST", "mkdir-immutable") ]:
100 if DEBUG: print " making final directory"
103 if t in ("mkdir-with-children", "mkdir-immutable"):
105 kids_json = req.content.read()
106 kids = convert_children_json(self.client.nodemaker,
109 if t == "mkdir-immutable":
111 d = self.node.create_subdirectory(name, kids,
113 d.addCallback(make_handler_for,
114 self.client, self.node, name)
116 if (method,t) in ( ("PUT",""), ("PUT","uri"), ):
117 if DEBUG: print " PUT, making leaf placeholder"
118 # we were trying to find the leaf filenode (to put a new
119 # file in its place), and it didn't exist. That's ok,
120 # since that's the leaf node that we're about to create.
121 # We make a dummy one, which will respond to the PUT
122 # request by replacing itself.
123 return PlaceHolderNodeHandler(self.client, self.node, name)
124 if DEBUG: print " 404"
125 # otherwise, we just return a no-such-child error
128 node = node_or_failure
129 if nonterminal and should_create_intermediate_directories(req):
130 if not IDirectoryNode.providedBy(node):
131 # we would have put a new directory here, but there was a
133 if DEBUG: print "blocking"
134 raise WebError("Unable to create directory '%s': "
135 "a file was in the way" % name,
137 if DEBUG: print "good child"
138 return make_handler_for(node, self.client, self.node, name)
140 def render_DELETE(self, ctx):
141 assert self.parentnode and self.name
142 d = self.parentnode.delete(self.name)
143 d.addCallback(lambda res: self.node.get_uri())
146 def render_GET(self, ctx):
148 # This is where all of the directory-related ?t=* code goes.
149 t = get_arg(req, "t", "").strip()
151 # render the directory as HTML, using the docFactory and Nevow's
152 # whole templating thing.
153 return DirectoryAsHTML(self.node)
156 return DirectoryJSONMetadata(ctx, self.node)
158 return MoreInfo(self.node)
160 return DirectoryURI(ctx, self.node)
161 if t == "readonly-uri":
162 return DirectoryReadonlyURI(ctx, self.node)
163 if t == 'rename-form':
164 return RenameForm(self.node)
166 raise WebError("GET directory: bad t=%s" % t)
168 def render_PUT(self, ctx):
170 t = get_arg(req, "t", "").strip()
171 replace = parse_replace_arg(get_arg(req, "replace", "true"))
174 # our job was done by the traversal/create-intermediate-directory
175 # process that got us here.
176 return text_plain(self.node.get_uri(), ctx) # TODO: urlencode
179 # they're trying to set_uri and that name is already occupied
181 raise ExistingChildError()
182 d = self.replace_me_with_a_childcap(req, self.client, replace)
186 raise WebError("PUT to a directory")
188 def render_POST(self, ctx):
190 t = get_arg(req, "t", "").strip()
193 d = self._POST_mkdir(req)
194 elif t == "mkdir-with-children":
195 d = self._POST_mkdir_with_children(req)
196 elif t == "mkdir-immutable":
197 d = self._POST_mkdir_immutable(req)
200 d = self._POST_mkdir_p(req)
202 d = self._POST_upload(ctx) # this one needs the context
204 d = self._POST_uri(req)
206 d = self._POST_delete(req)
208 d = self._POST_rename(req)
210 d = self._POST_check(req)
211 elif t == "start-deep-check":
212 d = self._POST_start_deep_check(ctx)
213 elif t == "stream-deep-check":
214 d = self._POST_stream_deep_check(ctx)
215 elif t == "start-manifest":
216 d = self._POST_start_manifest(ctx)
217 elif t == "start-deep-size":
218 d = self._POST_start_deep_size(ctx)
219 elif t == "start-deep-stats":
220 d = self._POST_start_deep_stats(ctx)
221 elif t == "stream-manifest":
222 d = self._POST_stream_manifest(ctx)
223 elif t == "set_children":
224 d = self._POST_set_children(req)
226 raise WebError("POST to a directory with bad t=%s" % t)
228 when_done = get_arg(req, "when_done", None)
230 d.addCallback(lambda res: url.URL.fromString(when_done))
233 def _POST_mkdir(self, req):
234 name = get_arg(req, "name", "")
236 # our job is done, it was handled by the code in got_child
237 # which created the final directory (i.e. us)
238 return defer.succeed(self.node.get_uri()) # TODO: urlencode
239 name = name.decode("utf-8")
240 replace = boolean_of_arg(get_arg(req, "replace", "true"))
242 d = self.node.create_subdirectory(name, kids, overwrite=replace)
243 d.addCallback(lambda child: child.get_uri()) # TODO: urlencode
246 def _POST_mkdir_with_children(self, req):
247 name = get_arg(req, "name", "")
249 # our job is done, it was handled by the code in got_child
250 # which created the final directory (i.e. us)
251 return defer.succeed(self.node.get_uri()) # TODO: urlencode
252 name = name.decode("utf-8")
253 replace = boolean_of_arg(get_arg(req, "replace", "true"))
255 kids_json = req.content.read()
256 kids = convert_children_json(self.client.nodemaker, kids_json)
257 d = self.node.create_subdirectory(name, kids, overwrite=replace)
258 d.addCallback(lambda child: child.get_uri()) # TODO: urlencode
261 def _POST_mkdir_immutable(self, req):
262 name = get_arg(req, "name", "")
264 # our job is done, it was handled by the code in got_child
265 # which created the final directory (i.e. us)
266 return defer.succeed(self.node.get_uri()) # TODO: urlencode
267 name = name.decode("utf-8")
268 # TODO: decide on replace= behavior, see #903
269 #replace = boolean_of_arg(get_arg(req, "replace", "true"))
271 kids_json = req.content.read()
272 kids = convert_children_json(self.client.nodemaker, kids_json)
273 d = self.node.create_subdirectory(name, kids, mutable=False)
274 d.addCallback(lambda child: child.get_uri()) # TODO: urlencode
277 def _POST_mkdir_p(self, req):
278 path = get_arg(req, "path")
280 raise WebError("mkdir-p requires a path")
281 path_ = tuple([seg.decode("utf-8") for seg in path.split('/') if seg ])
283 d = self._get_or_create_directories(self.node, path_)
284 d.addCallback(lambda node: node.get_uri())
287 def _get_or_create_directories(self, node, path):
288 if not IDirectoryNode.providedBy(node):
289 # unfortunately it is too late to provide the name of the
290 # blocking directory in the error message.
291 raise BlockingFileError("cannot create directory because there "
292 "is a file in the way")
294 return defer.succeed(node)
295 d = node.get(path[0])
296 def _maybe_create(f):
297 f.trap(NoSuchChildError)
298 return node.create_subdirectory(path[0])
299 d.addErrback(_maybe_create)
300 d.addCallback(self._get_or_create_directories, path[1:])
303 def _POST_upload(self, ctx):
305 charset = get_arg(req, "_charset", "utf-8")
306 contents = req.fields["file"]
307 assert contents.filename is None or isinstance(contents.filename, str)
308 name = get_arg(req, "name")
309 name = name or contents.filename
313 # this prohibts empty, missing, and all-whitespace filenames
314 raise WebError("upload requires a name")
315 assert isinstance(name, str)
316 name = name.decode(charset)
318 raise WebError("name= may not contain a slash", http.BAD_REQUEST)
319 assert isinstance(name, unicode)
321 # since POST /uri/path/file?t=upload is equivalent to
322 # POST /uri/path/dir?t=upload&name=foo, just do the same thing that
323 # childFactory would do. Things are cleaner if we only do a subset of
324 # them, though, so we don't do: d = self.childFactory(ctx, name)
326 d = self.node.get(name)
327 def _maybe_got_node(node_or_failure):
328 if isinstance(node_or_failure, Failure):
330 f.trap(NoSuchChildError)
331 # create a placeholder which will see POST t=upload
332 return PlaceHolderNodeHandler(self.client, self.node, name)
334 node = node_or_failure
335 return make_handler_for(node, self.client, self.node, name)
336 d.addBoth(_maybe_got_node)
337 # now we have a placeholder or a filenodehandler, and we can just
338 # delegate to it. We could return the resource back out of
339 # DirectoryNodeHandler.renderHTTP, and nevow would recurse into it,
340 # but the addCallback() that handles when_done= would break.
341 d.addCallback(lambda child: child.renderHTTP(ctx))
344 def _POST_uri(self, req):
345 childcap = get_arg(req, "uri")
347 raise WebError("set-uri requires a uri")
348 name = get_arg(req, "name")
350 raise WebError("set-uri requires a name")
351 charset = get_arg(req, "_charset", "utf-8")
352 name = name.decode(charset)
353 replace = boolean_of_arg(get_arg(req, "replace", "true"))
354 d = self.node.set_uri(name, childcap, childcap, overwrite=replace)
355 d.addCallback(lambda res: childcap)
358 def _POST_delete(self, req):
359 name = get_arg(req, "name")
361 # apparently an <input type="hidden" name="name" value="">
362 # won't show up in the resulting encoded form.. the 'name'
363 # field is completely missing. So to allow deletion of an
364 # empty file, we have to pretend that None means ''. The only
365 # downide of this is a slightly confusing error message if
366 # someone does a POST without a name= field. For our own HTML
367 # thisn't a big deal, because we create the 'delete' POST
370 charset = get_arg(req, "_charset", "utf-8")
371 name = name.decode(charset)
372 d = self.node.delete(name)
373 d.addCallback(lambda res: "thing deleted")
376 def _POST_rename(self, req):
377 charset = get_arg(req, "_charset", "utf-8")
378 from_name = get_arg(req, "from_name")
379 if from_name is not None:
380 from_name = from_name.strip()
381 from_name = from_name.decode(charset)
382 assert isinstance(from_name, unicode)
383 to_name = get_arg(req, "to_name")
384 if to_name is not None:
385 to_name = to_name.strip()
386 to_name = to_name.decode(charset)
387 assert isinstance(to_name, unicode)
388 if not from_name or not to_name:
389 raise WebError("rename requires from_name and to_name")
390 if from_name == to_name:
391 return defer.succeed("redundant rename")
393 # allow from_name to contain slashes, so they can fix names that were
394 # accidentally created with them. But disallow them in to_name, to
395 # discourage the practice.
397 raise WebError("to_name= may not contain a slash", http.BAD_REQUEST)
399 replace = boolean_of_arg(get_arg(req, "replace", "true"))
400 d = self.node.move_child_to(from_name, self.node, to_name, replace)
401 d.addCallback(lambda res: "thing renamed")
404 def _maybe_literal(self, res, Results_Class):
406 return Results_Class(self.client, res)
407 return LiteralCheckResults(self.client)
409 def _POST_check(self, req):
410 # check this directory
411 verify = boolean_of_arg(get_arg(req, "verify", "false"))
412 repair = boolean_of_arg(get_arg(req, "repair", "false"))
413 add_lease = boolean_of_arg(get_arg(req, "add-lease", "false"))
415 d = self.node.check_and_repair(Monitor(), verify, add_lease)
416 d.addCallback(self._maybe_literal, CheckAndRepairResults)
418 d = self.node.check(Monitor(), verify, add_lease)
419 d.addCallback(self._maybe_literal, CheckResults)
422 def _start_operation(self, monitor, renderer, ctx):
423 table = IOpHandleTable(ctx)
424 table.add_monitor(ctx, monitor, renderer)
425 return table.redirect_to(ctx)
427 def _POST_start_deep_check(self, ctx):
428 # check this directory and everything reachable from it
429 if not get_arg(ctx, "ophandle"):
430 raise NeedOperationHandleError("slow operation requires ophandle=")
431 verify = boolean_of_arg(get_arg(ctx, "verify", "false"))
432 repair = boolean_of_arg(get_arg(ctx, "repair", "false"))
433 add_lease = boolean_of_arg(get_arg(ctx, "add-lease", "false"))
435 monitor = self.node.start_deep_check_and_repair(verify, add_lease)
436 renderer = DeepCheckAndRepairResults(self.client, monitor)
438 monitor = self.node.start_deep_check(verify, add_lease)
439 renderer = DeepCheckResults(self.client, monitor)
440 return self._start_operation(monitor, renderer, ctx)
442 def _POST_stream_deep_check(self, ctx):
443 verify = boolean_of_arg(get_arg(ctx, "verify", "false"))
444 repair = boolean_of_arg(get_arg(ctx, "repair", "false"))
445 add_lease = boolean_of_arg(get_arg(ctx, "add-lease", "false"))
446 walker = DeepCheckStreamer(ctx, self.node, verify, repair, add_lease)
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()
453 IRequest(ctx).unregisterProducer()
457 f.trap(OperationCancelledError)
458 return "Operation Cancelled"
459 d.addErrback(_cancelled)
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]))
469 def _POST_start_manifest(self, ctx):
470 if not get_arg(ctx, "ophandle"):
471 raise NeedOperationHandleError("slow operation requires ophandle=")
472 monitor = self.node.build_manifest()
473 renderer = ManifestResults(self.client, monitor)
474 return self._start_operation(monitor, renderer, ctx)
476 def _POST_start_deep_size(self, ctx):
477 if not get_arg(ctx, "ophandle"):
478 raise NeedOperationHandleError("slow operation requires ophandle=")
479 monitor = self.node.start_deep_stats()
480 renderer = DeepSizeResults(self.client, monitor)
481 return self._start_operation(monitor, renderer, ctx)
483 def _POST_start_deep_stats(self, ctx):
484 if not get_arg(ctx, "ophandle"):
485 raise NeedOperationHandleError("slow operation requires ophandle=")
486 monitor = self.node.start_deep_stats()
487 renderer = DeepStatsResults(self.client, monitor)
488 return self._start_operation(monitor, renderer, ctx)
490 def _POST_stream_manifest(self, ctx):
491 walker = ManifestStreamer(ctx, self.node)
492 monitor = self.node.deep_traverse(walker)
493 walker.setMonitor(monitor)
494 # register to hear stopProducing. The walker ignores pauseProducing.
495 IRequest(ctx).registerProducer(walker, True)
496 d = monitor.when_done()
498 IRequest(ctx).unregisterProducer()
502 f.trap(OperationCancelledError)
503 return "Operation Cancelled"
504 d.addErrback(_cancelled)
506 # signal the error as a non-JSON "ERROR:" line, plus exception
507 msg = "ERROR: %s(%s)\n" % (f.value.__class__.__name__,
508 ", ".join([str(a) for a in f.value.args]))
514 def _POST_set_children(self, req):
515 replace = boolean_of_arg(get_arg(req, "replace", "true"))
517 body = req.content.read()
519 children = simplejson.loads(body)
520 except ValueError, le:
521 le.args = tuple(le.args + (body,))
522 # TODO test handling of bad JSON
525 for name, (file_or_dir, mddict) in children.iteritems():
526 name = unicode(name) # simplejson-2.0.1 returns str *or* unicode
527 writecap = mddict.get('rw_uri')
528 if writecap is not None:
529 writecap = str(writecap)
530 readcap = mddict.get('ro_uri')
531 if readcap is not None:
532 readcap = str(readcap)
533 cs[name] = (writecap, readcap, mddict.get('metadata'))
534 d = self.node.set_children(cs, replace)
535 d.addCallback(lambda res: "Okay so I did it.")
539 def abbreviated_dirnode(dirnode):
540 u = from_string_dirnode(dirnode.get_uri())
543 class DirectoryAsHTML(rend.Page):
544 # The remainder of this class is to render the directory into
545 # human+browser -oriented HTML.
546 docFactory = getxmlfile("directory.xhtml")
549 def __init__(self, node):
550 rend.Page.__init__(self)
553 def beforeRender(self, ctx):
554 # attempt to get the dirnode's children, stashing them (or the
555 # failure that results) for later use
558 # Deferreds don't optimize out tail recursion, and the way
559 # Nevow's flattener handles Deferreds doesn't take this into
560 # account. As a result, large lists of Deferreds that fire in the
561 # same turn (i.e. the output of defer.succeed) will cause a stack
562 # overflow. To work around this, we insert a turn break after
563 # every 100 items, using foolscap's fireEventually(). This gives
564 # the stack a chance to be popped. It would also work to put
565 # every item in its own turn, but that'd be a lot more
566 # inefficient. This addresses ticket #237, for which I was never
567 # able to create a failing unit test.
569 for i,item in enumerate(sorted(children.items())):
571 output.append(fireEventually(item))
574 self.dirnode_children = output
577 text, code = humanize_failure(f)
578 self.dirnode_children = None
579 self.dirnode_children_error = text
581 d.addCallbacks(_good, _bad)
584 def render_title(self, ctx, data):
585 si_s = abbreviated_dirnode(self.node)
586 header = ["Tahoe-LAFS - Directory SI=%s" % si_s]
587 if self.node.is_readonly():
588 header.append(" (read-only)")
590 header.append(" (modifiable)")
591 return ctx.tag[header]
593 def render_header(self, ctx, data):
594 si_s = abbreviated_dirnode(self.node)
595 header = ["Tahoe-LAFS Directory SI=", T.span(class_="data-chars")[si_s]]
596 if self.node.is_readonly():
597 header.append(" (read-only)")
598 return ctx.tag[header]
600 def render_welcome(self, ctx, data):
602 return T.div[T.a(href=link)["Return to Welcome page"]]
604 def render_show_readonly(self, ctx, data):
605 if self.node.is_readonly():
607 rocap = self.node.get_readonly_uri()
609 uri_link = "%s/uri/%s/" % (root, urllib.quote(rocap))
610 return ctx.tag[T.a(href=uri_link)["Read-Only Version"]]
612 def render_try_children(self, ctx, data):
613 # if the dirnode can be retrived, render a table of children.
614 # Otherwise, render an apologetic error message.
615 if self.dirnode_children is not None:
618 return T.div[T.p["Error reading directory:"],
619 T.p[self.dirnode_children_error]]
621 def data_children(self, ctx, data):
622 return self.dirnode_children
624 def render_row(self, ctx, data):
625 name, (target, metadata) = data
626 name = name.encode("utf-8")
627 assert not isinstance(name, unicode)
628 nameurl = urllib.quote(name, safe="") # encode any slashes too
631 here = "%s/uri/%s/" % (root, urllib.quote(self.node.get_uri()))
632 if self.node.is_readonly():
636 # this creates a button which will cause our child__delete method
637 # to be invoked, which deletes the file and then redirects the
638 # browser back to this directory
639 delete = T.form(action=here, method="post")[
640 T.input(type='hidden', name='t', value='delete'),
641 T.input(type='hidden', name='name', value=name),
642 T.input(type='hidden', name='when_done', value="."),
643 T.input(type='submit', value='del', name="del"),
646 rename = T.form(action=here, method="get")[
647 T.input(type='hidden', name='t', value='rename-form'),
648 T.input(type='hidden', name='name', value=name),
649 T.input(type='hidden', name='when_done', value="."),
650 T.input(type='submit', value='rename', name="rename"),
653 ctx.fillSlots("delete", delete)
654 ctx.fillSlots("rename", rename)
657 linkcrtime = metadata.get('tahoe', {}).get("linkcrtime")
658 if linkcrtime is not None:
659 times.append("lcr: " + time_format.iso_local(linkcrtime))
661 # For backwards-compatibility with links last modified by Tahoe < 1.4.0:
662 if "ctime" in metadata:
663 ctime = time_format.iso_local(metadata["ctime"])
664 times.append("c: " + ctime)
665 linkmotime = metadata.get('tahoe', {}).get("linkmotime")
666 if linkmotime is not None:
669 times.append("lmo: " + time_format.iso_local(linkmotime))
671 # For backwards-compatibility with links last modified by Tahoe < 1.4.0:
672 if "mtime" in metadata:
673 mtime = time_format.iso_local(metadata["mtime"])
676 times.append("m: " + mtime)
677 ctx.fillSlots("times", times)
679 assert IFilesystemNode.providedBy(target), target
680 writecap = target.get_uri() or ""
681 quoted_uri = urllib.quote(writecap, safe="") # escape slashes too
683 if IMutableFileNode.providedBy(target):
684 # to prevent javascript in displayed .html files from stealing a
685 # secret directory URI from the URL, send the browser to a URI-based
686 # page that doesn't know about the directory at all
687 dlurl = "%s/file/%s/@@named=/%s" % (root, quoted_uri, nameurl)
689 ctx.fillSlots("filename",
690 T.a(href=dlurl)[html.escape(name)])
691 ctx.fillSlots("type", "SSK")
693 ctx.fillSlots("size", "?")
695 info_link = "%s/uri/%s?t=info" % (root, quoted_uri)
697 elif IImmutableFileNode.providedBy(target):
698 dlurl = "%s/file/%s/@@named=/%s" % (root, quoted_uri, nameurl)
700 ctx.fillSlots("filename",
701 T.a(href=dlurl)[html.escape(name)])
702 ctx.fillSlots("type", "FILE")
704 ctx.fillSlots("size", target.get_size())
706 info_link = "%s/uri/%s?t=info" % (root, quoted_uri)
708 elif IDirectoryNode.providedBy(target):
710 uri_link = "%s/uri/%s/" % (root, urllib.quote(writecap))
711 ctx.fillSlots("filename",
712 T.a(href=uri_link)[html.escape(name)])
713 if not target.is_mutable():
715 elif target.is_readonly():
719 ctx.fillSlots("type", dirtype)
720 ctx.fillSlots("size", "-")
721 info_link = "%s/uri/%s/?t=info" % (root, quoted_uri)
725 ctx.fillSlots("filename", html.escape(name))
726 ctx.fillSlots("type", "?")
727 ctx.fillSlots("size", "-")
728 # use a directory-relative info link, so we can extract both the
729 # writecap and the readcap
730 info_link = "%s?t=info" % urllib.quote(name)
732 ctx.fillSlots("info", T.a(href=info_link)["More Info"])
736 def render_forms(self, ctx, data):
739 if self.node.is_readonly():
740 return T.div["No upload forms: directory is read-only"]
741 if self.dirnode_children is None:
742 return T.div["No upload forms: directory is unreadable"]
744 mkdir = T.form(action=".", method="post",
745 enctype="multipart/form-data")[
747 T.input(type="hidden", name="t", value="mkdir"),
748 T.input(type="hidden", name="when_done", value="."),
749 T.legend(class_="freeform-form-label")["Create a new directory in this directory"],
750 "New directory name: ",
751 T.input(type="text", name="name"), " ",
752 T.input(type="submit", value="Create"),
754 forms.append(T.div(class_="freeform-form")[mkdir])
756 upload = T.form(action=".", method="post",
757 enctype="multipart/form-data")[
759 T.input(type="hidden", name="t", value="upload"),
760 T.input(type="hidden", name="when_done", value="."),
761 T.legend(class_="freeform-form-label")["Upload a file to this directory"],
762 "Choose a file to upload: ",
763 T.input(type="file", name="file", class_="freeform-input-file"),
765 T.input(type="submit", value="Upload"),
767 T.input(type="checkbox", name="mutable"),
769 forms.append(T.div(class_="freeform-form")[upload])
771 mount = T.form(action=".", method="post",
772 enctype="multipart/form-data")[
774 T.input(type="hidden", name="t", value="uri"),
775 T.input(type="hidden", name="when_done", value="."),
776 T.legend(class_="freeform-form-label")["Add a link to a file or directory which is already in Tahoe-LAFS."],
778 T.input(type="text", name="name"), " ",
779 "URI of new child: ",
780 T.input(type="text", name="uri"), " ",
781 T.input(type="submit", value="Attach"),
783 forms.append(T.div(class_="freeform-form")[mount])
786 def render_results(self, ctx, data):
788 return get_arg(req, "results", "")
791 def DirectoryJSONMetadata(ctx, dirnode):
795 for name, (childnode, metadata) in children.iteritems():
796 assert IFilesystemNode.providedBy(childnode), childnode
797 rw_uri = childnode.get_uri()
798 ro_uri = childnode.get_readonly_uri()
799 if IFileNode.providedBy(childnode):
800 if childnode.is_readonly():
802 kiddata = ("filenode", {'size': childnode.get_size(),
803 'mutable': childnode.is_mutable(),
805 elif IDirectoryNode.providedBy(childnode):
806 if childnode.is_readonly():
808 kiddata = ("dirnode", {'mutable': childnode.is_mutable()})
810 kiddata = ("unknown", {})
811 kiddata[1]["metadata"] = metadata
813 kiddata[1]["ro_uri"] = ro_uri
815 kiddata[1]["rw_uri"] = rw_uri
816 verifycap = childnode.get_verify_cap()
818 kiddata[1]['verify_uri'] = verifycap.to_string()
820 if dirnode.is_readonly():
822 dro_uri = dirnode.get_uri()
824 drw_uri = dirnode.get_uri()
825 dro_uri = dirnode.get_readonly_uri()
826 contents = { 'children': kids }
828 contents['ro_uri'] = dro_uri
830 contents['rw_uri'] = drw_uri
831 verifycap = dirnode.get_verify_cap()
833 contents['verify_uri'] = verifycap.to_string()
834 contents['mutable'] = dirnode.is_mutable()
835 data = ("dirnode", contents)
836 return simplejson.dumps(data, indent=1) + "\n"
838 d.addCallback(text_plain, ctx)
843 def DirectoryURI(ctx, dirnode):
844 return text_plain(dirnode.get_uri(), ctx)
846 def DirectoryReadonlyURI(ctx, dirnode):
847 return text_plain(dirnode.get_readonly_uri(), ctx)
849 class RenameForm(rend.Page):
851 docFactory = getxmlfile("rename-form.xhtml")
853 def render_title(self, ctx, data):
854 return ctx.tag["Directory SI=%s" % abbreviated_dirnode(self.original)]
856 def render_header(self, ctx, data):
858 "in directory SI=%s" % abbreviated_dirnode(self.original),
861 if self.original.is_readonly():
862 header.append(" (readonly!)")
864 return ctx.tag[header]
866 def render_when_done(self, ctx, data):
867 return T.input(type="hidden", name="when_done", value=".")
869 def render_get_name(self, ctx, data):
871 name = get_arg(req, "name", "")
872 ctx.tag.attributes['value'] = name
876 class ManifestResults(rend.Page, ReloadMixin):
877 docFactory = getxmlfile("manifest.xhtml")
879 def __init__(self, client, monitor):
881 self.monitor = monitor
883 def renderHTTP(self, ctx):
884 req = inevow.IRequest(ctx)
885 output = get_arg(req, "output", "html").lower()
887 return self.text(req)
889 return self.json(req)
890 return rend.Page.renderHTTP(self, ctx)
892 def slashify_path(self, path):
895 return "/".join([p.encode("utf-8") for p in path])
898 req.setHeader("content-type", "text/plain")
900 is_finished = self.monitor.is_finished()
901 lines.append("finished: " + {True: "yes", False: "no"}[is_finished])
902 for (path, cap) in self.monitor.get_status()["manifest"]:
903 lines.append(self.slashify_path(path) + " " + cap)
904 return "\n".join(lines) + "\n"
907 req.setHeader("content-type", "text/plain")
911 status = { "stats": s["stats"],
912 "finished": m.is_finished(),
913 "origin": base32.b2a(m.origin_si),
916 # don't return manifest/verifycaps/SIs unless the operation is
917 # done, to save on CPU/memory (both here and in the HTTP client
918 # who has to unpack the JSON). Tests show that the ManifestWalker
919 # needs about 1092 bytes per item, the JSON we generate here
920 # requires about 503 bytes per item, and some internal overhead
921 # (perhaps transport-layer buffers in twisted.web?) requires an
922 # additional 1047 bytes per item.
923 status.update({ "manifest": s["manifest"],
924 "verifycaps": [i for i in s["verifycaps"]],
925 "storage-index": [i for i in s["storage-index"]],
927 # simplejson doesn't know how to serialize a set. We use a
928 # generator that walks the set rather than list(setofthing) to
929 # save a small amount of memory (4B*len) and a moderate amount of
931 return simplejson.dumps(status, indent=1)
933 def _si_abbrev(self):
934 return base32.b2a(self.monitor.origin_si)[:6]
936 def render_title(self, ctx):
937 return T.title["Manifest of SI=%s" % self._si_abbrev()]
939 def render_header(self, ctx):
940 return T.p["Manifest of SI=%s" % self._si_abbrev()]
942 def data_items(self, ctx, data):
943 return self.monitor.get_status()["manifest"]
945 def render_row(self, ctx, (path, cap)):
946 ctx.fillSlots("path", self.slashify_path(path))
948 # TODO: we need a clean consistent way to get the type of a cap string
950 if cap.startswith("URI:CHK") or cap.startswith("URI:SSK"):
951 nameurl = urllib.quote(path[-1].encode("utf-8"))
952 uri_link = "%s/file/%s/@@named=/%s" % (root, urllib.quote(cap),
955 uri_link = "%s/uri/%s" % (root, urllib.quote(cap, safe=""))
956 ctx.fillSlots("cap", T.a(href=uri_link)[cap])
958 ctx.fillSlots("cap", "")
961 class DeepSizeResults(rend.Page):
962 def __init__(self, client, monitor):
964 self.monitor = monitor
966 def renderHTTP(self, ctx):
967 req = inevow.IRequest(ctx)
968 output = get_arg(req, "output", "html").lower()
969 req.setHeader("content-type", "text/plain")
971 return self.json(req)
973 is_finished = self.monitor.is_finished()
974 output = "finished: " + {True: "yes", False: "no"}[is_finished] + "\n"
976 stats = self.monitor.get_status()
977 total = (stats.get("size-immutable-files", 0)
978 + stats.get("size-mutable-files", 0)
979 + stats.get("size-directories", 0))
980 output += "size: %d\n" % total
984 status = {"finished": self.monitor.is_finished(),
985 "size": self.monitor.get_status(),
987 return simplejson.dumps(status)
989 class DeepStatsResults(rend.Page):
990 def __init__(self, client, monitor):
992 self.monitor = monitor
994 def renderHTTP(self, ctx):
996 inevow.IRequest(ctx).setHeader("content-type", "text/plain")
997 s = self.monitor.get_status().copy()
998 s["finished"] = self.monitor.is_finished()
999 return simplejson.dumps(s, indent=1)
1001 class ManifestStreamer(dirnode.DeepStats):
1002 implements(IPushProducer)
1004 def __init__(self, ctx, origin):
1005 dirnode.DeepStats.__init__(self, origin)
1006 self.req = IRequest(ctx)
1008 def setMonitor(self, monitor):
1009 self.monitor = monitor
1010 def pauseProducing(self):
1012 def resumeProducing(self):
1014 def stopProducing(self):
1015 self.monitor.cancel()
1017 def add_node(self, node, path):
1018 dirnode.DeepStats.add_node(self, node, path)
1020 "cap": node.get_uri()}
1022 if IDirectoryNode.providedBy(node):
1023 d["type"] = "directory"
1024 elif IFileNode.providedBy(node):
1027 d["type"] = "unknown"
1029 v = node.get_verify_cap()
1034 r = node.get_repair_cap()
1039 si = node.get_storage_index()
1042 d["storage-index"] = si
1044 j = simplejson.dumps(d, ensure_ascii=True)
1045 assert "\n" not in j
1046 self.req.write(j+"\n")
1049 stats = dirnode.DeepStats.get_results(self)
1050 d = {"type": "stats",
1053 j = simplejson.dumps(d, ensure_ascii=True)
1054 assert "\n" not in j
1055 self.req.write(j+"\n")
1058 class DeepCheckStreamer(dirnode.DeepStats):
1059 implements(IPushProducer)
1061 def __init__(self, ctx, origin, verify, repair, add_lease):
1062 dirnode.DeepStats.__init__(self, origin)
1063 self.req = IRequest(ctx)
1064 self.verify = verify
1065 self.repair = repair
1066 self.add_lease = add_lease
1068 def setMonitor(self, monitor):
1069 self.monitor = monitor
1070 def pauseProducing(self):
1072 def resumeProducing(self):
1074 def stopProducing(self):
1075 self.monitor.cancel()
1077 def add_node(self, node, path):
1078 dirnode.DeepStats.add_node(self, node, path)
1079 data = {"path": path,
1080 "cap": node.get_uri()}
1082 if IDirectoryNode.providedBy(node):
1083 data["type"] = "directory"
1085 data["type"] = "file"
1087 v = node.get_verify_cap()
1090 data["verifycap"] = v
1092 r = node.get_repair_cap()
1095 data["repaircap"] = r
1097 si = node.get_storage_index()
1100 data["storage-index"] = si
1103 d = node.check_and_repair(self.monitor, self.verify, self.add_lease)
1104 d.addCallback(self.add_check_and_repair, data)
1106 d = node.check(self.monitor, self.verify, self.add_lease)
1107 d.addCallback(self.add_check, data)
1108 d.addCallback(self.write_line)
1111 def add_check_and_repair(self, crr, data):
1112 data["check-and-repair-results"] = json_check_and_repair_results(crr)
1115 def add_check(self, cr, data):
1116 data["check-results"] = json_check_results(cr)
1119 def write_line(self, data):
1120 j = simplejson.dumps(data, ensure_ascii=True)
1121 assert "\n" not in j
1122 self.req.write(j+"\n")
1125 stats = dirnode.DeepStats.get_results(self)
1126 d = {"type": "stats",
1129 j = simplejson.dumps(d, ensure_ascii=True)
1130 assert "\n" not in j
1131 self.req.write(j+"\n")
1134 class UnknownNodeHandler(RenderMixin, rend.Page):
1136 def __init__(self, client, node, parentnode=None, name=None):
1137 rend.Page.__init__(self)
1141 def render_GET(self, ctx):
1143 t = get_arg(req, "t", "").strip()
1145 return MoreInfo(self.node)
1146 raise WebError("GET unknown URI type: can only do t=info, not t=%s" % t)