Merge pull request #1 from nikosev/hotfix-livesearch

Fix livesearch in discopower

Author: olgabrani

CHANGELOG.md

@@ -4,6 +4,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- Add `login_with` key in discopower definitions
+
+### Fixed
+
+- Load JavaScript scripts with the new way
+- Fix undefined index error for `idps_in_searchable_list_index`
+- Load jQuery CSS script
+
+### Changed
+
+- Move `ribbon_text` definition to config file
+
 ## [v3.0.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v2.3.1...v3.0.0) - 2019-09-20
 
 ### Added

README.md

@@ -202,7 +202,7 @@ If you want to make any changes in the footer you need to modify the template
 ### Header ribbon
 
 The text in the header ribbon can be altered by changing the `ribbon_text`
-definition in `dictionaries/default.definition.json` file.
+definition in `module_themevanilla.php` file.
 If you want to hide the ribbon, set `ribbon_text` to `""`.
 
 ### CSS
@@ -256,10 +256,12 @@ You can read more about themes in a SimpleSAMLphp installation from the
 
 This table matches the theme version with the supported SimpleSAMLphp version.
 
-| Theme |  SimpleSAMLphp  |
-|:------:|:--------------:|
-| v2.3.1   | v1.14        |
-| v3.0.0   | v1.17        |
+| Theme | SimpleSAMLphp | Discopower |
+| :---: | :-----------: | :--------: |
+| v1.x  |     v1.14     |     -      |
+| v2.x  |     v1.14     |     -      |
+| v3.x  |     v1.17     |     -      |
+| v4.x  |       -       |   v0.9.2   |
 
 ## License
 

config-example/module_themevanilla.php

@@ -1,11 +1,13 @@
 <?php
+
 /**
  * This is example configuration of SimpleSAMLphp themevanila.
  * Copy this file to default config directory and edit the properties.
  *
  * copy command (from SimpleSAML base dir)
  * cp modules/themevanilla/module_themevanilla.php config/
  */
+
 $config = array(
     'cookiePolicy' => array(
         array('type' => 'Session State', 'provider' => 'aai.rciam.eu', 'name' => 'rciam_proxy_authtoken, rciam_google_proxy_authtoken, rciam_google_proxy_authtoken, rciam_facebook_proxy_authtoken, rciam_linkedin_proxy_authtoken, rciam_orcid_proxy_authtoken', 'thirdParty' => false, 'category' => 'Session', 'purpose' => 'Preserve user authentication token to prevent session fixation attacks'),
@@ -17,7 +19,6 @@
         array('type' => 'Preferences', 'provider' => 'aai.rciam.eu', 'name' => 'i18next', 'thirdParty' => false, 'category' => 'Session', 'purpose' => 'Preserve preferred language for RCIAM AAI OpenID Connect Provider'),
         array('type' => 'Session State', 'provider' => 'aai.rciam.eu', 'name' => 'JSESSIONID', 'thirdParty' => false, 'category' => 'Session', 'purpose' => 'Preserve user session ID to retrieve session information')
       ),
-      'enable_cookies_banner' => false
+      'enable_cookies_banner' => false,
+      'ribbon_text' => '',
 );
-
-?>

dictionaries/default.definition.json

@@ -10,8 +10,5 @@
   },
   "logo_link_url": {
     "en": "https://www.example.com"
-  },
-  "ribbon_text": {
-    "en": "Demo"
   }
 }

dictionaries/discopower.definition.json

@@ -25,5 +25,8 @@
   },
   "cookies_link_url": {
     "en": "../themevanilla/policy.php"
+  },
+  "login_with": {
+    "en": "Log in with"
   }
 }

dictionaries/userid_error.definition.json

@@ -3,7 +3,7 @@
     "en": "Sorry, we were not able to log you in"
   },
   "friendly_description": {
-    "en": "<strong>What is the problem?</strong> %IDP% does not return a persistent identifier to help us uniquely identify you."
+    "en": "<strong>What is the problem?</strong> %IDPNAME% does not return a persistent identifier to help us uniquely identify you."
   },
   "resolution_description": {
     "en": "<strong>What can you do?</strong> At the moment, the only way to log in is to <a href=\"%RETRY_URL%\">use a different account</a>. For future use, you may ask your institution administrator to release the required information, by sending them a print screen of this error, or asking them to contact our support at <a href=\"mailto:support@example.org\">support@example.org</a>."

themes/ssp/default/includes/header.php

@@ -1,6 +1,7 @@
 <?php
 
-
+$themeConfig = SimpleSAML\Configuration::getConfig('module_themevanilla.php');
+$ribbonText = $themeConfig->getValue('ribbon_text');
 
 /**
  * Support the htmlinject hook, which allows modules to change header, pre and post body on all pages.
@@ -127,9 +128,9 @@
 
 <div class="header">
 <?php
-  if (strpos($this->t('{themevanilla:default:ribbon_text}'), 'not translated') === FALSE || $this->t('{themevanilla:default:ribbon_text}')) {
+  if (!empty($ribbonText)) {
     echo '<div class="corner-ribbon red">';
-    echo $this->t('{themevanilla:default:ribbon_text}');
+    echo $ribbonText;
     echo '</div>';
   }
   ?>

themes/ssp/discopower/disco.tpl.php

@@ -25,20 +25,26 @@
 
 $this->data['header'] = $this->t('selectidp');
 $this->data['header'] = $this->t($this->data['header']);
-$this->data['jquery'] = ['core' => true, 'ui' => true, 'css' => true];
+$this->data['jquery'] = ['core' => true, 'ui' => false, 'css' => false];
 
-
-$this->data['head'] = '<script type="text/javascript" src="'.
-    SimpleSAML\Module::getModuleURL('discopower/assets/js/jquery.livesearch.js').'"></script>'."\n";
-$this->data['head'] .= '<script type="text/javascript" src="'.
-    SimpleSAML\Module::getModuleURL('discopower/assets/js/' . $this->data['score'].'.js')  . '"></script>'."\n";
-
-$this->data['head'] .= $this->data['search'];
+$this->data['head'] = '<link rel="stylesheet" media="screen" type="text/css" href="'.
+    SimpleSAML\Module::getModuleURL('discopower/assets/css/uitheme1.12.1/jquery-ui.min.css').'" />';
 
 if (!empty($faventry)) $this->data['autofocus'] = 'favouritesubmit';
 
 $this->includeAtTemplateBase('includes/header.php');
 
+$this->data['htmlinject']['htmlContentPost'][] = '<script type="text/javascript" src="'.
+    SimpleSAML\Module::getModuleURL('discopower/assets/js/jquery-1.12.4.min.js').'"></script>'."\n";
+$this->data['htmlinject']['htmlContentPost'][] = '<script type="text/javascript" src="'.
+    SimpleSAML\Module::getModuleURL('discopower/assets/js/jquery-ui-1.12.1.min.js').'"></script>'."\n";
+$this->data['htmlinject']['htmlContentPost'][] = '<script type="text/javascript" src="'.
+    SimpleSAML\Module::getModuleURL('discopower/assets/js/jquery.livesearch.js').'"></script>'."\n";
+$this->data['htmlinject']['htmlContentPost'][] = '<script type="text/javascript" src="'.
+    SimpleSAML\Module::getModuleURL('discopower/assets/js/tablist.js').'"></script>'."\n";
+$this->data['htmlinject']['htmlContentPost'][] = '<script type="text/javascript" src="'.
+    SimpleSAML\Module::getModuleURL('discopower/assets/js/' . $this->data['score'].'.js') . '"></script>'."\n";
+
 function showEntry($t, $metadata, $favourite = FALSE, $withIcon = FALSE) {
 
   $basequerystring = '?' .
@@ -134,7 +140,7 @@ function getTranslatedName($t, $metadata) {
                 <input type="hidden" name="returnIDParam" value="' . htmlspecialchars($this->data['returnIDParam']) . '" />
                 <input type="hidden" name="idpentityid" value="' . htmlspecialchars($faventry['entityid']) . '" />
                 <input type="submit" name="formsubmit" id="favouritesubmit" class="ssp-btn ssp-btn__action text-uppercase" value="'
-                  . $this->t('login_at') . ' ' . htmlspecialchars(getTranslatedName($this, $faventry)) . '" />
+                  . $this->t('{themevanilla:discopower:login_with}') . ' ' . htmlspecialchars(getTranslatedName($this, $faventry)) . '" />
               </form>
             </div>
             <div class="row text-center ssp-modal-or">' . (strpos($this->t('{themevanilla:discopower:or}'), 'not translated') === FALSE ? $this->t('{themevanilla:discopower:or}') : '') . '</div>
@@ -198,7 +204,7 @@ function getTranslatedName($t, $metadata) {
           $list_items .= (showEntry($this, $idpentry, FALSE, TRUE));
         }
       }
-      if($idps_in_searchable_list_index < $idps_with_logos_index) {
+      if(!empty($idps_in_searchable_list_index) && $idps_in_searchable_list_index < $idps_with_logos_index) {
         $or = '<div class="text-center ssp-line-or-line ssp-line-or-line--top"><span class="ssp-line-or-line__or">' . (strpos($this->t('{themevanilla:discopower:or}'), 'not translated') === FALSE ? $this->t('{themevanilla:discopower:or}') : '') . '</span></div>';
         echo $top . $or . $list_open . $list_items . $close_list . $close;
       }

themes/ssp/userid/error.tpl.php

@@ -9,14 +9,17 @@
 
 $this->includeAtTemplateBase('includes/header.php');
 $retryUrl = $this->data['parameters']['%BASEDIR%'] . 'saml2/idp/initSLO.php?RelayState=' . urlencode($this->data['parameters']['%RESTARTURL%']);
+$translationParams = [
+  '%IDPNAME%' => $this->data['parameters']['%IDPNAME%'],
+];
 ?>
 <div class="row">
   <div class="col-sm-12">
   <?php
     $friendly_title = '<h2>' . (strpos($this->t('{themevanilla:userid_error:friendly_title}'), 'not translated') === FALSE ? $this->t('{themevanilla:userid_error:friendly_title}') : '') . '</h2>';
     echo $friendly_title;
   ?>
-    <p><?php echo $this->t('{themevanilla:userid_error:friendly_description}', $this->data['parameters']); ?></p>
+    <p><?php echo $this->t('{themevanilla:userid_error:friendly_description}', $translationParams); ?></p>
     <p><?php echo $this->t('{themevanilla:userid_error:resolution_description}', array('%RETRY_URL%' => $retryUrl)); ?></p>
   </div>
 </div>