gitlab-org--gitlab-foss/lib/api/projects.rb

535 lines
19 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
require_dependency 'declarative_policy'
module API
2012-06-29 06:46:01 -04:00
class Projects < Grape::API
2016-11-09 09:51:27 -05:00
include PaginationParams
include Helpers::CustomAttributes
helpers Helpers::ProjectsHelpers
2016-11-09 09:51:27 -05:00
before { authenticate_non_get! }
2012-06-29 06:46:01 -04:00
2018-07-19 14:32:12 -04:00
helpers do
# EE::API::Projects would override this method
def apply_filters(projects)
projects = projects.with_issues_available_for_user(current_user) if params[:with_issues_enabled]
projects = projects.with_merge_requests_enabled if params[:with_merge_requests_enabled]
projects = projects.with_statistics if params[:statistics]
lang = params[:with_programming_language]
projects = projects.with_programming_language(lang) if lang
2018-07-19 14:32:12 -04:00
projects
end
2018-07-27 11:24:43 -04:00
def verify_update_project_attrs!(project, attrs)
end
end
2016-11-09 09:51:27 -05:00
helpers do
params :statistics_params do
optional :statistics, type: Boolean, default: false, desc: 'Include project statistics'
end
2017-06-29 13:20:59 -04:00
params :collection_params do
use :sort_params
use :filter_params
use :pagination
optional :simple, type: Boolean, default: false,
desc: 'Return only the ID, URL, name, and path of each project'
end
params :sort_params do
optional :order_by, type: String, values: %w[id name path created_at updated_at last_activity_at],
default: 'created_at', desc: 'Return projects ordered by field'
optional :sort, type: String, values: %w[asc desc], default: 'desc',
desc: 'Return projects sorted in ascending and descending order'
end
params :filter_params do
optional :archived, type: Boolean, desc: 'Limit by archived status'
2017-06-29 13:20:59 -04:00
optional :visibility, type: String, values: Gitlab::VisibilityLevel.string_values,
desc: 'Limit by visibility'
optional :search, type: String, desc: 'Return list of projects matching the search criteria'
optional :owned, type: Boolean, default: false, desc: 'Limit by owned by authenticated user'
optional :starred, type: Boolean, default: false, desc: 'Limit by starred status'
optional :membership, type: Boolean, default: false, desc: 'Limit by projects that the current user is a member of'
optional :with_issues_enabled, type: Boolean, default: false, desc: 'Limit by enabled issues feature'
optional :with_merge_requests_enabled, type: Boolean, default: false, desc: 'Limit by enabled merge requests feature'
optional :with_programming_language, type: String, desc: 'Limit to repositories which use the given programming language'
optional :min_access_level, type: Integer, values: Gitlab::Access.all_values, desc: 'Limit by minimum access level of authenticated user'
2018-07-19 14:32:12 -04:00
use :optional_filter_params_ee
2017-06-29 13:20:59 -04:00
end
params :create_params do
optional :namespace_id, type: Integer, desc: 'Namespace ID for the new project. Default to the user namespace.'
optional :import_url, type: String, desc: 'URL from which the project is imported'
end
def load_projects
ProjectsFinder.new(current_user: current_user, params: project_finder_params).execute
end
def present_projects(projects, options = {})
2017-06-29 13:20:59 -04:00
projects = reorder_projects(projects)
2018-07-19 14:32:12 -04:00
projects = apply_filters(projects)
projects = paginate(projects)
projects, options = with_custom_attributes(projects, options)
2017-06-29 13:20:59 -04:00
options = options.reverse_merge(
with: current_user ? Entities::ProjectWithAccess : Entities::BasicProjectDetails,
statistics: params[:statistics],
2018-10-26 11:12:14 -04:00
current_user: current_user,
license: false
2017-06-29 13:20:59 -04:00
)
options[:with] = Entities::BasicProjectDetails if params[:simple]
present options[:with].prepare_relation(projects, options), options
2017-06-29 13:20:59 -04:00
end
def translate_params_for_compatibility(params)
params[:builds_enabled] = params.delete(:jobs_enabled) if params.key?(:jobs_enabled)
params
end
2016-11-09 09:51:27 -05:00
end
2012-06-29 06:46:01 -04:00
2019-01-31 05:13:23 -05:00
resource :users, requirements: API::USER_REQUIREMENTS do
2017-06-29 13:20:59 -04:00
desc 'Get a user projects' do
success Entities::BasicProjectDetails
end
params do
requires :user_id, type: String, desc: 'The ID or username of the user'
use :collection_params
use :statistics_params
use :with_custom_attributes
end
2017-06-29 13:20:59 -04:00
get ":user_id/projects" do
user = find_user(params[:user_id])
not_found!('User') unless user
2017-06-29 13:20:59 -04:00
params[:user] = user
present_projects load_projects
2017-06-29 13:20:59 -04:00
end
desc 'Get projects starred by a user' do
success Entities::BasicProjectDetails
end
params do
requires :user_id, type: String, desc: 'The ID or username of the user'
use :collection_params
use :statistics_params
end
get ":user_id/starred_projects" do
user = find_user(params[:user_id])
not_found!('User') unless user
starred_projects = StarredProjectsFinder.new(user, params: project_finder_params, current_user: current_user).execute
present_projects starred_projects
end
2017-06-29 13:20:59 -04:00
end
resource :projects do
2017-09-18 09:03:24 -04:00
include CustomAttributesEndpoints
desc 'Get a list of visible projects for authenticated user' do
2016-11-09 09:51:27 -05:00
success Entities::BasicProjectDetails
end
params do
use :collection_params
use :statistics_params
use :with_custom_attributes
2016-11-09 09:51:27 -05:00
end
2012-06-29 06:46:01 -04:00
get do
present_projects load_projects
end
2016-11-09 09:51:27 -05:00
desc 'Create new project' do
success Entities::Project
end
params do
optional :name, type: String, desc: 'The name of the project'
2016-11-09 09:51:27 -05:00
optional :path, type: String, desc: 'The path of the repository'
at_least_one_of :name, :path
2018-03-28 13:07:16 -04:00
use :optional_project_params
2016-11-09 09:51:27 -05:00
use :create_params
end
2012-08-31 03:15:37 -04:00
post do
attrs = declared_params(include_missing: false)
attrs = translate_params_for_compatibility(attrs)
filter_attributes_using_license!(attrs)
2016-11-09 09:51:27 -05:00
project = ::Projects::CreateService.new(current_user, attrs).execute
if project.saved?
present project, with: Entities::Project,
user_can_admin_project: can?(current_user, :admin_project, project),
current_user: current_user
2012-08-31 03:15:37 -04:00
else
2016-11-09 09:51:27 -05:00
if project.errors[:limit_reached].present?
error!(project.errors[:limit_reached], 403)
end
2016-11-09 09:51:27 -05:00
render_validation_error!(project)
2012-08-31 03:15:37 -04:00
end
end
2016-11-09 09:51:27 -05:00
desc 'Create new project for a specified user. Only available to admin users.' do
success Entities::Project
end
params do
requires :name, type: String, desc: 'The name of the project'
requires :user_id, type: Integer, desc: 'The ID of a user'
optional :path, type: String, desc: 'The path of the repository'
2016-11-09 09:51:27 -05:00
optional :default_branch, type: String, desc: 'The default branch of the project'
2018-03-28 13:07:16 -04:00
use :optional_project_params
2016-11-09 09:51:27 -05:00
use :create_params
end
# rubocop: disable CodeReuse/ActiveRecord
2012-11-14 15:37:52 -05:00
post "user/:user_id" do
authenticated_as_admin!
2016-11-09 09:51:27 -05:00
user = User.find_by(id: params.delete(:user_id))
not_found!('User') unless user
attrs = declared_params(include_missing: false)
attrs = translate_params_for_compatibility(attrs)
filter_attributes_using_license!(attrs)
2016-11-09 09:51:27 -05:00
project = ::Projects::CreateService.new(user, attrs).execute
if project.saved?
present project, with: Entities::Project,
user_can_admin_project: can?(current_user, :admin_project, project),
current_user: current_user
2012-11-14 15:37:52 -05:00
else
2016-11-09 09:51:27 -05:00
render_validation_error!(project)
2012-11-14 15:37:52 -05:00
end
end
# rubocop: enable CodeReuse/ActiveRecord
2016-11-09 09:51:27 -05:00
end
2012-11-14 15:37:52 -05:00
2016-11-09 09:51:27 -05:00
params do
requires :id, type: String, desc: 'The ID of a project'
end
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
2016-11-09 09:51:27 -05:00
desc 'Get a single project' do
success Entities::ProjectWithAccess
end
params do
use :statistics_params
use :with_custom_attributes
2018-10-26 11:12:14 -04:00
optional :license, type: Boolean, default: false,
desc: 'Include project license data'
end
2016-11-09 09:51:27 -05:00
get ":id" do
options = {
with: current_user ? Entities::ProjectWithAccess : Entities::BasicProjectDetails,
current_user: current_user,
user_can_admin_project: can?(current_user, :admin_project, user_project),
2018-10-26 11:12:14 -04:00
statistics: params[:statistics],
license: params[:license]
}
project, options = with_custom_attributes(user_project, options)
present project, options
2016-11-09 09:51:27 -05:00
end
desc 'Fork new project for the current user or provided namespace.' do
success Entities::Project
end
params do
optional :namespace, type: String, desc: 'The ID or name of the namespace that the project will be forked into'
optional :path, type: String, desc: 'The path that will be assigned to the fork'
optional :name, type: String, desc: 'The name that will be assigned to the fork'
2016-11-09 09:51:27 -05:00
end
post ':id/fork' do
Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-ce/issues/42284')
2016-11-09 09:51:27 -05:00
fork_params = declared_params(include_missing: false)
namespace_id = fork_params[:namespace]
if namespace_id.present?
fork_params[:namespace] = find_namespace(namespace_id)
2016-11-09 09:51:27 -05:00
unless fork_params[:namespace] && can?(current_user, :create_projects, fork_params[:namespace])
not_found!('Target Namespace')
end
end
2016-11-09 09:51:27 -05:00
forked_project = ::Projects::ForkService.new(user_project, current_user, fork_params).execute
2016-11-09 09:51:27 -05:00
if forked_project.errors.any?
conflict!(forked_project.errors.messages)
else
2016-11-09 09:51:27 -05:00
present forked_project, with: Entities::Project,
user_can_admin_project: can?(current_user, :admin_project, forked_project),
current_user: current_user
end
end
desc 'List forks of this project' do
success Entities::Project
end
params do
use :collection_params
use :with_custom_attributes
end
get ':id/forks' do
forks = ForkProjectsFinder.new(user_project, params: project_finder_params, current_user: current_user).execute
present_projects forks
end
desc 'Check pages access of this project'
get ':id/pages_access' do
authorize! :read_pages_content, user_project unless user_project.public_pages?
status 200
end
2016-11-09 09:51:27 -05:00
desc 'Update an existing project' do
success Entities::Project
end
params do
optional :name, type: String, desc: 'The name of the project'
optional :default_branch, type: String, desc: 'The default branch of the project'
optional :path, type: String, desc: 'The path of the repository'
2017-04-05 12:31:15 -04:00
2018-03-28 13:07:16 -04:00
use :optional_project_params
use :optional_update_params_ee
2018-07-27 11:24:43 -04:00
at_least_one_of(*Helpers::ProjectsHelpers.update_params_at_least_one_of)
2016-11-09 09:51:27 -05:00
end
2014-10-15 02:57:35 -04:00
put ':id' do
authorize_admin_project
attrs = declared_params(include_missing: false)
2014-10-15 02:57:35 -04:00
authorize! :rename_project, user_project if attrs[:name].present?
authorize! :change_visibility_level, user_project if attrs[:visibility].present?
2014-10-15 02:57:35 -04:00
attrs = translate_params_for_compatibility(attrs)
filter_attributes_using_license!(attrs)
2018-07-27 11:24:43 -04:00
verify_update_project_attrs!(user_project, attrs)
result = ::Projects::UpdateService.new(user_project, current_user, attrs).execute
2014-10-15 02:57:35 -04:00
if result[:status] == :success
2016-01-11 09:27:20 -05:00
present user_project, with: Entities::Project,
user_can_admin_project: can?(current_user, :admin_project, user_project),
current_user: current_user
else
render_validation_error!(user_project)
2014-10-15 02:57:35 -04:00
end
end
2016-11-09 09:51:27 -05:00
desc 'Archive a project' do
success Entities::Project
end
post ':id/archive' do
authorize!(:archive_project, user_project)
::Projects::UpdateService.new(user_project, current_user, archived: true).execute
present user_project, with: Entities::Project, current_user: current_user
end
2016-11-09 09:51:27 -05:00
desc 'Unarchive a project' do
success Entities::Project
end
post ':id/unarchive' do
authorize!(:archive_project, user_project)
::Projects::UpdateService.new(@project, current_user, archived: false).execute
present user_project, with: Entities::Project, current_user: current_user
end
2016-11-09 09:51:27 -05:00
desc 'Star a project' do
success Entities::Project
end
2016-04-06 09:52:16 -04:00
post ':id/star' do
2016-04-12 12:52:43 -04:00
if current_user.starred?(user_project)
not_modified!
else
2016-04-06 09:52:16 -04:00
current_user.toggle_star(user_project)
user_project.reset
2016-04-13 06:50:00 -04:00
present user_project, with: Entities::Project, current_user: current_user
2016-04-06 09:52:16 -04:00
end
end
2016-11-09 09:51:27 -05:00
desc 'Unstar a project' do
success Entities::Project
end
post ':id/unstar' do
2016-04-06 09:52:16 -04:00
if current_user.starred?(user_project)
current_user.toggle_star(user_project)
user_project.reset
2016-04-13 06:50:00 -04:00
present user_project, with: Entities::Project, current_user: current_user
2016-04-06 09:52:16 -04:00
else
not_modified!
end
end
desc 'Get the users who starred a project' do
success Entities::UserBasic
end
params do
optional :search, type: String, desc: 'Return list of users matching the search criteria'
use :pagination
end
get ':id/starrers' do
2019-02-02 14:53:21 -05:00
starrers = UsersStarProjectsFinder.new(user_project, params, current_user: current_user).execute
present paginate(starrers), with: Entities::UserStarsProject
end
desc 'Get languages in project repository'
get ':id/languages' do
::Projects::RepositoryLanguagesService
.new(user_project, current_user)
.execute.map { |lang| [lang.name, lang.share] }.to_h
end
2016-11-09 09:51:27 -05:00
desc 'Remove a project'
2013-10-09 07:41:41 -04:00
delete ":id" do
authorize! :remove_project, user_project
2017-03-02 07:14:13 -05:00
destroy_conditionally!(user_project) do
::Projects::DestroyService.new(user_project, current_user, {}).async_execute
end
accepted!
2013-10-09 07:41:41 -04:00
end
2012-11-14 15:37:52 -05:00
2016-11-09 09:51:27 -05:00
desc 'Mark this project as forked from another'
params do
requires :forked_from_id, type: String, desc: 'The ID of the project it was forked from'
end
post ":id/fork/:forked_from_id" do
authorize! :admin_project, user_project
2016-11-09 09:51:27 -05:00
fork_from_project = find_project!(params[:forked_from_id])
2016-11-09 09:51:27 -05:00
not_found!("Source Project") unless fork_from_project
result = ::Projects::ForkService.new(fork_from_project, current_user).execute(user_project)
if result
present user_project.reset, with: Entities::Project, current_user: current_user
else
render_api_error!("Project already forked", 409) if user_project.forked?
end
end
2016-11-09 09:51:27 -05:00
desc 'Remove a forked_from relationship'
delete ":id/fork" do
authorize! :remove_fork_project, user_project
2016-11-09 09:51:27 -05:00
result = destroy_conditionally!(user_project) do
::Projects::UnlinkForkService.new(user_project, current_user).execute
end
result ? status(204) : not_modified!
end
2016-01-07 07:37:14 -05:00
2016-11-09 09:51:27 -05:00
desc 'Share the project with a group' do
success Entities::ProjectGroupLink
end
params do
requires :group_id, type: Integer, desc: 'The ID of a group'
requires :group_access, type: Integer, values: Gitlab::Access.values, as: :link_group_access, desc: 'The group access level'
2016-11-09 09:51:27 -05:00
optional :expires_at, type: Date, desc: 'Share expiration date'
end
post ":id/share" do
authorize! :admin_project, user_project
2016-11-09 09:51:27 -05:00
group = Group.find_by_id(params[:group_id])
unless user_project.allowed_to_share_with_group?
break render_api_error!("The project sharing with group is disabled", 400)
end
result = ::Projects::GroupLinks::CreateService.new(user_project, current_user, declared_params(include_missing: false))
.execute(group)
if result[:status] == :success
present result[:link], with: Entities::ProjectGroupLink
else
render_api_error!(result[:message], result[:http_status])
end
end
params do
requires :group_id, type: Integer, desc: 'The ID of the group'
2016-01-07 07:37:14 -05:00
end
# rubocop: disable CodeReuse/ActiveRecord
delete ":id/share/:group_id" do
authorize! :admin_project, user_project
link = user_project.project_group_links.find_by(group_id: params[:group_id])
not_found!('Group Link') unless link
2016-01-07 07:37:14 -05:00
destroy_conditionally!(link)
end
# rubocop: enable CodeReuse/ActiveRecord
2016-11-09 09:51:27 -05:00
desc 'Upload a file'
params do
requires :file, type: File, desc: 'The file to be uploaded'
end
2016-01-07 07:37:14 -05:00
post ":id/uploads" do
UploadService.new(user_project, params[:file]).execute.to_h
end
2016-11-09 09:51:27 -05:00
desc 'Get the users list of a project' do
success Entities::UserBasic
end
params do
optional :search, type: String, desc: 'Return list of users matching the search criteria'
optional :skip_users, type: Array[Integer], desc: 'Filter out users with the specified IDs'
2016-11-09 09:51:27 -05:00
use :pagination
end
get ':id/users' do
users = DeclarativePolicy.subject_scope { user_project.team.users }
2016-11-09 09:51:27 -05:00
users = users.search(params[:search]) if params[:search].present?
users = users.where_not_in(params[:skip_users]) if params[:skip_users].present?
2016-11-09 09:51:27 -05:00
present paginate(users), with: Entities::UserBasic
end
desc 'Start the housekeeping task for a project' do
detail 'This feature was introduced in GitLab 9.0.'
end
post ':id/housekeeping' do
authorize_admin_project
begin
::Projects::HousekeepingService.new(user_project, :gc).execute
rescue ::Projects::HousekeepingService::LeaseTaken => error
conflict!(error.message)
end
end
desc 'Transfer a project to a new namespace'
params do
requires :namespace, type: String, desc: 'The ID or path of the new namespace'
end
put ":id/transfer" do
authorize! :change_namespace, user_project
namespace = find_namespace!(params[:namespace])
result = ::Projects::TransferService.new(user_project, current_user).execute(namespace)
if result
present user_project, with: Entities::Project, current_user: current_user
else
render_api_error!("Failed to transfer project #{user_project.errors.messages}", 400)
end
end
2012-06-29 06:46:01 -04:00
end
end
end