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