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: 266: 267: 268: 269: 

<?php
/**
 * Session handler for persistent requests and default parameters
 *
 * @package Requests
 * @subpackage Session Handler
 */

/**
 * Session handler for persistent requests and default parameters
 *
 * Allows various options to be set as default values, and merges both the
 * options and URL properties together. A base URL can be set for all requests,
 * with all subrequests resolved from this. Base options can be set (including
 * a shared cookie jar), then overridden for individual requests.
 *
 * @package Requests
 * @subpackage Session Handler
 */
class Requests_Session {
    /**
     * Base URL for requests
     *
     * URLs will be made absolute using this as the base
     *
     * @var string|null
     */
    public $url = null;

    /**
     * Base headers for requests
     *
     * @var array
     */
    public $headers = array();

    /**
     * Base data for requests
     *
     * If both the base data and the per-request data are arrays, the data will
     * be merged before sending the request.
     *
     * @var array
     */
    public $data = array();

    /**
     * Base options for requests
     *
     * The base options are merged with the per-request data for each request.
     * The only default option is a shared cookie jar between requests.
     *
     * Values here can also be set directly via properties on the Session
     * object, e.g. `$session->useragent = 'X';`
     *
     * @var array
     */
    public $options = array();

    /**
     * Create a new session
     *
     * @param string|null $url Base URL for requests
     * @param array $headers Default headers for requests
     * @param array $data Default data for requests
     * @param array $options Default options for requests
     */
    public function __construct($url = null, $headers = array(), $data = array(), $options = array()) {
        $this->url     = $url;
        $this->headers = $headers;
        $this->data    = $data;
        $this->options = $options;

        if (empty($this->options['cookies'])) {
            $this->options['cookies'] = new Requests_Cookie_Jar();
        }
    }

    /**
     * Get a property's value
     *
     * @param string $key Property key
     * @return mixed|null Property value, null if none found
     */
    public function __get($key) {
        if (isset($this->options[$key])) {
            return $this->options[$key];
        }

        return null;
    }

    /**
     * Set a property's value
     *
     * @param string $key Property key
     * @param mixed $value Property value
     */
    public function __set($key, $value) {
        $this->options[$key] = $value;
    }

    /**
     * Remove a property's value
     *
     * @param string $key Property key
     */
    public function __isset($key) {
        return isset($this->options[$key]);
    }

    /**
     * Remove a property's value
     *
     * @param string $key Property key
     */
    public function __unset($key) {
        if (isset($this->options[$key])) {
            unset($this->options[$key]);
        }
    }

    /**#@+
     * @see request()
     * @param string $url
     * @param array $headers
     * @param array $options
     * @return Requests_Response
     */
    /**
     * Send a GET request
     */
    public function get($url, $headers = array(), $options = array()) {
        return $this->request($url, $headers, null, Requests::GET, $options);
    }

    /**
     * Send a HEAD request
     */
    public function head($url, $headers = array(), $options = array()) {
        return $this->request($url, $headers, null, Requests::HEAD, $options);
    }

    /**
     * Send a DELETE request
     */
    public function delete($url, $headers = array(), $options = array()) {
        return $this->request($url, $headers, null, Requests::DELETE, $options);
    }
    /**#@-*/

    /**#@+
     * @see request()
     * @param string $url
     * @param array $headers
     * @param array $data
     * @param array $options
     * @return Requests_Response
     */
    /**
     * Send a POST request
     */
    public function post($url, $headers = array(), $data = array(), $options = array()) {
        return $this->request($url, $headers, $data, Requests::POST, $options);
    }

    /**
     * Send a PUT request
     */
    public function put($url, $headers = array(), $data = array(), $options = array()) {
        return $this->request($url, $headers, $data, Requests::PUT, $options);
    }

    /**
     * Send a PATCH request
     *
     * Note: Unlike {@see post} and {@see put}, `$headers` is required, as the
     * specification recommends that should send an ETag
     *
     * @link https://tools.ietf.org/html/rfc5789
     */
    public function patch($url, $headers, $data = array(), $options = array()) {
        return $this->request($url, $headers, $data, Requests::PATCH, $options);
    }
    /**#@-*/

    /**
     * Main interface for HTTP requests
     *
     * This method initiates a request and sends it via a transport before
     * parsing.
     *
     * @see Requests::request()
     *
     * @throws Requests_Exception On invalid URLs (`nonhttp`)
     *
     * @param string $url URL to request
     * @param array $headers Extra headers to send with the request
     * @param array|null $data Data to send either as a query string for GET/HEAD requests, or in the body for POST requests
     * @param string $type HTTP request type (use Requests constants)
     * @param array $options Options for the request (see {@see Requests::request})
     * @return Requests_Response
     */
    public function request($url, $headers = array(), $data = array(), $type = Requests::GET, $options = array()) {
        $request = $this->merge_request(compact('url', 'headers', 'data', 'options'));

        return Requests::request($request['url'], $request['headers'], $request['data'], $type, $request['options']);
    }

    /**
     * Send multiple HTTP requests simultaneously
     *
     * @see Requests::request_multiple()
     *
     * @param array $requests Requests data (see {@see Requests::request_multiple})
     * @param array $options Global and default options (see {@see Requests::request})
     * @return array Responses (either Requests_Response or a Requests_Exception object)
     */
    public function request_multiple($requests, $options = array()) {
        foreach ($requests as $key => $request) {
            $requests[$key] = $this->merge_request($request, false);
        }

        $options = array_merge($this->options, $options);

        // Disallow forcing the type, as that's a per request setting
        unset($options['type']);

        return Requests::request_multiple($requests, $options);
    }

    /**
     * Merge a request's data with the default data
     *
     * @param array $request Request data (same form as {@see request_multiple})
     * @param boolean $merge_options Should we merge options as well?
     * @return array Request data
     */
    protected function merge_request($request, $merge_options = true) {
        if ($this->url !== null) {
            $request['url'] = Requests_IRI::absolutize($this->url, $request['url']);
            $request['url'] = $request['url']->uri;
        }

        if (empty($request['headers'])) {
            $request['headers'] = array();
        }
        $request['headers'] = array_merge($this->headers, $request['headers']);

        if (empty($request['data'])) {
            if (is_array($this->data)) {
                $request['data'] = $this->data;
            }
        }
        elseif (is_array($request['data']) && is_array($this->data)) {
            $request['data'] = array_merge($this->data, $request['data']);
        }

        if ($merge_options !== false) {
            $request['options'] = array_merge($this->options, $request['options']);

            // Disallow forcing the type, as that's a per request setting
            unset($request['options']['type']);
        }

        return $request;
    }
}