## $Id: applicant.py 15218 2018-11-08 12:45:03Z henrik $
##
## Copyright (C) 2011 Uli Fouquet & Henrik Bettermann
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##

import grok
from zope.interface import implementedBy
from waeup.kofa.applicants.applicant import ApplicantFactory
from waeup.kofa.utils.helpers import attrs_to_fields
from waeup.kofa.interfaces import IObjectHistory
from waeup.kofa.applicants.workflow import (
    application_states_dict, ADMITTED, NOT_ADMITTED, CREATED)
from kofacustom.nigeria.applicants.applicant import NigeriaApplicant
from kofacustom.edopoly.applicants.interfaces import(
    ICustomApplicant, ICustomUGApplicantEdit, ICustomPGApplicantEdit,
    IPUTMEApplicantEdit, ICustomSpecialApplicant)

class CustomApplicant(NigeriaApplicant):

    grok.implements(ICustomApplicant, ICustomUGApplicantEdit,
        ICustomPGApplicantEdit, IPUTMEApplicantEdit, ICustomSpecialApplicant)
    grok.provides(ICustomApplicant)

    def admchecking_fee_paid(self):
        # We don't charge if admission checking fee is not set.
        session = str(self.__parent__.year)
        try:
            session_config = grok.getSite()['configuration'][session]
        except KeyError:
            return True
        if session_config.admchecking_fee == 0:
            return True
        for key in self.keys():
            ticket = self[key]
            if ticket.p_state == 'paid' and \
                ticket.p_category == 'admission_checking':
                return True
        return False

    @property
    def history(self):
        # We do not provide a history
        if self.state in (ADMITTED, NOT_ADMITTED, CREATED) \
            and not self.admchecking_fee_paid():
            return
        history = IObjectHistory(self)
        return history

    @property
    def translated_state(self):
        if self.state in (ADMITTED, NOT_ADMITTED, CREATED) \
            and not self.admchecking_fee_paid():
            return
        try:
            state = application_states_dict[self.state]
        except LookupError:  # in unit tests
            return
        return state

# Set all attributes of CustomApplicant required in ICustomApplicant as field
# properties. Doing this, we do not have to set initial attributes
# ourselves and as a bonus we get free validation when an attribute is
# set.
CustomApplicant = attrs_to_fields(CustomApplicant)

class CustomApplicantFactory(ApplicantFactory):
    """A factory for customized applicants.
    """

    def __call__(self, *args, **kw):
        return CustomApplicant()

    def getInterfaces(self):
        return implementedBy(CustomApplicant)
