Class: Cask::Installer Private

Inherits:
Object show all
Extended by:
Utils::Output::Mixin
Includes:
OS::Linux::Cask::Installer, Utils::Output::Mixin
Defined in:
cask/installer.rb

Overview

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

Installer for a Cask.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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_deprecated, pretty_disabled, pretty_duration, pretty_install_status, pretty_installed, pretty_uninstalled, pretty_unmarked, pretty_upgradable, pretty_warning

Constructor Details

#initialize(cask, command: SystemCommand, force: false, adopt: false, skip_cask_deps: false, binaries: true, verbose: false, zap: false, require_sha: false, upgrade: false, reinstall: false, installed_on_request: true, verify_download_integrity: true, quiet: false, download_queue: Homebrew.default_download_queue, defer_fetch: false, default_uninstall_artifacts: 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:

  • cask (::Cask::Cask)
  • command (T.class_of(SystemCommand)) (defaults to: SystemCommand)
  • force (Boolean) (defaults to: false)
  • adopt (Boolean) (defaults to: false)
  • skip_cask_deps (Boolean) (defaults to: false)
  • binaries (Boolean) (defaults to: true)
  • verbose (Boolean) (defaults to: false)
  • zap (Boolean) (defaults to: false)
  • require_sha (Boolean) (defaults to: false)
  • upgrade (Boolean) (defaults to: false)
  • reinstall (Boolean) (defaults to: false)
  • installed_on_request (Boolean) (defaults to: true)
  • verify_download_integrity (Boolean) (defaults to: true)
  • quiet (Boolean) (defaults to: false)
  • download_queue (Homebrew::DownloadQueue) (defaults to: Homebrew.default_download_queue)
  • defer_fetch (Boolean) (defaults to: false)
  • default_uninstall_artifacts (ArtifactSet, nil) (defaults to: nil) 


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'cask/installer.rb', line 38

def initialize(cask, command: SystemCommand, force: false, adopt: false,
               skip_cask_deps: false, binaries: true, verbose: false,
               zap: false, require_sha: false, upgrade: false, reinstall: false,
               installed_on_request: true,
               verify_download_integrity: true, quiet: false,
               download_queue: Homebrew.default_download_queue, defer_fetch: false,
               default_uninstall_artifacts: nil)
  @cask = cask
  @command = command
  @force = force
  @adopt = adopt
  @skip_cask_deps = skip_cask_deps
  @binaries = binaries
  @verbose = verbose
  @zap = zap
  @require_sha = require_sha
  @reinstall = reinstall
  @upgrade = upgrade
  @installed_on_request = installed_on_request
  @verify_download_integrity = verify_download_integrity
  @quiet = quiet
  @download_queue = download_queue
  @defer_fetch = defer_fetch
  @source_download = T.let(nil, T.nilable(Homebrew::API::SourceDownload))
  # Restricts what `#uninstall` removes, for artifacts that are shared with a cask
  # which must be kept installed.
  @default_uninstall_artifacts = default_uninstall_artifacts
  @ran_prelude_fetch = T.let(false, T::Boolean)
  @ran_prelude = T.let(false, T::Boolean)
  @cask_and_formula_dependencies = T.let(nil, T.nilable(T::Array[T.any(Formula, ::Cask::Cask)]))
  @dependency_cask_installers = T.let(nil, T.nilable(T::Array[Installer]))
  @dependency_formula_installers = T.let(nil, T.nilable(T::Array[FormulaInstaller]))
  @dependencies_enqueued = T.let(false, T::Boolean)
  @download_failed = T.let(false, T::Boolean)
  @installed_uninstall_artifacts_missing = T.let(false, T::Boolean)
end

Instance Attribute Details

#cask ⇒ ::Cask::Cask (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:



26
27
28
 
# File 'cask/installer.rb', line 26

def cask
  @cask
end

Class Method Details

.caveats(cask) ⇒ 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.

Parameters:

Returns:



115
116
117
118
119
120
121
122
123
124
125
 
# File 'cask/installer.rb', line 115

def self.caveats(cask)
  odebug "Printing caveats"

  caveats = record_caveats(cask)
  return unless caveats

  <<~EOS
    #{ohai_title "Caveats"}
    #{caveats}
  EOS
end

.record_caveats(cask) ⇒ 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.

Parameters:

Returns:



128
129
130
131
132
133
134
 
# File 'cask/installer.rb', line 128

def self.record_caveats(cask)
  caveats = cask.caveats
  return if caveats.empty?

  Homebrew.messages.record_caveats(cask.token, caveats)
  caveats
end

Instance Method Details

#adopt? ⇒ 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) 


76
 
# File 'cask/installer.rb', line 76

def adopt? = @adopt

#artifacts ⇒ ArtifactSet

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:



305
306
307
 
# File 'cask/installer.rb', line 305

def artifacts
  @default_uninstall_artifacts || @cask.artifacts
end

#backup ⇒ 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.



658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'cask/installer.rb', line 658

def backup
  bp = backup_path
  raise "unexpected nil backup_path" unless bp

  bmp = backup_metadata_path
  raise "unexpected nil backup_metadata_path" unless bmp

  # The staged files may already be gone (e.g. an out-of-band cask update);
  # skip the rename rather than raising and aborting the upgrade.
  @cask.staged_path.rename bp.to_s if @cask.staged_path.exist?
  @cask.metadata_versioned_path.rename bmp.to_s if @cask.metadata_versioned_path.exist?
end

#backup_metadata_path ⇒ 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:



781
782
783
784
785
 
# File 'cask/installer.rb', line 781

def backup_metadata_path
  return if @cask.metadata_versioned_path.nil?

  Pathname("#{@cask.metadata_versioned_path}.upgrading")
end

#backup_path ⇒ 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:



774
775
776
777
778
 
# File 'cask/installer.rb', line 774

def backup_path
  return if @cask.staged_path.nil?

  Pathname("#{@cask.staged_path}.upgrading")
end

#binaries? ⇒ 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) 


79
 
# File 'cask/installer.rb', line 79

def binaries? = @binaries

#cask_and_formula_dependencies ⇒ Array<Formula, ::Cask::Cask>

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:

Raises:



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'cask/installer.rb', line 431

def cask_and_formula_dependencies
  return @cask_and_formula_dependencies if @cask_and_formula_dependencies

  graph = ::Utils::TopologicalHash.graph_package_dependencies(@cask)

  raise CaskSelfReferencingDependencyError, @cask.token if graph.fetch(@cask).include?(@cask)

  pc = primary_container
  raise "unexpected nil primary_container" unless pc

  ::Utils::TopologicalHash.graph_package_dependencies(pc.dependencies, graph)

  @cask_and_formula_dependencies = graph.tsort_with_cycles do |cycles|
    cyclic_dependencies = cycles.sort_by(&:count).fetch(-1) - [@cask]
    raise CaskCyclicDependencyError.new(@cask.token, cyclic_dependencies.to_sentence)
  end - [@cask]
end

#check_arch_requirements ⇒ 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.

Raises:



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'cask/installer.rb', line 414

def check_arch_requirements
  return if @cask.depends_on.arch.nil?

  @current_arch = T.let(@current_arch, T.nilable(T::Hash[Symbol, T.nilable(T.any(Symbol, Integer))]))
  @current_arch ||= { type: Hardware::CPU.type, bits: Hardware::CPU.bits }
  return if @cask.depends_on.arch.any? do |arch|
    arch[:type] == @current_arch[:type] &&
    Array(arch[:bits]).include?(@current_arch[:bits])
  end

  raise CaskError,
        "#{@cask}: This cask depends on hardware architecture being one of " \
        "[#{@cask.depends_on.arch.join(", ")}], " \
        "but you are running #{@current_arch}."
end

#check_conflicts ⇒ 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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'cask/installer.rb', line 235

def check_conflicts
  return unless @cask.conflicts_with

  @cask.conflicts_with[:cask].each do |conflicting_cask|
    if (conflicting_cask_tap_with_token = Tap.with_cask_token(conflicting_cask))
      conflicting_cask_tap, = conflicting_cask_tap_with_token
      next unless conflicting_cask_tap.installed?
    end

    if (installed_caskfile = Caskroom.cask_installed_caskfile(conflicting_cask))
      raise CaskConflictError.new(
        @cask,
        ::Cask::Cask.new(CaskLoader.token_from_path(installed_caskfile)),
      )
    end

    conflicting_cask = CaskLoader.load(conflicting_cask)
    raise CaskConflictError.new(@cask, conflicting_cask) if conflicting_cask.installed?
  rescue CaskUnavailableError, Homebrew::UntrustedTapError
    next # Ignore conflicting Casks that are unavailable or untrusted.
  end
end

#check_deprecate_disable ⇒ 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.



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'cask/installer.rb', line 218

def check_deprecate_disable
  deprecate_disable_type = DeprecateDisable.type(@cask)
  return if deprecate_disable_type.nil?

  message = DeprecateDisable.message(@cask).to_s
  message_full = "#{@cask.token} has been #{message}"

  case deprecate_disable_type
  when :deprecated
    opoo message_full
  when :disabled
    GitHub::Actions.puts_annotation_if_env_set!(:error, message)
    raise CaskCannotBeInstalledError.new(@cask, message)
  end
end

#check_macos_requirements ⇒ 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.

Raises:



406
407
408
409
410
411
 
# File 'cask/installer.rb', line 406

def check_macos_requirements
  macos_requirement = [@cask.depends_on.macos, @cask.depends_on.maximum_macos].compact.find { !it.satisfied? }
  return unless macos_requirement

  raise CaskError, "#{@cask}: #{macos_requirement.message(type: :cask)}"
end

#check_requirements ⇒ 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.



380
381
382
383
384
385
 
# File 'cask/installer.rb', line 380

def check_requirements
  check_stanza_os_requirements
  check_supported_system
  check_macos_requirements
  check_arch_requirements
end

#check_stanza_os_requirements ⇒ 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.

Raises:



388
389
390
391
392
 
# File 'cask/installer.rb', line 388

def check_stanza_os_requirements
  return if @cask.supports_macos?

  raise CaskError, "#{@cask}: This cask requires Linux."
end

#check_supported_system ⇒ 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.

Raises:



395
396
397
398
399
400
401
402
403
 
# File 'cask/installer.rb', line 395

def check_supported_system
  # API data without an installable artifact means this system is unsupported.
  # Source loads keep working for unaudited casks, e.g. naked containers.
  return unless @cask.loaded_from_api?
  return if @cask.installable_artifact?

  os_name = Homebrew::SimulateSystem.simulating_or_running_on_macos? ? "macOS" : "Linux"
  raise CaskError, "#{@cask}: This cask is not available on #{os_name}."
end

#dependency_installers(defer_fetch: false) ⇒ Array<(Array<Installer>, Array<FormulaInstaller>)>

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:

  • defer_fetch (Boolean) (defaults to: false)

Returns:



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'cask/installer.rb', line 525

def dependency_installers(defer_fetch: false)
  if @dependency_cask_installers && @dependency_formula_installers
    return [@dependency_cask_installers, @dependency_formula_installers]
  end

  cask_installers = T.let([], T::Array[Installer])
  formula_installers = T.let([], T::Array[FormulaInstaller])
  missing_cask_and_formula_dependencies.each do |cask_or_formula|
    if cask_or_formula.is_a?(Cask)
      next if skip_cask_deps?

      cask_installers << Installer.new(
        cask_or_formula,
        adopt:                adopt?,
        binaries:             binaries?,
        force:                false,
        installed_on_request: false,
        quiet:                quiet?,
        require_sha:          require_sha?,
        verbose:              verbose?,
        download_queue:       @download_queue,
        defer_fetch:,
      )
    else
      formula_installers << FormulaInstaller.new(
        cask_or_formula,
        **{
          show_header:          true,
          installed_on_request: false,
          verbose:              verbose?,
        }.compact,
      )
    end
  end

  @dependency_cask_installers = cask_installers
  @dependency_formula_installers = formula_installers
  [cask_installers, formula_installers]
end

#download(quiet: nil, timeout: nil) ⇒ 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:

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

Returns:



291
292
293
294
295
 
# File 'cask/installer.rb', line 291

def download(quiet: nil, timeout: nil)
  # Store cask download path in cask to prevent multiple downloads in a row when checking if it's outdated
  @cask.download ||= downloader.fetch(quiet:, verify_download_integrity: @verify_download_integrity,
                                      timeout:)
end

#download_failed! ⇒ 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.



88
 
# File 'cask/installer.rb', line 88

def download_failed! = @download_failed = true

#download_failed? ⇒ 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) 


85
 
# File 'cask/installer.rb', line 85

def download_failed? = @download_failed

#downloader ⇒ Download

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:



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'cask/installer.rb', line 276

def downloader
  @downloader ||= T.let(
    (if @cask.loaded_from_internal_api? && !@cask.caskfile_only?
       Homebrew::API::CaskDownload.download(
         token:       @cask.token,
         cask_struct: Homebrew::API::Internal.cask_struct(@cask.token),
         languages:   @cask.config.languages,
         require_sha: require_sha? && !force?,
       )
    end) || Download.new(@cask, require_sha: require_sha? && !force?),
    T.nilable(Download),
  )
end

#enqueue_dependency_downloads ⇒ 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.



462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'cask/installer.rb', line 462

def enqueue_dependency_downloads
  return unless installed_on_request?

  cask_installers, formula_installers = dependency_installers(defer_fetch: true)
  if cask_installers.any?
    Homebrew::Install.enqueue_cask_installers(cask_installers,
                                              download_queue: @download_queue)
  end
  if formula_installers.any?
    @dependency_formula_installers = Homebrew::Install.enqueue_formulae(formula_installers,
                                                                        download_queue: @download_queue)
  end
  @dependencies_enqueued = true
end

#enqueue_downloads ⇒ 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.



1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'cask/installer.rb', line 1007

def enqueue_downloads
  download_queue = @download_queue
  prelude_fetch(download_queue:) unless @ran_prelude_fetch

  if source_download_requires_pre_fetch?
    load_cask_from_source_api!
  elsif cask_from_source_api?
    Homebrew::API::Cask.source_download(@cask, download_queue:, enqueue: true)
  end

  forbidden_tap_check
  forbidden_cask_and_formula_check
  forbidden_cask_artifacts_check

  download_queue.enqueue(downloader)
end

#extract_primary_container(to: @cask.staged_path) ⇒ 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:

  • to (Pathname) (defaults to: @cask.staged_path) 


310
311
312
313
314
 
# File 'cask/installer.rb', line 310

def extract_primary_container(to: @cask.staged_path)
  download(quiet: true) if @cask.download.nil?

  downloader.extract_primary_container(to:, verbose: verbose?)
end

#fetch(quiet: nil, timeout: 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.

This method returns an undefined value.

Parameters:

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


137
138
139
140
141
142
143
144
145
 
# File 'cask/installer.rb', line 137

def fetch(quiet: nil, timeout: nil)
  odebug "Cask::Installer#fetch"

  prelude

  download(quiet:, timeout:) unless @defer_fetch

  satisfy_cask_and_formula_dependencies
end

#finalize_upgrade ⇒ 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.



696
697
698
699
700
701
702
 
# File 'cask/installer.rb', line 696

def finalize_upgrade
  ohai "Purging files for version #{@cask.version} of Cask #{@cask}"

  purge_backed_up_versioned_files

  puts summary
end

#forbidden_cask_and_formula_check(cask_only: 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:

  • cask_only (Boolean) (defaults to: false) 


880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'cask/installer.rb', line 880

def forbidden_cask_and_formula_check(cask_only: false)
  forbid_casks = Homebrew::EnvConfig.forbid_casks?
  forbidden_formulae = Set.new(Homebrew::EnvConfig.forbidden_formulae.to_s.split)
  forbidden_casks = Set.new(Homebrew::EnvConfig.forbidden_casks.to_s.split)
  return if !forbid_casks && forbidden_formulae.blank? && forbidden_casks.blank?

  owner = Homebrew::EnvConfig.forbidden_owner
  owner_contact = if (contact = Homebrew::EnvConfig.forbidden_owner_contact.presence)
    "\n#{contact}"
  end

  cask_variable = if forbid_casks
    "HOMEBREW_FORBID_CASKS"
  elsif forbidden_casks.include?(@cask.token) || forbidden_casks.include?(@cask.full_name)
    "HOMEBREW_FORBIDDEN_CASKS"
  end

  if cask_variable
    raise CaskCannotBeInstalledError.new(@cask, <<~EOS
      forbidden for installation by #{owner} in `#{cask_variable}`.#{owner_contact}
    EOS
    )
  end

  return if cask_only
  return if skip_cask_deps?

  cask_and_formula_dependencies.each do |dep_cask_or_formula|
    dep_name, dep_type, variable = if dep_cask_or_formula.is_a?(Cask) && forbidden_casks.present?
      dep_cask = dep_cask_or_formula
      env_variable = "HOMEBREW_FORBIDDEN_CASKS"
      dep_cask_name = if forbidden_casks.include?(dep_cask.token)
        dep_cask.token
      elsif forbidden_casks.include?(dep_cask.full_name)
        dep_cask.full_name
      end
      [dep_cask_name, "cask", env_variable]
    elsif dep_cask_or_formula.is_a?(Formula) && forbidden_formulae.present?
      dep_formula = dep_cask_or_formula
      formula_name = if forbidden_formulae.include?(dep_formula.name)
        dep_formula.name
      elsif dep_formula.tap.present? &&
            forbidden_formulae.include?(dep_formula.full_name)
        dep_formula.full_name
      end
      [formula_name, "formula", "HOMEBREW_FORBIDDEN_FORMULAE"]
    end
    next if dep_name.blank?

    raise CaskCannotBeInstalledError.new(@cask, <<~EOS
      has a dependency #{dep_name} but the
      #{dep_name} #{dep_type} was forbidden for installation by #{owner} in `#{variable}`.#{owner_contact}
    EOS
    )
  end
end

#forbidden_cask_artifacts_check ⇒ 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.



938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'cask/installer.rb', line 938

def forbidden_cask_artifacts_check
  forbidden_artifacts = Set.new(Homebrew::EnvConfig.forbidden_cask_artifacts.to_s.split)
  return if forbidden_artifacts.blank?

  owner = Homebrew::EnvConfig.forbidden_owner
  owner_contact = if (contact = Homebrew::EnvConfig.forbidden_owner_contact.presence)
    "\n#{contact}"
  end

  artifacts.each do |artifact|
    # Get the artifact class name (e.g., "Pkg", "Installer", "App")
    artifact_name = artifact.class.name
    next if artifact_name.nil?

    artifact_type = artifact_name.split("::").last&.downcase
    next if artifact_type.nil?

    next unless forbidden_artifacts.include?(artifact_type)

    raise CaskCannotBeInstalledError.new(@cask, <<~EOS
      contains a '#{artifact_type}' artifact, which is forbidden for installation by #{owner} in `HOMEBREW_FORBIDDEN_CASK_ARTIFACTS`.#{owner_contact}
    EOS
    )
  end
end

#forbidden_tap_check(cask_only: 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:

  • cask_only (Boolean) (defaults to: false) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
 
# File 'cask/installer.rb', line 838

def forbidden_tap_check(cask_only: false)
  return if Tap.allowed_taps.blank? && Tap.forbidden_taps.blank?

  owner = Homebrew::EnvConfig.forbidden_owner
  owner_contact = if (contact = Homebrew::EnvConfig.forbidden_owner_contact.presence)
    "\n#{contact}"
  end

  # Check the cask itself before its dependencies, since dependency resolution
  # for casks triggers a download via `primary_container`.
  cask_tap = @cask.tap
  if cask_tap.present? && (!cask_tap.allowed_by_env? || cask_tap.forbidden_by_env?)
    cask_error_message = "The installation of #{@cask.full_name} has the tap #{cask_tap}\n" \
                         "but #{owner} "
    cask_error_message << "has not allowed this tap in `$HOMEBREW_ALLOWED_TAPS`" unless cask_tap.allowed_by_env?
    cask_error_message << " and\n" if !cask_tap.allowed_by_env? && cask_tap.forbidden_by_env?
    cask_error_message << "has forbidden this tap in `$HOMEBREW_FORBIDDEN_TAPS`" if cask_tap.forbidden_by_env?
    cask_error_message << ".#{owner_contact}"

    raise CaskCannotBeInstalledError.new(@cask, cask_error_message)
  end

  return if cask_only
  return if skip_cask_deps?

  cask_and_formula_dependencies.each do |cask_or_formula|
    dep_tap = cask_or_formula.tap
    next if dep_tap.blank? || (dep_tap.allowed_by_env? && !dep_tap.forbidden_by_env?)

    dep_full_name = cask_or_formula.full_name
    error_message = "The installation of #{@cask} has a dependency #{dep_full_name}\n" \
                    "from the #{dep_tap} tap but #{owner} "
    error_message << "has not allowed this tap in `$HOMEBREW_ALLOWED_TAPS`" unless dep_tap.allowed_by_env?
    error_message << " and\n" if !dep_tap.allowed_by_env? && dep_tap.forbidden_by_env?
    error_message << "has forbidden this tap in `$HOMEBREW_FORBIDDEN_TAPS`" if dep_tap.forbidden_by_env?
    error_message << ".#{owner_contact}"

    raise CaskCannotBeInstalledError.new(@cask, error_message)
  end
end

#force? ⇒ 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) 


82
 
# File 'cask/installer.rb', line 82

def force? = @force

#gain_permissions_remove(path) ⇒ 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:



788
789
790
 
# File 'cask/installer.rb', line 788

def gain_permissions_remove(path)
  Utils.gain_permissions_remove(path, command: @command)
end

#install ⇒ 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.



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'cask/installer.rb', line 172

def install
  raise CaskError, "Download failed for #{@cask}." if download_failed?

  start_time = Time.now
  odebug "Cask::Installer#install"

  Migrator.migrate_if_needed(@cask)

  old_config = @cask.config
  predecessor = @cask if reinstall? && @cask.installed?

  prelude

  record_caveats
  fetch
  uninstall_existing_cask if reinstall?

  backup if force? && @cask.staged_path.exist? && @cask.metadata_versioned_path.exist?

  oh1 "Installing Cask #{Formatter.identifier(@cask)}"
  stage

  @cask.config = @cask.default_config.merge(old_config)

  install_artifacts(predecessor:)

  tab = Tab.create(@cask)
  tab.installed_on_request = installed_on_request?
  tab.write

  if (tap = @cask.tap) && tap.should_report_analytics?
    ::Utils::Analytics.report_package_event(:cask_install, package_name: @cask.token, tap_name: tap.name,
on_request: true)
  end

  purge_backed_up_versioned_files

  puts summary
  end_time = Time.now
  Homebrew.messages.package_installed(@cask.token, end_time - start_time)
rescue
  restore_backup
  raise
end

#install_artifacts(predecessor: 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.

This method returns an undefined value.

Parameters:

  • predecessor (Cask, nil) (defaults to: nil) 


322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
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
370
371
372
373
374
375
376
377
 
# File 'cask/installer.rb', line 322

def install_artifacts(predecessor: nil)
  already_installed_artifacts = []

  odebug "Installing artifacts"

  artifacts.each do |artifact|
    next unless artifact.respond_to?(:install_phase)

    odebug "Installing artifact of class #{artifact.class}"

    next if artifact.is_a?(Artifact::Binary) && !binaries?

    artifact = T.cast(
      artifact,
      T.any(
        Artifact::AbstractFlightBlock,
        Artifact::GeneratedCompletion,
        Artifact::Installer,
        Artifact::KeyboardLayout,
        Artifact::Mdimporter,
        Artifact::Moved,
        Artifact::PostflightSteps,
        Artifact::PreflightSteps,
        Artifact::Pkg,
        Artifact::Qlplugin,
        Artifact::Symlinked,
      ),
    )

    artifact.install_phase(
      command: @command, verbose: verbose?, adopt: adopt?, auto_updates: @cask.auto_updates,
      force: force?, predecessor:
    )
    already_installed_artifacts.unshift(artifact)
  end

  save_config_file
  save_download_sha if @cask.version.latest?
rescue => e
  begin
    already_installed_artifacts&.each do |artifact|
      if artifact.respond_to?(:uninstall_phase)
        odebug "Reverting installation of artifact of class #{artifact.class}"
        artifact.uninstall_phase(command: @command, verbose: verbose?, force: force?)
      end

      next unless artifact.respond_to?(:post_uninstall_phase)

      odebug "Reverting installation of artifact of class #{artifact.class}"
      artifact.post_uninstall_phase(command: @command, verbose: verbose?, force: force?)
    end
  ensure
    purge_versioned_files
    raise e
  end
end

#installed_on_request? ⇒ 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) 


91
 
# File 'cask/installer.rb', line 91

def installed_on_request? = @installed_on_request

#load_installed_caskfile! ⇒ 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.

load the same cask file that was used for installation, if possible



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
 
# File 'cask/installer.rb', line 1026

def load_installed_caskfile!
  Migrator.migrate_if_needed(@cask)

  installed_caskfile = @cask.installed_caskfile
  @installed_uninstall_artifacts_missing = installed_caskfile.is_a?(Pathname) &&
                                           installed_uninstall_artifacts_missing?(installed_caskfile)

  if installed_caskfile&.exist?
    tab = CaskLoader.load_installed_tab(@cask)
    tap = tab.tap
    tap ||= @cask.tap
    if installed_caskfile.extname == ".rb" &&
       Homebrew::EnvConfig.require_tap_trust? &&
       tap &&
       !Homebrew::Trust.trusted?(:cask, "#{tap.name}/#{@cask.token}")
      opoo "Skipping loading untrusted Cask #{tap.name}/#{@cask.token}; uninstalling recorded artifacts only."

      dsl = DSL.new(@cask)
      default_uninstall_artifact_keys = DSL::ACTIVATABLE_ARTIFACT_CLASSES.filter_map do |klass|
        next if [Artifact::Uninstall, Artifact::Zap].include?(klass)
        next if !klass.method_defined?(:uninstall_phase) && !klass.method_defined?(:post_uninstall_phase)

        klass.dsl_key
      end.to_set
      Array(tab.uninstall_artifacts).each do |artifact_entry|
        next unless artifact_entry.is_a?(Hash)

        artifact_entry.each do |raw_key, raw_args|
          dsl_key = raw_key.to_sym
          next unless default_uninstall_artifact_keys.include?(dsl_key)

          args = Array(raw_args)
          if args.last.is_a?(Hash)
            dsl.public_send(
              dsl_key,
              *args[...-1],
              **T.cast(args.last, T::Hash[T.any(Symbol, String), T.anything]).transform_keys(&:to_sym),
            )
          else
            dsl.public_send(dsl_key, *args)
          end
        end
      end
      @default_uninstall_artifacts ||= dsl.artifacts
      return
    end

    begin
      @cask = CaskLoader.load_from_installed_caskfile(installed_caskfile)
      return
    rescue CaskInvalidError, CaskUnavailableError, MethodDeprecatedError
      # could be caused by trying to load outdated or deleted caskfile
    end

    recovered_cask = CaskLoader.recover_from_installed_caskfile(installed_caskfile, tab:, fallback_cask: @cask)
    if recovered_cask
      @cask = recovered_cask
      return
    end
  end

  load_cask_from_source_api! if cask_from_source_api?
  # otherwise we default to the current cask
end

#metadata_subdir ⇒ 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:



571
572
573
574
575
576
577
578
579
580
581
 
# File 'cask/installer.rb', line 571

def metadata_subdir
  @metadata_subdir ||= T.let(
    begin
      msd = @cask.metadata_subdir("Casks", timestamp: :now, create: true)
      raise "unexpected nil metadata_subdir" unless msd

      msd
    end,
    T.nilable(Pathname),
  )
end

#missing_cask_and_formula_dependencies ⇒ Array<Formula, ::Cask::Cask>

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:



450
451
452
453
454
455
456
457
458
459
 
# File 'cask/installer.rb', line 450

def missing_cask_and_formula_dependencies
  cask_and_formula_dependencies.reject do |cask_or_formula|
    case cask_or_formula
    when Formula
      cask_or_formula.any_version_installed? && cask_or_formula.optlinked?
    when Cask
      cask_or_formula.installed?
    end
  end
end

#prelude ⇒ 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.



965
966
967
968
969
970
971
972
973
974
975
 
# File 'cask/installer.rb', line 965

def prelude
  return if @ran_prelude

  check_prelude_requirements unless @ran_prelude_fetch
  load_cask_from_source_api! if cask_from_source_api?
  forbidden_tap_check
  forbidden_cask_and_formula_check
  forbidden_cask_artifacts_check

  @ran_prelude = true
end

#prelude_fetch(download_queue: @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.

Parameters:



983
984
985
986
987
 
# File 'cask/installer.rb', line 983

def prelude_fetch(download_queue: @download_queue)
  return unless (download = prelude_fetch_download)

  download_queue.enqueue(download)
end

#prelude_fetch_download ⇒ Homebrew::API::SourceDownload?

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:



990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'cask/installer.rb', line 990

def prelude_fetch_download
  return if @ran_prelude_fetch

  check_prelude_requirements
  @ran_prelude_fetch = true
  return unless source_download_requires_pre_fetch?

  if source_download.downloaded?
    source_download.verify_download_integrity(source_download.cached_download)
    source_download.downloader.create_symlink_to_cached_download(source_download.cached_download)
    return
  end

  source_download
end

#primary_container ⇒ UnpackStrategy

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
 
# File 'cask/installer.rb', line 298

def primary_container
  download(quiet: true) if @cask.download.nil?

  downloader.primary_container
end

#process_rename_operations(target_dir: 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.

This method returns an undefined value.

Parameters:

  • target_dir (Pathname, nil) (defaults to: nil) 


317
318
319
 
# File 'cask/installer.rb', line 317

def process_rename_operations(target_dir: nil)
  downloader.process_rename_operations(target_dir: target_dir || @cask.staged_path)
end

#purge_backed_up_versioned_files ⇒ 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.



793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'cask/installer.rb', line 793

def purge_backed_up_versioned_files
  # versioned staged distribution
  gain_permissions_remove(T.must(backup_path)) if backup_path&.exist?

  # Cask metadata
  bmp = backup_metadata_path
  return unless bmp&.directory?

  bmp.children.each do |subdir|
    gain_permissions_remove(subdir)
  end
  bmp.rmdir_if_possible
end

#purge_caskroom_path ⇒ 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.



831
832
833
834
835
 
# File 'cask/installer.rb', line 831

def purge_caskroom_path
  odebug "Purging all staged versions of Cask #{@cask}"
  gain_permissions_remove(@cask.caskroom_path)
  remove_broken_caskroom_symlinks
end

#purge_versioned_files ⇒ 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.



808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'cask/installer.rb', line 808

def purge_versioned_files
  ohai "Purging files for version #{@cask.version} of Cask #{@cask}"

  # versioned staged distribution
  gain_permissions_remove(@cask.staged_path) if @cask.staged_path&.exist?

  # Cask metadata
  if @cask.metadata_versioned_path.directory?
    @cask.metadata_versioned_path.children.each do |subdir|
      gain_permissions_remove(subdir)
    end

    @cask.metadata_versioned_path.rmdir_if_possible
  end
  @cask.metadata_main_container_path.rmdir_if_possible unless upgrade?

  # toplevel staged distribution
  @cask.caskroom_path.rmdir_if_possible unless upgrade?

  remove_broken_caskroom_symlinks
end

#quiet? ⇒ 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) 


94
 
# File 'cask/installer.rb', line 94

def quiet? = @quiet

#record_caveats ⇒ 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.



566
567
568
 
# File 'cask/installer.rb', line 566

def record_caveats
  self.class.record_caveats(@cask)
end

#reinstall? ⇒ 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) 


97
 
# File 'cask/installer.rb', line 97

def reinstall? = @reinstall

#remove_config_file ⇒ 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.



640
641
642
643
 
# File 'cask/installer.rb', line 640

def remove_config_file
  FileUtils.rm_f @cask.config_path
  @cask.config_path.parent.rmdir_if_possible
end

#remove_download_sha ⇒ 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.



646
647
648
649
 
# File 'cask/installer.rb', line 646

def remove_download_sha
  FileUtils.rm_f @cask.download_sha_path
  @cask.download_sha_path.parent.rmdir_if_possible
end

#remove_tabfile ⇒ 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.



633
634
635
636
637
 
# File 'cask/installer.rb', line 633

def remove_tabfile
  tabfile = @cask.tab.tabfile
  FileUtils.rm_f tabfile if tabfile
  @cask.config_path.parent.rmdir_if_possible
end

#require_sha? ⇒ 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) 


100
 
# File 'cask/installer.rb', line 100

def require_sha? = @require_sha

#restore_backup ⇒ 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.



672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
 
# File 'cask/installer.rb', line 672

def restore_backup
  bp = backup_path
  return unless bp

  bmp = backup_metadata_path
  return unless bmp

  return if !bp.directory? || !bmp.directory?

  FileUtils.rm_r(@cask.staged_path) if @cask.staged_path.exist?
  FileUtils.rm_r(@cask.metadata_versioned_path) if @cask.metadata_versioned_path.exist?

  bp.rename @cask.staged_path.to_s
  bmp.rename @cask.metadata_versioned_path.to_s
end

#revert_upgrade(predecessor:) ⇒ 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:

  • predecessor (Cask) 


689
690
691
692
693
 
# File 'cask/installer.rb', line 689

def revert_upgrade(predecessor:)
  opoo "Reverting upgrade for Cask #{@cask}"
  restore_backup
  install_artifacts(predecessor:)
end

#satisfy_cask_and_formula_dependencies ⇒ 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.



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'cask/installer.rb', line 478

def satisfy_cask_and_formula_dependencies
  return unless installed_on_request?

  formulae_and_casks = cask_and_formula_dependencies

  return if formulae_and_casks.empty?

  missing_formulae_and_casks = missing_cask_and_formula_dependencies

  if missing_formulae_and_casks.empty?
    puts "All dependencies satisfied."
    return
  end

  ohai "Installing dependencies: #{missing_formulae_and_casks.join(", ")}"
  if skip_cask_deps?
    missing_formulae_and_casks.grep(Cask).each do |dependency|
      opoo "`--skip-cask-deps` is set; skipping installation of #{dependency}."
    end
  end

  cask_installers, formula_installers = dependency_installers
  if (failed_installer = cask_installers.find(&:download_failed?))
    raise CaskError, "Dependency download failed for #{failed_installer.cask}."
  end

  cask_installers.reject { |installer| installer.cask.installed? }.each(&:install)
  return if formula_installers.blank?

  Homebrew::Install.perform_preinstall_checks_once
  valid_formula_installers = if @dependencies_enqueued
    Homebrew::Install.reject_failed_downloads(formula_installers, download_queue: @download_queue)
  else
    Homebrew::Install.fetch_formulae(formula_installers)
  end
  valid_formula_installers.each do |formula_installer|
    next if formula_installer.formula.any_version_installed? && formula_installer.formula.optlinked?

    formula_installer.install
    formula_installer.finish
  end
end

#save_caskfile ⇒ 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.



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'cask/installer.rb', line 584

def save_caskfile
  old_savedir = @cask.metadata_timestamped_path

  return if @cask.source.blank?

  if @cask.uninstall_flight_blocks?
    (metadata_subdir/"#{@cask.token}.rb").write @cask.source.to_s
  else
    installed_json = @cask.to_installed_json_hash
    installed_json["artifacts"] = [] if @cask.artifacts_list(uninstall_only: true).empty?
    (metadata_subdir/"#{@cask.token}.json").write JSON.pretty_generate(installed_json)
  end

  FileUtils.rm_r(old_savedir) if old_savedir
end

#save_config_file ⇒ 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.



601
602
603
 
# File 'cask/installer.rb', line 601

def save_config_file
  @cask.config_path.atomic_write(@cask.config.to_json)
end

#save_download_sha ⇒ 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.



606
607
608
609
610
 
# File 'cask/installer.rb', line 606

def save_download_sha
  return unless @cask.checksumable?

  @cask.download_sha_path.atomic_write(@cask.new_download_sha)
end

#skip_cask_deps? ⇒ 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) 


103
 
# File 'cask/installer.rb', line 103

def skip_cask_deps? = @skip_cask_deps

#source_download_requires_pre_fetch? ⇒ 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) 


978
979
980
 
# File 'cask/installer.rb', line 978

def source_download_requires_pre_fetch?
  cask_from_source_api? && @cask.languages.any?
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.



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'cask/installer.rb', line 148

def stage
  odebug "Cask::Installer#stage"

  Caskroom.ensure_caskroom_exists

  queued_staged_path = downloader.staged_path_from_download_queue
  queued_staged_marker = downloader.staged_path_from_download_queue_marker
  if @defer_fetch && queued_staged_marker.exist? && !@cask.staged_path.exist?
    @cask.staged_path.dirname.mkpath
    FileUtils.mv(queued_staged_path, @cask.staged_path)
    downloader.purge_staged_from_download_queue(command: @command)
  else
    downloader.purge_staged_from_download_queue(command: @command) if @defer_fetch
    extract_primary_container
    process_rename_operations
  end
  save_caskfile
rescue => e
  downloader.purge_staged_from_download_queue(command: @command) if @defer_fetch
  purge_versioned_files
  raise e
end

#start_upgrade(successor:, quit: true) ⇒ 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:

  • successor (Cask, nil)
  • quit (Boolean) (defaults to: true) 


652
653
654
655
 
# File 'cask/installer.rb', line 652

def start_upgrade(successor:, quit: true)
  uninstall_artifacts(successor:, quit:)
  backup
end

#summary ⇒ 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:



268
269
270
271
272
273
 
# File 'cask/installer.rb', line 268

def summary
  s = +""
  s << "#{Homebrew::EnvConfig.install_badge}  " unless Homebrew::EnvConfig.no_emoji?
  s << "#{@cask} was successfully #{upgrade? ? "upgraded" : "installed"}!"
  s.freeze
end

#uninstall(successor: 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.

This method returns an undefined value.

Parameters:

  • successor (Cask, nil) (defaults to: nil) 


613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'cask/installer.rb', line 613

def uninstall(successor: nil)
  load_installed_caskfile!
  oh1 "Uninstalling Cask #{Formatter.identifier(@cask)}"
  if !reinstall? && !upgrade? && @installed_uninstall_artifacts_missing && artifacts.empty?
    opoo <<~EOS
      No uninstall artifact metadata is available for Cask '#{@cask}'.
      Homebrew will remove its records, but files installed by the Cask may remain.
    EOS
  end
  uninstall_artifacts(clear: true, successor:)
  if !reinstall? && !upgrade?
    remove_tabfile
    remove_download_sha
    remove_config_file
  end
  purge_versioned_files
  purge_caskroom_path if force?
end

#uninstall_artifacts(clear: false, successor: nil, quit: true) ⇒ 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:

  • clear (Boolean) (defaults to: false)
  • successor (Cask, nil) (defaults to: nil)
  • quit (Boolean) (defaults to: true) 


705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'cask/installer.rb', line 705

def uninstall_artifacts(clear: false, successor: nil, quit: true)
  odebug "Uninstalling artifacts"
  odebug "#{::Utils.pluralize("artifact", artifacts.length, include_count: true)} defined", artifacts

  artifacts.each do |artifact|
    if artifact.respond_to?(:uninstall_phase)
      artifact = T.cast(
        artifact,
        T.any(
          Artifact::AbstractFlightBlock,
          Artifact::GeneratedCompletion,
          Artifact::KeyboardLayout,
          Artifact::Moved,
          Artifact::PostflightSteps,
          Artifact::PreflightSteps,
          Artifact::Qlplugin,
          Artifact::Symlinked,
          Artifact::Uninstall,
          Artifact::UninstallPostflightSteps,
          Artifact::UninstallPreflightSteps,
        ),
      )

      odebug "Uninstalling artifact of class #{artifact.class}"
      uninstall_options = {
        command:   @command,
        verbose:   verbose?,
        skip:      clear,
        force:     force?,
        successor:,
        upgrade:   upgrade?,
        reinstall: reinstall?,
      }
      uninstall_options[:quit] = quit if artifact.is_a?(Artifact::Uninstall)
      artifact.uninstall_phase(**uninstall_options)
    end

    next unless artifact.respond_to?(:post_uninstall_phase)

    artifact = T.cast(artifact, Artifact::Uninstall)

    odebug "Post-uninstalling artifact of class #{artifact.class}"
    artifact.post_uninstall_phase(
      command:   @command,
      verbose:   verbose?,
      skip:      clear,
      force:     force?,
      successor:,
    )
  end
end

#uninstall_existing_cask ⇒ 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.



259
260
261
262
263
264
265
 
# File 'cask/installer.rb', line 259

def uninstall_existing_cask
  return unless @cask.installed?

  # Always force uninstallation, ignore method parameter
  cask_installer = Installer.new(@cask, verbose: verbose?, force: true, upgrade: upgrade?, reinstall: true)
  zap? ? cask_installer.zap : cask_installer.uninstall(successor: @cask)
end

#upgrade? ⇒ 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) 


106
 
# File 'cask/installer.rb', line 106

def upgrade? = @upgrade

#verbose? ⇒ 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) 


109
 
# File 'cask/installer.rb', line 109

def verbose? = @verbose

#zap ⇒ 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.



758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'cask/installer.rb', line 758

def zap
  load_installed_caskfile!
  uninstall_artifacts
  if (zap_stanzas = @cask.artifacts.grep(Artifact::Zap)).empty?
    opoo "No zap stanza present for Cask '#{@cask}'"
  else
    ohai "Dispatching zap stanza"
    zap_stanzas.each do |stanza|
      stanza.zap_phase(command: @command, verbose: verbose?, force: force?)
    end
  end
  ohai "Removing all staged versions of Cask '#{@cask}'"
  purge_caskroom_path
end

#zap? ⇒ 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) 


112
 
# File 'cask/installer.rb', line 112

def zap? = @zap