ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
class.ilCronManagerGUI.php
Go to the documentation of this file.
1 <?php
2 
3 /* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */
4 
5 include_once "Services/Cron/classes/class.ilCronManager.php";
6 
16 class ilCronManagerGUI
17 {
18  function executeCommand()
19  {
20  global $ilCtrl, $lng;
21 
22  $lng->loadLanguageModule("cron");
23 
24  $cmd = $ilCtrl->getCmd("render");
25  $this->$cmd();
26 
27  return true;
28  }
29 
30  function render()
31  {
32  global $tpl, $ilSetting, $lng;
33 
34  if($ilSetting->get('last_cronjob_start_ts'))
35  {
36  $tstamp = ilDatePresentation::formatDate(new ilDateTime($ilSetting->get('last_cronjob_start_ts'), IL_CAL_UNIX));
37  }
38  else
39  {
40  $tstamp = $lng->txt('cronjob_last_start_unknown');
41  }
42  ilUtil::sendInfo($lng->txt('cronjob_last_start').": ".$tstamp);
43 
44  include_once "Services/Cron/classes/class.ilCronManagerTableGUI.php";
45  $tbl = new ilCronManagerTableGUI($this, "render");
46  $tpl->setContent($tbl->getHTML());
47  }
48 
49  function edit(ilPropertyFormGUI $a_form = null)
50  {
51  global $ilCtrl, $tpl;
52 
53  $id = $_REQUEST["jid"];
54  if(!$id)
55  {
56  $ilCtrl->redirect($this, "render");
57  }
58 
59  if(!$a_form)
60  {
61  $a_form = $this->initEditForm($id);
62  }
63 
64  $tpl->setContent($a_form->getHTML());
65  }
66 
67  function initEditForm($a_job_id)
68  {
69  global $ilCtrl, $lng;
70 
71  $job = ilCronManager::getJobInstanceById($a_job_id);
72  if(!$job)
73  {
74  $ilCtrl->redirect($this, "render");
75  }
76 
77  $ilCtrl->setParameter($this, "jid", $a_job_id);
78 
79  $data = array_pop(ilCronManager::getCronJobData($job->getId()));
80 
81  include_once("Services/Cron/classes/class.ilCronJob.php");
82  include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
83  $form = new ilPropertyFormGUI();
84  $form->setFormAction($ilCtrl->getFormAction($this, "update"));
85  $form->setTitle($lng->txt("cron_action_edit").': "'.$job->getTitle().'"');
86 
87  if($job->hasFlexibleSchedule())
88  {
89  $type = new ilRadioGroupInputGUI($lng->txt("cron_schedule_type"), "type");
90  $type->setRequired(true);
91  $type->setValue($data["schedule_type"]);
92  $type->addOption(new ilRadioOption($lng->txt("cron_schedule_daily"), ilCronJob::SCHEDULE_TYPE_DAILY));
93  $type->addOption(new ilRadioOption($lng->txt("cron_schedule_weekly"), ilCronJob::SCHEDULE_TYPE_WEEKLY));
94  $type->addOption(new ilRadioOption($lng->txt("cron_schedule_monthly"), ilCronJob::SCHEDULE_TYPE_MONTHLY));
95  $type->addOption(new ilRadioOption($lng->txt("cron_schedule_quarterly"), ilCronJob::SCHEDULE_TYPE_QUARTERLY));
96  $type->addOption(new ilRadioOption($lng->txt("cron_schedule_yearly"), ilCronJob::SCHEDULE_TYPE_YEARLY));
97 
98  $min = new ilRadioOption(sprintf($lng->txt("cron_schedule_in_minutes"), "x"),
99  ilCronJob::SCHEDULE_TYPE_IN_MINUTES);
100  $mini = new ilNumberInputGUI($lng->txt("cron_schedule_value"), "smini");
101  $mini->setRequired(true);
102  $mini->setSize(5);
103  if($data["schedule_type"] == ilCronJob::SCHEDULE_TYPE_IN_MINUTES)
104  {
105  $mini->setValue($data["schedule_value"]);
106  }
107  $min->addSubItem($mini);
108  $type->addOption($min);
109 
110  $hr = new ilRadioOption(sprintf($lng->txt("cron_schedule_in_hours"), "x"),
111  ilCronJob::SCHEDULE_TYPE_IN_HOURS);
112  $hri = new ilNumberInputGUI($lng->txt("cron_schedule_value"), "shri");
113  $hri->setRequired(true);
114  $hri->setSize(5);
115  if($data["schedule_type"] == ilCronJob::SCHEDULE_TYPE_IN_HOURS)
116  {
117  $hri->setValue($data["schedule_value"]);
118  }
119  $hr->addSubItem($hri);
120  $type->addOption($hr);
121 
122  $dy = new ilRadioOption(sprintf($lng->txt("cron_schedule_in_days"), "x"),
123  ilCronJob::SCHEDULE_TYPE_IN_DAYS);
124  $dyi = new ilNumberInputGUI($lng->txt("cron_schedule_value"), "sdyi");
125  $dyi->setRequired(true);
126  $dyi->setSize(5);
127  if($data["schedule_type"] == ilCronJob::SCHEDULE_TYPE_IN_DAYS)
128  {
129  $dyi->setValue($data["schedule_value"]);
130  }
131  $dy->addSubItem($dyi);
132  $type->addOption($dy);
133 
134  $form->addItem($type);
135  }
136 
137  if($job->hasCustomSettings())
138  {
139  $job->addCustomSettingsToForm($form);
140  }
141 
142  $form->addCommandButton("update", $lng->txt("save"));
143  $form->addCommandButton("render", $lng->txt("cancel"));
144 
145  return $form;
146  }
147 
148  function update()
149  {
150  global $ilCtrl, $lng;
151 
152  $id = $_REQUEST["jid"];
153  if(!$id)
154  {
155  $ilCtrl->redirect($this, "render");
156  }
157 
158  $form = $this->initEditForm($id);
159  if($form->checkInput())
160  {
161  $job = ilCronManager::getJobInstanceById($id);
162  if($job)
163  {
164  $valid = true;
165  if($job->hasCustomSettings() &&
166  !$job->saveCustomSettings($form))
167  {
168  $valid = false;
169  }
170 
171  if($valid && $job->hasFlexibleSchedule())
172  {
173  $type = $form->getInput("type");
174  switch($type)
175  {
176  case ilCronJob::SCHEDULE_TYPE_IN_MINUTES:
177  $value = $form->getInput("smini");
178  break;
179 
180  case ilCronJob::SCHEDULE_TYPE_IN_HOURS:
181  $value = $form->getInput("shri");
182  break;
183 
184  case ilCronJob::SCHEDULE_TYPE_IN_DAYS:
185  $value = $form->getInput("sdyi");
186  break;
187 
188  default:
189  $value = null;
190  }
191 
192  ilCronManager::updateJobSchedule($job, $type, $value);
193  }
194  if($valid)
195  {
196  ilUtil::sendSuccess($lng->txt("cron_action_edit_success"), true);
197  $ilCtrl->redirect($this, "render");
198  }
199  }
200  }
201 
202  $form->setValuesByPost();
203  $this->edit($form);
204  }
205 
206  function run()
207  {
208  $this->confirm("run");
209  }
210 
211  function confirmedRun()
212  {
213  global $ilCtrl, $lng;
214 
215  $job_id = $_GET["jid"];
216  if($job_id)
217  {
218  if(ilCronManager::runJobManual($job_id))
219  {
220  ilUtil::sendSuccess($lng->txt("cron_action_run_success"), true);
221  }
222  else
223  {
224  ilUtil::sendFailure($lng->txt("cron_action_run_fail"), true);
225  }
226  }
227 
228  $ilCtrl->redirect($this, "render");
229  }
230 
231  function activate()
232  {
233  $this->confirm("activate");
234  }
235 
236  function confirmedActivate()
237  {
238  global $ilCtrl, $lng;
239 
240  $jobs = $this->getMultiActionData();
241  if($jobs)
242  {
243  foreach($jobs as $job)
244  {
245  if(ilCronManager::isJobInactive($job->getId()))
246  {
247  ilCronManager::resetJob($job);
248  ilCronManager::activateJob($job, true);
249  }
250  }
251 
252  ilUtil::sendSuccess($lng->txt("cron_action_activate_success"), true);
253  }
254 
255  $ilCtrl->redirect($this, "render");
256  }
257 
258  function deactivate()
259  {
260  $this->confirm("deactivate");
261  }
262 
263  function confirmedDeactivate()
264  {
265  global $ilCtrl, $lng;
266 
267  $jobs = $this->getMultiActionData();
268  if($jobs)
269  {
270  foreach($jobs as $job)
271  {
272  if(ilCronManager::isJobActive($job->getId()))
273  {
274  ilCronManager::deactivateJob($job, true);
275  }
276  }
277 
278  ilUtil::sendSuccess($lng->txt("cron_action_deactivate_success"), true);
279  }
280 
281  $ilCtrl->redirect($this, "render");
282  }
283 
284  function reset()
285  {
286  $this->confirm("reset");
287  }
288 
289  function confirmedReset()
290  {
291  global $ilCtrl, $lng;
292 
293  $job_id = $_GET["jid"];
294  if($job_id)
295  {
296  $job = ilCronManager::getJobInstanceById($job_id);
297  if($job)
298  {
299  ilCronManager::resetJob($job);
300 
301  ilUtil::sendSuccess($lng->txt("cron_action_reset_success"), true);
302  }
303  }
304 
305  $ilCtrl->redirect($this, "render");
306  }
307 
308  protected function getMultiActionData()
309  {
310  $res = array();
311 
312  if($_REQUEST["jid"])
313  {
314  $job_id = trim($_REQUEST["jid"]);
315  $job = ilCronManager::getJobInstanceById($job_id);
316  if($job)
317  {
318  $res[$job_id] = $job;
319  }
320  }
321  else if(is_array($_REQUEST["mjid"]))
322  {
323  foreach($_REQUEST["mjid"] as $job_id)
324  {
325  $job = ilCronManager::getJobInstanceById($job_id);
326  if($job)
327  {
328  $res[$job_id] = $job;
329  }
330  }
331  }
332 
333  return $res;
334  }
335 
336  protected function confirm($a_action)
337  {
338  global $ilCtrl, $tpl, $lng;
339 
340  $jobs = $this->getMultiActionData();
341  if(!$jobs)
342  {
343  $ilCtrl->redirect($this, "render");
344  }
345 
346  if('run' == $a_action)
347  {
348  // Filter jobs which are not indented to be executed manually
349  $jobs = array_filter($jobs, function ($job) {
353  return $job->isManuallyExecutable();
354  });
355 
356  if(0 == count($jobs))
357  {
358  ilUtil::sendFailure($lng->txt('cron_no_executable_job_selected'), true);
359  $ilCtrl->redirect($this, 'render');
360  }
361  }
362 
363  include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
364  $cgui = new ilConfirmationGUI();
365 
366  if(sizeof($jobs) == 1)
367  {
368  $job_id = array_pop(array_keys($jobs));
369  $job = array_pop($jobs);
370  $title = $job->getTitle();
371  if(!$title)
372  {
373  $title = preg_replace("[^A-Za-z0-9_\-]", "", $job->getId());
374  }
375 
376  $cgui->setHeaderText(sprintf($lng->txt("cron_action_".$a_action."_sure"),
377  $title));
378 
379  $ilCtrl->setParameter($this, "jid", $job_id);
380  }
381  else
382  {
383  $cgui->setHeaderText($lng->txt("cron_action_".$a_action."_sure_multi"));
384 
385  foreach($jobs as $job_id => $job)
386  {
387  $cgui->addItem("mjid[]", $job_id, $job->getTitle());
388  }
389  }
390 
391  $cgui->setFormAction($ilCtrl->getFormAction($this, "confirmed".ucfirst($a_action)));
392  $cgui->setCancel($lng->txt("cancel"), "render");
393  $cgui->setConfirm($lng->txt("cron_action_".$a_action), "confirmed".ucfirst($a_action));
394 
395  $tpl->setContent($cgui->getHTML());
396  }
397 
398  public function addToExternalSettingsForm($a_form_id)
399  {
400  $fields = array();
401 
402  $data = ilCronManager::getCronJobData();
403  foreach($data as $item)
404  {
405  $job = ilCronManager::getJobInstance($item["job_id"],
406  $item["component"], $item["class"], $item["path"]);
407 
408  if(method_exists($job, "addToExternalSettingsForm"))
409  {
410  $job->addToExternalSettingsForm($a_form_id, $fields, $item["job_status"]);
411  }
412  }
413 
414  if(sizeof($fields))
415  {
416  return array("cron_jobs"=>array("jumpToCronJobs", $fields));
417  }
418  }
419 }
420 
421 ?>