ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
Static Public Member Functions | Static Protected Member Functions
ilCronManager Class Reference

Cron management. More...

+ Collaboration diagram for ilCronManager:

Static Public Member Functions

static runActiveJobs ()
 Run all active jobs. More...
 
static runJobManual ($a_job_id)
 Run single job manually. More...
 
static getJobInstanceById ($a_job_id)
 Get job instance (by job id) More...
 
static getJobInstance ($a_id, $a_component, $a_class, $a_path=null)
 Get job instance (by job data) More...
 
static createDefaultEntry (ilCronJob $a_job, $a_component, $a_class, $a_path)
 
static updateFromXML ($a_component, $a_id, $a_class, $a_path=null)
 Process data from module.xml/service.xml. More...
 
static clearFromXML ($a_component, array $a_xml_job_ids)
 Clear job data. More...
 
static getPluginJobs ($a_only_active=false)
 
static getCronJobData ($a_id=null, $a_include_inactive=true)
 Get cron job configuration/execution data. More...
 
static resetJob (ilCronJob $a_job)
 Reset job. More...
 
static activateJob (ilCronJob $a_job, $a_manual=false)
 Activate cron job. More...
 
static deactivateJob (ilCronJob $a_job, $a_manual=false)
 Deactivate cron job. More...
 
static isJobActive ($a_job_id)
 Check if given job is currently active. More...
 
static isJobInactive ($a_job_id)
 Check if given job is currently inactive. More...
 
static updateJobSchedule (ilCronJob $a_job, $a_schedule_type, $a_schedule_value)
 Update job schedule. More...
 
static ping ($a_job_id)
 Keep cron job alive. More...
 

Static Protected Member Functions

static runJob (ilCronJob $a_job, array $a_job_data=null, $a_manual=false)
 Run single cron job (internal) More...
 
static sendNotification (ilCronJob $a_job, $a_message)
 Send notification to admin about job event(s) More...
 
static updateJobResult (ilCronJob $a_job, ilCronJobResult $a_result, $a_manual=false)
 Save job result. More...
 
static getMicrotime ()
 Get current microtime. More...
 

Detailed Description

Cron management.

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 11 of file class.ilCronManager.php.

Member Function Documentation

◆ activateJob()

static ilCronManager::activateJob ( ilCronJob  $a_job,
  $a_manual = false 
)
static

Activate cron job.

Parameters
ilCronJob$a_job
bool$a_manual

Definition at line 577 of file class.ilCronManager.php.

578 {
579 global $ilDB, $ilUser;
580
581 $user_id = $a_manual ? $ilUser->getId() : 0;
582
583 $sql = "UPDATE cron_job SET ".
584 " job_status = ".$ilDB->quote(1, "integer").
585 " , job_status_user_id = ".$ilDB->quote($user_id, "integer").
586 " , job_status_type = ".$ilDB->quote($a_manual, "integer").
587 " , job_status_ts = ".$ilDB->quote(time(), "integer").
588 " WHERE job_id = ".$ilDB->quote($a_job->getId(), "text");
589 $ilDB->manipulate($sql);
590
591 $a_job->activationWasToggled(true);
592 }
ilCronJob\activationWasToggled
activationWasToggled($a_currently_active)
Cron job status was changed.
Definition: class.ilCronJob.php:259
ilCronJob\getId
getId()
Get id.
$ilDB
global $ilDB
Definition: storeScorm2004.php:19
$ilUser
$ilUser
Definition: imgupload.php:18

References $ilDB, $ilUser, ilCronJob\activationWasToggled(), and ilCronJob\getId().

Referenced by ilCronManagerGUI\confirmedActivate(), createDefaultEntry(), and resetJob().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ clearFromXML()

static ilCronManager::clearFromXML (   $a_component,
array  $a_xml_job_ids 
)
static

Clear job data.

Parameters
string$a_component
array$a_xml_job_ids

Definition at line 416 of file class.ilCronManager.php.

417 {
418 global $ilDB, $ilLog;
419
420 if(!$ilDB->tableExists("cron_job"))
421 {
422 return;
423 }
424
425 // gather existing jobs
426 $all_jobs = array();
427 $sql = "SELECT job_id FROM cron_job".
428 " WHERE component = ".$ilDB->quote($a_component, "text");
429 $set = $ilDB->query($sql);
430 while($row = $ilDB->fetchAssoc($set))
431 {
432 $all_jobs[] = $row["job_id"];
433 }
434
435 if(sizeof($all_jobs))
436 {
437 if(sizeof($a_xml_job_ids))
438 {
439 // delete obsolete job data
440 foreach($all_jobs as $job_id)
441 {
442 if(!in_array($job_id, $a_xml_job_ids))
443 {
444 $ilDB->manipulate("DELETE FROM cron_job".
445 " WHERE component = ".$ilDB->quote($a_component, "text").
446 " AND job_id = ".$ilDB->quote($job_id, "text"));
447
448 $ilLog->write("Cron XML - Job ".$job_id." in class ".$a_component.
449 " deleted.");
450 }
451 }
452 }
453 else
454 {
455 $ilDB->manipulate("DELETE FROM cron_job".
456 " WHERE component = ".$ilDB->quote($a_component, "text"));
457
458 $ilLog->write("Cron XML - All jobs deleted for ".$a_component." as component is inactive.");
459 }
460 }
461 }
$ilLog
$ilLog
Definition: inc.setup_header.php:130

References $ilDB, $ilLog, and $row.

Referenced by ilObjDefReader\handlerEndTag().

+ Here is the caller graph for this function:

◆ createDefaultEntry()

static ilCronManager::createDefaultEntry ( ilCronJob  $a_job,
  $a_component,
  $a_class,
  $a_path 
)
static

Definition at line 323 of file class.ilCronManager.php.

324 {
325 global $ilDB, $ilLog, $ilSetting;
326
327 // already exists?
328 $sql = "SELECT job_id, schedule_type FROM cron_job".
329 " WHERE component = ".$ilDB->quote($a_component, "text").
330 " AND job_id = ".$ilDB->quote($a_job->getId(), "text");
331 $set = $ilDB->query($sql);
332 $row = $ilDB->fetchAssoc($set);
333 $job_exists = ($row["job_id"] == $a_job->getId());
334 $schedule_type = $row["schedule_type"];
335
336 // new job
337 if(!$job_exists)
338 {
339 $sql = "INSERT INTO cron_job (job_id, component, class, path)".
340 " VALUES (".$ilDB->quote($a_job->getId(), "text").", ".
341 $ilDB->quote($a_component, "text").", ".
342 $ilDB->quote($a_class, "text").", ".
343 $ilDB->quote($a_path, "text").")";
344 $ilDB->manipulate($sql);
345
346 $ilLog->write("Cron XML - Job ".$a_job->getId()." in class ".$a_class.
347 " added.");
348
349 // only if flexible
350 self::updateJobSchedule($a_job,
351 $a_job->getDefaultScheduleType(),
352 $a_job->getDefaultScheduleValue());
353
354 // #12221
355 if(!is_object($ilSetting))
356 {
357 include_once "Services/Administration/classes/class.ilSetting.php";
358 $ilSetting = new ilSetting();
359 }
360
361 if($a_job->hasAutoActivation())
362 {
363 self::activateJob($a_job);
364 }
365 else
366 {
367 // to overwrite dependent settings
368 $a_job->activationWasToggled(false);
369 }
370 }
371 // existing job - but schedule is flexible now
372 else if($a_job->hasFlexibleSchedule() && !$schedule_type)
373 {
374 self::updateJobSchedule($a_job,
375 $a_job->getDefaultScheduleType(),
376 $a_job->getDefaultScheduleValue());
377 }
378 // existing job - but schedule is static now
379 else if(!$a_job->hasFlexibleSchedule() && $schedule_type)
380 {
381 self::updateJobSchedule($a_job, null, null);
382 }
383 }
ilCronJob\getDefaultScheduleType
getDefaultScheduleType()
Get schedule type.
ilCronJob\getDefaultScheduleValue
getDefaultScheduleValue()
Get schedule value.
ilCronJob\hasAutoActivation
hasAutoActivation()
Is to be activated on "installation".
ilCronJob\hasFlexibleSchedule
hasFlexibleSchedule()
Can the schedule be configured?
ilCronManager\activateJob
static activateJob(ilCronJob $a_job, $a_manual=false)
Activate cron job.
Definition: class.ilCronManager.php:577
ilCronManager\updateJobSchedule
static updateJobSchedule(ilCronJob $a_job, $a_schedule_type, $a_schedule_value)
Update job schedule.
Definition: class.ilCronManager.php:681
ilSetting
ILIAS Setting Class.
Definition: class.ilSetting.php:33
$ilSetting
global $ilSetting
Definition: privfeed.php:17

References $ilDB, $ilLog, $ilSetting, $row, activateJob(), ilCronJob\activationWasToggled(), ilCronJob\getDefaultScheduleType(), ilCronJob\getDefaultScheduleValue(), ilCronJob\getId(), ilCronJob\hasAutoActivation(), ilCronJob\hasFlexibleSchedule(), and updateJobSchedule().

Referenced by getJobInstanceById(), getPluginJobs(), and updateFromXML().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ deactivateJob()

static ilCronManager::deactivateJob ( ilCronJob  $a_job,
  $a_manual = false 
)
static

Deactivate cron job.

Parameters
ilCronJob$a_job
bool$a_manual

Definition at line 600 of file class.ilCronManager.php.

601 {
602 global $ilDB, $ilUser;
603
604 $user_id = $a_manual ? $ilUser->getId() : 0;
605
606 $sql = "UPDATE cron_job SET ".
607 " job_status = ".$ilDB->quote(0, "integer").
608 " , job_status_user_id = ".$ilDB->quote($user_id, "integer").
609 " , job_status_type = ".$ilDB->quote($a_manual, "integer").
610 " , job_status_ts = ".$ilDB->quote(time(), "integer").
611 " WHERE job_id = ".$ilDB->quote($a_job->getId(), "text");
612 $ilDB->manipulate($sql);
613
614 $a_job->activationWasToggled(false);
615 }

References $ilDB, $ilUser, ilCronJob\activationWasToggled(), and ilCronJob\getId().

Referenced by ilCronManagerGUI\confirmedDeactivate(), and runJob().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getCronJobData()

static ilCronManager::getCronJobData (   $a_id = null,
  $a_include_inactive = true 
)
static

Get cron job configuration/execution data.

Parameters
array | string$a_id
array$a_include_inactive
Returns
array

Definition at line 503 of file class.ilCronManager.php.

504 {
505 global $ilDB;
506
507 $res = array();
508
509 if($a_id && !is_array($a_id))
510 {
511 $a_id = array($a_id);
512 }
513
514 $sql = "SELECT * FROM cron_job";
515
516 $where = array();
517 if($a_id)
518 {
519 $where[] = $ilDB->in("job_id", $a_id, "", "text");
520 }
521 else
522 {
523 $where[] = "class <> ".$ilDB->quote(IL_COMP_PLUGIN, "text");
524 }
525 if(!$a_include_inactive)
526 {
527 $where[] = "job_status = ".$ilDB->quote(1, "integer");
528 }
529 if(sizeof($where))
530 {
531 $sql .= " WHERE ".implode(" AND ", $where);
532 }
533
534 // :TODO: discuss job execution order
535 $sql .= " ORDER BY job_id";
536
537 $set = $ilDB->query($sql);
538 while($row = $ilDB->fetchAssoc($set))
539 {
540 $res[] = $row;
541 }
542
543 return $res;
544 }
IL_COMP_PLUGIN
const IL_COMP_PLUGIN
Definition: class.ilComponent.php:7

References $ilDB, $res, $row, and IL_COMP_PLUGIN.

Referenced by ilCronManagerGUI\addToExternalSettingsForm(), ilCronDeleteInactiveUserAccounts\calculateDeletionData(), ilCronManagerTableGUI\getItems(), getJobInstanceById(), getPluginJobs(), ilCronManagerGUI\initEditForm(), isJobActive(), and isJobInactive().

+ Here is the caller graph for this function:

◆ getJobInstance()

static ilCronManager::getJobInstance (   $a_id,
  $a_component,
  $a_class,
  $a_path = null 
)
static

Get job instance (by job data)

Parameters
string$a_component
string$a_class
string$a_path
Returns
ilCronJob

Definition at line 267 of file class.ilCronManager.php.

268 {
269 global $ilLog;
270
271 if(!$a_path)
272 {
273 $a_path = $a_component."/classes/";
274 }
275 $class_file = $a_path."class.".$a_class.".php";
276 if(file_exists($class_file))
277 {
278 include_once $class_file;
279 if(class_exists($a_class))
280 {
281 $job = new $a_class();
282 if($job instanceof ilCronJob)
283 {
284 if($job->getId() == $a_id)
285 {
286 return $job;
287 }
288 else
289 {
290 $mess .= " - job id mismatch";
291 }
292 }
293 else
294 {
295 $mess .= " - does not extend ilCronJob";
296 }
297 }
298 else
299 {
300 $mess = "- class not found in file";
301 }
302 }
303 else
304 {
305 $mess = " - class file not found";
306 }
307
308 $ilLog->write("Cron XML - Job ".$a_id." in class ".$a_class." (".
309 $class_file.") is invalid.".$mess);
310 }
ilCronJob
Cron job application base class.
Definition: class.ilCronJob.php:12

References $ilLog.

Referenced by ilCronManagerGUI\addToExternalSettingsForm(), ilCronManagerTableGUI\getItems(), getJobInstanceById(), and updateFromXML().

+ Here is the caller graph for this function:

◆ getJobInstanceById()

static ilCronManager::getJobInstanceById (   $a_job_id)
static

Get job instance (by job id)

Parameters
string$a_job_id
Returns
ilCronJob

Definition at line 216 of file class.ilCronManager.php.

217 {
218 global $ilLog, $ilPluginAdmin;
219
220 // plugin
221 if(substr($a_job_id, 0, 4) == "pl__")
222 {
223 $parts = explode("__", $a_job_id);
224 $pl_name = $parts[1];
225 $job_id = $parts[2];
226 if($ilPluginAdmin->isActive(IL_COMP_SERVICE, "Cron", "crnhk", $pl_name))
227 {
228 $plugin_obj = $ilPluginAdmin->getPluginObject(IL_COMP_SERVICE,
229 "Cron", "crnhk", $pl_name);
230 $job = $plugin_obj->getCronJobInstance($job_id);
231 if($job instanceof ilCronJob)
232 {
233 // should never happen but who knows...
234 if(!sizeof(ilCronManager::getCronJobData($job_id)))
235 {
236 // as job is not "imported" from xml
237 ilCronManager::createDefaultEntry($job, $pl_name, IL_COMP_PLUGIN, "");
238 }
239 return $job;
240 }
241 }
242
243 return null;
244 }
245 // system
246 else
247 {
248 $job_data = array_pop(self::getCronJobData($a_job_id));
249 if($job_data["job_id"] == $a_job_id)
250 {
251 return self::getJobInstance($job_data["job_id"], $job_data["component"],
252 $job_data["class"], $job_data["path"]);
253 }
254 }
255
256 $ilLog->write("CRON - job ".$a_job_id." seems invalid or is inactive");
257 }
IL_COMP_SERVICE
const IL_COMP_SERVICE
Definition: class.ilComponent.php:6
ilCronManager\getCronJobData
static getCronJobData($a_id=null, $a_include_inactive=true)
Get cron job configuration/execution data.
Definition: class.ilCronManager.php:503
ilCronManager\createDefaultEntry
static createDefaultEntry(ilCronJob $a_job, $a_component, $a_class, $a_path)
Definition: class.ilCronManager.php:323
ilCronManager\getJobInstance
static getJobInstance($a_id, $a_component, $a_class, $a_path=null)
Get job instance (by job data)
Definition: class.ilCronManager.php:267

References $ilLog, createDefaultEntry(), getCronJobData(), getJobInstance(), IL_COMP_PLUGIN, and IL_COMP_SERVICE.

Referenced by ilCronManagerGUI\getMultiActionData(), ilCronManagerGUI\initEditForm(), runActiveJobs(), runJobManual(), and ilCronManagerGUI\update().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMicrotime()

static ilCronManager::getMicrotime ( )
staticprotected

Get current microtime.

Returns
float

Definition at line 702 of file class.ilCronManager.php.

703 {
704 list($usec, $sec) = explode(" ", microtime());
705 return ((float)$usec + (float)$sec);
706 }

Referenced by runJob().

+ Here is the caller graph for this function:

◆ getPluginJobs()

static ilCronManager::getPluginJobs (   $a_only_active = false)
static

Definition at line 463 of file class.ilCronManager.php.

464 {
465 global $ilPluginAdmin;
466
467 $res = array();
468
469 foreach($ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "Cron", "crnhk") as $pl_name)
470 {
471 $plugin_obj = $ilPluginAdmin->getPluginObject(IL_COMP_SERVICE, "Cron", "crnhk", $pl_name);
472
473 foreach((array)$plugin_obj->getCronJobInstances() as $job)
474 {
475 $item = array_pop(ilCronManager::getCronJobData($job->getId()));
476 if(!sizeof($item))
477 {
478 // as job is not "imported" from xml
479 ilCronManager::createDefaultEntry($job, $pl_name, IL_COMP_PLUGIN, "");
480 }
481
482 $item = array_pop(ilCronManager::getCronJobData($job->getId()));
483
484 // #17941
485 if(!$a_only_active ||
486 $item["job_status"] == 1)
487 {
488 $res[$job->getId()] = array($job, $item);
489 }
490 }
491 }
492
493 return $res;
494 }

References $res, createDefaultEntry(), getCronJobData(), IL_COMP_PLUGIN, and IL_COMP_SERVICE.

Referenced by ilCronManagerTableGUI\getItems().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isJobActive()

static ilCronManager::isJobActive (   $a_job_id)
static

Check if given job is currently active.

Parameters
string$a_job_id
Returns
boolean

Definition at line 623 of file class.ilCronManager.php.

624 {
625 $job = self::getCronJobData($a_job_id);
626 if((bool)$job[0]["job_status"])
627 {
628 return true;
629 }
630 return false;
631 }

References getCronJobData().

Referenced by ilCronManagerGUI\confirmedDeactivate(), ilCronManagerGUI\confirmedReset(), ilObjForumAdministrationGUI\getSettingsForm(), ilObjContentObjectGUI\linkChecker(), and ilLPObjectStatisticsGUI\showCronJobInfo().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isJobInactive()

static ilCronManager::isJobInactive (   $a_job_id)
static

Check if given job is currently inactive.

Parameters
string$a_job_id
Returns
boolean

Definition at line 639 of file class.ilCronManager.php.

640 {
641 $job = self::getCronJobData($a_job_id);
642 if(!(bool)$job[0]["job_status"])
643 {
644 return true;
645 }
646 return false;
647 }

References getCronJobData().

Referenced by ilCronManagerGUI\confirmedActivate().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ping()

static ilCronManager::ping (   $a_job_id)
static

Keep cron job alive.

Parameters
string$a_job_id

Definition at line 713 of file class.ilCronManager.php.

714 {
715 global $ilDB;
716
717 $ilDB->manipulate("UPDATE cron_job SET ".
718 " alive_ts = ".$ilDB->quote(time(), "integer").
719 " WHERE job_id = ".$ilDB->quote($a_job_id, "text"));
720 }

References $ilDB.

Referenced by ilLPCronObjectStatistics\gatherCourseLPData(), ilLPCronObjectStatistics\gatherTypesData(), ilLPCronObjectStatistics\gatherUserData(), ilForumCronNotification\keepAlive(), ilLDAPCronSynchronization\run(), and ilMembershipCronNotifications\run().

+ Here is the caller graph for this function:

◆ resetJob()

static ilCronManager::resetJob ( ilCronJob  $a_job)
static

Reset job.

Parameters
ilCronJob$a_job

Definition at line 551 of file class.ilCronManager.php.

552 {
553 global $ilDB;
554
555 include_once "Services/Cron/classes/class.ilCronJobResult.php";
556 $result = new ilCronJobResult();
557 $result->setStatus(ilCronJobResult::STATUS_RESET);
558 $result->setCode(ilCronJobResult::CODE_MANUAL_RESET);
559 $result->setMessage("Cron job re-activated by admin");
560 self::updateJobResult($a_job, $result, true);
561
562 $ilDB->manipulate("UPDATE cron_job".
563 " SET running_ts = ".$ilDB->quote(0, "integer").
564 " , alive_ts = ".$ilDB->quote(0, "integer").
565 " , job_result_ts = ".$ilDB->quote(0, "integer").
566 " WHERE job_id = ".$ilDB->quote($a_job->getId(), "text"));
567
568 self::activateJob($a_job, true);
569 }
$result
$result
Definition: CleanUpTest.php:407
ilCronJobResult
Cron job result data container.
Definition: class.ilCronJobResult.php:12
ilCronManager\updateJobResult
static updateJobResult(ilCronJob $a_job, ilCronJobResult $a_result, $a_manual=false)
Save job result.
Definition: class.ilCronManager.php:656

References $ilDB, $result, activateJob(), ilCronJobResult\CODE_MANUAL_RESET, ilCronJob\getId(), ilCronJobResult\STATUS_RESET, and updateJobResult().

Referenced by ilCronManagerGUI\confirmedActivate(), and ilCronManagerGUI\confirmedReset().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ runActiveJobs()

static ilCronManager::runActiveJobs ( )
static

Run all active jobs.

Definition at line 16 of file class.ilCronManager.php.

17 {
18 global $ilLog, $ilSetting;
19
20 // separate log for cron
21 // $this->log->setFilename($_COOKIE["ilClientId"]."_cron.txt");
22
23 $ilLog->write("CRON - batch start");
24
25 $ilSetting->set("last_cronjob_start_ts", time());
26
27 // ilLink::_getStaticLink() should work in crons
28 if(!defined("ILIAS_HTTP_PATH"))
29 {
30 define("ILIAS_HTTP_PATH", ilUtil::_getHttpPath());
31 }
32
33 // system
34 foreach(self::getCronJobData(null, false) as $row)
35 {
36 $job = self::getJobInstanceById($row["job_id"]);
37 if($job)
38 {
39 // #18411 - we are NOT using the initial job data as it might be outdated at this point
40 self::runJob($job);
41 }
42 }
43
44 // plugins
45 foreach(self::getPluginJobs(true) as $item)
46 {
47 self::runJob($item[0], $item[1]);
48 }
49
50 $ilLog->write("CRON - batch end");
51 }
ilCronManager\getJobInstanceById
static getJobInstanceById($a_job_id)
Get job instance (by job id)
Definition: class.ilCronManager.php:216
ilCronManager\runJob
static runJob(ilCronJob $a_job, array $a_job_data=null, $a_manual=false)
Run single cron job (internal)
Definition: class.ilCronManager.php:97
ilUtil\_getHttpPath
static _getHttpPath()
Definition: class.ilUtil.php:4922
defined
defined( 'APPLICATION_ENV')||define( 'APPLICATION_ENV'
Definition: bootstrap.php:27

References $ilLog, $ilSetting, $row, ilUtil\_getHttpPath(), defined, getJobInstanceById(), and runJob().

+ Here is the call graph for this function:

◆ runJob()

static ilCronManager::runJob ( ilCronJob  $a_job,
array  $a_job_data = null,
  $a_manual = false 
)
staticprotected

Run single cron job (internal)

Parameters
ilCronJob$a_job
array$a_job_data
bool$a_manual
Returns
boolean

Definition at line 97 of file class.ilCronManager.php.

98 {
99 global $ilLog, $ilDB;
100
101 $did_run = false;
102
103 include_once "Services/Cron/classes/class.ilCronJobResult.php";
104
105 if($a_job_data === null)
106 {
107 // aquire "fresh" job (status) data
108 $a_job_data = array_pop(self::getCronJobData($a_job->getId()));
109 }
110
111 // already running?
112 if($a_job_data["alive_ts"])
113 {
114 $ilLog->write("CRON - job ".$a_job_data["job_id"]." still running");
115
116 $cut = 60*60*3; // 3h
117
118 // is running (and has not pinged) for 3 hours straight, we assume it crashed
119 if(time()-$a_job_data["alive_ts"] > $cut)
120 {
121 $ilDB->manipulate("UPDATE cron_job SET".
122 " running_ts = ".$ilDB->quote(0, "integer").
123 " , alive_ts = ".$ilDB->quote(0, "integer").
124 " WHERE job_id = ".$ilDB->quote($a_job_data["job_id"], "text"));
125
126 self::deactivateJob($a_job); // #13082
127
128 $result = new ilCronJobResult();
129 $result->setStatus(ilCronJobResult::STATUS_CRASHED);
130 $result->setCode(ilCronJobResult::CODE_SUPPOSED_CRASH);
131 $result->setMessage("Cron job deactivated because it has been inactive for 3 hours");
132
133 if(!$a_manual)
134 {
135 self::sendNotification($a_job, $result);
136 }
137
138 self::updateJobResult($a_job, $result, $a_manual);
139
140 $ilLog->write("CRON - job ".$a_job_data["job_id"]." deactivated (assumed crash)");
141 }
142 }
143 // initiate run?
144 else if($a_job->isActive($a_job_data["job_result_ts"],
145 $a_job_data["schedule_type"], $a_job_data["schedule_value"], $a_manual))
146 {
147 $ilLog->write("CRON - job ".$a_job_data["job_id"]." started");
148
149 $ilDB->manipulate("UPDATE cron_job SET".
150 " running_ts = ".$ilDB->quote(time(), "integer").
151 " , alive_ts = ".$ilDB->quote(time(), "integer").
152 " WHERE job_id = ".$ilDB->quote($a_job_data["job_id"], "text"));
153
154 $ts_in = self::getMicrotime();
155 $result = $a_job->run();
156 $ts_dur = self::getMicrotime()-$ts_in;
157
158 // no proper result
159 if(!$result instanceof ilCronJobResult)
160 {
161 $result = new ilCronJobResult();
162 $result->setStatus(ilCronJobResult::STATUS_CRASHED);
163 $result->setCode(ilCronJobResult::CODE_NO_RESULT);
164 $result->setMessage("Cron job did not return a proper result");
165
166 if(!$a_manual)
167 {
168 self::sendNotification($a_job, $result);
169 }
170
171 $ilLog->write("CRON - job ".$a_job_data["job_id"]." no result");
172 }
173 // no valid configuration, job won't work
174 else if($result->getStatus() == ilCronJobResult::STATUS_INVALID_CONFIGURATION)
175 {
176 self::deactivateJob($a_job);
177
178 if(!$a_manual)
179 {
180 self::sendNotification($a_job, $result);
181 }
182
183 $ilLog->write("CRON - job ".$a_job_data["job_id"]." invalid configuration");
184 }
185 // success!
186 else
187 {
188 $did_run = true;
189 }
190
191 $result->setDuration($ts_dur);
192
193 self::updateJobResult($a_job, $result, $a_manual);
194
195 $ilDB->manipulate("UPDATE cron_job SET".
196 " running_ts = ".$ilDB->quote(0, "integer").
197 " , alive_ts = ".$ilDB->quote(0, "integer").
198 " WHERE job_id = ".$ilDB->quote($a_job_data["job_id"], "text"));
199
200 $ilLog->write("CRON - job ".$a_job_data["job_id"]." finished");
201 }
202 else
203 {
204 $ilLog->write("CRON - job ".$a_job_data["job_id"]." returned status inactive");
205 }
206
207 return $did_run;
208 }
ilCronJob\run
run()
Run job.
ilCronJob\isActive
isActive($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
Is job currently active?
Definition: class.ilCronJob.php:35
ilCronManager\sendNotification
static sendNotification(ilCronJob $a_job, $a_message)
Send notification to admin about job event(s)
Definition: class.ilCronManager.php:318
ilCronManager\deactivateJob
static deactivateJob(ilCronJob $a_job, $a_manual=false)
Deactivate cron job.
Definition: class.ilCronManager.php:600
ilCronManager\getMicrotime
static getMicrotime()
Get current microtime.
Definition: class.ilCronManager.php:702

References $ilDB, $ilLog, $result, ilCronJobResult\CODE_NO_RESULT, ilCronJobResult\CODE_SUPPOSED_CRASH, deactivateJob(), ilCronJob\getId(), getMicrotime(), ilCronJob\isActive(), ilCronJob\run(), sendNotification(), ilCronJobResult\STATUS_CRASHED, ilCronJobResult\STATUS_INVALID_CONFIGURATION, and updateJobResult().

Referenced by runActiveJobs(), and runJobManual().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ runJobManual()

static ilCronManager::runJobManual (   $a_job_id)
static

Run single job manually.

Parameters
string$a_job_id
Returns
bool

Definition at line 59 of file class.ilCronManager.php.

60 {
61 global $ilLog;
62
63 $result = false;
64
65 $ilLog->write("CRON - manual start (".$a_job_id.")");
66
67 $job = self::getJobInstanceById($a_job_id);
68 if($job)
69 {
70 if($job->isManuallyExecutable())
71 {
72 $result = self::runJob($job, null, true);
73 }
74 else
75 {
76 $ilLog->write("CRON - job ".$a_job_id." is not intended to be executed manually");
77 }
78 }
79 else
80 {
81 $ilLog->write("CRON - job ".$a_job_id." seems invalid or is inactive");
82 }
83
84 $ilLog->write("CRON - manual end (".$a_job_id.")");
85
86 return $result;
87 }

References $ilLog, $result, getJobInstanceById(), and runJob().

Referenced by ilCronManagerGUI\confirmedRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ sendNotification()

static ilCronManager::sendNotification ( ilCronJob  $a_job,
  $a_message 
)
staticprotected

Send notification to admin about job event(s)

Parameters
ilCronJob$a_job
string$a_message

Definition at line 318 of file class.ilCronManager.php.

319 {
320 // :TODO:
321 }

Referenced by runJob().

+ Here is the caller graph for this function:

◆ updateFromXML()

static ilCronManager::updateFromXML (   $a_component,
  $a_id,
  $a_class,
  $a_path = null 
)
static

Process data from module.xml/service.xml.

Parameters
string$a_component
string$a_id
string$a_class
string$_path

Definition at line 393 of file class.ilCronManager.php.

394 {
395 global $ilDB;
396
397 if(!$ilDB->tableExists("cron_job"))
398 {
399 return;
400 }
401
402 // only if job seems valid
403 $job = self::getJobInstance($a_id, $a_component, $a_class, $a_path);
404 if($job)
405 {
406 self::createDefaultEntry($job, $a_component, $a_class, $a_path);
407 }
408 }

References $ilDB, createDefaultEntry(), and getJobInstance().

Referenced by ilObjDefReader\handlerBeginTag().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ updateJobResult()

static ilCronManager::updateJobResult ( ilCronJob  $a_job,
ilCronJobResult  $a_result,
  $a_manual = false 
)
staticprotected

Save job result.

Parameters
ilCronJob$a_job
ilCronJobResult$a_result
bool$a_manual

Definition at line 656 of file class.ilCronManager.php.

657 {
658 global $ilDB, $ilUser;
659
660 $user_id = $a_manual ? $ilUser->getId() : 0;
661
662 $sql = "UPDATE cron_job SET ".
663 " job_result_status = ".$ilDB->quote($a_result->getStatus(), "integer").
664 " , job_result_user_id = ".$ilDB->quote($user_id, "integer").
665 " , job_result_code = ".$ilDB->quote($a_result->getCode(), "text").
666 " , job_result_message = ".$ilDB->quote($a_result->getMessage(), "text").
667 " , job_result_type = ".$ilDB->quote($a_manual, "integer").
668 " , job_result_ts = ".$ilDB->quote(time(), "integer").
669 " , job_result_dur = ".$ilDB->quote($a_result->getDuration()*1000, "integer").
670 " WHERE job_id = ".$ilDB->quote($a_job->getId(), "text");
671 $ilDB->manipulate($sql);
672 }

References $ilDB, $ilUser, ilCronJobResult\getCode(), ilCronJobResult\getDuration(), ilCronJob\getId(), ilCronJobResult\getMessage(), and ilCronJobResult\getStatus().

Referenced by resetJob(), and runJob().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ updateJobSchedule()

static ilCronManager::updateJobSchedule ( ilCronJob  $a_job,
  $a_schedule_type,
  $a_schedule_value 
)
static

Update job schedule.

Parameters
ilCronJob$a_job
int$a_schedule_type
int$a_schedule_value

Definition at line 681 of file class.ilCronManager.php.

682 {
683 global $ilDB;
684
685 if($a_schedule_type === null ||
686 ($a_job->hasFlexibleSchedule() &&
687 in_array($a_schedule_type, $a_job->getValidScheduleTypes())))
688 {
689 $sql = "UPDATE cron_job SET ".
690 " schedule_type = ".$ilDB->quote($a_schedule_type, "integer").
691 " , schedule_value = ".$ilDB->quote($a_schedule_value, "integer").
692 " WHERE job_id = ".$ilDB->quote($a_job->getId(), "text");
693 $ilDB->manipulate($sql);
694 }
695 }
ilCronJob\getValidScheduleTypes
getValidScheduleTypes()
Get all available schedule types.
Definition: class.ilCronJob.php:98

References $ilDB, ilCronJob\getId(), ilCronJob\getValidScheduleTypes(), and ilCronJob\hasFlexibleSchedule().

Referenced by createDefaultEntry(), ilCronManagerTableGUI\parseJobToData(), and ilCronManagerGUI\update().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:
The documentation for this class was generated from the following file: