query.rb
344 lines
| 14.7 KiB
| text/x-ruby
|
RubyLexer
Jean-Philippe Lang
|
r92 | # redMine - project management software | ||
|
Jean-Philippe Lang
|
r444 | # Copyright (C) 2006-2007 Jean-Philippe Lang | ||
|
Jean-Philippe Lang
|
r92 | # | ||
| # 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. | ||||
|
Jean-Philippe Lang
|
r771 | class QueryColumn | ||
|
Jean-Philippe Lang
|
r774 | attr_accessor :name, :sortable | ||
|
Jean-Philippe Lang
|
r876 | include GLoc | ||
|
Jean-Philippe Lang
|
r771 | |||
| def initialize(name, options={}) | ||||
| self.name = name | ||||
| self.sortable = options[:sortable] | ||||
| end | ||||
|
Jean-Philippe Lang
|
r876 | def caption | ||
|
Jean-Philippe Lang
|
r893 | set_language_if_valid(User.current.language) | ||
|
Jean-Philippe Lang
|
r876 | l("field_#{name}") | ||
| end | ||||
| end | ||||
| class QueryCustomFieldColumn < QueryColumn | ||||
| def initialize(custom_field) | ||||
| self.name = "cf_#{custom_field.id}".to_sym | ||||
| self.sortable = false | ||||
| @cf = custom_field | ||||
| end | ||||
| def caption | ||||
| @cf.name | ||||
| end | ||||
| def custom_field | ||||
| @cf | ||||
| end | ||||
|
Jean-Philippe Lang
|
r771 | end | ||
|
Jean-Philippe Lang
|
r92 | class Query < ActiveRecord::Base | ||
| belongs_to :project | ||||
| belongs_to :user | ||||
| serialize :filters | ||||
|
Jean-Philippe Lang
|
r771 | serialize :column_names | ||
|
Jean-Philippe Lang
|
r92 | |||
| attr_protected :project, :user | ||||
|
Jean-Philippe Lang
|
r517 | attr_accessor :executed_by | ||
|
Jean-Philippe Lang
|
r92 | |||
| validates_presence_of :name, :on => :save | ||||
|
Jean-Philippe Lang
|
r590 | validates_length_of :name, :maximum => 255 | ||
|
Jean-Philippe Lang
|
r92 | |||
| @@operators = { "=" => :label_equals, | ||||
| "!" => :label_not_equals, | ||||
| "o" => :label_open_issues, | ||||
| "c" => :label_closed_issues, | ||||
| "!*" => :label_none, | ||||
| "*" => :label_all, | ||||
|
Jean-Philippe Lang
|
r710 | ">=" => '>=', | ||
| "<=" => '<=', | ||||
|
Jean-Philippe Lang
|
r92 | "<t+" => :label_in_less_than, | ||
| ">t+" => :label_in_more_than, | ||||
| "t+" => :label_in, | ||||
| "t" => :label_today, | ||||
|
Jean-Philippe Lang
|
r693 | "w" => :label_this_week, | ||
|
Jean-Philippe Lang
|
r92 | ">t-" => :label_less_than_ago, | ||
| "<t-" => :label_more_than_ago, | ||||
| "t-" => :label_ago, | ||||
| "~" => :label_contains, | ||||
| "!~" => :label_not_contains } | ||||
| cattr_reader :operators | ||||
| @@operators_by_filter_type = { :list => [ "=", "!" ], | ||||
| :list_status => [ "o", "=", "!", "c", "*" ], | ||||
| :list_optional => [ "=", "!", "!*", "*" ], | ||||
|
Jean-Philippe Lang
|
r347 | :list_one_or_more => [ "*", "=" ], | ||
|
Jean-Philippe Lang
|
r693 | :date => [ "<t+", ">t+", "t+", "t", "w", ">t-", "<t-", "t-" ], | ||
| :date_past => [ ">t-", "<t-", "t-", "t", "w" ], | ||||
|
Jean-Philippe Lang
|
r444 | :string => [ "=", "~", "!", "!~" ], | ||
|
Jean-Philippe Lang
|
r710 | :text => [ "~", "!~" ], | ||
| :integer => [ "=", ">=", "<=" ] } | ||||
|
Jean-Philippe Lang
|
r92 | |||
| cattr_reader :operators_by_filter_type | ||||
|
Jean-Philippe Lang
|
r771 | @@available_columns = [ | ||
|
Jean-Philippe Lang
|
r774 | QueryColumn.new(:tracker, :sortable => "#{Tracker.table_name}.position"), | ||
| QueryColumn.new(:status, :sortable => "#{IssueStatus.table_name}.position"), | ||||
|
Jean-Philippe Lang
|
r790 | QueryColumn.new(:priority, :sortable => "#{Enumeration.table_name}.position"), | ||
|
Jean-Philippe Lang
|
r774 | QueryColumn.new(:subject), | ||
| QueryColumn.new(:assigned_to, :sortable => "#{User.table_name}.lastname"), | ||||
| QueryColumn.new(:updated_on, :sortable => "#{Issue.table_name}.updated_on"), | ||||
|
Jean-Philippe Lang
|
r771 | QueryColumn.new(:category, :sortable => "#{IssueCategory.table_name}.name"), | ||
|
Jean-Philippe Lang
|
r901 | QueryColumn.new(:fixed_version), | ||
|
Jean-Philippe Lang
|
r771 | QueryColumn.new(:start_date, :sortable => "#{Issue.table_name}.start_date"), | ||
| QueryColumn.new(:due_date, :sortable => "#{Issue.table_name}.due_date"), | ||||
| QueryColumn.new(:estimated_hours, :sortable => "#{Issue.table_name}.estimated_hours"), | ||||
| QueryColumn.new(:done_ratio, :sortable => "#{Issue.table_name}.done_ratio"), | ||||
| QueryColumn.new(:created_on, :sortable => "#{Issue.table_name}.created_on"), | ||||
| ] | ||||
| cattr_reader :available_columns | ||||
|
Jean-Philippe Lang
|
r92 | def initialize(attributes = nil) | ||
| super attributes | ||||
| self.filters ||= { 'status_id' => {:operator => "o", :values => [""]} } | ||||
|
Jean-Philippe Lang
|
r906 | @executed_by = User.current.logged? ? User.current : nil | ||
| set_language_if_valid(executed_by.language) if executed_by | ||||
|
Jean-Philippe Lang
|
r517 | end | ||
|
Jean-Philippe Lang
|
r92 | def validate | ||
| filters.each_key do |field| | ||||
|
Jean-Philippe Lang
|
r444 | errors.add label_for(field), :activerecord_error_blank unless | ||
|
Jean-Philippe Lang
|
r92 | # filter requires one or more values | ||
| (values_for(field) and !values_for(field).first.empty?) or | ||||
| # filter doesn't require any value | ||||
|
Jean-Philippe Lang
|
r693 | ["o", "c", "!*", "*", "t", "w"].include? operator_for(field) | ||
|
Jean-Philippe Lang
|
r92 | end if filters | ||
| end | ||||
|
Jean-Philippe Lang
|
r563 | def editable_by?(user) | ||
| return false unless user | ||||
| return true if !is_public && self.user_id == user.id | ||||
|
Jean-Philippe Lang
|
r767 | is_public && user.allowed_to?(:manage_public_queries, project) | ||
|
Jean-Philippe Lang
|
r563 | end | ||
|
Jean-Philippe Lang
|
r92 | def available_filters | ||
| return @available_filters if @available_filters | ||||
|
Jean-Philippe Lang
|
r202 | @available_filters = { "status_id" => { :type => :list_status, :order => 1, :values => IssueStatus.find(:all, :order => 'position').collect{|s| [s.name, s.id.to_s] } }, | ||
|
Jean-Philippe Lang
|
r206 | "tracker_id" => { :type => :list, :order => 2, :values => Tracker.find(:all, :order => 'position').collect{|s| [s.name, s.id.to_s] } }, | ||
|
Jean-Philippe Lang
|
r92 | "priority_id" => { :type => :list, :order => 3, :values => Enumeration.find(:all, :conditions => ['opt=?','IPRI']).collect{|s| [s.name, s.id.to_s] } }, | ||
|
Jean-Philippe Lang
|
r162 | "subject" => { :type => :text, :order => 8 }, | ||
| "created_on" => { :type => :date_past, :order => 9 }, | ||||
| "updated_on" => { :type => :date_past, :order => 10 }, | ||||
| "start_date" => { :type => :date, :order => 11 }, | ||||
|
Jean-Philippe Lang
|
r710 | "due_date" => { :type => :date, :order => 12 }, | ||
| "done_ratio" => { :type => :integer, :order => 13 }} | ||||
|
Jean-Philippe Lang
|
r673 | |||
| user_values = [] | ||||
|
Jean-Philippe Lang
|
r872 | user_values << ["<< #{l(:label_me)} >>", "me"] if executed_by | ||
|
Jean-Philippe Lang
|
r673 | if project | ||
|
Jean-Philippe Lang
|
r926 | user_values += project.users.sort.collect{|s| [s.name, s.id.to_s] } | ||
|
Jean-Philippe Lang
|
r673 | elsif executed_by | ||
| # members of the user's projects | ||||
| user_values += executed_by.projects.collect(&:users).flatten.uniq.sort.collect{|s| [s.name, s.id.to_s] } | ||||
| end | ||||
| @available_filters["assigned_to_id"] = { :type => :list_optional, :order => 4, :values => user_values } unless user_values.empty? | ||||
| @available_filters["author_id"] = { :type => :list, :order => 5, :values => user_values } unless user_values.empty? | ||||
| if project | ||||
| # project specific filters | ||||
|
Jean-Philippe Lang
|
r92 | @available_filters["category_id"] = { :type => :list_optional, :order => 6, :values => @project.issue_categories.collect{|s| [s.name, s.id.to_s] } } | ||
|
Jean-Philippe Lang
|
r533 | @available_filters["fixed_version_id"] = { :type => :list_optional, :order => 7, :values => @project.versions.sort.collect{|s| [s.name, s.id.to_s] } } | ||
|
Jean-Philippe Lang
|
r546 | unless @project.active_children.empty? | ||
| @available_filters["subproject_id"] = { :type => :list_one_or_more, :order => 13, :values => @project.active_children.collect{|s| [s.name, s.id.to_s] } } | ||||
|
Jean-Philippe Lang
|
r347 | end | ||
|
Jean-Philippe Lang
|
r444 | @project.all_custom_fields.select(&:is_filter?).each do |field| | ||
| case field.field_format | ||||
| when "text" | ||||
| options = { :type => :text, :order => 20 } | ||||
| when "list" | ||||
| options = { :type => :list_optional, :values => field.possible_values, :order => 20} | ||||
| when "date" | ||||
| options = { :type => :date, :order => 20 } | ||||
| when "bool" | ||||
| options = { :type => :list, :values => [[l(:general_text_yes), "1"], [l(:general_text_no), "0"]], :order => 20 } | ||||
|
Jean-Philippe Lang
|
r908 | else | ||
| options = { :type => :string, :order => 20 } | ||||
|
Jean-Philippe Lang
|
r444 | end | ||
| @available_filters["cf_#{field.id}"] = options.merge({ :name => field.name }) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r92 | # remove category filter if no category defined | ||
| @available_filters.delete "category_id" if @available_filters["category_id"][:values].empty? | ||||
| end | ||||
| @available_filters | ||||
| end | ||||
| def add_filter(field, operator, values) | ||||
| # values must be an array | ||||
| return unless values and values.is_a? Array # and !values.first.empty? | ||||
| # check if field is defined as an available filter | ||||
| if available_filters.has_key? field | ||||
| filter_options = available_filters[field] | ||||
| # check if operator is allowed for that filter | ||||
| #if @@operators_by_filter_type[filter_options[:type]].include? operator | ||||
| # allowed_values = values & ([""] + (filter_options[:values] || []).collect {|val| val[1]}) | ||||
| # filters[field] = {:operator => operator, :values => allowed_values } if (allowed_values.first and !allowed_values.first.empty?) or ["o", "c", "!*", "*", "t"].include? operator | ||||
| #end | ||||
| filters[field] = {:operator => operator, :values => values } | ||||
| end | ||||
| end | ||||
| def add_short_filter(field, expression) | ||||
| return unless expression | ||||
| parms = expression.scan(/^(o|c|\!|\*)?(.*)$/).first | ||||
| add_filter field, (parms[0] || "="), [parms[1] || ""] | ||||
| end | ||||
| def has_filter?(field) | ||||
| filters and filters[field] | ||||
| end | ||||
| def operator_for(field) | ||||
| has_filter?(field) ? filters[field][:operator] : nil | ||||
| end | ||||
| def values_for(field) | ||||
| has_filter?(field) ? filters[field][:values] : nil | ||||
| end | ||||
|
Jean-Philippe Lang
|
r444 | def label_for(field) | ||
| label = @available_filters[field][:name] if @available_filters.has_key?(field) | ||||
| label ||= field.gsub(/\_id$/, "") | ||||
| end | ||||
|
Jean-Philippe Lang
|
r771 | |||
| def available_columns | ||||
|
Jean-Philippe Lang
|
r876 | return @available_columns if @available_columns | ||
| @available_columns = Query.available_columns | ||||
| @available_columns += (project ? | ||||
| project.custom_fields : | ||||
| IssueCustomField.find(:all, :conditions => {:is_for_all => true}) | ||||
| ).collect {|cf| QueryCustomFieldColumn.new(cf) } | ||||
|
Jean-Philippe Lang
|
r771 | end | ||
|
Jean-Philippe Lang
|
r444 | |||
|
Jean-Philippe Lang
|
r771 | def columns | ||
|
Jean-Philippe Lang
|
r772 | if has_default_columns? | ||
|
Jean-Philippe Lang
|
r774 | available_columns.select {|c| Setting.issue_list_default_columns.include?(c.name.to_s) } | ||
|
Jean-Philippe Lang
|
r772 | else | ||
|
Jean-Philippe Lang
|
r773 | # preserve the column_names order | ||
| column_names.collect {|name| available_columns.find {|col| col.name == name}}.compact | ||||
|
Jean-Philippe Lang
|
r771 | end | ||
| end | ||||
| def column_names=(names) | ||||
| names = names.select {|n| n.is_a?(Symbol) || !n.blank? } if names | ||||
| names = names.collect {|n| n.is_a?(Symbol) ? n : n.to_sym } if names | ||||
| write_attribute(:column_names, names) | ||||
| end | ||||
| def has_column?(column) | ||||
| column_names && column_names.include?(column.name) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r772 | |||
| def has_default_columns? | ||||
| column_names.nil? || column_names.empty? | ||||
| end | ||||
|
Jean-Philippe Lang
|
r771 | |||
|
Jean-Philippe Lang
|
r92 | def statement | ||
|
Jean-Philippe Lang
|
r662 | # project/subprojects clause | ||
| clause = '' | ||||
|
Jean-Philippe Lang
|
r673 | if project && has_filter?("subproject_id") | ||
|
Jean-Philippe Lang
|
r347 | subproject_ids = [] | ||
| if operator_for("subproject_id") == "=" | ||||
| subproject_ids = values_for("subproject_id").each(&:to_i) | ||||
| else | ||||
|
Jean-Philippe Lang
|
r546 | subproject_ids = project.active_children.collect{|p| p.id} | ||
|
Jean-Philippe Lang
|
r347 | end | ||
|
Jean-Philippe Lang
|
r662 | clause << "#{Issue.table_name}.project_id IN (%d,%s)" % [project.id, subproject_ids.join(",")] if project | ||
|
Jean-Philippe Lang
|
r673 | elsif project | ||
| clause << "#{Issue.table_name}.project_id=%d" % project.id | ||||
|
Jean-Philippe Lang
|
r347 | else | ||
|
Jean-Philippe Lang
|
r673 | clause << Project.visible_by(executed_by) | ||
|
Jean-Philippe Lang
|
r347 | end | ||
|
Jean-Philippe Lang
|
r662 | |||
| # filters clauses | ||||
| filters_clauses = [] | ||||
|
Jean-Philippe Lang
|
r92 | filters.each_key do |field| | ||
|
Jean-Philippe Lang
|
r347 | next if field == "subproject_id" | ||
|
Jean-Philippe Lang
|
r517 | v = values_for(field).clone | ||
|
Jean-Philippe Lang
|
r444 | next unless v and !v.empty? | ||
|
Jean-Philippe Lang
|
r662 | |||
| sql = '' | ||||
|
Jean-Philippe Lang
|
r444 | if field =~ /^cf_(\d+)$/ | ||
| # custom field | ||||
| db_table = CustomValue.table_name | ||||
|
Jean-Philippe Lang
|
r662 | db_field = 'value' | ||
| sql << "#{Issue.table_name}.id IN (SELECT #{db_table}.customized_id FROM #{db_table} where #{db_table}.customized_type='Issue' AND #{db_table}.customized_id=#{Issue.table_name}.id AND #{db_table}.custom_field_id=#{$1} AND " | ||||
|
Jean-Philippe Lang
|
r444 | else | ||
| # regular field | ||||
| db_table = Issue.table_name | ||||
| db_field = field | ||||
|
Jean-Philippe Lang
|
r662 | sql << '(' | ||
|
Jean-Philippe Lang
|
r444 | end | ||
|
Jean-Philippe Lang
|
r517 | # "me" value subsitution | ||
| if %w(assigned_to_id author_id).include?(field) | ||||
| v.push(executed_by ? executed_by.id.to_s : "0") if v.delete("me") | ||||
| end | ||||
|
Jean-Philippe Lang
|
r92 | case operator_for field | ||
| when "=" | ||||
|
Jean-Philippe Lang
|
r444 | sql = sql + "#{db_table}.#{db_field} IN (" + v.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + ")" | ||
|
Jean-Philippe Lang
|
r92 | when "!" | ||
|
Jean-Philippe Lang
|
r444 | sql = sql + "#{db_table}.#{db_field} NOT IN (" + v.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + ")" | ||
|
Jean-Philippe Lang
|
r92 | when "!*" | ||
|
Jean-Philippe Lang
|
r444 | sql = sql + "#{db_table}.#{db_field} IS NULL" | ||
|
Jean-Philippe Lang
|
r92 | when "*" | ||
|
Jean-Philippe Lang
|
r444 | sql = sql + "#{db_table}.#{db_field} IS NOT NULL" | ||
|
Jean-Philippe Lang
|
r710 | when ">=" | ||
| sql = sql + "#{db_table}.#{db_field} >= #{v.first.to_i}" | ||||
| when "<=" | ||||
| sql = sql + "#{db_table}.#{db_field} <= #{v.first.to_i}" | ||||
|
Jean-Philippe Lang
|
r92 | when "o" | ||
|
Jean-Philippe Lang
|
r334 | sql = sql + "#{IssueStatus.table_name}.is_closed=#{connection.quoted_false}" if field == "status_id" | ||
|
Jean-Philippe Lang
|
r92 | when "c" | ||
|
Jean-Philippe Lang
|
r334 | sql = sql + "#{IssueStatus.table_name}.is_closed=#{connection.quoted_true}" if field == "status_id" | ||
|
Jean-Philippe Lang
|
r92 | when ">t-" | ||
|
Jean-Philippe Lang
|
r551 | sql = sql + "#{db_table}.#{db_field} BETWEEN '%s' AND '%s'" % [connection.quoted_date((Date.today - v.first.to_i).to_time), connection.quoted_date((Date.today + 1).to_time)] | ||
|
Jean-Philippe Lang
|
r92 | when "<t-" | ||
|
Jean-Philippe Lang
|
r551 | sql = sql + "#{db_table}.#{db_field} <= '%s'" % connection.quoted_date((Date.today - v.first.to_i).to_time) | ||
|
Jean-Philippe Lang
|
r92 | when "t-" | ||
|
Jean-Philippe Lang
|
r551 | sql = sql + "#{db_table}.#{db_field} BETWEEN '%s' AND '%s'" % [connection.quoted_date((Date.today - v.first.to_i).to_time), connection.quoted_date((Date.today - v.first.to_i + 1).to_time)] | ||
|
Jean-Philippe Lang
|
r92 | when ">t+" | ||
|
Jean-Philippe Lang
|
r551 | sql = sql + "#{db_table}.#{db_field} >= '%s'" % connection.quoted_date((Date.today + v.first.to_i).to_time) | ||
|
Jean-Philippe Lang
|
r92 | when "<t+" | ||
|
Jean-Philippe Lang
|
r551 | sql = sql + "#{db_table}.#{db_field} BETWEEN '%s' AND '%s'" % [connection.quoted_date(Date.today.to_time), connection.quoted_date((Date.today + v.first.to_i + 1).to_time)] | ||
|
Jean-Philippe Lang
|
r92 | when "t+" | ||
|
Jean-Philippe Lang
|
r551 | sql = sql + "#{db_table}.#{db_field} BETWEEN '%s' AND '%s'" % [connection.quoted_date((Date.today + v.first.to_i).to_time), connection.quoted_date((Date.today + v.first.to_i + 1).to_time)] | ||
|
Jean-Philippe Lang
|
r92 | when "t" | ||
|
Jean-Philippe Lang
|
r551 | sql = sql + "#{db_table}.#{db_field} BETWEEN '%s' AND '%s'" % [connection.quoted_date(Date.today.to_time), connection.quoted_date((Date.today+1).to_time)] | ||
|
Jean-Philippe Lang
|
r693 | when "w" | ||
|
Jean-Philippe Lang
|
r698 | sql = sql + "#{db_table}.#{db_field} BETWEEN '%s' AND '%s'" % [connection.quoted_date(Time.now.at_beginning_of_week), connection.quoted_date(Time.now.next_week.yesterday)] | ||
|
Jean-Philippe Lang
|
r92 | when "~" | ||
|
Jean-Philippe Lang
|
r444 | sql = sql + "#{db_table}.#{db_field} LIKE '%#{connection.quote_string(v.first)}%'" | ||
|
Jean-Philippe Lang
|
r92 | when "!~" | ||
|
Jean-Philippe Lang
|
r444 | sql = sql + "#{db_table}.#{db_field} NOT LIKE '%#{connection.quote_string(v.first)}%'" | ||
|
Jean-Philippe Lang
|
r92 | end | ||
|
Jean-Philippe Lang
|
r662 | sql << ')' | ||
| filters_clauses << sql | ||||
|
Jean-Philippe Lang
|
r92 | end if filters and valid? | ||
|
Jean-Philippe Lang
|
r662 | |||
|
Jean-Philippe Lang
|
r673 | clause << ' AND ' unless clause.empty? | ||
| clause << filters_clauses.join(' AND ') unless filters_clauses.empty? | ||||
|
Jean-Philippe Lang
|
r662 | clause | ||
|
Jean-Philippe Lang
|
r92 | end | ||
| end | ||||