Class: FormulaInstaller Private
- Extended by:
- Attrable
- Includes:
- FormulaCellarChecks
- Defined in:
- extend/os/mac/formula_installer.rb,
extend/os/linux/formula_installer.rb,
formula_installer.rb,
sorbet/rbi/parlour.rbi
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 formula.
Constant Summary
Constants included from FormulaCellarChecks
FormulaCellarChecks::VALID_LIBRARY_EXTENSIONS
Instance Attribute Summary collapse
- #bottle_tab_runtime_dependencies ⇒ Object readonly private
- #formula ⇒ Object readonly private
- #link_keg ⇒ Object private
- #options ⇒ Object private
Class Method Summary collapse
- .attempted ⇒ Object private
- .clear_attempted ⇒ void private
- .clear_fetched ⇒ void private
- .clear_installed ⇒ void private
- .fetched ⇒ Object private
- .installed ⇒ Object private
- .locked ⇒ Object private
Instance Method Summary collapse
- #audit_installed ⇒ Object private
- #build ⇒ void private
- #build_argv ⇒ Array<String> private
- #build_bottle? ⇒ Boolean private
- #build_bottle_postinstall ⇒ Object private
- #build_bottle_preinstall ⇒ Object private
- #build_from_source? ⇒ Boolean private
- #build_time ⇒ Object private
- #caveats ⇒ void private
- #check_conflicts ⇒ Object private
- #check_install_sanity ⇒ Object private
- #check_installation_already_attempted ⇒ Object private
- #check_requirements(req_map) ⇒ Object private
- #clean ⇒ void private
- #compute_and_install_dependencies ⇒ Object private
-
#compute_dependencies(use_cache: true) ⇒ Object
private
Compute and collect the dependencies needed by the formula currently being installed.
- #debug? ⇒ Boolean private
- #debug_symbols? ⇒ Boolean private
- #display_options(formula) ⇒ Object private
- #downloader ⇒ Object private
- #effective_build_options_for(dependent, inherited_options = []) ⇒ Object private
- #expand_dependencies ⇒ Object private
- #expand_dependencies_for_formula(formula, inherited_options) ⇒ Object private
- #expand_requirements ⇒ Object private
- #fetch ⇒ void private
- #fetch_bottle_tab ⇒ void private
- #fetch_dependencies ⇒ void private
- #fetch_dependency(dep) ⇒ void private
- #finish ⇒ void private
- #fix_dynamic_linkage(keg) ⇒ void private
- #forbidden_formula_check ⇒ void private
- #forbidden_license_check ⇒ void private
- #forbidden_tap_check ⇒ void private
- #force? ⇒ Boolean private
- #force_bottle? ⇒ Boolean private
- #fresh_install?(formula) ⇒ Boolean? private
- #git? ⇒ Boolean private
- #hold_locks? ⇒ Boolean private
- #ignore_deps? ⇒ Boolean private
- #include_test? ⇒ Boolean private
- #inherited_options_for(dep) ⇒ Options private
-
#initialize(formula, link_keg: false, installed_as_dependency: false, installed_on_request: true, show_header: false, build_bottle: false, skip_post_install: false, force_bottle: false, bottle_arch: nil, ignore_deps: false, only_deps: false, include_test_formulae: [], build_from_source_formulae: [], env: nil, git: false, interactive: false, keep_tmp: false, debug_symbols: false, cc: nil, options: Options.new, force: false, overwrite: false, debug: false, quiet: false, verbose: false) ⇒ FormulaInstaller
constructor
private
A new instance of FormulaInstaller.
- #install ⇒ void private
- #install_bottle_for?(dep, build) ⇒ Boolean private
- #install_dependencies(deps) ⇒ void private
- #install_dependency(dep, inherited_options) ⇒ void private
- #install_fetch_deps ⇒ void private
- #install_service ⇒ void private
- #installed_as_dependency? ⇒ Boolean private
- #installed_on_request? ⇒ Boolean private
- #interactive? ⇒ Boolean private
- #keep_tmp? ⇒ Boolean private
- #link(keg) ⇒ void private
- #only_deps? ⇒ Boolean private
- #overwrite? ⇒ Boolean private
- #post_install ⇒ void private
- #post_install_formula_path ⇒ Pathname private
- #pour ⇒ void private
- #pour_bottle?(output_warning: false) ⇒ Boolean private
- #prelude ⇒ void private
- #previously_fetched_formula ⇒ Formula? private
- #problem_if_output(output) ⇒ void private
- #quiet? ⇒ Boolean private
- #runtime_requirements(formula) ⇒ Object private
- #sanitized_argv_options ⇒ Array<String> private
- #show_header? ⇒ Boolean private
- #show_summary_heading? ⇒ Boolean private
- #skip_post_install? ⇒ Boolean private
- #summary ⇒ String private
- #unbottled_dependencies(deps) ⇒ Object private
- #verbose? ⇒ Boolean private
- #verify_deps_exist ⇒ void private
Methods included from Attrable
Methods included from FormulaCellarChecks
#check_binary_arches, #check_cpuid_instruction, #check_easy_install_pth, #check_elisp_dirname, #check_elisp_root, #check_env_path, #check_flat_namespace, #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_python_symlinks, #check_service_command, #check_shadowed_headers, #check_shim_references, #valid_library_extension?
Methods included from Kernel
#disk_usage_readable, #ensure_executable!, #ensure_formula_installed!, #exec_browser, #exec_editor, #ignore_interrupts, #interactive_shell, #number_readable, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #paths, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled, #quiet_system, #redact_secrets, #redirect_stdout, #require?, #safe_system, #tap_and_name_comparison, #truncate_text_to_approximate_size, #which, #which_all, #which_editor, #with_custom_locale, #with_env, #with_homebrew_path
Constructor Details
#initialize(formula, link_keg: false, installed_as_dependency: false, installed_on_request: true, show_header: false, build_bottle: false, skip_post_install: false, force_bottle: false, bottle_arch: nil, ignore_deps: false, only_deps: false, include_test_formulae: [], build_from_source_formulae: [], env: nil, git: false, interactive: false, keep_tmp: false, debug_symbols: false, cc: nil, options: Options.new, force: false, overwrite: false, debug: false, quiet: false, verbose: false) ⇒ FormulaInstaller
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Returns a new instance of FormulaInstaller.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'formula_installer.rb', line 42 def initialize( formula, link_keg: false, installed_as_dependency: false, installed_on_request: true, show_header: false, build_bottle: false, skip_post_install: false, force_bottle: false, bottle_arch: nil, ignore_deps: false, only_deps: false, include_test_formulae: [], build_from_source_formulae: [], env: nil, git: false, interactive: false, keep_tmp: false, debug_symbols: false, cc: nil, options: Options.new, force: false, overwrite: false, debug: false, quiet: false, verbose: false ) @formula = formula @env = env @force = force @overwrite = overwrite @keep_tmp = keep_tmp @debug_symbols = debug_symbols @link_keg = !formula.keg_only? || link_keg @show_header = show_header @ignore_deps = ignore_deps @only_deps = only_deps @build_from_source_formulae = build_from_source_formulae @build_bottle = build_bottle @skip_post_install = skip_post_install @bottle_arch = bottle_arch @formula.force_bottle ||= force_bottle @force_bottle = @formula.force_bottle @include_test_formulae = include_test_formulae @interactive = interactive @git = git @cc = cc @verbose = verbose @quiet = quiet @debug = debug @installed_as_dependency = installed_as_dependency @installed_on_request = installed_on_request @options = @requirement_messages = [] @poured_bottle = false @start_time = nil @bottle_tab_runtime_dependencies = {}.freeze # Take the original formula instance, which might have been swapped from an API instance to a source instance @formula = previously_fetched_formula if previously_fetched_formula end |
Instance Attribute Details
#bottle_tab_runtime_dependencies ⇒ Object (readonly)
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
32 33 34 |
# File 'formula_installer.rb', line 32 def bottle_tab_runtime_dependencies @bottle_tab_runtime_dependencies end |
#formula ⇒ Object (readonly)
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
32 33 34 |
# File 'formula_installer.rb', line 32 def formula @formula end |
#link_keg ⇒ 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.
34 35 36 |
# File 'formula_installer.rb', line 34 def link_keg @link_keg end |
#options ⇒ 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.
34 35 36 |
# File 'formula_installer.rb', line 34 def @options end |
Class Method Details
.attempted ⇒ 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.
104 105 106 |
# File 'formula_installer.rb', line 104 def self.attempted @attempted ||= Set.new end |
.clear_attempted ⇒ 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.
109 110 111 |
# File 'formula_installer.rb', line 109 def self.clear_attempted @attempted = Set.new end |
.clear_fetched ⇒ 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.
127 128 129 |
# File 'formula_installer.rb', line 127 def self.clear_fetched @fetched = Set.new end |
.clear_installed ⇒ 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.
118 119 120 |
# File 'formula_installer.rb', line 118 def self.clear_installed @installed = Set.new end |
.fetched ⇒ 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.
122 123 124 |
# File 'formula_installer.rb', line 122 def self.fetched @fetched ||= Set.new end |
.installed ⇒ 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.
113 114 115 |
# File 'formula_installer.rb', line 113 def self.installed @installed ||= Set.new end |
.locked ⇒ 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.
1337 1338 1339 |
# File 'formula_installer.rb', line 1337 def self.locked @locked ||= [] end |
Instance Method Details
#audit_installed ⇒ 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.
1329 1330 1331 1332 1333 1334 1335 |
# File 'formula_installer.rb', line 1329 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 |
#build ⇒ 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.
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 |
# File 'formula_installer.rb', line 910 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 = [ "nice", *HOMEBREW_RUBY_EXEC_ARGS, "--", HOMEBREW_LIBRARY_PATH/"build.rb", formula.specified_path, ].concat(build_argv) Utils.safe_fork do |error_pipe| if Sandbox.available? sandbox = Sandbox.new formula.logs.mkpath sandbox.record_log(formula.logs/"build.sandbox.log") sandbox.allow_write_path(Dir.home) if 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.deny_all_network_except_pipe(error_pipe) unless formula.network_access_allowed?(:build) 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. = (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_argv ⇒ Array<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.
905 906 907 |
# File 'formula_installer.rb', line 905 def build_argv + .as_flags end |
#build_bottle? ⇒ 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.
142 143 144 |
# File 'formula_installer.rb', line 142 def build_bottle? @build_bottle.present? end |
#build_bottle_postinstall ⇒ 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.
375 376 377 378 379 380 |
# File 'formula_installer.rb', line 375 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_preinstall ⇒ 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.
370 371 372 373 |
# File 'formula_installer.rb', line 370 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_from_source? ⇒ 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.
132 133 134 |
# File 'formula_installer.rb', line 132 def build_from_source? @build_from_source_formulae.include?(formula.full_name) end |
#build_time ⇒ 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.
867 868 869 |
# File 'formula_installer.rb', line 867 def build_time @build_time ||= Time.now - @start_time if @start_time && !interactive? end |
#caveats ⇒ void
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
This method returns an undefined value.
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 |
# File 'formula_installer.rb', line 771 def caveats return if only_deps? audit_installed if Homebrew::EnvConfig.developer? return if !installed_on_request? || installed_as_dependency? caveats = Caveats.new(formula) return if caveats.empty? @show_summary_heading = true ohai "Caveats", caveats.to_s Homebrew..record_caveats(formula.name, caveats) end |
#check_conflicts ⇒ 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.
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 |
# File 'formula_installer.rb', line 487 def check_conflicts return if 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.} '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/homebrew-core)!" false else f.linked_keg.exist? && f.opt_prefix.exist? end raise FormulaConflictError.new(formula, conflicts) unless conflicts.empty? end |
#check_install_sanity ⇒ 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.
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 |
# File 'formula_installer.rb', line 247 def check_install_sanity check_installation_already_attempted if force_bottle? && !pour_bottle? raise CannotInstallFormulaError, "--force-bottle passed but #{formula.full_name} has no bottle!" end if Homebrew.default_prefix? && !build_from_source? && !build_bottle? && !formula.head? && formula.tap&.core_tap? && # Integration tests override homebrew-core locations ENV["HOMEBREW_INTEGRATION_TEST"].nil? && !pour_bottle? = if !formula.pour_bottle? && formula.pour_bottle_check_unsatisfied_reason = formula.pour_bottle_check_unsatisfied_reason [0] = [0].downcase <<~EOS #{formula}: #{} EOS # don't want to complain about no bottle available if doing an # upgrade/reinstall/dependency install (but do in the case the bottle # check fails) elsif fresh_install?(formula) <<~EOS #{formula}: no bottle available! EOS end if += <<~EOS If you're feeling brave, you can try to install from source with: brew install --build-from-source #{formula} It is expected behaviour that most formulae will fail to build from source. It is expected behaviour that Homebrew will be buggy and slow when building from source. Do not create any issues about failures building from source on Homebrew's GitHub repositories. Do not create any issues building from source even if you think this message is unrelated. Any opened issues will be immediately closed without response. Do not ask for help from Homebrew or its maintainers on social media. You may ask for help building from source in Homebrew's discussions but are unlikely to receive a response. If building from source fails, try to figure out the problem yourself and submit a fix as a pull request. We will review it but may or may not accept it. EOS raise CannotInstallFormulaError, end end return if ignore_deps? if Homebrew::EnvConfig.developer? # `recursive_dependencies` trims cyclic dependencies, so we do one level and take the recursive deps of that. # Mapping direct dependencies to deeper dependencies in a hash is also useful for the cyclic output below. recursive_dep_map = formula.deps.to_h { |dep| [dep, dep.to_formula.recursive_dependencies] } cyclic_dependencies = [] recursive_dep_map.each do |dep, recursive_deps| if [formula.name, formula.full_name].include?(dep.name) cyclic_dependencies << "#{formula.full_name} depends on itself directly" elsif recursive_deps.any? { |rdep| [formula.name, formula.full_name].include?(rdep.name) } cyclic_dependencies << "#{formula.full_name} depends on itself via #{dep.name}" end end if cyclic_dependencies.present? raise CannotInstallFormulaError, <<~EOS #{formula.full_name} contains a recursive dependency on itself: #{cyclic_dependencies.join("\n ")} EOS end # Merge into one list recursive_deps = recursive_dep_map.flat_map { |dep, rdeps| [dep] + rdeps } Dependency.merge_repeats(recursive_deps) else recursive_deps = formula.recursive_dependencies end invalid_arch_dependencies = [] pinned_unsatisfied_deps = [] recursive_deps.each do |dep| if (tab = Tab.for_formula(dep.to_formula)) && tab.arch.present? && tab.arch.to_s != Hardware::CPU.arch.to_s invalid_arch_dependencies << "#{dep} was built for #{tab.arch}" end next unless dep.to_formula.pinned? next if dep.satisfied?((dep)) next if dep.build? && pour_bottle? pinned_unsatisfied_deps << dep end if invalid_arch_dependencies.present? raise CannotInstallFormulaError, <<~EOS #{formula.full_name} dependencies not built for the #{Hardware::CPU.arch} CPU architecture: #{invalid_arch_dependencies.join("\n ")} EOS 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_installation_already_attempted ⇒ 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.
243 244 245 |
# File 'formula_installer.rb', line 243 def check_installation_already_attempted raise FormulaInstallationAlreadyAttemptedError, formula if self.class.attempted.include?(formula) end |
#check_requirements(req_map) ⇒ 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.
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 |
# File 'formula_installer.rb', line 542 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 == "macos" && req.comparator == "<=" @requirement_messages << "#{dependent}: #{req.}" fatals << req if req.fatal? end end return if fatals.empty? raise UnsatisfiedRequirements, fatals end |
#clean ⇒ 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.
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 |
# File 'formula_installer.rb', line 1100 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." odebug e, Utils::Backtrace.clean(e) Homebrew.failed = true @show_summary_heading = true end |
#compute_and_install_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.
537 538 539 540 |
# File 'formula_installer.rb', line 537 def compute_and_install_dependencies deps = compute_dependencies install_dependencies(deps) end |
#compute_dependencies(use_cache: true) ⇒ 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.
Compute and collect the dependencies needed by the formula currently being installed.
518 519 520 521 522 523 524 525 526 527 |
# File 'formula_installer.rb', line 518 def compute_dependencies(use_cache: true) @compute_dependencies = nil unless use_cache @compute_dependencies ||= begin # Needs to be done before expand_dependencies fetch_bottle_tab if pour_bottle? check_requirements() end end |
#debug? ⇒ 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.
218 |
# File 'sorbet/rbi/parlour.rbi', line 218 def debug?; end |
#debug_symbols? ⇒ 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.
212 |
# File 'sorbet/rbi/parlour.rbi', line 212 def debug_symbols?; end |
#display_options(formula) ⇒ 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 |
# File 'formula_installer.rb', line 645 def (formula) = if formula.head? ["--HEAD"] else [] end += (formula)..to_a end |
#downloader ⇒ 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.
1248 1249 1250 1251 1252 1253 1254 1255 1256 |
# File 'formula_installer.rb', line 1248 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
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.
637 638 639 640 641 642 643 |
# File 'formula_installer.rb', line 637 def (dependent, = []) args = dependent.build. args |= (dependent == formula) ? : args |= Tab.for_formula(dependent). args &= dependent. BuildOptions.new(args, dependent.) end |
#expand_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.
629 630 631 632 633 634 635 |
# File 'formula_installer.rb', line 629 def = Hash.new { |hash, key| hash[key] = Options.new } = (formula, ) .map { |dep| [dep, [dep.name]] } end |
#expand_dependencies_for_formula(formula, inherited_options) ⇒ 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.
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 |
# File 'formula_installer.rb', line 601 def (formula, ) # Cache for this expansion only. FormulaInstaller has a lot of inputs which can alter expansion. cache_key = "FormulaInstaller-#{formula.full_name}-#{Time.now.to_f}" Dependency.(formula, cache_key:) do |dependent, dep| [dep.name] |= (dep) build = ( dependent, .fetch(dependent.name, []), ) keep_build_test = false keep_build_test ||= dep.test? && include_test? && @include_test_formulae.include?(dependent.full_name) keep_build_test ||= dep.build? && !install_bottle_for?(dependent, build) && (formula.head? || !dependent.latest_version_installed?) bottle_runtime_version = @bottle_tab_runtime_dependencies.dig(dep.name, "version").presence bottle_runtime_version = Version.new(bottle_runtime_version) if bottle_runtime_version bottle_runtime_revision = @bottle_tab_runtime_dependencies.dig(dep.name, "revision") if dep.prune_from_option?(build) || ((dep.build? || dep.test?) && !keep_build_test) Dependency.prune elsif dep.satisfied?([dep.name], minimum_version: bottle_runtime_version, minimum_revision: bottle_runtime_revision) Dependency.skip end end end |
#expand_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.
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 |
# File 'formula_installer.rb', line 569 def unsatisfied_reqs = Hash.new { |h, k| h[k] = [] } formulae = [formula] formula_deps_map = formula.recursive_dependencies .each_with_object({}) { |dep, h| h[dep.name] = dep } while (f = formulae.pop) runtime_requirements = runtime_requirements(f) f.recursive_requirements do |dependent, req| build = (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) || req.satisfied?(env: @env, cc: @cc, build_bottle: @build_bottle, bottle_arch: @bottle_arch) || ((req.build? || req.test?) && !keep_build_test) || formula_deps_map[dependent.name]&.build? || (only_deps? && f == dependent) Requirement.prune else unsatisfied_reqs[dependent] << req end end end unsatisfied_reqs end |
#fetch ⇒ 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.
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 |
# File 'formula_installer.rb', line 1226 def fetch return if previously_fetched_formula fetch_dependencies return if only_deps? oh1 "Fetching #{Formatter.identifier(formula.full_name)}".strip if pour_bottle?(output_warning: true) fetch_bottle_tab else @formula = Homebrew::API::Formula.source_download(formula) if formula.loaded_from_api? formula.fetch_patches formula.resources.each(&:fetch) end downloader.fetch self.class.fetched << formula end |
#fetch_bottle_tab ⇒ 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.
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 |
# File 'formula_installer.rb', line 1212 def fetch_bottle_tab @fetch_bottle_tab ||= begin formula.fetch_bottle_tab @bottle_tab_runtime_dependencies = formula.bottle_tab_attributes .fetch("runtime_dependencies", []).then { |deps| deps || [] } .each_with_object({}) { |dep, h| h[dep["full_name"]] = dep } .freeze true rescue DownloadError, ArgumentError @fetch_bottle_tab = true end end |
#fetch_dependencies ⇒ void
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
This method returns an undefined value.
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 |
# File 'formula_installer.rb', line 1182 def fetch_dependencies return if ignore_deps? # Don't output dependencies if we're explicitly installing them. deps = compute_dependencies.reject do |(dep, )| self.class.fetched.include?(dep.to_formula) end return if deps.empty? oh1 "Fetching dependencies for #{formula.full_name}: " \ "#{deps.map(&:first).map { Formatter.identifier(_1) }.to_sentence}", truncate: false deps.each { |(dep, )| fetch_dependency(dep) } end |
#fetch_dependency(dep) ⇒ void
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
This method returns an undefined value.
680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 |
# File 'formula_installer.rb', line 680 def fetch_dependency(dep) df = dep.to_formula fi = FormulaInstaller.new( df, force_bottle: false, # 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. # Note, this tree can vary when pouring bottles so we need to check it then. ignore_deps: !pour_bottle?, installed_as_dependency: true, include_test_formulae: @include_test_formulae, build_from_source_formulae: @build_from_source_formulae, keep_tmp: keep_tmp?, debug_symbols: debug_symbols?, force: force?, debug: debug?, quiet: quiet?, verbose: verbose?, ) fi.prelude fi.fetch end |
#finish ⇒ 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.
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 822 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 |
# File 'formula_installer.rb', line 788 def finish return if only_deps? ohai "Finishing up" if verbose? keg = Keg.new(formula.prefix) link(keg) install_service fix_dynamic_linkage(keg) if !@poured_bottle || !formula.bottle_specification.skip_relocation? Homebrew::Install.global_post_install if build_bottle? || skip_post_install? if build_bottle? ohai "Not running 'post_install' as we're building a bottle" elsif skip_post_install? ohai "Skipping 'post_install' on request" end puts "You can run it manually using:" puts " brew postinstall #{formula.full_name}" else formula.install_etc_var post_install if formula.post_install_defined? end keg.prepare_debug_symbols if debug_symbols? # 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 = keg.tab Tab.clear_cache f_runtime_deps = formula.runtime_dependencies(read_from_tab: false) tab.runtime_dependencies = Tab.runtime_deps_hash(formula, f_runtime_deps) tab.write # let's reset Utils::Git.available? if we just installed git Utils::Git.clear_available_cache if formula.name == "git" # use installed ca-certificates when it's needed and available if formula.name == "ca-certificates" && !DevelopmentTools.ca_file_handles_most_https_certificates? ENV["SSL_CERT_FILE"] = ENV["GIT_SSL_CAINFO"] = formula.pkgetc/"cert.pem" ENV["GIT_SSL_CAPATH"] = formula.pkgetc end # 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" Utils::Curl.clear_path_cache end caveats ohai "Summary" if verbose? || show_summary_heading? puts summary self.class.installed << formula ensure unlock end |
#fix_dynamic_linkage(keg) ⇒ 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.
1089 1090 1091 1092 1093 1094 1095 1096 1097 |
# File 'formula_installer.rb', line 1089 def fix_dynamic_linkage(keg) keg.fix_dynamic_linkage rescue Exception => e # rubocop:disable Lint/RescueException ofail "Failed to fix install linkage" puts "The formula built, but you may encounter issues using it or linking other" puts "formulae against it." odebug e, Utils::Backtrace.clean(e) @show_summary_heading = true end |
#forbidden_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.
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 |
# File 'formula_installer.rb', line 1425 def forbidden_formula_check forbidden_formulae = Set.new(Homebrew::EnvConfig.forbidden_formulae.to_s.split) return if forbidden_formulae.blank? owner = Homebrew::EnvConfig.forbidden_owner owner_contact = if (contact = Homebrew::EnvConfig.forbidden_owner_contact.presence) "\n#{contact}" end unless ignore_deps? compute_dependencies.each do |(dep, )| dep_name = if forbidden_formulae.include?(dep.name) dep.name elsif dep.tap.present? && (dep_full_name = "#{dep.tap}/#{dep.name}") && forbidden_formulae.include?(dep_full_name) dep_full_name else next end raise CannotInstallFormulaError, <<~EOS The installation of #{formula.name} has a dependency #{dep_name} but the #{dep_name} formula was forbidden by #{owner} in `HOMEBREW_FORBIDDEN_FORMULAE`.#{owner_contact} EOS end end return if only_deps? formula_name = if forbidden_formulae.include?(formula.name) formula.name elsif forbidden_formulae.include?(formula.full_name) formula.full_name else return end raise CannotInstallFormulaError, <<~EOS The installation of #{formula_name} was forbidden by #{owner} in `HOMEBREW_FORBIDDEN_FORMULAE`.#{owner_contact} EOS end |
#forbidden_license_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.
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 |
# File 'formula_installer.rb', line 1342 def forbidden_license_check forbidden_licenses = Homebrew::EnvConfig.forbidden_licenses.to_s.dup SPDX::ALLOWED_LICENSE_SYMBOLS.each do |s| pattern = /#{s.to_s.tr("_", " ")}/i forbidden_licenses.sub!(pattern, s.to_s) end forbidden_licenses = forbidden_licenses.split.to_h do |license| [license, SPDX.license_version_info(license)] end return if forbidden_licenses.blank? owner = Homebrew::EnvConfig.forbidden_owner owner_contact = if (contact = Homebrew::EnvConfig.forbidden_owner_contact.presence) "\n#{contact}" end unless ignore_deps? compute_dependencies.each do |(dep, )| dep_f = dep.to_formula next unless SPDX.licenses_forbid_installation? dep_f.license, forbidden_licenses raise CannotInstallFormulaError, <<~EOS The installation of #{formula.name} has a dependency on #{dep.name} where all its licenses were forbidden by #{owner} in `HOMEBREW_FORBIDDEN_LICENSES`: #{SPDX.license_expression_to_string dep_f.license}.#{owner_contact} EOS end end return if only_deps? return unless SPDX.licenses_forbid_installation? formula.license, forbidden_licenses raise CannotInstallFormulaError, <<~EOS #{formula.name}'s licenses are all forbidden by #{owner} in `HOMEBREW_FORBIDDEN_LICENSES`: #{SPDX.license_expression_to_string formula.license}.#{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.
1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 |
# File 'formula_installer.rb', line 1383 def forbidden_tap_check forbidden_taps = Homebrew::EnvConfig.forbidden_taps return if forbidden_taps.blank? forbidden_taps_set = Set.new(forbidden_taps.split.filter_map do |tap| Tap.fetch(tap) rescue Tap::InvalidNameError opoo "Invalid tap name in `HOMEBREW_FORBIDDEN_TAPS`: #{tap}" nil end) owner = Homebrew::EnvConfig.forbidden_owner owner_contact = if (contact = Homebrew::EnvConfig.forbidden_owner_contact.presence) "\n#{contact}" end unless ignore_deps? compute_dependencies.each do |(dep, )| dep_tap = dep.tap next if dep_tap.blank? next unless forbidden_taps_set.include?(dep_tap) raise CannotInstallFormulaError, <<~EOS The installation of #{formula.name} has a dependency #{dep.name} but the #{dep_tap} tap was forbidden by #{owner} in `HOMEBREW_FORBIDDEN_TAPS`.#{owner_contact} EOS end end return if only_deps? formula_tap = formula.tap return if formula_tap.blank? return unless forbidden_taps_set.include?(formula_tap) raise CannotInstallFormulaError, <<~EOS The installation of #{formula.full_name} has the tap #{formula_tap} which was forbidden by #{owner} in `HOMEBREW_FORBIDDEN_TAPS`.#{owner_contact} EOS 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.
203 |
# File 'sorbet/rbi/parlour.rbi', line 203 def force?; end |
#force_bottle? ⇒ 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.
188 |
# File 'sorbet/rbi/parlour.rbi', line 188 def force_bottle?; end |
#fresh_install?(formula) ⇒ 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.
8 9 10 11 |
# File 'extend/os/mac/formula_installer.rb', line 8 def fresh_install?(formula) !Homebrew::EnvConfig.developer? && !OS::Mac.version.outdated_release? && (!installed_as_dependency? || !formula.any_version_installed?) end |
#git? ⇒ 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.
200 |
# File 'sorbet/rbi/parlour.rbi', line 200 def git?; end |
#hold_locks? ⇒ 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.
224 |
# File 'sorbet/rbi/parlour.rbi', line 224 def hold_locks?; end |
#ignore_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.
191 |
# File 'sorbet/rbi/parlour.rbi', line 191 def ignore_deps?; end |
#include_test? ⇒ 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.
137 138 139 |
# File 'formula_installer.rb', line 137 def include_test? @include_test_formulae.include?(formula.full_name) end |
#inherited_options_for(dep) ⇒ Options
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.
656 657 658 659 660 661 662 663 |
# File 'formula_installer.rb', line 656 def (dep) = Options.new u = Option.new("universal") if (.include?(u) || formula.require_universal_deps?) && !dep.build? && dep.to_formula.option_defined?(u) << u end 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.
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 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 475 476 477 478 479 480 481 482 483 484 485 |
# File 'formula_installer.rb', line 383 def install lock start_time = Time.now Homebrew::Install.perform_build_from_source_checks if !pour_bottle? && DevelopmentTools.installed? # 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, force_bottle: force_bottle?).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 UnbottledError, [formula] if !pour_bottle? && !DevelopmentTools.installed? unless ignore_deps? deps = compute_dependencies(use_cache: false) if ((pour_bottle? && !DevelopmentTools.installed?) || build_bottle?) && (unbottled = unbottled_dependencies(deps)).presence # Check that each dependency in deps has a bottle available, terminating # abnormally with a UnbottledError if one or more don't. raise UnbottledError, unbottled end install_dependencies(deps) end return if only_deps? 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 = (formula).join(" ") oh1 "Installing #{Formatter.identifier(formula.full_name)} #{}".strip if show_header? if (tap = formula.tap) && tap.should_report_analytics? Utils::Analytics.report_package_event(:formula_install, package_name: formula.name, tap_name: tap.name, on_request: installed_on_request?, options:) end self.class.attempted << formula if pour_bottle? begin pour rescue Exception # 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 else @poured_bottle = true end end 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.mkpath Pathname(brew_prefix/"#{formula.name}.rb").atomic_write(s) keg = Keg.new(formula.prefix) tab = keg.tab 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..package_installed(formula.name, end_time - start_time) end |
#install_bottle_for?(dep, build) ⇒ 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.
190 191 192 193 194 195 196 197 198 |
# File 'formula_installer.rb', line 190 def install_bottle_for?(dep, build) return pour_bottle? if dep == formula @build_from_source_formulae.exclude?(dep.full_name) && dep.bottle.present? && dep.pour_bottle? && build..empty? && dep.bottle&.compatible_locations? end |
#install_dependencies(deps) ⇒ 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.
666 667 668 669 670 671 672 673 674 675 676 677 |
# File 'formula_installer.rb', line 666 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.identifier(_1) }.to_sentence}", truncate: false deps.each { |dep, | install_dependency(dep, ) } end @show_header = true unless deps.empty? end |
#install_dependency(dep, inherited_options) ⇒ 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.
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'formula_installer.rb', line 705 def install_dependency(dep, ) df = dep.to_formula if df.linked_keg.directory? linked_keg = Keg.new(df.linked_keg.resolved_path) tab = linked_keg.tab 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) tab ||= installed_keg.tab tmp_keg = Pathname.new("#{installed_keg}.tmp") installed_keg.rename(tmp_keg) end if df.tap.present? && tab.present? && (tab_tap = tab.source["tap"].presence) && df.tap.to_s != tab_tap.to_s odie <<~EOS #{df} is already installed from #{tab_tap}! Please `brew uninstall #{df}` first." EOS end = Options.new |= tab. if tab.present? |= Tab.(df., dep.) |= &= df. fi = FormulaInstaller.new( df, options:, link_keg: keg_had_linked_keg ? keg_was_linked : nil, installed_as_dependency: true, installed_on_request: df.any_version_installed? && tab.present? && tab.installed_on_request, force_bottle: false, include_test_formulae: @include_test_formulae, build_from_source_formulae: @build_from_source_formulae, keep_tmp: keep_tmp?, debug_symbols: debug_symbols?, force: force?, debug: debug?, quiet: quiet?, verbose: verbose?, ) 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.to_path) if tmp_keg && !installed_keg.directory? linked_keg.link(verbose: verbose?) 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_fetch_deps ⇒ 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 361 362 363 364 365 366 367 368 |
# File 'formula_installer.rb', line 358 def install_fetch_deps return if @compute_dependencies.blank? compute_dependencies(use_cache: false) if @compute_dependencies.any? do |dep, | next false unless dep.implicit? fetch_dependencies install_dependency(dep, ) true end end |
#install_service ⇒ 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.
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 |
# File 'formula_installer.rb', line 1051 def install_service if formula.service? && formula.plist ofail "Formula specified both service and plist" return end if formula.service? && formula.service.command? service_path = formula.systemd_service_path service_path.atomic_write(formula.service.to_systemd_unit) service_path.chmod 0644 if formula.service.timed? timer_path = formula.systemd_timer_path timer_path.atomic_write(formula.service.to_systemd_timer) timer_path.chmod 0644 end end service = if formula.service? && formula.service.command? formula.service.to_plist elsif formula.plist formula.plist end return unless service launchd_service_path = formula.launchd_service_path launchd_service_path.atomic_write(service) launchd_service_path.chmod 0644 log = formula.var/"log" log.mkpath if service.include? log.to_s rescue Exception => e # rubocop:disable Lint/RescueException puts e ofail "Failed to install service files" odebug e, Utils::Backtrace.clean(e) 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.
176 |
# File 'sorbet/rbi/parlour.rbi', line 176 def installed_as_dependency?; end |
#installed_on_request? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
179 |
# File 'sorbet/rbi/parlour.rbi', line 179 def installed_on_request?; end |
#interactive? ⇒ 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.
197 |
# File 'sorbet/rbi/parlour.rbi', line 197 def interactive?; end |
#keep_tmp? ⇒ 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.
209 |
# File 'sorbet/rbi/parlour.rbi', line 209 def keep_tmp?; end |
#link(keg) ⇒ 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.
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 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 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 |
# File 'formula_installer.rb', line 964 def link(keg) Formula.clear_cache unless link_keg begin keg.optlink(verbose: verbose?, overwrite: overwrite?) rescue Keg::LinkError => e ofail "Failed to create #{formula.opt_prefix}" puts "Things that depend on #{formula.full_name} will probably not build." puts e 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 Homebrew::Unlink.unlink_versioned_formulae(formula, verbose: verbose?) link_overwrite_backup = {} # Hash: conflict file -> backup file backup_dir = HOMEBREW_CACHE/"Backup" begin keg.link(verbose: verbose?, overwrite: overwrite?) 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 ofail "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:" keg.link(dry_run: true, overwrite: true, verbose: verbose?) @show_summary_heading = true rescue Keg::LinkError => e ofail "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 rescue Exception => e # rubocop:disable Lint/RescueException ofail "An unexpected error occurred during the `brew link` step" puts "The formula built, but is not symlinked into #{HOMEBREW_PREFIX}" puts e puts Utils::Backtrace.clean(e) 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 raise end return if link_overwrite_backup.empty? opoo "These files were overwritten during the `brew link` step:" puts link_overwrite_backup.keys puts puts "They have been backed up to: #{backup_dir}" @show_summary_heading = true end |
#only_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.
194 |
# File 'sorbet/rbi/parlour.rbi', line 194 def only_deps?; end |
#overwrite? ⇒ 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.
206 |
# File 'sorbet/rbi/parlour.rbi', line 206 def overwrite?; end |
#post_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.
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 |
# File 'formula_installer.rb', line 1142 def post_install args = [ "nice", *HOMEBREW_RUBY_EXEC_ARGS, "-I", $LOAD_PATH.join(File::PATH_SEPARATOR), "--", HOMEBREW_LIBRARY_PATH/"postinstall.rb" ] args << post_install_formula_path Utils.safe_fork do |error_pipe| 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) sandbox.deny_all_network_except_pipe(error_pipe) unless formula.network_access_allowed?(:postinstall) 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:" puts " brew postinstall #{formula.full_name}" odebug e, Utils::Backtrace.clean(e), always_display: Homebrew::EnvConfig.developer? Homebrew.failed = true @show_summary_heading = true end |
#post_install_formula_path ⇒ Pathname
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 |
# File 'formula_installer.rb', line 1112 def post_install_formula_path # Use the formula from the keg when any of the following is true: # * We're installing from the JSON API # * We're installing a local bottle file # * The formula doesn't exist in the tap (or the tap isn't installed) # * The formula in the tap has a different `pkg_version``. # # In all other cases, including if the formula from the keg is unreadable # (third-party taps may `require` some of their own libraries) or if there # is no formula present in the keg (as is the case with very old bottles), # use the formula from the tap. keg_formula_path = formula.opt_prefix/".brew/#{formula.name}.rb" return keg_formula_path if formula.loaded_from_api? return keg_formula_path if formula.local_bottle_path.present? tap_formula_path = formula.specified_path return keg_formula_path unless tap_formula_path.exist? begin keg_formula = Formulary.factory(keg_formula_path) tap_formula = Formulary.factory(tap_formula_path) return keg_formula_path if keg_formula.pkg_version != tap_formula.pkg_version tap_formula_path rescue FormulaUnavailableError, FormulaUnreadableError tap_formula_path end end |
#pour ⇒ 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.
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 |
# File 'formula_installer.rb', line 1259 def pour if Homebrew::EnvConfig.verify_attestations? && formula.tap&.core_tap? ohai "Verifying attestation for #{formula.name}" begin Homebrew::Attestation.check_core_attestation formula.bottle rescue Homebrew::Attestation::InvalidAttestationError => e raise CannotInstallFormulaError, <<~EOS The bottle for #{formula.name} has an invalid build provenance attestation. This may indicate that the bottle was not produced by the expected tap, or was maliciously inserted into the expected tap's bottle storage. Additional context: #{e} EOS end end HOMEBREW_CELLAR.cd do downloader.stage end Tab.clear_cache tab = Utils::Bottles.load_tab(formula) # fill in missing/outdated parts of the tab # keep in sync with Tab#to_bottle_hash tab. = [] tab. = [] tab.built_as_bottle = true tab.poured_from_bottle = true tab.loaded_from_api = formula.loaded_from_api? tab.installed_as_dependency = installed_as_dependency? tab.installed_on_request = installed_on_request? tab.time = Time.now.to_i tab.aliases = formula.aliases tab.arch = Hardware::CPU.arch tab.source["versions"]["stable"] = formula.stable.version&.to_s tab.source["versions"]["version_scheme"] = formula.version_scheme tab.source["path"] = formula.specified_path.to_s tab.source["tap_git_head"] = formula.tap&.installed? ? formula.tap&.git_head : nil tab.tap = formula.tap tab.write keg = Keg.new(formula.prefix) skip_linkage = formula.bottle_specification.skip_relocation? keg.replace_placeholders_with_locations(tab.changed_files, skip_linkage:) cellar = formula.bottle_specification.tag_to_cellar(Utils::Bottles.tag) return if [:any, :any_skip_relocation].include?(cellar) prefix = Pathname(cellar).parent.to_s return if cellar == HOMEBREW_CELLAR.to_s && prefix == HOMEBREW_PREFIX.to_s return unless ENV["HOMEBREW_RELOCATE_BUILD_PREFIX"] keg.relocate_build_prefix(keg, prefix, HOMEBREW_PREFIX) end |
#pour_bottle?(output_warning: false) ⇒ 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.
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 180 181 182 183 184 185 186 187 |
# File 'formula_installer.rb', line 152 def pour_bottle?(output_warning: false) return false if !formula.bottle_tag? && !formula.local_bottle_path return true if force_bottle? return false if build_from_source? || build_bottle? || interactive? return false if @cc return false unless .empty? unless formula.pour_bottle? if output_warning && 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 return true if formula.local_bottle_path.present? bottle = formula.bottle_for_tag(Utils::Bottles.tag) return false if bottle.nil? unless bottle.compatible_locations? if output_warning prefix = Pathname(bottle.cellar.to_s).parent opoo <<~EOS Building #{formula.full_name} from source as the bottle needs: - HOMEBREW_CELLAR: #{bottle.cellar} (yours is #{HOMEBREW_CELLAR}) - HOMEBREW_PREFIX: #{prefix} (yours is #{HOMEBREW_PREFIX}) EOS end return false end true end |
#prelude ⇒ void
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
This method returns an undefined value.
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'formula_installer.rb', line 201 def prelude deprecate_disable_type = DeprecateDisable.type(formula) if deprecate_disable_type.present? = "#{formula.full_name} has been #{DeprecateDisable.(formula)}" case deprecate_disable_type when :deprecated puts "::warning::#{}" if ENV["GITHUB_ACTIONS"] opoo when :disabled puts "::error::#{}" if ENV["GITHUB_ACTIONS"] raise CannotInstallFormulaError, end end Tab.clear_cache verify_deps_exist unless ignore_deps? forbidden_license_check forbidden_tap_check forbidden_formula_check check_install_sanity install_fetch_deps unless ignore_deps? end |
#previously_fetched_formula ⇒ Formula?
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.
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 |
# File 'formula_installer.rb', line 1200 def previously_fetched_formula # We intentionally don't compare classes here: # from-API-JSON and from-source formula classes are not equal but we # want to equate them to be the same thing here given mixing bottle and # from-source installs of the same formula within the same operation # doesn't make sense. self.class.fetched.find do |fetched_formula| fetched_formula.full_name == formula.full_name && fetched_formula.active_spec_sym == formula.active_spec_sym end end |
#problem_if_output(output) ⇒ 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.
1322 1323 1324 1325 1326 1327 |
# File 'formula_installer.rb', line 1322 def problem_if_output(output) return unless output opoo output @show_summary_heading = true end |
#quiet? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
221 |
# File 'sorbet/rbi/parlour.rbi', line 221 def quiet?; end |
#runtime_requirements(formula) ⇒ 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.
561 562 563 564 565 566 567 |
# File 'formula_installer.rb', line 561 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_options ⇒ Array<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.
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 |
# File 'formula_installer.rb', line 872 def args = [] args << "--ignore-dependencies" if ignore_deps? if build_bottle? args << "--build-bottle" args << "--bottle-arch=#{@bottle_arch}" if @bottle_arch end args << "--git" if git? args << "--interactive" if interactive? args << "--verbose" if verbose? args << "--debug" if debug? args << "--cc=#{@cc}" if @cc args << "--keep-tmp" if keep_tmp? if debug_symbols? args << "--debug-symbols" args << "--build-from-source" end if @env.present? args << "--env=#{@env}" elsif formula.env.std? || formula.deps.select(&:build?).any? { |d| d.name == "scons" } args << "--env=std" end args << "--HEAD" if formula.head? args end |
#show_header? ⇒ 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.
185 |
# File 'sorbet/rbi/parlour.rbi', line 185 def show_header?; end |
#show_summary_heading? ⇒ 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.
182 |
# File 'sorbet/rbi/parlour.rbi', line 182 def show_summary_heading?; end |
#skip_post_install? ⇒ 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.
147 148 149 |
# File 'formula_installer.rb', line 147 def skip_post_install? @skip_post_install.present? 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.
859 860 861 862 863 864 865 |
# File 'formula_installer.rb', line 859 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 |
#unbottled_dependencies(deps) ⇒ 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.
529 530 531 532 533 534 535 |
# File 'formula_installer.rb', line 529 def unbottled_dependencies(deps) deps.map { |(dep, )| dep.to_formula }.reject do |dep_f| next false unless dep_f.pour_bottle? dep_f.bottled? end end |
#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.
215 |
# File 'sorbet/rbi/parlour.rbi', line 215 def verbose?; end |
#verify_deps_exist ⇒ 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.
229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'formula_installer.rb', line 229 def verify_deps_exist begin compute_dependencies rescue TapFormulaUnavailableError => e raise if e.tap.installed? e.tap.ensure_installed! retry if e.tap.installed? # It may have not installed if it's a core tap. end rescue FormulaUnavailableError => e e.dependent = formula.full_name raise end |