Many small optimizations for #2789

README

@@ -101,7 +101,9 @@ a2enmod headers
 Subversion access:
 Check out the latest SWITHCHwayf code with:
 svn co https://subversion.switch.ch/svn/general/aai/SWITCHwayf/
-Although the code in the Subversion should be always executable, it should be considered unstable and not be used for production environments without prior testing. 
+Although the code in the Subversion should be always executable, it should be 
+considered unstable and not be used for production environments without prior 
+testing. 
 
 
 -------------------------------------------------------------------------------
@@ -143,6 +145,13 @@ Updates from versions before 1.18
   description on these settings. The make sure to configure them to config.php
   which should contain your own configuration. Otherwise, default values
   will be set.
+  Also the default behaviour for the Embedded WAYF setting
+  wayf_use_small_logo was changed from false to true as most instances
+  of the Embedded WAYF seem to prefer the small logo. All non-mandatory
+  settings of the Embedded WAYF are now commented out in the default 
+  templated generated for the Embedded WAYF. This implies that
+  if there are Service Providers using your Embedded WAYF feature, they might
+  have to review their Embedded WAYF settings.
 
 
 Updates from versions before 1.15

config.dist.php

@@ -15,6 +15,7 @@
 // as last resort.
 //$defaultLanguage = 'en'; 
 
+
 // 2. Cookie settings
 //*******************
 
@@ -51,6 +52,7 @@
 // Number of days longterm cookies should be valid
 //$cookieValidity = 100;
 
+
 // 3. Features and extensions
 //***************************
 
@@ -157,19 +159,23 @@
 
 // URL to send user to when clicking on federation logo
 // Insert %s as macro to be substituted by the language (e.g. 'en', 'de', 'fr', ...) the WAYF uses
+// Set to an empty string to hide the logo
 //$federationURL = 'http://www.example.org/myFed/';
 
 // Absolute URL to the federation logo that should be displayed in the Embedded WAYF
-//$logoURL = 'http://ds.example.org/SWITCHwayf/images/federation-logo.png'; 
+// Set to an empty string to hide the logo
+//$logoURL = 'http://ds.example.org/SWITCHwayf/images/federation-logo.png';
 
 // Absolute URL to the small federation logo that should be displayed in the 
-// embedded WAYF if dimensions must be small
+// embedded WAYF. Make sure the dimensions (in particular the height of the logo)
+// is small, ideally not larger than 120x30 pixel
 //$smallLogoURL = 'http://ds.example.org/SWITCHwayf/images/small-federation-logo.png';
 
 // Support contact email address
 //$supportContactEmail = 'helpdesk@example.org';
 
 // Absolute URL to the logo of the organization operating this Discovery Service
+// Set to an empty string to hide the logo
 //$organizationLogoURL = 'https://ds.example.org/SWITCHwayf/images/organization-logo.png'; 
 
 // Absolute URL to the organization's web page
@@ -179,14 +185,17 @@
 // Absolute URL to an FAQ page
 // This entries local string is 'faq' in languages.php
 // Insert %s as macro to be substituted by the language (e.g. 'en', 'de', 'fr', ...) the WAYF uses
+// Set to an empty string to hide the logo
 //$faqURL = 'http://www.example.org/%s/myFed/faq/';
 
 // Absolute URL to a help/support page
 // Insert %s as macro to be substituted by the language (e.g. 'en', 'de', 'fr', ...) the WAYF uses
+// Set to an empty string to hide the logo
 //$helpURL = 'http://www.example.org/%s/myFed/help/';
 
 // Absolute URL to a privacy policy page
 // Insert %s as macro to be substituted by the language (e.g. 'en', 'de', 'fr', ...) the WAYF uses
+// Set to an empty string to hide the logo
 //$privacyURL = 'http://www.example.org/%s/myFed/privacy/';
 
 

css/default-styles.css

@@ -43,17 +43,18 @@ input {
 	margin-bottom: 0;
 }
 
-.box {
-	width:600px;
+.box
+{
+	width: 600px;
 	text-align: center;
 	background-color: #FFFFFF;
 	box-shadow: 1px 1px 8px #999999;
-	border-radius: 13px;  
+	border-radius: 13px;
 	-webkit-box-shadow: 1px 1px 8px #999999;
 	-webkit-border-radius: 13px;
 	-moz-box-shadow: 1px 1px 8px #999999;
 	-moz-border-radius: 13px;
-	padding: 24px;
+	padding: 10px 24px 10px 24px;
 }
 
 
@@ -109,13 +110,11 @@ input {
 
 #header {
 	width: 100%;
-	height: 50px;
+	display: inline-block;
 	text-align: left;
 }
 
 #federationLogo {
-	margin-top: 32px;
-	margin-left: 2px;
 	border: 0;
 	float: left;
 }

default-embedded-wayf.php

@@ -40,9 +40,7 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome"
 // Add 2 x (10px + 1px) = 22px for padding and border to get the actual 
 // width of everything that is drawn.
 // [Optional, default: "auto"]
-// Example for fixed size: 
 // var wayf_width  = 250;
-var wayf_width = "auto";
 
 // Height of the embedded WAYF in pixels or "auto"
 // This is the height of the content only (without padding and border). 
@@ -51,46 +49,36 @@ var wayf_width = "auto";
 // [Optional, default: "auto"]
 // Example for fixed size: 
 // var wayf_height = 150;
-var wayf_height = "auto";
 
 // Whether to show the checkbox to remember settings for this session
 // [Optional, default: true]
-var wayf_show_remember_checkbox = true;
-
-// Force the user's Home Organisation selection to be remembered for the
-// current browser session. If wayf_show_remember_checkbox is true
-// the checkbox will be shown but will be read only.
-// WARNING: Only use this feature if you know exactly what you are doing
-//          This option will cause problems that are difficult to find 
-//          in case they accidentially select a wrong Home Organisation
-// [Optional, false]
-var wayf_force_remember_for_session = false;
+//var wayf_show_remember_checkbox = true;
 
 // Logo size
 // Choose whether the small or large logo should be used
 // [Optional, default: true]
-var wayf_use_small_logo = true;
+//var wayf_use_small_logo = true;
 
 // Font size
 // [Optional, default: 12]
-var wayf_font_size = 12;
+//var wayf_font_size = 12;
 
-// Font color
+// Font color as CSS color value, e.g. 'black' or '#000000'
 // [Optional, default: #000000]
-var wayf_font_color = '#000000';
+//var wayf_font_color = '#000000';
 
-// Border color
+// Border color as CSS color value, e.g. 'black' or '#000000'
 // [Optional, default: #848484]
-var wayf_border_color = '#848484';
+//var wayf_border_color = '#848484';
 
-// Background color
+// Background color as CSS color value, e.g. 'black' or '#000000'
 // [Optional, default: #F0F0F0]
-var wayf_background_color = '#F0F0F0';
+//var wayf_background_color = '#F0F0F0';
 
 // Whether to automatically log in user if he has a session/permanent redirect
 // cookie set at central wayf
 // [Optional, default: true]
-var wayf_auto_login = true;
+//var wayf_auto_login = true;
 
 // Whether to hide the WAYF after the user was logged in
 // This requires that the _shib_session_* cookie is set when a user 
@@ -98,12 +86,12 @@ var wayf_auto_login = true;
 // For other Service Provider implementations have a look at the setting
 // wayf_check_login_state_function that allows you to customize this
 // [Optional, default: true]
-var wayf_hide_after_login = true;
+// var wayf_hide_after_login = true;
 
 // Whether or not to show the categories in the drop-down list
 // Possible values are: true or false
 // [Optional, default: true]
-var wayf_show_categories =  true;
+// var wayf_show_categories =  true;
 
 // Most used Identity Providers will be shown as top category in the drop down
 // list if this feature is used.
@@ -142,6 +130,15 @@ var wayf_show_categories =  true;
 // [Optional, default: commented out]
 // var wayf_use_discovery_service = false;
 
+// Force the user's Home Organisation selection to be remembered for the
+// current browser session. If wayf_show_remember_checkbox is true
+// the checkbox will be shown but will be read only.
+// WARNING: Only use this feature if you know exactly what you are doing
+//          This option will cause problems that are difficult to find 
+//          in case they accidentially select a wrong Home Organisation
+// [Optional, false]
+//var wayf_force_remember_for_session = false;
+
 // Session Initiator URL of the Service Provider
 // Examples: "https://interact.switch.ch/Shibboleth.sso/Login", "https://dokeos.unige.ch/Shibboleth.sso/DS"
 // This will implicitely be set to wayf_sp_samlDSURL = wayf_sp_handlerURL + "/Login";

default-header.php

@@ -109,14 +109,26 @@
 <div id="container">
 	<div class="box">
 		<div id="header">
+			<?php if (!empty($logoURL)) { ?>
 			<a href="<?php echo sprintf($federationURL, $language) ?>"><img src="<?php echo $logoURL ?>" alt="Federation Logo" id="federationLogo"></a>
+			<?php } ?>
+			<?php if (!empty($organizationLogoURL)) { ?>
 			<a href="<?php echo sprintf($organizationURL, $language) ?>"><img src="<?php echo $organizationLogoURL ?>" alt="Organization Logo" id="organisationLogo"></a>
+			<?php } ?>
 		</div>
 			<div id="content">
 				<ul class="menu">
-				  <li><a href="<?php echo sprintf($federationURL, $language) ?>"><?php echo getLocalString('about_federation'); ?></a></li>
-				  <li class="last"><a href="<?php echo sprintf($faqURL, $language) ?>"><?php echo getLocalString('faq') ?></a></li>
-				  <li class="last"><a href="<?php echo sprintf($helpURL, $language) ?>"><?php echo getLocalString('help') ?></a></li>
-				  <li class="last"><a href="<?php echo sprintf($privacyURL, $language) ?>"><?php echo getLocalString('privacy') ?></a></li>
+					<?php if (!empty($federationURL) && getLocalString('about_federation') != '') { ?>
+					<li><a href="<?php echo sprintf($federationURL, $language) ?>"><?php echo getLocalString('about_federation'); ?></a></li>
+					<?php } ?>
+					<?php if (!empty($faqURL) && getLocalString('faq') != '') { ?>
+					<li class="last"><a href="<?php echo sprintf($faqURL, $language) ?>"><?php echo getLocalString('faq') ?></a></li>
+					<?php } ?>
+					<?php if (!empty($helpURL) && getLocalString('help') != '') { ?>
+					<li class="last"><a href="<?php echo sprintf($helpURL, $language) ?>"><?php echo getLocalString('help') ?></a></li>
+					<?php } ?>
+					<?php if (!empty($privacyURL) && getLocalString('privacy') != '') { ?>
+					<li class="last"><a href="<?php echo sprintf($privacyURL, $language) ?>"><?php echo getLocalString('privacy') ?></a></li>
+					<?php } ?>
 				</ul>
 <!-- Body: Start -->