[locationinfo] Add exchange backend

Closes #3170

1 files changed, 226 insertions, 0 deletions

diff --git a/modules-available/locationinfo/exchange-includes/jamesiarmes/PhpNtlm/SoapClient.php b/modules-available/locationinfo/exchange-includes/jamesiarmes/PhpNtlm/SoapClient.php
new file mode 100644
index 00000000..21c77cbf
--- /dev/null
+++ b/modules-available/locationinfo/exchange-includes/jamesiarmes/PhpNtlm/SoapClient.php
@@ -0,0 +1,226 @@
+<?php
+/**
+ * Contains \JamesIArmes\PhpNtlm\NTLMSoapClient.
+ */
+
+namespace jamesiarmes\PhpNtlm;
+
+/**
+ * Soap Client using Microsoft's NTLM Authentication.
+ *
+ * @package php-ntlm\Soap
+ */
+class SoapClient extends \SoapClient
+{
+    /**
+     * cURL resource used to make the SOAP request
+     *
+     * @var resource
+     */
+    protected $ch;
+
+    /**
+     * Options passed to the client constructor.
+     *
+     * @var array
+     */
+    protected $options;
+
+    /**
+     * {@inheritdoc}
+     *
+     * Additional options:
+     * - user (string): The user to authenticate with.
+     * - password (string): The password to use when authenticating the user.
+     * - curlopts (array): Array of options to set on the curl handler when
+     *   making the request.
+     * - strip_bad_chars (boolean, default true): Whether or not to strip
+     *   invalid characters from the XML response. This can lead to content
+     *   being returned differently than it actually is on the host service, but
+     *   can also prevent the "looks like we got no XML document" SoapFault when
+     *   the response includes invalid characters.
+     * - warn_on_bad_chars (boolean, default false): Trigger a warning if bad
+     *   characters are stripped. This has no affect unless strip_bad_chars is
+     *   true.
+     */
+    public function __construct($wsdl, array $options = null)
+    {
+        // Set missing indexes to their default value.
+        $options += array(
+            'user' => null,
+            'password' => null,
+            'curlopts' => array(),
+            'strip_bad_chars' => true,
+            'warn_on_bad_chars' => false,
+        );
+        $this->options = $options;
+
+        // Verify that a user name and password were entered.
+        if (empty($options['user']) || empty($options['password'])) {
+            throw new \BadMethodCallException(
+                'A username and password is required.'
+            );
+        }
+
+        parent::__construct($wsdl, $options);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __doRequest($request, $location, $action, $version, $one_way = 0)
+    {
+        $headers = $this->buildHeaders($action);
+        $this->__last_request = $request;
+        $this->__last_request_headers = $headers;
+
+        // Only reinitialize curl handle if the location is different.
+        if (!$this->ch
+            || curl_getinfo($this->ch, CURLINFO_EFFECTIVE_URL) != $location) {
+            $this->ch = curl_init($location);
+        }
+
+        curl_setopt_array($this->ch, $this->curlOptions($action, $request));
+        $response = curl_exec($this->ch);
+
+        // TODO: Add some real error handling.
+        // If the response if false than there was an error and we should throw
+        // an exception.
+        if ($response === false) {
+            $this->__last_response = $this->__last_response_headers = false;
+            throw new \RuntimeException(
+                'Curl error: ' . curl_error($this->ch),
+                curl_errno($this->ch)
+            );
+        }
+
+        $this->parseResponse($response);
+        $this->cleanResponse();
+
+        return $this->__last_response;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __getLastRequestHeaders()
+    {
+        return implode("\n", $this->__last_request_headers) . "\n";
+    }
+
+    /**
+     * Returns the response code from the last request
+     *
+     * @return integer
+     *
+     * @throws \BadMethodCallException
+     *   If no cURL resource has been initialized.
+     */
+    public function getResponseCode()
+    {
+        if (empty($this->ch)) {
+            throw new \BadMethodCallException('No cURL resource has been '
+                . 'initialized. This is probably because no request has not '
+                . 'been made.');
+        }
+
+        return curl_getinfo($this->ch, CURLINFO_HTTP_CODE);
+    }
+
+    /**
+     * Builds the headers for the request.
+     *
+     * @param string $action
+     *   The SOAP action to be performed.
+     */
+    protected function buildHeaders($action)
+    {
+        return array(
+            'Method: POST',
+            'Connection: Keep-Alive',
+            'User-Agent: PHP-SOAP-CURL',
+            'Content-Type: text/xml; charset=utf-8',
+            "SOAPAction: \"$action\"",
+            'Expect: 100-continue',
+        );
+    }
+
+    /**
+     * Cleans the response body by stripping bad characters if instructed to.
+     */
+    protected function cleanResponse()
+    {
+        // If the option to strip bad characters is not set, then we shouldn't
+        // do anything here.
+        if (!$this->options['strip_bad_chars']) {
+            return;
+        }
+
+        // Strip invalid characters from the XML response body.
+        $count = 0;
+        $this->__last_response = preg_replace(
+            '/(?!&#x0?(9|A|D))(&#x[0-1]?[0-9A-F];)/',
+            ' ',
+            $this->__last_response,
+            -1,
+            $count
+        );
+
+        // If the option to warn on bad characters is set, and some characters
+        // were stripped, then trigger a warning.
+        if ($this->options['warn_on_bad_chars'] && $count > 0) {
+            trigger_error(
+                'Invalid characters were stripped from the XML SOAP response.',
+                E_USER_WARNING
+            );
+        }
+    }
+
+    /**
+     * Builds an array of curl options for the request
+     *
+     * @param string $action
+     *   The SOAP action to be performed.
+     * @param string $request
+     *   The XML SOAP request.
+     * @return array
+     *   Array of curl options.
+     */
+    protected function curlOptions($action, $request)
+    {
+        $options = $this->options['curlopts'] + array(
+            CURLOPT_SSL_VERIFYPEER => true,
+            CURLOPT_RETURNTRANSFER => true,
+            CURLOPT_HTTPHEADER => $this->buildHeaders($action),
+            CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
+            CURLOPT_HTTPAUTH => CURLAUTH_BASIC | CURLAUTH_NTLM,
+            CURLOPT_USERPWD => $this->options['user'] . ':'
+                               . $this->options['password'],
+        );
+
+        // We shouldn't allow these options to be overridden.
+        $options[CURLOPT_HEADER] = true;
+        $options[CURLOPT_POST] = true;
+        $options[CURLOPT_POSTFIELDS] = $request;
+
+        return $options;
+    }
+
+    /**
+     * Pareses the response from a successful request.
+     *
+     * @param string $response
+     *   The response from the cURL request, including headers and body.
+     */
+    public function parseResponse($response)
+    {
+        // Parse the response and set the last response and headers.
+        $info = curl_getinfo($this->ch);
+        $this->__last_response_headers = substr(
+            $response,
+            0,
+            $info['header_size']
+        );
+        $this->__last_response = substr($response, $info['header_size']);
+    }
+}