RestClient.php in Salesforce Suite 8.3

Namespace

Drupal\salesforce_encrypt\Rest

File

modules/salesforce_encrypt/src/Rest/RestClient.php

<?php

namespace Drupal\salesforce_encrypt\Rest;

use Drupal\Component\Serialization\Json;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Lock\LockBackendInterface;
use Drupal\Core\State\StateInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Core\Url;
use Drupal\encrypt\EncryptServiceInterface;
use Drupal\encrypt\EncryptionProfileInterface;
use Drupal\encrypt\EncryptionProfileManagerInterface;
use Drupal\salesforce\EntityNotFoundException;
use Drupal\salesforce\Rest\RestClient as SalesforceRestClient;
use GuzzleHttp\ClientInterface;
use Drupal\Component\Datetime\TimeInterface;

/**
 * Objects, properties, and methods to communicate with the Salesforce REST API.
 *
 * @deprecated salesforce_encrypt is deprecated and will be removed in 8.x-4.0. Please see change record https://www.drupal.org/node/3034230 for additional information.
 */
class RestClient extends SalesforceRestClient implements EncryptedRestClientInterface {
  use StringTranslationTrait;

  /**
   * Encryption service.
   *
   * @var \Drupal\encrypt\EncryptServiceInterface
   */
  protected $encryption;

  /**
   * Encryption profile manager.
   *
   * @var \Drupal\encrypt\EncryptionProfileManagerInterface
   */
  protected $encryptionProfileManager;

  /**
   * The active encryption profile id.
   *
   * @var string
   */
  protected $encryptionProfileId;

  /**
   * The encryption profile to use when encrypting and decrypting data.
   *
   * @var \Drupal\encrypt\EncryptionProfileInterface
   */
  protected $encryptionProfile;

  /**
   * Construct a new Encrypted Rest Client.
   *
   * @param \GuzzleHttp\ClientInterface $http_client
   *   The GuzzleHttp Client.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   * @param \Drupal\Core\State\StateInterface $state
   *   The state service.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
   *   The cache service.
   * @param \Drupal\Component\Serialization\Json $json
   *   The JSON serializer service.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The Time service.
   * @param \Drupal\encrypt\EncryptServiceInterface $encryption
   *   The encryption service.
   * @param \Drupal\encrypt\EncryptionProfileManagerInterface $encryptionProfileManager
   *   The Encryption profile manager service.
   * @param \Drupal\Core\Lock\LockBackendInterface $lock
   *   The lock backend service.
   *
   * @deprecated salesforce_encrypt is deprecated and will be removed in 8.x-4.0. Please see change record https://www.drupal.org/node/3034230 for additional information.
   */
  public function __construct(ClientInterface $http_client, ConfigFactoryInterface $config_factory, StateInterface $state, CacheBackendInterface $cache, Json $json, TimeInterface $time, EncryptServiceInterface $encryption, EncryptionProfileManagerInterface $encryptionProfileManager, LockBackendInterface $lock) {
    parent::__construct($http_client, $config_factory, $state, $cache, $json, $time);
    $this->encryption = $encryption;
    $this->encryptionProfileId = $this->state
      ->get('salesforce_encrypt.profile');
    $this->encryptionProfileManager = $encryptionProfileManager;
    $this->encryptionProfile = NULL;
    $this->lock = $lock;
  }

  /**
   * {@inheritdoc}
   */
  public function enableEncryption(EncryptionProfileInterface $profile) {
    if ($ret = $this
      ->setEncryption($profile)) {
      $this->state
        ->resetCache();
    }
    return $ret;
  }

  /**
   * {@inheritdoc}
   */
  public function disableEncryption() {
    if ($ret = $this
      ->setEncryption()) {
      $this->state
        ->resetCache();
    }
    return $ret;
  }

  /**
   * {@inheritdoc}
   */
  public function hookEncryptionProfileDelete(EncryptionProfileInterface $profile) {
    if ($this->encryptionProfileId == $profile
      ->id()) {
      $this
        ->disableEncryption();
    }
  }

  /**
   * Set the given encryption profile as active.
   *
   * If given profile is null, decrypt and disable encryption.
   *
   * @param \Drupal\encrypt\EncryptionProfileInterface|null $profile
   *   The encryption profile. If null, encryption will be disabled.
   */
  protected function setEncryption(EncryptionProfileInterface $profile = NULL) {
    if (!$this->lock
      ->acquire('salesforce_encrypt')) {
      throw new \RuntimeException('Unable to acquire lock.');
    }
    $access_token = $this
      ->getAccessToken();
    $refresh_token = $this
      ->getRefreshToken();
    $identity = $this
      ->getIdentity();
    $consumerKey = $this
      ->getConsumerKey();
    $consumerSecret = $this
      ->getConsumerSecret();
    $this->encryptionProfileId = $profile == NULL ? NULL : $profile
      ->id();
    $this->encryptionProfile = $profile;
    $this->state
      ->set('salesforce_encrypt.profile', $this->encryptionProfileId);
    $this
      ->setAccessToken($access_token);
    $this
      ->setRefreshToken($refresh_token);
    $this
      ->setIdentity($identity);
    $this
      ->setConsumerKey($consumerKey);
    $this
      ->setConsumerSecret($consumerSecret);
    $this->lock
      ->release('salesforce_encrypt');
  }

  /**
   * {@inheritdoc}
   */
  public function getEncryptionProfile() {
    if ($this->encryptionProfile) {
      return $this->encryptionProfile;
    }
    elseif (empty($this->encryptionProfileId)) {
      return NULL;
    }
    else {
      $this->encryptionProfile = $this->encryptionProfileManager
        ->getEncryptionProfile($this->encryptionProfileId);
      if (empty($this->encryptionProfile)) {
        throw new EntityNotFoundException([
          'id' => $this->encryptionProfileId,
        ], 'encryption_profile');
      }
      return $this->encryptionProfile;
    }
  }

  /**
   * Deprecated, use doGetEncryptionProfile.
   *
   * @deprecated use ::doGetEncryptionProfile().
   */
  protected function _getEncryptionProfile() {
    return $this
      ->doGetEncryptionProfile();
  }

  /**
   * Exception-handling wrapper around getEncryptionProfile().
   *
   * GetEncryptionProfile() will throw an EntityNotFoundException exception
   * if it has an encryption profile ID but cannot load it.  In this wrapper
   * we handle that exception by setting a helpful error message and allow
   * execution to proceed.
   *
   * @return \Drupal\encrypt\EncryptionProfileInterface|null
   *   The encryption profile if it can be loaded, otherwise NULL.
   */
  protected function doGetEncryptionProfile() {
    try {
      $profile = $this
        ->getEncryptionProfile();
    } catch (EntityNotFoundException $e) {
      drupal_set_message($this
        ->t('Error while loading encryption profile. You will need to <a href=":encrypt">assign a new encryption profile</a>, then <a href=":oauth">re-authenticate to Salesforce</a>.', [
        ':encrypt' => Url::fromRoute('salesforce_encrypt.settings')
          ->toString(),
        ':oauth' => Url::fromRoute('salesforce.authorize')
          ->toString(),
      ]), 'error');
    }
    return $profile;
  }

  /**
   * {@inheritdoc}
   */
  public function encrypt($value) {
    if (empty($this
      ->doGetEncryptionProfile())) {
      return $value;
    }
    else {
      return $this->encryption
        ->encrypt($value, $this
        ->doGetEncryptionProfile());
    }
  }

  /**
   * {@inheritdoc}
   */
  public function decrypt($value) {
    if (empty($this
      ->doGetEncryptionProfile()) || empty($value) || mb_strlen($value) === 0) {
      return $value;
    }
    else {
      return $this->encryption
        ->decrypt($value, $this
        ->doGetEncryptionProfile());
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getAccessToken() {
    return $this
      ->decrypt(parent::getAccessToken());
  }

  /**
   * {@inheritdoc}
   */
  public function setAccessToken($token) {
    return parent::setAccessToken($this
      ->encrypt($token));
  }

  /**
   * {@inheritdoc}
   */
  public function getRefreshToken() {
    return $this
      ->decrypt(parent::getRefreshToken());
  }

  /**
   * {@inheritdoc}
   */
  public function setRefreshToken($token) {
    return parent::setRefreshToken($this
      ->encrypt($token));
  }

  /**
   * {@inheritdoc}
   */
  public function setIdentity($data) {
    if (is_array($data)) {
      $data = serialize($data);
    }
    return parent::setIdentity($this
      ->encrypt($data));
  }

  /**
   * {@inheritdoc}
   */
  public function getIdentity() {
    $data = $this
      ->decrypt(parent::getIdentity());
    if (!empty($data) && !is_array($data)) {
      $data = unserialize($data);
    }
    return $data;
  }

  /**
   * {@inheritdoc}
   */
  public function getConsumerKey() {
    return $this
      ->decrypt(parent::getConsumerKey());
  }

  /**
   * {@inheritdoc}
   */
  public function setConsumerKey($value) {
    return parent::setConsumerKey($this
      ->encrypt($value));
  }

  /**
   * {@inheritdoc}
   */
  public function getConsumerSecret() {
    return $this
      ->decrypt(parent::getConsumerSecret());
  }

  /**
   * {@inheritdoc}
   */
  public function setConsumerSecret($value) {
    return parent::setConsumerSecret($this
      ->encrypt($value));
  }

}

Classes

Name	Description
RestClient Deprecated	Objects, properties, and methods to communicate with the Salesforce REST API.