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: class Wiki < ActiveRecord::Base
Chris@1494:   include Redmine::SafeAttributes
Chris@1494:   belongs_to :project
Chris@1494:   has_many :pages, :class_name => 'WikiPage', :dependent => :destroy, :order => 'title'
Chris@1494:   has_many :redirects, :class_name => 'WikiRedirect', :dependent => :delete_all
Chris@1494: 
Chris@1494:   acts_as_watchable
Chris@1494: 
Chris@1494:   validates_presence_of :start_page
Chris@1494:   validates_format_of :start_page, :with => /\A[^,\.\/\?\;\|\:]*\z/
Chris@1494: 
Chris@1494:   safe_attributes 'start_page'
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:   # Returns the wiki page that acts as the sidebar content
Chris@1494:   # or nil if no such page exists
Chris@1494:   def sidebar
Chris@1494:     @sidebar ||= find_page('Sidebar', :with_redirect => false)
Chris@1494:   end
Chris@1494: 
Chris@1494:   # find the page with the given title
Chris@1494:   # if page doesn't exist, return a new page
Chris@1494:   def find_or_new_page(title)
Chris@1494:     title = start_page if title.blank?
Chris@1494:     find_page(title) || WikiPage.new(:wiki => self, :title => Wiki.titleize(title))
Chris@1494:   end
Chris@1494: 
Chris@1494:   # find the page with the given title
Chris@1494:   def find_page(title, options = {})
Chris@1494:     @page_found_with_redirect = false
Chris@1494:     title = start_page if title.blank?
Chris@1494:     title = Wiki.titleize(title)
Chris@1494:     page = pages.where("LOWER(title) = LOWER(?)", title).first
Chris@1494:     if !page && !(options[:with_redirect] == false)
Chris@1494:       # search for a redirect
Chris@1494:       redirect = redirects.where("LOWER(title) = LOWER(?)", title).first
Chris@1494:       if redirect
Chris@1494:         page = find_page(redirect.redirects_to, :with_redirect => false)
Chris@1494:         @page_found_with_redirect = true
Chris@1494:       end
Chris@1494:     end
Chris@1494:     page
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Returns true if the last page was found with a redirect
Chris@1494:   def page_found_with_redirect?
Chris@1494:     @page_found_with_redirect
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Finds a page by title
Chris@1494:   # The given string can be of one of the forms: "title" or "project:title"
Chris@1494:   # Examples:
Chris@1494:   #   Wiki.find_page("bar", project => foo)
Chris@1494:   #   Wiki.find_page("foo:bar")
Chris@1494:   def self.find_page(title, options = {})
Chris@1494:     project = options[:project]
Chris@1494:     if title.to_s =~ %r{^([^\:]+)\:(.*)$}
Chris@1494:       project_identifier, title = $1, $2
Chris@1494:       project = Project.find_by_identifier(project_identifier) || Project.find_by_name(project_identifier)
Chris@1494:     end
Chris@1494:     if project && project.wiki
Chris@1494:       page = project.wiki.find_page(title)
Chris@1494:       if page && page.content
Chris@1494:         page
Chris@1494:       end
Chris@1494:     end
Chris@1494:   end
Chris@1494: 
Chris@1494:   # turn a string into a valid page title
Chris@1494:   def self.titleize(title)
Chris@1494:     # replace spaces with _ and remove unwanted caracters
Chris@1494:     title = title.gsub(/\s+/, '_').delete(',./?;|:') if title
Chris@1494:     # upcase the first letter
Chris@1494:     title = (title.slice(0..0).upcase + (title.slice(1..-1) || '')) if title
Chris@1494:     title
Chris@1494:   end
Chris@1494: end