Skip to Content

Wiki source code of Job Scheduler

Last modified by Bruno Mattos on 2025/10/20 21:08
Show last authors
1 {{velocity}}
2 ## First, set a shortcut to our Scheduler plugin
3 ##
4 #set ($scheduler = $xwiki.scheduler)
5 #set ($schedulerEnabled = $scheduler.enabled)
6 ##
7 ## If the sheet is called with an action ($request.do), let us first process this action
8 ## Possible values are : "schedule", "pause", "resume", "unschedule", "delete"
9 ##
10 #if ($schedulerEnabled && "$!request.do" != '' && "$!request.which" != '')
11 ##
12 ## Obtain the Job document and object for which the action has been called
13 ##
14 #set ($tJobHolder = $request.which)
15 #set ($jobDoc = $xwiki.getDocument($tJobHolder))
16 #set ($jobObj = $jobDoc.getObject('XWiki.SchedulerJobClass'))
17 #if (!$services.csrf.isTokenValid($request.form_token))
18 ##
19 ## Check that the CSRF token matches the user before any operation
20 ##
21 {{error}}$services.localization.render('xe.scheduler.invalidToken'){{/error}}
22
23 #elseif ($request.do == 'schedule')
24 ##
25 ## Schedule a job
26 ##
27 #set ($ok = $scheduler.scheduleJob($jobObj))
28 #if (!$ok)
29 {{error}}$xcontext.get('error'){{/error}}
30
31 #else
32 #set ($jobName = "$jobObj.get('jobName')")
33 {{info}}$services.localization.render('xe.scheduler.jobscheduled', [$jobName, $scheduler.getNextFireTime($jobObj)]){{/info}}
34
35 #end
36 #elseif ($request.do == 'pause')
37 ##
38 ## Pause a scheduled job
39 ##
40 #set ($ok = $scheduler.pauseJob($jobObj))
41 #if (!$ok)
42 {{error}}$xcontext.get('error'){{/error}}
43
44 #else
45 {{info}}$services.localization.render('xe.scheduler.paused', [$jobObj.get('jobName')]){{/info}}
46
47 #end
48 #elseif ($request.do == 'resume')
49 ##
50 ## Resume a paused job
51 ##
52 #set ($ok = $scheduler.resumeJob($jobObj))
53 #if (!$ok)
54 {{error}}$xcontext.get('error'){{/error}}
55
56 #else
57 {{info}}$services.localization.render('xe.scheduler.resumed', [$jobObj.get('jobName'), $scheduler.getNextFireTime($jobObj)]){{/info}}
58
59 #end
60 #elseif ($request.do == 'unschedule')
61 ##
62 ## Unschedule a scheduled job (paused or not)
63 ##
64 #set ($ok = $scheduler.unscheduleJob($jobObj))
65 #if (!$ok)
66 {{error}}$xcontext.get('error'){{/error}}
67
68 #else
69 {{info}}$services.localization.render('xe.scheduler.unscheduled', [$jobObj.get('jobName')]){{/info}}
70
71 #end
72 #elseif ($request.do == 'delete')
73 ##
74 ## Delete a job
75 ## First unschedule it (if needed), then delete its document holder
76 ##
77 #set ($jobName = $jobObj.get('jobName'))
78 #if ($jobObj.get('status') == 'Normal' || $jobObj.get('status') == 'Paused')
79 #set ($ok = $scheduler.unscheduleJob($jobObj))
80 #if ($ok)
81 #set ($deleteRedirect = $xwiki.getURL($jobObj.getName(), 'delete'))
82 $response.sendRedirect($deleteRedirect)
83 #else
84 {{error}}$xcontext.get('error'){{/error}}
85
86 #end
87 #else
88 #set ($deleteRedirect = $xwiki.getURL($jobObj.getName(), 'delete'))
89 $response.sendRedirect($deleteRedirect))
90 #end
91 #elseif ($request.do == 'trigger')
92 ##
93 ## Trigger a job (execute it now)
94 ##
95 #set ($ok = $scheduler.triggerJob($jobObj))
96 #if (!$ok)
97 {{error}}$xcontext.get('error'){{/error}}
98
99 #else
100 {{info}}$services.localization.render('xe.scheduler.triggered', [$jobObj.get('jobName')]){{/info}}
101
102 #end
103 #end
104 #end
105 $services.localization.render('xe.scheduler.welcome')
106
107 #if (!$schedulerEnabled)
108 {{warning}}
109 {{translation key="scheduler.disabled"/}}
110 {{/warning}}
111
112 #end
113 = $services.localization.render('xe.scheduler.jobs.list') =
114
115 ##
116 ## Retrieve all scheduler jobs
117 ## Display their name, status, possible next fire time, and available actions
118 ##
119 |=(%scope="col"%)$services.localization.render('xe.scheduler.jobs.name')#if ($schedulerEnabled)|=(%scope="col"%)$services.localization.render('xe.scheduler.jobs.status')|=(%scope="col"%)$services.localization.render('xe.scheduler.jobs.next')#end|=(%scope="col"%)$services.localization.render('xe.scheduler.jobs.actions')
120 #foreach ($docName in $services.query.xwql('from doc.object(XWiki.SchedulerJobClass) as jobs where doc.fullName <> ''XWiki.SchedulerJobTemplate''').execute())
121 #set ($jobHolder = $xwiki.getDocument($docName))
122 #set ($job = $jobHolder.getObject('XWiki.SchedulerJobClass'))
123 #if ($schedulerEnabled)
124 #set ($status = $scheduler.getJobStatus($job).value)
125 #if ($status == '')
126 #set ($status = 'None')
127 #end
128 #set ($firetime = '')
129 #if ($status != 'None')
130 #set ($firetime = $scheduler.getNextFireTime($job))
131 #else
132 #set ($firetime = $services.localization.render('xe.scheduler.jobs.next.undefined'))
133 #end
134 #set ($actions = ['trigger'])
135 #if ($status == 'None')
136 #set ($ok = $actions.add('schedule'))
137 #elseif($status == 'Normal')
138 #set ($ok = $actions.addAll(['pause', 'unschedule']))
139 #elseif ($status == 'Paused')
140 #set ($ok = $actions.addAll(['resume', 'unschedule']))
141 #end
142 #set ($ok = $actions.add('delete'))
143 #end
144 |$job.get('jobName')#if($schedulerEnabled)|$status|$firetime#end|**$services.localization.render('xe.scheduler.jobs.actions.access')** [[$services.localization.render('xe.scheduler.jobs.actions.view')>>$services.rendering.escape($jobHolder.fullName, 'xwiki/2.1')]]#if($jobHolder.hasAccessLevel('programming'))#if ($schedulerEnabled) [[$services.localization.render('xe.scheduler.jobs.actions.edit')>>path:${jobHolder.getURL('edit')}]]#end#end#if ($schedulerEnabled) **$services.localization.render('xe.scheduler.jobs.actions.manage')**#foreach($action in $actions) [[$services.localization.render("xe.scheduler.jobs.actions.$action")>>path:$doc.getURL('view', $escapetool.url({'do': $action, 'which': $jobHolder.fullName, 'form_token': $services.csrf.token}))]]#end#end
145
146 #end
147 #if ($schedulerEnabled)
148 #if ($doc.hasAccessLevel('programming'))
149 ##
150 ## Job creation is offered only for programmers, because the job page needs to be saved
151 ## with programming right for groovy jobs to be executed.
152 ## However, this page should stay accessible to admins, that can manipulate existing jobs:
153 ## schedule, pause, etc.
154 ##
155
156 = $services.localization.render('xe.scheduler.jobs.create') =
157
158 ##
159 ## Form to create a new Job
160 ##
161 {{info}}$services.localization.render('xe.scheduler.jobs.explaincreate'){{/info}}
162
163 {{html}}
164 <form action="$doc.getURL('create')" id="newdoc" class="form-inline"><div>
165 <input type="hidden" name="form_token" value="$!{services.csrf.getToken()}" />
166 <input type="hidden" name="parent" value="Scheduler.WebHome" />
167 <input type="hidden" name="template" value="XWiki.SchedulerJobTemplate" />
168 <input type="hidden" name="sheet" value="1" />
169 <input type="hidden" name="space" value="Scheduler"/>
170 <label class="sr-only" for="page">$services.localization.render('xe.scheduler.jobs.create.nameTip')</label>
171 <input id="page" name="page" size="30" type="text"
172 placeholder="$escapetool.xml($services.localization.render('xe.scheduler.jobs.create.nameTip'))" />
173 <span class="buttonwrapper">
174 <input type="submit" class="btn btn-success"
175 value="$escapetool.xml($services.localization.render('xe.scheduler.jobs.create.submit'))"/>
176 </span>
177 </div></form>
178 {{/html}}
179
180 #else
181
182 {{warning}}$services.localization.render('xe.scheduler.jobs.warning'){{/warning}}
183
184 #end
185 #end
186 {{/velocity}}