Class: Keg Private

Inherits:
Object show all
Extended by:
Cachable, Forwardable
Includes:
OS::Mac::Keg, Utils::Output::Mixin
Defined in:
extend/os/linux/keg.rb,
extend/os/linux/keg_relocate.rb,
keg.rb,
os/mac/keg.rb,
keg_relocate.rb,
keg.rbi,
sorbet/rbi/dsl/keg.rbi

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.

Defined Under Namespace

Classes: AlreadyLinkedError, ConflictError, DirectoryNotWritableError, LinkError, Relocation

Constant Summary collapse

LOCALEDIR_RX =

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

Locale-specific directories have the form language[_territory][.codeset][@modifier]

%r{(locale|man)/([a-z]{2}|C|POSIX)(_[A-Z]{2})?(\.[a-zA-Z\-0-9]+(@.+)?)?}
INFOFILE_RX =

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

%r{info/([^.].*?\.info(\.gz)?|dir)$}
SHARE_PATHS =

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

These paths relative to the keg's share directory should always be real directories in the prefix, never symlinks.

%w[
  aclocal doc info java locale man
  man/man1 man/man2 man/man3 man/man4
  man/man5 man/man6 man/man7 man/man8
  man/cat1 man/cat2 man/cat3 man/cat4
  man/cat5 man/cat6 man/cat7 man/cat8
  applications gnome gnome/help icons
  mime-info pixmaps sounds postgresql
].freeze
ELISP_EXTENSIONS =

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

%w[.el .elc].freeze
PYC_EXTENSIONS =

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

%w[.pyc .pyo].freeze
LIBTOOL_EXTENSIONS =

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

%w[.la .lai].freeze
KEEPME_FILE =

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

".keepme"
PREFIX_PLACEHOLDER =

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

T.let("@@HOMEBREW_PREFIX@@", String)
CELLAR_PLACEHOLDER =

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

T.let("@@HOMEBREW_CELLAR@@", String)
REPOSITORY_PLACEHOLDER =

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

T.let("@@HOMEBREW_REPOSITORY@@", String)
LIBRARY_PLACEHOLDER =

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

T.let("@@HOMEBREW_LIBRARY@@", String)
PERL_PLACEHOLDER =

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

T.let("@@HOMEBREW_PERL@@", String)
JAVA_PLACEHOLDER =

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

T.let("@@HOMEBREW_JAVA@@", String)
NULL_BYTE =

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

T.let("\x00", String)
NULL_BYTE_STRING =

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

T.let("\\x00", String)
JAVA_REGEX =

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

%r{#{HOMEBREW_PREFIX}/opt/openjdk(@\d+(\.\d+)*)?/libexec(/openjdk\.jdk/Contents/Home)?}

Constants included from OS::Mac::Keg

OS::Mac::Keg::FRAMEWORK_RX, OS::Mac::Keg::VARIABLE_REFERENCE_RX

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Cachable

cache, clear_cache

Methods included from Utils::Output::Mixin

#odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled

Methods included from OS::Mac::Keg

#dylib_id_for, #each_linkage_for, #find_dylib, #find_dylib_suffix_from, #fixed_name, #loader_name_for, #mach_o_files, #prepare_codesign_writable_files, #relocated_name_for

Methods included from SystemCommand::Mixin

#system_command, #system_command!

Constructor Details

#initialize(path) ⇒ void

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

Parameters:



178
179
180
181
182
183
184
185
186
187
188
189
# File 'keg.rb', line 178

def initialize(path)
  path = path.resolved_path if path.to_s.start_with?("#{HOMEBREW_PREFIX}/opt/")
  raise "#{path} is not a valid keg" if path.parent.parent.realpath != HOMEBREW_CELLAR.realpath
  raise "#{path} is not a directory" unless path.directory?

  @path = path
  @name = path.parent.basename.to_s
  @linked_keg_record = HOMEBREW_LINKED_KEGS/name
  @opt_record = HOMEBREW_PREFIX/"opt/#{name}"
  @oldname_opt_records = []
  @require_relocation = false
end

Instance Attribute Details

#linked_keg_recordObject (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.



167
168
169
# File 'keg.rb', line 167

def linked_keg_record
  @linked_keg_record
end

#nameObject (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.



167
168
169
# File 'keg.rb', line 167

def name
  @name
end

#opt_recordObject (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.



167
168
169
# File 'keg.rb', line 167

def opt_record
  @opt_record
end

Class Method Details

.allObject

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.



117
118
119
# File 'keg.rb', line 117

def self.all
  Formula.racks.flat_map(&:subdirs).map { |d| new(d) }
end

.file_linked_libraries(_file, _string) ⇒ Array<Pathname>

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

Parameters:

Returns:



425
426
427
# File 'keg_relocate.rb', line 425

def self.file_linked_libraries(_file, _string)
  []
end

.for(path) ⇒ Object

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

Parameters:

  • path

    if this is a file in a keg, returns the containing Keg object.

Raises:

  • (Errno::ENOENT)


103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'keg.rb', line 103

def self.for(path)
  original_path = path
  raise Errno::ENOENT, original_path.to_s unless original_path.exist?

  if (path = original_path.realpath)
    until path.root?
      return Keg.new(path) if path.parent.parent == HOMEBREW_CELLAR.realpath

      path = path.parent.realpath # realpath() prevents root? failing
    end
  end
  raise NotAKegError, "#{original_path} is not inside a keg"
end

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.



121
122
123
124
125
# File 'keg.rb', line 121

def self.keg_link_directories
  @keg_link_directories ||= %w[
    bin etc include lib sbin share var
  ].freeze
end

.must_be_writable_directoriesObject

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.

Keep relatively in sync with https://github.com/Homebrew/install/blob/HEAD/install.sh



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'keg.rb', line 146

def self.must_be_writable_directories
  @must_be_writable_directories ||= (
  %w[
    etc/bash_completion.d lib/pkgconfig
    share/aclocal share/doc share/info share/locale share/man
    share/man/man1 share/man/man2 share/man/man3 share/man/man4
    share/man/man5 share/man/man6 share/man/man7 share/man/man8
    share/zsh share/zsh/site-functions
    share/pwsh share/pwsh/completions
    var/log
  ].map { |dir| HOMEBREW_PREFIX/dir } + must_exist_subdirectories + [
    HOMEBREW_CACHE,
    HOMEBREW_CELLAR,
    HOMEBREW_LOCKS,
    HOMEBREW_LOGS,
    HOMEBREW_REPOSITORY,
    Language::Python.homebrew_site_packages,
  ]
).sort.uniq.freeze
end

.must_exist_directoriesObject

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.

Keep relatively in sync with https://github.com/Homebrew/install/blob/HEAD/install.sh



138
139
140
141
142
# File 'keg.rb', line 138

def self.must_exist_directories
  @must_exist_directories ||= (must_exist_subdirectories + [
    HOMEBREW_CELLAR,
  ].sort.uniq).freeze
end

.must_exist_subdirectoriesObject

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.



127
128
129
130
131
132
133
134
# File 'keg.rb', line 127

def self.must_exist_subdirectories
  @must_exist_subdirectories ||= (
  keg_link_directories - %w[var] + %w[
    opt
    var/homebrew/linked
  ]
).map { |dir| HOMEBREW_PREFIX/dir }.sort.uniq.freeze
end

.text_matches_in_file(file, string, ignores, linked_libraries, formula_and_runtime_deps_names) ⇒ Array<Array<(String, 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.

Parameters:

Returns:



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
# File 'keg_relocate.rb', line 385

def self.text_matches_in_file(file, string, ignores, linked_libraries, formula_and_runtime_deps_names)
  text_matches = []
  path_regex = Relocation.path_to_regex(string)
  Utils.popen_read("strings", "-t", "x", "-", file.to_s) do |io|
    until io.eof?
      str = io.readline.chomp
      next if ignores.any? { |i| str.match?(i) }
      next unless str.match? path_regex

      offset, match = str.split(" ", 2)

      # Some binaries contain strings with lists of files
      # e.g. `/usr/local/lib/foo:/usr/local/share/foo:/usr/lib/foo`
      # Each item in the list should be checked separately
      match.split(":").each do |sub_match|
        # Not all items in the list may be matches
        next unless sub_match.match? path_regex
        next if linked_libraries.include? sub_match # Don't bother reporting a string if it was found by otool

        # Do not report matches to files that do not exist.
        next unless File.exist? sub_match

        # Do not report matches to build dependencies.
        if formula_and_runtime_deps_names.present?
          begin
            keg_name = Keg.for(Pathname.new(sub_match)).name
            next unless formula_and_runtime_deps_names.include? keg_name
          rescue NotAKegError
            nil
          end
        end

        text_matches << [match, offset] unless text_matches.any? { |text| text.last == offset }
      end
    end
  end
  text_matches
end

Instance Method Details

#/(*args, &block) ⇒ T.untyped

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

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


10
# File 'sorbet/rbi/dsl/keg.rbi', line 10

def /(*args, &block); end

#abv(*args, &block) ⇒ T.untyped

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

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


13
# File 'sorbet/rbi/dsl/keg.rbi', line 13

def abv(*args, &block); end

#aliasesObject

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.



540
541
542
# File 'keg.rb', line 540

def aliases
  tab.aliases || []
end

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

Returns:



386
387
388
389
# File 'keg.rb', line 386

def apps
  app_prefix = optlinked? ? opt_record : path
  Pathname.glob("#{app_prefix}/{,libexec/}*.app")
end

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

Returns:



6
7
8
# File 'extend/os/linux/keg.rb', line 6

def binary_executable_or_library_files
  elf_files
end

#binary_file?(file) ⇒ 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.

Parameters:

Returns:

  • (Boolean)


292
293
294
295
296
297
298
299
# File 'keg_relocate.rb', line 292

def binary_file?(file)
  grep_bin, grep_args = egrep_args

  # We need to pass NULL_BYTE_STRING, the literal string "\x00", to grep
  # rather than NULL_BYTE, a literal null byte, because grep will internally
  # convert the literal string "\x00" to a null byte.
  Utils.popen_read(grep_bin, *grep_args, NULL_BYTE_STRING, file).present?
end

#change_dylib_id(id, file) ⇒ 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.

Parameters:

Returns:

  • (Boolean)


6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# File 'os/mac/keg.rb', line 6

def change_dylib_id(id, file)
  return false if file.dylib_id == id

  @require_relocation = true
  odebug "Changing dylib ID of #{file}\n  from #{file.dylib_id}\n    to #{id}"
  file.change_dylib_id(id, strict: false)
  true
rescue MachO::MachOError
  onoe <<~EOS
    Failed changing dylib ID of #{file}
      from #{file.dylib_id}
        to #{id}
  EOS
  raise
end

#change_install_name(old, new, file) ⇒ 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.

Parameters:

Returns:

  • (Boolean)


23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# File 'os/mac/keg.rb', line 23

def change_install_name(old, new, file)
  return false if old == new

  @require_relocation = true
  odebug "Changing install name in #{file}\n  from #{old}\n    to #{new}"
  file.change_install_name(old, new, strict: false)
  true
rescue MachO::MachOError
  onoe <<~EOS
    Failed changing install name in #{file}
      from #{old}
        to #{new}
  EOS
  raise
end

#change_rpath(old, new, file) ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'os/mac/keg.rb', line 39

def change_rpath(old, new, file)
  return false if old == new

  @require_relocation = true
  odebug "Changing rpath in #{file}\n  from #{old}\n    to #{new}"
  file.change_rpath(old, new, strict: false)
  true
rescue MachO::MachOError
  onoe <<~EOS
    Failed changing rpath in #{file}
      from #{old}
        to #{new}
  EOS
  raise
end

#change_rpath!(file, old_prefix, new_prefix, skip_protodesc_cold: 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.

Parameters:

  • file (Pathname)
  • old_prefix (String, Regexp)
  • new_prefix (String)
  • skip_protodesc_cold (Boolean) (defaults to: false)

Returns:

  • (Boolean)


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
# File 'extend/os/linux/keg_relocate.rb', line 25

def change_rpath!(file, old_prefix, new_prefix, skip_protodesc_cold: false)
  return false if !file.elf? || !file.dynamic_elf?

  # Skip relocation of files with `protodesc_cold` sections because patchelf.rb seems to break them,
  # but only when bottling (as we don't want to break existing bottles that require relocation).
  # https://github.com/Homebrew/homebrew-core/pull/232490#issuecomment-3161362452
  return false if skip_protodesc_cold && file.section_names.include?("protodesc_cold")

  updated = {}
  old_rpath = file.rpath
  new_rpath = if old_rpath
    rpath = old_rpath.split(":")
                     .map { |x| x.sub(old_prefix, new_prefix) }
                     .select { |x| x.start_with?(new_prefix, "$ORIGIN") }

    lib_path = "#{new_prefix}/lib"
    rpath << lib_path unless rpath.include? lib_path

    # Add GCC's lib directory (as of GCC 12+) to RPATH when there is existing versioned linkage.
    # This prevents broken linkage when pouring bottles built with an old GCC formula.
    unless name.match?(Version.formula_optionally_versioned_regex(:gcc))
      rpath.map! { |rp| rp.sub(%r{lib/gcc/\d+$}, "lib/gcc/current") }
    end

    rpath.join(":")
  end
  updated[:rpath] = new_rpath if old_rpath != new_rpath

  old_interpreter = file.interpreter
  new_interpreter = if old_interpreter.nil?
    nil
  elsif File.readable? "#{new_prefix}/lib/ld.so"
    "#{new_prefix}/lib/ld.so"
  else
    old_interpreter.sub old_prefix, new_prefix
  end
  updated[:interpreter] = new_interpreter if old_interpreter != new_interpreter

  file.patch!(interpreter: updated[:interpreter], rpath: updated[:rpath])
  true
end

#codesign_patched_binary(file) ⇒ Object

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



611
# File 'keg.rb', line 611

def codesign_patched_binary(file); end

#completion_installed?(shell) ⇒ Boolean

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

Returns:

  • (Boolean)


355
356
357
358
359
360
361
362
363
364
365
# File 'keg.rb', line 355

def completion_installed?(shell)
  dir = case shell
  when :bash then path/"etc/bash_completion.d"
  when :fish then path/"share/fish/vendor_completions.d"
  when :zsh
    dir = path/"share/zsh/site-functions"
    dir if dir.directory? && dir.children.any? { |f| f.basename.to_s.start_with?("_") }
  when :pwsh then path/"share/pwsh/completions"
  end
  dir&.directory? && !dir.children.empty?
end

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.



518
# File 'keg.rb', line 518

def consistent_reproducible_symlink_permissions!; end

#delete_pyc_files!Object

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



559
560
561
562
# File 'keg.rb', line 559

def delete_pyc_files!
  path.find { |pn| pn.delete if PYC_EXTENSIONS.include?(pn.extname) }
  path.find { |pn| FileUtils.rm_rf pn if pn.basename.to_s == "__pycache__" }
end

#delete_rpath(rpath, file) ⇒ 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.

Parameters:

Returns:

  • (Boolean)


56
57
58
59
60
61
62
63
64
65
# File 'os/mac/keg.rb', line 56

def delete_rpath(rpath, file)
  odebug "Deleting rpath #{rpath} in #{file}"
  file.delete_rpath(rpath, strict: false)
  true
rescue MachO::MachOError
  onoe <<~EOS
    Failed deleting rpath #{rpath} in #{file}
  EOS
  raise
end

#detect_cxx_stdlibs(options = {}) ⇒ Array<Symbol>

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

Parameters:

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'extend/os/linux/keg_relocate.rb', line 68

def detect_cxx_stdlibs(options = {})
  skip_executables = options.fetch(:skip_executables, false)
  results = Set.new
  elf_files.each do |file|
    next unless file.dynamic_elf?
    next if file.binary_executable? && skip_executables

    dylibs = file.dynamically_linked_libraries
    results << :libcxx if dylibs.any? { |s| s.include? "libc++.so" }
    results << :libstdcxx if dylibs.any? { |s| s.include? "libstdc++.so" }
  end
  results.to_a
end

#directory?(*args, &block) ⇒ 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.

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (Boolean)


16
# File 'sorbet/rbi/dsl/keg.rbi', line 16

def directory?(*args, &block); end

#disk_usage(*args, &block) ⇒ T.untyped

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

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


19
# File 'sorbet/rbi/dsl/keg.rbi', line 19

def disk_usage(*args, &block); end

#each_unique_file_matching(string, &_block) ⇒ void

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

This method returns an undefined value.

Parameters:



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# File 'keg_relocate.rb', line 275

def each_unique_file_matching(string, &_block)
  Utils.popen_read("fgrep", recursive_fgrep_args, string, to_s) do |io|
    hardlinks = Set.new

    until io.eof?
      file = Pathname.new(io.readline.chomp)
      # Don't return symbolic links.
      next if file.symlink?

      # To avoid returning hardlinks, only return files with unique inodes.
      # Hardlinks will have the same inode as the file they point to.
      yield file if hardlinks.add? file.stat.ino
    end
  end
end

#egrep_argsArray<(String, 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.

Returns:



263
264
265
266
267
268
269
270
271
272
# File 'keg_relocate.rb', line 263

def egrep_args
  grep_bin = "grep"
  grep_args = [
    "--files-with-matches",
    "--perl-regexp",
    "--binary-files=text",
  ]

  [grep_bin, grep_args]
end

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

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'extend/os/linux/keg_relocate.rb', line 83

def elf_files
  hardlinks = Set.new
  elf_files = []
  path.find do |pn|
    next if pn.symlink? || pn.directory?
    next if !pn.dylib? && !pn.binary_executable?

    # If we've already processed a file, ignore its hardlinks (which have the
    # same dev ID and inode). This prevents relocations from being performed
    # on a binary more than once.
    next unless hardlinks.add? [pn.stat.dev, pn.stat.ino]

    elf_files << pn
  end
  elf_files
end

#elisp_installed?Boolean

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

Returns:

  • (Boolean)


391
392
393
394
395
# File 'keg.rb', line 391

def elisp_installed?
  return false unless (path/"share/emacs/site-lisp"/name).exist?

  (path/"share/emacs/site-lisp"/name).children.any? { |f| ELISP_EXTENSIONS.include? f.extname }
end

#empty_installation?Boolean

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

Returns:

  • (Boolean)


209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'keg.rb', line 209

def empty_installation?
  Pathname.glob("#{path}/*") do |file|
    return false if file.directory? && !file.children.reject(&:ds_store?).empty?

    basename = file.basename.to_s

    require "metafiles"
    next if Metafiles.copy?(basename)
    next if %w[.DS_Store INSTALL_RECEIPT.json].include?(basename)

    return false
  end

  true
end

#exist?(*args, &block) ⇒ 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.

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (Boolean)


22
# File 'sorbet/rbi/dsl/keg.rbi', line 22

def exist?(*args, &block); end

#file_count(*args, &block) ⇒ T.untyped

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

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


25
# File 'sorbet/rbi/dsl/keg.rbi', line 25

def file_count(*args, &block); end

#find(*args, &block) ⇒ T.untyped

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

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


28
# File 'sorbet/rbi/dsl/keg.rbi', line 28

def find(*args, &block); end

#fix_dynamic_linkagevoid

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.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'keg_relocate.rb', line 68

def fix_dynamic_linkage
  symlink_files.each do |file|
    link = file.readlink
    # Don't fix relative symlinks
    next unless link.absolute?

    link_starts_cellar = link.to_s.start_with?(HOMEBREW_CELLAR.to_s)
    link_starts_prefix = link.to_s.start_with?(HOMEBREW_PREFIX.to_s)
    next if !link_starts_cellar && !link_starts_prefix

    new_src = link.relative_path_from(file.parent)
    file.unlink
    FileUtils.ln_s(new_src, file)
  end
end

#functions_installed?(shell) ⇒ Boolean

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

Returns:

  • (Boolean)


367
368
369
370
371
372
373
374
375
376
377
378
# File 'keg.rb', line 367

def functions_installed?(shell)
  case shell
  when :fish
    dir = path/"share/fish/vendor_functions.d"
    dir.directory? && !dir.children.empty?
  when :zsh
    # Check for non completion functions (i.e. files not started with an underscore),
    # since those can be checked separately
    dir = path/"share/zsh/site-functions"
    dir.directory? && dir.children.any? { |f| !f.basename.to_s.start_with?("_") }
  end
end

#join(*args, &block) ⇒ T.untyped

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

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


34
# File 'sorbet/rbi/dsl/keg.rbi', line 34

def join(*args, &block); end

#keepme_refsArray<String>

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

Returns:



600
601
602
603
604
605
# File 'keg.rb', line 600

def keepme_refs
  keepme = path/KEEPME_FILE
  return [] if !keepme.exist? || !keepme.readable?

  keepme.readlines.select { |ref| File.exist?(ref.strip) }
end

#libPathname

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:



302
303
304
# File 'keg_relocate.rb', line 302

def lib
  path/"lib"
end

#libexecPathname

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:



307
308
309
# File 'keg_relocate.rb', line 307

def libexec
  path/"libexec"
end

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

Returns:



360
361
362
363
364
365
366
367
368
369
# File 'keg_relocate.rb', line 360

def libtool_files
  libtool_files = []

  path.find do |pn|
    next if pn.symlink? || pn.directory? || Keg::LIBTOOL_EXTENSIONS.exclude?(pn.extname)

    libtool_files << pn
  end
  libtool_files
end

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.



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
486
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 'keg.rb', line 429

def link(verbose: false, dry_run: false, overwrite: false)
  raise AlreadyLinkedError, self if linked_keg_record.directory?

  ObserverPathnameExtension.reset_counts!

  optlink(verbose:, dry_run:, overwrite:) unless dry_run

  # yeah indeed, you have to force anything you need in the main tree into
  # these dirs REMEMBER that *NOT* everything needs to be in the main tree
  link_dir("etc", verbose:, dry_run:, overwrite:) { :mkpath }
  link_dir("bin", verbose:, dry_run:, overwrite:) { :skip_dir }
  link_dir("sbin", verbose:, dry_run:, overwrite:) { :skip_dir }
  link_dir("include", verbose:, dry_run:, overwrite:) do |relative_path|
    case relative_path.to_s
    when /^postgresql@\d+/
      :mkpath
    else
      :link
    end
  end

  link_dir("share", verbose:, dry_run:, overwrite:) do |relative_path|
    case relative_path.to_s
    when INFOFILE_RX then :info
    when "locale/locale.alias",
         %r{^icons/.*/icon-theme\.cache$}
      :skip_file
    when LOCALEDIR_RX,
         %r{^icons/}, # all icons subfolders should also mkpath
         /^zsh/,
         /^fish/,
         %r{^lua/}, #  Lua, Lua51, Lua53 all need the same handling.
         %r{^guile/},
         /^postgresql@\d+/,
         *SHARE_PATHS
      :mkpath
    else
      :link
    end
  end

  link_dir("lib", verbose:, dry_run:, overwrite:) do |relative_path|
    case relative_path.to_s
    when "charset.alias"
      :skip_file
    when "pkgconfig", # pkg-config database gets explicitly created
         "cmake",     # cmake database gets explicitly created
         "dtrace",    # lib/language folders also get explicitly created
         /^gdk-pixbuf/,
         "ghc",
         /^gio/,
         /^lua/,
         /^mecab/,
         /^node/,
         /^ocaml/,
         /^perl5/,
         "php",
         /^postgresql@\d+/,
         /^python[23]\.\d+/,
         /^R/,
         /^ruby/
      :mkpath
    else
      # Everything else is symlinked to the Cellar
      :link
    end
  end

  link_dir("Frameworks", verbose:, dry_run:, overwrite:) do |relative_path|
    # Frameworks contain symlinks pointing into a subdir, so we have to use
    # the :link strategy. However, for Foo.framework and
    # Foo.framework/Versions we have to use :mkpath so that multiple formulae
    # can link their versions into it and `brew [un]link` works.
    if relative_path.to_s.match?(%r{[^/]*\.framework(/Versions)?$})
      :mkpath
    else
      :link
    end
  end
  make_relative_symlink(linked_keg_record, path, verbose:, dry_run:, overwrite:) unless dry_run
rescue LinkError
  unlink(verbose:)
  raise
else
  ObserverPathnameExtension.n
end

#linked?Boolean

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

Returns:

  • (Boolean)


229
230
231
232
233
# File 'keg.rb', line 229

def linked?
  linked_keg_record.symlink? &&
    linked_keg_record.directory? &&
    path == linked_keg_record.resolved_path
end

#lockObject

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.



343
344
345
346
347
348
349
350
351
352
353
# File 'keg.rb', line 343

def lock
  FormulaLock.new(name).with_lock do
    oldname_locks = oldname_opt_records.map do |record|
      FormulaLock.new(record.basename.to_s)
    end
    oldname_locks.each(&:lock)
    yield
  ensure
    oldname_locks&.each(&:unlock)
  end
end

#new_usr_local_replacement_pairsHash{Symbol => Hash{Symbol => String}}

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

Returns:



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
# File 'keg_relocate.rb', line 90

def new_usr_local_replacement_pairs
  {
    prefix:       {
      old: "/usr/local/opt",
      new: "#{PREFIX_PLACEHOLDER}/opt",
    },
    caskroom:     {
      old: "/usr/local/Caskroom",
      new: "#{PREFIX_PLACEHOLDER}/Caskroom",
    },
    etc_name:     {
      old: "/usr/local/etc/#{name}",
      new: "#{PREFIX_PLACEHOLDER}/etc/#{name}",
    },
    var_homebrew: {
      old: "/usr/local/var/homebrew",
      new: "#{PREFIX_PLACEHOLDER}/var/homebrew",
    },
    var_name:     {
      old: "/usr/local/var/#{name}",
      new: "#{PREFIX_PLACEHOLDER}/var/#{name}",
    },
    var_log_name: {
      old: "/usr/local/var/log/#{name}",
      new: "#{PREFIX_PLACEHOLDER}/var/log/#{name}",
    },
  }
end

#normalize_pod2man_outputs!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.



564
565
566
567
568
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
# File 'keg.rb', line 564

def normalize_pod2man_outputs!
  # Only process uncompressed manpages, which end in a digit
  manpages = Dir[path/"share/man/*/*.[1-9]"]
  generated_regex = /^\.\\"\s*Automatically generated by .*\n/
  manpages.each do |f|
    manpage = Pathname.new(f)
    next unless manpage.file?

    content = manpage.read
    unless content.valid_encoding?
      # Occasionally, a manpage might not be encoded as UTF-8. ISO-8859-1 is a
      # common alternative that's worth trying in this case.
      content = File.read(manpage, encoding: "ISO-8859-1")

      # If the encoding is still invalid, we can't do anything about it.
      next unless content.valid_encoding?
    end

    content = content.gsub(generated_regex, "")
    content = content.lines.map do |line|
      next line unless line.start_with?(".TH")

      # Split the line by spaces, but preserve quoted strings
      parts = line.split(/\s(?=(?:[^"]|"[^"]*")*$)/)
      next line if parts.length != 6

      # pod2man embeds the perl version used into the 5th field of the footer
      T.must(parts[4]).gsub!(/^"perl v.*"$/, "\"\"")
      "#{parts.join(" ")}\n"
    end.join

    manpage.atomic_write(content)
  end
end

#oldname_opt_recordsObject

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.



417
418
419
420
421
422
423
424
425
426
427
# File 'keg.rb', line 417

def oldname_opt_records
  return @oldname_opt_records unless @oldname_opt_records.empty?

  @oldname_opt_records = if (opt_dir = HOMEBREW_PREFIX/"opt").directory?
    opt_dir.subdirs.select do |dir|
      dir.symlink? && dir != opt_record && path.parent == dir.resolved_path.parent
    end
  else
    []
  end
end

#openjdk_dep_name_if_applicableString?

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:



178
179
180
181
182
183
184
# File 'keg_relocate.rb', line 178

def openjdk_dep_name_if_applicable
  deps = runtime_dependencies
  return if deps.blank?

  dep_names = deps.map { |d| d["full_name"] }
  dep_names.find { |d| d.match? Version.formula_optionally_versioned_regex(:openjdk) }
end

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.



544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'keg.rb', line 544

def optlink(verbose: false, dry_run: false, overwrite: false)
  opt_record.delete if opt_record.symlink? || opt_record.exist?
  make_relative_symlink(opt_record, path, verbose:, dry_run:, overwrite:)
  aliases.each do |a|
    alias_opt_record = opt_record.parent/a
    alias_opt_record.delete if alias_opt_record.symlink? || alias_opt_record.exist?
    make_relative_symlink(alias_opt_record, path, verbose:, dry_run:, overwrite:)
  end

  oldname_opt_records.each do |record|
    record.delete
    make_relative_symlink(record, path, verbose:, dry_run:, overwrite:)
  end
end

#optlinked?Boolean

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

Returns:

  • (Boolean)


240
241
242
# File 'keg.rb', line 240

def optlinked?
  opt_record.symlink? && path == opt_record.resolved_path
end

#plist_installed?Boolean

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

Returns:

  • (Boolean)


381
382
383
# File 'keg.rb', line 381

def plist_installed?
  !Dir["#{path}/*.plist"].empty?
end

#prepare_debug_symbolsObject

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



516
# File 'keg.rb', line 516

def prepare_debug_symbols; end

#prepare_relocation_to_locationsRelocation

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:



156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'keg_relocate.rb', line 156

def prepare_relocation_to_locations
  relocation = Relocation.new
  relocation.add_replacement_pair(:prefix, PREFIX_PLACEHOLDER, HOMEBREW_PREFIX.to_s)
  relocation.add_replacement_pair(:cellar, CELLAR_PLACEHOLDER, HOMEBREW_CELLAR.to_s)
  relocation.add_replacement_pair(:repository, REPOSITORY_PLACEHOLDER, HOMEBREW_REPOSITORY.to_s)
  relocation.add_replacement_pair(:library, LIBRARY_PLACEHOLDER, HOMEBREW_LIBRARY.to_s)
  relocation.add_replacement_pair(:perl, PERL_PLACEHOLDER, "#{HOMEBREW_PREFIX}/opt/perl/bin/perl")
  if (openjdk = openjdk_dep_name_if_applicable)
    relocation.add_replacement_pair(:java, JAVA_PLACEHOLDER, "#{HOMEBREW_PREFIX}/opt/#{openjdk}/libexec")
  end

  relocation
end

#prepare_relocation_to_placeholdersRelocation

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:



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
# File 'keg_relocate.rb', line 120

def prepare_relocation_to_placeholders
  relocation = Relocation.new

  # Use selective HOMEBREW_PREFIX replacement when HOMEBREW_PREFIX=/usr/local
  # This avoids overzealous replacement of system paths when a script refers to e.g. /usr/local/bin
  if new_usr_local_relocation?
    new_usr_local_replacement_pairs.each do |key, value|
      relocation.add_replacement_pair(key, value.fetch(:old), value.fetch(:new), path: true)
    end
  else
    relocation.add_replacement_pair(:prefix, HOMEBREW_PREFIX.to_s, PREFIX_PLACEHOLDER, path: true)
  end

  relocation.add_replacement_pair(:cellar, HOMEBREW_CELLAR.to_s, CELLAR_PLACEHOLDER, path: true)
  # when HOMEBREW_PREFIX == HOMEBREW_REPOSITORY we should use HOMEBREW_PREFIX for all relocations to avoid
  # being unable to differentiate between them.
  if HOMEBREW_PREFIX != HOMEBREW_REPOSITORY
    relocation.add_replacement_pair(:repository, HOMEBREW_REPOSITORY.to_s, REPOSITORY_PLACEHOLDER, path: true)
  end
  relocation.add_replacement_pair(:library, HOMEBREW_LIBRARY.to_s, LIBRARY_PLACEHOLDER, path: true)
  relocation.add_replacement_pair(:perl,
                                  %r{\A#![ \t]*(?:/usr/bin/perl\d\.\d+|#{HOMEBREW_PREFIX}/opt/perl/bin/perl)( |$)}o,
                                  "#!#{PERL_PLACEHOLDER}\\1")
  relocation.add_replacement_pair(:java, JAVA_REGEX, JAVA_PLACEHOLDER)

  relocation
end

#rackObject

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
192
193
# File 'keg.rb', line 191

def rack
  path.parent
end

#recursive_fgrep_argsString

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:



257
258
259
260
# File 'keg_relocate.rb', line 257

def recursive_fgrep_args
  # for GNU grep; overridden for BSD grep on OS X
  "-lr"
end

#relocate_build_prefix(keg, old_prefix, new_prefix) ⇒ void

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

This method returns an undefined value.

Parameters:



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'keg_relocate.rb', line 212

def relocate_build_prefix(keg, old_prefix, new_prefix)
  each_unique_file_matching(old_prefix) do |file|
    # Skip files which are not binary, as they do not need null padding.
    next unless keg.binary_file?(file)

    # Skip sharballs, which appear to break if patched.
    next if file.text_executable?

    # Split binary by null characters into array and substitute new prefix for old prefix.
    # Null padding is added if the new string is too short.
    file.ensure_writable do
      binary = File.binread file
      odebug "Replacing build prefix in: #{file}"
      binary_strings = binary.split(/#{NULL_BYTE}/o, -1)
      match_indices = binary_strings.each_index.select { |i| binary_strings.fetch(i).include?(old_prefix.to_s) }

      # Only perform substitution on strings which match prefix regex.
      match_indices.each do |i|
        s = binary_strings.fetch(i)
        binary_strings[i] = s.gsub(old_prefix.to_s, new_prefix.to_s)
                             .ljust(s.size, NULL_BYTE)
      end

      # Rejoin strings by null bytes.
      patched_binary = binary_strings.join(NULL_BYTE)
      if patched_binary.size != binary.size
        raise <<~EOS
          Patching failed!  Original and patched binary sizes do not match.
          Original size: #{binary.size}
          Patched size: #{patched_binary.size}
        EOS
      end

      file.atomic_write patched_binary
    end
    codesign_patched_binary(file)
  end
end

#relocate_dynamic_linkage(relocation, skip_protodesc_cold: false) ⇒ void

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

This method returns an undefined value.

Parameters:

  • relocation (Relocation)
  • _relocation (Relocation)
  • skip_protodesc_cold (Boolean) (defaults to: false)


8
9
10
11
12
13
14
15
16
17
18
19
# File 'extend/os/linux/keg_relocate.rb', line 8

def relocate_dynamic_linkage(relocation, skip_protodesc_cold: false)
  # Patching the dynamic linker of glibc breaks it.
  return if name.match? Version.formula_optionally_versioned_regex(:glibc)

  old_prefix, new_prefix = relocation.replacement_pair_for(:prefix)

  elf_files.each do |file|
    file.ensure_writable do
      change_rpath!(file, old_prefix, new_prefix, skip_protodesc_cold:)
    end
  end
end

#remove_linked_keg_recordObject

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.



235
236
237
238
# File 'keg.rb', line 235

def remove_linked_keg_record
  linked_keg_record.unlink
  linked_keg_record.parent.rmdir_if_possible
end

#remove_old_aliasesObject

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.



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
# File 'keg.rb', line 244

def remove_old_aliases
  opt = opt_record.parent
  linkedkegs = linked_keg_record.parent

  tap = begin
    to_formula.tap
  rescue
    # If the formula can't be found, just ignore aliases for now.
    nil
  end

  if tap
    bad_tap_opt = opt/tap.user
    FileUtils.rm_rf bad_tap_opt if !bad_tap_opt.symlink? && bad_tap_opt.directory?
  end

  aliases.each do |a|
    # versioned aliases are handled below
    next if a.match?(/.+@./)

    remove_alias_symlink(opt/a, opt_record)
    remove_alias_symlink(linkedkegs/a, linked_keg_record)
  end

  Pathname.glob("#{opt_record}@*").each do |a|
    a = a.basename.to_s
    next if aliases.include?(a)

    remove_alias_symlink(opt/a, rack)
    remove_alias_symlink(linkedkegs/a, rack)
  end
end

#remove_oldname_opt_recordsObject

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.



520
521
522
523
524
525
526
527
528
# File 'keg.rb', line 520

def remove_oldname_opt_records
  oldname_opt_records.reject! do |record|
    return false if record.resolved_path != path

    record.unlink
    record.parent.rmdir_if_possible
    true
  end
end

#remove_opt_recordObject

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.



277
278
279
280
# File 'keg.rb', line 277

def remove_opt_record
  opt_record.unlink
  opt_record.parent.rmdir_if_possible
end

#rename(*args, &block) ⇒ T.untyped

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

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


37
# File 'sorbet/rbi/dsl/keg.rbi', line 37

def rename(*args, &block); end

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

Returns:



149
150
151
152
153
# File 'keg_relocate.rb', line 149

def replace_locations_with_placeholders
  relocation = prepare_relocation_to_placeholders.freeze
  relocate_dynamic_linkage(relocation, skip_protodesc_cold: true)
  replace_text_in_files(relocation)
end

#replace_placeholders_with_locations(files, skip_linkage: false) ⇒ void

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

This method returns an undefined value.

Parameters:

  • files (Array<Pathname>, nil)
  • skip_linkage (Boolean) (defaults to: false)


171
172
173
174
175
# File 'keg_relocate.rb', line 171

def replace_placeholders_with_locations(files, skip_linkage: false)
  relocation = prepare_relocation_to_locations.freeze
  relocate_dynamic_linkage(relocation) unless skip_linkage
  replace_text_in_files(relocation, files:)
end

#replace_text_in_files(relocation, files: nil) ⇒ Array<Pathname>

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

Parameters:

Returns:



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'keg_relocate.rb', line 187

def replace_text_in_files(relocation, files: nil)
  files ||= text_files | libtool_files

  changed_files = T.let([], T::Array[Pathname])
  files.map { path.join(_1) }.group_by { |f| f.stat.ino }.each_value do |first, *rest|
    s = first.open("rb", &:read)

    next unless relocation.replace_text!(s)

    changed_files += [first, *rest].map { |file| file.relative_path_from(path) }

    begin
      first.atomic_write(s)
    rescue SystemCallError
      first.ensure_writable do
        first.open("wb") { |f| f.write(s) }
      end
    else
      rest.each { |file| FileUtils.ln(first, file, force: true) }
    end
  end
  changed_files
end

#require_relocation?Boolean

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

Returns:

  • (Boolean)


225
226
227
# File 'keg.rb', line 225

def require_relocation?
  @require_relocation
end

#runtime_dependenciesObject

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.



535
536
537
538
# File 'keg.rb', line 535

def runtime_dependencies
  Keg.cache[:runtime_dependencies] ||= {}
  Keg.cache[:runtime_dependencies][path] ||= tab.runtime_dependencies
end

#scheme_and_versionObject

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.

For ordering kegs by version with .sort_by, .max_by, etc.



409
410
411
# File 'keg.rb', line 409

def scheme_and_version
  [version_scheme, version]
end

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:



372
373
374
375
376
377
378
379
# File 'keg_relocate.rb', line 372

def symlink_files
  symlink_files = []
  path.find do |pn|
    symlink_files << pn if pn.symlink?
  end

  symlink_files
end

#tabTab

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:



531
532
533
# File 'keg.rb', line 531

def tab
  Tab.for_keg(self)
end

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

Returns:



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'keg_relocate.rb', line 312

def text_files
  text_files = []
  return text_files if !which("file") || !which("xargs")

  # file has known issues with reading files on other locales. Has
  # been fixed upstream for some time, but a sufficiently new enough
  # file with that fix is only available in macOS Sierra.
  # https://bugs.gw.com/view.php?id=292
  with_custom_locale("C") do
    files = Set.new path.find.reject { |pn|
      next true if pn.symlink?
      next true if pn.directory?
      next false if pn.basename.to_s == "orig-prefix.txt" # for python virtualenvs
      next true if pn == self/".brew/#{name}.rb"

      require "metafiles"
      next true if Metafiles::EXTENSIONS.include?(pn.extname)

      if pn.text_executable?
        text_files << pn
        next true
      end
      false
    }
    output, _status = Open3.capture2("xargs -0 file --no-dereference --print0",
                                     stdin_data: files.to_a.join("\0"))
    # `file` output sometimes contains data from the file, which may include
    # invalid UTF-8 entities, so tell Ruby this is just a bytestring
    output.force_encoding(Encoding::ASCII_8BIT)
    output.each_line do |line|
      path, info = line.split("\0", 2)
      # `file` sometimes prints more than one line of output per file;
      # subsequent lines do not contain a null-byte separator, so `info`
      # will be `nil` for those lines
      next unless info
      next unless info.include?("text")

      path = Pathname.new(path)
      next unless files.include?(path)

      text_files << path
    end
  end

  text_files
end

#to_formulaObject

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.



413
414
415
# File 'keg.rb', line 413

def to_formula
  Formulary.from_keg(self)
end

#to_path(*args, &block) ⇒ T.untyped

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

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


40
# File 'sorbet/rbi/dsl/keg.rbi', line 40

def to_path(*args, &block); end

#uninstall(raise_failures: false) ⇒ 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.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# File 'keg.rb', line 282

def uninstall(raise_failures: false)
  CacheStoreDatabase.use(:linkage) do |db|
    break unless db.created?

    LinkageCacheStore.new(path, db).delete!
  end

  FileUtils.rm_r(path)
  path.parent.rmdir_if_possible
  remove_opt_record if optlinked?
  remove_linked_keg_record if linked?
  remove_old_aliases
  remove_oldname_opt_records
rescue Errno::EACCES, Errno::ENOTEMPTY
  raise if raise_failures

  odie <<~EOS
    Could not remove #{name} keg! Do so manually:
      sudo rm -rf #{path}
  EOS
end

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.



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
# File 'keg.rb', line 304

def unlink(verbose: false, dry_run: false)
  ObserverPathnameExtension.reset_counts!

  dirs = []

  keg_directories = self.class.keg_link_directories.map { |d| path/d }
                        .select(&:exist?)
  keg_directories.each do |dir|
    dir.find do |src|
      dst = HOMEBREW_PREFIX + src.relative_path_from(path)
      dst.extend(ObserverPathnameExtension)

      dirs << dst if dst.directory? && !dst.symlink?

      # check whether the file to be unlinked is from the current keg first
      next unless dst.symlink?
      next if src != dst.resolved_path

      if dry_run
        puts dst
        Find.prune if src.directory?
        next
      end

      dst.uninstall_info if dst.to_s.match?(INFOFILE_RX)
      dst.unlink
      Find.prune if src.directory?
    end
  end

  unless dry_run
    remove_old_aliases
    remove_linked_keg_record if linked?
    (dirs - self.class.must_exist_subdirectories).reverse_each(&:rmdir_if_possible)
  end

  ObserverPathnameExtension.n
end

#versionPkgVersion

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:



398
399
400
401
# File 'keg.rb', line 398

def version
  require "pkg_version"
  PkgVersion.parse(path.basename.to_s)
end

#version_schemeObject

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.



403
404
405
# File 'keg.rb', line 403

def version_scheme
  @version_scheme ||= tab.version_scheme
end