Implementation, tests and docs for blacklists. This version allows listing directorie...

[tahoe-lafs/tahoe-lafs.git] / src / allmydata / web / common.py

diff --git a/src/allmydata/web/common.py b/src/allmydata/web/common.py
index 8e265679ce5acb591e44eff220c8e659e7512f9e..0a14bf307ab926c2893e30932b51c307092eec53 100644 (file)
--- a/src/allmydata/web/common.py
+++ b/src/allmydata/web/common.py
@@ -6,13 +6,15 @@ 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, NoSharesError, \
      EmptyPathnameComponentError, MustBeDeepImmutableError, \
-     MustBeReadonlyError, MustNotBeUnknownRWError
+     MustBeReadonlyError, MustNotBeUnknownRWError, SDMF_VERSION, MDMF_VERSION
 from allmydata.mutable.common import UnrecoverableFileError
 from allmydata.util import abbreviate
-from allmydata.util.encodingutil import to_str
+from allmydata.util.encodingutil import to_str, quote_output
+
 
 class IOpHandleTable(Interface):
     pass
@@ -31,6 +33,32 @@ def parse_replace_arg(replace):
     else:
         return boolean_of_arg(replace)
 
+
+def parse_mutable_type_arg(arg):
+    if not arg:
+        return None # interpreted by the caller as "let the nodemaker decide"
+
+    arg = arg.lower()
+    if arg == "mdmf":
+        return MDMF_VERSION
+    elif arg == "sdmf":
+        return SDMF_VERSION
+
+    return "invalid"
+
+
+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
@@ -166,8 +194,8 @@ def humanize_failure(f):
         return ("There was already a child by that name, and you asked me "
                 "to not replace it.", http.CONFLICT)
     if f.check(NoSuchChildError):
-        name = f.value.args[0]
-        return ("No such child: %s" % name.encode("utf-8"), http.NOT_FOUND)
+        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 "
@@ -194,42 +222,45 @@ def humanize_failure(f):
              "this object to learn more.")
         return (t, http.GONE)
     if f.check(MustNotBeUnknownRWError):
-        name = f.value.args[1]
+        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"
+                 "%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.") % name.encode("utf-8")
+                 "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"
+                 "%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.") % name.encode("utf-8")
+                 "case.") % quoted_name
         return (t, http.BAD_REQUEST)
     if f.check(MustBeDeepImmutableError):
-        name = f.value.args[1]
+        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 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." % name.encode("utf-8"))
+             "cap.") % quoted_name
         return (t, http.BAD_REQUEST)
     if f.check(MustBeReadonlyError):
-        name = f.value.args[1]
+        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." % name.encode("utf-8"))
+             "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):