Class: Bottle

Inherits:
Object show all
Extended by:
Forwardable
Includes:
Downloadable
Defined in:
bottle.rb,
sorbet/rbi/dsl/bottle.rbi

Defined Under Namespace

Classes: Filename

Instance Attribute Summary collapse

Attributes included from Downloadable

#checksum, #mirrors, #phase

Instance Method Summary collapse

Methods included from Downloadable

#download_queue_message, #download_strategy, #downloaded!, #downloaded?, #downloading!, #extracting!, #fetched_size, #freeze, #initialize_dup, verification_cache, #verified!, #verifying!, #version

Methods included from Utils::Output::Mixin

#issue_reporting_message, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #opoo_without_github_actions_annotation, #pretty_cannot_install, #pretty_deprecated, #pretty_disabled, #pretty_duration, #pretty_install_status, #pretty_installed, #pretty_uninstalled, #pretty_unmarked, #pretty_upgradable, #pretty_warning

Methods included from Context

current, current=, #debug?, #deferred_environment_expansion?, #quiet?, #verbose?, #with_context

Constructor Details

#initialize(formula, spec, tag = nil, name: nil, pkg_version: nil) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'bottle.rb', line 97

def initialize(formula, spec, tag = nil, name: nil, pkg_version: nil)
  super()

  resource_name = T.let(nil, T.nilable(String))
  if formula
    name = formula.name
    pkg_version = formula.pkg_version
  else
    raise ArgumentError, "Bottle name is required" if name.nil?
    raise ArgumentError, "Bottle version is required" if pkg_version.nil?

    resource_name = name
  end

  @name = T.let(name, String)
  @pkg_version = T.let(pkg_version, PkgVersion)
  @resource = T.let(Resource.new(resource_name), Resource)
  @resource.owner = formula if formula
  @spec = spec

  tag_spec = spec.tag_specification_for(Utils::Bottles.tag(tag))

  odie "#{@name} tag specification for tag #{tag} is nil" if tag_spec.nil?

  @tag = T.let(tag_spec.tag, Utils::Bottles::Tag)
  @cellar = T.let(tag_spec.cellar, T.any(String, Symbol))
  @rebuild = T.let(spec.rebuild, Integer)

  @resource.version(@pkg_version.to_s)
  @resource.checksum = tag_spec.checksum

  @fetch_tab_retried = T.let(false, T::Boolean)

  root_url(spec.root_url, spec.root_url_specs)
end

Instance Attribute Details

#cellar ⇒ String, Symbol (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



80
81
82
 
# File 'bottle.rb', line 80

def cellar
  @cellar
end

#name ⇒ String (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



71
72
73
 
# File 'bottle.rb', line 71

def name
  @name
end

#rebuild ⇒ Integer (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



83
84
85
 
# File 'bottle.rb', line 83

def rebuild
  @rebuild
end

#resource ⇒ Resource (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



74
75
76
 
# File 'bottle.rb', line 74

def resource
  @resource
end

#tag ⇒ Utils::Bottles::Tag (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



77
78
79
 
# File 'bottle.rb', line 77

def tag
  @tag
end

Instance Method Details

#bottle_size ⇒ Integer?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



290
291
292
293
294
295
 
# File 'bottle.rb', line 290

def bottle_size
  resource = github_packages_manifest_resource
  return unless resource&.downloaded?

  resource.bottle_size
end

#built_cellar ⇒ Symbol, String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



229
230
231
232
233
234
235
236
 
# File 'bottle.rb', line 229

def built_cellar
  tab = tab_attributes
  if tab["padded_prefix"] == true && (built_prefix = tab["built_prefix"])
    "#{built_prefix}/Cellar"
  else
    @spec.tag_to_cellar(@tag)
  end
end

#cached_download(*args, &block) ⇒ T.untyped

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


10
 
# File 'sorbet/rbi/dsl/bottle.rbi', line 10

def cached_download(*args, &block); end

#clear_cache ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.



212
213
214
215
216
 
# File 'bottle.rb', line 212

def clear_cache
  @resource.clear_cache
  github_packages_manifest_resource&.clear_cache
  @fetch_tab_retried = false
end

#compatible_locations? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean) 


219
220
221
222
223
224
225
226
 
# File 'bottle.rb', line 219

def compatible_locations?
  return true if compatible_locations_from_tab?

  fetch_tab(quiet: true)
  compatible_locations_from_tab?
rescue DownloadError, Resource::BottleManifest::Error
  false
end

#discard_corrupt_cached_download(known_corrupt: false) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • known_corrupt (Boolean) (defaults to: false) 


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'bottle.rb', line 188

def discard_corrupt_cached_download(known_corrupt: false)
  expected_checksum = resource.checksum
  return if expected_checksum.nil?
  return unless cached_download.file?

  unless known_corrupt
    # The remembered digest cannot be trusted here: the failed extraction
    # may mean the file was corrupted in place without changing the
    # metadata that keys the digest cache, so forget it and hash afresh.
    verification_cache = Downloadable.verification_cache
    verification_cache.invalidate!(cached_download)
    return if verification_cache.sha256(cached_download) == expected_checksum.hexdigest
  end

  opoo "Removing corrupt cached download: #{cached_download.basename}"
  clear_cache
end

#download_queue_name ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



446
 
# File 'bottle.rb', line 446

def download_queue_name = "#{name} (#{resource.version})"

#download_queue_type ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



443
 
# File 'bottle.rb', line 443

def download_queue_type = "Bottle"

#downloaded_and_valid? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Whether the cached bottle can be reused without downloading it again. An immutable GitHub Packages blob is named after its own digest, so matching that name is enough to skip the download — but it says nothing about the file's contents, which every consumer must still verify before extracting.

Returns:

  • (Boolean) 


154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'bottle.rb', line 154

def downloaded_and_valid?
  return false unless cached_download.file?

  resource_checksum = resource.checksum
  return false if resource_checksum.nil?

  downloader = resource.downloader
  return false unless downloader.is_a?(CurlGitHubPackagesDownloadStrategy)
  return false unless downloader.immutable_bottle_blob?

  downloader.bottle_blob_sha256 == resource_checksum.hexdigest
end

#downloader(*args, &block) ⇒ T.untyped

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


13
 
# File 'sorbet/rbi/dsl/bottle.rbi', line 13

def downloader(*args, &block); end

#fetch(verify_download_integrity: true, timeout: nil, quiet: false) ⇒ Pathname

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • verify_download_integrity (Boolean) (defaults to: true)
  • timeout (Integer, Float, nil) (defaults to: nil)
  • quiet (Boolean) (defaults to: false)

Returns:



140
141
142
143
144
145
146
147
 
# File 'bottle.rb', line 140

def fetch(verify_download_integrity: true, timeout: nil, quiet: false)
  resource.fetch(verify_download_integrity:, timeout:, quiet:)
rescue DownloadError
  raise unless fallback_on_error?

  fetch_tab
  retry
end

#fetch_tab(timeout: nil, quiet: false) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • timeout (Integer, Float, nil) (defaults to: nil)
  • quiet (Boolean) (defaults to: false) 


265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'bottle.rb', line 265

def fetch_tab(timeout: nil, quiet: false)
  return unless (resource = github_packages_manifest_resource)

  begin
    # `$HOMEBREW_BOTTLE_DOMAIN` fallback is configured on the resource below.
    resource.fetch(timeout:, quiet:)
  rescue Resource::BottleManifest::Error
    raise if @fetch_tab_retried

    @fetch_tab_retried = true
    resource.clear_cache
    retry
  end
end

#filename ⇒ Filename

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



322
 
# File 'bottle.rb', line 322

def filename = Filename.new(@name, @pkg_version, @tag, @spec.rebuild)

#github_packages_manifest_resource ⇒ Resource::BottleManifest?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'bottle.rb', line 403

def github_packages_manifest_resource
  # `$HOMEBREW_BOTTLE_DOMAIN` may be a legacy flat-file mirror, so its
  # bottle resource does not necessarily use the GitHub Packages strategy.
  custom_bottle_domain = Homebrew::EnvConfig.bottle_domain_custom? &&
                         root_url == Homebrew::EnvConfig.bottle_domain
  return if @resource.download_strategy != CurlGitHubPackagesDownloadStrategy && !custom_bottle_domain

  @github_packages_manifest_resource ||= T.let(
    begin
      resource = Resource::BottleManifest.new(self)

      resource_version = @resource.version
      odie "resource version is nil" if resource_version.nil?

      version_rebuild = GitHubPackages.version_rebuild(resource_version, rebuild)
      resource.version(version_rebuild)

      image_name = GitHubPackages.image_formula_name(@name)
      image_tag = GitHubPackages.image_version_rebuild(version_rebuild)
      manifest_path = "#{image_name}/manifests/#{image_tag}"
      resource.url(
        "#{root_url}/#{manifest_path}",
        using:   CurlGitHubPackagesDownloadStrategy,
        headers: ["Accept: application/vnd.oci.image.index.v1+json"],
      )
      # Give a legacy mirror the first chance to serve the manifest. Many
      # contain only bottle archives, so retain GHCR as a fallback. By
      # contrast, `$HOMEBREW_ARTIFACT_DOMAIN` must provide an OCI registry
      # proxy for bottle blobs and manifests; the strategy rewrites the GHCR
      # URL for it.
      resource.mirror("#{HOMEBREW_BOTTLE_DEFAULT_DOMAIN}/#{manifest_path}") if custom_bottle_domain
      T.cast(resource.downloader, CurlGitHubPackagesDownloadStrategy).resolved_basename =
        "#{name}-#{version_rebuild}.bottle_manifest.json"
      resource
    end,
    T.nilable(Resource::BottleManifest),
  )
end

#installed_size ⇒ Integer?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



298
299
300
301
302
303
 
# File 'bottle.rb', line 298

def installed_size
  resource = github_packages_manifest_resource
  return unless resource&.downloaded?

  resource.installed_size
end

#path_exec_files ⇒ Array<String>?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



306
307
308
309
310
311
 
# File 'bottle.rb', line 306

def path_exec_files
  resource = github_packages_manifest_resource
  return unless resource&.downloaded?

  resource.path_exec_files
end

#purge_staged_from_download_queue ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.



382
383
384
385
386
 
# File 'bottle.rb', line 382

def purge_staged_from_download_queue
  keg = staged_path_from_download_queue
  FileUtils.rm_rf([staged_path_from_download_queue_marker, keg])
  Utils::Path.rmdir_if_possible(keg.parent)
end

#sbom_supplement ⇒ Hash{String => Object}?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



314
315
316
317
318
319
 
# File 'bottle.rb', line 314

def sbom_supplement
  resource = github_packages_manifest_resource
  return unless resource&.downloaded_and_valid?

  resource.sbom_supplement
end

#skip_relocation? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Does the bottle need to be relocated?

Returns:

  • (Boolean) 


240
241
242
243
244
 
# File 'bottle.rb', line 240

def skip_relocation?
  attrs = tab_attributes
  tab = Tab.new(**attrs.transform_keys(&:to_sym)) unless attrs.empty?
  @spec.skip_relocation?(tag: @tag, tab:)
end

#stage ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'bottle.rb', line 247

def stage
  with_corrupt_download_retry do
    with_verified_snapshot(cached_download) do |snapshot|
      UnpackStrategy.detect(snapshot, prioritize_extension: true, temporary_directory: snapshot.dirname)
                    .extract_nestedly(basename:             downloader.basename,
                                      prioritize_extension: true,
                                      verbose:              verbose? && !downloader.quiet?)
    end
  end
rescue ChecksumMismatchError
  # The retry's fresh download can itself fail verification, raising from
  # inside the rescue clause above: remove the known-bad download so the
  # next attempt fetches it again.
  clear_cache
  raise
end

#stage_from_download_queue(download, pour:) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'bottle.rb', line 341

def stage_from_download_queue(download, pour:)
  return unless pour

  bottle_tmp_keg = staged_path_from_download_queue
  bottle_poured_file = staged_path_from_download_queue_marker

  # Stay quiet on the retry: the download queue is redrawing its own
  # progress lines while this runs in a worker thread.
  with_corrupt_download_retry(quiet: true) do
    # Never reuse a marker or keg already here: sandboxed build and
    # postinstall steps may have written them.
    purge_staged_from_download_queue

    with_verified_snapshot(download) do |snapshot|
      UnpackStrategy.detect(snapshot, prioritize_extension: true, temporary_directory: snapshot.dirname)
                    .extract_nestedly(to: HOMEBREW_TEMP_CELLAR)
    end

    # Create a separate file to mark a completed extraction. This avoids
    # a potential race condition if a user interrupts the install.
    # We use a symlink to easily check that both this extra status file
    # and the real extracted directory exist via `Pathname#exist?`.
    FileUtils.ln_s(bottle_tmp_keg, bottle_poured_file)
  # Catch any exception type here to clean up partial queued extractions.
  rescue Exception # rubocop:disable Lint/RescueException
    Utils::Interrupts.ignore { purge_staged_from_download_queue }
    raise
  end
end

#stage_from_download_queue?(_download, pour:) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

  • (Boolean) 


336
337
338
 
# File 'bottle.rb', line 336

def stage_from_download_queue?(_download, pour:)
  pour
end

#staged_from_download_queue? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Whether the download queue left a keg here that pour may move into the Cellar: the marker must point at the expected keg and the keg must be a real directory, so entries planted by other processes are ignored.

Returns:

  • (Boolean) 


375
376
377
378
379
 
# File 'bottle.rb', line 375

def staged_from_download_queue?
  marker = staged_path_from_download_queue_marker
  keg = staged_path_from_download_queue
  marker.symlink? && marker.readlink == keg && !keg.symlink? && keg.directory?
end

#staged_path_from_download_queue ⇒ Pathname

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



325
326
327
328
 
# File 'bottle.rb', line 325

def staged_path_from_download_queue
  bottle_filename = filename
  HOMEBREW_TEMP_CELLAR/bottle_filename.name/bottle_filename.version.to_s
end

#staged_path_from_download_queue_marker ⇒ Pathname

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



331
332
333
 
# File 'bottle.rb', line 331

def staged_path_from_download_queue_marker
  Pathname("#{staged_path_from_download_queue}.poured")
end

#tab_attributes ⇒ Hash{String => T.untyped}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



281
282
283
284
285
286
287
 
# File 'bottle.rb', line 281

def tab_attributes
  if (resource = github_packages_manifest_resource) && resource.downloaded?
    return resource.tab
  end

  {}
end

#total_size ⇒ Integer?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



207
208
209
 
# File 'bottle.rb', line 207

def total_size
  bottle_size || super
end

#url(*args, &block) ⇒ T.untyped

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


16
 
# File 'sorbet/rbi/dsl/bottle.rbi', line 16

def url(*args, &block); end

#verify_download_integrity(*args, &block) ⇒ T.untyped

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


19
 
# File 'sorbet/rbi/dsl/bottle.rbi', line 19

def verify_download_integrity(*args, &block); end

#with_corrupt_download_retry(quiet: false, &_block) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Callers verify the cached download before consuming it. On failure, discard the cached file only when it is genuinely corrupt and retry once with a fresh download; a file that matches its checksum is kept and the original error re-raised.

Parameters:

  • quiet (Boolean) (defaults to: false)
  • _block (T.proc.void) 


172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'bottle.rb', line 172

def with_corrupt_download_retry(quiet: false, &_block)
  yield
rescue => e
  # A checksum mismatch has already hashed the file and proven it
  # corrupt; only other failures, e.g. during extraction, need a fresh
  # hash to decide whether the file can be kept.
  discard_corrupt_cached_download(known_corrupt: e.is_a?(ChecksumMismatchError))
  raise if cached_download.exist?

  downloading!
  fetch(quiet:)
  extracting!
  yield
end

#with_verified_snapshot(download, &_block) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Verify a private copy of the download and hand it to the block, so the bytes extracted are the bytes verified even if the cached download is changed underneath by a process with write access to the cache.

Parameters:



392
393
394
395
396
397
398
399
400
 
# File 'bottle.rb', line 392

def with_verified_snapshot(download, &_block)
  HOMEBREW_TEMP_CELLAR.mkpath
  Dir.mktmpdir("verify-", HOMEBREW_TEMP_CELLAR) do |directory|
    snapshot = Pathname(directory)/download.basename
    FileUtils.copy_file(download, snapshot)
    verify_download_integrity(snapshot)
    yield snapshot
  end
end