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|
66 if operator == 'ilike'
71 when :datetime, :integer, :boolean
79 def self.attribute_column attr
80 self.columns.select { |col| col.name == attr.to_s }.first
83 def self.attributes_required_columns
84 # This method returns a hash. Each key is the name of an API attribute,
85 # and it's mapped to a list of database columns that must be fetched
86 # to generate that attribute.
87 # This implementation generates a simple map of attributes to
88 # matching column names. Subclasses can override this method
89 # to specify that method-backed API attributes need to fetch
90 # specific columns from the database.
91 all_columns = columns.map(&:name)
92 api_column_map = Hash.new { |hash, key| hash[key] = [] }
93 methods.grep(/^api_accessible_\w+$/).each do |method_name|
94 next if method_name == :api_accessible_attributes
95 send(method_name).each_pair do |api_attr_name, col_name|
96 col_name = col_name.to_s
97 if all_columns.include?(col_name)
98 api_column_map[api_attr_name.to_s] |= [col_name]
105 # If current user can manage the object, return an array of uuids of
106 # users and groups that have permission to write the object. The
107 # first two elements are always [self.owner_uuid, current user's
110 # If current user can write but not manage the object, return
111 # [self.owner_uuid, current user's uuid].
113 # If current user cannot write this object, just return
116 unless (owner_uuid == current_user.uuid or
117 current_user.is_admin or
118 (current_user.groups_i_can(:manage) & [uuid, owner_uuid]).any?)
119 if ((current_user.groups_i_can(:write) + [current_user.uuid]) &
120 [uuid, owner_uuid]).any?
121 return [owner_uuid, current_user.uuid]
126 [owner_uuid, current_user.uuid] + permissions.collect do |p|
127 if ['can_write', 'can_manage'].index p.name
133 # Return a query with read permissions restricted to the union of of the
134 # permissions of the members of users_list, i.e. if something is readable by
135 # any user in users_list, it will be readable in the query returned by this
137 def self.readable_by(*users_list)
138 # Get rid of troublesome nils
141 # Load optional keyword arguments, if they exist.
142 if users_list.last.is_a? Hash
143 kwargs = users_list.pop
148 # Check if any of the users are admin. If so, we're done.
149 if users_list.select { |u| u.is_admin }.any?
153 # Collect the uuids for each user and any groups readable by each user.
154 user_uuids = users_list.map { |u| u.uuid }
155 uuid_list = user_uuids + users_list.flat_map { |u| u.groups_i_can(:read) }
158 sql_table = kwargs.fetch(:table_name, table_name)
161 # This row is owned by a member of users_list, or owned by a group
162 # readable by a member of users_list
164 # This row uuid is the uuid of a member of users_list
166 # A permission link exists ('write' and 'manage' implicitly include
167 # 'read') from a member of users_list, or a group readable by users_list,
168 # to this row, or to the owner of this row (see join() below).
169 sql_conds += ["#{sql_table}.uuid in (?)"]
170 sql_params += [user_uuids]
173 sql_conds += ["#{sql_table}.owner_uuid in (?)"]
174 sql_params += [uuid_list]
176 sanitized_uuid_list = uuid_list.
177 collect { |uuid| sanitize(uuid) }.join(', ')
178 permitted_uuids = "(SELECT head_uuid FROM links WHERE link_class='permission' AND tail_uuid IN (#{sanitized_uuid_list}))"
179 sql_conds += ["#{sql_table}.uuid IN #{permitted_uuids}"]
182 if sql_table == "links" and users_list.any?
183 # This row is a 'permission' or 'resources' link class
184 # The uuid for a member of users_list is referenced in either the head
185 # or tail of the link
186 sql_conds += ["(#{sql_table}.link_class in (#{sanitize 'permission'}, #{sanitize 'resources'}) AND (#{sql_table}.head_uuid IN (?) OR #{sql_table}.tail_uuid IN (?)))"]
187 sql_params += [user_uuids, user_uuids]
190 if sql_table == "logs" and users_list.any?
191 # Link head points to the object described by this row
192 sql_conds += ["#{sql_table}.object_uuid IN #{permitted_uuids}"]
194 # This object described by this row is owned by this user, or owned by a group readable by this user
195 sql_conds += ["#{sql_table}.object_owner_uuid in (?)"]
196 sql_params += [uuid_list]
199 # Link head points to this row, or to the owner of this row (the
202 # Link tail originates from this user, or a group that is readable
203 # by this user (the identity with authorization to read)
205 # Link class is 'permission' ('write' and 'manage' implicitly
207 where(sql_conds.join(' OR '), *sql_params)
210 def logged_attributes
216 def ensure_ownership_path_leads_to_user
217 if new_record? or owner_uuid_changed?
218 uuid_in_path = {owner_uuid => true, uuid => true}
220 while (owner_class = ArvadosModel::resource_class_for_uuid(x)) != User
223 # Test for cycles with the new version, not the DB contents
225 elsif !owner_class.respond_to? :find_by_uuid
226 raise ActiveRecord::RecordNotFound.new
228 x = owner_class.find_by_uuid(x).owner_uuid
230 rescue ActiveRecord::RecordNotFound => e
231 errors.add :owner_uuid, "is not owned by any user: #{e}"
236 errors.add :owner_uuid, "would create an ownership cycle"
238 errors.add :owner_uuid, "has an ownership cycle"
242 uuid_in_path[x] = true
248 def ensure_owner_uuid_is_permitted
249 raise PermissionDeniedError if !current_user
251 if new_record? and respond_to? :owner_uuid=
252 self.owner_uuid ||= current_user.uuid
255 if self.owner_uuid.nil?
256 errors.add :owner_uuid, "cannot be nil"
257 raise PermissionDeniedError
260 rsc_class = ArvadosModel::resource_class_for_uuid owner_uuid
261 unless rsc_class == User or rsc_class == Group
262 errors.add :owner_uuid, "must be set to User or Group"
263 raise PermissionDeniedError
266 # Verify "write" permission on old owner
267 # default fail unless one of:
268 # owner_uuid did not change
269 # previous owner_uuid is nil
270 # current user is the old owner
271 # current user is this object
272 # current user can_write old owner
273 unless !owner_uuid_changed? or
274 owner_uuid_was.nil? or
275 current_user.uuid == self.owner_uuid_was or
276 current_user.uuid == self.uuid or
277 current_user.can? write: self.owner_uuid_was
278 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}"
279 errors.add :owner_uuid, "cannot be changed without write permission on old owner"
280 raise PermissionDeniedError
283 # Verify "write" permission on new owner
284 # default fail unless one of:
285 # current_user is this object
286 # current user can_write new owner
287 unless current_user == self or current_user.can? write: owner_uuid
288 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}"
289 errors.add :owner_uuid, "cannot be changed without write permission on new owner"
290 raise PermissionDeniedError
296 def ensure_permission_to_save
297 unless (new_record? ? permission_to_create : permission_to_update)
298 raise PermissionDeniedError
302 def permission_to_create
303 current_user.andand.is_active
306 def permission_to_update
308 logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
311 if !current_user.is_active
312 logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
315 return true if current_user.is_admin
316 if self.uuid_changed?
317 logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
323 def ensure_permission_to_destroy
324 raise PermissionDeniedError unless permission_to_destroy
327 def permission_to_destroy
331 def maybe_update_modified_by_fields
332 update_modified_by_fields if self.changed? or self.new_record?
336 def update_modified_by_fields
337 self.updated_at = Time.now
338 self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid=
339 self.modified_at = Time.now
340 self.modified_by_user_uuid = current_user ? current_user.uuid : nil
341 self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
345 def self.has_symbols? x
348 return true if has_symbols?(k) or has_symbols?(v)
353 return true if has_symbols?(k)
361 def self.recursive_stringify x
363 Hash[x.collect do |k,v|
364 [recursive_stringify(k), recursive_stringify(v)]
368 recursive_stringify k
377 def ensure_serialized_attribute_type
378 # Specifying a type in the "serialize" declaration causes rails to
379 # raise an exception if a different data type is retrieved from
380 # the database during load(). The validation preventing such
381 # crash-inducing records from being inserted in the database in
382 # the first place seems to have been left as an exercise to the
384 self.class.serialized_attributes.each do |colname, attr|
386 if self.attributes[colname].class != attr.object_class
387 self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}, not a #{self.attributes[colname].class.to_s}"
388 elsif self.class.has_symbols? attributes[colname]
389 self.errors.add colname.to_sym, "must not contain symbols: #{attributes[colname].inspect}"
395 def convert_serialized_symbols_to_strings
396 # ensure_serialized_attribute_type should prevent symbols from
397 # getting into the database in the first place. If someone managed
398 # to get them into the database (perhaps using an older version)
399 # we'll convert symbols to strings when loading from the
400 # database. (Otherwise, loading and saving an object with existing
401 # symbols in a serialized field will crash.)
402 self.class.serialized_attributes.each do |colname, attr|
403 if self.class.has_symbols? attributes[colname]
404 attributes[colname] = self.class.recursive_stringify attributes[colname]
405 self.send(colname + '=',
406 self.class.recursive_stringify(attributes[colname]))
411 def foreign_key_attributes
412 attributes.keys.select { |a| a.match /_uuid$/ }
415 def skip_uuid_read_permission_check
416 %w(modified_by_client_uuid)
419 def skip_uuid_existence_check
423 def normalize_collection_uuids
424 foreign_key_attributes.each do |attr|
425 attr_value = send attr
426 if attr_value.is_a? String and
427 attr_value.match /^[0-9a-f]{32,}(\+[@\w]+)*$/
429 send "#{attr}=", Collection.normalize_uuid(attr_value)
431 # TODO: abort instead of silently accepting unnormalizable value?
437 @@prefixes_hash = nil
438 def self.uuid_prefixes
439 unless @@prefixes_hash
441 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
442 if k.respond_to?(:uuid_prefix)
443 @@prefixes_hash[k.uuid_prefix] = k
450 def self.uuid_like_pattern
451 "_____-#{uuid_prefix}-_______________"
455 %r/[a-z0-9]{5}-#{uuid_prefix}-[a-z0-9]{15}/
458 def ensure_valid_uuids
459 specials = [system_user_uuid]
461 foreign_key_attributes.each do |attr|
462 if new_record? or send (attr + "_changed?")
463 next if skip_uuid_existence_check.include? attr
464 attr_value = send attr
465 next if specials.include? attr_value
467 if (r = ArvadosModel::resource_class_for_uuid attr_value)
468 unless skip_uuid_read_permission_check.include? attr
469 r = r.readable_by(current_user)
471 if r.where(uuid: attr_value).count == 0
472 errors.add(attr, "'#{attr_value}' not found")
489 def self.readable_by (*u)
494 [{:uuid => u[:uuid]}]
498 def self.resource_class_for_uuid(uuid)
499 if uuid.is_a? ArvadosModel
502 unless uuid.is_a? String
507 Rails.application.eager_load!
508 uuid.match HasUuid::UUID_REGEX do |re|
509 return uuid_prefixes[re[1]] if uuid_prefixes[re[1]]
512 if uuid.match /.+@.+/
519 # ArvadosModel.find_by_uuid needs extra magic to allow it to return
520 # an object in any class.
521 def self.find_by_uuid uuid
522 if self == ArvadosModel
523 # If called directly as ArvadosModel.find_by_uuid rather than via subclass,
524 # delegate to the appropriate subclass based on the given uuid.
525 self.resource_class_for_uuid(uuid).find_by_uuid(uuid)
533 @old_attributes = logged_attributes
536 def log_change(event_type)
537 log = Log.new(event_type: event_type).fill_object(self)
544 log_change('create') do |log|
545 log.fill_properties('old', nil, nil)
551 log_change('update') do |log|
552 log.fill_properties('old', @old_etag, @old_attributes)
558 log_change('destroy') do |log|
559 log.fill_properties('old', @old_etag, @old_attributes)