import copy

import types

import sys

import os

from itertools import izip

try:

    set

except NameError:

    from sets import Set as set     # Python 2.3 fallback.

import django.db.models.manager     # Imported to register signal handler.

from django.core.exceptions import ObjectDoesNotExist, MultipleObjectsReturned, FieldError

from django.db.models.fields import AutoField, FieldDoesNotExist

from django.db.models.fields.related import OneToOneRel, ManyToOneRel, OneToOneField

from django.db.models.query import delete_objects, Q

from django.db.models.query_utils import CollectedObjects, DeferredAttribute

from django.db.models.options import Options

from django.db import connection, transaction, DatabaseError

from django.db.models import signals

from django.db.models.loading import register_models, get_model

from django.utils.functional import curry

from django.utils.encoding import smart_str, force_unicode, smart_unicode

from django.conf import settings

class ModelBase(type):

    """

    Metaclass for all models.

    """

    def __new__(cls, name, bases, attrs):

        super_new = super(ModelBase, cls).__new__

        parents = [b for b in bases if isinstance(b, ModelBase)]

        if not parents:

            # If this isn't a subclass of Model, don't do anything special.

            return super_new(cls, name, bases, attrs)

        # Create the class.

        module = attrs.pop('__module__')

        new_class = super_new(cls, name, bases, {'__module__': module})

        attr_meta = attrs.pop('Meta', None)

        abstract = getattr(attr_meta, 'abstract', False)

        if not attr_meta:

            meta = getattr(new_class, 'Meta', None)

        else:

            meta = attr_meta

        base_meta = getattr(new_class, '_meta', None)

        if getattr(meta, 'app_label', None) is None:

            # Figure out the app_label by looking one level up.

            # For 'django.contrib.sites.models', this would be 'sites'.

            model_module = sys.modules[new_class.__module__]

            kwargs = {"app_label": model_module.__name__.split('.')[-2]}

        else:

            kwargs = {}

        new_class.add_to_class('_meta', Options(meta, **kwargs))

        if not abstract:

            new_class.add_to_class('DoesNotExist',

                    subclass_exception('DoesNotExist', ObjectDoesNotExist, module))

            new_class.add_to_class('MultipleObjectsReturned',

                    subclass_exception('MultipleObjectsReturned', MultipleObjectsReturned, module))

            if base_meta and not base_meta.abstract:

                # Non-abstract child classes inherit some attributes from their

                # non-abstract parent (unless an ABC comes before it in the

                # method resolution order).

                if not hasattr(meta, 'ordering'):

                    new_class._meta.ordering = base_meta.ordering

                if not hasattr(meta, 'get_latest_by'):

                    new_class._meta.get_latest_by = base_meta.get_latest_by

        is_proxy = new_class._meta.proxy

        if getattr(new_class, '_default_manager', None):

            if not is_proxy:

                # Multi-table inheritance doesn't inherit default manager from

                # parents.

                new_class._default_manager = None

                new_class._base_manager = None

            else:

                # Proxy classes do inherit parent's default manager, if none is

                # set explicitly.

                new_class._default_manager = new_class._default_manager._copy_to_model(new_class)

                new_class._base_manager = new_class._base_manager._copy_to_model(new_class)

        # Bail out early if we have already created this class.

        m = get_model(new_class._meta.app_label, name, False)

        if m is not None:

            return m

        # Add all attributes to the class.

        for obj_name, obj in attrs.items():

            new_class.add_to_class(obj_name, obj)

        # All the fields of any type declared on this model

        new_fields = new_class._meta.local_fields + \

                     new_class._meta.local_many_to_many + \

                     new_class._meta.virtual_fields

        field_names = set([f.name for f in new_fields])

        # Basic setup for proxy models.

        if is_proxy:

            base = None

            for parent in [cls for cls in parents if hasattr(cls, '_meta')]:

                if parent._meta.abstract:

                    if parent._meta.fields:

                        raise TypeError("Abstract base class containing model fields not permitted for proxy model '%s'." % name)

                    else:

                        continue

                if base is not None:

                    raise TypeError("Proxy model '%s' has more than one non-abstract model base class." % name)

                else:

                    base = parent

            if base is None:

                    raise TypeError("Proxy model '%s' has no non-abstract model base class." % name)

            if (new_class._meta.local_fields or

                    new_class._meta.local_many_to_many):

                raise FieldError("Proxy model '%s' contains model fields."

                        % name)

            while base._meta.proxy:

                base = base._meta.proxy_for_model

            new_class._meta.setup_proxy(base)

        # Do the appropriate setup for any model parents.

        o2o_map = dict([(f.rel.to, f) for f in new_class._meta.local_fields

                if isinstance(f, OneToOneField)])

        for base in parents:

            original_base = base

            if not hasattr(base, '_meta'):

                # Things without _meta aren't functional models, so they're

                # uninteresting parents.

                continue

            parent_fields = base._meta.local_fields + base._meta.local_many_to_many

            # Check for clashes between locally declared fields and those

            # on the base classes (we cannot handle shadowed fields at the

            # moment).

            for field in parent_fields:

                if field.name in field_names:

                    raise FieldError('Local field %r in class %r clashes '

                                     'with field of similar name from '

                                     'base class %r' %

                                        (field.name, name, base.__name__))

            if not base._meta.abstract:

                # Concrete classes...

                while base._meta.proxy:

                    # Skip over a proxy class to the "real" base it proxies.

                    base = base._meta.proxy_for_model

                if base in o2o_map:

                    field = o2o_map[base]

                elif not is_proxy:

                    attr_name = '%s_ptr' % base._meta.module_name

                    field = OneToOneField(base, name=attr_name,

                            auto_created=True, parent_link=True)

                    new_class.add_to_class(attr_name, field)

                else:

                    field = None

                new_class._meta.parents[base] = field

            else:

                # .. and abstract ones.

                for field in parent_fields:

                    new_class.add_to_class(field.name, copy.deepcopy(field))

                # Pass any non-abstract parent classes onto child.

                new_class._meta.parents.update(base._meta.parents)

            # Inherit managers from the abstract base classes.

            new_class.copy_managers(base._meta.abstract_managers)

            # Proxy models inherit the non-abstract managers from their base,

            # unless they have redefined any of them.

            if is_proxy:

                new_class.copy_managers(original_base._meta.concrete_managers)

            # Inherit virtual fields (like GenericForeignKey) from the parent

            # class

            for field in base._meta.virtual_fields:

                if base._meta.abstract and field.name in field_names:

                    raise FieldError('Local field %r in class %r clashes '\

                                     'with field of similar name from '\

                                     'abstract base class %r' % \

                                        (field.name, name, base.__name__))

                new_class.add_to_class(field.name, copy.deepcopy(field))

        if abstract:

            # Abstract base models can't be instantiated and don't appear in

            # the list of models for an app. We do the final setup for them a

            # little differently from normal models.

            attr_meta.abstract = False

            new_class.Meta = attr_meta

            return new_class

        new_class._prepare()

        register_models(new_class._meta.app_label, new_class)

        # Because of the way imports happen (recursively), we may or may not be

        # the first time this model tries to register with the framework. There

        # should only be one class for each model, so we always return the

        # registered version.

        return get_model(new_class._meta.app_label, name, False)

    def copy_managers(cls, base_managers):

        # This is in-place sorting of an Options attribute, but that's fine.

        base_managers.sort()

        for _, mgr_name, manager in base_managers:

            val = getattr(cls, mgr_name, None)

            if not val or val is manager:

                new_manager = manager._copy_to_model(cls)

                cls.add_to_class(mgr_name, new_manager)

    def add_to_class(cls, name, value):

        if hasattr(value, 'contribute_to_class'):

            value.contribute_to_class(cls, name)

        else:

            setattr(cls, name, value)

    def _prepare(cls):

        """

        Creates some methods once self._meta has been populated.

        """

        opts = cls._meta

        opts._prepare(cls)

        if opts.order_with_respect_to:

            cls.get_next_in_order = curry(cls._get_next_or_previous_in_order, is_next=True)

            cls.get_previous_in_order = curry(cls._get_next_or_previous_in_order, is_next=False)

            setattr(opts.order_with_respect_to.rel.to, 'get_%s_order' % cls.__name__.lower(), curry(method_get_order, cls))

            setattr(opts.order_with_respect_to.rel.to, 'set_%s_order' % cls.__name__.lower(), curry(method_set_order, cls))

        # Give the class a docstring -- its definition.

        if cls.__doc__ is None:

            cls.__doc__ = "%s(%s)" % (cls.__name__, ", ".join([f.attname for f in opts.fields]))

        if hasattr(cls, 'get_absolute_url'):

            cls.get_absolute_url = curry(get_absolute_url, opts, cls.get_absolute_url)

        signals.class_prepared.send(sender=cls)

class Model(object):

    __metaclass__ = ModelBase

    _deferred = False

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

        signals.pre_init.send(sender=self.__class__, args=args, kwargs=kwargs)

        # There is a rather weird disparity here; if kwargs, it's set, then args

        # overrides it. It should be one or the other; don't duplicate the work

        # The reason for the kwargs check is that standard iterator passes in by

        # args, and instantiation for iteration is 33% faster.

        args_len = len(args)

        if args_len > len(self._meta.fields):

            # Daft, but matches old exception sans the err msg.

            raise IndexError("Number of args exceeds number of fields")

        fields_iter = iter(self._meta.fields)

        if not kwargs:

            # The ordering of the izip calls matter - izip throws StopIteration

            # when an iter throws it. So if the first iter throws it, the second

            # is *not* consumed. We rely on this, so don't change the order

            # without changing the logic.

            for val, field in izip(args, fields_iter):

                setattr(self, field.attname, val)

        else:

            # Slower, kwargs-ready version.

            for val, field in izip(args, fields_iter):

                setattr(self, field.attname, val)

                kwargs.pop(field.name, None)

                # Maintain compatibility with existing calls.

                if isinstance(field.rel, ManyToOneRel):

                    kwargs.pop(field.attname, None)

        # Now we're left with the unprocessed fields that *must* come from

        # keywords, or default.

        for field in fields_iter:

            is_related_object = False

            # This slightly odd construct is so that we can access any

            # data-descriptor object (DeferredAttribute) without triggering its

            # __get__ method.

            if (field.attname not in kwargs and

                    isinstance(self.__class__.__dict__.get(field.attname), DeferredAttribute)):

                # This field will be populated on request.

                continue

            if kwargs:

                if isinstance(field.rel, ManyToOneRel):

                    try:

                        # Assume object instance was passed in.

                        rel_obj = kwargs.pop(field.name)

                        is_related_object = True

                    except KeyError:

                        try:

                            # Object instance wasn't passed in -- must be an ID.

                            val = kwargs.pop(field.attname)

                        except KeyError:

                            val = field.get_default()

                    else:

                        # Object instance was passed in. Special case: You can

                        # pass in "None" for related objects if it's allowed.

                        if rel_obj is None and field.null:

                            val = None

                else:

                    val = kwargs.pop(field.attname, field.get_default())

            else:

                val = field.get_default()

            if is_related_object:

                # If we are passed a related instance, set it using the

                # field.name instead of field.attname (e.g. "user" instead of

                # "user_id") so that the object gets properly cached (and type

                # checked) by the RelatedObjectDescriptor.

                setattr(self, field.name, rel_obj)

            else:

                setattr(self, field.attname, val)

        if kwargs:

            for prop in kwargs.keys():

                try:

                    if isinstance(getattr(self.__class__, prop), property):

                        setattr(self, prop, kwargs.pop(prop))

                except AttributeError:

                    pass

            if kwargs:

                raise TypeError, "'%s' is an invalid keyword argument for this function" % kwargs.keys()[0]

        signals.post_init.send(sender=self.__class__, instance=self)

    def __repr__(self):

        try:

            u = unicode(self)

        except (UnicodeEncodeError, UnicodeDecodeError):

            u = '[Bad Unicode data]'

        return smart_str(u'<%s: %s>' % (self.__class__.__name__, u))

    def __str__(self):

        if hasattr(self, '__unicode__'):

            return force_unicode(self).encode('utf-8')

        return '%s object' % self.__class__.__name__

    def __eq__(self, other):

        return isinstance(other, self.__class__) and self._get_pk_val() == other._get_pk_val()

    def __ne__(self, other):

        return not self.__eq__(other)

    def __hash__(self):

        return hash(self._get_pk_val())

    def __reduce__(self):

        """

        Provide pickling support. Normally, this just dispatches to Python's

        standard handling. However, for models with deferred field loading, we

        need to do things manually, as they're dynamically created classes and

        only module-level classes can be pickled by the default path.

        """

        data = self.__dict__

        if not self._deferred:

            return (self.__class__, (), data)

        defers = []

        pk_val = None

        for field in self._meta.fields:

            if isinstance(self.__class__.__dict__.get(field.attname),

                    DeferredAttribute):

                defers.append(field.attname)

                if pk_val is None:

                    # The pk_val and model values are the same for all

                    # DeferredAttribute classes, so we only need to do this

                    # once.

                    obj = self.__class__.__dict__[field.attname]

                    model = obj.model_ref()

        return (model_unpickle, (model, defers), data)

    def _get_pk_val(self, meta=None):

        if not meta:

            meta = self._meta

        return getattr(self, meta.pk.attname)

    def _set_pk_val(self, value):

        return setattr(self, self._meta.pk.attname, value)

    pk = property(_get_pk_val, _set_pk_val)

    def serializable_value(self, field_name):

        """

        Returns the value of the field name for this instance. If the field is

        a foreign key, returns the id value, instead of the object. If there's

        no Field object with this name on the model, the model attribute's

        value is returned directly.

        Used to serialize a field's value (in the serializer, or form output,

        for example). Normally, you would just access the attribute directly

        and not use this method.

        """

        try:

            field = self._meta.get_field_by_name(field_name)[0]

        except FieldDoesNotExist:

            return getattr(self, field_name)

        return getattr(self, field.attname)