Imported code from old repository
This commit is contained in:
79
CloudObjects/SDK/AccountGateway/AAUIDParser.php
Normal file
79
CloudObjects/SDK/AccountGateway/AAUIDParser.php
Normal file
@@ -0,0 +1,79 @@
|
||||
<?php
|
||||
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
namespace CloudObjects\SDK\AccountGateway;
|
||||
|
||||
use ML\IRI\IRI;
|
||||
|
||||
class AAUIDParser {
|
||||
|
||||
const AAUID_INVALID = 0;
|
||||
|
||||
const AAUID_ACCOUNT = 1;
|
||||
const AAUID_CONNECTION = 2;
|
||||
const AAUID_CONNECTED_ACCOUNT = 3;
|
||||
|
||||
const REGEX_AAUID = "/^[a-z0-9]{16}$/";
|
||||
const REGEX_QUALIFIER = "/^[A-Z]{2}$/";
|
||||
|
||||
/**
|
||||
* Creates a new IRI object representing a AAUID from a string.
|
||||
* Adds the "aauid:" prefix if necessary.
|
||||
*
|
||||
* @param string $aauidString An AAUID string.
|
||||
* @return IRI
|
||||
*/
|
||||
public static function fromString($aauidString) {
|
||||
return new IRI(
|
||||
(substr($aauidString, 0, 6)=='aauid:') ? $aauidString : 'aauid:'.$aauidString
|
||||
);
|
||||
}
|
||||
|
||||
public static function getType(IRI $iri) {
|
||||
if ($iri->getScheme()!='aauid' || $iri->getPath()=='')
|
||||
return self::AAUID_INVALID;
|
||||
|
||||
$segments = explode(':', $iri->getPath());
|
||||
switch (count($segments)) {
|
||||
case 1:
|
||||
return (preg_match(self::REGEX_AAUID, $segments[0]) == 1)
|
||||
? self::AAUID_ACCOUNT
|
||||
: self::AAUID_INVALID;
|
||||
case 3;
|
||||
if (preg_match(self::REGEX_AAUID, $segments[0]) != 1
|
||||
|| preg_match(self::REGEX_QUALIFIER, $segments[2]) != 1)
|
||||
return self::AAUID_INVALID;
|
||||
switch ($segments[1]) {
|
||||
case "connection":
|
||||
return self::AAUID_CONNECTION;
|
||||
case "account":
|
||||
return self::AAUID_CONNECTED_ACCOUNT;
|
||||
default:
|
||||
return self::AAUID_INVALID;
|
||||
}
|
||||
default:
|
||||
return self::AAUID_INVALID;
|
||||
}
|
||||
}
|
||||
|
||||
public static function getAAUID(IRI $iri) {
|
||||
if (self::getType($iri)!=self::AAUID_INVALID) {
|
||||
$segments = explode(':', $iri->getPath());
|
||||
return $segments[0];
|
||||
} else
|
||||
return null;
|
||||
}
|
||||
|
||||
public static function getQualifier(IRI $iri) {
|
||||
if (self::getType($iri)==self::AAUID_CONNECTION
|
||||
|| self::getType($iri)==self::AAUID_CONNECTED_ACCOUNT) {
|
||||
$segments = explode(':', $iri->getPath());
|
||||
return $segments[2];
|
||||
} else
|
||||
return null;
|
||||
}
|
||||
|
||||
}
|
||||
369
CloudObjects/SDK/AccountGateway/AccountContext.php
Normal file
369
CloudObjects/SDK/AccountGateway/AccountContext.php
Normal file
@@ -0,0 +1,369 @@
|
||||
<?php
|
||||
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
namespace CloudObjects\SDK\AccountGateway;
|
||||
|
||||
use ML\IRI\IRI;
|
||||
use ML\JsonLD\Document, ML\JsonLD\JsonLD, ML\JsonLD\Node;
|
||||
use Symfony\Component\HttpFoundation\Request, Symfony\Component\HttpFoundation\Response;
|
||||
use Symfony\Bridge\PsrHttpMessage\Factory\DiactorosFactory;
|
||||
use GuzzleHttp\Client, GuzzleHttp\HandlerStack, GuzzleHttp\Middleware;
|
||||
use Psr\Http\Message\RequestInterface, Psr\Http\Message\ResponseInterface;
|
||||
|
||||
/**
|
||||
* The context of an request for an account.
|
||||
*/
|
||||
class AccountContext {
|
||||
|
||||
private $agwBaseUrl = 'https://{aauid}.aauid.net';
|
||||
private $aauid;
|
||||
private $accessToken;
|
||||
private $dataLoader;
|
||||
|
||||
private $accountDomain = null;
|
||||
private $connectionQualifier = null;
|
||||
private $installQualifier = null;
|
||||
private $accessor = null;
|
||||
private $latestAccessorVersionCOID = null;
|
||||
|
||||
private $request; // optional
|
||||
|
||||
private $document;
|
||||
private $client;
|
||||
|
||||
private $logCode = null;
|
||||
|
||||
/**
|
||||
* Create a new context using an AAUID and an OAuth 2.0 bearer access token.
|
||||
*/
|
||||
public function __construct(IRI $aauid, $accessToken, DataLoader $dataLoader = null) {
|
||||
if (AAUIDParser::getType($aauid) != AAUIDParser::AAUID_ACCOUNT)
|
||||
throw new \Exception("Not a valid AAUID");
|
||||
|
||||
$this->aauid = $aauid;
|
||||
$this->accessToken = $accessToken;
|
||||
if ($dataLoader) {
|
||||
$this->dataLoader = $dataLoader;
|
||||
} else {
|
||||
$this->dataLoader = new DataLoader;
|
||||
}
|
||||
}
|
||||
|
||||
private function parseHeaderIntoNode($headerName, Node $node) {
|
||||
$keyValuePairs = explode(',', $this->request->getHeaderLine($headerName));
|
||||
foreach ($keyValuePairs as $pair) {
|
||||
$keyValue = explode('=', $pair);
|
||||
$node->addPropertyValue($keyValue[0], urldecode($keyValue[1]));
|
||||
}
|
||||
}
|
||||
|
||||
private function parsePsrRequest(RequestInterface $request) {
|
||||
$this->request = $request;
|
||||
|
||||
if ($request->hasHeader('C-Accessor')) {
|
||||
// Store COID of Accessor
|
||||
$this->accessor = new IRI($request->getHeaderLine('C-Accessor'));
|
||||
}
|
||||
|
||||
if ($request->hasHeader('C-Account-Domain')) {
|
||||
// Store account domain
|
||||
$this->accountDomain = $request->getHeaderLine('C-Account-Domain');
|
||||
}
|
||||
|
||||
if ($request->hasHeader('C-Accessor-Latest-Version')) {
|
||||
// A new version of thie accessor is available, store its COID
|
||||
$this->latestAccessorVersionCOID = new IRI($request
|
||||
->getHeaderLine('C-Accessor-Latest-Version'));
|
||||
}
|
||||
|
||||
if ($request->hasHeader('C-Account-Connection')) {
|
||||
// For access from connected accounts, store qualifier
|
||||
$this->connectionQualifier = $request->getHeaderLine('C-Account-Connection');
|
||||
}
|
||||
|
||||
if ($request->hasHeader('C-Install-Connection')) {
|
||||
// For access from applications, store qualifier
|
||||
$this->installQualifier = $request->getHeaderLine('C-Install-Connection');
|
||||
}
|
||||
|
||||
if ($request->hasHeader('C-Connection-Data')) {
|
||||
// Copy Data into document
|
||||
if (!$this->document) $this->document = new Document();
|
||||
$this->parseHeaderIntoNode('C-Connection-Data',
|
||||
$this->document->getGraph()->createNode('aauid:'.$this->getAAUID().':connection:'.$this->connectionQualifier));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new context from the current request.
|
||||
*
|
||||
* @param Request $request
|
||||
*/
|
||||
public static function fromSymfonyRequest(Request $request) {
|
||||
if (!$request->headers->has('C-AAUID') || !$request->headers->has('C-Access-Token'))
|
||||
return null;
|
||||
|
||||
$context = new AccountContext(
|
||||
new IRI('aauid:'.$request->headers->get('C-AAUID')),
|
||||
$request->headers->get('C-Access-Token'));
|
||||
|
||||
$psr7Factory = new DiactorosFactory;
|
||||
$context->parsePsrRequest($psr7Factory->createRequest($request));
|
||||
|
||||
return $context;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new context from the current request.
|
||||
*
|
||||
* @param RequestInterface $request
|
||||
*/
|
||||
public static function fromPsrRequest(RequestInterface $request) {
|
||||
if (!$request->hasHeader('C-AAUID') || !$request->hasHeader('C-Access-Token'))
|
||||
return null;
|
||||
|
||||
$context = new AccountContext(
|
||||
new IRI('aauid:'.$request->getHeaderLine('C-AAUID')),
|
||||
$request->getHeaderLine('C-Access-Token'));
|
||||
|
||||
$context->parsePsrRequest($request);
|
||||
|
||||
return $context;
|
||||
}
|
||||
|
||||
public function getAAUID() {
|
||||
return $this->aauid;
|
||||
}
|
||||
|
||||
public function getAccessToken() {
|
||||
return $this->accessToken;
|
||||
}
|
||||
|
||||
public function getRequest() {
|
||||
return $this->request;
|
||||
}
|
||||
|
||||
public function getDataLoader() {
|
||||
return $this->dataLoader;
|
||||
}
|
||||
|
||||
private function getDocument() {
|
||||
if (!$this->document) {
|
||||
$this->document = $this->dataLoader->fetchAccountGraphDataDocument($this);
|
||||
}
|
||||
|
||||
return $this->document;
|
||||
}
|
||||
|
||||
public function getAccount() {
|
||||
return $this->getDocument()->getGraph()->getNode($this->getAAUID());
|
||||
}
|
||||
|
||||
public function getPerson() {
|
||||
return $this->getDocument()->getGraph()->getNode($this->getAAUID().':person');
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether the context uses an account connection, which is the case when an API
|
||||
* is requested by a connected account on another service.
|
||||
*/
|
||||
public function usesAccountConnection() {
|
||||
return ($this->connectionQualifier !== null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the qualifier of the account connection used for accessing the API.
|
||||
*/
|
||||
public function getConnectionQualifier() {
|
||||
return $this->connectionQualifier;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the qualifier for the connection to the platform service.
|
||||
* Only available when the accessor is an application.
|
||||
*/
|
||||
public function getInstallQualifier() {
|
||||
return $this->installQualifier;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the accessor.
|
||||
*/
|
||||
public function getAccessorCOID() {
|
||||
return $this->accessor;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the account's domain.
|
||||
* Only set from external API requests, null otherwise.
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getAccountDomain() {
|
||||
return $this->accountDomain;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a connected account.
|
||||
* @param $qualifier The qualifier for the account connection. If not specified, uses the connection qualifier.
|
||||
*/
|
||||
public function getConnectedAccount($qualifier = null) {
|
||||
if (!$qualifier) $qualifier = $this->getConnectionQualifier();
|
||||
if (!$qualifier) return null;
|
||||
return $this->getDocument()->getGraph()->getNode($this->getAAUID().':account:'.$qualifier);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an account connection.
|
||||
* @param $qualifier The qualifier for the account connection. If not specified, uses the connection qualifier.
|
||||
*/
|
||||
public function getAccountConnection($qualifier = null) {
|
||||
if (!$qualifier) $qualifier = $this->getConnectionQualifier();
|
||||
if (!$qualifier) return null;
|
||||
return $this->getDocument()->getGraph()->getNode($this->getAAUID().':connection:'.$qualifier);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the connected account for a service.
|
||||
* @param $service COID of the service
|
||||
*/
|
||||
public function getConnectedAccountForService($service) {
|
||||
$accounts = $this->getDocument()->getGraph()->getNodesByType('coid://aauid.net/Account');
|
||||
foreach ($accounts as $a) {
|
||||
if ($a->getProperty('coid://aauid.net/isForService')
|
||||
&& $a->getProperty('coid://aauid.net/isForService')->getId()==$service) return $a;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all account connections.
|
||||
*/
|
||||
public function getAllAccountConnections() {
|
||||
$connections = $this->getAccount()->getProperty('coid://aauid.net/hasConnection');
|
||||
if (!is_array($connections)) $connections = array($connections);
|
||||
return $connections;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all connected accounts.
|
||||
*/
|
||||
public function getAllConnectedAccounts() {
|
||||
$accounts = array();
|
||||
foreach ($this->getAllAccountConnections() as $ac) {
|
||||
$accounts[] = $ac->getProperty('coid://aauid.net/connectsTo');
|
||||
}
|
||||
return $accounts;
|
||||
}
|
||||
|
||||
/**
|
||||
* Pushes changes on the Account Graph into the Account Graph.
|
||||
*/
|
||||
public function pushGraphUpdates() {
|
||||
$this->getClient()->post('/~/', [
|
||||
'headers' => ['Content-Type' => 'application/ld+json'],
|
||||
'body' => JsonLD::toString($this->getDocument()->toJsonLd())
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies a template for the Account Gateway Base URL. Must be a valid URL that
|
||||
* may contain an {aauid} placeholder. Call this if you want to redirect traffic
|
||||
* through a proxy or a staging or mock instance of an Account Gateway. Most users
|
||||
* of this SDK should never call this function.
|
||||
*/
|
||||
public function setAccountGatewayBaseURLTemplate($baseUrl) {
|
||||
$this->agwBaseUrl = $baseUrl;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a preconfigured Guzzle client to access the Account Gateway.
|
||||
* @return Client
|
||||
*/
|
||||
public function getClient() {
|
||||
if (!$this->client) {
|
||||
// Create custom handler stack with middlewares
|
||||
$stack = HandlerStack::create();
|
||||
|
||||
$context = $this;
|
||||
$stack->push(Middleware::mapResponse(function (ResponseInterface $response) use ($context) {
|
||||
// If a new version of this accessor is available, store its COID
|
||||
if ($response->hasHeader('C-Accessor-Latest-Version'))
|
||||
$context->setLatestAccessorVersionCOID(
|
||||
new IRI($response->getHeaderLine('C-Accessor-Latest-Version')));
|
||||
return $response;
|
||||
}));
|
||||
|
||||
// Prepare client options
|
||||
$options = [
|
||||
'base_uri' => str_replace('{aauid}', AAUIDParser::getAAUID($this->getAAUID()), $this->agwBaseUrl),
|
||||
'headers' => [
|
||||
'Authorization' => 'Bearer '.$this->getAccessToken()
|
||||
],
|
||||
'handler' => $stack
|
||||
];
|
||||
if (isset($this->request) && $this->request->hasHeader('X-Forwarded-For')) {
|
||||
$options['headers']['X-Forwarded-For'] = $this->request->getHeaderLine('X-Forwarded-For');
|
||||
}
|
||||
|
||||
// Create client
|
||||
$this->client = new Client($options);
|
||||
}
|
||||
return $this->client;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a custom code for the current request in the Account Gateway logs.
|
||||
*/
|
||||
public function setLogCode($logCode) {
|
||||
if (!$this->request) {
|
||||
throw new \Exception('Not in a request context.');
|
||||
}
|
||||
$this->logCode = $logCode;
|
||||
}
|
||||
|
||||
/**
|
||||
* Process a response and add headers if applicable.
|
||||
*/
|
||||
public function processResponse(Response $response) {
|
||||
if ($this->logCode) {
|
||||
$response->headers->set('C-Code-For-Logger', $this->logCode);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check whether a new version of the accessor is available. This information
|
||||
* is updated from incoming and outgoing requests. If no request was executed,
|
||||
* returns false.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
public function isNewAccessorVersionAvailable() {
|
||||
return isset($this->latestAccessorVersionCOID);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the COID of the latest accessor version, if one is available, or
|
||||
* null otherwise. This information is updated from incoming and outgoing
|
||||
* requests. If no request was executed, returns null.
|
||||
*
|
||||
* @return IRI|null
|
||||
*/
|
||||
public function getLatestAccessorVersionCOID() {
|
||||
return $this->latestAccessorVersionCOID;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the COID of the latest accessor version. This method should only
|
||||
* called from request processing codes. Most developers should not use it.
|
||||
*
|
||||
* @param IRI $latestAccessorVersionCOID
|
||||
*/
|
||||
public function setLatestAccessorVersionCOID(IRI $latestAccessorVersionCOID) {
|
||||
$this->latestAccessorVersionCOID = $latestAccessorVersionCOID;
|
||||
}
|
||||
|
||||
}
|
||||
81
CloudObjects/SDK/AccountGateway/DataLoader.php
Normal file
81
CloudObjects/SDK/AccountGateway/DataLoader.php
Normal file
@@ -0,0 +1,81 @@
|
||||
<?php
|
||||
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
namespace CloudObjects\SDK\AccountGateway;
|
||||
|
||||
use Doctrine\Common\Cache\Cache;
|
||||
use ML\JsonLD\JsonLD;
|
||||
use GuzzleHttp\Psr7\Request;
|
||||
|
||||
class DataLoader {
|
||||
|
||||
const CACHE_TTL = 172800; // cache at most 48 hours
|
||||
|
||||
private $cache;
|
||||
private $cachePrefix = 'accdata:';
|
||||
private $mountPointName = '~';
|
||||
|
||||
public function getCache() {
|
||||
return $this->cache;
|
||||
}
|
||||
|
||||
public function setCache(Cache $cache) {
|
||||
$this->cache = $cache;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getCachePrefix() {
|
||||
return $this->cachePrefix;
|
||||
}
|
||||
|
||||
public function setCachePrefix($cachePrefix) {
|
||||
$this->cachePrefix = $cachePrefix;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getMountPointName() {
|
||||
return $this->mountPointName;
|
||||
}
|
||||
|
||||
public function setMountPointName($mountPointName) {
|
||||
$this->mountPointName = $mountPointName;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function fetchAccountGraphDataDocument(AccountContext $accountContext) {
|
||||
$dataRequest = new Request('GET', '/'.$this->mountPointName.'/',
|
||||
['Accept' => 'application/ld+json']);
|
||||
|
||||
if (!$this->cache || !$accountContext->getRequest()
|
||||
|| !$accountContext->getRequest()->hasHeader('C-Data-Updated')) {
|
||||
// No cache or no timestamp available, so always fetch from Account Gateway
|
||||
$dataString = (string)$accountContext->getClient()->send($dataRequest)->getBody();
|
||||
} else {
|
||||
$key = $this->cachePrefix.$accountContext->getAAUID();
|
||||
$remoteTimestamp = $accountContext->getRequest()->getHeaderLine('C-Data-Updated');
|
||||
if ($this->cache->contains($key)) {
|
||||
// Check timestamp
|
||||
$cacheEntry = $this->cache->fetch($key);
|
||||
$timestamp = substr($cacheEntry, 0, strpos($cacheEntry, '|'));
|
||||
if ($timestamp==$remoteTimestamp) {
|
||||
// Cache data is up to date, can be returned
|
||||
$dataString = substr($cacheEntry, strpos($cacheEntry, '|')+1);
|
||||
} else {
|
||||
// Fetch from Account Gateway and update cache entry
|
||||
$dataString = (string)$accountContext->getClient()->send($dataRequest)->getBody();
|
||||
$this->cache->save($key, $remoteTimestamp.'|'.$dataString, self::CACHE_TTL);
|
||||
}
|
||||
} else {
|
||||
// Fetch from Account Gateway and store in cache
|
||||
$dataString = (string)$accountContext->getClient()->send($dataRequest)->getBody();
|
||||
$this->cache->save($key, $remoteTimestamp.'|'.$dataString, self::CACHE_TTL);
|
||||
}
|
||||
}
|
||||
|
||||
return JsonLD::getDocument($dataString);
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user