2 require 'record_filters'
5 class ArvadosModel < ActiveRecord::Base
6 self.abstract_class = true
8 include CurrentApiClient # current_user, current_api_client, etc.
12 attr_protected :created_at
13 attr_protected :modified_by_user_uuid
14 attr_protected :modified_by_client_uuid
15 attr_protected :modified_at
16 after_initialize :log_start_state
17 before_save :ensure_permission_to_save
18 before_save :ensure_owner_uuid_is_permitted
19 before_save :ensure_ownership_path_leads_to_user
20 before_destroy :ensure_owner_uuid_is_permitted
21 before_destroy :ensure_permission_to_destroy
22 before_create :update_modified_by_fields
23 before_update :maybe_update_modified_by_fields
24 after_create :log_create
25 after_update :log_update
26 after_destroy :log_destroy
27 after_find :convert_serialized_symbols_to_strings
28 before_validation :normalize_collection_uuids
29 before_validation :set_default_owner
30 validate :ensure_serialized_attribute_type
31 validate :ensure_valid_uuids
33 # Note: This only returns permission links. It does not account for
34 # permissions obtained via user.is_admin or
35 # user.uuid==object.owner_uuid.
36 has_many(:permissions,
37 foreign_key: :head_uuid,
40 conditions: "link_class = 'permission'")
42 class PermissionDeniedError < StandardError
48 class AlreadyLockedError < StandardError
54 class InvalidStateTransitionError < StandardError
60 class UnauthorizedError < StandardError
66 class UnresolvableContainerError < StandardError
72 def self.kind_class(kind)
73 kind.match(/^arvados\#(.+)$/)[1].classify.safe_constantize rescue nil
77 "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}"
80 def self.selectable_attributes(template=:user)
81 # Return an array of attribute name strings that can be selected
82 # in the given template.
83 api_accessible_attributes(template).map { |attr_spec| attr_spec.first.to_s }
86 def self.searchable_columns operator
87 textonly_operator = !operator.match(/[<=>]/)
88 self.columns.select do |col|
92 when :datetime, :integer, :boolean
100 def self.attribute_column attr
101 self.columns.select { |col| col.name == attr.to_s }.first
104 def self.attributes_required_columns
105 # This method returns a hash. Each key is the name of an API attribute,
106 # and it's mapped to a list of database columns that must be fetched
107 # to generate that attribute.
108 # This implementation generates a simple map of attributes to
109 # matching column names. Subclasses can override this method
110 # to specify that method-backed API attributes need to fetch
111 # specific columns from the database.
112 all_columns = columns.map(&:name)
113 api_column_map = Hash.new { |hash, key| hash[key] = [] }
114 methods.grep(/^api_accessible_\w+$/).each do |method_name|
115 next if method_name == :api_accessible_attributes
116 send(method_name).each_pair do |api_attr_name, col_name|
117 col_name = col_name.to_s
118 if all_columns.include?(col_name)
119 api_column_map[api_attr_name.to_s] |= [col_name]
126 def self.ignored_select_attributes
127 ["href", "kind", "etag"]
130 def self.columns_for_attributes(select_attributes)
131 if select_attributes.empty?
132 raise ArgumentError.new("Attribute selection list cannot be empty")
134 api_column_map = attributes_required_columns
136 select_attributes.each do |s|
137 next if ignored_select_attributes.include? s
138 if not s.is_a? String or not api_column_map.include? s
142 if not invalid_attrs.empty?
143 raise ArgumentError.new("Invalid attribute(s): #{invalid_attrs.inspect}")
145 # Given an array of attribute names to select, return an array of column
146 # names that must be fetched from the database to satisfy the request.
147 select_attributes.flat_map { |attr| api_column_map[attr] }.uniq
150 def self.default_orders
151 ["#{table_name}.modified_at desc", "#{table_name}.uuid"]
154 def self.unique_columns
158 # If current user can manage the object, return an array of uuids of
159 # users and groups that have permission to write the object. The
160 # first two elements are always [self.owner_uuid, current user's
163 # If current user can write but not manage the object, return
164 # [self.owner_uuid, current user's uuid].
166 # If current user cannot write this object, just return
169 return [owner_uuid] if not current_user
170 unless (owner_uuid == current_user.uuid or
171 current_user.is_admin or
172 (current_user.groups_i_can(:manage) & [uuid, owner_uuid]).any?)
173 if ((current_user.groups_i_can(:write) + [current_user.uuid]) &
174 [uuid, owner_uuid]).any?
175 return [owner_uuid, current_user.uuid]
180 [owner_uuid, current_user.uuid] + permissions.collect do |p|
181 if ['can_write', 'can_manage'].index p.name
187 # Return a query with read permissions restricted to the union of of the
188 # permissions of the members of users_list, i.e. if something is readable by
189 # any user in users_list, it will be readable in the query returned by this
191 def self.readable_by(*users_list)
192 # Get rid of troublesome nils
195 # Load optional keyword arguments, if they exist.
196 if users_list.last.is_a? Hash
197 kwargs = users_list.pop
202 # Check if any of the users are admin. If so, we're done.
203 if users_list.select { |u| u.is_admin }.any?
207 # Collect the UUIDs of the authorized users.
208 user_uuids = users_list.map { |u| u.uuid }
210 # Collect the UUIDs of all groups readable by any of the
211 # authorized users. If one of these (or the UUID of one of the
212 # authorized users themselves) is an object's owner_uuid, that
213 # object is readable.
214 owner_uuids = user_uuids + users_list.flat_map { |u| u.groups_i_can(:read) }
218 sql_table = kwargs.fetch(:table_name, table_name)
220 # Match any object (evidently a group or user) whose UUID is
221 # listed explicitly in owner_uuids.
222 sql_conds += ["#{sql_table}.uuid in (:owner_uuids)"]
224 # Match any object whose owner is listed explicitly in
226 sql_conds += ["#{sql_table}.owner_uuid IN (:owner_uuids)"]
228 # Match the head of any permission link whose tail is listed
229 # explicitly in owner_uuids.
230 sql_conds += ["#{sql_table}.uuid IN (SELECT head_uuid FROM links WHERE link_class='permission' AND tail_uuid IN (:owner_uuids))"]
232 if sql_table == "links"
233 # Match any permission link that gives one of the authorized
234 # users some permission _or_ gives anyone else permission to
235 # view one of the authorized users.
236 sql_conds += ["(#{sql_table}.link_class in (:permission_link_classes) AND "+
237 "(#{sql_table}.head_uuid IN (:user_uuids) OR #{sql_table}.tail_uuid IN (:user_uuids)))"]
240 where(sql_conds.join(' OR '),
241 owner_uuids: owner_uuids,
242 user_uuids: user_uuids,
243 permission_link_classes: ['permission', 'resources'])
246 def save_with_unique_name!
251 conn = ActiveRecord::Base.connection
252 conn.exec_query 'SAVEPOINT save_with_unique_name'
255 rescue ActiveRecord::RecordNotUnique => rn
256 raise if max_retries == 0
259 conn.exec_query 'ROLLBACK TO SAVEPOINT save_with_unique_name'
261 # Dig into the error to determine if it is specifically calling out a
262 # (owner_uuid, name) uniqueness violation. In this specific case, and
263 # the client requested a unique name with ensure_unique_name==true,
264 # update the name field and try to save again. Loop as necessary to
265 # discover a unique name. It is necessary to handle name choosing at
266 # this level (as opposed to the client) to ensure that record creation
267 # never fails due to a race condition.
268 err = rn.original_exception
269 raise unless err.is_a?(PG::UniqueViolation)
271 # Unfortunately ActiveRecord doesn't abstract out any of the
272 # necessary information to figure out if this the error is actually
273 # the specific case where we want to apply the ensure_unique_name
274 # behavior, so the following code is specialized to Postgres.
275 detail = err.result.error_field(PG::Result::PG_DIAG_MESSAGE_DETAIL)
276 raise unless /^Key \(owner_uuid, name\)=\([a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{15}, .*?\) already exists\./.match detail
278 new_name = "#{name_was} (#{db_current_time.utc.iso8601(3)})"
280 # If the database is fast enough to do two attempts in the
281 # same millisecond, we need to wait to ensure we try a
282 # different timestamp on each attempt.
284 new_name = "#{name_was} (#{db_current_time.utc.iso8601(3)})"
287 self[:name] = new_name
288 self[:uuid] = nil if uuid_was.nil? && !uuid.nil?
289 conn.exec_query 'SAVEPOINT save_with_unique_name'
292 conn.exec_query 'RELEASE SAVEPOINT save_with_unique_name'
297 def logged_attributes
298 attributes.except(*Rails.configuration.unlogged_attributes)
301 def self.full_text_searchable_columns
302 self.columns.select do |col|
303 col.type == :string or col.type == :text
307 def self.full_text_tsvector
308 parts = full_text_searchable_columns.collect do |column|
309 "coalesce(#{column},'')"
311 "to_tsvector('english', #{parts.join(" || ' ' || ")})"
314 def self.apply_filters query, filters
315 ft = record_filters filters, self
316 if not ft[:cond_out].any?
319 query.where('(' + ft[:cond_out].join(') AND (') + ')',
325 def self.deep_sort_hash(x)
327 x.sort.collect do |k, v|
328 [k, deep_sort_hash(v)]
331 x.collect { |v| deep_sort_hash(v) }
337 def ensure_ownership_path_leads_to_user
338 if new_record? or owner_uuid_changed?
339 uuid_in_path = {owner_uuid => true, uuid => true}
341 while (owner_class = ArvadosModel::resource_class_for_uuid(x)) != User
344 # Test for cycles with the new version, not the DB contents
346 elsif !owner_class.respond_to? :find_by_uuid
347 raise ActiveRecord::RecordNotFound.new
349 x = owner_class.find_by_uuid(x).owner_uuid
351 rescue ActiveRecord::RecordNotFound => e
352 errors.add :owner_uuid, "is not owned by any user: #{e}"
357 errors.add :owner_uuid, "would create an ownership cycle"
359 errors.add :owner_uuid, "has an ownership cycle"
363 uuid_in_path[x] = true
369 def set_default_owner
370 if new_record? and current_user and respond_to? :owner_uuid=
371 self.owner_uuid ||= current_user.uuid
375 def ensure_owner_uuid_is_permitted
376 raise PermissionDeniedError if !current_user
378 if self.owner_uuid.nil?
379 errors.add :owner_uuid, "cannot be nil"
380 raise PermissionDeniedError
383 rsc_class = ArvadosModel::resource_class_for_uuid owner_uuid
384 unless rsc_class == User or rsc_class == Group
385 errors.add :owner_uuid, "must be set to User or Group"
386 raise PermissionDeniedError
389 if new_record? || owner_uuid_changed?
390 # Permission on owner_uuid_was is needed to move an existing
391 # object away from its previous owner (which implies permission
392 # to modify this object itself, so we don't need to check that
393 # separately). Permission on the new owner_uuid is also needed.
394 [['old', owner_uuid_was],
396 ].each do |which, check_uuid|
398 # old_owner_uuid is nil? New record, no need to check.
399 elsif !current_user.can?(write: check_uuid)
400 logger.warn "User #{current_user.uuid} tried to set ownership of #{self.class.to_s} #{self.uuid} but does not have permission to write #{which} owner_uuid #{check_uuid}"
401 errors.add :owner_uuid, "cannot be set or changed without write permission on #{which} owner"
402 raise PermissionDeniedError
406 # If the object already existed and we're not changing
407 # owner_uuid, we only need write permission on the object
409 if !current_user.can?(write: self.uuid)
410 logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{self.uuid} without write permission"
411 errors.add :uuid, "is not writable"
412 raise PermissionDeniedError
419 def ensure_permission_to_save
420 unless (new_record? ? permission_to_create : permission_to_update)
421 raise PermissionDeniedError
425 def permission_to_create
426 current_user.andand.is_active
429 def permission_to_update
431 logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
434 if !current_user.is_active
435 logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
438 return true if current_user.is_admin
439 if self.uuid_changed?
440 logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
446 def ensure_permission_to_destroy
447 raise PermissionDeniedError unless permission_to_destroy
450 def permission_to_destroy
454 def maybe_update_modified_by_fields
455 update_modified_by_fields if self.changed? or self.new_record?
459 def update_modified_by_fields
460 current_time = db_current_time
461 self.updated_at = current_time
462 self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid=
463 self.modified_at = current_time
464 self.modified_by_user_uuid = current_user ? current_user.uuid : nil
465 self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
469 def self.has_symbols? x
472 return true if has_symbols?(k) or has_symbols?(v)
476 return true if has_symbols?(k)
481 return true if x.start_with?(':') && !x.start_with?('::')
486 def self.recursive_stringify x
488 Hash[x.collect do |k,v|
489 [recursive_stringify(k), recursive_stringify(v)]
493 recursive_stringify k
497 elsif x.is_a? String and x.start_with?(':') and !x.start_with?('::')
504 def self.where_serialized(colname, value)
505 sorted = deep_sort_hash(value)
506 where("#{colname.to_s} IN (?)", [sorted.to_yaml, SafeJSON.dump(sorted)])
510 Hash => HashSerializer,
511 Array => ArraySerializer,
514 def self.serialize(colname, type)
515 super(colname, Serializer[type])
518 def ensure_serialized_attribute_type
519 # Specifying a type in the "serialize" declaration causes rails to
520 # raise an exception if a different data type is retrieved from
521 # the database during load(). The validation preventing such
522 # crash-inducing records from being inserted in the database in
523 # the first place seems to have been left as an exercise to the
525 self.class.serialized_attributes.each do |colname, attr|
527 if self.attributes[colname].class != attr.object_class
528 self.errors.add colname.to_sym, "must be a #{attr.object_class.to_s}, not a #{self.attributes[colname].class.to_s}"
529 elsif self.class.has_symbols? attributes[colname]
530 self.errors.add colname.to_sym, "must not contain symbols: #{attributes[colname].inspect}"
536 def convert_serialized_symbols_to_strings
537 # ensure_serialized_attribute_type should prevent symbols from
538 # getting into the database in the first place. If someone managed
539 # to get them into the database (perhaps using an older version)
540 # we'll convert symbols to strings when loading from the
541 # database. (Otherwise, loading and saving an object with existing
542 # symbols in a serialized field will crash.)
543 self.class.serialized_attributes.each do |colname, attr|
544 if self.class.has_symbols? attributes[colname]
545 attributes[colname] = self.class.recursive_stringify attributes[colname]
546 self.send(colname + '=',
547 self.class.recursive_stringify(attributes[colname]))
552 def foreign_key_attributes
553 attributes.keys.select { |a| a.match(/_uuid$/) }
556 def skip_uuid_read_permission_check
557 %w(modified_by_client_uuid)
560 def skip_uuid_existence_check
564 def normalize_collection_uuids
565 foreign_key_attributes.each do |attr|
566 attr_value = send attr
567 if attr_value.is_a? String and
568 attr_value.match(/^[0-9a-f]{32,}(\+[@\w]+)*$/)
570 send "#{attr}=", Collection.normalize_uuid(attr_value)
572 # TODO: abort instead of silently accepting unnormalizable value?
578 @@prefixes_hash = nil
579 def self.uuid_prefixes
580 unless @@prefixes_hash
582 Rails.application.eager_load!
583 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
584 if k.respond_to?(:uuid_prefix)
585 @@prefixes_hash[k.uuid_prefix] = k
592 def self.uuid_like_pattern
593 "#{Rails.configuration.uuid_prefix}-#{uuid_prefix}-_______________"
597 %r/[a-z0-9]{5}-#{uuid_prefix}-[a-z0-9]{15}/
600 def ensure_valid_uuids
601 specials = [system_user_uuid]
603 foreign_key_attributes.each do |attr|
604 if new_record? or send (attr + "_changed?")
605 next if skip_uuid_existence_check.include? attr
606 attr_value = send attr
607 next if specials.include? attr_value
609 if (r = ArvadosModel::resource_class_for_uuid attr_value)
610 unless skip_uuid_read_permission_check.include? attr
611 r = r.readable_by(current_user)
613 if r.where(uuid: attr_value).count == 0
614 errors.add(attr, "'#{attr_value}' not found")
631 def self.readable_by (*u)
636 [{:uuid => u[:uuid]}]
640 def self.resource_class_for_uuid(uuid)
641 if uuid.is_a? ArvadosModel
644 unless uuid.is_a? String
648 uuid.match HasUuid::UUID_REGEX do |re|
649 return uuid_prefixes[re[1]] if uuid_prefixes[re[1]]
652 if uuid.match(/.+@.+/)
659 # ArvadosModel.find_by_uuid needs extra magic to allow it to return
660 # an object in any class.
661 def self.find_by_uuid uuid
662 if self == ArvadosModel
663 # If called directly as ArvadosModel.find_by_uuid rather than via subclass,
664 # delegate to the appropriate subclass based on the given uuid.
665 self.resource_class_for_uuid(uuid).unscoped.find_by_uuid(uuid)
672 @old_attributes = Marshal.load(Marshal.dump(attributes))
673 @old_logged_attributes = Marshal.load(Marshal.dump(logged_attributes))
676 def log_change(event_type)
677 log = Log.new(event_type: event_type).fill_object(self)
684 log_change('create') do |log|
685 log.fill_properties('old', nil, nil)
691 log_change('update') do |log|
692 log.fill_properties('old', etag(@old_attributes), @old_logged_attributes)
698 log_change('delete') do |log|
699 log.fill_properties('old', etag(@old_attributes), @old_logged_attributes)