cms.templatetags.cms_tags: 255 total statements, 0.0% covered

Generated: Wed 2013-03-13 10:33 CET

Source file: /media/Envs/Envs/filer-gallery/lib/python2.7/site-packages/cms/templatetags/cms_tags.py

Stats: 0 executed, 233 missed, 22 excluded, 180 ignored

  1. # -*- coding: utf-8 -*-
  2. from classytags.arguments import Argument, MultiValueArgument
  3. from classytags.core import Options, Tag
  4. from classytags.helpers import InclusionTag, AsTag
  5. from classytags.parser import Parser
  6. from cms.models import Page, Placeholder as PlaceholderModel
  7. from cms.plugin_rendering import render_plugins, render_placeholder
  8. from cms.plugins.utils import get_plugins, assign_plugins
  9. from cms.utils import get_language_from_request
  10. from cms.utils.moderator import get_cmsplugin_queryset, get_page_queryset
  11. from cms.utils.placeholder import validate_placeholder_name
  12. from django import template
  13. from django.conf import settings
  14. from django.contrib.sites.models import Site
  15. from django.core.cache import cache
  16. from django.core.mail import mail_managers
  17. from django.utils.html import escape
  18. from django.utils.safestring import mark_safe
  19. from django.utils.translation import ugettext_lazy as _, get_language
  20. from itertools import chain
  21. import re
  22. register = template.Library()
  23. def get_site_id(site):
  24. if site:
  25. if isinstance(site, Site):
  26. site_id = site.id
  27. elif isinstance(site, int) or (isinstance(site, basestring) and site.isdigit()):
  28. site_id = int(site)
  29. else:
  30. site_id = settings.SITE_ID
  31. else:
  32. site_id = settings.SITE_ID
  33. return site_id
  34. def has_permission(page, request):
  35. return page.has_change_permission(request)
  36. register.filter(has_permission)
  37. CLEAN_KEY_PATTERN = re.compile(r'[^a-zA-Z0-9_-]')
  38. def _clean_key(key):
  39. return CLEAN_KEY_PATTERN.sub('-', key)
  40. def _get_cache_key(name, page_lookup, lang, site_id):
  41. if isinstance(page_lookup, Page):
  42. page_key = str(page_lookup.pk)
  43. else:
  44. page_key = str(page_lookup)
  45. page_key = _clean_key(page_key)
  46. return name+'__page_lookup:'+page_key+'_site:'+str(site_id)+'_lang:'+str(lang)
  47. def _get_page_by_untyped_arg(page_lookup, request, site_id):
  48. """
  49. The `page_lookup` argument can be of any of the following types:
  50. - Integer: interpreted as `pk` of the desired page
  51. - String: interpreted as `reverse_id` of the desired page
  52. - `dict`: a dictionary containing keyword arguments to find the desired page
  53. (for instance: `{'pk': 1}`)
  54. - `Page`: you can also pass a Page object directly, in which case there will be no database lookup.
  55. - `None`: the current page will be used
  56. """
  57. if page_lookup is None:
  58. return request.current_page
  59. if isinstance(page_lookup, Page):
  60. return page_lookup
  61. if isinstance(page_lookup, basestring):
  62. page_lookup = {'reverse_id': page_lookup}
  63. elif isinstance(page_lookup, (int, long)):
  64. page_lookup = {'pk': page_lookup}
  65. elif not isinstance(page_lookup, dict):
  66. raise TypeError('The page_lookup argument can be either a Dictionary, Integer, Page, or String.')
  67. page_lookup.update({'site': site_id})
  68. try:
  69. return get_page_queryset(request).get(**page_lookup)
  70. except Page.DoesNotExist:
  71. site = Site.objects.get_current()
  72. subject = _('Page not found on %(domain)s') % {'domain':site.domain}
  73. body = _("A template tag couldn't find the page with lookup arguments `%(page_lookup)s\n`. "
  74. "The URL of the request was: http://%(host)s%(path)s") \
  75. % {'page_lookup': repr(page_lookup), 'host': site.domain, 'path': request.path}
  76. if settings.DEBUG:
  77. raise Page.DoesNotExist(body)
  78. else:
  79. if settings.SEND_BROKEN_LINK_EMAILS:
  80. mail_managers(subject, body, fail_silently=True)
  81. return None
  82. class PageUrl(InclusionTag):
  83. template = 'cms/content.html'
  84. name = 'page_url'
  85. options = Options(
  86. Argument('page_lookup'),
  87. Argument('lang', required=False, default=None),
  88. Argument('site', required=False, default=None),
  89. )
  90. def get_context(self, context, page_lookup, lang, site):
  91. site_id = get_site_id(site)
  92. request = context.get('request', False)
  93. if not request:
  94. return {'content': ''}
  95. if request.current_page == "dummy":
  96. return {'content': ''}
  97. if lang is None:
  98. lang = get_language_from_request(request)
  99. cache_key = _get_cache_key('page_url', page_lookup, lang, site_id)+'_type:absolute_url'
  100. url = cache.get(cache_key)
  101. if not url:
  102. page = _get_page_by_untyped_arg(page_lookup, request, site_id)
  103. if page:
  104. url = page.get_absolute_url(language=lang)
  105. cache.set(cache_key, url, settings.CMS_CACHE_DURATIONS['content'])
  106. if url:
  107. return {'content': url}
  108. return {'content': ''}
  109. register.tag(PageUrl)
  110. register.tag('page_id_url', PageUrl)
  111. def _get_placeholder(current_page, page, context, name):
  112. from cms.utils.plugins import get_placeholders
  113. placeholder_cache = getattr(current_page, '_tmp_placeholders_cache', {})
  114. if page.pk in placeholder_cache:
  115. return placeholder_cache[page.pk].get(name, None)
  116. placeholder_cache[page.pk] = {}
  117. slots = get_placeholders(page.get_template())
  118. placeholders = page.placeholders.filter(slot__in=slots)
  119. assign_plugins(context['request'], placeholders, get_language())
  120. for placeholder in placeholders:
  121. placeholder_cache[page.pk][placeholder.slot] = placeholder
  122. placeholder.page = page
  123. current_page._tmp_placeholders_cache = placeholder_cache
  124. return placeholder_cache[page.pk].get(name, None)
  125. def get_placeholder_content(context, request, current_page, name, inherit):
  126. edit_mode = getattr(request, 'toolbar', None) and getattr(request.toolbar, 'edit_mode')
  127. pages = [current_page]
  128. # don't display inherited plugins in edit mode, so that the user doesn't
  129. # mistakenly edit/delete them. This is a fix for issue #1303. See the discussion
  130. # there for possible enhancements
  131. if inherit and not edit_mode:
  132. pages = chain([current_page], current_page.get_cached_ancestors(ascending=True))
  133. for page in pages:
  134. placeholder = _get_placeholder(current_page, page, context, name)
  135. if placeholder is None:
  136. continue
  137. if not get_plugins(request, placeholder):
  138. continue
  139. content = render_placeholder(placeholder, context, name)
  140. if content:
  141. return content
  142. # if we reach this point, we have an empty or non-existant placeholder
  143. # call _get_placeholder again to get the placeholder properly rendered
  144. # in frontend editing
  145. placeholder = _get_placeholder(current_page, current_page, context, name)
  146. return render_placeholder(placeholder, context, name)
  147. class PlaceholderParser(Parser):
  148. def parse_blocks(self):
  149. for bit in getattr(self.kwargs['extra_bits'], 'value', self.kwargs['extra_bits']):
  150. if getattr(bit, 'value', bit.var.value) == 'or':
  151. return super(PlaceholderParser, self).parse_blocks()
  152. return
  153. class PlaceholderOptions(Options):
  154. def get_parser_class(self):
  155. return PlaceholderParser
  156. class Placeholder(Tag):
  157. """
  158. This template node is used to output page content and
  159. is also used in the admin to dynamically generate input fields.
  160. eg: {% placeholder "placeholder_name" %}
  161. {% placeholder "sidebar" inherit %}
  162. {% placeholder "footer" inherit or %}
  163. <a href="/about/">About us</a>
  164. {% endplaceholder %}
  165. Keyword arguments:
  166. name -- the name of the placeholder
  167. width -- additional width attribute (integer) which gets added to the plugin context
  168. (deprecated, use `{% with 320 as width %}{% placeholder "foo"}{% endwith %}`)
  169. inherit -- optional argument which if given will result in inheriting
  170. the content of the placeholder with the same name on parent pages
  171. or -- optional argument which if given will make the template tag a block
  172. tag whose content is shown if the placeholder is empty
  173. """
  174. name = 'placeholder'
  175. options = PlaceholderOptions(
  176. Argument('name', resolve=False),
  177. MultiValueArgument('extra_bits', required=False, resolve=False),
  178. blocks=[
  179. ('endplaceholder', 'nodelist'),
  180. ]
  181. )
  182. def render_tag(self, context, name, extra_bits, nodelist=None):
  183. validate_placeholder_name(name)
  184. width = None
  185. inherit = False
  186. for bit in extra_bits:
  187. if bit == 'inherit':
  188. inherit = True
  189. elif bit.isdigit():
  190. width = int(bit)
  191. import warnings
  192. warnings.warn(
  193. "The width parameter for the placeholder tag is deprecated.",
  194. DeprecationWarning
  195. )
  196. if not 'request' in context:
  197. return ''
  198. request = context['request']
  199. if width:
  200. context.update({'width': width})
  201. page = request.current_page
  202. if not page or page == 'dummy':
  203. if nodelist:
  204. return nodelist.render(context)
  205. return ''
  206. content = get_placeholder_content(context, request, page, name, inherit)
  207. if not content and nodelist:
  208. return nodelist.render(context)
  209. return content
  210. def get_name(self):
  211. return self.kwargs['name'].var.value.strip('"').strip("'")
  212. register.tag(Placeholder)
  213. class PageAttribute(AsTag):
  214. """
  215. This template node is used to output attribute from a page such
  216. as its title or slug.
  217. Synopsis
  218. {% page_attribute "field-name" %}
  219. {% page_attribute "field-name" as varname %}
  220. {% page_attribute "field-name" page_lookup %}
  221. {% page_attribute "field-name" page_lookup as varname %}
  222. Example
  223. {# Output current page's page_title attribute: #}
  224. {% page_attribute "page_title" %}
  225. {# Output page_title attribute of the page with reverse_id "the_page": #}
  226. {% page_attribute "page_title" "the_page" %}
  227. {# Output slug attribute of the page with pk 10: #}
  228. {% page_attribute "slug" 10 %}
  229. {# Assign page_title attribute to a variable: #}
  230. {% page_attribute "page_title" as title %}
  231. Keyword arguments:
  232. field-name -- the name of the field to output. Use one of:
  233. - title
  234. - menu_title
  235. - page_title
  236. - slug
  237. - meta_description
  238. - meta_keywords
  239. page_lookup -- lookup argument for Page, if omitted field-name of current page is returned.
  240. See _get_page_by_untyped_arg() for detailed information on the allowed types and their interpretation
  241. for the page_lookup argument.
  242. varname -- context variable name. Output will be added to template context as this variable.
  243. This argument is required to follow the 'as' keyword.
  244. """
  245. name = 'page_attribute'
  246. options = Options(
  247. Argument('name', resolve=False),
  248. Argument('page_lookup', required=False, default=None),
  249. 'as',
  250. Argument('varname', required=False, resolve=False)
  251. )
  252. valid_attributes = [
  253. "title",
  254. "slug",
  255. "meta_description",
  256. "meta_keywords",
  257. "page_title",
  258. "menu_title"
  259. ]
  260. def get_value(self, context, name, page_lookup):
  261. if not 'request' in context:
  262. return ''
  263. name = name.lower()
  264. request = context['request']
  265. lang = get_language_from_request(request)
  266. page = _get_page_by_untyped_arg(page_lookup, request, get_site_id(None))
  267. if page == "dummy":
  268. return ''
  269. if page and name in self.valid_attributes:
  270. func = getattr(page, "get_%s" % name)
  271. return escape(func(language=lang, fallback=True))
  272. return ''
  273. register.tag(PageAttribute)
  274. class CleanAdminListFilter(InclusionTag):
  275. template = 'admin/filter.html'
  276. name = 'clean_admin_list_filter'
  277. options = Options(
  278. Argument('cl'),
  279. Argument('spec'),
  280. )
  281. def get_context(self, context, cl, spec):
  282. choices = sorted(list(spec.choices(cl)), key=lambda k: k['query_string'])
  283. query_string = None
  284. unique_choices = []
  285. for choice in choices:
  286. if choice['query_string'] != query_string:
  287. unique_choices.append(choice)
  288. query_string = choice['query_string']
  289. return {'title': spec.title(), 'choices' : unique_choices}
  290. def _show_placeholder_for_page(context, placeholder_name, page_lookup, lang=None,
  291. site=None, cache_result=True):
  292. """
  293. Shows the content of a page with a placeholder name and given lookup
  294. arguments in the given language.
  295. This is useful if you want to have some more or less static content that is
  296. shared among many pages, such as a footer.
  297. See _get_page_by_untyped_arg() for detailed information on the allowed types
  298. and their interpretation for the page_lookup argument.
  299. """
  300. validate_placeholder_name(placeholder_name)
  301. request = context.get('request', False)
  302. site_id = get_site_id(site)
  303. if not request:
  304. return {'content': ''}
  305. if lang is None:
  306. lang = get_language_from_request(request)
  307. content = None
  308. if cache_result:
  309. base_key = _get_cache_key('_show_placeholder_for_page', page_lookup, lang, site_id)
  310. cache_key = _clean_key('%s_placeholder:%s' % (base_key, placeholder_name))
  311. content = cache.get(cache_key)
  312. if not content:
  313. page = _get_page_by_untyped_arg(page_lookup, request, site_id)
  314. if not page:
  315. return {'content': ''}
  316. try:
  317. placeholder = page.placeholders.get(slot=placeholder_name)
  318. except PlaceholderModel.DoesNotExist:
  319. if settings.DEBUG:
  320. raise
  321. return {'content': ''}
  322. content = render_placeholder(placeholder, context, placeholder_name)
  323. if cache_result:
  324. cache.set(cache_key, content, settings.CMS_CACHE_DURATIONS['content'])
  325. if content:
  326. return {'content': mark_safe(content)}
  327. return {'content': ''}
  328. class ShowPlaceholderById(InclusionTag):
  329. template = 'cms/content.html'
  330. name = 'show_placeholder_by_id'
  331. options = Options(
  332. Argument('placeholder_name'),
  333. Argument('reverse_id'),
  334. Argument('lang', required=False, default=None),
  335. Argument('site', required=False, default=None),
  336. )
  337. def get_context(self, *args, **kwargs):
  338. return _show_placeholder_for_page(**self.get_kwargs(*args, **kwargs))
  339. def get_kwargs(self, context, placeholder_name, reverse_id, lang, site):
  340. return {
  341. 'context': context,
  342. 'placeholder_name': placeholder_name,
  343. 'page_lookup': reverse_id,
  344. 'lang': lang,
  345. 'site': site
  346. }
  347. register.tag(ShowPlaceholderById)
  348. register.tag('show_placeholder', ShowPlaceholderById)
  349. class ShowUncachedPlaceholderById(ShowPlaceholderById):
  350. name = 'show_uncached_placeholder_by_id'
  351. def get_kwargs(self, *args, **kwargs):
  352. kwargs = super(ShowUncachedPlaceholderById, self).get_kwargs(*args, **kwargs)
  353. kwargs['cache_result'] = False
  354. return kwargs
  355. register.tag(ShowUncachedPlaceholderById)
  356. register.tag('show_uncached_placeholder', ShowUncachedPlaceholderById)
  357. class CMSToolbar(InclusionTag):
  358. template = 'cms/toolbar/toolbar.html'
  359. name = 'cms_toolbar'
  360. def render(self, context):
  361. request = context.get('request', None)
  362. if not request:
  363. return ''
  364. toolbar = getattr(request, 'toolbar', None)
  365. if not toolbar:
  366. return ''
  367. if not toolbar.show_toolbar:
  368. return ''
  369. return super(CMSToolbar, self).render(context)
  370. def get_context(self, context):
  371. context['CMS_TOOLBAR_CONFIG'] = context['request'].toolbar.as_json(context)
  372. return context
  373. register.tag(CMSToolbar)