Chris@1295: # Redmine - project management software
Chris@1295: # Copyright (C) 2006-2012  Jean-Philippe Lang
Chris@1295: #
Chris@1295: # This program is free software; you can redistribute it and/or
Chris@1295: # modify it under the terms of the GNU General Public License
Chris@1295: # as published by the Free Software Foundation; either version 2
Chris@1295: # of the License, or (at your option) any later version.
Chris@1295: #
Chris@1295: # This program is distributed in the hope that it will be useful,
Chris@1295: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1295: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1295: # GNU General Public License for more details.
Chris@1295: #
Chris@1295: # You should have received a copy of the GNU General Public License
Chris@1295: # along with this program; if not, write to the Free Software
Chris@1295: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1295: 
Chris@1295: require 'diff'
Chris@1295: require 'enumerator'
Chris@1295: 
Chris@1295: class WikiPage < ActiveRecord::Base
Chris@1295:   include Redmine::SafeAttributes
Chris@1295: 
Chris@1295:   belongs_to :wiki
Chris@1295:   has_one :content, :class_name => 'WikiContent', :foreign_key => 'page_id', :dependent => :destroy
Chris@1295:   acts_as_attachable :delete_permission => :delete_wiki_pages_attachments
Chris@1295:   acts_as_tree :dependent => :nullify, :order => 'title'
Chris@1295: 
Chris@1295:   acts_as_watchable
Chris@1295:   acts_as_event :title => Proc.new {|o| "#{l(:label_wiki)}: #{o.title}"},
Chris@1295:                 :description => :text,
Chris@1295:                 :datetime => :created_on,
Chris@1295:                 :url => Proc.new {|o| {:controller => 'wiki', :action => 'show', :project_id => o.wiki.project, :id => o.title}}
Chris@1295: 
Chris@1295:   acts_as_searchable :columns => ['title', "#{WikiContent.table_name}.text"],
Chris@1295:                      :include => [{:wiki => :project}, :content],
Chris@1295:                      :permission => :view_wiki_pages,
Chris@1295:                      :project_key => "#{Wiki.table_name}.project_id"
Chris@1295: 
Chris@1295:   attr_accessor :redirect_existing_links
Chris@1295: 
Chris@1295:   validates_presence_of :title
Chris@1295:   validates_format_of :title, :with => /^[^,\.\/\?\;\|\s]*$/
Chris@1295:   validates_uniqueness_of :title, :scope => :wiki_id, :case_sensitive => false
Chris@1295:   validates_associated :content
Chris@1295: 
Chris@1295:   validate :validate_parent_title
Chris@1295:   before_destroy :remove_redirects
Chris@1295:   before_save    :handle_redirects
Chris@1295: 
Chris@1295:   # eager load information about last updates, without loading text
Chris@1295:   scope :with_updated_on, {
Chris@1295:     :select => "#{WikiPage.table_name}.*, #{WikiContent.table_name}.updated_on, #{WikiContent.table_name}.version",
Chris@1295:     :joins => "LEFT JOIN #{WikiContent.table_name} ON #{WikiContent.table_name}.page_id = #{WikiPage.table_name}.id"
Chris@1295:   }
Chris@1295: 
Chris@1295:   # Wiki pages that are protected by default
Chris@1295:   DEFAULT_PROTECTED_PAGES = %w(sidebar)
Chris@1295: 
Chris@1295:   safe_attributes 'parent_id', 'parent_title',
Chris@1295:     :if => lambda {|page, user| page.new_record? || user.allowed_to?(:rename_wiki_pages, page.project)}
Chris@1295: 
Chris@1295:   def initialize(attributes=nil, *args)
Chris@1295:     super
Chris@1295:     if new_record? && DEFAULT_PROTECTED_PAGES.include?(title.to_s.downcase)
Chris@1295:       self.protected = true
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   def visible?(user=User.current)
Chris@1295:     !user.nil? && user.allowed_to?(:view_wiki_pages, project)
Chris@1295:   end
Chris@1295: 
Chris@1295:   def title=(value)
Chris@1295:     value = Wiki.titleize(value)
Chris@1295:     @previous_title = read_attribute(:title) if @previous_title.blank?
Chris@1295:     write_attribute(:title, value)
Chris@1295:   end
Chris@1295: 
Chris@1295:   def handle_redirects
Chris@1295:     self.title = Wiki.titleize(title)
Chris@1295:     # Manage redirects if the title has changed
Chris@1295:     if !@previous_title.blank? && (@previous_title != title) && !new_record?
Chris@1295:       # Update redirects that point to the old title
Chris@1295:       wiki.redirects.find_all_by_redirects_to(@previous_title).each do |r|
Chris@1295:         r.redirects_to = title
Chris@1295:         r.title == r.redirects_to ? r.destroy : r.save
Chris@1295:       end
Chris@1295:       # Remove redirects for the new title
Chris@1295:       wiki.redirects.find_all_by_title(title).each(&:destroy)
Chris@1295:       # Create a redirect to the new title
Chris@1295:       wiki.redirects << WikiRedirect.new(:title => @previous_title, :redirects_to => title) unless redirect_existing_links == "0"
Chris@1295:       @previous_title = nil
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   def remove_redirects
Chris@1295:     # Remove redirects to this page
Chris@1295:     wiki.redirects.find_all_by_redirects_to(title).each(&:destroy)
Chris@1295:   end
Chris@1295: 
Chris@1295:   def pretty_title
Chris@1295:     WikiPage.pretty_title(title)
Chris@1295:   end
Chris@1295: 
Chris@1295:   def content_for_version(version=nil)
Chris@1295:     result = content.versions.find_by_version(version.to_i) if version
Chris@1295:     result ||= content
Chris@1295:     result
Chris@1295:   end
Chris@1295: 
Chris@1295:   def diff(version_to=nil, version_from=nil)
Chris@1295:     version_to = version_to ? version_to.to_i : self.content.version
Chris@1295:     content_to = content.versions.find_by_version(version_to)
Chris@1295:     content_from = version_from ? content.versions.find_by_version(version_from.to_i) : content_to.try(:previous)
Chris@1295:     return nil unless content_to && content_from
Chris@1295: 
Chris@1295:     if content_from.version > content_to.version
Chris@1295:       content_to, content_from = content_from, content_to
Chris@1295:     end
Chris@1295: 
Chris@1295:     (content_to && content_from) ? WikiDiff.new(content_to, content_from) : nil
Chris@1295:   end
Chris@1295: 
Chris@1295:   def annotate(version=nil)
Chris@1295:     version = version ? version.to_i : self.content.version
Chris@1295:     c = content.versions.find_by_version(version)
Chris@1295:     c ? WikiAnnotate.new(c) : nil
Chris@1295:   end
Chris@1295: 
Chris@1295:   def self.pretty_title(str)
Chris@1295:     (str && str.is_a?(String)) ? str.tr('_', ' ') : str
Chris@1295:   end
Chris@1295: 
Chris@1295:   def project
Chris@1295:     wiki.project
Chris@1295:   end
Chris@1295: 
Chris@1295:   def text
Chris@1295:     content.text if content
Chris@1295:   end
Chris@1295: 
Chris@1295:   def updated_on
Chris@1295:     unless @updated_on
Chris@1295:       if time = read_attribute(:updated_on)
Chris@1295:         # content updated_on was eager loaded with the page
Chris@1295:         begin
Chris@1295:           @updated_on = (self.class.default_timezone == :utc ? Time.parse(time.to_s).utc : Time.parse(time.to_s).localtime)
Chris@1295:         rescue
Chris@1295:         end
Chris@1295:       else
Chris@1295:         @updated_on = content && content.updated_on
Chris@1295:       end
Chris@1295:     end
Chris@1295:     @updated_on
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Returns true if usr is allowed to edit the page, otherwise false
Chris@1295:   def editable_by?(usr)
Chris@1295:     !protected? || usr.allowed_to?(:protect_wiki_pages, wiki.project)
Chris@1295:   end
Chris@1295: 
Chris@1295:   def attachments_deletable?(usr=User.current)
Chris@1295:     editable_by?(usr) && super(usr)
Chris@1295:   end
Chris@1295: 
Chris@1295:   def parent_title
Chris@1295:     @parent_title || (self.parent && self.parent.pretty_title)
Chris@1295:   end
Chris@1295: 
Chris@1295:   def parent_title=(t)
Chris@1295:     @parent_title = t
Chris@1295:     parent_page = t.blank? ? nil : self.wiki.find_page(t)
Chris@1295:     self.parent = parent_page
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Saves the page and its content if text was changed
Chris@1295:   def save_with_content
Chris@1295:     ret = nil
Chris@1295:     transaction do
Chris@1295:       if new_record?
Chris@1295:         # Rails automatically saves associated content
Chris@1295:         ret = save
Chris@1295:       else
Chris@1295:         ret = save && (content.text_changed? ? content.save : true)
Chris@1295:       end
Chris@1295:       raise ActiveRecord::Rollback unless ret
Chris@1295:     end
Chris@1295:     ret
Chris@1295:   end
Chris@1295: 
Chris@1295:   protected
Chris@1295: 
Chris@1295:   def validate_parent_title
Chris@1295:     errors.add(:parent_title, :invalid) if !@parent_title.blank? && parent.nil?
Chris@1295:     errors.add(:parent_title, :circular_dependency) if parent && (parent == self || parent.ancestors.include?(self))
Chris@1295:     errors.add(:parent_title, :not_same_project) if parent && (parent.wiki_id != wiki_id)
Chris@1295:   end
Chris@1295: end
Chris@1295: 
Chris@1295: class WikiDiff < Redmine::Helpers::Diff
Chris@1295:   attr_reader :content_to, :content_from
Chris@1295: 
Chris@1295:   def initialize(content_to, content_from)
Chris@1295:     @content_to = content_to
Chris@1295:     @content_from = content_from
Chris@1295:     super(content_to.text, content_from.text)
Chris@1295:   end
Chris@1295: end
Chris@1295: 
Chris@1295: class WikiAnnotate
Chris@1295:   attr_reader :lines, :content
Chris@1295: 
Chris@1295:   def initialize(content)
Chris@1295:     @content = content
Chris@1295:     current = content
Chris@1295:     current_lines = current.text.split(/\r?\n/)
Chris@1295:     @lines = current_lines.collect {|t| [nil, nil, t]}
Chris@1295:     positions = []
Chris@1295:     current_lines.size.times {|i| positions << i}
Chris@1295:     while (current.previous)
Chris@1295:       d = current.previous.text.split(/\r?\n/).diff(current.text.split(/\r?\n/)).diffs.flatten
Chris@1295:       d.each_slice(3) do |s|
Chris@1295:         sign, line = s[0], s[1]
Chris@1295:         if sign == '+' && positions[line] && positions[line] != -1
Chris@1295:           if @lines[positions[line]][0].nil?
Chris@1295:             @lines[positions[line]][0] = current.version
Chris@1295:             @lines[positions[line]][1] = current.author
Chris@1295:           end
Chris@1295:         end
Chris@1295:       end
Chris@1295:       d.each_slice(3) do |s|
Chris@1295:         sign, line = s[0], s[1]
Chris@1295:         if sign == '-'
Chris@1295:           positions.insert(line, -1)
Chris@1295:         else
Chris@1295:           positions[line] = nil
Chris@1295:         end
Chris@1295:       end
Chris@1295:       positions.compact!
Chris@1295:       # Stop if every line is annotated
Chris@1295:       break unless @lines.detect { |line| line[0].nil? }
Chris@1295:       current = current.previous
Chris@1295:     end
Chris@1295:     @lines.each { |line|
Chris@1295:       line[0] ||= current.version
Chris@1295:       # if the last known version is > 1 (eg. history was cleared), we don't know the author
Chris@1295:       line[1] ||= current.author if current.version == 1
Chris@1295:     }
Chris@1295:   end
Chris@1295: end