Changeset 9265

Timestamp:

1 Oct 2012, 21:18:48 (12 years ago)

Author:

Henrik Bettermann

Message:

Add AccessCodeProcessor?.

Location:

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

Files:

• accesscodes/accesscode.py (modified) (4 diffs)
• accesscodes/batching.py (modified) (2 diffs)
• accesscodes/browser.py (modified) (1 diff)
• accesscodes/interfaces.py (modified) (2 diffs)
• accesscodes/tests/sample_ac_data.csv (added)
• accesscodes/tests/test_batching.py (modified) (5 diffs)
• browser/batchprocessing.txt (modified) (1 diff)
• utils/batching.py (modified) (1 diff)

main/waeup.kofa/trunk/src/waeup/kofa/accesscodes/accesscode.py

@@ -81 +81 @@
     grok.implements(IAccessCode)
 
-    def __init__(self, batch_serial, random_num):
+    def __init__(self, batch_serial=None, random_num=None):
         super(AccessCode, self).__init__()
         self.batch_serial = batch_serial
@@ -154 +154 @@
 
     def __init__(self, creation_date=None, creator=None, batch_prefix=None,
-                 cost=None, entry_num=None, num=None):
+                 cost=None, entry_num=0, num=None):
         super(AccessCodeBatch, self).__init__()
         self.creation_date = creation_date
@@ -317 +317 @@
 
     def addBatchByImport(self, batch, batch_id):
-        """Add an already created `batch` by import
-        with defined id.
-        """
+        """Add an already created `batch` by import with defined id.
+
+        We want to create a batch without access codes. Since num_entry
+        access codes are automatically added by handle_batch_added when
+        the batch is added to the ZODB, we have to temporarily set entry_num
+        to zero when adding the batch persistently.
+        """
+        orig_entry_num = batch.entry_num
+        batch.entry_num = 0
         self[batch_id] = batch
+        self._p_changed = True
+        batch.entry_num = orig_entry_num
         return
 
@@ -480 +488 @@
 
     def __call__(self, *args, **kw):
-        return AccessCodeBatch(*args, **kw)
+        return AccessCodeBatch()
 
     def getInterfaces(self):
         return implementedBy(AccessCodeBatch)
+
+class AccessCodeFactory(grok.GlobalUtility):
+    """A factory for accesscodes.
+
+    We need this factory for the accesscodeprocessor.
+    """
+    grok.implements(IFactory)
+    grok.name(u'waeup.AccessCode')
+    title = u"Create a new accesscode.",
+    description = u"This factory instantiates new accesscode instances."
+
+    def __call__(self, *args, **kw):
+        return AccessCode(*args, **kw)
+
+    def getInterfaces(self):
+        return implementedBy(AccessCode)
 
 def get_access_code(access_code):

main/waeup.kofa/trunk/src/waeup/kofa/accesscodes/batching.py

@@ -20 +20 @@
 """
 import grok
+from hurry.workflow.interfaces import IWorkflowState
 from zope.interface import Interface
-from waeup.kofa.interfaces import IBatchProcessor, IGNORE_MARKER
+from waeup.kofa.interfaces import IBatchProcessor, IGNORE_MARKER, IObjectHistory
 from waeup.kofa.utils.batching import BatchProcessor
-from waeup.kofa.accesscodes.interfaces import IAccessCodeBatch
+from waeup.kofa.accesscodes.interfaces import IAccessCodeBatch, IAccessCode
 
 class AccessCodeBatchProcessor(BatchProcessor):
@@ -67 +68 @@
         Returns a string describing the fields changed.
         """
-        changed = []
-        for key, value in row.items():
-            # Skip fields to be ignored.
-            if value == IGNORE_MARKER:
-                continue
-            if not hasattr(obj, key):
-                continue
-            try:
-                evalvalue = eval(value)
-                if isinstance(evalvalue, list):
-                    value = eval(value)
-            except:
-                pass
-            setattr(obj, key, value)
-            log_value = getattr(value, 'code', value)
-            changed.append('%s=%s' % (key, log_value))
-
+        items_changed = super(AccessCodeBatchProcessor, self).updateEntry(
+            obj, row, site)
         # Log actions...
         location_field = self.location_fields[0]
-        items_changed = ', '.join(changed)
         grok.getSite()['accesscodes'].logger.info('%s - %s - Batch updated: %s'
             % (self.name, row[location_field], items_changed))
         return
+
+class AccessCodeProcessor(BatchProcessor):
+    """A batch processor for IAccessCode objects.
+    """
+    grok.implements(IBatchProcessor)
+    grok.provides(IBatchProcessor)
+    grok.context(Interface)
+    util_name = 'accesscodeprocessor'
+    grok.name(util_name)
+
+    name = u'AccessCode Processor'
+    iface = IAccessCode
+
+    location_fields = ['representation', 'batch_prefix', 'batch_num']
+    factory_name = 'waeup.AccessCode'
+
+    mode = None
+
+    @property
+    def available_fields(self):
+        return sorted(list(set(
+                    self.location_fields + [
+                        'random_num', 'owner', 'cost',
+                        'state', 'batch_serial',
+                        'history',]
+                    )))
+
+    @property
+    def required_fields(self):
+        return ['random_num', 'state', 'batch_serial', 'history',]
+
+    def parentsExist(self, row, site):
+        return self.getParent(row,site) is not None
+
+    def entryExists(self, row, site):
+        parent = self.getParent(row, site)
+        if parent is None:
+            return False
+        return row['representation'] in parent.keys()
+
+    def getParent(self, row, site):
+        if not 'accesscodes' in site.keys():
+            return None
+        batch_id = '%s-%s' % (row['batch_prefix'], row['batch_num'])
+        return site['accesscodes'].get(batch_id, None)
+
+    def getEntry(self, row, site):
+        if not self.entryExists(row, site):
+            return None
+        parent = self.getParent(row, site)
+        return parent.get(row['representation'], None)
+
+    def addEntry(self, obj, row, site):
+        parent = self.getParent(row, site)
+        obj.batch_serial = row['batch_serial']
+        obj.random_num = row['random_num']
+        parent[row['representation']] = obj
+        return
+
+    def updateEntry(self, obj, row, site):
+        """Update obj to the values given in row.
+
+        Returns a string describing the fields changed.
+        """
+        items_changed = ''
+        # Update state
+        if row.has_key('state'):
+            state = row.get('state', IGNORE_MARKER)
+            if state not in (IGNORE_MARKER, ''):
+                value = row['state']
+                IWorkflowState(obj).setState(value)
+                items_changed += ('%s=%s, ' % ('state', state))
+            row.pop('state')
+        # Update history
+        if row.has_key('history'):
+            history = row.get('history', IGNORE_MARKER)
+            if history not in (IGNORE_MARKER, ''):
+                values = row['history'].split('||')
+                for value in values:
+                    IObjectHistory(obj).addMessage(value)
+                items_changed += ('%s=%s, ' % ('history', history))
+            row.pop('history')
+
+        # In import files we can use the hash symbol at the end of a
+        # random_num string to avoid annoying automatic number transformation
+        # by Excel or Calc
+        row['random_num'] = row['random_num'].strip('#')
+
+        items_changed += super(AccessCodeProcessor, self).updateEntry(
+            obj, row, site)
+
+        # Log actions...
+        grok.getSite()['accesscodes'].logger.info('%s - %s - AC updated: %s'
+            % (self.name, row['representation'], items_changed))
+        return

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

@@ -67 +67 @@
                 continue
             del self.context[name]
+            self.context._p_changed = True
             self.flash(_('Deleted batch ${a}', mapping = {'a':name}))
             message = 'deleted: %s' % name

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

@@ -49 +49 @@
     owner = schema.TextLine(
         title = _(u'Purchaser'),
+        required = False,
         )
     history = schema.Text(
@@ -54 +55 @@
         default = u'',
         readonly = True,
+        required = False,
        )
 

main/waeup.kofa/trunk/src/waeup/kofa/accesscodes/tests/test_batching.py

@@ -36 +36 @@
 from waeup.kofa.testing import (
     FunctionalLayer, FunctionalTestCase, setUp, tearDown, getRootFolder)
-from waeup.kofa.accesscodes.batching import AccessCodeBatchProcessor
+from waeup.kofa.accesscodes.batching import (
+    AccessCodeBatchProcessor, AccessCodeProcessor)
 
 
@@ -44 +45 @@
 
 BATCH_HEADER_FIELDS = BATCH_SAMPLE_DATA.split(
+    '\n')[0].split(',')
+
+AC_SAMPLE_DATA = open(
+    os.path.join(os.path.dirname(__file__), 'sample_ac_data.csv'),
+    'rb').read()
+
+AC_HEADER_FIELDS = AC_SAMPLE_DATA.split(
     '\n')[0].split(',')
 
@@ -73 +81 @@
         self.logfile = os.path.join(
             self.app['datacenter'].storage, 'logs', 'accesscodes.log')
+        self.workdir = tempfile.mkdtemp()
 
     def tearDown(self):
@@ -85 +94 @@
     def test_import(self):
         self.processor = AccessCodeBatchProcessor()
-        self.workdir = tempfile.mkdtemp()
         self.csv_file = os.path.join(self.workdir, 'sample_batch_data.csv')
         open(self.csv_file, 'wb').write(BATCH_SAMPLE_DATA)
@@ -102 +110 @@
         shutil.rmtree(os.path.dirname(fin_file))
         return
+
+class ACProcessorTest(ACFullSetup):
+
+    layer = FunctionalLayer
+
+    def test_import(self):
+        self.processor = AccessCodeBatchProcessor()
+        self.csv_file = os.path.join(self.workdir, 'sample_batch_data.csv')
+        open(self.csv_file, 'wb').write(BATCH_SAMPLE_DATA)
+        self.processor.doImport(self.csv_file, BATCH_HEADER_FIELDS)
+
+        self.processor = AccessCodeProcessor()
+        self.csv_file = os.path.join(self.workdir, 'sample_ac_data.csv')
+        open(self.csv_file, 'wb').write(AC_SAMPLE_DATA)
+        num, num_warns, fin_file, fail_file =  self.processor.doImport(
+            self.csv_file, AC_HEADER_FIELDS)
+        self.assertEqual(num_warns,0)
+        self.assertEqual(
+            self.app['accesscodes']['CLR-1']['CLR-1-1625368961'].batch_serial, 33)
+        self.assertEqual(
+            self.app['accesscodes']['CLR-1']['CLR-1-1625368961'].random_num, '1625368961')
+        self.assertEqual(
+            self.app['accesscodes']['CLR-1']['CLR-1-1625368961'].state, 'used')
+        logcontent = open(self.logfile).read()
+        self.assertTrue(
+            'INFO - system - AccessCode Processor - CLR-1-1625368961 - '
+            'AC updated: state=used, history=2012-07-11 14:51:56 UTC - '
+            'initialized by Manager||2012-07-11 14:55:42 UTC - '
+            'invalidated by Manager, batch_serial=33, '
+            'random_num=1625368961, cost=100.0, owner=K1000009'
+            in logcontent)
+        shutil.rmtree(os.path.dirname(fin_file))
+        return

main/waeup.kofa/trunk/src/waeup/kofa/browser/batchprocessing.txt

@@ -93 +93 @@
     >>> importerselect = browser.getControl(name='importer')
     >>> importerselect.displayOptions
-    ['Applicant Processor', 'Applicants Container Processor',
+    ['AccessCodeBatch Processor', 'AccessCode Processor',
+    'Applicant Processor', 'Applicants Container Processor',
     'CertificateCourse Processor', 'Certificate Processor',
     'Course Processor', 'CourseTicket Processor',

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

@@ -220 +220 @@
             if not hasattr(obj, key):
                 continue
-            setattr(obj, key, value)
+            try:
+                setattr(obj, key, value)
+            except AttributeError:
+                # Computed attributes can't be set.
+                continue
             log_value = getattr(value, 'code', value)
             changed.append('%s=%s' % (key, log_value))