mirror/php-e107
1
0
Fork 0
mirror of https://github.com/e107inc/e107.git synced 2025-08-02 12:48:26 +02:00
Code Issues Releases Wiki Activity

Merge pull request #4643 from Deltik/fix/4192

Browse Source 
Handle previously unhandled exceptions with `social` plugin and Hybridauth
This commit is contained in:
Cameron
2021-12-29 10:32:43 -08:00
committed by GitHub
parent c96d64e275 3f59b3bc14
commit cfa36ccb45
6 changed files with 102 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
e107_core/controllers/system/xup.php
View File

@@ -105,7 +105,7 @@ class core_system_xup_controller extends eController
$testUrl = SITEURL."?route=system/xup/test";
$providers = $manager->getValidConfiguredProviderConfigs();
$providers = $manager->getSupportedConfiguredProviderConfigs();
foreach($providers as $key=>$var)
{

2
e107_core/shortcodes/batch/signup_shortcodes.php
View File

@@ -125,7 +125,7 @@ class signup_shortcodes extends e_shortcode
$manager = new social_login_config(e107::getConfig());
$providers = $manager->getValidConfiguredProviderConfigs();
$providers = $manager->getSupportedConfiguredProviderConfigs();
foreach ($providers as $p => $v)
{

66
e107_handlers/user_handler.php
View File

@@ -1117,24 +1117,43 @@ class e_user_provider
/**
* Hybridauth adapter
* @var \Hybridauth\Adapter\AdapterInterface
*
* @var \Hybridauth\Adapter\AdapterInterface|null
*/
public $adapter;
/**
* Hybridauth object
*
* @var Hybridauth\Hybridauth
*/
protected $hybridauth;
protected $_config = array();
/**
* @var social_login_config
* @var social_login_config|null
*/
protected $social_login_config_manager;
protected $social_login_config_manager = null;
public function __construct($provider = null, $config = array())
/**
* Create a new Hybridauth-backed social login provider
*
* This constructor suppresses exceptions due to client usages not handling exceptions and instead sends error
* messages to logged in admins. To check if a Hybridauth configuration is valid, use
* {@link e107::getUserProvider()} with the provider name while logged in as an admin.
*
* @param string|null $provider The name of the provider to use
* @param array $config An override Hybridauth configuration that takes precedence over the
* database Hybridauth configuration for this provider. Leave blank to use
* the database configuration.
* @param bool $suppress_exceptions Set to false to propagate Hybridauth exceptions
* @throws \Hybridauth\Exception\UnexpectedValueException if the provider is disabled
* @throws \Hybridauth\Exception\InvalidArgumentException if the provider configuration validation failed
*/
public function __construct($provider = null, $config = array(), $suppress_exceptions = true)
{
require_once(e_PLUGIN . "social/includes/social_login_config.php");
@include_once(e_PLUGIN . "social/includes/social_login_config.php");
if (!class_exists('social_login_config')) return;
$this->social_login_config_manager = new social_login_config(e107::getConfig());
if (!empty($config))
@@ -1144,24 +1163,38 @@ class e_user_provider
else
{
$this->_config = array(
"callback" => $this->generateCallbackUrl($provider),
"providers" => $this->social_login_config_manager->getValidConfiguredProviderConfigs(),
"callback" => $this->generateCallbackUrl($provider),
"providers" => $this->social_login_config_manager->getSupportedConfiguredProviderConfigs(),
"debug_mode" => 'error',
"debug_file" => e_LOG . "hybridAuth.log"
);
}
$this->respawnHybridauth();
$this->setProvider($provider);
$providerId = $this->getProvider();
if ($providerId && $this->hybridauth->isConnectedWith($providerId))
try
{
$this->adapter = $this->hybridauth->getAdapter($providerId);
$this->respawnHybridauth();
$this->setProvider($provider);
$providerId = $this->getProvider();
if ($providerId && $this->hybridauth->isConnectedWith($providerId))
{
$this->adapter = $this->hybridauth->getAdapter($providerId);
}
}
catch (\Hybridauth\Exception\InvalidArgumentException $e)
{
if (!$suppress_exceptions) throw $e;
}
catch (\Hybridauth\Exception\UnexpectedValueException $e)
{
if (!$suppress_exceptions) throw $e;
}
}
/**
* @throws \Hybridauth\Exception\InvalidArgumentException
*/
private function respawnHybridauth()
{
$this->hybridauth = new Hybridauth\Hybridauth($this->_config);
@@ -1218,9 +1251,10 @@ class e_user_provider
/**
* Get the social login providers for which we have adapters
*
* This function is slow! Please cache the output instead of calling it multiple times.
* Despite this being a static method, it memoizes (caches) the slow reflection code in the {@link e107} registry
* after the first run, so subsequent calls to this method are fast.
*
* @return array String list of supported providers. Empty if Hybridauth is broken.
* @return string[] String list of supported providers. Empty if Hybridauth is broken.
*/
public static function getSupportedProviders()
{
@@ -1466,6 +1500,8 @@ class e_user_provider
*/
public function isSocialLoginEnabled()
{
if ($this->social_login_config_manager === null) return false;
return $this->social_login_config_manager->isFlagActive(social_login_config::ENABLE_BIT_GLOBAL);
}

13
e107_plugins/social/admin_config.php
View File

@@ -606,6 +606,19 @@ class social_ui extends e_admin_ui
foreach ($provider_names as $provider_name)
{
// Check if the current configuration for the provider is valid
try
{
new e_user_provider($provider_name, [], false);
}
catch (\Hybridauth\Exception\InvalidArgumentException $e)
{
e107::getMessage()->addError("[{$e->getCode()}] {$e->getMessage()}");
}
catch (\Hybridauth\Exception\UnexpectedValueException $ignored)
{
}
$text .= $this->generateSocialLoginRow($provider_name, $readonly);
}

9
e107_plugins/social/includes/social_login_config.php
View File

@@ -162,9 +162,13 @@ class social_login_config
/**
* Get configs of providers that are supported and configured
*
* These configs are not validated here by the social login implementation.
* This method only filters out providers that are not supported and not configured.
*
* @return array Associative array where the key is the denormalized provider name and the value is its config
*/
public function getValidConfiguredProviderConfigs()
public function getSupportedConfiguredProviderConfigs()
{
$supported_providers = $this->getSupportedProviders();
$configured_providers = $this->getConfiguredProviders();
@@ -233,6 +237,9 @@ class social_login_config
return $output;
}
/**
* @return array
*/
protected function getSocialLoginConfig()
{
$config = $this->config->get(self::SOCIAL_LOGIN_PREF);

28
e107_tests/tests/unit/e_user_providerTest.php
View File

@@ -115,4 +115,32 @@ class e_user_providerTest extends \Codeception\Test\Unit
$result = e_user_provider::getSupplementalFieldsOf("Vkontakte");
$this->assertTrue(array_key_exists('photo_size', $result));
}
public function testNewSuppressExceptions()
{
$this->assertInstanceOf(
e_user_provider::class,
new e_user_provider("Facebook", ["providers" => ["Facebook", ["enabled" => true]]])
);
}
public function testNewNoSuppressConfigurationException()
{
$this->expectException(\Hybridauth\Exception\InvalidArgumentException::class);
new e_user_provider(
"Facebook",
["providers" => ["Facebook" => ["enabled" => true]]],
false
);
}
public function testNewNoSuppressDisabledException()
{
$this->expectException(\Hybridauth\Exception\UnexpectedValueException::class);
new e_user_provider(
"Facebook",
["providers" => ["Facebook" => ["enabled" => false]]],
false
);
}
}