Changeset 8735

Timestamp:

17 Jun 2012, 06:42:20 (12 years ago)

Author:

Henrik Bettermann

Message:

Let's use the msave helper function also in university and other packages. msave applies applyData to the view and writes a view-specific log message. The context object of the view must have a writeLogMessage method.

In the students package writeLogMessage is now provided by all classes which implement IStudentNavigation.

Location:

main/waeup.kofa/trunk/src/waeup/kofa

Files:

• students/accommodation.py (modified) (2 diffs)
• students/browser.py (modified) (6 diffs)
• students/interfaces.py (modified) (3 diffs)
• students/payments.py (modified) (2 diffs)
• students/student.py (modified) (2 diffs)
• students/studycourse.py (modified) (1 diff)
• students/studylevel.py (modified) (2 diffs)
• students/tests/test_student.py (modified) (2 diffs)
• students/viewlets.py (modified) (3 diffs)
• university/certificate.py (modified) (1 diff)
• utils/helpers.py (modified) (2 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/students/accommodation.py

@@ -51 +51 @@
         return self.__parent__
 
+    def writeLogMessage(self, view, message):
+        return self.__parent__.writeLogMessage(view, message)
+
 StudentAccommodation = attrs_to_fields(StudentAccommodation)
 
@@ -68 +71 @@
     def getStudent(self):
         return self.__parent__.__parent__
+
+    def writeLogMessage(self, view, message):
+        return self.__parent__.__parent__.writeLogMessage(view, message)
 
     def getSessionString(self):

main/waeup.kofa/trunk/src/waeup/kofa/students/browser.py

@@ -62 +62 @@
 from waeup.kofa.browser.resources import toggleall
 from waeup.kofa.hostels.hostel import NOT_OCCUPIED
-from waeup.kofa.utils.helpers import get_current_principal, to_timezone
-
-def write_log_message(view, message):
-    ob_class = view.__implemented__.__name__.replace('waeup.kofa.','')
-    view.context.getStudent().loggerInfo(ob_class, message)
-    return
-
-# Save function used for save methods in pages
-def msave(view, **data):
-    changed_fields = view.applyData(view.context, **data)
-    # Turn list of lists into single list
-    if changed_fields:
-        changed_fields = reduce(lambda x,y: x+y, changed_fields.values())
-    # Inform catalog if certificate has changed
-    # (applyData does this only for the context)
-    if 'certificate' in changed_fields:
-        notify(grok.ObjectModifiedEvent(view.context.getStudent()))
-    fields_string = ' + '.join(changed_fields)
-    view.flash(_('Form has been saved.'))
-    if fields_string:
-        write_log_message(view, 'saved: %s' % fields_string)
-    return
+from waeup.kofa.utils.helpers import get_current_principal, to_timezone, msave
 
 def emit_lock_message(view):
@@ -394 +373 @@
         self.flash(_('Form has been saved.'))
         if fields_string:
-            write_log_message(self, 'saved: % s' % fields_string)
+            self.context.writeLogMessage(self, 'saved: % s' % fields_string)
         return
 
@@ -1030 +1009 @@
             self.flash(_('Successfully removed: ${a}',
                 mapping = {'a': ', '.join(deleted)}))
-            write_log_message(self,'removed: % s' % ', '.join(deleted))
+            self.context.writeLogMessage(
+                self,'removed: % s' % ', '.join(deleted))
         self.redirect(self.url(self.context))
         return
@@ -1101 +1081 @@
         success, msg, log = self.context.approveStudentPayment()
         if log is not None:
-            write_log_message(self,log)
+            self.context.writeLogMessage(self,log)
         self.flash(msg)
         return
@@ -1202 +1182 @@
             self.flash(_('Successfully removed: ${a}',
                 mapping = {'a':', '.join(deleted)}))
-            write_log_message(self,'removed: % s' % ', '.join(deleted))
+            self.context.writeLogMessage(
+                self,'removed: % s' % ', '.join(deleted))
         self.redirect(self.url(self.context))
         return
@@ -1498 +1479 @@
             if not errors:
                 IUserAccount(self.context).setPassword(password)
-                write_log_message(self, 'saved: password')
+                self.context.writeLogMessage(self, 'saved: password')
                 self.flash(_('Password changed.'))
             else:

main/waeup.kofa/trunk/src/waeup/kofa/students/interfaces.py

@@ -129 +129 @@
 
 class IStudentNavigation(IKofaObject):
-    """Interface needed for student navigation.
+    """Interface needed for student navigation, logging, etc.
 
     """
     def getStudent():
         """Return student object.
+
+        """
+
+    def writeLogMessage(view, message):
+        """Write a view specific log message into students.log.
 
         """
@@ -152 +157 @@
     display_fullname = Attribute('The fullname of an applicant')
 
-    def loggerInfo(ob_class, comment):
-        """Adds an INFO message to the log file.
-
-        """
-
     student_id = schema.TextLine(
         title = _(u'Student Id'),
@@ -383 +383 @@
     def addCourseTicket(courseticket):
         """Add a course ticket object.
-        """
-
-    def getStudent():
-        """Return student
         """
 

main/waeup.kofa/trunk/src/waeup/kofa/students/payments.py

@@ -43 +43 @@
         return self.__parent__
 
+    def writeLogMessage(self, view, message):
+        return self.__parent__.writeLogMessage(view, message)
+
 StudentPaymentsContainer = attrs_to_fields(StudentPaymentsContainer)
 
@@ -60 +63 @@
         except AttributeError:
             return None
+
+    def writeLogMessage(self, view, message):
+        return self.__parent__.__parent__.writeLogMessage(view, message)
 
     def _createActivationCodes(self):

main/waeup.kofa/trunk/src/waeup/kofa/students/student.py

@@ -61 +61 @@
         return
 
-    def loggerInfo(self, ob_class, comment=None):
-        target = self.__name__
-        return grok.getSite()['students'].logger_info(ob_class,target,comment)
+    def writeLogMessage(self, view, message):
+        ob_class = view.__implemented__.__name__.replace('waeup.kofa.','')
+        return self.__parent__.logger_info(ob_class,self.__name__,comment=None)
 
     @property
@@ -139 +139 @@
             self.get('studycourse', None), 'is_postgrad', False)
         return is_postgrad
+
 
 # Set all attributes of Student required in IStudent as field

main/waeup.kofa/trunk/src/waeup/kofa/students/studycourse.py

@@ -42 +42 @@
     def getStudent(self):
         return self.__parent__
+
+    def writeLogMessage(self, view, message):
+        return self.__parent__.writeLogMessage(view, message)
 
     @property

main/waeup.kofa/trunk/src/waeup/kofa/students/studylevel.py

@@ -43 +43 @@
     def getStudent(self):
         return getattr(getattr(self, '__parent__', None), '__parent__', None)
+
+    def writeLogMessage(self, view, message):
+        return self.__parent__.__parent__.writeLogMessage(view, message)
 
     @property
@@ -107 +110 @@
             return None
 
+    def writeLogMessage(self, view, message):
+        return self.__parent__.__parent__.__parent__.writeLogMessage(view, message)
+
     def getLevel(self):
         """Returns the id of the level the ticket has been added to.

main/waeup.kofa/trunk/src/waeup/kofa/students/tests/test_student.py

@@ -36 +36 @@
 from waeup.kofa.students.interfaces import (
     IStudent, IStudentStudyCourse, IStudentPaymentsContainer,
-    IStudentAccommodation, IStudentStudyLevel, ICourseTicket, IBedTicket)
+    IStudentAccommodation, IStudentStudyLevel, ICourseTicket, IBedTicket,
+    IStudentNavigation)
 from waeup.kofa.students.tests.test_batching import StudentImportExportSetup
 from waeup.kofa.testing import FunctionalLayer, FunctionalTestCase
@@ -86 +87 @@
     def test_interfaces(self):
         verify.verifyClass(IStudent, Student)
+        verify.verifyClass(IStudentNavigation, Student)
         verify.verifyObject(IStudent, self.student)
+        verify.verifyObject(IStudentNavigation, self.student)
+
         verify.verifyClass(IStudentStudyCourse, StudentStudyCourse)
+        verify.verifyClass(IStudentNavigation, StudentStudyCourse)
         verify.verifyObject(IStudentStudyCourse, self.studycourse)
+        verify.verifyObject(IStudentNavigation, self.studycourse)
+
+        verify.verifyClass(IStudentStudyLevel, StudentStudyLevel)
+        verify.verifyClass(IStudentNavigation, StudentStudyLevel)
         verify.verifyObject(IStudentStudyLevel, self.studylevel)
+        verify.verifyObject(IStudentNavigation, self.studylevel)
+
+        verify.verifyClass(ICourseTicket, CourseTicket)
+        verify.verifyClass(IStudentNavigation, CourseTicket)
         verify.verifyObject(ICourseTicket, self.courseticket)
+        verify.verifyObject(IStudentNavigation, self.courseticket)
+
         verify.verifyClass(IStudentPaymentsContainer, StudentPaymentsContainer)
+        verify.verifyClass(IStudentNavigation, StudentPaymentsContainer)
         verify.verifyObject(IStudentPaymentsContainer, self.payments)
+        verify.verifyObject(IStudentNavigation, self.payments)
+
         verify.verifyClass(IStudentAccommodation, StudentAccommodation)
+        verify.verifyClass(IStudentNavigation, StudentAccommodation)
         verify.verifyObject(IStudentAccommodation, self.accommodation)
+        verify.verifyObject(IStudentNavigation, self.accommodation)
+
         verify.verifyClass(IBedTicket, BedTicket)
+        verify.verifyClass(IStudentNavigation, BedTicket)
         verify.verifyObject(IBedTicket, self.bedticket)
+        verify.verifyObject(IStudentNavigation, self.bedticket)
         return
 

main/waeup.kofa/trunk/src/waeup/kofa/students/viewlets.py

@@ -35 +35 @@
     VALIDATED)
 from waeup.kofa.students.browser import (
-    StudentClearanceManageFormPage, write_log_message,
+    StudentClearanceManageFormPage,
     StudentBaseManageFormPage, StudentFilesUploadPage,
     ExportPDFClearanceSlipPage, StudentsContainerPage,
@@ -568 +568 @@
     store = getUtility(IExtFileStore)
     store.deleteFileByContext(context, attr=download_name)
-    write_log_message(view, 'deleted: %s' % download_name)
+    context.writeLogMessage(view, 'deleted: %s' % download_name)
     view.flash(_('${a} deleted.', mapping = {'a':download_name}))
     return
@@ -607 +607 @@
     file_id = IFileStoreNameChooser(context).chooseName(attr=download_name)
     store.createFile(file_id, upload)
-    write_log_message(view, 'uploaded: %s (%s)' % (
+    context.writeLogMessage(view, 'uploaded: %s (%s)' % (
         download_name,upload.filename))
     view.flash(_('File ${a} uploaded.', mapping = {'a':download_name}))

main/waeup.kofa/trunk/src/waeup/kofa/university/certificate.py

@@ -151 +151 @@
         studycourse.certificate = None
         notify(grok.ObjectModifiedEvent(student))
-        student.loggerInfo('ObjectRemovedEvent', 'removed: certificate')
+        student.__parent__.logger_info(
+            'ObjectRemovedEvent',student.__name__,'removed: certificate')
     return
 

main/waeup.kofa/trunk/src/waeup/kofa/utils/helpers.py

@@ -38 +38 @@
 from zope.security.management import getInteraction
 from zope.pluggableauth.interfaces import IAuthenticatorPlugin
+from waeup.kofa.interfaces import MessageFactory as _
 
 BUFSIZE = 8 * 1024
@@ -682 +683 @@
         writer.writerow(row)
     return tmp_path
+
+# Save function used for save methods in pages
+def msave(view, **data):
+    changed_fields = view.applyData(view.context, **data)
+    # Turn list of lists into single list
+    if changed_fields:
+        changed_fields = reduce(lambda x,y: x+y, changed_fields.values())
+    # Inform catalog if certificate has changed
+    # (applyData does this only for the context)
+    if 'certificate' in changed_fields:
+        notify(grok.ObjectModifiedEvent(view.context.getStudent()))
+    fields_string = ' + '.join(changed_fields)
+    view.flash(_('Form has been saved.'))
+    if fields_string:
+        view.context.writeLogMessage(view, 'saved: %s' % fields_string)
+    return