forked from Wavyzz/dolibarr
182 lines
6.9 KiB
PHP
182 lines
6.9 KiB
PHP
<?php
|
|
/* Copyright (C) 2012 Nicolas Villa aka Boyquotes http://informetic.fr
|
|
* Copyright (C) 2013 Florian Henry <florian.henry@open-concept.pro>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/**
|
|
* \defgroup cron Module cron
|
|
* \brief cron module descriptor.
|
|
* \file cron/core/modules/modCron.class.php
|
|
* \ingroup cron
|
|
* \brief Description and activation file for module Jobs
|
|
*/
|
|
include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
|
|
|
|
/**
|
|
* Class to describe a Cron module
|
|
*/
|
|
class modCron extends DolibarrModules
|
|
{
|
|
|
|
/**
|
|
* Constructor. Define names, constants, directories, boxes, permissions
|
|
*
|
|
* @param DoliDB $db Database handler
|
|
*/
|
|
function __construct($db)
|
|
{
|
|
$this->db = $db;
|
|
$this->numero = 2300;
|
|
|
|
// Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
|
|
// It is used to group modules in module setup page
|
|
$this->family = "base";
|
|
// Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
|
|
$this->name = preg_replace('/^mod/i','',get_class($this));
|
|
$this->description = "Enable the Dolibarr cron service";
|
|
$this->version = 'experimental'; // 'experimental' or 'dolibarr' or version
|
|
// Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
|
|
$this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
|
|
// Where to store the module in setup page (0=common,1=interface,2=others,3=very specific)
|
|
$this->special = 2;
|
|
// Name of image file used for this module.
|
|
$this->picto='technic';
|
|
|
|
// Data directories to create when module is enabled
|
|
$this->dirs = array();
|
|
|
|
// Config pages
|
|
//-------------
|
|
$this->config_page_url = array("cron.php@cron");
|
|
|
|
// Dependancies
|
|
//-------------
|
|
$this->depends = array();
|
|
$this->requiredby = array();
|
|
$this->langfiles = array("cron@cron");
|
|
|
|
// Constantes
|
|
//-----------
|
|
$this->const = array(
|
|
0=>array(
|
|
'CRON_KEY',
|
|
'chaine',
|
|
'',
|
|
'CRON KEY',
|
|
0,
|
|
'main',
|
|
0
|
|
),);
|
|
|
|
// New pages on tabs
|
|
// -----------------
|
|
$this->tabs = array();
|
|
|
|
// Boxes
|
|
//------
|
|
$this->boxes = array();
|
|
|
|
// Permissions
|
|
$this->rights = array(); // Permission array used by this module
|
|
$this->rights_class = 'cron';
|
|
$r=0;
|
|
|
|
$this->rights[$r][0] = 23001;
|
|
$this->rights[$r][1] = 'Read cron jobs';
|
|
$this->rights[$r][3] = 1;
|
|
$this->rights[$r][4] = 'read';
|
|
$r++;
|
|
|
|
$this->rights[$r][0] = 23002;
|
|
$this->rights[$r][1] = 'Create cron Jobs';
|
|
$this->rights[$r][3] = 0;
|
|
$this->rights[$r][4] = 'create';
|
|
$r++;
|
|
|
|
$this->rights[$r][0] = 23003;
|
|
$this->rights[$r][1] = 'Delete cron Jobs';
|
|
$this->rights[$r][3] = 0;
|
|
$this->rights[$r][4] = 'delete';
|
|
$r++;
|
|
|
|
$this->rights[$r][0] = 23004;
|
|
$this->rights[$r][1] = 'Execute cron Jobs';
|
|
$this->rights[$r][3] = 0;
|
|
$this->rights[$r][4] = 'execute';
|
|
$r++;
|
|
|
|
// Main menu entries
|
|
$r=0;
|
|
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=home,fk_leftmenu=modulesadmintools', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
|
|
'type'=>'left', // This is a Left menu entry
|
|
'titre'=>'CronListActive',
|
|
'url'=>'/cron/list.php?status=1',
|
|
'langs'=>'cron', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
|
|
'position'=>200,
|
|
'enabled'=>'$leftmenu==\'modulesadmintools\'', // 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.
|
|
'perms'=>'$user->rights->cron->read', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
|
|
'target'=>'',
|
|
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
|
|
$r++;
|
|
|
|
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=home,fk_leftmenu=modulesadmintools', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
|
|
'type'=>'left', // This is a Left menu entry
|
|
'titre'=>'CronListInactive',
|
|
'url'=>'/cron/list.php?status=0',
|
|
'langs'=>'cron', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
|
|
'position'=>201,
|
|
'enabled'=>'$leftmenu==\'modulesadmintools\'', // 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.
|
|
'perms'=>'$user->rights->cron->read', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
|
|
'target'=>'',
|
|
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
|
|
$r++;
|
|
}
|
|
|
|
|
|
/**
|
|
* Function called when module is enabled.
|
|
* The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
|
|
* It also creates data directories
|
|
*
|
|
* @param string $options Options when enabling module ('', 'noboxes')
|
|
* @return int 1 if OK, 0 if KO
|
|
*/
|
|
function init($options='')
|
|
{
|
|
// Prevent pb of modules not correctly disabled
|
|
//$this->remove($options);
|
|
|
|
return $this->_init($sql,$options);
|
|
}
|
|
|
|
/**
|
|
* Function called when module is disabled.
|
|
* Remove from database constants, boxes and permissions from Dolibarr database.
|
|
* Data directories are not deleted
|
|
*
|
|
* @param string $options Options when enabling module ('', 'noboxes')
|
|
* @return int 1 if OK, 0 if KO
|
|
*/
|
|
function remove($options='')
|
|
{
|
|
$sql = array();
|
|
|
|
return $this->_remove($sql,$options);
|
|
}
|
|
|
|
}
|
|
?>
|