hobix 0.4 → 0.6

data/lib/hobix/out/rss.rb

@@ -15,6 +15,7 @@
 #++
 require 'hobix/base'
 require 'rexml/document'
+require 'erb'
 
 module Hobix
 module Out
@@ -52,7 +53,7 @@ class RSS < Hobix::BaseOutput
 </rss>
 EOXML
         rssdoc << REXML::XMLDecl.new
-        rssdoc.elements['/rss/channel/title'].text = vars[:weblog].title
+        rssdoc.elements['/rss/channel/title'].text = rss_mangle( vars[:weblog].title )
         rssdoc.elements['/rss/channel/link'].text = vars[:weblog].link.to_s
         rssdoc.elements['/rss/channel/description'].text = vars[:weblog].tagline
         rssdoc.elements['/rss/channel/dc:date'].text = Time.now.utc.strftime( "%Y-%m-%dT%H:%M:%S+00:00" )
@@ -69,7 +70,7 @@ EOXML
         ( vars[:entries] || [vars[:entry]] ).each do |e|
             ele = REXML::Element.new 'item'
             ele_title = REXML::Element.new 'title'
-            ele_title.text = e.title
+            ele_title.text = rss_mangle( e.title )
             ele << ele_title
             ele_link = REXML::Element.new 'link'
             link = e.link.gsub(/'/,"%27")
@@ -99,17 +100,29 @@ EOXML
             ele_pubDate.text = ( e.modified || e.created ).dup.utc.strftime( "%Y-%m-%dT%H:%M:%S+00:00" )
             ele << ele_pubDate
             ele_desc = REXML::Element.new 'description'
-            ele_desc.text = 
+            ele_desc.attributes['xml:space'] = "preserve"
+            text = 
                 if @summaries && e.summary
                   e.summary.to_html + (@more_link ? %{<p><a href="#{e.link}">#@more_link</a></p>} : "")
                 else
                   e.content.to_html
                 end.gsub( /(src|href)="\//, "\\1=\"#{ vars[:weblog].link.rooturi }/" )
+            # Quote the text ourselves rather than letting REXML do it,
+            # due to REXML bug where it fails to quote e.g. &rarr;
+            REXML::Text.new ::ERB::Util.h( text ), true, ele_desc, true
             ele << ele_desc
             rssdoc.elements['/rss/channel'].add ele
         end
         rssdoc.to_s
     end
+
+private
+    def rss_mangle( string )
+      string = string.gsub( /&/, '[and]' )
+      string.gsub!( /</, '[less-than]' )
+      string.gsub!( />/, '[greater-than]' )
+      string
+    end
 end
 end
 end

data/lib/hobix/plugin/akismet.rb

@@ -0,0 +1,196 @@
+## akismet.rb -- Hobix akismet plugin
+##
+## Adds spam comment blocking to Hobix comments support.  It does this
+## using David Czarnecki's Ruby API (included in the plugin) for Akismet
+## (http://akismet.com/personal/).  When loaded comments that get submitted
+## are fed to Akismet on-line and rejected if they are considered to be
+## spam comments.
+##
+## Note that this plugin needs a network connection to verify the comments
+## and it needs an Akismet API key to function.  For personal use, Akismet
+## API keys are free and will be sent to you on signing up at WordPress.
+## See also: http://wordpress.com/signup/.
+##
+## USAGE:
+##
+## 1) In hobix.yaml (e.g. by running 'hobix edit <blogname>'), simply
+##    add 'hobix/plugin/akismet' to the 'required' block.
+##
+## required:
+## [...]
+## - hobix/plugin/akismet
+##
+## 2) Specify the API key you received/already had as parameter for the
+##    plugin.
+##
+## required:
+## [...]
+## - hobix/plugin/akismet:
+##     api-key: 123456789abc
+##
+##    And that's it!
+##
+## NOTES:
+##
+## 1) This plugin is not useful when the Hobix comments support is not loaded,
+##    i.e. 'hobix/comments' is not required.
+
+module Hobix
+	
+class AkismetKey < BasePlugin
+	
+  def initialize(weblog, params = {})
+    raise %{The Akismet plugin is not configured, the API key is missing. See hobix/plugin/akismet.rb for details} unless params.member?("api-key")
+    @@key = params["api-key"]
+  end
+
+  def self.key; @@key; end
+  
+end
+
+end
+
+# Akismet
+#
+# Author:: David Czarnecki
+# Copyright:: Copyright (c) 2005 - David Czarnecki
+# License:: BSD
+# Modified by Dieter Komendera, Sparkling Studios:
+#   append blog= to data string (Akismet said it is required)
+#   changed require 'net/HTTP' to require 'net/http' (to work for me unter GNU/Linux)
+
+class Akismet
+
+  require 'net/http'
+  require 'uri'
+  
+  STANDARD_HEADERS = {
+    'User-Agent' => 'Akismet Ruby API/1.0',
+    'Content-Type' => 'application/x-www-form-urlencoded'
+  }
+  
+  # Instance variables
+  @apiKey
+  @blog
+  @verifiedKey
+  @proxyPort = nil
+  @proxyHost = nil
+
+  # Create a new instance of the Akismet class
+  #
+  # apiKey 
+  #   Your Akismet API key
+  # blog 
+  #   The blog associated with your api key
+  
+  def initialize(blog, apiKey)
+    @apiKey = apiKey
+    @blog = blog
+    @verifiedKey = false
+  end
+  
+  # Set proxy information 
+  #
+  # proxyHost
+  #   Hostname for the proxy to use
+  # proxyPort
+  #   Port for the proxy
+  def setProxy(proxyHost, proxyPort) 
+    @proxyPort = proxyPort
+    @proxyHost = proxyHost
+  end
+    
+  # Call to check and verify your API key. You may then call the #hasVerifiedKey method to see if your key has been validated.
+  def verifyAPIKey()
+    http = Net::HTTP.new('rest.akismet.com', 80, @proxyHost, @proxyPort)
+    path = '/1.1/verify-key'
+    
+    data="key=#{@apiKey}&blog=#{@blog}"
+    
+    resp, data = http.post(path, data, STANDARD_HEADERS)
+    @verifiedKey = (data == "valid")
+  end
+ 
+  # Returns <tt>true</tt> if the API key has been verified, <tt>false</tt> otherwise
+  def hasVerifiedKey()
+    return @verifiedKey
+  end
+  
+  # Internal call to Akismet. Prepares the data for posting to the Akismet service.
+  #
+  # akismet_function
+  #   The Akismet function that should be called
+  # user_ip (required)
+  #    IP address of the comment submitter.
+  # user_agent (required)
+  #    User agent information.
+  # referrer (note spelling)
+  #    The content of the HTTP_REFERER header should be sent here.
+  # permalink
+  #    The permanent location of the entry the comment was submitted to.
+  # comment_type
+  #    May be blank, comment, trackback, pingback, or a made up value like "registration".
+  # comment_author
+  #    Submitted name with the comment
+  # comment_author_email
+  #    Submitted email address
+  # comment_author_url
+  #    Commenter URL.
+  # comment_content
+  #    The content that was submitted.
+  # Other server enviroment variables
+  #    In PHP there is an array of enviroment variables called $_SERVER which contains information about the web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet as how the submited content interacts with the server can be very telling, so please include as much information as possible.  
+  def callAkismet(akismet_function, user_ip, user_agent, referrer, permalink, comment_type, comment_author, comment_author_email, comment_author_url, comment_content, other)
+    http = Net::HTTP.new("#{@apiKey}.rest.akismet.com", 80, @proxyHost, @proxyPort)
+    path = "/1.1/#{akismet_function}"        
+    
+    data = "blog=#{@blog}&user_ip=#{user_ip}&user_agent=#{user_agent}&referrer=#{referrer}&permalink=#{permalink}&comment_type=#{comment_type}&comment_author=#{comment_author}&comment_author_email=#{comment_author_email}&comment_author_url=#{comment_author_url}&comment_content=#{comment_content}"
+    if (other != nil) 
+      other.each_pair {|key, value| data.concat("&#{key}=#{value}")}
+    end
+            
+    resp, data = http.post(path, data, STANDARD_HEADERS)
+
+    return (data != "false")
+  end
+  
+  protected :callAkismet
+
+  # This is basically the core of everything. This call takes a number of arguments and characteristics about the submitted content and then returns a thumbs up or thumbs down. Almost everything is optional, but performance can drop dramatically if you exclude certain elements.
+  #
+  # user_ip (required)
+  #    IP address of the comment submitter.
+  # user_agent (required)
+  #    User agent information.
+  # referrer (note spelling)
+  #    The content of the HTTP_REFERER header should be sent here.
+  # permalink
+  #    The permanent location of the entry the comment was submitted to.
+  # comment_type
+  #    May be blank, comment, trackback, pingback, or a made up value like "registration".
+  # comment_author
+  #    Submitted name with the comment
+  # comment_author_email
+  #    Submitted email address
+  # comment_author_url
+  #    Commenter URL.
+  # comment_content
+  #    The content that was submitted.
+  # Other server enviroment variables
+  #    In PHP there is an array of enviroment variables called $_SERVER which contains information about the web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet as how the submited content interacts with the server can be very telling, so please include as much information as possible.
+  def commentCheck(user_ip, user_agent, referrer, permalink, comment_type, comment_author, comment_author_email, comment_author_url, comment_content, other)
+    return callAkismet('comment-check', user_ip, user_agent, referrer, permalink, comment_type, comment_author, comment_author_email, comment_author_url, comment_content, other)
+  end
+  
+  # This call is for submitting comments that weren't marked as spam but should have been. It takes identical arguments as comment check.
+  # The call parameters are the same as for the #commentCheck method.
+  def submitSpam(user_ip, user_agent, referrer, permalink, comment_type, comment_author, comment_author_email, comment_author_url, comment_content, other)
+    callAkismet('submit-spam', user_ip, user_agent, referrer, permalink, comment_type, comment_author, comment_author_email, comment_author_url, comment_content, other)
+  end
+  
+  # This call is intended for the marking of false positives, things that were incorrectly marked as spam. It takes identical arguments as comment check and submit spam.
+  # The call parameters are the same as for the #commentCheck method.
+  def submitHam(user_ip, user_agent, referrer, permalink, comment_type, comment_author, comment_author_email, comment_author_url, comment_content, other)
+    callAkismet('submit-ham', user_ip, user_agent, referrer, permalink, comment_type, comment_author, comment_author_email, comment_author_url, comment_content, other)
+  end
+end

data/lib/hobix/plugin/calendar.rb

@@ -88,16 +88,11 @@ class Out::Quick
   def sidebar_erb
     sidebar_calendar_ssi
   end
-
-  ## overwrite the default day header so that we can jump to the
-  ## corresponding day in the main body of the monthly/yearly index
-  ## files
-  def day_header_erb; %{ <h2 class="dayHeader"><a name="<%= day.strftime( "%Y%m%d" ) %>"><%= day.strftime( "%A, %B %d, %Y" ) %></a></h2> }; end
 end
 
 class Weblog
   ## generate all the sidebar calendar files
-  def skel_sidebar(path_storage)
+  def skel_sidebar( path_storage, section_path )
     months = path_storage.get_months(storage.find)
 
     months.extend Hobix::Enumerable
@@ -105,7 +100,8 @@ class Weblog
       month_start, month_end, month_id = cur
 
       entries = path_storage.within(month_start, month_end)
-      page = Page.new SidebarCalendarPlugin.dir_to(month_start, false)
+      entry_path = SidebarCalendarPlugin.dir_to(month_start, false)
+      page = Page.new( entry_path, section_path )
       page.timestamp = month_start
       page.updated = Time.now #path_storage.last_modified(entries)
       page.prev = prev[0].strftime("/%Y/%m/") if prev
@@ -167,11 +163,11 @@ class Out::Quick
           title = d.strftime("%A, %B %e: " + (days[d] == 1 ? "one entry" : "#{days[d]} entries"))
           link = case index
                  when :yearly:
-                   d.strftime("/%Y/#%Y%m%d")
+                   d.strftime("/%Y/#day%Y%m%d")
                  when :monthly:
-                   d.strftime("/%Y/%m/#%Y%m%d")
+                   d.strftime("/%Y/%m/#day%Y%m%d")
                  else
-                   d.strftime("/%Y/%m/%d.html#%Y%m%d")
+                   d.strftime("/%Y/%m/%d.html#day%Y%m%d")
                  end
         %>
         <td class="sidebarCalendarLinkDay"><a title="<%= title %>" href="<%= weblog.expand_path link %>"><%= d.strftime("%e") %></a></td>
@@ -180,10 +176,6 @@ class Out::Quick
       <% end %>
     <% end %>
 
-    <% (7 - offset).times do %>
-      <td class="sidebarCalendarFiller"> &nbsp; </td>
-    <% end %>
-
     </tr>
   }
   end

data/lib/hobix/plugin/recent_comments.rb

@@ -60,9 +60,11 @@ class Hobix::Out::Quick
     <div class="sidebarBox">
     <h2 class="sidebarTitle">Recent Comments</h2>
     <ul>
-    <% recent_comments( weblog, weblog.storage.find, RecentCommentsPlugin.num ).each do |link, title, auth, created| %>
-      <li><a href="<%= link %>"><%= title %></a> by <%= auth %> on <nobr><%= created.strftime "%m/%d at %I:%M %P" %></nobr></li>
+    <% reccomm = recent_comments( weblog, weblog.storage.find, RecentCommentsPlugin.num ) %>
+    <% reccomm.each do |link, title, auth, created| %>
+      <li><a href="<%= link %>"><%= title %></a> by <%= auth %> on <nobr><%= created.strftime "%d %b at %H:%M" %></nobr></li>
     <% end %>
+    <%= "<li>No comments (yet)!</li>" if reccomm.empty? %>
     </ul>
     </div>
   }

data/lib/hobix/plugin/tags.rb

@@ -38,7 +38,7 @@ class Hobix::Out::Quick
         <ul>
         <% tags_list(weblog.storage.find).sort.each do |name, count| %>
           <li>
-            <a href="<%= weblog.link %>/tags/<%=name%>/index.html"><%= name
+            <a href="<%= weblog.expand_path "tags/#{ name }/" %>"><%= name
             %></a>:&nbsp;<%=count%>
           </li>
         <% end %>

data/lib/hobix/storage/filesys.rb

@@ -51,7 +51,7 @@ class FileSys < Hobix::BaseStorage
     # Start the storage plugin for the +weblog+ passed in.
     def initialize( weblog )
         super( weblog )
-        @modified = {}
+        @updated = {}
         @basepath = weblog.entry_path
         @default_author = weblog.authors.keys.first
         @weblog = weblog
@@ -75,10 +75,10 @@ class FileSys < Hobix::BaseStorage
         File.join( @basepath, id.split( '/' ) ) + "." + ext
     end
 
-    # Brings an entry's modified time current.
+    # Brings an entry's updated time current.
     def touch_entry( id )
         check_id( id )
-        @modified[id] = Time.now
+        @updated[id] = Time.now
         FileUtils.touch entry_path( id )
     end
 
@@ -90,24 +90,22 @@ class FileSys < Hobix::BaseStorage
         e.created ||= (@index.has_key?( id ) ? @index[id].created : now)
         path = entry_path( id )
 
-        begin
-            File.open( path, 'w' ) { |f| YAML::dump( e, f ) }
-        rescue Errno::ENOENT
-            raise unless create_category and File.exists? @basepath
+        unless create_category and File.exists? @basepath
             FileUtils.makedirs File.dirname( path )
-            retry
         end
+        
+        File.open( path, 'w' ) { |f| YAML::dump( e, f ) }
 
         @entry_cache ||= {}
         e.id = id
         e.link = e.class.url_link e, @link, @weblog.central_ext
-        e.modified = now
+        e.updated = e.modified = now
         @entry_cache[id] = e
 
         @index[id] = @weblog.index_class.new( e ) do |i|
-            i.modified = e.modified
+            i.updated = e.updated
         end
-        @modified[id] = e.modified
+        @updated[id] = e.updated
         # catalog_search_entry( e )
         sort_index( true )
         e
@@ -124,9 +122,10 @@ class FileSys < Hobix::BaseStorage
             e = Hobix::Entry::load( entry_file )
             e.id = id
             e.link = e.class.url_link e, @link, @weblog.central_ext
-            e.modified = modified( id )
+            e.updated = updated( id )
             unless e.created
                 e.created = @index[id].created
+                e.modified = @index[id].modified
                 File.open( entry_file, 'w' ) { |f| YAML::dump( e, f ) }
             end
             @entry_cache[id] = e
@@ -175,28 +174,30 @@ class FileSys < Hobix::BaseStorage
                 entry_paths = File.split( $` )
                 entry_paths.shift if entry_paths.first == '.'
                 entry_id = entry_paths.join( '/' )
-                @modified[entry_id] = File.mtime( path )
+                @updated[entry_id] = File.mtime( path )
 
                 index_entry = nil
                 if ( index.has_key? entry_id ) and !( index[entry_id].is_a? ::Time ) # pre-0.4 index format
                     index_entry = index[entry_id]
                 end
                 ## we will (re)load the entry if:
-                if not index_entry.respond_to?( :modified ) or # it's new
-                        ( index_entry.modified != @modified[entry_id] ) or # it's changed
-                        index_fields.detect { |f| index_entry.send( f ).nil? } # index fields have been added
+                if not index_entry.respond_to?( :updated ) or # it's new
+                        ( index_entry.updated != @updated[entry_id] ) # it's changed
+                        # or index_fields.detect { |f| index_entry.send( f ).nil? } # index fields have been added
                         # or search_needs_update? index_entry # entry is old or not available in search db
 
+                    puts "++ Reloaded #{ entry_id }"
                     efile = entry_path( entry_id )
                     e = Hobix::Entry::load( efile )
                     e.id = entry_id
                     index_entry = @weblog.index_class.new( e, index_fields ) do |i|
-                        i.modified = @modified[entry_id]
+                        i.updated = @updated[entry_id]
                     end
                     # catalog_search_entry( e )
                     modified = true
                 end
-                @index[index_entry.id] = index_entry
+                index_entry.id = entry_id
+                @index[entry_id] = index_entry
             end
         end
         sort_index( modified )
@@ -210,7 +211,7 @@ class FileSys < Hobix::BaseStorage
         @index.sort! { |x,y| y[1].created <=> x[1].created }
         if modified
             File.open( index_path, 'w' ) do |f|
-                YAML::dump( @index, f )
+              YAML::dump( @index, f )
             end
             # @search_index.dump
         end
@@ -225,7 +226,7 @@ class FileSys < Hobix::BaseStorage
         path_storage.instance_eval do
             @index = @index.dup.delete_if do |id, entry|
                 if id.index( p ) != 0
-                    @modified.delete( p )
+                    @updated.delete( p )
                     true
                 end
             end
@@ -259,7 +260,7 @@ class FileSys < Hobix::BaseStorage
         _index = @index
         if _index.empty?
             e = default_entry( @default_author )
-            @modified[e.id] = e.modified
+            @updated[e.id] = e.updated
             _index = {e.id => @weblog.index_class.new(e)}
         end
         # if search[:search]
@@ -300,11 +301,19 @@ class FileSys < Hobix::BaseStorage
         entries
     end
 
+    # Returns a Time object for the latest updated time for a group of
+    # +entries+ (pass in an Array of IndexEntry objects).
+    def last_updated( entries )
+        entries.collect do |entry|
+            updated( entry.id )
+        end.max
+    end
+
     # Returns a Time object for the latest modified time for a group of
     # +entries+ (pass in an Array of IndexEntry objects).
     def last_modified( entries )
         entries.collect do |entry|
-            modified( entry.id )
+            entry.modified
         end.max
     end
 
@@ -316,10 +325,11 @@ class FileSys < Hobix::BaseStorage
         end.max
     end
 
-    # Returns a Time object representing the +modified+ time for the
-    # entry identified by +entry_id+.
-    def modified( entry_id )
-        find_attached( entry_id ).inject( @modified[entry_id] ) do |max, ext|
+    # Returns a Time object representing the +updated+ time for the
+    # entry identified by +entry_id+.  Takes into account attachments
+    # which have been updated.
+    def updated( entry_id )
+        find_attached( entry_id ).inject( @updated[entry_id] ) do |max, ext|
             mtime = File.mtime( entry_path( entry_id, ext ) )
             mtime > max ? mtime : max
         end
@@ -343,7 +353,7 @@ class FileSys < Hobix::BaseStorage
                 next_month %= 12
             end
             month_end = Time.mktime( next_year, next_month, 1 ) - 1
-            months << [ start, month_end, start.strftime( "/%Y/%m/" ) ]
+            months << [ start, month_end, start.strftime( "/%Y/%m/" ) ] unless find( :after => start, :before => month_end).empty?
             start = month_end + 1
         end
         months
@@ -378,7 +388,7 @@ class FileSys < Hobix::BaseStorage
     def save_attached( id, ext, e )
         check_id( id )
         File.open( entry_path( id, ext ), 'w' ) do |f|
-            YAML::dump( e, f )
+          YAML::dump( e, f )
         end
 
         @attach_cache ||= {}
@@ -389,9 +399,9 @@ class FileSys < Hobix::BaseStorage
     # then saves the modified attachment. If an attachment of the given type
     # does not exist, it will be created.
     def append_to_attachment( entry_id, attachment_type, *items )
-      attachment = load_attached( entry_id, attachment_type ) rescue []
-      attachment += items
-      save_attached( entry_id, attachment_type, attachment )
+        attachment = load_attached( entry_id, attachment_type ) rescue []
+        attachment += items
+        save_attached( entry_id, attachment_type, attachment )
     end
 end
 end

data/lib/hobix/trackbacks.rb

@@ -36,7 +36,6 @@ class Quick
   }
 
   def entry_trackback_erb; %{
-    <a name="trackbacks"></a>
     <div id="trackbacks">
     <% entry_id = entry.id %>
     <% trackbacks = weblog.storage.load_attached( entry_id, "trackbacks") rescue [] %>
@@ -44,7 +43,7 @@ class Quick
     <div class="entry">
         <div class="entryAttrib">
             <div class="entryAuthor"><h3><%= trackback.blog_name %></h3></div>
-            <div class="entryTime">tracked back on <%= trackback.created.strftime("<nobr>%d %b %Y</nobr> at <nobr>%I:%M %p</nobr>" ) %></div>
+            <div class="entryTime">tracked back on <%= trackback.created.strftime("<nobr>%d %b %Y</nobr> at <nobr>%H:%M</nobr>" ) %></div>
         </div>
         <div class="entryContentOuter"><div class="entryContent">
             <h3><a href="<%= trackback.url %>"><%= trackback.title %></a></h3>