ClassEditSheet

## If we don`t skip the template, we can not control the behaviour of emptyIsToday for date fields, which we want to handle in #updateAndSaveTemplate only once.

537

##

538

## FIXME: even if it is not a good practice to have an object in the class document, it is still possible. We should handle field renames for the class document

539

## as well. Note that there is a possibility that objects in the class' document are automatically updated. Needs checking.

540

##

541

## We use HQL because XWQL doesn't allow us to escape the special characters from the class name.

542

#set($instancesStatement = ', BaseObject as obj where doc.fullName = obj.name and obj.className = :className'

543

+ ' and doc.fullName not in (:className, :templateName)')

544

#set($className = $stringtool.removeEnd($doc.fullName, 'Class'))

545

#set($instancesQuery = $services.query.hql($instancesStatement).bindValue('className', $doc.fullName).bindValue(

546

'templateName', "${className}Template"))

547

#foreach($instanceDocName in $instancesQuery.execute())

548

#set($instanceDoc = $xwiki.getDocument($instanceDocName))

549

#set($discard = $instanceDoc.document.renameProperties($doc.documentReference, $fieldsToRename))

550

#set($discard = $instanceDoc.save($services.localization.render('core.comment.updateClassPropertyName'), true))

#end

#end

#end

#**

* Handle Date fields that have the "Empty is today" option checked in the class edit form.

557

* See https://jira.xwiki.org/browse/XWIKI-10296

558

**#

559

#macro(handleEmptyIsTodayDateFields $templateDoc)

560

#foreach($property in $doc.xWikiClass.properties)

561

## We check directly on the request if the user provided an empty date. We can not check from the template

562

## document's object that we've just parsed from the request using the updateObjectFromRequest method because it

563

## already applies the emtpyIsToday mechanism and that would not be good for us.

564

#set($newValueRequestParameterName = "${doc.fullName}_0_${property.name}")

565

#set($newDateStringValue = "$!{request.getParameter($newValueRequestParameterName)}")

566

#if($property.classType == 'Date' && $property.getValue('emptyIsToday') == 1 && $newDateStringValue == '')

567

#set($discard = $templateDoc.set($property.name, $MAGIC_DATE))

#end

#end

#end

#**

* Updates and saves the class template based on the submitted data.

574

*#

575

#macro(updateAndSaveTemplate)

576

#if(!$errorMessage && $request.updateClassTemplate)

577

#set($className = $stringtool.removeEnd($doc.fullName, 'Class'))

578

#set($templateRef = $services.model.resolveDocument("${className}Template"))

579

#set($templateDoc = $xwiki.getDocument($templateRef))

580

#set($discard = $templateDoc.setParent($doc.documentReference.name))

581

#if ($request.templateTitle)

582

#set($discard = $templateDoc.setTitle($request.templateTitle))

583

#end

584

#if ($request.templateContent)

585

#set($discard = $templateDoc.setContent($request.templateContent))

586

#end

587

## Rename the properties of the template's object, if applicable.

588

#set($discard = $templateDoc.document.renameProperties($doc.documentReference, $fieldsToRename))

589

## Fill the template's object with the default values from the class editor's form.

590

#set($discard = $templateDoc.updateObjectFromRequest($doc.fullName))

591

##

592

#handleEmptyIsTodayDateFields($templateDoc)

593

#set($discard = $templateDoc.setHidden(true))

594

#set($discard = $templateDoc.save(

595

$services.localization.render('platform.appwithinminutes.classEditorTemplateSaveComment'),

$minorEdit))

#end

#end

#**

* Updates and saves the class sheet based on the submitted data.

602

*#

603

#macro(updateAndSaveSheet)

604

#if(!$errorMessage && $request.updateClassSheet)

605

#set($classSheets = $services.sheet.getClassSheets($doc))

606

#if($classSheets.isEmpty())

607

#set($className = $stringtool.removeEnd($doc.fullName, 'Class'))

608

#set($sheetReference = $services.model.resolveDocument("${className}Sheet"))

609

#set($discard = $services.sheet.bindClassSheet($doc, $sheetReference))

610

#set($discard = $doc.save($services.localization.render('platform.appwithinminutes.classEditorBindSheetSaveComment'),

611

$minorEdit))

612

#elseif($classSheets.size() == 1)

613

#set($sheetReference = $classSheets.get(0))

614

#end

615

#if($sheetReference)

616

#set($sheetDoc = $xwiki.getDocument($sheetReference))

617

#set($sheetGeneratorDoc = $xwiki.getDocument('AppWithinMinutes.ClassSheetGenerator'))

618

#set($discard = $sheetDoc.setParent($doc.documentReference.name))

619

#set($discard = $sheetDoc.setContent($doc.getRenderedContent($sheetGeneratorDoc.content,

620

$sheetGeneratorDoc.syntax.toIdString(), 'plain/1.0')))

621

## We assume for now that the output produced by the sheet generator uses the same syntax as the code of the sheet

622

## generator. We have to set the syntax because the default wiki syntax (used when creating new wiki pages) could

623

## be different than the one used by the sheet generator.

624

#set($discard = $sheetDoc.setSyntax($sheetGeneratorDoc.syntax))

625

#set($discard = $sheetDoc.setHidden(true))

626

#set($discard = $sheetDoc.save($services.localization.render('platform.appwithinminutes.classEditorSheetSaveComment'),

$minorEdit))

#end

#end

#end

#**

* Updates and saves the class translation bundle based on the submitted data.

634

*#

635

#macro(updateAndSaveTranslations)

636

#if(!$errorMessage && $request.updateClassTranslations)

637

#set($className = $stringtool.removeEnd($doc.fullName, 'Class'))

638

#set($translationsRef = $services.model.resolveDocument("${className}Translations"))

639

#set($translationsDoc = $xwiki.getDocument($translationsRef))

640

#set($translationsObj = $translationsDoc.getObject('XWiki.TranslationDocumentClass', true))

641

#set ($scope = 'USER')

642

#if ($services.security.authorization.hasAccess('admin', $doc.documentReference.wikiReference))

643

#set ($scope = 'WIKI')

644

#end

645

#set($discard = $translationsObj.set('scope', $scope))

646

#set($discard = $translationsDoc.setParent($doc.documentReference.name))

647

#set($translationsGeneratorDoc = $xwiki.getDocument('AppWithinMinutes.ClassTranslationsGenerator'))

648

#set($discard = $translationsDoc.setContent($doc.getRenderedContent($translationsGeneratorDoc.content,

649

$translationsGeneratorDoc.syntax.toIdString(), 'plain/1.0')))

650

#set($discard = $translationsDoc.setSyntaxId('plain/1.0'))

651

#set($discard = $translationsDoc.setHidden(true))

652

#set($discard = $translationsDoc.save(

653

$services.localization.render('platform.appwithinminutes.classEditorTranslationsSaveComment'),

$minorEdit))

#end

#end

#**

* Updates and saves the class definition, the class sheet and the class template.

660

*#

661

#macro (doSave)

662

#set ($minorEdit = "$!request.minorEdit" != '')

663

#maybeCreateCodeSpace

664

#updateAndSaveClass

665

#updateAndSaveTemplate

666

#updateAndSaveSheet

667

#updateAndSaveTranslations

668

#if ($action == 'save')

669

#if ($errorMessage)

670

<div class="box errormessage">$errorMessage</div>

671

#elseif ("$!request.wizard" == 'true')

672

## Redirect to next wizard step.

673

#set ($className = $stringtool.removeEnd($doc.fullName, 'Class'))

674

#set ($templateProviderReference = $services.model.resolveDocument("${className}TemplateProvider"))

675

#set ($queryString = {

676

'wizard': true,

677

'sheet': 'AppWithinMinutes.TemplateProviderEditSheet'

678

})

679

#if (!$xwiki.exists($templateProviderReference))

680

#set ($discard = $queryString.putAll({

681

'form_token': $services.csrf.getToken(),

682

'template': 'XWiki.TemplateProviderTemplate',

683

'parent': $doc.fullName

684

}))

685

#end

686

$response.sendRedirect($xwiki.getURL($templateProviderReference, 'edit', $escapetool.url($queryString)))

687

#else

688

## Redirect to view mode.

689

$response.sendRedirect($doc.getURL())

#end

#else

#if ($errorMessage)

$response.sendError(400, $errorMessage)

694

#else

695

$response.setStatus(204)

#end

#end

#end

#if("$!request.wizard" == 'true')

#end

## Determine the action button that triggered the request

710

#set ($action = 'edit')

711

#foreach ($paramName in $request.getParameterMap().keySet())

712

#if ($paramName.startsWith('xaction_'))

713

#set ($action = $paramName.substring(8))

#break

#end

#end

#if ($action == 'edit')

718

#doEdit()

719

#elseif ($action == 'save' || $action == 'saveandcontinue')

720

#if ($services.csrf.isTokenValid($request.form_token))

721

#doSave()

722

#else

723

$response.sendRedirect($services.csrf.getResubmissionURL())

#end

#end

Wiki source code of ClassEditSheet

Navigation