Changeset 102

Timestamp:

04/09/08 00:17:10 (8 months ago)

Author:

pragma

Message:

Dirty Commit - code has not been tested, please use previous revision

• Refactored controllers to use method decorators on the various page handlers
  
• Added alternate (non-HTML) content support
  

Page handlers can now be bound to multiple mimetypes and corresponding .cs templates. While not the
most flexible approach, this allows for very easy integration for RSS, CSV, HTML and plain-text output
to co-exist from the same controller content hook. Now a mimetype is simply defined by what .cs template
generates its output. The various links at the footer of the page are also driven from the same dynamic
information (thanks to method decorators).

Files:

• trunk/tracforums/model.py (modified) (1 diff)
• trunk/tracforums/models/avatar.py (modified) (2 diffs)
• trunk/tracforums/models/forum.py (modified) (7 diffs)
• trunk/tracforums/models/main.py (modified) (6 diffs)
• trunk/tracforums/models/message.py (modified) (4 diffs)
• trunk/tracforums/models/profile.py (modified) (6 diffs)
• trunk/tracforums/models/topic.py (modified) (6 diffs)
• trunk/tracforums/orm.py (modified) (5 diffs)
• trunk/tracforums/web_ui.py (modified) (4 diffs)

trunk/tracforums/model.py

@@ -246 +246 @@
-        UIContext.__init__(self,req,env,db)
-        
+        # build up the handlers
+        memberMap = self.__class__.__dict__
+        self.handlerMap = {}
+        for name in memberMap:
+            member = memberMap[name]
+            if isinstance(member,IPageHandler):
+                for name in member.getPageNames():
+                    self.handlerMap[name] = member
+        
-    def __getitem__(self,name):
-
-
-
+
+
+
+
-        
-    def assertAction(self,test,message):
-        if not test:
-            raise TracError(message)
+            
+    def supports(self,view,mimetype):
+        return view in self.handlerMap and self.handlerMap[view].supports(mimetype)
+            
+    def invoke(self,view,mimetype):
+        if view in self.handlerMap:
+            return self.handlerMap[view][mimetype](self)
+        else:
+            raise TracError("Unknown handler '" + view + "'")
+
+            
+class IPageHandler:
+    def getPageNames(self):            pass
+    def __call__(self,*args,**kwargs): pass
+    def __getitem__(self,format):      pass
+    def getInner(self,format):         pass
+    def supports(self,format):         pass
+            
+def PageHandler(pageNames,mimetypeTemplateMap):
+    """
+        Decorator for Controller methods.  Supply a list of page names and a 
+        mimetype:template map to bind a method for page handling.
+        
+        Access a specific type handler via the array index operator: handler["html"].
+        
+        Call directly (__call__) to default to the 'html' type.
+        
+        Returns a (templateName,assetMap) tuple
+    """
+    class PageHandlerImpl(IPageHandler):
+        def getPageNames(self): return self.pageNames
+    
+        def __init__(self,func):
+            self.func = func
+            self.mimetypeTemplateMap = mimetypeTemplateMap
+            
+            if isinstance(pageNames,list):
+                self.pageNames = pageNames
+            else:
+                self.pageNames = [pageNames,]
+            
+        def __call__(self,*args,**kwargs):
+            return self.getInner('text/html')(*args,**kwargs)
+            
+        def __getitem__(self,mimetype):
+            return self.getInner(mimetype)
+        
+        def getInner(self,mimetype):
+            if mimetype in self.mimetypeTemplateMap:
+                def innerFunc(*args,**kwargs):
+                    return (self.mimetypeTemplateMap[mimetype],self.func(*args,**kwargs),mimetype)
+                return innerFunc
+            else:
+                raise TracError("Unknown or unsupported mimetype '" + mimetype + "'")
+                
+        def supports(self,mimetype):
+            return mimetype in self.mimetypeTemplateMap
+       
+    return PageHandlerImpl
+    
+    
+def ContentHandler(pageNames):
+    """
+        Decorator for Controller methods.  Supply a list of page names to handle.
+        The decorated handle is responsible for returning the (template,assets,type) tuple
+        
+        Returns a (templateName,assetMap,mimetype) tuple
+    """        
+    class PageHandlerImpl(IPageHandler):
+        def getPageNames(self): return self.pageNames
+    
+        def __init__(self,func):
+            self.func = func
+            
+            if isinstance(pageNames,list):
+                self.pageNames = pageNames
+            else:
+                self.pageNames = [pageNames,]
+            
+        def __call__(self,*args,**kwargs):
+            return self.getInner(None)(*args,**kwargs)
+            
+        def __getitem__(self,mimetype):
+            return self.getInner(mimetype)
+        
+        def getInner(self,mimetype):
+            def innerFunc(*args,**kwargs):
+                return self.func(*args,**kwargs)
+            return innerFunc
+                
+        def supports(self,format):
+            return True
+       
+    return PageHandlerImpl    

trunk/tracforums/models/avatar.py

@@ -184 +184 @@
-        Controller.__init__(self,req,env,db)
-        
+    @ContentHandler(["img","default"])
-    def doView(self):
-        args = self.getArgs()
@@ -189 +190 @@
-
-        self.renderAsFile(avatar.getTargetPath(),avatar.mimetype)
-
-
-
-
-
-
+

trunk/tracforums/models/forum.py

@@ -195 +195 @@
-    def __init__(self,req,env,db):
-        Controller.__init__(self,req,env,db)
-
+
+
+
+
-    def doView(self):
-        args = self.getArgs()
@@ -234 +237 @@
-            validateErrors = e.reasons
-                                         
-("forum/view.cs",
+
-            "returnto": self.req.abs_href.forums() + "/forum/view/" + str(forum.id),
-            "forum": forum,
@@ -240 +243 @@
-            "topics": TopicModelWithLeadMessage(self.db,self).getMany({"forumid": forum.id}),
-            "watching": ForumWatchModelWithProfile(self.db,self).getMany({"forumid": forum.id}),
-
-
+
+
+
+
+
-    def doEdit(self):
-        args = self.getArgs()
@@ -282 +288 @@
-        print "\nforum:",forum
-        
-("forum/edit.cs",
+
-            "returnto": args.get("returnto",None),
-            "forum": forum,
@@ -289 +295 @@
-            "forum_description_rows": self.getSessionVar("forum_description_rows",8),
-            "validateErrors": validateErrors
-
-
+
+
+
+
+
-    def doManage(self):
-        args = self.getArgs()
@@ -346 +355 @@
-            validateErrors = e.reasons        
-                 
-("forum/manage.cs",
+
-            "returnto": self.req.abs_href.forums() + "/forum/manage/" + str(forum.id),
-            "forum": forum,
@@ -353 +362 @@
-            "canMoveForums": self.isForumAdmin(),
-            "forums": ForumModel(self.db,self).getMany({"projectid": self.getProjectId()}),
-
-
-
-
-
-
-
-
+

trunk/tracforums/models/main.py

@@ -6 +6 @@
-    def __init__(self,req,env,db):
-        Controller.__init__(self,req,env,db)
-
+
+
+
+
+
-    def doIndex(self):
-        self.assertAction(
@@ -55 +59 @@
-            if forum.canView: plainForums.append(forum)
-                
-("main/index.cs",
+
-            "returnto": self.req.abs_href.forums() + "main/index",
-            "validateErrors": validateErrors,
@@ -63 +67 @@
-            "canWatch": self.isForumUser(),
-            "watching": ProjectWatchModelWithProfile(self.db,self).getMany({"projectid": self.getProjectId()}),
-
-
+
+
+
+
+
-    def doManage(self):
-        self.assertAction(
@@ -180 +187 @@
-        from tracforums.models.category import CategoryModelWithForums
-        from tracforums.models.forum import ForumModel 
-
-
+
+
+
-            "returnto": self.req.abs_href.forums() + "/main/manage/",
-            "validateErrors": validateErrors,
-            "canMoveProjects": self.isTracAdmin(),
-[{"id":"foobar","name":"Foobar Project"}], #TODO: project listing
+ProjectModel(self.db,self).getMany(),
-            "categories": CategoryModelWithForums(self.db,self).getMany({"projectid": self.getProjectId()}),
-            "forums": ForumModel(self.db,self).getMany({"projectid": self.getProjectId(),"categoryid":0})
-
-
+
+
+
+
+
+
-    def doRecent(self):
-        from tracforums.models.topic import TouchedTopic
@@ -197 +209 @@
-        for topic in TouchedTopic(self.db,self).getMany(query={"touched":False},params={"username":self.getAuthname()}):
-            if topic.forum.canView:
-     
+
-                print topic.touched
-        
-("main/recent.cs",
+
-            "topics": topics
-
-
+
+
+
+
+
-    def doProfiles(self):
-        self.assertAction(
@@ -212 +227 @@
-        from tracforums.models.profile import ProfileModelWithAvatar
-
-("main/profiles.cs",
+
-            "profiles": ProfileModelWithAvatar(self.db,self).getMany() #get all
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+

trunk/tracforums/models/message.py

@@ -46 +46 @@
-    )):
-    def format(self):
-        "MESSAGE FORMAT"
-        print ("MESSAGE FORMAT")
-        #TODO: replace with a smarter, wiki 'null formatter'
-        self.synopsis = self.body       
@@ -121 +119 @@
-        Controller.__init__(self,req,env,db)
-        
+    @PageHandler(["edit","default"],{
+        "text/html": "message/edit.cs"
+    })
-    def doEdit(self):
-        args = self.getArgs()
@@ -182 +183 @@
-        canSetAvatar = self.isForumAdmin or self.getAuthname() == message.username or message.id == 0
-                        
-("message/edit.cs",
+
-            "returnto": args.get("returnto",None),
-            "message": message,
@@ -192 +193 @@
-            "validateErrors": validateErrors,
-            "canSetAvatar": canSetAvatar
-
-
-
-
-
-
+

trunk/tracforums/models/profile.py

@@ -131 +131 @@
-        else:
-            return False
-
+
+
+
+
-    def doView(self):
-        args = self.getArgs()
@@ -161 +164 @@
-        moderatedForums = ModeratorModelWithForum(self.db,self).getMany({"username":profile.username})
-        
-("profile/view.cs",
+
-            "profile": profile,
-            "title": title,
-            "project": project.name,
-            "moderatedForums": moderatedForums
-
-
+
+
+
+
+
-    def doEdit(self):
-        args = self.getArgs()
@@ -189 +195 @@
-        profile = ProfileModelWithAssets(self.db,self).load({"profileid": args["viewid"]})
-        
-("profile/edit.cs",
+
-            "returnto": args.get("returnto",None),
-            "profile_bio_rows": self.getSessionVar('profile_bio_rows',8),
-            "profile":          profile,
-            "validateErrors":   validateErrors
-)
+
-         
+    @PageHandler("watches",{
+        "text/html": "profile/watches.cs"
+    })          
-    def doWatchLists(self):
-        args = self.getArgs()
@@ -254 +263 @@
-        
-        from tracforums.models.watch import CrossProjectWatchDetails,ForumWatchModelWithForum,TopicWatchModelWithTopic
-("profile/watches.cs",
+
-            "profile":        profile,
-            "watchedForums":  ForumWatchModelWithForum(self.db,self).getMany({"watchusername": profile.username,"projectid":self.getProjectId()}),
@@ -264 +273 @@
-                              )),
-            "validateErrors": validateErrors
-
-
+
+
+
+
+
-    def doManageAvatars(self):
-        args = self.getArgs()
@@ -331 +343 @@
-        
-        from tracforums.models.avatar import AvatarModelWithDetails
-("profile/avatars.cs",
+
-            "profile": profile,
-            "avatars": AvatarModelWithDetails(self.db,self).getMany({"username":profile.username}),
-            "validateErrors": validateErrors
-)
+
-       
-                

trunk/tracforums/models/topic.py

@@ -188 +188 @@
-    def canViewAll(self):
-        return self.isForumUser()
-
+
+
+
+
-    def doView(self):
-        args = self.getArgs()
@@ -233 +236 @@
-        from tracforums.models.forum   import ForumModel            
-        
-("topic/view.cs",
+
-            "returnto": self.req.abs_href.forums() + "/topic/view/" + str(topic.id),
-            "validateErrors": validateErrors,
@@ -243 +246 @@
-            }),
-            "watching": TopicWatchModelWithProfile(self.db,self).getMany({"topicid": topic.id})
-
-
+
+
+
+
+
-    def doEdit(self):
-        args = self.getArgs()
@@ -312 +318 @@
-               validateErrors = e.reasons
-                                                    
-("topic/edit.cs",
+
-            "returnto": args.get("returnto",None),
-            "topic": topic,
@@ -319 +325 @@
-            "message_body_rows": self.getSessionVar("message_body_rows",8),
-            "validateErrors": validateErrors
-
-
+
+
+
+
+
-    def doManage(self):
-        args = self.getArgs()
@@ -365 +374 @@
-            "canMoveMessages": self.isForumAdmin()
-        })
-        
-    templates = {
-        "view":    doView,
-        "edit":    doEdit,
-        "manage":  doManage,
-        "default": doView
-    }

trunk/tracforums/orm.py

@@ -347 +347 @@
-        
-    def doFormat(self,row,obj):
-
+#
-        isNull = True
-        for val in row:
@@ -353 +353 @@
-                isNull = False
-                value = self.getModel()(obj.db,obj.formatContext).mapRowToModel(row)
-
+#
-                value.format()
-                break
@@ -469 +469 @@
-            return ""
-        else:
-
-
+
-            return " order by " + ",".join(map(lambda x: x[0] + " " + x[1],orderby))       
-            
@@ -698 +697 @@
-                self.must(self.validateSave())
-                        
-
+#
-                cursor.execute(self.schema.updateSQL,self._getQueryValues())
-                self.db.commit()
@@ -704 +703 @@
-                self.must(self.validateCreate())
-               
-
+#
-                cursor.execute(self.schema.insertSQL,self._getQueryValues())
-                self.db.commit()

trunk/tracforums/web_ui.py

@@ -1 +1 @@
-from trac.core import *
-
+, add_link
-from trac.web.main import IRequestHandler
-from trac.wiki import wiki_to_html, wiki_to_oneliner
@@ -212 +212 @@
-        "message": MessageController,
-    }
+    
+    alternateFormats = {
+        "application/rss+xml":  ('alternate', '?format=rss', 'RSS Feed', 'application/rss+xml', 'rss')
+    }
+    
+    mimetypeMap = {
+        "html": "text/html",
+        "rss":  "application/rss+xml"
+    }
-        
-    """ The process_request handle in this class behaves like a state machine for 
@@ -218 +227 @@
-    def process_request(self,req):
-        req.args['authname'] = req.authname # grab authname here
-
+
-        db = get_forumDB(self.env)
-
+
+
-        if viewName in self.controllers:
-            controller = self.controllers[viewName](req,self.env,db)
-        else:
-            raise TracError("No such forum view: '" + viewName + "'")
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        
-        # set styles and links
@@ -241 +258 @@
-        add_script(req, "forums/js/forums.js")
-        
-        print assets        
-        req.hdf["forums"] = assets
-