Skip to Content

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 7.1
edited by Ophion Admin
on 2026/10/06 19:32
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -3,6 +3,8 @@
3 3  #set ($appClass = 'api.Code.apiClass')
4 4  ## Lowercase letters and digits, single hyphens only between the parts
5 5  #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"))
6 6  ## Collect all AWM apps: data class name -> app title
7 7  #set ($apps = {})
8 8  #set ($xwql = "select doc.fullName from Document doc, doc.object(AppWithinMinutes.LiveTableClass) as app order by doc.fullName")
... ... @@ -16,10 +16,47 @@
16 16   #end
17 17   #end
18 18  #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
19 19  #set ($errorMsg = '')
20 -#if ("$!request.createEntry" == '1')
21 - #set ($name = "$!request.name")
22 - #set ($sourceClass = "$!request.sourceClass")
61 +#if ("$!request.createEntry" == '1' && $canCreate)
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.')
68 + #elseif ($filterField != '' && !$values.contains($filterValue))
69 + #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))
81 + #set ($discard = $newObj.set('filterField', $filterField))
82 + #set ($discard = $newObj.set('filterValue', $filterValue))
40 40   #set ($discard = $newDoc.save('Created API entry'))
41 41   $response.sendRedirect($doc.getURL())
42 42   #end
... ... @@ -50,18 +50,33 @@
50 50   /* Hide the default AWM "Add new entry" button */
51 51   ul.actions a.action.add, a.action.add { display: none !important; }
52 52  </style>
96 +#if ($canCreate)
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">
99 + <!-- Changing the app or the field reloads the form without creating anything -->
100 + <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>
102 + <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"
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)"
62 62   pattern="$namePattern" title="Lowercase letters, digits and hyphens only"/>
63 - <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>
64 64  </form>
122 +#end
65 65  {{/html}}
66 66  {{/velocity}}
67 67  
... ... @@ -69,6 +69,7 @@
69 69  #set ($columnsProperties = {
70 70   'doc.title': {"link":"view"},
71 71   'sourceClass': {},
130 + 'getUrl': {"html":true,"sortable":false,"filterable":false},
72 72   'doc.location': {"html":true},
73 73   'doc.date': {},
74 74   'doc.author': {"link":"author"},
... ... @@ -83,6 +83,6 @@
83 83   'selectedColumn': 'doc.title',
84 84   'defaultOrder': 'asc'
85 85  })
86 -#set ($columns = ['doc.title', 'sourceClass', 'doc.location', 'doc.date', 'doc.author', '_actions'])
145 +#set ($columns = ['doc.title', 'sourceClass', 'getUrl', 'doc.location', 'doc.date', 'doc.author', '_actions'])
87 87  #livetable('api' $columns $columnsProperties $options)
88 88  {{/velocity}}