Version 5.0.0 beta 1
This commit is contained in:
1 parent
25ddeb65d6
commit
15c7beabc5
6736 files changed
+627902
-497943
No files matched your search
@@ -11,21 +11,43 @@
|
||||
namespace IPS\Login\Handler;
|
||||
|
||||
/* To prevent PHP errors (extending class does not exist) revealing path */
|
||||
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
||||
|
||||
use DomainException;
|
||||
use IPS\Db;
|
||||
use IPS\Db\Exception as DbException;
|
||||
use IPS\Helpers\Form\Codemirror;
|
||||
use IPS\Helpers\Form\Number;
|
||||
use IPS\Helpers\Form\Radio;
|
||||
use IPS\Helpers\Form\Select;
|
||||
use IPS\Helpers\Form\Text;
|
||||
use IPS\Http\Url;
|
||||
use IPS\Log;
|
||||
use IPS\Login;
|
||||
use IPS\Login\Exception;
|
||||
use IPS\Login\Handler;
|
||||
use IPS\Member;
|
||||
use IPS\Request;
|
||||
use IPS\Settings;
|
||||
use RuntimeException;
|
||||
use Throwable;
|
||||
use UnderflowException;
|
||||
use function defined;
|
||||
|
||||
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
||||
{
|
||||
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
|
||||
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Standard Internal Database Login Handler
|
||||
*/
|
||||
class _ExternalDatabase extends \IPS\Login\Handler
|
||||
class ExternalDatabase extends Handler
|
||||
{
|
||||
/**
|
||||
* @brief Can we have multiple instances of this handler?
|
||||
*/
|
||||
public static $allowMultiple = TRUE;
|
||||
public static bool $allowMultiple = TRUE;
|
||||
|
||||
use UsernamePasswordHandler;
|
||||
|
||||
@@ -36,7 +58,7 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function getTitle()
|
||||
public static function getTitle(): string
|
||||
{
|
||||
return 'login_handler_External';
|
||||
}
|
||||
@@ -44,43 +66,42 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
/**
|
||||
* ACP Settings Form
|
||||
*
|
||||
* @param string $url URL to redirect user to after successful submission
|
||||
* @return array List of settings to save - settings will be stored to core_login_methods.login_settings DB field
|
||||
* @code
|
||||
return array( 'savekey' => new \IPS\Helpers\Form\[Type]( ... ), ... );
|
||||
* @endcode
|
||||
*/
|
||||
public function acpForm()
|
||||
public function acpForm(): array
|
||||
{
|
||||
$id = $this->id ?: 'new';
|
||||
|
||||
$return = array(
|
||||
'login_external_conn',
|
||||
'sql_host' => new \IPS\Helpers\Form\Text( 'login_external_host', ( isset( $this->settings['sql_host'] ) and $this->settings['sql_host'] ) ? $this->settings['sql_host'] : 'localhost', TRUE ),
|
||||
'sql_user' => new \IPS\Helpers\Form\Text( 'login_external_user', isset( $this->settings['sql_user'] ) ? $this->settings['sql_user'] : NULL, TRUE ),
|
||||
'sql_pass' => new \IPS\Helpers\Form\Text( 'login_external_pass', isset( $this->settings['sql_pass'] ) ? $this->settings['sql_pass'] : NULL, FALSE ),
|
||||
'sql_database' => new \IPS\Helpers\Form\Text( 'login_external_database', isset( $this->settings['sql_database'] ) ? $this->settings['sql_database'] : NULL, TRUE ),
|
||||
'sql_port' => new \IPS\Helpers\Form\Number( 'login_external_port', isset( $this->settings['sql_port'] ) ? $this->settings['sql_port'] : 3306, FALSE ),
|
||||
'sql_socket' => new \IPS\Helpers\Form\Text( 'login_external_socket', isset( $this->settings['sql_socket'] ) ? $this->settings['sql_socket'] : NULL, FALSE ),
|
||||
'sql_host' => new Text( 'login_external_host', ( isset( $this->settings['sql_host'] ) and $this->settings['sql_host'] ) ? $this->settings['sql_host'] : 'localhost', TRUE ),
|
||||
'sql_user' => new Text( 'login_external_user', $this->settings['sql_user'] ?? NULL, TRUE ),
|
||||
'sql_pass' => new Text( 'login_external_pass', $this->settings['sql_pass'] ?? NULL, FALSE ),
|
||||
'sql_database' => new Text( 'login_external_database', $this->settings['sql_database'] ?? NULL, TRUE ),
|
||||
'sql_port' => new Number( 'login_external_port', $this->settings['sql_port'] ?? 3306, FALSE ),
|
||||
'sql_socket' => new Text( 'login_external_socket', $this->settings['sql_socket'] ?? NULL, FALSE ),
|
||||
'login_external_schema',
|
||||
'db_table' => new \IPS\Helpers\Form\Text( 'login_external_table', isset( $this->settings['db_table'] ) ? $this->settings['db_table'] : NULL, TRUE ),
|
||||
'db_col_id' => new \IPS\Helpers\Form\Text( 'login_external_id', isset( $this->settings['db_col_id'] ) ? $this->settings['db_col_id'] : NULL, FALSE ),
|
||||
'db_col_user' => new \IPS\Helpers\Form\Text( 'login_external_username', isset( $this->settings['db_col_user'] ) ? $this->settings['db_col_user'] : NULL, FALSE, array(), function( $val )
|
||||
'db_table' => new Text( 'login_external_table', $this->settings['db_table'] ?? NULL, TRUE ),
|
||||
'db_col_id' => new Text( 'login_external_id', $this->settings['db_col_id'] ?? NULL, FALSE ),
|
||||
'db_col_user' => new Text( 'login_external_username', $this->settings['db_col_user'] ?? NULL, FALSE, array(), function( $val )
|
||||
{
|
||||
if ( !$val and \IPS\Request::i()->login_auth_types & \IPS\Login::AUTH_TYPE_USERNAME )
|
||||
if ( !$val and Request::i()->login_auth_types & Login::AUTH_TYPE_USERNAME )
|
||||
{
|
||||
throw new \DomainException('login_external_username_err');
|
||||
throw new DomainException('login_external_username_err');
|
||||
}
|
||||
} ),
|
||||
'db_col_email' => new \IPS\Helpers\Form\Text( 'login_external_email', isset( $this->settings['db_col_email'] ) ? $this->settings['db_col_email'] : NULL, FALSE, array(), function( $val )
|
||||
'db_col_email' => new Text( 'login_external_email', $this->settings['db_col_email'] ?? NULL, FALSE, array(), function( $val )
|
||||
{
|
||||
if ( !$val and \IPS\Request::i()->login_auth_types & \IPS\Login::AUTH_TYPE_EMAIL )
|
||||
if ( !$val and Request::i()->login_auth_types & Login::AUTH_TYPE_EMAIL )
|
||||
{
|
||||
throw new \DomainException('login_external_email_err');
|
||||
throw new DomainException('login_external_email_err');
|
||||
}
|
||||
} ),
|
||||
'db_col_pass' => new \IPS\Helpers\Form\Text( 'login_external_password', isset( $this->settings['db_col_pass'] ) ? $this->settings['db_col_pass'] : NULL, TRUE ),
|
||||
'db_encryption' => new \IPS\Helpers\Form\Radio( 'login_external_encryption', ( isset( $this->settings['db_encryption'] ) and $this->settings['db_encryption'] ) ? $this->settings['db_encryption'] : NULL, TRUE, array(
|
||||
'db_col_pass' => new Text( 'login_external_password', $this->settings['db_col_pass'] ?? NULL, TRUE ),
|
||||
'db_encryption' => new Radio( 'login_external_encryption', ( isset( $this->settings['db_encryption'] ) and $this->settings['db_encryption'] ) ? $this->settings['db_encryption'] : NULL, TRUE, array(
|
||||
'options' => array(
|
||||
'password_hash' => 'login_external_encryption_password_hash',
|
||||
'md5' => 'MD5',
|
||||
@@ -92,9 +113,9 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
'other' => array( 'db_encryption_hash', 'db_encryption_validate' )
|
||||
)
|
||||
) ),
|
||||
'db_encryption_hash' => new \IPS\Helpers\Form\Codemirror( 'login_external_encryption_hash', isset( $this->settings['db_encryption_hash'] ) ? $this->settings['db_encryption_hash'] : 'return password_hash( $providedPassword );', NULL, array(
|
||||
'db_encryption_hash' => new Codemirror( 'login_external_encryption_hash', $this->settings['db_encryption_hash'] ?? 'return password_hash( $providedPassword );', NULL, array(
|
||||
'mode' => 'php',
|
||||
'tags' => array( '$providedPassword' => \IPS\Member::loggedIn()->language()->addToStack('login_external_encryption_custom_password') )
|
||||
'tags' => array( '$providedPassword' => Member::loggedIn()->language()->addToStack('login_external_encryption_custom_password') )
|
||||
), function( $val )
|
||||
{
|
||||
try
|
||||
@@ -103,16 +124,16 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
}
|
||||
catch ( \Exception $e )
|
||||
{
|
||||
throw new \DomainException( $e->getMessage() );
|
||||
throw new DomainException( $e->getMessage() );
|
||||
}
|
||||
catch ( \Throwable $e )
|
||||
catch ( Throwable $e )
|
||||
{
|
||||
throw new \DomainException( $e->getMessage() );
|
||||
throw new DomainException( $e->getMessage() );
|
||||
}
|
||||
}, NULL, NULL, 'db_encryption_hash' ),
|
||||
'db_encryption_validate' => new \IPS\Helpers\Form\Codemirror( 'login_external_encryption_validate', isset( $this->settings['db_encryption_validate'] ) ? $this->settings['db_encryption_validate'] : 'return password_verify( $providedPassword, $row[\'password\'] );', NULL, array(
|
||||
'db_encryption_validate' => new Codemirror( 'login_external_encryption_validate', $this->settings['db_encryption_validate'] ?? 'return password_verify( $providedPassword, $row[\'password\'] );', NULL, array(
|
||||
'mode' => 'php',
|
||||
'tags' => array( '$row' => \IPS\Member::loggedIn()->language()->addToStack('login_external_encryption_custom_row'), '$providedPassword' => \IPS\Member::loggedIn()->language()->addToStack('login_external_encryption_custom_password') )
|
||||
'tags' => array( '$row' => Member::loggedIn()->language()->addToStack('login_external_encryption_custom_row'), '$providedPassword' => Member::loggedIn()->language()->addToStack('login_external_encryption_custom_password') )
|
||||
), function( $val )
|
||||
{
|
||||
try
|
||||
@@ -121,49 +142,49 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
}
|
||||
catch ( \Exception $e )
|
||||
{
|
||||
throw new \DomainException( $e->getMessage() );
|
||||
throw new DomainException( $e->getMessage() );
|
||||
}
|
||||
catch ( \Throwable $e )
|
||||
catch ( Throwable $e )
|
||||
{
|
||||
throw new \DomainException( $e->getMessage() );
|
||||
throw new DomainException( $e->getMessage() );
|
||||
}
|
||||
}, NULL, NULL, 'db_encryption_validate' ),
|
||||
'db_extra' => new \IPS\Helpers\Form\Text( 'login_external_extra', isset( $this->settings['db_extra'] ) ? $this->settings['db_extra'] : NULL ),
|
||||
'db_extra' => new Text( 'login_external_extra', $this->settings['db_extra'] ?? NULL ),
|
||||
'login_settings',
|
||||
'auth_types' => new \IPS\Helpers\Form\Select( 'login_auth_types', isset( $this->settings['auth_types'] ) ? $this->settings['auth_types'] : ( \IPS\Login::AUTH_TYPE_EMAIL ), TRUE, array( 'options' => array(
|
||||
\IPS\Login::AUTH_TYPE_USERNAME + \IPS\Login::AUTH_TYPE_EMAIL => 'username_or_email',
|
||||
\IPS\Login::AUTH_TYPE_EMAIL => 'email_address',
|
||||
\IPS\Login::AUTH_TYPE_USERNAME => 'username',
|
||||
), 'toggles' => array( \IPS\Login::AUTH_TYPE_USERNAME + \IPS\Login::AUTH_TYPE_EMAIL => array( 'form_' . $id . '_login_auth_types_warning' ), \IPS\Login::AUTH_TYPE_USERNAME => array( 'form_' . $id . '_login_auth_types_warning' ) ) ) ),
|
||||
'auth_types' => new Select( 'login_auth_types', $this->settings['auth_types'] ?? ( Login::AUTH_TYPE_EMAIL ), TRUE, array( 'options' => array(
|
||||
Login::AUTH_TYPE_USERNAME + Login::AUTH_TYPE_EMAIL => 'username_or_email',
|
||||
Login::AUTH_TYPE_EMAIL => 'email_address',
|
||||
Login::AUTH_TYPE_USERNAME => 'username',
|
||||
), 'toggles' => array( Login::AUTH_TYPE_USERNAME + Login::AUTH_TYPE_EMAIL => array( 'form_' . $id . '_login_auth_types_warning' ), Login::AUTH_TYPE_USERNAME => array( 'form_' . $id . '_login_auth_types_warning' ) ) ) ),
|
||||
);
|
||||
|
||||
if ( \IPS\Settings::i()->allow_forgot_password == 'normal' or \IPS\Settings::i()->allow_forgot_password == 'handler' )
|
||||
if ( Settings::i()->allow_forgot_password == 'normal' or Settings::i()->allow_forgot_password == 'handler' )
|
||||
{
|
||||
$return['forgot_password_url'] = new \IPS\Helpers\Form\Url( 'handler_forgot_password_url', isset( $this->settings['forgot_password_url'] ) ? $this->settings['forgot_password_url'] : NULL );
|
||||
\IPS\Member::loggedIn()->language()->words['handler_forgot_password_url_desc'] = \IPS\Member::loggedIn()->language()->addToStack( \IPS\Settings::i()->allow_forgot_password == 'normal' ? 'handler_forgot_password_url_desc_normal' : 'handler_forgot_password_url_deschandler' );
|
||||
$return['forgot_password_url'] = new \IPS\Helpers\Form\Url( 'handler_forgot_password_url', $this->settings['forgot_password_url'] ?? NULL );
|
||||
Member::loggedIn()->language()->words['handler_forgot_password_url_desc'] = Member::loggedIn()->language()->addToStack( Settings::i()->allow_forgot_password == 'normal' ? 'handler_forgot_password_url_desc_normal' : 'handler_forgot_password_url_deschandler' );
|
||||
}
|
||||
|
||||
$return[] = 'account_management_settings';
|
||||
$return['sync_name_changes'] = new \IPS\Helpers\Form\Radio( 'login_sync_name_changes', isset( $this->settings['sync_name_changes'] ) ? $this->settings['sync_name_changes'] : 1, FALSE, array( 'options' => array(
|
||||
$return['sync_name_changes'] = new Radio( 'login_sync_name_changes', $this->settings['sync_name_changes'] ?? 1, FALSE, array( 'options' => array(
|
||||
1 => 'login_sync_changes_yes',
|
||||
0 => 'login_sync_changes_no',
|
||||
) ) );
|
||||
if ( \IPS\Settings::i()->allow_email_changes == 'normal' )
|
||||
if ( Settings::i()->allow_email_changes == 'normal' )
|
||||
{
|
||||
$return['sync_email_changes'] = new \IPS\Helpers\Form\Radio( 'login_sync_email_changes', isset( $this->settings['sync_email_changes'] ) ? $this->settings['sync_email_changes'] : 1, FALSE, array( 'options' => array(
|
||||
$return['sync_email_changes'] = new Radio( 'login_sync_email_changes', $this->settings['sync_email_changes'] ?? 1, FALSE, array( 'options' => array(
|
||||
1 => 'login_sync_changes_yes',
|
||||
0 => 'login_sync_changes_no',
|
||||
) ) );
|
||||
}
|
||||
if ( \IPS\Settings::i()->allow_password_changes == 'normal' )
|
||||
if ( Settings::i()->allow_password_changes == 'normal' )
|
||||
{
|
||||
$return['sync_password_changes'] = new \IPS\Helpers\Form\Radio( 'login_sync_password_changes', isset( $this->settings['sync_password_changes'] ) ? $this->settings['sync_password_changes'] : 1, FALSE, array( 'options' => array(
|
||||
$return['sync_password_changes'] = new Radio( 'login_sync_password_changes', $this->settings['sync_password_changes'] ?? 1, FALSE, array( 'options' => array(
|
||||
1 => 'login_sync_changes_yes',
|
||||
0 => 'login_sync_password_changes_no',
|
||||
) ) );
|
||||
}
|
||||
|
||||
$return['show_in_ucp'] = new \IPS\Helpers\Form\Radio( 'login_handler_show_in_ucp', isset( $this->settings['show_in_ucp'] ) ? $this->settings['show_in_ucp'] : 'disabled', FALSE, array(
|
||||
$return['show_in_ucp'] = new Radio( 'login_handler_show_in_ucp', $this->settings['show_in_ucp'] ?? 'disabled', FALSE, array(
|
||||
'options' => array(
|
||||
'always' => 'login_handler_show_in_ucp_always',
|
||||
'loggedin' => 'login_handler_show_in_ucp_loggedin',
|
||||
@@ -180,37 +201,37 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
if ( $forceNameHandler = static::handlerHasForceSync( 'name', $this ) )
|
||||
{
|
||||
$nameChangesDisabled[] = 'force';
|
||||
\IPS\Member::loggedIn()->language()->words['login_update_changes_yes_name_desc'] = \IPS\Member::loggedIn()->language()->addToStack( 'login_update_changes_yes_disabled', FALSE, array( 'sprintf' => $forceNameHandler->_title ) );
|
||||
Member::loggedIn()->language()->words['login_update_changes_yes_name_desc'] = Member::loggedIn()->language()->addToStack( 'login_update_changes_yes_disabled', FALSE, array( 'sprintf' => $forceNameHandler->_title ) );
|
||||
}
|
||||
$emailChangesDisabled = array();
|
||||
if ( $forceEmailHandler = static::handlerHasForceSync( 'email', $this ) )
|
||||
{
|
||||
$emailChangesDisabled[] = 'force';
|
||||
\IPS\Member::loggedIn()->language()->words['login_update_changes_yes_email_desc'] = \IPS\Member::loggedIn()->language()->addToStack( 'login_update_changes_yes_disabled', FALSE, array( 'sprintf' => $forceEmailHandler->_title ) );
|
||||
Member::loggedIn()->language()->words['login_update_changes_yes_email_desc'] = Member::loggedIn()->language()->addToStack( 'login_update_changes_yes_disabled', FALSE, array( 'sprintf' => $forceEmailHandler->_title ) );
|
||||
}
|
||||
|
||||
$return['update_name_changes_inc_optional'] = new \IPS\Helpers\Form\Radio( 'login_update_name_changes_inc_optional', isset( $this->settings['update_name_changes'] ) ? $this->settings['update_name_changes'] : 'disabled', FALSE, array( 'options' => array(
|
||||
$return['update_name_changes_inc_optional'] = new Radio( 'login_update_name_changes_inc_optional', $this->settings['update_name_changes'] ?? 'disabled', FALSE, array( 'options' => array(
|
||||
'force' => 'login_update_changes_yes_name',
|
||||
'optional' => 'login_update_changes_optional',
|
||||
'disabled' => 'login_update_changes_no',
|
||||
), 'disabled' => $nameChangesDisabled ), NULL, NULL, NULL, 'login_update_name_changes_inc_optional' );
|
||||
$return['update_name_changes_no_optional'] = new \IPS\Helpers\Form\Radio( 'login_update_name_changes_no_optional', ( isset( $this->settings['update_name_changes'] ) and $this->settings['update_name_changes'] != 'optional' ) ? $this->settings['update_name_changes'] : 'disabled', FALSE, array( 'options' => array(
|
||||
$return['update_name_changes_no_optional'] = new Radio( 'login_update_name_changes_no_optional', ( isset( $this->settings['update_name_changes'] ) and $this->settings['update_name_changes'] != 'optional' ) ? $this->settings['update_name_changes'] : 'disabled', FALSE, array( 'options' => array(
|
||||
'force' => 'login_update_changes_yes_name',
|
||||
'disabled' => 'login_update_changes_no',
|
||||
), 'disabled' => $nameChangesDisabled ), NULL, NULL, NULL, 'login_update_name_changes_no_optional' );
|
||||
$return['update_email_changes_inc_optional'] = new \IPS\Helpers\Form\Radio( 'login_update_email_changes_inc_optional', isset( $this->settings['update_email_changes'] ) ? $this->settings['update_email_changes'] : 'force', FALSE, array( 'options' => array(
|
||||
$return['update_email_changes_inc_optional'] = new Radio( 'login_update_email_changes_inc_optional', $this->settings['update_email_changes'] ?? 'force', FALSE, array( 'options' => array(
|
||||
'force' => 'login_update_changes_yes_email',
|
||||
'optional' => 'login_update_changes_optional',
|
||||
'disabled' => 'login_update_changes_no',
|
||||
), 'disabled' => $emailChangesDisabled ), NULL, NULL, NULL, 'login_update_email_changes_inc_optional' );
|
||||
$return['update_email_changes_no_optional'] = new \IPS\Helpers\Form\Radio( 'login_update_email_changes_no_optional', ( isset( $this->settings['update_email_changes'] ) and $this->settings['update_email_changes'] != 'optional' ) ? $this->settings['update_email_changes'] : 'force', FALSE, array( 'options' => array(
|
||||
$return['update_email_changes_no_optional'] = new Radio( 'login_update_email_changes_no_optional', ( isset( $this->settings['update_email_changes'] ) and $this->settings['update_email_changes'] != 'optional' ) ? $this->settings['update_email_changes'] : 'force', FALSE, array( 'options' => array(
|
||||
'force' => 'login_update_changes_yes_email',
|
||||
'disabled' => 'login_update_changes_no',
|
||||
), 'disabled' => $emailChangesDisabled ), NULL, NULL, NULL, 'login_update_email_changes_no_optional' );
|
||||
\IPS\Member::loggedIn()->language()->words['login_update_name_changes_inc_optional'] = \IPS\Member::loggedIn()->language()->addToStack('login_update_name_changes');
|
||||
\IPS\Member::loggedIn()->language()->words['login_update_name_changes_no_optional'] = \IPS\Member::loggedIn()->language()->addToStack('login_update_name_changes');
|
||||
\IPS\Member::loggedIn()->language()->words['login_update_email_changes_inc_optional'] = \IPS\Member::loggedIn()->language()->addToStack('login_update_email_changes');
|
||||
\IPS\Member::loggedIn()->language()->words['login_update_email_changes_no_optional'] = \IPS\Member::loggedIn()->language()->addToStack('login_update_email_changes');
|
||||
Member::loggedIn()->language()->words['login_update_name_changes_inc_optional'] = Member::loggedIn()->language()->addToStack('login_update_name_changes');
|
||||
Member::loggedIn()->language()->words['login_update_name_changes_no_optional'] = Member::loggedIn()->language()->addToStack('login_update_name_changes');
|
||||
Member::loggedIn()->language()->words['login_update_email_changes_inc_optional'] = Member::loggedIn()->language()->addToStack('login_update_email_changes');
|
||||
Member::loggedIn()->language()->words['login_update_email_changes_no_optional'] = Member::loggedIn()->language()->addToStack('login_update_email_changes');
|
||||
|
||||
return $return;
|
||||
}
|
||||
@@ -221,7 +242,7 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
* @param array $values Values from form
|
||||
* @return array
|
||||
*/
|
||||
public function acpFormSave( &$values )
|
||||
public function acpFormSave( array &$values ): array
|
||||
{
|
||||
$_values = $values;
|
||||
|
||||
@@ -252,9 +273,9 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
* Test Settings
|
||||
*
|
||||
* @return bool
|
||||
* @throws \IPS\Db\Exception
|
||||
* @throws DbException
|
||||
*/
|
||||
public function testSettings()
|
||||
public function testSettings(): bool
|
||||
{
|
||||
$select = array( $this->settings['db_col_pass'] );
|
||||
|
||||
@@ -272,7 +293,7 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
{
|
||||
$result = $this->_externalDb()->select( implode( ',', $select ), $this->settings['db_table'], ( isset( $this->settings['db_extra'] ) AND $this->settings['db_extra'] != '' ) ? array( $this->settings['db_extra'] ) : NULL )->first();
|
||||
}
|
||||
catch ( \UnderflowException $e )
|
||||
catch ( UnderflowException $e )
|
||||
{
|
||||
// It's possible that no users exist, which is fine
|
||||
}
|
||||
@@ -285,39 +306,36 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
/**
|
||||
* Authenticate
|
||||
*
|
||||
* @param \IPS\Login $login The login object
|
||||
* @param string $usernameOrEmail The username or email address provided by the user
|
||||
* @param object $password The plaintext password provided by the user, wrapped in an object that can be cast to a string so it doesn't show in any logs
|
||||
* @return \IPS\Member
|
||||
* @throws \IPS\Login\Exception
|
||||
* @param Login $login The login object
|
||||
* @param string $usernameOrEmail The username or email address provided by the user
|
||||
* @param object $password The plaintext password provided by the user, wrapped in an object that can be cast to a string so it doesn't show in any logs
|
||||
* @return Member
|
||||
* @throws Exception
|
||||
*/
|
||||
public function authenticateUsernamePassword( \IPS\Login $login, $usernameOrEmail, $password )
|
||||
public function authenticateUsernamePassword( Login $login, string $usernameOrEmail, object $password ): Member
|
||||
{
|
||||
/* Fetch result */
|
||||
try
|
||||
{
|
||||
if( !$usernameOrEmail )
|
||||
{
|
||||
throw new \UnderflowException;
|
||||
throw new UnderflowException;
|
||||
}
|
||||
|
||||
$result = $this->_getRowFromExternalDb( $usernameOrEmail );
|
||||
}
|
||||
catch ( \IPS\Db\Exception $e )
|
||||
catch ( DbException $e )
|
||||
{
|
||||
throw new \IPS\Login\Exception( 'generic_error', \IPS\Login\Exception::INTERNAL_ERROR );
|
||||
throw new Exception( 'generic_error', Exception::INTERNAL_ERROR );
|
||||
}
|
||||
catch ( \UnderflowException $e )
|
||||
catch ( UnderflowException $e )
|
||||
{
|
||||
$member = NULL;
|
||||
|
||||
if ( $this->authType() & \IPS\Login::AUTH_TYPE_EMAIL )
|
||||
{
|
||||
$member = new \IPS\Member;
|
||||
$member->email = $usernameOrEmail;
|
||||
}
|
||||
|
||||
throw new \IPS\Login\Exception( \IPS\Member::loggedIn()->language()->addToStack( 'login_err_no_account', FALSE, array( 'pluralize' => array( $this->authType() ) ) ), \IPS\Login\Exception::NO_ACCOUNT, NULL, $member );
|
||||
$member = new Member;
|
||||
$member->email = $usernameOrEmail;
|
||||
|
||||
throw new Exception( Member::loggedIn()->language()->addToStack( 'login_err_no_account', FALSE ), Exception::NO_ACCOUNT, NULL, $member );
|
||||
}
|
||||
|
||||
/* Get a local account if one exists */
|
||||
@@ -328,23 +346,23 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
{
|
||||
try
|
||||
{
|
||||
$link = \IPS\Db::i()->select( '*', 'core_login_links', array( 'token_login_method=? AND token_identifier=?', $this->id, $result[ $this->settings['db_col_id'] ] ) )->first();
|
||||
$member = \IPS\Member::load( $link['token_member'] );
|
||||
$link = Db::i()->select( '*', 'core_login_links', array( 'token_login_method=? AND token_identifier=?', $this->id, $result[ $this->settings['db_col_id'] ] ) )->first();
|
||||
$member = Member::load( $link['token_member'] );
|
||||
|
||||
/* If the user never finished the linking process, or the account has been deleted, discard this access token */
|
||||
if ( !$link['token_linked'] or !$member->member_id )
|
||||
{
|
||||
\IPS\Db::i()->delete( 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $link['token_member'] ) );
|
||||
Db::i()->delete( 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $link['token_member'] ) );
|
||||
$member = NULL;
|
||||
}
|
||||
}
|
||||
catch ( \UnderflowException $e ) { }
|
||||
catch ( UnderflowException $e ) { }
|
||||
}
|
||||
else
|
||||
{
|
||||
if ( $name )
|
||||
{
|
||||
$_member = \IPS\Member::load( $name, 'name' );
|
||||
$_member = Member::load( $name, 'name' );
|
||||
if ( $_member->member_id )
|
||||
{
|
||||
$member = $_member;
|
||||
@@ -352,7 +370,7 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
}
|
||||
if ( $email )
|
||||
{
|
||||
$_member = \IPS\Member::load( $email, 'email' );
|
||||
$_member = Member::load( $email, 'email' );
|
||||
if ( $_member->member_id )
|
||||
{
|
||||
$member = $_member;
|
||||
@@ -363,7 +381,7 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
/* Verify password */
|
||||
if( !$this->_passwordIsValid( $result, $password ) )
|
||||
{
|
||||
throw new \IPS\Login\Exception( \IPS\Member::loggedIn()->language()->addToStack( 'login_err_bad_password', FALSE, array( 'pluralize' => array( $this->authType() ) ) ), \IPS\Login\Exception::BAD_PASSWORD, NULL, $member );
|
||||
throw new Exception( Member::loggedIn()->language()->addToStack( 'login_err_bad_password', FALSE ), Exception::BAD_PASSWORD, NULL, $member );
|
||||
}
|
||||
|
||||
/* Create account if we don't have one */
|
||||
@@ -375,9 +393,9 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
{
|
||||
try
|
||||
{
|
||||
if ( $login->type === \IPS\Login::LOGIN_UCP )
|
||||
if ( $login->type === Login::LOGIN_UCP )
|
||||
{
|
||||
$exception = new \IPS\Login\Exception( 'generic_error', \IPS\Login\Exception::MERGE_SOCIAL_ACCOUNT );
|
||||
$exception = new Exception( 'generic_error', Exception::MERGE_SOCIAL_ACCOUNT );
|
||||
$exception->handler = $this;
|
||||
$exception->member = $login->reauthenticateAs;
|
||||
throw $exception;
|
||||
@@ -385,7 +403,7 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
|
||||
$member = $this->createAccount( $name, $email );
|
||||
|
||||
\IPS\Db::i()->insert( 'core_login_links', array(
|
||||
Db::i()->insert( 'core_login_links', array(
|
||||
'token_login_method' => $this->id,
|
||||
'token_member' => $member->member_id,
|
||||
'token_identifier' => $result[ $this->settings['db_col_id'] ],
|
||||
@@ -414,23 +432,23 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
|
||||
return $member;
|
||||
}
|
||||
catch ( \IPS\Login\Exception $exception )
|
||||
catch ( Exception $exception )
|
||||
{
|
||||
if ( $exception->getCode() === \IPS\Login\Exception::MERGE_SOCIAL_ACCOUNT )
|
||||
if ( $exception->getCode() === Exception::MERGE_SOCIAL_ACCOUNT )
|
||||
{
|
||||
try
|
||||
{
|
||||
$identifier = \IPS\Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $exception->member->member_id ) )->first();
|
||||
$identifier = Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $exception->member->member_id ) )->first();
|
||||
|
||||
if( $identifier != $result[ $this->settings['db_col_id'] ] )
|
||||
{
|
||||
$exception->setCode( \IPS\Login\Exception::LOCAL_ACCOUNT_ALREADY_MERGED );
|
||||
$exception->setCode( Exception::LOCAL_ACCOUNT_ALREADY_MERGED );
|
||||
throw $exception;
|
||||
}
|
||||
}
|
||||
catch( \UnderflowException $e )
|
||||
catch( UnderflowException $e )
|
||||
{
|
||||
\IPS\Db::i()->insert( 'core_login_links', array(
|
||||
Db::i()->insert( 'core_login_links', array(
|
||||
'token_login_method' => $this->id,
|
||||
'token_member' => $exception->member->member_id,
|
||||
'token_identifier' => $result[ $this->settings['db_col_id'] ],
|
||||
@@ -451,71 +469,41 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
/**
|
||||
* Authenticate
|
||||
*
|
||||
* @param \IPS\Member $member The member
|
||||
* @param object $password The plaintext password provided by the user, wrapped in an object that can be cast to a string so it doesn't show in any logs
|
||||
* @param Member $member The member
|
||||
* @param object $password The plaintext password provided by the user, wrapped in an object that can be cast to a string so it doesn't show in any logs
|
||||
* @return bool
|
||||
*/
|
||||
public function authenticatePasswordForMember( \IPS\Member $member, $password )
|
||||
public function authenticatePasswordForMember( Member $member, object $password ): bool
|
||||
{
|
||||
if ( $this->authType() & \IPS\Login::AUTH_TYPE_EMAIL )
|
||||
try
|
||||
{
|
||||
try
|
||||
$result = $this->_getRowFromExternalDb( $member->email );
|
||||
|
||||
if( $this->_passwordIsValid( $result, $password ) )
|
||||
{
|
||||
$result = $this->_getRowFromExternalDb( $member->email );
|
||||
|
||||
if( $this->_passwordIsValid( $result, $password ) )
|
||||
{
|
||||
return TRUE;
|
||||
}
|
||||
return TRUE;
|
||||
}
|
||||
catch ( \Exception $e ) { }
|
||||
}
|
||||
|
||||
if ( $this->authType() & \IPS\Login::AUTH_TYPE_USERNAME )
|
||||
{
|
||||
try
|
||||
{
|
||||
$result = $this->_getRowFromExternalDb( $member->name );
|
||||
|
||||
if( $this->_passwordIsValid( $result, $password ) )
|
||||
{
|
||||
return TRUE;
|
||||
}
|
||||
}
|
||||
catch ( \Exception $e ) { }
|
||||
}
|
||||
|
||||
catch ( \Exception $e ) { }
|
||||
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get row from external database
|
||||
*
|
||||
* @param string $usernameOrEmail The username or email address provided by the user
|
||||
* @param string $usernameOrEmail The username or email address provided by the user
|
||||
* @return array
|
||||
* @throws \UnderflowException
|
||||
* @throws \IPS\Db\Exception
|
||||
* @throws UnderflowException
|
||||
* @throws DbException
|
||||
*/
|
||||
public function _getRowFromExternalDb( $usernameOrEmail )
|
||||
public function _getRowFromExternalDb( string $usernameOrEmail ): array
|
||||
{
|
||||
$where = array();
|
||||
|
||||
/* Build where clause */
|
||||
switch ( $this->authType() )
|
||||
{
|
||||
case \IPS\Login::AUTH_TYPE_USERNAME:
|
||||
$where[] = array( "{$this->settings['db_col_user']}=?", $usernameOrEmail );
|
||||
break;
|
||||
|
||||
case \IPS\Login::AUTH_TYPE_EMAIL:
|
||||
$where[] = array( "{$this->settings['db_col_email']}=?", $usernameOrEmail );
|
||||
break;
|
||||
|
||||
case \IPS\Login::AUTH_TYPE_USERNAME + \IPS\Login::AUTH_TYPE_EMAIL:
|
||||
$where[] = array( "({$this->settings['db_col_user']}=? OR {$this->settings['db_col_email']}=?)", $usernameOrEmail, $usernameOrEmail );
|
||||
break;
|
||||
|
||||
}
|
||||
$where[] = array( "{$this->settings['db_col_email']}=?", $usernameOrEmail );
|
||||
|
||||
if ( $this->settings['db_extra'] )
|
||||
{
|
||||
$where[] = array( $this->settings['db_extra'] );
|
||||
@@ -526,13 +514,14 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
}
|
||||
|
||||
/* !Other Login Handler Methods */
|
||||
|
||||
|
||||
/**
|
||||
* Can this handler process a login for a member?
|
||||
* Can this handler process a login for a member?
|
||||
*
|
||||
* @return bool
|
||||
* @param Member $member
|
||||
* @return bool
|
||||
*/
|
||||
public function canProcess( \IPS\Member $member )
|
||||
public function canProcess( Member $member ): bool
|
||||
{
|
||||
if ( $this->settings['db_col_id'] )
|
||||
{
|
||||
@@ -540,24 +529,25 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
}
|
||||
else
|
||||
{
|
||||
if ( $this->authTypes & \IPS\Login::AUTH_TYPE_USERNAME and $member->name and $this->usernameIsInUse( $member->name ) )
|
||||
if ( $this->authTypes & Login::AUTH_TYPE_USERNAME and $member->name and $this->usernameIsInUse( $member->name ) )
|
||||
{
|
||||
return TRUE;
|
||||
}
|
||||
if ( $this->authTypes & \IPS\Login::AUTH_TYPE_EMAIL and $member->email and $this->emailIsInUse( $member->email ) )
|
||||
if ( $this->authTypes & Login::AUTH_TYPE_EMAIL and $member->email and $this->emailIsInUse( $member->email ) )
|
||||
{
|
||||
return TRUE;
|
||||
}
|
||||
return FALSE;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Can this handler process a password change for a member?
|
||||
* Can this handler process a password change for a member?
|
||||
*
|
||||
* @return bool
|
||||
* @param Member $member
|
||||
* @return bool
|
||||
*/
|
||||
public function canChangePassword( \IPS\Member $member )
|
||||
public function canChangePassword( Member $member ): bool
|
||||
{
|
||||
if ( !isset( $this->settings['sync_password_changes'] ) or $this->settings['sync_password_changes'] )
|
||||
{
|
||||
@@ -571,9 +561,9 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function canSyncPassword()
|
||||
public function canSyncPassword(): bool
|
||||
{
|
||||
return (bool) ( isset( $this->settings['sync_password_changes'] ) AND $this->settings['sync_password_changes'] );
|
||||
return ( isset( $this->settings['sync_password_changes'] ) AND $this->settings['sync_password_changes'] );
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -581,10 +571,10 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
* Used when registering or changing an email address to check the new one is available
|
||||
*
|
||||
* @param string $email Email Address
|
||||
* @param \IPS\Member|NULL $exclude Member to exclude
|
||||
* @return bool|NULL Boolean indicates if email is in use (TRUE means is in use and thus not registerable) or NULL if this handler does not support such an API
|
||||
* @param Member|NULL $exclude Member to exclude
|
||||
* @return bool|null Boolean indicates if email is in use (TRUE means is in use and thus not registerable) or NULL if this handler does not support such an API
|
||||
*/
|
||||
public function emailIsInUse( $email, \IPS\Member $exclude=NULL )
|
||||
public function emailIsInUse( string $email, Member $exclude=NULL ): ?bool
|
||||
{
|
||||
$where = array();
|
||||
$where[] = array( "{$this->settings['db_col_email']}=?", $email );
|
||||
@@ -595,10 +585,10 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
{
|
||||
try
|
||||
{
|
||||
$linkedId = \IPS\Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $exclude->member_id ) )->first();
|
||||
$linkedId = Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $exclude->member_id ) )->first();
|
||||
$where[] = array( "{$this->settings['db_col_id']}<>?", $linkedId );
|
||||
}
|
||||
catch ( \UnderflowException $e ) { }
|
||||
catch ( UnderflowException $e ) { }
|
||||
}
|
||||
else
|
||||
{
|
||||
@@ -611,11 +601,11 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
$this->_externalDb()->select( $this->settings['db_col_email'], $this->settings['db_table'], $where )->first();
|
||||
return TRUE;
|
||||
}
|
||||
catch ( \UnderflowException $e )
|
||||
catch ( UnderflowException $e )
|
||||
{
|
||||
return FALSE;
|
||||
}
|
||||
catch ( \IPS\Db\Exception $e )
|
||||
catch ( DbException $e )
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
@@ -626,10 +616,10 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
* Used when registering or changing an username to check the new one is available
|
||||
*
|
||||
* @param string $username Username
|
||||
* @param \IPS\Member|NULL $exclude Member to exclude
|
||||
* @param Member|NULL $exclude Member to exclude
|
||||
* @return bool|NULL Boolean indicates if username is in use (TRUE means is in use and thus not registerable) or NULL if this handler does not support such an API
|
||||
*/
|
||||
public function usernameIsInUse( $username, \IPS\Member $exclude=NULL )
|
||||
public function usernameIsInUse( string $username, Member $exclude=NULL ): ?bool
|
||||
{
|
||||
$where = array();
|
||||
$where[] = array( "{$this->settings['db_col_user']}=?", $username );
|
||||
@@ -640,10 +630,10 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
{
|
||||
try
|
||||
{
|
||||
$linkedId = \IPS\Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $exclude->member_id ) )->first();
|
||||
$linkedId = Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $exclude->member_id ) )->first();
|
||||
$where[] = array( "{$this->settings['db_col_id']}<>?", $linkedId );
|
||||
}
|
||||
catch ( \UnderflowException $e ) { }
|
||||
catch ( UnderflowException $e ) { }
|
||||
}
|
||||
else
|
||||
{
|
||||
@@ -656,11 +646,11 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
$result = $this->_externalDb()->select( $this->settings['db_col_user'], $this->settings['db_table'], $where )->first();
|
||||
return TRUE;
|
||||
}
|
||||
catch ( \UnderflowException $e )
|
||||
catch ( UnderflowException $e )
|
||||
{
|
||||
return FALSE;
|
||||
}
|
||||
catch ( \IPS\Db\Exception $e )
|
||||
catch ( DbException $e )
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
@@ -669,13 +659,13 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
/**
|
||||
* Change Email Address
|
||||
*
|
||||
* @param \IPS\Member $member The member
|
||||
* @param Member $member The member
|
||||
* @param string $oldEmail Old Email Address
|
||||
* @param string $newEmail New Email Address
|
||||
* @return void
|
||||
* @throws \IPS\Db\Exception
|
||||
* @throws DbException
|
||||
*/
|
||||
public function changeEmail( \IPS\Member $member, $oldEmail, $newEmail )
|
||||
public function changeEmail( Member $member, string $oldEmail, string $newEmail ) : void
|
||||
{
|
||||
if ( $this->settings['db_col_email'] and ( !isset( $this->settings['sync_email_changes'] ) or $this->settings['sync_email_changes'] ) )
|
||||
{
|
||||
@@ -684,10 +674,10 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
{
|
||||
try
|
||||
{
|
||||
$linkedId = \IPS\Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $member->member_id ) )->first();
|
||||
$linkedId = Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $member->member_id ) )->first();
|
||||
$where = array( "{$this->settings['db_col_id']}=?", $linkedId );
|
||||
}
|
||||
catch ( \UnderflowException $e ) { }
|
||||
catch ( UnderflowException $e ) { }
|
||||
}
|
||||
$this->_externalDb()->update( $this->settings['db_table'], array( $this->settings['db_col_email'] => $newEmail ), $where );
|
||||
}
|
||||
@@ -696,12 +686,12 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
/**
|
||||
* Change Password
|
||||
*
|
||||
* @param \IPS\Member $member The member
|
||||
* @param Member $member The member
|
||||
* @param string $newPassword New Password, wrapped in an object that can be cast to a string so it doesn't show in any logs
|
||||
* @return void
|
||||
* @throws \IPS\Db\Exception
|
||||
* @throws DbException
|
||||
*/
|
||||
public function changePassword( \IPS\Member $member, $newPassword )
|
||||
public function changePassword( Member $member, string $newPassword ) : void
|
||||
{
|
||||
if ( !isset( $this->settings['sync_password_changes'] ) or $this->settings['sync_password_changes'] )
|
||||
{
|
||||
@@ -709,10 +699,10 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
{
|
||||
try
|
||||
{
|
||||
$linkedId = \IPS\Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $member->member_id ) )->first();
|
||||
$linkedId = Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $member->member_id ) )->first();
|
||||
$where = array( "{$this->settings['db_col_id']}=?", $linkedId );
|
||||
}
|
||||
catch ( \UnderflowException $e )
|
||||
catch ( UnderflowException $e )
|
||||
{
|
||||
return;
|
||||
}
|
||||
@@ -722,15 +712,15 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
$where = '1=0';
|
||||
switch ( $this->authTypes )
|
||||
{
|
||||
case \IPS\Login::AUTH_TYPE_USERNAME:
|
||||
case Login::AUTH_TYPE_USERNAME:
|
||||
$where = array( "{$this->settings['db_col_user']}=?", $member->name );
|
||||
break;
|
||||
|
||||
case \IPS\Login::AUTH_TYPE_EMAIL:
|
||||
case Login::AUTH_TYPE_EMAIL:
|
||||
$where = array( "{$this->settings['db_col_email']}=?", $member->email );
|
||||
break;
|
||||
|
||||
case \IPS\Login::AUTH_TYPE_USERNAME + \IPS\Login::AUTH_TYPE_EMAIL:
|
||||
case Login::AUTH_TYPE_USERNAME + Login::AUTH_TYPE_EMAIL:
|
||||
$where = array( "{$this->settings['db_col_email']}=? OR {$this->settings['db_col_user']}=?", $member->email, $member->name );
|
||||
break;
|
||||
}
|
||||
@@ -743,13 +733,13 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
/**
|
||||
* Change Username
|
||||
*
|
||||
* @param \IPS\Member $member The member
|
||||
* @param Member $member The member
|
||||
* @param string $oldUsername Old Username
|
||||
* @param string $newUsername New Username
|
||||
* @return void
|
||||
* @throws \IPS\Db\Exception
|
||||
* @throws DbException
|
||||
*/
|
||||
public function changeUsername( \IPS\Member $member, $oldUsername, $newUsername )
|
||||
public function changeUsername( Member $member, string $oldUsername, string $newUsername ) : void
|
||||
{
|
||||
if ( $this->settings['db_col_user'] and ( !isset( $this->settings['sync_name_changes'] ) or $this->settings['sync_name_changes'] ) )
|
||||
{
|
||||
@@ -758,10 +748,10 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
{
|
||||
try
|
||||
{
|
||||
$linkedId = \IPS\Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $member->member_id ) )->first();
|
||||
$linkedId = Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $member->member_id ) )->first();
|
||||
$where = array( "{$this->settings['db_col_id']}=?", $linkedId );
|
||||
}
|
||||
catch ( \UnderflowException $e ) { }
|
||||
catch ( UnderflowException $e ) { }
|
||||
}
|
||||
$this->_externalDb()->update( $this->settings['db_table'], array( $this->settings['db_col_user'] => $newUsername ), $where );
|
||||
}
|
||||
@@ -770,21 +760,21 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
/**
|
||||
* Forgot Password URL
|
||||
*
|
||||
* @return \IPS\Http\Url|NULL
|
||||
* @return Url|NULL
|
||||
*/
|
||||
public function forgotPasswordUrl()
|
||||
public function forgotPasswordUrl(): ?Url
|
||||
{
|
||||
return ( isset( $this->settings['forgot_password_url'] ) and $this->settings['forgot_password_url'] ) ? \IPS\Http\Url::external( $this->settings['forgot_password_url'] ) : NULL;
|
||||
return ( isset( $this->settings['forgot_password_url'] ) and $this->settings['forgot_password_url'] ) ? Url::external( $this->settings['forgot_password_url'] ) : NULL;
|
||||
}
|
||||
|
||||
/**
|
||||
* Force Password Reset URL
|
||||
*
|
||||
* @param \IPS\Member $member The member
|
||||
* @param \IPS\Http\Url|NULL $ref Referrer
|
||||
* @return \IPS\Http\Url|NULL
|
||||
* @param Member $member The member
|
||||
* @param Url|NULL $ref Referrer
|
||||
* @return Url|NULL
|
||||
*/
|
||||
public function forcePasswordResetUrl( \IPS\Member $member, ?\IPS\Http\Url $ref = NULL ): ?\IPS\Http\Url
|
||||
public function forcePasswordResetUrl( Member $member, ?Url $ref = NULL ): ?Url
|
||||
{
|
||||
return $member->passwordResetForced( $ref );
|
||||
}
|
||||
@@ -793,13 +783,13 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
* Get user's profile name
|
||||
* May return NULL if server doesn't support this
|
||||
*
|
||||
* @param \IPS\Member $member Member
|
||||
* @param Member $member Member
|
||||
* @return string|NULL
|
||||
* @throws \IPS\Login\Exception The token is invalid and the user needs to reauthenticate
|
||||
* @throws \DomainException General error where it is safe to show a message to the user
|
||||
* @throws \RuntimeException Unexpected error from service
|
||||
* @throws Exception The token is invalid and the user needs to reauthenticate
|
||||
* @throws DomainException General error where it is safe to show a message to the user
|
||||
* @throws RuntimeException Unexpected error from service
|
||||
*/
|
||||
public function userProfileName( \IPS\Member $member )
|
||||
public function userProfileName( Member $member ): ?string
|
||||
{
|
||||
if ( isset( $this->settings['db_col_user'] ) and $this->settings['db_col_user'] )
|
||||
{
|
||||
@@ -809,25 +799,17 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
{
|
||||
if ( $this->settings['db_col_id'] )
|
||||
{
|
||||
$linkedId = \IPS\Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $member->member_id ) )->first();
|
||||
$result = $this->_externalDb()->select( '*', $this->settings['db_table'], array( "{$this->settings['db_col_id']}=?", $linkedId ) )->first();;
|
||||
$linkedId = Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $member->member_id ) )->first();
|
||||
$result = $this->_externalDb()->select( '*', $this->settings['db_table'], array( "{$this->settings['db_col_id']}=?", $linkedId ) )->first();
|
||||
}
|
||||
else
|
||||
{
|
||||
if ( $this->authType() & \IPS\Login::AUTH_TYPE_EMAIL )
|
||||
{
|
||||
$result = $this->_getRowFromExternalDb( $member->email );
|
||||
}
|
||||
|
||||
if ( !$result and $this->authType() & \IPS\Login::AUTH_TYPE_USERNAME )
|
||||
{
|
||||
$result = $this->_getRowFromExternalDb( $member->name );
|
||||
}
|
||||
$result = $this->_getRowFromExternalDb( $member->email );
|
||||
}
|
||||
}
|
||||
catch ( \Exception $e )
|
||||
{
|
||||
throw new \IPS\Login\Exception( NULL, \IPS\Login\Exception::INTERNAL_ERROR );
|
||||
throw new Exception( "", Exception::INTERNAL_ERROR );
|
||||
}
|
||||
|
||||
if ( $result )
|
||||
@@ -836,7 +818,7 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
}
|
||||
else
|
||||
{
|
||||
throw new \IPS\Login\Exception( NULL, \IPS\Login\Exception::INTERNAL_ERROR );
|
||||
throw new Exception( "", Exception::INTERNAL_ERROR );
|
||||
}
|
||||
}
|
||||
|
||||
@@ -847,13 +829,13 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
* Get user's email address
|
||||
* May return NULL if server doesn't support this
|
||||
*
|
||||
* @param \IPS\Member $member Member
|
||||
* @param Member $member Member
|
||||
* @return string|NULL
|
||||
* @throws \IPS\Login\Exception The token is invalid and the user needs to reauthenticate
|
||||
* @throws \DomainException General error where it is safe to show a message to the user
|
||||
* @throws \RuntimeException Unexpected error from service
|
||||
* @throws Exception The token is invalid and the user needs to reauthenticate
|
||||
* @throws DomainException General error where it is safe to show a message to the user
|
||||
* @throws RuntimeException Unexpected error from service
|
||||
*/
|
||||
public function userEmail( \IPS\Member $member )
|
||||
public function userEmail( Member $member ): ?string
|
||||
{
|
||||
if ( isset( $this->settings['db_col_email'] ) and $this->settings['db_col_email'] )
|
||||
{
|
||||
@@ -863,25 +845,17 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
{
|
||||
if ( $this->settings['db_col_id'] )
|
||||
{
|
||||
$linkedId = \IPS\Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $member->member_id ) )->first();
|
||||
$linkedId = Db::i()->select( 'token_identifier', 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $member->member_id ) )->first();
|
||||
$result = $this->_externalDb()->select( '*', $this->settings['db_table'], array( "{$this->settings['db_col_id']}=?", $linkedId ) )->first();
|
||||
}
|
||||
else
|
||||
{
|
||||
if ( $this->authType() & \IPS\Login::AUTH_TYPE_EMAIL )
|
||||
{
|
||||
$result = $this->_getRowFromExternalDb( $member->email );
|
||||
}
|
||||
|
||||
if ( !$result and $this->authType() & \IPS\Login::AUTH_TYPE_USERNAME )
|
||||
{
|
||||
$result = $this->_getRowFromExternalDb( $member->name );
|
||||
}
|
||||
$result = $this->_getRowFromExternalDb( $member->email );
|
||||
}
|
||||
}
|
||||
catch ( \Exception $e )
|
||||
{
|
||||
throw new \IPS\Login\Exception( NULL, \IPS\Login\Exception::INTERNAL_ERROR );
|
||||
throw new Exception( "", Exception::INTERNAL_ERROR );
|
||||
}
|
||||
|
||||
if ( $result )
|
||||
@@ -890,7 +864,7 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
}
|
||||
else
|
||||
{
|
||||
throw new \IPS\Login\Exception( NULL, \IPS\Login\Exception::INTERNAL_ERROR );
|
||||
throw new Exception( "", Exception::INTERNAL_ERROR );
|
||||
}
|
||||
}
|
||||
|
||||
@@ -900,11 +874,11 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
/**
|
||||
* Syncing Options
|
||||
*
|
||||
* @param \IPS\Member $member The member we're asking for (can be used to not show certain options iof the user didn't grant those scopes)
|
||||
* @param Member $member The member we're asking for (can be used to not show certain options iof the user didn't grant those scopes)
|
||||
* @param bool $defaultOnly If TRUE, only returns which options should be enabled by default for a new account
|
||||
* @return array
|
||||
*/
|
||||
public function syncOptions( \IPS\Member $member, $defaultOnly = FALSE )
|
||||
public function syncOptions( Member $member, bool $defaultOnly=FALSE ): array
|
||||
{
|
||||
$return = array();
|
||||
|
||||
@@ -926,7 +900,7 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function hasSyncOptions()
|
||||
public function hasSyncOptions(): bool
|
||||
{
|
||||
return TRUE;
|
||||
}
|
||||
@@ -936,22 +910,22 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
/**
|
||||
* Get DB Connection
|
||||
*
|
||||
* @return bool
|
||||
* @throws \IPS\Db\Exception
|
||||
* @return Db
|
||||
* @throws DbException
|
||||
*/
|
||||
protected function _externalDb()
|
||||
protected function _externalDb(): Db
|
||||
{
|
||||
return \IPS\Db::i( 'external_login_' . $this->id, $this->settings );
|
||||
return Db::i( 'external_login_' . $this->id, $this->settings );
|
||||
}
|
||||
|
||||
/**
|
||||
* Password is valid
|
||||
*
|
||||
* @param array $row The member row
|
||||
* @param object $providedPassword The plaintext password provided by the user, wrapped in an object that can be cast to a string so it doesn't show in any logs
|
||||
* @param array $row The member row
|
||||
* @param object $providedPassword The plaintext password provided by the user, wrapped in an object that can be cast to a string so it doesn't show in any logs
|
||||
* @return bool
|
||||
*/
|
||||
protected function _passwordIsValid( $row, $providedPassword )
|
||||
protected function _passwordIsValid( array $row, object $providedPassword ): bool
|
||||
{
|
||||
switch ( $this->settings['db_encryption'] )
|
||||
{
|
||||
@@ -963,29 +937,24 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
{
|
||||
return @eval( $this->settings['db_encryption_validate'] );
|
||||
}
|
||||
catch ( \Exception $e )
|
||||
catch ( \Exception|Throwable $e )
|
||||
{
|
||||
\IPS\Log::log( $e, 'external_login' );
|
||||
throw new \IPS\Login\Exception( 'generic_error', \IPS\Login\Exception::INTERNAL_ERROR );
|
||||
}
|
||||
catch ( \Throwable $e )
|
||||
{
|
||||
\IPS\Log::log( $e, 'external_login' );
|
||||
throw new \IPS\Login\Exception( 'generic_error', \IPS\Login\Exception::INTERNAL_ERROR );
|
||||
Log::log( $e, 'external_login' );
|
||||
throw new Exception( 'generic_error', Exception::INTERNAL_ERROR );
|
||||
}
|
||||
|
||||
default:
|
||||
return \IPS\Login::compareHashes( $row[ $this->settings['db_col_pass'] ], $this->_encryptedPassword( $providedPassword ) );
|
||||
return Login::compareHashes( $row[ $this->settings['db_col_pass'] ], $this->_encryptedPassword( $providedPassword ) );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Encrypted password
|
||||
*
|
||||
* @param object $providedPassword The plaintext password provided by the user, wrapped in an object that can be cast to a string so it doesn't show in any logs
|
||||
* @param object|string $providedPassword The plaintext password provided by the user, wrapped in an object that can be cast to a string so it doesn't show in any logs
|
||||
* @return string
|
||||
*/
|
||||
protected function _encryptedPassword( $providedPassword )
|
||||
protected function _encryptedPassword( object|string $providedPassword ): string
|
||||
{
|
||||
$providedPassword = (string) $providedPassword;
|
||||
|
||||
@@ -1005,15 +974,10 @@ class _ExternalDatabase extends \IPS\Login\Handler
|
||||
{
|
||||
return @eval( $this->settings['db_encryption_hash'] );
|
||||
}
|
||||
catch ( \Exception $e )
|
||||
catch ( \Exception|Throwable $e )
|
||||
{
|
||||
\IPS\Log::log( $e, 'external_login' );
|
||||
throw new \IPS\Login\Exception( 'generic_error', \IPS\Login\Exception::INTERNAL_ERROR );
|
||||
}
|
||||
catch ( \Throwable $e )
|
||||
{
|
||||
\IPS\Log::log( $e, 'external_login' );
|
||||
throw new \IPS\Login\Exception( 'generic_error', \IPS\Login\Exception::INTERNAL_ERROR );
|
||||
Log::log( $e, 'external_login' );
|
||||
throw new Exception( 'generic_error', Exception::INTERNAL_ERROR );
|
||||
}
|
||||
|
||||
default:
|
||||
|
||||
Reference in new issue
Block a user