selbackup 0.1.0

data/doc/js/searcher.js

@@ -0,0 +1,228 @@
+Searcher = function(data) {
+  this.data = data;
+  this.handlers = [];
+}
+
+Searcher.prototype = new function() {
+  // search is performed in chunks of 1000 for non-blocking user input
+  var CHUNK_SIZE = 1000;
+  // do not try to find more than 100 results
+  var MAX_RESULTS = 100;
+  var huid = 1;
+  var suid = 1;
+  var runs = 0;
+
+  this.find = function(query) {
+    var queries = splitQuery(query);
+    var regexps = buildRegexps(queries);
+    var highlighters = buildHilighters(queries);
+    var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++};
+    var _this = this;
+
+    this.currentSuid = state.n;
+
+    if (!query) return;
+
+    var run = function() {
+      // stop current search thread if new search started
+      if (state.n != _this.currentSuid) return;
+
+      var results =
+        performSearch(_this.data, regexps, queries, highlighters, state);
+      var hasMore = (state.limit > 0 && state.pass < 4);
+
+      triggerResults.call(_this, results, !hasMore);
+      if (hasMore) {
+        setTimeout(run, 2);
+      }
+      runs++;
+    };
+    runs = 0;
+
+    // start search thread
+    run();
+  }
+
+  /*  ----- Events ------  */
+  this.ready = function(fn) {
+    fn.huid = huid;
+    this.handlers.push(fn);
+  }
+
+  /*  ----- Utilities ------  */
+  function splitQuery(query) {
+    return jQuery.grep(query.split(/(\s+|::?|\(\)?)/), function(string) {
+      return string.match(/\S/)
+    });
+  }
+
+  function buildRegexps(queries) {
+    return jQuery.map(queries, function(query) {
+      return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i')
+    });
+  }
+
+  function buildHilighters(queries) {
+    return jQuery.map(queries, function(query) {
+      return jQuery.map(query.split(''), function(l, i) {
+        return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
+      }).join('');
+    });
+  }
+
+  // function longMatchRegexp(index, longIndex, regexps) {
+  //     for (var i = regexps.length - 1; i >= 0; i--){
+  //         if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false;
+  //     };
+  //     return true;
+  // }
+
+
+  /*  ----- Mathchers ------  */
+
+  /*
+   * This record matches if the index starts with queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassBeginning(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the longIndex starts with queries[0] and the
+   * longIndex matches all of the regexps
+   */
+  function matchPassLongIndex(index, longIndex, queries, regexps) {
+    if (longIndex.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the index contains queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassContains(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) == -1) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if regexps[0] matches the index and the record
+   * matches all of the regexps
+   */
+  function matchPassRegexp(index, longIndex, queries, regexps) {
+    if (!index.match(regexps[0])) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+
+  /*  ----- Highlighters ------  */
+  function highlightRegexp(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    for (var i=0, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function hltSubstring(string, pos, length) {
+    return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length);
+  }
+
+  function highlightQuery(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    var pos = 0;
+    var lcTitle = result.title.toLowerCase();
+
+    pos = lcTitle.indexOf(queries[0]);
+    if (pos != -1) {
+      result.title = hltSubstring(result.title, pos, queries[0].length);
+    }
+
+    result.namespace = result.namespace.replace(regexps[0], highlighters[0]);
+    for (var i=1, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function createResult(info) {
+    var result = {};
+    result.title = info[0];
+    result.namespace = info[1];
+    result.path = info[2];
+    result.params = info[3];
+    result.snippet = info[4];
+    return result;
+  }
+
+  /*  ----- Searching ------  */
+  function performSearch(data, regexps, queries, highlighters, state) {
+    var searchIndex = data.searchIndex;
+    var longSearchIndex = data.longSearchIndex;
+    var info = data.info;
+    var result = [];
+    var i = state.from;
+    var l = searchIndex.length;
+    var togo = CHUNK_SIZE;
+    var matchFunc, hltFunc;
+
+    while (state.pass < 4 && state.limit > 0 && togo > 0) {
+      if (state.pass == 0) {
+        matchFunc = matchPassBeginning;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 1) {
+        matchFunc = matchPassLongIndex;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 2) {
+        matchFunc = matchPassContains;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 3) {
+        matchFunc = matchPassRegexp;
+        hltFunc = highlightRegexp;
+      }
+
+      for (; togo > 0 && i < l && state.limit > 0; i++, togo--) {
+        if (info[i].n == state.n) continue;
+        if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) {
+          info[i].n = state.n;
+          result.push(hltFunc(info[i], queries, regexps, highlighters));
+          state.limit--;
+        }
+      };
+      if (searchIndex.length <= i) {
+        state.pass++;
+        i = state.from = 0;
+      } else {
+        state.from = i;
+      }
+    }
+    return result;
+  }
+
+  function triggerResults(results, isLast) {
+    jQuery.each(this.handlers, function(i, fn) {
+      fn.call(this, results, isLast)
+    })
+  }
+}
+

data/doc/panel/index.html

@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+	<title>search index</title>
+	<link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" charset="utf-8" />
+	<link rel="stylesheet" href="../css/panel.css" type="text/css" media="screen" charset="utf-8" />
+	<script src="../js/search_index.js" type="text/javascript" charset="utf-8"></script>
+	<script src="../js/searcher.js" type="text/javascript" charset="utf-8"></script>
+	<script src="tree.js" type="text/javascript" charset="utf-8"></script>
+	<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+	<script src="../js/searchdoc.js" type="text/javascript" charset="utf-8"></script>
+	<script type="text/javascript" charset="utf-8">
+    function placeholder() {
+        if ($('<input type="text">')[0].placeholder !== undefined) return;
+
+        $('#search-label').click(function() {
+            $('#search').focus();
+            $('#search-label').hide();
+        });
+
+        $('#search').focus(function() {
+            $('#search-label').hide();
+        });
+        $('#search').blur(function() {
+            this.value == '' && $('#search-label').show()
+        });
+
+        $('#search')[0].value == '' && $('#search-label').show();
+    }
+    $(function() {
+        placeholder();
+        $('#links').hide();
+        var panel = new Searchdoc.Panel($('#panel'), search_data, tree, window.parent.frames[1]);
+        $('#search').focus();
+
+        var s = window.parent.location.search.match(/\?q=([^&]+)/);
+        if (s) {
+            s = decodeURIComponent(s[1]).replace(/\+/g, ' ');
+            if (s.length > 0)
+            {
+                $('#search').val(s);
+                panel.search(s, true);
+            }
+        }
+    })
+	</script>
+</head>
+<body>
+    <div class="panel panel_tree" id="panel">
+        <div class="header">
+            <div>
+                <label for="search" id="search-label" style="display: none">Search</label>
+                <table>
+                <tr><td>
+                    <input type="Search" placeholder="Search" autosave="searchdoc" results="10" id="search" autocomplete="off"/>
+                </td></tr>
+            </table></div>
+        </div>
+        <div class="tree">
+            <ul>
+            </ul>
+        </div>
+        <div class="result">
+            <ul>
+            </ul>
+        </div>
+    </div>
+    <a href="links.html" id="links">index</a>
+</body>
+</html>

data/doc/panel/links.html

@@ -0,0 +1,16 @@
+<html>
+    <head>File index</head>
+    <body>
+    
+      <a href="../files/Gemfile.html">Gemfile</a>
+    
+      <a href="../files/LICENSE.html">LICENSE</a>
+    
+      <a href="../files/Rakefile.html">Rakefile</a>
+    
+      <a href="../files/lib/selbackup_rb.html">lib/selbackup.rb</a>
+    
+      <a href="../files/spec/selbackup_spec_rb.html">spec/selbackup_spec.rb</a>
+    
+    </body>
+</html>

data/doc/panel/tree.js

@@ -0,0 +1 @@
+var tree = [["","","files",[["Gemfile","files/Gemfile.html","",[]],["LICENSE","files/LICENSE.html","",[]],["Rakefile","files/Rakefile.html","",[]],["","","lib",[["selbackup.rb","files/lib/selbackup_rb.html","",[]]]],["","","spec",[["selbackup_spec.rb","files/spec/selbackup_spec_rb.html","",[]]]]]],["SelBackup","classes/SelBackup.html"," < Object",[]]]

data/lib/selbackup.rb

@@ -0,0 +1,376 @@
+require 'active_support/core_ext'
+require 'fog'
+
+# SelBackup Class
+#
+# Enables connection to s3 server and uploads files
+class SelBackup
+  # Attributes: informations required for connection to s3 server
+  attr_accessor :access_key, :access_secret, :bucket_name, :region
+
+
+  # Public: Initialize a new SelBackup instance.
+  #
+  # key:: A String representing the AWS ACCESS KEY ID.
+  #
+  # secret:: A String representing the AWS ACCESS KEY SECRET.
+  #
+  # bucket:: A String representing the name of the bucket ot use.
+  #
+  # :region (optional):: A String representing the region to conect to
+  #                      (default: 'eu-west-1').
+  #
+  # Examples
+  #
+  #   SelectraBackup.new('key', 'secret', 'bucket', region: 'us-east-1')
+  #
+  # Returns the newly instanciated object.
+  def initialize(key, secret, bucket, region = 'eu-west-1')
+    @access_key = key
+    @access_secret = secret
+    @bucket_name = bucket
+    @region = region
+  end
+
+
+  # Public: Returns the S3 bucket.
+  #
+  # Returns a Fog::Storage::AWS::Directory instance.
+  def bucket
+    @bucket ||= connection.directories.get(bucket_name)
+  end
+
+
+  # Public: daily check algorythm
+  #
+  # filename:: String which contains a filename. If you upload '2013-01-01-file.tgz', filename will be 'file.tgz'
+  #
+  # * If 7 daily files or less: does nothing
+  #
+  # * If more than 7 daily files but less than one week datediff between the latest daily file and the most recent weekly file: deletes the latest daily file
+  #
+  # * If more than 7 daily files but less than one week datediff between the latest daily file and the most recent weekly file: pushes the latest daily file to weekly file  
+  #    2013-01-01-daily-file.tgz -> 2013-01-01-weekly-file.tgz
+  #
+  # Returns true if a file as been push. False in other cases
+  def check_daily(filename, nb_day)
+    return_value = false
+    daily_directory = give_me_files(filename, "daily")
+    if ! daily_good?(daily_directory, nb_day)
+      weekly_directory = give_me_files(filename, "weekly")
+      latest_daily_file = give_me_latest_file(daily_directory)
+      recent_weekly_file = give_me_recent_file(weekly_directory)
+      if weekly_directory == [] || should_weekly?(latest_daily_file.key, recent_weekly_file.key)
+        weekly_file = gen_weekly_file({ key: latest_daily_file.key, body: latest_daily_file.body})
+        push_file(weekly_file)
+        return_value = true
+      end
+      delete_file(latest_daily_file)
+    end
+    return return_value
+  end
+
+
+  # Public: montlhy check algorythm
+  #
+  # filename:: String which contains a filename. If you upload '2013-01-01-file.tgz', filename will be 'file.tgz'
+  #
+  # * If 3 monthly files or less: does nothing
+  #
+  # * if more than 3 monthly files: deletes the latest monthly file
+  #
+  # Returns true if a file as been delete. False in other cases
+  def check_monthly(filename, nb_month)
+    return_value = false
+    monthly_directory = give_me_files(filename, "monthly")
+    if ! monthly_good?(monthly_directory, nb_month)
+      latest_monthly_file = give_me_latest_file(monthly_directory)
+      delete_file(latest_monthly_file)
+      return_value = true
+    end
+    return return_value
+  end
+
+
+  # Public: weekly check algorythm
+  #
+  # filename:: String which contains a filename. If you upload '2013-01-01-file.tgz', filename will be 'file.tgz'
+  #
+  # * If 4 weekly files or less: does nothing
+  #
+  # * If more than 4 weekly files but less than one month datediff between the latest weekly file and the most recent monthly file: deletes the latest weekly file
+  #
+  # * If more than 4 weekly files but less than one week datediff between the latest weekly file and the most recent monthly file: pushes the latest weekly file to monthly file
+  #     2013-01-01-weekly-file.tgz -> 2013-01-01-monthly-file.tgz
+  #
+  # Returns true if a file as been push. False in other cases
+  def check_weekly(filename, nb_week)
+    return_value = false
+    weekly_directory = give_me_files(filename, "weekly")
+    if ! weekly_good?(weekly_directory, nb_week)
+      monthly_directory = give_me_files(filename, "monthly")
+      latest_weekly_file = give_me_latest_file(weekly_directory)
+      recent_monthly_file = give_me_recent_file(monthly_directory)
+      if monthly_directory == [] || should_monthly?(latest_weekly_file.key, recent_monthly_file.key)
+        monthly_file = gen_monthly_file({ key: latest_weekly_file.key, body: latest_weekly_file.body})
+        push_file(monthly_file)
+        return_value = true
+      end
+      delete_file(latest_weekly_file)
+    end
+    return return_value
+  end
+
+
+  # Public: Returns the S3 connection.
+  #
+  # Returns a Fog::Storage::AWS::Real instance.
+  def connection
+    @connection ||= Fog::Storage.new(provider: 'AWS', aws_access_key_id: access_key, aws_secret_access_key: access_secret, region: region)
+  end
+
+
+  # Public: Check daily files number
+  #
+  # directoryFiles:: Array of daily files
+  #   ['file/2013-01-01-daily-file.tgz', 'file/2013-01-02-daily-file.tgz', ...]
+  #
+  # Returns false if there is more than 7 daily files. False in other cases
+  def daily_good?(directoryFiles, nb_day)
+    return directoryFiles.length > nb_day ? false : true;
+  end
+
+
+  # Public: deletes a file
+  #
+  # file:: Fog::Storage::AWS::Files file
+  #
+  # returns nothing
+  def delete_file(file)
+    file.destroy
+  end
+
+
+  # Public: Returns a virtual S3 directory.
+  #
+  # S3 doesn't know such a thing as a directory but it is possible to use a prefix to select only the files having a key starting with this prefix.
+  #
+  # path:: A String representing the prefix to use.
+  #
+  # Examples
+  #
+  #   sb = SelectraBackup.new('key', 'secret', 'bucket')
+  #   backup = sb.directory('backup/')
+  #   backup.files
+  #   # => <Fog::Storage::AWS::Files ...>
+  #
+  # Returns a Fog::Storage::AWS::Directory instance.
+  def directory(path)
+    connection.directories.get(bucket_name, prefix: path)
+  end
+
+
+  # Public: Returns the list of files.
+  #
+  # Returns a Fog::Storage::AWS::Files instances.
+  def files
+    bucket.files
+  end
+
+
+  # Public: returns lists of file
+  #
+  # filename: "file.tgz" for example
+  #
+  # type: specify if you want daily, weekly or monthly files
+  #
+  # Returns a sorted array
+  def give_me_files(filename, type)
+    full_directory = directory("#{filename}/")
+    files = []
+    full_directory.files.each do | file |
+      if file.key =~ /#{filename}\/\d{4}-\d{2}-\d{2}-#{type}-[\w+.]+/ ||
+         file.key =~ /#{filename}\/#{type}-\d{4}-\d{2}-\d{2}-[\w+.]+/
+          files.push(file)
+      end
+    end
+    return files
+  end
+
+
+  # Public: returns latest file
+  #
+  # files: array of AWS object file
+  #
+  # Returns the latest file, based on the date
+  def give_me_latest_file(files)
+    latest_file = files.first
+    files.each do | file |
+      if Date.parse(file.key.gsub('-', '')) < Date.parse(latest_file.key.gsub('-', ''))
+        latest_file = file
+      end
+    end
+    return latest_file
+  end
+
+
+  # Public: returns most recent file
+  #
+  # files: array of AWS object file
+  #
+  # Returns the most recent file, based on the date
+  def give_me_recent_file(files)
+    recent_file = files.first
+    files.each do | file |
+      if Date.parse(file.key.gsub('-', '')) > Date.parse(recent_file.key.gsub('-', ''))
+        recent_file = file
+      end
+    end
+    return recent_file
+  end
+
+
+  # Public: Check monthly files number
+  #
+  # files:: Array of monthly files
+  #   ['file/2013-01-01-monthly-file.tgz', 'file/2013-01-02-monthly-file.tgz', ...]
+  #
+  # Returns false if there is more than 3 monthly files. False in other cases
+  def monthly_good?(files, nb_month)
+    return files.length > nb_month ? false : true
+  end
+
+
+  # Public: gen a daily file
+  #
+  # file:: file you want to upload
+  #
+  # Returns an hash containing the filename, the key and the body of the daily file
+  def gen_daily_file(file)
+    name = File.basename(file)
+    if name =~ /[0-9]{4}-[0-9]{2}-[0-9]{2}(\.\w*)?$/
+      return false
+    elsif !(name =~ /[0-9]{4}-[0-9]{2}-[0-9]{2}-/)
+      name = "#{Date.today.to_s}-#{name}"
+    end
+    myname = name.split(/[0-9]{4}-[0-9]{2}-[0-9]{2}-/).last
+    mydate = name.split("-#{myname}").first
+    key = "#{myname}/#{mydate}-daily-#{myname}"
+    return { myname: myname, key: key, body: File.open(file) }
+  end
+
+
+  # Public: gen a monthly file
+  #
+  # file:: hash containing the key and the body of the weekly file you want to push to monthly file
+  #
+  # Returns an hash containing the key and the body of the monthly file
+  def gen_monthly_file(file)
+    if file[:key] =~ /[\w+.-]+\/[\w+.-]+-\d{4}-\d{2}-\d{2}-[\w+.-]+/
+      monthly_name = file[:key].sub("/weekly-", "/monthy-")
+    else
+      monthly_name = file[:key].sub("-weekly-", "-monthly-")
+    end
+    return { key: monthly_name, body: file[:body] }
+  end
+
+
+  # Public: gen a weekly file
+  #
+  # file:: hash containing the key and the body of the daily file you want to push to weekly file
+  #
+  # Returns an hash containing the key and the body of the weekly file
+  def gen_weekly_file(file)
+    if file[:key] =~ /[\w+.-]+\/[\w+.-]+-\d{4}-\d{2}-\d{2}-[\w+.-]+/
+      weekly_name = file[:key].sub("/daily-", "/weekly-")
+    else
+      weekly_name = file[:key].sub("-daily-", "-weekly-")
+    end
+    return { key: weekly_name, body: file[:body] }
+  end
+
+
+  # Public: pushes a file to s3 server
+  #
+  # file:: hash containing the key and the body of the file you want to upload
+  #
+  # Returns nothing
+  def push_file(file)
+    if file[:key] =~ /[\w+.-]+\/[\w+.-]+-\d{4}-\d{2}-\d{2}-[\w+.-]+/
+      filename = file[:key].split('/').first
+      name_parts = file[:key].split('/').last.split('-')
+      file[:key] = "#{filename}/#{name_parts[1]}-#{name_parts[2]}-#{name_parts[3]}-#{name_parts[0]}-#{filename}"
+    end
+    bucket.files.create(key: file[:key], body: file[:body])
+  end
+
+
+  # Public: date diff
+  #
+  # file1:: latest daily file
+  #
+  # file2:: most recent weekly file
+  #
+  # Returns true if datediff between the two files is upper than 7 days. False in other cases
+  def should_weekly?(file1, file2)
+    begin
+      date1 = Date.parse(file1.gsub('-', ''))
+      date2 = Date.parse(file2.gsub('-', ''))
+    rescue
+      print "Wrong date (Date.parse in should_monthly)."
+      return false
+    end
+    date_diff = date1 - date2
+    return date_diff.abs >= 7 ? true : false
+  end
+
+
+  # Public: date diff
+  #
+  # file1:: latest weekly file
+  #
+  # file2:: most recent monthly file
+  #
+  # Returns true if datediff between the two files is upper than 1 month. False in other cases
+  def should_monthly?(file1, file2)
+    begin
+      date1 = Date.parse(file1.gsub('-', '')).prev_month
+      date2 = Date.parse(file2.gsub('-', ''))
+    rescue
+      print "Wrong date (Date.parse in should_monthly)."
+      return false
+    end
+    return date1 >= date2 ? true : false
+  end
+
+  # Public: upload file algorythm
+  #
+  # file:: file you want to upload
+  #
+  # Uploads file as daily file and check daily, weekly and monthly full.
+  #
+  # Returns nothing
+  def upload_file(file, nb_day = 7, nb_week = 4, nb_month = 3)
+    daily_file = gen_daily_file(file)
+    if daily_file == false
+      return false
+    end
+    push_file(daily_file)
+    if check_daily(daily_file[:myname], nb_day)
+      if check_weekly(daily_file[:myname], nb_week)
+        check_monthly(daily_file[:myname], nb_month)
+      end
+    end
+  end
+
+
+  # Public: Check weekly files number
+  #
+  # files:: Array of daily files
+  #   ['file/2013-01-01-weekly-file.tgz', 'file/013-01-02-weekly-2file.tgz', ...]
+  #
+  # Returns false if there is more than 4 weekly files. False in other cases
+  def weekly_good?(directoryFiles, nb_week)
+    return directoryFiles.length > nb_week ? false : true
+  end
+end