Wiki source code of Scripting

Last modified by Simon Urli on 2023/10/10

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
5 Scripting allows you to create basic to complex web applications at the XWiki page (or view) layer without the need for compiling code or deploying software components. In other words, you can use scripting syntax in addition to wiki markup inside the content of an XWiki page (e.g. see the [[script syntax for the XWiki 2.1 syntax>>Documentation.UserGuide.Features.XWikiSyntax.WebHome?syntax=2.1&section=Macros]]).
7 XWiki integrates [[jsr-223>>]] scripting. You can script using several available languages by using the generic [[Script Macro>>extensions:Extension.Script Macro]] or one of following specific macros:
9 * [[Velocity Macro>>extensions:Extension.Velocity Macro]] (installed by default in XWiki)
10 * [[Groovy Macro>>extensions:Extension.Groovy Macro]] (installed by default in XWiki)
11 * [[Python Macro>>extensions:Extension.Python Macro]] (installed by default in XWiki)
12 * [[Ruby Macro>>extensions:Extension.Ruby Macro]] (not installed by default in XWiki)
13 * [[PHP Macro>>extensions:Extension.PHP Macro]] (not installed by default in XWiki)
15 = Permissions =
17 Starting with XWiki 7.2M1, a user needs to have the [[Script Permission in order to be able to write Script>>extensions:Extension.Script Macro#HRights]].
19 In addition, all scripting languages other than Velocity also require Programming Rights (see below for more details).
21 = Choosing a Scripting language =
23 Since XWiki supports several scripting languages you might be wondering which one to use. Most of the code written by XWiki developers is in Velocity, with a few more complex extensions written in Groovy; these two are thoroughly tried and tested, so they are both a safe bet. The other languages //should// work just as well, but there are less developers that could help answering any questions.
25 == Velocity ==
27 The first thing to know is that Velocity is different from the other scripting languages on 2 aspects:
29 * It's a templating language rather than a pure scripting language, which means that its content is actually wiki markup interspersed with Velocity directives, whereas pure scripting languages are written in that language and they need to explicitly output wiki markup. For example:(((
30 Velocity:
32 {{code}}
33 {{velocity}}
34 Your username is $xcontext.getUser(), welcome to the site.
35 {{/velocity}}
36 {{/code}}
38 Groovy:
40 {{code}}
41 {{groovy}}
42 println("Your username is " + xcontext.getUser() + " welcome to the site.");
43 {{/groovy}}
44 {{/code}}
45 )))
46 * It doesn't require special permissions (other than Script Permission starting with XWiki 7.2M1) since it runs in a Sandbox, with access to only a few safe objects, and each API call will check the rights configured in the wiki, forbidding access to resources or actions that the current user shouldn't be allowed to retrieve/perform. Other scripting language require the user that wrote the script to have Programming Rights to execute them, but except this initial precondition, access is granted to all the resources on the server. Note that starting with XWiki 4.1 we've introduced a [[Sandbox for Groovy>>xwiki:Documentation.AdminGuide.Configuration#HSecuringGroovyScripts]] too, but it's still in an early stage and is currently very restrictive.
48 Being a templating engine, Velocity doesn't offer many means of structuring code. In fact, there's only one useful directive in this regard, ###macro##. However, because it is a templating engine, its syntax is much simpler and easier to understand by non-developers, which means that it's accessible to a wider range of users, without a serious background in programming.
50 Without Programming Rights, it's impossible to instantiate new objects, except literals and those safely offered by the XWiki APIs. Nevertheless, the XWiki API is powerful enough to allow a wide range of applications to be safely developed, if "the XWiki way" is properly followed.
52 Velocity is also available in some other parts of XWiki: it is the language in which all the templates that generate the HTML UI of XWiki are written, it can be optionally activated in skin extensions, and it is executed when sending CSS and JavaScript skin resources from the filesystem.
54 In conclusion, **Velocity is suited for projects with small to medium complexity, and which don't require access to other resources except the provided XWiki API and registered script services. It allows very quick and easy development, offers good security and decent performance, and can easily be packaged and distributed as a XAR.**
56 == Groovy ==
58 Groovy is a full-fledged scripting language, which supports almost the entire Java syntax, and provides its own syntax delicacies and custom APIs that enhance the Java language even further. While it is recommended that complex code be written in Java as components accessible via script services, Groovy has the advantage that it is written live in the wiki, without requiring compilation, deployment and server restarts, thus enabling faster development.
60 The XWiki API is available in the context when executing Groovy scripts, but unlike in Velocity, the code isn't limited to this API, and any other classes or objects can be accessed freely. New classes can be defined in Groovy, compatible with Java classes, and this allows more structured code to be written, unlike in Velocity. A particular case of classes is new component roles and component implementations, which allows, for example, new script services or new event listeners to be defined in the wiki. It is possible to load attached jar files into the classpath of an executing script, which means that a wiki document can contain a complex program AND its required libraries not already provided by the platform.
62 Other than being available as a scripting language for writing custom code, it is also the language in which scheduler tasks are written.
64 In conclusion, **Groovy is suited for complex projects or for custom wiki enhancement through new components, when speedy live development is required. Being written in wiki documents, it can also be easily packaged and distributed as a XAR.**
66 After taking into account these considerations and if requiring Programming Rights isn't an issue for you, you should pick the script language that you're most familiar with!
68 = XWiki Scripting API =
70 The API is documented in Javadoc format and can be accessed here: [[XWiki API Javadoc>>Documentation.DevGuide.API.WebHome]]. If you are not familiar with Java or object oriented programming, you will probably be confused by the API documentation. It is not within the scope of our documentation to teach you all the details about Java, or object oriented programming. You can find all of that information already online. You can also explore the page code found throughout the [[Extensions wiki>>extensions:Main.WebHome]] area to see how others have figured out how to achieve a variety of results.
72 We're also making available an [[API Guide>>Documentation.DevGuide.Scripting.APIGuide.WebHome]] with examples about using the XWiki API.
74 == [[Bindings>>extensions:Extension.Script Macro#HBindings]] ==
76 The main objects available to you in scripting languages are:
78 * The current Document: **##doc##**
79 * The Context of the request: **##xcontext##**
80 * The Request object: **##request##**
81 * The Response object: **##response##**
82 * The XWiki object: **##xwiki##**
83 * The XWiki utils: **##util##** (this is deprecated)
84 * Various [[Script Services>>extensions:Extension.Script Module]]: **##services##**
86 See [[Scripting Reference Documentation>>xwiki:ScriptingDocumentation.WebHome]] for a complete list.
88 == [[XWiki Component>>extensions:Extension.Component Module]] Access ==
90 Since XWiki 4.1M2+ there's a Script Service to access the Component Manager (see also: [[Accessing components from Groovy>>Documentation.DevGuide.Tutorials.WritingComponents.WebHome#HFromwikipages]]).
92 For example using Groovy you'd write:
94 {{code language="java"}}
95 {{groovy}}
96 def greeter = services.component.getInstance(org.xwiki.component.HelloWorld.class)
97 println greeter.sayHello()
98 {{/groovy}}
99 {{/code}}
101 You can also get the ComponentManager with:
103 {{code language="java"}}
104 {{groovy}}
105 def cm = services.component.componentManager
106 {{/groovy}}
107 {{/code}}
109 {{info}}
110 With versions of XWiki older than 4.1M2 you'd use (in Groovy):
112 {{code language="java"}}
113 {{groovy}}
114 def greeter = com.xpn.xwiki.web.Utils.getComponent(org.xwiki.component.HelloWorld.class)
115 println greeter.sayHello()
116 {{/groovy}}
117 {{/code}}
118 {{/info}}
120 == XWiki Core Access ==
122 Sometimes the XWiki Api doesn't provide the methods which you need for your application. You can gain raw access the core of XWiki but it presents an increased security risk and requires **Programming Rights** to be able to save the page containing the script (Programming Rights are not required for viewing a page containing a script requiring Programming Rights, rights are only needed at save time). Using the core should be avoided if at all possible.
124 {{code language="java"}}
125 {{groovy}}
126 def xc = xcontext.getContext();
127 def wiki = xc.getWiki();
128 def xdoc = doc.getDocument();
129 {{/groovy}}
130 {{/code}}
132 After using this snippet, you will have 3 new objects:
134 * {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/"}}The underlying XWikiContext behind the Context object{{/scm}}: **##xc##**
135 * {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/"}}The underlying XWiki object which backs the **##xwiki##** object{{/scm}}: **##wiki##**
136 * {{scm path="xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/doc/"}}The underlying XWikiDocument behind the current Document{{/scm}}: **##xdoc##**
138 You will find that many of the methods in **##wiki##** and **##xdoc##** require an instance of the XWikiContext, this is the underlying xcontext **##xc##** not the Api context **##xcontext##**.
140 Again, these methods are only for the rare cases when functionality is not provided by the public Api. We put a lot of effort into preserving the behavior of the public Api and much less into preserving the behavior of core methods so you may find that core methods are deprecated, removed, or their behavior is changed in subsequent versions.
142 == Querying XWiki's Model ==
144 From your script you can query the full XWiki Model. Check the [[Query Module>>extensions:Extension.Query Module]] for more information.
146 See also this [[HQL tutorial in Velocity>>Documentation.DevGuide.Scripting.velocityHqlExamples.WebHome]].
148 {{id name="velocity"/}}
150 = Velocity Specific Information =
152 Velocity is currently the only scripting language which can be used without Programming [[xwiki:Documentation.AdminGuide.Access Rights]]. This means you can save Velocity scripts using a user with less permissions and nobody will be able to exploit your script to perform a security breach.
154 You can [[gain access to the XWiki core>>#HXWikiCoreAccess]] from Velocity but this will require Programming Rights. Strictly speaking, protected APIs are only available when the page that contains them was last saved by someone who had Programming Rights (see above).
156 In Velocity you can't import classes and as such you cannot gain direct access to XWiki components as shown [[above>>Documentation.DevGuide.WebHome#HXWikiComponentAccess]]. This leaves you with the provided [[bindings>>Documentation.DevGuide.WebHome#HBindings]] (NOTE: In Velocity, these bindings all start with **##$##** as with all other Velocity variables)
158 For more information about programming in the Velocity language, you can refer to the [[Velocity User Guide>>]]. See also this [[Velocity Training Presentation>>Documentation.DevGuide.Scripting.XWikiVelocityTraining.WebHome]].
160 For more details on using Velocity check the [[Velocity Module Documentation>>extensions:Extension.Velocity Module]] which also contains the full list of Velocity Tools that you can use in your scripts.
162 {{info}}
163 If you wish to add new Velocity tools you'll need to edit your file and follow the instructions in there.
164 {{/info}}
166 To include Velocity scripts in other Velocity scripts, see [[How to include a Velocity page into another page>>FAQ.IncludeInVelocity]].
168 == Velocity Macros ==
170 See [[available Velocity macros>>extensions:Extension.Web Resources for XWiki.WebHome]].
172 == Other Velocity Variables ==
174 === Controlling Page Tabs ===
176 You can control whether to display Comments/Annotations/History/Attachment/Information tabs or not by setting some velocity variables to ##false##:
178 {{code language="velocity"}}
179 #set ($showcomments = false)
180 #set ($showannotations = false)
181 #set ($showattachments = false)
182 #set ($showhistory = false)
183 #set ($showinformation = false)
184 {{/code}}
186 To remove them all you can set:
188 {{code language="velocity"}}
189 #set($displayDocExtra = false)
190 {{/code}}
192 You can also control whether shortcuts links are displayed in the page menu:
194 {{code language="velocity"}}
195 #set($displayShortcuts = false)
196 {{/code}}
198 === Control Content Footer ===
200 {{info}}XWiki 9.8{{/info}} The content footer can be controlled through the ##displayContentFooter## binding.
202 {{image reference="contentFooterAndDocextra.png"/}}
204 === Information about the current user ===
206 The following variables (set in the {{scm path="xwiki-platform-core/xwiki-platform-web/xwiki-platform-web-templates/src/main/resources/templates/xwikivars.vm"}}xwikivars.vm{{/scm}} template) are shortcuts for checking various information **for the current user**:
208 * ##$isGuest##: checks if the current user is ##XWiki.XWikiGuest##
209 * ##$isSuperAdmin##: checks if the current user is the special user ##superadmin##
211 * ##$hasComment##: checks comment rights on the current document
212 * ##$hasEdit##: checks edit rights on the current document
213 * ##$hasWatch##: checks if the user is authenticated and the watch service is available
215 * ##$hasAdmin##: checks admin rights on the current document
216 * ##$hasSpaceAdmin##: checks admin rights on the ##XWikiPreferences## document of the current space
217 * ##$hasGlobalAdmin##: checks admin rights on ##XWiki.XWikiPreferences##
219 * ##$hasCreateSpace##: checks edit rights on that page that does not exist, in a space that doesn't exist
220 * ##$hasCreatePage##: checks edit rights on that page that does not exist, in the current space
222 * ##$hasProgramming##: checks if the current user has programming rights
224 * ##$isAdvancedUser##: advanced users: ##superadmin##, users with the ##usertype## property set to "Advanced", guest users with admin rights
226 Example:
228 {{code language="velocity"}}
229 {{velocity}}
230 #if ($hasAdmin)
231 ## This link will only be visible to users that have admin rights on this document
232 [[Do some admin action>>Some.Document]]
233 #end
234 {{/velocity}}
235 {{/code}}
237 === Information about the current wiki ===
239 The following variables (set in the {{scm path="xwiki-platform-core/xwiki-platform-web/xwiki-platform-web-templates/src/main/resources/templates/xwikivars.vm"}}xwikivars.vm{{/scm}} template) are shortcuts for checking various information **about the current wiki**:
241 * ##$isReadOnly##
242 * ##$isInServletMode##
243 * ##$isInPortletMode##
245 = Groovy Specific Information =
247 {{info}}
248 Currently all non Velocity scripting languages are only allowed to be used by users having Programming Rights.
249 {{/info}}
251 * See Groovy snippets in the [[Snippets wiki>>snippets:Main.WebHome]] (click on the "Groovy" tag in the Tag Cloud)
252 * [[Groovy web site>>]]
254 == Groovy Example ==
256 The following example demonstrates how to use a groovy script to interact with velocity code in your page. This example performs a DNS lookup from the velocity variable ##$hostname## and stores the result in the variable ##$address##.
258 **Using XWiki Syntax 2.0:**
260 Objects can be passed back and forth between scripting languages by storing them in commonly available objects. One such commonly available object which only lasts the length of the request is the context object, known as xcontext.
262 {{code language="velocity"}}
263 {{velocity}}
264 #set($hostname = "")
265 Host Name: $hostname
266 $xcontext.put("hostname", $hostname)
267 {{/velocity}}
268 {{groovy}}
269 import;
270 host = xcontext.get("hostname");
271 InetAddress addr = InetAddress.getByName(host);
272 String address = addr.getHostAddress();
273 xcontext.put("address", address);
274 {{/groovy}}
275 {{velocity}}
276 IP Address: $xcontext.get("address")
277 {{/velocity}}
278 {{/code}}
280 **Using XWiki Syntax 1.0:**
282 Because Groovy and Velocity code are parsed together, variables defined in Groovy can be used directly in velocity without storing in and retrieving from the context.
284 {{code language="velocity"}}
285 #set ($hostname = "")
286 Host Name: $hostname
287 <%
288 import;
289 vcontext = context.get("vcontext");
290 host = vcontext.get("hostname");
291 InetAddress addr = InetAddress.getByName(host);
292 String address = addr.getHostAddress();
293 %>
294 IP Address: $address
295 {{/code}}
297 = Python Specific Information =
299 You can run Python code in XWiki just like Velocity or Groovy.
301 {{code language="python"}}
302 {{python}}
303 print "The full name of this document is " + doc.getFullName()
304 {{/python}}
305 {{/code}}
307 = Share variable between languages =
309 Most JSR223 based scripting languages reinject the created variable in the current ##ScriptContext## which means you can define a variable in a Groovy script and reuse it in a following Python script for example.
311 Since the Velocity implementation isn't based on JSR223, we have also set up a bridge so that Velocity scripts can access the current ##ScriptContext## variables. This allows for example to define a variable in a Groovy script and then reuse it in a Velocity one:
313 {{code}}
314 {{groovy}}
315 var = "foo"
316 {{/groovy}}
318 {{velocity}}
319 $var
320 {{/velocity}}
321 {{/code}}
323 Starting with XWiki 8.3 the Velocity bridge has been improved and it's now possible to do the opposite, i.e. define a variable in Velocity and access it from another scripting language. For example:
325 {{code}}
326 {{velocity}}
327 #set($myvar = "foo")
328 {{/velocity}}
330 {{groovy}}
331 print myvar
332 {{/groovy}}
333 {{/code}}
335 Note that you can also share variables by setting them in the XWiki Context (##xcontext## binding).
337 = Scripting In XWiki Syntax 1.0 =
339 XWiki Syntax 1.0 is rendered by an old rendering engine which is still supported but for which no further development is planned (it will eventually be removed). Syntax 1.0 has some idiosyncrasies which were solved by syntax 2.0.
341 * The only scripting languages available to you are Velocity and Groovy.
342 * In Groovy, the context is known as: **##context##** not **##xcontext##**
343 * The beginning and end of Groovy scripts are denoted by <% and %> rather than through the [[extensions:Extension.Groovy Macro]] (using ~{~{groovy}} and ~{~{/groovy}})
344 * Velocity is parsed in a page no matter what (there is no need to invoke the [[extensions:Extension.Velocity Macro]] using ~{~{velocity}} and ~{~{/velocity}})
346 The last part is important because it means you need to be careful when using **$** and **#** in your document. This is still true inside of **<%** and **%>** so you have to be careful when writing Groovy.

Get Connected