cms.plugin_pool: 77 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_pool.py

Stats: 0 executed, 67 missed, 10 excluded, 41 ignored

1. # -*- coding: utf-8 -*-
2. from cms.exceptions import PluginAlreadyRegistered, PluginNotRegistered
3. from cms.plugin_base import CMSPluginBase
4. from cms.utils.django_load import load
5. from cms.utils.helpers import reversion_register
6. from cms.utils.placeholder import get_placeholder_conf
7. from django.conf import settings
8. from django.core.exceptions import ImproperlyConfigured
9. import warnings
11. class PluginPool(object):
12. def __init__(self):
13. self.plugins = {}
14. self.discovered = False
16. def discover_plugins(self):
17. if self.discovered:
18. return
19. self.discovered = True
20. load('cms_plugins')
22. def register_plugin(self, plugin):
23. """
24. Registers the given plugin(s).
26. If a plugin is already registered, this will raise PluginAlreadyRegistered.
27. """
28. if not issubclass(plugin, CMSPluginBase):
29. raise ImproperlyConfigured(
30. "CMS Plugins must be subclasses of CMSPluginBase, %r is not."
31. % plugin
32. )
33. plugin_name = plugin.__name__
34. if plugin_name in self.plugins:
35. raise PluginAlreadyRegistered(
36. "Cannot register %r, a plugin with this name (%r) is already "
37. "registered." % (plugin, plugin_name)
38. )
39. plugin.value = plugin_name
40. self.plugins[plugin_name] = plugin
42. if 'reversion' in settings.INSTALLED_APPS:
43. try:
44. from reversion.registration import RegistrationError
45. except ImportError:
46. from reversion.revisions import RegistrationError
47. try:
48. reversion_register(plugin.model)
49. except RegistrationError:
50. pass
52. def unregister_plugin(self, plugin):
53. """
54. Unregisters the given plugin(s).
56. If a plugin isn't already registered, this will raise PluginNotRegistered.
57. """
58. plugin_name = plugin.__name__
59. if plugin_name not in self.plugins:
60. raise PluginNotRegistered(
61. 'The plugin %r is not registered' % plugin
62. )
63. del self.plugins[plugin_name]
65. def get_all_plugins(self, placeholder=None, page=None, setting_key="plugins", include_page_only=True):
66. self.discover_plugins()
67. plugins = self.plugins.values()[:]
68. plugins.sort(key=lambda obj: unicode(obj.name))
69. final_plugins = []
70. if page:
71. template = page.get_template()
72. else:
73. template = None
74. allowed_plugins = get_placeholder_conf(
75. setting_key,
76. placeholder,
77. template,
78. )
79. for plugin in plugins:
80. include_plugin = False
81. if placeholder:
82. if allowed_plugins:
83. if plugin.__name__ in allowed_plugins:
84. include_plugin = True
85. elif setting_key == "plugins":
86. include_plugin = True
87. if plugin.page_only and not include_page_only:
88. include_plugin = False
89. if include_plugin:
90. final_plugins.append(plugin)
92. if final_plugins:
93. plugins = final_plugins
95. # plugins sorted by modules
96. plugins = sorted(plugins, key=lambda obj: unicode(obj.module))
97. return plugins
99. def get_text_enabled_plugins(self, placeholder, page):
100. plugins = self.get_all_plugins(placeholder, page)
101. plugins +=self.get_all_plugins(placeholder, page, 'text_only_plugins')
102. final = []
103. for plugin in plugins:
104. if plugin.text_enabled:
105. if plugin not in final:
106. final.append(plugin)
107. return final
109. def get_plugin(self, name):
110. """
111. Retrieve a plugin from the cache.
112. """
113. self.discover_plugins()
114. return self.plugins[name]
117. plugin_pool = PluginPool()