Skip to content

Commit

Permalink
SAK-32216 Add the reset password link to the external user page when …
Browse files Browse the repository at this point in the history 
…joining a site. (sakaiproject#3946)

I moved reused method into base class and added link

WL-3375 : Move Forgot password link to Accept Invitation page

Remove it from Activate your account page.
Add it to Accept Invitation page.

WL-3375 : Welcome to WebLearn 'I already have an account' page is missing 'forgotten password' link

WL-3375 Make sure we don’t NPE on bad gateway site.
  • Loading branch information
@RebeccaMiller-Which @ottenhoff
RebeccaMiller-Which authored and ottenhoff committed Feb 23, 2017
1 parent 94888da commit 26c804c
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 45 deletions.
81 changes: 81 additions & 0 deletions ...ool/src/java/org/sakaiproject/accountvalidator/tool/producers/BaseValidationProducer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,18 @@
import org.sakaiproject.authz.api.AuthzGroupService;
import org.sakaiproject.component.api.ServerConfigurationService;
import org.sakaiproject.entitybroker.DeveloperHelperService;
import org.sakaiproject.exception.IdUnusedException;
import org.sakaiproject.site.api.Site;
import org.sakaiproject.site.api.SiteService;
import org.sakaiproject.site.api.ToolConfiguration;
import org.sakaiproject.user.api.UserDirectoryService;

import uk.org.ponder.messageutil.TargettedMessage;
import uk.org.ponder.messageutil.TargettedMessageList;
import uk.org.ponder.rsf.components.UIBranchContainer;
import uk.org.ponder.rsf.components.UIContainer;
import uk.org.ponder.rsf.components.UILink;
import uk.org.ponder.rsf.components.UIMessage;
import uk.org.ponder.rsf.flow.ARIResult;
import uk.org.ponder.rsf.viewstate.RawViewParameters;
import uk.org.ponder.rsf.viewstate.ViewParameters;
Expand Down Expand Up @@ -119,6 +124,82 @@ public ValidationAccount getValidationAccount(ViewParameters viewparams, Targett
return va;
}


/**
* Adds a link to the page for the user to request another validation token
* @param toFill the parent of the link
*/
protected void addResetPassLink(UIContainer toFill, ValidationAccount va)
{
if (toFill == null || va == null)
{
// enforce method contract
throw new IllegalArgumentException("null passed to addResetPassLink()");
}

//the url to reset-pass - assume it's on the gateway. Otherwise, we don't render a link and we log a warning
String url = null;
try
{
//get the link target
url = getPasswordResetUrl();
}
catch (IllegalArgumentException e)
{
log.warn("Couldn't create a link to reset-pass; no instance of reset-pass found on the gateway");
}

if (url != null)
{
//add the container
UIBranchContainer requestAnotherContainer = UIBranchContainer.make(toFill, "requestAnotherContainer:");
//add a label
UIMessage.make(requestAnotherContainer, "request.another.label", "validate.requestanother.label");
//add the link to reset-pass
String requestAnother = null;
if (ValidationAccount.ACCOUNT_STATUS_PASSWORD_RESET == va.getAccountStatus())
{
requestAnother = messageLocator.getMessage("validate.requestanother.reset");
}
else
{
requestAnother = messageLocator.getMessage("validate.requestanother");
}
UILink.make(requestAnotherContainer, "request.another", requestAnother, url);
}
//else - there is no reset pass instance on the gateway, but the user sees an appropriate message regardless (handled by a targetted message)
}

/**
* Gets the password reset URL. If looks for a configured URL, otherwise it looks
* for the password reset tool in the gateway site and builds a link to that.
* @return The password reset URL or <code>null</code> if there isn't one or we
* can't find the password reset tool.
*/
public String getPasswordResetUrl()
{
// Has a password reset url been specified in sakai.properties? If so, it rules.
String passwordResetUrl = serverConfigurationService.getString("login.password.reset.url", null);

if(passwordResetUrl == null) {
// No explicit password reset url. Try and locate the tool on the gateway page.
// If it has been installed we'll use it.
String gatewaySiteId = serverConfigurationService.getGatewaySiteId();
Site gatewaySite = null;
try {
gatewaySite = siteService.getSite(gatewaySiteId);
ToolConfiguration resetTC = gatewaySite.getToolForCommonId("sakai.resetpass");
if(resetTC != null) {
passwordResetUrl = resetTC.getContainingPage().getUrl();
}
} catch (IdUnusedException e) {
log.warn("No " + gatewaySiteId + " site found whilst building password reset url, set password.reset.url" +
" or create " + gatewaySiteId + " and add password reset tool.");
}
}
return passwordResetUrl;
}

/**
* Determines if the accountValidator.sendLegacyLinks property is enabled - ie. whether the account validation form is one single page or split up
*/
Expand Down
45 changes: 0 additions & 45 deletions ...tool/src/java/org/sakaiproject/accountvalidator/tool/producers/PasswordResetProducer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -252,51 +252,6 @@ public String getFormattedMinutes(int totalMinutes)
return periodFormatter.print(period);
}

/**
* Adds a link to the page for the user to request another validation token
* @param tofill the parent of the link
*/
private void addResetPassLink(UIContainer toFill, ValidationAccount va)
{
if (toFill == null || va == null)
{
// enforce method contract
throw new IllegalArgumentException("null passed to addResetPassLink()");
}

//the url to reset-pass - assume it's on the gateway. Otherwise, we don't render a link and we log a warning
String url = null;
try
{
//get the link target
url = developerHelperService.getToolViewURL("sakai.resetpass", null, null, developerHelperService.getStartingLocationReference());
}
catch (IllegalArgumentException e)
{
log.warn("Couldn't create a link to reset-pass; no instance of reset-pass found on the gateway");
}

if (url != null)
{
//add the container
UIBranchContainer requestAnotherContainer = UIBranchContainer.make(toFill, "requestAnotherContainer:");
//add a label
UIMessage.make(requestAnotherContainer, "request.another.label", "validate.requestanother.label");
//add the link to reset-pass
String requestAnother = null;
if (ValidationAccount.ACCOUNT_STATUS_PASSWORD_RESET == va.getAccountStatus())
{
requestAnother = messageLocator.getMessage("validate.requestanother.reset");
}
else
{
requestAnother = messageLocator.getMessage("validate.requestanother");
}
UILink.make(requestAnotherContainer, "request.another", requestAnother, url);
}
//else - there is no reset pass instance on the gateway, but the user sees an appropriate message regardless (handled by a targetted message)
}

/**
* When a user's validation token expires (by accountValidator.maxPasswordResetMinutes elapsing)
* this returns an appropriate TargettedMessage
Expand Down
2 changes: 2 additions & 0 deletions ...rc/java/org/sakaiproject/accountvalidator/tool/producers/TransferMembershipsProducer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,8 @@ else if (sendLegacyLinksEnabled())
UIMessage.make(tofill, "transferInstructions", "validate.loginexisting.transfer", args);
UIMessage.make(tofill, "validate.alreadyhave", "validate.alreadyhave", args);

addResetPassLink(tofill, va);

Object[] displayIdArgs = new Object[]{u.getDisplayId()};
UIForm claimForm = UIForm.make(tofill, "claimAccountForm");
UIMessage.make(claimForm, "validate.loginexisting", "validate.loginexisting.accountReserved", displayIdArgs);
Expand Down
3 changes: 3 additions & 0 deletions reset-pass/account-validator-tool/src/webapp/templates/transferMemberships.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ <h3 rsf:id="welcome1">Welcome to Sakai!</h3>
</form>
</div>
</fieldset>
<div rsf:id="requestAnotherContainer:" class="instruction">
<span rsf:id="request.another.label">Forgot your password?</span>&nbsp;<a rsf:id="request.another">Request again.</a>
</div>
</div>
</body>
</html>

0 comments on commit 26c804c

Please sign in to comment.