source: main/waeup.aaue/trunk/src/waeup/aaue/students/studylevel.py @ 14412

Last change on this file since 14412 was 14412, checked in by Henrik Bettermann, 8 years ago

Use level_verdict to hide end level gpa and display FRNS as remark.
  • Property svn:keywords set to Id
File size: 13.5 KB
Line 
1## $Id: studylevel.py 14412 2017-01-17 06:16:51Z henrik $
2##
3## Copyright (C) 2012 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"""
19Container which holds the data of a student study level
20and contains the course tickets.
21"""
22import grok
23import pytz
24from datetime import datetime
25from zope.component.interfaces import IFactory
26from zope.component import createObject
27from zope.interface import implementedBy
28from waeup.kofa.utils.helpers import attrs_to_fields
29from waeup.kofa.interfaces import CREATED
30from waeup.kofa.students.browser import TicketError
31from waeup.kofa.students.studylevel import (
32    StudentStudyLevel, CourseTicket,
33    CourseTicketFactory, StudentStudyLevelFactory)
34from waeup.kofa.students.interfaces import IStudentNavigation, ICourseTicket
35from waeup.aaue.students.interfaces import (
36    ICustomStudentStudyLevel, ICustomCourseTicket)
37from waeup.aaue.interfaces import MessageFactory as _
38
39
40class CustomStudentStudyLevel(StudentStudyLevel):
41    """This is a container for course tickets.
42    """
43    grok.implements(ICustomStudentStudyLevel, IStudentNavigation)
44    grok.provides(ICustomStudentStudyLevel)
45
46    @property
47    def total_credits_s1(self):
48        total = 0
49        for ticket in self.values():
50            if ticket.semester == 1:
51                total += ticket.credits
52        return total
53
54    @property
55    def total_credits_s2(self):
56        total = 0
57        for ticket in self.values():
58            if ticket.semester == 2:
59                total += ticket.credits
60        return total
61
62    @property
63    def gpa_params(self):
64        """Calculate gpa parameters for this level.
65        """
66        credits_weighted = 0.0
67        credits_counted = 0
68        level_gpa = 0.0
69        for ticket in self.values():
70            if None not in (ticket.score, ticket.ca):
71                credits_counted += ticket.credits
72                credits_weighted += ticket.credits * ticket.weight
73        if credits_counted:
74            level_gpa = credits_weighted/credits_counted
75        # Override level_gpa if value has been imported
76        imported_gpa = getattr(self, 'imported_gpa', None)
77        if imported_gpa:
78            level_gpa = imported_gpa
79        return level_gpa, credits_counted, credits_weighted
80
81    @property
82    def gpa_params_rectified(self):
83        return self.gpa_params
84
85    @property
86    def passed_params(self):
87        """Determine the number and credits of passed and failed courses.
88        This method is used for level reports.
89        """
90        passed = failed = 0
91        courses_failed = ''
92        credits_failed = 0
93        credits_passed = 0
94        courses_not_taken = ''
95        for ticket in self.values():
96            if None not in (ticket.score, ticket.ca):
97                if ticket.total_score < ticket.passmark:
98                    failed += 1
99                    credits_failed += ticket.credits
100                    if ticket.mandatory:
101                        courses_failed += 'm_%s_m ' % ticket.code
102                    else:
103                        courses_failed += '%s ' % ticket.code
104                else:
105                    passed += 1
106                    credits_passed += ticket.credits
107            else:
108                courses_not_taken += '%s ' % ticket.code
109        if not len(courses_failed):
110            courses_failed = 'Nil'
111        return (passed, failed, credits_passed,
112                credits_failed, courses_failed,
113                courses_not_taken)
114
115    @property
116    def course_registration_forbidden(self):
117        fac_dep_paid = True
118        if self.student.entry_session >= 2016:
119            fac_dep_paid = False
120            for ticket in self.student['payments'].values():
121                if ticket.p_category == 'fac_dep' and \
122                    ticket.p_session == self.level_session and \
123                    ticket.p_state == 'paid':
124                        fac_dep_paid = True
125                        continue
126        if not fac_dep_paid:
127            return _("Please pay faculty and departmental dues first.")
128        restitution_paid = True
129        if self.student.entry_session < 2016 \
130            and self.student.current_mode == 'ug_ft':
131            restitution_paid = False
132            for ticket in self.student['payments'].values():
133                if ticket.p_category == 'restitution' and \
134                    ticket.p_session == self.level_session and \
135                    ticket.p_state == 'paid':
136                        restitution_paid = True
137                        continue
138        if not restitution_paid:
139            return _("Please pay restitution fee first.")
140        if self.student.is_fresh:
141            return
142        try:
143            if self.student.is_postgrad:
144                deadline = grok.getSite()['configuration'][
145                        str(self.level_session)].coursereg_deadline_pg
146            elif self.student.current_mode.startswith('dp'):
147                deadline = grok.getSite()['configuration'][
148                        str(self.level_session)].coursereg_deadline_dp
149            elif self.student.current_mode.endswith('_pt'):
150                deadline = grok.getSite()['configuration'][
151                        str(self.level_session)].coursereg_deadline_pt
152            elif self.student.current_mode == 'found':
153                deadline = grok.getSite()['configuration'][
154                        str(self.level_session)].coursereg_deadline_found
155            else:
156                deadline = grok.getSite()['configuration'][
157                        str(self.level_session)].coursereg_deadline
158        except (TypeError, KeyError):
159            return
160        if not deadline or deadline > datetime.now(pytz.utc):
161            return
162        if len(self.student['payments']):
163            for ticket in self.student['payments'].values():
164                if ticket.p_category == 'late_registration' and \
165                    ticket.p_session == self.level_session and \
166                    ticket.p_state == 'paid':
167                        return
168        return _("Course registration has ended. "
169                 "Please pay the late registration fee.")
170
171    # only AAUE
172    @property
173    def remark(self):
174        certificate = getattr(self.__parent__,'certificate',None)
175        end_level = getattr(certificate, 'end_level', None)
176        failed_limit = 1.5
177        if self.student.entry_session < 2013:
178            failed_limit = 1.0
179        # final level student remark
180        if end_level and self.level >= end_level:
181            if '_m' in self.passed_params[4]:
182                return 'FRNS'
183            if not self.cumulative_params[0]:
184                return 'FRNS'
185            if len(self.passed_params[5]):
186                return 'FRNS'
187            if self.level_verdict == 'FRNS':
188                return 'FRNS'
189            if self.cumulative_params[0] < failed_limit:
190                return 'Fail'
191            if self.cumulative_params[0] < 2.4:
192                return '3s_rd_s'
193            if self.cumulative_params[0] < 3.5:
194                return '2s_2_s'
195            if self.cumulative_params[0] < 4.5:
196                return '2s_1_s'
197            if self.cumulative_params[0] < 5.1:
198                return '1s_st_s'
199            return 'N/A'
200        # returning student remark
201        if self.cumulative_params[0] < failed_limit:
202            return 'Probation'
203        if self.cumulative_params[0] < 5.1:
204            return 'Proceed'
205        return 'N/A'
206
207    def _schoolfeePaymentMade(self):
208        if len(self.student['payments']):
209            for ticket in self.student['payments'].values():
210                if ticket.p_state == 'paid' and \
211                    ticket.p_category in (
212                        'schoolfee', 'schoolfee_incl', 'schoolfee_2',)  and \
213                    ticket.p_session == self.student[
214                        'studycourse'].current_session:
215                    return True
216        return False
217
218    def _coursePaymentsMade(self, course):
219        if self.level_session < 2016:
220            return True
221        if not course.code[:3] in ('GST', 'ENT'):
222            return True
223        if len(self.student['payments']):
224            paid_cats = list()
225            for pticket in self.student['payments'].values():
226                if pticket.p_state == 'paid':
227                    paid_cats.append(pticket.p_category)
228            if course.code in ('GST101', 'GST102', 'GST111', 'GST112') and \
229                not 'gst_registration_1' in paid_cats:
230                return False
231            if course.code in ('GST222',) and \
232                not 'gst_registration_2' in paid_cats:
233                return False
234            if course.code in ('ENT201',) and \
235                not 'ent_registration_1' in paid_cats:
236                return False
237            if course.code in ('GST101', 'GST102') and \
238                not 'gst_text_book_1' in paid_cats and \
239                not 'gst_text_book_0' in paid_cats:
240                return False
241            if course.code in ('GST111', 'GST112') and \
242                not 'gst_text_book_2' in paid_cats and \
243                not 'gst_text_book_0' in paid_cats:
244                return False
245            if course.code in ('GST222',) and \
246                not 'gst_text_book_3' in paid_cats:
247                return False
248            if course.code in ('ENT201',) and \
249                not 'ent_text_book_1' in paid_cats:
250                return False
251            return True
252        return False
253
254    def addCourseTicket(self, ticket, course):
255        """Add a course ticket object.
256        """
257        if not ICourseTicket.providedBy(ticket):
258            raise TypeError(
259                'StudentStudyLeves contain only ICourseTicket instances')
260        # Raise TicketError if course is in 2nd semester but
261        # schoolfee has not yet been fully paid.
262        if course.semester == 2 and not self._schoolfeePaymentMade():
263            raise TicketError(
264                _('%s is a 2nd semester course which can only be added '
265                  'if school fees have been fully paid.' % course.code))
266        # Raise TicketError if registration fee or text
267        # book fee haven't been paid.
268        if not self._coursePaymentsMade(course):
269            raise TicketError(
270                _('%s can only be added if both registration fee and text '
271                  'book fee have been paid.'
272                  % course.code))
273        ticket.code = course.code
274        ticket.title = course.title
275        ticket.fcode = course.__parent__.__parent__.__parent__.code
276        ticket.dcode = course.__parent__.__parent__.code
277        ticket.credits = course.credits
278        if self.student.entry_session < 2013:
279            ticket.passmark = course.passmark - 5
280        else:
281            ticket.passmark = course.passmark
282        ticket.semester = course.semester
283        self[ticket.code] = ticket
284        return
285
286    def addCertCourseTickets(self, cert):
287        """Collect all certificate courses and create course
288        tickets automatically.
289        """
290        if cert is not None:
291            for key, val in cert.items():
292                if val.level != self.level:
293                    continue
294                ticket = createObject(u'waeup.CourseTicket')
295                ticket.automatic = True
296                ticket.mandatory = val.mandatory
297                ticket.carry_over = False
298                try:
299                    self.addCourseTicket(ticket, val.course)
300                except TicketError:
301                    pass
302        return
303
304CustomStudentStudyLevel = attrs_to_fields(
305    CustomStudentStudyLevel, omit=[
306    'total_credits', 'total_credits_s1', 'total_credits_s2', 'gpa'])
307
308class CustomStudentStudyLevelFactory(StudentStudyLevelFactory):
309    """A factory for student study levels.
310    """
311
312    def __call__(self, *args, **kw):
313        return CustomStudentStudyLevel()
314
315    def getInterfaces(self):
316        return implementedBy(CustomStudentStudyLevel)
317
318class CustomCourseTicket(CourseTicket):
319    """This is a course ticket which allows the
320    student to attend the course. Lecturers will enter scores and more at
321    the end of the term.
322
323    A course ticket contains a copy of the original course and
324    course referrer data. If the courses and/or their referrers are removed, the
325    corresponding tickets remain unchanged. So we do not need any event
326    triggered actions on course tickets.
327    """
328    grok.implements(ICustomCourseTicket, IStudentNavigation)
329    grok.provides(ICustomCourseTicket)
330
331    @property
332    def total_score(self):
333        """Returns ca + score.
334        """
335        if not None in (self.score, self.ca):
336            return self.score + self.ca
337
338    @property
339    def editable_by_lecturer(self):
340        """True if lecturer is allowed to edit the ticket.
341        """
342        return True
343
344CustomCourseTicket = attrs_to_fields(CustomCourseTicket)
345
346class CustomCourseTicketFactory(CourseTicketFactory):
347    """A factory for student study levels.
348    """
349
350    def __call__(self, *args, **kw):
351        return CustomCourseTicket()
352
353    def getInterfaces(self):
354        return implementedBy(CustomCourseTicket)
Note: See TracBrowser for help on using the repository browser.