instiki 0.9.2

data/README

@@ -0,0 +1,172 @@
+===What is Instiki?
+
+Admitted, it's YetAnotherWikiClone[http://c2.com/cgi/wiki?WikiWikiClones], but with a strong focus
+on simplicity of installation and running:
+
+Step 1. Download
+
+Step 2. Run "instiki"
+
+Step 3. Chuckle... "There's no step three!" (TM)
+
+You're now running a perfectly suitable wiki on port 2500 
+that'll present you with one-step setup, followed by a textarea for the home page
+on http://localhost:2500.
+
+Instiki lowers the barriers of interest for when you might consider
+using a wiki. It's so simple to get running that you'll find yourself
+using it for anything -- taking notes, brainstorming, organizing a 
+gathering.
+
+===Features:
+* Regular expression search: Find deep stuff really fast
+* Revisions: Follow the changes on every page from birth. Rollback to an earlier rev
+* Export to HTML or markup in a zip: Take the entire wiki with you home or for reference
+* RSS feeds to track recently revised pages
+* Multiple webs: Create separate wikis with their own namespace
+* Password-protected webs: Keep it private
+* Authors: Each revision is associated with an author, so you can see who changed what
+* Reference tracker: Which other pages are pointing to the current?
+* Speed: Using Madelein[http://madeleine.sourceforge.net] for persistence (all pages are in memory)
+* Three markup choices: Textile[http://www.textism.com/tools/textile] 
+  (default / RedCloth[http://www.whytheluckystiff.net/ruby/redcloth]), 
+  Markdown (BlueCloth[http://bluecloth.rubyforge.org]), and RDoc[http://rdoc.sourceforge.net/doc]
+* Embedded webserver: Through WEBrick[http://www.webrick.org]
+* Internationalization: Wiki words in any latin, greek, cyrillian, or armenian characters
+* Color diffs: Track changes through revisions
+
+===Missing:
+* File attachments
+
+===Install from gem:
+* Install rubygems
+* Run "gem install instiki"
+* Change to a directory where you want Instiki to keep its data files (for example,  ~/instiki/)
+* Run "instiki" - this will create a "storage" directory (for example, ~/instiki/storage), and start a new Wiki service
+
+Make sure that you always launch Instiki from the same working directory, or specify the storage directory in runtime parameters, such as:
+  instiki --storage ~/instiki/storage
+
+===Command-line options:
+* Run "instiki --help"
+
+===History:
+ * 0.9.2: Rollback takes the user to an edit form. The form has to be submitted for the change to take place.
+          Changed to use inline style on published pages
+          Fixed "forward in time" on the last revision before current page
+          Instiki won't log bogus error messages when creating a new Wiki.
+          Fixed deprecation warning for Object.id (introduced in Ruby 1.8.2)
+          Madeleine upgraded to 0.7.1
+          Madeleine snapshots are compressed
+          Packaged as a gem
+ * 0.9.1: Added performance improvements for updating existing pages
+          Fixed IP logging and RSS feeds behind proxies [With help from Guan Yang]
+          Fixed default storage directory (borked running on Windows) [Spotted by Curt Hibbs]
+ * 0.9.0: Added aliased links such as [[HomePage|that nice home page]] [Mark Reid]
+          Added include other page content with [[!include TableOfContents]] [Mark Reid]
+          Added delete orphan pages from the Edit Web screen [by inspiration from Simon Arnaud]
+          Added logging of IP address for authors (who's behind the rollback wars)
+          Added Categories pages through backlinks (use "categories: news, instiki" on start of line) [Mark Reid]
+          Added option to use bracket-style wiki links only (and hence ban WikiWords)
+          Added command-line option to specify different storage path
+          Added print view without navigation
+          Added character and page (2275 characters including spaces) counter (important for student papers)
+          Off by default, activate it on the Edit Web screen
+          Added LaTeX/PDF integration on Textile installations with pdflatex installed on system (EXPERIMENTAL)
+          Use the home page as a table of contents with a unordered list to control sections
+          Added limit of 15 to the number of pages included in RSS feed
+          Moved static parts of stylesheet to separate file [Lau T�rnskov]
+          Fixed better semantics for revision movement [Ryan Singer]
+          Fixed color diffs to work much better [Xen/Mertz/Atkins]
+          Fixed performance problems for All Pages list [Dennis Mertz]
+          Fixed lots of rendering bugs [Mark Reid]
+          Upgraded to RedCloth 2.0.11 [integrating the fine work of Dennis Mertz]
+ * 0.8.9: Added color diffs to see changes between revisions [Bill Atkins]
+              They're aren't quite perfect yet as new paragraphs split the <ins> tags (hence 0.8.9, not 0.9.0)
+          Added redirect to edit if content of page generates an error
+              (so the page doesn't become unusable on bugs in the markup engines)
+          Fixed update Web with different address bug [Denis Metz]
+          Fixed a bunch of wiki word rendering issues by doing wiki word detection and replacment at once
+          Upgraded to BlueCloth 0.0.3b (should fix loads of problems on Markdown wikis)
+ * 0.8.5: Instiki can now serve as a CMS by running a password-protected web with a published front
+          Added version check at startup (Instiki needs Ruby 1.8.1)
+ * 0.8.1: Actually included RedCloth 2.0.7 in the release
+ * 0.8.0: NOTE: Single-web wikis created in versions prior to 0.8.0 have "instiki" as their system password
+          Accepts wiki words in bracket style. Ex: [[wiki word]], [[c]],  [[We could'nt have done it!]]
+          Accepts camel-case wiki words in all latin, greek, cyrillian, and armenian unicode characters
+             Many thanks to Guan Yang for building the higher- and lower-case lookup tables
+             And thanks to Simon Arnaud for the initial patch that got the work started
+          Changed charset to UTF-8
+          Cut down on command-line options and replaced them with an per-web config screen
+          Added option to extend the stylesheet on a per-web basis to tweak the look in details
+          Added simple color options for variety
+          Added option to add/remove password protection on each web
+          Added the wiki name of the author locking a given page (instead of just "someone")
+          Removed single/multi-web distinction -- all Instikis are now multi-web
+          Load libraries from an unshifted load path, so that old installed libraries doesn't clash [Emiel van de Laar]
+          Keeps the author cookie forever, so you don't have to enter your name again and again
+          Fixed XHTML so it validates [Bruce D'Arcus]
+          Authors are no longer listed under orphan pages
+          Added export to markup (great for backups, potentially for switching wiki engine)
+          Don't link wiki words that proceeds from either /, = or ?
+            (http://c2.com/cgi/wiki?WikiWikiClones, /show/HomePage, cgi.pl?show=WikiWord without escaping)
+          Accessing an unexisting page redirects to a different url (/new/PageName)
+          Increased snapshot time to just once a day (cuts down on disk storage requirements)
+          Made RDoc support work better with 1.8.1 [Mauricio Fern�ndez]
+          Added convinient redirect from /wiki/ to /wiki/show/HomePage
+          Fixed BlueCloth bug with backticks at start of line
+          Updated to RedCloth 2.0.7 (and linked to the new Textile reference)
+ * 0.7.0: Added Markdown (BlueCloth) and RDoc [Mauricio Fern�ndez] as command-line markup choices
+          Added wanted and orphan page lists to All pages (only show up if there's actually orphan or wanted pages)
+          Added ISO-8859-1 as XML encoding in RSS feeds (makes FeedReader among others happy for special entities)
+          Added proper links in the RSS feed (but the body links are still relative, which NNW and others doesn't grok)
+          Added access keys: E => Edit, H => HomePage, A => All Pages, U => Recently Revised, X => Export
+          Added password-login through URL (so you can subscribe to feed on a protected web)
+          Added web passwords to the feed links for protected webs, so they work without manual login
+          Added the web name in small letters above all pages within a web
+          Polished authors and recently revised 
+          Updated to RedCloth 2.0.6
+          Changed content type for RSS feeds to text/xml (makes Mozilla Aggreg8 happy)
+          Changed searching to be case insensitive
+          Changed HomePage to display the name of the web instead
+          Changed exported HTML pages to be valid XHTML (which can be preprocessed by XSLT)
+          Fixed broken recently revised
+ * 0.6.0: Fixed Windows compatibility [Florian]
+          Fixed bug that would prevent Madeleine from taking snapshots in Daemon mode
+          Added export entire web as HTML in a zip file
+          Added RSS feeds
+          Added proper getops support for the growing number of options [Florian]
+          Added safe mode that forbids style options in RedCloth [Florian]
+          Updated RedCloth to 2.0.5
+ * 0.5.0: NOTE: 0.5.0 is NOT compatible with databases from earlier versions
+          Added revisions
+          Added multiple webs
+          Added password protection for webs on multi-web setups
+          Added the notion of authors (that are saved in a cookie)
+          Added command-line option for not running as a Daemon on Unix
+ * 0.3.1: Added option to escape wiki words with \
+ * 0.3.0: Brought all files into common style (including Textile help on the edit page)
+          Added page locking (if someone already is editing a page there's a warning)
+          Added daemon abilities on Unix (keep Instiki running after you close the terminal)
+          Made port 2500 the default port, so Instiki can be launched by dobbelt-click
+          Added Textile cache to speed-up rendering of large pages
+          Made WikiWords look like "Wiki Words"
+          Updated RedCloth to 2.0.4
+ * 0.2.5: Upgraded to RedCloth 2.0.2 and Madeleine 0.6.1, which means the
+          Windows problems are gone. Also fixed a problem with wikiwords
+          that used part of other wikiwords.
+ * 0.2.0: First public release
+
+===Download latest from: 
+* http://rubyforge.org/project/showfiles.php?group_id=186
+
+===Visit the official Instiki wiki:
+* http://www.instiki.org
+
+===License:
+* same as Ruby's
+
+---
+Author:: David Heinemeier Hansson
+Email::  david@loudthinking.com
+Weblog:: http://www.loudthinking.com

data/app/controllers/wiki.rb

@@ -0,0 +1,389 @@
+require "cgi"
+require "redcloth_for_tex"
+
+class WikiController < ActionControllerServlet
+  EXPORT_DIRECTORY = File.dirname(__FILE__) + "/../../storage/" unless const_defined?("EXPORT_DIRECTORY")
+
+  def index
+    if web_address
+      redirect_show "HomePage"
+    elsif !wiki.setup?
+      redirect_path "/new_system/"
+    elsif wiki.webs.length == 1
+      redirect_show "HomePage", wiki.webs.values.first.address
+    else
+      redirect_path "/web_list/"
+    end
+  end
+
+  # Administrating the Instiki setup --------------------------------------------
+
+  def new_system
+    wiki.setup? ? redirect_path("/") : render
+  end
+  
+  def new_web
+    redirect_path("/") if wiki.system["password"].nil?
+  end
+
+  def create_system
+    wiki.setup(@params["password"], @params["web_name"], @params["web_address"]) unless wiki.setup? 
+    redirect_path "/"
+  end
+
+  def create_web
+    redirect_path("/") unless wiki.authenticate(@params["system_password"])
+    wiki.create_web(@params["name"], @params["address"])
+    redirect_show("HomePage", @params["address"])
+  end
+  
+
+  # Outside a single web --------------------------------------------------------
+
+  def web_list
+    @system, @webs = wiki.system, wiki.webs.values
+    render "wiki/web_list"
+  end
+
+  def login
+    render "wiki/login"
+  end
+  
+  def authenticate
+    password_check(@params["password"]) ? redirect_show("HomePage") : redirect_action("login")
+  end
+
+  def static_style_sheet() render "static_style_sheet" end
+
+
+  # Within a single web ---------------------------------------------------------
+
+  def parse_category
+    @categories = web.categories
+    @category = @params["category"]
+    @pages_in_category = web.select { |page| page.in_category?(@category) }
+    @set_name = ( @categories.include?(@category) ? "category '#{@category}'" : "the web" )
+    @category_links = @categories.map do |c| 
+      (@category == c ? "<span class=\"selected\">#{c}</span>" : "<a href=\"?category=#{c}\">#{c}</a>")
+    end
+  end
+
+  def search
+    @query   = @params["query"]
+    @results = web.select { |page| page.content =~ /#{@query}/i }
+    @results.length == 1 ? redirect_show(@results.first.name) : render
+  end
+
+  def authors
+    @authors = web.select.authors
+  end
+  
+  def recently_revised
+    parse_category
+    @pages_by_revision = @pages_in_category.by_revision
+  end
+
+  def rss_with_content
+    @pages_by_revision = web.select.by_revision.first(15)
+    @uri = @req.request_uri
+    host = @req.meta_vars["HTTP_X_FORWARDED_HOST"] || "#{@uri.host}:#{@uri.port.to_s}"
+    @web_url = "#{@uri.scheme}://#{host}/#{@web.address}"
+    @res["Content-Type"] = "text/xml"
+    render "wiki/rss_feed"
+  end
+
+  def rss_with_headlines
+    @hide_description = true
+    rss_with_content
+  end
+
+  def list
+    parse_category
+    @pages_by_name = @pages_in_category.by_name 
+    @page_names_that_are_wanted = @pages_in_category.wanted_pages
+    @pages_that_are_orphaned = @pages_in_category.orphaned_pages
+  end
+  
+  def export_html
+    file_name = "#{web.address}-html-#{web.revised_on.strftime("%Y-%m-%d-%H-%M")}.zip"
+    file_path = EXPORT_DIRECTORY + file_name
+
+    export_pages_to_zip_file(file_path) unless FileTest.exists?(file_path)
+    send_export(file_name, file_path)
+  end
+
+  def export_markup
+    file_name = "#{web.address}-markup-#{web.revised_on.strftime("%Y-%m-%d-%H-%M")}.zip"
+    file_path = EXPORT_DIRECTORY + file_name
+
+    export_markup_to_zip_file(file_path) unless FileTest.exists?(file_path)
+    send_export(file_name, file_path)
+  end
+
+  def export_pdf
+    file_name = "#{web.address}-tex-#{web.revised_on.strftime("%Y-%m-%d-%H-%M")}"
+    file_path = EXPORT_DIRECTORY + file_name
+
+    export_web_to_tex(file_path + ".tex") unless FileTest.exists?(file_path + ".tex")
+    convert_tex_to_pdf(file_path + ".tex")
+    send_export(file_name + ".pdf", file_path + ".pdf")
+  end
+
+  def export_tex
+    file_name = "#{web.address}-tex-#{web.revised_on.strftime("%Y-%m-%d-%H-%M")}.tex"
+    file_path = EXPORT_DIRECTORY + file_name
+
+    export_web_to_tex(file_path) unless FileTest.exists?(file_path)
+    send_export(file_name, file_path)
+  end
+
+  def update_web
+    redirect_show("HomePage") unless wiki.authenticate(@params["system_password"])
+
+    wiki.update_web(
+      web.address, @params["address"], @params["name"], 
+      @params["markup"].intern, 
+      @params["color"], @params["additional_style"], 
+      @params["safe_mode"] ? true : false, 
+      @params["password"].empty? ? nil : @params["password"],
+      @params["published"] ? true : false, 
+      @params["brackets_only"] ? true : false,
+      @params["count_pages"] ? true : false
+    )
+
+    redirect_show("HomePage", @params["address"])
+  end
+  
+  def remove_orphaned_pages
+    if wiki.authenticate(@params["system_password"])
+      wiki.remove_orphaned_pages(web_address)
+      redirect_action "list/"
+    else
+      redirect_show "HomePage"
+    end
+  end
+
+  # Within a single page --------------------------------------------------------
+  
+  def show
+    if @page = wiki.read_page(web_address, page_name)
+      begin
+        render_action "page"
+      rescue => e
+        $stderr << e.backtrace.join("\n")
+        redirect_action "edit/#{CGI.escape(page_name)}?msg=#{CGI.escape(e.message)}"
+      end
+    else
+      redirect_action "new/#{CGI.escape(page_name)}"
+    end
+  end
+  
+  def published
+    if web.published then @page = wiki.read_page(web_address, page_name || "HomePage") else redirect_show("HomePage") end
+  end
+  
+  def print
+    @page = wiki.read_page(web_address, page_name)
+  end
+
+  def tex
+    @page = wiki.read_page(web_address, page_name)
+    @tex_content = RedClothForTex.new(@page.content).to_tex
+  end
+
+  def pdf
+    page = wiki.read_page(web_address, page_name)
+    safe_page_name = page.name.gsub(/\W/, "")
+    file_name = "#{safe_page_name}-#{web.address}-#{page.created_at.strftime("%Y-%m-%d-%H-%M")}"
+    file_path = EXPORT_DIRECTORY + file_name
+
+    export_page_to_tex(file_path + ".tex") unless FileTest.exists?(file_path + ".tex")
+    convert_tex_to_pdf(file_path + ".tex")
+    send_export(file_name + ".pdf", file_path + ".pdf")
+  end
+
+  def new
+    @page_name, @author = page_name, default_author
+  end
+
+  def edit
+    @page = wiki.read_page(web_address, page_name)
+
+    if !@page.locked?(Time.now) || @params["break_lock"]
+      @page.lock(Time.now, default_author)
+      @author = default_author
+      render
+    else
+      render "wiki/locked"
+    end
+  end
+  
+  def cancel_edit
+    @page = wiki.read_page(web_address, page_name)
+    @page.unlock
+    redirect_show
+  end
+  
+  def save
+    if web.pages[page_name]
+      page = wiki.revise_page(
+        web_address, page_name, @params["content"], Time.now, 
+        Author.new(@params["author"], remote_ip)
+      )
+
+      page.unlock
+    else
+      page = wiki.write_page(
+        web_address, page_name, @params["content"], Time.now, 
+        Author.new(@params["author"], remote_ip)
+      )
+    end
+
+    write_cookie("author", @params["author"], true)
+    redirect_show(page_name)
+  end
+
+  def revision
+    @page = wiki.read_page(web_address, page_name)
+    @revision = @page.revisions[@params["rev"].to_i]
+  end
+
+  def rollback
+    @page = wiki.read_page(web_address, page_name)
+    @revision = @page.revisions[@params["rev"].to_i]  
+  end
+
+  
+  protected
+    def before_action
+      if in_a_web? && !authorized?(web_address) && !%w( login authenticate published ).include?(action_name)
+        redirect_action("login")
+        return false
+      elsif in_a_web?
+        @web, @page_name, @action_name = web, page_name, action_name
+      end
+    end
+  
+    def action_name
+      if in_a_web?
+        request_path[1]
+      elsif action_methods.include?(request_path[0])
+        request_path[0]
+      else
+        "index"
+      end
+    end
+
+    def redirect_show(page = @page.name, web = web_address)
+      redirect_path "/#{web}/show/#{CGI.escape(page)}"
+    end
+
+    def redirect_action(action, web = web_address)
+      redirect_path "/#{web}/#{action}"
+    end
+
+
+
+  private
+    def wiki
+      WikiService.instance
+    end
+    
+    def web
+      wiki.webs[web_address]
+    end
+    
+    def in_a_web?
+      request_path.length > 1
+    end
+  
+    def web_address
+      request_path[0]
+    end
+
+    def page_name
+      CGI.unescape(request_path[2]) if request_path[2]
+    end
+    
+    def authorized?(web_address)
+      web.nil? ||
+      web.password.nil? || 
+      (read_cookie(web_address) && read_cookie(web_address) == web.password) ||
+      password_check(@params["password"])
+    end
+    
+    def default_author
+      read_cookie("author") || "AnonymousCoward"
+    end
+    
+    def password_check(password)
+      @params["password"] == web.password && write_cookie(web_address, @params["password"])
+    end
+    
+    def export_pages_to_zip_file(zip_file_path)
+      Zip::ZipOutputStream.open(zip_file_path) do |zos|
+        web.select.by_name.each do |@page|
+          zos.put_next_entry(@page.name + ".html")
+          zos.puts(template_engine("print").result(binding))
+        end
+
+        zos.put_next_entry("index.html")
+        zos.puts('<html><head><META HTTP-EQUIV="Refresh" CONTENT="0;URL=HomePage.html"></head></html>')
+      end
+    end
+
+    def export_markup_to_zip_file(zip_file_path)
+      Zip::ZipOutputStream.open(zip_file_path) do |zos|
+        web.select.by_name.each do |page|
+          zos.put_next_entry(page.name + ".#{web.markup}")
+          zos.puts(page.content)
+        end
+      end
+    end
+
+    def export_web_to_tex(file_path)
+      @web_name    = web.name
+      @tex_content = table_of_contents(web.pages["HomePage"].content.dup, render_tex_web)
+      File.open(file_path, "w") { |f| f.write(template_engine("tex_web").result(binding)) }
+    end
+    
+    def render_tex_web
+      web.select.by_name.inject({}) do |tex_web, page|
+        tex_web[page.name] = RedClothForTex.new(page.content).to_tex
+        tex_web
+      end
+    end
+
+    def export_page_to_tex(file_path)
+      tex
+      File.open(file_path, "w") { |f| f.write(template_engine("tex").result(binding)) }
+    end
+    
+    def convert_tex_to_pdf(tex_path)
+      `cd #{File.dirname(tex_path)}; pdflatex --interaction=scrollmode '#{File.basename(tex_path)}'`
+    end
+
+    def truncate(text, length = 30, truncate_string = "...")
+      if text.length > length then text[0..(length - 3)] + truncate_string else text end
+    end
+    
+    def render_markup_help
+      web ? sub_template("#{web.markup}_help") : ''
+    end
+    
+    def send_export(file_name, file_path, content_type = "application/zip")
+      @res["Content-Type"] = content_type
+      @res["Content-Disposition"] = "attachment; filename=#{file_name}"
+      @res["Content-Length"] = File.size(file_path)
+      File.open(file_path, "rb") { |f| @res.body = f.read }
+    end
+    
+    def template_engine(template_name)
+      ERB.new(IO.readlines(action_template_path(template_name)).join)
+    end
+    
+    def remote_ip
+      $stderr << "#{@req.meta_vars['HTTP_X_FORWARDED_FOR']} || #{@req.meta_vars['REMOTE_ADDR']}"
+      @req.meta_vars["HTTP_X_FORWARDED_FOR"] || @req.meta_vars["REMOTE_ADDR"]
+    end
+end