annotate app/controllers/wiki_controller.rb @ 1600:ed9c467ef922 dockerise

Add hggit extension
author Chris Cannam
date Wed, 23 Aug 2017 11:32:50 +0100
parents dffacf8a6908
children
rev   line source
Chris@441 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@441 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@441 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@37 18 # The WikiController follows the Rails REST controller pattern but with
chris@37 19 # a few differences
chris@37 20 #
chris@37 21 # * index - shows a list of WikiPages grouped by page or date
chris@37 22 # * new - not used
chris@37 23 # * create - not used
chris@37 24 # * show - will also show the form for creating a new wiki page
chris@37 25 # * edit - used to edit an existing or new page
chris@37 26 # * update - used to save a wiki page update to the database, including new pages
chris@37 27 # * destroy - normal
chris@37 28 #
chris@37 29 # Other member and collection methods are also used
chris@37 30 #
chris@37 31 # TODO: still being worked on
Chris@0 32 class WikiController < ApplicationController
Chris@0 33 default_search_scope :wiki_pages
Chris@0 34 before_filter :find_wiki, :authorize
Chris@441 35 before_filter :find_existing_or_new_page, :only => [:show, :edit, :update]
Chris@1115 36 before_filter :find_existing_page, :only => [:rename, :protect, :history, :diff, :annotate, :add_attachment, :destroy, :destroy_version]
Chris@1115 37 accept_api_auth :index, :show, :update, :destroy
Chris@1464 38 before_filter :find_attachments, :only => [:preview]
Chris@0 39
Chris@0 40 helper :attachments
Chris@441 41 include AttachmentsHelper
Chris@0 42 helper :watchers
Chris@909 43 include Redmine::Export::PDF
chris@37 44
chris@37 45 # List of pages, sorted alphabetically and by parent (hierarchy)
chris@37 46 def index
Chris@441 47 load_pages_for_index
Chris@1115 48
Chris@1115 49 respond_to do |format|
Chris@1115 50 format.html {
Chris@1115 51 @pages_by_parent_id = @pages.group_by(&:parent_id)
Chris@1115 52 }
Chris@1115 53 format.api
Chris@1115 54 end
Chris@441 55 end
Chris@441 56
Chris@441 57 # List of page, by last update
Chris@441 58 def date_index
Chris@441 59 load_pages_for_index
Chris@441 60 @pages_by_date = @pages.group_by {|p| p.updated_on.to_date}
chris@37 61 end
chris@37 62
Chris@0 63 # display a page (in editing mode if it doesn't exist)
chris@37 64 def show
Chris@1464 65 if params[:version] && !User.current.allowed_to?(:view_wiki_edits, @project)
Chris@1464 66 deny_access
Chris@1464 67 return
Chris@1464 68 end
Chris@1464 69 @content = @page.content_for_version(params[:version])
Chris@1464 70 if @content.nil?
Chris@1115 71 if User.current.allowed_to?(:edit_wiki_pages, @project) && editable? && !api_request?
Chris@0 72 edit
Chris@0 73 render :action => 'edit'
Chris@0 74 else
Chris@0 75 render_404
Chris@0 76 end
Chris@0 77 return
Chris@0 78 end
Chris@0 79 if User.current.allowed_to?(:export_wiki_pages, @project)
Chris@909 80 if params[:format] == 'pdf'
Chris@1115 81 send_data(wiki_page_to_pdf(@page, @project), :type => 'application/pdf', :filename => "#{@page.title}.pdf")
Chris@909 82 return
Chris@909 83 elsif params[:format] == 'html'
Chris@0 84 export = render_to_string :action => 'export', :layout => false
Chris@0 85 send_data(export, :type => 'text/html', :filename => "#{@page.title}.html")
Chris@0 86 return
Chris@0 87 elsif params[:format] == 'txt'
Chris@0 88 send_data(@content.text, :type => 'text/plain', :filename => "#{@page.title}.txt")
Chris@0 89 return
Chris@0 90 end
Chris@0 91 end
Chris@0 92 @editable = editable?
Chris@909 93 @sections_editable = @editable && User.current.allowed_to?(:edit_wiki_pages, @page.project) &&
Chris@909 94 @content.current_version? &&
Chris@909 95 Redmine::WikiFormatting.supports_section_edit?
Chris@909 96
Chris@1115 97 respond_to do |format|
Chris@1115 98 format.html
Chris@1115 99 format.api
Chris@1115 100 end
Chris@0 101 end
Chris@441 102
Chris@0 103 # edit an existing page or a new one
Chris@0 104 def edit
Chris@0 105 return render_403 unless editable?
Chris@1115 106 if @page.new_record?
Chris@1115 107 if params[:parent].present?
Chris@1115 108 @page.parent = @page.wiki.find_page(params[:parent].to_s)
Chris@1115 109 end
Chris@1115 110 end
Chris@441 111
Chris@0 112 @content = @page.content_for_version(params[:version])
Chris@1464 113 @content ||= WikiContent.new(:page => @page)
Chris@0 114 @content.text = initial_page_content(@page) if @content.text.blank?
Chris@0 115 # don't keep previous comment
Chris@0 116 @content.comments = nil
chris@37 117
chris@37 118 # To prevent StaleObjectError exception when reverting to a previous version
Chris@1464 119 @content.version = @page.content.version if @page.content
Chris@1115 120
Chris@909 121 @text = @content.text
Chris@909 122 if params[:section].present? && Redmine::WikiFormatting.supports_section_edit?
Chris@909 123 @section = params[:section].to_i
Chris@909 124 @text, @section_hash = Redmine::WikiFormatting.formatter.new(@text).get_section(@section)
Chris@909 125 render_404 if @text.blank?
Chris@909 126 end
Chris@0 127 end
chris@37 128
chris@37 129 # Creates a new page or updates an existing one
chris@37 130 def update
chris@37 131 return render_403 unless editable?
Chris@1115 132 was_new_page = @page.new_record?
Chris@1115 133 @page.safe_attributes = params[:wiki_page]
Chris@441 134
Chris@1464 135 @content = @page.content || WikiContent.new(:page => @page)
Chris@1115 136 content_params = params[:content]
Chris@1115 137 if content_params.nil? && params[:wiki_page].is_a?(Hash)
Chris@1115 138 content_params = params[:wiki_page].slice(:text, :comments, :version)
Chris@1115 139 end
Chris@1115 140 content_params ||= {}
chris@37 141
Chris@1115 142 @content.comments = content_params[:comments]
Chris@1115 143 @text = content_params[:text]
Chris@909 144 if params[:section].present? && Redmine::WikiFormatting.supports_section_edit?
Chris@909 145 @section = params[:section].to_i
Chris@909 146 @section_hash = params[:section_hash]
Chris@1464 147 @content.text = Redmine::WikiFormatting.formatter.new(@content.text).update_section(@section, @text, @section_hash)
Chris@909 148 else
Chris@1115 149 @content.version = content_params[:version] if content_params[:version]
Chris@909 150 @content.text = @text
Chris@909 151 end
chris@37 152 @content.author = User.current
Chris@1115 153
Chris@1464 154 if @page.save_with_content(@content)
chris@37 155 attachments = Attachment.attach_files(@page, params[:attachments])
chris@37 156 render_attachment_warning_if_needed(@page)
chris@37 157 call_hook(:controller_wiki_edit_after_save, { :params => params, :page => @page})
Chris@1115 158
Chris@1115 159 respond_to do |format|
Chris@1464 160 format.html {
Chris@1464 161 anchor = @section ? "section-#{@section}" : nil
Chris@1464 162 redirect_to project_wiki_page_path(@project, @page.title, :anchor => anchor)
Chris@1464 163 }
Chris@1115 164 format.api {
Chris@1115 165 if was_new_page
Chris@1464 166 render :action => 'show', :status => :created, :location => project_wiki_page_path(@project, @page.title)
Chris@1115 167 else
Chris@1115 168 render_api_ok
Chris@1115 169 end
Chris@1115 170 }
Chris@1115 171 end
Chris@119 172 else
Chris@1115 173 respond_to do |format|
Chris@1115 174 format.html { render :action => 'edit' }
Chris@1115 175 format.api { render_validation_errors(@content) }
Chris@1115 176 end
chris@37 177 end
chris@37 178
Chris@909 179 rescue ActiveRecord::StaleObjectError, Redmine::WikiFormatting::StaleSectionError
chris@37 180 # Optimistic locking exception
Chris@1115 181 respond_to do |format|
Chris@1115 182 format.html {
Chris@1115 183 flash.now[:error] = l(:notice_locking_conflict)
Chris@1115 184 render :action => 'edit'
Chris@1115 185 }
Chris@1115 186 format.api { render_api_head :conflict }
Chris@1115 187 end
Chris@1115 188 rescue ActiveRecord::RecordNotSaved
Chris@1115 189 respond_to do |format|
Chris@1115 190 format.html { render :action => 'edit' }
Chris@1115 191 format.api { render_validation_errors(@content) }
Chris@1115 192 end
chris@37 193 end
chris@37 194
Chris@0 195 # rename a page
Chris@0 196 def rename
Chris@0 197 return render_403 unless editable?
Chris@0 198 @page.redirect_existing_links = true
Chris@0 199 # used to display the *original* title if some AR validation errors occur
Chris@0 200 @original_title = @page.pretty_title
Chris@0 201 if request.post? && @page.update_attributes(params[:wiki_page])
Chris@0 202 flash[:notice] = l(:notice_successful_update)
Chris@1464 203 redirect_to project_wiki_page_path(@project, @page.title)
Chris@0 204 end
Chris@0 205 end
Chris@441 206
Chris@0 207 def protect
Chris@0 208 @page.update_attribute :protected, params[:protected]
Chris@1464 209 redirect_to project_wiki_page_path(@project, @page.title)
Chris@0 210 end
Chris@0 211
Chris@0 212 # show page history
Chris@0 213 def history
Chris@0 214 @version_count = @page.content.versions.count
Chris@1464 215 @version_pages = Paginator.new @version_count, per_page_option, params['page']
Chris@441 216 # don't load text
Chris@1464 217 @versions = @page.content.versions.
Chris@1464 218 select("id, author_id, comments, updated_on, version").
Chris@1464 219 reorder('version DESC').
Chris@1464 220 limit(@version_pages.per_page + 1).
Chris@1464 221 offset(@version_pages.offset).
Chris@1464 222 all
Chris@0 223
Chris@0 224 render :layout => false if request.xhr?
Chris@0 225 end
Chris@441 226
Chris@0 227 def diff
Chris@0 228 @diff = @page.diff(params[:version], params[:version_from])
Chris@0 229 render_404 unless @diff
Chris@0 230 end
Chris@441 231
Chris@0 232 def annotate
Chris@0 233 @annotate = @page.annotate(params[:version])
Chris@0 234 render_404 unless @annotate
Chris@0 235 end
chris@37 236
Chris@0 237 # Removes a wiki page and its history
Chris@0 238 # Children can be either set as root pages, removed or reassigned to another parent page
Chris@0 239 def destroy
Chris@0 240 return render_403 unless editable?
Chris@441 241
Chris@0 242 @descendants_count = @page.descendants.size
Chris@0 243 if @descendants_count > 0
Chris@0 244 case params[:todo]
Chris@0 245 when 'nullify'
Chris@0 246 # Nothing to do
Chris@0 247 when 'destroy'
Chris@0 248 # Removes all its descendants
Chris@0 249 @page.descendants.each(&:destroy)
Chris@0 250 when 'reassign'
Chris@0 251 # Reassign children to another parent page
Chris@0 252 reassign_to = @wiki.pages.find_by_id(params[:reassign_to_id].to_i)
Chris@0 253 return unless reassign_to
Chris@0 254 @page.children.each do |child|
Chris@0 255 child.update_attribute(:parent, reassign_to)
Chris@0 256 end
Chris@0 257 else
Chris@0 258 @reassignable_to = @wiki.pages - @page.self_and_descendants
Chris@1115 259 # display the destroy form if it's a user request
Chris@1115 260 return unless api_request?
Chris@0 261 end
Chris@0 262 end
Chris@0 263 @page.destroy
Chris@1115 264 respond_to do |format|
Chris@1464 265 format.html { redirect_to project_wiki_index_path(@project) }
Chris@1115 266 format.api { render_api_ok }
Chris@1115 267 end
Chris@0 268 end
Chris@0 269
Chris@1115 270 def destroy_version
Chris@1115 271 return render_403 unless editable?
Chris@1115 272
Chris@1115 273 @content = @page.content_for_version(params[:version])
Chris@1115 274 @content.destroy
Chris@1464 275 redirect_to_referer_or history_project_wiki_page_path(@project, @page.title)
Chris@1115 276 end
Chris@1115 277
Chris@1115 278 # Export wiki to a single pdf or html file
chris@37 279 def export
Chris@1517 280 @pages = @wiki.pages.
Chris@1517 281 order('title').
Chris@1517 282 includes([:content, {:attachments => :author}]).
Chris@1517 283 all
Chris@1115 284 respond_to do |format|
Chris@1115 285 format.html {
Chris@1115 286 export = render_to_string :action => 'export_multiple', :layout => false
Chris@1115 287 send_data(export, :type => 'text/html', :filename => "wiki.html")
Chris@1115 288 }
Chris@1115 289 format.pdf {
Chris@1517 290 send_data(wiki_pages_to_pdf(@pages, @project),
Chris@1517 291 :type => 'application/pdf',
Chris@1517 292 :filename => "#{@project.identifier}.pdf")
Chris@1115 293 }
Chris@0 294 end
chris@37 295 end
chris@37 296
Chris@0 297 def preview
chris@37 298 page = @wiki.find_page(params[:id])
Chris@0 299 # page is nil when previewing a new page
Chris@0 300 return render_403 unless page.nil? || editable?(page)
Chris@0 301 if page
Chris@1464 302 @attachments += page.attachments
Chris@0 303 @previewed = page.content
Chris@0 304 end
Chris@0 305 @text = params[:content][:text]
Chris@0 306 render :partial => 'common/preview'
Chris@0 307 end
Chris@0 308
Chris@0 309 def add_attachment
Chris@0 310 return render_403 unless editable?
Chris@0 311 attachments = Attachment.attach_files(@page, params[:attachments])
Chris@0 312 render_attachment_warning_if_needed(@page)
chris@37 313 redirect_to :action => 'show', :id => @page.title, :project_id => @project
Chris@0 314 end
Chris@0 315
Chris@0 316 private
Chris@441 317
Chris@0 318 def find_wiki
chris@37 319 @project = Project.find(params[:project_id])
Chris@0 320 @wiki = @project.wiki
Chris@0 321 render_404 unless @wiki
Chris@0 322 rescue ActiveRecord::RecordNotFound
Chris@0 323 render_404
Chris@0 324 end
Chris@441 325
Chris@441 326 # Finds the requested page or a new page if it doesn't exist
Chris@441 327 def find_existing_or_new_page
Chris@441 328 @page = @wiki.find_or_new_page(params[:id])
Chris@441 329 if @wiki.page_found_with_redirect?
Chris@441 330 redirect_to params.update(:id => @page.title)
Chris@441 331 end
Chris@441 332 end
Chris@441 333
Chris@0 334 # Finds the requested page and returns a 404 error if it doesn't exist
Chris@0 335 def find_existing_page
chris@37 336 @page = @wiki.find_page(params[:id])
Chris@441 337 if @page.nil?
Chris@441 338 render_404
Chris@441 339 return
Chris@441 340 end
Chris@441 341 if @wiki.page_found_with_redirect?
Chris@441 342 redirect_to params.update(:id => @page.title)
Chris@441 343 end
Chris@0 344 end
Chris@441 345
Chris@0 346 # Returns true if the current user is allowed to edit the page, otherwise false
Chris@0 347 def editable?(page = @page)
Chris@0 348 page.editable_by?(User.current)
Chris@0 349 end
Chris@0 350
Chris@0 351 # Returns the default content of a new wiki page
Chris@0 352 def initial_page_content(page)
Chris@0 353 helper = Redmine::WikiFormatting.helper_for(Setting.text_formatting)
Chris@0 354 extend helper unless self.instance_of?(helper)
Chris@0 355 helper.instance_method(:initial_page_content).bind(self).call(page)
Chris@0 356 end
chris@37 357
Chris@441 358 def load_pages_for_index
Chris@1517 359 @pages = @wiki.pages.with_updated_on.
Chris@1517 360 reorder("#{WikiPage.table_name}.title").
Chris@1517 361 includes(:wiki => :project).
Chris@1517 362 includes(:parent).
Chris@1517 363 all
chris@37 364 end
Chris@0 365 end