[FEATURE] Optional validators (kitodo#1760)

Co-authored-by: Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>

Author: markusweigelt

Classes/Controller/ValidationFormController.php

@@ -12,6 +12,10 @@
 namespace Kitodo\Dlf\Controller;
 
 use Psr\Http\Message\ResponseInterface;
+use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
+use TYPO3\CMS\Core\TypoScript\TypoScriptService;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
 
 /**
  * Plugin 'ValidationForm' for the 'dlf' extension
@@ -31,8 +35,33 @@ class ValidationFormController extends AbstractController
      */
     public function mainAction(): ResponseInterface
     {
-        $language = $this->request->getAttribute('language');
-        $this->view->assign("url", $language->getBase()->getPath() . '?middleware=dlf/domDocumentValidation');
+        /** @var SiteLanguage $siteLanguage */
+        $siteLanguage = $this->request->getAttribute('language') ?? $this->request->getAttribute('site')->getDefaultLanguage();
+
+        $typeParam = 'dfgviewer';
+
+        // retrieve validation configuration from plugin.tx_dlf typoscript
+        /** @var ConfigurationManagerInterface $configurationManager */
+        $configurationManager = GeneralUtility::makeInstance(ConfigurationManagerInterface::class);
+        $typoScript = $configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_FULL_TYPOSCRIPT);
+
+        /** @var TypoScriptService $typoScriptService */
+        $typoScriptService = GeneralUtility::makeInstance(TypoScriptService::class);
+        $settings = $typoScriptService->convertTypoScriptArrayToPlainArray($typoScript['plugin.']['tx_dlf.']['settings.']);
+
+        $disabledValidators = [];
+        if (array_key_exists("domDocumentValidation", $settings) && array_key_exists($typeParam, $settings["domDocumentValidation"])) {
+            $validationConfiguration = $settings['domDocumentValidation'][$typeParam];
+            foreach ($validationConfiguration as $key => $value) {
+                if (isset($value['disabled']) && $value['disabled'] === "true") {
+                    $disabledValidators[$key]['title'] = $value['title'];
+                    $disabledValidators[$key]['shortdescription'] = $value['shortdescription'];
+                }
+            }
+        }
+
+        $this->view->assign("url", $siteLanguage->getBase()->getPath() . '?middleware=dlf/domDocumentValidation');
+        $this->view->assign("disabledValidators", $disabledValidators);
         return $this->htmlResponse();
     }
 }

Classes/Middleware/DOMDocumentValidation.php

@@ -1,7 +1,4 @@
 <?php
-
-namespace Kitodo\Dlf\Middleware;
-
 /**
  * (c) Kitodo. Key to digital objects e.V. <contact@kitodo.org>
  *
@@ -12,6 +9,8 @@
  * LICENSE.txt file that was distributed with this source code.
  */
 
+namespace Kitodo\Dlf\Middleware;
+
 use DOMDocument;
 use InvalidArgumentException;
 use Kitodo\Dlf\Validation\DOMDocumentValidationStack;
@@ -24,6 +23,7 @@
 use TYPO3\CMS\Core\Localization\LanguageService;
 use TYPO3\CMS\Core\Localization\LanguageServiceFactory;
 use TYPO3\CMS\Core\Log\LogManager;
+use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
 use TYPO3\CMS\Core\TypoScript\TypoScriptService;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Core\Utility\PathUtility;
@@ -116,7 +116,8 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
             throw new InvalidArgumentException('Validation configuration type does not exist.', 1744373532);
         }
 
-        $validationConfiguration = $settings['domDocumentValidation'][$typeParam];
+        $validationConfiguration = $this->removeDisabledValidators($parameters, $settings['domDocumentValidation'][$typeParam]);
+
         $validation = GeneralUtility::makeInstance(DOMDocumentValidationStack::class, $validationConfiguration);
         // validate and return json response
         return $this->getJsonResponse($validationConfiguration, $validation->validate($document));
@@ -159,11 +160,45 @@ protected function getJsonResponse(array $configurations, ?Result $result): Resp
         return $response;
     }
 
-    private function getTranslation(string $key, ?array $arguments = null): string
+    /**
+     * Get the message.
+     *
+     * @return \Closure
+     */
+    protected function getMessageText(): \Closure
+    {
+        return function (Message $message): string {
+            return $message->getMessage();
+        };
+    }
+
+    /**
+     * Removes validators marked as disabled from the configuration.
+     *
+     * If a validator in the configuration has the disabled flag set to true and its key does not exist in the enabledValidators parameter, it will be removed.
+     *
+     * @param array $parameters The parameters of the middleware.
+     * @param array $validationConfiguration The validation configuration to remove from
+     * @return array The validator configuration without the disabled validators
+     */
+    protected function removeDisabledValidators(array $parameters, array $validationConfiguration): array
+    {
+        $enableValidators = [];
+        if (array_key_exists("enableValidators", $parameters)) {
+            $enableValidators = explode(",", $parameters['enableValidators']);
+        }
+        foreach ($validationConfiguration as $key => $value) {
+            if (isset($value['disabled']) && $value['disabled'] === "true" && !in_array($key, $enableValidators)) {
+                unset($validationConfiguration[$key]);
+            }
+        }
+        return $validationConfiguration;
+    }
+
+    protected function getTranslation(string $key, ?array $arguments = null): string
     {
-        $language =
-            $this->request->getAttribute('language')
-            ?? $this->request->getAttribute('site')->getDefaultLanguage();
+        /** @var SiteLanguage $siteLanguage */
+        $siteLanguage = $this->request->getAttribute('language') ?? $this->request->getAttribute('site')->getDefaultLanguage();
 
         /** @var LanguageServiceFactory $languageServiceFactory */
         $languageServiceFactory = GeneralUtility::makeInstance(
@@ -172,7 +207,7 @@ private function getTranslation(string $key, ?array $arguments = null): string
 
         /** @var LanguageService $languageService */
         $languageService = $languageServiceFactory
-            ->createFromSiteLanguage($language);
+            ->createFromSiteLanguage($siteLanguage);
 
         if (isset($arguments) && count($arguments) > 0) {
             return vsprintf(
@@ -182,16 +217,4 @@ private function getTranslation(string $key, ?array $arguments = null): string
         }
         return $languageService->sL($key);
     }
-
-    /**
-     * Get the message.
-     *
-     * @return \Closure
-     */
-    private function getMessageText(): \Closure
-    {
-        return function (Message $message): string {
-            return $message->getMessage();
-        };
-    }
 }

Resources/Private/Templates/ValidationForm/Main.html

@@ -12,11 +12,15 @@
                 <f:format.raw><f:translate key='LLL:EXT:dlf/Resources/Private/Language/locallang.xlf:plugins.validationform.label' /></f:format.raw>
                 <input type="text" name="url" class="url" value="" required>
             </label>
+            <div class="disabled-validators">
+                <f:for each="{disabledValidators}" as="value" key="key" >
+                    <label title="{f:translate(key: value.shortdescription)}">
+                        <input type="checkbox" name="enableValidator[]" class="checkbox" value="{key}"/>
+                        {f:translate(key: value.title)}
+                    </label>
+                </f:for>
+            </div>
             <input type="submit" class="submit" value="<f:translate key='LLL:EXT:dlf/Resources/Private/Language/locallang.xlf:plugins.validationform.validate'/>">
         </form>
-
-        <script>
-
-        </script>
     </div>
 </html>

Resources/Public/JavaScript/ValidationForm/ValidationForm.js

@@ -50,8 +50,26 @@ dlfValidationForms.forEach((validationForm) => {
   validationForm.addEventListener("submit", function (event) {
     event.preventDefault();
 
+    const formData = new FormData(event.target);
+    const data = {};
+
     // Convert submitted values to data
-    const data = Object.fromEntries(new FormData(event.target).entries());
+    for (const [key, value] of formData.entries()) {
+      // If key ends with [], treat as array
+      if (key.endsWith('[]')) {
+        const cleanKey = key.slice(0, -2);
+        // eslint-disable-next-line
+        if (!data[cleanKey]) {
+          // eslint-disable-next-line
+          data[cleanKey] = [];
+        }
+        // eslint-disable-next-line
+        data[cleanKey].push(value);
+      } else {
+        // eslint-disable-next-line
+        data[key] = value;
+      }
+    }
 
     /**
      * Create a list of messages.
@@ -140,7 +158,12 @@ dlfValidationForms.forEach((validationForm) => {
     const loader = buildLoader(event.target);
     const form = event.target.parentElement;
 
-    getData(this.action + '&type=' + encodeURI(data.type) + '&url=' + encodeURI(data.url)).then(data => {
+    let dataUrl = this.action + '&type=' + encodeURIComponent(data.type) + '&url=' + encodeURIComponent(data.url);
+    if (data.enableValidator && Array.isArray(data.enableValidator)) {
+      dataUrl += '&enableValidators=' + encodeURIComponent(data.enableValidator.join(','));
+    }
+
+    getData(dataUrl).then(data => {
       let validation = form.querySelector('.validation');
       if (validation) {
         form.removeChild(validation);