vim-recovery 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 822874fa51c53d423d5516a2518af51f81a0cb82
+  data.tar.gz: b14cea8e6c0031129c88ba42df039be631a65aab
+SHA512:
+  metadata.gz: e6f0729247d75f2bb0abd9349c7557103144ab30a83b397baf79dfbccec1b7a17499da826e30fc5421bdbc99af84e4805475c946aff993dfedb9395d689bf9e5
+  data.tar.gz: d13a2828334a8b7d57d051185f07120ea766569c20dd5fd08615ff07322b3e13ad9b419909ea82a227f56eb5389cbb5a66984ddb8b6e26f53f4fd1d823a8a037

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+/pkg/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vim-recovery.gemspec
+gemspec

data/README.md

@@ -0,0 +1,92 @@
+# vim-recovery
+
+vim-recovery is a utility to find and recover swapfiles.
+
+
+### Rationale
+
+After a system crash, my system is often littered with Vim swapfiles.  I
+usually want to do two things.  (1) Recover my in-progress work (unsaved files)
+and (2) remove any unmodified files to prevent Vim from prompting me about the
+swapfile whenever I open a file.
+
+`find . -type f -name "*.sw[a-p]"` doesn't take into account the actual type of
+the file.  For example, it finds Shockwave Flash files (\*.swf).
+
+vim-recovery searches directories for swap files and checks the header of the
+file to determine if it actually is a Vim swapfile.
+
+
+### Installation
+
+    $ gem install vim-recovery
+
+
+### Usage
+
+    $ vim-recovery --help
+    Usage:  vim-recovery [options] [paths...]
+    Commands:
+        -l, --list                       Find and list Vim swapfiles
+            --clean                      Delete unmodified swapfiles if process is not still running
+    Options:
+        -r, --recursive                  Also search subdirectories
+        -v, --verbose                    Be more verbose
+
+            --version                    Show version
+        -h, --help                       Display this help
+
+**Finding swapfiles**
+
+The "M" flag means the file was modified, and the "R" flag means the process is
+still running.  The output is tab-delimited to make it easier to parse with
+tools such as cut.
+
+    $ vim-recovery --list
+    [ R]	./.gitignore.swp	~speckins/git/vim-recovery/.gitignore
+    [MR]	./.README.md.swp	~speckins/git/vim-recovery/README.md
+    [ R]	./.vim-recovery.gemspec.swp	~speckins/git/vim-recovery/vim-recovery.gemspec
+    [  ]	./.crashed.txt.swp	~speckins/git/vim-recovery/crashed.txt
+
+**Removing unmodified swapfiles**
+
+    $ vim-recovery --clean --verbose
+    ./.crashed.txt.swp
+
+    $ vim-recovery --list
+    [ R]	./.gitignore.swp	~speckins/git/vim-recovery/.gitignore
+    [MR]	./.README.md.swp	~speckins/git/vim-recovery/README.md
+    [ R]	./.vim-recovery.gemspec.swp	~speckins/git/vim-recovery/vim-recovery.gemspec
+
+**Recursively cleaning swapfiles**
+
+    $ vim-recovery --clean --recursive --verbose
+    ./.crashed.txt.swp
+    ./lib/vim_recovery/.crashed.txt.swp
+
+**Filtering the output of --list**
+
+    $ vim-recovery --list --recursive
+    [ R]	./.gitignore.swp	~speckins/git/vim-recovery/.gitignore
+    [MR]	./.README.md.swp	~speckins/git/vim-recovery/README.md
+    [ R]	./.vim-recovery.gemspec.swp	~speckins/git/vim-recovery/vim-recovery.gemspec
+    [M ]	./.crashed.txt.swp	~speckins/git/vim-recovery/crashed.txt
+
+    $ vim-recovery --list --recursive | grep -a '^\[M \]' | cut -f2
+    ./.crashed.txt.swp
+
+
+### Vim options
+
+The directory option can be added to .vimrc to make it easier to find
+swapfiles.  This is not necessary to use vim-recovery, but it can make it
+faster.  (It takes a long time to search the 900,000+ files in my home
+directory.)
+
+    " .vimrc:
+    set directory=~/tmp/swapfiles//
+
+> For Unix and Win32, if a directory ends in two path separators "//"
+> or "\\\\", the swap file name will be built from the complete path to
+> the file with all path separators substituted to percent '%' signs.
+> This will ensure file name uniqueness in the preserve directory.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_{test,spec}.rb']
+end
+
+task :default => :test

data/exe/vim-recovery

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'vim_recovery/command'
+require 'vim_recovery/version'
+
+command = nil
+options = {}
+
+parser = OptionParser.new do |parser|
+  parser.banner = "Usage:  vim-recovery [options] [paths...]"
+
+  # --------------------------------------------------------------------------
+  parser.separator 'Commands:'
+  # --------------------------------------------------------------------------
+
+  parser.on '--list', '-l', 'Find and list Vim swapfiles' do
+    command = VimRecovery::Command::List
+  end
+
+  parser.on '--clean', 'Delete unmodified swapfiles if process is not still running' do
+    command = VimRecovery::Command::Clean
+  end
+
+  parser.on_tail '--version', 'Show version' do
+    puts VimRecovery::Version
+    exit
+  end
+
+  parser.on_tail '--help', '-h', 'Display this help' do
+    puts parser.help
+    exit
+  end
+
+  # --------------------------------------------------------------------------
+  parser.separator 'Options:'
+  # --------------------------------------------------------------------------
+
+  parser.on '--recursive', '-r', 'Also search subdirectories' do
+    options[:recursive] = true
+  end
+
+  parser.on '--verbose', '-v', 'Be more verbose' do
+    options[:verbose] = true
+  end
+
+  parser.separator ''
+end
+
+paths = parser.parse ARGV
+
+if command.nil?
+  puts "Required:  --list or --clean"
+  puts parser.help
+  exit 1
+end
+
+paths << '.' if paths.empty?
+
+paths.reject! do |path|
+  unless File.directory? path
+    STDERR.puts "#{path} is neither a directory nor a symlink to a directory"
+  end
+end
+
+exit 1 if paths.empty?
+
+command.new(paths, options).run

data/lib/vim_recovery.rb

@@ -0,0 +1,9 @@
+module VimRecovery
+
+  # Strictly speaking, ".saa" will never be a swapfile because the loop
+  # gives up at that name, but including it saves us a separate pattern.
+  # https://github.com/vim/vim/blob/95f096030ed1a8afea028f2ea295d6f6a70f466f/src/memline.c#L4566
+  SWAPFILES = ['*.sw[a-p]', '*.s[a-v][a-z]'].freeze
+end
+
+require 'vim_recovery/swapfile'

data/lib/vim_recovery/command.rb

@@ -0,0 +1,41 @@
+require 'vim_recovery'
+
+module VimRecovery
+  class Command
+    def initialize(paths, options = {})
+      @paths = paths
+      @options = options
+    end
+
+    def patterns
+      @patterns ||=
+        if @options[:recursive]
+          SWAPFILES.map { |swp| "**/#{swp}" }
+        else
+          SWAPFILES
+        end
+    end
+
+    def each_swapfile &block
+      @paths.each do |path|
+        path = path.chomp '/'
+        path_patterns = patterns.map { |swp| "#{path}/#{swp}" }
+
+        Dir.glob(path_patterns, File::FNM_DOTMATCH).each do |filename|
+          next unless File.file? filename
+
+          begin
+            swapfile = VimRecovery::Swapfile.open filename
+            next unless swapfile.valid_block0?
+            yield swapfile
+          ensure
+            swapfile.close
+          end
+        end
+      end
+    end
+  end
+end
+
+require_relative 'command/list'
+require_relative 'command/clean'

data/lib/vim_recovery/command/clean.rb

@@ -0,0 +1,13 @@
+module VimRecovery
+  class Command::Clean < Command
+    def run
+      each_swapfile do |swapfile|
+        next if swapfile.modified? || swapfile.still_running?
+
+        puts swapfile.path if @options[:verbose]
+        swapfile.close
+        File.unlink swapfile
+      end
+    end
+  end
+end

data/lib/vim_recovery/command/list.rb

@@ -0,0 +1,14 @@
+module VimRecovery
+  class Command::List < Command
+    def run
+      each_swapfile do |swapfile|
+        puts "[%s%s]\t%s\t%s" % [
+          swapfile.modified?      ? 'M' : ' ',
+          swapfile.still_running? ? 'R' : ' ',
+          swapfile.path,
+          swapfile.original_filename
+        ]
+      end
+    end
+  end
+end

data/lib/vim_recovery/swapfile.rb

@@ -0,0 +1,125 @@
+module VimRecovery
+  class Swapfile < ::File
+
+    Block0 = Struct.new :id, :version, :page_size, :mtime, :ino, :pid, :uname,
+      :hname, :fname, :crypt_seed, :flags, :dirty
+
+    # https://github.com/vim/vim/blob/95f096030ed1a8afea028f2ea295d6f6a70f466f/src/memline.c#L62
+    VALID_BLOCK_IDS = %w{b0 bc bC bd}.freeze
+
+    # https://github.com/vim/vim/blob/95f096030ed1a8afea028f2ea295d6f6a70f466f/src/memline.c#L143
+    B0_MAGIC_LONG   = 0x30313233
+    B0_MAGIC_INT    = 0x20212223
+    B0_MAGIC_SHORT  = 0x10111213
+    B0_MAGIC_CHAR   = 0x55
+    B0_DIRTY        = 0x55
+    B0_FF_MASK      = 3
+    B0_SAME_DIR     = 4
+    B0_HAS_FENC     = 8
+
+    # https://github.com/vim/vim/blob/95f096030ed1a8afea028f2ea295d6f6a70f466f/src/option.h#L80
+    EOL_UNIX        = 0 # NL
+    EOL_DOS         = 1 # CR NL
+    EOL_MAC         = 2 # CR
+
+    EOL = {
+      EOL_UNIX => :unix,
+      EOL_DOS  => :dos,
+      EOL_MAC  => :mac
+    }.freeze
+
+    # https://github.com/vim/vim/blob/95f096030ed1a8afea028f2ea295d6f6a70f466f/src/memline.c#L160
+    HEADER_FORMAT = [
+      'A2',   # identifier, "b0"
+      'A10',  # version, e.g., "VIM 7.4"
+      'V',    # page_size
+      'V',    # mtime (not used)
+      'V',    # inode
+      'V',    # pid
+      'A40',  # username or uid
+      'A40',  # hostname
+      'A890', # filename
+      'a8',   # crypt seed (for encrypted swapfiles)
+      'C',    # flags
+      'C',    # dirty (0x00/0x55)
+      #'l!',   # magic_long
+      #'i!',   # magic_int
+      #'s!',   # magic_short
+      #'c',    # magic_char
+    ].join ''
+
+    def self.swapfile?(name)
+      open(name) { |f| f.valid_block0? }
+    end
+
+    def encrypted?
+      # "b0" not encrypted
+      # "bc" encrypted (zip)
+      # "bC" encrypted (blowfish)
+      # "bd" encrypted (blowfish2)
+      block0.id[1] != '0'
+    end
+
+    def modified?
+      block0.dirty == B0_DIRTY
+    end
+
+    def mtime
+      block0.mtime == 0 ? super : Time.at(block0.mtime)
+    end
+
+    def pid
+      block0.pid
+    end
+
+    def original_filename
+      block0.fname unless block0.fname.empty?
+    end
+
+    def still_running?
+      Process.getpgid pid
+      true
+    rescue Errno::ESRCH
+      false
+    end
+
+    # Flags
+
+    # The original length of the filename field was 900 chars.  At some point
+    # (flags were introduced in Vim 7.0) the last two bytes were used to store
+    # "other things" ("dirty" char and flags).  When encrypted swapfiles were
+    # introduced (Vim 7.3) another 8 bytes were used to store the crypt seed,
+    # so the contemporary filename field size is 890.
+
+    # Swap file is in directory of edited file (see ":help directory").
+    def same_dir?
+      B0_SAME_DIR & block0.flags > 0
+    end
+
+    def has_file_encoding?
+      B0_HAS_FENC & block0.flags > 0
+    end
+
+    def file_format
+      # "Zero means it's not set (compatible with Vim 6.x), otherwise it's
+      # EOL_UNIX + 1, EOL_DOS + 1 or EOL_MAC + 1."
+      EOL[(block0.flags & B0_FF_MASK) - 1]
+    end
+
+    def valid_block0?
+      rewind
+      VALID_BLOCK_IDS.include?(read 2)
+    end
+
+    private
+
+    def block0
+      @block0 ||=
+        begin
+          rewind
+          Block0.new *read(1032).unpack(HEADER_FORMAT)
+        end
+    end
+
+  end
+end

data/lib/vim_recovery/version.rb

@@ -0,0 +1,3 @@
+module VimRecovery
+  Version = '0.0.1'
+end

data/vim-recovery.gemspec

@@ -0,0 +1,21 @@
+require_relative 'lib/vim_recovery/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name          = 'vim-recovery'
+  spec.version       = VimRecovery::Version
+  spec.authors       = ['Steven Peckins']
+  spec.email         = ['steven.peckins@gmail.com']
+  spec.summary       = 'A utility for finding and recovering Vim swapfiles'
+  spec.homepage      = 'https://github.com/speckins/vim-recovery'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+
+  spec.bindir        = 'exe'
+  spec.executables   << 'vim-recovery'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: vim-recovery
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steven Peckins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- steven.peckins@gmail.com
+executables:
+- vim-recovery
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- exe/vim-recovery
+- lib/vim_recovery.rb
+- lib/vim_recovery/command.rb
+- lib/vim_recovery/command/clean.rb
+- lib/vim_recovery/command/list.rb
+- lib/vim_recovery/swapfile.rb
+- lib/vim_recovery/version.rb
+- vim-recovery.gemspec
+homepage: https://github.com/speckins/vim-recovery
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A utility for finding and recovering Vim swapfiles
+test_files: []