hobix 0.6

data/lib/hobix/facets/publisher.rb

@@ -0,0 +1,314 @@
+#
+# = hobix/facets/publisher.rb
+#
+# Hobix command-line weblog system, web-based publishing interface.
+#
+# 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 'erb'
+require 'yaml'
+
+module Hobix
+module Facets
+
+# The Publisher plugin adds a web interface for managing Hobix blogs.
+# Basically, to add the publisher to your site, ensure the plugin
+# is loaded within your hobix.yaml `requires' list:
+#
+#   requires:
+#   - hobix/facets/publisher
+#
+class Publisher < BaseFacet
+    class MissingRequired < Exception; end
+
+    def initialize( weblog, defaults = {} )
+        @weblog = weblog
+    end
+    def get app
+        if app.respond_to? :action_uri
+            ns, method_id = app.action_uri.split( '/', 2 )
+            return false unless ( ns.nil? or ns == "publisher" )
+
+            case method_id
+            when /\.js$/
+                app.content_type = "text/javascript"
+                app.puts File.read( File.join( Hobix::SHARE_PATH, "publisher", method_id ) )
+                return true
+            when /\.css$/
+                app.content_type = "text/css"
+                app.puts File.read( File.join( Hobix::SHARE_PATH, "publisher", method_id ) )
+                return true
+            when /\.png$/
+                app.content_type = "image/png"
+                app.puts File.read( File.join( Hobix::SHARE_PATH, "publisher", method_id ) )
+                return true
+            end
+
+            # dispatch the url action
+            method_args = (method_id || "config").split( /\// )
+            method_id = "config"
+            method_args.length.downto(1) do |i|
+                if respond_to? "get_#{ method_args[0,i].join( '_' ) }"
+                    method_id = "get_#{ method_args.slice!(0,i).join( '_' ) }"
+                    break
+                end
+            end
+            method_args.unshift app
+            return false unless respond_to? method_id
+            @screen = method( method_id ).call( *method_args )
+            return true unless @screen
+
+            # Display publisher page
+            erb_src = File.read( File.join( Hobix::SHARE_PATH, "publisher/index.erb" ) )
+            app.content_type = 'text/html'
+            app.puts ::ERB.new( erb_src, nil, nil, "_hobixpublish" ).result( binding )
+            return true
+        end
+    end
+
+    def make_form( form )
+        form_erb = %q{
+% current = nil
+            <style type="text/css">
+            <!--
+            ul.edit_as_map, ol.edit_as_omap {
+                list-style-image:none;
+                list-style-type:none;
+                margin-top:5px;
+                margin:0px;
+                padding:0px;
+                margin-left:140px;
+            }
+            ul.edit_as_map li, ol.edit_as_omap li {
+                padding: 3px 0px;
+                margin: 0px;
+            }
+            ol.edit_as_omap li .handle {
+                cursor: move;
+            }
+            -->
+            </style>
+            <script type="text/javascript" language="javascript">
+            // <![CDATA[
+            function sortable_to_csv(element) {
+                var element = $(element);
+                var options = {
+                    tag:  element.sortable.tag,
+                    only: element.sortable.only,
+                    name: element.id
+                }.extend(arguments[1] || {});
+
+                var items = $(element).childNodes;
+                var queryComponents = new Array();
+
+                for(var i=0; i<items.length; i++)
+                    if(items[i].tagName && items[i].tagName==options.tag.toUpperCase() &&
+                        (!options.only || (Element.Class.has(items[i], options.only))))
+                            queryComponents.push(items[i].id.replace(element.id+'_',''));
+
+                return queryComponents;
+            }
+            // ]]>
+            </script>
+            <h2><%= form[:full_title] %></h2>
+            <form id="publisher_form" method="post" enctype="multipart/form-data">
+            <p><%= RedCloth.new( form[:intro] ).to_html %></p>
+% form[:object].class.properties.each do |name, opts|
+%     next unless opts and opts[:edit_as]
+%     if sect = form[:object].class.prop_sections.detect { |k,v| v[:__sect] == current }
+            <fieldset>
+                <legend><%= sect[0] %></legend>
+%     end
+%     title = name.to_s.gsub( '_', ' ' ).capitalize
+%     val = form[:object].instance_variable_get( "@" + name.to_s )
+%     if name == :notes
+                <div class="notes">
+                <h4><%= title %></h4>
+                </div>
+%     else
+                <div class="<%= opts[:req] ? 'required' : 'optional' %>">
+                <label for="<%= name %>"><%= title %>:</label>
+%         case opts[:edit_as]
+%         when :password
+                <input type="password" name="<%= name %>" id="<%= name %>"
+                       class="inputPassword" size="10" tabindex="" 
+                       maxlength="25" value="<%= val %>" />
+%         when :checkbox
+                <input type="checkbox" name="<%= name %>" id="<%= name %>" 
+                       class="inputCheckbox" tabindex="" value="1" />
+%         when :textarea
+                <textarea name="<%= name %>" id="<%= name %>" rows="<%= opts[:edit_rows] || 4 %>" cols="<%= opts[:edit_cols] || 36 %>" tabindex=""><%= val %></textarea>
+%         when :omap
+                <ol id="<%= name %>sort" class="edit_as_omap">
+%             val.each do |vkey, vval|
+%                 vkey = vkey.keys.first if vkey.is_a? Hash
+                    <li id="<%= name %>sort_<%= vkey %>" class="sorty" name="<%= vkey %>">
+                        <span class="handle">&raquo;</span>
+                        <%= vkey %>
+                        <a href="<%= form[:app].absuri( :path_info => "/publisher/#{ @title }/edit/#{ name }/#{ vkey }" ) %>">edit</a>
+                        <a href="<%= form[:app].absuri( :path_info => "/publisher/#{ @title }/del/#{ name }/#{ vkey }" ) %>">remove</a>
+                    </li>
+%             end if val
+                    <li class="new_item">
+                    <span>&raquo;</span>
+                    <input type="text" name="<%= name %>_new" id="<%= name %>_new" style="width:150px" 
+                           class="inputText" tabindex="" maxlength="255" value="" />
+                    <a href="<%= form[:app].absuri( :path_info => "/publisher/#{ @title }/add/#{ name }" ) %>">add</a>
+                    </li>
+                </ul>
+                <input type="hidden" name="<%= name %>" id="<%= name %>" value="" />
+                <script type="text/javascript" language="javascript">
+                // <![CDATA[
+                Sortable.create("<%= name %>sort", {handle:'handle', only: 'sorty', onUpdate:function () {
+                    $("<%= name %>").value = sortable_to_csv(this.element).join(' ');
+                }});
+                // ]]>
+                </script>
+%         when :map
+                <ul id="<%= name %>_order" class="edit_as_map">
+%             val.each do |vkey, vval|
+                    <li id="<%= name %>_<%= vkey %>">
+                        <%= vkey %>
+                        <a href="<%= form[:app].absuri( :path_info => "/publisher/#{ @title }/edit/#{ name }/#{ vkey }" ) %>">edit</a>
+                        <a href="<%= form[:app].absuri( :path_info => "/publisher/#{ @title }/del/#{ name }/#{ vkey }" ) %>">remove</a>
+                    </li>
+%             end if val
+                    <li id="new_item">
+                    <input type="text" name="<%= name %>_new" id="<%= name %>_new" style="width:150px"
+                           class="inputText" tabindex="" maxlength="255" value="" />
+                    <a href="<%= form[:app].absuri( :path_info => "/publisher/#{ @title }/add/#{ name }" ) %>">add</a>
+                    </li>
+                </ul>
+%         else
+                <input type="text" name="<%= name %>" id="<%= name %>" 
+                       class="inputText" size="<%= opts[:edit_size] || 24 %>" tabindex="" 
+                       maxlength="255" value="<%= val %>" />
+%         end
+
+%         if opts.include? :notes
+                <small><%= fopts['notes'] %></small>
+%         end
+%         if form[:object].respond_to? "default_#{ name }"
+                <small><em>Defaults to <strong><%= form[:object].method( "default_#{ name }" ).call %></strong>.</em></small>
+%         end
+                </div>
+%     end
+%     current = name
+%     if form[:object].class.prop_sections.detect { |k,v| v[:__sect] == current }
+            </fieldset>
+%     end
+% end
+            </fieldset>
+            <fieldset>
+                <div class="submit">
+                <div>
+
+                <input type="submit" class="inputSubmit" tabindex="" value="Submit &raquo;" />
+                <input type="submit" class="inputSubmit" tabindex="" value="Cancel" />
+                </div>
+                </div>
+            </fieldset>
+            </form>
+        }
+        return ::ERB.new( form_erb, 0, "%<>", "_hobixpublishFORM" ).result( binding )
+    end
+
+    def save_form( obj, app )
+        obj = obj.dup
+        missing = []
+        obj.class.properties.each do |name, opts|
+            next unless opts
+            next unless app._POST.has_key? name.to_s
+            val = app._POST[name.to_s]
+            val = nil if val and val.empty?
+            missing << name if val.nil? and opts[:req]
+
+            case opts[:edit_as]
+            when :omap
+                omap = obj.instance_variable_get( "@#{name}" )
+                sorted = val.to_s.split(/\s+/)
+                sorted.each { |item| omap << [item] unless omap.assoc(item) }
+                omap.sort_by { |item, val| sorted.index(item) || sorted.length }
+            when :map
+                map = obj.instance_variable_get( "@#{name}" )
+                val.to_s.split(/\s+/).each do |item|
+                    map[item] ||= nil
+                end
+            else
+                obj.instance_variable_set( "@#{name}", val )
+            end
+        end
+        [obj, missing]
+    end
+
+    def red( str ); RedCloth.new( str ).to_html; end
+
+    def show_weblog_form( weblog, app )
+        make_form :app => app,
+          :full_title => 'Configure Your Weblahhg',
+          :intro => %q{
+              Generally speaking, you shouldn't have to alter many of your weblog settings.
+              Most of the below are available for those who really want to customize.
+              
+              **Bold** fields are required.
+          }.gsub( /^ +/, '' ),
+          :object => weblog
+    end
+
+    def get_config( app )
+        @title = 'config'
+        case app.request_method
+        when "GET"
+            show_weblog_form( @weblog, app )
+        when "POST"
+            weblog, missing = save_form( @weblog, app )
+            # if missing.empty?
+            #     weblog.save( weblog.hobix_yaml + ".edit" )
+            #     red %{
+            #         *Your configuraton has been saved.*
+            #         
+            #         Please note that this development version of Hobix isn't
+            #         yet equipped to deal with re-sorting of the requires.  I'm not that great with Prototype
+            #         yet and I also want to write some code to sandbox the configuration, to check that the
+            #         requires will load right before saving it.
+            #     }
+            # else
+            #     show_weblog_form( weblog, app )
+            # end
+            [weblog, missing].to_yaml
+        end
+    end
+
+    def get_entries( app, *entry_id )
+        @title = 'entries'
+        unless entry_id.empty?
+            e = @weblog.storage.load_entry( entry_id.join( '/' ) )
+        else
+            e = Hobix::Entry.new
+        end
+        case app.request_method
+        when "GET"
+            make_form :app => app,
+              :full_title => 'Post an Entry',
+              :intro => %q{
+                  **Bold** fields are required.
+              }.gsub( /^ +/, '' ),
+              :object => e
+        when "POST"
+            e, missing = save_form( e, app )
+            e.inspect
+        end
+    end
+end
+
+end
+end

data/lib/hobix/facets/trackbacks.rb

@@ -0,0 +1,80 @@
+#
+# = hobix/facets/trackbacks.rb
+#
+# Hobix command-line weblog system, support for trackbacks.
+#
+# 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/entry'
+
+module Hobix
+module Facets
+
+# The Trackbacks plugin adds support for the TrackBack specification
+# (http://www.sixapart.com/pronet/docs/trackback_spec).
+#
+# Add this require to your hobix.yaml:
+#
+#   requires:
+#   - hobix/trackbacks
+#
+class Trackbacks < BaseFacet
+    def self.trackback_fields; ['url','title', 'excerpt', 'blog_name']; end
+    def self.trackback_class; Hobix::Trackback; end
+
+    def initialize( weblog, defaults = {} )
+        @weblog = weblog
+    end
+    def get app
+        if app.respond_to? :action_uri
+            action, entry_id = app.action_uri.split( '/', 2 )
+            case action
+            when "trackback"
+                # Validate
+                on_entry = @weblog.storage.load_entry( entry_id ) rescue nil
+                return send_trackback_response( app, false, 'No such entry' ) if on_entry.nil?
+
+                # Create a trackback comment
+                trackback = Trackbacks.trackback_class.new do |t|
+                    Trackbacks.trackback_fields.each do |tf|
+                      t.method( "#{tf}=" ).call( app._POST[tf].to_s )
+                    end
+                    return send_trackback_response( app, false, 'Missing URL field' ) if (t.url || '').empty?
+                    t.created = Time.now
+                    t.ipaddress = app.remote_addr
+                end
+
+                # Save the trackback, upgen
+                @weblog.storage.append_to_attachment( entry_id, 'trackbacks', trackback )
+                @weblog.regenerate :update
+
+                # Send response
+                send_trackback_response( app, true )
+                return true
+            end
+        end
+    end
+
+    def send_trackback_response(app, ok = true, message = nil)
+      app.content_type = 'text/xml'
+      app.puts %{<?xml version="1.0" encoding="UTF-8"?>
+        <response>
+          <error>%d</error>
+          %s
+        </response>
+      } % [ok ? 0 : 1, message ? %{<message>#{message}</message>} : '']
+      true
+    end
+end
+
+end
+end

data/lib/hobix/linklist.rb

@@ -0,0 +1,81 @@
+#
+# = hobix/linklist.rb
+#
+# Hobix command-line weblog system.
+#
+# 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/entry'
+require 'redcloth'
+require 'yaml'
+
+# The LinkList class is an entry type for storing links.  It's
+# also a good example of how to subclass the Entry class so you
+# can store your own kinds of entries.
+#
+# == Properties
+#
+# The LinkList responds to many of the same properties listed
+# in the +Hobix::Entry+ class.  The primary difference is that,
+# instead of having a +content+ property, there is a +links+
+# property.
+#
+# links::   Internally, this class stores a +YAML::Omap+, an
+#           Array of pairs.  The links are kept in the order
+#           shown in the YAML file.  They consist of a link
+#           title, paired with a URL.
+#
+# == Sample LinkList
+#
+#    --- %YAML:1.0 !hobix.com,2004/linklist
+#    title: Hobix Links
+#    author: why
+#    created: 2004-05-30 18:53:00 -06:00
+#    links:
+#    - Hobix: http://hobix.com/
+#    - Learn Hobix: http://hobix.com/learn/
+#    - Textile Reference: http://hobix.com/textile/
+#
+module Hobix
+class LinkList < BaseEntry
+
+    _ :links,   :req => true, :edit_as => :textarea
+
+    # Converts the link list into a RedCloth string for display
+    # in templates.
+    def content
+        RedCloth.new( 
+            @links.collect do |title, url|
+                "* \"#{ title }\":#{ url }"
+            end.join( "\n" )
+        )
+    end
+
+    # Adds support for enumeration.
+    def each
+      @links.each { |title, url| yield title, url }
+    end
+
+    # LinkLists currently output as YAML type family
+    # !hobix.com,2004/linklist.
+    yaml_type "tag:hobix.com,2004:linklist"
+end
+end
+
+YAML::add_domain_type( 'hobix.com,2004', 'linklist' ) do |type, val|
+    ['tagline', 'summary'].each do |f|
+        val[f] = RedCloth.new( val[f].to_s ) if val[f]
+    end
+    if val['links'].class == ::Array
+        val['links'] = YAML::transfer( 'omap', val['links'] )
+    end
+    YAML::object_maker( Hobix::LinkList, val )
+end

data/lib/hobix/out/atom.rb

@@ -0,0 +1,101 @@
+#
+# = hobix/out/atom.rb
+#
+# Atom output 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 'rexml/document'
+require 'erb'
+require 'uri'
+require 'cgi'
+
+module Hobix
+module Out
+module XmlQuick
+    def x( title, txt, attrs = nil )
+        e = REXML::Element.new title
+	e.attributes['xml:space'] = "preserve"
+        # self-quote to work around REXML quoting issues with HTML entities
+        REXML::Text.new ::ERB::Util.h( txt ), true, e, true if txt
+        attrs.each { |a,b| e.attributes[a] = b } if attrs
+        self << e
+    end
+end
+class Atom < Hobix::BaseOutput
+    def initialize( weblog )
+        @path = weblog.skel_path
+    end
+    def extension
+        "atom"
+    end
+    def load( file_name, vars )
+        rssdoc = REXML::Document.new( <<EOXML )
+<feed
+  xmlns="http://www.w3.org/2005/Atom"
+  xmlns:dc="http://purl.org/dc/elements/1.1/"
+  xml:lang="en">
+    <title></title>
+    <link rel="alternate" type="text/html" href="" />
+    <link rel="self" type="application/atom+xml" href="" />
+    <updated></updated>
+    <subtitle></subtitle>
+    <id></id>
+    <generator uri="http://hobix.com/" version="#{ Hobix::VERSION }">Hobix</generator>
+    <rights></rights>
+</feed>
+EOXML
+        uri = vars[:weblog].link
+        rssdoc << REXML::XMLDecl.new
+        rssdoc.elements['/feed/title'].text = vars[:weblog].title
+        alt_uri = vars[:weblog].link.to_s
+        REXML::XPath.first(rssdoc, '/atom:feed/atom:link[@rel="alternate"]', 
+          { 'atom' => 'http://www.w3.org/2005/Atom' }).attributes['href'] = alt_uri
+        self_uri = "#{vars[:weblog].link}#{vars[:page].link}"
+        REXML::XPath.first(rssdoc, '/atom:feed/atom:link[@rel="self"]', 
+          { 'atom' => 'http://www.w3.org/2005/Atom' }).attributes['href'] = self_uri
+        rssdoc.elements['/feed'].attributes['xml:base'] = self_uri
+        rssdoc.elements['/feed/subtitle'].text = vars[:weblog].tagline
+        rssdoc.elements['/feed/updated'].text = vars[:page].updated.strftime( "%Y-%m-%dT%H:%M:%SZ" )
+        rssdoc.elements['/feed/id'].text = "tag:#{ uri.host },#{ Time.now.year }:blog#{ uri.path }"
+        rssdoc.elements['/feed/rights'].text = vars[:weblog].copyright || "None"
+        ( vars[:entries] || [vars[:entry]] ).each do |e|
+            ele = REXML::Element.new 'entry'
+            ele.extend XmlQuick
+            ele.attributes['xml:base'] = e.link
+            ele.x( 'title', e.title )
+            ele.x( 'link', nil, {'rel' => 'alternate', 'type' => 'text/html', 'href' => e.link } )
+            ele.x( 'id', "tag:#{ uri.host },#{ Time.now.year }:blog#{ CGI.escape(uri.path) }entry#{ CGI.escape( "/#{ e.id }" ) }" )
+            ele.x( 'published', e.created.strftime( "%Y-%m-%dT%H:%M:%SZ" ) )
+            ele.x( 'updated', (e.modified || e.created).strftime( "%Y-%m-%dT%H:%M:%SZ" ) )
+            ele.x( 'dc:subject', e.section_id )
+            e.tags.find_all {|t| not (t.nil? or t == '') }.each do |t|
+                ele.x( 'category', '', { 'term' => t, 'scheme' => "http://hobix.com/tags" } )
+            end
+            ele.x( 'summary', 
+                e.summary.to_html.gsub( /img src="\//, "img src=\"#{ vars[:weblog].link }/" ),
+                {'type' => 'html', 'mode' => 'escaped'} ) if e.respond_to? :summary and e.summary and !e.summary.empty?
+            author = vars[:weblog].authors[e.author]
+            ele_auth = REXML::Element.new 'author'
+            ele_auth.extend XmlQuick
+            ele_auth.x( 'name', author['name'] )
+            ele_auth.x( 'uri', author['url'] ) if author['url']
+            ele_auth.x( 'email', author['email'] ) if author['email']
+            ele << ele_auth
+            ele.x( 'content', e.content.to_html, {'type' => 'html'} )
+            rssdoc.elements['/feed'].add ele
+        end
+        rssdoc.to_s
+    end
+end
+end
+end

data/lib/hobix/out/erb.rb

@@ -0,0 +1,64 @@
+#
+# = hobix/out/erb.rb
+#
+# Hobix processing of ERB templates.
+#
+# 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 'erb'
+
+module Hobix
+module Out
+class ERBError < StandardError; end
+class ERB < Hobix::BaseOutput
+    def initialize( weblog )
+        @path = weblog.skel_path
+    end
+    def extension
+        "erb"
+    end
+    def load( file_name, vars )
+        @bind = binding
+        vars.each do |k, v|
+            k.untaint
+            k_inspect = k.inspect.untaint
+            eval( "#{ k } = vars[#{ k_inspect }]", @bind )
+        end
+        @relpath = File.dirname( file_name )
+        @load_erb = import_erb( file_name )
+        begin
+            @load_erb.result( @bind )
+        rescue Exception => e
+            raise ERBError, "Error `#{ e.message }' in erb #{ file_name }."
+        end
+    end
+    def expand( fname )
+        if fname =~ /^\//
+            File.join( @path, fname )
+        else
+            File.join( @relpath, fname )
+        end
+    end
+    def import( fname, bindto = @bind )
+        import_erb( expand( fname ) ).result( bindto )
+    end
+    def import_erb(fname)
+        File.open(fname) do |fp| 
+            src = fp.read.gsub( /<\+\s*([\w\.\/\\\-]+)\s*\+>/ ) do
+                File.read( expand( $1 ) )
+            end
+            ::ERB.new( src, nil, nil, "_hobixout#{ rand( 9999999 ) }" )
+        end
+    end
+end
+end
+end