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 < ApplicationRecord
12 self.abstract_class = true
14 include ArvadosModelUpdates
15 include CurrentApiClient # current_user, current_api_client, etc.
19 after_find :schedule_restoring_changes
20 after_initialize :log_start_state
21 before_save :ensure_permission_to_save
22 before_save :ensure_owner_uuid_is_permitted
23 before_save :ensure_ownership_path_leads_to_user
24 before_destroy :ensure_owner_uuid_is_permitted
25 before_destroy :ensure_permission_to_destroy
26 before_create :update_modified_by_fields
27 before_create :add_uuid_to_name, :if => Proc.new { @_add_uuid_to_name }
28 before_update :maybe_update_modified_by_fields
29 after_create :log_create
30 after_update :log_update
31 after_destroy :log_destroy
32 before_validation :normalize_collection_uuids
33 before_validation :set_default_owner
34 validate :ensure_valid_uuids
36 # Note: This only returns permission links. It does not account for
37 # permissions obtained via user.is_admin or
38 # user.uuid==object.owner_uuid.
39 has_many(:permissions,
40 ->{where(link_class: 'permission')},
41 foreign_key: 'head_uuid',
45 # If async is true at create or update, permission graph
46 # update is deferred allowing making multiple calls without the performance
48 attr_accessor :async_permissions_update
50 # Ignore listed attributes on mass assignments
51 def self.protected_attributes
55 class PermissionDeniedError < RequestError
61 class AlreadyLockedError < RequestError
67 class LockFailedError < RequestError
73 class InvalidStateTransitionError < RequestError
79 class UnauthorizedError < RequestError
85 class UnresolvableContainerError < RequestError
91 def self.kind_class(kind)
92 kind.match(/^arvados\#(.+)$/)[1].classify.safe_constantize rescue nil
96 "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}"
99 def self.permit_attribute_params raw_params
100 # strong_parameters does not provide security: permissions are
101 # implemented with before_save hooks.
103 # The following permit! is necessary even with
104 # "ActionController::Parameters.permit_all_parameters = true",
105 # because permit_all does not permit nested attributes.
109 raw_params = raw_params.to_hash
110 raw_params.delete_if { |k, _| self.protected_attributes.include? k }
111 serialized_attributes.each do |colname, coder|
112 param = raw_params[colname.to_sym]
115 elsif !param.is_a?(coder.object_class)
116 raise ArgumentError.new("#{colname} parameter must be #{coder.object_class}, not #{param.class}")
117 elsif has_nonstring_keys?(param)
118 raise ArgumentError.new("#{colname} parameter cannot have non-string hash keys")
121 # Check JSONB columns that aren't listed on serialized_attributes
122 columns.select{|c| c.type == :jsonb}.collect{|j| j.name}.each do |colname|
123 if serialized_attributes.include? colname || raw_params[colname.to_sym].nil?
126 if has_nonstring_keys?(raw_params[colname.to_sym])
127 raise ArgumentError.new("#{colname} parameter cannot have non-string hash keys")
131 ActionController::Parameters.new(raw_params).permit!
134 def initialize raw_params={}, *args
135 super(self.class.permit_attribute_params(raw_params), *args)
138 # Reload "old attributes" for logging, too.
145 def self.create raw_params={}, *args
146 super(permit_attribute_params(raw_params), *args)
149 def update raw_params={}, *args
150 super(self.class.permit_attribute_params(raw_params), *args)
153 def self.selectable_attributes(template=:user)
154 # Return an array of attribute name strings that can be selected
155 # in the given template.
156 api_accessible_attributes(template).map { |attr_spec| attr_spec.first.to_s }
159 def self.searchable_columns operator
160 textonly_operator = !operator.match(/[<=>]/) && !operator.in?(['in', 'not in'])
161 self.columns.select do |col|
165 when :datetime, :integer, :boolean
173 def self.attribute_column attr
174 self.columns.select { |col| col.name == attr.to_s }.first
177 def self.attributes_required_columns
178 # This method returns a hash. Each key is the name of an API attribute,
179 # and it's mapped to a list of database columns that must be fetched
180 # to generate that attribute.
181 # This implementation generates a simple map of attributes to
182 # matching column names. Subclasses can override this method
183 # to specify that method-backed API attributes need to fetch
184 # specific columns from the database.
185 all_columns = columns.map(&:name)
186 api_column_map = Hash.new { |hash, key| hash[key] = [] }
187 methods.grep(/^api_accessible_\w+$/).each do |method_name|
188 next if method_name == :api_accessible_attributes
189 send(method_name).each_pair do |api_attr_name, col_name|
190 col_name = col_name.to_s
191 if all_columns.include?(col_name)
192 api_column_map[api_attr_name.to_s] |= [col_name]
199 def self.ignored_select_attributes
200 ["href", "kind", "etag"]
203 def self.columns_for_attributes(select_attributes)
204 if select_attributes.empty?
205 raise ArgumentError.new("Attribute selection list cannot be empty")
207 api_column_map = attributes_required_columns
209 select_attributes.each do |s|
210 next if ignored_select_attributes.include? s
211 if not s.is_a? String or not api_column_map.include? s
215 if not invalid_attrs.empty?
216 raise ArgumentError.new("Invalid attribute(s): #{invalid_attrs.inspect}")
218 # Given an array of attribute names to select, return an array of column
219 # names that must be fetched from the database to satisfy the request.
220 select_attributes.flat_map { |attr| api_column_map[attr] }.uniq
223 def self.default_orders
224 ["#{table_name}.modified_at desc", "#{table_name}.uuid desc"]
227 def self.unique_columns
231 def self.limit_index_columns_read
232 # This method returns a list of column names.
233 # If an index request reads that column from the database,
234 # APIs that return lists will only fetch objects until reaching
235 # max_index_database_read bytes of data from those columns.
239 # If current user can manage the object, return an array of uuids of
240 # users and groups that have permission to write the object. The
241 # first two elements are always [self.owner_uuid, current user's
244 # If current user can write but not manage the object, return
245 # [self.owner_uuid, current user's uuid].
247 # If current user cannot write this object, just return
250 # Return [] if this is a frozen project and the current user can't
252 return [] if respond_to?(:frozen_by_uuid) && frozen_by_uuid &&
253 (Rails.configuration.API.UnfreezeProjectRequiresAdmin ?
254 !current_user.andand.is_admin :
255 !current_user.can?(manage: uuid))
256 # Return [] if nobody can write because this object is inside a
258 return [] if FrozenGroup.where(uuid: owner_uuid).any?
259 return [owner_uuid] if not current_user
260 unless (owner_uuid == current_user.uuid or
261 current_user.is_admin or
262 (current_user.groups_i_can(:manage) & [uuid, owner_uuid]).any?)
263 if ((current_user.groups_i_can(:write) + [current_user.uuid]) &
264 [uuid, owner_uuid]).any?
265 return [owner_uuid, current_user.uuid]
270 [owner_uuid, current_user.uuid] + permissions.collect do |p|
271 if ['can_write', 'can_manage'].index p.name
278 if respond_to?(:frozen_by_uuid) && frozen_by_uuid
279 # This special case is needed to return the correct value from a
280 # "freeze project" API, during which writable status changes
281 # from true to false.
283 # current_user.can?(write: self) returns true (which is correct
284 # in the context of permission-checking hooks) but the can_write
285 # value we're returning to the caller here represents the state
286 # _after_ the update, i.e., false.
289 return current_user.can?(write: self)
294 return current_user.can?(manage: self)
297 # Return a query with read permissions restricted to the union of the
298 # permissions of the members of users_list, i.e. if something is readable by
299 # any user in users_list, it will be readable in the query returned by this
301 def self.readable_by(*users_list)
302 # Get rid of troublesome nils
305 # Load optional keyword arguments, if they exist.
306 if users_list.last.is_a? Hash
307 kwargs = users_list.pop
312 # Collect the UUIDs of the authorized users.
313 sql_table = kwargs.fetch(:table_name, table_name)
314 include_trash = kwargs.fetch(:include_trash, false)
315 include_old_versions = kwargs.fetch(:include_old_versions, false)
318 user_uuids = users_list.map { |u| u.uuid }
321 admin = users_list.select { |u| u.is_admin }.any?
323 # For details on how the trashed_groups table is constructed, see
324 # see db/migrate/20200501150153_permission_table.rb
326 # excluded_trash is a SQL expression that determines whether a row
327 # should be excluded from the results due to being trashed.
328 # Trashed items inside frozen projects are invisible to regular
329 # (non-admin) users even when using include_trash, so we have:
331 # (item_trashed || item_inside_trashed_project)
333 # (!caller_requests_include_trash ||
334 # (item_inside_frozen_project && caller_is_not_admin))
335 if (admin && include_trash) || sql_table == "api_client_authorizations"
336 excluded_trash = "false"
338 excluded_trash = "(#{sql_table}.owner_uuid IN (SELECT group_uuid FROM #{TRASHED_GROUPS} " +
339 "WHERE trash_at <= statement_timestamp()))"
340 if sql_table == "groups" || sql_table == "collections"
341 excluded_trash = "(#{excluded_trash} OR #{sql_table}.trash_at <= statement_timestamp() IS TRUE)"
345 # Exclude trash inside frozen projects
346 excluded_trash = "(#{excluded_trash} AND #{sql_table}.owner_uuid IN (SELECT uuid FROM #{FROZEN_GROUPS}))"
351 # Admin skips most permission checks, but still want to filter
353 if !include_trash && sql_table != "api_client_authorizations"
354 # Only include records where the owner is not trashed
355 sql_conds = "NOT (#{excluded_trash})"
358 # The core of the permission check is a join against the
359 # materialized_permissions table to determine if the user has at
360 # least read permission to either the object itself or its
361 # direct owner (if traverse_owned is true). See
362 # db/migrate/20200501150153_permission_table.rb for details on
363 # how the permissions are computed.
365 # A user can have can_manage access to another user, this grants
366 # full access to all that user's stuff. To implement that we
367 # need to include those other users in the permission query.
369 # This was previously implemented by embedding the subquery
370 # directly into the query, but it was discovered later that this
371 # causes the Postgres query planner to do silly things because
372 # the query heuristics assumed the subquery would have a lot
373 # more rows that it does, and choose a bad merge strategy. By
374 # doing the query here and embedding the result as a constant,
375 # Postgres also knows exactly how many items there are and can
376 # choose the right query strategy.
378 # (note: you could also do this with a temporary table, but that
379 # would require all every request be wrapped in a transaction,
380 # which is not currently the case).
382 all_user_uuids = ActiveRecord::Base.connection.exec_query %{
383 #{USER_UUIDS_SUBQUERY_TEMPLATE % {user: "'#{user_uuids.join "', '"}'", perm_level: 1}}
385 'readable_by.user_uuids'
387 user_uuids_subquery = ":user_uuids"
389 # Note: it is possible to combine the direct_check and
390 # owner_check into a single IN (SELECT) clause, however it turns
391 # out query optimizer doesn't like it and forces a sequential
392 # table scan. Constructing the query with separate IN (SELECT)
393 # clauses enables it to use the index.
395 # see issue 13208 for details.
397 # Match a direct read permission link from the user to the record uuid
398 direct_check = "#{sql_table}.uuid IN (SELECT target_uuid FROM #{PERMISSION_VIEW} "+
399 "WHERE user_uuid IN (#{user_uuids_subquery}) AND perm_level >= 1)"
401 # Match a read permission for the user to the record's
402 # owner_uuid. This is so we can have a permissions table that
403 # mostly consists of users and groups (projects are a type of
404 # group) and not have to compute and list user permission to
405 # every single object in the system.
407 # Don't do this for API keys (special behavior) or groups
408 # (already covered by direct_check).
410 # The traverse_owned flag indicates whether the permission to
411 # read an object also implies transitive permission to read
412 # things the object owns. The situation where this is important
413 # are determining if we can read an object owned by another
414 # user. This makes it possible to have permission to read the
415 # user record without granting permission to read things the
418 if sql_table != "api_client_authorizations" and sql_table != "groups" then
419 owner_check = "#{sql_table}.owner_uuid IN (SELECT target_uuid FROM #{PERMISSION_VIEW} "+
420 "WHERE user_uuid IN (#{user_uuids_subquery}) AND perm_level >= 1 AND traverse_owned) "
422 # We want to do owner_check before direct_check in the OR
423 # clause. The order of the OR clause isn't supposed to
424 # matter, but in practice, it does -- apparently in the
425 # absence of other hints, it uses the ordering from the query.
426 # For certain types of queries (like filtering on owner_uuid),
427 # every item will match the owner_check clause, so then
428 # Postgres will optimize out the direct_check entirely.
429 direct_check = " OR " + direct_check
432 if Rails.configuration.Users.RoleGroupsVisibleToAll &&
433 sql_table == "groups" &&
434 users_list.select { |u| u.is_active }.any?
435 # All role groups are readable (but we still need the other
436 # direct_check clauses to handle non-role groups).
437 direct_check += " OR #{sql_table}.group_class = 'role'"
441 if sql_table == "links"
442 # 1) Match permission links incoming or outgoing on the
443 # user, i.e. granting permission on the user, or granting
444 # permission to the user.
446 # 2) Match permission links which grant permission on an
447 # object that this user can_manage.
449 links_cond = "OR (#{sql_table}.link_class IN (:permission_link_classes) AND "+
450 " ((#{sql_table}.head_uuid IN (#{user_uuids_subquery}) OR #{sql_table}.tail_uuid IN (#{user_uuids_subquery})) OR " +
451 " #{sql_table}.head_uuid IN (SELECT target_uuid FROM #{PERMISSION_VIEW} "+
452 " WHERE user_uuid IN (#{user_uuids_subquery}) AND perm_level >= 3))) "
455 sql_conds = "(#{owner_check} #{direct_check} #{links_cond}) AND NOT (#{excluded_trash})"
459 if !include_old_versions && sql_table == "collections"
460 exclude_old_versions = "#{sql_table}.uuid = #{sql_table}.current_version_uuid"
462 sql_conds = exclude_old_versions
464 sql_conds += " AND #{exclude_old_versions}"
468 return self if sql_conds == nil
469 self.where(sql_conds,
470 user_uuids: all_user_uuids.collect{|c| c["target_uuid"]},
471 permission_link_classes: ['permission'])
474 def save_with_unique_name!
477 conn = ActiveRecord::Base.connection
478 conn.exec_query 'SAVEPOINT save_with_unique_name'
481 conn.exec_query 'RELEASE SAVEPOINT save_with_unique_name'
482 rescue ActiveRecord::RecordNotUnique => rn
483 raise if max_retries == 0
486 # Dig into the error to determine if it is specifically calling out a
487 # (owner_uuid, name) uniqueness violation. In this specific case, and
488 # the client requested a unique name with ensure_unique_name==true,
489 # update the name field and try to save again. Loop as necessary to
490 # discover a unique name. It is necessary to handle name choosing at
491 # this level (as opposed to the client) to ensure that record creation
492 # never fails due to a race condition.
494 raise unless err.is_a?(PG::UniqueViolation)
496 # Unfortunately ActiveRecord doesn't abstract out any of the
497 # necessary information to figure out if this the error is actually
498 # the specific case where we want to apply the ensure_unique_name
499 # behavior, so the following code is specialized to Postgres.
500 detail = err.result.error_field(PG::Result::PG_DIAG_MESSAGE_DETAIL)
501 raise unless /^Key \(owner_uuid, name\)=\([a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{15}, .*?\) already exists\./.match detail
503 conn.exec_query 'ROLLBACK TO SAVEPOINT save_with_unique_name'
506 # new record, the uuid caused a name collision (very
507 # unlikely but possible), so generate new uuid
509 if self.is_a? Collection
510 # Also needs to be reset
511 self[:current_version_uuid] = nil
513 # need to adjust the name after the uuid has been generated
514 add_uuid_to_make_unique_name
516 # existing record, just update the name directly.
525 if self.owner_uuid.nil?
526 return current_user.uuid
528 owner_class = ArvadosModel.resource_class_for_uuid(self.owner_uuid)
529 if owner_class == User
532 owner_class.find_by_uuid(self.owner_uuid).user_owner_uuid
536 def logged_attributes
537 attributes.except(*Rails.configuration.AuditLogs.UnloggedAttributes.stringify_keys.keys)
540 def self.full_text_searchable_columns
541 self.columns.select do |col|
542 [:string, :text, :jsonb].include?(col.type) and
543 col.name !~ /(^|_)(hash|uuid)$/
547 def self.full_text_coalesce
548 full_text_searchable_columns.collect do |column|
549 is_jsonb = self.columns.select{|x|x.name == column}[0].type == :jsonb
550 cast = (is_jsonb || serialized_attributes[column]) ? '::text' : ''
551 "coalesce(#{column}#{cast},'')"
555 def self.full_text_trgm
556 "(#{full_text_coalesce.join(" || ' ' || ")})"
559 def self.full_text_tsvector
560 parts = full_text_searchable_columns.collect do |column|
561 is_jsonb = self.columns.select{|x|x.name == column}[0].type == :jsonb
562 cast = (is_jsonb || serialized_attributes[column]) ? '::text' : ''
563 "coalesce(#{column}#{cast},'')"
565 "to_tsvector('english', substr(#{parts.join(" || ' ' || ")}, 0, 8000))"
568 def self.apply_filters query, filters
569 ft = record_filters filters, self
570 if not ft[:cond_out].any?
573 ft[:joins].each do |t|
574 query = query.joins(t)
576 query.where('(' + ft[:cond_out].join(') AND (') + ')',
580 @_add_uuid_to_name = false
581 def add_uuid_to_make_unique_name
582 @_add_uuid_to_name = true
586 # Incorporate the random part of the UUID into the name. This
587 # lets us prevent name collision but the part we add to the name
588 # is still somewhat meaningful (instead of generating a second
589 # random meaningless string).
591 # Because ArvadosModel is an abstract class and assign_uuid is
592 # part of HasUuid (which is included by the other concrete
593 # classes) the assign_uuid hook gets added (and run) after this
594 # one. So we need to call assign_uuid here to make sure we have a
597 self.name = "#{self.name[0..236]} (#{self.uuid[-15..-1]})"
602 def self.deep_sort_hash(x)
604 x.sort.collect do |k, v|
605 [k, deep_sort_hash(v)]
608 x.collect { |v| deep_sort_hash(v) }
614 def ensure_ownership_path_leads_to_user
615 if new_record? or owner_uuid_changed?
616 uuid_in_path = {owner_uuid => true, uuid => true}
618 while (owner_class = ArvadosModel::resource_class_for_uuid(x)) != User
621 # Test for cycles with the new version, not the DB contents
623 elsif !owner_class.respond_to? :find_by_uuid
624 raise ActiveRecord::RecordNotFound.new
626 x = owner_class.find_by_uuid(x).owner_uuid
628 rescue ActiveRecord::RecordNotFound => e
629 errors.add :owner_uuid, "is not owned by any user: #{e}"
634 errors.add :owner_uuid, "would create an ownership cycle"
636 errors.add :owner_uuid, "has an ownership cycle"
640 uuid_in_path[x] = true
646 def set_default_owner
647 if new_record? and current_user and respond_to? :owner_uuid=
648 self.owner_uuid ||= current_user.uuid
652 def ensure_owner_uuid_is_permitted
653 raise PermissionDeniedError if !current_user
655 if self.owner_uuid.nil?
656 errors.add :owner_uuid, "cannot be nil"
657 raise PermissionDeniedError
660 rsc_class = ArvadosModel::resource_class_for_uuid owner_uuid
661 unless rsc_class == User or rsc_class == Group
662 errors.add :owner_uuid, "must be set to User or Group"
663 raise PermissionDeniedError
666 if new_record? || owner_uuid_changed?
667 # Permission on owner_uuid_was is needed to move an existing
668 # object away from its previous owner (which implies permission
669 # to modify this object itself, so we don't need to check that
670 # separately). Permission on the new owner_uuid is also needed.
671 [['old', owner_uuid_was],
673 ].each do |which, check_uuid|
675 # old_owner_uuid is nil? New record, no need to check.
676 elsif !current_user.can?(write: check_uuid)
677 if FrozenGroup.where(uuid: check_uuid).any?
678 errors.add :owner_uuid, "cannot be set or changed because #{which} owner is frozen"
680 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}"
681 errors.add :owner_uuid, "cannot be set or changed without write permission on #{which} owner"
683 raise PermissionDeniedError
684 elsif rsc_class == Group && Group.find_by_uuid(owner_uuid).group_class != "project"
685 errors.add :owner_uuid, "must be a project"
686 raise PermissionDeniedError
690 # If the object already existed and we're not changing
691 # owner_uuid, we only need write permission on the object
692 # itself. (If we're in the act of unfreezing, we only need
693 # :unfreeze permission, which means "what write permission would
694 # be if target weren't frozen")
695 unless ((respond_to?(:frozen_by_uuid) && frozen_by_uuid_was && !frozen_by_uuid) ?
696 current_user.can?(unfreeze: uuid) :
697 current_user.can?(write: uuid))
698 logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{self.uuid} without write permission"
699 errors.add :uuid, " #{uuid} is not writable by #{current_user.uuid}"
700 raise PermissionDeniedError
707 def ensure_permission_to_save
708 unless (new_record? ? permission_to_create : permission_to_update)
709 raise PermissionDeniedError
713 def permission_to_create
714 return current_user.andand.is_active
717 def permission_to_update
719 logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
722 if !current_user.is_active
723 logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
726 return true if current_user.is_admin
727 if self.uuid_changed?
728 logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
734 def ensure_permission_to_destroy
735 raise PermissionDeniedError unless permission_to_destroy
738 def permission_to_destroy
739 if [system_user_uuid, system_group_uuid, anonymous_group_uuid,
740 anonymous_user_uuid, public_project_uuid].include? uuid
747 def maybe_update_modified_by_fields
748 update_modified_by_fields if self.changed? or self.new_record?
752 def update_modified_by_fields
753 current_time = db_current_time
754 self.created_at ||= created_at_was || current_time
755 self.updated_at = current_time
756 self.owner_uuid ||= current_user.uuid if current_user && self.respond_to?(:owner_uuid=)
757 if !anonymous_updater
758 self.modified_by_user_uuid = current_user ? current_user.uuid : nil
761 self.modified_at = current_time
763 self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
767 def self.has_nonstring_keys? x
770 return true if !(k.is_a?(String) || k.is_a?(Symbol)) || has_nonstring_keys?(v)
774 return true if has_nonstring_keys?(v)
780 def self.where_serialized(colname, value, md5: false, multivalue: false)
781 colsql = colname.to_s
783 colsql = "md5(#{colsql})"
786 # rails4 stores as null, rails3 stored as serialized [] or {}
787 sql = "#{colsql} is null or #{colsql} IN (?)"
790 sql = "#{colsql} IN (?)"
791 sorted = deep_sort_hash(value)
797 params << SafeJSON.dump(v)
800 params << sorted.to_yaml
801 params << SafeJSON.dump(sorted)
804 params = params.map { |x| Digest::MD5.hexdigest(x) }
810 Hash => HashSerializer,
811 Array => ArraySerializer,
814 def self.serialize(colname, type)
815 coder = Serializer[type]
816 @serialized_attributes ||= {}
817 @serialized_attributes[colname.to_s] = coder
818 super(colname, coder)
821 def self.serialized_attributes
822 @serialized_attributes ||= {}
825 def serialized_attributes
826 self.class.serialized_attributes
829 def foreign_key_attributes
830 attributes.keys.select { |a| a.match(/_uuid$/) }
833 def skip_uuid_read_permission_check
834 %w(modified_by_client_uuid)
837 def skip_uuid_existence_check
841 def normalize_collection_uuids
842 foreign_key_attributes.each do |attr|
843 attr_value = send attr
844 if attr_value.is_a? String and
845 attr_value.match(/^[0-9a-f]{32,}(\+[@\w]+)*$/)
847 send "#{attr}=", Collection.normalize_uuid(attr_value)
849 # TODO: abort instead of silently accepting unnormalizable value?
855 @@prefixes_hash = nil
856 def self.uuid_prefixes
857 unless @@prefixes_hash
859 Rails.application.eager_load!
860 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
861 if k.respond_to?(:uuid_prefix)
862 @@prefixes_hash[k.uuid_prefix] = k
869 def self.uuid_like_pattern
870 "#{Rails.configuration.ClusterID}-#{uuid_prefix}-_______________"
874 %r/[a-z0-9]{5}-#{uuid_prefix}-[a-z0-9]{15}/
877 def check_readable_uuid attr, attr_value
878 return if attr_value.nil?
879 if (r = ArvadosModel::resource_class_for_uuid attr_value)
880 unless skip_uuid_read_permission_check.include? attr
881 r = r.readable_by(current_user)
883 if r.where(uuid: attr_value).count == 0
884 errors.add(attr, "'#{attr_value}' not found")
887 # Not a valid uuid or PDH, but that (currently) is not an error.
891 def ensure_valid_uuids
892 specials = [system_user_uuid]
894 foreign_key_attributes.each do |attr|
895 if new_record? or send (attr + "_changed?")
896 next if skip_uuid_existence_check.include? attr
897 attr_value = send attr
898 next if specials.include? attr_value
899 check_readable_uuid attr, attr_value
904 def ensure_filesystem_compatible_name
905 if name == "." || name == ".."
906 errors.add(:name, "cannot be '.' or '..'")
907 elsif Rails.configuration.Collections.ForwardSlashNameSubstitution == "" && !name.nil? && name.index('/')
908 errors.add(:name, "cannot contain a '/' character")
921 def self.readable_by (*u)
926 [{:uuid => u[:uuid]}]
930 def self.resource_class_for_uuid(uuid)
931 if uuid.is_a? ArvadosModel
934 unless uuid.is_a? String
938 uuid.match HasUuid::UUID_REGEX do |re|
939 return uuid_prefixes[re[1]] if uuid_prefixes[re[1]]
942 if uuid.match(/.+@.+/)
949 # Fill in implied zero/false values in database records that were
950 # created before #17014 made them explicit, and reset the Rails
951 # "changed" state so the record doesn't appear to have been modified
954 # Invoked by Container and ContainerRequest models as an after_find
956 def fill_container_defaults_after_find
957 fill_container_defaults
958 clear_changes_information
961 # Fill in implied zero/false values. Invoked by ContainerRequest as
962 # a before_validation hook in order to (a) ensure every key has a
963 # value in the updated database record and (b) ensure the attribute
964 # whitelist doesn't reject a change from an explicit zero/false
965 # value in the database to an implicit zero/false value in an update
967 def fill_container_defaults
968 # Make sure this is correctly sorted by key, because we merge in
969 # whatever is in the database on top of it, this will be the order
970 # that gets used downstream rather than the order the keys appear
972 self.runtime_constraints = {
976 'driver_version' => '',
977 'hardware_capability' => '',
979 'keep_cache_disk' => 0,
980 'keep_cache_ram' => 0,
983 }.merge(attributes['runtime_constraints'] || {})
984 self.scheduling_parameters = {
987 'preemptible' => false,
988 'supervisor' => false,
989 }.merge(attributes['scheduling_parameters'] || {})
992 # ArvadosModel.find_by_uuid needs extra magic to allow it to return
993 # an object in any class.
994 def self.find_by_uuid uuid
995 if self == ArvadosModel
996 # If called directly as ArvadosModel.find_by_uuid rather than via subclass,
997 # delegate to the appropriate subclass based on the given uuid.
998 self.resource_class_for_uuid(uuid).find_by_uuid(uuid)
1004 def is_audit_logging_enabled?
1005 return !(Rails.configuration.AuditLogs.MaxAge.to_i == 0 &&
1006 Rails.configuration.AuditLogs.MaxDeleteBatch.to_i > 0)
1009 def schedule_restoring_changes
1010 # This will be checked at log_start_state, to reset any (virtual) changes
1011 # produced by the act of reading a serialized attribute.
1012 @fresh_from_database = true
1016 if is_audit_logging_enabled?
1017 @old_attributes = Marshal.load(Marshal.dump(attributes))
1018 @old_logged_attributes = Marshal.load(Marshal.dump(logged_attributes))
1019 if @fresh_from_database
1020 # This instance was created from reading a database record. Attributes
1021 # haven't been changed, but those serialized attributes will be reported
1022 # as unpersisted, so we restore them to avoid issues with lock!() and
1025 @fresh_from_database = nil
1030 def log_change(event_type)
1031 if is_audit_logging_enabled?
1032 log = Log.new(event_type: event_type).fill_object(self)
1040 if is_audit_logging_enabled?
1041 log_change('create') do |log|
1042 log.fill_properties('old', nil, nil)
1049 if is_audit_logging_enabled?
1050 log_change('update') do |log|
1051 log.fill_properties('old', etag(@old_attributes), @old_logged_attributes)
1058 if is_audit_logging_enabled?
1059 log_change('delete') do |log|
1060 log.fill_properties('old', etag(@old_attributes), @old_logged_attributes)