clwiki 2.0.0

data/config/initializers/clwiki.rb

@@ -0,0 +1,9 @@
+require 'cl_wiki/configuration'
+
+filename = File.join(File.dirname(__FILE__), '..', '..', 'config', 'clwiki.yml')
+
+conf_hash = YAML::load(::File.open(filename))[Rails.env]
+conf_hash['wiki_path'] = ::File.expand_path(conf_hash['wiki_path'], Rails.root)
+$wiki_conf = ClWiki::Configuration.new(conf_hash)
+$wiki_path = $wiki_conf.wiki_path
+$wiki_conf

data/config/routes.rb

@@ -0,0 +1,15 @@
+ClWiki::Engine.routes.draw do
+  root to: 'page#show'
+
+  # legacy CGI
+  match '/clwikicgi.rb', to: 'page#show', via: [:get], as: 'legacy'
+
+  get '/find' => 'page#find', as: 'page_find'
+  post '/find' => 'page#find'
+
+  get '/recent' => 'page#recent', as: 'recent'
+
+  get '/:page_name' => 'page#show', as: 'page_show'
+  get '/:page_name/edit' => 'page#edit', as: 'page_edit'
+  post '/:page_name' => 'page#update'
+end

data/lib/cl_wiki.rb

@@ -0,0 +1,12 @@
+require 'cl_wiki/engine'
+
+module ClWiki
+=begin
+  http://edgeguides.rubyonrails.org/engines.html#inside-an-engine
+
+  Some engines choose to use this file to put global configuration options for their
+  engine. It's a relatively good idea, and so if you want to offer configuration
+  options, the file where your engine's module is defined is perfect for that. Place
+  the methods inside the module and you'll be good to go.
+=end
+end

data/lib/cl_wiki/configuration.rb

@@ -0,0 +1,171 @@
+require File.dirname(__FILE__) + '/index'
+require 'yaml'
+
+$defaultConfFile = 'clwiki.yml'
+
+module ClWiki
+  class Configuration
+
+    USE_INDEX_NO = 0
+    USE_INDEX_DRB = 1
+    USE_INDEX_LOCAL = 2
+
+    attr_accessor :wiki_path, :cgifn, :indexPort, :cssHref, :template, :useGmt,
+                  :publishTag, :url_prefix, :global_edits, :cgifn_from_rss, :stats_name,
+                  :index_log_fn, :page_update_format
+    attr_reader   :custom_formatter_load_path
+
+    def wait_on_threads
+      # Ruby kills any threads as soon as the main process is done. Any
+      # threads created should be registered here. The last
+      # line of the CGI script should call out to wait_on_threads to make
+      # sure nothing running async in the background is terminated too early
+      @threads.each do |thread|
+        thread.join
+      end if !@threads.nil?
+    end
+
+    def wait_on_thread(thread)
+      @threads = [] if !@threads
+      @threads << thread
+    end
+
+    def useIndex
+      @useIndex
+    end
+
+    def useIndex=(value)
+      @useIndex = value.to_i
+    end
+
+    def edit_rows
+      @edit_rows
+    end
+
+    def edit_rows=(value)
+      @edit_rows = value.to_i
+    end
+
+    def edit_cols
+      @edit_cols
+    end
+
+    def edit_cols=(value)
+      @edit_cols = value.to_i
+    end
+
+    def useIndexForPageExists
+      @useIndexForPageExists
+    end
+
+    def useIndexForPageExists=(value)
+      if value.class == String
+        @useIndexForPageExists = (value =~ /true/i)
+      else
+        @useIndexForPageExists = value
+      end
+    end
+
+    def access_log_index
+      @access_log_index
+    end
+
+    def access_log_index=(value)
+      if value.class == String
+        @access_log_index = (value =~ /true/i)
+      else
+        @access_log_index = value
+      end
+    end
+
+    def override_access_log_index
+      @orig_access_log_index_value = @access_log_index
+      @access_log_index = false
+    end
+
+    def restore_access_log_index
+      @access_log_index = @orig_access_log_index_value if @orig_access_log_index_value
+    end
+
+    def editable
+      @editable
+    end
+
+    def editable=(value)
+      if value.class == String
+        @editable = (value =~ /true/i)
+      else
+        @editable = value
+      end
+    end
+
+    def showSourceLink
+      @showSourceLink
+    end
+
+    def showSourceLink=(value)
+      if value.class == String
+        @showSourceLink = (value =~ /true/i)
+      else
+        @showSourceLink = value
+      end
+    end
+
+    def self.load(filename=$defaultConfFile)
+      $wiki_conf = self.new(YAML::load(::File.open(filename)))
+      $wiki_path = $wiki_conf.wiki_path
+      $wiki_conf
+    end
+
+    def initialize(hash={})
+      default_hash.merge(hash).each do |k, v|
+        instance_variable_set(:"@#{k.to_s}", v)
+      end
+    end
+
+    def default_hash
+      {
+          :url_prefix => '/',
+          :indexPort => ClWiki::Indexer.defaultPort,
+          :cgifn => 'clwikicgi.rb',
+          :default_recent_changes_name => "Recent Changes",
+          :recent_changes_name => "Recent Changes",
+          :stats_name => "Hit Counts",
+          :useGmt => false,
+          :publishTag => nil,
+          :useIndexForPageExists => false,
+          :showSourceLink => false,
+          :cgifn_from_rss => 'blogki.rb',
+          :edit_rows => 25,
+          :edit_cols => 80,
+          :access_log_index => false,
+          :index_log_fn => nil,
+          :custom_formatter_load_path => []
+      }
+    end
+
+    def default_recent_changes_name=(value)
+      if @recent_changes_name == @default_recent_changes_name
+        @recent_changes_name = value
+      end
+      @default_recent_changes_name = default_recent_changes_name
+    end
+
+    def default_recent_changes_name
+      @default_recent_changes_name
+    end
+
+    def recentChangesName=(value)
+      @recent_changes_name = value
+      @recent_changes_name = @default_recent_changes_name if @recent_changes_name.empty?
+    end
+
+    alias recent_changes_name= recentChangesName=
+
+    def recentChangesName
+      @recent_changes_name
+    end
+
+    alias recent_changes_name recentChangesName
+  end
+end

data/lib/cl_wiki/engine.rb

@@ -0,0 +1,5 @@
+module ClWiki
+  class Engine < ::Rails::Engine
+    isolate_namespace ClWiki
+  end
+end

data/lib/cl_wiki/file.rb

@@ -0,0 +1,171 @@
+require 'fileutils'
+require 'time'
+
+$wikiPageExt = '.txt'
+
+module ClWiki
+  class File
+    attr_reader :name, :fileExt, :wikiRootPath, :pagePath, :modTimeAtLastRead
+    attr_accessor :clientLastReadModTime
+
+    def initialize(fullPageName, wikiRootPath, fileExt=$wikiPageExt, autocreate=true)
+      # fullPageName must start with / ?
+      @wikiRootPath = wikiRootPath
+      fullPageName = ClWiki::Util.convertToNativePath(fullPageName)
+      fullPageName.ensure_slash_prefix
+      @pagePath, @name = ::File.split(fullPageName)
+      @pagePath = '/' if @pagePath == '.'
+      @fileExt = fileExt
+      @metadata = {}
+      if autocreate
+        if file_exists?
+          readFile
+        else
+          writeToFile(default_content, false)
+        end
+      end
+    end
+
+    def content_is_default?
+      @contents.to_s == default_content
+    end
+
+    def delete
+      File.delete(fullPathAndName) if File.exists?(fullPathAndName)
+    end
+
+    def default_content
+      "Describe " + @name + " here."
+    end
+
+    def file_exists?
+      FileTest.exists?(fullPathAndName)
+    end
+
+    def fullPath
+      res = ::File.expand_path(::File.join(@wikiRootPath, @pagePath))
+      raise 'no dirs in fullPath' if res.split('/').empty?
+      res
+    end
+
+    def fullPathAndName
+      ::File.expand_path(@name + @fileExt, fullPath)
+    end
+
+    def fileName
+      raise Exception, 'ClWikiFile.fileName is deprecated, use fullPathAndName'
+      # fullPathAndName
+    end
+
+    def content
+      @contents
+    end
+
+    def content=(newContent)
+      writeToFile(newContent)
+    end
+
+    def writeToFile(content, checkModTime=true)
+      if checkModTime
+        # refactor, bring raiseIfMTimeNotEqual back into this class
+        ClWiki::Util.raiseIfMTimeNotEqual(@modTimeAtLastRead, fullPathAndName)
+        unless @clientLastReadModTime.nil?
+          ClWiki::Util.raiseIfMTimeNotEqual(@clientLastReadModTime, fullPathAndName)
+        end
+      end
+
+      make_dirs(fullPath)
+      ding_mtime
+      ::File.open(fullPathAndName, 'w+') do |f|
+        f.print(metadata_to_write)
+        f.print(content)
+      end
+      ::File.utime(@metadata['mtime'], @metadata['mtime'], fullPathAndName)
+      readFile
+    end
+
+    def ding_mtime
+      @metadata['mtime'] = Time.now
+    end
+
+    def metadata_to_write
+      @metadata.collect { |k, v| "#{k}: #{v}" }.join("\n") + "\n\n\n"
+    end
+
+    def make_dirs(dir)
+      # need to commit each dir as we make it, which is why we just don't
+      # call File::makedirs. Core code copied from ftools.rb
+      parent = ::File.dirname(dir)
+      return if parent == dir or FileTest.directory? dir
+      make_dirs parent unless FileTest.directory? parent
+      if ::File.basename(dir) != ""
+        Dir.mkdir dir, 0755
+      end
+    end
+
+    def readFile
+      ::File.open(fullPathAndName, 'r') do |f|
+        @modTimeAtLastRead = f.mtime
+        raw_lines = f.readlines
+        metadata_lines, content = split_metadata(raw_lines)
+        read_metadata(metadata_lines)
+        apply_metadata
+        @contents = content
+      end
+    end
+
+    def split_metadata(raw_lines)
+      start_index = 0
+      raw_lines.each_with_index do |ln, index|
+        if ln.chomp.empty?
+          next_line = raw_lines[index+1]
+          if next_line.nil? || next_line.chomp.empty?
+            start_index = index + 2
+            break
+          end
+        end
+      end
+      [raw_lines[0..start_index-3], raw_lines[start_index..-1]]
+    end
+
+    def read_metadata(lines)
+      @metadata = {}
+      lines.each do |ln|
+        key, value = ln.split(': ')
+        @metadata[key] = value
+      end
+    end
+
+    def apply_metadata
+      @modTimeAtLastRead = Time.parse(@metadata['mtime']) if @metadata.keys.include? 'mtime'
+    end
+  end
+
+  class Util
+    def self.raiseIfMTimeNotEqual(mtime_to_compare, file_name)
+      # reading the instance .mtime appears to take Windows DST into account,
+      # whereas the static File.mtime(filename) method does not
+      current_mtime = ::File.open(file_name) do |f|
+        f.mtime
+      end
+      if mtime_to_compare != current_mtime
+        raise FileModifiedSinceRead, "File has been modified since it was last read."
+      end
+    end
+
+    def self.convertToNativePath(path)
+      newpath = path.gsub(/\//, ::File::SEPARATOR)
+      newpath = newpath.gsub(/\\/, ::File::SEPARATOR)
+      return newpath
+    end
+  end
+
+  class FileError < Exception
+  end
+
+  class FileModifiedSinceRead < FileError
+  end
+
+  class FileMustUseWriteNewContent < FileError
+  end
+end

data/lib/cl_wiki/find_in_file.rb

@@ -0,0 +1,33 @@
+module ClWiki
+  class FindInFile
+    FULL_SEARCH = 0
+    FILE_NAME_ONLY = 1
+
+    attr_reader :find_path, :files
+
+    def initialize(find_path)
+      @find_path = find_path
+    end
+
+    def find(search_text, scope = FULL_SEARCH)
+      recursive_find_path = ::File.join(@find_path, '**', '*')
+      regex = /#{search_text}/i
+      @files = Dir[recursive_find_path].grep(regex)
+      if scope == FULL_SEARCH
+        Dir[recursive_find_path].each do |path_filename|
+          if ::File.stat(path_filename).file?
+            f = ::File.open(path_filename)
+            begin
+              @files << path_filename if f.grep(regex) != []
+            ensure
+              f.close unless f.nil?
+            end
+          end
+        end
+      end
+      @files.collect! { |fn| fn.sub(@find_path + '/', '') }
+      @files.uniq!
+      @files.length
+    end
+  end
+end

data/lib/cl_wiki/format/format.blockquote.rb

@@ -0,0 +1,15 @@
+class FormatBlockquote < ClWiki::CustomFormatter
+  def FormatBlockquote.match_re
+    /\[\].*\[\/\]/m
+  end
+  
+  def FormatBlockquote.format_content(content, page)
+    if content
+      content.gsub!(/\[\]/, "<blockquote>")
+      content.gsub!(/\[\/\]/, "</blockquote>")
+      content
+    end
+  end
+end
+
+ClWiki::CustomFormatters.instance.register(FormatBlockquote)

data/lib/cl_wiki/format/format.graphviz.digraph.rb

@@ -0,0 +1,16 @@
+class FormatGraphVizDiGraph < ClWiki::CustomFormatter
+  def FormatGraphVizDiGraph.match_re
+    /digraph.*\}/m
+  end
+  
+  def FormatGraphVizDiGraph.format_content(content, page)
+    content.sub!(/digraph.*\}/m,
+      '<a href="dot.rb?fn=' + page.fileFullPathAndName + '">' +
+      '<img src="dot.rb?fn=' + page.fileFullPathAndName + '">' +
+      '</a>'
+    )
+    content
+  end
+end
+
+ClWiki::CustomFormatters.instance.register(FormatGraphVizDiGraph)