Registration

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

407

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

408

#end

409

#end

410

#else

411

## The registration is not allowed on the subwiki

412

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

413

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

414

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

415

#end

416

##

417

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

418

#*

419

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

420

*

421

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

422

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

423

*###

424

#macro(validateFields, $fields, $request)

425

#foreach($field in $fields)

426

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

427

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

428

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

429

#set($error = '')

430

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

431

#if("$!value" != '' || $field.get('type') == 'html')

432

##

433

## mustMatch validation

434

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

435

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

436

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

437

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

438

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

439

#end

440

#else

441

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

442

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

#end

457

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

458

#else

459

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

460

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

461

#end

462

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

463

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

464

#end

465

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

466

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

#end

#end

##

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

471

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

472

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

473

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

474

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

475

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

476

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

477

#end

478

#else

479

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

#end

#end

#else

##

## If no content, check if content is mandatory

485

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

486

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

487

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

488

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

489

#else

490

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

#end

#end

#end

#if($error != '')

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

496

#set($registrationFailed = true)

497

#end

498

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

499

ERROR: Field with no name.

#end##if(validate)

#end##loop

#end##macro

#*

* Create the user.

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

506

*

507

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

508

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

509

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

510

*###

511

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

512

## CSRF check

513

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

514

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

515

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

516

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

517

#else

518

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

519

#end

520

#else

521

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

522

#end

523

##

524

## Handle output from the registration.

525

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

#if($reg == -2)

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

530

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

#elseif($reg == -4)

#elseif($reg == -11)

#else

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

#end

#elseif($reg)

## Registration was successful

542

#set($registrationDone = true)

543

##

544

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

545

#foreach($field in $fields)

546

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

547

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

548

#end

549

#end

550

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

551

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

552

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

553

##

554

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

555

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

556

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

557

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

558

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

559

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

560

#else

561

#set($redirect = $defaultRedirect)

562

#end

563

## Display a "registration successful" message

564

565

#evaluate($registrationSuccessMessage)

566

567

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

568

569

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

585

#if ($autoLogin && $request.xpage != 'registerinline')

586

587

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

588

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

});

</script>

#end

#end

#end

##

#end## createUser Macro

598

#*

599

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

600

*

601

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

602

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

603

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

604

*###

605

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

606

## Put the same values back into the fields.

#getParams($fields)

##

<dl>

#foreach($field in $fields)

611

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

612

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

613

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

614

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

615

<dt><label #if (!$field.get('skipLabelFor'))for="$fieldName"#end>$label

616

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

617

<span ##

618

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

619

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

620

#end

621

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

#end

</label>

</dt>

#end

<dd>

#if ($field.get('type') == 'html')

628

$field.get('html')

629

#elseif ($field.get('type') == 'tag' || "$!{field.get('type')}" == '')

630

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

631

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

632

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

#else

#set($tag = 'input')

#end

<$tag id="$fieldName" ##

637

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

638

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

639

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

640

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

641

#end

642

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

643

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

644

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

645

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

646

#end

647

#end

648

## Close the opened tag in a way that is valid for its type (i.e. with "/>" or with "></tag>").

649

#if ($tag == 'input')

650

#set ($voidTag = true)

651

#end

652

#if ($voidTag)/#end>#if (!$voidTag)</$tag>#end

653

#end

654

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

655

<span ##

656

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

657

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

658

#end

659

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

#end

</dd>

#else

ERROR: Field with no name.

664

#end##if fieldName exists

#end

</dl>

#end

#*

* Generate the Javascript for interacting with LiveValidation.

670

*

671

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

672

*###

673

#macro(generateJavascript, $fields)

674

675

/* <![CDATA[ */

676

var initRegistrationFormValidation = function() {

677

##

678

#foreach($field in $fields)

679

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

680

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

681

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

682

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

683

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

684

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

685

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

686

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

687

#else

688

#set($okayMessage = $defaultFieldOkayMessage)

689

#end

690

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

691

##

692

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

693

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

694

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

695

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

#end

#end

##

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

700

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

701

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

702

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

#end

#end

##

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

707

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

708

#set($pattern = "")

709

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

710

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

711

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

712

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

713

#end

714

#set($failMessage = "")

715

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

716

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

717

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

718

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

719

#end

720

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

721

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

722

#end

723

#end##if regex

724

#end##if contains js validateable fields.

#end##if validate

#end##loop

};

document.observe('xwiki:dom:loaded', initRegistrationFormValidation);

729

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

730

var container = (event && event.memo && event.memo.elements && event.memo.elements[0]) || $('body');

731

if (container.down('form#register')) {

732

initRegistrationFormValidation();

}

});// ]]>

</script>

#end##macro

#*

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

739

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

740

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

741

*

742

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

743

*###

744

#macro(getParams $fields)

745

#foreach($field in $fields)

746

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

747

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

748

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

749

#set($params = {})

750

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

751

#else

752

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

753

#end

754

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

#end

#end

#end

#end

#*

* Get the configuration from the configuration object.

761

*

762

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

763

*###

764

#macro(loadConfig, $configDocumentName)

765

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

766

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

767

## No config document, load defaults.

768

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

769

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

770

#set($useLiveValidation = true)

771

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

772

#set($loginButton = true)

773

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

774

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

775

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

776

#else

777

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

778

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

779

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

780

#else

781

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