source: main/kofacustom.nigeria/trunk/src/kofacustom/nigeria/students/export.py @ 16827

## $Id: export.py 16334 2020-11-24 10:48:31Z 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
##
"""Exporters for student related stuff.
"""
import grok
from waeup.kofa.interfaces import REQUESTED
from kofacustom.nigeria.students.interfaces import (
    INigeriaStudent,
    INigeriaStudentStudyCourse,
    INigeriaStudentStudyLevel,
    INigeriaCourseTicket,
    INigeriaStudentOnlinePayment)
from waeup.kofa.students.export import (
    StudentExporter,
    StudentStudyCourseExporter,
    StudentStudyLevelExporter,
    CourseTicketExporter,
    StudentPaymentExporter,
    DataForBursaryExporter,
    TrimmedDataExporter)
from waeup.kofa.utils.helpers import iface_names
from kofacustom.nigeria.interfaces import MessageFactory as _

class NigeriaStudentExporter(StudentExporter):
    """Exporter for Students.
    """

    fields = tuple(sorted(iface_names(
        INigeriaStudent, omit=['loggerInfo']))) + (
        'password', 'state', 'history', 'certcode', 'is_postgrad',
        'current_level', 'current_session')

    def mangle_value(self, value, name, context=None):
        if '_result' in name and value:
            value = [eval(entry.to_string()) for entry in value]
        return super(
            NigeriaStudentExporter, self).mangle_value(
            value, name, context=context)

class NigeriaTrimmedDataExporter(TrimmedDataExporter):
    """The Student Trimmed Data Exporter first filters the set of students
    by searching the students catalog. Then it exports a trimmed data set
    of this set of students.
    """

    fields = (
        'student_id',
        'matric_number',
        'reg_number',
        'firstname',
        'middlename',
        'lastname',
        'sex',
        'email',
        'phone',
        'nationality',
        'date_of_birth',
        'state',
        'current_mode',
        'certcode',
        'faccode',
        'depcode',
        'current_level',
        'current_session',
        'current_verdict',
        'entry_session',
        'lg_state',
        'lg_area')

    def mangle_value(self, value, name, context=None):
        if name == 'lg_state' and context.lga:
            value = context.lga.split('_')[0]
        if name == 'lg_area' and context.lga:
            value = '-'.join(context.lga.split('_')[1:])
        return super(
            NigeriaTrimmedDataExporter, self).mangle_value(
            value, name, context=context)

class NigeriaStudentStudyCourseExporter(StudentStudyCourseExporter):
    """Exporter for StudentStudyCourses.
    """

    fields = tuple(
        sorted(iface_names(INigeriaStudentStudyCourse))) + ('student_id',)

class NigeriaStudentStudyLevelExporter(StudentStudyLevelExporter):
    """Exporter for StudentStudyLevels.
    """
    fields = tuple(sorted(iface_names(
        INigeriaStudentStudyLevel))) + (
        'student_id', 'number_of_tickets','certcode')

class NigeriaCourseTicketExporter(CourseTicketExporter):
    """Exporter for CourseTickets.
    """

    fields = tuple(sorted(iface_names(INigeriaCourseTicket) +
        ['level', 'code', 'level_session'])) + ('student_id',
        'certcode', 'display_fullname')

class NigeriaStudentPaymentExporter(StudentPaymentExporter):
    """Exporter for OnlinePayment instances.
    """

    fields = tuple(
        sorted(iface_names(
            INigeriaStudentOnlinePayment, exclude_attribs=False,
            omit=['display_item','formatted_p_date']))) + (
            'student_id','state','current_session')

class NigeriaDataForBursaryExporter(DataForBursaryExporter):
    """Exporter for bursary data.
    """

    fields = tuple(
        sorted(iface_names(
            INigeriaStudentOnlinePayment, exclude_attribs=False,
            omit=['display_item', 'certificate', 'student']))) + (
            'student_id','matric_number','reg_number',
            'firstname', 'middlename', 'lastname','sex',
            'state','current_session',
            'entry_session', 'entry_mode',
            'faccode', 'depcode','certcode','lga')

    def mangle_value(self, value, name, context=None):
        """The mangler fetches the student data.
        """
        if context is not None:
            student = context.student
            if name in [
                'student_id','matric_number', 'reg_number',
                'firstname', 'middlename', 'lastname','sex',
                'state', 'current_session',
                'entry_session', 'entry_mode',
                'faccode', 'depcode', 'certcode',
                'lga'] and student is not None:
                value = getattr(student, name, None)
        return super(
            StudentPaymentExporter, self).mangle_value(
            value, name, context=context)

class ClearanceRequestedStudentExporter(StudentExporter):
    """Exporter of data used to assign physical clearance dates.
    """

    grok.name('clearancerequested')

    fields = ('student_id', 'reg_number', 'display_fullname',
              'state', 'current_session', 'history', 'physical_clearance_date',
              'email','phone')

    title = _(u'Clearance Invitation Data')

    def filter_func(self, x, **kw):
        # We use this method to post-filter students in state
        # 'clearance_requested'
        return [student for student in x if student.state == REQUESTED]

    def mangle_value(self, value, name, context=None):
        if name == 'history':
            # Only show last mesage
            value = value.messages[-1]
        return super(
            StudentExporter, self).mangle_value(
            value, name, context=context)