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_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 before_validation :normalize_collection_uuids
31 before_validation :set_default_owner
32 validate :ensure_valid_uuids
34 # Note: This only returns permission links. It does not account for
35 # permissions obtained via user.is_admin or
36 # user.uuid==object.owner_uuid.
37 has_many(:permissions,
38 ->{where(link_class: 'permission')},
39 foreign_key: :head_uuid,
43 # If async is true at create or update, permission graph
44 # update is deferred allowing making multiple calls without the performance
46 attr_accessor :async_permissions_update
48 # Ignore listed attributes on mass assignments
49 def self.protected_attributes
53 class PermissionDeniedError < RequestError
59 class AlreadyLockedError < RequestError
65 class LockFailedError < RequestError
71 class InvalidStateTransitionError < RequestError
77 class UnauthorizedError < RequestError
83 class UnresolvableContainerError < RequestError
89 def self.kind_class(kind)
90 kind.match(/^arvados\#(.+)$/)[1].classify.safe_constantize rescue nil
94 "#{current_api_base}/#{self.class.to_s.pluralize.underscore}/#{self.uuid}"
97 def self.permit_attribute_params raw_params
98 # strong_parameters does not provide security: permissions are
99 # implemented with before_save hooks.
101 # The following permit! is necessary even with
102 # "ActionController::Parameters.permit_all_parameters = true",
103 # because permit_all does not permit nested attributes.
107 raw_params = raw_params.to_hash
108 raw_params.delete_if { |k, _| self.protected_attributes.include? k }
109 serialized_attributes.each do |colname, coder|
110 param = raw_params[colname.to_sym]
113 elsif !param.is_a?(coder.object_class)
114 raise ArgumentError.new("#{colname} parameter must be #{coder.object_class}, not #{param.class}")
115 elsif has_nonstring_keys?(param)
116 raise ArgumentError.new("#{colname} parameter cannot have non-string hash keys")
119 # Check JSONB columns that aren't listed on serialized_attributes
120 columns.select{|c| c.type == :jsonb}.collect{|j| j.name}.each do |colname|
121 if serialized_attributes.include? colname || raw_params[colname.to_sym].nil?
124 if has_nonstring_keys?(raw_params[colname.to_sym])
125 raise ArgumentError.new("#{colname} parameter cannot have non-string hash keys")
129 ActionController::Parameters.new(raw_params).permit!
132 def initialize raw_params={}, *args
133 super(self.class.permit_attribute_params(raw_params), *args)
136 # Reload "old attributes" for logging, too.
142 def self.create raw_params={}, *args
143 super(permit_attribute_params(raw_params), *args)
146 def update_attributes raw_params={}, *args
147 super(self.class.permit_attribute_params(raw_params), *args)
150 def self.selectable_attributes(template=:user)
151 # Return an array of attribute name strings that can be selected
152 # in the given template.
153 api_accessible_attributes(template).map { |attr_spec| attr_spec.first.to_s }
156 def self.searchable_columns operator
157 textonly_operator = !operator.match(/[<=>]/)
158 self.columns.select do |col|
162 when :datetime, :integer, :boolean
170 def self.attribute_column attr
171 self.columns.select { |col| col.name == attr.to_s }.first
174 def self.attributes_required_columns
175 # This method returns a hash. Each key is the name of an API attribute,
176 # and it's mapped to a list of database columns that must be fetched
177 # to generate that attribute.
178 # This implementation generates a simple map of attributes to
179 # matching column names. Subclasses can override this method
180 # to specify that method-backed API attributes need to fetch
181 # specific columns from the database.
182 all_columns = columns.map(&:name)
183 api_column_map = Hash.new { |hash, key| hash[key] = [] }
184 methods.grep(/^api_accessible_\w+$/).each do |method_name|
185 next if method_name == :api_accessible_attributes
186 send(method_name).each_pair do |api_attr_name, col_name|
187 col_name = col_name.to_s
188 if all_columns.include?(col_name)
189 api_column_map[api_attr_name.to_s] |= [col_name]
196 def self.ignored_select_attributes
197 ["href", "kind", "etag"]
200 def self.columns_for_attributes(select_attributes)
201 if select_attributes.empty?
202 raise ArgumentError.new("Attribute selection list cannot be empty")
204 api_column_map = attributes_required_columns
206 select_attributes.each do |s|
207 next if ignored_select_attributes.include? s
208 if not s.is_a? String or not api_column_map.include? s
212 if not invalid_attrs.empty?
213 raise ArgumentError.new("Invalid attribute(s): #{invalid_attrs.inspect}")
215 # Given an array of attribute names to select, return an array of column
216 # names that must be fetched from the database to satisfy the request.
217 select_attributes.flat_map { |attr| api_column_map[attr] }.uniq
220 def self.default_orders
221 ["#{table_name}.modified_at desc", "#{table_name}.uuid"]
224 def self.unique_columns
228 def self.limit_index_columns_read
229 # This method returns a list of column names.
230 # If an index request reads that column from the database,
231 # APIs that return lists will only fetch objects until reaching
232 # max_index_database_read bytes of data from those columns.
236 # If current user can manage the object, return an array of uuids of
237 # users and groups that have permission to write the object. The
238 # first two elements are always [self.owner_uuid, current user's
241 # If current user can write but not manage the object, return
242 # [self.owner_uuid, current user's uuid].
244 # If current user cannot write this object, just return
247 return [owner_uuid] if not current_user
248 unless (owner_uuid == current_user.uuid or
249 current_user.is_admin or
250 (current_user.groups_i_can(:manage) & [uuid, owner_uuid]).any?)
251 if ((current_user.groups_i_can(:write) + [current_user.uuid]) &
252 [uuid, owner_uuid]).any?
253 return [owner_uuid, current_user.uuid]
258 [owner_uuid, current_user.uuid] + permissions.collect do |p|
259 if ['can_write', 'can_manage'].index p.name
265 # Return a query with read permissions restricted to the union of the
266 # permissions of the members of users_list, i.e. if something is readable by
267 # any user in users_list, it will be readable in the query returned by this
269 def self.readable_by(*users_list)
270 # Get rid of troublesome nils
273 # Load optional keyword arguments, if they exist.
274 if users_list.last.is_a? Hash
275 kwargs = users_list.pop
280 # Collect the UUIDs of the authorized users.
281 sql_table = kwargs.fetch(:table_name, table_name)
282 include_trash = kwargs.fetch(:include_trash, false)
283 include_old_versions = kwargs.fetch(:include_old_versions, false)
286 user_uuids = users_list.map { |u| u.uuid }
288 # For details on how the trashed_groups table is constructed, see
289 # see db/migrate/20200501150153_permission_table.rb
291 exclude_trashed_records = ""
292 if !include_trash and (sql_table == "groups" or sql_table == "collections") then
293 # Only include records that are not trashed
294 exclude_trashed_records = "AND (#{sql_table}.trash_at is NULL or #{sql_table}.trash_at > statement_timestamp())"
297 if users_list.select { |u| u.is_admin }.any?
298 # Admin skips most permission checks, but still want to filter on trashed items.
300 if sql_table != "api_client_authorizations"
301 # Only include records where the owner is not trashed
302 sql_conds = "#{sql_table}.owner_uuid NOT IN (SELECT group_uuid FROM #{TRASHED_GROUPS} "+
303 "where trash_at <= statement_timestamp()) #{exclude_trashed_records}"
308 if !include_trash then
309 trashed_check = "AND target_uuid NOT IN (SELECT group_uuid FROM #{TRASHED_GROUPS} where trash_at <= statement_timestamp())"
312 # The core of the permission check is a join against the
313 # materialized_permissions table to determine if the user has at
314 # least read permission to either the object itself or its
316 # db/migrate/20200501150153_permission_table.rb for details on
317 # how the permissions are computed.
319 # Note: it is possible to combine the direct_check and
320 # owner_check into a single EXISTS() clause, however it turns
321 # out query optimizer doesn't like it and forces a sequential
322 # table scan. Constructing the query with separate EXISTS()
323 # clauses enables it to use the index.
325 # see issue 13208 for details.
327 # Match a direct read permission link from the user to the record uuid
328 direct_check = "#{sql_table}.uuid IN (SELECT target_uuid FROM #{PERMISSION_VIEW} "+
329 "WHERE user_uuid IN (:user_uuids) AND perm_level >= 1 #{trashed_check})"
331 # Match a read permission for the user to the record's
332 # owner_uuid. This is so we can have a permissions table that
333 # mostly consists of users and groups (projects are a type of
334 # group) and not have to compute and list user permission to
335 # every single object in the system.
337 # Don't do this for API keys (special behavior) or groups
338 # (already covered by direct_check).
340 # The traverse_owned flag indicates whether the permission to
341 # read an object also implies transitive permission to read
342 # things the object owns. The situation where this is important
343 # are determining if we can read an object owned by another
344 # user. This makes it possible to have permission to read the
345 # user record without granting permission to read things the
348 if sql_table != "api_client_authorizations" and sql_table != "groups" then
349 owner_check = "OR #{sql_table}.owner_uuid IN (SELECT target_uuid FROM #{PERMISSION_VIEW} "+
350 "WHERE user_uuid IN (:user_uuids) AND perm_level >= 1 #{trashed_check} AND traverse_owned) "
354 if sql_table == "links"
355 # Match any permission link that gives one of the authorized
356 # users some permission _or_ gives anyone else permission to
357 # view one of the authorized users.
358 links_cond = "OR (#{sql_table}.link_class IN (:permission_link_classes) AND "+
359 "(#{sql_table}.head_uuid IN (:user_uuids) OR #{sql_table}.tail_uuid IN (:user_uuids)))"
362 sql_conds = "(#{direct_check} #{owner_check} #{links_cond}) #{exclude_trashed_records}"
366 if !include_old_versions && sql_table == "collections"
367 exclude_old_versions = "#{sql_table}.uuid = #{sql_table}.current_version_uuid"
369 sql_conds = exclude_old_versions
371 sql_conds += " AND #{exclude_old_versions}"
375 self.where(sql_conds,
376 user_uuids: user_uuids,
377 permission_link_classes: ['permission', 'resources'])
380 def save_with_unique_name!
385 conn = ActiveRecord::Base.connection
386 conn.exec_query 'SAVEPOINT save_with_unique_name'
389 rescue ActiveRecord::RecordNotUnique => rn
390 raise if max_retries == 0
393 conn.exec_query 'ROLLBACK TO SAVEPOINT save_with_unique_name'
395 # Dig into the error to determine if it is specifically calling out a
396 # (owner_uuid, name) uniqueness violation. In this specific case, and
397 # the client requested a unique name with ensure_unique_name==true,
398 # update the name field and try to save again. Loop as necessary to
399 # discover a unique name. It is necessary to handle name choosing at
400 # this level (as opposed to the client) to ensure that record creation
401 # never fails due to a race condition.
403 raise unless err.is_a?(PG::UniqueViolation)
405 # Unfortunately ActiveRecord doesn't abstract out any of the
406 # necessary information to figure out if this the error is actually
407 # the specific case where we want to apply the ensure_unique_name
408 # behavior, so the following code is specialized to Postgres.
409 detail = err.result.error_field(PG::Result::PG_DIAG_MESSAGE_DETAIL)
410 raise unless /^Key \(owner_uuid, name\)=\([a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{15}, .*?\) already exists\./.match detail
412 new_name = "#{name_was} (#{db_current_time.utc.iso8601(3)})"
414 # If the database is fast enough to do two attempts in the
415 # same millisecond, we need to wait to ensure we try a
416 # different timestamp on each attempt.
418 new_name = "#{name_was} (#{db_current_time.utc.iso8601(3)})"
421 self[:name] = new_name
422 if uuid_was.nil? && !uuid.nil?
424 if self.is_a? Collection
425 # Reset so that is assigned to the new UUID
426 self[:current_version_uuid] = nil
429 conn.exec_query 'SAVEPOINT save_with_unique_name'
432 conn.exec_query 'RELEASE SAVEPOINT save_with_unique_name'
438 if self.owner_uuid.nil?
439 return current_user.uuid
441 owner_class = ArvadosModel.resource_class_for_uuid(self.owner_uuid)
442 if owner_class == User
445 owner_class.find_by_uuid(self.owner_uuid).user_owner_uuid
449 def logged_attributes
450 attributes.except(*Rails.configuration.AuditLogs.UnloggedAttributes.keys)
453 def self.full_text_searchable_columns
454 self.columns.select do |col|
455 [:string, :text, :jsonb].include?(col.type)
459 def self.full_text_coalesce
460 full_text_searchable_columns.collect do |column|
461 is_jsonb = self.columns.select{|x|x.name == column}[0].type == :jsonb
462 cast = (is_jsonb || serialized_attributes[column]) ? '::text' : ''
463 "coalesce(#{column}#{cast},'')"
467 def self.full_text_trgm
468 "(#{full_text_coalesce.join(" || ' ' || ")})"
471 def self.full_text_tsvector
472 parts = full_text_searchable_columns.collect do |column|
473 is_jsonb = self.columns.select{|x|x.name == column}[0].type == :jsonb
474 cast = (is_jsonb || serialized_attributes[column]) ? '::text' : ''
475 "coalesce(#{column}#{cast},'')"
477 "to_tsvector('english', substr(#{parts.join(" || ' ' || ")}, 0, 8000))"
480 def self.apply_filters query, filters
481 ft = record_filters filters, self
482 if not ft[:cond_out].any?
485 ft[:joins].each do |t|
486 query = query.joins(t)
488 query.where('(' + ft[:cond_out].join(') AND (') + ')',
494 def self.deep_sort_hash(x)
496 x.sort.collect do |k, v|
497 [k, deep_sort_hash(v)]
500 x.collect { |v| deep_sort_hash(v) }
506 def ensure_ownership_path_leads_to_user
507 if new_record? or owner_uuid_changed?
508 uuid_in_path = {owner_uuid => true, uuid => true}
510 while (owner_class = ArvadosModel::resource_class_for_uuid(x)) != User
513 # Test for cycles with the new version, not the DB contents
515 elsif !owner_class.respond_to? :find_by_uuid
516 raise ActiveRecord::RecordNotFound.new
518 x = owner_class.find_by_uuid(x).owner_uuid
520 rescue ActiveRecord::RecordNotFound => e
521 errors.add :owner_uuid, "is not owned by any user: #{e}"
526 errors.add :owner_uuid, "would create an ownership cycle"
528 errors.add :owner_uuid, "has an ownership cycle"
532 uuid_in_path[x] = true
538 def set_default_owner
539 if new_record? and current_user and respond_to? :owner_uuid=
540 self.owner_uuid ||= current_user.uuid
544 def ensure_owner_uuid_is_permitted
545 raise PermissionDeniedError if !current_user
547 if self.owner_uuid.nil?
548 errors.add :owner_uuid, "cannot be nil"
549 raise PermissionDeniedError
552 rsc_class = ArvadosModel::resource_class_for_uuid owner_uuid
553 unless rsc_class == User or rsc_class == Group
554 errors.add :owner_uuid, "must be set to User or Group"
555 raise PermissionDeniedError
558 if new_record? || owner_uuid_changed?
559 # Permission on owner_uuid_was is needed to move an existing
560 # object away from its previous owner (which implies permission
561 # to modify this object itself, so we don't need to check that
562 # separately). Permission on the new owner_uuid is also needed.
563 [['old', owner_uuid_was],
565 ].each do |which, check_uuid|
567 # old_owner_uuid is nil? New record, no need to check.
568 elsif !current_user.can?(write: check_uuid)
569 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}"
570 errors.add :owner_uuid, "cannot be set or changed without write permission on #{which} owner"
571 raise PermissionDeniedError
575 # If the object already existed and we're not changing
576 # owner_uuid, we only need write permission on the object
578 if !current_user.can?(write: self.uuid)
579 logger.warn "User #{current_user.uuid} tried to modify #{self.class.to_s} #{self.uuid} without write permission"
580 errors.add :uuid, "is not writable"
581 raise PermissionDeniedError
588 def ensure_permission_to_save
589 unless (new_record? ? permission_to_create : permission_to_update)
590 raise PermissionDeniedError
594 def permission_to_create
595 current_user.andand.is_active
598 def permission_to_update
600 logger.warn "Anonymous user tried to update #{self.class.to_s} #{self.uuid_was}"
603 if !current_user.is_active
604 logger.warn "Inactive user #{current_user.uuid} tried to update #{self.class.to_s} #{self.uuid_was}"
607 return true if current_user.is_admin
608 if self.uuid_changed?
609 logger.warn "User #{current_user.uuid} tried to change uuid of #{self.class.to_s} #{self.uuid_was} to #{self.uuid}"
615 def ensure_permission_to_destroy
616 raise PermissionDeniedError unless permission_to_destroy
619 def permission_to_destroy
623 def maybe_update_modified_by_fields
624 update_modified_by_fields if self.changed? or self.new_record?
628 def update_modified_by_fields
629 current_time = db_current_time
630 self.created_at ||= created_at_was || current_time
631 self.updated_at = current_time
632 self.owner_uuid ||= current_default_owner if self.respond_to? :owner_uuid=
633 if !anonymous_updater
634 self.modified_by_user_uuid = current_user ? current_user.uuid : nil
637 self.modified_at = current_time
639 self.modified_by_client_uuid = current_api_client ? current_api_client.uuid : nil
643 def self.has_nonstring_keys? x
646 return true if !(k.is_a?(String) || k.is_a?(Symbol)) || has_nonstring_keys?(v)
650 return true if has_nonstring_keys?(v)
656 def self.where_serialized(colname, value, md5: false)
657 colsql = colname.to_s
659 colsql = "md5(#{colsql})"
662 # rails4 stores as null, rails3 stored as serialized [] or {}
663 sql = "#{colsql} is null or #{colsql} IN (?)"
666 sql = "#{colsql} IN (?)"
667 sorted = deep_sort_hash(value)
669 params = [sorted.to_yaml, SafeJSON.dump(sorted)]
671 params = params.map { |x| Digest::MD5.hexdigest(x) }
677 Hash => HashSerializer,
678 Array => ArraySerializer,
681 def self.serialize(colname, type)
682 coder = Serializer[type]
683 @serialized_attributes ||= {}
684 @serialized_attributes[colname.to_s] = coder
685 super(colname, coder)
688 def self.serialized_attributes
689 @serialized_attributes ||= {}
692 def serialized_attributes
693 self.class.serialized_attributes
696 def foreign_key_attributes
697 attributes.keys.select { |a| a.match(/_uuid$/) }
700 def skip_uuid_read_permission_check
701 %w(modified_by_client_uuid)
704 def skip_uuid_existence_check
708 def normalize_collection_uuids
709 foreign_key_attributes.each do |attr|
710 attr_value = send attr
711 if attr_value.is_a? String and
712 attr_value.match(/^[0-9a-f]{32,}(\+[@\w]+)*$/)
714 send "#{attr}=", Collection.normalize_uuid(attr_value)
716 # TODO: abort instead of silently accepting unnormalizable value?
722 @@prefixes_hash = nil
723 def self.uuid_prefixes
724 unless @@prefixes_hash
726 Rails.application.eager_load!
727 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |k|
728 if k.respond_to?(:uuid_prefix)
729 @@prefixes_hash[k.uuid_prefix] = k
736 def self.uuid_like_pattern
737 "#{Rails.configuration.ClusterID}-#{uuid_prefix}-_______________"
741 %r/[a-z0-9]{5}-#{uuid_prefix}-[a-z0-9]{15}/
744 def ensure_valid_uuids
745 specials = [system_user_uuid]
747 foreign_key_attributes.each do |attr|
748 if new_record? or send (attr + "_changed?")
749 next if skip_uuid_existence_check.include? attr
750 attr_value = send attr
751 next if specials.include? attr_value
753 if (r = ArvadosModel::resource_class_for_uuid attr_value)
754 unless skip_uuid_read_permission_check.include? attr
755 r = r.readable_by(current_user)
757 if r.where(uuid: attr_value).count == 0
758 errors.add(attr, "'#{attr_value}' not found")
766 def ensure_filesystem_compatible_name
767 if name == "." || name == ".."
768 errors.add(:name, "cannot be '.' or '..'")
769 elsif Rails.configuration.Collections.ForwardSlashNameSubstitution == "" && !name.nil? && name.index('/')
770 errors.add(:name, "cannot contain a '/' character")
783 def self.readable_by (*u)
788 [{:uuid => u[:uuid]}]
792 def self.resource_class_for_uuid(uuid)
793 if uuid.is_a? ArvadosModel
796 unless uuid.is_a? String
800 uuid.match HasUuid::UUID_REGEX do |re|
801 return uuid_prefixes[re[1]] if uuid_prefixes[re[1]]
804 if uuid.match(/.+@.+/)
811 # ArvadosModel.find_by_uuid needs extra magic to allow it to return
812 # an object in any class.
813 def self.find_by_uuid uuid
814 if self == ArvadosModel
815 # If called directly as ArvadosModel.find_by_uuid rather than via subclass,
816 # delegate to the appropriate subclass based on the given uuid.
817 self.resource_class_for_uuid(uuid).find_by_uuid(uuid)
823 def is_audit_logging_enabled?
824 return !(Rails.configuration.AuditLogs.MaxAge.to_i == 0 &&
825 Rails.configuration.AuditLogs.MaxDeleteBatch.to_i > 0)
829 if is_audit_logging_enabled?
830 @old_attributes = Marshal.load(Marshal.dump(attributes))
831 @old_logged_attributes = Marshal.load(Marshal.dump(logged_attributes))
835 def log_change(event_type)
836 if is_audit_logging_enabled?
837 log = Log.new(event_type: event_type).fill_object(self)
845 if is_audit_logging_enabled?
846 log_change('create') do |log|
847 log.fill_properties('old', nil, nil)
854 if is_audit_logging_enabled?
855 log_change('update') do |log|
856 log.fill_properties('old', etag(@old_attributes), @old_logged_attributes)
863 if is_audit_logging_enabled?
864 log_change('delete') do |log|
865 log.fill_properties('old', etag(@old_attributes), @old_logged_attributes)