BigW Consortium Gitlab

issue.rb 8.59 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 Spammable
9
  include FasterCacheKeys
10
  include RelativePositioning
11
  include TimeTrackable
12

Rémy Coutable committed
13 14 15 16 17 18
  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
19

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

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

25 26 27 28 29 30
  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
31

32 33
  validates :project, presence: true

34
  scope :in_projects, ->(project_ids) { where(project_id: project_ids) }
35

36 37 38 39
  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)}

40 41 42 43
  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) }

44 45 46
  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') }

47
  scope :preload_associations, -> { preload(:labels, project: :namespace) }
48

49 50
  scope :public_only, -> { where(confidential: false) }

Regis Boudinot committed
51 52
  after_save :expire_etag_cache

53 54
  attr_spammable :title, spam_title: true
  attr_spammable :description, spam_description: true
55

56 57
  participant :assignees

Andrew8xx8 committed
58
  state_machine :state, initial: :opened do
Andrew8xx8 committed
59
    event :close do
60
      transition [:opened] => :closed
Andrew8xx8 committed
61 62 63
    end

    event :reopen do
64
      transition closed: :opened
Andrew8xx8 committed
65 66 67 68
    end

    state :opened
    state :closed
69 70 71 72

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

75 76
  acts_as_paranoid

77 78 79 80
  def self.reference_prefix
    '#'
  end

81 82 83 84
  # Pattern used to extract `#123` issue references from text
  #
  # This pattern supports cross-project references.
  def self.reference_pattern
85
    @reference_pattern ||= %r{
86 87
      (#{Project.reference_pattern})?
      #{Regexp.escape(reference_prefix)}(?<issue>\d+)
88
    }x
Kirill Zaitsev committed
89 90
  end

91
  def self.link_reference_pattern
92
    @link_reference_pattern ||= super("issues", /(?<issue>\d+)/)
93 94
  end

95 96 97 98
  def self.reference_valid?(reference)
    reference.to_i > 0 && reference.to_i <= Gitlab::Database::MAX_INT_VALUE
  end

99 100 101 102
  def self.project_foreign_key
    'project_id'
  end

103
  def self.sort(method, excluded_labels: [])
104
    case method.to_s
105 106
    when 'due_date'      then order_due_date_asc
    when 'due_date_asc'  then order_due_date_asc
107
    when 'due_date_desc' then order_due_date_desc
108 109 110 111 112
    else
      super
    end
  end

113
  def self.order_by_position_and_priority
114 115
    order_labels_priority
      .reorder(Gitlab::Database.nulls_last_order('relative_position', 'ASC'),
116 117 118 119
              Gitlab::Database.nulls_last_order('highest_priority', 'ASC'),
              "id DESC")
  end

120
  def hook_attrs
121
    Gitlab::HookData::IssueBuilder.new(self).build
122 123
  end

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
  # 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

140
  # `from` argument can be a Namespace or Project.
141
  def to_reference(from = nil, full: false)
142 143
    reference = "#{self.class.reference_prefix}#{iid}"

144
    "#{project.to_reference(from, full: full)}#{reference}"
145 146
  end

147
  def referenced_merge_requests(current_user = nil)
Yorick Peterse committed
148 149 150 151
    ext = all_references(current_user)

    notes_with_associations.each do |object|
      object.all_references(current_user, extractor: ext)
152
    end
Yorick Peterse committed
153 154

    ext.merge_requests.sort_by(&:iid)
155 156
  end

157
  # All branches containing the current issue's ID, except for
158
  # those with a merge request open referencing the current issue.
159 160
  def related_branches(current_user)
    branches_with_iid = project.repository.branch_names.select do |branch|
161
      branch =~ /\A#{iid}-(?!\d+-stable)/i
162
    end
163 164 165 166

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

    branches_with_iid - branches_with_merge_request
167 168
  end

169 170
  # Returns boolean if a related branch exists for the current issue
  # ignores merge requests branchs
171
  def has_related_branch?
172 173 174 175 176
    project.repository.branch_names.any? do |branch|
      /\A#{iid}-(?!\d+-stable)/i =~ branch
    end
  end

177 178 179 180
  # To allow polymorphism with MergeRequest.
  def source_project
    project
  end
181 182 183

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

Yorick Peterse committed
187 188 189 190 191 192
    ext = all_references(current_user)

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

193 194 195 196 197 198 199
    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
200
  end
201

202 203 204 205 206 207 208 209 210
  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

211 212
    !moved? && persisted? &&
      user.can?(:admin_issue, self.project)
213
  end
214

215
  def to_branch_name
216
    if self.confidential?
217
      "#{iid}-confidential-issue"
218
    else
219
      "#{iid}-#{title.parameterize}"
220
    end
221 222
  end

223
  def can_be_worked_on?(current_user)
224
    !self.closed? &&
225
      !self.project.forked? &&
226
      self.related_branches(current_user).empty? &&
227
      self.closed_by_merge_requests(current_user).empty?
228
  end
229

230 231 232
  # 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)
233
    return false unless project && project.feature_available?(:issues, user)
234

235
    user ? readable_by?(user) : publicly_visible?
236 237
  end

238
  def overdue?
Rémy Coutable committed
239
    due_date.try(:past?) || false
240
  end
241 242

  def check_for_spam?
243
    project.public? && (title_changed? || description_changed?)
244
  end
245 246 247

  def as_json(options = {})
    super(options).tap do |json|
248 249 250 251 252 253
      if options.key?(:sidebar_endpoints) && project
        url_helper = Gitlab::Routing.url_helpers

        json.merge!(issue_sidebar_endpoint: url_helper.project_issue_path(project, self, format: :json, serializer: 'sidebar'),
                    toggle_subscription_endpoint: url_helper.toggle_subscription_project_issue_path(project, self))
      end
254

255
      if options.key?(:labels)
256 257
        json[:labels] = labels.as_json(
          project: project,
258
          only: [:id, :title, :description, :color, :priority],
259 260 261
          methods: [:text_color]
        )
      end
262 263
    end
  end
264

265 266 267 268
  def discussions_rendered_on_frontend?
    true
  end

269 270 271 272
  def update_project_counter_caches
    Projects::OpenIssuesCountService.new(project).refresh_cache
  end

273 274 275 276 277 278 279 280 281 282 283 284 285 286
  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 ||
287
        assignees.include?(user) ||
288 289 290 291 292 293 294 295 296 297 298 299
        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
300 301

  def expire_etag_cache
302
    key = Gitlab::Routing.url_helpers.realtime_changes_project_issue_path(project, self)
Regis Boudinot committed
303 304
    Gitlab::EtagCaching::Store.new.touch(key)
  end
gitlabhq committed
305
end