Changeset 2555

Timestamp:

03/02/10 16:13:56 (5 months ago)

Author:

JensDiemer

Message:

• NEW: tools / overwrite template !
• Bugfix wrong settings.TEMPLATE_DIRS & Bugfix wrong template_path in PyLucidPlugin?
• merge some code in hightlighter.py

Location:

branches/0.9/pylucid_project

Files:

• apps/pylucid/markup/hightlighter.py (modified) (2 diffs)
• pylucid_plugins/tools/admin_urls.py (modified) (1 diff)
• pylucid_plugins/tools/admin_views.py (modified) (4 diffs)
• pylucid_plugins/tools/forms.py (modified) (2 diffs)
• pylucid_plugins/tools/templates/tools/overwrite_template.html (added)
• settings.py (modified) (3 diffs)
• system/pylucid_plugins.py (modified) (1 diff)

branches/0.9/pylucid_project/apps/pylucid/markup/hightlighter.py

@@ -25 +25 @@
 from pylucid_project.utils.SimpleStringIO import SimpleStringIO
 from pylucid_project.utils.escape import escape, escape_django_tags
+from pylucid_project.apps.pylucid.models import EditableHtmlHeadFile
 
 try:
@@ -107 +108 @@
 
 
+def get_pygments_css(request):
+    """
+    Returns the EditableHtmlHeadFile path to pygments.css
+    A page_msg would be created, if css not exists.
+    """
+    try:
+        pygments_css = EditableHtmlHeadFile.on_site.get(filepath="pygments.css")
+    except EditableHtmlHeadFile.DoesNotExist:
+        request.page_msg("Error: No headfile with filepath 'pygments.css' found.")
+    else:
+        absolute_url = pygments_css.get_absolute_url(colorscheme=None)
+        return absolute_url

branches/0.9/pylucid_project/pylucid_plugins/tools/admin_urls.py

@@ -23 +23 @@
     url(r'^cleanup_log/$', admin_views.cleanup_log, name='Tools-cleanup_log'),
     url(r'^cleanup_session/$', admin_views.cleanup_session, name='Tools-cleanup_session'),
+    url(r'^overwrite_template/$', admin_views.overwrite_template, name='Tools-overwrite_template'),
 )
 

branches/0.9/pylucid_project/pylucid_plugins/tools/admin_views.py

@@ -1 +1 @@
 # coding:utf-8
 
+import os
+import posixpath
 from datetime import datetime, timedelta
+
+
+if __name__ == "__main__":
+    os.environ['DJANGO_SETTINGS_MODULE'] = "pylucid_project.settings"
+    virtualenv_file = "../../../../../bin/activate_this.py"
+    execfile(virtualenv_file, dict(__file__=virtualenv_file))
 
 from django import http
 from django.conf import settings
 from django.utils.translation import ugettext as _
+from django.utils.translation import ugettext as _
 from django.contrib.sessions.models import Session
-
-from pylucid.models import EditableHtmlHeadFile, LogEntry
-from pylucid.decorators import check_permissions, render_to
-
-from pylucid_admin.admin_menu import AdminMenu
-
-from pylucid.markup.hightlighter import make_html
-
-from pylucid_project.pylucid_plugins.tools.forms import HighlightCodeForm, CleanupLogForm
+from django.core.urlresolvers import reverse
+from django.contrib.sites.models import Site
+
+from dbtemplates.models import Template
+
+from pylucid_project.apps.pylucid.models import LogEntry
+from pylucid_project.apps.pylucid.decorators import check_permissions, render_to
+from pylucid_project.apps.pylucid.markup.hightlighter import make_html, get_pygments_css
+
+from pylucid_project.apps.pylucid_admin.admin_menu import AdminMenu
+
+from pylucid_project.pylucid_plugins.tools.forms import HighlightCodeForm, CleanupLogForm, SelectTemplateForm
+
 
 MYSQL_ENCODING_VARS = (
@@ -44 +57 @@
         url_name="Tools-cleanup_session"
     )
-
+    admin_menu.add_menu_entry(
+        parent=menu_section_entry, name="overwrite template",
+        title="Overwrite a filesystem template with a new database headfile entry",
+        url_name="Tools-overwrite_template"
+    )
     return "\n".join(output)
 
@@ -58 +75 @@
     }
 
-    try:
-        pygments_css = EditableHtmlHeadFile.on_site.get(filepath="pygments.css")
-    except EditableHtmlHeadFile.DoesNotExist:
-        request.page_msg("Error: No headfile with filepath 'pygments.css' found.")
-    else:
-        absolute_url = pygments_css.get_absolute_url(colorscheme=None)
-        context["pygments_css"] = absolute_url
+    # get the EditableHtmlHeadFile path to pygments.css (page_msg created, if not exists)
+    pygments_css_path = get_pygments_css(request)
+    context["pygments_css"] = pygments_css_path
 
     if request.method == "POST":
@@ -152 +165 @@
     }
     return context
+
+
+#-----------------------------------------------------------------------------------------------------------
+# overwrite template
+
+
+class TemplateFile(object):
+    def __init__(self, request, fs_path):
+        self.request = request
+        self.fs_path = fs_path
+
+        self.name = fs_path.rsplit("templates", 1)[1].lstrip("/")
+
+    def _get_fs_content(self):
+        try:
+            f = file(self.fs_path, "r")
+            content = f.read()
+            f.close()
+        except Exception, err:
+            request.page_msg.error("Can't read file: %s" % err)
+        else:
+            return content
+
+    def get_or_create_dbtemplate(self):
+        """
+        create a dbtemplate entry with the content form filesystem.
+        return the dbtemplate instance if success, otherwise: create a page_msg and return None
+        """
+        content = self._get_fs_content()
+        if not content:
+            # Content can't readed.
+            return
+
+        template, created = Template.objects.get_or_create(name=self.name,
+            defaults={"content": content}
+        )
+        if created:
+            template.save()
+            current_site = Site.objects.get_current()
+            template.sites.add(current_site)
+            template.save()
+        return template, created
+
+    def get_content_preview(self):
+        content = self._get_fs_content()
+        if not content:
+            # Can't read the template content, page_msg was created.
+            return
+
+        ext = os.path.splitext(self.fs_path)[1]
+        html = make_html(content, ext)
+        return html
+
+
+
+@check_permissions(
+    superuser_only=False,
+    permissions=(u'dbtemplates.add_template', u'dbtemplates.change_template')
+)
+@render_to("tools/overwrite_template.html")
+def overwrite_template(request):
+    """
+    Overwrite a template:
+    1. The user can choose between all existing template in filesystem.
+    2. Read the content from filesystem and create a new dbtemplate entry.
+    3. redirect to edit the nre dbtemplate entry
+    """
+    context = {
+        "title": _("overwrite template"),
+    }
+
+    if request.method != "POST":
+        form = SelectTemplateForm()
+    else:
+        form = SelectTemplateForm(request.POST)
+        if form.is_valid():
+            fs_path = form.cleaned_data["template"]
+            template = TemplateFile(request, fs_path)
+
+            if "preview" in request.POST:
+                # Display only the template content
+                preview_html = template.get_content_preview()
+                if preview_html:
+                    context["template"] = template
+
+                    # get the EditableHtmlHeadFile path to pygments.css (page_msg created, if not exists)
+                    pygments_css_path = get_pygments_css(request)
+                    context["pygments_css"] = pygments_css_path
+            else:
+                # A new dbtemplate should be created
+                instance, created = template.get_or_create_dbtemplate()
+                if instance:
+                    if created:
+                        # New dbtemplate instance created -> edit it
+                        # if instance == None: e.g.: error reading file -> page_msg was created
+                        msg = _("New dbtemplate entry %s created.") % instance
+                        LogEntry.objects.log_action(
+                            app_label="pylucid_plugin.extrahead",
+                            action="overwrite template %s" % template.name,
+                            request=request,
+                            message=msg
+                        )
+                    else:
+                        msg = _("dbtemplate entry %s already exists!") % instance
+
+                    msg += _(" You can edit it now.")
+
+                    request.page_msg(msg)
+
+                    # redirect to edit the new dbtemplate entry
+                    url = reverse("admin:dbtemplates_template_change", args=(instance.id,))
+                    return http.HttpResponseRedirect(url)
+
+    context["form"] = form
+    return context
+
+
+if __name__ == "__main__":
+    templates = [TemplateDir(dir) for dir in settings.TEMPLATE_DIRS]

branches/0.9/pylucid_project/pylucid_plugins/tools/forms.py

@@ -1 +1 @@
 # coding: utf-8
 
+import os
+import posixpath
+
+if __name__ == "__main__":
+    os.environ['DJANGO_SETTINGS_MODULE'] = "pylucid_project.settings"
+    virtualenv_file = "../../../../../bin/activate_this.py"
+    execfile(virtualenv_file, dict(__file__=virtualenv_file))
+
 from django import forms
+from django.conf import settings
 from django.utils.translation import ugettext_lazy as _
 
@@ -29 +38 @@
         help_text=_("Limit the query to the current site?")
     )
+
+
+#-----------------------------------------------------------------------------------------------------------
+# overwrite template
+
+
+class Template(object):
+    """ one template file """
+    def __init__(self, path, filename, abs_path):
+        self.path = path
+        self.filename = filename
+        self.abs_path = abs_path
+
+    def get_choices(self):
+        if "templates" in self.abs_path:
+            path = self.abs_path.split("templates", 1)[1]
+        else:
+            path = self.abs_path
+        path = posixpath.normpath(path)
+        path = path.lstrip("/")
+        return (self.abs_path, path)
+
+
+class TemplateDir(object):
+    """ all template in a settings.TEMPLATE_DIRS """
+    def __init__(self, fs_path):
+        self.fs_path = fs_path
+
+        self.short_path = self._build_short_path()
+
+        if not os.path.isdir(self.fs_path):
+            print "Error: %r doesn't exist!!!" % self.fs_path
+
+        self.templates = []
+        self._get_all_files(self.fs_path)
+
+    def _build_short_path(self):
+        if self.fs_path.startswith(settings.PYLUCID_BASE_PATH):
+            short_path = self.fs_path[len(settings.PYLUCID_BASE_PATH):]
+        else:
+            short_path = self.fs_path
+
+        short_path = posixpath.normpath(short_path)
+        short_path = short_path.strip("/")
+        short_path = short_path.rsplit("templates", 1)[0]
+        if "/src/" in short_path:
+            short_path = short_path.split("/src/")[1]
+
+        return short_path
+
+    def _get_all_files(self, path):
+        dir_items = os.listdir(path)
+        for dir_item in dir_items:
+            if dir_item.startswith("."): # Skip hidden items, e.g.: .svn
+                continue
+
+            abs_path = os.path.join(path, dir_item)
+            if os.path.isfile(abs_path):
+                self.templates.append(Template(path, dir_item, abs_path))
+            elif os.path.isdir(abs_path):
+                self._get_all_files(abs_path) # go recusive deeper
+            else:
+                raise AssertionError("item %r not file or dir" % abs_path)
+
+
+class Templates(object):
+    """ all templates """
+    def __init__(self, template_dirs):
+        self.template_dirs = template_dirs
+        self.templates = {}
+        for dir in template_dirs:
+            self.templates[dir] = TemplateDir(dir)
+
+    def get_choices(self):
+        choices = []
+        for dir in self.template_dirs:
+            templates = self.templates[dir]
+            dir_items = []
+            for template in templates.templates:
+                dir_items.append(template.get_choices())
+            dir_items.sort()
+            choices.append((templates.short_path, dir_items))
+
+        choices.sort()
+        return choices
+
+
+class ChoiceTemplateField(forms.ChoiceField):
+    def __init__(self, *args, **kwargs):
+        super(ChoiceTemplateField, self).__init__(*args, **kwargs)
+
+        templates = Templates(settings.TEMPLATE_DIRS)
+        self.choices = [("", "---------")]
+        self.choices += templates.get_choices()
+
+
+class SelectTemplateForm(forms.Form):
+    template = ChoiceTemplateField(
+        initial="",
+        help_text=_("Select the template you would like to overwrite in dbtemplate.")
+    )
+
+
+if __name__ == "__main__":
+    from pprint import pprint
+
+    form = SelectTemplateForm()
+    pprint(form.fields["template"].choices)
+

branches/0.9/pylucid_project/settings.py

@@ -31 +31 @@
 try:
     #from django_tools.utils import info_print;info_print.redirect_stdout()
-
+    import django
+    import dbpreferences
     import pylucid_project
     from pylucid_project.system import pylucid_plugins
@@ -40 +41 @@
 
 PYLUCID_PROJECT_ROOT = os.path.abspath(os.path.dirname(pylucid_project.__file__))
+#print "PYLUCID_PROJECT_ROOT:", PYLUCID_PROJECT_ROOT
 #PYLUCID_PLUGINS_ROOT = os.path.abspath(os.path.dirname(pylucid_plugins.__file__))
 
@@ -134 +136 @@
     os.path.join(PYLUCID_BASE_PATH, "apps/pylucid_update/templates/"),
 
-    os.path.join(PYLUCID_BASE_PATH, "apps/dbpreferences/templates/"),
-
-    os.path.join(PYLUCID_BASE_PATH, "django/contrib/admin/templates"),
+    os.path.join(os.path.abspath(os.path.dirname(dbpreferences.__file__)), "templates/"),
+    os.path.join(os.path.abspath(os.path.dirname(django.__file__)), "contrib/admin/templates"),
 )
 # Add all templates subdirs from all existing PyLucid plugins
 TEMPLATE_DIRS += pylucid_plugins.PYLUCID_PLUGINS.template_dirs
-#print "settings.TEMPLATE_DIRS:", TEMPLATE_DIRS
+#print "settings.TEMPLATE_DIRS:\n", "\n".join(TEMPLATE_DIRS)
 
 TEMPLATE_LOADERS = (

branches/0.9/pylucid_project/system/pylucid_plugins.py

@@ -31 +31 @@
         self.pkg_string = ".".join([pkg_prefix, plugin_name])
         self.name = plugin_name
-
-        self._template_path = os.path.join(fs_path, "templates")
+        self._template_path = os.path.join(fs_path, plugin_name, "templates")
 
     def get_template_path(self):