2018-09-29 22:34:47 +00:00
# frozen_string_literal: true
2013-12-20 19:12:44 +00:00
require 'mime/types'
2013-05-23 09:23:47 +00:00
module API
2020-10-15 00:08:42 +00:00
class Repositories < :: API :: Base
2017-01-17 04:45:07 +00:00
include PaginationParams
2020-10-23 09:08:41 +00:00
content_type :txt , 'text/plain'
2020-05-27 21:08:05 +00:00
helpers :: API :: Helpers :: HeadersHelpers
2021-11-22 18:10:55 +00:00
helpers do
params :release_params do
requires :version ,
type : String ,
regexp : Gitlab :: Regex . unbounded_semver_regex ,
desc : 'The version of the release, using the semantic versioning format'
optional :from ,
type : String ,
desc : 'The first commit in the range of commits to use for the changelog'
optional :to ,
type : String ,
desc : 'The last commit in the range of commits to use for the changelog'
optional :date ,
type : DateTime ,
desc : 'The date and time of the release'
optional :trailer ,
type : String ,
desc : 'The Git trailer to use for determining if commits are to be included in the changelog' ,
default : :: Repositories :: ChangelogService :: DEFAULT_TRAILER
end
end
2013-09-29 13:04:57 +00:00
before { authorize! :download_code , user_project }
2013-05-23 09:23:47 +00:00
2020-10-30 18:08:56 +00:00
feature_category :source_code_management
2016-11-17 15:05:57 +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
2013-05-23 09:23:47 +00:00
helpers do
2020-02-22 12:08:58 +00:00
include :: Gitlab :: RateLimitHelpers
2013-05-23 09:23:47 +00:00
def handle_project_member_errors ( errors )
if errors [ :project_access ] . any?
error! ( errors [ :project_access ] , 422 )
end
2018-01-11 16:34:01 +00:00
2013-05-23 09:23:47 +00:00
not_found!
end
2017-03-01 20:22:29 +00:00
2021-08-11 12:10:59 +00:00
def assign_blob_vars! ( limit : )
2017-03-08 00:14:33 +00:00
authorize! :download_code , user_project
2017-03-01 20:22:29 +00:00
@repo = user_project . repository
begin
2021-08-11 12:10:59 +00:00
@blob = Gitlab :: Git :: Blob . raw ( @repo , params [ :sha ] , limit : limit )
2021-04-26 12:09:44 +00:00
rescue StandardError
2017-03-01 20:22:29 +00:00
not_found! 'Blob'
end
not_found! 'Blob' unless @blob
end
2021-10-22 15:19:11 +00:00
def fetch_target_project ( current_user , user_project , params )
return user_project unless params [ :from_project_id ] . present?
MergeRequestTargetProjectFinder
. new ( current_user : current_user , source_project : user_project , project_feature : :repository )
. execute ( include_routes : true ) . find_by_id ( params [ :from_project_id ] )
end
def compare_cache_key ( current_user , user_project , target_project , params )
[
user_project ,
target_project ,
current_user ,
:repository_compare ,
target_project . repository . commit ( params [ :from ] ) ,
user_project . repository . commit ( params [ :to ] ) ,
params
]
end
2013-05-23 09:23:47 +00:00
end
2014-05-26 13:08:22 +00:00
2016-11-17 15:05:57 +00:00
desc 'Get a project repository tree' do
2017-10-05 08:48:05 +00:00
success Entities :: TreeObject
2016-11-17 15:05:57 +00:00
end
params do
2017-03-08 00:14:33 +00:00
optional :ref , type : String , desc : 'The name of a repository branch or tag, if not given the default branch is used'
2016-11-17 15:05:57 +00:00
optional :path , type : String , desc : 'The path of the tree'
optional :recursive , type : Boolean , default : false , desc : 'Used to get a recursive tree'
2021-09-14 18:12:06 +00:00
2017-01-17 04:45:07 +00:00
use :pagination
2021-09-14 18:12:06 +00:00
optional :pagination , type : String , values : %w( legacy keyset ) , default : 'legacy' , desc : 'Specify the pagination method'
given pagination : - > ( value ) { value == 'keyset' } do
optional :page_token , type : String , desc : 'Record from which to start the keyset pagination'
end
2016-11-17 15:05:57 +00:00
end
2021-11-12 18:12:20 +00:00
get ':id/repository/tree' , urgency : :low do
2021-09-14 18:12:06 +00:00
tree_finder = :: Repositories :: TreeFinder . new ( user_project , declared_params ( include_missing : false ) )
not_found! ( " Tree " ) unless tree_finder . commit_exists?
2013-06-06 15:01:03 +00:00
2021-09-14 18:12:06 +00:00
tree = Gitlab :: Pagination :: GitalyKeysetPager . new ( self , user_project ) . paginate ( tree_finder )
2015-01-18 21:17:10 +00:00
2021-09-14 18:12:06 +00:00
present tree , with : Entities :: TreeObject
2013-06-06 15:01:03 +00:00
end
2017-03-08 00:14:33 +00:00
desc 'Get raw blob contents from the repository'
2016-11-17 15:05:57 +00:00
params do
2017-09-23 13:21:32 +00:00
requires :sha , type : String , desc : 'The commit hash'
2013-12-23 09:37:38 +00:00
end
2017-03-08 00:14:33 +00:00
get ':id/repository/blobs/:sha/raw' do
2021-08-11 12:10:59 +00:00
# Load metadata enough to ask Workhorse to load the whole blob
assign_blob_vars! ( limit : 0 )
2013-12-23 09:37:38 +00:00
2020-05-27 21:08:05 +00:00
no_cache_headers
2017-03-01 20:22:29 +00:00
send_git_blob @repo , @blob
end
2013-12-23 09:37:38 +00:00
2017-03-08 00:14:33 +00:00
desc 'Get a blob from the repository'
2017-03-01 20:22:29 +00:00
params do
2017-09-23 13:21:32 +00:00
requires :sha , type : String , desc : 'The commit hash'
2017-03-01 20:22:29 +00:00
end
get ':id/repository/blobs/:sha' do
2021-08-11 12:10:59 +00:00
assign_blob_vars! ( limit : - 1 )
2017-03-01 20:22:29 +00:00
{
size : @blob . size ,
encoding : " base64 " ,
content : Base64 . strict_encode64 ( @blob . data ) ,
sha : @blob . id
}
2013-05-23 09:23:47 +00:00
end
2013-09-26 20:42:49 +00:00
2016-11-17 15:05:57 +00:00
desc 'Get an archive of the repository'
params do
optional :sha , type : String , desc : 'The commit sha of the archive to be downloaded'
optional :format , type : String , desc : 'The archive format'
2021-10-11 18:09:46 +00:00
optional :path , type : String , desc : 'Subfolder of the repository to be downloaded'
2016-11-17 15:05:57 +00:00
end
2017-05-24 20:59:26 +00:00
get ':id/repository/archive' , requirements : { format : Gitlab :: PathRegex . archive_formats_regex } do
2020-02-22 12:08:58 +00:00
if archive_rate_limit_reached? ( current_user , user_project )
render_api_error! ( { error : :: Gitlab :: RateLimitHelpers :: ARCHIVE_RATE_LIMIT_REACHED_MESSAGE } , 429 )
end
2020-03-26 18:08:03 +00:00
not_acceptable! if Gitlab :: HotlinkingDetector . intercept_hotlinking? ( request )
2021-10-11 18:09:46 +00:00
send_git_archive user_project . repository , ref : params [ :sha ] , format : params [ :format ] , append_sha : true , path : params [ :path ]
2021-04-26 12:09:44 +00:00
rescue StandardError
2019-03-13 13:42:43 +00:00
not_found! ( 'File' )
2013-09-26 20:42:49 +00:00
end
2014-05-26 13:08:22 +00:00
2016-11-17 15:05:57 +00:00
desc 'Compare two branches, tags, or commits' do
success Entities :: Compare
end
params do
requires :from , type : String , desc : 'The commit, branch name, or tag name to start comparison'
requires :to , type : String , desc : 'The commit, branch name, or tag name to stop comparison'
2021-04-06 21:09:08 +00:00
optional :from_project_id , type : String , desc : 'The project to compare from'
2018-06-23 19:39:11 +00:00
optional :straight , type : Boolean , desc : 'Comparison method, `true` for direct comparison between `from` and `to` (`from`..`to`), `false` to compare using merge base (`from`...`to`)' , default : false
2016-11-17 15:05:57 +00:00
end
2021-11-12 18:12:20 +00:00
get ':id/repository/compare' , urgency : :low do
2021-07-02 15:07:36 +00:00
ff_enabled = Feature . enabled? ( :api_caching_rate_limit_repository_compare , user_project , default_enabled : :yaml )
2021-10-22 15:19:11 +00:00
target_project = fetch_target_project ( current_user , user_project , params )
2021-07-02 15:07:36 +00:00
2021-10-22 15:19:11 +00:00
if target_project . blank?
render_api_error! ( " Target project id: #{ params [ :from_project_id ] } is not a fork of project id: #{ params [ :id ] } " , 400 )
end
2021-07-02 15:07:36 +00:00
2021-10-22 15:19:11 +00:00
cache_key = compare_cache_key ( current_user , user_project , target_project , declared_params )
2021-04-06 21:09:08 +00:00
2021-10-22 15:19:11 +00:00
cache_action_if ( ff_enabled , cache_key , expires_in : 1 . minute ) do
2021-07-02 15:07:36 +00:00
compare = CompareService . new ( user_project , params [ :to ] ) . execute ( target_project , params [ :from ] , straight : params [ :straight ] )
2020-01-22 18:08:47 +00:00
2021-07-02 15:07:36 +00:00
if compare
2021-07-12 12:09:39 +00:00
present compare , with : Entities :: Compare
2021-07-02 15:07:36 +00:00
else
not_found! ( " Ref " )
end
2020-01-22 18:08:47 +00:00
end
2014-05-26 13:08:22 +00:00
end
2014-07-02 06:49:10 +00:00
2016-11-17 15:05:57 +00:00
desc 'Get repository contributors' do
success Entities :: Contributor
end
2017-01-17 04:45:07 +00:00
params do
use :pagination
2018-04-16 10:30:40 +00:00
optional :order_by , type : String , values : %w[ email name commits ] , default : 'commits' , desc : 'Return contributors ordered by `name` or `email` or `commits`'
optional :sort , type : String , values : %w[ asc desc ] , default : 'asc' , desc : 'Sort by asc (ascending) or desc (descending)'
2017-01-17 04:45:07 +00:00
end
2014-07-02 06:49:10 +00:00
get ':id/repository/contributors' do
2019-03-13 13:42:43 +00:00
contributors = :: Kaminari . paginate_array ( user_project . repository . contributors ( order_by : params [ :order_by ] , sort : params [ :sort ] ) )
present paginate ( contributors ) , with : Entities :: Contributor
2021-04-26 12:09:44 +00:00
rescue StandardError
2019-03-13 13:42:43 +00:00
not_found!
2014-07-02 06:49:10 +00:00
end
2018-07-31 14:38:03 +00:00
desc 'Get the common ancestor between commits' do
success Entities :: Commit
end
params do
2020-06-29 21:09:07 +00:00
requires :refs , type : Array [ String ] , coerce_with : :: API :: Validations :: Types :: CommaSeparatedToArray . coerce
2018-07-31 14:38:03 +00:00
end
get ':id/repository/merge_base' do
refs = params [ :refs ]
2018-10-11 14:27:04 +00:00
if refs . size < 2
render_api_error! ( 'Provide at least 2 refs' , 400 )
2018-07-31 14:38:03 +00:00
end
merge_base = Gitlab :: Git :: MergeBase . new ( user_project . repository , refs )
if merge_base . unknown_refs . any?
ref_noun = 'ref' . pluralize ( merge_base . unknown_refs . size )
message = " Could not find #{ ref_noun } : #{ merge_base . unknown_refs . join ( ', ' ) } "
render_api_error! ( message , 400 )
end
if merge_base . commit
present merge_base . commit , with : Entities :: Commit
else
not_found! ( " Merge Base " )
end
end
2021-01-29 18:09:17 +00:00
2021-11-22 18:10:55 +00:00
desc 'Generates a changelog section for a release and returns it' do
detail 'This feature was introduced in GitLab 14.6'
2021-01-29 18:09:17 +00:00
end
params do
2021-11-22 18:10:55 +00:00
use :release_params
end
get ':id/repository/changelog' do
service = :: Repositories :: ChangelogService . new (
user_project ,
current_user ,
** declared_params ( include_missing : false )
)
changelog = service . execute ( commit_to_changelog : false )
2021-01-29 18:09:17 +00:00
2021-11-22 18:10:55 +00:00
present changelog , with : Entities :: Changelog
end
2021-01-29 18:09:17 +00:00
2021-11-22 18:10:55 +00:00
desc 'Generates a changelog section for a release and commits it in a changelog file' do
detail 'This feature was introduced in GitLab 13.9'
end
params do
use :release_params
2021-01-29 18:09:17 +00:00
optional :branch ,
type : String ,
desc : 'The branch to commit the changelog changes to'
optional :file ,
type : String ,
desc : 'The file to commit the changelog changes to' ,
default : :: Repositories :: ChangelogService :: DEFAULT_FILE
optional :message ,
type : String ,
desc : 'The commit message to use when committing the changelog'
end
post ':id/repository/changelog' do
2021-05-04 12:10:04 +00:00
branch = params [ :branch ] || user_project . default_branch_or_main
2021-01-29 18:09:17 +00:00
access = Gitlab :: UserAccess . new ( current_user , container : user_project )
unless access . can_push_to_branch? ( branch )
forbidden! ( " You are not allowed to commit a changelog on this branch " )
end
service = :: Repositories :: ChangelogService . new (
user_project ,
current_user ,
** declared_params ( include_missing : false )
)
2021-11-22 18:10:55 +00:00
service . execute ( commit_to_changelog : true )
2021-01-29 18:09:17 +00:00
status ( 200 )
2021-02-08 18:09:49 +00:00
rescue Gitlab :: Changelog :: Error = > ex
2021-02-16 18:09:24 +00:00
render_api_error! ( " Failed to generate the changelog: #{ ex . message } " , 422 )
2021-01-29 18:09:17 +00:00
end
2013-05-23 09:23:47 +00:00
end
end
end