path: root/pyfirstaidkit/utils/backup.py

# File name: backup.py
# Date:      2008/03/14
# Author:    Martin Sivak <msivak at redhet dot com>
#
# Copyright (C) Red Hat 2008
#
# 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 2 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 should have received a copy of the GNU General Public License
# in a file called COPYING along with this program; if not, write to
# the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA
# 02139, USA.
from errors import NotImplemented
import os
import shutil
import hashlib
import weakref
import cPickle as pickle
import copy
import tempfile
import datetime

class BackupException(Exception):
    pass

class BackupStoreInterface(object):
    class Backup:
        def __init__(self, id):
            raise NotImplemented()

        def backupPath(self, path, name = None):
            raise NotImplemented()
        def backupValue(self, value, name):
            raise NotImplemented()

        def restoreName(self, name, path = None):
            raise NotImplemented()
        def restorePath(self, path, name = None):
            raise NotImplemented()
        def restoreValue(self, name):
            raise NotImplemented()

        def delete(self, name):
            raise NotImplemented()
        def cleanup(self):
            raise NotImplemented()

        def exists(self, name = None, path = None):
            raise NotImplemented()

    def __init__(self):
        raise NotImplemented()

    def getBackup(self, id, persistent = False):
        raise NotImplemented()

    def closeBackup(self, id):
        raise NotImplemented()

    def __del__(self):
        raise NotImplemented()

class FileBackupStore(BackupStoreInterface):
    _singleton = None

    class Backup(BackupStoreInterface.Backup):
        def __init__(self, id, path, reverting = False):
            self._id = id
            self._path = path
            self._metafile = "__meta.pickle"
            self._data = {} # name -> (stored as, origin)
            self._origin = {} # origin -> name
            # Because the dir is suppose to be there when we are reverting.
            if not reverting:
                os.makedirs(self._path)

        def saveMeta(self):
            f = open(os.path.join(self._path, self._metafile), "wb")
            pickle.dump((self._id, self._data, self._origin), f, \
                    pickle.HIGHEST_PROTOCOL)
            f.close()
            return True

        def loadMeta(self):
            f = open(os.path.join(self._path, self._metafile), "rb")
            (id, data, origin) = pickle.load(f)
            f.close()

            if id==self._id:
                self._data = data
                self._origin = origin
            else:
                raise BackupException("Loading metadata for different Backup " \
                        "(ID mismatch: '%s' and '%s')" % (self._id, id))

            return True

        def backupPath(self, path, name = None):
            if name is None:
                name = path

            if self._origin.has_key(path):
                raise BackupException("Path %s already in the backup store %s!"
                        % (path,self._id))
            if self._data.has_key(name):
                raise BackupException("Named backup %s already in the backup "
                        "store %s!" % (name,self._id))

            stored = hashlib.sha224(name).hexdigest()

            if os.path.isdir(path):
                shutil.copytree(path, os.path.join(self._path, stored),
                        symlinks = True)
            else:
                shutil.copy2(path, os.path.join(self._path, stored))

            self._origin[path] = name
            self._data[name] = (stored, path)

            self.saveMeta()

            return True

        def backupValue(self, value, name):
            if self._data.has_key(name):
                raise BackupException("Named backup %s already in the backup "
                        "store %s!" % (name,self._id))
            stored = hashlib.sha224(name).hexdigest()

            f = open(os.path.join(self._path, stored), "wb")
            pickle.dump(value, f, pickle.HIGHEST_PROTOCOL)
            f.close()

            self._data[name] = (stored, None)

            self.saveMeta()

            return True

        def restoreValue(self, name):
            stored, origin = self._data[name]
            if origin is not None:
                raise BackupException("Named backup %s is not a value object!"
                        % (name,))


            f = open(os.path.join(self._path, stored), "rb")
            val = pickle.load(f)
            f.close()

            return val

        def restoreName(self, name, path = None):
            stored, origin = self._data[name]
            if origin is None:
                raise BackupException("Named backup %s is not a filesystem "
                        "object!" % (name,))

            assert self._origin[name]==origin

            if path is None:
                path = origin

            if os.path.exists(path):
                if os.path.isdir(path):
                    shutil.rmtree(path)
                else:
                    os.unlink(path)

            stored = os.path.join(self._path, stored)

            if os.path.isdir(stored):
                shutil.copytree(stored, path, symlinks = True)
            else:
                shutil.copy2(stored, path)
            return True

        def restorePath(self, path, name = None):
            assert self._data[self._origin[path]][1]==path

            if name is None:
                name = self._origin[path]

            return self.restoreName(name, path)

        def delete(self, name):
            stored, origin = self._data[name]
            stored = os.path.join(self._path, stored)

            if os.path.isdir(stored):
                shutil.rmtree(stored)
            else:
                os.unlink(stored)

            del self._data[name]
            if origin is not None:
                del self._origin[origin]

            self.saveMeta()

            return True

        def cleanup(self):
            _datakeys = self._data.keys()
            for name in _datakeys:
                self.delete(name)
            try:
                os.remove(os.path.join(self._path, self._metafile))
            except OSError:
                pass
            os.rmdir(self._path)
            return True

        def exists(self, name=None, path=None):
            if name == None and path == None:
                raise BackupException("Cannot call the exists method with both "
                        "the arguments equal to None")

            if name != None and path != None:
                try:
                    if self._data[name] == path:
                        return True
                    else:
                        return False
                except KeyError:
                    return False

            if name != None and self._data.has_key(name):
                return True

            if path != None and self._origin.has_key(path):
                return True

            return False

    class BackupPersistent(Backup):
        def cleanup(self):
            self.saveMeta()
            return False

    def __init__(self, rootpath = "/tmp", fullpath = ""):
        if self.__class__._singleton:
            raise BackupException("BackupStore with %s type can have only "
                    "one instance" % (self.__name__,))

        assert self.__class__._singleton==None

        if fullpath:
            if os.path.isdir(fullpath):
                raise BackupException("Backupdir %s already exists. Erase "
                        "dir or change backup dir." % self._path)
            else:
                self._path = fullpath
                os.makedirs(fullpath)

        else:
            if not os.path.isdir(rootpath):
                os.makedirs(rootpath)
            timestamp = datetime.datetime.now().strftime("%Y%m%d_%H%m%S")
            self._path = tempfile.mkdtemp(prefix = "fakbackup-%s-"%timestamp,
                    dir = rootpath)

        self._backups = {}

        self.__class__._singleton = weakref.proxy(self)
        print("Backup system initialized")

    def getBackup(self, id, persistent = False):
        if not self._backups.has_key(id):
            if persistent:
                self._backups[id] = self.BackupPersistent(id, self._path+"/"+id+"/")
            else:
                self._backups[id] = self.Backup(id, self._path+"/"+id+"/")
        return self._backups[id]

    def closeBackup(self, id):
        if not self._backups.has_key(id):
            raise BackupException("Backup with id %s does not exist" % (id,))
        if self._backups[id].cleanup():
            del self._backups[id]

    def __del__(self):
        if self.__class__._singleton is None:
            return

        backupEmpty = True

        for id,backup in self._backups.iteritems():
            backupEmpty = backupEmpty and backup.cleanup()

        if backupEmpty:
            os.rmdir(self._path)
        else:
            print("I'm keeping persistent backup spaces intact in %s" % (self._path,))


        print("Backup closed")

    @classmethod
    def get(cls, path):
        if cls._singleton:
            return cls._singleton
        else:
            return cls(path)