2 /*********************************************************************************
3 * SugarCRM Community Edition is a customer relationship management program developed by
4 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
6 * This program is free software; you can redistribute it and/or modify it under
7 * the terms of the GNU Affero General Public License version 3 as published by the
8 * Free Software Foundation with the addition of the following permission added
9 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
10 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
11 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
18 * You should have received a copy of the GNU Affero General Public License along with
19 * this program; if not, see http://www.gnu.org/licenses or write to the Free
20 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
24 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
26 * The interactive user interfaces in modified source and object code versions
27 * of this program must display Appropriate Legal Notices, as required under
28 * Section 5 of the GNU Affero General Public License version 3.
30 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
31 * these Appropriate Legal Notices must retain the display of the "Powered by
32 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
33 * technical reasons, the Appropriate Legal Notices must display the words
34 * "Powered by SugarCRM".
35 ********************************************************************************/
38 require_once('include/externalAPI/Base/ExternalAPIBase.php');
40 class OAuthPluginBase extends ExternalAPIBase implements ExternalOAuthAPIPlugin {
41 public $authMethod = 'oauth';
42 protected $oauthParams = array();
44 public function __construct()
46 $connector = $this->getConnector();
47 if(!empty($connector)) {
48 $cons_key = $connector->getProperty('oauth_consumer_key');
49 if(!empty($cons_key)) {
50 $this->oauthParams['consumerKey'] = $cons_key;
52 $cons_secret = $connector->getProperty('oauth_consumer_secret');
53 if(!empty($cons_secret)) {
54 $this->oauthParams['consumerSecret'] = $cons_secret;
60 * Load data from EAPM bean
61 * @see ExternalAPIBase::loadEAPM()
63 public function loadEAPM($eapmBean)
65 if ( !parent::loadEAPM($eapmBean) ) { return false; }
67 $this->oauth_token = $eapmBean->oauth_token;
68 $this->oauth_secret = $eapmBean->oauth_secret;
75 * @param EAPM $eapmBean
76 * @see ExternalAPIBase::checkLogin()
78 public function checkLogin($eapmBean = null)
80 $reply = parent::checkLogin($eapmBean);
81 if ( !$reply['success'] ) {
85 if ( $this->checkOauthLogin() ) {
86 return array('success' => true);
90 public function quickCheckLogin()
92 $reply = parent::quickCheckLogin();
94 if ( !$reply['success'] ) {
98 if ( !empty($this->oauth_token) && !empty($this->oauth_secret) ) {
99 return array('success'=>true);
101 return array('success'=>false,'errorMessage'=>translate('LBL_ERR_NO_TOKEN','EAPM'));
105 protected function checkOauthLogin()
107 if ( empty($this->oauth_token) || empty($this->oauth_secret) ) {
108 return $this->oauthLogin();
114 public function getOauthParams()
116 return $this->getValue("oauthParams");
119 public function getOauthRequestURL()
121 return $this->getValue("oauthReq");
124 public function getOauthAuthURL()
126 return $this->getValue("oauthAuth");
129 public function getOauthAccessURL()
131 return $this->getValue("oauthAccess");
138 public function getOauth()
141 $oauth = new SugarOAuth($this->oauthParams['consumerKey'], $this->oauthParams['consumerSecret'], $this->getOauthParams());
143 if ( isset($this->oauth_token) && !empty($this->oauth_token) ) {
144 $oauth->setToken($this->oauth_token, $this->oauth_secret);
150 public function oauthLogin()
152 global $sugar_config;
153 $oauth = $this->getOauth();
154 if(isset($_SESSION['eapm_oauth_secret']) && isset($_SESSION['eapm_oauth_token']) && isset($_REQUEST['oauth_token']) && isset($_REQUEST['oauth_verifier'])) {
160 $oauthReq = $this->getOauthRequestURL();
161 $callback_url = $sugar_config['site_url'].'/index.php?module=EAPM&action=oauth&record='.$this->eapmBean->id;
162 $callback_url = $this->formatCallbackURL($callback_url);
164 $GLOBALS['log']->debug("OAuth request token: {$oauthReq} callback: $callback_url");
166 $request_token_info = $oauth->getRequestToken($oauthReq, $callback_url);
168 $GLOBALS['log']->debug("OAuth token: ".var_export($request_token_info, true));
170 if(empty($request_token_info['oauth_token_secret']) || empty($request_token_info['oauth_token'])){
173 // FIXME: error checking here
174 $_SESSION['eapm_oauth_secret'] = $request_token_info['oauth_token_secret'];
175 $_SESSION['eapm_oauth_token'] = $request_token_info['oauth_token'];
176 $authReq = $this->getOauthAuthURL();
177 SugarApplication::redirect("{$authReq}?oauth_token={$request_token_info['oauth_token']}");
180 $accReq = $this->getOauthAccessURL();
181 $oauth->setToken($_SESSION['eapm_oauth_token'],$_SESSION['eapm_oauth_secret']);
182 $GLOBALS['log']->debug("OAuth access token: {$accReq}");
183 $access_token_info = $oauth->getAccessToken($accReq);
184 $GLOBALS['log']->debug("OAuth token: ".var_export($access_token_info, true));
185 // FIXME: error checking here
186 $this->oauth_token = $access_token_info['oauth_token'];
187 $this->oauth_secret = $access_token_info['oauth_token_secret'];
188 $this->eapmBean->oauth_token = $this->oauth_token;
189 $this->eapmBean->oauth_secret = $this->oauth_secret;
190 $oauth->setToken($this->oauth_token, $this->oauth_secret);
191 $this->eapmBean->validated = 1;
192 $this->eapmBean->save();
193 unset($_SESSION['eapm_oauth_token']);
194 unset($_SESSION['eapm_oauth_secret']);