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
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.util.encodingutil import to_str
17 from allmydata.uri import from_string_dirnode
18 from allmydata.interfaces import IDirectoryNode, IFileNode, IFilesystemNode, \
19 IImmutableFileNode, IMutableFileNode, ExistingChildError, \
20 NoSuchChildError, EmptyPathnameComponentError, SDMF_VERSION, MDMF_VERSION
21 from allmydata.blacklist import ProhibitedNode
22 from allmydata.monitor import Monitor, OperationCancelledError
23 from allmydata import dirnode
24 from allmydata.web.common import text_plain, WebError, \
25 IOpHandleTable, NeedOperationHandleError, \
26 boolean_of_arg, get_arg, get_root, parse_replace_arg, \
27 should_create_intermediate_directories, \
28 getxmlfile, RenderMixin, humanize_failure, convert_children_json, \
29 get_format, get_mutable_type, get_filenode_metadata
30 from allmydata.web.filenode import ReplaceMeMixin, \
31 FileNodeHandler, PlaceHolderNodeHandler
32 from allmydata.web.check_results import CheckResultsRenderer, \
33 CheckAndRepairResultsRenderer, DeepCheckResultsRenderer, \
34 DeepCheckAndRepairResultsRenderer, LiteralCheckResultsRenderer
35 from allmydata.web.info import MoreInfo
36 from allmydata.web.operations import ReloadMixin
37 from allmydata.web.check_results import json_check_results, \
38 json_check_and_repair_results
40 class BlockingFileError(Exception):
41 # TODO: catch and transform
42 """We cannot auto-create a parent directory, because there is a file in
45 def make_handler_for(node, client, parentnode=None, name=None):
47 assert IDirectoryNode.providedBy(parentnode)
48 if IFileNode.providedBy(node):
49 return FileNodeHandler(client, node, parentnode, name)
50 if IDirectoryNode.providedBy(node):
51 return DirectoryNodeHandler(client, node, parentnode, name)
52 return UnknownNodeHandler(client, node, parentnode, name)
54 class DirectoryNodeHandler(RenderMixin, rend.Page, ReplaceMeMixin):
57 def __init__(self, client, node, parentnode=None, name=None):
58 rend.Page.__init__(self)
62 self.parentnode = parentnode
65 def childFactory(self, ctx, name):
66 name = name.decode("utf-8")
68 raise EmptyPathnameComponentError()
69 d = self.node.get(name)
70 d.addBoth(self.got_child, ctx, name)
71 # got_child returns a handler resource: FileNodeHandler or
72 # DirectoryNodeHandler
75 def got_child(self, node_or_failure, ctx, name):
77 if DEBUG: print "GOT_CHILD", name, node_or_failure
80 nonterminal = len(req.postpath) > 1
81 t = get_arg(req, "t", "").strip()
82 if isinstance(node_or_failure, Failure):
84 f.trap(NoSuchChildError)
85 # No child by this name. What should we do about it?
86 if DEBUG: print "no child", name
87 if DEBUG: print "postpath", req.postpath
89 if DEBUG: print " intermediate"
90 if should_create_intermediate_directories(req):
91 # create intermediate directories
92 if DEBUG: print " making intermediate directory"
93 d = self.node.create_subdirectory(name)
94 d.addCallback(make_handler_for,
95 self.client, self.node, name)
98 if DEBUG: print " terminal"
100 if (method,t) in [ ("POST","mkdir"), ("PUT","mkdir"),
101 ("POST", "mkdir-with-children"),
102 ("POST", "mkdir-immutable") ]:
103 if DEBUG: print " making final directory"
106 if t in ("mkdir-with-children", "mkdir-immutable"):
108 kids_json = req.content.read()
109 kids = convert_children_json(self.client.nodemaker,
111 file_format = get_format(req, None)
113 mt = get_mutable_type(file_format)
114 if t == "mkdir-immutable":
117 d = self.node.create_subdirectory(name, kids,
120 d.addCallback(make_handler_for,
121 self.client, self.node, name)
123 if (method,t) in ( ("PUT",""), ("PUT","uri"), ):
124 if DEBUG: print " PUT, making leaf placeholder"
125 # we were trying to find the leaf filenode (to put a new
126 # file in its place), and it didn't exist. That's ok,
127 # since that's the leaf node that we're about to create.
128 # We make a dummy one, which will respond to the PUT
129 # request by replacing itself.
130 return PlaceHolderNodeHandler(self.client, self.node, name)
131 if DEBUG: print " 404"
132 # otherwise, we just return a no-such-child error
135 node = node_or_failure
136 if nonterminal and should_create_intermediate_directories(req):
137 if not IDirectoryNode.providedBy(node):
138 # we would have put a new directory here, but there was a
140 if DEBUG: print "blocking"
141 raise WebError("Unable to create directory '%s': "
142 "a file was in the way" % name,
144 if DEBUG: print "good child"
145 return make_handler_for(node, self.client, self.node, name)
147 def render_DELETE(self, ctx):
148 assert self.parentnode and self.name
149 d = self.parentnode.delete(self.name)
150 d.addCallback(lambda res: self.node.get_uri())
153 def render_GET(self, ctx):
155 # This is where all of the directory-related ?t=* code goes.
156 t = get_arg(req, "t", "").strip()
158 # t=info contains variable ophandles, t=rename-form contains the name
159 # of the child being renamed. Neither is allowed an ETag.
160 FIXED_OUTPUT_TYPES = ["", "json", "uri", "readonly-uri"]
161 if not self.node.is_mutable() and t in FIXED_OUTPUT_TYPES:
162 si = self.node.get_storage_index()
163 if si and req.setETag('DIR:%s-%s' % (base32.b2a(si), t or "")):
167 # render the directory as HTML, using the docFactory and Nevow's
168 # whole templating thing.
169 return DirectoryAsHTML(self.node,
170 self.client.mutable_file_default)
173 return DirectoryJSONMetadata(ctx, self.node)
175 return MoreInfo(self.node)
177 return DirectoryURI(ctx, self.node)
178 if t == "readonly-uri":
179 return DirectoryReadonlyURI(ctx, self.node)
180 if t == 'rename-form':
181 return RenameForm(self.node)
183 raise WebError("GET directory: bad t=%s" % t)
185 def render_PUT(self, ctx):
187 t = get_arg(req, "t", "").strip()
188 replace = parse_replace_arg(get_arg(req, "replace", "true"))
191 # our job was done by the traversal/create-intermediate-directory
192 # process that got us here.
193 return text_plain(self.node.get_uri(), ctx) # TODO: urlencode
196 # they're trying to set_uri and that name is already occupied
198 raise ExistingChildError()
199 d = self.replace_me_with_a_childcap(req, self.client, replace)
203 raise WebError("PUT to a directory")
205 def render_POST(self, ctx):
207 t = get_arg(req, "t", "").strip()
210 d = self._POST_mkdir(req)
211 elif t == "mkdir-with-children":
212 d = self._POST_mkdir_with_children(req)
213 elif t == "mkdir-immutable":
214 d = self._POST_mkdir_immutable(req)
216 d = self._POST_upload(ctx) # this one needs the context
218 d = self._POST_uri(req)
219 elif t == "delete" or t == "unlink":
220 d = self._POST_unlink(req)
222 d = self._POST_rename(req)
224 d = self._POST_relink(req)
226 d = self._POST_check(req)
227 elif t == "start-deep-check":
228 d = self._POST_start_deep_check(ctx)
229 elif t == "stream-deep-check":
230 d = self._POST_stream_deep_check(ctx)
231 elif t == "start-manifest":
232 d = self._POST_start_manifest(ctx)
233 elif t == "start-deep-size":
234 d = self._POST_start_deep_size(ctx)
235 elif t == "start-deep-stats":
236 d = self._POST_start_deep_stats(ctx)
237 elif t == "stream-manifest":
238 d = self._POST_stream_manifest(ctx)
239 elif t == "set_children" or t == "set-children":
240 d = self._POST_set_children(req)
242 raise WebError("POST to a directory with bad t=%s" % t)
244 when_done = get_arg(req, "when_done", None)
246 d.addCallback(lambda res: url.URL.fromString(when_done))
249 def _POST_mkdir(self, req):
250 name = get_arg(req, "name", "")
252 # our job is done, it was handled by the code in got_child
253 # which created the final directory (i.e. us)
254 return defer.succeed(self.node.get_uri()) # TODO: urlencode
255 name = name.decode("utf-8")
256 replace = boolean_of_arg(get_arg(req, "replace", "true"))
258 mt = get_mutable_type(get_format(req, None))
259 d = self.node.create_subdirectory(name, kids, overwrite=replace,
261 d.addCallback(lambda child: child.get_uri()) # TODO: urlencode
264 def _POST_mkdir_with_children(self, req):
265 name = get_arg(req, "name", "")
267 # our job is done, it was handled by the code in got_child
268 # which created the final directory (i.e. us)
269 return defer.succeed(self.node.get_uri()) # TODO: urlencode
270 name = name.decode("utf-8")
271 # TODO: decide on replace= behavior, see #903
272 #replace = boolean_of_arg(get_arg(req, "replace", "false"))
274 kids_json = req.content.read()
275 kids = convert_children_json(self.client.nodemaker, kids_json)
276 mt = get_mutable_type(get_format(req, None))
277 d = self.node.create_subdirectory(name, kids, overwrite=False,
279 d.addCallback(lambda child: child.get_uri()) # TODO: urlencode
282 def _POST_mkdir_immutable(self, req):
283 name = get_arg(req, "name", "")
285 # our job is done, it was handled by the code in got_child
286 # which created the final directory (i.e. us)
287 return defer.succeed(self.node.get_uri()) # TODO: urlencode
288 name = name.decode("utf-8")
289 # TODO: decide on replace= behavior, see #903
290 #replace = boolean_of_arg(get_arg(req, "replace", "false"))
292 kids_json = req.content.read()
293 kids = convert_children_json(self.client.nodemaker, kids_json)
294 d = self.node.create_subdirectory(name, kids, overwrite=False, mutable=False)
295 d.addCallback(lambda child: child.get_uri()) # TODO: urlencode
298 def _POST_upload(self, ctx):
300 charset = get_arg(req, "_charset", "utf-8")
301 contents = req.fields["file"]
302 assert contents.filename is None or isinstance(contents.filename, str)
303 name = get_arg(req, "name")
304 name = name or contents.filename
308 # this prohibts empty, missing, and all-whitespace filenames
309 raise WebError("upload requires a name")
310 assert isinstance(name, str)
311 name = name.decode(charset)
313 raise WebError("name= may not contain a slash", http.BAD_REQUEST)
314 assert isinstance(name, unicode)
316 # since POST /uri/path/file?t=upload is equivalent to
317 # POST /uri/path/dir?t=upload&name=foo, just do the same thing that
318 # childFactory would do. Things are cleaner if we only do a subset of
319 # them, though, so we don't do: d = self.childFactory(ctx, name)
321 d = self.node.get(name)
322 def _maybe_got_node(node_or_failure):
323 if isinstance(node_or_failure, Failure):
325 f.trap(NoSuchChildError)
326 # create a placeholder which will see POST t=upload
327 return PlaceHolderNodeHandler(self.client, self.node, name)
329 node = node_or_failure
330 return make_handler_for(node, self.client, self.node, name)
331 d.addBoth(_maybe_got_node)
332 # now we have a placeholder or a filenodehandler, and we can just
333 # delegate to it. We could return the resource back out of
334 # DirectoryNodeHandler.renderHTTP, and nevow would recurse into it,
335 # but the addCallback() that handles when_done= would break.
336 d.addCallback(lambda child: child.renderHTTP(ctx))
339 def _POST_uri(self, req):
340 childcap = get_arg(req, "uri")
342 raise WebError("set-uri requires a uri")
343 name = get_arg(req, "name")
345 raise WebError("set-uri requires a name")
346 charset = get_arg(req, "_charset", "utf-8")
347 name = name.decode(charset)
348 replace = parse_replace_arg(get_arg(req, "replace", "true"))
350 # We mustn't pass childcap for the readcap argument because we don't
351 # know whether it is a read cap. Passing a read cap as the writecap
352 # argument will work (it ends up calling NodeMaker.create_from_cap,
353 # which derives a readcap if necessary and possible).
354 d = self.node.set_uri(name, childcap, None, overwrite=replace)
355 d.addCallback(lambda res: childcap)
358 def _POST_unlink(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 unlinking of a
364 # child with a name that is the empty string, we have to
365 # pretend that None means ''. The only downside of this is
366 # a slightly confusing error message if someone does a POST
367 # without a name= field. For our own HTML this isn't a big
368 # deal, because we create the 'unlink' POST buttons ourselves.
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 unlinked")
376 def _POST_rename(self, req):
377 # rename is identical to relink, but to_dir is not allowed
378 # and to_name is required.
379 if get_arg(req, "to_dir") is not None:
380 raise WebError("to_dir= is not valid for rename")
381 if get_arg(req, "to_name") is None:
382 raise WebError("to_name= is required for rename")
383 return self._POST_relink(req)
385 def _POST_relink(self, req):
386 charset = get_arg(req, "_charset", "utf-8")
387 replace = parse_replace_arg(get_arg(req, "replace", "true"))
389 from_name = get_arg(req, "from_name")
390 if from_name is not None:
391 from_name = from_name.strip()
392 from_name = from_name.decode(charset)
393 assert isinstance(from_name, unicode)
395 raise WebError("from_name= is required")
397 to_name = get_arg(req, "to_name")
398 if to_name is not None:
399 to_name = to_name.strip()
400 to_name = to_name.decode(charset)
401 assert isinstance(to_name, unicode)
405 # Disallow slashes in both from_name and to_name, that would only
408 raise WebError("from_name= may not contain a slash",
411 raise WebError("to_name= may not contain a slash",
414 to_dir = get_arg(req, "to_dir")
415 if to_dir is not None and to_dir != self.node.get_write_uri():
416 to_dir = to_dir.strip()
417 to_dir = to_dir.decode(charset)
418 assert isinstance(to_dir, unicode)
419 to_path = to_dir.split(u"/")
420 to_root = self.client.nodemaker.create_from_cap(to_str(to_path[0]))
421 if not IDirectoryNode.providedBy(to_root):
422 raise WebError("to_dir is not a directory", http.BAD_REQUEST)
423 d = to_root.get_child_at_path(to_path[1:])
425 d = defer.succeed(self.node)
427 def _got_new_parent(new_parent):
428 if not IDirectoryNode.providedBy(new_parent):
429 raise WebError("to_dir is not a directory", http.BAD_REQUEST)
431 return self.node.move_child_to(from_name, new_parent,
433 d.addCallback(_got_new_parent)
434 d.addCallback(lambda res: "thing moved")
437 def _maybe_literal(self, res, Results_Class):
439 return Results_Class(self.client, res)
440 return LiteralCheckResultsRenderer(self.client)
442 def _POST_check(self, req):
443 # check this directory
444 verify = boolean_of_arg(get_arg(req, "verify", "false"))
445 repair = boolean_of_arg(get_arg(req, "repair", "false"))
446 add_lease = boolean_of_arg(get_arg(req, "add-lease", "false"))
448 d = self.node.check_and_repair(Monitor(), verify, add_lease)
449 d.addCallback(self._maybe_literal, CheckAndRepairResultsRenderer)
451 d = self.node.check(Monitor(), verify, add_lease)
452 d.addCallback(self._maybe_literal, CheckResultsRenderer)
455 def _start_operation(self, monitor, renderer, ctx):
456 table = IOpHandleTable(ctx)
457 table.add_monitor(ctx, monitor, renderer)
458 return table.redirect_to(ctx)
460 def _POST_start_deep_check(self, ctx):
461 # check this directory and everything reachable from it
462 if not get_arg(ctx, "ophandle"):
463 raise NeedOperationHandleError("slow operation requires ophandle=")
464 verify = boolean_of_arg(get_arg(ctx, "verify", "false"))
465 repair = boolean_of_arg(get_arg(ctx, "repair", "false"))
466 add_lease = boolean_of_arg(get_arg(ctx, "add-lease", "false"))
468 monitor = self.node.start_deep_check_and_repair(verify, add_lease)
469 renderer = DeepCheckAndRepairResultsRenderer(self.client, monitor)
471 monitor = self.node.start_deep_check(verify, add_lease)
472 renderer = DeepCheckResultsRenderer(self.client, monitor)
473 return self._start_operation(monitor, renderer, ctx)
475 def _POST_stream_deep_check(self, ctx):
476 verify = boolean_of_arg(get_arg(ctx, "verify", "false"))
477 repair = boolean_of_arg(get_arg(ctx, "repair", "false"))
478 add_lease = boolean_of_arg(get_arg(ctx, "add-lease", "false"))
479 walker = DeepCheckStreamer(ctx, self.node, verify, repair, add_lease)
480 monitor = self.node.deep_traverse(walker)
481 walker.setMonitor(monitor)
482 # register to hear stopProducing. The walker ignores pauseProducing.
483 IRequest(ctx).registerProducer(walker, True)
484 d = monitor.when_done()
486 IRequest(ctx).unregisterProducer()
490 f.trap(OperationCancelledError)
491 return "Operation Cancelled"
492 d.addErrback(_cancelled)
494 # signal the error as a non-JSON "ERROR:" line, plus exception
495 msg = "ERROR: %s(%s)\n" % (f.value.__class__.__name__,
496 ", ".join([str(a) for a in f.value.args]))
502 def _POST_start_manifest(self, ctx):
503 if not get_arg(ctx, "ophandle"):
504 raise NeedOperationHandleError("slow operation requires ophandle=")
505 monitor = self.node.build_manifest()
506 renderer = ManifestResults(self.client, monitor)
507 return self._start_operation(monitor, renderer, ctx)
509 def _POST_start_deep_size(self, ctx):
510 if not get_arg(ctx, "ophandle"):
511 raise NeedOperationHandleError("slow operation requires ophandle=")
512 monitor = self.node.start_deep_stats()
513 renderer = DeepSizeResults(self.client, monitor)
514 return self._start_operation(monitor, renderer, ctx)
516 def _POST_start_deep_stats(self, ctx):
517 if not get_arg(ctx, "ophandle"):
518 raise NeedOperationHandleError("slow operation requires ophandle=")
519 monitor = self.node.start_deep_stats()
520 renderer = DeepStatsResults(self.client, monitor)
521 return self._start_operation(monitor, renderer, ctx)
523 def _POST_stream_manifest(self, ctx):
524 walker = ManifestStreamer(ctx, self.node)
525 monitor = self.node.deep_traverse(walker)
526 walker.setMonitor(monitor)
527 # register to hear stopProducing. The walker ignores pauseProducing.
528 IRequest(ctx).registerProducer(walker, True)
529 d = monitor.when_done()
531 IRequest(ctx).unregisterProducer()
535 f.trap(OperationCancelledError)
536 return "Operation Cancelled"
537 d.addErrback(_cancelled)
539 # signal the error as a non-JSON "ERROR:" line, plus exception
540 msg = "ERROR: %s(%s)\n" % (f.value.__class__.__name__,
541 ", ".join([str(a) for a in f.value.args]))
547 def _POST_set_children(self, req):
548 replace = parse_replace_arg(get_arg(req, "replace", "true"))
550 body = req.content.read()
552 children = simplejson.loads(body)
553 except ValueError, le:
554 le.args = tuple(le.args + (body,))
555 # TODO test handling of bad JSON
558 for name, (file_or_dir, mddict) in children.iteritems():
559 name = unicode(name) # simplejson-2.0.1 returns str *or* unicode
560 writecap = mddict.get('rw_uri')
561 if writecap is not None:
562 writecap = str(writecap)
563 readcap = mddict.get('ro_uri')
564 if readcap is not None:
565 readcap = str(readcap)
566 cs[name] = (writecap, readcap, mddict.get('metadata'))
567 d = self.node.set_children(cs, replace)
568 d.addCallback(lambda res: "Okay so I did it.")
572 def abbreviated_dirnode(dirnode):
573 u = from_string_dirnode(dirnode.get_uri())
578 class DirectoryAsHTML(rend.Page):
579 # The remainder of this class is to render the directory into
580 # human+browser -oriented HTML.
581 docFactory = getxmlfile("directory.xhtml")
584 def __init__(self, node, default_mutable_format):
585 rend.Page.__init__(self)
588 assert default_mutable_format in (MDMF_VERSION, SDMF_VERSION)
589 self.default_mutable_format = default_mutable_format
591 def beforeRender(self, ctx):
592 # attempt to get the dirnode's children, stashing them (or the
593 # failure that results) for later use
596 # Deferreds don't optimize out tail recursion, and the way
597 # Nevow's flattener handles Deferreds doesn't take this into
598 # account. As a result, large lists of Deferreds that fire in the
599 # same turn (i.e. the output of defer.succeed) will cause a stack
600 # overflow. To work around this, we insert a turn break after
601 # every 100 items, using foolscap's fireEventually(). This gives
602 # the stack a chance to be popped. It would also work to put
603 # every item in its own turn, but that'd be a lot more
604 # inefficient. This addresses ticket #237, for which I was never
605 # able to create a failing unit test.
607 for i,item in enumerate(sorted(children.items())):
609 output.append(fireEventually(item))
612 self.dirnode_children = output
615 text, code = humanize_failure(f)
616 self.dirnode_children = None
617 self.dirnode_children_error = text
619 d.addCallbacks(_good, _bad)
622 def render_title(self, ctx, data):
623 si_s = abbreviated_dirnode(self.node)
624 header = ["Tahoe-LAFS - Directory SI=%s" % si_s]
625 if self.node.is_unknown():
626 header.append(" (unknown)")
627 elif not self.node.is_mutable():
628 header.append(" (immutable)")
629 elif self.node.is_readonly():
630 header.append(" (read-only)")
632 header.append(" (modifiable)")
633 return ctx.tag[header]
635 def render_header(self, ctx, data):
636 si_s = abbreviated_dirnode(self.node)
637 header = ["Tahoe-LAFS Directory SI=", T.span(class_="data-chars")[si_s]]
638 if self.node.is_unknown():
639 header.append(" (unknown)")
640 elif not self.node.is_mutable():
641 header.append(" (immutable)")
642 elif self.node.is_readonly():
643 header.append(" (read-only)")
644 return ctx.tag[header]
646 def render_welcome(self, ctx, data):
648 return ctx.tag[T.a(href=link)["Return to Welcome page"]]
650 def render_show_readonly(self, ctx, data):
651 if self.node.is_unknown() or self.node.is_readonly():
653 rocap = self.node.get_readonly_uri()
655 uri_link = "%s/uri/%s/" % (root, urllib.quote(rocap))
656 return ctx.tag[T.a(href=uri_link)["Read-Only Version"]]
658 def render_try_children(self, ctx, data):
659 # if the dirnode can be retrived, render a table of children.
660 # Otherwise, render an apologetic error message.
661 if self.dirnode_children is not None:
664 return T.div[T.p["Error reading directory:"],
665 T.p[self.dirnode_children_error]]
667 def data_children(self, ctx, data):
668 return self.dirnode_children
670 def render_row(self, ctx, data):
671 name, (target, metadata) = data
672 name = name.encode("utf-8")
673 assert not isinstance(name, unicode)
674 nameurl = urllib.quote(name, safe="") # encode any slashes too
677 here = "%s/uri/%s/" % (root, urllib.quote(self.node.get_uri()))
678 if self.node.is_unknown() or self.node.is_readonly():
682 # this creates a button which will cause our _POST_unlink method
683 # to be invoked, which unlinks the file and then redirects the
684 # browser back to this directory
685 unlink = T.form(action=here, method="post")[
686 T.input(type='hidden', name='t', value='unlink'),
687 T.input(type='hidden', name='name', value=name),
688 T.input(type='hidden', name='when_done', value="."),
689 T.input(type='submit', _class='btn', value='unlink', name="unlink"),
692 rename = T.form(action=here, method="get")[
693 T.input(type='hidden', name='t', value='rename-form'),
694 T.input(type='hidden', name='name', value=name),
695 T.input(type='hidden', name='when_done', value="."),
696 T.input(type='submit', _class='btn', value='rename/relink', name="rename"),
699 ctx.fillSlots("unlink", unlink)
700 ctx.fillSlots("rename", rename)
703 linkcrtime = metadata.get('tahoe', {}).get("linkcrtime")
704 if linkcrtime is not None:
705 times.append("lcr: " + time_format.iso_local(linkcrtime))
707 # For backwards-compatibility with links last modified by Tahoe < 1.4.0:
708 if "ctime" in metadata:
709 ctime = time_format.iso_local(metadata["ctime"])
710 times.append("c: " + ctime)
711 linkmotime = metadata.get('tahoe', {}).get("linkmotime")
712 if linkmotime is not None:
715 times.append("lmo: " + time_format.iso_local(linkmotime))
717 # For backwards-compatibility with links last modified by Tahoe < 1.4.0:
718 if "mtime" in metadata:
719 mtime = time_format.iso_local(metadata["mtime"])
722 times.append("m: " + mtime)
723 ctx.fillSlots("times", times)
725 assert IFilesystemNode.providedBy(target), target
726 target_uri = target.get_uri() or ""
727 quoted_uri = urllib.quote(target_uri, safe="") # escape slashes too
729 if IMutableFileNode.providedBy(target):
730 # to prevent javascript in displayed .html files from stealing a
731 # secret directory URI from the URL, send the browser to a URI-based
732 # page that doesn't know about the directory at all
733 dlurl = "%s/file/%s/@@named=/%s" % (root, quoted_uri, nameurl)
735 ctx.fillSlots("filename", T.a(href=dlurl)[name])
736 ctx.fillSlots("type", "SSK")
738 ctx.fillSlots("size", "?")
740 info_link = "%s/uri/%s?t=info" % (root, quoted_uri)
742 elif IImmutableFileNode.providedBy(target):
743 dlurl = "%s/file/%s/@@named=/%s" % (root, quoted_uri, nameurl)
745 ctx.fillSlots("filename", T.a(href=dlurl)[name])
746 ctx.fillSlots("type", "FILE")
748 ctx.fillSlots("size", target.get_size())
750 info_link = "%s/uri/%s?t=info" % (root, quoted_uri)
752 elif IDirectoryNode.providedBy(target):
754 uri_link = "%s/uri/%s/" % (root, urllib.quote(target_uri))
755 ctx.fillSlots("filename", T.a(href=uri_link)[name])
756 if not target.is_mutable():
758 elif target.is_readonly():
762 ctx.fillSlots("type", dirtype)
763 ctx.fillSlots("size", "-")
764 info_link = "%s/uri/%s/?t=info" % (root, quoted_uri)
766 elif isinstance(target, ProhibitedNode):
767 ctx.fillSlots("filename", T.strike[name])
768 if IDirectoryNode.providedBy(target.wrapped_node):
769 blacklisted_type = "DIR-BLACKLISTED"
771 blacklisted_type = "BLACKLISTED"
772 ctx.fillSlots("type", blacklisted_type)
773 ctx.fillSlots("size", "-")
775 ctx.fillSlots("info", ["Access Prohibited:", T.br, target.reason])
779 ctx.fillSlots("filename", name)
780 if target.get_write_uri() is not None:
782 elif not self.node.is_mutable() or target.is_alleged_immutable():
783 unknowntype = "?-IMM"
786 ctx.fillSlots("type", unknowntype)
787 ctx.fillSlots("size", "-")
788 # use a directory-relative info link, so we can extract both the
789 # writecap and the readcap
790 info_link = "%s?t=info" % urllib.quote(name)
793 ctx.fillSlots("info", T.a(href=info_link)["More Info"])
797 # XXX: similar to render_upload_form and render_mkdir_form in root.py.
798 def render_forms(self, ctx, data):
801 if self.node.is_readonly():
802 return T.div["No upload forms: directory is read-only"]
803 if self.dirnode_children is None:
804 return T.div["No upload forms: directory is unreadable"]
806 mkdir_sdmf = T.input(type='radio', name='format',
807 value='sdmf', id='mkdir-sdmf',
809 mkdir_mdmf = T.input(type='radio', name='format',
810 value='mdmf', id='mkdir-mdmf')
812 mkdir_form = T.form(action=".", method="post",
813 enctype="multipart/form-data")[
815 T.input(type="hidden", name="t", value="mkdir"),
816 T.input(type="hidden", name="when_done", value="."),
817 T.legend(class_="freeform-form-label")["Create a new directory in this directory"],
818 "New directory name:"+SPACE, T.br,
819 T.input(type="text", name="name"), SPACE,
820 T.div(class_="form-inline")[
821 mkdir_sdmf, T.label(for_='mutable-directory-sdmf')[SPACE, "SDMF"], SPACE*2,
822 mkdir_mdmf, T.label(for_='mutable-directory-mdmf')[SPACE, "MDMF (experimental)"]
824 T.input(type="submit", class_="btn", value="Create")
826 forms.append(T.div(class_="freeform-form")[mkdir_form])
828 upload_chk = T.input(type='radio', name='format',
829 value='chk', id='upload-chk',
831 upload_sdmf = T.input(type='radio', name='format',
832 value='sdmf', id='upload-sdmf')
833 upload_mdmf = T.input(type='radio', name='format',
834 value='mdmf', id='upload-mdmf')
836 upload_form = T.form(action=".", method="post",
837 enctype="multipart/form-data")[
839 T.input(type="hidden", name="t", value="upload"),
840 T.input(type="hidden", name="when_done", value="."),
841 T.legend(class_="freeform-form-label")["Upload a file to this directory"],
842 "Choose a file to upload:"+SPACE,
843 T.input(type="file", name="file", class_="freeform-input-file"), SPACE,
844 T.div(class_="form-inline")[
845 upload_chk, T.label(for_="upload-chk") [SPACE, "Immutable"], SPACE*2,
846 upload_sdmf, T.label(for_="upload-sdmf")[SPACE, "SDMF"], SPACE*2,
847 upload_mdmf, T.label(for_="upload-mdmf")[SPACE, "MDMF (experimental)"]
849 T.input(type="submit", class_="btn", value="Upload"), SPACE*2,
851 forms.append(T.div(class_="freeform-form")[upload_form])
853 attach_form = T.form(action=".", method="post",
854 enctype="multipart/form-data")[
855 T.fieldset[ T.div(class_="form-inline")[
856 T.input(type="hidden", name="t", value="uri"),
857 T.input(type="hidden", name="when_done", value="."),
858 T.legend(class_="freeform-form-label")["Add a link to a file or directory which is already in Tahoe-LAFS."],
859 "New child name:"+SPACE,
860 T.input(type="text", name="name"), SPACE*2, T.br,
861 "URI of new child:"+SPACE,
862 T.input(type="text", name="uri"), SPACE,
863 T.input(type="submit", class_="btn", value="Attach"),
865 forms.append(T.div(class_="freeform-form")[attach_form])
868 def render_results(self, ctx, data):
870 return get_arg(req, "results", "")
872 def DirectoryJSONMetadata(ctx, dirnode):
876 for name, (childnode, metadata) in children.iteritems():
877 assert IFilesystemNode.providedBy(childnode), childnode
878 rw_uri = childnode.get_write_uri()
879 ro_uri = childnode.get_readonly_uri()
880 if IFileNode.providedBy(childnode):
881 kiddata = ("filenode", get_filenode_metadata(childnode))
882 elif IDirectoryNode.providedBy(childnode):
883 kiddata = ("dirnode", {'mutable': childnode.is_mutable()})
885 kiddata = ("unknown", {})
887 kiddata[1]["metadata"] = metadata
889 kiddata[1]["rw_uri"] = rw_uri
891 kiddata[1]["ro_uri"] = ro_uri
892 verifycap = childnode.get_verify_cap()
894 kiddata[1]['verify_uri'] = verifycap.to_string()
898 drw_uri = dirnode.get_write_uri()
899 dro_uri = dirnode.get_readonly_uri()
900 contents = { 'children': kids }
902 contents['ro_uri'] = dro_uri
904 contents['rw_uri'] = drw_uri
905 verifycap = dirnode.get_verify_cap()
907 contents['verify_uri'] = verifycap.to_string()
908 contents['mutable'] = dirnode.is_mutable()
909 data = ("dirnode", contents)
910 json = simplejson.dumps(data, indent=1) + "\n"
913 d.addCallback(text_plain, ctx)
917 def DirectoryURI(ctx, dirnode):
918 return text_plain(dirnode.get_uri(), ctx)
920 def DirectoryReadonlyURI(ctx, dirnode):
921 return text_plain(dirnode.get_readonly_uri(), ctx)
923 class RenameForm(rend.Page):
925 docFactory = getxmlfile("rename-form.xhtml")
927 def render_title(self, ctx, data):
928 return ctx.tag["Directory SI=%s" % abbreviated_dirnode(self.original)]
930 def render_header(self, ctx, data):
932 "in directory SI=%s" % abbreviated_dirnode(self.original),
935 if self.original.is_readonly():
936 header.append(" (readonly!)")
938 return ctx.tag[header]
940 def render_when_done(self, ctx, data):
941 return T.input(type="hidden", name="when_done", value=".")
943 def render_get_name(self, ctx, data):
945 name = get_arg(req, "name", "")
946 ctx.tag.attributes['value'] = name
949 class ManifestResults(rend.Page, ReloadMixin):
950 docFactory = getxmlfile("manifest.xhtml")
952 def __init__(self, client, monitor):
954 self.monitor = monitor
956 def renderHTTP(self, ctx):
957 req = inevow.IRequest(ctx)
958 output = get_arg(req, "output", "html").lower()
960 return self.text(req)
962 return self.json(req)
963 return rend.Page.renderHTTP(self, ctx)
965 def slashify_path(self, path):
968 return "/".join([p.encode("utf-8") for p in path])
971 req.setHeader("content-type", "text/plain")
973 is_finished = self.monitor.is_finished()
974 lines.append("finished: " + {True: "yes", False: "no"}[is_finished])
975 for (path, cap) in self.monitor.get_status()["manifest"]:
976 lines.append(self.slashify_path(path) + " " + cap)
977 return "\n".join(lines) + "\n"
980 req.setHeader("content-type", "text/plain")
985 origin_base32 = base32.b2a(m.origin_si)
988 status = { "stats": s["stats"],
989 "finished": m.is_finished(),
990 "origin": origin_base32,
993 # don't return manifest/verifycaps/SIs unless the operation is
994 # done, to save on CPU/memory (both here and in the HTTP client
995 # who has to unpack the JSON). Tests show that the ManifestWalker
996 # needs about 1092 bytes per item, the JSON we generate here
997 # requires about 503 bytes per item, and some internal overhead
998 # (perhaps transport-layer buffers in twisted.web?) requires an
999 # additional 1047 bytes per item.
1000 status.update({ "manifest": s["manifest"],
1001 "verifycaps": [i for i in s["verifycaps"]],
1002 "storage-index": [i for i in s["storage-index"]],
1004 # simplejson doesn't know how to serialize a set. We use a
1005 # generator that walks the set rather than list(setofthing) to
1006 # save a small amount of memory (4B*len) and a moderate amount of
1008 return simplejson.dumps(status, indent=1)
1010 def _si_abbrev(self):
1011 si = self.monitor.origin_si
1014 return base32.b2a(si)[:6]
1016 def render_title(self, ctx):
1017 return T.title["Manifest of SI=%s" % self._si_abbrev()]
1019 def render_header(self, ctx):
1020 return T.p["Manifest of SI=%s" % self._si_abbrev()]
1022 def data_items(self, ctx, data):
1023 return self.monitor.get_status()["manifest"]
1025 def render_row(self, ctx, (path, cap)):
1026 ctx.fillSlots("path", self.slashify_path(path))
1027 root = get_root(ctx)
1028 # TODO: we need a clean consistent way to get the type of a cap string
1030 if cap.startswith("URI:CHK") or cap.startswith("URI:SSK"):
1031 nameurl = urllib.quote(path[-1].encode("utf-8"))
1032 uri_link = "%s/file/%s/@@named=/%s" % (root, urllib.quote(cap),
1035 uri_link = "%s/uri/%s" % (root, urllib.quote(cap, safe=""))
1036 ctx.fillSlots("cap", T.a(href=uri_link)[cap])
1038 ctx.fillSlots("cap", "")
1041 class DeepSizeResults(rend.Page):
1042 def __init__(self, client, monitor):
1043 self.client = client
1044 self.monitor = monitor
1046 def renderHTTP(self, ctx):
1047 req = inevow.IRequest(ctx)
1048 output = get_arg(req, "output", "html").lower()
1049 req.setHeader("content-type", "text/plain")
1050 if output == "json":
1051 return self.json(req)
1053 is_finished = self.monitor.is_finished()
1054 output = "finished: " + {True: "yes", False: "no"}[is_finished] + "\n"
1056 stats = self.monitor.get_status()
1057 total = (stats.get("size-immutable-files", 0)
1058 + stats.get("size-mutable-files", 0)
1059 + stats.get("size-directories", 0))
1060 output += "size: %d\n" % total
1063 def json(self, req):
1064 status = {"finished": self.monitor.is_finished(),
1065 "size": self.monitor.get_status(),
1067 return simplejson.dumps(status)
1069 class DeepStatsResults(rend.Page):
1070 def __init__(self, client, monitor):
1071 self.client = client
1072 self.monitor = monitor
1074 def renderHTTP(self, ctx):
1076 inevow.IRequest(ctx).setHeader("content-type", "text/plain")
1077 s = self.monitor.get_status().copy()
1078 s["finished"] = self.monitor.is_finished()
1079 return simplejson.dumps(s, indent=1)
1081 class ManifestStreamer(dirnode.DeepStats):
1082 implements(IPushProducer)
1084 def __init__(self, ctx, origin):
1085 dirnode.DeepStats.__init__(self, origin)
1086 self.req = IRequest(ctx)
1088 def setMonitor(self, monitor):
1089 self.monitor = monitor
1090 def pauseProducing(self):
1092 def resumeProducing(self):
1094 def stopProducing(self):
1095 self.monitor.cancel()
1097 def add_node(self, node, path):
1098 dirnode.DeepStats.add_node(self, node, path)
1100 "cap": node.get_uri()}
1102 if IDirectoryNode.providedBy(node):
1103 d["type"] = "directory"
1104 elif IFileNode.providedBy(node):
1107 d["type"] = "unknown"
1109 v = node.get_verify_cap()
1112 d["verifycap"] = v or ""
1114 r = node.get_repair_cap()
1117 d["repaircap"] = r or ""
1119 si = node.get_storage_index()
1122 d["storage-index"] = si or ""
1124 j = simplejson.dumps(d, ensure_ascii=True)
1125 assert "\n" not in j
1126 self.req.write(j+"\n")
1129 stats = dirnode.DeepStats.get_results(self)
1130 d = {"type": "stats",
1133 j = simplejson.dumps(d, ensure_ascii=True)
1134 assert "\n" not in j
1135 self.req.write(j+"\n")
1138 class DeepCheckStreamer(dirnode.DeepStats):
1139 implements(IPushProducer)
1141 def __init__(self, ctx, origin, verify, repair, add_lease):
1142 dirnode.DeepStats.__init__(self, origin)
1143 self.req = IRequest(ctx)
1144 self.verify = verify
1145 self.repair = repair
1146 self.add_lease = add_lease
1148 def setMonitor(self, monitor):
1149 self.monitor = monitor
1150 def pauseProducing(self):
1152 def resumeProducing(self):
1154 def stopProducing(self):
1155 self.monitor.cancel()
1157 def add_node(self, node, path):
1158 dirnode.DeepStats.add_node(self, node, path)
1159 data = {"path": path,
1160 "cap": node.get_uri()}
1162 if IDirectoryNode.providedBy(node):
1163 data["type"] = "directory"
1164 elif IFileNode.providedBy(node):
1165 data["type"] = "file"
1167 data["type"] = "unknown"
1169 v = node.get_verify_cap()
1172 data["verifycap"] = v or ""
1174 r = node.get_repair_cap()
1177 data["repaircap"] = r or ""
1179 si = node.get_storage_index()
1182 data["storage-index"] = si or ""
1185 d = node.check_and_repair(self.monitor, self.verify, self.add_lease)
1186 d.addCallback(self.add_check_and_repair, data)
1188 d = node.check(self.monitor, self.verify, self.add_lease)
1189 d.addCallback(self.add_check, data)
1190 d.addCallback(self.write_line)
1193 def add_check_and_repair(self, crr, data):
1194 data["check-and-repair-results"] = json_check_and_repair_results(crr)
1197 def add_check(self, cr, data):
1198 data["check-results"] = json_check_results(cr)
1201 def write_line(self, data):
1202 j = simplejson.dumps(data, ensure_ascii=True)
1203 assert "\n" not in j
1204 self.req.write(j+"\n")
1207 stats = dirnode.DeepStats.get_results(self)
1208 d = {"type": "stats",
1211 j = simplejson.dumps(d, ensure_ascii=True)
1212 assert "\n" not in j
1213 self.req.write(j+"\n")
1217 class UnknownNodeHandler(RenderMixin, rend.Page):
1218 def __init__(self, client, node, parentnode=None, name=None):
1219 rend.Page.__init__(self)
1222 self.parentnode = parentnode
1225 def render_GET(self, ctx):
1227 t = get_arg(req, "t", "").strip()
1229 return MoreInfo(self.node)
1231 is_parent_known_immutable = self.parentnode and not self.parentnode.is_mutable()
1232 if self.parentnode and self.name:
1233 d = self.parentnode.get_metadata_for(self.name)
1235 d = defer.succeed(None)
1236 d.addCallback(lambda md: UnknownJSONMetadata(ctx, self.node, md, is_parent_known_immutable))
1238 raise WebError("GET unknown URI type: can only do t=info and t=json, not t=%s.\n"
1239 "Using a webapi server that supports a later version of Tahoe "
1242 def UnknownJSONMetadata(ctx, node, edge_metadata, is_parent_known_immutable):
1243 rw_uri = node.get_write_uri()
1244 ro_uri = node.get_readonly_uri()
1245 data = ("unknown", {})
1247 data[1]['ro_uri'] = ro_uri
1249 data[1]['rw_uri'] = rw_uri
1250 data[1]['mutable'] = True
1251 elif is_parent_known_immutable or node.is_alleged_immutable():
1252 data[1]['mutable'] = False
1253 # else we don't know whether it is mutable.
1255 if edge_metadata is not None:
1256 data[1]['metadata'] = edge_metadata
1257 return text_plain(simplejson.dumps(data, indent=1) + "\n", ctx)