BxGoogleConModule.php 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. <?php defined('BX_DOL') or die('hack attempt');
  2. /**
  3. * Copyright (c) UNA, Inc - https://una.io
  4. * MIT License - https://opensource.org/licenses/MIT
  5. *
  6. * @defgroup GoogleConnect Google Connect
  7. * @ingroup UnaModules
  8. *
  9. * @{
  10. */
  11. class BxGoogleConModule extends BxBaseModConnectModule
  12. {
  13. function __construct(&$aModule)
  14. {
  15. parent::__construct($aModule);
  16. }
  17. /**
  18. * Redirect to remote site login form
  19. *
  20. * @return n/a - redirect or HTML page in case of error
  21. */
  22. function actionStart()
  23. {
  24. if (isLogged())
  25. $this->_redirect ($this -> _oConfig -> sDefaultRedirectUrl);
  26. if (!$this->_oConfig->sApiID || !$this->_oConfig->sApiSecret) {
  27. require_once(BX_DIRECTORY_PATH_INC . 'design.inc.php');
  28. bx_import('BxDolLanguages');
  29. $sCode = MsgBox( _t('_bx_googlecon_profile_error_api_keys') );
  30. $this->_oTemplate->getPage(_t('_bx_googlecon'), $sCode);
  31. }
  32. else {
  33. // define redirect URL to the remote site
  34. $sUrl = bx_append_url_params($this->_oConfig->sOauthUrl . '/auth', array(
  35. 'response_type' => 'code',
  36. 'client_id' => $this->_oConfig->sApiID,
  37. 'redirect_uri' => $this->_oConfig->sPageHandle,
  38. 'scope' => $this->_oConfig->sScope,
  39. 'state' => $this->_genCsrfToken(),
  40. ));
  41. $this->_redirect($sUrl);
  42. }
  43. }
  44. function actionHandle()
  45. {
  46. require_once(BX_DIRECTORY_PATH_INC . 'design.inc.php');
  47. // check CSRF token
  48. if ($this->_getCsrfToken() != bx_get('state')) {
  49. $this->_oTemplate->getPage(_t('_Error'), MsgBox(_t('_sys_connect_state_invalid')));
  50. return;
  51. }
  52. // check code
  53. $sCode = bx_get('code');
  54. if (!$sCode || bx_get('error')) {
  55. $sErrorDescription = bx_get('error_description') ? bx_get('error_description') : _t('_error occured');
  56. $this->_oTemplate->getPage(_t('_Error'), MsgBox($sErrorDescription));
  57. return;
  58. }
  59. // make request for token
  60. $s = bx_file_get_contents($this->_oConfig->sApiUrl . '/oauth2/v4/token', array(
  61. 'client_id' => $this->_oConfig->sApiID,
  62. 'client_secret' => $this->_oConfig->sApiSecret,
  63. 'grant_type' => 'authorization_code',
  64. 'code' => $sCode,
  65. 'redirect_uri' => $this->_oConfig->sPageHandle,
  66. ), 'post', array ('Content-Type: application/x-www-form-urlencoded'));
  67. // handle error
  68. if (!$s || NULL === ($aResponse = json_decode($s, true)) || !isset($aResponse['access_token']) || isset($aResponse['error'])) {
  69. $sErrorDescription = isset($aResponse['error_description']) ? $aResponse['error_description'] : _t('_error occured');
  70. $this->_oTemplate->getPage(_t('_Error'), MsgBox($sErrorDescription));
  71. return;
  72. }
  73. // get the data, especially access_token
  74. $sAccessToken = $aResponse['access_token'];
  75. $sExpiresIn = $aResponse['expires_in'];
  76. $sExpiresAt = new \DateTime('+' . $sExpiresIn . ' seconds');
  77. // request info about profile
  78. $s = bx_file_get_contents($this->_oConfig->sApiUrl . '/oauth2/v1/userinfo', array(), 'get', array(
  79. 'Authorization: Bearer ' . $sAccessToken,
  80. ));
  81. // handle error
  82. if (!$s || NULL === ($aResponse = json_decode($s, true)) || !$aResponse || isset($aResponse['error'])) {
  83. $sErrorDescription = isset($aResponse['error_description']) ? $aResponse['error_description'] : _t('_error occured');
  84. $this->_oTemplate->getPage(_t('_Error'), MsgBox($sErrorDescription));
  85. return;
  86. }
  87. $aRemoteProfileInfo = $aResponse;
  88. if ($aRemoteProfileInfo) {
  89. // check if user logged in before
  90. $iLocalProfileId = $this->_oDb->getProfileId($aRemoteProfileInfo['id']);
  91. if ($iLocalProfileId && $oProfile = BxDolProfile::getInstance($iLocalProfileId)) {
  92. // user already exists
  93. $this->setLogged($oProfile ->id());
  94. }
  95. else {
  96. // register new user
  97. $this->_createProfile($aRemoteProfileInfo);
  98. }
  99. }
  100. else {
  101. $this->_oTemplate->getPage(_t('_Error'), MsgBox(_t('_sys_connect_profile_error_info')));
  102. }
  103. }
  104. /**
  105. * @param $aProfileInfo - remote profile info
  106. * @param $sAlternativeName - suffix to add to NickName to make it unique
  107. * @return profile array info, ready for the local database
  108. */
  109. protected function _convertRemoteFields($aProfileInfo, $sAlternativeName = '')
  110. {
  111. $aProfileFields = $aProfileInfo;
  112. $aProfileFields['name'] = $aProfileInfo['given_name'];
  113. $aProfileFields['fullname'] = $aProfileInfo['name'];
  114. $aProfileFields['email'] = isset($aProfileInfo['email']) ? $aProfileInfo['email'] : '';
  115. $aProfileFields['picture'] = isset($aProfileInfo['picture']) ? $aProfileInfo['picture'] : '';
  116. return $aProfileFields;
  117. }
  118. protected function _genCsrfToken($bReturn = false)
  119. {
  120. if (getParam('sys_security_form_token_enable') != 'on' || defined('BX_DOL_CRON_EXECUTE'))
  121. return false;
  122. $oSession = BxDolSession::getInstance();
  123. $iCsrfTokenLifetime = (int)$this->_oDb->getParam('sys_security_form_token_lifetime');
  124. if ($oSession->getValue('bx_googlecon_csrf_token') === false || ($iCsrfTokenLifetime != 0 && time() - (int)$oSession->getValue('csrf_token_time') > $iCsrfTokenLifetime)) {
  125. $sToken = genRndPwd(20, false);
  126. $oSession->setValue('bx_googlecon_csrf_token', $sToken);
  127. $oSession->setValue('bx_googlecon_csrf_token_time', time());
  128. }
  129. else {
  130. $sToken = $oSession->getValue('bx_googlecon_csrf_token');
  131. }
  132. return $sToken;
  133. }
  134. protected function _getCsrfToken()
  135. {
  136. $oSession = BxDolSession::getInstance();
  137. return $oSession->getValue('bx_googlecon_csrf_token');
  138. }
  139. }
  140. /** @} */