"""
mingprovider Module

This contains the class which allows sprox to interface with any database.

Copyright &copy 2009 <NAME>
Original Version by <NAME> 2009
Released under MIT license.
"""
from bson.errors import InvalidId
import itertools
from sprox.iprovider import IProvider
from sprox.util import timestamp
import datetime, inspect

try:
    from ming.odm import mapper, ForeignIdProperty, FieldProperty, RelationProperty
    from ming.odm.declarative import MappedClass
    from ming.odm.property import OneToManyJoin, ManyToOneJoin, ORMProperty
    from ming.odm.icollection import InstrumentedObj
except ImportError: #pragma nocover
    from ming.orm import mapper, ForeignIdProperty, FieldProperty, RelationProperty
    from ming.orm.declarative import MappedClass
    from ming.orm.property import OneToManyJoin, ManyToOneJoin, ORMProperty
    from ming.orm.icollection import InstrumentedObj


from ming import schema as S
import bson
from bson import ObjectId

import re
from .widgetselector import MingWidgetSelector
from .validatorselector import MingValidatorSelector
from pymongo import ASCENDING, DESCENDING
from sprox._compat import string_type, zip_longest

class MingProvider(IProvider):
    default_view_names = ['_name', 'name', 'description', 'title']
    default_widget_selector_type = MingWidgetSelector
    default_validator_selector_type = MingValidatorSelector

    def __init__(self, hint, **hints):
        self.session = hint

    def get_field(self, entity, name):
        """Get a field with the given field name."""
        if '.' in name:
            # Nested field
            path = name.split('.')
            name = path.pop(0)
            field = mapper(entity).property_index[name]
            while path:
                name = path.pop(0)
                if name == '$':
                    # Array element, the real entry was the parent
                    continue

                field_schema = field.field.schema

                field_type = field_schema
                if isinstance(field_schema, S.Array):
                    field_type = field_schema.field_type
                if isinstance(field_type, S.Object):
                    field_type = field_type.fields.get(name)
                field = FieldProperty(name, field_type)
            return field

        return mapper(entity).property_index[name]

    def get_fields(self, entity):
        """Get all of the fields for a given entity."""
        if inspect.isfunction(entity):
            entity = entity()
        return [prop.name for prop in mapper(entity).properties if isinstance(prop, ORMProperty)]

    @property
    def _entities(self):
        entities = getattr(self, '__entities', None)
        if entities is None:
            entities = dict(((m.mapped_class.__name__, m) for m in MappedClass._registry.values()))
            self.__entities = entities
        return entities
    
    def get_entity(self, name):
        """Get an entity with the given name."""
        return self._entities[name].mapped_class

    def get_entities(self):
        """Get all entities available for this provider."""
        return iter(self._entities.keys())

    def get_primary_fields(self, entity):
        """Get the fields in the entity which uniquely identifies a record."""
        return [self.get_primary_field(entity)]

    def get_primary_field(self, entity):
        """Get the single primary field for an entity"""
        return '_id'

    def _get_meta(self, entity, field_name, metaprop):
        """Returns the value of the given sprox meta property for the field."""
        field = self.get_field(entity, field_name)
        return getattr(field, "sprox_meta", {}).get(metaprop, None)

    def get_view_field_name(self, entity, possible_names, item=None):
        """Get the name of the field which first matches the possible colums

        :Arguments:
          entity
            the entity where the field is located
          possible_names
            a list of names which define what the view field may contain.  This allows the first
            field that has a name in the list of names will be returned as the view field.
        """
        if entity is InstrumentedObj:
            # Cope with subdocuments
            if item is not None:
                fields = list(item.keys())
            else:
                fields = ['_impl']
        else:
            fields = self.get_fields(entity)
            for field in fields:
                if self._get_meta(entity, field, 'title'):
                    return field

        view_field = None
        for column_name in possible_names:
            for actual_name in fields:
                if column_name == actual_name:
                    view_field = actual_name
                    break
            if view_field:
                break
            for actual_name in fields:
                if column_name in actual_name:
                    view_field = actual_name
                    break
            if view_field:
                break

        if view_field is None:
            view_field = fields[0]

        return view_field

    def get_dropdown_options(self, entity_or_field, field_name, view_names=None):
        """Get all dropdown options for a given entity field.

        :Arguments:
          entity_or_field
            either the entity where the field is located, or the field itself
          field_name
            if the entity is specified, name of the field in the entity. Otherwise, None
          view_names
            a list of names which define what the view field may contain.  This allows the first
            field that has a name in the list of names will be returned as the view field.

        :Returns:
          A list of tuples with (id, view_value) as items.

        """
        if view_names is None:
            view_names = self.default_view_names

        if field_name is not None:
            field = self.get_field(entity_or_field, field_name)
        else:
            field = entity_or_field

        if isinstance(field, FieldProperty):
            field_type = getattr(field, 'field_type', None)
            if field_type is None:
                f = getattr(field, 'field', None)
                if f is not None:
                    field = field.field
                    field_type = field.type

            schemaitem = field_type
            if isinstance(schemaitem, S.OneOf):
                return [ (opt,opt) for opt in schemaitem.options ]
            raise NotImplementedError("get_dropdown_options doesn't know how to get the options for field %r of type %r" % (field, schemaitem))

        if not isinstance(field, RelationProperty):
            raise NotImplementedError("get_dropdown_options expected a FieldProperty or RelationProperty field, but got %r" % field)
        try:
            join = field.join
            iter = join.rel_cls.query.find()
            rel_cls = join.rel_cls
        #this seems like a work around for a bug in ming.
        except KeyError: # pragma: no cover
            join = field.related
            iter = join.query.find()
            rel_cls = join

        view_field = self.get_view_field_name(rel_cls, view_names)
        return [ (str(obj._id), getattr(obj, view_field)) for obj in iter ]

    def get_relations(self, entity):
        """Get all of the field names in an enity which are related to other entities."""
        return [prop.name for prop in mapper(entity).properties if isinstance(prop, RelationProperty)]

    def is_entity(self, entity):
        try:
            return bool(self.get_fields(entity))
        except:
            return False

    def is_subdocument(self, entity):
        return isinstance(entity, InstrumentedObj)

    def is_relation(self, entity, field_name):
        """Determine if a field is related to a field in another entity."""
        return isinstance(self.get_field(entity, field_name), RelationProperty)

    def is_query(self, entity, value):
        """determines if a field is a query instead of actual list of data"""
        #Currently not supported in MING
        return False

    def is_nullable(self, entity, field_name):
        """Determine if a field is nullable."""
        fld = self.get_field(entity, field_name)
        if isinstance(fld, RelationProperty):
            # check the required attribute on the corresponding foreign key field
            fld = fld.join.prop

        fld = fld.field
        schema = fld.schema
        return not getattr(schema, 'required', False)

    def get_field_default(self, field):
        field = getattr(field, 'field', None)
        if field is not None:
            if_missing = field.schema.if_missing
            if if_missing is not None:
                return (True, if_missing)
        return (False, None)

    def get_field_provider_specific_widget_args(self, viewbase, field, field_name):
        widget_args = {}
        return widget_args

    def _build_subfields(self, viewbase, field):
        subfields_widget_args = {}

        field = getattr(field, 'field', None)
        if field is None:
            return subfields_widget_args

        schema = getattr(field, 'schema', None)
        if isinstance(schema, (S.Array, S.Object)):
            if isinstance(schema, S.Array):
                field_type = schema.field_type
            else:
                field_type = schema

            if isinstance(field_type, S.Object):
                subfields = [FieldProperty('.'.join((field.name, n)), t) for n, t in field_type.fields.items()]
                direct = False
            else:
                subfields = [FieldProperty('.'.join((field.name, '$')), field_type)]
                direct = True

            subfields_widget_args = {'children': [],
                                     'direct': direct}

            for subfield in subfields:
                widget = viewbase._do_get_field_widget(subfield.name, subfield)
                widget_args = {
                    'key': subfield.name.rsplit('.', 1)[-1],
                    'id': 'sx_' + subfield.name.replace('$', '-').replace('.', '_'),
                }
                if subfields_widget_args.get('direct', False):
                    widget_args['label'] = None

                subfields_widget_args['children'].append(widget(**widget_args))

        return subfields_widget_args

    def get_default_values(self, entity, params):
        return params

    def _related_object_id(self, value):
        if isinstance(value, MappedClass):
            return value._id
        return ObjectId(value)

    def _cast_value_for_type(self, type, value):
        if value is None:
            return None

        def _check(*types):
            return type in types or isinstance(type, types)

        if _check(S.DateTime, datetime.datetime):
            if isinstance(value, string_type):
                return datetime.datetime.strptime(value, "%Y-%m-%d %H:%M:%S")
            else:
                return value
        elif _check(S.Binary):
            return bson.Binary(value)
        elif _check(S.Int, int):
            return int(value)
        elif _check(S.Bool, bool):
            if value in ('true', 'false'):
                return value == 'true' and True or False
            else:
                return bool(value)
        elif _check(S.Object, dict):
            if isinstance(type, S.Object):
                type = type.fields
            return dict((k, self._cast_value_for_type(type[k], v)) for k, v in value.items())
        elif _check(S.Array, list):
            if not isinstance(value, (list, tuple)):
                value = [value]
            if isinstance(type, S.Array):
                type = [type.field_type]
            return [self._cast_value_for_type(type[0], v) for v in value]
        else:
            return value

    def _cast_value(self, entity, key, value):
        # handles the case where an record with no id is being created
        if key == '_id' and value == '':
            value = ObjectId()

        if value is None:
            # Let none pass as is as it actually means a "null" on mongodb
            return value

        field = getattr(entity, key)

        relations = self.get_relations(entity)
        if key in relations:
            related = field.related
            if isinstance(value, list):
                return related.query.find({'_id':{'$in':[self._related_object_id(i) for i in value]}}).all()
            else:
                return self.get_obj(related, {'_id':self._related_object_id(value)})

        field = getattr(field, 'field', None)
        if field is not None:
            value = self._cast_value_for_type(field.type, value)

        return value

    def create(self, entity, params):
        """Create an entry of type entity with the given params."""
        values = {}
        fields = self.get_fields(entity)
        for key, value in params.items():
            if key not in fields:
                continue
            value = self._cast_value(entity, key, value)
            if value is not None:
                values[key] = value

        obj = entity(**values)
        self.flush()
        return obj

    def flush(self):
        self.session.flush_all()
        self.session.close_all()

    def get_obj(self, entity, params, fields=None, omit_fields=None):
        try:
            return entity.query.get(_id=ObjectId(params['_id']))
        except InvalidId:
            return None
        except KeyError:
            return entity.query.find_by(**params).first()

    def get(self, entity, params, fields=None, omit_fields=None):
        return self.dictify(self.get_obj(entity, params), fields, omit_fields)

    def update(self, entity, params, omit_fields=None):
        """Update an entry of type entity which matches the params."""
        obj = self.get_obj(entity, params)
        params.pop('_id')
        try:
            params.pop('sprox_id')
        except KeyError:
            pass
        try:
            params.pop('_method')
        except KeyError:
            pass

        fields = self.get_fields(entity)
        for key, value in params.items():
            if key not in fields:
                continue

            if omit_fields and key in omit_fields:
                continue

            value = self._cast_value(entity, key, value)
            setattr(obj, key, value)

        self.flush()
        return obj

    def delete(self, entity, params):
        """Delete an entry of typeentity which matches the params."""
        obj = self.get_obj(entity, params)
        if obj is not None:
            obj.delete()
        return obj

    def _modify_params_for_related_searches(self, entity, params, view_names=None, substrings=()):
        if view_names is None:
            view_names = self.default_view_names

        relations = self.get_relations(entity)
        for relation in relations:
            if relation in params:
                value = params[relation]
                if not isinstance(value, string_type):
                    # When not a string consider it the related class primary key
                    params.update({relation: value})
                    continue

                if not value:
                    # As we use ``contains``, searching for an empty text
                    # will just lead to all results so we just remove the filter.
                    del params[relation]
                    continue

                relationship = getattr(entity, relation)
                target_class = relationship.related
                view_name = self.get_view_field_name(target_class, view_names)

                if relation in substrings:
                    filter = {view_name: {'$regex': re.compile(re.escape(value), re.IGNORECASE)}}
                else:
                    filter = {view_name: value}
                value = target_class.query.find(filter).all()
                params[relation] = value

        return params

    def _modify_params_for_relationships(self, entity, params):
        relations = self.get_relations(entity)
        for relation in relations:
            if relation in params:
                relationship = getattr(entity, relation)
                value = params[relation]

                if not isinstance(value, list):
                    value = [value]

                adapted_value = []
                for v in value:
                    if isinstance(v, ObjectId) or isinstance(v, string_type):
                        obj = self.get_obj(relationship.related, dict(_id=v))
                        if obj is not None:
                            adapted_value.append(obj)
                    else:
                        adapted_value.append(v)
                value = adapted_value

                join = relationship.join
                my_foreign_key = relationship._detect_foreign_keys(relationship.mapper,
                                                                   join.rel_cls,
                                                                   False)
                rel_foreign_key = relationship._detect_foreign_keys(mapper(relationship.related),
                                                                    join.own_cls,
                                                                    False)

                params.pop(relation)
                if my_foreign_key:
                    my_foreign_key = my_foreign_key[0]
                    params[my_foreign_key.name] = {'$in': [r._id for r in value]}
                elif rel_foreign_key:
                    rel_foreign_key = rel_foreign_key[0]
                    value = [getattr(r, rel_foreign_key.name) for r in value]
                    if rel_foreign_key.uselist:
                        value = list(itertools.chain(*value))
                    params['_id'] = {'$in': value}
        return params

    def query(self, entity, limit=None, offset=0, limit_fields=None,
              order_by=None, desc=False, filters={},
              substring_filters=[], search_related=False, related_field_names=None,
              **kw):

        if '_id' in filters:
            try:
                filters['_id'] = ObjectId(filters['_id'])
            except InvalidId:
                pass

        if search_related:
            # Values for related fields contain the text to search
            filters = self._modify_params_for_related_searches(entity, filters,
                                                               view_names=related_field_names,
                                                               substrings=substring_filters)
        filters = self._modify_params_for_relationships(entity, filters)

        for field in substring_filters:
            if self.is_string(entity, field):
                filters[field] = {'$regex': re.compile(re.escape(filters[field]), re.IGNORECASE)}

        iter = entity.query.find(filters)
        if offset:
            iter = iter.skip(int(offset))
        if limit is not None:
            iter = iter.limit(int(limit))

        if order_by is not None:
            if not isinstance(order_by, (tuple, list)):
                order_by = [order_by]

            if not isinstance(desc, (tuple, list)):
                desc = [desc]

            sorting = [(field, DESCENDING if sort_descending else ASCENDING) for field, sort_descending in
                       zip_longest(order_by, desc)]
            iter.sort(sorting)

        count = iter.count()
        return count, iter.all()

    def is_string(self, entity, field_name):
        fld = self.get_field(entity, field_name)
        if isinstance(fld, RelationProperty):
            # check the required attribute on the corresponding foreign key field
            fld = fld.join.prop

        fld = getattr(fld, 'field', None)
        return isinstance(fld.schema, S.String)

    def is_binary(self, entity, field_name):
        fld = self.get_field(entity, field_name)
        if isinstance(fld, RelationProperty):
            # check the required attribute on the corresponding foreign key field
            fld = fld.join.prop

        fld = getattr(fld, 'field', None)
        return isinstance(fld.schema,S.Binary)

    def relation_fields(self, entity, field_name):
        field = self.get_field(entity, field_name)
        if not isinstance(field, RelationProperty):
            raise TypeError("The field %r is not a relation field" % field)

        #This is here for many-to-many turbogears-ming relations
        if not field.join.prop:
            return []

        return [field.join.prop.name]

    def relation_entity(self, entity, field_name):
        """If the field in the entity is a relation field, then returns the
        entity which it relates to.

        :Returns:
          Related entity for the field
        """
        field = self.get_field(entity, field_name)
        return field.related

    def get_field_widget_args(self, entity, field_name, field):
        args = {}
        args['provider'] = self
        args['nullable'] = self.is_nullable(entity, field_name)
        return args

    def is_unique(self, entity, field_name, value):
        iter = entity.query.find({ field_name: value })
        return iter.count() == 0

    def is_unique_field(self, entity, field_name):
        for idx in getattr(entity.__mongometa__, "unique_indexes", ()):
            if idx == (field_name,):
                return True
        return False

    def dictify(self, obj, fields=None, omit_fields=None):
        if obj is None:
            return {}
        r = {}
        for prop in self.get_fields(obj.__class__):
            if fields and prop not in fields:
                continue

            if omit_fields and prop in omit_fields:
                continue

            value = getattr(obj, prop)
            if value is not None:
                if self.is_relation(obj.__class__, prop):
                    klass = self.relation_entity(obj.__class__, prop)
                    pk_name = self.get_primary_field(klass)
                    if isinstance(value, list):
                        #joins
                        value = [getattr(value, pk_name) for value in value]
                    else:
                        #fks
                        value = getattr(value, pk_name)
            r[prop] = value
        return r

"""
mingprovider Module

This contains the class which allows sprox to interface with any database.

Copyright &copy 2009 <NAME>
Original Version by <NAME> 2009
Released under MIT license.
"""
from bson.errors import InvalidId
import itertools
from sprox.iprovider import IProvider
from sprox.util import timestamp
import datetime, inspect

try:
    from ming.odm import mapper, ForeignIdProperty, FieldProperty, RelationProperty
    from ming.odm.declarative import MappedClass
    from ming.odm.property import OneToManyJoin, ManyToOneJoin, ORMProperty
    from ming.odm.icollection import InstrumentedObj
except ImportError: #pragma nocover
    from ming.orm import mapper, ForeignIdProperty, FieldProperty, RelationProperty
    from ming.orm.declarative import MappedClass
    from ming.orm.property import OneToManyJoin, ManyToOneJoin, ORMProperty
    from ming.orm.icollection import InstrumentedObj


from ming import schema as S
import bson
from bson import ObjectId

import re
from .widgetselector import MingWidgetSelector
from .validatorselector import MingValidatorSelector
from pymongo import ASCENDING, DESCENDING
from sprox._compat import string_type, zip_longest

class MingProvider(IProvider):
    default_view_names = ['_name', 'name', 'description', 'title']
    default_widget_selector_type = MingWidgetSelector
    default_validator_selector_type = MingValidatorSelector

    def __init__(self, hint, **hints):
        self.session = hint

    def get_field(self, entity, name):
        """Get a field with the given field name."""
        if '.' in name:
            # Nested field
            path = name.split('.')
            name = path.pop(0)
            field = mapper(entity).property_index[name]
            while path:
                name = path.pop(0)
                if name == '$':
                    # Array element, the real entry was the parent
                    continue

                field_schema = field.field.schema

                field_type = field_schema
                if isinstance(field_schema, S.Array):
                    field_type = field_schema.field_type
                if isinstance(field_type, S.Object):
                    field_type = field_type.fields.get(name)
                field = FieldProperty(name, field_type)
            return field

        return mapper(entity).property_index[name]

    def get_fields(self, entity):
        """Get all of the fields for a given entity."""
        if inspect.isfunction(entity):
            entity = entity()
        return [prop.name for prop in mapper(entity).properties if isinstance(prop, ORMProperty)]

    @property
    def _entities(self):
        entities = getattr(self, '__entities', None)
        if entities is None:
            entities = dict(((m.mapped_class.__name__, m) for m in MappedClass._registry.values()))
            self.__entities = entities
        return entities
    
    def get_entity(self, name):
        """Get an entity with the given name."""
        return self._entities[name].mapped_class

    def get_entities(self):
        """Get all entities available for this provider."""
        return iter(self._entities.keys())

    def get_primary_fields(self, entity):
        """Get the fields in the entity which uniquely identifies a record."""
        return [self.get_primary_field(entity)]

    def get_primary_field(self, entity):
        """Get the single primary field for an entity"""
        return '_id'

    def _get_meta(self, entity, field_name, metaprop):
        """Returns the value of the given sprox meta property for the field."""
        field = self.get_field(entity, field_name)
        return getattr(field, "sprox_meta", {}).get(metaprop, None)

    def get_view_field_name(self, entity, possible_names, item=None):
        """Get the name of the field which first matches the possible colums

        :Arguments:
          entity
            the entity where the field is located
          possible_names
            a list of names which define what the view field may contain.  This allows the first
            field that has a name in the list of names will be returned as the view field.
        """
        if entity is InstrumentedObj:
            # Cope with subdocuments
            if item is not None:
                fields = list(item.keys())
            else:
                fields = ['_impl']
        else:
            fields = self.get_fields(entity)
            for field in fields:
                if self._get_meta(entity, field, 'title'):
                    return field

        view_field = None
        for column_name in possible_names:
            for actual_name in fields:
                if column_name == actual_name:
                    view_field = actual_name
                    break
            if view_field:
                break
            for actual_name in fields:
                if column_name in actual_name:
                    view_field = actual_name
                    break
            if view_field:
                break

        if view_field is None:
            view_field = fields[0]

        return view_field

    def get_dropdown_options(self, entity_or_field, field_name, view_names=None):
        """Get all dropdown options for a given entity field.

        :Arguments:
          entity_or_field
            either the entity where the field is located, or the field itself
          field_name
            if the entity is specified, name of the field in the entity. Otherwise, None
          view_names
            a list of names which define what the view field may contain.  This allows the first
            field that has a name in the list of names will be returned as the view field.

        :Returns:
          A list of tuples with (id, view_value) as items.

        """
        if view_names is None:
            view_names = self.default_view_names

        if field_name is not None:
            field = self.get_field(entity_or_field, field_name)
        else:
            field = entity_or_field

        if isinstance(field, FieldProperty):
            field_type = getattr(field, 'field_type', None)
            if field_type is None:
                f = getattr(field, 'field', None)
                if f is not None:
                    field = field.field
                    field_type = field.type

            schemaitem = field_type
            if isinstance(schemaitem, S.OneOf):
                return [ (opt,opt) for opt in schemaitem.options ]
            raise NotImplementedError("get_dropdown_options doesn't know how to get the options for field %r of type %r" % (field, schemaitem))

        if not isinstance(field, RelationProperty):
            raise NotImplementedError("get_dropdown_options expected a FieldProperty or RelationProperty field, but got %r" % field)
        try:
            join = field.join
            iter = join.rel_cls.query.find()
            rel_cls = join.rel_cls
        #this seems like a work around for a bug in ming.
        except KeyError: # pragma: no cover
            join = field.related
            iter = join.query.find()
            rel_cls = join

        view_field = self.get_view_field_name(rel_cls, view_names)
        return [ (str(obj._id), getattr(obj, view_field)) for obj in iter ]

    def get_relations(self, entity):
        """Get all of the field names in an enity which are related to other entities."""
        return [prop.name for prop in mapper(entity).properties if isinstance(prop, RelationProperty)]

    def is_entity(self, entity):
        try:
            return bool(self.get_fields(entity))
        except:
            return False

    def is_subdocument(self, entity):
        return isinstance(entity, InstrumentedObj)

    def is_relation(self, entity, field_name):
        """Determine if a field is related to a field in another entity."""
        return isinstance(self.get_field(entity, field_name), RelationProperty)

    def is_query(self, entity, value):
        """determines if a field is a query instead of actual list of data"""
        #Currently not supported in MING
        return False

    def is_nullable(self, entity, field_name):
        """Determine if a field is nullable."""
        fld = self.get_field(entity, field_name)
        if isinstance(fld, RelationProperty):
            # check the required attribute on the corresponding foreign key field
            fld = fld.join.prop

        fld = fld.field
        schema = fld.schema
        return not getattr(schema, 'required', False)

    def get_field_default(self, field):
        field = getattr(field, 'field', None)
        if field is not None:
            if_missing = field.schema.if_missing
            if if_missing is not None:
                return (True, if_missing)
        return (False, None)

    def get_field_provider_specific_widget_args(self, viewbase, field, field_name):
        widget_args = {}
        return widget_args

    def _build_subfields(self, viewbase, field):
        subfields_widget_args = {}

        field = getattr(field, 'field', None)
        if field is None:
            return subfields_widget_args

        schema = getattr(field, 'schema', None)
        if isinstance(schema, (S.Array, S.Object)):
            if isinstance(schema, S.Array):
                field_type = schema.field_type
            else:
                field_type = schema

            if isinstance(field_type, S.Object):
                subfields = [FieldProperty('.'.join((field.name, n)), t) for n, t in field_type.fields.items()]
                direct = False
            else:
                subfields = [FieldProperty('.'.join((field.name, '$')), field_type)]
                direct = True

            subfields_widget_args = {'children': [],
                                     'direct': direct}

            for subfield in subfields:
                widget = viewbase._do_get_field_widget(subfield.name, subfield)
                widget_args = {
                    'key': subfield.name.rsplit('.', 1)[-1],
                    'id': 'sx_' + subfield.name.replace('$', '-').replace('.', '_'),
                }
                if subfields_widget_args.get('direct', False):
                    widget_args['label'] = None

                subfields_widget_args['children'].append(widget(**widget_args))

        return subfields_widget_args

    def get_default_values(self, entity, params):
        return params

    def _related_object_id(self, value):
        if isinstance(value, MappedClass):
            return value._id
        return ObjectId(value)

    def _cast_value_for_type(self, type, value):
        if value is None:
            return None

        def _check(*types):
            return type in types or isinstance(type, types)

        if _check(S.DateTime, datetime.datetime):
            if isinstance(value, string_type):
                return datetime.datetime.strptime(value, "%Y-%m-%d %H:%M:%S")
            else:
                return value
        elif _check(S.Binary):
            return bson.Binary(value)
        elif _check(S.Int, int):
            return int(value)
        elif _check(S.Bool, bool):
            if value in ('true', 'false'):
                return value == 'true' and True or False
            else:
                return bool(value)
        elif _check(S.Object, dict):
            if isinstance(type, S.Object):
                type = type.fields
            return dict((k, self._cast_value_for_type(type[k], v)) for k, v in value.items())
        elif _check(S.Array, list):
            if not isinstance(value, (list, tuple)):
                value = [value]
            if isinstance(type, S.Array):
                type = [type.field_type]
            return [self._cast_value_for_type(type[0], v) for v in value]
        else:
            return value

    def _cast_value(self, entity, key, value):
        # handles the case where an record with no id is being created
        if key == '_id' and value == '':
            value = ObjectId()

        if value is None:
            # Let none pass as is as it actually means a "null" on mongodb
            return value

        field = getattr(entity, key)

        relations = self.get_relations(entity)
        if key in relations:
            related = field.related
            if isinstance(value, list):
                return related.query.find({'_id':{'$in':[self._related_object_id(i) for i in value]}}).all()
            else:
                return self.get_obj(related, {'_id':self._related_object_id(value)})

        field = getattr(field, 'field', None)
        if field is not None:
            value = self._cast_value_for_type(field.type, value)

        return value

    def create(self, entity, params):
        """Create an entry of type entity with the given params."""
        values = {}
        fields = self.get_fields(entity)
        for key, value in params.items():
            if key not in fields:
                continue
            value = self._cast_value(entity, key, value)
            if value is not None:
                values[key] = value

        obj = entity(**values)
        self.flush()
        return obj

    def flush(self):
        self.session.flush_all()
        self.session.close_all()

    def get_obj(self, entity, params, fields=None, omit_fields=None):
        try:
            return entity.query.get(_id=ObjectId(params['_id']))
        except InvalidId:
            return None
        except KeyError:
            return entity.query.find_by(**params).first()

    def get(self, entity, params, fields=None, omit_fields=None):
        return self.dictify(self.get_obj(entity, params), fields, omit_fields)

    def update(self, entity, params, omit_fields=None):
        """Update an entry of type entity which matches the params."""
        obj = self.get_obj(entity, params)
        params.pop('_id')
        try:
            params.pop('sprox_id')
        except KeyError:
            pass
        try:
            params.pop('_method')
        except KeyError:
            pass

        fields = self.get_fields(entity)
        for key, value in params.items():
            if key not in fields:
                continue

            if omit_fields and key in omit_fields:
                continue

            value = self._cast_value(entity, key, value)
            setattr(obj, key, value)

        self.flush()
        return obj

    def delete(self, entity, params):
        """Delete an entry of typeentity which matches the params."""
        obj = self.get_obj(entity, params)
        if obj is not None:
            obj.delete()
        return obj

    def _modify_params_for_related_searches(self, entity, params, view_names=None, substrings=()):
        if view_names is None:
            view_names = self.default_view_names

        relations = self.get_relations(entity)
        for relation in relations:
            if relation in params:
                value = params[relation]
                if not isinstance(value, string_type):
                    # When not a string consider it the related class primary key
                    params.update({relation: value})
                    continue

                if not value:
                    # As we use ``contains``, searching for an empty text
                    # will just lead to all results so we just remove the filter.
                    del params[relation]
                    continue

                relationship = getattr(entity, relation)
                target_class = relationship.related
                view_name = self.get_view_field_name(target_class, view_names)

                if relation in substrings:
                    filter = {view_name: {'$regex': re.compile(re.escape(value), re.IGNORECASE)}}
                else:
                    filter = {view_name: value}
                value = target_class.query.find(filter).all()
                params[relation] = value

        return params

    def _modify_params_for_relationships(self, entity, params):
        relations = self.get_relations(entity)
        for relation in relations:
            if relation in params:
                relationship = getattr(entity, relation)
                value = params[relation]

                if not isinstance(value, list):
                    value = [value]

                adapted_value = []
                for v in value:
                    if isinstance(v, ObjectId) or isinstance(v, string_type):
                        obj = self.get_obj(relationship.related, dict(_id=v))
                        if obj is not None:
                            adapted_value.append(obj)
                    else:
                        adapted_value.append(v)
                value = adapted_value

                join = relationship.join
                my_foreign_key = relationship._detect_foreign_keys(relationship.mapper,
                                                                   join.rel_cls,
                                                                   False)
                rel_foreign_key = relationship._detect_foreign_keys(mapper(relationship.related),
                                                                    join.own_cls,
                                                                    False)

                params.pop(relation)
                if my_foreign_key:
                    my_foreign_key = my_foreign_key[0]
                    params[my_foreign_key.name] = {'$in': [r._id for r in value]}
                elif rel_foreign_key:
                    rel_foreign_key = rel_foreign_key[0]
                    value = [getattr(r, rel_foreign_key.name) for r in value]
                    if rel_foreign_key.uselist:
                        value = list(itertools.chain(*value))
                    params['_id'] = {'$in': value}
        return params

    def query(self, entity, limit=None, offset=0, limit_fields=None,
              order_by=None, desc=False, filters={},
              substring_filters=[], search_related=False, related_field_names=None,
              **kw):

        if '_id' in filters:
            try:
                filters['_id'] = ObjectId(filters['_id'])
            except InvalidId:
                pass

        if search_related:
            # Values for related fields contain the text to search
            filters = self._modify_params_for_related_searches(entity, filters,
                                                               view_names=related_field_names,
                                                               substrings=substring_filters)
        filters = self._modify_params_for_relationships(entity, filters)

        for field in substring_filters:
            if self.is_string(entity, field):
                filters[field] = {'$regex': re.compile(re.escape(filters[field]), re.IGNORECASE)}

        iter = entity.query.find(filters)
        if offset:
            iter = iter.skip(int(offset))
        if limit is not None:
            iter = iter.limit(int(limit))

        if order_by is not None:
            if not isinstance(order_by, (tuple, list)):
                order_by = [order_by]

            if not isinstance(desc, (tuple, list)):
                desc = [desc]

            sorting = [(field, DESCENDING if sort_descending else ASCENDING) for field, sort_descending in
                       zip_longest(order_by, desc)]
            iter.sort(sorting)

        count = iter.count()
        return count, iter.all()

    def is_string(self, entity, field_name):
        fld = self.get_field(entity, field_name)
        if isinstance(fld, RelationProperty):
            # check the required attribute on the corresponding foreign key field
            fld = fld.join.prop

        fld = getattr(fld, 'field', None)
        return isinstance(fld.schema, S.String)

    def is_binary(self, entity, field_name):
        fld = self.get_field(entity, field_name)
        if isinstance(fld, RelationProperty):
            # check the required attribute on the corresponding foreign key field
            fld = fld.join.prop

        fld = getattr(fld, 'field', None)
        return isinstance(fld.schema,S.Binary)

    def relation_fields(self, entity, field_name):
        field = self.get_field(entity, field_name)
        if not isinstance(field, RelationProperty):
            raise TypeError("The field %r is not a relation field" % field)

        #This is here for many-to-many turbogears-ming relations
        if not field.join.prop:
            return []

        return [field.join.prop.name]

    def relation_entity(self, entity, field_name):
        """If the field in the entity is a relation field, then returns the
        entity which it relates to.

        :Returns:
          Related entity for the field
        """
        field = self.get_field(entity, field_name)
        return field.related

    def get_field_widget_args(self, entity, field_name, field):
        args = {}
        args['provider'] = self
        args['nullable'] = self.is_nullable(entity, field_name)
        return args

    def is_unique(self, entity, field_name, value):
        iter = entity.query.find({ field_name: value })
        return iter.count() == 0

    def is_unique_field(self, entity, field_name):
        for idx in getattr(entity.__mongometa__, "unique_indexes", ()):
            if idx == (field_name,):
                return True
        return False

    def dictify(self, obj, fields=None, omit_fields=None):
        if obj is None:
            return {}
        r = {}
        for prop in self.get_fields(obj.__class__):
            if fields and prop not in fields:
                continue

            if omit_fields and prop in omit_fields:
                continue

            value = getattr(obj, prop)
            if value is not None:
                if self.is_relation(obj.__class__, prop):
                    klass = self.relation_entity(obj.__class__, prop)
                    pk_name = self.get_primary_field(klass)
                    if isinstance(value, list):
                        #joins
                        value = [getattr(value, pk_name) for value in value]
                    else:
                        #fks
                        value = getattr(value, pk_name)
            r[prop] = value
        return r

mingprovider Module  This contains the class which allows sprox to interface with any database.  Copyright &copy 2009 <NAME> Original Version by <NAME> 2009 Released under MIT license. #pragma nocover Get a field with the given field name. # Nested field # Array element, the real entry was the parent Get all of the fields for a given entity. Get an entity with the given name. Get all entities available for this provider. Get the fields in the entity which uniquely identifies a record. Get the single primary field for an entity Returns the value of the given sprox meta property for the field. Get the name of the field which first matches the possible colums          :Arguments:           entity             the entity where the field is located           possible_names             a list of names which define what the view field may contain.  This allows the first             field that has a name in the list of names will be returned as the view field. # Cope with subdocuments Get all dropdown options for a given entity field.          :Arguments:           entity_or_field             either the entity where the field is located, or the field itself           field_name             if the entity is specified, name of the field in the entity. Otherwise, None           view_names             a list of names which define what the view field may contain.  This allows the first             field that has a name in the list of names will be returned as the view field.          :Returns:           A list of tuples with (id, view_value) as items. #this seems like a work around for a bug in ming. # pragma: no cover Get all of the field names in an enity which are related to other entities. Determine if a field is related to a field in another entity. determines if a field is a query instead of actual list of data #Currently not supported in MING Determine if a field is nullable. # check the required attribute on the corresponding foreign key field # handles the case where an record with no id is being created # Let none pass as is as it actually means a "null" on mongodb Create an entry of type entity with the given params. Update an entry of type entity which matches the params. Delete an entry of typeentity which matches the params. # When not a string consider it the related class primary key # As we use ``contains``, searching for an empty text # will just lead to all results so we just remove the filter. # Values for related fields contain the text to search # check the required attribute on the corresponding foreign key field # check the required attribute on the corresponding foreign key field #This is here for many-to-many turbogears-ming relations If the field in the entity is a relation field, then returns the         entity which it relates to.          :Returns:           Related entity for the field #joins #fks