You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

query.rb 34KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865
  1. # Redmine - project management software
  2. # Copyright (C) 2006-2011 Jean-Philippe Lang
  3. #
  4. # This program is free software; you can redistribute it and/or
  5. # modify it under the terms of the GNU General Public License
  6. # as published by the Free Software Foundation; either version 2
  7. # of the License, or (at your option) any later version.
  8. #
  9. # This program is distributed in the hope that it will be useful,
  10. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. # GNU General Public License for more details.
  13. #
  14. # You should have received a copy of the GNU General Public License
  15. # along with this program; if not, write to the Free Software
  16. # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17. class QueryColumn
  18. attr_accessor :name, :sortable, :groupable, :default_order
  19. include Redmine::I18n
  20. def initialize(name, options={})
  21. self.name = name
  22. self.sortable = options[:sortable]
  23. self.groupable = options[:groupable] || false
  24. if groupable == true
  25. self.groupable = name.to_s
  26. end
  27. self.default_order = options[:default_order]
  28. @caption_key = options[:caption] || "field_#{name}"
  29. end
  30. def caption
  31. l(@caption_key)
  32. end
  33. # Returns true if the column is sortable, otherwise false
  34. def sortable?
  35. !@sortable.nil?
  36. end
  37. def sortable
  38. @sortable.is_a?(Proc) ? @sortable.call : @sortable
  39. end
  40. def value(issue)
  41. issue.send name
  42. end
  43. def css_classes
  44. name
  45. end
  46. end
  47. class QueryCustomFieldColumn < QueryColumn
  48. def initialize(custom_field)
  49. self.name = "cf_#{custom_field.id}".to_sym
  50. self.sortable = custom_field.order_statement || false
  51. if %w(list date bool int).include?(custom_field.field_format) && !custom_field.multiple?
  52. self.groupable = custom_field.order_statement
  53. end
  54. self.groupable ||= false
  55. @cf = custom_field
  56. end
  57. def caption
  58. @cf.name
  59. end
  60. def custom_field
  61. @cf
  62. end
  63. def value(issue)
  64. cv = issue.custom_values.select {|v| v.custom_field_id == @cf.id}.collect {|v| @cf.cast_value(v.value)}
  65. cv.size > 1 ? cv : cv.first
  66. end
  67. def css_classes
  68. @css_classes ||= "#{name} #{@cf.field_format}"
  69. end
  70. end
  71. class Query < ActiveRecord::Base
  72. class StatementInvalid < ::ActiveRecord::StatementInvalid
  73. end
  74. belongs_to :project
  75. belongs_to :user
  76. serialize :filters
  77. serialize :column_names
  78. serialize :sort_criteria, Array
  79. attr_protected :project_id, :user_id
  80. validates_presence_of :name
  81. validates_length_of :name, :maximum => 255
  82. validate :validate_query_filters
  83. @@operators = { "=" => :label_equals,
  84. "!" => :label_not_equals,
  85. "o" => :label_open_issues,
  86. "c" => :label_closed_issues,
  87. "!*" => :label_none,
  88. "*" => :label_all,
  89. ">=" => :label_greater_or_equal,
  90. "<=" => :label_less_or_equal,
  91. "><" => :label_between,
  92. "<t+" => :label_in_less_than,
  93. ">t+" => :label_in_more_than,
  94. "t+" => :label_in,
  95. "t" => :label_today,
  96. "w" => :label_this_week,
  97. ">t-" => :label_less_than_ago,
  98. "<t-" => :label_more_than_ago,
  99. "t-" => :label_ago,
  100. "~" => :label_contains,
  101. "!~" => :label_not_contains }
  102. cattr_reader :operators
  103. @@operators_by_filter_type = { :list => [ "=", "!" ],
  104. :list_status => [ "o", "=", "!", "c", "*" ],
  105. :list_optional => [ "=", "!", "!*", "*" ],
  106. :list_subprojects => [ "*", "!*", "=" ],
  107. :date => [ "=", ">=", "<=", "><", "<t+", ">t+", "t+", "t", "w", ">t-", "<t-", "t-", "!*", "*" ],
  108. :date_past => [ "=", ">=", "<=", "><", ">t-", "<t-", "t-", "t", "w", "!*", "*" ],
  109. :string => [ "=", "~", "!", "!~", "!*", "*" ],
  110. :text => [ "~", "!~", "!*", "*" ],
  111. :integer => [ "=", ">=", "<=", "><", "!*", "*" ],
  112. :float => [ "=", ">=", "<=", "><", "!*", "*" ] }
  113. cattr_reader :operators_by_filter_type
  114. @@available_columns = [
  115. QueryColumn.new(:project, :sortable => "#{Project.table_name}.name", :groupable => true),
  116. QueryColumn.new(:tracker, :sortable => "#{Tracker.table_name}.position", :groupable => true),
  117. QueryColumn.new(:parent, :sortable => ["#{Issue.table_name}.root_id", "#{Issue.table_name}.lft ASC"], :default_order => 'desc', :caption => :field_parent_issue),
  118. QueryColumn.new(:status, :sortable => "#{IssueStatus.table_name}.position", :groupable => true),
  119. QueryColumn.new(:priority, :sortable => "#{IssuePriority.table_name}.position", :default_order => 'desc', :groupable => true),
  120. QueryColumn.new(:subject, :sortable => "#{Issue.table_name}.subject"),
  121. QueryColumn.new(:author, :sortable => lambda {User.fields_for_order_statement("authors")}, :groupable => true),
  122. QueryColumn.new(:assigned_to, :sortable => lambda {User.fields_for_order_statement}, :groupable => true),
  123. QueryColumn.new(:updated_on, :sortable => "#{Issue.table_name}.updated_on", :default_order => 'desc'),
  124. QueryColumn.new(:category, :sortable => "#{IssueCategory.table_name}.name", :groupable => true),
  125. QueryColumn.new(:fixed_version, :sortable => ["#{Version.table_name}.effective_date", "#{Version.table_name}.name"], :default_order => 'desc', :groupable => true),
  126. QueryColumn.new(:start_date, :sortable => "#{Issue.table_name}.start_date"),
  127. QueryColumn.new(:due_date, :sortable => "#{Issue.table_name}.due_date"),
  128. QueryColumn.new(:estimated_hours, :sortable => "#{Issue.table_name}.estimated_hours"),
  129. QueryColumn.new(:done_ratio, :sortable => "#{Issue.table_name}.done_ratio", :groupable => true),
  130. QueryColumn.new(:created_on, :sortable => "#{Issue.table_name}.created_on", :default_order => 'desc'),
  131. ]
  132. cattr_reader :available_columns
  133. named_scope :visible, lambda {|*args|
  134. user = args.shift || User.current
  135. base = Project.allowed_to_condition(user, :view_issues, *args)
  136. user_id = user.logged? ? user.id : 0
  137. {
  138. :conditions => ["(#{table_name}.project_id IS NULL OR (#{base})) AND (#{table_name}.is_public = ? OR #{table_name}.user_id = ?)", true, user_id],
  139. :include => :project
  140. }
  141. }
  142. def initialize(attributes=nil, *args)
  143. super attributes
  144. self.filters ||= { 'status_id' => {:operator => "o", :values => [""]} }
  145. @is_for_all = project.nil?
  146. end
  147. def validate_query_filters
  148. filters.each_key do |field|
  149. if values_for(field)
  150. case type_for(field)
  151. when :integer
  152. add_filter_error(field, :invalid) if values_for(field).detect {|v| v.present? && !v.match(/^\d+$/) }
  153. when :float
  154. add_filter_error(field, :invalid) if values_for(field).detect {|v| v.present? && !v.match(/^\d+(\.\d*)?$/) }
  155. when :date, :date_past
  156. case operator_for(field)
  157. when "=", ">=", "<=", "><"
  158. add_filter_error(field, :invalid) if values_for(field).detect {|v| v.present? && (!v.match(/^\d{4}-\d{2}-\d{2}$/) || (Date.parse(v) rescue nil).nil?) }
  159. when ">t-", "<t-", "t-"
  160. add_filter_error(field, :invalid) if values_for(field).detect {|v| v.present? && !v.match(/^\d+$/) }
  161. end
  162. end
  163. end
  164. add_filter_error(field, :blank) unless
  165. # filter requires one or more values
  166. (values_for(field) and !values_for(field).first.blank?) or
  167. # filter doesn't require any value
  168. ["o", "c", "!*", "*", "t", "w"].include? operator_for(field)
  169. end if filters
  170. end
  171. def add_filter_error(field, message)
  172. m = label_for(field) + " " + l(message, :scope => 'activerecord.errors.messages')
  173. errors.add(:base, m)
  174. end
  175. # Returns true if the query is visible to +user+ or the current user.
  176. def visible?(user=User.current)
  177. (project.nil? || user.allowed_to?(:view_issues, project)) && (self.is_public? || self.user_id == user.id)
  178. end
  179. def editable_by?(user)
  180. return false unless user
  181. # Admin can edit them all and regular users can edit their private queries
  182. return true if user.admin? || (!is_public && self.user_id == user.id)
  183. # Members can not edit public queries that are for all project (only admin is allowed to)
  184. is_public && !@is_for_all && user.allowed_to?(:manage_public_queries, project)
  185. end
  186. def available_filters
  187. return @available_filters if @available_filters
  188. trackers = project.nil? ? Tracker.find(:all, :order => 'position') : project.rolled_up_trackers
  189. @available_filters = { "status_id" => { :type => :list_status, :order => 1, :values => IssueStatus.find(:all, :order => 'position').collect{|s| [s.name, s.id.to_s] } },
  190. "tracker_id" => { :type => :list, :order => 2, :values => trackers.collect{|s| [s.name, s.id.to_s] } },
  191. "priority_id" => { :type => :list, :order => 3, :values => IssuePriority.all.collect{|s| [s.name, s.id.to_s] } },
  192. "subject" => { :type => :text, :order => 8 },
  193. "created_on" => { :type => :date_past, :order => 9 },
  194. "updated_on" => { :type => :date_past, :order => 10 },
  195. "start_date" => { :type => :date, :order => 11 },
  196. "due_date" => { :type => :date, :order => 12 },
  197. "estimated_hours" => { :type => :float, :order => 13 },
  198. "done_ratio" => { :type => :integer, :order => 14 }}
  199. principals = []
  200. if project
  201. principals += project.principals.sort
  202. unless project.leaf?
  203. subprojects = project.descendants.visible.all
  204. if subprojects.any?
  205. @available_filters["subproject_id"] = { :type => :list_subprojects, :order => 13, :values => subprojects.collect{|s| [s.name, s.id.to_s] } }
  206. principals += Principal.member_of(subprojects)
  207. end
  208. end
  209. else
  210. all_projects = Project.visible.all
  211. if all_projects.any?
  212. # members of visible projects
  213. principals += Principal.member_of(all_projects)
  214. # project filter
  215. project_values = []
  216. if User.current.logged? && User.current.memberships.any?
  217. project_values << ["<< #{l(:label_my_projects).downcase} >>", "mine"]
  218. end
  219. Project.project_tree(all_projects) do |p, level|
  220. prefix = (level > 0 ? ('--' * level + ' ') : '')
  221. project_values << ["#{prefix}#{p.name}", p.id.to_s]
  222. end
  223. @available_filters["project_id"] = { :type => :list, :order => 1, :values => project_values} unless project_values.empty?
  224. end
  225. end
  226. principals.uniq!
  227. principals.sort!
  228. users = principals.select {|p| p.is_a?(User)}
  229. assigned_to_values = []
  230. assigned_to_values << ["<< #{l(:label_me)} >>", "me"] if User.current.logged?
  231. assigned_to_values += (Setting.issue_group_assignment? ? principals : users).collect{|s| [s.name, s.id.to_s] }
  232. @available_filters["assigned_to_id"] = { :type => :list_optional, :order => 4, :values => assigned_to_values } unless assigned_to_values.empty?
  233. author_values = []
  234. author_values << ["<< #{l(:label_me)} >>", "me"] if User.current.logged?
  235. author_values += users.collect{|s| [s.name, s.id.to_s] }
  236. @available_filters["author_id"] = { :type => :list, :order => 5, :values => author_values } unless author_values.empty?
  237. group_values = Group.all.collect {|g| [g.name, g.id.to_s] }
  238. @available_filters["member_of_group"] = { :type => :list_optional, :order => 6, :values => group_values } unless group_values.empty?
  239. role_values = Role.givable.collect {|r| [r.name, r.id.to_s] }
  240. @available_filters["assigned_to_role"] = { :type => :list_optional, :order => 7, :values => role_values } unless role_values.empty?
  241. if User.current.logged?
  242. @available_filters["watcher_id"] = { :type => :list, :order => 15, :values => [["<< #{l(:label_me)} >>", "me"]] }
  243. end
  244. if project
  245. # project specific filters
  246. categories = project.issue_categories.all
  247. unless categories.empty?
  248. @available_filters["category_id"] = { :type => :list_optional, :order => 6, :values => categories.collect{|s| [s.name, s.id.to_s] } }
  249. end
  250. versions = project.shared_versions.all
  251. unless versions.empty?
  252. @available_filters["fixed_version_id"] = { :type => :list_optional, :order => 7, :values => versions.sort.collect{|s| ["#{s.project.name} - #{s.name}", s.id.to_s] } }
  253. end
  254. add_custom_fields_filters(project.all_issue_custom_fields)
  255. else
  256. # global filters for cross project issue list
  257. system_shared_versions = Version.visible.find_all_by_sharing('system')
  258. unless system_shared_versions.empty?
  259. @available_filters["fixed_version_id"] = { :type => :list_optional, :order => 7, :values => system_shared_versions.sort.collect{|s| ["#{s.project.name} - #{s.name}", s.id.to_s] } }
  260. end
  261. add_custom_fields_filters(IssueCustomField.find(:all, :conditions => {:is_filter => true, :is_for_all => true}))
  262. end
  263. @available_filters
  264. end
  265. def add_filter(field, operator, values)
  266. # values must be an array
  267. return unless values.nil? || values.is_a?(Array)
  268. # check if field is defined as an available filter
  269. if available_filters.has_key? field
  270. filter_options = available_filters[field]
  271. # check if operator is allowed for that filter
  272. #if @@operators_by_filter_type[filter_options[:type]].include? operator
  273. # allowed_values = values & ([""] + (filter_options[:values] || []).collect {|val| val[1]})
  274. # filters[field] = {:operator => operator, :values => allowed_values } if (allowed_values.first and !allowed_values.first.empty?) or ["o", "c", "!*", "*", "t"].include? operator
  275. #end
  276. filters[field] = {:operator => operator, :values => (values || [''])}
  277. end
  278. end
  279. def add_short_filter(field, expression)
  280. return unless expression && available_filters.has_key?(field)
  281. field_type = available_filters[field][:type]
  282. @@operators_by_filter_type[field_type].sort.reverse.detect do |operator|
  283. next unless expression =~ /^#{Regexp.escape(operator)}(.*)$/
  284. add_filter field, operator, $1.present? ? $1.split('|') : ['']
  285. end || add_filter(field, '=', expression.split('|'))
  286. end
  287. # Add multiple filters using +add_filter+
  288. def add_filters(fields, operators, values)
  289. if fields.is_a?(Array) && operators.is_a?(Hash) && (values.nil? || values.is_a?(Hash))
  290. fields.each do |field|
  291. add_filter(field, operators[field], values && values[field])
  292. end
  293. end
  294. end
  295. def has_filter?(field)
  296. filters and filters[field]
  297. end
  298. def type_for(field)
  299. available_filters[field][:type] if available_filters.has_key?(field)
  300. end
  301. def operator_for(field)
  302. has_filter?(field) ? filters[field][:operator] : nil
  303. end
  304. def values_for(field)
  305. has_filter?(field) ? filters[field][:values] : nil
  306. end
  307. def value_for(field, index=0)
  308. (values_for(field) || [])[index]
  309. end
  310. def label_for(field)
  311. label = available_filters[field][:name] if available_filters.has_key?(field)
  312. label ||= l("field_#{field.to_s.gsub(/_id$/, '')}", :default => field)
  313. end
  314. def available_columns
  315. return @available_columns if @available_columns
  316. @available_columns = ::Query.available_columns.dup
  317. @available_columns += (project ?
  318. project.all_issue_custom_fields :
  319. IssueCustomField.find(:all)
  320. ).collect {|cf| QueryCustomFieldColumn.new(cf) }
  321. if User.current.allowed_to?(:view_time_entries, project, :global => true)
  322. index = nil
  323. @available_columns.each_with_index {|column, i| index = i if column.name == :estimated_hours}
  324. index = (index ? index + 1 : -1)
  325. # insert the column after estimated_hours or at the end
  326. @available_columns.insert index, QueryColumn.new(:spent_hours,
  327. :sortable => "(SELECT COALESCE(SUM(hours), 0) FROM #{TimeEntry.table_name} WHERE #{TimeEntry.table_name}.issue_id = #{Issue.table_name}.id)",
  328. :default_order => 'desc',
  329. :caption => :label_spent_time
  330. )
  331. end
  332. @available_columns
  333. end
  334. def self.available_columns=(v)
  335. self.available_columns = (v)
  336. end
  337. def self.add_available_column(column)
  338. self.available_columns << (column) if column.is_a?(QueryColumn)
  339. end
  340. # Returns an array of columns that can be used to group the results
  341. def groupable_columns
  342. available_columns.select {|c| c.groupable}
  343. end
  344. # Returns a Hash of columns and the key for sorting
  345. def sortable_columns
  346. {'id' => "#{Issue.table_name}.id"}.merge(available_columns.inject({}) {|h, column|
  347. h[column.name.to_s] = column.sortable
  348. h
  349. })
  350. end
  351. def columns
  352. # preserve the column_names order
  353. (has_default_columns? ? default_columns_names : column_names).collect do |name|
  354. available_columns.find { |col| col.name == name }
  355. end.compact
  356. end
  357. def default_columns_names
  358. @default_columns_names ||= begin
  359. default_columns = Setting.issue_list_default_columns.map(&:to_sym)
  360. project.present? ? default_columns : [:project] | default_columns
  361. end
  362. end
  363. def column_names=(names)
  364. if names
  365. names = names.select {|n| n.is_a?(Symbol) || !n.blank? }
  366. names = names.collect {|n| n.is_a?(Symbol) ? n : n.to_sym }
  367. # Set column_names to nil if default columns
  368. if names == default_columns_names
  369. names = nil
  370. end
  371. end
  372. write_attribute(:column_names, names)
  373. end
  374. def has_column?(column)
  375. column_names && column_names.include?(column.is_a?(QueryColumn) ? column.name : column)
  376. end
  377. def has_default_columns?
  378. column_names.nil? || column_names.empty?
  379. end
  380. def sort_criteria=(arg)
  381. c = []
  382. if arg.is_a?(Hash)
  383. arg = arg.keys.sort.collect {|k| arg[k]}
  384. end
  385. c = arg.select {|k,o| !k.to_s.blank?}.slice(0,3).collect {|k,o| [k.to_s, o == 'desc' ? o : 'asc']}
  386. write_attribute(:sort_criteria, c)
  387. end
  388. def sort_criteria
  389. read_attribute(:sort_criteria) || []
  390. end
  391. def sort_criteria_key(arg)
  392. sort_criteria && sort_criteria[arg] && sort_criteria[arg].first
  393. end
  394. def sort_criteria_order(arg)
  395. sort_criteria && sort_criteria[arg] && sort_criteria[arg].last
  396. end
  397. # Returns the SQL sort order that should be prepended for grouping
  398. def group_by_sort_order
  399. if grouped? && (column = group_by_column)
  400. column.sortable.is_a?(Array) ?
  401. column.sortable.collect {|s| "#{s} #{column.default_order}"}.join(',') :
  402. "#{column.sortable} #{column.default_order}"
  403. end
  404. end
  405. # Returns true if the query is a grouped query
  406. def grouped?
  407. !group_by_column.nil?
  408. end
  409. def group_by_column
  410. groupable_columns.detect {|c| c.groupable && c.name.to_s == group_by}
  411. end
  412. def group_by_statement
  413. group_by_column.try(:groupable)
  414. end
  415. def project_statement
  416. project_clauses = []
  417. if project && !project.descendants.active.empty?
  418. ids = [project.id]
  419. if has_filter?("subproject_id")
  420. case operator_for("subproject_id")
  421. when '='
  422. # include the selected subprojects
  423. ids += values_for("subproject_id").each(&:to_i)
  424. when '!*'
  425. # main project only
  426. else
  427. # all subprojects
  428. ids += project.descendants.collect(&:id)
  429. end
  430. elsif Setting.display_subprojects_issues?
  431. ids += project.descendants.collect(&:id)
  432. end
  433. project_clauses << "#{Project.table_name}.id IN (%s)" % ids.join(',')
  434. elsif project
  435. project_clauses << "#{Project.table_name}.id = %d" % project.id
  436. end
  437. project_clauses.any? ? project_clauses.join(' AND ') : nil
  438. end
  439. def statement
  440. # filters clauses
  441. filters_clauses = []
  442. filters.each_key do |field|
  443. next if field == "subproject_id"
  444. v = values_for(field).clone
  445. next unless v and !v.empty?
  446. operator = operator_for(field)
  447. # "me" value subsitution
  448. if %w(assigned_to_id author_id watcher_id).include?(field)
  449. if v.delete("me")
  450. if User.current.logged?
  451. v.push(User.current.id.to_s)
  452. v += User.current.group_ids.map(&:to_s) if field == 'assigned_to_id'
  453. else
  454. v.push("0")
  455. end
  456. end
  457. end
  458. if field == 'project_id'
  459. if v.delete('mine')
  460. v += User.current.memberships.map(&:project_id).map(&:to_s)
  461. end
  462. end
  463. if field =~ /^cf_(\d+)$/
  464. # custom field
  465. filters_clauses << sql_for_custom_field(field, operator, v, $1)
  466. elsif respond_to?("sql_for_#{field}_field")
  467. # specific statement
  468. filters_clauses << send("sql_for_#{field}_field", field, operator, v)
  469. else
  470. # regular field
  471. filters_clauses << '(' + sql_for_field(field, operator, v, Issue.table_name, field) + ')'
  472. end
  473. end if filters and valid?
  474. filters_clauses << project_statement
  475. filters_clauses.reject!(&:blank?)
  476. filters_clauses.any? ? filters_clauses.join(' AND ') : nil
  477. end
  478. # Returns the issue count
  479. def issue_count
  480. Issue.visible.count(:include => [:status, :project], :conditions => statement)
  481. rescue ::ActiveRecord::StatementInvalid => e
  482. raise StatementInvalid.new(e.message)
  483. end
  484. # Returns the issue count by group or nil if query is not grouped
  485. def issue_count_by_group
  486. r = nil
  487. if grouped?
  488. begin
  489. # Rails will raise an (unexpected) RecordNotFound if there's only a nil group value
  490. r = Issue.visible.count(:group => group_by_statement, :include => [:status, :project], :conditions => statement)
  491. rescue ActiveRecord::RecordNotFound
  492. r = {nil => issue_count}
  493. end
  494. c = group_by_column
  495. if c.is_a?(QueryCustomFieldColumn)
  496. r = r.keys.inject({}) {|h, k| h[c.custom_field.cast_value(k)] = r[k]; h}
  497. end
  498. end
  499. r
  500. rescue ::ActiveRecord::StatementInvalid => e
  501. raise StatementInvalid.new(e.message)
  502. end
  503. # Returns the issues
  504. # Valid options are :order, :offset, :limit, :include, :conditions
  505. def issues(options={})
  506. order_option = [group_by_sort_order, options[:order]].reject {|s| s.blank?}.join(',')
  507. order_option = nil if order_option.blank?
  508. joins = (order_option && order_option.include?('authors')) ? "LEFT OUTER JOIN users authors ON authors.id = #{Issue.table_name}.author_id" : nil
  509. issues = Issue.visible.scoped(:conditions => options[:conditions]).find :all, :include => ([:status, :project] + (options[:include] || [])).uniq,
  510. :conditions => statement,
  511. :order => order_option,
  512. :joins => joins,
  513. :limit => options[:limit],
  514. :offset => options[:offset]
  515. if has_column?(:spent_hours)
  516. Issue.load_visible_spent_hours(issues)
  517. end
  518. issues
  519. rescue ::ActiveRecord::StatementInvalid => e
  520. raise StatementInvalid.new(e.message)
  521. end
  522. # Returns the issues ids
  523. def issue_ids(options={})
  524. order_option = [group_by_sort_order, options[:order]].reject {|s| s.blank?}.join(',')
  525. order_option = nil if order_option.blank?
  526. joins = (order_option && order_option.include?('authors')) ? "LEFT OUTER JOIN users authors ON authors.id = #{Issue.table_name}.author_id" : nil
  527. Issue.visible.scoped(:conditions => options[:conditions]).scoped(:include => ([:status, :project] + (options[:include] || [])).uniq,
  528. :conditions => statement,
  529. :order => order_option,
  530. :joins => joins,
  531. :limit => options[:limit],
  532. :offset => options[:offset]).find_ids
  533. rescue ::ActiveRecord::StatementInvalid => e
  534. raise StatementInvalid.new(e.message)
  535. end
  536. # Returns the journals
  537. # Valid options are :order, :offset, :limit
  538. def journals(options={})
  539. Journal.visible.find :all, :include => [:details, :user, {:issue => [:project, :author, :tracker, :status]}],
  540. :conditions => statement,
  541. :order => options[:order],
  542. :limit => options[:limit],
  543. :offset => options[:offset]
  544. rescue ::ActiveRecord::StatementInvalid => e
  545. raise StatementInvalid.new(e.message)
  546. end
  547. # Returns the versions
  548. # Valid options are :conditions
  549. def versions(options={})
  550. Version.visible.scoped(:conditions => options[:conditions]).find :all, :include => :project, :conditions => project_statement
  551. rescue ::ActiveRecord::StatementInvalid => e
  552. raise StatementInvalid.new(e.message)
  553. end
  554. def sql_for_watcher_id_field(field, operator, value)
  555. db_table = Watcher.table_name
  556. "#{Issue.table_name}.id #{ operator == '=' ? 'IN' : 'NOT IN' } (SELECT #{db_table}.watchable_id FROM #{db_table} WHERE #{db_table}.watchable_type='Issue' AND " +
  557. sql_for_field(field, '=', value, db_table, 'user_id') + ')'
  558. end
  559. def sql_for_member_of_group_field(field, operator, value)
  560. if operator == '*' # Any group
  561. groups = Group.all
  562. operator = '=' # Override the operator since we want to find by assigned_to
  563. elsif operator == "!*"
  564. groups = Group.all
  565. operator = '!' # Override the operator since we want to find by assigned_to
  566. else
  567. groups = Group.find_all_by_id(value)
  568. end
  569. groups ||= []
  570. members_of_groups = groups.inject([]) {|user_ids, group|
  571. if group && group.user_ids.present?
  572. user_ids << group.user_ids
  573. end
  574. user_ids.flatten.uniq.compact
  575. }.sort.collect(&:to_s)
  576. '(' + sql_for_field("assigned_to_id", operator, members_of_groups, Issue.table_name, "assigned_to_id", false) + ')'
  577. end
  578. def sql_for_assigned_to_role_field(field, operator, value)
  579. case operator
  580. when "*", "!*" # Member / Not member
  581. sw = operator == "!*" ? 'NOT' : ''
  582. nl = operator == "!*" ? "#{Issue.table_name}.assigned_to_id IS NULL OR" : ''
  583. "(#{nl} #{Issue.table_name}.assigned_to_id #{sw} IN (SELECT DISTINCT #{Member.table_name}.user_id FROM #{Member.table_name}" +
  584. " WHERE #{Member.table_name}.project_id = #{Issue.table_name}.project_id))"
  585. when "=", "!"
  586. role_cond = value.any? ?
  587. "#{MemberRole.table_name}.role_id IN (" + value.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + ")" :
  588. "1=0"
  589. sw = operator == "!" ? 'NOT' : ''
  590. nl = operator == "!" ? "#{Issue.table_name}.assigned_to_id IS NULL OR" : ''
  591. "(#{nl} #{Issue.table_name}.assigned_to_id #{sw} IN (SELECT DISTINCT #{Member.table_name}.user_id FROM #{Member.table_name}, #{MemberRole.table_name}" +
  592. " WHERE #{Member.table_name}.project_id = #{Issue.table_name}.project_id AND #{Member.table_name}.id = #{MemberRole.table_name}.member_id AND #{role_cond}))"
  593. end
  594. end
  595. private
  596. def sql_for_custom_field(field, operator, value, custom_field_id)
  597. db_table = CustomValue.table_name
  598. db_field = 'value'
  599. filter = @available_filters[field]
  600. if filter && filter[:format] == 'user'
  601. if value.delete('me')
  602. value.push User.current.id.to_s
  603. end
  604. end
  605. not_in = nil
  606. if operator == '!'
  607. # Makes ! operator work for custom fields with multiple values
  608. operator = '='
  609. not_in = 'NOT'
  610. end
  611. "#{Issue.table_name}.id #{not_in} IN (SELECT #{Issue.table_name}.id FROM #{Issue.table_name} LEFT OUTER JOIN #{db_table} ON #{db_table}.customized_type='Issue' AND #{db_table}.customized_id=#{Issue.table_name}.id AND #{db_table}.custom_field_id=#{custom_field_id} WHERE " +
  612. sql_for_field(field, operator, value, db_table, db_field, true) + ')'
  613. end
  614. # Helper method to generate the WHERE sql for a +field+, +operator+ and a +value+
  615. def sql_for_field(field, operator, value, db_table, db_field, is_custom_filter=false)
  616. sql = ''
  617. case operator
  618. when "="
  619. if value.any?
  620. case type_for(field)
  621. when :date, :date_past
  622. sql = date_clause(db_table, db_field, (Date.parse(value.first) rescue nil), (Date.parse(value.first) rescue nil))
  623. when :integer
  624. if is_custom_filter
  625. sql = "(#{db_table}.#{db_field} <> '' AND CAST(#{db_table}.#{db_field} AS decimal(60,3)) = #{value.first.to_i})"
  626. else
  627. sql = "#{db_table}.#{db_field} = #{value.first.to_i}"
  628. end
  629. when :float
  630. if is_custom_filter
  631. sql = "(#{db_table}.#{db_field} <> '' AND CAST(#{db_table}.#{db_field} AS decimal(60,3)) BETWEEN #{value.first.to_f - 1e-5} AND #{value.first.to_f + 1e-5})"
  632. else
  633. sql = "#{db_table}.#{db_field} BETWEEN #{value.first.to_f - 1e-5} AND #{value.first.to_f + 1e-5}"
  634. end
  635. else
  636. sql = "#{db_table}.#{db_field} IN (" + value.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + ")"
  637. end
  638. else
  639. # IN an empty set
  640. sql = "1=0"
  641. end
  642. when "!"
  643. if value.any?
  644. sql = "(#{db_table}.#{db_field} IS NULL OR #{db_table}.#{db_field} NOT IN (" + value.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + "))"
  645. else
  646. # NOT IN an empty set
  647. sql = "1=1"
  648. end
  649. when "!*"
  650. sql = "#{db_table}.#{db_field} IS NULL"
  651. sql << " OR #{db_table}.#{db_field} = ''" if is_custom_filter
  652. when "*"
  653. sql = "#{db_table}.#{db_field} IS NOT NULL"
  654. sql << " AND #{db_table}.#{db_field} <> ''" if is_custom_filter
  655. when ">="
  656. if [:date, :date_past].include?(type_for(field))
  657. sql = date_clause(db_table, db_field, (Date.parse(value.first) rescue nil), nil)
  658. else
  659. if is_custom_filter
  660. sql = "(#{db_table}.#{db_field} <> '' AND CAST(#{db_table}.#{db_field} AS decimal(60,3)) >= #{value.first.to_f})"
  661. else
  662. sql = "#{db_table}.#{db_field} >= #{value.first.to_f}"
  663. end
  664. end
  665. when "<="
  666. if [:date, :date_past].include?(type_for(field))
  667. sql = date_clause(db_table, db_field, nil, (Date.parse(value.first) rescue nil))
  668. else
  669. if is_custom_filter
  670. sql = "(#{db_table}.#{db_field} <> '' AND CAST(#{db_table}.#{db_field} AS decimal(60,3)) <= #{value.first.to_f})"
  671. else
  672. sql = "#{db_table}.#{db_field} <= #{value.first.to_f}"
  673. end
  674. end
  675. when "><"
  676. if [:date, :date_past].include?(type_for(field))
  677. sql = date_clause(db_table, db_field, (Date.parse(value[0]) rescue nil), (Date.parse(value[1]) rescue nil))
  678. else
  679. if is_custom_filter
  680. sql = "(#{db_table}.#{db_field} <> '' AND CAST(#{db_table}.#{db_field} AS decimal(60,3)) BETWEEN #{value[0].to_f} AND #{value[1].to_f})"
  681. else
  682. sql = "#{db_table}.#{db_field} BETWEEN #{value[0].to_f} AND #{value[1].to_f}"
  683. end
  684. end
  685. when "o"
  686. sql = "#{Issue.table_name}.status_id IN (SELECT id FROM #{IssueStatus.table_name} WHERE is_closed=#{connection.quoted_false})" if field == "status_id"
  687. when "c"
  688. sql = "#{Issue.table_name}.status_id IN (SELECT id FROM #{IssueStatus.table_name} WHERE is_closed=#{connection.quoted_true})" if field == "status_id"
  689. when ">t-"
  690. sql = relative_date_clause(db_table, db_field, - value.first.to_i, 0)
  691. when "<t-"
  692. sql = relative_date_clause(db_table, db_field, nil, - value.first.to_i)
  693. when "t-"
  694. sql = relative_date_clause(db_table, db_field, - value.first.to_i, - value.first.to_i)
  695. when ">t+"
  696. sql = relative_date_clause(db_table, db_field, value.first.to_i, nil)
  697. when "<t+"
  698. sql = relative_date_clause(db_table, db_field, 0, value.first.to_i)
  699. when "t+"
  700. sql = relative_date_clause(db_table, db_field, value.first.to_i, value.first.to_i)
  701. when "t"
  702. sql = relative_date_clause(db_table, db_field, 0, 0)
  703. when "w"
  704. first_day_of_week = l(:general_first_day_of_week).to_i
  705. day_of_week = Date.today.cwday
  706. days_ago = (day_of_week >= first_day_of_week ? day_of_week - first_day_of_week : day_of_week + 7 - first_day_of_week)
  707. sql = relative_date_clause(db_table, db_field, - days_ago, - days_ago + 6)
  708. when "~"
  709. sql = "LOWER(#{db_table}.#{db_field}) LIKE '%#{connection.quote_string(value.first.to_s.downcase)}%'"
  710. when "!~"
  711. sql = "LOWER(#{db_table}.#{db_field}) NOT LIKE '%#{connection.quote_string(value.first.to_s.downcase)}%'"
  712. else
  713. raise "Unknown query operator #{operator}"
  714. end
  715. return sql
  716. end
  717. def add_custom_fields_filters(custom_fields)
  718. @available_filters ||= {}
  719. custom_fields.select(&:is_filter?).each do |field|
  720. case field.field_format
  721. when "text"
  722. options = { :type => :text, :order => 20 }
  723. when "list"
  724. options = { :type => :list_optional, :values => field.possible_values, :order => 20}
  725. when "date"
  726. options = { :type => :date, :order => 20 }
  727. when "bool"
  728. options = { :type => :list, :values => [[l(:general_text_yes), "1"], [l(:general_text_no), "0"]], :order => 20 }
  729. when "int"
  730. options = { :type => :integer, :order => 20 }
  731. when "float"
  732. options = { :type => :float, :order => 20 }
  733. when "user", "version"
  734. next unless project
  735. values = field.possible_values_options(project)
  736. if User.current.logged? && field.field_format == 'user'
  737. values.unshift ["<< #{l(:label_me)} >>", "me"]
  738. end
  739. options = { :type => :list_optional, :values => values, :order => 20}
  740. else
  741. options = { :type => :string, :order => 20 }
  742. end
  743. @available_filters["cf_#{field.id}"] = options.merge({ :name => field.name, :format => field.field_format })
  744. end
  745. end
  746. # Returns a SQL clause for a date or datetime field.
  747. def date_clause(table, field, from, to)
  748. s = []
  749. if from
  750. from_yesterday = from - 1
  751. from_yesterday_utc = Time.gm(from_yesterday.year, from_yesterday.month, from_yesterday.day)
  752. s << ("#{table}.#{field} > '%s'" % [connection.quoted_date(from_yesterday_utc.end_of_day)])
  753. end
  754. if to
  755. to_utc = Time.gm(to.year, to.month, to.day)
  756. s << ("#{table}.#{field} <= '%s'" % [connection.quoted_date(to_utc.end_of_day)])
  757. end
  758. s.join(' AND ')
  759. end
  760. # Returns a SQL clause for a date or datetime field using relative dates.
  761. def relative_date_clause(table, field, days_from, days_to)
  762. date_clause(table, field, (days_from ? Date.today + days_from : nil), (days_to ? Date.today + days_to : nil))
  763. end
  764. end