Fix for odette

[auf_rh_dae.git] / project / rh / change_list.py

# -*- coding: utf-8 -*-

import time, datetime
import operator

from django.db.models import Q
from django.conf import settings
from django.contrib.admin.options import IncorrectLookupParameters
from django.contrib.admin.views.main import ChangeList as DjangoChangeList
from django.contrib.admin.views.main import ALL_VAR, ORDER_VAR, \
        ORDER_TYPE_VAR, SEARCH_VAR, TO_FIELD_VAR, IS_POPUP_VAR, field_needs_distinct
from django.core.exceptions import SuspiciousOperation
from django.db import models
from django.utils.encoding import smart_str


KEY_ANNEE = 'annee'
KEY_DATE_DEBUT = 'date_debut'
KEY_DATE_FIN = 'date_fin'
KEY_STATUT = 'statut'

STATUT_ACTIF = 'Actif'
STATUT_INACTIF = 'Inactif'
STATUT_FUTUR = 'Futur'
STATUT_INCONNU = 'Inconnu'


class RechercheTemporelle(object):
    model = None
    params = None
    prefixe_recherche_temporelle = ""
    lookup_recherche_temporelle = {}

    internal_fields = (KEY_ANNEE, KEY_DATE_DEBUT, KEY_DATE_FIN, KEY_STATUT, )
    STATUT_CHOICES = (STATUT_ACTIF, STATUT_INACTIF, STATUT_FUTUR, STATUT_INCONNU )
    
    def __init__(self, params=params, model=model):
        self.model = model
        self.params = params

    def get_prefix(self):
        klass = getattr(self, "model_admin", self)
        return getattr(klass, 'prefixe_recherche_temporelle', "")

    def get_annees(self):
        prefix = self.get_prefix()
        date_debut = "%s%s" % (prefix, KEY_DATE_DEBUT)
        date_fin = "%s%s" % (prefix, KEY_DATE_FIN)
        annees = self.model.objects.all().values(date_debut, date_fin)
        annees_debut = [d[date_debut].year for d in annees if d[date_debut] is not None]
        annees_fin = [d[date_fin].year for d in annees if d[date_fin] is not None]
        annees = set(annees_debut + annees_fin)
        annees = list(annees)
        annees.sort(reverse=True)
        return annees

    def get_q_actifs(self):
        qs = self.model.objects.get_query_set()
        q = qs.get_q_actifs()
        return q

    def get_q_inactifs(self):
        qs = self.model.objects.get_query_set()
        q = qs.get_q_inactifs()
        return q

    def get_q_futurs(self):
        qs = self.model.objects.get_query_set()
        q = qs.get_q_futurs()
        return q

    def get_q_inconnus(self):
        qs = self.model.objects.get_query_set()
        q = qs.get_q_inconnus()
        return q

    def get_q_range(self, prefix, borne_gauche=None, borne_droite=None):
        # on filtre si on a au moins une borne, car par défaut q_actifs est
        # un filtre sur actif à l'instant présent
        if borne_gauche is not None and  borne_droite is not None:
            qs = self.model.objects.get_query_set()
            q = qs.get_q_actifs(borne_gauche,  borne_droite)
            return q
        else:
            return Q()

    def purge_params(self, lookup_params):
        self.lookup_recherche_temporelle = {}
        params = lookup_params.copy()
        for key, value in lookup_params.items():
            # ignorer les param GET pour la recherche temporelle
            if len([i for i in self.internal_fields if key.endswith(i)]) > 0:
                del params[key]
                self.lookup_recherche_temporelle[key] = value
                continue
        return params

    def get_q_temporel(self, qs):
        q = Q()
        prefix = self.get_prefix()
        borne_gauche = None
        borne_droite = None
        
        for k, v in self.lookup_recherche_temporelle.items():

            if k.endswith(KEY_ANNEE):
                borne_gauche = "%s-01-01" % v
                borne_droite = "%s-12-31" % v

            if k.endswith(KEY_DATE_DEBUT):
                date = time.strptime(v, settings.DATE_INPUT_FORMATS[0])
                borne_gauche = time.strftime("%Y-%m-%d", date)

            if k.endswith(KEY_DATE_FIN):
                date = time.strptime(v, settings.DATE_INPUT_FORMATS[0])
                borne_droite = time.strftime("%Y-%m-%d", date)

            if k.endswith(KEY_STATUT):
                aujourdhui = datetime.date.today()
                if v == STATUT_ACTIF:
                    q = q & self.get_q_actifs()
                elif v == STATUT_INACTIF:
                    q = q & self.get_q_inactifs()
                    borne_droite = aujourdhui
                elif v == STATUT_FUTUR:
                    q = q & self.get_q_futurs()
                elif v == STATUT_INCONNU:
                    q = q & self.get_q_inconnus()
        q_range = self.get_q_range(prefix, borne_gauche, borne_droite)
        return q & q_range

RechercheTemporelle.get_query_string = DjangoChangeList.get_query_string.im_func


class ChangeList(DjangoChangeList, RechercheTemporelle):

    def __init__(self, *args, **kwargs):
        super(ChangeList, self).__init__(*args, **kwargs)

    def get_query_set(self):

        use_distinct = True

        qs = self.root_query_set
        
        lookup_params = self.params.copy() # a dictionary of the query string
        for i in (ALL_VAR, ORDER_VAR, ORDER_TYPE_VAR, SEARCH_VAR, IS_POPUP_VAR, TO_FIELD_VAR):
            if i in lookup_params:
                del lookup_params[i]

        lookup_params = self.purge_params(lookup_params)       
        for key, value in lookup_params.items():
            if not isinstance(key, str):
                # 'key' will be used as a keyword argument later, so Python
                # requires it to be a string.
                del lookup_params[key]
                lookup_params[smart_str(key)] = value

            if not use_distinct:
                # Check if it's a relationship that might return more than one
                # instance
                field_name = key.split('__', 1)[0]
                try:
                    f = self.lookup_opts.get_field_by_name(field_name)[0]
                except models.FieldDoesNotExist:
                    raise IncorrectLookupParameters
                use_distinct = field_needs_distinct(f)

            # Commenting out, not sure why we try to .split() a
            # iterable / queryset, but it doesn't seem to work. Hope
            # i'm not breaking something.
            # if key ends with __in, split parameter into separate
            # values
            # if key.endswith('__in'):
            #     lookup_params[key] = value

            # if key ends with __isnull, special case '' and false
            if key.endswith('__isnull'):
                if value.lower() in ('', 'false'):
                    value = False
                else:
                    value = True
                lookup_params[key] = value

            if not self.model_admin.lookup_allowed(key, value):
                raise SuspiciousOperation(
                    "Filtering by %s not allowed" % key
                )
        
        q_temporel = self.get_q_temporel(qs)
        q = Q(**lookup_params) & q_temporel
        
        # Apply lookup parameters from the query string.
        try:
            qs = qs.filter(q)
        # Naked except! Because we don't have any other way of validating "params".
        # They might be invalid if the keyword arguments are incorrect, or if the
        # values are not in the correct type, so we might get FieldError, ValueError,
        # ValicationError, or ? from a custom field that raises yet something else
        # when handed impossible data.
        except:
            raise IncorrectLookupParameters


        # Use select_related() if one of the list_display options is a field
        # with a relationship and the provided queryset doesn't already have
        # select_related defined.
        if not qs.query.select_related:
            if self.list_select_related:
                qs = qs.select_related()
            else:
                for field_name in self.list_display:
                    try:
                        f = self.lookup_opts.get_field(field_name)
                    except models.FieldDoesNotExist:
                        pass
                    else:
                        if isinstance(f.rel, models.ManyToOneRel):
                            qs = qs.select_related()
                            break

        # Set ordering.
        if self.order_field:
            qs = qs.order_by('%s%s' % ((self.order_type == 'desc' and '-' or ''), self.order_field))

        # Apply keyword searches.
        def construct_search(field_name):
            if field_name.startswith('^'):
                return "%s__istartswith" % field_name[1:]
            elif field_name.startswith('='):
                return "%s__iexact" % field_name[1:]
            elif field_name.startswith('@'):
                return "%s__search" % field_name[1:]
            else:
                return "%s__icontains" % field_name

        if self.search_fields and self.query:
            orm_lookups = [construct_search(str(search_field))
                           for search_field in self.search_fields]
            for bit in self.query.split():
                or_queries = [models.Q(**{orm_lookup: bit})
                              for orm_lookup in orm_lookups]
                qs = qs.filter(reduce(operator.or_, or_queries))
            if not use_distinct:
                for search_spec in orm_lookups:
                    field_name = search_spec.split('__', 1)[0]
                    f = self.lookup_opts.get_field_by_name(field_name)[0]
                    if field_needs_distinct(f):
                        use_distinct = True
                        break
        
        if use_distinct:
            return qs.distinct()
        else:
            return qs