debian-mirror-gitlab/app/services/issuable_base_service.rb

423 lines
13 KiB
Ruby
Raw Normal View History

2018-11-18 11:00:15 +05:30
# frozen_string_literal: true
2015-04-26 12:48:37 +05:30
class IssuableBaseService < BaseService
private
2018-12-13 13:39:08 +05:30
attr_accessor :params, :skip_milestone_email
def initialize(project, user = nil, params = {})
super
@skip_milestone_email = @params.delete(:skip_milestone_email)
end
2020-03-09 13:42:32 +05:30
def can_admin_issuable?(issuable)
2017-08-17 22:00:37 +05:30
ability_name = :"admin_#{issuable.to_ability_name}"
2015-09-11 14:41:01 +05:30
2020-03-09 13:42:32 +05:30
can?(current_user, ability_name, issuable)
end
def filter_params(issuable)
unless can_admin_issuable?(issuable)
2015-09-11 14:41:01 +05:30
params.delete(:milestone_id)
2016-09-29 09:46:39 +05:30
params.delete(:labels)
params.delete(:add_label_ids)
params.delete(:remove_label_ids)
2015-09-11 14:41:01 +05:30
params.delete(:label_ids)
2017-08-17 22:00:37 +05:30
params.delete(:assignee_ids)
2015-09-11 14:41:01 +05:30
params.delete(:assignee_id)
2016-11-03 12:29:30 +05:30
params.delete(:due_date)
2017-09-10 17:25:29 +05:30
params.delete(:canonical_issue_id)
2018-03-17 18:26:18 +05:30
params.delete(:project)
params.delete(:discussion_locked)
2015-09-11 14:41:01 +05:30
end
2017-08-17 22:00:37 +05:30
filter_assignee(issuable)
filter_milestone
filter_labels
2015-09-11 14:41:01 +05:30
end
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
def filter_assignee(issuable)
2019-07-31 22:56:46 +05:30
return if params[:assignee_ids].blank?
2017-08-17 22:00:37 +05:30
2019-07-31 22:56:46 +05:30
unless issuable.allows_multiple_assignees?
params[:assignee_ids] = params[:assignee_ids].first(1)
end
assignee_ids = params[:assignee_ids].select { |assignee_id| assignee_can_read?(issuable, assignee_id) }
2017-08-17 22:00:37 +05:30
2019-07-31 22:56:46 +05:30
if params[:assignee_ids].map(&:to_s) == [IssuableFinder::NONE]
params[:assignee_ids] = []
elsif assignee_ids.any?
params[:assignee_ids] = assignee_ids
2017-08-17 22:00:37 +05:30
else
2019-07-31 22:56:46 +05:30
params.delete(:assignee_ids)
2016-06-02 11:05:42 +05:30
end
end
2017-08-17 22:00:37 +05:30
def assignee_can_read?(issuable, assignee_id)
new_assignee = User.find_by_id(assignee_id)
return false unless new_assignee
ability_name = :"read_#{issuable.to_ability_name}"
resource = issuable.persisted? ? issuable : project
can?(new_assignee, ability_name, resource)
end
2016-06-02 11:05:42 +05:30
def filter_milestone
milestone_id = params[:milestone_id]
return unless milestone_id
2017-09-10 17:25:29 +05:30
params[:milestone_id] = '' if milestone_id == IssuableFinder::NONE
2019-03-02 22:35:43 +05:30
groups = project.group&.self_and_ancestors&.select(:id)
2017-09-10 17:25:29 +05:30
milestone =
2019-03-02 22:35:43 +05:30
Milestone.for_projects_and_groups([project.id], groups).find_by_id(milestone_id)
2017-09-10 17:25:29 +05:30
params[:milestone_id] = '' unless milestone
2016-06-02 11:05:42 +05:30
end
def filter_labels
2019-12-04 20:38:33 +05:30
label_ids_to_filter(:add_label_ids, :add_labels, false)
label_ids_to_filter(:remove_label_ids, :remove_labels, true)
label_ids_to_filter(:label_ids, :labels, false)
end
2019-04-03 18:18:56 +05:30
2019-12-04 20:38:33 +05:30
def label_ids_to_filter(label_id_key, label_key, find_only)
if params[label_id_key]
params[label_id_key] = labels_service.filter_labels_ids_in_param(label_id_key)
elsif params[label_key]
params[label_id_key] = labels_service.find_or_create_by_titles(label_key, find_only: find_only).map(&:id)
2019-04-03 18:18:56 +05:30
end
end
def filter_labels_in_param(key)
return if params[key].to_a.empty?
2016-06-02 11:05:42 +05:30
2019-07-07 11:18:12 +05:30
params[key] = available_labels.id_in(params[key]).pluck_primary_key
end
2016-09-29 09:46:39 +05:30
def find_or_create_label_ids
labels = params.delete(:labels)
2017-01-15 13:20:01 +05:30
2016-09-29 09:46:39 +05:30
return unless labels
2019-07-07 11:18:12 +05:30
params[:label_ids] = labels.map do |label_name|
2018-03-27 19:54:05 +05:30
label = Labels::FindOrCreateService.new(
current_user,
parent,
title: label_name.strip,
available_labels: available_labels
).execute
2016-11-03 12:29:30 +05:30
2017-01-15 13:20:01 +05:30
label.try(:id)
end.compact
2016-09-29 09:46:39 +05:30
end
2019-04-03 18:18:56 +05:30
def labels_service
@labels_service ||= ::Labels::AvailableLabelsService.new(current_user, parent, params)
end
2019-07-07 11:18:12 +05:30
def process_label_ids(attributes, existing_label_ids: nil, extra_label_ids: [])
2016-09-13 17:45:13 +05:30
label_ids = attributes.delete(:label_ids)
add_label_ids = attributes.delete(:add_label_ids)
remove_label_ids = attributes.delete(:remove_label_ids)
new_label_ids = existing_label_ids || label_ids || []
2019-07-07 11:18:12 +05:30
new_label_ids |= extra_label_ids
2016-09-13 17:45:13 +05:30
if add_label_ids.blank? && remove_label_ids.blank?
new_label_ids = label_ids if label_ids
else
new_label_ids |= add_label_ids if add_label_ids
new_label_ids -= remove_label_ids if remove_label_ids
end
2019-07-07 11:18:12 +05:30
new_label_ids.uniq
2016-09-13 17:45:13 +05:30
end
2018-03-27 19:54:05 +05:30
def handle_quick_actions_on_create(issuable)
merge_quick_actions_into_params!(issuable)
2016-11-03 12:29:30 +05:30
end
2018-12-13 13:39:08 +05:30
def merge_quick_actions_into_params!(issuable, only: nil)
2018-03-17 18:26:18 +05:30
original_description = params.fetch(:description, issuable.description)
2016-09-13 17:45:13 +05:30
description, command_params =
2017-09-10 17:25:29 +05:30
QuickActions::InterpretService.new(project, current_user)
2018-12-13 13:39:08 +05:30
.execute(original_description, issuable, only: only)
2016-09-13 17:45:13 +05:30
2017-08-17 22:00:37 +05:30
# Avoid a description already set on an issuable to be overwritten by a nil
2018-03-17 18:26:18 +05:30
params[:description] = description if description
2016-09-13 17:45:13 +05:30
params.merge!(command_params)
end
def create(issuable)
2018-03-27 19:54:05 +05:30
handle_quick_actions_on_create(issuable)
2017-08-17 22:00:37 +05:30
filter_params(issuable)
2016-09-13 17:45:13 +05:30
params.delete(:state_event)
params[:author] ||= current_user
2019-07-07 11:18:12 +05:30
params[:label_ids] = process_label_ids(params, extra_label_ids: issuable.label_ids.to_a)
2016-09-13 17:45:13 +05:30
issuable.assign_attributes(params)
before_create(issuable)
2020-01-01 13:55:28 +05:30
issuable_saved = issuable.with_transaction_returning_status do
2020-03-09 13:42:32 +05:30
issuable.save
2020-01-01 13:55:28 +05:30
end
if issuable_saved
Issuable::CommonSystemNotesService.new(project, current_user).execute(issuable, is_update: false)
2019-02-15 15:39:39 +05:30
2016-09-13 17:45:13 +05:30
after_create(issuable)
execute_hooks(issuable)
2017-09-10 17:25:29 +05:30
invalidate_cache_counts(issuable, users: issuable.assignees)
2018-03-17 18:26:18 +05:30
issuable.update_project_counter_caches
2016-09-13 17:45:13 +05:30
end
issuable
end
2016-09-13 17:45:13 +05:30
def before_create(issuable)
# To be overridden by subclasses
end
def after_create(issuable)
# To be overridden by subclasses
end
2019-09-30 21:07:59 +05:30
def before_update(issuable, skip_spam_check: false)
2016-09-29 09:46:39 +05:30
# To be overridden by subclasses
end
2017-08-17 22:00:37 +05:30
def after_update(issuable)
# To be overridden by subclasses
2016-06-02 11:05:42 +05:30
end
2015-12-23 02:04:40 +05:30
def update(issuable)
change_state(issuable)
2016-08-24 12:49:21 +05:30
change_subscription(issuable)
2016-09-13 17:45:13 +05:30
change_todo(issuable)
2017-08-17 22:00:37 +05:30
toggle_award(issuable)
filter_params(issuable)
2018-03-17 18:26:18 +05:30
old_associations = associations_before_update(issuable)
2016-09-13 17:45:13 +05:30
2017-08-17 22:00:37 +05:30
label_ids = process_label_ids(params, existing_label_ids: issuable.label_ids)
2018-11-08 19:23:39 +05:30
if labels_changing?(issuable.label_ids, label_ids)
params[:label_ids] = label_ids
issuable.touch
end
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
if issuable.changed? || params.present?
2019-09-30 21:07:59 +05:30
issuable.assign_attributes(params)
2016-09-29 09:46:39 +05:30
2017-08-17 22:00:37 +05:30
if has_title_or_description_changed?(issuable)
issuable.assign_attributes(last_edited_at: Time.now, last_edited_by: current_user)
2016-09-29 09:46:39 +05:30
end
2017-08-17 22:00:37 +05:30
before_update(issuable)
2019-09-30 21:07:59 +05:30
# Do not touch when saving the issuable if only changes position within a list. We should call
# this method at this point to capture all possible changes.
should_touch = update_timestamp?(issuable)
issuable.updated_by = current_user if should_touch
2018-03-17 18:26:18 +05:30
# We have to perform this check before saving the issuable as Rails resets
# the changed fields upon calling #save.
update_project_counters = issuable.project && update_project_counter_caches?(issuable)
2019-12-04 20:38:33 +05:30
ensure_milestone_available(issuable)
2018-03-17 18:26:18 +05:30
2020-01-01 13:55:28 +05:30
issuable_saved = issuable.with_transaction_returning_status do
2020-03-09 13:42:32 +05:30
issuable.save(touch: should_touch)
2020-01-01 13:55:28 +05:30
end
if issuable_saved
Issuable::CommonSystemNotesService.new(project, current_user).execute(issuable, old_labels: old_associations[:labels])
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
handle_changes(issuable, old_associations: old_associations)
2017-08-17 22:00:37 +05:30
2017-09-10 17:25:29 +05:30
new_assignees = issuable.assignees.to_a
2018-03-17 18:26:18 +05:30
affected_assignees = (old_associations[:assignees] + new_assignees) - (old_associations[:assignees] & new_assignees)
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
invalidate_cache_counts(issuable, users: affected_assignees.compact)
2017-08-17 22:00:37 +05:30
after_update(issuable)
issuable.create_new_cross_references!(current_user)
2018-03-17 18:26:18 +05:30
execute_hooks(
issuable,
'update',
old_associations: old_associations
)
issuable.update_project_counter_caches if update_project_counters
2017-08-17 22:00:37 +05:30
end
2015-12-23 02:04:40 +05:30
end
issuable
end
2019-03-02 22:35:43 +05:30
def update_task(issuable)
filter_params(issuable)
if issuable.changed? || params.present?
issuable.assign_attributes(params.merge(updated_by: current_user,
last_edited_at: Time.now,
last_edited_by: current_user))
2019-09-30 21:07:59 +05:30
before_update(issuable, skip_spam_check: true)
2019-03-02 22:35:43 +05:30
if issuable.with_transaction_returning_status { issuable.save }
2020-01-01 13:55:28 +05:30
Issuable::CommonSystemNotesService.new(project, current_user).execute(issuable, old_labels: nil)
2019-03-02 22:35:43 +05:30
handle_task_changes(issuable)
invalidate_cache_counts(issuable, users: issuable.assignees.to_a)
after_update(issuable)
execute_hooks(issuable, 'update', old_associations: nil)
end
end
issuable
end
# Handle the `update_task` event sent from UI. Attempts to update a specific
# line in the markdown and cached html, bypassing any unnecessary updates or checks.
def update_task_event(issuable)
update_task_params = params.delete(:update_task)
return unless update_task_params
tasklist_toggler = TaskListToggleService.new(issuable.description, issuable.description_html,
line_source: update_task_params[:line_source],
line_number: update_task_params[:line_number].to_i,
toggle_as_checked: update_task_params[:checked])
unless tasklist_toggler.execute
# if we make it here, the data is much newer than we thought it was - fail fast
raise ActiveRecord::StaleObjectError
end
# by updating the description_html field at the same time,
# the markdown cache won't be considered invalid
params[:description] = tasklist_toggler.updated_markdown
params[:description_html] = tasklist_toggler.updated_markdown_html
# since we're updating a very specific line, we don't care whether
# the `lock_version` sent from the FE is the same or not. Just
# make sure the data hasn't changed since we queried it
params[:lock_version] = issuable.lock_version
update_task(issuable)
end
2017-08-17 22:00:37 +05:30
def labels_changing?(old_label_ids, new_label_ids)
old_label_ids.sort != new_label_ids.sort
end
def has_title_or_description_changed?(issuable)
issuable.title_changed? || issuable.description_changed?
end
2015-12-23 02:04:40 +05:30
def change_state(issuable)
case params.delete(:state_event)
when 'reopen'
reopen_service.new(project, current_user, {}).execute(issuable)
when 'close'
close_service.new(project, current_user, {}).execute(issuable)
end
end
2016-08-24 12:49:21 +05:30
def change_subscription(issuable)
case params.delete(:subscription_event)
when 'subscribe'
2017-08-17 22:00:37 +05:30
issuable.subscribe(current_user, project)
2016-08-24 12:49:21 +05:30
when 'unsubscribe'
2017-08-17 22:00:37 +05:30
issuable.unsubscribe(current_user, project)
2016-08-24 12:49:21 +05:30
end
end
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2016-09-13 17:45:13 +05:30
def change_todo(issuable)
case params.delete(:todo_event)
when 'add'
todo_service.mark_todo(issuable, current_user)
when 'done'
2018-03-27 19:54:05 +05:30
todo = TodosFinder.new(current_user).find_by(target: issuable)
2017-09-10 17:25:29 +05:30
todo_service.mark_todos_as_done_by_ids(todo, current_user) if todo
2016-09-13 17:45:13 +05:30
end
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2016-09-13 17:45:13 +05:30
2017-08-17 22:00:37 +05:30
def toggle_award(issuable)
award = params.delete(:emoji_award)
2019-12-04 20:38:33 +05:30
AwardEmojis::ToggleService.new(issuable, award, current_user).execute if award
2017-08-17 22:00:37 +05:30
end
2018-03-17 18:26:18 +05:30
def associations_before_update(issuable)
associations =
{
labels: issuable.labels.to_a,
2019-12-26 22:10:19 +05:30
mentioned_users: issuable.mentioned_users(current_user).to_a,
2018-03-17 18:26:18 +05:30
assignees: issuable.assignees.to_a
}
associations[:total_time_spent] = issuable.total_time_spent if issuable.respond_to?(:total_time_spent)
2019-10-12 21:52:04 +05:30
associations[:description] = issuable.description
2018-03-17 18:26:18 +05:30
associations
end
2017-08-17 22:00:37 +05:30
def has_changes?(issuable, old_labels: [], old_assignees: [])
2019-07-31 22:56:46 +05:30
valid_attrs = [:title, :description, :assignee_ids, :milestone_id, :target_branch]
2016-04-02 18:10:28 +05:30
attrs_changed = valid_attrs.any? do |attr|
issuable.previous_changes.include?(attr.to_s)
end
2016-06-02 11:05:42 +05:30
labels_changed = issuable.labels != old_labels
2016-04-02 18:10:28 +05:30
2017-08-17 22:00:37 +05:30
assignees_changed = issuable.assignees != old_assignees
attrs_changed || labels_changed || assignees_changed
2016-04-02 18:10:28 +05:30
end
2018-03-17 18:26:18 +05:30
def invalidate_cache_counts(issuable, users: [])
users.each do |user|
user.public_send("invalidate_#{issuable.model_name.singular}_cache_counts") # rubocop:disable GitlabSecurity/PublicSend
2017-08-17 22:00:37 +05:30
end
2018-03-17 18:26:18 +05:30
end
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
# override if needed
def handle_changes(issuable, options)
2015-12-23 02:04:40 +05:30
end
2017-08-17 22:00:37 +05:30
2019-03-02 22:35:43 +05:30
# override if needed
def handle_task_changes(issuable)
end
2018-03-17 18:26:18 +05:30
# override if needed
def execute_hooks(issuable, action = 'open', params = {})
end
2017-09-10 17:25:29 +05:30
2018-03-17 18:26:18 +05:30
def update_project_counter_caches?(issuable)
2020-01-01 13:55:28 +05:30
issuable.state_id_changed?
2017-08-17 22:00:37 +05:30
end
2018-03-27 19:54:05 +05:30
def parent
project
end
2019-03-13 22:55:13 +05:30
# we need to check this because milestone from milestone_id param is displayed on "new" page
# where private project milestone could leak without this check
def ensure_milestone_available(issuable)
issuable.milestone_id = nil unless issuable.milestone_available?
end
2019-09-30 21:07:59 +05:30
def update_timestamp?(issuable)
issuable.changes.keys != ["relative_position"]
end
2015-04-26 12:48:37 +05:30
end
2019-12-04 20:38:33 +05:30
IssuableBaseService.prepend_if_ee('EE::IssuableBaseService')