309 lines
8.7 KiB
Ruby
309 lines
8.7 KiB
Ruby
require 'carrierwave/orm/activerecord'
|
|
|
|
class Issue < ActiveRecord::Base
|
|
include InternalId
|
|
include Issuable
|
|
include Noteable
|
|
include Referable
|
|
include Sortable
|
|
include Spammable
|
|
include FasterCacheKeys
|
|
include RelativePositioning
|
|
include CreatedAtFilterable
|
|
|
|
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
|
|
|
|
belongs_to :project
|
|
belongs_to :moved_to, class_name: 'Issue'
|
|
|
|
has_many :events, as: :target, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
|
|
|
|
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
|
|
|
|
has_many :issue_assignees
|
|
has_many :assignees, class_name: "User", through: :issue_assignees
|
|
|
|
validates :project, presence: true
|
|
|
|
scope :in_projects, ->(project_ids) { where(project_id: project_ids) }
|
|
|
|
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)}
|
|
|
|
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) }
|
|
|
|
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') }
|
|
|
|
scope :preload_associations, -> { preload(:labels, project: :namespace) }
|
|
|
|
scope :public_only, -> { where(confidential: false) }
|
|
|
|
after_save :expire_etag_cache
|
|
after_commit :update_project_counter_caches, on: :destroy
|
|
|
|
attr_spammable :title, spam_title: true
|
|
attr_spammable :description, spam_description: true
|
|
|
|
participant :assignees
|
|
|
|
state_machine :state, initial: :opened do
|
|
event :close do
|
|
transition [:opened] => :closed
|
|
end
|
|
|
|
event :reopen do
|
|
transition closed: :opened
|
|
end
|
|
|
|
state :opened
|
|
state :closed
|
|
|
|
before_transition any => :closed do |issue|
|
|
issue.closed_at = Time.zone.now
|
|
end
|
|
end
|
|
|
|
def hook_attrs
|
|
assignee_ids = self.assignee_ids
|
|
|
|
attrs = {
|
|
total_time_spent: total_time_spent,
|
|
human_total_time_spent: human_total_time_spent,
|
|
human_time_estimate: human_time_estimate,
|
|
assignee_ids: assignee_ids,
|
|
assignee_id: assignee_ids.first # This key is deprecated
|
|
}
|
|
|
|
attributes.merge!(attrs)
|
|
end
|
|
|
|
def self.reference_prefix
|
|
'#'
|
|
end
|
|
|
|
# Pattern used to extract `#123` issue references from text
|
|
#
|
|
# This pattern supports cross-project references.
|
|
def self.reference_pattern
|
|
@reference_pattern ||= %r{
|
|
(#{Project.reference_pattern})?
|
|
#{Regexp.escape(reference_prefix)}(?<issue>\d+)
|
|
}x
|
|
end
|
|
|
|
def self.link_reference_pattern
|
|
@link_reference_pattern ||= super("issues", /(?<issue>\d+)/)
|
|
end
|
|
|
|
def self.reference_valid?(reference)
|
|
reference.to_i > 0 && reference.to_i <= Gitlab::Database::MAX_INT_VALUE
|
|
end
|
|
|
|
def self.project_foreign_key
|
|
'project_id'
|
|
end
|
|
|
|
def self.sort(method, excluded_labels: [])
|
|
case method.to_s
|
|
when 'due_date_asc' then order_due_date_asc
|
|
when 'due_date_desc' then order_due_date_desc
|
|
else
|
|
super
|
|
end
|
|
end
|
|
|
|
def self.order_by_position_and_priority
|
|
order_labels_priority
|
|
.reorder(Gitlab::Database.nulls_last_order('relative_position', 'ASC'),
|
|
Gitlab::Database.nulls_last_order('highest_priority', 'ASC'),
|
|
"id DESC")
|
|
end
|
|
|
|
# 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
|
|
|
|
# `from` argument can be a Namespace or Project.
|
|
def to_reference(from = nil, full: false)
|
|
reference = "#{self.class.reference_prefix}#{iid}"
|
|
|
|
"#{project.to_reference(from, full: full)}#{reference}"
|
|
end
|
|
|
|
def referenced_merge_requests(current_user = nil)
|
|
ext = all_references(current_user)
|
|
|
|
notes_with_associations.each do |object|
|
|
object.all_references(current_user, extractor: ext)
|
|
end
|
|
|
|
ext.merge_requests.sort_by(&:iid)
|
|
end
|
|
|
|
# All branches containing the current issue's ID, except for
|
|
# those with a merge request open referencing the current issue.
|
|
def related_branches(current_user)
|
|
branches_with_iid = project.repository.branch_names.select do |branch|
|
|
branch =~ /\A#{iid}-(?!\d+-stable)/i
|
|
end
|
|
|
|
branches_with_merge_request = self.referenced_merge_requests(current_user).map(&:source_branch)
|
|
|
|
branches_with_iid - branches_with_merge_request
|
|
end
|
|
|
|
# Returns boolean if a related branch exists for the current issue
|
|
# ignores merge requests branchs
|
|
def has_related_branch?
|
|
project.repository.branch_names.any? do |branch|
|
|
/\A#{iid}-(?!\d+-stable)/i =~ branch
|
|
end
|
|
end
|
|
|
|
# To allow polymorphism with MergeRequest.
|
|
def source_project
|
|
project
|
|
end
|
|
|
|
# From all notes on this issue, we'll select the system notes about linked
|
|
# merge requests. Of those, the MRs closing `self` are returned.
|
|
def closed_by_merge_requests(current_user = nil)
|
|
return [] unless open?
|
|
|
|
ext = all_references(current_user)
|
|
|
|
notes.system.each do |note|
|
|
note.all_references(current_user, extractor: ext)
|
|
end
|
|
|
|
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
|
|
end
|
|
|
|
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
|
|
|
|
!moved? && persisted? &&
|
|
user.can?(:admin_issue, self.project)
|
|
end
|
|
|
|
def to_branch_name
|
|
if self.confidential?
|
|
"#{iid}-confidential-issue"
|
|
else
|
|
"#{iid}-#{title.parameterize}"
|
|
end
|
|
end
|
|
|
|
def can_be_worked_on?(current_user)
|
|
!self.closed? &&
|
|
!self.project.forked? &&
|
|
self.related_branches(current_user).empty? &&
|
|
self.closed_by_merge_requests(current_user).empty?
|
|
end
|
|
|
|
# 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)
|
|
return false unless project && project.feature_available?(:issues, user)
|
|
|
|
user ? readable_by?(user) : publicly_visible?
|
|
end
|
|
|
|
def overdue?
|
|
due_date.try(:past?) || false
|
|
end
|
|
|
|
def check_for_spam?
|
|
project.public? && (title_changed? || description_changed?)
|
|
end
|
|
|
|
def as_json(options = {})
|
|
super(options).tap do |json|
|
|
json[:subscribed] = subscribed?(options[:user], project) if options.key?(:user) && options[:user]
|
|
|
|
if options.key?(:labels)
|
|
json[:labels] = labels.as_json(
|
|
project: project,
|
|
only: [:id, :title, :description, :color, :priority],
|
|
methods: [:text_color]
|
|
)
|
|
end
|
|
end
|
|
end
|
|
|
|
def update_project_counter_caches
|
|
Projects::OpenIssuesCountService.new(project).refresh_cache
|
|
end
|
|
|
|
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 ||
|
|
assignees.include?(user) ||
|
|
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
|
|
|
|
def expire_etag_cache
|
|
key = Gitlab::Routing.url_helpers.realtime_changes_project_issue_path(project, self)
|
|
Gitlab::EtagCaching::Store.new.touch(key)
|
|
end
|
|
end
|