cms.plugin_processors << index >> cms.plugins.file.cms_plugins

cms.plugin_rendering: 108 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/plugin_rendering.py

Stats: 0 executed, 95 missed, 13 excluded, 54 ignored

  1. # -*- coding: utf-8 -*-
  2. from cms.models.placeholdermodel import Placeholder
  3. from cms.plugin_processors import (plugin_meta_context_processor,
  4. mark_safe_plugin_processor)
  5. from cms.utils import get_language_from_request
  6. from cms.utils.django_load import iterload_objects
  7. from cms.utils.placeholder import get_placeholder_conf
  8. from django.conf import settings
  9. from django.template import Template, Context
  10. from django.template.defaultfilters import title
  11. from django.template.loader import render_to_string
  12. from django.utils.translation import ugettext_lazy as _
  14. # these are always called before all other plugin context processors
  15. DEFAULT_PLUGIN_CONTEXT_PROCESSORS = (
  16. plugin_meta_context_processor,
  17. )
  19. # these are always called after all other plugin processors
  20. DEFAULT_PLUGIN_PROCESSORS = (
  21. mark_safe_plugin_processor,
  22. )
  25. class PluginContext(Context):
  26. """
  27. This subclass of template.Context automatically populates itself using
  28. the processors defined in CMS_PLUGIN_CONTEXT_PROCESSORS.
  29. Additional processors can be specified as a list of callables
  30. using the "processors" keyword argument.
  31. """
  32. def __init__(self, dict, instance, placeholder, processors=None, current_app=None):
  33. super(PluginContext, self).__init__(dict, current_app=current_app)
  34. if not processors:
  35. processors = []
  36. for processor in DEFAULT_PLUGIN_CONTEXT_PROCESSORS:
  37. self.update(processor(instance, placeholder))
  38. for processor in iterload_objects(settings.CMS_PLUGIN_CONTEXT_PROCESSORS):
  39. self.update(processor(instance, placeholder))
  40. for processor in processors:
  41. self.update(processor(instance, placeholder))
  43. def render_plugin(context, instance, placeholder, template, processors=None,
  44. current_app=None):
  45. """
  46. Renders a single plugin and applies the post processors to it's rendered
  47. content.
  48. """
  49. if not processors:
  50. processors = []
  51. if isinstance(template, basestring):
  52. content = render_to_string(template, context)
  53. elif isinstance(template, Template):
  54. content = template.render(context)
  55. else:
  56. content = ''
  57. for processor in iterload_objects(settings.CMS_PLUGIN_PROCESSORS):
  58. content = processor(instance, placeholder, content, context)
  59. for processor in processors:
  60. content = processor(instance, placeholder, content, context)
  61. for processor in DEFAULT_PLUGIN_PROCESSORS:
  62. content = processor(instance, placeholder, content, context)
  63. return content
  65. def render_plugins(plugins, context, placeholder, processors=None):
  66. """
  67. Renders a collection of plugins with the given context, using the appropriate processors
  68. for a given placeholder name, and returns a list containing a "rendered content" string
  69. for each plugin.
  71. This is the main plugin rendering utility function, use this function rather than
  72. Plugin.render_plugin().
  73. """
  74. out = []
  75. total = len(plugins)
  76. for index, plugin in enumerate(plugins):
  77. plugin._render_meta.total = total
  78. plugin._render_meta.index = index
  79. context.push()
  80. out.append(plugin.render_plugin(context, placeholder, processors=processors))
  81. context.pop()
  82. return out
  84. def render_placeholder(placeholder, context_to_copy, name_fallback="Placeholder"):
  85. """
  86. Renders plugins for a placeholder on the given page using shallow copies of the
  87. given context, and returns a string containing the rendered output.
  88. """
  89. from cms.plugins.utils import get_plugins
  90. context = context_to_copy
  91. context.push()
  92. request = context['request']
  93. plugins = [plugin for plugin in get_plugins(request, placeholder)]
  94. page = placeholder.page if placeholder else None
  95. if page:
  96. template = page.template
  97. else:
  98. template = None
  99. # Add extra context as defined in settings, but do not overwrite existing context variables,
  100. # since settings are general and database/template are specific
  101. # TODO this should actually happen as a plugin context processor, but these currently overwrite
  102. # existing context -- maybe change this order?
  103. slot = getattr(placeholder, 'slot', None)
  104. extra_context = {}
  105. if slot:
  106. extra_context = get_placeholder_conf("extra_context", slot, template, {})
  107. for key, value in extra_context.items():
  108. if not key in context:
  109. context[key] = value
  111. content = []
  113. # Prepend frontedit toolbar output if applicable
  114. edit = False
  115. toolbar = getattr(request, 'toolbar', None)
  117. if (getattr(toolbar, 'edit_mode', False) and
  118. (not page or page.has_change_permission(request))):
  119. edit = True
  120. if edit:
  121. from cms.middleware.toolbar import toolbar_plugin_processor
  122. processors = (toolbar_plugin_processor,)
  123. else:
  124. processors = None
  126. content.extend(render_plugins(plugins, context, placeholder, processors))
  127. content = "".join(content)
  128. if edit:
  129. content = render_placeholder_toolbar(placeholder, context, content, name_fallback)
  130. context.pop()
  131. return content
  133. def render_placeholder_toolbar(placeholder, context, content, name_fallback=None):
  134. from cms.plugin_pool import plugin_pool
  135. request = context['request']
  136. page = placeholder.page if placeholder else None
  137. if not page:
  138. page = getattr(request, 'current_page', None)
  139. if page:
  140. template = page.template
  141. if name_fallback and not placeholder:
  142. placeholder = Placeholder.objects.create(slot=name_fallback)
  143. page.placeholders.add(placeholder)
  144. placeholder.page = page
  145. else:
  146. template = None
  147. if placeholder:
  148. slot = placeholder.slot
  149. else:
  150. slot = None
  151. installed_plugins = plugin_pool.get_all_plugins(slot, page)
  152. name = get_placeholder_conf("name", slot, template, title(slot))
  153. name = _(name)
  154. context.push()
  155. context['installed_plugins'] = installed_plugins
  156. context['language'] = get_language_from_request(request)
  157. context['placeholder_label'] = name
  158. context['placeholder'] = placeholder
  159. context['page'] = page
  160. toolbar = render_to_string("cms/toolbar/placeholder.html", context)
  161. context.pop()
  162. return "".join([toolbar, content])
cms.plugin_processors << index >> cms.plugins.file.cms_plugins