diskman 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6831a1ef183d31bdae66d4ae5080cf3a019b0ace76d259a0783d4751cfca1f94
+  data.tar.gz: 62ac2d6b97e14081766fd44cefbeca8529afcf51ffd2a63c309850b3c58013cc
+SHA512:
+  metadata.gz: 314214d528f832e92563265161fbf3e11d8960a04720686084ed4d78361a7f2e2b08e67f8bac3c014f329f088f9d9c6b15b32dc3d9e7a48000780d9b1146e9f9
+  data.tar.gz: 48598af4a378a4190d1292d872133e9c334a214d5d42f02a969b8765079da8ac74f8cdc9c6a8fa82db6c5caae38a8d80b620914542c3905e2176c52210a53608

data/bin/diskman

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+require_relative '../lib/diskman'
+include Diskman
+
+class Main
+    def initialize(opts)
+        @opts = opts
+    end
+
+    def self.run(opts)
+        new(opts).run
+    end
+
+    def params
+        @params ||= OpenStruct.new({
+            version: @opts['--version'],
+            help: @opts['--help'],
+            list: @opts['--list'],
+            write: @opts['write'],
+            fdisk: @opts['fdisk'],
+            mkfs: @opts['mkfs'],
+            file: @opts['<file>'],
+        })
+    end
+
+    def exit_usage
+        puts DOCS
+        exit 0
+    end
+
+    def exit_version
+        puts Diskman::VERSION
+        exit 0
+    end
+
+    def run
+        exit_version if params.version
+        exit_usage if params.help
+
+        if params.mkfs
+            Command::Mkfs.new.run(list: params.list)
+        elsif params.write
+            Command::Write.new.run(file: params.file)
+        elsif params.fdisk
+            Command::Fdisk.new.run
+        end
+    rescue Interrupt => e
+    end
+end
+
+docs = <<~EOF
+    #{'Usage:'.bold}
+        #{File.basename($0)} write <file>
+        #{File.basename($0)} fdisk
+        #{File.basename($0)} mkfs [ --list ]
+        #{File.basename($0)} ( --version | --help )
+
+    #{'Options:'.bold}
+        -v, --version  Show version
+        -h, --help     Show this help
+EOF
+
+begin
+    Main.run(Docopt::docopt(docs, version: VERSION))
+rescue Docopt::Exit => e
+    puts e.message
+    exit 1
+end

data/lib/diskman.rb

@@ -0,0 +1,13 @@
+require 'require_all'
+require 'colorize'
+require 'docopt'
+
+require 'ostruct'
+
+module Diskman
+    def self.root_dir
+        File.expand_path('../..', __FILE__)
+    end
+end
+
+require_rel 'diskman'

data/lib/diskman/chooser.rb

@@ -0,0 +1,70 @@
+module Diskman
+    # Presents the user with a list of items to choose from.
+    class Chooser
+        def initialize(items, what:)
+            @items = items
+            @singular = what
+            @plural = what + 's'
+        end
+
+        def label
+            if @items.length > 1
+                @plural
+            else
+                @singular
+            end
+        end
+
+        def space
+            ' '
+        end
+
+        def select
+            if @items.length == 0
+                puts 'No %s found'.yellow % @plural
+                raise Interrupt
+            end
+
+            if @items.length == 1
+                puts 'Found the following %s.' % label
+            else
+                puts 'Please pick from the following %s.' % @plural
+            end
+
+            puts
+
+            @items.each_with_index do |device, i|
+                puts "#{(space * 4) }#{i + 1}. #{device}"
+            end
+
+            puts
+
+            if @items.length == 1
+                puts 'Press any key to select it.'
+                $stdin.gets
+                return @items.first
+            end
+
+            puts 'Enter the number of your selection.'
+            puts
+            print '> '
+
+            selection = $stdin.gets.chomp
+
+            puts
+
+            if selection.length == 0
+                raise Interrupt
+            end
+
+            selection = selection.to_i
+
+            if selection <= 0 || selection > @items.length
+                puts 'Invalid selection'.red
+                raise Interrupt
+            end
+
+            @items[selection - 1]
+        end
+    end
+end

data/lib/diskman/commands/fdisk.rb

@@ -0,0 +1,9 @@
+module Command
+    class Fdisk
+        def run
+            root_device = RootDevice.choose
+            cmd = root_device.get_fdisk_command
+            System.exec! cmd, safe: false
+        end
+    end
+end

data/lib/diskman/commands/mkfs.rb

@@ -0,0 +1,30 @@
+module Command
+    class Mkfs
+        def get_list
+            Dir['/usr/bin/mkfs.*'].map do |path|
+                path.gsub(%r[^/usr/bin/mkfs.], '')
+            end.sort
+        end
+
+        def run(list: false)
+            if list
+                puts get_list
+                return
+            end
+
+            device = RootDevice.choose
+            device.ensure_not_mounted!
+
+            device = device.choose_block_device
+
+            fs = Chooser.new(get_list, what: 'filesystem').select
+            cmd = device.get_mkfs_command(fs)
+
+            puts "Filesystem: #{fs.yellow}"
+            puts "Device:     #{device.to_s.yellow}"
+            puts "Command:    #{cmd.yellow}"
+
+            System.exec!(cmd)
+        end
+    end
+end

data/lib/diskman/commands/write.rb

@@ -0,0 +1,22 @@
+module Command
+    class Write
+        def run(file:)
+            if !File.exists?(file)
+                puts ('Unable to read ' + file).red
+                raise Interrupt
+            end
+
+            device = RootDevice.choose
+            device.ensure_not_mounted!
+
+            size = File.size(file)
+            cmd = device.get_write_command(file, size)
+
+            puts "File:    #{file.yellow} (#{System.bytes2human(size)})"
+            puts "Device:  #{device.to_s.yellow}"
+            puts "Command: #{cmd.yellow}"
+
+            System.exec!(cmd)
+        end
+    end
+end

data/lib/diskman/confirmer.rb

@@ -0,0 +1,22 @@
+module Diskman
+    # Confirms whether the user wants to do something destructive.
+    class Confirmer
+        YES = 'YES'
+
+        def self.check!
+            self.new.check!
+        end
+
+        def check!
+            puts
+            puts 'Are you sure? Type "%s" if so.' % YES
+            puts
+
+            print '> '
+
+            if $stdin.gets.chomp != YES
+                raise Interrupt
+            end
+        end
+    end
+end

data/lib/diskman/device.rb

@@ -0,0 +1,39 @@
+module Diskman
+    class Device
+        attr_reader :path
+
+        def initialize(name)
+            @name = name
+            @path = '/dev/' + name
+        end
+
+        def get_fdisk_command
+            'sudo fdisk %s' % @path
+        end
+
+        def get_mkfs_command(fs)
+            'sudo mkfs.%s %s' % [fs, @path]
+        end
+
+        def get_write_command(path, bytes)
+            if `which 2>/dev/null pv`.length > 0
+                pv = 'pv --size %d' % bytes
+                dd = 'dd if="%s" | ' + pv + ' | sudo dd of="%s" bs=%d'
+            else
+                dd = 'sudo dd if="%s" of="%s" bs=%d'
+            end
+
+            dd % [path, @path, 4096]
+        end
+
+        def to_s
+            @path
+        end
+
+        private
+
+        def <=>(o)
+            @path <=> o.path
+        end
+    end
+end

data/lib/diskman/mount.rb

@@ -0,0 +1,21 @@
+module Diskman
+    class Mount
+        def self.is_mounted(name)
+            Mount.new.find(name)
+        end
+
+        def self.get_mount_point(name)
+            Mount.new.find(name).chomp.match(/[^ ]+ (?<m>[^ ]+)/)[:m]
+        end
+
+        def find(name)
+            lines.grep(%r[^/dev/#{name}\d?\s+]).first
+        end
+
+        private
+
+        def lines
+            @lines ||= File.read('/etc/mtab').lines
+        end
+    end
+end

data/lib/diskman/root_device.rb

@@ -0,0 +1,68 @@
+module Diskman
+    class RootDevice < Device
+        def self.get_removable
+            Dir['/sys/block/*/removable'].select do |file|
+                File.read(file).strip == '1'
+            end.map do |path|
+                path =~ /^\/sys\/block\/(.*)\/removable$/ && RootDevice.new($1)
+            end.sort
+        end
+
+        def self.choose
+            Chooser.new(RootDevice.get_removable, what: 'removable device').select
+        end
+
+        def get_devices
+            Dir[@path + '*'].sort.map do |file|
+                file =~ %r[/dev/(.*)] && Device.new($1)
+            end.sort
+        end
+
+        def choose_block_device
+            Chooser.new(get_devices, what: 'device').select
+        end
+
+        def ensure_not_mounted!
+            if mounted?
+                puts ('Warning: device appears to be mounted at ' + get_mount_point).yellow
+                puts 'Not continuing'.red
+                raise Interrupt
+            end
+        end
+
+        def mounted?
+            Mount.is_mounted(@name)
+        end
+
+        def get_mount_point
+            Mount.get_mount_point(@name)
+        end
+
+        def to_s
+            @path + ' [' + [size, label].reject(&:empty?).join(', ') + ']'
+        end
+
+        private
+
+        def get_int_prop(name)
+            get_prop(name).to_i
+        end
+
+        def get_prop(name)
+            file = "/sys/class/block/%s/%s" % [@name, name]
+            File.read(file).strip.gsub(/\s+/, ' ')
+        end
+
+        def label
+            [get_prop('device/vendor'), get_prop('device/model')].reject(&:empty?).join(' ')
+        end
+
+        def size_bytes
+            get_int_prop('size') * get_int_prop('queue/logical_block_size')
+        end
+
+        def size
+            System.bytes2human(size_bytes)
+        end
+    end
+end

data/lib/diskman/system.rb

@@ -0,0 +1,40 @@
+module Diskman
+    class System
+        # If sudo prompts for the password when a pipeline with pv has already
+        # started then we're unable to enter the password. Run a pointless
+        # command with sudo first to ensure that we can accept keyboard input
+        # for the password, if necessary.
+        def self.prepare_sudo_session!
+            system('sudo echo >/dev/null')
+        end
+
+        # Execute a command.
+        # If sudo is true, ensures sudo is ready before running the command.
+        # If safe is true, ensures the user definitely wants to run the command
+        # before running it.
+        def self.exec!(cmd, safe: true, sudo: true)
+            Confirmer.check! if safe
+            prepare_sudo_session! if sudo
+            puts
+            exec cmd
+        end
+
+        # Convert bytes into a human-friendly representation.
+        def self.bytes2human(b)
+            return '0B' if b <= 0
+
+            # Use 1000 to match the misleading way disk capacities are
+            # advertised.
+            k = 1000
+
+            suffices = ['T', 'G', 'M', 'K', 'B']
+
+            suffices.each_with_index do |suffix, i|
+                threshold = k ** (suffices.length - i - 1)
+                if b >= threshold
+                    return (b / threshold).to_s + suffix
+                end
+            end
+        end
+    end
+end

data/lib/diskman/version.rb

@@ -0,0 +1,3 @@
+module Diskman
+    VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: diskman
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- crdx
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description: 
+email: 
+executables:
+- diskman
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/diskman
+- lib/diskman.rb
+- lib/diskman/chooser.rb
+- lib/diskman/commands/fdisk.rb
+- lib/diskman/commands/mkfs.rb
+- lib/diskman/commands/write.rb
+- lib/diskman/confirmer.rb
+- lib/diskman/device.rb
+- lib/diskman/mount.rb
+- lib/diskman/root_device.rb
+- lib/diskman/system.rb
+- lib/diskman/version.rb
+homepage: https://github.com/crdx/diskman
+licenses:
+- MIT
+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.6
+signing_key: 
+specification_version: 4
+summary: Interactive command line interface for safely managing disks
+test_files: []