Class: Issue

Inherits:
ActiveRecord::Base
  • Object
show all
Includes:
Redmine::I18n, Redmine::SafeAttributes, Redmine::Utils::DateCalculation
Defined in:
app/models/issue.rb

Overview

Redmine - project management software Copyright (C) 2006-2014 Jean-Philippe Lang

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.

Constant Summary collapse

DONE_RATIO_OPTIONS =
%w(issue_field issue_status)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Redmine::I18n

#current_language, #day_letter, #day_name, #find_language, #format_date, #format_time, included, #l, #l_hours, #l_or_humanize, #languages_options, #ll, #month_name, #set_language_if_valid, #valid_languages

Methods included from Redmine::Utils::DateCalculation

#add_working_days, #next_working_date, #non_working_week_days, #working_days

Methods included from Redmine::SafeAttributes

#delete_unsafe_attributes, included, #safe_attribute?

Constructor Details

#initialize(attributes = nil, *args) ⇒ Issue



163
164
165
166
167
168
169
170
# File 'app/models/issue.rb', line 163

def initialize(attributes=nil, *args)
  super
  if new_record?
    # set default values for new records only
    self.priority ||= IssuePriority.default
    self.watcher_user_ids = []
  end
end

Instance Attribute Details

#current_journalObject (readonly)

Returns the current journal or nil if it's not initialized



661
662
663
# File 'app/models/issue.rb', line 661

def current_journal
  @current_journal
end

Class Method Details

.allowed_target_projects_on_move(user = User.current) ⇒ Object

Returns a scope of projects that user can move issues to



1295
1296
1297
# File 'app/models/issue.rb', line 1295

def self.allowed_target_projects_on_move(user=User.current)
  Project.where(Project.allowed_to_condition(user, :move_issues))
end

.by_assigned_to(project) ⇒ Object



1244
1245
1246
# File 'app/models/issue.rb', line 1244

def self.by_assigned_to(project)
  count_and_group_by(:project => project, :association => :assigned_to)
end

.by_author(project) ⇒ Object



1248
1249
1250
# File 'app/models/issue.rb', line 1248

def self.by_author(project)
  count_and_group_by(:project => project, :association => :author)
end

.by_category(project) ⇒ Object



1240
1241
1242
# File 'app/models/issue.rb', line 1240

def self.by_category(project)
  count_and_group_by(:project => project, :association => :category)
end

.by_priority(project) ⇒ Object



1236
1237
1238
# File 'app/models/issue.rb', line 1236

def self.by_priority(project)
  count_and_group_by(:project => project, :association => :priority)
end

.by_subproject(project) ⇒ Object



1252
1253
1254
1255
# File 'app/models/issue.rb', line 1252

def self.by_subproject(project)
  r = count_and_group_by(:project => project, :with_subprojects => true, :association => :project)
  r.reject {|r| r["project_id"] == project.id.to_s}
end

.by_tracker(project) ⇒ Object



1228
1229
1230
# File 'app/models/issue.rb', line 1228

def self.by_tracker(project)
  count_and_group_by(:project => project, :association => :tracker)
end

.by_version(project) ⇒ Object



1232
1233
1234
# File 'app/models/issue.rb', line 1232

def self.by_version(project)
  count_and_group_by(:project => project, :association => :fixed_version)
end

.count_and_group_by(options) ⇒ Object

Query generator for selecting groups of issue counts for a project based on specific criteria

Options

  • project - Project to search in.

  • with_subprojects - Includes subprojects issues if set to true.

  • association - Symbol. Association for grouping.



1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
# File 'app/models/issue.rb', line 1264

def self.count_and_group_by(options)
  assoc = reflect_on_association(options[:association])
  select_field = assoc.foreign_key

  Issue.
    visible(User.current, :project => options[:project], :with_subprojects => options[:with_subprojects]).
    joins(:status, assoc.name).
    group(:status_id, :is_closed, select_field).
    count.
    map do |columns, total|
      status_id, is_closed, field_value = columns
      is_closed = ['t', 'true', '1'].include?(is_closed.to_s)
      {
        "status_id" => status_id.to_s,
        "closed" => is_closed,
        select_field => field_value.to_s,
        "total" => total.to_s
      }
    end
end

.cross_project_scope(project, scope = nil) ⇒ Object

Returns an issue scope based on project and scope



1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
# File 'app/models/issue.rb', line 1207

def self.cross_project_scope(project, scope=nil)
  if project.nil?
    return Issue
  end
  case scope
  when 'all', 'system'
    Issue
  when 'tree'
    Issue.joins(:project).where("(#{Project.table_name}.lft >= :lft AND #{Project.table_name}.rgt <= :rgt)",
                                :lft => project.root.lft, :rgt => project.root.rgt)
  when 'hierarchy'
    Issue.joins(:project).where("(#{Project.table_name}.lft >= :lft AND #{Project.table_name}.rgt <= :rgt) OR (#{Project.table_name}.lft < :lft AND #{Project.table_name}.rgt > :rgt)",
                                :lft => project.lft, :rgt => project.rgt)
  when 'descendants'
    Issue.joins(:project).where("(#{Project.table_name}.lft >= :lft AND #{Project.table_name}.rgt <= :rgt)",
                                :lft => project.lft, :rgt => project.rgt)
  else
    Issue.where(:project_id => project.id)
  end
end

.load_relations(issues) ⇒ Object

Preloads relations for a collection of issues



899
900
901
902
903
904
905
906
# File 'app/models/issue.rb', line 899

def self.load_relations(issues)
  if issues.any?
    relations = IssueRelation.where("issue_from_id IN (:ids) OR issue_to_id IN (:ids)", :ids => issues.map(&:id)).all
    issues.each do |issue|
      issue.instance_variable_set "@relations", relations.select {|r| r.issue_from_id == issue.id || r.issue_to_id == issue.id}
    end
  end
end

.load_visible_relations(issues, user = User.current) ⇒ Object

Preloads visible relations for a collection of issues



919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
# File 'app/models/issue.rb', line 919

def self.load_visible_relations(issues, user=User.current)
  if issues.any?
    issue_ids = issues.map(&:id)
    # Relations with issue_from in given issues and visible issue_to
    relations_from = IssueRelation.joins(:issue_to => :project).
                       where(visible_condition(user)).where(:issue_from_id => issue_ids).to_a
    # Relations with issue_to in given issues and visible issue_from
    relations_to = IssueRelation.joins(:issue_from => :project).
                       where(visible_condition(user)).
                       where(:issue_to_id => issue_ids).to_a
    issues.each do |issue|
      relations =
        relations_from.select {|relation| relation.issue_from_id == issue.id} +
        relations_to.select {|relation| relation.issue_to_id == issue.id}

      issue.instance_variable_set "@relations", IssueRelation::Relations.new(issue, relations.sort)
    end
  end
end

.load_visible_spent_hours(issues, user = User.current) ⇒ Object

Preloads visible spent time for a collection of issues



909
910
911
912
913
914
915
916
# File 'app/models/issue.rb', line 909

def self.load_visible_spent_hours(issues, user=User.current)
  if issues.any?
    hours_by_issue_id = TimeEntry.visible(user).group(:issue_id).sum(:hours)
    issues.each do |issue|
      issue.instance_variable_set "@spent_hours", (hours_by_issue_id[issue.id] || 0)
    end
  end
end

.update_versions_from_hierarchy_change(project) ⇒ Object

Unassigns issues from versions that are no longer shared after project was moved



1155
1156
1157
1158
1159
1160
1161
1162
# File 'app/models/issue.rb', line 1155

def self.update_versions_from_hierarchy_change(project)
  moved_project_ids = project.self_and_descendants.reload.collect(&:id)
  # Update issues of the moved projects and issues assigned to a version of a moved project
  Issue.update_versions(
          ["#{Version.table_name}.project_id IN (?) OR #{Issue.table_name}.project_id IN (?)",
           moved_project_ids, moved_project_ids]
        )
end

.update_versions_from_sharing_change(version) ⇒ Object

Unassigns issues from version if it's no longer shared with issue's project



1148
1149
1150
1151
# File 'app/models/issue.rb', line 1148

def self.update_versions_from_sharing_change(version)
  # Update issues assigned to the version
  update_versions(["#{Issue.table_name}.fixed_version_id = ?", version.id])
end

.use_field_for_done_ratio?Boolean



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

def self.use_field_for_done_ratio?
  Setting.issue_done_ratio == 'issue_field'
end

.use_status_for_done_ratio?Boolean



576
577
578
# File 'app/models/issue.rb', line 576

def self.use_status_for_done_ratio?
  Setting.issue_done_ratio == 'issue_status'
end

.visible_condition(user, options = {}) ⇒ Object

Returns a SQL conditions string used to find all issues visible by the specified user



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'app/models/issue.rb', line 117

def self.visible_condition(user, options={})
  Project.allowed_to_condition(user, :view_issues, options) do |role, user|
    if user.id && user.logged?
      case role.issues_visibility
      when 'all'
        nil
      when 'default'
        user_ids = [user.id] + user.groups.map(&:id).compact
        "(#{table_name}.is_private = #{connection.quoted_false} OR #{table_name}.author_id = #{user.id} OR #{table_name}.assigned_to_id IN (#{user_ids.join(',')}))"
      when 'own'
        user_ids = [user.id] + user.groups.map(&:id).compact
        "(#{table_name}.author_id = #{user.id} OR #{table_name}.assigned_to_id IN (#{user_ids.join(',')}))"
      else
        '1=0'
      end
    else
      "(#{table_name}.is_private = #{connection.quoted_false})"
    end
  end
end

Instance Method Details

#<=>(issue) ⇒ Object



1117
1118
1119
1120
1121
1122
1123
1124
1125
# File 'app/models/issue.rb', line 1117

def <=>(issue)
  if issue.nil?
    -1
  elsif root_id != issue.root_id
    (root_id || 0) <=> (issue.root_id || 0)
  else
    (lft || 0) <=> (issue.lft || 0)
  end
end

#all_dependent_issues(except = []) ⇒ Object

Returns all the other issues that depend on the issue The algorithm is a modified breadth first search (bfs)



946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
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
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
# File 'app/models/issue.rb', line 946

def all_dependent_issues(except=[])
  # The found dependencies
  dependencies = []

  # The visited flag for every node (issue) used by the breadth first search
  eNOT_DISCOVERED         = 0       # The issue is "new" to the algorithm, it has not seen it before.

  ePROCESS_ALL            = 1       # The issue is added to the queue. Process both children and relations of
                                    # the issue when it is processed.

  ePROCESS_RELATIONS_ONLY = 2       # The issue was added to the queue and will be output as dependent issue,
                                    # but its children will not be added to the queue when it is processed.

  eRELATIONS_PROCESSED    = 3       # The related issues, the parent issue and the issue itself have been added to
                                    # the queue, but its children have not been added.

  ePROCESS_CHILDREN_ONLY  = 4       # The relations and the parent of the issue have been added to the queue, but
                                    # the children still need to be processed.

  eALL_PROCESSED          = 5       # The issue and all its children, its parent and its related issues have been
                                    # added as dependent issues. It needs no further processing.

  issue_status = Hash.new(eNOT_DISCOVERED)

  # The queue
  queue = []

  # Initialize the bfs, add start node (self) to the queue
  queue << self
  issue_status[self] = ePROCESS_ALL

  while (!queue.empty?) do
    current_issue = queue.shift
    current_issue_status = issue_status[current_issue]
    dependencies << current_issue

    # Add parent to queue, if not already in it.
    parent = current_issue.parent
    parent_status = issue_status[parent]

    if parent && (parent_status == eNOT_DISCOVERED) && !except.include?(parent)
      queue << parent
      issue_status[parent] = ePROCESS_RELATIONS_ONLY
    end

    # Add children to queue, but only if they are not already in it and
    # the children of the current node need to be processed.
    if (current_issue_status == ePROCESS_CHILDREN_ONLY || current_issue_status == ePROCESS_ALL)
      current_issue.children.each do |child|
        next if except.include?(child)

        if (issue_status[child] == eNOT_DISCOVERED)
          queue << child
          issue_status[child] = ePROCESS_ALL
        elsif (issue_status[child] == eRELATIONS_PROCESSED)
          queue << child
          issue_status[child] = ePROCESS_CHILDREN_ONLY
        elsif (issue_status[child] == ePROCESS_RELATIONS_ONLY)
          queue << child
          issue_status[child] = ePROCESS_ALL
        end
      end
    end

    # Add related issues to the queue, if they are not already in it.
    current_issue.relations_from.map(&:issue_to).each do |related_issue|
      next if except.include?(related_issue)

      if (issue_status[related_issue] == eNOT_DISCOVERED)
        queue << related_issue
        issue_status[related_issue] = ePROCESS_ALL
      elsif (issue_status[related_issue] == eRELATIONS_PROCESSED)
        queue << related_issue
        issue_status[related_issue] = ePROCESS_CHILDREN_ONLY
      elsif (issue_status[related_issue] == ePROCESS_RELATIONS_ONLY)
        queue << related_issue
        issue_status[related_issue] = ePROCESS_ALL
      end
    end

    # Set new status for current issue
    if (current_issue_status == ePROCESS_ALL) || (current_issue_status == ePROCESS_CHILDREN_ONLY)
      issue_status[current_issue] = eALL_PROCESSED
    elsif (current_issue_status == ePROCESS_RELATIONS_ONLY)
      issue_status[current_issue] = eRELATIONS_PROCESSED
    end
  end # while

  # Remove the issues from the "except" parameter from the result array
  dependencies -= except
  dependencies.delete(self)

  dependencies
end

#allowed_target_projects(user = User.current) ⇒ Object

Returns a scope of projects that user can assign the issue to



1286
1287
1288
1289
1290
1291
1292
# File 'app/models/issue.rb', line 1286

def allowed_target_projects(user=User.current)
  if new_record?
    Project.where(Project.allowed_to_condition(user, :add_issues))
  else
    self.class.allowed_target_projects_on_move(user)
  end
end

#assign_attributes_with_project_and_tracker_first(new_attributes, *args) ⇒ Object

Overrides assign_attributes so that project and tracker get assigned first



358
359
360
361
362
363
364
365
366
367
368
369
# File 'app/models/issue.rb', line 358

def assign_attributes_with_project_and_tracker_first(new_attributes, *args)
  return if new_attributes.nil?
  attrs = new_attributes.dup
  attrs.stringify_keys!

  %w(project project_id tracker tracker_id).each do |attr|
    if attrs.has_key?(attr)
      send "#{attr}=", attrs.delete(attr)
    end
  end
  send :assign_attributes_without_project_and_tracker_first, attrs, *args
end

#assignable_usersObject

Users the issue can be assigned to



747
748
749
750
751
752
# File 'app/models/issue.rb', line 747

def assignable_users
  users = project.assignable_users.to_a
  users << author if author
  users << assigned_to if assigned_to
  users.uniq.sort
end

#assignable_versionsObject

Versions that the issue can be assigned to



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
# File 'app/models/issue.rb', line 755

def assignable_versions
  return @assignable_versions if @assignable_versions

  versions = project.shared_versions.open.to_a
  if fixed_version
    if fixed_version_id_changed?
      # nothing to do
    elsif project_id_changed?
      if project.shared_versions.include?(fixed_version)
        versions << fixed_version
      end
    else
      versions << fixed_version
    end
  end
  @assignable_versions = versions.uniq.sort
end

#assigned_to_wasObject

Returns the previous assignee if changed



828
829
830
831
832
833
834
# File 'app/models/issue.rb', line 828

def assigned_to_was
  # assigned_to_id_was is reset before after_save callbacks
  user_id = @previous_assigned_to_id || assigned_to_id_was
  if user_id && user_id != assigned_to_id
    @assigned_to_was ||= User.find_by_id(user_id)
  end
end

#attributes=(new_attributes) ⇒ Object



373
374
375
# File 'app/models/issue.rb', line 373

def attributes=(new_attributes)
  assign_attributes new_attributes
end

#available_custom_fieldsObject

Overrides Redmine::Acts::Customizable::InstanceMethods#available_custom_fields



211
212
213
# File 'app/models/issue.rb', line 211

def available_custom_fields
  (project && tracker) ? (project.all_issue_custom_fields & tracker.custom_fields) : []
end

#base_reloadObject



201
# File 'app/models/issue.rb', line 201

alias :base_reload :reload

#behind_schedule?Boolean

Is the amount of work done less than it should for the due date



735
736
737
738
739
# File 'app/models/issue.rb', line 735

def behind_schedule?
  return false if start_date.nil? || due_date.nil?
  done_date = start_date + ((due_date - start_date + 1) * done_ratio / 100).floor
  return done_date <= Date.today
end

#blocked?Boolean

Returns true if this issue is blocked by another issue that is still open



774
775
776
# File 'app/models/issue.rb', line 774

def blocked?
  !relations_to.detect {|ir| ir.relation_type == 'blocks' && !ir.issue_from.closed?}.nil?
end

#category_id=(cid) ⇒ Object



271
272
273
274
# File 'app/models/issue.rb', line 271

def category_id=(cid)
  self.category = nil
  write_attribute(:category_id, cid)
end

#children?Boolean

Does this issue have children?



742
743
744
# File 'app/models/issue.rb', line 742

def children?
  !leaf?
end

#closed?Boolean

Return true if the issue is closed, otherwise false



701
702
703
# File 'app/models/issue.rb', line 701

def closed?
  status.present? && status.is_closed?
end

#closing?Boolean

Return true if the issue is being closed



721
722
723
724
725
726
727
# File 'app/models/issue.rb', line 721

def closing?
  if new_record?
    closed?
  else
    status_id_changed? && closed? && !was_closed?
  end
end

#copy(attributes = nil, copy_options = {}) ⇒ Object

Returns an unsaved copy of the issue



240
241
242
243
244
# File 'app/models/issue.rb', line 240

def copy(attributes=nil, copy_options={})
  copy = self.class.new.copy_from(self, copy_options)
  copy.attributes = attributes if attributes
  copy
end

#copy?Boolean

Returns true if the issue is a copy



247
248
249
# File 'app/models/issue.rb', line 247

def copy?
  @copied_from.present?
end

#copy_from(arg, options = {}) ⇒ Object

Copies attributes from another issue, arg can be an id or an Issue



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'app/models/issue.rb', line 223

def copy_from(arg, options={})
  issue = arg.is_a?(Issue) ? arg : Issue.visible.find(arg)
  self.attributes = issue.attributes.dup.except("id", "root_id", "parent_id", "lft", "rgt", "created_on", "updated_on")
  self.custom_field_values = issue.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}
  self.status = issue.status
  self.author = User.current
  unless options[:attachments] == false
    self.attachments = issue.attachments.map do |attachement|
      attachement.copy(:container => self)
    end
  end
  @copied_from = issue
  @copy_options = options
  self
end

#css_classes(user = User.current) ⇒ Object

Returns a string of css classes that apply to the issue



1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
# File 'app/models/issue.rb', line 1132

def css_classes(user=User.current)
  s = "issue tracker-#{tracker_id} status-#{status_id} #{priority.try(:css_classes)}"
  s << ' closed' if closed?
  s << ' overdue' if overdue?
  s << ' child' if child?
  s << ' parent' unless leaf?
  s << ' private' if is_private?
  if user.logged?
    s << ' created-by-me' if author_id == user.id
    s << ' assigned-to-me' if assigned_to_id == user.id
    s << ' assigned-to-my-group' if user.groups.any? {|g| g.id == assigned_to_id}
  end
  s
end

#default_statusObject

Returns the default status of the issue based on its tracker Returns nil if tracker is nil



780
781
782
# File 'app/models/issue.rb', line 780

def default_status
  tracker.try(:default_status)
end

#description=(arg) ⇒ Object



350
351
352
353
354
355
# File 'app/models/issue.rb', line 350

def description=(arg)
  if arg.is_a?(String)
    arg = arg.gsub(/(\r\n|\n|\r)/, "\r\n")
  end
  write_attribute(:description, arg)
end

#destroyObject

AR#Persistence#destroy would raise and RecordNotFound exception if the issue was already deleted or updated (non matching lock_version). This is a problem when bulk deleting issues or deleting a project (because an issue may already be deleted if its parent was deleted first). The issue is reloaded by the nested_set before being deleted so the lock_version condition should not be an issue but we handle it.



186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'app/models/issue.rb', line 186

def destroy
  super
rescue ActiveRecord::RecordNotFound
  # Stale or already deleted
  begin
    reload
  rescue ActiveRecord::RecordNotFound
    # The issue was actually already deleted
    @destroyed = true
    return freeze
  end
  # The issue was stale, retry to destroy
  super
end

#disabled_core_fieldsObject



488
489
490
# File 'app/models/issue.rb', line 488

def disabled_core_fields
  tracker ? tracker.disabled_core_fields : []
end

#done_ratioObject



568
569
570
571
572
573
574
# File 'app/models/issue.rb', line 568

def done_ratio
  if Issue.use_status_for_done_ratio? && status && status.default_done_ratio
    status.default_done_ratio
  else
    read_attribute(:done_ratio)
  end
end

#due_beforeObject

Returns the due date or the target due date if any Used on gantt chart



1048
1049
1050
# File 'app/models/issue.rb', line 1048

def due_before
  due_date || (fixed_version ? fixed_version.effective_date : nil)
end

#duplicatesObject

Returns an array of issues that duplicate this one



1042
1043
1044
# File 'app/models/issue.rb', line 1042

def duplicates
  relations_to.select {|r| r.relation_type == IssueRelation::TYPE_DUPLICATES}.collect {|r| r.issue_from}
end

#durationObject

Returns the time scheduled for this issue.

Example:

Start Date: 2/26/09, End Date: 3/04/09
duration => 6


1057
1058
1059
# File 'app/models/issue.rb', line 1057

def duration
  (start_date && due_date) ? due_date - start_date : 0
end

#each_notification(users, &block) ⇒ Object



862
863
864
865
866
867
868
869
870
871
872
873
874
875
# File 'app/models/issue.rb', line 862

def each_notification(users, &block)
  if users.any?
    if custom_field_values.detect {|value| !value.custom_field.visible?}
      users_by_custom_field_visibility = users.group_by do |user|
        visible_custom_field_values(user).map(&:custom_field_id).sort
      end
      users_by_custom_field_visibility.values.each do |users|
        yield(users)
      end
    else
      yield(users)
    end
  end
end

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

Returns true if user or current user is allowed to edit or add a note to the issue



159
160
161
# File 'app/models/issue.rb', line 159

def editable?(user=User.current)
  user.allowed_to?(:edit_issues, project) || user.allowed_to?(:add_issue_notes, project)
end

#editable_custom_field_values(user = nil) ⇒ Object

Returns the custom_field_values that can be edited by the given user



493
494
495
496
497
# File 'app/models/issue.rb', line 493

def editable_custom_field_values(user=nil)
  visible_custom_field_values(user).reject do |value|
    read_only_attribute_names(user).include?(value.custom_field_id.to_s)
  end
end

#editable_custom_fields(user = nil) ⇒ Object

Returns the custom fields that can be edited by the given user



500
501
502
# File 'app/models/issue.rb', line 500

def editable_custom_fields(user=nil)
  editable_custom_field_values(user).map(&:custom_field).uniq
end

#estimated_hours=(h) ⇒ Object



377
378
379
# File 'app/models/issue.rb', line 377

def estimated_hours=(h)
  write_attribute :estimated_hours, (h.is_a?(String) ? h.to_hours : h)
end

#find_relation(relation_id) ⇒ Object

Finds an issue relation given its id.



940
941
942
# File 'app/models/issue.rb', line 940

def find_relation(relation_id)
  IssueRelation.where("issue_to_id = ? OR issue_from_id = ?", id, id).find(relation_id)
end

#fixed_version_id=(vid) ⇒ Object



276
277
278
279
# File 'app/models/issue.rb', line 276

def fixed_version_id=(vid)
  self.fixed_version = nil
  write_attribute(:fixed_version_id, vid)
end

#init_journal(user, notes = "") ⇒ Object



656
657
658
# File 'app/models/issue.rb', line 656

def init_journal(user, notes = "")
  @current_journal ||= Journal.new(:journalized => self, :user => user, :notes => notes)
end

#journalized_attribute_namesObject

Returns the names of attributes that are journalized when updating the issue



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

def journalized_attribute_names
  Issue.column_names - %w(id root_id lft rgt lock_version created_on updated_on closed_on)
end

#journals_after(journal_id) ⇒ Object

Returns a scope for journals that have an id greater than journal_id



680
681
682
683
684
685
686
# File 'app/models/issue.rb', line 680

def journals_after(journal_id)
  scope = journals.reorder("#{Journal.table_name}.id ASC")
  if journal_id.present?
    scope = scope.where("#{Journal.table_name}.id > ?", journal_id.to_i)
  end
  scope
end

#last_journal_idObject

Returns the id of the last journal or nil



671
672
673
674
675
676
677
# File 'app/models/issue.rb', line 671

def last_journal_id
  if new_record?
    nil
  else
    journals.maximum(:id)
  end
end

#new_statuses_allowed_to(user = User.current, include_default = false) ⇒ Object

Returns an array of statuses that user is able to apply



785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
# File 'app/models/issue.rb', line 785

def new_statuses_allowed_to(user=User.current, include_default=false)
  if new_record? && @copied_from
    [default_status, @copied_from.status].compact.uniq.sort
  else
    initial_status = nil
    if new_record?
      initial_status = default_status
    elsif tracker_id_changed?
      if Tracker.where(:id => tracker_id_was, :default_status_id => status_id_was).any?
        initial_status = default_status
      elsif tracker.issue_status_ids.include?(status_id_was)
        initial_status = IssueStatus.find_by_id(status_id_was)
      else
        initial_status = default_status
      end
    else
      initial_status = status_was
    end

    initial_assigned_to_id = assigned_to_id_changed? ? assigned_to_id_was : assigned_to_id
    assignee_transitions_allowed = initial_assigned_to_id.present? &&
      (user.id == initial_assigned_to_id || user.group_ids.include?(initial_assigned_to_id))

    statuses = []
    if initial_status
      statuses += initial_status.find_new_statuses_allowed_to(
        user.admin ? Role.all.to_a : user.roles_for_project(project),
        tracker,
        author == user,
        assignee_transitions_allowed
        )
    end
    statuses << initial_status unless statuses.empty?
    statuses << default_status if include_default
    statuses = statuses.compact.uniq.sort
    if blocked?
      statuses.reject!(&:is_closed?)
    end
    statuses
  end
end

#notified_usersObject

Returns the users that should be notified



837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
# File 'app/models/issue.rb', line 837

def notified_users
  notified = []
  # Author and assignee are always notified unless they have been
  # locked or don't want to be notified
  notified << author if author
  if assigned_to
    notified += (assigned_to.is_a?(Group) ? assigned_to.users : [assigned_to])
  end
  if assigned_to_was
    notified += (assigned_to_was.is_a?(Group) ? assigned_to_was.users : [assigned_to_was])
  end
  notified = notified.select {|u| u.active? && u.notify_about?(self)}

  notified += project.notified_users
  notified.uniq!
  # Remove users that can not view the issue
  notified.reject! {|user| !visible?(user)}
  notified
end

#overdue?Boolean

Returns true if the issue is overdue



730
731
732
# File 'app/models/issue.rb', line 730

def overdue?
  due_date.present? && (due_date < Date.today) && !closed?
end

#parent_issue_idObject



1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'app/models/issue.rb', line 1177

def parent_issue_id
  if @invalid_parent_issue_id
    @invalid_parent_issue_id
  elsif instance_variable_defined? :@parent_issue
    @parent_issue.nil? ? nil : @parent_issue.id
  else
    parent_id
  end
end

#parent_issue_id=(arg) ⇒ Object



1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
# File 'app/models/issue.rb', line 1164

def parent_issue_id=(arg)
  s = arg.to_s.strip.presence
  if s && (m = s.match(%r{\A#?(\d+)\z})) && (@parent_issue = Issue.find_by_id(m[1]))
    @invalid_parent_issue_id = nil
  elsif s.blank?
    @parent_issue = nil
    @invalid_parent_issue_id = nil
  else
    @parent_issue = nil
    @invalid_parent_issue_id = arg
  end
end

#priority_id=(pid) ⇒ Object



266
267
268
269
# File 'app/models/issue.rb', line 266

def priority_id=(pid)
  self.priority = nil
  write_attribute(:priority_id, pid)
end

#project=(project, keep_tracker = false) ⇒ Object

Sets the project. Unless keep_tracker argument is set to true, this will change the tracker to the first tracker of the new project if the previous tracker is not part of the new project trackers. This will clear the fixed_version is it's no longer valid for the new project. This will clear the parent issue if it's no longer valid for the new project. This will set the category to the category with the same name in the new project if it exists, or clear it if it doesn't.



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
# File 'app/models/issue.rb', line 323

def project=(project, keep_tracker=false)
  project_was = self.project
  association(:project).writer(project)
  if project_was && project && project_was != project
    @assignable_versions = nil

    unless keep_tracker || project.trackers.include?(tracker)
      self.tracker = project.trackers.first
    end
    # Reassign to the category with same name if any
    if category
      self.category = project.issue_categories.find_by_name(category.name)
    end
    # Keep the fixed_version if it's still valid in the new_project
    if fixed_version && fixed_version.project != project && !project.shared_versions.include?(fixed_version)
      self.fixed_version = nil
    end
    # Clear the parent task if it's no longer valid
    unless valid_parent_project?
      self.parent_issue_id = nil
    end
    @custom_field_values = nil
    @workflow_rule_by_attribute = nil
  end
  self.project
end

#project_id=(project_id) ⇒ Object



308
309
310
311
312
313
# File 'app/models/issue.rb', line 308

def project_id=(project_id)
  if project_id.to_s != self.project_id.to_s
    self.project = (project_id.present? ? Project.find_by_id(project_id) : nil)
  end
  self.project_id
end

#read_only_attribute_names(user = nil) ⇒ Object

Returns the names of attributes that are read-only for user or the current user For users with multiple roles, the read-only fields are the intersection of read-only fields of each role The result is an array of strings where sustom fields are represented with their ids

Examples:

issue.read_only_attribute_names # => ['due_date', '2']
issue.read_only_attribute_names(user) # => []


512
513
514
# File 'app/models/issue.rb', line 512

def read_only_attribute_names(user=nil)
  workflow_rule_by_attribute(user).reject {|attr, rule| rule != 'readonly'}.keys
end

#recipientsObject

Returns the email addresses that should be notified



858
859
860
# File 'app/models/issue.rb', line 858

def recipients
  notified_users.collect(&:mail)
end

#relationsObject



894
895
896
# File 'app/models/issue.rb', line 894

def relations
  @relations ||= IssueRelation::Relations.new(self, (relations_from + relations_to).sort)
end

#reload(*args) ⇒ Object



202
203
204
205
206
207
208
# File 'app/models/issue.rb', line 202

def reload(*args)
  @workflow_rule_by_attribute = nil
  @assignable_versions = nil
  @relations = nil
  @spent_hours = nil
  base_reload(*args)
end

#reopening?Boolean Also known as: reopened?

Return true if the issue is being reopened



711
712
713
714
715
716
717
# File 'app/models/issue.rb', line 711

def reopening?
  if new_record?
    false
  else
    status_id_changed? && !closed? && was_closed?
  end
end

#required_attribute?(name, user = nil) ⇒ Boolean

Returns true if the attribute is required for user



529
530
531
# File 'app/models/issue.rb', line 529

def required_attribute?(name, user=nil)
  required_attribute_names(user).include?(name.to_s)
end

#required_attribute_names(user = nil) ⇒ Object

Returns the names of required attributes for user or the current user For users with multiple roles, the required fields are the intersection of required fields of each role The result is an array of strings where sustom fields are represented with their ids

Examples:

issue.required_attribute_names # => ['due_date', '2']
issue.required_attribute_names(user) # => []


524
525
526
# File 'app/models/issue.rb', line 524

def required_attribute_names(user=nil)
  workflow_rule_by_attribute(user).reject {|attr, rule| rule != 'required'}.keys
end

#reschedule_on(date) ⇒ Object

Sets start_date on the given date or the next working day and changes due_date to keep the same working duration.



1076
1077
1078
1079
1080
1081
# File 'app/models/issue.rb', line 1076

def reschedule_on(date)
  wd = working_duration
  date = next_working_date(date)
  self.start_date = date
  self.due_date = add_working_days(date, wd)
end

#reschedule_on!(date) ⇒ Object

Reschedules the issue on the given date or the next working day and saves the record. If the issue is a parent task, this is done by rescheduling its subtasks.



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
# File 'app/models/issue.rb', line 1085

def reschedule_on!(date)
  return if date.nil?
  if leaf?
    if start_date.nil? || start_date != date
      if start_date && start_date > date
        # Issue can not be moved earlier than its soonest start date
        date = [soonest_start(true), date].compact.max
      end
      reschedule_on(date)
      begin
        save
      rescue ActiveRecord::StaleObjectError
        reload
        reschedule_on(date)
        save
      end
    end
  else
    leaves.each do |leaf|
      if leaf.start_date
        # Only move subtask if it starts at the same date as the parent
        # or if it starts before the given date
        if start_date == leaf.start_date || date > leaf.start_date
          leaf.reschedule_on!(date)
        end
      else
        leaf.reschedule_on!(date)
      end
    end
  end
end

#safe_attribute_names(user = nil) ⇒ Object



427
428
429
430
431
432
# File 'app/models/issue.rb', line 427

def safe_attribute_names(user=nil)
  names = super
  names -= disabled_core_fields
  names -= read_only_attribute_names(user)
  names
end

#safe_attributes=(attrs, user = User.current) ⇒ Object

Safely sets attributes Should be called from controllers instead of #attributes= attr_accessible is too rough because we still want things like Issue.new(:project => foo) to work



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
# File 'app/models/issue.rb', line 438

def safe_attributes=(attrs, user=User.current)
  return unless attrs.is_a?(Hash)

  attrs = attrs.deep_dup

  # Project and Tracker must be set before since new_statuses_allowed_to depends on it.
  if (p = attrs.delete('project_id')) && safe_attribute?('project_id')
    if allowed_target_projects(user).where(:id => p.to_i).exists?
      self.project_id = p
    end
  end

  if (t = attrs.delete('tracker_id')) && safe_attribute?('tracker_id')
    self.tracker_id = t
  end

  if (s = attrs.delete('status_id')) && safe_attribute?('status_id')
    if new_statuses_allowed_to(user).collect(&:id).include?(s.to_i)
      self.status_id = s
    end
  end

  attrs = delete_unsafe_attributes(attrs, user)
  return if attrs.empty?

  unless leaf?
    attrs.reject! {|k,v| %w(priority_id done_ratio start_date due_date estimated_hours).include?(k)}
  end

  if attrs['parent_issue_id'].present?
    s = attrs['parent_issue_id'].to_s
    unless (m = s.match(%r{\A#?(\d+)\z})) && (m[1] == parent_id.to_s || Issue.visible(user).exists?(m[1]))
      @invalid_parent_issue_id = attrs.delete('parent_issue_id')
    end
  end

  if attrs['custom_field_values'].present?
    editable_custom_field_ids = editable_custom_field_values(user).map {|v| v.custom_field_id.to_s}
    attrs['custom_field_values'].select! {|k, v| editable_custom_field_ids.include?(k.to_s)}
  end

  if attrs['custom_fields'].present?
    editable_custom_field_ids = editable_custom_field_values(user).map {|v| v.custom_field_id.to_s}
    attrs['custom_fields'].select! {|c| editable_custom_field_ids.include?(c['id'].to_s)}
  end

  # mass-assignment security bypass
  assign_attributes attrs, :without_protection => true
end

#soonest_start(reload = false) ⇒ Object



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

def soonest_start(reload=false)
  @soonest_start = nil if reload
  @soonest_start ||= (
      relations_to(reload).collect{|relation| relation.successor_soonest_start} +
      [(@parent_issue || parent).try(:soonest_start)]
    ).compact.max
end

#spent_hoursObject

Returns the number of hours spent on this issue



878
879
880
# File 'app/models/issue.rb', line 878

def spent_hours
  @spent_hours ||= time_entries.sum(:hours) || 0
end

#status=(status) ⇒ Object

Sets the status.



259
260
261
262
263
264
# File 'app/models/issue.rb', line 259

def status=(status)
  if status != self.status
    @workflow_rule_by_attribute = nil
  end
  association(:status).writer(status)
end

#status_id=(status_id) ⇒ Object



251
252
253
254
255
256
# File 'app/models/issue.rb', line 251

def status_id=(status_id)
  if status_id.to_s != self.status_id.to_s
    self.status = (status_id.present? ? IssueStatus.find_by_id(status_id) : nil)
  end
  self.status_id
end

#status_wasObject

Returns the initial status of the issue Returns nil for a new issue



690
691
692
693
694
695
696
697
698
# File 'app/models/issue.rb', line 690

def status_was
  if status_id_changed?
    if status_id_was.to_i > 0
      @status_was ||= IssueStatus.find_by_id(status_id_was)
    end
  else
    @status_was ||= status
  end
end

#to_sObject



1127
1128
1129
# File 'app/models/issue.rb', line 1127

def to_s
  "#{tracker} ##{id}: #{subject}"
end

#total_spent_hoursObject

Returns the total number of hours spent on this issue and its descendants

Example:

spent_hours => 0.0
spent_hours => 50.2


887
888
889
890
891
892
# File 'app/models/issue.rb', line 887

def total_spent_hours
  @total_spent_hours ||=
    self_and_descendants.
      joins("LEFT JOIN #{TimeEntry.table_name} ON #{TimeEntry.table_name}.issue_id = #{Issue.table_name}.id").
      sum("#{TimeEntry.table_name}.hours").to_f || 0.0
end

#tracker=(tracker) ⇒ Object

Sets the tracker. This will set the status to the default status of the new tracker if:

  • the status was the default for the previous tracker

  • or if the status was not part of the new tracker statuses

  • or the status was nil



293
294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'app/models/issue.rb', line 293

def tracker=(tracker)
  if tracker != self.tracker 
    if status == default_status
      self.status = nil
    elsif status && tracker && !tracker.issue_status_ids.include?(status.id)
      self.status = nil
    end
    @custom_field_values = nil
    @workflow_rule_by_attribute = nil
  end
  association(:tracker).writer(tracker)
  self.status ||= default_status
  self.tracker
end

#tracker_id=(tracker_id) ⇒ Object



281
282
283
284
285
286
# File 'app/models/issue.rb', line 281

def tracker_id=(tracker_id)
  if tracker_id.to_s != self.tracker_id.to_s
    self.tracker = (tracker_id.present? ? Tracker.find_by_id(tracker_id) : nil)
  end
  self.tracker_id
end

#update_done_ratio_from_issue_statusObject

Set the done_ratio using the status if that setting is set. This will keep the done_ratios even if the user turns off the setting later



650
651
652
653
654
# File 'app/models/issue.rb', line 650

def update_done_ratio_from_issue_status
  if Issue.use_status_for_done_ratio? && status && status.default_done_ratio
    self.done_ratio = status.default_done_ratio
  end
end

#valid_parent_project?(issue = parent) ⇒ Boolean

Returns true if issue's project is a valid parent issue project



1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
# File 'app/models/issue.rb', line 1189

def valid_parent_project?(issue=parent)
  return true if issue.nil? || issue.project_id == project_id

  case Setting.cross_project_subtasks
  when 'system'
    true
  when 'tree'
    issue.project.root == project.root
  when 'hierarchy'
    issue.project.is_or_is_ancestor_of?(project) || issue.project.is_descendant_of?(project)
  when 'descendants'
    issue.project.is_or_is_ancestor_of?(project)
  else
    false
  end
end

#validate_issueObject



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
# File 'app/models/issue.rb', line 584

def validate_issue
  if due_date && start_date && (start_date_changed? || due_date_changed?) && due_date < start_date
    errors.add :due_date, :greater_than_start_date
  end

  if start_date && start_date_changed? && soonest_start && start_date < soonest_start
    errors.add :start_date, :earlier_than_minimum_start_date, :date => format_date(soonest_start)
  end

  if fixed_version
    if !assignable_versions.include?(fixed_version)
      errors.add :fixed_version_id, :inclusion
    elsif reopening? && fixed_version.closed?
      errors.add :base, I18n.t(:error_can_not_reopen_issue_on_closed_version)
    end
  end

  # Checks that the issue can not be added/moved to a disabled tracker
  if project && (tracker_id_changed? || project_id_changed?)
    unless project.trackers.include?(tracker)
      errors.add :tracker_id, :inclusion
    end
  end

  # Checks parent issue assignment
  if @invalid_parent_issue_id.present?
    errors.add :parent_issue_id, :invalid
  elsif @parent_issue
    if !valid_parent_project?(@parent_issue)
      errors.add :parent_issue_id, :invalid
    elsif (@parent_issue != parent) && (all_dependent_issues.include?(@parent_issue) || @parent_issue.all_dependent_issues.include?(self))
      errors.add :parent_issue_id, :invalid
    elsif !new_record?
      # moving an existing issue
      if @parent_issue.root_id != root_id
        # we can always move to another tree
      elsif move_possible?(@parent_issue)
        # move accepted inside tree
      else
        errors.add :parent_issue_id, :invalid
      end
    end
  end
end

#validate_required_fieldsObject

Validates the issue against additional workflow requirements



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'app/models/issue.rb', line 630

def validate_required_fields
  user = new_record? ? author : current_journal.try(:user)

  required_attribute_names(user).each do |attribute|
    if attribute =~ /^\d+$/
      attribute = attribute.to_i
      v = custom_field_values.detect {|v| v.custom_field_id == attribute }
      if v && v.value.blank?
        errors.add :base, v.custom_field.name + ' ' + l('activerecord.errors.messages.blank')
      end
    else
      if respond_to?(attribute) && send(attribute).blank? && !disabled_core_fields.include?(attribute)
        errors.add attribute, :blank
      end
    end
  end
end

#visible?(usr = nil) ⇒ Boolean

Returns true if usr or current user is allowed to view the issue



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'app/models/issue.rb', line 139

def visible?(usr=nil)
  (usr || User.current).allowed_to?(:view_issues, self.project) do |role, user|
    if user.logged?
      case role.issues_visibility
      when 'all'
        true
      when 'default'
        !self.is_private? || (self.author == user || user.is_or_belongs_to?(assigned_to))
      when 'own'
        self.author == user || user.is_or_belongs_to?(assigned_to)
      else
        false
      end
    else
      !self.is_private?
    end
  end
end

#visible_custom_field_values(user = nil) ⇒ Object



215
216
217
218
219
220
# File 'app/models/issue.rb', line 215

def visible_custom_field_values(user=nil)
  user_real = user || User.current
  custom_field_values.select do |value|
    value.custom_field.visible_by?(project, user_real)
  end
end

#was_closed?Boolean

Returns true if the issue was closed when loaded



706
707
708
# File 'app/models/issue.rb', line 706

def was_closed?
  status_was.present? && status_was.is_closed?
end

#working_durationObject

Returns the duration in working days



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

def working_duration
  (start_date && due_date) ? working_days(start_date, due_date) : 0
end