2018-09-29 22:34:47 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2014-03-31 13:31:53 +00:00
|
|
|
require 'mime/types'
|
|
|
|
|
|
|
|
module API
|
2020-10-15 00:08:42 +00:00
|
|
|
class Branches < ::API::Base
|
2017-01-17 04:45:07 +00:00
|
|
|
include PaginationParams
|
|
|
|
|
2018-11-08 12:18:17 +00:00
|
|
|
BRANCH_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS.merge(branch: API::NO_SLASH_URL_PART_REGEX)
|
2017-07-27 11:01:14 +00:00
|
|
|
|
2020-05-12 00:10:11 +00:00
|
|
|
after_validation { content_type "application/json" }
|
|
|
|
|
2020-10-29 12:08:50 +00:00
|
|
|
feature_category :source_code_management
|
|
|
|
|
2019-06-24 22:12:42 +00:00
|
|
|
before do
|
|
|
|
require_repository_enabled!
|
|
|
|
authorize! :download_code, user_project
|
|
|
|
end
|
2014-03-31 13:31:53 +00:00
|
|
|
|
2021-05-20 12:10:26 +00:00
|
|
|
rescue_from Gitlab::Git::Repository::NoRepository do
|
|
|
|
not_found!
|
|
|
|
end
|
|
|
|
|
2017-10-14 09:32:24 +00:00
|
|
|
helpers do
|
2018-03-05 12:57:47 +00:00
|
|
|
params :filter_params do
|
|
|
|
optional :search, type: String, desc: 'Return list of branches matching the search criteria'
|
2022-02-02 18:15:35 +00:00
|
|
|
optional :sort, type: String, desc: 'Return list of branches sorted by the given field', values: %w[name_asc updated_asc updated_desc]
|
2018-03-05 12:57:47 +00:00
|
|
|
end
|
2017-10-14 09:32:24 +00:00
|
|
|
end
|
|
|
|
|
2016-09-13 18:28:29 +00:00
|
|
|
params do
|
|
|
|
requires :id, type: String, desc: 'The ID of a project'
|
|
|
|
end
|
2018-11-08 12:18:17 +00:00
|
|
|
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
|
2016-09-13 18:28:29 +00:00
|
|
|
desc 'Get a project repository branches' do
|
2017-10-05 08:48:05 +00:00
|
|
|
success Entities::Branch
|
2016-09-13 18:28:29 +00:00
|
|
|
end
|
2017-01-17 04:45:07 +00:00
|
|
|
params do
|
|
|
|
use :pagination
|
2018-03-05 12:57:47 +00:00
|
|
|
use :filter_params
|
2020-07-17 09:09:43 +00:00
|
|
|
|
|
|
|
optional :page_token, type: String, desc: 'Name of branch to start the paginaition from'
|
2017-01-17 04:45:07 +00:00
|
|
|
end
|
2021-11-12 18:12:20 +00:00
|
|
|
get ':id/repository/branches', urgency: :low do
|
2022-02-16 00:15:19 +00:00
|
|
|
cache_action([user_project, :branches, current_user, declared_params], expires_in: 30.seconds) do
|
2021-05-13 21:10:08 +00:00
|
|
|
user_project.preload_protected_branches
|
2018-03-05 12:57:47 +00:00
|
|
|
|
2021-05-13 21:10:08 +00:00
|
|
|
repository = user_project.repository
|
2020-07-17 09:09:43 +00:00
|
|
|
|
2021-05-13 21:10:08 +00:00
|
|
|
branches_finder = BranchesFinder.new(repository, declared_params(include_missing: false))
|
|
|
|
branches = Gitlab::Pagination::GitalyKeysetPager.new(self, user_project).paginate(branches_finder)
|
2016-07-19 11:30:23 +00:00
|
|
|
|
2021-05-13 21:10:08 +00:00
|
|
|
merged_branch_names = repository.merged_branch_names(branches.map(&:name))
|
|
|
|
|
2022-05-06 15:09:03 +00:00
|
|
|
if Feature.enabled?(:api_caching_branches, user_project, type: :development)
|
2021-05-13 21:10:08 +00:00
|
|
|
present_cached(
|
|
|
|
branches,
|
|
|
|
with: Entities::Branch,
|
|
|
|
current_user: current_user,
|
|
|
|
project: user_project,
|
|
|
|
merged_branch_names: merged_branch_names,
|
|
|
|
expires_in: 10.minutes,
|
|
|
|
cache_context: -> (branch) { [current_user&.cache_key, merged_branch_names.include?(branch.name)] }
|
|
|
|
)
|
|
|
|
else
|
|
|
|
present(
|
|
|
|
branches,
|
|
|
|
with: Entities::Branch,
|
|
|
|
current_user: current_user,
|
|
|
|
project: user_project,
|
|
|
|
merged_branch_names: merged_branch_names
|
|
|
|
)
|
|
|
|
end
|
2021-05-12 15:10:25 +00:00
|
|
|
end
|
2014-03-31 13:31:53 +00:00
|
|
|
end
|
|
|
|
|
2017-09-04 23:55:12 +00:00
|
|
|
resource ':id/repository/branches/:branch', requirements: BRANCH_ENDPOINT_REQUIREMENTS do
|
|
|
|
desc 'Get a single branch' do
|
2017-10-05 08:48:05 +00:00
|
|
|
success Entities::Branch
|
2017-09-04 23:55:12 +00:00
|
|
|
end
|
|
|
|
params do
|
|
|
|
requires :branch, type: String, desc: 'The name of the branch'
|
|
|
|
end
|
|
|
|
head do
|
2020-01-16 18:08:46 +00:00
|
|
|
user_project.repository.branch_exists?(params[:branch]) ? no_content! : not_found!
|
2017-09-04 23:55:12 +00:00
|
|
|
end
|
2021-11-12 18:12:20 +00:00
|
|
|
get '/', urgency: :low do
|
2017-10-14 09:32:24 +00:00
|
|
|
branch = find_branch!(params[:branch])
|
2017-09-04 23:55:12 +00:00
|
|
|
|
2018-06-25 16:39:23 +00:00
|
|
|
present branch, with: Entities::Branch, current_user: current_user, project: user_project
|
2017-09-04 23:55:12 +00:00
|
|
|
end
|
2014-03-31 13:31:53 +00:00
|
|
|
end
|
|
|
|
|
2017-08-02 10:16:17 +00:00
|
|
|
# Note: This API will be deprecated in favor of the protected branches API.
|
2016-07-25 14:44:53 +00:00
|
|
|
# Note: The internal data model moved from `developers_can_{merge,push}` to `allowed_to_{merge,push}`
|
|
|
|
# in `gitlab-org/gitlab-ce!5081`. The API interface has not been changed (to maintain compatibility),
|
|
|
|
# but it works with the changed data model to infer `developers_can_merge` and `developers_can_push`.
|
2016-09-13 18:28:29 +00:00
|
|
|
desc 'Protect a single branch' do
|
2017-10-05 08:48:05 +00:00
|
|
|
success Entities::Branch
|
2016-09-13 18:28:29 +00:00
|
|
|
end
|
|
|
|
params do
|
2018-09-11 22:02:09 +00:00
|
|
|
requires :branch, type: String, desc: 'The name of the branch', allow_blank: false
|
2016-09-13 18:28:29 +00:00
|
|
|
optional :developers_can_push, type: Boolean, desc: 'Flag if developers can push to that branch'
|
|
|
|
optional :developers_can_merge, type: Boolean, desc: 'Flag if developers can merge to that branch'
|
|
|
|
end
|
2018-08-27 15:31:01 +00:00
|
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
2017-07-27 11:01:14 +00:00
|
|
|
put ':id/repository/branches/:branch/protect', requirements: BRANCH_ENDPOINT_REQUIREMENTS do
|
2014-03-31 13:31:53 +00:00
|
|
|
authorize_admin_project
|
|
|
|
|
2017-10-14 09:32:24 +00:00
|
|
|
branch = find_branch!(params[:branch])
|
2016-09-13 18:28:29 +00:00
|
|
|
|
|
|
|
protected_branch = user_project.protected_branches.find_by(name: branch.name)
|
2016-07-29 06:13:07 +00:00
|
|
|
|
2016-09-22 15:08:05 +00:00
|
|
|
protected_branch_params = {
|
2016-09-13 18:28:29 +00:00
|
|
|
name: branch.name,
|
|
|
|
developers_can_push: params[:developers_can_push],
|
|
|
|
developers_can_merge: params[:developers_can_merge]
|
2016-07-25 14:44:53 +00:00
|
|
|
}
|
|
|
|
|
2016-09-30 07:44:46 +00:00
|
|
|
service_args = [user_project, current_user, protected_branch_params]
|
2016-07-29 06:13:07 +00:00
|
|
|
|
2016-09-06 05:05:34 +00:00
|
|
|
protected_branch = if protected_branch
|
2017-11-22 15:16:08 +00:00
|
|
|
::ProtectedBranches::LegacyApiUpdateService.new(*service_args).execute(protected_branch)
|
2016-09-06 05:05:34 +00:00
|
|
|
else
|
2017-11-22 15:16:08 +00:00
|
|
|
::ProtectedBranches::LegacyApiCreateService.new(*service_args).execute
|
2016-09-06 05:05:34 +00:00
|
|
|
end
|
2016-07-12 14:31:55 +00:00
|
|
|
|
2016-09-06 05:05:34 +00:00
|
|
|
if protected_branch.valid?
|
2018-06-25 16:39:23 +00:00
|
|
|
present branch, with: Entities::Branch, current_user: current_user, project: user_project
|
2016-07-29 06:13:07 +00:00
|
|
|
else
|
2016-09-06 05:05:34 +00:00
|
|
|
render_api_error!(protected_branch.errors.full_messages, 422)
|
2016-07-29 06:13:07 +00:00
|
|
|
end
|
2014-03-31 13:31:53 +00:00
|
|
|
end
|
2018-08-27 15:31:01 +00:00
|
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
2014-03-31 13:31:53 +00:00
|
|
|
|
2017-08-02 10:16:17 +00:00
|
|
|
# Note: This API will be deprecated in favor of the protected branches API.
|
2016-09-13 18:28:29 +00:00
|
|
|
desc 'Unprotect a single branch' do
|
2017-10-05 08:48:05 +00:00
|
|
|
success Entities::Branch
|
2016-09-13 18:28:29 +00:00
|
|
|
end
|
|
|
|
params do
|
2018-09-11 22:02:09 +00:00
|
|
|
requires :branch, type: String, desc: 'The name of the branch', allow_blank: false
|
2016-09-13 18:28:29 +00:00
|
|
|
end
|
2018-08-27 15:31:01 +00:00
|
|
|
# rubocop: disable CodeReuse/ActiveRecord
|
2017-07-27 11:01:14 +00:00
|
|
|
put ':id/repository/branches/:branch/unprotect', requirements: BRANCH_ENDPOINT_REQUIREMENTS do
|
2014-03-31 13:31:53 +00:00
|
|
|
authorize_admin_project
|
|
|
|
|
2017-10-14 09:32:24 +00:00
|
|
|
branch = find_branch!(params[:branch])
|
2016-09-13 18:28:29 +00:00
|
|
|
protected_branch = user_project.protected_branches.find_by(name: branch.name)
|
2017-02-07 14:16:46 +00:00
|
|
|
protected_branch&.destroy
|
2014-03-31 13:31:53 +00:00
|
|
|
|
2018-06-25 16:39:23 +00:00
|
|
|
present branch, with: Entities::Branch, current_user: current_user, project: user_project
|
2014-03-31 13:31:53 +00:00
|
|
|
end
|
2018-08-27 15:31:01 +00:00
|
|
|
# rubocop: enable CodeReuse/ActiveRecord
|
2014-04-01 07:39:53 +00:00
|
|
|
|
2016-09-13 18:28:29 +00:00
|
|
|
desc 'Create branch' do
|
2017-10-05 08:48:05 +00:00
|
|
|
success Entities::Branch
|
2016-09-13 18:28:29 +00:00
|
|
|
end
|
|
|
|
params do
|
2018-09-11 22:02:09 +00:00
|
|
|
requires :branch, type: String, desc: 'The name of the branch', allow_blank: false
|
|
|
|
requires :ref, type: String, desc: 'Create branch from commit sha or existing branch', allow_blank: false
|
2016-09-13 18:28:29 +00:00
|
|
|
end
|
2017-07-26 12:33:09 +00:00
|
|
|
post ':id/repository/branches' do
|
2014-04-01 07:39:53 +00:00
|
|
|
authorize_push_project
|
2017-03-20 08:37:14 +00:00
|
|
|
|
2019-12-03 18:06:49 +00:00
|
|
|
result = ::Branches::CreateService.new(user_project, current_user)
|
2017-06-21 13:48:12 +00:00
|
|
|
.execute(params[:branch], params[:ref])
|
2014-10-30 15:28:59 +00:00
|
|
|
|
2014-07-27 14:40:00 +00:00
|
|
|
if result[:status] == :success
|
|
|
|
present result[:branch],
|
2017-10-05 08:48:05 +00:00
|
|
|
with: Entities::Branch,
|
2018-06-25 16:39:23 +00:00
|
|
|
current_user: current_user,
|
2014-07-27 14:40:00 +00:00
|
|
|
project: user_project
|
|
|
|
else
|
|
|
|
render_api_error!(result[:message], 400)
|
|
|
|
end
|
2014-04-01 07:39:53 +00:00
|
|
|
end
|
2014-05-22 11:39:50 +00:00
|
|
|
|
2016-09-13 18:28:29 +00:00
|
|
|
desc 'Delete a branch'
|
|
|
|
params do
|
2018-09-11 22:02:09 +00:00
|
|
|
requires :branch, type: String, desc: 'The name of the branch', allow_blank: false
|
2016-09-13 18:28:29 +00:00
|
|
|
end
|
2017-07-27 11:01:14 +00:00
|
|
|
delete ':id/repository/branches/:branch', requirements: BRANCH_ENDPOINT_REQUIREMENTS do
|
2014-05-22 11:39:50 +00:00
|
|
|
authorize_push_project
|
2016-09-13 18:28:29 +00:00
|
|
|
|
2017-10-14 09:32:24 +00:00
|
|
|
branch = find_branch!(params[:branch])
|
2017-03-02 13:21:36 +00:00
|
|
|
|
|
|
|
commit = user_project.repository.commit(branch.dereferenced_target)
|
|
|
|
|
2017-08-30 12:33:39 +00:00
|
|
|
destroy_conditionally!(commit, last_updated: commit.authored_date) do
|
2019-12-03 18:06:49 +00:00
|
|
|
result = ::Branches::DeleteService.new(user_project, current_user)
|
2017-03-02 13:21:36 +00:00
|
|
|
.execute(params[:branch])
|
2014-05-23 12:34:02 +00:00
|
|
|
|
2019-04-19 15:39:12 +00:00
|
|
|
if result.error?
|
|
|
|
render_api_error!(result.message, result.http_status)
|
2017-03-02 13:21:36 +00:00
|
|
|
end
|
2014-05-23 12:34:02 +00:00
|
|
|
end
|
2014-05-22 11:39:50 +00:00
|
|
|
end
|
2016-09-21 14:15:12 +00:00
|
|
|
|
2017-01-24 19:24:59 +00:00
|
|
|
desc 'Delete all merged branches'
|
2017-07-26 12:33:09 +00:00
|
|
|
delete ':id/repository/merged_branches' do
|
2019-12-03 18:06:49 +00:00
|
|
|
::Branches::DeleteMergedService.new(user_project, current_user).async_execute
|
2016-09-21 14:15:12 +00:00
|
|
|
|
2017-02-22 17:37:13 +00:00
|
|
|
accepted!
|
2016-09-21 14:15:12 +00:00
|
|
|
end
|
2014-03-31 13:31:53 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|