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_update :maybe_update_modified_by_fields
28 after_create :log_create
29 after_update :log_update
30 after_destroy :log_destroy
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 # If async is true at create or update, permission graph
45 # update is deferred allowing making multiple calls without the performance
47 attr_accessor :async_permissions_update
49 # Ignore listed attributes on mass assignments
50 def self.protected_attributes
54 class PermissionDeniedError < RequestError
60 class AlreadyLockedError < RequestError
66 class LockFailedError < RequestError
72 class InvalidStateTransitionError < RequestError
78 class UnauthorizedError < RequestError
84 class UnresolvableContainerError < RequestError
90 def self.kind_class(kind)
91 kind.match(/^arvados\#(.+)$/)[1].classify.safe_constantize rescue nil
95 "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}"
98 def self.permit_attribute_params raw_params
99 # strong_parameters does not provide security: permissions are
100 # implemented with before_save hooks.
102 # The following permit! is necessary even with
103 # "ActionController::Parameters.permit_all_parameters = true",
104 # because permit_all does not permit nested attributes.
108 raw_params = raw_params.to_hash
109 raw_params.delete_if { |k, _| self.protected_attributes.include? k }
110 serialized_attributes.each do |colname, coder|
111 param = raw_params[colname.to_sym]
114 elsif !param.is_a?(coder.object_class)
115 raise ArgumentError.new("#{colname} parameter must be #{coder.object_class}, not #{param.class}")
116 elsif has_nonstring_keys?(param)
117 raise ArgumentError.new("#{colname} parameter cannot have non-string hash keys")
120 # Check JSONB columns that aren't listed on serialized_attributes
121 columns.select{|c| c.type == :jsonb}.collect{|j| j.name}.each do |colname|
122 if serialized_attributes.include? colname || raw_params[colname.to_sym].nil?
125 if has_nonstring_keys?(raw_params[colname.to_sym])
126 raise ArgumentError.new("#{colname} parameter cannot have non-string hash keys")
130 ActionController::Parameters.new(raw_params).permit!
133 def initialize raw_params={}, *args
134 super(self.class.permit_attribute_params(raw_params), *args)
137 # Reload "old attributes" for logging, too.
144 def self.create raw_params={}, *args
145 super(permit_attribute_params(raw_params), *args)
148 def update_attributes raw_params={}, *args
149 super(self.class.permit_attribute_params(raw_params), *args)
152 def self.selectable_attributes(template=:user)
153 # Return an array of attribute name strings that can be selected
154 # in the given template.
155 api_accessible_attributes(template).map { |attr_spec| attr_spec.first.to_s }
158 def self.searchable_columns operator
159 textonly_operator = !operator.match(/[<=>]/)
160 self.columns.select do |col|
164 when :datetime, :integer, :boolean
172 def self.attribute_column attr
173 self.columns.select { |col| col.name == attr.to_s }.first
176 def self.attributes_required_columns
177 # This method returns a hash. Each key is the name of an API attribute,
178 # and it's mapped to a list of database columns that must be fetched
179 # to generate that attribute.
180 # This implementation generates a simple map of attributes to
181 # matching column names. Subclasses can override this method
182 # to specify that method-backed API attributes need to fetch
183 # specific columns from the database.
184 all_columns = columns.map(&:name)
185 api_column_map = Hash.new { |hash, key| hash[key] = [] }
186 methods.grep(/^api_accessible_\w+$/).each do |method_name|
187 next if method_name == :api_accessible_attributes
188 send(method_name).each_pair do |api_attr_name, col_name|
189 col_name = col_name.to_s
190 if all_columns.include?(col_name)
191 api_column_map[api_attr_name.to_s] |= [col_name]
198 def self.ignored_select_attributes
199 ["href", "kind", "etag"]
202 def self.columns_for_attributes(select_attributes)
203 if select_attributes.empty?
204 raise ArgumentError.new("Attribute selection list cannot be empty")
206 api_column_map = attributes_required_columns
208 select_attributes.each do |s|
209 next if ignored_select_attributes.include? s
210 if not s.is_a? String or not api_column_map.include? s
214 if not invalid_attrs.empty?
215 raise ArgumentError.new("Invalid attribute(s): #{invalid_attrs.inspect}")
217 # Given an array of attribute names to select, return an array of column
218 # names that must be fetched from the database to satisfy the request.
219 select_attributes.flat_map { |attr| api_column_map[attr] }.uniq
222 def self.default_orders
223 ["#{table_name}.modified_at desc", "#{table_name}.uuid desc"]
226 def self.unique_columns
230 def self.limit_index_columns_read
231 # This method returns a list of column names.
232 # If an index request reads that column from the database,
233 # APIs that return lists will only fetch objects until reaching
234 # max_index_database_read bytes of data from those columns.
238 # If current user can manage the object, return an array of uuids of
239 # users and groups that have permission to write the object. The
240 # first two elements are always [self.owner_uuid, current user's
243 # If current user can write but not manage the object, return
244 # [self.owner_uuid, current user's uuid].
246 # If current user cannot write this object, just return
249 # Return [] if this is a frozen project and the current user can't
251 return [] if respond_to?(:frozen_by_uuid) && frozen_by_uuid &&
252 (Rails.configuration.API.UnfreezeProjectRequiresAdmin ?
253 !current_user.andand.is_admin :
254 !current_user.can?(manage: uuid))
255 # Return [] if nobody can write because this object is inside a
257 return [] if FrozenGroup.where(uuid: owner_uuid).any?
258 return [owner_uuid] if not current_user
259 unless (owner_uuid == current_user.uuid or
260 current_user.is_admin or
261 (current_user.groups_i_can(:manage) & [uuid, owner_uuid]).any?)
262 if ((current_user.groups_i_can(:write) + [current_user.uuid]) &
263 [uuid, owner_uuid]).any?
264 return [owner_uuid, current_user.uuid]
269 [owner_uuid, current_user.uuid] + permissions.collect do |p|
270 if ['can_write', 'can_manage'].index p.name
276 # Return a query with read permissions restricted to the union of the
277 # permissions of the members of users_list, i.e. if something is readable by
278 # any user in users_list, it will be readable in the query returned by this
280 def self.readable_by(*users_list)
281 # Get rid of troublesome nils
284 # Load optional keyword arguments, if they exist.
285 if users_list.last.is_a? Hash
286 kwargs = users_list.pop
291 # Collect the UUIDs of the authorized users.
292 sql_table = kwargs.fetch(:table_name, table_name)
293 include_trash = kwargs.fetch(:include_trash, false)
294 include_old_versions = kwargs.fetch(:include_old_versions, false)
297 user_uuids = users_list.map { |u| u.uuid }
300 admin = users_list.select { |u| u.is_admin }.any?
302 # For details on how the trashed_groups table is constructed, see
303 # see db/migrate/20200501150153_permission_table.rb
305 # excluded_trash is a SQL expression that determines whether a row
306 # should be excluded from the results due to being trashed.
307 # Trashed items inside frozen projects are invisible to regular
308 # (non-admin) users even when using include_trash, so we have:
310 # (item_trashed || item_inside_trashed_project)
312 # (!caller_requests_include_trash ||
313 # (item_inside_frozen_project && caller_is_not_admin))
314 if (admin && include_trash) || sql_table == "api_client_authorizations"
315 excluded_trash = "false"
317 excluded_trash = "(#{sql_table}.owner_uuid IN (SELECT group_uuid FROM #{TRASHED_GROUPS} " +
318 "WHERE trash_at <= statement_timestamp()))"
319 if sql_table == "groups" || sql_table == "collections"
320 excluded_trash = "(#{excluded_trash} OR #{sql_table}.trash_at <= statement_timestamp() IS TRUE)"
324 # Exclude trash inside frozen projects
325 excluded_trash = "(#{excluded_trash} AND #{sql_table}.owner_uuid IN (SELECT uuid FROM #{FROZEN_GROUPS}))"
330 # Admin skips most permission checks, but still want to filter
332 if !include_trash && sql_table != "api_client_authorizations"
333 # Only include records where the owner is not trashed
334 sql_conds = "NOT (#{excluded_trash})"
337 # The core of the permission check is a join against the
338 # materialized_permissions table to determine if the user has at
339 # least read permission to either the object itself or its
340 # direct owner (if traverse_owned is true). See
341 # db/migrate/20200501150153_permission_table.rb for details on
342 # how the permissions are computed.
344 # A user can have can_manage access to another user, this grants
345 # full access to all that user's stuff. To implement that we
346 # need to include those other users in the permission query.
348 # This was previously implemented by embedding the subquery
349 # directly into the query, but it was discovered later that this
350 # causes the Postgres query planner to do silly things because
351 # the query heuristics assumed the subquery would have a lot
352 # more rows that it does, and choose a bad merge strategy. By
353 # doing the query here and embedding the result as a constant,
354 # Postgres also knows exactly how many items there are and can
355 # choose the right query strategy.
357 # (note: you could also do this with a temporary table, but that
358 # would require all every request be wrapped in a transaction,
359 # which is not currently the case).
361 all_user_uuids = ActiveRecord::Base.connection.exec_query %{
362 #{USER_UUIDS_SUBQUERY_TEMPLATE % {user: "'#{user_uuids.join "', '"}'", perm_level: 1}}
364 'readable_by.user_uuids'
366 user_uuids_subquery = ":user_uuids"
368 # Note: it is possible to combine the direct_check and
369 # owner_check into a single IN (SELECT) clause, however it turns
370 # out query optimizer doesn't like it and forces a sequential
371 # table scan. Constructing the query with separate IN (SELECT)
372 # clauses enables it to use the index.
374 # see issue 13208 for details.
376 # Match a direct read permission link from the user to the record uuid
377 direct_check = "#{sql_table}.uuid IN (SELECT target_uuid FROM #{PERMISSION_VIEW} "+
378 "WHERE user_uuid IN (#{user_uuids_subquery}) AND perm_level >= 1)"
380 # Match a read permission for the user to the record's
381 # owner_uuid. This is so we can have a permissions table that
382 # mostly consists of users and groups (projects are a type of
383 # group) and not have to compute and list user permission to
384 # every single object in the system.
386 # Don't do this for API keys (special behavior) or groups
387 # (already covered by direct_check).
389 # The traverse_owned flag indicates whether the permission to
390 # read an object also implies transitive permission to read
391 # things the object owns. The situation where this is important
392 # are determining if we can read an object owned by another
393 # user. This makes it possible to have permission to read the
394 # user record without granting permission to read things the
397 if sql_table != "api_client_authorizations" and sql_table != "groups" then
398 owner_check = "#{sql_table}.owner_uuid IN (SELECT target_uuid FROM #{PERMISSION_VIEW} "+
399 "WHERE user_uuid IN (#{user_uuids_subquery}) AND perm_level >= 1 AND traverse_owned) "
401 # We want to do owner_check before direct_check in the OR
402 # clause. The order of the OR clause isn't supposed to
403 # matter, but in practice, it does -- apparently in the
404 # absence of other hints, it uses the ordering from the query.
405 # For certain types of queries (like filtering on owner_uuid),
406 # every item will match the owner_check clause, so then
407 # Postgres will optimize out the direct_check entirely.
408 direct_check = " OR " + direct_check
411 if Rails.configuration.Users.RoleGroupsVisibleToAll &&
412 sql_table == "groups" &&
413 users_list.select { |u| u.is_active }.any?
414 # All role groups are readable (but we still need the other
415 # direct_check clauses to handle non-role groups).
416 direct_check += " OR #{sql_table}.group_class = 'role'"
420 if sql_table == "links"
421 # 1) Match permission links incoming or outgoing on the
422 # user, i.e. granting permission on the user, or granting
423 # permission to the user.
425 # 2) Match permission links which grant permission on an
426 # object that this user can_manage.
428 links_cond = "OR (#{sql_table}.link_class IN (:permission_link_classes) AND "+
429 " ((#{sql_table}.head_uuid IN (#{user_uuids_subquery}) OR #{sql_table}.tail_uuid IN (#{user_uuids_subquery})) OR " +
430 " #{sql_table}.head_uuid IN (SELECT target_uuid FROM #{PERMISSION_VIEW} "+
431 " WHERE user_uuid IN (#{user_uuids_subquery}) AND perm_level >= 3))) "
434 sql_conds = "(#{owner_check} #{direct_check} #{links_cond}) AND NOT (#{excluded_trash})"
438 if !include_old_versions && sql_table == "collections"
439 exclude_old_versions = "#{sql_table}.uuid = #{sql_table}.current_version_uuid"
441 sql_conds = exclude_old_versions
443 sql_conds += " AND #{exclude_old_versions}"
447 self.where(sql_conds,
448 user_uuids: all_user_uuids.collect{|c| c["target_uuid"]},
449 permission_link_classes: ['permission'])
452 def save_with_unique_name!
457 conn = ActiveRecord::Base.connection
458 conn.exec_query 'SAVEPOINT save_with_unique_name'
461 rescue ActiveRecord::RecordNotUnique => rn
462 raise if max_retries == 0
465 conn.exec_query 'ROLLBACK TO SAVEPOINT save_with_unique_name'
467 # Dig into the error to determine if it is specifically calling out a
468 # (owner_uuid, name) uniqueness violation. In this specific case, and
469 # the client requested a unique name with ensure_unique_name==true,
470 # update the name field and try to save again. Loop as necessary to
471 # discover a unique name. It is necessary to handle name choosing at
472 # this level (as opposed to the client) to ensure that record creation
473 # never fails due to a race condition.
475 raise unless err.is_a?(PG::UniqueViolation)
477 # Unfortunately ActiveRecord doesn't abstract out any of the
478 # necessary information to figure out if this the error is actually
479 # the specific case where we want to apply the ensure_unique_name
480 # behavior, so the following code is specialized to Postgres.
481 detail = err.result.error_field(PG::Result::PG_DIAG_MESSAGE_DETAIL)
482 raise unless /^Key \(owner_uuid, name\)=\([a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{15}, .*?\) already exists\./.match detail
484 new_name = "#{name_was} (#{db_current_time.utc.iso8601(3)})"
486 # If the database is fast enough to do two attempts in the
487 # same millisecond, we need to wait to ensure we try a
488 # different timestamp on each attempt.
490 new_name = "#{name_was} (#{db_current_time.utc.iso8601(3)})"
493 self[:name] = new_name
494 if uuid_was.nil? && !uuid.nil?
496 if self.is_a? Collection
497 # Reset so that is assigned to the new UUID
498 self[:current_version_uuid] = nil
501 conn.exec_query 'SAVEPOINT save_with_unique_name'
504 conn.exec_query 'RELEASE SAVEPOINT save_with_unique_name'
510 if self.owner_uuid.nil?
511 return current_user.uuid
513 owner_class = ArvadosModel.resource_class_for_uuid(self.owner_uuid)
514 if owner_class == User
517 owner_class.find_by_uuid(self.owner_uuid).user_owner_uuid
521 def logged_attributes
522 attributes.except(*Rails.configuration.AuditLogs.UnloggedAttributes.stringify_keys.keys)
525 def self.full_text_searchable_columns
526 self.columns.select do |col|
527 [:string, :text, :jsonb].include?(col.type)
531 def self.full_text_coalesce
532 full_text_searchable_columns.collect do |column|
533 is_jsonb = self.columns.select{|x|x.name == column}[0].type == :jsonb
534 cast = (is_jsonb || serialized_attributes[column]) ? '::text' : ''
535 "coalesce(#{column}#{cast},'')"
539 def self.full_text_trgm
540 "(#{full_text_coalesce.join(" || ' ' || ")})"
543 def self.full_text_tsvector
544 parts = full_text_searchable_columns.collect do |column|
545 is_jsonb = self.columns.select{|x|x.name == column}[0].type == :jsonb
546 cast = (is_jsonb || serialized_attributes[column]) ? '::text' : ''
547 "coalesce(#{column}#{cast},'')"
549 "to_tsvector('english', substr(#{parts.join(" || ' ' || ")}, 0, 8000))"
552 def self.apply_filters query, filters
553 ft = record_filters filters, self
554 if not ft[:cond_out].any?
557 ft[:joins].each do |t|
558 query = query.joins(t)
560 query.where('(' + ft[:cond_out].join(') AND (') + ')',
566 def self.deep_sort_hash(x)
568 x.sort.collect do |k, v|
569 [k, deep_sort_hash(v)]
572 x.collect { |v| deep_sort_hash(v) }
578 def ensure_ownership_path_leads_to_user
579 if new_record? or owner_uuid_changed?
580 uuid_in_path = {owner_uuid => true, uuid => true}
582 while (owner_class = ArvadosModel::resource_class_for_uuid(x)) != User
585 # Test for cycles with the new version, not the DB contents
587 elsif !owner_class.respond_to? :find_by_uuid
588 raise ActiveRecord::RecordNotFound.new
590 x = owner_class.find_by_uuid(x).owner_uuid
592 rescue ActiveRecord::RecordNotFound => e
593 errors.add :owner_uuid, "is not owned by any user: #{e}"
598 errors.add :owner_uuid, "would create an ownership cycle"
600 errors.add :owner_uuid, "has an ownership cycle"
604 uuid_in_path[x] = true
610 def set_default_owner
611 if new_record? and current_user and respond_to? :owner_uuid=
612 self.owner_uuid ||= current_user.uuid
616 def ensure_owner_uuid_is_permitted
617 raise PermissionDeniedError if !current_user
619 if self.owner_uuid.nil?
620 errors.add :owner_uuid, "cannot be nil"
621 raise PermissionDeniedError
624 rsc_class = ArvadosModel::resource_class_for_uuid owner_uuid
625 unless rsc_class == User or rsc_class == Group
626 errors.add :owner_uuid, "must be set to User or Group"
627 raise PermissionDeniedError
630 if new_record? || owner_uuid_changed?
631 # Permission on owner_uuid_was is needed to move an existing
632 # object away from its previous owner (which implies permission
633 # to modify this object itself, so we don't need to check that
634 # separately). Permission on the new owner_uuid is also needed.
635 [['old', owner_uuid_was],
637 ].each do |which, check_uuid|
639 # old_owner_uuid is nil? New record, no need to check.
640 elsif !current_user.can?(write: check_uuid)
641 if FrozenGroup.where(uuid: check_uuid).any?
642 errors.add :owner_uuid, "cannot be set or changed because #{which} owner is frozen"
644 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}"
645 errors.add :owner_uuid, "cannot be set or changed without write permission on #{which} owner"
647 raise PermissionDeniedError
648 elsif rsc_class == Group && Group.find_by_uuid(owner_uuid).group_class != "project"
649 errors.add :owner_uuid, "must be a project"
650 raise PermissionDeniedError
654 # If the object already existed and we're not changing
655 # owner_uuid, we only need write permission on the object
656 # itself. (If we're in the act of unfreezing, we only need
657 # :unfreeze permission, which means "what write permission would
658 # be if target weren't frozen")
659 unless ((respond_to?(:frozen_by_uuid) && frozen_by_uuid_was && !frozen_by_uuid) ?
660 current_user.can?(unfreeze: uuid) :
661 current_user.can?(write: uuid))
662 logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{self.uuid} without write permission"
663 errors.add :uuid, " #{uuid} is not writable by #{current_user.uuid}"
664 raise PermissionDeniedError
671 def ensure_permission_to_save
672 unless (new_record? ? permission_to_create : permission_to_update)
673 raise PermissionDeniedError
677 def permission_to_create
678 return current_user.andand.is_active
681 def permission_to_update
683 logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
686 if !current_user.is_active
687 logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
690 return true if current_user.is_admin
691 if self.uuid_changed?
692 logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
698 def ensure_permission_to_destroy
699 raise PermissionDeniedError unless permission_to_destroy
702 def permission_to_destroy
703 if [system_user_uuid, system_group_uuid, anonymous_group_uuid,
704 anonymous_user_uuid, public_project_uuid].include? uuid
711 def maybe_update_modified_by_fields
712 update_modified_by_fields if self.changed? or self.new_record?
716 def update_modified_by_fields
717 current_time = db_current_time
718 self.created_at ||= created_at_was || current_time
719 self.updated_at = current_time
720 self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid=
721 if !anonymous_updater
722 self.modified_by_user_uuid = current_user ? current_user.uuid : nil
725 self.modified_at = current_time
727 self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
731 def self.has_nonstring_keys? x
734 return true if !(k.is_a?(String) || k.is_a?(Symbol)) || has_nonstring_keys?(v)
738 return true if has_nonstring_keys?(v)
744 def self.where_serialized(colname, value, md5: false, multivalue: false)
745 colsql = colname.to_s
747 colsql = "md5(#{colsql})"
750 # rails4 stores as null, rails3 stored as serialized [] or {}
751 sql = "#{colsql} is null or #{colsql} IN (?)"
754 sql = "#{colsql} IN (?)"
755 sorted = deep_sort_hash(value)
761 params << SafeJSON.dump(v)
764 params << sorted.to_yaml
765 params << SafeJSON.dump(sorted)
768 params = params.map { |x| Digest::MD5.hexdigest(x) }
774 Hash => HashSerializer,
775 Array => ArraySerializer,
778 def self.serialize(colname, type)
779 coder = Serializer[type]
780 @serialized_attributes ||= {}
781 @serialized_attributes[colname.to_s] = coder
782 super(colname, coder)
785 def self.serialized_attributes
786 @serialized_attributes ||= {}
789 def serialized_attributes
790 self.class.serialized_attributes
793 def foreign_key_attributes
794 attributes.keys.select { |a| a.match(/_uuid$/) }
797 def skip_uuid_read_permission_check
798 %w(modified_by_client_uuid)
801 def skip_uuid_existence_check
805 def normalize_collection_uuids
806 foreign_key_attributes.each do |attr|
807 attr_value = send attr
808 if attr_value.is_a? String and
809 attr_value.match(/^[0-9a-f]{32,}(\+[@\w]+)*$/)
811 send "#{attr}=", Collection.normalize_uuid(attr_value)
813 # TODO: abort instead of silently accepting unnormalizable value?
819 @@prefixes_hash = nil
820 def self.uuid_prefixes
821 unless @@prefixes_hash
823 Rails.application.eager_load!
824 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
825 if k.respond_to?(:uuid_prefix)
826 @@prefixes_hash[k.uuid_prefix] = k
833 def self.uuid_like_pattern
834 "#{Rails.configuration.ClusterID}-#{uuid_prefix}-_______________"
838 %r/[a-z0-9]{5}-#{uuid_prefix}-[a-z0-9]{15}/
841 def check_readable_uuid attr, attr_value
842 return if attr_value.nil?
843 if (r = ArvadosModel::resource_class_for_uuid attr_value)
844 unless skip_uuid_read_permission_check.include? attr
845 r = r.readable_by(current_user)
847 if r.where(uuid: attr_value).count == 0
848 errors.add(attr, "'#{attr_value}' not found")
851 # Not a valid uuid or PDH, but that (currently) is not an error.
855 def ensure_valid_uuids
856 specials = [system_user_uuid]
858 foreign_key_attributes.each do |attr|
859 if new_record? or send (attr + "_changed?")
860 next if skip_uuid_existence_check.include? attr
861 attr_value = send attr
862 next if specials.include? attr_value
863 check_readable_uuid attr, attr_value
868 def ensure_filesystem_compatible_name
869 if name == "." || name == ".."
870 errors.add(:name, "cannot be '.' or '..'")
871 elsif Rails.configuration.Collections.ForwardSlashNameSubstitution == "" && !name.nil? && name.index('/')
872 errors.add(:name, "cannot contain a '/' character")
885 def self.readable_by (*u)
890 [{:uuid => u[:uuid]}]
894 def self.resource_class_for_uuid(uuid)
895 if uuid.is_a? ArvadosModel
898 unless uuid.is_a? String
902 uuid.match HasUuid::UUID_REGEX do |re|
903 return uuid_prefixes[re[1]] if uuid_prefixes[re[1]]
906 if uuid.match(/.+@.+/)
913 # Fill in implied zero/false values in database records that were
914 # created before #17014 made them explicit, and reset the Rails
915 # "changed" state so the record doesn't appear to have been modified
918 # Invoked by Container and ContainerRequest models as an after_find
920 def fill_container_defaults_after_find
921 fill_container_defaults
922 set_attribute_was('runtime_constraints', runtime_constraints)
923 set_attribute_was('scheduling_parameters', scheduling_parameters)
924 clear_changes_information
927 # Fill in implied zero/false values. Invoked by ContainerRequest as
928 # a before_validation hook in order to (a) ensure every key has a
929 # value in the updated database record and (b) ensure the attribute
930 # whitelist doesn't reject a change from an explicit zero/false
931 # value in the database to an implicit zero/false value in an update
933 def fill_container_defaults
934 self.runtime_constraints = {
938 'driver_version' => '',
939 'hardware_capability' => '',
941 'keep_cache_ram' => 0,
944 }.merge(attributes['runtime_constraints'] || {})
945 self.scheduling_parameters = {
948 'preemptible' => false,
949 }.merge(attributes['scheduling_parameters'] || {})
952 # ArvadosModel.find_by_uuid needs extra magic to allow it to return
953 # an object in any class.
954 def self.find_by_uuid uuid
955 if self == ArvadosModel
956 # If called directly as ArvadosModel.find_by_uuid rather than via subclass,
957 # delegate to the appropriate subclass based on the given uuid.
958 self.resource_class_for_uuid(uuid).find_by_uuid(uuid)
964 def is_audit_logging_enabled?
965 return !(Rails.configuration.AuditLogs.MaxAge.to_i == 0 &&
966 Rails.configuration.AuditLogs.MaxDeleteBatch.to_i > 0)
969 def schedule_restoring_changes
970 # This will be checked at log_start_state, to reset any (virtual) changes
971 # produced by the act of reading a serialized attribute.
972 @fresh_from_database = true
976 if is_audit_logging_enabled?
977 @old_attributes = Marshal.load(Marshal.dump(attributes))
978 @old_logged_attributes = Marshal.load(Marshal.dump(logged_attributes))
979 if @fresh_from_database
980 # This instance was created from reading a database record. Attributes
981 # haven't been changed, but those serialized attributes will be reported
982 # as unpersisted, so we restore them to avoid issues with lock!() and
985 @fresh_from_database = nil
990 def log_change(event_type)
991 if is_audit_logging_enabled?
992 log = Log.new(event_type: event_type).fill_object(self)
1000 if is_audit_logging_enabled?
1001 log_change('create') do |log|
1002 log.fill_properties('old', nil, nil)
1009 if is_audit_logging_enabled?
1010 log_change('update') do |log|
1011 log.fill_properties('old', etag(@old_attributes), @old_logged_attributes)
1018 if is_audit_logging_enabled?
1019 log_change('delete') do |log|
1020 log.fill_properties('old', etag(@old_attributes), @old_logged_attributes)