Changeset 1551

Timestamp:

05/02/08 16:47:16 (23 months ago)

Author:

JensDiemer

Message:

update preferences:

• move the preferences form from the plugin module into the plugin config modul
• a plugin must not use try...except to get the preferences
• update all modules around the plugin install/deinstall etc.
• detect_page used the system_settings "index_page" value (setup a other default index page works!)

Location:

trunk/pylucid

Files:

• media/PyLucid/internal_page/plugin_admin/administation_menu.html (modified) (3 diffs)
• media/PyLucid/internal_page/preference_editor/select.html (modified) (1 diff)
• PyLucid/db/page.py (modified) (2 diffs)
• PyLucid/models.py (modified) (7 diffs)
• PyLucid/plugins_internal/find_and_replace/find_and_replace.py (modified) (2 diffs)
• PyLucid/plugins_internal/find_and_replace/find_and_replace_cfg.py (modified) (1 diff)
• PyLucid/plugins_internal/page_admin/page_admin.py (modified) (2 diffs)
• PyLucid/plugins_internal/plugin_admin/plugin_admin.py (modified) (5 diffs)
• PyLucid/plugins_internal/preference_editor/preference_editor.py (modified) (2 diffs)
• PyLucid/plugins_internal/search/search.py (modified) (1 diff)
• PyLucid/plugins_internal/search/search_cfg.py (modified) (1 diff)
• PyLucid/plugins_internal/system_settings/system_settings.py (modified) (3 diffs)
• PyLucid/plugins_internal/system_settings/system_settings_cfg.py (modified) (1 diff)
• PyLucid/system/detect_page.py (modified) (4 diffs)
• PyLucid/system/plugin_import.py (modified) (4 diffs)
• PyLucid/system/plugin_manager.py (modified) (8 diffs)

trunk/pylucid/media/PyLucid/internal_page/plugin_admin/administation_menu.html

@@ -50 +50 @@
                 <a class="author" href="{{ plugin.url }}" title="{{ plugin.author }}"></a>
             </td>
-            <td class="version">{{ plugin.version }}</td>
+            <td class="version">{{ plugin.get_version_string }}</td>
             <td>
                 {% if plugin.builtin %}
@@ -91 +91 @@
                 <a class="author" href="{{ plugin.url }}" title="{{ plugin.author }}">{{ plugin.author }}</a>
             </td>
-            <td class="version">{{ plugin.version }}</td>
+            <td class="version">{{ plugin.get_version_string }}</td>
             <td>
                 {% if not plugin.can_deinstall %}
@@ -116 +116 @@
 <h4>Info:</h4>
 <ul>
-  <li><strong>install</strong> - register a plugin/Plugin in the Database</li>
-  <li><strong>deinstall</strong> - All tables, stylesheets and internal pages where delete in the DB.</li>
-  <li><strong>activate</strong> - enable the plugin/Plugin for the CMS</li>
-  <li><strong>deactivate</strong> - disable the plugin/Plugin</li>
+  <li><strong>install</strong> - register a plugin/Plugin in the database</li>
+  <li><strong>deinstall</strong> - Complete remove the plugin from the database (incl. preferences)</li>
+  <li><strong>activate</strong> - enable the plugin (set active flag)</li>
+  <li><strong>deactivate</strong> - disable the plugin</li>
 </ul>

trunk/pylucid/media/PyLucid/internal_page/preference_editor/select.html

@@ -1 +1 @@
 <fieldset><legend>select for edit</legend>
 <ul>
-{% for item in preferences %}
-  <li><a href="{{ item.edit_link }}">{{ item.plugin_name }}</a> - {{ item.plugin_description }}</li>
+{% for plugin in plugins %}
+  <li><a href="{{ plugin.edit_link }}">{{ plugin.plugin_name }}</a> - {{ plugin.description }}</li>
 {% endfor %}
 </ul>

trunk/pylucid/PyLucid/db/page.py

@@ -20 +20 @@
 #      page-ID  <-> parant-ID relation?
 #      url data for every page?
+
+from django import newforms as forms
+from django.newforms.util import ValidationError
+from django.utils.translation import ugettext as _
 
 from PyLucid.models import User, Page
@@ -129 +133 @@
     return sub_pages
 
+#______________________________________________________________________________
+# newforms Page choice
+"""
+# usage:
 
+from PyLucid.db.page import PageChoiceField, get_page_choices
+class MyForm(forms.Form):
+    ...
+    page = PageChoiceField(widget=forms.Select(choices=get_page_choices()))
+    ...
+"""
+
+class PageChoiceField(forms.IntegerField):
+    def clean(self, page_id):
+        """
+        returns the parent page instance.
+        Note:
+            In PyLucid.models.Page.save() it would be checkt if the selected
+            parent page is logical valid. Here we check only, if the page with
+            the given ID exists.
+        """
+        # let convert the string into a integer:
+        page_id = super(PageChoiceField, self).clean(page_id)
+
+        if page_id == 0:
+            # assigned to the tree root.
+            return None
+
+        try:
+            #page_id = 999999999 # Not exists test
+            page = Page.objects.get(id=page_id)
+        except Exception, msg:
+            raise ValidationError(_(u"Wrong parent POST data: %s" % msg))
+        else:
+            return page_id
+
+
+def get_page_choices():
+    """
+    generate a verbose page name tree for the parent choice field.
+    """
+    page_list = flat_tree_list()
+    choices = [(0, "---[root]---")]
+    for page in page_list:
+        choices.append((page["id"], page["level_name"]))
+    return choices

trunk/pylucid/PyLucid/models.py

@@ -32 +32 @@
 from PyLucid.tools import crypt
 from PyLucid.system.utils import get_uri_base
-from PyLucid.system.plugin_import import get_plugin_module
+from PyLucid.system.plugin_import import get_plugin_config, get_plugin_version
 
 #from PyLucid.db.cache import delete_page_cache
@@ -234 +234 @@
             auto_shortcuts = True
         else:
-            print ">>>", preferences
             auto_shortcuts = preferences["auto_shortcuts"]
 
@@ -508 +507 @@
         # Get the name of the plugin, if __file__ used
         plugin_name = os.path.splitext(os.path.basename(plugin_name))[0]
-        print "plugin name: '%s'" % plugin_name
+        #print "plugin name: '%s'" % plugin_name
 
         if plugin_name in preference_cache:
@@ -541 +540 @@
     )
 
+    #__________________________________________________________________________
+    # spezial methods
+
     def init_pref_form(self, pref_form):
         """
@@ -550 +552 @@
         self.set_pref_data_string(init_dict)
 
+    #__________________________________________________________________________
+    # spezial set methods
+
     def set_pref_data_string(self, data_dict):
         """
@@ -556 +561 @@
         preference_cache[self.plugin_name] = data_dict
         self.pref_data_string = pformat(data_dict)
+
+    #__________________________________________________________________________
+    # spezial get methods
 
     def get_preferences(self):
@@ -570 +578 @@
         initial information into the help text and return the form.
         """
-        plugin_module = get_plugin_module(
+        plugin_config = get_plugin_config(
             self.package_name, self.plugin_name, debug
         )
-        form = getattr(plugin_module, "PreferencesForm")
+        form = getattr(plugin_config, "PreferencesForm")
         setup_help_text(form)
         return form
+
+    def get_version_string(self, debug=False):
+        """
+        Returned the version string from the plugin module
+        """
+        return get_plugin_version(self.package_name, self.plugin_name, debug)
+
+    #--------------------------------------------------------------------------
 
     def save(self):

trunk/pylucid/PyLucid/plugins_internal/find_and_replace/find_and_replace.py

@@ -33 +33 @@
 
 from PyLucid.system.BasePlugin import PyLucidBasePlugin
-from PyLucid.models import Page, Template, Style
-#from PyLucid.db.preferences import get_pref_dict
+from PyLucid.models import Page, Plugin, Template, Style
 from PyLucid.tools.Diff import diff_lines
 from PyLucid.tools.utils import escape
-
-
-class PreferencesForm(forms.Form):
-    min_term_len = forms.IntegerField(
-        help_text="Min length of a search term",
-        initial=2, min_value=1
-    )
-    max_term_len = forms.IntegerField(
-        help_text="Max length of a search term",
-        initial=150, min_value=1, max_value=500
-    )
 
 
@@ -59 +47 @@
 
 # We used preferences values in a newform. We need these values here.
-try:
-    preferences = Plugin.objects.get_preferences(__file__)
-except Plugin.DoesNotExist, e:
-    # in _install section?
-    pass
-else:
-    min_term_len = preferences["min_term_len"]
-    max_term_len = preferences["max_term_len"]
+preferences = Plugin.objects.get_preferences(__file__)
+
+min_term_len = preferences["min_term_len"]
+max_term_len = preferences["max_term_len"]
 
 

trunk/pylucid/PyLucid/plugins_internal/find_and_replace/find_and_replace_cfg.py

@@ -16 +16 @@
 submenu.
 """
+
+#_____________________________________________________________________________
+# preferences
+
+from django import newforms as forms
+from django.utils.translation import ugettext as _
+
+class PreferencesForm(forms.Form):
+    min_term_len = forms.IntegerField(
+        help_text=_("Min length of a search term"),
+        initial=2, min_value=1
+    )
+    max_term_len = forms.IntegerField(
+        help_text=_("Max length of a search term"),
+        initial=150, min_value=1, max_value=500
+    )
 
 #_____________________________________________________________________________

trunk/pylucid/PyLucid/plugins_internal/page_admin/page_admin.py

@@ -45 +45 @@
 from PyLucid.plugins_internal.page_style.page_style import replace_add_data
 
-
-class ParentChoiceField(forms.IntegerField):
-    def clean(self, parent_id):
-        """
-        returns the parent page instance.
-        Note:
-            In PyLucid.models.Page.save() it would be checkt if the selected
-            parent page is logical valid. Here we check only, if the page with
-            the given ID exists.
-        """
-        # let convert the string into a integer:
-        parent_id = super(ParentChoiceField, self).clean(parent_id)
-        assert isinstance(parent_id, int)
-
-        if parent_id == 0:
-            # assigned to the tree root.
-            return None
-
-        try:
-            #parent_id = 999999999 # Not exists test
-            page = Page.objects.get(id=parent_id)
-            return page
-        except Exception, msg:
-            raise ValidationError(_(u"Wrong parent POST data: %s" % msg))
-
-
-def get_parent_choices():
-    """
-    generate a verbose page name tree for the parent choice field.
-    """
-    page_list = flat_tree_list()
-    choices = [(0, "---[root]---")]
-    for page in page_list:
-        choices.append((page["id"], page["level_name"]))
-    return choices
+from PyLucid.db.page import PageChoiceField, get_page_choices
+
 
 class EditPageForm(forms.Form):
@@ -95 +62 @@
     )
 
-    parent = ParentChoiceField(
-        widget=forms.Select(choices=get_parent_choices()),
+    parent = PageChoiceField(
+        widget=forms.Select(choices=get_page_choices()),
         # FIXME: How to set invalid_choice here?
         help_text="the higher-ranking father page",

trunk/pylucid/PyLucid/plugins_internal/plugin_admin/plugin_admin.py

@@ -30 +30 @@
 
 from PyLucid.system.plugin_manager import get_plugin_list, install_plugin
-from PyLucid.system.plugin_import import get_plugin_config
+from PyLucid.system.plugin_import import get_plugin_config, get_plugin_version
 from PyLucid.system.BasePlugin import PyLucidBasePlugin
 from PyLucid.models import Plugin
@@ -134 +134 @@
                     continue
                 try:
-                    plugin_cfg = get_plugin_config(self.request,
-                        package_name, plugin_name, dissolve_version_string=True
+                    plugin_cfg = get_plugin_config(
+                        package_name, plugin_name, self.request.debug
                     )
                 except Exception, e:
@@ -142 +142 @@
                     self.page_msg("Error: %s" % e)
                 else:
+                    plugin_version = get_plugin_version(
+                        package_name, plugin_name, self.request.debug
+                    )
                     uninstalled_plugins.append({
                         "plugin_name": plugin_name,
@@ -148 +151 @@
                         "url": plugin_cfg.__url__,
                         "author": plugin_cfg.__author__,
-                        "version": plugin_cfg.__version__,
+                        "version": plugin_version,
                     })
 
@@ -165 +168 @@
         try:
             install_plugin(
-                self.request, package_name, plugin_name, active,
+                package_name, plugin_name, self.request.debug, active,
                 extra_verbose=False
             )

trunk/pylucid/PyLucid/plugins_internal/preference_editor/preference_editor.py

@@ -11 +11 @@
     ~~~~~~~~~~~~~~~~~
     $LastChangedDate$
-    $Rev$
-    $Author$
+    $Rev:1549 $
+    $Author:JensDiemer $
 
     :copyleft: 2008 by the PyLucid team.
@@ -40 +40 @@
         Display the sub menu
         """
-#        self.context["PAGE"].title = _("Preferences editor")
+        plugins = Plugin.objects.exclude(pref_data_string__isnull=True)
 
-        items = []
-        plugins = Plugin.objects.all()
+        # Add edit link
         for plugin in plugins:
-            if plugin.pref_data_string == None:
-                continue
-
             edit_link = self.URLs.methodLink("edit", args=plugin.id)
-
-            items.append({
-                "plugin_name": unicode(plugin),
-                "plugin_description": plugin.description,
-                "edit_link": edit_link,
-            })
+            plugin.edit_link = edit_link
 
         context = {
-            "preferences": items,
-            "admin_link": self.URLs.adminLink("PyLucid/preference"),
+            "plugins": plugins,
+            "admin_link": self.URLs.adminLink("PyLucid/Plugin"),
         }
         self._render_template("select", context)#, debug=True)

trunk/pylucid/PyLucid/plugins_internal/search/search.py

@@ -35 +35 @@
 
 
-class PreferencesForm(forms.Form):
-    min_term_len = forms.IntegerField(
-        help_text="Min length of a search term",
-        initial=3, min_value=1
+# We used preferences values in a newform. We need these values here.
+preferences = Plugin.objects.get_preferences(__file__)
+
+class SearchForm(forms.Form):
+    search_string = forms.CharField(
+        min_length = preferences["min_term_len"],
+        max_length = preferences["max_term_len"],
     )
-    max_term_len = forms.IntegerField(
-        help_text="Max length of a search term",
-        initial=50, min_value=1, max_value=200
-    )
-    max_results = forms.IntegerField(
-        help_text="Number of the paged for the result page",
-        initial=20, min_value=1, max_value=200
-    )
-    text_cutout_len = forms.IntegerField(
-        help_text="The length of the text-hit-cutouts",
-        initial=50, min_value=1, max_value=200
-    )
-    text_cutout_lines = forms.IntegerField(
-        help_text="Max. cutout lines for every search term",
-        initial=5, min_value=1, max_value=20
-    )
-
-# We used preferences values in a newform. We need these values here.
-try:
-    preferences = Plugin.objects.get_preferences(__file__)
-except Plugin.DoesNotExist, e:
-    # in _install section?
-    pass
-else:
-    class SearchForm(forms.Form):
-        search_string = forms.CharField(
-            min_length = preferences["min_term_len"],
-            max_length = preferences["max_term_len"],
-        )
 
 

trunk/pylucid/PyLucid/plugins_internal/search/search_cfg.py

@@ -13 +13 @@
 
 #_____________________________________________________________________________
+# preferences
+
+from django import newforms as forms
+from django.utils.translation import ugettext as _
+
+class PreferencesForm(forms.Form):
+    min_term_len = forms.IntegerField(
+        help_text=_("Min length of a search term"),
+        initial=3, min_value=1
+    )
+    max_term_len = forms.IntegerField(
+        help_text=_("Max length of a search term"),
+        initial=50, min_value=1, max_value=200
+    )
+    max_results = forms.IntegerField(
+        help_text=_("Number of the paged for the result page"),
+        initial=20, min_value=1, max_value=200
+    )
+    text_cutout_len = forms.IntegerField(
+        help_text=_("The length of the text-hit-cutouts"),
+        initial=50, min_value=1, max_value=200
+    )
+    text_cutout_lines = forms.IntegerField(
+        help_text=_("Max. cutout lines for every search term"),
+        initial=5, min_value=1, max_value=20
+    )
+
+#_____________________________________________________________________________
 # plugin administration data
 

trunk/pylucid/PyLucid/plugins_internal/system_settings/system_settings.py

@@ -7 +7 @@
 
     A pseudo plugin for holding the system settings via the plugin preferences.
-
-    TODO: merge with page_admin ChoiceField -> move it into PyLucid.db.page?
 
     Last commit info:
@@ -22 +20 @@
 __version__= "$Rev$"
 
-from django import newforms as forms
+#from django import newforms as forms
 #from django.utils.translation import ugettext as _
 #from django.utils.safestring import mark_safe
@@ -28 +26 @@
 from PyLucid.system.BasePlugin import PyLucidBasePlugin
 from PyLucid.models import Page
-from PyLucid.db.page import flat_tree_list
-
-def get_parent_choices():
-    """
-    generate a verbose page name tree for the parent choice field.
-    """
-    page_list = flat_tree_list()
-    choices = [(0, "---[root]---")]
-    for page in page_list:
-        choices.append((page["id"], page["level_name"]))
-    return choices
-
-class PreferencesForm(forms.Form):
-#    index_page = forms.IntegerField(
-    index_page = forms.ChoiceField(
-        choices=get_parent_choices(),
-        help_text="The page ID of the index page",
-        initial=0
-    )
-    auto_shortcuts = forms.BooleanField(
-        help_text="Should the shortcut of a page rebuild on every edit?",
-        initial=True
-    )
-
 
 
 class system_settings(PyLucidBasePlugin):
-
     def lucidTag(self):
         """
-        Insert a empty search form into the page.
+        TODO!
         """
         self.page_msg("Preferences:", preferences)

trunk/pylucid/PyLucid/plugins_internal/system_settings/system_settings_cfg.py

@@ -13 +13 @@
 
 #_____________________________________________________________________________
+# preferences
+
+from django import newforms as forms
+from django.utils.translation import ugettext as _
+
+from PyLucid.db.page import PageChoiceField, get_page_choices
+
+
+class PreferencesForm(forms.Form):
+    index_page = PageChoiceField(
+        widget=forms.Select(choices=get_page_choices()),
+        help_text=_("The page ID of the index page"),
+        initial=0
+    )
+    auto_shortcuts = forms.BooleanField(
+        help_text=_("Should the shortcut of a page rebuild on every edit?"),
+        initial=True
+    )
+
+#_____________________________________________________________________________
 # plugin administration data
 

trunk/pylucid/PyLucid/system/detect_page.py

@@ -17 +17 @@
 """
 
-from PyLucid.models import Page
-from PyLucid.system.exceptions import AccessDenied, LowLevelError
-
 from django.utils.translation import ugettext as _
 from django.http import Http404, HttpResponseRedirect
+
+from PyLucid.system.exceptions import AccessDenied, LowLevelError
+from PyLucid.models import Page, Plugin
+
 
 def get_a_page():
     """
     Try to get and return a existing page.
-    Create a first page, if no page exists.
     """
     try:
@@ -37 +37 @@
 
 
-def get_default_page_id():
+def get_default_page_id(request):
     """
     returns the default page id
     """
     try:
-        default_page = Preference.objects.get(name__exact="index page")
-#        default_page = "raise!"
-        return int(default_page.value)
+        preferences = Plugin.objects.get_preferences("system_settings")
+        default_page_id = preferences["index_page"]
+        return default_page_id
     except Exception, e:
         # TODO: make a page message for the admin
@@ -53 +53 @@
 
 
-def get_default_page():
-    page_id = get_default_page_id()
+def get_default_page(request):
+    page_id = get_default_page_id(request)
     try:
 #        page_id = "wrong test"
@@ -76 +76 @@
     if page_name == "":
         # Index Seite wurde aufgerufen. Zumindest bei poor-modrewrite
-        return get_default_page()
+        return get_default_page(request)
 
     # bsp/und%2Foder -> ['bsp', 'und%2Foder']

trunk/pylucid/PyLucid/system/plugin_import.py

@@ -1 +1 @@
 # -*- coding: utf-8 -*-
-
 """
     PyLucid Plugin Manager
@@ -52 +51 @@
         page_msg(getattr(plugin_config, item))
 
-def get_plugin_config(request, package_name, plugin_name,
-                            dissolve_version_string=False, extra_verbose=False):
+def get_plugin_config(package_name, plugin_name, debug, extra_verbose=False):
     """
     imports the plugin and the config plugin and returns a merge config-object
@@ -61 +59 @@
     """
     config_name = "%s_cfg" % plugin_name
-    debug = request.user.is_superuser or request.debug
+    from_name = ".".join([package_name, plugin_name, config_name])
+    if extra_verbose:
+        print "from %s import %s" % (from_name, config_name)
 
-    def get_plugin(object_name):
-        from_name = ".".join([package_name, plugin_name, object_name])
-        if extra_verbose:
-            print "from %s import %s" % (from_name, object_name)
-        return _import(from_name, object_name, debug)
-
-    config_plugin = get_plugin(config_name)
-
-    if dissolve_version_string:
-        plugin_plugin = get_plugin(plugin_name)
-
-        plugin_version = getattr(plugin_plugin, "__version__", None)
-        if plugin_version:
-            # Cleanup a SVN Revision Number
-            plugin_version = plugin_version.strip("$ ")
-        config_plugin.__version__ = plugin_version
+    config_plugin = _import(from_name, config_name, debug)
 
     return config_plugin
+
+def get_plugin_version(package_name, plugin_name, debug):
+    plugin_plugin = get_plugin_module(package_name, plugin_name, debug)
+
+    plugin_version = getattr(plugin_plugin, "__version__", "")
+
+    # Cleanup a SVN Revision Number
+    plugin_version = plugin_version.strip("$ ")
+
+    return plugin_version
 
 
@@ -87 +82 @@
 
 
-
-

trunk/pylucid/PyLucid/system/plugin_manager.py

@@ -1 +1 @@
 # -*- coding: utf-8 -*-
-
 """
     PyLucid Plugin Manager
@@ -35 +34 @@
 
 #from PyLucid.db.preferences import Preferences, preference_cache, PreferenceDoesntExist
-from PyLucid.system.plugin_import import get_plugin_module, get_plugin_config
+from PyLucid.system.plugin_import import get_plugin_module, get_plugin_config, \
+                                                            get_plugin_version
 from PyLucid.system.exceptions import *
 from PyLucid.models import Plugin
@@ -68 +68 @@
         return
 
-    plugin_config = get_plugin_config(request,
+    plugin_config = get_plugin_config(
         package_name = plugin.package_name,
         plugin_name = plugin.plugin_name,
-        dissolve_version_string=False
+        debug = request.debug,
     )
 #    context["page_msg"](plugin_config.plugin_manager_data)
@@ -200 +200 @@
 
 
-def _install_plugin(request, package_name, plugin_name, plugin_config, active,
+def _install_plugin(package_name, plugin_name, plugin_config, active,
                                                                 extra_verbose):
     """
@@ -217 +217 @@
         active = active,
     )
-    debug = request.user.is_superuser or request.debug
-    plugin_module = get_plugin_module(package_name, plugin_name, debug)
-    pref_form = getattr(plugin_module, "PreferencesForm", None)
+
+    pref_form = getattr(plugin_config, "PreferencesForm", None)
     if pref_form:
         # plugin module has a preferences newform class
         plugin.init_pref_form(pref_form)
-
 
     plugin.save()
@@ -232 +230 @@
 
 
-def install_plugin(request, package_name, plugin_name, active,
+def install_plugin(package_name, plugin_name, debug, active,
                                                         extra_verbose=False):
     """
     Get the config object from disk and insert the plugin into the database
     """
-    plugin_config = get_plugin_config(request,
-        package_name, plugin_name,
-        dissolve_version_string=True, extra_verbose=extra_verbose
+    plugin_config = get_plugin_config(
+        package_name, plugin_name, debug, extra_verbose=extra_verbose
     )
     if extra_verbose:
@@ -255 +252 @@
 
     plugin = _install_plugin(
-        request, package_name, plugin_name,
-        plugin_config, active, extra_verbose
+        package_name, plugin_name, plugin_config, active, extra_verbose
     )
 
@@ -284 +280 @@
 
         try:
-            install_plugin(request,
-                package_name, plugin_name,
+            install_plugin(
+                package_name, plugin_name, request.debug,
                 active=True, extra_verbose=extra_verbose
             )
         except Exception, e:
+            # FIXME
             print "Error:"
             import traceback