Merge lp:~yeliabmas/wikkid/fixes-for-sloecode into lp:wikkid

[Brendan Cooper]

Small fixes and docstrings in preprocess_environ for when using Wikkid as a module.

Added a method to filestore for getting a recursive listing on a directory.

Added a config setting for telling formatters to strip html. Doesn't work in most formatters as that functionality doesn't exist/is hard to find, but the option is there to implement it.

Small fix for TextFile to UTF encode content before rendering.

[lp:~yeliabmas/wikkid/fixes-for-sloecode]

82. By Sam Bailey on 2012-11-06

Fixed bug where Markdown would not display unicode content in files.

Unmerged revisions

82. By Sam Bailey on 2012-11-06

Fixed bug where Markdown would not display unicode content in files.

81. By Sam Bailey on 2012-10-28

Removed some outdated docstrings.

80. By Sam Bailey on 2012-10-28

Forgot to add strip_html to preview.

79. By Sam Bailey on 2012-10-28

Added a strip_html parameter to ExecutionContext. Currently only works in Markdown; no other formatters seem to support this.

78. By Sam Bailey on 2012-10-28

Changed the public-facing implementation of preprocess_environ to create a copy of the environ before use. This prevents the path_info in environ being modified if Wikkid is being used as a module.

77. By Sam Bailey on 2012-10-28

TextFile content now UTF encoded.

76. By Sam Bailey on 2012-10-28

Added parameter to the list_directory method to allow recursive directory lookups.

75. By Sam Bailey on 2012-09-13

Changed preprocess_environ in some of the views that need to be redirected. Now can call _preprocess_environ() for redirection without actually requiring a skin.

74. By Sam Bailey on 2012-09-03

Small fixes to ensure that it works with Sloecode. Moved redirection to before_render. Copying the environ before using it so that it can be reused

=== modified file 'wikkid/app.py'
--- wikkid/app.py	2012-06-14 08:49:55 +0000
+++ wikkid/app.py	2012-11-06 03:23:19 +0000
@@ -7,15 +7,16 @@
 
 """A WSGI application for Wikkid."""
 
+import copy
 import logging
 import mimetypes
 import os.path
 import urllib
-from wsgiref.util import shift_path_info
 
 from bzrlib import urlutils
 from webob import Request, Response
 from webob.exc import HTTPException, HTTPNotFound
+from wsgiref.util import shift_path_info
 
 from wikkid.context import ExecutionContext
 from wikkid.dispatcher import get_view
@@ -61,6 +62,22 @@
         self.logger = logging.getLogger('wikkid')
 
     def preprocess_environ(self, environ):
+        """External entry point which creates a copy of the environ
+        then uses that.
+
+        If environ is being used by any other sites then things can
+        get messy (mostly because script_name gets used where it
+        shouldn't, etc).
+
+        """
+        new_environ = copy.copy(environ)
+        return self._preprocess_environ(new_environ)
+
+    def _preprocess_environ(self, environ):
+        """Strips the script_name from the start of the environ's
+        PATH_INFO.
+
+        """
         request = Request(environ)
         path = urllib.unquote(request.path)
         script_name = self.execution_context.script_name
@@ -69,6 +86,11 @@
             not path.startswith(script_name + '/')):
             raise HTTPNotFound()
 
+        # Strip script_name from the start of environ['PATH_INFO'].
+        # PATH_INFO should always start with script_name here. If
+        # the assertion fails then user shold probably be using
+        # preprocess_environ
+        assert environ['PATH_INFO'].startswith(script_name)
         shifted_prefix = ''
         while shifted_prefix != script_name:
             shifted = shift_path_info(environ)
@@ -90,7 +112,7 @@
         """The actual implementation of dealing with the call."""
         # TODO: reject requests that aren't GET or POST
         try:
-            request, path = self.preprocess_environ(environ)
+            request, path = self._preprocess_environ(environ)
         except HTTPException, e:
             return e
 
 
=== modified file 'wikkid/context.py'
--- wikkid/context.py	2012-06-14 08:40:25 +0000
+++ wikkid/context.py	2012-11-06 03:23:19 +0000
@@ -10,6 +10,9 @@
 DEFAULT_FORMAT = 'rest'
 DEFAULT_HOST = 'localhost'
 DEFAULT_PORT = 8080
+# STRIP_HTML only does anything in Markdown currently. The other formatters
+# do not support this.
+DEFAULT_STRIP_HTML = True
 
 
 class ExecutionContext(object):
@@ -19,13 +22,15 @@
     """
 
     def __init__(self, host=None, port=None, default_format=None,
-                 script_name=None):
+                 script_name=None, strip_html=None):
         """Create an execution context for the application.
 
         :param host: The hostname that content is being served from.
         :param port: The port that is being listened on.
         :param default_format: The default wiki format for pages that
             don't specify any.
+        :param strip_html: Toggles whether or not raw html gets stripped
+            from page content. Currently only supported in Markdown.
         """
         if host is None:
             host = DEFAULT_HOST
@@ -41,3 +46,6 @@
         if script_name is None:
             script_name = ''
         self.script_name = script_name.rstrip('/')
+        if strip_html is None:
+            strip_html = DEFAULT_STRIP_HTML
+        self.strip_html = strip_html
 
=== modified file 'wikkid/filestore/bzr.py'
--- wikkid/filestore/bzr.py	2012-06-14 01:14:00 +0000
+++ wikkid/filestore/bzr.py	2012-11-06 03:23:19 +0000
@@ -207,7 +207,7 @@
         finally:
             wt.unlock()
 
-    def list_directory(self, directory_path):
+    def list_directory(self, directory_path, recursive=False):
         """Return a list of File objects for in the directory path.
 
         If the path doesn't exist, returns None.  If the path exists but is
@@ -223,7 +223,7 @@
         wt.lock_read()
         try:
             for fp, fc, fkind, fid, entry in wt.list_files(
-                from_dir=directory_path, recursive=False):
+                from_dir=directory_path, recursive=recursive):
                 if fc != 'V':
                     # If the file isn't versioned, skip it.
                     continue
 
=== modified file 'wikkid/filestore/volatile.py'
--- wikkid/filestore/volatile.py	2010-06-07 08:56:13 +0000
+++ wikkid/filestore/volatile.py	2012-11-06 03:23:19 +0000
@@ -86,7 +86,7 @@
             existing_file.last_modified_by = user
             existing_file.last_modified_date = datetime.utcnow()
 
-    def list_directory(self, directory_path):
+    def list_directory(self, directory_path, recursive=False):
         """Return a list of File objects for in the directory path.
 
         If the path doesn't exist, returns None.  If the path exists but is
@@ -102,8 +102,12 @@
         listing = []
         for path, value in self.path_map.iteritems():
             path_dir = dirname(path)
-            if path_dir == directory_path:
-                listing.append(value)
+            if not recursive:
+                if path_dir == directory_path:
+                    listing.append(value)
+            else:
+                if path_dir.startswith(directory_path):
+                    listing.append(value)
         return listing
 
 
 
=== modified file 'wikkid/formatter/creoleformatter.py'
--- wikkid/formatter/creoleformatter.py	2010-05-12 10:39:13 +0000
+++ wikkid/formatter/creoleformatter.py	2012-11-06 03:23:19 +0000
@@ -28,6 +28,6 @@
     def __init__(self):
         self.rules = Rules(wiki_words=True)
 
-    def format(self, filename, text):
+    def format(self, filename, text, strip_html=True):
         """Format the text."""
         return HtmlEmitter(Parser(text, self.rules).parse()).emit()
 
=== modified file 'wikkid/formatter/markdownformatter.py'
--- wikkid/formatter/markdownformatter.py	2010-11-05 05:32:47 +0000
+++ wikkid/formatter/markdownformatter.py	2012-11-06 03:23:19 +0000
@@ -19,9 +19,11 @@
 
     implements(ITextFormatter)
 
-    def format(self, filename, text):
+    def format(self, filename, text, strip_html=True):
         """Format the text.
         """
-        md = markdown.Markdown(safe_mode='replace')
+        if strip_html is False:
+            md = markdown.Markdown()
+        else:
+            md = markdown.Markdown(safe_mode='replace')
         return md.convert(text)
-
 
=== modified file 'wikkid/formatter/pygmentsformatter.py'
--- wikkid/formatter/pygmentsformatter.py	2010-11-05 05:32:47 +0000
+++ wikkid/formatter/pygmentsformatter.py	2012-11-06 03:23:19 +0000
@@ -22,7 +22,7 @@
 
     implements(ITextFormatter)
 
-    def format(self, filename, text):
+    def format(self, filename, text, strip_html=True):
         """Format the text.
 
         We can at a later time try to guess the lexer based on the file
 
=== modified file 'wikkid/formatter/restformatter.py'
--- wikkid/formatter/restformatter.py	2010-05-12 10:56:03 +0000
+++ wikkid/formatter/restformatter.py	2012-11-06 03:23:19 +0000
@@ -17,7 +17,7 @@
 
     implements(ITextFormatter)
 
-    def format(self, filename, text):
+    def format(self, filename, text, strip_html=True):
         """Format the text.
 
         I'm almost 100% positive that this method needs more args.
 
=== modified file 'wikkid/formatter/textileformatter.py'
--- wikkid/formatter/textileformatter.py	2010-11-12 09:00:42 +0000
+++ wikkid/formatter/textileformatter.py	2012-11-06 03:23:19 +0000
@@ -19,7 +19,7 @@
 
     implements(ITextFormatter)
 
-    def format(self, filename, text):
+    def format(self, filename, text, strip_html=True):
         """Format the text.
         """
         return textile(text)
 
=== modified file 'wikkid/interface/filestore.py'
--- wikkid/interface/filestore.py	2010-06-07 08:24:06 +0000
+++ wikkid/interface/filestore.py	2012-11-06 03:23:19 +0000
@@ -36,7 +36,7 @@
            provided, then some sensible default will be used.
         """
 
-    def list_directory(path):
+    def list_directory(path, recursive=False):
         """Return a list of IFile objects.
 
         Each of the IFile objects will be directly in the directory specified
 
=== modified file 'wikkid/interface/formatter.py'
--- wikkid/interface/formatter.py	2010-05-12 10:39:13 +0000
+++ wikkid/interface/formatter.py	2012-11-06 03:23:19 +0000
@@ -13,5 +13,5 @@
 class ITextFormatter(Interface):
     """A text formatter takes plain text and makes HTML of some form."""
 
-    def format(filename, text):
+    def format(filename, text, strip_html=True):
         """Takes text, and returns HTML."""
 
=== modified file 'wikkid/tests/filestore.py'
--- wikkid/tests/filestore.py	2010-11-08 00:00:06 +0000
+++ wikkid/tests/filestore.py	2012-11-06 03:23:19 +0000
@@ -154,6 +154,19 @@
             ['another', 'subfile'],
             sorted(f.base_name for f in listing))
 
+    def test_recursive_list_directory(self):
+        filestore = self.make_filestore(
+            [('some-file', 'content'),
+             ('directory/', None),
+             ('directory/another-file', 'content'),
+             ('directory/subdirectory/', None),
+             ('directory/subdirectory/nested-file', 'content'),
+             ])
+        listing = filestore.list_directory('directory', recursive=True)
+        self.assertEqual(
+            ['another-file', 'nested-file', 'subdirectory'],
+            sorted(f.base_name for f in listing))
+
     def test_last_modified(self):
         # Make sure that the timestamp and author are recorded.
         start = datetime.utcnow()
 
=== modified file 'wikkid/tests/test_app.py'
--- wikkid/tests/test_app.py	2012-06-14 08:51:43 +0000
+++ wikkid/tests/test_app.py	2012-11-06 03:23:19 +0000
@@ -99,3 +99,19 @@
     def test_get_home_view(self):
         content = [('Home.txt', 'Welcome Home.')]
         self.assertUrlIsView("/Home", WikiPage, store_content=content)
+
+    def test_environ_can_be_reused_without_script_name(self):
+        environ = environ_from_url("/baz")
+        filestore = FileStore([("baz.txt", "Content")])
+        context = ExecutionContext()
+        app = WikkidApp(filestore, execution_context=context)
+        app.preprocess_environ(environ)
+        app(environ, self.assert_ok)
+
+    def test_environ_can_be_reused_with_script_name(self):
+        environ = environ_from_url("/foo/bar/baz")
+        filestore = FileStore([("baz.txt", "Content")])
+        context = ExecutionContext(script_name="/foo/bar")
+        app = WikkidApp(filestore, execution_context=context)
+        app.preprocess_environ(environ)
+        app(environ, self.assert_ok)
 
=== modified file 'wikkid/view/textfile.py'
--- wikkid/view/textfile.py	2012-05-17 11:41:05 +0000
+++ wikkid/view/textfile.py	2012-11-06 03:23:19 +0000
@@ -45,7 +45,7 @@
 
     name = 'save'
 
-    def _render(self, skin):
+    def before_render(self):
         """Save the text file.
 
         If it conflicts, render the edit, otherwise render the page (ideally
@@ -62,11 +62,13 @@
             self.rev_id = rev_id
             self.description = description
             self.content = content
+            strip_html = self.execution_context.strip_html
             default_format = self.execution_context.default_format
             self.preview_content = format_content(
-                content, self.context.base_name, default_format)
+                content, self.context.base_name, default_format, strip_html)
         else:
             try:
+                content = content.encode('utf-8')
                 self.context.put_bytes(
                     content, self.user.committer_id, rev_id, description)
 
@@ -81,7 +83,6 @@
                 self.message = "Conflicts detected during merge."
 
         self.description = description
-        return super(SaveNewTextContent, self)._render(skin)
 
 
 class UpdateTextFile(SaveNewTextContent):
 
=== modified file 'wikkid/view/wiki.py'
--- wikkid/view/wiki.py	2012-05-17 11:41:05 +0000
+++ wikkid/view/wiki.py	2012-11-06 03:23:19 +0000
@@ -14,7 +14,7 @@
 from wikkid.view.base import BaseView
 
 
-def format_content(bytes, base_name, default_format):
+def format_content(bytes, base_name, default_format, strip_html=None):
     """ Format the content with the right formatter.
 
     Check the first line of the content to see if it specifies a
@@ -22,7 +22,7 @@
     configurable shortly.
     """
     content, formatter = get_wiki_formatter(bytes, default_format)
-    return formatter.format(base_name, content)
+    return formatter.format(base_name, content, strip_html=strip_html)
 
 
 class WikiPage(BaseView):
@@ -37,9 +37,11 @@
     def content(self):
         bytes = self.context.get_bytes()
         default_format = self.execution_context.default_format
-        return format_content(bytes, self.context.base_name, default_format)
+        strip_html = self.execution_context.strip_html
+        bytes = bytes.decode('utf-8')
+        return format_content(bytes, self.context.base_name, default_format, strip_html=strip_html)
 
-    def _render(self, skin):
+    def before_render(self):
         """If the page is not being viewed with the preferred path, redirect.
 
         For example, /FrontPage.txt will redirect to /FrontPage
@@ -48,5 +50,3 @@
         if self.context.path != preferred:
             location = self.canonical_url(self.context)
             raise HTTPTemporaryRedirect(location=location)
-        else:
-            return super(WikiPage, self)._render(skin)