Skip to content

Commit

Permalink
Merge pull request django-cms#6 from mkoistinen/mkoistinen-future/app…
Browse files Browse the repository at this point in the history 
…spaced_apphooks

Mkoistinen future/appspaced apphooks
  • Loading branch information
@yakky
yakky committed Feb 11, 2015
2 parents 2237615 + 5969cbc commit 6ecde67
Show file tree
Hide file tree
Showing 9 changed files with 345 additions and 177 deletions.
12 changes: 8 additions & 4 deletions cms/apphook_pool.py
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# -*- coding: utf-8 -*-

import warnings

from django.core.exceptions import ImproperlyConfigured
Expand Down Expand Up @@ -40,8 +41,9 @@ def register(self, app=None, discovering_apps=False):
'but %r does not' % app.__name__)

if not hasattr(app, 'menus') and hasattr(app, 'menu'):
warnings.warn("You define a 'menu' attribute on CMS application %r, "
"but the 'menus' attribute is empty, did you make a typo?" % app.__name__)
warnings.warn("You define a 'menu' attribute on CMS application "
"%r, but the 'menus' attribute is empty, "
"did you make a typo?" % app.__name__)

self.apps[app.__name__] = app()
return app
Expand Down Expand Up @@ -73,7 +75,8 @@ def get_apphooks(self):
if app.urls:
hooks.append((app_name, app.name))

# Unfortunately, we loose the ordering since we now have a list of tuples. Let's reorder by app_name:
# Unfortunately, we lose the ordering since we now have a list of
# tuples. Let's reorder by app_name:
hooks = sorted(hooks, key=lambda hook: hook[1])

return hooks
Expand All @@ -85,7 +88,8 @@ def get_apphook(self, app_name):
try:
return self.apps[app_name]
except KeyError:
# deprecated: return apphooks registered in db with urlconf name instead of apphook class name
# deprecated: return apphooks registered in db with urlconf name
# instead of apphook class name
for app in self.apps.values():
if app_name in app.urls:
return app
Expand Down
121 changes: 71 additions & 50 deletions cms/menu.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,65 +36,73 @@ def get_visible_pages(request, pages, site=None):
is_auth_user = request.user.is_authenticated()
visible_page_ids = []
restricted_pages = defaultdict(list)
page_permissions = PagePermission.objects.filter(can_view=True).select_related(
'page').prefetch_related('group__' + user_related_name)
page_permissions = PagePermission.objects.filter(
can_view=True
).select_related(
'page'
).prefetch_related('group__' + user_related_name)

for perm in page_permissions:
# collect the pages that are affected by permissions
if site and perm.page.site_id != site.pk:
continue
if perm is not None and perm not in restricted_pages[perm.page.pk]:
# affective restricted pages gathering
# using mptt functions
# using mptt functions
# add the page with the perm itself
if perm.grant_on in [ACCESS_PAGE, ACCESS_PAGE_AND_CHILDREN, ACCESS_PAGE_AND_DESCENDANTS]:
if perm.grant_on in [
ACCESS_PAGE, ACCESS_PAGE_AND_CHILDREN,
ACCESS_PAGE_AND_DESCENDANTS]:
restricted_pages[perm.page.pk].append(perm)
restricted_pages[perm.page.publisher_public_id].append(perm)
# add children
if perm.grant_on in [ACCESS_CHILDREN, ACCESS_PAGE_AND_CHILDREN]:
child_ids = perm.page.get_children().values_list('id', 'publisher_public_id')
child_ids = perm.page.get_children().values_list(
'id', 'publisher_public_id')
for id, public_id in child_ids:
restricted_pages[id].append(perm)
restricted_pages[public_id].append(perm)
# add descendants
elif perm.grant_on in [ACCESS_DESCENDANTS, ACCESS_PAGE_AND_DESCENDANTS]:
child_ids = perm.page.get_descendants().values_list('id', 'publisher_public_id')
elif perm.grant_on in [
ACCESS_DESCENDANTS, ACCESS_PAGE_AND_DESCENDANTS]:
child_ids = perm.page.get_descendants().values_list(
'id', 'publisher_public_id')
for id, public_id in child_ids:
restricted_pages[id].append(perm)
restricted_pages[public_id].append(perm)

# anonymous
# no restriction applied at all
if (not is_auth_user and
is_setting_public_all and
not restricted_pages):
if (not is_auth_user and is_setting_public_all and
not restricted_pages):
return [page.pk for page in pages]

if site is None:
site = current_site(request)

# authenticated user and global permission
if is_auth_user:
global_view_perms = GlobalPagePermission.objects.user_has_view_permission(
request.user, site.pk).exists()
global_view_perms = GlobalPagePermission.objects.user_has_view_permission(request.user, site.pk).exists()

#no page perms edge case - all visible
# no page perms edge case - all visible
if ((is_setting_public_all or (
is_setting_public_staff and request.user.is_staff)) and
not restricted_pages and
not global_view_perms):
not restricted_pages and
not global_view_perms):
return [page.pk for page in pages]
#no page perms edge case - none visible
# no page perms edge case - none visible
elif (is_setting_public_staff and
not request.user.is_staff and
not restricted_pages and
not global_view_perms):
not request.user.is_staff and
not restricted_pages and
not global_view_perms):
return []


def has_global_perm():
if has_global_perm.cache < 0:
has_global_perm.cache = 1 if request.user.has_perm('cms.view_page') else 0
if request.user.has_perm('cms.view_page'):
has_global_perm.cache = 1
else:
has_global_perm.cache = 0
return bool(has_global_perm.cache)

has_global_perm.cache = -1
Expand Down Expand Up @@ -135,15 +143,15 @@ def has_permission_membership(page):
is_setting_public_staff and request.user.is_staff)
):
# authenticated user, no restriction and public for all
# or
# or
# authenticated staff user, no restriction and public for staff
to_add = True
# check group and user memberships to restricted pages
elif is_restricted and has_permission_membership(page):
to_add = True
elif has_global_perm():
to_add = True
# anonymous user, no restriction
# anonymous user, no restriction
elif not is_restricted and is_setting_public_all:
to_add = True
# store it
Expand All @@ -158,25 +166,28 @@ def page_to_node(page, home, cut):
:param page: the page you wish to transform
:param home: a reference to the "home" page (the page with tree_id=1)
:param cut: Should we cut page from its parent pages? This means the node will not
have a parent anymore.
:param cut: Should we cut page from its parent pages? This means the node
will not have a parent anymore.
"""
# Theses are simple to port over, since they are not calculated.
# Other attributes will be added conditionnally later.
attr = {'soft_root': page.soft_root,
attr = {
'page': page,
'soft_root': page.soft_root,
'auth_required': page.login_required,
'reverse_id': page.reverse_id, }
'reverse_id': page.reverse_id,
}

parent_id = page.parent_id
# Should we cut the Node from its parents?
if home and page.parent_id == home.pk and cut:
parent_id = None

# possible fix for a possible problem
#if parent_id and not page.parent.get_calculated_status():
# if parent_id and not page.parent.get_calculated_status():
# parent_id = None # ????

if page.limit_visibility_in_menu == None:
if page.limit_visibility_in_menu is None:
attr['visible_for_authenticated'] = True
attr['visible_for_anonymous'] = True
else:
Expand All @@ -194,13 +205,21 @@ def page_to_node(page, home, cut):
# but otherwise, just request the title normally
if not hasattr(page, 'title_cache') or lang in page.title_cache:
app_name = page.get_application_urls(fallback=False)
if app_name: # it means it is an apphook
if app_name: # it means it is an apphook
app = apphook_pool.get_apphook(app_name)
for menu in app.menus:
extenders.append(menu.__name__)

if extenders:
attr['navigation_extenders'] = extenders
exts = []
for ext in extenders:
if hasattr(ext, "get_instances"):
# CMSAttachMenus are treated a bit differently to allow them to be
# able to be attached to multiple points in the navigation.
exts.append("{0}:{1}".format(ext, page.pk))
else:
exts.append(ext)
if exts:
attr['navigation_extenders'] = exts

# Do we have a redirectURL?
attr['redirect_url'] = page.get_redirect() # save redirect URL if any
Expand Down Expand Up @@ -266,7 +285,7 @@ def get_nodes(self, request):
langs.extend(get_fallback_languages(lang))

titles = list(get_title_queryset(request).filter(page__in=ids, language__in=langs))
for title in titles: # add the title and slugs and some meta data
for title in titles: # add the title and slugs and some meta data
page = ids[title.page_id]
page.title_cache[title.language] = title

Expand All @@ -292,11 +311,13 @@ def modify(self, request, nodes, namespace, root_id, post_cut, breadcrumb):
extenders = node.attr.get("navigation_extenders", None)
if extenders:
for ext in extenders:
if not ext in exts:
if ext not in exts:
exts.append(ext)
for extnode in nodes:
if extnode.namespace == ext and not extnode.parent_id:# if home has nav extenders but home is not visible
if node.attr.get("is_home", False) and not node.visible:
if extnode.namespace == ext and not extnode.parent_id:
# if home has nav extenders but home is not visible
if (node.attr.get("is_home", False)
and not node.visible):
extnode.parent_id = None
extnode.parent_namespace = None
extnode.parent = None
Expand All @@ -308,50 +329,50 @@ def modify(self, request, nodes, namespace, root_id, post_cut, breadcrumb):
removed = []
# find all not assigned nodes
for menu in menu_pool.menus.items():
if hasattr(menu[1], 'cms_enabled') and menu[1].cms_enabled and not menu[0] in exts:
if (hasattr(menu[1], 'cms_enabled')
and menu[1].cms_enabled and not menu[0] in exts):
for node in nodes:
if node.namespace == menu[0]:
removed.append(node)
if breadcrumb:
# if breadcrumb and home not in navigation add node
# if breadcrumb and home not in navigation add node
if breadcrumb and home and not home.visible:
home.visible = True
if request.path_info == home.get_absolute_url():
home.selected = True
else:
home.selected = False
# remove all nodes that are nav_extenders and not assigned
# remove all nodes that are nav_extenders and not assigned
for node in removed:
nodes.remove(node)
return nodes


menu_pool.register_modifier(NavExtender)


class SoftRootCutter(Modifier):
"""
Ask evildmp/superdmp if you don't understand softroots!
Softroot description from the docs:
A soft root is a page that acts as the root for a menu navigation tree.
Typically, this will be a page that is the root of a significant new
section on your site.
When the soft root feature is enabled, the navigation menu for any page
will start at the nearest soft root, rather than at the real root of
the site’s page hierarchy.
This feature is useful when your site has deep page hierarchies (and
therefore multiple levels in its navigation trees). In such a case, you
usually don’t want to present site visitors with deep menus of nested
items.
For example, you’re on the page -Introduction to Bleeding-?, so the menu
might look like this:
School of Medicine
Medical Education
Departments
Expand All @@ -377,12 +398,12 @@ class SoftRootCutter(Modifier):
Administration
Contact us
Impressum
which is frankly overwhelming.
By making -Department of Mediaeval Surgery-? a soft root, the menu
becomes much more manageable:
Department of Mediaeval Surgery
Theory
Cures
Expand Down
52 changes: 49 additions & 3 deletions cms/menu_bases.py
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,58 @@
# -*- coding: utf-8 -*-
from menus.base import Menu

from __future__ import unicode_literals

from django.db.models import Q
from django.core.exceptions import ValidationError

from cms.apphook_pool import apphook_pool
from cms.models import Page
from menus.base import Menu


class CMSAttachMenu(Menu):
cms_enabled = True
instance = None
name = None

def __init__(self, *args, **kwargs):
super(CMSAttachMenu, self).__init__(*args, **kwargs)
if self.cms_enabled and not self.name:
raise ValidationError("the menu %s is a CMSAttachMenu but has no name defined!" % self.__class__.__name__)
raise ValidationError(
"the menu %s is a CMSAttachMenu but has no name defined!" %
self.__class__.__name__)

@classmethod
def get_apphooks(cls):
"""
Returns a list of apphooks to which this CMSAttachMenu is attached.
Calling this does NOT produce DB queries.
"""
apps = []
for key, _ in apphook_pool.get_apphooks():
app = apphook_pool.get_apphook(key)
if cls in app.menus:
apps.append(app)
return apps

@classmethod
def get_instances(cls):
"""
Return a list (queryset, really) of all CMS Page objects (in this case)
that are currently using this CMSAttachMenu either directly as a
navigation_extender, or, as part of an apphook.
Calling this DOES perform a DB query.
"""
parent_apps = []
for app in cls.get_apphooks():
parent_apps.append(app.__class__.__name__)
return Page.objects.filter(
Q(application_urls__in=parent_apps)
| Q(navigation_extenders=cls.__name__)
)

def get_nodes(self, request):
"""should return a list of NavigationNode instances."""
raise NotImplementedError

0 comments on commit 6ecde67

Please sign in to comment.