apigee_edge-8.x-1.17/src/Entity/Developer.php
src/Entity/Developer.php
<?php
/**
* Copyright 2018 Google Inc.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* version 2 as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*/
namespace Drupal\apigee_edge\Entity;
use Apigee\Edge\Api\Management\Entity\Developer as EdgeDeveloper;
use Apigee\Edge\Entity\EntityInterface as EdgeEntityInterface;
use Apigee\Edge\Exception\ApiException;
use Apigee\Edge\Structure\AttributesProperty;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Utility\Error;
use Drupal\apigee_edge\Entity\Controller\EntityCacheAwareControllerInterface;
use Drupal\user\Entity\User;
use Drupal\user\UserInterface;
/**
* Defines the Developer entity class.
*
* @\Drupal\apigee_edge\Annotation\EdgeEntityType(
* id = "developer",
* label = @Translation("Developer"),
* label_collection = @Translation("Developers"),
* label_singular = @Translation("developer"),
* label_plural = @Translation("developers"),
* label_count = @PluralTranslation(
* singular = "@count developer",
* plural = "@count developers",
* ),
* handlers = {
* "storage" = "\Drupal\apigee_edge\Entity\Storage\DeveloperStorage",
* },
* query_class = "Drupal\apigee_edge\Entity\Query\DeveloperQuery",
* )
*/
#[\AllowDynamicProperties]
class Developer extends EdgeEntityBase implements DeveloperInterface {
/**
* Developer already exists error code.
*
* @var string
*/
const APIGEE_EDGE_ERROR_CODE_DEVELOPER_ALREADY_EXISTS = 'developer.service.DeveloperAlreadyExists';
/**
* Developer does not exists error code.
*
* @var string
*/
const APIGEE_EDGE_ERROR_CODE_DEVELOPER_DOES_NOT_EXISTS = 'developer.service.DeveloperDoesNotExist';
/**
* Resource name in the url doesnot match with the name in the request payload.
*
* @var string
*/
const APIGEE_HYBRID_ERROR_CODE_DEVELOPER_EMAIL_MISMATCH = 'rest.interceptor.name_mismatch';
/**
* The decorated SDK entity.
*
* @var \Apigee\Edge\Api\Management\Entity\Developer
*/
protected $decorated;
/**
* The cached Drupal UID.
*
* Use getOwnerId() to return the correct value.
*
* @var null|int
*/
protected $drupalUserId;
/**
* The original email address of the developer.
*
* @var null|string
*/
protected $originalEmail;
/**
* Caches company names.
*
* This does not get saved to the persistent entity cache because it gets
* calculated only when it is necessary, when getCompanies() gets called.
*
* @var \Drupal\apigee_edge\Entity\DeveloperCompaniesCacheInterface
*
* @see getCompanies()
*/
protected $companiesCache;
/**
* Developer constructor.
*
* @param array $values
* An array of values to set, keyed by property name.
* @param null|string $entity_type
* Type of the entity. It is optional because constructor sets its default
* value.
* @param \Apigee\Edge\Entity\EntityInterface|null $decorated
* The SDK entity that this Drupal entity decorates.
*/
public function __construct(array $values, ?string $entity_type = NULL, ?EdgeEntityInterface $decorated = NULL) {
$entity_type = $entity_type ?? 'developer';
// Callers expect that the status is always either 'active' or 'inactive',
// never null.
if (!isset($values['status'])) {
$values['status'] = static::STATUS_ACTIVE;
}
parent::__construct($values, $entity_type, $decorated);
// Property must be initialized here because it is used as entity's
// primary id in Drupal.
// @see static::idProperties()
// @see static::drupalEntityId()
$this->originalEmail = $this->originalEmail ?? $this->decorated->getEmail();
$this->companiesCache = \Drupal::service('apigee_edge.controller.cache.developer_companies');
// If we got a non-empty companies list from the API response then
// cache it otherwise ignore it. See more details in getCompanies().
if ($this->decorated->getCompanies()) {
$this->companiesCache->saveCompanies([$this->decorated]);
}
}
/**
* {@inheritdoc}
*
* We have to override this to make it compatible with the SDK's
* entity interface that has return type hint.
*/
public function id(): ?string {
return parent::id();
}
/**
* {@inheritdoc}
*/
protected static function decoratedClass(): string {
return EdgeDeveloper::class;
}
/**
* {@inheritdoc}
*/
public static function uniqueIdProperties(): array {
// Parent returns the original email.
// @see static::idProperty()
return array_merge(parent::uniqueIdProperties(), [
// UUID.
EdgeDeveloper::idProperty(),
]);
}
/**
* {@inheritdoc}
*/
protected function drupalEntityId(): ?string {
return $this->originalEmail;
}
/**
* {@inheritdoc}
*/
public function uuid() {
return $this->decorated->id();
}
/**
* {@inheritdoc}
*/
public function getAttributes(): AttributesProperty {
return $this->decorated->getAttributes();
}
/**
* {@inheritdoc}
*/
public function setAttributes(AttributesProperty $attributes): void {
$this->decorated->setAttributes($attributes);
}
/**
* {@inheritdoc}
*/
public function getAttributeValue(string $attribute): ?string {
return $this->decorated->getAttributeValue($attribute);
}
/**
* {@inheritdoc}
*/
public function setAttribute(string $name, string $value): void {
$this->decorated->setAttribute($name, $value);
}
/**
* {@inheritdoc}
*/
public function hasAttribute(string $name): bool {
return $this->decorated->hasAttribute($name);
}
/**
* {@inheritdoc}
*/
public function deleteAttribute(string $name): void {
$this->decorated->deleteAttribute($name);
}
/**
* {@inheritdoc}
*/
public function getCreatedAt(): ?\DateTimeImmutable {
return $this->decorated->getCreatedAt();
}
/**
* {@inheritdoc}
*/
public function getCreatedBy(): ?string {
return $this->decorated->getCreatedBy();
}
/**
* {@inheritdoc}
*/
public function getLastModifiedAt(): ?\DateTimeImmutable {
return $this->decorated->getLastModifiedAt();
}
/**
* {@inheritdoc}
*/
public function getLastModifiedBy(): ?string {
return $this->decorated->getLastModifiedBy();
}
/**
* {@inheritdoc}
*/
public function getApps(): array {
return $this->decorated->getApps();
}
/**
* {@inheritdoc}
*/
public function hasApp(string $app_name): bool {
return $this->decorated->hasApp($app_name);
}
/**
* {@inheritdoc}
*/
public function getCompanies(): array {
// If companies is null it means the original API response that this
// object constructed did not contain a non-empty company list.
// One of the reasons of this could be that the entity got loaded
// by calling the list developers API endpoint that does not return the
// companies.
// @see https://apidocs.apigee.com/management/apis/get/organizations/%7Borg_name%7D/developers
if ($this->companiesCache->getCompanies($this->getDeveloperId()) === NULL) {
/** @var \Drupal\apigee_edge\Entity\Controller\DeveloperControllerInterface $controller */
$controller = \Drupal::service('apigee_edge.controller.developer');
// If controller has an internal cache let's check whether this
// developer in it and it has a non-empty company list.
if ($controller instanceof EntityCacheAwareControllerInterface) {
/** @var \Apigee\Edge\Api\Management\Entity\DeveloperInterface|null $cached_developer */
$cached_developer = $controller->entityCache()->getEntity($this->getDeveloperId());
if ($cached_developer && !empty($cached_developer->getCompanies())) {
// Save it to the local cache so we can serve it from there
// next time.
$this->companiesCache->saveCompanies([$cached_developer]);
return $this->companiesCache->getCompanies($cached_developer->id());
}
else {
// Let's remove the developer from the cache otherwise we get it back
// with the same empty company list as before (maybe returned by the
// list developers API endpoint) for this developer.
$controller->entityCache()->removeEntities([$this->getDeveloperId()]);
}
}
/** @var \Apigee\Edge\Api\Management\Entity\DeveloperInterface $developer */
try {
$developer = $controller->load($this->getEmail());
// Save the list of companies (even if it is actually empty) to this
// local cache property so we can return this information without
// calling Apigee Edge next time.
$this->companiesCache->saveCompanies([$developer]);
}
catch (ApiException $exception) {
$message = 'Unable to load companies of %developer developer from Apigee Edge. @message %function (line %line of %file). <pre>@backtrace_string</pre>';
$context = [
'%developer' => $this->getEmail(),
];
$context += Error::decodeException($exception);
\Drupal::logger('apigee_edge')->error($message, $context);
// Return an empty array if the API call fails because this is the
// safest thing that we can do in this case.
// Do not change the value of $this->companies because this way we can
// ensure the this method tries to call the API again next time.
return [];
}
}
return $this->companiesCache->getCompanies($this->getDeveloperId());
}
/**
* {@inheritdoc}
*/
public function hasCompany(string $company_name): bool {
return in_array($company_name, $this->getCompanies(), TRUE);
}
/**
* {@inheritdoc}
*/
public function getDeveloperId(): ?string {
return $this->decorated->getDeveloperId();
}
/**
* {@inheritdoc}
*/
public function getUserName(): ?string {
return $this->decorated->getUserName();
}
/**
* {@inheritdoc}
*/
public function setUserName(string $user_name): void {
$this->decorated->setUserName($user_name);
}
/**
* {@inheritdoc}
*/
public function getEmail(): ?string {
return $this->decorated->getEmail();
}
/**
* {@inheritdoc}
*/
public function setEmail(string $email): void {
$this->decorated->setEmail($email);
if ($this->originalEmail === NULL) {
$this->originalEmail = $email;
}
}
/**
* {@inheritdoc}
*/
public function getFirstName(): ?string {
return $this->decorated->getFirstName();
}
/**
* {@inheritdoc}
*/
public function setFirstName(string $first_name): void {
$this->decorated->setFirstName($first_name);
}
/**
* {@inheritdoc}
*/
public function getLastName(): ?string {
return $this->decorated->getLastName();
}
/**
* {@inheritdoc}
*/
public function setLastName(string $last_name): void {
$this->decorated->setLastName($last_name);
}
/**
* {@inheritdoc}
*/
public static function idProperty(): string {
return 'originalEmail';
}
/**
* {@inheritdoc}
*/
public function getOwner() {
$owner_id = $this->getOwnerId();
return $owner_id === NULL ? NULL : User::load($owner_id);
}
/**
* {@inheritdoc}
*/
public function setOwner(UserInterface $account) {
$this->setOwnerId($account->id());
return $this;
}
/**
* {@inheritdoc}
*/
public function getOwnerId() {
if ($this->drupalUserId === NULL) {
if ($this->getEmail()) {
/** @var \Drupal\user\UserInterface $account */
$account = user_load_by_mail($this->getEmail());
if ($account) {
$this->drupalUserId = $account->id();
}
}
// Username is not unique on Apigee Edge so we do not use that here.
}
return $this->drupalUserId;
}
/**
* {@inheritdoc}
*/
public function setOwnerId($uid) {
$this->drupalUserId = $uid;
// When a new user is created uid is null.
if ($uid !== NULL) {
$account = User::load($uid);
if ($account !== NULL && $this->getEmail() !== $account->getEmail()) {
$this->setEmail($account->getEmail());
}
}
return $this;
}
/**
* {@inheritdoc}
*/
public function resetOriginalEmail(): void {
$this->originalEmail = $this->decorated->getEmail();
}
/**
* {@inheritdoc}
*/
public function setStatus(string $status): void {
$this->decorated->setStatus($status);
}
/**
* {@inheritdoc}
*/
public function getOrganizationName(): ?string {
return $this->decorated->getOrganizationName();
}
/**
* {@inheritdoc}
*/
public function getStatus(): ?string {
return $this->decorated->getStatus();
}
/**
* {@inheritdoc}
*/
public function getOriginalEmail(): ?string {
return $this->originalEmail;
}
/**
* {@inheritdoc}
*/
public function label() {
// This class does not implement DisplayNamePropertyInterface.
// It make sense to return this as a default label for a developer entity.
// (Both fields are mandatory.)
return "{$this->getFirstName()} {$this->getLastName()}";
}
/**
* {@inheritdoc}
*/
public static function postDelete(EntityStorageInterface $storage, array $entities) {
parent::postDelete($storage, $entities);
/** @var \Drupal\apigee_edge\Entity\DeveloperCompaniesCacheInterface $cache */
$cache = \Drupal::service('apigee_edge.controller.cache.developer_companies');
$developer_mail_id_map = array_map(function (Developer $entity) {
return $entity->getDeveloperId();
}, $entities);
// Remove developer->company membership info from the memory cache.
$cache->remove($developer_mail_id_map);
// Ensure that even if $storage:delete() got called with developer email
// addresses, all cache entries that refers to the same developer by
// its developer id (UUID) also gets invalidated.
$storage->resetCache($developer_mail_id_map);
}
/**
* {@inheritdoc}
*/
public function getCacheMaxAge(): int {
return \Drupal::config('apigee_edge.developer_settings')->get('cache_expiration');
}
}
