smarbs 0.9.3

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.9.3 / 2009-12-16
+
+* First gem release

data/Manifest.txt

@@ -0,0 +1,28 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/smarbs
+lib/backup.rb
+lib/data/configuration.txt
+lib/data/iconblue.png
+lib/data/icongreen.png
+lib/data/iconred.png
+lib/data/intro.txt
+lib/data/outro.txt
+lib/helpers.rb
+lib/log.rb
+lib/script.rb
+lib/smarbs.rb
+lib/syslog.rb
+lib/types.rb
+test/smarbs_test.rb
+test/test_backup.rb
+test/test_helpers.rb
+test/test_log.rb
+test/test_script.rb
+test/test_smarbs.rb
+test/test_smarbs_test.rb
+test/test_suite.rb
+test/test_types.rb

data/README.txt

@@ -0,0 +1,88 @@
+= smarbs
+
+* http://smarbs.sourceforge.net
+
+== DESCRIPTION:
+
+smarbs is a backup script written in ruby capable of doing intelligent and
+automated backups using rsync.
+
+== FEATURES/PROBLEMS:
+
+Smarbs was designed to be
+
+* fast
+* incremental
+* able to take full snapshots
+* space managing
+* able to handle several sources
+* automated 
+
+== SYNOPSIS:
+
+Run smarbs --help to see what options you have. The configfiles are stored
+in the directory /etc/smarbs or ~/.smarbs, if not executed as root.
+
+= Syslog
+
+Smarbs can log to syslog instead of directly to file. Note, you
+should only enable this feature if you know what you are doing, and
+have root access. 
+
+Example configuration for syslog-ng, this will log everything "smarbs"
+into separate file.
+
+ destination smarbs      { file("/var/log/smarbs.log"
+                            template("$FULLDATE [$LEVEL] $MSG\n")
+                            template_escape(no) );
+                          };
+  filter f_smarbs         { program(smarbs); };
+log { source(src); filter(f_smarbs);      destination(smarbs); };
+
+To filter out some less important information, try:
+
+  filter f_smarbs         { program(smarbs) and level(notice..err); };
+
+Also, if you put $ISODATE there instead of $FULLDATE, you will get
+date in ISO-standard format.
+
+== REQUIREMENTS:
+
+* Ruby 1.9.1
+* rsync
+* standard unix tools (du, df, ...)
+* optional: ruby-gtk2: For status icon while backupping
+* optional: syslog-ng: For syslog functionality
+
+
+== INSTALL:
+
+* sudo gem install 
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(GPL)
+
+Copyright (c) 2009 Jan Rüegg <rggjan@gmail.com>
+
+Smarbs is free software; you can redistribute it and/or modify it 
+under the terms of the GNU General Public License as published by 
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of 
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
+General Public License for more details.
+
+You can find a copy of the GNU General Public License under 
+http://www.gnu.org/licenses/

data/Rakefile

@@ -0,0 +1,10 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'smarbs' do
+  developer('Jan Rueegg', 'rggjan@gmail.com')
+end
+
+# vim: syntax=ruby

data/bin/smarbs

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+require 'script'
+require 'types'
+
+$stdout.sync = true # rsync "realtime" output
+
+if Directory.writable?("/etc/smarbs")
+	script=Script.new("/etc/smarbs", ARGV)
+else
+	script=Script.new(File.expand_path("~/.smarbs"), ARGV)
+end

data/lib/backup.rb

@@ -0,0 +1,275 @@
+require 'log'
+require 'helpers'
+require 'types'
+
+# A class that has individual backups as instances.
+class Backup
+
+  # Initializes the a backup, takes as arguments a Configfile, some
+  # rsync_arguments and the information if it should be verbose.
+  def initialize(path, rsync_arguments, verbose)
+    @rsync_arguments = rsync_arguments
+    @verbose = verbose
+    @logger = nil
+    @configfile = nil
+    
+    begin 
+      @configfile = ConfigFile.new(path)
+
+      logfile = @configfile.logfile
+      if logfile == ""
+        if @configfile.logdir == ""
+          logfile = "/tmp/" + Time.now.strftime("%Y-%m-%d.%Hh%M")
+        else
+          logfile = @configfile.logdir + "/" + Time.now.strftime("%Y-%m-%d.%Hh%M")+"-"+@configfile.filename.to_s+".log"
+        end
+      else
+        logfile = @configfile.logfile
+      end
+
+      @logger = Log.new(logfile, @configfile.advancedlog, @configfile.syslog)
+
+      @configfile.write
+      
+      @logger.p("-" * 20, 98)
+      @logger.p("Working on " + @configfile.filename, 2)
+      @logger.p("-" * 20, 98)
+      @logger.p("\nChecking configfile...")
+      
+      if @configfile.sendmail
+        @logger.initialize_email(@configfile.email, @configfile.smtp,
+          @configfile.port, @configfile.uname, @configfile.passwd,
+          @configfile.tls, @configfile.testm, path.split("/")[-1])
+        if @configfile.testm
+          @logger.p("The test e-mail has been successfully sent to " + @configfile.email + ",", 2, 1)
+          @configfile.testm=false
+          @configfile.write
+          @logger.p("testm has been automatically set to 'no'.", 2, 1)            
+        end  
+      end
+      
+      raise "No 'rsync' installed!" unless command_exists?("rsync")
+      raise "No 'du' installed!" unless command_exists?("du")      
+      raise "No 'df' installed!" unless command_exists?("df")
+      readcf
+      
+      if not @configfile.execute_before.empty? then
+        output = `#{@configfile.execute_before} 2>&1`
+        raise "execute_before command '" + @configfile.execute_before + "' was not successful, aborting!\nThis was the output generated:\n" + output unless $?.exitstatus == 0
+      end
+      
+      @backup_dir = SmarbsBackupDir.new(@configfile.dest + "/" + "smarbsbackup", @configfile.ignore_leftovers)
+      
+      backup
+      
+      if not @configfile.execute_after.empty? then
+        output = `#{@configfile.execute_after} 2>&1`
+        raise(AfterException, "execute_after command '" + @configfile.execute_after + "' was not successful, aborting!\nThis was the output generated:\n" + output) unless $?.exitstatus == 0
+      end
+    
+    rescue AfterException
+      message =  $!.to_s + "\nCheck your configfile " + path + "."
+      if @logger.nil?
+        puts "Error: " + message
+      else
+        @logger.p(message, 4)
+      end
+    rescue NoConfigException
+      @configfile.execute_after = "" if @configfile.execute_after.nil?
+      message =  $!.to_s
+      if not @configfile.execute_after.empty? then
+        output = `#{@configfile.execute_after} 2>&1`
+        if $?.exitstatus != 0 then
+          message = "execute_after command '" + @configfile.execute_after + "' was not successful, aborting!\nThis was the output generated:\n" + output + "\nAlso, your backup was aborted: " + message
+        end
+      end
+      if @logger.nil?
+        puts "Error: " + message
+      else
+        @logger.p(message, 4)
+      end
+    rescue
+      message =  $!.to_s + "\nCheck your configfile " + path + "."
+      @configfile.execute_after = "" if @configfile.execute_after.nil? unless @configfile.nil?
+      if not @configfile.execute_after.empty? then
+        output = `#{@configfile.execute_after} 2>&1`
+        if $?.exitstatus != 0 then
+          message = "execute_after command '" + @configfile.execute_after + "' was not successful, aborting!\nThis was the output generated:\n" + output + "\nAlso, your backup was aborted: " + message
+        end
+      end unless @configfile.nil?
+      if @logger.nil?
+        puts "Error: " + message
+      else
+        @logger.p(message, 4)
+      end
+    end
+  end
+
+  private
+  
+  def command_exists?(command)
+    `#{command} --version 2>/dev/null`
+    return $?.exitstatus == 0
+  end
+  
+  def readcf
+    raise "No source directory specified!" unless @configfile.src != [""]
+    @configfile.src.each do |dir|
+      raise "Source directory/file " + dir + " not existing!" unless File.directory?(dir) or File.file?(dir)
+    end
+    raise "No destination directory specified!" unless @configfile.dest != ""
+    
+    @options = ""
+    @options += " --exclude='" + @configfile.exclude.join("' --exclude='") + "'" unless @configfile.exclude[-1] == ""
+    @options += " -rltD"
+
+    
+    @options += "og" if @configfile.preserveowner
+    @options += "p" if @configfile.preservepermissions
+    @options += "v --progress " if @verbose or @configfile.verbose
+    @options += " -x " if @configfile.onefilesystem
+    @options += " --relative " if @configfile.relative
+    @options += " --modify-window=#{@configfile.modifywindow}" if @configfile.modifywindow != 0
+  end
+
+  def make_space(used, avail, text_only=false)
+    @logger.p("", 2)
+    @logger.p("estimated new space used: " + Size.new(used).opt, 2)
+    @logger.p("available space: " + Size.new(avail).opt, 2)
+    @backup_dir.delete(@logger, @configfile.minbackuplevels, @configfile.oldestfirst) unless text_only
+  end
+
+  def delete(to_free)
+    while (@backup_dir.dirlist.size >= @configfile.maxbackuplevels) do
+      @logger.p("", 98)
+      @logger.p("maxbackuplevels: " + @configfile.maxbackuplevels.to_s, 1)
+      @logger.p("backups: " + @backup_dir.dirlist.size.to_s, 1)
+      @backup_dir.delete(@logger, @configfile.minbackuplevels, @configfile.oldestfirst)
+    end unless @configfile.maxbackuplevels == 0
+
+    if @configfile.ownpartition then
+      now_free=@backup_dir.free
+      while to_free > now_free do
+        make_space(to_free, now_free)
+        now_free=@backup_dir.free
+      end
+      make_space(to_free, now_free, true)
+      cursize = @backup_dir.space(true)
+    elsif @configfile.exclusive then
+      cursize=@backup_dir.space
+      while cursize + to_free > @configfile.limit.b do
+        before = @backup_dir.free
+        make_space(to_free, @configfile.limit.b-cursize)
+        after = @backup_dir.free
+        cursize -= (after - before)
+      end
+      make_space(to_free, @configfile.limit.b-cursize, true)
+    else
+      cursize=@backup_dir.space
+      while cursize + to_free > @configfile.limit.b do
+        make_space(to_free, @configfile.limit.b-cursize)
+        cursize=@backup_dir.space
+      end
+      make_space(to_free, @configfile.limit.b-cursize, true)
+    end
+    @logger.p("", 98)
+    return cursize
+  end
+  
+  def backup
+
+    dest = @backup_dir.to_s + Time.now.strftime("%Y-%m-%d.%Hh%M") + "-backup.0"
+
+    if @configfile.ignore_leftovers
+      directory_left = @backup_dir.directory_left
+      if directory_left
+        @logger.p("Warning: Aborted backup directory #{directory_left} detected.
+Resuming backup there because of ignore_leftovers option.", 3)
+
+        orig_dest = dest
+        dest = @backup_dir.to_s + directory_left
+      end
+    end
+
+    if @backup_dir.dirlist.size!=0
+      if orig_dest
+        linkdest=@backup_dir.to_s+(@backup_dir.dirlist[1][1]).to_s+"-backup."+(@backup_dir.dirlist[1][0]).to_s
+      else
+        linkdest=@backup_dir.to_s+(@backup_dir.dirlist[0][1]).to_s+"-backup."+(@backup_dir.dirlist[0][0]).to_s
+      end
+      @rsync_arguments += " --link-dest='" + linkdest + "' "
+    end
+    
+    @logger.p("\nCalculating required space...", 1)
+    
+    required = `rsync #@options #@rsync_arguments -n --stats --delete '#{@configfile.src.join"' '"}' '#{dest}/' 2>/dev/null | tail -n 11 | (read a b c d e f; echo $e)`.to_f
+    
+    @logger.p("\nDeleting old backups...", 1)
+    
+    begin 
+      size_before=delete(required + @configfile.dirspace.b * 1.5)
+      
+      @logger.p("Backing up...\n\n", 2)
+      
+      system("rsync #@options #@rsync_arguments --delete '#{@configfile.src.join"' '"}' '#{dest}/'")
+      
+      success=$?.exitstatus
+      
+      case success
+      when 0
+        @logger.p("", 98) if @verbose  
+        @logger.p("Successfully backed up.\n\n", 2, 1)
+        @logger.p("Successfully backed up.", 99, 1) if @configfile.successmail
+      when 1
+        raise NoConfigException, "Your --pass-rsync argument '" + @rsync_arguments.to_s + "' is invalid!"
+      when 24
+        @logger.p("Warning: Some files couldn't be transferred because they vanished!", 3)
+        @logger.p("Successfully backed up.\n\n", 2, 1)
+        @logger.p("Successfully backed up.\n\n", 99, 1) if @configfile.successmail
+      when nil
+        raise NoConfigException, "rsync was stopped unexpectedly!"
+      else    
+        raise NoConfigException, "rsync failed with error code #{success}."
+      end
+
+      FileUtils.mv dest, orig_dest if orig_dest
+
+      @backup_dir.increment
+      
+      size_after = @backup_dir.space(@configfile.ownpartition)
+      newdirspace=size_after - size_before - required
+      newdirspace = newdirspace*1.1 # Safety margin
+      newdirspace = Size.new(newdirspace)
+      if @backup_dir.dirlist.size > 1
+        if newdirspace.b > @configfile.dirspace.b
+          @configfile.dirspace = newdirspace.b
+          @configfile.write
+        else
+          if newdirspace.b >= 0
+            @configfile.dirspace = @configfile.dirspace.b*0.9 + newdirspace.b*0.1
+          else
+            @configfile.dirspace = @configfile.dirspace.b*0.9
+          end
+          @configfile.write
+        end
+      end
+      
+      size_one = `du -bcs #{@backup_dir.to_s}*backup.1 | tail -1 | (read a b; echo $a)`.strip
+      
+      @logger.p("Additional Space used:   #{Size.new(size_after - size_before).opt}", 1)
+      @logger.p("Size of all the Backups: #{Size.new(size_after).opt}", 1)
+      @logger.p("Size of one full Backup: #{Size.new(size_one).opt}\n\n", 1)
+      if @configfile.ownpartition then
+        @logger.p("Limit:                   ignored (ownpartition is set)", 1)
+      else
+        @logger.p("Limit:                   " + @configfile.limit.opt, 1)
+      end
+    end
+  end
+end
+
+class AfterException < RuntimeError
+end
+
+class NoConfigException < RuntimeError
+end

data/lib/data/configuration.txt

@@ -0,0 +1,209 @@
+=preferences=
+
+src: Directory(list)
+ -- One or more directories to the source (= directory or file you need a backup
+ -- backup from. One directory / file per line only.
+src /directory/to/source1
+src /directory/to/source2
+
+dest: Directory
+ -- One (!) destination directory:
+dest /directory/to/the/destination
+
+limit: Size
+ -- Limit of space to use for the full and all the incremental backups:
+ -- (ignored when using "ownpartition", see below)
+limit 20m
+
+minbackuplevels: Integer(positive)
+ -- Minimum number of backups to keep.
+ -- Smarbs will throw an error if there is not enough space available to backup,
+ -- or the next deletion would go below "minbackuplevels".
+minbackuplevels 5
+
+verbose: Boolean
+ -- More output when a yes is here:
+verbose no
+
+=filesystems=
+
+ownpartition: Boolean
+ -- If there is an entire partition just for the backups, then here should be a
+ -- yes. Uses the whole partition for this backup, the limit set above is
+ -- ignored. This is MUCH faster than the normal space calculations, but
+ -- requires an own partition for every backup.
+ownpartition no
+
+exclusive: Boolean
+ -- Does deletion using 'df' instead of 'du', what increases speed (much).
+ -- Can ONLY be used, if NO other processes write to the destination partition
+ -- during the backup. Has only an effect when 'ownpartition' is false.
+exclusive no
+
+onefilesystem: Boolean
+ -- Don't cross filesystem boundaries. This tells smarbs to avoid crossing a
+ -- filesystem boundary when recursing. This does not limit the user's
+ -- ability to specify items to copy from multiple filesystems.
+onefilesystem no
+
+preserveowner: Boolean
+ -- Preserve the owner / group of files:
+ -- Owner preserving does NOT work if the script is not executed as superuser.
+preserveowner yes
+
+preservepermissions: Boolean
+ -- Preserve the permissions of files:
+preservepermissions yes
+
+modifywindow: Integer
+ -- When comparing two timestamps, smarbs treats the timestamps as being equal
+ -- if they differ by no more than the modifywindow value. This is normally
+ -- 0 (for an exact match), but you may find it useful to set this to a larger
+ -- value in some situations. In particular, when transferring to or from an
+ -- Windows FAT filesystem (which represents times with a 2-second resolution),
+ -- modifywindow 1 is useful (allowing times to differ by up to 1 second).
+modifywindow 0
+
+maxbackuplevels: Integer(positive)
+ -- Maximum number of backups to keep.
+ -- Smarbs will delete backups if there are more incremental backups than given
+ -- here. This may be useful if space calculations take too much time (due to
+ -- more and more incremental backups and hardlinks).
+ -- 0 means infinity and is recommended, if the speed is acceptable.
+maxbackuplevels 0
+
+dirspace: Size
+ -- How much space is used by hardlinks and directories? Used to do space
+ -- calculations. Should be adapted automatically by smarbs, so you shouldn't
+ -- have to touch that...
+dirspace 1m
+
+=advanced=
+
+execute_before: String
+ -- A command to execute (in a shell) before the backup is done.
+ -- Example:
+ -- execute_before mount /directory/to/source1
+execute_before
+
+execute_after: String
+ -- A command to execute (in a shell) after the backup , regardless if it was
+ -- successful or not.
+ -- Example:
+ -- execute_after umount /directory/to/source1
+execute_after
+
+relative: Boolean
+ -- Use  relative  paths. This means that the full path names of the sources are
+ -- sent to the backup folder rather than just the last parts of the filenames.
+ -- This is particularly useful when you want to backup several different
+ -- directories with the same name, or to preserve a whole directory structure.
+ -- So you get .../smarbsbackup/2008-03-01.11h10-backup.1/directory/to/source1
+ -- instead of just .../smarbsbackup/2008-03-01.11h10-backup.1/source1
+relative no
+
+oldestfirst: Boolean
+ -- Delete the oldest backups first when no more space is available, instead of
+ -- using the established "powers of two" algorithm, that keeps the backups 1,
+ -- 2, 4, 8, 16, 32 etc. Recommended to set to 'no'!
+ -- See https://sourceforge.net/apps/trac/smarbs/wiki/DeletionAlgorithm for more
+ -- informations.
+oldestfirst no
+
+exclude: String(list)
+ -- Directories / files to exclude. Path relative to the "root of transfer" when
+ -- starting with a "/". So "exclude /source1/foo" excludes files or directories
+ -- named foo in /directory/to/source1 while "exclude foo" excludes EVERY
+ -- directory or file named foo in source1 or source2. "exclude sub/foo" would
+ -- exclude EVERY file or directory named foo which is in a folder "sub".
+ -- Syntax: One line per exclude.
+ -- Example:
+ -- exclude *.jpg
+ -- exclude /sub/*/foo
+exclude
+
+ignore_leftovers: Boolean
+ -- Normally, when an aborted backup directory (...backup.0 instead of 1) is
+ -- detected, smarbs treats this as an error, stops and does not do a backup at
+ -- at all. When ignore_leftovers is set to "yes", it just prints a warning and
+ -- continues the last backup.
+ignore_leftovers: no
+
+=logging=
+
+logfile: Directory
+ -- Place of the (error) log file:
+ -- Example:
+ -- logfile /home/me/smarbslog.log
+logfile
+
+logdir: Directory
+ -- Place of a possible log directory. Has no effect when a logfile is set.
+ -- Otherwise, instead of writing logs into one file, logfiles are stored in the
+ -- directory below like this for each backup:
+ -- /.../logdir/2009-02-06.20h09-backup1.log
+ -- If logfile and logdir are not set, the logdir will be /tmp/
+ -- Example:
+ -- logdir /home/me/smarbslogs/
+logdir
+
+advancedlog: Boolean
+ -- Do advanced logging (show deletions, space informations etc. instead of just
+ -- success and failure messages).
+advancedlog yes
+
+syslog: Boolean
+ -- Log to syslog instead of build-in logger, above options will be ignored.
+ -- You will have to configure your syslog daemon accordingly, check README for
+ -- examples.
+ -- DO NOT enable unless you know what you are doing, and have root access
+syslog no
+
+=email notification=
+
+sendmail: Boolean
+ -- Send an email in case of an error, the logfile will be attached.
+sendmail no
+
+successmail: Boolean
+ -- Send also an email for successful backups:
+successmail no
+
+email: String
+ -- Email address to send it to.
+ -- Example:
+ -- email rggjan@gmail.com
+email
+
+smtp: String
+ -- Smtp server.
+ -- Example:
+ -- smtp smtp-auth.freesurf.ch
+smtp
+
+port: Integer
+ -- Port to use:
+port 25
+
+uname: String
+ -- When authentication is required, put here the username.
+ -- Example:
+ -- uname rggjan@gmail.com
+uname
+
+passwd: String
+ -- When authentication is required, put here the username.
+ -- Example:
+ -- passwd topsecret
+passwd
+
+tls: Boolean
+ -- Use tls (ssl). That's required for some smtp servers like Gmail.
+ -- You need to have ruby-openssl installed to use this!
+tls no
+
+testm: Boolean
+ -- Send a test email to see if your smtp options are ok. This should
+ -- definitely be a "yes" at the beginning to check if the connection works.
+ -- Will be automatically set to "no" once the email is successfully sent.
+testm yes

data/lib/data/intro.txt

@@ -0,0 +1,16 @@
+Smarbs space-managing-rsync-backup-script
+rsync and ruby are required!
+
+For each different backup you should create a file like this in the directory
+/home/"user"/.smarbs/ (or /etc/smarbs/ if you are root).
+
+You can start a backup using "smarbs backup1" or "smarbs homebackup" assuming
+there is a file named "backup1" or "homebackup" in the smarbs folder.
+A simple "smarbs" or a "smarbs all" will do a backup with all the different
+configurations in the smarbs directory.
+
+Sizes:    2394 Bytes     (B) =>  2394
+          32 Kibibytes (MiB) =>  32k
+          54 Mebibytes (MiB) =>  54m
+          2  Gibibytes (KiB) =>  2g
+

data/lib/data/outro.txt

@@ -0,0 +1,15 @@
+-------------------------------end of preferences-------------------------------
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+See <http://www.gnu.org/licenses/> for a copy of the GNU General Public License.
+
+For any suggestions, comments or bug reports, write to rggjan@gmail.com