from __future__ import print_function

import sys
import traceback

from sqlalchemy import MetaData, Table
from sqlalchemy.exc import NoSuchTableError

import migrate.versioning.api as migrate

from sfa.util.sfalogging import logger
import sfa.storage.model as model

########## this class takes care of database upgrades
### upgrade from a pre-2.1 db 
# * 1.0 and up to 1.1-4:  ('very old')    
#       was piggybacking the planetlab5 database
#       this is kind of out of our scope here, we don't have the credentials 
#       to connect to planetlab5, but this is documented in
#       https://svn.planet-lab.org/wiki/SFATutorialConfigureSFA#Upgradingnotes
#       and essentially this is seamless to users
# * from 1.1-5 up to 2.0-x: ('old')
#       uses the 'sfa' db and essentially the 'records' table,
#       as well as record_types
#       together with an 'sfa_db_version' table (version, subversion)
# * from 2.1:
#       we have an 'records' table, plus 'users' and the like
#       and once migrate has kicked in there is a table named (see migrate.cfg)
#       migrate_db_version (repository_id, repository_path, version)
### after 2.1 
#       Starting with 2.1, we use sqlalchemy-migrate scripts in a standard way
#       Note that the model defined in sfa.storage.model needs to be maintained 
#       as the 'current/latest' version, and newly installed deployments will 
#       then 'jump' to the latest version number without going through the migrations
###
# An initial attempt to run this as a 001_*.py migrate script 
# did not quite work out (essentially we need to set the current version
# number out of the migrations logic)
# also this approach has less stuff in the initscript, which seems just right

class DBSchema:

    header="Upgrading to 2.1 or higher"

    def __init__ (self):
        from sfa.storage.alchemy import alchemy
        self.url=alchemy.url
        self.engine=alchemy.engine
        self.repository="/usr/share/sfa/migrations"

    def current_version (self):
        try:
            return migrate.db_version (self.url, self.repository)
        except:
            return None

    def table_exists (self, tablename):
        try:
            metadata = MetaData (bind=self.engine)
            table=Table (tablename, metadata, autoload=True)
            return True
        except NoSuchTableError:
            return False

    def drop_table (self, tablename):
        if self.table_exists (tablename):
            print("%s: Dropping table %s"%(DBSchema.header,tablename), file=sys.stderr)
            self.engine.execute ("drop table %s cascade"%tablename)
        else:
            print("%s: no need to drop table %s"%(DBSchema.header,tablename), file=sys.stderr)
        
    def handle_old_releases (self):
        try:
            # try to find out which old version this can be
            if not self.table_exists ('records'):
                # this likely means 
                # (.) we've just created the db, so it's either a fresh install, or
                # (.) we come from a 'very old' depl.
                # in either case, an import is required but there's nothing to clean up
                print("%s: make sure to run import"%(DBSchema.header,), file=sys.stderr)
            elif self.table_exists ('sfa_db_version'):
                # we come from an 'old' version
                self.drop_table ('records')
                self.drop_table ('record_types')
                self.drop_table ('sfa_db_version')
            else:
                # we should be good here
                pass
        except:
            print("%s: unknown exception"%(DBSchema.header,), file=sys.stderr)
            traceback.print_exc ()

    # after this call the db schema and the version as known by migrate should 
    # reflect the current data model and the latest known version
    def init_or_upgrade (self):
        # check if under version control, and initialize it otherwise
        if self.current_version() is None:
            before="Unknown"
            # can be either a very old version, or a fresh install
            # for very old versions:
            self.handle_old_releases()
            # in any case, initialize db from current code and reflect in migrate
            model.init_tables(self.engine)
            code_version = migrate.version (self.repository)
            migrate.version_control (self.url, self.repository, code_version)
            after="%s"%self.current_version()
            logger.info("DBSchema : jumped to version %s"%(after))
        else:
            # use migrate in the usual way
            before="%s"%self.current_version()
            migrate.upgrade (self.url, self.repository)
            after="%s"%self.current_version()
            if before != after:
                logger.info("DBSchema : upgraded version from %s to %s"%(before,after))
            else:
                logger.debug("DBSchema : no change needed in db schema (%s==%s)"%(before,after))
    
    # this trashes the db altogether, from the current model in sfa.storage.model
    # I hope this won't collide with ongoing migrations and all
    # actually, now that sfa uses its own db, this is essentially equivalent to 
    # dropping the db entirely, modulo a 'service sfa start'
    def nuke (self):
        model.drop_tables(self.engine)
        # so in this case it's like we haven't initialized the db at all
        try:
            migrate.drop_version_control (self.url, self.repository)
        except migrate.exceptions.DatabaseNotControlledError:
            logger.log_exc("Failed to drop version control")
        

if __name__ == '__main__':
    DBSchema().init_or_upgrade()