ruwiki 0.9.0

data/Readme.rubygems

@@ -0,0 +1,86 @@
+Ruwiki 0.9.0
+------------
+Ruwiki is a simple, extensible Wiki-clone written in Ruby. It supports both
+CGI and WEBrick interfaces, templates, and CSS formatting. This Wiki differs
+from most other Wikis in that it supports project namespaces, so that two
+topics may be named the same for differing projects without colliding or
+having to resort to odd naming conventions. Please see the ::Ruwiki project in
+the running Wiki for more information. Ruwiki 0.9.0 has German and Spanish
+translations available.
+
+Upgrading
+---------
+Ruwiki 0.9.0 has a flatfile format that is incompatible with older versions of
+Ruwiki. If you are upgrading from one of these versions, you must use the
+bin/convert. The simple case will be (assuming that your data files are in
+./data):
+
+  % convert ./data
+
+The convert utility is automatically installed by RubyGems.
+
+Requirements
+------------
+Ruwiki currently requires:
+  * Ruby 1.8
+  * Diff::LCS 1.2.0
+  * Archive::Tar::Minitar 0.5.1
+
+The YAML backend requires Ruby 1.8.2 after preview2. You should have been
+prompted to load these dependencies on installation.
+
+Quick Start (WEBrick Readonly)
+------------------------------
+1. Type:
+
+   % ruwiki_servlet --gem-data
+
+2. Point your web browser to <http://localhost:8808/>.
+
+Quick Start (CGI)
+-----------------
+1. Create a directory in a place that your webserver can execute CGI programs
+   and type:
+
+   % ruwiki install cgi,data --to <directory>
+
+2. Ensure that ruwiki.cgi is executable on your webserver.
+3. Point your web browser to the appropriate URL.
+
+Quick Start (WEBrick)
+---------------------
+1. Create a directory to store your data and templates and type:
+
+   % ruwiki install data --to <directory>
+
+2. Type:
+
+   % ruwiki_servlet
+
+3. Point your web browser to <http://localhost:8808/>.
+
+Configuration
+-------------
+There are extensive configuration options available. The Ruwiki WEBrick
+servlet offers command-line options that simplify the configuration of Ruwiki
+without editing the servlet; use ruwiki_servlet --help for more information.
+
+Copyright
+---------
+Copyright:  Copyright � 2002 - 2004, Alan Chen and Austin Ziegler
+Authors:    Alan Chen (alan@digikata.com)
+            Austin Ziegler (ruwiki@halostatue.ca)
+Licence:    Ruby's
+
+Credits
+-------
+* This software includes portions of Diff::LCS by Austin Ziegler, available
+  for download from the Ruwiki RubyForge project:
+  [http://rubyforge.org/projects/ruwiki/]
+* Portions of this software are derived from Dave Thomas's RDoc system, now
+  part of the Ruby distribution.
+
+* Translation to German by [mailto:chneukirchen@yahoo.de Christian Neukirchen].
+* Translation to Spanish by [mailto:batsman.geo@yahoo.com Mauricio Fern�ndez].
+
+$Id: Readme.rubygems,v 1.3 2004/11/28 23:59:18 austin Exp $

data/Readme.tarfile

@@ -0,0 +1,65 @@
+Ruwiki 0.9.0
+------------
+Ruwiki is a simple, extensible Wiki-clone written in Ruby. It supports both
+CGI and WEBrick interfaces, templates, and CSS formatting. This Wiki differs
+from most other Wikis in that it supports project namespaces, so that two
+topics may be named the same for differing projects without colliding or
+having to resort to odd naming conventions. Please see the ::Ruwiki project in
+the running Wiki for more information. Ruwiki 0.9.0 has German and Spanish
+translations available.
+
+Upgrading
+---------
+Ruwiki 0.9.0 has a flatfile format that is incompatible with versions of
+Ruwiki older than 0.8.0. If you are upgrading from one of these versions, you
+must use the bin/convert. The simplest case will be (assuming that your data
+files are in ./data):
+
+  % bin/convert ./data
+
+Requirements
+------------
+Ruwiki currently requires:
+  * Ruby 1.8
+  * Diff::LCS 1.2.0
+  * Archive::Tar::Minitar 0.5.1
+
+The YAML backend requires Ruby 1.8.2 after preview2. Portions of Diff::LCS and
+Archive::Tar::Minitar have been included in this version of Ruwiki.
+
+Quick Start (CGI)
+-----------------
+1. Place the Ruwiki directory in a place that your webserver can execute CGI
+   programs and ensure that ruwiki.cgi is executable on your webserver.
+2. Point your web browser to the appropriate URL.
+
+Quick Start (WEBrick)
+---------------------
+1. Run bin/ruwiki_servlet (ruby bin/ruwiki_servlet under Windows).
+2. Point your web browser to <http://localhost:8808/>.
+
+Configuration
+-------------
+There are extensive configuration options available. The Ruwiki WEBrick
+servlet offers command-line options that simplify the configuration of Ruwiki
+without editing the servlet; use ruwiki_servlet --help for more information.
+
+Copyright
+---------
+Copyright:  Copyright � 2002 - 2004, Alan Chen and Austin Ziegler
+Authors:    Alan Chen (alan@digikata.com)
+            Austin Ziegler (ruwiki@halostatue.ca)
+Licence:    Ruby's
+
+Credits
+-------
+* This software includes portions of Diff::LCS and Archive::Tar::Minitar by
+  Austin Ziegler, available for download from the Ruwiki RubyForge project:
+  [http://rubyforge.org/projects/ruwiki/]
+* Portions of this software are derived from Dave Thomas's RDoc system, now
+  part of the Ruby distribution.
+
+* Translation to German by [mailto:chneukirchen@yahoo.de Christian Neukirchen].
+* Translation to Spanish by [mailto:batsman.geo@yahoo.com Mauricio Fern�ndez].
+
+$Id: Readme.tarfile,v 1.1 2004/09/22 15:13:30 austin Exp $

data/bin/ruwiki

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+#--
+# Ruwiki
+#   Copyright � 2002 - 2004, Digikata and HaloStatue
+#   Alan Chen (alan@digikata.com)
+#   Austin Ziegler (ruwiki@halostatue.ca)
+#
+# Licensed under the same terms as Ruby.
+#
+# $Id: ruwiki,v 1.5 2004/11/26 12:18:46 austin Exp $
+#++
+
+  # 1) Try to load Ruwiki from the local directory structure (e.g., ./lib/
+  #    and ../lib/).
+  # 2) Try to load Ruwiki from the directory structure of the running script
+  #    (e.g., File.dirname($0)/lib and File.dirname($0)/../lib).
+  # 3) Try to load Ruwiki from the directory structure of the current file
+  #    (e.g., File.dirname(__FILE__)/lib and File.dirname(__FILE__)/../lib).
+  # 4) Try to load Ruwiki from an unmodified $LOAD_PATH, e.g., site_ruby.
+  # 5) Try to load Ruwiki from Rubygems.
+  # 6) Fail hard.
+load_state = 1
+
+$LOAD_PATH.unshift "#{Dir.pwd}/lib", "#{Dir.pwd}/../lib"
+
+begin
+  require 'ruwiki'
+rescue LoadError
+  if (1..3).include?(load_state)
+    $LOAD_PATH.shift # Oh, what I'd give for $LOAD_PATH.shift(2)
+    $LOAD_PATH.shift
+  end
+
+  load_state += 1
+
+  case load_state
+  when 2
+    $LOAD_PATH.unshift "#{File.dirname($0)}/lib", "#{File.dirname($0)}/../lib"
+  when 3
+    $LOAD_PATH.unshift "#{File.dirname(__FILE__)}/lib", "#{File.dirname(__FILE__)}/../lib"
+  when 5
+    require 'rubygems'
+  when 6
+    raise
+  end
+  retry
+end
+
+require 'ruwiki/utils'
+require 'ruwiki/utils/manager'
+
+  # RPA Maintainers: Change this to the appropriate location on installation.
+  # This is the right place for RubyGems, basically.
+ss = "#{File.dirname(File.expand_path(__FILE__))}/.."
+
+Ruwiki::Utils::Manager.shared = ss
+
+exit Ruwiki::Utils::Manager.run(ARGV)

data/bin/ruwiki.cgi

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+#--
+# Ruwiki
+#   Copyright � 2002 - 2004, Digikata and HaloStatue
+#   Alan Chen (alan@digikata.com)
+#   Austin Ziegler (ruwiki@halostatue.ca)
+#
+# Licensed under the same terms as Ruby.
+#
+# This file may be renamed to change the URI for the wiki.
+#
+# $Id: ruwiki.cgi,v 1.6 2004/11/26 12:18:46 austin Exp $
+#++
+
+  # 1) Try to load Ruwiki from the local directory structure (e.g., ./lib/
+  #    and ../lib/).
+  # 2) Try to load Ruwiki from the directory structure of the running script
+  #    (e.g., File.dirname($0)/lib and File.dirname($0)/../lib).
+  # 3) Try to load Ruwiki from the directory structure of the current file
+  #    (e.g., File.dirname(__FILE__)/lib and File.dirname(__FILE__)/../lib).
+  # 4) Try to load Ruwiki from an unmodified $LOAD_PATH, e.g., site_ruby.
+  # 5) Try to load Ruwiki from Rubygems.
+  # 6) Fail hard.
+load_state = 1
+
+$LOAD_PATH.unshift "#{Dir.pwd}/lib", "#{Dir.pwd}/../lib"
+
+begin
+  require 'ruwiki'
+rescue LoadError
+  if (1..3).include?(load_state)
+    $LOAD_PATH.shift # Oh, what I'd give for $LOAD_PATH.shift(2)
+    $LOAD_PATH.shift
+  end
+
+  load_state += 1
+
+  case load_state
+  when 2
+    $LOAD_PATH.unshift "#{File.dirname($0)}/lib", "#{File.dirname($0)}/../lib"
+  when 3
+    $LOAD_PATH.unshift "#{File.dirname(__FILE__)}/lib", "#{File.dirname(__FILE__)}/../lib"
+  when 5
+    require 'rubygems'
+  when 6
+    raise
+  end
+  retry
+end
+
+  # This is the CGI version of Ruwiki. Therefore, when we create the Ruwiki
+  # instance, we specify that the request and response handlers are to be
+  # generated from a new CGI object.
+wiki = Ruwiki.new(Ruwiki::Handler.from_cgi(CGI.new))
+
+config_file = File.join(Dir.pwd, Ruwiki::Config::CONFIG_NAME)
+
+if File.exists?(config_file)
+  wiki.load_config(config_file)
+  config = Ruwiki::Config.read(config_file)
+  if config.webmaster.nil? or config.webmaster.empty?
+    config.webmaster = "webmaster@domain.tld"
+  end
+else
+    # Configuration defaults to certain values. This overrides the defaults.
+    # The webmaster.
+  wiki.config.webmaster       = "webmaster@domain.tld"
+
+# wiki.config.debug           = false
+# wiki.config.title           = "Ruwiki"
+# wiki.config.default_page    = "ProjectIndex"
+# wiki.config.default_project = "Default"
+    # This next defaults to 'flatfiles'. Conversion of the default data will
+    # be necessary to use other formats.
+# wiki.config.storage_type    = 'flatfiles'
+# wiki.config.storage_options[wiki.config.storage_type][:data_path] = "./data/"
+  wiki.config.storage_options[wiki.config.storage_type][:extension] = "ruwiki"
+# wiki.config.template_path   = "./templates/"
+# wiki.config.template_set    = "default"
+# wiki.config.css             = "ruwiki.css"
+# wiki.config.time_format     = "%H:%M:%S"
+# wiki.config.date_format     = "%Y.%m.%d"
+# wiki.config.datetime_format = "%Y.%m.%d %H:%M:%S"
+end
+
+wiki.config!
+wiki.run

data/bin/ruwiki_convert

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+#--
+# Ruwiki
+#   Copyright � 2002 - 2004, Digikata and HaloStatue
+#   Alan Chen (alan@digikata.com)
+#   Austin Ziegler (ruwiki@halostatue.ca)
+#
+# Licensed under the same terms as Ruby.
+#
+# This file may be renamed to change the URI for the wiki.
+#
+# $Id: ruwiki_convert,v 1.1 2004/11/28 02:26:57 austin Exp $
+#++
+
+  # 1) Try to load Ruwiki from the local directory structure (e.g., ./lib/
+  #    and ../lib/).
+  # 2) Try to load Ruwiki from the directory structure of the running script
+  #    (e.g., File.dirname($0)/lib and File.dirname($0)/../lib).
+  # 3) Try to load Ruwiki from the directory structure of the current file
+  #    (e.g., File.dirname(__FILE__)/lib and File.dirname(__FILE__)/../lib).
+  # 4) Try to load Ruwiki from an unmodified $LOAD_PATH, e.g., site_ruby.
+  # 5) Try to load Ruwiki from Rubygems.
+  # 6) Fail hard.
+load_state = 1
+
+$LOAD_PATH.unshift "#{Dir.pwd}/lib", "#{Dir.pwd}/../lib"
+
+begin
+  require 'ruwiki'
+rescue LoadError
+  if (1..3).include?(load_state)
+    $LOAD_PATH.shift # Oh, what I'd give for $LOAD_PATH.shift(2)
+    $LOAD_PATH.shift
+  end
+
+  load_state += 1
+
+  case load_state
+  when 2
+    $LOAD_PATH.unshift "#{File.dirname($0)}/lib", "#{File.dirname($0)}/../lib"
+  when 3
+    $LOAD_PATH.unshift "#{File.dirname(__FILE__)}/lib", "#{File.dirname(__FILE__)}/../lib"
+  when 5
+    require 'rubygems'
+  when 6
+    raise
+  end
+  retry
+end
+
+  # Load all of the known backends.
+require 'ruwiki/utils'
+require 'ruwiki/backend/flatfiles'
+require 'ruwiki/utils/converter'
+
+exit Ruwiki::Utils::Converter.run(ARGV)

data/bin/ruwiki_service.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+#--
+# Ruwiki
+#   Copyright � 2002 - 2004, Digikata and HaloStatue
+#   Alan Chen (alan@digikata.com)
+#   Austin Ziegler (ruwiki@halostatue.ca)
+#
+# Licensed under the same terms as Ruby.
+#
+# This file may be renamed to change the URI for the wiki.
+#
+# $Id: ruwiki_service.rb,v 1.6 2004/11/26 12:18:46 austin Exp $
+#++
+
+  # 1) Try to load Ruwiki from the local directory structure (e.g., ./lib/
+  #    and ../lib/).
+  # 2) Try to load Ruwiki from the directory structure of the running script
+  #    (e.g., File.dirname($0)/lib and File.dirname($0)/../lib).
+  # 3) Try to load Ruwiki from the directory structure of the current file
+  #    (e.g., File.dirname(__FILE__)/lib and File.dirname(__FILE__)/../lib).
+  # 4) Try to load Ruwiki from an unmodified $LOAD_PATH, e.g., site_ruby.
+  # 5) Try to load Ruwiki from Rubygems.
+  # 6) Fail hard.
+load_state = 1
+
+$LOAD_PATH.unshift "#{Dir.pwd}/lib", "#{Dir.pwd}/../lib"
+
+begin
+  require 'ruwiki'
+rescue LoadError
+  if (1..3).include?(load_state)
+    $LOAD_PATH.shift # Oh, what I'd give for $LOAD_PATH.shift(2)
+    $LOAD_PATH.shift
+  end
+
+  load_state += 1
+
+  case load_state
+  when 2
+    $LOAD_PATH.unshift "#{File.dirname($0)}/lib", "#{File.dirname($0)}/../lib"
+  when 3
+    $LOAD_PATH.unshift "#{File.dirname(__FILE__)}/lib", "#{File.dirname(__FILE__)}/../lib"
+  when 5
+    require 'rubygems'
+  when 6
+    raise
+  end
+  retry
+end
+
+require 'win32/service'
+require 'ruwiki/utils/servletrunner'
+
+class Ruwiki::Utils::Daemon < Win32::Daemon
+  LOCATION = File.dirname(File.expand_path(__FILE__))
+
+  def initialize
+    @logfile = File.open(File.join(LOCATION, "ruwiki_service.log"), "ab+")
+  rescue Exception => e
+    File.open(File.join(LOCATION, "temp.log"), "a+") do |f|
+      f.puts "Logfile error: #{e}"
+      f.puts "Backtrace:\n#{e.backtrace.join(', ')}"
+    end
+    exit
+  end
+
+  def service_main
+    ARGV.replace(["--config", File.join(LOCATION, Ruwiki::Config::CONFIG_NAME),
+                  "--logfile", File.join(LOCATION, "ruwiki_servlet.log")])
+    Ruwiki::Utils::ServletRunner.run(ARGV, @logfile, @logfile, @logfile)
+  rescue Exception => e
+    file = LOCATION + '/temp.log'
+    File.open(file, "a+") do |f|
+      f.puts "Error: #{e}"
+      f.puts "Backtrace: #{e.backtrace.join(', ')}"
+    end
+    exit
+  end
+end
+
+daemon = Ruwiki::Utils::Daemon.new
+daemon.mainloop

data/bin/ruwiki_servlet

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+#--
+# Ruwiki
+#   Copyright � 2002 - 2004, Digikata and HaloStatue
+#   Alan Chen (alan@digikata.com)
+#   Austin Ziegler (ruwiki@halostatue.ca)
+#
+# Licensed under the same terms as Ruby.
+#
+# This file may be renamed to change the URI for the wiki.
+#
+# $Id: ruwiki_servlet,v 1.5 2004/11/28 02:26:57 austin Exp $
+#++
+
+  # 1) Try to load Ruwiki from the local directory structure (e.g., ./lib/
+  #    and ../lib/).
+  # 2) Try to load Ruwiki from the directory structure of the running script
+  #    (e.g., File.dirname($0)/lib and File.dirname($0)/../lib).
+  # 3) Try to load Ruwiki from the directory structure of the current file
+  #    (e.g., File.dirname(__FILE__)/lib and File.dirname(__FILE__)/../lib).
+  # 4) Try to load Ruwiki from an unmodified $LOAD_PATH, e.g., site_ruby.
+  # 5) Try to load Ruwiki from Rubygems.
+  # 6) Fail hard.
+load_state = 1
+
+$LOAD_PATH.unshift "#{Dir.pwd}/lib", "#{Dir.pwd}/../lib"
+
+begin
+  require 'ruwiki'
+rescue LoadError
+  if (1..3).include?(load_state)
+    $LOAD_PATH.shift # Oh, what I'd give for $LOAD_PATH.shift(2)
+    $LOAD_PATH.shift
+  end
+
+  load_state += 1
+
+  case load_state
+  when 2
+    $LOAD_PATH.unshift "#{File.dirname($0)}/lib", "#{File.dirname($0)}/../lib"
+  when 3
+    $LOAD_PATH.unshift "#{File.dirname(__FILE__)}/lib", "#{File.dirname(__FILE__)}/../lib"
+  when 5
+    require 'rubygems'
+  when 6
+    raise
+  end
+  retry
+end
+
+require 'ruwiki/utils/servletrunner'
+
+exit Ruwiki::Utils::ServletRunner.run(ARGV)