wiki_controller.rb
279 lines
| 9.9 KiB
| text/x-ruby
|
RubyLexer
Jean-Philippe Lang
|
r320 | # redMine - project management software | ||
| # Copyright (C) 2006-2007 Jean-Philippe Lang | ||||
| # | ||||
| # 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. | ||||
|
Jean-Philippe Lang
|
r580 | require 'diff' | ||
Eric Davis
|
r4176 | # The WikiController follows the Rails REST controller pattern but with | ||
| # a few differences | ||||
| # | ||||
| # * index - shows a list of WikiPages grouped by page or date | ||||
| # * new - not used | ||||
| # * create - not used | ||||
| # * show - will also show the form for creating a new wiki page | ||||
| # * edit - used to edit an existing or new page | ||||
| # * update - used to save a wiki page update to the database, including new pages | ||||
| # * destroy - normal | ||||
| # | ||||
| # Other member and collection methods are also used | ||||
| # | ||||
| # TODO: still being worked on | ||||
|
Jean-Philippe Lang
|
r320 | class WikiController < ApplicationController | ||
|
Jean-Philippe Lang
|
r2829 | default_search_scope :wiki_pages | ||
|
Jean-Philippe Lang
|
r663 | before_filter :find_wiki, :authorize | ||
|
Jean-Philippe Lang
|
r2143 | before_filter :find_existing_page, :only => [:rename, :protect, :history, :diff, :annotate, :add_attachment, :destroy] | ||
|
Jean-Philippe Lang
|
r537 | |||
|
Eric Davis
|
r4181 | verify :method => :post, :only => [:protect], :redirect_to => { :action => :show } | ||
|
Jean-Philippe Lang
|
r538 | |||
| helper :attachments | ||||
| include AttachmentsHelper | ||||
|
Jean-Philippe Lang
|
r2666 | helper :watchers | ||
|
Eric Davis
|
r4152 | |||
|
Eric Davis
|
r4176 | # List of pages, sorted alphabetically and by parent (hierarchy) | ||
| def index | ||||
| load_pages_grouped_by_date_without_content | ||||
| end | ||||
|
Jean-Philippe Lang
|
r320 | # display a page (in editing mode if it doesn't exist) | ||
|
Eric Davis
|
r4152 | def show | ||
|
Eric Davis
|
r4182 | page_title = params[:id] | ||
|
Jean-Philippe Lang
|
r320 | @page = @wiki.find_or_new_page(page_title) | ||
| if @page.new_record? | ||||
|
Jean-Philippe Lang
|
r3518 | if User.current.allowed_to?(:edit_wiki_pages, @project) && editable? | ||
|
Jean-Philippe Lang
|
r812 | edit | ||
| render :action => 'edit' | ||||
| else | ||||
| render_404 | ||||
| end | ||||
| return | ||||
|
Jean-Philippe Lang
|
r320 | end | ||
|
Jean-Philippe Lang
|
r1813 | if params[:version] && !User.current.allowed_to?(:view_wiki_edits, @project) | ||
| # Redirects user to the current version if he's not allowed to view previous versions | ||||
| redirect_to :version => nil | ||||
| return | ||||
| end | ||||
|
Jean-Philippe Lang
|
r421 | @content = @page.content_for_version(params[:version]) | ||
|
Jean-Philippe Lang
|
r3257 | if User.current.allowed_to?(:export_wiki_pages, @project) | ||
| if params[:format] == 'html' | ||||
| export = render_to_string :action => 'export', :layout => false | ||||
| send_data(export, :type => 'text/html', :filename => "#{@page.title}.html") | ||||
| return | ||||
| elsif params[:format] == 'txt' | ||||
| send_data(@content.text, :type => 'text/plain', :filename => "#{@page.title}.txt") | ||||
| return | ||||
| end | ||||
|
Jean-Philippe Lang
|
r320 | end | ||
|
Jean-Philippe Lang
|
r3257 | @editable = editable? | ||
|
Jean-Philippe Lang
|
r320 | render :action => 'show' | ||
| end | ||||
| # edit an existing page or a new one | ||||
| def edit | ||||
|
Eric Davis
|
r4182 | @page = @wiki.find_or_new_page(params[:id]) | ||
|
Jean-Philippe Lang
|
r1400 | return render_403 unless editable? | ||
|
Jean-Philippe Lang
|
r320 | @page.content = WikiContent.new(:page => @page) if @page.new_record? | ||
|
Jean-Philippe Lang
|
r421 | |||
| @content = @page.content_for_version(params[:version]) | ||||
|
Jean-Philippe Lang
|
r1953 | @content.text = initial_page_content(@page) if @content.text.blank? | ||
|
Jean-Philippe Lang
|
r320 | # don't keep previous comment | ||
|
Jean-Philippe Lang
|
r476 | @content.comments = nil | ||
|
Eric Davis
|
r4158 | |||
| # To prevent StaleObjectError exception when reverting to a previous version | ||||
| @content.version = @page.content.version | ||||
| rescue ActiveRecord::StaleObjectError | ||||
| # Optimistic locking exception | ||||
| flash[:error] = l(:notice_locking_conflict) | ||||
| end | ||||
|
Eric Davis
|
r4189 | verify :method => :put, :only => :update, :render => {:nothing => true, :status => :method_not_allowed } | ||
|
Eric Davis
|
r4158 | # Creates a new page or updates an existing one | ||
| def update | ||||
|
Eric Davis
|
r4182 | @page = @wiki.find_or_new_page(params[:id]) | ||
|
Eric Davis
|
r4158 | return render_403 unless editable? | ||
| @page.content = WikiContent.new(:page => @page) if @page.new_record? | ||||
| @content = @page.content_for_version(params[:version]) | ||||
| @content.text = initial_page_content(@page) if @content.text.blank? | ||||
| # don't keep previous comment | ||||
| @content.comments = nil | ||||
| if !@page.new_record? && params[:content].present? && @content.text == params[:content][:text] | ||||
| attachments = Attachment.attach_files(@page, params[:attachments]) | ||||
| render_attachment_warning_if_needed(@page) | ||||
| # don't save if text wasn't changed | ||||
|
Eric Davis
|
r4182 | redirect_to :action => 'show', :project_id => @project, :id => @page.title | ||
|
Eric Davis
|
r4158 | return | ||
| end | ||||
| @content.attributes = params[:content] | ||||
| @content.author = User.current | ||||
| # if page is new @page.save will also save content, but not if page isn't a new record | ||||
| if (@page.new_record? ? @page.save : @content.save) | ||||
| attachments = Attachment.attach_files(@page, params[:attachments]) | ||||
| render_attachment_warning_if_needed(@page) | ||||
| call_hook(:controller_wiki_edit_after_save, { :params => params, :page => @page}) | ||||
|
Eric Davis
|
r4182 | redirect_to :action => 'show', :project_id => @project, :id => @page.title | ||
|
Jean-Philippe Lang
|
r4315 | else | ||
| render :action => 'edit' | ||||
|
Jean-Philippe Lang
|
r320 | end | ||
|
Eric Davis
|
r4158 | |||
|
Jean-Philippe Lang
|
r542 | rescue ActiveRecord::StaleObjectError | ||
| # Optimistic locking exception | ||||
|
Jean-Philippe Lang
|
r597 | flash[:error] = l(:notice_locking_conflict) | ||
|
Jean-Philippe Lang
|
r320 | end | ||
|
Eric Davis
|
r4158 | |||
|
Jean-Philippe Lang
|
r709 | # rename a page | ||
| def rename | ||||
|
Jean-Philippe Lang
|
r2143 | return render_403 unless editable? | ||
|
Jean-Philippe Lang
|
r709 | @page.redirect_existing_links = true | ||
| # used to display the *original* title if some AR validation errors occur | ||||
| @original_title = @page.pretty_title | ||||
| if request.post? && @page.update_attributes(params[:wiki_page]) | ||||
| flash[:notice] = l(:notice_successful_update) | ||||
|
Eric Davis
|
r4182 | redirect_to :action => 'show', :project_id => @project, :id => @page.title | ||
|
Jean-Philippe Lang
|
r709 | end | ||
| end | ||||
|
Jean-Philippe Lang
|
r1400 | def protect | ||
|
Jean-Philippe Lang
|
r2143 | @page.update_attribute :protected, params[:protected] | ||
|
Eric Davis
|
r4182 | redirect_to :action => 'show', :project_id => @project, :id => @page.title | ||
|
Jean-Philippe Lang
|
r1400 | end | ||
|
Jean-Philippe Lang
|
r320 | # show page history | ||
| def history | ||||
|
Jean-Philippe Lang
|
r568 | @version_count = @page.content.versions.count | ||
|
Jean-Philippe Lang
|
r1013 | @version_pages = Paginator.new self, @version_count, per_page_option, params['p'] | ||
|
Jean-Philippe Lang
|
r568 | # don't load text | ||
|
Jean-Philippe Lang
|
r320 | @versions = @page.content.versions.find :all, | ||
|
Jean-Philippe Lang
|
r476 | :select => "id, author_id, comments, updated_on, version", | ||
|
Jean-Philippe Lang
|
r568 | :order => 'version DESC', | ||
|
Jean-Philippe Lang
|
r580 | :limit => @version_pages.items_per_page + 1, | ||
|
Jean-Philippe Lang
|
r568 | :offset => @version_pages.current.offset | ||
| render :layout => false if request.xhr? | ||||
|
Jean-Philippe Lang
|
r320 | end | ||
|
Jean-Philippe Lang
|
r537 | |||
|
Jean-Philippe Lang
|
r580 | def diff | ||
| @diff = @page.diff(params[:version], params[:version_from]) | ||||
| render_404 unless @diff | ||||
| end | ||||
|
Jean-Philippe Lang
|
r1007 | def annotate | ||
| @annotate = @page.annotate(params[:version]) | ||||
|
Jean-Philippe Lang
|
r2143 | render_404 unless @annotate | ||
|
Jean-Philippe Lang
|
r1007 | end | ||
|
Eric Davis
|
r4181 | |||
| verify :method => :delete, :only => [:destroy], :redirect_to => { :action => :show } | ||||
|
Jean-Philippe Lang
|
r2584 | # Removes a wiki page and its history | ||
| # Children can be either set as root pages, removed or reassigned to another parent page | ||||
|
Jean-Philippe Lang
|
r537 | def destroy | ||
|
Jean-Philippe Lang
|
r2143 | return render_403 unless editable? | ||
|
Jean-Philippe Lang
|
r2584 | |||
| @descendants_count = @page.descendants.size | ||||
| if @descendants_count > 0 | ||||
| case params[:todo] | ||||
| when 'nullify' | ||||
| # Nothing to do | ||||
| when 'destroy' | ||||
| # Removes all its descendants | ||||
| @page.descendants.each(&:destroy) | ||||
| when 'reassign' | ||||
| # Reassign children to another parent page | ||||
| reassign_to = @wiki.pages.find_by_id(params[:reassign_to_id].to_i) | ||||
| return unless reassign_to | ||||
| @page.children.each do |child| | ||||
| child.update_attribute(:parent, reassign_to) | ||||
| end | ||||
| else | ||||
| @reassignable_to = @wiki.pages - @page.self_and_descendants | ||||
| return | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r2143 | @page.destroy | ||
|
Eric Davis
|
r4176 | redirect_to :action => 'index', :project_id => @project | ||
|
Jean-Philippe Lang
|
r537 | end | ||
|
Jean-Philippe Lang
|
r320 | |||
|
Eric Davis
|
r4137 | # Export wiki to a single html file | ||
| def export | ||||
| if User.current.allowed_to?(:export_wiki_pages, @project) | ||||
| @pages = @wiki.pages.find :all, :order => 'title' | ||||
| export = render_to_string :action => 'export_multiple', :layout => false | ||||
| send_data(export, :type => 'text/html', :filename => "wiki.html") | ||||
| else | ||||
|
Eric Davis
|
r4182 | redirect_to :action => 'show', :project_id => @project, :id => nil | ||
|
Eric Davis
|
r4137 | end | ||
| end | ||||
|
Eric Davis
|
r4139 | |||
|
Eric Davis
|
r4147 | def date_index | ||
| load_pages_grouped_by_date_without_content | ||||
| end | ||||
|
Jean-Philippe Lang
|
r320 | |||
| def preview | ||||
|
Eric Davis
|
r4182 | page = @wiki.find_page(params[:id]) | ||
|
Jean-Philippe Lang
|
r1431 | # page is nil when previewing a new page | ||
| return render_403 unless page.nil? || editable?(page) | ||||
|
Jean-Philippe Lang
|
r1690 | if page | ||
| @attachements = page.attachments | ||||
| @previewed = page.content | ||||
| end | ||||
|
Jean-Philippe Lang
|
r320 | @text = params[:content][:text] | ||
|
Jean-Philippe Lang
|
r801 | render :partial => 'common/preview' | ||
|
Jean-Philippe Lang
|
r320 | end | ||
|
Jean-Philippe Lang
|
r538 | def add_attachment | ||
|
Jean-Philippe Lang
|
r1400 | return render_403 unless editable? | ||
|
Eric Davis
|
r3409 | attachments = Attachment.attach_files(@page, params[:attachments]) | ||
|
Eric Davis
|
r3414 | render_attachment_warning_if_needed(@page) | ||
|
Eric Davis
|
r4189 | redirect_to :action => 'show', :id => @page.title, :project_id => @project | ||
|
Jean-Philippe Lang
|
r538 | end | ||
|
Jean-Philippe Lang
|
r320 | private | ||
| def find_wiki | ||||
|
Eric Davis
|
r4151 | @project = Project.find(params[:project_id]) | ||
|
Jean-Philippe Lang
|
r320 | @wiki = @project.wiki | ||
|
Jean-Philippe Lang
|
r561 | render_404 unless @wiki | ||
|
Jean-Philippe Lang
|
r320 | rescue ActiveRecord::RecordNotFound | ||
| render_404 | ||||
| end | ||||
|
Jean-Philippe Lang
|
r1400 | |||
|
Jean-Philippe Lang
|
r2143 | # Finds the requested page and returns a 404 error if it doesn't exist | ||
| def find_existing_page | ||||
|
Eric Davis
|
r4182 | @page = @wiki.find_page(params[:id]) | ||
|
Jean-Philippe Lang
|
r2143 | render_404 if @page.nil? | ||
| end | ||||
|
Jean-Philippe Lang
|
r1400 | # Returns true if the current user is allowed to edit the page, otherwise false | ||
| def editable?(page = @page) | ||||
| page.editable_by?(User.current) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r1953 | |||
| # Returns the default content of a new wiki page | ||||
| def initial_page_content(page) | ||||
| helper = Redmine::WikiFormatting.helper_for(Setting.text_formatting) | ||||
| extend helper unless self.instance_of?(helper) | ||||
| helper.instance_method(:initial_page_content).bind(self).call(page) | ||||
| end | ||||
|
Eric Davis
|
r4138 | |||
| # eager load information about last updates, without loading text | ||||
| def load_pages_grouped_by_date_without_content | ||||
| @pages = @wiki.pages.find :all, :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", | ||||
| :order => 'title' | ||||
| @pages_by_date = @pages.group_by {|p| p.updated_on.to_date} | ||||
| @pages_by_parent_id = @pages.group_by(&:parent_id) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r320 | end | ||