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 AlreadyLockedError < StandardError
45 class UnauthorizedError < StandardError
51 def self.kind_class(kind)
52 kind.match(/^arvados\#(.+)$/)[1].classify.safe_constantize rescue nil
56 "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}"
59 def self.searchable_columns operator
60 textonly_operator = !operator.match(/[<=>]/)
61 self.columns.select do |col|
65 when :datetime, :integer, :boolean
73 def self.attribute_column attr
74 self.columns.select { |col| col.name == attr.to_s }.first
77 def self.attributes_required_columns
78 # This method returns a hash. Each key is the name of an API attribute,
79 # and it's mapped to a list of database columns that must be fetched
80 # to generate that attribute.
81 # This implementation generates a simple map of attributes to
82 # matching column names. Subclasses can override this method
83 # to specify that method-backed API attributes need to fetch
84 # specific columns from the database.
85 all_columns = columns.map(&:name)
86 api_column_map = Hash.new { |hash, key| hash[key] = [] }
87 methods.grep(/^api_accessible_\w+$/).each do |method_name|
88 next if method_name == :api_accessible_attributes
89 send(method_name).each_pair do |api_attr_name, col_name|
90 col_name = col_name.to_s
91 if all_columns.include?(col_name)
92 api_column_map[api_attr_name.to_s] |= [col_name]
99 # If current user can manage the object, return an array of uuids of
100 # users and groups that have permission to write the object. The
101 # first two elements are always [self.owner_uuid, current user's
104 # If current user can write but not manage the object, return
105 # [self.owner_uuid, current user's uuid].
107 # If current user cannot write this object, just return
110 unless (owner_uuid == current_user.uuid or
111 current_user.is_admin or
112 (current_user.groups_i_can(:manage) & [uuid, owner_uuid]).any?)
113 if current_user.groups_i_can(:write).index(uuid)
114 return [owner_uuid, current_user.uuid]
119 [owner_uuid, current_user.uuid] + permissions.collect do |p|
120 if ['can_write', 'can_manage'].index p.name
126 # Return a query with read permissions restricted to the union of of the
127 # permissions of the members of users_list, i.e. if something is readable by
128 # any user in users_list, it will be readable in the query returned by this
130 def self.readable_by(*users_list)
131 # Get rid of troublesome nils
134 # Load optional keyword arguments, if they exist.
135 if users_list.last.is_a? Hash
136 kwargs = users_list.pop
141 # Check if any of the users are admin. If so, we're done.
142 if users_list.select { |u| u.is_admin }.any?
146 # Collect the uuids for each user and any groups readable by each user.
147 user_uuids = users_list.map { |u| u.uuid }
148 uuid_list = user_uuids + users_list.flat_map { |u| u.groups_i_can(:read) }
151 sql_table = kwargs.fetch(:table_name, table_name)
154 # This row is owned by a member of users_list, or owned by a group
155 # readable by a member of users_list
157 # This row uuid is the uuid of a member of users_list
159 # A permission link exists ('write' and 'manage' implicitly include
160 # 'read') from a member of users_list, or a group readable by users_list,
161 # to this row, or to the owner of this row (see join() below).
162 sql_conds += ["#{sql_table}.uuid in (?)"]
163 sql_params += [user_uuids]
166 sql_conds += ["#{sql_table}.owner_uuid in (?)"]
167 sql_params += [uuid_list]
169 sanitized_uuid_list = uuid_list.
170 collect { |uuid| sanitize(uuid) }.join(', ')
171 permitted_uuids = "(SELECT head_uuid FROM links WHERE link_class='permission' AND tail_uuid IN (#{sanitized_uuid_list}))"
172 sql_conds += ["#{sql_table}.uuid IN #{permitted_uuids}"]
175 if sql_table == "links" and users_list.any?
176 # This row is a 'permission' or 'resources' link class
177 # The uuid for a member of users_list is referenced in either the head
178 # or tail of the link
179 sql_conds += ["(#{sql_table}.link_class in (#{sanitize 'permission'}, #{sanitize 'resources'}) AND (#{sql_table}.head_uuid IN (?) OR #{sql_table}.tail_uuid IN (?)))"]
180 sql_params += [user_uuids, user_uuids]
183 if sql_table == "logs" and users_list.any?
184 # Link head points to the object described by this row
185 sql_conds += ["#{sql_table}.object_uuid IN #{permitted_uuids}"]
187 # This object described by this row is owned by this user, or owned by a group readable by this user
188 sql_conds += ["#{sql_table}.object_owner_uuid in (?)"]
189 sql_params += [uuid_list]
192 # Link head points to this row, or to the owner of this row (the
195 # Link tail originates from this user, or a group that is readable
196 # by this user (the identity with authorization to read)
198 # Link class is 'permission' ('write' and 'manage' implicitly
200 where(sql_conds.join(' OR '), *sql_params)
203 def logged_attributes
209 def ensure_ownership_path_leads_to_user
210 if new_record? or owner_uuid_changed?
211 uuid_in_path = {owner_uuid => true, uuid => true}
213 while (owner_class = ArvadosModel::resource_class_for_uuid(x)) != User
216 # Test for cycles with the new version, not the DB contents
218 elsif !owner_class.respond_to? :find_by_uuid
219 raise ActiveRecord::RecordNotFound.new
221 x = owner_class.find_by_uuid(x).owner_uuid
223 rescue ActiveRecord::RecordNotFound => e
224 errors.add :owner_uuid, "is not owned by any user: #{e}"
229 errors.add :owner_uuid, "would create an ownership cycle"
231 errors.add :owner_uuid, "has an ownership cycle"
235 uuid_in_path[x] = true
241 def ensure_owner_uuid_is_permitted
242 raise PermissionDeniedError if !current_user
244 if new_record? and respond_to? :owner_uuid=
245 self.owner_uuid ||= current_user.uuid
248 if self.owner_uuid.nil?
249 errors.add :owner_uuid, "cannot be nil"
250 raise PermissionDeniedError
253 rsc_class = ArvadosModel::resource_class_for_uuid owner_uuid
254 unless rsc_class == User or rsc_class == Group
255 errors.add :owner_uuid, "must be set to User or Group"
256 raise PermissionDeniedError
259 # Verify "write" permission on old owner
260 # default fail unless one of:
261 # owner_uuid did not change
262 # previous owner_uuid is nil
263 # current user is the old owner
264 # current user is this object
265 # current user can_write old owner
266 unless !owner_uuid_changed? or
267 owner_uuid_was.nil? or
268 current_user.uuid == self.owner_uuid_was or
269 current_user.uuid == self.uuid or
270 current_user.can? write: self.owner_uuid_was
271 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}"
272 errors.add :owner_uuid, "cannot be changed without write permission on old owner"
273 raise PermissionDeniedError
276 # Verify "write" permission on new owner
277 # default fail unless one of:
278 # current_user is this object
279 # current user can_write new owner
280 unless current_user == self or current_user.can? write: owner_uuid
281 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}"
282 errors.add :owner_uuid, "cannot be changed without write permission on new owner"
283 raise PermissionDeniedError
289 def ensure_permission_to_save
290 unless (new_record? ? permission_to_create : permission_to_update)
291 raise PermissionDeniedError
295 def permission_to_create
296 current_user.andand.is_active
299 def permission_to_update
301 logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
304 if !current_user.is_active
305 logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
308 return true if current_user.is_admin
309 if self.uuid_changed?
310 logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
316 def ensure_permission_to_destroy
317 raise PermissionDeniedError unless permission_to_destroy
320 def permission_to_destroy
324 def maybe_update_modified_by_fields
325 update_modified_by_fields if self.changed? or self.new_record?
329 def update_modified_by_fields
330 self.updated_at = Time.now
331 self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid=
332 self.modified_at = Time.now
333 self.modified_by_user_uuid = current_user ? current_user.uuid : nil
334 self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
338 def self.has_symbols? x
341 return true if has_symbols?(k) or has_symbols?(v)
346 return true if has_symbols?(k)
354 def self.recursive_stringify x
356 Hash[x.collect do |k,v|
357 [recursive_stringify(k), recursive_stringify(v)]
361 recursive_stringify k
370 def ensure_serialized_attribute_type
371 # Specifying a type in the "serialize" declaration causes rails to
372 # raise an exception if a different data type is retrieved from
373 # the database during load(). The validation preventing such
374 # crash-inducing records from being inserted in the database in
375 # the first place seems to have been left as an exercise to the
377 self.class.serialized_attributes.each do |colname, attr|
379 if self.attributes[colname].class != attr.object_class
380 self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}, not a #{self.attributes[colname].class.to_s}"
381 elsif self.class.has_symbols? attributes[colname]
382 self.errors.add colname.to_sym, "must not contain symbols: #{attributes[colname].inspect}"
388 def convert_serialized_symbols_to_strings
389 # ensure_serialized_attribute_type should prevent symbols from
390 # getting into the database in the first place. If someone managed
391 # to get them into the database (perhaps using an older version)
392 # we'll convert symbols to strings when loading from the
393 # database. (Otherwise, loading and saving an object with existing
394 # symbols in a serialized field will crash.)
395 self.class.serialized_attributes.each do |colname, attr|
396 if self.class.has_symbols? attributes[colname]
397 attributes[colname] = self.class.recursive_stringify attributes[colname]
398 self.send(colname + '=',
399 self.class.recursive_stringify(attributes[colname]))
404 def foreign_key_attributes
405 attributes.keys.select { |a| a.match /_uuid$/ }
408 def skip_uuid_read_permission_check
409 %w(modified_by_client_uuid)
412 def skip_uuid_existence_check
416 def normalize_collection_uuids
417 foreign_key_attributes.each do |attr|
418 attr_value = send attr
419 if attr_value.is_a? String and
420 attr_value.match /^[0-9a-f]{32,}(\+[@\w]+)*$/
422 send "#{attr}=", Collection.normalize_uuid(attr_value)
424 # TODO: abort instead of silently accepting unnormalizable value?
430 @@prefixes_hash = nil
431 def self.uuid_prefixes
432 unless @@prefixes_hash
434 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
435 if k.respond_to?(:uuid_prefix)
436 @@prefixes_hash[k.uuid_prefix] = k
443 def self.uuid_like_pattern
444 "_____-#{uuid_prefix}-_______________"
447 def ensure_valid_uuids
448 specials = [system_user_uuid]
450 foreign_key_attributes.each do |attr|
451 if new_record? or send (attr + "_changed?")
452 next if skip_uuid_existence_check.include? attr
453 attr_value = send attr
454 next if specials.include? attr_value
456 if (r = ArvadosModel::resource_class_for_uuid attr_value)
457 unless skip_uuid_read_permission_check.include? attr
458 r = r.readable_by(current_user)
460 if r.where(uuid: attr_value).count == 0
461 errors.add(attr, "'#{attr_value}' not found")
478 def self.readable_by (*u)
483 [{:uuid => u[:uuid]}]
487 def self.resource_class_for_uuid(uuid)
488 if uuid.is_a? ArvadosModel
491 unless uuid.is_a? String
496 Rails.application.eager_load!
497 uuid.match HasUuid::UUID_REGEX do |re|
498 return uuid_prefixes[re[1]] if uuid_prefixes[re[1]]
501 if uuid.match /.+@.+/
508 # ArvadosModel.find_by_uuid needs extra magic to allow it to return
509 # an object in any class.
510 def self.find_by_uuid uuid
511 if self == ArvadosModel
512 # If called directly as ArvadosModel.find_by_uuid rather than via subclass,
513 # delegate to the appropriate subclass based on the given uuid.
514 self.resource_class_for_uuid(uuid).find_by_uuid(uuid)
522 @old_attributes = logged_attributes
525 def log_change(event_type)
526 log = Log.new(event_type: event_type).fill_object(self)
529 connection.execute "NOTIFY logs, '#{log.id}'"
534 log_change('create') do |log|
535 log.fill_properties('old', nil, nil)
541 log_change('update') do |log|
542 log.fill_properties('old', @old_etag, @old_attributes)
548 log_change('destroy') do |log|
549 log.fill_properties('old', @old_etag, @old_attributes)