refactor: Rename LS Hostel to LS Username Login

Also update all references

BREAKING CHANGE:  modified config options - see example config. Also renamed directory
under "themes"

config-templates/module_lshostel.php → config-templates/module_lsaai.php

 <?php
 
 /**
- * This is example configuration fot lsaai module. Copy this file to default config directory and edit the properties.
+ * This is example configuration for the LS AAI module.
+ * Copy this file to default config directory and edit the properties.
  *
- * copy command (from SimpleSAML base dir) cp modules/lsaai/module_lsaai.php config/
+ * copy command (from SimpleSAML base dir) cp modules/lsaai/config-templates/module_lsaai.php config/.
  */
 
 declare(strict_types=1);
@@ -12,8 +13,8 @@ $config = [
     'register_link' => '',
 
     'pwd_reset' => [
-        'lsaai_entity_id' => '',
-        'lsaai_scope' => '',
+        'ls_username_login_entity_id' => '',
+        'ls_username_login_scope' => '',
         'vo_short_name' => '',
         'perun_namespace' => '',
         'perun_url' => '',

dictionaries/lsaai.definition.json

@@ -3,18 +3,18 @@
     "en": "Please provide your mail so that we can contact you for further information or let you know the issue was fixed."
   },
   "user_pass_header": {
-    "en": "Life Science Hostel Login"
+    "en": "LS Username Login"
   },
   "user_pass_text": {
     "en": "Enter your username and password"
   },
-  "register_acc_hostel": {
+  "login_button_register": {
     "en": "Sign up"
   },
   "email": {
     "en": "Email"
   },
-  "forgot_password": {
+  "login_button_forgotten_password": {
     "en": "Forgotten password"
   },
   "title_WRONGUSERPASS": {

lib/TemplateHelper.php

@@ -13,8 +13,8 @@ class TemplateHelper
 {
     public const LANG_EN = 'en';
     public const PWD_RESET = 'pwd_reset';
-    public const PWDRESET_LSHOSTEL_ENTITY_ID = 'lshostel_entity_id';
-    public const PWDRESET_LSHOSTEL_SCOPE = 'lshostel_scope';
+    public const PWDRESET_LS_USERNAME_LOGIN_ENTITY_ID = 'ls_username_login_entity_id';
+    public const PWDRESET_LS_USERNAME_LOGIN_SCOPE = 'ls_username_login_scope';
     public const PWDRESET_VO_SHORT_NAME = 'vo_short_name';
     public const PWDRESET_PERUN_NAMESPACE = 'perun_namespace';
     public const PWDRESET_PERUN_URL = 'perun_url';
@@ -27,8 +27,8 @@ class TemplateHelper
 
         $conf = Configuration::getConfig(TemplateHelper::CONFIG_FILE_NAME);
         $pwdConf = $conf->getConfigItem(TemplateHelper::PWD_RESET);
-        $lshostelEntityId = $pwdConf->getString(TemplateHelper::PWDRESET_LSHOSTEL_ENTITY_ID);
-        $lshostelScope = $pwdConf->getString(TemplateHelper::PWDRESET_LSHOSTEL_SCOPE);
+        $lsUsernameLoginEntityId = $pwdConf->getString(TemplateHelper::PWDRESET_LS_USERNAME_LOGIN_ENTITY_ID);
+        $lsUsernameLoginScope = $pwdConf->getString(TemplateHelper::PWDRESET_LS_USERNAME_LOGIN_SCOPE);
         $voShortName = $pwdConf->getString(TemplateHelper::PWDRESET_VO_SHORT_NAME);
         $perunNamespace = $pwdConf->getString(TemplateHelper::PWDRESET_PERUN_NAMESPACE);
         $perunUrl = $pwdConf->getString(TemplateHelper::PWDRESET_PERUN_URL);
@@ -37,19 +37,15 @@ class TemplateHelper
         $userName = trim($userName);
         Logger::debug(print_r($userName, true));
 
-//    $userNameParts = explode('@', $userName, 2);
-//    $userName = $userNameParts[0] . '_' . strtolower($userNameParts[1]);
-
-        $uid = [$userName . $lshostelScope];
-        $user = null;
+        $uid = [$userName . $lsUsernameLoginScope];
         try {
-            $user = $rpcAdapter->getPerunUser($lshostelEntityId, $uid);
+            $user = $rpcAdapter->getPerunUser($lsUsernameLoginEntityId, $uid);
             Logger::debug(print_r($user, true));
         } catch (Exception $ex) {
             throw new Exception($ex);
         }
         if (null === $user) {
-            throw new Exception('There are no LifeScience Hostel user with username: ' . $userName);
+            throw new Exception('There is no Lifescience RI user with username: ' . $userName);
         }
 
         $vo = $rpcAdapter->getVoByShortName($voShortName);

templates/pwd_reset-tpl.php

@@ -46,7 +46,7 @@ header('X-Frame-Options: SAMEORIGIN');
     <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1.0"/>
     <script type="text/javascript" src="/<?php
     echo $this->data['baseurlpath']; ?>resources/script.js"></script>
-    <title>LS Hostel</title>
+    <title>LS Username Login</title>
 
     <link rel="stylesheet" type="text/css" href="/<?php
     echo $this->data['baseurlpath']; ?>resources/default.css"/>
@@ -106,7 +106,7 @@ echo $onLoad; ?>>
         <div class="row pl-0 pr-0">
             <div class="col-md-6 col-md-offset-3 logo-wrap col-align--center">
                 <img src="<?php
-                echo SimpleSAML\Module::getModuleUrl('lsaai/res/img/ls_logo.png'); ?>" alt="Life Science Hostel logo">
+                echo SimpleSAML\Module::getModuleUrl('lsaai/res/img/ls_logo.png'); ?>" alt="LS Username Login Logo">
             </div>
             <div class="col-md-6 col-md-offset-3">
                 <?php

themes/lshostel/core/loginuserpass.php → themes/lsusernamelogin/core/loginuserpass.php

@@ -5,7 +5,6 @@ declare(strict_types=1);
 use SimpleSAML\Configuration;
 use SimpleSAML\Module\lsaai\TemplateHelper;
 
-const CONFIG_FILE_NAME = 'module_lsaai.php';
 const REGISTER_LINK = 'register_link';
 
 $conf = Configuration::getConfig(TemplateHelper::CONFIG_FILE_NAME);
@@ -52,7 +51,7 @@ header('X-Frame-Options: SAMEORIGIN');
     <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1.0"/>
     <script type="text/javascript" src="/<?php
     echo $this->data['baseurlpath']; ?>resources/script.js"></script>
-    <title>LS Hostel</title>
+    <title>LS Username Login</title>
 
     <link rel="stylesheet" type="text/css" href="/<?php
     echo $this->data['baseurlpath']; ?>resources/default.css"/>
@@ -113,7 +112,7 @@ echo $onLoad; ?>>
         <div class="row pl-0 pr-0">
             <div class="col-md-6 col-md-offset-3 logo-wrap">
                 <img src="<?php
-                echo SimpleSAML\Module::getModuleUrl('lsaai/res/img/ls_logo.png'); ?>" alt="Life Science Hostel logo">
+                echo SimpleSAML\Module::getModuleUrl('lsaai/res/img/ls_logo.png'); ?>" alt="LS Username login logo">
             </div>
             <div class="col-md-6 col-md-offset-3">
                 <h1>
@@ -224,14 +223,13 @@ echo $onLoad; ?>>
                         <a class="btn btn-link" href="<?php
                         echo $register_link; ?>">
                             <?php
-                            echo $this->t('{lsaai:lsaai:register_acc_hostel}'); ?>
+                            echo $this->t('{lsaai:lsaai:login_button_register}'); ?>
+                        </a>                       |
+                        <a class="btn btn-link" href="<?php
+                        echo SimpleSAML\Module::getModuleURL("lsaai/pwd_reset.php");?>">
+                            <?php
+                            echo $this->t('{lsaai:lsaai:login_button_forgotten_password}')?>
                         </a>
-                        <!--                         |-->
-                        <!--                        <a class="btn btn-link" href="--><?php
-                        //echo SimpleSAML\Module::getModuleURL("lsaai/pwd_reset.php");?><!--">-->
-                        <!--                            --><?php
-                        //echo $this->t('{lsaai:lsaai:forgot_password}')?>
-                        <!--                        </a>-->
                     </div>
                     <?php
                     foreach ($this->data['stateparams'] as $name => $value) {

themes/lshostel/default/includes/header.php → themes/lsusernamelogin/default/includes/header.php

@@ -139,10 +139,10 @@ echo $onLoad; ?>>
 
     <div id="header">
         <img src="<?php
-        echo SimpleSAML\Module::getModuleUrl('lsaai/res/img/ls_logo.png'); ?>" alt="Life Science Hostel logo">
+        echo SimpleSAML\Module::getModuleUrl('lsaai/res/img/ls_logo.png'); ?>" alt="LS Username Login logo">
         <h1>
             <?php
-            echo isset($this->data['header']) ? $this->data['header'] : 'Life Science Hostel';
+            echo isset($this->data['header']) ? $this->data['header'] : 'LS Username Login';
             ?>
         </h1>
     </div>

www/pwd_reset.php

@@ -3,9 +3,6 @@
 declare(strict_types=1);
 
 use SimpleSAML\Configuration;
-use SimpleSAML\Error\Exception;
-use SimpleSAML\Logger;
-use SimpleSAML\Module\lsaai\TemplateHelper;
 use SimpleSAML\Module\perun\AdapterRpc;
 use SimpleSAML\XHTML\Template;