Class: Cask::Installer Private

Inherits:
Object
  • Object
show all
Extended by:
Predicable
Includes:
Staged
Defined in:
brew/Library/Homebrew/cask/installer.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Installer for a Cask.

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Predicable

attr_predicate

Methods included from Staged

#set_ownership, #set_permissions

Constructor Details

#initialize(cask, command: SystemCommand, force: false, skip_cask_deps: false, binaries: true, verbose: false, require_sha: false, upgrade: false, installed_as_dependency: false, quarantine: true) ⇒ Installer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Installer.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'brew/Library/Homebrew/cask/installer.rb', line 28

def initialize(cask, command: SystemCommand, force: false,
               skip_cask_deps: false, binaries: true, verbose: false,
               require_sha: false, upgrade: false,
               installed_as_dependency: false, quarantine: true)
  @cask = cask
  @command = command
  @force = force
  @skip_cask_deps = skip_cask_deps
  @binaries = binaries
  @verbose = verbose
  @require_sha = require_sha
  @reinstall = false
  @upgrade = upgrade
  @installed_as_dependency = installed_as_dependency
  @quarantine = quarantine
end

Class Method Details

.caveats(cask) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



49
50
51
52
53
54
55
56
57
58
59
# File 'brew/Library/Homebrew/cask/installer.rb', line 49

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

  caveats = cask.caveats
  return if caveats.empty?

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

Instance Method Details

#arch_dependenciesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises:



262
263
264
265
266
267
268
269
270
271
272
273
274
275
# File 'brew/Library/Homebrew/cask/installer.rb', line 262

def arch_dependencies
  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

#backupObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



418
419
420
421
# File 'brew/Library/Homebrew/cask/installer.rb', line 418

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

#backup_metadata_pathObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



491
492
493
494
495
# File 'brew/Library/Homebrew/cask/installer.rb', line 491

def 
  return if @cask..nil?

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

#backup_pathObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



485
486
487
488
489
# File 'brew/Library/Homebrew/cask/installer.rb', line 485

def backup_path
  return if @cask.staged_path.nil?

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

#cask_and_formula_dependenciesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



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
# File 'brew/Library/Homebrew/cask/installer.rb', line 339

def cask_and_formula_dependencies
  return if installed_as_dependency?

  formulae_and_casks = collect_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 Formula dependencies satisfied."
    return
  end

  ohai "Installing dependencies: #{missing_formulae_and_casks.map(&:to_s).join(", ")}"
  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}."
        next
      end

      Installer.new(
        cask_or_formula,
        binaries:                binaries?,
        verbose:                 verbose?,
        installed_as_dependency: true,
        force:                   false,
      ).install
    else
      FormulaInstaller.new(cask_or_formula, verbose: verbose?).yield_self do |fi|
        fi.installed_as_dependency = true
        fi.installed_on_request = false
        fi.show_header = true
        fi.prelude
        fi.fetch
        fi.install
        fi.finish
      end
    end
  end
end

#caveatsObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



382
383
384
# File 'brew/Library/Homebrew/cask/installer.rb', line 382

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

#check_conflictsObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



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

def check_conflicts
  return unless @cask.conflicts_with

  @cask.conflicts_with[:cask].each do |conflicting_cask|
    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

#collect_cask_and_formula_dependenciesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'brew/Library/Homebrew/cask/installer.rb', line 308

def collect_cask_and_formula_dependencies
  return @cask_and_formula_dependencies if @cask_and_formula_dependencies

  graph = graph_dependencies(@cask)

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

  primary_container.dependencies.each do |dep|
    graph_dependencies(dep, graph)
  end

  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

#downloadObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



151
152
153
154
155
156
157
158
# File 'brew/Library/Homebrew/cask/installer.rb', line 151

def download
  return @downloaded_path if @downloaded_path

  odebug "Downloading"
  @downloaded_path = Download.new(@cask, force: false, quarantine: quarantine?).perform
  odebug "Downloaded to -> #{@downloaded_path}"
  @downloaded_path
end

#extract_primary_containerObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



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
# File 'brew/Library/Homebrew/cask/installer.rb', line 178

def extract_primary_container
  odebug "Extracting primary container"

  odebug "Using container class #{primary_container.class} for #{@downloaded_path}"

  basename = CGI.unescape(File.basename(@cask.url.path))

  if nested_container = @cask.container&.nested
    Dir.mktmpdir do |tmpdir|
      tmpdir = Pathname(tmpdir)
      primary_container.extract(to: tmpdir, basename: 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: @cask.staged_path, verbose: verbose?)
    end
  else
    primary_container.extract_nestedly(to: @cask.staged_path, basename: basename, verbose: verbose?)
  end

  return unless quarantine?
  return unless Quarantine.available?

  Quarantine.propagate(from: @downloaded_path, to: @cask.staged_path)
end

#fetchObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



61
62
63
64
65
66
67
68
69
# File 'brew/Library/Homebrew/cask/installer.rb', line 61

def fetch
  odebug "Cask::Installer#fetch"

  verify_has_sha if require_sha? && !force?
  satisfy_dependencies

  download
  verify
end

#finalize_upgradeObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



439
440
441
442
443
444
445
# File 'brew/Library/Homebrew/cask/installer.rb', line 439

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

  purge_backed_up_versioned_files

  puts summary
end

#gain_permissions_remove(path) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



497
498
499
# File 'brew/Library/Homebrew/cask/installer.rb', line 497

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

#graph_dependencies(cask_or_formula, acc = TopologicalHash.new) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'brew/Library/Homebrew/cask/installer.rb', line 282

def graph_dependencies(cask_or_formula, acc = TopologicalHash.new)
  return acc if acc.key?(cask_or_formula)

  if cask_or_formula.is_a?(Cask)
    formula_deps = cask_or_formula.depends_on.formula.map { |f| Formula[f] }
    cask_deps = cask_or_formula.depends_on.cask.map(&CaskLoader.public_method(:load))
  else
    formula_deps = cask_or_formula.deps.reject(&:build?).map(&:to_formula)
    cask_deps = cask_or_formula.requirements.map(&:cask).compact.map(&CaskLoader.public_method(:load))
  end

  acc[cask_or_formula] ||= []
  acc[cask_or_formula] += formula_deps
  acc[cask_or_formula] += cask_deps

  formula_deps.each do |f|
    graph_dependencies(f, acc)
  end

  cask_deps.each do |c|
    graph_dependencies(c, acc)
  end

  acc
end

#installObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'brew/Library/Homebrew/cask/installer.rb', line 83

def install
  odebug "Cask::Installer#install"

  old_config = @cask.config

  raise CaskAlreadyInstalledError, @cask if @cask.installed? && !force? && !reinstall? && !upgrade?

  check_conflicts

  print caveats
  fetch
  uninstall_existing_cask if reinstall?

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

  oh1 "Installing Cask #{Formatter.identifier(@cask)}"
  opoo "macOS's Gatekeeper has been disabled for this Cask" unless quarantine?
  stage

  @cask.config = Config.global.merge(old_config)

  install_artifacts

  ::Utils::Analytics.report_event("cask_install", @cask.token) unless @cask.tap&.private?

  purge_backed_up_versioned_files

  puts summary
rescue
  restore_backup
  raise
end

#install_artifactsObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'brew/Library/Homebrew/cask/installer.rb', line 205

def install_artifacts
  already_installed_artifacts = []

  odebug "Installing artifacts"
  artifacts = @cask.artifacts
  odebug "#{artifacts.length} artifact/s defined", 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.install_phase(command: @command, verbose: verbose?, force: force?)
    already_installed_artifacts.unshift(artifact)
  end

  save_config_file
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

#macos_dependenciesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises:



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

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

  raise CaskError, @cask.depends_on.macos.message(type: :cask)
end

#missing_cask_and_formula_dependenciesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



328
329
330
331
332
333
334
335
336
337
# File 'brew/Library/Homebrew/cask/installer.rb', line 328

def missing_cask_and_formula_dependencies
  collect_cask_and_formula_dependencies.reject do |cask_or_formula|
    installed = if cask_or_formula.respond_to?(:any_version_installed?)
      cask_or_formula.any_version_installed?
    else
      cask_or_formula.try(:installed?)
    end
    installed && (cask_or_formula.respond_to?(:optlinked?) ? cask_or_formula.optlinked? : true)
  end
end

#primary_containerObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



171
172
173
174
175
176
# File 'brew/Library/Homebrew/cask/installer.rb', line 171

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

#purge_backed_up_versioned_filesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



501
502
503
504
505
506
507
508
509
510
511
512
# File 'brew/Library/Homebrew/cask/installer.rb', line 501

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

  # Homebrew Cask metadata
  return unless .directory?

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

#purge_caskroom_pathObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



534
535
536
537
# File 'brew/Library/Homebrew/cask/installer.rb', line 534

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

#purge_versioned_filesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
# File 'brew/Library/Homebrew/cask/installer.rb', line 514

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..directory?
    @cask..children.each do |subdir|
      gain_permissions_remove(subdir)
    end

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

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

#reinstallObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



127
128
129
130
131
# File 'brew/Library/Homebrew/cask/installer.rb', line 127

def reinstall
  odebug "Cask::Installer#reinstall"
  @reinstall = true
  install
end

#remove_config_fileObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



408
409
410
411
# File 'brew/Library/Homebrew/cask/installer.rb', line 408

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

#restore_backupObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



423
424
425
426
427
428
429
430
431
# File 'brew/Library/Homebrew/cask/installer.rb', line 423

def restore_backup
  return unless backup_path.directory? && .directory?

  Pathname.new(@cask.staged_path).rmtree if @cask.staged_path.exist?
  Pathname.new(@cask.).rmtree if @cask..exist?

  backup_path.rename @cask.staged_path
  .rename @cask.
end

#revert_upgradeObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



433
434
435
436
437
# File 'brew/Library/Homebrew/cask/installer.rb', line 433

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

#satisfy_dependenciesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

TODO: move dependencies to a separate class, dependencies should also apply for brew cask stage, override dependencies with --force or perhaps --force-deps



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

def satisfy_dependencies
  return unless @cask.depends_on

  macos_dependencies
  arch_dependencies
  x11_dependencies
  cask_and_formula_dependencies
end

#save_caskfileObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



386
387
388
389
390
391
392
393
394
# File 'brew/Library/Homebrew/cask/installer.rb', line 386

def save_caskfile
  old_savedir = @cask.

  return unless @cask.sourcefile_path

  savedir = @cask.("Casks", timestamp: :now, create: true)
  FileUtils.copy @cask.sourcefile_path, savedir
  old_savedir&.rmtree
end

#save_config_fileObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



396
397
398
# File 'brew/Library/Homebrew/cask/installer.rb', line 396

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

#stageObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



71
72
73
74
75
76
77
78
79
80
81
# File 'brew/Library/Homebrew/cask/installer.rb', line 71

def stage
  odebug "Cask::Installer#stage"

  Caskroom.ensure_caskroom_exists

  extract_primary_container
  save_caskfile
rescue => e
  purge_versioned_files
  raise e
end

#start_upgradeObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



413
414
415
416
# File 'brew/Library/Homebrew/cask/installer.rb', line 413

def start_upgrade
  uninstall_artifacts
  backup
end

#summaryObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



144
145
146
147
148
149
# File 'brew/Library/Homebrew/cask/installer.rb', line 144

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

#uninstallObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



400
401
402
403
404
405
406
# File 'brew/Library/Homebrew/cask/installer.rb', line 400

def uninstall
  oh1 "Uninstalling Cask #{Formatter.identifier(@cask)}"
  uninstall_artifacts(clear: true)
  remove_config_file unless reinstall? || upgrade?
  purge_versioned_files
  purge_caskroom_path if force?
end

#uninstall_artifacts(clear: false) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'brew/Library/Homebrew/cask/installer.rb', line 447

def uninstall_artifacts(clear: false)
  odebug "Uninstalling artifacts"
  artifacts = @cask.artifacts

  odebug "#{artifacts.length} artifact/s defined", artifacts

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

    next unless artifact.respond_to?(:post_uninstall_phase)

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

#uninstall_existing_caskObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



133
134
135
136
137
138
139
140
141
142
# File 'brew/Library/Homebrew/cask/installer.rb', line 133

def uninstall_existing_cask
  return unless @cask.installed?

  # use the same cask file that was used for installation, if possible
  installed_caskfile = @cask.installed_caskfile
  installed_cask = installed_caskfile.exist? ? CaskLoader.load(installed_caskfile) : @cask

  # Always force uninstallation, ignore method parameter
  Installer.new(installed_cask, binaries: binaries?, verbose: verbose?, force: true, upgrade: upgrade?).uninstall
end

#verifyObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



167
168
169
# File 'brew/Library/Homebrew/cask/installer.rb', line 167

def verify
  Verify.all(@cask, @downloaded_path)
end

#verify_has_shaObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises:



160
161
162
163
164
165
# File 'brew/Library/Homebrew/cask/installer.rb', line 160

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

  raise CaskNoShasumError, @cask.token
end

#x11_dependenciesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



277
278
279
280
# File 'brew/Library/Homebrew/cask/installer.rb', line 277

def x11_dependencies
  return unless @cask.depends_on.x11
  raise CaskX11DependencyError, @cask.token unless MacOS::XQuartz.installed?
end

#zapObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



470
471
472
473
474
475
476
477
478
479
480
481
482
483
# File 'brew/Library/Homebrew/cask/installer.rb', line 470

def zap
  ohai %Q(Implied "brew cask uninstall #{@cask}")
  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