clwiki 2.0.0

data/LICENSE

@@ -0,0 +1,31 @@
+---------------------------------------------------------------------------
+Copyright (c) 2001-2013, Chris Morris
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+3. Neither the names Chris Morris, cLabs nor the names of contributors to
+this software may be used to endorse or promote products derived from this
+software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
+IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+--------------------------------------------------------------------------
+(based on BSD Open Source License)

data/Rakefile

@@ -0,0 +1,53 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ClWiki'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+# Customized additions to the Rails Engine Rakefile below,
+# since the current frankenstein setup has the core clWiki
+# with Test::Unit tests and the new Rails Engine bits with RSpec.
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :tests do
+  errors = %w(test spec).collect do |task|
+    begin
+      Rake::Task[task].invoke
+      nil
+    rescue => e
+      { task: task, exception: e }
+    end
+  end.compact
+
+  if errors.any?
+    puts errors.map { |e| "Errors running #{e[:task]}! #{e[:exception].inspect}" }.join("\n")
+    abort
+  end
+end
+
+task default: :tests

data/app/assets/javascripts/cl_wiki/application.js

@@ -0,0 +1,29 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .
+
+
+function findFocus() {
+  if ($('.findResults li').length > 0) {
+    $('.findResults li:first a').focus();
+  } else {
+    $(".findForm input[type='text']").focus();
+  }
+}
+
+// to cope with rails 4 turbolinks
+$(document).ready(findFocus);
+$(document).on('page:change', findFocus);

data/app/assets/stylesheets/cl_wiki/application.css

@@ -0,0 +1,103 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+
+
+ */
+
+
+body {
+    font-family: "Verdana", Arial, serif;
+}
+
+a:link {
+    color: #00f;
+    text-decoration: none;
+}
+
+a:visited {
+    color: #00f;
+}
+
+a:hover {
+    color: #77f;
+}
+
+a:active {
+    color: #77f;
+}
+
+.wikiBody {
+    font-size: 90%;
+    padding: 20px 20px 20px 20px;
+}
+
+.wikiBody pre {
+    font-size: 125%;
+}
+
+.wikiPageData {
+    font-size: 80%;
+    font-style: italic;
+}
+
+.wikiHeader {
+    font-size: 110%;
+    margin-bottom: 5px;
+}
+
+.wikiFooter {
+    font-size: 90%;
+    margin-bottom: 5px;
+}
+
+.wikiFooter ul {
+    list-style-type: none;
+    padding: 0px;
+}
+
+.wikiFooter li {
+    display: inline;
+    padding-right: 10px;
+}
+
+.findInput {
+    width: 40%;
+    margin: 0 auto;
+    text-align: center;
+}
+
+.findInput div {
+    float: left;
+    text-align: left;
+    padding: 20px;
+}
+
+.findForm {
+    text-align: right;
+}
+
+.findDetails {
+    text-align: left;
+    font-size: 80%;
+    padding-bottom: 10px;
+}
+
+.findResults {
+    text-align: center;
+    width: 50%;
+    margin: auto;
+}
+
+.findResults li {
+    list-style-type: none;
+    padding: 15px;
+    float: left;
+}

data/app/controllers/cl_wiki/application_controller.rb

@@ -0,0 +1,4 @@
+module ClWiki
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/cl_wiki/page_controller.rb

@@ -0,0 +1,106 @@
+require 'cl_wiki/page'
+
+module ClWiki
+  class PageController < ApplicationController
+    before_filter :redirect_legacy_cgi_urls
+    before_filter :initialize_formatter
+    before_filter :assign_page_name
+    before_filter :redirect_to_front_page_if_bad_name, :only => :show
+
+    def show
+      @page = ClWiki::Page.new(@page_name)
+      @page.read_content
+      @page
+    end
+
+    def edit
+      @page = ClWiki::Page.new(@page_name)
+      @page.read_raw_content
+      @page
+    end
+
+    def update
+      @page = ClWiki::Page.new(@page_name)
+      @page.update_content(params[:page_content], Time.at(params[:client_mod_time].to_s.to_i))
+      redirect_to params[:save_and_edit] ? page_edit_url(:page_name => @page.full_name.strip_slash_prefix) : page_show_url(:page_name => @page.full_name.strip_slash_prefix)
+    end
+
+    def find
+      @formatter = ClWiki::PageFormatter.new
+      @search_text = params[:search_text]
+      @results = []
+      if @search_text
+        hits = search(@search_text)
+
+        hits.each do |full_name|
+          @formatter.fullName = full_name
+          @results << "#{@formatter.convertToLink(full_name)}"
+        end
+      end
+    end
+
+    def search(text)
+      case $wiki_conf.useIndex
+        when ClWiki::Configuration::USE_INDEX_NO
+          finder = FindInFile.new($wiki_path)
+          finder.find(text)
+          finder.files.collect do |filename|
+            filename.sub($wikiPageExt, '')
+          end
+        else
+          ClWiki::IndexClient.new.search(text)
+      end
+    end
+
+    def recent
+      finder = FindInFile.new($wiki_path)
+      finder.find($wiki_conf.publishTag || '.')
+      @pages = finder.files.collect do |filename|
+        p = ClWiki::Page.new(filename.sub($wikiPageExt, ''))
+        p.read_page_attributes
+        p
+      end
+      @pages = @pages.sort { |a, b| b.mtime <=> a.mtime }[0..9]
+      without_header_and_footer = false
+      @pages.each { |p| p.read_content(without_header_and_footer) }
+
+      respond_to do |format|
+        format.html
+        format.rss { render :layout => false }
+      end
+    end
+
+    def front_page_name
+      'FrontPage'
+    end
+
+    def redirect_legacy_cgi_urls
+      if request.fullpath.start_with?(legacy_path)
+        page_name = (params[:page] || front_page_name).split('/')[-1]
+        case
+          when request.query_parameters.include?('edit')
+            redirect_to page_edit_url(:page_name => page_name)
+          else
+            redirect_to page_show_url(:page_name => page_name)
+        end
+      end
+    end
+
+    def assign_page_name
+      @page_name = params[:page_name]
+      @page_name = @page_name.ensure_slash_prefix if @page_name
+    end
+
+    def redirect_to_front_page_if_bad_name
+      if ((@page_name.blank?) || (!@formatter.is_wiki_name?(@page_name))) ||
+          (!$wiki_conf.editable && !ClWiki::Page.page_exists?(@page_name.ensure_slash_prefix))
+        redirect_to page_show_url(:page_name => front_page_name)
+        return
+      end
+    end
+
+    def initialize_formatter
+      @formatter = ClWiki::PageFormatter.new
+    end
+  end
+end

data/app/helpers/cl_wiki/application_helper.rb

@@ -0,0 +1,4 @@
+module ClWiki
+  module ApplicationHelper
+  end
+end

data/app/views/cl_wiki/page/edit.html.erb

@@ -0,0 +1,8 @@
+<%= form_tag(page_show_path(:page_name => @page.full_name)) do %>
+  <%= hidden_field_tag 'client_mod_time', @page.mtime.to_i.to_s %>
+
+  <%= text_area_tag 'page_content', CGI.escapeHTML(@page.raw_content), rows: $wiki_conf.edit_rows, cols: $wiki_conf.edit_cols %>
+  <br/>
+  <%= submit_tag 'Save', name: 'save' %>
+  <%= submit_tag 'Save and Continue Editing', name: 'save_and_edit' %>
+<% end %>

data/app/views/cl_wiki/page/find.html.erb

@@ -0,0 +1,27 @@
+<%= @formatter.header("Find").html_safe %>
+
+<div class='findInput'>
+  <div class='findForm'>
+    <%= form_tag(page_find_path) do %>
+      <%= text_field_tag 'search_text', @search_text %>
+      <%= submit_tag 'Find', name: 'find' %>
+    <% end %>
+  </div>
+
+  <div class='findDetails'>
+    <span>"this that" => <i><b>this</b></i> and <b><i>that</i></b></span><br/>
+    <span>"the" => <i><b>the</b></i>, <i><b>the</b>ater</i>, <i>soo<b>the</b></i>, <i>o<b>the</b>r</i></span>
+  </div>
+</div>
+
+<div style='clear: left'></div>
+
+<div class='findResults'>
+  <ul>
+    <% @results.each do |result| %>
+      <li><%= result.html_safe %></li>
+    <% end %>
+  </ul>
+</div>
+
+<%= @formatter.footer("Find").html_safe %>

data/app/views/cl_wiki/page/recent.html.erb

@@ -0,0 +1,4 @@
+<% @pages.each do |page| %>
+  <%= @formatter.convertToLink(page.name).html_safe %>
+  <%= page.content.html_safe %>
+<% end %>

data/app/views/cl_wiki/page/recent.rss.builder

@@ -0,0 +1,18 @@
+xml.instruct! :xml, :version => "1.0"
+xml.rss :version => "2.0" do
+  xml.channel do
+    xml.title "clWiki"
+    xml.description "clWiki"
+    xml.link root_url
+
+    for page in @pages
+      xml.item do
+        xml.title page.name
+        xml.description page.content
+        xml.pubDate page.mtime.to_s(:rfc822)
+        xml.link page_show_url(:page_name => page.name)
+        xml.guid page_show_url(:page_name => page.name)
+      end
+    end
+  end
+end

data/app/views/cl_wiki/page/show.html.erb

@@ -0,0 +1 @@
+<%= @page.content.html_safe %>

data/app/views/layouts/cl_wiki/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ClWiki</title>
+  <%= stylesheet_link_tag    "cl_wiki/application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "cl_wiki/application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/clwiki.yml

@@ -0,0 +1,73 @@
+production:
+  # path to the root directory that stores the page files
+  wiki_path: wikirep
+
+  # useIndex can be one of the three numbers:
+  #  0 No Index
+  #  1 DRb Index Server
+  #  2 Local Index Server
+
+  useIndex: 0
+
+  # useIndexForPageExists determines if the index is referenced for
+  # determining if a page exists rather than querying the file system. In
+  # some cases, the file system (due to OS caching and whatnot) outperforms
+  # the index. This option is ignored if useIndex is set to No Index.
+
+  useIndexForPageExists: false
+
+  # the port the DRb Index Server uses. This setting is irrelevant if
+  # useIndex is anything other than 1
+
+  # indexPort: 9111
+
+  # set this to false for a read-only wiki. Useful with Blogki
+
+  editable: false
+
+  # enable this option to use an external style sheet
+
+  # cssHref http://www.my.domain/stylesheet.css
+
+  # enable this option to have the wiki rendered in a template. See the
+  # sample.template.htm file for how to use this option. (NOTE: this is a
+  # BETA option -- probably not even a sample.template.htm included in the
+  # distribution)
+
+  # template mytemplate.htm
+
+  # If you want to restrict the Recent view to only published pages, you
+  # can configure a custom tag here. If this isn't defined, then every
+  # page will appear on the Recent view.
+  #
+  # publishTag <publish>
+
+  # showSourceLink can be turned on to add a page link in the footer that
+  # is a file:// url direct to the raw page. Default is false.
+  #
+  # showSourceLink true
+
+  # time format for display of last page update
+  #
+  page_update_format: '%B %d, %Y'
+
+  # Add directories containing optional custom formatters here.
+  #
+  custom_formatter_load_path: []
+
+test:
+  wiki_path: tmp/testrep
+  useIndex: 0
+  useIndexForPageExists: false
+  editable: true
+  page_update_format: '%B %d, %Y'
+  custom_formatter_load_path: []
+
+development:
+  # path to the root directory that stores the page files
+  wiki_path: wikirep
+  useIndex: 0
+  useIndexForPageExists: false
+  editable: true
+  page_update_format: '%B %d, %Y'
+  custom_formatter_load_path: []