0
0
mirror of https://github.com/salesagility/SuiteCRM.git synced 2024-11-21 15:37:57 +00:00
salesagility_SuiteCRM/include/SugarOauth.php
2023-07-18 15:53:09 +01:00

246 lines
8.7 KiB
PHP
Executable File

<?php
/**
*
* SugarCRM Community Edition is a customer relationship management program developed by
* SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
*
* SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
* Copyright (C) 2011 - 2018 SalesAgility Ltd.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License version 3 as published by the
* Free Software Foundation with the addition of the following permission added
* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
* IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License along with
* this program; if not, see http://www.gnu.org/licenses or write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
*
* You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
* SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
*
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
* SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
* reasonably feasible for technical reasons, the Appropriate Legal Notices must
* display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
*/
// use ZF oauth
/**
* Sugar Oauth consumer
* @api
*/
#[\AllowDynamicProperties]
class SugarOAuth extends Zend_Oauth_Consumer
{
protected $_last = '';
protected $_oauth_config = array();
/**
* Create OAuth client
* @param string $consumer_key
* @param string $consumer_secret
* @param array $params OAuth options
*/
public function __construct($consumer_key, $consumer_secret, $params = null)
{
$this->_oauth_config = array(
'consumerKey' => $consumer_key,
'consumerSecret' => $consumer_secret,
);
if (!empty($params)) {
$this->_oauth_config = array_merge($this->_oauth_config, $params);
}
parent::__construct($this->_oauth_config);
}
/**
* Enable debugging
* @return SugarOAuth
*/
public function enableDebug()
{
return $this;
}
/**
* Set token
* @param string $token
* @param string $secret
*/
public function setToken($token, $secret)
{
$this->token = array($token, $secret);
}
/**
* Create request token object for current token
* @return Zend_Oauth_Token_Request
*/
public function makeRequestToken()
{
$token = new Zend_Oauth_Token_Request();
$token->setToken($this->token[0]);
$token->setTokenSecret($this->token[1]);
return $token;
}
/**
* Create access token object for current token
* @return Zend_Oauth_Token_Access
*/
public function makeAccessToken()
{
$token = new Zend_Oauth_Token_Access();
$token->setToken($this->token[0]);
$token->setTokenSecret($this->token[1]);
return $token;
}
/**
* Retrieve request token from URL
* @param string $url
* @param string $callback Callback URL
* @param array $params Query params
* @return array
* @see Zend_Oauth_Consumer::getRequestToken()
*/
public function getRequestTokenByUrl($url, $callback = null, $params = array())
{
if (!empty($callback)) {
$this->setCallbackUrl($callback);
}
list($clean_url, $query) = explode('?', $url);
if ($query) {
$url = $clean_url;
parse_str($query, $query_params);
$params = array_merge($params, $query_params);
}
$this->setRequestTokenUrl($url);
try {
$this->_last = $token = parent::getRequestToken($params);
return array('oauth_token' => $token->getToken(), 'oauth_token_secret' => $token->getTokenSecret());
} catch (Zend_Oauth_Exception $e) {
return array('oauth_token' => '', 'oauth_token_secret' => '');
}
}
/**
* Retrieve access token from url
* @param string $url
* @see Zend_Oauth_Consumer::getAccessToken()
* @return array
*/
public function getAccessToken(
$url,
Zend_Oauth_Token_Request $token = null,
$httpMethod = null,
Zend_Oauth_Http_AccessToken $request = null
) {
$this->setAccessTokenUrl($url);
$this->_last = $token = parent::getAccessToken($_REQUEST, $this->makeRequestToken());
return array('oauth_token' => $token->getToken(), 'oauth_token_secret' => $token->getTokenSecret());
}
/**
* Fetch URL with OAuth
* @param string $url
* @param string $params Query params
* @param string $method HTTP method
* @param array $headers HTTP headers
* @return string
*/
public function fetch($url, $params = null, $method = 'GET', $headers = null)
{
$acc = $this->makeAccessToken();
if (strpos($url, '?')) {
list($clean_url, $query) = explode('?', $url);
if ($query) {
$url = $clean_url;
parse_str($query, $query_params);
$params = array_merge($params?$params:array(), $query_params);
}
}
$client = $acc->getHttpClient($this->_oauth_config, $url);
Zend_Loader::loadClass('Zend_Http_Client_Adapter_Proxy');
$proxy_config = SugarModule::get('Administration')->loadBean();
$proxy_config->retrieveSettings('proxy');
if (!empty($proxy_config) &&
!empty($proxy_config->settings['proxy_on']) &&
$proxy_config->settings['proxy_on'] == 1) {
$proxy_settings = array();
$proxy_settings['proxy_host'] = $proxy_config->settings['proxy_host'];
$proxy_settings['proxy_port'] = $proxy_config->settings['proxy_port'];
if (!empty($proxy_config->settings['proxy_auth'])) {
$proxy_settings['proxy_user'] = $proxy_config->settings['proxy_username'];
$proxy_settings['proxy_pass'] = $proxy_config->settings['proxy_password'];
}
$adapter = new Zend_Http_Client_Adapter_Proxy();
$adapter->setConfig($proxy_settings);
$client->setAdapter($adapter);
}
$client->setMethod($method);
if (!empty($headers)) {
$client->setHeaders($headers);
}
if (!empty($params)) {
if ($method == 'GET') {
$client->setParameterGet($params);
} else {
$client->setParameterPost($params);
}
}
$this->_last = $resp = $client->request();
$this->_lastReq = $client->getLastRequest();
return $resp->getBody();
}
/**
* Get HTTP client
* @return Zend_Oauth_Client
*/
public function getClient()
{
$acc = $this->makeAccessToken();
return $acc->getHttpClient($this->_oauth_config);
}
/**
* Get last response
* @return string
*/
public function getLastResponse()
{
return $this->_last;
}
/**
* Get last request
* @return string
*/
public function getLastRequest()
{
return $this->_lastReq;
}
}