hobix 0.4

data/lib/hobix/plugin/calendar.rb

@@ -0,0 +1,220 @@
+## calendar.rb -- Hobix calendar plugin
+##
+## Displays a one-month calendar in the sidebar. The calendar links
+## individual days to a daily, monthly or yearly index page. Daily and
+## monthly index pages display the corresponding month in the sidebar;
+## yearly pages do something arbitrary and likely to be wrong; other
+## pages display the current month.
+##
+## The plugin generates separate sidebar .html file for each month. It
+## places these files in htdocs/calendar/.
+##
+## USAGE:
+##
+## 1) In hobix.yaml (e.g. by running 'hobix edit <blogname>'), in the
+##    'required' block, AFTER the "lib/local" line, append as follows:
+##
+## required:
+##   - hobix/plugin/calendar
+##
+##    The plugin overwrites some of the default definitions in
+##    lib/local.rb, so in most cases it will need to be loaded later.
+##    You can also specify any of the following arguments:
+##
+## required:
+##   - hobix/plugin/calendar:
+##       start-on-monday: true
+##       point-to-index: daily
+##       day-symbols: ["Mon" "Tue" "Wed" "Thu" "Fri" "Sat" "Sun"]
+##
+##    Options for 'point-to-index' are 'daily', 'monthly' and
+##    'yearly'.
+##
+## NOTES:
+##
+## 1) If you redefine 'sidebar_list' in hobix.yaml, you'll need to
+##    explicitly add a 'sidebar_calendar' item.
+## 2) Every sidebar page is regenerated every time you do an
+##    upgen. This is slow.
+## 3) The sidebar on yearly index pages is December of that year,
+##    regardless of whether that month contains any posts. That's a
+##    little weird.
+
+require 'date'
+
+class Array
+  def uniq_c
+    ret = {}
+    each { |e| ret[e] = 1 + (ret[e] || 0) }
+    ret
+  end
+end
+
+module Hobix
+
+## we just keep parameters from hobix.yaml here
+class SidebarCalendarPlugin < BasePlugin
+  def initialize(weblog, params = {})
+    @@start_on_monday = lambda { |x| (x.nil? ? false : x) }[params['start-on-monday']]
+    @@point_to_index = (params['point-to-index'] || "monthly").to_sym
+    @@day_syms = params['day-symbols'] || (@@start_on_monday ? %w(Mo Tu We Th Fr Sa Su) : %w(Su Mo Tu We Th Fr Sa))
+  end
+
+  def self.start_on_monday?; @@start_on_monday; end
+  def self.point_to_index; @@point_to_index; end
+  def self.day_syms; @@day_syms; end
+
+  DIR = "/calendar"
+  def self.dir_to(date, ext = true)
+    date.strftime("#{DIR}/sidebar-%Y-%m") + (ext ? ".html" : "")
+  end
+end
+
+class Out::Quick
+  alias calendar_old_sidebar_list_erb sidebar_list_erb
+  def sidebar_list_erb
+    l = calendar_old_sidebar_list_erb
+    if l.last == "sidebar_hobix"
+      l[0 ... (l.length - 1)] + ['sidebar_calendar', 'sidebar_hobix']
+    else
+      l + ['sidebar_calendar']
+    end
+  end
+
+  def sidebar_calendar_ssi
+    %q{<!--#include virtual="<%= weblog.link.path + SidebarCalendarPlugin.dir_to(page.timestamp || Time.now)%>"-->}
+  end
+
+  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)
+    months = path_storage.get_months(storage.find)
+
+    months.extend Hobix::Enumerable
+    months.each_with_neighbors do |prev, cur, nexxt| 
+      month_start, month_end, month_id = cur
+
+      entries = path_storage.within(month_start, month_end)
+      page = Page.new SidebarCalendarPlugin.dir_to(month_start, false)
+      page.timestamp = month_start
+      page.updated = Time.now #path_storage.last_modified(entries)
+      page.prev = prev[0].strftime("/%Y/%m/") if prev
+      page.next = nexxt[0].strftime("/%Y/%m/") if nexxt
+
+      days = entries.map do |entry|
+        day = entry.created
+        Date.new(day.year, day.mon, day.day)
+      end.uniq_c
+      offset = (month_start.wday - (SidebarCalendarPlugin.start_on_monday? ? 1 : 0)) % 7
+
+      yield :page => page, :months => months, :month => month_start, :days => days, :offset => offset, :day_syms => SidebarCalendarPlugin.day_syms, :index => SidebarCalendarPlugin.point_to_index
+    end
+  end
+end
+
+## generate the HTML
+class Out::Quick
+  def sidebar_calendar_erb
+  %{
+    <style type="text/css">
+    .sidebarCalendar a { text-decoration: none; font-weight: bold; }
+    .sidebarCalendarHeader { text-align: center; }
+    .sidebarCalendarContentRow { color: #888; text-align: right; }
+    </style>
+
+    <div class="sidebarBox">
+    <h2 class="sidebarTitle">Calendar</h2>
+    <table class="sidebarCalendar">
+      <+ sidebar_calendar_caption +>
+      <+ sidebar_calendar_header +>
+      <+ sidebar_calendar_contents +>
+    </table>
+    </div>
+  }
+  end
+
+  def sidebar_calendar_contents_erb
+  %q{
+    <tr class="sidebarCalendarContentRow">
+    <% offset.times do %>
+      <td class="sidebarCalendarFiller"> &nbsp; </td>
+    <% end %>
+    
+    <%
+      current = offset
+      first = Date.new(month.year, month.mon, 1)
+      last = (first >> 1) - 1
+    %>
+
+    <% (first .. last).each do |d| %>
+      <% if (current % 7) == 0 %>
+        </tr><tr class="sidebarCalendarContentRow">
+      <% end %>
+      <% current += 1 %>
+
+      <% if days.keys.include? d %>
+        <% 
+          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")
+                 when :monthly:
+                   d.strftime("/%Y/%m/#%Y%m%d")
+                 else
+                   d.strftime("/%Y/%m/%d.html#%Y%m%d")
+                 end
+        %>
+        <td class="sidebarCalendarLinkDay"><a title="<%= title %>" href="<%= weblog.expand_path link %>"><%= d.strftime("%e") %></a></td>
+      <% else %>
+        <td class="sidebarCalendarEmptyDay"><%= d.strftime("%e") %></td>
+      <% end %>
+    <% end %>
+
+    <% (7 - offset).times do %>
+      <td class="sidebarCalendarFiller"> &nbsp; </td>
+    <% end %>
+
+    </tr>
+  }
+  end
+
+  def sidebar_calendar_header_erb
+  %{
+    <tr class="sidebarCalendarHeaderRow">
+    <% day_syms.each do |d| %>
+      <th class="sidebarCalendarHeader"><%= d %></th>
+    <% end %>
+    </tr>
+  }
+  end
+
+  def sidebar_calendar_caption_erb
+  %q{
+    <caption class="sidebarCalendarCaption">
+    <% if page.prev %>
+      <a href="<%= weblog.expand_path page.prev %>">&larr;</a>
+    <% else %>
+      &larr;
+    <% end %>
+    &nbsp;<a href="<%= weblog.expand_path month.strftime("/%Y/%m/")%>"><%= month.strftime("%B %Y") %></a>&nbsp;
+    <% if page.next %>
+      <a href="<%= weblog.expand_path page.next %>">&rarr;</a>
+    <% else %>
+      &rarr;
+    <% end %>
+    </caption>
+  }
+  end
+end
+
+end

data/lib/hobix/plugin/flickr.rb

@@ -0,0 +1,110 @@
+## flickr.rb -- Hobix Flickr plugin
+##
+## Displays your Flickr photostream ("badge") on the sidebar.  This is
+## based on the instructions at http://flickr.com/badge_new.gne. That
+## page provides a lot more functionality in terms of colors and sizes
+## and whatnot; this plugin just makes it slightly easier to do the
+## most common thing.
+##
+## You'll need to discover your Flickr userid to use this (different
+## from your username). You can use the tool at
+## http://eightface.com/code/idgettr/, or simply examine your Flickr
+## RSS URL for the "id" parameter.  It should look something like
+## this: 34479244@N00.
+##
+## USAGE:
+##
+## 1) In hobix.yaml (e.g. by running 'hobix edit <blogname>'), in the
+##    'required' block, append as follows:
+##
+## required:
+##   - hobix/plugin/flickr:
+##       userid: <your flickr userid (see above)>
+##
+##    You can also specify any of the following arguments:
+##
+## required:
+##   - hobix/plugin/flickr:
+##       userid: <your flickr userid>
+##       num: <number of pics to use (default 5)>
+##       size: <small, thumbnail or midsize (default small)>
+##       title: <title (default "Recent Pictures"), or nil for none>
+##       in-sidebarBox-div: <true or false (default true)>
+##
+## NOTES:
+##
+## 1) If you redefine 'sidebar_list' in hobix.yaml, you'll need to
+##    explicitly add a 'sidebar_flickr' item.
+
+module Hobix
+
+## we just keep parameters from hobix.yaml here
+class FlickrPlugin < BasePlugin
+  def initialize(weblog, params = {})
+    raise %{the flickr plugin needs a "userid" parameter. see hobix/plugin/flickr.rb for details} unless params.member? "userid"
+    @@userid = params["userid"]
+    @@num = params["num"] || 5
+    @@size =
+      case params["size"]
+      when nil, "small"
+        "s"
+      when "thumbnail"
+        "t"
+      when "midsize"
+        "m"
+      else
+        raise %{unknown size value "#{params["size"]}" for flickr plugin. use "small", "thumbnail" or "midsize"}
+      end
+    @@title = params["title"] || "Recent Pictures"
+    @@in_sidebarBox_div = lambda { |x| (x.nil? ? true : x) }[params["in-sidebarBox-div"]]
+  end
+
+  def self.userid; @@userid; end
+  def self.num; @@num; end
+  def self.size; @@size; end
+  def self.title; @@title; end
+  def self.in_sidebarBox_div?; @@in_sidebarBox_div; end
+end
+
+class Out::Quick
+  alias flickr_old_sidebar_list_erb sidebar_list_erb
+  def sidebar_list_erb
+    l = flickr_old_sidebar_list_erb
+    if l.last == "sidebar_hobix"
+      l[0 ... (l.length - 1)] + ['sidebar_flickr', 'sidebar_hobix']
+    else
+      l + ['sidebar_flickr']
+    end
+  end
+
+  def sidebar_flickr_erb
+    (FlickrPlugin.in_sidebarBox_div? ? %{<div class="sidebarBox">} : "") +
+      (FlickrPlugin.title ? %{<h2 class="sidebarTitle">#{FlickrPlugin.title}</h2>} : "") +
+      %{
+<!-- Start of Flickr Badge -->
+<!-- Start of Flickr Badge -->
+<style type="text/css">
+#flickr_badge_source_txt {padding:0; font: 11px Arial, Helvetica, Sans serif; color:#666666;}
+#flickr_badge_icon {display:block !important; margin:0 !important; border: 1px solid rgb(0, 0, 0) !important;}
+#flickr_icon_td {padding:0 5px 0 0 !important;}
+.flickr_badge_image {text-align:center !important;}
+.flickr_badge_image img {border: 1px solid black !important;}
+#flickr_www {display:block; padding:0 10px 0 10px !important; font: 11px Arial, Helvetica, Sans serif !important; color:#3993ff !important;}
+#flickr_badge_uber_wrapper a:hover,
+#flickr_badge_uber_wrapper a:link,
+#flickr_badge_uber_wrapper a:active,
+#flickr_badge_uber_wrapper a:visited {text-decoration:none !important; background:inherit !important;color:#3993ff;}
+#flickr_badge_wrapper {border: solid 1px #000000}
+#flickr_badge_source {padding:0 !important; font: 11px Arial, Helvetica, Sans serif !important; color:#666666 !important;}
+</style>
+<table id="flickr_badge_uber_wrapper" cellpadding="0" cellspacing="10" border="0"><tr><td><a href="http://www.flickr.com" id="flickr_www">www.<strong style="color:#3993ff">flick<span style="color:#ff1c92">r</span></strong>.com</a><table cellpadding="0" cellspacing="10" border="0" id="flickr_badge_wrapper">
+<script type="text/javascript" src="http://www.flickr.com/badge_code_v2.gne?count=#{FlickrPlugin.num}&display=latest&size=#{FlickrPlugin.size}&layout=v&source=user&user=#{FlickrPlugin.userid}"></script>
+</table>
+</td></tr></table>
+<!-- End of Flickr Badge -->
+    } +
+    (FlickrPlugin.in_sidebarBox_div? ? "</div>" : "")
+  end
+end
+
+end

data/lib/hobix/plugin/recent_comments.rb

@@ -0,0 +1,82 @@
+## recent_comments.rb -- Hobix recent comments plugin
+##
+## Displays a list of recent comments posted on your blog.
+##
+## USAGE:
+##
+## 1) In hobix.yaml (e.g. by running 'hobix edit <blogname>'), simply
+##    add 'hobix/plugin/recent_comments' to the 'required' list, as
+##    follows:
+##
+## required:
+##   - hobix/plugin/recent_comments
+##
+##    And that's it!
+##
+##    You can also specify any of the following arguments:
+##
+## required:
+##   - hobix/plugin/recent_comments:
+##       num: <number of comments (default 5)>
+##
+## NOTES:
+##
+## 1) If you redefine 'sidebar_list' in hobix.yaml, you'll need to
+##    explicitly add a 'sidebar_recent_comments' item.
+## 2) Currently pretty slow, as it basically take a brute force
+##    approach.
+
+module Hobix
+
+## we just keep parameters from hobix.yaml here
+class RecentCommentsPlugin < BasePlugin
+  def initialize(weblog, params = {})
+    @@num = params["num"] || 5
+  end
+
+  def self.num; @@num; end
+end
+
+class Hobix::Out::Quick
+  def all_comments(weblog, entries)
+    entries.map do |ie|
+      begin
+        comments = weblog.storage.load_attached(ie.id, "comments")
+        e = weblog.storage.load_entry ie.id
+        comments.each { |c| yield e.link, e.title, c.author, c.created }
+      rescue Errno::ENOENT
+      end
+    end
+  end
+
+  def recent_comments(weblog, entries, num)
+    comments = []
+    all_comments(weblog, entries) { |*c| comments.push c }
+    comments.map { |x| x }.sort_by { |x| x[3] }.reverse[0 ... num]
+  end
+
+  def sidebar_recent_comments_erb
+  %q{
+    <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>
+    <% end %>
+    </ul>
+    </div>
+  }
+  end
+
+  alias recent_comments_old_sidebar_list_erb sidebar_list_erb
+  def sidebar_list_erb
+    l = recent_comments_old_sidebar_list_erb
+    if l.last == "sidebar_hobix"
+      l[0 ... (l.length - 1)] + ['sidebar_recent_comments', 'sidebar_hobix']
+    else
+      l + ['sidebar_recent_comments']
+    end
+  end
+end
+
+end

data/lib/hobix/plugin/sections.rb

@@ -0,0 +1,91 @@
+## sections.rb -- Hobix section list plugin
+##
+## Displays a list of all the sections of your blog.
+##
+## USAGE:
+##
+## 1) In hobix.yaml (e.g. by running 'hobix edit <blogname>'), simply
+##    add 'hobix/plugin/sections' to the 'required' list, as follows:
+##
+## required:
+##   - hobix/plugin/sections
+##
+##    And that's it!
+##
+## NOTES:
+##
+## 1) If you redefine 'sidebar_list' in hobix.yaml, you'll need to
+##    explicitly add a 'sidebar_section_list' item.
+## 2) The default Hobix CSS doesn't indent lists, so the hierarchy is 
+##    lost upon display. You can add something like this to your CSS file
+##    to fix this:
+##
+## .sidebarBox ul {
+##     margin:7px;
+##     padding:0px;
+## }
+
+class Hobix::Out::Quick
+  def section_list( entries, topname = "top level" )
+    counts = {}
+    entries.each do |entry|
+      path = ( entry.id.split("/")[0 ... -1] || [] ) # nil in ruby 1.8.1 if path is ""
+      counts[path] = 1 + ( counts[path] || 0 )
+    end
+
+    list = []; seen = {}
+    counts[[]] ||= 0 # force the root
+    counts.sort.each do |path, count|
+      if path == []
+        list.push [topname, "", 0, counts[path]]        
+      else
+        path.inject( "." ) do |s, x|
+          prefix = s + "/" + x
+          unless seen[prefix]
+            length = prefix.count '/'
+            list.push [x, prefix, length, ( length == path.length ? count : 0 ) ]
+            seen[prefix] = true
+          end
+          prefix
+        end
+      end
+    end
+    list
+  end
+
+  def sidebar_section_list_erb
+  %q{
+    <div class="sidebarBox">
+    <h2 class="sidebarTitle">Sections</h2>
+    <% curlev = -1 %>
+    <% section_list( weblog.storage.find ).each do |name, path, lev, num| %>
+      <% if ( lev > curlev ) %>
+        <% ( lev - curlev ).times do %> <ul> <% end %>
+      <% else # less than or equal %>
+        </li>
+      <% end %>
+      <% if ( curlev > lev ) %>
+        <% ( curlev - lev ).times do %> </ul></li> <% end %>
+      <% end %>
+
+      <% curlev = lev %>
+      <li>
+        <a href="<%= weblog.expand_path path %>"><%= name %></a><% if num != 0 then %>: <%= num %> <% end %>
+    <% end %>
+    <% ( curlev + 1 ).times do %>
+      </li></ul>
+    <% end %>
+    </div>
+  }
+  end
+
+  alias sections_old_sidebar_list_erb sidebar_list_erb
+  def sidebar_list_erb
+    l = sections_old_sidebar_list_erb
+    if l.last == "sidebar_hobix"
+      l[0 ... (l.length - 1)] + ['sidebar_section_list', 'sidebar_hobix']
+    else
+      l + ['sidebar_section_list']
+    end
+  end
+end

data/lib/hobix/plugin/tags.rb

@@ -0,0 +1,60 @@
+## tags.rb -- Hobix tag list plugin
+##
+## Displays a list of all the tags of your blog.
+##
+## USAGE:
+##
+## 1) In hobix.yaml (e.g. by running 'hobix edit <blogname>'), simply
+##    add 'hobix/plugin/tags' to the 'required' list, as follows:
+##
+## required:
+##   - hobix/plugin/tags
+##
+##    And that's it!
+##
+## NOTES:
+##
+## 1) If you redefine 'sidebar_list' in hobix.yaml, you'll need to
+##    explicitly add a 'sidebar_tag_list' item.
+
+class Hobix::Out::Quick
+  def tags_list(entries)
+    tags = { }
+    entries.each do |e|
+      if e.tags
+        e.tags.each do |t|
+          tags[t] ||= 0
+          tags[t] += 1
+        end
+      end
+    end
+    tags
+  end
+
+  def sidebar_tag_list_erb
+    %q{
+        <div class="sidebarBox">
+        <h2 class="sidebarTitle">Tags</h2>
+        <ul>
+        <% tags_list(weblog.storage.find).sort.each do |name, count| %>
+          <li>
+            <a href="<%= weblog.link %>/tags/<%=name%>/index.html"><%= name
+            %></a>:&nbsp;<%=count%>
+          </li>
+        <% end %>
+        </ul>
+        </div>
+      }
+  end
+
+  alias tags_old_sidebar_list_erb sidebar_list_erb
+  def sidebar_list_erb
+    l = tags_old_sidebar_list_erb
+    if l.last == "sidebar_hobix"
+      l[0 ... (l.length - 1)] + ['sidebar_tag_list', 'sidebar_hobix']
+    else
+      l + ['sidebar_tag_list']
+    end
+  end
+
+end

data/lib/hobix/publish/ping.rb

@@ -0,0 +1,53 @@
+#
+# = hobix/out/ping.rb
+#
+# XML-RPC pingt for Hobix.
+#
+# Copyright (c) 2003-2004 why the lucky stiff
+#
+# Written & maintained by why the lucky stiff <why@ruby-lang.org>
+#
+# This program is free software, released under a BSD license.
+# See COPYING for details.
+#
+#--
+# $Id$
+#++
+require 'hobix/base'
+require 'xmlrpc/client'
+
+module Hobix
+module Publish
+class Ping < Hobix::BasePublish
+    def initialize( weblog, urls )
+        @title = weblog.title
+        @link = weblog.link
+        @urls = urls
+    end
+    def watch
+        ['index']
+    end
+    def publish( pages )
+        @urls.each do |u|
+            link = @link.to_s
+            u, link = u.keys.first, u.values.first if Hash === u
+            puts "pinging #{ u }..."
+            u = URI::parse( u )
+            begin
+                server = XMLRPC::Client.new( u.host, u.path, u.port )
+
+                begin
+                    result = server.call( "weblogUpdates.ping", @title, link )
+                rescue XMLRPC::FaultException => e
+                    puts "Error: "
+                    puts e.faultCode
+                    puts e.faultString
+                end
+            rescue Exception => e
+                puts "Error: #{ e.message }"
+            end
+        end
+    end
+end
+end
+end