Overview

Namespaces

  • Apptus
    • ESales
      • Connector
        • Report
        • Time
    • Util
      • Cache
  • PHP
  • Overview
  • Namespace
  • Class
  • Tree
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 
<?php

namespace Apptus\ESales\Connector;

/**
 * @internal
 */
class ConnectorSettings {
    const DEFAULT_EXPORT_TIMEOUT = 60000;
    const DEFAULT_IMPORT_TIMEOUT = 600000;
    const DEFAULT_CONNECTION_TIMEOUT = 2000;
    const DEFAULT_HEALTH_CHECK_TIMEOUT = 500;
    const DEFAULT_REPORT_TIMEOUT = 120000;
    const DEFAULT_BLOCK_TIMEOUT = 10000;
    const DEFAULT_NOTIFICATION_TIMEOUT = 3000;
    const DEFAULT_QUERY_TIMEOUT = 3000;
    private $queryString;
    // PHP Connector specific settings
    private $CAInfo;
    private $highSecurity; // used only in cloud
    // General settings
    private $timeouts;
    private $ignoreCertificates;
    private $compressionMode;
    private $maximumAttempts;
    private $sendExtraRequestHeader;

    public function __construct($queryString, $timeouts, $ignoreCertificates, $compressionMode, $CAInfo, $highSecurity, $maximumAttempts, $sendExtraRequestHeader) {
        $this->queryString = $queryString;
        $this->timeouts = $timeouts;
        $this->ignoreCertificates = $ignoreCertificates;
        $this->compressionMode = $compressionMode;
        $this->CAInfo = $CAInfo;
        $this->highSecurity = $highSecurity;
        $this->maximumAttempts = $maximumAttempts;
        $this->sendExtraRequestHeader = $sendExtraRequestHeader;
    }

    public static function defaultsForOnPrem() {
        return new ConnectorSettings(
            '',
            self::defaultTimeouts(),
            false,
            CompressionMode::NONE,
            false,
            false,
            5,
            false
        );
    }

    public static function defaultsForCloud() {
        return new ConnectorSettings(
            '',
            self::defaultTimeouts(),
            false,
            CompressionMode::GZIP,
            false,
            true,
            5,
            true
        );
    }

    public function update($queryString, $strict = true) {
        $builder = new ConnectorSettingsBuilder($this);
        $builder->handleParameters($queryString, $strict);
        return $builder->build();
    }

    public function ignoreCertificates() {
        return $this->ignoreCertificates;
    }

    public function CAInfo() {
        return $this->CAInfo;
    }

    public function maxAttempts() {
        return $this->maximumAttempts;
    }

    public function sendExtraRequestHeader() {
        return $this->sendExtraRequestHeader;
    }

    public function highSecurity() {
        return $this->highSecurity;
    }

    function timeout($name) {
        return $this->timeouts[$name];
    }

    public function timeouts() {
        return $this->timeouts;
    }

    public function blockTimeout() {
        return $this->timeout('block_timeout');
    }

    public function connectionTimeout() {
        return $this->timeout('connection_timeout');
    }

    public function queryTimeout() {
        return $this->timeout('query_timeout');
    }

    public function healthCheckTimeout() {
        return $this->timeout('health_check_timeout');
    }

    public function exportTimeout() {
        return $this->timeout('export_timeout');
    }

    public function reportTimeout() {
        return $this->timeout('report_timeout');
    }

    public function importTimeout() {
        return $this->timeout('import_timeout');
    }

    public function notificationTimeout() {
        return $this->timeout('notification_timeout');
    }

    public function compressionMode() {
        return $this->compressionMode;
    }

    public function queryString() {
        return $this->queryString;
    }

    private static function defaultTimeouts() {
        return [
            'connection_timeout' => self::DEFAULT_CONNECTION_TIMEOUT,
            'query_timeout' => self::DEFAULT_QUERY_TIMEOUT,
            'health_check_timeout' => self::DEFAULT_HEALTH_CHECK_TIMEOUT,
            'import_timeout' => self::DEFAULT_IMPORT_TIMEOUT,
            'export_timeout' => self::DEFAULT_EXPORT_TIMEOUT,
            'report_timeout' => self::DEFAULT_REPORT_TIMEOUT,
            'notification_timeout' => self::DEFAULT_NOTIFICATION_TIMEOUT,
            'block_timeout' => self::DEFAULT_BLOCK_TIMEOUT
        ];
    }
}

class ConnectorSettingsBuilder {
    private $queryString;
    private $compressionMode;
    private $ignoreCertificates;
    private $maxAttempts;
    private $sendExtraRequestHeader;
    private $CAInfo;
    private $highSecurity;
    private $timeouts;


    public function __construct(ConnectorSettings $connectorSettings) {
        // NOTE: this assigment will copy array by value not by reference
        $this->timeouts = $connectorSettings->timeouts();
        $this->compressionMode = $connectorSettings->compressionMode();
        $this->ignoreCertificates = $connectorSettings->ignoreCertificates();
        $this->maxAttempts = $connectorSettings->maxAttempts();
        $this->sendExtraRequestHeader = $connectorSettings->sendExtraRequestHeader();
        $this->CAInfo = $connectorSettings->CAInfo();
        $this->highSecurity = $connectorSettings->highSecurity();
        $this->queryString = $connectorSettings->queryString();
    }

    public function handleParameters($queryString, $strict) {
        if ($queryString === null || $queryString === '') {
            return;
        }
        $this->queryString = $queryString;
        $args = explode('&', $queryString);
        $seenArgs = array();
        foreach ($args as $arg) {
            $eIx = strpos($arg, '=');
            $name = $arg;
            $value = null;

            if ($eIx !== false) {
                $name = substr($arg, 0, $eIx);
                $value = urldecode(substr($arg, $eIx + 1));
            }

            if ($strict) {
                if (isset($seenArgs[$name])) {
                    throw new MalformedURLException('Argument specified twice: ' . $name);
                }
                $seenArgs[$name] = true;
            }

            if ($name === 'ignore_certificates') {
                self::parseBoolean($name, $value, $strict, $this->ignoreCertificates);
            } elseif ($name === 'compression_mode') {
                $compressionMode = CompressionMode::valueOf($value);
                if ($compressionMode !== null) {
                    $this->compressionMode = $compressionMode;
                } else if ($strict) {
                    throw new MalformedURLException("Couldn't parse " . $name . ". Got '" . $value . "'.");
                }
            } elseif ($name === 'maximum_attempts') {
                self::parseInt($name, $value, $strict, $this->maxAttempts);
            } elseif ($name === 'send_extra_request_header') {
                self::parseBoolean($name, $value, $strict, $this->sendExtraRequestHeader);
            } elseif ($name === 'cainfo') {
                $this->CAInfo = $value;
            } elseif ($name === 'security') {
                if ($value === 'high') {
                    $this->highSecurity = true;
                } elseif ($value === 'medium') {
                    $this->highSecurity = false;
                } else {
                    throw new MalformedURLException('Unknown security level: ' . $value . '. Allowed values are "high" and "medium"');
                }
            } elseif (array_key_exists($name, $this->timeouts)) {
                self::parseInt($name, $value, $strict, $this->timeouts[$name]);
            } else {
                // ignore 'ssl' for compatibility
                if ($strict && $name !== 'ssl') {
                    throw new MalformedURLException('Unknown parameter: ' . $name);
                }
            }
        }
    }

    public function build() {
        return new ConnectorSettings(
            $this->queryString,
            $this->timeouts,
            $this->ignoreCertificates,
            $this->compressionMode,
            $this->CAInfo,
            $this->highSecurity,
            $this->maxAttempts,
            $this->sendExtraRequestHeader
        );
    }

    private static function parseBoolean($name, $value, $strict, &$result) {
        $filtered = filter_var($value, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
        if ($filtered === null) {
            if ($strict) {
                throw new MalformedURLException("Couldn't parse " . $name . ". Expected boolean got '" . $value . "'.");
            }
        } else {
            $result = $filtered;
        }
    }

    private static function parseInt($name, $value, $strict, &$result) {
        if (ctype_digit($value)) {
            $result = (int)$value;
        } else if ($strict) {
            throw new MalformedURLException("Couldn't parse " . $name . ". Expected int got '" . $value . "'.");
        }
    }
}
Apptus ESales Connector PHP API documentation generated by ApiGen