source: WAeUP_SRP/trunk/WAeUPTables.py @ 1709

Last change on this file since 1709 was 1707, checked in by joachim, 18 years ago

new import function for createStudents,
catalog fields added

  • Property svn:keywords set to Id
File size: 23.8 KB
RevLine 
[966]1#-*- mode: python; mode: fold -*-
[363]2# (C) Copyright 2005 AixtraWare <http://aixtraware.de>
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: WAeUPTables.py 1707 2007-04-25 11:58:39Z joachim $
20
21from zope.interface import implements
22from Globals import InitializeClass
23from Products.ZCatalog.ZCatalog import ZCatalog
[1620]24from Products.ZCatalog.ProgressHandler import ZLogHandler
[780]25from AccessControl import ClassSecurityInfo
26from Products.CMFCore.permissions import ModifyPortalContent
[1700]27import urllib
[1620]28import DateTime,time
[780]29import csv,re
30import logging
31import Globals
32p_home = Globals.package_home(globals())
33i_home = Globals.INSTANCE_HOME
[1702]34from Products.AdvancedQuery import Eq, Between, Le,In
[780]35
[363]36from interfaces import IWAeUPTable
37
38class AttributeHolder(object):
39    pass
40
41def dict2ob(dict):
42    ob = AttributeHolder()
43    for key, value in dict.items():
44        setattr(ob, key, value)
45    return ob
46
[834]47
[1146]48class WAeUPTable(ZCatalog): ###(
[834]49
[363]50    implements(IWAeUPTable)
[780]51    security = ClassSecurityInfo()
[834]52
[1620]53    def refreshCatalog(self, clear=0, pghandler=None):
54        """ don't refresh for a normal table """
55
56        if self.REQUEST and self.REQUEST.RESPONSE:
57            self.REQUEST.RESPONSE.redirect(
58              URL1 +
59              '/manage_catalogAdvanced?manage_tabs_message=Catalog%20refresh%20not%20implemented')
60
61    def manage_catalogClear(self, REQUEST=None, RESPONSE=None, URL1=None):
62        """ clears the whole enchilada """
63        #self._catalog.clear()
64
65        if REQUEST and RESPONSE:
66            RESPONSE.redirect(
67              URL1 +
68              '/manage_catalogAdvanced?manage_tabs_message=Catalog%20Clearing%20disabled')
69
[363]70    def addRecord(self, **data):
[502]71        # The uid is the same as "bed".
72        uid = data[self.key]
73        res = self.searchResults({"%s" % self.key : uid})
74        if len(res) > 0:
75            raise ValueError("More than one record with uid %s" % uid)
76        self.catalog_object(dict2ob(data), uid=uid)
77        return uid
[834]78
[363]79    def deleteRecord(self, uid):
80        self.uncatalog_object(uid)
[834]81
[502]82    def searchAndSetRecord(self, **data):
83        raise NotImplemented
84
85    def modifyRecord(self, **data):
86        #records = self.searchResults(uid=uid)
87        uid = data[self.key]
88        records = self.searchResults({"%s" % self.key : uid})
[363]89        if len(records) > 1:
90            # Can not happen, but anyway...
91            raise ValueError("More than one record with uid %s" % uid)
92        if len(records) == 0:
93            raise KeyError("No record for uid %s" % uid)
94        record = records[0]
95        record_data = {}
96        for field in self.schema() + self.indexes():
97            record_data[field] = getattr(record, field)
98        # Add the updated data:
99        record_data.update(data)
100        self.catalog_object(dict2ob(record_data), uid)
101
[1062]102    def reindexIndex(self, name, REQUEST,pghandler=None):
103        if isinstance(name, str):
104            name = (name,)
105        paths = self._catalog.uids.items()
106        i = 0
107        #import pdb;pdb.set_trace()
108        for p,rid in paths:
109            i += 1
110            metadata = self.getMetadataForRID(rid)
111            record_data = {}
112            for field in name:
113                record_data[field] = metadata.get(field)
114            uid = metadata.get(self.key)
115            self.catalog_object(dict2ob(record_data), uid, idxs=name,
116                                update_metadata=0)
[1082]117
[780]118    security.declareProtected(ModifyPortalContent,"exportAllRecords")
119    def exportAllRecords(self):
120        "export a WAeUPTable"
121        #import pdb;pdb.set_trace()
122        fields = [field for field in self.schema()]
123        format = ','.join(['"%%(%s)s"' % fn for fn in fields])
124        csv = []
125        csv.append(','.join(['"%s"' % fn for fn in fields]))
126        for uid in self._catalog.uids:
127            records = self.searchResults({"%s" % self.key : uid})
128            if len(records) > 1:
129                # Can not happen, but anyway...
130                raise ValueError("More than one record with uid %s" % uid)
131            if len(records) == 0:
132                raise KeyError("No record for uid %s" % uid)
133            rec = records[0]
134            csv.append(format % rec)
135        current = DateTime.DateTime().strftime("%d-%m-%y_%H_%M_%S")
136        open("%s/import/%s-%s.csv" % (i_home,self.getId(),current),"w+").write('\n'.join(csv))
[834]137
[1146]138###)
[834]139
[1146]140class AccommodationTable(WAeUPTable): ###(
[834]141
[404]142    meta_type = 'WAeUP Accommodation Tool'
[502]143    name = "accommodation"
144    key = "bed"
[363]145    def __init__(self):
[404]146        WAeUPTable.__init__(self, 'portal_accommodation')
[363]147
[635]148    def searchAndReserveBed(self, student_id,bed_type):
149        records = self.searchResults({'student' : student_id})
150        if len(records) > 0:
[1293]151            return -1,"Student with Id %s already booked bed %s." % (student_id,records[0].bed)
[834]152
[673]153        records = [r for r in self.searchResults({'bed_type' : bed_type}) if not r.student]
[686]154        #import pdb;pdb.set_trace()
[635]155        if len(records) == 0:
[1306]156            return -2,"No bed available"
[635]157        rec = records[0]
158        self.modifyRecord(bed=rec.bed,student=student_id)
[1571]159        s_logger = logging.getLogger('WAeUPTables.AccommodationTable.searchAndReserveBed')
160        s_logger.info('%s reserved bed %s' % (student_id,rec.bed))
[635]161        return 1,rec.bed
[363]162
[834]163
[404]164InitializeClass(AccommodationTable)
[411]165
[1146]166###)
167
168class PinTable(WAeUPTable): ###(
[1030]169    from ZODB.POSException import ConflictError
[440]170    meta_type = 'WAeUP Pin Tool'
[502]171    name = "pins"
172    key = 'pin'
[440]173    def __init__(self):
174        WAeUPTable.__init__(self, 'portal_pins')
[1082]175
176
[710]177    def searchAndSetRecord(self, uid, student_id,prefix):
[502]178        #records = self.searchResults(uid=uid)
[710]179        records = self.searchResults(student = student_id)
[990]180        #import pdb;pdb.set_trace()
[710]181        if len(records) > 0:
182            for r in records:
[834]183                if r.pin != uid and r.prefix_batch.startswith(prefix):
[710]184                    return -2
[502]185        records = self.searchResults({"%s" % self.key : uid})
186        if len(records) > 1:
187            # Can not happen, but anyway...
188            raise ValueError("More than one record with uid %s" % uid)
189        if len(records) == 0:
190            return -1
191        record = records[0]
192        if record.student == "":
193            record_data = {}
194            for field in self.schema() + self.indexes():
195                record_data[field] = getattr(record, field)
196            # Add the updated data:
[635]197            record_data['student'] = student_id
[1030]198            try:
199                self.catalog_object(dict2ob(record_data), uid)
200                return 1
201            except ConflictError:
202                return 2
[990]203        if record.student.upper() != student_id.upper():
[502]204            return 0
[997]205        if record.student.upper() == student_id.upper():
[502]206            return 2
[997]207        return -3
[440]208
209InitializeClass(PinTable)
210
[1146]211###)
[966]212
[1146]213class PumeResultsTable(WAeUPTable): ###(
214
[966]215    meta_type = 'WAeUP PumeResults Tool'
216    name = "pumeresults"
217    key = "jamb_reg_no"
218    def __init__(self):
219        WAeUPTable.__init__(self, 'portal_pumeresults')
220
221
222InitializeClass(PumeResultsTable)
223
[1146]224###)
[971]225
[1146]226class StudentsCatalog(WAeUPTable): ###(
[1620]227    security = ClassSecurityInfo()
[1146]228
[971]229    meta_type = 'WAeUP Students Catalog'
230    name = "students_catalog"
231    key = "id"
[1700]232    affected_types = {   ###(
[1707]233                      'StudentApplication':
234                          {'id': 'application',
235                           'fields':
[1700]236                             ('jamb_reg_no',
237                              'entry_mode',
[1707]238                              'entry_level',
[1700]239                              'entry_session',
[1707]240                              )
241                              },
[1700]242                      'StudentClearance':
[1707]243                          {'id': 'clearance',
244                           'fields':
[1700]245                             ('matric_no',
[1707]246                              )
247                              },
[1700]248                         'StudentPersonal':
[1707]249                          {'id': 'personal',
250                           'fields':
[1700]251                             ('name',
252                              'sex',
253                              'email',
254                              'phone',
[1707]255                              )
256                              },
[1700]257                         'StudentStudyCourse':
[1707]258                          {'id': 'study_course',
259                           'fields':
[1700]260                             ('course',
261                              'faculty',
262                              'department',
263                              'level',
[1705]264                              'mode',
[1700]265                              'session',
266                              'verdict',
[1707]267                              )
268                              },
[1700]269                         }
270    ###)
[1625]271
[971]272    def __init__(self):
273        WAeUPTable.__init__(self, 'students_catalog')
[1620]274        return
[1625]275
[1700]276    def manage_catalogClear(self, REQUEST=None, RESPONSE=None, URL1=None):
277        """ clears the whole enchilada """
278        self._catalog.clear()
[971]279
[1700]280        if REQUEST and RESPONSE:
281            RESPONSE.redirect(
282              URL1 +
283              '/manage_catalogAdvanced?manage_tabs_message=Catalog%20Cleared')
[971]284
[1700]285    def manage_catalogReindex(self, REQUEST, RESPONSE, URL1): ###(
286        """ clear the catalog, then re-index everything """
287
288        elapse = time.time()
289        c_elapse = time.clock()
290
291        pgthreshold = self._getProgressThreshold()
292        handler = (pgthreshold > 0) and ZLogHandler(pgthreshold) or None
293        self.refreshCatalog(clear=1, pghandler=handler)
294
295        elapse = time.time() - elapse
296        c_elapse = time.clock() - c_elapse
297
298        RESPONSE.redirect(
299            URL1 +
300            '/manage_catalogAdvanced?manage_tabs_message=' +
301            urllib.quote('Catalog Updated \n'
302                         'Total time: %s\n'
303                         'Total CPU time: %s' % (`elapse`, `c_elapse`)))
304    ###)
305
306    def get_from_doc_department(self,doc): ###(
[1620]307        "return the students department"
[1700]308        if doc is None:
[1620]309            return None
[1700]310        certificate_res = self.portal_catalog(id = doc.study_course)
[1620]311        if len(certificate_res) != 1:
312            return None
313        return certificate_res[0].getPath().split('/')[-3]
314
[1700]315    def get_from_doc_faculty(self,doc):
316        "return the students faculty"
317        if doc is None:
[1620]318            return None
[1700]319        certificate_res = self.portal_catalog(id = doc.study_course)
320        if len(certificate_res) != 1:
321            return None
322        return certificate_res[0].getPath().split('/')[-4]
[1620]323
[1700]324    def get_from_doc_level(self,doc):
325        "return the students level"
326        if doc is None:
[1620]327            return None
[1700]328        return getattr(doc,'current_level',None)
[1620]329
[1705]330    def get_from_doc_mode(self,doc):
331        "return the students mode"
[1700]332        if doc is None:
[1620]333            return None
[1705]334        cm = getattr(doc,'current_mode',None)
335        return cm
336       
[1625]337
[1705]338    def get_from_doc_session(self,doc):
339        "return the students current_session"
340        if doc is None:
341            return None
342        return getattr(doc,'current_session',None)
343
[1700]344    def get_from_doc_entry_session(self,doc):
345        "return the students entry_session"
346        if doc is None:
[1620]347            return None
[1705]348        es = getattr(doc,'entry_session',None)
349        if len(es) == 2:
350            return es
[1700]351        try:
352            digit = int(doc.jamb_reg_no[0])
353        except:
354            return "xx"
355        if digit < 8:
356            return "0%c" % doc.jamb_reg_no[0]
357        return "9%c" % doc.jamb_reg_no[0]
358
359    def get_from_doc_session(self,doc):
360        "return the students session"
361        if doc is None:
[1620]362            return None
[1700]363        return getattr(doc,'current_session',None)
[1620]364
[1700]365    def get_from_doc_course(self,doc):
[1620]366        "return the students study_course"
[1700]367        if doc is None:
[1620]368            return None
[1700]369        return getattr(doc,'study_course',None)
[1620]370
[1700]371    def get_from_doc_name(self,doc):
[1620]372        "return the students name from the personal"
[1700]373        if doc is None:
[1620]374            return None
375        return "%s %s %s" % (doc.firstname,doc.middlename,doc.lastname)
376
[1700]377    def get_from_doc_verdict(self,doc):
378        "return the students study_course"
379        if doc is None:
[1620]380            return None
[1700]381        return getattr(doc,'current_verdict',None)
[1702]382    ###)
[1620]383
[1702]384    def reindexIndex(self, name, REQUEST,pghandler=None): ###(
385        if isinstance(name, str):
386            name = (name,)
387        reindextypes = {}
388        reindex_special = []
389        #import pdb;pdb.set_trace()
390        for n in name:
391            if n in ("review_state","registered_courses"):
392                reindex_special.append(n)
393            else:
394                for pt in self.affected_types.keys():
[1707]395                    if n in self.affected_types[pt]['fields']:
[1702]396                        if reindextypes.has_key(pt):
397                            reindextypes[pt].append(n)
398                        else:
399                            reindextypes[pt]= [n]
400                        break
401        students = self.portal_catalog(portal_type="Student")
402        aq_portal = self.portal_catalog.evalAdvancedQuery
403        num_objects = len(students)
404        if pghandler:
405            pghandler.init('Refreshing catalog: %s' % self.absolute_url(1), num_objects)
406        noattr = set(('StudentClearance','StudentPersonal')) & set(reindextypes.keys())
407        for i in xrange(num_objects):
408            if pghandler: pghandler.report(i)
409            student_brain = students[i]
[1707]410            student_object = student_brain.getObject()
[1702]411            data = {}
412            modified = False
413            sid = data['id'] = student_brain.getId
414            if reindex_special and 'review_state' in reindex_special:
415                modified = True
416                data['review_state'] = student_brain.review_state
[1707]417            sub_objects = False
418            for pt in reindextypes.keys():
[1702]419                modified = True
[1707]420                try:
421                    doc = getattr(student_object,self.affected_types[pt]['id']).getContent()
422                    sub_objects = True
423                except:
424                    continue
425                for field in self.affected_types[pt]['fields']:
426                    if hasattr(self,'get_from_doc_%s' % field):
427                        data[field] = getattr(self,'get_from_doc_%s' % field)(doc)
428                    else:
429                        data[field] = getattr(doc,field)
430                #from pdb import set_trace;set_trace()
431            if not sub_objects and noattr:
432                import_res = self.returning_import(id = sid)
433                if not import_res:
434                    continue
435                import_record = import_res[0]
436                data['matric_no'] = import_record.matric_no
437                data['sex'] = import_record.Sex == 'F'
438                data['name'] = "%s %s %s" % (import_record.Firstname,
439                                             import_record.Middlename,
440                                             import_record.Lastname)
441                data['matric_no'] = import_record.Entryregno
[1702]442            if reindex_special and 'registered_courses' in reindex_special:
443                query = Eq('id','study_course') & Eq('path',student_brain.getPath())
444                brains = aq_portal(query)
445                while brains:
446                    study_course_path = brains[0].getPath()
447                    level_brains = self.portal_catalog(path = study_course_path,
448                                                       portal_type = "StudentStudyLevel")
449                    if not level_brains:
450                        break
451                    modified = True
452                    level_ids = [l.getId for l in level_brains]
453                    level_ids.sort()
454                    for l in level_brains:
455                        if l.getId == level_ids[-1]:
456                            level_path = l.getPath()
457                            break
458                    result_brains = self.portal_catalog(path = level_path,
459                                                        portal_type = "StudentCourseResult")
460                    course_ids = [cr.getId for cr in result_brains]
461                    courses = []
462                    for c in course_ids:
463                        if c.endswith('_co'):
464                            courses.append(c[:-3])
465                        else:
466                            courses.append(c)
467                    data['registered_courses'] = courses
468                    break
469            if modified:
470                self.modifyRecord(**data)
471        if pghandler: pghandler.finish()
472    ###)
[1620]473
474    def refreshCatalog(self, clear=0, pghandler=None): ###(
475        """ re-index everything we can find """
476        students_folder = self.portal_url.getPortalObject().campus.students
[1625]477
[1620]478        cat = self._catalog
479        paths = self._catalog.uids.items()
480        if clear:
481            paths = tuple(paths)
482            cat.clear()
[1700]483        students = self.portal_catalog(portal_type="Student")
484        num_objects = len(students)
[1620]485        if pghandler:
486            pghandler.init('Refreshing catalog: %s' % self.absolute_url(1), num_objects)
487        for i in xrange(num_objects):
488            if pghandler: pghandler.report(i)
[1700]489            student_brain = students[i]
490            spath = student_brain.getPath()
[1620]491            student_obj = student_brain.getObject()
492            data = {}
[1700]493            sid = data['id'] = student_brain.getId
494            data['review_state'] = student_brain.review_state
[1707]495            sub_objects = False
496            for pt in self.affected_types.keys():
497                modified = True
498                try:
499                    doc = getattr(student_object,self.affected_types[pt]['id']).getContent()
500                    sub_objects = True
501                except:
502                    continue
503                for field in self.affected_types[pt]['fields']:
504                    if hasattr(self,'get_from_doc_%s' % field):
505                        data[field] = getattr(self,'get_from_doc_%s' % field)(doc)
506                    else:
507                        data[field] = getattr(doc,field)
508                #from pdb import set_trace;set_trace()
509            if not sub_objects and noattr:
[1700]510                import_res = self.returning_import(id = sid)
511                if not import_res:
[1620]512                    continue
[1700]513                import_record = import_res[0]
514                data['matric_no'] = import_record.matric_no
515                data['sex'] = import_record.Sex == 'F'
516                data['name'] = "%s %s %s" % (import_record.Firstname,
517                                             import_record.Middlename,
518                                             import_record.Lastname)
519                data['matric_no'] = import_record.Entryregno
[1707]520##            sub_brains = self.portal_catalog(path = spath)
521##            if len(sub_brains) > 1:
522##                for sub_brain in sub_brains:
523##                    if not sub_brain.portal_type in self.affected_types.keys():
524##                        continue
525##                    doc = sub_brain.getObject().getContent()
526##                    for field in self.affected_types[sub_brain.portal_type]:
527##                        if hasattr(self,'get_from_doc_%s' % field):
528##                            data[field] = getattr(self,'get_from_doc_%s' % field)(doc)
529##                        else:
530##                            data[field] = getattr(doc,field)
531##            elif len(sub_brains) == 1:
532##                #import pdb;pdb.set_trace()
533##                import_res = self.returning_import(id = sid)
534##                if not import_res:
535##                    continue
536##                import_record = import_res[0]
537##                data['matric_no'] = import_record.matric_no
538##                data['sex'] = import_record.Sex == 'F'
539##                data['name'] = "%s %s %s" % (import_record.Firstname,
540##                                             import_record.Middlename,
541##                                             import_record.Lastname)
542##                data['matric_no'] = import_record.Entryregno
[1700]543            study_course = getattr(student_obj,'study_course',None)
544            current_level = data.get('level',None)
545            data['registered_courses'] = []
546            if study_course and current_level and current_level in study_course.objectIds():
547                level_obj = getattr(study_course,current_level)
548                courses = []
549                for c in level_obj.objectIds():
550                    if c.endswith('_co'):
551                        courses.append(c[:-3])
552                    else:
553                        courses.append(c)
554                data['registered_courses'] = courses
555            self.addRecord(**data)
[1620]556        if pghandler: pghandler.finish()
557    ###)
558
559
[1700]560    security.declarePrivate('notify_event_listener') ###(
[1620]561    def notify_event_listener(self,event_type,object,infos):
562        "listen for events"
[1702]563        pt = getattr(object,'portal_type',None)
564        mt = getattr(object,'meta_type',None)
[1620]565        students_catalog = self.students_catalog
[1702]566        data = {}
567        if pt == 'Student' and\
568           mt == 'CPS Proxy Folder' and\
569           event_type.startswith('workflow'):
570            data['id'] = object.getId()
571            data['review_state'] = self.portal_workflow.getInfoFor(object,'review_state',None)
572            #from pdb import set_trace;set_trace()
573            students_catalog.modifyRecord(**data)
574            return
[1700]575        if pt not in self.affected_types.keys():
576            return
[1620]577        if not infos.has_key('rpath'):
578            return
[1700]579        rpl = infos['rpath'].split('/')
580        if pt == 'Student' and event_type == "sys_add_object":
581            student_id = object.id
582            try:
583                self.addRecord(id = student_id)
584            except ValueError:
585                pass
586            return
587        elif pt == 'CourseResult' and mt == 'CPS Proxy Folder':
[1707]588            pass
[1700]589        if event_type not in ('sys_modify_object'):
[1707]590            #from pdb import set_trace;set_trace()
[1700]591            return
592        if mt == 'CPS Proxy Folder':
593            return
594        for field in self.affected_types[pt]:
595            if hasattr(self,'get_from_doc_%s' % field):
596                data[field] = getattr(self,'get_from_doc_%s' % field)(object)
597            else:
598                data[field] = getattr(object,field)
599        data['id'] = rpl[2]
600        students_catalog.modifyRecord(**data)
601    ###)
[1620]602
[1625]603
[971]604InitializeClass(StudentsCatalog)
605
[1146]606###)
607
608class CoursesCatalog(WAeUPTable): ###(
609
610    meta_type = 'WAeUP Courses Catalog'
611    name = "students_catalog"
612    key = "code"
613    def __init__(self):
614        WAeUPTable.__init__(self, 'courses_catalog')
615
616
617InitializeClass(CoursesCatalog)
[1151]618###)
[1146]619
[1625]620class OnlinePaymentsImport(WAeUPTable): ###(
[1620]621
622    meta_type = 'WAeUP Online Payment Transactions'
[1625]623    name = "online_payments_import"
[1620]624    key = "order_id"
625    def __init__(self):
626        WAeUPTable.__init__(self, self.name)
627
628
629InitializeClass(CoursesCatalog)
630###)
631
[1151]632class ReturningImport(WAeUPTable): ###(
[1146]633
[1151]634    meta_type = 'Returning Import Table'
635    name = "returning_import"
[1146]636    key = "matric_no"
637    def __init__(self):
[1151]638        WAeUPTable.__init__(self, 'returning_import')
[1146]639
640
[1151]641InitializeClass(ReturningImport)
642###)
[1146]643
644class ResultsImport(WAeUPTable): ###(
645
646    meta_type = 'Results Import Table'
647    name = "results_import"
648    key = "key"
649    def __init__(self):
650        WAeUPTable.__init__(self, 'results_import')
651
652
653InitializeClass(ResultsImport)
654
655###)
656
657class PaymentsCatalog(WAeUPTable): ###(
658
659    meta_type = 'WAeUP Payments Catalog'
660    name = "students_catalog"
661    key = "id"
662    def __init__(self):
663        WAeUPTable.__init__(self, 'payments_catalog')
664
665
666InitializeClass(PaymentsCatalog)
667
668###)
669
[414]670# BBB:
671AccomodationTable = AccommodationTable
Note: See TracBrowser for help on using the repository browser.