cms.toolbar.items: 101 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/toolbar/items.py

Stats: 0 executed, 94 missed, 7 excluded, 141 ignored

1. # -*- coding: utf-8 -*-
2. from cms.toolbar.base import BaseItem, Serializable
3. from django.conf import settings
4. from django.core.exceptions import ImproperlyConfigured
5. from django.middleware.csrf import get_token
6. from django.template.context import RequestContext, Context
7. from django.template.loader import render_to_string
8. from django.utils.html import strip_spaces_between_tags
11. class Switcher(BaseItem):
12. """
13. A 'switcher' button, state is defined using GET (and optionally a session
14. entry).
15. """
16. item_type = 'switcher'
17. extra_attributes = [
18. ('add_parameter', 'addParameter'),
19. ('remove_parameter', 'removeParameter'),
20. ('title', 'title'),
21. ]
23. def __init__(self, alignment, css_class_suffix, add_parameter,
24. remove_parameter, title, session_key=None):
25. """
26. add_parameter: parameter which indicates the True state
27. remove_parameter: parameter which indicates the False state
28. title: name of the switcher
29. session_key: key in the session which has a boolean value to indicate
30. the state of this switcher.
31. """
32. super(Switcher, self).__init__(alignment, css_class_suffix)
33. self.add_parameter = add_parameter
34. self.remove_parameter = remove_parameter
35. self.title = title
36. self.session_key = session_key
38. def get_state(self, request):
39. state = self.add_parameter in request.GET
40. if self.session_key and request.session.get(self.session_key, False):
41. return True
42. return state
45. def get_extra_data(self, context, toolbar, **kwargs):
46. return {
47. 'state': self.get_state(toolbar.request)
48. }
51. class Anchor(BaseItem):
52. """
53. A link.
54. """
55. item_type = 'anchor'
56. extra_attributes = [
57. ('url', 'url'),
58. ('title', 'title'),
59. ]
61. def __init__(self, alignment, css_class_suffix, title, url):
62. """
63. title: Name of the link
64. url: Target of the link
65. """
66. super(Anchor, self).__init__(alignment, css_class_suffix)
67. self.title = title
68. if callable(url):
69. self.serialize_url = url
70. else:
71. self.url = url
74. class HTML(BaseItem):
75. """
76. HTML item, can do whatever it want
77. """
78. item_type = 'html'
79. extra_attributes = [
80. ('html', 'html'),
81. ]
83. def __init__(self, alignment, css_class_suffix, html):
84. """
85. html: The HTML to render.
86. """
87. super(HTML, self).__init__(alignment, css_class_suffix)
88. self.html = html
91. class TemplateHTML(BaseItem):
92. """
93. Same as HTML, but renders a template to generate the HTML.
94. """
95. item_type = 'html'
97. def __init__(self, alignment, css_class_suffix, template):
98. """
99. template: the template to render
100. """
101. super(TemplateHTML, self).__init__(alignment, css_class_suffix)
102. self.template = template
104. def get_extra_data(self, context, toolbar, **kwargs):
105. new_context = RequestContext(toolbar.request)
106. rendered = render_to_string(self.template, new_context)
107. stripped = strip_spaces_between_tags(rendered.strip())
108. return {
109. 'html': stripped,
110. }
113. class GetButton(BaseItem):
114. """
115. A button which triggers a GET request
116. """
117. item_type = 'button'
118. extra_attributes = [
119. ('title', 'title'),
120. ('icon', 'icon'),
121. ('url', 'redirect'),
122. ]
124. def __init__(self, alignment, css_class_suffix, title, url, icon=None):
125. """
126. title: name of the button
127. icon: icon of the button, relative to STATIC_URL
128. url: target of the GET request
129. """
130. super(GetButton, self).__init__(alignment, css_class_suffix)
131. self.icon = icon
132. self.title = title
133. if callable(url):
134. self.serialize_url = url
135. else:
136. self.url = url
139. class PostButton(BaseItem):
140. """
141. A button which triggers a POST request
142. """
143. item_type = 'button'
144. extra_attributes = [
145. ('title', 'title'),
146. ('icon', 'icon'),
147. ('action', 'action'),
148. ]
150. def __init__(self, alignment, css_class_suffix, title, icon, action, *args, **kwargs):
151. """
152. title: name of the button
153. icon: icon of the button, relative to STATIC_URL
154. action: target of the request
155. *args, **kwargs: data to POST
157. A csrfmiddlewaretoken is always injected into the request.
158. """
159. super(PostButton, self).__init__(alignment, css_class_suffix)
160. self.title = title
161. self.icon = icon
162. self.action = action
163. self.args = args
164. self.kwargs = kwargs
166. def get_extra_data(self, context, toolbar, **kwargs):
167. double = self.kwargs.copy()
168. double['csrfmiddlewaretoken'] = get_token(toolbar.request)
169. hidden = render_to_string('cms/toolbar/items/_post_button_hidden.html',
170. Context({'single': self.args,
171. 'double': double}))
172. return {
173. 'hidden': hidden,
174. }
177. class ListItem(Serializable):
178. """
179. A item in a dropdown list (List).
180. """
181. base_attributes = [
182. ('css_class', 'cls'),
183. ('title', 'title'),
184. ('url', 'url'),
185. ('icon', 'icon'),
186. ('method', 'method'),
187. ]
188. extra_attributes = []
190. def __init__(self, css_class_suffix, title, url, method='GET', icon=None):
191. """
192. title: name of the list
193. url: target of the item
194. icon: icon of the item, relative to STATIC_URL
195. """
196. self.css_class_suffix = css_class_suffix
197. self.css_class = 'cms_toolbar-item_%s' % self.css_class_suffix
198. self.title = title
199. self.method = method
200. self.icon = icon
201. if callable(url):
202. self.serialize_url = url
203. else:
204. self.url = url
207. class List(BaseItem):
208. """
209. A dropdown list
210. """
211. item_type = 'list'
212. extra_attributes = [
213. ('title', 'title'),
214. ('icon', 'icon'),
215. ]
217. def __init__(self, alignment, css_class_suffix, title, icon, items):
218. """
219. title: name of the item
220. icon: icon of the item, relative to STATIC_URL
221. items: an iterable of ListItem instances.
222. """
223. super(List, self).__init__(alignment, css_class_suffix)
224. self.title = title
225. self.icon = icon
226. self.validate_items(items)
227. self.raw_items = items
229. def validate_items(self, items):
230. for item in items:
231. if not isinstance(item, ListItem):
232. raise ImproperlyConfigured(
233. 'Only ListItem instances are allowed to be used inside of '
234. 'List instances'
235. )
237. def get_extra_data(self, context, **kwargs):
238. items = [item.serialize(context, **kwargs)
239. for item in self.raw_items]
240. return {
241. 'items': items
242. }