+import time
+import simplejson
+
from twisted.web import http, server
+from twisted.python import log
from zope.interface import Interface
from nevow import loaders, appserver
from nevow.inevow import IRequest
from nevow.util import resource_filename
+from allmydata import blacklist
from allmydata.interfaces import ExistingChildError, NoSuchChildError, \
- FileTooLargeError, NotEnoughSharesError
-from allmydata.util import abbreviate # TODO: consolidate
+ FileTooLargeError, NotEnoughSharesError, NoSharesError, \
+ EmptyPathnameComponentError, MustBeDeepImmutableError, \
+ MustBeReadonlyError, MustNotBeUnknownRWError, SDMF_VERSION, MDMF_VERSION
+from allmydata.mutable.common import UnrecoverableFileError
+from allmydata.util import abbreviate
+from allmydata.util.time_format import format_time
+from allmydata.util.encodingutil import to_str, quote_output
+
+
+def get_filenode_metadata(filenode):
+ metadata = {'mutable': filenode.is_mutable()}
+ if metadata['mutable']:
+ mutable_type = filenode.get_version()
+ assert mutable_type in (SDMF_VERSION, MDMF_VERSION)
+ if mutable_type == MDMF_VERSION:
+ file_format = "MDMF"
+ else:
+ file_format = "SDMF"
+ else:
+ file_format = "CHK"
+ metadata['format'] = file_format
+ size = filenode.get_size()
+ if size is not None:
+ metadata['size'] = size
+ return metadata
class IOpHandleTable(Interface):
pass
def boolean_of_arg(arg):
# TODO: ""
- assert arg.lower() in ("true", "t", "1", "false", "f", "0", "on", "off")
+ if arg.lower() not in ("true", "t", "1", "false", "f", "0", "on", "off"):
+ raise WebError("invalid boolean argument: %r" % (arg,), http.BAD_REQUEST)
return arg.lower() in ("true", "t", "1", "on")
+def parse_replace_arg(replace):
+ if replace.lower() == "only-files":
+ return replace
+ try:
+ return boolean_of_arg(replace)
+ except WebError:
+ raise WebError("invalid replace= argument: %r" % (replace,), http.BAD_REQUEST)
+
+
+def get_format(req, default="CHK"):
+ arg = get_arg(req, "format", None)
+ if not arg:
+ if boolean_of_arg(get_arg(req, "mutable", "false")):
+ return "SDMF"
+ return default
+ if arg.upper() == "CHK":
+ return "CHK"
+ elif arg.upper() == "SDMF":
+ return "SDMF"
+ elif arg.upper() == "MDMF":
+ return "MDMF"
+ else:
+ raise WebError("Unknown format: %s, I know CHK, SDMF, MDMF" % arg,
+ http.BAD_REQUEST)
+
+def get_mutable_type(file_format): # accepts result of get_format()
+ if file_format == "SDMF":
+ return SDMF_VERSION
+ elif file_format == "MDMF":
+ return MDMF_VERSION
+ else:
+ # this is also used to identify which formats are mutable. Use
+ # if get_mutable_type(file_format) is not None:
+ # do_mutable()
+ # else:
+ # do_immutable()
+ return None
+
+
+def parse_offset_arg(offset):
+ # XXX: This will raise a ValueError when invoked on something that
+ # is not an integer. Is that okay? Or do we want a better error
+ # message? Since this call is going to be used by programmers and
+ # their tools rather than users (through the wui), it is not
+ # inconsistent to return that, I guess.
+ if offset is not None:
+ offset = int(offset)
+
+ return offset
+
+
def get_root(ctx_or_req):
req = IRequest(ctx_or_req)
# the addSlash=True gives us one extra (empty) segment
return results[0]
return default
+def convert_children_json(nodemaker, children_json):
+ """I convert the JSON output of GET?t=json into the dict-of-nodes input
+ to both dirnode.create_subdirectory() and
+ client.create_directory(initial_children=). This is used by
+ t=mkdir-with-children and t=mkdir-immutable"""
+ children = {}
+ if children_json:
+ data = simplejson.loads(children_json)
+ for (namex, (ctype, propdict)) in data.iteritems():
+ namex = unicode(namex)
+ writecap = to_str(propdict.get("rw_uri"))
+ readcap = to_str(propdict.get("ro_uri"))
+ metadata = propdict.get("metadata", {})
+ # name= argument is just for error reporting
+ childnode = nodemaker.create_from_cap(writecap, readcap, name=namex)
+ children[namex] = (childnode, metadata)
+ return children
+
def abbreviate_time(data):
# 1.23s, 790ms, 132us
if data is None:
if s >= 1.0:
return "%.2fs" % s
if s >= 0.01:
- return "%dms" % (1000*s)
+ return "%.0fms" % (1000*s)
if s >= 0.001:
return "%.1fms" % (1000*s)
- return "%dus" % (1000000*s)
+ return "%.0fus" % (1000000*s)
+
+def compute_rate(bytes, seconds):
+ if bytes is None:
+ return None
+
+ if seconds is None or seconds == 0:
+ return None
+
+ # negative values don't make sense here
+ assert bytes > -1
+ assert seconds > 0
+
+ return 1.0 * bytes / seconds
def abbreviate_rate(data):
# 21.8kBps, 554.4kBps 4.37MBps
return "%1.2fMBps" % (r/1000000)
if r > 1000:
return "%.1fkBps" % (r/1000)
- return "%dBps" % r
+ return "%.0fBps" % r
def abbreviate_size(data):
# 21.8kB, 554.4kB 4.37MB
return "%1.2fMB" % (r/1000000)
if r > 1000:
return "%.1fkB" % (r/1000)
- return "%dB" % r
+ return "%.0fB" % r
def plural(sequence_or_length):
if isinstance(sequence_or_length, int):
def text_plain(text, ctx):
req = IRequest(ctx)
req.setHeader("content-type", "text/plain")
- req.setHeader("content-length", len(text))
+ req.setHeader("content-length", b"%d" % len(text))
return text
+def spaces_to_nbsp(text):
+ return unicode(text).replace(u' ', u'\u00A0')
+
+def render_time(t):
+ return spaces_to_nbsp(format_time(time.localtime(t)))
+
class WebError(Exception):
def __init__(self, text, code=http.BAD_REQUEST):
self.text = text
return bool(req.method in ("PUT", "POST") and
t not in ("delete", "rename", "rename-form", "check"))
+def humanize_failure(f):
+ # return text, responsecode
+ if f.check(EmptyPathnameComponentError):
+ return ("The webapi does not allow empty pathname components, "
+ "i.e. a double slash", http.BAD_REQUEST)
+ if f.check(ExistingChildError):
+ return ("There was already a child by that name, and you asked me "
+ "to not replace it.", http.CONFLICT)
+ if f.check(NoSuchChildError):
+ quoted_name = quote_output(f.value.args[0], encoding="utf-8", quotemarks=False)
+ return ("No such child: %s" % quoted_name, http.NOT_FOUND)
+ if f.check(NotEnoughSharesError):
+ t = ("NotEnoughSharesError: This indicates that some "
+ "servers were unavailable, or that shares have been "
+ "lost to server departure, hard drive failure, or disk "
+ "corruption. You should perform a filecheck on "
+ "this object to learn more.\n\nThe full error message is:\n"
+ "%s") % str(f.value)
+ return (t, http.GONE)
+ if f.check(NoSharesError):
+ t = ("NoSharesError: no shares could be found. "
+ "Zero shares usually indicates a corrupt URI, or that "
+ "no servers were connected, but it might also indicate "
+ "severe corruption. You should perform a filecheck on "
+ "this object to learn more.\n\nThe full error message is:\n"
+ "%s") % str(f.value)
+ return (t, http.GONE)
+ if f.check(UnrecoverableFileError):
+ t = ("UnrecoverableFileError: the directory (or mutable file) could "
+ "not be retrieved, because there were insufficient good shares. "
+ "This might indicate that no servers were connected, "
+ "insufficient servers were connected, the URI was corrupt, or "
+ "that shares have been lost due to server departure, hard drive "
+ "failure, or disk corruption. You should perform a filecheck on "
+ "this object to learn more.")
+ return (t, http.GONE)
+ if f.check(MustNotBeUnknownRWError):
+ quoted_name = quote_output(f.value.args[1], encoding="utf-8")
+ immutable = f.value.args[2]
+ if immutable:
+ t = ("MustNotBeUnknownRWError: an operation to add a child named "
+ "%s to a directory was given an unknown cap in a write slot.\n"
+ "If the cap is actually an immutable readcap, then using a "
+ "webapi server that supports a later version of Tahoe may help.\n\n"
+ "If you are using the webapi directly, then specifying an immutable "
+ "readcap in the read slot (ro_uri) of the JSON PROPDICT, and "
+ "omitting the write slot (rw_uri), would also work in this "
+ "case.") % quoted_name
+ else:
+ t = ("MustNotBeUnknownRWError: an operation to add a child named "
+ "%s to a directory was given an unknown cap in a write slot.\n"
+ "Using a webapi server that supports a later version of Tahoe "
+ "may help.\n\n"
+ "If you are using the webapi directly, specifying a readcap in "
+ "the read slot (ro_uri) of the JSON PROPDICT, as well as a "
+ "writecap in the write slot if desired, would also work in this "
+ "case.") % quoted_name
+ return (t, http.BAD_REQUEST)
+ if f.check(MustBeDeepImmutableError):
+ quoted_name = quote_output(f.value.args[1], encoding="utf-8")
+ t = ("MustBeDeepImmutableError: a cap passed to this operation for "
+ "the child named %s, needed to be immutable but was not. Either "
+ "the cap is being added to an immutable directory, or it was "
+ "originally retrieved from an immutable directory as an unknown "
+ "cap.") % quoted_name
+ return (t, http.BAD_REQUEST)
+ if f.check(MustBeReadonlyError):
+ quoted_name = quote_output(f.value.args[1], encoding="utf-8")
+ t = ("MustBeReadonlyError: a cap passed to this operation for "
+ "the child named '%s', needed to be read-only but was not. "
+ "The cap is being passed in a read slot (ro_uri), or was retrieved "
+ "from a read slot as an unknown cap.") % quoted_name
+ return (t, http.BAD_REQUEST)
+ if f.check(blacklist.FileProhibited):
+ t = "Access Prohibited: %s" % quote_output(f.value.reason, encoding="utf-8", quotemarks=False)
+ return (t, http.FORBIDDEN)
+ if f.check(WebError):
+ return (f.value.text, f.value.code)
+ if f.check(FileTooLargeError):
+ return (f.getTraceback(), http.REQUEST_ENTITY_TOO_LARGE)
+ return (str(f), None)
class MyExceptionHandler(appserver.DefaultExceptionHandler):
def simple(self, ctx, text, code=http.BAD_REQUEST):
req.setHeader("content-type", "text/plain;charset=utf-8")
if isinstance(text, unicode):
text = text.encode("utf-8")
- req.setHeader("content-length", str(len(text)))
+ req.setHeader("content-length", b"%d" % len(text))
req.write(text)
# TODO: consider putting the requested URL here
req.finishRequest(False)
def renderHTTP_exception(self, ctx, f):
- traceback = f.getTraceback()
- if f.check(ExistingChildError):
- return self.simple(ctx,
- "There was already a child by that "
- "name, and you asked me to not "
- "replace it.",
- http.CONFLICT)
- elif f.check(NoSuchChildError):
- name = f.value.args[0]
- return self.simple(ctx,
- "No such child: %s" % name.encode("utf-8"),
- http.NOT_FOUND)
- elif f.check(NotEnoughSharesError):
- got = f.value.got
- needed = f.value.needed
- if got == 0:
- t = ("NotEnoughSharesError: no shares could be found. "
- "Zero shares usually indicates a corrupt URI, or that "
- "no servers were connected, but it might also indicate "
- "severe corruption. You should perform a filecheck on "
- "this object to learn more.")
- else:
- t = ("NotEnoughSharesError: %d share%s found, but we need "
- "%d to recover the file. This indicates that some "
- "servers were unavailable, or that shares have been "
- "lost to server departure, hard drive failure, or disk "
- "corruption. You should perform a filecheck on "
- "this object to learn more.") % (got, plural(got), needed)
- return self.simple(ctx, t, http.GONE)
- elif f.check(WebError):
- return self.simple(ctx, f.value.text, f.value.code)
- elif f.check(FileTooLargeError):
- return self.simple(ctx, str(f.value), http.REQUEST_ENTITY_TOO_LARGE)
- elif f.check(server.UnsupportedMethod):
+ try:
+ text, code = humanize_failure(f)
+ except:
+ log.msg("exception in humanize_failure")
+ log.msg("argument was %s" % (f,))
+ log.err()
+ text, code = str(f), None
+ if code is not None:
+ return self.simple(ctx, text, code)
+ if f.check(server.UnsupportedMethod):
# twisted.web.server.Request.render() has support for transforming
# this into an appropriate 501 NOT_IMPLEMENTED or 405 NOT_ALLOWED
# return code, but nevow does not.
super = appserver.DefaultExceptionHandler
return super.renderHTTP_exception(self, ctx, f)
# use plain text
+ traceback = f.getTraceback()
return self.simple(ctx, traceback, http.INTERNAL_SERVER_ERROR)
class NeedOperationHandleError(WebError):
projects / tahoe-lafs / tahoe-lafs.git / blobdiff