Registration (XWiki.org)

[[$msg.get('xe.admin.registration.youCanConfigureRegistrationHere')>>XWiki.XWikiPreferences?section=Registration&editor=globaladmin#HCustomizeXWikiRegistration]]

454

{{html}}<a href="$xwiki.getURL($documentName, 'edit', 'editor=wiki')">$msg.get('xe.admin.registration.youCanConfigureRegistrationFieldsHere')</a>{{/html}}

455

#end

456

## If the registration is done (successful) and we detect the Lightbox simply send the user back to the original page.

457

#elseif($assumeLightbox)

458

459

460

var url = window.lb.redirectUrl;

461

window.lb.lbClose;

462

if (url != undefined) {

463

if(window.location.pathname + window.location.search == url) {

464

## Under certain circumstances (bug) Opera will not load a page if the location is the same as the current page.

465

## In these cases, location.reload() doesn't work either, the only solution (I could find) was to change the URL.

466

window.location.href = url + "&";

467

} else {

468

window.location.href = url;

}

}

</script>

#end

##

####### The Macros (nothing below this point is run directly) #########

476

#*

477

* Server side validation, this is necessary for security and because not everyone has Javascript

478

*

479

* @param $fields The array of fields to validate.

480

* @param $request An XWikiRequest object which made the register request, used to get parameters.

481

*###

482

#macro(validateFields, $fields, $request)

483

#foreach($field in $fields)

484

#if($field.get('validate') && $field.get('name'))

485

#set($fieldName = $field.get('name'))

486

#set($validate = $field.get('validate'))

487

#set($error = '')

488

#set($value = $request.get($fieldName))

489

#if($value && $value != '')

490

##

491

## mustMatch validation

492

#if($error == '' && $validate.get('mustMatch'))

493

#set($mustMatch = $validate.get('mustMatch'))

494

#if($mustMatch.get('name') && $mustMatch.get('failureMessage'))

495

#if($request.get($fieldName) != $request.get($mustMatch.get('name')))

496

#set($error = $mustMatch.get('failureMessage'))

497

#end

498

#else

499

ERROR: In field: ${fieldName}: mustMatch validation required both name

500

(of field which this field must match) and failureMessage.

#end

#end

##

## Regex validation

## We won't bother with regex validation if there is no entry, that would defeat the purpose of 'mandatory'

506

#if($error == '' && $validate.get('regex') && $value && $value != '')

507

#set($regex = $validate.get('regex'))

508

#if($regex.get('pattern') && $regex.get('failureMessage'))

509

## Make Java regexes more compatible with Perl/js style regexes by removing leading and trailing /

510

#if($regex.get('pattern').length() > 1)

511

#set($pattern = $regex.get('pattern'))

512

#if($pattern.lastIndexOf('/') < $pattern.length() - 1)

513

ERROR: In field: ${fieldName}: regex validation does not allow flags after the /, please fix [${pattern}].

514

#end

515

#set($pattern = $pattern.substring($mathtool.add(1, $pattern.indexOf('/')), $pattern.lastIndexOf('/')))

516

#else

517

## I don't expect this but want to maintain compatibility.

518

#set($pattern = $regex.get('pattern'))

519

#end

520

#if($regextool.find($value, $pattern).isEmpty())

521

#set($error = $regex.get('failureMessage'))

522

#end

523

#elseif($regex.get('pattern'))

524

ERROR: In field: ${fieldName}: regex validation must include failureMessage.

#end

#end

##

## If regex and mustMatch validation passed, try programmatic validation

529

#if($error == '' && $validate.get('programmaticValidation'))

530

#set($pv = $validate.get('programmaticValidation'))

531

#if($pv.get('code') && $pv.get('failureMessage'))

532

#set($pvReturn = "#evaluate($pv.get('code'))")

533

#if($pvReturn.indexOf('failed') != -1)

534

#set($error = $pv.get('failureMessage'))

535

#end

536

#else

537

ERROR: In field: ${fieldName}: programmaticValidation requires code and failureMessage

#end

#end

#else

##

## If no content, check if content is mandatory

543

#if($validate.get('mandatory'))

544

#set($mandatory = $validate.get('mandatory'))

545

#if($mandatory.get('failureMessage'))

546

#set($error = $mandatory.get('failureMessage'))

547

#else

548

ERROR: In field: ${fieldName}: mandatory validation requires a failureMessage

#end

#end

#end

#if($error != '')

#set($discard = $field.put('error', $error))

554

#set($registrationFailed = true)

555

#end

556

#elseif(!$field.get('name'))

557

ERROR: Field with no name.

#end##if(validate)

#end##loop

#end##macro

#*

* Create the user.

* Calls $xwiki.createUser to create a new user.

564

*

565

* @param $request An XWikiRequest object which made the register request.

566

* @param $response The XWikiResponse object to send any redirects to.

567

* @param $doAfterRegistration code block to run after registration completes successfully.

568

*###

569

#macro(createUser, $fields, $request, $response, $doAfterRegistration)

570

## CSRF check

571

#if(${services.csrf.isTokenValid("$!{request.getParameter('form_token')}")})

572

## See if email verification is required and register the user.

573

#if($xwiki.getXWikiPreferenceAsInt('use_email_verification', 0) == 1)

574

#set($reg = $xwiki.createUser(true))

575

#else

576

#set($reg = $xwiki.createUser(false))

577

#end

578

#else

579

$response.sendRedirect("$!{services.csrf.getResubmissionURL()}")

580

#end

581

##

582

## Handle output from the registration.

583

#if($reg && $reg <= 0)

584

585

#if($reg == -2)

586

$msg.get('core.register.passwordMismatch')

587

## -3 means username taken, -8 means username is superadmin name

588

#elseif($reg == -3 || $reg == -8)

589

$msg.get('core.register.userAlreadyExists')

590

#elseif($reg == -4)

591

$msg.get('core.register.invalidUsername')

592

#else

593

$msg.get('core.register.registerFailed', [$reg])

#end

#elseif($reg)

## Registration was successful

598

#set($registrationDone = true)

599

##

600

## If there is any thing to "doAfterRegistration" then do it.

601

#foreach($field in $fields)

602

#if($field.get('doAfterRegistration'))

603

#evaluate($field.get('doAfterRegistration'))

604

#end

605

#end

606

## If there is a "global" doAfterRegistration, do that as well.

607

#if($doAfterRegistration)

608

#set($discard = $doAfterRegistration.toString())

609

#end

610

## Define some strings which may be used by autoLogin or loginButton

611

#set($userName = $!request.get('xwikiname'))

612

#set($password = $!request.get('register_password'))

613

#set($loginURL = $xwiki.getURL($loginPage, $loginAction))

614

#if("$!request.getParameter($redirectParam)" != '')

615

#set($redirect = $request.getParameter($redirectParam))

616

#else

617

#set($redirect = $defaultRedirect)

618

#end

619

## Display a "registration successful" message

620

621

#evaluate($registrationSuccessMessage)

622

623

## Empty line prevents message from being forced into a <p> block.

624

625

## Give the user a login button which posts their username and password to loginsubmit

#if($loginButton)

</span>

</div>

</form>

## We don't want autoLogin if we are administrators adding users...

641

#if($autoLogin && !$assumeLightbox)

642

643

document.observe('xwiki:dom:loaded', function() {

644

document.forms['loginForm'].submit();

});

</script>

#end

#end

#end

##

#end## createUser Macro

654

#*

655

* Generate HTML form, this is the only place where HTML is written.

656

*

657

* @param $fields The array of fields to use for generating html code.

658

* @param $fieldMandatoryStar The tag parameters for a * indicating a mandatory field.

659

* @param $failureMessageParams The tag parameters for a failure message.

660

*###

661

#macro(generateHtml, $fields, $fieldMandatoryStar, $failureMessageParams)

662

## Put the same values back into the fields.

#getParams($fields)

##

<dl>

#foreach($field in $fields)

667

#if($field.get('name'))

668

#set($fieldName = $field.get('name'))

669

#if($field.get('label'))

670

#set($label = $field.get('label'))

671

<dt><label for="$fieldName">$label

672

#if($field.get('validate').get('mandatory'))

673

<span ##

674

#foreach($entry in $fieldMandatoryStar.entrySet())

675

$entry.getKey()="$entry.getValue()" ##

676

#end

677

>$msg.get('core.validation.required')</span>

#end

</label>

</dt>

#end

## If no tag then default tag is <input>

683

#if($field.get('tag'))

684

#set($tag = $field.get('tag'))

#else

#set($tag = 'input')

#end

<dd><$tag id="$fieldName" ##

689

#set($params = $field.get('params'))

690

## If no name parameter is spacified, then we use the field name

691

#if(!$params.get('name'))

692

#set($discard = $params.put('name', $fieldName))

693

#end

694

#foreach($entry in $params.entrySet())

695

## If a parameter is specified as '' then we don't include it.

696

#if($entry.getValue() != '')

697

$entry.getKey()="$escapetool.xml($entry.getValue())" ##

#end

#end

></$tag>

#if($field.get('error'))

702

<span ##

703

#foreach($entry in $failureMessageParams.entrySet())

704

$entry.getKey()="$entry.getValue()" ##

705

#end

706

>$field.get('error')</span>

#end

</dd>

#else

ERROR: Field with no name.

711

#end##if fieldName exists

#end

</dl>

#end

#*

* Generate the Javascript for interacting with LiveValidation.

717

*

718

* @param $fields The array of fields which to validate.

719

*###

720

#macro(generateJavascript, $fields)

721

722

/* <![CDATA[ */

723

document.observe('xwiki:dom:loaded', function() {

724

##

725

#foreach($field in $fields)

726

#if($field.get('validate') && $field.get('name'))

727

#set($validate = $field.get('validate'))

728

#if(($validate.get('mandatory') && !$validate.get('mandatory').get('noscript'))

729

|| ($validate.get('regex') && !$validate.get('regex').get('noscript'))

730

|| ($validate.get('mustMatch') && !$validate.get('mustMatch').get('noscript')))

731

#set($fieldName = $field.get('name'))

732

#if($validate.get('fieldOkayMessage'))

733

#set($okayMessage = $validate.get('fieldOkayMessage'))

734

#else

735

#set($okayMessage = $defaultFieldOkayMessage)

736

#end

737

var ${fieldName}Validator = new LiveValidation("$fieldName", { validMessage: "$okayMessage", wait: 500} );

738

##

739

#if($validate.get('mandatory'))

740

#set($mandatory = $validate.get('mandatory'))

741

#if($mandatory.get('failureMessage') && !$mandatory.get('noscript'))

742

${fieldName}Validator.add( Validate.Presence, { failureMessage: "$!mandatory.get('failureMessage')"} );

#end

#end

##

#if($validate.get('mustMatch'))

747

#set($mustMatch = $validate.get('mustMatch'))

748

#if($mustMatch.get('name') && $mustMatch.get('failureMessage') && !$mustMatch.get('noscript'))

749

${fieldName}Validator.add( Validate.Confirmation, { match: $$("input[name=$!mustMatch.get('name')]")[0], failureMessage: "$!mustMatch.get('failureMessage')"} );

#end

#end

##

#if($validate.get('regex'))

754

#set($regex = $validate.get('regex'))

755

#set($pattern = "")

756

#if($regex.get('jsPattern'))

757

#set($pattern = $regex.get('jsPattern'))

758

#elseif($regex.get('pattern'))

759

#set($pattern = $regex.get('pattern'))

760

#end

761

#set($failMessage = "")

762

#if($regex.get('jsFailureMessage'))

763

#set($failMessage = $regex.get('jsFailureMessage'))

764

#elseif($regex.get('failureMessage'))

765

#set($failMessage = $regex.get('failureMessage'))

766

#end

767

#if($pattern != '' && $failMessage != '' && !$regex.get('noscript'))

768

${fieldName}Validator.add( Validate.Format, { pattern: $pattern, failureMessage: "$failMessage"} );

769

#end

770

#end##if regex

771

#end##if contains js validateable fields.

#end##if validate

#end##loop

});// ]]>

</script>

#end##macro

#*

* Get parameters from request so that values will be filled in if there is a mistake

779

* in one of the entries. Entries will be returned to fields[n].params.value

780

* Fields will not be returned if they have either noReturn or error specified.

781

*

782

* @param $fields The array of fields to get parameters for.

783

*###

784

#macro(getParams $fields)

785

#foreach($field in $fields)

786

#if($field.get('name') && $request.get($field.get('name')))

787

#if(!$field.get('noReturn') && !$field.get('error'))

788

#if(!$field.get('params'))

789

#set($params = {})

790

#set($discard = $field.put('params', $params))

791

#else

792

#set($params = $field.get('params'))

793

#end

794

#set($discard = $params.put('value', $request.get($field.get('name'))))

#end

#end

#end

#end

#*

* Get the configuration from the configuration object.

801

*

802

* @param $configDocumentName The name of the document to get the configuration from.

803

*###

804

#macro(loadConfig, $configDocumentName)

805

#set($configDocument = $xwiki.getDocument($configDocumentName))

806

#if(!$configDocument || !$configDocument.getObject($documentName))

807

## No config document, load defaults.

808

#set($heading = "$msg.get('core.register.title')")

809

#set($welcomeMessage = "$msg.get('core.register.welcome')")

810

#set($useLiveValidation = true)

811

#set($defaultFieldOkayMessage = "$msg.get('core.validation.valid.message')")

812

#set($loginButton = true)

813

#set($defaultRedirect = "$xwiki.getURL('Main.WebHome')")

814

#set($userFullName = "$request.get('register_first_name') $request.get('register_last_name')")

815

#set($registrationSuccessMessage = '{{info}}$msg.get("core.register.successful", ["[[${userFullName}>>${userSpace}${userName}]]", ${userName}]){{/info}}')

816

#else

817

#set($configObject = $configDocument.getObject($documentName))

818

#if ($context.action == 'register')

819

#set ($heading = "(% id='document-title'%)((( = #evaluate($configObject.getProperty('heading').getValue()) = )))(%%)")

820

#else

821

#set ($heading = "= #evaluate($configObject.getProperty('heading').getValue()) =")