pkp/pkp-lib#10571 limit email template access by user groups #10581

taslangraham · 2024-11-05T20:58:30Z

taslangraham · 2024-11-21T17:58:49Z

@ewhanson Just an update - I've made a new commit since I last requested your review.

This handles cases where a template was restored to default settings, and also cleans up template access when a template is deleted

ewhanson · 2024-11-21T19:00:52Z

controllers/grid/users/reviewer/form/AdvancedSearchReviewerForm.php

-            ->getMany()
+            ->getMany();
+
+        $templates = Repo::emailTemplate()


This $templates variable is directly replacing the one above. Is that what you meant to do? If so, the above one should be removed.

ewhanson · 2024-11-21T19:28:04Z

classes/decision/steps/Email.php

                $emailTemplates->add($emailTemplate);
            }
            Repo::emailTemplate()
                ->getCollector($context->getId())
                ->alternateTo([$this->mailable::getEmailTemplateKey()])
                ->getMany()
-                ->each(fn (EmailTemplate $e) => $emailTemplates->add($e));
+                ->each(function (EmailTemplate $e) use ($context, $request, $emailTemplates) {


Just a suggestion, but since this isn't an arrow function anymore, I would be more verbose about the variable name, just to make it easier to read at a glance.

ewhanson · 2024-11-21T19:31:52Z

schemas/emailTemplate.json

+		},
+		"assignableTemplateUserGroups": {
+			"type": "array",
+			"description": "List of User Groups that can be assigned to the template",


Period at the end.

ewhanson · 2024-11-21T19:32:07Z

schemas/emailTemplate.json

+		},
+		"isUnrestricted": {
+			"type": "boolean",
+			"description": "Boolean indicating  if an email template is available to all user groups within the roles associated with the template's mailable.",


Extra space between indicating and if.

ewhanson · 2024-11-21T19:33:07Z

schemas/emailTemplate.json

+						"type": "integer",
+						"apiSummary": true
+					},
+					"name": {


I'm not sure if the individual items support descriptions off the top of my head, but the name being an integer is a little confusing. Assuming this is correct, a description would be helpful to understand what the number is supposed to represent in terms of the name.

That's an error on my part. It should be a string.

ewhanson · 2024-11-21T22:30:23Z

classes/components/forms/emailTemplate/EmailTemplateForm.php

@@ -46,6 +48,14 @@ public function __construct(string $action, array $locales)
                'isMultilingual' => true,
                'toolbar' => 'bold italic superscript subscript | link | blockquote bullist numlist',
                'plugins' => 'paste,link,lists',
+            ]))->addField(new FieldEmailTemplateUnrestricted('isUnrestricted', [


I think a lot more of the setup logic for the Vue components can be done in PHP so that these can both be done with existing FieldOptions components. I mentioned this in the ui-library PR as well and we can chat about it more in our next one-on-one (probably easier to share screen and code together than writing it all out here).

ewhanson · 2024-11-21T22:31:20Z

classes/emailTemplate/DAO.php

     *
     */
    public function installEmailTemplates(
        string $templatesFile,
        array $locales = [],
        ?string $emailKey = null,
-        bool $skipExisting = false
+        bool $skipExisting = false,
+        $recordTemplateGroupAccess = false


I mention this directly below, but I don't think this optional parameter will be necessary. I think the assumption of "unrestricted if no additional data provided" below is enough.

ewhanson · 2024-11-21T22:31:52Z

classes/emailTemplate/EmailTemplateAccessGroup.php

@@ -0,0 +1,34 @@
+<?php


Needs file docblock.

ewhanson · 2024-11-21T22:32:04Z

classes/migration/upgrade/V3_6_0/I10403_EmailTemplateUserGroupAccess.php

@@ -0,0 +1,74 @@
+<?php


Needs file docblock.

ewhanson · 2024-11-21T22:32:32Z

classes/migration/upgrade/V3_6_0/PreflightCheckMigration.php

+/**
+ * @file classes/migration/upgrade/v3_5_0/PreflightCheckMigration.php
+ *
+ * Copyright (c) 2014-2021 Simon Fraser University


Should be 2024 here and below.

…il templates within a mailable

taslangraham force-pushed the i10571_limit_template_access_by_sender_and_receiver_role branch 5 times, most recently from 0352bec to ba47e2b Compare November 14, 2024 19:12

taslangraham force-pushed the i10571_limit_template_access_by_sender_and_receiver_role branch 7 times, most recently from 3cb222d to cf0580b Compare November 20, 2024 15:29

taslangraham changed the title ~~pkp/pkp-lib#10571~~ pkp/pkp-lib#10571 limit email template access by user groups Nov 20, 2024

taslangraham force-pushed the i10571_limit_template_access_by_sender_and_receiver_role branch 2 times, most recently from 8b6f076 to 75b9ed1 Compare November 20, 2024 17:01

taslangraham marked this pull request as ready for review November 20, 2024 18:32

taslangraham force-pushed the i10571_limit_template_access_by_sender_and_receiver_role branch from 75b9ed1 to 405e376 Compare November 20, 2024 18:37

ewhanson requested changes Nov 21, 2024

View reviewed changes

taslangraham force-pushed the i10571_limit_template_access_by_sender_and_receiver_role branch from efecaab to a5f43dc Compare November 25, 2024 22:20

taslangraham added 10 commits November 25, 2024 17:21

pkp#10571 WIP: Add checks to limit email template access by usergroups

45a86ac

pkp#10571 WIP: Allow admins and managers to assign user groups to ema…

f702945

…il templates within a mailable

pkp#10571 WIP: add support for unrestricted templates

ced55fc

pkp#10571 Convert queries to eloquent

13fdaf2

Update migration logic

7ba258c

pkp#10571 Update emailTemplate schema

7b9785c

pkp#10571 Update locales

5411845

Added back accidentally deleted migration and fix errors

0f4d4f5

pkp#10571 Move migration into v3.6 folder

de58aab

pkp#10571 add additional access checks

362d0be

taslangraham added 7 commits November 25, 2024 17:21

pkp#10571 Add migration to install process

c4fe1b7

pkp#10571 Make default templates unrestricted on Context creation

20aaeaa

pkp#10571 Make templates assignable to all user groups

7b1fae9

pkp#10571 Allow restriction to be set during template installation

cf5219a

Code cleanup

2ae5004

pkp#10571 Update access on template deletion and template restore/reset

80068ac

pkp#10571 Remove unnecessary email form components and clean up code

d2e9586

taslangraham force-pushed the i10571_limit_template_access_by_sender_and_receiver_role branch from a5f43dc to d2e9586 Compare November 25, 2024 22:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

pkp/pkp-lib#10571 limit email template access by user groups #10581

pkp/pkp-lib#10571 limit email template access by user groups #10581

taslangraham commented Nov 5, 2024 •

edited

Loading

taslangraham commented Nov 21, 2024

ewhanson Nov 21, 2024

ewhanson Nov 21, 2024

ewhanson Nov 21, 2024

ewhanson Nov 21, 2024

ewhanson Nov 21, 2024

taslangraham Nov 22, 2024

ewhanson Nov 21, 2024

ewhanson Nov 21, 2024

ewhanson Nov 21, 2024

ewhanson Nov 21, 2024

ewhanson Nov 21, 2024

pkp/pkp-lib#10571 limit email template access by user groups #10581

Are you sure you want to change the base?

pkp/pkp-lib#10571 limit email template access by user groups #10581

Conversation

taslangraham commented Nov 5, 2024 • edited Loading

taslangraham commented Nov 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

taslangraham commented Nov 5, 2024 •

edited

Loading