X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/0f361d9a0748e2b470ed5bc73351cb2eaf3e02e3..02f24a0c4a01a7ab46645c21630b9f48065b4b96:/services/api/app/models/collection.rb diff --git a/services/api/app/models/collection.rb b/services/api/app/models/collection.rb index 901084c763..4772768c8f 100644 --- a/services/api/app/models/collection.rb +++ b/services/api/app/models/collection.rb @@ -1,24 +1,33 @@ +# Copyright (C) The Arvados Authors. All rights reserved. +# +# SPDX-License-Identifier: AGPL-3.0 + require 'arvados/keep' +require 'sweep_trashed_objects' +require 'trashable' class Collection < ArvadosModel + extend CurrentApiClient extend DbCurrentTime include HasUuid include KindAndEtag include CommonApiTemplate + include Trashable serialize :properties, Hash + serialize :storage_classes_desired, Array + serialize :storage_classes_confirmed, Array before_validation :default_empty_manifest + before_validation :default_storage_classes, on: :create before_validation :check_encoding before_validation :check_manifest_validity before_validation :check_signatures before_validation :strip_signatures_and_update_replication_confirmed validate :ensure_pdh_matches_manifest_text + validate :ensure_storage_classes_desired_is_not_empty + validate :ensure_storage_classes_contain_non_empty_strings before_save :set_file_names - before_save :expires_at_not_in_past - - # Query only undeleted collections by default. - default_scope where("expires_at IS NULL or expires_at > statement_timestamp()") api_accessible :user, extend: :common do |t| t.add :name @@ -26,10 +35,16 @@ class Collection < ArvadosModel t.add :properties t.add :portable_data_hash t.add :signed_manifest_text, as: :manifest_text + t.add :manifest_text, as: :unsigned_manifest_text t.add :replication_desired t.add :replication_confirmed t.add :replication_confirmed_at - t.add :expires_at + t.add :storage_classes_desired + t.add :storage_classes_confirmed + t.add :storage_classes_confirmed_at + t.add :delete_at + t.add :trash_at + t.add :is_trashed end after_initialize do @@ -45,9 +60,10 @@ class Collection < ArvadosModel # API response, and never let clients select the # manifest_text column. # - # We need expires_at to determine the correct - # timestamp in signed_manifest_text. - 'manifest_text' => ['manifest_text', 'expires_at'], + # We need trash_at and is_trashed to determine the + # correct timestamp in signed_manifest_text. + 'manifest_text' => ['manifest_text', 'trash_at', 'is_trashed'], + 'unsigned_manifest_text' => ['manifest_text'], ) end @@ -55,6 +71,10 @@ class Collection < ArvadosModel super + ["updated_at", "file_names"] end + def self.limit_index_columns_read + ["manifest_text"] + end + FILE_TOKEN = /^[[:digit:]]+:[[:digit:]]+:/ def check_signatures return false if self.manifest_text.nil? @@ -77,7 +97,7 @@ class Collection < ArvadosModel api_token = current_api_client_authorization.andand.api_token signing_opts = { api_token: api_token, - now: db_current_time.to_i, + now: @validation_timestamp.to_i, } self.manifest_text.each_line do |entry| entry.split.each do |tok| @@ -153,7 +173,7 @@ class Collection < ArvadosModel false elsif portable_data_hash[0..31] != computed_pdh[0..31] errors.add(:portable_data_hash, - "does not match computed hash #{computed_pdh}") + "'#{portable_data_hash}' does not match computed hash '#{computed_pdh}'") false else # Ignore the client-provided size part: always store @@ -225,11 +245,15 @@ class Collection < ArvadosModel end def signed_manifest_text - if has_attribute? :manifest_text + if !has_attribute? :manifest_text + return nil + elsif is_trashed + return manifest_text + else token = current_api_client_authorization.andand.api_token exp = [db_current_time.to_i + Rails.configuration.blob_signature_ttl, - expires_at].compact.map(&:to_i).min - @signed_manifest_text = self.class.sign_manifest manifest_text, token, exp + trash_at].compact.map(&:to_i).min + self.class.sign_manifest manifest_text, token, exp end end @@ -302,8 +326,53 @@ class Collection < ArvadosModel [hash_part, size_part].compact.join '+' end - # Return array of Collection objects - def self.find_all_for_docker_image(search_term, search_tag=nil, readers=nil) + def self.get_compatible_images(readers, pattern, collections) + if collections.empty? + return [] + end + + migrations = Hash[ + Link.where('tail_uuid in (?) AND link_class=? AND links.owner_uuid=?', + collections.map(&:portable_data_hash), + 'docker_image_migration', + system_user_uuid). + order('links.created_at asc'). + map { |l| + [l.tail_uuid, l.head_uuid] + }] + + migrated_collections = Hash[ + Collection.readable_by(*readers). + where('portable_data_hash in (?)', migrations.values). + map { |c| + [c.portable_data_hash, c] + }] + + collections.map { |c| + # Check if the listed image is compatible first, if not, then try the + # migration link. + manifest = Keep::Manifest.new(c.manifest_text) + if manifest.exact_file_count?(1) and manifest.files[0][1] =~ pattern + c + elsif m = migrated_collections[migrations[c.portable_data_hash]] + manifest = Keep::Manifest.new(m.manifest_text) + if manifest.exact_file_count?(1) and manifest.files[0][1] =~ pattern + m + end + end + }.compact + end + + # Resolve a Docker repo+tag, hash, or collection PDH to an array of + # Collection objects, sorted by timestamp starting with the most recent + # match. + # + # If filter_compatible_format is true (the default), only return image + # collections which are support by the installation as indicated by + # Rails.configuration.docker_image_formats. Will follow + # 'docker_image_migration' links if search_term resolves to an incompatible + # image, but an equivalent compatible image is available. + def self.find_all_for_docker_image(search_term, search_tag=nil, readers=nil, filter_compatible_format: true) readers ||= [Thread.current[:user]] base_search = Link. readable_by(*readers). @@ -311,20 +380,23 @@ class Collection < ArvadosModel joins("JOIN collections ON links.head_uuid = collections.uuid"). order("links.created_at DESC") + if (Rails.configuration.docker_image_formats.include? 'v1' and + Rails.configuration.docker_image_formats.include? 'v2') or filter_compatible_format == false + pattern = /^(sha256:)?[0-9A-Fa-f]{64}\.tar$/ + elsif Rails.configuration.docker_image_formats.include? 'v2' + pattern = /^(sha256:)[0-9A-Fa-f]{64}\.tar$/ + elsif Rails.configuration.docker_image_formats.include? 'v1' + pattern = /^[0-9A-Fa-f]{64}\.tar$/ + else + raise "Unrecognized configuration for docker_image_formats #{Rails.configuration.docker_image_formats}" + end + # If the search term is a Collection locator that contains one file # that looks like a Docker image, return it. if loc = Keep::Locator.parse(search_term) loc.strip_hints! - coll_match = readable_by(*readers).where(portable_data_hash: loc.to_s).limit(1).first - if coll_match - # Check if the Collection contains exactly one file whose name - # looks like a saved Docker image. - manifest = Keep::Manifest.new(coll_match.manifest_text) - if manifest.exact_file_count?(1) and - (manifest.files[0][1] =~ /^(sha256:)?[0-9A-Fa-f]{64}\.tar$/) - return [coll_match] - end - end + coll_match = readable_by(*readers).where(portable_data_hash: loc.to_s).limit(1) + return get_compatible_images(readers, pattern, coll_match) end if search_tag.nil? and (n = search_term.index(":")) @@ -348,11 +420,19 @@ class Collection < ArvadosModel # so that anything with an image timestamp is considered more recent than # anything without; then we use the link's created_at as a tiebreaker. uuid_timestamps = {} - matches.all.map do |link| + matches.each do |link| uuid_timestamps[link.head_uuid] = [(-link.properties["image_timestamp"].to_datetime.to_i rescue 0), -link.created_at.to_i] + end + + sorted = Collection.where('uuid in (?)', uuid_timestamps.keys).sort_by { |c| + uuid_timestamps[c.uuid] + } + compatible = get_compatible_images(readers, pattern, sorted) + if sorted.length > 0 and compatible.empty? + raise ArvadosModel::UnresolvableContainerError.new "Matching Docker image is incompatible with 'docker_image_formats' configuration." end - Collection.where('uuid in (?)', uuid_timestamps.keys).sort_by { |c| uuid_timestamps[c.uuid] } + compatible end def self.for_latest_docker_image(search_term, search_tag=nil, readers=nil) @@ -364,10 +444,26 @@ class Collection < ArvadosModel end def self.full_text_searchable_columns - super - ["manifest_text"] + super - ["manifest_text", "storage_classes_desired", "storage_classes_confirmed"] + end + + def self.where *args + SweepTrashedObjects.sweep_if_stale + super end protected + + # Although the defaults for these columns is already set up on the schema, + # collection creation from an API client seems to ignore them, making the + # validation on empty desired storage classes return an error. + def default_storage_classes + if self.storage_classes_desired.nil? || self.storage_classes_desired.empty? + self.storage_classes_desired = ["default"] + end + self.storage_classes_confirmed ||= [] + end + def portable_manifest_text self.class.munge_manifest_locators(manifest_text) do |match| if match[2] # size @@ -395,21 +491,30 @@ class Collection < ArvadosModel end def ensure_permission_to_save - if (not current_user.andand.is_admin and - (replication_confirmed_at_changed? or replication_confirmed_changed?) and - not (replication_confirmed_at.nil? and replication_confirmed.nil?)) - raise ArvadosModel::PermissionDeniedError.new("replication_confirmed and replication_confirmed_at attributes cannot be changed, except by setting both to nil") + if (not current_user.andand.is_admin) + if (replication_confirmed_at_changed? or replication_confirmed_changed?) and + not (replication_confirmed_at.nil? and replication_confirmed.nil?) + raise ArvadosModel::PermissionDeniedError.new("replication_confirmed and replication_confirmed_at attributes cannot be changed, except by setting both to nil") + end + if (storage_classes_confirmed_changed? or storage_classes_confirmed_at_changed?) and + not (storage_classes_confirmed == [] and storage_classes_confirmed_at.nil?) + raise ArvadosModel::PermissionDeniedError.new("storage_classes_confirmed and storage_classes_confirmed_at attributes cannot be changed, except by setting them to [] and nil respectively") + end end super end - # If expires_at is being changed to a time in the past, change it to - # now. This allows clients to say "expires {client-current-time}" - # without failing due to clock skew, while avoiding odd log entries - # like "expiry date changed to {1 year ago}". - def expires_at_not_in_past - if expires_at_changed? and expires_at - self.expires_at = [db_current_time, expires_at].max + def ensure_storage_classes_desired_is_not_empty + if self.storage_classes_desired.empty? + raise ArvadosModel::InvalidStateTransitionError.new("storage_classes_desired shouldn't be empty") + end + end + + def ensure_storage_classes_contain_non_empty_strings + (self.storage_classes_desired + self.storage_classes_confirmed).each do |c| + if !c.is_a?(String) || c == '' + raise ArvadosModel::InvalidStateTransitionError.new("storage classes should only be non-empty strings") + end end end end