instiki 0.9.2 → 0.10.0

data/app/models/revision.rb

@@ -1,90 +1,123 @@
-$: << File.dirname(__FILE__) + "../../libraries"
-
-require "diff/diff"
-
-require "wiki_content"
-require "chunks/wiki"
-
-require "date"
-require "author"
-require "page"
-
-class Revision
-  attr_accessor :page, :number, :content, :created_at, :author
-
-  def initialize(page, number, content, created_at, author)
-    @page, @number, @created_at, @author = page, number, created_at, author
-    self.content = content
-  end
-
-  # Ensure that the wiki content is parsed when ever it is updated.
-  def content=(content)
-    @content = content
-  end
-
-  def created_on
-    Date.new(@created_at.year, @created_at.mon, @created_at.day)
-  end
-
-  def pretty_created_at
-    # Must use DateTime because Time doesn't support %e on at least some platforms
-    DateTime.new(
-      @created_at.year, @created_at.mon, @created_at.day, @created_at.hour, @created_at.min
-    ).strftime "%B %e, %Y %H:%M" 
-  end
-
-  def next_revision
-    page.revisions[number + 1]
-  end
-
-  def previous_revision
-    number - 1 >= 0 && page.revisions[number - 1]
-  end
-
-  # Returns an array of all the WikiWords present in the content of this revision.
-  def wiki_words
-    unless @wiki_words_cache 
-      wiki_chunks = display_content.find_chunks(WikiChunk::WikiLink)
-      @wiki_words_cache = wiki_chunks.map { |c| ( c.escaped_text ? nil : c.page_name ) }.compact.uniq
-    end
-    @wiki_words_cache
-  end  
-
-  # Returns an array of all the WikiWords present in the content of this revision.
-  # that already exists as a page in the web.
-  def existing_pages
-    wiki_words.select { |wiki_word| page.web.pages[wiki_word] }
-  end
-
-  # Returns an array of all the WikiWords present in the content of this revision
-  # that *doesn't* already exists as a page in the web.
-  def unexisting_pages
-    wiki_words - existing_pages
-  end  
-
-	# Explicit check for new type of display cache with find_chunks method.
-	# Ensures new version works with older snapshots.
-  def display_content
-    unless @display_cache && @display_cache.respond_to?(:find_chunks)
-      @display_cache = WikiContent.new(self)
-    end
-    @display_cache
-  end
-
-  def display_diff
-    previous_revision ? HTMLDiff.diff(previous_revision.display_content, display_content) : display_content
-  end
-
-  def clear_display_cache
-    @display_cache = @published_cache = @wiki_words_cache = nil
-  end
-  
-  def display_published
-    @published_cache = WikiContent.new(self, {:mode => :publish}) if @published_cache.nil?
-    @published_cache
-  end
-
-  def display_content_for_export
-    WikiContent.new(self, {:mode => :export} )
-  end  
-end
+require 'diff'
+require 'wiki_content'
+require 'chunks/wiki'
+require 'date'
+require 'author'
+require 'page'
+
+class Revision
+
+  attr_accessor :page, :number, :content, :created_at, :author
+
+  def initialize(page, number, content, created_at, author)
+    @page, @number, @created_at, @author = page, number, created_at, author
+    self.content = content
+    @display_cache = nil
+  end
+
+  def created_on
+    Date.new(@created_at.year, @created_at.mon, @created_at.day)
+  end
+
+  def pretty_created_at
+    # Must use DateTime because Time doesn't support %e on at least some platforms
+    DateTime.new(
+      @created_at.year, @created_at.mon, @created_at.day, @created_at.hour, @created_at.min
+    ).strftime "%B %e, %Y %H:%M" 
+  end
+
+  def next_revision
+    page.revisions[number + 1]
+  end
+
+  def previous_revision
+    number > 0 ? page.revisions[number - 1] : nil
+  end
+
+  # Returns an array of all the WikiIncludes present in the content of this revision.
+  def wiki_includes
+    unless @wiki_includes_cache 
+      chunks = display_content.find_chunks(Include)
+      @wiki_includes_cache = chunks.map { |c| ( c.escaped? ? nil : c.page_name ) }.compact.uniq
+    end
+    @wiki_includes_cache
+  end  
+
+  # Returns an array of all the WikiReferences present in the content of this revision.
+  def wiki_references
+    unless @wiki_references_cache 
+      chunks = display_content.find_chunks(WikiChunk::WikiReference)
+      @wiki_references_cache = chunks.map { |c| ( c.escaped? ? nil : c.page_name ) }.compact.uniq
+    end
+    @wiki_references_cache
+  end  
+
+  # Returns an array of all the WikiWords present in the content of this revision.
+  def wiki_words
+    unless @wiki_words_cache
+      wiki_chunks = display_content.find_chunks(WikiChunk::WikiLink)
+      @wiki_words_cache = wiki_chunks.map { |c| ( c.escaped? ? nil : c.page_name ) }.compact.uniq
+    end
+    @wiki_words_cache
+  end
+
+  # Returns an array of all the WikiWords present in the content of this revision.
+  # that already exists as a page in the web.
+  def existing_pages
+    wiki_words.select { |wiki_word| page.web.pages[wiki_word] }
+  end
+
+  # Returns an array of all the WikiWords present in the content of this revision
+  # that *doesn't* already exists as a page in the web.
+  def unexisting_pages
+    wiki_words - existing_pages
+  end  
+
+  # Explicit check for new type of display cache with chunks_by_type method.
+  # Ensures new version works with older snapshots.
+  def display_content
+    unless @display_cache && @display_cache.respond_to?(:chunks_by_type)
+      @display_cache = WikiContent.new(self)
+      @display_cache.render!
+    end
+    @display_cache
+  end
+
+  def display_diff
+    previous_revision ? HTMLDiff.diff(previous_revision.display_content, display_content) : display_content
+  end
+
+  def clear_display_cache
+    @wiki_words_cache = @published_cache = @display_cache = @wiki_includes_cache = 
+      @wiki_references_cache = nil
+  end
+
+  def display_published
+    unless @published_cache && @published_cache.respond_to?(:chunks_by_type)
+      @published_cache = WikiContent.new(self, {:mode => :publish})
+      @published_cache.render!
+    end
+    @published_cache
+  end
+
+  def display_content_for_export
+    WikiContent.new(self, {:mode => :export} ).render!
+  end
+  
+  def force_rendering
+    begin
+      display_content.render!
+    rescue Exception => e
+      ApplicationController.logger.error "Failed rendering page #{@name}"
+      ApplicationController.logger.error e
+      message = e.message.gsub(/\n/, '<br/>')
+      # substitute content with an error message
+      content = <<-EOL
+          <p>Markup engine has failed to render this page, raising the following error:</p>
+          <p>#{message}</p>
+      EOL
+      raise e
+    end
+  end
+
+end

data/app/models/web.rb

@@ -1,89 +1,176 @@
-require "cgi"
-require "page"
-require "page_set"
-require "wiki_words"
-require "zip/zip"
-
-class Web
-  attr_accessor :pages, :name, :address, :password
-  attr_accessor :markup, :color, :safe_mode, :additional_style, :published, :brackets_only, :count_pages
-  
-  def initialize(name, address, password = nil)
-    @name, @address, @password, @safe_mode = name, address, password, false
-    @pages = {}
-  end
-
-  def add_page(page)
-    @pages[page.name] = page
-  end
-
-  def remove_pages(pages_to_be_removed)
-    pages.delete_if { |page_name, page| pages_to_be_removed.include?(page) }
-  end
-  
-  def select(&accept)
-    PageSet.new(self, @pages.values, accept)
-  end
-  
-  def revised_on
-    select.most_recent_revision
-  end
-    
-  def authors 
-    select.authors 
-  end
-
-  def categories
-    select.map { |page| page.categories }.flatten.uniq.sort
-  end
-
-  # Create a link for the given page name and link text based
-  # on the render mode in options and whether the page exists
-  # in the this web.
-  def make_link(name, text = nil, options = {})
-    page = pages[name]
-    text = text || WikiWords.separate(name)
-    link = CGI.escape(name)
-    
-    case options[:mode]
-      when :export
-        if page then "<a class=\"existingWikiWord\" href=\"#{link}.html\">#{text}</a>"
-        else "<span class=\"newWikiWord\">#{text}</span>" end
-      when :publish
-        if page then "<a class=\"existingWikiWord\" href=\"../show/#{link}\">#{text}</a>"
-        else "<span class=\"newWikiWord\">#{text}</span>" end
-      else
-        if page then "<a class=\"existingWikiWord\" href=\"../show/#{link}\">#{text}</a>"
-        else "<span class=\"newWikiWord\">#{text}<a href=\"../show/#{link}\">?</a></span>" end
-    end
-  end
-
-
-  # Clears the display cache for all the pages with references to 
-  def refresh_pages_with_references(page_name)
-    select.pages_that_reference(page_name).each { |page| 
-      page.revisions.each { |revision| revision.clear_display_cache }
-    }
-  end
-  
-  def refresh_revisions
-    select.each { |page| page.revisions.each { |revision| revision.clear_display_cache } }
-  end
-  
-  # Default values
-  def markup()        @markup || :textile end
-  def color()         @color  || "008B26" end
-  def brackets_only() @brackets_only || false end
-  def count_pages()   @count_pages || false end
-
-  private
-    # Returns an array of all the wiki words in any current revision
-    def wiki_words
-      pages.values.inject([]) { |wiki_words, page| wiki_words << page.wiki_words }.flatten.uniq
-    end
-    
-    # Returns an array of all the page names on this web
-    def page_names
-      pages.keys
-    end
-end
+require 'cgi'
+require 'page'
+require 'page_set'
+require 'wiki_words'
+require 'zip/zip'
+
+class Web
+  attr_accessor :name, :password, :markup, :color, :safe_mode, :pages
+  attr_accessor :additional_style, :published, :brackets_only, :count_pages, :allow_uploads
+  attr_accessor :max_upload_size
+  
+  attr_reader :address
+
+  def initialize(parent_wiki, name, address, password = nil)
+    self.address = address
+    @wiki, @name, @password = parent_wiki, name, password
+
+    # default values
+    @markup = :textile 
+    @color = '008B26'
+    @safe_mode = false
+    @pages = {}
+    @allow_uploads = true
+    @additional_style = nil
+    @published = false
+    @brackets_only = false
+    @count_pages = false
+    @allow_uploads = true
+    @max_upload_size = 100
+  end
+
+  def add_page(page)
+    @pages[page.name] = page
+  end
+
+  def address=(the_address)
+    if the_address != CGI.escape(the_address)
+      raise Instiki::ValidationError.new('Web name should contain only valid URI characters') 
+    end
+    @address = the_address
+  end
+
+  def authors 
+    select.authors 
+  end
+
+  def categories
+    select.map { |page| page.categories }.flatten.uniq.sort
+  end
+
+  def has_page?(name)
+    pages[name]
+  end
+
+  def has_file?(name)
+    wiki.file_yard(self).has_file?(name)
+  end
+
+  def make_file_link(mode, name, text, base_url)
+    link = CGI.escape(name)
+    case mode
+    when :export
+      if has_file?(name) then "<a class=\"existingWikiWord\" href=\"#{link}.html\">#{text}</a>"
+      else "<span class=\"newWikiWord\">#{text}</span>" end
+    when :publish
+      if has_file?(name) then "<a class=\"existingWikiWord\" href=\"#{base_url}/published/#{link}\">#{text}</a>"
+      else "<span class=\"newWikiWord\">#{text}</span>" end
+    else 
+      if has_file?(name)
+        "<a class=\"existingWikiWord\" href=\"#{base_url}/file/#{link}\">#{text}</a>"
+      else 
+        "<span class=\"newWikiWord\">#{text}<a href=\"#{base_url}/file/#{link}\">?</a></span>"
+      end
+    end
+  end
+
+  # Create a link for the given page name and link text based
+  # on the render mode in options and whether the page exists
+  # in the this web.
+  # The links a relative, and will work only if displayed on another WikiPage.
+  # It should not be used in menus, templates and such - instead, use link_to_page helper
+  def make_link(name, text = nil, options = {})
+    text = CGI.escapeHTML(text || WikiWords.separate(name))
+    mode = options[:mode] || :show
+    base_url = options[:base_url] || '..'
+    link_type = options[:link_type] || :show
+    case link_type.to_sym
+    when :show
+      make_page_link(mode, name, text, base_url)
+    when :file
+      make_file_link(mode, name, text, base_url)
+    when :pic
+      make_pic_link(mode, name, text, base_url)
+    else
+      raise "Unknown link type: #{link_type}"
+    end
+  end
+
+  def make_page_link(mode, name, text, base_url)
+    link = CGI.escape(name)
+    case mode.to_sym
+    when :export
+      if has_page?(name) then %{<a class="existingWikiWord" href="#{link}.html">#{text}</a>}
+      else %{<span class="newWikiWord">#{text}</span>} end
+    when :publish
+      if has_page?(name) then %{<a class="existingWikiWord" href="#{base_url}/published/#{link}">#{text}</a>}
+      else %{<span class="newWikiWord">#{text}</span>} end
+    else 
+      if has_page?(name)
+        %{<a class="existingWikiWord" href="#{base_url}/show/#{link}">#{text}</a>}
+      else 
+        %{<span class="newWikiWord">#{text}<a href="#{base_url}/show/#{link}">?</a></span>}
+      end
+    end
+  end
+
+  def make_pic_link(mode, name, text, base_url)
+    link = CGI.escape(name)
+    case mode.to_sym
+    when :export
+      if has_file?(name) then %{<img alt="#{text}" src="#{link}" />}
+      else %{<img alt="#{text}" src="no image" />} end
+    when :publish
+      if has_file?(name) then %{<img alt="#{text}" src="#{link}" />}
+      else %{<span class="newWikiWord">#{text}</span>} end
+    else 
+      if has_file?(name) then %{<img alt="#{text}" src="#{base_url}/pic/#{link}" />}
+      else %{<span class="newWikiWord">#{text}<a href="#{base_url}/pic/#{link}">?</a></span>} end
+    end
+  end
+
+  def max_upload_size
+    @max_upload_size || 100
+  end
+
+  # Clears the display cache for all the pages with references to 
+  def refresh_pages_with_references(page_name)
+    select.pages_that_reference(page_name).each { |page| 
+      page.revisions.each { |revision| revision.clear_display_cache }
+    }
+  end
+  
+  def refresh_revisions
+    select.each { |page| page.revisions.each { |revision| revision.clear_display_cache } }
+  end
+
+  def remove_pages(pages_to_be_removed)
+    pages.delete_if { |page_name, page| pages_to_be_removed.include?(page) }
+  end
+  
+  def revised_on
+    select.most_recent_revision
+  end
+    
+  def select(&condition)
+    PageSet.new(self, @pages.values, condition)
+  end
+  
+  # This ensures compatibility with 0.9 storages
+  def wiki
+    @wiki ||= WikiService.instance
+  end
+
+  private
+
+    # Returns an array of all the wiki words in any current revision
+    def wiki_words
+      pages.values.inject([]) { |wiki_words, page| wiki_words << page.wiki_words }.flatten.uniq
+    end
+    
+    # Returns an array of all the page names on this web
+    def page_names
+      pages.keys
+    end
+    
+end