pkgpurge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b45d7148c766962be92c49e134e3b910af1b86994f3918a18be3fb7779256e4d
+  data.tar.gz: 10f4b4cc4c9163d9afc3519f2e8cc50b91036f9918c10adfe50ece85e590953f
+SHA512:
+  metadata.gz: a4949cde5ab1aac508265d49735f0f49154e26be5001fd250e75f5cacbc7cd858dc7cea50e8c23f79d9b6d79ac64942c90a3bd1d2228c861050af5bb10682251
+  data.tar.gz: 640543ed8133e7dd3b08d82dfe2d977711ec1ca778170e86e6762ea2dffea9a10e486c49a942c29fd9b7beb5dd7dbfe907b3fb4d8b20d4b25799d7b5166f0afd

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Yoshimasa Niwa
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+pkgpurge
+========
+
+NAME
+----
+
+`pkgpurge` -- A simple helper tool to purge `installer(8)` packages.
+
+SYNOPSIS
+--------
+
+    pkgpurge COMMAND [OPTIONS...] [ARGS...]
+
+DESCRIPTION
+-----------
+
+`pkgpurge` is a Ruby gem that provides a command line interface and a Ruby library
+to purge `install(8)` packages.
+
+`pkgpurge` command line interface takes next commands.
+
+### `ls PATH`
+
+List entries for given receipt plist at `PATH`.
+Similar to `lsbom -pfmugsct PATH_TO_BOM_FILE`
+
+### `verify PATH`
+
+Verify entries for given receipt plist at `PATH`.
+Print modified or missing entries.
+
+* `--checksum`
+
+    Verify checksum of each entry. Slow.
+    Directories and symbolic links are ignored.
+    This command executes `cksum(1)` on each regular file entry.
+
+* `--mtime`
+
+    Verify mtime of each entry. Directories are ignored.
+
+### `ls-purge PATH`
+
+List entries that can be purged for given receipt plist at PATH.
+Entries are not modified and if it's a directory, must be empty before listed.
+
+* `--checksum`
+
+    Verify checksum of each entry. Slow.
+    Directories and symbolic links are ignored.
+    This command executes `cksum(1)` on each regular file entry.
+
+* `--mtime`
+
+    Verify mtime of each entry. Directories are ignored.

data/bin/pkgpurge

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+
+require "pkgpurge"
+
+Pkgpurge::CLI.start(ARGV)

data/lib/pkgpurge/cli.rb

@@ -0,0 +1,124 @@
+require "rubygems"
+require "thor"
+
+module Pkgpurge
+  class CLI < Thor
+    desc "ls PATH", "List entries for given receipt plist at PATH"
+    def ls(path)
+      root = Receipt.new(path).root
+
+      Entry.traverse_entry_with_path(root, "/") do |entry, path|
+        report path, "%o" % entry.mode, entry.uid, entry.gid, entry.size, entry.checksum
+      end
+    end
+
+    desc "verify PATH", "Verify entries for given receipt plist at PATH"
+    option :checksum, type: :boolean, banner: "Verify checksum of each entry. Slow."
+    option :mtime, type: :boolean, banner: "Verify mtime of each entry."
+    def verify(path)
+      root = Receipt.new(path).root
+
+      Entry.traverse_entry_with_path(root, "/") do |entry, path|
+        verify_entry(entry, path, options).each do |modification|
+          report path, *modification
+        end
+      end
+    end
+
+    desc "ls-purge PATH", "List entries that can be purged for given receipt plist at PATH"
+    option :checksum, type: :boolean, banner: "Verify checksum of each entry. Slow."
+    option :mtime, type: :boolean, banner: "Verify mtime of each entry."
+    def ls_purge(path)
+      root = Receipt.new(path).root
+
+      traverse_purge_entry_with_path(root, "/") do |entry, path|
+        if verify_entry(entry, path, options).empty?
+          puts path
+          true
+        else
+          false
+        end
+      end
+    end
+
+    private
+
+    def traverse_purge_entry_with_path(entry, parent_path, &block)
+      path = File.expand_path(File.join(parent_path, entry.name))
+      unless File.exists?(path)
+        return true
+      end
+
+      children = if !File.symlink?(path) && File.directory?(path)
+        Dir.children(path)
+      else
+        []
+      end
+
+      empty_children = []
+      entry.entries.each do |_, entry|
+        if traverse_purge_entry_with_path(entry, path, &block)
+          empty_children << entry.name
+        end
+      end
+
+      if children.sort == empty_children.sort
+        # All children are empty, so we can purge this path
+        yield(entry, path)
+      else
+        false
+      end
+    end
+
+    def verify_entry(entry, path, options = {})
+      modifications = []
+
+      unless File.exists?(path)
+        modifications << ["missing"]
+        return modifications
+      end
+
+      stat = File.lstat(path)
+      unless stat.mode == entry.mode
+        modifications << ["mode", "%o" % entry.mode, "%o" % stat.mode]
+      end
+      unless stat.uid == entry.uid
+        modifications << ["uid", entry.uid, stat.uid]
+      end
+      unless stat.gid == entry.gid
+        modifications << ["gid", entry.gid, stat.gid]
+      end
+
+      if entry.size
+        unless stat.size == entry.size
+          modifications << ["size", entry.size, stat.size]
+        end
+      end
+
+      if options[:checksum] && entry.checksum && !entry.symlink?
+        checksum = cksum(path)
+        if checksum != entry.checksum
+          modifications << ["checksum", entry.checksum, checksum]
+        end
+      end
+
+      if options[:mtime] && entry.mtime
+        unless stat.mtime == entry.mtime
+          modifications << ["mtime", entry.mtime, stat.mtime]
+        end
+      end
+
+      modifications
+    end
+
+    CKSUM = "/usr/bin/cksum".freeze
+
+    def cksum(path)
+      Command.run(CKSUM, path).split(/\s/).first.to_i
+    end
+
+    def report(*messages)
+      puts messages.join("\t")
+    end
+  end
+end

data/lib/pkgpurge/command.rb

@@ -0,0 +1,7 @@
+module Pkgpurge
+  module Command
+    def self.run(*command)
+      IO.popen(command){|io| io.read}
+    end
+  end
+end

data/lib/pkgpurge/entry.rb

@@ -0,0 +1,43 @@
+module Pkgpurge
+  class Entry
+    def self.traverse_entry_with_path(entry, parent_path = nil, &block)
+      if parent_path
+        path = File.join(parent_path, entry.name)
+      else
+        path = entry.name
+      end
+
+      yield(entry, File.expand_path(path))
+
+      entry.entries.each do |_, entry|
+        traverse_entry_with_path(entry, path, &block)
+      end
+    end
+
+    attr_reader :name, :mode, :uid, :gid, :size, :checksum, :mtime, :entries
+
+    def initialize(name, mode, uid, gid, size, checksum, mtime)
+      @name = name
+      @mode = mode
+      @uid = uid
+      @gid = gid
+      @size = size
+      @checksum = checksum
+      @mtime = mtime
+      @entries = {}
+    end
+
+    # See `/usr/includde/sys/_types/_s_ifmt.h`
+    S_IFMT  = 0170000
+    S_IFDIR = 0040000
+    S_IFLNK = 0120000
+
+    def directory?
+      (@mode & S_IFMT) == S_IFDIR
+    end
+
+    def symlink?
+      (@mode & S_IFMT) == S_IFLNK
+    end
+  end
+end

data/lib/pkgpurge/receipt.rb

@@ -0,0 +1,80 @@
+require "rubygems"
+require "plist"
+require "pathname"
+
+module Pkgpurge
+  class Receipt
+    def initialize(path)
+      @path = path
+    end
+
+    def root
+      @root ||= parse!
+    end
+
+    private
+
+    def parse!
+      relative_install_prefix_path = Pathname.new(install_prefix_path).relative_path_from("/").to_s
+
+      root = nil
+      lsbom.lines.each do |line|
+        # size and checksum are optional.
+        path, mode, uid, gid, size, checksum, mtime = line.chomp.split("\t")
+        mode = mode.to_i(8)
+        uid = uid.to_i
+        gid = gid.to_i
+        size = size && size.to_i
+        checksum = checksum && checksum.to_i
+        mtime = mtime && Time.at(mtime.to_i)
+
+        current = nil
+        path.split("/").each do |path_component|
+          if path_component == "."
+            unless current
+              if !root
+                root = Entry.new(path_component, mode, uid, gid, size, checksum, mtime)
+              end
+              current = root
+              next
+            end
+            raise "Unexpected path: #{path}"
+          end
+
+          entry = current.entries[path_component]
+          unless entry
+            entry = Entry.new(path_component, mode, uid, gid, size, checksum, mtime)
+            current.entries[path_component] = entry
+            break
+          end
+
+          current = entry
+        end
+      end
+
+      root
+    end
+
+    LSBOM = "/usr/bin/lsbom".freeze
+    PLIST_BUDDY = "/usr/libexec/PlistBuddy".freeze
+
+    def lsbom
+      @lsbom ||= begin
+        bompath = "#{File.join(File.dirname(@path), File.basename(@path, ".plist"))}.bom"
+        # file, mode, uid, gid, size, checksum, mtime
+        Command.run(LSBOM, "-pfmugsct", bompath)
+      end
+    end
+
+    def install_prefix_path
+      plist["InstallPrefixPath"]
+    end
+
+    def plist
+      @plist ||= begin
+        plist_xml = Command.run(PLIST_BUDDY, "-x", "-c", "Print", @path)
+        Plist.parse_xml(plist_xml)
+      end
+    end
+  end
+end

data/lib/pkgpurge.rb

@@ -0,0 +1,6 @@
+module Pkgpurge
+  autoload :CLI, "pkgpurge/cli"
+  autoload :Command, "pkgpurge/command"
+  autoload :Entry, "pkgpurge/entry"
+  autoload :Receipt, "pkgpurge/receipt"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: pkgpurge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshimasa Niwa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple helper tool to purge `intaller(8)` packages
+email:
+- niw@niw.at
+executables:
+- pkgpurge
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- bin/pkgpurge
+- lib/pkgpurge.rb
+- lib/pkgpurge/cli.rb
+- lib/pkgpurge/command.rb
+- lib/pkgpurge/entry.rb
+- lib/pkgpurge/receipt.rb
+homepage: https://github.com/niw/pkgpurge
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A simple helper tool to purge `intaller(8)` packages
+test_files: []