Merge branch 'release-2.2.0'

Author: olgabrani

CHANGELOG.md

@@ -4,23 +4,38 @@ 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).
 
+## [v2.2.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v2.1.0...v2.2.0) - 2019-06-27
+
+### Added
+- Module discopower: Add style rules and logos for the buttons of the IdPs:
+  - OpenAIRE
+  - OpenMinTeD
+  - QQ
+  - WeChat
+  - Epos
+- Add info about compatiblity in README.
+- Enable/disable cookie banner functionality via setting in config file.
+
+### Changed
+- Update instructions on module config file usage.
+- Update style of Google login button.
 
 ## [v2.1.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v2.0.0...v2.1.0) - 2018-10-18
 
 ### Added
-- Add banner and an extra view for cookies options
-- Add corner ribbon that displays customisable text
-- Add this changelog file
+- Add banner and an extra view for cookies options.
+- Add corner ribbon that displays customisable text.
+- Add this changelog file.
 - Module discopower: Add style rules and logos for the buttons of the IdPs:
   - eduTEAMS
   - EGI
   - Aria
 
 ### Changed
-  - Change vanilla logo and favicon
+  - Change vanilla logo and favicon.
   - Move wording and links from the templates of several modules to the related
-    definition file
-  - Render header logo link url customisable
+    definition file.
+  - Render header logo link url customisable.
 
 ## [v2.0.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v1.0.0...v2.0.0) - 2018-04-17
 

README.md

@@ -64,7 +64,8 @@ v1.0.0**.
 
   "post-update-cmd": [
     "cp -r 'vendor/rciam/css' 'modules/themevanilla/www/resources'",
-    "cp -r 'vendor/rciam/js' 'modules/themevanilla/www/resources'"
+    "cp -r 'vendor/rciam/js' 'modules/themevanilla/www/resources'",
+    "cp 'modules/themevanilla/config-example/module_themevanilla.php' 'config/module_themevanilla.php'"
   ]
 },
 ```
@@ -76,12 +77,16 @@ With the above configuration composer will do several operations:
 * It will copy the `css` and `js` directories from the `vendor/rciam` directory
   in the `themevanilla/www/resources` directory, where the static files of the
   theme should be placed.
+* It will place the configuration file `module_themevanilla.php` inside the
+  `config` directory of the installation.
 
 ### Direct download
 
 You can download `themevanilla.zip` from the [release page](https://github.com/rciam/simplesamlphp-module-themevanilla/releases).
 Download the zip file of the preferred release and extract its contents in the
 `modules` directory of your SimpleSAMLphp installation.
+Finally, move `example-config/module_themevanilla.php` file to the `config` directory
+of your SimpleSAMLphp installation.
 
 ### Clone repository
 
@@ -97,14 +102,8 @@ You'll need to download or produce them. You can download the compressed
 directories (`js.zip` and `css.zip`) from the [release page](https://github.com/rciam/simplesamlphp-module-themevanilla/releases) and
 extract them under `modules/themevanilla/www/resources`.  If you want to produce
 them, you may read the customisation instructions below.
-
-### Cookie Policy
-
-In order to use Cookie Policy page you must copy the configuration file
-from the `config-example` folder to core config directory.
-```
-cp <path-to-module>/config-example/module_themevanilla.php <path-to-simplesamlphp>/config
-```
+As a last step, move `example-config/module_themevanilla.php` file to the `config`
+directory of your SimpleSAMLphp installation.
 
 
 ## Configuration
@@ -162,6 +161,16 @@ At the moment there are style rules for the IdPs:
 * IGTF
 * LinkedIn
 * ORCID
+* OpenAIRE
+* OpenMinTeD
+
+### Cookie Policy
+
+Cookie policy includes a banner at the bottom of each page that prompts the user to
+accept the cookies, along with a Cookies Policy page.
+The feature is disabled by default.
+To enable it, set `enable_cookies_banner` to `true` in the configuration file:
+`<path-to-simplesamlphp>/config/module_themevanilla.php`.
 
 
 ## Customization
@@ -186,6 +195,7 @@ You can customise the url of the link of the logo in the header by changing
 the `logo_link_url` definition in `dictionaries/default.definition.json` file.
 
 ### Footer
+
 If you want to make any changes in the footer you need to modify the template
 `footer.php` that is placed in: `themevanilla/themes/ssp/default/includes/`.
 
@@ -235,8 +245,15 @@ compiling options.
 To modify the cookie banner and cookie policy page, you must edit the following files:
 `<path-to-module>/dictionaries/policy.definition.json`
 and to modify the table in cookie policy page:
-`<path-to-simplesamlphp>/config/module_themevanilla.php`
+`<path-to-simplesamlphp>/config/module_themevanilla.php`.
 
+## Compatibility Note
+
+If you want to use the theme with **SimpleSAMLphp version greater than 1.14**, you
+need to rename the template of the discopower module:
+```
+themes/ssp/discopower/disco-tpl.php -> themes/ssp/discopower/disco.tpl.php
+```
 
 ## About SimpleSAMLphp themes
 

config-example/module_themevanilla.php

@@ -16,7 +16,8 @@
         array('type' => 'Preferences', 'provider' => 'aai.rciam.eu', 'name' => 'rciam_co_registry_tz', 'thirdParty' => false, 'category' => 'Persistent', 'purpose' => 'Preserve preferred timezone selection for COmanage RCIAM Account Registry'),
         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
 );
 
 ?>

themes/ssp/default/includes/footer.php

@@ -1,5 +1,8 @@
 
 <?php
+$themeConfig = SimpleSAML_Configuration::getConfig('module_themevanilla.php');
+$enable_cookies_banner = $themeConfig->getValue('enable_cookies_banner');
+
 if(!empty($this->data['htmlinject']['htmlContentPost'])) {
   foreach($this->data['htmlinject']['htmlContentPost'] AS $c) {
     echo $c;
@@ -9,7 +12,7 @@
   </div><!-- /container -->
   </div><!-- /ssp-container -->
 
-<?php if(strpos($this->t('{themevanilla:discopower:cookies_text}'), 'not translated') === FALSE || strpos($this->t('{themevanilla:discopower:cookies_accept_btn_text}'), 'not translated') === FALSE) { ?>
+<?php if ($enable_cookies_banner) { ?>
   <!-- cookies popup -->
   <div id="cookies">
     <div id="cookies-wrapper">

themes/ssp/discopower/disco-tpl.php

@@ -30,7 +30,7 @@
 $this->data['jquery'] = array('core' => TRUE, 'ui' => TRUE, 'css' => TRUE);
 
 
-$this->data['head'] .= '<script type="text/javascript" src="' . SimpleSAML_Module::getModuleUrl('discopower/js/jquery.livesearch.js')  . '"></script>';
+$this->data['head'] = '<script type="text/javascript" src="' . SimpleSAML_Module::getModuleUrl('discopower/js/jquery.livesearch.js')  . '"></script>';
 $this->data['head'] .= '<script type="text/javascript" src="' . SimpleSAML_Module::getModuleUrl('discopower/js/' . $this->data['score'] . '.js')  . '"></script>';
 
 $this->data['head'] .= '<script type="text/javascript">
@@ -65,7 +65,9 @@ function showEntry($t, $metadata, $favourite = FALSE, $withIcon = FALSE) {
 
 
   if($withIcon) {
-    $label =  $metadata['login_button']['label'];
+    if(isset($metadata['login_button']['label']) && !isempty($metadata['login_button']['label'])) {
+        $label =  $metadata['login_button']['label'];
+    }
     $filename = $metadata['login_button']['icon_filename'];
     $css_classname = $metadata['login_button']['css_classname'];
     $css_button_type = '';
@@ -80,7 +82,9 @@ function showEntry($t, $metadata, $favourite = FALSE, $withIcon = FALSE) {
 
     $html = '<a class="metaentry ssp-btn ' . $css_button_type  .  ' ' . $css_classname . '" href="' . $basequerystring . urlencode($metadata['entityid']) . '">';
     $html .= '<img alt="Identity Provider" class="entryicon" src="' . SimpleSAML_Module::getModuleURL('themevanilla/resources/images/' . $filename ) . '" />';
-    $html .= '<span>' . $label . '</span></a>';
+    if (isset($label)) {
+        $html .= '<span>' . $label . '</span></a>';
+    }
   }
   else {
     $html = '<a class="metaentry " href="' . $basequerystring . urlencode($metadata['entityid']) . '">';

version.txt

@@ -1,2 +1,2 @@
 simplesamlphp-module-themevanilla
-version 2.1.0
+version 2.2.0