dolibarr 21.0.0-alpha
stripetest_oauthcallback.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2022 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2015 Frederic France <frederic.france@free.fr>
4 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
26// Load Dolibarr environment
27require '../../../main.inc.php';
28require_once DOL_DOCUMENT_ROOT.'/includes/OAuth/bootstrap.php';
29use OAuth\Common\Storage\DoliStorage;
30use OAuth\Common\Consumer\Credentials;
31
32// Define $urlwithroot
33$urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($dolibarr_main_url_root));
34$urlwithroot = $urlwithouturlroot.DOL_URL_ROOT; // This is to use external domain name found into config file
35//$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current
36
37
38$action = GETPOST('action', 'aZ09');
39$backtourl = GETPOST('backtourl', 'alpha');
40$keyforprovider = GETPOST('keyforprovider', 'aZ09');
41if (empty($keyforprovider) && !empty($_SESSION["oauthkeyforproviderbeforeoauthjump"]) && (GETPOST('code') || $action == 'delete')) {
42 $keyforprovider = $_SESSION["oauthkeyforproviderbeforeoauthjump"];
43}
44
45
49$uriFactory = new \OAuth\Common\Http\Uri\UriFactory();
50//$currentUri = $uriFactory->createFromSuperGlobalArray($_SERVER);
51//$currentUri->setQuery('');
52$currentUri = $uriFactory->createFromAbsolute($urlwithroot.'/core/modules/oauth/stripetest_oauthcallback.php');
53
54$state = null;
55$apiService = null;
56
57
63$serviceFactory = new \OAuth\ServiceFactory();
64$httpClient = new \OAuth\Common\Http\Client\CurlClient();
65// TODO Set options for proxy and timeout
66// $params=array('CURLXXX'=>value, ...)
67//$httpClient->setCurlParameters($params);
68$serviceFactory->setHttpClient($httpClient);
69
70// Dolibarr storage
71$storage = new DoliStorage($db, $conf, $keyforprovider);
72
73// Setup the credentials for the requests
74$keyforparamid = 'OAUTH_STRIPETEST'.($keyforprovider ? '-'.$keyforprovider : '').'_ID';
75$keyforparamsecret = 'OAUTH_STRIPETEST'.($keyforprovider ? '-'.$keyforprovider : '').'_SECRET';
76$credentials = new Credentials(
77 getDolGlobalString($keyforparamid),
78 getDolGlobalString($keyforparamsecret),
79 $currentUri->getAbsoluteUri()
80);
81
82$requestedpermissionsarray = array();
83if (GETPOST('state')) {
84 $requestedpermissionsarray = explode(',', GETPOST('state')); // Example: 'userinfo_email,userinfo_profile,cloud_print'. 'state' parameter is standard to retrieve some parameters back
85}
86/*if ($action != 'delete' && empty($requestedpermissionsarray))
87{
88 print 'Error, parameter state is not defined';
89 exit;
90}*/
91//var_dump($requestedpermissionsarray);exit;
92
93// Instantiate the Api service using the credentials, http client and storage mechanism for the token
94//$apiService = $serviceFactory->createService('StripeTest', $credentials, $storage, $requestedpermissionsarray);
95
96$servicesuffix = ($keyforprovider ? '-'.$keyforprovider : '');
97$sql = "INSERT INTO ".MAIN_DB_PREFIX."oauth_token SET service = 'StripeTest".$db->escape($servicesuffix)."', entity = ".((int) $conf->entity);
98$db->query($sql);
99
100// access type needed to have oauth provider refreshing token
101//$apiService->setAccessType('offline');
102
103$langs->load("oauth");
104
105if (!getDolGlobalString($keyforparamid)) {
106 accessforbidden('Setup of service is not complete. Customer ID is missing');
107}
108if (!getDolGlobalString($keyforparamsecret)) {
109 accessforbidden('Setup of service is not complete. Secret key is missing');
110}
111
112
113/*
114 * Actions
115 */
116
117if ($action == 'delete' && (!empty($user->admin) || $user->id == GETPOSTINT('userid'))) {
118 $storage->userid = GETPOSTINT('userid');
119 $storage->clearToken('StripeTest');
120
121 setEventMessages($langs->trans('TokenDeleted'), null, 'mesgs');
122
123 header('Location: '.$backtourl);
124 exit();
125}
126
127if (GETPOST('code')) { // We are coming from oauth provider page
128 // We should have
129 //$_GET=array('code' => string 'aaaaaaaaaaaaaa' (length=20), 'state' => string 'user,public_repo' (length=16))
130
131 dol_syslog(basename(__FILE__)." We are coming from the oauth provider page code=".dol_trunc(GETPOST('code'), 5));
132
133 // This was a callback request from service, get the token
134 try {
135 '@phan-var-force OAuth\OAuth2\Service\AbstractService|OAuth\OAuth1\Service\AbstractService $apiService';
136 //var_dump($state);
137 //var_dump($apiService); // OAuth\OAuth2\Service\Stripe
138
139 //$token = $apiService->requestAccessToken(GETPOST('code'), $state);
140 $token = $apiService->requestAccessToken(GETPOST('code'));
141 // Stripe is a service that does not need state to be stored as second parameter of requestAccessToken
142
143 setEventMessages($langs->trans('NewTokenStored'), null, 'mesgs'); // Stored into object managed by class DoliStorage so into table oauth_token
144
145 $backtourl = $_SESSION["backtourlsavedbeforeoauthjump"];
146 unset($_SESSION["backtourlsavedbeforeoauthjump"]);
147
148 if (empty($backtourl)) {
149 $backtourl = DOL_URL_ROOT.'/';
150 }
151
152 header('Location: '.$backtourl);
153 exit();
154 } catch (Exception $e) {
155 print $e->getMessage();
156 }
157} else { // If entry on page with no parameter, we arrive here
158 $_SESSION["backtourlsavedbeforeoauthjump"] = $backtourl;
159 $_SESSION["oauthkeyforproviderbeforeoauthjump"] = $keyforprovider;
160 $_SESSION['oauthstateanticsrf'] = $state;
161
162 // This may create record into oauth_state before the header redirect.
163 // Creation of record with state in this tables depend on the Provider used (see its constructor).
164 if (GETPOST('state')) {
165 if (is_object($apiService)) { // @phpstan-ignore-line
166 '@phan-var-force OAuth\OAuth2\Service\AbstractService|OAuth\OAuth1\Service\AbstractService $apiService';
167 $url = $apiService->getAuthorizationUri(array('state' => GETPOST('state')));
168 } else {
169 $url = null;
170 }
171 } else {
172 //$url = $apiService->getAuthorizationUri(); // Parameter state will be randomly generated
173 //https://connect.stripe.com/oauth/authorize?response_type=code&client_id=ca_AX27ut70tJ1j6eyFCV3ObEXhNOo2jY6V&scope=read_write
174 $url = 'https://connect.stripe.com/oauth/authorize?response_type=code&client_id=' . getDolGlobalString($keyforparamid).'&scope=read_write';
175 }
176
177 if (empty($url)) {
178 $url = DOL_URL_ROOT.'/';
179 }
180
181 // we go on oauth provider authorization page
182 header('Location: '.$url);
183 exit();
184}
185
186
187/*
188 * View
189 */
190
191// No view at all, just actions
192
193$db->close();
setEventMessages($mesg, $mesgs, $style='mesgs', $messagekey='', $noduplicate=0, $attop=0)
Set event messages in dol_events session object.
GETPOSTINT($paramname, $method=0)
Return the value of a $_GET or $_POST supervariable, converted into integer.
GETPOST($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0)
Return value of a param into GET or POST supervariable.
dol_trunc($string, $size=40, $trunc='right', $stringencoding='UTF-8', $nodot=0, $display=0)
Truncate a string to a particular length adding '…' if string larger than length.
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
accessforbidden($message='', $printheader=1, $printfooter=1, $showonlymessage=0, $params=null)
Show a message to say access is forbidden and stop program.
if(empty($keyforprovider) &&!empty($_SESSION["oauthkeyforproviderbeforeoauthjump"]) &&(GETPOST('code')|| $action=='delete')) $uriFactory
Create a new instance of the URI class with the current URI, stripping the query string.