16007: All the API tests pass!!!
[arvados.git] / services / api / app / models / user.rb
1 # Copyright (C) The Arvados Authors. All rights reserved.
2 #
3 # SPDX-License-Identifier: AGPL-3.0
4
5 require 'can_be_an_owner'
6
7 class User < ArvadosModel
8   include HasUuid
9   include KindAndEtag
10   include CommonApiTemplate
11   include CanBeAnOwner
12   extend CurrentApiClient
13
14   serialize :prefs, Hash
15   has_many :api_client_authorizations
16   validates(:username,
17             format: {
18               with: /\A[A-Za-z][A-Za-z0-9]*\z/,
19               message: "must begin with a letter and contain only alphanumerics",
20             },
21             uniqueness: true,
22             allow_nil: true)
23   validate :must_unsetup_to_deactivate
24   before_update :prevent_privilege_escalation
25   before_update :prevent_inactive_admin
26   before_update :verify_repositories_empty, :if => Proc.new { |user|
27     user.username.nil? and user.username_changed?
28   }
29   before_update :setup_on_activate
30
31   before_create :check_auto_admin
32   before_create :set_initial_username, :if => Proc.new { |user|
33     user.username.nil? and user.email
34   }
35   after_create :after_ownership_change
36   after_create :setup_on_activate
37   after_create :add_system_group_permission_link
38   after_create :auto_setup_new_user, :if => Proc.new { |user|
39     Rails.configuration.Users.AutoSetupNewUsers and
40     (user.uuid != system_user_uuid) and
41     (user.uuid != anonymous_user_uuid)
42   }
43   after_create :send_admin_notifications
44
45   before_update :before_ownership_change
46   after_update :after_ownership_change
47   after_update :send_profile_created_notification
48   after_update :sync_repository_names, :if => Proc.new { |user|
49     (user.uuid != system_user_uuid) and
50     user.username_changed? and
51     (not user.username_was.nil?)
52   }
53   after_destroy :clear_permissions
54
55   has_many :authorized_keys, :foreign_key => :authorized_user_uuid, :primary_key => :uuid
56   has_many :repositories, foreign_key: :owner_uuid, primary_key: :uuid
57
58   default_scope { where('redirect_to_user_uuid is null') }
59
60   api_accessible :user, extend: :common do |t|
61     t.add :email
62     t.add :username
63     t.add :full_name
64     t.add :first_name
65     t.add :last_name
66     t.add :identity_url
67     t.add :is_active
68     t.add :is_admin
69     t.add :is_invited
70     t.add :prefs
71     t.add :writable_by
72   end
73
74   ALL_PERMISSIONS = {read: true, write: true, manage: true}
75
76   # Map numeric permission levels (see lib/create_permission_view.sql)
77   # back to read/write/manage flags.
78   PERMS_FOR_VAL =
79     [{},
80      {read: true},
81      {read: true, write: true},
82      {read: true, write: true, manage: true}]
83
84   VAL_FOR_PERM =
85     {:read => 1,
86      :write => 2,
87      :manage => 3}
88
89
90   def full_name
91     "#{first_name} #{last_name}".strip
92   end
93
94   def is_invited
95     !!(self.is_active ||
96        Rails.configuration.Users.NewUsersAreActive ||
97        self.groups_i_can(:read).select { |x| x.match(/-f+$/) }.first)
98   end
99
100   def groups_i_can(verb)
101     my_groups = self.group_permissions(VAL_FOR_PERM[verb]).keys
102     if verb == :read
103       my_groups << anonymous_group_uuid
104     end
105     my_groups
106   end
107
108   def can?(actions)
109     return true if is_admin
110     actions.each do |action, target|
111       unless target.nil?
112         if target.respond_to? :uuid
113           target_uuid = target.uuid
114         else
115           target_uuid = target
116           target = ArvadosModel.find_by_uuid(target_uuid)
117         end
118       end
119       next if target_uuid == self.uuid
120
121       target_owner_uuid = target.owner_uuid if target.respond_to? :owner_uuid
122
123       unless ActiveRecord::Base.connection.
124         exec_query(%{
125 SELECT 1 FROM #{PERMISSION_VIEW}
126   WHERE user_uuid = $1 and
127         ((target_uuid = $2 and perm_level >= $3)
128          or (target_uuid = $4 and perm_level >= $3 and traverse_owned))
129 },
130                   # "name" arg is a query label that appears in logs:
131                    "user_can_query",
132                    [[nil, self.uuid],
133                     [nil, target_uuid],
134                     [nil, VAL_FOR_PERM[action]],
135                     [nil, target_owner_uuid]]
136                   ).any?
137         return false
138       end
139     end
140     true
141   end
142
143   def before_ownership_change
144     if owner_uuid_changed? and !self.owner_uuid_was.nil?
145       MaterializedPermission.where(user_uuid: owner_uuid_was, target_uuid: uuid).delete_all
146       User.update_permissions self.owner_uuid_was, self.uuid, 0, false
147     end
148   end
149
150   def after_ownership_change
151
152 #       puts "Update permissions for #{uuid}"
153 #     User.printdump %{
154 # select * from materialized_permissions where user_uuid='#{uuid}'
155 # }
156     puts "-1- #{uuid_changed?} and #{uuid} and #{uuid_was}"
157     puts "-2- #{owner_uuid_changed?} and #{owner_uuid} and #{owner_uuid_was}"
158
159     unless owner_uuid_changed?
160       return
161     end
162
163 #     if !uuid_was.nil? and uuid_changed?
164 #       puts "Cleaning house #{uuid_was}"
165 #     ActiveRecord::Base.connection.exec_query %{
166 # update #{PERMISSION_VIEW} set user_uuid=$1 where user_uuid = $2
167 # },
168 #                                              'Change user uuid',
169 #                                              [[nil, uuid],
170 #                                               [nil, uuid_was]]
171 #     ActiveRecord::Base.connection.exec_query %{
172 # update #{PERMISSION_VIEW} set target_uuid=$1 where target_uuid = $2
173 # },
174 #                                              'Change user uuid',
175 #                                              [[nil, uuid],
176 #                                               [nil, uuid_was]]
177 #     end
178
179     User.update_permissions self.owner_uuid, self.uuid, 3
180
181 #   puts "post-update"
182 #    User.printdump %{
183 # select * from materialized_permissions where user_uuid='#{uuid}'
184 # }
185 #    puts "<<<"
186   end
187
188   def clear_permissions
189     MaterializedPermission.where("user_uuid = ? or target_uuid = ?", uuid, uuid).delete_all
190   end
191
192   def self.printdump qr
193     q1 = ActiveRecord::Base.connection.exec_query qr
194     q1.each do |r|
195       puts r
196     end
197   end
198
199   def recompute_permissions
200     ActiveRecord::Base.connection.execute("DELETE FROM #{PERMISSION_VIEW} where user_uuid='#{uuid}'")
201     ActiveRecord::Base.connection.execute %{
202 INSERT INTO #{PERMISSION_VIEW}
203 select '#{uuid}', g.target_uuid, g.val, g.traverse_owned
204 from search_permission_graph('#{uuid}', 3) as g
205 }
206   end
207
208   def self.update_permissions perm_origin_uuid, starting_uuid, perm_level, check=true
209     # Update a subset of the permission graph
210     # perm_level is the inherited permission
211     # perm_level is a number from 0-3
212     #   can_read=1
213     #   can_write=2
214     #   can_manage=3
215     #   call with perm_level=0 to revoke permissions
216     #
217     # 1. Compute set (group, permission) implied by traversing
218     #    graph starting at this group
219     # 2. Find links from outside the graph that point inside
220     # 3. For each starting uuid, get the set of permissions from the
221     #    materialized permission table
222     # 3. Delete permissions from table not in our computed subset.
223     # 4. Upsert each permission in our subset (user, group, val)
224
225     ## testinging
226     puts "\n__ update_permissions __"
227 #     puts "What's in there now for #{starting_uuid}"
228 #     printdump %{
229 # select * from materialized_permissions where user_uuid='#{starting_uuid}'
230 # }
231
232     puts "search_permission_graph #{perm_origin_uuid} #{starting_uuid}, #{perm_level}"
233     printdump %{
234 select '#{perm_origin_uuid}'::varchar as perm_origin_uuid, target_uuid, val, traverse_owned from search_permission_graph('#{starting_uuid}', #{perm_level})
235 }
236
237 #     puts "other_links #{perm_origin_uuid} #{starting_uuid}, #{perm_level}"
238 #     printdump %{
239 # with
240 # perm_from_start(perm_origin_uuid, target_uuid, val, traverse_owned) as (
241 #   select '#{perm_origin_uuid}'::varchar, target_uuid, val, traverse_owned
242 #     from search_permission_graph('#{starting_uuid}'::varchar, #{perm_level}))
243
244 #     select links.tail_uuid as perm_origin_uuid, links.head_uuid, links.name
245 #       from links
246 #       where links.link_class='permission' and
247 #         links.tail_uuid not in (select target_uuid from perm_from_start where traverse_owned) and
248 #         links.tail_uuid != '#{perm_origin_uuid}' and
249 #         links.head_uuid in (select target_uuid from perm_from_start)
250 # }
251
252     puts "additional_perms #{perm_origin_uuid} #{starting_uuid}, #{perm_level}"
253     printdump %{
254 with
255 perm_from_start(perm_origin_uuid, target_uuid, val, traverse_owned) as (
256   select '#{perm_origin_uuid}'::varchar, target_uuid, val, traverse_owned
257     from search_permission_graph('#{starting_uuid}'::varchar, #{perm_level})),
258
259   edges(tail_uuid, head_uuid, val) as (
260         select * from permission_graph_edges()),
261
262   additional_perms(perm_origin_uuid, target_uuid, val, traverse_owned) as (
263     select edges.tail_uuid as perm_origin_uuid, ps.target_uuid, ps.val,
264            should_traverse_owned(ps.target_uuid, ps.val)
265       from edges, lateral search_permission_graph(edges.head_uuid, edges.val) as ps
266       where (not (edges.tail_uuid = '#{perm_origin_uuid}' and
267                   edges.head_uuid = '#{starting_uuid}')) and
268             edges.tail_uuid not in (select target_uuid from perm_from_start) and
269             edges.head_uuid in (select target_uuid from perm_from_start)),
270
271   partial_perms(perm_origin_uuid, target_uuid, val, traverse_owned) as (
272       select * from perm_from_start
273     union
274       select * from additional_perms
275   ),
276
277   user_identity_perms(perm_origin_uuid, target_uuid, val, traverse_owned) as (
278     select users.uuid as perm_origin_uuid, ps.target_uuid, ps.val, ps.traverse_owned
279       from users, lateral search_permission_graph(users.uuid, 3) as ps
280       where (users.owner_uuid not in (select target_uuid from partial_perms) or
281              users.owner_uuid = users.uuid) and
282       users.uuid in (select target_uuid from partial_perms)
283   ),
284
285   all_perms(perm_origin_uuid, target_uuid, val, traverse_owned) as (
286       select * from additional_perms
287     union
288       select * from user_identity_perms
289   )
290
291   select * from all_perms order by perm_origin_uuid, target_uuid
292 }
293
294     puts "Perms out"
295     printdump %{
296 select * from compute_permission_subgraph('#{perm_origin_uuid}', '#{starting_uuid}', '#{perm_level}')
297 order by user_uuid, target_uuid
298 }
299     ## end
300
301     temptable_perms = "temp_perms_#{rand(2**64).to_s(10)}"
302     ActiveRecord::Base.connection.exec_query %{
303 create temporary table #{temptable_perms} on commit drop
304 as select * from compute_permission_subgraph($1, $2, $3)
305 },
306                                              'Group.search_permissions',
307                                              [[nil, perm_origin_uuid],
308                                               [nil, starting_uuid],
309                                               [nil, perm_level]]
310
311 #     q1 = ActiveRecord::Base.connection.exec_query %{
312 # select * from #{temptable_perms} order by user_uuid, target_uuid
313 # }
314 #     puts "recomputed perms was #{perm_origin_uuid} #{starting_uuid}, #{perm_level}"
315 #     q1.each do |r|
316 #       puts r
317 #     end
318 #     puts "<<<<"
319
320     ActiveRecord::Base.connection.exec_query %{
321 delete from materialized_permissions where
322   target_uuid in (select target_uuid from #{temptable_perms}) and
323   not exists (select 1 from #{temptable_perms}
324               where target_uuid=materialized_permissions.target_uuid and
325                     user_uuid=materialized_permissions.user_uuid and
326                     val>0)
327 }
328
329     ActiveRecord::Base.connection.exec_query %{
330 insert into materialized_permissions (user_uuid, target_uuid, perm_level, traverse_owned)
331   select user_uuid, target_uuid, val as perm_level, traverse_owned from #{temptable_perms} where val>0
332 on conflict (user_uuid, target_uuid) do update set perm_level=EXCLUDED.perm_level, traverse_owned=EXCLUDED.traverse_owned;
333 }
334
335     # for testing only - make a copy of the table and compare it to the one generated
336     # using a full permission recompute
337
338 #     puts "dump--"
339 #     User.printdump %{
340 # select owner_uuid, uuid from users order by uuid
341 #     }
342 #     User.printdump %{
343 # select * from groups
344 #     }
345 #     User.printdump %{
346 #select * from search_permission_graph('zzzzz-tpzed-000000000000000', 3)
347 #     }
348 #     puts "--"
349
350     if check
351       q1 = ActiveRecord::Base.connection.exec_query %{
352 select user_uuid, target_uuid, perm_level, traverse_owned from materialized_permissions
353 order by user_uuid, target_uuid
354 }
355
356       q2 = ActiveRecord::Base.connection.exec_query %{
357 select users.uuid as user_uuid, g.target_uuid, g.val as perm_level, g.traverse_owned
358 from users, lateral search_permission_graph(users.uuid, 3) as g where g.val > 0
359 order by users.uuid, target_uuid
360 }
361
362       if q1.count != q2.count
363         puts "Didn't match incremental+: #{q1.count} != full refresh-: #{q2.count}"
364       end
365
366       if q1.count > q2.count
367         q1.each_with_index do |r, i|
368           if r != q2[i]
369             puts "+#{r}\n-#{q2[i]}"
370             raise "Didn't match"
371           end
372         end
373       else
374         q2.each_with_index do |r, i|
375           if r != q1[i]
376             puts "+#{q1[i]}\n-#{r}"
377             raise "Didn't match"
378           end
379         end
380       end
381     end
382   end
383
384   # Return a hash of {user_uuid: group_perms}
385   def self.all_group_permissions
386     all_perms = {}
387     ActiveRecord::Base.connection.
388       exec_query("SELECT user_uuid, target_uuid, perm_level
389                   FROM #{PERMISSION_VIEW}
390                   WHERE traverse_owned",
391                   # "name" arg is a query label that appears in logs:
392                  "all_group_permissions").
393       rows.each do |user_uuid, group_uuid, max_p_val|
394       all_perms[user_uuid] ||= {}
395       all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
396     end
397     all_perms
398   end
399
400   # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
401   # and perm_hash[:write] are true if this user can read and write
402   # objects owned by group_uuid.
403   def group_permissions(level=1)
404     group_perms = {}
405     ActiveRecord::Base.connection.
406       exec_query(%{
407 SELECT target_uuid, perm_level
408   FROM #{PERMISSION_VIEW}
409   WHERE user_uuid = $1 and perm_level >= $2
410 },
411                   # "name" arg is a query label that appears in logs:
412                   "group_permissions_for_user",
413                   # "binds" arg is an array of [col_id, value] for '$1' vars:
414                   [[nil, uuid],
415                    [nil, level]]).
416       rows.each do |group_uuid, max_p_val|
417       group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
418     end
419     group_perms
420   end
421
422   # create links
423   def setup(repo_name: nil, vm_uuid: nil)
424     repo_perm = create_user_repo_link repo_name
425     vm_login_perm = create_vm_login_permission_link(vm_uuid, username) if vm_uuid
426     group_perm = create_user_group_link
427
428     return [repo_perm, vm_login_perm, group_perm, self].compact
429   end
430
431   # delete user signatures, login, repo, and vm perms, and mark as inactive
432   def unsetup
433     # delete oid_login_perms for this user
434     #
435     # note: these permission links are obsolete, they have no effect
436     # on anything and they are not created for new users.
437     Link.where(tail_uuid: self.email,
438                      link_class: 'permission',
439                      name: 'can_login').destroy_all
440
441     # delete repo_perms for this user
442     Link.where(tail_uuid: self.uuid,
443                      link_class: 'permission',
444                      name: 'can_manage').destroy_all
445
446     # delete vm_login_perms for this user
447     Link.where(tail_uuid: self.uuid,
448                      link_class: 'permission',
449                      name: 'can_login').destroy_all
450
451     # delete "All users" group read permissions for this user
452     group = Group.where(name: 'All users').select do |g|
453       g[:uuid].match(/-f+$/)
454     end.first
455     Link.where(tail_uuid: self.uuid,
456                      head_uuid: group[:uuid],
457                      link_class: 'permission',
458                      name: 'can_read').destroy_all
459
460     # delete any signatures by this user
461     Link.where(link_class: 'signature',
462                      tail_uuid: self.uuid).destroy_all
463
464     # delete user preferences (including profile)
465     self.prefs = {}
466
467     # mark the user as inactive
468     self.is_active = false
469     self.save!
470   end
471
472   def must_unsetup_to_deactivate
473     if self.is_active_changed? &&
474        self.is_active_was == true &&
475        !self.is_active
476
477       group = Group.where(name: 'All users').select do |g|
478         g[:uuid].match(/-f+$/)
479       end.first
480
481       # When a user is set up, they are added to the "All users"
482       # group.  A user that is part of the "All users" group is
483       # allowed to self-activate.
484       #
485       # It doesn't make sense to deactivate a user (set is_active =
486       # false) without first removing them from the "All users" group,
487       # because they would be able to immediately reactivate
488       # themselves.
489       #
490       # The 'unsetup' method removes the user from the "All users"
491       # group (and also sets is_active = false) so send a message
492       # explaining the correct way to deactivate a user.
493       #
494       if Link.where(tail_uuid: self.uuid,
495                     head_uuid: group[:uuid],
496                     link_class: 'permission',
497                     name: 'can_read').any?
498         errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
499       end
500     end
501   end
502
503   def set_initial_username(requested: false)
504     if !requested.is_a?(String) || requested.empty?
505       email_parts = email.partition("@")
506       local_parts = email_parts.first.partition("+")
507       if email_parts.any?(&:empty?)
508         return
509       elsif not local_parts.first.empty?
510         requested = local_parts.first
511       else
512         requested = email_parts.first
513       end
514     end
515     requested.sub!(/^[^A-Za-z]+/, "")
516     requested.gsub!(/[^A-Za-z0-9]/, "")
517     unless requested.empty?
518       self.username = find_usable_username_from(requested)
519     end
520   end
521
522   def update_uuid(new_uuid:)
523     if !current_user.andand.is_admin
524       raise PermissionDeniedError
525     end
526     if uuid == system_user_uuid || uuid == anonymous_user_uuid
527       raise "update_uuid cannot update system accounts"
528     end
529     if self.class != self.class.resource_class_for_uuid(new_uuid)
530       raise "invalid new_uuid #{new_uuid.inspect}"
531     end
532     transaction(requires_new: true) do
533       reload
534       old_uuid = self.uuid
535       self.uuid = new_uuid
536       save!(validate: false)
537       change_all_uuid_refs(old_uuid: old_uuid, new_uuid: new_uuid)
538     ActiveRecord::Base.connection.exec_query %{
539 update #{PERMISSION_VIEW} set user_uuid=$1 where user_uuid = $2
540 },
541                                              'Change user uuid',
542                                              [[nil, new_uuid],
543                                               [nil, old_uuid]]
544       ActiveRecord::Base.connection.exec_query %{
545 update #{PERMISSION_VIEW} set target_uuid=$1 where target_uuid = $2
546 },
547                                              'Change target uuid',
548                                              [[nil, new_uuid],
549                                               [nil, old_uuid]]
550     end
551   end
552
553   # Move this user's (i.e., self's) owned items to new_owner_uuid and
554   # new_user_uuid (for things normally owned directly by the user).
555   #
556   # If redirect_auth is true, also reassign auth tokens and ssh keys,
557   # and redirect this account to redirect_to_user_uuid, i.e., when a
558   # caller authenticates to this account in the future, the account
559   # redirect_to_user_uuid account will be used instead.
560   #
561   # current_user must have admin privileges, i.e., the caller is
562   # responsible for checking permission to do this.
563   def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
564     raise PermissionDeniedError if !current_user.andand.is_admin
565     raise "Missing new_owner_uuid" if !new_owner_uuid
566     raise "Missing new_user_uuid" if !new_user_uuid
567     transaction(requires_new: true) do
568       reload
569       raise "cannot merge an already merged user" if self.redirect_to_user_uuid
570
571       new_user = User.where(uuid: new_user_uuid).first
572       raise "user does not exist" if !new_user
573       raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
574
575       # If 'self' is a remote user, don't transfer authorizations
576       # (i.e. ability to access the account) to the new user, because
577       # that gives the remote site the ability to access the 'new'
578       # user account that takes over the 'self' account.
579       #
580       # If 'self' is a local user, it is okay to transfer
581       # authorizations, even if the 'new' user is a remote account,
582       # because the remote site does not gain the ability to access an
583       # account it could not before.
584
585       if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
586         # Existing API tokens and ssh keys are updated to authenticate
587         # to the new user.
588         ApiClientAuthorization.
589           where(user_id: id).
590           update_all(user_id: new_user.id)
591
592         user_updates = [
593           [AuthorizedKey, :owner_uuid],
594           [AuthorizedKey, :authorized_user_uuid],
595           [Link, :owner_uuid],
596           [Link, :tail_uuid],
597           [Link, :head_uuid],
598         ]
599       else
600         # Destroy API tokens and ssh keys associated with the old
601         # user.
602         ApiClientAuthorization.where(user_id: id).destroy_all
603         AuthorizedKey.where(owner_uuid: uuid).destroy_all
604         AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
605         user_updates = [
606           [Link, :owner_uuid],
607           [Link, :tail_uuid]
608         ]
609       end
610
611       # References to the old user UUID in the context of a user ID
612       # (rather than a "home project" in the project hierarchy) are
613       # updated to point to the new user.
614       user_updates.each do |klass, column|
615         klass.where(column => uuid).update_all(column => new_user.uuid)
616       end
617
618       # Need to update repository names to new username
619       if username
620         old_repo_name_re = /^#{Regexp.escape(username)}\//
621         Repository.where(:owner_uuid => uuid).each do |repo|
622           repo.owner_uuid = new_user.uuid
623           repo_name_sub = "#{new_user.username}/"
624           name = repo.name.sub(old_repo_name_re, repo_name_sub)
625           while (conflict = Repository.where(:name => name).first) != nil
626             repo_name_sub += "migrated"
627             name = repo.name.sub(old_repo_name_re, repo_name_sub)
628           end
629           repo.name = name
630           repo.save!
631         end
632       end
633
634       # References to the merged user's "home project" are updated to
635       # point to new_owner_uuid.
636       ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
637         next if [ApiClientAuthorization,
638                  AuthorizedKey,
639                  Link,
640                  Log,
641                  Repository].include?(klass)
642         next if !klass.columns.collect(&:name).include?('owner_uuid')
643         klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
644       end
645
646       if redirect_to_new_user
647         update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
648       end
649       self.recompute_permissions
650       new_user.recompute_permissions
651     end
652   end
653
654   def redirects_to
655     user = self
656     redirects = 0
657     while (uuid = user.redirect_to_user_uuid)
658       break if uuid.empty?
659       nextuser = User.unscoped.find_by_uuid(uuid)
660       if !nextuser
661         raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
662       end
663       user = nextuser
664       redirects += 1
665       if redirects > 15
666         raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
667       end
668     end
669     user
670   end
671
672   def self.register info
673     # login info expected fields, all can be optional but at minimum
674     # must supply either 'identity_url' or 'email'
675     #
676     #   email
677     #   first_name
678     #   last_name
679     #   username
680     #   alternate_emails
681     #   identity_url
682
683     primary_user = nil
684
685     # local database
686     identity_url = info['identity_url']
687
688     if identity_url && identity_url.length > 0
689       # Only local users can create sessions, hence uuid_like_pattern
690       # here.
691       user = User.unscoped.where('identity_url = ? and uuid like ?',
692                                  identity_url,
693                                  User.uuid_like_pattern).first
694       primary_user = user.redirects_to if user
695     end
696
697     if !primary_user
698       # identity url is unset or didn't find matching record.
699       emails = [info['email']] + (info['alternate_emails'] || [])
700       emails.select! {|em| !em.nil? && !em.empty?}
701
702       User.unscoped.where('email in (?) and uuid like ?',
703                           emails,
704                           User.uuid_like_pattern).each do |user|
705         if !primary_user
706           primary_user = user.redirects_to
707         elsif primary_user.uuid != user.redirects_to.uuid
708           raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
709         end
710       end
711     end
712
713     if !primary_user
714       # New user registration
715       primary_user = User.new(:owner_uuid => system_user_uuid,
716                               :is_admin => false,
717                               :is_active => Rails.configuration.Users.NewUsersAreActive)
718
719       primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
720       primary_user.identity_url = info['identity_url'] if identity_url
721     end
722
723     primary_user.email = info['email'] if info['email']
724     primary_user.first_name = info['first_name'] if info['first_name']
725     primary_user.last_name = info['last_name'] if info['last_name']
726
727     if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
728       raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
729     end
730
731     act_as_system_user do
732       primary_user.save!
733     end
734
735     primary_user
736   end
737
738   protected
739
740   def change_all_uuid_refs(old_uuid:, new_uuid:)
741     ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
742       klass.columns.each do |col|
743         if col.name.end_with?('_uuid')
744           column = col.name.to_sym
745           klass.where(column => old_uuid).update_all(column => new_uuid)
746         end
747       end
748     end
749   end
750
751   def ensure_ownership_path_leads_to_user
752     true
753   end
754
755   def permission_to_update
756     if username_changed? || redirect_to_user_uuid_changed? || email_changed?
757       current_user.andand.is_admin
758     else
759       # users must be able to update themselves (even if they are
760       # inactive) in order to create sessions
761       self == current_user or super
762     end
763   end
764
765   def permission_to_create
766     current_user.andand.is_admin or
767       (self == current_user &&
768        self.redirect_to_user_uuid.nil? &&
769        self.is_active == Rails.configuration.Users.NewUsersAreActive)
770   end
771
772   def check_auto_admin
773     return if self.uuid.end_with?('anonymouspublic')
774     if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
775         !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
776        (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
777         Rails.configuration.Users.AutoAdminFirstUser)
778       self.is_admin = true
779       self.is_active = true
780     end
781   end
782
783   def find_usable_username_from(basename)
784     # If "basename" is a usable username, return that.
785     # Otherwise, find a unique username "basenameN", where N is the
786     # smallest integer greater than 1, and return that.
787     # Return nil if a unique username can't be found after reasonable
788     # searching.
789     quoted_name = self.class.connection.quote_string(basename)
790     next_username = basename
791     next_suffix = 1
792     while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
793       next_suffix += 1
794       next_username = "%s%i" % [basename, next_suffix]
795     end
796     0.upto(6).each do |suffix_len|
797       pattern = "%s%s" % [quoted_name, "_" * suffix_len]
798       self.class.unscoped.
799           where("username like '#{pattern}'").
800           select(:username).
801           order('username asc').
802           each do |other_user|
803         if other_user.username > next_username
804           break
805         elsif other_user.username == next_username
806           next_suffix += 1
807           next_username = "%s%i" % [basename, next_suffix]
808         end
809       end
810       return next_username if (next_username.size <= pattern.size)
811     end
812     nil
813   end
814
815   def prevent_privilege_escalation
816     if current_user.andand.is_admin
817       return true
818     end
819     if self.is_active_changed?
820       if self.is_active != self.is_active_was
821         logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
822         self.is_active = self.is_active_was
823       end
824     end
825     if self.is_admin_changed?
826       if self.is_admin != self.is_admin_was
827         logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
828         self.is_admin = self.is_admin_was
829       end
830     end
831     true
832   end
833
834   def prevent_inactive_admin
835     if self.is_admin and not self.is_active
836       # There is no known use case for the strange set of permissions
837       # that would result from this change. It's safest to assume it's
838       # a mistake and disallow it outright.
839       raise "Admin users cannot be inactive"
840     end
841     true
842   end
843
844   def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
845     nextpaths = graph[start]
846     return merged if !nextpaths
847     return merged if upstream_path.has_key? start
848     upstream_path[start] = true
849     upstream_mask ||= ALL_PERMISSIONS
850     nextpaths.each do |head, mask|
851       merged[head] ||= {}
852       mask.each do |k,v|
853         merged[head][k] ||= v if upstream_mask[k]
854       end
855       search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
856     end
857     upstream_path.delete start
858     merged
859   end
860
861   def create_user_repo_link(repo_name)
862     # repo_name is optional
863     if not repo_name
864       logger.warn ("Repository name not given for #{self.uuid}.")
865       return
866     end
867
868     repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
869     logger.info { "repo uuid: " + repo[:uuid] }
870     repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
871                            link_class: "permission",
872                            name: "can_manage").first_or_create!
873     logger.info { "repo permission: " + repo_perm[:uuid] }
874     return repo_perm
875   end
876
877   # create login permission for the given vm_uuid, if it does not already exist
878   def create_vm_login_permission_link(vm_uuid, repo_name)
879     # vm uuid is optional
880     return if vm_uuid == ""
881
882     vm = VirtualMachine.where(uuid: vm_uuid).first
883     if !vm
884       logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
885       raise "No vm found for #{vm_uuid}"
886     end
887
888     logger.info { "vm uuid: " + vm[:uuid] }
889     login_attrs = {
890       tail_uuid: uuid, head_uuid: vm.uuid,
891       link_class: "permission", name: "can_login",
892     }
893
894     login_perm = Link.
895       where(login_attrs).
896       select { |link| link.properties["username"] == repo_name }.
897       first
898
899     login_perm ||= Link.
900       create(login_attrs.merge(properties: {"username" => repo_name}))
901
902     logger.info { "login permission: " + login_perm[:uuid] }
903     login_perm
904   end
905
906   # add the user to the 'All users' group
907   def create_user_group_link
908     #puts "In create_user_group_link"
909     return (Link.where(tail_uuid: self.uuid,
910                        head_uuid: all_users_group[:uuid],
911                        link_class: 'permission',
912                        name: 'can_read').first or
913             Link.create(tail_uuid: self.uuid,
914                         head_uuid: all_users_group[:uuid],
915                         link_class: 'permission',
916                         name: 'can_read'))
917   end
918
919   # Give the special "System group" permission to manage this user and
920   # all of this user's stuff.
921   def add_system_group_permission_link
922     return true if uuid == system_user_uuid
923     act_as_system_user do
924       Link.create(link_class: 'permission',
925                   name: 'can_manage',
926                   tail_uuid: system_group_uuid,
927                   head_uuid: self.uuid)
928     end
929   end
930
931   # Send admin notifications
932   def send_admin_notifications
933     AdminNotifier.new_user(self).deliver_now
934     if not self.is_active then
935       AdminNotifier.new_inactive_user(self).deliver_now
936     end
937   end
938
939   # Automatically setup if is_active flag turns on
940   def setup_on_activate
941     return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
942     if is_active && (new_record? || is_active_changed?)
943       setup
944     end
945   end
946
947   # Automatically setup new user during creation
948   def auto_setup_new_user
949     setup
950     if username
951       create_vm_login_permission_link(Rails.configuration.Users.AutoSetupNewUsersWithVmUUID,
952                                       username)
953       repo_name = "#{username}/#{username}"
954       if Rails.configuration.Users.AutoSetupNewUsersWithRepository and
955           Repository.where(name: repo_name).first.nil?
956         repo = Repository.create!(name: repo_name, owner_uuid: uuid)
957         Link.create!(tail_uuid: uuid, head_uuid: repo.uuid,
958                      link_class: "permission", name: "can_manage")
959       end
960     end
961   end
962
963   # Send notification if the user saved profile for the first time
964   def send_profile_created_notification
965     if self.prefs_changed?
966       if self.prefs_was.andand.empty? || !self.prefs_was.andand['profile']
967         profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
968         ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
969       end
970     end
971   end
972
973   def verify_repositories_empty
974     unless repositories.first.nil?
975       errors.add(:username, "can't be unset when the user owns repositories")
976       throw(:abort)
977     end
978   end
979
980   def sync_repository_names
981     old_name_re = /^#{Regexp.escape(username_was)}\//
982     name_sub = "#{username}/"
983     repositories.find_each do |repo|
984       repo.name = repo.name.sub(old_name_re, name_sub)
985       repo.save!
986     end
987   end
988 end