1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
5 require 'arvados_model_updates'
7 require 'record_filters'
9 require 'request_error'
11 class ArvadosModel < ActiveRecord::Base
12 self.abstract_class = true
14 include ArvadosModelUpdates
15 include CurrentApiClient # current_user, current_api_client, etc.
19 after_initialize :log_start_state
20 before_save :ensure_permission_to_save
21 before_save :ensure_owner_uuid_is_permitted
22 before_save :ensure_ownership_path_leads_to_user
23 before_destroy :ensure_owner_uuid_is_permitted
24 before_destroy :ensure_permission_to_destroy
25 before_create :update_modified_by_fields
26 before_update :maybe_update_modified_by_fields
27 after_create :log_create
28 after_update :log_update
29 after_destroy :log_destroy
30 after_find :convert_serialized_symbols_to_strings
31 before_validation :normalize_collection_uuids
32 before_validation :set_default_owner
33 validate :ensure_valid_uuids
35 # Note: This only returns permission links. It does not account for
36 # permissions obtained via user.is_admin or
37 # user.uuid==object.owner_uuid.
38 has_many(:permissions,
39 ->{where(link_class: 'permission')},
40 foreign_key: :head_uuid,
44 class PermissionDeniedError < RequestError
50 class AlreadyLockedError < RequestError
56 class LockFailedError < RequestError
62 class InvalidStateTransitionError < RequestError
68 class UnauthorizedError < RequestError
74 class UnresolvableContainerError < RequestError
80 def self.kind_class(kind)
81 kind.match(/^arvados\#(.+)$/)[1].classify.safe_constantize rescue nil
85 "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}"
88 def self.permit_attribute_params raw_params
89 # strong_parameters does not provide security: permissions are
90 # implemented with before_save hooks.
92 # The following permit! is necessary even with
93 # "ActionController::Parameters.permit_all_parameters = true",
94 # because permit_all does not permit nested attributes.
96 serialized_attributes.each do |colname, coder|
97 param = raw_params[colname.to_sym]
100 elsif !param.is_a?(coder.object_class)
101 raise ArgumentError.new("#{colname} parameter must be #{coder.object_class}, not #{param.class}")
102 elsif has_nonstring_keys?(param)
103 raise ArgumentError.new("#{colname} parameter cannot have non-string hash keys")
107 ActionController::Parameters.new(raw_params).permit!
110 def initialize raw_params={}, *args
111 super(self.class.permit_attribute_params(raw_params), *args)
114 # Reload "old attributes" for logging, too.
120 def self.create raw_params={}, *args
121 super(permit_attribute_params(raw_params), *args)
124 def update_attributes raw_params={}, *args
125 super(self.class.permit_attribute_params(raw_params), *args)
128 def self.selectable_attributes(template=:user)
129 # Return an array of attribute name strings that can be selected
130 # in the given template.
131 api_accessible_attributes(template).map { |attr_spec| attr_spec.first.to_s }
134 def self.searchable_columns operator
135 textonly_operator = !operator.match(/[<=>]/)
136 self.columns.select do |col|
140 when :datetime, :integer, :boolean
148 def self.attribute_column attr
149 self.columns.select { |col| col.name == attr.to_s }.first
152 def self.attributes_required_columns
153 # This method returns a hash. Each key is the name of an API attribute,
154 # and it's mapped to a list of database columns that must be fetched
155 # to generate that attribute.
156 # This implementation generates a simple map of attributes to
157 # matching column names. Subclasses can override this method
158 # to specify that method-backed API attributes need to fetch
159 # specific columns from the database.
160 all_columns = columns.map(&:name)
161 api_column_map = Hash.new { |hash, key| hash[key] = [] }
162 methods.grep(/^api_accessible_\w+$/).each do |method_name|
163 next if method_name == :api_accessible_attributes
164 send(method_name).each_pair do |api_attr_name, col_name|
165 col_name = col_name.to_s
166 if all_columns.include?(col_name)
167 api_column_map[api_attr_name.to_s] |= [col_name]
174 def self.ignored_select_attributes
175 ["href", "kind", "etag"]
178 def self.columns_for_attributes(select_attributes)
179 if select_attributes.empty?
180 raise ArgumentError.new("Attribute selection list cannot be empty")
182 api_column_map = attributes_required_columns
184 select_attributes.each do |s|
185 next if ignored_select_attributes.include? s
186 if not s.is_a? String or not api_column_map.include? s
190 if not invalid_attrs.empty?
191 raise ArgumentError.new("Invalid attribute(s): #{invalid_attrs.inspect}")
193 # Given an array of attribute names to select, return an array of column
194 # names that must be fetched from the database to satisfy the request.
195 select_attributes.flat_map { |attr| api_column_map[attr] }.uniq
198 def self.default_orders
199 ["#{table_name}.modified_at desc", "#{table_name}.uuid"]
202 def self.unique_columns
206 def self.limit_index_columns_read
207 # This method returns a list of column names.
208 # If an index request reads that column from the database,
209 # APIs that return lists will only fetch objects until reaching
210 # max_index_database_read bytes of data from those columns.
214 # If current user can manage the object, return an array of uuids of
215 # users and groups that have permission to write the object. The
216 # first two elements are always [self.owner_uuid, current user's
219 # If current user can write but not manage the object, return
220 # [self.owner_uuid, current user's uuid].
222 # If current user cannot write this object, just return
225 return [owner_uuid] if not current_user
226 unless (owner_uuid == current_user.uuid or
227 current_user.is_admin or
228 (current_user.groups_i_can(:manage) & [uuid, owner_uuid]).any?)
229 if ((current_user.groups_i_can(:write) + [current_user.uuid]) &
230 [uuid, owner_uuid]).any?
231 return [owner_uuid, current_user.uuid]
236 [owner_uuid, current_user.uuid] + permissions.collect do |p|
237 if ['can_write', 'can_manage'].index p.name
243 # Return a query with read permissions restricted to the union of the
244 # permissions of the members of users_list, i.e. if something is readable by
245 # any user in users_list, it will be readable in the query returned by this
247 def self.readable_by(*users_list)
248 # Get rid of troublesome nils
251 # Load optional keyword arguments, if they exist.
252 if users_list.last.is_a? Hash
253 kwargs = users_list.pop
258 # Collect the UUIDs of the authorized users.
259 sql_table = kwargs.fetch(:table_name, table_name)
260 include_trash = kwargs.fetch(:include_trash, false)
261 include_old_versions = kwargs.fetch(:include_old_versions, false)
264 user_uuids = users_list.map { |u| u.uuid }
266 exclude_trashed_records = ""
267 if !include_trash and (sql_table == "groups" or sql_table == "collections") then
268 # Only include records that are not explicitly trashed
269 exclude_trashed_records = "AND #{sql_table}.is_trashed = false"
272 exclude_old_versions = ""
273 if !include_old_versions && sql_table == "collections"
274 exclude_old_versions = "AND #{sql_table}.uuid = #{sql_table}.current_version_uuid"
277 if users_list.select { |u| u.is_admin }.any?
278 # Admin skips most permission checks, but still want to filter on trashed items.
280 if sql_table != "api_client_authorizations"
281 # Only include records where the owner is not trashed
282 sql_conds = "NOT EXISTS(SELECT 1 FROM #{PERMISSION_VIEW} "+
283 "WHERE trashed = 1 AND "+
284 "(#{sql_table}.owner_uuid = target_uuid)) #{exclude_trashed_records}"
289 if !include_trash then
290 trashed_check = "AND trashed = 0"
293 # Note: it is possible to combine the direct_check and
294 # owner_check into a single EXISTS() clause, however it turns
295 # out query optimizer doesn't like it and forces a sequential
296 # table scan. Constructing the query with separate EXISTS()
297 # clauses enables it to use the index.
299 # see issue 13208 for details.
301 # Match a direct read permission link from the user to the record uuid
302 direct_check = "EXISTS(SELECT 1 FROM #{PERMISSION_VIEW} "+
303 "WHERE user_uuid IN (:user_uuids) AND perm_level >= 1 #{trashed_check} AND target_uuid = #{sql_table}.uuid)"
305 # Match a read permission link from the user to the record's owner_uuid
307 if sql_table != "api_client_authorizations" and sql_table != "groups" then
308 owner_check = "OR EXISTS(SELECT 1 FROM #{PERMISSION_VIEW} "+
309 "WHERE user_uuid IN (:user_uuids) AND perm_level >= 1 #{trashed_check} AND target_uuid = #{sql_table}.owner_uuid AND target_owner_uuid IS NOT NULL) "
313 if sql_table == "links"
314 # Match any permission link that gives one of the authorized
315 # users some permission _or_ gives anyone else permission to
316 # view one of the authorized users.
317 links_cond = "OR (#{sql_table}.link_class IN (:permission_link_classes) AND "+
318 "(#{sql_table}.head_uuid IN (:user_uuids) OR #{sql_table}.tail_uuid IN (:user_uuids)))"
321 sql_conds = "(#{direct_check} #{owner_check} #{links_cond}) #{exclude_trashed_records}"
325 if exclude_old_versions != ""
327 sql_conds = exclude_old_versions[4..-1] # Remove "AND "
329 sql_conds += " #{exclude_old_versions}"
333 self.where(sql_conds,
334 user_uuids: user_uuids,
335 permission_link_classes: ['permission', 'resources'])
338 def save_with_unique_name!
343 conn = ActiveRecord::Base.connection
344 conn.exec_query 'SAVEPOINT save_with_unique_name'
347 rescue ActiveRecord::RecordNotUnique => rn
348 raise if max_retries == 0
351 conn.exec_query 'ROLLBACK TO SAVEPOINT save_with_unique_name'
353 # Dig into the error to determine if it is specifically calling out a
354 # (owner_uuid, name) uniqueness violation. In this specific case, and
355 # the client requested a unique name with ensure_unique_name==true,
356 # update the name field and try to save again. Loop as necessary to
357 # discover a unique name. It is necessary to handle name choosing at
358 # this level (as opposed to the client) to ensure that record creation
359 # never fails due to a race condition.
360 err = rn.original_exception
361 raise unless err.is_a?(PG::UniqueViolation)
363 # Unfortunately ActiveRecord doesn't abstract out any of the
364 # necessary information to figure out if this the error is actually
365 # the specific case where we want to apply the ensure_unique_name
366 # behavior, so the following code is specialized to Postgres.
367 detail = err.result.error_field(PG::Result::PG_DIAG_MESSAGE_DETAIL)
368 raise unless /^Key \(owner_uuid, name\)=\([a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{15}, .*?\) already exists\./.match detail
370 new_name = "#{name_was} (#{db_current_time.utc.iso8601(3)})"
372 # If the database is fast enough to do two attempts in the
373 # same millisecond, we need to wait to ensure we try a
374 # different timestamp on each attempt.
376 new_name = "#{name_was} (#{db_current_time.utc.iso8601(3)})"
379 self[:name] = new_name
380 if uuid_was.nil? && !uuid.nil?
382 if self.is_a? Collection
383 # Reset so that is assigned to the new UUID
384 self[:current_version_uuid] = nil
387 conn.exec_query 'SAVEPOINT save_with_unique_name'
390 conn.exec_query 'RELEASE SAVEPOINT save_with_unique_name'
395 def logged_attributes
396 attributes.except(*Rails.configuration.unlogged_attributes)
399 def self.full_text_searchable_columns
400 self.columns.select do |col|
401 [:string, :text, :jsonb].include?(col.type)
405 def self.full_text_tsvector
406 parts = full_text_searchable_columns.collect do |column|
407 cast = serialized_attributes[column] ? '::text' : ''
408 "coalesce(#{column}#{cast},'')"
410 "to_tsvector('english', #{parts.join(" || ' ' || ")})"
413 def self.apply_filters query, filters
414 ft = record_filters filters, self
415 if not ft[:cond_out].any?
418 query.where('(' + ft[:cond_out].join(') AND (') + ')',
424 def self.deep_sort_hash(x)
426 x.sort.collect do |k, v|
427 [k, deep_sort_hash(v)]
430 x.collect { |v| deep_sort_hash(v) }
436 def ensure_ownership_path_leads_to_user
437 if new_record? or owner_uuid_changed?
438 uuid_in_path = {owner_uuid => true, uuid => true}
440 while (owner_class = ArvadosModel::resource_class_for_uuid(x)) != User
443 # Test for cycles with the new version, not the DB contents
445 elsif !owner_class.respond_to? :find_by_uuid
446 raise ActiveRecord::RecordNotFound.new
448 x = owner_class.find_by_uuid(x).owner_uuid
450 rescue ActiveRecord::RecordNotFound => e
451 errors.add :owner_uuid, "is not owned by any user: #{e}"
456 errors.add :owner_uuid, "would create an ownership cycle"
458 errors.add :owner_uuid, "has an ownership cycle"
462 uuid_in_path[x] = true
468 def set_default_owner
469 if new_record? and current_user and respond_to? :owner_uuid=
470 self.owner_uuid ||= current_user.uuid
474 def ensure_owner_uuid_is_permitted
475 raise PermissionDeniedError if !current_user
477 if self.owner_uuid.nil?
478 errors.add :owner_uuid, "cannot be nil"
479 raise PermissionDeniedError
482 rsc_class = ArvadosModel::resource_class_for_uuid owner_uuid
483 unless rsc_class == User or rsc_class == Group
484 errors.add :owner_uuid, "must be set to User or Group"
485 raise PermissionDeniedError
488 if new_record? || owner_uuid_changed?
489 # Permission on owner_uuid_was is needed to move an existing
490 # object away from its previous owner (which implies permission
491 # to modify this object itself, so we don't need to check that
492 # separately). Permission on the new owner_uuid is also needed.
493 [['old', owner_uuid_was],
495 ].each do |which, check_uuid|
497 # old_owner_uuid is nil? New record, no need to check.
498 elsif !current_user.can?(write: check_uuid)
499 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}"
500 errors.add :owner_uuid, "cannot be set or changed without write permission on #{which} owner"
501 raise PermissionDeniedError
505 # If the object already existed and we're not changing
506 # owner_uuid, we only need write permission on the object
508 if !current_user.can?(write: self.uuid)
509 logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{self.uuid} without write permission"
510 errors.add :uuid, "is not writable"
511 raise PermissionDeniedError
518 def ensure_permission_to_save
519 unless (new_record? ? permission_to_create : permission_to_update)
520 raise PermissionDeniedError
524 def permission_to_create
525 current_user.andand.is_active
528 def permission_to_update
530 logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
533 if !current_user.is_active
534 logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
537 return true if current_user.is_admin
538 if self.uuid_changed?
539 logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
545 def ensure_permission_to_destroy
546 raise PermissionDeniedError unless permission_to_destroy
549 def permission_to_destroy
553 def maybe_update_modified_by_fields
554 update_modified_by_fields if self.changed? or self.new_record?
558 def update_modified_by_fields
559 current_time = db_current_time
560 self.created_at ||= created_at_was || current_time
561 self.updated_at = current_time
562 self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid=
563 if !anonymous_updater
564 self.modified_by_user_uuid = current_user ? current_user.uuid : nil
565 self.modified_at = current_time
567 self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
571 def self.has_nonstring_keys? x
574 return true if !(k.is_a?(String) || k.is_a?(Symbol)) || has_nonstring_keys?(v)
578 return true if has_nonstring_keys?(v)
584 def self.has_symbols? x
587 return true if has_symbols?(k) or has_symbols?(v)
591 return true if has_symbols?(k)
596 return true if x.start_with?(':') && !x.start_with?('::')
601 def self.recursive_stringify x
603 Hash[x.collect do |k,v|
604 [recursive_stringify(k), recursive_stringify(v)]
608 recursive_stringify k
612 elsif x.is_a? String and x.start_with?(':') and !x.start_with?('::')
619 def self.where_serialized(colname, value, md5: false)
620 colsql = colname.to_s
622 colsql = "md5(#{colsql})"
625 # rails4 stores as null, rails3 stored as serialized [] or {}
626 sql = "#{colsql} is null or #{colsql} IN (?)"
629 sql = "#{colsql} IN (?)"
630 sorted = deep_sort_hash(value)
632 params = [sorted.to_yaml, SafeJSON.dump(sorted)]
634 params = params.map { |x| Digest::MD5.hexdigest(x) }
640 Hash => HashSerializer,
641 Array => ArraySerializer,
644 def self.serialize(colname, type)
645 coder = Serializer[type]
646 @serialized_attributes ||= {}
647 @serialized_attributes[colname.to_s] = coder
648 super(colname, coder)
651 def self.serialized_attributes
652 @serialized_attributes ||= {}
655 def serialized_attributes
656 self.class.serialized_attributes
659 def convert_serialized_symbols_to_strings
660 # ensure_serialized_attribute_type should prevent symbols from
661 # getting into the database in the first place. If someone managed
662 # to get them into the database (perhaps using an older version)
663 # we'll convert symbols to strings when loading from the
664 # database. (Otherwise, loading and saving an object with existing
665 # symbols in a serialized field will crash.)
666 self.class.serialized_attributes.each do |colname, attr|
667 if self.class.has_symbols? attributes[colname]
668 attributes[colname] = self.class.recursive_stringify attributes[colname]
670 self.class.recursive_stringify(attributes[colname]))
675 def foreign_key_attributes
676 attributes.keys.select { |a| a.match(/_uuid$/) }
679 def skip_uuid_read_permission_check
680 %w(modified_by_client_uuid)
683 def skip_uuid_existence_check
687 def normalize_collection_uuids
688 foreign_key_attributes.each do |attr|
689 attr_value = send attr
690 if attr_value.is_a? String and
691 attr_value.match(/^[0-9a-f]{32,}(\+[@\w]+)*$/)
693 send "#{attr}=", Collection.normalize_uuid(attr_value)
695 # TODO: abort instead of silently accepting unnormalizable value?
701 @@prefixes_hash = nil
702 def self.uuid_prefixes
703 unless @@prefixes_hash
705 Rails.application.eager_load!
706 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
707 if k.respond_to?(:uuid_prefix)
708 @@prefixes_hash[k.uuid_prefix] = k
715 def self.uuid_like_pattern
716 "#{Rails.configuration.uuid_prefix}-#{uuid_prefix}-_______________"
720 %r/[a-z0-9]{5}-#{uuid_prefix}-[a-z0-9]{15}/
723 def ensure_valid_uuids
724 specials = [system_user_uuid]
726 foreign_key_attributes.each do |attr|
727 if new_record? or send (attr + "_changed?")
728 next if skip_uuid_existence_check.include? attr
729 attr_value = send attr
730 next if specials.include? attr_value
732 if (r = ArvadosModel::resource_class_for_uuid attr_value)
733 unless skip_uuid_read_permission_check.include? attr
734 r = r.readable_by(current_user)
736 if r.where(uuid: attr_value).count == 0
737 errors.add(attr, "'#{attr_value}' not found")
754 def self.readable_by (*u)
759 [{:uuid => u[:uuid]}]
763 def self.resource_class_for_uuid(uuid)
764 if uuid.is_a? ArvadosModel
767 unless uuid.is_a? String
771 uuid.match HasUuid::UUID_REGEX do |re|
772 return uuid_prefixes[re[1]] if uuid_prefixes[re[1]]
775 if uuid.match(/.+@.+/)
782 # ArvadosModel.find_by_uuid needs extra magic to allow it to return
783 # an object in any class.
784 def self.find_by_uuid uuid
785 if self == ArvadosModel
786 # If called directly as ArvadosModel.find_by_uuid rather than via subclass,
787 # delegate to the appropriate subclass based on the given uuid.
788 self.resource_class_for_uuid(uuid).find_by_uuid(uuid)
794 def is_audit_logging_enabled?
795 return !(Rails.configuration.max_audit_log_age.to_i == 0 &&
796 Rails.configuration.max_audit_log_delete_batch.to_i > 0)
800 if is_audit_logging_enabled?
801 @old_attributes = Marshal.load(Marshal.dump(attributes))
802 @old_logged_attributes = Marshal.load(Marshal.dump(logged_attributes))
806 def log_change(event_type)
807 if is_audit_logging_enabled?
808 log = Log.new(event_type: event_type).fill_object(self)
816 if is_audit_logging_enabled?
817 log_change('create') do |log|
818 log.fill_properties('old', nil, nil)
825 if is_audit_logging_enabled?
826 log_change('update') do |log|
827 log.fill_properties('old', etag(@old_attributes), @old_logged_attributes)
834 if is_audit_logging_enabled?
835 log_change('delete') do |log|
836 log.fill_properties('old', etag(@old_attributes), @old_logged_attributes)