Commit 2bb5e797 authored by Jonathan Smith's avatar Jonathan Smith
Browse files

Issue #3273938 by jonathan1055: Maintain backwards compatibility with 8.x-1.x... 

Issue #3273938 by jonathan1055: Maintain backwards compatibility with 8.x-1.x action hooks and improve hook log messages
parent 0472da9e

src/SchedulerManager.php

+34 −14
Changes for src/SchedulerManager.php: 34 added lines, 14 removed lines.
Original line number Diff line number Diff line
@@ -342,13 +342,22 @@ class SchedulerManager { 
          // hook_scheduler_{type}_publish_process() to allow other modules to

          // do the "publishing" process instead of Scheduler.

          $hook_implementations = $this->getHookImplementations('publish_process', $entity);

          $processed = FALSE;

          $failed = FALSE;

          $sucessful_hooks = [];

          $failed_hooks = [];

          foreach ($hook_implementations as $function) {

            $return = $function($entity);

            $processed = $processed || ($return === 1);

            $failed = $failed || ($return === -1);

            if ($return === 1) {

              $sucessful_hooks[] = $function;

              if (stristr($function, '_action')) {

                // If this is a legacy action hook, for safety call ->save() as

                // this used to be done here in Scheduler 8.x-1.x.

                $entity->save();

              }

            }

            $return === -1 ? $failed_hooks[] = $function : NULL;

          }

          $processed = count($sucessful_hooks) > 0;

          $failed = count($failed_hooks) > 0;



          // Create a set of variables for use in the log message.

          $bundle_type = $entity->getEntityType()->getBundleEntityType();
@@ -362,14 +371,15 @@ class SchedulerManager { 
          $logger_variables = [

            '@type' => $entity_type->label(),

            '%title' => $entity->label(),

            '@hook' => implode(', ', $hook_implementations),

            '@sucessful_hooks' => implode(', ', $sucessful_hooks),

            '@failed_hooks' => implode(', ', $failed_hooks),

            'link' => $view_link->toString() . ' ' . $entity_type_link->toString(),

          ];



          if ($failed) {

            // At least one hook function returned a failure or exception, so

            // stop processing this entity and move on to the next one.

            $this->logger->warning('Publishing failed for %title. Calls to @hook returned a failure code.', $logger_variables);

            $this->logger->warning('Publishing failed for %title. @failed_hooks returned a failure code.', $logger_variables);

            // Restore the publish_on date to allow another attempt next time.

            $entity->publish_on->value = $publish_on;

            $entity->save();
@@ -378,7 +388,7 @@ class SchedulerManager { 
          elseif ($processed) {

            // The entity was 'published' by a module implementing the hook, so

            // we only need to log this result.

            $this->logger->notice('@type: scheduled processing of %title completed by calls to @hook.', $logger_variables);

            $this->logger->notice('@type: scheduled "publish" processing of %title completed by @sucessful_hooks.', $logger_variables);

          }

          else {

            // None of the above hook calls processed the entity and there were
@@ -535,13 +545,22 @@ class SchedulerManager { 
          // and hook_scheduler_{type}_unpublish_process() to allow other

          // modules to do the "unpublishing" process instead of Scheduler.

          $hook_implementations = $this->getHookImplementations('unpublish_process', $entity);

          $processed = FALSE;

          $failed = FALSE;

          $sucessful_hooks = [];

          $failed_hooks = [];

          foreach ($hook_implementations as $function) {

            $return = $function($entity);

            $processed = $processed || ($return === 1);

            $failed = $failed || ($return === -1);

            if ($return === 1) {

              $sucessful_hooks[] = $function;

              if (stristr($function, '_action')) {

                // If this is a legacy action hook, for safety call ->save() as

                // this used to be done here in Scheduler 8.x-1.x.

                $entity->save();

              }

            }

            $return === -1 ? $failed_hooks[] = $function : NULL;

          }

          $processed = count($sucessful_hooks) > 0;

          $failed = count($failed_hooks) > 0;



          // Create a set of variables for use in the log message.

          $bundle_type = $entity->getEntityType()->getBundleEntityType();
@@ -555,14 +574,15 @@ class SchedulerManager { 
          $logger_variables = [

            '@type' => $entity_type->label(),

            '%title' => $entity->label(),

            '@hook' => implode(', ', $hook_implementations),

            '@sucessful_hooks' => implode(', ', $sucessful_hooks),

            '@failed_hooks' => implode(', ', $failed_hooks),

            'link' => $view_link->toString() . ' ' . $entity_type_link->toString(),

          ];



          if ($failed) {

            // At least one hook function returned a failure or exception, so

            // stop processing this entity and move on to the next one.

            $this->logger->warning('Unpublishing failed for %title. Calls to @hook returned a failure code.', $logger_variables);

            $this->logger->warning('Unpublishing failed for %title. @failed_hooks returned a failure code.', $logger_variables);

            // Restore the unpublish_on date to allow another attempt next time.

            $entity->unpublish_on->value = $unpublish_on;

            $entity->save();
@@ -571,7 +591,7 @@ class SchedulerManager { 
          elseif ($processed) {

            // The entity was 'unpublished' by a module implementing the hook,

            // so we only need to log this result.

            $this->logger->notice('@type: scheduled processing of %title completed by calls to @hook.', $logger_variables);

            $this->logger->notice('@type: scheduled "unpublish" processing of %title completed by @sucessful_hooks.', $logger_variables);

          }

          else {

            // None of the above hook calls processed the entity and there were

tests/modules/scheduler_api_test/scheduler_api_legacy_test/scheduler_api_legacy_test.module

+2 −2
Changes for tests/modules/scheduler_api_test/scheduler_api_legacy_test/scheduler_api_legacy_test.module: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -165,7 +165,7 @@ function scheduler_api_legacy_test_scheduler_publish_action($node) { 
    // Nodes with yellow in the title are simulated to be processed by this

    // hook, and will not be published by Scheduler.

    $node->set('title', $node->title->value . ' - publishing processed by API test module');

    $node->setPublished()->save();

    $node->setPublished();

    \Drupal::messenger()->addMessage(t('Scheduler_Api_Test: Yellow nodes should not have publishing processed by Scheduler.'), 'status', FALSE);

    return 1;

  }
@@ -187,7 +187,7 @@ function scheduler_api_legacy_test_scheduler_unpublish_action($node) { 
    // Nodes with orange in the title are simulated to be processed by this

    // hook, and will not be published by Scheduler.

    $node->set('title', $node->title->value . ' - unpublishing processed by API test module');

    $node->setUnpublished()->save();

    $node->setUnpublished();

    \Drupal::messenger()->addMessage(t('Scheduler_Api_Test: Orange nodes should not have unpublishing processed by Scheduler.'), 'status', FALSE);

    return 1;

  }