Changeset 1713

Timestamp:

07/24/08 16:16:21 (11 months ago)

Author:

JensDiemer

Message:

blog update 2:

• nicer "create blog entry" form (existing tags can be selected)
  
• some code cleanup
  
• try to verify tag slugs
  

Location:

trunk/pylucid

Files:

• media/PyLucid/internal_page/blog/display_blog.html (modified) (2 diffs)
• PyLucid/plugins_internal/blog/blog.py (modified) (11 diffs)
• PyLucid/plugins_internal/blog/forms.py (modified) (2 diffs)
• PyLucid/plugins_internal/blog/models.py (modified) (3 diffs)
• PyLucid/tools/newforms_utils.py (modified) (3 diffs)

trunk/pylucid/media/PyLucid/internal_page/blog/display_blog.html

@@ -100 +100 @@
 {% endfor %}
 
+{% if back_url %}<p><a href="{{ back_url }}" class="action_link">&laquo;  Display all blog entries</a></p>{% endif %}
+{% if create_url %}<p><a href="{{ create_url }}" class="action_link">create a new blog entry</a></p>{% endif %}
+
 <fieldset class="tag_cloud"><legend>{% trans 'tag cloud' %}</legend>
     <ul>
@@ -121 +124 @@
     </ul>
 </fieldset>
-
-{% if back_url %}<p><a href="{{ back_url }}" class="action_link">&laquo;  Display all blog entries</a></p>{% endif %}
-{% if create_url %}<p><a href="{{ create_url }}" class="action_link">create a new blog entry</a></p>{% endif %}

trunk/pylucid/PyLucid/plugins_internal/blog/blog.py

@@ -244 +244 @@
         """
         slug = urlargs.strip("/")
-        # TODO: Verify tag
-        tag_obj = BlogTag.objects.get(slug = slug)
+        # TODO: Exist there a better way to verify the tag slug?
+        for char in (" ", "/", ";"):
+            if char in slug:
+                return self.error(
+                    _("Wrong URL."), "Not allowed character in tag name!"
+                )
+
+        try:
+            tag_obj = BlogTag.objects.safe_get(slug)
+        except BlogTag.DoesNotExist, err:
+            return self.error(
+                _("Wrong URL."), "tag '%s' unknown: %s" % (slug, err)
+            )
 
         self.current_page.title += (
@@ -278 +289 @@
             #self.page_msg(self.request.POST)
             if form.is_valid():
+                new_tags = form.cleaned_data.pop("new_tags") # ListCharField
                 if blog_obj == None:
                     # a new blog entry should be created
                     blog_obj = BlogEntry(
-                        headline = form.cleaned_data["headline"],
-                        content = form.cleaned_data["content"],
-                        markup = form.cleaned_data["markup"],
+                        headline  = form.cleaned_data["headline"],
+                        content   = form.cleaned_data["content"],
+                        markup    = form.cleaned_data["markup"],
                         is_public = form.cleaned_data["is_public"],
-                        createby = self.request.user,
+                        createby  = self.request.user,
                     )
                     blog_obj.save()
                     self.page_msg.green("New blog entry created.")
-                    tags_string = form.cleaned_data["tags"]
                 else:
                     # Update a existing blog entry
-                    tags_string = form.cleaned_data.pop("tags")
                     self.page_msg.green("Update existing blog entry.")
                     blog_obj.lastupdateby = self.request.user
@@ -298 +308 @@
                         setattr(blog_obj, k, v)
 
-                tag_objects, new_tags = BlogTag.objects.get_or_creates(
-                    tags_string
-                )
-                if new_tags:
-                    self.page_msg(_("New tags created: %s") % new_tags)
-
-                # Add many-to-many
-                for tag in tag_objects:
-                    blog_obj.tags.add(tag)
+                if new_tags != []:
+                    # There are new tags to create incoming via ListCharField
+                    # Create the new tags and add them to the blog entry
+                    new_tags = BlogTag.objects.add_new_tags(new_tags, blog_obj)
+                    if new_tags:
+                        self.page_msg(_("New tags created: %s") % new_tags)
 
                 blog_obj.save()
@@ -314 +321 @@
             if blog_obj == None:
                 context["legend"] = _("Create a new blog entry")
-
                 form = BlogEntryForm(
-                    initial={
-                        "markup": self.preferences["default_markup"],
-                    }
+                    initial={"markup": self.preferences["default_markup"],}
                 )
             else:
                 context["legend"] = _("Edit a existing blog entry")
-                form = BlogEntryForm(
-                    instance=blog_obj,
-                    initial={"tags":blog_obj.get_tag_string()}
-                )
+                form = BlogEntryForm(instance=blog_obj)
 
         context["form"]= form
@@ -471 +472 @@
                 "Comment contains mod_keyword: '%s'" % mod_keyword
             )
-
 
 
@@ -499 +499 @@
             is_public = False
         else:
-            self.submit_msg("Blog comment published.")
-            mail_title = _("Blog comment published.")
+            msg = _("Blog comment published.")
+            self.submit_msg(msg)
+            mail_title = msg
             is_public = True
 
@@ -618 +619 @@
             return
 
-#        CommentForm = AdminCommentForm
-#
-#
-#        CommentForm = forms.form_for_instance(
-#            instance=comment_entry#, form=BlogCommentForm
-#        )
-
         blog_entry = comment_entry.blog_entry # ForeignKey("BlogEntry")
 
         if self.request.method == 'POST':
-#            form = CommentForm(self.request.POST)
             form = AdminCommentForm(self.request.POST, instance=comment_entry)
             #self.page_msg(self.request.POST)
@@ -641 +634 @@
                 )
         else:
-#            form = CommentForm()
             form = AdminCommentForm(instance=comment_entry)
 
@@ -717 +709 @@
         Build the tag cloud context.
         """
-        tags = BlogTag.objects.all()
-
-        frequency = set()
-        # get the counter information
-        for tag in tags:
-            count = tag.blogentry_set.count()
-            tag.count = count
-            #self.page_msg(tag, count)
-            frequency.add(count)
-
-        min_frequency = float(min(frequency))
-        max_frequency = float(max(frequency))
+        tags, min_frequency, max_frequency = BlogTag.objects.get_tag_info()
+
         diff_frequency = float(max_frequency - min_frequency)
 
@@ -757 +739 @@
         feed_name = raw_feed_name.strip("/")
 
-        # Verify the feed name
+        # Verify raw_feed_name
         try:
             self._feed_info_by_filename(feed_name)
@@ -799 +781 @@
             tag_slug = feed_name[len(TAG_FEED_PREFIX):]
             try:
-                tag_obj = BlogTag.objects.get(slug = tag_slug)
+                tag_obj = BlogTag.objects.safe_get(tag_slug)
             except BlogTag.DoesNotExist, err:
                 raise WrongFeedFilename(

trunk/pylucid/PyLucid/plugins_internal/blog/forms.py

@@ -20 +20 @@
 from django.utils.translation import ugettext as _
 
-from PyLucid.tools.newforms_utils import StripedCharField
+from PyLucid.tools.newforms_utils import StripedCharField, ListCharField
 
 # from blog plugin
@@ -58 +58 @@
         )
 
-
 class BlogEntryForm(forms.ModelForm):
     """
     Form for create/edit a blog entry.
     """
-    content = forms.CharField(
-        widget=forms.Textarea(attrs={'rows': '15'}),
+    new_tags = ListCharField( # New field, (no field from BlogEntry model)
+        max_length=255, required=False,
+        help_text=_(
+            "New tags for this entry, if there not in the list above"
+            " (separated by spaces.)"
+        ),
+        widget=forms.TextInput(attrs={'class':'bigger'}),
     )
 
-    tags = forms.CharField(
-        max_length=255, required=False,
-        help_text=_("Tags for this entry (separated by spaces.)"),
-        widget=forms.TextInput(attrs={'class':'bigger'}),
-    )
+    def __init__(self, *args, **kwargs):
+        """
+        set some widget attributes
+        """
+        super(BlogEntryForm, self).__init__(*args, **kwargs)
+
+        # Limit the MultipleChoiceField size
+        # Is there are a better way to do this? See:
+        # http://www.python-forum.de/topic-15503.html (de)
+        self.fields['tags'].widget.attrs["size"] = 7
+
+        # makes the content textarea bigger
+        self.fields['content'].widget.attrs["rows"] = 15
+
     class Meta:
         model = BlogEntry

trunk/pylucid/PyLucid/plugins_internal/blog/models.py

@@ -87 +87 @@
 
 
+BAD_TAG_SLUG_CHARS = (" ", "/", ";")
 class BlogTagManager(models.Manager):
     """
     Manager for BlogTag model.
     """
-    def get_or_creates(self, tags_string):
-        """
-        split the given tags_string and create not existing tags.
-        returns a list of all tag model objects and a list of all created tags.
-        """
-        tag_objects = []
+    def safe_get(self, slug):
+        """
+        Get a tag entry by slug. Try to verify the slug before we access the
+        database. Should be used, if the slug comes from the Client
+        (e.g. via url)
+        TODO: Exist there a better way to verify the tag slug?
+        """
+        slug = slug.strip("/") # If it comes from url args
+        for char in BAD_TAG_SLUG_CHARS:
+            if char in slug:
+                raise self.model.DoesNotExist("Not allowed character in tag name!")
+
+        return self.model.objects.get(slug = slug)
+
+    def add_new_tags(self, tag_list, blog_obj):
+        """
+        Create new tag entries and add it to the given blog entry.
+        Skip existing tags and returns only the new created tags.
+        """
         new_tags = []
-        for tag_name in tags_string.split(" "):
-            tag_name = tag_name.strip().lower()
+        for tag_name in tag_list:
             try:
                 tag_obj = self.get(name = tag_name)
@@ -106 +119 @@
                 tag_obj = self.create(name = tag_name, slug = tag_name)
 
-            tag_objects.append(tag_obj)
-
-        return tag_objects, new_tags
+            # Add many-to-many
+            blog_obj.tags.add(tag_obj)
+
+        return new_tags
+
+    def get_tag_info(self):
+        """
+        Returns all tags with the additional information:
+         * tag.count     - How many blog entries used this tag?
+
+        returns min_frequency and max_frequency, too: The min/max usage of all
+        tags. Needed to build a tag cloud.
+        """
+        tags = self.model.objects.all()
+
+        frequency = set()
+        # get the counter information
+        for tag in tags:
+            count = tag.blogentry_set.count()
+            tag.count = count
+            frequency.add(count)
+
+        min_frequency = float(min(frequency))
+        max_frequency = float(max(frequency))
+
+        return tags, min_frequency, max_frequency
+
+#    def get_tag_choices(self):
+#        """
+#        returns >count< tags witch are the most used tags.
+#        """
+#        tags, min_frequency, max_frequency = self.get_tag_info()
+#
+#        tags = sorted(tags, key=lambda x: x.count, reverse=True)
+#
+#        choices = tuple([(t.id, t.name) for t in tags])
+#        return choices
 
 
@@ -114 +161 @@
     """
     A blog entry tag
+    TODO: Add a usage counter! So we can easy sort from more to less usages and
+          building a tag cloud is easier.
     """
     objects = BlogTagManager()

trunk/pylucid/PyLucid/tools/newforms_utils.py

@@ -15 +15 @@
 
 from django import newforms as forms
+from django.newforms import ValidationError
 from django.utils.encoding import smart_unicode
 
@@ -87 +88 @@
     """
     Same as forms.CharField but stripes the output.
-    
+
     >>> f = StripedCharField()
     >>> f.clean('\\n\\n[\\nTEST\\n]\\n\\n')
@@ -97 +98 @@
 
 
+class ListCharField(forms.CharField):
+    """
+    Items seperated by spaces.
+
+    >>> f = ListCharField()
+    >>> f.clean(' one two  tree')
+    [u'one', u'two', u'tree']
+    """
+    def clean(self, value):
+        raw_value = super(ListCharField, self).clean(value)
+        value = raw_value.strip()
+        items = [i.strip() for i in value.split(" ")]
+        items = [i for i in items if i] # eliminate empty items
+        return items
+
+
+class InternalURLField(forms.CharField):
+    """
+    Uses e.g. for back urls via a http GET parameter
+    validates the URL and check if is't a internal url and not
+    a external.
+
+    >>> f = InternalURLField()
+    >>> f.clean('/a/foobar/url/')
+    u'/a/foobar/url/'
+
+    >>> f.clean('http://eval.domain.tld')
+    Traceback (most recent call last):
+        ...
+    ValidationError: [u'Open redirect found.']
+
+    >>> f = InternalURLField(must_start_with="/_command/")
+    >>> f.clean('/_command/a/foobar/url/')
+    u'/_command/a/foobar/url/'
+
+    >>> f.clean('/a/wrong/url/')
+    Traceback (most recent call last):
+        ...
+    ValidationError: [u'Open redirect found.']
+    """
+    default_error_message = "Open redirect found."
+
+    def __init__(self, must_start_with=None, *args, **kwargs):
+        self.must_start_with = must_start_with
+        super(InternalURLField, self).__init__(*args, **kwargs)
+
+    def clean(self, value):
+        value = super(InternalURLField, self).clean(value)
+        if "://" in value:
+            raise ValidationError(self.default_error_message)
+        if self.must_start_with and not value.startswith(self.must_start_with):
+            raise ValidationError(self.default_error_message)
+        return value
+
+
+
 if __name__ == "__main__":
     import doctest