sydney/IPB
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Version 5.0.0 beta 1

Browse Source
This commit is contained in:
Neo committed 2025-12-19 16:27:35 -08:00
1 parent 25ddeb65d6
commit 15c7beabc5
6736 files changed
+627902 -497943
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

system/Login/Handler/OAuth1/OAuth1.php
+120 -95
View File
@@ -12,38 +12,58 @@
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\Helpers\Form\Radio;
use IPS\Helpers\Form\Text;
use IPS\Http\Response;
use IPS\Http\Url;
use IPS\Log;
use IPS\Login;
use IPS\Login\Exception;
use IPS\Login\Handler;
use IPS\Member;
use IPS\Output;
use IPS\Request;
use IPS\Session;
use LogicException;
use RuntimeException;
use UnderflowException;
use function count;
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;
}
/**
* Abstract OAuth1 Login Handler
*/
abstract class _OAuth1 extends \IPS\Login\Handler
abstract class OAuth1 extends Handler
{
/* !Login Handler: Basics */
/**
* 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
{
$return = array(
array( 'login_handler_oauth_settings', \IPS\Member::loggedIn()->language()->addToStack( static::getTitle() . '_info', FALSE, array( 'sprintf' => array( (string) $this->redirectionEndpoint() ) ) ) ),
'consumer_key' => new \IPS\Helpers\Form\Text( 'oauth_consumer_key', ( isset( $this->settings['consumer_key'] ) ) ? $this->settings['consumer_key'] : '', TRUE ),
'consumer_secret' => new \IPS\Helpers\Form\Text( 'oauth_consumer_secret', ( isset( $this->settings['consumer_secret'] ) ) ? $this->settings['consumer_secret'] : '', TRUE ),
array( 'login_handler_oauth_settings', Member::loggedIn()->language()->addToStack( static::getTitle() . '_info', FALSE, array( 'sprintf' => array( (string) $this->redirectionEndpoint() ) ) ) ),
'consumer_key' => new Text( 'oauth_consumer_key', ( isset( $this->settings['consumer_key'] ) ) ? $this->settings['consumer_key'] : '', TRUE ),
'consumer_secret' => new Text( 'oauth_consumer_secret', ( isset( $this->settings['consumer_secret'] ) ) ? $this->settings['consumer_secret'] : '', TRUE ),
);
$return[] = 'account_management_settings';
$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'] : 'always', FALSE, array(
$return['show_in_ucp'] = new Radio( 'login_handler_show_in_ucp', $this->settings['show_in_ucp'] ?? 'always', FALSE, array(
'options' => array(
'always' => 'login_handler_show_in_ucp_always',
'loggedin' => 'login_handler_show_in_ucp_loggedin',
@@ -55,9 +75,9 @@ abstract class _OAuth1 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 ) );
}
$return['update_name_changes'] = new \IPS\Helpers\Form\Radio( 'login_update_name_changes', isset( $this->settings['update_name_changes'] ) ? $this->settings['update_name_changes'] : 'disabled', FALSE, array( 'options' => array(
$return['update_name_changes'] = new Radio( 'login_update_name_changes', $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',
@@ -67,9 +87,9 @@ abstract class _OAuth1 extends \IPS\Login\Handler
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_email_changes'] = new \IPS\Helpers\Form\Radio( 'login_update_email_changes', isset( $this->settings['update_email_changes'] ) ? $this->settings['update_email_changes'] : 'optional', FALSE, array( 'options' => array(
$return['update_email_changes'] = new Radio( 'login_update_email_changes', $this->settings['update_email_changes'] ?? 'optional', FALSE, array( 'options' => array(
'force' => 'login_update_changes_yes_email',
'optional' => 'login_update_changes_optional',
'disabled' => 'login_update_changes_no',
@@ -82,9 +102,9 @@ abstract class _OAuth1 extends \IPS\Login\Handler
* Test Settings
*
* @return bool
* @throws \LogicException
* @throws LogicException
*/
public function testSettings()
public function testSettings(): bool
{
try
{
@@ -92,7 +112,7 @@ abstract class _OAuth1 extends \IPS\Login\Handler
}
catch ( \Exception $e )
{
throw new \LogicException( \IPS\Member::loggedIn()->language()->addToStack( 'oauth1_setup_error', FALSE, array( 'sprintf' => array( $e->getMessage() ) ) ) );
throw new LogicException( Member::loggedIn()->language()->addToStack( 'oauth1_setup_error', FALSE, array( 'sprintf' => array( $e->getMessage() ) ) ) );
}
try
@@ -101,28 +121,30 @@ abstract class _OAuth1 extends \IPS\Login\Handler
}
catch ( \Exception $e )
{
throw new \LogicException( \IPS\Member::loggedIn()->language()->addToStack( 'oauth1_setup_error', FALSE, array( 'sprintf' => array( (string) $response ) ) ) );
throw new LogicException( Member::loggedIn()->language()->addToStack( 'oauth1_setup_error', FALSE, array( 'sprintf' => array( (string) $response ) ) ) );
}
return true;
}
/* !Authentication */
use \IPS\Login\Handler\ButtonHandler;
use ButtonHandler;
/**
* Authenticate
*
* @param \IPS\Login $login The login object
* @return \IPS\Member
* @throws \IPS\Login\Exception
* @param Login $login The login object
* @return Member|null
* @throws Exception
*/
public function authenticateButton( \IPS\Login $login )
public function authenticateButton( Login $login ) : ?Member
{
if ( isset( \IPS\Request::i()->denied ) )
if ( isset( Request::i()->denied ) )
{
return NULL;
}
elseif ( isset( \IPS\Request::i()->oauth_token ) )
elseif ( isset( Request::i()->oauth_token ) )
{
return $this->_handleAuthorizationResponse( $login );
}
@@ -130,17 +152,19 @@ abstract class _OAuth1 extends \IPS\Login\Handler
{
$this->_redirectToAuthorizationEndpoint( $login );
}
return null;
}
/**
* Redirect to Resource Owner Authorization Endpoint
*
* @param \IPS\Login $login The login object
* @param Login $login The login object
* @return void
*/
protected function _redirectToAuthorizationEndpoint( \IPS\Login $login )
protected function _redirectToAuthorizationEndpoint( Login $login ) : void
{
$callback = $this->redirectionEndpoint()->setQueryString( 'state' , $this->id . '-' . base64_encode( $login->url ) . '-' . \IPS\Session::i()->csrfKey . '-' . \IPS\Request::i()->ref );
$callback = $this->redirectionEndpoint()->setQueryString( 'state' , $this->id . '-' . base64_encode( $login->url ) . '-' . Session::i()->csrfKey . '-' . Request::i()->ref );
try
{
@@ -148,31 +172,31 @@ abstract class _OAuth1 extends \IPS\Login\Handler
}
catch ( \Exception $e )
{
\IPS\Log::log( $e, 'twitter' );
throw new \IPS\Login\Exception( 'generic_error', \IPS\Login\Exception::INTERNAL_ERROR );
Log::log( $e, 'twitter' );
throw new Exception( 'generic_error', Exception::INTERNAL_ERROR );
}
\IPS\Output::i()->redirect( $this->authorizationEndpoint( $login )->setQueryString( 'oauth_token', $response['oauth_token'] ) );
Output::i()->redirect( $this->authorizationEndpoint( $login )->setQueryString( 'oauth_token', $response['oauth_token'] ) );
}
/**
* Handle authorization response
*
* @param \IPS\Login $login The login object
* @return \IPS\Member
* @throws \IPS\Login\Exception
* @param Login $login The login object
* @return Member
* @throws Exception
*/
protected function _handleAuthorizationResponse( \IPS\Login $login )
protected function _handleAuthorizationResponse( Login $login ): Member
{
/* Authenticate */
try
{
$response = $this->_sendRequest( 'post', $this->accessTokenEndpoint(), array( 'oauth_verifier' => \IPS\Request::i()->oauth_verifier ), \IPS\Request::i()->oauth_token )->decodeQueryString('oauth_token');
$response = $this->_sendRequest( 'post', $this->accessTokenEndpoint(), array( 'oauth_verifier' => Request::i()->oauth_verifier ), Request::i()->oauth_token )->decodeQueryString('oauth_token');
}
catch ( \Exception $e )
{
\IPS\Log::log( $e, 'twitter' );
throw new \IPS\Login\Exception( 'generic_error', \IPS\Login\Exception::INTERNAL_ERROR );
Log::log( $e, 'twitter' );
throw new Exception( 'generic_error', Exception::INTERNAL_ERROR );
}
/* Get user id */
@@ -182,25 +206,25 @@ abstract class _OAuth1 extends \IPS\Login\Handler
}
catch ( \Exception $e )
{
\IPS\Log::log( $e, 'oauth' );
throw new \IPS\Login\Exception( 'generic_error', \IPS\Login\Exception::INTERNAL_ERROR );
Log::log( $e, 'oauth' );
throw new Exception( 'generic_error', Exception::INTERNAL_ERROR );
}
/* Has this user signed in with this service before? */
try
{
$oauthAccess = \IPS\Db::i()->select( '*', 'core_login_links', array( 'token_login_method=? AND token_identifier=?', $this->id, $userId ) )->first();
$member = \IPS\Member::load( $oauthAccess['token_member'] );
$oauthAccess = Db::i()->select( '*', 'core_login_links', array( 'token_login_method=? AND token_identifier=?', $this->id, $userId ) )->first();
$member = Member::load( $oauthAccess['token_member'] );
/* If the user never finished the linking process, or the account has been deleted, discard this access token */
if ( !$oauthAccess['token_linked'] or !$member->member_id )
{
\IPS\Db::i()->delete( 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $oauthAccess['token_member'] ) );
throw new \UnderflowException;
Db::i()->delete( 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $oauthAccess['token_member'] ) );
throw new UnderflowException;
}
/* Otherwise, update our token... */
\IPS\Db::i()->update( 'core_login_links', array(
Db::i()->update( 'core_login_links', array(
'token_access_token' => $response['oauth_token'],
'token_secret' => $response['oauth_token_secret'],
), array( 'token_login_method=? AND token_member=?', $this->id, $oauthAccess['token_member'] ) );
@@ -209,7 +233,7 @@ abstract class _OAuth1 extends \IPS\Login\Handler
return $member;
}
/* No, create or link the account */
catch ( \UnderflowException $e )
catch ( UnderflowException $e )
{
/* Get the username + email */
$name = NULL;
@@ -227,9 +251,9 @@ abstract class _OAuth1 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;
@@ -237,7 +261,7 @@ abstract class _OAuth1 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' => $userId,
@@ -268,23 +292,23 @@ abstract class _OAuth1 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 != $userId )
{
$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' => $userId,
@@ -303,53 +327,54 @@ abstract class _OAuth1 extends \IPS\Login\Handler
/**
* Authorization Endpoint
*
* @param \IPS\Login $login The login object
* @return \IPS\Http\Url
* @param Login $login The login object
* @return Url
*/
abstract protected function authorizationEndpoint( \IPS\Login $login );
abstract protected function authorizationEndpoint( Login $login ): Url;
/**
* Token Request Endpoint
*
* @return \IPS\Http\Url
* @return Url
*/
abstract protected function tokenRequestEndpoint();
abstract protected function tokenRequestEndpoint(): Url;
/**
* Access Token Endpoint
*
* @return \IPS\Http\Url
* @return Url
*/
abstract protected function accessTokenEndpoint();
abstract protected function accessTokenEndpoint(): Url;
/**
* Redirection Endpoint
*
* @return \IPS\Http\Url
* @return Url
*/
public function redirectionEndpoint()
public function redirectionEndpoint(): Url
{
return \IPS\Http\Url::internal( 'oauth/callback/', 'none' );
return Url::internal( 'oauth/callback/', 'none' );
}
/**
* Send Request
*
* @param string $method HTTP Method
* @param \IPS\Http\Url $url URL
* @param array|string|NULL $params Parameters
* @param string $token OAuth Token
* @param array $otherParams Other params to send obvs
* @param string $mimeBoundary Mime data to send (boundary => data )
* @return \IPS\Http\Response
* @param string $method HTTP Method
* @param Url $url URL
* @param array|string|null $params Parameters
* @param string $token OAuth Token
* @param string $secret OAuth Secret
* @param array $otherParams Other params to send obvs
* @param array|string $mimeBoundary Mime data to send (boundary => data )
* @return Response
* @throws \IPS\Http\Request\Exception
*/
protected function _sendRequest( $method, $url, $params=array(), $token='', $secret='', $otherParams=array(), $mimeBoundary=array() )
protected function _sendRequest( string $method, Url $url, array|string|null $params=array(), string $token='', string $secret='', array $otherParams=array(), array|string $mimeBoundary=array() ): Response
{
/* Generate the OAUTH Authorization Header */
$OAuthAuthorization = array_merge( array(
'oauth_consumer_key' => $this->settings['consumer_key'],
'oauth_nonce' => md5( \IPS\Login::generateRandomString() ),
'oauth_nonce' => md5( Login::generateRandomString() ),
'oauth_signature_method'=> 'HMAC-SHA1',
'oauth_timestamp' => time(),
'oauth_token' => $token,
@@ -392,7 +417,7 @@ abstract class _OAuth1 extends \IPS\Login\Handler
$headers = array( 'Authorization' => $OAuthAuthorizationHeader );
/* Send the request */
if ( ! \count( $mimeBoundary ) )
if ( ! count( $mimeBoundary ) )
{
if ( $method === 'get' )
{
@@ -415,17 +440,17 @@ abstract class _OAuth1 extends \IPS\Login\Handler
* Get user's identifier (may not be a number)
* 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 userId( \IPS\Member $member )
public function userId( Member $member ): ?string
{
if ( !( $link = $this->_link( $member ) ) )
{
throw new \IPS\Login\Exception( $error['message'], \IPS\Login\Exception::INTERNAL_ERROR );
throw new Exception( "", Exception::INTERNAL_ERROR );
}
return $this->authenticatedUserId( $link['token_access_token'], $link['token_secret'] );
@@ -435,17 +460,17 @@ abstract class _OAuth1 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 ( !( $link = $this->_link( $member ) ) )
{
throw new \IPS\Login\Exception( NULL, \IPS\Login\Exception::INTERNAL_ERROR );
throw new Exception( "", Exception::INTERNAL_ERROR );
}
return $this->authenticatedUserName( $link['token_access_token'], $link['token_secret'] );
@@ -455,17 +480,17 @@ abstract class _OAuth1 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 ( !( $link = $this->_link( $member ) ) )
{
throw new \IPS\Login\Exception( $error['message'], \IPS\Login\Exception::INTERNAL_ERROR );
throw new Exception( "", Exception::INTERNAL_ERROR );
}
return $this->authenticatedEmail( $link['token_access_token'], $link['token_secret'] );
@@ -476,10 +501,10 @@ abstract class _OAuth1 extends \IPS\Login\Handler
/**
* Show in Account Settings?
*
* @param \IPS\Member|NULL $member The member, or NULL for if it should show generally
* @param Member|NULL $member The member, or NULL for if it should show generally
* @return bool
*/
public function showInUcp( \IPS\Member $member = NULL )
public function showInUcp( Member $member = NULL ): bool
{
$return = parent::showInUcp( $member );
@@ -495,7 +520,7 @@ abstract class _OAuth1 extends \IPS\Login\Handler
*
* @return bool
*/
public function hasSyncOptions()
public function hasSyncOptions(): bool
{
return TRUE;
}
system/Login/Handler/OAuth1/Twitter.php
+124 -206
View File
@@ -11,23 +11,39 @@
namespace IPS\Login\Handler\OAuth1;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
use DomainException;
use IPS\Data\Store;
use IPS\Db;
use IPS\Helpers\Form\Radio;
use IPS\Http\Request\Exception;
use IPS\Http\Url;
use IPS\Login;
use IPS\Login\Exception as LoginException;
use IPS\Login\Handler\OAuth1;
use IPS\Member;
use IPS\Theme;
use RuntimeException;
use UnexpectedValueException;
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;
}
/**
* Twitter Login Handler
*/
class _Twitter extends \IPS\Login\Handler\OAuth1
class Twitter extends OAuth1
{
/**
* Get title
*
* @return string
*/
public static function getTitle()
public static function getTitle(): string
{
return 'login_handler_Twitter';
}
@@ -35,19 +51,18 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
/**
* 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
{
\IPS\Member::loggedIn()->language()->words['login_acp_desc'] = \IPS\Member::loggedIn()->language()->addToStack('login_acp_will_reauth');
Member::loggedIn()->language()->words['login_acp_desc'] = Member::loggedIn()->language()->addToStack('login_acp_will_reauth');
return array_merge(
array(
'name' => new \IPS\Helpers\Form\Radio( 'login_real_name', ( isset( $this->settings['name'] ) ) ? $this->settings['name'] : 'any', TRUE, array(
'name' => new Radio( 'login_real_name', ( isset( $this->settings['name'] ) ) ? $this->settings['name'] : 'any', TRUE, array(
'options' => array(
'real' => 'login_twitter_name_real',
'screen' => 'login_twitter_name_screen',
@@ -60,9 +75,7 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
), NULL, NULL, NULL, 'login_real_name' ),
),
parent::acpForm(),
array(
'allow_status_import' => new \IPS\Helpers\Form\YesNo( 'login_generic_allow_status_import', ( isset( $this->settings['allow_status_import'] ) ) ? $this->settings['allow_status_import'] : FALSE, FALSE )
)
array()
);
}
@@ -71,9 +84,9 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
*
* @return string
*/
public function buttonColor()
public function buttonColor(): string
{
return '#000000';
return '#1d9bf0';
}
/**
@@ -81,9 +94,9 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
*
* @return string
*/
public function buttonIcon()
public function buttonIcon(): string
{
return 'twitter';
return 'x-twitter';
}
/**
@@ -91,7 +104,7 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
*
* @return string
*/
public function buttonText()
public function buttonText(): string
{
return 'login_twitter';
}
@@ -101,42 +114,42 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
*
* @return string
*/
public function buttonClass()
public function buttonClass(): string
{
return 'ipsSocial_twitter';
return 'ipsSocial--twitter';
}
/**
* Get logo to display in information about logins with this method
* Returns NULL for methods where it is not necessary to indicate the method, e..g Standard
*
* @return \IPS\Http\Url
* @return Url|string|null
*/
public function logoForDeviceInformation()
public function logoForDeviceInformation(): Url|string|null
{
return \IPS\Theme::i()->resource( 'logos/login/X.png', 'core', 'interface' );
return Theme::i()->resource( 'logos/login/Twitter.png', 'core', 'interface' );
}
/**
* Authorization Endpoint
*
* @param \IPS\Login $login The login object
* @return \IPS\Http\Url
* @param Login $login The login object
* @return Url
*/
protected function authorizationEndpoint( \IPS\Login $login )
protected function authorizationEndpoint( Login $login ): Url
{
$return = \IPS\Http\Url::external('https://api.twitter.com/oauth/authenticate');
$return = Url::external('https://api.twitter.com/oauth/authenticate');
if ( $login->type === \IPS\Login::LOGIN_ACP or $login->type === \IPS\Login::LOGIN_REAUTHENTICATE )
if ( $login->type === Login::LOGIN_ACP or $login->type === Login::LOGIN_REAUTHENTICATE )
{
$return = $return->setQueryString( 'force_login', 'true' );
}
if ( $login->type === \IPS\Login::LOGIN_REAUTHENTICATE )
if ( $login->type === Login::LOGIN_REAUTHENTICATE )
{
try
{
$token = \IPS\Db::i()->select( array( 'token_access_token', 'token_secret' ), 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $login->reauthenticateAs->member_id ) )->first();
$token = Db::i()->select( array( 'token_access_token', 'token_secret' ), 'core_login_links', array( 'token_login_method=? AND token_member=?', $this->id, $login->reauthenticateAs->member_id ) )->first();
$userDetails = $this->_userData( $token['token_access_token'], $token['token_secret'] );
if ( isset( $userDetails['screen_name'] ) )
{
@@ -152,21 +165,21 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
/**
* Token Request Endpoint
*
* @return \IPS\Http\Url
* @return Url
*/
protected function tokenRequestEndpoint()
protected function tokenRequestEndpoint(): Url
{
return \IPS\Http\Url::external('https://api.twitter.com/oauth/request_token');
return Url::external('https://api.twitter.com/oauth/request_token');
}
/**
* Access Token Endpoint
*
* @return \IPS\Http\Url
* @return Url
*/
protected function accessTokenEndpoint()
protected function accessTokenEndpoint(): Url
{
return \IPS\Http\Url::external('https://api.twitter.com/oauth/access_token');
return Url::external('https://api.twitter.com/oauth/access_token');
}
/**
@@ -176,7 +189,7 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
* @param string $accessTokenSecret Access Token Secret
* @return string
*/
protected function authenticatedUserId( $accessToken, $accessTokenSecret )
protected function authenticatedUserId( string $accessToken, string $accessTokenSecret ): string
{
return $this->_userData( $accessToken, $accessTokenSecret )['id'];
}
@@ -185,11 +198,11 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
* Get authenticated user's username
* May return NULL if server doesn't support this
*
* @param string $accessToken Access Token
* @param string $accessTokenSecret Access Token Secret
* @param string $accessToken Access Token
* @param string $accessTokenSecret Access Token Secret
* @return string|NULL
*/
protected function authenticatedUserName( $accessToken, $accessTokenSecret )
protected function authenticatedUserName( string $accessToken, string $accessTokenSecret ): ?string
{
if ( $this->settings['name'] == 'screen' )
{
@@ -206,11 +219,11 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
* Get authenticated user's email address
* May return NULL if server doesn't support this
*
* @param string $accessToken Access Token
* @param string $accessTokenSecret Access Token Secret
* @param string $accessToken Access Token
* @param string $accessTokenSecret Access Token Secret
* @return string|NULL
*/
protected function authenticatedEmail( $accessToken, $accessTokenSecret )
protected function authenticatedEmail( string $accessToken, string $accessTokenSecret ): ?string
{
return $this->_userData( $accessToken, $accessTokenSecret )['email'];
}
@@ -219,17 +232,17 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
* 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 LoginException 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 ( !( $link = $this->_link( $member ) ) )
{
throw new \IPS\Login\Exception( NULL, \IPS\Login\Exception::INTERNAL_ERROR );
throw new LoginException( "", LoginException::INTERNAL_ERROR );
}
return $this->_userData( $link['token_access_token'], $link['token_secret'] )['screen_name'];
@@ -239,23 +252,23 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
* Get user's profile photo
* May return NULL if server doesn't support this
*
* @param \IPS\Member $member Member
* @return \IPS\Http\Url|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
* @param Member $member Member
* @return Url|NULL
* @throws LoginException 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 userProfilePhoto( \IPS\Member $member )
public function userProfilePhoto( Member $member ): ?Url
{
if ( !( $link = $this->_link( $member ) ) )
{
throw new \IPS\Login\Exception( NULL, \IPS\Login\Exception::INTERNAL_ERROR );
throw new LoginException( "", LoginException::INTERNAL_ERROR );
}
$userData = $this->_userData( $link['token_access_token'], $link['token_secret'] );
if ( !$userData['default_profile_image'] )
{
return \IPS\Http\Url::external( str_replace( '_normal', '', $userData['profile_image_url_https'] ?: $userData['profile_image_url'] ) );
return Url::external( str_replace( '_normal', '', $userData['profile_image_url_https'] ?: $userData['profile_image_url'] ) );
}
return NULL;
}
@@ -264,62 +277,27 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
* Get user's cover photo
* May return NULL if server doesn't support this
*
* @param \IPS\Member $member Member
* @return \IPS\Http\Url|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
* @param Member $member Member
* @return Url|NULL
* @throws LoginException 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 userCoverPhoto( \IPS\Member $member )
public function userCoverPhoto( Member $member ): ?Url
{
if ( !( $link = $this->_link( $member ) ) )
{
throw new \IPS\Login\Exception( NULL, \IPS\Login\Exception::INTERNAL_ERROR );
throw new LoginException( "", LoginException::INTERNAL_ERROR );
}
$userData = $this->_userData( $link['token_access_token'], $link['token_secret'] );
if ( isset( $userData['profile_banner_url'] ) and $userData['profile_banner_url'] )
{
return \IPS\Http\Url::external( $userData['profile_banner_url'] );
return Url::external( $userData['profile_banner_url'] );
}
return NULL;
}
/**
* Get user's statuses since a particular date
*
* @param \IPS\Member $member Member
* @param \IPS\DateTime|NULL $since Date/Time to get statuses since then, or NULL to get the latest one
* @return array
* @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
*/
public function userStatuses( \IPS\Member $member, \IPS\DateTime $since = NULL )
{
if ( !( $link = $this->_link( $member ) ) )
{
throw new \IPS\Login\Exception( NULL, \IPS\Login\Exception::INTERNAL_ERROR );
}
$return = array();
$response = $this->_sendRequest( 'get', \IPS\Http\Url::external('https://api.twitter.com/1.1/statuses/user_timeline.json'), $since ? array() : array( 'count' => 1 ), $link['token_access_token'], $link['token_secret'] )->decodeJson();
foreach ( $response as $statusData )
{
if ( $since and strtotime( $statusData['created_at'] ) < $since->getTimestamp() )
{
break;
}
$status = \IPS\core\Statuses\Status::createItem( $member, $member->ip_address, new \IPS\DateTime( $statusData['created_at'] ) );
$status->content = $this->_parseStatusText( $member, nl2br( $statusData['text'], FALSE ) );
$return[] = $status;
}
return $return;
}
/**
* Get link to user's remote profile
@@ -327,24 +305,24 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
*
* @param string $identifier The ID Nnumber/string from remote service
* @param string $username The username from remote service
* @return \IPS\Http\Url|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
* @return Url|NULL
* @throws LoginException 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 userLink( $identifier, $username )
public function userLink( string $identifier, string $username ): ?Url
{
return \IPS\Http\Url::external( "https://twitter.com/" )->setPath( $username );
return Url::external( "https://twitter.com/" )->setPath( $username );
}
/**
* 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();
@@ -361,36 +339,31 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
$return[] = 'photo';
$return[] = 'cover';
if ( \IPS\Settings::i()->profile_comments and isset( $this->settings['allow_status_import'] ) and $this->settings['allow_status_import'] )
{
$return[] = 'status';
}
return $return;
}
/**
* @brief Cached user data
*/
protected $_cachedUserData = array();
protected array $_cachedUserData = array();
/**
* Get user data
*
* @param string $accessToken Access Token
* @param string $accessTokenSecret Access Token Secret
* @param string $accessToken Access Token
* @param string $accessTokenSecret Access Token Secret
* @return array
* @throws \IPS\Login\Exception The token is invalid and the user needs to reauthenticate
* @throws \RuntimeException Unexpected error from service
* @throws LoginException The token is invalid and the user needs to reauthenticate
* @throws RuntimeException Unexpected error from service
*/
protected function _userData( $accessToken, $accessTokenSecret )
protected function _userData( string $accessToken, string $accessTokenSecret ): array
{
if ( !isset( $this->_cachedUserData[ $accessToken ] ) )
{
$response = $this->_sendRequest( 'get', \IPS\Http\Url::external('https://api.twitter.com/1.1/account/verify_credentials.json'), array( 'include_email' => 'true' ), $accessToken, $accessTokenSecret )->decodeJson();
$response = $this->_sendRequest( 'get', Url::external('https://api.twitter.com/1.1/account/verify_credentials.json'), array( 'include_email' => 'true' ), $accessToken, $accessTokenSecret )->decodeJson();
if ( isset( $response['errors'] ) )
{
throw new \IPS\Login\Exception( $response['errors'][0]['message'], \IPS\Login\Exception::INTERNAL_ERROR );
throw new LoginException( $response['errors'][0]['message'], LoginException::INTERNAL_ERROR );
}
$this->_cachedUserData[ $accessToken ] = $response;
@@ -402,21 +375,21 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
/**
* @brief The length of the shortened URLs returned by Twitter's text parser https://developer.twitter.com/en/docs/counting-characters#:~:text=The%20current%20length%20of%20a,count%20towards%20the%20character%20limit.
*/
protected static $defaultShortenedUrlLength = 23;
protected static int $defaultShortenedUrlLength = 23;
/**
* Post something to Twitter
*
* @param \IPS\Member $member Member posting
* @param Member $member Member posting
* @param string $content Content to post
* @param \IPS\Http\Url|NULL $url Optional link
* @return void
* @param Url|NULL $url Optional link
* @return bool
*/
public function postToTwitter( \IPS\Member $member, $content, \IPS\Http\Url $url = NULL )
public function postToTwitter( Member $member, string $content, ?Url $url = NULL ) : bool
{
if ( !( $link = $this->_link( $member ) ) )
{
return FALSE;
return false;
}
$data = array( 'status' => $content );
@@ -425,32 +398,32 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
if ( $url !== NULL )
{
/* Try to refresh if the stored response is more than a day old */
if ( !isset( \IPS\Data\Store::i()->twitter_config ) or \IPS\Data\Store::i()->twitter_config['time'] > time() - 86400 )
if ( !isset( Store::i()->twitter_config ) or Store::i()->twitter_config['time'] > time() - 86400 )
{
try
{
$response = $this->_sendRequest( 'get', \IPS\Http\Url::external('https://api.twitter.com/1.1/help/configuration.json'), array(), $link['token_access_token'], $link['token_secret'] );
if ( ( $response->httpResponseCode === 200 ) AND ( $payload = $response->decodeJson() ) AND \is_array( $payload ) )
$response = $this->_sendRequest( 'get', Url::external('https://api.twitter.com/1.1/help/configuration.json'), array(), $link['token_access_token'], $link['token_secret'] );
if ( ( $response->httpResponseCode === 200 ) AND ( $payload = $response->decodeJson() ) )
{
\IPS\Data\Store::i()->twitter_config = array_merge( $payload, array( 'time' => time() ) );
Store::i()->twitter_config = array_merge( $payload, array( 'time' => time() ) );
}
else
{
throw new \UnexpectedValueException();
throw new UnexpectedValueException();
}
}
catch ( \Exception|\UnexpectedValueException $e )
catch ( \Exception| UnexpectedValueException $e )
{
/* We should be fine hard coding to 23 if the deprecated configuration endpoint is no longer online https://developer.twitter.com/en/docs/counting-characters#:~:text=The%20current%20length%20of%20a,count%20towards%20the%20character%20limit. */
\IPS\Data\Store::i()->twitter_config['short_url_length'] = static::$defaultShortenedUrlLength;
Store::i()->twitter_config['short_url_length'] = static::$defaultShortenedUrlLength;
}
}
$maxUrlLen = \IPS\Data\Store::i()->twitter_config['short_url_length'] ?? static::$defaultShortenedUrlLength;
$maxUrlLen = Store::i()->twitter_config['short_url_length'] ?? static::$defaultShortenedUrlLength;
$data['status'] = mb_substr( $data['status'], 0, ( 140 - ( $maxUrlLen + 1 ) ) ) . ' ' . $url;
}
$response = $this->_sendRequest( 'post', \IPS\Http\Url::external('https://api.twitter.com/1.1/statuses/update.json'), $data, $link['token_access_token'], $link['token_secret'] )->decodeJson();
$response = $this->_sendRequest( 'post', Url::external('https://api.twitter.com/1.1/statuses/update.json'), $data, $link['token_access_token'], $link['token_secret'] )->decodeJson();
return isset( $response['id_str'] );
}
@@ -460,10 +433,10 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
/**
* Request a token
*
* @param \IPS\Http\Url $callback Callback URK
* @return string
* @param Url $callback Callback URL
* @return array
*/
public function requestToken( $callback )
public function requestToken( Url $callback ): array
{
return $this->_sendRequest( 'get', $this->tokenRequestEndpoint(), array( 'oauth_callback' => (string) $callback ) )->decodeQueryString('oauth_token');
}
@@ -471,11 +444,11 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
/**
* Get authenticated user's identifier (may not be a number)
*
* @param string $verifier Verifier
* @param string $accessTokenSecret Access Token
* @param string $verifier Verifier
* @param string $accessToken Access Token
* @return array
*/
public function exchangeToken( $verifier, $accessToken )
public function exchangeToken(string $verifier, string $accessToken ): array
{
return $this->_sendRequest( 'post', $this->accessTokenEndpoint(), array( 'oauth_verifier' => $verifier ), $accessToken )->decodeQueryString('user_id');
}
@@ -483,15 +456,15 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
/**
* Can we publish to this twitter account?
*
* @param string $accessToken Access Token
* @param string $accessTokenSecret Access Token Secret
* @param string $accessToken Access Token
* @param string $accessTokenSecret Access Token Secret
* @return boolean
*/
public function hasWritePermissions( $accessToken, $accessTokenSecret )
public function hasWritePermissions( string $accessToken, string $accessTokenSecret ): bool
{
try
{
$response = $this->_sendRequest( 'get', \IPS\Http\Url::external('https://api.twitter.com/1.1/account/verify_credentials.json'), array(), $accessToken, $accessTokenSecret );
$response = $this->_sendRequest( 'get', Url::external('https://api.twitter.com/1.1/account/verify_credentials.json'), array(), $accessToken, $accessTokenSecret );
if ( $response->httpResponseCode == 401 )
{
@@ -507,33 +480,20 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
return TRUE;
}
catch ( \IPS\Http\Request\Exception $e ) { }
catch ( Exception $e ) { }
return FALSE;
}
/**
* Send a status
*
* @param array $data Post data to send
* @param string $accessToken Access Token
* @param string $accessTokenSecret Access Token Secret
* @return boolean
*/
public function sendStatus( $data, $accessToken, $accessTokenSecret )
{
return $this->_sendRequest( 'post', \IPS\Http\Url::external("https://api.twitter.com/1.1/statuses/update.json"), $data, $accessToken, $accessTokenSecret )->decodeJson();
}
/**
* Send media
*
* @param array $contents Photo contents
* @param string $accessToken Access Token
* @param string $accessTokenSecret Access Token Secret
* @return boolean
* @param array $contents Photo contents
* @param string $accessToken Access Token
* @param string $accessTokenSecret Access Token Secret
* @return array
*/
public function sendMedia( $contents, $accessToken, $accessTokenSecret )
public function sendMedia( array $contents, string $accessToken, string $accessTokenSecret ): array
{
$mimeBoundary = sha1( microtime() );
@@ -543,48 +503,6 @@ class _Twitter extends \IPS\Login\Handler\OAuth1
$data .= $contents . "\r\n";
$data .= '--' . $mimeBoundary . '--' . "\r\n" . "\r\n";
return $this->_sendRequest( 'post', \IPS\Http\Url::external('https://upload.twitter.com/1.1/media/upload.json'), array(), $accessToken, $accessTokenSecret, array(), array( $mimeBoundary, $data ) )->decodeJson();
}
/**
* [Node] Set whether this node is enabled
*
* @param bool|int $enabled Whether to set it enabled or disabled
* @return void
*/
protected function set__enabled( $enabled )
{
parent::set__enabled( $enabled );
$this->_checkSocialPromotes();
}
/**
* [ActiveRecord] Delete Record
*
* @return void
*/
public function delete()
{
parent::delete();
$this->_checkSocialPromotes();
}
/**
* Disable social promotes Twitter method if all Twitter login handlers are disabled
*
* @return void
*/
protected function _checkSocialPromotes()
{
try
{
\IPS\Db::i()->select( '*', 'core_login_methods', array( 'login_classname=? AND login_id!=?', 'IPS\Login\Handler\OAuth1\Twitter', $this->_id ) )->first();
}
catch( \UnderflowException $e )
{
$promoter = \IPS\core\Promote::getPromoter('Twitter');
$promoter->enabled = FALSE;
$promoter->save();
}
return $this->_sendRequest( 'post', Url::external('https://upload.twitter.com/1.1/media/upload.json'), array(), $accessToken, $accessTokenSecret, array(), array( $mimeBoundary, $data ) )->decodeJson();
}
}