Class: Cask::Installer Private

Inherits:
Object show all
Extended by:
Utils::Output::Mixin
Includes:
OS::Linux::Cask::Installer, OS::Mac::Cask::Installer, Utils::Output::Mixin, Utils::Path
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_once, 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 Utils::Path

formula_installed_prefixes, formula_opt_bin_env, formula_opt_bin_path, install_info, loadable_package_path?, uninstall_info

Methods included from Utils::Path::Helpers

#child_of?, #cp_path_sub, #ensure_child_of!, #ensure_writable, #resolved_path, #resolved_path_exists?, #rmdir_if_possible, #text_executable?

Methods included from Utils::Path::FormulaHelpers

#formula_any_version_installed?, #formula_opt_bin, #formula_opt_include, #formula_opt_lib, #formula_opt_libexec, #formula_opt_prefix

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::DownloadQueue.default, 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::DownloadQueue.default)
  • defer_fetch (Boolean) (defaults to: false)
  • default_uninstall_artifacts (ArtifactSet, nil) (defaults to: nil) 


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

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::DownloadQueue.default, 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
  # 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 = 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:



30
31
32
 
# File 'cask/installer.rb', line 30

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:



120
121
122
123
124
125
126
127
128
129
130
 
# File 'cask/installer.rb', line 120

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:



133
134
135
136
137
138
139
 
# File 'cask/installer.rb', line 133

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) 


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

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:



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

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.



680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'cask/installer.rb', line 680

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:



800
801
802
803
804
 
# File 'cask/installer.rb', line 800

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:



793
794
795
796
797
 
# File 'cask/installer.rb', line 793

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) 


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

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:



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'cask/installer.rb', line 450

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, ::Utils::Text.to_sentence(cyclic_dependencies))
  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:



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

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.



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'cask/installer.rb', line 248

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.



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'cask/installer.rb', line 231

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:



425
426
427
428
429
430
 
# File 'cask/installer.rb', line 425

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.



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

def check_requirements
  if (artifact = @cask.artifacts.find(&:requires_sudo?)) && !SystemCommand.sudo_available?
    raise CaskError,
          "#{@cask}: The #{artifact.class.dsl_key} artifact requires sudo, but HOMEBREW_NO_SUDO is set."
  end

  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:



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

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:



414
415
416
417
418
419
420
421
422
 
# File 'cask/installer.rb', line 414

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_cask_installers ⇒ Array<Installer>

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:



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

def dependency_cask_installers = @dependency_cask_installers || []

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



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'cask/installer.rb', line 543

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:



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

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.



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

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) 


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

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:



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'cask/installer.rb', line 289

def downloader
  @downloader ||= T.let(
    (if @cask.loaded_from_internal_api?
       Homebrew::API::CaskDownload.download(
         token:       @cask.token,
         cask_struct: Homebrew::API::Internal.cask_struct(@cask.token),
         languages:   @cask.config.languages,
         require_sha: require_sha?,
       )
    end) || Download.new(@cask, require_sha: require_sha?),
    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.



481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'cask/installer.rb', line 481

def enqueue_dependency_downloads
  return if download_failed? || !installed_on_request?

  cask_installers, formula_installers = dependency_installers(defer_fetch: true)
  if cask_installers.any?
    Homebrew::Install.enqueue_cask_installers(cask_installers)
  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.



1000
1001
1002
1003
 
# File 'cask/installer.rb', line 1000

def enqueue_downloads
  prelude
  @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) 


323
324
325
326
327
 
# File 'cask/installer.rb', line 323

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) 


142
143
144
145
146
147
148
149
150
 
# File 'cask/installer.rb', line 142

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.



718
719
720
721
722
723
724
 
# File 'cask/installer.rb', line 718

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



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
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
 
# File 'cask/installer.rb', line 906

def forbidden_cask_and_formula_check
  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 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.



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'cask/installer.rb', line 963

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|
    artifact_type = artifact.class.name.to_s.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 ⇒ 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.



865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'cask/installer.rb', line 865

def forbidden_tap_check
  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 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) 


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

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:



807
808
809
 
# File 'cask/installer.rb', line 807

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.



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
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'cask/installer.rb', line 177

def install
  completed = false
  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)
  completed = true
rescue => e
  begin
    restore_backup
  ensure
    purge_staged_download
  end
  raise e
ensure
  @cask.cleanup_temp(retain: !completed)
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) 


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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'cask/installer.rb', line 335

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::GeneratedScript,
        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) 


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

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



1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
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
 
# File 'cask/installer.rb', line 1007

def load_installed_caskfile!
  previous_cask = @cask
  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)

  return unless 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)
  # otherwise we default to the current cask
  @cask = recovered_cask if recovered_cask
ensure
  if previous_cask
    @cask.temp = previous_cask.temp
    previous_cask.temp = nil if !reinstall? && !upgrade? && !@cask.equal?(previous_cask)
  end
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:



589
590
591
592
593
594
595
596
597
598
599
 
# File 'cask/installer.rb', line 589

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:



469
470
471
472
473
474
475
476
477
478
 
# File 'cask/installer.rb', line 469

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.



986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'cask/installer.rb', line 986

def prelude
  return if @ran_prelude

  check_deprecate_disable
  check_conflicts
  check_requirements
  forbidden_tap_check
  forbidden_cask_and_formula_check
  forbidden_cask_artifacts_check

  @ran_prelude = true
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:



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

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) 


330
331
332
 
# File 'cask/installer.rb', line 330

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.



812
813
814
815
816
817
818
819
820
821
822
823
824
825
 
# File 'cask/installer.rb', line 812

def purge_backed_up_versioned_files
  # versioned staged distribution
  backup = backup_path
  gain_permissions_remove(backup) if backup&.exist?

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

  bmp.children.each do |subdir|
    gain_permissions_remove(subdir)
  end
  rmdir_if_possible(bmp)
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.



858
859
860
861
862
 
# File 'cask/installer.rb', line 858

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

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



828
829
830
831
832
 
# File 'cask/installer.rb', line 828

def purge_staged_download
  downloader.purge_staged_from_download_queue(command: @command) if @defer_fetch
rescue => e
  opoo "Removing the pre-staged download of #{@cask.token} also failed: #{e.message}"
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.



835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
 
# File 'cask/installer.rb', line 835

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

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

  # toplevel staged distribution
  rmdir_if_possible(@cask.caskroom_path) 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) 


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

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.



584
585
586
 
# File 'cask/installer.rb', line 584

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) 


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

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.



662
663
664
665
 
# File 'cask/installer.rb', line 662

def remove_config_file
  FileUtils.rm_f @cask.config_path
  rmdir_if_possible(@cask.config_path.parent)
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.



668
669
670
671
 
# File 'cask/installer.rb', line 668

def remove_download_sha
  FileUtils.rm_f @cask.download_sha_path
  rmdir_if_possible(@cask.download_sha_path.parent)
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.



655
656
657
658
659
 
# File 'cask/installer.rb', line 655

def remove_tabfile
  tabfile = @cask.tab.tabfile
  FileUtils.rm_f tabfile if tabfile
  rmdir_if_possible(@cask.config_path.parent)
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) 


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

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.



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'cask/installer.rb', line 694

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) 


711
712
713
714
715
 
# File 'cask/installer.rb', line 711

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.



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'cask/installer.rb', line 496

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.



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'cask/installer.rb', line 602

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.



619
620
621
 
# File 'cask/installer.rb', line 619

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.



624
625
626
627
628
 
# File 'cask/installer.rb', line 624

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) 


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

def skip_cask_deps? = @skip_cask_deps

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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'cask/installer.rb', line 153

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) 


674
675
676
677
 
# File 'cask/installer.rb', line 674

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:



281
282
283
284
285
286
 
# File 'cask/installer.rb', line 281

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) 


631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'cask/installer.rb', line 631

def uninstall(successor: nil)
  completed = false
  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?
  completed = true
ensure
  @cask.cleanup_temp(retain: !completed) if !reinstall? && !upgrade?
end

#uninstall_artifacts(clear: false, successor: nil, quit: true, zap_stanzas: []) ⇒ 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)
  • zap_stanzas (Array<Artifact::Zap>) (defaults to: []) 


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
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'cask/installer.rb', line 730

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

  directive_artifacts = [*artifacts.grep(Artifact::Uninstall), *zap_stanzas]

  preflight, removable = T.cast(
    artifacts.grep_v(Artifact::AbstractUninstall).select { |artifact| artifact.respond_to?(:uninstall_phase) },
    T::Array[
      T.any(
        Artifact::AbstractFlightBlock,
        Artifact::GeneratedCompletion,
        Artifact::KeyboardLayout,
        Artifact::Moved,
        Artifact::PostflightSteps,
        Artifact::PreflightSteps,
        Artifact::Qlplugin,
        Artifact::Symlinked,
        Artifact::UninstallPostflightSteps,
        Artifact::UninstallPreflightSteps,
      ),
    ],
  ).partition do |artifact|
    order = artifact.sort_order
    uninstall_order = order.fetch(Artifact::Uninstall)
    order.fetch(artifact.class, uninstall_order) < uninstall_order
  end

  preflight.each do |artifact|
    odebug "Uninstalling artifact of class #{artifact.class}"
    artifact.uninstall_phase(command: @command, verbose: verbose?, skip: clear, force: force?, successor:,
                             upgrade: upgrade?, reinstall: reinstall?)
  end

  Artifact::AbstractUninstall.dispatch_directives(directive_artifacts, command: @command, force: force?,
                                                  successor:, upgrade: upgrade?, reinstall: reinstall?, quit:)

  removable.each do |artifact|
    odebug "Uninstalling artifact of class #{artifact.class}"
    artifact.uninstall_phase(command: @command, verbose: verbose?, skip: clear, force: force?, successor:,
                             upgrade: upgrade?, reinstall: reinstall?)
  end

  Artifact::AbstractUninstall.dispatch_directives(directive_artifacts, command: @command, deferred: true,
                                                                       force: force?, successor:)
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.



272
273
274
275
276
277
278
 
# File 'cask/installer.rb', line 272

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) 


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

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) 


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

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.



778
779
780
781
782
783
784
785
786
787
788
789
790
 
# File 'cask/installer.rb', line 778

def zap
  completed = false
  load_installed_caskfile!
  oh1 "Zapping Cask #{Formatter.identifier(@cask)}"
  zap_stanzas = @cask.artifacts.grep(Artifact::Zap)
  opoo "No zap stanza present for Cask '#{@cask}'" if zap_stanzas.empty?
  uninstall_artifacts(clear: true, zap_stanzas:)
  ohai "Removing all staged versions of Cask '#{@cask}'"
  purge_caskroom_path
  completed = true
ensure
  @cask.cleanup_temp(retain: !completed) if !reinstall? && !upgrade?
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) 


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

def zap? = @zap