OAuthRequest Class Reference

Collaboration diagram for OAuthRequest:

Public Member Functions
	__construct ($http_method, $http_url, $parameters=null)
	set_parameter ($name, $value, $allow_duplicates=true)
	get_parameter ($name)
	get_parameters ()
	unset_parameter ($name)
	get_signable_parameters ()
	The request parameters, sorted and concatenated into a normalized string. More...
	get_signature_base_string ()
	Returns the base string of this request. More...
	get_normalized_http_method ()
	just uppercases the http method More...
	get_normalized_http_url ()
	parses the url and rebuilds it to be scheme://host/path More...
	to_url ()
	builds a url usable for a GET request More...
	to_postdata ()
	builds the data one would send in a POST request More...
	to_header ()
	builds the Authorization: header More...
	__toString ()
	sign_request ($signature_method, $consumer, $token)
	build_signature ($signature_method, $consumer, $token)

Static Public Member Functions
static	from_request ($http_method=null, $http_url=null, $parameters=null)
	attempt to build up a request from what was passed to the server More...
static	from_consumer_and_token ($consumer, $token, $http_method, $http_url, $parameters=null)
	pretty much a helper function to set up the request More...

Data Fields
	$base_string

Static Public Attributes
static	$version = '1.0'
static	$POST_INPUT = 'php://input'

Static Private Member Functions
static	generate_timestamp ()
	util function: current timestamp More...
static	generate_nonce ()
	util function: current nonce More...

Private Attributes
	$parameters
	$http_method
	$http_url

Detailed Description

Definition at line 206 of file OAuth.php.

Constructor & Destructor Documentation

__construct()

OAuthRequest::__construct	(		$http_method,
			$http_url,
			$parameters = null
	)

Definition at line 216 of file OAuth.php.

    {
        @$parameters or $parameters = array();
        $this->parameters = $parameters;
        $this->http_method = $http_method;
        $this->http_url = $http_url;
    }

Member Function Documentation

__toString()

OAuthRequest::__toString

(

)

Definition at line 451 of file OAuth.php.

    {
        return $this->to_url();
    }

build_signature()

OAuthRequest::build_signature	(		$signature_method,
			$consumer,
			$token
	)

Definition at line 468 of file OAuth.php.

References $token.

    {
        $signature = $signature_method->build_signature($this, $consumer, $token);
        return $signature;
    }

from_consumer_and_token()

static OAuthRequest::from_consumer_and_token (   $consumer,   $token,   $http_method,   $http_url,   $parameters = null  )

static

pretty much a helper function to set up the request

Definition at line 284 of file OAuth.php.

References $token, $version, generate_nonce(), generate_timestamp(), and OAuthUtil\parse_parameters().

Referenced by ilLTIConsumerLaunch\signOAuth().

    {
        @$parameters or $parameters = array();
        $defaults = array("oauth_version" => OAuthRequest::$version,
                      "oauth_nonce" => OAuthRequest::generate_nonce(),
                      "oauth_timestamp" => OAuthRequest::generate_timestamp(),
                      "oauth_consumer_key" => $consumer->key);
        if ($token) {
            $defaults['oauth_token'] = $token->key;
        }

        $parameters = array_merge($defaults, $parameters);

        // Parse the query-string to find and add GET parameters
        $parts = parse_url($http_url);
        if ($parts['query']) {
            $qparms = OAuthUtil::parse_parameters($parts['query']);
            $parameters = array_merge($qparms, $parameters);
        }
     

        return new OAuthRequest($http_method, $http_url, $parameters);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

from_request()

static OAuthRequest::from_request (   $http_method = null,   $http_url = null,   $parameters = null  )

static

attempt to build up a request from what was passed to the server

Definition at line 228 of file OAuth.php.

References $_POST, $_SERVER, OAuthUtil\get_headers(), OAuthUtil\parse_parameters(), and OAuthUtil\split_header().

Referenced by ilLTIConsumerResultService\checkSignature().

    {
        $scheme = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != "on")
              ? 'http'
              : 'https';
        $port = "";
        if ($_SERVER['SERVER_PORT'] != "80" && $_SERVER['SERVER_PORT'] != "443" &&
        strpos(':', $_SERVER['HTTP_HOST']) < 0) {
            $port = ':' . $_SERVER['SERVER_PORT'] ;
        }
        @$http_url or $http_url = $scheme .
                              '://' . $_SERVER['HTTP_HOST'] .
                              $port .
                              $_SERVER['REQUEST_URI'];
        @$http_method or $http_method = $_SERVER['REQUEST_METHOD'];

        // We weren't handed any parameters, so let's find the ones relevant to
        // this request.
        // If you run XML-RPC or similar you should use this to provide your own
        // parsed parameter-list
        if (!$parameters) {
            // Find request headers
            $request_headers = OAuthUtil::get_headers();

            // Parse the query-string to find GET parameters
            $parameters = OAuthUtil::parse_parameters($_SERVER['QUERY_STRING']);

            $ourpost = $_POST;
            // Deal with magic_quotes
            // http://www.php.net/manual/en/security.magicquotes.disabling.php
            if (get_magic_quotes_gpc()) {
                $outpost = array();
                foreach ($_POST as $k => $v) {
                    $v = stripslashes($v);
                    $ourpost[$k] = $v;
                }
            }
            // Add POST Parameters if they exist
            $parameters = array_merge($parameters, $ourpost);

            // We have a Authorization-header with OAuth data. Parse the header
            // and add those overriding any duplicates from GET or POST
            if (@substr($request_headers['Authorization'], 0, 6) == "OAuth ") {
                $header_parameters = OAuthUtil::split_header(
                    $request_headers['Authorization']
        );
                $parameters = array_merge($parameters, $header_parameters);
            }
        }

        return new OAuthRequest($http_method, $http_url, $parameters);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

generate_nonce()

static OAuthRequest::generate_nonce ( )

staticprivate

util function: current nonce

Definition at line 485 of file OAuth.php.

Referenced by from_consumer_and_token().

    {
        $mt = microtime();
        $rand = mt_rand();

        return md5($mt . $rand); // md5s look nicer than numbers
    }

Here is the caller graph for this function:

generate_timestamp()

static OAuthRequest::generate_timestamp ( )

staticprivate

util function: current timestamp

Definition at line 477 of file OAuth.php.

Referenced by from_consumer_and_token().

    {
        return time();
    }

Here is the caller graph for this function:

get_normalized_http_method()

OAuthRequest::get_normalized_http_method

(

)

just uppercases the http method

Definition at line 380 of file OAuth.php.

    {
        return strtoupper($this->http_method);
    }

get_normalized_http_url()

OAuthRequest::get_normalized_http_url

(

)

parses the url and rebuilds it to be scheme://host/path

Definition at line 389 of file OAuth.php.

    {
        $parts = parse_url($this->http_url);

        $port = @$parts['port'];
        $scheme = $parts['scheme'];
        $host = $parts['host'];
        $path = @$parts['path'];

        $port or $port = ($scheme == 'https') ? '443' : '80';

        if (($scheme == 'https' && $port != '443')
        || ($scheme == 'http' && $port != '80')) {
            $host = "$host:$port";
        }
        return "$scheme://$host$path";
    }

get_parameter()

OAuthRequest::get_parameter

(

$name

)

Definition at line 324 of file OAuth.php.

References $name.

    {
        return isset($this->parameters[$name]) ? $this->parameters[$name] : null;
    }

get_parameters()

OAuthRequest::get_parameters

(

)

Definition at line 329 of file OAuth.php.

    {
        return $this->parameters;
    }

get_signable_parameters()

OAuthRequest::get_signable_parameters

(

)

The request parameters, sorted and concatenated into a normalized string.

Returns

string

Definition at line 343 of file OAuth.php.

References OAuthUtil\build_http_query().

    {
        // Grab all parameters
        $params = $this->parameters;

        // Remove oauth_signature if present
        // Ref: Spec: 9.1.1 ("The oauth_signature parameter MUST be excluded.")
        if (isset($params['oauth_signature'])) {
            unset($params['oauth_signature']);
        }

        return OAuthUtil::build_http_query($params);
    }

Here is the call graph for this function:

get_signature_base_string()

OAuthRequest::get_signature_base_string

(

)

Returns the base string of this request.

The base string defined as the method, the url and the parameters (normalized), each urlencoded and the concated with &.

Definition at line 364 of file OAuth.php.

References OAuthUtil\urlencode_rfc3986().

    {
        $parts = array(
      $this->get_normalized_http_method(),
      $this->get_normalized_http_url(),
      $this->get_signable_parameters()
    );

        $parts = OAuthUtil::urlencode_rfc3986($parts);

        return implode('&', $parts);
    }

Here is the call graph for this function:

set_parameter()

OAuthRequest::set_parameter	(		$name,
			$value,
			$allow_duplicates = true
	)

Definition at line 308 of file OAuth.php.

References $name.

    {
        if ($allow_duplicates && isset($this->parameters[$name])) {
            // We have already added parameter(s) with this name, so add to the list
            if (is_scalar($this->parameters[$name])) {
                // This is the first duplicate, so transform scalar (string)
                // into an array so we can add the duplicates
                $this->parameters[$name] = array($this->parameters[$name]);
            }

            $this->parameters[$name][] = $value;
        } else {
            $this->parameters[$name] = $value;
        }
    }

sign_request()

OAuthRequest::sign_request	(		$signature_method,
			$consumer,
			$token
	)

Definition at line 457 of file OAuth.php.

References $token.

    {
        $this->set_parameter(
            "oauth_signature_method",
            $signature_method->get_name(),
            false
    );
        $signature = $this->build_signature($signature_method, $consumer, $token);
        $this->set_parameter("oauth_signature", $signature, false);
    }

to_header()

OAuthRequest::to_header

(

)

builds the Authorization: header

Definition at line 431 of file OAuth.php.

References $out, $total, and OAuthUtil\urlencode_rfc3986().

    {
        $out = 'Authorization: OAuth realm=""';
        $total = array();
        foreach ($this->parameters as $k => $v) {
            if (substr($k, 0, 5) != "oauth") {
                continue;
            }
            if (is_array($v)) {
                throw new OAuthException('Arrays not supported in headers');
            }
            $out .= ',' .
              OAuthUtil::urlencode_rfc3986($k) .
              '="' .
              OAuthUtil::urlencode_rfc3986($v) .
              '"';
        }
        return $out;
    }

Here is the call graph for this function:

to_postdata()

OAuthRequest::to_postdata

(

)

builds the data one would send in a POST request

Definition at line 423 of file OAuth.php.

References OAuthUtil\build_http_query().

    {
        return OAuthUtil::build_http_query($this->parameters);
    }

Here is the call graph for this function:

to_url()

OAuthRequest::to_url

(

)

builds a url usable for a GET request

Definition at line 410 of file OAuth.php.

References $out.

    {
        $post_data = $this->to_postdata();
        $out = $this->get_normalized_http_url();
        if ($post_data) {
            $out .= '?' . $post_data;
        }
        return $out;
    }

unset_parameter()

OAuthRequest::unset_parameter

(

$name

)

Definition at line 334 of file OAuth.php.

References $name.

    {
        unset($this->parameters[$name]);
    }

Field Documentation

$base_string

OAuthRequest::$base_string

Definition at line 212 of file OAuth.php.

$http_method

OAuthRequest::$http_method

private

Definition at line 209 of file OAuth.php.

$http_url

OAuthRequest::$http_url

private

Definition at line 210 of file OAuth.php.

$parameters

OAuthRequest::$parameters

private

Definition at line 208 of file OAuth.php.

$POST_INPUT

OAuthRequest::$POST_INPUT = 'php://input'

static

Definition at line 214 of file OAuth.php.

$version

OAuthRequest::$version = '1.0'

static

Definition at line 213 of file OAuth.php.

Referenced by from_consumer_and_token().

---

The documentation for this class was generated from the following file:

• Modules/LTIConsumer/lib/OAuth.php