dolibarr 21.0.0-alpha
modCron.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2012 Nicolas Villa aka Boyquotes http://informetic.fr
3 * Copyright (C) 2013 Florian Henry <florian.henry@open-concept.pro>
4 * Copyright (C) 2022 Anthony Berton <anthony.berton@bb2a.fr>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
27include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
28
29
34{
40 public function __construct($db)
41 {
42 global $langs, $conf;
43
44 $this->db = $db;
45 $this->numero = 2300;
46
47 // Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
48 // It is used to group modules in module setup page
49 $this->family = "base";
50 // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
51 $this->name = preg_replace('/^mod/i', '', get_class($this));
52 $this->description = "Enable the Dolibarr cron service";
53 // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
54 $this->version = 'dolibarr';
55 // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
56 $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
57 // Name of image file used for this module.
58 $this->picto = 'cron';
59
60 // Data directories to create when module is enabled
61 $this->dirs = array();
62
63 // Config pages
64 //-------------
65 $this->config_page_url = array("cron.php@cron");
66
67 // Dependencies
68 //-------------
69 $this->hidden = getDolGlobalInt('MODULE_CRON_DISABLED'); // A condition to disable module
70 $this->depends = array(); // List of modules id that must be enabled if this module is enabled
71 $this->requiredby = array(); // List of modules id to disable if this one is disabled
72 $this->conflictwith = array(); // List of modules id this module is in conflict with
73 $this->langfiles = array("cron");
74
75 // Constants
76 //-----------
77 $this->const = array(
78 0=>array(
79 'CRON_KEY',
80 'chaine',
81 '',
82 'CRON KEY',
83 0,
84 'main',
85 0
86 ),);
87
88 // New pages on tabs
89 // -----------------
90 $this->tabs = array();
91
92 // Boxes
93 //------
94 $this->boxes = array(
95 0 => array('file' => 'box_scheduled_jobs.php', 'enabledbydefaulton' => 'Home')
96 );
97
98 // Cronjobs
99 $this->cronjobs = array(
100 0=>array('entity'=>0, 'label'=>'PurgeDeleteTemporaryFilesShort', 'jobtype'=>'method', 'class'=>'core/class/utils.class.php', 'objectname'=>'Utils', 'method'=>'purgeFiles', 'parameters'=>'tempfilesold+logfiles', 'comment'=>'PurgeDeleteTemporaryFiles', 'frequency'=>2, 'unitfrequency'=>3600 * 24 * 7, 'priority'=>50, 'status'=>1, 'test'=>true),
101 1=>array('entity'=>0, 'label'=>'MakeLocalDatabaseDumpShort', 'jobtype'=>'method', 'class'=>'core/class/utils.class.php', 'objectname'=>'Utils', 'method'=>'dumpDatabase', 'parameters'=>'none,auto,1,auto,10,0,0', 'comment'=>'MakeLocalDatabaseDump', 'frequency'=>1, 'unitfrequency'=>3600 * 24 * 7, 'priority'=>90, 'status'=>0, 'test'=>'in_array($conf->db->type, array(\'mysql\', \'mysqli\'))'),
102 2=>array('entity'=>0, 'label'=>'MakeSendLocalDatabaseDumpShort', 'jobtype'=>'method', 'class'=>'core/class/utils.class.php', 'objectname'=>'Utils', 'method'=>'sendBackup', 'parameters'=>',,,,,sql', 'comment'=>'MakeSendLocalDatabaseDump', 'frequency'=>1, 'unitfrequency'=>604800, 'priority'=>91, 'status'=>0, 'test'=>'!empty($conf->global->MAIN_ALLOW_BACKUP_BY_EMAIL) && in_array($conf->db->type, array(\'mysql\', \'mysqli\'))'),
103 3=>array('entity'=>0, 'label'=>'CleanUnfinishedCronjobShort', 'jobtype'=>'method', 'class'=>'core/class/utils.class.php', 'objectname'=>'Utils', 'method'=>'cleanUnfinishedCronjob', 'parameters'=>'', 'comment'=>'CleanUnfinishedCronjob', 'frequency'=>5, 'unitfrequency'=>60, 'priority'=>10, 'status'=>0, 'test'=>'getDolGlobalInt("MAIN_FEATURES_LEVEL") >= 2'),
104 // 1=>array('entity'=>0, 'label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24)
105 );
106
107 // Permissions
108 $this->rights = array(); // Permission array used by this module
109 $this->rights_class = 'cron';
110 $r = 0;
111
112 $this->rights[$r][0] = 23001;
113 $this->rights[$r][1] = 'Read cron jobs';
114 $this->rights[$r][3] = 0;
115 $this->rights[$r][4] = 'read';
116 $r++;
117
118 $this->rights[$r][0] = 23002;
119 $this->rights[$r][1] = 'Create cron Jobs';
120 $this->rights[$r][3] = 0;
121 $this->rights[$r][4] = 'create';
122 $r++;
123
124 $this->rights[$r][0] = 23003;
125 $this->rights[$r][1] = 'Delete cron Jobs';
126 $this->rights[$r][3] = 0;
127 $this->rights[$r][4] = 'delete';
128 $r++;
129
130 $this->rights[$r][0] = 23004;
131 $this->rights[$r][1] = 'Execute cron Jobs';
132 $this->rights[$r][3] = 0;
133 $this->rights[$r][4] = 'execute';
134 $r++;
135
136 // Main menu entries
137 $r = 0;
138 $this->menu[$r] = array('fk_menu'=>'fk_mainmenu=home,fk_leftmenu=admintools', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
139 'type'=>'left', // This is a Left menu entry
140 'titre'=>'CronList',
141 'url'=>'/cron/list.php?leftmenu=admintools',
142 'langs'=>'cron', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
143 'position'=>500,
144 'enabled'=>'$conf->cron->enabled && preg_match(\'/^(admintools|all)/\', $leftmenu)', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
145 'perms'=>'$user->rights->cron->read', // Use 'perms'=>'$user->hasRight("mymodule","level1","level2")' if you want your menu with a permission rules
146 'target'=>'',
147 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
148 $r++;
149 }
150}
Class DolibarrModules.
Class to describe a Cron module.
__construct($db)
Constructor.
print $script_file $mode $langs defaultlang(is_numeric($duration_value) ? " delay=". $duration_value :"").(is_numeric($duration_value2) ? " after cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:140