191 lines
4.3 KiB
PHP
191 lines
4.3 KiB
PHP
<?php
|
|
|
|
namespace Appwrite\Auth\OAuth2;
|
|
|
|
use Appwrite\Auth\OAuth2;
|
|
|
|
// Reference Material
|
|
// https://developer.box.com/reference/
|
|
|
|
class Box extends OAuth2
|
|
{
|
|
/**
|
|
* @var string
|
|
*/
|
|
private string $endpoint = 'https://account.box.com/api/oauth2/';
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
private string $resourceEndpoint = 'https://api.box.com/2.0/';
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected array $user = [];
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected array $tokens = [];
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected array $scopes = [
|
|
'manage_app_users',
|
|
];
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getName(): string
|
|
{
|
|
return 'box';
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getLoginURL(): string
|
|
{
|
|
$url = $this->endpoint . 'authorize?' .
|
|
\http_build_query([
|
|
'response_type' => 'code',
|
|
'client_id' => $this->appID,
|
|
'scope' => \implode(',', $this->getScopes()),
|
|
'redirect_uri' => $this->callback,
|
|
'state' => \json_encode($this->state),
|
|
]);
|
|
|
|
return $url;
|
|
}
|
|
|
|
/**
|
|
* @param string $code
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function getTokens(string $code): array
|
|
{
|
|
if (empty($this->tokens)) {
|
|
$headers = ['Content-Type: application/x-www-form-urlencoded'];
|
|
$this->tokens = \json_decode($this->request(
|
|
'POST',
|
|
$this->endpoint . 'token',
|
|
$headers,
|
|
\http_build_query([
|
|
"client_id" => $this->appID,
|
|
"client_secret" => $this->appSecret,
|
|
"code" => $code,
|
|
"grant_type" => "authorization_code",
|
|
"scope" => \implode(',', $this->getScopes()),
|
|
"redirect_uri" => $this->callback
|
|
])
|
|
), true);
|
|
}
|
|
|
|
return $this->tokens;
|
|
}
|
|
|
|
/**
|
|
* @param string $refreshToken
|
|
*
|
|
* @return array
|
|
*/
|
|
public function refreshTokens(string $refreshToken): array
|
|
{
|
|
$headers = ['Content-Type: application/x-www-form-urlencoded'];
|
|
$this->tokens = \json_decode($this->request(
|
|
'POST',
|
|
$this->endpoint . 'token',
|
|
$headers,
|
|
\http_build_query([
|
|
"client_id" => $this->appID,
|
|
"client_secret" => $this->appSecret,
|
|
"refresh_token" => $refreshToken,
|
|
"grant_type" => "refresh_token",
|
|
])
|
|
), true);
|
|
|
|
if (empty($this->tokens['refresh_token'])) {
|
|
$this->tokens['refresh_token'] = $refreshToken;
|
|
}
|
|
|
|
return $this->tokens;
|
|
}
|
|
|
|
/**
|
|
* @param string $accessToken
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getUserID(string $accessToken): string
|
|
{
|
|
$user = $this->getUser($accessToken);
|
|
|
|
return $user['id'] ?? '';
|
|
}
|
|
|
|
/**
|
|
* @param string $accessToken
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getUserEmail(string $accessToken): string
|
|
{
|
|
$user = $this->getUser($accessToken);
|
|
|
|
return $user['login'] ?? '';
|
|
}
|
|
|
|
/**
|
|
* Check if the OAuth email is verified
|
|
*
|
|
* If present, the email is verified. This was verfied through a manual Box sign up process
|
|
*
|
|
* @param string $accessToken
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isEmailVerified(string $accessToken): bool
|
|
{
|
|
$email = $this->getUserEmail($accessToken);
|
|
|
|
return !empty($email);
|
|
}
|
|
|
|
/**
|
|
* @param string $accessToken
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getUserName(string $accessToken): string
|
|
{
|
|
$user = $this->getUser($accessToken);
|
|
|
|
return $user['name'] ?? '';
|
|
}
|
|
|
|
/**
|
|
* @param string $accessToken
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function getUser(string $accessToken): array
|
|
{
|
|
$header = [
|
|
'Authorization: Bearer ' . \urlencode($accessToken),
|
|
];
|
|
if (empty($this->user)) {
|
|
$user = $this->request(
|
|
'GET',
|
|
$this->resourceEndpoint . 'me',
|
|
$header
|
|
);
|
|
$this->user = \json_decode($user, true);
|
|
}
|
|
|
|
return $this->user;
|
|
}
|
|
}
|