dolibarr  7.0.0-beta
github_oauthcallback.php
Go to the documentation of this file.
1 <?php
2 /*
3  * Copyright (C) 2015 Frederic France <frederic.france@free.fr>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  */
18 
25 require '../../../main.inc.php';
26 require_once DOL_DOCUMENT_ROOT.'/includes/OAuth/bootstrap.php';
27 use OAuth\Common\Storage\DoliStorage;
28 use OAuth\Common\Consumer\Credentials;
29 use OAuth\OAuth2\Service\GitHub;
30 
31 // Define $urlwithroot
32 $urlwithouturlroot=preg_replace('/'.preg_quote(DOL_URL_ROOT,'/').'$/i','',trim($dolibarr_main_url_root));
33 $urlwithroot=$urlwithouturlroot.DOL_URL_ROOT; // This is to use external domain name found into config file
34 //$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current
35 
36 
37 
38 $action = GETPOST('action', 'alpha');
39 $backtourl = GETPOST('backtourl', 'alpha');
40 
41 
45 $uriFactory = new \OAuth\Common\Http\Uri\UriFactory();
46 //$currentUri = $uriFactory->createFromSuperGlobalArray($_SERVER);
47 //$currentUri->setQuery('');
48 $currentUri = $uriFactory->createFromAbsolute($urlwithroot.'/core/modules/oauth/github_oauthcallback.php');
49 
50 
56 $serviceFactory = new \OAuth\ServiceFactory();
57 $httpClient = new \OAuth\Common\Http\Client\CurlClient();
58 // TODO Set options for proxy and timeout
59 // $params=array('CURLXXX'=>value, ...)
60 //$httpClient->setCurlParameters($params);
61 $serviceFactory->setHttpClient($httpClient);
62 
63 // Dolibarr storage
64 $storage = new DoliStorage($db, $conf);
65 
66 // Setup the credentials for the requests
67 $credentials = new Credentials(
68  $conf->global->OAUTH_GITHUB_ID,
69  $conf->global->OAUTH_GITHUB_SECRET,
70  $currentUri->getAbsoluteUri()
71 );
72 
73 $requestedpermissionsarray=array();
74 if (GETPOST('state')) $requestedpermissionsarray=explode(',', GETPOST('state')); // Example: 'userinfo_email,userinfo_profile,cloud_print'. 'state' parameter is standard to retrieve some parameters back
75 if ($action != 'delete' && empty($requestedpermissionsarray))
76 {
77  print 'Error, parameter state is not defined';
78  exit;
79 }
80 //var_dump($requestedpermissionsarray);exit;
81 
82 // Instantiate the Api service using the credentials, http client and storage mechanism for the token
84 $apiService = $serviceFactory->createService('GitHub', $credentials, $storage, $requestedpermissionsarray);
85 
86 // access type needed to have oauth provider refreshing token
87 //$apiService->setAccessType('offline');
88 
89 $langs->load("oauth");
90 
91 
92 /*
93  * Actions
94  */
95 
96 
97 if ($action == 'delete')
98 {
99  $storage->clearToken('GitHub');
100 
101  setEventMessages($langs->trans('TokenDeleted'), null, 'mesgs');
102 
103  header('Location: ' . $backtourl);
104  exit();
105 }
106 
107 if (! empty($_GET['code'])) // We are coming from oauth provider page
108 {
109  // We should have
110  //$_GET=array('code' => string 'aaaaaaaaaaaaaa' (length=20), 'state' => string 'user,public_repo' (length=16))
111 
112  dol_syslog("We are coming fr mthe oauth provider page");
113  //llxHeader('',$langs->trans("OAuthSetup"));
114 
115  //$linkback='<a href="'.DOL_URL_ROOT.'/admin/modules.php">'.$langs->trans("BackToModuleList").'</a>';
116  //print load_fiche_titre($langs->trans("OAuthSetup"),$linkback,'title_setup');
117 
118  //dol_fiche_head();
119  // retrieve the CSRF state parameter
120  $state = isset($_GET['state']) ? $_GET['state'] : null;
121  //print '<table>';
122 
123  // This was a callback request from service, get the token
124  try {
125  //var_dump($_GET['code']);
126  //var_dump($state);
127  //var_dump($apiService); // OAuth\OAuth2\Service\GitHub
128 
129  //$token = $apiService->requestAccessToken($_GET['code'], $state);
130  $token = $apiService->requestAccessToken($_GET['code']);
131  // Github is a service that does not need state to be stored.
132  // Into constructor of GitHub, the call
133  // parent::__construct($credentials, $httpClient, $storage, $scopes, $baseApiUri)
134  // has not the ending parameter to true like the Google class constructor.
135 
136  setEventMessages($langs->trans('NewTokenStored'), null, 'mesgs'); // Stored into object managed by class DoliStorage so into table oauth_token
137 
138  $backtourl = $_SESSION["backtourlsavedbeforeoauthjump"];
139  unset($_SESSION["backtourlsavedbeforeoauthjump"]);
140 
141  header('Location: ' . $backtourl);
142  exit();
143  } catch (Exception $e) {
144  print $e->getMessage();
145  }
146 }
147 else // If entry on page with no parameter, we arrive here
148 {
149  $_SESSION["backtourlsavedbeforeoauthjump"]=$backtourl;
150 
151  // This may create record into oauth_state before the header redirect.
152  // Creation of record with state in this tables depend on the Provider used (see its constructor).
153  if (GETPOST('state'))
154  {
155  $url = $apiService->getAuthorizationUri(array('state'=>GETPOST('state')));
156  }
157  else
158  {
159  $url = $apiService->getAuthorizationUri(); // Parameter state will be randomly generated
160  }
161 
162  // we go on oauth provider authorization page
163  header('Location: ' . $url);
164  exit();
165 }
166 
167 
168 /*
169  * View
170  */
171 
172 // No view at all, just actions
173 
174 $db->close();
175 
setEventMessages($mesg, $mesgs, $style='mesgs')
Set event messages in dol_events session object.
GETPOST($paramname, $check='none', $method=0, $filter=NULL, $options=NULL, $noreplace=0)
Return value of a param into GET or POST supervariable.
$uriFactory
Create a new instance of the URI class with the current URI, stripping the query string.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='')
Write log message into outputs.
print
Draft customers invoices.
Definition: index.php:91