Registration (XWiki.org)

[[{{translation key="xe.admin.registration.youCanConfigureRegistrationHere"/}}>>XWiki.XWikiPreferences?section=Registration&editor=globaladmin#HCustomizeXWikiRegistration]]

462

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

463

#end

464

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

465

#elseif($assumeLightbox)

466

467

468

var url = window.lb.redirectUrl;

469

window.lb.lbClose;

470

if (url != undefined) {

471

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

472

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

473

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

474

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

475

} else {

476

window.location.href = url;

}

}

</script>

#end

#else

## The registration is not allowed on the subwiki

484

## Redirecting to main wiki's registration page since local user registration is not allowed.

485

#set($mainWikiRegisterPageReference = $services.model.createDocumentReference($services.wiki.mainWikiId, 'XWiki', 'Register'))

486

#set($temp = $response.sendRedirect($xwiki.getURL($mainWikiRegisterPageReference, 'register', $request.queryString)))

487

#end

488

##

489

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

490

#*

491

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

492

*

493

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

494

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

495

*###

496

#macro(validateFields, $fields, $request)

497

#foreach($field in $fields)

498

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

499

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

500

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

501

#set($error = '')

502

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

503

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

504

##

505

## mustMatch validation

506

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

507

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

508

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

509

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

510

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

511

#end

512

#else

513

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

514

(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'

520

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

521

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

522

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

523

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

524

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

525

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

526

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

527

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

528

#end

529

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

530

#else

531

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

532

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

533

#end

534

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

535

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

536

#end

537

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

538

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

#end

#end

##

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

543

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

544

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

545

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

546

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

547

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

548

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

549

#end

550

#else

551

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

#end

#end

#else

##

## If no content, check if content is mandatory

557

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

558

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

559

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

560

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

561

#else

562

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

#end

#end

#end

#if($error != '')

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

568

#set($registrationFailed = true)

569

#end

570

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

571

ERROR: Field with no name.

#end##if(validate)

#end##loop

#end##macro

#*

* Create the user.

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

578

*

579

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

580

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

581

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

582

*###

583

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

584

## CSRF check

585

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

586

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

587

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

588

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

589

#else

590

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

591

#end

592

#else

593

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

594

#end

595

##

596

## Handle output from the registration.

597

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

#if($reg == -2)

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

602

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

#elseif($reg == -4)

#else

{{translation key="core.register.registerFailed" parameters="$reg"/}}

#end

#elseif($reg)

## Registration was successful

612

#set($registrationDone = true)

613

##

614

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

615

#foreach($field in $fields)

616

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

617

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

618

#end

619

#end

620

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

621

## Calling toString() on a #define block will execute it and we discard the result.

622

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

623

##

624

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

625

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

626

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

627

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

628

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

629

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

630

#else

631

#set($redirect = $defaultRedirect)

632

#end

633

## Display a "registration successful" message

634

635

#evaluate($registrationSuccessMessage)

636

637

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

638

639

## 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...

655

#if($autoLogin && !$assumeLightbox)

656

657

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

658

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

});

</script>

#end

#end

#end

##

#end## createUser Macro

668

#*

669

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

670

*

671

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

672

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

673

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

674

*###

675

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

676

## Put the same values back into the fields.

#getParams($fields)

##

<dl>

#foreach($field in $fields)

681

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

682

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

683

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

684

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

685

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

686

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

687

<span ##

688

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

689

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

690

#end

691

>$services.localization.render('core.validation.required')</span>

#end

</label>

</dt>

#end

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

697

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

698

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

#else

#set($tag = 'input')

#end

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

703

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

704

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

705

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

706

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

707

#end

708

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

709

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

710

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

711

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

#end

#end

></$tag>

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

716

<span ##

717

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

718

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

719

#end

720

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

#end

</dd>

#else

ERROR: Field with no name.

725

#end##if fieldName exists

#end

</dl>

#end

#*

* Generate the Javascript for interacting with LiveValidation.

731

*

732

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

733

*###

734

#macro(generateJavascript, $fields)

735

736

/* <![CDATA[ */

737

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

738

##

739

#foreach($field in $fields)

740

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

741

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

742

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

743

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

744

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

745

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

746

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

747

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

748

#else

749

#set($okayMessage = $defaultFieldOkayMessage)

750

#end

751

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

752

##

753

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

754

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

755

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

756

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

#end

#end

##

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

761

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

762

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

763

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

#end

#end

##

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

768

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

769

#set($pattern = "")

770

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

771

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

772

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

773

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

774

#end

775

#set($failMessage = "")

776

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

777

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

778

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

779

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

780

#end

781

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

782

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

783

#end

784

#end##if regex

785

#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

793

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

794

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

795

*

796

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

797

*###

798

#macro(getParams $fields)

799

#foreach($field in $fields)

800

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

801

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

802

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

803

#set($params = {})

804

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

805

#else

806

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

807

#end

808

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

#end

#end

#end

#end

#*

* Get the configuration from the configuration object.

815

*

816

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

817

*###

818

#macro(loadConfig, $configDocumentName)

819

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

820

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

821

## No config document, load defaults.

822

#set($heading = "$services.localization.render('core.register.title')")

823

#set($welcomeMessage = "$services.localization.render('core.register.welcome')")

824

#set($useLiveValidation = true)

825

#set($defaultFieldOkayMessage = "$services.localization.render('core.validation.valid.message')")

826

#set($loginButton = true)

827

#set($defaultRedirect = "$xwiki.getURL($services.model.resolveDocument('', 'default', $doc.documentReference.extractReference('WIKI')))")

828

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

829

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

830

#else

831

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

832

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

833

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

834

#else

835

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