wiki_page.rb
299 lines
| 9.4 KiB
| text/x-ruby
|
RubyLexer
Jean-Philippe Lang
|
r2666 | # Redmine - project management software | ||
|
Jean-Philippe Lang
|
r13490 | # Copyright (C) 2006-2015 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
|
r13357 | :scope => joins(:content, {:wiki => :project}), | ||
|
Jean-Philippe Lang
|
r13432 | :preload => [:content, {:wiki => :project}], | ||
|
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
|
r10734 | validates_format_of :title, :with => /\A[^,\.\/\?\;\|\s]*\z/ | ||
|
Jean-Philippe Lang
|
r320 | validates_uniqueness_of :title, :scope => :wiki_id, :case_sensitive => false | ||
| validates_associated :content | ||||
|
Jean-Philippe Lang
|
r13100 | attr_protected :id | ||
|
Toshi MARUYAMA
|
r6391 | |||
|
Toshi MARUYAMA
|
r6714 | validate :validate_parent_title | ||
|
Jean-Philippe Lang
|
r13261 | before_destroy :delete_redirects | ||
| before_save :handle_rename_or_move | ||||
| after_save :handle_children_move | ||||
|
Toshi MARUYAMA
|
r6714 | |||
|
Jean-Philippe Lang
|
r4978 | # eager load information about last updates, without loading text | ||
|
Jean-Philippe Lang
|
r10723 | scope :with_updated_on, lambda { | ||
| select("#{WikiPage.table_name}.*, #{WikiContent.table_name}.updated_on, #{WikiContent.table_name}.version"). | ||||
| 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
|
r13261 | safe_attributes 'parent_id', 'parent_title', 'title', 'redirect_existing_links', 'wiki_id', | ||
|
Jean-Philippe Lang
|
r8667 | :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) | ||||
| write_attribute(:title, value) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r13261 | def safe_attributes=(attrs, user=User.current) | ||
| return unless attrs.is_a?(Hash) | ||||
| attrs = attrs.deep_dup | ||||
| # Project and Tracker must be set before since new_statuses_allowed_to depends on it. | ||||
| if (w_id = attrs.delete('wiki_id')) && safe_attribute?('wiki_id') | ||||
| if (w = Wiki.find_by_id(w_id)) && w.project && user.allowed_to?(:rename_wiki_pages, w.project) | ||||
| self.wiki = w | ||||
| end | ||||
| end | ||||
| super attrs, user | ||||
| end | ||||
| # Manages redirects if page is renamed or moved | ||||
| def handle_rename_or_move | ||||
| if !new_record? && (title_changed? || wiki_id_changed?) | ||||
|
Jean-Philippe Lang
|
r709 | # Update redirects that point to the old title | ||
|
Jean-Philippe Lang
|
r13261 | WikiRedirect.where(:redirects_to => title_was, :redirects_to_wiki_id => wiki_id_was).each do |r| | ||
|
Jean-Philippe Lang
|
r709 | r.redirects_to = title | ||
|
Jean-Philippe Lang
|
r13261 | r.redirects_to_wiki_id = wiki_id | ||
| (r.title == r.redirects_to && r.wiki_id == r.redirects_to_wiki_id) ? r.destroy : r.save | ||||
|
Jean-Philippe Lang
|
r709 | end | ||
| # Remove redirects for the new title | ||||
|
Jean-Philippe Lang
|
r13261 | WikiRedirect.where(:wiki_id => wiki_id, :title => title).delete_all | ||
|
Jean-Philippe Lang
|
r709 | # Create a redirect to the new title | ||
|
Jean-Philippe Lang
|
r13261 | unless redirect_existing_links == "0" | ||
| WikiRedirect.create( | ||||
| :wiki_id => wiki_id_was, :title => title_was, | ||||
| :redirects_to_wiki_id => wiki_id, :redirects_to => title | ||||
| ) | ||||
| end | ||||
| end | ||||
| if !new_record? && wiki_id_changed? && parent.present? | ||||
| unless parent.wiki_id == wiki_id | ||||
| self.parent_id = nil | ||||
| end | ||||
|
Jean-Philippe Lang
|
r709 | end | ||
| end | ||||
|
Jean-Philippe Lang
|
r13261 | private :handle_rename_or_move | ||
| # Moves child pages if page was moved | ||||
| def handle_children_move | ||||
| if !new_record? && wiki_id_changed? | ||||
| children.each do |child| | ||||
| child.wiki_id = wiki_id | ||||
| child.redirect_existing_links = redirect_existing_links | ||||
| unless child.save | ||||
| WikiPage.where(:id => child.id).update_all :parent_nil => nil | ||||
| end | ||||
| end | ||||
| end | ||||
| end | ||||
| private :handle_children_move | ||||
|
Toshi MARUYAMA
|
r6391 | |||
|
Jean-Philippe Lang
|
r13261 | # Deletes redirects to this page | ||
| def delete_redirects | ||||
| WikiRedirect.where(:redirects_to_wiki_id => wiki_id, :redirects_to => title).delete_all | ||||
|
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) | ||
|
Jean-Philippe Lang
|
r12696 | if content | ||
| result = content.versions.find_by_version(version.to_i) if version | ||||
| result ||= content | ||||
| result | ||||
| end | ||||
|
Jean-Philippe Lang
|
r421 | 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 | ||||
| content_to = content.versions.find_by_version(version_to) | ||||
|
Jean-Philippe Lang
|
r10650 | content_from = version_from ? content.versions.find_by_version(version_from.to_i) : content_to.try(:previous) | ||
| return nil unless content_to && content_from | ||||
|
Jean-Philippe Lang
|
r10473 | |||
| if content_from.version > content_to.version | ||||
| content_to, content_from = content_from, content_to | ||||
| end | ||||
|
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 | ||
|
Jean-Philippe Lang
|
r13261 | wiki.try(:project) | ||
|
Jean-Philippe Lang
|
r538 | 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
|
r10615 | # Saves the page and its content if text was changed | ||
|
Jean-Philippe Lang
|
r13314 | # Return true if the page was saved | ||
|
Jean-Philippe Lang
|
r11990 | def save_with_content(content) | ||
|
Jean-Philippe Lang
|
r10615 | ret = nil | ||
| transaction do | ||||
|
Jean-Philippe Lang
|
r13100 | ret = save | ||
| if content.text_changed? | ||||
|
Jean-Philippe Lang
|
r13314 | begin | ||
| self.content = content | ||||
| ret = ret && content.changed? | ||||
| rescue ActiveRecord::RecordNotSaved | ||||
| ret = false | ||||
| end | ||||
|
Jean-Philippe Lang
|
r10615 | end | ||
| raise ActiveRecord::Rollback unless ret | ||||
| end | ||||
| ret | ||||
| end | ||||
|
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)) | ||||
|
Jean-Philippe Lang
|
r13261 | if parent_id_changed? && parent && (parent.wiki_id != wiki_id) | ||
| errors.add(:parent_title, :not_same_project) | ||||
| end | ||||
|
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 | ||||