Changes for page api
Last modified by Ophion Admin on 2026/10/06 19:32
From version 2.1
edited by Ophion Admin
on 2026/10/06 15:59
on 2026/10/06 15:59
Change comment:
There is no comment for this version
To version 7.1
edited by Ophion Admin
on 2026/10/06 19:32
on 2026/10/06 19:32
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,9 +1,10 @@ 1 1 {{velocity}} 2 2 #set ($appSpace = 'api') 3 3 #set ($appClass = 'api.Code.apiClass') 4 -#set ($templateRef = 'api.Code.apiTemplate') 5 5 ## Lowercase letters and digits, single hyphens only between the parts 6 6 #set ($namePattern = '[a-z0-9]+(-[a-z0-9]+)*') 6 +## Only users with edit right on the app home page may create APIs 7 +#set ($canCreate = $xwiki.hasAccessLevel('edit', $xcontext.user, "${appSpace}.WebHome")) 7 7 ## Collect all AWM apps: data class name -> app title 8 8 #set ($apps = {}) 9 9 #set ($xwql = "select doc.fullName from Document doc, doc.object(AppWithinMinutes.LiveTableClass) as app order by doc.fullName") ... ... @@ -17,22 +17,70 @@ 17 17 #end 18 18 #end 19 19 #end 21 +## Current state of the form 22 +#set ($name = "$!request.name") 23 +#set ($sourceClass = "$!request.sourceClass") 24 +#set ($filterField = "$!request.filterField") 25 +#set ($filterValue = "$!request.filterValue") 26 +## Preselect the first app on the first page load 27 +#if ($sourceClass == '') 28 + #foreach ($key in $apps.keySet()) 29 + #set ($sourceClass = $key) 30 + #break 31 + #end 32 +#end 33 +## Fields of the selected source app 34 +#set ($fields = []) 35 +#if ($apps.containsKey($sourceClass)) 36 + #foreach ($p in $xwiki.getDocument($sourceClass).getxWikiClass().properties) 37 + #set ($discard = $fields.add($p.name)) 38 + #end 39 +#end 40 +## Reset the filter if the field does not belong to the selected app 41 +#if (!$fields.contains($filterField)) 42 + #set ($filterField = '') 43 + #set ($filterValue = '') 44 +#end 45 +## Existing values of the selected field 46 +#set ($values = []) 47 +#if ($filterField != '') 48 + #set ($template = $sourceClass.replaceAll('Class$', 'Template')) 49 + #set ($hql = "select distinct doc.fullName from XWikiDocument doc, BaseObject obj where obj.name = doc.fullName and obj.className = :cls and doc.fullName <> :tpl order by doc.fullName") 50 + #foreach ($entryName in $services.query.hql($hql).bindValue('cls', $sourceClass).bindValue('tpl', $template).execute()) 51 + #set ($entry = $xwiki.getDocument($entryName)) 52 + #if ($entry) 53 + #set ($value = "$!entry.getObject($sourceClass).getValue($filterField)") 54 + #if ($value != '' && !$values.contains($value)) 55 + #set ($discard = $values.add($value)) 56 + #end 57 + #end 58 + #end 59 +#end 20 20 #set ($errorMsg = '') 21 -#if ("$!request.createEntry" == '1') 22 - # set($name ="$!request.name")23 - #set ($ sourceClass="$!request.sourceClass")24 - #if (!$name.matches($namePattern)) 61 +#if ("$!request.createEntry" == '1' && $canCreate) 62 + #if (!$services.csrf.isTokenValid("$!request.form_token")) 63 + #set ($errorMsg = 'Invalid form token, please try again.') 64 + #elseif (!$name.matches($namePattern)) 25 25 #set ($errorMsg = 'Only lowercase letters, digits and hyphens are allowed.') 26 26 #elseif (!$apps.containsKey($sourceClass)) 27 27 #set ($errorMsg = 'Invalid source application.') 68 + #elseif ($filterField != '' && !$values.contains($filterValue)) 69 + #set ($errorMsg = 'Please select a filter value.') 28 28 #else 29 29 #set ($ref = $services.model.createDocumentReference('', [$appSpace, $name], 'WebHome')) 30 30 #if ($xwiki.exists($ref)) 31 31 #set ($errorMsg = "An API named '${name}' already exists.") 32 32 #else 33 - ## The last parameter prefills the sourceClass field of the new entry 34 - #set ($qs = $escapetool.url({'template': $templateRef, 'parent': "${appSpace}.WebHome", 'title': $name, "${appClass}_0_sourceClass": $sourceClass})) 35 - $response.sendRedirect($xwiki.getURL($ref, 'edit', $qs)) 75 + ## Create and save the entry directly, no edit form needed 76 + #set ($newDoc = $xwiki.getDocument($ref)) 77 + #set ($discard = $newDoc.setTitle($name)) 78 + #set ($discard = $newDoc.setParent("${appSpace}.WebHome")) 79 + #set ($newObj = $newDoc.newObject($appClass)) 80 + #set ($discard = $newObj.set('sourceClass', $sourceClass)) 81 + #set ($discard = $newObj.set('filterField', $filterField)) 82 + #set ($discard = $newObj.set('filterValue', $filterValue)) 83 + #set ($discard = $newDoc.save('Created API entry')) 84 + $response.sendRedirect($doc.getURL()) 36 36 #end 37 37 #end 38 38 #end ... ... @@ -44,17 +44,33 @@ 44 44 /* Hide the default AWM "Add new entry" button */ 45 45 ul.actions a.action.add, a.action.add { display: none !important; } 46 46 </style> 47 -<form action="$doc.getURL()" method="get" class="form-inline"> 48 - <input type="hidden" name="createEntry" value="1"/> 49 - <select name="sourceClass" class="form-control"> 96 +#if ($canCreate) 97 +<form action="$doc.getURL()" method="post" class="form-inline"> 98 + <input type="hidden" name="form_token" value="$!services.csrf.token"/> 99 + <!-- Changing the app or the field reloads the form without creating anything --> 100 + <select name="sourceClass" class="form-control" onchange="this.form.submit()"> 50 50 #foreach ($app in $apps.entrySet()) 51 - <option value="$escapetool.xml($app.key)">$escapetool.xml($app.value)</option> 102 + <option value="$escapetool.xml($app.key)" #if ($app.key == $sourceClass)selected="selected"#end>$escapetool.xml($app.value)</option> 52 52 #end 53 53 </select> 54 - <input type="text" name="name" class="form-control" required="required" 105 + <select name="filterField" class="form-control" onchange="this.form.submit()"> 106 + <option value="">(no filter)</option> 107 + #foreach ($field in $fields) 108 + <option value="$escapetool.xml($field)" #if ($field == $filterField)selected="selected"#end>$escapetool.xml($field)</option> 109 + #end 110 + </select> 111 + #if ($filterField != '') 112 + <select name="filterValue" class="form-control"> 113 + #foreach ($value in $values) 114 + <option value="$escapetool.xml($value)" #if ($value == $filterValue)selected="selected"#end>$escapetool.xml($value)</option> 115 + #end 116 + </select> 117 + #end 118 + <input type="text" name="name" class="form-control" required="required" value="$escapetool.xml($name)" 55 55 pattern="$namePattern" title="Lowercase letters, digits and hyphens only"/> 56 - < input type="submit" class="btn btn-primary"value="Create API"/>120 + <button type="submit" name="createEntry" value="1" class="btn btn-primary">Create API</button> 57 57 </form> 122 +#end 58 58 {{/html}} 59 59 {{/velocity}} 60 60 ... ... @@ -61,6 +61,8 @@ 61 61 {{velocity}} 62 62 #set ($columnsProperties = { 63 63 'doc.title': {"link":"view"}, 129 + 'sourceClass': {}, 130 + 'getUrl': {"html":true,"sortable":false,"filterable":false}, 64 64 'doc.location': {"html":true}, 65 65 'doc.date': {}, 66 66 'doc.author': {"link":"author"}, ... ... @@ -75,6 +75,6 @@ 75 75 'selectedColumn': 'doc.title', 76 76 'defaultOrder': 'asc' 77 77 }) 78 -#set ($columns = ['doc.title', 'doc.location', 'doc.date', 'doc.author', '_actions']) 145 +#set ($columns = ['doc.title', 'sourceClass', 'getUrl', 'doc.location', 'doc.date', 'doc.author', '_actions']) 79 79 #livetable('api' $columns $columnsProperties $options) 80 80 {{/velocity}}