/**
* Adds a relationship to the running list of relationships.
*
* @param Entity $source The source entity.
* @param Entity $destination The destination entity that the source entity relates to.
* @param string $field_name The field on the source entity that the relationship belongs to.
* @param int $delta The delta the relationship belongs to.
* @param array $handler_arguments Any arguments to pass to the handler (like the field name).
* @param bool $source_vuuid The VUUID of the source (if false, defaults to the current
* VUUID).
* @param bool $destination_vuuid The VUUID of the destination (if false, the VUUID of the
* destination isn't taken into account).
*/
protected function addRelationship(Entity $source, Entity $destination, $field_name, $delta = 0, array $handler_arguments = array(), $source_vuuid = false, $destination_vuuid = false)
{
// Get the relationship handler name.
$handler = $this->getRelationshipHandlerName();
// Generate the fields for the relationship.
$record = array();
$record['source_type'] = $source->type();
$record['source_uuid'] = $source->uuid();
$record['destination_type'] = $destination->type();
$record['destination_uuid'] = $destination->uuid();
$record['field_name'] = $field_name;
$record['delta'] = $delta;
// Add the source_vuuid column.
if ($source->supportsRevisions()) {
$record['source_vuuid'] = $source_vuuid === false ? $source->vuuid() : $source_vuuid;
} else {
$record['source_vuuid'] = false;
}
// Add the destination vuuid column.
$record['destination_vuuid'] = $destination->supportsRevisions() ? $destination_vuuid : false;
// Add the relationship handler and arguments.
$record['relationship_handler'] = $handler;
$record['relationship_arguments'] = $handler_arguments;
// Check to see if the relationship already exists...
foreach ($this->relationships as $relationship) {
if ($record['source_type'] != $relationship['source_type']) {
continue;
}
if ($record['source_uuid'] != $relationship['source_uuid']) {
continue;
}
if ($record['source_vuuid'] != $relationship['source_vuuid']) {
continue;
}
if ($record['destination_type'] != $relationship['destination_type']) {
continue;
}
if ($record['destination_uuid'] != $relationship['destination_uuid']) {
continue;
}
if ($record['destination_vuuid'] != $relationship['destination_vuuid']) {
continue;
}
if ($record['relationship_handler'] != $relationship['relationship_handler']) {
continue;
}
if (count(array_diff($record['relationship_arguments'], $relationship['relationship_arguments'])) !== 0) {
continue;
}
return;
// The relationship already exists...
}
// Add the relationship to the list.
$this->relationships[] = $record;
}
/**
* Add dependency.
*
* Adds the specified entity to the dependencies list if it doesn't already exist.
*
* @param Entity $entity The entity to add.
* @param mixed $source_override If true, the source is the parent entity. If false,
* no source is recorded. If an array, the array is used
* as the source list.
* @param boolean $requires_latest If true, requires that the entity (the latest version)
* is present.
*
* @return array The new dependency;
*/
protected function addDependency(Entity $entity, $source_override = true, $requires_latest = false)
{
// If we're trying to add a dependency that points to the same entity, just don't
// do anything.
// if ($entity->uuid() == $this->entity->uuid()) return false;
$dependency = null;
if (array_key_exists($entity->uuid(), $this->dependencies)) {
$dependency = $this->dependencies[$entity->uuid()];
}
if ($dependency === null || $entity->supportsRevisions() && $entity->revision() > $dependency['original_revision']) {
$dependency = self::createReferenceDefinition($entity);
}
// Generate the list of sources.
if ($source_override === true) {
$sources = array($this->original_entity->uuid());
} elseif (is_array($source_override)) {
$sources = $source_override;
} else {
$sources = false;
}
// Run through the sources and add the dependency dependencies.
if (is_array($sources) && count($sources) > 0) {
$dependency_dependencies =& drupal_static('publisher_dependency_dependencies', array());
foreach ($sources as $source) {
if (!array_key_exists($source, $dependency_dependencies)) {
$dependency_dependencies[$source] = array();
}
$dependency_dependencies[$source][] = $dependency['uuid'];
}
}
if ($sources !== false) {
if (!array_key_exists('sources', $dependency) || !is_array($dependency['sources'])) {
$dependency['sources'] = array();
}
$dependency['sources'] = array_merge($dependency['sources'], $sources);
}
$dependency['requires_latest'] = array_key_exists('requires_latest', $dependency) ? $requires_latest || $dependency['requires_latest'] : $requires_latest;
$dependency['has_relationship'] = false;
$this->dependencies[$entity->uuid()] = $dependency;
return $dependency;
}
protected function checkForDuplicateRevisions($definition, Entity $entity)
{
$info = entity_get_info($entity->type());
if (!$entity->supportsRevisions()) {
return;
}
// Query for revisions with the same UUID.
$query = db_select($info['revision table'], 'rev');
$query->addField('rev', $info['entity keys']['revision'], 'revision');
$query->condition($info['entity keys']['revision uuid'], $definition->{$info['entity keys']['revision uuid']});
$query->orderBy($info['entity keys']['revision']);
$results = $query->execute();
if ($results->rowCount() > 1) {
// Grab the first row (oldest) and delete it.
$this->deleteRevision($entity, $results->fetch()->revision);
}
}
public function resolveDependencies($recurse = true, $subset = false, $child = false, $subtype = false)
{
// Check to see if the resolved definition already exists in the cached list.
$cached_resolutions =& drupal_static('publisher_cached_resolutions', array());
$key = $this->base_entity->uuid() . '|' . $this->base_entity->type();
if ($this->base_entity->supportsRevisions()) {
$key .= '|' . $this->base_entity->vuuid();
}
$key .= $recurse ? '|recurse' : '';
if (array_key_exists($key, $cached_resolutions) && $child === false && $subset === false) {
$this->dependencies = array_replace_recursive($this->dependencies, $cached_resolutions[$key]['dependencies']);
$this->relationships = array_merge($this->relationships, $cached_resolutions[$key]['relationships']);
$this->resolved_definition = $cached_resolutions[$key]['resolved_definition'];
return;
}
if (count($cached_resolutions) > 200) {
// For memory consumption purposes.
drupal_static_reset('publisher_cached_resolutions');
}
// Create a clone of the definition so we don't muck up the entity cache.
$this->resolved_definition = $subset !== false ? $subset : clone $this->entity->definition;
if (!is_object($this->resolved_definition)) {
$this->resolved_definition = (object) $this->resolved_definition;
}
// Generate the list of handlers for each of the fields.
$handlers = DefinitionHandlerRegistry::getFieldHandlers($this->entity, $this->resolved_definition, $subtype);
foreach ($handlers as $field_name => $handler) {
if (!isset($this->resolved_definition->{$field_name})) {
continue;
}
foreach ($handler['handlers'] as $single_handler) {
if (!$single_handler instanceof DefinitionHandlerBase) {
continue;
}
try {
$single_handler->dependencies =& $this->dependencies;
$single_handler->entity =& $this->entity;
$single_handler->original_entity = $this->base_entity;
if (property_exists($single_handler, 'relationships')) {
$single_handler->relationships =& $this->relationships;
}
$single_handler->handleField($this->entity->type(), $handler['type'], $field_name, $this->resolved_definition->{$field_name});
} catch (\Exception $ex) {
$message = t('Error processing field "@fieldName" - "@message"', array('@fieldName' => $field_name, '@message' => $ex->getMessage()));
\watchdog('publisher', $message, array(), WATCHDOG_WARNING);
$this->errors[] = $ex;
}
}
}
// Now, recursion.
if ($recurse) {
foreach ($this->dependencies as $identifier => $dependency) {
// If the dependency has already been handled, skip it.
if (array_key_exists($identifier, self::$handled_dependencies)) {
continue;
}
// Add the dependency to the list of handled ones.
self::$handled_dependencies[$identifier] = $dependency;
// Load the entity and get its dependencies.
$entity = Entity::loadByUUID($dependency['uuid'], $dependency['entity_type']);
// If for some reason the entity fails, we need to just skip it.
if (!$entity) {
continue;
}
// Make sure the entity is not the current entity to prevent infinite loop.
if ($entity->uuid() == $this->entity->uuid()) {
continue;
}
$resolver = new self($entity, false, $this->dependencies);
$resolver->relationships =& $this->relationships;
$resolver->metadata =& $this->metadata;
$resolver->resolveDependencies(true, false, true);
$this->dependencies = $resolver->dependencies();
}
}
// Add a dependency for the entity itself if it doesn't already exist.
if (!array_key_exists($this->base_entity->uuid(), $this->dependencies) || $this->base_entity->supportsRevisions() && !empty($this->dependencies[$this->base_entity->uuid()]['original_revision']) && $this->base_entity->revision() > $this->dependencies[$this->base_entity->uuid()]['original_revision']) {
$this->dependencies[$this->base_entity->uuid()] = HandlerBase::createReferenceDefinition($this->base_entity);
}
// Pass the entity through the entity handlers.
if (!array_key_exists($this->base_entity->uuid(), $this->metadata) && $recurse) {
$this->metadata[$this->base_entity->uuid()] = array();
foreach (EntityHandlerRegistry::getEntityHandlers($this->base_entity) as $handler) {
if (!$handler instanceof EntityHandlerBase) {
continue;
}
$handler->entity =& $this->entity;
$handler->original_entity = $this->base_entity;
$handler->dependencies =& $this->dependencies;
$handler->handleEntity($this->metadata[$this->base_entity->uuid()]);
}
}
// Update the cache record.
$cached_resolutions[$key] = array('dependencies' => $this->dependencies, 'relationships' => $this->relationships, 'resolved_definition' => $this->resolved_definition);
if (!$child) {
$dependency_dependencies =& drupal_static('publisher_dependency_dependencies', array());
foreach ($dependency_dependencies as $source => $dependencies) {
if (array_key_exists($source, $this->dependencies)) {
if (!array_key_exists('dependencies', $this->dependencies[$source]) || !is_array($this->dependencies[$source]['dependencies'])) {
$this->dependencies[$source]['dependencies'] = array();
}
$this->dependencies[$source]['dependencies'] = array_replace_recursive($this->dependencies[$source]['dependencies'], $dependencies);
$this->dependencies[$source]['dependencies'] = array_unique($this->dependencies[$source]['dependencies']);
}
}
// Update the relationships.
$this->updateRelationships();
// Loop through all the dependencies and perform cleanup tasks.
foreach ($this->dependencies as $dependency_key => &$dependency) {
// Cleanup the sources.
if (array_key_exists('sources', $dependency) && is_array($dependency['sources'])) {
$dependency['sources'] = array_unique($dependency['sources']);
}
}
// Loop through again for the required stuff.
foreach ($this->dependencies as $dependency_key => &$dependency) {
// Create the 'required' key.
if (array_key_exists('has_relationship', $dependency) && $dependency['has_relationship']) {
$dependency['required'] = false;
continue;
}
$this->dependencies[$dependency_key]['required'] = true;
if (array_key_exists('sources', $this->dependencies[$dependency_key]) && is_array($this->dependencies[$dependency_key]['sources']) && count($this->dependencies[$dependency_key]['sources']) > 0) {
// Mark dependencies as not required only if all of their parent paths
// are marked as having relationships.
$sources = array();
foreach ($this->dependencies[$dependency_key]['sources'] as $source_uuid) {
$sources[] = $this->dependencies[$source_uuid];
}
$paths = $this->getAllParentTrails($sources);
$paths_with_notrequired = 0;
foreach ($paths as $path) {
foreach ($path as $item) {
if (!array_key_exists('required', $this->dependencies[$item]) || !$this->dependencies[$item]['required']) {
$paths_with_notrequired++;
break;
}
}
}
if ($paths_with_notrequired == count($paths)) {
$this->dependencies[$dependency_key]['required'] = false;
}
} else {
// If the dependency doesn't have any sources, it is not
// required.
$this->dependencies[$dependency_key]['required'] = false;
}
}
// Now, loop through the dependencies again and fill in their
// 'required_if' values. If a dependency is marked as not required,
// go through its trails and find the lowest parent that is marked
// as having a relationship and add it to the 'required_if' list
// if it isn't already there.
foreach ($this->dependencies as $dependency_key => &$dependency) {
$dependency['required_if'] = array();
// If the dependency is marked as required already, is a relationship,
// or doesn't have any sources, skip it.
if ($dependency['required']) {
continue;
}
if (!array_key_exists('sources', $dependency) || !is_array($dependency['sources'])) {
continue;
}
// Loop through its parent trails to find the non-required items.
$required_if = array();
$sources = array();
foreach ($dependency['sources'] as $source_uuid) {
// If the source UUID is the owner of the relationship, don't add it.
$skip = false;
foreach ($this->relationships as $relationship) {
if ($relationship['source_uuid'] == $source_uuid && $relationship['destination_uuid'] == $dependency['uuid']) {
$skip = true;
break;
}
}
if ($skip) {
continue;
}
$sources[] = $this->dependencies[$source_uuid];
}
$paths = $this->getAllParentTrails($sources);
foreach ($paths as $path) {
$found = false;
foreach ($path as $index => $item) {
if (array_key_exists('has_relationship', $this->dependencies[$item]) && $this->dependencies[$item]['has_relationship']) {
$found = true;
$required_if[] = array_slice($path, 0, $index + 1);
break;
}
}
if (!$found) {
if (count($path) === 1) {
$required_if[] = $path;
} else {
for ($i = 1; $i < count($path); $i++) {
$required_if[] = array_slice($path, 0, $i);
}
}
}
}
// Add it to the dependency.
$required_if_entities = array();
foreach ($required_if as $path) {
$required_if_entities[] = end($path);
}
$dependency['required_if'] = array_unique($required_if_entities);
}
// Reset the dependency dependencies cache.
drupal_static_reset('publisher_dependency_dependencies');
// Finally, perform the topological sort on the dependencies.
$this->topologicalSortDependencies();
}
}
public function execute(Entity $entity, Remote $remote, array $options, &$context)
{
// Get the transaction from the session.
$transaction_session = TransactionSession::getFromSession();
if (!$transaction_session) {
return;
}
// Prepare the list of entities.
$entities = array();
// Get the dependencies from the entity.
try {
if ($entity->supportsRevisions()) {
$revision = $entity->revision();
$resolver = new RevisionResolver($entity);
} else {
$resolver = new Resolver($entity);
}
$dependencies = $resolver->dependencies();
if (!empty($revision)) {
$entity->setRevision($revision);
}
} catch (ResolverException $ex) {
$message = t('There was an error processing the dependencies for the <strong>:type</strong> <code>:id</code> to the remote. Skipping.', array(':type' => $entity->type(), ':id' => $entity->id()));
drupal_set_message($message, 'error');
watchdog('publisher', $message, array(), WATCHDOG_WARNING);
$this->updateContextMessages($entity, $context);
return;
}
// Optionally mark the item as forced based on the entity type.
$force = array_key_exists('force', $options) ? $options['force'] : false;
drupal_alter('publisher_force_entity', $force, $entity);
// Loop through each of the dependencies and mark them as forced if the options specify.
if ($force) {
foreach ($dependencies as $key => $dependency) {
$dependencies[$key]['force'] = true;
$dependencies[$key]['required'] = true;
}
}
// Mark the root dependency as required if it has a status update.
if (array_key_exists($entity->uuid(), $dependencies)) {
$dependencies[$entity->uuid()]['source_required'] = false;
$status = publisher_entity_tracking_get_status($entity->uuid(), $entity->type(), $remote->name);
if (!$status->date_synced) {
$dependencies[$entity->uuid()]['source_required'] = true;
}
}
// Add the relationships to the transaction session.
if ($resolver->relationships()) {
$relationships = $transaction_session->getRelationships();
foreach ($resolver->relationships() as $relationship) {
$relationships[] = $relationship;
}
$transaction_session->setRelationships($relationships);
}
// Add the metadata to the transaction session.
if ($metadata = $resolver->metadata()) {
$transaction_session->setMetadata($metadata);
}
// Prepare the post data.
$post_data = array('dependencies' => $dependencies);
// Start the transaction.
$transaction = new Transaction($remote);
$response = $transaction->send('begin', $post_data);
if (!$response['success']) {
$message = t('There was an error sending the <strong>:type</strong> <code>:id</code> to the remote. See recent log messages for more details.', array(':type' => $entity->type(), ':id' => $entity->id()));
drupal_set_message($message, 'error');
watchdog('publisher', $message, array(), WATCHDOG_WARNING);
Debug::wd($response);
}
$needs = array();
if (array_key_exists('dependencies', $response)) {
$needs = $response['dependencies'];
}
// Check to see if the receiving server didn't need anything.
if (count($needs) <= 0) {
$message = t('The remote <strong>:remote</strong> already has the latest version of the <strong>:type</strong> <code>:id</code>', array(':remote' => $remote->label, ':type' => $entity->type(), ':id' => $entity->id()));
drupal_set_message($message);
watchdog('publisher', $message);
$this->updateContextMessages($entity, $context);
return;
}
// Make sure each of the needs is valid before adding them to the transaction
// session.
foreach ($needs as $need) {
if (!array_key_exists('uuid', $need) || !array_key_exists('entity_type', $need) || !array_key_exists('need revision', $need) || !array_key_exists('have revision', $need)) {
continue;
}
// Check to see if the entity exists and prepare its payload.
$entity_need = Entity::loadByUUID($need['uuid'], $need['entity_type']);
if (!$entity_need) {
$message = t('One of the entities the destination server needs could not be found. Please check the development log for more details.');
drupal_set_message($message, 'error');
watchdog('publisher', $message, array(), WATCHDOG_WARNING);
Debug::wd($need);
continue;
}
// Generate the payload for the entity.
$entity_need_payload = publisher_compare_revision_uuid($entity_need, $need['have your revision'], $need['need revision']);
if ($entity_need_payload === false) {
$message = t('One or more revisions did not exist for the <strong>:type</strong> <code>:id</code>', array(':type' => $entity_need->type(), ':id' => $entity_need->id()));
drupal_set_message($message, 'error');
watchdog('publisher', $message, array(), WATCHDOG_WARNING);
continue;
}
// Add the entity to the entities list in the transaction session.
$entities[$entity_need->uuid()] = array('entity_type' => $entity_need->type(), 'entity_uuid' => $entity_need->uuid(), 'entity_id' => $entity_need->id(), 'entity_vuuid' => $entity_need->vuuid(), 'have_revision' => $need['have revision'], 'have_your_revision' => $need['have your revision'], 'need_revision' => $need['need revision'], 'required_from_remote' => $need['required_from_remote'], 'original_dependency' => $dependencies[$entity_need->uuid()], 'revisions_payload' => $entity_need_payload);
}
// Add the entities to the transaction session.
$transaction_session->addEntities($entity->uuid(), $entities);
$transaction_session->storeToSession();
// Finally, record the context messages.
$this->updateContextMessages($entity, $context);
}
