smarbs 0.9.3

data/lib/helpers.rb

@@ -0,0 +1,438 @@
+require 'fileutils'
+require 'types'
+require 'smarbs'
+
+class ConfigString
+  # Takes as args the arguments to the specific type (like positive), as desc
+  # the description of the value, and as defaults an Array or a single default
+  # value that is shown when no other value is added.
+  def initialize(name, args, desc, defaults)
+    @list = false
+    @positive = false
+    args.split(",").each{|arg| eval("@#{arg} = true") unless arg.empty?}
+    @desc = desc
+    @defaults = defaults
+    @defaults = "" if @defaults.empty?
+    @name = name
+    clear
+    value
+  end
+
+  # Returns the value, as an Array if list is false, as a single value
+  # otherwise. If the value is empty, return the default value(s).
+  def value
+    val = nil
+    if @value.empty? then
+      set(@defaults)
+      val = @value
+      clear
+    else
+      val = @value
+    end
+    if @list then
+      val
+    else
+      val[0]
+    end
+  end
+
+  # Returns the name of this option.
+  def name
+    @name
+  end
+
+  # Prints out the configfile-text with description.
+  def to_s
+    if @list then
+      ([@desc] + value.collect{|value| format(value)}).join("\n" + name + " ")
+    else
+      @desc + "\n" + name + " " + format(value)
+    end
+  end
+
+  # Adds the value(s) to @value (can be an Array). Doesn't strip!
+  def add(value)
+    if value.class == Array then
+      value.each{ |v| addvalue(v) }
+    else
+      addvalue(value)
+    end
+  end
+
+  # Sets the value as value of the object (can be an Array).
+  def set(value)
+    clear
+    add(value)
+  end
+
+  def clear
+    @value = []
+  end
+
+  private
+
+
+  # Adds the single string-value to @value
+  def addvalue(string)
+    raise "Only one '#{name}' allowed!" unless (@value.size == 0 or @list)
+    @value << check(string) unless @value.include?(check(string))
+  end
+
+  def check(string)
+    string.to_s
+  end
+
+  def format(value)
+    value.to_s
+  end
+end
+
+class ConfigDirectory < ConfigString
+  def check(string)
+    string.strip!
+    string.chop! if string[-1, 1] == "/" and string.size > 1
+    string
+  end
+end
+
+class ConfigSize < ConfigString
+  def check(value)
+    if value.class == Size then
+      value
+    else
+      Size.new(value)
+    end
+  end
+
+  def format(value)
+    value.short
+  end
+end
+
+class ConfigBoolean < ConfigString
+  def check(value)
+    if value == true or value == false then
+      value
+    else
+      value.downcase == "yes"
+    end
+  end
+
+  def format(value)
+    if value then "yes" else "no" end
+  end
+end
+
+class ConfigInteger < ConfigString
+  def check(value)
+    raise "Format #{value} not valid for an integer in '#{name}'!" unless value.to_i.to_s == value if value.class == String
+    value = value.to_i
+    raise "'#{name}' must be positive, you set it to #{value}!" unless value >= 0 if @positive
+    value
+  end
+end
+
+class ConfigExclude < ConfigString
+  def initialize(name, args, desc, defaults)
+    super(name, args + ",list", desc, defaults)
+  end
+end
+
+class ConfigTemplate
+
+  # Initializes a new ConfigTemplate and creates the internal structures needed.
+  # To read the actual data use read_template.
+  def initialize
+    @hash = Hash.new
+    @order = Array.new
+  end
+
+  # Returns everything within this ConfigTemplate as a parseable configfile
+  # text.
+  def to_s
+    out = ""
+    @order.each do |section|
+      out += preference_text(section[0]) + "\n\n"
+      section[1..-1].each do |option|
+        out +=  @hash[option].to_s + "\n\n"
+      end
+    end
+    out
+  end
+
+  def clear
+    @order.each do |section|
+      section[1..-1].each do |option|
+        @hash[option].clear
+      end
+    end
+  end
+
+  # Reads the template file at the given path and
+  def read_template(path)
+    sections = nil
+    File.open(path, "r") do |file|
+      sections = file.readlines
+      sections.each { |line| line.rstrip! }
+      sections = sections.join("\n").split("\n\n")
+    end
+
+    sections.each do |section|
+      parse_section(section)
+    end
+  end
+
+  # Parses the string (or Array of strings) as if it was part of a configfile,
+  # and *adds* the value accordingly, if it is not already there.
+  def parse(string)
+    if string.class == Array then
+      string
+    else
+      string.split("\n")
+    end.each do |line|
+      if line =~ /^(\w)+ +.+/
+        line = line.strip.split(" ", 2)
+        raise "No option '#{line[0]}' existing!" if @hash[line[0]].nil?
+        @hash[line[0]].add(line[1])
+      end
+    end
+  end
+
+  def preference_text(string)
+    i = (80 - string.length)/2
+    "-"*i + string + "-"*(80-i-string.length)
+  end
+
+  def parse_section(section)
+    if section[0,1] == "=" then
+      @order << [section[1..-2]]
+      return
+    end
+    lines = section.split("\n")
+    first = lines.shift.split(": ")
+    name = first.shift
+    raise InternalError, "Order still empty!" if @order.empty?
+    @order.last << name
+
+    classname = /^[^(]*/.match(first[0]).to_s
+                     arguments = /\(.*\)/.match(first[0]).to_s
+                     arguments = arguments[1..-2] unless arguments.nil?
+
+                     desc = []
+                     defaults = []
+                     lines.each do |line|
+                       if line =~ /^#{name} */ then
+                         defaults << line[(name.length+1)..-1] unless line[(name.length+1)..-1].nil?
+                       else
+                         desc << line
+                       end
+                     end
+                     @hash[name] = eval("Config#{classname}").new(name, arguments.to_s, desc.join("\n"), defaults)
+  end
+
+  private
+
+  def method_missing(name_orig, *args)
+    name = name_orig.to_s
+    if @hash.has_key?(name)
+      @hash[name].value
+    elsif @hash.has_key?(name[0..-2]) and name[-1] == "="[0]
+      @hash[name[0..-2]].set(args.first)
+    else
+      super
+    end
+  end
+end
+
+class ConfigFile
+
+  attr_reader :new
+
+  # Path should be a String. Creates or opens a new configfile and immediately
+  # writes it back again, to add new features etc (just in case).
+  def initialize(path)
+    @path = path
+    @template = ConfigTemplate.new
+    @template.read_template(SMARBS::DATADIR + "/configuration.txt")
+
+    if File.file?(@path)
+      raise @path + " is not writable!" if not File.writable?(@path)
+      read
+      write
+    else
+      if Directory.writable?(File.dirname(@path)) # Create example file
+        FileUtils.makedirs(File.dirname(@path)) # Create directory
+        write
+        puts "First run:\nConfig file created, edit " + @path + "!"
+        @new = true
+      else
+        raise(File.dirname(@path) + " is not writable!")
+      end
+    end
+  end
+
+  # Returns the filename (name only!) of the configfile.
+  def filename
+    return File.basename(@path)
+  end
+
+  # Puts the Configfile-text into the given file, with all the options as-is.
+  def write 
+    file=File.open(@path, "w")
+    file.puts intro
+    file.puts @template
+    file.puts outro
+    file.close
+  end
+
+  def intro
+    txt = nil
+    File.open(SMARBS::DATADIR + "/intro.txt", "r") do |file|
+      txt = file.readlines
+    end
+    txt[0] = txt[0].strip + " #{SMARBS::VERSION} (#{SMARBS::DATE})\n"
+    txt.join
+  end
+
+  def outro
+    txt = nil
+    File.open(SMARBS::DATADIR + "/outro.txt", "r") do |file|
+      txt = file.readlines
+    end
+    txt.join
+  end
+
+  def read
+    File.open(@path, "r") do |file|
+      lines = file.readlines
+      index1 = lines.index{|string| string.include? "-preferences-"}
+      index2 = lines.index{|string| string.include? "-end of preferences-"}
+
+      raise "Configfile #{@path} is invalid. Please delete it!" if index1 == nil or index2 == nil
+      @template.clear
+      @template.parse(lines[index1..index2])
+    end
+  end
+
+  private
+
+  def method_missing(name, *args)
+    eval "@template.#{name}(args[0])"
+  end
+end
+
+# Specifies a directory that contains smarbs backups.
+class SmarbsBackupDir < Directory
+  # Creates or reads out a SmarbsBackupDir, testing if it has valid contents.
+  def initialize(directory, ignore_leftovers=false)
+    super(directory, :writable)
+
+    return if files.size == 0 # Return if the directory is empty.
+    list = dirlist
+    numbers = list.collect {|x| x[0]}
+    raise "Two directories with same 'number' detected in " + @dir + "!" if numbers.uniq != numbers
+    raise "Directory with negative 'number' detected in #{@dir}!" if numbers[0] < 0
+    if (not ignore_leftovers) && directory_left
+      raise(NoConfigException, "\nAborted backup directory '#{directory_left}' left in #{@dir}\nMove or delete it to continue!")
+    end
+  end
+
+  public
+
+  # Returns the name of the directory (like 12-34-56-backup.0) when a
+  # '...backup.0' directory is left. Otherwise returns false.
+  def directory_left
+    list = dirlist
+    if list[0][0] == 0
+      return (list[0][1]).to_s+"-backup.0"
+    else
+      return false
+    end
+  end
+
+  # Returns a sorted array of arrays of the splitted directories within the smarbsbackupdir 
+  # of the form [7, 12-34-56] (from "12-34-56-backup.7").
+  # 
+  # Raises an error, if some directories are "malformed", respectively not in the form <date>-backup.<positive_number>.
+  def dirlist
+    list=files
+    for i in 0...list.size
+      raise "File '#{list[i]}' left in the destination directory #{@dir}!" if not File.directory?(@dir+"/"+list[i]) # No files are allowed.  
+
+      tmp = list[i].split("-backup.")
+      raise @dir + list[i] + " has wrong format!" if tmp.size != 2
+      raise @dir + list[i] + " has wrong format in number!" if tmp[1].to_i.to_s != tmp[1]
+
+      list[i]=[tmp[1].to_i, tmp[0]] # Converts "12-34-56-backup.7" to an Array entry [7, 12-34-56].
+    end
+    list.sort!
+    list.compact!
+    return list
+  end
+
+  # Deletes the directory differing most from the "1, 2, 4, 8, 16, ..." scheme.
+  # If no such is found, deletes the last of all the directories. Also logs what
+  # is happening.
+  # 
+  # Raises an error if the next deletion would go below the 'minbackuplevels'.
+  def delete(logger, minbackuplevels, oldestfirst = false)
+    list=dirlist
+    deleted=false
+
+    unless list.size > minbackuplevels or minbackuplevels <= 1
+      raise "Not enough space available, next deletion would go below your minbackuplevels of #{minbackuplevels}!"
+    end
+
+    unless list.size > 1
+      raise "Not enough space available to do an incremental backup!"
+    end
+
+    if oldestfirst then
+      a = dirlist[-1][1]
+      b = dirlist[-1][0]
+    else
+      for i in 0...(dirlist.size-1)
+        if (dirlist[i+1][0]-(2**i)).abs < (dirlist[i][0]-(2**i)).abs  && dirlist[i][0] != 0 #Smarbs CORE, the secret formula :)
+          deleted=true
+          a = dirlist[i][1]
+          b = dirlist[i][0]
+          break
+        end
+      end
+
+      if not deleted
+        a = dirlist[-1][1]
+        b = dirlist[-1][0]
+      end
+    end
+    logger.p("...removing backup." + b.to_s + "...", 1)
+    FileUtils.remove_dir(self.to_s + a + "-backup." + b.to_s)
+    logger.p(@dir.to_s + a + "-backup." + b.to_s + " removed!", 2, true)
+  end
+
+  # Removes all backups directories except the last one
+  # (the one with the smallest 'number').
+  # 
+  # Usually, this is "*-backup.0".
+  def remove_except_one
+    list = dirlist
+    for i in 1...list.size do
+      FileUtils.remove_dir "#{@dir}/#{list[i][1]}-backup.#{list[i][0]}"
+    end    
+  end
+
+  # Increments all the directory numbers by 1. So for example "12-34-56-backup.7" becomes "12-34-56-backup.8".
+  def increment
+    dirlist.reverse.each do |element|
+      original=@dir.to_s+element[1].to_s+"-backup."+element[0].to_s
+      incremented=@dir.to_s+element[1].to_s+"-backup."+(element[0]+1).to_s
+      FileUtils.move(original, incremented)
+    end
+  end
+end
+
+class NoConfigException < RuntimeError
+end
+
+class InternalError < RuntimeError
+end

data/lib/log.rb

@@ -0,0 +1,214 @@
+require 'net/smtp'
+require 'fileutils'
+require 'syslog'
+
+# Class to do automated logging to the console, to a logfile and to an email-account.
+# 
+# It is possible to set the verbosity of logging and various other options.
+#
+# $Id$
+
+class Log
+  # Initializes the logger object. Takes an (optional) path as argument, and 
+  # a string ("yes" or "no") or boolean value for the verbosity level within this logfile.
+  # 
+  # If the logfile is not yet existing, a new one will be created, if possible. Otherwise an error is thrown.
+  def initialize(logfile="", advancedlog=true, syslog=false)
+    @logfile=logfile.strip
+    @syslog = syslog
+    @mail_initialized = false
+    @smpt=false
+   
+    @logging_to_file = false 
+    unless @logfile == ""
+      @logfile.insert(0, '/') unless @logfile[0, 1].to_s == "/"
+      @logging_to_file = true
+    end
+    
+    @logging_to_file = false if @syslog
+    
+    @slog = SyslogWrapper.new() if @syslog
+    
+    @advancedlog=advancedlog
+    
+    if @logging_to_file and not Directory.writable?(@logfile)
+      @initialized = false
+      raise @logfile.to_s + " is not writable!"
+    elsif @logging_to_file and not File.file?(@logfile)
+      array = @logfile.split("/")
+      array.delete_at(-1)
+      FileUtils.makedirs("/" + array.join("/"))
+    end
+    @initialized = true
+  end
+  
+  public
+  # Initialize the email function, and check if all the given parameters are correct.
+  # If tls is true, then see if ruby-openssl is installed.
+  #  
+  # If any errors occur, it raises an error.
+  #
+  # Also sends a test email, if testm is set.
+  def initialize_email(email, smtp, port, uname, passwd, tls, testm, backupname)
+    @email=email
+    @smtp=smtp
+    @port=port
+    @uname=uname
+    @passwd=passwd
+    @tls=tls
+    @testm=testm
+    @backupname = backupname
+
+    if (@uname == "" and @passwd != "") or (@passwd == "" and @uname != "")
+      @mail_initialized=false
+      raise "Both or none of the uname and the passwd must be specified!"
+    end
+    
+    if @port == "" 
+      @mail_initialized = false
+      raise "Port mustn't be empty to send e-mails!"
+    end
+    if @smpt == "" 
+      @mail_initialized = false
+      raise "Smtp mustn't be empty to send e-mails!"
+    end
+    
+    unless (@email =~ /./ and @email =~ /@/)
+      @mail_initialized = false
+      raise "E-mail provided in Configfile is wrong or empty!"
+    end
+    
+    @mail_initialized=true
+
+    if @testm
+      text='From: smarbs <' +  @email + '>
+To: smarbs Admin <'+@email+'>
+Subject: Test email, ' + @backupname + '
+This test email was sent to check the smtp-connection of the configfile "' + @backupname + '".
+The "testm" option in the script should have been automatically disabled by now, 
+so you wont receive test emails anymore.
+
+---
+
+For any questions concerning smarbs, you can contact me here: rggjan@gmail.com'
+      sendmail(text)
+    end
+    
+  end
+  
+  
+  # if "date" is true, print the date into (only) the logfile. For example:
+  # 
+  # 01 Nov 2008 19h23: Backup NOT successful!
+  # 
+  # instead of
+  # 
+  # Backup NOT successful!
+  
+  # levels are:
+  # * 0: debug
+  # * 1: info
+  # * 2: notice
+  # * 3: warning
+  # * 4: error
+  # * 98: print only to command line (special case)
+  # * 99: successmail (special case)
+  
+  def p(message, level=1, date=false)
+    case level
+      when 0..1
+        puts message
+	@slog.log(message, level) if @syslog
+        message=Time.now.strftime("%d %b %Y %Hh%M: ")+message if date
+        File.open(@logfile, "a") {|f| f.puts message} if @logging_to_file and @advancedlog
+	
+      when 2..3
+        puts message
+	@slog.log(message, level) if @syslog
+        message=Time.now.strftime("%d %b %Y %Hh%M: ")+message if date
+        File.open(@logfile, "a") {|f| f.puts message} if @logging_to_file
+        
+      when 4
+	@slog.log(message, level) if @syslog
+        message = Time.now.strftime("\n%d %b %Y %Hh%M: Backup NOT successful!\n") + "The following error occured: " + message
+        puts message
+        File.open(@logfile, "a") {|f| f.puts message } if @logging_to_file
+      
+        if @mail_initialized
+          text='From: smarbs <' +  @email + '>
+To: smarbs Admin <'+@email+'>
+Subject: An error occured in ' + @backupname + '
+An error occured in ' + @backupname + ":\n" + message
+        
+          if @logging_to_file
+            text += '
+  
+Here is the full logfile: 
+    
+' + IO.read(@logfile)
+          end 
+          text +='
+
+---
+
+For any questions concerning smarbs, you can contact me here: rggjan@gmail.com'
+        sendmail(text)  
+        end
+        
+      when 98
+	puts message
+      when 99
+        if @mail_initialized then
+          text='From: smarbs <' +  @email + '>
+To: smarbs Admin <'+@email+'>
+Subject: Smarbs, backup "' + @backupname + '" successful
+Smarbs backup ended with the following message:
+' + message
+  
+          if @logging_to_file then text += '
+
+Here is the full logfile:
+
+' + IO.read(@logfile) 
+          end
+          text += '
+
+---
+
+For any questions concerning smarbs, you can contact me here: rggjan@gmail.com'
+          sendmail(text)
+        end  
+    end
+  end
+  
+  # Sends an email with the appropriate message.
+  def sendmail(message)
+    begin
+      smtp = Net::SMTP.new(@smtp, @port)
+      if @uname != "" 
+        if @tls then
+          smtp.enable_starttls
+          smtp.start("localhost.localdomain",@uname,@passwd, :plain) do |i|
+            i.send_message message, @email, @email
+          end
+        else
+          smtp.start("localhost.localdomain",@uname,@passwd, :login) do |i|
+            i.send_message message, @email, @email
+          end
+        end
+      else
+        smtp.start do |i|
+          i.send_message message, @email, @email 
+        end
+      end
+    rescue Timeout::Error
+      @mail_initialized=false
+      raise "Error, SMTP timed out, " + $!.to_s
+    rescue
+      @mail_initialized=false
+      raise "Error with SMTP authentification, " + $!.to_s
+    end
+  end
+end
+
+# $Id$