6 from twisted.internet import defer
7 from twisted.python.failure import Failure
8 from twisted.web import http, html
9 from nevow import url, rend, tags as T
10 from nevow.inevow import IRequest
12 from foolscap.eventual import fireEventually
14 from allmydata.util import log, base32
15 from allmydata.uri import from_string_verifier, from_string_dirnode, \
17 from allmydata.interfaces import IDirectoryNode, IFileNode, IMutableFileNode, \
19 from allmydata.web.common import text_plain, WebError, IClient, \
20 boolean_of_arg, get_arg, should_create_intermediate_directories, \
21 getxmlfile, RenderMixin
22 from allmydata.web.filenode import ReplaceMeMixin, \
23 FileNodeHandler, PlaceHolderNodeHandler
25 class BlockingFileError(Exception):
26 # TODO: catch and transform
27 """We cannot auto-create a parent directory, because there is a file in
30 def make_handler_for(node, parentnode=None, name=None):
32 assert IDirectoryNode.providedBy(parentnode)
33 if IFileNode.providedBy(node):
34 return FileNodeHandler(node, parentnode, name)
35 if IMutableFileNode.providedBy(node):
36 return FileNodeHandler(node, parentnode, name)
37 if IDirectoryNode.providedBy(node):
38 return DirectoryNodeHandler(node, parentnode, name)
39 raise WebError("Cannot provide handler for '%s'" % node)
41 class DirectoryNodeHandler(RenderMixin, rend.Page, ReplaceMeMixin):
44 def __init__(self, node, parentnode=None, name=None):
45 rend.Page.__init__(self)
48 self.parentnode = parentnode
51 def childFactory(self, ctx, name):
53 name = name.decode("utf-8")
54 d = self.node.get(name)
55 d.addBoth(self.got_child, ctx, name)
56 # got_child returns a handler resource: FileNodeHandler or
57 # DirectoryNodeHandler
60 def got_child(self, node_or_failure, ctx, name):
62 if DEBUG: print "GOT_CHILD", name, node_or_failure
65 nonterminal = len(req.postpath) > 1
66 t = get_arg(req, "t", "").strip()
67 if isinstance(node_or_failure, Failure):
70 # No child by this name. What should we do about it?
71 if DEBUG: print "no child", name
72 if DEBUG: print "postpath", req.postpath
74 if DEBUG: print " intermediate"
75 if should_create_intermediate_directories(req):
76 # create intermediate directories
77 if DEBUG: print " making intermediate directory"
78 d = self.node.create_empty_directory(name)
79 d.addCallback(make_handler_for, self.node, name)
82 if DEBUG: print " terminal"
84 if (method,t) in [ ("POST","mkdir"), ("PUT","mkdir") ]:
85 if DEBUG: print " making final directory"
87 d = self.node.create_empty_directory(name)
88 d.addCallback(make_handler_for, self.node, name)
90 if (method,t) in ( ("PUT",""), ("PUT","uri"), ):
91 if DEBUG: print " PUT, making leaf placeholder"
92 # we were trying to find the leaf filenode (to put a new
93 # file in its place), and it didn't exist. That's ok,
94 # since that's the leaf node that we're about to create.
95 # We make a dummy one, which will respond to the PUT
96 # request by replacing itself.
97 return PlaceHolderNodeHandler(self.node, name)
98 if DEBUG: print " 404"
99 # otherwise, we just return a no-such-child error
100 return rend.FourOhFour()
102 node = node_or_failure
103 if nonterminal and should_create_intermediate_directories(req):
104 if not IDirectoryNode.providedBy(node):
105 # we would have put a new directory here, but there was a
107 if DEBUG: print "blocking"
108 raise WebError("Unable to create directory '%s': "
109 "a file was in the way" % name,
111 if DEBUG: print "good child"
112 return make_handler_for(node, self.node, name)
114 def render_DELETE(self, ctx):
115 assert self.parentnode and self.name
116 d = self.parentnode.delete(self.name)
117 d.addCallback(lambda res: self.node.get_uri())
120 def render_GET(self, ctx):
121 client = IClient(ctx)
123 # This is where all of the directory-related ?t=* code goes.
124 t = get_arg(req, "t", "").strip()
126 # render the directory as HTML, using the docFactory and Nevow's
127 # whole templating thing.
128 return DirectoryAsHTML(self.node)
131 return DirectoryJSONMetadata(ctx, self.node)
133 return DirectoryURI(ctx, self.node)
134 if t == "readonly-uri":
135 return DirectoryReadonlyURI(ctx, self.node)
137 return Manifest(self.node)
139 return DeepSize(ctx, self.node)
140 if t == "deep-stats":
141 return DeepStats(ctx, self.node)
142 if t == 'rename-form':
143 return RenameForm(self.node)
145 raise WebError("GET directory: bad t=%s" % t)
147 def render_PUT(self, ctx):
149 t = get_arg(req, "t", "").strip()
150 replace = boolean_of_arg(get_arg(req, "replace", "true"))
152 # our job was done by the traversal/create-intermediate-directory
153 # process that got us here.
154 return text_plain(self.node.get_uri(), ctx) # TODO: urlencode
157 # they're trying to set_uri and that name is already occupied
159 raise ExistingChildError()
160 d = self.parentnode.replace_me_with_a_childcap(ctx, replace)
164 raise WebError("PUT to a directory")
166 def render_POST(self, ctx):
168 t = get_arg(req, "t", "").strip()
170 d = self._POST_mkdir(req)
173 d = self._POST_mkdir_p(req)
175 d = self._POST_upload(ctx) # this one needs the context
177 d = self._POST_uri(req)
179 d = self._POST_delete(req)
181 d = self._POST_rename(req)
183 d = self._POST_check(req)
184 elif t == "set_children":
186 d = self._POST_set_children(req)
188 raise WebError("POST to a directory with bad t=%s" % t)
190 when_done = get_arg(req, "when_done", None)
192 d.addCallback(lambda res: url.URL.fromString(when_done))
195 def _POST_mkdir(self, req):
196 name = get_arg(req, "name", "")
198 # our job is done, it was handled by the code in got_child
199 # which created the final directory (i.e. us)
200 return defer.succeed(self.node.get_uri()) # TODO: urlencode
201 name = name.decode("utf-8")
202 replace = boolean_of_arg(get_arg(req, "replace", "true"))
203 d = self.node.create_empty_directory(name, overwrite=replace)
204 d.addCallback(lambda child: child.get_uri()) # TODO: urlencode
207 def _POST_mkdir_p(self, req):
208 path = get_arg(req, "path")
210 raise WebError("mkdir-p requires a path")
211 path_ = tuple([seg.decode("utf-8") for seg in path.split('/') if seg ])
213 d = self._get_or_create_directories(self.node, path_)
214 d.addCallback(lambda node: node.get_uri())
217 def _get_or_create_directories(self, node, path):
218 if not IDirectoryNode.providedBy(node):
219 # unfortunately it is too late to provide the name of the
220 # blocking directory in the error message.
221 raise BlockingFileError("cannot create directory because there "
222 "is a file in the way")
224 return defer.succeed(node)
225 d = node.get(path[0])
226 def _maybe_create(f):
228 return node.create_empty_directory(path[0])
229 d.addErrback(_maybe_create)
230 d.addCallback(self._get_or_create_directories, path[1:])
233 def _POST_upload(self, ctx):
235 charset = get_arg(req, "_charset", "utf-8")
236 contents = req.fields["file"]
237 name = get_arg(req, "name")
238 name = name or contents.filename
242 # this prohibts empty, missing, and all-whitespace filenames
243 raise WebError("upload requires a name")
244 name = name.decode(charset)
246 raise WebError("name= may not contain a slash", http.BAD_REQUEST)
247 assert isinstance(name, unicode)
249 # since POST /uri/path/file?t=upload is equivalent to
250 # POST /uri/path/dir?t=upload&name=foo, just do the same thing that
251 # childFactory would do. Things are cleaner if we only do a subset of
252 # them, though, so we don't do: d = self.childFactory(ctx, name)
254 d = self.node.get(name)
255 def _maybe_got_node(node_or_failure):
256 if isinstance(node_or_failure, Failure):
259 # create a placeholder
260 return PlaceHolderNodeHandler(self.node, name)
262 node = node_or_failure
263 return make_handler_for(node, self.node, name)
264 d.addBoth(_maybe_got_node)
265 # now we have a placeholder or a filenodehandler, and we can just
266 # delegate to it. We could return the resource back out of
267 # DirectoryNodeHandler.renderHTTP, and nevow would recurse into it,
268 # but the addCallback() that handles when_done= would break.
269 d.addCallback(lambda child: child.renderHTTP(ctx))
272 def _POST_uri(self, req):
273 childcap = get_arg(req, "uri")
275 raise WebError("set-uri requires a uri")
276 name = get_arg(req, "name")
278 raise WebError("set-uri requires a name")
279 charset = get_arg(req, "_charset", "utf-8")
280 name = name.decode(charset)
281 replace = boolean_of_arg(get_arg(req, "replace", "true"))
282 d = self.node.set_uri(name, childcap, overwrite=replace)
283 d.addCallback(lambda res: childcap)
286 def _POST_delete(self, req):
287 name = get_arg(req, "name")
289 # apparently an <input type="hidden" name="name" value="">
290 # won't show up in the resulting encoded form.. the 'name'
291 # field is completely missing. So to allow deletion of an
292 # empty file, we have to pretend that None means ''. The only
293 # downide of this is a slightly confusing error message if
294 # someone does a POST without a name= field. For our own HTML
295 # thisn't a big deal, because we create the 'delete' POST
298 charset = get_arg(req, "_charset", "utf-8")
299 name = name.decode(charset)
300 d = self.node.delete(name)
301 d.addCallback(lambda res: "thing deleted")
304 def _POST_rename(self, req):
305 charset = get_arg(req, "_charset", "utf-8")
306 from_name = get_arg(req, "from_name")
307 if from_name is not None:
308 from_name = from_name.strip()
309 from_name = from_name.decode(charset)
310 assert isinstance(from_name, unicode)
311 to_name = get_arg(req, "to_name")
312 if to_name is not None:
313 to_name = to_name.strip()
314 to_name = to_name.decode(charset)
315 assert isinstance(to_name, unicode)
316 if not from_name or not to_name:
317 raise WebError("rename requires from_name and to_name")
318 for k,v in [ ('from_name', from_name), ('to_name', to_name) ]:
320 raise WebError("%s= may not contain a slash" % k,
323 replace = boolean_of_arg(get_arg(req, "replace", "true"))
324 d = self.node.move_child_to(from_name, self.node, to_name, replace)
325 d.addCallback(lambda res: "thing renamed")
328 def _POST_check(self, req):
329 # check this directory
330 d = self.node.check()
332 log.msg("checked %s, results %s" % (self.node, res),
333 facility="tahoe.webish", level=log.NOISY)
339 def _POST_set_children(self, req):
340 replace = boolean_of_arg(get_arg(req, "replace", "true"))
342 body = req.content.read()
344 children = simplejson.loads(body)
345 except ValueError, le:
346 le.args = tuple(le.args + (body,))
347 # TODO test handling of bad JSON
350 for name, (file_or_dir, mddict) in children.iteritems():
351 cap = str(mddict.get('rw_uri') or mddict.get('ro_uri'))
352 cs.append((name, cap, mddict.get('metadata')))
353 d = self.node.set_children(cs, replace)
354 d.addCallback(lambda res: "Okay so I did it.")
358 def abbreviated_dirnode(dirnode):
359 u = from_string_dirnode(dirnode.get_uri())
360 si = u.get_filenode_uri().storage_index
361 si_s = base32.b2a(si)
364 class DirectoryAsHTML(rend.Page):
365 # The remainder of this class is to render the directory into
366 # human+browser -oriented HTML.
367 docFactory = getxmlfile("directory.xhtml")
369 def __init__(self, node):
370 rend.Page.__init__(self)
373 def render_title(self, ctx, data):
374 si_s = abbreviated_dirnode(self.node)
375 header = ["Directory SI=%s" % si_s]
376 return ctx.tag[header]
378 def render_header(self, ctx, data):
379 si_s = abbreviated_dirnode(self.node)
380 header = ["Directory SI=%s" % si_s]
381 if self.node.is_readonly():
382 header.append(" (readonly)")
383 return ctx.tag[header]
385 def render_welcome(self, ctx, data):
386 depth = len(IRequest(ctx).path) + 2
387 link = "/".join([".."] * depth)
388 return T.div[T.a(href=link)["Return to Welcome page"]]
390 def data_children(self, ctx, data):
392 d.addCallback(lambda dict: sorted(dict.items()))
393 def _stall_some(items):
394 # Deferreds don't optimize out tail recursion, and the way
395 # Nevow's flattener handles Deferreds doesn't take this into
396 # account. As a result, large lists of Deferreds that fire in the
397 # same turn (i.e. the output of defer.succeed) will cause a stack
398 # overflow. To work around this, we insert a turn break after
399 # every 100 items, using foolscap's fireEventually(). This gives
400 # the stack a chance to be popped. It would also work to put
401 # every item in its own turn, but that'd be a lot more
402 # inefficient. This addresses ticket #237, for which I was never
403 # able to create a failing unit test.
405 for i,item in enumerate(items):
407 output.append(fireEventually(item))
411 d.addCallback(_stall_some)
414 def render_row(self, ctx, data):
415 name, (target, metadata) = data
416 name = name.encode("utf-8")
417 assert not isinstance(name, unicode)
419 if self.node.is_readonly():
423 # this creates a button which will cause our child__delete method
424 # to be invoked, which deletes the file and then redirects the
425 # browser back to this directory
426 delete = T.form(action=url.here, method="post")[
427 T.input(type='hidden', name='t', value='delete'),
428 T.input(type='hidden', name='name', value=name),
429 T.input(type='hidden', name='when_done', value=url.here),
430 T.input(type='submit', value='del', name="del"),
433 rename = T.form(action=url.here, method="get")[
434 T.input(type='hidden', name='t', value='rename-form'),
435 T.input(type='hidden', name='name', value=name),
436 T.input(type='hidden', name='when_done', value=url.here),
437 T.input(type='submit', value='rename', name="rename"),
440 ctx.fillSlots("delete", delete)
441 ctx.fillSlots("rename", rename)
442 check = T.form(action=url.here.child(name), method="post")[
443 T.input(type='hidden', name='t', value='check'),
444 T.input(type='hidden', name='when_done', value=url.here),
445 T.input(type='submit', value='check', name="check"),
447 ctx.fillSlots("overwrite",
448 self.build_overwrite_form(ctx, name, target))
449 ctx.fillSlots("check", check)
452 TIME_FORMAT = "%H:%M:%S %d-%b-%Y"
453 if "ctime" in metadata:
454 ctime = time.strftime(TIME_FORMAT,
455 time.localtime(metadata["ctime"]))
456 times.append("c: " + ctime)
457 if "mtime" in metadata:
458 mtime = time.strftime(TIME_FORMAT,
459 time.localtime(metadata["mtime"]))
462 times.append("m: " + mtime)
463 ctx.fillSlots("times", times)
465 assert (IFileNode.providedBy(target)
466 or IDirectoryNode.providedBy(target)
467 or IMutableFileNode.providedBy(target)), target
469 quoted_uri = urllib.quote(target.get_uri())
471 if IMutableFileNode.providedBy(target):
472 # to prevent javascript in displayed .html files from stealing a
473 # secret directory URI from the URL, send the browser to a URI-based
474 # page that doesn't know about the directory at all
475 dlurl = "/file/%s/@@named=/%s" % (quoted_uri, urllib.quote(name))
477 ctx.fillSlots("filename",
478 T.a(href=dlurl)[html.escape(name)])
479 ctx.fillSlots("type", "SSK")
481 ctx.fillSlots("size", "?")
483 text_plain_url = "/file/%s/@@named=/foo.txt" % quoted_uri
484 text_plain_tag = T.a(href=text_plain_url)["text/plain"]
486 elif IFileNode.providedBy(target):
487 dlurl = "/file/%s/@@named=/%s" % (quoted_uri, urllib.quote(name))
489 ctx.fillSlots("filename",
490 T.a(href=dlurl)[html.escape(name)])
491 ctx.fillSlots("type", "FILE")
493 ctx.fillSlots("size", target.get_size())
495 text_plain_url = "/file/%s/@@named=/foo.txt" % quoted_uri
496 text_plain_tag = T.a(href=text_plain_url)["text/plain"]
499 elif IDirectoryNode.providedBy(target):
501 uri_link = "/uri/" + urllib.quote(target.get_uri())
502 ctx.fillSlots("filename",
503 T.a(href=uri_link)[html.escape(name)])
504 if target.is_readonly():
508 ctx.fillSlots("type", dirtype)
509 ctx.fillSlots("size", "-")
510 text_plain_tag = None
512 childdata = [T.a(href="%s?t=json" % name)["JSON"], ", ",
513 T.a(href="%s?t=uri" % name)["URI"], ", ",
514 T.a(href="%s?t=readonly-uri" % name)["readonly-URI"],
517 childdata.extend([", ", text_plain_tag])
519 ctx.fillSlots("data", childdata)
522 checker = IClient(ctx).getServiceNamed("checker")
526 d = defer.maybeDeferred(checker.checker_results_for,
527 target.get_verifier())
528 def _got(checker_results):
529 recent_results = reversed(checker_results[-5:])
530 if IFileNode.providedBy(target):
532 ", ".join(["%d/%d" % (found, needed)
534 (needed, total, found, sharemap))
535 in recent_results]) +
537 elif IDirectoryNode.providedBy(target):
539 "".join([{True:"+",False:"-"}[res]
540 for (when, res) in recent_results]) +
543 results = "%d results" % len(checker_results)
549 # TODO: include a link to see more results, including timestamps
550 # TODO: use a sparkline
551 ctx.fillSlots("checker_results", results)
555 def render_forms(self, ctx, data):
556 if self.node.is_readonly():
557 return T.div["No upload forms: directory is read-only"]
558 mkdir = T.form(action=".", method="post",
559 enctype="multipart/form-data")[
561 T.input(type="hidden", name="t", value="mkdir"),
562 T.input(type="hidden", name="when_done", value=url.here),
563 T.legend(class_="freeform-form-label")["Create a new directory"],
564 "New directory name: ",
565 T.input(type="text", name="name"), " ",
566 T.input(type="submit", value="Create"),
569 upload = T.form(action=".", method="post",
570 enctype="multipart/form-data")[
572 T.input(type="hidden", name="t", value="upload"),
573 T.input(type="hidden", name="when_done", value=url.here),
574 T.legend(class_="freeform-form-label")["Upload a file to this directory"],
575 "Choose a file to upload: ",
576 T.input(type="file", name="file", class_="freeform-input-file"),
578 T.input(type="submit", value="Upload"),
580 T.input(type="checkbox", name="mutable"),
583 mount = T.form(action=".", method="post",
584 enctype="multipart/form-data")[
586 T.input(type="hidden", name="t", value="uri"),
587 T.input(type="hidden", name="when_done", value=url.here),
588 T.legend(class_="freeform-form-label")["Attach a file or directory"
592 T.input(type="text", name="name"), " ",
593 "URI of new child: ",
594 T.input(type="text", name="uri"), " ",
595 T.input(type="submit", value="Attach"),
597 return [T.div(class_="freeform-form")[mkdir],
598 T.div(class_="freeform-form")[upload],
599 T.div(class_="freeform-form")[mount],
602 def build_overwrite_form(self, ctx, name, target):
603 if IMutableFileNode.providedBy(target) and not target.is_readonly():
604 action = "/uri/" + urllib.quote(target.get_uri())
605 overwrite = T.form(action=action, method="post",
606 enctype="multipart/form-data")[
608 T.input(type="hidden", name="t", value="upload"),
609 T.input(type='hidden', name='when_done', value=url.here),
610 T.legend(class_="freeform-form-label")["Overwrite"],
612 T.input(type="file", name="file", class_="freeform-input-file"),
614 T.input(type="submit", value="Overwrite")
616 return [T.div(class_="freeform-form")[overwrite],]
620 def render_results(self, ctx, data):
622 return get_arg(req, "results", "")
625 def DirectoryJSONMetadata(ctx, dirnode):
629 for name, (childnode, metadata) in children.iteritems():
630 if childnode.is_readonly():
632 ro_uri = childnode.get_uri()
634 rw_uri = childnode.get_uri()
635 ro_uri = childnode.get_readonly_uri()
636 if IFileNode.providedBy(childnode):
637 kiddata = ("filenode", {'size': childnode.get_size(),
638 'metadata': metadata,
641 assert IDirectoryNode.providedBy(childnode), (childnode,
643 kiddata = ("dirnode", {'metadata': metadata})
645 kiddata[1]["ro_uri"] = ro_uri
647 kiddata[1]["rw_uri"] = rw_uri
649 if dirnode.is_readonly():
651 dro_uri = dirnode.get_uri()
653 drw_uri = dirnode.get_uri()
654 dro_uri = dirnode.get_readonly_uri()
655 contents = { 'children': kids }
657 contents['ro_uri'] = dro_uri
659 contents['rw_uri'] = drw_uri
660 data = ("dirnode", contents)
661 return simplejson.dumps(data, indent=1)
663 d.addCallback(text_plain, ctx)
666 def DirectoryURI(ctx, dirnode):
667 return text_plain(dirnode.get_uri(), ctx)
669 def DirectoryReadonlyURI(ctx, dirnode):
670 return text_plain(dirnode.get_readonly_uri(), ctx)
672 class RenameForm(rend.Page):
674 docFactory = getxmlfile("rename-form.xhtml")
676 def render_title(self, ctx, data):
677 return ctx.tag["Directory SI=%s" % abbreviated_dirnode(self.original)]
679 def render_header(self, ctx, data):
681 "in directory SI=%s" % abbreviated_dirnode(self.original),
684 if self.original.is_readonly():
685 header.append(" (readonly!)")
687 return ctx.tag[header]
689 def render_when_done(self, ctx, data):
690 return T.input(type="hidden", name="when_done", value=url.here)
692 def render_get_name(self, ctx, data):
694 name = get_arg(req, "name", "")
695 ctx.tag.attributes['value'] = name
699 class Manifest(rend.Page):
700 docFactory = getxmlfile("manifest.xhtml")
702 def render_title(self, ctx):
703 return T.title["Manifest of SI=%s" % abbreviated_dirnode(self.original)]
705 def render_header(self, ctx):
706 return T.p["Manifest of SI=%s" % abbreviated_dirnode(self.original)]
708 def data_items(self, ctx, data):
709 return self.original.build_manifest()
711 def render_row(self, ctx, refresh_cap):
712 ctx.fillSlots("refresh_capability", refresh_cap)
715 def DeepSize(ctx, dirnode):
716 d = dirnode.build_manifest()
717 def _measure_size(manifest):
719 for verifiercap in manifest:
720 u = from_string_verifier(verifiercap)
721 if isinstance(u, CHKFileVerifierURI):
724 d.addCallback(_measure_size)
725 d.addCallback(text_plain, ctx)
728 def DeepStats(ctx, dirnode):
729 d = dirnode.deep_stats()
730 d.addCallback(simplejson.dumps, indent=1)
731 d.addCallback(text_plain, ctx)