Changeset 31 for sitemap-plugin/trunk/src

Timestamp:

04/06/07 13:14:12 (5 years ago)

Author:

christian

Message:

• Fixed base url error by adding a configurable option
• Finished option handling UI
• Improved readme and installation instructions
• Downgraded embedded trac environment to sqlite2
• Improved eclipse setup

Location:

sitemap-plugin/trunk/src

Files:

• . (modified) (1 prop)
• setup.py (modified) (1 diff)
• sitemap/__init__.py (modified) (1 diff)
• sitemap/api.py (modified) (1 diff)
• sitemap/templates/sitemap_admin.cs (modified) (2 diffs)
• sitemap/ticket.py (modified) (6 diffs)
• sitemap/wiki.py (modified) (3 diffs)

sitemap-plugin/trunk/src/setup.py

@@ -10 +10 @@
         author_email = 'christian@wilde-welt.de',
         url = 'http://voidblog.de/wiki/GoogleSitemap',
-        description = 'Various sitemap generators',
+        description = 'Dynamic sitemap generation for the Google sitemap service',
         license='BSD',
         packages = ['sitemap'],

sitemap-plugin/trunk/src/sitemap/__init__.py

@@ -1 +1 @@
 import api
 import wiki
-import ticket
+# import ticket
 try:
     from admin_ui import *

sitemap-plugin/trunk/src/sitemap/api.py

@@ -154 +154 @@
     def send_ping(self):
         """Ping Google sitemaps to indicate that an updated sitemap is available"""
-        href = Href(self.env.abs_href)
+        href = self.base_url + '/sitemap.xml'
         url = 'http://www.google.com/webmasters/sitemaps/ping?' + \
               urlencode({'sitemap' : href})
         self.env.log.info('Sending ping to Google: %s ' % url)
-        urllib2.urlopen(url)
+        # urllib2.urlopen(url)
+
+
+class RessourceFactory:
+   """Convenience base class for content implementations, eg. wiki or ticket data converters"""
+   
+   def set_option(self, req, name, default=''):
+      tmp = default
+      if name in req.args:
+         tmp = req.args[name]
          
+      if self.env.config.get('sitemap', name) != tmp:
+         self.env.config.set('sitemap', name, tmp)
+            
+   def set_bool_option(self, req, name, default=None):
+      tmp = default
+      self.env.log.debug(req.args)
+      if name in req.args:
+         tmp = req.args[name] == '1'
+         self.env.log.debug('Value of ' + name + ' is ' + req.args[name])
+         
+      if self.env.config.getbool('sitemap', name) != tmp:
+         self.env.config.set('sitemap', name, tmp)
+            

sitemap-plugin/trunk/src/sitemap/templates/sitemap_admin.cs

@@ -2 +2 @@
 <h2>Google Sitemap&trade; settings</h2>
   <div class="field">
-   <label>Google page name:<br />
-    <input size="30" type="text" name="confirmationpage" value="<?cs var:sitemap.confirmationpage ?>" /> e.g. <em>googleeb3689b3689b3689.html</em>
+   <label>Google page name: <em>e.g. googleeb3689b3689b3689.html</em><br />
+    <input size="30" type="text" name="confirmationpage" value="<?cs var:sitemap.confirmationpage ?>" />
    </label>
   </div>
   <div class="field">
-   <label>Base url:<br />
+   <label>Base url: <em>will be extended with /sitemap.xml</em><br />
     <input size="60" type="text" name="base_url" value="<?cs var:sitemap.base_url ?>" style="width:100%" />
    </label>
@@ -30 +30 @@
                 <?cs each:item = sitemap.data ?>
                 <tr>
-                        <td align="center"><input type="checkbox" name="handle_<?cs name:item ?>" value="1" <?cs
-                        if:item.handle ?> checked="checked" <?cs /if ?> /></td>
+                        <td align="center"><input type="checkbox" name="<?cs name:item ?>_autoupdate" value="1" <?cs
+                        if:item.autoupdate == 1 ?> checked="checked" <?cs /if ?> /></td>
                         <td><strong><?cs var:item.title ?></strong></td>
                         <td><select name="<?cs name:item ?>_priority">

sitemap-plugin/trunk/src/sitemap/ticket.py

@@ -1 @@
-from api import SitemapController
+from api import *
 from trac.config import BoolOption
 import datetime
@@ -5 +5 @@
 from trac.core import Component
 from trac.core import implements
+from trac.ticket.api import ITicketChangeListener
+from trac.ticket.model import Ticket
 from trac.web.href import Href
-from trac.wiki.model import WikiPage
-from trac.wiki.api import WikiSystem
 from api import ISitemapContributor
 from api import RessourceData
 
-class TicketData(Component):
+class TicketData(Component, RessourceFactory):
     
-    implements(ISitemapContributor)
+    implements(ISitemapContributor, ITicketChangeListener)
 
     auto_update = BoolOption('sitemap', 'ticket_autoupdate', 'True',
@@ -22 +22 @@
        """Default change frequency for tickets""")
     
+    def _check_update(self):
+        if self.auto_update == True:
+            s = SitemapController(self.env)
+            s.send_ping()
+
     #ISitemapContributor methods
     def get_name(self):
@@ -33 +38 @@
         """
         return {
+            'autoupdate' : self.auto_update,
             'priority' : self.priority,
             'frequency' : self.frequency
@@ -39 +45 @@
     def set_configuration(self, req):
         """Update config to new values"""
+        self.set_bool_option(req, 'ticket_autoupdate')
+        self.set_option(req, 'ticket_priority')
+        self.set_option(req, 'ticket_frequency')
         
     
@@ -46 +55 @@
         wiki = WikiSystem(self.env)
         d = []
-        href = Href(self.env.base_url)
-        for pagename in wiki.get_pages():
-            page = WikiPage(self.env, pagename)
-            
-            version, post_time, author, comment, ipnr = page.get_history().next() #@UnusedVariable
-            if self.exclude_default:
-                if author == 'trac':
-                    continue
-            entry_time = datetime.datetime.utcfromtimestamp(post_time)
-            d.append(RessourceData(
-                                  href.wiki(pagename),
-                                  entry_time.strftime("%Y-%m-%dT%H:%M:%SZ"),
-                                  self.frequency,
-                                  self.priority
-                                  ))
         return d
         
+     #ITicketChangeListener methods
+    def ticket_created(ticket):
+        """Called when a ticket is created."""
+        self._check_update()
+
+    def ticket_changed(ticket, comment, author, old_values):
+        """Called when a ticket is modified.
+        
+        `old_values` is a dictionary containing the previous values of the
+        fields that have changed.
+        """
+        self._check_update()
+
+    def ticket_deleted(ticket):
+        """Called when a ticket is deleted."""
+        self._check_update()
+
+     

sitemap-plugin/trunk/src/sitemap/wiki.py

@@ -1 @@
-from api import SitemapController
+from api import *
 from trac.wiki.api import IWikiChangeListener
 from trac.config import BoolOption
@@ -12 +12 @@
 from api import RessourceData
 
-class WikiData(Component):
+class WikiData(Component, RessourceFactory):
     
     implements(ISitemapContributor, IWikiChangeListener)
@@ -41 +41 @@
         """
         return {
+            'autoupdate' : self.auto_update,
             'priority' : self.priority,
-            'frequency' : self.frequency
+            'frequency' : self.frequency,
+            'exclude_default' : self.exclude_default
         }
         
     def set_configuration(self, req):
         """Update config to new values"""
-        
+        self.set_bool_option(req, 'wiki_autoupdate')
+        self.set_option(req, 'wiki_priority')
+        self.set_option(req, 'wiki_frequency')
     
     def get_data(self, req):