2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
require 'mime/types'
module API
2021-01-03 14:25:43 +05:30
class Repositories < :: API :: Base
2017-08-17 22:00:37 +05:30
include PaginationParams
2021-01-29 00:20:46 +05:30
content_type :txt , 'text/plain'
2020-06-23 00:09:42 +05:30
helpers :: API :: Helpers :: HeadersHelpers
2014-09-02 18:07:02 +05:30
before { authorize! :download_code , user_project }
2021-01-29 00:20:46 +05:30
feature_category :source_code_management
2017-08-17 22:00:37 +05:30
params do
requires :id , type : String , desc : 'The ID of a project'
end
2019-02-15 15:39:39 +05:30
resource :projects , requirements : API :: NAMESPACE_OR_PROJECT_REQUIREMENTS do
2014-09-02 18:07:02 +05:30
helpers do
2020-04-08 14:13:33 +05:30
include :: Gitlab :: RateLimitHelpers
2014-09-02 18:07:02 +05:30
def handle_project_member_errors ( errors )
if errors [ :project_access ] . any?
error! ( errors [ :project_access ] , 422 )
end
2018-03-17 18:26:18 +05:30
2014-09-02 18:07:02 +05:30
not_found!
end
2017-08-17 22:00:37 +05:30
2021-10-27 15:23:28 +05:30
def assign_blob_vars! ( limit : )
2017-08-17 22:00:37 +05:30
authorize! :download_code , user_project
@repo = user_project . repository
begin
2021-10-27 15:23:28 +05:30
@blob = Gitlab :: Git :: Blob . raw ( @repo , params [ :sha ] , limit : limit )
2021-06-08 01:23:25 +05:30
rescue StandardError
2017-08-17 22:00:37 +05:30
not_found! 'Blob'
end
not_found! 'Blob' unless @blob
end
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Get a project repository tree' do
2018-03-17 18:26:18 +05:30
success Entities :: TreeObject
2017-08-17 22:00:37 +05:30
end
params do
optional :ref , type : String , desc : 'The name of a repository branch or tag, if not given the default branch is used'
optional :path , type : String , desc : 'The path of the tree'
optional :recursive , type : Boolean , default : false , desc : 'Used to get a recursive tree'
use :pagination
end
2015-04-26 12:48:37 +05:30
get ':id/repository/tree' do
2021-10-27 15:23:28 +05:30
ref = params [ :ref ] || user_project . default_branch
2014-09-02 18:07:02 +05:30
path = params [ :path ] || nil
2015-09-11 14:41:01 +05:30
commit = user_project . commit ( ref )
2015-04-26 12:48:37 +05:30
not_found! ( 'Tree' ) unless commit
2017-08-17 22:00:37 +05:30
tree = user_project . repository . tree ( commit . id , path , recursive : params [ :recursive ] )
entries = :: Kaminari . paginate_array ( tree . sorted_entries )
2018-03-17 18:26:18 +05:30
present paginate ( entries ) , with : Entities :: TreeObject
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Get raw blob contents from the repository'
params do
2018-03-17 18:26:18 +05:30
requires :sha , type : String , desc : 'The commit hash'
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
get ':id/repository/blobs/:sha/raw' do
2021-10-27 15:23:28 +05:30
# Load metadata enough to ask Workhorse to load the whole blob
assign_blob_vars! ( limit : 0 )
2014-09-02 18:07:02 +05:30
2020-06-23 00:09:42 +05:30
no_cache_headers
2017-08-17 22:00:37 +05:30
send_git_blob @repo , @blob
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Get a blob from the repository'
params do
2018-03-17 18:26:18 +05:30
requires :sha , type : String , desc : 'The commit hash'
2017-08-17 22:00:37 +05:30
end
get ':id/repository/blobs/:sha' do
2021-10-27 15:23:28 +05:30
assign_blob_vars! ( limit : - 1 )
2017-08-17 22:00:37 +05:30
{
size : @blob . size ,
encoding : " base64 " ,
content : Base64 . strict_encode64 ( @blob . data ) ,
sha : @blob . id
}
end
2015-04-26 12:48:37 +05:30
2017-08-17 22:00:37 +05:30
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'
end
2017-09-10 17:25:29 +05:30
get ':id/repository/archive' , requirements : { format : Gitlab :: PathRegex . archive_formats_regex } do
2020-04-08 14:13:33 +05:30
if archive_rate_limit_reached? ( current_user , user_project )
render_api_error! ( { error : :: Gitlab :: RateLimitHelpers :: ARCHIVE_RATE_LIMIT_REACHED_MESSAGE } , 429 )
end
2020-03-28 13:19:24 +05:30
not_acceptable! if Gitlab :: HotlinkingDetector . intercept_hotlinking? ( request )
2019-07-07 11:18:12 +05:30
send_git_archive user_project . repository , ref : params [ :sha ] , format : params [ :format ] , append_sha : true
2021-06-08 01:23:25 +05:30
rescue StandardError
2019-07-07 11:18:12 +05:30
not_found! ( 'File' )
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
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-29 21:17:54 +05:30
optional :from_project_id , type : String , desc : 'The project to compare from'
2018-11-08 19:23:39 +05:30
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
2017-08-17 22:00:37 +05:30
end
2014-09-02 18:07:02 +05:30
get ':id/repository/compare' do
2021-09-30 23:02:18 +05:30
ff_enabled = Feature . enabled? ( :api_caching_rate_limit_repository_compare , user_project , default_enabled : :yaml )
cache_action_if ( ff_enabled , [ user_project , :repository_compare , current_user , declared_params ] , expires_in : 1 . minute ) do
if params [ :from_project_id ] . present?
target_project = MergeRequestTargetProjectFinder
. new ( current_user : current_user , source_project : user_project , project_feature : :repository )
. execute ( include_routes : true ) . find_by_id ( params [ :from_project_id ] )
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
else
target_project = user_project
2021-04-29 21:17:54 +05:30
end
2021-09-30 23:02:18 +05:30
compare = CompareService . new ( user_project , params [ :to ] ) . execute ( target_project , params [ :from ] , straight : params [ :straight ] )
2020-03-13 15:44:24 +05:30
2021-09-30 23:02:18 +05:30
if compare
present compare , with : Entities :: Compare
else
not_found! ( " Ref " )
end
2020-03-13 15:44:24 +05:30
end
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
desc 'Get repository contributors' do
success Entities :: Contributor
end
params do
use :pagination
2018-05-09 12:01:36 +05:30
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-08-17 22:00:37 +05:30
end
2014-09-02 18:07:02 +05:30
get ':id/repository/contributors' do
2019-07-07 11:18:12 +05:30
contributors = :: Kaminari . paginate_array ( user_project . repository . contributors ( order_by : params [ :order_by ] , sort : params [ :sort ] ) )
present paginate ( contributors ) , with : Entities :: Contributor
2021-06-08 01:23:25 +05:30
rescue StandardError
2019-07-07 11:18:12 +05:30
not_found!
2014-09-02 18:07:02 +05:30
end
2018-11-20 20:47:30 +05:30
desc 'Get the common ancestor between commits' do
success Entities :: Commit
end
params do
2020-07-28 23:09:34 +05:30
requires :refs , type : Array [ String ] , coerce_with : :: API :: Validations :: Types :: CommaSeparatedToArray . coerce
2018-11-20 20:47:30 +05:30
end
get ':id/repository/merge_base' do
refs = params [ :refs ]
2018-12-13 13:39:08 +05:30
if refs . size < 2
render_api_error! ( 'Provide at least 2 refs' , 400 )
2018-11-20 20:47:30 +05:30
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-03-11 19:13:27 +05:30
desc 'Generates a changelog section for a release' do
detail 'This feature was introduced in GitLab 13.9'
end
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'
2021-04-17 20:07:23 +05:30
optional :to ,
2021-03-11 19:13:27 +05:30
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 :branch ,
type : String ,
desc : 'The branch to commit the changelog changes to'
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
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-06-08 01:23:25 +05:30
branch = params [ :branch ] || user_project . default_branch_or_main
2021-03-11 19:13:27 +05:30
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 )
)
service . execute
status ( 200 )
rescue Gitlab :: Changelog :: Error = > ex
render_api_error! ( " Failed to generate the changelog: #{ ex . message } " , 422 )
end
2014-09-02 18:07:02 +05:30
end
end
end