hobix 0.4

data/lib/hobix/trackbacks.rb

@@ -0,0 +1,94 @@
+#
+# = hobix/trackbacks.rb
+#
+# Hobix command-line weblog system, API 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/facets/trackbacks'
+require 'time'
+require 'rexml/document'
+
+module Hobix
+module Out
+class Quick
+  prepend_def :entry_title_erb, %{
+    <+ entry_trackback_rdf +>
+  }
+
+  def entry_trackback_rdf_erb; %{
+    <!--
+    <%= trackback_rdf_for( weblog, entry ) %>
+    -->
+  } end
+
+  append_def :entry_erb, %{
+    <% if entry and not defined? entries %><+ entry_trackback +><% end %>
+  }
+
+  def entry_trackback_erb; %{
+    <a name="trackbacks"></a>
+    <div id="trackbacks">
+    <% entry_id = entry.id %>
+    <% trackbacks = weblog.storage.load_attached( entry_id, "trackbacks") rescue [] %>
+    <% trackbacks.each do |trackback| %>
+    <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>
+        <div class="entryContentOuter"><div class="entryContent">
+            <h3><a href="<%= trackback.url %>"><%= trackback.title %></a></h3>
+            <%= trackback.excerpt %>
+        </div></div>
+    </div>
+    <% end %>
+    </div>
+  } end
+
+  private
+  def trackback_rdf_for( weblog, entry )
+    trackback_link = '%s/control/trackback/%s' % [weblog.link, entry.id]
+    doc = REXML::Document.new
+    rdf = doc.add_element( "rdf:RDF" )
+    rdf.add_namespace( "rdf", "http://www.w3.org/1999/02/22-rdf-syntax-ns#" )
+    rdf.add_namespace( "trackback", "http://madskills.com/public/xml/rss/module/trackback/" )
+    rdf.add_namespace( "dc", "http://purl.org/dc/elements/1.1/" )
+    desc = rdf.add_element( "rdf:Description" )
+    desc.add_attribute( "rdf:about", "")
+    desc.add_attribute( "trackback:ping", trackback_link )
+    desc.add_attribute( "dc:title", entry.title )
+    desc.add_attribute( "dc:identifier", entry.link )
+##  i've dropped the following fields because i don't think they're used, and
+##  dc:description in particular will potentially double the size of the 
+##  html pages. if they're actually useful to anyone, please re-add.
+##
+##  desc.add_attribute( "dc:description", ( entry.summary || entry.content ).to_html )
+##  desc.add_attribute( "dc:creator", entry.author )
+##  desc.add_attribute( "dc:date", entry.created.xmlschema )
+    doc.to_s
+  end
+end
+end
+
+class Trackback < BaseContent
+  _! "Trackback Information"
+  _ :blog_name, :edit_as => :text, :req => true
+  _ :url, :edit_as => :text, :req => true
+  _ :title, :edit_as => :text, :req => true
+  _ :excerpt , :edit_as => :text, :req => true
+  _ :created, :edit_as => :datetime
+  _ :ipaddress, :edit_as => :text
+
+  yaml_type "tag:hobix.com,2005:trackback"
+end
+end

data/lib/hobix/util/objedit.rb

@@ -0,0 +1,193 @@
+#
+# = hobix/util/objedit
+#
+# 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 'ncurses'
+require 'yaml'
+
+module Hobix
+module Util
+# The ObjEdit class provides an ncurses-based editor for
+# modifying Ruby objects.  The ncurses library must be installed,
+# which is available at http://ncurses-ruby.berlios.de/.
+def self.ObjEdit( obj )
+    include Ncurses
+    include Ncurses::Form
+    # Initialize ncurses
+    scr = Ncurses.initscr
+    out_obj = nil
+    Ncurses.start_color
+    Ncurses.cbreak
+    Ncurses.keypad scr, true
+
+    # Initialize few color pairs 
+    Ncurses.init_pair 1, COLOR_RED, COLOR_BLACK
+    Ncurses.init_pair 2, COLOR_WHITE, COLOR_BLACK
+    Ncurses.init_pair 3, COLOR_YELLOW, COLOR_BLACK
+    Ncurses.init_pair 4, COLOR_RED, COLOR_BLACK
+    scr.bkgd Ncurses.COLOR_PAIR(2) 
+
+    # Initialize the fields
+    y = 0
+    labels = []
+    label_end = 12
+    ivars = []
+    fields =
+        obj.property_map.collect do |ivar, flag, edit_as|
+            ht, wt = 1, 60
+            case edit_as
+            when :text
+                field = FIELD.new ht, wt, y, 1, 0, 0
+            when :textarea
+                ht, wt = 5, 60
+                field = FIELD.new ht, wt, y, 1, 60, 0
+            end
+            if y + ht + 8 >= Ncurses.LINES
+                field.set_new_page TRUE
+                y = 0
+            end
+            labels << [y + 2, ivar, ht, wt]
+            ivars << ivar[1..-1]
+            label_end = ivar.length + 3 if label_end < ivar.length + 3
+            y += ht + 1
+
+            field.field_opts_off O_AUTOSKIP
+            field.set_field_back A_REVERSE
+            field.set_field_fore A_BOLD
+            field_write( field, obj.instance_variable_get( ivar ) )
+            field
+        end
+
+    # Create the form
+    my_form = FORM.new fields
+    my_form.user_object = "Editing #{ obj.class }"
+    rows, cols = [], []
+    my_form.scale_form rows, cols
+
+    # Create the window
+    my_win = WINDOW.new rows[0] + 3, cols[0] + 20, 0, 0
+    my_win.bkgd Ncurses.COLOR_PAIR( 3 )
+    my_win.keypad TRUE
+
+    # Attach
+    my_form.set_form_win my_win
+    my_form.set_form_sub my_win.derwin( rows[0], cols[0], 2, label_end )
+    my_form.form_opts_off O_NL_OVERLOAD
+    my_form.post_form
+    labels.each do |y, ivar, ht, wt|
+        my_win.mvaddstr y, 2, ivar
+    end
+    scr.mvprintw Ncurses.LINES - 2, 28, "Use TAB to switch between fields"
+    scr.mvprintw Ncurses.LINES - 1, 28, "F2 to save | F3 to cancel"
+    scr.refresh
+    my_win.wrefresh
+
+    # Loop through to get user requests
+    pressed = []
+    while((ch = my_win.getch()) != KEY_F2)
+        pressed << ch
+        case ch
+        when 16 # Ctrl + P
+            my_form.form_driver REQ_PREV_PAGE
+            my_form.form_driver REQ_FIRST_FIELD
+
+        when 14 # Ctrl + N
+            my_form.form_driver REQ_NEXT_PAGE
+            my_form.form_driver REQ_LAST_FIELD
+
+        when KEY_C3, ?\t
+            # Go to next field
+            my_form.form_driver REQ_NEXT_FIELD
+            # Go to the end of the present buffer
+            # Leaves nicely at the last character
+            my_form.form_driver REQ_END_LINE
+          
+        when KEY_C1
+            # Go to previous field
+            my_form.form_driver REQ_PREV_FIELD
+            my_form.form_driver REQ_END_LINE
+
+        when KEY_UP
+            my_form.form_driver REQ_PREV_LINE
+
+        when KEY_DOWN
+            my_form.form_driver REQ_NEXT_LINE
+
+        when KEY_LEFT
+            # Go to previous character
+            my_form.form_driver REQ_PREV_CHAR
+
+        when KEY_RIGHT
+            # Go to previous field
+            my_form.form_driver REQ_NEXT_CHAR
+
+        when KEY_BACKSPACE, 010
+            my_form.form_driver REQ_DEL_PREV
+
+        when KEY_ENTER, ?\n, ?\r
+            my_form.form_driver REQ_NEW_LINE
+
+        when KEY_F3
+            return nil
+
+        else
+            # If this is a normal character, it gets Printed    
+            my_form.form_driver ch
+        end
+    end
+    # Un post form and free the memory
+    my_form.form_driver REQ_NEXT_FIELD
+    my_form.unpost_form
+    my_form.free_form
+    obj_props = {}
+    fields.each do |f|
+        b = field_read(f)
+        f.free_field()
+        if String === b and b.empty?
+            b = nil
+        end
+        obj_props[ivars.shift] = b
+    end
+    out_obj = YAML::transfer( obj.to_yaml_type[1..-1], obj_props )
+ensure
+    Ncurses.endwin
+    # p pressed
+    # p out_obj
+end
+def self.field_write( f, obj )
+    rows, cols, frow, fcol, nrow, nbuf = [], [], [], [], [], []
+    f.field_info( rows, cols, frow, fcol, nrow, nbuf )
+    if String === obj
+        obj = "#{ obj }"
+    end
+    str = obj.to_yaml( :BestWidth => cols[0] - 4 ).
+              sub( /^\-\-\-\s*(\>[0-9\-\+]*\n)?/, '' ).
+              gsub( /^([^\n]*)\n/ ) { |line| "%-#{cols}s" % [$1] }
+    f.set_field_buffer 0, str
+end
+def self.field_read( f )
+    rows, cols, frow, fcol, nrow, nbuf = [], [], [], [], [], []
+    f.field_info( rows, cols, frow, fcol, nrow, nbuf )
+    val = f.field_buffer(0).scan( /.{#{ cols[0] }}/ )
+    YAML::load(
+        if val.length > 1
+            "--- >\n  " + 
+            val.collect { |line| line.rstrip }.join( "\n  " ).rstrip
+        else
+            "--- #{ val[0] }"
+        end
+    )
+end
+end
+end

data/lib/hobix/util/patcher.rb

@@ -0,0 +1,155 @@
+#
+# = hobix/util/patcher
+#
+# 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 'fileutils'
+
+module Hobix
+module Util
+# The Patcher class applies Hobix's own YAML patch format to a directory.
+# These patches can create or append to existing plain-text files, as well
+# as modifying YAML files using YPath.
+#
+# To apply your patch:
+#
+#   patch_set = Hobix::Util::Patcher['1.patch', '2.patch']
+#   patch_set.apply('/dir/to/unaltered/code')
+#
+class PatchError < Exception; end
+class Patcher
+    # Initialize the Patcher with a list of +paths+ to patches which
+    # must be applied in order.
+    #
+    #   patch_set = Hobix::Util::Patcher.new('1.patch', '2.patch')
+    #   patch_set.apply('/dir/to/unaltered/code')
+    #
+    def initialize( *paths )
+        @patches = {}
+        paths.each do |path|
+            YAML::load_file( path ).each do |k, v|
+                ( @patches[k] ||= [] ) << v
+            end
+        end
+    end
+
+    # Alias for Patcher.new.
+    #
+    #   patch_set = Hobix::Util::Patcher['1.patch', '2.patch']
+    #   patch_set.apply('/dir/to/unaltered/code')
+    #
+    def Patcher.[]( *paths )
+        Patcher.new( *paths )
+    end
+
+    # Apply the patches loaded into this class against a +path+ containing
+    # unaltered files.
+    #
+    #   patch_set = Hobix::Util::Patcher['1.patch', '2.patch']
+    #   patch_set.apply('/dir/to/unaltered/code')
+    #
+    def apply( path )
+        @patches.map do |fname, patchset|
+            fname = File.join( path, fname ) # .gsub( /^.*?[\/\\]/, '' ) )
+            ftarg = File.read( fname ) rescue ''
+            ftarg = YAML::load( ftarg ) if fname =~ /\.yaml$/
+            
+            patchset.each_with_index do |(ptype, patch), patchno|
+                # apply the changes
+                puts "*** Applying patch ##{ patchno + 1 } for #{ fname } (#{ ptype })."
+                ftarg = method( ptype.gsub( /\W/, '_' ) ).call( ftarg, patch )
+            end
+
+            [fname, ftarg]
+        end.
+        each do |fname, ftext|
+            # save the files
+            if ftext == :remove
+                FileUtils.rm_rf fname
+            else
+                FileUtils.makedirs( File.dirname( fname ) )
+                ftext = ftext.to_yaml if fname =~ /\.yaml$/
+                File.open( fname, 'w+' ) { |f| f << ftext }
+            end
+        end
+    end
+
+    def file_remove( target, text )
+        :remove
+    end
+
+    def file_create( target, text )
+        text.to_s
+    end
+
+    def file_ensure( target, text )
+        target << text unless target.include? text
+        target
+    end
+
+    def yaml_merge( obj, merge )
+        obj = obj.value if obj.respond_to? :value
+        if obj.class != merge.class and merge.class != Hash
+            raise PatchError, "*** Patch failure since #{ obj.class } != #{ merge.class }."
+        end
+
+        case obj
+        when Hash
+            merge.each do |k, v|
+                if obj.has_key? k
+                    yaml_merge obj[k], v
+                else
+                    obj[k] = v
+                end
+            end
+        when Array
+            at = nil
+            merge.each do |v|
+                vat = obj.index( v )
+                if vat
+                    at = vat if vat > at.to_i
+                else
+                    if at
+                        obj[at+=1,0] = v
+                    else
+                        obj << v
+                    end
+                end
+            end
+        when String
+            obj.replace merge
+        else
+            merge.each do |k, v|
+                ivar = obj.instance_variable_get "@#{k}"
+                if ivar
+                    yaml_merge ivar, v
+                else
+                    obj.instance_variable_set "@#{k}", v
+                end
+            end
+        end
+
+        obj
+    end
+end
+end
+end
+
+YAML::add_domain_type( 'hobix.com,2004', 'patches/list' ) do |type, val|
+    val
+end
+['yaml-merge', 'file-create', 'file-ensure', 'file-remove'].each do |ptype|
+    YAML::add_domain_type( 'hobix.com,2004', 'patches/' + ptype ) do |type, val|
+        [ptype, val]
+    end
+end

data/lib/hobix/webapp/cli.rb

@@ -0,0 +1,195 @@
+# = webapp command line interface
+#
+# A web application using webapp has CLI (command line interface).
+# You can invoke a webapp script from command line.
+#
+#   xxx.cgi [options] [/path_info] [?query_string]
+#       -h, --help                       show this message
+#       -o, --output=FILE                set output file
+#           --cern-meta                  output header as CERN httpd metafile
+#           --server-name=STRING         set server name
+#           --server-port=INTEGER        set server port number
+#           --script-name=STRING         set script name
+#           --remote-addr=STRING         set remote IP address
+#           --header=NAME:BODY           set additional request header
+#
+# For example, hello.cgi, as follows, can be invoked from command line.
+#
+#   % cat hello.cgi 
+#   #!/usr/bin/env ruby
+#   require 'webapp'
+#   WebApp {|w| w.puts "Hello" }
+#   % ./hello.cgi 
+#   Status: 200 OK
+#   Content-Type: text/plain
+#   Content-Length: 6
+#  
+#   Hello
+#
+# webapp.rb can be used in command line directly as follows.
+# This document use the form to make examples short. 
+#
+#   % ruby -rwebapp -e 'WebApp {|w| w.puts "Hello" }'
+#   Status: 200 OK
+#   Content-Type: text/plain
+#   Content-Length: 6
+#  
+#   Hello
+#
+# The web application takes two optional argument: path info and query string.
+# The optional first argument which begins with '/' is path info.
+# The optional second argument which begins with '?' is query string.
+# Since '?' is a shell meta character, it should be quoted.
+#
+#   % ruby -rwebapp -e '
+#     WebApp {|w|
+#       w.puts w.path_info
+#       w.puts w.query_string
+#     }' /a '?q'
+#   Status: 200 OK
+#   Content-Type: text/plain
+#   Content-Length: 30
+#  
+#   /a
+#   #<WebApp::QueryString: ?q>
+#
+# If the option -o is specified, a response is generated on the specified file.
+# Note that the format is suitable for Apache mod_asis.
+#
+#   % ruby -rwebapp -e 'WebApp {|w| w.puts "Hello" }' -- -o ~/public_html/hello.asis
+#   % cat ~/public_html/hello.asis 
+#   Status: 200 OK
+#   Content-Type: text/plain
+#   Content-Length: 6
+#
+#   Hello
+# 
+# If the option --cern-meta is specified addition to -o,
+# The header in the response is stored in separated file.
+# Note that the format is suitable for Apache mod_cern_meta.
+#
+#   % ruby -rwebapp -e 'WebApp {|w| w.puts "Hello" }' -- --cern-meta -o ~/public_html/hello2.txt
+#   % cat ~/public_html/.web/hello2.txt.meta 
+#   Content-Type: text/plain
+#   Content-Length: 6
+#   % cat ~/public_html/hello2.txt 
+#   Hello
+#
+# The options --server-name, --server-port, --script-name and --remote-addr specifies  
+# information visible from web application.
+# For example, WebApp#server_name returns a server name specified by --server-name.
+#
+#   % ruby -rwebapp -e 'WebApp {|w| w.puts w.server_name }'
+#   Status: 200 OK
+#   Content-Type: text/plain
+#   Content-Length: 10
+#  
+#   localhost
+#   % ruby -rwebapp -e 'WebApp {|w| w.puts w.server_name }' -- --server-name=www.example.org
+#   Status: 200 OK
+#   Content-Type: text/plain
+#   Content-Length: 16
+#
+#   www.example.org
+#
+# The option --header specifies an additional request header.
+# For example, specifying "Accept-Encoding: gzip" makes output gzipped.
+#
+#   % ruby -rwebapp -e 'WebApp {|w| w.puts "Hello"*100 }' -- --header='Accept-Encoding: gzip'|cat -v 
+#   Status: 200 OK
+#   Content-Type: text/plain
+#   Content-Encoding: gzip
+#   Content-Length: 31
+#
+#   ^_M-^K^H^@^O^VM-TA^@^CM-sHM-MM-IM-IM-w^X%F^RM-A^E^@ZTsDM-u^A^@^@
+
+require 'optparse'
+
+module Hobix
+class WebApp
+  class Manager
+    # CLI (command line interface)
+    def run_cli
+      opt_output = '-'
+      opt_cern_meta = false
+      opt_server_name = 'localhost'
+      opt_server_port = 80
+      opt_script_name = "/#{File.basename($0)}"
+      opt_remote_addr = '127.0.0.1'
+      opt_headers = []
+      ARGV.options {|q|
+        q.banner = "#{File.basename $0} [options] [/path_info] [?query_string]"
+        q.def_option('-h', '--help', 'show this message') { puts q; exit(0) }
+        q.def_option('-o FILE', '--output=FILE', 'set output file') {|arg| opt_output = arg.untaint }
+        q.def_option('--cern-meta', 'output header as CERN httpd metafile') { opt_cern_meta = true }
+        q.def_option('--server-name=STRING', 'set server name') {|arg| opt_server_name = arg }
+        q.def_option('--server-port=INTEGER', 'set server port number') {|arg| opt_server_port = arg.to_i }
+        q.def_option('--script-name=STRING', 'set script name') {|arg| opt_script_name = arg }
+        q.def_option('--remote-addr=STRING', 'set remote IP address') {|arg| opt_remote_addr = arg }
+        q.def_option('--header=NAME:BODY', 'set additional request header') {|arg| opt_headers << arg.split(/:/, 2) }
+        q.parse!
+      }
+      if path_info = ARGV.shift
+        if %r{\A/} !~ path_info
+          ARGV.unshift path_info
+          path_info = nil
+        end
+      end
+      if query_string = ARGV.shift
+        if %r{\A\?} !~ query_string
+          ARGV.unshift query_string
+          query_string = nil
+        end
+      end
+      if !ARGV.empty?
+        raise "extra arguments: #{ARGV.inspect[1..-2]}"
+      end
+      path_info ||= ''
+      query_string ||= ''
+      setup_request = lambda {|req|
+        req.make_request_header_from_cgi_env({
+          'REQUEST_METHOD' => 'GET',
+          'SERVER_NAME' => opt_server_name,
+          'SERVER_PORT' => opt_server_port,
+          'SCRIPT_NAME' => opt_script_name,
+          'PATH_INFO' => path_info,
+          'QUERY_STRING' => query_string,
+          'SERVER_PROTOCOL' => 'HTTP/1.0',
+          'REMOTE_ADDR' => opt_remote_addr,
+          'CONTENT_TYPE' => ''
+        })
+        opt_headers.each {|name, body|
+          req.header_object.add name, body
+        }
+      }
+      output_response = lambda {|res|
+        if opt_output == '-'
+          res.output_cgi_status_field($stdout)
+          res.output_message($stdout)
+        else
+          if opt_cern_meta
+            dir = "#{File.dirname(opt_output)}/.web"
+            begin
+              Dir.mkdir dir
+            rescue Errno::EEXIST
+            end
+            open("#{dir}/#{File.basename(opt_output)}.meta", 'w') {|f|
+              #res.output_cgi_status_field(f)
+              res.output_header(f)
+            }
+            open(opt_output, 'w') {|f|
+              res.output_body(f)
+            }
+          else
+            open(opt_output, 'w') {|f|
+              res.output_cgi_status_field(f)
+              res.output_message(f)
+            }
+          end
+        end
+      }
+      primitive_run(setup_request, output_response)
+    end
+  end
+end
+end