Top Level Namespace

Defined Under Namespace

Modules: ArchitectureListExtension, Cachable, Cask, CleanupRefinement, Commands, Debrew, Dependable, DiskUsageExtension, ELFShim, Emoji, EnvActivation, Formatter, FormulaCellarChecks, FormulaClassUnavailableErrorModule, FormulaUnreadableErrorModule, Formulary, Git, GitHub, GitRepositoryExtension, Hardware, HashValidator, Homebrew, HomebrewArgvExtension, IRB, InstallRenamed, Kernel, Language, MachOShim, Metafiles, OS, Patch, Predicable, Readall, RuboCop, Searchable, SharedEnvExtension, StringInreplaceExtension, Superenv, Tty, UnpackStrategy, Utils Classes: AbstractDownloadStrategy, AbstractFileDownloadStrategy, ArchRequirement, BazaarDownloadStrategy, Bottle, BottleDisableReason, BottleFormulaUnavailableError, BottlePublisher, BottleSpecification, Build, BuildEnvironment, BuildError, BuildFlagsError, BuildOptions, BuildToolsError, CVSDownloadStrategy, CacheStore, CacheStoreDatabase, CannotInstallFormulaError, CaskLock, Caveats, Checksum, ChecksumMismatchError, ChecksumMissingError, ChildProcessError, Cleaner, CodesignRequirement, CompilerFailure, CompilerSelectionError, CompilerSelector, CoreTap, CurlApacheMirrorDownloadStrategy, CurlDownloadStrategy, CurlDownloadStrategyError, CurlPostDownloadStrategy, CxxStdlib, DATAPatch, Dependencies, Dependency, DependencyCollector, DeprecatedOption, DescriptionCacheStore, Descriptions, DownloadError, DownloadStrategyDetector, DuplicateResourceError, EmbeddedPatch, ErrorDuringExecution, ExternalPatch, Formula, FormulaAmbiguousPythonError, FormulaClassUnavailableError, FormulaConflict, FormulaConflictError, FormulaInfo, FormulaInstallationAlreadyAttemptedError, FormulaInstaller, FormulaLock, FormulaPin, FormulaSpecificationError, FormulaUnavailableError, FormulaUnreadableError, FormulaUnspecifiedError, FormulaValidationError, FormulaVersions, FossilDownloadStrategy, GitDownloadStrategy, GitHubGitDownloadStrategy, HeadSoftwareSpec, HeadVersion, IO, JavaRequirement, Keg, KegOnlyReason, KegUnspecifiedError, LazyObject, LegacyPatch, LinkageCacheStore, LinkageChecker, LinuxRequirement, LocalBottleDownloadStrategy, Locale, LockFile, MacOSRequirement, MercurialDownloadStrategy, Messages, MethodDeprecatedError, Migrator, MissingApplyError, MissingEnvironmentVariables, Mktemp, Module, MultipleVersionsInstalledError, NilClass, NoSuchKegError, NoUnzipCurlDownloadStrategy, NotAKegError, OperationInProgressError, Option, Options, OsxfuseRequirement, PATH, Pathname, PkgVersion, PourBottleCheck, PrettyListing, Reporter, ReporterHub, Requirement, Requirements, Resource, ResourceMissingError, ResourceStageContext, Sandbox, SoftwareSpec, String, StringPatch, SubversionDownloadStrategy, Symbol, SystemCommand, SystemConfig, Tab, Tap, TapAlreadyTappedError, TapAlreadyUnshallowError, TapConfig, TapDependency, TapFormulaAmbiguityError, TapFormulaClassUnavailableError, TapFormulaUnavailableError, TapFormulaUnreadableError, TapFormulaWithOldnameAmbiguityError, TapPinStatusError, TapRemoteMismatchError, TapUnavailableError, TuntapRequirement, URL, UnsatisfiedRequirements, UsageError, User, VCSDownloadStrategy, Version, X11Requirement, XcodeRequirement

Constant Summary collapse

HOMEBREW_HELP =
<<~EOS
  Example usage:
    brew search [TEXT|/REGEX/]
    brew info [FORMULA...]
    brew install FORMULA...
    brew update
    brew upgrade [FORMULA...]
    brew uninstall FORMULA...
    brew list [FORMULA...]

  Troubleshooting:
    brew config
    brew doctor
    brew install --verbose --debug FORMULA

  Contributing:
    brew create [URL [--no-fetch]]
    brew edit [FORMULA...]

  Further help:
    brew commands
    brew help [COMMAND]
    man brew
    https://docs.brew.sh
EOS
TEST_TIMEOUT_SECONDS =
5 * 60
HOMEBREW_BREW_FILE =

Path to bin/brew main executable in HOMEBREW_PREFIX

Pathname.new(ENV["HOMEBREW_BREW_FILE"]).freeze
HOMEBREW_PREFIX =

Where we link under

Pathname.new(get_env_or_raise("HOMEBREW_PREFIX")).freeze
HOMEBREW_REPOSITORY =

Where .git is found

Pathname.new(get_env_or_raise("HOMEBREW_REPOSITORY"))
.extend(GitRepositoryExtension)
.freeze
HOMEBREW_LIBRARY =

Where we store most of Homebrew, taps, and various metadata

Pathname.new(get_env_or_raise("HOMEBREW_LIBRARY")).freeze
HOMEBREW_SHIMS_PATH =

Where shim scripts for various build and SCM tools are stored

(HOMEBREW_LIBRARY/"Homebrew/shims").freeze
HOMEBREW_LINKED_KEGS =

Where we store symlinks to currently linked kegs

(HOMEBREW_PREFIX/"var/homebrew/linked").freeze
HOMEBREW_PINNED_KEGS =

Where we store symlinks to currently version-pinned kegs

(HOMEBREW_PREFIX/"var/homebrew/pinned").freeze
HOMEBREW_LOCKS =

Where we store lock files

(HOMEBREW_PREFIX/"var/homebrew/locks").freeze
HOMEBREW_CELLAR =

Where we store built products

Pathname.new(get_env_or_raise("HOMEBREW_CELLAR")).freeze
HOMEBREW_CACHE =

Where downloads (bottles, source tarballs, etc.) are cached

Pathname.new(get_env_or_raise("HOMEBREW_CACHE")).freeze
HOMEBREW_CACHE_FORMULA =

Where brews installed via URL are cached

(HOMEBREW_CACHE/"Formula").freeze
HOMEBREW_LOGS =

Where build, postinstall, and test logs of formulae are written to

Pathname.new(get_env_or_raise("HOMEBREW_LOGS")).expand_path.freeze
HOMEBREW_TEMP =

Must use /tmp instead of TMPDIR because long paths break Unix domain sockets

begin
  tmp = Pathname.new(get_env_or_raise("HOMEBREW_TEMP"))
  tmp.mkpath unless tmp.exist?
  tmp.realpath
end.freeze
ARGV_WITHOUT_MONKEY_PATCHING =
ARGV.dup.freeze
HOMEBREW_PRODUCT =
ENV["HOMEBREW_PRODUCT"]
HOMEBREW_VERSION =
ENV["HOMEBREW_VERSION"]
HOMEBREW_WWW =
"https://brew.sh"
RUBY_PATH =
Pathname.new(RbConfig.ruby).freeze
RUBY_BIN =
RUBY_PATH.dirname.freeze
HOMEBREW_USER_AGENT_CURL =
ENV["HOMEBREW_USER_AGENT_CURL"]
HOMEBREW_USER_AGENT_RUBY =
"#{ENV["HOMEBREW_USER_AGENT"]} ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
HOMEBREW_USER_AGENT_FAKE_SAFARI =
"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/602.4.8 " \
"(KHTML, like Gecko) Version/10.0.3 Safari/602.4.8"
HOMEBREW_BOTTLE_DEFAULT_DOMAIN =
ENV["HOMEBREW_BOTTLE_DEFAULT_DOMAIN"]
HOMEBREW_BOTTLE_DOMAIN =
ENV["HOMEBREW_BOTTLE_DOMAIN"]
HOMEBREW_PULL_API_REGEX =
%r{https://api\.github\.com/repos/([\w-]+)/([\w-]+)?/pulls/(\d+)}.freeze
HOMEBREW_PULL_OR_COMMIT_URL_REGEX =
%r[https://github\.com/([\w-]+)/([\w-]+)?/(?:pull/(\d+)|commit/[0-9a-fA-F]{4,40})].freeze
ORIGINAL_PATHS =
PATH.new(ENV["HOMEBREW_PATH"]).map do |p|
  begin
    Pathname.new(p).expand_path
  rescue
    nil
  end
end.compact.freeze
HOMEBREW_INTERNAL_COMMAND_ALIASES =
{
  "ls"          => "list",
  "homepage"    => "home",
  "-S"          => "search",
  "up"          => "update",
  "ln"          => "link",
  "instal"      => "install", # gem does the same
  "uninstal"    => "uninstall",
  "rm"          => "uninstall",
  "remove"      => "uninstall",
  "configure"   => "diy",
  "abv"         => "info",
  "dr"          => "doctor",
  "--repo"      => "--repository",
  "environment" => "--env",
  "--config"    => "config",
  "-v"          => "--version",
}.freeze
CLEANUP_DEFAULT_DAYS =
30
CLEANUP_MAX_AGE_DAYS =
120
HOMEBREW_LIBRARY_PATH =
Pathname(__dir__).realpath.freeze
BUG_REPORTS_URL =
"https://github.com/Homebrew/homebrew-cask#reporting-bugs"
COMMAND_DESC_WIDTH =
80
OPTION_DESC_WIDTH =
43
OFFICIAL_CASK_TAPS =
%w[
  cask
  versions
].freeze
OFFICIAL_CMD_TAPS =
{
  "homebrew/bundle"   => ["bundle"],
  "homebrew/test-bot" => ["test-bot"],
  "homebrew/services" => ["services"],
}.freeze
DEPRECATED_OFFICIAL_TAPS =
%w[
  apache
  binary
  completions
  devel-only
  dupes
  emacs
  fuse
  games
  gui
  head-only
  nginx
  php
  python
  science
  tex
  versions
  x11
].freeze
HOMEBREW_TAP_FORMULA_REGEX =

match taps’ formulae, e.g. someuser/sometap/someformula

%r{^([\w-]+)/([\w-]+)/([\w+-.@]+)$}.freeze
HOMEBREW_TAP_CASK_REGEX =

match taps’ casks, e.g. someuser/sometap/somecask

%r{^([\w-]+)/([\w-]+)/([a-z0-9\-]+)$}.freeze
HOMEBREW_TAP_DIR_REGEX =

match taps’ directory paths, e.g. HOMEBREW_LIBRARY/Taps/someuser/sometap

%r{#{Regexp.escape(HOMEBREW_LIBRARY)}/Taps/(?<user>[\w-]+)/(?<repo>[\w-]+)}.freeze
HOMEBREW_TAP_PATH_REGEX =

match taps’ formula paths, e.g. HOMEBREW_LIBRARY/Taps/someuser/sometap/someformula

Regexp.new(HOMEBREW_TAP_DIR_REGEX.source + %r{(?:/.*)?$}.source).freeze
HOMEBREW_CASK_TAP_CASK_REGEX =

match official taps’ casks, e.g. homebrew/cask/somecask or homebrew/cask-versions/somecask

%r{^(?:([Cc]askroom)/(cask|versions)|(homebrew)/(cask|cask-[\w-]+))/([\w+-.]+)$}.freeze
HOMEBREW_OFFICIAL_REPO_PREFIXES_REGEX =
/^(home|linux)brew-/.freeze
BOTTLE_ERB =
<<-EOS.freeze
  bottle do
    <% if !root_url.start_with?(HOMEBREW_BOTTLE_DEFAULT_DOMAIN) %>
    root_url "<%= root_url %>"
    <% end %>
    <% if ![Homebrew::DEFAULT_PREFIX, "/usr/local"].include?(prefix) %>
    prefix "<%= prefix %>"
    <% end %>
    <% if cellar.is_a? Symbol %>
    cellar :<%= cellar %>
    <% elsif ![Homebrew::DEFAULT_CELLAR, "/usr/local/Cellar"].include?(cellar) %>
    cellar "<%= cellar %>"
    <% end %>
    <% if rebuild.positive? %>
    rebuild <%= rebuild %>
    <% end %>
    <% checksums.each do |checksum_type, checksum_values| %>
    <% checksum_values.each do |checksum_value| %>
    <% checksum, macos = checksum_value.shift %>
    <%= checksum_type %> "<%= checksum %>" => :<%= macos %><%= "_or_later" if Homebrew.args.or_later? %>
    <% end %>
    <% end %>
  end
EOS
MAXIMUM_STRING_MATCHES =
100
PYTHON_VIRTUALENV_URL =
"https://files.pythonhosted.org/packages/11/74" \
"/2c151a13ef41ab9fb43b3c4ff9e788e0496ed7923b2078d42cab30622bdf" \
"/virtualenv-16.7.4.tar.gz"
PYTHON_VIRTUALENV_SHA256 =
"94a6898293d07f84a98add34c4df900f8ec64a570292279f6d91c781d37fd305"

Instance Method Summary collapse

Methods included from EnvActivation

activate_extensions!, clear_sensitive_environment!, sensitive?, sensitive_environment, with_build_environment

Methods included from HomebrewArgvExtension

bottle_arch, build_bottle?, build_formula_from_source?, build_from_source?, build_stable?, build_universal?, casks, cc, collect_build_flags, debug?, env, fetch_head?, flag?, flags_only, force?, force_bottle?, formulae, git?, homebrew_developer?, ignore_deps?, interactive?, keep_tmp?, kegs, named, no_sandbox?, options_only, quieter?, resolved_formulae, skip_or_later_bottles?, value, verbose?

Instance Method Details

#curl(*args, secrets: [], **options) ⇒ Object



45
46
47
48
49
50
51
52
53
# File 'brew/Library/Homebrew/utils/curl.rb', line 45

def curl(*args, secrets: [], **options)
  # SSL_CERT_FILE can be incorrectly set by users or portable-ruby and screw
  # with SSL downloads so unset it here.
  system_command! curl_executable,
                  args:         curl_args(*args, **options),
                  print_stdout: true,
                  env:          { "SSL_CERT_FILE" => nil },
                  secrets:      secrets
end

#curl_args(*extra_args, show_output: false, user_agent: :default) ⇒ Object



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'brew/Library/Homebrew/utils/curl.rb', line 16

def curl_args(*extra_args, show_output: false, user_agent: :default)
  args = []

  # do not load .curlrc unless requested (must be the first argument)
  args << "-q" unless ENV["HOMEBREW_CURLRC"]

  args << "--show-error"

  args << "--user-agent" << case user_agent
  when :browser, :fake
    HOMEBREW_USER_AGENT_FAKE_SAFARI
  when :default
    HOMEBREW_USER_AGENT_CURL
  else
    user_agent
  end

  unless show_output
    args << "--fail"
    args << "--progress-bar" unless ARGV.verbose?
    args << "--verbose" if ENV["HOMEBREW_CURL_VERBOSE"]
    args << "--silent" unless $stdout.tty?
  end

  args << "--retry" << ENV["HOMEBREW_CURL_RETRIES"] if ENV["HOMEBREW_CURL_RETRIES"]

  args + extra_args
end

#curl_check_http_content(url, user_agents: [:default], check_content: false, strict: false) ⇒ Object



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'brew/Library/Homebrew/utils/curl.rb', line 88

def curl_check_http_content(url, user_agents: [:default], check_content: false, strict: false)
  return unless url.start_with? "http"

  details = nil
  user_agent = nil
  hash_needed = url.start_with?("http:")
  user_agents.each do |ua|
    details = curl_http_content_headers_and_checksum(url, hash_needed: hash_needed, user_agent: ua)
    user_agent = ua
    break if details[:status].to_s.start_with?("2")
  end

  unless details[:status]
    # Hack around https://github.com/Homebrew/brew/issues/3199
    return if MacOS.version == :el_capitan

    return "The URL #{url} is not reachable"
  end

  unless details[:status].start_with? "2"
    return "The URL #{url} is not reachable (HTTP status code #{details[:status]})"
  end

  if url.start_with?("https://") && ENV["HOMEBREW_NO_INSECURE_REDIRECT"] &&
     !details[:final_url].start_with?("https://")
    return "The URL #{url} redirects back to HTTP"
  end

  return unless hash_needed

  secure_url = url.sub "http", "https"
  secure_details =
    curl_http_content_headers_and_checksum(secure_url, hash_needed: true, user_agent: user_agent)

  if !details[:status].to_s.start_with?("2") ||
     !secure_details[:status].to_s.start_with?("2")
    return
  end

  etag_match = details[:etag] &&
               details[:etag] == secure_details[:etag]
  content_length_match =
    details[:content_length] &&
    details[:content_length] == secure_details[:content_length]
  file_match = details[:file_hash] == secure_details[:file_hash]

  if (etag_match || content_length_match || file_match) &&
     secure_details[:final_url].start_with?("https://") &&
     url.start_with?("http://")
    return "The URL #{url} should use HTTPS rather than HTTP"
  end

  return unless check_content

  no_protocol_file_contents = %r{https?:\\?/\\?/}
  details[:file] = details[:file].gsub(no_protocol_file_contents, "/")
  secure_details[:file] = secure_details[:file].gsub(no_protocol_file_contents, "/")

  # Check for the same content after removing all protocols
  if (details[:file] == secure_details[:file]) &&
     secure_details[:final_url].start_with?("https://") &&
     url.start_with?("http://")
    return "The URL #{url} should use HTTPS rather than HTTP"
  end

  return unless strict

  # Same size, different content after normalization
  # (typical causes: Generated ID, Timestamp, Unix time)
  if details[:file].length == secure_details[:file].length
    return "The URL #{url} may be able to use HTTPS rather than HTTP. Please verify it in a browser."
  end

  lenratio = (100 * secure_details[:file].length / details[:file].length).to_i
  return unless (90..110).cover?(lenratio)

  "The URL #{url} may be able to use HTTPS rather than HTTP. Please verify it in a browser."
end

#curl_download(*args, to: nil, **options) ⇒ Object



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
# File 'brew/Library/Homebrew/utils/curl.rb', line 55

def curl_download(*args, to: nil, **options)
  destination = Pathname(to)
  destination.dirname.mkpath

  range_stdout = curl_output("--location", "--range", "0-1",
                             "--dump-header", "-",
                             "--write-out", "%{http_code}",
                             "--output", "/dev/null", *args, **options).stdout
  headers, _, http_status = range_stdout.partition("\r\n\r\n")

  supports_partial_download = http_status.to_i == 206 # Partial Content
  if supports_partial_download &&
     destination.exist? &&
     destination.size == %r{^.*Content-Range: bytes \d+-\d+/(\d+)\r\n.*$}m.match(headers)&.[](1)&.to_i
    return # We've already downloaded all the bytes
  end

  continue_at = if destination.exist? && supports_partial_download
    "-"
  else
    0
  end

  curl("--location", "--remote-time", "--continue-at", continue_at.to_s, "--output", destination, *args, **options)
end

#curl_executableObject



5
6
7
8
9
10
11
12
13
14
# File 'brew/Library/Homebrew/utils/curl.rb', line 5

def curl_executable
  @curl ||= [
    ENV["HOMEBREW_CURL"],
    which("curl"),
    "/usr/bin/curl",
  ].compact.map { |c| Pathname(c) }.find(&:executable?)
  raise "no executable curl was found" unless @curl

  @curl
end

#curl_http_content_headers_and_checksum(url, hash_needed: false, user_agent: :default) ⇒ Object



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'brew/Library/Homebrew/utils/curl.rb', line 167

def curl_http_content_headers_and_checksum(url, hash_needed: false, user_agent: :default)
  max_time = hash_needed ? "600" : "25"
  output, = curl_output(
    "--connect-timeout", "15", "--include", "--max-time", max_time, "--location", url,
    user_agent: user_agent
  )

  status_code = :unknown
  while status_code == :unknown || status_code.to_s.start_with?("3")
    headers, _, output = output.partition("\r\n\r\n")
    status_code = headers[%r{HTTP\/.* (\d+)}, 1]
    final_url = headers[/^Location:\s*(.*)$/i, 1]&.chomp
  end

  output_hash = Digest::SHA256.digest(output) if hash_needed

  final_url ||= url

  {
    url:            url,
    final_url:      final_url,
    status:         status_code,
    etag:           headers[%r{ETag: ([wW]\/)?"(([^"]|\\")*)"}, 2],
    content_length: headers[/Content-Length: (\d+)/, 1],
    file_hash:      output_hash,
    file:           output,
  }
end

#curl_output(*args, secrets: [], **options) ⇒ Object



81
82
83
84
85
86
# File 'brew/Library/Homebrew/utils/curl.rb', line 81

def curl_output(*args, secrets: [], **options)
  system_command curl_executable,
                 args:         curl_args(*args, show_output: true, **options),
                 print_stderr: false,
                 secrets:      secrets
end

#get_env_or_raise(env) ⇒ Object



10
11
12
13
14
# File 'brew/Library/Homebrew/config.rb', line 10

def get_env_or_raise(env)
  raise MissingEnvironmentVariables, "#{env} was not exported!" unless ENV[env]

  ENV[env]
end

#superenv?Boolean

Returns:

  • (Boolean)


8
9
10
# File 'brew/Library/Homebrew/extend/ENV.rb', line 8

def superenv?
  ARGV.env != "std" && Superenv.bin
end

#with_monkey_patchObject



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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
# File 'brew/Library/Homebrew/dev-cmd/extract.rb', line 8

def with_monkey_patch
  BottleSpecification.class_eval do
    alias_method :old_method_missing, :method_missing if method_defined?(:method_missing)
    define_method(:method_missing) { |*| }
  end

  Module.class_eval do
    alias_method :old_method_missing, :method_missing if method_defined?(:method_missing)
    define_method(:method_missing) { |*| }
  end

  Resource.class_eval do
    alias_method :old_method_missing, :method_missing if method_defined?(:method_missing)
    define_method(:method_missing) { |*| }
  end

  DependencyCollector.class_eval do
    alias_method :old_parse_symbol_spec, :parse_symbol_spec if method_defined?(:parse_symbol_spec)
    define_method(:parse_symbol_spec) { |*| }
  end

  if defined?(DependencyCollector::Compat)
    DependencyCollector::Compat.class_eval do
      alias_method :old_parse_string_spec, :parse_string_spec if method_defined?(:parse_string_spec)
      define_method(:parse_string_spec) { |*| }
    end
  end

  yield
ensure
  BottleSpecification.class_eval do
    if method_defined?(:old_method_missing)
      alias_method :method_missing, :old_method_missing
      undef :old_method_missing
    end
  end

  Module.class_eval do
    if method_defined?(:old_method_missing)
      alias_method :method_missing, :old_method_missing
      undef :old_method_missing
    end
  end

  Resource.class_eval do
    if method_defined?(:old_method_missing)
      alias_method :method_missing, :old_method_missing
      undef :old_method_missing
    end
  end

  DependencyCollector.class_eval do
    if method_defined?(:old_parse_symbol_spec)
      alias_method :parse_symbol_spec, :old_parse_symbol_spec
      undef :old_parse_symbol_spec
    end
  end

  if defined?(DependencyCollector::Compat)
    DependencyCollector::Compat.class_eval do
      if method_defined?(:old_parse_string_spec)
        alias_method :parse_string_spec, :old_parse_string_spec
        undef :old_parse_string_spec
      end
    end
  end
end