ENH Add campaign-admin support back in

silverstripe · Mar 6, 2025 · c066f14 · c066f14
1 parent a2c83d2
commit c066f14
Show file tree

Hide file tree

Showing 10 changed files with 119 additions and 16 deletions.
diff --git a/client/dist/js/TinyMCE_sslink-file.js b/client/dist/js/TinyMCE_sslink-file.js
diff --git a/client/dist/js/TinyMCE_ssmedia.js b/client/dist/js/TinyMCE_ssmedia.js
diff --git a/client/dist/js/bundle.js b/client/dist/js/bundle.js
diff --git a/client/src/containers/AssetAdmin/AssetAdmin.js b/client/src/containers/AssetAdmin/AssetAdmin.js
@@ -742,6 +742,7 @@ class AssetAdmin extends Component {
       onClose: this.handleCloseFile,
       onSubmit: this.handleSubmitEditor,
       onUnpublish: this.handleUnpublish,
+      addToCampaignSchemaUrl: config.form.addToCampaignForm.schemaUrl
     };
 
     return <EditorComponent {...editorProps} />;

diff --git a/client/src/containers/AssetAdmin/tests/AssetAdmin-test.js b/client/src/containers/AssetAdmin/tests/AssetAdmin-test.js
@@ -142,6 +142,9 @@ function makeProps(obj = {}) {
         fileSearchForm: {
           schemaUrl: '',
         },
+        addToCampaignForm: {
+          schemaUrl: '',
+        },
       },
     },
     fileId: null,

diff --git a/client/src/containers/Editor/Editor.js b/client/src/containers/Editor/Editor.js
@@ -5,6 +5,7 @@ import { bindActionCreators, compose } from 'redux';
 import React, { Component } from 'react';
 import CONSTANTS from 'constants/index';
 import FormBuilderLoader from 'containers/FormBuilderLoader/FormBuilderLoader';
+import FormBuilderModal from 'components/FormBuilderModal/FormBuilderModal';
 import * as UnsavedFormsActions from 'state/unsavedForms/UnsavedFormsActions';
 import PropTypes from 'prop-types';
 import { inject } from 'lib/Injector';
@@ -31,10 +32,13 @@ class Editor extends Component {
     this.handleLoadingSuccess = this.handleLoadingSuccess.bind(this);
     this.handleLoadingError = this.handleLoadingError.bind(this);
     this.handleFetchingSchema = this.handleFetchingSchema.bind(this);
+    this.closeModal = this.closeModal.bind(this);
+    this.openModal = this.openModal.bind(this);
     this.createFn = this.createFn.bind(this);
     this.editorHeader = this.editorHeader.bind(this);
 
     this.state = {
+      openModal: false,
       loadingForm: false,
       loadingError: null,
       file: null,
@@ -87,6 +91,12 @@ class Editor extends Component {
   handleAction(event) {
     const file = this.state.file;
     switch (event.currentTarget.name) {
+      // intercept the Add to Campaign submit and open the modal dialog instead
+      case 'action_addtocampaign':
+        this.openModal();
+        event.preventDefault();
+
+        break;
       case 'action_replacefile':
         this.replaceFile();
         event.preventDefault();
@@ -152,13 +162,22 @@ class Editor extends Component {
     } else {
       // If we're already at the top of the form stack, close the editor form
       onClose();
+      this.closeModal();
     }
 
     if (event) {
       event.preventDefault();
     }
   }
 
+  openModal() {
+    this.setState({ openModal: true });
+  }
+
+  closeModal() {
+    this.setState({ openModal: false });
+  }
+
   replaceFile() {
     const hiddenFileInput = document.querySelector('.dz-input-PreviewImage');
 
@@ -270,8 +289,9 @@ class Editor extends Component {
     if (!this.state.file) {
       return null;
     }
-    const { FormBuilderLoaderComponent } = this.props;
+    const { FormBuilderLoaderComponent, FormBuilderModalComponent } = this.props;
     const formSchemaUrl = this.getFormSchemaUrl();
+    const modalSchemaUrl = `${this.props.addToCampaignSchemaUrl}/${this.props.fileId}`;
     const editorClasses = classnames(
       'panel', 'form--no-dividers', 'editor', {
         'editor--asset-dropzone--disable': !this.props.enableDropzone
@@ -291,6 +311,7 @@ class Editor extends Component {
         <div className="editor__file-preview-message--file-missing">{message}</div>
       );
     }
+    const campaignTitle = i18n._t('Admin.ADD_TO_CAMPAIGN', 'Add to campaign');
     const Loading = this.props.loadingComponent;
 
     return (<div className={editorClasses}>
@@ -307,6 +328,16 @@ class Editor extends Component {
           file={this.state.file}
         />
         {error}
+        <FormBuilderModalComponent
+          title={campaignTitle}
+          identifier="AssetAdmin.AddToCampaign"
+          isOpen={this.state.openModal}
+          onClosed={this.closeModal}
+          schemaUrl={modalSchemaUrl}
+          bodyClassName="modal__dialog"
+          responseClassBad="modal__response modal__response--error"
+          responseClassGood="modal__response modal__response--good"
+        />
         { this.state.loadingForm && <Loading />}
       </div>
     </div>);
@@ -325,16 +356,19 @@ Editor.propTypes = {
     name: PropTypes.string,
     value: PropTypes.any,
   })),
+  addToCampaignSchemaUrl: PropTypes.string,
   actions: PropTypes.object,
   showingSubForm: PropTypes.bool,
   nextType: PropTypes.string,
   EditorHeaderComponent: PropTypes.oneOfType([PropTypes.object, PropTypes.func]),
   FormBuilderLoaderComponent: PropTypes.oneOfType([PropTypes.object, PropTypes.func]),
+  FormBuilderModalComponent: PropTypes.oneOfType([PropTypes.object, PropTypes.func]),
 };
 
 Editor.defaultProps = {
   EditorHeaderComponent: EditorHeader,
   FormBuilderLoaderComponent: FormBuilderLoader,
+  FormBuilderModalComponent: FormBuilderModal,
 };
 
 function mapDispatchToProps(dispatch) {

diff --git a/client/src/containers/Editor/tests/Editor-test.js b/client/src/containers/Editor/tests/Editor-test.js
@@ -78,12 +78,20 @@ function makeProps(obj = {}) {
     FormBuilderLoaderComponent: ({ createFn, onAction, schemaUrl }) => (
       <div data-testid="test-form-builder-loader" onClick={() => onAction(...nextParams)} data-schema-url={schemaUrl}>{createFn(...createFnParams)}</div>
     ),
+    FormBuilderModalComponent: ({ isOpen }) => <div data-testid="test-form-builder-modal" data-is-open={isOpen}/>,
     ...obj
   };
 }
 
-async function awaitLoader() {
-  await screen.findByTestId('test-form-builder-loader');
+async function openModal() {
+  const loader = await screen.findByTestId('test-form-builder-loader');
+  nextParams = [{
+    preventDefault: () => null,
+    currentTarget: {
+      name: 'action_addtocampaign'
+    }
+  }];
+  fireEvent.click(loader);
   nextParams = [{
     preventDefault: () => null,
     currentTarget: {
@@ -109,12 +117,16 @@ test('Editor handleClose Closing editor', async () => {
     />
   );
   resolveBackendGet(makeReadFileResponse());
-  awaitLoader();
+  openModal();
+  let modal = await screen.findByTestId('test-form-builder-modal');
+  expect(modal.getAttribute('data-is-open')).toBe('true');
   const header = await screen.findByTestId('test-editor-header');
   nextAction = 'cancel';
   fireEvent.click(header);
   expect(popFormStackEntry).not.toHaveBeenCalled();
   expect(onClose).toHaveBeenCalled();
+  modal = await screen.findByTestId('test-form-builder-modal');
+  expect(modal.getAttribute('data-is-open')).toBe('false');
   expect(header.getAttribute('data-show-button')).toBe(buttonStates.SWITCH);
 });
 
@@ -135,12 +147,16 @@ test('Editor handleClose Closing sub form', async () => {
     />
   );
   resolveBackendGet(makeReadFileResponse());
-  awaitLoader();
+  openModal();
+  let modal = await screen.findByTestId('test-form-builder-modal');
+  expect(modal.getAttribute('data-is-open')).toBe('true');
   const header = await screen.findByTestId('test-editor-header');
   nextAction = 'cancel';
   fireEvent.click(header);
   expect(popFormStackEntry).toHaveBeenCalled();
   expect(onClose).not.toHaveBeenCalled();
+  modal = await screen.findByTestId('test-form-builder-modal');
+  expect(modal.getAttribute('data-is-open')).toBe('true');
   expect(header.getAttribute('data-show-button')).toBe(buttonStates.SWITCH);
 });
 
@@ -173,7 +189,7 @@ test('Editor editorHeader Top Form with detail in dialog', async () => {
     />
   );
   resolveBackendGet(makeReadFileResponse());
-  awaitLoader();
+  openModal();
   const header = await screen.findByTestId('test-editor-header');
   nextAction = 'details';
   fireEvent.click(header);
@@ -192,7 +208,7 @@ test('Editor editorHeader Sub form in dialog', async () => {
     />
   );
   resolveBackendGet(makeReadFileResponse());
-  awaitLoader();
+  openModal();
   const header = await screen.findByTestId('test-editor-header');
   expect(header.getAttribute('data-show-button')).toBe(buttonStates.ALWAYS_BACK);
 });
@@ -212,7 +228,7 @@ test('Editor editorHeader Form for folder', async () => {
       type: 'folder',
     })
   });
-  awaitLoader();
+  openModal();
   const header = await screen.findByTestId('test-editor-header');
   expect(header.getAttribute('data-show-button')).toBe(buttonStates.SWITCH);
 });
@@ -226,7 +242,7 @@ test('Editor getFormSchemaUrl Plain URL', async () => {
     />
   );
   resolveBackendGet(makeReadFileResponse());
-  awaitLoader();
+  openModal();
   const loader = await screen.findByTestId('test-form-builder-loader');
   expect(loader.getAttribute('data-schema-url')).toBe('edit/file/123');
 });
@@ -240,7 +256,7 @@ test('Editor getFormSchemaUrl Plain URL', async () => {
     />
   );
   resolveBackendGet(makeReadFileResponse());
-  awaitLoader();
+  openModal();
   const loader = await screen.findByTestId('test-form-builder-loader');
   expect(loader.getAttribute('data-schema-url')).toBe('edit/file/123?q=search');
 });
@@ -257,7 +273,7 @@ test('Editor getFormSchemaUrl Plain URL', async () => {
     />
   );
   resolveBackendGet(makeReadFileResponse());
-  awaitLoader();
+  openModal();
   const loader = await screen.findByTestId('test-form-builder-loader');
   expect(loader.getAttribute('data-schema-url')).toBe('edit/file/123?q=search&foo=bar');
 });
diff --git a/code/Controller/AssetAdmin.php b/code/Controller/AssetAdmin.php
@@ -3,6 +3,7 @@
 namespace SilverStripe\AssetAdmin\Controller;
 
 use Exception;
+use RuntimeException;
 use InvalidArgumentException;
 use SilverStripe\Admin\CMSBatchActionHandler;
 use SilverStripe\Admin\LeftAndMain;
@@ -24,6 +25,7 @@
 use SilverStripe\Assets\Image;
 use SilverStripe\Assets\Storage\AssetNameGenerator;
 use SilverStripe\Assets\Upload;
+use SilverStripe\CampaignAdmin\AddToCampaignHandler;
 use SilverStripe\Control\Controller;
 use SilverStripe\Control\HTTPRequest;
 use SilverStripe\Control\HTTPResponse;

diff --git a/tests/php/Forms/FileFormBuilderTest.php b/tests/php/Forms/FileFormBuilderTest.php
@@ -14,6 +14,7 @@
 use SilverStripe\Core\Config\Config;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\Forms\LiteralField;
+use SilverStripe\CampaignAdmin\Extensions\FileFormFactoryExtension;
 
 class FileFormBuilderTest extends SapphireTest
 {
@@ -51,6 +52,9 @@ protected function tearDown(): void
 
     public function testEditFileForm()
     {
+        // Ensure campaign-admin extension is not applied!
+        Config::modify()->remove(FileFormFactory::class, 'extensions');
+
         $this->logInWithPermission('ADMIN');
 
         $file = $this->objFromFixture(File::class, 'file1');
@@ -91,14 +95,37 @@ public function testEditFileForm()
         $this->assertNotNull($form->Actions()->fieldByName('PopoverActions.action_replacefile'));
         $this->assertNotNull($form->Actions()->fieldByName('PopoverActions.action_delete'));
         $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_unpublish'));
+
+        if (class_exists(FileFormFactoryExtension::class)) {
+            // Add to campaign should not be there by default
+            $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_addtocampaign'));
+
+            // Add extension for campaign-admin
+            Config::modify()->merge(
+                FileFormFactory::class,
+                'extensions',
+                [FileFormFactoryExtension::class]
+            );
+
+            $builder = new FileFormFactory();
+            $form = $builder->getForm($controller, 'EditForm', ['Record' => $file, 'RequireLinkText' => false]);
+
+            // Add to campaign should now be available
+            $this->assertNotNull($form->Actions()->fieldByName('PopoverActions.action_addtocampaign'));
+        }
     }
 
     public function testEditFileFormWithPermissions()
     {
         // Add extension to simulate different permissions
         File::add_extension(FileExtension::class);
 
-        $this->logInWithPermission('CMS_ACCESS_AssetAdmin');
+        if (class_exists(FileFormFactoryExtension::class)) {
+            FileFormFactory::add_extension(FileFormFactoryExtension::class);
+            $this->logInWithPermission('CMS_ACCESS_CampaignAdmin');
+        } else {
+            $this->logInWithPermission('CMS_ACCESS_AssetAdmin');
+        }
 
         /** @var File $file */
         $file = $this->objFromFixture(File::class, 'file1');
@@ -112,7 +139,9 @@ public function testEditFileFormWithPermissions()
         $this->assertNull($form->Actions()->fieldByName('PopoverActions'));
         $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_delete'));
         $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_replacefile'));
-
+        if (class_exists(FileFormFactoryExtension::class)) {
+            $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_addtocampaign'));
+        }
         $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_unpublish'));
 
         FileExtension::$canDelete = false;
@@ -121,6 +150,9 @@ public function testEditFileFormWithPermissions()
         $form = $builder->getForm($controller, 'EditForm', ['Record' => $file, 'RequireLinkText' => false]);
         $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_delete'));
         $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_replacefile'));
+        if (class_exists(FileFormFactoryExtension::class)) {
+            $this->assertNotNull($form->Actions()->fieldByName('PopoverActions.action_addtocampaign'));
+        }
         $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_unpublish'));
 
         FileExtension::$canDelete = true;
@@ -129,6 +161,9 @@ public function testEditFileFormWithPermissions()
         $form = $builder->getForm($controller, 'EditForm', ['Record' => $file]);
         $this->assertNotNull($form->Actions()->fieldByName('PopoverActions.action_delete'));
         $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_replacefile'));
+        if (class_exists(FileFormFactoryExtension::class)) {
+            $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_addtocampaign'));
+        }
         $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_unpublish'));
 
         FileExtension::$canDelete = false;
@@ -137,6 +172,9 @@ public function testEditFileFormWithPermissions()
         $form = $builder->getForm($controller, 'EditForm', ['Record' => $file]);
         $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_delete'));
         $this->assertNotNull($form->Actions()->fieldByName('PopoverActions.action_replacefile'));
+        if (class_exists(FileFormFactoryExtension::class)) {
+            $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_addtocampaign'));
+        }
         $this->assertNull($form->Actions()->fieldByName('PopoverActions.action_unpublish'));
 
         FileExtension::$canDelete = true;
@@ -147,8 +185,14 @@ public function testEditFileFormWithPermissions()
         $form = $builder->getForm($controller, 'EditForm', ['Record' => $file, 'RequireLinkText' => false]);
         $this->assertNotNull($form->Actions()->fieldByName('PopoverActions.action_delete'));
         $this->assertNotNull($form->Actions()->fieldByName('PopoverActions.action_replacefile'));
+        if (class_exists(FileFormFactoryExtension::class)) {
+            $this->assertNotNull($form->Actions()->fieldByName('PopoverActions.action_addtocampaign'));
+        }
         $this->assertNotNull($form->Actions()->fieldByName('PopoverActions.action_unpublish'));
 
+        if (class_exists(FileFormFactoryExtension::class)) {
+            FileFormFactory::remove_extension(FileFormFactoryExtension::class);
+        }
         File::remove_extension(FileExtension::class);
     }
 

diff --git a/tests/php/Forms/FolderCreateFormFactoryTest.php b/tests/php/Forms/FolderCreateFormFactoryTest.php
@@ -13,6 +13,9 @@ class FolderCreateFormFactoryTest extends SapphireTest
 {
     public function testEditFileForm()
     {
+        // Ensure campaign-admin extension is not applied!
+        Config::modify()->remove(FileFormFactory::class, 'extensions');
+
         $this->logInWithPermission('ADMIN');
 
         $controller = new AssetAdmin();