# Linked module for extensions

EXTENSIONS = {}

# BRAND controls internal references in database and config to the products

# own name.

#

# NOTE: If you want compatibility with a database that was originally created

#  for use with the RhodeCode software product, change BRAND to "rhodecode",

#  either by editing here or by creating a new file:

#  echo "BRAND = 'rhodecode'" > kallithea/brand.py

BRAND = "kallithea"

try:

    from kallithea.brand import BRAND

except ImportError:

    pass

# Prefix for the ui and settings table names

DB_PREFIX = (BRAND + "_") if BRAND != "kallithea" else ""

# Users.extern_type and .extern_name value for local users

EXTERN_TYPE_INTERNAL = BRAND if BRAND != 'kallithea' else 'internal'

try:

    from kallithea.lib import get_current_revision

    _rev = get_current_revision(quiet=True)

    if _rev and len(VERSION) > 3:

        VERSION += ('%s' % _rev[0],)

except ImportError:

    pass

__version__ = ('.'.join((str(each) for each in VERSION[:3])))

__dbversion__ = 31  # defines current db version for migrations

__platform__ = platform.system()

__license__ = 'GPLv3'

__py_version__ = sys.version_info

__author__ = "Various Authors"

__url__ = 'https://kallithea-scm.org/'

is_windows = __platform__ in ['Windows']

is_unix = not is_windows

if len(VERSION) > 3:

    __version__ += '.'+VERSION[3]

    if len(VERSION) > 4:

        __version__ += VERSION[4]

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""

kallithea.lib.db_manage

~~~~~~~~~~~~~~~~~~~~~~~

Database creation, and setup module for Kallithea. Used for creation

of database as well as for migration operations

This file was forked by the Kallithea project in July 2014.

Original author and date, and relevant copyright and licensing information is below:

:created_on: Apr 10, 2010

:author: marcink

:copyright: (c) 2013 RhodeCode GmbH, and others.

:license: GPLv3, see LICENSE.md for more details.

"""

import os

import sys

import time

import uuid

import logging

from os.path import dirname as dn, join as jn

import datetime

from kallithea.model.user import UserModel

from kallithea.lib.utils import ask_ok

from kallithea.model import init_model

from kallithea.model.db import User, Permission, Ui, \

    Setting, UserToPerm, DbMigrateVersion, RepoGroup, \

    UserRepoGroupToPerm, CacheInvalidation, UserGroup, Repository

from sqlalchemy.engine import create_engine

from kallithea.model.repo_group import RepoGroupModel

#from kallithea.model import meta

from kallithea.model.meta import Session, Base

from kallithea.model.repo import RepoModel

from kallithea.model.permission import PermissionModel

from kallithea.model.user_group import UserGroupModel

log = logging.getLogger(__name__)

def notify(msg):

    """

    Notification for migrations messages

    """

    ml = len(msg) + (4 * 2)

    def create_tables(self, override=False):

        """

        Create a auth database

        """

        log.info("Any existing database is going to be destroyed")

        if self.tests:

            destroy = True

        else:

            destroy = ask_ok('Are you sure to destroy old database ? [y/n]')

        if not destroy:

            print 'Nothing done.'

            sys.exit(0)

        if destroy:

            Base.metadata.drop_all()

        checkfirst = not override

        Base.metadata.create_all(checkfirst=checkfirst)

        log.info('Created tables for %s' % self.dbname)

    def set_db_version(self):

        ver = DbMigrateVersion()

        ver.version = __dbversion__

        ver.repository_path = 'versions'

        self.sa.add(ver)

        log.info('db version set to: %s' % __dbversion__)

    def upgrade(self):

        """

        Upgrades given database schema to given revision following

        all needed steps, to perform the upgrade

        """

        from kallithea.lib.dbmigrate.migrate.versioning import api

        from kallithea.lib.dbmigrate.migrate.exceptions import \

            DatabaseNotControlledError

        if 'sqlite' in self.dburi:

            print (

               '********************** WARNING **********************\n'

               'Make sure your version of sqlite is at least 3.7.X.  \n'

               'Earlier versions are known to fail on some migrations\n'

               '*****************************************************\n')

        upgrade = ask_ok('You are about to perform database upgrade, make '

                         'sure You backed up your database before. '

[db_settings]

# Used to identify which repository this database is versioned under.

# You can use the name of your project.

# The name of the database table used to track the schema version.

# This name shouldn't already be used by your project.

# If this is changed once a database is under version control, you'll need to 

# change the table name in each database too. 

version_table=db_migrate_version

# When committing a change script, Migrate will attempt to generate the 

# sql for all supported databases; normally, if one of them fails - probably

# because you don't have that database installed - it is ignored and the 

# commit continues, perhaps ending successfully. 

# Databases in this list MUST compile successfully during a commit, or the 

# entire commit will fail. List the databases your application will actually 

# be using to ensure your updates to that database work properly.

# This must be a list; example: ['postgres','sqlite']

required_dbs=['sqlite']

"""

   SQLAlchemy migrate repository management.

"""

import os

import shutil

import string

import logging

from pkg_resources import resource_filename

from tempita import Template as TempitaTemplate

from kallithea.lib.dbmigrate.migrate import exceptions

from kallithea.lib.dbmigrate.migrate.versioning import version, pathed, cfgparse

from kallithea.lib.dbmigrate.migrate.versioning.template import Template

from kallithea.lib.dbmigrate.migrate.versioning.config import *

log = logging.getLogger(__name__)

class Changeset(dict):

    """A collection of changes to be applied to a database.

    Changesets are bound to a repository and manage a set of

    scripts from that repository.

    Behaves like a dict, for the most part. Keys are ordered based on step value.

    """

    def __init__(self, start, *changes, **k):

        """

        Give a start version; step must be explicitly stated.

        """

        self.step = k.pop('step', 1)

        self.start = version.VerNum(start)

        self.end = self.start

    def create_script(self, description, **k):

        """API to :meth:`migrate.versioning.version.Collection.create_new_python_version`"""

        k['use_timestamp_numbering'] = self.use_timestamp_numbering

        self.versions.create_new_python_version(description, **k)

    def create_script_sql(self, database, description, **k):

        """API to :meth:`migrate.versioning.version.Collection.create_new_sql_version`"""

        k['use_timestamp_numbering'] = self.use_timestamp_numbering

        self.versions.create_new_sql_version(database, description, **k)

    @property

    def latest(self):

        """API to :attr:`migrate.versioning.version.Collection.latest`"""

        return self.versions.latest

    @property

    def version_table(self):

        """Returns version_table name specified in config"""

        return self.config.get('db_settings', 'version_table')

    @property

    def id(self):

        """Returns repository id specified in config"""

    @property

    def use_timestamp_numbering(self):

        """Returns use_timestamp_numbering specified in config"""

        if self.config.has_option('db_settings', 'use_timestamp_numbering'):

            return self.config.getboolean('db_settings', 'use_timestamp_numbering')

        return False

    def version(self, *p, **k):

        """API to :attr:`migrate.versioning.version.Collection.version`"""

        return self.versions.version(*p, **k)

    @classmethod

    def clear(cls):

        # TODO: deletes repo

        super(Repository, cls).clear()

        version.Collection.clear()

    def changeset(self, database, start, end=None):

        """Create a changeset to migrate this database from ver. start to end/latest.

        :param database: name of database to generate changeset

        :param start: version to start at

        :param end: version to end at (latest if None given)