Chris@1295: # Redmine - project management software
Chris@1295: # Copyright (C) 2006-2012  Jean-Philippe Lang
Chris@1295: #
Chris@1295: # This program is free software; you can redistribute it and/or
Chris@1295: # modify it under the terms of the GNU General Public License
Chris@1295: # as published by the Free Software Foundation; either version 2
Chris@1295: # of the License, or (at your option) any later version.
Chris@1295: #
Chris@1295: # This program is distributed in the hope that it will be useful,
Chris@1295: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1295: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1295: # GNU General Public License for more details.
Chris@1295: #
Chris@1295: # You should have received a copy of the GNU General Public License
Chris@1295: # along with this program; if not, write to the Free Software
Chris@1295: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1295: 
Chris@1295: class IssuesController < ApplicationController
Chris@1295:   menu_item :new_issue, :only => [:new, :create]
Chris@1295:   default_search_scope :issues
Chris@1295: 
Chris@1295:   before_filter :find_issue, :only => [:show, :edit, :update]
Chris@1295:   before_filter :find_issues, :only => [:bulk_edit, :bulk_update, :destroy]
Chris@1295:   before_filter :find_project, :only => [:new, :create]
Chris@1295:   before_filter :authorize, :except => [:index]
Chris@1295:   before_filter :find_optional_project, :only => [:index]
Chris@1295:   before_filter :check_for_default_issue_status, :only => [:new, :create]
Chris@1295:   before_filter :build_new_issue_from_params, :only => [:new, :create]
Chris@1295:   accept_rss_auth :index, :show
Chris@1295:   accept_api_auth :index, :show, :create, :update, :destroy
Chris@1295: 
Chris@1295:   rescue_from Query::StatementInvalid, :with => :query_statement_invalid
Chris@1295: 
Chris@1295:   helper :journals
Chris@1295:   helper :projects
Chris@1295:   include ProjectsHelper
Chris@1295:   helper :custom_fields
Chris@1295:   include CustomFieldsHelper
Chris@1295:   helper :issue_relations
Chris@1295:   include IssueRelationsHelper
Chris@1295:   helper :watchers
Chris@1295:   include WatchersHelper
Chris@1295:   helper :attachments
Chris@1295:   include AttachmentsHelper
Chris@1295:   helper :queries
Chris@1295:   include QueriesHelper
Chris@1295:   helper :repositories
Chris@1295:   include RepositoriesHelper
Chris@1295:   helper :sort
Chris@1295:   include SortHelper
Chris@1295:   include IssuesHelper
Chris@1295:   helper :timelog
Chris@1295:   include Redmine::Export::PDF
Chris@1295: 
Chris@1295:   def index
Chris@1295:     retrieve_query
Chris@1295:     sort_init(@query.sort_criteria.empty? ? [['id', 'desc']] : @query.sort_criteria)
Chris@1295:     sort_update(@query.sortable_columns)
Chris@1295:     @query.sort_criteria = sort_criteria.to_a
Chris@1295: 
Chris@1295:     if @query.valid?
Chris@1295:       case params[:format]
Chris@1295:       when 'csv', 'pdf'
Chris@1295:         @limit = Setting.issues_export_limit.to_i
Chris@1295:       when 'atom'
Chris@1295:         @limit = Setting.feeds_limit.to_i
Chris@1295:       when 'xml', 'json'
Chris@1295:         @offset, @limit = api_offset_and_limit
Chris@1295:       else
Chris@1295:         @limit = per_page_option
Chris@1295:       end
Chris@1295: 
Chris@1295:       @issue_count = @query.issue_count
Chris@1295:       @issue_pages = Paginator.new self, @issue_count, @limit, params['page']
Chris@1295:       @offset ||= @issue_pages.current.offset
Chris@1295:       @issues = @query.issues(:include => [:assigned_to, :tracker, :priority, :category, :fixed_version],
Chris@1295:                               :order => sort_clause,
Chris@1295:                               :offset => @offset,
Chris@1295:                               :limit => @limit)
Chris@1295:       @issue_count_by_group = @query.issue_count_by_group
Chris@1295: 
Chris@1295:       respond_to do |format|
Chris@1295:         format.html { render :template => 'issues/index', :layout => !request.xhr? }
Chris@1295:         format.api  {
Chris@1295:           Issue.load_visible_relations(@issues) if include_in_api_response?('relations')
Chris@1295:         }
Chris@1295:         format.atom { render_feed(@issues, :title => "#{@project || Setting.app_title}: #{l(:label_issue_plural)}") }
Chris@1295:         format.csv  { send_data(issues_to_csv(@issues, @project, @query, params), :type => 'text/csv; header=present', :filename => 'export.csv') }
Chris@1295:         format.pdf  { send_data(issues_to_pdf(@issues, @project, @query), :type => 'application/pdf', :filename => 'export.pdf') }
Chris@1295:       end
Chris@1295:     else
Chris@1295:       respond_to do |format|
Chris@1295:         format.html { render(:template => 'issues/index', :layout => !request.xhr?) }
Chris@1295:         format.any(:atom, :csv, :pdf) { render(:nothing => true) }
Chris@1295:         format.api { render_validation_errors(@query) }
Chris@1295:       end
Chris@1295:     end
Chris@1295:   rescue ActiveRecord::RecordNotFound
Chris@1295:     render_404
Chris@1295:   end
Chris@1295: 
Chris@1295:   def show
Chris@1295:     @journals = @issue.journals.includes(:user, :details).reorder("#{Journal.table_name}.id ASC").all
Chris@1295:     @journals.each_with_index {|j,i| j.indice = i+1}
Chris@1295:     @journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
Chris@1295:     @journals.reverse! if User.current.wants_comments_in_reverse_order?
Chris@1295: 
Chris@1295:     @changesets = @issue.changesets.visible.all
Chris@1295:     @changesets.reverse! if User.current.wants_comments_in_reverse_order?
Chris@1295: 
Chris@1295:     @relations = @issue.relations.select {|r| r.other_issue(@issue) && r.other_issue(@issue).visible? }
Chris@1295:     @allowed_statuses = @issue.new_statuses_allowed_to(User.current)
Chris@1295:     @edit_allowed = User.current.allowed_to?(:edit_issues, @project)
Chris@1295:     @priorities = IssuePriority.active
Chris@1295:     @time_entry = TimeEntry.new(:issue => @issue, :project => @issue.project)
Chris@1295:     respond_to do |format|
Chris@1295:       format.html {
Chris@1295:         retrieve_previous_and_next_issue_ids
Chris@1295:         render :template => 'issues/show'
Chris@1295:       }
Chris@1295:       format.api
Chris@1295:       format.atom { render :template => 'journals/index', :layout => false, :content_type => 'application/atom+xml' }
Chris@1295:       format.pdf  {
Chris@1295:         pdf = issue_to_pdf(@issue, :journals => @journals)
Chris@1295:         send_data(pdf, :type => 'application/pdf', :filename => "#{@project.identifier}-#{@issue.id}.pdf")
Chris@1295:       }
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Add a new issue
Chris@1295:   # The new issue will be created from an existing one if copy_from parameter is given
Chris@1295:   def new
Chris@1295:     respond_to do |format|
Chris@1295:       format.html { render :action => 'new', :layout => !request.xhr? }
Chris@1295:       format.js { render :partial => 'update_form' }
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   def create
Chris@1295:     call_hook(:controller_issues_new_before_save, { :params => params, :issue => @issue })
Chris@1295:     @issue.save_attachments(params[:attachments] || (params[:issue] && params[:issue][:uploads]))
Chris@1295:     if @issue.save
Chris@1295:       call_hook(:controller_issues_new_after_save, { :params => params, :issue => @issue})
Chris@1295:       respond_to do |format|
Chris@1295:         format.html {
Chris@1295:           render_attachment_warning_if_needed(@issue)
Chris@1295:           flash[:notice] = l(:notice_issue_successful_create, :id => view_context.link_to("##{@issue.id}", issue_path(@issue), :title => @issue.subject))
Chris@1295:           redirect_to(params[:continue] ?  { :action => 'new', :project_id => @issue.project, :issue => {:tracker_id => @issue.tracker, :parent_issue_id => @issue.parent_issue_id}.reject {|k,v| v.nil?} } :
Chris@1295:                       { :action => 'show', :id => @issue })
Chris@1295:         }
Chris@1295:         format.api  { render :action => 'show', :status => :created, :location => issue_url(@issue) }
Chris@1295:       end
Chris@1295:       return
Chris@1295:     else
Chris@1295:       respond_to do |format|
Chris@1295:         format.html { render :action => 'new' }
Chris@1295:         format.api  { render_validation_errors(@issue) }
Chris@1295:       end
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   def edit
Chris@1295:     return unless update_issue_from_params
Chris@1295: 
Chris@1295:     respond_to do |format|
Chris@1295:       format.html { }
Chris@1295:       format.xml  { }
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   def update
Chris@1295:     return unless update_issue_from_params
Chris@1295:     @issue.save_attachments(params[:attachments] || (params[:issue] && params[:issue][:uploads]))
Chris@1295:     saved = false
Chris@1295:     begin
Chris@1295:       saved = @issue.save_issue_with_child_records(params, @time_entry)
Chris@1295:     rescue ActiveRecord::StaleObjectError
Chris@1295:       @conflict = true
Chris@1295:       if params[:last_journal_id]
Chris@1295:         @conflict_journals = @issue.journals_after(params[:last_journal_id]).all
Chris@1295:         @conflict_journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
Chris@1295:       end
Chris@1295:     end
Chris@1295: 
Chris@1295:     if saved
Chris@1295:       render_attachment_warning_if_needed(@issue)
Chris@1295:       flash[:notice] = l(:notice_successful_update) unless @issue.current_journal.new_record?
Chris@1295: 
Chris@1295:       respond_to do |format|
Chris@1295:         format.html { redirect_back_or_default({:action => 'show', :id => @issue}) }
Chris@1295:         format.api  { render_api_ok }
Chris@1295:       end
Chris@1295:     else
Chris@1295:       respond_to do |format|
Chris@1295:         format.html { render :action => 'edit' }
Chris@1295:         format.api  { render_validation_errors(@issue) }
Chris@1295:       end
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Bulk edit/copy a set of issues
Chris@1295:   def bulk_edit
Chris@1295:     @issues.sort!
Chris@1295:     @copy = params[:copy].present?
Chris@1295:     @notes = params[:notes]
Chris@1295: 
Chris@1295:     if User.current.allowed_to?(:move_issues, @projects)
Chris@1295:       @allowed_projects = Issue.allowed_target_projects_on_move
Chris@1295:       if params[:issue]
Chris@1295:         @target_project = @allowed_projects.detect {|p| p.id.to_s == params[:issue][:project_id].to_s}
Chris@1295:         if @target_project
Chris@1295:           target_projects = [@target_project]
Chris@1295:         end
Chris@1295:       end
Chris@1295:     end
Chris@1295:     target_projects ||= @projects
Chris@1295: 
Chris@1295:     if @copy
Chris@1295:       @available_statuses = [IssueStatus.default]
Chris@1295:     else
Chris@1295:       @available_statuses = @issues.map(&:new_statuses_allowed_to).reduce(:&)
Chris@1295:     end
Chris@1295:     @custom_fields = target_projects.map{|p|p.all_issue_custom_fields}.reduce(:&)
Chris@1295:     @assignables = target_projects.map(&:assignable_users).reduce(:&)
Chris@1295:     @trackers = target_projects.map(&:trackers).reduce(:&)
Chris@1295:     @versions = target_projects.map {|p| p.shared_versions.open}.reduce(:&)
Chris@1295:     @categories = target_projects.map {|p| p.issue_categories}.reduce(:&)
Chris@1295:     if @copy
Chris@1295:       @attachments_present = @issues.detect {|i| i.attachments.any?}.present?
Chris@1295:       @subtasks_present = @issues.detect {|i| !i.leaf?}.present?
Chris@1295:     end
Chris@1295: 
Chris@1295:     @safe_attributes = @issues.map(&:safe_attribute_names).reduce(:&)
Chris@1295:     render :layout => false if request.xhr?
Chris@1295:   end
Chris@1295: 
Chris@1295:   def bulk_update
Chris@1295:     @issues.sort!
Chris@1295:     @copy = params[:copy].present?
Chris@1295:     attributes = parse_params_for_bulk_issue_attributes(params)
Chris@1295: 
Chris@1295:     unsaved_issue_ids = []
Chris@1295:     moved_issues = []
Chris@1295: 
Chris@1295:     if @copy && params[:copy_subtasks].present?
Chris@1295:       # Descendant issues will be copied with the parent task
Chris@1295:       # Don't copy them twice
Chris@1295:       @issues.reject! {|issue| @issues.detect {|other| issue.is_descendant_of?(other)}}
Chris@1295:     end
Chris@1295: 
Chris@1295:     @issues.each do |issue|
Chris@1295:       issue.reload
Chris@1295:       if @copy
Chris@1295:         issue = issue.copy({},
Chris@1295:           :attachments => params[:copy_attachments].present?,
Chris@1295:           :subtasks => params[:copy_subtasks].present?
Chris@1295:         )
Chris@1295:       end
Chris@1295:       journal = issue.init_journal(User.current, params[:notes])
Chris@1295:       issue.safe_attributes = attributes
Chris@1295:       call_hook(:controller_issues_bulk_edit_before_save, { :params => params, :issue => issue })
Chris@1295:       if issue.save
Chris@1295:         moved_issues << issue
Chris@1295:       else
Chris@1295:         # Keep unsaved issue ids to display them in flash error
Chris@1295:         unsaved_issue_ids << issue.id
Chris@1295:       end
Chris@1295:     end
Chris@1295:     set_flash_from_bulk_issue_save(@issues, unsaved_issue_ids)
Chris@1295: 
Chris@1295:     if params[:follow]
Chris@1295:       if @issues.size == 1 && moved_issues.size == 1
Chris@1295:         redirect_to :controller => 'issues', :action => 'show', :id => moved_issues.first
Chris@1295:       elsif moved_issues.map(&:project).uniq.size == 1
Chris@1295:         redirect_to :controller => 'issues', :action => 'index', :project_id => moved_issues.map(&:project).first
Chris@1295:       end
Chris@1295:     else
Chris@1295:       redirect_back_or_default({:controller => 'issues', :action => 'index', :project_id => @project})
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   def destroy
Chris@1295:     @hours = TimeEntry.sum(:hours, :conditions => ['issue_id IN (?)', @issues]).to_f
Chris@1295:     if @hours > 0
Chris@1295:       case params[:todo]
Chris@1295:       when 'destroy'
Chris@1295:         # nothing to do
Chris@1295:       when 'nullify'
Chris@1295:         TimeEntry.update_all('issue_id = NULL', ['issue_id IN (?)', @issues])
Chris@1295:       when 'reassign'
Chris@1295:         reassign_to = @project.issues.find_by_id(params[:reassign_to_id])
Chris@1295:         if reassign_to.nil?
Chris@1295:           flash.now[:error] = l(:error_issue_not_found_in_project)
Chris@1295:           return
Chris@1295:         else
Chris@1295:           TimeEntry.update_all("issue_id = #{reassign_to.id}", ['issue_id IN (?)', @issues])
Chris@1295:         end
Chris@1295:       else
Chris@1295:         # display the destroy form if it's a user request
Chris@1295:         return unless api_request?
Chris@1295:       end
Chris@1295:     end
Chris@1295:     @issues.each do |issue|
Chris@1295:       begin
Chris@1295:         issue.reload.destroy
Chris@1295:       rescue ::ActiveRecord::RecordNotFound # raised by #reload if issue no longer exists
Chris@1295:         # nothing to do, issue was already deleted (eg. by a parent)
Chris@1295:       end
Chris@1295:     end
Chris@1295:     respond_to do |format|
Chris@1295:       format.html { redirect_back_or_default(:action => 'index', :project_id => @project) }
Chris@1295:       format.api  { render_api_ok }
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   private
Chris@1295: 
Chris@1295:   def find_project
Chris@1295:     project_id = params[:project_id] || (params[:issue] && params[:issue][:project_id])
Chris@1295:     @project = Project.find(project_id)
Chris@1295:   rescue ActiveRecord::RecordNotFound
Chris@1295:     render_404
Chris@1295:   end
Chris@1295: 
Chris@1295:   def retrieve_previous_and_next_issue_ids
Chris@1295:     retrieve_query_from_session
Chris@1295:     if @query
Chris@1295:       sort_init(@query.sort_criteria.empty? ? [['id', 'desc']] : @query.sort_criteria)
Chris@1295:       sort_update(@query.sortable_columns, 'issues_index_sort')
Chris@1295:       limit = 500
Chris@1295:       issue_ids = @query.issue_ids(:order => sort_clause, :limit => (limit + 1), :include => [:assigned_to, :tracker, :priority, :category, :fixed_version])
Chris@1295:       if (idx = issue_ids.index(@issue.id)) && idx < limit
Chris@1295:         if issue_ids.size < 500
Chris@1295:           @issue_position = idx + 1
Chris@1295:           @issue_count = issue_ids.size
Chris@1295:         end
Chris@1295:         @prev_issue_id = issue_ids[idx - 1] if idx > 0
Chris@1295:         @next_issue_id = issue_ids[idx + 1] if idx < (issue_ids.size - 1)
Chris@1295:       end
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Used by #edit and #update to set some common instance variables
Chris@1295:   # from the params
Chris@1295:   # TODO: Refactor, not everything in here is needed by #edit
Chris@1295:   def update_issue_from_params
Chris@1295:     @edit_allowed = User.current.allowed_to?(:edit_issues, @project)
Chris@1295:     @time_entry = TimeEntry.new(:issue => @issue, :project => @issue.project)
Chris@1295:     @time_entry.attributes = params[:time_entry]
Chris@1295: 
Chris@1295:     @issue.init_journal(User.current)
Chris@1295: 
Chris@1295:     issue_attributes = params[:issue]
Chris@1295:     if issue_attributes && params[:conflict_resolution]
Chris@1295:       case params[:conflict_resolution]
Chris@1295:       when 'overwrite'
Chris@1295:         issue_attributes = issue_attributes.dup
Chris@1295:         issue_attributes.delete(:lock_version)
Chris@1295:       when 'add_notes'
Chris@1295:         issue_attributes = issue_attributes.slice(:notes)
Chris@1295:       when 'cancel'
Chris@1295:         redirect_to issue_path(@issue)
Chris@1295:         return false
Chris@1295:       end
Chris@1295:     end
Chris@1295:     @issue.safe_attributes = issue_attributes
Chris@1295:     @priorities = IssuePriority.active
Chris@1295:     @allowed_statuses = @issue.new_statuses_allowed_to(User.current)
Chris@1295:     true
Chris@1295:   end
Chris@1295: 
Chris@1295:   # TODO: Refactor, lots of extra code in here
Chris@1295:   # TODO: Changing tracker on an existing issue should not trigger this
Chris@1295:   def build_new_issue_from_params
Chris@1295:     if params[:id].blank?
Chris@1295:       @issue = Issue.new
Chris@1295:       if params[:copy_from]
Chris@1295:         begin
Chris@1295:           @copy_from = Issue.visible.find(params[:copy_from])
Chris@1295:           @copy_attachments = params[:copy_attachments].present? || request.get?
Chris@1295:           @copy_subtasks = params[:copy_subtasks].present? || request.get?
Chris@1295:           @issue.copy_from(@copy_from, :attachments => @copy_attachments, :subtasks => @copy_subtasks)
Chris@1295:         rescue ActiveRecord::RecordNotFound
Chris@1295:           render_404
Chris@1295:           return
Chris@1295:         end
Chris@1295:       end
Chris@1295:       @issue.project = @project
Chris@1295:     else
Chris@1295:       @issue = @project.issues.visible.find(params[:id])
Chris@1295:     end
Chris@1295: 
Chris@1295:     @issue.project = @project
Chris@1295:     @issue.author ||= User.current
Chris@1295:     # Tracker must be set before custom field values
Chris@1295:     @issue.tracker ||= @project.trackers.find((params[:issue] && params[:issue][:tracker_id]) || params[:tracker_id] || :first)
Chris@1295:     if @issue.tracker.nil?
Chris@1295:       render_error l(:error_no_tracker_in_project)
Chris@1295:       return false
Chris@1295:     end
Chris@1295:     @issue.start_date ||= Date.today if Setting.default_issue_start_date_to_creation_date?
Chris@1295:     @issue.safe_attributes = params[:issue]
Chris@1295: 
Chris@1295:     @priorities = IssuePriority.active
Chris@1295:     @allowed_statuses = @issue.new_statuses_allowed_to(User.current, true)
Chris@1295:     @available_watchers = (@issue.project.users.sort + @issue.watcher_users).uniq
Chris@1295:   end
Chris@1295: 
Chris@1295:   def check_for_default_issue_status
Chris@1295:     if IssueStatus.default.nil?
Chris@1295:       render_error l(:error_no_default_issue_status)
Chris@1295:       return false
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   def parse_params_for_bulk_issue_attributes(params)
Chris@1295:     attributes = (params[:issue] || {}).reject {|k,v| v.blank?}
Chris@1295:     attributes.keys.each {|k| attributes[k] = '' if attributes[k] == 'none'}
Chris@1295:     if custom = attributes[:custom_field_values]
Chris@1295:       custom.reject! {|k,v| v.blank?}
Chris@1295:       custom.keys.each do |k|
Chris@1295:         if custom[k].is_a?(Array)
Chris@1295:           custom[k] << '' if custom[k].delete('__none__')
Chris@1295:         else
Chris@1295:           custom[k] = '' if custom[k] == '__none__'
Chris@1295:         end
Chris@1295:       end
Chris@1295:     end
Chris@1295:     attributes
Chris@1295:   end
Chris@1295: end