Skip to content

Minimize full copies #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
elohanlon merged 2 commits into from
Aug 13, 2025
Merged

Minimize full copies #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d04730b
configurable token passthrough (TRICLOPS-14)
barmintor Jun 23, 2025
f437b7a
do not redundantly store standard base image unless necessary (TRICLO…
barmintor Jun 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions app/controllers/iiif/images_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ def test_viewer
private

def require_token_if_resource_has_view_limitation!
return if TRICLOPS[:skip_tokens]
# Placeholder images don't ever require a token
return if @resource.identifier.start_with?('placeholder')

Expand Down
33 changes: 27 additions & 6 deletions app/models/concerns/triclops/resource/derivative_generation.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,38 @@ def raise_exception_if_base_derivative_dependency_missing!
missing_fields.join(', ')
end

# Generate the standard base path for the cache
def writeable_standard_base_path
Triclops::RasterCache.instance.base_cache_path(Triclops::Iiif::Constants::BASE_TYPE_STANDARD, self.identifier, mkdir_p: true)
end

# Generate the standard base path unless it would copy a locally readable original
def readable_standard_base_path
with_source_image_file do |source_image_file|
extname = File.extname(source_image_file.path.downcase)
return source_image_file.path if extname == Triclops::Iiif::Constants::BASE_IMAGE_EXTNAME
end
cached_base = writeable_standard_base_path
cached_base if File.exist?(cached_base)
end

def base_exists?(base_path)
base_path && File.exist?(base_path)
end

# Generates base derivatives
# rubocop:disable Metrics/AbcSize
def generate_base_derivatives_if_not_exist!
raise_exception_if_base_derivative_dependency_missing!
standard_base_path = Triclops::RasterCache.instance.base_cache_path(Triclops::Iiif::Constants::BASE_TYPE_STANDARD, self.identifier, mkdir_p: true)
standard_base_path = readable_standard_base_path
limited_base_path = Triclops::RasterCache.instance.base_cache_path(Triclops::Iiif::Constants::BASE_TYPE_LIMITED, self.identifier, mkdir_p: true)
featured_base_path = Triclops::RasterCache.instance.base_cache_path(Triclops::Iiif::Constants::BASE_TYPE_FEATURED, self.identifier, mkdir_p: true)

return if File.exist?(standard_base_path) && File.exist?(limited_base_path) && File.exist?(featured_base_path)
return if base_exists?(standard_base_path) && base_exists?(limited_base_path) && base_exists?(featured_base_path)

standard_base_path = writeable_standard_base_path unless base_exists?(standard_base_path)
self.with_source_image_file do |source_image_file|
# Use the original image to generate standard base
# Use the original image to generate standard base if necessary
unless File.exist?(standard_base_path)
Triclops::Raster.generate(
source_image_file.path,
Expand All @@ -51,7 +71,7 @@ def generate_base_derivatives_if_not_exist!
# Note: Technically the 'limited' base can be larger than the source image, if the source image
# has a long side that's smaller than LIMITED_BASE_SIZE. But that case will be rare, and
# shouldn't cause any issues.
unless File.exist?(limited_base_path)
unless base_exists?(limited_base_path)
Triclops::Raster.generate(
source_image_file.path,
limited_base_path,
Expand All @@ -76,7 +96,7 @@ def generate_base_derivatives_if_not_exist!
# has a long side that's smaller than FEATURED_BASE_SIZE. But that case will be rare, and
# shouldn't cause any issues.

unless File.exist?(featured_base_path)
unless base_exists?(featured_base_path)
Triclops::Raster.generate(
source_image_file.path,
featured_base_path,
Expand Down Expand Up @@ -118,7 +138,7 @@ def generate_commonly_requested_derivatives
# - Scaled versions at Triclops::Iiif::Constants::RECOMMENDED_SIZES.
# - IIIF zooming image viewer tiles
def generate_commonly_requested_standard_derivatives
standard_base_path = Triclops::RasterCache.instance.base_cache_path(Triclops::Iiif::Constants::BASE_TYPE_STANDARD, self.identifier)
standard_base_path = readable_standard_base_path

# Generate scaled rasters at Triclops::Iiif::Constants::RECOMMENDED_SIZES.
Triclops::Iiif::Constants::RECOMMENDED_SIZES.each do |size|
Expand Down Expand Up @@ -156,6 +176,7 @@ def generate_commonly_requested_standard_derivatives
Triclops::Iiif::Constants::TILE_SIZE,
'color'
) do |img, suggested_tile_dest_path, format, iiif_opts|
# iiif_opts keys are :region, :size, :rotation, :quality
FileUtils.mkdir_p(File.dirname(suggested_tile_dest_path))
Imogen::Iiif.convert(img, suggested_tile_dest_path, format, iiif_opts)
end
Expand Down
1 change: 1 addition & 0 deletions lib/triclops/iiif/constants.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ module Triclops::Iiif::Constants
}.freeze
DEFAULT_FORMAT = 'jpg'
BASE_IMAGE_FORMAT = 'png'
BASE_IMAGE_EXTNAME = ".#{BASE_IMAGE_FORMAT}".freeze
ALLOWED_QUALITIES = ['default', 'color', 'gray', 'bitonal'].freeze
BASE_QUALITY = 'color'
ALLOWED_ROTATIONS = [0, 90, 180, 270].freeze
Expand Down