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" or 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 # TODO: decide on replace= behavior, see #903
254 #replace = boolean_of_arg(get_arg(req, "replace", "false"))
256 kids_json = req.content.read()
257 kids = convert_children_json(self.client.nodemaker, kids_json)
258 d = self.node.create_subdirectory(name, kids, overwrite=False)
259 d.addCallback(lambda child: child.get_uri()) # TODO: urlencode
262 def _POST_mkdir_immutable(self, req):
263 name = get_arg(req, "name", "")
265 # our job is done, it was handled by the code in got_child
266 # which created the final directory (i.e. us)
267 return defer.succeed(self.node.get_uri()) # TODO: urlencode
268 name = name.decode("utf-8")
269 # TODO: decide on replace= behavior, see #903
270 #replace = boolean_of_arg(get_arg(req, "replace", "false"))
272 kids_json = req.content.read()
273 kids = convert_children_json(self.client.nodemaker, kids_json)
274 d = self.node.create_subdirectory(name, kids, overwrite=False, mutable=False)
275 d.addCallback(lambda child: child.get_uri()) # TODO: urlencode
278 def _POST_mkdir_p(self, req):
279 path = get_arg(req, "path")
281 raise WebError("mkdir-p requires a path")
282 path_ = tuple([seg.decode("utf-8") for seg in path.split('/') if seg ])
284 d = self._get_or_create_directories(self.node, path_)
285 d.addCallback(lambda node: node.get_uri())
288 def _get_or_create_directories(self, node, path):
289 if not IDirectoryNode.providedBy(node):
290 # unfortunately it is too late to provide the name of the
291 # blocking directory in the error message.
292 raise BlockingFileError("cannot create directory because there "
293 "is a file in the way")
295 return defer.succeed(node)
296 d = node.get(path[0])
297 def _maybe_create(f):
298 f.trap(NoSuchChildError)
299 return node.create_subdirectory(path[0])
300 d.addErrback(_maybe_create)
301 d.addCallback(self._get_or_create_directories, path[1:])
304 def _POST_upload(self, ctx):
306 charset = get_arg(req, "_charset", "utf-8")
307 contents = req.fields["file"]
308 assert contents.filename is None or isinstance(contents.filename, str)
309 name = get_arg(req, "name")
310 name = name or contents.filename
314 # this prohibts empty, missing, and all-whitespace filenames
315 raise WebError("upload requires a name")
316 assert isinstance(name, str)
317 name = name.decode(charset)
319 raise WebError("name= may not contain a slash", http.BAD_REQUEST)
320 assert isinstance(name, unicode)
322 # since POST /uri/path/file?t=upload is equivalent to
323 # POST /uri/path/dir?t=upload&name=foo, just do the same thing that
324 # childFactory would do. Things are cleaner if we only do a subset of
325 # them, though, so we don't do: d = self.childFactory(ctx, name)
327 d = self.node.get(name)
328 def _maybe_got_node(node_or_failure):
329 if isinstance(node_or_failure, Failure):
331 f.trap(NoSuchChildError)
332 # create a placeholder which will see POST t=upload
333 return PlaceHolderNodeHandler(self.client, self.node, name)
335 node = node_or_failure
336 return make_handler_for(node, self.client, self.node, name)
337 d.addBoth(_maybe_got_node)
338 # now we have a placeholder or a filenodehandler, and we can just
339 # delegate to it. We could return the resource back out of
340 # DirectoryNodeHandler.renderHTTP, and nevow would recurse into it,
341 # but the addCallback() that handles when_done= would break.
342 d.addCallback(lambda child: child.renderHTTP(ctx))
345 def _POST_uri(self, req):
346 childcap = get_arg(req, "uri")
348 raise WebError("set-uri requires a uri")
349 name = get_arg(req, "name")
351 raise WebError("set-uri requires a name")
352 charset = get_arg(req, "_charset", "utf-8")
353 name = name.decode(charset)
354 replace = boolean_of_arg(get_arg(req, "replace", "true"))
356 # We mustn't pass childcap for the readcap argument because we don't
357 # know whether it is a read cap. Passing a read cap as the writecap
358 # argument will work (it ends up calling NodeMaker.create_from_cap,
359 # which derives a readcap if necessary and possible).
360 d = self.node.set_uri(name, childcap, None, overwrite=replace)
361 d.addCallback(lambda res: childcap)
364 def _POST_delete(self, req):
365 name = get_arg(req, "name")
367 # apparently an <input type="hidden" name="name" value="">
368 # won't show up in the resulting encoded form.. the 'name'
369 # field is completely missing. So to allow deletion of an
370 # empty file, we have to pretend that None means ''. The only
371 # downside of this is a slightly confusing error message if
372 # someone does a POST without a name= field. For our own HTML
373 # this isn't a big deal, because we create the 'delete' POST
376 charset = get_arg(req, "_charset", "utf-8")
377 name = name.decode(charset)
378 d = self.node.delete(name)
379 d.addCallback(lambda res: "thing deleted")
382 def _POST_rename(self, req):
383 charset = get_arg(req, "_charset", "utf-8")
384 from_name = get_arg(req, "from_name")
385 if from_name is not None:
386 from_name = from_name.strip()
387 from_name = from_name.decode(charset)
388 assert isinstance(from_name, unicode)
389 to_name = get_arg(req, "to_name")
390 if to_name is not None:
391 to_name = to_name.strip()
392 to_name = to_name.decode(charset)
393 assert isinstance(to_name, unicode)
394 if not from_name or not to_name:
395 raise WebError("rename requires from_name and to_name")
396 if from_name == to_name:
397 return defer.succeed("redundant rename")
399 # allow from_name to contain slashes, so they can fix names that were
400 # accidentally created with them. But disallow them in to_name, to
401 # discourage the practice.
403 raise WebError("to_name= may not contain a slash", http.BAD_REQUEST)
405 replace = boolean_of_arg(get_arg(req, "replace", "true"))
406 d = self.node.move_child_to(from_name, self.node, to_name, replace)
407 d.addCallback(lambda res: "thing renamed")
410 def _maybe_literal(self, res, Results_Class):
412 return Results_Class(self.client, res)
413 return LiteralCheckResults(self.client)
415 def _POST_check(self, req):
416 # check this directory
417 verify = boolean_of_arg(get_arg(req, "verify", "false"))
418 repair = boolean_of_arg(get_arg(req, "repair", "false"))
419 add_lease = boolean_of_arg(get_arg(req, "add-lease", "false"))
421 d = self.node.check_and_repair(Monitor(), verify, add_lease)
422 d.addCallback(self._maybe_literal, CheckAndRepairResults)
424 d = self.node.check(Monitor(), verify, add_lease)
425 d.addCallback(self._maybe_literal, CheckResults)
428 def _start_operation(self, monitor, renderer, ctx):
429 table = IOpHandleTable(ctx)
430 table.add_monitor(ctx, monitor, renderer)
431 return table.redirect_to(ctx)
433 def _POST_start_deep_check(self, ctx):
434 # check this directory and everything reachable from it
435 if not get_arg(ctx, "ophandle"):
436 raise NeedOperationHandleError("slow operation requires ophandle=")
437 verify = boolean_of_arg(get_arg(ctx, "verify", "false"))
438 repair = boolean_of_arg(get_arg(ctx, "repair", "false"))
439 add_lease = boolean_of_arg(get_arg(ctx, "add-lease", "false"))
441 monitor = self.node.start_deep_check_and_repair(verify, add_lease)
442 renderer = DeepCheckAndRepairResults(self.client, monitor)
444 monitor = self.node.start_deep_check(verify, add_lease)
445 renderer = DeepCheckResults(self.client, monitor)
446 return self._start_operation(monitor, renderer, ctx)
448 def _POST_stream_deep_check(self, ctx):
449 verify = boolean_of_arg(get_arg(ctx, "verify", "false"))
450 repair = boolean_of_arg(get_arg(ctx, "repair", "false"))
451 add_lease = boolean_of_arg(get_arg(ctx, "add-lease", "false"))
452 walker = DeepCheckStreamer(ctx, self.node, verify, repair, add_lease)
453 monitor = self.node.deep_traverse(walker)
454 walker.setMonitor(monitor)
455 # register to hear stopProducing. The walker ignores pauseProducing.
456 IRequest(ctx).registerProducer(walker, True)
457 d = monitor.when_done()
459 IRequest(ctx).unregisterProducer()
463 f.trap(OperationCancelledError)
464 return "Operation Cancelled"
465 d.addErrback(_cancelled)
467 # signal the error as a non-JSON "ERROR:" line, plus exception
468 msg = "ERROR: %s(%s)\n" % (f.value.__class__.__name__,
469 ", ".join([str(a) for a in f.value.args]))
475 def _POST_start_manifest(self, ctx):
476 if not get_arg(ctx, "ophandle"):
477 raise NeedOperationHandleError("slow operation requires ophandle=")
478 monitor = self.node.build_manifest()
479 renderer = ManifestResults(self.client, monitor)
480 return self._start_operation(monitor, renderer, ctx)
482 def _POST_start_deep_size(self, ctx):
483 if not get_arg(ctx, "ophandle"):
484 raise NeedOperationHandleError("slow operation requires ophandle=")
485 monitor = self.node.start_deep_stats()
486 renderer = DeepSizeResults(self.client, monitor)
487 return self._start_operation(monitor, renderer, ctx)
489 def _POST_start_deep_stats(self, ctx):
490 if not get_arg(ctx, "ophandle"):
491 raise NeedOperationHandleError("slow operation requires ophandle=")
492 monitor = self.node.start_deep_stats()
493 renderer = DeepStatsResults(self.client, monitor)
494 return self._start_operation(monitor, renderer, ctx)
496 def _POST_stream_manifest(self, ctx):
497 walker = ManifestStreamer(ctx, self.node)
498 monitor = self.node.deep_traverse(walker)
499 walker.setMonitor(monitor)
500 # register to hear stopProducing. The walker ignores pauseProducing.
501 IRequest(ctx).registerProducer(walker, True)
502 d = monitor.when_done()
504 IRequest(ctx).unregisterProducer()
508 f.trap(OperationCancelledError)
509 return "Operation Cancelled"
510 d.addErrback(_cancelled)
512 # signal the error as a non-JSON "ERROR:" line, plus exception
513 msg = "ERROR: %s(%s)\n" % (f.value.__class__.__name__,
514 ", ".join([str(a) for a in f.value.args]))
520 def _POST_set_children(self, req):
521 replace = boolean_of_arg(get_arg(req, "replace", "true"))
523 body = req.content.read()
525 children = simplejson.loads(body)
526 except ValueError, le:
527 le.args = tuple(le.args + (body,))
528 # TODO test handling of bad JSON
531 for name, (file_or_dir, mddict) in children.iteritems():
532 name = unicode(name) # simplejson-2.0.1 returns str *or* unicode
533 writecap = mddict.get('rw_uri')
534 if writecap is not None:
535 writecap = str(writecap)
536 readcap = mddict.get('ro_uri')
537 if readcap is not None:
538 readcap = str(readcap)
539 cs[name] = (writecap, readcap, mddict.get('metadata'))
540 d = self.node.set_children(cs, replace)
541 d.addCallback(lambda res: "Okay so I did it.")
545 def abbreviated_dirnode(dirnode):
546 u = from_string_dirnode(dirnode.get_uri())
549 class DirectoryAsHTML(rend.Page):
550 # The remainder of this class is to render the directory into
551 # human+browser -oriented HTML.
552 docFactory = getxmlfile("directory.xhtml")
555 def __init__(self, node):
556 rend.Page.__init__(self)
559 def beforeRender(self, ctx):
560 # attempt to get the dirnode's children, stashing them (or the
561 # failure that results) for later use
564 # Deferreds don't optimize out tail recursion, and the way
565 # Nevow's flattener handles Deferreds doesn't take this into
566 # account. As a result, large lists of Deferreds that fire in the
567 # same turn (i.e. the output of defer.succeed) will cause a stack
568 # overflow. To work around this, we insert a turn break after
569 # every 100 items, using foolscap's fireEventually(). This gives
570 # the stack a chance to be popped. It would also work to put
571 # every item in its own turn, but that'd be a lot more
572 # inefficient. This addresses ticket #237, for which I was never
573 # able to create a failing unit test.
575 for i,item in enumerate(sorted(children.items())):
577 output.append(fireEventually(item))
580 self.dirnode_children = output
583 text, code = humanize_failure(f)
584 self.dirnode_children = None
585 self.dirnode_children_error = text
587 d.addCallbacks(_good, _bad)
590 def render_title(self, ctx, data):
591 si_s = abbreviated_dirnode(self.node)
592 header = ["Tahoe-LAFS - Directory SI=%s" % si_s]
593 if self.node.is_unknown():
594 header.append(" (unknown)")
595 elif not self.node.is_mutable():
596 header.append(" (immutable)")
597 elif self.node.is_readonly():
598 header.append(" (read-only)")
600 header.append(" (modifiable)")
601 return ctx.tag[header]
603 def render_header(self, ctx, data):
604 si_s = abbreviated_dirnode(self.node)
605 header = ["Tahoe-LAFS Directory SI=", T.span(class_="data-chars")[si_s]]
606 if self.node.is_unknown():
607 header.append(" (unknown)")
608 elif not self.node.is_mutable():
609 header.append(" (immutable)")
610 elif self.node.is_readonly():
611 header.append(" (read-only)")
612 return ctx.tag[header]
614 def render_welcome(self, ctx, data):
616 return ctx.tag[T.a(href=link)["Return to Welcome page"]]
618 def render_show_readonly(self, ctx, data):
619 if self.node.is_unknown() or self.node.is_readonly():
621 rocap = self.node.get_readonly_uri()
623 uri_link = "%s/uri/%s/" % (root, urllib.quote(rocap))
624 return ctx.tag[T.a(href=uri_link)["Read-Only Version"]]
626 def render_try_children(self, ctx, data):
627 # if the dirnode can be retrived, render a table of children.
628 # Otherwise, render an apologetic error message.
629 if self.dirnode_children is not None:
632 return T.div[T.p["Error reading directory:"],
633 T.p[self.dirnode_children_error]]
635 def data_children(self, ctx, data):
636 return self.dirnode_children
638 def render_row(self, ctx, data):
639 name, (target, metadata) = data
640 name = name.encode("utf-8")
641 assert not isinstance(name, unicode)
642 nameurl = urllib.quote(name, safe="") # encode any slashes too
645 here = "%s/uri/%s/" % (root, urllib.quote(self.node.get_uri()))
646 if self.node.is_unknown() or self.node.is_readonly():
650 # this creates a button which will cause our child__delete method
651 # to be invoked, which deletes the file and then redirects the
652 # browser back to this directory
653 delete = T.form(action=here, method="post")[
654 T.input(type='hidden', name='t', value='delete'),
655 T.input(type='hidden', name='name', value=name),
656 T.input(type='hidden', name='when_done', value="."),
657 T.input(type='submit', value='del', name="del"),
660 rename = T.form(action=here, method="get")[
661 T.input(type='hidden', name='t', value='rename-form'),
662 T.input(type='hidden', name='name', value=name),
663 T.input(type='hidden', name='when_done', value="."),
664 T.input(type='submit', value='rename', name="rename"),
667 ctx.fillSlots("delete", delete)
668 ctx.fillSlots("rename", rename)
671 linkcrtime = metadata.get('tahoe', {}).get("linkcrtime")
672 if linkcrtime is not None:
673 times.append("lcr: " + time_format.iso_local(linkcrtime))
675 # For backwards-compatibility with links last modified by Tahoe < 1.4.0:
676 if "ctime" in metadata:
677 ctime = time_format.iso_local(metadata["ctime"])
678 times.append("c: " + ctime)
679 linkmotime = metadata.get('tahoe', {}).get("linkmotime")
680 if linkmotime is not None:
683 times.append("lmo: " + time_format.iso_local(linkmotime))
685 # For backwards-compatibility with links last modified by Tahoe < 1.4.0:
686 if "mtime" in metadata:
687 mtime = time_format.iso_local(metadata["mtime"])
690 times.append("m: " + mtime)
691 ctx.fillSlots("times", times)
693 assert IFilesystemNode.providedBy(target), target
694 target_uri = target.get_uri() or ""
695 quoted_uri = urllib.quote(target_uri, safe="") # escape slashes too
697 if IMutableFileNode.providedBy(target):
698 # to prevent javascript in displayed .html files from stealing a
699 # secret directory URI from the URL, send the browser to a URI-based
700 # page that doesn't know about the directory at all
701 dlurl = "%s/file/%s/@@named=/%s" % (root, quoted_uri, nameurl)
703 ctx.fillSlots("filename",
704 T.a(href=dlurl)[html.escape(name)])
705 ctx.fillSlots("type", "SSK")
707 ctx.fillSlots("size", "?")
709 info_link = "%s/uri/%s?t=info" % (root, quoted_uri)
711 elif IImmutableFileNode.providedBy(target):
712 dlurl = "%s/file/%s/@@named=/%s" % (root, quoted_uri, nameurl)
714 ctx.fillSlots("filename",
715 T.a(href=dlurl)[html.escape(name)])
716 ctx.fillSlots("type", "FILE")
718 ctx.fillSlots("size", target.get_size())
720 info_link = "%s/uri/%s?t=info" % (root, quoted_uri)
722 elif IDirectoryNode.providedBy(target):
724 uri_link = "%s/uri/%s/" % (root, urllib.quote(target_uri))
725 ctx.fillSlots("filename",
726 T.a(href=uri_link)[html.escape(name)])
727 if not target.is_mutable():
729 elif target.is_readonly():
733 ctx.fillSlots("type", dirtype)
734 ctx.fillSlots("size", "-")
735 info_link = "%s/uri/%s/?t=info" % (root, quoted_uri)
739 ctx.fillSlots("filename", html.escape(name))
740 if target.get_write_uri() is not None:
742 elif not self.node.is_mutable() or target.is_alleged_immutable():
743 unknowntype = "?-IMM"
746 ctx.fillSlots("type", unknowntype)
747 ctx.fillSlots("size", "-")
748 # use a directory-relative info link, so we can extract both the
749 # writecap and the readcap
750 info_link = "%s?t=info" % urllib.quote(name)
752 ctx.fillSlots("info", T.a(href=info_link)["More Info"])
756 def render_forms(self, ctx, data):
759 if self.node.is_readonly():
760 return T.div["No upload forms: directory is read-only"]
761 if self.dirnode_children is None:
762 return T.div["No upload forms: directory is unreadable"]
764 mkdir = T.form(action=".", method="post",
765 enctype="multipart/form-data")[
767 T.input(type="hidden", name="t", value="mkdir"),
768 T.input(type="hidden", name="when_done", value="."),
769 T.legend(class_="freeform-form-label")["Create a new directory in this directory"],
770 "New directory name: ",
771 T.input(type="text", name="name"), " ",
772 T.input(type="submit", value="Create"),
774 forms.append(T.div(class_="freeform-form")[mkdir])
776 upload = T.form(action=".", method="post",
777 enctype="multipart/form-data")[
779 T.input(type="hidden", name="t", value="upload"),
780 T.input(type="hidden", name="when_done", value="."),
781 T.legend(class_="freeform-form-label")["Upload a file to this directory"],
782 "Choose a file to upload: ",
783 T.input(type="file", name="file", class_="freeform-input-file"),
785 T.input(type="submit", value="Upload"),
787 T.input(type="checkbox", name="mutable"),
789 forms.append(T.div(class_="freeform-form")[upload])
791 mount = T.form(action=".", method="post",
792 enctype="multipart/form-data")[
794 T.input(type="hidden", name="t", value="uri"),
795 T.input(type="hidden", name="when_done", value="."),
796 T.legend(class_="freeform-form-label")["Add a link to a file or directory which is already in Tahoe-LAFS."],
798 T.input(type="text", name="name"), " ",
799 "URI of new child: ",
800 T.input(type="text", name="uri"), " ",
801 T.input(type="submit", value="Attach"),
803 forms.append(T.div(class_="freeform-form")[mount])
806 def render_results(self, ctx, data):
808 return get_arg(req, "results", "")
811 def DirectoryJSONMetadata(ctx, dirnode):
815 for name, (childnode, metadata) in children.iteritems():
816 assert IFilesystemNode.providedBy(childnode), childnode
817 rw_uri = childnode.get_write_uri()
818 ro_uri = childnode.get_readonly_uri()
819 if IFileNode.providedBy(childnode):
820 kiddata = ("filenode", {'size': childnode.get_size(),
821 'mutable': childnode.is_mutable(),
823 elif IDirectoryNode.providedBy(childnode):
824 kiddata = ("dirnode", {'mutable': childnode.is_mutable()})
826 kiddata = ("unknown", {})
828 kiddata[1]["metadata"] = metadata
830 kiddata[1]["rw_uri"] = rw_uri
832 kiddata[1]["ro_uri"] = ro_uri
833 verifycap = childnode.get_verify_cap()
835 kiddata[1]['verify_uri'] = verifycap.to_string()
839 drw_uri = dirnode.get_write_uri()
840 dro_uri = dirnode.get_readonly_uri()
841 contents = { 'children': kids }
843 contents['ro_uri'] = dro_uri
845 contents['rw_uri'] = drw_uri
846 verifycap = dirnode.get_verify_cap()
848 contents['verify_uri'] = verifycap.to_string()
849 contents['mutable'] = dirnode.is_mutable()
850 data = ("dirnode", contents)
851 json = simplejson.dumps(data, indent=1) + "\n"
854 d.addCallback(text_plain, ctx)
858 def DirectoryURI(ctx, dirnode):
859 return text_plain(dirnode.get_uri(), ctx)
861 def DirectoryReadonlyURI(ctx, dirnode):
862 return text_plain(dirnode.get_readonly_uri(), ctx)
864 class RenameForm(rend.Page):
866 docFactory = getxmlfile("rename-form.xhtml")
868 def render_title(self, ctx, data):
869 return ctx.tag["Directory SI=%s" % abbreviated_dirnode(self.original)]
871 def render_header(self, ctx, data):
873 "in directory SI=%s" % abbreviated_dirnode(self.original),
876 if self.original.is_readonly():
877 header.append(" (readonly!)")
879 return ctx.tag[header]
881 def render_when_done(self, ctx, data):
882 return T.input(type="hidden", name="when_done", value=".")
884 def render_get_name(self, ctx, data):
886 name = get_arg(req, "name", "")
887 ctx.tag.attributes['value'] = name
891 class ManifestResults(rend.Page, ReloadMixin):
892 docFactory = getxmlfile("manifest.xhtml")
894 def __init__(self, client, monitor):
896 self.monitor = monitor
898 def renderHTTP(self, ctx):
899 req = inevow.IRequest(ctx)
900 output = get_arg(req, "output", "html").lower()
902 return self.text(req)
904 return self.json(req)
905 return rend.Page.renderHTTP(self, ctx)
907 def slashify_path(self, path):
910 return "/".join([p.encode("utf-8") for p in path])
913 req.setHeader("content-type", "text/plain")
915 is_finished = self.monitor.is_finished()
916 lines.append("finished: " + {True: "yes", False: "no"}[is_finished])
917 for (path, cap) in self.monitor.get_status()["manifest"]:
918 lines.append(self.slashify_path(path) + " " + cap)
919 return "\n".join(lines) + "\n"
922 req.setHeader("content-type", "text/plain")
927 origin_base32 = base32.b2a(m.origin_si)
930 status = { "stats": s["stats"],
931 "finished": m.is_finished(),
932 "origin": origin_base32,
935 # don't return manifest/verifycaps/SIs unless the operation is
936 # done, to save on CPU/memory (both here and in the HTTP client
937 # who has to unpack the JSON). Tests show that the ManifestWalker
938 # needs about 1092 bytes per item, the JSON we generate here
939 # requires about 503 bytes per item, and some internal overhead
940 # (perhaps transport-layer buffers in twisted.web?) requires an
941 # additional 1047 bytes per item.
942 status.update({ "manifest": s["manifest"],
943 "verifycaps": [i for i in s["verifycaps"]],
944 "storage-index": [i for i in s["storage-index"]],
946 # simplejson doesn't know how to serialize a set. We use a
947 # generator that walks the set rather than list(setofthing) to
948 # save a small amount of memory (4B*len) and a moderate amount of
950 return simplejson.dumps(status, indent=1)
952 def _si_abbrev(self):
953 si = self.monitor.origin_si
956 return base32.b2a(si)[:6]
958 def render_title(self, ctx):
959 return T.title["Manifest of SI=%s" % self._si_abbrev()]
961 def render_header(self, ctx):
962 return T.p["Manifest of SI=%s" % self._si_abbrev()]
964 def data_items(self, ctx, data):
965 return self.monitor.get_status()["manifest"]
967 def render_row(self, ctx, (path, cap)):
968 ctx.fillSlots("path", self.slashify_path(path))
970 # TODO: we need a clean consistent way to get the type of a cap string
972 if cap.startswith("URI:CHK") or cap.startswith("URI:SSK"):
973 nameurl = urllib.quote(path[-1].encode("utf-8"))
974 uri_link = "%s/file/%s/@@named=/%s" % (root, urllib.quote(cap),
977 uri_link = "%s/uri/%s" % (root, urllib.quote(cap, safe=""))
978 ctx.fillSlots("cap", T.a(href=uri_link)[cap])
980 ctx.fillSlots("cap", "")
983 class DeepSizeResults(rend.Page):
984 def __init__(self, client, monitor):
986 self.monitor = monitor
988 def renderHTTP(self, ctx):
989 req = inevow.IRequest(ctx)
990 output = get_arg(req, "output", "html").lower()
991 req.setHeader("content-type", "text/plain")
993 return self.json(req)
995 is_finished = self.monitor.is_finished()
996 output = "finished: " + {True: "yes", False: "no"}[is_finished] + "\n"
998 stats = self.monitor.get_status()
999 total = (stats.get("size-immutable-files", 0)
1000 + stats.get("size-mutable-files", 0)
1001 + stats.get("size-directories", 0))
1002 output += "size: %d\n" % total
1005 def json(self, req):
1006 status = {"finished": self.monitor.is_finished(),
1007 "size": self.monitor.get_status(),
1009 return simplejson.dumps(status)
1011 class DeepStatsResults(rend.Page):
1012 def __init__(self, client, monitor):
1013 self.client = client
1014 self.monitor = monitor
1016 def renderHTTP(self, ctx):
1018 inevow.IRequest(ctx).setHeader("content-type", "text/plain")
1019 s = self.monitor.get_status().copy()
1020 s["finished"] = self.monitor.is_finished()
1021 return simplejson.dumps(s, indent=1)
1023 class ManifestStreamer(dirnode.DeepStats):
1024 implements(IPushProducer)
1026 def __init__(self, ctx, origin):
1027 dirnode.DeepStats.__init__(self, origin)
1028 self.req = IRequest(ctx)
1030 def setMonitor(self, monitor):
1031 self.monitor = monitor
1032 def pauseProducing(self):
1034 def resumeProducing(self):
1036 def stopProducing(self):
1037 self.monitor.cancel()
1039 def add_node(self, node, path):
1040 dirnode.DeepStats.add_node(self, node, path)
1042 "cap": node.get_uri()}
1044 if IDirectoryNode.providedBy(node):
1045 d["type"] = "directory"
1046 elif IFileNode.providedBy(node):
1049 d["type"] = "unknown"
1051 v = node.get_verify_cap()
1054 d["verifycap"] = v or ""
1056 r = node.get_repair_cap()
1059 d["repaircap"] = r or ""
1061 si = node.get_storage_index()
1064 d["storage-index"] = si or ""
1066 j = simplejson.dumps(d, ensure_ascii=True)
1067 assert "\n" not in j
1068 self.req.write(j+"\n")
1071 stats = dirnode.DeepStats.get_results(self)
1072 d = {"type": "stats",
1075 j = simplejson.dumps(d, ensure_ascii=True)
1076 assert "\n" not in j
1077 self.req.write(j+"\n")
1080 class DeepCheckStreamer(dirnode.DeepStats):
1081 implements(IPushProducer)
1083 def __init__(self, ctx, origin, verify, repair, add_lease):
1084 dirnode.DeepStats.__init__(self, origin)
1085 self.req = IRequest(ctx)
1086 self.verify = verify
1087 self.repair = repair
1088 self.add_lease = add_lease
1090 def setMonitor(self, monitor):
1091 self.monitor = monitor
1092 def pauseProducing(self):
1094 def resumeProducing(self):
1096 def stopProducing(self):
1097 self.monitor.cancel()
1099 def add_node(self, node, path):
1100 dirnode.DeepStats.add_node(self, node, path)
1101 data = {"path": path,
1102 "cap": node.get_uri()}
1104 if IDirectoryNode.providedBy(node):
1105 data["type"] = "directory"
1106 elif IFileNode.providedBy(node):
1107 data["type"] = "file"
1109 data["type"] = "unknown"
1111 v = node.get_verify_cap()
1114 data["verifycap"] = v or ""
1116 r = node.get_repair_cap()
1119 data["repaircap"] = r or ""
1121 si = node.get_storage_index()
1124 data["storage-index"] = si or ""
1127 d = node.check_and_repair(self.monitor, self.verify, self.add_lease)
1128 d.addCallback(self.add_check_and_repair, data)
1130 d = node.check(self.monitor, self.verify, self.add_lease)
1131 d.addCallback(self.add_check, data)
1132 d.addCallback(self.write_line)
1135 def add_check_and_repair(self, crr, data):
1136 data["check-and-repair-results"] = json_check_and_repair_results(crr)
1139 def add_check(self, cr, data):
1140 data["check-results"] = json_check_results(cr)
1143 def write_line(self, data):
1144 j = simplejson.dumps(data, ensure_ascii=True)
1145 assert "\n" not in j
1146 self.req.write(j+"\n")
1149 stats = dirnode.DeepStats.get_results(self)
1150 d = {"type": "stats",
1153 j = simplejson.dumps(d, ensure_ascii=True)
1154 assert "\n" not in j
1155 self.req.write(j+"\n")
1159 class UnknownNodeHandler(RenderMixin, rend.Page):
1160 def __init__(self, client, node, parentnode=None, name=None):
1161 rend.Page.__init__(self)
1164 self.parentnode = parentnode
1167 def render_GET(self, ctx):
1169 t = get_arg(req, "t", "").strip()
1171 return MoreInfo(self.node)
1173 is_parent_known_immutable = self.parentnode and not self.parentnode.is_mutable()
1174 if self.parentnode and self.name:
1175 d = self.parentnode.get_metadata_for(self.name)
1177 d = defer.succeed(None)
1178 d.addCallback(lambda md: UnknownJSONMetadata(ctx, self.node, md, is_parent_known_immutable))
1180 raise WebError("GET unknown URI type: can only do t=info and t=json, not t=%s.\n"
1181 "Using a webapi server that supports a later version of Tahoe "
1184 def UnknownJSONMetadata(ctx, node, edge_metadata, is_parent_known_immutable):
1185 rw_uri = node.get_write_uri()
1186 ro_uri = node.get_readonly_uri()
1187 data = ("unknown", {})
1189 data[1]['ro_uri'] = ro_uri
1191 data[1]['rw_uri'] = rw_uri
1192 data[1]['mutable'] = True
1193 elif is_parent_known_immutable or node.is_alleged_immutable():
1194 data[1]['mutable'] = False
1195 # else we don't know whether it is mutable.
1197 if edge_metadata is not None:
1198 data[1]['metadata'] = edge_metadata
1199 return text_plain(simplejson.dumps(data, indent=1) + "\n", ctx)