Added possibility to specify custom texts for warning_test_sp (#147)

* Added possibility to specify custom texts for warning_test_sp

* Split inline translation into header and text

Author: Dominik František Bučík

CHANGELOG.md

@@ -2,6 +2,9 @@
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
+#### Added
+- Added possibility to add custom texts to the TEST_SP warning page.
+
 #### Fixed
 - Fixed bad check in NagiosStatusConnector.php
 

config-templates/module_perun.php

@@ -272,4 +272,15 @@
             ],
         ],
     ],
+
+    'warning_test_sp_config' => [
+        'header' => [
+            'en' => '<h3>Warning - service in test environment</h3>',
+            'cs' => '<h3>Varování - testovací služba</h3>'
+        ],
+        'text' => [
+            'en' => '<p>Service is in the test environment.<br class="spacer"/>Hit the continue button.</p>',
+            'cs' => '<p>Služba je v testovacím režimu.<br class="spacer"/>Pokračujte zmáčknutím tlačítka.</p>',
+        ],
+    ],
 ];

lib/Auth/Process/WarningTestSP.php

@@ -2,6 +2,7 @@
 
 namespace SimpleSAML\Module\perun\Auth\Process;
 
+use SimpleSAML\Auth\ProcessingFilter;
 use SimpleSAML\Auth\State;
 use SimpleSAML\Module;
 use SimpleSAML\Utils\HTTP;
@@ -11,8 +12,18 @@
  *
  * Warns user that he/she is accessing to the testing SP
  */
-class WarningTestSP extends \SimpleSAML\Auth\ProcessingFilter
+class WarningTestSP extends ProcessingFilter
 {
+    public const CONFIG_FILE_NAME = "module_perun.php";
+
+    public const TEST_SP_CONFIG = "warning_test_sp_config";
+    public const TEST_SP_CONFIG_TEXT = "text";
+    public const TEST_SP_CONFIG_HEADER = "header";
+
+    public const CUSTOM_HEADER_ENABLED = "custom_header_enabled";
+    public const CUSTOM_TEXT_ENABLED = "custom_text_enabled";
+    public const CUSTOM_HEADER_KEY = "{perun:warning_test_sp:custom_header}";
+    public const CUSTOM_TEXT_KEY = "{perun:warning_test_sp:custom_text}";
 
     public function __construct($config, $reserved)
     {

templates/warning-test-sp-tpl.php

@@ -10,19 +10,32 @@
  * @var Template $this
  */
 
+$this->data['head'] = '<link rel="stylesheet" media="screen" type="text/css" href="' .
+    Module::getModuleUrl('perun/res/css/warning_test_sp.css') . '" />';
+
 $this->data['header'] = '';
 
 $this->includeAtTemplateBase('includes/header.php');
-
+$customHeaderEnabled = isset($this->data[Module\perun\Auth\Process\WarningTestSP::CUSTOM_HEADER_ENABLED])
+    && $this->data[Module\perun\Auth\Process\WarningTestSP::CUSTOM_HEADER_ENABLED];
+$customTextEnabled = isset($this->data[Module\perun\Auth\Process\WarningTestSP::CUSTOM_TEXT_ENABLED])
+    && $this->data[Module\perun\Auth\Process\WarningTestSP::CUSTOM_TEXT_ENABLED];
 ?>
 
     <form method="post" action="<?php echo Module::getModuleURL('perun/warning_test_sp_continue.php'); ?>">
 
         <input type="hidden" name="StateId" value="<?php echo $_REQUEST['StateId'] ?>">
-        <h3> <?php echo $this->t('{perun:perun:warning-test-sp-tpl_text}') ?> </h3>
-        </hr>
-        </br>
-
+        <h3><?php echo $customTextEnabled ?
+                $this->t(Module\perun\Auth\Process\WarningTestSP::CUSTOM_HEADER_KEY) :
+                $this->t('{perun:perun:warning-test-sp-tpl_text}')
+        ?>
+        </h3>
+        <?php
+        if ($customTextEnabled) {
+            echo '<div>' . $this->t(Module\perun\Auth\Process\WarningTestSP::CUSTOM_TEXT_KEY) . '</div>' . PHP_EOL;
+        }
+        ?>
+        <br/>
         <div class="form-group">
             <input type="submit" value="<?php echo $this->t('{perun:perun:continue}') ?>"
                    class="btn btn-lg btn-primary btn-block">

www/res/css/warning_test_sp.css

@@ -0,0 +1,22 @@
+html {
+    position: relative;
+    min-height: 100%;
+}
+
+.spacer {
+    margin-bottom: 3%;
+}
+
+#wrap {
+    padding: 3% 1% 1%;
+    margin-top: 3%;
+    margin-bottom: 110px;
+}
+
+#footer {
+    position: absolute;
+    bottom: 0;
+    left: 0;
+    right: 0;
+    height: 100px;
+}

www/warning_test_sp_page.php

@@ -2,6 +2,8 @@
 
 use SimpleSAML\Auth\State;
 use SimpleSAML\Configuration;
+use SimpleSAML\Logger;
+use SimpleSAML\Module\perun\Auth\Process\WarningTestSP;
 use SimpleSAML\XHTML\Template;
 
 $id = $_REQUEST['StateId'];
@@ -10,4 +12,30 @@
 $config = Configuration::getInstance();
 
 $t = new Template($config, 'perun:warning-test-sp-tpl.php');
+$t->data[WarningTestSP::CUSTOM_TEXT_ENABLED] = false;
+
+
+$perunModuleConfig = null;
+try {
+    $perunModuleConfig = Configuration::getConfig(WarningTestSP::CONFIG_FILE_NAME);
+} catch (\Exception $ex) {
+    Logger::warning("perun:warning_test_sp_page: missing or invalid '" .
+        WarningTestSP::CONFIG_FILE_NAME . "' config file");
+}
+if ($perunModuleConfig != null) {
+    $testSpWarningConfig = $perunModuleConfig->getConfigItem(WarningTestSP::TEST_SP_CONFIG, null);
+    if ($testSpWarningConfig != null) {
+        $header = $testSpWarningConfig->getArray(WarningTestSP::TEST_SP_CONFIG_HEADER, []);
+        if (!empty($header)) {
+            $t->includeInlineTranslation(WarningTestSP::CUSTOM_HEADER_KEY, $header);
+            $t->data[WarningTestSP::CUSTOM_HEADER_ENABLED] = true;
+        }
+        $text = $testSpWarningConfig->getArray(WarningTestSP::TEST_SP_CONFIG_TEXT, []);
+        if (!empty($text)) {
+            $t->includeInlineTranslation(WarningTestSP::CUSTOM_TEXT_KEY, $text);
+            $t->data[WarningTestSP::CUSTOM_TEXT_ENABLED] = true;
+        }
+    }
+}
+
 $t->show();