Pimki 1.4.092 → 1.5.092

data/README-PIMKI

@@ -48,23 +48,35 @@ Pimki added features:
 * Expanded Search:
    * Search also tries to match the page names (not just contents).
    * Now showing part of sentance around match in search-results page
+* Advanced Search
+   * Case sensitivity
+   * Search as regex, phrase or words
+   * Search pages and bliki entries
+   * Search in page names / contents
+   * Limit search to selected categories
+   * Limit search to selected authors
 * Removed unnecessary (for me) stuff from the nav-bar: RSS, authors, export. 
   Moved to bottom of Home Page.
 * Minor stylesheet tweaks.
 
-ToDo:
-
-* Expand todo with @Context
-* Advanced Search
-   * Advanced Search options (not just regexp, case sensitivity etc)
-   * Highlight match on individual page when clicked form search results
-* Editable left-side menu options: by search results? by author?
-
 
 Command-line options:
 Run "ruby pimki.rb --help"
 
+Please note also that RedCloth (http://redcloth.rubyforge.org) is set to
+version 2.0.11 by default. Version 3.0.1 is a bit experimental. You can select
+which version of redcloth via --redcloth command line argument.
+
 History:
+1.5.092 Bug fixes & new features release
+    - Several bug fixes
+    - RedCloth is now defaulting to 2.0.11. Controllable thru commandline.
+    - Advanced Search
+    - c2 wiki links via [c2[PageName]]
+    - FavIcon (working in Firefox)
+    - Madeleine Snapshot Controls (thru edit_web)
+    
+
 1.4.092 New features release
     - Added a major/minor edit override for the default 'continous edit' when
       revising a page.

data/app/controllers/wiki.rb

@@ -5,7 +5,7 @@ RenderedTodo = Struct.new( :text, :context, :due_date )
 
 class WikiController < ActionControllerServlet
   EXPORT_DIRECTORY = WikiService.storage_path unless const_defined?("EXPORT_DIRECTORY")
-
+  
   def index
     if web_address
       redirect_show "HomePage"
@@ -76,12 +76,80 @@ class WikiController < ActionControllerServlet
   def search
     set_menu_pages
     @query = @params["query"]
-    rex = /#{@query}/i
-    @results = web.select { |page| rex.match(page.name) or rex.match(page.content) }
-    @bliki_results = web.bliki.values.select do |entry|
-      rex.match(entry.name) or rex.match(entry.content)
+    search_content = [nil, 'both', 'contents'].include? @params['fields']
+    search_names   = [nil, 'both', 'names'].include? @params['fields']
+ 
+    case @params['expression']
+      when 'regex', nil
+        rex = Regexp.new @query, (Regexp::IGNORECASE unless @params['case'])
+        @results = if [nil, 'all', 'pages', nil].include? @params['where'] 
+          web.select do |page| 
+            (search_names and rex.match(page.name)) or (search_content and rex.match(page.content)) 
+          end
+        else
+          []
+        end
+        @bliki_results = if [nil, 'all', 'bliki'].include? @params['where']
+          web.bliki.values.select do |entry|
+            (search_names and rex.match(entry.name)) or (search_content and rex.match(entry.content)) 
+          end
+        else
+          []
+        end
+      
+      when 'all'
+        words = @query.split(/\s/).reject { |w| w.empty? }
+        @results = if [nil, 'all', 'pages'].include? @params['where'] 
+          web.select do |page|
+            words.all? do |word|
+              (search_names and page.name.index(word)) or (search_content and page.content.index(word)) 
+            end
+          end
+        else
+          []
+        end
+        @bliki_results = if [nil, 'all', 'bliki'].include? @params['where']
+          web.bliki.values.select do |entry|
+            words.all? do |word|
+              (search_names and entry.name.index(word)) or (search_content and entry.content.index(word)) 
+            end
+          end
+        else
+          []
+        end
+        
+      when 'exact'
+        @results = if [nil, 'all', 'pages'].include? @params['where'] 
+          web.select do |page| 
+            (search_names and page.name.index(@query)) or (search_content and page.content.index(@query)) 
+          end
+        else
+          []
+        end
+        @bliki_results = if [nil, 'all', 'bliki'].include? @params['where']
+          web.bliki.values.select do |entry|
+            (search_names and entry.name.index(@query)) or (search_content and entry.content.index(@query)) 
+          end
+        else
+          []
+        end
+    end
+    
+    if !@params['category'].nil? and @params['category'] != 'noselect'
+      @selected_categories = parse_multi_select 'category'
+      @results.reject! { |page| (page.categories & @selected_categories).empty? }
+      @bliki_results.reject! { |page| (page.categories & @selected_categories).empty? }
+    end
+    
+    if !@params['author'].nil? and @params['author'] != 'noselect'
+      @selected_authors = parse_multi_select 'author'
+      @results.reject! { |page| (page.authors & @selected_authors).empty? }
+      @bliki_results.reject! { |page| (page.authors & @selected_authors).empty? }
     end
-    @results.length == 1 ? redirect_show(@results.first.name) : render
+    
+    redirect_show(@results.first.name) if @results.length == 1 && @bliki_results.length == 0
+    redirect_path("/#{web_address}/bliki_revision/#{@bliki_results.first.name}?rev=#{@bliki_results.first.revisions.size-1}") if @results.length == 0 && @bliki_results.length == 1
+    render_action "search"
   end
 
   def authors
@@ -151,7 +219,7 @@ class WikiController < ActionControllerServlet
   end
 
   def export_pdf
-    file_name = "#{web.address}-tex-#{web.revised_on.strftime("%Y-%m-%d-%H-%M")}"
+    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")
@@ -160,7 +228,7 @@ class WikiController < ActionControllerServlet
   end
 
   def export_tex
-    file_name = "#{web.address}-tex-#{web.revised_on.strftime("%Y-%m-%d-%H-%M")}.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)
@@ -170,6 +238,7 @@ class WikiController < ActionControllerServlet
   def edit_web #{{{
     parse_category
     set_mm_options
+    @snapshot_interval = MadeleineService.snapshot_interval_hours
   end #}}}
   
   def update_web
@@ -178,8 +247,8 @@ class WikiController < ActionControllerServlet
     set_mm_options
 
     wiki.update_web(
-      web.address, @params["address"], @params["name"], 
-      @params["markup"].intern, 
+      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"],
@@ -189,6 +258,7 @@ class WikiController < ActionControllerServlet
       @params['mind_map_size'],
       @params['symbols_map'],
       @params['links_map'],
+      @params['snapshots_interval'],
       @params['enable_dclick_edit'],
       @params['check_pass_on_edit'] == 'each_edit',
       @prog, @graph_type, @missing, @show_authors, @show_leaves, @selected_categories
@@ -197,12 +267,27 @@ class WikiController < ActionControllerServlet
     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/"
+  def administrate
+    @logger.info "Taking administrative action: #{@params['action']}"
+    if wiki.authenticate(@params['system_password'])
+      case @params['action']
+        when 'Delete Orphan Pages'
+          wiki.remove_orphaned_pages(web_address)
+        
+        when 'Clear Render Cache'
+          clear_render_cache true
+        
+        when 'Force Data Snapshot'
+          MadeleineService.take_snapshot
+          
+        when 'Clean Storage'
+          MadeleineService.clean_old_snapshots
+        
+      end
+      @message = 'Operation succeeded'
+      redirect_action 'edit_web/'
     else
-      redirect_show "HomePage"
+      redirect_show 'HomePage'
     end
   end
 
@@ -216,7 +301,8 @@ class WikiController < ActionControllerServlet
     @context    = @params['context']
     @sort_order = @params['sort_order']
 
-    clear_render_cache # hack to make sure we don't have old-style rendered todos.
+    # the clear_render_cache hack to make sure we don't have old-style rendered
+    # todos is no longer needed - can go thru the edit web to explicitely clear the cache.
     @todo_items = analyse_rendered_todo_items @pages_in_category.by_name
     @bliki_todo_items = analyse_rendered_todo_items web.bliki.values
 
@@ -281,9 +367,9 @@ class WikiController < ActionControllerServlet
     (due_date <=> Date.today) > -1 ? "todoFuture" : "todo"
   end
 
-  def clear_render_cache do_redirect=false
+  def clear_render_cache dont_redirect=false
     web.refresh_revisions
-    redirect_show 'HomePage' if do_redirect
+    redirect_path "/#{web_address}/edit_web/" unless dont_redirect
   end
   
   def set_menu_pages #{{{
@@ -294,8 +380,14 @@ class WikiController < ActionControllerServlet
       when 'recent'   then @all_pages.by_last_visited
       when 'viewed'   then @all_pages.by_most_viewed
       when 'revised'  then @all_pages.by_revision
-      when 'user'     then @menu_content = web.menu_content.revisions.last.display_content; nil
       when 'category' then web.select { |page| page.in_category?(web.menu_category) } 
+      when 'user'
+        @menu_content = if Page === web.menu_content
+          web.menu_content.revisions.last.display_content
+        else
+          web.menu_content
+        end
+        nil
       when 'linkers'
         web.select { |page|
           page.wiki_words.size > 0 
@@ -358,15 +450,22 @@ class WikiController < ActionControllerServlet
       @show_authors = @req.query['show_authors'] == 'on'
       @show_leaves = @req.query.empty? || @req.query['show_leaves'] == 'on'
       
-      # TODO: fix handling of multiple-select for whole application
-      @selected_categories = @req.body.split('&').map { |pair| 
-        pair.split('=') }.select  { |k,v| 
-          k == 'selected_categs' }.map { |k,v| v } if @req.body
-      @selected_categories ||= []
+      @selected_categories = parse_multi_select 'selected_categs'
       @selected_categories = [] if @selected_categories.include? 'all'
     end
   end #}}}
   
+  def parse_multi_select field #{{{
+    if @req.body
+      @req.body.split('&').map { |pair| 
+          pair.split('=') }.select  { |k,v| 
+            k == field }.map { |k,v| v }
+    else
+      []
+    end
+  end #}}}
+  
+  
   def edit_menu #{{{
     @menu_type = web.menu_type
     @menu_content = web.menu_content

data/app/models/chunks/engines.rb

@@ -14,7 +14,7 @@ module Engines
   class Textile < MarkupEngine
     def mask(content)
       rc = RedCloth.new(text,content.options[:engine_opts])
-      rc.rules = [:textile]
+      rc.rules = [:textile] if RedCloth::VERSION >= '3.0.0'
       rc.to_html
     end
   end
@@ -39,6 +39,10 @@ module Engines
     end
   end
 
-  MAP = { :textile => Textile, :red_markdown => RedMarkdown, :blue_markdown => BlueMarkdown, :rdoc => RDoc }
+  MAP = { :textile => Textile, 
+          :red_markdown => RedMarkdown, 
+          :blue_markdown => BlueMarkdown,
+          :markdown => BlueMarkdown,
+          :rdoc => RDoc }
 end
 

data/app/models/chunks/uri.rb

@@ -22,7 +22,7 @@ class URIChunk < Chunk::Abstract
   COUNTRY = '(?:au|at|be|ca|ch|de|dk|fr|hk|in|ir|it|jp|nl|no|pt|ru|se|sw|tv|tw|uk|us)'
 
   # These are needed otherwise HOST will match almost anything
-  TLDS = "\\.(?:#{GENERIC}|#{COUNTRY})\b" 
+  TLDS = "\\.(?:#{GENERIC}|#{COUNTRY})\\b"
 
   # Redefine USERINFO so that it must have non-zero length
   USERINFO = "(?:[#{UNRESERVED};:&=+$,]|#{ESCAPED})+"

data/app/models/chunks/wiki.rb

@@ -81,34 +81,35 @@ module WikiChunk
         @page_name, @link_text = match_data[1], match_data[1]
       end
     end
-
-    def mask(content) pre_mask + post_mask; end
-    def regexp() Regexp.new(pre_mask + post_mask) end
-    def escaped_text() (@escape.nil? ? nil : page_name) end # TODO: never set?
-    def link_text() WikiWords.separate(page_name) end	
   end
 
   # This chunk handles [bliki[entry name]].
   # This format can be easily duplicated for any other pre-configured redirection.
   class BlikiLink < WikiLink
-    def self.pattern() /\[bliki\[([\w\d\s]+)\]\]/ end
+    def self.pattern() /\[(\w+)\[([\w\d\s]+)\]\]/ end
 
     attr_reader :page_name, :link_text, :entry
 
     def initialize(match_data, revision)
       super(match_data, revision)
-      @page_name, @link_text = match_data[1], match_data[1]
+      @target, @page_name, @link_text = match_data[1], match_data[2], match_data[2]
     end
 
     def unmask(content)
       return self if content.sub!(regexp) { |match|
-        web = revision.page.web
-        entry = web.bliki[page_name]
-        if entry.nil?
-          "<span style='background:lightgrey;font-style:italic'>Unknown Bliki entry: '#{page_name}'</span>"
-        else
-          "<a class='existingWikiWord' href='/#{web.address}/bliki_revision/#{entry.name}?rev=#{entry.revisions.size-1}'>#{entry.name}</a>"
-        end
+        case @target
+        when 'bliki'
+          web = revision.page.web
+          entry = web.bliki[page_name]
+          if entry.nil?
+            "<span style='background:lightgrey;font-style:italic'>Unknown Bliki entry: '#{page_name}'</span>"
+          else
+            "<a class='existingWikiWord' href='/#{web.address}/bliki_revision/#{entry.name}?rev=#{entry.revisions.size-1}'>#{entry.name}</a>"
+          end
+          
+        when 'c2'
+          "<a href='http://c2.com/cgi/wiki?#{@page_name}'>C2::#{@page_name}</a>"
+      end
       }
     end
   end

data/app/models/page.rb

@@ -111,7 +111,7 @@ class Page
     end
     
     def revise_minor(content, created_at, author) #{{{
-      @revisions.last.created_at = Time.now
+      @revisions.last.created_at = created_at
       @revisions.last.content    = content
       @revisions.last.clear_display_cache
     end #}}}

data/app/models/wiki_content.rb

@@ -46,7 +46,7 @@ class WikiContent < String
   # markup of "link":URL.
   PRE_ENGINE_ACTIONS  = [ NoWiki, Category, Include, Literal::Pre, WikiSymbol, 
                           WikiChunk::Link, WikiChunk::BlikiLink ] 
-  POST_ENGINE_ACTIONS = [ Literal::Tags, WikiChunk::Word, URIChunk, Todo ]
+  POST_ENGINE_ACTIONS = [ Literal::Tags, URIChunk, WikiChunk::Word, Todo ]
   
 
   DEFAULT_OPTS = {
@@ -69,23 +69,22 @@ class WikiContent < String
     @options = Marshal.load(Marshal.dump(DEFAULT_OPTS)).update(options)
     @options[:engine] = Engines::MAP[@web.markup] || Engines::Textile
     
-    @options[:engine_opts] = []
-    case @options[:engine]
-      when Engines::Textile
+    @options[:engine_opts] = DEFAULT_OPTS[:engine_opts]
+    case @options[:engine].name
+      when 'Engines::Textile'
         if RedCloth::VERSION >= '3.0.0'
           # RedCloth v3 changes the default behaviour from not folding lines.
-          DEFAULT_OPTS[:engine_opts] = [:hard_breaks]
+          @options[:engine_opts] += [:hard_breaks]
         end
         @options[:engine_opts] += (@web.safe_mode ? [:filter_html, :filter_styles] : [])
         
-      when Engines::BlueMarkdown, Engines::RedMarkdown
+      when 'Engines::BlueMarkdown', 'Engines::RedMarkdown'
         @options[:engine_opts] += (@web.safe_mode ? [:filter_html, :filter_styles] : [])
         
-      when Engines::RDoc
+      when 'Engines::RDoc'
         nil
         
     end
-    
 
     @options[:post_engine_actions].delete(WikiChunk::Word) if @web.brackets_only
 
@@ -94,6 +93,8 @@ class WikiContent < String
     begin
       render!(@options[:pre_engine_actions] + [@options[:engine]] + @options[:post_engine_actions])
     rescue => e
+      puts "[#{DateTime.now.strftime '%F %T'}] DEBUG: #{e}"
+      puts e.backtrace
       @rendered = "<strong>#{e.message}</strong><br/><br/>#{e.backtrace.join('<br/>')}"
     end
   end

data/app/models/wiki_service.rb

@@ -8,6 +8,10 @@ require "author"
 class WikiService < MadeleineService
   attr_reader :webs, :system
 
+  # These methods do not change the state of persistent objects, and 
+  # should not be logged by Madeleine
+  automatic_read_only :authenticate, :read_page, :read_bliki_entry, :setup?, :webs
+
   def initialize
     @webs, @system = {}, {}
   end
@@ -31,7 +35,8 @@ class WikiService < MadeleineService
   
   def update_web(old_address, new_address, name, markup, color, additional_style, safe_mode = false, 
       password = nil, published = false, brackets_only = false, count_pages = false,
-      mind_map_size="7,7", symbols_map=nil, links_map=nil, 
+      mind_map_size="7,7", symbols_map=nil, links_map=nil,
+      snapshots_interval = 1,
       enable_dclick_edit=nil, check_pass_on_edit=false,
       prog=nil, graph_type=nil, missing=nil, show_authors=nil, show_leaves=nil, selected_categories=nil) 
 
@@ -40,6 +45,8 @@ class WikiService < MadeleineService
       @webs.delete(old_address)
       @webs[new_address].address = new_address
     end
+
+    MadeleineService.snapshot_interval_hours = snapshots_interval
     
     web = @webs[new_address]
     web.refresh_revisions if settings_changed?(web, markup, safe_mode, brackets_only)

data/app/views/navigation.rhtml

@@ -23,4 +23,5 @@ end
   <%= list_item "Export", "../export/", "Download a zip with all the pages in this wiki", "X" %> |
   -->
   <input type="text" id="searchField" name="query" style="font-size: 10px" value="Search" onClick="this.value == 'Search' ? this.value = '' : true">
+  <%= list_item "<small>(Adv)</small>", "../adv_search/", "Advanced Search" %>
 </form>