source: WAeUP_SRP/base/WAeUPImport.py @ 3326

Last change on this file since 3326 was 3326, checked in by Henrik Bettermann, 17 years ago

some beautifying
  • Property svn:keywords set to Id
File size: 48.2 KB
Line 
1#-*- mode: python; mode: fold -*-
2# (C) Copyright 2005 The WAeUP group  <http://www.waeup.org>
3# Author: Joachim Schmitz (js@aixtraware.de)
4#
5# This program is free software; you can redistribute it and/or modify
6# it under the terms of the GNU General Public License version 2 as published
7# by the Free Software Foundation.
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
17# 02111-1307, USA.
18#
19# $Id: WAeUPImport.py 3326 2008-03-12 22:28:34Z henrik $
20"""The WAeUP Tool Box.
21"""
22
23#from AccessControl import ClassSecurityInfo
24#from Acquisition import aq_inner
25#from Acquisition import aq_parent
26#from Globals import DTMLFile
27#from Globals import InitializeClass
28from OFS.SimpleItem import SimpleItem
29from zExceptions import BadRequest
30
31#from Products.CMFCore.utils import getToolByName
32#from Products.CPSSchemas.DataStructure import DataStructure
33#from Products.CPSSchemas.DataModel import DataModel
34#from Products.CPSSchemas.StorageAdapter import MappingStorageAdapter
35from Products.CMFCore.ActionProviderBase import ActionProviderBase
36#from Products.CMFCore.permissions import View
37#from Products.ZCatalog.ZCatalog import ZCatalog
38#from Products.CMFCore.permissions import ModifyPortalContent
39#from Products.CMFCore.permissions import ManagePortal
40from Products.CMFCore.utils import UniqueObject
41#from Products.CMFCore.URLTool import URLTool
42from Products.CMFCore.utils import getToolByName
43from Globals import package_home,INSTANCE_HOME
44from Products.AdvancedQuery import Eq, Between, Le,In
45import csv,re,os,sys
46from shutil import copy2
47import DateTime,time
48import logging
49p_home = package_home(globals())
50i_home = INSTANCE_HOME
51from utils import makeDigest
52
53NO_KEY = '----'
54IGNORE = 'ignore'
55class WAeUPImport(UniqueObject, SimpleItem, ActionProviderBase): ###(
56    """ WAeUPImport """
57    required_modes = ('create',)
58
59    def __init__(self,waeup_tool): ###(
60        self.students_folder = waeup_tool.portal_url.getPortalObject().campus.students
61        self.member = member = waeup_tool.portal_membership.getAuthenticatedMember()
62        self.import_date = DateTime.DateTime()
63        self.imported_by = str(member)
64        #self.current = DateTime.DateTime().strftime("%d-%m-%y_%H_%M_%S")
65        self.waeup_tool = waeup_tool
66        self.academics_folder = waeup_tool.portal_url.getPortalObject().campus.academics
67        self.schema_tool = getToolByName(waeup_tool, 'portal_schemas')
68        self.layout_tool = getToolByName(waeup_tool, 'portal_layouts')
69        self.portal_workflow = getToolByName(waeup_tool, 'portal_workflow')
70        self.portal_url = getToolByName(waeup_tool, 'portal_url')
71        self.portal_catalog = waeup_tool.portal_catalog
72        self.students_catalog = waeup_tool.students_catalog
73        self.courses_catalog = waeup_tool.courses_catalog
74        self.course_results = waeup_tool.course_results
75        self.applicants_catalog = waeup_tool.applicants_catalog
76        #self.mode = mode
77        # self.import_method = getattr(self, '%s' % mode,None)
78        errors = []
79        # if self.import_method is None:
80        #     errors.append('No importer method %s' % mode)
81        self.pending_path = "%s/import/%s.pending" % (i_home,self.plural_name)
82        self.pending_tmp = "%s/import/%s.pending.tmp" % (i_home,self.plural_name)
83        self.pending_backup = "%s/import/%s.pending.old" % (i_home,self.plural_name)
84        self.pending_fn = os.path.split(self.pending_path)[1]
85        self.imported_path = "%s/import/%s.imported" % (i_home,self.plural_name)
86        self.imported_fn = os.path.split(self.imported_path)[1]
87        iname = "import_%s" % self.name
88        self.logger = logging.getLogger('WAeUPImport.%sImport' % self.plural_name.capitalize())
89        self.schema = self.schema_tool._getOb(iname,None)
90        #self.pending_schema = self.schema_tool._getOb("%s_pending" % iname,None)
91        self.layout = self.layout_tool._getOb(iname,None)
92        while True:
93            if self.schema is None:
94                errors.append('no schema %s' % iname)
95            # if self.pending_schema is None:
96            #     self.pending_schema = self.schema
97            if self.layout is None:
98                errors.append('no such layout %s' % iname)
99            if errors:
100                break
101            self.data_keys = self.schema.keys()
102            self.csv_keys = self.schema.keys()
103            info = {}
104            info['imported_from'] = ''
105            info['import_record_no'] = 0
106            info['imported_by'] = self.imported_by
107            info['import_date'] = self.import_date.strftime("%d/%m/%y %H:%M:%S")
108            info['error'] = ''
109            self.info = info
110            self.csv_keys.extend(self.info)
111            self.validators = {}
112            for widget in self.layout.keys():
113                self.validators[widget] = self.layout[widget].validate
114            self.required_keys = {}
115            for mode in self.required_modes:
116                self.required_keys[mode] = [self.layout.getIdUnprefixed(id)
117                                    for id,widget in self.layout.objectItems()
118                                    if widget.is_required]
119            break
120        self.init_errors = ','.join(errors)
121    ###)
122
123    def makeIdLists(self): ###(
124        pending_digests = []
125        pending = []
126        # pending_student_ids = []
127        # pending_matric_nos = []
128        # pending_reg_ns = []
129        if os.path.exists(self.pending_path):
130            datafile = open(self.pending_path,"r")
131            reader = csv.reader(datafile)
132            old_headline = reader.next()
133            #datafile.seek(0)
134            pending_csv_reader = csv.DictReader(datafile,old_headline,)
135            #pending_csv_reader.next() # skip headline
136            for item in pending_csv_reader:
137                digest = makeDigest(item,self.data_keys)
138                if digest not in pending_digests:
139                    pending_digests += digest,
140                    pending += item,
141            datafile.close()
142            #copy2(self.pending_path,self.pending_backup)
143        return pending, pending_digests
144    ###)
145
146    def checkHeadline(self,headline): ###(
147        """ check the headline of a csv file """
148        import_keys = [k.strip() for k in headline if not (k.strip().startswith('ignore')
149                                                        or k.strip() in self.info.keys())]
150        # import_keys = [k.strip() for k in headline if not (k.strip() in self.info.keys())]
151        diff2schema = set(import_keys).difference(set(self.schema.keys()))
152        diff2layout = set(import_keys).difference(set(self.layout.keys()))
153        #if diff2schema and diff2schema != set(['id',]):
154        if diff2schema:
155            return list(diff2schema)
156        return []
157    ###)
158
159    def getHeadlineFields(self,headline,values): ###(
160        """ check the headline of a csv file """
161        # import_keys = [k.strip() for k in headline if not (k.strip().startswith('ignore')
162        #                                                 or k.strip() in self.info.keys())]
163        import_keys = [k.strip() for k in headline if not (k.strip() in self.info.keys())]
164        si = set(import_keys)
165        ss = set(self.schema.keys())
166
167        invalid_keys = si - ss
168        keys = []
169        i = 0
170        duplicates = False
171        singels = []
172        msg = ''
173        while True:
174            if len(values) != len(import_keys):
175                msg += "%d fields in headline but %d values" % (len(import_keys),len(values))
176                break
177            for k in import_keys:
178                if k in singels:
179                    keys += (k,'%s' % k,values[i],'(duplicate)'),
180                    msg += ("duplicate %s," % k)
181                    keys[singels.index(k)] = (k,'%s' % k,values[singels.index(k)],'(duplicate)')
182                elif k in invalid_keys and not k.startswith(IGNORE):
183                    keys += (k,NO_KEY,values[i],'(invalid)'),
184                else:
185                    keys += (k,k,values[i],''),
186                i += 1
187                singels += k,
188            break
189        return msg,keys
190    ###)
191###)
192
193class ApplicationImport(WAeUPImport):###(
194    name = "application"
195    plural_name = "%ss" % name
196    commit_after = 1000
197
198    def create(self,mapping):###(
199        reg_no = mapping.get('reg_no')
200        msg = ''
201        while True:
202            try:
203                self.applicants_catalog.addRecord(**mapping)
204            except ValueError:
205                msg =  "applicant record with reg_no %s already exists" % reg_no
206            break
207        return reg_no,msg,mapping
208    ###)
209
210    def edit(self,mapping):###(
211        reg_no = mapping.get('reg_no')
212        status = mapping.get('status')
213        msg = ''
214        while True:
215            res = self.applicants_catalog(reg_no = reg_no)
216            if len(res):
217                if res[0].status == 'created' and status != 'created':
218                    msg =  "student object with id %s for %s already created, status cannot be changed" % (res[0].student_id, reg_no)
219                elif status == 'created' and res[0].status != 'created':
220                    msg =  "student object for %s has not yet been created, status cannot be set to 'created'" % (reg_no)
221                else:
222                    self.applicants_catalog.modifyRecord(**mapping)
223            else:
224                msg =  "applicant record with reg_no %s does not exist" % reg_no
225            break
226        return reg_no,msg,mapping
227    ###)
228
229###)
230
231class CertificateImport(WAeUPImport):###(
232    name = "certificate"
233    plural_name = "%ss" % name
234    commit_after = 100000
235
236    def create(self,mapping):###(
237        if getattr(self,'_v_certificate_list',None) is None:
238            self._v_certificate_list = []
239        if getattr(self,'_v_department_certificates',None) is None:
240            departments = self.portal_catalog(portal_type = "Department")
241            self._v_department_certificates = {}
242            for d in departments:
243                certificates_folder = getattr(d.getObject(),"certificates",None)
244                self._v_department_certificates[d.getId] = certificates_folder.objectIds()
245        department_id = mapping['department_code']
246        msg = ''
247        certificate_id = mapping.get('code')
248        while True:
249            department_certificates = self._v_department_certificates.get(department_id,None)
250            if department_certificates is None:
251                msg =  "No Department with ID: %s" % department_id
252                break
253            if certificate_id in self._v_certificate_list:
254                msg =  "Duplicate Certificate ID: %s" % department_id
255                break
256            if certificate_id in department_certificates:
257                msg =  "Duplicate Certificate ID: %s" % department_id
258                break
259            try:
260                d.invokeFactory('Certificate', certificate_id)
261            except BadRequest,E:
262                msg =  "%s" % E
263                break
264            self._v_certificate_list.append(certificate_id)
265            c = getattr(d,certificate_id)
266            c.getContent().edit(mapping=mapping)
267            break
268        return certificate_id,msg,mapping
269    ###)
270
271    def edit(self,mapping):###(
272        certificate_id = mapping.get('code')
273        res = self.portal_catalog(id=certificate_id)
274        msg = ''
275        while True:
276            if not res:
277                msg =  "no certificate with id: %s" % certificate_id
278                break
279            c = res[0].getObject()
280            c.getContent().edit(mapping=mapping)
281            break
282        return certificate_id,msg,mapping
283    ###)
284###)
285
286class CourseImport(WAeUPImport):###(
287    name = "course"
288    plural_name = "%ss" % name
289    commit_after = 1000
290
291    def create(self,mapping):###(
292        if getattr(self,'_v_course_list',None) is None:
293            self._v_course_list = []
294        if getattr(self,'_v_department_courses',None) is None:
295            departments = self.portal_catalog(portal_type = "Department")
296            self._v_department_courses = {}
297            for department in departments:
298                courses_folder = getattr(department.getObject(),"courses",None)
299                if courses_folder is not None:
300                    self._v_department_courses[department.getId] = courses_folder.objectIds()
301        department_id = mapping['department_code']
302        course_id = mapping.get('code','')
303        msg = ''
304        while True:
305            department_courses = self._v_department_courses.get(department_id,None)
306            if department_courses is None:
307                msg =  "no department with id: %(department_id)s" % vars()
308                break
309            if course_id in self._v_course_list:
310                msg =  "duplicate course id: %(course_id)s" % vars()
311                break
312            if course_id in department_courses:
313                msg =  "course %(course_id)s already exists in department %(department_id)s" % vars()
314                break
315            try:
316                department.invokeFactory('Course', course_id)
317            except BadRequest,E:
318                msg =  "%s" % E
319                break
320            self._v_course_list.append(course_id)
321            course = getattr(department,course_id)
322            course.getContent().edit(mapping=mapping)
323            break
324        return course_id,msg,mapping
325    ###)
326
327    def edit(self,mapping): ###(
328        course_id = mapping.get('code','')
329        course = self.courses_catalog.getRecordByKey(course_id)
330        while True:
331            if course is None:
332                msg =  "no course with id: %s" % course_id
333                break
334            course_object = getattr(getattr(self.academics_folder,course.department),course_id)
335            course_object.getContent().edit(mapping=mapping)
336            break
337        return course_id,msg,mapping
338    ###)
339###)
340
341class CourseResultImport(WAeUPImport):###(
342    """ CourseresultImport """
343    name = "course_result"
344    plural_name = "%ss" % name
345    commit_after = 1000000
346    required_modes = ('create','edit','remove')
347
348    def getStudentRecord(self,mapping): ###(
349        id_field_found = False
350        msg = ''
351        student_record = None
352        id_count = 0
353        for id_key in ('id','matric_no'):
354            id_field = mapping.get(id_key,'')
355            if id_field:
356                id_count += 1
357                search_key = id_key
358                search_field = id_field
359        while True:
360            if id_count > 1:
361                msg = "both id and matric_no are provided"
362                break
363            elif id_count == 0:
364                msg = "neither id nor matric_no provided"
365                break
366            query = Eq(search_key,search_field)
367            res = self.students_catalog.evalAdvancedQuery(query)
368            if res:
369                student_record = res[0]
370                if search_key == "matric_no":
371                    mapping['id'] = student_record.id
372                elif search_key == "id":
373                    mapping['matric_no'] = student_record.matric_no
374            else:
375                msg = "no student with %(search_key)s %(search_field)s" % vars()
376            break
377        return student_record,msg
378    ###)
379
380    def create(self,mapping):###(
381        students_folder = self.portal_url.getPortalObject().campus.students
382        if getattr(self,'_v_courses',None) is None:
383            res = self.courses_catalog()
384            self._v_courses = {}
385            for brain in res:
386                self._v_courses[brain.code] = brain
387        if getattr(self,'_v_level_created',None) is None:
388            self._v_level_created = []
389        msg = ''
390        key = ''
391        while True:
392            course_id = mapping.get('code')
393            if course_id not in self._v_courses.keys():
394                msg = "no course with id: %s" % course_id
395                break
396            student_record,msg = self.getStudentRecord(mapping)
397            if msg:
398                break
399            student_id = student_record.id
400            level_id = mapping.get('level_id','')
401            code = mapping.get('code','')
402            if student_id not in self._v_level_created:
403                try:
404                    context = getattr(getattr(students_folder,
405                                            "%(student_id)s" % vars()),
406                                    'study_course')
407                except:
408                    msg = "could not create level %(level_id)s for %(student_id)s" % vars()
409                    break
410                if level_id not in context.objectIds():
411                    context.invokeFactory('StudentStudyLevel',"%(level_id)s" % vars())
412                    level = getattr(context,"%(level_id)s" % vars())
413                    self.portal_workflow.doActionFor(level,'open')
414                    # the session string must not be copied into the level object
415                    current_verdict = getattr(student_record,'current_verdict','')
416                    current_session = getattr(student_record,'current_session','')
417                    if current_verdict and student_record.current_level == level_id:
418                        level.getContent().edit(mapping={'verdict': "%s" %
419                                                        current_verdict,
420                                                        'session': "%s" %
421                                                        current_session,
422                                                        })
423                        self.portal_workflow.doActionFor(level,'close')
424                self._v_level_created += student_id,
425            mapping['key'] = key = "%(student_id)s|%(level_id)s|%(code)s" % vars()
426            for k in ('semester','credits',):
427                mapping[k] = getattr(self._v_courses[course_id],k)
428            try:
429                self.course_results.addRecord(**mapping)
430            except ValueError:
431                msg = "course result already exists: %s" % key
432            break
433        return key,msg,mapping
434    ###)
435
436    def edit(self,mapping): ###(
437        msg = ''
438        key = ''
439        while True:
440            student_record,msg = self.getStudentRecord(mapping)
441            if msg:
442                break
443            level_id = mapping.get('level_id','')
444            code = mapping.get('code','')
445            code = mapping['code']
446            mapping['key'] = key = "%(student_id)s|%(level_id)s|%(code)s" % vars()
447            break
448        try:
449            self.course_results.modifyRecord(**mapping)
450        except KeyError:
451            msg = "no course result with key %s" % key
452        return key,msg,mapping
453    ###)
454
455    def remove(self,mapping):###(
456        key = ''
457        msg = ''
458        while True:
459            student_record,msg = self.getStudentRecord(mapping)
460            if msg:
461                break
462            student_id = student_record.id
463            level_id = mapping.get('level_id','')
464            code = mapping.get('code','')
465            key = "%(student_id)s|%(level_id)s|%(code)s" % vars()
466            if self.course_results.getRecordByKey(key) is None:
467                msg =  "no course result with key %(key)s" % vars()
468                break
469            self.course_results.deleteRecord(key)
470            break
471        return key,msg,mapping
472    ###)
473
474###)
475
476class CertificateCourseImport(WAeUPImport):###(
477    name = "certificate_course"
478    plural_name = "%ss" % name
479    commit_after = 100000
480    required_modes = ('create','edit')
481
482    def create(self,mapping):
483        if getattr(self,'_v_courses',None) is None:
484            res = self.courses_catalog()
485            self._v_courses= [course.code for course in res]
486        if getattr(self,'_v_ceritficates',None) is None:
487            res = self.portal_catalog(portal_type = "Certificate")
488            self._v_certificates = {}
489            for cert in res:
490                self._v_certificates[cert.getId] = cert.getObject()
491        msg = ''
492        while True:
493            certificate_course_id = mapping.get('code')
494            if certificate_course_id not in self._v_courses:
495                msg =  "no course with id: %s" % certificate_course_id
496                break
497            cert_id = mapping['certificate_code']
498            cert = self._v_certificates.get(cert_id,None)
499            if cert is None:
500                msg =  "no certificate with id: %s" % cert_id
501                break
502            level_id = mapping.get('level')
503            level = getattr(cert,level_id,None)
504            if level is None:
505                cert.invokeFactory('StudyLevel', level_id)
506                level = getattr(cert,level_id,None)
507            elif hasattr(level,certificate_course_id):
508                msg =  "duplicate certificate course id: %(certificate_course_id)s " % vars()
509                msg += "in %(cert_id)s/ %(level_id)s" % vars()
510                break
511            level.invokeFactory('CertificateCourse', certificate_course_id)
512            c = getattr(level,certificate_course_id)
513            c.getContent().edit(mapping=mapping)
514            break
515        return certificate_course_id,msg,mapping
516    ###)
517
518class DepartmentImport(WAeUPImport):###(
519    name = "department"
520    plural_name = "%ss" % name
521    commit_after = 1000
522
523    def create(self,mapping):###(
524        "create a department in the correct faculty"
525        faculty_id = mapping['faculty_code']
526        msg = ''
527        if getattr(self,'_v_faculties',None) is None:
528            res = self.portal_catalog(portal_type = "Department")
529            self._v_faculties = {}
530            for f in res:
531                self._v_faculties[f.getId] = f.getObject()
532        department_id = mapping.get('code','')
533        while True:
534            faculty = self._v_faculties.get(faculty_id,None)
535            if faculty is None:
536                msg =  "no faculty with id: %s" % faculty_id
537                break
538            else:
539                d = getattr(faculty,department_id,None)
540                if d is None or d.portal_type == "Faculty":
541                    try:
542                        faculty.invokeFactory('Department', department_id)
543                    except BadRequest,E:
544                        msg =  "%s" % E
545                        break
546                    d = getattr(faculty,department_id)
547                    d.invokeFactory('CoursesFolder','courses')
548                    courses = getattr(d,'courses')
549                    dict = {'Title': 'Courses'}
550                    courses.getContent().edit(mapping=dict)
551                    d.invokeFactory('CertificatesFolder','certificates')
552                    certificates = getattr(d,'certificates')
553                    dict = {'Title': 'Certificates'}
554                    certificates.getContent().edit(mapping=dict)
555                    d.getContent().edit(mapping=mapping)
556            break
557        return department_id,msg,mapping
558    ###)
559
560    def edit(self,mapping): ###(
561        "edit a department in the correct faculty"
562        academics_folder = self.portal_url.getPortalObject().campus.academics
563        faculty_id = mapping['faculty_code']
564        department_id = mapping.get('code','')
565        msg = ''
566        while True:
567            try:
568                d = getattr(getattr(academics_folder,faculty_id),department_id,None)
569            except KeyError:
570                msg =  "department %s or faculty %s wrong" % (department_id,faculty_id)
571                break
572            if d is None or d.portal_type == "Faculty":
573                msg =  "department %s not found" % (department_id)
574                break
575            d.getContent().edit(mapping=mapping)
576            break
577        return department_id,msg,mapping
578    ###)
579###)
580
581class FacultyImport(WAeUPImport):###(
582    name = "faculty"
583    plural_name = "faculties"
584    commit_after = 100
585
586    def create(self,mapping): ###(
587        "create a faculty"
588        academics_folder = self.portal_url.getPortalObject().campus.academics
589        faculty_id = mapping.get('code','')
590        msg = ''
591        while True:
592            if faculty_id in academics_folder.objectIds():
593                msg =  "faculty with id: %s exists" % faculty_id
594                break
595            logger.info('Creating Faculty %(code)s, %(title)s' % mapping)
596            try:
597                academics_folder.invokeFactory('Faculty', faculty_id)
598            except BadRequest,E:
599                msg =  "%s" % E
600                break
601            f = getattr(academics_folder,faculty_id,None)
602            f.getContent().edit(mapping=mapping)
603            break
604        return faculty_id,msg,mapping
605        ###)
606
607    def edit(self,mapping): ###(
608        "edit a faculty"
609        academics_folder = self.portal_url.getPortalObject().campus.academics
610        faculty_id = mapping['code']
611        msg = ''
612        while True:
613            f = getattr(academics_folder,faculty_id,None)
614            if f is None:
615                msg =  "faculty with id: %s does not exist" % faculty_id
616            f.getContent().edit(mapping=mapping)
617            break
618        return faculty_id,msg,mapping
619    ###)
620###)
621
622class StudentImport(WAeUPImport):###(
623    name = "student"
624    plural_name = "%ss" % name
625    commit_after = 100
626
627    field2types_student = {   ###(
628                      'StudentApplication':
629                          {'id': 'application',
630                           'title': 'Application Data',
631                           'wf_transition_return': 'close',
632                           'wf_transition_admit': 'remain',
633                           'fields':
634                             ('jamb_reg_no',
635                              'entry_mode',
636                              'entry_session',
637                              'jamb_score',
638                              'app_email',
639                              'jamb_age',
640                              'jamb_state',
641                              'jamb_lga',
642                              'jamb_sex',
643                              )
644                              },
645                      #'StudentPume':
646                      #    {'id': 'pume',
647                      #     'title': 'Pume Data',
648                      #     'wf_transition_return': 'close',
649                      #     'wf_transition_admit': 'close',
650                      #     'fields':
651                      #       ('pume_score',
652                      #        )
653                      #        },
654                      'StudentClearance':
655                          {'id': 'clearance',
656                           'title': 'Clearance/Eligibility Record',
657                           'wf_transition_return': 'close',
658                           'wf_transition_admit': 'remain',
659                           'fields':
660                             ('matric_no',
661                              'nationality',
662                              'lga',
663                              'birthday',
664                              )
665                              },
666                         'StudentPersonal':
667                          {'id': 'personal',
668                           'title': 'Personal Data',
669                           'wf_transition_return': 'open',
670                           'wf_transition_admit': 'remain',
671                           'fields':
672                             ('firstname',
673                              'middlename',
674                              'lastname',
675                              'sex',
676                              'email',
677                              'phone',
678                              'perm_address',
679                              )
680                              },
681                         'StudentStudyCourse':
682                          {'id': 'study_course',
683                           'title': 'Study Course',
684                           'wf_transition_return': 'open',
685                           'wf_transition_admit': 'remain',
686                           'fields':
687                             ('study_course',
688                              'current_level',
689                              'current_session',
690                              'current_mode',
691                              'current_verdict',
692                              'previous_verdict',
693                              )
694                              },
695                         # 'StudentStudyLevel':
696                         #  {'id': 'current_level',
697                         #   'title': '',
698                         #   'wf_transition_return': 'open',
699                         #   'wf_transition_admit': 'remain',
700                         #   'fields':
701                         #     ('verdict',
702                         #      'session',
703                         #      )
704                         #      },
705                         'PaymentsFolder':
706                          {'id': 'payments',
707                           'title': 'Payments',
708                           'wf_transition_return': 'open',
709                           'wf_transition_admit': 'open',
710                           'fields':
711                             ()
712                              },
713                         }
714    ###)
715
716    def create(self,mapping): ###(
717        "create student records due import"
718        logger = logging.getLogger('WAeUPTool.mass_create_student')
719        students_folder = self.portal_url.getPortalObject().campus.students
720        jamb_reg_no = mapping.get('jamb_reg_no',None)
721        matric_no = mapping.get('matric_no',None)
722        msg = ''
723        student_id = mapping.get('id',None)
724        while True:
725            if student_id:
726                msg = "student_id must not be specified in create mode"
727                break
728            if jamb_reg_no:
729                res = self.students_catalog(jamb_reg_no = jamb_reg_no)
730                if res:
731                    msg = "jamb_reg_no exists"
732                    break
733            if matric_no:
734                res = self.students_catalog(matric_no = matric_no)
735                if res:
736                    msg = "matric_no exists"
737                    break
738            if not matric_no and not jamb_reg_no:
739                msg = "jamb_reg_no or matric_no must be specified"
740                break
741            student_id = self.waeup_tool.generateStudentId('?')
742            students_folder.invokeFactory('Student', student_id)
743            student_obj = getattr(students_folder,student_id)
744            f2t = self.field2types_student
745            d = {}
746            transition = mapping.get('reg_transition','admit')
747            if transition not in ('admit','return'):
748                msg = "no valid transition provided"
749                break
750            for pt in f2t.keys():
751                student_obj.invokeFactory(pt,f2t[pt]['id'])
752                sub_obj = getattr(student_obj,f2t[pt]['id'])
753                sub_doc = sub_obj.getContent()
754                d['Title'] = f2t[pt]['title']
755                for field in f2t[pt]['fields']:
756                    d[field] = mapping.get(field,'')
757
758                if pt == "StudentApplication":
759                    #d['jamb_sex']  = 'M'
760                    #if mapping.get('sex'):
761                    #    d['jamb_sex']  = 'F'
762                    d['jamb_firstname'] = mapping.get('firstname',None)
763                    d['jamb_middlename'] = mapping.get('middlename',None)
764                    d['jamb_lastname'] = mapping.get('lastname',None)
765
766                # if pt == "StudyCourse":
767                #     for von,zu in (('entry_mode','current_mode'),
768                #                    ('entry_session','current_session')):
769                #         if mapping.get(zu,None) is None and mapping.get(von,None) is not None:
770                #             d[zu] = mapping[von]
771                sub_doc.edit(mapping = d)
772
773                #import pdb;pdb.set_trace()
774                new_state = f2t[pt]['wf_transition_%(transition)s' % vars()]
775                if new_state != "remain":
776                    self.portal_workflow.doActionFor(sub_obj,new_state,dest_container=sub_obj)
777            self.portal_workflow.doActionFor(student_obj,transition)
778            student_obj.manage_setLocalRoles(student_id, ['Owner',])
779            mapping['id'] = student_id
780            break
781        return student_id,msg,mapping
782    ###)
783
784    def edit(self,mapping): ###(
785        wftool = self.portal_workflow
786        "edit student records due import"
787        logger = logging.getLogger('WAeUPTool.mass_edit_student')
788        students_folder = self.portal_url.getPortalObject().campus.students
789        student_id = mapping.get('id',None)
790        jamb_reg_no = mapping.get('jamb_reg_no',None)
791        matric_no = mapping.get('matric_no',None)
792        editable_keys = mapping.keys()
793        msg = ''
794        while True:
795            if student_id:
796                res = self.students_catalog(id = student_id)
797                if not res:
798                    msg = "no student with id %s" % student_id
799                    break
800                student_record = res[0]
801                if matric_no and student_record.matric_no:
802                    if  matric_no != student_record.matric_no:
803                        msg = "old matric_no %s overwritten with %s" % (student_record.matric_no,matric_no)
804                        #logger.info("%s, old matric_no %s overwritten with %s" % (student_record.id,student_record.matric_no,matric_no))
805                if jamb_reg_no and student_record.jamb_reg_no:
806                    if jamb_reg_no != student_record.jamb_reg_no:
807                        msg = "old reg_no %s overwritten with %s" % (student_record.jamb_reg_no,jamb_reg_no)
808                        #logger.info("%s, old reg_no %s overwritten with %s" % (student_record.id,student_record.jamb_reg_no,jamb_reg_no))
809            elif jamb_reg_no:
810                res = self.students_catalog(jamb_reg_no = jamb_reg_no)
811                if not res:
812                    msg = "no student with jamb_reg_no %s" % jamb_reg_no
813                    break
814                student_record = res[0]
815                editable_keys.remove('jamb_reg_no')
816            elif matric_no:
817                res = self.students_catalog(matric_no = matric_no)
818                if not res:
819                    msg = "no student with matric_no %s" % matric_no
820                    break
821                student_record = res[0]
822                editable_keys.remove('matric_no')
823            ## included only to change wf state from admitted to returning
824            #if student_record.review_state not in ('admitted','objection_raised'):
825            #    return '%s' % student_record.id ,"student is not in state admitted or objection_raised"
826            ## end inclusion
827            student_id = student_record.id
828            student_obj = getattr(students_folder,student_id)
829            f2t = self.field2types_student
830            d = {}
831            any_change = False
832            #special treatment for StudentStudyLevel
833            d['verdict']  = mapping.get('current_verdict','')
834            d['session']  = mapping.get('current_session','')
835            current_level = mapping.get('current_level','')
836            while d['session'] and d['verdict'] and current_level:
837                sub_obj = getattr(student_obj,'study_course',None)
838                if sub_obj is None:
839                    break
840                level_obj = getattr(sub_obj,current_level,None)
841                if  level_obj is None:
842                    break
843                any_change = True
844                level_obj.getContent().edit(mapping = d)
845                try:
846                    wftool.doActionFor(level_obj,'close')
847                except:
848                    pass
849                break
850            for pt in f2t.keys():
851                #if pt == "StudentApplication":
852                #    d['jamb_sex']  = 'M'
853                #    if mapping.get('sex'):
854                #        d['jamb_sex']  = 'F'
855                intersect = set(f2t[pt]['fields']).intersection(set(editable_keys))
856                if intersect and pt not in ('StudentStudyLevel',):
857                    object_id = f2t[pt]['id']
858                    sub_obj = getattr(student_obj,object_id,None)
859                    if sub_obj is None:
860                        try:
861                            student_obj.invokeFactory(pt,object_id)
862                        except:
863                            continue
864                        sub_obj = getattr(student_obj,object_id)
865                        if f2t[pt]['title'] != '':
866                            d['Title'] = f2t[pt]['title']
867                    sub_doc = sub_obj.getContent()
868                    for field in intersect:
869                        changed = False
870                        if getattr(sub_doc,field,None) != mapping.get(field,''):
871                            any_change = True
872                            changed = True
873                            d[field] = mapping.get(field,'')
874                        if changed:
875                            sub_doc.edit(mapping = d)
876            ## included only to change wf state from admitted to returning
877            #    if student_record.review_state in ('admitted','objection_raised'):
878            #        new_state = f2t[pt]['wf_transition_return']
879            #        sub_obj = getattr(student_obj,f2t[pt]['id'],None)
880            #        if sub_obj and new_state != "remain":
881            #            try:
882            #                self.portal_workflow.doActionFor(sub_obj,new_state,dest_container=sub_obj)
883            #            except:
884            #                #logger.info('%s, wf transition %s of %s failed' % (student_id,new_state,sub_obj.id))
885            #                pass
886            #if student_record.review_state in ('admitted','objection_raised'):
887            #    wfaction = 'return'
888            #    try:
889            #        self.portal_workflow.doActionFor(student_obj,wfaction)
890            #        logger.info('%s, wf state changed' % student_id)
891            #        any_change = True
892            #    except:
893            #        logger.info('%s, wf transition failed, old state = %s' % (student_id,student_record.review_state))
894            #        pass
895            ## end inclusion
896            break
897        # if not any_change:
898        #     msg = 'not modified'
899        return student_id,msg,mapping
900    ###)
901###)
902
903class VerdictImport(WAeUPImport):###(
904    """ VerdictImport """
905    name = "verdict"
906    plural_name = "%ss" % name
907    commit_after = 100000
908    required_modes = ('create','edit')
909
910    def create(self,mapping):
911        "edit student verdicts and create StudentStudyLevel object if not existent"
912        wftool = self.portal_workflow
913        logger = logging.getLogger('WAeUPTool.mass_edit_verdict')
914        students_folder = self.portal_url.getPortalObject().campus.students
915        student_id = mapping.get('id',None)
916        matric_no = mapping.get('matric_no',None)
917        editable_keys = mapping.keys()
918        while True:
919            key = ''
920            msg = ''
921            if student_id:
922                student_record = self.students_catalog.getRecordByKey(student_id)
923                if student_record is None:
924                    #return '',"no student with id %s" % student_id
925                    msg = "no student with id %s" % student_id
926                    break
927                if matric_no and student_record.matric_no and matric_no != student_record.matric_no:
928                    msg = 'student %s: matric_no %s does not match %s' % (student_record.id,
929                                                                          student_record.matric_no,
930                                                                          matric_no)
931                    break
932                mapping['matric_no'] = student_record.matric_no
933            elif matric_no:
934                res = self.students_catalog(matric_no = matric_no)
935                if not res:
936                    msg = "no student with matric_no %s" % matric_no
937                    break
938                student_record = res[0]
939                editable_keys.remove('matric_no')
940            else:
941                msg = "no id or matric_no specified"
942                break
943            student_id = student_record.id
944            mapping['id'] = student_id
945            d = {}
946            #import pdb;pdb.set_trace()
947            any_change = False
948            #special treatment for StudentStudyLevel
949            current_session = d['session'] = mapping.get('current_session','')
950            if current_session and student_record.session != current_session:
951                msg = 'student %s: imported session %s does not match current_session %s' % (student_id,
952                                                                                            current_session,
953                                                                                            student_record.session)
954                break
955            current_level = mapping.get('current_level','')
956            if not current_level.isdigit():
957                msg = 'student %s: imported level is empty' % (student_id,)
958                break
959            if current_level and student_record.level != current_level:
960                msg = 'student %s: imported level %s does not match current_level %s' % (student_id,
961                                                                                        current_level,
962                                                                                        student_record.level)
963                break
964            student_review_state =  student_record.review_state
965            if student_review_state == 'deactivated':
966                msg = "student %s in review_state %s" % (student_id, student_review_state)
967                break
968            if student_review_state not in ('courses_validated','returning'):
969                msg = "student %s in wrong review_state %s" % (student_id, student_review_state)
970                break
971            student_obj = getattr(students_folder,student_id)
972            # f2t = self.field2types_student
973            study_course_obj = getattr(student_obj,'study_course',None)
974            if study_course_obj is None:
975                msg = 'student %s: no study_course object' % student_id
976                break
977            level_obj = getattr(study_course_obj,current_level,None)
978
979            if  level_obj is None:
980                # The only difference to the edit method is that we create a StudentStudyLevel object
981                try:
982                    study_course_obj.invokeFactory('StudentStudyLevel',"%s" % current_level)
983                    level_obj = getattr(context,"%s" % current_level)
984                    level_obj.portal_workflow.doActionFor(level,'open')
985                except:
986                    continue
987                #msg = 'student %s: no study_level object for level %s' % (student_id,
988                #                                                                current_level)
989                #break
990
991            verdict = d['verdict'] = d['current_verdict']  = mapping.get('current_verdict','')
992
993            #if verdict == student_record.verdict:
994            #    msg = 'student %s: verdict already set to %s' % (student_id,
995            #                                                            verdict)
996
997            level_review_state = wftool.getInfoFor(level_obj,'review_state',None)
998            if level_review_state != "closed":
999                wftool.doActionFor(level_obj,'close')
1000                # msg = 'student %s: level %s is not closed' % (student_id,
1001                #                                                      current_level)
1002
1003            study_course_obj.getContent().edit(mapping = d)
1004            level_obj.getContent().edit(mapping = d)
1005            if student_review_state != "returning":
1006                wftool.doActionFor(student_obj,'return')
1007            # try:
1008            #     wftool.doActionFor(level_obj,'close')
1009            # except:
1010            #     pass
1011            break
1012        return student_id,msg,mapping
1013
1014
1015    def edit(self,mapping):
1016        "edit student verdicts"
1017        wftool = self.portal_workflow
1018        logger = logging.getLogger('WAeUPTool.mass_edit_verdict')
1019        students_folder = self.portal_url.getPortalObject().campus.students
1020        student_id = mapping.get('id',None)
1021        matric_no = mapping.get('matric_no',None)
1022        editable_keys = mapping.keys()
1023        while True:
1024            key = ''
1025            msg = ''
1026            if student_id:
1027                student_record = self.students_catalog.getRecordByKey(student_id)
1028                if student_record is None:
1029                    #return '',"no student with id %s" % student_id
1030                    msg = "no student with id %s" % student_id
1031                    break
1032                if matric_no and student_record.matric_no and matric_no != student_record.matric_no:
1033                    msg = 'student %s: matric_no %s does not match %s' % (student_record.id,
1034                                                                          student_record.matric_no,
1035                                                                          matric_no)
1036                    break
1037                mapping['matric_no'] = student_record.matric_no
1038            elif matric_no:
1039                res = self.students_catalog(matric_no = matric_no)
1040                if not res:
1041                    msg = "no student with matric_no %s" % matric_no
1042                    break
1043                student_record = res[0]
1044                editable_keys.remove('matric_no')
1045            else:
1046                msg = "no id or matric_no specified"
1047                break
1048            student_id = student_record.id
1049            mapping['id'] = student_id
1050            d = {}
1051            #import pdb;pdb.set_trace()
1052            any_change = False
1053            #special treatment for StudentStudyLevel
1054            current_session = d['session'] = mapping.get('current_session','')
1055            if current_session and student_record.session != current_session:
1056                msg = 'student %s: imported session %s does not match current_session %s' % (student_id,
1057                                                                                            current_session,
1058                                                                                            student_record.session)
1059                break
1060            current_level = mapping.get('current_level','')
1061            if not current_level.isdigit():
1062                msg = 'student %s: imported level is empty' % (student_id,)
1063                break
1064            if current_level and student_record.level != current_level:
1065                msg = 'student %s: imported level %s does not match current_level %s' % (student_id,
1066                                                                                        current_level,
1067                                                                                        student_record.level)
1068                break
1069            student_review_state =  student_record.review_state
1070            if student_review_state == 'deactivated':
1071                msg = "student %s in review_state %s" % (student_id, student_review_state)
1072                break
1073            if student_review_state not in ('courses_validated','returning'):
1074                msg = "student %s in wrong review_state %s" % (student_id, student_review_state)
1075                break
1076            student_obj = getattr(students_folder,student_id)
1077            # f2t = self.field2types_student
1078            study_course_obj = getattr(student_obj,'study_course',None)
1079            if study_course_obj is None:
1080                msg = 'student %s: no study_course object' % student_id
1081                break
1082            level_obj = getattr(study_course_obj,current_level,None)
1083            if  level_obj is None:
1084                msg = 'student %s: no study_level object for level %s' % (student_id,
1085                                                                                current_level)
1086                break
1087            verdict = d['verdict'] = d['current_verdict']  = mapping.get('current_verdict','')
1088
1089            #if verdict == student_record.verdict:
1090            #    msg = 'student %s: verdict already set to %s' % (student_id,
1091            #                                                            verdict)
1092
1093            level_review_state = wftool.getInfoFor(level_obj,'review_state',None)
1094            if level_review_state != "closed":
1095                wftool.doActionFor(level_obj,'close')
1096                # msg = 'student %s: level %s is not closed' % (student_id,
1097                #                                                      current_level)
1098
1099            study_course_obj.getContent().edit(mapping = d)
1100            level_obj.getContent().edit(mapping = d)
1101            if student_review_state != "returning":
1102                wftool.doActionFor(student_obj,'return')
1103            # try:
1104            #     wftool.doActionFor(level_obj,'close')
1105            # except:
1106            #     pass
1107            break
1108        return student_id,msg,mapping
1109    ###)
1110
Note: See TracBrowser for help on using the repository browser.