1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
8 class Collection < ArvadosModel
9 extend CurrentApiClient
13 include CommonApiTemplate
16 # Posgresql JSONB columns should NOT be declared as serialized, Rails 5
17 # already know how to properly treat them.
18 attribute :properties, :jsonbHash, default: {}
19 attribute :storage_classes_desired, :jsonbArray, default: lambda { Rails.configuration.DefaultStorageClasses }
20 attribute :storage_classes_confirmed, :jsonbArray, default: []
22 before_validation :default_empty_manifest
23 before_validation :default_storage_classes, on: :create
24 before_validation :managed_properties, on: :create
25 before_validation :check_encoding
26 before_validation :check_manifest_validity
27 before_validation :check_signatures
28 before_validation :strip_signatures_and_update_replication_confirmed
29 before_validation :name_null_if_empty
30 validate :ensure_filesystem_compatible_name
31 validate :ensure_pdh_matches_manifest_text
32 validate :ensure_storage_classes_desired_is_not_empty
33 validate :ensure_storage_classes_contain_non_empty_strings
34 validate :versioning_metadata_updates, on: :update
35 validate :past_versions_cannot_be_updated, on: :update
36 validate :protected_managed_properties_updates, on: :update
37 after_validation :set_file_count_and_total_size
38 before_save :set_file_names
39 around_update :manage_versioning, unless: :is_past_version?
41 api_accessible :user, extend: :common do |t|
42 t.add lambda { |x| x.name || "" }, as: :name
45 t.add :portable_data_hash
46 t.add :manifest_text, as: :unsigned_manifest_text
47 t.add :manifest_text, as: :manifest_text
48 t.add :replication_desired
49 t.add :replication_confirmed
50 t.add :replication_confirmed_at
51 t.add :storage_classes_desired
52 t.add :storage_classes_confirmed
53 t.add :storage_classes_confirmed_at
58 t.add :current_version_uuid
59 t.add :preserve_version
61 t.add :file_size_total
64 UNLOGGED_CHANGES = ['preserve_version', 'updated_at']
67 @signatures_checked = false
68 @computed_pdh_for_manifest_text = false
71 def self.attributes_required_columns
73 # If we don't list unsigned_manifest_text explicitly,
74 # the params[:select] code gets confused by the way we
75 # expose manifest_text as unsigned_manifest_text in
76 # the API response, and never let clients select the
77 # unsigned_manifest_text column.
78 'unsigned_manifest_text' => ['manifest_text'],
83 def self.ignored_select_attributes
84 super + ["updated_at", "file_names"]
87 def self.limit_index_columns_read
91 FILE_TOKEN = /^[[:digit:]]+:[[:digit:]]+:/
93 throw(:abort) if self.manifest_text.nil?
95 return true if current_user.andand.is_admin
97 # Provided the manifest_text hasn't changed materially since an
98 # earlier validation, it's safe to pass this validation on
99 # subsequent passes without checking any signatures. This is
100 # important because the signatures have probably been stripped off
101 # by the time we get to a second validation pass!
102 if @signatures_checked && @signatures_checked == computed_pdh
106 if self.manifest_text_changed?
107 # Check permissions on the collection manifest.
108 # If any signature cannot be verified, raise PermissionDeniedError
109 # which will return 403 Permission denied to the client.
110 api_token = Thread.current[:token]
112 api_token: api_token,
113 now: @validation_timestamp.to_i,
115 self.manifest_text.each_line do |entry|
116 entry.split.each do |tok|
117 if tok == '.' or tok.starts_with? './'
119 elsif tok =~ FILE_TOKEN
120 # This is a filename token, not a blob locator. Note that we
121 # keep checking tokens after this, even though manifest
122 # format dictates that all subsequent tokens will also be
123 # filenames. Safety first!
124 elsif Blob.verify_signature tok, signing_opts
126 elsif Keep::Locator.parse(tok).andand.signature
127 # Signature provided, but verify_signature did not like it.
128 logger.warn "Invalid signature on locator #{tok}"
129 raise ArvadosModel::PermissionDeniedError
130 elsif !Rails.configuration.Collections.BlobSigning
131 # No signature provided, but we are running in insecure mode.
132 logger.debug "Missing signature on locator #{tok} ignored"
133 elsif Blob.new(tok).empty?
134 # No signature provided -- but no data to protect, either.
136 logger.warn "Missing signature on locator #{tok}"
137 raise ArvadosModel::PermissionDeniedError
142 @signatures_checked = computed_pdh
145 def strip_signatures_and_update_replication_confirmed
146 if self.manifest_text_changed?
148 # manifest_text_was could be nil when dealing with a freshly created snapshot,
149 # so we skip this case because there was no real manifest change. (Bug #18005)
150 if (not self.replication_confirmed.nil?) and (not self.manifest_text_was.nil?)
151 self.class.each_manifest_locator(manifest_text_was) do |match|
152 in_old_manifest[match[1]] = true
156 stripped_manifest = self.class.munge_manifest_locators(manifest_text) do |match|
157 if not self.replication_confirmed.nil? and not in_old_manifest[match[1]]
158 # If the new manifest_text contains locators whose hashes
159 # weren't in the old manifest_text, storage replication is no
161 self.replication_confirmed_at = nil
162 self.replication_confirmed = nil
165 # Return the locator with all permission signatures removed,
166 # but otherwise intact.
167 match[0].gsub(/\+A[^+]*/, '')
170 if @computed_pdh_for_manifest_text == manifest_text
171 # If the cached PDH was valid before stripping, it is still
172 # valid after stripping.
173 @computed_pdh_for_manifest_text = stripped_manifest.dup
176 self[:manifest_text] = stripped_manifest
181 def ensure_pdh_matches_manifest_text
182 if not manifest_text_changed? and not portable_data_hash_changed?
184 elsif portable_data_hash.nil? or not portable_data_hash_changed?
185 self.portable_data_hash = computed_pdh
186 elsif portable_data_hash !~ Keep::Locator::LOCATOR_REGEXP
187 errors.add(:portable_data_hash, "is not a valid locator")
189 elsif portable_data_hash[0..31] != computed_pdh[0..31]
190 errors.add(:portable_data_hash,
191 "'#{portable_data_hash}' does not match computed hash '#{computed_pdh}'")
194 # Ignore the client-provided size part: always store
195 # computed_pdh in the database.
196 self.portable_data_hash = computed_pdh
200 def name_null_if_empty
207 if self.manifest_text_changed?
208 self.file_names = manifest_files
213 def set_file_count_and_total_size
214 # Only update the file stats if the manifest changed
215 if self.manifest_text_changed?
216 m = Keep::Manifest.new(self.manifest_text)
217 self.file_size_total = m.files_size
218 self.file_count = m.files_count
219 # If the manifest didn't change but the attributes did, ignore the changes
220 elsif self.file_count_changed? || self.file_size_total_changed?
221 self.file_count = self.file_count_was
222 self.file_size_total = self.file_size_total_was
228 return '' if !self.manifest_text
232 self.manifest_text.scan(/ \d+:\d+:(\S+)/) do |name|
235 names << name.first.gsub('\040',' ') + "\n"
237 self.manifest_text.scan(/^\.\/(\S+)/m) do |stream_name|
238 next if done[stream_name]
239 done[stream_name] = true
240 names << stream_name.first.gsub('\040',' ') + "\n"
245 def default_empty_manifest
246 self.manifest_text ||= ''
249 def skip_uuid_existence_check
250 # Avoid checking the existence of current_version_uuid, as it's
251 # assigned on creation of a new 'current version' collection, so
252 # the collection's UUID only lives on memory when the validation check
254 ['current_version_uuid']
257 def manage_versioning
258 should_preserve_version = should_preserve_version? # Time sensitive, cache value
259 return(yield) unless (should_preserve_version || syncable_updates.any?)
261 # Put aside the changes because with_lock does a record reload
262 changes = self.changes
266 # Copy the original state to save it as old version
267 if should_preserve_version
269 snapshot.uuid = nil # Reset UUID so it's created as a new record
270 snapshot.created_at = self.created_at
271 snapshot.modified_at = self.modified_at_was
274 # Restore requested changes on the current version
275 changes.keys.each do |attr|
276 if attr == 'preserve_version' && changes[attr].last == false && !should_preserve_version
277 next # Ignore false assignment, once true it'll be true until next version
279 self.attributes = {attr => changes[attr].last}
281 # Also update the current version reference
282 self.attributes = {'current_version_uuid' => changes[attr].last}
286 if should_preserve_version
292 sync_past_versions if syncable_updates.any?
294 snapshot.attributes = self.syncable_updates
295 leave_modified_by_user_alone do
296 leave_modified_at_alone do
297 act_as_system_user do
306 def maybe_update_modified_by_fields
307 if !(self.changes.keys - ['updated_at', 'preserve_version']).empty?
315 changes = self.changes
317 # If called after save...
318 changes = self.saved_changes
320 (syncable_attrs & changes.keys).each do |attr|
322 # Point old versions to current version's new UUID
323 updates['current_version_uuid'] = changes[attr].last
325 updates[attr] = changes[attr].last
331 def sync_past_versions
332 Collection.where('current_version_uuid = ? AND uuid != ?', self.uuid_before_last_save, self.uuid_before_last_save).update_all self.syncable_updates
335 def versionable_updates?(attrs)
336 (['manifest_text', 'description', 'properties', 'name'] & attrs).any?
340 ['uuid', 'owner_uuid', 'delete_at', 'trash_at', 'is_trashed', 'replication_desired', 'storage_classes_desired']
344 # Check for the '_was' values just in case the update operation
345 # includes a change on current_version_uuid or uuid.
346 !(new_record? || self.current_version_uuid_was == self.uuid_was)
349 def should_preserve_version?
350 return false unless (Rails.configuration.Collections.CollectionVersioning && versionable_updates?(self.changes.keys))
352 return false if self.is_trashed
354 idle_threshold = Rails.configuration.Collections.PreserveVersionIfIdle
355 if !self.preserve_version_was &&
356 !self.preserve_version &&
357 (idle_threshold < 0 ||
358 (idle_threshold > 0 && self.modified_at_was > db_current_time-idle_threshold.seconds))
365 if !(manifest_text.encoding.name == 'UTF-8' and manifest_text.valid_encoding?)
367 # If Ruby thinks the encoding is something else, like 7-bit
368 # ASCII, but its stored bytes are equal to the (valid) UTF-8
369 # encoding of the same string, we declare it to be a UTF-8
372 utf8.force_encoding Encoding::UTF_8
373 if utf8.valid_encoding? and utf8 == manifest_text.encode(Encoding::UTF_8)
374 self.manifest_text = utf8
379 errors.add :manifest_text, "must use UTF-8 encoding"
384 def check_manifest_validity
386 Keep::Manifest.validate! manifest_text
388 rescue ArgumentError => e
389 errors.add :manifest_text, e.message
394 def signed_manifest_text_only_for_tests
395 if !has_attribute? :manifest_text
400 token = Thread.current[:token]
401 exp = [db_current_time.to_i + Rails.configuration.Collections.BlobSigningTTL.to_i,
402 trash_at].compact.map(&:to_i).min
403 self.class.sign_manifest_only_for_tests manifest_text, token, exp
407 def self.sign_manifest_only_for_tests manifest, token, exp=nil
409 exp = db_current_time.to_i + Rails.configuration.Collections.BlobSigningTTL.to_i
415 m = munge_manifest_locators(manifest) do |match|
416 Blob.sign_locator(match[0], signing_opts)
421 def self.munge_manifest_locators manifest
422 # Given a manifest text and a block, yield the regexp MatchData
423 # for each locator. Return a new manifest in which each locator
424 # has been replaced by the block's return value.
425 return nil if !manifest
426 return '' if manifest == ''
429 manifest.each_line do |line|
432 line.split(' ').each do |word|
435 elsif match = Keep::Locator::LOCATOR_REGEXP.match(word)
436 new_words << yield(match)
441 new_lines << new_words.join(' ')
443 new_lines.join("\n") + "\n"
446 def self.each_manifest_locator manifest
447 # Given a manifest text and a block, yield the regexp match object
449 manifest.each_line do |line|
450 # line will have a trailing newline, but the last token is never
451 # a locator, so it's harmless here.
452 line.split(' ').each do |word|
453 if match = Keep::Locator::LOCATOR_REGEXP.match(word)
460 def self.normalize_uuid uuid
463 uuid.split('+').each do |token|
464 if token.match(/^[0-9a-f]{32,}$/)
465 raise "uuid #{uuid} has multiple hash parts" if hash_part
467 elsif token.match(/^\d+$/)
468 raise "uuid #{uuid} has multiple size parts" if size_part
472 raise "uuid #{uuid} has no hash part" if !hash_part
473 [hash_part, size_part].compact.join '+'
476 def self.get_compatible_images(readers, pattern, collections)
477 if collections.empty?
482 Link.where('tail_uuid in (?) AND link_class=? AND links.owner_uuid=?',
483 collections.map(&:portable_data_hash),
484 'docker_image_migration',
486 order('links.created_at asc').
488 [l.tail_uuid, l.head_uuid]
491 migrated_collections = Hash[
492 Collection.readable_by(*readers).
493 where('portable_data_hash in (?)', migrations.values).
495 [c.portable_data_hash, c]
498 collections.map { |c|
499 # Check if the listed image is compatible first, if not, then try the
501 manifest = Keep::Manifest.new(c.manifest_text)
502 if manifest.exact_file_count?(1) and manifest.files[0][1] =~ pattern
504 elsif m = migrated_collections[migrations[c.portable_data_hash]]
505 manifest = Keep::Manifest.new(m.manifest_text)
506 if manifest.exact_file_count?(1) and manifest.files[0][1] =~ pattern
513 # Resolve a Docker repo+tag, hash, or collection PDH to an array of
514 # Collection objects, sorted by timestamp starting with the most recent
517 # If filter_compatible_format is true (the default), only return image
518 # collections which are support by the installation as indicated by
519 # Rails.configuration.Containers.SupportedDockerImageFormats. Will follow
520 # 'docker_image_migration' links if search_term resolves to an incompatible
521 # image, but an equivalent compatible image is available.
522 def self.find_all_for_docker_image(search_term, search_tag=nil, readers=nil, filter_compatible_format: true)
523 readers ||= [Thread.current[:user]]
525 readable_by(*readers).
526 readable_by(*readers, table_name: "collections").
527 joins("JOIN collections ON links.head_uuid = collections.uuid").
528 order("links.created_at DESC")
530 docker_image_formats = Rails.configuration.Containers.SupportedDockerImageFormats.keys.map(&:to_s)
532 if (docker_image_formats.include? 'v1' and
533 docker_image_formats.include? 'v2') or filter_compatible_format == false
534 pattern = /^(sha256:)?[0-9A-Fa-f]{64}\.tar$/
535 elsif docker_image_formats.include? 'v2'
536 pattern = /^(sha256:)[0-9A-Fa-f]{64}\.tar$/
537 elsif docker_image_formats.include? 'v1'
538 pattern = /^[0-9A-Fa-f]{64}\.tar$/
540 raise "Unrecognized configuration for docker_image_formats #{docker_image_formats}"
543 # If the search term is a Collection locator that contains one file
544 # that looks like a Docker image, return it.
545 if loc = Keep::Locator.parse(search_term)
547 coll_match = readable_by(*readers).where(portable_data_hash: loc.to_s).limit(1)
548 rc = Rails.configuration.RemoteClusters.select{ |k|
549 k != :"*" && k != Rails.configuration.ClusterID}
550 if coll_match.any? or rc.length == 0
551 return get_compatible_images(readers, pattern, coll_match)
553 # Allow bare pdh that doesn't exist in the local database so
554 # that federated container requests which refer to remotely
555 # stored containers will validate.
556 return [Collection.new(portable_data_hash: loc.to_s)]
560 if search_tag.nil? and (n = search_term.index(":"))
561 search_tag = search_term[n+1..-1]
562 search_term = search_term[0..n-1]
565 # Find Collections with matching Docker image repository+tag pairs.
566 matches = base_search.
567 where(link_class: "docker_image_repo+tag",
568 name: "#{search_term}:#{search_tag || 'latest'}")
570 # If that didn't work, find Collections with matching Docker image hashes.
572 matches = base_search.
573 where("link_class = ? and links.name LIKE ?",
574 "docker_image_hash", "#{search_term}%")
577 # Generate an order key for each result. We want to order the results
578 # so that anything with an image timestamp is considered more recent than
579 # anything without; then we use the link's created_at as a tiebreaker.
581 matches.each do |link|
582 uuid_timestamps[link.head_uuid] = [(-link.properties["image_timestamp"].to_datetime.to_i rescue 0),
583 -link.created_at.to_i]
586 sorted = Collection.where('uuid in (?)', uuid_timestamps.keys).sort_by { |c|
587 uuid_timestamps[c.uuid]
589 compatible = get_compatible_images(readers, pattern, sorted)
590 if sorted.length > 0 and compatible.empty?
591 raise ArvadosModel::UnresolvableContainerError.new "Matching Docker image is incompatible with 'docker_image_formats' configuration."
596 def self.for_latest_docker_image(search_term, search_tag=nil, readers=nil)
597 find_all_for_docker_image(search_term, search_tag, readers).first
600 def self.searchable_columns operator
601 super - ["manifest_text"]
604 def self.full_text_searchable_columns
605 super - ["manifest_text", "storage_classes_desired", "storage_classes_confirmed", "current_version_uuid"]
610 # Although the defaults for these columns is already set up on the schema,
611 # collection creation from an API client seems to ignore them, making the
612 # validation on empty desired storage classes return an error.
613 def default_storage_classes
614 if self.storage_classes_desired.nil? || self.storage_classes_desired.empty?
615 self.storage_classes_desired = Rails.configuration.DefaultStorageClasses
617 self.storage_classes_confirmed ||= []
620 # Sets managed properties at creation time
621 def managed_properties
622 managed_props = Rails.configuration.Collections.ManagedProperties.with_indifferent_access
623 if managed_props.empty?
626 (managed_props.keys - self.properties.keys).each do |key|
627 if managed_props[key]['Function'] == 'original_owner'
628 self.properties[key] = self.user_owner_uuid
629 elsif managed_props[key]['Value']
630 self.properties[key] = managed_props[key]['Value']
632 logger.warn "Unidentified default property definition '#{key}': #{managed_props[key].inspect}"
637 def portable_manifest_text
638 self.class.munge_manifest_locators(manifest_text) do |match|
648 portable_manifest = portable_manifest_text
649 (Digest::MD5.hexdigest(portable_manifest) +
651 portable_manifest.bytesize.to_s)
655 if @computed_pdh_for_manifest_text == manifest_text
658 @computed_pdh = compute_pdh
659 @computed_pdh_for_manifest_text = manifest_text.dup
663 def ensure_permission_to_save
664 if (not current_user.andand.is_admin)
665 if (replication_confirmed_at_changed? or replication_confirmed_changed?) and
666 not (replication_confirmed_at.nil? and replication_confirmed.nil?)
667 raise ArvadosModel::PermissionDeniedError.new("replication_confirmed and replication_confirmed_at attributes cannot be changed, except by setting both to nil")
669 if (storage_classes_confirmed_changed? or storage_classes_confirmed_at_changed?) and
670 not (storage_classes_confirmed == [] and storage_classes_confirmed_at.nil?)
671 raise ArvadosModel::PermissionDeniedError.new("storage_classes_confirmed and storage_classes_confirmed_at attributes cannot be changed, except by setting them to [] and nil respectively")
677 def ensure_storage_classes_desired_is_not_empty
678 if self.storage_classes_desired.empty?
679 raise ArvadosModel::InvalidStateTransitionError.new("storage_classes_desired shouldn't be empty")
683 def ensure_storage_classes_contain_non_empty_strings
684 (self.storage_classes_desired + self.storage_classes_confirmed).each do |c|
685 if !c.is_a?(String) || c == ''
686 raise ArvadosModel::InvalidStateTransitionError.new("storage classes should only be non-empty strings")
691 def past_versions_cannot_be_updated
693 errors.add(:base, "past versions cannot be updated")
698 def protected_managed_properties_updates
699 managed_properties = Rails.configuration.Collections.ManagedProperties.with_indifferent_access
700 if managed_properties.empty? || !properties_changed? || current_user.is_admin
703 protected_props = managed_properties.keys.select do |p|
704 Rails.configuration.Collections.ManagedProperties[p]['Protected']
706 # Pre-existent protected properties can't be updated
707 invalid_updates = properties_was.keys.select{|p| properties_was[p] != properties[p]} & protected_props
708 if !invalid_updates.empty?
709 invalid_updates.each do |p|
710 errors.add("protected property cannot be updated:", p)
712 raise PermissionDeniedError.new
717 def versioning_metadata_updates
719 if !is_past_version? && current_version_uuid_changed?
720 errors.add(:current_version_uuid, "cannot be updated")
724 errors.add(:version, "cannot be updated")
732 self.current_version_uuid ||= self.uuid
737 super unless (saved_changes.keys - UNLOGGED_CHANGES).empty?