161 lines
3.7 KiB
PHP
161 lines
3.7 KiB
PHP
|
<?php
|
||
|
/**
|
||
|
* Copyright 2017 Facebook, Inc.
|
||
|
*
|
||
|
* You are hereby granted a non-exclusive, worldwide, royalty-free license to
|
||
|
* use, copy, modify, and distribute this software in source code or binary
|
||
|
* form for use in connection with the web services and APIs provided by
|
||
|
* Facebook.
|
||
|
*
|
||
|
* As with any software that integrates with the Facebook platform, your use
|
||
|
* of this software is subject to the Facebook Developer Principles and
|
||
|
* Policies [http://developers.facebook.com/policy/]. This copyright notice
|
||
|
* shall be included in all copies or substantial portions of the software.
|
||
|
*
|
||
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
||
|
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||
|
* DEALINGS IN THE SOFTWARE.
|
||
|
*
|
||
|
*/
|
||
|
namespace Facebook\Authentication;
|
||
|
|
||
|
/**
|
||
|
* Class AccessToken
|
||
|
*
|
||
|
* @package Facebook
|
||
|
*/
|
||
|
class AccessToken
|
||
|
{
|
||
|
/**
|
||
|
* The access token value.
|
||
|
*
|
||
|
* @var string
|
||
|
*/
|
||
|
protected $value = '';
|
||
|
|
||
|
/**
|
||
|
* Date when token expires.
|
||
|
*
|
||
|
* @var \DateTime|null
|
||
|
*/
|
||
|
protected $expiresAt;
|
||
|
|
||
|
/**
|
||
|
* Create a new access token entity.
|
||
|
*
|
||
|
* @param string $accessToken
|
||
|
* @param int $expiresAt
|
||
|
*/
|
||
|
public function __construct($accessToken, $expiresAt = 0)
|
||
|
{
|
||
|
$this->value = $accessToken;
|
||
|
if ($expiresAt) {
|
||
|
$this->setExpiresAtFromTimeStamp($expiresAt);
|
||
|
}
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Generate an app secret proof to sign a request to Graph.
|
||
|
*
|
||
|
* @param string $appSecret The app secret.
|
||
|
*
|
||
|
* @return string
|
||
|
*/
|
||
|
public function getAppSecretProof($appSecret)
|
||
|
{
|
||
|
return hash_hmac('sha256', $this->value, $appSecret);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Getter for expiresAt.
|
||
|
*
|
||
|
* @return \DateTime|null
|
||
|
*/
|
||
|
public function getExpiresAt()
|
||
|
{
|
||
|
return $this->expiresAt;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Determines whether or not this is an app access token.
|
||
|
*
|
||
|
* @return bool
|
||
|
*/
|
||
|
public function isAppAccessToken()
|
||
|
{
|
||
|
return strpos($this->value, '|') !== false;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Determines whether or not this is a long-lived token.
|
||
|
*
|
||
|
* @return bool
|
||
|
*/
|
||
|
public function isLongLived()
|
||
|
{
|
||
|
if ($this->expiresAt) {
|
||
|
return $this->expiresAt->getTimestamp() > time() + (60 * 60 * 2);
|
||
|
}
|
||
|
|
||
|
if ($this->isAppAccessToken()) {
|
||
|
return true;
|
||
|
}
|
||
|
|
||
|
return false;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Checks the expiration of the access token.
|
||
|
*
|
||
|
* @return boolean|null
|
||
|
*/
|
||
|
public function isExpired()
|
||
|
{
|
||
|
if ($this->getExpiresAt() instanceof \DateTime) {
|
||
|
return $this->getExpiresAt()->getTimestamp() < time();
|
||
|
}
|
||
|
|
||
|
if ($this->isAppAccessToken()) {
|
||
|
return false;
|
||
|
}
|
||
|
|
||
|
return null;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns the access token as a string.
|
||
|
*
|
||
|
* @return string
|
||
|
*/
|
||
|
public function getValue()
|
||
|
{
|
||
|
return $this->value;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns the access token as a string.
|
||
|
*
|
||
|
* @return string
|
||
|
*/
|
||
|
public function __toString()
|
||
|
{
|
||
|
return $this->getValue();
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Setter for expires_at.
|
||
|
*
|
||
|
* @param int $timeStamp
|
||
|
*/
|
||
|
protected function setExpiresAtFromTimeStamp($timeStamp)
|
||
|
{
|
||
|
$dt = new \DateTime();
|
||
|
$dt->setTimestamp($timeStamp);
|
||
|
$this->expiresAt = $dt;
|
||
|
}
|
||
|
}
|