Test for Issue 1166. Split cms.utils.page_resolver.get_page_from_path to reuse queryset code

Author: yakky

cms/tests/page.py

@@ -15,8 +15,14 @@
 from cms.test_utils.util.context_managers import (LanguageOverride,
                                                   SettingsOverride)
 from cms.utils.page_resolver import get_page_from_request
+from cms.test_utils.testcases import (CMSTestCase, URL_CMS_PAGE,
+    URL_CMS_PAGE_ADD)
+from cms.test_utils.util.context_managers import (LanguageOverride, 
+    SettingsOverride)
+from cms.utils.page_resolver import get_page_from_request, is_valid_overwrite_url
 from django.conf import settings
 from django.contrib.sites.models import Site
+from django.core.exceptions import ValidationError
 from django.core.urlresolvers import reverse
 from django.http import HttpRequest, HttpResponse, HttpResponseNotFound
 import datetime
@@ -662,6 +668,31 @@ def test_page_overwrite_urls(self):
         self.assertEqual(page3.get_absolute_url(),
             self.get_pages_root()+'i-want-another-url/')
 
+    def test_slug_url_overwrite_clash(self):
+        """ Tests if a URL-Override clashes with a normal page url
+        """
+        with SettingsOverride(CMS_MODERATOR=False, CMS_PERMISSION=False):
+            home = create_page('home', 'nav_playground.html', 'en', published=True)
+            bar = create_page('bar', 'nav_playground.html', 'en', published=False)
+            foo = create_page('foo', 'nav_playground.html', 'en', published=True)
+            # Tests to assure is_valid_overwrite_url is ok on plain pages
+            self.assertTrue(is_valid_overwrite_url(bar.get_absolute_url('en'),bar))
+            self.assertTrue(is_valid_overwrite_url(foo.get_absolute_url('en'),foo))
+
+            # Set url_overwrite for page foo
+            t = foo.get_title_obj(language='en')
+            t.has_url_overwrite = True
+            t.path = '/bar/'
+            t.save()
+            try:
+                url = is_valid_overwrite_url(bar.get_absolute_url('en'),bar)
+            except ValidationError:
+                url = False
+            if url:
+                bar.published = True
+                bar.save()
+            self.assertFalse(bar.published)
+
     def test_home_slug_not_accessible(self):
         with SettingsOverride(CMS_MODERATOR=False, CMS_PERMISSION=False):
             page = create_page('page', 'nav_playground.html', 'en', published=True)

cms/utils/page_resolver.py

@@ -2,18 +2,24 @@
 from cms.exceptions import NoHomeFound
 from cms.models.pagemodel import Page
 
+from django.utils.translation import ugettext_lazy as _
 from django.conf import settings
 from django.contrib.sites.models import Site
+from django.core.exceptions import ValidationError
 from django.core.urlresolvers import reverse
 from django.db.models.query_utils import Q
 import urllib
 import re
+from cms.utils.urlutils import any_path_re
 
 ADMIN_PAGE_RE_PATTERN = ur'cms/page/(\d+)'
 ADMIN_PAGE_RE = re.compile(ADMIN_PAGE_RE_PATTERN)
 
 
-def get_page_from_path(path, preview=False):
+def get_page_queryset_from_path(path, preview=False):
+    """ Returns a queryset of pages corresponding to the path given
+    In may returns None or a single page is no page is present or root path is given
+    """
     if 'django.contrib.admin' in settings.INSTALLED_APPS:
         admin_base = reverse('admin:index').lstrip('/')
     else:
@@ -43,7 +49,7 @@ def get_page_from_path(path, preview=False):
         pages = pages.published()
 
     pages = pages.filter(site=site)
-    
+
     # Check if there are any pages
     if not pages.all_root().exists():
         return None
@@ -65,13 +71,25 @@ def get_page_from_path(path, preview=False):
         query = Q(title_set__slug=path)
     else:
         query = Q(title_set__path=path)
-    try:
-        page = pages.filter(query).distinct().get()
-    except Page.DoesNotExist:
+    return pages.filter(query).distinct()
+
+
+def get_page_from_path(path, preview=False):
+    """ Resolves a url path to a single page object.
+    Raises exceptions is page does not exist or multiple pages are found
+    """
+    page_qs = get_page_queryset_from_path(path,preview)
+    if page_qs is not None:
+        if isinstance(page_qs,Page):
+            return page_qs
+        try:
+            page = page_qs.get()
+        except Page.DoesNotExist:
+            return None
+        return page
+    else:
         return None
-        
-    return page
-    
+
 
 def get_page_from_request(request, use_path=None):
     """
@@ -111,3 +129,21 @@ def get_page_from_request(request, use_path=None):
 
     request._current_page_cache = page
     return page
+
+
+def is_valid_overwrite_url(url,instance):
+    if url:
+        if not any_path_re.match(url):
+            raise ValidationError(_('Invalid URL, use /my/url format.'))
+        page_qs = get_page_queryset_from_path(url.strip('/'))
+        url_clashes = []
+        if page_qs is not None:
+            if isinstance(page_qs,Page):
+                pages = [page_qs]
+            for page in page_qs:
+                if page and page.pk != instance.pk:
+                    url_clashes.append("'%s'" % page)
+            if url_clashes:
+                url_clashes.append("'%s'" % instance)
+                raise ValidationError(_('Pages %(pages)s has the same url \'%(url)s\'.') % {'pages':", ".join(url_clashes),'url':url})
+    return True