ILIAS  Release_4_4_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"));
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 
195  ilUtil::sendSuccess($lng->txt("cron_action_edit_success"), true);
196  $ilCtrl->redirect($this, "render");
197  }
198  }
199 
200  $form->setValuesByPost();
201  $this->edit($form);
202  }
203 
204  function run()
205  {
206  $this->confirm("run");
207  }
208 
209  function confirmedRun()
210  {
211  global $ilCtrl, $lng;
212 
213  $job_id = $_GET["jid"];
214  if($job_id)
215  {
216  if(ilCronManager::runJobManual($job_id))
217  {
218  ilUtil::sendSuccess($lng->txt("cron_action_run_success"), true);
219  }
220  else
221  {
222  ilUtil::sendFailure($lng->txt("cron_action_run_fail"), true);
223  }
224  }
225 
226  $ilCtrl->redirect($this, "render");
227  }
228 
229  function activate()
230  {
231  $this->confirm("activate");
232  }
233 
234  function confirmedActivate()
235  {
236  global $ilCtrl, $lng;
237 
238  $jobs = $this->getMultiActionData();
239  if($jobs)
240  {
241  foreach($jobs as $job)
242  {
243  if(ilCronManager::isJobInactive($job->getId()))
244  {
245  ilCronManager::resetJob($job);
246  ilCronManager::activateJob($job, true);
247  }
248  }
249 
250  ilUtil::sendSuccess($lng->txt("cron_action_activate_success"), true);
251  }
252 
253  $ilCtrl->redirect($this, "render");
254  }
255 
256  function deactivate()
257  {
258  $this->confirm("deactivate");
259  }
260 
261  function confirmedDeactivate()
262  {
263  global $ilCtrl, $lng;
264 
265  $jobs = $this->getMultiActionData();
266  if($jobs)
267  {
268  foreach($jobs as $job)
269  {
270  if(ilCronManager::isJobActive($job->getId()))
271  {
272  ilCronManager::deactivateJob($job, true);
273  }
274  }
275 
276  ilUtil::sendSuccess($lng->txt("cron_action_deactivate_success"), true);
277  }
278 
279  $ilCtrl->redirect($this, "render");
280  }
281 
282  function reset()
283  {
284  $this->confirm("reset");
285  }
286 
287  function confirmedReset()
288  {
289  global $ilCtrl, $lng;
290 
291  $job_id = $_GET["jid"];
292  if($job_id)
293  {
294  $job = ilCronManager::getJobInstanceById($job_id);
295  if($job)
296  {
297  ilCronManager::resetJob($job);
298 
299  ilUtil::sendSuccess($lng->txt("cron_action_reset_success"), true);
300  }
301  }
302 
303  $ilCtrl->redirect($this, "render");
304  }
305 
306  protected function getMultiActionData()
307  {
308  $res = array();
309 
310  if($_REQUEST["jid"])
311  {
312  $job_id = trim($_REQUEST["jid"]);
313  $job = ilCronManager::getJobInstanceById($job_id);
314  if($job)
315  {
316  $res[$job_id] = $job;
317  }
318  }
319  else if(is_array($_REQUEST["mjid"]))
320  {
321  foreach($_REQUEST["mjid"] as $job_id)
322  {
323  $job = ilCronManager::getJobInstanceById($job_id);
324  if($job)
325  {
326  $res[$job_id] = $job;
327  }
328  }
329  }
330 
331  return $res;
332  }
333 
334  protected function confirm($a_action)
335  {
336  global $ilCtrl, $tpl, $lng;
337 
338  $jobs = $this->getMultiActionData();
339  if(!$jobs)
340  {
341  $ilCtrl->redirect($this, "render");
342  }
343 
344  if('run' == $a_action)
345  {
346  // Filter jobs which are not indented to be executed manually
347  $jobs = array_filter($jobs, function ($job) {
351  return $job->isManuallyExecutable();
352  });
353 
354  if(0 == count($jobs))
355  {
356  ilUtil::sendFailure($lng->txt('cron_no_executable_job_selected'), true);
357  $ilCtrl->redirect($this, 'render');
358  }
359  }
360 
361  include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
362  $cgui = new ilConfirmationGUI();
363 
364  if(sizeof($jobs) == 1)
365  {
366  $job_id = array_pop(array_keys($jobs));
367  $job = array_pop($jobs);
368  $title = $job->getTitle();
369  if(!$title)
370  {
371  $title = preg_replace("[^A-Za-z0-9_\-]", "", $job->getId());
372  }
373 
374  $cgui->setHeaderText(sprintf($lng->txt("cron_action_".$a_action."_sure"),
375  $title));
376 
377  $ilCtrl->setParameter($this, "jid", $job_id);
378  }
379  else
380  {
381  $cgui->setHeaderText($lng->txt("cron_action_".$a_action."_sure_multi"));
382 
383  foreach($jobs as $job_id => $job)
384  {
385  $cgui->addItem("mjid[]", $job_id, $job->getTitle());
386  }
387  }
388 
389  $cgui->setFormAction($ilCtrl->getFormAction($this, "confirmed".ucfirst($a_action)));
390  $cgui->setCancel($lng->txt("cancel"), "render");
391  $cgui->setConfirm($lng->txt("cron_action_".$a_action), "confirmed".ucfirst($a_action));
392 
393  $tpl->setContent($cgui->getHTML());
394  }
395 
396  public function addToExternalSettingsForm($a_form_id)
397  {
398  $fields = array();
399 
400  $data = ilCronManager::getCronJobData();
401  foreach($data as $item)
402  {
403  $job = ilCronManager::getJobInstance($item["job_id"],
404  $item["component"], $item["class"], $item["path"]);
405 
406  if(method_exists($job, "addToExternalSettingsForm"))
407  {
408  $job->addToExternalSettingsForm($a_form_id, $fields, $item["job_status"]);
409  }
410  }
411 
412  if(sizeof($fields))
413  {
414  return array("cron_jobs"=>array("jumpToCronJobs", $fields));
415  }
416  }
417 }
418 
419 ?>