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 assert contents.filename is None or isinstance(contents.filename, str)
238 name = get_arg(req, "name")
239 name = name or contents.filename
243 # this prohibts empty, missing, and all-whitespace filenames
244 raise WebError("upload requires a name")
245 assert isinstance(name, str)
246 name = name.decode(charset)
248 raise WebError("name= may not contain a slash", http.BAD_REQUEST)
249 assert isinstance(name, unicode)
251 # since POST /uri/path/file?t=upload is equivalent to
252 # POST /uri/path/dir?t=upload&name=foo, just do the same thing that
253 # childFactory would do. Things are cleaner if we only do a subset of
254 # them, though, so we don't do: d = self.childFactory(ctx, name)
256 d = self.node.get(name)
257 def _maybe_got_node(node_or_failure):
258 if isinstance(node_or_failure, Failure):
261 # create a placeholder which will see POST t=upload
262 return PlaceHolderNodeHandler(self.node, name)
264 node = node_or_failure
265 return make_handler_for(node, self.node, name)
266 d.addBoth(_maybe_got_node)
267 # now we have a placeholder or a filenodehandler, and we can just
268 # delegate to it. We could return the resource back out of
269 # DirectoryNodeHandler.renderHTTP, and nevow would recurse into it,
270 # but the addCallback() that handles when_done= would break.
271 d.addCallback(lambda child: child.renderHTTP(ctx))
274 def _POST_uri(self, req):
275 childcap = get_arg(req, "uri")
277 raise WebError("set-uri requires a uri")
278 name = get_arg(req, "name")
280 raise WebError("set-uri requires a name")
281 charset = get_arg(req, "_charset", "utf-8")
282 name = name.decode(charset)
283 replace = boolean_of_arg(get_arg(req, "replace", "true"))
284 d = self.node.set_uri(name, childcap, overwrite=replace)
285 d.addCallback(lambda res: childcap)
288 def _POST_delete(self, req):
289 name = get_arg(req, "name")
291 # apparently an <input type="hidden" name="name" value="">
292 # won't show up in the resulting encoded form.. the 'name'
293 # field is completely missing. So to allow deletion of an
294 # empty file, we have to pretend that None means ''. The only
295 # downide of this is a slightly confusing error message if
296 # someone does a POST without a name= field. For our own HTML
297 # thisn't a big deal, because we create the 'delete' POST
300 charset = get_arg(req, "_charset", "utf-8")
301 name = name.decode(charset)
302 d = self.node.delete(name)
303 d.addCallback(lambda res: "thing deleted")
306 def _POST_rename(self, req):
307 charset = get_arg(req, "_charset", "utf-8")
308 from_name = get_arg(req, "from_name")
309 if from_name is not None:
310 from_name = from_name.strip()
311 from_name = from_name.decode(charset)
312 assert isinstance(from_name, unicode)
313 to_name = get_arg(req, "to_name")
314 if to_name is not None:
315 to_name = to_name.strip()
316 to_name = to_name.decode(charset)
317 assert isinstance(to_name, unicode)
318 if not from_name or not to_name:
319 raise WebError("rename requires from_name and to_name")
320 for k,v in [ ('from_name', from_name), ('to_name', to_name) ]:
322 raise WebError("%s= may not contain a slash" % k,
325 replace = boolean_of_arg(get_arg(req, "replace", "true"))
326 d = self.node.move_child_to(from_name, self.node, to_name, replace)
327 d.addCallback(lambda res: "thing renamed")
330 def _POST_check(self, req):
331 # check this directory
332 d = self.node.check()
334 log.msg("checked %s, results %s" % (self.node, res),
335 facility="tahoe.webish", level=log.NOISY)
341 def _POST_set_children(self, req):
342 replace = boolean_of_arg(get_arg(req, "replace", "true"))
344 body = req.content.read()
346 children = simplejson.loads(body)
347 except ValueError, le:
348 le.args = tuple(le.args + (body,))
349 # TODO test handling of bad JSON
352 for name, (file_or_dir, mddict) in children.iteritems():
353 cap = str(mddict.get('rw_uri') or mddict.get('ro_uri'))
354 cs.append((name, cap, mddict.get('metadata')))
355 d = self.node.set_children(cs, replace)
356 d.addCallback(lambda res: "Okay so I did it.")
360 def abbreviated_dirnode(dirnode):
361 u = from_string_dirnode(dirnode.get_uri())
362 si = u.get_filenode_uri().storage_index
363 si_s = base32.b2a(si)
366 class DirectoryAsHTML(rend.Page):
367 # The remainder of this class is to render the directory into
368 # human+browser -oriented HTML.
369 docFactory = getxmlfile("directory.xhtml")
372 def __init__(self, node):
373 rend.Page.__init__(self)
376 def render_title(self, ctx, data):
377 si_s = abbreviated_dirnode(self.node)
378 header = ["Directory SI=%s" % si_s]
379 return ctx.tag[header]
381 def render_header(self, ctx, data):
382 si_s = abbreviated_dirnode(self.node)
383 header = ["Directory SI=%s" % si_s]
384 if self.node.is_readonly():
385 header.append(" (readonly)")
386 return ctx.tag[header]
388 def get_root(self, ctx):
390 # the addSlash=True gives us one extra (empty) segment
391 depth = len(req.prepath) + len(req.postpath) - 1
392 link = "/".join([".."] * depth)
395 def render_welcome(self, ctx, data):
396 link = self.get_root(ctx)
397 return T.div[T.a(href=link)["Return to Welcome page"]]
399 def data_children(self, ctx, data):
401 d.addCallback(lambda dict: sorted(dict.items()))
402 def _stall_some(items):
403 # Deferreds don't optimize out tail recursion, and the way
404 # Nevow's flattener handles Deferreds doesn't take this into
405 # account. As a result, large lists of Deferreds that fire in the
406 # same turn (i.e. the output of defer.succeed) will cause a stack
407 # overflow. To work around this, we insert a turn break after
408 # every 100 items, using foolscap's fireEventually(). This gives
409 # the stack a chance to be popped. It would also work to put
410 # every item in its own turn, but that'd be a lot more
411 # inefficient. This addresses ticket #237, for which I was never
412 # able to create a failing unit test.
414 for i,item in enumerate(items):
416 output.append(fireEventually(item))
420 d.addCallback(_stall_some)
423 def render_row(self, ctx, data):
424 name, (target, metadata) = data
425 name = name.encode("utf-8")
426 assert not isinstance(name, unicode)
428 root = self.get_root(ctx)
429 here = "%s/uri/%s/" % (root, urllib.quote(self.node.get_uri()))
430 if self.node.is_readonly():
434 # this creates a button which will cause our child__delete method
435 # to be invoked, which deletes the file and then redirects the
436 # browser back to this directory
437 delete = T.form(action=here, method="post")[
438 T.input(type='hidden', name='t', value='delete'),
439 T.input(type='hidden', name='name', value=name),
440 T.input(type='hidden', name='when_done', value="."),
441 T.input(type='submit', value='del', name="del"),
444 rename = T.form(action=here, method="get")[
445 T.input(type='hidden', name='t', value='rename-form'),
446 T.input(type='hidden', name='name', value=name),
447 T.input(type='hidden', name='when_done', value="."),
448 T.input(type='submit', value='rename', name="rename"),
451 ctx.fillSlots("delete", delete)
452 ctx.fillSlots("rename", rename)
453 if IDirectoryNode.providedBy(target):
454 check_url = "%s/uri/%s/" % (root, urllib.quote(target.get_uri()))
455 check_done_url = "../../uri/%s/" % urllib.quote(self.node.get_uri())
457 check_url = "%s/uri/%s" % (root, urllib.quote(target.get_uri()))
458 check_done_url = "../uri/%s/" % urllib.quote(self.node.get_uri())
459 check = T.form(action=check_url, method="post")[
460 T.input(type='hidden', name='t', value='check'),
461 T.input(type='hidden', name='when_done', value=check_done_url),
462 T.input(type='submit', value='check', name="check"),
464 ctx.fillSlots("overwrite",
465 self.build_overwrite_form(ctx, name, target))
466 ctx.fillSlots("check", check)
469 TIME_FORMAT = "%H:%M:%S %d-%b-%Y"
470 if "ctime" in metadata:
471 ctime = time.strftime(TIME_FORMAT,
472 time.localtime(metadata["ctime"]))
473 times.append("c: " + ctime)
474 if "mtime" in metadata:
475 mtime = time.strftime(TIME_FORMAT,
476 time.localtime(metadata["mtime"]))
479 times.append("m: " + mtime)
480 ctx.fillSlots("times", times)
482 assert (IFileNode.providedBy(target)
483 or IDirectoryNode.providedBy(target)
484 or IMutableFileNode.providedBy(target)), target
486 quoted_uri = urllib.quote(target.get_uri())
488 if IMutableFileNode.providedBy(target):
489 # to prevent javascript in displayed .html files from stealing a
490 # secret directory URI from the URL, send the browser to a URI-based
491 # page that doesn't know about the directory at all
492 dlurl = "%s/file/%s/@@named=/%s" % (root, quoted_uri, urllib.quote(name))
494 ctx.fillSlots("filename",
495 T.a(href=dlurl)[html.escape(name)])
496 ctx.fillSlots("type", "SSK")
498 ctx.fillSlots("size", "?")
500 text_plain_url = "%s/file/%s/@@named=/foo.txt" % (root, quoted_uri)
501 text_plain_tag = T.a(href=text_plain_url)["text/plain"]
503 elif IFileNode.providedBy(target):
504 dlurl = "%s/file/%s/@@named=/%s" % (root, quoted_uri, urllib.quote(name))
506 ctx.fillSlots("filename",
507 T.a(href=dlurl)[html.escape(name)])
508 ctx.fillSlots("type", "FILE")
510 ctx.fillSlots("size", target.get_size())
512 text_plain_url = "%s/file/%s/@@named=/foo.txt" % (root, quoted_uri)
513 text_plain_tag = T.a(href=text_plain_url)["text/plain"]
516 elif IDirectoryNode.providedBy(target):
518 uri_link = "%s/uri/%s/" % (root, urllib.quote(target.get_uri()))
519 ctx.fillSlots("filename",
520 T.a(href=uri_link)[html.escape(name)])
521 if target.is_readonly():
525 ctx.fillSlots("type", dirtype)
526 ctx.fillSlots("size", "-")
527 text_plain_tag = None
529 childdata = [T.a(href="%s?t=json" % name)["JSON"], ", ",
530 T.a(href="%s?t=uri" % name)["URI"], ", ",
531 T.a(href="%s?t=readonly-uri" % name)["readonly-URI"],
534 childdata.extend([", ", text_plain_tag])
536 ctx.fillSlots("data", childdata)
539 # TODO: include a link to see more results, including timestamps
540 # TODO: use a sparkline
541 ctx.fillSlots("checker_results", results)
545 def render_forms(self, ctx, data):
546 if self.node.is_readonly():
547 return T.div["No upload forms: directory is read-only"]
548 mkdir = T.form(action=".", method="post",
549 enctype="multipart/form-data")[
551 T.input(type="hidden", name="t", value="mkdir"),
552 T.input(type="hidden", name="when_done", value="."),
553 T.legend(class_="freeform-form-label")["Create a new directory"],
554 "New directory name: ",
555 T.input(type="text", name="name"), " ",
556 T.input(type="submit", value="Create"),
559 upload = T.form(action=".", method="post",
560 enctype="multipart/form-data")[
562 T.input(type="hidden", name="t", value="upload"),
563 T.input(type="hidden", name="when_done", value="."),
564 T.legend(class_="freeform-form-label")["Upload a file to this directory"],
565 "Choose a file to upload: ",
566 T.input(type="file", name="file", class_="freeform-input-file"),
568 T.input(type="submit", value="Upload"),
570 T.input(type="checkbox", name="mutable"),
573 mount = T.form(action=".", method="post",
574 enctype="multipart/form-data")[
576 T.input(type="hidden", name="t", value="uri"),
577 T.input(type="hidden", name="when_done", value="."),
578 T.legend(class_="freeform-form-label")["Attach a file or directory"
582 T.input(type="text", name="name"), " ",
583 "URI of new child: ",
584 T.input(type="text", name="uri"), " ",
585 T.input(type="submit", value="Attach"),
587 return [T.div(class_="freeform-form")[mkdir],
588 T.div(class_="freeform-form")[upload],
589 T.div(class_="freeform-form")[mount],
592 def build_overwrite_form(self, ctx, name, target):
593 if IMutableFileNode.providedBy(target) and not target.is_readonly():
594 root = self.get_root(ctx)
595 action = "%s/uri/%s" % (root, urllib.quote(target.get_uri()))
596 done_url = "../uri/%s/" % urllib.quote(self.node.get_uri())
597 overwrite = T.form(action=action, method="post",
598 enctype="multipart/form-data")[
600 T.input(type="hidden", name="t", value="upload"),
601 T.input(type='hidden', name='when_done', value=done_url),
602 T.legend(class_="freeform-form-label")["Overwrite"],
604 T.input(type="file", name="file", class_="freeform-input-file"),
606 T.input(type="submit", value="Overwrite")
608 return [T.div(class_="freeform-form")[overwrite],]
612 def render_results(self, ctx, data):
614 return get_arg(req, "results", "")
617 def DirectoryJSONMetadata(ctx, dirnode):
621 for name, (childnode, metadata) in children.iteritems():
622 if childnode.is_readonly():
624 ro_uri = childnode.get_uri()
626 rw_uri = childnode.get_uri()
627 ro_uri = childnode.get_readonly_uri()
628 if IFileNode.providedBy(childnode):
629 kiddata = ("filenode", {'size': childnode.get_size(),
630 'metadata': metadata,
633 assert IDirectoryNode.providedBy(childnode), (childnode,
635 kiddata = ("dirnode", {'metadata': metadata})
637 kiddata[1]["ro_uri"] = ro_uri
639 kiddata[1]["rw_uri"] = rw_uri
640 kiddata[1]['mutable'] = childnode.is_mutable()
642 if dirnode.is_readonly():
644 dro_uri = dirnode.get_uri()
646 drw_uri = dirnode.get_uri()
647 dro_uri = dirnode.get_readonly_uri()
648 contents = { 'children': kids }
650 contents['ro_uri'] = dro_uri
652 contents['rw_uri'] = drw_uri
653 contents['mutable'] = dirnode.is_mutable()
654 data = ("dirnode", contents)
655 return simplejson.dumps(data, indent=1)
657 d.addCallback(text_plain, ctx)
660 def DirectoryURI(ctx, dirnode):
661 return text_plain(dirnode.get_uri(), ctx)
663 def DirectoryReadonlyURI(ctx, dirnode):
664 return text_plain(dirnode.get_readonly_uri(), ctx)
666 class RenameForm(rend.Page):
668 docFactory = getxmlfile("rename-form.xhtml")
670 def render_title(self, ctx, data):
671 return ctx.tag["Directory SI=%s" % abbreviated_dirnode(self.original)]
673 def render_header(self, ctx, data):
675 "in directory SI=%s" % abbreviated_dirnode(self.original),
678 if self.original.is_readonly():
679 header.append(" (readonly!)")
681 return ctx.tag[header]
683 def render_when_done(self, ctx, data):
684 return T.input(type="hidden", name="when_done", value=".")
686 def render_get_name(self, ctx, data):
688 name = get_arg(req, "name", "")
689 ctx.tag.attributes['value'] = name
693 class Manifest(rend.Page):
694 docFactory = getxmlfile("manifest.xhtml")
696 def render_title(self, ctx):
697 return T.title["Manifest of SI=%s" % abbreviated_dirnode(self.original)]
699 def render_header(self, ctx):
700 return T.p["Manifest of SI=%s" % abbreviated_dirnode(self.original)]
702 def data_items(self, ctx, data):
703 return self.original.build_manifest()
705 def render_row(self, ctx, refresh_cap):
706 ctx.fillSlots("refresh_capability", refresh_cap)
709 def DeepSize(ctx, dirnode):
710 d = dirnode.build_manifest()
711 def _measure_size(manifest):
713 for verifiercap in manifest:
714 u = from_string_verifier(verifiercap)
715 if isinstance(u, CHKFileVerifierURI):
718 d.addCallback(_measure_size)
719 d.addCallback(text_plain, ctx)
722 def DeepStats(ctx, dirnode):
723 d = dirnode.deep_stats()
724 d.addCallback(simplejson.dumps, indent=1)
725 d.addCallback(text_plain, ctx)