API Provide a way to register link forms dynamically for ModalControl…

…ler (#1860)

client/src/containers/InsertLinkModal/InsertLinkModal.js

@@ -93,7 +93,7 @@ const createInsertLinkModal = (sectionConfigKey, formName) => {
 
     // get the schemaUrl to use as a key for overrides
     const schemaUrl = `${sectionConfig.form[formName].schemaUrl}${requireTextFieldUrl}`
-      .replace(/:pageid/, ownProps.currentPageID);
+      .replace(/:pageid/, ownProps.currentPageID || 0);
 
     return {
       sectionConfig,

code/FormSchemaController.php

@@ -67,7 +67,7 @@ public function setFormSchema(FormSchema $schema): static
     }
 
     /**
-     * Gets a JSON schema representing the current edit form.
+     * Gets a JSON schema representing a form.
      */
     public function schema(HTTPRequest $request): HTTPResponse
     {
@@ -103,16 +103,6 @@ public function schema(HTTPRequest $request): HTTPResponse
         return $this->getSchemaResponse($schemaID, $form);
     }
 
-    /**
-     * Check if the current request has a X-Formschema-Request header set.
-     * Used by conditional logic that responds to validation results
-     */
-    protected function getSchemaRequested(): bool
-    {
-        $parts = $this->getRequest()->getHeader(static::SCHEMA_HEADER);
-        return !empty($parts);
-    }
-
     /**
      * Generate schema for the given form based on the X-Formschema-Request header value
      *
@@ -121,7 +111,7 @@ protected function getSchemaRequested(): bool
      * @param ValidationResult $errors Required for 'error' response
      * @param array $extraData Any extra data to be merged with the schema response
      */
-    protected function getSchemaResponse(string $schemaID, ?Form $form = null, ValidationResult $errors = null, array $extraData = []): HTTPResponse
+    public function getSchemaResponse(string $schemaID, ?Form $form = null, ValidationResult $errors = null, array $extraData = []): HTTPResponse
     {
         $parts = $this->getRequest()->getHeader(static::SCHEMA_HEADER);
         $data = $this
@@ -137,6 +127,16 @@ protected function getSchemaResponse(string $schemaID, ?Form $form = null, Valid
         return $response;
     }
 
+    /**
+     * Check if the current request has a X-Formschema-Request header set.
+     * Used by conditional logic that responds to validation results
+     */
+    protected function getSchemaRequested(): bool
+    {
+        $parts = $this->getRequest()->getHeader(static::SCHEMA_HEADER);
+        return !empty($parts);
+    }
+
     private function prepareTinyMce(): void
     {
         // Set the members html editor config

code/LeftAndMain.php

@@ -310,14 +310,9 @@ public function getClientConfig(): array
         // Add WYSIWYG link form schema before extensions are applied
         $this->beforeExtending('updateClientConfig', function (array &$clientConfig): void {
             $modalController = ModalController::singleton();
-            $clientConfig['form'] = [
-                'EditorExternalLink' => [
-                    'schemaUrl' => $modalController->Link('schema/EditorExternalLink'),
-                ],
-                'EditorEmailLink' => [
-                    'schemaUrl' => $modalController->Link('schema/EditorEmailLink'),
-                ],
-            ];
+            foreach (array_keys(ModalController::config()->get('link_modal_form_factories')) as $name) {
+                $clientConfig['form'][$name]['schemaUrl'] = $modalController->Link('linkModalFormSchema/' . $name . '/:pageid');
+            }
         });
         return parent::getClientConfig();
     }

code/ModalController.php

@@ -2,8 +2,13 @@
 
 namespace SilverStripe\Admin;
 
+use LogicException;
 use SilverStripe\Admin\Forms\EditorEmailLinkFormFactory;
 use SilverStripe\Admin\Forms\EditorExternalLinkFormFactory;
+use SilverStripe\Admin\Forms\LinkFormFactory;
+use SilverStripe\Control\HTTPRequest;
+use SilverStripe\Control\HTTPResponse;
+use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Forms\Form;
 
 /**
@@ -13,48 +18,77 @@ class ModalController extends FormSchemaController
 {
     private static ?string $url_segment = 'modals';
 
-    private static $allowed_actions = [
-        'EditorExternalLink',
-        'EditorEmailLink',
+    private static string $required_permission_codes = 'CMS_ACCESS';
+
+    private static array $allowed_actions = [
+        'linkModalForm',
+        'linkModalFormSchema',
     ];
 
-    private static string $required_permission_codes = 'CMS_ACCESS';
+    private static array $url_handlers = [
+        'linkModalForm/$ModalName/$ItemID' => 'linkModalForm',
+        'GET linkModalFormSchema/$ModalName/$ItemID' => 'linkModalFormSchema',
+    ];
+
+    /**
+     * Associative array of modal form names to form factory classes.
+     * Used primarily to register modal form factories for use in the WYSIWYG link plugin.
+     * Form factories must subclass LinkFormFactory
+     */
+    private static array $link_modal_form_factories = [
+        'EditorExternalLink' => EditorExternalLinkFormFactory::class,
+        'EditorEmailLink' => EditorEmailLinkFormFactory::class,
+    ];
 
     /**
-     * Builds and returns the external link form
-     *
-     * @return Form
-     * @deprecated 2.4.0 Will be replaced with linkModalForm()
+     * Get a link modal form built from a factory.
+     * Intended to be used in conjunction with linkModalFormSchema()
      */
-    public function EditorExternalLink(): Form
+    public function linkModalForm(HTTPRequest $request): Form
     {
-        Deprecation::noticeWithNoReplacment('2.4.0', 'Will be replaced with linkModalForm()');
+        $modalName = $request->param('ModalName');
+        $itemID = $request->param('ItemID');
+        if ($modalName === null || $itemID === null) {
+            $this->jsonError(400, 'Missing request params');
+        }
+        $modalForms = static::config()->get('link_modal_form_factories');
+        if (!array_key_exists($modalName, $modalForms)) {
+            $this->httpError(400);
+        }
         // Show link text field if requested
         $showLinkText = $this->getRequest()->getVar('requireLinkText');
-        $factory = EditorExternalLinkFormFactory::singleton();
-        return $factory->getForm(
+        $class = $modalForms[$modalName];
+        if (!is_a($class, LinkFormFactory::class, true)) {
+            throw new LogicException("Factory for '$modalName' must be a subclass of " . LinkFormFactory::class);
+        }
+
+        // Build the form
+        /** @var LinkFormFactory $factory */
+        $factory = Injector::inst()->get($class);
+        $form = $factory->getForm(
             $this,
-            __FUNCTION__,
-            [ 'RequireLinkText' => isset($showLinkText) ]
+            'linkModalForm/'.$modalName,
+            [
+                'RequireLinkText' => isset($showLinkText),
+                'ItemID' => $itemID,
+            ]
         );
+        // Set url handler that handles ItemID param correctly
+        $form->setRequestHandler(
+            LeftAndMainFormRequestHandler::create($form, [$itemID])
+        );
+        return $form;
     }
 
     /**
-     * Builds and returns the external link form
-     *
-     * @return Form
-     * @deprecated 2.4.0 Will be replaced with linkModalForm()
+     * Gets a JSON schema representing a link modal form.
+     * Links to this must include the ID of the current record or 0
+     * e.g ModalController::singleton()->Link('linkModalFormSchema/myModalForm/:pageid')
      */
-    public function EditorEmailLink(): Form
+    public function linkModalFormSchema(HTTPRequest $request): HTTPResponse
     {
-        Deprecation::noticeWithNoReplacment('2.4.0', 'Will be replaced with linkModalForm()');
-        // Show link text field if requested
-        $showLinkText = $this->getRequest()->getVar('requireLinkText');
-        $factory = EditorEmailLinkFormFactory::singleton();
-        return $factory->getForm(
-            $this,
-            __FUNCTION__,
-            [ 'RequireLinkText' => isset($showLinkText) ]
-        );
+        $form = $this->linkModalForm($request);
+        $schemaID = $request->getURL();
+        return $this->getSchemaResponse($schemaID, $form);
     }
 }