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