Changeset 9843

Timestamp:

8 Jan 2013, 11:38:14 (12 years ago)

Author:

Henrik Bettermann

Message:

Implement local student data exports in courses.

Location:

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

Files:

• browser/tests/test_browser.py (modified) (1 diff)
• browser/viewlets.py (modified) (2 diffs)
• catalog.py (modified) (1 diff)
• students/browser.py (modified) (2 diffs)
• students/browser_templates/exportconfig_certificate.pt (added)
• students/browser_templates/exportconfig_course.pt (added)
• students/catalog.py (modified) (1 diff)
• students/export.py (modified) (3 diffs)
• students/tests/test_browser.py (modified) (3 diffs)
• university/course.py (modified) (3 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/browser/tests/test_browser.py

@@ -316 +316 @@
         self.assertTrue(
             'zope.mgr - students.browser.DatacenterExportJobContainerJobConfig '
-            '- exported: students (None, None, None, None), job_id='
-            in logcontent)
+            '- exported: students (None, None, None, None, None), job_id=%s'
+            % job_id in logcontent)
         self.assertTrue(
             'zope.mgr - browser.pages.ExportCSVView '

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

@@ -471 +471 @@
     grok.view(CoursePage)
     text = _('Edit course')
+    grok.order(1)
     
 class ShowCourseStudentsActionButton(ManageActionButton):
@@ -481 +482 @@
     text = _('Show students')
     target = 'students'
+    grok.order(2)
+
+class ExportCourseStudentsActionButton(ManageActionButton):
+    """ 'Export student data' button for courses.
+    """
+    grok.context(ICourse)
+    grok.view(CoursePage)
+    grok.require('waeup.showStudents')
+    icon = 'actionicon_down.png'
+    text = _('Export student data')
+    target = 'exports'
+    grok.order(3)
 
 class ManageCertificateActionButton(ManageActionButton):

main/waeup.kofa/trunk/src/waeup/kofa/catalog.py

@@ -122 +122 @@
         query = dict()
         for idx_name, value in self._kw.items():
+            if idx_name == 'cat':
+                continue
             if not isinstance(value, tuple):
                 value = (value, value)

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

@@ -58 +58 @@
 from waeup.kofa.university.certificate import (
     VirtualCertificateExportJobContainer,)
+from waeup.kofa.university.course import (
+    VirtualCourseExportJobContainer,)
 from waeup.kofa.university.vocabularies import course_levels
 from waeup.kofa.utils.batching import VirtualExportJobContainer
@@ -2791 +2793 @@
     """
     grok.context(VirtualCertificateExportJobContainer)
+    grok.template('exportconfig_certificate')
 
     @property
     def certcode(self):
         return self.context.__parent__.code
+
+class CourseExportJobContainerJobConfig(ExportJobContainerJobConfig):
+    """Page that configures a students export job for courses.
+
+    In contrast to department or certificate student data exports the
+    coursetickets_catalog is searched here. Therefore the update
+    method from the base class is customized.
+    """
+    grok.context(VirtualCourseExportJobContainer)
+    grok.template('exportconfig_course')
+
+    def _set_exporter_values(self):
+        # We provide only the students exporter.
+        exporters = []
+        for name in ('students',):
+            util = getUtility(ICSVExporter, name=name)
+            exporters.append((util.title, name),)
+        self.exporters = exporters
+
+    def update(self, START=None, session=None, level=None, mode=None,
+               exporter=None):
+        self._set_session_values()
+        self._set_level_values()
+        self._set_mode_values()
+        self._set_exporter_values()
+        if START is None:
+            return
+        if session == 'all':
+            session=None
+        if level == 'all':
+            level = None
+        job_id = self.context.start_export_job(exporter,
+                                      self.request.principal.id,
+                                      # Use a different catalog and
+                                      # pass different keywords than
+                                      # for the (default) students_catalog
+                                      cat='coursetickets',
+                                      session=session,
+                                      level=level,
+                                      code=self.context.__parent__.code)
+        ob_class = self.__implemented__.__name__.replace('waeup.kofa.','')
+        self.context.logger.info(
+            '%s - exported: %s (%s, %s, %s), job_id=%s'
+            % (ob_class, exporter, session, level,
+            self.context.__parent__.code, job_id))
+        self.flash(_('Export started for course tickets with') +
+                   ' level_session=%s, level=%s' % (
+                   session, level))
+        self.redirect(self.url(self.redirect_target))
+        return

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

@@ -140 +140 @@
     cat_name = 'students_catalog'
     defaults = dict(student_id=None) # make sure we get all studs by default
+
+class CourseTicketsQuery(FilteredCatalogQueryBase):
+    """Query students in a site. See waeup.kofa.catalog for more info.
+    """
+    cat_name = 'coursetickets_catalog'
+    defaults = dict(code=None) # make sure we get all tickets by default

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

@@ -21 +21 @@
 from datetime import datetime
 from waeup.kofa.interfaces import MessageFactory as _
-from waeup.kofa.students.catalog import StudentsQuery
+from waeup.kofa.students.catalog import StudentsQuery, CourseTicketsQuery
 from waeup.kofa.students.interfaces import (
     IStudent, IStudentStudyCourse, IStudentStudyLevel, ICourseTicket,
@@ -96 +96 @@
 
     def get_filtered(self, site, **kw):
-        """Get students filtered by keywords.
-
-        The keys must be valid students catalog index names. Returns a
-        simple empty list or a catalog result set with `Student`
+        """Get students from a catalog filtered by keywords.
+
+        students_catalog is the default catalog. The keys must be valid
+        atalog index names.
+        Returns a simple empty list, a list with `Student`
+        objects or a catalog result set with `Student`
         objects.
 
@@ -105 +107 @@
 
         """
-        # Pass only given keywords to StudentsQuery. This way we avoid
+        # Pass only given keywords to create FilteredCatalogQuery objects.
+        # This way we avoid
         # trouble with `None` value ambivalences and queries are also
         # faster (normally less indexes to ask). Drawback is, that
         # developers must look into catalog to see what keywords are
         # valid.
+        if kw.get('cat', None) == 'coursetickets':
+            coursetickets = CourseTicketsQuery(**kw).query()
+            students = []
+            for ticket in coursetickets:
+                students.append(ticket.student)
+            return list(set(students))
         query = StudentsQuery(**kw)
         return query.query()

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

@@ -2798 +2798 @@
         self.browser.getControl(name="session").value = ['2004']
         self.browser.getControl(name="level").value = ['100']
-        self.browser.getControl(name="mode").value = ['ug_ft']
         self.browser.getControl("Create CSV file").click()
 
@@ -2823 +2822 @@
         self.assertTrue(
             'zope.mgr - students.browser.CertificateExportJobContainerJobConfig '
-            '- exported: students (2004, 100, ug_ft, None, CERT1), job_id=%s'
+            '- exported: students (2004, 100, None, None, CERT1), job_id=%s'
             % job_id in logcontent
             )
@@ -2835 +2834 @@
             '- discarded: job_id=%s' % job_id in logcontent
             )
+
+    def test_course_export(self):
+        self.browser.addHeader('Authorization', 'Basic mgr:mgrpw')
+        course1_path = 'http://localhost/app/faculties/fac1/dep1/courses/COURSE1'
+        self.browser.open(course1_path)
+        self.browser.getLink("Export student data").click()
+        self.browser.getControl("Configure new export").click()
+        self.browser.getControl(name="exporter").value = ['students']
+        self.browser.getControl(name="session").value = ['2004']
+        self.browser.getControl(name="level").value = ['100']
+        self.browser.getControl("Create CSV file").click()
+
+        # When the job is finished and we reload the page...
+        job_id = self.wait_for_export_job_completed()
+        self.browser.open(course1_path + '/exports')
+        # ... the csv file can be downloaded ...
+        self.browser.getLink("Download").click()
+        self.assertEqual(self.browser.headers['content-type'],
+            'text/csv; charset=UTF-8')
+        self.assertTrue(
+            'filename="WAeUP.Kofa_students_%s.csv' % job_id in
+            self.browser.headers['content-disposition'])
+        self.assertEqual(len(self.app['datacenter'].running_exports), 1)
+        job_id = self.app['datacenter'].running_exports[0][0]
+        # ... and discarded
+        self.browser.open(course1_path + '/exports')
+        self.browser.getControl("Discard").click()
+        self.assertEqual(len(self.app['datacenter'].running_exports), 0)
+        # Creation, downloading and discarding is logged
+        logfile = os.path.join(
+            self.app['datacenter'].storage, 'logs', 'datacenter.log')
+        logcontent = open(logfile).read()
+        self.assertTrue(
+            'zope.mgr - students.browser.CourseExportJobContainerJobConfig '
+            '- exported: students (2004, 100, COURSE1), job_id=%s'
+            % job_id in logcontent
+            )
+        self.assertTrue(
+            'zope.mgr - students.browser.ExportJobContainerDownload '
+            '- downloaded: WAeUP.Kofa_students_%s.csv, job_id=%s'
+            % (job_id, job_id) in logcontent
+            )
+        self.assertTrue(
+            'zope.mgr - students.browser.ExportJobContainerOverview '
+            '- discarded: job_id=%s' % job_id in logcontent
+            )

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

@@ -19 +19 @@
 """
 import grok
+import zope.location.location
 from zope.catalog.interfaces import ICatalog
 from zope.interface import implementedBy
@@ -27 +28 @@
 from waeup.kofa.interfaces import IKofaPluggable
 from waeup.kofa.university.interfaces import ICourse, ICourseAdd
+from waeup.kofa.utils.batching import VirtualExportJobContainer
+
+class VirtualCourseExportJobContainer(VirtualExportJobContainer):
+    """A virtual export job container for courses.
+    """
 
 class Course(grok.Model):
@@ -50 +56 @@
         self.semester = semester
         self.former_course = former_course
+
+    def traverse(self, name):
+        """Deliver appropriate containers.
+        """
+        if name == 'exports':
+            # create a virtual exports container and return it
+            container = VirtualCourseExportJobContainer()
+            zope.location.location.located(container, self, 'exports')
+            return container
+        return None
 
     def longtitle(self):