Changeset 3906

Timestamp:

06/26/08 12:29:39 (5 months ago)

Author:

osimons

Message:

FullBlogPlugin: Major refactoring of the post naming to make it more flexible.

• Now supports any name that don't conflict with the few needed plugin 'commands' such as /edit/, /author/someone, /year/month etc.
  
• Also supports '/' in names for easier migration from wiki-based posts with migration script, and also allows flexible naming often requested.
  
• New setting for default_postname that also supports Python time string formatting substitution as well as the $USER variable. Setting also available in admin page.
  
• Refactored to make the path parsing (command + pagename) easier to comprehend and maintain. Similar treatment to the new post name checking.
  
• Improved the warning and notice logic for the user to provide relevant messages for all create situations I could think of.
  
• Added a notice (sidebar) on post naming that may just be over the top in hand-holding. Let me know what you think - happy to remove that one again.
  

Changes should close tickets #2460 and #2956.

Files:

• fullblogplugin/0.11/tracfullblog/admin.py (modified) (2 diffs)
• fullblogplugin/0.11/tracfullblog/core.py (modified) (5 diffs)
• fullblogplugin/0.11/tracfullblog/templates/fullblog_admin.html (modified) (1 diff)
• fullblogplugin/0.11/tracfullblog/templates/fullblog_edit.html (modified) (3 diffs)
• fullblogplugin/0.11/tracfullblog/util.py (modified) (1 diff)
• fullblogplugin/0.11/tracfullblog/web_ui.py (modified) (13 diffs)

fullblogplugin/0.11/tracfullblog/admin.py

@@ -39 +39 @@
-                self.env.config.set('fullblog', 'num_items_front',
-                    req.args.get('numpostsfront'))
+                self.env.config.set('fullblog', 'default_postname',
+                    req.args.get('defaultpostname'))
-                self.env.config.save()
-            elif req.args.get('savebloginfotext'):
@@ -55 +57 @@
-        blog_admin['numpostsfront'] = self.env.config.getint(
-                                            'fullblog', 'num_items_front')
+        blog_admin['defaultpostname'] = self.env.config.get(
+                                            'fullblog', 'default_postname')
-        
-        return ('fullblog_admin.html', {'blog_admin': blog_admin})

fullblogplugin/0.11/tracfullblog/core.py

@@ -11 +11 @@
-"""
-
+from time import strftime
+
-from genshi.builder import tag
-
-from trac.attachment import ILegacyAttachmentPolicyDelegate
-from trac.core import *
-Int
+
-from trac.perm import IPermissionRequestor
-from trac.resource import IResourceManager
-from trac.util.text import unicode_unquote
+from trac.util.datefmt import to_datetime, utc
-from trac.wiki.api import IWikiSyntaxProvider
-
@@ -24 +27 @@
-from api import IBlogChangeListener, IBlogManipulator
-from model import BlogPost, get_blog_resources
-
+
-
-class FullBlogCore(Component):
@@ -35 +38 @@
-    manipulators = ExtensionPoint(IBlogManipulator)
-    
+    implements(IPermissionRequestor, IWikiSyntaxProvider, IResourceManager,
+            ILegacyAttachmentPolicyDelegate)
+
-    # Options
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-    reserved_names = ['create', 'view', 'edit', 'delete',
-                    'archive', 'category', 'author']
-    
-    implements(IPermissionRequestor, IWikiSyntaxProvider, IResourceManager,
-            ILegacyAttachmentPolicyDelegate)
-
-    # IPermissionRequestor method
@@ -189 +195 @@
-        # Do basic checking for content existence
-        warnings.extend(bp.save(version_author, version_comment, verify_only=True))
-
-
-
-
-
+
+
-        # Check if any plugins has objections with the contents
-        fields = {
@@ -278 +281 @@
-            warnings.append(('', "Unknown error. Not deleted."))
-        return warnings
+
+    # Internal methods
+    
+    def _get_default_postname(self, user=''):
+        """ Parses and returns the setting for default_postname. """
+        opt = self.env.config.get('fullblog', 'default_postname')
+        if not opt:
+            return ''
+        # Perform substitutions
+        try:
+            now = to_datetime(None, utc).timetuple()
+            name = strftime(opt, now)
+            name = name.replace('$USER', user)
+            return name
+        except:
+            self.env.log.debug(
+                "FullBlog: Error parsing default_postname option: %s" % opt)
+            return ''
+
+    def _check_new_postname(self, req, name):
+        """ Does some checking on the postname to make sure it does
+        not conflict with existing commands. """
+        warnings = []
+        name = name.lower()
+        # Reserved names
+        for rn in self.reserved_names:
+            if name == rn:
+                warnings.append(('',
+                    "'%s' is a reserved name. Please change." % name))
+            if name.startswith(rn + '/'):
+                warnings.append(('',
+                    "Name cannot start with a reserved name as first item in "
+                    "path ('%s'). Please change." % rn))
+        # Check to see if it is a date range
+        items = name.split('/')
+        if len(items) == 2 and parse_period(items) != (None, None):
+            warnings.append(('',
+                "'%s' is seen as a time period, and cannot "
+                "be used as a name. Please change." % name))        
+        return warnings

fullblogplugin/0.11/tracfullblog/templates/fullblog_admin.html

@@ -22 +22 @@
-        <legend>Blog Settings:</legend>
-        <div class="field">
-
-
+<br />
+size="10" 
-                              value="${blog_admin.numpostsfront}" />
+         </label>
+        </div>
+        <div class="field">
+         <label for="defaultpostname">Template for naming new blog posts:<br />
+                (username and time substitution available, like <tt>${'$USER'}-%Y/%m/%d/my_topic</tt>)<br />
+           <input type="text" size="35" name="defaultpostname"
+                              value="${blog_admin.defaultpostname}" />
-         </label>
-        </div>

fullblogplugin/0.11/tracfullblog/templates/fullblog_edit.html

@@ -17 +17 @@
-    <div id="content" class="blog wiki">
-      
+    <py:with vars="is_create = not blog_edit.version;
+                   can_create = 'BLOG_CREATE' in perm('blog');
+                   is_edit = bool(blog_edit.version);
+                   can_edit = 'BLOG_MODIFY_ALL' in perm(blog_edit.resource) or defined(
+                        'blog_orig_author') or (
+                        perm.username==blog_edit.author and 'BLOG_MODIFY_OWN' in perm(blog_edit.resource));
+                   is_allowed = (is_create and can_create) or (is_edit and can_edit);
+                  ">
+
+      <div py:if="is_create and can_create" id="sidebar">
+        <p><em>Naming your blog posts.</em></p>
+        <p>When naming your posts (post shortname), it is recommended to make them URL friendly
+          (for instance avoid spaces).</p>
+        <p>Blog posts can also be referenced with <tt>[blog:postname]</tt> wiki link syntax,
+          so you may not want to make them too hard to read or write.</p>
+        <p>Some names are reserved and not allowed:</p>
+        <ul>
+          <li>'view', 'create', 'edit', 'archive', 'delete', 'category', 'author' -
+            either on their own or as first item in a path.</li>
+          <li>Numbers evaluating to N/M are seen as time periods and
+            used for month-based browsing.</li>
+        </ul>
+      </div>
+
-      <div id="main">
-      
@@ -22 +46 @@
-        <h1 py:if="blog_edit.version">Edit Blog Post</h1>
-
-        <py:with vars="is_create = not blog_edit.version;
-                       can_create = 'BLOG_CREATE' in perm('blog');
-                       is_edit = bool(blog_edit.version);
-                       can_edit = 'BLOG_MODIFY_ALL' in perm(blog_edit.resource) or defined(
-                            'blog_orig_author') or (
-                            perm.username==blog_edit.author and 'BLOG_MODIFY_OWN' in perm(blog_edit.resource));
-                       is_allowed = (is_create and can_create) or (is_edit and can_edit);
-                      ">
-          <div py:if="not is_allowed" class="system-message">You do not have the required permission to
-              ${is_create and 'create a blog post' or 'edit this blog post'}.</div>
@@ -101 +117 @@
-            </fieldset>
-          </form>
-        </py:with>
-
-      </div>
-
+    </py:with>
-    </div>
-

fullblogplugin/0.11/tracfullblog/util.py

@@ -33 +33 @@
-    """ Parses a list of items for elements of dates, and returns
-    a month as (from_dt, to_dt) if valid. (None, None) if not. """
->
+=
-        return None, None
-    try:

fullblogplugin/0.11/tracfullblog/web_ui.py

@@ -13 +13 @@
-import re
-from pkg_resources import resource_filename
-from trac.util.compat import itemgetter
-
-# Trac and Genshi imports
-from genshi.builder import tag
-from trac.attachment import AttachmentModule
-
+, IntOption
-from trac.core import *
-from trac.mimeview.api import Context
@@ -24 +23 @@
-from trac.search.api import ISearchSource, shorten_result
-from trac.timeline.api import ITimelineEventProvider
-
+, itemgetter
-from trac.util.datefmt import utc
-from trac.util.translation import _
@@ -46 +45 @@
-               ITemplateProvider)
-
+    # Options
+    
-    ListOption('fullblog', 'month_names',
-        doc = """Ability to specify a list of month names for display in groupings.
@@ -51 +52 @@
-        Enter list of 12 months like:
-        `month_names = January, February, ..., December` """)
+
-    BoolOption('fullblog', 'personal_blog', False,
-        """When using the Blog as a personal blog (only one author), setting to 'True'
-        will disable the display of 'Browse by author:' in sidebar, and also removes
-        various author links and references. """)
+
+    IntOption('fullblog', 'num_items_front', 20,
+        """Option to specify how many recent posts to display on the
+        front page of the Blog.""")
-
-    # INavigationContributor methods
@@ -90 +96 @@
-
-        blog_core = FullBlogCore(self.env)
-        default_pagename = blog_core.default_pagename
-        reserved_names = blog_core.reserved_names
-
-        format = req.args.get('format', '').lower()
-
-
-
-
+
+
-        action = req.args.get('action', 'view').lower()
-        try:
@@ -103 +104 @@
-        except:
-            version = 0
-        command = pagename = ''
-        command = (len(path_items) and path_items[0]) or ''
-        if command.lower() in [u'view', u'edit', 'delete'] and len(path_items) == 2:
-            pagename = path_items[1]
-        if command and command not in [
-                'view', 'edit', 'create', 'archive', 'delete']:
-            if len(path_items) == 1:
-                # Assume it is a request for a specific post
-                pagename = command
-                command = 'view'
-            else:
-                # Assume it is a listing, do further parsing later
-                command = 'listing'
-
-        data = {}
-
-        template = 'fullblog_view.html'
-        data['blog_about'] = BlogPost(self.env, 'about')
@@ -202 +189 @@
-        elif command in ['create', 'edit']:
-            template = 'fullblog_edit.html'
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-            if command == 'edit':
-                req.perm(the_post.resource).require('BLOG_VIEW') # Starting point
@@ -220 +220 @@
-                    else:
-                        req.perm(the_post.resource).require('BLOG_MODIFY_ALL')
-
-
-
-
-
-
-
+
+
-                orig_author = the_post.author
-                if not the_post.update_fields(req.args):
@@ -249 +244 @@
-                        "edit the post again due to restricted permissions.")
-                    data['blog_orig_author'] = orig_author
-    
-    
-    
-    
-    add_warning(req, reason)                        
+
+
+
+
+add_warning(req, reason)
-            data['blog_edit'] = the_post
-
@@ -301 +296 @@
-                    add_warning(req, reason)                        
-
- == 'listing'
+.startswith('listing-')
-            # 2007/10 or category/something or author/theuser
-            title = category = author = ''
-
-
+
+
+
+
-                title = "Posts for the month of %s %d" % (
-                        blog_month_names[from_dt.month -1], from_dt.year)
@@ -311 +308 @@
-                        'application/rss+xml', 'rss')
-
-category = (path_items[0].lower() == 'category'
-        and path_items[1]) or ''
-
-
-add_link(req, 'alternate', req.href.blog('category', category, format='rss')
-
-author = (path_items[0].lower() == 'author'
-        and path_items[1]) or ''
-
-
-add_link(req, 'alternate', req.href.blog('author', author, format='rss')
-
+elif command == 'listing-category':
+category = listing_data['category']
+    
+    
+    add_link(req, 'alternate', req.href.blog('category', category
+    format='rss'), 
+elif command == 'listing-author':
+author = listing_data['author']
+    
+    
+    add_link(req, 'alternate', req.href.blog('author', author
+    format='rss'), 
-            if not (author or category or (from_dt and to_dt)):
-                raise HTTPNotFound("Not a valid path for viewing blog posts.")
@@ -336 +333 @@
-            raise HTTPNotFound("Not a valid blog path.")
-
- == 'listing'
+.startswith('listing-')
-            data['context'] = Context.from_request(req, absurls=True)
-            return 'fullblog.rss', data, 'application/rss+xml'
@@ -467 +464 @@
-        """ Location of Trac templates provided by plugin. """
-        return [resource_filename('tracfullblog', 'templates')]
+
+    # Internal methods
+
+    def _parse_path(self, req):
+        """ Parses the request path for the blog and returns a
+        ('command', 'pagename', 'path_items', 'listing_data') tuple. """
+        # Parse out the path and actions from args
+        path = req.args.get('blog_path', '')
+        path_items = path.split('/')
+        path_items = [item for item in path_items if item] # clean out empties
+        command = pagename = ''
+        listing_data = {}
+        from_dt, to_dt = parse_period(path_items)
+        if not path_items:
+            pass # emtpy default for return is fine
+        elif len(path_items) > 1 and path_items[0].lower() in ['view', 'edit', 'delete']:
+            command = path_items[0].lower()
+            pagename = '/'.join(path_items[1:])
+        elif len(path_items) == 1 and path_items[0].lower() == 'archive':
+            command = path_items[0].lower()
+        elif len(path_items) >= 1 and path_items[0].lower() == 'create':
+            command = path_items[0].lower()
+            pagename = req.args.get('name','') or (len(path_items) > 1 \
+                                                    and '/'.join(path_items[1:]))
+        elif len(path_items) > 1 and path_items[0].lower() in ['author', 'category']:
+            command = 'listing' + '-' + path_items[0].lower()
+            listing_data[path_items[0].lower()] = '/'.join(path_items[1:])
+        elif len(path_items) == 2 and (from_dt, to_dt) != (None, None):
+            command = 'listing-month'
+            listing_data['from_dt'] = from_dt
+            listing_data['to_dt'] = to_dt
+        else:
+            # A request for a regular page
+            command = 'view'
+            pagename = path
+        return (command, pagename, path_items, listing_data)