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/OAuth2/LinkedIn.php
+79 -69
View File
@@ -11,28 +11,40 @@
namespace IPS\Login\Handler\OAuth2;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
use DomainException;
use IPS\Helpers\Form\Radio;
use IPS\Http\Url;
use IPS\Login;
use IPS\Login\Exception;
use IPS\Login\Handler\OAuth2;
use IPS\Member;
use IPS\Theme;
use RuntimeException;
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;
}
/**
* LinkedIn Login Handler
*/
class _LinkedIn extends \IPS\Login\Handler\OAuth2
class LinkedIn extends OAuth2
{
/**
* @brief Does this handler support PKCE?
*/
public $pkceSupported = FALSE;
public bool $pkceSupported = FALSE;
/**
* Get title
*
* @return string
*/
public static function getTitle()
public static function getTitle(): string
{
return 'login_handler_Linkedin';
}
@@ -40,7 +52,7 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
/**
* @brief Enable AdminCP logins by default
*/
protected static $enableAcpLoginByDefault = FALSE;
protected static bool $enableAcpLoginByDefault = FALSE;
/**
* ACP Settings Form
@@ -50,13 +62,13 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
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_cannot_reauth');
\IPS\Member::loggedIn()->language()->words['oauth_client_id'] = \IPS\Member::loggedIn()->language()->addToStack('login_linkedin_key');
Member::loggedIn()->language()->words['login_acp_desc'] = Member::loggedIn()->language()->addToStack('login_acp_cannot_reauth');
Member::loggedIn()->language()->words['oauth_client_id'] = Member::loggedIn()->language()->addToStack('login_linkedin_key');
return array_merge( array(
'real_name' => new \IPS\Helpers\Form\Radio( 'login_real_name', isset( $this->settings['real_name'] ) ? $this->settings['real_name'] : 1, FALSE, array(
'real_name' => new Radio( 'login_real_name', $this->settings['real_name'] ?? 1, FALSE, array(
'options' => array(
1 => 'login_real_name_linkedin',
0 => 'login_real_name_disabled',
@@ -73,7 +85,7 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
*
* @return string
*/
public function buttonColor()
public function buttonColor(): string
{
return '#007eb3';
}
@@ -83,7 +95,7 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
*
* @return string
*/
public function buttonIcon()
public function buttonIcon(): string
{
return 'linkedin';
}
@@ -93,7 +105,7 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
*
* @return string
*/
public function buttonText()
public function buttonText(): string
{
return 'login_linkedin';
}
@@ -103,20 +115,20 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
*
* @return string
*/
public function buttonClass()
public function buttonClass(): string
{
return 'ipsSocial_linkedin';
return 'ipsSocial--linkedIn';
}
/**
* 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/Linkedin.png', 'core', 'interface' );
return Theme::i()->resource( 'logos/login/Linkedin.png', 'core', 'interface' );
}
/**
@@ -124,7 +136,7 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
*
* @return string
*/
protected function _authenticationType()
protected function _authenticationType(): string
{
return static::AUTHENTICATE_POST;
}
@@ -134,7 +146,7 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
*
* @return string
*/
protected function grantType()
protected function grantType(): string
{
return 'authorization_code';
}
@@ -145,7 +157,7 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
* @param array|NULL $additional Any additional scopes to request
* @return array
*/
protected function scopesToRequest( $additional=NULL )
protected function scopesToRequest( array $additional=NULL ): array
{
return array(
'r_liteprofile',
@@ -156,34 +168,34 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
/**
* 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://www.linkedin.com/oauth/v2/authorization');
return Url::external('https://www.linkedin.com/oauth/v2/authorization');
}
/**
* Token Endpoint
*
* @return \IPS\Http\Url
* @return Url
*/
protected function tokenEndpoint()
protected function tokenEndpoint(): Url
{
return \IPS\Http\Url::external('https://www.linkedin.com/oauth/v2/accessToken');
return Url::external('https://www.linkedin.com/oauth/v2/accessToken');
}
/**
* Redirection Endpoint
*
* @return \IPS\Http\Url
* @return Url
*/
protected function redirectionEndpoint()
protected function redirectionEndpoint(): Url
{
if ( isset( $this->settings['legacy_redirect'] ) and $this->settings['legacy_redirect'] )
{
return \IPS\Http\Url::internal( 'applications/core/interface/linkedin/auth.php', 'none' );
return Url::internal( 'applications/core/interface/linkedin/auth.php', 'none' );
}
return parent::redirectionEndpoint();
}
@@ -192,9 +204,9 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
* Get authenticated user's identifier (may not be a number)
*
* @param string $accessToken Access Token
* @return string
* @return string|null
*/
protected function authenticatedUserId( $accessToken )
protected function authenticatedUserId( string $accessToken ): ?string
{
return $this->_userData( $accessToken )['id'];
}
@@ -206,7 +218,7 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
* @param string $accessToken Access Token
* @return string|NULL
*/
protected function authenticatedUserName( $accessToken )
protected function authenticatedUserName( string $accessToken ): ?string
{
if ( isset( $this->settings['real_name'] ) and $this->settings['real_name'] )
{
@@ -218,7 +230,7 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
/**
* @brief Cached email address to make sure we don't request more than once
*/
protected $_cachedEmail = NULL;
protected ?string $_cachedEmail = NULL;
/**
* Get authenticated user's email address
@@ -227,11 +239,11 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
* @param string $accessToken Access Token
* @return string|NULL
*/
protected function authenticatedEmail( $accessToken )
protected function authenticatedEmail( string $accessToken ): ?string
{
if ( $this->_cachedEmail === NULL )
{
$response = \IPS\Http\Url::external( "https://api.linkedin.com/v2/emailAddress?q=members&projection=(elements*(handle~))" )
$response = Url::external( "https://api.linkedin.com/v2/emailAddress?q=members&projection=(elements*(handle~))" )
->request()
->setHeaders( array( 'Authorization' => "Bearer {$accessToken}" ) )
->get()
@@ -239,7 +251,7 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
if ( isset( $response['errorCode'] ) )
{
throw new \IPS\Login\Exception( $response['message'], \IPS\Login\Exception::INTERNAL_ERROR );
throw new Exception( $response['message'], Exception::INTERNAL_ERROR );
}
$this->_cachedEmail = $response['elements'][0]['handle~']['emailAddress'];
@@ -251,17 +263,17 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
* 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 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 userProfilePhoto( \IPS\Member $member )
public function userProfilePhoto( Member $member ): ?Url
{
if ( !( $link = $this->_link( $member ) ) or ( $link['token_expires'] and $link['token_expires'] < time() ) )
{
throw new \IPS\Login\Exception( NULL, \IPS\Login\Exception::INTERNAL_ERROR );
throw new Exception( "", Exception::INTERNAL_ERROR );
}
if( !isset( $this->_userData( $link['token_access_token'] )['profilePicture'] ) )
@@ -279,7 +291,7 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
{
if( isset( $identifier['identifier'] ) AND $identifier['identifier'] )
{
return \IPS\Http\Url::external( $identifier['identifier'] );
return Url::external( $identifier['identifier'] );
}
}
}
@@ -291,31 +303,29 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
* 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 ) ) or ( $link['token_expires'] and $link['token_expires'] < time() ) )
{
throw new \IPS\Login\Exception( NULL, \IPS\Login\Exception::INTERNAL_ERROR );
throw new Exception( "", Exception::INTERNAL_ERROR );
}
return $this->_getProfileName( $link['token_access_token'] );
$preferredLocale = $this->_userData( $link['token_access_token'] )['firstName']['preferredLocale']['language'] . '_' . $this->_userData( $link['token_access_token'] )['firstName']['preferredLocale']['country'];
}
/**
* Get the user's profile name
*
* @param string $accessToken Access token
* @param string $accessToken Access token
* @return string
*/
protected function _getProfileName( $accessToken )
protected function _getProfileName( string $accessToken ): string
{
$preferredLocale = $this->_userData( $accessToken )['firstName']['preferredLocale']['language'] . '_' . $this->_userData( $accessToken )['firstName']['preferredLocale']['country'];
@@ -328,13 +338,13 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
*
* @param string $identifier The ID Number/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 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
* @note You have to apply to LinkedIn's Partnership program manually to get the profile data necessary to generate the public profile URL (specifically, the vanityName field). As such, we can't generate the URL to your profile beginning with the v2 API.
*/
public function userLink( $identifier, $username )
public function userLink( string $identifier, string $username ): ?Url
{
return NULL;
}
@@ -342,11 +352,11 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
/**
* 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();
@@ -369,20 +379,20 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
/**
* @brief Cached user data
*/
protected $_cachedUserData = array();
protected array $_cachedUserData = array();
/**
* Get user data
*
* @param string $accessToken Access Token
* @throws \IPS\Login\Exception The token is invalid and the user needs to reauthenticate
* @throws \RuntimeException Unexpected error from service
* @throws Exception The token is invalid and the user needs to reauthenticate
* @throws RuntimeException Unexpected error from service
*/
protected function _userData( $accessToken )
protected function _userData( string $accessToken ): array
{
if ( !isset( $this->_cachedUserData[ $accessToken ] ) )
{
$response = \IPS\Http\Url::external( "https://api.linkedin.com/v2/me" )
$response = Url::external( "https://api.linkedin.com/v2/me" )
->setQueryString( 'projection', '(id,firstName,lastName,vanityName,profilePicture(displayImage~:playableStreams))' )
->request()
->setHeaders( array( 'Authorization' => "Bearer {$accessToken}" ) )
@@ -391,7 +401,7 @@ class _LinkedIn extends \IPS\Login\Handler\OAuth2
if ( isset( $response['errorCode'] ) )
{
throw new \IPS\Login\Exception( $response['message'], \IPS\Login\Exception::INTERNAL_ERROR );
throw new Exception( $response['message'], Exception::INTERNAL_ERROR );
}
$this->_cachedUserData[ $accessToken ] = $response;