annotate app/models/wiki.rb @ 1628:9c5f8e24dadc live tip

Quieten this cron script
author Chris Cannam
date Tue, 25 Aug 2020 11:38:49 +0100
parents fb9a13467253
children
rev   line source
Chris@0 1 # Redmine - project management software
Chris@1494 2 # Copyright (C) 2006-2014 Jean-Philippe Lang
Chris@0 3 #
Chris@0 4 # This program is free software; you can redistribute it and/or
Chris@0 5 # modify it under the terms of the GNU General Public License
Chris@0 6 # as published by the Free Software Foundation; either version 2
Chris@0 7 # of the License, or (at your option) any later version.
Chris@909 8 #
Chris@0 9 # This program is distributed in the hope that it will be useful,
Chris@0 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@0 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Chris@0 12 # GNU General Public License for more details.
Chris@909 13 #
Chris@0 14 # You should have received a copy of the GNU General Public License
Chris@0 15 # along with this program; if not, write to the Free Software
Chris@0 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Chris@0 17
Chris@0 18 class Wiki < ActiveRecord::Base
Chris@929 19 include Redmine::SafeAttributes
Chris@0 20 belongs_to :project
Chris@0 21 has_many :pages, :class_name => 'WikiPage', :dependent => :destroy, :order => 'title'
Chris@0 22 has_many :redirects, :class_name => 'WikiRedirect', :dependent => :delete_all
Chris@909 23
Chris@0 24 acts_as_watchable
Chris@909 25
Chris@0 26 validates_presence_of :start_page
Chris@1464 27 validates_format_of :start_page, :with => /\A[^,\.\/\?\;\|\:]*\z/
Chris@909 28
Chris@929 29 safe_attributes 'start_page'
Chris@929 30
Chris@0 31 def visible?(user=User.current)
Chris@0 32 !user.nil? && user.allowed_to?(:view_wiki_pages, project)
Chris@0 33 end
Chris@909 34
Chris@0 35 # Returns the wiki page that acts as the sidebar content
Chris@0 36 # or nil if no such page exists
Chris@0 37 def sidebar
Chris@0 38 @sidebar ||= find_page('Sidebar', :with_redirect => false)
Chris@0 39 end
Chris@909 40
Chris@0 41 # find the page with the given title
Chris@0 42 # if page doesn't exist, return a new page
Chris@0 43 def find_or_new_page(title)
Chris@0 44 title = start_page if title.blank?
Chris@0 45 find_page(title) || WikiPage.new(:wiki => self, :title => Wiki.titleize(title))
Chris@0 46 end
Chris@909 47
Chris@0 48 # find the page with the given title
Chris@0 49 def find_page(title, options = {})
Chris@441 50 @page_found_with_redirect = false
Chris@0 51 title = start_page if title.blank?
Chris@0 52 title = Wiki.titleize(title)
Chris@1464 53 page = pages.where("LOWER(title) = LOWER(?)", title).first
Chris@0 54 if !page && !(options[:with_redirect] == false)
Chris@0 55 # search for a redirect
Chris@1464 56 redirect = redirects.where("LOWER(title) = LOWER(?)", title).first
Chris@441 57 if redirect
Chris@441 58 page = find_page(redirect.redirects_to, :with_redirect => false)
Chris@441 59 @page_found_with_redirect = true
Chris@441 60 end
Chris@0 61 end
Chris@0 62 page
Chris@0 63 end
Chris@909 64
Chris@441 65 # Returns true if the last page was found with a redirect
Chris@441 66 def page_found_with_redirect?
Chris@441 67 @page_found_with_redirect
Chris@441 68 end
Chris@441 69
Chris@0 70 # Finds a page by title
Chris@0 71 # The given string can be of one of the forms: "title" or "project:title"
Chris@0 72 # Examples:
Chris@0 73 # Wiki.find_page("bar", project => foo)
Chris@0 74 # Wiki.find_page("foo:bar")
Chris@0 75 def self.find_page(title, options = {})
Chris@0 76 project = options[:project]
Chris@0 77 if title.to_s =~ %r{^([^\:]+)\:(.*)$}
Chris@0 78 project_identifier, title = $1, $2
Chris@0 79 project = Project.find_by_identifier(project_identifier) || Project.find_by_name(project_identifier)
Chris@0 80 end
Chris@0 81 if project && project.wiki
Chris@0 82 page = project.wiki.find_page(title)
Chris@0 83 if page && page.content
Chris@0 84 page
Chris@0 85 end
Chris@0 86 end
Chris@0 87 end
Chris@909 88
Chris@0 89 # turn a string into a valid page title
Chris@0 90 def self.titleize(title)
Chris@0 91 # replace spaces with _ and remove unwanted caracters
Chris@0 92 title = title.gsub(/\s+/, '_').delete(',./?;|:') if title
Chris@0 93 # upcase the first letter
Chris@0 94 title = (title.slice(0..0).upcase + (title.slice(1..-1) || '')) if title
Chris@0 95 title
Chris@909 96 end
Chris@0 97 end