Class: Homebrew::Cleanup Private

Inherits:
Object show all
Extended by:
Utils::Output::Mixin
Includes:
OS::Linux::Cleanup, OS::Mac::Cleanup, Utils::Output::Mixin
Defined in:
cleanup.rb

Overview

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

Helper class for cleaning up the Homebrew cache.

Constant Summary collapse

PERIODIC_CLEAN_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. 

T.let((HOMEBREW_CACHE/".cleaned").freeze, Pathname)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils::Output::Mixin

issue_reporting_message, odebug, odeprecated, odie, odisabled, ofail, oh1, oh1_title, ohai, ohai_title, onoe, opoo, opoo_outside_github_actions, opoo_without_github_actions_annotation, pretty_deprecated, pretty_disabled, pretty_duration, pretty_install_status, pretty_installed, pretty_uninstalled, pretty_unmarked, pretty_upgradable, pretty_warning

Constructor Details

#initialize(*args, dry_run: false, scrub: false, days: nil, cache: HOMEBREW_CACHE, output: $stdout) ⇒ 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:

  • args (String)
  • dry_run (Boolean) (defaults to: false)
  • scrub (Boolean) (defaults to: false)
  • days (Integer, nil) (defaults to: nil)
  • cache (Pathname) (defaults to: HOMEBREW_CACHE)
  • output (IO, StringIO) (defaults to: $stdout) 


277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'cleanup.rb', line 277

def initialize(*args, dry_run: false, scrub: false, days: nil, cache: HOMEBREW_CACHE, output: $stdout)
  @disk_cleanup_size = T.let(0, Integer)
  @args = args
  @dry_run = dry_run
  @scrub = scrub
  @prune = T.let(days.present?, T::Boolean)
  @days = T.let(days || Homebrew::EnvConfig.cleanup_max_age_days.to_i, Integer)
  @cache = cache
  @output = output
  @cleaned_up_paths = T.let(Set.new, T::Set[Pathname])
  @formula_cache_paths = T.let(nil, T.nilable(T::Hash[String, T::Array[Pathname]]))
end

Instance Attribute Details

#args ⇒ Array<String> (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.

Returns:



256
257
258
 
# File 'cleanup.rb', line 256

def args
  @args
end

#cache ⇒ Pathname (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.

Returns:



262
263
264
 
# File 'cleanup.rb', line 262

def cache
  @cache
end

#days ⇒ Integer (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.

Returns:



259
260
261
 
# File 'cleanup.rb', line 259

def days
  @days
end

#disk_cleanup_size ⇒ Integer (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.

Returns:



265
266
267
 
# File 'cleanup.rb', line 265

def disk_cleanup_size
  @disk_cleanup_size
end

Class Method Details

.autoremove(dry_run: 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:

  • dry_run (Boolean) (defaults to: false) 


1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'cleanup.rb', line 1003

def self.autoremove(dry_run: false)
  require "utils/autoremove"
  require "cask/caskroom"

  # If this runs after install, uninstall, reinstall or upgrade,
  # the cache of installed formulae may no longer be valid.
  Formula.clear_cache unless dry_run

  formulae = Formula.installed
  # Remove formulae listed in HOMEBREW_NO_CLEANUP_FORMULAE and their dependencies.
  if Homebrew::EnvConfig.no_cleanup_formulae.present?
    formulae -= formulae.select { skip_clean_formula?(it) }
                        .flat_map { |f| [f, *f.installed_runtime_formula_dependencies] }
  end
  casks = Cask::Caskroom.casks

  removable_formulae = Utils::Autoremove.removable_formulae(formulae, casks)
  if (candidate_kegs = removable_formulae.filter_map(&:any_installed_keg).presence) &&
     (required_kegs, = InstalledDependents.find_some_installed_dependents(candidate_kegs)) &&
     (required_names = Set.new(required_kegs.map(&:name)).presence)
    removable_formulae.reject! { |formula| required_names.include?(formula.name) }
  end

  return if removable_formulae.blank?

  formulae_names = removable_formulae.map(&:full_name).sort

  verb = dry_run ? "Would autoremove" : "Autoremoving"
  oh1 "#{verb} #{formulae_names.count} unneeded #{Utils.pluralize("formula", formulae_names.count)}:"
  puts formulae_names.join("\n")
  return if dry_run

  require "uninstall"

  kegs_by_rack = removable_formulae.filter_map(&:any_installed_keg).group_by(&:rack)
  Uninstall.uninstall_kegs(kegs_by_rack)

  # The installed formula cache will be invalid after uninstalling.
  Formula.clear_cache
end

.cask_cache_file_current?(pathname, cask, name) ⇒ 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) 


78
79
80
 
# File 'cleanup.rb', line 78

def cask_cache_file_current?(pathname, cask, name)
  pathname.basename.to_s.match?(/\A#{Regexp.escape(name)}--#{Regexp.escape(cask.version)}(?:\.|\z)/)
end

.dry_run_output(*args, formulae: [], quiet: false) ⇒ 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:

  • args (String)
  • formulae (Array<Formula>) (defaults to: [])
  • quiet (Boolean) (defaults to: false)

Returns:



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'cleanup.rb', line 314

def self.dry_run_output(*args, formulae: [], quiet: false)
  output = StringIO.new
  old_stdout = $stdout
  begin
    $stdout = output
    cleanup = Cleanup.new(*args, dry_run: true)
    if formulae.empty?
      cleanup.clean!(quiet:)
    else
      formulae.each { |formula| cleanup.cleanup_formula(formula, quiet:) }
    end
  ensure
    $stdout = old_stdout
  end
  output.string
end

.go_cache_directory?(pathname) ⇒ 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) 


42
43
44
45
46
 
# File 'cleanup.rb', line 42

def go_cache_directory?(pathname)
  # Go makes its cache contents read-only to ensure cache integrity,
  # which makes sense but is something we need to undo for cleanup.
  pathname.directory? && %w[go_cache go_mod_cache].include?(pathname.basename.to_s)
end

.incomplete?(pathname) ⇒ 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
 
# File 'cleanup.rb', line 23

def incomplete?(pathname)
  pathname.extname.end_with?(".incomplete")
end

.install_clean!(formulae: [], casks: []) ⇒ 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:



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'cleanup.rb', line 354

def self.install_clean!(formulae: [], casks: [])
  return if Homebrew::EnvConfig.no_install_cleanup?

  formulae = install_cleanup_formulae(formulae).uniq(&:full_name)
  casks = casks.uniq(&:full_name)
  packages = T.let(formulae + casks, T::Array[T.any(Formula, Cask::Cask)])
  return if packages.empty?

  cleanup_output = Utils.parallel_map(packages) do |package|
    output = StringIO.new
    cleanup = Cleanup.new(output:)
    name = case package
    when Formula
      cleanup.cleanup_formula(package, quiet: true, cache_db: false, cleanup_unreferenced: false)
      package.full_specified_name
    when Cask::Cask
      cleanup.cleanup_cask(package, cleanup_unreferenced: false)
      package.full_name
    else
      T.absurd(package)
    end
    [name, output.string]
  end

  Cleanup.new.cleanup_cache_db if formulae.present?
  Cleanup.new.cleanup_unreferenced_downloads

  cleanup_output.reject! { |_, output| output.empty? }
  return if cleanup_output.empty?

  oh1 "Cleanup"
  cleanup_output.each do |name, output|
    ohai name
    print output
  end
  puts_no_install_cleanup_disable_message_if_not_already!
end

.install_cleanup_formulae(formulae) ⇒ Array<Formula>

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

Parameters:

Returns:



332
333
334
335
336
337
338
 
# File 'cleanup.rb', line 332

def self.install_cleanup_formulae(formulae)
  return [] if Homebrew::EnvConfig.no_install_cleanup?

  formulae.select do |formula|
    formula.latest_version_installed? && !skip_clean_formula?(formula)
  end
end

.install_formula_clean!(formula) ⇒ 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:



341
342
343
344
345
346
347
348
349
350
351
 
# File 'cleanup.rb', line 341

def self.install_formula_clean!(formula)
  return if install_cleanup_formulae([formula]).blank?

  output = StringIO.new
  Cleanup.new(output:).cleanup_formula(formula, quiet: true)
  return if output.string.empty?

  ohai "Running `brew cleanup #{formula}`..."
  puts_no_install_cleanup_disable_message_if_not_already!
  print output.string
end

.nested_cache?(pathname) ⇒ 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) 


28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'cleanup.rb', line 28

def nested_cache?(pathname)
  pathname.directory? && %w[
    cargo_cache
    go_cache
    go_mod_cache
    glide_home
    java_cache
    npm_cache
    pip_cache
    gclient_cache
  ].include?(pathname.basename.to_s)
end

.periodic_clean!(dry_run: 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:

  • dry_run (Boolean) (defaults to: false) 


432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'cleanup.rb', line 432

def self.periodic_clean!(dry_run: false)
  return if Homebrew::EnvConfig.no_install_cleanup?
  return unless periodic_clean_due?

  if dry_run
    oh1 "Would run `brew cleanup` which has not been run in the last #{CLEANUP_DEFAULT_DAYS} days"
  else
    oh1 "`brew cleanup` has not been run in the last #{CLEANUP_DEFAULT_DAYS} days, running now..."
  end

  puts_no_install_cleanup_disable_message
  return if dry_run

  Cleanup.new.clean!(quiet: true, periodic: true)
end

.periodic_clean_due? ⇒ 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) 


419
420
421
422
423
424
425
426
427
428
429
 
# File 'cleanup.rb', line 419

def self.periodic_clean_due?
  return false if Homebrew::EnvConfig.no_install_cleanup?

  unless PERIODIC_CLEAN_FILE.exist?
    HOMEBREW_CACHE.mkpath
    FileUtils.touch PERIODIC_CLEAN_FILE
    return false
  end

  PERIODIC_CLEAN_FILE.mtime < (DateTime.now - CLEANUP_DEFAULT_DAYS).to_time
end

.printed_dry_run_output?(output, ohai: 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:

  • output (String)
  • ohai (Boolean) (defaults to: false)

Returns:

  • (Boolean) 


300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'cleanup.rb', line 300

def self.printed_dry_run_output?(output, ohai: false)
  return false if output.blank?

  if ohai
    ohai "Would `brew cleanup`"
  else
    puts "Would `brew cleanup`:"
  end
  print output
  puts unless output.end_with?("\n")
  true
end

.prune?(pathname, days) ⇒ 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) 


49
50
51
52
53
54
55
56
 
# File 'cleanup.rb', line 49

def prune?(pathname, days)
  return false unless days
  return true if days.zero?
  return true if pathname.symlink? && !pathname.exist?

  days_ago = (DateTime.now - days).to_time
  pathname.mtime < days_ago && pathname.ctime < days_ago
end

.puts_no_install_cleanup_disable_message ⇒ 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.



393
394
395
396
397
398
399
 
# File 'cleanup.rb', line 393

def self.puts_no_install_cleanup_disable_message
  return if Homebrew::EnvConfig.no_env_hints?
  return if Homebrew::EnvConfig.no_install_cleanup?

  puts "Disable this behaviour by setting `HOMEBREW_NO_INSTALL_CLEANUP=1`."
  puts "Hide these hints with `HOMEBREW_NO_ENV_HINTS=1` (see `man brew`)."
end

.puts_no_install_cleanup_disable_message_if_not_already! ⇒ 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.



402
403
404
405
406
407
 
# File 'cleanup.rb', line 402

def self.puts_no_install_cleanup_disable_message_if_not_already!
  return if @puts_no_install_cleanup_disable_message_if_not_already

  puts_no_install_cleanup_disable_message
  @puts_no_install_cleanup_disable_message_if_not_already = T.let(true, T.nilable(TrueClass))
end

.skip_clean_formula?(formula) ⇒ Boolean

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

Parameters:

Returns:

  • (Boolean) 


410
411
412
413
414
415
416
 
# File 'cleanup.rb', line 410

def self.skip_clean_formula?(formula)
  no_cleanup_formula = Homebrew::EnvConfig.no_cleanup_formulae
  return false if no_cleanup_formula.blank?

  @skip_clean_formulae ||= T.let(no_cleanup_formula.split(","), T.nilable(T::Array[String]))
  @skip_clean_formulae.include?(formula.name) || @skip_clean_formulae.intersect?(formula.aliases)
end

.stale?(entry, scrub: 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:

  • entry (Hash)
  • scrub (Boolean) (defaults to: false)

Returns:

  • (Boolean) 


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'cleanup.rb', line 59

def stale?(entry, scrub: false)
  pathname = entry[:path]
  return false unless pathname.resolved_path.file?

  case entry[:type]
  when :api_package
    scrub
  when :api_source
    stale_api_source?(pathname, scrub)
  when :cask
    stale_cask?(pathname, scrub)
  when :gh_actions_artifact
    scrub || prune?(pathname, GH_ACTIONS_ARTIFACT_CLEANUP_DAYS)
  else
    stale_formula?(pathname, scrub)
  end
end

.stale_cask_download?(pathname, cask, name, scrub:) ⇒ 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) 


83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'cleanup.rb', line 83

def stale_cask_download?(pathname, cask, name, scrub:)
  return true unless pathname.exist?
  return true unless cask_cache_file_current?(pathname, cask, name)
  return true if scrub && cask.installed_version != cask.version

  if cask.version.latest?
    cleanup_threshold = (DateTime.now - CLEANUP_DEFAULT_DAYS).to_time
    return pathname.mtime < cleanup_threshold && pathname.ctime < cleanup_threshold
  end

  false
end

Instance Method Details

#cache_entries(paths, type:) ⇒ Array<Hash>

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:



532
533
534
 
# File 'cleanup.rb', line 532

def cache_entries(paths, type:)
  paths.map { |path| { path:, type: } }
end

#cache_files ⇒ Array<Hash>

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:



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'cleanup.rb', line 656

def cache_files
  files = cache.directory? ? cache.children : []
  cask_files = (cache/"Cask").directory? ? (cache/"Cask").children : []
  api_internal = cache/"api/internal"
  api_package_files = if scrub? && api_internal.directory?
    current_api_package_basename = Homebrew::API::Internal.cached_packages_json_file_path.basename.to_s
    # Keep only the current OS's envelope and its `.payload` and
    # `.payload.index` sidecars and scrub the rest, including orphaned
    # sidecars and temp files.
    # Keep in sync with the previous-OS-version removal in cmd/update.sh.
    kept_basenames = [
      current_api_package_basename,
      "#{current_api_package_basename}.payload",
      "#{current_api_package_basename}.payload.index",
    ]
    api_internal.glob("packages.*.jws.json*").reject do |path|
      kept_basenames.include?(path.basename.to_s)
    end
  else
    []
  end
  api_source_files = (cache/"api-source").glob("*/*/*/**/*").select { |path| path.file? || path.symlink? }
  gh_actions_artifacts = (cache/"gh-actions-artifact").directory? ? (cache/"gh-actions-artifact").children : []

  cache_entries(files, type: nil) +
    cache_entries(cask_files, type: :cask) +
    cache_entries(api_package_files, type: :api_package) +
    cache_entries(api_source_files, type: :api_source) +
    cache_entries(gh_actions_artifacts, type: :gh_actions_artifact)
end

#clean!(quiet: false, periodic: 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:

  • quiet (Boolean) (defaults to: false)
  • periodic (Boolean) (defaults to: false) 


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
515
516
517
518
519
520
521
 
# File 'cleanup.rb', line 449

def clean!(quiet: false, periodic: false)
  require "cask/cask_loader"

  if args.empty?
    Formula.installed
           .sort_by(&:name)
           .reject { |f| Cleanup.skip_clean_formula?(f) }
           .each do |formula|
      # Don't `cleanup_unreferenced` here for each formula.
      # Instead, let it be run once `cleanup_cache` below.
      cleanup_formula(formula, quiet:, ds_store: false, cache_db: false, cleanup_unreferenced: false)
    end

    if periodic
      Cask::Caskroom.casks.sort_by(&:full_name).each do |cask|
        cleanup_cask(cask, ds_store: false, cleanup_legacy_downloads: false, cleanup_unreferenced: false)
      end
    end

    if ENV["HOMEBREW_AUTOREMOVE"].present?
      opoo "`$HOMEBREW_AUTOREMOVE` is now a no-op as it is the default behaviour. " \
           "Set `HOMEBREW_NO_AUTOREMOVE=1` to disable it."
    end
    Cleanup.autoremove(dry_run: dry_run?) unless Homebrew::EnvConfig.no_autoremove?

    cleanup_cache
    cleanup_empty_api_source_directories
    cleanup_bootsnap
    cleanup_logs
    cleanup_temp_cellar
    cleanup_reinstall_kegs
    cleanup_lockfiles
    cleanup_python_site_packages
    prune_prefix_symlinks_and_directories

    unless dry_run?
      cleanup_cache_db
      rm_ds_store
      HOMEBREW_CACHE.mkpath
      FileUtils.touch PERIODIC_CLEAN_FILE
    end

    # Cleaning up Ruby needs to be done last to avoid requiring additional
    # files afterwards. Additionally, don't allow it on periodic cleans to
    # avoid having to try to do a `brew install` when we've just deleted
    # the running Ruby process...
    return if periodic

    cleanup_portable_ruby
  else
    args.each do |arg|
      formula = begin
        Formulary.resolve(arg)
      rescue FormulaUnavailableError, TapFormulaAmbiguityError
        nil
      end

      cask = begin
        Cask::CaskLoader.load(arg)
      rescue Cask::CaskError
        nil
      end

      if formula && Cleanup.skip_clean_formula?(formula)
        onoe "Refusing to clean #{formula} because it is listed in " \
             "#{Tty.bold}HOMEBREW_NO_CLEANUP_FORMULAE#{Tty.reset}!"
      elsif formula
        cleanup_formula(formula)
      end
      cleanup_cask(cask) if cask
    end
  end
end

#cleanup_bootsnap ⇒ 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.



841
842
843
844
845
846
847
848
 
# File 'cleanup.rb', line 841

def cleanup_bootsnap
  bootsnap = cache/"bootsnap"
  return unless bootsnap.directory?

  bootsnap.each_child do |subdir|
    cleanup_path(subdir) { FileUtils.rm_r(subdir) } if subdir.basename.to_s != Homebrew::Bootsnap.key
  end
end

#cleanup_cache(entries = nil, cleanup_unreferenced: true) ⇒ 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:

  • entries (Array<Hash>, nil) (defaults to: nil)
  • cleanup_unreferenced (Boolean) (defaults to: true) 


731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
 
# File 'cleanup.rb', line 731

def cleanup_cache(entries = nil, cleanup_unreferenced: true)
  full_cache_cleanup = entries.nil?
  entries ||= cache_files

  entries.each do |entry|
    path = entry[:path]
    next if path == PERIODIC_CLEAN_FILE

    FileUtils.chmod_R 0755, path if self.class.go_cache_directory?(path) && !dry_run?
    next cleanup_path(path) { path.unlink } if self.class.incomplete?(path)
    next cleanup_path(path) { FileUtils.rm_rf path } if self.class.nested_cache?(path)

    if self.class.prune?(path, days)
      if path.file? || path.symlink?
        cleanup_path(path) { path.unlink }
      elsif path.directory? && path.to_s.include?("--")
        cleanup_path(path) { FileUtils.rm_rf path }
      end
      next
    end

    # If we've specified --prune don't do the (expensive) .stale? check.
    cleanup_path(path) { path.unlink } if !prune? && self.class.stale?(entry, scrub: scrub?)
  end

  cleanup_legacy_cask_downloads(Cask::Caskroom.casks) if full_cache_cleanup
  cleanup_unreferenced_downloads if cleanup_unreferenced
end

#cleanup_cache_db(rack = nil) ⇒ 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:

  • rack (Pathname, nil) (defaults to: nil) 


851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'cleanup.rb', line 851

def cleanup_cache_db(rack = nil)
  FileUtils.rm_rf [
    cache/"desc_cache.json",
    cache/"linkage.db",
    cache/"linkage.db.db",
  ]

  CacheStoreDatabase.use(:linkage) do |db|
    break unless db.created?

    db.each_key do |keg|
      keg = T.cast(keg, String)
      next if rack && !keg.start_with?("#{rack}/")
      next if File.directory?(keg)

      LinkageCacheStore.new(
        keg,
        T.cast(db, CacheStoreDatabase[String, T::Hash[T.any(String, Symbol), T.anything]]),
      ).delete!
    end
  end
end

#cleanup_cache_entries(paths, type:, cleanup_unreferenced: true) ⇒ 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:

  • paths (Array<Pathname>)
  • type (Symbol, nil)
  • cleanup_unreferenced (Boolean) (defaults to: true) 


539
540
541
 
# File 'cleanup.rb', line 539

def cleanup_cache_entries(paths, type:, cleanup_unreferenced: true)
  cleanup_cache(cache_entries(paths, type:), cleanup_unreferenced:)
end

#cleanup_cask(cask, ds_store: true, cleanup_legacy_downloads: true, cleanup_unreferenced: true) ⇒ 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:

  • cask (Cask::Cask)
  • ds_store (Boolean) (defaults to: true)
  • cleanup_legacy_downloads (Boolean) (defaults to: true)
  • cleanup_unreferenced (Boolean) (defaults to: true) 


582
583
584
585
586
587
588
589
 
# File 'cleanup.rb', line 582

def cleanup_cask(cask, ds_store: true, cleanup_legacy_downloads: true, cleanup_unreferenced: true)
  cleanup_cache_entries(Pathname.glob(cache/"Cask/#{cask.token}--*"), type: :cask, cleanup_unreferenced: false)
  cleanup_legacy_cask_downloads([cask]) if cleanup_legacy_downloads
  cleanup_unreferenced_downloads if cleanup_unreferenced

  rm_ds_store([cask.caskroom_path]) if ds_store
  cleanup_lockfiles(CaskLock.new(cask.token).path)
end

#cleanup_empty_api_source_directories(directory = cache/"api-source") ⇒ 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:

  • directory (Pathname) (defaults to: cache/"api-source") 


688
689
690
691
692
693
694
695
696
697
698
 
# File 'cleanup.rb', line 688

def cleanup_empty_api_source_directories(directory = cache/"api-source")
  return if dry_run?
  return unless directory.directory?

  directory.each_child do |child|
    next unless child.directory?

    cleanup_empty_api_source_directories(child)
    child.rmdir if child.empty?
  end
end

#cleanup_formula(formula, quiet: false, ds_store: true, cache_db: true, cleanup_unreferenced: true) ⇒ 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:

  • formula (Formula)
  • quiet (Boolean) (defaults to: false)
  • ds_store (Boolean) (defaults to: true)
  • cache_db (Boolean) (defaults to: true)
  • cleanup_unreferenced (Boolean) (defaults to: true) 


565
566
567
568
569
570
571
572
 
# File 'cleanup.rb', line 565

def cleanup_formula(formula, quiet: false, ds_store: true, cache_db: true, cleanup_unreferenced: true)
  formula.eligible_kegs_for_cleanup(quiet:)
         .each { |keg| cleanup_keg(keg) }
  cleanup_cache_entries(formula_cache_paths(formula), type: nil, cleanup_unreferenced:)
  rm_ds_store([formula.rack]) if ds_store
  cleanup_cache_db(formula.rack) if cache_db
  cleanup_lockfiles(FormulaLock.new(formula.name).path)
end

#cleanup_keg(keg) ⇒ void

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

This method returns an undefined value.

Parameters:



619
620
621
622
623
624
 
# File 'cleanup.rb', line 619

def cleanup_keg(keg)
  cleanup_path(Pathname.new(keg)) { keg.uninstall(raise_failures: true) }
rescue Errno::EACCES, Errno::ENOTEMPTY => e
  opoo e.message
  unremovable_kegs << keg
end

#cleanup_legacy_cask_downloads(casks) ⇒ 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.

Added 2026-07-05 for legacy cask cache symlinks named after URL basenames. Remove after 2026-11-02, once the 120-day fallback stale-file sweep has had time to prune stale files created before cask downloads were token-named.

Parameters:



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'cleanup.rb', line 595

def cleanup_legacy_cask_downloads(casks)
  cask_cache = cache/"Cask"
  return unless cask_cache.directory?

  cask_cache_paths = cask_cache.children.select { |path| path.file? || path.symlink? }

  casks.each do |cask|
    next unless (url = cask.url)

    legacy_download_name = Utils.safe_filename(File.basename(url.to_s))
    next if legacy_download_name.blank? || legacy_download_name == cask.token

    cask_cache_paths.each do |path|
      next unless path.basename.to_s.start_with?("#{legacy_download_name}--")
      next if !self.class.stale_cask_download?(path, cask, legacy_download_name, scrub: scrub?) &&
              (!self.class.cask_cache_file_current?(path, cask, legacy_download_name) ||
               !(cask_cache/Utils.safe_filename("#{cask.token}--#{cask.version}#{path.extname}")).exist?)

      cleanup_path(path) { path.unlink }
    end
  end
end

#cleanup_lockfiles(*lockfiles) ⇒ 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:



776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'cleanup.rb', line 776

def cleanup_lockfiles(*lockfiles)
  return if dry_run?

  lockfiles = HOMEBREW_LOCKS.children.select(&:file?) if lockfiles.empty? && HOMEBREW_LOCKS.directory?

  lockfiles.each do |file|
    next unless file.readable?

    file.open(File::RDWR) do |lockfile|
      next unless lockfile.flock(File::LOCK_EX | File::LOCK_NB)

      begin
        file.unlink
      ensure
        lockfile.flock(File::LOCK_UN) if file.exist?
      end
    end
  end
end

#cleanup_logs ⇒ 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.



627
628
629
630
631
632
633
634
635
 
# File 'cleanup.rb', line 627

def cleanup_logs
  return unless HOMEBREW_LOGS.directory?

  logs_days = [days, CLEANUP_DEFAULT_DAYS].min

  HOMEBREW_LOGS.subdirs.each do |dir|
    cleanup_path(dir) { FileUtils.rm_r(dir) } if self.class.prune?(dir, logs_days)
  end
end

#cleanup_path(path, &_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:



761
762
763
764
765
766
767
768
769
770
771
772
773
 
# File 'cleanup.rb', line 761

def cleanup_path(path, &_block)
  return if !path.exist? && !path.symlink?
  return unless @cleaned_up_paths.add?(path)

  @disk_cleanup_size += path.disk_usage

  if dry_run?
    @output.puts "Would remove: #{path} (#{path.abv})"
  else
    @output.puts "Removing: #{path}... (#{path.abv})"
    yield
  end
end

#cleanup_portable_ruby ⇒ 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.



797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
 
# File 'cleanup.rb', line 797

def cleanup_portable_ruby
  vendor_dir = HOMEBREW_LIBRARY/"Homebrew/vendor"
  portable_ruby_latest_version = (vendor_dir/"portable-ruby-version").read.chomp

  portable_rubies_to_remove = []
  Pathname.glob(vendor_dir/"portable-ruby/*.*").select(&:directory?).each do |path|
    next if !use_system_ruby? && portable_ruby_latest_version == path.basename.to_s

    portable_rubies_to_remove << path
  end

  return if portable_rubies_to_remove.empty?

  bundler_paths = (vendor_dir/"bundle/ruby").children.select do |child|
    basename = child.basename.to_s

    next false if basename == ".homebrew_gem_groups"
    next true unless child.directory?

    [
      "#{Version.new(portable_ruby_latest_version).major_minor}.0",
      RbConfig::CONFIG["ruby_version"],
    ].uniq.exclude?(basename)
  end

  bundler_paths.each do |bundler_path|
    if dry_run?
      puts Utils.popen_read("git", "-C", HOMEBREW_REPOSITORY, "clean", "-nx", bundler_path).chomp
    else
      puts Utils.popen_read("git", "-C", HOMEBREW_REPOSITORY, "clean", "-ffqx", bundler_path).chomp
    end
  end

  portable_rubies_to_remove.each do |portable_ruby|
    cleanup_path(portable_ruby) { FileUtils.rm_r(portable_ruby) }
  end
end

#cleanup_python_site_packages ⇒ 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.



890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
 
# File 'cleanup.rb', line 890

def cleanup_python_site_packages
  pyc_files = Hash.new { |h, k| h[k] = [] }
  seen_non_pyc_file = Hash.new { |h, k| h[k] = false }
  unused_pyc_files = []

  HOMEBREW_PREFIX.glob("lib/python*/site-packages").each do |site_packages|
    site_packages.each_child do |child|
      next unless child.directory?
      # TODO: Work out a sensible way to clean up `pip`'s, `setuptools`' and `wheel`'s
      #       `{dist,site}-info` directories. Alternatively, consider always removing
      #       all `-info` directories, because we may not be making use of them.
      next if child.basename.to_s.end_with?("-info")

      # Clean up old *.pyc files in the top-level __pycache__.
      if child.basename.to_s == "__pycache__"
        child.find do |path|
          next if path.extname != ".pyc"
          next unless self.class.prune?(path, days)

          unused_pyc_files << path
        end

        next
      end

      # Look for directories that contain only *.pyc files.
      child.find do |path|
        next if path.directory?

        if path.extname == ".pyc"
          pyc_files[child] << path
        else
          seen_non_pyc_file[child] = true
          break
        end
      end
    end
  end

  unused_pyc_files += pyc_files.reject { |k,| seen_non_pyc_file[k] }
                               .values
                               .flatten
  return if unused_pyc_files.blank?

  unused_pyc_files.each do |pyc|
    cleanup_path(pyc) { pyc.unlink }
  end
end

#cleanup_reinstall_kegs ⇒ 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.



647
648
649
650
651
652
653
 
# File 'cleanup.rb', line 647

def cleanup_reinstall_kegs
  return unless HOMEBREW_CELLAR.directory?

  HOMEBREW_CELLAR.glob("*/*.reinstall").each do |reinstall_keg|
    cleanup_path(reinstall_keg) { FileUtils.rm_r(reinstall_keg) }
  end
end

#cleanup_temp_cellar ⇒ 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.



638
639
640
641
642
643
644
 
# File 'cleanup.rb', line 638

def cleanup_temp_cellar
  return unless HOMEBREW_TEMP_CELLAR.directory?

  HOMEBREW_TEMP_CELLAR.each_child do |child|
    cleanup_path(child) { FileUtils.rm_r(child) }
  end
end

#cleanup_unreferenced_downloads ⇒ 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.



701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'cleanup.rb', line 701

def cleanup_unreferenced_downloads
  return if dry_run?
  return unless (cache/"downloads").directory?

  downloads = (cache/"downloads").children

  referenced_downloads = cache_files.map { |file| file[:path] }.select(&:symlink?).map(&:resolved_path)

  (downloads - referenced_downloads).each do |download|
    if self.class.incomplete?(download)
      begin
        DownloadLock.new(download).with_lock do
          download.unlink
        end
      rescue OperationInProgressError
        # Skip incomplete downloads which are still in progress.
        next
      end
    elsif download.directory?
      FileUtils.rm_rf download
    else
      download.unlink
    end
  end
end

#dry_run? ⇒ 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) 


291
 
# File 'cleanup.rb', line 291

def dry_run? = @dry_run

#formula_cache_paths(formula) ⇒ 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.

Returns the cached <formula>--<version> and <formula>_bottle_manifest--<version> downloads for a formula. Globbing these per formula rescans the entire cache each time, which is quadratic for brew cleanup, so index the cache by name prefix once instead.

Parameters:

Returns:



548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'cleanup.rb', line 548

def formula_cache_paths(formula)
  return [] unless cache.directory?

  index = @formula_cache_paths ||= cache.children.each_with_object({}) do |path, hash|
    prefix, separator, = path.basename.to_s.partition("--")
    next if prefix.start_with?(".") || separator.empty?

    (hash[prefix] ||= []) << path
  end

  [*index.fetch(formula.name, []), *index.fetch("#{formula.name}_bottle_manifest", [])].sort
end

#prune? ⇒ 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) 


294
 
# File 'cleanup.rb', line 294

def prune? = @prune

#prune_prefix_symlinks_and_directories ⇒ 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.



940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'cleanup.rb', line 940

def prune_prefix_symlinks_and_directories
  ObserverPathnameExtension.reset_counts!

  dirs = []
  children_count = {}

  Keg.must_exist_subdirectories.each do |dir|
    next unless dir.directory?

    dir.find do |path|
      path.extend(ObserverPathnameExtension)
      if path.symlink?
        unless path.resolved_path_exists?
          path.uninstall_info if path.to_s.match?(Keg::INFOFILE_RX) && !dry_run?

          if dry_run?
            puts "Would remove (broken link): #{path}"
            children_count[path.dirname] -= 1 if children_count.key?(path.dirname)
          else
            path.unlink
          end
        end
      elsif path.directory? && Keg.must_exist_subdirectories.exclude?(path)
        dirs << path
        children_count[path] = path.children.length if dry_run?
      end
    end
  end

  dirs.reverse_each do |d|
    if !dry_run?
      d.rmdir_if_possible
    elsif children_count[d].zero?
      puts "Would remove (empty directory): #{d}"
      children_count[d.dirname] -= 1 if children_count.key?(d.dirname)
    end
  end

  require "cask/caskroom"
  if Cask::Caskroom.path.directory?
    Cask::Caskroom.path.each_child do |path|
      path.extend(ObserverPathnameExtension)
      next if !path.symlink? || path.resolved_path_exists?

      if dry_run?
        puts "Would remove (broken link): #{path}"
      else
        path.unlink
      end
    end
  end

  return if dry_run?

  return if ObserverPathnameExtension.total.zero?

  n, d = ObserverPathnameExtension.counts
  print "Pruned #{n} symbolic links "
  print "and #{d} directories " if d.positive?
  puts "from #{HOMEBREW_PREFIX}"
end

#rm_ds_store(dirs = nil) ⇒ 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:



875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'cleanup.rb', line 875

def rm_ds_store(dirs = nil)
  dirs ||= Keg.must_exist_directories + [
    HOMEBREW_PREFIX/"Caskroom",
  ]
  dirs.select(&:directory?)
      .flat_map { |d| Pathname.glob("#{d}/**/.DS_Store") }
      .each do |dir|
        dir.unlink
      rescue Errno::EACCES
        # don't care if we can't delete a .DS_Store
        nil
      end
end

#scrub? ⇒ 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) 


297
 
# File 'cleanup.rb', line 297

def scrub? = @scrub

#unremovable_kegs ⇒ Array<Keg>

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:



524
525
526
 
# File 'cleanup.rb', line 524

def unremovable_kegs
  @unremovable_kegs ||= T.let([], T.nilable(T::Array[Keg]))
end

#use_system_ruby? ⇒ 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) 


836
837
838
 
# File 'cleanup.rb', line 836

def use_system_ruby?
  false
end