1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
6 require 'record_filters'
9 class ArvadosModel < ActiveRecord::Base
10 self.abstract_class = true
12 include CurrentApiClient # current_user, current_api_client, etc.
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_valid_uuids
32 # Note: This only returns permission links. It does not account for
33 # permissions obtained via user.is_admin or
34 # user.uuid==object.owner_uuid.
35 has_many(:permissions,
36 ->{where(link_class: 'permission')},
37 foreign_key: :head_uuid,
41 class PermissionDeniedError < StandardError
47 class AlreadyLockedError < StandardError
53 class LockFailedError < StandardError
59 class InvalidStateTransitionError < StandardError
65 class UnauthorizedError < StandardError
71 class UnresolvableContainerError < StandardError
77 def self.kind_class(kind)
78 kind.match(/^arvados\#(.+)$/)[1].classify.safe_constantize rescue nil
82 "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}"
85 def self.permit_attribute_params raw_params
86 # strong_parameters does not provide security: permissions are
87 # implemented with before_save hooks.
89 # The following permit! is necessary even with
90 # "ActionController::Parameters.permit_all_parameters = true",
91 # because permit_all does not permit nested attributes.
93 serialized_attributes.each do |colname, coder|
94 param = raw_params[colname.to_sym]
97 elsif !param.is_a?(coder.object_class)
98 raise ArgumentError.new("#{colname} parameter must be #{coder.object_class}, not #{param.class}")
99 elsif has_nonstring_keys?(param)
100 raise ArgumentError.new("#{colname} parameter cannot have non-string hash keys")
104 ActionController::Parameters.new(raw_params).permit!
107 def initialize raw_params={}, *args
108 super(self.class.permit_attribute_params(raw_params), *args)
111 # Reload "old attributes" for logging, too.
117 def self.create raw_params={}, *args
118 super(permit_attribute_params(raw_params), *args)
121 def update_attributes raw_params={}, *args
122 super(self.class.permit_attribute_params(raw_params), *args)
125 def self.selectable_attributes(template=:user)
126 # Return an array of attribute name strings that can be selected
127 # in the given template.
128 api_accessible_attributes(template).map { |attr_spec| attr_spec.first.to_s }
131 def self.searchable_columns operator
132 textonly_operator = !operator.match(/[<=>]/)
133 self.columns.select do |col|
137 when :datetime, :integer, :boolean
145 def self.attribute_column attr
146 self.columns.select { |col| col.name == attr.to_s }.first
149 def self.attributes_required_columns
150 # This method returns a hash. Each key is the name of an API attribute,
151 # and it's mapped to a list of database columns that must be fetched
152 # to generate that attribute.
153 # This implementation generates a simple map of attributes to
154 # matching column names. Subclasses can override this method
155 # to specify that method-backed API attributes need to fetch
156 # specific columns from the database.
157 all_columns = columns.map(&:name)
158 api_column_map = Hash.new { |hash, key| hash[key] = [] }
159 methods.grep(/^api_accessible_\w+$/).each do |method_name|
160 next if method_name == :api_accessible_attributes
161 send(method_name).each_pair do |api_attr_name, col_name|
162 col_name = col_name.to_s
163 if all_columns.include?(col_name)
164 api_column_map[api_attr_name.to_s] |= [col_name]
171 def self.ignored_select_attributes
172 ["href", "kind", "etag"]
175 def self.columns_for_attributes(select_attributes)
176 if select_attributes.empty?
177 raise ArgumentError.new("Attribute selection list cannot be empty")
179 api_column_map = attributes_required_columns
181 select_attributes.each do |s|
182 next if ignored_select_attributes.include? s
183 if not s.is_a? String or not api_column_map.include? s
187 if not invalid_attrs.empty?
188 raise ArgumentError.new("Invalid attribute(s): #{invalid_attrs.inspect}")
190 # Given an array of attribute names to select, return an array of column
191 # names that must be fetched from the database to satisfy the request.
192 select_attributes.flat_map { |attr| api_column_map[attr] }.uniq
195 def self.default_orders
196 ["#{table_name}.modified_at desc", "#{table_name}.uuid"]
199 def self.unique_columns
203 def self.limit_index_columns_read
204 # This method returns a list of column names.
205 # If an index request reads that column from the database,
206 # APIs that return lists will only fetch objects until reaching
207 # max_index_database_read bytes of data from those columns.
211 # If current user can manage the object, return an array of uuids of
212 # users and groups that have permission to write the object. The
213 # first two elements are always [self.owner_uuid, current user's
216 # If current user can write but not manage the object, return
217 # [self.owner_uuid, current user's uuid].
219 # If current user cannot write this object, just return
222 return [owner_uuid] if not current_user
223 unless (owner_uuid == current_user.uuid or
224 current_user.is_admin or
225 (current_user.groups_i_can(:manage) & [uuid, owner_uuid]).any?)
226 if ((current_user.groups_i_can(:write) + [current_user.uuid]) &
227 [uuid, owner_uuid]).any?
228 return [owner_uuid, current_user.uuid]
233 [owner_uuid, current_user.uuid] + permissions.collect do |p|
234 if ['can_write', 'can_manage'].index p.name
240 # Return a query with read permissions restricted to the union of of the
241 # permissions of the members of users_list, i.e. if something is readable by
242 # any user in users_list, it will be readable in the query returned by this
244 def self.readable_by(*users_list)
245 # Get rid of troublesome nils
248 # Load optional keyword arguments, if they exist.
249 if users_list.last.is_a? Hash
250 kwargs = users_list.pop
255 # Collect the UUIDs of the authorized users.
256 sql_table = kwargs.fetch(:table_name, table_name)
257 include_trash = kwargs.fetch(:include_trash, false)
258 query_on = kwargs.fetch(:query_on, self)
261 user_uuids = users_list.map { |u| u.uuid }
263 if users_list.select { |u| u.is_admin }.any?
265 # exclude rows that are explicitly trashed.
266 if sql_table != "api_client_authorizations"
267 sql_conds.push "NOT EXISTS(SELECT 1
268 FROM #{PERMISSION_VIEW}
269 WHERE trashed = 1 AND
270 (#{sql_table}.uuid = target_uuid OR #{sql_table}.owner_uuid = target_uuid))"
277 trashed_check = "AND trashed = 0"
280 if sql_table != "api_client_authorizations" and sql_table != "groups"
281 owner_check = "OR (target_uuid = #{sql_table}.owner_uuid AND target_owner_uuid IS NOT NULL)"
286 sql_conds.push "EXISTS(SELECT 1 FROM #{PERMISSION_VIEW} "+
287 "WHERE user_uuid IN (:user_uuids) AND perm_level >= 1 #{trashed_check} AND (target_uuid = #{sql_table}.uuid #{owner_check}))"
289 if sql_table == "links"
290 # Match any permission link that gives one of the authorized
291 # users some permission _or_ gives anyone else permission to
292 # view one of the authorized users.
293 sql_conds.push "(#{sql_table}.link_class IN (:permission_link_classes) AND "+
294 "(#{sql_table}.head_uuid IN (:user_uuids) OR #{sql_table}.tail_uuid IN (:user_uuids)))"
298 query_on.where(sql_conds.join(' OR '),
299 user_uuids: user_uuids,
300 permission_link_classes: ['permission', 'resources'])
303 def save_with_unique_name!
308 conn = ActiveRecord::Base.connection
309 conn.exec_query 'SAVEPOINT save_with_unique_name'
312 rescue ActiveRecord::RecordNotUnique => rn
313 raise if max_retries == 0
316 conn.exec_query 'ROLLBACK TO SAVEPOINT save_with_unique_name'
318 # Dig into the error to determine if it is specifically calling out a
319 # (owner_uuid, name) uniqueness violation. In this specific case, and
320 # the client requested a unique name with ensure_unique_name==true,
321 # update the name field and try to save again. Loop as necessary to
322 # discover a unique name. It is necessary to handle name choosing at
323 # this level (as opposed to the client) to ensure that record creation
324 # never fails due to a race condition.
325 err = rn.original_exception
326 raise unless err.is_a?(PG::UniqueViolation)
328 # Unfortunately ActiveRecord doesn't abstract out any of the
329 # necessary information to figure out if this the error is actually
330 # the specific case where we want to apply the ensure_unique_name
331 # behavior, so the following code is specialized to Postgres.
332 detail = err.result.error_field(PG::Result::PG_DIAG_MESSAGE_DETAIL)
333 raise unless /^Key \(owner_uuid, name\)=\([a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{15}, .*?\) already exists\./.match detail
335 new_name = "#{name_was} (#{db_current_time.utc.iso8601(3)})"
337 # If the database is fast enough to do two attempts in the
338 # same millisecond, we need to wait to ensure we try a
339 # different timestamp on each attempt.
341 new_name = "#{name_was} (#{db_current_time.utc.iso8601(3)})"
344 self[:name] = new_name
345 self[:uuid] = nil if uuid_was.nil? && !uuid.nil?
346 conn.exec_query 'SAVEPOINT save_with_unique_name'
349 conn.exec_query 'RELEASE SAVEPOINT save_with_unique_name'
354 def logged_attributes
355 attributes.except(*Rails.configuration.unlogged_attributes)
358 def self.full_text_searchable_columns
359 self.columns.select do |col|
360 [:string, :text, :jsonb].include?(col.type)
364 def self.full_text_tsvector
365 parts = full_text_searchable_columns.collect do |column|
366 cast = serialized_attributes[column] ? '::text' : ''
367 "coalesce(#{column}#{cast},'')"
369 "to_tsvector('english', #{parts.join(" || ' ' || ")})"
372 def self.apply_filters query, filters
373 ft = record_filters filters, self
374 if not ft[:cond_out].any?
377 query.where('(' + ft[:cond_out].join(') AND (') + ')',
383 def self.deep_sort_hash(x)
385 x.sort.collect do |k, v|
386 [k, deep_sort_hash(v)]
389 x.collect { |v| deep_sort_hash(v) }
395 def ensure_ownership_path_leads_to_user
396 if new_record? or owner_uuid_changed?
397 uuid_in_path = {owner_uuid => true, uuid => true}
399 while (owner_class = ArvadosModel::resource_class_for_uuid(x)) != User
402 # Test for cycles with the new version, not the DB contents
404 elsif !owner_class.respond_to? :find_by_uuid
405 raise ActiveRecord::RecordNotFound.new
407 x = owner_class.find_by_uuid(x).owner_uuid
409 rescue ActiveRecord::RecordNotFound => e
410 errors.add :owner_uuid, "is not owned by any user: #{e}"
415 errors.add :owner_uuid, "would create an ownership cycle"
417 errors.add :owner_uuid, "has an ownership cycle"
421 uuid_in_path[x] = true
427 def set_default_owner
428 if new_record? and current_user and respond_to? :owner_uuid=
429 self.owner_uuid ||= current_user.uuid
433 def ensure_owner_uuid_is_permitted
434 raise PermissionDeniedError if !current_user
436 if self.owner_uuid.nil?
437 errors.add :owner_uuid, "cannot be nil"
438 raise PermissionDeniedError
441 rsc_class = ArvadosModel::resource_class_for_uuid owner_uuid
442 unless rsc_class == User or rsc_class == Group
443 errors.add :owner_uuid, "must be set to User or Group"
444 raise PermissionDeniedError
447 if new_record? || owner_uuid_changed?
448 # Permission on owner_uuid_was is needed to move an existing
449 # object away from its previous owner (which implies permission
450 # to modify this object itself, so we don't need to check that
451 # separately). Permission on the new owner_uuid is also needed.
452 [['old', owner_uuid_was],
454 ].each do |which, check_uuid|
456 # old_owner_uuid is nil? New record, no need to check.
457 elsif !current_user.can?(write: check_uuid)
458 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}"
459 errors.add :owner_uuid, "cannot be set or changed without write permission on #{which} owner"
460 raise PermissionDeniedError
464 # If the object already existed and we're not changing
465 # owner_uuid, we only need write permission on the object
467 if !current_user.can?(write: self.uuid)
468 logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{self.uuid} without write permission"
469 errors.add :uuid, "is not writable"
470 raise PermissionDeniedError
477 def ensure_permission_to_save
478 unless (new_record? ? permission_to_create : permission_to_update)
479 raise PermissionDeniedError
483 def permission_to_create
484 current_user.andand.is_active
487 def permission_to_update
489 logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
492 if !current_user.is_active
493 logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
496 return true if current_user.is_admin
497 if self.uuid_changed?
498 logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
504 def ensure_permission_to_destroy
505 raise PermissionDeniedError unless permission_to_destroy
508 def permission_to_destroy
512 def maybe_update_modified_by_fields
513 update_modified_by_fields if self.changed? or self.new_record?
517 def update_modified_by_fields
518 current_time = db_current_time
519 self.created_at = created_at_was || current_time
520 self.updated_at = current_time
521 self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid=
522 self.modified_at = current_time
523 self.modified_by_user_uuid = current_user ? current_user.uuid : nil
524 self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
528 def self.has_nonstring_keys? x
531 return true if !(k.is_a?(String) || k.is_a?(Symbol)) || has_nonstring_keys?(v)
535 return true if has_nonstring_keys?(v)
541 def self.has_symbols? x
544 return true if has_symbols?(k) or has_symbols?(v)
548 return true if has_symbols?(k)
553 return true if x.start_with?(':') && !x.start_with?('::')
558 def self.recursive_stringify x
560 Hash[x.collect do |k,v|
561 [recursive_stringify(k), recursive_stringify(v)]
565 recursive_stringify k
569 elsif x.is_a? String and x.start_with?(':') and !x.start_with?('::')
576 def self.where_serialized(colname, value)
578 # rails4 stores as null, rails3 stored as serialized [] or {}
579 sql = "#{colname.to_s} is null or #{colname.to_s} IN (?)"
582 sql = "#{colname.to_s} IN (?)"
583 sorted = deep_sort_hash(value)
585 where(sql, [sorted.to_yaml, SafeJSON.dump(sorted)])
589 Hash => HashSerializer,
590 Array => ArraySerializer,
593 def self.serialize(colname, type)
594 coder = Serializer[type]
595 @serialized_attributes ||= {}
596 @serialized_attributes[colname.to_s] = coder
597 super(colname, coder)
600 def self.serialized_attributes
601 @serialized_attributes ||= {}
604 def serialized_attributes
605 self.class.serialized_attributes
608 def convert_serialized_symbols_to_strings
609 # ensure_serialized_attribute_type should prevent symbols from
610 # getting into the database in the first place. If someone managed
611 # to get them into the database (perhaps using an older version)
612 # we'll convert symbols to strings when loading from the
613 # database. (Otherwise, loading and saving an object with existing
614 # symbols in a serialized field will crash.)
615 self.class.serialized_attributes.each do |colname, attr|
616 if self.class.has_symbols? attributes[colname]
617 attributes[colname] = self.class.recursive_stringify attributes[colname]
619 self.class.recursive_stringify(attributes[colname]))
624 def foreign_key_attributes
625 attributes.keys.select { |a| a.match(/_uuid$/) }
628 def skip_uuid_read_permission_check
629 %w(modified_by_client_uuid)
632 def skip_uuid_existence_check
636 def normalize_collection_uuids
637 foreign_key_attributes.each do |attr|
638 attr_value = send attr
639 if attr_value.is_a? String and
640 attr_value.match(/^[0-9a-f]{32,}(\+[@\w]+)*$/)
642 send "#{attr}=", Collection.normalize_uuid(attr_value)
644 # TODO: abort instead of silently accepting unnormalizable value?
650 @@prefixes_hash = nil
651 def self.uuid_prefixes
652 unless @@prefixes_hash
654 Rails.application.eager_load!
655 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
656 if k.respond_to?(:uuid_prefix)
657 @@prefixes_hash[k.uuid_prefix] = k
664 def self.uuid_like_pattern
665 "#{Rails.configuration.uuid_prefix}-#{uuid_prefix}-_______________"
669 %r/[a-z0-9]{5}-#{uuid_prefix}-[a-z0-9]{15}/
672 def ensure_valid_uuids
673 specials = [system_user_uuid]
675 foreign_key_attributes.each do |attr|
676 if new_record? or send (attr + "_changed?")
677 next if skip_uuid_existence_check.include? attr
678 attr_value = send attr
679 next if specials.include? attr_value
681 if (r = ArvadosModel::resource_class_for_uuid attr_value)
682 unless skip_uuid_read_permission_check.include? attr
683 r = r.readable_by(current_user)
685 if r.where(uuid: attr_value).count == 0
686 errors.add(attr, "'#{attr_value}' not found")
703 def self.readable_by (*u)
708 [{:uuid => u[:uuid]}]
712 def self.resource_class_for_uuid(uuid)
713 if uuid.is_a? ArvadosModel
716 unless uuid.is_a? String
720 uuid.match HasUuid::UUID_REGEX do |re|
721 return uuid_prefixes[re[1]] if uuid_prefixes[re[1]]
724 if uuid.match(/.+@.+/)
731 # ArvadosModel.find_by_uuid needs extra magic to allow it to return
732 # an object in any class.
733 def self.find_by_uuid uuid
734 if self == ArvadosModel
735 # If called directly as ArvadosModel.find_by_uuid rather than via subclass,
736 # delegate to the appropriate subclass based on the given uuid.
737 self.resource_class_for_uuid(uuid).unscoped.find_by_uuid(uuid)
744 @old_attributes = Marshal.load(Marshal.dump(attributes))
745 @old_logged_attributes = Marshal.load(Marshal.dump(logged_attributes))
748 def log_change(event_type)
749 log = Log.new(event_type: event_type).fill_object(self)
756 log_change('create') do |log|
757 log.fill_properties('old', nil, nil)
763 log_change('update') do |log|
764 log.fill_properties('old', etag(@old_attributes), @old_logged_attributes)
770 log_change('delete') do |log|
771 log.fill_properties('old', etag(@old_attributes), @old_logged_attributes)