Merge branch '19830-pysdk-util-docs'
[arvados.git] / services / api / app / controllers / arvados / v1 / users_controller.rb
1 # Copyright (C) The Arvados Authors. All rights reserved.
2 #
3 # SPDX-License-Identifier: AGPL-3.0
4
5 class Arvados::V1::UsersController < ApplicationController
6   accept_attribute_as_json :prefs, Hash
7   accept_param_as_json :updates
8
9   skip_before_action :find_object_by_uuid, only:
10     [:activate, :current, :system, :setup, :merge, :batch_update]
11   skip_before_action :render_404_if_no_object, only:
12     [:activate, :current, :system, :setup, :merge, :batch_update]
13   before_action :admin_required, only: [:setup, :unsetup, :batch_update]
14
15   # Internal API used by controller to update local cache of user
16   # records from LoginCluster.
17   def batch_update
18     @objects = []
19     # update_remote_user takes a row lock on the User record, so sort
20     # the keys so we always lock them in the same order.
21     sorted = params[:updates].keys.sort
22     sorted.each do |uuid|
23       attrs = params[:updates][uuid]
24       attrs[:uuid] = uuid
25       u = User.update_remote_user nullify_attrs(attrs)
26       @objects << u
27     end
28     @offset = 0
29     @limit = -1
30     render_list
31   end
32
33   def current
34     if current_user
35       @object = current_user
36       show
37     else
38       send_error("Not logged in", status: 401)
39     end
40   end
41
42   def system
43     @object = system_user
44     show
45   end
46
47   def activate
48     if params[:id] and params[:id].match(/\D/)
49       params[:uuid] = params.delete :id
50     end
51     if current_user.andand.is_admin && params[:uuid]
52       @object = User.find_by_uuid params[:uuid]
53     else
54       @object = current_user
55     end
56     if not @object.is_active
57       if @object.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
58          @object.uuid[0..4] != Rails.configuration.ClusterID
59         logger.warn "Local user #{@object.uuid} called users#activate but only LoginCluster can do that"
60         raise ArgumentError.new "cannot activate user #{@object.uuid} here, only the #{@object.uuid[0..4]} cluster can do that"
61       elsif not (current_user.is_admin or @object.is_invited)
62         logger.warn "User #{@object.uuid} called users.activate " +
63           "but is not invited"
64         raise ArgumentError.new "Cannot activate without being invited."
65       end
66       act_as_system_user do
67         required_uuids = Link.where("owner_uuid = ? and link_class = ? and name = ? and tail_uuid = ? and head_uuid like ?",
68                                     system_user_uuid,
69                                     'signature',
70                                     'require',
71                                     system_user_uuid,
72                                     Collection.uuid_like_pattern).
73           collect(&:head_uuid)
74         signed_uuids = Link.where(owner_uuid: system_user_uuid,
75                                   link_class: 'signature',
76                                   name: 'click',
77                                   tail_uuid: @object.uuid,
78                                   head_uuid: required_uuids).
79           collect(&:head_uuid)
80         todo_uuids = required_uuids - signed_uuids
81         if todo_uuids.empty?
82           @object.update is_active: true
83           logger.info "User #{@object.uuid} activated"
84         else
85           logger.warn "User #{@object.uuid} called users.activate " +
86             "before signing agreements #{todo_uuids.inspect}"
87           raise ArvadosModel::PermissionDeniedError.new \
88           "Cannot activate without user agreements #{todo_uuids.inspect}."
89         end
90       end
91     end
92     show
93   end
94
95   # create user object and all the needed links
96   def setup
97     if params[:uuid]
98       @object = User.find_by_uuid(params[:uuid])
99       if !@object
100         return render_404_if_no_object
101       end
102     elsif !params[:user] || params[:user].empty?
103       raise ArgumentError.new "Required uuid or user"
104     elsif !params[:user]['email']
105       raise ArgumentError.new "Require user email"
106     else
107       @object = model_class.create! resource_attrs
108     end
109
110     # It's not always possible for the client to know the user's
111     # username when submitting this request: the username might have
112     # been assigned automatically in create!() above. If client
113     # provided a plain repository name, prefix it with the username
114     # now that we know what it is.
115     if params[:repo_name].nil?
116       full_repo_name = nil
117     elsif @object.username.nil?
118       raise ArgumentError.
119         new("cannot setup a repository because user has no username")
120     elsif params[:repo_name].index("/")
121       full_repo_name = params[:repo_name]
122     else
123       full_repo_name = "#{@object.username}/#{params[:repo_name]}"
124     end
125
126     @response = @object.setup(repo_name: full_repo_name,
127                               vm_uuid: params[:vm_uuid],
128                               send_notification_email: params[:send_notification_email])
129
130     send_json kind: "arvados#HashList", items: @response.as_api_response(nil)
131   end
132
133   # delete user agreements, vm, repository, login links; set state to inactive
134   def unsetup
135     reload_object_before_update
136     @object.unsetup
137     show
138   end
139
140   def merge
141     if (params[:old_user_uuid] || params[:new_user_uuid])
142       if !current_user.andand.is_admin
143         return send_error("Must be admin to use old_user_uuid/new_user_uuid", status: 403)
144       end
145       if !params[:old_user_uuid] || !params[:new_user_uuid]
146         return send_error("Must supply both old_user_uuid and new_user_uuid", status: 422)
147       end
148       new_user = User.find_by_uuid(params[:new_user_uuid])
149       if !new_user
150         return send_error("User in new_user_uuid not found", status: 422)
151       end
152       @object = User.find_by_uuid(params[:old_user_uuid])
153       if !@object
154         return send_error("User in old_user_uuid not found", status: 422)
155       end
156     else
157       if !Thread.current[:api_client].andand.is_trusted
158         return send_error("supplied API token is not from a trusted client", status: 403)
159       elsif Thread.current[:api_client_authorization].scopes != ['all']
160         return send_error("cannot merge with a scoped token", status: 403)
161       end
162
163       new_auth = ApiClientAuthorization.validate(token: params[:new_user_token])
164       if !new_auth
165         return send_error("invalid new_user_token", status: 401)
166       end
167
168       if new_auth.user.uuid[0..4] == Rails.configuration.ClusterID
169         if !new_auth.api_client.andand.is_trusted
170           return send_error("supplied new_user_token is not from a trusted client", status: 403)
171         elsif new_auth.scopes != ['all']
172           return send_error("supplied new_user_token has restricted scope", status: 403)
173         end
174       end
175       new_user = new_auth.user
176       @object = current_user
177     end
178
179     if @object.uuid == new_user.uuid
180       return send_error("cannot merge user to self", status: 422)
181     end
182
183     if !params[:new_owner_uuid]
184       return send_error("missing new_owner_uuid", status: 422)
185     end
186
187     if !new_user.can?(write: params[:new_owner_uuid])
188       return send_error("cannot move objects into supplied new_owner_uuid: new user does not have write permission", status: 403)
189     end
190
191     act_as_system_user do
192       @object.merge(new_owner_uuid: params[:new_owner_uuid],
193                     new_user_uuid: new_user.uuid,
194                     redirect_to_new_user: params[:redirect_to_new_user])
195     end
196     show
197   end
198
199   protected
200
201   def self._merge_requires_parameters
202     {
203       new_owner_uuid: {
204         type: 'string', required: true,
205       },
206       new_user_token: {
207         type: 'string', required: false,
208       },
209       redirect_to_new_user: {
210         type: 'boolean', required: false, default: false,
211       },
212       old_user_uuid: {
213         type: 'string', required: false,
214       },
215       new_user_uuid: {
216         type: 'string', required: false,
217       }
218     }
219   end
220
221   def self._setup_requires_parameters
222     {
223       uuid: {
224         type: 'string', required: false,
225       },
226       user: {
227         type: 'object', required: false,
228       },
229       repo_name: {
230         type: 'string', required: false,
231       },
232       vm_uuid: {
233         type: 'string', required: false,
234       },
235       send_notification_email: {
236         type: 'boolean', required: false, default: false,
237       },
238     }
239   end
240
241   def self._update_requires_parameters
242     super.merge({
243       bypass_federation: {
244         type: 'boolean', required: false, default: false,
245       },
246     })
247   end
248
249   def apply_filters(model_class=nil)
250     return super if @read_users.any?(&:is_admin)
251     if params[:uuid] != current_user.andand.uuid
252       # Non-admin index/show returns very basic information about readable users.
253       safe_attrs = ["uuid", "is_active", "is_admin", "is_invited", "email", "first_name", "last_name", "username", "can_write", "can_manage", "kind"]
254       if @select
255         @select = @select & safe_attrs
256       else
257         @select = safe_attrs
258       end
259       @filters += [['is_active', '=', true]]
260     end
261     # This gets called from within find_object_by_uuid.
262     # find_object_by_uuid stores the original value of @select in
263     # @preserve_select, edits the value of @select, calls
264     # find_objects_for_index, then restores @select from the value
265     # of @preserve_select.  So if we want our updated value of
266     # @select here to stick, we have to set @preserve_select.
267     @preserve_select = @select
268     super
269   end
270
271   def nullable_attributes
272     super + [:email, :first_name, :last_name, :username]
273   end
274 end