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