Sindbad~EG File Manager
<?php
/*
* oauth_client.php
*
* @(#) $Id: oauth_client.php,v 1.187 2023/06/06 20:47:37 mlemos Exp $
* PHP-OAuth-API (http://www.phpclasses.org/oauth-api)
*
*/
if (!defined('ABSPATH'))
die('Restricted Access');
class oauth_session_value_class
{
var $id;
var $session;
var $state;
var $access_token;
var $access_token_secret;
var $authorized;
var $expiry;
var $type;
var $server;
var $creation;
var $refresh_token;
var $access_token_response;
};
/*
{metadocument}<?xml version="1.0" encoding="ISO-8859-1" ?>
<class>
<package>net.manuellemos.oauth</package>
<version>@(#) $Id: oauth_client.php,v 1.187 2023/06/06 20:47:37 mlemos Exp $</version>
<copyright>Copyright (C) Manuel Lemos 2012 - 2022 and beyond</copyright>
<title>OAuth client</title>
<author>Manuel Lemos</author>
<authoraddress>mlemos-at-acm.org</authoraddress>
<documentation>
<idiom>en</idiom>
<purpose>This class serves two main purposes:<paragraphbreak />
1) Implement the OAuth protocol to retrieve a token from a server to
authorize the access to an API on behalf of the current
user.<paragraphbreak />
2) Perform calls to a Web services API using a token previously
obtained using this class or a token provided some other way by the
Web services provider.</purpose>
<usage>Regardless of your purposes, you always need to start calling
the class <functionlink>Initialize</functionlink> function after
initializing setup variables. After you are done with the class,
always call the <functionlink>Finalize</functionlink> function at
the end.<paragraphbreak />
This class supports either OAuth protocol versions 1.0, 1.0a and
2.0. It abstracts the differences between these protocol versions,
so the class usage is the same independently of the OAuth
version of the server.<paragraphbreak />
The class also provides built-in support to several popular OAuth
servers, so you do not have to manually configure all the details to
access those servers. Just set the
<variablelink>server</variablelink> variable to configure the class
to access one of the built-in supported servers.<paragraphbreak />
If you need to access one type of server that is not yet directly
supported by the class, you need to configure it explicitly setting
the variables: <variablelink>oauth_version</variablelink>,
<variablelink>url_parameters</variablelink>,
<variablelink>authorization_header</variablelink>,
<variablelink>request_token_url</variablelink>,
<variablelink>dialog_url</variablelink>,
<variablelink>reauthenticate_dialog_url</variablelink>,
<variablelink>pin_dialog_url</variablelink>,
<variablelink>offline_dialog_url</variablelink>,
<variablelink>append_state_to_redirect_uri</variablelink> and
<variablelink>access_token_url</variablelink>.<paragraphbreak />
Before proceeding to the actual OAuth authorization process, you
need to have registered your application with the OAuth server. The
registration provides you values to set the variables
<variablelink>client_id</variablelink> and
<variablelink>client_secret</variablelink>. Some servers also
provide an additional value to set the
<variablelink>api_key</variablelink> variable.<paragraphbreak />
You also need to set the variables
<variablelink>redirect_uri</variablelink> and
<variablelink>scope</variablelink> before calling the
<functionlink>Process</functionlink> function to make the class
perform the necessary interactions with the OAuth
server.<paragraphbreak />
The OAuth protocol involves multiple steps that include redirection
to the OAuth server. There it asks permission to the current user to
grant your application access to APIs on his/her behalf. When there
is a redirection, the class will set the
<variablelink>exit</variablelink> variable to
<booleanvalue>1</booleanvalue>. Then your script should exit
immediately without outputting anything.<paragraphbreak />
When the OAuth access token is successfully obtained, the following
variables are set by the class with the obtained values:
<variablelink>access_token</variablelink>,
<variablelink>access_token_secret</variablelink>,
<variablelink>access_token_expiry</variablelink>,
<variablelink>access_token_type</variablelink>. You may want to
store these values to use them later when calling the server
APIs.<paragraphbreak />
If there was a problem during OAuth authorization process, check the
variable <variablelink>authorization_error</variablelink> to
determine the reason.<paragraphbreak />
Once you get the access token, you can call the server APIs using
the <functionlink>CallAPI</functionlink> function. Check the
<variablelink>access_token_error</variablelink> variable to
determine if there was an error when trying to to call the
API.<paragraphbreak />
If for some reason the user has revoked the access to your
application, you need to ask the user to authorize your application
again. First you may need to call the function
<functionlink>ResetAccessToken</functionlink> to reset the value of
the access token that may be cached in session variables.</usage>
</documentation>
{/metadocument}
*/
class oauth_client_class
{
/*
{metadocument}
<variable>
<name>error</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Store the message that is returned when an error
occurs.</purpose>
<usage>Check this variable to understand what happened when a call to
any of the class functions has failed.<paragraphbreak />
This class uses cumulative error handling. This means that if one
class functions that may fail is called and this variable was
already set to an error message due to a failure in a previous call
to the same or other function, the function will also fail and does
not do anything.<paragraphbreak />
This allows programs using this class to safely call several
functions that may fail and only check the failure condition after
the last function call.<paragraphbreak />
Just set this variable to an empty string to clear the error
condition.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $error = '';
/*
{metadocument}
<variable>
<name>debug</name>
<type>BOOLEAN</type>
<value>0</value>
<documentation>
<purpose>Control whether debug output is enabled</purpose>
<usage>Set this variable to <booleanvalue>1</booleanvalue> if you
need to check what is going on during calls to the class. When
enabled, the debug output goes either to the variable
<variablelink>debug_output</variablelink> and the PHP error log.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $debug = false;
/*
{metadocument}
<variable>
<name>display_debug</name>
<type>BOOLEAN</type>
<value>0</value>
<documentation>
<purpose>Control whether debug messages are displayed as part
of the current script output.</purpose>
<usage>Set this variable to <booleanvalue>1</booleanvalue> if
you need to see the debug messages output.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $display_debug = false;
/*
{metadocument}
<variable>
<name>debug_http</name>
<type>BOOLEAN</type>
<value>0</value>
<documentation>
<purpose>Control whether the dialog with the remote Web server
should also be logged.</purpose>
<usage>Set this variable to <booleanvalue>1</booleanvalue> if you
want to inspect the data exchange with the OAuth server.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $debug_http = false;
/*
{metadocument}
<variable>
<name>log_file_name</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Name of the file to store log messages</purpose>
<usage>Set this variable to the path of a file to which log messages
will be appended instead of sending to PHP error log when the
<variablelink>debug</variablelink> variable is set to
<booleanvalue>1</booleanvalue>.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $log_file_name = '';
/*
{metadocument}
<variable>
<name>exit</name>
<type>BOOLEAN</type>
<value>0</value>
<documentation>
<purpose>Determine if the current script should be exited.</purpose>
<usage>Check this variable after calling the
<functionlink>Process</functionlink> function and exit your script
immediately if the variable is set to
<booleanvalue>1</booleanvalue>.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $exit = false;
/*
{metadocument}
<variable>
<name>debug_output</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Capture the debug output generated by the class</purpose>
<usage>Inspect this variable if you need to see what happened during
the class function calls.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $debug_output = '';
/*
{metadocument}
<variable>
<name>debug_prefix</name>
<type>STRING</type>
<value>OAuth client: </value>
<documentation>
<purpose>Mark the lines of the debug output to identify actions
performed by this class.</purpose>
<usage>Change this variable if you prefer the debug output lines to
be prefixed with a different text.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $debug_prefix = 'OAuth client: ';
/*
{metadocument}
<variable>
<name>server</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Identify the type of OAuth server to access.</purpose>
<usage>The class provides built-in support to several types of OAuth
servers. This means that the class can automatically initialize
several configuration variables just by setting this server
variable.<paragraphbreak />
Currently it supports the following servers:
<stringvalue>37Signals</stringvalue>,
<stringvalue>Amazon</stringvalue>,
<stringvalue>AOL</stringvalue>,
<stringvalue>Bitbucket</stringvalue>,
<stringvalue>Bitly</stringvalue>,
<stringvalue>Box</stringvalue>,
<stringvalue>Buffer</stringvalue>,
<stringvalue>CharterSpectrum</stringvalue>,
<stringvalue>CharterSpectrumQA</stringvalue> (CharterSpectrum Quality Assurance),
<stringvalue>Copy</stringvalue>,
<stringvalue>Dailymotion</stringvalue>,
<stringvalue>Discogs</stringvalue>,
<stringvalue>Disqus</stringvalue>,
<stringvalue>Dropbox</stringvalue> (Dropbox with OAuth 1.0),
<stringvalue>Dropbox2</stringvalue> (Dropbox with OAuth 2.0),
<stringvalue>Etsy</stringvalue>,
<stringvalue>Eventful</stringvalue>,
<stringvalue>Facebook</stringvalue>,
<stringvalue>Fitbit</stringvalue>,
<stringvalue>Flickr</stringvalue>,
<stringvalue>Foursquare</stringvalue>,
<stringvalue>Garmin</stringvalue>,
<stringvalue>github</stringvalue>,
<stringvalue>Google</stringvalue>,
<stringvalue>Google1</stringvalue> (Google with OAuth 1.0),
<stringvalue>iHealth</stringvalue>,
<stringvalue>iHealthSandbox</stringvalue>,
<stringvalue>imgur</stringvalue>,
<stringvalue>Infusionsoft</stringvalue>,
<stringvalue>Instagram</stringvalue>,
<stringvalue>Intuit</stringvalue>,
<stringvalue>Jawbone</stringvalue>,
<stringvalue>LinkedIn</stringvalue>,
<stringvalue>LinkedIn2</stringvalue> (LinkedIn with OAuth 2.0),
<stringvalue>mail.ru</stringvalue>,
<stringvalue>MailChimp</stringvalue>,
<stringvalue>Mavenlink</stringvalue>,
<stringvalue>Meetup</stringvalue>,
<stringvalue>Microsoft</stringvalue>,
<stringvalue>Misfit</stringvalue>,
<stringvalue>oDesk</stringvalue>,
<stringvalue>Odnoklassniki</stringvalue>,
<stringvalue>Paypal</stringvalue>,
<stringvalue>PaypalApplication</stringvalue>,
<stringvalue>Pinterest</stringvalue>,
<stringvalue>Pipedrive</stringvalue>,
<stringvalue>Polar</stringvalue>,
<stringvalue>Quire</stringvalue>,
<stringvalue>Rdio</stringvalue>,
<stringvalue>Reddit</stringvalue>,
<stringvalue>RunKeeper</stringvalue>,
<stringvalue>Salesforce</stringvalue>,
<stringvalue>Scoop.it</stringvalue>,
<stringvalue>StockTwits</stringvalue>,
<stringvalue>SurveyMonkey</stringvalue>,
<stringvalue>TeamViewer</stringvalue>,
<stringvalue>Tumblr</stringvalue>,
<stringvalue>Twitter</stringvalue>,
<stringvalue>Vimeo</stringvalue>,
<stringvalue>VK</stringvalue>,
<stringvalue>Withings</stringvalue>,
<stringvalue>Wordpress</stringvalue>,
<stringvalue>Xero</stringvalue>,
<stringvalue>XING</stringvalue>,
<stringvalue>Yahoo</stringvalue>,
<stringvalue>Yahoo2</stringvalue>,
<stringvalue>Yammer</stringvalue> and
<stringvalue>Yandex</stringvalue>. Please contact the author if you
would like to ask to add built-in support for other types of OAuth
servers.<paragraphbreak />
If you want to access other types of OAuth servers that are not
yet supported, set this variable to an empty string and configure
other variables with values specific to those servers.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $server = '';
/*
{metadocument}
<variable>
<name>configuration_file</name>
<type>STRING</type>
<value>oauth_configuration.json</value>
<documentation>
<purpose>Specify the path of the configuration file that defines the
properties of additional OAuth server types.</purpose>
<usage>Change the path in this variable if you are accessing a type
of server without support built-in the class and you need to put
the configuration file path in a different directory.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $configuration_file = 'oauth_configuration.json';
/*
{metadocument}
<variable>
<name>request_token_url</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>URL of the OAuth server to request the initial token for
OAuth 1.0 and 1.0a servers.</purpose>
<usage>Set this variable to the OAuth request token URL when you are
not accessing one of the built-in supported OAuth
servers.<paragraphbreak />
For OAuth 1.0 and 1.0a servers, the request token URL can have
certain marks that will act as template placeholders which will be
replaced with given values before requesting the authorization
token. Currently it supports the following placeholder
marks:<paragraphbreak />
{SCOPE} - scope of the requested permissions to the granted by the
OAuth server with the user permissions</usage>
</documentation>
</variable>
{/metadocument}
*/
var $request_token_url = '';
/*
{metadocument}
<variable>
<name>dialog_url</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>URL of the OAuth server to redirect the browser so the user
can grant access to your application.</purpose>
<usage>Set this variable to the OAuth request token URL when you are
not accessing one of the built-in supported OAuth servers.<paragraphbreak />
For OAuth 1.0a servers that return the login dialog URL
automatically, set this variable to
<stringvalue>automatic</stringvalue><paragraphbreak />
For OAuth 1.0a servers that support 2 legged authentication set
this variable to <stringvalue>2legged</stringvalue><paragraphbreak />
For certain servers, the dialog URL can have certain marks that
will act as template placeholders which will be replaced with
values defined before redirecting the users browser. Currently it
supports the following placeholder marks:<paragraphbreak />
{REDIRECT_URI} - URL to redirect when returning from the OAuth
server authorization page<paragraphbreak />
{CLIENT_ID} - client application identifier registered at the
server<paragraphbreak />
{SCOPE} - scope of the requested permissions to the granted by the
OAuth server with the user permissions<paragraphbreak />
{STATE} - identifier of the OAuth session state<paragraphbreak />
{API_KEY} - API key to access the server<paragraphbreak />
{REALM} - realm name for OpenID Connect<paragraphbreak />
{NONCE} - unique identifier to made all redirects be unique for
OpenID Connect</usage>
</documentation>
</variable>
{/metadocument}
*/
var $dialog_url = '';
/*
{metadocument}
<variable>
<name>reauthenticate_dialog_url</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>URL of the OAuth server to redirect the browser so the user
can grant access to your application.</purpose>
<usage>Set this variable when forcing the user to authenticate again
and the format of the of the authorization dialog page URL is
different than the one set to the
<variablelink>dialog_url</variablelink> variable.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $reauthenticate_dialog_url = '';
/*
{metadocument}
<variable>
<name>pin_dialog_url</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>URL of the OAuth server to redirect the browser so the user
can grant access to your application.</purpose>
<usage>Set this variable when using the pin based authorization and
the format of the of the authorization dialog page URL is
different than the one set to the
<variablelink>dialog_url</variablelink> variable.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $pin_dialog_url = '';
/*
{metadocument}
<variable>
<name>offline_dialog_url</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>URL of the OAuth server to redirect the browser so the user
can grant access to your application when offline access is
requested.</purpose>
<usage>Set this variable to the OAuth request token URL when you are
not accessing one of the built-in supported OAuth servers and the
OAuth server supports offline access.<paragraphbreak />
It should have the same format as the
<variablelink>dialog_url</variablelink> variable.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $offline_dialog_url = '';
/*
{metadocument}
<variable>
<name>pin</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Value of the pin code for pin based authorization.</purpose>
<usage>Set this value to the pin informed by the user when
implementing the pin based authorization.<paragraphbreak />
Make sure the <variablelink>redirect_uri</variablelink> variable
is set to <stringvalue>oob</stringvalue>.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $pin = '';
/*
{metadocument}
<variable>
<name>append_state_to_redirect_uri</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Pass the OAuth session state in a variable with a different
name to work around implementation bugs of certain OAuth
servers</purpose>
<usage>Set this variable when you are not accessing one of the
built-in supported OAuth servers if the OAuth server has a bug
that makes it not pass back the OAuth state identifier in a
request variable named state.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $append_state_to_redirect_uri = '';
/*
{metadocument}
<variable>
<name>access_token_url</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>OAuth server URL that will return the access token
URL.</purpose>
<usage>Set this variable to the OAuth access token URL when you are
not accessing one of the built-in supported OAuth servers.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $access_token_url = '';
/*
{metadocument}
<variable>
<name>revoke_token_url</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>OAuth server URL that will revoke a previously obtain
token.</purpose>
<usage>Set this variable to the OAuth revoke token URL when you are
not accessing one of the built-in supported OAuth servers.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $revoke_token_url = '';
/*
{metadocument}
<variable>
<name>oauth_version</name>
<type>STRING</type>
<value>2.0</value>
<documentation>
<purpose>Version of the protocol version supported by the OAuth
server.</purpose>
<usage>Set this variable to the OAuth server protocol version when
you are not accessing one of the built-in supported OAuth
servers.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $oauth_version = '2.0';
/*
{metadocument}
<variable>
<name>url_parameters</name>
<type>BOOLEAN</type>
<value>0</value>
<documentation>
<purpose>Determine if the API call parameters should be moved to the
call URL.</purpose>
<usage>Set this variable to <booleanvalue>1</booleanvalue> if the
API you need to call requires that the call parameters always be
passed via the API URL.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $url_parameters = false;
/*
{metadocument}
<variable>
<name>authorization_header</name>
<type>BOOLEAN</type>
<value>1</value>
<documentation>
<purpose>Determine if the OAuth parameters should be passed via HTTP
Authorization request header.</purpose>
<usage>Set this variable to <booleanvalue>1</booleanvalue> if the
OAuth server requires that the OAuth parameters be passed using
the HTTP Authorization instead of the request URI parameters.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $authorization_header = true;
/*
{metadocument}
<variable>
<name>token_request_method</name>
<type>STRING</type>
<value>GET</value>
<documentation>
<purpose>Define the HTTP method that should be used to request
tokens from the server.</purpose>
<usage>Set this variable to <stringvalue>POST</stringvalue> if the
OAuth server does not support requesting tokens using the HTTP GET
method.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $token_request_method = 'GET';
/*
{metadocument}
<variable>
<name>signature_method</name>
<type>STRING</type>
<value>HMAC-SHA1</value>
<documentation>
<purpose>Define the method to generate the signature for API request
parameters values.</purpose>
<usage>Currently it supports <stringvalue>PLAINTEXT</stringvalue>
and <stringvalue>HMAC-SHA1</stringvalue>.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $signature_method = 'HMAC-SHA1';
/*
{metadocument}
<variable>
<name>redirect_uri</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>URL of the current script page that is calling this
class</purpose>
<usage>Set this variable to the current script page URL before
proceeding the OAuth authorization process.<paragraphbreak />
For pin based authorization, set this variable to
<stringvalue>oob</stringvalue>.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $redirect_uri = '';
/*
{metadocument}
<variable>
<name>client_id</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Identifier of your application registered with the OAuth
server</purpose>
<usage>Set this variable to the application identifier that is
provided by the OAuth server when you register the
application.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $client_id = '';
/*
{metadocument}
<variable>
<name>client_secret</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Secret value assigned to your application when it is
registered with the OAuth server.</purpose>
<usage>Set this variable to the application secret that is provided
by the OAuth server when you register the application.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $client_secret = '';
/*
{metadocument}
<variable>
<name>api_key</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Identifier of your API key provided by the OAuth
server</purpose>
<usage>Set this variable to the API key if the OAuth server requires
one.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $api_key = '';
/*
{metadocument}
<variable>
<name>get_token_with_api_key</name>
<type>BOOLEAN</type>
<value>0</value>
<documentation>
<purpose>Option to determine if the access token should be retrieved
using the API key value instead of the client secret.</purpose>
<usage>Set this variable to <booleanvalue>1</booleanvalue> if the
OAuth server requires that the client secret be set to the API key
when retrieving the OAuth token.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $get_token_with_api_key = false;
/*
{metadocument}
<variable>
<name>scope</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Permissions that your application needs to call the OAuth
server APIs</purpose>
<usage>Check the documentation of the APIs that your application
needs to call to set this variable with the identifiers of the
permissions that the user needs to grant to your application.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $scope = '';
/*
{metadocument}
<variable>
<name>realm</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Realm of authorization for OpenID Connect</purpose>
<usage>Set this variable to the realm value when using OpenID
Connect.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $realm = '';
/*
{metadocument}
<variable>
<name>offline</name>
<type>BOOLEAN</type>
<value>0</value>
<documentation>
<purpose>Specify whether it will be necessary to call the API when
the user is not present and the server supports renewing expired
access tokens using refresh tokens.</purpose>
<usage>Set this variable to <booleanvalue>1</booleanvalue> if the
server supports renewing expired tokens automatically when the
user is not present.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $offline = false;
/*
{metadocument}
<variable>
<name>reauthenticate</name>
<type>BOOLEAN</type>
<value>0</value>
<documentation>
<purpose>Specify whether it will be necessary to force the user to
authenticate again even after the user has already authorized the
application before.</purpose>
<usage>Set this variable to <booleanvalue>1</booleanvalue> if you
want to force the user to authenticate again.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $reauthenticate = false;
/*
{metadocument}
<variable>
<name>access_token</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Access token obtained from the OAuth server</purpose>
<usage>Check this variable to get the obtained access token upon
successful OAuth authorization.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $access_token = '';
/*
{metadocument}
<variable>
<name>access_token_secret</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Access token secret obtained from the OAuth server</purpose>
<usage>If the OAuth protocol version is 1.0 or 1.0a, check this
variable to get the obtained access token secret upon successful
OAuth authorization.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $access_token_secret = '';
/*
{metadocument}
<variable>
<name>access_token_expiry</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Timestamp of the expiry of the access token obtained from
the OAuth server.</purpose>
<usage>Check this variable to get the obtained access token expiry
time upon successful OAuth authorization. If this variable is
empty, that means no expiry time was set.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $access_token_expiry = '';
/*
{metadocument}
<variable>
<name>access_token_type</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Type of access token obtained from the OAuth server.</purpose>
<usage>Check this variable to get the obtained access token type
upon successful OAuth authorization.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $access_token_type = '';
/*
{metadocument}
<variable>
<name>default_access_token_type</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Type of access token to be assumed when the OAuth server
does not specify an access token type.</purpose>
<usage>Set this variable if the server requires a certain type of
access token to be used but it does not specify a token type
when the access token is returned.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $default_access_token_type = '';
/*
{metadocument}
<variable>
<name>access_token_content_type</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Content type to be assumed when retrieving the response to
a request to retrieve the access token.</purpose>
<usage>Set this variable only if the server does not return the
correct content type for the access token request response.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $access_token_content_type = '';
/*
{metadocument}
<variable>
<name>access_token_parameter</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Name of the access token parameter to be passed in API call
requests.</purpose>
<usage>Set this variable to a non-empty string to override the
default name for the access token parameter which is
<stringvalue>oauth_token</stringvalue> of OAuth 1 and
<stringvalue>access_token</stringvalue> for OAuth 2.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $access_token_parameter = '';
/*
{metadocument}
<variable>
<name>access_token_response</name>
<type>ARRAY</type>
<documentation>
<purpose>The original response for the access token request</purpose>
<usage>Check this variable if the OAuth server returns custom
parameters in the request to obtain the access token.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $access_token_response;
/*
{metadocument}
<variable>
<name>store_access_token_response</name>
<type>BOOLEAN</type>
<value>0</value>
<documentation>
<purpose>Option to determine if the original response for the access
token request should be stored in the
<variablelink>access_token_response</variablelink>
variable.</purpose>
<usage>Set this variable to <booleanvalue>1</booleanvalue> if the
OAuth server returns custom parameters in the request to obtain
the access token that may be needed in subsequent API calls.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $store_access_token_response = false;
/*
{metadocument}
<variable>
<name>access_token_authentication</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Option to determine if the requests to obtain a new access
token should use authentication to pass the application client ID
and secret.</purpose>
<usage>Set this variable to <stringvalue>basic</stringvalue> if the
OAuth server requires that the client ID and secret be passed
using HTTP basic authentication headers when retrieving a new
token. Set this variable to <stringvalue>none</stringvalue> to
avoid that the Authorization header be set in the request to get
the access token.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $access_token_authentication = '';
/*
{metadocument}
<variable>
<name>access_token_accept_content_type</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Option to determine if the content type value that
should be sent to the OAuth server when it requests the
access token.</purpose>
<usage>Set this variable to a specific content type if the
OAuth server requires that the
<stringvalue>Accept</stringvalue> header has a specific
value.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $access_token_accept_content_type = '';
/*
{metadocument}
<variable>
<name>refresh_token_authentication</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Option to determine if the requests to refresh an expired
access token should use authentication to pass the application
client ID and secret.</purpose>
<usage>Leave this value with an empty string to make it use the same
as the <variablelink>access_token_authentication</variablelink>
variable. Set this variable to <stringvalue>none</stringvalue> to
avoid that the Authorization header be set in the request to get
the refresh token.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $refresh_token_authentication = '';
/*
{metadocument}
<variable>
<name>refresh_token</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Refresh token obtained from the OAuth server</purpose>
<usage>Check this variable to get the obtained refresh token upon
successful OAuth authorization.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $refresh_token = '';
/*
{metadocument}
<variable>
<name>access_token_error</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Error message returned when a call to the API fails.</purpose>
<usage>Check this variable to determine if there was an error while
calling the Web services API when using the
<functionlink>CallAPI</functionlink> function.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $access_token_error = '';
/*
{metadocument}
<variable>
<name>authorization_error</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Error message returned when it was not possible to obtain
an OAuth access token</purpose>
<usage>Check this variable to determine if there was an error while
trying to obtain the OAuth access token.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $authorization_error = '';
/*
{metadocument}
<variable>
<name>id_token</name>
<type>OBJECT</type>
<documentation>
<purpose>The id_token value from OAuth servers compatible with
OpenID Connect.</purpose>
<usage>Check this variable if the OAuth server returns id_token
values.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $id_token;
/*
{metadocument}
<variable>
<name>response_status</name>
<type>INTEGER</type>
<value>0</value>
<documentation>
<purpose>HTTP response status returned by the server when calling an
API</purpose>
<usage>Check this variable after calling the
<functionlink>CallAPI</functionlink> function if the API calls and you
need to process the error depending the response status.
<integervalue>200</integervalue> means no error.
<integervalue>0</integervalue> means the server response was not
retrieved.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $response_status = 0;
/*
{metadocument}
<variable>
<name>response_headers</name>
<type>INTEGER</type>
<value>0</value>
<documentation>
<purpose>HTTP response headers returned by the server when calling an
API</purpose>
<usage>Check this variable after calling the
<functionlink>CallAPI</functionlink> function if the API calls and you
need to process the error depending the response headers.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $response_headers = array();
/*
{metadocument}
<variable>
<name>oauth_username</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Define the user name to obtain authorization using a password.</purpose>
<usage>Set this variable to the user name of the account to
authorize instead of going through the interactive user
authorization process.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $oauth_username = '';
/*
{metadocument}
<variable>
<name>oauth_password</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Define the user name to obtain authorization using a password.</purpose>
<usage>Set this variable to the user password of the account to
authorize instead of going through the interactive user
authorization process.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $oauth_password = '';
/*
{metadocument}
<variable>
<name>grant_type</name>
<type>STRING</type>
<value>authorization_code</value>
<documentation>
<purpose>Define the type of grant to obtain the OAuth 2 access
token.</purpose>
<usage>Change this variable to
<stringvalue>client_credentials</stringvalue> to obtain
application only access token.<paragraphbreak />
Change this variable to <stringvalue>password</stringvalue> to
obtain an access token on behalf of an user with a given username
and password specified by the
<variablelink>oauth_username</variablelink> and
<variablelink>oauth_password</variablelink> variables
respectively.<paragraphbreak />In this case the user does not need
to be present, so the class will not redirect the user to the
authorization dialog page.<paragraphbreak />
</usage>
</documentation>
</variable>
{/metadocument}
*/
var $grant_type = "authorization_code";
/*
{metadocument}
<variable>
<name>http_arguments</name>
<type>HASH</type>
<value></value>
<documentation>
<purpose>Define additional arguments to configure the HTTP
requests.</purpose>
<usage>Set this associative array with argument values that you need
to set options of the HTTP requests sent to the OAuth server and
API URLs.<paragraphbreak />
Check the documentation of the <link>
<data>HTTP client class</data>
<url>http://www.phpclasses.org/httpclient</url>
</link> for more
information on the available arguments that can be configured
using this option.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $http_arguments = array();
/*
{metadocument}
<variable>
<name>oauth_user_agent</name>
<type>STRING</type>
<value></value>
<documentation>
<purpose>Define user agente name used to send HTTP requests.</purpose>
<usage>Change this variable only if it is necessary that the
OAuth class sends requests to HTTP servers with a different
identification name.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $oauth_user_agent = 'PHP-OAuth-API (http://www.phpclasses.org/oauth-api $Revision: 1.187 $)';
/*
{metadocument}
<variable>
<name>session_cookie</name>
<type>STRING</type>
<value>oauth_session</value>
<documentation>
<purpose>Define the name of the cookie that the class uses to
store the PHP session name.</purpose>
<usage>Change this variable only if it is necessary that the
OAuth class uses a different cookie name to avoid
collision of names of cookies used for other purposes.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $session_cookie = 'oauth_session';
/*
{metadocument}
<variable>
<name>session_name_prefix</name>
<type>STRING</type>
<value>OAUTH_</value>
<documentation>
<purpose>Define the string that the class uses as prefix to
name PHP session variables.</purpose>
<usage>Change this variable only if it is necessary that the
OAuth class uses a different prefix string to avoid
collision of names of session variables used for other
purposes.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $session_name_prefix = 'OAUTH_';
var $response_time = 0;
var $session = '';
/*
{metadocument}
<variable>
<name>map_urls</name>
<type>ARRAY</type>
<value>_</value>
<documentation>
<purpose>Define a list of URLs that may need to be changed
replacing the beggining of the URL to another URL
beginning.</purpose>
<usage>Change this variable only if it is necessary that the
OAuth class replaces the beggining of the URLs of the
OAuth server or API calls.</usage>
</documentation>
</variable>
{/metadocument}
*/
var $map_urls = array();
Function ConvertObjectToArray($object)
{
$array = array();
foreach($object as $property => $value)
{
switch(GetType($value))
{
case 'object':
case 'array':
$array[$property] = $this->ConvertObjectToArray($value);
break;
default:
$array[$property] = $value;
}
}
return $array;
}
Function ISOTime($timestamp = null)
{
if(extension_loaded('Intl'))
{
$date = new DateTime();
if(IsSet($timestamp))
$date->setTimestamp($timestamp);
$time = $date->format('Y-m-d H:i:s');
}
else
{
if(!IsSet($timestamp))
$timestamp = time();
$time = gmstrftime('%Y-%m-%d %H:%M:%S', $timestamp);
}
return $time;
}
Function SetError($error)
{
$this->error = $error;
if($this->debug)
$this->OutputDebug('Error: '.$error);
return(false);
}
Function SetPHPError($error)
{
$e = error_get_last();
if(IsSet($e))
$error.=": ".$e['message'];
return($this->SetError($error));
}
Function OutputDebug($message)
{
if($this->debug)
{
$message = $this->debug_prefix.$message;
$this->debug_output .= $message."\n";
if(strlen($this->log_file_name))
error_log($message."\n", 3, $this->log_file_name);
elseif($this->display_debug)
echo wp_kses($message,WPJOBPORTAL_ALLOWED_TAGS)."\n";
else
error_log($message);
}
return(true);
}
Function SetupSession(&$session)
{
if(strlen($this->session)
|| IsSet($_COOKIE[$this->session_cookie]))
{
if($this->debug)
$this->OutputDebug(strlen($this->session) ? 'Checking OAuth session '.$this->session : 'Checking OAuth session from cookie '.$_COOKIE[$this->session_cookie]);
if(!$this->GetOAuthSession(strlen($this->session) ? $this->session : $_COOKIE[$this->session_cookie], $this->server, $session))
return($this->SetError('OAuth session error: '.$this->error));
}
else
{
if($this->debug)
$this->OutputDebug('No OAuth session is set');
$session = null;
}
if(!IsSet($session))
{
if($this->debug)
$this->OutputDebug('Creating a new OAuth session');
if(!$this->CreateOAuthSession($this->server, $session))
return($this->SetError('OAuth session error: '.$this->error));
SetCookie($this->session_cookie, $session->session, 0, $this->session_path);
}
$this->session = $session->session;
return true;
}
Function InitializeOAuthSession(&$session)
{
$session = new oauth_session_value_class;
$session->state = md5(time().wp_rand());
$session->session = md5($session->state.time().wp_rand());
$session->access_token = '';
$session->access_token_secret = '';
$session->authorized = null;
$session->expiry = null;
$session->type = '';
$session->server = $this->server;
$session->creation = $this->ISOTime();
$session->refresh_token = '';
$session->access_token_response = null;
}
Function GetRequestTokenURL(&$request_token_url)
{
$request_token_url = $this->request_token_url;
return(true);
}
Function GetDialogURL(&$url, $redirect_uri = '', $state = '')
{
$url = (($this->offline && strlen($this->offline_dialog_url)) ? $this->offline_dialog_url : (($redirect_uri === 'oob' && strlen($this->pin_dialog_url)) ? $this->pin_dialog_url : ($this->reauthenticate ? $this->reauthenticate_dialog_url : $this->dialog_url)));
if(strlen($url) === 0)
return $this->SetError('the dialog URL '.($this->offline ? 'for offline access ' : ($this->reauthenticate ? 'for reautentication' : '')).'is not defined for this server');
$url = str_replace(
'{NONCE}', UrlEncode(uniqid($state)), str_replace(
'{REDIRECT_URI}', UrlEncode($redirect_uri), str_replace(
'{STATE}', UrlEncode($state), str_replace(
'{CLIENT_ID}', UrlEncode($this->client_id), str_replace(
'{API_KEY}', UrlEncode($this->api_key), str_replace(
'{SCOPE}', UrlEncode($this->scope), str_replace(
'{REALM}', UrlEncode($this->realm),
$url)))))));
return(true);
}
Function GetAccessTokenURL(&$access_token_url)
{
$access_token_url = str_replace('{API_KEY}', $this->api_key, $this->access_token_url);
return(true);
}
Function GetRevokeTokenURL($token, &$revoke_token_url)
{
$revoke_token_url = str_replace('{TOKEN}', $token, $this->revoke_token_url);
return(true);
}
Function SessionStart()
{
if(!function_exists('session_start'))
return $this->SetError('Session variables are not accessible in this PHP environment');
if(version_compare(phpversion(), '5.4.0', '>='))
{
switch($session_status = session_status())
{
case PHP_SESSION_DISABLED:
return $this->SetError('PHP session support is disabled in this environment');
case PHP_SESSION_ACTIVE:
$session_active = true;
break;
case PHP_SESSION_NONE:
$session_active = false;
break;
default:
return $this->SetError($session_status.' is not yet a supported PHP session status value');
}
}
else
{
$session_active = (session_id() !== '');
}
if(!$session_active
&& !session_start())
return($this->SetPHPError('it was not possible to start the PHP session'));
return true;
}
Function GetStoredState(&$state)
{
if(!$this->SessionStart())
return false;
if(IsSet($_SESSION[$this->session_name_prefix.'STATE']))
$state = $_SESSION[$this->session_name_prefix.'STATE'];
else
$state = $_SESSION[$this->session_name_prefix.'STATE'] = time().'-'.substr(md5(wp_rand().time()), 0, 6);
return(true);
}
Function GetRequestState(&$state)
{
if(IsSet($_GET['error']))
{
if($this->debug)
$this->OutputDebug('it was returned the request state error '.$_GET['error']);
$state = null;
$this->error = $_GET['error'];
if(IsSet($_GET['error_description']))
$this->error .= ': '.$_GET['error_description'];
return false;
}
$check = (strlen($this->append_state_to_redirect_uri) ? $this->append_state_to_redirect_uri : 'state');
if($this->debug)
{
if(!IsSet($_GET[$check]))
$this->OutputDebug('The authentication state value was not passed by the OAuth server.');
}
$state = (IsSet($_GET[$check]) ? $_GET[$check] : null);
return(true);
}
Function GetRequestCode(&$code)
{
$code = (IsSet($_GET['code']) ? $_GET['code'] : null);
return(true);
}
Function GetRequestError(&$error)
{
$error = (IsSet($_GET['error']) ? $_GET['error'] : null);
return(true);
}
Function GetRequestDenied(&$denied)
{
$denied = (IsSet($_GET['denied']) ? $_GET['denied'] : null);
return(true);
}
Function GetRequestToken(&$token, &$verifier)
{
$token = (IsSet($_GET['oauth_token']) ? $_GET['oauth_token'] : null);
$verifier = (IsSet($_GET['oauth_verifier']) ? $_GET['oauth_verifier'] : null);
return(true);
}
Function GetRedirectURI(&$redirect_uri)
{
if(strlen($this->redirect_uri))
$redirect_uri = $this->redirect_uri;
else
$redirect_uri = ((IsSet($_SERVER['HTTP_HOST']) && IsSet($_SERVER['REQUEST_URI'])) ? '' : (IsSet($_SERVER['HTTPS']) ? 'https' : 'http').'://'.$_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI']);
return true;
}
/*
{metadocument}
<function>
<name>Redirect</name>
<type>VOID</type>
<documentation>
<purpose>Redirect the user browser to a given page.</purpose>
<usage>This function is meant to be only be called from inside the
class. By default it issues HTTP 302 response status and sets the
redirection location to a given URL. Sub-classes may override this
function to implement a different way to redirect the user
browser.</usage>
</documentation>
<argument>
<name>url</name>
<type>STRING</type>
<documentation>
<purpose>String with the full URL of the page to redirect.</purpose>
</documentation>
</argument>
<do>
{/metadocument}
*/
Function Redirect($url)
{
Header('HTTP/1.0 302 OAuth Redirection');
Header('Location: '.$url);
}
/*
{metadocument}
</do>
</function>
{/metadocument}
*/
/*
{metadocument}
<function>
<name>StoreAccessToken</name>
<type>BOOLEAN</type>
<documentation>
<purpose>Store the values of the access token when it is succefully
retrieved from the OAuth server.</purpose>
<usage>This function is meant to be only be called from inside the
class. By default it stores access tokens in a session variable
named <stringvalue>OAUTH_ACCESS_TOKEN</stringvalue>.<paragraphbreak />
Actual implementations should create a sub-class and override this
function to make the access token values be stored in other types
of containers, like for instance databases.</usage>
<returnvalue>This function should return
<booleanvalue>1</booleanvalue> if the access token was stored
successfully.</returnvalue>
</documentation>
<argument>
<name>access_token</name>
<type>HASH</type>
<documentation>
<purpose>Associative array with properties of the access token.
The array may have set the following
properties:<paragraphbreak />
<stringvalue>value</stringvalue>: string value of the access
token<paragraphbreak />
<stringvalue>authorized</stringvalue>: boolean value that
determines if the access token was obtained
successfully<paragraphbreak />
<stringvalue>expiry</stringvalue>: (optional) timestamp in ISO
format relative to UTC time zone of the access token expiry
time<paragraphbreak />
<stringvalue>type</stringvalue>: (optional) type of OAuth token
that may determine how it should be used when sending API call
requests.<paragraphbreak />
<stringvalue>refresh</stringvalue>: (optional) token that some
servers may set to allowing refreshing access tokens when they
expire.</purpose>
</documentation>
</argument>
<do>
{/metadocument}
*/
Function StoreAccessToken($access_token)
{
if(!function_exists('session_start'))
return $this->SetError('Session variables are not accessible in this PHP environment');
if(session_id() === ''
&& !session_start())
return($this->SetPHPError('it was not possible to start the PHP session'));
if(!$this->GetAccessTokenURL($access_token_url))
return false;
$_SESSION[$this->session_name_prefix.'ACCESS_TOKEN'][$access_token_url] = $access_token;
return true;
}
/*
{metadocument}
</do>
</function>
{/metadocument}
*/
/*
{metadocument}
<function>
<name>GetAccessToken</name>
<type>BOOLEAN</type>
<documentation>
<purpose>Retrieve the OAuth access token if it was already
previously stored by the
<functionlink>StoreAccessToken</functionlink> function.</purpose>
<usage>This function is meant to be only be called from inside the
class. By default it retrieves access tokens stored in a session
variable named
<stringvalue>OAUTH_ACCESS_TOKEN</stringvalue>.<paragraphbreak />
Actual implementations should create a sub-class and override this
function to retrieve the access token values from other types of
containers, like for instance databases.</usage>
<returnvalue>This function should return
<booleanvalue>1</booleanvalue> if the access token was retrieved
successfully.</returnvalue>
</documentation>
<argument>
<name>access_token</name>
<type>STRING</type>
<out />
<documentation>
<purpose>Return the properties of the access token in an
associative array. If the access token was not yet stored, it
returns an empty array. Otherwise, the properties it may return
are the same that may be passed to the
<functionlink>StoreAccessToken</functionlink>.</purpose>
</documentation>
</argument>
<do>
{/metadocument}
*/
Function GetAccessToken(&$access_token)
{
if(!function_exists('session_start'))
return $this->SetError('Session variables are not accessible in this PHP environment');
if(!$this->SessionStart())
return false;
if(!$this->GetAccessTokenURL($access_token_url))
return false;
if(IsSet($_SESSION[$this->session_name_prefix.'ACCESS_TOKEN'][$access_token_url]))
$access_token = $_SESSION[$this->session_name_prefix.'ACCESS_TOKEN'][$access_token_url];
else
$access_token = array();
return true;
}
/*
{metadocument}
</do>
</function>
{/metadocument}
*/
/*
{metadocument}
<function>
<name>ResetAccessToken</name>
<type>BOOLEAN</type>
<documentation>
<purpose>Reset the access token to a state back when the user has
not yet authorized the access to the OAuth server API.</purpose>
<usage>Call this function if for some reason the token to access
the API was revoked and you need to ask the user to authorize
the access again.<paragraphbreak />
By default the class stores and retrieves access tokens in a
session variable named
<stringvalue>OAUTH_ACCESS_TOKEN</stringvalue>.<paragraphbreak />
This function must be called when the user is accessing your site
pages, so it can reset the information stored in session variables
that cache the state of a previously retrieved access
token.<paragraphbreak />
Actual implementations should create a sub-class and override this
function to reset the access token state when it is stored in
other types of containers, like for instance databases.</usage>
<returnvalue>This function should return
<booleanvalue>1</booleanvalue> if the access token was resetted
successfully.</returnvalue>
</documentation>
<do>
{/metadocument}
*/
Function ResetAccessToken()
{
if(!$this->GetAccessTokenURL($access_token_url))
return false;
if($this->debug)
$this->OutputDebug('Resetting the access token status for OAuth server located at '.$access_token_url);
if(!$this->SessionStart())
return false;
Unset($_SESSION[$this->session_name_prefix.'ACCESS_TOKEN'][$access_token_url]);
UnSet($_SESSION[$this->session_name_prefix.'STATE']);
return true;
}
/*
{metadocument}
</do>
</function>
{/metadocument}
*/
Function Encode($value)
{
return(is_array($value) ? $this->EncodeArray($value) : str_replace('%7E', '~', str_replace('+',' ', RawURLEncode($value))));
}
Function EncodeArray($array)
{
foreach($array as $key => $value)
$array[$key] = $this->Encode($value);
return $array;
}
Function HMAC($function, $data, $key)
{
switch($function)
{
case 'sha1':
$pack = 'H40';
break;
default:
if($this->debug)
$this->OutputDebug($function.' is not a supported an HMAC hash type');
return('');
}
if(strlen($key) > 64)
$key = pack($pack, $function($key));
if(strlen($key) < 64)
$key = str_pad($key, 64, "\0");
return(pack($pack, $function((str_repeat("\x5c", 64) ^ $key).pack($pack, $function((str_repeat("\x36", 64) ^ $key).$data)))));
}
Function Sign(&$url, $method, $parameters, $oauth, $request_content_type, $has_files, $post_values_in_uri, &$authorization, &$post_values)
{
$values = array(
'oauth_consumer_key'=>$this->client_id,
'oauth_nonce'=>md5(uniqid(wp_rand(), true)),
'oauth_signature_method'=>$this->signature_method,
'oauth_timestamp'=>time(),
'oauth_version'=>'1.0',
);
if($has_files)
$value_parameters = array();
else
{
if(($this->url_parameters
|| $method !== 'POST')
&& $request_content_type === 'application/x-www-form-urlencoded'
&& count($parameters))
{
$first = (strpos($url, '?') === false);
foreach($parameters as $parameter => $value)
{
$url .= ($first ? '?' : '&').UrlEncode($parameter).'='.UrlEncode($value);
$first = false;
}
$parameters = array();
}
$value_parameters = (($request_content_type !== 'application/x-www-form-urlencoded') ? array() : $parameters);
}
$header_values = ($method === 'GET' ? array_merge($values, $oauth, $value_parameters) : array_merge($values, $oauth));
$values = array_merge($values, $oauth, $value_parameters);
$key = $this->Encode($this->client_secret).'&'.$this->Encode($this->access_token_secret);
switch($this->signature_method)
{
case 'PLAINTEXT':
$values['oauth_signature'] = $key;
break;
case 'HMAC-SHA1':
$uri = strtok($url, '?');
$sign = $method.'&'.$this->Encode($uri).'&';
$first = true;
$sign_values = $values;
$u = wp_parse_url($url);
if(IsSet($u['query']))
{
parse_str($u['query'], $q);
foreach($q as $parameter => $value)
$sign_values[$parameter] = $value;
}
KSort($sign_values);
foreach($sign_values as $parameter => $value)
{
$sign .= $this->Encode(($first ? '' : '&').$parameter.'='.$this->Encode($value));
$first = false;
}
$header_values['oauth_signature'] = $values['oauth_signature'] = base64_encode($this->HMAC('sha1', $sign, $key));
break;
default:
return $this->SetError($this->signature_method.' signature method is not yet supported');
}
if($this->authorization_header)
{
$authorization = 'OAuth';
$first = true;
foreach($header_values as $parameter => $value)
{
$authorization .= ($first ? ' ' : ',').$parameter.'="'.$this->Encode($value).'"';
$first = false;
}
$post_values = $parameters;
}
else
{
if($method !== 'POST'
|| $post_values_in_uri)
{
$first = (strcspn($url, '?') == strlen($url));
foreach($values as $parameter => $value)
{
$url .= ($first ? '?' : '&').$parameter.'='.$this->Encode($value);
$first = false;
}
$post_values = array();
}
else
$post_values = $values;
}
return true;
}
Function SendAPIRequest($url, $method, $parameters, $oauth, $options, &$response)
{
$this->response_status = 0;
$http = new http_class;
$http->debug = ($this->debug && $this->debug_http);
$http->log_debug = true;
$http->log_file_name = $this->log_file_name;
$http->sasl_authenticate = 0;
$http->user_agent = $this->oauth_user_agent;
$http->redirection_limit = (IsSet($options['FollowRedirection']) ? intval($options['FollowRedirection']) : 0);
$http->follow_redirect = ($http->redirection_limit != 0);
if($this->debug)
$this->OutputDebug('Accessing the '.$options['Resource'].' at '.$url);
$post_files = array();
$method = strtoupper($method);
$authorization = '';
$request_content_type = (IsSet($options['RequestContentType']) ? strtolower(trim(strtok($options['RequestContentType'], ';'))) : (($method === 'POST' || IsSet($oauth)) ? 'application/x-www-form-urlencoded' : ''));
$files = (IsSet($options['Files']) ? $options['Files'] : array());
if(count($files))
{
foreach($files as $name => $value)
{
if(!IsSet($parameters[$name]))
return($this->SetError('it was not specified a file parameter named '.$name));
$file = array();
$value_type = IsSet($value['Type']) ? $value['Type'] : 'FileName';
switch($value_type)
{
case 'FileName':
$file['FileName'] = $parameters[$name];
if(IsSet($value['FileName']))
$file['Name'] = $value['FileName'];
break;
case 'Data':
$file['Data'] = $parameters[$name];
if(!IsSet($value['FileName']))
return($this->SetError('it was not specified the file name for data file parameter '.$name));
$file['Name'] = $value['FileName'];
break;
default:
return($this->SetError($value_type.' is not a valid type for file '.$name));
}
$file['Content-Type'] = (IsSet($value['ContentType']) ? $value['ContentType'] : 'automatic/name');
$post_files[$name] = $file;
UnSet($parameters[$name]);
}
if($method !== 'POST')
{
$this->OutputDebug('For uploading files the method should be POST not '.$method);
$method = 'POST';
}
if($request_content_type !== 'multipart/form-data')
{
if(IsSet($options['RequestContentType']))
return($this->SetError('the request content type for uploading files should be multipart/form-data'));
$request_content_type = 'multipart/form-data';
}
}
if(IsSet($oauth))
{
if(!$this->Sign($url, $method, $parameters, $oauth, $request_content_type, count($files) !== 0, IsSet($options['PostValuesInURI']) && $options['PostValuesInURI'], $authorization, $post_values))
return false;
}
else
{
if(GetType($parameters) !== 'array')
{
if(GetType($parameters) !== 'object')
return $this->SetError('the parameters value for the '.$options['Resource'].' to '.$url.' is not an array');
if($this->debug)
$this->OutputDebug('the parameters value for the '.$options['Resource'].' to '.$url.' is not an array');
$parameters = (array)$parameters;
}
$post_values = $parameters;
if(count($parameters))
{
switch($request_content_type)
{
case 'application/x-www-form-urlencoded':
case 'multipart/form-data':
case 'application/json':
case 'application/javascript':
break;
default:
$first = (strpos($url, '?') === false);
foreach($parameters as $name => $value)
{
if(GetType($value) === 'array')
{
foreach($value as $index => $value)
{
$url .= ($first ? '?' : '&').$name.'='.UrlEncode($value);
$first = false;
}
}
else
{
$url .= ($first ? '?' : '&').$name.'='.UrlEncode($value);
$first = false;
}
}
}
}
}
if(strlen($authorization) === 0
&& !strcasecmp($this->access_token_type, 'Bearer'))
$authorization = 'Bearer '.$this->access_token;
$real_url = $url;
foreach($this->map_urls as $from => $to)
{
$f = strlen($from);
if(substr($real_url, 0, $f) === $from)
{
$mapped_url = $to.substr($real_url, $f);
if($this->debug)
{
$this->OutputDebug('The HTTP request URL '.$real_url.' was mapped to '.$mapped_url);
}
$real_url = $mapped_url;
}
}
if(strlen($error = $http->GetRequestArguments($real_url, $arguments)))
return($this->SetError('it was not possible to open the '.$options['Resource'].' URL: '.$error));
$arguments = array_merge($this->http_arguments, $arguments);
if(strlen($error = $http->Open($arguments)))
return($this->SetError('it was not possible to open the '.$options['Resource'].' URL: '.$error));
if(count($post_files))
$arguments['PostFiles'] = $post_files;
$arguments['RequestMethod'] = $method;
switch($request_content_type)
{
case 'application/x-www-form-urlencoded':
case 'multipart/form-data':
if(IsSet($options['RequestBody']))
return($this->SetError('the request body is defined automatically from the parameters'));
$arguments['PostValues'] = $post_values;
break;
case 'application/json':
case 'application/javascript':
$arguments['Headers']['Content-Type'] = $options['RequestContentType'];
$arguments['Body'] = (IsSet($options['RequestBody']) ? $options['RequestBody'] : wp_json_encode($parameters));
break;
default:
if(!IsSet($options['RequestBody']))
{
if(IsSet($options['RequestContentType']))
return($this->SetError('it was not specified the body value of the of the API call request'));
break;
}
$arguments['Headers']['Content-Type'] = $options['RequestContentType'];
$arguments['Body'] = $options['RequestBody'];
break;
}
$arguments['Headers']['Accept'] = (IsSet($options['Accept']) ? $options['Accept'] : '*/*');
switch($authentication = (IsSet($options['AccessTokenAuthentication']) ? strtolower($options['AccessTokenAuthentication']) : ''))
{
case 'basic':
$arguments['Headers']['Authorization'] = 'Basic '.base64_encode($this->client_id.':'.($this->get_token_with_api_key ? $this->api_key : $this->client_secret));
break;
case '':
if(strlen($authorization))
$arguments['Headers']['Authorization'] = $authorization;
break;
case 'none':
break;
default:
return($this->SetError($authentication.' is not a supported authentication mechanism to retrieve an access token'));
}
if(IsSet($options['RequestHeaders']))
$arguments['Headers'] = array_merge($arguments['Headers'], $options['RequestHeaders']);
if(strlen($error = $http->SendRequest($arguments))
|| strlen($error = $http->ReadReplyHeaders($headers)))
{
$http->Close();
return($this->SetError('it was not possible to retrieve the '.$options['Resource'].': '.$error));
}
$error = $http->ReadWholeReplyBody($data);
$http->Close();
if(strlen($error))
{
return($this->SetError('it was not possible to access the '.$options['Resource'].': '.$error));
}
$this->response_status = intval($http->response_status);
$this->response_headers = $headers;
$content_type = (IsSet($options['ResponseContentType']) ? $options['ResponseContentType'] : (IsSet($headers['content-type']) ? strtolower(trim(strtok($headers['content-type'], ';'))) : 'unspecified'));
$content_type = preg_replace('/^(.+\\/).+\\+(.+)$/', '\\1\\2', $content_type);
$this->response_time = (IsSet($headers['date']) ? strtotime(GetType($headers['date']) === 'array' ? $headers['date'][0] : $headers['date']) : time());
switch($content_type)
{
case 'text/javascript':
case 'application/json':
case 'application/javascript':
if(!function_exists('json_decode'))
return($this->SetError('the JSON extension is not available in this PHP setup'));
$object = json_decode($data);
switch(GetType($object))
{
case 'object':
if(!IsSet($options['ConvertObjects'])
|| !$options['ConvertObjects'])
$response = $object;
else
$response = $this->ConvertObjectToArray($object);
break;
case 'array':
$response = $object;
break;
default:
if(!IsSet($object))
return($this->SetError('it was not returned a valid JSON definition of the '.$options['Resource'].' values'));
$response = $object;
break;
}
break;
case 'application/x-json-access-token':
if($this->response_status < 200
|| $this->response_status >= 300)
return true;
if(!function_exists('json_decode'))
return($this->SetError('the JSON extension is not available in this PHP setup'));
$object = json_decode($data);
if(GetType($object) !== 'object')
return($this->SetError('the access token response is not in the JSON format'));
$response = array('response' => $object);
if(IsSet($object->access_token)
&& IsSet($object->access_token->token))
$response['access_token'] = $object->access_token->token;
break;
case 'application/x-www-form-urlencoded':
case 'text/plain':
case 'text/html':
parse_str($data, $response);
break;
case 'text/xml':
if(IsSet($options['DecodeXMLResponse']))
{
switch(strtolower($options['DecodeXMLResponse']))
{
case 'simplexml':
if($this->debug)
$this->OutputDebug('Decoding XML response with simplexml');
try
{
$response = @new SimpleXMLElement($data);
}
catch(Exception $exception)
{
return $this->SetError('Could not parse XML response: '.$exception->getMessage());
}
break 2;
default:
return $this->SetError($options['DecodeXML'].' is not a supported method to decode XML responses');
}
}
default:
$response = $data;
break;
}
if($this->response_status >= 200
&& $this->response_status < 300)
$this->access_token_error = '';
else
{
$this->access_token_error = 'it was not possible to access the '.$options['Resource'].': it was returned an unexpected response status '.$http->response_status.' Response: '.$data;
if($this->debug)
$this->OutputDebug('Could not retrieve the OAuth access token. Error: '.$this->access_token_error);
if(IsSet($options['FailOnAccessError'])
&& $options['FailOnAccessError'])
{
$this->error = $this->access_token_error;
return false;
}
}
return true;
}
Function ProcessToken1($oauth, &$access_token)
{
if(!$this->GetAccessTokenURL($url))
return false;
$options = array('Resource'=>'OAuth access token');
$method = strtoupper($this->token_request_method);
switch($method)
{
case 'GET':
break;
case 'POST':
$options['PostValuesInURI'] = true;
break;
default:
$this->error = $method.' is not a supported method to request tokens';
return false;
}
if(!$this->SendAPIRequest($url, $method, array(), $oauth, $options, $response))
return false;
if(strlen($this->access_token_error))
{
$this->authorization_error = $this->access_token_error;
return true;
}
if(!IsSet($response['oauth_token'])
|| !IsSet($response['oauth_token_secret']))
{
$this->authorization_error= 'it was not returned the access token and secret';
return true;
}
$access_token = array(
'value'=>$response['oauth_token'],
'secret'=>$response['oauth_token_secret'],
'authorized'=>true
);
if(IsSet($response['oauth_expires_in'])
&& $response['oauth_expires_in'] == 0)
{
if($this->debug)
$this->OutputDebug('Ignoring access token expiry set to 0');
$this->access_token_expiry = '';
}
elseif(IsSet($response['oauth_expires_in']))
{
$expires = $response['oauth_expires_in'];
if(strval($expires) !== strval(intval($expires))
|| $expires <= 0)
return($this->SetError('OAuth server did not return a supported type of access token expiry time'));
$this->access_token_expiry = $this->ISOTime($this->response_time + $expires);
if($this->debug)
$this->OutputDebug('Access token expiry: '.$this->access_token_expiry.' UTC');
$access_token['expiry'] = $this->access_token_expiry;
}
else
$this->access_token_expiry = '';
if(IsSet($response['oauth_session_handle']))
{
$access_token['refresh'] = $response['oauth_session_handle'];
if($this->debug)
$this->OutputDebug('Refresh token: '.$access_token['refresh']);
}
return $this->StoreAccessToken($access_token);
}
Function ProcessToken2($code, $refresh)
{
if(!$this->GetRedirectURI($redirect_uri))
return false;
$authentication = $this->access_token_authentication;
if(strlen($this->oauth_username))
{
$values = array(
'grant_type'=>'password',
'username'=>$this->oauth_username,
'password'=>$this->oauth_password,
'redirect_uri' => $redirect_uri
);
$authentication = 'Basic';
}
elseif($this->redirect_uri === 'oob'
&& strlen($this->pin))
{
$values = array(
'grant_type'=>'pin',
'pin'=>$this->pin,
'scope'=>$this->scope,
);
}
elseif($refresh)
{
$values = array(
'refresh_token'=>$this->refresh_token,
'grant_type'=>'refresh_token',
'scope'=>$this->scope,
);
if(strlen($this->refresh_token_authentication))
$authentication = $this->refresh_token_authentication;
}
else
{
switch($this->grant_type)
{
case 'password':
return $this->SetError('it was not specified the username for obtaining a password based OAuth 2 authorization');
case 'authorization_code':
$values = array(
'code'=>$code,
'redirect_uri'=>$redirect_uri,
'grant_type'=>'authorization_code'
);
break;
case 'client_credentials':
$values = array(
'grant_type'=>'client_credentials'
);
if($this->scope !== '')
$values['scope'] = $this->scope;
$authentication = 'Basic';
break;
default:
return $this->SetError($this->grant_type.' is not yet a supported OAuth 2 grant type');
}
}
$options = array(
'Resource'=>'OAuth '.($refresh ? 'refresh' : 'access').' token',
'ConvertObjects'=>true
);
switch(strtolower($authentication))
{
case 'basic':
case 'none':
$options['AccessTokenAuthentication'] = $authentication;
break;
case '':
$values['client_id'] = $this->client_id;
$values['client_secret'] = ($this->get_token_with_api_key ? $this->api_key : $this->client_secret);
break;
default:
return($this->SetError($authentication.' is not a supported authentication mechanism to retrieve an access token'));
}
if(!$this->GetAccessTokenURL($access_token_url))
return false;
if(strlen($this->access_token_content_type))
$options['ResponseContentType'] = $this->access_token_content_type;
if(strlen($this->access_token_accept_content_type))
$options['Accept'] = $this->access_token_accept_content_type;
if(!$this->SendAPIRequest($access_token_url, 'POST', $values, null, $options, $response))
return false;
if(strlen($this->access_token_error))
{
$this->authorization_error = $this->access_token_error;
return true;
}
$this->access_token = '';
if(IsSet($response[$name = 'access_token'])
|| IsSet($response[$name = 'AccessToken']))
$this->access_token = $response[$name];
if(IsSet($response['id_token']))
{
$jwt = base64_decode($response['id_token']);
if(!$jwt
|| !preg_match('/^((?U){[^}]+})((?U){[^}]+})?(.+)$/m', $jwt, $m)
|| !($header = json_decode($m[1]))
|| (strlen($m[2])
&& !($payload = json_decode($m[2]))))
{
if($this->debug)
$this->OutputDebug('it was returned an invalid JSON Web Token for the id_token');
}
else
{
if(strlen($m[2]))
{
$this->id_token = $payload;
}
}
}
if(strlen($this->access_token) === 0)
{
if(!IsSet($this->id_token))
{
if(IsSet($response['error']))
{
$this->authorization_error = 'it was not possible to retrieve the access token: it was returned the error: '.$response['error'];
return true;
}
return($this->SetError('OAuth server did not return the access token in the expected parameter'));
}
if($this->debug)
$this->OutputDebug('The OAuth server did not return an OAuth token but returned an id_token');
}
$access_token = array(
'value'=>$this->access_token,
'authorized'=>true,
);
if(IsSet($this->id_token))
$access_token['id_token'] = $this->id_token;
if($this->store_access_token_response)
$access_token['response'] = $this->access_token_response = $response;
if($this->debug)
$this->OutputDebug('Access token: '.(strlen($this->access_token) ? $this->access_token : 'Not retrieved'));
if(IsSet($response['expires_in'])
&& $response['expires_in'] == 0)
{
if($this->debug)
$this->OutputDebug('Ignoring access token expiry set to 0');
$this->access_token_expiry = '';
}
elseif((IsSet($response[$name = 'expires'])
|| IsSet($response[$name = 'Expires']))
|| IsSet($response['expires_in']))
{
$expires = (IsSet($response['expires_in']) ? $response['expires_in'] : $response[$name] - ($response[$name] > $this->response_time ? $this->response_time : 0));
if(strval($expires) !== strval(intval($expires))
|| $expires <= 0)
return($this->SetError('OAuth server did not return a supported type of access token expiry time'));
$this->access_token_expiry = $this->ISOTime($this->response_time + $expires);
if($this->debug)
$this->OutputDebug('Access token expiry: '.$this->access_token_expiry.' UTC');
$access_token['expiry'] = $this->access_token_expiry;
}
else
$this->access_token_expiry = '';
if(IsSet($response['token_type']))
{
$this->access_token_type = $response['token_type'];
if(strlen($this->access_token_type)
&& $this->debug)
$this->OutputDebug('Access token type: '.$this->access_token_type);
$access_token['type'] = $this->access_token_type;
}
else
{
$this->access_token_type = $this->default_access_token_type;
if(strlen($this->access_token_type)
&& $this->debug)
$this->OutputDebug('Assumed the default for OAuth access token type which is '.$this->access_token_type);
}
if(IsSet($response[$name = 'refresh_token'])
|| IsSet($response[$name = 'RefreshToken']))
{
$this->refresh_token = $response[$name];
if($this->debug)
$this->OutputDebug('Refresh token: '.$this->refresh_token);
$access_token['refresh'] = $this->refresh_token;
}
elseif(strlen($this->refresh_token))
{
if($this->debug)
$this->OutputDebug('Reusing previous refresh token: '.$this->refresh_token);
$access_token['refresh'] = $this->refresh_token;
}
return $this->StoreAccessToken($access_token);
}
Function RetrieveToken(&$valid)
{
$valid = false;
if(!$this->GetAccessToken($access_token))
return false;
if(IsSet($access_token['value']))
{
$this->access_token = $access_token['value'];
$this->access_token_expiry = '';
$expired = (IsSet($access_token['expiry']) && strcmp($this->access_token_expiry = $access_token['expiry'], $this->ISOTime()) < 0);
if($this->debug)
{
if($expired)
{
$this->OutputDebug('The OAuth access token expired on '.$this->access_token_expiry.' UTC');
$valid = false;
return true;
}
elseif(strlen($this->access_token))
{
$this->OutputDebug('The OAuth access token '.$this->access_token.' is valid');
if(strlen($this->access_token_expiry))
$this->OutputDebug('The OAuth access token expires on '.$this->access_token_expiry);
}
else
{
$this->OutputDebug('The OAuth access token value was not retrieved before.');
}
}
if(IsSet($access_token['type']))
{
$this->access_token_type = $access_token['type'];
if(strlen($this->access_token_type)
&& !$expired
&& $this->debug)
$this->OutputDebug('The OAuth access token is of type '.$this->access_token_type);
}
else
{
$this->access_token_type = $this->default_access_token_type;
if(strlen($this->access_token_type)
&& !$expired
&& $this->debug)
$this->OutputDebug('Assumed the default for OAuth access token type which is '.$this->access_token_type);
}
if(IsSet($access_token['secret']))
{
$this->access_token_secret = $access_token['secret'];
if($this->debug
&& !$expired
&& strlen($this->access_token_secret))
$this->OutputDebug('The OAuth access token secret is '.$this->access_token_secret);
}
if(IsSet($access_token['refresh']))
$this->refresh_token = $access_token['refresh'];
else
$this->refresh_token = '';
if(IsSet($access_token['id_token']))
$this->id_token = $access_token['id_token'];
else
$this->id_token = null;
$this->access_token_response = (($this->store_access_token_response && IsSet($access_token['response'])) ? $access_token['response'] : null);
$valid = true;
}
return true;
}
/*
{metadocument}
<function>
<name>CallAPI</name>
<type>BOOLEAN</type>
<documentation>
<purpose>Send a HTTP request to the Web services API using a
previously obtained authorization token via OAuth.</purpose>
<usage>This function can be used to call an API after having
previously obtained an access token through the OAuth protocol
using the <functionlink>Process</functionlink> function, or by
directly setting the variables
<variablelink>access_token</variablelink>, as well as
<variablelink>access_token_secret</variablelink> in case of using
OAuth 1.0 or 1.0a services.<paragraphbreak />
The <variablelink>response_status</variablelink> variable returns
the HTTP response status of the request.<paragraphbreak />
The <variablelink>response_headers</variablelink> variable returns
the HTTP the request response headers.</usage>
<returnvalue>This function returns <booleanvalue>1</booleanvalue> if
the call was done successfully.</returnvalue>
</documentation>
<argument>
<name>url</name>
<type>STRING</type>
<documentation>
<purpose>URL of the API where the HTTP request will be sent.</purpose>
</documentation>
</argument>
<argument>
<name>method</name>
<type>STRING</type>
<documentation>
<purpose>HTTP method that will be used to send the request. It can
be <stringvalue>GET</stringvalue>,
<stringvalue>POST</stringvalue>,
<stringvalue>DELETE</stringvalue>, <stringvalue>PUT</stringvalue>,
etc..</purpose>
</documentation>
</argument>
<argument>
<name>parameters</name>
<type>HASH</type>
<documentation>
<purpose>Associative array with the names and values of the API
call request parameters.</purpose>
</documentation>
</argument>
<argument>
<name>options</name>
<type>HASH</type>
<documentation>
<purpose>Associative array with additional options to configure
the request. Currently it supports the following
options:<paragraphbreak />
<stringvalue>2Legged</stringvalue>: boolean option that
determines if the API request should be 2 legged. The default
value is <tt><booleanvalue>0</booleanvalue></tt>.<paragraphbreak />
<stringvalue>Accept</stringvalue>: content type value of the
Accept HTTP header to be sent in the API call HTTP request.
Some APIs require that a certain value be sent to specify
which version of the API is being called. The default value is
<stringvalue>*/*</stringvalue>.<paragraphbreak />
<stringvalue>ConvertObjects</stringvalue>: boolean option that
determines if objects should be converted into arrays when the
response is returned in JSON format. The default value is
<booleanvalue>0</booleanvalue>.<paragraphbreak />
<stringvalue>DecodeXMLResponse</stringvalue>: name of the method
to decode XML responses. Currently only
<stringvalue>simplexml</stringvalue> is supported. It makes a
XML response be parsed and returned as a SimpleXMLElement
object.<paragraphbreak />
<stringvalue>FailOnAccessError</stringvalue>: boolean option
that determines if this functions should fail when the server
response status is not between 200 and 299. The default value
is <booleanvalue>0</booleanvalue>.<paragraphbreak />
<stringvalue>Files</stringvalue>: associative array with
details of the parameters that must be passed as file uploads.
The array indexes must have the same name of the parameters
to be sent as files. The respective array entry values must
also be associative arrays with the parameters for each file.
Currently it supports the following parameters:<paragraphbreak />
- <tt>Type</tt> - defines how the parameter value should be
treated. It can be <tt>'FileName'</tt> if the parameter value is
is the name of a local file to be uploaded. It may also be
<tt>'Data'</tt> if the parameter value is the actual data of
the file to be uploaded.<paragraphbreak />
Default: <tt>'FileName'</tt><paragraphbreak />
- <tt>FileName</tt> - defines a custom file name for the file
to be uploaded.<paragraphbreak />
Default: none<paragraphbreak />
- <tt>ContentType</tt> - MIME value of the content type of the
file. It can be <tt>'automatic/name'</tt> if the content type
should be determine from the file name extension.<paragraphbreak />
Default: <tt>'automatic/name'</tt><paragraphbreak />
<stringvalue>PostValuesInURI</stringvalue>: boolean option to
determine that a POST request should pass the request values
in the URI. The default value is
<booleanvalue>0</booleanvalue>.<paragraphbreak />
<stringvalue>FollowRedirection</stringvalue>: limit number of
times that HTTP response redirects will be followed. If it is
set to <integervalue>0</integervalue>, redirection responses
fail in error. The default value is
<integervalue>0</integervalue>.<paragraphbreak />
<stringvalue>RequestBody</stringvalue>: request body data of a
custom type. The <stringvalue>RequestContentType</stringvalue>
option must be specified, so the
<stringvalue>RequestBody</stringvalue> option is considered.<paragraphbreak />
<stringvalue>RequestContentType</stringvalue>: content type that
should be used to send the request values. It can be either
<stringvalue>application/x-www-form-urlencoded</stringvalue>
for sending values like from Web forms, or
<stringvalue>application/json</stringvalue> for sending the
values encoded in JSON format. Other types are accepted if the
<stringvalue>RequestBody</stringvalue> option is specified.
The default value is
<stringvalue>application/x-www-form-urlencoded</stringvalue>.<paragraphbreak />
<stringvalue>RequestHeaders</stringvalue>: associative array of
custom headers to be sent with the API call. These headers
override any values set by the class when sending the API
call HTTP request.<paragraphbreak />
<stringvalue>Resource</stringvalue>: string with a label that
will be used in the error messages and debug log entries to
identify what operation the request is performing. The default
value is <stringvalue>API call</stringvalue>.<paragraphbreak />
<stringvalue>ResponseContentType</stringvalue>: content type
that should be considered when decoding the API request
response. This overrides the <tt>Content-Type</tt> header
returned by the server. If the content type is
<stringvalue>application/x-www-form-urlencoded</stringvalue>
the function will parse the data returning an array of
key-value pairs. If the content type is
<stringvalue>application/json</stringvalue> the response will
be decode as a JSON-encoded data type. Other content type
values will make the function return the original response
value as it was returned from the server. The default value
for this option is to use what the server returned in the
<tt>Content-Type</tt> header.</purpose>
</documentation>
</argument>
<argument>
<name>response</name>
<type>STRING</type>
<out />
<documentation>
<purpose>Return the value of the API response. If the value is
JSON encoded, this function will decode it and return the value
converted to respective types. If the value is form encoded,
this function will decode the response and return it as an
array. Otherwise, the class will return the value as a
string.</purpose>
</documentation>
</argument>
<do>
{/metadocument}
*/
Function CallAPI($url, $method, $parameters, $options, &$response)
{
if(!IsSet($options['Resource']))
$options['Resource'] = 'API call';
if(!IsSet($options['ConvertObjects']))
$options['ConvertObjects'] = false;
$version = intval($this->oauth_version);
$two_legged = ($version === 1 && IsSet($options['2Legged']) && $options['2Legged']);
if(strlen($this->access_token) === 0
&& !$two_legged)
{
if(!$this->RetrieveToken($valid))
return false;
if(!$valid)
return $this->SetError('the access token for server '.$this->server.' is not set to a valid value');
}
switch($version)
{
case 1:
if(!$two_legged
&& strlen($this->access_token_expiry)
&& strcmp($this->access_token_expiry, $this->ISOTime()) <= 0)
{
if(strlen($this->refresh_token) === 0)
return($this->SetError('the access token expired and no refresh token is available'));
if($this->debug)
$this->OutputDebug('Refreshing the OAuth access token expired on '.$this->access_token_expiry);
$oauth = array(
'oauth_token'=>$this->access_token,
'oauth_session_handle'=>$this->refresh_token
);
if(!$this->ProcessToken1($oauth, $access_token))
return false;
if(IsSet($options['FailOnAccessError'])
&& $options['FailOnAccessError']
&& strlen($this->authorization_error))
{
$this->error = $this->authorization_error;
return false;
}
if(!IsSet($access_token['authorized'])
|| !$access_token['authorized'])
return($this->SetError('failed to obtain a renewed the expired access token'));
$this->access_token = $access_token['value'];
$this->access_token_secret = $access_token['secret'];
if(IsSet($access_token['refresh']))
$this->refresh_token = $access_token['refresh'];
}
$oauth = array();
if(!$two_legged)
$oauth[strlen($this->access_token_parameter) ? $this->access_token_parameter : 'oauth_token'] = $this->access_token;
break;
case 2:
if(strlen($this->access_token_expiry)
&& strcmp($this->access_token_expiry, $this->ISOTime()) <= 0)
{
if(strlen($this->refresh_token) === 0)
return($this->SetError('the access token expired and no refresh token is available'));
if($this->debug)
$this->OutputDebug('Refreshing the OAuth access token expired on '.$this->access_token_expiry);
if(!$this->ProcessToken2(null, true))
return false;
if(IsSet($options['FailOnAccessError'])
&& $options['FailOnAccessError']
&& strlen($this->authorization_error))
{
$this->error = $this->authorization_error;
return false;
}
}
$oauth = null;
if(strcasecmp($this->access_token_type, 'Bearer'))
$url .= (strcspn($url, '?') < strlen($url) ? '&' : '?').(strlen($this->access_token_parameter) ? $this->access_token_parameter : 'access_token').'='.UrlEncode($this->access_token);
break;
default:
return($this->SetError($this->oauth_version.' is not a supported version of the OAuth protocol'));
}
return($this->SendAPIRequest($url, $method, $parameters, $oauth, $options, $response));
}
/*
{metadocument}
</do>
</function>
{/metadocument}
*/
/*
{metadocument}
<function>
<name>Initialize</name>
<type>BOOLEAN</type>
<documentation>
<purpose>Initialize the class variables and internal state. It must
be called before calling other class functions.</purpose>
<usage>Set the <variablelink>server</variablelink> variable before
calling this function to let it initialize the class variables to
work with the specified server type. Alternatively, you can set
other class variables manually to make it work with servers that
are not yet built-in supported.</usage>
<returnvalue>This function returns <booleanvalue>1</booleanvalue> if
it was able to successfully initialize the class for the specified
server type.</returnvalue>
</documentation>
<do>
{/metadocument}
*/
Function Initialize()
{
if(strlen($this->server) === 0)
return true;
$this->oauth_version =
$this->dialog_url =
$this->reauthenticate_dialog_url =
$this->pin_dialog_url =
$this->access_token_url =
$this->revoke_token_url =
$this->request_token_url =
$this->append_state_to_redirect_uri = '';
$this->authorization_header = true;
$this->url_parameters = false;
$this->token_request_method = 'GET';
$this->signature_method = 'HMAC-SHA1';
$this->access_token_authentication = '';
$this->access_token_accept_content_type = '';
$this->access_token_parameter = '';
$this->default_access_token_type = '';
$this->store_access_token_response = false;
$this->refresh_token_authentication = '';
$this->grant_type = 'authorization_code';
$this->access_token_content_type = '';
switch($this->server)
{
case 'Facebook':
$this->oauth_version = '2.0';
$this->dialog_url = 'https://www.facebook.com/dialog/oauth?client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope={SCOPE}&state={STATE}';
$this->reauthenticate_dialog_url = 'https://www.facebook.com/dialog/oauth?client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope={SCOPE}&state={STATE}&auth_type=reauthenticate';
$this->access_token_url = 'https://graph.facebook.com/oauth/access_token';
break;
case 'github':
$this->oauth_version = '2.0';
$this->dialog_url = 'https://github.com/login/oauth/authorize?client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope={SCOPE}&state={STATE}';
$this->access_token_url = 'https://github.com/login/oauth/access_token';
break;
case 'Google':
$this->oauth_version = '2.0';
$this->dialog_url = 'https://accounts.google.com/o/oauth2/auth?response_type=code&client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope={SCOPE}&state={STATE}';
$this->offline_dialog_url = 'https://accounts.google.com/o/oauth2/auth?response_type=code&client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope={SCOPE}&state={STATE}&access_type=offline&approval_prompt=force';
$this->access_token_url = 'https://accounts.google.com/o/oauth2/token';
$this->revoke_token_url = 'https://accounts.google.com/o/oauth2/revoke';
break;
case 'LinkedIn':
$this->oauth_version = '1.0a';
$this->request_token_url = 'https://api.linkedin.com/uas/oauth/requestToken?scope={SCOPE}';
$this->dialog_url = 'https://api.linkedin.com/uas/oauth/authenticate';
$this->access_token_url = 'https://api.linkedin.com/uas/oauth/accessToken';
$this->url_parameters = true;
break;
case 'Microsoft':
$this->oauth_version = '2.0';
$this->dialog_url = 'https://login.live.com/oauth20_authorize.srf?client_id={CLIENT_ID}&scope={SCOPE}&response_type=code&redirect_uri={REDIRECT_URI}&state={STATE}';
$this->access_token_url = 'https://login.live.com/oauth20_token.srf';
break;
case 'Twitter':
$this->oauth_version = '1.0a';
$this->request_token_url = 'https://api.twitter.com/oauth/request_token';
$this->dialog_url = 'https://api.twitter.com/oauth/authenticate';
$this->access_token_url = 'https://api.twitter.com/oauth/access_token';
$this->url_parameters = false;
break;
case 'Twitter2':
$this->oauth_version = '2.0';
$this->request_token_url = 'https://api.twitter.com/oauth/request_token';
$this->dialog_url = 'https://api.twitter.com/oauth/authenticate';
$this->access_token_url = 'https://api.twitter.com/oauth/access_token';
$this->url_parameters = false;
break;
case 'Yahoo':
$this->oauth_version = '1.0a';
$this->request_token_url = 'https://api.login.yahoo.com/oauth/v2/get_request_token';
$this->dialog_url = 'https://api.login.yahoo.com/oauth/v2/request_auth';
$this->access_token_url = 'https://api.login.yahoo.com/oauth/v2/get_token';
$this->authorization_header = false;
break;
default:
$json = wp_remote_get($this->configuration_file);
if (is_wp_error($json)) {
if(!file_exists($this->configuration_file)){
return $this->SetError('the OAuth server configuration file '.$this->configuration_file.' does not exist');
}
return $this->SetPHPError('could not read the OAuth server configuration file '.$this->configuration_file);
}
$oauth_server = json_decode($json);
if(!IsSet($oauth_server))
return $this->SetPHPError('It was not possible to decode the OAuth server configuration file '.$this->configuration_file.' eventually due to incorrect format');
if(GetType($oauth_server) !== 'object')
return $this->SetError('It was not possible to decode the OAuth server configuration file '.$this->configuration_file.' because it does not correctly define a JSON object');
if(!IsSet($oauth_server->servers)
|| GetType($oauth_server->servers) !== 'object')
return $this->SetError('It was not possible to decode the OAuth server configuration file '.$this->configuration_file.' because it does not correctly define a JSON object for servers');
if(!IsSet($oauth_server->servers->{$this->server}))
return($this->SetError($this->server.' is not yet a supported type of OAuth server. Please send a request in this class support forum (preferred) http://www.phpclasses.org/oauth-api , or if it is a security or private matter, contact the author Manuel Lemos mlemos@acm.org to request adding built-in support to this type of OAuth server.'));
$properties = $oauth_server->servers->{$this->server};
if(GetType($properties) !== 'object')
return $this->SetError('The OAuth server configuration file '.$this->configuration_file.' for the "'.$this->server.'" server does not correctly define a JSON object');
$types = array(
'oauth_version'=>'string',
'request_token_url'=>'string',
'dialog_url'=>'string',
'reauthenticate_dialog_url'=>'string',
'pin_dialog_url'=>'string',
'offline_dialog_url'=>'string',
'access_token_url'=>'string',
'append_state_to_redirect_uri'=> 'string',
'authorization_header'=>'boolean',
'url_parameters' => 'boolean',
'token_request_method'=>'string',
'signature_method'=>'string',
'access_token_authentication'=>'string',
'access_token_accept_content_type'=>'string',
'access_token_parameter'=>'string',
'default_access_token_type'=>'string',
'store_access_token_response'=>'boolean',
'refresh_token_authentication'=>'string',
'grant_type'=>'string',
'access_token_content_type'=>'string',
'revoke_token_url'=>'string',
'oauth_user_agent'=>'string',
);
$required = array(
'oauth_version'=>array(),
'request_token_url'=>array('1.0', '1.0a'),
'dialog_url'=>array(),
'access_token_url'=>array(),
);
foreach($properties as $property => $value)
{
if(!IsSet($types[$property]))
return $this->SetError($property.' is not a supported property for the "'.$this->server.'" server in the OAuth server configuration file '.$this->configuration_file);
$type = GetType($value);
$expected = $types[$property];
if($type !== $expected)
return $this->SetError(' the property "'.$property.'" for the "'.$this->server.'" server is not of type "'.$expected.'", it is of type "'.$type.'", in the OAuth server configuration file '.$this->configuration_file);
$this->{$property} = $value;
UnSet($required[$property]);
}
foreach($required as $property => $value)
{
if(count($value)
&& in_array($this->oauth_version, $value))
return $this->SetError('the property "'.$property.'" is not defined for the "'.$this->server.'" server in the OAuth server configuration file '.$this->configuration_file);
}
break;
}
return(true);
}
/*
{metadocument}
</do>
</function>
{/metadocument}
*/
/*
{metadocument}
<function>
<name>CheckAccessToken</name>
<type>BOOLEAN</type>
<documentation>
<purpose>Check if the access token was retrieved and if it is
valid.</purpose>
<usage>Call this function when you need to check of an access token
is valid without forcing to redirect the user to the OAuth server
authorization page.<paragraphbreak />
If a previously retrieved access token has expired, this function
may renew it automatically.</usage>
<returnvalue>This function returns <booleanvalue>1</booleanvalue> if
the OAuth protocol was checked without errors.</returnvalue>
</documentation>
<argument>
<name>redirect_url</name>
<type>STRING</type>
<out />
<documentation>
<purpose>Return the URL of the OAuth server authorization to
redirect the user if the access token was not yet retrieved or
is not valid.</purpose>
</documentation>
</argument>
<do>
{/metadocument}
*/
Function CheckAccessToken(&$redirect_url)
{
$redirect_url = null;
if(strlen($this->access_token)
|| strlen($this->access_token_secret))
{
if($this->debug)
$this->OutputDebug('The Process function should not be called again if the OAuth token was already set manually');
return $this->SetError('the OAuth token was already set');
}
switch(intval($this->oauth_version))
{
case 1:
$one_a = ($this->oauth_version === '1.0a');
if($this->debug)
$this->OutputDebug('Checking the OAuth token authorization state');
if(!$this->GetAccessToken($access_token))
return false;
if(IsSet($access_token['expiry']))
$this->access_token_expiry = $access_token['expiry'];
if(IsSet($access_token['authorized'])
&& IsSet($access_token['value']))
{
$expired = (IsSet($access_token['expiry']) && strcmp($access_token['expiry'], $this->ISOTime()) <= 0);
if(!$access_token['authorized']
|| $expired)
{
if($this->debug)
{
if($expired)
$this->OutputDebug('The OAuth token expired on '.$access_token['expiry'].'UTC');
else
$this->OutputDebug('The OAuth token is not yet authorized');
}
if($one_a
&& $this->redirect_uri === 'oob'
&& strlen($this->pin))
{
if($this->debug)
$this->OutputDebug('Checking the pin');
$this->access_token_secret = $access_token['secret'];
$oauth = array(
'oauth_token'=>$access_token['value'],
'oauth_verifier'=>$this->pin
);
if(!$this->ProcessToken1($oauth, $access_token))
return false;
if($this->debug)
$this->OutputDebug('The OAuth token was authorized');
}
else
{
if($this->debug)
$this->OutputDebug('Checking the OAuth token and verifier');
if(!$this->GetRequestToken($token, $verifier))
return false;
if(!IsSet($token)
|| ($one_a
&& !IsSet($verifier)))
{
if(!$this->GetRequestDenied($denied))
return false;
if(IsSet($denied)
&& $denied === $access_token['value'])
{
if($this->debug)
$this->OutputDebug('The authorization request was denied');
$this->authorization_error = 'the request was denied';
return true;
}
else
{
if($this->debug)
$this->OutputDebug('Reset the OAuth token state because token and verifier are not both set');
$access_token = array();
}
}
elseif($token !== $access_token['value'])
{
if($this->debug)
$this->OutputDebug('Reset the OAuth token state because token does not match what as previously retrieved');
$access_token = array();
}
else
{
$this->access_token_secret = $access_token['secret'];
$oauth = array(
'oauth_token'=>$token,
);
if($one_a)
$oauth['oauth_verifier'] = $verifier;
if(!$this->ProcessToken1($oauth, $access_token))
return false;
if($this->debug)
$this->OutputDebug('The OAuth token was authorized');
}
}
}
elseif($this->debug)
$this->OutputDebug('The OAuth token was already authorized');
if(IsSet($access_token['authorized'])
&& $access_token['authorized'])
{
$this->access_token = $access_token['value'];
$this->access_token_secret = $access_token['secret'];
if(IsSet($access_token['refresh']))
$this->refresh_token = $access_token['refresh'];
return true;
}
}
else
{
if($this->debug)
$this->OutputDebug('The OAuth access token is not set');
$access_token = array();
}
if(!IsSet($access_token['authorized']))
{
if($this->debug)
$this->OutputDebug('Requesting the unauthorized OAuth token');
if(!$this->GetRequestTokenURL($url))
return false;
$url = str_replace('{SCOPE}', UrlEncode($this->scope), $url);
if(!$this->GetRedirectURI($redirect_uri))
return false;
$oauth = array(
'oauth_callback'=>$redirect_uri,
);
$options = array(
'Resource'=>'OAuth request token',
'FailOnAccessError'=>true
);
$method = strtoupper($this->token_request_method);
switch($method)
{
case 'GET':
break;
case 'POST':
$options['PostValuesInURI'] = true;
break;
default:
$this->error = $method.' is not a supported method to request tokens';
break;
}
if(!$this->SendAPIRequest($url, $method, array(), $oauth, $options, $response))
return false;
if(strlen($this->access_token_error))
{
$this->authorization_error = $this->access_token_error;
return true;
}
if(!IsSet($response['oauth_token'])
|| !IsSet($response['oauth_token_secret']))
{
$this->authorization_error = 'it was not returned the requested token';
return true;
}
$access_token = array(
'value'=>$response['oauth_token'],
'secret'=>$response['oauth_token_secret'],
'authorized'=>false
);
if(IsSet($response['login_url']))
$access_token['login_url'] = $response['login_url'];
if(!$this->StoreAccessToken($access_token))
return false;
}
if(!$this->GetRedirectURI($redirect_uri))
return false;
if(!$this->GetDialogURL($url, $redirect_uri))
return false;
switch($url)
{
case 'automatic':
if(!IsSet($access_token['login_url']))
return($this->SetError('The request token response did not automatically the login dialog URL as expected'));
if($this->debug)
$this->OutputDebug('Dialog URL obtained automatically from the request token response: '.$url);
$url = $access_token['login_url'];
break;
case '2legged':
if($this->debug)
$this->OutputDebug('Obtaining 2 legged access token');
$this->access_token_secret = $access_token['secret'];
$oauth = array(
'oauth_token'=>$access_token['value'],
);
if(!$this->ProcessToken1($oauth, $access_token))
return false;
if($this->debug)
$this->OutputDebug('The OAuth token was authorized');
return true;
default:
$url .= (strpos($url, '?') === false ? '?' : '&').'oauth_token='.$access_token['value'];
}
if(!$one_a)
{
if(!$this->GetRedirectURI($redirect_uri))
return false;
$url .= '&oauth_callback='.UrlEncode($redirect_uri);
}
$redirect_url = $url;
return true;
case 2:
if($this->debug)
{
if(!$this->GetAccessTokenURL($access_token_url))
return false;
$this->OutputDebug('Checking if OAuth access token was already retrieved from '.$access_token_url);
}
if(!$this->RetrieveToken($valid))
return false;
$expired = (strlen($this->access_token_expiry) && strcmp($this->access_token_expiry, $this->ISOTime()) <= 0 && strlen($this->refresh_token) === 0);
if($valid
&& !$expired)
return true;
if($this->debug)
{
if(!$valid)
$this->OutputDebug('A valid access token is not available');
elseif($expired)
$this->OutputDebug('The access token expired');
}
switch($this->grant_type)
{
case 'authorization_code':
if($this->redirect_uri === 'oob'
&& strlen($this->pin))
{
if($this->debug)
$this->OutputDebug('Getting the access token using the pin');
if(!$this->ProcessToken2(null, false))
return false;
if(strlen($this->authorization_error))
return $this->SetError($this->authorization_error);
return true;
}
elseif(strlen($this->oauth_username) === 0)
break;
case 'password':
if($this->debug)
$this->OutputDebug('Getting the access token using the username and password');
if(!$this->ProcessToken2(null, false))
return false;
if(strlen($this->authorization_error))
return $this->SetError($this->authorization_error);
return true;
case 'client_credentials':
if($this->debug)
$this->OutputDebug('Getting the access token using the client credentials');
if(!$this->ProcessToken2(null, false))
return false;
if(strlen($this->authorization_error))
return $this->SetError($this->authorization_error);
return true;
default:
return $this->SetError($this->grant_type.' is not yet a supported OAuth 2 grant type');
}
if($this->debug)
$this->OutputDebug('Getting the authentication state from URI '.(IsSet($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '"'.$this->redirect_uri.'"'));
if(!$this->GetStoredState($stored_state))
return false;
if(strlen($stored_state) == 0)
return($this->SetError('it was not set the OAuth state'));
if($this->debug)
$this->OutputDebug('Checking the authentication state');
if(!$this->GetRequestState($state))
return false;
if($state === $stored_state)
{
if($this->debug)
$this->OutputDebug('Checking the authentication code');
if(!$this->GetRequestCode($code))
return false;
if(strlen($code) == 0)
{
if(!$this->GetRequestError($this->authorization_error))
return false;
if(IsSet($this->authorization_error))
{
if($this->debug)
$this->OutputDebug('Authorization failed with error code '.$this->authorization_error);
switch($this->authorization_error)
{
case 'invalid_request':
case 'unauthorized_client':
case 'access_denied':
case 'unsupported_response_type':
case 'invalid_scope':
case 'server_error':
case 'temporarily_unavailable':
case 'user_denied':
return true;
default:
return($this->SetError('it was returned an unknown OAuth error code'));
}
}
return($this->SetError('it was not returned the OAuth dialog code'));
}
if(!$this->ProcessToken2($code, false))
return false;
if(strlen($this->authorization_error))
return $this->SetError($this->authorization_error);
}
else
{
if($this->debug)
{
if($stored_state !== '')
$this->OutputDebug('The authentication state is not valid.');
}
if(!$this->GetRedirectURI($redirect_uri))
return false;
if(strlen($this->append_state_to_redirect_uri))
$redirect_uri .= (strpos($redirect_uri, '?') === false ? '?' : '&').$this->append_state_to_redirect_uri.'='.$stored_state;
if(!$this->GetDialogURL($url, $redirect_uri, $stored_state))
return false;
if(strlen($url) == 0)
return($this->SetError('it was not set the OAuth dialog URL'));
$redirect_url = $url;
}
break;
default:
return($this->SetError($this->oauth_version.' is not a supported version of the OAuth protocol'));
}
return(true);
}
/*
{metadocument}
</do>
</function>
{/metadocument}
*/
/*
{metadocument}
<function>
<name>Process</name>
<type>BOOLEAN</type>
<documentation>
<purpose>Process the OAuth protocol interaction with the OAuth
server.</purpose>
<usage>Call this function when you need to retrieve the OAuth access
token. Check the <variablelink>access_token</variablelink> to
determine if the access token was obtained successfully.</usage>
<returnvalue>This function returns <booleanvalue>1</booleanvalue> if
the OAuth protocol was processed without errors.</returnvalue>
</documentation>
<do>
{/metadocument}
*/
Function Process()
{
if(!$this->CheckAccessToken($redirect_url))
return false;
if(IsSet($redirect_url))
{
if($this->debug)
$this->OutputDebug('Redirecting to OAuth Dialog '.$redirect_url);
$this->Redirect($redirect_url);
$this->exit = true;
}
return true;
}
/*
{metadocument}
</do>
</function>
{/metadocument}
*/
/*
{metadocument}
<function>
<name>RevokeToken</name>
<type>BOOLEAN</type>
<documentation>
<purpose>Revoke a previously obtained token so it becomes invalid.</purpose>
<usage>Call this function when you need to invalidate a token that
you no longer need to use, so it is not used by any other
application.</usage>
<returnvalue>This function returns <booleanvalue>1</booleanvalue> if
the OAuth protocol was revoked without errors.</returnvalue>
</documentation>
<argument>
<name>token_type_hint</name>
<type>STRING</type>
<defaultvalue>access_token</defaultvalue>
<documentation>
<purpose>Pass the type of token to be revoked if it is not an
access token.</purpose>
</documentation>
</argument>
<do>
{/metadocument}
*/
Function RevokeToken($token_type_hint = 'access_token')
{
switch($token_type_hint)
{
case 'access_token':
$token = $this->access_token;
break;
default:
return $this->SetError('Revoking tokens of type '.$token_type_hint.' is not yet supported');
}
if(!$this->GetRevokeTokenURL($token, $revoke_token_url))
return false;
if(strlen($revoke_token_url) === 0)
return $this->SetError('OAuth revoke token URL is not defined');
$parameters = array(
'token'=>$token,
'token_type_hint'=>$token_type_hint
);
$options = array(
'Resource'=>'OAuth revoke token',
'FailOnAccessError'=>true,
'AccessTokenAuthentication'=>'basic'
);
if($this->debug)
$this->OutputDebug('Revoking token of type '.$token_type_hint.': '.$token);
if(!$this->SendAPIRequest($revoke_token_url, 'POST', $parameters, null, $options, $response))
return false;
if($token_type_hint === 'access_token')
return $this->ResetAccessToken();
return true;
}
/*
{metadocument}
</do>
</function>
{/metadocument}
*/
/*
{metadocument}
<function>
<name>Finalize</name>
<type>BOOLEAN</type>
<documentation>
<purpose>Cleanup any resources that may have been used during the
OAuth protocol processing or execution of API calls.</purpose>
<usage>Always call this function as the last step after calling the
functions <functionlink>Process</functionlink> or
<functionlink>CallAPI</functionlink>.</usage>
<returnvalue>This function returns <booleanvalue>1</booleanvalue> if
the function cleaned up any resources successfully.</returnvalue>
</documentation>
<argument>
<name>success</name>
<type>BOOLEAN</type>
<documentation>
<purpose>Pass the last success state returned by the class or any
external code processing the class function results.</purpose>
</documentation>
</argument>
<do>
{/metadocument}
*/
Function Finalize($success)
{
return($success);
}
/*
{metadocument}
</do>
</function>
{/metadocument}
*/
/*
{metadocument}
<function>
<name>Output</name>
<type>VOID</type>
<documentation>
<purpose>Display the results of the OAuth protocol processing.</purpose>
<usage>Only call this function if you are debugging the OAuth
authorization process and you need to view what was its
results.</usage>
</documentation>
<do>
{/metadocument}
*/
Function Output()
{
if(strlen($this->authorization_error)
|| strlen($this->access_token_error)
|| strlen($this->access_token))
{
?>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>OAuth client result</title>
</head>
<body>
<h1>OAuth client result</h1>
<?php
if(strlen($this->authorization_error))
{
?>
<p>It was not possible to authorize the application.<?php
if($this->debug)
{
?>
<br>Authorization error: <?php echo wp_kses(HtmlSpecialChars($this->authorization_error),WPJOBPORTAL_ALLOWED_TAGS);
}
?></p>
<?php
}
elseif(strlen($this->access_token_error))
{
?>
<p>It was not possible to use the application access token.
<?php
if($this->debug)
{
?>
<br>Error: <?php echo wp_kses(HtmlSpecialChars($this->access_token_error),WPJOBPORTAL_ALLOWED_TAGS);
}
?></p>
<?php
}
elseif(strlen($this->access_token))
{
?>
<p>The application authorization was obtained successfully.
<?php
if($this->debug)
{
?>
<br>Access token: <?php echo wp_kses(HtmlSpecialChars($this->access_token),WPJOBPORTAL_ALLOWED_TAGS);
if(IsSet($this->access_token_secret))
{
?>
<br>Access token secret: <?php echo wp_kses(HtmlSpecialChars($this->access_token_secret),WPJOBPORTAL_ALLOWED_TAGS);
}
}
?></p>
<?php
if(strlen($this->access_token_expiry))
{
?>
<p>Access token expiry: <?php echo esc_html($this->access_token_expiry); ?> UTC</p>
<?php
}
}
?>
</body>
</html>
<?php
}
}
/*
{metadocument}
</do>
</function>
{/metadocument}
*/
};
/*
{metadocument}
</class>
{/metadocument}
*/
Sindbad File Manager Version 1.0, Coded By Sindbad EG ~ The Terrorists