Merge lp:~thumper/wikkid/script-name into lp:wikkid

[Tim Penhey]

Allow wikkid-serve to specify a script-name. This is the assumed to be the start of any request for a wikkid served page. If not, a 404 is returned.

Styling and links are updated to use the script-name.

[Tim Penhey (thumper)]

I approve :-)

review: Approve

[lp:~thumper/wikkid/script-name]

86. By Tim Penhey on 2012-05-17

Have the views use their own canonical_url function that uses the request object.

=== modified file 'bin/wikkid-serve'
--- bin/wikkid-serve	2011-03-09 21:34:46 +0000
+++ bin/wikkid-serve	2012-05-17 11:13:18 +0000
@@ -58,12 +58,16 @@
         '--default-format', type='string', default=DEFAULT_FORMAT,
         help=("Specify the default wiki format to use. Defaults to %r"
               % DEFAULT_FORMAT))
+    parser.add_option(
+        '--script-name',
+        help=('The SCRIPT_NAME for the environment.  This is the prefix for the URLs'))
     options, args = parser.parse_args(sys.argv[1:])
 
     execution_context = ExecutionContext(
         host=options.host,
         port=options.port,
-        default_format=options.default_format)
+        default_format=options.default_format,
+        script_name=options.script_name)
 
     if len(args) == 0:
         print "No branch location specified.\n"
 
=== modified file 'setup.py'
--- setup.py	2011-06-29 09:21:55 +0000
+++ setup.py	2012-05-17 11:13:18 +0000
@@ -31,7 +31,8 @@
         'zope.interface',
         ],
     test_requires=[
-        'beautifulsoup',
+        'bs4',
+        'bzrlib.tests',
         'testtools',
         ],
     test_suite='wikkid.tests',
 
=== modified file 'wikkid/app.py'
--- wikkid/app.py	2010-11-22 00:00:31 +0000
+++ wikkid/app.py	2012-05-17 11:13:18 +0000
@@ -11,6 +11,7 @@
 import mimetypes
 import os.path
 import urllib
+from wsgiref.util import shift_path_info
 
 from bzrlib import urlutils
 from webob import Request, Response
@@ -59,35 +60,50 @@
         self.skin = Skin(skin_name)
         self.logger = logging.getLogger('wikkid')
 
-    def __call__(self, environ, start_response):
-        """The WSGI bit."""
+    def process_call(self, environ):
+        """The actual implementation of dealing with the call."""
+        # TODO: reject requests that aren't GET or POST
         request = Request(environ)
-
-        # TODO: reject requests that aren't GET or POST
         path = urllib.unquote(request.path)
+        script_name = self.execution_context.script_name
+        if not path.startswith(script_name + '/'):
+            return HTTPNotFound()
+
+        shifted_prefix = ''
+        while shifted_prefix != script_name:
+            shifted = shift_path_info(environ)
+            shifted_prefix = '{0}/{1}'.format(shifted_prefix, shifted)
+        # Now we are just interested in the path_info having ignored the
+        # script name.
+        path = urllib.unquote(request.path_info)
+
         if path == '/favicon.ico':
             if self.skin.favicon is not None:
-                response = serve_file(self.skin.favicon)
+                return serve_file(self.skin.favicon)
             else:
-                response = HTTPNotFound()
-        elif path.startswith('/static/'):
+                return HTTPNotFound()
+
+        if path.startswith('/static/'):
             if self.skin.static_dir is not None:
                 static_dir = self.skin.static_dir.rstrip(os.sep) + os.sep
                 static_file = os.path.abspath(
                     urlutils.joinpath(static_dir, path[8:]))
                 if static_file.startswith(static_dir):
-                    response = serve_file(static_file)
+                    return serve_file(static_file)
                 else:
-                    response = HTTPNotFound()
+                    return HTTPNotFound()
             else:
-                response = HTTPNotFound()
-        else:
-            resource_path, action = parse_url(path)
-            model = self.resource_factory.get_resource_at_path(resource_path)
-            try:
-                view = get_view(model, action, request, self.execution_context)
-                response = view.render(self.skin)
-            except HTTPException, e:
-                response = e
-
+                return HTTPNotFound()
+
+        resource_path, action = parse_url(path)
+        model = self.resource_factory.get_resource_at_path(resource_path)
+        try:
+            view = get_view(model, action, request, self.execution_context)
+            return view.render(self.skin)
+        except HTTPException, e:
+            return e
+
+    def __call__(self, environ, start_response):
+        """The WSGI bit."""
+        response = self.process_call(environ)
         return response(environ, start_response)
 
=== modified file 'wikkid/context.py'
--- wikkid/context.py	2010-11-22 00:00:31 +0000
+++ wikkid/context.py	2012-05-17 11:13:18 +0000
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2010 Wikkid Developers.
+# Copyright (C) 2010-2012 Wikkid Developers.
 #
 # This software is licensed under the GNU Affero General Public License
 # version 3 (see the file LICENSE).
@@ -13,9 +13,13 @@
 
 
 class ExecutionContext(object):
-    """Store run-time execution context data."""
-
-    def __init__(self, host=None, port=None, default_format=None):
+    """Store run-time execution context data.
+
+    This is the Encapsulate Context pattern.
+    """
+
+    def __init__(self, host=None, port=None, default_format=None,
+                 script_name=None):
         """Create an execution context for the application.
 
         :param host: The hostname that content is being served from.
@@ -32,3 +36,8 @@
         self.host = host
         self.port = port
         self.default_format = default_format
+        # TODO: make sure the script_name if set starts with a slash and
+        # doesn't finish with one.
+        if script_name is None:
+            script_name = ''
+        self.script_name = script_name
 
=== modified file 'wikkid/skin/default/base.html'
--- wikkid/skin/default/base.html	2010-07-13 12:49:52 +0000
+++ wikkid/skin/default/base.html	2012-05-17 11:13:18 +0000
@@ -5,14 +5,14 @@
   <title>{% block title %}{% endblock %} - Wikkid</title>
 
   <link type="text/css" rel="stylesheet" media="screen, print"
-        href="/static/default.css" />
-  <link rel="shortcut icon" href="/favicon.ico" />
+        href="{{ request.script_name }}/static/default.css" />
+  <link rel="shortcut icon" href="{{ request.script_name }}/favicon.ico" />
   {% endblock %}
 </head>
 <body>
 <div id="container">
   <div id="header">
-    <div class="wikkidlogo"><a href="/"><strong>Wikkid Wiki</strong></a></div>
+    <div class="wikkidlogo"><a href="{{ request.script_name }}/"><strong>Wikkid Wiki</strong></a></div>
     <div id="logged">
       {% if view.user %}
 
@@ -44,7 +44,7 @@
   </div>
   {% block footer %}{% endblock %}
   <div id="footer">
-    &copy; 2010
+    &copy; 2010-2012
     <a href="https://launchpad.net/~wikkid">Wikkid Hackers</a>,
     All rights reserved.
   </div>
 
=== modified file 'wikkid/tests/factory.py'
--- wikkid/tests/factory.py	2010-06-15 09:05:29 +0000
+++ wikkid/tests/factory.py	2012-05-17 11:13:18 +0000
@@ -26,7 +26,7 @@
 class ViewTestCase(FactoryTestCase):
     """A factory test case that can create views."""
 
-    def get_view(self, factory, path, name=None):
+    def get_view(self, factory, path, name=None, base_url=None):
         info = factory.get_resource_at_path(path)
-        request = Request.blank(path)
+        request = Request.blank(path, base_url=base_url)
         return get_view(info, name, request)
 
=== modified file 'wikkid/tests/test_app.py'
--- wikkid/tests/test_app.py	2011-04-23 08:18:58 +0000
+++ wikkid/tests/test_app.py	2012-05-17 11:13:18 +0000
@@ -11,25 +11,28 @@
 from webob.request import environ_from_url
 
 from wikkid.app import WikkidApp
+from wikkid.context import ExecutionContext
 from wikkid.filestore.volatile import FileStore
 from wikkid.tests import TestCase
 
 
 class TestApp(TestCase):
 
+    def assert_not_found(self, status, headers):
+        self.assertEqual("404 Not Found", status)
+
+    def assert_ok(self, status, headers):
+        self.assertEqual("200 OK", status)
+
     def test_traverse_above_static_not_possible_with_relative_path(self):
         """
         Traversal above the static folder, by forging a malicious request with
         a relative path for example, is not possible.
         """
         environ = environ_from_url("/static/../page.html")
-
-        def start_response(status, headers):
-            self.assertEqual("404 Not Found", status)
-
         filestore = FileStore()
         app = WikkidApp(filestore)
-        app(environ, start_response)
+        app(environ, self.assert_not_found)
 
     def test_traverse_above_static_not_possible_with_absolute_path(self):
         """
@@ -38,10 +41,35 @@
         """
         this_file = os.path.abspath(__file__)
         environ = environ_from_url("/static/" + this_file)
-
-        def start_response(status, headers):
-            self.assertEqual("404 Not Found", status)
-
-        filestore = FileStore()
-        app = WikkidApp(filestore)
-        app(environ, start_response)
+        filestore = FileStore()
+        app = WikkidApp(filestore)
+        app(environ, self.assert_not_found)
+
+    def test_getting_static_style_css_works(self):
+
+        environ = environ_from_url("/static/default.css")
+        filestore = FileStore()
+        app = WikkidApp(filestore)
+        app(environ, self.assert_ok)
+
+    def test_getting_static_style_css_works_with_script_name(self):
+
+        environ = environ_from_url("/test/static/default.css")
+        filestore = FileStore()
+        context = ExecutionContext(script_name="/test")
+        app = WikkidApp(filestore, execution_context=context)
+        app(environ, self.assert_ok)
+
+    def test_getting_static_style_css_works_with_script_name_multiple_segments(self):
+        environ = environ_from_url("/p/project-name/wiki/static/default.css")
+        filestore = FileStore()
+        context = ExecutionContext(script_name="/p/project-name/wiki")
+        app = WikkidApp(filestore, execution_context=context)
+        app(environ, self.assert_ok)
+
+    def test_getting_anything_outside_script_name_fails(self):
+        environ = environ_from_url("/foo/bar")
+        filestore = FileStore()
+        context = ExecutionContext(script_name="/test")
+        app = WikkidApp(filestore, execution_context=context)
+        app(environ, self.assert_not_found)
 
=== modified file 'wikkid/tests/views/test_breadcrumbs.py'
--- wikkid/tests/views/test_breadcrumbs.py	2010-06-15 09:05:29 +0000
+++ wikkid/tests/views/test_breadcrumbs.py	2012-05-17 11:13:18 +0000
@@ -107,3 +107,16 @@
              ('wiki root', '/+listing'),
              ('SomePage', '/SomePage/+listing'),
              ('SubPage', '/SomePage/SubPage')])
+
+    def test_directory_breadcrumbs_nested_with_script_name(self):
+        # For each directory after the root, a listing crumb is added.
+        # Names are not wiki expanded.
+        factory = self.make_factory([
+                ('SomePage/SubPage/Nested.txt', 'some text')])
+        view = self.get_view(factory, '/SomePage/SubPage', 'listing', '/p/wiki')
+        self.assertBreadcrumbs(
+            view,
+            [('Home', '/p/wiki/Home'),
+             ('wiki root', '/p/wiki/+listing'),
+             ('SomePage', '/p/wiki/SomePage/+listing'),
+             ('SubPage', '/p/wiki/SomePage/SubPage')])
 
=== modified file 'wikkid/tests/views/test_root.py'
--- wikkid/tests/views/test_root.py	2010-06-17 10:45:52 +0000
+++ wikkid/tests/views/test_root.py	2012-05-17 11:13:18 +0000
@@ -6,16 +6,19 @@
 
 """Test views for the root object."""
 
+from bs4 import BeautifulSoup
+from testtools.matchers import Equals
 from webob.exc import HTTPSeeOther
 
+from wikkid.skin.loader import Skin
 from wikkid.tests.factory import ViewTestCase
 
 
 class TestRootViews(ViewTestCase):
     """Test the views on the root object."""
 
-    def test_last_modified_by(self):
-        """Test that the last committer is displayed properly"""
+    def test_root_redirects(self):
+        """Going to / redirects to the Home page."""
         factory = self.make_factory()
         view = self.get_view(factory, '/')
         error = self.assertRaises(
@@ -23,3 +26,31 @@
             view.render,
             None)
         self.assertEqual('/Home', error.headers['Location'])
+
+    def test_root_redirects_with_script_name(self):
+        """Redirection works and respects the script name"""
+        factory = self.make_factory()
+        view = self.get_view(factory, '/', base_url='/p/test')
+        error = self.assertRaises(
+            HTTPSeeOther,
+            view.render,
+            None)
+        self.assertEqual('/p/test/Home', error.headers['Location'])
+
+    def test_home_rendering(self):
+        """Render the home page and test the elements."""
+        factory = self.make_factory()
+        view = self.get_view(factory, '/Home')
+        content = view.render(Skin('default'))
+        soup = BeautifulSoup(content.text)
+        [style] = soup.find_all('link', {'rel':'stylesheet'})
+        self.assertThat(style['href'], Equals('/static/default.css'))
+
+    def test_home_rendering_with_script_name(self):
+        """Render the home page and test the elements."""
+        factory = self.make_factory()
+        view = self.get_view(factory, '/Home', base_url='/p/test')
+        content = view.render(Skin('default'))
+        soup = BeautifulSoup(content.text)
+        [style] = soup.find_all('link', {'rel':'stylesheet'})
+        self.assertThat(style['href'], Equals('/p/test/static/default.css'))
 
=== modified file 'wikkid/tests/views/test_urls.py'
--- wikkid/tests/views/test_urls.py	2010-06-16 10:29:35 +0000
+++ wikkid/tests/views/test_urls.py	2012-05-17 11:13:18 +0000
@@ -6,6 +6,9 @@
 
 """Tests the edit views."""
 
+from testtools.matchers import Equals
+from webob import Request
+
 from wikkid.tests import TestCase
 from wikkid.tests.factory import FactoryTestCase
 from wikkid.view.urls import canonical_url, parse_url
@@ -14,84 +17,86 @@
 class TestCanonicalUrl(FactoryTestCase):
     """Test the wikkid.view.base.canonical_url."""
 
+    def assertUrl(self, resource, url, view_name=None, base_url=None):
+        request = Request.blank('/', base_url=base_url)
+        self.assertThat(canonical_url(resource, request, view_name),
+                        Equals(url))
+
     def test_root(self):
         factory = self.make_factory()
         root = factory.get_resource_at_path('/')
-        self.assertEqual('/', canonical_url(root))
+        self.assertUrl(root, '/')
 
     def test_root_listing(self):
         factory = self.make_factory()
         root = factory.get_resource_at_path('/')
-        self.assertEqual('/+listing', canonical_url(root, 'listing'))
+        self.assertUrl(root, '/+listing', view_name='listing')
 
     def test_default(self):
         factory = self.make_factory([
             ('Home.txt', 'Some content'),
             ])
         root = factory.get_resource_at_path('/')
-        self.assertEqual('/Home', canonical_url(root.default_resource))
+        self.assertUrl(root.default_resource, '/Home')
 
     def test_default_view(self):
         factory = self.make_factory([
             ('Home.txt', 'Some content'),
             ])
         root = factory.get_resource_at_path('/')
-        self.assertEqual(
-            '/Home/+edit',
-            canonical_url(root.default_resource, 'edit'))
+        self.assertUrl(root.default_resource, '/Home/+edit', view_name='edit')
 
     def test_wiki_page(self):
         factory = self.make_factory([
             ('SomeDir/SomePage.txt', 'Some content'),
             ])
         page = factory.get_resource_at_path('/SomeDir/SomePage')
-        self.assertEqual('/SomeDir/SomePage', canonical_url(page))
+        self.assertUrl(page, '/SomeDir/SomePage')
 
     def test_wiki_page_view(self):
         factory = self.make_factory([
             ('SomeDir/SomePage.txt', 'Some content'),
             ])
         page = factory.get_resource_at_path('/SomeDir/SomePage')
-        self.assertEqual(
-            '/SomeDir/SomePage/+edit', canonical_url(page, 'edit'))
+        self.assertUrl(page, '/SomeDir/SomePage/+edit', view_name='edit')
 
     def test_wiki_page_full_url(self):
         factory = self.make_factory([
             ('SomeDir.txt', 'Some content'),
             ])
         page = factory.get_resource_at_path('/SomeDir.txt')
-        self.assertEqual('/SomeDir', canonical_url(page))
+        self.assertUrl(page, '/SomeDir')
 
     def test_wiki_page_full_url_with_view(self):
         factory = self.make_factory([
             ('SomeDir.txt', 'Some content'),
             ])
         page = factory.get_resource_at_path('/SomeDir.txt')
-        self.assertEqual('/SomeDir/+edit', canonical_url(page, 'edit'))
+        self.assertUrl(page, '/SomeDir/+edit', view_name='edit')
 
     def test_other_file(self):
         factory = self.make_factory([
             ('simple.py', '#!/usr/bin/python'),
             ])
         page = factory.get_resource_at_path('/simple.py')
-        self.assertEqual('/simple.py', canonical_url(page))
+        self.assertUrl(page, '/simple.py')
 
     def test_other_file_view(self):
         factory = self.make_factory([
             ('simple.py', '#!/usr/bin/python'),
             ])
         page = factory.get_resource_at_path('/simple.py')
-        self.assertEqual('/simple.py/+edit', canonical_url(page, 'edit'))
+        self.assertUrl(page, '/simple.py/+edit', view_name='edit')
 
     def test_missing(self):
         factory = self.make_factory()
-        root = factory.get_resource_at_path('/MissingPage')
-        self.assertEqual('/MissingPage', canonical_url(root))
+        missing = factory.get_resource_at_path('/MissingPage')
+        self.assertUrl(missing, '/MissingPage')
 
     def test_missing_view(self):
         factory = self.make_factory()
-        root = factory.get_resource_at_path('/MissingPage')
-        self.assertEqual('/MissingPage/+edit', canonical_url(root, 'edit'))
+        missing = factory.get_resource_at_path('/MissingPage')
+        self.assertUrl(missing, '/MissingPage/+edit', view_name='edit')
 
 
 class TestParseUrl(TestCase):
 
=== modified file 'wikkid/view/base.py'
--- wikkid/view/base.py	2010-11-22 09:23:40 +0000
+++ wikkid/view/base.py	2012-05-17 11:13:18 +0000
@@ -29,8 +29,8 @@
 class Breadcrumb(object):
     """Breadcrumbs exist to give the user quick links up the path chain."""
 
-    def __init__(self, context, view=None, title=None):
-        self.path = canonical_url(context, view)
+    def __init__(self, context, request, view=None, title=None):
+        self.path = canonical_url(context, request, view)
         if title is None:
             self.title = title_for_filename(context.base_name)
         else:
@@ -54,14 +54,14 @@
         self.logger = logging.getLogger('wikkid')
 
     def _create_breadcrumbs(self):
-        crumbs = [Breadcrumb(self.context)]
+        crumbs = [Breadcrumb(self.context, self.request)]
         current = self.context.parent
         while not IRootResource.providedBy(current):
-            crumbs.append(Breadcrumb(current))
+            crumbs.append(Breadcrumb(current, self.request))
             current = current.parent
         # And add in the default page if the context isn't the default.
         if not IDefaultPage.providedBy(self.context):
-            crumbs.append(Breadcrumb(current.default_resource))
+            crumbs.append(Breadcrumb(current.default_resource, self.request))
         return reversed(crumbs)
 
     def initialize(self):
@@ -89,6 +89,9 @@
     def before_render(self):
         """A hook to do things before rendering."""
 
+    def canonical_url(self, context, view=None):
+        return canonical_url(context, self.request, view)
+
     def template_args(self):
         """Needs to be implemented in the derived classes.
 
@@ -99,7 +102,7 @@
             'user': self.user,
             'context': self.context,
             'request': self.request,
-            'canonical_url': canonical_url,
+            'canonical_url': self.canonical_url,
             }
 
     def _render(self, skin):
@@ -139,12 +142,13 @@
         view = None
         while not IRootResource.providedBy(current):
             crumbs.append(Breadcrumb(
-                    current, view, title=current.base_name))
+                    current, self.request, view, title=current.base_name))
             current = current.parent
             # Add listings to subsequent urls.
             view = 'listing'
         # Add in the root dir.
-        crumbs.append(Breadcrumb(current, 'listing', title='wiki root'))
+        crumbs.append(Breadcrumb(current, self.request, 'listing',
+                                 title='wiki root'))
         # And add in the default page.
-        crumbs.append(Breadcrumb(current.default_resource))
+        crumbs.append(Breadcrumb(current.default_resource, self.request))
         return reversed(crumbs)
 
=== modified file 'wikkid/view/directory.py'
--- wikkid/view/directory.py	2010-06-23 10:57:14 +0000
+++ wikkid/view/directory.py	2012-05-17 11:13:18 +0000
@@ -14,9 +14,9 @@
 class ListingItem(object):
     """An item to be shown in the directory listing."""
 
-    def __init__(self, context, view, css_class, name=None):
+    def __init__(self, context, request, view, css_class, name=None):
         self.context = context
-        self.url = canonical_url(self.context, view)
+        self.url = canonical_url(self.context, request, view)
         if name is None:
             name = context.base_name
         self.name = name
@@ -53,11 +53,11 @@
         if self.context.path != '/':
             parent = self.context.parent
             items.append(
-                ListingItem(parent, 'listing', 'up', name='..'))
+                ListingItem(parent, self.request, 'listing', 'up', name='..'))
         for item in sorted(directories, key=sort_key):
-            items.append(ListingItem(item, 'listing', 'directory'))
+            items.append(ListingItem(item, self.request, 'listing', 'directory'))
         for item in sorted(files, key=sort_key):
-            items.append(ListingItem(item, None, 'file'))
+            items.append(ListingItem(item, self.request, None, 'file'))
         self.items = items
 
     @property
 
=== modified file 'wikkid/view/edit.py'
--- wikkid/view/edit.py	2010-06-17 10:45:52 +0000
+++ wikkid/view/edit.py	2012-05-17 11:13:18 +0000
@@ -24,7 +24,7 @@
     @property
     def save_url(self):
         """The link for the cancel button."""
-        return canonical_url(self.context, 'save')
+        return canonical_url(self.context, self.request, 'save')
 
     @property
     def cancel_url(self):
 
=== modified file 'wikkid/view/root.py'
--- wikkid/view/root.py	2010-06-17 10:45:52 +0000
+++ wikkid/view/root.py	2012-05-17 11:13:18 +0000
@@ -23,4 +23,6 @@
         """Redirect to Home (or the default page)."""
         default_resource = self.context.default_resource
         preferred = default_resource.preferred_path
+        if self.request.script_name:
+            preferred = self.request.script_name + preferred
         raise HTTPSeeOther(location=preferred)
 
=== modified file 'wikkid/view/urls.py'
--- wikkid/view/urls.py	2010-06-16 10:29:35 +0000
+++ wikkid/view/urls.py	2012-05-17 11:13:18 +0000
@@ -24,12 +24,12 @@
         return (path, None)
 
 
-def canonical_url(context, view=None):
+def canonical_url(context, request, view=None):
     """The one true URL for the context object."""
     path = context.preferred_path
     if view is None:
-        return path
+        return '{0}{1}'.format(request.script_name, path)
     else:
         if path == '/':
             path = ''
-        return '{0}/+{1}'.format(path, view)
+        return '{0}{1}/+{2}'.format(request.script_name, path, view)