Module: FormulaCellarChecks Private

Included in:
FormulaInstaller, Homebrew::FormulaAuditor
Defined in:
Library/Homebrew/formula_cellar_checks.rb,
Library/Homebrew/extend/os/mac/formula_cellar_checks.rb,
Library/Homebrew/extend/os/linux/formula_cellar_checks.rb

Overview

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

Checks to perform on a formula's cellar.

Constant Summary collapse

VALID_LIBRARY_EXTENSIONS =

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

%w[.a .jnilib .la .o .so .jar .prl .pm .sh].freeze

Instance Method Summary collapse

Instance Method Details

#audit_installedObject

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


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# File 'Library/Homebrew/formula_cellar_checks.rb', line 265

def audit_installed
  @new_formula ||= false

  problem_if_output(check_manpages)
  problem_if_output(check_infopages)
  problem_if_output(check_jars)
  problem_if_output(check_non_libraries) if @new_formula
  problem_if_output(check_non_executables(formula.bin))
  problem_if_output(check_generic_executables(formula.bin))
  problem_if_output(check_non_executables(formula.sbin))
  problem_if_output(check_generic_executables(formula.sbin))
  problem_if_output(check_easy_install_pth(formula.lib))
  problem_if_output(check_elisp_dirname(formula.share, formula.name))
  problem_if_output(check_elisp_root(formula.share, formula.name))
  problem_if_output(check_python_packages(formula.lib, formula.deps))
  problem_if_output(check_shim_references(formula.prefix))
  problem_if_output(check_plist(formula.prefix, formula.plist))
end

#check_easy_install_pth(lib) ⇒ Object

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


121
122
123
124
125
126
127
128
129
130
131
132
# File 'Library/Homebrew/formula_cellar_checks.rb', line 121

def check_easy_install_pth(lib)
  pth_found = Dir["#{lib}/python{2.7,3}*/site-packages/easy-install.pth"].map { |f| File.dirname(f) }
  return if pth_found.empty?

  <<~EOS
    easy-install.pth files were found
    These .pth files are likely to cause link conflicts. Please invoke
    setup.py using Language::Python.setup_install_args.
    The offending files are:
      #{pth_found * "\n        "}
  EOS
end

#check_elisp_dirname(share, name) ⇒ Object

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


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'Library/Homebrew/formula_cellar_checks.rb', line 134

def check_elisp_dirname(share, name)
  return unless (share/"emacs/site-lisp").directory?
  # Emacs itself can do what it wants
  return if name == "emacs"

  bad_dir_name = (share/"emacs/site-lisp").children.any? do |child|
    child.directory? && child.basename.to_s != name
  end

  return unless bad_dir_name

  <<~EOS
    Emacs Lisp files were installed into the wrong site-lisp subdirectory.
    They should be installed into:
      #{share}/emacs/site-lisp/#{name}
  EOS
end

#check_elisp_root(share, name) ⇒ Object

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


152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'Library/Homebrew/formula_cellar_checks.rb', line 152

def check_elisp_root(share, name)
  return unless (share/"emacs/site-lisp").directory?
  # Emacs itself can do what it wants
  return if name == "emacs"

  elisps = (share/"emacs/site-lisp").children.select { |file| %w[.el .elc].include? file.extname }
  return if elisps.empty?

  <<~EOS
    Emacs Lisp files were linked directly to #{HOMEBREW_PREFIX}/share/emacs/site-lisp
    This may cause conflicts with other packages.
    They should instead be installed into:
      #{share}/emacs/site-lisp/#{name}

    The offending files are:
      #{elisps * "\n        "}
  EOS
end

#check_env_path(bin) ⇒ Object

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


9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# File 'Library/Homebrew/formula_cellar_checks.rb', line 9

def check_env_path(bin)
  # warn the user if stuff was installed outside of their PATH
  return unless bin.directory?
  return if bin.children.empty?

  prefix_bin = (HOMEBREW_PREFIX/bin.basename)
  return unless prefix_bin.directory?

  prefix_bin = prefix_bin.realpath
  return if ORIGINAL_PATHS.include? prefix_bin

  <<~EOS
    #{prefix_bin} is not in your PATH
    You can amend this by altering your #{Utils::Shell.profile} file.
  EOS
end

#check_generic_executables(bin) ⇒ Object

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


103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'Library/Homebrew/formula_cellar_checks.rb', line 103

def check_generic_executables(bin)
  return unless bin.directory?

  generic_names = %w[service start stop]
  generics = bin.children.select { |g| generic_names.include? g.basename.to_s }
  return if generics.empty?

  <<~EOS
    Generic binaries were installed to "#{bin}"
    Binaries with generic names are likely to conflict with other software,
    and suggest that this software should be installed to "libexec" and then
    symlinked as needed.

    The offending files are:
      #{generics * "\n        "}
  EOS
end

#check_infopagesObject

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


37
38
39
40
41
42
43
44
45
46
# File 'Library/Homebrew/formula_cellar_checks.rb', line 37

def check_infopages
  # Check for info pages that aren't in share/info
  return unless (formula.prefix/"info").directory?

  <<~EOS
    A top-level "info" directory was found
    Homebrew suggests that info pages live under share.
    This can often be fixed by passing "--infodir=\#{info}" to configure.
  EOS
end

#check_jarsObject

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


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'Library/Homebrew/formula_cellar_checks.rb', line 48

def check_jars
  return unless formula.lib.directory?

  jars = formula.lib.children.select { |g| g.extname == ".jar" }
  return if jars.empty?

  <<~EOS
    JARs were installed to "#{formula.lib}"
    Installing JARs to "lib" can cause conflicts between packages.
    For Java software, it is typically better for the formula to
    install to "libexec" and then symlink or wrap binaries into "bin".
    See "activemq", "jruby", etc. for examples.
    The offending files are:
      #{jars * "\n        "}
  EOS
end

#check_linkageObject

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


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
# File 'Library/Homebrew/extend/os/mac/formula_cellar_checks.rb', line 64

def check_linkage
  return unless formula.prefix.directory?

  keg = Keg.new(formula.prefix)

  CacheStoreDatabase.use(:linkage) do |db|
    checker = LinkageChecker.new(keg, formula, cache_db: db)
    next unless checker.broken_library_linkage?

    output = <<~EOS
      #{formula} has broken dynamic library links:
        #{checker.display_test_output}
    EOS

    tab = Tab.for_keg(keg)
    if tab.poured_from_bottle
      output += <<~EOS
        Rebuild this from source with:
          brew reinstall --build-from-source #{formula}
        If that's successful, file an issue#{formula.tap ? " here:\n  #{formula.tap.issues_url}" : "."}
      EOS
    end
    problem_if_output output
  end
end

#check_manpagesObject

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


26
27
28
29
30
31
32
33
34
35
# File 'Library/Homebrew/formula_cellar_checks.rb', line 26

def check_manpages
  # Check for man pages that aren't in share/man
  return unless (formula.prefix/"man").directory?

  <<~EOS
    A top-level "man" directory was found
    Homebrew requires that man pages live under share.
    This can often be fixed by passing "--mandir=\#{man}" to configure.
  EOS
end

#check_non_executables(bin) ⇒ Object

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


90
91
92
93
94
95
96
97
98
99
100
101
# File 'Library/Homebrew/formula_cellar_checks.rb', line 90

def check_non_executables(bin)
  return unless bin.directory?

  non_exes = bin.children.select { |g| g.directory? || !g.executable? }
  return if non_exes.empty?

  <<~EOS
    Non-executables were installed to "#{bin}"
    The offending files are:
      #{non_exes * "\n  "}
  EOS
end

#check_non_librariesObject

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


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'Library/Homebrew/formula_cellar_checks.rb', line 72

def check_non_libraries
  return unless formula.lib.directory?

  non_libraries = formula.lib.children.reject do |g|
    next true if g.directory?

    valid_library_extension? g
  end
  return if non_libraries.empty?

  <<~EOS
    Non-libraries were installed to "#{formula.lib}"
    Installing non-libraries to "lib" is discouraged.
    The offending files are:
      #{non_libraries * "\n        "}
  EOS
end

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


28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# File 'Library/Homebrew/extend/os/mac/formula_cellar_checks.rb', line 28

def check_openssl_links
  return unless formula.prefix.directory?

  keg = Keg.new(formula.prefix)
  system_openssl = keg.mach_o_files.select do |obj|
    dlls = obj.dynamically_linked_libraries
    dlls.any? { |dll| %r{/usr/lib/lib(crypto|ssl|tls)\..*dylib}.match dll }
  end
  return if system_openssl.empty?

  <<~EOS
    object files were linked against system openssl
    These object files were linked against the deprecated system OpenSSL or
    the system's private LibreSSL.
    Adding `depends_on "openssl"` to the formula may help.
      #{system_openssl * "\n        "}
  EOS
end

#check_plist(prefix, plist) ⇒ Object

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


230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'Library/Homebrew/formula_cellar_checks.rb', line 230

def check_plist(prefix, plist)
  return unless prefix.directory?

  plist = begin
    Plist.parse_xml(plist)
  rescue
    nil
  end
  return if plist.blank?

  program_location = plist["ProgramArguments"]&.first
  key = "first ProgramArguments value"
  if program_location.blank?
    program_location = plist["Program"]
    key = "Program"
  end
  return if program_location.blank?

  Dir.chdir("/") do
    unless File.exist?(program_location)
      return <<~EOS
        The plist #{key} does not exist:
          #{program_location}
      EOS
    end

    return if File.executable?(program_location)
  end

  <<~EOS
    The plist #{key} is not executable:
      #{program_location}
  EOS
end

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


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'Library/Homebrew/extend/os/mac/formula_cellar_checks.rb', line 47

def check_python_framework_links(lib)
  python_modules = Pathname.glob lib/"python*/site-packages/**/*.so"
  framework_links = python_modules.select do |obj|
    dlls = obj.dynamically_linked_libraries
    dlls.any? { |dll| /Python\.framework/.match dll }
  end
  return if framework_links.empty?

  <<~EOS
    python modules have explicit framework links
    These python extension modules were linked directly to a Python
    framework binary. They should be linked with -undefined dynamic_lookup
    instead of -lpython or -framework Python.
      #{framework_links * "\n        "}
  EOS
end

#check_python_packages(lib, deps) ⇒ Object

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


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'Library/Homebrew/formula_cellar_checks.rb', line 171

def check_python_packages(lib, deps)
  return unless lib.directory?

  lib_subdirs = lib.children
                   .select(&:directory?)
                   .map(&:basename)

  pythons = lib_subdirs.map do |p|
    match = p.to_s.match(/^python(\d+\.\d+)$/)
    next if match.blank?
    next if match.captures.blank?

    match.captures.first
  end.compact

  return if pythons.blank?

  python_deps = deps.map(&:name)
                    .grep(/^python(@.*)?$/)
                    .map { |d| Formula[d].version.to_s[/^\d+\.\d+/] }
                    .compact

  return if python_deps.blank?
  return if pythons.any? { |v| python_deps.include? v }

  pythons = pythons.map { |v| "Python #{v}" }
  python_deps = python_deps.map { |v| "Python #{v}" }

  <<~EOS
    Packages have been installed for:
      #{pythons * "\n        "}
    but this formula depends on:
      #{python_deps * "\n        "}
  EOS
end

#check_shadowed_headersObject

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


7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# File 'Library/Homebrew/extend/os/mac/formula_cellar_checks.rb', line 7

def check_shadowed_headers
  return if ["libtool", "subversion", "berkeley-db"].any? do |formula_name|
    formula.name.start_with?(formula_name)
  end

  return if formula.name&.match?(Version.formula_optionally_versioned_regex(:php))
  return if formula.keg_only? || !formula.include.directory?

  files  = relative_glob(formula.include, "**/*.h")
  files &= relative_glob("#{MacOS.sdk_path}/usr/include", "**/*.h")
  files.map! { |p| File.join(formula.include, p) }

  return if files.empty?

  <<~EOS
    Header files that shadow system header files were installed to "#{formula.include}"
    The offending files are:
      #{files * "\n        "}
  EOS
end

#check_shim_references(prefix) ⇒ Object

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


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'Library/Homebrew/formula_cellar_checks.rb', line 207

def check_shim_references(prefix)
  return unless prefix.directory?

  keg = Keg.new(prefix)

  matches = []
  keg.each_unique_file_matching(HOMEBREW_SHIMS_PATH) do |f|
    match = f.relative_path_from(keg.to_path)

    next if match.to_s.match? %r{^share/doc/.+?/INFO_BIN$}

    matches << match
  end

  return if matches.empty?

  <<~EOS
    Files were found with references to the Homebrew shims directory.
    The offending files are:
      #{matches * "\n  "}
  EOS
end

#generic_audit_installedObject

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


283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'Library/Homebrew/formula_cellar_checks.rb', line 283

def audit_installed
  @new_formula ||= false

  problem_if_output(check_manpages)
  problem_if_output(check_infopages)
  problem_if_output(check_jars)
  problem_if_output(check_non_libraries) if @new_formula
  problem_if_output(check_non_executables(formula.bin))
  problem_if_output(check_generic_executables(formula.bin))
  problem_if_output(check_non_executables(formula.sbin))
  problem_if_output(check_generic_executables(formula.sbin))
  problem_if_output(check_easy_install_pth(formula.lib))
  problem_if_output(check_elisp_dirname(formula.share, formula.name))
  problem_if_output(check_elisp_root(formula.share, formula.name))
  problem_if_output(check_python_packages(formula.lib, formula.deps))
  problem_if_output(check_shim_references(formula.prefix))
  problem_if_output(check_plist(formula.prefix, formula.plist))
end

#generic_valid_library_extension?Boolean

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

Returns:

  • (Boolean)

70
71
72
# File 'Library/Homebrew/formula_cellar_checks.rb', line 70

def valid_library_extension?(filename)
  VALID_LIBRARY_EXTENSIONS.include? filename.extname
end

#valid_library_extension?(filename) ⇒ Boolean

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

Returns:

  • (Boolean)

67
68
69
# File 'Library/Homebrew/formula_cellar_checks.rb', line 67

def valid_library_extension?(filename)
  VALID_LIBRARY_EXTENSIONS.include? filename.extname
end