Changes for page api

Last modified by Ophion Admin on 2026/10/06 19:32

From version 4.1
edited by Ophion Admin
on 2026/10/06 16:02
Change comment: There is no comment for this version
To version 5.1
edited by Ophion Admin
on 2026/10/06 16:20
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -16,10 +16,47 @@
16 16   #end
17 17   #end
18 18  #end
19 +## Current state of the form
20 +#set ($name = "$!request.name")
21 +#set ($sourceClass = "$!request.sourceClass")
22 +#set ($filterField = "$!request.filterField")
23 +#set ($filterValue = "$!request.filterValue")
24 +## Preselect the first app on the first page load
25 +#if ($sourceClass == '')
26 + #foreach ($key in $apps.keySet())
27 + #set ($sourceClass = $key)
28 + #break
29 + #end
30 +#end
31 +## Fields of the selected source app
32 +#set ($fields = [])
33 +#if ($apps.containsKey($sourceClass))
34 + #foreach ($p in $xwiki.getDocument($sourceClass).getxWikiClass().properties)
35 + #set ($discard = $fields.add($p.name))
36 + #end
37 +#end
38 +## Reset the filter if the field does not belong to the selected app
39 +#if (!$fields.contains($filterField))
40 + #set ($filterField = '')
41 + #set ($filterValue = '')
42 +#end
43 +## Existing values of the selected field
44 +#set ($values = [])
45 +#if ($filterField != '')
46 + #set ($template = $sourceClass.replaceAll('Class$', 'Template'))
47 + #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")
48 + #foreach ($entryName in $services.query.hql($hql).bindValue('cls', $sourceClass).bindValue('tpl', $template).execute())
49 + #set ($entry = $xwiki.getDocument($entryName))
50 + #if ($entry)
51 + #set ($value = "$!entry.getObject($sourceClass).getValue($filterField)")
52 + #if ($value != '' && !$values.contains($value))
53 + #set ($discard = $values.add($value))
54 + #end
55 + #end
56 + #end
57 +#end
19 19  #set ($errorMsg = '')
20 20  #if ("$!request.createEntry" == '1')
21 - #set ($name = "$!request.name")
22 - #set ($sourceClass = "$!request.sourceClass")
23 23   #if (!$services.csrf.isTokenValid("$!request.form_token"))
24 24   #set ($errorMsg = 'Invalid form token, please try again.')
25 25   #elseif (!$name.matches($namePattern))
... ... @@ -26,6 +26,8 @@
26 26   #set ($errorMsg = 'Only lowercase letters, digits and hyphens are allowed.')
27 27   #elseif (!$apps.containsKey($sourceClass))
28 28   #set ($errorMsg = 'Invalid source application.')
66 + #elseif ($filterField != '' && !$values.contains($filterValue))
67 + #set ($errorMsg = 'Please select a filter value.')
29 29   #else
30 30   #set ($ref = $services.model.createDocumentReference('', [$appSpace, $name], 'WebHome'))
31 31   #if ($xwiki.exists($ref))
... ... @@ -37,6 +37,8 @@
37 37   #set ($discard = $newDoc.setParent("${appSpace}.WebHome"))
38 38   #set ($newObj = $newDoc.newObject($appClass))
39 39   #set ($discard = $newObj.set('sourceClass', $sourceClass))
79 + #set ($discard = $newObj.set('filterField', $filterField))
80 + #set ($discard = $newObj.set('filterValue', $filterValue))
40 40   #set ($discard = $newDoc.save('Created API entry'))
41 41   $response.sendRedirect($doc.getURL())
42 42   #end
... ... @@ -51,16 +51,29 @@
51 51   ul.actions a.action.add, a.action.add { display: none !important; }
52 52  </style>
53 53  <form action="$doc.getURL()" method="post" class="form-inline">
54 - <input type="hidden" name="createEntry" value="1"/>
55 55   <input type="hidden" name="form_token" value="$!services.csrf.token"/>
56 - <select name="sourceClass" class="form-control">
96 + <!-- Changing the app or the field reloads the form without creating anything -->
97 + <select name="sourceClass" class="form-control" onchange="this.form.submit()">
57 57   #foreach ($app in $apps.entrySet())
58 - <option value="$escapetool.xml($app.key)">$escapetool.xml($app.value)</option>
99 + <option value="$escapetool.xml($app.key)" #if ($app.key == $sourceClass)selected="selected"#end>$escapetool.xml($app.value)</option>
59 59   #end
60 60   </select>
61 - <input type="text" name="name" class="form-control" required="required"
102 + <select name="filterField" class="form-control" onchange="this.form.submit()">
103 + <option value="">(no filter)</option>
104 + #foreach ($field in $fields)
105 + <option value="$escapetool.xml($field)" #if ($field == $filterField)selected="selected"#end>$escapetool.xml($field)</option>
106 + #end
107 + </select>
108 + #if ($filterField != '')
109 + <select name="filterValue" class="form-control">
110 + #foreach ($value in $values)
111 + <option value="$escapetool.xml($value)" #if ($value == $filterValue)selected="selected"#end>$escapetool.xml($value)</option>
112 + #end
113 + </select>
114 + #end
115 + <input type="text" name="name" class="form-control" required="required" value="$escapetool.xml($name)"
62 62   pattern="$namePattern" title="Lowercase letters, digits and hyphens only"/>
63 - <input type="submit" class="btn btn-primary" value="Create API"/>
117 + <button type="submit" name="createEntry" value="1" class="btn btn-primary">Create API</button>
64 64  </form>
65 65  {{/html}}
66 66  {{/velocity}}