MappedObject.php in Salesforce Suite 5.0.x

Namespace

Drupal\salesforce_mapping\Entity

File

modules/salesforce_mapping/src/Entity/MappedObject.php

<?php

namespace Drupal\salesforce_mapping\Entity;

use Drupal\Core\Entity\EntityChangedInterface;
use Drupal\Core\Entity\EntityChangedTrait;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Entity\RevisionableContentEntityBase;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\TypedData\TypedDataInterface;
use Drupal\salesforce\Event\SalesforceEvents;
use Drupal\salesforce\Event\SalesforceNoticeEvent;
use Drupal\salesforce\Event\SalesforceWarningEvent;
use Drupal\salesforce\Exception as SalesforceException;
use Drupal\salesforce\SFID;
use Drupal\salesforce\SObject;
use Drupal\salesforce_mapping\Event\SalesforcePullEntityValueEvent;
use Drupal\salesforce_mapping\Event\SalesforcePullEvent;
use Drupal\salesforce_mapping\Event\SalesforcePushParamsEvent;
use Drupal\salesforce_mapping\MappingConstants;
use Drupal\salesforce_mapping\Plugin\Field\FieldType\SalesforceLinkItemList;
use Drupal\salesforce_mapping\PushParams;

/**
 * Defines a Salesforce Mapped Object entity class.
 *
 * Mapped Objects are content entities, since they're defined by references
 * to other content entities.
 *
 * @ContentEntityType(
 *   id = "salesforce_mapped_object",
 *   label = @Translation("Salesforce Mapped Object"),
 *   module = "salesforce_mapping",
 *   handlers = {
 *     "storage" = "Drupal\salesforce_mapping\MappedObjectStorage",
 *     "storage_schema" = "Drupal\salesforce_mapping\MappedObjectStorageSchema",
 *     "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
 *     "views_data" = "Drupal\views\EntityViewsData",
 *     "access" = "Drupal\salesforce_mapping\MappedObjectAccessControlHandler",
 *   },
 *   base_table = "salesforce_mapped_object",
 *   revision_table = "salesforce_mapped_object_revision",
 *   admin_permission = "administer salesforce mapping",
 *   entity_keys = {
 *      "id" = "id",
 *      "entity_id" = "drupal_entity__target_id",
 *      "salesforce_id" = "salesforce_id",
 *      "revision" = "revision_id",
 *      "label" = "salesforce_id"
 *   },
 *   revision_metadata_keys = {
 *     "revision_user" = "revision_user",
 *     "revision_created" = "revision_created",
 *     "revision_log_message" = "revision_log_message"
 *   },
 *   constraints = {
 *     "MappingSfid" = {},
 *     "MappingEntity" = {},
 *     "MappingEntityType" = {}
 *   }
 * )
 */
class MappedObject extends RevisionableContentEntityBase implements MappedObjectInterface {
  use EntityChangedTrait;

  /**
   * Salesforce Object.
   *
   * @var \Drupal\salesforce\SObject
   */
  protected $sfObject = NULL;

  /**
   * Drupal entity stub, as its in the process of being created during pulls.
   *
   * @var \Drupal\Core\Entity\FieldableEntityInterface
   */
  protected $drupalEntityStub = NULL;

  /**
   * Overrides ContentEntityBase::__construct().
   */
  public function __construct(array $values) {

    // @TODO: Revisit this language stuff
    // Drupal adds a layer of abstraction for translation purposes, even though
    // we're talking about numeric identifiers that aren't language-dependent
    // in any way, so we have to build our own constructor in order to allow
    // callers to ignore this layer.
    foreach ($values as &$value) {
      if (!is_array($value)) {
        $value = [
          LanguageInterface::LANGCODE_DEFAULT => $value,
        ];
      }
    }
    parent::__construct($values, 'salesforce_mapped_object');
  }

  /**
   * {@inheritdoc}
   */
  public function preSaveRevision(EntityStorageInterface $storage, \stdClass $record) {

    // Revision uid, timestamp, and message are required for D9.
    if ($this
      ->isNewRevision()) {
      if (empty($this
        ->getRevisionUserId())) {
        $this
          ->setRevisionUserId(1);
      }
      if (empty($this
        ->getRevisionCreationTime())) {
        $this
          ->setRevisionCreationTime(time());
      }
      if (empty($this
        ->getRevisionLogMessage())) {
        $this
          ->setRevisionLogMessage('New revision');
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function save() {
    $this->changed = $this
      ->getRequestTime();
    if ($this
      ->isNew()) {
      $this->created = $this
        ->getRequestTime();
    }
    return parent::save();
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    if ($update) {
      $this
        ->pruneRevisions($storage);
    }
    return parent::postSave($storage, $update);
  }

  /**
   * {@inheritdoc}
   */
  public function pruneRevisions(EntityStorageInterface $storage) {
    $limit = $this
      ->config('salesforce.settings')
      ->get('limit_mapped_object_revisions');
    if ($limit <= 0) {

      // Limit 0 means no limit.
      return $this;
    }
    $count = $storage
      ->getQuery()
      ->allRevisions()
      ->condition('id', $this
      ->id())
      ->count()
      ->execute();

    // Query for any revision id beyond the limit.
    if ($count <= $limit) {
      return $this;
    }
    $vids_to_delete = $storage
      ->getQuery()
      ->allRevisions()
      ->condition('id', $this
      ->id())
      ->range($limit, $count)
      ->sort('changed', 'DESC')
      ->execute();
    if (empty($vids_to_delete)) {
      return $this;
    }
    foreach ($vids_to_delete as $vid => $dummy) {

      /** @var \Drupal\Core\Entity\RevisionableInterface $revision */
      if ($revision = $storage
        ->loadRevision($vid)) {

        // Prevent deletion if this is the default revision.
        if ($revision
          ->isDefaultRevision()) {
          continue;
        }
      }
      $storage
        ->deleteRevision($vid);
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $i = 0;
    $fields['drupal_entity'] = BaseFieldDefinition::create('dynamic_entity_reference')
      ->setLabel(t('Mapped Entity'))
      ->setDescription(t('Reference to the Drupal entity mapped by this mapped object.'))
      ->setRevisionable(FALSE)
      ->setCardinality(1)
      ->setDisplayOptions('form', [
      'type' => 'dynamic_entity_reference_default',
      'weight' => $i,
    ])
      ->setDisplayOptions('view', [
      'label' => 'above',
      'type' => 'dynamic_entity_reference_label',
      'weight' => $i++,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['salesforce_mapping'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Salesforce mapping'))
      ->setDescription(t('Salesforce mapping used to push/pull this mapped object'))
      ->setRevisionable(TRUE)
      ->setSetting('max_length', EntityTypeInterface::ID_MAX_LENGTH)
      ->setSetting('target_type', 'salesforce_mapping')
      ->setSetting('handler', 'default')
      ->setRequired(TRUE)
      ->setDisplayOptions('form', [
      'type' => 'options_select',
      'weight' => $i,
    ])
      ->setSettings([
      'allowed_values' => [],
    ])
      ->setDisplayOptions('view', [
      'label' => 'above',
      'type' => 'string',
      'weight' => $i++,
    ]);

    // @TODO make this work with Drupal\salesforce\SFID (?)
    $fields['salesforce_id'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Salesforce ID'))
      ->setDescription(t('Reference to the mapped Salesforce object (SObject)'))
      ->setRevisionable(TRUE)
      ->setTranslatable(FALSE)
      ->setSetting('is_ascii', TRUE)
      ->setSetting('max_length', SFID::MAX_LENGTH)
      ->setDisplayOptions('form', [
      'type' => 'string_textfield',
      'weight' => $i++,
    ])
      ->setDisplayOptions('view', [
      'type' => 'hidden',
    ]);
    $fields['salesforce_link'] = BaseFieldDefinition::create('salesforce_link')
      ->setLabel('Salesforce Record')
      ->setDescription(t('Link to salesforce record'))
      ->setRevisionable(FALSE)
      ->setTranslatable(FALSE)
      ->setComputed(TRUE)
      ->setClass(SalesforceLinkItemList::class)
      ->setDisplayOptions('view', [
      'label' => 'above',
      'type' => 'string',
      'weight' => $i++,
    ]);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Authored on'))
      ->setDescription(t('The time that the object mapping was created.'))
      ->setRevisionable(TRUE)
      ->setDisplayOptions('view', [
      'label' => 'above',
      'type' => 'timestamp',
      'weight' => $i++,
    ]);
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setDescription(t('The time that the object mapping was last edited.'))
      ->setRevisionable(TRUE)
      ->setDisplayOptions('view', [
      'label' => 'above',
      'type' => 'string',
      'weight' => $i++,
    ]);
    $fields['entity_updated'] = BaseFieldDefinition::create('timestamp')
      ->setLabel(t('Drupal Entity Updated'))
      ->setDescription(t('The Unix timestamp when the mapped Drupal entity was last updated.'))
      ->setRevisionable(TRUE)
      ->setDefaultValue(0)
      ->setDisplayOptions('view', [
      'label' => 'above',
      'type' => 'string',
      'weight' => $i++,
    ]);
    $fields['last_sync_status'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Status of most recent sync'))
      ->setDescription(t('Indicates whether most recent sync was successful or not.'))
      ->setRevisionable(TRUE);
    $fields['last_sync_action'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Action of most recent sync'))
      ->setDescription(t('Indicates acion which triggered most recent sync for this mapped object'))
      ->setSetting('is_ascii', TRUE)
      ->setSetting('max_length', MappingConstants::SALESFORCE_MAPPING_TRIGGER_MAX_LENGTH)
      ->setRevisionable(TRUE);
    $fields['force_pull'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Force Pull'))
      ->setDescription(t('Whether to ignore entity timestamps and force an update on the next pull for this record.'))
      ->setRevisionable(FALSE);

    // @see ContentEntityBase::baseFieldDefinitions
    // and RevisionLogEntityTrait::revisionLogBaseFieldDefinitions
    $fields += parent::baseFieldDefinitions($entity_type);
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function getChanged() {
    return $this
      ->get('entity_updated')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function getMapping() {
    return $this->salesforce_mapping->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function getMappedEntity() {
    return $this->drupal_entity->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function setDrupalEntity(EntityInterface $entity = NULL) {
    $this
      ->set('drupal_entity', $entity);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function client() {
    return \Drupal::service('salesforce.client');
  }

  /**
   * {@inheritdoc}
   */
  public function eventDispatcher() {
    return \Drupal::service('event_dispatcher');
  }

  /**
   * {@inheritdoc}
   */
  public function config($name) {
    return \Drupal::service('config.factory')
      ->get($name);
  }

  /**
   * {@inheritdoc}
   */
  public function authMan() {
    return \Drupal::service('plugin.manager.salesforce.auth_providers');
  }

  /**
   * {@inheritdoc}
   */
  public function getSalesforceUrl() {
    return $this
      ->authMan()
      ->getProvider()
      ->getInstanceUrl() . '/' . $this->salesforce_id->value;
  }

  /**
   * {@inheritdoc}
   */
  public function sfid() {
    return $this->salesforce_id->value;
  }

  /**
   * {@inheritdoc}
   */
  public function push() {

    // @TODO need error handling, logging, and hook invocations within this function, where we can provide full context, or short of that clear documentation on how callers should handle errors and exceptions. At the very least, we need to make sure to include $params in some kind of exception if we're not going to handle it inside this function.
    $mapping = $this
      ->getMapping();
    $drupal_entity = $this
      ->getMappedEntity();

    // Previously hook_salesforce_push_params_alter.
    $params = new PushParams($mapping, $drupal_entity);
    $this
      ->eventDispatcher()
      ->dispatch(new SalesforcePushParamsEvent($this, $params), SalesforceEvents::PUSH_PARAMS);

    // @TODO is this the right place for this logic to live?
    // Cases:
    // 1. Already mapped to an existing Salesforce object + always_upsert not
    //    set?  Update.
    // 2. Not mapped, but upsert key is defined?  Upsert.
    // 3. Not mapped & no upsert key?  Create.
    if ($this
      ->sfid() && !$mapping
      ->alwaysUpsert()) {
      $action = 'update';
      $result = $this
        ->client()
        ->objectUpdate($mapping
        ->getSalesforceObjectType(), $this
        ->sfid(), $params
        ->getParams());
    }
    elseif ($mapping
      ->hasKey()) {
      $action = 'upsert';
      $result = $this
        ->client()
        ->objectUpsert($mapping
        ->getSalesforceObjectType(), $mapping
        ->getKeyField(), $mapping
        ->getKeyValue($drupal_entity), $params
        ->getParams());
    }
    else {
      $action = 'create';
      $result = $this
        ->client()
        ->objectCreate($mapping
        ->getSalesforceObjectType(), $params
        ->getParams());
    }
    if ($drupal_entity instanceof EntityChangedInterface) {
      $this
        ->set('entity_updated', $drupal_entity
        ->getChangedTime());
    }

    // @TODO: catch EntityStorageException ? Others ?
    if ($result instanceof SFID) {
      $this
        ->set('salesforce_id', (string) $result);
    }

    // @TODO setNewRevision not chainable, per https://www.drupal.org/node/2839075
    $this
      ->setNewRevision(TRUE);
    $this
      ->set('last_sync_action', 'push_' . $action)
      ->set('last_sync_status', TRUE)
      ->set('revision_log_message', '')
      ->save();

    // Previously hook_salesforce_push_success.
    $this
      ->eventDispatcher()
      ->dispatch(new SalesforcePushParamsEvent($this, $params), SalesforceEvents::PUSH_SUCCESS);
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function pushDelete() {
    $mapping = $this
      ->getMapping();
    $this
      ->client()
      ->objectDelete($mapping
      ->getSalesforceObjectType(), $this
      ->sfid());
    $this
      ->setNewRevision(TRUE);
    $this
      ->set('last_sync_action', 'push_delete')
      ->set('last_sync_status', TRUE)
      ->save();
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setDrupalEntityStub(EntityInterface $entity = NULL) {
    $this->drupalEntityStub = $entity;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDrupalEntityStub() {
    return $this->drupalEntityStub;
  }

  /**
   * {@inheritdoc}
   */
  public function setSalesforceRecord(SObject $sfObject) {
    $this->sfObject = $sfObject;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getSalesforceRecord() {
    return $this->sfObject;
  }

  /**
   * {@inheritdoc}
   */
  public function pull() {
    $mapping = $this
      ->getMapping();

    // If the pull isn't coming from a cron job.
    if ($this->sfObject == NULL) {
      if ($this
        ->sfid()) {
        $this->sfObject = $this
          ->client()
          ->objectRead($mapping
          ->getSalesforceObjectType(), $this
          ->sfid());
      }
      elseif ($mapping
        ->hasKey()) {
        $this->sfObject = $this
          ->client()
          ->objectReadbyExternalId($mapping
          ->getSalesforceObjectType(), $mapping
          ->getKeyField(), $mapping
          ->getKeyValue($this
          ->getMappedEntity()));
        $this
          ->set('salesforce_id', (string) $this->sfObject
          ->id());
      }
    }

    // No object found means there's nothing to pull.
    if (!$this->sfObject instanceof SObject) {
      throw new SalesforceException('Nothing to pull. Please specify a Salesforce ID, or choose a mapping with an Upsert Key defined.');
    }

    // @TODO better way to handle push/pull:
    $fields = $mapping
      ->getPullFields();

    /** @var \Drupal\Core\Entity\FieldableEntityInterface $drupal_entity */
    $drupal_entity = $this
      ->getMappedEntity() ?: $this
      ->getDrupalEntityStub();

    /** @var \Drupal\salesforce_mapping\SalesforceMappingFieldPluginInterface $field */
    foreach ($fields as $field) {
      try {
        $value = $field
          ->pullValue($this->sfObject, $drupal_entity, $mapping);
      } catch (\Exception $e) {

        // Field missing from SObject? Skip it.
        $message = 'Field @sobj.@sffield not found on @sfid';
        $args = [
          '@sobj' => $mapping
            ->getSalesforceObjectType(),
          '@sffield' => $field
            ->config('salesforce_field'),
          '@sfid' => $this
            ->sfid(),
        ];
        $this
          ->eventDispatcher()
          ->dispatch(new SalesforceNoticeEvent($e, $message, $args), SalesforceEvents::NOTICE);
        continue;
      }
      $this
        ->eventDispatcher()
        ->dispatch(new SalesforcePullEntityValueEvent($value, $field, $this), SalesforceEvents::PULL_ENTITY_VALUE);
      try {

        // If $value is TypedData, it should have been set during pullValue().
        if (!$value instanceof TypedDataInterface) {
          $drupal_field = $field
            ->get('drupal_field_value');
          $drupal_entity
            ->set($drupal_field, $value);
        }
      } catch (\Exception $e) {
        $message = 'Exception during pull for @sfobj.@sffield @sfid to @dobj.@dprop @did with value @v';
        $args = [
          '@sfobj' => $mapping
            ->getSalesforceObjectType(),
          '@sffield' => $field
            ->config('salesforce_field'),
          '@sfid' => $this
            ->sfid(),
          '@dobj' => $drupal_entity
            ->getEntityTypeId(),
          '@dprop' => $field
            ->get('drupal_field_value'),
          '@did' => $drupal_entity
            ->id(),
          '@v' => $value,
        ];
        $this
          ->eventDispatcher()
          ->dispatch(new SalesforceWarningEvent($e, $message, $args), SalesforceEvents::WARNING);
        continue;
      }
    }

    // @TODO: Event dispatching and entity saving should not be happening in this context, but inside a controller. This class needs to be more model-like.
    $this
      ->eventDispatcher()
      ->dispatch(new SalesforcePullEvent($this, $drupal_entity
      ->isNew() ? MappingConstants::SALESFORCE_MAPPING_SYNC_SF_CREATE : MappingConstants::SALESFORCE_MAPPING_SYNC_SF_UPDATE), SalesforceEvents::PULL_PRESAVE);

    // Set a flag here to indicate that a pull is happening, to avoid
    // triggering a push.
    $drupal_entity->salesforce_pull = TRUE;
    $drupal_entity
      ->save();

    // Update mapping object.
    $this
      ->set('drupal_entity', $drupal_entity)
      ->set('entity_updated', $this
      ->getRequestTime())
      ->set('last_sync_action', 'pull')
      ->set('last_sync_status', TRUE)
      ->set('force_pull', 0)
      ->save();
    return $this;
  }

  /**
   * Testable func to return the request time server variable.
   *
   * @return int
   *   The request time.
   */
  protected function getRequestTime() {
    return \Drupal::time()
      ->getRequestTime();
  }

}

Classes

Name	Description
MappedObject	Defines a Salesforce Mapped Object entity class.