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

Stats: 0 executed, 89 missed, 12 excluded, 125 ignored

  1. # -*- coding: utf-8 -*-
  2. from cms.exceptions import SubClassNeededError, Deprecated
  3. from cms.models import CMSPlugin
  4. from django import forms
  5. from django.conf import settings
  6. from django.contrib import admin
  7. from django.core.exceptions import ImproperlyConfigured
  8. from django.db.models.options import get_verbose_name
  9. from django.forms.models import ModelForm
  10. from django.utils.encoding import smart_str
  11. from django.utils.translation import ugettext_lazy as _
  12. class CMSPluginBaseMetaclass(forms.MediaDefiningClass):
  13. """
  14. Ensure the CMSPlugin subclasses have sane values and set some defaults if
  15. they're not given.
  16. """
  17. def __new__(cls, name, bases, attrs):
  18. super_new = super(CMSPluginBaseMetaclass, cls).__new__
  19. parents = [base for base in bases if isinstance(base, CMSPluginBaseMetaclass)]
  20. if not parents:
  21. # If this is CMSPluginBase itself, and not a subclass, don't do anything
  22. return super_new(cls, name, bases, attrs)
  23. new_plugin = super_new(cls, name, bases, attrs)
  24. # validate model is actually a CMSPlugin subclass.
  25. if not issubclass(new_plugin.model, CMSPlugin):
  26. raise SubClassNeededError(
  27. "The 'model' attribute on CMSPluginBase subclasses must be "
  28. "either CMSPlugin or a subclass of CMSPlugin. %r on %r is not."
  29. % (new_plugin.model, new_plugin)
  30. )
  31. # validate the template:
  32. if not hasattr(new_plugin, 'render_template'):
  33. raise ImproperlyConfigured(
  34. "CMSPluginBase subclasses must have a render_template attribute"
  35. )
  36. # Set the default form
  37. if not new_plugin.form:
  38. form_meta_attrs = {
  39. 'model': new_plugin.model,
  40. 'exclude': ('position', 'placeholder', 'language', 'plugin_type')
  41. }
  42. form_attrs = {
  43. 'Meta': type('Meta', (object,), form_meta_attrs)
  44. }
  45. new_plugin.form = type('%sForm' % name, (ModelForm,), form_attrs)
  46. # Set the default fieldsets
  47. if not new_plugin.fieldsets:
  48. basic_fields = []
  49. advanced_fields = []
  50. for f in new_plugin.model._meta.fields:
  51. if not f.auto_created and f.editable:
  52. if hasattr(f,'advanced'):
  53. advanced_fields.append(f.name)
  54. else: basic_fields.append(f.name)
  55. if advanced_fields:
  56. new_plugin.fieldsets = [
  57. (
  58. None,
  59. {
  60. 'fields': basic_fields
  61. }
  62. ),
  63. (
  64. _('Advanced options'),
  65. {
  66. 'fields' : advanced_fields,
  67. 'classes' : ('collapse',)
  68. }
  69. )
  70. ]
  71. # Set default name
  72. if not new_plugin.name:
  73. new_plugin.name = get_verbose_name(new_plugin.__name__)
  74. return new_plugin
  75. class CMSPluginBase(admin.ModelAdmin):
  76. __metaclass__ = CMSPluginBaseMetaclass
  77. name = ""
  78. form = None
  79. change_form_template = "admin/cms/page/plugin_change_form.html"
  80. # Should the plugin be rendered in the admin?
  81. admin_preview = True
  82. render_template = None
  83. # Should the plugin be rendered at all, or doesn't it have any output?
  84. render_plugin = True
  85. model = CMSPlugin
  86. text_enabled = False
  87. page_only = False
  88. opts = {}
  89. module = None #track in which module/application belongs
  90. def __init__(self, model=None, admin_site=None):
  91. if admin_site:
  92. super(CMSPluginBase, self).__init__(self.model, admin_site)
  93. self.object_successfully_changed = False
  94. # variables will be overwritten in edit_view, so we got required
  95. self.cms_plugin_instance = None
  96. self.placeholder = None
  97. self.page = None
  98. def render(self, context, instance, placeholder):
  99. raise NotImplementedError("render needs to be implemented")
  100. @property
  101. def parent(self):
  102. return self.cms_plugin_instance.parent
  103. def render_change_form(self, request, context, add=False, change=False, form_url='', obj=None):
  104. """
  105. We just need the popup interface here
  106. """
  107. context.update({
  108. 'preview': not "no_preview" in request.GET,
  109. 'is_popup': True,
  110. 'plugin': self.cms_plugin_instance,
  111. 'CMS_MEDIA_URL': settings.CMS_MEDIA_URL,
  112. })
  113. return super(CMSPluginBase, self).render_change_form(request, context, add, change, form_url, obj)
  114. def has_add_permission(self, request, *args, **kwargs):
  115. """Permission handling change - if user is allowed to change the page
  116. he must be also allowed to add/change/delete plugins..
  117. Not sure if there will be plugin permission requirement in future, but
  118. if, then this must be changed.
  119. """
  120. return self.cms_plugin_instance.has_change_permission(request)
  121. has_delete_permission = has_change_permission = has_add_permission
  122. def save_model(self, request, obj, form, change):
  123. """
  124. Override original method, and add some attributes to obj
  125. This have to be made, because if object is newly created, he must know
  126. where he lives.
  127. Attributes from cms_plugin_instance have to be assigned to object, if
  128. is cms_plugin_instance attribute available.
  129. """
  130. if getattr(self, "cms_plugin_instance"):
  131. # assign stuff to object
  132. fields = self.cms_plugin_instance._meta.fields
  133. for field in fields:
  134. # assign all the fields - we can do this, because object is
  135. # subclassing cms_plugin_instance (one to one relation)
  136. value = getattr(self.cms_plugin_instance, field.name)
  137. setattr(obj, field.name, value)
  138. # remember the saved object
  139. self.saved_object = obj
  140. return super(CMSPluginBase, self).save_model(request, obj, form, change)
  141. def response_change(self, request, obj):
  142. """
  143. Just set a flag, so we know something was changed, and can make
  144. new version if reversion installed.
  145. New version will be created in admin.views.edit_plugin
  146. """
  147. self.object_successfully_changed = True
  148. return super(CMSPluginBase, self).response_change(request, obj)
  149. def response_add(self, request, obj):
  150. """
  151. Just set a flag, so we know something was changed, and can make
  152. new version if reversion installed.
  153. New version will be created in admin.views.edit_plugin
  154. """
  155. self.object_successfully_changed = True
  156. return super(CMSPluginBase, self).response_add(request, obj)
  157. def log_addition(self, request, object):
  158. pass
  159. def log_change(self, request, object, message):
  160. pass
  161. def log_deletion(self, request, object, object_repr):
  162. pass
  163. def icon_src(self, instance):
  164. """
  165. Overwrite this if text_enabled = True
  166. Return the URL for an image to be used for an icon for this
  167. plugin instance in a text editor.
  168. """
  169. return ""
  170. def icon_alt(self, instance):
  171. """
  172. Overwrite this if necessary if text_enabled = True
  173. Return the 'alt' text to be used for an icon representing
  174. the plugin object in a text editor.
  175. """
  176. return "%s - %s" % (unicode(self.name), unicode(instance))
  177. def __repr__(self):
  178. return smart_str(self.name)
  179. def __unicode__(self):
  180. return self.name
  181. #===========================================================================
  182. # Deprecated APIs
  183. #===========================================================================
  184. @property
  185. def pluginmedia(self):
  186. raise Deprecated(
  187. "CMSPluginBase.pluginmedia is deprecated in favor of django-sekizai"
  188. )
  189. def get_plugin_media(self, request, context, plugin):
  190. raise Deprecated(
  191. "CMSPluginBase.get_plugin_media is deprecated in favor of django-sekizai"
  192. )