Wiki2Go 1.14.0

data/lib/Wiki2Go/WikiFormatter.rb

@@ -0,0 +1,597 @@
+#!/usr/bin/ruby
+
+require 'erb'
+require 'cgi'
+require 'English'
+
+module Wiki2Go
+
+  class PageContext
+    attr_reader :format
+    attr_reader :web 
+    attr_reader :page
+    attr_reader :text
+    attr_reader :pages
+    attr_reader :searchtopic
+    attr_reader :config
+    attr_accessor :title
+
+    def initialize(config,formatter,text,page,web,pages,searchtopic,title)
+      @config = config
+      @format = formatter 
+      @web = web 
+      @page = page
+      @text = text
+      @pages = pages
+      @searchtopic = searchtopic
+      @title = title 
+    end
+  end
+
+  class Formatter
+
+    def initialize(web,storage,config,generate_html,editable)
+      @web = web
+      @storage = storage
+      @config = config
+      @in_table = false
+      @bullets = Array.new
+      @pre_line = ""
+      @post_line = ""
+      @generate_html = generate_html
+      @editable      = editable
+    end
+
+    public
+
+    def format_page_in_template(template,page) 
+      formatted_page = format_page(page.content)
+      template = splice_variable_values(template,page,formatted_page)
+      erb = ERB.new(template)
+      context = PageContext.new(@config,self,formatted_page,page,@web,nil,nil,nil)
+      template = evaluate(erb,context)
+      return template
+    end
+
+    def format_pagelist_in_template(template,pages,searchtopic,title) 
+      template = splice_web_values(template)
+      erb = ERB.new(template)
+      context = PageContext.new(@config,self,nil,nil,@web,pages,searchtopic,title)
+      template = evaluate(erb,context)
+      return template
+    end
+
+    def put_page_in_template(template,page) 
+      formatted_page = page_text(page).gsub(/&/n, '&amp;').gsub(/\"/n, '&quot;').gsub(/>/n, '&gt;').gsub(/</n, '&lt;')
+
+      template = splice_variable_values(template,page,formatted_page)
+      erb = ERB.new(template)
+      context = PageContext.new(@config,self,formatted_page,page,@web,nil,nil,nil)
+      template = evaluate(erb,context)
+      return template
+    end
+
+    def format_page(content)
+      result = format_page_content(content)
+      emit_bullets
+      result += @pre_line
+      return format_empty_lines(result)
+    end
+
+    def format_line(line)
+      @added_bullets = false
+      line = format_wiki_markup(line)
+      if !@added_bullets then
+        emit_bullets
+      end
+
+      return formatted_output(line)
+    end
+
+    def generate_rss(template,changes)
+
+      template_after_items = <<-END_OF_AFTER_ITEMS_XML
+      </channel>
+      </rss>
+      END_OF_AFTER_ITEMS_XML
+
+      items = ""
+
+      changes.each do |page| 
+        items = items + <<-END_OF_ITEMS
+        <item>
+        <title>#{page.name}</title>
+        <author>#{page.alias}</author>
+        <pubDate>#{page.lastmodified.strftime("%d %B %Y %H:%M GMT")}</pubDate>
+        <link>#{absolute_url_of_topic(page.title)}</link>
+        <guid isPermaLink="true">#{@web.name}/#{page.title}</guid>
+        <description><![CDATA[#{format_page(page.content).strip}]]></description>
+        </item>
+        END_OF_ITEMS
+      end
+
+      template = template + items + template_after_items
+
+      # We're using hard coded GMT, because %Z returns something strange
+      time = Time.new.gmtime.strftime("%d %B %Y %H:%M GMT")
+      template.gsub!(/\$DATE\$/, time)
+      template = splice_web_values(template)
+      return template
+    end
+
+    def absolute_url
+      return @web.base_url + view_url(@web.name,@web.current_page)
+    end
+
+    def absolute_url_of_topic(topic)
+      return @web.base_url + view_url(@web.name,topic)
+    end
+
+    def edit_link(subwiki,page,name)
+      if @editable then
+        return name + edit_this_link(subwiki,page,"?")
+      else
+        return name 
+      end
+    end
+
+    def edit_this_link(subwiki,page,name)
+      if @editable then
+        return "<a href=\"#{join(@web.script_prefix,"edit"+@web.script_extension,subwiki,page)}\">#{name}</a>"
+      else
+        return "" 
+      end
+    end
+
+    def save_this_link(subwiki,page)
+      if @editable then
+        return join(@web.script_prefix,"save"+@web.script_extension,subwiki,page) 
+      else
+        return page 
+      end
+    end
+
+    def verb_url(verb)
+      return join(@web.script_prefix,verb+@web.script_extension,@web.name,@web.current_page)
+    end
+
+    def removespam_url(user)
+      return join(@web.script_prefix,'removespam'+@web.script_extension,@web.name,'') + '?user=' + user
+    end
+
+    def version_url(page)
+      return join(@web.script_prefix,'versions'+@web.script_extension,@web.name,page)
+    end
+
+    def save_url
+      verb_url('save')
+    end
+
+    def search_link(desc)
+      return "<a href=\"#{search_url + "?text="+desc}\">#{desc}</a>"
+    end
+
+    def search_link2(desc,name)
+      return "<a href=\"#{search_url + "?text="+desc}\">#{name}</a>"
+    end
+
+    def search_url
+      return join(@web.script_prefix,'search'+@web.script_extension,@web.name)
+    end
+
+    def changes_url
+      return join(@web.script_prefix,'changes'+@web.script_extension,@web.name)
+    end
+
+    def changes_link(desc)
+      return "<a href=\"#{changes_url}\">#{desc}</a>"
+    end
+
+    def view_link(subwiki,page,name)
+      if subwiki == @web.name then
+        return "<a href=\"#{view_url(subwiki,page)}\">#{name}</a>"
+      else
+        return "<a href=\"#{view_url(subwiki,page)}\">#{subwiki}:#{name}</a>"
+      end
+    end
+
+    def view_version_link(subwiki,page,name,parameters=nil)
+      return "<a href=\"#{view_version_url(subwiki,page)+query_string(parameters)}\">#{name}</a>"
+    end
+
+    def view_version_url(subwiki,page)
+      return join(@web.script_prefix,"view" + @web.script_extension,subwiki,page)
+    end
+
+    def query_string(parameters)
+      return "" if parameters.nil?
+      return "?" + parameters.collect { |key,value| key + '=' + value}.sort.join('&')
+    end
+
+    def version_link(page,name)
+      return "<a href=\"#{version_url(page)}\">#{name}</a>"
+    end
+
+    def admin_link(page,name)
+      return "<a href=\"#{join(@web.script_prefix,'admin' + @web.script_extension,page)}\">#{name}</a>"
+    end
+
+
+    def redirect_url(url)
+      if @config.redirect_url?(@web,url) then
+        redirected_url = join(@web.script_prefix,"redirect",@web.name + "?url=" + CGI::escape(url) )
+        return redirected_url
+      else
+        return url
+      end
+    end
+
+    def redirect_link(label,url)
+      if @config.redirect_url?(@web,url) then
+        redirected_url = redirect_url(url)
+        return "<a href=\"#{redirected_url}\" rel=\"nofollow\" target=\"_blank\">#{label}</a>"
+      else
+        return "<a href=\"#{url}\" target=\"_blank\">#{label}</a>"
+      end
+
+    end
+
+    def view_url(subwiki,page)
+      if @generate_html then 
+        return join(subwiki,page + ".html") 
+      else
+        return join(@web.script_prefix,"view" + @web.script_extension,subwiki,page)
+      end
+    end
+
+    def resource_url(name)
+      File.join('html',@web.name,name)
+    end
+
+    def encode_mail_to(addr) 
+
+      addr =~ /(.*)@(.*)/ ;
+      name = $1 ;
+      site = $2 ;
+
+      return  "<a href=\"#{view_url(@web.name,"MailFormattingRules")}\" onmouseover=\"this.href='mai' + 'lto:' + '#{name}' + '&#64;' + '#{site}'\">#{name}</a>" 
+    end
+
+    alias :encodeMailTo :encode_mail_to
+    
+    private
+
+    def evaluate(erb,current)
+      Wiki2Go.module_eval{
+        erb.result(binding)
+      }
+    end
+
+    def format_empty_lines(content)
+      lines = content.split($/)
+      paragraph = ''
+      result = ''
+      lines.each do |line|
+        if line.strip.length == 0 then
+          paragraph = "<p>" + $/
+        else
+          result += $/ if result.length > 0
+          result += paragraph
+          paragraph = ''
+          result += line 
+        end  
+      end
+      result
+    end
+    
+    def format_page_content(content)
+      if content.length == 0 then
+        return ''
+      elsif content =~ /^(.*)(<!--(.*)-->\n?)(.*)$/m then
+        before,match,after = $1,$2,$4
+        return append(format_page_content(before),format_comment(match),format_page_content(after))
+      elsif content =~ /^(.*)(<pre>(.*)<\/pre>)(.*)$/im then
+        before,match,after = $1,$2,$4
+        return append(format_page_content(before),match,format_page_content(after))
+      else
+        result = ''
+        lines = content.split($/)
+        if lines.length > 1 then
+          lines.each do |line|
+            result += format_line(line) + $/
+          end
+        else
+          result = format_line(content)
+        end
+        return result 
+      end
+
+    end
+
+    def append(before,match,after)
+      result = ''
+      result += before if !before.nil?
+      result += match if !match.nil?
+      result += after if !after.nil?
+      result
+    end
+
+    def format_comment(text)
+      @config.preprocess(@web,text)
+    end
+
+    def format_tag(text)
+      text = text.gsub(/"((http|ftp|gopher|news|https)\:[^"]*)"/) { externalUrl($1) }
+
+      return '<' + text + '>'
+    end
+
+    def splice_variable_values(template, page, formatted_page)
+      template.gsub!(/\$TEXT\$/,formatted_page)
+      template.gsub!(/\$TOPIC\$/,page.title)
+      template.gsub!(/\$AUTHOR\$/,page.author)
+      template.gsub!(/\$LASTMODIFIED\$/,page.lastmodified.strftime("%d/%m/%Y"))
+      template.gsub!(/\$MESSAGE\$/,"")
+      template = splice_web_values(template)
+      return template
+    end     
+
+    def splice_web_values(template)
+      template.gsub!(/\$WEB\$/,@web.name)
+      template.gsub!(/\$BASEURL\$/,@web.base_url)
+      template.gsub!(/\$HTMLURL\$/,@web.base_url)
+      template.gsub!(/\$SCRIPTURL\$/,@web.script_prefix)
+      template.gsub!(/\$MESSAGE\$/,"")
+      template.gsub!(/\$EXT\$/,@web.script_extension)
+      template = remove_markers(template)
+      return template
+    end     
+
+    def format_wiki_markup(line)
+      if line =~ /^(.*)<(\S.*)\>(.*)$/ then
+        before,match,after = $1,$2,$3
+        return append(format_wiki_markup(before),format_tag(match),format_wiki_markup(after))
+      else
+        line = escape_wiki_markers(line)
+
+        if line =~ /^(.*)\{([^\}]*)\}(.*)$/ then
+          before,match,after = $1,$2,$3
+          line = append(format_wiki_markup(before),format_forced_link(match),format_wiki_markup(after))
+        elsif line =~ /^(.*)\%([^\%]*)\%(.*)$/ then
+          before,match,after = $1,$2,$3
+          line = append(format_wiki_markup(before),format_forced_link(match),format_wiki_markup(after))
+        elsif line =~ /^(.*)((http|ftp|gopher|news|https)\:(\w|\/|\.|_|-|\?|\=|&|;|\~|#|,)+)(.*)$/ then
+          before,match,after = $1,$2,$5
+          line = append(format_wiki_markup(before),external_link(match),format_wiki_markup(after))
+        elsif line =~ /^(.*)mailto\:([a-zA-Z0-9\-\_\.]+@[a-zA-Z0-9\-\_\.]+)(.*)$/ then
+          before,match,after = $1,$2,$3
+          line = append(format_wiki_markup(before),encode_mail_to(match),format_wiki_markup(after))          
+        else
+          line = format_brackets(line)
+          line = format_entities(line)
+          line = format_bullets(line)
+          line = formatMarkup(line)
+          line = format_table(line)
+          line = recognize_wiki_words(line)
+        end
+        line = remove_markers(line)
+        return line
+      end    
+    end
+
+    def formatted_output(line)
+      output = @pre_line + line + @post_line
+      @pre_line = ""
+      @post_line = ""
+      return output
+    end
+
+
+    def page_text(page)
+      result = ""
+      page.lines.each do |line|
+        result = result + line
+      end
+      return result 
+    end
+
+    def escape_wiki_markers(line)
+      line = line.gsub(/%%/,"&percent;")
+      line = line.gsub(/\{\{/,"&openingbrace;")
+      line = line.gsub(/\}\}/,"&closingbrace;")
+    end
+    
+    def remove_markers(line)
+      line = line.gsub(/&percent;/,"%")
+      line = line.gsub(/&openingbrace;/,"{")
+      line = line.gsub(/&closingbrace;/,"}")
+      line = line.gsub(/&tilde;/,"~")
+      line = line.gsub(/&asterisk;/,"*")
+      line = line.gsub(/&underscore;/,"_")
+      return line
+    end
+
+    
+    def format_brackets(line)
+      line = line.gsub(/</,"&lt\;") ;
+      line = line.gsub(/>/,"&gt\;") ;
+      return line
+    end
+
+    def format_entities(line)
+      line = line.gsub(/\~/,"&tilde;") ;
+      line = line.gsub(/&(\w+)\;/,"~\\1\;") ;
+      line = line.gsub(/&(#\d+)\;/,"~\\1\;") ;
+      line = line.gsub(/&/,"&amp\;") ;
+      line = line.gsub(/~/,"&") ;
+      line = line.gsub(/\t/,"   ") ;
+      return line
+    end
+
+    def formatMarkup(line)
+      line = line.gsub(/\*\*([^\*]*)\*\*/,"<h2>\\1<\/h2>")
+      line = line.gsub(/\*([^\*]+)\*/,"<STRONG>\\1<\/STRONG>")
+      line = line.gsub(/\b_([^_]*)_/,"<EM>\\1<\/EM>")
+      line = line.gsub(/^---+/,"<hr>")
+#      line = line.gsub(/^\s*$/,"\n<p>")
+      return line
+    end
+
+    def format_bullets(line)
+      line = line.gsub(/^([\s]{3,99})\*(.*)$/) { add_bullet($1,$2,'u') } 
+      line = line.gsub(/^([\s]{3,99})(\d)+\.?(.*)$/) { add_bullet($1,$3,'o') } 
+      return line
+    end
+
+    def format_table(line)
+      if @in_table then
+        replacement = "</table>"
+      else
+        replacement = '<table class="wikitable" >'
+      end
+      if line.gsub!(/^(\|-+\|)/,replacement) then
+        @in_table = ! @in_table
+      elsif line.gsub!(/^\|\((.+)\)-+\|/,'<table class="\1" >') then
+        @in_table = true
+      end
+      if @in_table then
+        line = line.gsub(/^\|/,"<tr><td>")
+        line = line.gsub(/\|\s*$/,"<\/td><\/tr>")
+        line = line.gsub(/\|/,"<\/td><td>")
+      end
+      return line
+
+    end
+
+    def recognize_wiki_words(line)
+      line = line.gsub(/(^|[^\w\.])([A-Z]+[a-z0-9]+[A-Z]+[a-zA-Z0-9]*)/) { $1 + internalLink($2) }
+
+    end
+
+    def external_link(url)
+      if url =~ /([^\/]+)\.(gif|jpg|jpeg|png)$/i then
+        alt = $1
+        return "<img src=\"#{url}\" alt=\"#{alt}\">"
+      else
+        return redirect_link(url,url)
+      end
+    end      
+
+    def externalUrl(url)
+      return '"' + redirect_url(url) + (@config.redirect_url?(@web,url) ? '" rel="nofollow"' : '"') +' target="_blank"'
+    end      
+
+    def format_forced_link(link)
+       if ! link.gsub!(/^([^%@]+)@(http[^%]+)$/) { labelLink($1,$2) } then
+         link.gsub!(/^(([^\%@]+)@)?(([^\%:]+):)?([^%]+)$/) { mega_link($2,$4,$5,@web.name) }
+       end
+       link
+    end
+    
+    def labelLink(label,url)
+      return redirect_link(label,url)
+    end
+
+    def internalLink(page)
+      return internalSubwikiNamedLink(@web.name,page,page) 
+    end
+
+    def mega_link(name,subwiki,page,default_wiki)
+      name = page if name.nil? || name.empty?
+      subwiki = default_wiki if subwiki.nil? || subwiki.empty?
+      internalSubwikiNamedLink(subwiki,page,name)
+    end
+
+    def internalSubwikiNamedLink(subwiki,page,name)
+      if subwiki == "xpnl" then
+        return "<a href=\"http://www.xpnl.org/Wiki/#{page}\" target=\"_blank\">xpnl:#{page}</a>"
+      elsif subwiki == 'xpbe' then
+        return "<a href=\"http://wiki.xp.be/Xpbe/#{page}.html\" target=\"_blank\">xpbe:#{page}</a>"
+      elsif subwiki == "wiki" then
+        return "<a href=\"http://c2.com/cgi/wiki?#{page}\" target=\"_blank\">wiki:#{page}</a>"
+      elsif subwiki == "book" then
+        return "<a href=\"http://bookshelved.org/cgi-bin/wiki.pl?#{page}\" target=\"_blank\">book:#{page}</a>"
+      elsif subwiki == "wiki2go" then
+        return "<a href=\"http://wiki2go.nayima.be/Wiki2Go/#{page}.html\" target=\"_blank\">wiki2go:#{page}</a>"
+      elsif subwiki =~ /^isbn$/i then
+        name = "ISBN " + page if page == name
+        return "<a href=\"http://www.amazon.co.uk/exec/obidos/ASIN/#{page}/agilesystems-21\" target=\"_blank\">#{name}</a>"
+      elsif page =~ /^isbn(.+)$/i then
+        name = "ISBN " + $1 if page == name
+        return "<a href=\"http://www.amazon.co.uk/exec/obidos/ASIN/#{$1}/agilesystems-21\" target=\"_blank\">#{name}</a>"
+      elsif page =~ /\./ then
+        return resource_link(subwiki,page,name)
+      elsif @storage.exists(File.join(subwiki,page)) then
+        return view_link(subwiki,page,name)
+      else
+        return edit_link(subwiki,page,name)
+      end
+    end
+
+    def resource_link(subwiki,page,name)
+      if page =~ /^(.*)\.(gif|jpg|jpeg|png)$/i then
+        filename = $1
+        alt_label = name
+        if page == name || url?(name) then
+          alt_label = filename
+        end
+        image_link = "<img src=\"html/#{subwiki}/#{page}\" border=0 alt=\"#{alt_label}\" >"
+        if url?(name) then
+          return redirect_link(image_link,name)
+        else
+          return image_link
+        end
+      else
+        return "<a href=\"html/#{subwiki}/#{page}\" target=\"_blank\">#{name}</a>"
+      end
+    end
+
+    def add_bullet(prefix,text,code)
+      @added_bullets = true
+      depth = prefix.length / 3
+      result = ""
+      bullet_depth = @bullets.length
+      if depth > bullet_depth then
+        bullet_depth.upto(depth-1) do
+          result += "<#{code}l>" 
+          @bullets.push(code)
+        end
+      elsif depth < bullet_depth then
+        bullet_depth.downto(depth+1) do
+          bullet = @bullets.pop
+          result += "</#{bullet}l>"
+        end
+      elsif @bullets.last != code then
+        bullet = @bullets.pop
+        result += "</#{bullet}l>" 
+        result += "<#{code}l>" 
+        @bullets.push(code)
+      end
+      return result + "<li>#{text}"
+    end
+
+    def emit_bullets
+      while ! @bullets.empty?
+        bullet = @bullets.pop
+        @pre_line += "</#{bullet}l>" 
+      end
+    end
+
+    def join(*dirs)
+      result = ""
+      dirs.each do |name|
+        if !name.nil? and name.length > 0 then
+          result += '/' unless result.length == 0
+          result += name
+        end
+      end
+      return result.squeeze('/')
+    end
+
+    def url?(name)
+      name =~ /(http|ftp|gopher|news|https)\:(\w|\/|\.|_|-|\?|\=|&|;|\~|#|,)+/
+    end    
+
+  end
+
+end