-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
/
cms_tags.py
618 lines (566 loc) · 25.3 KB
/
cms_tags.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
from django.conf import settings
from django import template
from django.core.cache import cache
from django.core.mail import send_mail, mail_managers
from django.contrib.sites.models import Site
from django.utils.safestring import mark_safe
from django.utils.translation import ugettext_lazy as _
from cms.exceptions import NoHomeFound
from cms.models import Page
from cms.utils.moderator import get_cmsplugin_queryset, get_page_queryset, get_title_queryset
from cms.utils import get_language_from_request,\
get_extended_navigation_nodes, find_children, \
cut_levels, find_selected, mark_descendants
from cms.utils import navigation
from cms.utils.i18n import get_fallback_languages
register = template.Library()
def get_site_id(site):
if site:
if isinstance(site, Site):
site_id = site.id
elif isinstance(site, int):
site_id = site
else:
site_id = settings.SITE_ID
else:
site_id = settings.SITE_ID
return site_id
def show_menu(context, from_level=0, to_level=100, extra_inactive=0, extra_active=100, template="cms/menu.html", next_page=None, root_id=None):
"""
render a nested list of all children of the pages
from_level: is the start level
to_level: is the max level rendered
render_children: if set to True will render all not direct ascendants too
"""
try:
# If there's an exception (500), default context_processors may not be called.
request = context['request']
except KeyError:
return {'template': 'cms/content.html'}
page_queryset = get_page_queryset(request)
site = Site.objects.get_current()
lang = get_language_from_request(request)
current_page = request.current_page
if current_page == "dummy":
context.update({'children':[],
'template':template,
'from_level':from_level,
'to_level':to_level,
'extra_inactive':extra_inactive,
'extra_active':extra_active})
return context
if hasattr(current_page, "home_pk_cache"):
home_pk = current_page.home_pk_cache
else:
try:
home_pk = page_queryset.get_home(site).pk
except NoHomeFound:
home_pk = 0
if not next_page: #new menu... get all the data so we can save a lot of queries
children = []
ancestors = []
alist = None
if current_page:
alist = current_page.get_ancestors().values_list('id', 'soft_root')
if not alist: # == None:# maybe the active node is in an extender?
alist = []
extenders = page_queryset.published().filter(in_navigation=True,
site=site,
level__lte=to_level)
extenders = extenders.exclude(navigation_extenders__isnull=True).exclude( navigation_extenders__exact="")
for ext in extenders:
ext.childrens = []
ext.ancestors_ascending = []
get_extended_navigation_nodes(request, 100, [ext], ext.level, 100, 100, False, ext.navigation_extenders)
if hasattr(ext, "ancestor"):
alist = list(ext.get_ancestors().values_list('id', 'soft_root'))
alist = [(ext.pk, ext.soft_root)] + alist
break
filters = {'in_navigation' : True,
'site' : site,
'level__lte' : to_level}
#check the ancestors for softroots
soft_root_pk = None
for p in alist:
ancestors.append(p[0])
if p[1]:
soft_root_pk = p[0]
#modify filters if we don't start from the root
root_page = None
if root_id:
try:
root_page = page_queryset.get(reverse_id=root_id, site=site)
except:
send_missing_mail(root_id, request)
else:
if current_page and current_page.soft_root:
root_page = current_page
soft_root_pk = current_page.pk
elif soft_root_pk:
root_page = page_queryset.get(pk=soft_root_pk)
if root_page:
if isinstance(root_page, int):
root_page = page_queryset.get(pk=root_page)
if isinstance(root_page, Page):
root_page = page_queryset.get(pk=root_page.id)
elif isinstance(root_page, unicode):
root_page = page_queryset.get(reverse_id=root_page, site=site)
filters['tree_id'] = root_page.tree_id
filters['lft__gt'] = root_page.lft
filters['rght__lt'] = root_page.rght
filters['level__lte'] = root_page.level + to_level
db_from_level = root_page.level + from_level
else:
db_from_level = from_level
if settings.CMS_HIDE_UNTRANSLATED:
filters['title_set__language'] = lang
if not request.user.is_authenticated():
filters['menu_login_required'] = False
pages = page_queryset.published().filter(**filters).order_by('tree_id',
'parent',
'lft')
pages = list(pages)
if root_page:
pages = [root_page] + pages
all_pages = pages[:]
root_level = getattr(root_page, 'level', None)
ids = []
current = None
for page in pages:# build the tree
if current_page and current_page.pk == page.pk:
current = page
if page.level >= db_from_level:
ids.append(page.pk)
if page.level == 0 or page.level == root_level:
if page.parent_id:
page.get_cached_ancestors()
else:
page.ancestors_ascending = []
page.home_pk_cache = home_pk
page.menu_level = 0 - from_level
page.childrens = []
children.append(page)
if page.pk == soft_root_pk:
page.soft_root = False #ugly hack for the recursive function
if current_page and not current_page.navigation_extenders:
pk = current_page.pk
else:
pk = -1
find_children(page, pages, extra_inactive, extra_active, ancestors, pk, request=request, to_levels=to_level)
if page.pk == soft_root_pk:
page.soft_root = True
if db_from_level > 0:
children = cut_levels(children, db_from_level)
titles = list(get_title_queryset(request).filter(page__in=ids, language=lang))
for page in all_pages:# add the title and slugs and some meta data
for title in titles:
if title.page_id == page.pk:
if not hasattr(page, "title_cache"):
page.title_cache = {}
page.title_cache[title.language] = title
ids.remove(page.pk)
if current_page and page.pk == current_page.pk and not getattr(current, 'ancestor', False):
page.selected = True
if hasattr(page, "childrens"):
mark_descendants(page.childrens)
if page.pk in ancestors:
page.ancestor = True
if current_page and page.parent_id == current_page.parent_id and not page.pk == current_page.pk and not getattr(current, 'ancestor', False):
page.sibling = True
if ids:
fallbacks = get_fallback_languages(lang)
for l in fallbacks:
titles = list(get_title_queryset(request).filter(page__in=ids, language=l))
for page in all_pages:# add the title and slugs and some meta data
for title in titles:
if title.page_id == page.pk:
if not hasattr(page, "title_cache"):
page.title_cache = {}
page.title_cache[title.language] = title
ids.remove(page.pk)
if not ids:
break
children = navigation.handle_navigation_manipulators(children, request)
else:
children = next_page.childrens
context.update({'children':children,
'template':template,
'from_level':from_level,
'to_level':to_level,
'extra_inactive':extra_inactive,
'extra_active':extra_active})
return context
show_menu = register.inclusion_tag('cms/dummy.html', takes_context=True)(show_menu)
def show_menu_below_id(context, root_id=None, from_level=0, to_level=100, extra_inactive=0, extra_active=100, template_file="cms/menu.html", next_page=None):
return show_menu(context, from_level, to_level, extra_inactive, extra_active, template_file, next_page, root_id=root_id)
register.inclusion_tag('cms/dummy.html', takes_context=True)(show_menu_below_id)
def show_sub_menu(context, levels=100, template="cms/sub_menu.html"):
"""Get the root page of the current page and
render a nested list of all root's children pages"""
request = context['request']
page_queryset = get_page_queryset(request)
lang = get_language_from_request(request)
site = Site.objects.get_current()
children = []
page = request.current_page
if page == "dummy":
context.update({'children':[],
'template':template,
'from_level':0,
'to_level':0,
'extra_inactive':0,
'extra_active':0
})
return context
if page:
page.get_cached_ancestors()
# this is not required anymore, sice home_pk_cache is a getter
#if not hasattr(page, "home_pk_cache"):
# page.home_pk_cache = page_queryset.get_home(site).pk
filters = {'in_navigation':True,
'lft__gt':page.lft,
'rght__lt':page.rght,
'tree_id':page.tree_id,
'level__lte':page.level+levels,
'site':site}
if settings.CMS_HIDE_UNTRANSLATED:
filters['title_set__language'] = lang
if not request.user.is_authenticated():
filters['menu_login_required'] = False
pages = page_queryset.published().filter(**filters)
ids = []
pages = list(pages)
all_pages = pages[:]
page.childrens = []
for p in pages:
p.descendant = True
ids.append(p.pk)
page.selected = True
page.menu_level = -1
was_soft_root = False
if page.soft_root:
was_soft_root = True
page.soft_root = False
find_children(page, pages, levels, levels, [], page.pk, request=request)
if was_soft_root:
page.soft_root = True
children = page.childrens
titles = get_title_queryset(request).filter(page__in=ids, language=lang)
for p in all_pages:# add the title and slugs and some meta data
for title in titles:
if title.page_id == p.pk:
if not hasattr(page, "title_cache"):
page.title_cache = {}
page.title_cache[title.language] = title
from_level = page.level
to_level = page.level+levels
extra_active = extra_inactive = levels
else:
extenders = page_queryset.published().filter(in_navigation=True, site=site)
extenders = extenders.exclude(navigation_extenders__isnull=True).exclude(navigation_extenders__exact="")
children = []
from_level = 0
to_level = 0
extra_active = 0
extra_inactive = 0
for ext in extenders:
ext.childrens = []
ext.ancestors_ascending = []
nodes = get_extended_navigation_nodes(request, 100, [ext], ext.level, 100, levels, False, ext.navigation_extenders)
if hasattr(ext, "ancestor"):
selected = find_selected(nodes)
if selected:
children = selected.childrens
from_level = selected.level
to_level = from_level+levels
extra_active = extra_inactive = levels
children = navigation.handle_navigation_manipulators(children, request)
context.update({'children':children,
'template':template,
'from_level':from_level,
'to_level':to_level,
'extra_inactive':extra_inactive,
'extra_active':extra_active})
return context
show_sub_menu = register.inclusion_tag('cms/dummy.html',
takes_context=True)(show_sub_menu)
def show_breadcrumb(context, start_level=0, template="cms/breadcrumb.html"):
request = context['request']
page_queryset = get_page_queryset(request)
title_queryset = get_title_queryset(request)
page = request.current_page
if page == "dummy":
context.update({
'ancestors': [],
'template': template,
})
return context
lang = get_language_from_request(request)
if page and not page.navigation_extenders:
ancestors = ancestors_from_page(page, page_queryset, title_queryset, lang)
else:
site = Site.objects.get_current()
ancestors = []
extenders = page_queryset.published().filter(site=site)
extenders = extenders.exclude(navigation_extenders__isnull=True).exclude(navigation_extenders__exact="")
for ext in extenders:
ext.childrens = []
ext.ancestors_ascending = []
nodes = get_extended_navigation_nodes(request, 100, [ext], ext.level, 100, 0, False, ext.navigation_extenders)
if hasattr(ext, "ancestor"):
selected = find_selected(nodes)
if selected:
ancestors = list(ext.get_ancestors()) + [ext]
home = page_queryset.get_home()
if ancestors and ancestors[0].pk != home.pk:
ancestors = [home] + ancestors
ids = []
for anc in ancestors:
ids.append(anc.pk)
titles = title_queryset.filter(page__in=ids, language=lang)
ancs = []
for anc in ancestors:
anc.home_pk_cache = home.pk
anc.ancestors_ascending = ancs[:]
ancs += [anc]
for title in titles:
if title.page_id == anc.pk:
if not hasattr(anc, "title_cache"):
anc.title_cache = {}
anc.title_cache[title.language] = title
ancestors = ancestors + selected.ancestors_ascending[1:] + [selected]
if not ancestors and page:
ancestors = ancestors_from_page(page, page_queryset, title_queryset, lang)
context.update({'ancestors':ancestors,
'template': template})
return context
show_breadcrumb = register.inclusion_tag('cms/dummy.html',
takes_context=True)(show_breadcrumb)
def ancestors_from_page(page, page_queryset, title_queryset, lang):
ancestors = list(page.get_cached_ancestors(False))
ancestors.append(page)
try:
home = page_queryset.get_home()
except NoHomeFound:
home = None
if ancestors and home and ancestors[0].pk != home.pk:
ancestors = [home] + ancestors
ids = [page.pk]
for anc in ancestors:
ids.append(anc.pk)
titles = title_queryset.filter(page__in=ids, language=lang)
for anc in ancestors:
if home:
anc.home_pk_cache = home.pk
for title in titles:
if title.page_id == anc.pk:
if not hasattr(anc, "title_cache"):
anc.title_cache = {}
anc.title_cache[title.language] = title
for title in titles:
if title.page_id == page.pk:
if not hasattr(page, "title_cache"):
page.title_cache = {}
page.title_cache[title.language] = title
return ancestors
def has_permission(page, request):
return page.has_change_permission(request)
register.filter(has_permission)
def send_missing_mail(reverse_id, request):
site = Site.objects.get_current()
mail_managers(_('Reverse ID not found on %(domain)s') % {'domain':site.domain},
_("A page_id_url template tag didn't found a page with the reverse_id %(reverse_id)s\n"
"The url of the page was: http://%(host)s%(path)s")
% {'reverse_id':reverse_id, 'host':site.domain, 'path':request.path},
fail_silently=True)
def page_id_url(context, reverse_id, lang=None, site=None):
"""
Show the url of a page with a reverse id in the right language
This is mostly used if you want to have a static link in a template to a page
"""
site_id = get_site_id(site)
request = context.get('request', False)
if not request:
return {'content':''}
if request.current_page == "dummy":
return {'content': ''}
if lang is None:
lang = get_language_from_request(request)
key = 'page_id_url_pid:'+str(reverse_id)+'_l:'+str(lang)+'_site:'+str(site_id)+'_type:absolute_url'
url = cache.get(key)
if not url:
try:
page = get_page_queryset(request).get(reverse_id=reverse_id,site=site_id)
url = page.get_absolute_url(language=lang)
cache.set(key, url, settings.CMS_CONTENT_CACHE_DURATION)
except:
send_missing_mail(reverse_id, request)
if url:
return {'content':url}
return {'content':''}
page_id_url = register.inclusion_tag('cms/content.html', takes_context=True)(page_id_url)
def page_language_url(context, lang):
"""
Displays the url of the current page in the defined language.
You can set a language_changer function with the set_language_changer function in the utils.py if there is no page.
This is needed if you have slugs in more than one language.
"""
if not 'request' in context:
return ''
request = context['request']
page = request.current_page
if page == "dummy":
return ''
if hasattr(request, "_language_changer"):
url = "/%s" % lang + request._language_changer(lang)
else:
try:
url = "/%s" % lang + page.get_absolute_url(language=lang, fallback=False)
except:
url = "/%s/" % lang
if url:
return {'content':url}
return {'content':''}
page_language_url = register.inclusion_tag('cms/content.html', takes_context=True)(page_language_url)
def language_chooser(context, template="cms/language_chooser.html"):
"""
Displays a language chooser
"""
if not 'request' in context:
return ''
request = context['request']
languages = settings.LANGUAGES
lang = get_language_from_request(request, request.current_page)
context.update(locals())
return context
language_chooser = register.inclusion_tag('cms/dummy.html', takes_context=True)(language_chooser)
def do_placeholder(parser, token):
error_string = '%r tag requires at least 1 and accepts at most 2 arguments' % token.contents[0]
try:
# split_contents() knows not to split quoted strings.
bits = token.split_contents()
except ValueError:
raise template.TemplateSyntaxError(error_string)
if len(bits) == 2:
#tag_name, name
return PlaceholderNode(bits[1])
elif len(bits) == 3:
#tag_name, name, theme
return PlaceholderNode(bits[1], bits[2])
else:
raise template.TemplateSyntaxError(error_string)
class PlaceholderNode(template.Node):
"""This template node is used to output page content and
is also used in the admin to dynamicaly generate input fields.
eg: {% placeholder content-type-name page-object widget-name %}
Keyword arguments:
name -- the name of the placeholder
theme -- additional theme attribute string which gets added to the context
"""
def __init__(self, name, theme=None):
self.name = "".join(name.lower().split('"'))
self.theme = theme
def render(self, context):
if context.get('display_placeholder_names_only'):
return "<!-- PlaceholderNode: %s -->" % self.name
if not 'request' in context:
return ''
l = get_language_from_request(context['request'])
request = context['request']
page = request.current_page
if page == "dummy":
return ""
plugins = get_cmsplugin_queryset(request).filter(page=page, language=l, placeholder__iexact=self.name, parent__isnull=True).order_by('position').select_related()
if settings.CMS_PLACEHOLDER_CONF and self.name in settings.CMS_PLACEHOLDER_CONF:
if "extra_context" in settings.CMS_PLACEHOLDER_CONF[self.name]:
context.update(settings.CMS_PLACEHOLDER_CONF[self.name]["extra_context"])
if self.theme:
# this may overwrite previously defined key [theme] from settings.CMS_PLACEHOLDER_CONF
context.update({'theme': self.theme,})
c = []
for index, plugin in enumerate(plugins):
context['plugin_index'] = index
c.append(plugin.render_plugin(context, self.name))
return "".join(c)
def __repr__(self):
return "<Placeholder Node: %s>" % self.name
register.tag('placeholder', do_placeholder)
def do_page_attribute(parser, token):
error_string = '%r tag requires one argument' % token.contents[0]
try:
# split_contents() knows not to split quoted strings.
bits = token.split_contents()
except ValueError:
raise template.TemplateSyntaxError(error_string)
if len(bits) == 2:
#tag_name, name
return PageAttributeNode(bits[1])
else:
raise template.TemplateSyntaxError(error_string)
class PageAttributeNode(template.Node):
"""This template node is used to output attribute from page such
as its title and slug.
eg: {% page_attribute field-name %}
Keyword arguments:
field-name -- the name of the field to output. One of "title",
"slug", "meta_description" or "meta_keywords" -- Use without qoutes!
"""
def __init__(self, name):
self.name = name.lower()
def render(self, context):
if not 'request' in context:
return ''
lang = get_language_from_request(context['request'])
request = context['request']
page = request.current_page
if page == "dummy":
return ''
if page and self.name in ["title", "slug", "meta_description", "meta_keywords", "page_title", "menu_title"]:
f = getattr(page, "get_"+self.name)
return f(language=lang, fallback=True)
else:
return ''
def __repr__(self):
return "<PageAttribute Node: %s>" % self.name
register.tag('page_attribute', do_page_attribute)
def clean_admin_list_filter(cl, spec):
"""
used in admin to display only these users that have actually edited a page and not everybody
"""
choices = sorted(list(spec.choices(cl)), key=lambda k: k['query_string'])
query_string = None
unique_choices = []
for choice in choices:
if choice['query_string'] != query_string:
unique_choices.append(choice)
query_string = choice['query_string']
return {'title': spec.title(), 'choices' : unique_choices}
clean_admin_list_filter = register.inclusion_tag('admin/filter.html')(clean_admin_list_filter)
def show_placeholder_by_id(context, placeholder_name, reverse_id, lang=None, site=None):
"""
Show the content of a page with a placeholder name and a reverse id in the right language
This is mostly used if you want to have static content in a template of a page (like a footer)
"""
request = context.get('request', False)
site_id = get_site_id(site)
if not request:
return {'content':''}
if lang is None:
lang = get_language_from_request(request)
key = 'show_placeholder_by_id_pid:'+reverse_id+'_placeholder:'+placeholder_name+'_site:'+str(site_id)+'_l:'+str(lang)
content = cache.get(key)
if not content:
try:
page = get_page_queryset(request).get(reverse_id=reverse_id, site=site_id)
except:
send_missing_mail(reverse_id, request)
return {'content':''}
plugins = get_cmsplugin_queryset(request).filter(page=page, language=lang, placeholder__iexact=placeholder_name, parent__isnull=True).order_by('position').select_related()
content = ""
for plugin in plugins:
content += plugin.render_plugin(context, placeholder_name)
cache.set(key, content, settings.CMS_CONTENT_CACHE_DURATION)
if content:
return {'content':mark_safe(content)}
return {'content':''}
show_placeholder_by_id = register.inclusion_tag('cms/content.html', takes_context=True)(show_placeholder_by_id)