source: main/kofacustom.nigeria/trunk/src/kofacustom/nigeria/utils/utils.py @ 17672

## $Id: utils.py 17246 2022-12-28 09:57:26Z henrik $
##
## Copyright (C) 2012 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
##
"""Customize general helper utilities for Kofa.
"""
import os
import pytz
from waeup.kofa.utils.utils import KofaUtils, sorted_phone_prefixes
from kofacustom.nigeria.interfaces import MessageFactory as _
from kofacustom.nigeria.utils.degrees import DEGREES_DICT

INT_PHONE_PREFIXES = [
    (1, _('Nigeria'), '234'),
    (99, _('Germany'), '49'),
    (99, _('United States'), '1'),
    (99, _('Niger'), '227'),
    (99, _('Benin'), '229'),
    (99, _('Cameroon'), '237'),
    (99, _('United Kingdom'), '44'),
    (99, _('France'), '33'),
    (99, _('Australia'), '61'),
    (99, _('Austria'), '43'),
    (99, _('Canada'), '1'),
    (99, _('China'), '86'),
    (99, _('Cyprus'), '357'),
    (99, _('Denmark'), '45'),
    (99, _('Egypt'), '20'),
    (99, _('Estonia'), '372'),
    (99, _('Ethiopia'), '251'),
    (99, _('Finland'), '358'),
    (99, _('Gambia'), '220'),
    (99, _('Georgia'), '995'),
    (99, _('Ghana'), '233'),
    (99, _('Greece'), '30'),
    (99, _('Hong Kong'), '852'),
    (99, _('Hungary'), '36'),
    (99, _('Iceland'), '354'),
    (99, _('India'), '91'),
    (99, _('Ireland'), '353'),
    (99, _('Italy'), '39'),
    (99, _('Japan'), '81'),
    (99, _('Kenya'), '254'),
    (99, _('Luxembourg'), '352'),
    (99, _('Malaysia'), '60'),
    (99, _('Malta'), '356'),
    (99, _('Netherlands'), '31'),
    (99, _('New Zealand'), '64'),
    (99, _('Norway'), '47'),
    (99, _('Qatar'), '974'),
    (99, _('South Africa'), '27'),
    (99, _('Spain'), '34'),
    (99, _('Sweden'), '46'),
    (99, _('Switzerland'), '41'),
    (99, _('Togo'), '228'),
    (99, _('Turkey'), '90'),
    (99, _('Ukraine'), '380'),
    (99, _('United Arab Emirates'), '971'),
    (99, _('Zambia'), '260'),
    (99, _('Zimbabwe'), '263'),
    ]

class NigeriaKofaUtils(KofaUtils):
    """A collection of methods subject to customization.
    """
    PORTAL_LANGUAGE = 'en'

    PREFERRED_LANGUAGES_DICT = {
        'en':(1, u'English'),
        'fr':(2, u'Français'),
        'de':(3, u'Deutsch'),
        'ha':(4, u'Hausa'),
        'yo':(5, u'Yoruba'),
        'ig':(6, u'Igbo'),
        }

    #: A function to return
    @classmethod
    def sorted_phone_prefixes(cls, data=INT_PHONE_PREFIXES, request=None):
        return sorted_phone_prefixes(data, request)

    DEGREES_DICT = DEGREES_DICT

    EXAM_SUBJECTS_DICT = {
        'accounts': 'Accounts',
        'add_general_science': 'Add General Science',
        'add_maths': 'Add Maths',
        'adv_elect_install_maint': 'Adv. Electrical Installation and Maintenance',
        'agricultural_science': 'Agricultural Science',
        'applied_electricity': 'Applied Electricity',
        'arabi': 'Arabic',
        'arithmetics': 'Arithmetics',
        'art': 'Art',
        'auto_mechanics': 'Auto Mechanics',
        'awaiting_results': 'Awaiting Results',
        'basic_electricity': 'Basic Electricity',
        'bible_knowledge': 'Bible Knowledge',
        'biology': 'Biology',
        'biology_alt_syl': 'Biology (Alt.Syl)',
        'block_brick_concrete': 'Block Laying, Brick Laying and Concreting',
        'book_keeping': 'Book Keeping',
        'building_construction': 'Building Construction',
        'business_management': 'Business Management',
        'business_construction_management': 'Business/Construction Management (Adv)',
        'chemistry': 'Chemistry',
        'chemistry_alt_syl': 'Chemistry (Alt.Syl)',
        'christian_religious_studies': 'Christian Religious Studies',
        'class_teaching': 'Class Teaching',
        'clerical_office_duties': 'Clerical Office Duties',
        'clothing_and_textiles': 'Clothing and Textiles',
        'commerce': 'Commerce',
        'economics': 'Economics',
        'edo': 'Edo Language',
        'education': 'Education',
        'efik': 'Efik',
        'electronics': 'Electronics',
        'elementary_surveying': 'Elementary Surveying',
        'english_language': 'English Language',
        'engineering_science': 'Engineering Science',
        'financial_accounting': 'Financial Accounting',
        'fine_art': 'Fine Art',
        'food_and_nutrition': 'Food and Nutrition',
        'french': 'French',
        'further_mathematics': 'Further Mathematics',
        'general_science': 'General Science',
        'geography': 'Geography',
        'german': 'German',
        'government': 'Government',
        'hausa': 'Hausa',
        'hausa_literature': 'Hausa Literature',
        'health_science': 'Health Science',
        'history': 'History',
        'home_economics': 'Home Economics',
        'home_management': 'Home Management',
        'human_biology': 'Human Biology',
        'industrial_electrical_installation': 'Industrial Elect Installation (Adv)',
        'intergrated_science': 'Intergrated Science',
        'islamic_studies': 'Islamic Studies',
        'literature_in_english': 'Literature in English',
        'literature_in_nigerian_languages': 'Literature in Nigerian Languages',
        'igbo': 'Igbo',
        'igbo_literature': 'Igbo Literature',
        'yoruba': 'Yoruba',
        'yoruba_literature': 'Yoruba Literature',
        'management_in_living': 'Management in Living',
        'mathematics': 'Mathematics',
        'metalwork': 'Metalwork',
        'music': 'Music',
        'nigerian_language': 'Nigerian Language',
        'office_practice': 'Office Practice',
        'physical_education': 'Physical Education',
        'physical_health_education': 'Physical and Health Education',
        'physics': 'Physics',
        'physics_alt_syl': 'Physics (Alt.Syl)',
        'principles_and_practice_of_education': 'Principles and Practice of Education',
        'principles_of_cost_accounting': 'Principles of Cost Accounting',
        'rural_science': 'Rural Science',
        'science': 'Science',
        'secretarial_duties': 'Secretarial Duties',
        'shorthand': 'Shorthand',
        'sierra_leone_studies': 'Sierra Leone Studies',
        'sierra_leone_languages': 'Sierra Leone Languages',
        'social_studies': 'Social Studies',
        'statistics': 'Statistics',
        'teaching_practice': 'Teaching Practice',
        'technical_drawing': 'Technical Drawing',
        'typewriting': 'Typewriting',
        'visual_art': 'Visual Art',
        'woodwork': 'Woodwork',
        'winding_elect_machines': 'Winding of Elect Machines and Elect Eng Sc',
        'first_written': 'First Written',
        'second_written': 'Second Written',
        'pract_tests': 'Practical Tests',
        # Added 25/08/2014
        'animal_husbandry_(alt_a)': 'Animal Husbandry (Alt A)',
        'animal_husbandry_(alt_b)': 'Animal Husbandry (Alt B)',
        'auto_electrical_work': 'Auto Electrical Work',
        'auto_mechanical_work': 'Auto Mechanical Work',
        'catering_craft_practice': 'Catering Craft Practice',
        'civic_education': 'Civic Education',
        'computer_studies': 'Computer Studies',
        'cosmetology': 'Cosmetology',
        'data_processing': 'Data Processing',
        'dyeing_&_bleaching': 'Dyeing & Bleaching',
        'electrical_installation_and_maintenance_work': 'Electrical Installation and Maintenance Work',
        'fisheries_(alt_a)_ghana_candidates': 'Fisheries (Alt A) Ghana Candidates',
        'fisheries_(alt_b)_nigeria_candidates': 'Fisheries (Alt B) Nigeria Candidates',
        'garment_making': 'Garment Making',
        'general_agriculture': 'General Agriculture',
        'gsm_phones_maintenance_and_repairs': 'Gsm Phones Maintenance and Repairs',
        'health_education': 'Health Education',
        'insurance': 'Insurance',
        'painting_and_decorating': 'Painting and Decorating',
        'photography': 'Photography',
        'printing_craft_practice': 'Printing Craft Practice',
        'store_management': 'Store Management',
        'textiles': 'Textiles',
        # Added after 19/01/2015
        'marketing': 'Marketing',
        'carpentry_joinery': 'Carpentry and Joinery',
        'tourism': 'Tourism',
        'mining': 'Mining',
        'furniture_making': 'Furniture Making',
        'information_communication_technology': 'Information and Communication Technology',
        'salesmanship': 'Salesmanship',
        'welding_and_fabrication': 'Welding and Fabrication',
        }

    EXAM_GRADES = (
        ('A1', 'Excellent (A1)'),
        ('A2', 'Very Good (A2)'),
        ('A3', 'Good (A3)'),
        ('B2', 'Very Good (B2)'),
        ('B3', 'Good (B3)'),
        ('C4', 'Credit (C4)'),
        ('C5', 'Credit (C5)'),
        ('C6', 'Credit (C6)'),
        ('A', 'Pass (A)'),
        ('B', 'Pass (B)'),
        ('C', 'Pass (C)'),
        ('U', 'Pass (U)'),
        ('D7', 'Pass (D7)'),
        ('P7', 'Pass (P7)'),
        ('P8', 'Pass (P8)'),
        ('E8', 'Pass (E8)'),
        ('F9', 'Fail (F9)'),
        ('Aa', 'A (a)'),
        ('Bb', 'B (b)'),
        ('Cc', 'C (c)'),
        ('Dd', 'D (d)'),
        ('Ee', 'E (e)'),
        ('Ff', 'F (f)'),
        ('Gg', 'G (g)'),
        ('credit-1', 'Credit-1'),
        ('credit-2', 'Credit-2'),
        ('dist', 'Distinction'),
        ('pass', 'Pass'),  
        ('AR', 'Awaiting Results'),
        )

    INST_TYPES_DICT = {
        'none': '',
        'faculty': 'Faculty of',
        'department': 'Department of',
        'school': 'School of',
        'office': 'Office for',
        'centre': 'Centre for',
        'centre_of': 'Centre of',
        'institute': 'Institute of',
        'school_for': 'School for',
        'college': 'College of',
        'directorate': 'Directorate of',
        }

    STUDY_MODES_DICT = {
        'ume_ft': 'UME Full Time',
        'ug_ft': 'Undergraduate Full Time',
        'ug_pt': 'Undergraduate Part Time',
        'dp_pt': 'Diploma Part Time',
        'ct_ft': 'Certificate Full Time',
        'dp_ft': 'Diploma Full Time',
        'de_ft': 'Direct Entry Full Time',
        'de_pt': 'Direct Entry Part Time',
        'nd_ft': 'National Diploma Full Time',
        'nd_pt': 'National Diploma Part Time',
        'hnd_ft': 'Higher National Diploma Full Time',
        'hnd_pt': 'Higher National Diploma Part Time',
        'pg_ft': 'Postgraduate Full Time',
        'pg_pt': 'Postgraduate Part Time',
        'pgd_ft': 'Postgraduate Diploma Full Time',
        'pgd_pt': 'Postgraduate Diploma Part Time',
        'pgphd': 'Postgraduate PhD/MPhil',
        'special_pg_pt': 'Special Postgraduate Part Time',
        'nce_ft': 'NCE Full Time',
        'nce_pt': 'NCE Part Time',
        'ug_sw': 'Undergraduate Sandwich',
        'nce_sw': 'NCE Sandwich',
        'jm_ft': 'Joint Matriculation Full Time',
        'ph_ft': 'Post Higher Education Full Time',
        'transfer_pt': 'Transfer Part Time',
        'transfer_ft': 'Transfer Full Time',
        'ct_pt': 'Certificate Part Time',
        'rmd_ft': 'Remedial with deficiencies',
        'rm_ft': 'Remedial',
        'transfer': 'Transfer',
        'prence': 'Pre-NCE',
        'prend': 'Pre-ND',
        'pce': 'PCE',
        'pd_ft': 'Professional Diploma in Education',
        'found': 'Foundation',
        'no': 'no application',
        }

    APP_CATS_DICT = {
        'basic': 'UAS, PUTME, PUDE, PCE, PRENCE',
        'no': 'No Application',
        'pg_ft': 'Postgraduate Full-Time',
        'pg_pt': 'Postgraduate Part-Time',
        'sandwich': 'Sandwich',
        'cest': 'Part-Time, Diploma, Certificate',
        'pre': 'Pre-Degree Studies',
        }

    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', # FCEOkene only
        'P': 'Exhausted maximum years in the university',
        'R': 'Register Excess Credit',
        'Y': 'No previous verdict',
        'X': 'New 300 level student (Uniben)',
        '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',
        'A9': 'Cert Not Classified',
        'A10': 'Upper Credit',
        'A11': 'Lower Credit',
        }

    DISABILITIES_DICT = {
        'cripple': 'Paraplegia (cripple)',
        'deaf': 'Deaf',
        'dumb': 'Dumb',
        'blind': 'Blind',
        'others': 'Others',
        }

    GRADING_SYSTEM_DICT = {
        'A': 'Regular Course Grading System (2018/2019 till date)',
        'B': 'Old Course Grading System (2012/2013 - 2017/2018)',
        }

    CURRENCY_DICT = {
        'NGN': u"\N{naira sign} (Naira)",
        'EUR': u"\N{euro sign} (Euro)",
        'USD': u"\N{dollar sign} (US Dollar)",
        'GBP': u"\N{pound sign} (Pound Sterling)",
        }

    @property
    def tzinfo(self):
        return pytz.timezone('Africa/Lagos')