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 return [owner_uuid] if not current_user
111 unless (owner_uuid == current_user.uuid or
112 current_user.is_admin or
113 (current_user.groups_i_can(:manage) & [uuid, owner_uuid]).any?)
114 if ((current_user.groups_i_can(:write) + [current_user.uuid]) &
115 [uuid, owner_uuid]).any?
116 return [owner_uuid, current_user.uuid]
121 [owner_uuid, current_user.uuid] + permissions.collect do |p|
122 if ['can_write', 'can_manage'].index p.name
128 # Return a query with read permissions restricted to the union of of the
129 # permissions of the members of users_list, i.e. if something is readable by
130 # any user in users_list, it will be readable in the query returned by this
132 def self.readable_by(*users_list)
133 # Get rid of troublesome nils
136 # Load optional keyword arguments, if they exist.
137 if users_list.last.is_a? Hash
138 kwargs = users_list.pop
143 # Check if any of the users are admin. If so, we're done.
144 if users_list.select { |u| u.is_admin }.any?
148 # Collect the uuids for each user and any groups readable by each user.
149 user_uuids = users_list.map { |u| u.uuid }
150 uuid_list = user_uuids + users_list.flat_map { |u| u.groups_i_can(:read) }
153 sql_table = kwargs.fetch(:table_name, table_name)
156 # This row is owned by a member of users_list, or owned by a group
157 # readable by a member of users_list
159 # This row uuid is the uuid of a member of users_list
161 # A permission link exists ('write' and 'manage' implicitly include
162 # 'read') from a member of users_list, or a group readable by users_list,
163 # to this row, or to the owner of this row (see join() below).
164 sql_conds += ["#{sql_table}.uuid in (?)"]
165 sql_params += [user_uuids]
168 sql_conds += ["#{sql_table}.owner_uuid in (?)"]
169 sql_params += [uuid_list]
171 sanitized_uuid_list = uuid_list.
172 collect { |uuid| sanitize(uuid) }.join(', ')
173 permitted_uuids = "(SELECT head_uuid FROM links WHERE link_class='permission' AND tail_uuid IN (#{sanitized_uuid_list}))"
174 sql_conds += ["#{sql_table}.uuid IN #{permitted_uuids}"]
177 if sql_table == "links" and users_list.any?
178 # This row is a 'permission' or 'resources' link class
179 # The uuid for a member of users_list is referenced in either the head
180 # or tail of the link
181 sql_conds += ["(#{sql_table}.link_class in (#{sanitize 'permission'}, #{sanitize 'resources'}) AND (#{sql_table}.head_uuid IN (?) OR #{sql_table}.tail_uuid IN (?)))"]
182 sql_params += [user_uuids, user_uuids]
185 if sql_table == "logs" and users_list.any?
186 # Link head points to the object described by this row
187 sql_conds += ["#{sql_table}.object_uuid IN #{permitted_uuids}"]
189 # This object described by this row is owned by this user, or owned by a group readable by this user
190 sql_conds += ["#{sql_table}.object_owner_uuid in (?)"]
191 sql_params += [uuid_list]
194 # Link head points to this row, or to the owner of this row (the
197 # Link tail originates from this user, or a group that is readable
198 # by this user (the identity with authorization to read)
200 # Link class is 'permission' ('write' and 'manage' implicitly
202 where(sql_conds.join(' OR '), *sql_params)
205 def logged_attributes
211 def ensure_ownership_path_leads_to_user
212 if new_record? or owner_uuid_changed?
213 uuid_in_path = {owner_uuid => true, uuid => true}
215 while (owner_class = ArvadosModel::resource_class_for_uuid(x)) != User
218 # Test for cycles with the new version, not the DB contents
220 elsif !owner_class.respond_to? :find_by_uuid
221 raise ActiveRecord::RecordNotFound.new
223 x = owner_class.find_by_uuid(x).owner_uuid
225 rescue ActiveRecord::RecordNotFound => e
226 errors.add :owner_uuid, "is not owned by any user: #{e}"
231 errors.add :owner_uuid, "would create an ownership cycle"
233 errors.add :owner_uuid, "has an ownership cycle"
237 uuid_in_path[x] = true
243 def ensure_owner_uuid_is_permitted
244 raise PermissionDeniedError if !current_user
246 if new_record? and respond_to? :owner_uuid=
247 self.owner_uuid ||= current_user.uuid
250 if self.owner_uuid.nil?
251 errors.add :owner_uuid, "cannot be nil"
252 raise PermissionDeniedError
255 rsc_class = ArvadosModel::resource_class_for_uuid owner_uuid
256 unless rsc_class == User or rsc_class == Group
257 errors.add :owner_uuid, "must be set to User or Group"
258 raise PermissionDeniedError
261 # Verify "write" permission on old owner
262 # default fail unless one of:
263 # owner_uuid did not change
264 # previous owner_uuid is nil
265 # current user is the old owner
266 # current user is this object
267 # current user can_write old owner
268 unless !owner_uuid_changed? or
269 owner_uuid_was.nil? or
270 current_user.uuid == self.owner_uuid_was or
271 current_user.uuid == self.uuid or
272 current_user.can? write: self.owner_uuid_was
273 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}"
274 errors.add :owner_uuid, "cannot be changed without write permission on old owner"
275 raise PermissionDeniedError
278 # Verify "write" permission on new owner
279 # default fail unless one of:
280 # current_user is this object
281 # current user can_write new owner
282 unless current_user == self or current_user.can? write: owner_uuid
283 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}"
284 errors.add :owner_uuid, "cannot be changed without write permission on new owner"
285 raise PermissionDeniedError
291 def ensure_permission_to_save
292 unless (new_record? ? permission_to_create : permission_to_update)
293 raise PermissionDeniedError
297 def permission_to_create
298 current_user.andand.is_active
301 def permission_to_update
303 logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
306 if !current_user.is_active
307 logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
310 return true if current_user.is_admin
311 if self.uuid_changed?
312 logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
318 def ensure_permission_to_destroy
319 raise PermissionDeniedError unless permission_to_destroy
322 def permission_to_destroy
326 def maybe_update_modified_by_fields
327 update_modified_by_fields if self.changed? or self.new_record?
331 def update_modified_by_fields
332 self.updated_at = Time.now
333 self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid=
334 self.modified_at = Time.now
335 self.modified_by_user_uuid = current_user ? current_user.uuid : nil
336 self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
340 def self.has_symbols? x
343 return true if has_symbols?(k) or has_symbols?(v)
348 return true if has_symbols?(k)
356 def self.recursive_stringify x
358 Hash[x.collect do |k,v|
359 [recursive_stringify(k), recursive_stringify(v)]
363 recursive_stringify k
372 def ensure_serialized_attribute_type
373 # Specifying a type in the "serialize" declaration causes rails to
374 # raise an exception if a different data type is retrieved from
375 # the database during load(). The validation preventing such
376 # crash-inducing records from being inserted in the database in
377 # the first place seems to have been left as an exercise to the
379 self.class.serialized_attributes.each do |colname, attr|
381 if self.attributes[colname].class != attr.object_class
382 self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}, not a #{self.attributes[colname].class.to_s}"
383 elsif self.class.has_symbols? attributes[colname]
384 self.errors.add colname.to_sym, "must not contain symbols: #{attributes[colname].inspect}"
390 def convert_serialized_symbols_to_strings
391 # ensure_serialized_attribute_type should prevent symbols from
392 # getting into the database in the first place. If someone managed
393 # to get them into the database (perhaps using an older version)
394 # we'll convert symbols to strings when loading from the
395 # database. (Otherwise, loading and saving an object with existing
396 # symbols in a serialized field will crash.)
397 self.class.serialized_attributes.each do |colname, attr|
398 if self.class.has_symbols? attributes[colname]
399 attributes[colname] = self.class.recursive_stringify attributes[colname]
400 self.send(colname + '=',
401 self.class.recursive_stringify(attributes[colname]))
406 def foreign_key_attributes
407 attributes.keys.select { |a| a.match /_uuid$/ }
410 def skip_uuid_read_permission_check
411 %w(modified_by_client_uuid)
414 def skip_uuid_existence_check
418 def normalize_collection_uuids
419 foreign_key_attributes.each do |attr|
420 attr_value = send attr
421 if attr_value.is_a? String and
422 attr_value.match /^[0-9a-f]{32,}(\+[@\w]+)*$/
424 send "#{attr}=", Collection.normalize_uuid(attr_value)
426 # TODO: abort instead of silently accepting unnormalizable value?
432 @@prefixes_hash = nil
433 def self.uuid_prefixes
434 unless @@prefixes_hash
436 Rails.application.eager_load!
437 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
438 if k.respond_to?(:uuid_prefix)
439 @@prefixes_hash[k.uuid_prefix] = k
446 def self.uuid_like_pattern
447 "_____-#{uuid_prefix}-_______________"
451 %r/[a-z0-9]{5}-#{uuid_prefix}-[a-z0-9]{15}/
454 def ensure_valid_uuids
455 specials = [system_user_uuid]
457 foreign_key_attributes.each do |attr|
458 if new_record? or send (attr + "_changed?")
459 next if skip_uuid_existence_check.include? attr
460 attr_value = send attr
461 next if specials.include? attr_value
463 if (r = ArvadosModel::resource_class_for_uuid attr_value)
464 unless skip_uuid_read_permission_check.include? attr
465 r = r.readable_by(current_user)
467 if r.where(uuid: attr_value).count == 0
468 errors.add(attr, "'#{attr_value}' not found")
485 def self.readable_by (*u)
490 [{:uuid => u[:uuid]}]
494 def self.resource_class_for_uuid(uuid)
495 if uuid.is_a? ArvadosModel
498 unless uuid.is_a? String
503 uuid.match HasUuid::UUID_REGEX do |re|
504 return uuid_prefixes[re[1]] if uuid_prefixes[re[1]]
507 if uuid.match /.+@.+/
514 # ArvadosModel.find_by_uuid needs extra magic to allow it to return
515 # an object in any class.
516 def self.find_by_uuid uuid
517 if self == ArvadosModel
518 # If called directly as ArvadosModel.find_by_uuid rather than via subclass,
519 # delegate to the appropriate subclass based on the given uuid.
520 self.resource_class_for_uuid(uuid).find_by_uuid(uuid)
527 @old_attributes = Marshal.load(Marshal.dump(attributes))
528 @old_logged_attributes = Marshal.load(Marshal.dump(logged_attributes))
531 def log_change(event_type)
532 log = Log.new(event_type: event_type).fill_object(self)
539 log_change('create') do |log|
540 log.fill_properties('old', nil, nil)
546 log_change('update') do |log|
547 log.fill_properties('old', etag(@old_attributes), @old_logged_attributes)
553 log_change('destroy') do |log|
554 log.fill_properties('old', etag(@old_attributes), @old_logged_attributes)