[DICOM archive] Ensure that settings necessary for anonymization exist

modules/dicom_archive/php/dicom_archive.class.inc

@@ -4,7 +4,7 @@
  * This class features the code for the menu portion
  * of the Loris dicom archive.
  *
- * PHP Version 5
+ * PHP Version 7
  *
  * @category   Behavioural
  * @package    Main
@@ -97,7 +97,6 @@ class Dicom_Archive extends \NDB_Menu_Filter
         $this->addBasicText('seriesuid', 'Series UID');
     }
 
-
     /**
      * Converts the results of this menu filter to a JSON format to be retrieved
      * with ?format=json
@@ -106,6 +105,9 @@ class Dicom_Archive extends \NDB_Menu_Filter
      */
     function toJSON()
     {
+        /* Ensure that the server is well configured to prevent displaying
+         * data that is not properly anonmyized.
+         */
         $table = (new \LORIS\Data\Table())
             ->withDataFrom($this->getDataProvisioner());
         $arr   = array_map(

modules/dicom_archive/php/module.class.inc

@@ -13,6 +13,8 @@
  * @link       https://www.github.com/aces/Loris-Trunk/
  */
 namespace LORIS\dicom_archive;
+use \Psr\Http\Message\ServerRequestInterface;
+use \Psr\Http\Message\ResponseInterface;
 
 /**
  * Class module implements the basic LORIS module functionality
@@ -26,4 +28,67 @@ namespace LORIS\dicom_archive;
  */
 class Module extends \Module
 {
-}
+    /**
+     * Handle a PSR7 Request for the dicom_archive endpoint. Also calls a
+     * validation function to ensure necessary configuration settings exist.
+     *
+     * @param ServerRequestInterface $request The PSR15 Request being handled
+     *
+     * @return ResponseInterface The PSR15 response for the page.
+     */
+    public function handle(ServerRequestInterface $request) : ResponseInterface
+    {
+        try {
+            $this->validateConfig();
+        } catch (\ConfigurationException $e) {
+            error_log($e);
+            return (new \LORIS\Middleware\PageDecorationMiddleware(
+                $request->getAttribute("user") ?? new \LORIS\AnonymousUser()
+            ))->process(
+                $request,
+                new \LORIS\Router\NoopResponder(
+                    new \LORIS\Http\Error(
+                        $request,
+                        500,
+                        'Required configuration settings for DICOM ' .
+                        'anonymization are missing. Cannot continue.'
+                    )
+                )
+            );
+        }
+        return parent::handle($request);
+    }
+
+    /**
+     * Checks that the required configuration settings are properly set. Throws
+     * a ConfigurationException if not.
+     *
+     * @return void
+     *
+     * @throws \ConfigurationException
+     */
+    function validateConfig(): void
+    {
+        /* Ensure that all required configuraton settings are properly set
+         * before continuing.
+         */
+        $config        = \NDB_Config::singleton()->getSetting("imaging_modules");
+        $configOptions = array(
+                          'patientNameRegex',
+                          'LegoPhantomRegex',
+                          'LivingPhantomRegex',
+                          'patientIDRegex',
+                         );
+        $configError   = 'Configuration settings missing for DICOM anonymization. ' .
+            'Please ensure that the following settings are configured to ' .
+            'be valid regular expressions: ';
+        foreach ($configOptions as $option) {
+            if (!isset($config[$option])) {
+                throw new \ConfigurationException(
+                    $configError . implode(', ', $configOptions)
+                );
+            }
+        }
+    }
+
+}