Improve extensibility for external modules

Author: Chris Penny

composer.json

@@ -42,5 +42,12 @@
     }
   },
   "prefer-stable": true,
-  "minimum-stability": "dev"
+  "minimum-stability": "dev",
+  "config": {
+    "allow-plugins": {
+      "composer/installers": true,
+      "silverstripe/vendor-plugin": true,
+      "silverstripe/recipe-plugin": true
+    }
+  }
 }

src/Extension/EmbargoExpiryCMSMainExtension.php

@@ -2,6 +2,7 @@
 
 namespace Terraformers\EmbargoExpiry\Extension;
 
+use Exception;
 use SilverStripe\CMS\Controllers\CMSMain;
 use SilverStripe\Control\HTTPResponse_Exception;
 use SilverStripe\Core\Extension;
@@ -108,8 +109,19 @@ protected function removeEmbargoOrExpiry(string $className, int $id, string $dat
             throw new AccessDeniedException('You do not have permission to remove embargo and expiry dates.');
         }
 
-        // Writing the record with no embargo set will automatically remove the queued jobs.
-        $record->{$dateField} = null;
+        // Clear the appropriate Job and field
+        switch ($dateField) {
+            case 'PublishOnDate':
+                $record->clearPublishJob();
+
+                break;
+            case 'UnPublishOnDate':
+                $record->clearUnPublishJob();
+
+                break;
+            default:
+                throw new Exception('Invalid action submitted');
+        }
 
         $record->write();
     }

src/Extension/EmbargoExpiryExtension.php

@@ -2,6 +2,7 @@
 
 namespace Terraformers\EmbargoExpiry\Extension;
 
+use DateTimeImmutable;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Forms\DatetimeField;
 use SilverStripe\Forms\FieldList;
@@ -22,7 +23,6 @@
 use Symbiote\QueuedJobs\Services\QueuedJobService;
 use Terraformers\EmbargoExpiry\Job\PublishTargetJob;
 use Terraformers\EmbargoExpiry\Job\UnPublishTargetJob;
-use DateTimeImmutable;
 
 /**
  * Class WorkflowEmbargoExpiryExtension
@@ -202,7 +202,16 @@ public function onBeforeWrite(): void
         }
 
         // Jobs can only be queued for records that already exist
-        if (!$this->owner->ID) {
+        if (!$this->owner->isInDB()) {
+            return;
+        }
+
+        // We allow other extensions/modules to prevent Jobs from being queued (only temporarily though, we hope). EG:
+        // The Advanced Workflow module will prevent Jobs being queued during write() operations if a Workflow is set,
+        // and will later allow them during an approval step
+        $extensionResults = $this->owner->invokeWithExtensions('preventEmbargoExpiryQueueJobs');
+
+        if (in_array(true, $extensionResults)) {
             return;
         }
 
@@ -496,6 +505,7 @@ public function objectRequiresPublishJob(): bool
         // You might have some additional requirements for allowing a PublishJob to be created.
         /** @var array|bool[] $canHavePublishJob */
         $canHavePublishJob = $this->owner->invokeWithExtensions('publishJobCanBeQueued');
+
         // One or more extensions said that this Object cannot have a PublishJob.
         if (in_array(false, $canHavePublishJob)) {
             return false;

src/Extension/EmbargoExpiryGridFieldItemRequestExtension.php

@@ -2,6 +2,7 @@
 
 namespace Terraformers\EmbargoExpiry\Extension;
 
+use Exception;
 use SilverStripe\Control\Controller;
 use SilverStripe\Control\HTTPResponse;
 use SilverStripe\Control\HTTPResponse_Exception;
@@ -124,8 +125,19 @@ public function removeEmbargoOrExpiry(string $dateField): void
             throw new AccessDeniedException('You do not have permission to remove embargo and expiry dates.');
         }
 
-        // Writing the record with no embargo set will automatically remove the queued jobs.
-        $record->{$dateField} = null;
+        // Clear the appropriate Job and field
+        switch ($dateField) {
+            case 'PublishOnDate':
+                $record->clearPublishJob();
+
+                break;
+            case 'UnPublishOnDate':
+                $record->clearUnPublishJob();
+
+                break;
+            default:
+                throw new Exception('Invalid action submitted');
+        }
 
         $record->write();
     }