636 lines
19 KiB
PHP
636 lines
19 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;
|
|
|
|
use Facebook\Authentication\AccessToken;
|
|
use Facebook\Authentication\OAuth2Client;
|
|
use Facebook\FileUpload\FacebookFile;
|
|
use Facebook\FileUpload\FacebookResumableUploader;
|
|
use Facebook\FileUpload\FacebookTransferChunk;
|
|
use Facebook\FileUpload\FacebookVideo;
|
|
use Facebook\GraphNodes\GraphEdge;
|
|
use Facebook\Url\UrlDetectionInterface;
|
|
use Facebook\Url\FacebookUrlDetectionHandler;
|
|
use Facebook\PseudoRandomString\PseudoRandomStringGeneratorFactory;
|
|
use Facebook\PseudoRandomString\PseudoRandomStringGeneratorInterface;
|
|
use Facebook\HttpClients\HttpClientsFactory;
|
|
use Facebook\PersistentData\PersistentDataFactory;
|
|
use Facebook\PersistentData\PersistentDataInterface;
|
|
use Facebook\Helpers\FacebookCanvasHelper;
|
|
use Facebook\Helpers\FacebookJavaScriptHelper;
|
|
use Facebook\Helpers\FacebookPageTabHelper;
|
|
use Facebook\Helpers\FacebookRedirectLoginHelper;
|
|
use Facebook\Exceptions\FacebookSDKException;
|
|
|
|
/**
|
|
* Class Facebook
|
|
*
|
|
* @package Facebook
|
|
*/
|
|
class Facebook
|
|
{
|
|
/**
|
|
* @const string Version number of the Facebook PHP SDK.
|
|
*/
|
|
const VERSION = '5.5.0';
|
|
|
|
/**
|
|
* @const string Default Graph API version for requests.
|
|
*/
|
|
const DEFAULT_GRAPH_VERSION = 'v2.9';
|
|
|
|
/**
|
|
* @const string The name of the environment variable that contains the app ID.
|
|
*/
|
|
const APP_ID_ENV_NAME = 'FACEBOOK_APP_ID';
|
|
|
|
/**
|
|
* @const string The name of the environment variable that contains the app secret.
|
|
*/
|
|
const APP_SECRET_ENV_NAME = 'FACEBOOK_APP_SECRET';
|
|
|
|
/**
|
|
* @var FacebookApp The FacebookApp entity.
|
|
*/
|
|
protected $app;
|
|
|
|
/**
|
|
* @var FacebookClient The Facebook client service.
|
|
*/
|
|
protected $client;
|
|
|
|
/**
|
|
* @var OAuth2Client The OAuth 2.0 client service.
|
|
*/
|
|
protected $oAuth2Client;
|
|
|
|
/**
|
|
* @var UrlDetectionInterface|null The URL detection handler.
|
|
*/
|
|
protected $urlDetectionHandler;
|
|
|
|
/**
|
|
* @var PseudoRandomStringGeneratorInterface|null The cryptographically secure pseudo-random string generator.
|
|
*/
|
|
protected $pseudoRandomStringGenerator;
|
|
|
|
/**
|
|
* @var AccessToken|null The default access token to use with requests.
|
|
*/
|
|
protected $defaultAccessToken;
|
|
|
|
/**
|
|
* @var string|null The default Graph version we want to use.
|
|
*/
|
|
protected $defaultGraphVersion;
|
|
|
|
/**
|
|
* @var PersistentDataInterface|null The persistent data handler.
|
|
*/
|
|
protected $persistentDataHandler;
|
|
|
|
/**
|
|
* @var FacebookResponse|FacebookBatchResponse|null Stores the last request made to Graph.
|
|
*/
|
|
protected $lastResponse;
|
|
|
|
/**
|
|
* Instantiates a new Facebook super-class object.
|
|
*
|
|
* @param array $config
|
|
*
|
|
* @throws FacebookSDKException
|
|
*/
|
|
public function __construct(array $config = [])
|
|
{
|
|
$config = array_merge([
|
|
'app_id' => getenv(static::APP_ID_ENV_NAME),
|
|
'app_secret' => getenv(static::APP_SECRET_ENV_NAME),
|
|
'default_graph_version' => static::DEFAULT_GRAPH_VERSION,
|
|
'enable_beta_mode' => false,
|
|
'http_client_handler' => null,
|
|
'persistent_data_handler' => null,
|
|
'pseudo_random_string_generator' => null,
|
|
'url_detection_handler' => null,
|
|
], $config);
|
|
|
|
if (!$config['app_id']) {
|
|
throw new FacebookSDKException('Required "app_id" key not supplied in config and could not find fallback environment variable "' . static::APP_ID_ENV_NAME . '"');
|
|
}
|
|
if (!$config['app_secret']) {
|
|
throw new FacebookSDKException('Required "app_secret" key not supplied in config and could not find fallback environment variable "' . static::APP_SECRET_ENV_NAME . '"');
|
|
}
|
|
|
|
$this->app = new FacebookApp($config['app_id'], $config['app_secret']);
|
|
$this->client = new FacebookClient(
|
|
HttpClientsFactory::createHttpClient($config['http_client_handler']),
|
|
$config['enable_beta_mode']
|
|
);
|
|
$this->pseudoRandomStringGenerator = PseudoRandomStringGeneratorFactory::createPseudoRandomStringGenerator(
|
|
$config['pseudo_random_string_generator']
|
|
);
|
|
$this->setUrlDetectionHandler($config['url_detection_handler'] ?: new FacebookUrlDetectionHandler());
|
|
$this->persistentDataHandler = PersistentDataFactory::createPersistentDataHandler(
|
|
$config['persistent_data_handler']
|
|
);
|
|
|
|
if (isset($config['default_access_token'])) {
|
|
$this->setDefaultAccessToken($config['default_access_token']);
|
|
}
|
|
|
|
// @todo v6: Throw an InvalidArgumentException if "default_graph_version" is not set
|
|
$this->defaultGraphVersion = $config['default_graph_version'];
|
|
}
|
|
|
|
/**
|
|
* Returns the FacebookApp entity.
|
|
*
|
|
* @return FacebookApp
|
|
*/
|
|
public function getApp()
|
|
{
|
|
return $this->app;
|
|
}
|
|
|
|
/**
|
|
* Returns the FacebookClient service.
|
|
*
|
|
* @return FacebookClient
|
|
*/
|
|
public function getClient()
|
|
{
|
|
return $this->client;
|
|
}
|
|
|
|
/**
|
|
* Returns the OAuth 2.0 client service.
|
|
*
|
|
* @return OAuth2Client
|
|
*/
|
|
public function getOAuth2Client()
|
|
{
|
|
if (!$this->oAuth2Client instanceof OAuth2Client) {
|
|
$app = $this->getApp();
|
|
$client = $this->getClient();
|
|
$this->oAuth2Client = new OAuth2Client($app, $client, $this->defaultGraphVersion);
|
|
}
|
|
|
|
return $this->oAuth2Client;
|
|
}
|
|
|
|
/**
|
|
* Returns the last response returned from Graph.
|
|
*
|
|
* @return FacebookResponse|FacebookBatchResponse|null
|
|
*/
|
|
public function getLastResponse()
|
|
{
|
|
return $this->lastResponse;
|
|
}
|
|
|
|
/**
|
|
* Returns the URL detection handler.
|
|
*
|
|
* @return UrlDetectionInterface
|
|
*/
|
|
public function getUrlDetectionHandler()
|
|
{
|
|
return $this->urlDetectionHandler;
|
|
}
|
|
|
|
/**
|
|
* Changes the URL detection handler.
|
|
*
|
|
* @param UrlDetectionInterface $urlDetectionHandler
|
|
*/
|
|
private function setUrlDetectionHandler(UrlDetectionInterface $urlDetectionHandler)
|
|
{
|
|
$this->urlDetectionHandler = $urlDetectionHandler;
|
|
}
|
|
|
|
/**
|
|
* Returns the default AccessToken entity.
|
|
*
|
|
* @return AccessToken|null
|
|
*/
|
|
public function getDefaultAccessToken()
|
|
{
|
|
return $this->defaultAccessToken;
|
|
}
|
|
|
|
/**
|
|
* Sets the default access token to use with requests.
|
|
*
|
|
* @param AccessToken|string $accessToken The access token to save.
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
*/
|
|
public function setDefaultAccessToken($accessToken)
|
|
{
|
|
if (is_string($accessToken)) {
|
|
$this->defaultAccessToken = new AccessToken($accessToken);
|
|
|
|
return;
|
|
}
|
|
|
|
if ($accessToken instanceof AccessToken) {
|
|
$this->defaultAccessToken = $accessToken;
|
|
|
|
return;
|
|
}
|
|
|
|
throw new \InvalidArgumentException('The default access token must be of type "string" or Facebook\AccessToken');
|
|
}
|
|
|
|
/**
|
|
* Returns the default Graph version.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getDefaultGraphVersion()
|
|
{
|
|
return $this->defaultGraphVersion;
|
|
}
|
|
|
|
/**
|
|
* Returns the redirect login helper.
|
|
*
|
|
* @return FacebookRedirectLoginHelper
|
|
*/
|
|
public function getRedirectLoginHelper()
|
|
{
|
|
return new FacebookRedirectLoginHelper(
|
|
$this->getOAuth2Client(),
|
|
$this->persistentDataHandler,
|
|
$this->urlDetectionHandler,
|
|
$this->pseudoRandomStringGenerator
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns the JavaScript helper.
|
|
*
|
|
* @return FacebookJavaScriptHelper
|
|
*/
|
|
public function getJavaScriptHelper()
|
|
{
|
|
return new FacebookJavaScriptHelper($this->app, $this->client, $this->defaultGraphVersion);
|
|
}
|
|
|
|
/**
|
|
* Returns the canvas helper.
|
|
*
|
|
* @return FacebookCanvasHelper
|
|
*/
|
|
public function getCanvasHelper()
|
|
{
|
|
return new FacebookCanvasHelper($this->app, $this->client, $this->defaultGraphVersion);
|
|
}
|
|
|
|
/**
|
|
* Returns the page tab helper.
|
|
*
|
|
* @return FacebookPageTabHelper
|
|
*/
|
|
public function getPageTabHelper()
|
|
{
|
|
return new FacebookPageTabHelper($this->app, $this->client, $this->defaultGraphVersion);
|
|
}
|
|
|
|
/**
|
|
* Sends a GET request to Graph and returns the result.
|
|
*
|
|
* @param string $endpoint
|
|
* @param AccessToken|string|null $accessToken
|
|
* @param string|null $eTag
|
|
* @param string|null $graphVersion
|
|
*
|
|
* @return FacebookResponse
|
|
*
|
|
* @throws FacebookSDKException
|
|
*/
|
|
public function get($endpoint, $accessToken = null, $eTag = null, $graphVersion = null)
|
|
{
|
|
return $this->sendRequest(
|
|
'GET',
|
|
$endpoint,
|
|
$params = [],
|
|
$accessToken,
|
|
$eTag,
|
|
$graphVersion
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Sends a POST request to Graph and returns the result.
|
|
*
|
|
* @param string $endpoint
|
|
* @param array $params
|
|
* @param AccessToken|string|null $accessToken
|
|
* @param string|null $eTag
|
|
* @param string|null $graphVersion
|
|
*
|
|
* @return FacebookResponse
|
|
*
|
|
* @throws FacebookSDKException
|
|
*/
|
|
public function post($endpoint, array $params = [], $accessToken = null, $eTag = null, $graphVersion = null)
|
|
{
|
|
return $this->sendRequest(
|
|
'POST',
|
|
$endpoint,
|
|
$params,
|
|
$accessToken,
|
|
$eTag,
|
|
$graphVersion
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Sends a DELETE request to Graph and returns the result.
|
|
*
|
|
* @param string $endpoint
|
|
* @param array $params
|
|
* @param AccessToken|string|null $accessToken
|
|
* @param string|null $eTag
|
|
* @param string|null $graphVersion
|
|
*
|
|
* @return FacebookResponse
|
|
*
|
|
* @throws FacebookSDKException
|
|
*/
|
|
public function delete($endpoint, array $params = [], $accessToken = null, $eTag = null, $graphVersion = null)
|
|
{
|
|
return $this->sendRequest(
|
|
'DELETE',
|
|
$endpoint,
|
|
$params,
|
|
$accessToken,
|
|
$eTag,
|
|
$graphVersion
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Sends a request to Graph for the next page of results.
|
|
*
|
|
* @param GraphEdge $graphEdge The GraphEdge to paginate over.
|
|
*
|
|
* @return GraphEdge|null
|
|
*
|
|
* @throws FacebookSDKException
|
|
*/
|
|
public function next(GraphEdge $graphEdge)
|
|
{
|
|
return $this->getPaginationResults($graphEdge, 'next');
|
|
}
|
|
|
|
/**
|
|
* Sends a request to Graph for the previous page of results.
|
|
*
|
|
* @param GraphEdge $graphEdge The GraphEdge to paginate over.
|
|
*
|
|
* @return GraphEdge|null
|
|
*
|
|
* @throws FacebookSDKException
|
|
*/
|
|
public function previous(GraphEdge $graphEdge)
|
|
{
|
|
return $this->getPaginationResults($graphEdge, 'previous');
|
|
}
|
|
|
|
/**
|
|
* Sends a request to Graph for the next page of results.
|
|
*
|
|
* @param GraphEdge $graphEdge The GraphEdge to paginate over.
|
|
* @param string $direction The direction of the pagination: next|previous.
|
|
*
|
|
* @return GraphEdge|null
|
|
*
|
|
* @throws FacebookSDKException
|
|
*/
|
|
public function getPaginationResults(GraphEdge $graphEdge, $direction)
|
|
{
|
|
$paginationRequest = $graphEdge->getPaginationRequest($direction);
|
|
if (!$paginationRequest) {
|
|
return null;
|
|
}
|
|
|
|
$this->lastResponse = $this->client->sendRequest($paginationRequest);
|
|
|
|
// Keep the same GraphNode subclass
|
|
$subClassName = $graphEdge->getSubClassName();
|
|
$graphEdge = $this->lastResponse->getGraphEdge($subClassName, false);
|
|
|
|
return count($graphEdge) > 0 ? $graphEdge : null;
|
|
}
|
|
|
|
/**
|
|
* Sends a request to Graph and returns the result.
|
|
*
|
|
* @param string $method
|
|
* @param string $endpoint
|
|
* @param array $params
|
|
* @param AccessToken|string|null $accessToken
|
|
* @param string|null $eTag
|
|
* @param string|null $graphVersion
|
|
*
|
|
* @return FacebookResponse
|
|
*
|
|
* @throws FacebookSDKException
|
|
*/
|
|
public function sendRequest($method, $endpoint, array $params = [], $accessToken = null, $eTag = null, $graphVersion = null)
|
|
{
|
|
$accessToken = $accessToken ?: $this->defaultAccessToken;
|
|
$graphVersion = $graphVersion ?: $this->defaultGraphVersion;
|
|
$request = $this->request($method, $endpoint, $params, $accessToken, $eTag, $graphVersion);
|
|
|
|
return $this->lastResponse = $this->client->sendRequest($request);
|
|
}
|
|
|
|
/**
|
|
* Sends a batched request to Graph and returns the result.
|
|
*
|
|
* @param array $requests
|
|
* @param AccessToken|string|null $accessToken
|
|
* @param string|null $graphVersion
|
|
*
|
|
* @return FacebookBatchResponse
|
|
*
|
|
* @throws FacebookSDKException
|
|
*/
|
|
public function sendBatchRequest(array $requests, $accessToken = null, $graphVersion = null)
|
|
{
|
|
$accessToken = $accessToken ?: $this->defaultAccessToken;
|
|
$graphVersion = $graphVersion ?: $this->defaultGraphVersion;
|
|
$batchRequest = new FacebookBatchRequest(
|
|
$this->app,
|
|
$requests,
|
|
$accessToken,
|
|
$graphVersion
|
|
);
|
|
|
|
return $this->lastResponse = $this->client->sendBatchRequest($batchRequest);
|
|
}
|
|
|
|
/**
|
|
* Instantiates an empty FacebookBatchRequest entity.
|
|
*
|
|
* @param AccessToken|string|null $accessToken The top-level access token. Requests with no access token
|
|
* will fallback to this.
|
|
* @param string|null $graphVersion The Graph API version to use.
|
|
* @return FacebookBatchRequest
|
|
*/
|
|
public function newBatchRequest($accessToken = null, $graphVersion = null)
|
|
{
|
|
$accessToken = $accessToken ?: $this->defaultAccessToken;
|
|
$graphVersion = $graphVersion ?: $this->defaultGraphVersion;
|
|
|
|
return new FacebookBatchRequest(
|
|
$this->app,
|
|
[],
|
|
$accessToken,
|
|
$graphVersion
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Instantiates a new FacebookRequest entity.
|
|
*
|
|
* @param string $method
|
|
* @param string $endpoint
|
|
* @param array $params
|
|
* @param AccessToken|string|null $accessToken
|
|
* @param string|null $eTag
|
|
* @param string|null $graphVersion
|
|
*
|
|
* @return FacebookRequest
|
|
*
|
|
* @throws FacebookSDKException
|
|
*/
|
|
public function request($method, $endpoint, array $params = [], $accessToken = null, $eTag = null, $graphVersion = null)
|
|
{
|
|
$accessToken = $accessToken ?: $this->defaultAccessToken;
|
|
$graphVersion = $graphVersion ?: $this->defaultGraphVersion;
|
|
|
|
return new FacebookRequest(
|
|
$this->app,
|
|
$accessToken,
|
|
$method,
|
|
$endpoint,
|
|
$params,
|
|
$eTag,
|
|
$graphVersion
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Factory to create FacebookFile's.
|
|
*
|
|
* @param string $pathToFile
|
|
*
|
|
* @return FacebookFile
|
|
*
|
|
* @throws FacebookSDKException
|
|
*/
|
|
public function fileToUpload($pathToFile)
|
|
{
|
|
return new FacebookFile($pathToFile);
|
|
}
|
|
|
|
/**
|
|
* Factory to create FacebookVideo's.
|
|
*
|
|
* @param string $pathToFile
|
|
*
|
|
* @return FacebookVideo
|
|
*
|
|
* @throws FacebookSDKException
|
|
*/
|
|
public function videoToUpload($pathToFile)
|
|
{
|
|
return new FacebookVideo($pathToFile);
|
|
}
|
|
|
|
/**
|
|
* Upload a video in chunks.
|
|
*
|
|
* @param int $target The id of the target node before the /videos edge.
|
|
* @param string $pathToFile The full path to the file.
|
|
* @param array $metadata The metadata associated with the video file.
|
|
* @param string|null $accessToken The access token.
|
|
* @param int $maxTransferTries The max times to retry a failed upload chunk.
|
|
* @param string|null $graphVersion The Graph API version to use.
|
|
*
|
|
* @return array
|
|
*
|
|
* @throws FacebookSDKException
|
|
*/
|
|
public function uploadVideo($target, $pathToFile, $metadata = [], $accessToken = null, $maxTransferTries = 5, $graphVersion = null)
|
|
{
|
|
$accessToken = $accessToken ?: $this->defaultAccessToken;
|
|
$graphVersion = $graphVersion ?: $this->defaultGraphVersion;
|
|
|
|
$uploader = new FacebookResumableUploader($this->app, $this->client, $accessToken, $graphVersion);
|
|
$endpoint = '/'.$target.'/videos';
|
|
$file = $this->videoToUpload($pathToFile);
|
|
$chunk = $uploader->start($endpoint, $file);
|
|
|
|
do {
|
|
$chunk = $this->maxTriesTransfer($uploader, $endpoint, $chunk, $maxTransferTries);
|
|
} while (!$chunk->isLastChunk());
|
|
|
|
return [
|
|
'video_id' => $chunk->getVideoId(),
|
|
'success' => $uploader->finish($endpoint, $chunk->getUploadSessionId(), $metadata),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Attempts to upload a chunk of a file in $retryCountdown tries.
|
|
*
|
|
* @param FacebookResumableUploader $uploader
|
|
* @param string $endpoint
|
|
* @param FacebookTransferChunk $chunk
|
|
* @param int $retryCountdown
|
|
*
|
|
* @return FacebookTransferChunk
|
|
*
|
|
* @throws FacebookSDKException
|
|
*/
|
|
private function maxTriesTransfer(FacebookResumableUploader $uploader, $endpoint, FacebookTransferChunk $chunk, $retryCountdown)
|
|
{
|
|
$newChunk = $uploader->transfer($endpoint, $chunk, $retryCountdown < 1);
|
|
|
|
if ($newChunk !== $chunk) {
|
|
return $newChunk;
|
|
}
|
|
|
|
$retryCountdown--;
|
|
|
|
// If transfer() returned the same chunk entity, the transfer failed but is resumable.
|
|
return $this->maxTriesTransfer($uploader, $endpoint, $chunk, $retryCountdown);
|
|
}
|
|
}
|