Wiki source code of Forgot your password?

Last modified by superadmin on 2017/09/08 09:28
Hide line numbers
  1: {{velocity}}
  2: #**
  3: This page starts the password reset procedure. It works according to the next algorithm:
  4: 1. Display a form requesting the username
  5: 2. When receiving the username via form submission, generate a random verification string which is stored (as a hash) inside a ResetPasswordRequestClass object attached to the user's profile page. If no such object exists, it is created, but an existing object will be reused, meaning that at most one password reset request can be active at a moment.
  6: 3. Send an email to the address configured in the user's profile, containing a link to the second step of the password reset procedure.
  7: 
  8: URL parameters:
  9: 
 10: u = user account sent in the form
 11: *###
 12: ##
 13: ##
 14: ## The name of the class used for storing password reset verification data.
 15: #set ($verifClass = 'XWiki.ResetPasswordRequestClass')
 16: #set ($userName = "$!request.get('u')")
 17: #if ($userName == '')## First step, display the form requesting the username
 18:   {{translation key="xe.admin.passwordReset.instructions"/}}
 19: 
 20:   {{html}}
 21:   <form method="post" action="$doc.getURL()" class="xformInline">
 22:   <div>
 23:   <input type="hidden" name="form_token" value="$!{services.csrf.getToken()}" />
 24:   <label for="u">$services.localization.render('xe.admin.passwordReset.username.label')</label> <input type="text" id="u" name="u"/> <span class="buttonwrapper"><input type="submit" value="$services.localization.render('xe.admin.passwordReset.submit')" class="button"/></span>
 25:   </div>
 26:   </form>
 27:   {{/html}}
 28: #else## Second step, generate the verification string, store it, and send the email
 29:   ## TODO: Once the usernames are not bound to the XWiki space, revisit this code
 30:   #if ($userName.indexOf('.') != -1)
 31:     #set ($userDoc = $xwiki.getDocumentAsAuthor(${userName}))
 32:   #else
 33:     #set ($userDoc = $xwiki.getDocumentAsAuthor("XWiki.${userName}"))
 34:   #end
 35:   ## Check if the user exists and has a valid email address configured in his profile
 36:   #set ($userObj = '')
 37:   #set ($userObj = $userDoc.getObject('XWiki.XWikiUsers'))
 38:   #if (!$userObj)
 39: 
 40:     {{warning}}$services.localization.render('xe.admin.passwordReset.error.noUser', ["//${escapetool.xml($userName)}//"]){{/warning}}
 41: 
 42:   #elseif ($userDoc.getObject('XWiki.LDAPProfileClass'))
 43: 
 44:     {{warning}}$services.localization.render('xe.admin.passwordReset.error.ldapUser', ["//${escapetool.xml($userName)}//"]){{/warning}}
 45: 
 46:   #else
 47:     #set ($userEmail = $userObj.getProperty('email').value)
 48:     #if ("$!userEmail" == '')
 49: 
 50:       {{error}}{{translation key="xe.admin.passwordReset.error.noEmail"/}}{{/error}}
 51: 
 52:     #else
 53:       ## Find the object that will hold the verification string
 54:       #set ($verifObj = '')
 55:       #set ($verifObj = $userDoc.getObject($verifClass, true))
 56:       ## Generate a random string
 57:       #set ($verifStr = $util.generateRandomString(30))
 58:       ## If the class is correctly configured, the string should automatically be stored as a hash
 59:       #set ($discard = $verifObj.set('verification', $verifStr))
 60:       #set ($discard = $userDoc.saveAsAuthor($services.localization.render('xe.admin.passwordReset.versionComment'), true))
 61:       ## Compose the verification URL
 62:       #set ($passwordResetURL = $xwiki.getDocument('XWiki.ResetPasswordComplete').getExternalURL('view', "u=${userName}&v=${verifStr}"))
 63:       ## Send the email
 64:       #set ($from = $services.mailsender.configuration.fromAddress)
 65:       #if ("$!from" == '')
 66:         #set ($from = "no-reply@${request.serverName}")
 67:       #end
 68:       #set ($mailTemplateReference = $services.model.createDocumentReference('', 'XWiki', 'ResetPasswordMailContent'))
 69:       #set ($mailParameters = {'from' : $from, 'to' : $userEmail, 'language' : $xcontext.locale})
 70:       #set ($message = $services.mailsender.createMessage('template', $mailTemplateReference, $mailParameters))
 71:       #set ($discard = $message.setType('Reset Password'))
 72:       #macro (displayError $text)
 73: 
 74:         {{html}}
 75:           <div class="xwikirenderingerror" title="Click to get more details about the error" style="cursor: pointer;">
 76:             $services.localization.render('xe.admin.passwordReset.error.emailFailed')
 77:           </div>
 78:           <div class="xwikirenderingerrordescription hidden">
 79:             <pre>${text}</pre>
 80:           </div>
 81:         {{/html}}
 82: 
 83:       #end
 84:       ## Check for an error constructing the message!
 85:       #if ($services.mailsender.lastError)
 86:         #displayError($exceptiontool.getStackTrace($services.mailsender.lastError))
 87:       #else
 88:         ## Send the message and wait for it to be sent or for any error to be raised.
 89:         #set ($mailResult = $services.mailsender.send([$message], 'database'))
 90:         ## Check for errors during the send
 91:         #if ($services.mailsender.lastError)
 92:           #displayError($exceptiontool.getStackTrace($services.mailsender.lastError))
 93:         #else
 94:           #set ($failedMailStatuses = $mailResult.statusResult.getAllErrors())
 95:           #if ($failedMailStatuses.hasNext())
 96:             #set ($mailStatus = $failedMailStatuses.next())
 97:             #displayError($mailStatus.errorDescription)
 98:           #else
 99: 
100:             {{info}}$services.localization.render('xe.admin.passwordReset.emailSent', ["$userDoc.display('email', $userObj)"]){{/info}}
101: 
102:           #end
103:         #end
104:       #end
105:     #end
106:   #end
107:   [[{{translation key="xe.admin.passwordReset.error.retry"/}}>>$doc.fullName]] | [[{{translation key="xe.admin.passwordReset.error.recoverUsername"/}}>>ForgotUsername]] | [[{{translation key="xe.admin.passwordReset.login"/}}>>path:$xwiki.getURL('XWiki.XWikiLogin', 'login')]]
108: #end
109: ## Clear private variables, so that they cannot be accessed from the rest of the page (comments, panels...)
110: #set ($verifStr = '')
111: #set ($passwordResetURL = '')
112: {{/velocity}}