instiki 0.10.0 → 0.10.1

data/app/models/chunks/wiki.rb

@@ -1,141 +1,141 @@
-require 'wiki_words'
-require 'chunks/chunk'
-require 'chunks/wiki'
-require 'cgi'
-
-# Contains all the methods for finding and replacing wiki related links.
-module WikiChunk
-  include Chunk
-
-  # A wiki reference is the top-level class for anything that refers to
-  # another wiki page.
-  class WikiReference < Chunk::Abstract
-
-    # Name of the referenced page
-    attr_reader :page_name
-    
-    # the referenced page
-    def refpage
-      @content.web.pages[@page_name]
-    end
-  
-  end
-
-  # A wiki link is the top-level class for links that refers to
-  # another wiki page.
-  class WikiLink < WikiReference
- 
-    attr_reader :link_text, :link_type
-
-    def initialize(match_data, content)
-      super
-      @link_type = :show
-    end
-
-    def self.apply_to(content)
-      content.gsub!( self.pattern ) do |matched_text|
-        chunk = self.new($~, content)
-        if chunk.textile_url?
-          # do not substitute
-          matched_text
-        else
-          content.add_chunk(chunk)
-          chunk.mask
-        end
-      end
-    end
-
-    # the referenced page
-    def refpage
-      @content.web.pages[@page_name]
-    end
-
-    def textile_url?
-      not @textile_link_suffix.nil?
-    end
-
-  end
-
-  # This chunk matches a WikiWord. WikiWords can be escaped
-  # by prepending a '\'. When this is the case, the +escaped_text+
-  # method will return the WikiWord instead of the usual +nil+.
-  # The +page_name+ method returns the matched WikiWord.
-  class Word < WikiLink
-
-    attr_reader :escaped_text
-    
-    unless defined? WIKI_WORD
-      WIKI_WORD = Regexp.new('(":)?(\\\\)?(' + WikiWords::WIKI_WORD_PATTERN + ')\b', 0, "utf-8")
-    end
-
-    def self.pattern
-      WIKI_WORD
-    end
-
-    def initialize(match_data, content)
-      super
-      @textile_link_suffix, @escape, @page_name = match_data[1..3]
-      if @escape 
-        @unmask_mode = :escape
-        @escaped_text = @page_name
-      else
-        @escaped_text = nil
-      end
-      @link_text = WikiWords.separate(@page_name)
-      @unmask_text = (@escaped_text || @content.page_link(@page_name, @link_text, @link_type))
-    end
-
-  end
-
-  # This chunk handles [[bracketted wiki words]] and 
-  # [[AliasedWords|aliased wiki words]]. The first part of an
-  # aliased wiki word must be a WikiWord. If the WikiWord
-  # is aliased, the +link_text+ field will contain the
-  # alias, otherwise +link_text+ will contain the entire
-  # contents within the double brackets.
-  #
-  # NOTE: This chunk must be tested before WikiWord since
-  #       a WikiWords can be a substring of a WikiLink. 
-  class Link < WikiLink
-    
-    unless defined? WIKI_LINK
-      WIKI_LINK = /(":)?\[\[([^\]]+)\]\]/
-      LINK_TYPE_SEPARATION = Regexp.new('^(.+):((file)|(pic))$', 0, 'utf-8')
-      ALIAS_SEPARATION = Regexp.new('^(.+)\|(.+)$', 0, 'utf-8')
-    end    
-        
-    def self.pattern() WIKI_LINK end
-
-    def initialize(match_data, content)
-      super
-      @textile_link_suffix, @page_name = match_data[1..2]
-      @link_text = @page_name
-      separate_link_type
-      separate_alias
-      @unmask_text = @content.page_link(@page_name, @link_text, @link_type)
-    end
-
-    private
-
-    # if link wihin the brackets has a form of [[filename:file]] or [[filename:pic]], 
-    # this means a link to a picture or a file
-    def separate_link_type
-      link_type_match = LINK_TYPE_SEPARATION.match(@page_name)
-      if link_type_match
-        @link_text = @page_name = link_type_match[1]
-        @link_type = link_type_match[2..3].compact[0].to_sym
-      end
-    end
-
-    # link text may be different from page name. this will look like [[actual page|link text]]
-    def separate_alias
-      alias_match = ALIAS_SEPARATION.match(@page_name)
-      if alias_match
-        @page_name, @link_text = alias_match[1..2]
-      end
-      # note that [[filename|link text:file]] is also supported
-    end  
-  
-  end
-  
-end
+require 'wiki_words'
+require 'chunks/chunk'
+require 'chunks/wiki'
+require 'cgi'
+
+# Contains all the methods for finding and replacing wiki related links.
+module WikiChunk
+  include Chunk
+
+  # A wiki reference is the top-level class for anything that refers to
+  # another wiki page.
+  class WikiReference < Chunk::Abstract
+
+    # Name of the referenced page
+    attr_reader :page_name
+    
+    # the referenced page
+    def refpage
+      @content.web.pages[@page_name]
+    end
+  
+  end
+
+  # A wiki link is the top-level class for links that refers to
+  # another wiki page.
+  class WikiLink < WikiReference
+ 
+    attr_reader :link_text, :link_type
+
+    def initialize(match_data, content)
+      super
+      @link_type = :show
+    end
+
+    def self.apply_to(content)
+      content.gsub!( self.pattern ) do |matched_text|
+        chunk = self.new($~, content)
+        if chunk.textile_url?
+          # do not substitute
+          matched_text
+        else
+          content.add_chunk(chunk)
+          chunk.mask
+        end
+      end
+    end
+
+    # the referenced page
+    def refpage
+      @content.web.pages[@page_name]
+    end
+
+    def textile_url?
+      not @textile_link_suffix.nil?
+    end
+
+  end
+
+  # This chunk matches a WikiWord. WikiWords can be escaped
+  # by prepending a '\'. When this is the case, the +escaped_text+
+  # method will return the WikiWord instead of the usual +nil+.
+  # The +page_name+ method returns the matched WikiWord.
+  class Word < WikiLink
+
+    attr_reader :escaped_text
+    
+    unless defined? WIKI_WORD
+      WIKI_WORD = Regexp.new('(":)?(\\\\)?(' + WikiWords::WIKI_WORD_PATTERN + ')\b', 0, "utf-8")
+    end
+
+    def self.pattern
+      WIKI_WORD
+    end
+
+    def initialize(match_data, content)
+      super
+      @textile_link_suffix, @escape, @page_name = match_data[1..3]
+      if @escape 
+        @unmask_mode = :escape
+        @escaped_text = @page_name
+      else
+        @escaped_text = nil
+      end
+      @link_text = WikiWords.separate(@page_name)
+      @unmask_text = (@escaped_text || @content.page_link(@page_name, @link_text, @link_type))
+    end
+
+  end
+
+  # This chunk handles [[bracketted wiki words]] and 
+  # [[AliasedWords|aliased wiki words]]. The first part of an
+  # aliased wiki word must be a WikiWord. If the WikiWord
+  # is aliased, the +link_text+ field will contain the
+  # alias, otherwise +link_text+ will contain the entire
+  # contents within the double brackets.
+  #
+  # NOTE: This chunk must be tested before WikiWord since
+  #       a WikiWords can be a substring of a WikiLink. 
+  class Link < WikiLink
+    
+    unless defined? WIKI_LINK
+      WIKI_LINK = /(":)?\[\[([^\]]+)\]\]/
+      LINK_TYPE_SEPARATION = Regexp.new('^(.+):((file)|(pic))$', 0, 'utf-8')
+      ALIAS_SEPARATION = Regexp.new('^(.+)\|(.+)$', 0, 'utf-8')
+    end    
+        
+    def self.pattern() WIKI_LINK end
+
+    def initialize(match_data, content)
+      super
+      @textile_link_suffix, @page_name = match_data[1..2]
+      @link_text = @page_name
+      separate_link_type
+      separate_alias
+      @unmask_text = @content.page_link(@page_name, @link_text, @link_type)
+    end
+
+    private
+
+    # if link wihin the brackets has a form of [[filename:file]] or [[filename:pic]], 
+    # this means a link to a picture or a file
+    def separate_link_type
+      link_type_match = LINK_TYPE_SEPARATION.match(@page_name)
+      if link_type_match
+        @link_text = @page_name = link_type_match[1]
+        @link_type = link_type_match[2..3].compact[0].to_sym
+      end
+    end
+
+    # link text may be different from page name. this will look like [[actual page|link text]]
+    def separate_alias
+      alias_match = ALIAS_SEPARATION.match(@page_name)
+      if alias_match
+        @page_name, @link_text = alias_match[1..2]
+      end
+      # note that [[filename|link text:file]] is also supported
+    end  
+  
+  end
+  
+end

data/app/models/file_yard.rb

@@ -1,58 +1,58 @@
-require 'fileutils'
-require 'instiki_errors'
-
-class FileYard
-
-  attr_reader :files_path
-
-  def initialize(files_path, max_upload_size)
-    @files_path = files_path
-    @max_upload_size = max_upload_size
-    FileUtils.mkdir_p(files_path) unless File.exist?(files_path)
-    @files = Dir["#{files_path}/*"].collect{|path| File.basename(path) if File.file?(path) }.compact
-  end
-
-  def upload_file(name, io)
-    sanitize_file_name(name)
-    if io.kind_of?(Tempfile)
-      io.close
-      check_upload_size(io.size)
-      FileUtils.mv(io.path, file_path(name))
-    else
-      content = io.read
-      check_upload_size(content.length)
-      File.open(file_path(name), 'wb') { |f| f.write(content) }
-    end
-    # just in case, restrict read access and prohibit write access to the uploaded file
-    FileUtils.chmod(0440, file_path(name))
-  end
-
-  def files
-    Dir["#{files_path}/*"].collect{|path| File.basename(path) if File.file?(path)}.compact
-  end
-
-  def has_file?(name)
-    files.include?(name)
-  end
-
-  def file_path(name)
-    "#{files_path}/#{name}"
-  end
-
-  SANE_FILE_NAME = /[-_\.A-Za-z0-9]{1,255}/
-
-  def sanitize_file_name(name)
-    unless name =~ SANE_FILE_NAME
-      raise Instiki::ValidationError.new("Invalid file name: '#{name}'.\n" +
-            "Only latin characters, digits, dots, underscores and dashes are accepted.")
-    end
-  end
-  
-  def check_upload_size(actual_upload_size)
-    if actual_upload_size > @max_upload_size.kilobytes
-      raise Instiki::ValidationError.new("Uploaded file size (#{actual_upload_size / 1024} " + 
-              "kbytes) exceeds the maximum (#{@max_upload_size} kbytes) set for this wiki")
-    end
-  end
-
-end
+require 'fileutils'
+require 'instiki_errors'
+
+class FileYard
+
+  attr_reader :files_path
+
+  def initialize(files_path, max_upload_size)
+    @files_path = files_path
+    @max_upload_size = max_upload_size
+    FileUtils.mkdir_p(files_path) unless File.exist?(files_path)
+    @files = Dir["#{files_path}/*"].collect{|path| File.basename(path) if File.file?(path) }.compact
+  end
+
+  def upload_file(name, io)
+    sanitize_file_name(name)
+    if io.kind_of?(Tempfile)
+      io.close
+      check_upload_size(io.size)
+      FileUtils.mv(io.path, file_path(name))
+    else
+      content = io.read
+      check_upload_size(content.length)
+      File.open(file_path(name), 'wb') { |f| f.write(content) }
+    end
+    # just in case, restrict read access and prohibit write access to the uploaded file
+    FileUtils.chmod(0440, file_path(name))
+  end
+
+  def files
+    Dir["#{files_path}/*"].collect{|path| File.basename(path) if File.file?(path)}.compact
+  end
+
+  def has_file?(name)
+    files.include?(name)
+  end
+
+  def file_path(name)
+    "#{files_path}/#{name}"
+  end
+
+  SANE_FILE_NAME = /[-_\.A-Za-z0-9]{1,255}/
+
+  def sanitize_file_name(name)
+    unless name =~ SANE_FILE_NAME
+      raise Instiki::ValidationError.new("Invalid file name: '#{name}'.\n" +
+            "Only latin characters, digits, dots, underscores and dashes are accepted.")
+    end
+  end
+  
+  def check_upload_size(actual_upload_size)
+    if actual_upload_size > @max_upload_size.kilobytes
+      raise Instiki::ValidationError.new("Uploaded file size (#{actual_upload_size / 1024} " + 
+              "kbytes) exceeds the maximum (#{@max_upload_size} kbytes) set for this wiki")
+    end
+  end
+
+end

data/app/models/page.rb

@@ -1,112 +1,112 @@
-require 'date'
-require 'page_lock'
-require 'revision'
-require 'wiki_words'
-require 'chunks/wiki'
-
-class Page
-  include PageLock
-
-  attr_reader :name, :web
-  attr_accessor :revisions
-  
-  def initialize(web, name, content, created_at, author)
-    @web, @name, @revisions = web, name, []
-    revise(content, created_at, author)
-  end
-
-  def revise(content, created_at, author)
-
-    if not @revisions.empty? and content == @revisions.last.content
-      raise Instiki::ValidationError.new(
-          "You have tried to save page '#{name}' without changing its content")
-    end
-
-    # A user may change a page, look at it and make some more changes - several times.
-    # Not to record every such iteration as a new revision, if the previous revision was done 
-    # by the same author, not more than 30 minutes ago, then update the last revision instead of
-    # creating a new one
-    if !@revisions.empty? && continous_revision?(created_at, author)
-      @revisions.last.created_at = created_at
-      @revisions.last.content = content
-      @revisions.last.clear_display_cache
-    else
-      @revisions << Revision.new(self, @revisions.length, content, created_at, author)
-    end
-
-    self.revisions.last.force_rendering
-    # at this point the page may not be inserted in the web yet, and therefore 
-    # references to the page itself are rendered as "unresolved". Clearing the cache allows 
-    # the page to re-render itself once again, hopefully _after_ it is inserted in the web
-    self.revisions.last.clear_display_cache
-    
-    @web.refresh_pages_with_references(@name) if @revisions.length == 1
-  end
-
-  def rollback(revision_number, created_at, author_ip = nil)
-    roll_back_revision = @revisions[revision_number].dup
-    revise(roll_back_revision.content, created_at, Author.new(roll_back_revision.author, author_ip))
-  end
-  
-  def revisions?
-    revisions.length > 1
-  end
-
-  def revised_on
-    created_on
-  end
-
-  def in_category?(cat)
-    cat.nil? || cat.empty? || categories.include?(cat)
-  end
-
-  def categories
-    display_content.find_chunks(Category).map { |cat| cat.list }.flatten
-  end
-
-  def authors
-    revisions.collect { |rev| rev.author }
-  end
-
-  def references
-    @web.select.pages_that_reference(name)
-  end
-
-  def linked_from
-    @web.select.pages_that_link_to(name)
-  end
-
-  def included_from
-    @web.select.pages_that_include(name)
-  end
-
-  # Returns the original wiki-word name as separate words, so "MyPage" becomes "My Page".
-  def plain_name
-    @web.brackets_only ? name : WikiWords.separate(name)
-  end
-
-  # used to build chunk ids. 
-  def id
-    @id ||= name.unpack('H*').first
-  end
-
-  def link(options = {})
-    @web.make_link(name, nil, options)
-  end
-
-  def author_link(options = {})
-    @web.make_link(author, nil, options)
-  end
-
-  private
-
-  def continous_revision?(created_at, author)
-    @revisions.last.author == author && @revisions.last.created_at + 30.minutes > created_at
-  end
-
-  # Forward method calls to the current revision, so the page responds to all revision calls
-  def method_missing(method_symbol)
-    revisions.last.send(method_symbol)
-  end
-
-end
+require 'date'
+require 'page_lock'
+require 'revision'
+require 'wiki_words'
+require 'chunks/wiki'
+
+class Page
+  include PageLock
+
+  attr_reader :name, :web
+  attr_accessor :revisions
+  
+  def initialize(web, name, content, created_at, author)
+    @web, @name, @revisions = web, name, []
+    revise(content, created_at, author)
+  end
+
+  def revise(content, created_at, author)
+
+    if not @revisions.empty? and content == @revisions.last.content
+      raise Instiki::ValidationError.new(
+          "You have tried to save page '#{name}' without changing its content")
+    end
+
+    # A user may change a page, look at it and make some more changes - several times.
+    # Not to record every such iteration as a new revision, if the previous revision was done 
+    # by the same author, not more than 30 minutes ago, then update the last revision instead of
+    # creating a new one
+    if !@revisions.empty? && continous_revision?(created_at, author)
+      @revisions.last.created_at = created_at
+      @revisions.last.content = content
+      @revisions.last.clear_display_cache
+    else
+      @revisions << Revision.new(self, @revisions.length, content, created_at, author)
+    end
+
+    self.revisions.last.force_rendering
+    # at this point the page may not be inserted in the web yet, and therefore 
+    # references to the page itself are rendered as "unresolved". Clearing the cache allows 
+    # the page to re-render itself once again, hopefully _after_ it is inserted in the web
+    self.revisions.last.clear_display_cache
+    
+    @web.refresh_pages_with_references(@name) if @revisions.length == 1
+  end
+
+  def rollback(revision_number, created_at, author_ip = nil)
+    roll_back_revision = @revisions[revision_number].dup
+    revise(roll_back_revision.content, created_at, Author.new(roll_back_revision.author, author_ip))
+  end
+  
+  def revisions?
+    revisions.length > 1
+  end
+
+  def revised_on
+    created_on
+  end
+
+  def in_category?(cat)
+    cat.nil? || cat.empty? || categories.include?(cat)
+  end
+
+  def categories
+    display_content.find_chunks(Category).map { |cat| cat.list }.flatten
+  end
+
+  def authors
+    revisions.collect { |rev| rev.author }
+  end
+
+  def references
+    @web.select.pages_that_reference(name)
+  end
+
+  def linked_from
+    @web.select.pages_that_link_to(name)
+  end
+
+  def included_from
+    @web.select.pages_that_include(name)
+  end
+
+  # Returns the original wiki-word name as separate words, so "MyPage" becomes "My Page".
+  def plain_name
+    @web.brackets_only ? name : WikiWords.separate(name)
+  end
+
+  # used to build chunk ids. 
+  def id
+    @id ||= name.unpack('H*').first
+  end
+
+  def link(options = {})
+    @web.make_link(name, nil, options)
+  end
+
+  def author_link(options = {})
+    @web.make_link(author, nil, options)
+  end
+
+  private
+
+  def continous_revision?(created_at, author)
+    @revisions.last.author == author && @revisions.last.created_at + 30.minutes > created_at
+  end
+
+  # Forward method calls to the current revision, so the page responds to all revision calls
+  def method_missing(method_symbol)
+    revisions.last.send(method_symbol)
+  end
+
+end