source: main/waeup.kofa/trunk/src/waeup/kofa/students/batching.py @ 9706

Last change on this file since 9706 was 9706, checked in by Henrik Bettermann, 12 years ago

Rework logging of batch processing. Remove redundant text but add name of import file.
  • Property svn:keywords set to Id
File size: 31.9 KB
Line 
1## $Id: batching.py 9706 2012-11-21 22:37:03Z henrik $
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"""Batch processing components for student objects.
19
20Batch processors eat CSV files to add, update or remove large numbers
21of certain kinds of objects at once.
22
23Here we define the processors for students specific objects like
24students, studycourses, payment tickets and accommodation tickets.
25"""
26import grok
27import csv
28from time import time
29from datetime import datetime
30from zope.i18n import translate
31from zope.interface import Interface
32from zope.schema import getFields
33from zope.component import queryUtility, getUtility
34from zope.event import notify
35from zope.catalog.interfaces import ICatalog
36from hurry.workflow.interfaces import IWorkflowState, IWorkflowInfo
37from waeup.kofa.interfaces import (
38    IBatchProcessor, FatalCSVError, IObjectConverter, IUserAccount,
39    IObjectHistory, VALIDATED, REGISTERED, IGNORE_MARKER)
40from waeup.kofa.interfaces import IKofaUtils
41from waeup.kofa.interfaces import MessageFactory as _
42from waeup.kofa.students.interfaces import (
43    IStudent, IStudentStudyCourse,
44    IStudentUpdateByRegNo, IStudentUpdateByMatricNo,
45    IStudentStudyLevel, ICourseTicketImport,
46    IStudentOnlinePayment, IStudentVerdictUpdate)
47from waeup.kofa.students.workflow import  (
48    IMPORTABLE_STATES, IMPORTABLE_TRANSITIONS,
49    FORBIDDEN_POSTGRAD_TRANS, FORBIDDEN_POSTGRAD_STATES)
50from waeup.kofa.utils.batching import BatchProcessor
51
52class StudentProcessor(BatchProcessor):
53    """A batch processor for IStudent objects.
54    """
55    grok.implements(IBatchProcessor)
56    grok.provides(IBatchProcessor)
57    grok.context(Interface)
58    util_name = 'studentprocessor'
59    grok.name(util_name)
60
61    name = u'Student Processor'
62    iface = IStudent
63    iface_byregnumber = IStudentUpdateByRegNo
64    iface_bymatricnumber = IStudentUpdateByMatricNo
65
66    location_fields = []
67    factory_name = 'waeup.Student'
68
69    @property
70    def available_fields(self):
71        fields = getFields(self.iface)
72        return sorted(list(set(
73            ['student_id','reg_number','matric_number',
74            'password', 'state', 'transition'] + fields.keys())))
75
76    def checkHeaders(self, headerfields, mode='create'):
77        if 'state' in headerfields and 'transition' in headerfields:
78            raise FatalCSVError(
79                "State and transition can't be  imported at the same time!")
80        if not 'reg_number' in headerfields and not 'student_id' \
81            in headerfields and not 'matric_number' in headerfields:
82            raise FatalCSVError(
83                "Need at least columns student_id or reg_number " +
84                "or matric_number for import!")
85        if mode == 'create':
86            for field in self.required_fields:
87                if not field in headerfields:
88                    raise FatalCSVError(
89                        "Need at least columns %s for import!" %
90                        ', '.join(["'%s'" % x for x in self.required_fields]))
91        # Check for fields to be ignored...
92        not_ignored_fields = [x for x in headerfields
93                              if not x.startswith('--')]
94        if len(set(not_ignored_fields)) < len(not_ignored_fields):
95            raise FatalCSVError(
96                "Double headers: each column name may only appear once.")
97        return True
98
99    def parentsExist(self, row, site):
100        return 'students' in site.keys()
101
102    def getLocator(self, row):
103        if row.get('student_id',None) not in (None, IGNORE_MARKER):
104            return 'student_id'
105        elif row.get('reg_number',None) not in (None, IGNORE_MARKER):
106            return 'reg_number'
107        elif row.get('matric_number',None) not in (None, IGNORE_MARKER):
108            return 'matric_number'
109        else:
110            return None
111
112    # The entry never exists in create mode.
113    def entryExists(self, row, site):
114        return self.getEntry(row, site) is not None
115
116    def getParent(self, row, site):
117        return site['students']
118
119    def getEntry(self, row, site):
120        if not 'students' in site.keys():
121            return None
122        if self.getLocator(row) == 'student_id':
123            if row['student_id'] in site['students']:
124                student = site['students'][row['student_id']]
125                return student
126        elif self.getLocator(row) == 'reg_number':
127            reg_number = row['reg_number']
128            cat = queryUtility(ICatalog, name='students_catalog')
129            results = list(
130                cat.searchResults(reg_number=(reg_number, reg_number)))
131            if results:
132                return results[0]
133        elif self.getLocator(row) == 'matric_number':
134            matric_number = row['matric_number']
135            cat = queryUtility(ICatalog, name='students_catalog')
136            results = list(
137                cat.searchResults(matric_number=(matric_number, matric_number)))
138            if results:
139                return results[0]
140        return None
141
142    def addEntry(self, obj, row, site):
143        parent = self.getParent(row, site)
144        parent.addStudent(obj)
145        # Reset _curr_stud_id if student_id has been imported
146        if self.getLocator(row) == 'student_id':
147            parent._curr_stud_id -= 1
148        # We have to log this if state is provided. If not,
149        # logging is done by the event handler handle_student_added
150        if 'state' in row:
151            parent.logger.info('%s - Student record created' % obj.student_id)
152        history = IObjectHistory(obj)
153        history.addMessage(_('Student record created'))
154        return
155
156    def delEntry(self, row, site):
157        student = self.getEntry(row, site)
158        if student is not None:
159            parent = self.getParent(row, site)
160            parent.logger.info('%s - Student removed' % student.student_id)
161            del parent[student.student_id]
162        pass
163
164    def checkUpdateRequirements(self, obj, row, site):
165        """Checks requirements the object must fulfill when being updated.
166
167        This method is not used in case of deleting or adding objects.
168
169        Returns error messages as strings in case of requirement
170        problems.
171        """
172        transition = row.get('transition', IGNORE_MARKER)
173        if transition not in (IGNORE_MARKER, ''):
174            allowed_transitions = IWorkflowInfo(obj).getManualTransitionIds()
175            if transition not in allowed_transitions:
176                return 'Transition not allowed.'
177            if transition in FORBIDDEN_POSTGRAD_TRANS and \
178                obj.is_postgrad:
179                return 'Transition not allowed (pg student).'
180        state = row.get('state', IGNORE_MARKER)
181        if state not in (IGNORE_MARKER, ''):
182            if state in FORBIDDEN_POSTGRAD_STATES and \
183                obj.is_postgrad:
184                return 'State not allowed (pg student).'
185        return None
186
187    def updateEntry(self, obj, row, site, filename):
188        """Update obj to the values given in row.
189        """
190        items_changed = ''
191
192        # Remove student_id from row if empty
193        if 'student_id' in row and row['student_id'] in (None, IGNORE_MARKER):
194            row.pop('student_id')
195
196        # Update password
197        # XXX: Take DELETION_MARKER into consideration
198        if 'password' in row:
199            passwd = row.get('password', IGNORE_MARKER)
200            if passwd not in ('', IGNORE_MARKER):
201                if passwd.startswith('{SSHA}'):
202                    # already encrypted password
203                    obj.password = passwd
204                else:
205                    # not yet encrypted password
206                    IUserAccount(obj).setPassword(passwd)
207                items_changed += ('%s=%s, ' % ('password', passwd))
208            row.pop('password')
209
210        # Update registration state
211        if 'state' in row:
212            state = row.get('state', IGNORE_MARKER)
213            if state not in (IGNORE_MARKER, ''):
214                value = row['state']
215                IWorkflowState(obj).setState(value)
216                msg = _("State '${a}' set", mapping = {'a':value})
217                history = IObjectHistory(obj)
218                history.addMessage(msg)
219                items_changed += ('%s=%s, ' % ('state', state))
220            row.pop('state')
221
222        if 'transition' in row:
223            transition = row.get('transition', IGNORE_MARKER)
224            if transition not in (IGNORE_MARKER, ''):
225                value = row['transition']
226                IWorkflowInfo(obj).fireTransition(value)
227                items_changed += ('%s=%s, ' % ('transition', transition))
228            row.pop('transition')
229
230        # apply other values...
231        items_changed += super(StudentProcessor, self).updateEntry(
232            obj, row, site, filename)
233
234        # Log actions...
235        parent = self.getParent(row, site)
236        if hasattr(obj,'student_id'):
237            # Update mode: the student exists and we can get the student_id.
238            # Create mode: the record contains the student_id
239            parent.logger.info(
240                '%s - %s - %s - updated: %s'
241                % (self.name, filename, obj.student_id, items_changed))
242        else:
243            # Create mode: the student does not yet exist
244            # XXX: It seems that this never happens because student_id
245            # is always set.
246            parent.logger.info(
247                '%s - %s - %s - imported: %s'
248                % (self.name, filename, obj.student_id, items_changed))
249        return items_changed
250
251    def getMapping(self, path, headerfields, mode):
252        """Get a mapping from CSV file headerfields to actually used fieldnames.
253        """
254        result = dict()
255        reader = csv.reader(open(path, 'rb'))
256        raw_header = reader.next()
257        for num, field in enumerate(headerfields):
258            if field not in ['student_id', 'reg_number', 'matric_number'
259                             ] and mode == 'remove':
260                continue
261            if field == u'--IGNORE--':
262                # Skip ignored columns in failed and finished data files.
263                continue
264            result[raw_header[num]] = field
265        return result
266
267    def checkConversion(self, row, mode='create'):
268        """Validates all values in row.
269        """
270        iface = self.iface
271        if mode in ['update', 'remove']:
272            if self.getLocator(row) == 'reg_number':
273                iface = self.iface_byregnumber
274            elif self.getLocator(row) == 'matric_number':
275                iface = self.iface_bymatricnumber
276        converter = IObjectConverter(iface)
277        errs, inv_errs, conv_dict =  converter.fromStringDict(
278            row, self.factory_name, mode=mode)
279        if 'transition' in row:
280            if row['transition'] not in IMPORTABLE_TRANSITIONS:
281                if row['transition'] not in (IGNORE_MARKER, ''):
282                    errs.append(('transition','not allowed'))
283        if 'state' in row:
284            if row['state'] not in IMPORTABLE_STATES:
285                if row['state'] not in (IGNORE_MARKER, ''):
286                    errs.append(('state','not allowed'))
287                else:
288                    # State is an attribute of Student and must not
289                    # be changed if empty.
290                    conv_dict['state'] = IGNORE_MARKER
291        try:
292            # Correct stud_id counter. As the IConverter for students
293            # creates student objects that are not used afterwards, we
294            # have to fix the site-wide student_id counter.
295            site = grok.getSite()
296            students = site['students']
297            students._curr_stud_id -= 1
298        except (KeyError, TypeError, AttributeError):
299                pass
300        return errs, inv_errs, conv_dict
301
302
303class StudentProcessorBase(BatchProcessor):
304    """A base for student subitem processor.
305
306    Helps reducing redundancy.
307    """
308    grok.baseclass()
309
310    # additional available fields
311    # beside 'student_id', 'reg_number' and 'matric_number'
312    additional_fields = []
313
314    #: header fields additionally required
315    additional_headers = []
316
317    @property
318    def available_fields(self):
319        fields = ['student_id','reg_number','matric_number'
320                  ] + self.additional_fields
321        return sorted(list(set(fields + getFields(
322                self.iface).keys())))
323
324    def checkHeaders(self, headerfields, mode='ignore'):
325        if not 'reg_number' in headerfields and not 'student_id' \
326            in headerfields and not 'matric_number' in headerfields:
327            raise FatalCSVError(
328                "Need at least columns student_id " +
329                "or reg_number or matric_number for import!")
330        for name in self.additional_headers:
331            if not name in headerfields:
332                raise FatalCSVError(
333                    "Need %s for import!" % name)
334
335        # Check for fields to be ignored...
336        not_ignored_fields = [x for x in headerfields
337                              if not x.startswith('--')]
338        if len(set(not_ignored_fields)) < len(not_ignored_fields):
339            raise FatalCSVError(
340                "Double headers: each column name may only appear once.")
341        return True
342
343    def _getStudent(self, row, site):
344        NON_VALUES = ['', IGNORE_MARKER]
345        if not 'students' in site.keys():
346            return None
347        if row.get('student_id', '') not in NON_VALUES:
348            if row['student_id'] in site['students']:
349                student = site['students'][row['student_id']]
350                return student
351        elif row.get('reg_number', '') not in NON_VALUES:
352            reg_number = row['reg_number']
353            cat = queryUtility(ICatalog, name='students_catalog')
354            results = list(
355                cat.searchResults(reg_number=(reg_number, reg_number)))
356            if results:
357                return results[0]
358        elif row.get('matric_number', '') not in NON_VALUES:
359            matric_number = row['matric_number']
360            cat = queryUtility(ICatalog, name='students_catalog')
361            results = list(
362                cat.searchResults(matric_number=(matric_number, matric_number)))
363            if results:
364                return results[0]
365        return None
366
367    def parentsExist(self, row, site):
368        return self.getParent(row, site) is not None
369
370    def entryExists(self, row, site):
371        return self.getEntry(row, site) is not None
372
373    def checkConversion(self, row, mode='ignore'):
374        """Validates all values in row.
375        """
376        converter = IObjectConverter(self.iface)
377        errs, inv_errs, conv_dict =  converter.fromStringDict(
378            row, self.factory_name, mode=mode)
379        return errs, inv_errs, conv_dict
380
381    def getMapping(self, path, headerfields, mode):
382        """Get a mapping from CSV file headerfields to actually used fieldnames.
383        """
384        result = dict()
385        reader = csv.reader(open(path, 'rb'))
386        raw_header = reader.next()
387        for num, field in enumerate(headerfields):
388            if field not in ['student_id', 'reg_number', 'matric_number',
389                             'p_id', 'code', 'level'
390                             ] and mode == 'remove':
391                continue
392            if field == u'--IGNORE--':
393                # Skip ignored columns in failed and finished data files.
394                continue
395            result[raw_header[num]] = field
396        return result
397
398
399class StudentStudyCourseProcessor(StudentProcessorBase):
400    """A batch processor for IStudentStudyCourse objects.
401    """
402    grok.implements(IBatchProcessor)
403    grok.provides(IBatchProcessor)
404    grok.context(Interface)
405    util_name = 'studycourseupdater'
406    grok.name(util_name)
407
408    name = u'StudentStudyCourse Processor (update only)'
409    iface = IStudentStudyCourse
410    factory_name = 'waeup.StudentStudyCourse'
411
412    location_fields = []
413    additional_fields = []
414
415    def getParent(self, row, site):
416        return self._getStudent(row, site)
417
418    def getEntry(self, row, site):
419        student = self.getParent(row, site)
420        if student is None:
421            return None
422        return student.get('studycourse')
423
424    def updateEntry(self, obj, row, site, filename):
425        """Update obj to the values given in row.
426        """
427        items_changed = super(StudentStudyCourseProcessor, self).updateEntry(
428            obj, row, site, filename)
429        parent = self.getParent(row, site)
430        parent.__parent__.logger.info(
431            '%s - %s - %s - updated: %s'
432            % (self.name, filename, parent.student_id, items_changed))
433        # Update the students_catalog
434        notify(grok.ObjectModifiedEvent(obj.__parent__))
435        return
436
437    def checkConversion(self, row, mode='ignore'):
438        """Validates all values in row.
439        """
440        errs, inv_errs, conv_dict = super(
441            StudentStudyCourseProcessor, self).checkConversion(row, mode=mode)
442        # We have to check if current_level is in range of certificate.
443        if 'certificate' in conv_dict and 'current_level' in conv_dict:
444            cert = conv_dict['certificate']
445            level = conv_dict['current_level']
446            if level < cert.start_level or level > cert.end_level+120:
447                errs.append(('current_level','not in range'))
448        return errs, inv_errs, conv_dict
449
450    def checkUpdateRequirements(self, obj, row, site):
451        """Checks requirements the object must fulfill when being updated.
452
453        Returns error messages as strings in case of requirement
454        problems.
455        """
456        current_level = row.get('current_level', None)
457        if current_level == 999 and \
458            obj.__parent__.state in FORBIDDEN_POSTGRAD_STATES:
459            return 'Not a pg student.'
460        return None
461
462class StudentStudyLevelProcessor(StudentProcessorBase):
463    """A batch processor for IStudentStudyLevel objects.
464    """
465    grok.implements(IBatchProcessor)
466    grok.provides(IBatchProcessor)
467    grok.context(Interface)
468    util_name = 'studylevelprocessor'
469    grok.name(util_name)
470
471    name = u'StudentStudyLevel Processor'
472    iface = IStudentStudyLevel
473    factory_name = 'waeup.StudentStudyLevel'
474
475    location_fields = []
476
477    additional_fields = ['level']
478    additional_headers = ['level']
479
480    @property
481    def available_fields(self):
482        fields = super(StudentStudyLevelProcessor, self).available_fields
483        fields.remove('total_credits')
484        fields.remove('gpa')
485        return  fields
486
487    def getParent(self, row, site):
488        student = self._getStudent(row, site)
489        if student is None:
490            return None
491        return student['studycourse']
492
493    def getEntry(self, row, site):
494        studycourse = self.getParent(row, site)
495        if studycourse is None:
496            return None
497        return studycourse.get(row['level'])
498
499    def delEntry(self, row, site):
500        studylevel = self.getEntry(row, site)
501        parent = self.getParent(row, site)
502        if studylevel is not None:
503            student = self._getStudent(row, site)
504            student.__parent__.logger.info('%s - Level removed: %s'
505                % (student.student_id, studylevel.__name__))
506            del parent[studylevel.__name__]
507        return
508
509    def updateEntry(self, obj, row, site, filename):
510        """Update obj to the values given in row.
511        """
512        items_changed = super(StudentStudyLevelProcessor, self).updateEntry(
513            obj, row, site, filename)
514        student = self.getParent(row, site).__parent__
515        student.__parent__.logger.info(
516            '%s - %s - %s - updated: %s'
517            % (self.name, filename, student.student_id, items_changed))
518        return
519
520    def addEntry(self, obj, row, site):
521        parent = self.getParent(row, site)
522        obj.level = int(row['level'])
523        parent[row['level']] = obj
524        return
525
526    def checkConversion(self, row, mode='ignore'):
527        """Validates all values in row.
528        """
529        errs, inv_errs, conv_dict = super(
530            StudentStudyLevelProcessor, self).checkConversion(row, mode=mode)
531
532        # We have to check if level is a valid integer.
533        # This is not done by the converter.
534        try:
535            level = int(row['level'])
536            if level not in range(0,1000,10) + [999]:
537                errs.append(('level','no valid integer'))
538        except ValueError:
539            errs.append(('level','no integer'))
540        return errs, inv_errs, conv_dict
541
542class CourseTicketProcessor(StudentProcessorBase):
543    """A batch processor for ICourseTicket objects.
544    """
545    grok.implements(IBatchProcessor)
546    grok.provides(IBatchProcessor)
547    grok.context(Interface)
548    util_name = 'courseticketprocessor'
549    grok.name(util_name)
550
551    name = u'CourseTicket Processor'
552    iface = ICourseTicketImport
553    factory_name = 'waeup.CourseTicket'
554
555    location_fields = []
556    additional_fields = ['level', 'code']
557    additional_headers = ['level', 'code']
558
559    @property
560    def available_fields(self):
561        fields = [
562            'student_id','reg_number','matric_number',
563            'mandatory', 'score', 'carry_over', 'automatic',
564            'level_session'
565            ] + self.additional_fields
566        return sorted(fields)
567
568    def getParent(self, row, site):
569        student = self._getStudent(row, site)
570        if student is None:
571            return None
572        return student['studycourse'].get(row['level'])
573
574    def getEntry(self, row, site):
575        level = self.getParent(row, site)
576        if level is None:
577            return None
578        return level.get(row['code'])
579
580    def updateEntry(self, obj, row, site, filename):
581        """Update obj to the values given in row.
582        """
583        items_changed = super(CourseTicketProcessor, self).updateEntry(
584            obj, row, site, filename)
585        parent = self.getParent(row, site)
586        student = self.getParent(row, site).__parent__.__parent__
587        student.__parent__.logger.info(
588            '%s - %s - %s - %s - updated: %s'
589            % (self.name, filename, student.student_id, parent.level, items_changed))
590        return
591
592    def addEntry(self, obj, row, site):
593        parent = self.getParent(row, site)
594        catalog = getUtility(ICatalog, name='courses_catalog')
595        entries = list(catalog.searchResults(code=(row['code'],row['code'])))
596        obj.fcode = entries[0].__parent__.__parent__.__parent__.code
597        obj.dcode = entries[0].__parent__.__parent__.code
598        obj.title = entries[0].title
599        #if getattr(obj, 'credits', None) is None:
600        obj.credits = entries[0].credits
601        #if getattr(obj, 'passmark', None) is None:
602        obj.passmark = entries[0].passmark
603        obj.semester = entries[0].semester
604        parent[row['code']] = obj
605        return
606
607    def delEntry(self, row, site):
608        ticket = self.getEntry(row, site)
609        parent = self.getParent(row, site)
610        if ticket is not None:
611            student = self._getStudent(row, site)
612            student.__parent__.logger.info('%s - Course ticket in %s removed: %s'
613                % (student.student_id, parent.level, ticket.code))
614            del parent[ticket.code]
615        return
616
617    def checkConversion(self, row, mode='ignore'):
618        """Validates all values in row.
619        """
620        errs, inv_errs, conv_dict = super(
621            CourseTicketProcessor, self).checkConversion(row, mode=mode)
622        if mode == 'remove':
623            return errs, inv_errs, conv_dict
624        # In update and create mode we have to check if course really exists.
625        # This is not done by the converter.
626        catalog = getUtility(ICatalog, name='courses_catalog')
627        entries = catalog.searchResults(code=(row['code'],row['code']))
628        if len(entries) == 0:
629            errs.append(('code','non-existent'))
630            return errs, inv_errs, conv_dict
631        # If level_session is provided in row we have to check if
632        # the parent studylevel exists and if its level_session
633        # attribute corresponds with the expected value in row.
634        level_session = conv_dict.get('level_session', IGNORE_MARKER)
635        if level_session not in (IGNORE_MARKER, None):
636            site = grok.getSite()
637            studylevel = self.getParent(row, site)
638            if studylevel is not None:
639                if studylevel.level_session != level_session:
640                    errs.append(('level_session','does not match %s'
641                        % studylevel.level_session))
642            else:
643                errs.append(('level','does not exist'))
644        return errs, inv_errs, conv_dict
645
646class StudentOnlinePaymentProcessor(StudentProcessorBase):
647    """A batch processor for IStudentOnlinePayment objects.
648    """
649    grok.implements(IBatchProcessor)
650    grok.provides(IBatchProcessor)
651    grok.context(Interface)
652    util_name = 'paymentprocessor'
653    grok.name(util_name)
654
655    name = u'Student Payment Processor'
656    iface = IStudentOnlinePayment
657    factory_name = 'waeup.StudentOnlinePayment'
658
659    location_fields = []
660    additional_fields = ['p_id']
661    additional_headers = []
662
663    def checkHeaders(self, headerfields, mode='ignore'):
664        super(StudentOnlinePaymentProcessor, self).checkHeaders(headerfields)
665        if mode in ('update', 'remove') and not 'p_id' in headerfields:
666            raise FatalCSVError(
667                "Need p_id for import in update and remove modes!")
668        return True
669
670    def parentsExist(self, row, site):
671        return self.getParent(row, site) is not None
672
673    def getParent(self, row, site):
674        student = self._getStudent(row, site)
675        if student is None:
676            return None
677        return student['payments']
678
679    def getEntry(self, row, site):
680        payments = self.getParent(row, site)
681        if payments is None:
682            return None
683        p_id = row.get('p_id', None)
684        if p_id is None:
685            return None
686        # We can use the hash symbol at the end of p_id in import files
687        # to avoid annoying automatic number transformation
688        # by Excel or Calc
689        p_id = p_id.strip('#')
690        if len(p_id.split('-')) != 3 and not p_id.startswith('p'):
691            # For data migration from old SRP only
692            p_id = 'p' + p_id[7:] + '0'
693        entry = payments.get(p_id)
694        return entry
695
696    def updateEntry(self, obj, row, site, filename):
697        """Update obj to the values given in row.
698        """
699        items_changed = super(StudentOnlinePaymentProcessor, self).updateEntry(
700            obj, row, site, filename)
701        student = self.getParent(row, site).__parent__
702        student.__parent__.logger.info(
703            '%s - %s - %s - updated: %s'
704            % (self.name, filename, student.student_id, items_changed))
705        return
706
707    def addEntry(self, obj, row, site):
708        parent = self.getParent(row, site)
709        p_id = row['p_id'].strip('#')
710        if len(p_id.split('-')) != 3 and not p_id.startswith('p'):
711            # For data migration from old SRP
712            obj.p_id = 'p' + p_id[7:] + '0'
713            parent[obj.p_id] = obj
714        else:
715            parent[p_id] = obj
716        return
717
718    def delEntry(self, row, site):
719        payment = self.getEntry(row, site)
720        parent = self.getParent(row, site)
721        if payment is not None:
722            student = self._getStudent(row, site)
723            student.__parent__.logger.info('%s - Payment ticket removed: %s'
724                % (student.student_id, payment.p_id))
725            del parent[payment.p_id]
726        return
727
728    def checkConversion(self, row, mode='ignore'):
729        """Validates all values in row.
730        """
731        errs, inv_errs, conv_dict = super(
732            StudentOnlinePaymentProcessor, self).checkConversion(row, mode=mode)
733
734        # We have to check p_id.
735        p_id = row.get('p_id', None)
736        if not p_id:
737            timestamp = ("%d" % int(time()*10000))[1:]
738            p_id = "p%s" % timestamp
739            conv_dict['p_id'] = p_id
740            return errs, inv_errs, conv_dict
741        else:
742            p_id = p_id.strip('#')
743        if p_id.startswith('p'):
744            if not len(p_id) == 14:
745                errs.append(('p_id','invalid length'))
746                return errs, inv_errs, conv_dict
747        elif len(p_id.split('-')) == 3:
748            # The SRP used either pins as keys ...
749            if len(p_id.split('-')[2]) not in (9, 10):
750                errs.append(('p_id','invalid pin'))
751                return errs, inv_errs, conv_dict
752        else:
753            # ... or order_ids.
754            if not len(p_id) == 19:
755                errs.append(('p_id','invalid length'))
756                return errs, inv_errs, conv_dict
757        return errs, inv_errs, conv_dict
758
759class StudentVerdictProcessor(StudentStudyCourseProcessor):
760    """A special batch processor for verdicts.
761
762    Import verdicts and perform workflow transitions.
763    """
764
765    util_name = 'verdictupdater'
766    grok.name(util_name)
767
768    name = u'Verdict Processor (special processor, update only)'
769    iface = IStudentVerdictUpdate
770    factory_name = 'waeup.StudentStudyCourse'
771
772    additional_fields = [
773        'current_session',
774        'current_level',
775        'bypass_validation',
776        'validated_by']
777
778    def checkUpdateRequirements(self, obj, row, site):
779        """Checks requirements the studycourse and the student must fulfill
780        before being updated.
781        """
782        # Check if current_levels correspond
783        if obj.current_level != row['current_level']:
784            return 'Current level does not correspond.'
785        # Check if current_sessions correspond
786        if obj.current_session != row['current_session']:
787            return 'Current session does not correspond.'
788        # Check if new verdict is provided
789        if row['current_verdict'] in (IGNORE_MARKER, ''):
790            return 'No verdict in import file.'
791        # Check if studylevel exists
792        level_string = str(obj.current_level)
793        if obj.get(level_string) is None:
794            return 'Study level object is missing.'
795        # Check if student is in state REGISTERED or VALIDATED
796        if row.get('bypass_validation'):
797            if obj.student.state not in (VALIDATED, REGISTERED):
798                return 'Student in wrong state.'
799        else:
800            if obj.student.state != VALIDATED:
801                return 'Student in wrong state.'
802        return None
803
804    def updateEntry(self, obj, row, site, filename):
805        """Update obj to the values given in row.
806        """
807        # Don't set current_session, current_level
808        vals_to_set = dict((key, val) for key, val in row.items()
809                           if key not in ('current_session','current_level'))
810        super(StudentVerdictProcessor, self).updateEntry(
811            obj, vals_to_set, site, filename)
812        parent = self.getParent(row, site)
813        # Set current_vedict in corresponding studylevel
814        level_string = str(obj.current_level)
815        obj[level_string].level_verdict = row['current_verdict']
816        # Fire transition and set studylevel attributes
817        # depending on student's state
818        if obj.__parent__.state == REGISTERED:
819            validated_by = row.get('validated_by', '')
820            if validated_by in (IGNORE_MARKER, ''):
821                portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
822                system = translate(_('System'),'waeup.kofa',
823                                  target_language=portal_language)
824                obj[level_string].validated_by = system
825            else:
826                obj[level_string].validated_by = validated_by
827            obj[level_string].validation_date = datetime.utcnow()
828            IWorkflowInfo(obj.__parent__).fireTransition('bypass_validation')
829        else:
830            IWorkflowInfo(obj.__parent__).fireTransition('return')
831        # Update the students_catalog
832        notify(grok.ObjectModifiedEvent(obj.__parent__))
833        return
Note: See TracBrowser for help on using the repository browser.