2013-05-14 12:33:31 +00:00
|
|
|
module API
|
2015-10-22 09:16:51 +00:00
|
|
|
module Helpers
|
2013-03-28 18:37:44 +00:00
|
|
|
PRIVATE_TOKEN_HEADER = "HTTP_PRIVATE_TOKEN"
|
|
|
|
PRIVATE_TOKEN_PARAM = :private_token
|
|
|
|
SUDO_HEADER ="HTTP_SUDO"
|
|
|
|
SUDO_PARAM = :sudo
|
|
|
|
|
2014-07-28 05:01:01 +00:00
|
|
|
def parse_boolean(value)
|
|
|
|
[ true, 1, '1', 't', 'T', 'true', 'TRUE', 'on', 'ON' ].include?(value)
|
|
|
|
end
|
|
|
|
|
2012-06-27 11:32:56 +00:00
|
|
|
def current_user
|
2013-11-08 16:49:38 +00:00
|
|
|
private_token = (params[PRIVATE_TOKEN_PARAM] || env[PRIVATE_TOKEN_HEADER]).to_s
|
2014-12-19 14:15:29 +00:00
|
|
|
@current_user ||= (User.find_by(authentication_token: private_token) || doorkeeper_guard)
|
2014-05-15 08:03:26 +00:00
|
|
|
|
|
|
|
unless @current_user && Gitlab::UserAccess.allowed?(@current_user)
|
|
|
|
return nil
|
|
|
|
end
|
|
|
|
|
2013-03-28 18:37:44 +00:00
|
|
|
identifier = sudo_identifier()
|
2013-11-08 16:49:38 +00:00
|
|
|
|
2013-03-28 18:37:44 +00:00
|
|
|
# If the sudo is the current user do nothing
|
2015-03-25 01:28:10 +00:00
|
|
|
if identifier && !(@current_user.id == identifier || @current_user.username == identifier)
|
2013-03-28 18:37:44 +00:00
|
|
|
render_api_error!('403 Forbidden: Must be admin to use sudo', 403) unless @current_user.is_admin?
|
2013-10-16 17:31:46 +00:00
|
|
|
@current_user = User.by_username_or_id(identifier)
|
2013-10-16 17:28:39 +00:00
|
|
|
not_found!("No user id or username for: #{identifier}") if @current_user.nil?
|
2013-03-28 18:37:44 +00:00
|
|
|
end
|
2013-11-08 16:49:38 +00:00
|
|
|
|
2013-03-28 18:37:44 +00:00
|
|
|
@current_user
|
|
|
|
end
|
|
|
|
|
|
|
|
def sudo_identifier()
|
2013-06-28 12:59:05 +00:00
|
|
|
identifier ||= params[SUDO_PARAM] ||= env[SUDO_HEADER]
|
2013-11-08 16:49:38 +00:00
|
|
|
|
2013-06-28 12:59:05 +00:00
|
|
|
# Regex for integers
|
2015-03-25 01:28:10 +00:00
|
|
|
if !!(identifier =~ /^[0-9]+$/)
|
2013-03-28 18:37:44 +00:00
|
|
|
identifier.to_i
|
|
|
|
else
|
|
|
|
identifier
|
|
|
|
end
|
2012-06-27 11:32:56 +00:00
|
|
|
end
|
|
|
|
|
2012-07-06 13:08:17 +00:00
|
|
|
def user_project
|
2013-06-27 21:49:26 +00:00
|
|
|
@project ||= find_project(params[:id])
|
2014-12-30 12:36:13 +00:00
|
|
|
@project || not_found!("Project")
|
2012-12-12 10:54:28 +00:00
|
|
|
end
|
|
|
|
|
2013-06-27 21:49:26 +00:00
|
|
|
def find_project(id)
|
2014-03-14 13:58:52 +00:00
|
|
|
project = Project.find_with_namespace(id) || Project.find_by(id: id)
|
2012-12-12 10:54:28 +00:00
|
|
|
|
|
|
|
if project && can?(current_user, :read_project, project)
|
|
|
|
project
|
2012-07-25 12:24:28 +00:00
|
|
|
else
|
2012-12-12 10:54:28 +00:00
|
|
|
nil
|
2012-07-25 12:24:28 +00:00
|
|
|
end
|
2012-07-06 13:08:17 +00:00
|
|
|
end
|
|
|
|
|
2015-08-26 23:58:49 +00:00
|
|
|
def project_service
|
|
|
|
@project_service ||= begin
|
|
|
|
underscored_service = params[:service_slug].underscore
|
|
|
|
|
|
|
|
if Service.available_services_names.include?(underscored_service)
|
|
|
|
user_project.build_missing_services
|
|
|
|
|
|
|
|
service_method = "#{underscored_service}_service"
|
2015-10-03 06:29:58 +00:00
|
|
|
|
2015-08-26 23:58:49 +00:00
|
|
|
send_service(service_method)
|
|
|
|
end
|
|
|
|
end
|
2015-10-03 06:29:58 +00:00
|
|
|
|
2015-08-26 23:58:49 +00:00
|
|
|
@project_service || not_found!("Service")
|
|
|
|
end
|
|
|
|
|
|
|
|
def send_service(service_method)
|
|
|
|
user_project.send(service_method)
|
|
|
|
end
|
|
|
|
|
|
|
|
def service_attributes
|
|
|
|
@service_attributes ||= project_service.fields.inject([]) do |arr, hash|
|
|
|
|
arr << hash[:name].to_sym
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-01-30 09:46:08 +00:00
|
|
|
def find_group(id)
|
|
|
|
begin
|
|
|
|
group = Group.find(id)
|
|
|
|
rescue ActiveRecord::RecordNotFound
|
|
|
|
group = Group.find_by!(path: id)
|
|
|
|
end
|
|
|
|
|
|
|
|
if can?(current_user, :read_group, group)
|
|
|
|
group
|
|
|
|
else
|
|
|
|
forbidden!("#{current_user.username} lacks sufficient "\
|
|
|
|
"access to #{group.name}")
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2013-10-29 09:41:20 +00:00
|
|
|
def paginate(relation)
|
2016-01-14 11:08:44 +00:00
|
|
|
relation.page(params[:page]).per(params[:per_page].to_i).tap do |data|
|
|
|
|
add_pagination_headers(data)
|
|
|
|
end
|
2012-09-03 11:46:29 +00:00
|
|
|
end
|
|
|
|
|
2012-06-27 11:32:56 +00:00
|
|
|
def authenticate!
|
2012-09-10 07:41:46 +00:00
|
|
|
unauthorized! unless current_user
|
2012-06-27 11:32:56 +00:00
|
|
|
end
|
2012-09-10 06:06:11 +00:00
|
|
|
|
2014-10-15 15:26:15 +00:00
|
|
|
def authenticate_by_gitlab_shell_token!
|
2015-03-06 18:49:38 +00:00
|
|
|
input = params['secret_token'].try(:chomp)
|
|
|
|
unless Devise.secure_compare(secret_token, input)
|
|
|
|
unauthorized!
|
|
|
|
end
|
2014-10-15 15:26:15 +00:00
|
|
|
end
|
|
|
|
|
2012-10-02 09:46:01 +00:00
|
|
|
def authenticated_as_admin!
|
|
|
|
forbidden! unless current_user.is_admin?
|
|
|
|
end
|
|
|
|
|
2014-09-25 22:07:40 +00:00
|
|
|
def authorize!(action, subject)
|
2012-09-10 06:06:11 +00:00
|
|
|
unless abilities.allowed?(current_user, action, subject)
|
2012-09-10 07:41:46 +00:00
|
|
|
forbidden!
|
2012-09-10 06:06:11 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2014-04-01 07:39:53 +00:00
|
|
|
def authorize_push_project
|
|
|
|
authorize! :push_code, user_project
|
|
|
|
end
|
|
|
|
|
2013-09-29 13:04:57 +00:00
|
|
|
def authorize_admin_project
|
|
|
|
authorize! :admin_project, user_project
|
|
|
|
end
|
|
|
|
|
2015-10-12 21:47:32 +00:00
|
|
|
def require_gitlab_workhorse!
|
2015-11-09 11:49:47 +00:00
|
|
|
unless env['HTTP_GITLAB_WORKHORSE'].present?
|
2015-10-12 21:47:32 +00:00
|
|
|
forbidden!('Request should be executed via GitLab Workhorse')
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2012-12-12 10:54:28 +00:00
|
|
|
def can?(object, action, subject)
|
|
|
|
abilities.allowed?(object, action, subject)
|
|
|
|
end
|
|
|
|
|
2013-02-27 16:50:30 +00:00
|
|
|
# Checks the occurrences of required attributes, each attribute must be present in the params hash
|
|
|
|
# or a Bad Request error is invoked.
|
|
|
|
#
|
|
|
|
# Parameters:
|
|
|
|
# keys (required) - A hash consisting of keys that must be present
|
|
|
|
def required_attributes!(keys)
|
|
|
|
keys.each do |key|
|
|
|
|
bad_request!(key) unless params[key].present?
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-09-14 15:14:17 +00:00
|
|
|
def attributes_for_keys(keys, custom_params = nil)
|
2012-09-16 16:51:04 +00:00
|
|
|
attrs = {}
|
|
|
|
keys.each do |key|
|
2014-06-26 20:24:17 +00:00
|
|
|
if params[key].present? or (params.has_key?(key) and params[key] == false)
|
|
|
|
attrs[key] = params[key]
|
|
|
|
end
|
2012-09-16 16:51:04 +00:00
|
|
|
end
|
2014-06-26 20:24:17 +00:00
|
|
|
ActionController::Parameters.new(attrs).permit!
|
2012-09-16 16:51:04 +00:00
|
|
|
end
|
|
|
|
|
2014-08-14 08:17:52 +00:00
|
|
|
# Helper method for validating all labels against its names
|
|
|
|
def validate_label_params(params)
|
2014-08-17 20:22:01 +00:00
|
|
|
errors = {}
|
|
|
|
|
2014-08-14 08:17:52 +00:00
|
|
|
if params[:labels].present?
|
|
|
|
params[:labels].split(',').each do |label_name|
|
|
|
|
label = user_project.labels.create_with(
|
|
|
|
color: Label::DEFAULT_COLOR).find_or_initialize_by(
|
|
|
|
title: label_name.strip)
|
2014-08-17 20:22:01 +00:00
|
|
|
|
2014-08-14 08:17:52 +00:00
|
|
|
if label.invalid?
|
2014-08-17 20:22:01 +00:00
|
|
|
errors[label.title] = label.errors
|
2014-08-14 08:17:52 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2014-08-17 20:22:01 +00:00
|
|
|
|
|
|
|
errors
|
2014-08-14 08:17:52 +00:00
|
|
|
end
|
|
|
|
|
2015-01-30 09:46:08 +00:00
|
|
|
def validate_access_level?(level)
|
|
|
|
Gitlab::Access.options_with_owner.values.include? level.to_i
|
|
|
|
end
|
|
|
|
|
2015-02-06 06:00:54 +00:00
|
|
|
def issuable_order_by
|
|
|
|
if params["order_by"] == 'updated_at'
|
|
|
|
'updated_at'
|
|
|
|
else
|
|
|
|
'created_at'
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def issuable_sort
|
|
|
|
if params["sort"] == 'asc'
|
|
|
|
:asc
|
|
|
|
else
|
|
|
|
:desc
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-01-17 22:45:39 +00:00
|
|
|
def filter_by_iid(items, iid)
|
|
|
|
items.where(iid: iid)
|
|
|
|
end
|
|
|
|
|
2012-09-10 07:41:46 +00:00
|
|
|
# error helpers
|
|
|
|
|
2015-01-30 09:46:08 +00:00
|
|
|
def forbidden!(reason = nil)
|
|
|
|
message = ['403 Forbidden']
|
|
|
|
message << " - #{reason}" if reason
|
|
|
|
render_api_error!(message.join(' '), 403)
|
2012-09-10 07:41:46 +00:00
|
|
|
end
|
|
|
|
|
2013-02-13 14:48:52 +00:00
|
|
|
def bad_request!(attribute)
|
|
|
|
message = ["400 (Bad request)"]
|
|
|
|
message << "\"" + attribute.to_s + "\" not given"
|
|
|
|
render_api_error!(message.join(' '), 400)
|
|
|
|
end
|
|
|
|
|
2012-09-10 07:41:46 +00:00
|
|
|
def not_found!(resource = nil)
|
|
|
|
message = ["404"]
|
|
|
|
message << resource if resource
|
|
|
|
message << "Not Found"
|
2012-09-10 10:49:00 +00:00
|
|
|
render_api_error!(message.join(' '), 404)
|
2012-09-10 07:41:46 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def unauthorized!
|
2012-09-10 10:49:00 +00:00
|
|
|
render_api_error!('401 Unauthorized', 401)
|
2012-09-10 07:41:46 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def not_allowed!
|
2014-08-18 18:09:09 +00:00
|
|
|
render_api_error!('405 Method Not Allowed', 405)
|
|
|
|
end
|
|
|
|
|
|
|
|
def conflict!(message = nil)
|
|
|
|
render_api_error!(message || '409 Conflict', 409)
|
|
|
|
end
|
|
|
|
|
2015-10-12 21:47:32 +00:00
|
|
|
def file_to_large!
|
|
|
|
render_api_error!('413 Request Entity Too Large', 413)
|
|
|
|
end
|
|
|
|
|
2014-08-18 18:09:09 +00:00
|
|
|
def render_validation_error!(model)
|
2015-03-07 18:23:43 +00:00
|
|
|
if model.errors.any?
|
2014-08-18 18:09:09 +00:00
|
|
|
render_api_error!(model.errors.messages || '400 Bad Request', 400)
|
|
|
|
end
|
2012-09-10 10:49:00 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def render_api_error!(message, status)
|
2015-02-03 04:36:54 +00:00
|
|
|
error!({ 'message' => message }, status)
|
2012-09-10 07:41:46 +00:00
|
|
|
end
|
|
|
|
|
2015-09-15 10:50:24 +00:00
|
|
|
# Projects helpers
|
|
|
|
|
|
|
|
def filter_projects(projects)
|
|
|
|
# If the archived parameter is passed, limit results accordingly
|
|
|
|
if params[:archived].present?
|
|
|
|
projects = projects.where(archived: parse_boolean(params[:archived]))
|
|
|
|
end
|
|
|
|
|
|
|
|
if params[:search].present?
|
|
|
|
projects = projects.search(params[:search])
|
|
|
|
end
|
|
|
|
|
2016-01-18 17:41:49 +00:00
|
|
|
if params[:visibility].present?
|
|
|
|
projects = projects.search_by_visibility(params[:visibility])
|
2016-01-13 14:07:21 +00:00
|
|
|
end
|
|
|
|
|
2015-12-04 11:55:23 +00:00
|
|
|
projects.reorder(project_order_by => project_sort)
|
2015-09-15 10:50:24 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def project_order_by
|
|
|
|
order_fields = %w(id name path created_at updated_at last_activity_at)
|
|
|
|
|
|
|
|
if order_fields.include?(params['order_by'])
|
|
|
|
params['order_by']
|
|
|
|
else
|
|
|
|
'created_at'
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def project_sort
|
|
|
|
if params["sort"] == 'asc'
|
|
|
|
:asc
|
|
|
|
else
|
|
|
|
:desc
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-10-12 21:47:32 +00:00
|
|
|
# file helpers
|
|
|
|
|
2016-01-13 13:02:36 +00:00
|
|
|
def uploaded_file(field, uploads_path)
|
2015-11-09 21:01:26 +00:00
|
|
|
if params[field]
|
|
|
|
bad_request!("#{field} is not a file") unless params[field].respond_to?(:filename)
|
|
|
|
return params[field]
|
|
|
|
end
|
2015-10-12 21:47:32 +00:00
|
|
|
|
2016-01-13 13:02:36 +00:00
|
|
|
return nil unless params["#{field}.path"] && params["#{field}.name"]
|
|
|
|
|
2015-10-12 21:47:32 +00:00
|
|
|
# sanitize file paths
|
2015-11-09 21:01:26 +00:00
|
|
|
# this requires all paths to exist
|
|
|
|
required_attributes! %W(#{field}.path)
|
2015-10-12 21:47:32 +00:00
|
|
|
uploads_path = File.realpath(uploads_path)
|
2015-11-09 21:01:26 +00:00
|
|
|
file_path = File.realpath(params["#{field}.path"])
|
2015-10-12 21:47:32 +00:00
|
|
|
bad_request!('Bad file path') unless file_path.start_with?(uploads_path)
|
|
|
|
|
|
|
|
UploadedFile.new(
|
|
|
|
file_path,
|
2015-11-09 21:01:26 +00:00
|
|
|
params["#{field}.name"],
|
|
|
|
params["#{field}.type"] || 'application/octet-stream',
|
2015-10-12 21:47:32 +00:00
|
|
|
)
|
|
|
|
end
|
|
|
|
|
|
|
|
def present_file!(path, filename, content_type = 'application/octet-stream')
|
|
|
|
filename ||= File.basename(path)
|
|
|
|
header['Content-Disposition'] = "attachment; filename=#{filename}"
|
|
|
|
header['Content-Transfer-Encoding'] = 'binary'
|
|
|
|
content_type content_type
|
|
|
|
|
|
|
|
# Support download acceleration
|
|
|
|
case headers['X-Sendfile-Type']
|
|
|
|
when 'X-Sendfile'
|
|
|
|
header['X-Sendfile'] = path
|
|
|
|
body
|
|
|
|
else
|
|
|
|
file FileStreamer.new(path)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2012-09-21 10:22:30 +00:00
|
|
|
private
|
2012-09-10 06:06:11 +00:00
|
|
|
|
2016-01-14 11:08:44 +00:00
|
|
|
def add_pagination_headers(paginated_data)
|
|
|
|
header 'X-Total', paginated_data.total_count.to_s
|
|
|
|
header 'X-Total-Pages', paginated_data.total_pages.to_s
|
|
|
|
header 'X-Per-Page', paginated_data.limit_value.to_s
|
|
|
|
header 'X-Page', paginated_data.current_page.to_s
|
|
|
|
header 'X-Next-Page', paginated_data.next_page.to_s
|
|
|
|
header 'X-Prev-Page', paginated_data.prev_page.to_s
|
|
|
|
header 'Link', pagination_links(paginated_data)
|
|
|
|
end
|
|
|
|
|
|
|
|
def pagination_links(paginated_data)
|
2013-10-29 09:41:20 +00:00
|
|
|
request_url = request.url.split('?').first
|
|
|
|
|
|
|
|
links = []
|
2016-01-14 11:08:44 +00:00
|
|
|
links << %(<#{request_url}?page=#{paginated_data.current_page - 1}&per_page=#{paginated_data.limit_value}>; rel="prev") unless paginated_data.first_page?
|
|
|
|
links << %(<#{request_url}?page=#{paginated_data.current_page + 1}&per_page=#{paginated_data.limit_value}>; rel="next") unless paginated_data.last_page?
|
|
|
|
links << %(<#{request_url}?page=1&per_page=#{paginated_data.limit_value}>; rel="first")
|
|
|
|
links << %(<#{request_url}?page=#{paginated_data.total_pages}&per_page=#{paginated_data.limit_value}>; rel="last")
|
2013-10-29 09:41:20 +00:00
|
|
|
|
2016-01-14 11:08:44 +00:00
|
|
|
links.join(', ')
|
2013-10-29 09:41:20 +00:00
|
|
|
end
|
|
|
|
|
2012-09-10 06:06:11 +00:00
|
|
|
def abilities
|
|
|
|
@abilities ||= begin
|
2013-06-28 12:59:05 +00:00
|
|
|
abilities = Six.new
|
|
|
|
abilities << Ability
|
|
|
|
abilities
|
|
|
|
end
|
2012-09-10 06:06:11 +00:00
|
|
|
end
|
2014-10-15 15:26:15 +00:00
|
|
|
|
|
|
|
def secret_token
|
2015-02-16 12:16:26 +00:00
|
|
|
File.read(Gitlab.config.gitlab_shell.secret_file).chomp
|
2014-10-15 15:26:15 +00:00
|
|
|
end
|
2015-01-21 03:34:09 +00:00
|
|
|
|
|
|
|
def handle_member_errors(errors)
|
|
|
|
error!(errors[:access_level], 422) if errors[:access_level].any?
|
|
|
|
not_found!(errors)
|
|
|
|
end
|
2012-06-27 11:32:56 +00:00
|
|
|
end
|
|
|
|
end
|