anjea_backup 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmZjYWM2NDI3ZGUyOTllZDUxYTZhOTRjNDkwMjk5MTczYmMwNzYyYg==
+  data.tar.gz: !binary |-
+    NGNjYTA3OWVmYWZhOTk2OWVlNTc0ZmU4MzQ0ZjgxMzJkZTI5OGIxYQ==
+SHA512:
+  metadata.gz: !binary |-
+    MmM4NTQ1ODI2MzBiYjQ3YjY1Mjg5ZWQzYjM3MWEwZmUxOTNiN2Q1NmUwOGQ0
+    OWI0OWZlNWM4OGRlNDUwNTExMzJlYjU4MjMxYWI4NDkxMjBmZTg4MjcxYThh
+    NzUwNzMzYjk4NWU4YmY1YWVhMTQzODk2OTczMzBhMTgyZGQ3ZDc=
+  data.tar.gz: !binary |-
+    MjE3NTJjMzA1Yzg1OGU0YTBmMTczMzFjYTQ5YTVkNWRlOTRiY2QxNDJmZjNj
+    OGQxMTRjNDZlYzdmNWM1ZTYxZWY4MmZlMDdiZGMyOWQxYmNlMzlmMDRiNjMx
+    MzQ1MGM3NTdmOTkwZjZiNjZjOGE3MTk5MzU0YzE5OWU3ZjA5NDY=

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    anjea_backup (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  anjea_backup!
+  bundler (~> 1.6)
+  rake

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Felix Wolfsteller
+
+MIT License
+
+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,89 @@
+# AnjeaBackup
+
+Warning: *I do not consider AnjeaBackup anything close to production-ready* .
+
+It is however a fun toy, and some things do work.
+
+AnjeaBackup will create copies of local or remote (via ssh) files and directories, hard-linked to former versions of the same files and directories.
+
+The approach has been beautifully implemented by numerous people using e.g. bash or perl scripts.
+I aimed for quick and easy configurability and some oppinionated choices that were given my usage scenario.
+
+## Installation
+
+You'll probably need a decent linux installation and have rsync installed.
+
+    $ gem install anjea_backup
+
+## Usage
+
+AnjeaBackup is meant to be a script.  If you find 'library' usage for it, get in touch.  Also, I think if you want to use it, get in touch.
+
+The script is in `/bin/anjea` .
+
+The working basic use case is to just call it.  It will pick up two configuration files (see next sections) and immediately start a backup-attempt.
+
+## Configuration
+
+There are two important configuration files, `anjea.conf` and `backups.conf` .
+
+Example configuration files are included.
+The files somewhat follow the ini/Desktop-File conventions, but a *very* limited parser is used.
+
+### anjea.conf
+
+Defines *where* to save backups, logs, etc.  Example:
+
+    [system]
+    dst=/backup/anjea-backups/
+    vault=/vault/anjea-vault/
+    log=/var/log/anjea/
+    lock=/var/lock/anjea.lock
+
+`dst` is the root folder for backups, `vault` currently unused, `log` folder for log files, `lock` file to ensure anjea is just running once.
+
+### backups.conf
+
+Defines *what* to backup and how to access it.  Example:
+
+    [files]
+    src=/home/anjea/files/
+    description=other directory with files
+    
+    [remotebox]
+    src=/home/remoteanjea/stuff/
+    description=stuff on other host
+    host=otherhost.mynetwork
+    key=/home/anjea/.anjea/keys/otherhostkey_rsa
+    user=anjea
+
+Second group saves files from a remote box (`anjea@otherhost.mynetwork:/home/remoteanjea/stuff`) using public key as defined in `key` .
+
+## Example
+
+* Dedicated Backup-Server running anjea.
+* Backup-Server wakes up on lan, triggered by cron job from outside.
+* Backup-Server has a crontab-entry to do the backup
+    0 3 * * * anjea | tee /backups/current/log | ssmtp myemailadress@geemail.com 
+* last log goes to /backup/current/log, is sent to email address (requires configured ssmtp, alternatively define MAILTO in crontab).
+
+## TODOs
+
+This will need work.
+
+* optparse bin/anjea, add help
+* trap and handle signals
+* Rescue from malconditions, move incomplete backups to a designated location
+* Continue with other backups in case one faults
+* Allow manual targeted backups of single sources
+* Revive tests
+* (missing: send mail) -> easy to do from outside
+* (missing: do full, non incremental, non hardlinked backups into vault from time to time)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/anjea_backup/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/anjea.conf.example

@@ -0,0 +1,5 @@
+[system]
+dst=/backup/anjea-backups/
+vault=/vault/anjea-vault/
+log=/var/log/anjea/
+lock=/var/lock/anjea.lock

data/anjea_backup.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'anjea_backup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "anjea_backup"
+  spec.version       = AnjeaBackup::VERSION
+  spec.authors       = ["Felix Wolfsteller"]
+  spec.email         = ["felix.wolfsteller@gmail.com"]
+  spec.summary       = %q{Backup with ruby, rsync, hardlinks, hacks, without style but with aboriginal mystery.}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/fwolfst/anjea_backup/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/backups.conf.example

@@ -0,0 +1,20 @@
+[datatest]
+src=/home/anjea/data/
+description=Short test
+
+[files]
+src=/home/anjea/files/
+description=other directory with files
+
+[remotebox]
+src=/home/remoteanjea/stuff/
+description=stuff on other host
+host=otherhost.mynetwork
+key=/home/anjea/.anjea/keys/otherhostkey_rsa
+user=anjea
+
+# Always good idea to backup myself
+[self]
+src=/home/installed/backup
+description=backup script and conf
+

data/bin/anjea

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'anjea_backup'
+
+action = :backup
+if ARGV.length > 0
+  case ARGV[0].downcase
+  when 'backup'
+    action = :backup
+  when 'vault'
+    action = :vault
+  when 'list'
+    action = :list
+  end
+end
+
+begin
+  case action
+  when :backup
+    AnjeaBackup::Backup.new.backup
+  when :list
+    AnjeaBackup.new.cleanup
+  when :vault
+    AnjeaBackup.new.to_vault
+  else
+    STDERR.puts "unknown action"
+    exit 3
+  end
+rescue NoIniFileError => ex
+  STDERR.puts "#{ex.inspect}"
+  exit 4
+end

data/lib/anjea_backup/anjea_backup.rb

@@ -0,0 +1,151 @@
+require 'date'
+require 'fileutils'
+require 'pathname'
+require_relative 'inifile'
+
+module AnjeaBackup
+  class BackupItem
+    attr_accessor :name
+    attr_accessor :description
+    attr_accessor :src_dir
+    attr_accessor :ssh_url
+    attr_accessor :ssh_key
+  
+    def initialize hash
+      @name        = hash[:name]
+      @description = hash['description']
+      @src_dir     = hash['src']
+      if hash['host'] && hash['user'] && hash['key']
+        @ssh_url = "#{hash['user']}@#{hash['host']}:#{@src_dir}"
+        @ssh_key = hash['key']
+      end
+    end
+  end
+  
+  class Backup
+    def initialize
+      read_system_conf
+      if !lock!
+        log_err "Aborting, anjea already running.  Delete #{@lock_file} if not."
+        exit 2
+      end
+      read_backups_conf
+      setup_dirs
+    end
+  
+    def backup
+      yyyymmdd = DateTime.now.strftime("%Y-%m-%d-%H")
+      
+      # TODO work in a tmp work dir
+      @backup_items.each do |item|
+        last_backup  = File.join(@last, item.name)
+        today_backup = create_now_backup_path(yyyymmdd, item)
+        work_dir     = File.join(@partial, item.name, yyyymmdd)
+        FileUtils.mkdir_p work_dir
+  
+        source = item.ssh_url ? "-e \"ssh -i #{item.ssh_key}\" #{item.ssh_url}"
+                              : item.src_dir
+  
+        rsync_cmd = "rsync -avz --delete --relative --stats --log-file #{log_file_for(yyyymmdd, item)} --link-dest #{last_backup} #{source} #{today_backup}"
+      
+        log item, "rsync start"
+        if system(rsync_cmd)
+          log item, "rsync finished"
+          # 'finish', move partial to backup-dest
+          link_last_backup today_backup, last_backup
+          log item, "linked"
+        else
+          # TODO Move this one into quarantaine/incomplete!
+          log_err item, "rsync failed?"
+        end
+      end
+      self
+    end
+  
+    def cleanup
+      now = DateTime.now
+      @backup_items.each do |item|
+        puts "[#{item.name}] backups:"
+        puts "-- #{item.description} --"
+        ages = Dir.glob("#{@destination}/[^c]*/#{item.name}").map do |dir|
+          date_dir = Pathname.new(dir).parent.basename.to_s
+          dtdiff = 0
+          begin
+            stamp = DateTime.strptime(date_dir, "%Y-%m-%d-%H")
+            dtdiff = now - stamp
+          rescue
+            STDERR.puts "Do not understand timestamp in #{dir}"
+          end
+          [dtdiff, dir]
+        end
+        ages.sort.each do |age,dir|
+          puts "(#{(age*24).to_i}) #{dir}"
+        end
+        puts
+      end
+    end
+  
+    def to_vault
+    end
+  
+    private
+  
+    def setup_dirs
+      Dir.mkdir @destination if !File.directory? @destination
+      Dir.mkdir @vault       if !File.directory? @vault
+      Dir.mkdir @log         if !File.directory? @log
+      Dir.mkdir @last        if !File.directory? @last
+      Dir.mkdir @partial     if !File.directory? @partial
+      Dir.mkdir @failed      if !File.directory? @failed
+    end
+  
+    def log_err item=nil, msg
+      if item
+        STDERR.puts "[#{item.name}] #{DateTime.now.strftime("%Y-%m-%d-%H:%M")} - #{msg}"
+      else
+        STDERR.puts "#{DateTime.now.strftime("%Y-%m-%d-%H:%M")} - #{msg}"
+      end
+    end
+  
+    def log item, msg
+      puts "[#{item.name}] #{DateTime.now.strftime("%Y-%m-%d-%H-%M")} - #{msg}"
+    end
+  
+    def lock!
+      File.new(@lock_file,'w').flock( File::LOCK_NB | File::LOCK_EX )
+    end
+  
+    def link_last_backup today_backup, last_backup
+      FileUtils.rm_f last_backup
+      FileUtils.ln_s(today_backup, last_backup, :force => true)
+    end
+  
+    def read_backups_conf
+      @backup_items = read_ini_file('backups.conf').map {|group| BackupItem.new group }
+    end
+  
+    def read_system_conf
+      system_conf = read_ini_file 'anjea.conf'
+  
+      @destination = system_conf[0]['dst']
+      @vault       = system_conf[0]['vault']
+      @log         = system_conf[0]['log']
+      @last        = File.join(@destination, 'current')
+      @failed      = File.join(@destination, 'failed')
+      @partial     = File.join(@destination, 'partial')
+      @lock_file   = system_conf[0]['lock']
+    end
+  
+    def log_file_for yyyymmdd, item
+      FileUtils.mkdir_p File.join(@log, item.name)
+      File.join(@log, item.name, "#{yyyymmdd}.log")
+    end
+  
+    def create_now_backup_path yyyymmdd, item
+      today_backup = File.join(@destination, yyyymmdd, item.name)
+      FileUtils.mkdir_p today_backup
+      today_backup
+    end
+  
+  end
+end

data/lib/anjea_backup/inifile.rb

@@ -0,0 +1,39 @@
+class NoIniFileError < StandardError
+end
+
+def is_head? line
+  match_data = /(\[)([\w-]*)(\])/.match line
+  match_data
+end
+
+def get_category line
+  match_data = /(\[)([\w-]*)(\])/.match line
+  match_data.captures[1]
+end
+
+def get_kv line
+  match_data = /([A-Za-z0-9]*) *= *([A-Za-z0-9\/ .\-_]*)/.match line
+  match_data.captures
+end
+
+def read_ini_file filename
+  ini_objs = []
+  file_contents = File.readlines(filename)
+  rescue Errno::ENOENT
+    raise NoIniFileError, "#{filename} config file error"
+  ini_obj = {}
+  file_contents.each do |line|
+    next if(line.strip.empty? || line.start_with?("#"))
+    if is_head? line
+      ini_objs << ini_obj if !ini_obj.empty?
+      ini_obj = {}
+      ini_obj[:name] = get_category line
+      next
+    end
+    kv = get_kv line
+    ini_obj[kv[0]] = kv[1]
+  end
+  ini_objs << ini_obj
+  ini_objs
+end
+

data/lib/anjea_backup/version.rb

@@ -0,0 +1,3 @@
+module AnjeaBackup
+  VERSION = "0.0.1"
+end

data/lib/anjea_backup.rb

@@ -0,0 +1,7 @@
+require "anjea_backup/version"
+require "anjea_backup/anjea_backup"
+require "anjea_backup/inifile"
+
+module AnjeaBackup
+  # Our code goes here...
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: anjea_backup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Felix Wolfsteller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: ''
+email:
+- felix.wolfsteller@gmail.com
+executables:
+- anjea
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- anjea.conf.example
+- anjea_backup.gemspec
+- backups.conf.example
+- bin/anjea
+- lib/anjea_backup.rb
+- lib/anjea_backup/anjea_backup.rb
+- lib/anjea_backup/inifile.rb
+- lib/anjea_backup/version.rb
+homepage: https://github.com/fwolfst/anjea_backup/
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Backup with ruby, rsync, hardlinks, hacks, without style but with aboriginal
+  mystery.
+test_files: []