cms.utils.plugins: 100 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/utils/plugins.py

Stats: 0 executed, 89 missed, 11 excluded, 44 ignored

1. # -*- coding: utf-8 -*-
2. from cms.exceptions import DuplicatePlaceholderWarning
3. from cms.models import Page
4. from cms.templatetags.cms_tags import Placeholder
5. from cms.utils.placeholder import validate_placeholder_name
6. from django.contrib.sites.models import Site
7. from django.shortcuts import get_object_or_404
8. from django.template import (NodeList, TextNode, VariableNode,
9. TemplateSyntaxError)
10. from django.template.loader import get_template
11. from django.template.loader_tags import (ConstantIncludeNode, ExtendsNode,
12. BlockNode)
13. import warnings
14. from sekizai.helpers import is_variable_extend_node
16. def get_page_from_plugin_or_404(cms_plugin):
17. return get_object_or_404(Page, placeholders=cms_plugin.placeholder)
19. def _extend_blocks(extend_node, blocks):
20. """
21. Extends the dictionary `blocks` with *new* blocks in the parent node (recursive)
22. """
23. # we don't support variable extensions
24. if is_variable_extend_node(extend_node):
25. return
26. parent = extend_node.get_parent(None)
27. # Search for new blocks
28. for node in parent.nodelist.get_nodes_by_type(BlockNode):
29. if not node.name in blocks:
30. blocks[node.name] = node
31. else:
32. # set this node as the super node (for {{ block.super }})
33. block = blocks[node.name]
34. seen_supers = []
35. while hasattr(block.super, 'nodelist') and block.super not in seen_supers:
36. seen_supers.append(block.super)
37. block = block.super
38. block.super = node
39. # search for further ExtendsNodes
40. for node in parent.nodelist.get_nodes_by_type(ExtendsNode):
41. _extend_blocks(node, blocks)
42. break
44. def _find_topmost_template(extend_node):
45. parent_template = extend_node.get_parent({})
46. for node in parent_template.nodelist.get_nodes_by_type(ExtendsNode):
47. # Their can only be one extend block in a template, otherwise django raises an exception
48. return _find_topmost_template(node)
49. # No ExtendsNode
50. return extend_node.get_parent({})
52. def _extend_nodelist(extend_node):
53. """
54. Returns a list of placeholders found in the parent template(s) of this
55. ExtendsNode
56. """
57. # we don't support variable extensions
58. if is_variable_extend_node(extend_node):
59. return []
60. blocks = extend_node.blocks
61. _extend_blocks(extend_node, blocks)
62. placeholders = []
64. for block in blocks.values():
65. placeholders += _scan_placeholders(block.nodelist, block, blocks.keys())
67. # Scan topmost template for placeholder outside of blocks
68. parent_template = _find_topmost_template(extend_node)
69. placeholders += _scan_placeholders(parent_template.nodelist, None, blocks.keys())
70. return placeholders
72. def _scan_placeholders(nodelist, current_block=None, ignore_blocks=None):
73. placeholders = []
74. if ignore_blocks is None:
75. ignore_blocks = []
77. for node in nodelist:
78. # check if this is a placeholder first
79. if isinstance(node, Placeholder):
80. placeholders.append(node.get_name())
81. # if it's a Constant Include Node ({% include "template_name.html" %})
82. # scan the child template
83. elif isinstance(node, ConstantIncludeNode):
84. # if there's an error in the to-be-included template, node.template becomes None
85. if node.template:
86. placeholders += _scan_placeholders(node.template.nodelist, current_block)
87. # handle {% extends ... %} tags
88. elif isinstance(node, ExtendsNode):
89. placeholders += _extend_nodelist(node)
90. # in block nodes we have to scan for super blocks
91. elif isinstance(node, VariableNode) and current_block:
92. if node.filter_expression.token == 'block.super':
93. if not hasattr(current_block.super, 'nodelist'):
94. raise TemplateSyntaxError("Cannot render block.super for blocks without a parent.")
95. placeholders += _scan_placeholders(current_block.super.nodelist, current_block.super)
96. # ignore nested blocks which are already handled
97. elif isinstance(node, BlockNode) and node.name in ignore_blocks:
98. continue
99. # if the node has the newly introduced 'child_nodelists' attribute, scan
100. # those attributes for nodelists and recurse them
101. elif hasattr(node, 'child_nodelists'):
102. for nodelist_name in node.child_nodelists:
103. if hasattr(node, nodelist_name):
104. subnodelist = getattr(node, nodelist_name)
105. if isinstance(subnodelist, NodeList):
106. if isinstance(node, BlockNode):
107. current_block = node
108. placeholders += _scan_placeholders(subnodelist, current_block)
109. # else just scan the node for nodelist instance attributes
110. else:
111. for attr in dir(node):
112. obj = getattr(node, attr)
113. if isinstance(obj, NodeList):
114. if isinstance(node, BlockNode):
115. current_block = node
116. placeholders += _scan_placeholders(obj, current_block)
117. return placeholders
119. def get_placeholders(template):
120. compiled_template = get_template(template)
121. placeholders = _scan_placeholders(compiled_template.nodelist)
122. clean_placeholders = []
123. for placeholder in placeholders:
124. if placeholder in clean_placeholders:
125. warnings.warn("Duplicate placeholder found: `%s`" % placeholder, DuplicatePlaceholderWarning)
126. else:
127. validate_placeholder_name(placeholder)
128. clean_placeholders.append(placeholder)
129. return clean_placeholders
131. SITE_VAR = "site__exact"
133. def current_site(request):
134. if SITE_VAR in request.REQUEST:
135. return Site.objects.get(pk=request.REQUEST[SITE_VAR])
136. else:
137. site_pk = request.session.get('cms_admin_site', None)
138. if site_pk:
139. try:
140. return Site.objects.get(pk=site_pk)
141. except Site.DoesNotExist:
142. return None
143. else:
144. return Site.objects.get_current()