Class: Homebrew::Cleanup

Inherits:
Object
  • Object
show all
Extended by:
Predicable
Defined in:
brew/Library/Homebrew/cleanup.rb

Constant Summary collapse

PERIODIC_CLEAN_FILE =
(HOMEBREW_CACHE/".cleaned").freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Predicable

attr_predicate

Constructor Details

#initialize(*args, dry_run: false, scrub: false, days: nil, cache: HOMEBREW_CACHE) ⇒ Cleanup

Returns a new instance of Cleanup



130
131
132
133
134
135
136
137
138
# File 'brew/Library/Homebrew/cleanup.rb', line 130

def initialize(*args, dry_run: false, scrub: false, days: nil, cache: HOMEBREW_CACHE)
  @disk_cleanup_size = 0
  @args = args
  @dry_run = dry_run
  @scrub = scrub
  @days = days || CLEANUP_MAX_AGE_DAYS
  @cache = cache
  @cleaned_up_paths = Set.new
end

Instance Attribute Details

#argsObject (readonly)

Returns the value of attribute args



127
128
129
# File 'brew/Library/Homebrew/cleanup.rb', line 127

def args
  @args
end

#cacheObject (readonly)

Returns the value of attribute cache



127
128
129
# File 'brew/Library/Homebrew/cleanup.rb', line 127

def cache
  @cache
end

#daysObject (readonly)

Returns the value of attribute days



127
128
129
# File 'brew/Library/Homebrew/cleanup.rb', line 127

def days
  @days
end

#disk_cleanup_sizeObject (readonly)

Returns the value of attribute disk_cleanup_size



128
129
130
# File 'brew/Library/Homebrew/cleanup.rb', line 128

def disk_cleanup_size
  @disk_cleanup_size
end

Class Method Details

.install_formula_clean!(f) ⇒ Object



140
141
142
143
144
145
146
147
148
149
# File 'brew/Library/Homebrew/cleanup.rb', line 140

def self.install_formula_clean!(f)
  return if ENV["HOMEBREW_NO_INSTALL_CLEANUP"]

  cleanup = Cleanup.new
  if cleanup.periodic_clean_due?
    cleanup.periodic_clean!
  elsif f.installed?
    cleanup.cleanup_formula(f)
  end
end

Instance Method Details

#clean!(quiet: false, periodic: false) ⇒ Object



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

def clean!(quiet: false, periodic: false)
  if args.empty?
    Formula.installed.sort_by(&:name).each do |formula|
      cleanup_formula(formula, quiet: quiet)
    end
    cleanup_cache
    cleanup_logs
    cleanup_lockfiles
    prune_prefix_symlinks_and_directories

    unless dry_run?
      cleanup_old_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, TapFormulaWithOldnameAmbiguityError
        nil
      end

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

      cleanup_formula(formula) if formula
      cleanup_cask(cask) if cask
    end
  end
end

#cleanup_cache(entries = nil) ⇒ Object



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'brew/Library/Homebrew/cleanup.rb', line 277

def cleanup_cache(entries = nil)
  entries ||= [cache, cache/"Cask"].select(&:directory?).flat_map(&:children)

  entries.each do |path|
    next if path == PERIODIC_CLEAN_FILE

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

    if path.prune?(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

    next cleanup_path(path) { path.unlink } if path.stale?(scrub?)
  end

  cleanup_unreferenced_downloads
end

#cleanup_cask(cask) ⇒ Object



221
222
223
224
225
# File 'brew/Library/Homebrew/cleanup.rb', line 221

def cleanup_cask(cask)
  cleanup_cache(Pathname.glob(cache/"Cask/#{cask.token}--*"))
  rm_ds_store([cask.caskroom_path])
  cleanup_lockfiles(CaskLock.new(cask.token).path)
end

#cleanup_formula(formula, quiet: false) ⇒ Object



213
214
215
216
217
218
219
# File 'brew/Library/Homebrew/cleanup.rb', line 213

def cleanup_formula(formula, quiet: false)
  formula.eligible_kegs_for_cleanup(quiet: quiet)
         .each(&method(:cleanup_keg))
  cleanup_cache(Pathname.glob(cache/"#{formula.name}--*"))
  rm_ds_store([formula.rack])
  cleanup_lockfiles(FormulaLock.new(formula.name).path)
end

#cleanup_keg(keg) ⇒ Object



227
228
229
230
231
232
# File 'brew/Library/Homebrew/cleanup.rb', line 227

def cleanup_keg(keg)
  cleanup_path(keg) { keg.uninstall }
rescue Errno::EACCES => e
  opoo e.message
  unremovable_kegs << keg
end

#cleanup_lockfiles(*lockfiles) ⇒ Object



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
# File 'brew/Library/Homebrew/cleanup.rb', line 317

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?
    next unless file.open(File::RDWR).flock(File::LOCK_EX | File::LOCK_NB)

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

#cleanup_logsObject



234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'brew/Library/Homebrew/cleanup.rb', line 234

def cleanup_logs
  return unless HOMEBREW_LOGS.directory?

  logs_days = if days > CLEANUP_DEFAULT_DAYS
    CLEANUP_DEFAULT_DAYS
  else
    days
  end

  HOMEBREW_LOGS.subdirs.each do |dir|
    cleanup_path(dir) { dir.rmtree } if dir.prune?(logs_days)
  end
end

#cleanup_old_cache_dbObject



372
373
374
375
376
377
378
# File 'brew/Library/Homebrew/cleanup.rb', line 372

def cleanup_old_cache_db
  FileUtils.rm_rf [
    cache/"desc_cache.json",
    cache/"linkage.db",
    cache/"linkage.db.db",
  ]
end

#cleanup_path(path) ⇒ Object



302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'brew/Library/Homebrew/cleanup.rb', line 302

def cleanup_path(path)
  return unless @cleaned_up_paths.add?(path)

  disk_usage = path.disk_usage

  if dry_run?
    puts "Would remove: #{path} (#{path.abv})"
    @disk_cleanup_size += disk_usage
  else
    puts "Removing: #{path}... (#{path.abv})"
    yield
    @disk_cleanup_size += disk_usage - path.disk_usage
  end
end

#cleanup_portable_rubyObject



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
# File 'brew/Library/Homebrew/cleanup.rb', line 334

def cleanup_portable_ruby
  system_ruby_version =
    Utils.popen_read("/usr/bin/ruby", "-e", "puts RUBY_VERSION")
         .chomp
  use_system_ruby = (
    Gem::Version.new(system_ruby_version) >= Gem::Version.new(RUBY_VERSION)
  ) && ENV["HOMEBREW_FORCE_VENDOR_RUBY"].nil?
  vendor_path = HOMEBREW_LIBRARY/"Homebrew/vendor"
  portable_ruby_version_file = vendor_path/"portable-ruby-version"
  portable_ruby_version = if portable_ruby_version_file.exist?
    portable_ruby_version_file.read
                              .chomp
  end

  portable_ruby_path = vendor_path/"portable-ruby"
  portable_ruby_glob = "#{portable_ruby_path}/*.*"
  Pathname.glob(portable_ruby_glob).each do |path|
    next if !use_system_ruby && portable_ruby_version == path.basename.to_s

    if dry_run?
      puts "Would remove: #{path} (#{path.abv})"
    else
      FileUtils.rm_rf path
    end
  end

  return unless Dir.glob(portable_ruby_glob).empty?
  return unless portable_ruby_path.exist?

  bundler_path = vendor_path/"bundle/ruby"
  if dry_run?
    puts "Would remove: #{bundler_path} (#{bundler_path.abv})"
    puts "Would remove: #{portable_ruby_path} (#{portable_ruby_path.abv})"
  else
    FileUtils.rm_rf [bundler_path, portable_ruby_path]
  end
end

#cleanup_unreferenced_downloadsObject



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 'brew/Library/Homebrew/cleanup.rb', line 248

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

  downloads = (cache/"downloads").children

  referenced_downloads = [cache, cache/"Cask"].select(&:directory?)
                                              .flat_map(&:children)
                                              .select(&:symlink?)
                                              .map(&:resolved_path)

  (downloads - referenced_downloads).each do |download|
    if download.incomplete?
      begin
        LockFile.new(download.basename).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

#periodic_clean!Object



158
159
160
161
162
163
# File 'brew/Library/Homebrew/cleanup.rb', line 158

def periodic_clean!
  return false unless periodic_clean_due?

  ohai "`brew cleanup` has not been run in #{CLEANUP_DEFAULT_DAYS} days, running now..."
  clean!(quiet: true, periodic: true)
end

#periodic_clean_due?Boolean

Returns:

  • (Boolean)


151
152
153
154
155
156
# File 'brew/Library/Homebrew/cleanup.rb', line 151

def periodic_clean_due?
  return false if ENV["HOMEBREW_NO_INSTALL_CLEANUP"]
  return true unless PERIODIC_CLEAN_FILE.exist?

  PERIODIC_CLEAN_FILE.mtime < CLEANUP_DEFAULT_DAYS.days.ago
end


393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
# File 'brew/Library/Homebrew/cleanup.rb', line 393

def prune_prefix_symlinks_and_directories
  ObserverPathnameExtension.reset_counts!

  dirs = []

  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?
          if path.to_s =~ Keg::INFOFILE_RX
            path.uninstall_info unless dry_run?
          end

          if dry_run?
            puts "Would remove (broken link): #{path}"
          else
            path.unlink
          end
        end
      elsif path.directory? && !Keg::MUST_EXIST_SUBDIRECTORIES.include?(path)
        dirs << path
      end
    end
  end

  dirs.reverse_each do |d|
    if dry_run? && d.children.empty?
      puts "Would remove (empty directory): #{d}"
    else
      d.rmdir_if_possible
    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) ⇒ Object



380
381
382
383
384
385
386
387
388
389
390
391
# File 'brew/Library/Homebrew/cleanup.rb', line 380

def rm_ds_store(dirs = nil)
  dirs ||= begin
    Keg::MUST_EXIST_DIRECTORIES + [
      HOMEBREW_PREFIX/"Caskroom",
    ]
  end
  dirs.select(&:directory?).each do |dir|
    system_command "find",
                   args:         [dir, "-name", ".DS_Store", "-delete"],
                   print_stderr: false
  end
end

#unremovable_kegsObject



209
210
211
# File 'brew/Library/Homebrew/cleanup.rb', line 209

def unremovable_kegs
  @unremovable_kegs ||= []
end