brew-rmtree.rb

#:
#:  * `rmtree` [`--force`] [`-n`|`--dry-run`] [`--quiet`] [`--ignore=`formulaX,formulaY] formula1 [formula2] [formula3]...
#:
#:    Remove a formula entirely, including all of its dependencies,
#:    unless of course, they are used by another formula.
#:
#:    Warning:
#:
#:      Not all formulae declare their dependencies and therefore this command may end
#:      up removing something you still need. It should be used with caution.
#:
#:    With `--force`, you can override the dependency check for the top-level formula you
#:    are trying to remove. If you try to remove 'ruby' for example, you most likely will
#:    not be able to do this because other fomulae specify this as a dependency. This
#:    option will let you remove 'ruby'. This will NOT bypass dependency checks for the
#:    formula's children. If 'ruby' depends on 'git', then 'git' will still not be removed.
#:
#:    With `--ignore`, you can ignore some dependencies from being removed.
#:
#:    You can use `--dry-run` (alias `-n`) to see what would be removed without
#:    actually removing anything.
#:
#:    `--quiet` will hide output.
#:
#:    `brew rmtree` <formula>
#:    Removes <formula> and its dependencies.
#:
#:    `brew rmtree` <formula> <formula2>
#:    Removes <formula> and <formula2> and their dependencies.
#:
#:    `brew rmtree` --force <formula>
#:    Force the removal of <formula> even if other formulae depend on it.
#:
#:    `brew rmtree` --ignore=<formula2> <formula>
#:    Remove <formula>, but don't remove its dependency of <formula2>

require 'keg'
require 'formula'
require 'formulary'
require 'dependencies'
require 'shellwords'
require 'set'
require 'pathname'
require 'cmd/deps'
require 'cmd/uses'
require 'cli/parser'

# I am not a ruby-ist and so my style may offend some

module BrewRmtree

  @dry_run = false
  @used_by_table = {}
  @dependency_table = {}

  module_function

  def bash(command)
    escaped_command = Shellwords.escape(command)
    return %x! bash -c #{escaped_command} !
  end

  # Find the path to the currently running version of homebrew
  # Fixes #46
  def brew_path()
    brew_home = Pathname.new(ENV["HOMEBREW_PREFIX"])
    if brew_home.directory?
      brew_bin = brew_home / "bin/brew"
      if brew_bin.executable?
        return brew_bin.realpath
      end
    end
    return "brew"
  end

  # replaces Kernel#puts w/ do-nothing method
  def puts_off
    Kernel.module_eval %q{
      def puts(*args)
      end
      def print(*args)
      end
    }
  end

  # restores Kernel#puts to its original definition
  def puts_on
    Kernel.module_eval %q{
      def puts(*args)
        $stdout.puts(*args)
      end
      def print(*args)
        $stdout.print(*args)
      end
    }
  end

  # Sets the text to output with the spinner
  def set_spinner_progress(txt)
    @spinner[:progress] = txt
  end

  def show_wait_spinner(fps=10)
    chars = %w[| / - \\]
    delay = 1.0/fps
    iter = 0
    @spinner = Thread.new do
      Thread.current[:progress] = ""
      progress_size = 0
      while iter do  # Keep spinning until told otherwise
        print ' ' + chars[(iter+=1) % chars.length] + Thread.current[:progress]
        progress_size = Thread.current[:progress].length
        sleep delay
        print "\b"*(progress_size + 2)
      end
    end
    yield.tap{       # After yielding to the block, save the return value
      iter = false   # Tell the thread to exit, cleaning up after itself…
      @spinner.join   # …and wait for it to do so.
    }                # Use the block's return value as the method's
  end

  # Remove a particular keg
  def remove_keg(keg_name, dry_run)
    if dry_run
      puts "Would have removed #{keg_name}"
      return
    end

    # Remove old versions of keg
    puts bash "#{brew_path} cleanup #{keg_name} 2>/dev/null"

    # Remove current keg
    puts bash "#{brew_path} uninstall #{keg_name}"
  end

  # A list of dependencies of keg_name that are still installed after removal
  # of the keg
  def orphaned_dependencies(keg_name)
    bash("join <(sort <(#{brew_path} leaves)) <(sort <(#{brew_path} deps #{keg_name}))").split("\n")
  end

  # A list of kegs that use keg_name, using homebrew code instead of shell cmd
  def uses(keg_name, recursive=true, ignores=[], args:)
    # https://raw.githubusercontent.com/Homebrew/brew/master/Library/Homebrew/cmd/uses.rb
    formulae = [Formulary.factory(keg_name)]
    uses = Formula.installed.select do |f|
      formulae.all? do |ff|
        begin
          if recursive
            deps = f.recursive_dependencies do |dependent, dep|
              if dep.recommended?
                Dependency.prune if ignores.include?("recommended?") || dependent.build.without?(dep)
              elsif dep.optional?
                Dependency.prune if !includes.include?("optional?") && !dependent.build.with?(dep)
              elsif dep.build?
                Dependency.prune unless includes.include?("build?")
              end

              # If a tap isn't installed, we can't find the dependencies of one
              # its formulae, and an exception will be thrown if we try.
              if dep.is_a?(TapDependency) && !dep.tap.installed?
                Dependency.keep_but_prune_recursive_deps
              end
            end

            dep_formulae = deps.flat_map do |dep|
              begin
                dep.to_formula
              rescue
                []
              end
            end

            reqs_by_formula = ([f] + dep_formulae).flat_map do |formula|
              formula.requirements.map { |req| [formula, req] }
            end

            reqs_by_formula.reject! do |dependent, req|
              if req.recommended?
                ignores.include?("recommended?") || dependent.build.without?(req)
              elsif req.optional?
                !includes.include?("optional?") && !dependent.build.with?(req)
              elsif req.build?
                !includes.include?("build?")
              end
            end

            reqs = reqs_by_formula.map(&:last)
          else
            includes, ignores = Homebrew.args_includes_ignores(Homebrew.uses_args.parse)
            deps = f.deps.reject do |dep|
              ignores.any? { |ignore| dep.send(ignore) } && includes.none? { |include| dep.send(include) }
            end
            # deps.reject! do |dep|
            #   # Exclude build dependencies or not required and can be built without it
            #   dep.build? || (!dep.required? && as_formula(dep.name).build.without?(dep))
            # end
            reqs = f.requirements.reject do |req|
              ignores.any? { |ignore| req.send(ignore) } && includes.none? { |include| req.send(include) }
            end
          end
          next true if deps.any? do |dep|
            begin
              dep.to_formula.full_name == ff.full_name
            rescue
              dep.name == ff.name
            end
          end

          reqs.any? { |req| req.name == ff.name }
        rescue FormulaUnavailableError
          # Silently ignore this case as we don't care about things used in
          # taps that aren't currently tapped.
          next
        end
      end
    end
    uses.map(&:full_name)
  end

  def deps_for_formula(f, args:)
    # https://github.com/Homebrew/brew/blob/d1b83819deacd99b55c9d400149dc9b49fa795df/Library/Homebrew/cmd/deps.rb#L137
    includes, ignores = Homebrew.args_includes_ignores(Homebrew.uses_args.parse)

    deps = f.runtime_dependencies
    reqs = Homebrew.reject_ignores(f.requirements, ignores, includes)

    deps + reqs.to_a
  end

  # Gather complete list of packages used by root package
  def dependency_tree(keg_name, recursive=true, args:)
    deps_for_formula(as_formula(keg_name), args: args
      ).map{ |x| as_formula(x) }
      .reject{ |x| x.nil? }
      .select(&:any_version_installed?
      )
  end

  # Returns a set of dependencies as their keg name
  def dependency_tree_as_keg_names(keg_name, recursive=true, args:)
    @dependency_table[keg_name] ||= dependency_tree(keg_name, recursive, args: args).map!(&:name)
  end

  # Return a formula for keg_name
  def as_formula(keg_name)
    if keg_name.is_a? Dependency
      return find_active_formula(keg_name.name)
    end
    if keg_name.is_a? Requirement
      begin
        return find_active_formula(keg_name.to_dependency.name)
      rescue
        return nil
      end
    end
    return find_active_formula(keg_name)
  end

  # Given a formula name, find the formula for the active version.
  # Default formulae are for the latest version which may not be installed causing issue #28.
  def find_active_formula(name)
    latest_formula = Formulary.factory(name)
    active_version = latest_formula.linked_version
    active_prefix = latest_formula.installed_prefixes.last
    begin
      return Formulary.factory("#{active_prefix}/.brew/#{name}.rb")
    rescue
      return latest_formula
    end
  end

  def used_by(dep_name, del_formula, args:)
    @used_by_table[dep_name] ||= uses(dep_name, false, args: args).to_set.delete(del_formula.full_name)
  end

  # Return list of installed formula that will still use this dependency
  # after deletion and thus cannot be removed.
  def still_used_by(dep_name, del_formula, full_dep_list, args:)
    # List of formulae that use this keg and aren't in the tree
    # of dependencies to be removed
    return used_by(dep_name, del_formula, args: args).subtract(full_dep_list)
  end

  def cant_remove(dep_set)
    !dep_set.empty?
  end

  def can_remove(dep_set)
    dep_set.empty?
  end

  def removable_in_tree(tree)
    tree.select {|dep,used_by_set| can_remove(used_by_set)}
  end

  def unremovable_in_tree(tree)
    tree.select {|dep,used_by_set| cant_remove(used_by_set)}
  end

  def describe_build_tree_will_remove(tree)
    will_remove = removable_in_tree(tree)

    puts ""
    puts "Can safely be removed"
    puts "----------------------"
    puts will_remove.map { |dep,_| dep }.sort.join("\n")
  end

  def describe_build_tree_wont_remove(tree)
    wont_remove = unremovable_in_tree(tree)

    puts ""
    puts "Won't be removed"
    puts "-----------------"
    puts wont_remove.map { |dep,used_by| "#{dep} is used by #{used_by.to_a.join(', ')}" }.sort.join("\n")
  end

  # Print out interpretation of dependency analysis
  def describe_build_tree(tree)
    describe_build_tree_will_remove(tree)
    describe_build_tree_wont_remove(tree)
  end

  # Simple prompt helper
  def should_proceed(prompt)
    input = [(print "#{prompt}[y/N]: "), STDIN.gets.chomp()][1]
    if ['y', 'yes'].include?(input.downcase)
      return true
    end
    return false
  end

  def should_proceed_or_quit(prompt)
    puts ""
    unless should_proceed(prompt)
      puts ""
      onoe "User quit"
      exit 0
    end
    return true
  end

  # Will mark any children and parents of dep as unremovable if dep is unremovable
  def revisit_neighbors(of_dependency, del_formula, dep_set, wont_remove_because, args:)
    # Prevent subsequent related formula from being flagged for removal
    dep_set.delete(of_dependency)

    # Update users of the dependency
    used_by(of_dependency, del_formula, args: args).each do |user_of_d|
      # Only update those we visited and think we can remove
      if wont_remove_because.has_key? user_of_d and can_remove(wont_remove_because[user_of_d])
        wont_remove_because[user_of_d] << of_dependency
        revisit_neighbors(user_of_d, del_formula, dep_set, wont_remove_because, args: args)
      end
    end

    # Update dependencies of the dependency
    dependency_tree_as_keg_names(of_dependency, false, args: args).each do |d|
      # Only update those we visited and think we can remove
      if wont_remove_because.has_key? d and can_remove(wont_remove_because[d])
        wont_remove_because[d] << of_dependency
        revisit_neighbors(d, del_formula, dep_set, wont_remove_because, args: args)
      end
    end
  end

  # Walk the tree and decide which ones are safe to remove
  def build_tree(keg_name, ignored_kegs=[], args: )
    # List used to save the status of all dependency packages
    wont_remove_because = {}

    ohai "Examining installed formulae required by #{keg_name}..."
    show_wait_spinner{

      # Convert the keg_name the user provided into homebrew formula
      f = as_formula(keg_name)

      # Get the complete list of dependencies and convert it to just keg names
      dep_arr = dependency_tree_as_keg_names(keg_name, args: args)
      dep_set = dep_arr.to_set

      # For each possible dependency that we want to remove, check if anything
      # uses it, which is not also in the list of dependencies. That means it
      # isn't safe to remove.
      dep_arr.each do |dep|

        # Set the progress text for spinner thread
        set_spinner_progress "  #{wont_remove_because.size} / #{dep_arr.length} "

        # Save the list of formulae that use this keg and aren't in the tree
        # of dependencies to be removed
        wont_remove_because[dep] = still_used_by(dep, f, dep_set, args: args)

        # Allow user to keep dependencies that aren't used anymore by saying
        # something phony uses it
        if ignored_kegs.include?(dep)
          if wont_remove_because[dep].empty?
            wont_remove_because[dep] << "ignored"
          end
        end

        # Revisit any formulae already visited and related to this dependency
        # because at the time they didn't have this new information
        if cant_remove(wont_remove_because[dep])
          # This dependency can't be removed. Users and dependencies need to be reconsidered.
          revisit_neighbors(dep, f, dep_set, wont_remove_because, args: args)
        end

        set_spinner_progress "  #{wont_remove_because.size} / #{dep_arr.length} "
      end
    }
    print "\n"
    return wont_remove_because
  end

  def order_to_be_removed_v2(start_from, wont_remove_because, args:)
    # Maintain stuff we delete
    deleted_formulae = [start_from]

    # Stuff we *should* be able to delete, albeit using faulty logic from before
    maybe_dependencies_to_delete = removable_in_tree(wont_remove_because).map { |d,_| d }

    # Keep deleting things that we *think* we can delete. As we go through the list,
    # more things should become deletable. But when no new things become deletable,
    # then we are done. This is hacky logic v2
    last_size = 0
    while maybe_dependencies_to_delete.size != last_size
      last_size = maybe_dependencies_to_delete.size
      maybe_dependencies_to_delete.each do |dep|
        _used_by = uses(dep, false, args: args).to_set.subtract(deleted_formulae.to_set)
        # puts "Deleted formulae are #{deleted_formulae.inspect()}"
        # puts "#{dep} is used by #{_used_by.inspect()}"
        if _used_by.size == 0
          deleted_formulae << dep
          maybe_dependencies_to_delete.delete dep
        end
      end
    end

    return deleted_formulae, maybe_dependencies_to_delete
  end

  def rmtree(keg_name, force=false, ignored_kegs=[], args:)
    # Does anything use keg such that we can't remove it?
    if !force
      keg_used_by = uses(keg_name, false, args: args)
      if !keg_used_by.empty?
        puts "#{keg_name} can't be removed because other formula depend on it:"
        puts keg_used_by.join(", ")
        return
      end
    end

    # Check if the formula is installed (outdated implies installed)
    unless as_formula(keg_name).any_version_installed? || as_formula(keg_name).outdated?
      onoe "#{keg_name} is not currently installed"
      return
    end

    # Dependency list of what can be removed, and what can't, and why
    wont_remove_because = build_tree(keg_name, ignored_kegs, args: args)

    kegs_to_delete_in_order, maybe_dependencies_to_delete = order_to_be_removed_v2(keg_name, wont_remove_because, 
    args: args)

    # Dry run print out more information on what will happen
    if @dry_run
      # describe_build_tree(wont_remove_because)

      puts ""
      puts "Can safely be removed"
      puts "----------------------"
      kegs_to_delete_in_order.each do |k|
        puts k
      end
      
      describe_build_tree_wont_remove(wont_remove_because)
      if @dry_run
        maybe_dependencies_to_delete.each do |dep|
          _used_by = uses(dep, false, args: args).to_set.subtract(kegs_to_delete_in_order)
          puts "#{dep} is used by #{_used_by.to_a.join(', ')}"
        end
      end

      puts ""
      puts "Order of operations"
      puts "-------------------"
      puts kegs_to_delete_in_order
    else
      # Confirm with user packages that can and will be removed
      # describe_build_tree_will_remove(wont_remove_because)

      puts ""
      puts "Can safely be removed"
      puts "----------------------"
      kegs_to_delete_in_order.each do |k|
        puts k
      end

      should_proceed_or_quit("Proceed?")

      ohai "Cleaning up packages safe to remove"
    end

    # Remove packages
    # remove_keg(keg_name, @dry_run)
    #removable_in_tree(wont_remove_because).map { |d,_| remove_keg(d, @dry_run) }
    kegs_to_delete_in_order.each { |d| remove_keg(d, @dry_run) }
  end

  def rmtree_args
    Homebrew::CLI::Parser.new do
      usage_banner <<~EOS
      `rmtree` [<options>] [<formula>]

      Remove a formula entirely, including all of its dependencies, unless of course, 
      they are used by another formula.
         
      Warning:
        Not all formulae declare their dependencies and therefore this command may end
        up removing something you still need. It should be used with caution.
      EOS
      switch "--quiet",
             description: "Hide output."
      switch "-n", "--dry-run",
             description: "See what would be removed without actually removing anything."
      switch "--force",
             description: "Force the removal of <formula> even if other formulae depend on it. " +
             "You can override the dependency check for the top-level formula you " +
             "are trying to remove. \nFor example, if you try to remove 'ruby', you most likely will " +
             "not be able to do this because other fomulae specify this as a dependency. This " +
             "option will enable you to remove 'ruby'. This will NOT bypass dependency checks for the " +
             "formula's children. If 'ruby' depends on 'git', then 'git' will still not be removed. Sorry."
      comma_array "--ignore=",
             description: "Ignore some dependencies from being removed. Specify multiple values separated by a comma."
    end
  end

  def main
    args = rmtree_args.parse

    force = args.force?
    ignored_kegs = []
    ignored_kegs.push(*args.ignore)
    rm_kegs = args.named
    quiet = args.quiet?
    @dry_run = args.dry_run?

    raise KegUnspecifiedError if args.no_named?

    # Turn off output if 'quiet' is specified
    if quiet
      puts_off
    end

    if @dry_run
      puts "This is a dry-run, nothing will be deleted"
    end

    # Convert ignored kegs into full names
    ignored_kegs.map! { |k| as_formula(k).full_name }

    rm_kegs.each { |keg_name| rmtree keg_name, force, ignored_kegs, args: args }
  end
end

BrewRmtree.main
exit 0