Changeset 8371 for main/waeup.kofa/trunk/src/waeup/kofa/students/export.py

Timestamp:

6 May 2012, 14:33:14 (12 years ago)

Author:

uli

Message:

Add payments exporter.

File:

• main/waeup.kofa/trunk/src/waeup/kofa/students/export.py (modified) (2 diffs)

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

@@ -24 +24 @@
 from waeup.kofa.interfaces import MessageFactory as _
 from waeup.kofa.students.interfaces import (
-    IStudent, IStudentStudyCourse, IStudentStudyLevel, ICourseTicket)
+    IStudent, IStudentStudyCourse, IStudentStudyLevel, ICourseTicket,
+    IStudentOnlinePayment)
 from waeup.kofa.utils.batching import ExporterBase
 from waeup.kofa.utils.helpers import iface_names
@@ -248 +249 @@
         return self.export(tickets, filepath)
 
+class PaymentsExporter(grok.GlobalUtility, ExporterBase):
+    """Exporter for OnlinePayment instances.
+    """
+    grok.implements(ICSVExporter)
+    grok.name('studentpayments')
+
+    #: Fieldnames considered by this exporter
+    fields = tuple(
+        sorted(['reg_number', 'matric_number'] +
+               iface_names(IStudentOnlinePayment, exclude_attribs=False)))
+
+    #: The title under which this exporter will be displayed
+    title = _(u'Course Tickets')
+
+    def mangle_value(self, value, name, context=None):
+        """Treat location values special.
+        """
+        if context is not None:
+            student = context.getStudent()
+            if name in ['reg_number', 'matric_number'] and student is not None:
+                value = getattr(student, name, None)
+        return super(
+            PaymentsExporter, self).mangle_value(
+            value, name, context=context)
+
+    def export(self, payments, filepath=None):
+        """Export `payments`, an iterable, as CSV file.
+
+        If `filepath` is ``None``, a raw string with CSV data is returned.
+        """
+        writer, outfile = self.get_csv_writer(filepath)
+        for payment in payments:
+            self.write_item(payment, writer)
+        return self.close_outfile(filepath, outfile)
+
+    def export_all(self, site, filepath=None):
+        """Export payments into filepath as CSV data.
+
+        If `filepath` is ``None``, a raw string with CSV data is returned.
+        """
+        catalog = queryUtility(
+            ICatalog, context=site, name='students_catalog', default=None)
+        if catalog is None:
+            return self.export([], filepath)
+        students = catalog.searchResults(
+            student_id=(None, None))
+        payments = []
+        for student in students:
+            if not 'payments' in student.keys():
+                continue
+            for payment in student['payments'].values():
+                payments.append(payment)
+        return self.export(payments, filepath)