Class: IssuesController

Inherits:
ApplicationController show all
Includes:
AttachmentsHelper, CustomFieldsHelper, IssueRelationsHelper, IssuesHelper, ProjectsHelper, Redmine::Export::PDF, SortHelper, WatchersHelper
Defined in:
app/controllers/issues_controller.rb

Overview

Redmine - project management software Copyright (C) 2006-2008 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.

Constant Summary

UPDATABLE_ATTRS_ON_TRANSITION =
%w(status_id assigned_to_id fixed_version_id done_ratio)

Instance Method Summary (collapse)

Methods included from Redmine::Export::PDF

#gantt_to_pdf, #issue_to_pdf, #issues_to_pdf

Methods included from IssuesHelper

#css_issue_classes, #issues_to_csv, #render_issue_tooltip, #show_detail, #sidebar_queries

Methods included from ApplicationHelper

#accesskey, #authoring, #authorize_for, #avatar, #back_url_hidden_field_tag, #breadcrumb, #calendar_for, #check_all_links, #content_for, #context_menu_link, #current_role, #due_date_distance_in_words, #format_activity_day, #format_activity_description, #format_activity_title, #has_content?, #html_hours, #html_title, #image_to_function, #include_calendar_headers_tags, #label_tag_for, #labelled_tabular_form_for, #lang_options_for_select, #link_to_attachment, #link_to_if_authorized, #link_to_issue, #link_to_remote_if_authorized, #link_to_user, #other_formats_links, #page_header_title, #pagination_links_full, #path_to_stylesheet, #per_page_links, #progress_bar, #project_nested_ul, #project_tree, #project_tree_options_for_select, #prompt_to_remote, #render_flash_messages, #render_page_hierarchy, #render_project_jump_box, #reorder_links, #simple_format_without_paragraph, #stylesheet_path, #syntax_highlight, #textilizable, #to_path_param, #toggle_link, #truncate_single_line

Methods included from Redmine::I18n

#current_language, #day_name, #find_language, #format_date, #format_time, included, #l, #l_hours, #l_or_humanize, #ll, #month_name, #set_language_if_valid, #valid_languages

Methods included from Redmine::WikiFormatting::Macros::Definitions

#exec_macro, #extract_macro_options

Methods included from SortHelper

#sort_clause, #sort_clear, #sort_header_tag, #sort_init, #sort_link, #sort_name, #sort_update

Methods included from AttachmentsHelper

#link_to_attachments, #to_utf8

Methods included from WatchersHelper

#watcher_link, #watcher_tag, #watchers_list

Methods included from IssueRelationsHelper

#collection_for_relation_type_select

Methods included from CustomFieldsHelper

#custom_field_formats_for_select, #custom_field_label_tag, #custom_field_tag, #custom_field_tag_with_label, #custom_fields_tabs, #format_value, #show_value

Methods included from ProjectsHelper

#link_to_version, #parent_project_select_tag, #project_settings_tabs, #render_project_hierarchy

Methods inherited from ApplicationController

accept_key_auth, #accept_key_auth_actions, #attach_files, #authorize, #check_if_login_required, #check_project_privacy, #current_role, #deny_access, #filename_for_content_disposition, #find_current_user, #logged_user=, #parse_qvalues, #per_page_option, #redirect_back_or_default, #render_403, #render_404, #render_error, #render_feed, #require_admin, #require_login, #set_localization, #user_setup

Methods included from Redmine::MenuManager::MenuController

#current_menu_item, included, #menu_items, #redirect_to_project_menu_item

Instance Method Details

- (Object) bulk_edit

Bulk edit a set of issues



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'app/controllers/issues_controller.rb', line 228

def bulk_edit
  if request.post?
    status = params[:status_id].blank? ? nil : IssueStatus.find_by_id(params[:status_id])
    priority = params[:priority_id].blank? ? nil : Enumeration.find_by_id(params[:priority_id])
    assigned_to = (params[:assigned_to_id].blank? || params[:assigned_to_id] == 'none') ? nil : User.find_by_id(params[:assigned_to_id])
    category = (params[:category_id].blank? || params[:category_id] == 'none') ? nil : @project.issue_categories.find_by_id(params[:category_id])
    fixed_version = (params[:fixed_version_id].blank? || params[:fixed_version_id] == 'none') ? nil : @project.versions.find_by_id(params[:fixed_version_id])
    custom_field_values = params[:custom_field_values] ? params[:custom_field_values].reject {|k,v| v.blank?} : nil
    
    unsaved_issue_ids = []      
    @issues.each do |issue|
      journal = issue.init_journal(User.current, params[:notes])
      issue.priority = priority if priority
      issue.assigned_to = assigned_to if assigned_to || params[:assigned_to_id] == 'none'
      issue.category = category if category || params[:category_id] == 'none'
      issue.fixed_version = fixed_version if fixed_version || params[:fixed_version_id] == 'none'
      issue.start_date = params[:start_date] unless params[:start_date].blank?
      issue.due_date = params[:due_date] unless params[:due_date].blank?
      issue.done_ratio = params[:done_ratio] unless params[:done_ratio].blank?
      issue.custom_field_values = custom_field_values if custom_field_values && !custom_field_values.empty?
      call_hook(:controller_issues_bulk_edit_before_save, { :params => params, :issue => issue })
      # Don't save any change to the issue if the user is not authorized to apply the requested status
      if (status.nil? || (issue.status.new_status_allowed_to?(status, current_role, issue.tracker) && issue.status = status)) && issue.save
        # Send notification for each issue (if changed)
        Mailer.deliver_issue_edit(journal) if journal.details.any? && Setting.notified_events.include?('issue_updated')
      else
        # Keep unsaved issue ids to display them in flash error
        unsaved_issue_ids << issue.id
      end
    end
    if unsaved_issue_ids.empty?
      flash[:notice] = l(:notice_successful_update) unless @issues.empty?
    else
      flash[:error] = l(:notice_failed_to_save_issues, :count => unsaved_issue_ids.size,
                                                       :total => @issues.size,
                                                       :ids => '#' + unsaved_issue_ids.join(', #'))
    end
    redirect_to(params[:back_to] || {:controller => 'issues', :action => 'index', :project_id => @project})
    return
  end
  # Find potential statuses the user could be allowed to switch issues to
  @available_statuses = Workflow.find(:all, :include => :new_status,
                                            :conditions => {:role_id => current_role.id}).collect(&:new_status).compact.uniq.sort
  @custom_fields = @project.issue_custom_fields.select {|f| f.field_format == 'list'}
end

- (Object) calendar



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
# File 'app/controllers/issues_controller.rb', line 362

def calendar
  if params[:year] and params[:year].to_i > 1900
    @year = params[:year].to_i
    if params[:month] and params[:month].to_i > 0 and params[:month].to_i < 13
      @month = params[:month].to_i
    end    
  end
  @year ||= Date.today.year
  @month ||= Date.today.month
  
  @calendar = Redmine::Helpers::Calendar.new(Date.civil(@year, @month, 1), current_language, :month)
  retrieve_query
  if @query.valid?
    events = []
    events += Issue.find(:all, 
                         :include => [:tracker, :status, :assigned_to, :priority, :project], 
                         :conditions => ["(#{@query.statement}) AND ((start_date BETWEEN ? AND ?) OR (due_date BETWEEN ? AND ?))", @calendar.startdt, @calendar.enddt, @calendar.startdt, @calendar.enddt]
                         )
    events += Version.find(:all, :include => :project,
                                 :conditions => ["(#{@query.project_statement}) AND effective_date BETWEEN ? AND ?", @calendar.startdt, @calendar.enddt])
                                   
    @calendar.events = events
  end
  
  render :layout => false if request.xhr?
end

- (Object) changes



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'app/controllers/issues_controller.rb', line 80

def changes
  retrieve_query
  sort_init 'id', 'desc'
  sort_update({'id' => "#{Issue.table_name}.id"}.merge(@query.columns.inject({}) {|h, c| h[c.name.to_s] = c.sortable; h}))
  
  if @query.valid?
    @journals = Journal.find :all, :include => [ :details, :user, {:issue => [:project, :author, :tracker, :status]} ],
                                   :conditions => @query.statement,
                                   :limit => 25,
                                   :order => "#{Journal.table_name}.created_on DESC"
  end
  @title = (@project ? @project.name : Setting.app_title) + ": " + (@query.new_record? ? l(:label_changes_details) : @query.name)
  render :layout => false, :content_type => 'application/atom+xml'
rescue ActiveRecord::RecordNotFound
  render_404
end

- (Object) context_menu



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
# File 'app/controllers/issues_controller.rb', line 389

def context_menu
  @issues = Issue.find_all_by_id(params[:ids], :include => :project)
  if (@issues.size == 1)
    @issue = @issues.first
    @allowed_statuses = @issue.new_statuses_allowed_to(User.current)
  end
  projects = @issues.collect(&:project).compact.uniq
  @project = projects.first if projects.size == 1

  @can = {:edit => (@project && User.current.allowed_to?(:edit_issues, @project)),
          :log_time => (@project && User.current.allowed_to?(:log_time, @project)),
          :update => (@project && (User.current.allowed_to?(:edit_issues, @project) || (User.current.allowed_to?(:change_status, @project) && @allowed_statuses && !@allowed_statuses.empty?))),
          :move => (@project && User.current.allowed_to?(:move_issues, @project)),
          :copy => (@issue && @project.trackers.include?(@issue.tracker) && User.current.allowed_to?(:add_issues, @project)),
          :delete => (@project && User.current.allowed_to?(:delete_issues, @project))
          }
  if @project
    @assignables = @project.assignable_users
    @assignables << @issue.assigned_to if @issue && @issue.assigned_to && !@assignables.include?(@issue.assigned_to)
  end
  
  @priorities = Enumeration.priorities.reverse
  @statuses = IssueStatus.find(:all, :order => 'position')
  @back = request.env['HTTP_REFERER']
  
  render :layout => false
end

- (Object) destroy



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# File 'app/controllers/issues_controller.rb', line 306

def destroy
  @hours = TimeEntry.sum(:hours, :conditions => ['issue_id IN (?)', @issues]).to_f
  if @hours > 0
    case params[:todo]
    when 'destroy'
      # nothing to do
    when 'nullify'
      TimeEntry.update_all('issue_id = NULL', ['issue_id IN (?)', @issues])
    when 'reassign'
      reassign_to = @project.issues.find_by_id(params[:reassign_to_id])
      if reassign_to.nil?
        flash.now[:error] = l(:error_issue_not_found_in_project)
        return
      else
        TimeEntry.update_all("issue_id = #{reassign_to.id}", ['issue_id IN (?)', @issues])
      end
    else
      # display the destroy form
      return
    end
  end
  @issues.each(&:destroy)
  redirect_to :action => 'index', :project_id => @project
end

- (Object) edit



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'app/controllers/issues_controller.rb', line 164

def edit
  @allowed_statuses = @issue.new_statuses_allowed_to(User.current)
  @priorities = Enumeration.priorities
  @edit_allowed = User.current.allowed_to?(:edit_issues, @project)
  @time_entry = TimeEntry.new
  
  @notes = params[:notes]
  journal = @issue.init_journal(User.current, @notes)
  # User can change issue attributes only if he has :edit permission or if a workflow transition is allowed
  if (@edit_allowed || !@allowed_statuses.empty?) && params[:issue]
    attrs = params[:issue].dup
    attrs.delete_if {|k,v| !UPDATABLE_ATTRS_ON_TRANSITION.include?(k) } unless @edit_allowed
    attrs.delete(:status_id) unless @allowed_statuses.detect {|s| s.id.to_s == attrs[:status_id].to_s}
    @issue.attributes = attrs
  end

  if request.post?
    @time_entry = TimeEntry.new(:project => @project, :issue => @issue, :user => User.current, :spent_on => Date.today)
    @time_entry.attributes = params[:time_entry]
    attachments = attach_files(@issue, params[:attachments])
    attachments.each {|a| journal.details << JournalDetail.new(:property => 'attachment', :prop_key => a.id, :value => a.filename)}
    
    call_hook(:controller_issues_edit_before_save, { :params => params, :issue => @issue, :time_entry => @time_entry, :journal => journal})

    if (@time_entry.hours.nil? || @time_entry.valid?) && @issue.save
      # Log spend time
      if User.current.allowed_to?(:log_time, @project)
        @time_entry.save
      end
      if !journal.new_record?
        # Only send notification if something was actually changed
        flash[:notice] = l(:notice_successful_update)
        Mailer.deliver_issue_edit(journal) if Setting.notified_events.include?('issue_updated')
      end
      call_hook(:controller_issues_edit_after_save, { :params => params, :issue => @issue, :time_entry => @time_entry, :journal => journal})
      redirect_to(params[:back_to] || {:action => 'show', :id => @issue})
    end
  end
rescue ActiveRecord::StaleObjectError
  # Optimistic locking exception
  flash.now[:error] = l(:notice_locking_conflict)
end

- (Object) gantt



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
# File 'app/controllers/issues_controller.rb', line 331

def gantt
  @gantt = Redmine::Helpers::Gantt.new(params)
  retrieve_query
  if @query.valid?
    events = []
    # Issues that have start and due dates
    events += Issue.find(:all, 
                         :order => "start_date, due_date",
                         :include => [:tracker, :status, :assigned_to, :priority, :project], 
                         :conditions => ["(#{@query.statement}) AND (((start_date>=? and start_date<=?) or (due_date>=? and due_date<=?) or (start_date<? and due_date>?)) and start_date is not null and due_date is not null)", @gantt.date_from, @gantt.date_to, @gantt.date_from, @gantt.date_to, @gantt.date_from, @gantt.date_to]
                         )
    # Issues that don't have a due date but that are assigned to a version with a date
    events += Issue.find(:all, 
                         :order => "start_date, effective_date",
                         :include => [:tracker, :status, :assigned_to, :priority, :project, :fixed_version], 
                         :conditions => ["(#{@query.statement}) AND (((start_date>=? and start_date<=?) or (effective_date>=? and effective_date<=?) or (start_date<? and effective_date>?)) and start_date is not null and due_date is null and effective_date is not null)", @gantt.date_from, @gantt.date_to, @gantt.date_from, @gantt.date_to, @gantt.date_from, @gantt.date_to]
                         )
    # Versions
    events += Version.find(:all, :include => :project,
                                 :conditions => ["(#{@query.project_statement}) AND effective_date BETWEEN ? AND ?", @gantt.date_from, @gantt.date_to])
                                 
    @gantt.events = events
  end
  
  respond_to do |format|
    format.html { render :template => "issues/gantt.rhtml", :layout => !request.xhr? }
    format.png  { send_data(@gantt.to_image, :disposition => 'inline', :type => 'image/png', :filename => "#{@project.nil? ? '' : "#{@project.identifier}-" }gantt.png") } if @gantt.respond_to?('to_image')
    format.pdf  { send_data(gantt_to_pdf(@gantt, @project), :type => 'application/pdf', :filename => "#{@project.nil? ? '' : "#{@project.identifier}-" }gantt.pdf") }
  end
end

- (Object) index



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'app/controllers/issues_controller.rb', line 46

def index
  retrieve_query
  sort_init(@query.sort_criteria.empty? ? [['id', 'desc']] : @query.sort_criteria)
  sort_update({'id' => "#{Issue.table_name}.id"}.merge(@query.columns.inject({}) {|h, c| h[c.name.to_s] = c.sortable; h}))
  
  if @query.valid?
    limit = per_page_option
    respond_to do |format|
      format.html { }
      format.atom { }
      format.csv  { limit = Setting.issues_export_limit.to_i }
      format.pdf  { limit = Setting.issues_export_limit.to_i }
    end
    @issue_count = Issue.count(:include => [:status, :project], :conditions => @query.statement)
    @issue_pages = Paginator.new self, @issue_count, limit, params['page']
    @issues = Issue.find :all, :order => sort_clause,
                         :include => [ :assigned_to, :status, :tracker, :project, :priority, :category, :fixed_version ],
                         :conditions => @query.statement,
                         :limit  =>  limit,
                         :offset =>  @issue_pages.current.offset
    respond_to do |format|
      format.html { render :template => 'issues/index.rhtml', :layout => !request.xhr? }
      format.atom { render_feed(@issues, :title => "#{@project || Setting.app_title}: #{l(:label_issue_plural)}") }
      format.csv  { send_data(issues_to_csv(@issues, @project).read, :type => 'text/csv; header=present', :filename => 'export.csv') }
      format.pdf  { send_data(issues_to_pdf(@issues, @project), :type => 'application/pdf', :filename => 'export.pdf') }
    end
  else
    # Send html if the query is not valid
    render(:template => 'issues/index.rhtml', :layout => !request.xhr?)
  end
rescue ActiveRecord::RecordNotFound
  render_404
end

- (Object) move



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
# File 'app/controllers/issues_controller.rb', line 274

def move
  @allowed_projects = []
  # find projects to which the user is allowed to move the issue
  if User.current.admin?
    # admin is allowed to move issues to any active (visible) project
    @allowed_projects = Project.find(:all, :conditions => Project.visible_by(User.current))
  else
    User.current.memberships.each {|m| @allowed_projects << m.project if m.role.allowed_to?(:move_issues)}
  end
  @target_project = @allowed_projects.detect {|p| p.id.to_s == params[:new_project_id]} if params[:new_project_id]
  @target_project ||= @project    
  @trackers = @target_project.trackers
  if request.post?
    new_tracker = params[:new_tracker_id].blank? ? nil : @target_project.trackers.find_by_id(params[:new_tracker_id])
    unsaved_issue_ids = []
    @issues.each do |issue|
      issue.init_journal(User.current)
      unsaved_issue_ids << issue.id unless issue.move_to(@target_project, new_tracker, params[:copy_options])
    end
    if unsaved_issue_ids.empty?
      flash[:notice] = l(:notice_successful_update) unless @issues.empty?
    else
      flash[:error] = l(:notice_failed_to_save_issues, :count => unsaved_issue_ids.size,
                                                       :total => @issues.size,
                                                       :ids => '#' + unsaved_issue_ids.join(', #'))
    end
    redirect_to :controller => 'issues', :action => 'index', :project_id => @project
    return
  end
  render :layout => false if request.xhr?
end

- (Object) new

Add a new issue The new issue will be created from an existing one if copy_from parameter is given



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'app/controllers/issues_controller.rb', line 116

def new
  @issue = Issue.new
  @issue.copy_from(params[:copy_from]) if params[:copy_from]
  @issue.project = @project
  # Tracker must be set before custom field values
  @issue.tracker ||= @project.trackers.find((params[:issue] && params[:issue][:tracker_id]) || params[:tracker_id] || :first)
  if @issue.tracker.nil?
    render_error 'No tracker is associated to this project. Please check the Project settings.'
    return
  end
  if params[:issue].is_a?(Hash)
    @issue.attributes = params[:issue]
    @issue.watcher_user_ids = params[:issue]['watcher_user_ids'] if User.current.allowed_to?(:add_issue_watchers, @project)
  end
  @issue.author = User.current
  
  default_status = IssueStatus.default
  unless default_status
    render_error 'No default issue status is defined. Please check your configuration (Go to "Administration -> Issue statuses").'
    return
  end    
  @issue.status = default_status
  @allowed_statuses = ([default_status] + default_status.find_new_statuses_allowed_to(User.current.role_for_project(@project), @issue.tracker)).uniq
  
  if request.get? || request.xhr?
    @issue.start_date ||= Date.today
  else
    requested_status = IssueStatus.find_by_id(params[:issue][:status_id])
    # Check that the user is allowed to apply the requested status
    @issue.status = (@allowed_statuses.include? requested_status) ? requested_status : default_status
    if @issue.save
      attach_files(@issue, params[:attachments])
      flash[:notice] = l(:notice_successful_create)
      Mailer.deliver_issue_add(@issue) if Setting.notified_events.include?('issue_added')
      call_hook(:controller_issues_new_after_save, { :params => params, :issue => @issue})
      redirect_to(params[:continue] ? { :action => 'new', :tracker_id => @issue.tracker } :
                                      { :action => 'show', :id => @issue })
      return
    end		
  end	
  @priorities = Enumeration.priorities
  render :layout => !request.xhr?
end

- (Object) preview



422
423
424
425
426
427
# File 'app/controllers/issues_controller.rb', line 422

def preview
  @issue = @project.issues.find_by_id(params[:id]) unless params[:id].blank?
  @attachements = @issue.attachments if @issue
  @text = params[:notes] || (params[:issue] ? params[:issue][:description] : nil)
  render :partial => 'common/preview'
end

- (Object) reply



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'app/controllers/issues_controller.rb', line 207

def reply
  journal = Journal.find(params[:journal_id]) if params[:journal_id]
  if journal
    user = journal.user
    text = journal.notes
  else
    user = @issue.author
    text = @issue.description
  end
  content = "#{ll(Setting.default_language, :text_user_wrote, user)}\\n> "
  content << text.to_s.strip.gsub(%r{<pre>((.|\s)*?)</pre>}m, '[...]').gsub('"', '\"').gsub(/(\r?\n|\r\n?)/, "\\n> ") + "\\n\\n"
  render(:update) { |page|
    page.<< "$('notes').value = \"#{content}\";"
    page.show 'update'
    page << "Form.Element.focus('notes');"
    page << "Element.scrollTo('update');"
    page << "$('notes').scrollTop = $('notes').scrollHeight - $('notes').clientHeight;"
  }
end

- (Object) show



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# File 'app/controllers/issues_controller.rb', line 97

def show
  @journals = @issue.journals.find(:all, :include => [:user, :details], :order => "#{Journal.table_name}.created_on ASC")
  @journals.each_with_index {|j,i| j.indice = i+1}
  @journals.reverse! if User.current.wants_comments_in_reverse_order?
  @changesets = @issue.changesets
  @changesets.reverse! if User.current.wants_comments_in_reverse_order?
  @allowed_statuses = @issue.new_statuses_allowed_to(User.current)
  @edit_allowed = User.current.allowed_to?(:edit_issues, @project)
  @priorities = Enumeration.priorities
  @time_entry = TimeEntry.new
  respond_to do |format|
    format.html { render :template => 'issues/show.rhtml' }
    format.atom { render :action => 'changes', :layout => false, :content_type => 'application/atom+xml' }
    format.pdf  { send_data(issue_to_pdf(@issue), :type => 'application/pdf', :filename => "#{@project.identifier}-#{@issue.id}.pdf") }
  end
end

- (Object) update_form



417
418
419
420
# File 'app/controllers/issues_controller.rb', line 417

def update_form
  @issue = Issue.new(params[:issue])
  render :action => :new, :layout => false
end