Made several LDAP queries, DN's and properties configurable

Tjeerd · Tjeerd · commit a86f563d9948 · 2016-05-18T13:44:48.000+02:00
diff --git a/README.md b/README.md
@@ -125,15 +125,30 @@ parameters:
     ldap_dn:   ~
     ldap_pass: ~
 
-    # DN of where the users are located in LDAP
-    users_dn: 'ou=Users,ou=SURFUni,dc=surfuni,dc=org'
+    # DN of where the users are located in LDAP, can be multiple DN's seperated by a comma
+    users_dn: ['ou=Users,ou=SURFUni,dc=surfuni,dc=org']
+    user_query: 'cn=*'
     # DN of where groups are located in LDAP, can be multiple DN's seperated by a comma
     groups_dn: ['ou=Formalgroups,dc=surfuni,dc=org']
+    group_query: 'cn=*'
     # Root group of where Grouphub groups will be stored
     grouphub_dn: 'ou=Grouphub,dc=surfuni,dc=org'
     # Subgroups located beneath the 'grouphub' DN where formal and adhoc groups will be stored
     formal_dn: 'ou=SemiFormal,ou=Grouphub,dc=surfuni,dc=org'
     adhoc_dn: 'ou=AdHoc,ou=Grouphub,dc=surfuni,dc=org'
+    
+    # Mapping of GroupHub properties to LDAP properties
+    ldap.mapping:
+        user:
+            firstName: givenname
+            lastName:  sn
+            loginName: uid
+            email:     mail
+        group:
+            name:        cn
+            description: description
+            objectClass: groupOfNames # this not a mapping, but a hardcoded value
+            groupType:   ~            # this not a mapping, but a hardcoded value which will not be added if empty 
 
     # Whether or not to sync admins to dedicated groups and, if so, to which DN
     # Note this DN should not be located beneath one of the groups mentioned earlier
diff --git a/app/config/parameters.yml.dist b/app/config/parameters.yml.dist
@@ -19,12 +19,26 @@ parameters:
     ldap_dn:   ~
     ldap_pass: ~
 
-    users_dn: 'ou=Users,ou=SURFUni,dc=surfuni,dc=org'
+    users_dn: ['ou=Users,ou=SURFUni,dc=surfuni,dc=org']
+    user_query: 'cn=*'
     groups_dn: ['ou=Formalgroups,dc=surfuni,dc=org']
+    group_query: 'cn=*'
     grouphub_dn: 'ou=Grouphub,dc=surfuni,dc=org'
     formal_dn: 'ou=SemiFormal,ou=Grouphub,dc=surfuni,dc=org'
     adhoc_dn: 'ou=AdHoc,ou=Grouphub,dc=surfuni,dc=org'
 
+    ldap.mapping:
+        user:
+            firstName: givenname
+            lastName:  sn
+            loginName: uid
+            email:     mail
+        group:
+            name:        cn
+            description: description
+            objectClass: groupOfNames
+            groupType:   ~
+
     admin_groups_sync: false
     admin_groups_dn: ~
 
diff --git a/app/config/services.yml b/app/config/services.yml
@@ -9,11 +9,12 @@ services:
 
     app.ldap_normalizer:
         class: AppBundle\Ldap\Normalizer
+        arguments: ["%ldap.mapping%"]
         private: true
 
     app.grouphub_ldap_client:
         class: AppBundle\Ldap\GrouphubClient
-        arguments: ["@app.ldap_client", "@app.ldap_normalizer", "%users_dn%", "%groups_dn%", "%grouphub_dn%", "%formal_dn%", "%adhoc_dn%", "%admin_groups_dn%"]
+        arguments: ["@app.ldap_client", "@app.ldap_normalizer", "%users_dn%", "%groups_dn%", "%grouphub_dn%", "%formal_dn%", "%adhoc_dn%", "%admin_groups_dn%", "%user_query%", "%group_query%"]
         private: true
 
     app.api_normalizer:
diff --git a/src/AppBundle/Ldap/GrouphubClient.php b/src/AppBundle/Ldap/GrouphubClient.php
@@ -3,8 +3,10 @@
 namespace AppBundle\Ldap;
 
 use AppBundle\Model\Group;
+use AppBundle\Model\User;
 use AppBundle\Sequence;
 use AppBundle\SynchronizableSequence;
+use Doctrine\Common\Comparable;
 use InvalidArgumentException;
 
 /**
@@ -25,7 +27,7 @@ class GrouphubClient
     private $normalizer;
 
     /**
-     * @var string
+     * @var string[]
      */
     private $usersDn;
 
@@ -54,25 +56,39 @@ class GrouphubClient
      */
     private $adminGroupsDn;
 
+    /**
+     * @var string
+     */
+    private $userQuery;
+
+    /**
+     * @var string
+     */
+    private $groupQuery;
+
     /**
      * @param LdapClient $ldap
      * @param Normalizer $normalizer
-     * @param string     $usersDn
+     * @param string[]   $usersDn
      * @param string[]   $groupsDn
      * @param string     $grouphubDn
      * @param string     $formalDn
      * @param string     $adhocDn
      * @param string     $adminGroupsDn
+     * @param string     $userQuery
+     * @param string     $groupQuery
      */
     public function __construct(
         LdapClient $ldap,
         $normalizer,
-        $usersDn,
+        array $usersDn,
         array $groupsDn,
         $grouphubDn,
         $formalDn,
         $adhocDn,
-        $adminGroupsDn = ''
+        $adminGroupsDn = '',
+        $userQuery = 'cn=*',
+        $groupQuery = 'cn=*'
     ) {
         $this->ldap = $ldap;
         $this->normalizer = $normalizer;
@@ -83,63 +99,73 @@ public function __construct(
         $this->formalDn = $formalDn;
         $this->adhocDn = $adhocDn;
         $this->adminGroupsDn = $adminGroupsDn;
+        $this->userQuery = $userQuery;
+        $this->groupQuery = $groupQuery;
     }
 
     /**
      * @param int $offset
      * @param int $limit
      *
-     * @return Sequence
+     * @return Sequence|User[]
      */
     public function findUsers($offset, $limit)
     {
-        $data = $this->ldap->find($this->usersDn, 'cn=*', '*', '', $offset, $limit);
-
-        if (empty($data)) {
-            return new Sequence([]);
-        }
-
-        $users = $this->normalizer->denormalizeUsers($data);
-
-        // @todo: use actual offset/limit
-        $users = array_slice($users, $offset, $limit);
-
-        return new Sequence($users);
+        return $this->findEntities($this->usersDn, $this->userQuery, ['*'], $offset, $limit, function ($data) {
+            return $this->normalizer->denormalizeUsers($data);
+        });
     }
 
     /**
      * @param int $offset
      * @param int $limit
      *
-     * @return Sequence
+     * @return Sequence|Group[]
      */
     public function findGroups($offset, $limit)
     {
-        $groups = [];
+        return $this->findEntities($this->groupsDn, $this->groupQuery, ['*'], $offset, $limit, function ($data) {
+            return $this->normalizer->denormalizeGroups($data);
+        });
+    }
+
+    /**
+     * @param array    $dns
+     * @param string   $query
+     * @param array    $filter
+     * @param int      $offset
+     * @param int      $limit
+     * @param \Closure $normalizer
+     *
+     * @return Sequence
+     */
+    private function findEntities(array $dns, $query, $filter, $offset, $limit, \Closure $normalizer)
+    {
+        $entities = [];
 
-        foreach ($this->groupsDn as $dn) {
-            $data = $this->ldap->find($dn, 'cn=*', ['cn', 'description'], '');
+        foreach ($dns as $dn) {
+            $data = $this->ldap->find($dn, $query, $filter, '');
 
             if (empty($data)) {
                 continue;
             }
 
-            $groups = array_merge($groups, $this->normalizer->denormalizeGroups($data));
+            $entities = array_merge($entities, $normalizer($data));
         }
 
-        if (count($this->groupsDn) > 1) {
+        if (count($dns) > 1) {
             usort(
-                $groups,
-                function (Group $a, Group $b) {
+                $entities,
+                function (Comparable $a, Comparable $b) {
                     return $a->compareTo($b);
                 }
             );
         }
 
         // @todo: use actual offset/limit
-        $groups = array_slice($groups, $offset, $limit);
+        $entities = array_slice($entities, $offset, $limit);
 
-        return new Sequence($groups);
+        return new Sequence($entities);
     }
 
     /**
diff --git a/src/AppBundle/Ldap/Normalizer.php b/src/AppBundle/Ldap/Normalizer.php
@@ -10,29 +10,44 @@
  */
 class Normalizer
 {
+    /**
+     * @var array
+     */
+    private $mapping;
+
+    /**
+     * @param array $mapping
+     */
+    public function __construct(array $mapping)
+    {
+        $this->mapping = $mapping;
+    }
+
     /**
      * @param array $users
      *
      * @return User[]
      */
     public function denormalizeUsers(array $users)
     {
+        $mapping = $this->mapping['user'];
+
         $result = [];
         for ($i = 0; $i < $users['count']; $i++) {
             $user = $users[$i];
 
             $annotations = [];
 
-            if (isset($user['mail'][0])) {
-                $annotations['email'] = $user['mail'][0];
+            if (isset($user[$mapping['email']][0])) {
+                $annotations['email'] = $user[$mapping['email']][0];
             }
 
             $result[] = new User(
                 null,
                 $user['dn'],
-                $user['givenname'][0],
-                $user['sn'][0],
-                $user['uid'][0],
+                $user[$mapping['firstName']][0],
+                $user[$mapping['lastName']][0],
+                $user[$mapping['loginName']][0],
                 $annotations
             );
         }
@@ -47,15 +62,17 @@ public function denormalizeUsers(array $users)
      */
     public function denormalizeGroups(array $groups)
     {
+        $mapping = $this->mapping['group'];
+
         $result = [];
         for ($i = 0; $i < $groups['count']; $i++) {
             $group = $groups[$i];
 
             $result[] = new Group(
                 null,
                 $group['dn'],
-                $group['cn'][0],
-                isset($group['description'][0]) ? $group['description'][0] : '',
+                $group[$mapping['name']][0],
+                isset($group[$mapping['description']][0]) ? $group[$mapping['description']][0] : '',
                 'ldap',
                 new User(1)
             );
@@ -97,15 +114,17 @@ public function denormalizeGroupUsers(array $groups)
      */
     public function denormalizeGrouphubGroups(array $groups)
     {
+        $mapping = $this->mapping['group'];
+
         $result = [];
         for ($i = 0; $i < $groups['count']; $i++) {
             $group = $groups[$i];
 
             $result[] = new Group(
                 null,
                 $group['dn'],
-                $group['cn'][0],
-                isset($group['description'][0]) ? $group['description'][0] : ''
+                $group[$mapping['name']][0],
+                isset($group[$mapping['description']][0]) ? $group[$mapping['description']][0] : ''
             );
         }
 
@@ -119,11 +138,16 @@ public function denormalizeGrouphubGroups(array $groups)
      */
     public function normalizeGroup(Group $group)
     {
-        $data = array_filter([
-            'cn'          => $group->getName(),
-            'description' => $group->getDescription(),
-            'objectClass' => 'groupOfNames',
-        ]);
+        $mapping = $this->mapping['group'];
+
+        $data = array_filter(
+            [
+                $mapping['name']        => $group->getName(),
+                $mapping['description'] => $group->getDescription(),
+                'objectClass'           => $mapping['objectClass'],
+                'groupType'             => $mapping['groupType'],
+            ]
+        );
 
         $data['member'] = '';
 
@@ -137,8 +161,12 @@ public function normalizeGroup(Group $group)
      */
     public function normalizeGroupForUpdate(Group $group)
     {
-        return array_filter([
-            'description' => $group->getDescription(),
-        ]);
+        $mapping = $this->mapping['group'];
+
+        return array_filter(
+            [
+                $mapping['description'] => $group->getDescription(),
+            ]
+        );
     }
 }
