#-- encoding: UTF-8 #-- copyright # OpenProject is a project management system. # Copyright (C) 2012-2014 the OpenProject Foundation (OPF) # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License version 3. # # OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows: # Copyright (C) 2006-2013 Jean-Philippe Lang # Copyright (C) 2010-2013 the ChiliProject Team # # 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. # # 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. # # 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. # # See doc/COPYRIGHT.rdoc for more details. #++ require 'diff' require 'enumerator' class WikiPage < ActiveRecord::Base include ActiveModel::ForbiddenAttributesProtection belongs_to :wiki has_one :content, class_name: 'WikiContent', foreign_key: 'page_id', dependent: :destroy acts_as_attachable delete_permission: :delete_wiki_pages_attachments acts_as_tree dependent: :nullify, order: 'title' acts_as_watchable acts_as_event title: Proc.new { |o| "#{Wiki.model_name.human}: #{o.title}" }, description: :text, datetime: :created_on, url: Proc.new { |o| { controller: '/wiki', action: 'show', project_id: o.wiki.project, id: o.title } } acts_as_searchable columns: ["#{WikiPage.table_name}.title", "#{WikiContent.table_name}.text"], include: [{ wiki: :project }, :content], project_key: "#{Wiki.table_name}.project_id" attr_accessor :redirect_existing_links validates_presence_of :title validates_format_of :title, with: /\A[^,\.\/\?\;\|\s]*\z/ validates_uniqueness_of :title, scope: :wiki_id, case_sensitive: false validates_associated :content validate :validate_consistency_of_parent_title validate :validate_non_circular_dependency validate :validate_same_project after_initialize :check_and_mark_as_protected before_save :update_redirects before_destroy :remove_redirects # eager load information about last updates, without loading text scope :with_updated_on, 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" scope :main_pages, lambda {|wiki_id| { conditions: { wiki_id: wiki_id, parent_id: nil } } } # Wiki pages that are protected by default DEFAULT_PROTECTED_PAGES = %w(sidebar) after_destroy :delete_wiki_menu_item def check_and_mark_as_protected if new_record? && DEFAULT_PROTECTED_PAGES.include?(title.to_s.downcase) self.protected = true end end def delete_wiki_menu_item menu_item.destroy if menu_item # ensure there is a menu item for the wiki wiki.create_menu_item_for_start_page if MenuItems::WikiMenuItem.main_items(wiki).empty? end def visible?(user = User.current) !user.nil? && user.allowed_to?(:view_wiki_pages, project) end def title=(value) value = Wiki.titleize(value) @previous_title = read_attribute(:title) if @previous_title.blank? write_attribute(:title, value) end def update_redirects self.title = Wiki.titleize(title) # 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' # Change title of dependent wiki menu item dependent_item = MenuItems::WikiMenuItem.find_by_navigatable_id_and_title(wiki.id, @previous_title) if dependent_item dependent_item.title = title dependent_item.save! end @previous_title = nil end end # Remove redirects to this page def remove_redirects wiki.redirects.find_all_by_redirects_to(title).each(&:destroy) end def pretty_title WikiPage.pretty_title(title) end def content_for_version(version = nil) journal = content.versions.find_by_version(version.to_i) if version unless journal.nil? || content.version == journal.version content_version = WikiContent.new journal.data.attributes.except('id', 'journal_id') content_version.journals = content.journals.select { |j| j.version <= version.to_i } content_version else content end end def diff(version_to = nil, version_from = nil) version_to = version_to ? version_to.to_i : 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 content_to = content.versions.find_by_version(version_to) content_from = content.versions.find_by_version(version_from) (content_to && content_from) ? WikiDiff.new(content_to, content_from) : nil end def annotate(version = nil) version = version ? version.to_i : content.version c = content.versions.find_by_version(version) c ? WikiAnnotate.new(c) : nil end def self.pretty_title(str) (str && str.is_a?(String)) ? str.tr('_', ' ') : str end def project wiki.project end def text content.text if content end def updated_on unless @updated_on if time = read_attribute(:updated_on) # content updated_on was eager loaded with the page unless time.is_a? Time time = Time.zone.parse(time) rescue nil end @updated_on = time else @updated_on = content && content.updated_on end end @updated_on end # 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 def attachments_deletable?(usr = User.current) editable_by?(usr) && super(usr) end def parent_title @parent_title || (parent && parent.pretty_title) end def parent_title=(t) @parent_title = t parent_page = t.blank? ? nil : wiki.find_page(t) self.parent = parent_page end def menu_item MenuItems::WikiMenuItem.find_by_title_and_navigatable_id(title, wiki_id) end def nearest_menu_item menu_item || nearest_parent_menu_item end # Returns the wiki menu item of nearest ancestor page that has a wiki menu item. # To restrict the result to main menu items pass :is_main_item => true as +options+ hash def nearest_parent_menu_item(options = {}) return nil unless parent options = options.with_indifferent_access if (parent_menu_item = parent.menu_item) && (!options[:is_main_item] || parent_menu_item.is_main_item?) parent_menu_item else parent.nearest_parent_menu_item end end def breadcrumb_title if item = menu_item item.name else pretty_title end end def to_param CGI.escape title end def is_only_wiki_page? wiki.pages == [self] end protected def validate_consistency_of_parent_title errors.add(:parent_title, :invalid) if @parent_title.present? && parent.nil? end def validate_non_circular_dependency errors.add(:parent_title, :circular_dependency) if parent && (parent == self || parent.ancestors.include?(self)) end def validate_same_project errors.add(:parent_title, :not_same_project) if parent && (parent.wiki_id != wiki_id) end end class WikiDiff < Redmine::Helpers::Diff attr_reader :content_to, :content_from def initialize(content_to, content_from) @content_to = content_to @content_from = content_from super(content_to.data.text, content_from.data.text) end end class WikiAnnotate attr_reader :lines, :content def initialize(content) @content = content current = content current_lines = current.journable.text.split(/\r?\n/) @lines = current_lines.map { |t| [nil, nil, t] } positions = [] current_lines.size.times { |i| positions << i } while current.previous d = current.previous.journable.text.split(/\r?\n/).diff(current.journable.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.journable.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 @lines.each { |line| line[0] ||= current.version } end end