Changeset 8787 for main

Timestamp:

25 Jun 2012, 11:22:19 (13 years ago)

Author:

Henrik Bettermann

Message:

Add UsersExporter?.

Location:

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

Files:

• userscontainer.py (modified) (2 diffs)
• userscontainer.txt (modified) (1 diff)

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

@@ -23 +23 @@
 from waeup.kofa.interfaces import IUsersContainer
 from waeup.kofa.utils.logger import Logger
+from waeup.kofa.utils.batching import ExporterBase
+from waeup.kofa.interfaces import ICSVExporter
+from waeup.kofa.interfaces import MessageFactory as _
+
 
 class UsersContainer(grok.Container, Logger):
@@ -60 +64 @@
             del self[name]
             #self.logger.info('User account %s deleted.' % name)
+
+
+class UsersExporter(grok.GlobalUtility, ExporterBase):
+    """Exporter for faculties.
+    """
+    grok.implements(ICSVExporter)
+    grok.name('users')
+
+    #: Fieldnames considered by this exporter
+    fields = ('name', 'title', 'public_name', 'description',
+              'email', 'phone', 'roles', 'local_roles', 'password')
+
+    #: The title under which this exporter will be displayed
+    title = _(u'Users')
+
+    def mangle_value(self, value, name, context=None):
+        """Treat location values special.
+        """
+        
+        if name == 'local_roles' and context is not None:
+            local_roles = context.getLocalRoles()
+            value = {}
+            for role in local_roles.keys():
+                objects = local_roles[role]
+                object_list = []
+                for object in objects:
+                    object.__class__.__name__
+                    object_list.append((object.__name__, object.__class__.__name__))
+                value[role] = object_list
+        return super(
+            UsersExporter, self).mangle_value(
+            value, name, context=context)
+
+    def export(self, users, filepath=None):
+        """Export `users`, 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 user in users:
+            self.write_item(user, writer)
+        return self.close_outfile(filepath, outfile)
+
+    def export_all(self, site, filepath=None):
+        """Export users into filepath as CSV data.
+
+        If `filepath` is ``None``, a raw string with CSV data is returned.
+        """
+        writer, outfile = self.get_csv_writer(filepath)
+        users = site.get('users', {})
+        return self.export(users.values(), filepath)

main/waeup.kofa/trunk/src/waeup/kofa/userscontainer.txt

@@ -48 +48 @@
     '{SSHA}...'
 
+We can export user accounts:
+
+    >>> from waeup.kofa.userscontainer import UsersExporter
+    >>> import os
+    >>> import tempfile
+    >>> workdir = tempfile.mkdtemp()
+    >>> outfile = os.path.join(workdir, 'myoutput.csv')
+    >>> exporter = UsersExporter()
+    >>> site = {'users':myusers}
+    >>> exporter.export_all(site, outfile)
+    >>> result = open(outfile, 'rb').read()
+    >>> 'name,title,public_name,description,email,phone,roles,local_roles,password' in result
+    True
+    >>> '{SSHA}' in result
+    True
+
 We can delete users: