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

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

If there is no outstanding results (course w/o results) return NIL
  • Property svn:keywords set to Id
File size: 13.9 KB
Line 
1## $Id: studylevel.py 14428 2017-01-21 16:19:42Z 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        if not len(courses_not_taken):
112            courses_not_taken = 'NIL'
113        return (passed, failed, credits_passed,
114                credits_failed, courses_failed,
115                courses_not_taken)
116
117    @property
118    def course_registration_forbidden(self):
119        fac_dep_paid = True
120        if self.student.entry_session >= 2016:
121            fac_dep_paid = False
122            for ticket in self.student['payments'].values():
123                if ticket.p_category == 'fac_dep' and \
124                    ticket.p_session == self.level_session and \
125                    ticket.p_state == 'paid':
126                        fac_dep_paid = True
127                        continue
128        if not fac_dep_paid:
129            return _("Please pay faculty and departmental dues first.")
130        restitution_paid = True
131        if self.student.entry_session < 2016 \
132            and self.student.current_mode == 'ug_ft':
133            restitution_paid = False
134            for ticket in self.student['payments'].values():
135                if ticket.p_category == 'restitution' and \
136                    ticket.p_session == self.level_session and \
137                    ticket.p_state == 'paid':
138                        restitution_paid = True
139                        continue
140        if not restitution_paid:
141            return _("Please pay restitution fee first.")
142        if self.student.is_fresh:
143            return
144        try:
145            if self.student.is_postgrad:
146                deadline = grok.getSite()['configuration'][
147                        str(self.level_session)].coursereg_deadline_pg
148            elif self.student.current_mode.startswith('dp'):
149                deadline = grok.getSite()['configuration'][
150                        str(self.level_session)].coursereg_deadline_dp
151            elif self.student.current_mode.endswith('_pt'):
152                deadline = grok.getSite()['configuration'][
153                        str(self.level_session)].coursereg_deadline_pt
154            elif self.student.current_mode == 'found':
155                deadline = grok.getSite()['configuration'][
156                        str(self.level_session)].coursereg_deadline_found
157            else:
158                deadline = grok.getSite()['configuration'][
159                        str(self.level_session)].coursereg_deadline
160        except (TypeError, KeyError):
161            return
162        if not deadline or deadline > datetime.now(pytz.utc):
163            return
164        if len(self.student['payments']):
165            for ticket in self.student['payments'].values():
166                if ticket.p_category == 'late_registration' and \
167                    ticket.p_session == self.level_session and \
168                    ticket.p_state == 'paid':
169                        return
170        return _("Course registration has ended. "
171                 "Please pay the late registration fee.")
172
173    # only AAUE
174    @property
175    def remark(self):
176        certificate = getattr(self.__parent__,'certificate',None)
177        end_level = getattr(certificate, 'end_level', None)
178        failed_limit = 1.5
179        if self.student.entry_session < 2013:
180            failed_limit = 1.0
181        # final level student remark
182        if end_level and self.level >= end_level:
183            if self.gpa_params[1] == 0:
184                # No credits weighted at this level
185                return 'FRNS'
186            if self.level_verdict in ('FRNS', 'NEOR', 'NEOV'):
187                return self.level_verdict
188            if '_m' in self.passed_params[4]:
189                return 'FRNS'
190            if not self.cumulative_params[0]:
191                return 'FRNS'
192            if len(self.passed_params[5]):
193                return 'FRNS'
194            if self.cumulative_params[0] < failed_limit:
195                return 'Fail'
196            if self.cumulative_params[0] < 2.4:
197                return '3s_rd_s'
198            if self.cumulative_params[0] < 3.5:
199                return '2s_2_s'
200            if self.cumulative_params[0] < 4.5:
201                return '2s_1_s'
202            if self.cumulative_params[0] < 5.1:
203                return '1s_st_s'
204            return 'N/A'
205        # returning student remark
206        if self.gpa_params[1] == 0:
207            # No credits weighted at this level
208            return 'Probation'
209        if self.level_verdict in ('FRNS', 'NEOR', 'NEOV'):
210            return 'Probation'
211        if self.cumulative_params[0] < failed_limit:
212            return 'Probation'
213        if self.cumulative_params[0] < 5.1:
214            return 'Proceed'
215        return 'N/A'
216
217    def _schoolfeePaymentMade(self):
218        if len(self.student['payments']):
219            for ticket in self.student['payments'].values():
220                if ticket.p_state == 'paid' and \
221                    ticket.p_category in (
222                        'schoolfee', 'schoolfee_incl', 'schoolfee_2',)  and \
223                    ticket.p_session == self.student[
224                        'studycourse'].current_session:
225                    return True
226        return False
227
228    def _coursePaymentsMade(self, course):
229        if self.level_session < 2016:
230            return True
231        if not course.code[:3] in ('GST', 'ENT'):
232            return True
233        if len(self.student['payments']):
234            paid_cats = list()
235            for pticket in self.student['payments'].values():
236                if pticket.p_state == 'paid':
237                    paid_cats.append(pticket.p_category)
238            if course.code in ('GST101', 'GST102', 'GST111', 'GST112') and \
239                not 'gst_registration_1' in paid_cats:
240                return False
241            if course.code in ('GST222',) and \
242                not 'gst_registration_2' in paid_cats:
243                return False
244            if course.code in ('ENT201',) and \
245                not 'ent_registration_1' in paid_cats:
246                return False
247            if course.code in ('GST101', 'GST102') and \
248                not 'gst_text_book_1' in paid_cats and \
249                not 'gst_text_book_0' in paid_cats:
250                return False
251            if course.code in ('GST111', 'GST112') and \
252                not 'gst_text_book_2' in paid_cats and \
253                not 'gst_text_book_0' in paid_cats:
254                return False
255            if course.code in ('GST222',) and \
256                not 'gst_text_book_3' in paid_cats:
257                return False
258            if course.code in ('ENT201',) and \
259                not 'ent_text_book_1' in paid_cats:
260                return False
261            return True
262        return False
263
264    def addCourseTicket(self, ticket, course):
265        """Add a course ticket object.
266        """
267        if not ICourseTicket.providedBy(ticket):
268            raise TypeError(
269                'StudentStudyLeves contain only ICourseTicket instances')
270        # Raise TicketError if course is in 2nd semester but
271        # schoolfee has not yet been fully paid.
272        if course.semester == 2 and not self._schoolfeePaymentMade():
273            raise TicketError(
274                _('%s is a 2nd semester course which can only be added '
275                  'if school fees have been fully paid.' % course.code))
276        # Raise TicketError if registration fee or text
277        # book fee haven't been paid.
278        if not self._coursePaymentsMade(course):
279            raise TicketError(
280                _('%s can only be added if both registration fee and text '
281                  'book fee have been paid.'
282                  % course.code))
283        ticket.code = course.code
284        ticket.title = course.title
285        ticket.fcode = course.__parent__.__parent__.__parent__.code
286        ticket.dcode = course.__parent__.__parent__.code
287        ticket.credits = course.credits
288        if self.student.entry_session < 2013:
289            ticket.passmark = course.passmark - 5
290        else:
291            ticket.passmark = course.passmark
292        ticket.semester = course.semester
293        self[ticket.code] = ticket
294        return
295
296    def addCertCourseTickets(self, cert):
297        """Collect all certificate courses and create course
298        tickets automatically.
299        """
300        if cert is not None:
301            for key, val in cert.items():
302                if val.level != self.level:
303                    continue
304                ticket = createObject(u'waeup.CourseTicket')
305                ticket.automatic = True
306                ticket.mandatory = val.mandatory
307                ticket.carry_over = False
308                try:
309                    self.addCourseTicket(ticket, val.course)
310                except TicketError:
311                    pass
312        return
313
314CustomStudentStudyLevel = attrs_to_fields(
315    CustomStudentStudyLevel, omit=[
316    'total_credits', 'total_credits_s1', 'total_credits_s2', 'gpa'])
317
318class CustomStudentStudyLevelFactory(StudentStudyLevelFactory):
319    """A factory for student study levels.
320    """
321
322    def __call__(self, *args, **kw):
323        return CustomStudentStudyLevel()
324
325    def getInterfaces(self):
326        return implementedBy(CustomStudentStudyLevel)
327
328class CustomCourseTicket(CourseTicket):
329    """This is a course ticket which allows the
330    student to attend the course. Lecturers will enter scores and more at
331    the end of the term.
332
333    A course ticket contains a copy of the original course and
334    course referrer data. If the courses and/or their referrers are removed, the
335    corresponding tickets remain unchanged. So we do not need any event
336    triggered actions on course tickets.
337    """
338    grok.implements(ICustomCourseTicket, IStudentNavigation)
339    grok.provides(ICustomCourseTicket)
340
341    @property
342    def total_score(self):
343        """Returns ca + score.
344        """
345        if not None in (self.score, self.ca):
346            return self.score + self.ca
347
348    @property
349    def editable_by_lecturer(self):
350        """True if lecturer is allowed to edit the ticket.
351        """
352        return True
353
354CustomCourseTicket = attrs_to_fields(CustomCourseTicket)
355
356class CustomCourseTicketFactory(CourseTicketFactory):
357    """A factory for student study levels.
358    """
359
360    def __call__(self, *args, **kw):
361        return CustomCourseTicket()
362
363    def getInterfaces(self):
364        return implementedBy(CustomCourseTicket)
Note: See TracBrowser for help on using the repository browser.