ClassEditSheet

; {{html clean="false"}}<label for="$!{prefix}$property.name">#displayPropertyEditInput($property, $prefix, $field)$escapetool.xml($property.prettyName)</label>{{/html}}

283

#else

284

; {{html}}<label for="${prefix}$property.name">$escapetool.xml($property.prettyName)</label>{{/html}}

285

: {{html clean="false"}}#displayPropertyEditInput($property, $prefix, $field){{/html}}

#end

#end

#**

* Displays the input used to edit the specified property of the given object. The given object can be either an

291

* instance of an XWiki class or a class field. In the first case the property represents an object field and in the

292

* second case the property represents a field meta property.

293

*#

294

#macro(displayPropertyEditInput $property $prefix $object)

295

#set($wrappedProperty = $property.propertyClass)

296

#if($wrappedProperty.isCustomDisplayed($xcontext.context))

297

$xcontext.get('propertyCustomDisplayer').display($property, $prefix, $object)

298

#else

299

$doc.displayEdit($property, $prefix, $object)

#end

#end

#**

* Called when a new form field is added via AJAX.

305

*#

306

#macro(displayNewField)

307

## Output the SkinExtension hooks to allow field displayers to pull JavaScript/CSS resources.

308

## Output also the LinkExtension hook because $xwiki.linkx.use() is used to load CSS files from WebJars.

309

## The class editor moves this resource includes in the HTML page head.

310

311

#skinExtensionHooks

#set($formFieldDoc = $xwiki.getDocument($request.field))

316

#set($formFieldDocClassFields = $formFieldDoc.getxWikiClass().getXWikiClass().properties)

317

#if($formFieldDocClassFields.size() > 0)

318

## Clone the field template.

319

#set($field = $formFieldDocClassFields.get(0).clone())

320

#if("$!field.prettyName" == '')

321

#set($discard = $field.setPrettyName($formFieldDoc.title))

322

#end

323

#set($xclass = $doc.getxWikiClass().getXWikiClass())

324

#set($discard = $xclass.addField($field.name, $field))

325

#set($discard = $field.setObject($xclass))

326

#displayField($doc.getxWikiClass().get($field.name) $formFieldDoc)

327

#else

328

Unsupported form field.

#end

#end

#**

* Preview a class field (requires Programming Right).

334

*#

335

#macro(previewField)

336

## Find the request parameter that specifies the field template.

337

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

338

#if($paramName.startsWith('template-'))

339

#set($fieldName = $paramName.substring(9))

340

#set($fieldTemplateDoc = $xwiki.getDocument($request.getParameter($paramName)))

#break

#end

#end

##

## Clone the field template.

346

#set($field = $fieldTemplateDoc.getxWikiClass().getXWikiClass().properties.get(0).clone())

347

##

348

## Update the field meta properties based on the submitted data.

349

#set($valuesFromRequest = $xcontext.context.getForm().getObject("field-$fieldName"))

350

#set($discard = $field.getxWikiClass().fromMap($valuesFromRequest, $field))

351

##

352

## Don't rename the field (ignore the submitted name).

353

#set($discard = $field.setName($fieldName))

354

##

355

## We have to add the field to the class before setting its value.

356

## (otherwise the field value from the request is ignored).

357

#set($xclass = $doc.getxWikiClass().getXWikiClass())

358

#set($discard = $xclass.addField($fieldName, $field))

359

#set($discard = $field.setObject($xclass))

360

##

361

## Create an object that has this field and set its value from request.

362

#set($object = $fieldTemplateDoc.getObject($doc.fullName, true))

363

##

364

## Filter empty values from the request, otherwise the update method could try to select an invalid value.

365

#set($values = [])

366

#foreach($value in $request.getParameterValues("${doc.fullName}_0_$fieldName"))

367

#if($value != '')

368

#set($discard = $values.add($value))

369

#end

370

#end

371

#if($values.size() > 0)

372

#set($stringArray = $request.getParameterValues("template-$fieldName"))

373

#set($discard = $xclass.fromMap({$fieldName: $values.toArray($stringArray)}, $object.getXWikiObject()))

374

#end

375

##

376

## Display the field.

377

#set($field = $doc.getxWikiClass().get($fieldName))

378

{{html clean="false"}}#displayPropertyEditInput($field, "${doc.fullName}_0_", $object){{/html}}

#end

#**

* Display the edit class form.

383

*#

384

#macro(displayEditForm)

385

$xwiki.jsfx.use('js/scriptaculous/dragdrop.js')##

386

$xwiki.jsx.use('AppWithinMinutes.ClassEditSheet')##

387

$xwiki.ssx.use('AppWithinMinutes.ClassEditSheet')##

388

$xwiki.ssx.use('AppWithinMinutes.ClassSheetGenerator')##

389

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

390

#appWizardHeader('structure')

391

392

#end

393

#displayFieldPalette()

394

#displayFieldCanvas()

395

#displayClassOptions()

396

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

397

398

#appWizardFooter('structure')

399

#end

400

(% class="clearfloats" %)((()))

#end

#**

* Displays either the edit class form or a new form field. The later is used when adding a new form field via AJAX.

405

*#

406

#macro(doEdit)

407

#if("$!request.field" != '')

408

#displayNewField()

409

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

410

#previewField()

411

#else

412

## Make sure that only the sheet content is rendered when the class is saved using AJAX.

413

(% class="hidden" %)

414

{{html}}<input type="hidden" name="xpage" value="plain" />{{/html}}

#displayEditForm()

#end

#end

#**

* Create the home page of the application code space, if it doesn't exist already.

422

*#

423

#macro (maybeCreateCodeSpace)

424

#set ($codeHomePageReference = $services.model.resolveDocument('', 'default', $doc.documentReference.parent))

425

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

426

#set ($codeSpaceTemplate = $services.model.resolveDocument('AppWithinMinutes.CodeSpaceTemplate'))

427

#set ($copyAsJob = $services.refactoring.copyAs($codeSpaceTemplate, $codeHomePageReference))

428

#try()

429

#set ($discard = $copyAsJob.join())

430

#set ($copyAsJobStatus = $services.job.getJobStatus($copyAsJob.request.id))

431

#set ($errorLogs = $copyAsJobStatus.log.getLogs('ERROR'))

432

#if ($errorLogs.size() > 0)

433

#set ($errorMessage = $errorLogs.get(0).toString())

#end

#end

#end

#end

#**

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

441

*#

442

#macro(updateAndSaveClass)

443

#set($class = $doc.xWikiClass)

444

#set($xclass = $class.getXWikiClass().clone())

445

#set($xdoc = $doc.document)

446

##

447

## Handle new fields and field type changes.

448

##

449

#set($fieldNames = [])

450

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

451

#if($paramName.startsWith('type-'))

452

#set($fieldName = $paramName.substring(5))

453

#set($fieldType = $request.getParameter($paramName))

454

#set($field = $class.get($fieldName))

455

#if(!$field || $field.classType != $fieldType)

456

#if($field)

457

## The field type has changed. Remove the field and add a new one with the proper type.

458

#set($discard = $xclass.removeField($fieldName))

459

#end

460

## Add a new class field with the specified type.

461

#set($fieldTemplateRef = $request.getParameter("template-$fieldName"))

462

#if("$!fieldTemplateRef" != '')

463

#set($fieldTemplateDoc = $xwiki.getDocument($fieldTemplateRef))

464

#set($field = $fieldTemplateDoc.getxWikiClass().getXWikiClass().properties.get(0).clone())

465

#set($discard = $field.setObject($xclass))

466

#set($discard = $xclass.addField($fieldName, $field))

467

#set($discard = $fieldNames.add($fieldName))

468

#set($discard = $xdoc.setMetaDataDirty(true))

469

#end

470

#else

471

#set($discard = $fieldNames.add($fieldName))

#end

#end

#end

##

## Handle deleted fields.

477

##

478

#foreach($field in $class.properties)

479

#if(!$fieldNames.contains($field.name))

480

#set($discard = $xclass.removeField($field.name))

#end

#end

##

## Handle field updates.

485

##

486

#set($fieldsToRename = {})

487

#foreach($fieldName in $xclass.propertyNames)

488

#set($field = $xclass.get($fieldName))

489

#set($valuesFromRequest = $xcontext.context.getForm().getObject("field-$fieldName"))

490

#set($discard = $field.getxWikiClass().fromMap($valuesFromRequest, $field))

491

#if($field.name.matches('^[a-zA-Z_][\w:\-\.]*$'))

492

#if($fieldName != $field.name)

493

## The field name has changed.

494

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

495

## There is already a field with the same name.

496

#set($errorMessage = $services.localization.render('platform.appwithinminutes.classEditorDuplicateFieldNameError', [$field.name]))

497

#break

498

#else

499

#set($discard = $xclass.removeField($fieldName))

500

#set($discard = $xclass.addField($field.name, $field))

501

#set($originalField = $class.get($fieldName))

502

#if($originalField)

503

## This is not a new field.

504

#set($discard = $fieldsToRename.put($fieldName, $field.name))

505

#set($discard = $xclass.addPropertyForRemoval($originalField.propertyClass))

#end

#end

#end

#else

#set($errorMessage = $services.localization.render('propertynamenotcorrect'))

#break

#end

#end

##

## Save

##

#if(!$errorMessage)

#set($discard = $xdoc.setXClass($xclass))

519

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

520

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

521

#set($discard = $xdoc.setMetaDataDirty(true))

522

#set($discard = $doc.save($services.localization.render('core.comment.updateClassProperty'), $minorEdit))

523

#end

524

##

525

## Handle field renames.

526

##

527

#if(!$errorMessage && !$fieldsToRename.isEmpty())

528

## We need to load all documents (except the class and template, which we handle below) that have objects of this class and rename their properties.

529

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

530

##

531

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

532

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

533

##

534

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

535

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

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

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

550

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

551

**#

552

#macro(handleEmptyIsTodayDateFields $templateDoc)

553

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

554

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

555

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

556

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

557

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

558

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

559

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

560

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

#end

#end

#end

#**

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

567

*#

568

#macro(updateAndSaveTemplate)

569

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

570

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

571

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

572

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

573

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

574

#if ($request.templateTitle)

575

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

576

#end

577

#if ($request.templateContent)

578

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

579

#end

580

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

581

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

582

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

583

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

584

##

585

#handleEmptyIsTodayDateFields($templateDoc)

586

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

587

#set($discard = $templateDoc.save(

588

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

$minorEdit))

#end

#end

#**

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

595

*#

596

#macro(updateAndSaveSheet)

597

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

598

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

599

#if($classSheets.isEmpty())

600

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

601

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

602

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

603

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

604

$minorEdit))

605

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

606

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

607

#end

608

#if($sheetReference)

609

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

610

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

611

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

612

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

613

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

614

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

615

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

623

*#

624

#macro(updateAndSaveTranslations)

625

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

626

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

627

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

628

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

629

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

630

#set ($scope = 'USER')

631

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

632

#set ($scope = 'WIKI')

633

#end

634

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

635

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

636

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

637

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

638

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

639

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

640

#set($discard = $translationsDoc.save(

641

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

$minorEdit))

#end

#end

#**

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

648

*#

649

#macro(doSave)

650

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

651

#maybeCreateCodeSpace

652

#updateAndSaveClass

653

#updateAndSaveTemplate

654

#updateAndSaveSheet

655

#updateAndSaveTranslations

656

#if($action == 'save')

657

#if($errorMessage)

658

{{error}}{{html}}$errorMessage{{/html}}{{/error}}

659

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

660

## Redirect to next wizard step.

661

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

662

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

663

#set ($queryString = {

664

'wizard': true,

665

'sheet': 'AppWithinMinutes.TemplateProviderEditSheet'

666

})

667

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

668

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

669

'template': 'XWiki.TemplateProviderTemplate',

670

'parent': $doc.fullName

671

}))

672

#end

673

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

674

#else

675

## Redirect to view mode.

676

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

#end

#else

#if($errorMessage)

$response.sendError(400, $errorMessage)

681

#else

682

$response.setStatus(204)

#end

#end

#end

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

#end

## Determine the action button that triggered the request

696

#set($action = 'edit')

697

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

698

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

699

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

#break

#end

#end

#if($action == 'edit')

704

#doEdit()

705

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

706

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

707

#doSave()

708

#else

709

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

710

#end

711

#end

712

Wiki source code of ClassEditSheet

Applications

Navigation

Need help?