Merge pull request django-cms#3276 from vovanbo/feature/appresolver_improvements

Support of nested namespaces in URLconfs in hooked apps

Author: digi604

cms/app_base.py

@@ -5,3 +5,4 @@ class CMSApp(object):
     menus = []
     app_name = None
     permissions = True
+    exclude_permissions = []

cms/appresolver.py

@@ -1,8 +1,6 @@
 # -*- coding: utf-8 -*-
 from __future__ import with_statement
 
-import sys
-
 from django.conf import settings
 from django.conf.urls import patterns
 from django.contrib.sites.models import Site
@@ -45,8 +43,9 @@ def applications_page_check(request, current_page=None, path=None):
             page_id = resolver.resolve_page_id(path)
             # yes, it is application page
             page = Page.objects.public().get(id=page_id)
-            # If current page was matched, then we have some override for content
-            # from cms, but keep current page. Otherwise return page to which was application assigned.
+            # If current page was matched, then we have some override for
+            # content from cms, but keep current page. Otherwise return page
+            # to which was application assigned.
             return page
         except Resolver404:
             # Raised if the page is not managed by an apphook
@@ -86,20 +85,20 @@ def resolve_page_id(self, path):
                 else:
                     try:
                         sub_match = pattern.resolve(new_path)
-                    except Resolver404:
-                        exc = sys.exc_info()[0]
-                        if 'tried' in exc.args[0]:
-                            tried.extend([[pattern] + t for t in exc.args[0]['tried']])
-                        elif 'path' in exc.args[0]:
-                            tried.extend([[pattern] + t for t in exc.args[0]['path']])
+                    except Resolver404 as e:
+                        tried_match = e.args[0].get('tried')
+                        if tried_match is not None:
+                            tried.extend([[pattern] + t for t in tried_match])
+                        else:
+                            tried.extend([pattern])
                     else:
                         if sub_match:
                             return pattern.page_id
                         tried.append(pattern.regex.pattern)
             raise Resolver404({'tried': tried, 'path': new_path})
 
 
-def recurse_patterns(path, pattern_list, page_id, default_args=None):
+def recurse_patterns(path, pattern_list, page_id, default_args=None, nested=False):
     """
     Recurse over a list of to-be-hooked patterns for a given path prefix
     """
@@ -109,7 +108,7 @@ def recurse_patterns(path, pattern_list, page_id, default_args=None):
         # make sure we don't get patterns that start with more than one '^'!
         app_pat = app_pat.lstrip('^')
         path = path.lstrip('^')
-        regex = r'^%s%s' % (path, app_pat)
+        regex = r'^%s%s' % (path, app_pat) if not nested else r'^%s' % (app_pat)
         if isinstance(pattern, RegexURLResolver):
             # this is an 'include', recurse!
             resolver = RegexURLResolver(regex, 'cms_appresolver',
@@ -120,7 +119,7 @@ def recurse_patterns(path, pattern_list, page_id, default_args=None):
             if default_args:
                 args.update(default_args)
             # see lines 243 and 236 of urlresolvers.py to understand the next line
-            resolver._urlconf_module = recurse_patterns(regex, pattern.url_patterns, page_id, args)
+            resolver._urlconf_module = recurse_patterns(regex, pattern.url_patterns, page_id, args, nested=True)
         else:
             # Re-do the RegexURLPattern with the new regular expression
             args = pattern.default_args
@@ -133,14 +132,15 @@ def recurse_patterns(path, pattern_list, page_id, default_args=None):
     return newpatterns
 
 
-def _flatten_patterns(patterns):
-    flat = []
+def _set_permissions(patterns, exclude_permissions):
     for pattern in patterns:
         if isinstance(pattern, RegexURLResolver):
-            flat += _flatten_patterns(pattern.url_patterns)
+            if pattern.namespace in exclude_permissions:
+                continue
+            _set_permissions(pattern.url_patterns, exclude_permissions)
         else:
-            flat.append(pattern)
-    return flat
+            from cms.utils.decorators import cms_perms
+            pattern._callback = cms_perms(pattern.callback)
 
 
 def get_app_urls(urls):
@@ -167,7 +167,6 @@ def get_patterns_for_title(path, title):
             path += '/'
         page_id = title.page.id
         url_patterns += recurse_patterns(path, pattern_list, page_id)
-    url_patterns = _flatten_patterns(url_patterns)
     return url_patterns
 
 
@@ -228,9 +227,8 @@ def get_app_patterns():
                 resolver = AppRegexURLResolver(r'', 'app_resolver', app_name=app_ns, namespace=inst_ns)
                 resolver.page_id = page_id
             if app.permissions:
-                from cms.utils.decorators import cms_perms
-                for pat in current_patterns:
-                    pat._callback = cms_perms(pat.callback)
+                _set_permissions(current_patterns, app.exclude_permissions)
+
             extra_patterns = patterns('', *current_patterns)
             resolver.url_patterns_dict[lang] = extra_patterns
         app_patterns.append(resolver)

cms/test_utils/project/sampleapp/cms_app.py

@@ -3,6 +3,7 @@
 from cms.apphook_pool import apphook_pool
 from django.utils.translation import ugettext_lazy as _
 
+
 class SampleApp(CMSApp):
     name = _("Sample App")
     urls = ["cms.test_utils.project.sampleapp.urls"]
@@ -12,6 +13,17 @@ class SampleApp(CMSApp):
 apphook_pool.register(SampleApp)
 
 
+class SampleAppWithExcludedPermissions(CMSApp):
+    name = _("Sample App with excluded permissions")
+    urls = [
+        "cms.test_utils.project.sampleapp.urls_excluded"
+    ]
+    permissions = True
+    exclude_permissions = ['excluded']
+
+apphook_pool.register(SampleAppWithExcludedPermissions)
+
+
 class SampleApp2(CMSApp):
     name = _("Sample App 2")
     urls = ["cms.test_utils.project.sampleapp.urls2"]

cms/test_utils/project/sampleapp/urls_excluded.py

@@ -0,0 +1,12 @@
+from django.conf.urls import patterns, url, include
+
+"""
+Used in test_apphook_excluded_permissions
+"""
+
+urlpatterns = patterns('cms.test_utils.project.sampleapp.views',
+    url(r'^excluded/',
+        include('cms.test_utils.project.sampleapp.urls_example', namespace="excluded", app_name='some_app')),
+    url(r'^not_excluded/',
+        include('cms.test_utils.project.sampleapp.urls_example', namespace="not_excluded", app_name='some_app')),
+)

cms/tests/apphooks.py

@@ -118,7 +118,7 @@ def test_implicit_apphooks(self):
             apphook_pool.clear()
             hooks = apphook_pool.get_apphooks()
             app_names = [hook[0] for hook in hooks]
-            self.assertEqual(len(hooks), 3)
+            self.assertEqual(len(hooks), 4)
             self.assertIn(NS_APP_NAME, app_names)
             self.assertIn(APP_NAME, app_names)
             apphook_pool.clear()
@@ -200,8 +200,10 @@ def test_apphook_permissions(self):
 
             with force_language("en"):
                 path = reverse('sample-settings')
+
             response = self.client.get(path)
             self.assertEqual(response.status_code, 200)
+
             page = en_title.page.publisher_public
             page.login_required = True
             page.save()
@@ -211,6 +213,26 @@ def test_apphook_permissions(self):
             self.assertEqual(response.status_code, 302)
             apphook_pool.clear()
 
+    def test_apphooks_with_excluded_permissions(self):
+        with SettingsOverride(ROOT_URLCONF='cms.test_utils.project.second_urls_for_apphook_tests'):
+            en_title = self.create_base_structure('SampleAppWithExcludedPermissions', 'en')
+
+            with force_language("en"):
+                excluded_path = reverse('excluded:example')
+                not_excluded_path = reverse('not_excluded:example')
+
+            page = en_title.page.publisher_public
+            page.login_required = True
+            page.save()
+            page.publish('en')
+
+            excluded_response = self.client.get(excluded_path)
+            not_excluded_response = self.client.get(not_excluded_path)
+            self.assertEqual(excluded_response.status_code, 200)
+            self.assertEqual(not_excluded_response.status_code, 302)
+
+            apphook_pool.clear()
+
     def test_get_page_for_apphook_on_preview_or_edit(self):
         with SettingsOverride(ROOT_URLCONF='cms.test_utils.project.urls_3'):
             if get_user_model().USERNAME_FIELD == 'email':

docs/extending_cms/app_integration.rst

@@ -440,7 +440,28 @@ Here is a simple example::
         ...
 
 
+If you have your own permission check in your app, or just don't want to wrap some nested apps
+with CMS permission decorator, then use ``exclude_permissions`` property of apphook::
 
+    class SampleApp(CMSApp):
+        name = _("Sample App")
+        urls = ["project.sampleapp.urls"]
+        permissions = True
+        exclude_permissions = ["some_nested_app"]
+
+
+For example, django-oscar_ apphook integration needs to be used with exclude permissions of dashboard app,
+because it use `customizable access function`__. So, your apphook in this case will looks like this::
+
+    class OscarApp(CMSApp):
+        name = _("Oscar")
+        urls = [
+            patterns('', *application.urls[0])
+        ]
+        exclude_permissions = ['dashboard']
+
+.. _django-oscar: https://github.com/tangentlabs/django-oscar
+.. __: https://github.com/tangentlabs/django-oscar/blob/0.7.2/oscar/apps/dashboard/nav.py#L57
 
 Automatically restart server on apphook changes
 -----------------------------------------------