18803: Save empty identity_url to database as null.
[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   validate :identity_url_nil_if_empty
25   before_update :prevent_privilege_escalation
26   before_update :prevent_inactive_admin
27   before_update :verify_repositories_empty, :if => Proc.new {
28     username.nil? and username_changed?
29   }
30   after_update :setup_on_activate
31
32   before_create :check_auto_admin
33   before_create :set_initial_username, :if => Proc.new {
34     username.nil? and email
35   }
36   after_create :after_ownership_change
37   after_create :setup_on_activate
38   after_create :add_system_group_permission_link
39   after_create :auto_setup_new_user, :if => Proc.new {
40     Rails.configuration.Users.AutoSetupNewUsers and
41     (uuid != system_user_uuid) and
42     (uuid != anonymous_user_uuid) and
43     (uuid[0..4] == Rails.configuration.ClusterID)
44   }
45   after_create :send_admin_notifications
46
47   before_update :before_ownership_change
48   after_update :after_ownership_change
49   after_update :send_profile_created_notification
50   after_update :sync_repository_names, :if => Proc.new {
51     (uuid != system_user_uuid) and
52     saved_change_to_username? and
53     (not username_before_last_save.nil?)
54   }
55   before_destroy :clear_permissions
56   after_destroy :remove_self_from_permissions
57
58   has_many :authorized_keys, :foreign_key => :authorized_user_uuid, :primary_key => :uuid
59   has_many :repositories, foreign_key: :owner_uuid, primary_key: :uuid
60
61   default_scope { where('redirect_to_user_uuid is null') }
62
63   api_accessible :user, extend: :common do |t|
64     t.add :email
65     t.add :username
66     t.add :full_name
67     t.add :first_name
68     t.add :last_name
69     t.add :identity_url
70     t.add :is_active
71     t.add :is_admin
72     t.add :is_invited
73     t.add :prefs
74     t.add :writable_by
75   end
76
77   ALL_PERMISSIONS = {read: true, write: true, manage: true}
78
79   # Map numeric permission levels (see lib/create_permission_view.sql)
80   # back to read/write/manage flags.
81   PERMS_FOR_VAL =
82     [{},
83      {read: true},
84      {read: true, write: true},
85      {read: true, write: true, manage: true}]
86
87   VAL_FOR_PERM =
88     {:read => 1,
89      :write => 2,
90      :manage => 3}
91
92
93   def full_name
94     "#{first_name} #{last_name}".strip
95   end
96
97   def is_invited
98     !!(self.is_active ||
99        Rails.configuration.Users.NewUsersAreActive ||
100        self.groups_i_can(:read).select { |x| x.match(/-f+$/) }.first)
101   end
102
103   def groups_i_can(verb)
104     my_groups = self.group_permissions(VAL_FOR_PERM[verb]).keys
105     if verb == :read
106       my_groups << anonymous_group_uuid
107     end
108     my_groups
109   end
110
111   def can?(actions)
112     return true if is_admin
113     actions.each do |action, target|
114       unless target.nil?
115         if target.respond_to? :uuid
116           target_uuid = target.uuid
117         else
118           target_uuid = target
119           target = ArvadosModel.find_by_uuid(target_uuid)
120         end
121       end
122       next if target_uuid == self.uuid
123
124       target_owner_uuid = target.owner_uuid if target.respond_to? :owner_uuid
125
126       user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: "$3"}
127
128       unless ActiveRecord::Base.connection.
129         exec_query(%{
130 SELECT 1 FROM #{PERMISSION_VIEW}
131   WHERE user_uuid in (#{user_uuids_subquery}) and
132         ((target_uuid = $2 and perm_level >= $3)
133          or (target_uuid = $4 and perm_level >= $3 and traverse_owned))
134 },
135                   # "name" arg is a query label that appears in logs:
136                    "user_can_query",
137                    [[nil, self.uuid],
138                     [nil, target_uuid],
139                     [nil, VAL_FOR_PERM[action]],
140                     [nil, target_owner_uuid]]
141                   ).any?
142         return false
143       end
144     end
145     true
146   end
147
148   def before_ownership_change
149     if owner_uuid_changed? and !self.owner_uuid_was.nil?
150       MaterializedPermission.where(user_uuid: owner_uuid_was, target_uuid: uuid).delete_all
151       update_permissions self.owner_uuid_was, self.uuid, REVOKE_PERM
152     end
153   end
154
155   def after_ownership_change
156     if saved_change_to_owner_uuid?
157       update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
158     end
159   end
160
161   def clear_permissions
162     MaterializedPermission.where("user_uuid = ? and target_uuid != ?", uuid, uuid).delete_all
163   end
164
165   def forget_cached_group_perms
166     @group_perms = nil
167   end
168
169   def remove_self_from_permissions
170     MaterializedPermission.where("target_uuid = ?", uuid).delete_all
171     check_permissions_against_full_refresh
172   end
173
174   # Return a hash of {user_uuid: group_perms}
175   #
176   # note: this does not account for permissions that a user gains by
177   # having can_manage on another user.
178   def self.all_group_permissions
179     all_perms = {}
180     ActiveRecord::Base.connection.
181       exec_query(%{
182 SELECT user_uuid, target_uuid, perm_level
183                   FROM #{PERMISSION_VIEW}
184                   WHERE traverse_owned
185 },
186                   # "name" arg is a query label that appears in logs:
187                  "all_group_permissions").
188       rows.each do |user_uuid, group_uuid, max_p_val|
189       all_perms[user_uuid] ||= {}
190       all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
191     end
192     all_perms
193   end
194
195   # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
196   # and perm_hash[:write] are true if this user can read and write
197   # objects owned by group_uuid.
198   def group_permissions(level=1)
199     @group_perms ||= {}
200     if @group_perms.empty?
201       user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: 1}
202
203       ActiveRecord::Base.connection.
204         exec_query(%{
205 SELECT target_uuid, perm_level
206   FROM #{PERMISSION_VIEW}
207   WHERE user_uuid in (#{user_uuids_subquery}) and perm_level >= 1
208 },
209                    # "name" arg is a query label that appears in logs:
210                    "User.group_permissions",
211                    # "binds" arg is an array of [col_id, value] for '$1' vars:
212                    [[nil, uuid]]).
213         rows.each do |group_uuid, max_p_val|
214         @group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
215       end
216     end
217
218     case level
219     when 1
220       @group_perms
221     when 2
222       @group_perms.select {|k,v| v[:write] }
223     when 3
224       @group_perms.select {|k,v| v[:manage] }
225     else
226       raise "level must be 1, 2 or 3"
227     end
228   end
229
230   # create links
231   def setup(repo_name: nil, vm_uuid: nil, send_notification_email: nil)
232     newly_invited = Link.where(tail_uuid: self.uuid,
233                               head_uuid: all_users_group_uuid,
234                               link_class: 'permission',
235                               name: 'can_read').empty?
236
237     # Add can_read link from this user to "all users" which makes this
238     # user "invited", and (depending on config) a link in the opposite
239     # direction which makes this user visible to other users.
240     group_perms = add_to_all_users_group
241
242     # Add git repo
243     repo_perm = if (!repo_name.nil? || Rails.configuration.Users.AutoSetupNewUsersWithRepository) and !username.nil?
244                   repo_name ||= "#{username}/#{username}"
245                   create_user_repo_link repo_name
246                 end
247
248     # Add virtual machine
249     if vm_uuid.nil? and !Rails.configuration.Users.AutoSetupNewUsersWithVmUUID.empty?
250       vm_uuid = Rails.configuration.Users.AutoSetupNewUsersWithVmUUID
251     end
252
253     vm_login_perm = if vm_uuid && username
254                       create_vm_login_permission_link(vm_uuid, username)
255                     end
256
257     # Send welcome email
258     if send_notification_email.nil?
259       send_notification_email = Rails.configuration.Mail.SendUserSetupNotificationEmail
260     end
261
262     if newly_invited and send_notification_email and !Rails.configuration.Users.UserSetupMailText.empty?
263       begin
264         UserNotifier.account_is_setup(self).deliver_now
265       rescue => e
266         logger.warn "Failed to send email to #{self.email}: #{e}"
267       end
268     end
269
270     forget_cached_group_perms
271
272     return [repo_perm, vm_login_perm, *group_perms, self].compact
273   end
274
275   # delete user signatures, login, repo, and vm perms, and mark as inactive
276   def unsetup
277     # delete oid_login_perms for this user
278     #
279     # note: these permission links are obsolete, they have no effect
280     # on anything and they are not created for new users.
281     Link.where(tail_uuid: self.email,
282                      link_class: 'permission',
283                      name: 'can_login').destroy_all
284
285     # delete repo_perms for this user
286     Link.where(tail_uuid: self.uuid,
287                      link_class: 'permission',
288                      name: 'can_manage').destroy_all
289
290     # delete vm_login_perms for this user
291     Link.where(tail_uuid: self.uuid,
292                      link_class: 'permission',
293                      name: 'can_login').destroy_all
294
295     # delete "All users" group read permissions for this user
296     Link.where(tail_uuid: self.uuid,
297                      head_uuid: all_users_group_uuid,
298                      link_class: 'permission',
299                      name: 'can_read').destroy_all
300
301     # delete any signatures by this user
302     Link.where(link_class: 'signature',
303                      tail_uuid: self.uuid).destroy_all
304
305     # delete tokens for this user
306     ApiClientAuthorization.where(user_id: self.id).destroy_all
307     # delete ssh keys for this user
308     AuthorizedKey.where(owner_uuid: self.uuid).destroy_all
309     AuthorizedKey.where(authorized_user_uuid: self.uuid).destroy_all
310
311     # delete user preferences (including profile)
312     self.prefs = {}
313
314     # mark the user as inactive
315     self.is_admin = false  # can't be admin and inactive
316     self.is_active = false
317     forget_cached_group_perms
318     self.save!
319   end
320
321   def must_unsetup_to_deactivate
322     if !self.new_record? &&
323        self.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
324        self.uuid[0..4] != Rails.configuration.ClusterID
325       # OK to update our local record to whatever the LoginCluster
326       # reports, because self-activate is not allowed.
327       return
328     elsif self.is_active_changed? &&
329        self.is_active_was &&
330        !self.is_active
331
332       # When a user is set up, they are added to the "All users"
333       # group.  A user that is part of the "All users" group is
334       # allowed to self-activate.
335       #
336       # It doesn't make sense to deactivate a user (set is_active =
337       # false) without first removing them from the "All users" group,
338       # because they would be able to immediately reactivate
339       # themselves.
340       #
341       # The 'unsetup' method removes the user from the "All users"
342       # group (and also sets is_active = false) so send a message
343       # explaining the correct way to deactivate a user.
344       #
345       if Link.where(tail_uuid: self.uuid,
346                     head_uuid: all_users_group_uuid,
347                     link_class: 'permission',
348                     name: 'can_read').any?
349         errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
350       end
351     end
352   end
353
354   def set_initial_username(requested: false)
355     if !requested.is_a?(String) || requested.empty?
356       email_parts = email.partition("@")
357       local_parts = email_parts.first.partition("+")
358       if email_parts.any?(&:empty?)
359         return
360       elsif not local_parts.first.empty?
361         requested = local_parts.first
362       else
363         requested = email_parts.first
364       end
365     end
366     requested.sub!(/^[^A-Za-z]+/, "")
367     requested.gsub!(/[^A-Za-z0-9]/, "")
368     unless requested.empty?
369       self.username = find_usable_username_from(requested)
370     end
371   end
372
373   # Move this user's (i.e., self's) owned items to new_owner_uuid and
374   # new_user_uuid (for things normally owned directly by the user).
375   #
376   # If redirect_auth is true, also reassign auth tokens and ssh keys,
377   # and redirect this account to redirect_to_user_uuid, i.e., when a
378   # caller authenticates to this account in the future, the account
379   # redirect_to_user_uuid account will be used instead.
380   #
381   # current_user must have admin privileges, i.e., the caller is
382   # responsible for checking permission to do this.
383   def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
384     raise PermissionDeniedError if !current_user.andand.is_admin
385     raise "Missing new_owner_uuid" if !new_owner_uuid
386     raise "Missing new_user_uuid" if !new_user_uuid
387     transaction(requires_new: true) do
388       reload
389       raise "cannot merge an already merged user" if self.redirect_to_user_uuid
390
391       new_user = User.where(uuid: new_user_uuid).first
392       raise "user does not exist" if !new_user
393       raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
394
395       self.clear_permissions
396       new_user.clear_permissions
397
398       # If 'self' is a remote user, don't transfer authorizations
399       # (i.e. ability to access the account) to the new user, because
400       # that gives the remote site the ability to access the 'new'
401       # user account that takes over the 'self' account.
402       #
403       # If 'self' is a local user, it is okay to transfer
404       # authorizations, even if the 'new' user is a remote account,
405       # because the remote site does not gain the ability to access an
406       # account it could not before.
407
408       if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
409         # Existing API tokens and ssh keys are updated to authenticate
410         # to the new user.
411         ApiClientAuthorization.
412           where(user_id: id).
413           update_all(user_id: new_user.id)
414
415         user_updates = [
416           [AuthorizedKey, :owner_uuid],
417           [AuthorizedKey, :authorized_user_uuid],
418           [Link, :owner_uuid],
419           [Link, :tail_uuid],
420           [Link, :head_uuid],
421         ]
422       else
423         # Destroy API tokens and ssh keys associated with the old
424         # user.
425         ApiClientAuthorization.where(user_id: id).destroy_all
426         AuthorizedKey.where(owner_uuid: uuid).destroy_all
427         AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
428         user_updates = [
429           [Link, :owner_uuid],
430           [Link, :tail_uuid]
431         ]
432       end
433
434       # References to the old user UUID in the context of a user ID
435       # (rather than a "home project" in the project hierarchy) are
436       # updated to point to the new user.
437       user_updates.each do |klass, column|
438         klass.where(column => uuid).update_all(column => new_user.uuid)
439       end
440
441       # Need to update repository names to new username
442       if username
443         old_repo_name_re = /^#{Regexp.escape(username)}\//
444         Repository.where(:owner_uuid => uuid).each do |repo|
445           repo.owner_uuid = new_user.uuid
446           repo_name_sub = "#{new_user.username}/"
447           name = repo.name.sub(old_repo_name_re, repo_name_sub)
448           while (conflict = Repository.where(:name => name).first) != nil
449             repo_name_sub += "migrated"
450             name = repo.name.sub(old_repo_name_re, repo_name_sub)
451           end
452           repo.name = name
453           repo.save!
454         end
455       end
456
457       # References to the merged user's "home project" are updated to
458       # point to new_owner_uuid.
459       ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
460         next if [ApiClientAuthorization,
461                  AuthorizedKey,
462                  Link,
463                  Log,
464                  Repository].include?(klass)
465         next if !klass.columns.collect(&:name).include?('owner_uuid')
466         klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
467       end
468
469       if redirect_to_new_user
470         update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
471       end
472       skip_check_permissions_against_full_refresh do
473         update_permissions self.uuid, self.uuid, CAN_MANAGE_PERM
474         update_permissions new_user.uuid, new_user.uuid, CAN_MANAGE_PERM
475         update_permissions new_user.owner_uuid, new_user.uuid, CAN_MANAGE_PERM
476       end
477       update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
478     end
479   end
480
481   def redirects_to
482     user = self
483     redirects = 0
484     while (uuid = user.redirect_to_user_uuid)
485       break if uuid.empty?
486       nextuser = User.unscoped.find_by_uuid(uuid)
487       if !nextuser
488         raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
489       end
490       user = nextuser
491       redirects += 1
492       if redirects > 15
493         raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
494       end
495     end
496     user
497   end
498
499   def self.register info
500     # login info expected fields, all can be optional but at minimum
501     # must supply either 'identity_url' or 'email'
502     #
503     #   email
504     #   first_name
505     #   last_name
506     #   username
507     #   alternate_emails
508     #   identity_url
509
510     primary_user = nil
511
512     # local database
513     identity_url = info['identity_url']
514
515     if identity_url && identity_url.length > 0
516       # Only local users can create sessions, hence uuid_like_pattern
517       # here.
518       user = User.unscoped.where('identity_url = ? and uuid like ?',
519                                  identity_url,
520                                  User.uuid_like_pattern).first
521       primary_user = user.redirects_to if user
522     end
523
524     if !primary_user
525       # identity url is unset or didn't find matching record.
526       emails = [info['email']] + (info['alternate_emails'] || [])
527       emails.select! {|em| !em.nil? && !em.empty?}
528
529       User.unscoped.where('email in (?) and uuid like ?',
530                           emails,
531                           User.uuid_like_pattern).each do |user|
532         if !primary_user
533           primary_user = user.redirects_to
534         elsif primary_user.uuid != user.redirects_to.uuid
535           raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
536         end
537       end
538     end
539
540     if !primary_user
541       # New user registration
542       primary_user = User.new(:owner_uuid => system_user_uuid,
543                               :is_admin => false,
544                               :is_active => Rails.configuration.Users.NewUsersAreActive)
545
546       primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
547       primary_user.identity_url = info['identity_url'] if identity_url
548     end
549
550     primary_user.email = info['email'] if info['email']
551     primary_user.first_name = info['first_name'] if info['first_name']
552     primary_user.last_name = info['last_name'] if info['last_name']
553
554     if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
555       raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
556     end
557
558     act_as_system_user do
559       primary_user.save!
560     end
561
562     primary_user
563   end
564
565   protected
566
567   def change_all_uuid_refs(old_uuid:, new_uuid:)
568     ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
569       klass.columns.each do |col|
570         if col.name.end_with?('_uuid')
571           column = col.name.to_sym
572           klass.where(column => old_uuid).update_all(column => new_uuid)
573         end
574       end
575     end
576   end
577
578   def ensure_ownership_path_leads_to_user
579     true
580   end
581
582   def permission_to_update
583     if username_changed? || redirect_to_user_uuid_changed? || email_changed?
584       current_user.andand.is_admin
585     else
586       # users must be able to update themselves (even if they are
587       # inactive) in order to create sessions
588       self == current_user or super
589     end
590   end
591
592   def permission_to_create
593     current_user.andand.is_admin or
594       (self == current_user &&
595        self.redirect_to_user_uuid.nil? &&
596        self.is_active == Rails.configuration.Users.NewUsersAreActive)
597   end
598
599   def check_auto_admin
600     return if self.uuid.end_with?('anonymouspublic')
601     if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
602         !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
603        (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
604         Rails.configuration.Users.AutoAdminFirstUser)
605       self.is_admin = true
606       self.is_active = true
607     end
608   end
609
610   def find_usable_username_from(basename)
611     # If "basename" is a usable username, return that.
612     # Otherwise, find a unique username "basenameN", where N is the
613     # smallest integer greater than 1, and return that.
614     # Return nil if a unique username can't be found after reasonable
615     # searching.
616     quoted_name = self.class.connection.quote_string(basename)
617     next_username = basename
618     next_suffix = 1
619     while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
620       next_suffix += 1
621       next_username = "%s%i" % [basename, next_suffix]
622     end
623     0.upto(6).each do |suffix_len|
624       pattern = "%s%s" % [quoted_name, "_" * suffix_len]
625       self.class.unscoped.
626           where("username like '#{pattern}'").
627           select(:username).
628           order('username asc').
629           each do |other_user|
630         if other_user.username > next_username
631           break
632         elsif other_user.username == next_username
633           next_suffix += 1
634           next_username = "%s%i" % [basename, next_suffix]
635         end
636       end
637       return next_username if (next_username.size <= pattern.size)
638     end
639     nil
640   end
641
642   def prevent_privilege_escalation
643     if current_user.andand.is_admin
644       return true
645     end
646     if self.is_active_changed?
647       if self.is_active != self.is_active_was
648         logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
649         self.is_active = self.is_active_was
650       end
651     end
652     if self.is_admin_changed?
653       if self.is_admin != self.is_admin_was
654         logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
655         self.is_admin = self.is_admin_was
656       end
657     end
658     true
659   end
660
661   def prevent_inactive_admin
662     if self.is_admin and not self.is_active
663       # There is no known use case for the strange set of permissions
664       # that would result from this change. It's safest to assume it's
665       # a mistake and disallow it outright.
666       raise "Admin users cannot be inactive"
667     end
668     true
669   end
670
671   def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
672     nextpaths = graph[start]
673     return merged if !nextpaths
674     return merged if upstream_path.has_key? start
675     upstream_path[start] = true
676     upstream_mask ||= ALL_PERMISSIONS
677     nextpaths.each do |head, mask|
678       merged[head] ||= {}
679       mask.each do |k,v|
680         merged[head][k] ||= v if upstream_mask[k]
681       end
682       search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
683     end
684     upstream_path.delete start
685     merged
686   end
687
688   def create_user_repo_link(repo_name)
689     # repo_name is optional
690     if not repo_name
691       logger.warn ("Repository name not given for #{self.uuid}.")
692       return
693     end
694
695     repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
696     logger.info { "repo uuid: " + repo[:uuid] }
697     repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
698                            link_class: "permission",
699                            name: "can_manage").first_or_create!
700     logger.info { "repo permission: " + repo_perm[:uuid] }
701     return repo_perm
702   end
703
704   # create login permission for the given vm_uuid, if it does not already exist
705   def create_vm_login_permission_link(vm_uuid, repo_name)
706     # vm uuid is optional
707     return if vm_uuid == ""
708
709     vm = VirtualMachine.where(uuid: vm_uuid).first
710     if !vm
711       logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
712       raise "No vm found for #{vm_uuid}"
713     end
714
715     logger.info { "vm uuid: " + vm[:uuid] }
716     login_attrs = {
717       tail_uuid: uuid, head_uuid: vm.uuid,
718       link_class: "permission", name: "can_login",
719     }
720
721     login_perm = Link.
722       where(login_attrs).
723       select { |link| link.properties["username"] == repo_name }.
724       first
725
726     login_perm ||= Link.
727       create(login_attrs.merge(properties: {"username" => repo_name}))
728
729     logger.info { "login permission: " + login_perm[:uuid] }
730     login_perm
731   end
732
733   def add_to_all_users_group
734     resp = [Link.where(tail_uuid: self.uuid,
735                        head_uuid: all_users_group_uuid,
736                        link_class: 'permission',
737                        name: 'can_read').first ||
738             Link.create(tail_uuid: self.uuid,
739                         head_uuid: all_users_group_uuid,
740                         link_class: 'permission',
741                         name: 'can_read')]
742     if Rails.configuration.Users.ActivatedUsersAreVisibleToOthers
743       resp += [Link.where(tail_uuid: all_users_group_uuid,
744                           head_uuid: self.uuid,
745                           link_class: 'permission',
746                           name: 'can_read').first ||
747                Link.create(tail_uuid: all_users_group_uuid,
748                            head_uuid: self.uuid,
749                            link_class: 'permission',
750                            name: 'can_read')]
751     end
752     return resp
753   end
754
755   # Give the special "System group" permission to manage this user and
756   # all of this user's stuff.
757   def add_system_group_permission_link
758     return true if uuid == system_user_uuid
759     act_as_system_user do
760       Link.create(link_class: 'permission',
761                   name: 'can_manage',
762                   tail_uuid: system_group_uuid,
763                   head_uuid: self.uuid)
764     end
765   end
766
767   # Send admin notifications
768   def send_admin_notifications
769     AdminNotifier.new_user(self).deliver_now
770     if not self.is_active then
771       AdminNotifier.new_inactive_user(self).deliver_now
772     end
773   end
774
775   # Automatically setup if is_active flag turns on
776   def setup_on_activate
777     return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
778     if is_active &&
779       (new_record? || saved_change_to_is_active? || will_save_change_to_is_active?)
780       setup
781     end
782   end
783
784   # Automatically setup new user during creation
785   def auto_setup_new_user
786     setup
787   end
788
789   # Send notification if the user saved profile for the first time
790   def send_profile_created_notification
791     if saved_change_to_prefs?
792       if prefs_before_last_save.andand.empty? || !prefs_before_last_save.andand['profile']
793         profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
794         ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
795       end
796     end
797   end
798
799   def verify_repositories_empty
800     unless repositories.first.nil?
801       errors.add(:username, "can't be unset when the user owns repositories")
802       throw(:abort)
803     end
804   end
805
806   def sync_repository_names
807     old_name_re = /^#{Regexp.escape(username_before_last_save)}\//
808     name_sub = "#{username}/"
809     repositories.find_each do |repo|
810       repo.name = repo.name.sub(old_name_re, name_sub)
811       repo.save!
812     end
813   end
814
815   def identity_url_nil_if_empty
816     if identity_url == ""
817       self.identity_url = nil
818     end
819   end
820 end