3 class ArvadosModel < ActiveRecord::Base
4 self.abstract_class = true
6 include CurrentApiClient # current_user, current_api_client, etc.
8 attr_protected :created_at
9 attr_protected :modified_by_user_uuid
10 attr_protected :modified_by_client_uuid
11 attr_protected :modified_at
12 after_initialize :log_start_state
13 before_save :ensure_permission_to_save
14 before_save :ensure_owner_uuid_is_permitted
15 before_save :ensure_ownership_path_leads_to_user
16 before_destroy :ensure_owner_uuid_is_permitted
17 before_destroy :ensure_permission_to_destroy
18 before_create :update_modified_by_fields
19 before_update :maybe_update_modified_by_fields
20 after_create :log_create
21 after_update :log_update
22 after_destroy :log_destroy
23 after_find :convert_serialized_symbols_to_strings
24 before_validation :normalize_collection_uuids
25 validate :ensure_serialized_attribute_type
26 validate :ensure_valid_uuids
28 # Note: This only returns permission links. It does not account for
29 # permissions obtained via user.is_admin or
30 # user.uuid==object.owner_uuid.
31 has_many :permissions, :foreign_key => :head_uuid, :class_name => 'Link', :primary_key => :uuid, :conditions => "link_class = 'permission'"
33 class PermissionDeniedError < StandardError
39 class UnauthorizedError < StandardError
45 def self.kind_class(kind)
46 kind.match(/^arvados\#(.+)$/)[1].classify.safe_constantize rescue nil
50 "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}"
53 def self.searchable_columns operator
54 textonly_operator = !operator.match(/[<=>]/)
55 self.columns.select do |col|
59 when :datetime, :integer, :boolean
67 def self.attribute_column attr
68 self.columns.select { |col| col.name == attr.to_s }.first
71 # Return nil if current user is not allowed to see the list of
72 # writers. Otherwise, return a list of user_ and group_uuids with
73 # write permission. (If not returning nil, current_user is always in
74 # the list because can_manage permission is needed to see the list
77 unless (owner_uuid == current_user.uuid or
78 current_user.is_admin or
79 current_user.groups_i_can(:manage).index(owner_uuid))
82 [owner_uuid, current_user.uuid] + permissions.collect do |p|
83 if ['can_write', 'can_manage'].index p.name
89 # Return a query with read permissions restricted to the union of of the
90 # permissions of the members of users_list, i.e. if something is readable by
91 # any user in users_list, it will be readable in the query returned by this
93 def self.readable_by(*users_list)
94 # Get rid of troublesome nils
97 # Load optional keyword arguments, if they exist.
98 if users_list.last.is_a? Hash
99 kwargs = users_list.pop
104 # Check if any of the users are admin. If so, we're done.
105 if users_list.select { |u| u.is_admin }.empty?
107 # Collect the uuids for each user and any groups readable by each user.
108 user_uuids = users_list.map { |u| u.uuid }
109 uuid_list = user_uuids + users_list.flat_map { |u| u.groups_i_can(:read) }
110 sanitized_uuid_list = uuid_list.
111 collect { |uuid| sanitize(uuid) }.join(', ')
114 sql_table = kwargs.fetch(:table_name, table_name)
117 # This row is owned by a member of users_list, or owned by a group
118 # readable by a member of users_list
120 # This row uuid is the uuid of a member of users_list
122 # A permission link exists ('write' and 'manage' implicitly include
123 # 'read') from a member of users_list, or a group readable by users_list,
124 # to this row, or to the owner of this row (see join() below).
125 permitted_uuids = "(SELECT head_uuid FROM links WHERE link_class='permission' AND tail_uuid IN (#{sanitized_uuid_list}))"
127 sql_conds += ["#{sql_table}.owner_uuid in (?)",
128 "#{sql_table}.uuid in (?)",
129 "#{sql_table}.uuid IN #{permitted_uuids}"]
130 sql_params += [uuid_list, user_uuids]
132 if sql_table == "links" and users_list.any?
133 # This row is a 'permission' or 'resources' link class
134 # The uuid for a member of users_list is referenced in either the head
135 # or tail of the link
136 sql_conds += ["(#{sql_table}.link_class in (#{sanitize 'permission'}, #{sanitize 'resources'}) AND (#{sql_table}.head_uuid IN (?) OR #{sql_table}.tail_uuid IN (?)))"]
137 sql_params += [user_uuids, user_uuids]
140 if sql_table == "logs" and users_list.any?
141 # Link head points to the object described by this row
142 sql_conds += ["#{sql_table}.object_uuid IN #{permitted_uuids}"]
144 # This object described by this row is owned by this user, or owned by a group readable by this user
145 sql_conds += ["#{sql_table}.object_owner_uuid in (?)"]
146 sql_params += [uuid_list]
149 # Link head points to this row, or to the owner of this row (the thing to be read)
151 # Link tail originates from this user, or a group that is readable by this
152 # user (the identity with authorization to read)
154 # Link class is 'permission' ('write' and 'manage' implicitly include 'read')
155 where(sql_conds.join(' OR '), *sql_params)
157 # At least one user is admin, so don't bother to apply any restrictions.
162 def logged_attributes
166 def has_permission? perm_type, target_uuid
167 Link.where(link_class: "permission",
170 head_uuid: target_uuid).any?
175 def ensure_ownership_path_leads_to_user
176 if new_record? or owner_uuid_changed?
177 uuid_in_path = {owner_uuid => true, uuid => true}
179 while (owner_class = ArvadosModel::resource_class_for_uuid(x)) != User
182 # Test for cycles with the new version, not the DB contents
184 elsif !owner_class.respond_to? :find_by_uuid
185 raise ActiveRecord::RecordNotFound.new
187 x = owner_class.find_by_uuid(x).owner_uuid
189 rescue ActiveRecord::RecordNotFound => e
190 errors.add :owner_uuid, "is not owned by any user: #{e}"
195 errors.add :owner_uuid, "would create an ownership cycle"
197 errors.add :owner_uuid, "has an ownership cycle"
201 uuid_in_path[x] = true
207 def ensure_owner_uuid_is_permitted
208 raise PermissionDeniedError if !current_user
210 if new_record? and respond_to? :owner_uuid=
211 self.owner_uuid ||= current_user.uuid
214 if self.owner_uuid.nil?
215 errors.add :owner_uuid, "cannot be nil"
216 raise PermissionDeniedError
219 rsc_class = ArvadosModel::resource_class_for_uuid owner_uuid
220 unless rsc_class == User or rsc_class == Group
221 errors.add :owner_uuid, "can only be set to User or Group"
222 raise PermissionDeniedError
225 # Verify "write" permission on old owner
226 # default fail unless one of:
227 # owner_uuid did not change
228 # previous owner_uuid is nil
229 # current user is the old owner
230 # current user is this object
231 # current user can_write old owner
232 unless !owner_uuid_changed? or
233 owner_uuid_was.nil? or
234 current_user.uuid == self.owner_uuid_was or
235 current_user.uuid == self.uuid or
236 current_user.can? write: self.owner_uuid_was
237 logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{uuid} but does not have permission to write old owner_uuid #{owner_uuid_was}"
238 errors.add :owner_uuid, "cannot be changed without write permission on old owner"
239 raise PermissionDeniedError
242 # Verify "write" permission on new owner
243 # default fail unless one of:
244 # current_user is this object
245 # current user can_write new owner
246 unless current_user == self or current_user.can? write: owner_uuid
247 logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{uuid} but does not have permission to write new owner_uuid #{owner_uuid}"
248 errors.add :owner_uuid, "cannot be changed without write permission on new owner"
249 raise PermissionDeniedError
255 def ensure_permission_to_save
256 unless (new_record? ? permission_to_create : permission_to_update)
257 raise PermissionDeniedError
261 def permission_to_create
262 current_user.andand.is_active
265 def permission_to_update
267 logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
270 if !current_user.is_active
271 logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
274 return true if current_user.is_admin
275 if self.uuid_changed?
276 logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
282 def ensure_permission_to_destroy
283 raise PermissionDeniedError unless permission_to_destroy
286 def permission_to_destroy
290 def maybe_update_modified_by_fields
291 update_modified_by_fields if self.changed? or self.new_record?
295 def update_modified_by_fields
296 self.updated_at = Time.now
297 self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid=
298 self.modified_at = Time.now
299 self.modified_by_user_uuid = current_user ? current_user.uuid : nil
300 self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
304 def self.has_symbols? x
307 return true if has_symbols?(k) or has_symbols?(v)
312 return true if has_symbols?(k)
320 def self.recursive_stringify x
322 Hash[x.collect do |k,v|
323 [recursive_stringify(k), recursive_stringify(v)]
327 recursive_stringify k
336 def ensure_serialized_attribute_type
337 # Specifying a type in the "serialize" declaration causes rails to
338 # raise an exception if a different data type is retrieved from
339 # the database during load(). The validation preventing such
340 # crash-inducing records from being inserted in the database in
341 # the first place seems to have been left as an exercise to the
343 self.class.serialized_attributes.each do |colname, attr|
345 if self.attributes[colname].class != attr.object_class
346 self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}, not a #{self.attributes[colname].class.to_s}"
347 elsif self.class.has_symbols? attributes[colname]
348 self.errors.add colname.to_sym, "must not contain symbols: #{attributes[colname].inspect}"
354 def convert_serialized_symbols_to_strings
355 # ensure_serialized_attribute_type should prevent symbols from
356 # getting into the database in the first place. If someone managed
357 # to get them into the database (perhaps using an older version)
358 # we'll convert symbols to strings when loading from the
359 # database. (Otherwise, loading and saving an object with existing
360 # symbols in a serialized field will crash.)
361 self.class.serialized_attributes.each do |colname, attr|
362 if self.class.has_symbols? attributes[colname]
363 attributes[colname] = self.class.recursive_stringify attributes[colname]
364 self.send(colname + '=',
365 self.class.recursive_stringify(attributes[colname]))
370 def foreign_key_attributes
371 attributes.keys.select { |a| a.match /_uuid$/ }
374 def skip_uuid_read_permission_check
375 %w(modified_by_client_uuid)
378 def skip_uuid_existence_check
382 def normalize_collection_uuids
383 foreign_key_attributes.each do |attr|
384 attr_value = send attr
385 if attr_value.is_a? String and
386 attr_value.match /^[0-9a-f]{32,}(\+[@\w]+)*$/
388 send "#{attr}=", Collection.normalize_uuid(attr_value)
390 # TODO: abort instead of silently accepting unnormalizable value?
396 @@prefixes_hash = nil
397 def self.uuid_prefixes
398 unless @@prefixes_hash
400 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
401 if k.respond_to?(:uuid_prefix)
402 @@prefixes_hash[k.uuid_prefix] = k
409 def self.uuid_like_pattern
410 "_____-#{uuid_prefix}-_______________"
413 def ensure_valid_uuids
414 specials = [system_user_uuid]
416 foreign_key_attributes.each do |attr|
417 if new_record? or send (attr + "_changed?")
418 next if skip_uuid_existence_check.include? attr
419 attr_value = send attr
420 next if specials.include? attr_value
422 if (r = ArvadosModel::resource_class_for_uuid attr_value)
423 unless skip_uuid_read_permission_check.include? attr
424 r = r.readable_by(current_user)
426 if r.where(uuid: attr_value).count == 0
427 errors.add(attr, "'#{attr_value}' not found")
444 def self.readable_by (*u)
449 [{:uuid => u[:uuid]}]
453 def self.resource_class_for_uuid(uuid)
454 if uuid.is_a? ArvadosModel
457 unless uuid.is_a? String
462 Rails.application.eager_load!
463 uuid.match HasUuid::UUID_REGEX do |re|
464 return uuid_prefixes[re[1]] if uuid_prefixes[re[1]]
467 if uuid.match /.+@.+/
474 # ArvadosModel.find_by_uuid needs extra magic to allow it to return
475 # an object in any class.
476 def self.find_by_uuid uuid
477 if self == ArvadosModel
478 # If called directly as ArvadosModel.find_by_uuid rather than via subclass,
479 # delegate to the appropriate subclass based on the given uuid.
480 self.resource_class_for_uuid(uuid).find_by_uuid(uuid)
488 @old_attributes = logged_attributes
491 def log_change(event_type)
492 log = Log.new(event_type: event_type).fill_object(self)
495 connection.execute "NOTIFY logs, '#{log.id}'"
500 log_change('create') do |log|
501 log.fill_properties('old', nil, nil)
507 log_change('update') do |log|
508 log.fill_properties('old', @old_etag, @old_attributes)
514 log_change('destroy') do |log|
515 log.fill_properties('old', @old_etag, @old_attributes)