ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
class.ilCronManagerTableGUI.php
Go to the documentation of this file.
1<?php
2/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */
3
4include_once './Services/Table/classes/class.ilTable2GUI.php';
5
12class ilCronManagerTableGUI extends ilTable2GUI
13{
20 public function __construct($a_parent_obj, $a_parent_cmd)
21 {
22 global $ilCtrl, $lng;
23
24 $this->setId("crnmng"); // #14526 / #16391
25
26 parent::__construct($a_parent_obj, $a_parent_cmd);
27
28 $this->addColumn("", "", 1);
29 $this->addColumn($this->lng->txt("cron_job_id"), "title");
30 $this->addColumn($this->lng->txt("cron_component"), "component");
31 $this->addColumn($this->lng->txt("cron_schedule"), "schedule");
32 $this->addColumn($this->lng->txt("cron_status"), "status");
33 $this->addColumn($this->lng->txt("cron_status_info"), "");
34 $this->addColumn($this->lng->txt("cron_result"), "result");
35 $this->addColumn($this->lng->txt("cron_result_info"), "");
36 $this->addColumn($this->lng->txt("cron_last_run"), "last_run");
37 $this->addColumn($this->lng->txt("actions"), "");
38
39 $this->setTitle($this->lng->txt("cron_jobs"));
40 $this->setDefaultOrderField("title");
41
42 $this->setSelectAllCheckbox("mjid");
43 $this->addMultiCommand("activate", $lng->txt("cron_action_activate"));
44 $this->addMultiCommand("deactivate", $lng->txt("cron_action_deactivate"));
45
46 $this->setRowTemplate("tpl.cron_job_row.html", "Services/Cron");
47 $this->setFormAction($ilCtrl->getFormAction($a_parent_obj, $a_parent_cmd));
48
49 $this->getItems();
50 }
51
52 protected function parseJobToData(array $a_item, ilCronJob $job)
53 {
54 global $lng;
55
56 $res = $a_item;
57
58 $res["title"] = $job->getTitle();
59 $res["description"] = $job->getDescription();
60 $res["has_settings"] = $job->hasCustomSettings();
61
62 if(!$res["title"])
63 {
64 $res["title"] = $a_item["job_id"];
65 }
66
67 // schedule
68 if(!$job->hasFlexibleSchedule())
69 {
70 // schedule type changed
71 if($a_item["schedule_type"])
72 {
73 ilCronManager::updateJobSchedule($job, null, null);
74 }
75
76 $a_item["schedule_type"] = $job->getDefaultScheduleType();
77 $a_item["schedule_value"] = $job->getDefaultScheduleValue();
78 $res["editable_schedule"] = false;
79 }
80 else
81 {
82 // schedule type changed
83 if(!$a_item["schedule_type"])
84 {
85 $a_item["schedule_type"] = $job->getDefaultScheduleType();
86 $a_item["schedule_value"] = $job->getDefaultScheduleValue();
87 ilCronManager::updateJobSchedule($job, $a_item["schedule_type"],
88 $a_item["schedule_value"]);
89 }
90
91 $res["editable_schedule"] = true;
92 }
93
94 switch($a_item["schedule_type"])
95 {
96 case ilCronJob::SCHEDULE_TYPE_DAILY:
97 $schedule = $lng->txt("cron_schedule_daily");
98 break;
99
100 case ilCronJob::SCHEDULE_TYPE_WEEKLY:
101 $schedule = $lng->txt("cron_schedule_weekly");
102 break;
103
104 case ilCronJob::SCHEDULE_TYPE_MONTHLY:
105 $schedule = $lng->txt("cron_schedule_monthly");
106 break;
107
108 case ilCronJob::SCHEDULE_TYPE_QUARTERLY:
109 $schedule = $lng->txt("cron_schedule_quarterly");
110 break;
111
112 case ilCronJob::SCHEDULE_TYPE_YEARLY:
113 $schedule = $lng->txt("cron_schedule_yearly");
114 break;
115
116 case ilCronJob::SCHEDULE_TYPE_IN_MINUTES:
117 $schedule = sprintf($lng->txt("cron_schedule_in_minutes"), $a_item["schedule_value"]);
118 break;
119
120 case ilCronJob::SCHEDULE_TYPE_IN_HOURS:
121 $schedule = sprintf($lng->txt("cron_schedule_in_hours"), $a_item["schedule_value"]);
122 break;
123
124 case ilCronJob::SCHEDULE_TYPE_IN_DAYS:
125 $schedule = sprintf($lng->txt("cron_schedule_in_days"), $a_item["schedule_value"]);
126 break;
127 }
128 $res["schedule"] = $schedule;
129
130 // status
131 if($a_item["job_status"])
132 {
133 $res["status"] = $lng->txt("cron_status_active");
134 }
135 else
136 {
137 $res["status"] = $lng->txt("cron_status_inactive");
138 }
139
140 $status_info = array();
141 if($a_item["job_status_ts"])
142 {
143 $status_info[] = ilDatePresentation::formatDate(new ilDateTime($a_item["job_status_ts"], IL_CAL_UNIX));
144 }
145 if(!$a_item["job_status_type"])
146 {
147 $status_info[] = $lng->txt("cron_changed_by_crontab");
148 }
149 else
150 {
151 $status_info[] = ilUserUtil::getNamePresentation($a_item["job_status_user_id"]);
152 }
153 $res["status_info"] = implode("<br />", $status_info);
154
155 // result
156 $result = "-";
157 if($a_item["job_result_status"])
158 {
159 switch($a_item["job_result_status"])
160 {
161 case ilCronJobResult::STATUS_INVALID_CONFIGURATION:
162 $result = $lng->txt("cron_result_status_invalid_configuration");
163 break;
164
165 case ilCronJobResult::STATUS_NO_ACTION:
166 $result = $lng->txt("cron_result_status_no_action");
167 break;
168
169 case ilCronJobResult::STATUS_OK:
170 $result = $lng->txt("cron_result_status_ok");
171 break;
172
173 case ilCronJobResult::STATUS_CRASHED:
174 $result = $lng->txt("cron_result_status_crashed");
175 break;
176
177 case ilCronJobResult::STATUS_RESET:
178 $result = $lng->txt("cron_result_status_reset");
179 break;
180
181 case ilCronJobResult::STATUS_FAIL:
182 $result = $lng->txt("cron_result_status_fail");
183 break;
184 }
185 }
186 $res["result"] = $result;
187
188 $result_info = array();
189 if($a_item["job_result_dur"])
190 {
191 $result_info[] = ($a_item["job_result_dur"]/1000)." sec";
192 }
193 if($a_item["job_result_message"])
194 {
195 $result_info[] = $a_item["job_result_message"];
196 }
197 if(DEVMODE && $a_item["job_result_code"]) // #11866
198 {
199 $result_info[] = $a_item["job_result_code"];
200 }
201 if(!$a_item["job_result_type"])
202 {
203 $result_info[] = $lng->txt("cron_changed_by_crontab");
204 }
205 else
206 {
207 $result_info[] = ilUserUtil::getNamePresentation($a_item["job_result_user_id"]);
208 }
209 $res["result_info"] = implode("<br />", $result_info);
210
211 if($a_item["running_ts"])
212 {
213 $res["last_run"] = strtotime("+1year", $a_item["running_ts"]);
214 }
215 else if($a_item["job_result_ts"])
216 {
217 $res["last_run"] = $a_item["job_result_ts"];
218 }
219 else
220 {
221 $res["last_run"] = null;
222 }
223
224 $res['is_manually_executable'] = $job->isManuallyExecutable();
225
226 return $res;
227 }
228
229 protected function getItems()
230 {
231 global $ilPluginAdmin, $lng;
232
233 include_once "Services/User/classes/class.ilUserUtil.php";
234 include_once "Services/Cron/classes/class.ilCronJobResult.php";
235
236 // systems
237 $data = ilCronManager::getCronJobData();
238 foreach($data as $idx => $item)
239 {
240 $job = ilCronManager::getJobInstance($item["job_id"],
241 $item["component"], $item["class"], $item["path"]);
242 if($job)
243 {
244 $data[$idx] = $this->parseJobToData($item, $job);
245 }
246 }
247
248 // plugins
249 $lng->loadLanguageModule("cmps");
250 foreach(ilCronManager::getPluginJobs() as $item)
251 {
252 $job = $item[0];
253 $item = $item[1];
254
255 $item["job_id"] = "pl__".$item["component"]."__".$job->getId();
256 $item["component"] = $lng->txt("cmps_plugin")."/".$item["component"];
257
258 $data[] = $this->parseJobToData($item, $job);
259 }
260
261 $this->setData($data);
262 }
263
264 protected function fillRow($a_set)
265 {
266 global $ilCtrl, $lng;
267
268 $this->tpl->setVariable("VAL_ID", $a_set["title"]);
269 $this->tpl->setVariable("VAL_JID", $a_set["job_id"]);
270
271 if($a_set["description"])
272 {
273 $this->tpl->setVariable("VAL_DESC", $a_set["description"]);
274 }
275
276 $this->tpl->setVariable("VAL_COMPONENT", $a_set["component"]);
277 $this->tpl->setVariable("VAL_SCHEDULE", $a_set["schedule"]);
278 $this->tpl->setVariable("VAL_STATUS", $a_set["status"]);
279 $this->tpl->setVariable("VAL_STATUS_INFO", $a_set["status_info"]);
280 $this->tpl->setVariable("VAL_RESULT", $a_set["result"]);
281 $this->tpl->setVariable("VAL_RESULT_INFO", $a_set["result_info"]);
282 if($a_set["last_run"] > time())
283 {
284 $a_set["last_run"] = $lng->txt("cron_running_since")." ".
285 ilDatePresentation::formatDate(new ilDateTime($a_set["running_ts"], IL_CAL_UNIX));
286
287 // job has pinged
288 if($a_set["alive_ts"] != $a_set["running_ts"])
289 {
290 $a_set["last_run"] .= "<br />(Ping: ".
291 ilDatePresentation::formatDate(new ilDateTime($a_set["alive_ts"], IL_CAL_UNIX)).")";
292 }
293 }
294 else if($a_set["last_run"])
295 {
296 $a_set["last_run"] = ilDatePresentation::formatDate(new ilDateTime($a_set["last_run"], IL_CAL_UNIX));
297 }
298 $this->tpl->setVariable("VAL_LAST_RUN", $a_set["last_run"] ? $a_set["last_run"] : "-");
299
300
301 // actions
302
303 $actions = array();
304
305 if(!$a_set["running_ts"])
306 {
307 // reset
308 if($a_set["job_result_status"] == ilCronJobResult::STATUS_CRASHED)
309 {
310 $actions[] = "reset";
311 }
312 // activate
313 else if(!$a_set["job_status"])
314 {
315 $actions[] = "activate";
316 }
317 // deactivate
318 else
319 {
320 if($a_set['is_manually_executable'])
321 {
322 $actions[] = 'run';
323 }
324 $actions[] = "deactivate";
325 }
326 // edit (schedule)
327 if($a_set["editable_schedule"] || $a_set["has_settings"])
328 {
329 $actions[] = "edit";
330 }
331
332 $ilCtrl->setParameter($this->getParentObject(), "jid", $a_set["job_id"]);
333
334 foreach($actions as $action)
335 {
336 $this->tpl->setCurrentBlock("action_bl");
337 $this->tpl->setVariable("URL_ACTION",
338 $ilCtrl->getLinkTarget($this->getParentObject(), $action));
339 $this->tpl->setVariable("TXT_ACTION", $lng->txt("cron_action_".$action));
340 $this->tpl->parseCurrentBlock();
341 }
342
343 $ilCtrl->setParameter($this->getParentObject(), "jid", "");
344 }
345 }
346}
347
348?>
$result
$result
Definition: CleanUpTest.php:407
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:11
ilCronJob
Cron job application base class.
Definition: class.ilCronJob.php:12
ilCronJob\SCHEDULE_TYPE_IN_DAYS
const SCHEDULE_TYPE_IN_DAYS
Definition: class.ilCronJob.php:16
ilCronJob\getDefaultScheduleType
getDefaultScheduleType()
Get schedule type.
ilCronJob\getDescription
getDescription()
Get description.
Definition: class.ilCronJob.php:188
ilCronJob\SCHEDULE_TYPE_IN_HOURS
const SCHEDULE_TYPE_IN_HOURS
Definition: class.ilCronJob.php:15
ilCronJob\getDefaultScheduleValue
getDefaultScheduleValue()
Get schedule value.
ilCronJob\hasCustomSettings
hasCustomSettings()
Has cron job any custom setting which can be edited?
Definition: class.ilCronJob.php:211
ilCronJob\SCHEDULE_TYPE_IN_MINUTES
const SCHEDULE_TYPE_IN_MINUTES
Definition: class.ilCronJob.php:14
ilCronJob\isManuallyExecutable
isManuallyExecutable()
Defines whether or not a cron job can be started manually.
Definition: class.ilCronJob.php:197
ilCronJob\SCHEDULE_TYPE_WEEKLY
const SCHEDULE_TYPE_WEEKLY
Definition: class.ilCronJob.php:17
ilCronJob\SCHEDULE_TYPE_YEARLY
const SCHEDULE_TYPE_YEARLY
Definition: class.ilCronJob.php:20
ilCronJob\SCHEDULE_TYPE_DAILY
const SCHEDULE_TYPE_DAILY
Definition: class.ilCronJob.php:13
ilCronJob\hasFlexibleSchedule
hasFlexibleSchedule()
Can the schedule be configured?
ilCronJob\SCHEDULE_TYPE_QUARTERLY
const SCHEDULE_TYPE_QUARTERLY
Definition: class.ilCronJob.php:19
ilCronJob\SCHEDULE_TYPE_MONTHLY
const SCHEDULE_TYPE_MONTHLY
Definition: class.ilCronJob.php:18
ilCronJob\getTitle
getTitle()
Get title.
Definition: class.ilCronJob.php:178
ilCronManagerTableGUI
List all active cron jobs.
Definition: class.ilCronManagerTableGUI.php:13
ilCronManagerTableGUI\__construct
__construct($a_parent_obj, $a_parent_cmd)
Constructor.
Definition: class.ilCronManagerTableGUI.php:20
ilCronManagerTableGUI\parseJobToData
parseJobToData(array $a_item, ilCronJob $job)
Definition: class.ilCronManagerTableGUI.php:52
ilCronManagerTableGUI\fillRow
fillRow($a_set)
Standard Version of Fill Row.
Definition: class.ilCronManagerTableGUI.php:264
ilCronManager\getCronJobData
static getCronJobData($a_id=null, $a_include_inactive=true)
Get cron job configuration/execution data.
Definition: class.ilCronManager.php:506
ilCronManager\getJobInstance
static getJobInstance($a_id, $a_component, $a_class, $a_path=null)
Get job instance (by job data)
Definition: class.ilCronManager.php:270
ilCronManager\updateJobSchedule
static updateJobSchedule(ilCronJob $a_job, $a_schedule_type, $a_schedule_value)
Update job schedule.
Definition: class.ilCronManager.php:684
ilCronManager\getPluginJobs
static getPluginJobs($a_only_active=false)
Definition: class.ilCronManager.php:466
ilDatePresentation\formatDate
static formatDate(ilDateTime $date)
Format a date @access public.
Definition: class.ilDatePresentation.php:113
ilDateTime
@classDescription Date and time handling
Definition: class.ilDateTime.php:33
ilTable2GUI
Class ilTable2GUI.
Definition: class.ilTable2GUI.php:16
ilTable2GUI\addColumn
addColumn($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
Add a column to the header.
Definition: class.ilTable2GUI.php:1308
ilTable2GUI\getParentObject
getParentObject()
Get parent object.
Definition: class.ilTable2GUI.php:370
ilTable2GUI\setTitle
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
Definition: class.ilTable2GUI.php:508
ilTable2GUI\setData
setData($a_data)
set table data @access public
Definition: class.ilTable2GUI.php:548
ilTable2GUI\setRowTemplate
setRowTemplate($a_template, $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:1125
ilTable2GUI\addMultiCommand
addMultiCommand($a_cmd, $a_text)
Add Command button.
Definition: class.ilTable2GUI.php:1253
ilTable2GUI\setDefaultOrderField
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
Definition: class.ilTable2GUI.php:1136
ilTable2GUI\setSelectAllCheckbox
setSelectAllCheckbox($a_select_all_checkbox)
Set the name of the checkbox that should be toggled with a select all button.
Definition: class.ilTable2GUI.php:1030
ilTable2GUI\setId
setId($a_val)
Set id.
Definition: class.ilTable2GUI.php:976
ilTable2GUI\setFormAction
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
Definition: class.ilTable2GUI.php:935
ilUserUtil\getNamePresentation
static getNamePresentation($a_user_id, $a_user_image=false, $a_profile_link=false, $a_profile_back_link="", $a_force_first_lastname=false, $a_omit_login=false, $a_sortable=true, $a_return_data_array=false)
Default behaviour is:
Definition: class.ilUserUtil.php:42
$ilCtrl
global $ilCtrl
Definition: ilias.php:18
$lng
global $lng
Definition: privfeed.php:40