"""DB-API 2.0 compliant module

Take a look at http://www.python.org/peps/pep-0249.html

(most parts of this document are reported here in docstrings)

:organization: Logilab

:copyright: 2001-2009 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2.

:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr

:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses

"""

__docformat__ = "restructuredtext en"

from logging import getLogger

from time import time, clock

from logilab.common.logging_ext import set_log_methods

from cubicweb import ETYPE_NAME_MAP, ConnectionError, RequestSessionMixIn

from cubicweb.cwvreg import CubicWebRegistry, MulCnxCubicWebRegistry

from cubicweb.cwconfig import CubicWebNoAppConfiguration

_MARKER = object()

class ConnectionProperties(object):

    def __init__(self, cnxtype=None, lang=None, close=True, log=False):

        self.cnxtype = cnxtype or 'pyro'

        self.lang = lang

        self.log_queries = log

        self.close_on_del = close

def get_repository(method, database=None, config=None, vreg=None):

    """get a proxy object to the CubicWeb repository, using a specific RPC method.

    Only 'in-memory' and 'pyro' are supported for now. Either vreg or config

    argument should be given

    """

    assert method in ('pyro', 'inmemory')

    assert vreg or config

    if vreg and not config:

        config = vreg.config

    if method == 'inmemory':

        # get local access to the repository

        from cubicweb.server.repository import Repository

        return Repository(config, vreg=vreg)

    else: # method == 'pyro'

        from Pyro import core, naming

        from Pyro.errors import NamingError, ProtocolError

        core.initClient(banner=0)

        nsid = ':%s.%s' % (config['pyro-ns-group'], database)

        locator = naming.NameServerLocator()

        # resolve the Pyro object

        try:

            nshost, nsport = config['pyro-ns-host'], config['pyro-ns-port']

            uri = locator.getNS(nshost, nsport).resolve(nsid)

        except ProtocolError:

            raise ConnectionError('Could not connect to the Pyro name server '

                                  '(host: %s:%i)' % (nshost, nsport))

        except NamingError:

            raise ConnectionError('Could not get repository for %s '

                                  '(not registered in Pyro), '

                                  'you may have to restart your server-side '

                                  'application' % nsid)

        return core.getProxyForURI(uri)

def repo_connect(repo, user, password, cnxprops=None):

    """Constructor to create a new connection to the CubicWeb repository.

    Returns a Connection instance.

    """

    cnxprops = cnxprops or ConnectionProperties('inmemory')

    cnxid = repo.connect(unicode(user), password, cnxprops=cnxprops)

    cnx = Connection(repo, cnxid, cnxprops)

    if cnxprops.cnxtype == 'inmemory':

        cnx.vreg = repo.vreg

    return cnx

def connect(database=None, user=None, password=None, host=None,

            group=None, cnxprops=None, port=None, setvreg=True, mulcnx=True,

            initlog=True):

    """Constructor for creating a connection to the CubicWeb repository.

    Returns a Connection object.

    When method is 'pyro' and setvreg is True, use a special registry class

    (MulCnxCubicWebRegistry) made to deal with connections to differents instances

    in the same process unless specified otherwise by setting the mulcnx to

    False.

    """

    config = CubicWebNoAppConfiguration()

    if host:

        config.global_set_option('pyro-ns-host', host)

    if port:

        config.global_set_option('pyro-ns-port', port)

    if group:

        config.global_set_option('pyro-ns-group', group)

    cnxprops = cnxprops or ConnectionProperties()

    method = cnxprops.cnxtype

    repo = get_repository(method, database, config=config)

    if method == 'inmemory':

        vreg = repo.vreg

    elif setvreg:

        if mulcnx:

            vreg = MulCnxCubicWebRegistry(config, initlog=initlog)

        else:

            vreg = CubicWebRegistry(config, initlog=initlog)

        schema = repo.get_schema()

        for oldetype, newetype in ETYPE_NAME_MAP.items():

            if oldetype in schema:

                print 'aliasing', newetype, 'to', oldetype

                schema._entities[newetype] = schema._entities[oldetype]

        vreg.set_schema(schema)

    else:

        vreg = None

    cnx = repo_connect(repo, user, password, cnxprops)

    cnx.vreg = vreg

    return cnx

def in_memory_cnx(config, user, password):

    """usefull method for testing and scripting to get a dbapi.Connection

    object connected to an in-memory repository instance

    """

    if isinstance(config, CubicWebRegistry):

        vreg = config

        config = None

    else:

        vreg = None

    # get local access to the repository

    repo = get_repository('inmemory', config=config, vreg=vreg)

    # connection to the CubicWeb repository

    cnxprops = ConnectionProperties('inmemory')

    cnx = repo_connect(repo, user, password, cnxprops=cnxprops)

    return repo, cnx

class DBAPIRequest(RequestSessionMixIn):

    def __init__(self, vreg, cnx=None):

        super(DBAPIRequest, self).__init__(vreg)

        try:

            # no vreg or config which doesn't handle translations

            self.translations = vreg.config.translations

        except AttributeError:

            self.translations = {}

        self.set_default_language(vreg)

        # cache entities built during the request

        self._eid_cache = {}

        # these args are initialized after a connection is

        # established

        self.cnx = None   # connection associated to the request

        self._user = None # request's user, set at authentication

        if cnx is not None:

            self.set_connection(cnx)

    def base_url(self):

        return self.vreg.config['base-url']

    def from_controller(self):

        return 'view'

    def set_connection(self, cnx, user=None):

        """method called by the session handler when the user is authenticated

        or an anonymous connection is open

        """

        self.cnx = cnx

        self.cursor = cnx.cursor(self)

        self.set_user(user)

    def set_default_language(self, vreg):

        try:

            self.lang = vreg.property_value('ui.language')

        except: # property may not be registered

            self.lang = 'en'

        # use req.__ to translate a message without registering it to the catalog

        try:

            self._ = self.__ = self.translations[self.lang]

        except KeyError:

            # this occurs usually during test execution

            self._ = self.__ = unicode

        self.debug('request language: %s', self.lang)

    def decorate_rset(self, rset):

        rset.vreg = self.vreg

        rset.req = self

        return rset

    def describe(self, eid):

        """return a tuple (type, sourceuri, extid) for the entity with id <eid>"""

        return self.cnx.describe(eid)

    def source_defs(self):

        """return the definition of sources used by the repository."""

        return self.cnx.source_defs()

    # entities cache management ###############################################

    def entity_cache(self, eid):

        return self._eid_cache[eid]

    def set_entity_cache(self, entity):

        self._eid_cache[entity.eid] = entity

    def cached_entities(self):

        return self._eid_cache.values()

    def drop_entity_cache(self, eid=None):

        if eid is None:

            self._eid_cache = {}

        else:

            del self._eid_cache[eid]

    # low level session data management #######################################

    def session_data(self):

        """return a dictionnary containing session data"""

        return self.cnx.session_data()

    def get_session_data(self, key, default=None, pop=False):

        """return value associated to `key` in session data"""

        return self.cnx.get_session_data(key, default, pop)

    def set_session_data(self, key, value):

        """set value associated to `key` in session data"""

        return self.cnx.set_session_data(key, value)

    def del_session_data(self, key):

        """remove value associated to `key` in session data"""

        return self.cnx.del_session_data(key)

    def get_shared_data(self, key, default=None, pop=False):

        """return value associated to `key` in shared data"""

        return self.cnx.get_shared_data(key, default, pop)

    def set_shared_data(self, key, value, querydata=False):

        """set value associated to `key` in shared data

        if `querydata` is true, the value will be added to the repository

        session's query data which are cleared on commit/rollback of the current

        transaction, and won't be available through the connexion, only on the

        repository side.

        """

        return self.cnx.set_shared_data(key, value, querydata)

    # server session compat layer #############################################

    @property

    def user(self):

        if self._user is None and self.cnx:

            self.set_user(self.cnx.user(self))

        return self._user

    def set_user(self, user):

        self._user = user

        if user:

            self.set_entity_cache(user)

    def execute(self, *args, **kwargs):

        """Session interface compatibility"""

        return self.cursor.execute(*args, **kwargs)

set_log_methods(DBAPIRequest, getLogger('cubicweb.dbapi'))

# exceptions ##################################################################

class ProgrammingError(Exception): #DatabaseError):

    """Exception raised for errors that are related to the database's operation

    and not necessarily under the control of the programmer, e.g. an unexpected

    disconnect occurs, the data source name is not found, a transaction could

    not be processed, a memory allocation error occurred during processing,

    etc.

    """

# module level objects ########################################################

apilevel = '2.0'

"""Integer constant stating the level of thread safety the interface supports.

Possible values are:

                0     Threads may not share the module.

                1     Threads may share the module, but not connections.

                2     Threads may share the module and connections.

                3     Threads may share the module, connections and

                      cursors.

Sharing in the above context means that two threads may use a resource without

wrapping it using a mutex semaphore to implement resource locking. Note that

you cannot always make external resources thread safe by managing access using

a mutex: the resource may rely on global variables or other external sources

that are beyond your control.

"""

threadsafety = 1

"""String constant stating the type of parameter marker formatting expected by

the interface. Possible values are :

                'qmark'         Question mark style,

                                e.g. '...WHERE name=?'

                'numeric'       Numeric, positional style,

                                e.g. '...WHERE name=:1'

                'named'         Named style,

                                e.g. '...WHERE name=:name'

                'format'        ANSI C printf format codes,

                                e.g. '...WHERE name=%s'

                'pyformat'      Python extended format codes,

                                e.g. '...WHERE name=%(name)s'

"""

paramstyle = 'pyformat'

# connection object ###########################################################

class Connection(object):

    """DB-API 2.0 compatible Connection object for CubicWebt

    """

    # make exceptions available through the connection object

    ProgrammingError = ProgrammingError

    def __init__(self, repo, cnxid, cnxprops=None):

        self._repo = repo

        self.sessionid = cnxid

        self._close_on_del = getattr(cnxprops, 'close_on_del', True)

        self._cnxtype = getattr(cnxprops, 'cnxtype', 'pyro')

        self._closed = None

        if cnxprops and cnxprops.log_queries:

            self.executed_queries = []

            self.cursor_class = LogCursor

        else:

            self.cursor_class = Cursor

        self.anonymous_connection = False

        self.vreg = None

        # session's data

        self.data = {}

    def __repr__(self):

        if self.anonymous_connection:

            return '<Connection %s (anonymous)>' % self.sessionid

        return '<Connection %s>' % self.sessionid

    def request(self):

        return DBAPIRequest(self.vreg, self)

    def session_data(self):

        """return a dictionnary containing session data"""

        return self.data

    def get_session_data(self, key, default=None, pop=False):

        """return value associated to `key` in session data"""

        if pop:

            return self.data.pop(key, default)

        else:

            return self.data.get(key, default)

    def set_session_data(self, key, value):

        """set value associated to `key` in session data"""

        self.data[key] = value

    def del_session_data(self, key):

        """remove value associated to `key` in session data"""

        try:

            del self.data[key]

        except KeyError:

            pass

    def check(self):

        """raise `BadSessionId` if the connection is no more valid"""

        self._repo.check_session(self.sessionid)

    def get_shared_data(self, key, default=None, pop=False):

        """return value associated to `key` in shared data"""

        return self._repo.get_shared_data(self.sessionid, key, default, pop)

    def set_shared_data(self, key, value, querydata=False):

        """set value associated to `key` in shared data

        if `querydata` is true, the value will be added to the repository

        session's query data which are cleared on commit/rollback of the current

        transaction, and won't be available through the connexion, only on the

        repository side.

        """

        return self._repo.set_shared_data(self.sessionid, key, value, querydata)

    def get_schema(self):

        """Return the schema currently used by the repository.

        This is NOT part of the DB-API.

        """

        if self._closed is not None:

            raise ProgrammingError('Closed connection')

        return self._repo.get_schema()

    def load_vobjects(self, cubes=_MARKER, subpath=None, expand=True, force_reload=None):

        config = self.vreg.config

        if cubes is _MARKER:

            cubes = self._repo.get_cubes()

        elif cubes is None:

            cubes = ()

        else:

            if not isinstance(cubes, (list, tuple)):

                cubes = (cubes,)

            if expand:

                cubes = config.expand_cubes(cubes)

        if subpath is None:

            subpath = esubpath = ('entities', 'views')