Changeset 1602

Timestamp:

05/28/08 13:37:32 (13 months ago)

Author:

JensDiemer

Message:

replace the static admin sub menu with a dynamic one ;)

Location:

trunk/pylucid

Files:

• media/PyLucid/internal_page/admin_menu/sub_menu.html (modified) (1 diff)
• PyLucid/plugins_internal/admin_menu/admin_menu.py (modified) (3 diffs)
• PyLucid/plugins_internal/admin_menu/admin_menu_cfg.py (modified) (2 diffs)
• PyLucid/plugins_internal/EMailSystem/EMailSystem_cfg.py (modified) (2 diffs)
• PyLucid/plugins_internal/filemanager/filemanager_cfg.py (modified) (2 diffs)
• PyLucid/plugins_internal/find_and_replace/find_and_replace_cfg.py (modified) (3 diffs)
• PyLucid/plugins_internal/page_admin/page_admin_cfg.py (modified) (2 diffs)
• PyLucid/plugins_internal/plugin_admin/plugin_admin_cfg.py (modified) (2 diffs)
• PyLucid/plugins_internal/preference_editor/preference_editor_cfg.py (modified) (2 diffs)
• PyLucid/plugins_internal/show_internals/show_internals_cfg.py (modified) (2 diffs)
• PyLucid/system/plugin_manager.py (modified) (1 diff)

trunk/pylucid/media/PyLucid/internal_page/admin_menu/sub_menu.html

@@ -1 @@
-<fieldset><legend>{% trans 'page admin' %}</legend>
-<ul>
-    <li>
-        <a href="{{ commandURLprefix }}/page_admin/select_edit_page/">{% trans 'select page to edit' %}</a> <small>({% trans 'all pages available!' %})</small>
-    </li>
-    <li>
-        <a href="{{ commandURLprefix }}/page_admin/delete_pages/">{% trans 'delete pages' %}</a> <small>({% trans 'select pages to delete these.' %})</small>
-    </li>
-    <li>
-        <a href="{{ commandURLprefix }}/page_admin/sequencing/">{% trans 'sequencing the pages' %}</a> <small>({% trans 'change the page order.' %})</small>
-    </li>
-    {% if is_admin %}
-    <li>
-        <a href="{{ commandURLprefix }}/find_and_replace/find_and_replace/">{% trans 'find/replace' %}</a> <small>({% trans 'Find/replace page content.' %})</small>
-    </li>
-    {% endif %}
-</ul>
-</fieldset>
-
-{% if is_admin %}
-
-<fieldset><legend>{% trans 'edit look' %}</legend>
-<ul>
-    <li>
-        <a href="{{ adminURLprefix }}/PyLucid/style/" onclick="OpenInWindow(this); return false">{% trans 'edit stylesheets' %}</a>
-        |
-        <a href="{{ adminURLprefix }}/PyLucid/style/{{ PAGE.style.id }}/" onclick="OpenInWindow(this); return false">{% trans 'edit current stylesheet' %}</a>
-    </li>
-    <li>
-        <a href="{{ adminURLprefix }}/PyLucid/template/" onclick="OpenInWindow(this); return false">{% trans 'edit templates' %}</a>
-        |
-        <a href="{{ adminURLprefix }}/PyLucid/template/{{ PAGE.template.id }}/" onclick="OpenInWindow(this); return false">{% trans 'edit current template' %}</a>
-    </li>
-</ul>
-</fieldset>
-
-<fieldset><legend>{% trans 'user management' %}</legend>
-<ul>
-    <li>
-        <a href="{{ adminURLprefix }}/auth/user/" onclick="OpenInWindow(this); return false">{% trans 'edit users' %}</a>
-    </li>
-    <li>
-        <a href="{{ adminURLprefix }}/auth/group/" onclick="OpenInWindow(this); return false">{% trans 'edit user groups' %}</a>
-    </li>
-    <li>
-        <a href="{{ commandURLprefix }}/EMailSystem/user_list/">{% trans 'EMail system' %}</a>
-    </li>
-</ul>
-</fieldset>
-
-<fieldset><legend>{% trans 'miscellaneous' %}</legend>
-<ul>
-    <li>
-        <a href="{{ commandURLprefix }}/plugin_admin/menu/">{% trans 'Plugin administration' %}</a>
-    </li>
-    <li>
-        <a href="{{ commandURLprefix }}/preference_editor/select/">{% trans 'Preferences editor' %}</a>
-    </li>
-    <li>
-        <a href="{{ commandURLprefix }}/filemanager/filelist/">{% trans 'Filemanager' %}</a>
-    </li>
-    <li>
-        <a href="{{ commandURLprefix }}/show_internals/menu/">{% trans 'Show internals' %}</a>
-    </li>
-</ul>
-</fieldset>
-
-{% endif %}
+{% for section in dynamic_menu %}
+    <fieldset><legend>{{ section.name }}</legend>
+        <ul>
+        {% for entry in section %}
+            <li><a href="{{ entry.link }}" {% if entry.open_in_window %}onclick="OpenInWindow(this); return false"{% endif %}>{{ entry.title }}</a> - <small>{{ entry.help_text }}</small></li>
+        {% endfor %}
+        </ul>
+    </fieldset>
+{% endfor %}

trunk/pylucid/PyLucid/plugins_internal/admin_menu/admin_menu.py

@@ -19 +19 @@
 
 from django.utils.translation import ugettext as _
+from django.utils.safestring import mark_safe
 
 from PyLucid.system.BasePlugin import PyLucidBasePlugin
+from PyLucid.models import Plugin
+from PyLucid.system.plugin_manager import get_plugin_list, install_plugin
+from PyLucid.system.plugin_import import get_plugin_config, get_plugin_version
+
+
+class MenuSection(object):
+    """
+    Container for all entries in a admin sub menu section
+    """
+    def __init__(self, page_msg, section_name, section_weight):
+        self.page_msg = page_msg
+        self.name = section_name
+        self.weight = section_weight
+        self.data = []
+
+    def add_method(self, menu_data):
+        self.data.append(menu_data)
+
+    def __iter__(self):
+        """
+        for django template engine
+        """
+        data = sorted(self.data, key=lambda x: x.get('weight',0))
+        for entry in data:
+            yield entry
+
+    def __repr__(self):
+        return repr(self.data)
+
+
+class Menu(object):
+    """
+    Container for the complete admin sub menu data
+    """
+    def __init__(self, page_msg, section_weights):
+        self.page_msg = page_msg
+        self.section_weights = section_weights
+        self.data = {}
+
+    def add_entry(self, section_name, menu_data):
+        if section_name not in self.data:
+            # Create new section
+            weights = self.section_weights
+            section_weight = weights.get(section_name, 0)
+            self.data[section_name] = MenuSection(
+                self.page_msg, section_name, section_weight
+            )
+
+        section = self.data[section_name]
+        section.add_method(menu_data)
+
+    def __iter__(self):
+        """
+        for django template engine
+        """
+        sections = self.data.keys()
+        weights = self.section_weights
+
+        # sort in two steps:
+        sections = [(weights.get(s, 0), s) for s in sections]
+        sections = [x[1] for x in sorted(sections)]
+
+        # FIXME: sorting in one step, but it doesn't work, why?
+#        sections = sorted(sections, key=lambda x: weights.get(x, 0))
+
+        for section in sections:
+            yield self.data[section]
+
+    def debug(self):
+        """
+        Display all data
+        """
+        self.page_msg("Menu debug:")
+        self.page_msg(self.section_weights)
+        self.page_msg(self.data)
+
 
 
@@ -42 +119 @@
     def sub_menu(self):
         """
-        render the sub menu
-        """
+        render the admin sub menu
+        """
+        # Collect all plugin methods with a admin_sub_menu data dict
+        menu = self._generate_menu()
+        #menu.debug()
+
+        # Get some static links to the django admin panel
+        self._add_static_entries(menu)
+        #menu.debug()
+
+        #----------------------------------------------------------------------
         # Change the global page title:
         self.context["PAGE"].title = _("Administration sub menu")
@@ -50 +136 @@
 
         context = {
-            "PAGE"            : self.context["PAGE"],
-            "commandURLprefix": self.URLs.get_command_base(),
-            "adminURLprefix"  : self.URLs["adminBase"],
-            "is_admin"        : is_admin,
+            "dynamic_menu" : menu,
         }
         self._render_template("sub_menu", context)#, debug=True)
 
-
-
+    def _add_static_entries(self, menu):
+        """
+        Adds some static sub menu entries to the django admin panel
+        TODO: Make this dynamic changeable
+        """
+        if not self.request.user.is_staff:
+            # All entries here are in the django admin panel
+            # Skip all links, if the current user can't use it
+            return
+
+        page_obj = self.context["PAGE"]
+
+        def add_entry(section, link, title, help_text="", weight=0):
+            menu.add_entry(
+                section,
+                menu_data = {
+                    #"section"       : section,
+                    "link"          : link,
+                    "title"         : title,
+                    "help_text"     : help_text,
+                    "open_in_window": True,
+                    "weight" : weight,
+                },
+            )
+
+        section = _("edit look")
+
+        # STYLE
+        add_entry(section,
+            self.URLs.adminLink("PyLucid/style/%s" % page_obj.style.id),
+            _("edit '%s' stylesheet") % page_obj.style,
+            _("The current used stylesheet."),
+            -5,
+        )
+        add_entry(section,
+            self.URLs.adminLink("PyLucid/style"),
+            _("edit all stylesheets"),
+            "You get a list of all existing stylesheets.",
+            -4,
+        )
+
+        # TEMPLATE
+        add_entry(section,
+            self.URLs.adminLink("PyLucid/template"),
+            _("edit all templates"),
+            "You get a list of all existing templates.",
+            8,
+        )
+        add_entry(section,
+            self.URLs.adminLink("PyLucid/template/%s" % page_obj.template.id),
+            _("edit '%s' template") % page_obj.template,
+            _("The current used template."),
+            5,
+        )
+
+        section = _("user management")
+
+        add_entry(section,
+            self.URLs.adminLink("auth/user"),
+            _("edit users"),
+            "Edit all existing users.",
+            5,
+        )
+        add_entry(section,
+            self.URLs.adminLink("auth/group"),
+            _("edit user groups"),
+            "Edit all existing users.",
+            5,
+        )
+
+
+    def _generate_menu(self):
+        """
+        Generate the dynamic admin sub menu
+        """
+        # Get the preferences from the database:
+        preferences = self.get_preferences()
+        if preferences == None:
+            # preferences not in database -> reinit required
+            if self.request.debug == True:
+                msg = (
+                    '<a href="http://www.pylucid.org/_goto/121/changes/">'
+                    'reinit "admin_menu" plugin required!</a>'
+                )
+                self.page_msg.red(mark_safe(msg))
+            section_weights = []
+        else:
+            # Sort the sections with the weight information from the preferences
+            section_weights = preferences["section_weights"]
+
+        # All installed + active plugins
+        plugins = Plugin.objects.all().filter(active = True).order_by(
+            'package_name', 'plugin_name'
+        )
+
+        menu = Menu(self.page_msg, section_weights)
+
+        # Get the plugin config and build the menu data
+        for plugin in plugins:
+            config = get_plugin_config(
+                package_name = plugin.package_name,
+                plugin_name = plugin.plugin_name,
+                debug = False,
+            )
+
+            for method, data in config.plugin_manager_data.iteritems():
+                if "admin_sub_menu" not in data:
+                    # This method should not listed into the admin sub menu
+                    continue
+
+                menu_data = data["admin_sub_menu"]
+                section = unicode(menu_data["section"]) # translate gettext_lazy
+
+                # Add the _command link to the menu data
+                link = self.URLs.commandLink(
+                    plugin_name = plugin.plugin_name,
+                    method_name = method,
+                )
+                menu_data["link"] = link
+
+                menu.add_entry(section, menu_data)
+
+        return menu

trunk/pylucid/PyLucid/plugins_internal/admin_menu/admin_menu_cfg.py

@@ -1 @@
-#!/usr/bin/python
 # -*- coding: UTF-8 -*-
+
+from pprint import pformat
+from PyLucid.tools.data_eval import data_eval, DataEvalError
+
+from django import newforms as forms
+from django.newforms.util import ValidationError
+from django.utils.translation import gettext_lazy as _
 
 #_____________________________________________________________________________
@@ -9 +15 @@
 __long_description__ = """"""
 __can_deinstall__ = False
+
+#_____________________________________________________________________________
+# preferences
+
+class WeightField(forms.CharField):
+    def clean(self, value):
+        """
+        TODO: Check the data.
+        """
+        # Validates max_length and min_length
+        value = super(WeightField, self).clean(value)
+
+        try:
+            data = data_eval(value)
+        except DataEvalError, err:
+            raise ValidationError("Can't evaluate data: %s" % err)
+
+        for section_name, weight in data.iteritems():
+            if not isinstance(section_name, basestring):
+                raise ValidationError("Wrong section name '%r'" % section_name)
+            if not isinstance(weight, int):
+                raise ValidationError("Wrong weight for '%s'" % section_name)
+            if weight<-10 or weight>10:
+                msg = (
+                    "weight for '%s' out of range (min: -10, max: 10)"
+                ) % section_name
+                raise ValidationError(msg)
+
+        return data
+
+
+class PreferencesForm(forms.Form):
+    # TODO: Find a better way to create a better sized form
+    section_weights = WeightField(
+        min_length = 2,
+        help_text=_(
+            "Weigth for every admin sub menu section entry. (ascending order) "
+        ),
+        widget=forms.Textarea(attrs={'rows': '10'}),
+        initial= (
+            '{'
+                ' "page admin": -5,'
+                ' "edit look": 0,'
+                ' "user management": 3,'
+                ' "miscellaneous": 6,'
+                ' "setup": 8,'
+            '}'
+        )
+    )
 
 #_____________________________________________________________________________

trunk/pylucid/PyLucid/plugins_internal/EMailSystem/EMailSystem_cfg.py

@@ -1 @@
-#!/usr/bin/python
 # -*- coding: UTF-8 -*-
+
+from django.utils.translation import gettext_lazy as _
 
 #_____________________________________________________________________________
@@ -19 +20 @@
         "must_login"    : True,
         "must_admin"    : False,
+        "admin_sub_menu": {
+            "section"       : _("user management"),
+            "title"         : _("EMail system"),
+            "help_text"     : _("Send other PyLucid members a email."),
+            "open_in_window": False,
+            "weight" : 0,
+        },
     },
 }

trunk/pylucid/PyLucid/plugins_internal/filemanager/filemanager_cfg.py

@@ -1 @@
-#!/usr/bin/python
 # -*- coding: UTF-8 -*-
+
+from django.utils.translation import gettext_lazy as _
 
 #_____________________________________________________________________________
@@ -28 +29 @@
 plugin_manager_data = {
     "lucidTag" : global_rights,
-    "filelist" : global_rights,
+    "filelist" : {
+        "must_login"    : True,
+        "must_admin"    : True,
+        "admin_sub_menu": {
+            "section"       : _("miscellaneous"),
+            "title"         : _("Filemanager"),
+            "help_text"     : _(
+                "Administrate static files."
+            ),
+            "open_in_window": False,
+            "weight" : 0,
+        },
+    },
     "select_basepath": global_rights,
     "edit": global_rights,

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

@@ -1 @@
-#!/usr/bin/python
 # -*- coding: UTF-8 -*-
+
+from django import newforms as forms
+from django.utils.translation import gettext_lazy as _
 
 #_____________________________________________________________________________
@@ -20 +22 @@
 # preferences
 
-from django import newforms as forms
-from django.utils.translation import ugettext as _
-
 class PreferencesForm(forms.Form):
     min_term_len = forms.IntegerField(
@@ -40 +39 @@
         "must_login"    : True,
         "must_admin"    : True,
+        "admin_sub_menu": {
+            "section"       : _("page admin"),
+            "title"         : _("find/replace"),
+            "help_text"     : _(
+                "Find and replace strings in page/stylesheets/template content."
+            ),
+            "open_in_window": False,
+            "weight" : 5,
+        },
     },
 }
-
-preferences = (
-    {
-        "name": "term len limit",
-        "description": "How min/max long must a search term be?",
-        "value": {
-            "min term len": 1,
-            "max term len": 255,
-        }
-    },
-)

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

@@ -1 @@
-#!/usr/bin/python
 # -*- coding: UTF-8 -*-
+
+from django.utils.translation import gettext_lazy as _
 
 #_____________________________________________________________________________
@@ -17 +18 @@
 # plugin administration data
 
-global_rights = {
-    "must_login"    : True,
-    "must_admin"    : False,
-}
 plugin_manager_data = {
-    "edit_page" : global_rights,
-    "new_page" : global_rights,
-    "delete_page" : global_rights,
+    "edit_page" : {
+        "must_login"    : True,
+        "must_admin"    : False,
+    },
+    "new_page" : {
+        "must_login"    : True,
+        "must_admin"    : False,
+    },
+    "delete_page" : {
+        "must_login"    : True,
+        "must_admin"    : False,
+    },
     "markup_help" : {
         "must_login" : False,
         "must_admin" : False,
     },
-    "select_edit_page" : global_rights,
+    "select_edit_page" : {
+        "must_login"    : True,
+        "must_admin"    : False,
+        "admin_sub_menu": {
+            "section"       : _("page admin"),
+            "title"         : _("select page to edit"),
+            "help_text"     : _("all pages available!"),
+            "open_in_window": False,
+            "weight"        : -8,
+        },
+    },
     "delete_pages" : {
         "must_login" : True,
         "must_admin" : True,
+        "admin_sub_menu": {
+            "section"       : _("page admin"),
+            "title"         : _("delete pages"),
+            "help_text"     : _("select pages to delete these."),
+            "open_in_window": False,
+            "weight"        : -5,
+        },
     },
-    "sequencing" : global_rights,
+    "sequencing" : {
+        "must_login"    : True,
+        "must_admin"    : False,
+        "admin_sub_menu": {
+            "section"       : _("page admin"),
+            "title"         : _("sequencing the pages"),
+            "help_text"     : _("change the page order."),
+            "open_in_window": False,
+            "weight"        : -3,
+        },
+    },
     "tag_list": {
         "must_login" : False,

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

@@ -1 @@
-#!/usr/bin/python
 # -*- coding: UTF-8 -*-
+
+from django.utils.translation import gettext_lazy as _
 
 #_____________________________________________________________________________
@@ -16 +17 @@
 # plugin administration data
 
-global_rights = {
-    "must_login": True,
-    "must_admin": True,
+plugin_manager_data = {
+    "menu": {
+        "must_login": True,
+        "must_admin": True,
+        "admin_sub_menu": {
+            "section"       : _("setup"),
+            "title"         : _("Plugin administration"),
+            "help_text"     : _(
+                "Manage all PyLucid plugins."
+            ),
+            "open_in_window": False,
+            "weight" : -8,
+        },
+    },
+    "plugin_setup": {
+        "must_login": True,
+        "must_admin": True,
+    },
 }
-plugin_manager_data = {
-    "menu": global_rights,
-    "plugin_setup": global_rights,
-}

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

@@ -1 @@
-#!/usr/bin/python
 # -*- coding: UTF-8 -*-
+
+from django.utils.translation import gettext_lazy as _
 
 #_____________________________________________________________________________
@@ -15 +16 @@
 # plugin administration data
 
-
-global_rights = {
-    "must_login"    : True,
-    "must_admin"    : True,
+plugin_manager_data = {
+    "select" : {
+        "must_login"    : True,
+        "must_admin"    : True,
+        "admin_sub_menu": {
+            "section"       : _("setup"),
+            "title"         : _("Preferences editor"),
+            "help_text"     : _(
+                "Setup all plugin preferences."
+            ),
+            "open_in_window": False,
+            "weight" : -5,
+        },
+    },
+    "edit": {
+        "must_login"    : True,
+        "must_admin"    : True,
+    },
 }
-
-plugin_manager_data = {
-    "select" : global_rights,
-    "edit": global_rights,
-}

trunk/pylucid/PyLucid/plugins_internal/show_internals/show_internals_cfg.py

@@ -1 @@
-#!/usr/bin/python
 # -*- coding: UTF-8 -*-
+
+from django.utils.translation import gettext_lazy as _
 
 #_____________________________________________________________________________
@@ -22 +23 @@
     "lucidTag"  : global_rights,
     "link"      : global_rights,
-    "menu"      : global_rights,
+    "menu"      : {
+        "must_login"    : True,
+        "must_admin"    : True,
+        "admin_sub_menu": {
+            "section"       : _("miscellaneous"),
+            "title"         : _("Show internals"),
+            "help_text"     : _(
+                "Display several system information."
+            ),
+            "open_in_window": False,
+            "weight" : 0,
+        },
+    },
     "pylucid_info": {
         "must_login"        : True,

trunk/pylucid/PyLucid/system/plugin_manager.py

@@ -220 +220 @@
     if pref_form:
         # plugin module has a preferences newform class
-        plugin.init_pref_form(pref_form)
+        plugin.init_pref_form(pref_form, debug=extra_verbose)
 
     plugin.save()