-
Notifications
You must be signed in to change notification settings - Fork 0
/
elysia_cron.module
1942 lines (1697 loc) · 56.1 KB
/
elysia_cron.module
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* @file
* Elysia cron primary module file.
*/
require_once 'elysia_cron_scheduler.inc';
require_once 'elysia_cron.admin.inc';
/**
* Implements hook_config_info().
*/
function elysia_cron_config_info() {
$prefixes['elysia_cron.settings'] = array(
'label' => t('Elysia Cron settings'),
'group' => t('Configuration'),
);
return $prefixes;
}
/**
* Implements hook_menu().
*/
function elysia_cron_menu() {
$items['admin/config/system/cron'] = array(
'title' => 'Cron Settings',
'description' => 'View and manage cron table',
'page callback' => 'elysia_cron_admin_page',
'access callback' => 'elysia_cron_access',
'access arguments' => array('view elysia_cron'),
);
$items['admin/config/system/cron/status'] = array(
'type' => MENU_DEFAULT_LOCAL_TASK,
'title' => 'Status',
'weight' => 1,
);
$items['admin/config/system/cron/settings'] = array(
'type' => MENU_LOCAL_TASK,
'title' => 'Settings',
'page callback' => 'backdrop_get_form',
'page arguments' => array('elysia_cron_settings_form'),
'access callback' => 'elysia_cron_access',
'access arguments' => array('administer elysia_cron'),
'weight' => 2,
);
$items['admin/config/system/cron/maintenance'] = array(
'type' => MENU_LOCAL_TASK,
'title' => 'Maintenance',
'page callback' => 'backdrop_get_form',
'page arguments' => array('elysia_cron_reset_statistics_form'),
'access callback' => 'elysia_cron_access',
'access arguments' => array('administer elysia_cron'),
'weight' => 3,
);
$items['admin/config/system/cron/execute/%'] = array(
'type' => MENU_CALLBACK,
'page callback' => 'elysia_cron_execute_page',
'page arguments' => array(5),
'access callback' => 'elysia_cron_access',
'access arguments' => array('execute elysia_cron'),
);
$items['admin/build/cron/ping'] = array(
'type' => MENU_CALLBACK,
'page callback' => 'elysia_cron_ping_page',
'access callback' => TRUE,
);
return $items;
}
/**
* Implements hook_menu_alter().
*/
function elysia_cron_menu_alter(&$items) {
// Override default cron page.
$items['admin/config/system/cron']['title'] = 'Cron Settings';
$items['admin/config/system/cron']['description'] = 'View and manage cron table';
$items['admin/config/system/cron']['page callback'] = 'elysia_cron_admin_page';
$items['admin/config/system/cron']['access callback'] = 'elysia_cron_access';
$items['admin/config/system/cron']['access arguments'] = array('view elysia_cron');
$items['admin/config/system/cron']['file'] = NULL;
$items['admin/reports/status/run-cron']['page callback'] = 'elysia_cron_run_manually';
$items['admin/reports/status/run-cron']['file'] = NULL;
}
/**
* Check access to operation inside elysia cron module.
*
* Permission have nested structure, for example: "administer elysia_cron" allow
* to do anything: view, execute and configure cron jobs.
*
* @param string $perm
* Permission name.
*
* @return bool
* Access granted or not.
*/
function elysia_cron_access($perm) {
$access = FALSE;
switch ($perm) {
case 'administer elysia_cron':
$access = user_access($perm);
break;
case 'execute elysia_cron':
$access = user_access($perm) || user_access('administer elysia_cron');
break;
case 'view elysia_cron';
$access = user_access($perm) || user_access('execute elysia_cron') || user_access('administer elysia_cron');
}
return $access;
}
/**
* Implements hook_permission().
*/
function elysia_cron_permission() {
return array(
'administer elysia_cron' => array(
'title' => t('Administer elysia cron'),
'description' => t('Perform changes to cron jobs timings, disable cron or single jobs and access cron execution statistics'),
'restrict access' => TRUE,
),
'execute elysia_cron' => array(
'title' => t('Execute elysia cron jobs'),
'description' => t('Allow users to view statistics, execution status and do manually execute cron jobs'),
),
'view elysia_cron' => array(
'title' => t('View elysia cron stats'),
'description' => t('Allows users to view statistics and execution status of cron jobs'),
),
);
}
/**
* Implements hook_exit().
*/
function elysia_cron_exit() {
global $_elysia_cron_exit_phase;
$_elysia_cron_exit_phase = TRUE;
}
/**
* Implements hook_cron().
*
* Hook cron is invoked only by standard backdrop cron.
* It's used to replace backdrop cron.
*/
function elysia_cron_cron() {
global $_elysia_cron_exit_phase, $_elysia_cron_drush;
// First cron run is executed in standard Backdrop way.
// This is to enable the use of install profiles.
if (state_get('cron_last', 0) <= state_get('install_time', 0)) {
return;
}
// If cron has been executed via "drush core-cron" or any other custom drush
// command then we run internal cron handler which is designed to handle
// cron executions from drush.
if (function_exists('elysia_cron_drush_detect') && elysia_cron_drush_detect()) {
elysia_cron_drush_invoke();
}
// If the path is 'admin/*', or if the user is not anonymous,
// this is a manual cron run (probably by admin/logs/status),
// but not if we are in the exit phase (= this a "poormanscron" run).
$manual_run = empty($_elysia_cron_exit_phase) && ((arg(0) == 'admin') || !empty($GLOBALS['user']->uid));
$result = elysia_cron_run($manual_run);
if ($manual_run) {
if ($result) {
elysia_cron_message('Cron ran successfully');
}
else {
elysia_cron_message('Cron run failed, disabled or nothing to do');
}
// In manual execution it's better to set cron_last variable in standard way
// (so the user sees the execution time updates).
// This invalidates variable cache, but it's a manual execution,
// it should be not a great performance problem.
if (empty($_elysia_cron_drush)) {
state_set('cron_last', time());
}
backdrop_goto('admin/reports/status');
}
// If we are in "poormanscron" mode it's better to force setting of cron_last.
// This invalidates variable cache, but is needed for right execution check.
// @see system_run_automated_cron() in system.module
if (!empty($_elysia_cron_exit_phase)) {
state_set('cron_last', time());
}
backdrop_exit();
}
/**
* Implements hook_cron().
*
* I use help section for admin/build/modules page to check if elysia_cron
* is the module with the smallest weight.
* If it's not i'll set it and print a message.
*/
function elysia_cron_help($section, $arg = FALSE) {
if ($section == 'admin/modules') {
$query = db_select('system', 's');
$query->addExpression('MIN(weight)');
$min = $query->condition('s.name', 'elysia_cron', '!=')
->execute()
->fetchField();
$weight = db_select('system', 's')
->fields('s', array('weight'))
->condition('s.name', 'elysia_cron')
->execute()
->fetchField();
if ($min <= $weight) {
elysia_cron_message('Elysia cron module is not the module with the smallest weight (and it must be). Updating weight...');
db_update('system')
->fields(array('weight' => $min - 1))
->condition('name', 'elysia_cron')
->execute();
}
}
}
function _ec_get_name($name) {
$maxlen = 120;
if (strlen($name) < $maxlen) {
return $name;
}
$border = ($maxlen - 32) / 2;
return substr($name, 0, $border) . md5($name) . substr($name, -$border);
}
function elysia_cron_set($name, $channel = FALSE, $values = array()) {
if ($channel) {
$name = ':' . $name;
}
db_merge('elysia_cron')->key(array('name' => $name))->fields($values)->execute();
global $_elysia_cron_db_cache;
unset($_elysia_cron_db_cache[$name]);
}
function elysia_cron_get($name, $channel = FALSE, $key = FALSE, $default = FALSE, $refresh = FALSE) {
global $_elysia_cron_db_cache;
static $elysia_cron_defaults;
if (!isset($elysia_cron_defaults)) {
$elysia_cron_defaults = array();
}
if ($channel) {
$name = ':' . $name;
}
if ($refresh || !isset($_elysia_cron_db_cache[$name])) {
$_elysia_cron_db_cache[$name] = db_select('elysia_cron', 'ec')
->fields('ec', _elysia_cron_columns())
->condition('name', $name)
->execute()
->fetchAssoc();
if (!$_elysia_cron_db_cache[$name] && isset($elysia_cron_defaults[$name])) {
$_elysia_cron_db_cache[$name] = (array) $elysia_cron_defaults[$name];
}
elseif ($_elysia_cron_db_cache[$name] && isset($elysia_cron_defaults[$name])) {
foreach ($elysia_cron_defaults[$name] as $k => $v) {
if (!isset($_elysia_cron_db_cache[$name][$k]) || is_null($_elysia_cron_db_cache[$name][$k])) {
$_elysia_cron_db_cache[$name][$k] = $v;
}
}
}
}
return !$_elysia_cron_db_cache[$name] || !isset($_elysia_cron_db_cache[$name][$key]) || is_null($_elysia_cron_db_cache[$name][$key]) ? $default : $_elysia_cron_db_cache[$name][$key];
}
/**
* Get status of specified channel.
*
* @param string $channel
* Channel name.
* @param bool $default
* Default value for channel status.
* @param bool $refresh
* If TRUE - fresh status will be get from database.
*
* @return bool
* Channel status.
*/
function elysia_cron_is_channel_disabled($channel, $default = FALSE, $refresh = FALSE) {
// May be overridden by a static conf.
if (isset($GLOBALS['conf'][$n = 'ecc_' . _ec_get_name($channel) . '_d'])) {
return $GLOBALS['conf'][$n];
}
return elysia_cron_get($channel, TRUE, 'disable', $default, $refresh);
}
/**
* Update channel status.
*
* @param string $channel
* Channel name.
* @param bool $value
* New channel status:
* TRUE - enabled
* FALSE - disabled.
*/
function elysia_cron_set_channel_disabled($channel, $value) {
elysia_cron_set($channel, TRUE, array('disable' => $value ? 1 : 0));
}
/**
* Reset channel status to default (disabled).
*
* @param string $channel
* Channel name.
*/
function elysia_cron_reset_channel_disabled($channel) {
elysia_cron_set($channel, TRUE, array('disable' => 0));
}
/**
* Get channel's rule.
*
* @param string $channel
* Channel name.
* @param string $default
* Default rule.
* @param bool $refresh
* If TRUE - fresh status will be get from database.
*
* @return string
* Formatted rule for specified channel.
*/
function elysia_cron_get_channel_rule($channel, $default = '', $refresh = FALSE) {
// May be overridden by a static conf.
if (isset($GLOBALS['conf'][$n = 'ecc_' . _ec_get_name($channel) . '_rul'])) {
return $GLOBALS['conf'][$n];
}
return elysia_cron_get($channel, TRUE, 'rule', $default, $refresh);
}
/**
* Set new rule for channel.
*
* @param string $channel
* Channel name.
* @param string $rule
* Crontab formatted rule.
*/
function elysia_cron_set_channel_rule($channel, $rule) {
elysia_cron_set($channel, TRUE, array('rule' => $rule));
}
/**
* Reset channel's rule to default.
*
* @param string $channel
* Channel name.
*/
function elysia_cron_reset_channel_rule($channel) {
elysia_cron_set($channel, TRUE, array('rule' => NULL));
}
/**
* Check if channel is running now.
*
* @param string $channel
* Channel name.
* @param int $default
* Default value.
* @param bool $refresh
* If TRUE - fresh status will be get from database.
*
* @return int
* Timestamp from beginning of running or zero.
*/
function elysia_cron_is_channel_running($channel, $default = 0, $refresh = FALSE) {
return elysia_cron_get($channel, TRUE, 'running', $default, $refresh);
}
/**
* Updated channel running value.
*
* @param string $channel
* Channel name.
* @param int $value
* New running value.
*/
function elysia_cron_set_channel_running($channel, $value) {
elysia_cron_set($channel, TRUE, array('running' => $value));
}
/**
* Get channel's last run value.
*
* @param string $channel
* Channel name.
* @param int $default
* Default value.
* @param bool $refresh
* If TRUE - fresh status will be get from database.
*
* @return int
* Last run timestamp or zero.
*
* @todo Not used, to delete?
*/
function elysia_cron_get_channel_last_run($channel, $default = 0, $refresh = FALSE) {
return elysia_cron_get($channel, TRUE, 'last_run', $default, $refresh);
}
/**
* Set channel's last run value.
*
* @param string $channel
* Channel name.
* @param int $value
* New last run timestamp.
*
* @todo Not used, to delete?
*/
function elysia_cron_set_channel_last_run($channel, $value) {
elysia_cron_set($channel, TRUE, array('last_run' => $value));
}
/**
* Get channel's last aborted value.
*
* @param string $channel
* Channel name.
* @param int $default
* Default value.
* @param bool $refresh
* If TRUE - fresh status will be get from database.
*
* @return int
* Last aborted timestamp or zero.
*
* @todo Not used, to delete?
*/
function elysia_cron_get_channel_last_aborted($channel, $default = 0, $refresh = FALSE) {
return elysia_cron_get($channel, TRUE, 'last_aborted', $default, $refresh);
}
/**
* Set channel's last aborted value.
*
* @param string $channel
* Channel name.
* @param int $value
* New last aborted timestamp.
*
* @todo Not used, to delete?
*/
function elysia_cron_set_channel_last_aborted($channel, $value) {
elysia_cron_set($channel, TRUE, array('last_aborted' => $value ? 1 : 0));
}
/**
* Get channel's about count.
*
* @param string $channel
* Channel name.
* @param int $default
* Default value.
* @param bool $refresh
* If TRUE - fresh status will be get from database.
*
* @return int
* Abort count for specified channel.
*/
function elysia_cron_get_channel_abort_count($channel, $default = 0, $refresh = FALSE) {
return elysia_cron_get($channel, TRUE, 'abort_count', $default, $refresh);
}
/**
* Set channel's abort count.
*
* @param string $channel
* Channel name.
* @param int $value
* New abort count.
*
* @todo Not used, to delete?
*/
function elysia_cron_set_channel_abort_count($channel, $value) {
elysia_cron_set($channel, TRUE, array('abort_count' => $value));
}
/**
* Get channel's last about function.
*
* @param string $channel
* Channel name.
* @param string $default
* Default value.
* @param bool $refresh
* If TRUE - fresh status will be get from database.
*
* @return string
* Last abort function or empty string.
*
* @todo Not used, to delete?
*/
function elysia_cron_get_channel_last_abort_function($channel, $default = '', $refresh = FALSE) {
return elysia_cron_get($channel, TRUE, 'last_abort_function', $default, $refresh);
}
/**
* Set channel's last abort function.
*
* @param string $channel
* Channel name.
* @param string $value
* Last abort function name.
*
* @todo Not used, to delete?
*/
function elysia_cron_set_channel_last_abort_function($channel, $value) {
elysia_cron_set($channel, TRUE, array('last_abort_function' => $value));
}
/**
* Grab statistics by channel.
*
* @param string $channel
* Channel name.
* @param bool $refresh
* If TRUE - fresh status will be get from database.
*
* @return array
* Statistics for specified channel.
*/
function elysia_cron_get_channel_stats($channel, $refresh = FALSE) {
return array(
'last_run' => elysia_cron_get($channel, TRUE, 'last_run', 0, $refresh),
'last_execution_time' => elysia_cron_get($channel, TRUE, 'last_execution_time', 0, $refresh),
'execution_count' => elysia_cron_get($channel, TRUE, 'execution_count', 0, $refresh),
'avg_execution_time' => elysia_cron_get($channel, TRUE, 'avg_execution_time', 0, $refresh),
'max_execution_time' => elysia_cron_get($channel, TRUE, 'max_execution_time', 0, $refresh),
'last_shutdown_time' => elysia_cron_get($channel, TRUE, 'last_shutdown_time', 0, $refresh),
'last_aborted' => elysia_cron_get($channel, TRUE, 'last_aborted', 0, $refresh),
'abort_count' => elysia_cron_get($channel, TRUE, 'abort_count', 0, $refresh),
'last_abort_function' => elysia_cron_get($channel, TRUE, 'last_abort_function', 0, ''),
);
}
/**
* Update channel's stats.
*
* @param string $channel
* Channel name.
* @param array $data
* Associative array of values.
*/
function elysia_cron_set_channel_stats($channel, array $data = array()) {
elysia_cron_set($channel, TRUE, $data);
}
/**
* Get formatted crontab rule for specified job.
*
* @param string $job
* Job name.
* @param string $default
* Default rule.
* @param bool $refresh
* If TRUE - fresh status will be get from database.
*
* @return string
* Formatted job rule.
*/
function elysia_cron_get_job_rule($job, $default = '', $refresh = FALSE) {
// May be overridden by a static conf.
if (isset($GLOBALS['conf'][$n = 'ec_' . _ec_get_name($job) . '_rul'])) {
return $GLOBALS['conf'][$n];
}
return elysia_cron_get($job, FALSE, 'rule', $default, $refresh);
}
/**
* Set formatted crontab rule for specified job.
*
* @param string $job
* Job name.
* @param string $value
* New crontab rule for job.
*/
function elysia_cron_set_job_rule($job, $value) {
elysia_cron_set($job, FALSE, array('rule' => $value));
}
/**
* Reset crontab job rule to default.
*
* @param string $job
* Job name.
*/
function elysia_cron_reset_job_rule($job) {
elysia_cron_set($job, FALSE, array('rule' => NULL));
}
/**
* Get weight of specified job.
*
* @param string $job
* Job name.
* @param string $default
* Default weight.
* @param bool $refresh
* If TRUE - fresh status will be get from database.
*
* @return string
* Job weight or empty string.
*/
function elysia_cron_get_job_weight($job, $default = '', $refresh = FALSE) {
// May be overridden by a static conf.
if (isset($GLOBALS['conf'][$n = 'ec_' . _ec_get_name($job) . '_w'])) {
return $GLOBALS['conf'][$n];
}
return elysia_cron_get($job, FALSE, 'weight', $default, $refresh);
}
/**
* Set weight specified job.
*
* @param string $job
* Job name.
* @param string $value
* New weight for job.
*/
function elysia_cron_set_job_weight($job, $value) {
elysia_cron_set($job, FALSE, array('weight' => $value));
}
/**
* Reset job weight to default.
*
* @param string $job
* Job name.
*/
function elysia_cron_reset_job_weight($job) {
elysia_cron_set($job, FALSE, array('weight' => NULL));
}
function elysia_cron_is_job_disabled($job, $default = FALSE, $refresh = FALSE) {
// May be overridden by a static conf.
if (isset($GLOBALS['conf'][$n = 'ec_' . _ec_get_name($job) . '_d'])) {
return $GLOBALS['conf'][$n];
}
return elysia_cron_get($job, FALSE, 'disable', $default, $refresh);
}
function elysia_cron_set_job_disabled($job, $value) {
elysia_cron_set($job, FALSE, array('disable' => $value ? 1 : 0));
}
function elysia_cron_reset_job_disabled($job) {
elysia_cron_set($job, FALSE, array('disable' => NULL));
}
function elysia_cron_get_job_channel($job, $default = '', $refresh = FALSE) {
// May be overridden by a static conf.
if (isset($GLOBALS['conf'][$n = 'ec_' . _ec_get_name($job) . '_c'])) {
$c = $GLOBALS['conf'][$n];
}
else {
// In this place, 'context' means 'channel'.
$c = elysia_cron_get($job, FALSE, 'context', $default, $refresh);
}
return !$c ? $default : $c;
}
function elysia_cron_set_job_channel($job, $value) {
// In this place, 'context' means 'channel'.
elysia_cron_set($job, FALSE, array('context' => $value));
}
function elysia_cron_reset_job_channel($job) {
// In this place, 'context' means 'channel'.
elysia_cron_set($job, FALSE, array('context' => NULL));
}
function elysia_cron_is_job_running($job, $default = 0, $refresh = FALSE) {
return elysia_cron_get($job, FALSE, 'running', $default, $refresh);
}
function elysia_cron_set_job_running($job, $value) {
elysia_cron_set($job, FALSE, array('running' => $value));
}
function elysia_cron_get_job_last_run($job, $default = 0, $refresh = FALSE) {
return elysia_cron_get($job, FALSE, 'last_run', $default, $refresh);
}
function elysia_cron_set_job_last_run($job, $value) {
elysia_cron_set($job, FALSE, array('last_run' => $value));
}
function elysia_cron_get_job_stats($job, $refresh = FALSE) {
return array(
'last_run' => elysia_cron_get($job, FALSE, 'last_run', 0, $refresh),
'last_execution_time' => elysia_cron_get($job, FALSE, 'last_execution_time', 0, $refresh),
'execution_count' => elysia_cron_get($job, FALSE, 'execution_count', 0, $refresh),
'avg_execution_time' => elysia_cron_get($job, FALSE, 'avg_execution_time', 0, $refresh),
'max_execution_time' => elysia_cron_get($job, FALSE, 'max_execution_time', 0, $refresh),
);
}
function elysia_cron_set_job_stats(
$job,
$last_run = -1,
$last_execution_time = -1,
$execution_count = -1,
$avg_execution_time = -1,
$max_execution_time = -1,
$data = array()
) {
if ($last_run != -1) {
$data['last_run'] = $last_run;
}
if ($last_execution_time != -1) {
$data['last_execution_time'] = $last_execution_time;
}
if ($execution_count != -1) {
$data['execution_count'] = $execution_count;
}
if ($avg_execution_time != -1) {
$data['avg_execution_time'] = $avg_execution_time;
}
if ($max_execution_time != -1) {
$data['max_execution_time'] = $max_execution_time;
}
elysia_cron_set($job, FALSE, $data);
}
function elysia_cron_last_channel() {
return state_get('elysia_cron_last_channel', '');
}
function elysia_cron_set_last_channel($channel) {
state_set('elysia_cron_last_channel', $channel);
}
function elysia_cron_reset_stats() {
global $_elysia_cron_settings, $_elysia_cron_settings_by_channel;
elysia_cron_initialize();
foreach ($_elysia_cron_settings as $job => $conf) {
elysia_cron_set_job_stats($job, 0, 0, 0, 0, 0);
}
$channel_reset_data = array(
'last_run' => 0,
'last_execution_time' => 0,
'execution_count' => 0,
'avg_execution_time' => 0,
'max_execution_time' => 0,
'last_shutdown_time' => 0,
'last_aborted' => 0,
'abort_count' => 0,
'last_abort_function' => 0,
);
foreach ($_elysia_cron_settings_by_channel as $channel => $conf) {
elysia_cron_set_channel_stats($channel, $channel_reset_data);
}
}
/*******************************************************************************
* INTERNAL
*
* WARN: Below this point the word "context" should be avoided (use channel)
* Disabled should always be referenced as "disabled".
*******************************************************************************/
/**
* Sends a standard message to user.
*
* Drush see it.
*/
function elysia_cron_message($message, $vars = array()) {
global $_elysia_cron_drush;
if (empty($_elysia_cron_drush)) {
backdrop_set_message(t($message, $vars));
}
else {
drush_log(strip_tags(dt($message, $vars)), 'ok');
}
}
/**
* Send an error message to user (and log also an error).
*
* Drush see it (even if $skip_user_message)
*/
function elysia_cron_error($message, $vars = array(), $skip_user_message = FALSE) {
global $_elysia_cron_drush;
if (empty($_elysia_cron_drush) && !$skip_user_message) {
backdrop_set_message(t($message, $vars), 'error');
}
/* @todo remove following code if not necessary.
if (!empty($_elysia_cron_drush)) {
drush_log(strip_tags(dt($message, $vars)), "error");
}*/
watchdog('cron', $message, $vars, WATCHDOG_ERROR);
}
/**
* Log a debug in watchdog (do not print an user message).
*
* Drush see it in verbose mode.
*/
function elysia_cron_debug($message, $vars = array(), $type = WATCHDOG_NOTICE) {
global $_elysia_cron_drush;
if ($type < WATCHDOG_NOTICE || config_get('elysia_cron.settings', 'debug_messages')) {
watchdog('cron', $message, $vars, $type);
}
if (!empty($_elysia_cron_drush) && $_elysia_cron_drush >= 2 && ($type >= WATCHDOG_NOTICE || drush_get_option("verbose", FALSE))) {
if ($type >= WATCHDOG_NOTICE) {
drush_print(strip_tags(dt($message, $vars)));
}
else {
drush_log(strip_tags(dt($message, $vars)), $type == WATCHDOG_ERROR ? "error" : (($type == WATCHDOG_ERROR ? "warning" : "notice")));
}
}
}
/**
* Log a warning (do not print an user message).
*
* Drush see it in verbose mode.
*/
function elysia_cron_warning($message, $vars = array()) {
elysia_cron_debug($message, $vars, WATCHDOG_WARNING);
}
function elysia_cron_decode_script($text, $apply = TRUE) {
global $_elysia_cron_settings;
$lines = explode(PHP_EOL, $text);
$lastcomment = '';
$errors = array();
foreach ($lines as $line) {
$line = trim($line);
if (!empty($line)) {
if ($line[0] == '#') {
$lastcomment = trim(substr($line, 1));
}
elseif (preg_match('/^(-[ ]*|)([0-9*,\/-]+[ ]+[0-9*,\/-]+[ ]+[0-9*,\/-]+[ ]+[0-9*,\/-]+[ ]+[0-9*,\/-]+)[ ]+((?:ctx|ch):([a-zA-Z0-9_-]+)[ ]+|)([^(:]+)(\(.*\);|)$/', $line, $r)) {
$c = array(
'disabled' => !empty($r[1]),
'rule' => $r[2],
'description' => $lastcomment,
'channel' => $r[4] ? $r[4] : 'default',
);
$lastcomment = '';
if (empty($r[6])) {
if (!isset($_elysia_cron_settings[$r[5]])) {
// Referring a module function that not exists.
$errors[] = $line;
continue;
}
$name = $r[5];
}
else {
// Custom expression, generate a unique name.
$postfix = '';
while (isset($_elysia_cron_settings[$r[5] . $postfix])) {
$postfix = ($postfix ? $postfix : 0) + 1;
}
$name = $r[5] . $postfix;
$c['expression'] = $r[5] . $r[6];
}
if ($apply) {
$_elysia_cron_settings[$name] = isset($_elysia_cron_settings[$name]) ? array_merge($_elysia_cron_settings[$name], $c) : $c;
}
}
else {
$errors[] = $line;
}
}
else {
$lastcomment = '';
}
}
return count($errors) ? $errors : FALSE;
}
/**
* Fetch information about cron jobs from modules.
*
* @return array
* Array with jobs information.
*/
function elysia_cron_module_jobs() {
static $jobs;
if (!isset($jobs)) {
$jobs = array();
foreach (module_implements('cron') as $module) {
if ($module != 'elysia_cron') {
$jobs[$module . '_cron'] = array(
'module' => $module,
'callback' => $module . '_cron',
'arguments' => array(),
);
}
}
foreach (module_implements('cronapi') as $module) {
$function = $module . '_cronapi';
if (function_exists($function)) {
$job_list = $function('list');
if (is_array($job_list)) {
foreach ($job_list as $job => $data) {
if (is_array($data)) {
$jobs[$job] = $data;
}
else {
// Compatibility with v1.x settings.
$jobs[$job] = array(
'description' => $data,
'rule' => ($rule = $function('rule', $job)) ? $rule : FALSE,
'weight' => ($weight = $function('weight', $job)) ? $weight : 0,
);
}
$jobs[$job] = $jobs[$job] + array(
'module' => $module,
'callback' => $job,
'arguments' => array(),
);
}
}
}
}
if (function_exists('backdrop_alter')) {
backdrop_alter('cron', $jobs);
}
}
return $jobs;
}
function elysia_cron_initialize($skipscript = FALSE) {
global $_elysia_cron_settings, $_elysia_cron_settings_by_channel;
if (empty($_elysia_cron_settings)) {
$_elysia_cron_settings = array();
$_elysia_cron_settings_by_channel = array();
foreach (elysia_cron_module_jobs() as $job => $jobpars) {
$channel = elysia_cron_get_job_channel($job, 'default');
$defrule = !empty($jobpars['rule']) ? $jobpars['rule'] : elysia_cron_get_channel_rule($channel);
if (!$defrule) {
$defrule = config_get('elysia_cron.settings', 'default_rule');
}
$defweight = !empty($jobpars['weight']) ? $jobpars['weight'] : 0;
if (!is_numeric($defweight)) {
$defweight = 0;
}
$_elysia_cron_settings[$job] = array(
'key' => $job,
'channel' => $channel,
'rule' => elysia_cron_get_job_rule($job, $defrule),
'default_rule' => $defrule,
'weight' => elysia_cron_get_job_weight($job, $defweight),
'default_weight' => $defweight,
'disabled' => elysia_cron_is_job_disabled($job),
'running' => elysia_cron_is_job_running($job),
) + $jobpars;
}