Skip to Content

Wiki source code of Scripting

Version 30.3 by Vincent Massol on 2010/12/10
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
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 and HTML syntax as the contents of an XWiki page.
6
7 XWiki integrates [[jsr-223>>http://scripting.dev.java.net/]] scripting. You can script using several available languages by using one of the following macros:
8
9 * [[Velocity Macro>>extensions:Extension.Velocity Macro]] (installed by default in XWiki Enterprise)
10 * [[Groovy Macro>>extensions:Extension.Groovy Macro]] (installed by default in XWiki Enterprise)
11 * [[Python Macro>>extensions:Extension.Python Macro]] (installed by default in XWiki Enterprise)
12 * [[Ruby Macro>>extensions:Extension.Ruby Macro]] (not installed by default in XWiki Enterprise)
13 * [[PHP Macro>>extensions:Extension.PHP Macro]] (not installed by default in XWiki Enterprise)
14
15 = XWiki Scripting API =
16
17 The API is documented in Javadoc format and can be accessed here: [[XWiki API Javadoc>>DevGuide.API]]. 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.
18
19 == [[Bindings>>extensions:Extension.Script Macro#HBindings]] ==
20
21 These objects are available to you in scripting languages.
22
23 * [[The current Document>>http://maven.xwiki.org/site/xwiki-core-parent/xwiki-core/apidocs/com/xpn/xwiki/api/Document.html]]: **##doc##**
24 * [[The Context of the request>>http://maven.xwiki.org/site/xwiki-core-parent/xwiki-core/apidocs/com/xpn/xwiki/api/Context.html]]: **##xcontext##**
25 * [[The Request object>>http://maven.xwiki.org/site/xwiki-core-parent/xwiki-core/apidocs/com/xpn/xwiki/web/XWikiRequest.html]]: **##request##**
26 * [[The Response object>>http://maven.xwiki.org/site/xwiki-core-parent/xwiki-core/apidocs/com/xpn/xwiki/web/XWikiResponse.html]]: **##response##**
27 * [[The XWiki object>>http://maven.xwiki.org/site/xwiki-core-parent/xwiki-core/apidocs/com/xpn/xwiki/api/XWiki.html]]: **##xwiki##**
28
29 == [[XWiki Component>>extensions:Extension.Component Module]] Access ==
30
31 You can also gain direct access to XWiki components using the following code snippet:
32 Also see: [[Accessing components from Groovy>>DevGuide.WritingComponents#HAccessingacomponentfromgroovy]]
33 Note: This snippet is written in Groovy and will have to be converted to your scripting language.
34
35 {{code language="java"}}{{groovy}}
36 def greeter = com.xpn.xwiki.web.Utils.getComponent(org.xwiki.component.HelloWorld.class);
37 println greeter.sayHello();
38 {{/groovy}}{{/code}}
39
40 == XWiki Core Access ==
41
42 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 run. Using the core should be avoided if at all possible.
43
44 {{code language="java"}}{{groovy}}
45 def xc = xcontext.getContext();
46 def wiki = xc.getWiki();
47 def xdoc = doc.getDocument();
48 {{/groovy}}{{/code}}
49
50 After using this snippet, you will have 3 new objects:
51
52 * [[The underlying XWikiContext behind the Context object>>http://maven.xwiki.org/site/xwiki-core-parent/xwiki-core/apidocs/com/xpn/xwiki/XWikiContext.html]]: **##xc##**
53 * [[The underlying XWiki object which backs the **##xwiki##** object>>http://maven.xwiki.org/site/xwiki-core-parent/xwiki-core/apidocs/com/xpn/xwiki/XWiki.html]]: **##wiki##**
54 * [[The underlying XWikiDocument behind the current Document>>http://maven.xwiki.org/site/xwiki-core-parent/xwiki-core/apidocs/com/xpn/xwiki/doc/XWikiDocument.html]]: **##xdoc##**
55
56 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##**.
57
58 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.
59
60 == Querying XWiki's Model ==
61
62 From your script you can query the full XWiki's Model. Check the [[Query Guide>>QueryGuide]] for more information.
63
64 {{id name="velocity"/}}
65
66 = Velocity Specific Information =
67
68 Velocity is the only scripting language which can be used without Administration or Programming [[AdminGuide.Access Rights]]. This means you can save velocity scripts using a username with less permission and an exploit of your script is less of a security breach. Also if you are administrating a [[virtual wiki>>AdminGuide.Virtualization]] and you don't have programming rights, you can still do scripting in Velocity.
69 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 has programming rights.
70
71 In Velocity you can't import classes and as such you cannot gain direct access to XWiki components as shown [[above>>#HXWikiComponentAccess]]. This leaves you with the provided [[bindings>>#HBindings]] (NOTE: In Velocity, these bindings all start with **##$##** as with all other Velocity variables)
72
73 For more information about programming in the Velocity language, you can refer to the [[Velocity User Guide>>http://velocity.apache.org/engine/releases/velocity-1.6.2/user-guide.html]].
74
75 The following Velocity tools are also available in addition to the bindings.
76
77 * [[List Tool>>http://velocity.apache.org/tools/releases/1.4/javadoc/org/apache/velocity/tools/generic/ListTool.html]]: **##$listtool##**
78 * [[Number Tool>>http://velocity.apache.org/tools/releases/1.4/javadoc/org/apache/velocity/tools/generic/NumberTool.html]]: **##$numbertool##**
79 * [[Comparison Date Tool>>http://velocity.apache.org/tools/releases/1.4/javadoc/org/apache/velocity/tools/generic/ComparisonDateTool.html]] (extends [[Date Tool>>http://velocity.apache.org/tools/releases/1.4/javadoc/org/apache/velocity/tools/generic/DateTool.html]]): **##$datetool##**
80 * [[Math Tool>>http://velocity.apache.org/tools/releases/1.4/generic/MathTool.html]]: **##$mathtool##**
81 * [[Escape Tool>>http://velocity.apache.org/tools/releases/1.4/generic/EscapeTool.html]]: **##$escapetool##**
82 * [[Sort Tool>>http://velocity.apache.org/tools/releases/1.4/javadoc/org/apache/velocity/tools/generic/SortTool.html]]: **##$sorttool##**
83 * Message Tool: **##$msg##** This tool is used to provide internationalized messages based on keys. For more details see the [[How to Write Internationalized Applications tutorial>>DevGuide.InternationalizingApplications]].
84
85 {{info}}
86 If you wish to add new Velocity tools you'll need to edit your ##xwiki.properties## file and follow the instructions in there.
87 {{/info}}
88
89 To include Velocity scripts in other Velocity scripts, see [[How to include a velocity page into another page>>DevGuide.IncludeInVelocity]].
90
91 == Other Velocity Variables ==
92
93 {{warning}}
94 These variables can be used but are subject to change in the future.
95 {{/warning}}
96
97 {{id name="HControllingwhethertodisplayCommentsHistoryAttachmentInformationsectionsornot"/}}
98
99 === Controlling Which Sections to Display ===
100
101 You can control whether to display Comments/History/Attachment/Information sections or not by setting some velocity variable to "no":
102
103 {{code}}
104 #set ($showcomments = "no")
105 #set ($showattachments = "no")
106 #set ($showhistory = "no")
107 #set ($showinformation = "no")
108 {{/code}}
109
110 To remove them all you can set:
111
112 {{code}}
113 #set($docextras = [])
114 {{/code}}
115
116 === Information about the current user ===
117
118 The following variables (set in the [[xwikivars.vm>>http://svn.xwiki.org/svnroot/xwiki/platform/web/trunk/standard/src/main/webapp/templates/xwikivars.vm]] template) are shortcuts for checking various information **for the current user**:
119
120 * ##$isGuest##: checks if the current user is ##XWiki.XWikiGuest##
121 * ##$isSuperAdmin##: checks if the current user is the special user ##superadmin##
122
123 * ##$hasComment##: checks comment rights on the current document
124 * ##$hasEdit##: checks edit rights on the current document
125 * ##$hasWatch##: checks if the user is authenticated and the watch service is available
126
127 * ##$hasAdmin##: checks admin rights on the current document
128 * ##$hasSpaceAdmin##: checks admin rights on the ##XWikiPreferences## document of the current space
129 * ##$hasGlobalAdmin##: checks admin rights on ##XWiki.XWikiPreferences##
130
131 * ##$hasCreateSpace##: checks edit rights on that page that does not exist, in a space that doesn't exist
132 * ##$hasCreatePage##: checks edit rights on that page that does not exist, in the current space
133
134 * ##$hasProgramming##: checks if the current user has programming rights
135
136 * ##$isAdvancedUser##: advanced users: ##superadmin##, users with the ##usertype## property set to "Advanced", guest users with admin rights
137
138 Example:
139
140 {{code}}{{velocity}}
141 #if ($hasAdmin)
142 ## This link will only be visible to users that have admin rights on this document
143 [[Do some admin action>>Some.Document]]
144 #end
145 {{/velocity}}{{/code}}
146
147
148 === Information about the current wiki ===
149
150 The following variables (set in the [[xwikivars.vm>>http://svn.xwiki.org/svnroot/xwiki/platform/web/trunk/standard/src/main/webapp/templates/xwikivars.vm]] template) are shortcuts for checking various information **about the current wiki**:
151
152 * ##$isReadOnly##
153 * ##$isInServletMode##
154 * ##$isInPortletMode##
155
156 = Groovy Specific Information =
157
158 Currently all non Velocity scripting languages are only allowed for administrators of a wiki (or users having the 'programming' right).
159
160 * See Groovy examples in the [[Extensions wiki>>extensions:Main.WebHome]]
161 * [[Feeling Groovy>>http://www-128.ibm.com/developerworks/java/library/j-alj08034.html]]
162 * [[MVC programming with Groovy templates>>http://www-128.ibm.com/developerworks/java/library/j-pg02155/]]
163
164 == Groovy Example ==
165
166 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##.
167
168 Using XWiki Syntax 2.0:
169 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.
170
171 {{code}}{{velocity}}
172 #set($hostname = "www.xwiki.org")
173 Host Name: $hostname
174 $xcontext.put("hostname", $hostname)
175 {{/velocity}}
176 {{groovy}}
177 import java.net.InetAddress;
178 host = xcontext.get("hostname");
179 InetAddress addr = InetAddress.getByName(host);
180 String address = addr.getHostAddress();
181 xcontext.put("address", address);
182 {{/groovy}}
183 {{velocity}}
184 IP Address: $xcontext.get("address")
185 {{/velocity}}{{/code}}
186
187 Using XWiki Syntax 1.0:
188 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.
189
190 {{code}}#set ($hostname = "www.xwiki.org")
191 Host Name: $hostname
192 <%
193 import java.net.InetAddress;
194 vcontext = context.get("vcontext");
195 host = vcontext.get("hostname");
196 InetAddress addr = InetAddress.getByName(host);
197 String address = addr.getHostAddress();
198 %>
199 IP Address: $address{{/code}}
200
201 = Python Specific Information =
202
203 You can run python code in XWiki just like velocity or groovy.
204
205 {{code language="python"}}{{python}}
206 print "The full name of this document is " + doc.getFullName()
207 {{/python}}{{/code}}
208
209 {{warning}}
210 Versions prior to [[XWiki Enterprise 2.4>>xwiki:ReleaseNotes.ReleaseNotesXWikiEnterprise24]] have a bug which prevents you from having access to the default objects (doc, xcontext, request, etc.) a [[workaround is available in the Extensions wiki>>extensions:Extension.Access To Bindings In Python]]
211 {{/warning}}
212
213 = Scripting In XWiki Syntax 1.0 =
214
215 XWiki Syntax 1.0 is rendered by an old rendering engine which 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.
216
217 * The only scripting languages available to you are Velocity and Groovy.
218 * In Groovy, the context is known as: **##context##** not **##xcontext##**
219 * The beginning and end of Groovy scripts are denoted by <% and %> rather than through the [[extensions:Extension.Groovy Macro]] (using ~{~{groovy}} and ~{~{/groovy}})
220 * Velocity is parsed in a page no matter what (there is no need to invoke the [[extensions:Extension.Velocity Macro]] using ~{~{velocity}} and ~{~{/velocity}})
221
222 The last part is important because it means you need to be careful of using $ and # in your document. This is still true inside of <% and %> so you have to be careful writing Groovy.

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected