Changeset 1825

Timestamp:

02/16/09 16:50:17 (13 months ago)

Author:

JensDiemer

Message:

Work-in-progress: move some code from filemanager plugin into a shared destination. It's usefull for "filesystem based plugins" such as the gallery. Change the settings for the filemanager base path. Every fs-plugin should use this path information.

Location:

trunk/pylucid_project

Files:

• media/PyLucid/internal_page/filemanager/select_basepath.html (modified) (1 diff)
• PyLucid/forms/filesystem.py (modified) (2 diffs)
• PyLucid/plugins_internal/filemanager/filemanager.py (modified) (10 diffs)
• PyLucid/settings_example.py (modified) (1 diff)
• PyLucid/system/BaseFilesystemPlugin.py (added)
• PyLucid/tools/path_manager.py (modified) (1 diff)

trunk/pylucid_project/media/PyLucid/internal_page/filemanager/select_basepath.html

@@ -1 +1 @@
 <fieldset><legend>{% trans 'Select a base path' %}</legend>
 <form action="." method="post">
-    {{ form.as_p }}
+    {{ select_basepath }}
     <input type="submit" name="change" value="{% trans 'change' %}" />
 </form>

trunk/pylucid_project/PyLucid/forms/filesystem.py

@@ -17 +17 @@
 """
 
-
 from django import forms
+from django.conf import settings
 from django.utils.translation import ugettext as _
 
@@ -29 +29 @@
 
 
+
+class BasePathField(forms.ChoiceField):
+    def __init__(self, required=True, label=None, initial=None, help_text=None,
+                                                             *args, **kwargs):
+        
+        widget = forms.Select
+        choices = [(i,i) for i in settings.FILESYSTEM_BASEPATHS.keys()]
+        
+        super(BasePathField, self).__init__(choices, required, widget, label,
+                                            initial, help_text, *args, **kwargs)
+        
+    def clean(self, value):
+        path_key = super(BasePathField, self).clean(value)
+        try:
+            fs_path, url = settings.FILESYSTEM_BASEPATHS[path_key]
+             
+        except KeyError:
+            raise forms.ValidationError("Basepath doesn't exists!")
+        
+        return path_key, fs_path, url
+        
+        
 
 class BadCharField(forms.CharField):

trunk/pylucid_project/PyLucid/plugins_internal/filemanager/filemanager.py

@@ -52 +52 @@
 from datetime import datetime
 
+from django import forms
 from django.conf import settings
-from django.http import Http404
-from django import forms
+from django.http import HttpResponse
 from django.forms import ValidationError
 from django.utils.translation import ugettext as _
-from django.utils.encoding import force_unicode
-
-from PyLucid.models import Page
-from PyLucid.tools.utils import contains_char
-from PyLucid.system.BasePlugin import PyLucidBasePlugin
-from PyLucid.forms.filesystem import FilenameField, DirnameField, \
-                                                BAD_DIR_CHARS, BAD_FILE_CHARS
-
-from PyLucid.tools.path_manager import BASE_PATHS, BASE_PATHS_DICT
+
+from PyLucid.system.BaseFilesystemPlugin import FilesystemPlugin
+from PyLucid.forms.filesystem import FilenameField, DirnameField
 
 #______________________________________________________________________________
@@ -111 +105 @@
     )
 
-class SelectBasePathForm(forms.Form):
-    """ change the base path form """
-    base_path = forms.ChoiceField(choices=BASE_PATHS)
 
 #______________________________________________________________________________
@@ -175 +166 @@
     item_name = FilenameField()
 
+
+
+
 #______________________________________________________________________________
 
-class Path(dict):
-    """
-    Helper class for analyse, check and store the html GET path information.
-    Used in filemanager()
-
-    base_no       = BASE_PATHS_DICT key (Note: it's a String!)
-    base_path     = relative base path
-    abs_base_path = absolute filesystem base path
-    rel_path      = relative path (from GET)
-    abs_path      = absolute filesystem path (abs_base_path + rel_path)
-    url_path      = base_no + rel_path for html links
-
-    - only with new_filename_path():
-    filename      = contains only the filename
-    abs_file_path = absolute filesystem path incl. filename
-    """
-    def __init__(self, context):
-        self.context     = context
-        self.request     = context["request"]
-        self.page_msg    = self.request.page_msg
-
-    def new_dir_path(self, path_info, must_exist=True):
-        """
-        split the html-GET path information and build the absolute filesystem
-        path.
-        if must_exist==True: The given path must allready exists.
-        """
-        if contains_char(path_info, BAD_DIR_CHARS):
-            raise Http404(_(u"Error: Bad character found!"))
-
-        path_info = os.path.normpath(path_info)
-
-        if len(path_info) == 1:
-            # e.g. edit a file in the base_path root
-            base_no = path_info
-            rel_path = ""
-        else:
-            try:
-                base_no, rel_path = path_info.split("/", 1)
-            except ValueError:
-                raise Http404(_("Wrong path!"))
-
-        try:
-            base_path = BASE_PATHS_DICT[base_no]
-        except KeyError:
-            raise Http404(_("Wrong basepath!"))
-
-        base_path = os.path.normpath(base_path)
-        abs_base_path = os.path.abspath(base_path)
-
-        abs_path = os.path.normpath(os.path.join(abs_base_path, rel_path))
-        if must_exist and not os.path.exists(abs_path):
-            raise Http404(_("Error: Path '%s' doesn't exist.") % abs_path)
-
-        self["base_no"] = base_no
-        self["base_path"] = base_path
-        self["abs_base_path"] = abs_base_path
-        self["rel_path"] = rel_path
-        self["abs_path"] = abs_path
-        self["url_path"] = os.path.normpath(os.path.join(base_no, rel_path))
-
-
-    def new_filename_path(self, file_path, must_exist=True):
-        """
-        Split a html GET path information witch contains a filename.
-        if must_exist==True: The file must exist in the given path.
-        """
-        path_info, filename = os.path.split(file_path)
-
-        self.new_dir_path(path_info, must_exist)
-
-        if contains_char(filename, BAD_FILE_CHARS):
-            raise Http404(_(u"Error: Bad character found!"))
-
-        abs_file_path = os.path.join(self["abs_path"], filename)
-
-        if must_exist and not os.path.isfile(abs_file_path):
-            raise Http404(_("Error: File '%s' doesn't exist.") % filename)
-
-        self["filename"] = filename
-        self["abs_file_path"] = abs_file_path
-
-    #--------------------------------------------------------------------------
-
-    def get_abs_link(self, item=""):
-        """
-        returns a absolute link to the given item.
-        """
-        return os.path.join("/", self["base_path"], self["rel_path"], item)
-
-    #--------------------------------------------------------------------------
-
-    def debug(self):
-        """
-        write debug information into the page_msg
-        """
-        self.page_msg("path debug:")
-        for k,v in self.items():
-            self.page_msg(" - %15s: '%s'" % (k,v))
-
-#______________________________________________________________________________
-
-class filemanager(PyLucidBasePlugin):
+class filemanager(FilesystemPlugin):
     """
     The PyLucid plugin class.
     """
-    def __init__(self, context, response, plugin_name):
-        super(filemanager, self).__init__(context, response, plugin_name)
-        self.path = Path(context)
-
-    #--------------------------------------------------------------------------
-
     def get_filelist(self):
         """
@@ -306 +192 @@
                 "name": "..",
                 "link": self.URLs.methodLink(
-                    method_name="filelist", args=(self.path["base_no"], updir)
+                    method_name="filelist", args=(self.path["base_key"], updir)
                 ),
                 "is_dir": True,
@@ -370 +256 @@
         # start with the first base_path entry:
         dir_links = [{
-            "name": self.path["base_path"], # use only the short relative path
+            "name": self.path["base_fs_path"], # use only the short relative path
             "title": self.path["abs_path"],
             "link": self.URLs.methodLink(
-                method_name="filelist", args=self.path["base_no"]
+                method_name="filelist", args=self.path["base_key"]
             ),
         }]
@@ -383 +269 @@
                 dir_links.append({
                     "name": name,
-                    "title": os.path.join(self.path["base_path"], path),
+                    "title": os.path.join(self.path["base_fs_path"], path),
                     "link": self.URLs.methodLink(
                         method_name="filelist",
-                        args=(self.path["base_no"], path)
+                        args=(self.path["base_key"], path)
                     ),
                 })
@@ -571 +457 @@
         # Change the global page title:
         self.context["PAGE"].title = _("Filemanager - Change the basepath")
-#        self.page_msg(self.request.POST)
-
-        if self.request.method == 'POST':
-            form = SelectBasePathForm(self.request.POST)
-            if form.is_valid():
-                path_no = form.cleaned_data["base_path"]
-                new_path = BASE_PATHS_DICT[path_no]
-                if not os.path.isdir(new_path):
-                    self.page_msg.red(
-                        "Error: Path '%s' doesn't exist" % new_path
-                    )
-                else:
-                    self.page_msg("change base path to '%s'." % new_path)
-                    # Display the filelist:
-                    return self.filelist(path_no + "/")
+        
+        context = {}
+
+        path_key = self.basepath_form(context)
+        if not path_key:
+            self._render_template("select_basepath", context)#, debug=True)
         else:
-            form = SelectBasePathForm()
-
-        self._render_template("select_basepath", {"form": form})#, debug=True)
+            # POST with valide form data -> display the filelist
+            self.filelist(path_key + u"/")            
 
     #--------------------------------------------------------------------------
@@ -597 +473 @@
         List dir and file. Some actions.
         rest: path to dir or file
-        """
+        """        
         if not path_info:
             self.select_basepath()
@@ -607 +483 @@
 
         # Change the global page title:
-        path = os.path.join(self.path["base_path"], self.path["rel_path"])
+        path = os.path.join(self.path["base_fs_path"], self.path["rel_path"])
         self.context["PAGE"].title = _("File list - %s" % path)
 
@@ -691 +567 @@
             ),
         }
-#        self.page_msg(context)
-#        self._render_template("filelist", context, debug=True)
+        #self.page_msg(context)
         self._render_template("filelist", context)#, debug=True)
 

trunk/pylucid_project/PyLucid/settings_example.py

@@ -177 +177 @@
 ADMIN_MEDIA_PREFIX = "/django/contrib/admin/media/"
 
-# Base path for the filemanager plugin
-# You can add more path for the plugin.
-FILEMANAGER_BASEPATHS = (
-    MEDIA_ROOT,
-    #"./static/",
-)
+# Base path for all filesystem bases plugins, e.g. Filemanager, Gallery
+# The dict key would be inserted into the url.
+# Every item is a tupel containing the filesystem path and the url.
+# You can add more path, if you need them!
+FILESYSTEM_BASEPATHS = {
+    "media": (MEDIA_ROOT, MEDIA_URL),
+    # "downloads": ("/var/www/media/downloads/", "/downloads/"),
+    # "my files": ("./my_static_files/", "http://static.your_domain.net/"),
+    # ...
+}
 
 """

trunk/pylucid_project/PyLucid/tools/path_manager.py

@@ -23 +23 @@
 else:
     from django.conf import settings
-
-#______________________________________________________________________________
-# Build a list and a dict from the basepaths
-# The dict key is a string, not a integer. (GET/POST Data always returned
-# numbers as strings)
-
-BASE_PATHS = [
-    (str(no), unicode(path)) for no, path in enumerate(
-                                                settings.FILEMANAGER_BASEPATHS)
-]
-BASE_PATHS_DICT = dict(BASE_PATHS)
 
 #______________________________________________________________________________