BigW Consortium Gitlab

issue.rb 8.81 KB
Newer Older
1 2
require 'carrierwave/orm/activerecord'

gitlabhq committed
3
class Issue < ActiveRecord::Base
4
  include InternalId
5
  include Issuable
6
  include Noteable
7
  include Referable
8
  include Sortable
9
  include Spammable
10
  include FasterCacheKeys
11
  include RelativePositioning
12
  include CreatedAtFilterable
13

Rémy Coutable committed
14 15 16 17 18 19
  DueDateStruct = Struct.new(:title, :name).freeze
  NoDueDate     = DueDateStruct.new('No Due Date', '0').freeze
  AnyDueDate    = DueDateStruct.new('Any Due Date', '').freeze
  Overdue       = DueDateStruct.new('Overdue', 'overdue').freeze
  DueThisWeek   = DueDateStruct.new('Due This Week', 'week').freeze
  DueThisMonth  = DueDateStruct.new('Due This Month', 'month').freeze
20

21
  belongs_to :project
22 23
  belongs_to :moved_to, class_name: 'Issue'

24
  has_many :events, as: :target, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
25

26 27 28 29 30 31
  has_many :merge_requests_closing_issues,
    class_name: 'MergeRequestsClosingIssues',
    dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent

  has_many :issue_assignees
  has_many :assignees, class_name: "User", through: :issue_assignees
32

33 34 35
  has_many :issue_assignees
  has_many :assignees, class_name: "User", through: :issue_assignees

36 37
  validates :project, presence: true

38
  scope :in_projects, ->(project_ids) { where(project_id: project_ids) }
39

40 41 42 43
  scope :assigned, -> { where('EXISTS (SELECT TRUE FROM issue_assignees WHERE issue_id = issues.id)') }
  scope :unassigned, -> { where('NOT EXISTS (SELECT TRUE FROM issue_assignees WHERE issue_id = issues.id)') }
  scope :assigned_to, ->(u) { where('EXISTS (SELECT TRUE FROM issue_assignees WHERE user_id = ? AND issue_id = issues.id)', u.id)}

44 45 46 47
  scope :without_due_date, -> { where(due_date: nil) }
  scope :due_before, ->(date) { where('issues.due_date < ?', date) }
  scope :due_between, ->(from_date, to_date) { where('issues.due_date >= ?', from_date).where('issues.due_date <= ?', to_date) }

48 49 50
  scope :order_due_date_asc, -> { reorder('issues.due_date IS NULL, issues.due_date ASC') }
  scope :order_due_date_desc, -> { reorder('issues.due_date IS NULL, issues.due_date DESC') }

51
  scope :preload_associations, -> { preload(:labels, project: :namespace) }
52

53 54
  scope :public_only, -> { where(confidential: false) }

Regis Boudinot committed
55
  after_save :expire_etag_cache
56
  after_commit :update_project_counter_caches, on: :destroy
Regis Boudinot committed
57

58 59
  attr_spammable :title, spam_title: true
  attr_spammable :description, spam_description: true
60

61 62
  participant :assignees

Andrew8xx8 committed
63
  state_machine :state, initial: :opened do
Andrew8xx8 committed
64
    event :close do
65
      transition [:opened] => :closed
Andrew8xx8 committed
66 67 68
    end

    event :reopen do
69
      transition closed: :opened
Andrew8xx8 committed
70 71 72 73
    end

    state :opened
    state :closed
74 75 76 77

    before_transition any => :closed do |issue|
      issue.closed_at = Time.zone.now
    end
Andrew8xx8 committed
78
  end
79

80
  def hook_attrs
81 82
    assignee_ids = self.assignee_ids

83 84 85
    attrs = {
      total_time_spent: total_time_spent,
      human_total_time_spent: human_total_time_spent,
86 87 88
      human_time_estimate: human_time_estimate,
      assignee_ids: assignee_ids,
      assignee_id: assignee_ids.first # This key is deprecated
89 90 91
    }

    attributes.merge!(attrs)
92 93
  end

94 95 96 97
  def self.reference_prefix
    '#'
  end

98 99 100 101
  # Pattern used to extract `#123` issue references from text
  #
  # This pattern supports cross-project references.
  def self.reference_pattern
102
    @reference_pattern ||= %r{
103 104
      (#{Project.reference_pattern})?
      #{Regexp.escape(reference_prefix)}(?<issue>\d+)
105
    }x
Kirill Zaitsev committed
106 107
  end

108
  def self.link_reference_pattern
109
    @link_reference_pattern ||= super("issues", /(?<issue>\d+)/)
110 111
  end

112 113 114 115
  def self.reference_valid?(reference)
    reference.to_i > 0 && reference.to_i <= Gitlab::Database::MAX_INT_VALUE
  end

116 117 118 119
  def self.project_foreign_key
    'project_id'
  end

120
  def self.sort(method, excluded_labels: [])
121 122
    case method.to_s
    when 'due_date_asc' then order_due_date_asc
123
    when 'due_date_desc' then order_due_date_desc
124 125 126 127 128
    else
      super
    end
  end

129
  def self.order_by_position_and_priority
130 131
    order_labels_priority
      .reorder(Gitlab::Database.nulls_last_order('relative_position', 'ASC'),
132 133 134 135
              Gitlab::Database.nulls_last_order('highest_priority', 'ASC'),
              "id DESC")
  end

136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
  # Returns a Hash of attributes to be used for Twitter card metadata
  def card_attributes
    {
      'Author'   => author.try(:name),
      'Assignee' => assignee_list
    }
  end

  def assignee_or_author?(user)
    author_id == user.id || assignees.exists?(user.id)
  end

  def assignee_list
    assignees.map(&:name).to_sentence
  end

152
  # `from` argument can be a Namespace or Project.
153
  def to_reference(from = nil, full: false)
154 155
    reference = "#{self.class.reference_prefix}#{iid}"

156
    "#{project.to_reference(from, full: full)}#{reference}"
157 158
  end

159
  def referenced_merge_requests(current_user = nil)
Yorick Peterse committed
160 161 162 163
    ext = all_references(current_user)

    notes_with_associations.each do |object|
      object.all_references(current_user, extractor: ext)
164
    end
Yorick Peterse committed
165 166

    ext.merge_requests.sort_by(&:iid)
167 168
  end

169
  # All branches containing the current issue's ID, except for
170
  # those with a merge request open referencing the current issue.
171 172
  def related_branches(current_user)
    branches_with_iid = project.repository.branch_names.select do |branch|
173
      branch =~ /\A#{iid}-(?!\d+-stable)/i
174
    end
175 176 177 178

    branches_with_merge_request = self.referenced_merge_requests(current_user).map(&:source_branch)

    branches_with_iid - branches_with_merge_request
179 180
  end

181 182
  # Returns boolean if a related branch exists for the current issue
  # ignores merge requests branchs
183
  def has_related_branch?
184 185 186 187 188
    project.repository.branch_names.any? do |branch|
      /\A#{iid}-(?!\d+-stable)/i =~ branch
    end
  end

189 190 191 192
  # To allow polymorphism with MergeRequest.
  def source_project
    project
  end
193 194 195

  # From all notes on this issue, we'll select the system notes about linked
  # merge requests. Of those, the MRs closing `self` are returned.
196
  def closed_by_merge_requests(current_user = nil)
197
    return [] unless open?
198

Yorick Peterse committed
199 200 201 202 203 204
    ext = all_references(current_user)

    notes.system.each do |note|
      note.all_references(current_user, extractor: ext)
    end

205 206 207 208 209 210 211
    merge_requests = ext.merge_requests.select(&:open?)
    if merge_requests.any?
      ids = MergeRequestsClosingIssues.where(merge_request_id: merge_requests.map(&:id), issue_id: id).pluck(:merge_request_id)
      merge_requests.select { |mr| mr.id.in?(ids) }
    else
      []
    end
212
  end
213

214 215 216 217 218 219 220 221 222
  def moved?
    !moved_to.nil?
  end

  def can_move?(user, to_project = nil)
    if to_project
      return false unless user.can?(:admin_issue, to_project)
    end

223 224
    !moved? && persisted? &&
      user.can?(:admin_issue, self.project)
225
  end
226

227
  def to_branch_name
228
    if self.confidential?
229
      "#{iid}-confidential-issue"
230
    else
231
      "#{iid}-#{title.parameterize}"
232
    end
233 234
  end

235
  def can_be_worked_on?(current_user)
236
    !self.closed? &&
237
      !self.project.forked? &&
238
      self.related_branches(current_user).empty? &&
239
      self.closed_by_merge_requests(current_user).empty?
240
  end
241

242 243 244
  # Returns `true` if the current issue can be viewed by either a logged in User
  # or an anonymous user.
  def visible_to_user?(user = nil)
245
    return false unless project && project.feature_available?(:issues, user)
246

247
    user ? readable_by?(user) : publicly_visible?
248 249
  end

250
  def overdue?
Rémy Coutable committed
251
    due_date.try(:past?) || false
252
  end
253 254

  def check_for_spam?
255
    project.public? && (title_changed? || description_changed?)
256
  end
257 258 259

  def as_json(options = {})
    super(options).tap do |json|
260
      json[:subscribed] = subscribed?(options[:user], project) if options.key?(:user) && options[:user]
261

262
      if options.key?(:labels)
263 264
        json[:labels] = labels.as_json(
          project: project,
265
          only: [:id, :title, :description, :color, :priority],
266 267 268
          methods: [:text_color]
        )
      end
269 270
    end
  end
271

272 273 274 275
  def update_project_counter_caches?
    state_changed? || confidential_changed?
  end

276
  def update_project_counter_caches
277 278
    return unless update_project_counter_caches?

279 280 281
    Projects::OpenIssuesCountService.new(project).refresh_cache
  end

282 283 284 285 286 287 288 289 290 291 292 293 294 295
  private

  # Returns `true` if the given User can read the current Issue.
  #
  # This method duplicates the same check of issue_policy.rb
  # for performance reasons, check commit: 002ad215818450d2cbbc5fa065850a953dc7ada8
  # Make sure to sync this method with issue_policy.rb
  def readable_by?(user)
    if user.admin?
      true
    elsif project.owner == user
      true
    elsif confidential?
      author == user ||
296
        assignees.include?(user) ||
297 298 299 300 301 302 303 304 305 306 307 308
        project.team.member?(user, Gitlab::Access::REPORTER)
    else
      project.public? ||
        project.internal? && !user.external? ||
        project.team.member?(user)
    end
  end

  # Returns `true` if this Issue is visible to everybody.
  def publicly_visible?
    project.public? && !confidential?
  end
Regis Boudinot committed
309 310

  def expire_etag_cache
311
    key = Gitlab::Routing.url_helpers.realtime_changes_project_issue_path(project, self)
Regis Boudinot committed
312 313
    Gitlab::EtagCaching::Store.new.touch(key)
  end
gitlabhq committed
314
end