Class: Query

Inherits:
ActiveRecord::Base
  • Object
show all
Includes:
Redmine::SubclassFactory
Defined in:
app/models/query.rb

Direct Known Subclasses

IssueQuery, ProjectQuery, TimeEntryQuery

Defined Under Namespace

Classes: QueryError, StatementInvalid

Constant Summary collapse

VISIBILITY_PRIVATE = 
0
VISIBILITY_ROLES = 
1
VISIBILITY_PUBLIC = 
2

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Redmine::SubclassFactory

included

Class Method Details

.add_available_column(column) ⇒ Object 


768
769
770
 
# File 'app/models/query.rb', line 768

def self.add_available_column(column)
  self.available_columns << (column) if column.is_a?(QueryColumn)
end

.build_from_params(params, attributes = {}) ⇒ Object

Builds a new query from the given params and attributes


446
447
448
 
# File 'app/models/query.rb', line 446

def self.build_from_params(params, attributes={})
  new(attributes).build_from_params(params)
end

.default(**_) ⇒ Object

to be implemented in subclasses that have a way to determine a default query for the given options


348
349
350
 
# File 'app/models/query.rb', line 348

def self.default(**_)
  nil
end

.operators_labels ⇒ Object

Returns a hash of localized labels for all filter operators


530
531
532
 
# File 'app/models/query.rb', line 530

def self.operators_labels
  operators.inject({}) {|h, operator| h[operator.first] = l(*operator.last); h}
end

.visible(*args) ⇒ Object

Scope of visible queries, can be used from subclasses only. Unlike other visible scopes, a class methods is used as it let handle inheritance more nicely than scope DSL.


355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'app/models/query.rb', line 355

def self.visible(*args)
  if self == ::Query
    # Visibility depends on permissions for each subclass,
    # raise an error if the scope is called from Query (eg. Query.visible)
    raise "Cannot call .visible scope from the base Query class, but from subclasses only."
  end

  user = args.shift || User.current
  base = Project.allowed_to_condition(user, view_permission, *args)
  scope = joins("LEFT OUTER JOIN #{Project.table_name} ON #{table_name}.project_id = #{Project.table_name}.id").
    where("#{table_name}.project_id IS NULL OR (#{base})")

  if user.admin?
    scope.where("#{table_name}.visibility <> ? OR #{table_name}.user_id = ?", VISIBILITY_PRIVATE, user.id)
  elsif user.memberships.any?
    scope.where(
      "#{table_name}.visibility = ?" +
        " OR (#{table_name}.visibility = ? AND #{table_name}.id IN (" +
        "SELECT DISTINCT q.id FROM #{table_name} q" +
        " INNER JOIN #{table_name_prefix}queries_roles#{table_name_suffix} qr on qr.query_id = q.id" +
        " INNER JOIN #{MemberRole.table_name} mr ON mr.role_id = qr.role_id" +
        " INNER JOIN #{Member.table_name} m ON m.id = mr.member_id AND m.user_id = ?" +
        " INNER JOIN #{Project.table_name} p ON p.id = m.project_id AND p.status <> ?" +
        " WHERE q.project_id IS NULL OR q.project_id = m.project_id))" +
        " OR #{table_name}.user_id = ?",
      VISIBILITY_PUBLIC, VISIBILITY_ROLES, user.id, Project::STATUS_ARCHIVED, user.id)
  elsif user.logged?
    scope.where("#{table_name}.visibility = ? OR #{table_name}.user_id = ?", VISIBILITY_PUBLIC, user.id)
  else
    scope.where("#{table_name}.visibility = ?", VISIBILITY_PUBLIC)
  end
end

Instance Method Details

#add_available_filter(field, options) ⇒ Object

Adds an available filter


690
691
692
693
694
 
# File 'app/models/query.rb', line 690

def add_available_filter(field, options)
  @available_filters ||= ActiveSupport::OrderedHash.new
  @available_filters[field] = QueryFilter.new(field, options)
  @available_filters
end

#add_filter(field, operator, values = nil) ⇒ Object 


712
713
714
715
716
717
718
719
720
 
# File 'app/models/query.rb', line 712

def add_filter(field, operator, values=nil)
  # values must be an array
  return unless values.nil? || values.is_a?(Array)

  # check if field is defined as an available filter
  if available_filters.has_key? field
    filters[field] = {:operator => operator, :values => (values || [''])}
  end
end

#add_filter_error(field, message) ⇒ Object 


510
511
512
513
 
# File 'app/models/query.rb', line 510

def add_filter_error(field, message)
  m = label_for(field) + " " + l(message, :scope => 'activerecord.errors.messages')
  errors.add(:base, m)
end

#add_filters(fields, operators, values) ⇒ Object

Add multiple filters using add_filter


735
736
737
738
739
740
741
 
# File 'app/models/query.rb', line 735

def add_filters(fields, operators, values)
  if fields.present? && operators.present?
    fields.each do |field|
      add_filter(field, operators[field], values && values[field])
    end
  end
end

#add_short_filter(field, expression) ⇒ Object 


722
723
724
725
726
727
728
729
730
731
732
 
# File 'app/models/query.rb', line 722

def add_short_filter(field, expression)
  return unless expression && available_filters.has_key?(field)

  field_type = available_filters[field][:type]
  operators_by_filter_type[field_type].sort.reverse.detect do |operator|
    next unless expression =~ /^#{Regexp.escape(operator)}(.*)$/

    values = $1
    add_filter field, operator, values.present? ? values.split('|') : ['']
  end || add_filter(field, '=', expression.to_s.split('|'))
end

#all_projects ⇒ Object 


555
556
557
 
# File 'app/models/query.rb', line 555

def all_projects
  @all_projects ||= Project.visible.to_a
end

#all_projects_values ⇒ Object 


559
560
561
562
563
564
565
566
567
568
 
# File 'app/models/query.rb', line 559

def all_projects_values
  return @all_projects_values if @all_projects_values

  values = []
  Project.project_tree(all_projects) do |p, level|
    prefix = (level > 0 ? ('--' * level + ' ') : '')
    values << ["#{prefix}#{p.name}", p.id.to_s]
  end
  @all_projects_values = values
end

#as_params ⇒ Object 


450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'app/models/query.rb', line 450

def as_params
  if new_record?
    params = {}
    filters.each do |field, options|
      params[:f] ||= []
      params[:f] << field
      params[:op] ||= {}
      params[:op][field] = options[:operator]
      params[:v] ||= {}
      params[:v][field] = options[:values]
    end
    params[:c] = column_names
    params[:group_by] = group_by.to_s if group_by.present?
    params[:t] = totalable_names.map(&:to_s) if totalable_names.any?
    params[:sort] = sort_criteria.to_param
    params[:set_filter] = 1
    params
  else
    {:query_id => id}
  end
end

#assigned_to_values ⇒ Object 


616
617
618
619
620
621
622
623
 
# File 'app/models/query.rb', line 616

def assigned_to_values
  assigned_to_values = []
  assigned_to_values << ["<< #{l(:label_me)} >>", "me"] if User.current.logged?
  assigned_to_values +=
    (Setting.issue_group_assignment? ? principals : users).sort_by(&:status).
      collect{|s| [s.name, s.id.to_s, l("status_#{User::LABEL_BY_STATUS[s.status]}")]}
  assigned_to_values
end

#author_values ⇒ Object 


606
607
608
609
610
611
612
613
614
 
# File 'app/models/query.rb', line 606

def author_values
  author_values = []
  author_values << ["<< #{l(:label_me)} >>", "me"] if User.current.logged?
  author_values +=
    users.sort_by(&:status).
      collect{|s| [s.name, s.id.to_s, l("status_#{User::LABEL_BY_STATUS[s.status]}")]}
  author_values << [l(:label_user_anonymous), User.anonymous.id.to_s]
  author_values
end

#available_block_columns ⇒ Object 


807
808
809
 
# File 'app/models/query.rb', line 807

def available_block_columns
  available_columns.reject(&:inline?)
end

#available_display_types ⇒ Object 


1073
1074
1075
 
# File 'app/models/query.rb', line 1073

def available_display_types
  ['list']
end

#available_filters ⇒ Object

Return a hash of available filters


704
705
706
707
708
709
710
 
# File 'app/models/query.rb', line 704

def available_filters
  unless @available_filters
    initialize_available_filters
    @available_filters ||= {}
  end
  @available_filters
end

#available_filters_as_json ⇒ Object

Returns a representation of the available filters for JSON serialization


535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'app/models/query.rb', line 535

def available_filters_as_json
  json = {}
  available_filters.each do |field, filter|
    options = {:type => filter[:type], :name => filter[:name]}
    options[:remote] = true if filter.remote

    if has_filter?(field) || !filter.remote
      options[:values] = filter.values
      if options[:values] && values_for(field)
        missing = Array(values_for(field)).select(&:present?) - options[:values].map{|v| v[1]}
        if missing.any? && respond_to?(method = "find_#{field}_filter_values")
          options[:values] += send(method, missing)
        end
      end
    end
    json[field] = options.stringify_keys
  end
  json
end

#available_inline_columns ⇒ Object 


803
804
805
 
# File 'app/models/query.rb', line 803

def available_inline_columns
  available_columns.select(&:inline?)
end

#available_totalable_columns ⇒ Object 


811
812
813
 
# File 'app/models/query.rb', line 811

def available_totalable_columns
  available_columns.select(&:totalable)
end

#block_columns ⇒ Object 


799
800
801
 
# File 'app/models/query.rb', line 799

def block_columns
  columns.reject(&:inline?)
end

#build_from_params(params, defaults = {}) ⇒ Object

Builds the query from the given params


426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'app/models/query.rb', line 426

def build_from_params(params, defaults={})
  if params[:fields] || params[:f]
    self.filters = {}
    add_filters(params[:fields] || params[:f], params[:operators] || params[:op], params[:values] || params[:v])
  else
    available_filters.each_key do |field|
      add_short_filter(field, params[field]) if params[field]
    end
  end

  query_params = params[:query] || defaults || {}
  self.group_by = params[:group_by] || query_params[:group_by] || self.group_by
  self.column_names = params[:c] || query_params[:column_names] || self.column_names
  self.totalable_names = params[:t] || query_params[:totalable_names] || self.totalable_names
  self.sort_criteria = params[:sort] || query_params[:sort_criteria] || self.sort_criteria
  self.display_type = params[:display_type] || query_params[:display_type] || self.display_type
  self
end

#column_names=(names) ⇒ Object 


827
828
829
830
831
832
833
834
835
836
837
838
839
840
 
# File 'app/models/query.rb', line 827

def column_names=(names)
  if names
    names = names.select {|n| n.is_a?(Symbol) || !n.blank?}
    names = names.collect {|n| n.is_a?(Symbol) ? n : n.to_sym}
    if names.delete(:all_inline)
      names = available_inline_columns.map(&:name) | names
    end
    # Set column_names to nil if default columns
    if names == default_columns_names
      names = nil
    end
  end
  write_attribute(:column_names, names)
end

#columns ⇒ Object 


785
786
787
788
789
790
791
792
793
 
# File 'app/models/query.rb', line 785

def columns
  return [] if available_columns.empty?

  # preserve the column_names order
  cols = (has_default_columns? ? default_columns_names : column_names).collect do |name|
    available_columns.find {|col| col.name == name}
  end.compact
  available_columns.select(&:frozen?) | cols
end

#css_classes ⇒ Object 


1054
1055
1056
1057
1058
1059
1060
 
# File 'app/models/query.rb', line 1054

def css_classes
  s = sort_criteria.first
  if s.present?
    key, asc = s
    "sort-by-#{key.to_s.dasherize} sort-#{asc}"
  end
end

#default_columns_names ⇒ Object 


815
816
817
 
# File 'app/models/query.rb', line 815

def default_columns_names
  []
end

#default_display_type ⇒ Object 


823
824
825
 
# File 'app/models/query.rb', line 823

def default_display_type
  self.available_display_types.first
end

#default_sort_criteria ⇒ Object 


871
872
873
 
# File 'app/models/query.rb', line 871

def default_sort_criteria
  []
end

#default_totalable_names ⇒ Object 


819
820
821
 
# File 'app/models/query.rb', line 819

def default_totalable_names
  []
end

#delete_available_filter(field) ⇒ Object

Removes an available filter


697
698
699
700
701
 
# File 'app/models/query.rb', line 697

def delete_available_filter(field)
  if @available_filters
    @available_filters.delete(field)
  end
end

#display_type ⇒ Object 


1062
1063
1064
 
# File 'app/models/query.rb', line 1062

def display_type
  options[:display_type] || self.default_display_type
end

#display_type=(type) ⇒ Object 


1066
1067
1068
1069
1070
1071
 
# File 'app/models/query.rb', line 1066

def display_type=(type)
  unless type || self.available_display_types.include?(type)
    type = self.available_display_types.first
  end
  options[:display_type] = type
end

#editable_by?(user) ⇒ Boolean

Returns:

  • (Boolean) 

515
516
517
518
519
520
521
522
523
 
# File 'app/models/query.rb', line 515

def editable_by?(user)
  return false unless user

  # Admin can edit them all and regular users can edit their private queries
  return true if user.admin? || (is_private? && self.user_id == user.id)

  # Members can not edit public queries that are for all project (only admin is allowed to)
  is_public? && !is_global? && user.allowed_to?(:manage_public_queries, project)
end

#fixed_version_values ⇒ Object 


625
626
627
628
629
630
631
632
633
634
 
# File 'app/models/query.rb', line 625

def fixed_version_values
  versions = []
  if project
    versions = project.shared_versions.to_a
  else
    versions = Version.visible.to_a
  end
  Version.sort_by_status(versions).
    collect{|s| ["#{s.project.name} - #{s.name}", s.id.to_s, l("version_status_#{s.status}")]}
end

#group_by_column ⇒ Object 


921
922
923
 
# File 'app/models/query.rb', line 921

def group_by_column
  groupable_columns.detect {|c| c.groupable? && c.name.to_s == group_by}
end

#group_by_sort_order ⇒ Object

Returns the SQL sort order that should be prepended for grouping


904
905
906
907
908
909
910
911
912
913
914
 
# File 'app/models/query.rb', line 904

def group_by_sort_order
  if column = group_by_column
    order = (sort_criteria.order_for(column.name) || column.default_order || 'asc').try(:upcase)

    column_sortable = column.sortable
    if column.is_a?(TimestampQueryColumn)
      column_sortable = Redmine::Database.timestamp_to_date(column.sortable, User.current.time_zone)
    end
    Array(column_sortable).map {|s| Arel.sql("#{s} #{order}")}
  end
end

#group_by_statement ⇒ Object 


925
926
927
 
# File 'app/models/query.rb', line 925

def group_by_statement
  group_by_column.try(:group_by_statement)
end

#groupable_columns ⇒ Object

Returns an array of columns that can be used to group the results


773
774
775
 
# File 'app/models/query.rb', line 773

def groupable_columns
  available_columns.select(&:groupable?)
end

#grouped? ⇒ Boolean

Returns true if the query is a grouped query

Returns:

  • (Boolean) 

917
918
919
 
# File 'app/models/query.rb', line 917

def grouped?
  !group_by_column.nil?
end

#has_column?(column) ⇒ Boolean

Returns:

  • (Boolean) 

842
843
844
845
 
# File 'app/models/query.rb', line 842

def has_column?(column)
  name = column.is_a?(QueryColumn) ? column.name : column
  columns.detect {|c| c.name == name}
end

#has_custom_field_column? ⇒ Boolean

Returns:

  • (Boolean) 

847
848
849
 
# File 'app/models/query.rb', line 847

def has_custom_field_column?
  columns.any? {|column| column.is_a? QueryCustomFieldColumn}
end

#has_default_columns? ⇒ Boolean

Returns:

  • (Boolean) 

851
852
853
 
# File 'app/models/query.rb', line 851

def has_default_columns?
  column_names.nil? || column_names.empty?
end

#has_filter?(field) ⇒ Boolean

Returns:

  • (Boolean) 

743
744
745
 
# File 'app/models/query.rb', line 743

def has_filter?(field)
  filters and filters[field]
end

#inline_columns ⇒ Object 


795
796
797
 
# File 'app/models/query.rb', line 795

def inline_columns
  columns.select(&:inline?)
end

#is_global? ⇒ Boolean

Returns true if the query is available for all projects

Returns:

  • (Boolean) 

417
418
419
 
# File 'app/models/query.rb', line 417

def is_global?
  new_record? ? project_id.nil? : project_id_in_database.nil?
end

#is_private? ⇒ Boolean

Returns:

  • (Boolean) 

408
409
410
 
# File 'app/models/query.rb', line 408

def is_private?
  visibility == VISIBILITY_PRIVATE
end

#is_public? ⇒ Boolean

Returns:

  • (Boolean) 

412
413
414
 
# File 'app/models/query.rb', line 412

def is_public?
  !is_private?
end

#issue_custom_fields ⇒ Object

Returns a scope of issue custom fields that are available as columns or filters


657
658
659
660
661
662
663
 
# File 'app/models/query.rb', line 657

def issue_custom_fields
  if project
    project.rolled_up_custom_fields
  else
    IssueCustomField.sorted
  end
end

#issue_statuses_values ⇒ Object

Returns a scope of issue statuses that are available as columns for filters


637
638
639
640
641
642
643
644
 
# File 'app/models/query.rb', line 637

def issue_statuses_values
  if project
    statuses = project.rolled_up_statuses
  else
    statuses = IssueStatus.all.sorted
  end
  statuses.collect{|s| [s.name, s.id.to_s]}
end

#label_for(field) ⇒ Object 


763
764
765
766
 
# File 'app/models/query.rb', line 763

def label_for(field)
  label = available_filters[field][:name] if available_filters.has_key?(field)
  label ||= queried_class.human_attribute_name(field, :default => field)
end

#operator_for(field) ⇒ Object 


751
752
753
 
# File 'app/models/query.rb', line 751

def operator_for(field)
  has_filter?(field) ? filters[field][:operator] : nil
end

#principals ⇒ Object 


584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'app/models/query.rb', line 584

def principals
  @principal ||= begin
    principals = []
    if project
      principals += Principal.member_of(project).visible
      unless project.leaf?
        principals += Principal.member_of(project.descendants.visible).visible
      end
    else
      principals += Principal.member_of(all_projects).visible
    end
    principals.uniq!
    principals.sort!
    principals.reject! {|p| p.is_a?(GroupBuiltin)}
    principals
  end
end

#project_custom_fields ⇒ Object

Returns a scope of project custom fields that are available as columns or filters


666
667
668
 
# File 'app/models/query.rb', line 666

def project_custom_fields
  ProjectCustomField.sorted
end

#project_statement ⇒ Object 


929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'app/models/query.rb', line 929

def project_statement
  project_clauses = []
  subprojects_ids = []

  subprojects_ids = project.descendants.where.not(status: Project::STATUS_ARCHIVED).ids if project
  if subprojects_ids.any?
    if has_filter?("subproject_id")
      case operator_for("subproject_id")
      when '='
        # include the selected subprojects
        ids = [project.id] + values_for("subproject_id").map(&:to_i)
        project_clauses << "#{Project.table_name}.id IN (%s)" % ids.join(',')
      when '!'
        # exclude the selected subprojects
        ids = [project.id] + subprojects_ids - values_for("subproject_id").map(&:to_i)
        project_clauses << "#{Project.table_name}.id IN (%s)" % ids.join(',')
      when '!*'
        # main project only
        project_clauses << "#{Project.table_name}.id = %d" % project.id
      else
        # all subprojects
        project_clauses << "#{Project.table_name}.lft >= #{project.lft} AND #{Project.table_name}.rgt <= #{project.rgt}"
      end
    elsif Setting.display_subprojects_issues?
      project_clauses << "#{Project.table_name}.lft >= #{project.lft} AND #{Project.table_name}.rgt <= #{project.rgt}"
    else
      project_clauses << "#{Project.table_name}.id = %d" % project.id
    end
  elsif project
    project_clauses << "#{Project.table_name}.id = %d" % project.id
  end
  project_clauses.any? ? project_clauses.join(' AND ') : nil
end

#project_statuses_values ⇒ Object

Returns a scope of project statuses that are available as columns or filters


676
677
678
679
680
681
 
# File 'app/models/query.rb', line 676

def project_statuses_values
  [
    [l(:project_status_active), "#{Project::STATUS_ACTIVE}"],
    [l(:project_status_closed), "#{Project::STATUS_CLOSED}"]
  ]
end

#project_values ⇒ Object 


570
571
572
573
574
575
576
577
578
 
# File 'app/models/query.rb', line 570

def project_values
  project_values = []
  if User.current.logged?
    project_values << ["<< #{l(:label_my_projects).downcase} >>", "mine"] if User.current.memberships.any?
    project_values << ["<< #{l(:label_my_bookmarks).downcase} >>", "bookmarks"] if User.current.bookmarked_project_ids.any?
  end
  project_values += all_projects_values
  project_values
end

#queried_table_name ⇒ Object 


421
422
423
 
# File 'app/models/query.rb', line 421

def queried_table_name
  @queried_table_name ||= self.class.queried_class.table_name
end

#result_count_by_group ⇒ Object

Returns the result count by group or nil if query is not grouped


1023
1024
1025
1026
1027
 
# File 'app/models/query.rb', line 1023

def result_count_by_group
  grouped_query do |scope|
    scope.count
  end
end

#sort_clause ⇒ Object 


897
898
899
900
901
 
# File 'app/models/query.rb', line 897

def sort_clause
  if clause = sort_criteria.sort_clause(sortable_columns)
    clause.map {|c| Arel.sql c}
  end
end

#sort_criteria ⇒ Object 


881
882
883
884
885
886
887
 
# File 'app/models/query.rb', line 881

def sort_criteria
  c = read_attribute(:sort_criteria)
  if c.blank?
    c = default_sort_criteria
  end
  Redmine::SortCriteria.new(c)
end

#sort_criteria=(arg) ⇒ Object 


875
876
877
878
879
 
# File 'app/models/query.rb', line 875

def sort_criteria=(arg)
  c = Redmine::SortCriteria.new(arg)
  write_attribute(:sort_criteria, c.to_a)
  c
end

#sort_criteria_key(index) ⇒ Object 


889
890
891
 
# File 'app/models/query.rb', line 889

def sort_criteria_key(index)
  sort_criteria[index].try(:first)
end

#sort_criteria_order(index) ⇒ Object 


893
894
895
 
# File 'app/models/query.rb', line 893

def sort_criteria_order(index)
  sort_criteria[index].try(:last)
end

#sortable_columns ⇒ Object

Returns a Hash of columns and the key for sorting


778
779
780
781
782
783
 
# File 'app/models/query.rb', line 778

def sortable_columns
  available_columns.inject({}) do |h, column|
    h[column.name.to_s] = column.sortable
    h
  end
end

#statement ⇒ Object 


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'app/models/query.rb', line 963

def statement
  # filters clauses
  filters_clauses = []
  filters.each_key do |field|
    next if field == "subproject_id"

    v = values_for(field).clone
    next unless v and !v.empty?

    operator = operator_for(field)

    # "me" value substitution
    if %w(assigned_to_id author_id user_id watcher_id updated_by last_updated_by).include?(field)
      if v.delete("me")
        if User.current.logged?
          v.push(User.current.id.to_s)
          v += User.current.group_ids.map(&:to_s) if %w(assigned_to_id watcher_id).include?(field)
        else
          v.push("0")
        end
      end
    end

    if field == 'project_id' || (self.type == 'ProjectQuery' && %w[id parent_id].include?(field))
      if v.delete('mine')
        v += User.current.memberships.map(&:project_id).map(&:to_s)
      end
      if v.delete('bookmarks')
        v += User.current.bookmarked_project_ids
      end
    end

    if field =~ /^cf_(\d+)\.cf_(\d+)$/
      filters_clauses << sql_for_chained_custom_field(field, operator, v, $1, $2)
    elsif field =~ /cf_(\d+)$/
      # custom field
      filters_clauses << sql_for_custom_field(field, operator, v, $1)
    elsif field =~ /^cf_(\d+)\.(.+)$/
      filters_clauses << sql_for_custom_field_attribute(field, operator, v, $1, $2)
    elsif respond_to?(method = "sql_for_#{field.tr('.', '_')}_field")
      # specific statement
      filters_clauses << send(method, field, operator, v)
    else
      # regular field
      filters_clauses << '(' + sql_for_field(field, operator, v, queried_table_name, field) + ')'
    end
  end if filters and valid?

  if (c = group_by_column) && c.is_a?(QueryCustomFieldColumn)
    # Excludes results for which the grouped custom field is not visible
    filters_clauses << c.custom_field.visibility_by_project_condition
  end

  filters_clauses << project_statement
  filters_clauses.reject!(&:blank?)

  filters_clauses.any? ? filters_clauses.join(' AND ') : nil
end

#subproject_values ⇒ Object 


580
581
582
 
# File 'app/models/query.rb', line 580

def subproject_values
  project.descendants.visible.collect{|s| [s.name, s.id.to_s]}
end

#time_entry_custom_fields ⇒ Object

Returns a scope of time entry custom fields that are available as columns or filters


671
672
673
 
# File 'app/models/query.rb', line 671

def time_entry_custom_fields
  TimeEntryCustomField.sorted
end

#total_by_group_for(column) ⇒ Object

Returns a hash of the sum of the given column for each group, or nil if the query is not grouped


1036
1037
1038
1039
1040
 
# File 'app/models/query.rb', line 1036

def total_by_group_for(column)
  grouped_query do |scope|
    total_with_scope(column, scope)
  end
end

#total_for(column) ⇒ Object

Returns the sum of values for the given column


1030
1031
1032
 
# File 'app/models/query.rb', line 1030

def total_for(column)
  total_with_scope(column, base_scope)
end

#totalable_columns ⇒ Object 


855
856
857
858
 
# File 'app/models/query.rb', line 855

def totalable_columns
  names = totalable_names
  available_totalable_columns.select {|column| names.include?(column.name)}
end

#totalable_names ⇒ Object 


867
868
869
 
# File 'app/models/query.rb', line 867

def totalable_names
  options[:totalable_names] || default_totalable_names || []
end

#totalable_names=(names) ⇒ Object 


860
861
862
863
864
865
 
# File 'app/models/query.rb', line 860

def totalable_names=(names)
  if names
    names = names.select(&:present?).map {|n| n.is_a?(Symbol) ? n : n.to_sym}
  end
  options[:totalable_names] = names
end

#totals {|totals| ... } ⇒ Object

Yields:


1042
1043
1044
1045
1046
 
# File 'app/models/query.rb', line 1042

def totals
  totals = totalable_columns.map {|column| [column, total_for(column)]}
  yield totals if block_given?
  totals
end

#totals_by_group {|totals| ... } ⇒ Object

Yields:


1048
1049
1050
1051
1052
 
# File 'app/models/query.rb', line 1048

def totals_by_group
  totals = totalable_columns.map {|column| [column, total_by_group_for(column)]}
  yield totals if block_given?
  totals
end

#trackers ⇒ Object 


525
526
527
 
# File 'app/models/query.rb', line 525

def trackers
  @trackers ||= (project.nil? ? Tracker.all : project.rolled_up_trackers).visible.sorted
end

#type_for(field) ⇒ Object 


747
748
749
 
# File 'app/models/query.rb', line 747

def type_for(field)
  available_filters[field][:type] if available_filters.has_key?(field)
end

#users ⇒ Object 


602
603
604
 
# File 'app/models/query.rb', line 602

def users
  principals.select {|p| p.is_a?(User)}
end

#validate_query_filters ⇒ Object 


472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'app/models/query.rb', line 472

def validate_query_filters
  filters.each_key do |field|
    if values_for(field)
      case type_for(field)
      when :integer
        if values_for(field).detect {|v| v.present? && !/\A[+-]?\d+(,[+-]?\d+)*\z/.match?(v)}
          add_filter_error(field, :invalid)
        end
      when :float
        if values_for(field).detect {|v| v.present? && !/\A[+-]?\d+(\.\d*)?\z/.match?(v)}
          add_filter_error(field, :invalid)
        end
      when :date, :date_past
        case operator_for(field)
        when "=", ">=", "<=", "><"
          if values_for(field).detect do |v|
               v.present? &&
                 (!/\A\d{4}-\d{2}-\d{2}(T\d{2}((:)?\d{2}){0,2}(Z|\d{2}:?\d{2})?)?\z/.match?(v) ||
                   parse_date(v).nil?)
             end
            add_filter_error(field, :invalid)
          end
        when ">t-", "<t-", "t-", ">t+", "<t+", "t+", "><t+", "><t-"
          if values_for(field).detect {|v| v.present? && !/^\d+$/.match?(v)}
            add_filter_error(field, :invalid)
          end
        end
      end
    end

    add_filter_error(field, :blank) unless
        # filter requires one or more values
        (values_for(field) and !values_for(field).first.blank?) or
        # filter doesn't require any value
        ["o", "c", "!*", "*", "nd", "t", "ld", "nw", "w", "lw", "l2w", "nm", "m", "lm", "y", "*o", "!o"].include? operator_for(field)
  end if filters
end

#value_for(field, index = 0) ⇒ Object 


759
760
761
 
# File 'app/models/query.rb', line 759

def value_for(field, index=0)
  (values_for(field) || [])[index]
end

#values_for(field) ⇒ Object 


755
756
757
 
# File 'app/models/query.rb', line 755

def values_for(field)
  has_filter?(field) ? filters[field][:values] : nil
end

#visible?(user = User.current) ⇒ Boolean

Returns true if the query is visible to user or the current user.

Returns:

  • (Boolean) 

389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'app/models/query.rb', line 389

def visible?(user=User.current)
  return true if user.admin?

  return false unless project.nil? || user.allowed_to?(self.class.view_permission, project)

  case visibility
  when VISIBILITY_PUBLIC
    true
  when VISIBILITY_ROLES
    if project
      (user.roles_for_project(project) & roles).any?
    else
      user.memberships.joins(:member_roles).where(:member_roles => {:role_id => roles.map(&:id)}).any?
    end
  else
    user == self.user
  end
end

#watcher_values ⇒ Object 


646
647
648
649
650
651
652
653
654
 
# File 'app/models/query.rb', line 646

def watcher_values
  watcher_values = [["<< #{l(:label_me)} >>", "me"]]
  if User.current.allowed_to?(:view_issue_watchers, self.project, global: true)
    watcher_values +=
      principals.sort_by(&:status).
        collect{|s| [s.name, s.id.to_s, l("status_#{User::LABEL_BY_STATUS[s.status]}")]}
  end
  watcher_values
end