Chris@1295: # Redmine - project management software
Chris@1295: # Copyright (C) 2006-2013  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 IssueQuery < Query
Chris@1295: 
Chris@1295:   self.queried_class = Issue
Chris@1295: 
Chris@1295:   self.available_columns = [
Chris@1295:     QueryColumn.new(:id, :sortable => "#{Issue.table_name}.id", :default_order => 'desc', :caption => '#', :frozen => true),
Chris@1295:     QueryColumn.new(:project, :sortable => "#{Project.table_name}.name", :groupable => true),
Chris@1295:     QueryColumn.new(:tracker, :sortable => "#{Tracker.table_name}.position", :groupable => true),
Chris@1295:     QueryColumn.new(:parent, :sortable => ["#{Issue.table_name}.root_id", "#{Issue.table_name}.lft ASC"], :default_order => 'desc', :caption => :field_parent_issue),
Chris@1295:     QueryColumn.new(:status, :sortable => "#{IssueStatus.table_name}.position", :groupable => true),
Chris@1295:     QueryColumn.new(:priority, :sortable => "#{IssuePriority.table_name}.position", :default_order => 'desc', :groupable => true),
Chris@1295:     QueryColumn.new(:subject, :sortable => "#{Issue.table_name}.subject"),
Chris@1295:     QueryColumn.new(:author, :sortable => lambda {User.fields_for_order_statement("authors")}, :groupable => true),
Chris@1295:     QueryColumn.new(:assigned_to, :sortable => lambda {User.fields_for_order_statement}, :groupable => true),
Chris@1295:     QueryColumn.new(:updated_on, :sortable => "#{Issue.table_name}.updated_on", :default_order => 'desc'),
Chris@1295:     QueryColumn.new(:category, :sortable => "#{IssueCategory.table_name}.name", :groupable => true),
Chris@1295:     QueryColumn.new(:fixed_version, :sortable => lambda {Version.fields_for_order_statement}, :groupable => true),
Chris@1295:     QueryColumn.new(:start_date, :sortable => "#{Issue.table_name}.start_date"),
Chris@1295:     QueryColumn.new(:due_date, :sortable => "#{Issue.table_name}.due_date"),
Chris@1295:     QueryColumn.new(:estimated_hours, :sortable => "#{Issue.table_name}.estimated_hours"),
Chris@1295:     QueryColumn.new(:done_ratio, :sortable => "#{Issue.table_name}.done_ratio", :groupable => true),
Chris@1295:     QueryColumn.new(:created_on, :sortable => "#{Issue.table_name}.created_on", :default_order => 'desc'),
Chris@1295:     QueryColumn.new(:closed_on, :sortable => "#{Issue.table_name}.closed_on", :default_order => 'desc'),
Chris@1295:     QueryColumn.new(:relations, :caption => :label_related_issues),
Chris@1295:     QueryColumn.new(:description, :inline => false)
Chris@1295:   ]
Chris@1295: 
Chris@1295:   scope :visible, lambda {|*args|
Chris@1295:     user = args.shift || User.current
Chris@1295:     base = Project.allowed_to_condition(user, :view_issues, *args)
Chris@1295:     user_id = user.logged? ? user.id : 0
Chris@1295: 
Chris@1295:     includes(:project).where("(#{table_name}.project_id IS NULL OR (#{base})) AND (#{table_name}.is_public = ? OR #{table_name}.user_id = ?)", true, user_id)
Chris@1295:   }
Chris@1295: 
Chris@1295:   def initialize(attributes=nil, *args)
Chris@1295:     super attributes
Chris@1295:     self.filters ||= { 'status_id' => {:operator => "o", :values => [""]} }
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Returns true if the query is visible to +user+ or the current user.
Chris@1295:   def visible?(user=User.current)
Chris@1295:     (project.nil? || user.allowed_to?(:view_issues, project)) && (self.is_public? || self.user_id == user.id)
Chris@1295:   end
Chris@1295: 
Chris@1295:   def initialize_available_filters
Chris@1295:     principals = []
Chris@1295:     subprojects = []
Chris@1295:     versions = []
Chris@1295:     categories = []
Chris@1295:     issue_custom_fields = []
Chris@1295:     
Chris@1295:     if project
Chris@1295:       principals += project.principals.sort
Chris@1295:       unless project.leaf?
Chris@1295:         subprojects = project.descendants.visible.all
Chris@1295:         principals += Principal.member_of(subprojects)
Chris@1295:       end
Chris@1295:       versions = project.shared_versions.all
Chris@1295:       categories = project.issue_categories.all
Chris@1295:       issue_custom_fields = project.all_issue_custom_fields
Chris@1295:     else
Chris@1295:       if all_projects.any?
Chris@1295:         principals += Principal.member_of(all_projects)
Chris@1295:       end
Chris@1295:       versions = Version.visible.find_all_by_sharing('system')
Chris@1295:       issue_custom_fields = IssueCustomField.where(:is_filter => true, :is_for_all => true).all
Chris@1295:     end
Chris@1295:     principals.uniq!
Chris@1295:     principals.sort!
Chris@1295:     users = principals.select {|p| p.is_a?(User)}
Chris@1295: 
Chris@1295: 
Chris@1295:     add_available_filter "status_id",
Chris@1295:       :type => :list_status, :values => IssueStatus.sorted.all.collect{|s| [s.name, s.id.to_s] }
Chris@1295: 
Chris@1295:     if project.nil?
Chris@1295:       project_values = []
Chris@1295:       if User.current.logged? && User.current.memberships.any?
Chris@1295:         project_values << ["<< #{l(:label_my_projects).downcase} >>", "mine"]
Chris@1295:       end
Chris@1295:       project_values += all_projects_values
Chris@1295:       add_available_filter("project_id",
Chris@1295:         :type => :list, :values => project_values
Chris@1295:       ) unless project_values.empty?
Chris@1295:     end
Chris@1295: 
Chris@1295:     add_available_filter "tracker_id",
Chris@1295:       :type => :list, :values => trackers.collect{|s| [s.name, s.id.to_s] }
Chris@1295:     add_available_filter "priority_id",
Chris@1295:       :type => :list, :values => IssuePriority.all.collect{|s| [s.name, s.id.to_s] }
Chris@1295: 
Chris@1295:     author_values = []
Chris@1295:     author_values << ["<< #{l(:label_me)} >>", "me"] if User.current.logged?
Chris@1295:     author_values += users.collect{|s| [s.name, s.id.to_s] }
Chris@1295:     add_available_filter("author_id",
Chris@1295:       :type => :list, :values => author_values
Chris@1295:     ) unless author_values.empty?
Chris@1295: 
Chris@1295:     assigned_to_values = []
Chris@1295:     assigned_to_values << ["<< #{l(:label_me)} >>", "me"] if User.current.logged?
Chris@1295:     assigned_to_values += (Setting.issue_group_assignment? ?
Chris@1295:                               principals : users).collect{|s| [s.name, s.id.to_s] }
Chris@1295:     add_available_filter("assigned_to_id",
Chris@1295:       :type => :list_optional, :values => assigned_to_values
Chris@1295:     ) unless assigned_to_values.empty?
Chris@1295: 
Chris@1295:     group_values = Group.all.collect {|g| [g.name, g.id.to_s] }
Chris@1295:     add_available_filter("member_of_group",
Chris@1295:       :type => :list_optional, :values => group_values
Chris@1295:     ) unless group_values.empty?
Chris@1295: 
Chris@1295:     role_values = Role.givable.collect {|r| [r.name, r.id.to_s] }
Chris@1295:     add_available_filter("assigned_to_role",
Chris@1295:       :type => :list_optional, :values => role_values
Chris@1295:     ) unless role_values.empty?
Chris@1295: 
Chris@1295:     if versions.any?
Chris@1295:       add_available_filter "fixed_version_id",
Chris@1295:         :type => :list_optional,
Chris@1295:         :values => versions.sort.collect{|s| ["#{s.project.name} - #{s.name}", s.id.to_s] }
Chris@1295:     end
Chris@1295: 
Chris@1295:     if categories.any?
Chris@1295:       add_available_filter "category_id",
Chris@1295:         :type => :list_optional,
Chris@1295:         :values => categories.collect{|s| [s.name, s.id.to_s] }
Chris@1295:     end
Chris@1295: 
Chris@1295:     add_available_filter "subject", :type => :text
Chris@1295:     add_available_filter "created_on", :type => :date_past
Chris@1295:     add_available_filter "updated_on", :type => :date_past
Chris@1295:     add_available_filter "closed_on", :type => :date_past
Chris@1295:     add_available_filter "start_date", :type => :date
Chris@1295:     add_available_filter "due_date", :type => :date
Chris@1295:     add_available_filter "estimated_hours", :type => :float
Chris@1295:     add_available_filter "done_ratio", :type => :integer
Chris@1295: 
Chris@1295:     if User.current.allowed_to?(:set_issues_private, nil, :global => true) ||
Chris@1295:       User.current.allowed_to?(:set_own_issues_private, nil, :global => true)
Chris@1295:       add_available_filter "is_private",
Chris@1295:         :type => :list,
Chris@1295:         :values => [[l(:general_text_yes), "1"], [l(:general_text_no), "0"]]
Chris@1295:     end
Chris@1295: 
Chris@1295:     if User.current.logged?
Chris@1295:       add_available_filter "watcher_id",
Chris@1295:         :type => :list, :values => [["<< #{l(:label_me)} >>", "me"]]
Chris@1295:     end
Chris@1295: 
Chris@1295:     if subprojects.any?
Chris@1295:       add_available_filter "subproject_id",
Chris@1295:         :type => :list_subprojects,
Chris@1295:         :values => subprojects.collect{|s| [s.name, s.id.to_s] }
Chris@1295:     end
Chris@1295: 
Chris@1295:     add_custom_fields_filters(issue_custom_fields)
Chris@1295: 
Chris@1295:     add_associations_custom_fields_filters :project, :author, :assigned_to, :fixed_version
Chris@1295: 
Chris@1295:     IssueRelation::TYPES.each do |relation_type, options|
Chris@1295:       add_available_filter relation_type, :type => :relation, :label => options[:name]
Chris@1295:     end
Chris@1295: 
Chris@1295:     Tracker.disabled_core_fields(trackers).each {|field|
Chris@1295:       delete_available_filter field
Chris@1295:     }
Chris@1295:   end
Chris@1295: 
Chris@1295:   def available_columns
Chris@1295:     return @available_columns if @available_columns
Chris@1295:     @available_columns = self.class.available_columns.dup
Chris@1295:     @available_columns += (project ?
Chris@1295:                             project.all_issue_custom_fields :
Chris@1295:                             IssueCustomField.all
Chris@1295:                            ).collect {|cf| QueryCustomFieldColumn.new(cf) }
Chris@1295: 
Chris@1295:     if User.current.allowed_to?(:view_time_entries, project, :global => true)
Chris@1295:       index = nil
Chris@1295:       @available_columns.each_with_index {|column, i| index = i if column.name == :estimated_hours}
Chris@1295:       index = (index ? index + 1 : -1)
Chris@1295:       # insert the column after estimated_hours or at the end
Chris@1295:       @available_columns.insert index, QueryColumn.new(:spent_hours,
Chris@1295:         :sortable => "COALESCE((SELECT SUM(hours) FROM #{TimeEntry.table_name} WHERE #{TimeEntry.table_name}.issue_id = #{Issue.table_name}.id), 0)",
Chris@1295:         :default_order => 'desc',
Chris@1295:         :caption => :label_spent_time
Chris@1295:       )
Chris@1295:     end
Chris@1295: 
Chris@1295:     if User.current.allowed_to?(:set_issues_private, nil, :global => true) ||
Chris@1295:       User.current.allowed_to?(:set_own_issues_private, nil, :global => true)
Chris@1295:       @available_columns << QueryColumn.new(:is_private, :sortable => "#{Issue.table_name}.is_private")
Chris@1295:     end
Chris@1295: 
Chris@1295:     disabled_fields = Tracker.disabled_core_fields(trackers).map {|field| field.sub(/_id$/, '')}
Chris@1295:     @available_columns.reject! {|column|
Chris@1295:       disabled_fields.include?(column.name.to_s)
Chris@1295:     }
Chris@1295: 
Chris@1295:     @available_columns
Chris@1295:   end
Chris@1295: 
Chris@1295:   def default_columns_names
Chris@1295:     @default_columns_names ||= begin
Chris@1295:       default_columns = Setting.issue_list_default_columns.map(&:to_sym)
Chris@1295: 
Chris@1295:       project.present? ? default_columns : [:project] | default_columns
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Returns the issue count
Chris@1295:   def issue_count
Chris@1295:     Issue.visible.count(:include => [:status, :project], :conditions => statement)
Chris@1295:   rescue ::ActiveRecord::StatementInvalid => e
Chris@1295:     raise StatementInvalid.new(e.message)
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Returns the issue count by group or nil if query is not grouped
Chris@1295:   def issue_count_by_group
Chris@1295:     r = nil
Chris@1295:     if grouped?
Chris@1295:       begin
Chris@1295:         # Rails3 will raise an (unexpected) RecordNotFound if there's only a nil group value
Chris@1295:         r = Issue.visible.count(:joins => joins_for_order_statement(group_by_statement), :group => group_by_statement, :include => [:status, :project], :conditions => statement)
Chris@1295:       rescue ActiveRecord::RecordNotFound
Chris@1295:         r = {nil => issue_count}
Chris@1295:       end
Chris@1295:       c = group_by_column
Chris@1295:       if c.is_a?(QueryCustomFieldColumn)
Chris@1295:         r = r.keys.inject({}) {|h, k| h[c.custom_field.cast_value(k)] = r[k]; h}
Chris@1295:       end
Chris@1295:     end
Chris@1295:     r
Chris@1295:   rescue ::ActiveRecord::StatementInvalid => e
Chris@1295:     raise StatementInvalid.new(e.message)
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Returns the issues
Chris@1295:   # Valid options are :order, :offset, :limit, :include, :conditions
Chris@1295:   def issues(options={})
Chris@1295:     order_option = [group_by_sort_order, options[:order]].flatten.reject(&:blank?)
Chris@1295: 
Chris@1295:     issues = Issue.visible.where(options[:conditions]).all(
Chris@1295:       :include => ([:status, :project] + (options[:include] || [])).uniq,
Chris@1295:       :conditions => statement,
Chris@1295:       :order => order_option,
Chris@1295:       :joins => joins_for_order_statement(order_option.join(',')),
Chris@1295:       :limit  => options[:limit],
Chris@1295:       :offset => options[:offset]
Chris@1295:     )
Chris@1295: 
Chris@1295:     if has_column?(:spent_hours)
Chris@1295:       Issue.load_visible_spent_hours(issues)
Chris@1295:     end
Chris@1295:     if has_column?(:relations)
Chris@1295:       Issue.load_visible_relations(issues)
Chris@1295:     end
Chris@1295:     issues
Chris@1295:   rescue ::ActiveRecord::StatementInvalid => e
Chris@1295:     raise StatementInvalid.new(e.message)
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Returns the issues ids
Chris@1295:   def issue_ids(options={})
Chris@1295:     order_option = [group_by_sort_order, options[:order]].flatten.reject(&:blank?)
Chris@1295: 
Chris@1295:     Issue.visible.scoped(:conditions => options[:conditions]).scoped(:include => ([:status, :project] + (options[:include] || [])).uniq,
Chris@1295:                      :conditions => statement,
Chris@1295:                      :order => order_option,
Chris@1295:                      :joins => joins_for_order_statement(order_option.join(',')),
Chris@1295:                      :limit  => options[:limit],
Chris@1295:                      :offset => options[:offset]).find_ids
Chris@1295:   rescue ::ActiveRecord::StatementInvalid => e
Chris@1295:     raise StatementInvalid.new(e.message)
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Returns the journals
Chris@1295:   # Valid options are :order, :offset, :limit
Chris@1295:   def journals(options={})
Chris@1295:     Journal.visible.all(
Chris@1295:       :include => [:details, :user, {:issue => [:project, :author, :tracker, :status]}],
Chris@1295:       :conditions => statement,
Chris@1295:       :order => options[:order],
Chris@1295:       :limit => options[:limit],
Chris@1295:       :offset => options[:offset]
Chris@1295:     )
Chris@1295:   rescue ::ActiveRecord::StatementInvalid => e
Chris@1295:     raise StatementInvalid.new(e.message)
Chris@1295:   end
Chris@1295: 
Chris@1295:   # Returns the versions
Chris@1295:   # Valid options are :conditions
Chris@1295:   def versions(options={})
Chris@1295:     Version.visible.where(options[:conditions]).all(
Chris@1295:       :include => :project,
Chris@1295:       :conditions => project_statement
Chris@1295:     )
Chris@1295:   rescue ::ActiveRecord::StatementInvalid => e
Chris@1295:     raise StatementInvalid.new(e.message)
Chris@1295:   end
Chris@1295: 
Chris@1295:   def sql_for_watcher_id_field(field, operator, value)
Chris@1295:     db_table = Watcher.table_name
Chris@1295:     "#{Issue.table_name}.id #{ operator == '=' ? 'IN' : 'NOT IN' } (SELECT #{db_table}.watchable_id FROM #{db_table} WHERE #{db_table}.watchable_type='Issue' AND " +
Chris@1295:       sql_for_field(field, '=', value, db_table, 'user_id') + ')'
Chris@1295:   end
Chris@1295: 
Chris@1295:   def sql_for_member_of_group_field(field, operator, value)
Chris@1295:     if operator == '*' # Any group
Chris@1295:       groups = Group.all
Chris@1295:       operator = '=' # Override the operator since we want to find by assigned_to
Chris@1295:     elsif operator == "!*"
Chris@1295:       groups = Group.all
Chris@1295:       operator = '!' # Override the operator since we want to find by assigned_to
Chris@1295:     else
Chris@1295:       groups = Group.find_all_by_id(value)
Chris@1295:     end
Chris@1295:     groups ||= []
Chris@1295: 
Chris@1295:     members_of_groups = groups.inject([]) {|user_ids, group|
Chris@1295:       user_ids + group.user_ids + [group.id]
Chris@1295:     }.uniq.compact.sort.collect(&:to_s)
Chris@1295: 
Chris@1295:     '(' + sql_for_field("assigned_to_id", operator, members_of_groups, Issue.table_name, "assigned_to_id", false) + ')'
Chris@1295:   end
Chris@1295: 
Chris@1295:   def sql_for_assigned_to_role_field(field, operator, value)
Chris@1295:     case operator
Chris@1295:     when "*", "!*" # Member / Not member
Chris@1295:       sw = operator == "!*" ? 'NOT' : ''
Chris@1295:       nl = operator == "!*" ? "#{Issue.table_name}.assigned_to_id IS NULL OR" : ''
Chris@1295:       "(#{nl} #{Issue.table_name}.assigned_to_id #{sw} IN (SELECT DISTINCT #{Member.table_name}.user_id FROM #{Member.table_name}" +
Chris@1295:         " WHERE #{Member.table_name}.project_id = #{Issue.table_name}.project_id))"
Chris@1295:     when "=", "!"
Chris@1295:       role_cond = value.any? ?
Chris@1295:         "#{MemberRole.table_name}.role_id IN (" + value.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + ")" :
Chris@1295:         "1=0"
Chris@1295: 
Chris@1295:       sw = operator == "!" ? 'NOT' : ''
Chris@1295:       nl = operator == "!" ? "#{Issue.table_name}.assigned_to_id IS NULL OR" : ''
Chris@1295:       "(#{nl} #{Issue.table_name}.assigned_to_id #{sw} IN (SELECT DISTINCT #{Member.table_name}.user_id FROM #{Member.table_name}, #{MemberRole.table_name}" +
Chris@1295:         " WHERE #{Member.table_name}.project_id = #{Issue.table_name}.project_id AND #{Member.table_name}.id = #{MemberRole.table_name}.member_id AND #{role_cond}))"
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   def sql_for_is_private_field(field, operator, value)
Chris@1295:     op = (operator == "=" ? 'IN' : 'NOT IN')
Chris@1295:     va = value.map {|v| v == '0' ? connection.quoted_false : connection.quoted_true}.uniq.join(',')
Chris@1295: 
Chris@1295:     "#{Issue.table_name}.is_private #{op} (#{va})"
Chris@1295:   end
Chris@1295: 
Chris@1295:   def sql_for_relations(field, operator, value, options={})
Chris@1295:     relation_options = IssueRelation::TYPES[field]
Chris@1295:     return relation_options unless relation_options
Chris@1295: 
Chris@1295:     relation_type = field
Chris@1295:     join_column, target_join_column = "issue_from_id", "issue_to_id"
Chris@1295:     if relation_options[:reverse] || options[:reverse]
Chris@1295:       relation_type = relation_options[:reverse] || relation_type
Chris@1295:       join_column, target_join_column = target_join_column, join_column
Chris@1295:     end
Chris@1295: 
Chris@1295:     sql = case operator
Chris@1295:       when "*", "!*"
Chris@1295:         op = (operator == "*" ? 'IN' : 'NOT IN')
Chris@1295:         "#{Issue.table_name}.id #{op} (SELECT DISTINCT #{IssueRelation.table_name}.#{join_column} FROM #{IssueRelation.table_name} WHERE #{IssueRelation.table_name}.relation_type = '#{connection.quote_string(relation_type)}')"
Chris@1295:       when "=", "!"
Chris@1295:         op = (operator == "=" ? 'IN' : 'NOT IN')
Chris@1295:         "#{Issue.table_name}.id #{op} (SELECT DISTINCT #{IssueRelation.table_name}.#{join_column} FROM #{IssueRelation.table_name} WHERE #{IssueRelation.table_name}.relation_type = '#{connection.quote_string(relation_type)}' AND #{IssueRelation.table_name}.#{target_join_column} = #{value.first.to_i})"
Chris@1295:       when "=p", "=!p", "!p"
Chris@1295:         op = (operator == "!p" ? 'NOT IN' : 'IN')
Chris@1295:         comp = (operator == "=!p" ? '<>' : '=')
Chris@1295:         "#{Issue.table_name}.id #{op} (SELECT DISTINCT #{IssueRelation.table_name}.#{join_column} FROM #{IssueRelation.table_name}, #{Issue.table_name} relissues WHERE #{IssueRelation.table_name}.relation_type = '#{connection.quote_string(relation_type)}' AND #{IssueRelation.table_name}.#{target_join_column} = relissues.id AND relissues.project_id #{comp} #{value.first.to_i})"
Chris@1295:       end
Chris@1295: 
Chris@1295:     if relation_options[:sym] == field && !options[:reverse]
Chris@1295:       sqls = [sql, sql_for_relations(field, operator, value, :reverse => true)]
Chris@1295:       sqls.join(["!", "!*", "!p"].include?(operator) ? " AND " : " OR ")
Chris@1295:     else
Chris@1295:       sql
Chris@1295:     end
Chris@1295:   end
Chris@1295: 
Chris@1295:   IssueRelation::TYPES.keys.each do |relation_type|
Chris@1295:     alias_method "sql_for_#{relation_type}_field".to_sym, :sql_for_relations
Chris@1295:   end
Chris@1295: end