Merge branch 'craft-4' of https://github.com/verbb/workflow into craft-5

# Conflicts:
#	src/controllers/BaseController.php
#	src/models/Settings.php
#	src/services/Emails.php

Author: engram-design

Diff for: docs/get-started/configuration.md

@@ -23,7 +23,7 @@ return [
         'reviewerApprovalNotifications' => false,
         'publisherNotifications' => true,
         'publishedAuthorNotifications' => false,
-        'selectedPublishers' => '*',
+        'publisherNotificationsUserGroup' => null,
 
         // Permissions
         'enabledSections' => '*',
@@ -48,7 +48,7 @@ Notifications
 - `reviewerApprovalNotifications` - Whether email notifications should be delivered to editors when each reviewer approves an entry after review.
 - `publisherNotifications` - Whether email notifications should be delivered to publishers when editors submit an entry for review.
 - `publishedAuthorNotifications` - Whether email notifications should be delivered to the entry author when approved and published by a Publisher.
-- `selectedPublishers` - An array of user IDs of publishers to receive email notifications. Use '\*' for all.
+- `publisherNotificationsUserGroup` - The user group UID to have email notifications for publishers sent to. By default, all users in the `publisherUserGroup` will receive email notifications.
 
 Permissions
 - `enabledSections` - An array of section UIDs to enable submissions on. Use '\*' for all.

Diff for: src/Workflow.php

@@ -213,6 +213,11 @@ private function _registerEventHandlers(): void
         // Use `Entry::EVENT_BEFORE_SAVE` in order to add validation errors. `Elements::EVENT_BEFORE_SAVE_ELEMENT` doesn't work
         Event::on(Entry::class, Entry::EVENT_BEFORE_SAVE, [$this->getService(), 'onBeforeSaveEntry']);
 
+        // When a publisher applies a draft instead of using the Workflow action, approve any pending submissions
+        // Note the use of "beforeApply" due to when applying a draft of an existing entry, the draft will already be
+        // deleted by the time we reach "afterApply" and the FK constraint updated on the review, so a submission can't be found.
+        Event::on(Drafts::class, Drafts::EVENT_BEFORE_APPLY_DRAFT, [$this->getService(), 'onBeforeApplyDraft']);
+
         // Use `Elements::EVENT_AFTER_SAVE_ELEMENT` so that the element is fully finished with propagating, etc.
         Event::on(Elements::class, Elements::EVENT_AFTER_SAVE_ELEMENT, [$this->getService(), 'onAfterSaveElement']);
 

Diff for: src/controllers/BaseController.php

@@ -22,25 +22,19 @@ public function actionSettings(): Response
     {
         $settings = Workflow::$plugin->getSettings();
 
-        $publishers = [];
+        $userGroups = [
+            ['label' => Craft::t('workflow', 'All Publishers'), 'value' => ''],
+        ];
 
-        if ($settings->publisherUserGroup) {
-            $publisherUserGroup = $settings->publisherUserGroup;
-
-            foreach ($publisherUserGroup as $siteUid => $publisherUserGroupUid) {
-                $publisherUserGroupId = Db::idByUid(Table::USERGROUPS, $publisherUserGroupUid);
-
-                foreach (User::find()->groupId($publisherUserGroupId)->all() as $user) {
-                    $publishers[] = ['value' => $user->id, 'label' => (string)$user];
-                }
-            }
+        foreach (Craft::$app->getUserGroups()->getAllGroups() as $userGroup) {
+            $userGroups[] = ['label' => $userGroup->name, 'value' => $userGroup->uid];
         }
 
-        $publishers = array_unique($publishers, SORT_REGULAR);
+        $userGroups = array_unique($userGroups, SORT_REGULAR);
 
         return $this->renderTemplate('workflow/settings', [
             'settings' => $settings,
-            'publishers' => $publishers,
+            'userGroups' => $userGroups,
         ]);
     }
 

Diff for: src/elements/Submission.php

@@ -109,9 +109,8 @@ protected static function defineDefaultTableAttributes(string $source): array
     protected static function defineSortOptions(): array
     {
         return [
+            'id' => Craft::t('workflow', 'Submission'),
             'ownerId' => Craft::t('workflow', 'Entry'),
-            'editorId' => Craft::t('workflow', 'Editor'),
-            'publisherId' => Craft::t('workflow', 'Publisher'),
             'lastReviewDate' => Craft::t('workflow', 'Last Reviewed'),
             'dateCreated' => Craft::t('workflow', 'Date Submitted'),
         ];
@@ -399,6 +398,13 @@ public function canUserReview(User $user, $site): bool
         return $canReview;
     }
 
+    public function canUserPublish(User $user, $site): bool
+    {
+        $settings = Workflow::$plugin->getSettings();
+
+        return $user->isInGroup($settings->getPublisherUserGroup($site));
+    }
+
     public function afterSave(bool $isNew): void
     {
         if (!$isNew) {

Diff for: src/models/Settings.php

@@ -3,6 +3,7 @@
 
 use Craft;
 use craft\base\Model;
+use craft\elements\User;
 use craft\helpers\ArrayHelper;
 
 class Settings extends Model
@@ -26,11 +27,14 @@ class Settings extends Model
     public bool $reviewerApprovalNotifications = false;
     public bool $publisherNotifications = true;
     public bool $publishedAuthorNotifications = false;
-    public mixed $selectedPublishers = '*';
+    public ?string $publisherNotificationsUserGroup = null;
 
     // Permissions
     public mixed $enabledSections = '*';
 
+    // Deprecated
+    public mixed $selectedPublishers = '*';
+
 
     // Public Methods
     // =========================================================================
@@ -115,4 +119,16 @@ public function getPublisherNotesRequired($site)
     {
         return $this->publisherNotesRequired[$site->uid] ?? false;
     }
+
+    public function getPublishersForNotificationEmail($site): array
+    {
+        // Get the user group for email notifications
+        $publisherGroup = $this->publisherNotificationsUserGroup ?? $this->getPublisherUserGroup($site);
+
+        if (!$publisherGroup) {
+            return [];
+        }
+
+        return User::find()->groupId($publisherGroup->id)->all();
+    }
 }

Diff for: src/services/Emails.php

@@ -117,20 +117,7 @@ public function sendPublisherNotificationEmail(Submission $submission, Review $r
 
         $settings = Workflow::$plugin->getSettings();
 
-        $publisherGroup = $settings->getPublisherUserGroup($entry->site);
-
-        if (!$publisherGroup) {
-            Workflow::info('No publisher group found to send notifications to.');
-        }
-
-        $query = User::find()->groupId($publisherGroup->id);
-
-        // Check settings to see if we should email all publishers or not
-        if (isset($settings->selectedPublishers) && $settings->selectedPublishers != '*') {
-            $query->id($settings->selectedPublishers);
-        }
-
-        $publishers = $query->all();
+        $publishers = $settings->getPublishersForNotificationEmail($entry->site);
 
         // Fire a 'preparePublisherEmail' event
         $event = new PrepareEmailEvent([

Diff for: src/services/Service.php

@@ -211,6 +211,39 @@ public function onAfterSaveElement(ElementEvent $event): void
         }
     }
 
+    public function onBeforeApplyDraft(DraftEvent $event): void
+    {
+        if (!($event->draft instanceof Entry)) {
+            return;
+        }
+
+        // Because we're using "beforeApply" for complicated reasons, we should at least check if things validate first
+        $event->draft->setScenario(Element::SCENARIO_LIVE);
+        
+        if (!$event->draft->validate()) {
+            return;
+        }
+
+        // Check if a publisher has applied the draft by mistake, and there's a pending submission. Just mark as done.
+        $submission = Submission::find()
+            ->ownerId($event->draft->getCanonicalId())
+            ->ownerSiteId($event->draft->siteId)
+            ->ownerDraftId($event->draft->draftId)
+            ->limit(1)
+            ->isComplete(false)
+            ->isPending(true)
+            ->one();
+
+        if ($submission) {
+            $currentUser = Craft::$app->getUser()->getIdentity();
+
+            // Ensure current user is allowed to publish the submission
+            if ($submission->canUserPublish($currentUser, $event->draft->site)) {
+                Workflow::$plugin->getSubmissions()->approveSubmission($event->draft);
+            }
+        }
+    }
+
     public function renderEntrySidebar(DefineHtmlEvent $event): void
     {
         $entry = $event->sender;

Diff for: src/services/Submissions.php

@@ -436,7 +436,7 @@ private function _setReviewFromPost(Submission $submission, ElementInterface $en
 
         $review = new Review();
         $review->submissionId = $submission->id;
-        $review->elementId = $entry->id;
+        $review->elementId = $entry->getCanonicalId();
         $review->elementSiteId = $entry->siteId;
         $review->draftId = $entry->draftId;
         $review->userId = $currentUser->id;

Diff for: src/templates/settings/_panes/notifications.html

@@ -56,34 +56,15 @@
     warning: macros.configWarning('publisherNotifications', 'workflow'),
 }) }}
 
-{% if settings.publisherUserGroup %}
-    {{ forms.checkboxSelectField({
-        label: 'Publishers To Receive Notifications' | t('workflow'),
-        instructions: 'Select all, or specific publishers to receive email notifications. By default, all will be notified.' | t('workflow'),
-        id: 'selectedPublishers',
-        name: 'selectedPublishers',
-        values: settings.selectedPublishers,
-        options: publishers,
-        showAllOption: true,
-        warning: macros.configWarning('selectedPublishers', 'workflow'),
-    }) }}
-{% else %}
-    <div class="field">
-        <div class="heading">
-            <label>
-                {{ "Publishers To Receive Notifications" | t('workflow') }}
-            </label>
-
-            <div class="instructions">
-                <p>{{ "Select all, or specific publishers to receive email notifications. By default, all will be notified." | t('workflow') }}</p>
-            </div>
-        </div>
-
-        <p class="small warning">
-            {{ "Select a Publisher User Group first." | t('workflow') }}
-        </p>
-    </div>
-{% endif %}
+{{ forms.selectField({
+    label: 'Publisher Notifications User Group' | t('workflow'),
+    instructions: 'By default, all users in the "Publisher User Group" will receive email notifications. Set a specific group to receive email notifications.' | t('workflow'),
+    id: 'publisherNotificationsUserGroup',
+    name: 'publisherNotificationsUserGroup',
+    value: settings.publisherNotificationsUserGroup,
+    options: userGroups,
+    warning: macros.configWarning('publisherNotificationsUserGroup', 'workflow'),
+}) }}
 
 {{ forms.lightswitchField({
     label: 'Published Author Notifications' | t('workflow'),