source: main/waeup.kofa/branches/uli-async-update/src/waeup/kofa/utils/utils.py @ 10009

Last change on this file since 10009 was 9169, checked in by uli, 12 years ago

Merge changes from trunk, r8786-HEAD

  • Property svn:keywords set to Id
File size: 7.1 KB
Line 
1## $Id: utils.py 9169 2012-09-10 11:05:07Z uli $
2##
3## Copyright (C) 2011 Uli Fouquet & Henrik Bettermann
4## This program is free software; you can redistribute it and/or modify
5## it under the terms of the GNU General Public License as published by
6## the Free Software Foundation; either version 2 of the License, or
7## (at your option) any later version.
8##
9## This program is distributed in the hope that it will be useful,
10## but WITHOUT ANY WARRANTY; without even the implied warranty of
11## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12## GNU General Public License for more details.
13##
14## You should have received a copy of the GNU General Public License
15## along with this program; if not, write to the Free Software
16## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17##
18"""General helper utilities for Kofa.
19"""
20import os
21import grok
22import string
23import pytz
24from random import SystemRandom as r
25from zope.i18n import translate
26from zope.interface import implements
27from waeup.kofa.interfaces import IKofaUtils
28from waeup.kofa.interfaces import MessageFactory as _
29from waeup.kofa.smtp import send_mail as send_mail_internally
30from waeup.kofa.utils.countries import COUNTRIES
31from waeup.kofa.utils.helpers import get_sorted_preferred
32
33def send_mail(from_name,from_addr,rcpt_name,rcpt_addr,subject,body,config):
34    """Wrapper for the real SMTP functionality in :mod:`waeup.kofa.smtp`.
35
36    Merely here to stay compatible with lots of calls to this place.
37    """
38    mail_id = send_mail_internally(
39        from_name, from_addr, rcpt_name, rcpt_addr,
40        subject, body, config)
41    return True
42
43#: A list of phone prefixes (order num, country, prefix).
44#: Items with same order num will be sorted alphabetically.
45#: The lower the order num, the higher the precedence.
46INT_PHONE_PREFIXES = [
47    (99, _('Germany'), '49'),
48    ( 1, _('Nigeria'), '234'),
49    (99, _('U.S.'), '1'),
50    ]
51
52def sorted_phone_prefixes(data = INT_PHONE_PREFIXES, request=None):
53    """Sorted tuples of phone prefixes.
54
55    Ordered as shown above and formatted for use in select boxes.
56
57    If request is given, we'll try to translate all country names in
58    order to sort alphabetically correctly.
59
60    XXX: This is a function (and not a constant) as different
61    languages might give different orders. This is not tested yet.
62
63    XXX: If we really want to use alphabetic ordering here, we might
64    think about caching results of translations.
65    """
66    if request is not None:
67        data = [
68            (x, translate(y, context=request), z)
69            for x, y, z in data]
70    return tuple([
71        ('%s (+%s)' % (x[1],x[2]), '+%s' % x[2])
72        for x in sorted(data)
73        ])
74
75class KofaUtils(grok.GlobalUtility):
76    """A collection of parameters and methods subject to customization.
77
78    """
79    grok.implements(IKofaUtils)
80    # This the only place where we define the portal language
81    # which is used for the translation of system messages
82    # (e.g. object histories).
83    PORTAL_LANGUAGE = 'en'
84
85    PREFERRED_LANGUAGES_DICT = {
86        'en':(1, u'English'),
87        'fr':(2, u'Français'),
88        'de':(3, u'Deutsch'),
89        'ha':(4, u'Hausa'),
90        'yo':(5, u'Yoruba'),
91        'ig':(6, u'Igbo'),
92        }
93
94    #: A function to return
95    @classmethod
96    def sorted_phone_prefixes(cls, data=INT_PHONE_PREFIXES, request=None):
97        return sorted_phone_prefixes(data, request)
98
99    EXAM_SUBJECTS_DICT = {
100        'math': 'Mathematics',
101        'computer_science': 'Computer Science',
102        }
103
104    #: Exam grades. The tuple is sorted as it should be displayed in
105    #: select boxes.
106    EXAM_GRADES = (
107        ('A', 'Best'),
108        ('B', 'Better'),
109        ('C', 'Good'),
110        )
111
112    INST_TYPES_DICT = {
113        'none': '',
114        'faculty': 'Faculty of',
115        'department': 'Department of',
116        'school': 'School of',
117        'office': 'Office for',
118        'centre': 'Centre for',
119        'institute': 'Institute of',
120        'school_for': 'School for',
121        'college': 'College of',
122        }
123
124    STUDY_MODES_DICT = {
125        'transfer': 'Transfer',
126        'ug_ft': 'Undergraduate Full-Time',
127        'ug_pt': 'Undergraduate Part-Time',
128        'pg_ft': 'Postgraduate Full-Time',
129        'pg_pt': 'Postgraduate Part-Time',
130        }
131
132    APP_CATS_DICT = {
133        'basic': 'Basic Application',
134        'no': 'no application',
135        'pg': 'Postgraduate',
136        'sandwich': 'Sandwich',
137        'cest': 'Part-Time, Diploma, Certificate'
138        }
139
140    SEMESTER_DICT = {
141        1: 'First Semester',
142        2: 'Second Semester',
143        3: 'Combined',
144        9: 'N/A'
145        }
146
147    def sendContactForm(self,from_name,from_addr,rcpt_name,rcpt_addr,
148                from_username,usertype,portal,body,subject):
149        """Send an email with data provided by forms.
150        """
151        config = grok.getSite()['configuration']
152        text = _(u"""Fullname: ${a}
153User Id: ${b}
154User Type: ${c}
155Portal: ${d}
156
157${e}
158""")
159        text = _(text,
160            mapping = {
161            'a':from_name,
162            'b':from_username,
163            'c':usertype,
164            'd':portal,
165            'e':body})
166        body = translate(text, 'waeup.kofa',
167            target_language=self.PORTAL_LANGUAGE)
168        if not (from_addr and rcpt_addr):
169            return False
170        return send_mail(
171            from_name,from_addr,rcpt_name,rcpt_addr,subject,body,config)
172
173    @property
174    def tzinfo(self):
175        # For Nigeria: pytz.timezone('Africa/Lagos')
176        return pytz.utc
177
178    def fullname(self,firstname,lastname,middlename=None):
179        """Full name constructor.
180        """
181        # We do not necessarily have the middlename attribute
182        if middlename:
183            name = '%s %s %s' % (firstname, middlename, lastname)
184        else:
185            name = '%s %s' % (firstname, lastname)
186        return string.capwords(name.replace('-',' - ')).replace(' - ','-')
187
188
189    def genPassword(self, length=8, chars=string.letters + string.digits):
190        """Generate a random password.
191        """
192        return ''.join([r().choice(chars) for i in range(length)])
193
194
195    def sendCredentials(self, user, password=None, url_info=None, msg=None):
196        """Send credentials as email.
197
198        Input is the applicant for which credentials are sent and the
199        password.
200
201        Returns True or False to indicate successful operation.
202        """
203        subject = 'Your Kofa credentials'
204        text = _(u"""Dear ${a},
205
206${b}
207Student Registration and Information Portal of
208${c}.
209
210Your user name: ${d}
211Your password: ${e}
212${f}
213
214Please remember your user name and keep
215your password secret!
216
217Please also note that passwords are case-sensitive.
218
219Regards
220""")
221        config = grok.getSite()['configuration']
222        from_name = config.name_admin
223        from_addr = config.email_admin
224        rcpt_name = user.title
225        rcpt_addr = user.email
226        text = _(text,
227            mapping = {
228            'a':rcpt_name,
229            'b':msg,
230            'c':config.name,
231            'd':user.name,
232            'e':password,
233            'f':url_info})
234
235        body = translate(text, 'waeup.kofa',
236            target_language=self.PORTAL_LANGUAGE)
237        return send_mail(
238            from_name,from_addr,rcpt_name,rcpt_addr,subject,body,config)
Note: See TracBrowser for help on using the repository browser.