[LIMS-1636] Make LDAP server ID field configurable (#934)

* Make LDAP searches more configurable

* Include ldap_id_field in globals

Author: gfrn

api/config_sample.php

@@ -40,6 +40,8 @@
     # CAS CA Cert (for SSO)
     $cacert = '/etc/certs/ca-bundle.crt';
 
+    # Field to get user ID from in LDAP
+    $ldap_id_field = "cn";
     # ldap server, used for lookup and authentication (if using, set to null if not)
     # Update the ldap(s) prefix, hostname and search settings as required
     $ldap_server = 'ldaps://ldap.example.com';

api/src/Page.php

@@ -758,7 +758,9 @@ function bcr()
      */
     function _get_name($fedid)
     {
-        $src = $this->_ldap_search('uid=' . $fedid);
+        global $ldap_id_field;
+
+        $src = $this->_ldap_search($ldap_id_field . '=' . $fedid);
         return array_key_exists($fedid, $src) ? $src[$fedid] : '';
     }
 
@@ -770,7 +772,9 @@ function _get_name($fedid)
      */
     function _get_email($fedid)
     {
-        $src = $this->_ldap_search('uid=' . $fedid, True);
+        global $ldap_id_field;
+
+        $src = $this->_ldap_search($ldap_id_field . '=' . $fedid, True);
         return array_key_exists($fedid, $src) ? $src[$fedid] : $fedid;
     }
 
@@ -853,12 +857,12 @@ function _get_ispyb_email_fn($name)
      * Search LDAP for name or email
      *
      * @param boolean $email Search for an email adddress if true, search for name if false
-     * @param string $search ldap query, typically uid=fedid or name search
+     * @param string $search ldap query, typically cn=fedid or name search
      * @return array Returns array of results, either fedid=>emailAddresses or fedid=>"givenname sn" from ldap records
      */
     function _ldap_search($search, $email = False)
     {
-        global $ldap_server, $ldap_search;
+        global $ldap_server, $ldap_search, $ldap_id_field;
 
         $ret = array();
         if (is_null($ldap_server)) {
@@ -881,7 +885,7 @@ function _ldap_search($search, $email = False)
             {
                 // Strictly speaking we could set anything as the key here, since only the first record is used in e.g. _get_email_fn
                 // But as the logic maps fedid=>email, use similar keys here
-                $fedid = $info[$i]['uid'][0];
+                $fedid = $info[$i][$ldap_id_field][0];
                 if ($email)
                 {
                     $ret[$fedid] = array_key_exists('mail', $info[$i]) ? $info[$i]['mail'][0] : '';