Class: FormulaInstaller

Inherits:
Object
  • Object
show all
Extended by:
Predicable
Includes:
FormulaCellarChecks
Defined in:
brew/Library/Homebrew/formula_installer.rb

Constant Summary

Constants included from FormulaCellarChecks

FormulaCellarChecks::VALID_LIBRARY_EXTENSIONS

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Predicable

attr_predicate

Methods included from FormulaCellarChecks

#check_easy_install_pth, #check_elisp_dirname, #check_elisp_root, #check_env_path, #check_generic_executables, #check_infopages, #check_jars, #check_linkage, #check_manpages, #check_non_executables, #check_non_libraries, #check_openssl_links, #check_plist, #check_python_framework_links, #check_python_packages, #check_shadowed_headers, #check_shim_references, #generic_audit_installed, #generic_valid_library_extension?, #valid_library_extension?

Constructor Details

#initialize(formula) ⇒ FormulaInstaller

Returns a new instance of FormulaInstaller.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'brew/Library/Homebrew/formula_installer.rb', line 48

def initialize(formula)
  @formula = formula
  @link_keg = !formula.keg_only?
  @show_header = false
  @ignore_deps = false
  @only_deps = false
  @build_from_source = Homebrew.args.build_from_source?
  @build_bottle = false
  @force_bottle = Homebrew.args.force_bottle?
  @include_test = Homebrew.args.include_test?
  @interactive = false
  @git = false
  @verbose = Homebrew.args.verbose?
  @quiet = Homebrew.args.quiet?
  @debug = Homebrew.args.debug?
  @installed_as_dependency = false
  @installed_on_request = true
  @options = Options.new
  @requirement_messages = []
  @poured_bottle = false
  @pour_failed = false
  @start_time = nil
end

Instance Attribute Details

#build_bottleObject

Returns the value of attribute build_bottle.



41
42
43
# File 'brew/Library/Homebrew/formula_installer.rb', line 41

def build_bottle
  @build_bottle
end

#formulaObject (readonly)

Returns the value of attribute formula.



40
41
42
# File 'brew/Library/Homebrew/formula_installer.rb', line 40

def formula
  @formula
end

#installed_as_dependencyObject

Returns the value of attribute installed_as_dependency.



41
42
43
# File 'brew/Library/Homebrew/formula_installer.rb', line 41

def installed_as_dependency
  @installed_as_dependency
end

#installed_on_requestObject

Returns the value of attribute installed_on_request.



41
42
43
# File 'brew/Library/Homebrew/formula_installer.rb', line 41

def installed_on_request
  @installed_on_request
end

Returns the value of attribute link_keg.



41
42
43
# File 'brew/Library/Homebrew/formula_installer.rb', line 41

def link_keg
  @link_keg
end

#optionsObject

Returns the value of attribute options.



41
42
43
# File 'brew/Library/Homebrew/formula_installer.rb', line 41

def options
  @options
end

Class Method Details

.attemptedObject



72
73
74
# File 'brew/Library/Homebrew/formula_installer.rb', line 72

def self.attempted
  @attempted ||= Set.new
end

.clear_attemptedObject



76
77
78
# File 'brew/Library/Homebrew/formula_installer.rb', line 76

def self.clear_attempted
  @attempted = Set.new
end

.clear_installedObject



84
85
86
# File 'brew/Library/Homebrew/formula_installer.rb', line 84

def self.clear_installed
  @installed = Set.new
end

.installedObject



80
81
82
# File 'brew/Library/Homebrew/formula_installer.rb', line 80

def self.installed
  @installed ||= Set.new
end

.lockedObject



1072
1073
1074
# File 'brew/Library/Homebrew/formula_installer.rb', line 1072

def self.locked
  @locked ||= []
end

.mode_attr_accessor(*names) ⇒ Object



27
28
29
30
31
32
33
34
35
36
37
38
# File 'brew/Library/Homebrew/formula_installer.rb', line 27

def self.mode_attr_accessor(*names)
  attr_accessor(*names)

  private(*names)
  names.each do |name|
    predicate = "#{name}?"
    define_method(predicate) do
      send(name) ? true : false
    end
    private(predicate)
  end
end

.prevent_build_flagsObject

When no build tools are available and build flags are passed through ARGV, it’s necessary to interrupt the user before any sort of installation can proceed. Only invoked when the user has no developer tools.

Raises:



91
92
93
94
95
96
97
# File 'brew/Library/Homebrew/formula_installer.rb', line 91

def self.prevent_build_flags
  build_flags = Homebrew.args.collect_build_args
  return if build_flags.empty?

  all_bottled = Homebrew.args.formulae.all?(&:bottled?)
  raise BuildFlagsError.new(build_flags, bottled: all_bottled)
end

Instance Method Details

#audit_installedObject



1064
1065
1066
1067
1068
1069
1070
# File 'brew/Library/Homebrew/formula_installer.rb', line 1064

def audit_installed
  unless formula.keg_only?
    problem_if_output(check_env_path(formula.bin))
    problem_if_output(check_env_path(formula.sbin))
  end
  super
end

#buildObject



770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
# File 'brew/Library/Homebrew/formula_installer.rb', line 770

def build
  FileUtils.rm_rf(formula.logs)

  @start_time = Time.now

  # 1. formulae can modify ENV, so we must ensure that each
  #    installation has a pristine ENV when it starts, forking now is
  #    the easiest way to do this
  args = %W[
    nice #{RUBY_PATH}
    -W0
    -I #{$LOAD_PATH.join(File::PATH_SEPARATOR)}
    --
    #{HOMEBREW_LIBRARY_PATH}/build.rb
    #{formula.specified_path}
  ].concat(build_argv)

  Utils.safe_fork do
    if Sandbox.available?
      sandbox = Sandbox.new
      formula.logs.mkpath
      sandbox.record_log(formula.logs/"build.sandbox.log")
      sandbox.allow_write_path(ENV["HOME"]) if Homebrew.args.interactive?
      sandbox.allow_write_temp_and_cache
      sandbox.allow_write_log(formula)
      sandbox.allow_cvs
      sandbox.allow_fossil
      sandbox.allow_write_xcode
      sandbox.allow_write_cellar(formula)
      sandbox.exec(*args)
    else
      exec(*args)
    end
  end

  formula.update_head_version

  raise "Empty installation" if !formula.prefix.directory? || Keg.new(formula.prefix).empty_installation?
rescue Exception => e # rubocop:disable Lint/RescueException
  if e.is_a? BuildError
    e.formula = formula
    e.options = display_options(formula)
  end

  ignore_interrupts do
    # any exceptions must leave us with nothing installed
    formula.update_head_version
    formula.prefix.rmtree if formula.prefix.directory?
    formula.rack.rmdir_if_possible
  end
  raise e
end

#build_argvObject



766
767
768
# File 'brew/Library/Homebrew/formula_installer.rb', line 766

def build_argv
  sanitized_argv_options + options.as_flags
end

#build_bottle?Boolean

Returns:

  • (Boolean)


99
100
101
102
103
# File 'brew/Library/Homebrew/formula_installer.rb', line 99

def build_bottle?
  return false unless @build_bottle

  !formula.bottle_disabled?
end

#build_bottle_postinstallObject



225
226
227
228
229
230
# File 'brew/Library/Homebrew/formula_installer.rb', line 225

def build_bottle_postinstall
  @etc_var_postinstall = Find.find(*@etc_var_dirs.select(&:directory?)).to_a
  (@etc_var_postinstall - @etc_var_preinstall).each do |file|
    Pathname.new(file).cp_path_sub(HOMEBREW_PREFIX, formula.bottle_prefix)
  end
end

#build_bottle_preinstallObject



220
221
222
223
# File 'brew/Library/Homebrew/formula_installer.rb', line 220

def build_bottle_preinstall
  @etc_var_dirs ||= [HOMEBREW_PREFIX/"etc", HOMEBREW_PREFIX/"var"]
  @etc_var_preinstall = Find.find(*@etc_var_dirs.select(&:directory?)).to_a
end

#build_timeObject



725
726
727
# File 'brew/Library/Homebrew/formula_installer.rb', line 725

def build_time
  @build_time ||= Time.now - @start_time if @start_time && !interactive?
end

#caveatsObject



651
652
653
654
655
656
657
658
659
660
661
662
663
# File 'brew/Library/Homebrew/formula_installer.rb', line 651

def caveats
  return if only_deps?

  audit_installed if Homebrew::EnvConfig.developer?

  caveats = Caveats.new(formula)

  return if caveats.empty?

  @show_summary_heading = true
  ohai "Caveats", caveats.to_s
  Homebrew.messages.record_caveats(formula, caveats)
end

#check_conflictsObject



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
# File 'brew/Library/Homebrew/formula_installer.rb', line 369

def check_conflicts
  return if Homebrew.args.force?

  conflicts = formula.conflicts.select do |c|
    f = Formulary.factory(c.name)
  rescue TapFormulaUnavailableError
    # If the formula name is a fully-qualified name let's silently
    # ignore it as we don't care about things used in taps that aren't
    # currently tapped.
    false
  rescue FormulaUnavailableError => e
    # If the formula name doesn't exist any more then complain but don't
    # stop installation from continuing.
    opoo <<~EOS
      #{formula}: #{e.message}
      'conflicts_with \"#{c.name}\"' should be removed from #{formula.path.basename}.
    EOS

    raise if Homebrew::EnvConfig.developer?

    $stderr.puts "Please report this issue to the #{formula.tap} tap (not Homebrew/brew or Homebrew/core)!"
    false
  else # rubocop:disable Layout/ElseAlignment
    f.linked_keg.exist? && f.opt_prefix.exist?
  end

  raise FormulaConflictError.new(formula, conflicts) unless conflicts.empty?
end

#check_dependencies_bottled(deps) ⇒ Object

Check that each dependency in deps has a bottle available, terminating abnormally with a BuildToolsError if one or more don’t. Only invoked when the user has no developer tools.

Raises:



409
410
411
412
413
414
415
416
# File 'brew/Library/Homebrew/formula_installer.rb', line 409

def check_dependencies_bottled(deps)
  unbottled = deps.reject do |dep, _|
    dep_f = dep.to_formula
    dep_f.pour_bottle? || dep_f.bottle_unneeded?
  end

  raise BuildToolsError, unbottled unless unbottled.empty?
end

#check_install_sanityObject



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

def check_install_sanity
  raise FormulaInstallationAlreadyAttemptedError, formula if self.class.attempted.include?(formula)

  if formula.deprecated?
    opoo "#{formula.full_name} has been deprecated!"
  elsif formula.disabled?
    odie "#{formula.full_name} has been disabled!"
  end

  return if ignore_deps?

  recursive_deps = formula.recursive_dependencies
  recursive_formulae = recursive_deps.map(&:to_formula)

  recursive_dependencies = []
  recursive_formulae.each do |dep|
    dep_recursive_dependencies = dep.recursive_dependencies.map(&:to_s)
    if dep_recursive_dependencies.include?(formula.name)
      recursive_dependencies << "#{formula.full_name} depends on #{dep.full_name}"
      recursive_dependencies << "#{dep.full_name} depends on #{formula.full_name}"
    end
  end

  unless recursive_dependencies.empty?
    raise CannotInstallFormulaError, <<~EOS
      #{formula.full_name} contains a recursive dependency on itself:
        #{recursive_dependencies.join("\n  ")}
    EOS
  end

  if recursive_formulae.flat_map(&:recursive_dependencies)
                       .map(&:to_s)
                       .include?(formula.name)
    raise CannotInstallFormulaError, <<~EOS
      #{formula.full_name} contains a recursive dependency on itself!
    EOS
  end

  pinned_unsatisfied_deps = recursive_deps.select do |dep|
    dep.to_formula.pinned? && !dep.satisfied?(inherited_options_for(dep))
  end

  return if pinned_unsatisfied_deps.empty?

  raise CannotInstallFormulaError,
        "You must `brew unpin #{pinned_unsatisfied_deps * " "}` as installing " \
        "#{formula.full_name} requires the latest version of pinned dependencies"
end

#check_requirements(req_map) ⇒ Object



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'brew/Library/Homebrew/formula_installer.rb', line 423

def check_requirements(req_map)
  @requirement_messages = []
  fatals = []

  req_map.each_pair do |dependent, reqs|
    reqs.each do |req|
      next if dependent.latest_version_installed? && req.name == "maximummacos"

      @requirement_messages << "#{dependent}: #{req.message}"
      fatals << req if req.fatal?
    end
  end

  return if fatals.empty?

  puts_requirement_messages
  raise UnsatisfiedRequirements, fatals
end

#cleanObject



935
936
937
938
939
940
941
942
943
944
# File 'brew/Library/Homebrew/formula_installer.rb', line 935

def clean
  ohai "Cleaning" if verbose?
  Cleaner.new(formula).clean
rescue Exception => e # rubocop:disable Lint/RescueException
  opoo "The cleaning step did not complete successfully"
  puts "Still, the installation was successful, so we will link it into your prefix"
  ohai e, e.backtrace if debug?
  Homebrew.failed = true
  @show_summary_heading = true
end

#compute_and_install_dependenciesObject



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

def compute_and_install_dependencies
  deps = compute_dependencies
  install_dependencies(deps)
end

#compute_dependenciesObject

Compute and collect the dependencies needed by the formula currently being installed.



400
401
402
403
404
# File 'brew/Library/Homebrew/formula_installer.rb', line 400

def compute_dependencies
  req_map, req_deps = expand_requirements
  check_requirements(req_map)
  expand_dependencies(req_deps + formula.deps)
end

#display_options(formula) ⇒ Object



543
544
545
546
547
548
549
550
551
552
553
# File 'brew/Library/Homebrew/formula_installer.rb', line 543

def display_options(formula)
  options = if formula.head?
    ["--HEAD"]
  elsif formula.devel?
    ["--devel"]
  else
    []
  end
  options += effective_build_options_for(formula).used_options.to_a
  options
end

#downloaderObject



1017
1018
1019
1020
1021
1022
1023
1024
1025
# File 'brew/Library/Homebrew/formula_installer.rb', line 1017

def downloader
  if (bottle_path = formula.local_bottle_path)
    LocalBottleDownloadStrategy.new(bottle_path)
  elsif pour_bottle?
    formula.bottle
  else
    formula
  end
end

#effective_build_options_for(dependent, inherited_options = []) ⇒ Object



535
536
537
538
539
540
541
# File 'brew/Library/Homebrew/formula_installer.rb', line 535

def effective_build_options_for(dependent, inherited_options = [])
  args  = dependent.build.used_options
  args |= (dependent == formula) ? options : inherited_options
  args |= Tab.for_formula(dependent).used_options
  args &= dependent.options
  BuildOptions.new(args, dependent.options)
end

#expand_dependencies(deps) ⇒ Object



490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
# File 'brew/Library/Homebrew/formula_installer.rb', line 490

def expand_dependencies(deps)
  inherited_options = Hash.new { |hash, key| hash[key] = Options.new }
  pour_bottle = pour_bottle?

  expanded_deps = Dependency.expand(formula, deps) do |dependent, dep|
    inherited_options[dep.name] |= inherited_options_for(dep)
    build = effective_build_options_for(
      dependent,
      inherited_options.fetch(dependent.name, []),
    )

    keep_build_test = false
    keep_build_test ||= dep.test? && include_test? && Homebrew.args.include_formula_test_deps?(dependent)
    keep_build_test ||= dep.build? && !install_bottle_for?(dependent, build) && !dependent.latest_version_installed?

    if dep.prune_from_option?(build)
      Dependency.prune
    elsif (dep.build? || dep.test?) && !keep_build_test
      Dependency.prune
    elsif dep.satisfied?(inherited_options[dep.name])
      Dependency.skip
    else
      pour_bottle ||= install_bottle_for?(dep.to_formula, build)
    end
  end

  if pour_bottle && !Keg.bottle_dependencies.empty?
    bottle_deps = if !Keg.bottle_dependencies.include?(formula.name)
      Keg.bottle_dependencies
    elsif !Keg.relocation_formulae.include?(formula.name)
      Keg.relocation_formulae
    else
      []
    end
    bottle_deps = bottle_deps.map { |formula| Dependency.new(formula) }
                             .reject do |dep|
      inherited_options[dep.name] |= inherited_options_for(dep)
      dep.satisfied? inherited_options[dep.name]
    end
    expanded_deps = Dependency.merge_repeats(bottle_deps + expanded_deps)
  end

  expanded_deps.map { |dep| [dep, inherited_options[dep.name]] }
end

#expand_requirementsObject



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
# File 'brew/Library/Homebrew/formula_installer.rb', line 450

def expand_requirements
  unsatisfied_reqs = Hash.new { |h, k| h[k] = [] }
  req_deps = []
  formulae = [formula]
  formula_deps_map = Dependency.expand(formula)
                               .each_with_object({}) do |dep, hash|
    hash[dep.name] = dep
  end

  while f = formulae.pop
    runtime_requirements = runtime_requirements(f)
    f.recursive_requirements do |dependent, req|
      build = effective_build_options_for(dependent)
      install_bottle_for_dependent = install_bottle_for?(dependent, build)

      keep_build_test = false
      keep_build_test ||= runtime_requirements.include?(req)
      keep_build_test ||= req.test? && include_test? && dependent == f
      keep_build_test ||= req.build? && !install_bottle_for_dependent && !dependent.latest_version_installed?

      if req.prune_from_option?(build)
        Requirement.prune
      elsif req.satisfied?
        Requirement.prune
      elsif (req.build? || req.test?) && !keep_build_test
        Requirement.prune
      elsif (dep = formula_deps_map[dependent.name]) && dep.build?
        Requirement.prune
      else
        unsatisfied_reqs[dependent] << req
      end
    end
  end

  # Merge the repeated dependencies, which may have different tags.
  req_deps = Dependency.merge_repeats(req_deps)

  [unsatisfied_reqs, req_deps]
end

#fetchObject



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
# File 'brew/Library/Homebrew/formula_installer.rb', line 991

def fetch
  fetch_dependencies

  return if only_deps?

  if pour_bottle?(warn: true)
    begin
      downloader.fetch
    rescue Exception => e # rubocop:disable Lint/RescueException
      raise if Homebrew::EnvConfig.developer? ||
               Homebrew::EnvConfig.no_bottle_source_fallback? ||
               e.is_a?(Interrupt)

      @pour_failed = true
      onoe e.message
      opoo "Bottle installation failed: building from source."
      fetch_dependencies
    end
  end
  return if pour_bottle?

  formula.fetch_patches
  formula.resources.each(&:fetch)
  downloader.fetch
end

#fetch_dependenciesObject



982
983
984
985
986
987
988
989
# File 'brew/Library/Homebrew/formula_installer.rb', line 982

def fetch_dependencies
  return if ignore_deps?

  deps = compute_dependencies
  return if deps.empty?

  deps.each { |dep, _options| fetch_dependency(dep) }
end

#fetch_dependency(dep) ⇒ Object



577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
# File 'brew/Library/Homebrew/formula_installer.rb', line 577

def fetch_dependency(dep)
  df = dep.to_formula
  fi = FormulaInstaller.new(df)

  fi.build_from_source       = Homebrew.args.build_formula_from_source?(df)
  fi.force_bottle            = false
  fi.include_test            = Homebrew.args.include_formula_test_deps?(df)
  fi.verbose                 = verbose?
  fi.quiet                   = quiet?
  fi.debug                   = debug?
  # When fetching we don't need to recurse the dependency tree as it's already
  # been done for us in `compute_dependencies` and there's no requirement to
  # fetch in a particular order.
  fi.ignore_deps             = true
  fi.fetch
end

#finishObject



665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
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
# File 'brew/Library/Homebrew/formula_installer.rb', line 665

def finish
  return if only_deps?

  ohai "Finishing up" if verbose?

  install_plist

  keg = Keg.new(formula.prefix)
  link(keg)

  fix_dynamic_linkage(keg) unless @poured_bottle && formula.bottle_specification.skip_relocation?

  if build_bottle?
    ohai "Not running post_install as we're building a bottle"
    puts "You can run it manually using `brew postinstall #{formula.full_name}`"
  else
    post_install
  end

  # Updates the cache for a particular formula after doing an install
  CacheStoreDatabase.use(:linkage) do |db|
    break unless db.created?

    LinkageChecker.new(keg, formula, cache_db: db, rebuild_cache: true)
  end

  # Update tab with actual runtime dependencies
  tab = Tab.for_keg(keg)
  Tab.clear_cache
  f_runtime_deps = formula.runtime_dependencies(read_from_tab: false)
  tab.runtime_dependencies = Tab.runtime_deps_hash(f_runtime_deps)
  tab.write

  # let's reset Utils.git_available? if we just installed git
  Utils.clear_git_available_cache if formula.name == "git"

  # use installed curl when it's needed and available
  if formula.name == "curl" &&
     !DevelopmentTools.curl_handles_most_https_certificates?
    ENV["HOMEBREW_CURL"] = formula.opt_bin/"curl"
  end

  caveats

  ohai "Summary" if verbose? || show_summary_heading?
  puts summary

  self.class.installed << formula
ensure
  unlock
end

#fix_dynamic_linkage(keg) ⇒ Object



924
925
926
927
928
929
930
931
932
933
# File 'brew/Library/Homebrew/formula_installer.rb', line 924

def fix_dynamic_linkage(keg)
  keg.fix_dynamic_linkage
rescue Exception => e # rubocop:disable Lint/RescueException
  onoe "Failed to fix install linkage"
  puts "The formula built, but you may encounter issues using it or linking other"
  puts "formulae against it."
  ohai e, e.backtrace if debug?
  Homebrew.failed = true
  @show_summary_heading = true
end

#inherited_options_for(dep) ⇒ Object



555
556
557
558
559
560
561
562
# File 'brew/Library/Homebrew/formula_installer.rb', line 555

def inherited_options_for(dep)
  inherited_options = Options.new
  u = Option.new("universal")
  if (options.include?(u) || formula.require_universal_deps?) && !dep.build? && dep.to_formula.option_defined?(u)
    inherited_options << u
  end
  inherited_options
end

#installObject

Raises:



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
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
294
295
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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'brew/Library/Homebrew/formula_installer.rb', line 232

def install
  lock

  start_time = Time.now
  if !formula.bottle_unneeded? && !pour_bottle? && DevelopmentTools.installed?
    Homebrew::Install.perform_build_from_source_checks
  end

  # not in initialize so upgrade can unlink the active keg before calling this
  # function but after instantiating this class so that it can avoid having to
  # relink the active keg if possible (because it is slow).
  if formula.linked_keg.directory?
    message = <<~EOS
      #{formula.name} #{formula.linked_version} is already installed
    EOS
    if formula.outdated? && !formula.head?
      message += <<~EOS
        To upgrade to #{formula.pkg_version}, run `brew upgrade #{formula.full_name}`.
      EOS
    elsif only_deps?
      message = nil
    else
      # some other version is already installed *and* linked
      message += <<~EOS
        To install #{formula.pkg_version}, first run `brew unlink #{formula.name}`.
      EOS
    end
    raise CannotInstallFormulaError, message if message
  end

  # Warn if a more recent version of this formula is available in the tap.
  begin
    if formula.pkg_version < (v = Formulary.factory(formula.full_name).pkg_version)
      opoo "#{formula.full_name} #{v} is available and more recent than version #{formula.pkg_version}."
    end
  rescue FormulaUnavailableError
    nil
  end

  check_conflicts

  raise BuildToolsError, [formula] if !pour_bottle? && !formula.bottle_unneeded? && !DevelopmentTools.installed?

  unless ignore_deps?
    deps = compute_dependencies
    check_dependencies_bottled(deps) if pour_bottle? && !DevelopmentTools.installed?
    install_dependencies(deps)
  end

  return if only_deps?

  if build_bottle? && (arch = Homebrew.args.bottle_arch) && !Hardware::CPU.optimization_flags.include?(arch.to_sym)
    raise "Unrecognized architecture for --bottle-arch: #{arch}"
  end

  formula.deprecated_flags.each do |deprecated_option|
    old_flag = deprecated_option.old_flag
    new_flag = deprecated_option.current_flag
    opoo "#{formula.full_name}: #{old_flag} was deprecated; using #{new_flag} instead!"
  end

  options = display_options(formula).join(" ")
  oh1 "Installing #{Formatter.identifier(formula.full_name)} #{options}".strip if show_header?

  unless formula.tap&.private?
    action = "#{formula.full_name} #{options}".strip
    Utils::Analytics.report_event("install", action)

    Utils::Analytics.report_event("install_on_request", action) if installed_on_request
  end

  self.class.attempted << formula

  if pour_bottle?
    begin
      pour
    rescue Exception => e # rubocop:disable Lint/RescueException
      # any exceptions must leave us with nothing installed
      ignore_interrupts do
        begin
          formula.prefix.rmtree if formula.prefix.directory?
        rescue Errno::EACCES, Errno::ENOTEMPTY
          odie <<~EOS
            Could not remove #{formula.prefix.basename} keg! Do so manually:
              sudo rm -rf #{formula.prefix}
          EOS
        end
        formula.rack.rmdir_if_possible
      end
      raise if Homebrew::EnvConfig.developer? ||
               Homebrew::EnvConfig.no_bottle_source_fallback? ||
               e.is_a?(Interrupt)

      @pour_failed = true
      onoe e.message
      opoo "Bottle installation failed: building from source."
      raise BuildToolsError, [formula] unless DevelopmentTools.installed?

      compute_and_install_dependencies unless ignore_deps?
    else
      @poured_bottle = true
    end
  end

  puts_requirement_messages

  build_bottle_preinstall if build_bottle?

  unless @poured_bottle
    build
    clean

    # Store the formula used to build the keg in the keg.
    formula_contents = if formula.local_bottle_path
      Utils::Bottles.formula_contents formula.local_bottle_path, name: formula.name
    else
      formula.path.read
    end
    s = formula_contents.gsub(/  bottle do.+?end\n\n?/m, "")
    brew_prefix = formula.prefix/".brew"
    brew_prefix.mkdir
    Pathname(brew_prefix/"#{formula.name}.rb").atomic_write(s)

    keg = Keg.new(formula.prefix)
    tab = Tab.for_keg(keg)
    tab.installed_as_dependency = installed_as_dependency
    tab.installed_on_request = installed_on_request
    tab.write
  end

  build_bottle_postinstall if build_bottle?

  opoo "Nothing was installed to #{formula.prefix}" unless formula.latest_version_installed?
  end_time = Time.now
  Homebrew.messages.formula_installed(formula, end_time - start_time)
end

#install_bottle_for?(dep, build) ⇒ Boolean

Returns:

  • (Boolean)


139
140
141
142
143
144
145
146
147
# File 'brew/Library/Homebrew/formula_installer.rb', line 139

def install_bottle_for?(dep, build)
  return pour_bottle? if dep == formula
  return false if Homebrew.args.build_formula_from_source?(dep)
  return false unless dep.bottle && dep.pour_bottle?
  return false unless build.used_options.empty?
  return false unless dep.bottle.compatible_cellar?

  true
end

#install_dependencies(deps) ⇒ Object



564
565
566
567
568
569
570
571
572
573
574
575
# File 'brew/Library/Homebrew/formula_installer.rb', line 564

def install_dependencies(deps)
  if deps.empty? && only_deps?
    puts "All dependencies for #{formula.full_name} are satisfied."
  elsif !deps.empty?
    oh1 "Installing dependencies for #{formula.full_name}: " \
        "#{deps.map(&:first).map(&Formatter.method(:identifier)).to_sentence}",
        truncate: false
    deps.each { |dep, options| install_dependency(dep, options) }
  end

  @show_header = true unless deps.empty?
end

#install_dependency(dep, inherited_options) ⇒ Object



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
# File 'brew/Library/Homebrew/formula_installer.rb', line 594

def install_dependency(dep, inherited_options)
  df = dep.to_formula
  tab = Tab.for_formula(df)

  if df.linked_keg.directory?
    linked_keg = Keg.new(df.linked_keg.resolved_path)
    keg_had_linked_keg = true
    keg_was_linked = linked_keg.linked?
    linked_keg.unlink
  end

  if df.latest_version_installed?
    installed_keg = Keg.new(df.prefix)
    tmp_keg = Pathname.new("#{installed_keg}.tmp")
    installed_keg.rename(tmp_keg)
  end

  tab_tap = tab.source["tap"]
  if tab_tap.present? && df.tap.present? && df.tap.to_s != tab_tap.to_s
    odie <<~EOS
      #{df} is already installed from #{tab_tap}!
      Please `brew uninstall #{df}` first."
    EOS
  end

  fi = FormulaInstaller.new(df)
  fi.options                |= tab.used_options
  fi.options                |= Tab.remap_deprecated_options(df.deprecated_options, dep.options)
  fi.options                |= inherited_options
  fi.options                &= df.options
  fi.build_from_source       = Homebrew.args.build_formula_from_source?(df)
  fi.force_bottle            = false
  fi.include_test            = Homebrew.args.include_formula_test_deps?(df)
  fi.verbose                 = verbose?
  fi.quiet                   = quiet?
  fi.debug                   = debug?
  fi.link_keg              ||= keg_was_linked if keg_had_linked_keg
  fi.installed_as_dependency = true
  fi.installed_on_request    = df.any_version_installed? && tab.installed_on_request
  fi.prelude
  oh1 "Installing #{formula.full_name} dependency: #{Formatter.identifier(dep.name)}"
  fi.install
  fi.finish
rescue Exception => e # rubocop:disable Lint/RescueException
  ignore_interrupts do
    tmp_keg.rename(installed_keg) if tmp_keg && !installed_keg.directory?
    linked_keg.link if keg_was_linked
  end
  raise unless e.is_a? FormulaInstallationAlreadyAttemptedError

  # We already attempted to install f as part of another formula's
  # dependency tree. In that case, don't generate an error, just move on.
  nil
else
  ignore_interrupts { tmp_keg.rmtree if tmp_keg&.directory? }
end

#install_plistObject



911
912
913
914
915
916
917
918
919
920
921
922
# File 'brew/Library/Homebrew/formula_installer.rb', line 911

def install_plist
  return unless formula.plist

  formula.plist_path.atomic_write(formula.plist)
  formula.plist_path.chmod 0644
  log = formula.var/"log"
  log.mkpath if formula.plist.include? log.to_s
rescue Exception => e # rubocop:disable Lint/RescueException
  onoe "Failed to install plist file"
  ohai e, e.backtrace if debug?
  Homebrew.failed = true
end


823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
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
904
905
906
907
908
909
# File 'brew/Library/Homebrew/formula_installer.rb', line 823

def link(keg)
  unless link_keg
    begin
      keg.optlink
      Formula.clear_cache
    rescue Keg::LinkError => e
      onoe "Failed to create #{formula.opt_prefix}"
      puts "Things that depend on #{formula.full_name} will probably not build."
      puts e
      Homebrew.failed = true
    end
    return
  end

  cask_installed_with_formula_name = begin
    Cask::CaskLoader.load(formula.name).installed?
  rescue Cask::CaskUnavailableError, Cask::CaskInvalidError
    false
  end

  if cask_installed_with_formula_name
    ohai "#{formula.name} cask is installed, skipping link."
    return
  end

  if keg.linked?
    opoo "This keg was marked linked already, continuing anyway"
    keg.remove_linked_keg_record
  end

  link_overwrite_backup = {} # Hash: conflict file -> backup file
  backup_dir = HOMEBREW_CACHE/"Backup"

  begin
    keg.link
  rescue Keg::ConflictError => e
    conflict_file = e.dst
    if formula.link_overwrite?(conflict_file) && !link_overwrite_backup.key?(conflict_file)
      backup_file = backup_dir/conflict_file.relative_path_from(HOMEBREW_PREFIX).to_s
      backup_file.parent.mkpath
      FileUtils.mv conflict_file, backup_file
      link_overwrite_backup[conflict_file] = backup_file
      retry
    end
    onoe "The `brew link` step did not complete successfully"
    puts "The formula built, but is not symlinked into #{HOMEBREW_PREFIX}"
    puts e
    puts
    puts "Possible conflicting files are:"
    mode = OpenStruct.new(dry_run: true, overwrite: true)
    keg.link(mode)
    @show_summary_heading = true
    Homebrew.failed = true
  rescue Keg::LinkError => e
    onoe "The `brew link` step did not complete successfully"
    puts "The formula built, but is not symlinked into #{HOMEBREW_PREFIX}"
    puts e
    puts
    puts "You can try again using:"
    puts "  brew link #{formula.name}"
    @show_summary_heading = true
    Homebrew.failed = true
  rescue Exception => e # rubocop:disable Lint/RescueException
    onoe "An unexpected error occurred during the `brew link` step"
    puts "The formula built, but is not symlinked into #{HOMEBREW_PREFIX}"
    puts e
    puts e.backtrace if debug?
    @show_summary_heading = true
    ignore_interrupts do
      keg.unlink
      link_overwrite_backup.each do |origin, backup|
        origin.parent.mkpath
        FileUtils.mv backup, origin
      end
    end
    Homebrew.failed = true
    raise
  end

  return if link_overwrite_backup.empty?

  opoo "These files were overwritten during `brew link` step:"
  puts link_overwrite_backup.keys
  puts
  puts "They have been backed up in #{backup_dir}"
  @show_summary_heading = true
end

#post_installObject



946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
# File 'brew/Library/Homebrew/formula_installer.rb', line 946

def post_install
  args = %W[
    nice #{RUBY_PATH}
    -W0
    -I #{$LOAD_PATH.join(File::PATH_SEPARATOR)}
    --
    #{HOMEBREW_LIBRARY_PATH}/postinstall.rb
    #{formula.path}
  ]

  Utils.safe_fork do
    if Sandbox.available?
      sandbox = Sandbox.new
      formula.logs.mkpath
      sandbox.record_log(formula.logs/"postinstall.sandbox.log")
      sandbox.allow_write_temp_and_cache
      sandbox.allow_write_log(formula)
      sandbox.allow_write_xcode
      sandbox.deny_write_homebrew_repository
      sandbox.allow_write_cellar(formula)
      Keg::KEG_LINK_DIRECTORIES.each do |dir|
        sandbox.allow_write_path "#{HOMEBREW_PREFIX}/#{dir}"
      end
      sandbox.exec(*args)
    else
      exec(*args)
    end
  end
rescue Exception => e # rubocop:disable Lint/RescueException
  opoo "The post-install step did not complete successfully"
  puts "You can try again using `brew postinstall #{formula.full_name}`"
  ohai e, e.backtrace if debug? || Homebrew::EnvConfig.developer?
  Homebrew.failed = true
  @show_summary_heading = true
end

#pourObject



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
# File 'brew/Library/Homebrew/formula_installer.rb', line 1027

def pour
  HOMEBREW_CELLAR.cd do
    downloader.stage
  end

  keg = Keg.new(formula.prefix)
  tab = Tab.for_keg(keg)
  Tab.clear_cache

  skip_linkage = formula.bottle_specification.skip_relocation?
  keg.replace_placeholders_with_locations tab.changed_files, skip_linkage: skip_linkage

  tab = Tab.for_keg(keg)

  CxxStdlib.check_compatibility(
    formula, formula.recursive_dependencies,
    Keg.new(formula.prefix), tab.compiler
  )

  tab.tap = formula.tap
  tab.poured_from_bottle = true
  tab.time = Time.now.to_i
  tab.head = HOMEBREW_REPOSITORY.git_head
  tab.source["path"] = formula.specified_path.to_s
  tab.installed_as_dependency = installed_as_dependency
  tab.installed_on_request = installed_on_request
  tab.aliases = formula.aliases
  tab.write
end

#pour_bottle?(install_bottle_options = { warn: false }) ⇒ Boolean

Returns:

  • (Boolean)


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'brew/Library/Homebrew/formula_installer.rb', line 105

def pour_bottle?(install_bottle_options = { warn: false })
  return false if @pour_failed

  return false if !formula.bottled? && !formula.local_bottle_path
  return true  if force_bottle?
  return false if build_from_source? || build_bottle? || interactive?
  return false if Homebrew.args.cc
  return false unless options.empty?
  return false if formula.bottle_disabled?

  unless formula.pour_bottle?
    if install_bottle_options[:warn] && formula.pour_bottle_check_unsatisfied_reason
      opoo <<~EOS
        Building #{formula.full_name} from source:
          #{formula.pour_bottle_check_unsatisfied_reason}
      EOS
    end
    return false
  end

  bottle = formula.bottle_specification
  unless bottle.compatible_cellar?
    if install_bottle_options[:warn]
      opoo <<~EOS
        Building #{formula.full_name} from source:
          The bottle needs a #{bottle.cellar} Cellar (yours is #{HOMEBREW_CELLAR}).
      EOS
    end
    return false
  end

  true
end

#preludeObject



149
150
151
152
153
154
155
# File 'brew/Library/Homebrew/formula_installer.rb', line 149

def prelude
  Tab.clear_cache
  verify_deps_exist unless ignore_deps?
  forbidden_license_check

  check_install_sanity
end

#problem_if_output(output) ⇒ Object



1057
1058
1059
1060
1061
1062
# File 'brew/Library/Homebrew/formula_installer.rb', line 1057

def problem_if_output(output)
  return unless output

  opoo output
  @show_summary_heading = true
end

#runtime_requirements(formula) ⇒ Object



442
443
444
445
446
447
448
# File 'brew/Library/Homebrew/formula_installer.rb', line 442

def runtime_requirements(formula)
  runtime_deps = formula.runtime_formula_dependencies(undeclared: false)
  recursive_requirements = formula.recursive_requirements do |dependent, _|
    Requirement.prune unless runtime_deps.include?(dependent)
  end
  (recursive_requirements.to_a + formula.requirements.to_a).reject(&:build?).uniq
end

#sanitized_argv_optionsObject



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
# File 'brew/Library/Homebrew/formula_installer.rb', line 729

def sanitized_argv_options
  args = []
  args << "--ignore-dependencies" if ignore_deps?

  if build_bottle?
    args << "--build-bottle"
    args << "--bottle-arch=#{Homebrew.args.bottle_arch}" if Homebrew.args.bottle_arch
  end

  args << "--git" if git?
  args << "--interactive" if interactive?
  args << "--verbose" if verbose?
  args << "--debug" if debug?
  args << "--cc=#{Homebrew.args.cc}" if Homebrew.args.cc
  args << "--keep-tmp" if Homebrew.args.keep_tmp?

  if Homebrew.args.env.present?
    args << "--env=#{Homebrew.args.env}"
  elsif formula.env.std? || formula.deps.select(&:build?).any? { |d| d.name == "scons" }
    args << "--env=std"
  end

  if formula.head?
    args << "--HEAD"
  elsif formula.devel?
    args << "--devel"
  end

  formula.options.each do |opt|
    name = opt.name[/^([^=]+)=$/, 1]
    value = Homebrew.args.value(name) if name
    args << "--#{name}=#{value}" if value
  end

  args
end

#summaryObject



717
718
719
720
721
722
723
# File 'brew/Library/Homebrew/formula_installer.rb', line 717

def summary
  s = +""
  s << "#{Homebrew::EnvConfig.install_badge}  " unless Homebrew::EnvConfig.no_emoji?
  s << "#{formula.prefix.resolved_path}: #{formula.prefix.abv}"
  s << ", built in #{pretty_duration build_time}" if build_time
  s.freeze
end

#verify_deps_existObject



157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'brew/Library/Homebrew/formula_installer.rb', line 157

def verify_deps_exist
  begin
    compute_dependencies
  rescue TapFormulaUnavailableError => e
    raise if e.tap.installed?

    e.tap.install
    retry
  end
rescue FormulaUnavailableError => e
  e.dependent = formula.full_name
  raise
end