Merge pull request #71 from silinternational/links-of-desire

users wanted a way to get to their profile and help docs

Author: longrunningprocess

README.md

@@ -103,6 +103,13 @@ If provided, an alert will be shown to the user filled with the content of that
 1.  Click **idp2** (second one)
 1.  Forgot password link should be visible
 
+### Helpful links functionality
+
+1.  Goto [SP 1](http://ssp-sp1.local:8082/module.php/core/authenticate.php?as=hub-discovery)
+1.  Click **idp4** (third one)
+1.  Help link should be visible under login form
+1.  Profile link should be visible under login form
+
 ### Expiry functionality
 
 #### About to expire page

dictionaries/login.definition.json

@@ -46,5 +46,17 @@
 		"es": "Logotipo de {idpName}",
 		"fr": "Logo {idpName}",
 		"ko": "{idpName} 로고"
+	},
+	"help": {
+		"en": "I need help",
+		"es": "necesito ayuda",
+		"fr": "j'ai besoin d'aide",
+		"ko": "도움이 필요해."
+	},
+	"profile": {
+		"en": "Manage my profile",
+		"es": "Administrar mi perfil",
+		"fr": "Gérer mon profil",
+		"ko": "내 프로필 관리"
 	}
 }

docker-compose.yml

@@ -83,10 +83,10 @@ services:
       IDP_NAME: "idp-2"
       IDP_DISPLAY_NAME: "IdP 2"
       ANALYTICS_ID: "UA-XXXX-Y"
-      PASSWORD_CHANGE_URL:  "http://example.org"
-      PASSWORD_FORGOT_URL:  "http://example.org"
+      PASSWORD_CHANGE_URL:  "https://example.org/change"
+      PASSWORD_FORGOT_URL:  "https://example.org/forgot"
 
-  idp4:  # used for mfa testing
+  idp4:  # used for mfa testing (as well as some helpful links)
     image: silintl/ssp-base:local-testing-with-develop-deps
     volumes:
       - ./development/cert:/data/vendor/simplesamlphp/simplesamlphp/cert
@@ -126,6 +126,7 @@ services:
       ID_BROKER_BASE_URI: "http://broker"
       REMEMBER_ME_SECRET: "dummy"
       PROFILE_URL: "https://example.org/profile"
+      HELP_CENTER_URL: "https://example.org/help"
     command: ["bash", "-c", "whenavail silAuthDb 3306 60 ./run-idp.sh"]
 
   silAuthDb:

themes/material/core/loginuserpass.php

@@ -45,17 +45,16 @@ function onRecaptchaLoad() {
         <?php include __DIR__ . '/../common-announcement.php' ?>
 
         <form method="post" autocomplete="off">
-            <input type="hidden" name="AuthState"
-                   value="<?= htmlentities($this->data['stateparams']['AuthState']) ?>" />
+            <input type="hidden" name="AuthState" value="<?= htmlentities($this->data['stateparams']['AuthState']) ?>" />
+
             <?php
             $csrfToken = htmlentities($this->data['csrfToken']);
             ?>
             <input type="hidden" name="csrf-token" value="<?= $csrfToken ?>" />
 
             <div class="mdl-card mdl-shadow--8dp fill-phone-viewport">
                 <div class="mdl-card__media white-bg margin" layout-children="column">
-                    <img src="/logo.png"
-                         alt="<?= $this->t('{material:login:logo}', ['{idpName}' => $idpName]) ?>">
+                    <img src="/logo.png" alt="<?= $this->t('{material:login:logo}', ['{idpName}' => $idpName]) ?>">
                 </div>
 
                 <div class="mdl-card__title center">
@@ -69,20 +68,21 @@ function onRecaptchaLoad() {
                         <label for="username" class="mdl-textfield__label">
                             <?= $this->t('{material:login:label_username}') ?>
                         </label>
+
                         <?php
                         $username = htmlentities($this->data['username'] ?? null);
                         ?>
-                        <input type="text" name="username" class="mdl-textfield__input"
-                               value="<?= $username ?>" <?= empty($username) ? 'autofocus' : '' ?>
-                               id="username"/>
+                        <input type="text" name="username" class="mdl-textfield__input" value="<?= $username ?>" 
+                               <?= empty($username) ? 'autofocus' : '' ?> id="username"/>
                     </div>
 
                     <div class="mdl-textfield mdl-js-textfield mdl-textfield--floating-label">
                         <label for="password" class="mdl-textfield__label">
                             <?= $this->t('{material:login:label_password}') ?>
                         </label>
-                        <input type="password" name="password" class="mdl-textfield__input"
-                               <?= ! empty($username) ? 'autofocus' : '' ?> id="password"/>
+
+                        <input type="password" name="password" class="mdl-textfield__input" <?= ! empty($username) ? 'autofocus' : '' ?> 
+                               id="password"/>
                     </div>
                 </div>
 
@@ -114,8 +114,7 @@ function onRecaptchaLoad() {
                     $forgotPasswordUrl = htmlentities($this->configuration->getValue('passwordForgotUrl'));
                     if (! empty($forgotPasswordUrl)) {
                     ?>
-                    <a href="<?= $forgotPasswordUrl ?>" target="_blank"
-                       class="mdl-button mdl-button--colored mdl-typography--caption">
+                    <a href="<?= $forgotPasswordUrl ?>" target="_blank" class="mdl-button mdl-button--colored mdl-typography--caption">
                         <?= $this->t('{material:login:forgot}') ?>
                     </a>
                     <?php
@@ -129,6 +128,20 @@ class="mdl-button mdl-button--colored mdl-typography--caption">
                     </button>
                 </div>
             </div>
+
+            <section layout-children="row" child-spacing="space-around">
+                <?php if (! empty($this->data['helpCenterUrl'])): ?>
+                <a href="<?= $this->data['helpCenterUrl'] ?>" target="_blank">
+                    <?= $this->t('{material:login:help}') ?>
+                </a>
+                <?php endif; ?>
+
+                <?php if (! empty($this->data['profileUrl'])): ?>
+                <a href="<?= $this->data['profileUrl'] ?>" target="_blank">
+                    <?= $this->t('{material:login:profile}') ?>
+                </a>
+                <?php endif; ?>
+            </section>
         </form>
     </main>
 </div>