Wiki2Go 1.17.5 → 1.22.0

data/lib/Wiki2Go/Wiki2Go.rb

@@ -1,60 +1,147 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+gem 'diff-lcs'
+
+require 'cgi'
 
 require "Wiki2Go/WikiFormatter"
+require "Wiki2Go/HTMLFormatter"
 
 require 'Web2Go/ERB_Interpreter'
 require 'Web2Go/MockRequest'
 
+require 'diff/lcs'
+
 module Wiki2Go
 
+  class SpamException < RuntimeError
+  end
+  
   class Wiki
     def initialize(config)
       @config  = config
     end
-
-    def view(web)
+    
+    def view(web,version)
+      text = load_page_version(web,version)
+      
+      template = @config.storage.load_template(web.name,"view.htm")
+      
       html = @config.redirect_to_html?(web)
       formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,@config.editable?(web))
-
-      text = @config.storage.load_page(web.name,web.current_page)        
-      template = @config.storage.load_template(web.name,"view.htm")
-
-      return formatter.format_page_in_template(template,text) 
+      
+      result = formatter.format_page_in_template(template,text,version)
+      return result 
     end
-
+    
     def versions(web)
+      topics = all_good_versions(web)
+      template = @config.storage.load_template(web.name,"versionlist.htm")
+      
       html = @config.redirect_to_html?(web)
       formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,@config.editable?(web))
-
-      topics = @config.storage.all_versions_of(web.name,web.current_page) 
-      template = @config.storage.load_template(web.name,"versionlist.htm")
-
+      
       return formatter.format_pagelist_in_template(template,topics,"","Versions of '#{web.current_page}'") 
     end
-
+    
+    def diff(web,version1,version2)
+      from,from_page,to,to_page = load_two_versions(web,version1,version2)
+      
+      from_lines = break_on_br(from_page.lines)
+      to_lines   = break_on_br(to_page.lines)
+      
+      html = @config.redirect_to_html?(web)
+      formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,@config.editable?(web))
+      
+      header = "<strong>#{to_page.name} "
+      header << append_blank(formatter.diff_link(web.name,from_page.filename,'&lt;&lt;',from-1,to))
+      header << formatter.view_version_link(web.name,from_page.filename,"v#{from.to_s} (by #{from_page.alias})",from)
+      link = formatter.diff_link(web.name,from_page.filename,'&gt;&gt;',from+1,to)
+      header << (link.length > 0 ? ' ' + link : '' )
+      header << ' => '
+      header << append_blank(formatter.diff_link(web.name,from_page.filename,'&lt;&lt;',from,to-1))
+      header << formatter.view_version_link(web.name,to_page.filename,"v#{to.to_s} (by #{to_page.alias})",to) + ' ' 
+      header << formatter.diff_link(web.name,from_page.filename,'&gt;&gt;',from,to+1)
+      header << "</strong>\n<hr>\n"
+      
+      lines = Array.new       
+      lines << header 
+      sdiff = Diff::LCS.sdiff(from_lines,to_lines,nil) do |change|
+        case change.action
+        when '='
+          lines  << "<div class=\"diff_kept\">=&nbsp;#{CGI::escapeHTML(change.old_element).gsub(' ','&nbsp;')}</div>"
+        when '!'
+          lines  << "<div class=\"diff_deleted\">&lt;&nbsp;#{CGI::escapeHTML(change.old_element).gsub(' ','&nbsp;')}</div>"
+          lines  << "<div class=\"diff_added\">&gt;&nbsp;#{CGI::escapeHTML(change.new_element).gsub(' ','&nbsp;')}</div>"
+        when '-'
+          lines  << "<div class=\"diff_deleted\">&lt;&nbsp;#{CGI::escapeHTML(change.old_element).gsub(' ','&nbsp;')}</div>"
+        when '+'
+          lines  << "<div class=\"diff_added\">&gt;&nbsp;#{CGI::escapeHTML(change.new_element).gsub(' ','&nbsp;')}</div>"
+        end 
+      end
+      
+      to_page.lines = lines
+      template = @config.storage.load_template(web.name,"view.htm")
+      
+      return formatter.dump_page_in_template(template,to_page,from,to) 
+    end
+    
+    def sidebyside(web,version1,version2)
+    
+      from,from_page,to,to_page = load_two_versions(web,version1,version2)
+      
+      template = @config.storage.load_template(web.name,"view.htm")
+      
+      html = @config.redirect_to_html?(web)
+      formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,@config.editable?(web))
+      
+      left = formatter.format_page(from_page.content)
+      right = formatter.format_page(to_page.content)
+      
+      
+      leftheader = append_blank(formatter.sidebyside_link(web.name,from_page.filename,'&lt;&lt;',from-1,to))
+      leftheader << formatter.view_version_link(web.name,from_page.filename,"#{to_page.name} v#{from.to_s} (by #{from_page.alias})",from)
+      leftheader << formatter.sidebyside_link(web.name,from_page.filename,'&gt;&gt;',from+1,to)
+      
+      rightheader =  append_blank(formatter.sidebyside_link(web.name,from_page.filename,'&lt;&lt;',from,to-1))
+      rightheader << formatter.view_version_link(web.name,to_page.filename,"#{to_page.name} v#{to.to_s} (by #{to_page.alias})",to) + ' ' 
+      rightheader << formatter.sidebyside_link(web.name,from_page.filename,'&gt;&gt;',from,to+1)
+      
+      
+      content = "<table class=\"wikitable\" width=\"100%\"><tr>"
+      content += "<th>#{leftheader}</th><th>#{rightheader}</th></tr>\n"
+      content += "<tr><td width='50%' valign='top'>#{left}</td><td width='50%' valign='top'>#{right}</td></tr></table>"
+      to_page.lines = content.split($/)
+      
+      
+      return formatter.dump_page_in_template(template,to_page,from,to) 
+    end
+    
     def view_dynamic(web)
       html = false
       editable = @config.editable?(web)
       formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,editable)
-
+      
       text = @config.storage.load_page(web.name,web.current_page)        
       template = @config.storage.load_template(web.name,"view.htm")
-
+      
       return formatter.format_page_in_template(template,text) 
     end
-
+    
     def view_html(web)
       html = true
       editable = @config.editable?(web)
       web = @config.static_web(web)
       formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,editable)
-
+      
       text = @config.storage.load_page(web.name,web.current_page)        
       template = @config.storage.load_template(web.name,"view.htm")
-
+      
       return formatter.format_page_in_template(template,text) 
     end
-
+    
     def generate_rss(web,changes)
       html = @config.generate_html
       editable = false
@@ -64,7 +151,7 @@ module Wiki2Go
       rss = formatter.generate_rss(template,changes)
       return rss
     end
-
+    
     def generate_rss_from_log(web,errorlog)
       html = @config.generate_html
       editable = false
@@ -73,35 +160,40 @@ module Wiki2Go
       rss = formatter.generate_rss_from_log(errorlog)
       return rss
     end
-
+    
     def edit(web)
-      html = @config.redirect_to_html?(web)
-      formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,@config.editable?(web))
-
-      text = @config.storage.load_page(web.name,web.current_page)        
-      template = @config.storage.load_template(web.name,"edit.htm")
-
-      return formatter.put_page_in_template(template,text) 
+      do_edit(web,'edit.htm')
     end
-
-    def save(web,new_content)
-      new_content = new_content.join('\r\n') if new_content.kind_of? Array
+    
+    def wikiedit(web)
+      do_edit(web,'wikiedit.htm')
+    end
+    
+    def save(web,new_content,checksum="")
       new_content.gsub!(/\t/,'   ')
+      
+      blacklist_robots(web,checksum)
+      
+      author   = web.user
+      pagename = web.name.length > 0 ? "#{web.name}/#{web.current_page}" : web.current_page 
 
       changed = true
       newfile = !@config.storage.exists(web.path)
       newpage = Page.new(web.current_page,new_content,web.user,Time.now,web.title,web.alias)
+      current = @config.storage.load_page(web.name,web.current_page)
+
       if !newfile then
-        current = @config.storage.load_page(web.name,web.current_page)
         changed = (current.content != newpage.content) || newpage.name != current.name
         newpage.created_on = current.created_on
       end      
-
+      
       if changed then
+        if !@config.accept_edit?(web,current,checksum) then
+          @config.errorlog("Edit by user #{author} of page '#{pagename}' clashes with edit of #{current.alias}")
+        end
         if @config.accept_page?(web,new_content) then
           @config.save(web,newpage)
-          changes = @config.storage.read_changes_in(web.name,20)
-          save_rss(web,changes)
+          save_changes_in_rss(web)
           @config.instant_commit_to_repository
           if @config.generate_html then
             if newfile then
@@ -112,13 +204,15 @@ module Wiki2Go
           end
         else
           @config.storage.save_spam(web.name,web.current_page,new_content,web.user)
+          raise SpamException
+          return web.error_page
         end
       end
       html = @config.redirect_to_html?(web)
       formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,@config.editable?(web))
       return formatter.absolute_url
     end
-
+    
     def upload(web,name,content)
       if name.empty? || content.nil? then
         html = @config.redirect_to_html?(web)
@@ -133,32 +227,32 @@ module Wiki2Go
         return save(web,text)
       end
     end
-
+    
     def changes(web)
       html = @config.redirect_to_html?(web)
       formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,@config.editable?(web))
-
-      topics = @config.storage.read_changes_in(web.name,20) 
+      
+      topics = @config.storage.read_changes_in(web.name,@config.pages_in_recent_changes) 
       template = @config.storage.load_template(web.name,"pagelist.htm")
-
+      
       return formatter.format_pagelist_in_template(template,topics,"","Recent Changes") 
     end
-
+    
     def search(web,searchtopic)
       searchtopic ||= ''
       html = @config.redirect_to_html?(web)
       formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,@config.editable?(web))
-
+      
       topics = @config.storage.search(web.name,searchtopic) 
       template = @config.storage.load_template(web.name,"pagelist.htm")
-
+      
       return formatter.format_pagelist_in_template(template,topics,searchtopic,"Search for '#{searchtopic}'") 
     end
-
+    
     def remove_spam(web)
       any_changes = false
       files = @config.storage.all_pages_in(web.name)
-      blacklist = @config.storage.load_blacklist
+      blacklist = @config.banned_users
       files.each do |topic|
         page = @config.storage.load_page(web.name,topic)
         if blacklist.contains(page.author) then
@@ -167,147 +261,193 @@ module Wiki2Go
         end  
       end
       if any_changes then
-        changes = @config.storage.read_changes_in(web.name,20)
-        save_rss(web,changes)      
+        save_changes_in_rss(web)
       end
-      return changes(web)
+      html = @config.redirect_to_html?(web)
+      formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,@config.editable?(web))
+      return formatter.changes_url
     end
-
+    
     def blacklist(user)
       @config.log("Adding #{user} to blacklist")
-      list = @config.storage.load_blacklist
+      list = @config.banned_users
       list.add(user)
       @config.storage.save_list(list)
     end
-
+    
     def log(msg)
       @config.log(msg)
     end
-
+    
     def generate_html(web)  
-      report = ["Generating HTML\r\n" , "<ul>"]
+      report = ["Generating HTML#{$/}" , "<ul>"]
       files = @config.storage.all_pages_in(web.name)
       files.each do |file|
-        report << "<li>#{file}</li>\r\n"
+        report << "<li>#{file}</li>#{$/}"
         pageweb = @config.static_web(web)
         pageweb.current_page = file
         save_html(pageweb)
       end
-      changes = @config.storage.read_changes_in(web.name,20)
-      save_rss(web,changes)
-      report << "</ul>\r\n"
+      save_changes_in_rss(web)
+      report << "</ul>#{$/}"
       return report.join
     end
-
+    
+    def prepare_for_fckeditor(web)
+      report = ["Generating HTML#{$/}" , "<ul>"]
+      files = @config.storage.all_pages_in(web.name)
+      files.each do |file|
+        report << "<li>#{file}</li>#{$/}"
+        pageweb = @config.static_web(web)
+        pageweb.current_page = file
+        generate_fckeditor_html(pageweb)
+      end
+      report << "</ul>#{$/}"
+      return report.join
+    end
+    
     def admin(request)
-
+    
       old_config = @config.multi_wiki 
       @config.multi_wiki = false
       wikiweb = Wiki2Go::Web.from_request(request,@config) 
       @config.multi_wiki = old_config
-
+      
       template_name = wikiweb.current_page
       if template_name.nil? || template_name.empty?
         template_name = 'admin'
       end
       master   = @config.storage.load_template(wikiweb.name,'admin.htm')
       template = @config.storage.load_template(wikiweb.name,File.join('admin_pages',template_name+'.txt'))
-
+      
       master = master.gsub(/\$BODY\$/,template)
-
+      
       erb = Web2Go::ERB_Interpreter.new
       erb.add_field(:@request,request)
       erb.add_field(:@config,@config)
       erb.add_field(:@web,wikiweb)
       result = erb.execute master,0
-
+      
     end
-
+    
     def perform(web,request)
-
+    
       if @config.allow_dynamic_pages then
         html = @config.redirect_to_html?(web)
         formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,@config.editable?(web))
-
+        
         text = @config.storage.load_page(web.name,web.current_page)        
-
+        
         erb = Web2Go::ERB_Interpreter.new
         erb.add_field(:@config,@config)
         erb.add_field(:@web,web)
         erb.add_field(:@request,request)
-
-        script = text.lines.join
+        erb.add_field(:@formatter,formatter)
+        
+        script = text.lines.join($/)
         output = erb.execute(script,1)
-        text.lines = output.split($/).collect {|line| line + $/ }
-
+        text.lines = output.split($/)
+        
         template = @config.storage.load_template(web.name,"view.htm")
-
+        
         return formatter.format_page_in_template(template,text)
       else
-        view(web)
+        log("Perform not allowed")
+        self.view(web,-1)
       end 
     end
-
+    
     private
-
+    
+    def append_blank(str)
+      return str.length == 0 ? '' : str + ' '
+    end
+    
+    def generate_fckeditor_html(web)
+      formatter = Wiki2Go::HTMLFormatter.new(web,@config.storage,@config,true,@config.editable?(web))
+      pagename = web.current_page
+      @config.storage.backup_page(web.name,web.current_page)
+      page = @config.storage.load_page(web.name,web.current_page)
+      updated = formatter.format_page(page.content)
+      page.lines = updated.split($/)
+      @config.storage.save_page(web.name,page)
+    end
+    
+    def select(changes,maximum_amount)
+      if maximum_amount < changes.length then
+        changes[0,maximum_amount]
+      else
+        changes
+      end
+    end
+    
+    def save_changes_in_rss(web)
+      nb_changes = (@config.pages_in_rss > @config.pages_in_recent_changes ? @config.pages_in_rss : @config.pages_in_recent_changes )
+      changes = @config.storage.read_changes_in(web.name,nb_changes)
+      save_rss(web,select(changes,@config.pages_in_rss))
+      save_changes(web,select(changes,@config.pages_in_recent_changes))
+    end
+    
     def save_rss(web,changes)
       static_web = @config.static_web(web)
       rss = generate_rss(static_web,changes)
       @config.storage.store_web_file(web.name,"rss.xml",rss)
-      save_changes(static_web,changes)
     end
-
+    
     def save_changes(web,changes)
+      web = @config.static_web(web)
       if @config.generate_html then
         html = true
         formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,@config.editable?(web))
-
+        
         template = @config.storage.load_template(web.name,"pagelist.htm")
-
+        
         content = formatter.format_pagelist_in_template(template,changes,"","Recent Changes") 
         @config.storage.save_html(web.name,'recent_changes',content)
       end
     end
-
+    
     def save_html(web)
-      if @config.generate_html then
+      if @config.generate_html && !Page.is_dynamic?(web.current_page) then
         static_web = @config.static_web(web)
         @config.storage.save_html(static_web.name,static_web.current_page, view_html(static_web))
       end
     end
-
+    
     # Optimized method of regenerating only the HTML of pages that are affected by a new page
     # Search for all pages containing the title of the new page and render those + the new page
     def generate_html_for_page(web,pagename)  
       files = @config.storage.search(web.name,pagename)
       files << @config.storage.load_page(web.name,pagename)
       files.each do |file|
-        static_web = @config.static_web(web)
-        static_web.current_page = file.filename
-        @config.storage.save_html(static_web.name,static_web.current_page, view_html_of_page(static_web,file))
+        if !Page.is_dynamic?(file.filename) then
+          static_web = @config.static_web(web)
+          static_web.current_page = file.filename
+          @config.storage.save_html(static_web.name,static_web.current_page, view_html_of_page(static_web,file))
+        end
       end
     end
-
+    
     def view_html_of_page(web,text)
       html = true
       editable = @config.editable?(web)
       formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,editable)
-
+      
       template = @config.storage.load_template(web.name,"view.htm")
-
+      
       return formatter.format_page_in_template(template,text) 
     end
-
+    
     def view_text(web,text)
-      html = @config.generate_html && !web.secure
+      html = @config.generate_html && !web.secure?
       formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,@config.editable?(web))
-
+      
       template = @config.storage.load_template(web.name,"view.htm")
-
+      
       page = Wiki2Go::Page.new("Report",text,"system",Time.now,Time.now,"Report")
       return formatter.format_page_in_template(template,page) 
     end
-
+    
     def restore_last_good_version(web,topic,blacklist)
       versions = @config.storage.all_versions_of(web.name,topic)
       first_good_version = versions.find do |v|
@@ -325,5 +465,72 @@ module Wiki2Go
         save_html(thispage)
       end        
     end
+    
+    def do_edit(web,template)
+      html = @config.redirect_to_html?(web)
+      formatter = Wiki2Go::Formatter.new(web,@config.storage,@config,html,@config.editable?(web))
+      
+      text,version = load_page_version(web,-1)
+      
+      template = @config.storage.load_template(web.name,template)
+      
+      return formatter.put_page_in_template(template,text) 
+    end
+    
+    def break_on_br(lines)
+      content = lines.join($/)
+      content.gsub!(/<br>/i,$/)
+      content.gsub!(/<br \/>/i,$/)
+      return content.split($/)
+    end
+    
+    def load_page_version(web,version)
+    
+      if version == -1 then
+        text = @config.storage.load_page(web.name,web.current_page)
+      else
+        topics = all_good_versions(web)
+        topics.reverse!
+        text = topics[version] || @config.storage.load_page(web.name,web.current_page)
+      end       
+      
+      return text
+    end
+    
+    def load_two_versions(web,version1,version2)
+      from = (version1 < version2 ? version1 : version2)
+      to   = (version1 < version2 ? version2 : version1)
+      
+      topics = all_good_versions(web)
+      topics.reverse!
+      
+      to = topics.length - 1 if to < 0 || to >= topics.length
+      from = to > 0 ? to -1 : 0 if from < 0 || from >= topics.length
+      
+      from_page = topics[from] || topics[-2] || @config.storage.load_page(web.name,web.current_page)
+      to_page   = topics[to] || @config.storage.load_page(web.name,web.current_page)
+      
+      return from,from_page,to,to_page
+    end
+    
+    def all_good_versions(web)
+      topics = @config.storage.all_versions_of(web.name,web.current_page) 
+      blacklist = @config.banned_users
+      topics = topics.reject { |version| blacklist.contains(version.author) }
+      
+      topics
+    end
+    
+    def blacklist_robots(web,checksum)
+      if @config.checksum_required && @config.blacklist_when_no_checksum && checksum.length == 0 then
+        author   = web.user
+        pagename = web.name.length > 0 ? "#{web.name}/#{web.current_page}" : web.current_page 
+ 
+        @config.blacklist_user(author)
+        @config.errorlog("Edit by user #{author} of page '#{pagename}' does not have a checksum. Suspected robot blacklisted")
+        raise SpamException
+      end
+    end
+    
   end
 end