# coding=utf-8
""" Data types for sqlalchemy
"""
from __future__ import absolute_import
from distutils.version import StrictVersion
import pkg_resources
from functools import partial
import json
import sqlalchemy as sa
from sqlalchemy.ext.mutable import Mutable
 
from flask.ext.sqlalchemy import SQLAlchemy as SAExtension
 
flask_sa_version = pkg_resources.get_distribution('Flask-SQLAlchemy').version
 
class AbilianBaseSAExtension(SAExtension):
  """
  Base subclass of :class:`flask.ext.sqlalchemy.SQLAlchemy`. Add
  our custom driver hacks.
  """
  def apply_driver_hacks(self, app, info, options):
    SAExtension.apply_driver_hacks(self, app, info, options)
 
    if info.drivername == 'sqlite':
      connect_args = options.setdefault('connect_args', {})
 
      if 'isolation_level' not in connect_args:
        # required to support savepoints/rollback without error. It disables
        # implicit BEGIN/COMMIT statements made by pysqlite (a COMMIT kills all
        # savepoints made).
        connect_args['isolation_level'] = None
 
 
if StrictVersion(flask_sa_version) <= StrictVersion('1.0'):
  # SA extension's scoped session supports 'bind' parameter only after 1.0. This
  # is a fix for it. This is required to ensure transaction rollback during
  # tests, but it's useful in some use cases too.
  from flask.ext.sqlalchemy import _SignallingSession as BaseSession
 
  class SignallingSession(BaseSession):
 
    def __init__(self, db, autocommit=False, autoflush=True, **options):
      self.app = db.get_app()
      self._model_changes = {}
      bind = options.pop('bind', None) or db.engine
      # actually we are overriding BaseSession.__init__, so we don't want to
      # call it! Directly call BaseSession parent __init__
      sa.orm.Session.__init__(self, autocommit=autocommit, autoflush=autoflush,
                          bind=bind, binds=db.get_binds(self.app), **options)
 
 
  class SQLAlchemy(AbilianBaseSAExtension):
 
    def create_scoped_session(self, options=None):
      """Helper factory method that creates a scoped session."""
      # override needed to use our SignallingSession implementation
      if options is None:
        options = {}
      scopefunc=options.pop('scopefunc', None)
      return sa.orm.scoped_session(partial(SignallingSession, self, **options),
                                   scopefunc=scopefunc)
 
 
else:
  # Flask-SQLAlchemy > 1.0: bind parameter is supported
  SQLAlchemy = AbilianBaseSAExtension
 
del flask_sa_version
 
 
def filter_cols(model, *filtered_columns):
  """ Return columnsnames for a model except named ones. Useful for defer() for
  example to retain only columns of interest
  """
  m = sa.orm.class_mapper(model)
  return list(set(p.key for p in m.iterate_properties
              if hasattr(p, 'columns')).difference(filtered_columns)
              )
 
 
class MutationDict(Mutable, dict):
  """ Provides a dictionary type with mutability support.
  """
  @classmethod
  def coerce(cls, key, value):
    """Convert plain dictionaries to MutationDict."""
    if not isinstance(value, MutationDict):
      if isinstance(value, dict):
        return MutationDict(value)
 
      # this call will raise ValueError
      return Mutable.coerce(key, value)
    else:
      return value
 
  #  pickling support. see:
  #  http://docs.sqlalchemy.org/en/rel_0_8/orm/extensions/mutable.html#supporting-pickling
  def __getstate__(self):
    return dict(self)
 
  def __setstate__(self, state):
    self.update(state)
 
  # dict methods
  def __setitem__(self, key, value):
    """Detect dictionary set events and emit change events."""
    dict.__setitem__(self, key, value)
    self.changed()
 
  def __delitem__(self, key):
    """Detect dictionary del events and emit change events."""
    dict.__delitem__(self, key)
    self.changed()
 
  def clear(self):
    dict.clear(self)
    self.changed()
 
  def update(self, other):
    dict.update(self, other)
    self.changed()
 
  def setdefault(self, key, failobj=None):
    if not key in self.data:
        self.changed()
    return dict.setdefault(self, key, failobj)
 
  def pop(self, key, *args):
    self.changed()
    return dict.pop(self, key, *args)
 
  def popitem(self):
    self.changed()
    return dict.popitem(self)
 
 
class MutationList(Mutable, list):
  """ Provide a list type with mutability support.
  """
  @classmethod
  def coerce(cls, key, value):
    """Convert list to MutationList."""
    if not isinstance(value, MutationList):
      if isinstance(value, list):
        return MutationList(value)
 
      # this call will raise ValueError
      return Mutable.coerce(key, value)
    else:
      return value
 
  #  pickling support. see:
  #  http://docs.sqlalchemy.org/en/rel_0_8/orm/extensions/mutable.html#supporting-pickling
  def __getstate__(self):
    d = self.__dict__.copy()
    d.pop('_parents', None)
    return d
 
  # list methods
  def __setitem__(self, idx, value):
    list.__setitem__(self, idx, value)
    self.changed()
 
  def __delitem__(self, idx):
    list.__delitem__(self, idx)
    self.changed()
 
  def insert(self, idx, value):
    list.insert(self, idx, value)
    self.changed()
 
  def __setslice__(self, i, j, other):
    list.__setslice__(self, i, j, other)
    self.changed()
 
  def __delslice__(self, i, j):
    list.__delslice__(self, i, j)
    self.changed()
 
  def __iadd__(self, other):
    l = list.__iadd__(self, other)
    self.changed()
    return l
 
  def __imul__(self, n):
    l = list.__imul__(self, n)
    self.changed()
    return l
 
  def append(self, item):
    list.append(self, item)
    self.changed()
 
  def pop(self, i=-1):
    item = list.pop(self, i)
    self.changed()
    return item
 
  def remove(self, item):
    list.remove(self, item)
    self.changed()
 
  def reverse(self):
    list.reverse(self)
    self.changed()
 
  def sort(self, *args, **kwargs):
    list.sort(self, *args, **kwargs)
    self.changed()
 
  def extend(self, other):
    list.extend(self, other)
    self.changed()
 
 
class JSON(sa.types.TypeDecorator):
  """Stores any structure serializable with json.
 
  Usage::
    JSON()
    Takes same parameters as sqlalchemy.types.Text
  """
  impl = sa.types.Text
 
  def process_bind_param(self, value, dialect):
    if value is not None:
      value = json.dumps(value)
    return value
 
  def process_result_value(self, value, dialect):
    if value is not None:
      value = json.loads(value)
    return value
 
 
class JSONUniqueListType(JSON):
  """ Store a list in JSON format, with items made unique and sorted.
  """
  @property
  def python_type(self):
    return MutationList
 
  def process_bind_param(self, value, dialect):
    # value may be a simple string used in a LIKE clause for instance, so we
    # must ensure we uniquify/sort only for list-like values
    if value is not None and isinstance(value, (tuple, list)):
      value = sorted(set(value))
 
    return JSON.process_bind_param(self, value, dialect)
 
 
def JSONDict(*args, **kwargs):
  """ Stores a dict as JSON on database, with mutability support.
  """
  return MutationDict.as_mutable(JSON(*args, **kwargs))
 
 
def JSONList(*args, **kwargs):
  """ Stores a list as JSON on database, with mutability support.
 
  If kwargs has a param `unique_sorted` (which evaluated to True), list values
  are made unique and sorted.
  """
  type_ = JSON
  try:
    if kwargs.pop('unique_sorted'):
      type_ = JSONUniqueListType
  except KeyError:
    pass
 
  return MutationList.as_mutable(type_(*args, **kwargs))