Merge pull request #569 in ZP/z-push from...

Merge pull request #569 in ZP/z-push from feature/ZP-1209-autodiscover-apply-a-configurable to develop

* commit 'ae32ce5f':
  ZP-1209 AutoDiscover: updated AUTODISCOVER_LOGIN_TYPE description in config.php and in INSTALL.
  ZP-1209 AutoDiscover: Apply a configurable regex to the login string.

src/autodiscover/INSTALL

@@ -171,6 +171,20 @@ USE_FULLEMAIL_FOR_LOGIN If this is set to "true", AutoDiscover will attempt to
                         address sent by the client. If disabled (default), the 
                         local part of the email address is used.
 
+AUTODISCOVER_LOGIN_TYPE If the local part of the email address doesn't match the
+                        user name, this parameter helps to convert it for some common cases.
+Possible values:
+    AUTODISCOVER_LOGIN_EMAIL            uses the local part of the email address
+                                        as provided when setting up the account.
+    AUTODISCOVER_LOGIN_NO_DOT           removes the '.' from email address:
+                                        email: first.last@domain.com -> resulting username: firstlast
+    AUTODISCOVER_LOGIN_F_NO_DOT_LAST    cuts the first part before '.' after the first letter
+                                        and removes the '.' from email address:
+                                        email: first.last@domain.com -> resulting username: flast
+    AUTODISCOVER_LOGIN_F_DOT_LAST       cuts the part before '.' after the first letter and
+                                        leaves the part after '.' as is:
+                                        email: first.last@domain.com -> resulting username: f.last
+
 LOGFILEDIR              The directory where logfiles are created.
 
 LOGFILE                 The default AutoDiscover log file.

src/autodiscover/autodiscover.php

@@ -190,11 +190,25 @@ class ZPushAutodiscover {
         // the local part only.
         if (USE_FULLEMAIL_FOR_LOGIN) {
             $username = $incomingXml->Request->EMailAddress;
-            ZLog::Write(LOGLEVEL_DEBUG, sprintf("Using the complete email address for login: '%s'", $username));
+            ZLog::Write(LOGLEVEL_DEBUG, sprintf("ZPushAutodiscover->login(): Using the complete email address for login: '%s'", $username));
         }
         else {
             $username = Utils::GetLocalPartFromEmail($incomingXml->Request->EMailAddress);
-            ZLog::Write(LOGLEVEL_DEBUG, sprintf("Using the username only for login: '%s'", $username));
+            if (defined('AUTODISCOVER_LOGIN_TYPE') && AUTODISCOVER_LOGIN_TYPE != AUTODISCOVER_LOGIN_EMAIL) {
+                switch (AUTODISCOVER_LOGIN_TYPE) {
+                    case AUTODISCOVER_LOGIN_NO_DOT:
+                        $username = str_replace('.', '', $username);
+                        break;
+                    case AUTODISCOVER_LOGIN_F_NO_DOT_LAST:
+                        $username = str_replace('.', '', substr_replace($username, '', 1, strpos($username, '.') - 1));
+                        break;
+                    case AUTODISCOVER_LOGIN_F_DOT_LAST:
+                        $username = substr_replace($username, '', 1, strpos($username, '.') - 1);
+                        break;
+                }
+                ZLog::Write(LOGLEVEL_DEBUG, sprintf("ZPushAutodiscover->login(): AUTODISCOVER_LOGIN_TYPE is set to %d", AUTODISCOVER_LOGIN_TYPE));
+            }
+            ZLog::Write(LOGLEVEL_DEBUG, sprintf("ZPushAutodiscover->login(): Using the username only for login: '%s'", $username));
         }
 
         // Mobile devices send Authorization header using UTF-8 charset. Outlook sends it using ISO-8859-1 encoding.

src/autodiscover/config.php

@@ -45,6 +45,28 @@
      */
     define('USE_FULLEMAIL_FOR_LOGIN', false);
 
+    /*
+     * AutoDiscover requires the username to match either the email address
+     * or the local part of the email address.
+     * This is not always possible as the username might have a different
+     * schema than email address. Configure this parameter to match your
+     * username settings.
+     * @see https://wiki.z-hub.io/display/ZP/Configuring+Z-Push+Autodiscover#ConfiguringZ-PushAutodiscover-Configuration
+     * @see https://jira.z-hub.io/browse/ZP-1209
+     *
+     * Possible values:
+     * AUTODISCOVER_LOGIN_EMAIL             - uses the email address as provided when setting up the account
+     * AUTODISCOVER_LOGIN_NO_DOT            - removes the '.' from email address:
+     *                                          email: first.last@domain.com -> resulting username: firstlast
+     * AUTODISCOVER_LOGIN_F_NO_DOT_LAST     - cuts the first part before '.' after the first letter and
+     *                                          removes the '.' from email address:
+     *                                          email: first.last@domain.com -> resulting username: flast
+     * AUTODISCOVER_LOGIN_F_DOT_LAST        - cuts the part before '.' after the first letter and
+     *                                          leaves the part after '.' as is:
+     *                                          email: first.last@domain.com -> resulting username: f.last
+     */
+    define('AUTODISCOVER_LOGIN_TYPE', AUTODISCOVER_LOGIN_EMAIL);
+
 /**********************************************************************************
  *  Logging settings
  *  Possible LOGLEVEL and LOGUSERLEVEL values are:

src/lib/core/zpushdefs.php

@@ -1053,3 +1053,8 @@ define("NOTEIVERB_FORWARD", 104);
 define("AS_REPLYTOSENDER", 1);
 define("AS_REPLYTOALL", 2);
 define("AS_FORWARD", 3);
+
+define('AUTODISCOVER_LOGIN_EMAIL', 0);
+define('AUTODISCOVER_LOGIN_NO_DOT', 1);
+define('AUTODISCOVER_LOGIN_F_NO_DOT_LAST', 2);
+define('AUTODISCOVER_LOGIN_F_DOT_LAST', 3);