Class: Cask::Installer Private

Inherits:
Object show all
Includes:
OS::Linux::Cask::Installer
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.

Constant Summary

Constants included from OS::Linux::Cask::Installer

OS::Linux::Cask::Installer::LINUX_INVALID_ARTIFACTS

Class Method Summary collapse

Instance Method Summary collapse

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_as_dependency: false, installed_on_request: true, quarantine: true, verify_download_integrity: true, quiet: false, download_queue: 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[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_as_dependency (Boolean) (defaults to: false)
  • installed_on_request (Boolean) (defaults to: true)
  • quarantine (Boolean) (defaults to: true)
  • verify_download_integrity (Boolean) (defaults to: true)
  • quiet (Boolean) (defaults to: false)
  • download_queue (Homebrew::DownloadQueue, nil) (defaults to: nil) 


27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'cask/installer.rb', line 27

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_as_dependency: false, installed_on_request: true,
               quarantine: true, verify_download_integrity: true, quiet: false, download_queue: 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_as_dependency = installed_as_dependency
  @installed_on_request = installed_on_request
  @quarantine = quarantine
  @verify_download_integrity = verify_download_integrity
  @quiet = quiet
  @download_queue = download_queue
end

Class Method Details

.caveats(cask) ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'cask/installer.rb', line 90

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

  caveats = cask.caveats
  return if caveats.empty?

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

  <<~EOS
    #{ohai_title "Caveats"}
    #{caveats}
  EOS
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) 


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

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:



263
264
265
 
# File 'cask/installer.rb', line 263

def artifacts
  @cask.artifacts
end

#backup ⇒ Object

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



538
539
540
541
 
# File 'cask/installer.rb', line 538

def backup
  @cask.staged_path.rename backup_path
  @cask.metadata_versioned_path.rename backup_metadata_path
end

#backup_metadata_path ⇒ Object

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



635
636
637
638
639
 
# File 'cask/installer.rb', line 635

def backup_metadata_path
  return if @cask.metadata_versioned_path.nil?

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

#backup_path ⇒ Object

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



629
630
631
632
633
 
# File 'cask/installer.rb', line 629

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) 


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

def binaries? = @binaries

#cask_and_formula_dependencies ⇒ Array<T.untyped>

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

Returns:

Raises:



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'cask/installer.rb', line 386

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)

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

  begin
    @cask_and_formula_dependencies = graph.tsort - [@cask]
  rescue TSort::Cyclic
    strongly_connected_components = graph.strongly_connected_components.sort_by(&:count)
    cyclic_dependencies = strongly_connected_components.last - [@cask]
    raise CaskCyclicDependencyError.new(@cask.token, cyclic_dependencies.to_sentence)
  end
end

#caveats ⇒ Object

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



476
477
478
 
# File 'cask/installer.rb', line 476

def caveats
  self.class.caveats(@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:



370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'cask/installer.rb', line 370

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

  @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 #{@cask} depends on hardware architecture being one of " \
        "[#{@cask.depends_on.arch.map(&:to_s).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.



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'cask/installer.rb', line 199

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

    conflicting_cask = CaskLoader.load(conflicting_cask)
    raise CaskConflictError.new(@cask, conflicting_cask) if conflicting_cask.installed?
  rescue CaskUnavailableError
    next # Ignore conflicting Casks that do not exist.
  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.



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'cask/installer.rb', line 182

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

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

Raises:



362
363
364
365
366
367
 
# File 'cask/installer.rb', line 362

def check_macos_requirements
  return unless @cask.depends_on.macos
  return if @cask.depends_on.macos.satisfied?

  raise CaskError, @cask.depends_on.macos.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.



351
352
353
354
355
 
# File 'cask/installer.rb', line 351

def check_requirements
  check_stanza_os_requirements
  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.



358
359
360
 
# File 'cask/installer.rb', line 358

def check_stanza_os_requirements
  nil
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:



238
239
240
241
242
 
# File 'cask/installer.rb', line 238

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

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



233
234
235
 
# File 'cask/installer.rb', line 233

def downloader
  @downloader ||= Download.new(@cask, quarantine: quarantine?)
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.



795
796
797
798
799
800
801
802
 
# File 'cask/installer.rb', line 795

def enqueue_downloads
  download_queue = @download_queue
  return if download_queue.nil?

  Homebrew::API::Cask.source_download(@cask, download_queue:) if cask_from_source_api?

  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) 


268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'cask/installer.rb', line 268

def extract_primary_container(to: @cask.staged_path)
  odebug "Extracting primary container"

  odebug "Using container class #{primary_container.class} for #{primary_container.path}"

  basename = downloader.basename

  if (nested_container = @cask.container&.nested)
    Dir.mktmpdir("cask-installer", HOMEBREW_TEMP) do |tmpdir|
      tmpdir = Pathname(tmpdir)
      primary_container.extract(to: tmpdir, basename:, verbose: verbose?)

      FileUtils.chmod_R "+rw", tmpdir/nested_container, force: true, verbose: verbose?

      UnpackStrategy.detect(tmpdir/nested_container, merge_xattrs: true)
                    .extract_nestedly(to:, verbose: verbose?)
    end
  else
    primary_container.extract_nestedly(to:, basename:, verbose: verbose?)
  end

  return unless quarantine?
  return unless Quarantine.available?

  Quarantine.propagate(from: primary_container.path, to:)
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) 


105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'cask/installer.rb', line 105

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

  load_cask_from_source_api! if cask_from_source_api?
  verify_has_sha if require_sha? && !force?
  check_requirements

  forbidden_tap_check
  forbidden_cask_and_formula_check

  download(quiet:, timeout:) if @download_queue.nil?

  satisfy_cask_and_formula_dependencies
end

#finalize_upgrade ⇒ Object

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



560
561
562
563
564
565
566
 
# File 'cask/installer.rb', line 560

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.

Raises:



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
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
 
# File 'cask/installer.rb', line 729

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

  unless 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 forbid_casks
          env_variable = "HOMEBREW_FORBID_CASKS"
          dep_cask.token
        elsif forbidden_casks.include?(dep_cask.full_name)
          dep_cask.token
        elsif dep_cask.tap.present? &&
              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
  return if !forbid_casks && forbidden_casks.blank?

  variable = "HOMEBREW_FORBIDDEN_CASKS"
  if forbid_casks
    variable = "HOMEBREW_FORBID_CASKS"
    @cask.token
  elsif forbidden_casks.include?(@cask.token)
    @cask.token
  elsif forbidden_casks.include?(@cask.full_name)
    @cask.full_name
  else
    return
  end

  raise CaskCannotBeInstalledError.new(@cask, <<~EOS
    forbidden for installation by #{owner} in `#{variable}`.#{owner_contact}
  EOS
  )
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.

Raises:



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'cask/installer.rb', line 690

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

  unless 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

  cask_tap = @cask.tap
  return if cask_tap.blank? || (cask_tap.allowed_by_env? && !cask_tap.forbidden_by_env?)

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

  raise CaskCannotBeInstalledError.new(@cask, error_message)
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) 


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

def force? = @force

#gain_permissions_remove(path) ⇒ Object

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



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

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.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'cask/installer.rb', line 134

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

  Migrator.migrate_if_needed(@cask)

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

  check_deprecate_disable
  check_conflicts

  print 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)}"
  # GitHub Actions globally disables Gatekeeper.
  opoo_outside_github_actions "macOS's Gatekeeper has been disabled for this Cask" unless quarantine?
  stage

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

  install_artifacts(predecessor:)

  tab = Tab.create(@cask)
  tab.installed_as_dependency = installed_as_dependency?
  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) 


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
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
 
# File 'cask/installer.rb', line 296

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::Installer,
        Artifact::KeyboardLayout,
        Artifact::Mdimporter,
        Artifact::Moved,
        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_as_dependency? ⇒ 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) 


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

def installed_as_dependency? = @installed_as_dependency

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


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

def installed_on_request? = @installed_on_request

#metadata_subdir ⇒ Object

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



480
481
482
 
# File 'cask/installer.rb', line 480

def metadata_subdir
  @metadata_subdir ||= @cask.metadata_subdir("Casks", timestamp: :now, create: true)
end

#missing_cask_and_formula_dependencies ⇒ Object

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



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

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

#primary_container ⇒ Object

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



255
256
257
258
259
260
 
# File 'cask/installer.rb', line 255

def primary_container
  @primary_container ||= begin
    downloaded_path = download(quiet: true)
    UnpackStrategy.detect(downloaded_path, type: @cask.container&.type, merge_xattrs: true)
  end
end

#purge_backed_up_versioned_files ⇒ Object

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



645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'cask/installer.rb', line 645

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

  # Homebrew Cask metadata
  return unless backup_metadata_path.directory?

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

#purge_caskroom_path ⇒ Object

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



684
685
686
687
 
# File 'cask/installer.rb', line 684

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

#purge_versioned_files ⇒ Object

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



658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'cask/installer.rb', line 658

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?

  # Homebrew 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 symlinks for renamed casks if they are now broken.
  @cask.old_tokens.each do |old_token|
    old_caskroom_path = Caskroom.path/old_token
    FileUtils.rm old_caskroom_path if old_caskroom_path.symlink? && !old_caskroom_path.exist?
  end
end

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


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

def quarantine? = @quarantine

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


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

def quiet? = @quiet

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


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

def reinstall? = @reinstall

#remove_config_file ⇒ Object

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



522
523
524
525
 
# File 'cask/installer.rb', line 522

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

#remove_download_sha ⇒ Object

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



527
528
529
530
 
# File 'cask/installer.rb', line 527

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

#remove_tabfile ⇒ Object

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



516
517
518
519
520
 
# File 'cask/installer.rb', line 516

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) 


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

def require_sha? = @require_sha

#restore_backup ⇒ Object

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



543
544
545
546
547
548
549
550
551
 
# File 'cask/installer.rb', line 543

def restore_backup
  return if !backup_path.directory? || !backup_metadata_path.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?

  backup_path.rename @cask.staged_path
  backup_metadata_path.rename @cask.metadata_versioned_path
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) 


554
555
556
557
558
 
# File 'cask/installer.rb', line 554

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

#satisfy_cask_and_formula_dependencies ⇒ Object

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



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'cask/installer.rb', line 415

def satisfy_cask_and_formula_dependencies
  return if installed_as_dependency?

  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.map(&:to_s).join(", ")}"
  cask_installers = T.let([], T::Array[Installer])
  formula_installers = T.let([], T::Array[FormulaInstaller])

  missing_formulae_and_casks.each do |cask_or_formula|
    if cask_or_formula.is_a?(Cask)
      if skip_cask_deps?
        opoo "`--skip-cask-deps` is set; skipping installation of #{cask_or_formula}."
        next
      end

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

  cask_installers.each(&:install)
  return if formula_installers.blank?

  Homebrew::Install.perform_preinstall_checks_once
  valid_formula_installers = Homebrew::Install.fetch_formulae(formula_installers)
  valid_formula_installers.each do |formula_installer|
    formula_installer.install
    formula_installer.finish
  end
end

#save_caskfile ⇒ Object

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



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

def save_caskfile
  old_savedir = @cask.metadata_timestamped_path

  return if @cask.source.blank?

  extension = @cask.loaded_from_api? ? "json" : "rb"
  (metadata_subdir/"#{@cask.token}.#{extension}").write @cask.source
  FileUtils.rm_r(old_savedir) if old_savedir
end

#save_config_file ⇒ Object

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



494
495
496
 
# File 'cask/installer.rb', line 494

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

#save_download_sha ⇒ Object

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



498
499
500
 
# File 'cask/installer.rb', line 498

def save_download_sha
  @cask.download_sha_path.atomic_write(@cask.new_download_sha) if @cask.checksumable?
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) 


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

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.



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

def stage
  odebug "Cask::Installer#stage"

  Caskroom.ensure_caskroom_exists

  extract_primary_container
  save_caskfile
rescue => e
  purge_versioned_files
  raise e
end

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


533
534
535
536
 
# File 'cask/installer.rb', line 533

def start_upgrade(successor:)
  uninstall_artifacts(successor:)
  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:



225
226
227
228
229
230
 
# File 'cask/installer.rb', line 225

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) 


503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'cask/installer.rb', line 503

def uninstall(successor: nil)
  load_installed_caskfile!
  oh1 "Uninstalling Cask #{Formatter.identifier(@cask)}"
  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) ⇒ 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) 


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'cask/installer.rb', line 569

def uninstall_artifacts(clear: false, successor: nil)
  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::KeyboardLayout,
          Artifact::Moved,
          Artifact::Qlplugin,
          Artifact::Symlinked,
          Artifact::Uninstall,
        ),
      )

      odebug "Uninstalling artifact of class #{artifact.class}"
      artifact.uninstall_phase(
        command:   @command,
        verbose:   verbose?,
        skip:      clear,
        force:     force?,
        successor:,
        upgrade:   upgrade?,
        reinstall: reinstall?,
      )
    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.



216
217
218
219
220
221
222
 
# File 'cask/installer.rb', line 216

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) 


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

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) 


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

def verbose? = @verbose

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

Raises:



245
246
247
248
249
250
251
252
253
 
# File 'cask/installer.rb', line 245

def verify_has_sha
  odebug "Checking cask has checksum"
  return if @cask.sha256 != :no_check

  raise CaskError, <<~EOS
    Cask '#{@cask}' does not have a sha256 checksum defined and was not installed.
    This means you have the #{Formatter.identifier("--require-sha")} option set, perhaps in your `$HOMEBREW_CASK_OPTS`.
  EOS
end

#zap ⇒ Object

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



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

def zap
  load_installed_caskfile!
  uninstall_artifacts
  if (zap_stanzas = @cask.artifacts.select { |a| a.is_a?(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) 


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

def zap? = @zap