hobix 0.6

data/lib/hobix/comments.rb

@@ -0,0 +1,98 @@
+#
+# = hobix/comments.rb
+#
+# Hobix command-line weblog system, API for comments.
+#
+# 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/facets/comments'
+
+module Hobix
+module Out
+class Quick
+append_def :head_tags_erb, %{
+  <meta http-equiv="Pragma" content="no-cache" />
+  <meta http-equiv="Expires" content="-1" />
+  <script type="text/javascript" src="<%= weblog.expand_path( '/js/prototype.js' ) %>"></script>
+  <script type="text/javascript">
+      function quickRedReference() {
+          window.open(
+              "http://hobix.com/textile/quick.html",
+              "redRef",
+              "height=600,width=550,channelmode=0,dependent=0," +
+              "directories=0,fullscreen=0,location=0,menubar=0," +
+              "resizable=0,scrollbars=1,status=1,toolbar=0"
+          );
+      }
+  </script>
+}
+
+append_def :entry_erb, %{
+    <% if entry and not defined? entries %>
+      <+ entry_comment +>
+      <+ entry_comment_form +>
+    <% end %> 
+}
+
+def entry_comment_erb; %{
+  <% entry_id = entry.id %>
+  <div id="comments">
+  <% comments = weblog.storage.load_attached( entry_id, "comments" ) rescue [] %>
+  <% comments.each do |comment| %>
+  <div class="entry">
+      <div class="entryAttrib">
+          <div class="entryAuthor"><h3><%= comment.author %></h3></div>
+          <div class="entryTime">said on <%= comment.created.strftime( "<nobr>%d %b %Y</nobr> at <nobr>%H:%M</nobr>" ) %></div>
+      </div>
+      <div class="entryContentOuter"><div class="entryContent"><%= comment.content.to_html %></div></div>
+  </div>
+  <% end %>
+} end
+
+def entry_comment_form_erb; %{
+  <div class="entry">
+  <form id="userComment" method="post" action="<%= weblog.expand_path( '/control/comment/' + entry_id )%>">
+    <div class="entryAttrib">
+       <div class="entryAuthor"><input name="<%= Hobix::Facets::Comments.form_field 'author' %>" type="textbox" size="15" maxlength="50" /></div>
+       <div id="liveTime" class="entryTime">said on <%= Time.now.strftime( "<nobr>%d %b %Y</nobr> at <nobr>%H:%M</nobr>")%></div>
+    </div>
+    <div class="entryContentOuter"><div class="entryContent">
+       <textarea name="<%= Hobix::Facets::Comments.form_field 'content' %>" rows="6" cols="50"></textarea>
+       <p><input type="button" name="pleasePreview" value="preview" 
+           onClick="new Ajax.Request( '<%= weblog.expand_path '/control/preview' %>', {parameters: Form.serialize('userComment'), onComplete: function(req) { $('textilePreview').innerHTML = req.responseText }})" />
+          <input type="submit" name="<%= Hobix::Facets::Comments.form_field 'submit' %>" value="&gt;&gt;" />
+          <small>* do <a href="javascript:quickRedReference();">fancy stuff</a> in your comment.</small>
+       </p>
+       <div id="textileWrap"><!-- <h4>PREVIEW PANE</h4> -->
+       <div id="textilePreview"></div>
+       </div>
+       </div>
+    </div></div>
+     
+  </form>
+  </div>
+} end
+end
+end
+
+class Comment < BaseContent
+  _! "Comment Information"
+  _ :author,    :req => true, :edit_as => :text, :search => :prefix
+  _ :created,   :edit_as => :datetime
+  _ :url,       :edit_as => :text
+  _ :email,     :edit_as => :text
+  _ :content,   :edit_as => :textarea, :search => :fulltext, :text_processor => true
+  _ :ipaddress, :edit_as => :text
+
+  yaml_type "tag:hobix.com,2005:comment"
+end
+end

data/lib/hobix/config.rb

@@ -0,0 +1,39 @@
+#
+# = hobix/config.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 'yaml'
+
+module Hobix
+class Config
+    attr_accessor :weblogs, :username, :personal, 
+                  :post_upgen, :use_editor
+    def initialize
+        @username = ENV['USER'] unless @username
+        self
+    end
+    def Config.load( conf_file )
+        c = YAML::load( File::open( conf_file ) )
+        c.keys.each do |k|
+            if k =~ /\s/
+                k_ = k.gsub( /\s/, '_' )
+                c[k_] = c.delete( k )
+            end
+        end
+        c = YAML::object_maker( Hobix::Config, c )
+        c.initialize
+    end
+end
+end

data/lib/hobix/datamarsh.rb

@@ -0,0 +1,110 @@
+require 'dbm'
+#
+# Marshal + DBM = DataMarsh
+# - Same interface as DBM class
+#
+module Hobix
+
+class DataMarsh < ::DBM
+    VERSION = "0.1"
+    def []( key )
+        fetch( key )
+    end
+    def []=( key, val )
+        store( key, val )
+    end
+    def fetch( keystr, ifnone = nil )
+        begin
+            val = super( keystr )
+            return Marshal::load( val ) if String === val
+        rescue IndexError
+        end
+        if block_given?
+            yield keystr
+        else
+            ifnone
+        end
+    end
+    def index( keystr )
+        super( keystr.to_yaml )
+    end
+    def values_at( *keys )
+        keys.collect { |k| fetch( k ) }
+    end
+    def delete( key )
+        v = super( key )
+        if String === v
+            v = Marshal::load( v ) 
+        end
+        v
+    end
+    def delete_if
+        del_keys = keys.dup
+        del_keys.delete_if { |k| yield( k, fetch( k ) ) == false }
+        del_keys.each { |k| delete( k ) } 
+        self
+    end
+    def reject
+        hsh = self.to_hash
+        hsh.reject { |k,v| yield k, v }
+    end
+    def each_pair
+        keys.each { |k| yield k, fetch( k ) }
+        self
+    end
+    def each_value
+        super { |v| yield Marshal::load( v ) }
+        self
+    end
+    def values
+        super.collect { |v| Marshal::load( v ) }
+    end
+    def has_value?( val )
+        each_value { |v| return true if v == val }
+        return false
+    end
+    def invert
+        h = {}
+        keys.each { |k| h[ self.fetch( k ) ] = k }
+        h
+    end
+    def replace( hsh )
+        clear
+        update( hsh )
+    end
+    def shift
+        a = super
+        a[1] = Marshal::load( a[1] ) if a
+        a
+    end
+    def select( *keys )
+        if block_given?
+            self.keys.collect { |k| v = self[k]; [k, v] if yield k, v }.compact
+        else
+            values_at( *keys )
+        end
+    end
+    def store( key, val )
+        super( key, val.to_yaml )
+        val
+    end
+    def update( hsh )
+        hsh.keys.each do |k|
+            self.store( k, hsh.fetch( k ) )
+        end
+        self
+    end
+    def to_a
+        a = []
+        keys.each { |k| a.push [ k, self.fetch( k ) ] }
+        a
+    end
+    def to_hash
+        h = {}
+        keys.each { |k| h[ k ] = self.fetch( k ) }
+        h
+    end
+    alias :each :each_pair
+end
+
+end

data/lib/hobix/entry.rb

@@ -0,0 +1,84 @@
+#
+# = hobix/entry.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$
+#++
+
+module Hobix
+# The Entry class stores complete data for an entry on the site.  All
+# entry extensions should behave like this class as well.
+#
+# == Properties
+#
+# At the very least, entry data should support the following
+# accessors.
+#
+# id::               The id (or shortName) for this entry.  Includes
+#                    the basic entry path.
+# link::             The full URL to this entry from the weblog.
+# title::            The heading for this entry.
+# tagline::          The subheading for this entry.
+# tags::             A list of free-tagged categories.
+# author::           The author's username.
+# contributors::     An Array of contributors' usernames.
+# created::          The time the Entry was initially created.
+# modified::         A modification time.
+# updated::          Used internally to ensure an entry has been generated.
+# summary::          A brief description of this entry.  Can be used
+#                    for an abbreviated text of a long article.
+# content::          The full text of the entry.
+#
+# The following read-only properties are also available:
+#
+# day_id::           The day ID can act as a path where other
+#                    entry, posted on the same day, are stored.
+# month_id::         A path for the month's entries.
+# year_id::          A path for the year's entries.
+class Entry < BaseEntry
+
+    _ :title,   :req => true, :edit_as => :text, :search => :fulltext
+    _ :tagline, :edit_as => :text, :search => :fulltext, :text_processor => true
+    _ :summary, :edit_as => :textarea, :search => :fulltext, :text_processor => true
+    _ :content, :req => true, :edit_as => :textarea, :search => :fulltext, :text_processor => true
+
+    # Hobix::Entry objects are typed in YAML as !hobix.com,2004/entry
+    # objects.  This type is virtually identical to !okay/news/feed objects,
+    # which are documented at http://yaml.kwiki.org/?OkayNews.
+    yaml_type "tag:okay.yaml.org,2002:news/entry#1.0"
+    yaml_type "tag:hobix.com,2004:entry"
+
+end
+end
+
+module Hobix
+# The EntryEnum class is mixed into an Array of entries just before
+# passing on to a template.  This Enumerator-like module provides some
+# common iteration of entries.
+module EntryEnum
+    # Calls the block with two arguments: (1) a Time object with
+    # the earliest date of an issued post for that day; (2) an
+    # Array of entries posted that day, in chronological order.
+    def each_day
+        last_day, day = nil, []
+        each do |e|
+            if last_day and last_day != e.day_id
+                yield day.first.created, day
+                day = []
+            end
+            last_day = e.day_id
+            day << e
+        end
+        yield day.first.created, day if last_day
+    end
+end
+end

data/lib/hobix/facets/comments.rb

@@ -0,0 +1,99 @@
+#
+# = hobix/facets/comments.rb
+#
+# Hobix command-line weblog system, API for comments.
+#
+# 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 Comments plugin adds a remote API for adding comments.
+# Basically, to add comments to your site, ensure the plugin
+# is loaded within your hobix.yaml `requires' list:
+#
+#   requires:
+#   - hobix/facets/comments
+#
+class Comments < BaseFacet
+    def self.form_field( name ); "hobix_comment:#{ name }" end
+    def self.comment_fields; ['author', 'content']; end
+    def self.comment_class; Hobix::Comment 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 "comment"
+                # Create the comment entry
+                on_entry = @weblog.storage.load_entry( entry_id )
+                comment = Comments.comment_class.new do |c|
+                    Comments.comment_fields.each do |cf|
+                        getf = Comments.form_field cf
+                        if app._POST[getf].to_s.empty?
+                            app.puts "Missing field `#{ getf }'.  Please back up and try again."
+                            return true
+                        end
+                        c.method( "#{ cf }=" ).call( app._POST[getf] )
+                    end
+                    c.created = Time.now
+                    c.ipaddress = app.remote_addr
+                end
+
+               # A quick hack to try akismet content spam checking
+               if @weblog.requires.detect{ |i| i['hobix/plugin/akismet'] }         
+                   @akismet = Akismet.new(@weblog.link, AkismetKey.key)
+                   if @akismet.verifyAPIKey
+                       if @akismet.commentCheck(
+                               app.remote_addr,                            # remote IP
+                               app.get_request_header('User-Agent'),       # user agent
+                               app.get_request_header('Referer'),          # http referer
+                               '',                                         # permalink
+                               'comment',                                  # comment type
+                               app._POST['hobix_comment:author'].to_s,     # author name
+                               '',                                         # author email
+                               '',                                         # author url
+                               app._POST['hobix_comment:comment'].to_s,    # comment text
+                               {})                                         # other
+                           app.puts( "Sorry, that smelled like spam. If wasn't meant to, go back and try again" )
+                           return true
+                       end
+                   else
+                       # If the key does not verify, post the comment
+                       # but note the failure in the apache error logs.
+                       $stderr.puts( "Hobix: Akismet API key did not verify." )
+                   end
+               end
+                   
+               # Save the comment, upgen
+               @weblog.storage.append_to_attachment( entry_id, 'comments', comment )
+               @weblog.regenerate :update
+               
+               # Redirect
+                link = @weblog.output_entry_map[entry_id]
+                app.setup_redirection( 302, @weblog.expand_path( link[:page].link ) )
+                return true
+            when "preview"
+                app.puts RedCloth.new( app._POST[Comments.form_field('content')] ).to_html
+                return true
+            end
+        end
+    end
+end
+
+end
+end