[change] we now use Full-Text RSS 3.1, thank you so much @fivefilters

[github/wallabag/wallabag.git] / inc / 3rdparty / libraries / humble-http-agent / CookieJar.php

<?php\r
/**\r
 * Cookie Jar\r
 * \r
 * PHP class for handling cookies, as defined by the Netscape spec: \r
 * <http://curl.haxx.se/rfc/cookie_spec.html>\r
 *\r
 * This class should be used to handle cookies (storing cookies from HTTP response messages, and\r
 * sending out cookies in HTTP request messages). This has been adapted for FiveFilters.org \r
 * from the original version used in HTTP Navigator. See http://www.keyvan.net/code/http-navigator/\r
 * \r
 * This class is mainly based on Cookies.pm <http://search.cpan.org/author/GAAS/libwww-perl-5.65/\r
 * lib/HTTP/Cookies.pm> from the libwww-perl collection <http://www.linpro.no/lwp/>.\r
 * Unlike Cookies.pm, this class only supports the Netscape cookie spec, not RFC 2965.\r
 * \r
 * @version 0.5\r
 * @date 2011-03-15\r
 * @see http://php.net/HttpRequestPool\r
 * @author Keyvan Minoukadeh\r
 * @copyright 2011 Keyvan Minoukadeh\r
 * @license http://www.gnu.org/licenses/agpl-3.0.html AGPL v3\r
 */\r
\r
class CookieJar\r
{\r
    /**\r
    * Cookies - array containing all cookies.\r
    *\r
    * <pre>\r
    * Cookies are stored like this:\r
    *   [domain][path][name] = array\r
    * where array is:\r
    *   0 => value, 1 => secure, 2 => expires\r
    * </pre>\r
    * @var array\r
    * @access private\r
    */\r
    public $cookies = array();\r
	public $debug = false;\r
\r
    /**\r
    * Constructor\r
    */\r
    function __construct() {\r
    }\r
\r
	protected function debug($msg, $file=null, $line=null) {\r
		if ($this->debug) {\r
			$mem = round(memory_get_usage()/1024, 2);\r
			$memPeak = round(memory_get_peak_usage()/1024, 2);\r
			echo '* ',$msg;\r
			if (isset($file, $line)) echo " ($file line $line)";\r
			echo ' - mem used: ',$mem," (peak: $memPeak)\n";	\r
			ob_flush();\r
			flush();\r
		}\r
	}	\r
	\r
    /**\r
    * Get matching cookies\r
    *\r
    * Only use this method if you cannot use add_cookie_header(), for example, if you want to use\r
    * this cookie jar class without using the request class.\r
    *\r
    * @param array $param associative array containing 'domain', 'path', 'secure' keys\r
    * @return string\r
    * @see add_cookie_header()\r
    */\r
    public function getMatchingCookies($url)\r
    {\r
		if (($parts = @parse_url($url)) && isset($parts['scheme'], $parts['host'], $parts['path'])) {\r
			$param['domain'] = $parts['host'];\r
			$param['path'] = $parts['path'];\r
			$param['secure'] = (strtolower($parts['scheme']) == 'https');\r
			unset($parts);\r
		} else {\r
			return false;\r
		}\r
        // RFC 2965 notes:\r
        //  If multiple cookies satisfy the criteria above, they are ordered in\r
        //  the Cookie header such that those with more specific Path attributes\r
        //  precede those with less specific.  Ordering with respect to other\r
        //  attributes (e.g., Domain) is unspecified.\r
        $domain = $param['domain'];\r
        if (strpos($domain, '.') === false) $domain .= '.local';\r
        $request_path = $param['path'];\r
        if ($request_path == '') $request_path = '/';\r
        $request_secure = $param['secure'];\r
        $now = time();\r
        $matched_cookies = array();\r
        // domain - find matching domains\r
        $this->debug('Finding matching domains for '.$domain, __FILE__, __LINE__);\r
        while (strpos($domain, '.') !== false) {\r
            if (isset($this->cookies[$domain])) {\r
                $this->debug(' domain match found: '.$domain);\r
                $cookies =& $this->cookies[$domain];\r
            } else {\r
                $domain = $this->_reduce_domain($domain);\r
                continue;\r
            }\r
            // paths - find matching paths starting from most specific\r
            $this->debug('  - Finding matching paths for '.$request_path);\r
            $paths = array_keys($cookies);\r
            usort($paths, array($this, '_cmp_length'));\r
            foreach ($paths as $path) {\r
                // continue to next cookie if request path does not path-match cookie path\r
                if (!$this->_path_match($request_path, $path)) continue;\r
                // loop through cookie names\r
                $this->debug('     path match found: '.$path);\r
                foreach ($cookies[$path] as $name => $values) {\r
                    // if this cookie is secure but request isn't, continue to next cookie\r
                    if ($values[1] && !$request_secure) continue;\r
                    // if cookie is not a session cookie and has expired, continue to next cookie\r
                    if (is_int($values[2]) && ($values[2] < $now)) continue;\r
                    // cookie matches request\r
                    $this->debug('      cookie match: '.$name.'='.$values[0]);\r
                    $matched_cookies[] = $name.'='.$values[0];\r
                }\r
            }\r
            $domain = $this->_reduce_domain($domain);\r
        }\r
        // return cookies\r
        return implode('; ', $matched_cookies);\r
    }\r
\r
    /**\r
    * Parse Set-Cookie values.\r
    *\r
    * Only use this method if you cannot use extract_cookies(), for example, if you want to use\r
    * this cookie jar class without using the response class.\r
    *\r
    * @param array $set_cookies array holding 1 or more "Set-Cookie" header values\r
    * @param array $param associative array containing 'host', 'path' keys\r
    * @return void\r
    * @see extract_cookies()\r
    */\r
    public function storeCookies($url, $set_cookies)\r
    {\r
        if (count($set_cookies) == 0) return;\r
		$param = @parse_url($url);\r
		if (!is_array($param) || !isset($param['host'])) return;\r
        $request_host = $param['host'];\r
        if (strpos($request_host, '.') === false) $request_host .= '.local';\r
        $request_path = @$param['path'];\r
        if ($request_path == '') $request_path = '/';\r
        //\r
        // loop through set-cookie headers\r
        //\r
        foreach ($set_cookies as $set_cookie) {\r
            $this->debug('Parsing: '.$set_cookie);\r
            // temporary cookie store (before adding to jar)\r
            $tmp_cookie = array();\r
            $param = explode(';', $set_cookie);\r
            // loop through params\r
            for ($x=0; $x<count($param); $x++) {\r
                $key_val = explode('=', $param[$x], 2);\r
                if (count($key_val) != 2) {\r
                    // if the first param isn't a name=value pair, continue to the next set-cookie\r
                    // header\r
                    if ($x == 0) continue 2;\r
                    // check for secure flag\r
                    if (strtolower(trim($key_val[0])) == 'secure') $tmp_cookie['secure'] = true;\r
                    // continue to next param\r
                    continue;\r
                }\r
                list($key, $val) = array_map('trim', $key_val);\r
                // first name=value pair is the cookie name and value\r
                // the name and value are stored under 'name' and 'value' to avoid conflicts\r
                // with later parameters.\r
                if ($x == 0) {\r
                    $tmp_cookie = array('name'=>$key, 'value'=>$val);\r
                    continue;\r
                }\r
                $key = strtolower($key);\r
                if (in_array($key, array('expires', 'path', 'domain', 'secure'))) {\r
                    $tmp_cookie[$key] = $val;\r
                }\r
            }\r
            //\r
            // set cookie\r
            //\r
            // check domain\r
            if (isset($tmp_cookie['domain']) && ($tmp_cookie['domain'] != $request_host) &&\r
                    ($tmp_cookie['domain'] != ".$request_host")) {\r
                $domain = $tmp_cookie['domain'];\r
                if ((strpos($domain, '.') === false) && ($domain != 'local')) {\r
                    $this->debug(' - domain "'.$domain.'" has no dot and is not a local domain');\r
                    continue;\r
                }\r
                if (preg_match('/\.[0-9]+$/', $domain)) {\r
                    $this->debug(' - domain "'.$domain.'" appears to be an ip address');\r
                    continue;\r
                }\r
                if (substr($domain, 0, 1) != '.') $domain = ".$domain";\r
                if (!$this->_domain_match($request_host, $domain)) {\r
                    $this->debug(' - request host "'.$request_host.'" does not domain-match "'.$domain.'"');\r
                    continue;\r
                }\r
            } else {\r
                // if domain is not specified in the set-cookie header, domain will default to\r
                // the request host\r
                $domain = $request_host;\r
            }\r
            // check path\r
            if (isset($tmp_cookie['path']) && ($tmp_cookie['path'] != '')) {\r
                $path = urldecode($tmp_cookie['path']);\r
                if (!$this->_path_match($request_path, $path)) {\r
                    $this->debug(' - request path "'.$request_path.'" does not path-match "'.$path.'"');\r
                    continue;\r
                }\r
            } else {\r
                $path = $request_path;\r
                $path = substr($path, 0, strrpos($path, '/'));\r
                if ($path == '') $path = '/';\r
            }\r
            // check if secure\r
            $secure = (isset($tmp_cookie['secure'])) ? true : false;\r
            // check expiry\r
            if (isset($tmp_cookie['expires'])) {\r
                if (($expires = strtotime($tmp_cookie['expires'])) < 0) {\r
                    $expires = null;\r
                }\r
            } else {\r
                $expires = null;\r
            }\r
            // set cookie\r
            $this->set_cookie($domain, $path, $tmp_cookie['name'], $tmp_cookie['value'], $secure, $expires);\r
        }\r
    }\r
	\r
	// return array of set-cookie values extracted from HTTP response headers (string $h)\r
	public function extractCookies($h) {\r
        $x = 0;\r
        $lines = 0;\r
        $headers = array();\r
        $last_match = false;\r
		$h = explode("\n", $h);\r
        foreach ($h as $line) {\r
			$line = rtrim($line);\r
            $lines++;\r
\r
            $trimmed_line = trim($line);\r
            if (isset($line_last)) {\r
                // check if we have \r\n\r\n (indicating the end of headers)\r
                // some servers will not use CRLF (\r\n), so we make CR (\r) optional.\r
                // if (preg_match('/\015?\012\015?\012/', $line_last.$line)) {\r
                //     break;\r
                // }\r
                // As an alternative, we can check if the current trimmed line is empty\r
                if ($trimmed_line == '') {\r
                    break;\r
                }\r
\r
                // check for continuation line...\r
                // RFC 2616 Section 2.2 "Basic Rules":\r
                // HTTP/1.1 header field values can be folded onto multiple lines if the\r
                // continuation line begins with a space or horizontal tab. All linear\r
                // white space, including folding, has the same semantics as SP. A\r
                // recipient MAY replace any linear white space with a single SP before\r
                // interpreting the field value or forwarding the message downstream.\r
                if ($last_match && preg_match('/^\s+(.*)/', $line, $match)) {\r
                    // append to previous header value\r
                    $headers[$x-1] .= ' '.rtrim($match[1]);\r
                    continue;\r
                }\r
            }\r
            $line_last = $line;\r
\r
            // split header name and value\r
            if (preg_match('/^Set-Cookie\s*:\s*(.*)/i', $line, $match)) {\r
                $headers[$x++] = rtrim($match[1]);\r
                $last_match = true;\r
            } else {\r
                $last_match = false;\r
            }\r
        }\r
        return $headers;\r
	}\r
\r
    /**\r
    * Set Cookie\r
    * @param string $domain\r
    * @param string $path\r
    * @param string $name cookie name\r
    * @param string $value cookie value\r
    * @param bool $secure\r
    * @param int $expires expiry time (null if session cookie, <= 0 will delete cookie)\r
    * @return void\r
    */\r
    function set_cookie($domain, $path, $name, $value, $secure=false, $expires=null)\r
    {\r
        if ($domain == '') return;\r
        if ($path == '') return;\r
        if ($name == '') return;\r
        // check if cookie needs to go\r
        if (isset($expires) && ($expires <= 0)) {\r
            if (isset($this->cookies[$domain][$path][$name])) unset($this->cookies[$domain][$path][$name]);\r
            return;\r
        }\r
        if ($value == '') return;\r
        $this->cookies[$domain][$path][$name] = array($value, $secure, $expires);\r
        return;\r
    }\r
\r
    /**\r
    * Clear cookies - [domain [,path [,name]]] - call method with no arguments to clear all cookies.\r
    * @param string $domain\r
    * @param string $path\r
    * @param string $name\r
    * @return void\r
    */\r
    function clear($domain=null, $path=null, $name=null)\r
    {\r
        if (!isset($domain)) {\r
            $this->cookies = array();\r
        } elseif (!isset($path)) {\r
            if (isset($this->cookies[$domain])) unset($this->cookies[$domain]);\r
        } elseif (!isset($name)) {\r
            if (isset($this->cookies[$domain][$path])) unset($this->cookies[$domain][$path]);\r
        } elseif (isset($name)) {\r
            if (isset($this->cookies[$domain][$path][$name])) unset($this->cookies[$domain][$path][$name]);\r
        }\r
    }\r
\r
    /**\r
    * Compare string length - used for sorting\r
    * @access private\r
    * @return int\r
    */\r
    function _cmp_length($a, $b)\r
    {\r
        $la = strlen($a); $lb = strlen($b);\r
        if ($la == $lb) return 0;\r
        return ($la > $lb) ? -1 : 1;\r
    }\r
\r
    /**\r
    * Reduce domain\r
    * @param string $domain\r
    * @return string\r
    * @access private\r
    */\r
    function _reduce_domain($domain)\r
    {\r
        if ($domain == '') return '';\r
        if (substr($domain, 0, 1) == '.') return substr($domain, 1);\r
        return substr($domain, strpos($domain, '.'));\r
    }\r
\r
    /**\r
    * Path match - check if path1 path-matches path2\r
    *\r
    * From RFC 2965: \r
    *   <i>For two strings that represent paths, P1 and P2, P1 path-matches P2\r
    *   if P2 is a prefix of P1 (including the case where P1 and P2 string-\r
    *   compare equal).  Thus, the string /tec/waldo path-matches /tec.</i>\r
    * @param string $path1\r
    * @param string $path2\r
    * @return bool\r
    * @access private\r
    */\r
    function _path_match($path1, $path2)\r
    {\r
        return (substr($path1, 0, strlen($path2)) == $path2);\r
    }\r
\r
    /**\r
    * Domain match - check if domain1 domain-matches domain2\r
    *\r
    * A few extracts from RFC 2965: \r
    *  -  A Set-Cookie2 from request-host y.x.foo.com for Domain=.foo.com\r
    *     would be rejected, because H is y.x and contains a dot.\r
    *\r
    *  -  A Set-Cookie2 from request-host x.foo.com for Domain=.foo.com\r
    *     would be accepted.\r
    *\r
    *  -  A Set-Cookie2 with Domain=.com or Domain=.com., will always be\r
    *     rejected, because there is no embedded dot.\r
    *\r
    *  -  A Set-Cookie2 from request-host example for Domain=.local will\r
    *     be accepted, because the effective host name for the request-\r
    *     host is example.local, and example.local domain-matches .local.\r
    *\r
    * I'm ignoring the first point for now (must check to see how other browsers handle\r
    * this rule for Set-Cookie headers)\r
    *\r
    * @param string $domain1\r
    * @param string $domain2\r
    * @return bool\r
    * @access private\r
    */\r
    function _domain_match($domain1, $domain2)\r
    {\r
        $domain1 = strtolower($domain1);\r
        $domain2 = strtolower($domain2);\r
        while (strpos($domain1, '.') !== false) {\r
            if ($domain1 == $domain2) return true;\r
            $domain1 = $this->_reduce_domain($domain1);\r
            continue;\r
        }\r
        return false;\r
    }\r
}\r
?>