annotate .svn/pristine/e4/e47c28874d93e63d4ec1ec20c05fe818fb5867d7.svn-base @ 1327:287f201c2802 redmine-2.2-integration

Add italic
author Chris Cannam <chris.cannam@soundsoftware.ac.uk>
date Wed, 19 Jun 2013 20:56:22 +0100
parents cbb26bc654de
children
rev   line source
Chris@909 1 # Redmine - project management software
Chris@909 2 # Copyright (C) 2006-2011 Jean-Philippe Lang
Chris@909 3 #
Chris@909 4 # This program is free software; you can redistribute it and/or
Chris@909 5 # modify it under the terms of the GNU General Public License
Chris@909 6 # as published by the Free Software Foundation; either version 2
Chris@909 7 # of the License, or (at your option) any later version.
Chris@909 8 #
Chris@909 9 # This program is distributed in the hope that it will be useful,
Chris@909 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@909 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Chris@909 12 # GNU General Public License for more details.
Chris@909 13 #
Chris@909 14 # You should have received a copy of the GNU General Public License
Chris@909 15 # along with this program; if not, write to the Free Software
Chris@909 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Chris@909 17
Chris@909 18 require 'diff'
Chris@909 19
Chris@909 20 # The WikiController follows the Rails REST controller pattern but with
Chris@909 21 # a few differences
Chris@909 22 #
Chris@909 23 # * index - shows a list of WikiPages grouped by page or date
Chris@909 24 # * new - not used
Chris@909 25 # * create - not used
Chris@909 26 # * show - will also show the form for creating a new wiki page
Chris@909 27 # * edit - used to edit an existing or new page
Chris@909 28 # * update - used to save a wiki page update to the database, including new pages
Chris@909 29 # * destroy - normal
Chris@909 30 #
Chris@909 31 # Other member and collection methods are also used
Chris@909 32 #
Chris@909 33 # TODO: still being worked on
Chris@909 34 class WikiController < ApplicationController
Chris@909 35 default_search_scope :wiki_pages
Chris@909 36 before_filter :find_wiki, :authorize
Chris@909 37 before_filter :find_existing_or_new_page, :only => [:show, :edit, :update]
Chris@909 38 before_filter :find_existing_page, :only => [:rename, :protect, :history, :diff, :annotate, :add_attachment, :destroy]
Chris@909 39
Chris@909 40 helper :attachments
Chris@909 41 include AttachmentsHelper
Chris@909 42 helper :watchers
Chris@909 43 include Redmine::Export::PDF
Chris@909 44
Chris@909 45 # List of pages, sorted alphabetically and by parent (hierarchy)
Chris@909 46 def index
Chris@909 47 load_pages_for_index
Chris@909 48 @pages_by_parent_id = @pages.group_by(&:parent_id)
Chris@909 49 end
Chris@909 50
Chris@909 51 # List of page, by last update
Chris@909 52 def date_index
Chris@909 53 load_pages_for_index
Chris@909 54 @pages_by_date = @pages.group_by {|p| p.updated_on.to_date}
Chris@909 55 end
Chris@909 56
Chris@909 57 # display a page (in editing mode if it doesn't exist)
Chris@909 58 def show
Chris@909 59 if @page.new_record?
Chris@909 60 if User.current.allowed_to?(:edit_wiki_pages, @project) && editable?
Chris@909 61 edit
Chris@909 62 render :action => 'edit'
Chris@909 63 else
Chris@909 64 render_404
Chris@909 65 end
Chris@909 66 return
Chris@909 67 end
Chris@909 68 if params[:version] && !User.current.allowed_to?(:view_wiki_edits, @project)
Chris@909 69 # Redirects user to the current version if he's not allowed to view previous versions
Chris@909 70 redirect_to :version => nil
Chris@909 71 return
Chris@909 72 end
Chris@909 73 @content = @page.content_for_version(params[:version])
Chris@909 74 if User.current.allowed_to?(:export_wiki_pages, @project)
Chris@909 75 if params[:format] == 'pdf'
Chris@909 76 send_data(wiki_to_pdf(@page, @project), :type => 'application/pdf', :filename => "#{@page.title}.pdf")
Chris@909 77 return
Chris@909 78 elsif params[:format] == 'html'
Chris@909 79 export = render_to_string :action => 'export', :layout => false
Chris@909 80 send_data(export, :type => 'text/html', :filename => "#{@page.title}.html")
Chris@909 81 return
Chris@909 82 elsif params[:format] == 'txt'
Chris@909 83 send_data(@content.text, :type => 'text/plain', :filename => "#{@page.title}.txt")
Chris@909 84 return
Chris@909 85 end
Chris@909 86 end
Chris@909 87 @editable = editable?
Chris@909 88 @sections_editable = @editable && User.current.allowed_to?(:edit_wiki_pages, @page.project) &&
Chris@909 89 @content.current_version? &&
Chris@909 90 Redmine::WikiFormatting.supports_section_edit?
Chris@909 91
Chris@909 92 render :action => 'show'
Chris@909 93 end
Chris@909 94
Chris@909 95 # edit an existing page or a new one
Chris@909 96 def edit
Chris@909 97 return render_403 unless editable?
Chris@909 98 @page.content = WikiContent.new(:page => @page) if @page.new_record?
Chris@909 99
Chris@909 100 @content = @page.content_for_version(params[:version])
Chris@909 101 @content.text = initial_page_content(@page) if @content.text.blank?
Chris@909 102 # don't keep previous comment
Chris@909 103 @content.comments = nil
Chris@909 104
Chris@909 105 # To prevent StaleObjectError exception when reverting to a previous version
Chris@909 106 @content.version = @page.content.version
Chris@909 107
Chris@909 108 @text = @content.text
Chris@909 109 if params[:section].present? && Redmine::WikiFormatting.supports_section_edit?
Chris@909 110 @section = params[:section].to_i
Chris@909 111 @text, @section_hash = Redmine::WikiFormatting.formatter.new(@text).get_section(@section)
Chris@909 112 render_404 if @text.blank?
Chris@909 113 end
Chris@909 114 end
Chris@909 115
Chris@909 116 verify :method => :put, :only => :update, :render => {:nothing => true, :status => :method_not_allowed }
Chris@909 117 # Creates a new page or updates an existing one
Chris@909 118 def update
Chris@909 119 return render_403 unless editable?
Chris@909 120 @page.content = WikiContent.new(:page => @page) if @page.new_record?
Chris@909 121
Chris@909 122 @content = @page.content_for_version(params[:version])
Chris@909 123 @content.text = initial_page_content(@page) if @content.text.blank?
Chris@909 124 # don't keep previous comment
Chris@909 125 @content.comments = nil
Chris@909 126
Chris@909 127 if !@page.new_record? && params[:content].present? && @content.text == params[:content][:text]
Chris@909 128 attachments = Attachment.attach_files(@page, params[:attachments])
Chris@909 129 render_attachment_warning_if_needed(@page)
Chris@909 130 # don't save if text wasn't changed
Chris@909 131 redirect_to :action => 'show', :project_id => @project, :id => @page.title
Chris@909 132 return
Chris@909 133 end
Chris@909 134
Chris@909 135 @content.comments = params[:content][:comments]
Chris@909 136 @text = params[:content][:text]
Chris@909 137 if params[:section].present? && Redmine::WikiFormatting.supports_section_edit?
Chris@909 138 @section = params[:section].to_i
Chris@909 139 @section_hash = params[:section_hash]
Chris@909 140 @content.text = Redmine::WikiFormatting.formatter.new(@content.text).update_section(params[:section].to_i, @text, @section_hash)
Chris@909 141 else
Chris@909 142 @content.version = params[:content][:version]
Chris@909 143 @content.text = @text
Chris@909 144 end
Chris@909 145 @content.author = User.current
Chris@909 146 # if page is new @page.save will also save content, but not if page isn't a new record
Chris@909 147 if (@page.new_record? ? @page.save : @content.save)
Chris@909 148 attachments = Attachment.attach_files(@page, params[:attachments])
Chris@909 149 render_attachment_warning_if_needed(@page)
Chris@909 150 call_hook(:controller_wiki_edit_after_save, { :params => params, :page => @page})
Chris@909 151 redirect_to :action => 'show', :project_id => @project, :id => @page.title
Chris@909 152 else
Chris@909 153 render :action => 'edit'
Chris@909 154 end
Chris@909 155
Chris@909 156 rescue ActiveRecord::StaleObjectError, Redmine::WikiFormatting::StaleSectionError
Chris@909 157 # Optimistic locking exception
Chris@909 158 flash.now[:error] = l(:notice_locking_conflict)
Chris@909 159 render :action => 'edit'
Chris@909 160 end
Chris@909 161
Chris@909 162 # rename a page
Chris@909 163 def rename
Chris@909 164 return render_403 unless editable?
Chris@909 165 @page.redirect_existing_links = true
Chris@909 166 # used to display the *original* title if some AR validation errors occur
Chris@909 167 @original_title = @page.pretty_title
Chris@909 168 if request.post? && @page.update_attributes(params[:wiki_page])
Chris@909 169 flash[:notice] = l(:notice_successful_update)
Chris@909 170 redirect_to :action => 'show', :project_id => @project, :id => @page.title
Chris@909 171 end
Chris@909 172 end
Chris@909 173
Chris@909 174 verify :method => :post, :only => :protect, :redirect_to => { :action => :show }
Chris@909 175 def protect
Chris@909 176 @page.update_attribute :protected, params[:protected]
Chris@909 177 redirect_to :action => 'show', :project_id => @project, :id => @page.title
Chris@909 178 end
Chris@909 179
Chris@909 180 # show page history
Chris@909 181 def history
Chris@909 182 @version_count = @page.content.versions.count
Chris@909 183 @version_pages = Paginator.new self, @version_count, per_page_option, params['p']
Chris@909 184 # don't load text
Chris@909 185 @versions = @page.content.versions.find :all,
Chris@909 186 :select => "id, author_id, comments, updated_on, version",
Chris@909 187 :order => 'version DESC',
Chris@909 188 :limit => @version_pages.items_per_page + 1,
Chris@909 189 :offset => @version_pages.current.offset
Chris@909 190
Chris@909 191 render :layout => false if request.xhr?
Chris@909 192 end
Chris@909 193
Chris@909 194 def diff
Chris@909 195 @diff = @page.diff(params[:version], params[:version_from])
Chris@909 196 render_404 unless @diff
Chris@909 197 end
Chris@909 198
Chris@909 199 def annotate
Chris@909 200 @annotate = @page.annotate(params[:version])
Chris@909 201 render_404 unless @annotate
Chris@909 202 end
Chris@909 203
Chris@909 204 verify :method => :delete, :only => [:destroy], :redirect_to => { :action => :show }
Chris@909 205 # Removes a wiki page and its history
Chris@909 206 # Children can be either set as root pages, removed or reassigned to another parent page
Chris@909 207 def destroy
Chris@909 208 return render_403 unless editable?
Chris@909 209
Chris@909 210 @descendants_count = @page.descendants.size
Chris@909 211 if @descendants_count > 0
Chris@909 212 case params[:todo]
Chris@909 213 when 'nullify'
Chris@909 214 # Nothing to do
Chris@909 215 when 'destroy'
Chris@909 216 # Removes all its descendants
Chris@909 217 @page.descendants.each(&:destroy)
Chris@909 218 when 'reassign'
Chris@909 219 # Reassign children to another parent page
Chris@909 220 reassign_to = @wiki.pages.find_by_id(params[:reassign_to_id].to_i)
Chris@909 221 return unless reassign_to
Chris@909 222 @page.children.each do |child|
Chris@909 223 child.update_attribute(:parent, reassign_to)
Chris@909 224 end
Chris@909 225 else
Chris@909 226 @reassignable_to = @wiki.pages - @page.self_and_descendants
Chris@909 227 return
Chris@909 228 end
Chris@909 229 end
Chris@909 230 @page.destroy
Chris@909 231 redirect_to :action => 'index', :project_id => @project
Chris@909 232 end
Chris@909 233
Chris@909 234 # Export wiki to a single html file
Chris@909 235 def export
Chris@909 236 if User.current.allowed_to?(:export_wiki_pages, @project)
Chris@909 237 @pages = @wiki.pages.find :all, :order => 'title'
Chris@909 238 export = render_to_string :action => 'export_multiple', :layout => false
Chris@909 239 send_data(export, :type => 'text/html', :filename => "wiki.html")
Chris@909 240 else
Chris@909 241 redirect_to :action => 'show', :project_id => @project, :id => nil
Chris@909 242 end
Chris@909 243 end
Chris@909 244
Chris@909 245 def preview
Chris@909 246 page = @wiki.find_page(params[:id])
Chris@909 247 # page is nil when previewing a new page
Chris@909 248 return render_403 unless page.nil? || editable?(page)
Chris@909 249 if page
Chris@909 250 @attachements = page.attachments
Chris@909 251 @previewed = page.content
Chris@909 252 end
Chris@909 253 @text = params[:content][:text]
Chris@909 254 render :partial => 'common/preview'
Chris@909 255 end
Chris@909 256
Chris@909 257 def add_attachment
Chris@909 258 return render_403 unless editable?
Chris@909 259 attachments = Attachment.attach_files(@page, params[:attachments])
Chris@909 260 render_attachment_warning_if_needed(@page)
Chris@909 261 redirect_to :action => 'show', :id => @page.title, :project_id => @project
Chris@909 262 end
Chris@909 263
Chris@909 264 private
Chris@909 265
Chris@909 266 def find_wiki
Chris@909 267 @project = Project.find(params[:project_id])
Chris@909 268 @wiki = @project.wiki
Chris@909 269 render_404 unless @wiki
Chris@909 270 rescue ActiveRecord::RecordNotFound
Chris@909 271 render_404
Chris@909 272 end
Chris@909 273
Chris@909 274 # Finds the requested page or a new page if it doesn't exist
Chris@909 275 def find_existing_or_new_page
Chris@909 276 @page = @wiki.find_or_new_page(params[:id])
Chris@909 277 if @wiki.page_found_with_redirect?
Chris@909 278 redirect_to params.update(:id => @page.title)
Chris@909 279 end
Chris@909 280 end
Chris@909 281
Chris@909 282 # Finds the requested page and returns a 404 error if it doesn't exist
Chris@909 283 def find_existing_page
Chris@909 284 @page = @wiki.find_page(params[:id])
Chris@909 285 if @page.nil?
Chris@909 286 render_404
Chris@909 287 return
Chris@909 288 end
Chris@909 289 if @wiki.page_found_with_redirect?
Chris@909 290 redirect_to params.update(:id => @page.title)
Chris@909 291 end
Chris@909 292 end
Chris@909 293
Chris@909 294 # Returns true if the current user is allowed to edit the page, otherwise false
Chris@909 295 def editable?(page = @page)
Chris@909 296 page.editable_by?(User.current)
Chris@909 297 end
Chris@909 298
Chris@909 299 # Returns the default content of a new wiki page
Chris@909 300 def initial_page_content(page)
Chris@909 301 helper = Redmine::WikiFormatting.helper_for(Setting.text_formatting)
Chris@909 302 extend helper unless self.instance_of?(helper)
Chris@909 303 helper.instance_method(:initial_page_content).bind(self).call(page)
Chris@909 304 end
Chris@909 305
Chris@909 306 def load_pages_for_index
Chris@909 307 @pages = @wiki.pages.with_updated_on.all(:order => 'title', :include => {:wiki => :project})
Chris@909 308 end
Chris@909 309 end