source: main/waeup.aaue/trunk/src/waeup/aaue/students/utils.py @ 11653

## $Id: utils.py 11653 2014-05-15 07:08:46Z 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 time import time
from zope.component import createObject
from waeup.kofa.interfaces import (
    CLEARED, RETURNING, PAID, academic_sessions_vocab)
from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
from waeup.kofa.accesscodes import create_accesscode
from waeup.kofa.students.utils import trans
from waeup.aaue.interfaces import MessageFactory as _

class CustomStudentsUtils(NigeriaStudentsUtils):
    """A collection of customized methods.

    """

    VERDICTS_DICT = {
        '0': 'not yet',
        'A': 'Successful student',
        'B': 'Student with carryover courses',
        'C': 'Student on probation',
        #'D': 'Withdrawn from the faculty',
        #'E': 'Student who were previously on probation',
        #'F': 'Medical case',
        #'G': 'Absent from examination',
        #'H': 'Withheld results',
        #'I': 'Expelled/rusticated/suspended student',
        #'J': 'Temporary withdrawn from the university',
        #'K': 'Unregistered student',
        #'L': 'Referred student',
        #'M': 'Reinstatement',
        #'N': 'Student on transfer',
        #'O': 'NCE-III repeater',
        #'Y': 'No previous verdict',
        #'X': 'New 300 level student',
        'Z': 'Successful student (provisional)',
        #'A1': 'First Class',
        #'A2': 'Second Class Upper',
        #'A3': 'Second Class Lower',
        #'A4': 'Third Class',
        #'A5': 'Pass',
        #'A6': 'Distinction',
        #'A7': 'Credit',
        #'A8': 'Merit',
        'NEOR': 'No evidence of registration',
        'NEOV': 'No evidence of verification',
        'FRNS': 'Faculty requirements not satisfied',
        }

    gpa_boundaries = ((1, 'FRNS'),
                      (1.5, 'Pass'),
                      (2.4, '3rd Class Honours'),
                      (3.5, '2nd Class Honours Lower Division'),
                      (4.5, '2nd Class Honours Upper Division'),
                      (5, '1st Class Honours'))

    def constructMatricNumber(self, student):
        next_integer = grok.getSite()['configuration'].next_matric_integer
        if next_integer == 0:
            return None
        faccode = student.faccode
        depcode = student.depcode
        year = unicode(student.entry_session)[2:]
        if student.current_mode in ('ug_pt', 'de_pt') \
            and student.state in (PAID, ) \
            and student.is_fresh:
            return None, "PTP/%s/%s/%s/%05d" % (faccode, depcode, year, next_integer)
        #if student.current_mode in ('pg_ft', 'pg_pt'):
        #    return None, "SPS/%s/%s/%s/%05d" % (faccode, depcode, year, next_integer)
        #if student.current_mode in ('dp_ft', 'dp_pt'):
        #    return None, "DIP/%s/%s/%s/%05d" % (faccode, depcode, year, next_integer)
        #if student.current_mode == 'found':
        #    return _('Foundation programme students don\'t have matric number.'), None
        #return None, "%s/%s/%s/%05d" % (faccode, depcode, year, next_integer)
        return _('Matriculation number cannot be set.'), None

    def getReturningData(self, student):
        """ This method defines what happens after school fee payment
        of returning students depending on the student's senate verdict.
        """
        prev_level = student['studycourse'].current_level
        cur_verdict = student['studycourse'].current_verdict
        if cur_verdict in ('A','B','L','M','N','Z',):
            # Successful student
            new_level = divmod(int(prev_level),100)[0]*100 + 100
        elif cur_verdict == 'C':
            # Student on probation
            new_level = int(prev_level) + 10
        else:
            # Student is somehow in an undefined state.
            # Level has to be set manually.
            new_level = prev_level
        new_session = student['studycourse'].current_session + 1
        return new_session, new_level

    def setPaymentDetails(self, category, student,
            previous_session=None, previous_level=None):
        """Create Payment object and set the payment data of a student for
        the payment category specified.

        """
        details = {}
        p_item = u''
        amount = 0.0
        error = u''
        if previous_session:
            return _('Previous session payment not yet implemented.'), None
        p_session = student['studycourse'].current_session
        p_level = student['studycourse'].current_level
        p_current = True
        academic_session = self._getSessionConfiguration(p_session)
        if academic_session == None:
            return _(u'Session configuration object is not available.'), None
        # Determine fee.
        if category == 'transfer':
            amount = academic_session.transfer_fee
        elif category == 'transcript':
            amount = academic_session.transcript_fee
        elif category == 'gown':
            amount = academic_session.gown_fee
        elif category == 'bed_allocation':
            amount = academic_session.booking_fee
        elif category == 'hostel_maintenance':
            amount = academic_session.maint_fee
        elif category == 'clearance':
            if student.faccode == 'FP':
                amount = academic_session.clearance_fee_fp
            else:
                amount = academic_session.clearance_fee
            p_item = student['studycourse'].certificate.code
        elif category == 'late_registration':
            amount = academic_session.late_fee
        elif category == 'schoolfee':
            try:
                certificate = student['studycourse'].certificate
                p_item = certificate.code
            except (AttributeError, TypeError):
                return _('Study course data are incomplete.'), None
            if student.state == CLEARED:
                if student.faccode == 'FP':
                    amount = academic_session.school_fee_3
                else:
                    amount = academic_session.school_fee_1
            elif student.state == RETURNING or\
                (student.is_postgrad and student.state == PAID):
                academic_session = self._getSessionConfiguration(p_session)
                if academic_session == None:
                    return _(u'Session configuration object is not available.'), None
                if student.state == RETURNING:
                    p_session, p_level = self.getReturningData(student)
                else:
                    # Returning postgraduate students also pay for the 
                    # next session but their level always remains the same.
                    p_session += 1
                try:
                    academic_session = grok.getSite()[
                        'configuration'][str(p_session)]
                except KeyError:
                    return _(u'Session configuration object is not available.'), None
                amount = academic_session.school_fee_2
            else:
                return _('Wrong state.'), None
        if amount in (0.0, None):
            return _(u'Amount could not be determined.'), None
        # Add session specific penalty fee.
        if category == 'schoolfee' and student.is_postgrad:
            amount += academic_session.penalty_pg
        elif category == 'schoolfee':
            amount += academic_session.penalty_ug
        # Create ticket.
        for key in student['payments'].keys():
            ticket = student['payments'][key]
            if ticket.p_state == 'paid' and\
               ticket.p_category == category and \
               ticket.p_item == p_item and \
               ticket.p_session == p_session:
                  return _('This type of payment has already been made.'), None
        if self._isPaymentDisabled(p_session, category, student):
            return _('Payment temporarily disabled.'), None
        payment = createObject(u'waeup.StudentOnlinePayment')
        timestamp = ("%d" % int(time()*10000))[1:]
        payment.p_id = "p%s" % timestamp
        payment.p_category = category
        payment.p_item = p_item
        payment.p_session = p_session
        payment.p_level = p_level
        payment.p_current = p_current
        payment.amount_auth = amount
        return None, payment

    def _admissionText(self, student, portal_language):
        inst_name = grok.getSite()['configuration'].name
        entry_session = student['studycourse'].entry_session
        entry_session = academic_sessions_vocab.getTerm(entry_session).title
        text = trans(_(
            'This is to inform you that you have been offered provisional'
            ' admission into ${a} for the ${b} academic session as follows:',
            mapping = {'a': inst_name, 'b': entry_session}),
            portal_language)
        return text

    def maxCredits(self, studylevel):
        """Return maximum credits.

        """
        return 48

    # AAUE prefix
    STUDENT_ID_PREFIX = u'E'