Create a new wiki

1

2

#######################################################

3

## Create a new (sub)wiki - WIZARD

4

##

5

## This wizard let user create a new wiki.

6

## The 'controller' macro call the good submacro

7

## depending on the step

8

##

9

#######################################################

10

#########################

11

## STYLE

12

#########################

13

#set($docextras = {})

14

#########################

15

## PLUGINS DEPENDENCIES

16

#########################

17

18

## If all dependencies are OK, we call the controller

19

#if ($services.wiki && $services.wiki.creationjob)

#controller()

#else

#end

##################################

26

## CONTROLLER

27

##################################

28

#macro(controller)

29

#if($request.step == 'members')

30

#stepMembers()

31

#elseif($request.step == 'create')

32

#create()

33

#elseif($request.step == 'cleanUp')

34

#cleanUp()

35

#elseif($request.step == 'finalize')

#finalize()

#else

## Default step

#stepType()

#end

#end

##################################

43

## HEADER

44

##

45

## Display the wizard header

46

##################################

47

#macro(wizardHeader $title $currentStepNumber)

48

## Display a step name in the header

49

#macro(wizardHeaderStep $name $number $currentStepNumber)

50

<li><span class="number #if($currentStepNumber==$number)active#end">$number</span> <span class="name #if($currentStepNumber==$number)active#end">$name</span></li>

#end

<h1><span>$title</span></h1>

55

#if($currentStepNumber)

56

57

#wizardHeaderStep($services.localization.render('platform.wiki.create.wizard.step.nameAndType.shortname'), 1, $currentStepNumber)

58

#wizardHeaderStep($services.localization.render('platform.wiki.create.wizard.step.users.shortname'), 2, $currentStepNumber)

</ul>

#end

</div>

#end

##################################

66

## FOOTER

67

##

68

## Display the wizard footer

69

##################################

70

#macro(wizardFooter $prev $next $create $finalize $finalizeHidden $cleanUp $cleanupHidden)

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

<button value="$prev" title="$services.localization.render('platform.wiki.create.wizard.step.previous')" name="step" id="wizard-previous" class="button secondary">$services.localization.render('platform.wiki.create.wizard.step.previous')</button>

</span>

#end

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

<button value="$next" title="$services.localization.render('platform.wiki.create.wizard.step.next')" name="step" id="wizard-next" class="button">$services.localization.render('platform.wiki.create.wizard.step.next')</button>

</span>

#end

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

<button value="$create" title="$services.localization.render('platform.wiki.create.wizard.step.create')" name="step" id="wizard-create" class="button">$services.localization.render('platform.wiki.create.wizard.step.create')</button>

85

</span>

86

#end

87

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

88

89

<button value="finalize" title="$services.localization.render('platform.wiki.create.wizard.step.creation.go')" name="step" id="finalize" class="button #if($finalizeHidden)hidden#end">$services.localization.render('platform.wiki.create.wizard.step.creation.go')</button>

90

</span>

91

#end

92

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

93

94

<button value="cleanUp" title="$services.localization.render('platform.wiki.create.wizard.step.provisioning.cleanUp')" name="step" id="cleanUp" class="button #if($cleanupHidden)hidden#end">$services.localization.render('platform.wiki.create.wizard.step.provisioning.cleanUp')</button>

</span>

#end

</div>

#end

##################################

100

## REQUIRED

101

##

102

## Add a required message

103

##################################

104

#macro(required)<span class='xRequired'>($services.localization.render('platform.wiki.form.requiredField'))</span>#end

105

##################################

106

## TEMPLATE FIELDS

107

##

108

## Display the 'template' fields

109

##################################

110

#macro(displayTemplateFields $templates)

111

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

112

113

<option value="xwikinotemplate">$services.localization.render('platform.wiki.create.wizard.template.noTemplate')</option>

114

#foreach ($template in $templates)

115

#set ($name = $template.id)

116

#if ($stringtool.isNotBlank("$!template.prettyName"))

117

#set($name = "${template.prettyName} (${name})")

118

#end

119

#set($selected = '')

120

#if($request.template == $template.id)

121

#set($selected = 'selected="selected"')

#end

#end

</select>

#end

#set ($isTemplate = '')

129

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

130

#set ($isTemplate = 'checked="checked"')

131

#end

132

133

<label for="set_as_template" id="label_set_as_template">$services.localization.render('platform.wiki.create.wizard.setAsTemplate.label')</label>

134

</div>

135

#end

136

##################################

137

## STEP TYPE

138

##

139

## The type is the first step on the creation

140

##################################

141

#macro(stepType)

142

#set($discard = $xwiki.ssfx.use('uicomponents/wizard/wizard.css', true))

143

144

145

#wizardHeader($services.localization.render('platform.wiki.create.wizard.step.nameAndType'), 1)

146

### WIZARD BODY ###

147

148

### SECOND STEP VALUES

#addMembersAsHiddenInput()

153

### WIZARD FIRST HALF ###

### PRETTY NAME ###

<dl>

<dt>

<label for="prettyname">$services.localization.render('platform.wiki.prop.wikiprettyname')#required()</label>

159

<span class="xHint">$services.localization.render('platform.wiki.create.wizard.desc.wikiprettyname')</span>

</dt>

<dd>

</dd>

</dl>

### WIKI NAME ###

<dl>

<dt>

<label for="wikiname">$services.localization.render('platform.wiki.prop.wikiname')#required()</label>

170

<span class='xHint'>$services.localization.render('platform.wiki.create.wizard.desc.wikiname')</span>

</dt>

<dd>

</dd>

</dl>

### WIKI ALIAS ###

#if(!$services.wiki.isPathMode())

179

<dl>

180

<dt>

181

<label for="wikialias">$services.localization.render('platform.wiki.prop.wikialias')#required()</label>

182

<span class='xHint'>$services.localization.render('platform.wiki.create.wizard.desc.wikialias')</span>

</dt>

<dd>

</dd>

</dl>

#end

### DESCRIPTION ###

<dl>

<dt>

<label for="description">$services.localization.render('platform.wiki.prop.description')</label>

193

<span class="xHint">$services.localization.render('platform.wiki.create.wizard.desc.description')</span>

194

</dt>

195

<dd>

196

<textarea id="description" name="description" rows="7" cols="45">$!escapetool.xml($request.getParameter('description'))</textarea>

197

</dd>

198

</dl>

199

### END OF WIZARD FIRST HALF

200

</div>

201

### WIZARD SECOND HALF

202

203

### TEMPLATE / FLAVOR ###

204

#set ($templates = $services.wiki.template.getTemplates())

205

#if (!$services.distribution.hasWikiDefaultUIExtension())

206

#template('flavor/macros.vm')

207

<dl>

208

<dt>

209

<label>$services.localization.render('platform.wiki.create.wizard.flavortemplate.label')</label>

210

<span class="xHint">$services.localization.render('platform.wiki.create.wizard.flavortemplate.hint')</span>

211

</dt>

212

#set ($currentTab = 'flavors')

213

#if ("$!request.template" != '' && $request.template != 'xwikinotemplate')

214

#set ($currentTab = 'templates')

#end

<li #if($currentTab=='flavors')class="active"#end><a href="#flavors">$services.localization.render('platform.wiki.create.wizard.flavortemplate.flavorTab')</a></li>

219

<li #if($currentTab=='templates')class="active"#end><a href="#templates">$services.localization.render('platform.wiki.create.wizard.flavortemplate.templateTab')</a></li>

220

</ul>

221

222

#set ($defaultFlavor = "$!request.flavor")

223

#if ($defaultFlavor == '')

224

#set ($defaultFlavor = 'noFlavor')

225

#end

226

227

## TODO: reload when the target subwiki id changes

228

#displayFlavorPicker('flavor', $defaultFlavor, true, 'xwiki-createwiki-flavor-picker', true, 'wiki:subwiki')

229

</div>

230

231

#displayTemplateFields($templates)

</div>

</div>

</dd>

</dl>

#else

## There is a default UI configured, so we do not display the flavor picker

238

<dl>

239

<dt>

240

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

241

<label for="template">$services.localization.render('platform.wiki.create.wizard.template.label')</label>

242

<span class="xHint">$services.localization.render('platform.wiki.create.wizard.desc.newTemplateHint')</span>

243

#else

244

<label>$services.localization.render('platform.wiki.create.wizard.template.label')</label>

#end

</dt>

<dd>

#displayTemplateFields($templates)

</dd>

</dl>

#end

### END OF WIZARD SECOND HALF

253

</div>

254

### END OF WIZARD BODY

255

</div>

256

257

#wizardFooter('', 'members', '')

</form>

#end

##################################

262

## STEP MEMBERS

263

##

264

## The members step is the lasy

265

##################################

266

#macro(stepMembers)

267

#set($discard = $xwiki.ssfx.use('uicomponents/wizard/wizard.css', true))

268

269

270

#wizardHeader($services.localization.render('platform.wiki.create.wizard.step.users'), 2)

271

### WIZARD BODY ###

272

273

### FIRST STEP VALUES

### WIZARD FIRST HALF ###

283

284

### OWNER ###

285

## Make this section available only to admins, so that only admins can create wikis in the name of other users.

#if ($hasAdmin)

<dl>

<dt>

<label for="owner">$services.localization.render('platform.wiki.prop.owner') <span class="xRequired">($services.localization.render('platform.wiki.form.requiredField'))</span></label>

290

<span class="xHint">$services.localization.render('platform.wiki.create.wizard.desc.owner')</span>

291

</dt>

292

<dd>

293

#set($value = $escapetool.xml($request.getParameter('ownerId')))

294

#if("$!value" == "")

295

#set($value = $escapetool.xml($xcontext.user))

296

#end

297

#set ($userPickerParams = {

'id': 'owner',

'name': 'ownerId',

'value': $value

})

#userPicker(false $userPickerParams)

</dd>

</dl>

#else

#end

### USERS SCOPE ###

<dl>

<dt>

<label for="userScope">$services.localization.render('platform.wiki.create.wizard.userScope.label')</label>

312

<span class="xHint">$services.localization.render('platform.wiki.create.wizard.userScope.hint')</span>

313

</dt>

314

<dd>

315

#set($value = $escapetool.xml($request.getParameter('userScope')))

316

#set ($wikiUserClassDocument = $xwiki.getDocument('WikiManager.WikiUserClass'))

317

#set ($wikiUserClass = $wikiUserClassDocument.getxWikiClass())

318

#set ($userScopeProperty = $wikiUserClass.get('userScope'))

319

#set ($userScopePropertyValues = '')

320

#set ($userScopePropertyValues = $userScopeProperty.getListValues())

321

#set ($userScopeDetailsMap = $userScopeProperty.getMapValues())

322

#foreach ($userScopeValue in $userScopePropertyValues)

323

#set ($userScopeValueId = "userScope_${foreach.index}")

<div>

#set($checked = '')

#if($request.getParameter('userScope') == $userScopeValue || ("$!request.getParameter('userScope')"=='' && $foreach.index==0))

328

#set($checked = 'checked="checked"')

329

#end

330

331

$services.localization.render("${wikiUserClassDocument.fullName}_${userScopeProperty.name}_${userScopeDetailsMap.get($userScopeValue).getValue()}")

</label>

</div>

#end

</dd>

</dl>

### END OF WIZARD FIRST HALF

338

</div>

339

### WIZARD SECOND HALF

340

341

### MEMBERSHIP TYPE

342

#set ($membershipTypeProperty = $wikiUserClass.get('membershipType'))

343

#set ($membershipTypeValues = '')

344

#set ($membershipTypeValues = $membershipTypeProperty.getListValues())

345

#set ($membershipTypeDetailsMap = $membershipTypeProperty.getMapValues())

346

<dl>

347

<dt>

348

<label>$services.localization.render('platform.wiki.prop.membershipType.label')</label>

349

<span class='xHint'>$services.localization.render('platform.wiki.prop.membershipType.hint')</span>

350

</dt>

351

<dd>

352

#foreach ($membershipTypeValue in $membershipTypeValues)

353

#set ($membershipTypeValueId = "membershipType_${foreach.index}")

<div>

#set($checked = '')

#if($request.getParameter('membershipType') == $membershipTypeValue || ("$!request.getParameter('membershipType')"=='' && $foreach.index==0))

358

#set($checked = 'checked="checked"')

359

#end

360

361

$services.localization.render("${wikiUserClassDocument.fullName}_${membershipTypeProperty.name}_${membershipTypeDetailsMap.get($membershipTypeValue).getValue()}")

</label>

</div>

#end

</dd>

</dl>

### MEMBERS

<dl>

<dt>

<label for="members">$services.localization.render('platform.wiki.create.members')</label>

371

<span class="xHint">$services.localization.render('platform.wiki.create.wizard.desc.members')</span>

372

</dt>

373

<dd>

374

#set ($userPickerParams = {

375

'id': 'members',

376

'name': 'members',

377

'value': $request.getParameterValues('members')

378

})

379

#userPicker(true $userPickerParams)

380

</dd>

381

</dl>

382

### END OF WIZARD SECOND HALF

383

</div>

384

### END OF WIZARD BODY

385

</div>

386

387

#wizardFooter('type', '', 'create')

</form>

#end

##################################

392

## GET REQUEST LIST

393

##

394

## Get the values for user pickers with multiple selection

395

##################################

396

#macro(getRequestList $paramlist $paramname)

397

#set ($paramtable = [])

398

#set ($paramtable = $request.getParameterValues($paramname))

399

#if ($paramtable && $paramlist)

400

#set ($ok = $paramlist.clear())

401

#foreach($paramvalue in $paramtable)

402

#set ($ok = $paramlist.add($paramvalue))

#end

#end

#end

##################################

407

## CREATE

408

##

409

## The final step that eventually create the wiki

410

##################################

411

#macro(create)

412

## Job Status

413

#set ($state = $services.wiki.creationjob.getJobStatus($request.wikiname).state)

414

## If a deleted wiki had the same name, the job status may still be there (with a 'FINISHED' status)

415

## So we have to check if the wiki really exists

416

#if ($state == 'FINISHED' && !$services.wiki.exists($request.wikiname))

417

## If not, consider that the new job has not been launched yet

418

#set($state = 'NONE')

419

#end

420

## CSRF checkFailed to execute the [velocity] macro. Click on this m

421

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

#stepMembers()

#elseif("$!state" != '' && $state != 'NONE')

#creation()

#else

#createWiki()

#end

#end

##################################

434

## CREATE WIKI

435

##

436

## The macro that finaly starts the wiki creation job

437

##################################

438

#macro(createWiki)

439

#set($wikialias = $request.wikialias)

440

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

441

#set($wikialias = $request.wikiname)

442

#end

443

#set($wikiCreationRequest = $services.wiki.creationjob.newWikiCreationRequest())

444

#set($discard = $wikiCreationRequest.setWikiId($request.wikiname))

445

#set($discard = $wikiCreationRequest.setAlias($wikialias))

446

#set($discard = $wikiCreationRequest.setPrettyName($request.wikiprettyname))

447

#set($discard = $wikiCreationRequest.setDescription($request.description))

448

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

449

#set($discard = $wikiCreationRequest.setTemplate(true))

450

#else

451

#set($discard = $wikiCreationRequest.setTemplate(false))

452

#end

453

#set($ownerId = $request.ownerId)

454

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

455

## If the ownerId is null, then set the current user

456

#set($ownerId = $services.model.serialize($xcontext.userReference, 'default'))

457

#else

458

#set($ownerId = $services.model.serialize($services.model.resolveDocument($ownerId), 'default'))

459

#end

460

#set($discard = $wikiCreationRequest.setOwnerId($ownerId))

461

#set($discard = $wikiCreationRequest.setUserScope($request.userScope))

462

#set($discard = $wikiCreationRequest.setMembershipType($request.membershipType))

463

#set($discard = $wikiCreationRequest.setFailOnExist(true))

464

#if("$!request.template" != '' && $request.template != 'xwikinotemplate')

465

## Create a wiki from a template

466

#set($discard = $wikiCreationRequest.setWikiSource('template'))

467

#set($discard = $wikiCreationRequest.setTemplateId($request.template))

468

#elseif("$!request.flavor" != '' && $request.flavor != 'noFlavor')

469

## Create a wiki from an extension

470

#set($discard = $wikiCreationRequest.setWikiSource('extension'))

471

#set($flavorExtension = $request.flavor.split(':::'))

472

#set($discard = $wikiCreationRequest.setExtensionId($flavorExtension[0], $flavorExtension[1]))

473

#elseif($services.distribution.hasWikiDefaultUIExtension())

474

## Default action when a default UI is configured for subwikis

475

#set($discard = $wikiCreationRequest.setWikiSource('extension'))

476

#set($discard = $wikiCreationRequest.setExtensionId($services.wiki.creationjob.defaultWikiExtensionId))

477

#end

478

## Members

479

#if ($request.userScope != 'local_only')

480

#set ($members = [])

481

#getRequestList($members 'members')

482

## Remove empty strings from the list of members (the user picker submits by default an empty string).

483

#set ($discard = $members.removeAll(['']))

484

#if ("$!members" != '' && $members.size() > 0)

485

#set ($globalMembers = [])

486

## Enforce global users

487

#foreach ($member in $members)

488

#set($discard = $globalMembers.add($services.model.serialize($services.model.resolveDocument($member), 'default')))

489

#end

490

## Add the members

491

#set ($discard = $wikiCreationRequest.setMembers($globalMembers))

492

#end

493

#end

494

## Start the creation job

495

#set($job = $services.wiki.creationjob.createWiki($wikiCreationRequest))

496

#if (!$job)

497

{{error}}$services.localization.render('platform.wiki.create.error', [$request.wikiname, $services.wiki.creationjob.lastError]){{/error}}

#else

#creation()

#end

#end

##################################

503

## ADD MEMBERS AS HIDDEN INPUT

504

##################################

505

#macro(addMembersAsHiddenInput)

506

### MEMBERS VALUES

507

#set ($members = [])

508

#getRequestList($members 'members')

509

#set($membersValue = '')

510

#foreach($m in $members)

#if($m != '')

#end

#end

#end

##################################

517

## CREATION

518

##

519

## This step display a progess bar during

520

## the wiki creation

521

##################################

522

#macro(creation)

523

#set ($discard = $xwiki.ssfx.use('uicomponents/wizard/wizard.css', true))

524

#set ($discard = $xwiki.ssfx.use('uicomponents/logging/logging.css', true))

525

#set ($discard = $xwiki.jsfx.use('uicomponents/logging/logging.js', true))

526

#set ($status = $services.wiki.creationjob.getJobStatus($request.wikiname))

#wizardHeader($services.localization.render('platform.wiki.create.wizard.step.creation'))

532

533

#if ($status.state != 'FINISHED')

534

535

$services.localization.render('platform.wiki.create.wizard.step.creation.wait')

536

537

#set ($percent = $status.progress.offset)

538

## There is no progress information if the job was scheduled but hasn't started yet.

#if (!$percent)

#set ($percent = 0)

#end

#set ($percent = $mathtool.toInteger($mathtool.mul($percent, 100)))

</div>

</div>

#end

#set($errorlogs = $status.log.getLogs('ERROR'))

548

549

$services.localization.render('platform.wiki.create.wizard.step.creation.complete', ["<strong>$escapetool.xml($request.wikiname)</strong>"])

550

</p>

551

552

$services.localization.render('platform.wiki.create.wizard.step.creation.errorlog', ["<strong>$escapetool.xml($request.wikiname)</strong>"])

553

</p>

554

555

$services.localization.render('platform.wiki.create.wizard.step.creation.error', ["<strong>$escapetool.xml($request.wikiname)</strong>"])

</p>

</div>

## Log

#template('logging_macros.vm')

560

#template('extension.vm')

561

## Hack to be able to use macros from extension.vm that are supposed to be used inside Extension Manager

562

#set($olddoc = $doc)

563

#set($doc = $xwiki.getDocument('XWiki.AddExtensions'))

564

#set($loading = $status.state != 'FINISHED')

565

566

#printLogs($status.log, $loading)

567

</div>

568

#set($doc = $olddoc)

569

#if($status.state == 'FINISHED')

570

#if ($status.error)

571

#set($finalizeHidden = true)

572

#set($cleanUpHidden = false)

573

#else

574

#set($finalizeHidden = false)

575

#set($cleanUpHidden = $errorlogs.isEmpty())

576

#end

577

#else

578

#set($finalizeHidden = true)

579

#set($cleanUpHidden = true)

580

#end

581

#wizardFooter('', '', '', 'finalize', $finalizeHidden, 'cleanUp', $cleanUpHidden)

</form>

#end

##################################

586

## FINALIZE

587

##

588

## Just go the the created wiki

589

##################################

590

#macro(finalize)

591

#set($wikiDescriptor = $services.wiki.getById($request.wikiId))

592

$response.sendRedirect($xwiki.getURL($wikiDescriptor.mainPageReference))

593

#end

594

##################################

595

## CLEAN UP

596

##

597

## Delete the wiki if errors has occured

598

##################################

599

#macro(cleanUp)

600

#set($discard = $xwiki.ssfx.use('uicomponents/wizard/wizard.css', true))

601

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

602

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

603

#set($wikiId = $request.wikiId)

604

#set($ok = $services.wiki.deleteWiki($wikiId))

605

$response.sendRedirect($doc.getURL('view', "step=cleanUp&deleteOk=$ok&wikiId=$wikiId"))

606

#else

607

608

#wizardHeader($services.localization.render('platform.wiki.create.wizard.step.cleaningUp'))

609

610

611

<p>$services.localization.render('platform.wiki.create.wizard.step.cleaningUp.confirmmessage', ["<strong>$request.wikiId</strong>"])</p>

<button value="cleanUp" title="Confirm" name="step" id="cleanUp" class="button">$services.localization.render('platform.wiki.create.wizard.step.cleaningUp.confirm')</button>

</span>

</div>

</div>

</form>

#end