##// END OF EJS Templates
Refactor: extract method in IssuesController#move....
Eric Davis -
r3803:e4af6e77a734
parent child
Show More
@@ -1,488 +1,492
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2008 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 class IssuesController < ApplicationController
19 19 menu_item :new_issue, :only => [:new, :create]
20 20 default_search_scope :issues
21 21
22 22 before_filter :find_issue, :only => [:show, :edit, :update, :reply]
23 23 before_filter :find_issues, :only => [:bulk_edit, :move, :destroy]
24 24 before_filter :find_project, :only => [:new, :create, :update_form, :preview, :auto_complete]
25 25 before_filter :authorize, :except => [:index, :changes, :preview, :context_menu]
26 26 before_filter :find_optional_project, :only => [:index, :changes]
27 27 before_filter :check_for_default_issue_status, :only => [:new, :create]
28 28 before_filter :build_new_issue_from_params, :only => [:new, :create]
29 29 accept_key_auth :index, :show, :changes
30 30
31 31 rescue_from Query::StatementInvalid, :with => :query_statement_invalid
32 32
33 33 helper :journals
34 34 helper :projects
35 35 include ProjectsHelper
36 36 helper :custom_fields
37 37 include CustomFieldsHelper
38 38 helper :issue_relations
39 39 include IssueRelationsHelper
40 40 helper :watchers
41 41 include WatchersHelper
42 42 helper :attachments
43 43 include AttachmentsHelper
44 44 helper :queries
45 45 include QueriesHelper
46 46 helper :sort
47 47 include SortHelper
48 48 include IssuesHelper
49 49 helper :timelog
50 50 include Redmine::Export::PDF
51 51
52 52 verify :method => [:post, :delete],
53 53 :only => :destroy,
54 54 :render => { :nothing => true, :status => :method_not_allowed }
55 55
56 56 verify :method => :post, :only => :create, :render => {:nothing => true, :status => :method_not_allowed }
57 57 verify :method => :put, :only => :update, :render => {:nothing => true, :status => :method_not_allowed }
58 58
59 59 def index
60 60 retrieve_query
61 61 sort_init(@query.sort_criteria.empty? ? [['id', 'desc']] : @query.sort_criteria)
62 62 sort_update(@query.sortable_columns)
63 63
64 64 if @query.valid?
65 65 limit = case params[:format]
66 66 when 'csv', 'pdf'
67 67 Setting.issues_export_limit.to_i
68 68 when 'atom'
69 69 Setting.feeds_limit.to_i
70 70 else
71 71 per_page_option
72 72 end
73 73
74 74 @issue_count = @query.issue_count
75 75 @issue_pages = Paginator.new self, @issue_count, limit, params['page']
76 76 @issues = @query.issues(:include => [:assigned_to, :tracker, :priority, :category, :fixed_version],
77 77 :order => sort_clause,
78 78 :offset => @issue_pages.current.offset,
79 79 :limit => limit)
80 80 @issue_count_by_group = @query.issue_count_by_group
81 81
82 82 respond_to do |format|
83 83 format.html { render :template => 'issues/index.rhtml', :layout => !request.xhr? }
84 84 format.xml { render :layout => false }
85 85 format.json { render :text => @issues.to_json, :layout => false }
86 86 format.atom { render_feed(@issues, :title => "#{@project || Setting.app_title}: #{l(:label_issue_plural)}") }
87 87 format.csv { send_data(issues_to_csv(@issues, @project), :type => 'text/csv; header=present', :filename => 'export.csv') }
88 88 format.pdf { send_data(issues_to_pdf(@issues, @project, @query), :type => 'application/pdf', :filename => 'export.pdf') }
89 89 end
90 90 else
91 91 # Send html if the query is not valid
92 92 render(:template => 'issues/index.rhtml', :layout => !request.xhr?)
93 93 end
94 94 rescue ActiveRecord::RecordNotFound
95 95 render_404
96 96 end
97 97
98 98 def changes
99 99 retrieve_query
100 100 sort_init 'id', 'desc'
101 101 sort_update(@query.sortable_columns)
102 102
103 103 if @query.valid?
104 104 @journals = @query.journals(:order => "#{Journal.table_name}.created_on DESC",
105 105 :limit => 25)
106 106 end
107 107 @title = (@project ? @project.name : Setting.app_title) + ": " + (@query.new_record? ? l(:label_changes_details) : @query.name)
108 108 render :layout => false, :content_type => 'application/atom+xml'
109 109 rescue ActiveRecord::RecordNotFound
110 110 render_404
111 111 end
112 112
113 113 def show
114 114 @journals = @issue.journals.find(:all, :include => [:user, :details], :order => "#{Journal.table_name}.created_on ASC")
115 115 @journals.each_with_index {|j,i| j.indice = i+1}
116 116 @journals.reverse! if User.current.wants_comments_in_reverse_order?
117 117 @changesets = @issue.changesets.visible.all
118 118 @changesets.reverse! if User.current.wants_comments_in_reverse_order?
119 119 @allowed_statuses = @issue.new_statuses_allowed_to(User.current)
120 120 @edit_allowed = User.current.allowed_to?(:edit_issues, @project)
121 121 @priorities = IssuePriority.all
122 122 @time_entry = TimeEntry.new
123 123 respond_to do |format|
124 124 format.html { render :template => 'issues/show.rhtml' }
125 125 format.xml { render :layout => false }
126 126 format.json { render :text => @issue.to_json, :layout => false }
127 127 format.atom { render :action => 'changes', :layout => false, :content_type => 'application/atom+xml' }
128 128 format.pdf { send_data(issue_to_pdf(@issue), :type => 'application/pdf', :filename => "#{@project.identifier}-#{@issue.id}.pdf") }
129 129 end
130 130 end
131 131
132 132 # Add a new issue
133 133 # The new issue will be created from an existing one if copy_from parameter is given
134 134 def new
135 135 render :action => 'new', :layout => !request.xhr?
136 136 end
137 137
138 138 def create
139 139 call_hook(:controller_issues_new_before_save, { :params => params, :issue => @issue })
140 140 if @issue.save
141 141 attachments = Attachment.attach_files(@issue, params[:attachments])
142 142 render_attachment_warning_if_needed(@issue)
143 143 flash[:notice] = l(:notice_successful_create)
144 144 call_hook(:controller_issues_new_after_save, { :params => params, :issue => @issue})
145 145 respond_to do |format|
146 146 format.html {
147 147 redirect_to(params[:continue] ? { :action => 'new', :issue => {:tracker_id => @issue.tracker, :parent_issue_id => @issue.parent_issue_id}.reject {|k,v| v.nil?} } :
148 148 { :action => 'show', :id => @issue })
149 149 }
150 150 format.xml { render :action => 'show', :status => :created, :location => url_for(:controller => 'issues', :action => 'show', :id => @issue) }
151 151 format.json { render :text => @issue.to_json, :status => :created, :location => url_for(:controller => 'issues', :action => 'show'), :layout => false }
152 152 end
153 153 return
154 154 else
155 155 respond_to do |format|
156 156 format.html { render :action => 'new' }
157 157 format.xml { render(:xml => @issue.errors, :status => :unprocessable_entity); return }
158 158 format.json { render :text => object_errors_to_json(@issue), :status => :unprocessable_entity, :layout => false }
159 159 end
160 160 end
161 161 end
162 162
163 163 # Attributes that can be updated on workflow transition (without :edit permission)
164 164 # TODO: make it configurable (at least per role)
165 165 UPDATABLE_ATTRS_ON_TRANSITION = %w(status_id assigned_to_id fixed_version_id done_ratio) unless const_defined?(:UPDATABLE_ATTRS_ON_TRANSITION)
166 166
167 167 def edit
168 168 update_issue_from_params
169 169
170 170 @journal = @issue.current_journal
171 171
172 172 respond_to do |format|
173 173 format.html { }
174 174 format.xml { }
175 175 end
176 176 end
177 177
178 178 def update
179 179 update_issue_from_params
180 180
181 181 if @issue.save_issue_with_child_records(params, @time_entry)
182 182 render_attachment_warning_if_needed(@issue)
183 183 flash[:notice] = l(:notice_successful_update) unless @issue.current_journal.new_record?
184 184
185 185 respond_to do |format|
186 186 format.html { redirect_back_or_default({:action => 'show', :id => @issue}) }
187 187 format.xml { head :ok }
188 188 format.json { head :ok }
189 189 end
190 190 else
191 191 render_attachment_warning_if_needed(@issue)
192 192 flash[:notice] = l(:notice_successful_update) unless @issue.current_journal.new_record?
193 193 @journal = @issue.current_journal
194 194
195 195 respond_to do |format|
196 196 format.html { render :action => 'edit' }
197 197 format.xml { render :xml => @issue.errors, :status => :unprocessable_entity }
198 198 format.json { render :text => object_errors_to_json(@issue), :status => :unprocessable_entity, :layout => false }
199 199 end
200 200 end
201 201 end
202 202
203 203 def reply
204 204 journal = Journal.find(params[:journal_id]) if params[:journal_id]
205 205 if journal
206 206 user = journal.user
207 207 text = journal.notes
208 208 else
209 209 user = @issue.author
210 210 text = @issue.description
211 211 end
212 212 # Replaces pre blocks with [...]
213 213 text = text.to_s.strip.gsub(%r{<pre>((.|\s)*?)</pre>}m, '[...]')
214 214 content = "#{ll(Setting.default_language, :text_user_wrote, user)}\n> "
215 215 content << text.gsub(/(\r?\n|\r\n?)/, "\n> ") + "\n\n"
216 216
217 217 render(:update) { |page|
218 218 page.<< "$('notes').value = \"#{escape_javascript content}\";"
219 219 page.show 'update'
220 220 page << "Form.Element.focus('notes');"
221 221 page << "Element.scrollTo('update');"
222 222 page << "$('notes').scrollTop = $('notes').scrollHeight - $('notes').clientHeight;"
223 223 }
224 224 end
225 225
226 226 # Bulk edit a set of issues
227 227 def bulk_edit
228 228 @issues.sort!
229 229 if request.post?
230 230 attributes = (params[:issue] || {}).reject {|k,v| v.blank?}
231 231 attributes.keys.each {|k| attributes[k] = '' if attributes[k] == 'none'}
232 232 attributes[:custom_field_values].reject! {|k,v| v.blank?} if attributes[:custom_field_values]
233 233
234 234 unsaved_issue_ids = []
235 235 @issues.each do |issue|
236 236 issue.reload
237 237 journal = issue.init_journal(User.current, params[:notes])
238 238 issue.safe_attributes = attributes
239 239 call_hook(:controller_issues_bulk_edit_before_save, { :params => params, :issue => issue })
240 240 unless issue.save
241 241 # Keep unsaved issue ids to display them in flash error
242 242 unsaved_issue_ids << issue.id
243 243 end
244 244 end
245 245 set_flash_from_bulk_issue_save(@issues, unsaved_issue_ids)
246 246 redirect_back_or_default({:controller => 'issues', :action => 'index', :project_id => @project})
247 247 return
248 248 end
249 249 @available_statuses = Workflow.available_statuses(@project)
250 250 @custom_fields = @project.all_issue_custom_fields
251 251 end
252 252
253 253 def move
254 254 @issues.sort!
255 255 @copy = params[:copy_options] && params[:copy_options][:copy]
256 256 @allowed_projects = Issue.allowed_target_projects_on_move
257 257 @target_project = @allowed_projects.detect {|p| p.id.to_s == params[:new_project_id]} if params[:new_project_id]
258 258 @target_project ||= @project
259 259 @trackers = @target_project.trackers
260 260 @available_statuses = Workflow.available_statuses(@project)
261 261 if request.post?
262 262 new_tracker = params[:new_tracker_id].blank? ? nil : @target_project.trackers.find_by_id(params[:new_tracker_id])
263 263 unsaved_issue_ids = []
264 264 moved_issues = []
265 265 @issues.each do |issue|
266 266 issue.reload
267 changed_attributes = {}
268 [:assigned_to_id, :status_id, :start_date, :due_date].each do |valid_attribute|
269 unless params[valid_attribute].blank?
270 changed_attributes[valid_attribute] = (params[valid_attribute] == 'none' ? nil : params[valid_attribute])
271 end
272 end
273 267 issue.init_journal(User.current)
274 268 call_hook(:controller_issues_move_before_save, { :params => params, :issue => issue, :target_project => @target_project, :copy => !!@copy })
275 if r = issue.move_to_project(@target_project, new_tracker, {:copy => @copy, :attributes => changed_attributes})
269 if r = issue.move_to_project(@target_project, new_tracker, {:copy => @copy, :attributes => extract_changed_attributes_for_move(params)})
276 270 moved_issues << r
277 271 else
278 272 unsaved_issue_ids << issue.id
279 273 end
280 274 end
281 275 set_flash_from_bulk_issue_save(@issues, unsaved_issue_ids)
282 276
283 277 if params[:follow]
284 278 if @issues.size == 1 && moved_issues.size == 1
285 279 redirect_to :controller => 'issues', :action => 'show', :id => moved_issues.first
286 280 else
287 281 redirect_to :controller => 'issues', :action => 'index', :project_id => (@target_project || @project)
288 282 end
289 283 else
290 284 redirect_to :controller => 'issues', :action => 'index', :project_id => @project
291 285 end
292 286 return
293 287 end
294 288 render :layout => false if request.xhr?
295 289 end
296 290
297 291 def destroy
298 292 @hours = TimeEntry.sum(:hours, :conditions => ['issue_id IN (?)', @issues]).to_f
299 293 if @hours > 0
300 294 case params[:todo]
301 295 when 'destroy'
302 296 # nothing to do
303 297 when 'nullify'
304 298 TimeEntry.update_all('issue_id = NULL', ['issue_id IN (?)', @issues])
305 299 when 'reassign'
306 300 reassign_to = @project.issues.find_by_id(params[:reassign_to_id])
307 301 if reassign_to.nil?
308 302 flash.now[:error] = l(:error_issue_not_found_in_project)
309 303 return
310 304 else
311 305 TimeEntry.update_all("issue_id = #{reassign_to.id}", ['issue_id IN (?)', @issues])
312 306 end
313 307 else
314 308 unless params[:format] == 'xml' || params[:format] == 'json'
315 309 # display the destroy form if it's a user request
316 310 return
317 311 end
318 312 end
319 313 end
320 314 @issues.each(&:destroy)
321 315 respond_to do |format|
322 316 format.html { redirect_to :action => 'index', :project_id => @project }
323 317 format.xml { head :ok }
324 318 format.json { head :ok }
325 319 end
326 320 end
327 321
328 322 def context_menu
329 323 @issues = Issue.find_all_by_id(params[:ids], :include => :project)
330 324 if (@issues.size == 1)
331 325 @issue = @issues.first
332 326 @allowed_statuses = @issue.new_statuses_allowed_to(User.current)
333 327 end
334 328 projects = @issues.collect(&:project).compact.uniq
335 329 @project = projects.first if projects.size == 1
336 330
337 331 @can = {:edit => (@project && User.current.allowed_to?(:edit_issues, @project)),
338 332 :log_time => (@project && User.current.allowed_to?(:log_time, @project)),
339 333 :update => (@project && (User.current.allowed_to?(:edit_issues, @project) || (User.current.allowed_to?(:change_status, @project) && @allowed_statuses && !@allowed_statuses.empty?))),
340 334 :move => (@project && User.current.allowed_to?(:move_issues, @project)),
341 335 :copy => (@issue && @project.trackers.include?(@issue.tracker) && User.current.allowed_to?(:add_issues, @project)),
342 336 :delete => (@project && User.current.allowed_to?(:delete_issues, @project))
343 337 }
344 338 if @project
345 339 @assignables = @project.assignable_users
346 340 @assignables << @issue.assigned_to if @issue && @issue.assigned_to && !@assignables.include?(@issue.assigned_to)
347 341 @trackers = @project.trackers
348 342 end
349 343
350 344 @priorities = IssuePriority.all.reverse
351 345 @statuses = IssueStatus.find(:all, :order => 'position')
352 346 @back = back_url
353 347
354 348 render :layout => false
355 349 end
356 350
357 351 def update_form
358 352 if params[:id].blank?
359 353 @issue = Issue.new
360 354 @issue.project = @project
361 355 else
362 356 @issue = @project.issues.visible.find(params[:id])
363 357 end
364 358 @issue.attributes = params[:issue]
365 359 @allowed_statuses = ([@issue.status] + @issue.status.find_new_statuses_allowed_to(User.current.roles_for_project(@project), @issue.tracker)).uniq
366 360 @priorities = IssuePriority.all
367 361
368 362 render :partial => 'attributes'
369 363 end
370 364
371 365 def preview
372 366 @issue = @project.issues.find_by_id(params[:id]) unless params[:id].blank?
373 367 if @issue
374 368 @attachements = @issue.attachments
375 369 @description = params[:issue] && params[:issue][:description]
376 370 if @description && @description.gsub(/(\r?\n|\n\r?)/, "\n") == @issue.description.to_s.gsub(/(\r?\n|\n\r?)/, "\n")
377 371 @description = nil
378 372 end
379 373 @notes = params[:notes]
380 374 else
381 375 @description = (params[:issue] ? params[:issue][:description] : nil)
382 376 end
383 377 render :layout => false
384 378 end
385 379
386 380 def auto_complete
387 381 @issues = []
388 382 q = params[:q].to_s
389 383 if q.match(/^\d+$/)
390 384 @issues << @project.issues.visible.find_by_id(q.to_i)
391 385 end
392 386 unless q.blank?
393 387 @issues += @project.issues.visible.find(:all, :conditions => ["LOWER(#{Issue.table_name}.subject) LIKE ?", "%#{q.downcase}%"], :limit => 10)
394 388 end
395 389 render :layout => false
396 390 end
397 391
398 392 private
399 393 def find_issue
400 394 @issue = Issue.find(params[:id], :include => [:project, :tracker, :status, :author, :priority, :category])
401 395 @project = @issue.project
402 396 rescue ActiveRecord::RecordNotFound
403 397 render_404
404 398 end
405 399
406 400 # Filter for bulk operations
407 401 def find_issues
408 402 @issues = Issue.find_all_by_id(params[:id] || params[:ids])
409 403 raise ActiveRecord::RecordNotFound if @issues.empty?
410 404 projects = @issues.collect(&:project).compact.uniq
411 405 if projects.size == 1
412 406 @project = projects.first
413 407 else
414 408 # TODO: let users bulk edit/move/destroy issues from different projects
415 409 render_error 'Can not bulk edit/move/destroy issues from different projects'
416 410 return false
417 411 end
418 412 rescue ActiveRecord::RecordNotFound
419 413 render_404
420 414 end
421 415
422 416 def find_project
423 417 project_id = (params[:issue] && params[:issue][:project_id]) || params[:project_id]
424 418 @project = Project.find(project_id)
425 419 rescue ActiveRecord::RecordNotFound
426 420 render_404
427 421 end
428 422
429 423 # Used by #edit and #update to set some common instance variables
430 424 # from the params
431 425 # TODO: Refactor, not everything in here is needed by #edit
432 426 def update_issue_from_params
433 427 @allowed_statuses = @issue.new_statuses_allowed_to(User.current)
434 428 @priorities = IssuePriority.all
435 429 @edit_allowed = User.current.allowed_to?(:edit_issues, @project)
436 430 @time_entry = TimeEntry.new
437 431
438 432 @notes = params[:notes]
439 433 @issue.init_journal(User.current, @notes)
440 434 # User can change issue attributes only if he has :edit permission or if a workflow transition is allowed
441 435 if (@edit_allowed || !@allowed_statuses.empty?) && params[:issue]
442 436 attrs = params[:issue].dup
443 437 attrs.delete_if {|k,v| !UPDATABLE_ATTRS_ON_TRANSITION.include?(k) } unless @edit_allowed
444 438 attrs.delete(:status_id) unless @allowed_statuses.detect {|s| s.id.to_s == attrs[:status_id].to_s}
445 439 @issue.safe_attributes = attrs
446 440 end
447 441
448 442 end
449 443
450 444 # TODO: Refactor, lots of extra code in here
451 445 def build_new_issue_from_params
452 446 @issue = Issue.new
453 447 @issue.copy_from(params[:copy_from]) if params[:copy_from]
454 448 @issue.project = @project
455 449 # Tracker must be set before custom field values
456 450 @issue.tracker ||= @project.trackers.find((params[:issue] && params[:issue][:tracker_id]) || params[:tracker_id] || :first)
457 451 if @issue.tracker.nil?
458 452 render_error l(:error_no_tracker_in_project)
459 453 return false
460 454 end
461 455 if params[:issue].is_a?(Hash)
462 456 @issue.safe_attributes = params[:issue]
463 457 @issue.watcher_user_ids = params[:issue]['watcher_user_ids'] if User.current.allowed_to?(:add_issue_watchers, @project)
464 458 end
465 459 @issue.author = User.current
466 460 @issue.start_date ||= Date.today
467 461 @priorities = IssuePriority.all
468 462 @allowed_statuses = @issue.new_statuses_allowed_to(User.current, true)
469 463 end
470 464
471 465 def set_flash_from_bulk_issue_save(issues, unsaved_issue_ids)
472 466 if unsaved_issue_ids.empty?
473 467 flash[:notice] = l(:notice_successful_update) unless issues.empty?
474 468 else
475 469 flash[:error] = l(:notice_failed_to_save_issues,
476 470 :count => unsaved_issue_ids.size,
477 471 :total => issues.size,
478 472 :ids => '#' + unsaved_issue_ids.join(', #'))
479 473 end
480 474 end
481 475
482 476 def check_for_default_issue_status
483 477 if IssueStatus.default.nil?
484 478 render_error l(:error_no_default_issue_status)
485 479 return false
486 480 end
487 481 end
482
483 def extract_changed_attributes_for_move(params)
484 changed_attributes = {}
485 [:assigned_to_id, :status_id, :start_date, :due_date].each do |valid_attribute|
486 unless params[valid_attribute].blank?
487 changed_attributes[valid_attribute] = (params[valid_attribute] == 'none' ? nil : params[valid_attribute])
488 end
489 end
490 changed_attributes
491 end
488 492 end
General Comments 0
You need to be logged in to leave comments. Login now