.
* ---------------------------------------------------------------------
*/
if (!defined('GLPI_ROOT')) {
die("Sorry. You can't access this file directly");
}
/**
* Rule Class store all information about a GLPI rule :
* - description
* - criterias
* - actions
**/
class Rule extends CommonDBTM {
use Glpi\Features\Clonable;
public $dohistory = true;
// Specific ones
///Actions affected to this rule
public $actions = [];
///Criterias affected to this rule
public $criterias = [];
/// Rules can be sorted ?
public $can_sort = false;
/// field used to order rules
public $orderby = 'ranking';
/// restrict matching to self::AND_MATCHING or self::OR_MATCHING : specify value to activate
public $restrict_matching = false;
protected $rules_id_field = 'rules_id';
protected $ruleactionclass = 'RuleAction';
protected $rulecriteriaclass = 'RuleCriteria';
public $specific_parameters = false;
public $regex_results = [];
public $criterias_results = [];
static $rightname = 'config';
const RULE_NOT_IN_CACHE = -1;
const RULE_WILDCARD = '*';
//Generic rules engine
const PATTERN_IS = 0;
const PATTERN_IS_NOT = 1;
const PATTERN_CONTAIN = 2;
const PATTERN_NOT_CONTAIN = 3;
const PATTERN_BEGIN = 4;
const PATTERN_END = 5;
const REGEX_MATCH = 6;
const REGEX_NOT_MATCH = 7;
const PATTERN_EXISTS = 8;
const PATTERN_DOES_NOT_EXISTS = 9;
const PATTERN_FIND = 10; // Global criteria
const PATTERN_UNDER = 11;
const PATTERN_NOT_UNDER = 12;
const PATTERN_IS_EMPTY = 30; // Global criteria
const AND_MATCHING = "AND";
const OR_MATCHING = "OR";
public function getCloneRelations() :array {
return [
RuleAction::class,
RuleCriteria::class
];
}
static function getTable($classname = null) {
return parent::getTable(__CLASS__);
}
static function getTypeName($nb = 0) {
return _n('Rule', 'Rules', $nb);
}
/**
* Get correct Rule object for specific rule
*
* @since 0.84
*
* @param $rules_id ID of the rule
**/
static function getRuleObjectByID($rules_id) {
$rule = new self();
if ($rule->getFromDB($rules_id)) {
$realrule = new $rule->fields['sub_type']();
return $realrule;
}
return null;
}
/**
* Get condition array for rule. If empty array no condition used
* maybe overridden to define conditions using binary combination :
* example array(1 => Condition1,
* 2 => Condition2,
* 3 => Condition1&Condition2)
*
* @since 0.85
*
* @return array of conditions
**/
static function getConditionsArray() {
return [];
}
/**
* Is this rule use condition
*
**/
function useConditions() {
return (count($this->getConditionsArray()) > 0);
}
/**
* Display a dropdown with all the rule conditions
*
* @since 0.85
*
* @param $options array of parameters
**/
static function dropdownConditions($options = []) {
$p['name'] = 'condition';
$p['value'] = 0;
$p['display'] = true;
$p['on_change'] = '';
if (is_array($options) && count($options)) {
foreach ($options as $key => $val) {
$p[$key] = $val;
}
}
$elements = static::getConditionsArray();
if (count($elements)) {
return Dropdown::showFromArray($p['name'], $elements, $p);
}
return false;
}
/**
* Get rule condition type Name
*
* @param $value condition ID
**/
static function getConditionName($value) {
$cond = static::getConditionsArray();
if (isset($cond[$value])) {
return $cond[$value];
}
return NOT_AVAILABLE;
}
/**
* @see CommonGLPI::getMenuContent()
*
* @since 0.85
**/
static function getMenuContent() {
global $CFG_GLPI;
$menu = [];
if (Session::haveRight("rule_ldap", READ)
|| Session::haveRight("rule_import", READ)
|| Session::haveRight("rule_ticket", READ)
|| Session::haveRight("rule_softwarecategories", READ)
|| Session::haveRight("rule_mailcollector", READ)) {
$menu['rule']['title'] = static::getTypeName(Session::getPluralNumber());
$menu['rule']['page'] = static::getSearchURL(false);
$menu['rule']['icon'] = static::getIcon();
foreach ($CFG_GLPI["rulecollections_types"] as $rulecollectionclass) {
$rulecollection = new $rulecollectionclass();
if ($rulecollection->canList()) {
$ruleclassname = $rulecollection->getRuleClassName();
$menu['rule']['options'][$rulecollection->menu_option]['title']
= $rulecollection->getRuleClass()->getTitle();
$menu['rule']['options'][$rulecollection->menu_option]['page']
= $ruleclassname::getSearchURL(false);
$menu['rule']['options'][$rulecollection->menu_option]['links']['search']
= $ruleclassname::getSearchURL(false);
if ($rulecollection->canCreate()) {
$menu['rule']['options'][$rulecollection->menu_option]['links']['add']
= $ruleclassname::getFormURL(false);
}
}
}
}
if (Transfer::canView()
&& Session::isMultiEntitiesMode()) {
$menu['rule']['title'] = static::getTypeName(Session::getPluralNumber());
$menu['rule']['page'] = static::getSearchURL(false);
$menu['rule']['icon'] = static::getIcon();
$menu['rule']['options']['transfer']['title'] = __('Transfer');
$menu['rule']['options']['transfer']['page'] = "/front/transfer.php";
$menu['rule']['options']['transfer']['links']['search'] = "/front/transfer.php";
if (Session::haveRightsOr("transfer", [CREATE, UPDATE])) {
$menu['rule']['options']['transfer']['links']['summary']
= "/front/transfer.action.php";
$menu['rule']['options']['transfer']['links']['add'] = Transfer::getFormURL(false);
}
}
if (Session::haveRight("rule_dictionnary_dropdown", READ)
|| Session::haveRight("rule_dictionnary_software", READ)
|| Session::haveRight("rule_dictionnary_printer", READ)) {
$menu['dictionnary']['title'] = _n('Dictionary', 'Dictionaries', Session::getPluralNumber());
$menu['dictionnary']['shortcut'] = '';
$menu['dictionnary']['page'] = '/front/dictionnary.php';
$menu['dictionnary']['icon'] = static::getIcon();
$menu['dictionnary']['options']['manufacturers']['title']
= _n('Manufacturer', 'Manufacturers', Session::getPluralNumber());
$menu['dictionnary']['options']['manufacturers']['page']
= '/front/ruledictionnarymanufacturer.php';
$menu['dictionnary']['options']['manufacturers']['links']['search']
= '/front/ruledictionnarymanufacturer.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['manufacturers']['links']['add']
= '/front/ruledictionnarymanufacturer.form.php';
}
$menu['dictionnary']['options']['software']['title']
= _n('Software', 'Software', Session::getPluralNumber());
$menu['dictionnary']['options']['software']['page']
= '/front/ruledictionnarysoftware.php';
$menu['dictionnary']['options']['software']['links']['search']
= '/front/ruledictionnarysoftware.php';
if (RuleDictionnarySoftware::canCreate()) {
$menu['dictionnary']['options']['software']['links']['add']
= '/front/ruledictionnarysoftware.form.php';
}
$menu['dictionnary']['options']['model.computer']['title']
= _n('Computer model', 'Computer models', Session::getPluralNumber());
$menu['dictionnary']['options']['model.computer']['page']
= '/front/ruledictionnarycomputermodel.php';
$menu['dictionnary']['options']['model.computer']['links']['search']
= '/front/ruledictionnarycomputermodel.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['model.computer']['links']['add']
= '/front/ruledictionnarycomputermodel.form.php';
}
$menu['dictionnary']['options']['model.monitor']['title']
= _n('Monitor model', 'Monitor models', Session::getPluralNumber());
$menu['dictionnary']['options']['model.monitor']['page']
= '/front/ruledictionnarymonitormodel.php';
$menu['dictionnary']['options']['model.monitor']['links']['search']
= '/front/ruledictionnarymonitormodel.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['model.monitor']['links']['add']
= '/front/ruledictionnarymonitormodel.form.php';
}
$menu['dictionnary']['options']['model.printer']['title']
= _n('Printer model', 'Printer models', Session::getPluralNumber());
$menu['dictionnary']['options']['model.printer']['page']
= '/front/ruledictionnaryprintermodel.php';
$menu['dictionnary']['options']['model.printer']['links']['search']
= '/front/ruledictionnaryprintermodel.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['model.printer']['links']['add']
= '/front/ruledictionnaryprintermodel.form.php';
}
$menu['dictionnary']['options']['model.peripheral']['title']
= _n('Peripheral model', 'Peripheral models', Session::getPluralNumber());
$menu['dictionnary']['options']['model.peripheral']['page']
= '/front/ruledictionnaryperipheralmodel.php';
$menu['dictionnary']['options']['model.peripheral']['links']['search']
= '/front/ruledictionnaryperipheralmodel.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['model.peripheral']['links']['add']
= '/front/ruledictionnaryperipheralmodel.form.php';
}
$menu['dictionnary']['options']['model.networking']['title']
= _n('Networking equipment model', 'Networking equipment models', Session::getPluralNumber());
$menu['dictionnary']['options']['model.networking']['page']
= '/front/ruledictionnarynetworkequipmentmodel.php';
$menu['dictionnary']['options']['model.networking']['links']['search']
= '/front/ruledictionnarynetworkequipmentmodel.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['model.networking']['links']['add']
= '/front/ruledictionnarynetworkequipmentmodel.form.php';
}
$menu['dictionnary']['options']['model.phone']['title']
= _n('Phone model', 'Phone models', Session::getPluralNumber());
$menu['dictionnary']['options']['model.phone']['page']
= '/front/ruledictionnaryphonemodel.php';
$menu['dictionnary']['options']['model.phone']['links']['search']
= '/front/ruledictionnaryphonemodel.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['model.phone']['links']['add']
= '/front/ruledictionnaryphonemodel.form.php';
}
$menu['dictionnary']['options']['type.computer']['title']
= _n('Computer type', 'Computer types', Session::getPluralNumber());
$menu['dictionnary']['options']['type.computer']['page']
= '/front/ruledictionnarycomputertype.php';
$menu['dictionnary']['options']['type.computer']['links']['search']
= '/front/ruledictionnarycomputertype.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['type.computer']['links']['add']
= '/front/ruledictionnarycomputertype.form.php';
}
$menu['dictionnary']['options']['type.monitor']['title']
= _n('Monitor type', 'Monitors types', Session::getPluralNumber());
$menu['dictionnary']['options']['type.monitor']['page']
= '/front/ruledictionnarymonitortype.php';
$menu['dictionnary']['options']['type.monitor']['links']['search']
= '/front/ruledictionnarymonitortype.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['type.monitor']['links']['add']
= '/front/ruledictionnarymonitortype.form.php';
}
$menu['dictionnary']['options']['type.printer']['title']
= _n('Printer type', 'Printer types', Session::getPluralNumber());
$menu['dictionnary']['options']['type.printer']['page']
= '/front/ruledictionnaryprintertype.php';
$menu['dictionnary']['options']['type.printer']['links']['search']
= '/front/ruledictionnaryprintertype.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['type.printer']['links']['add']
= '/front/ruledictionnaryprintertype.form.php';
}
$menu['dictionnary']['options']['type.peripheral']['title']
= _n('Peripheral type', 'Peripheral types', Session::getPluralNumber());
$menu['dictionnary']['options']['type.peripheral']['page']
= '/front/ruledictionnaryperipheraltype.php';
$menu['dictionnary']['options']['type.peripheral']['links']['search']
= '/front/ruledictionnaryperipheraltype.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['type.peripheral']['links']['add']
= '/front/ruledictionnaryperipheraltype.form.php';
}
$menu['dictionnary']['options']['type.networking']['title']
= _n('Networking equipment type', 'Networking equipment types', Session::getPluralNumber());
$menu['dictionnary']['options']['type.networking']['page']
= '/front/ruledictionnarynetworkequipmenttype.php';
$menu['dictionnary']['options']['type.networking']['links']['search']
= '/front/ruledictionnarynetworkequipmenttype.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['type.networking']['links']['add']
= '/front/ruledictionnarynetworkequipmenttype.form.php';
}
$menu['dictionnary']['options']['type.phone']['title']
= _n('Phone type', 'Phone types', Session::getPluralNumber());
$menu['dictionnary']['options']['type.phone']['page']
= '/front/ruledictionnaryphonetype.php';
$menu['dictionnary']['options']['type.phone']['links']['search']
= '/front/ruledictionnaryphonetype.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['type.phone']['links']['add']
= '/front/ruledictionnaryphonetype.form.php';
}
$menu['dictionnary']['options']['os']['title']
= OperatingSystem::getTypeName(1);
$menu['dictionnary']['options']['os']['page']
= '/front/ruledictionnaryoperatingsystem.php';
$menu['dictionnary']['options']['os']['links']['search']
= '/front/ruledictionnaryoperatingsystem.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['os']['links']['add']
= '/front/ruledictionnaryoperatingsystem.form.php';
}
$menu['dictionnary']['options']['os_sp']['title']
= OperatingSystemServicePack::getTypeName(1);
$menu['dictionnary']['options']['os_sp']['page']
= '/front/ruledictionnaryoperatingsystemservicepack.php';
$menu['dictionnary']['options']['os_sp']['links']['search']
= '/front/ruledictionnaryoperatingsystemservicepack.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['os_sp']['links']['add']
= '/front/ruledictionnaryoperatingsystemservicepack.form.php';
}
$menu['dictionnary']['options']['os_version']['title']
= OperatingSystemVersion::getTypeName(1);
$menu['dictionnary']['options']['os_version']['page']
= '/front/ruledictionnaryoperatingsystemversion.php';
$menu['dictionnary']['options']['os_version']['links']['search']
= '/front/ruledictionnaryoperatingsystemversion.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['os_version']['links']['add']
= '/front/ruledictionnaryoperatingsystemversion.form.php';
}
$menu['dictionnary']['options']['os_arch']['title']
= OperatingSystemArchitecture::getTypeName(1);
$menu['dictionnary']['options']['os_arch']['page']
= '/front/ruledictionnaryoperatingsystemarchitecture.php';
$menu['dictionnary']['options']['os_arch']['links']['search']
= '/front/ruledictionnaryoperatingsystemarchitecture.php';
if (RuleDictionnaryDropdown::canCreate()) {
$menu['dictionnary']['options']['os_arch']['links']['add']
= '/front/ruledictionnaryoperatingsystemarchitecture.form.php';
}
$menu['dictionnary']['options']['printer']['title']
= _n('Printer', 'Printers', Session::getPluralNumber());
$menu['dictionnary']['options']['printer']['page']
= '/front/ruledictionnaryprinter.php';
$menu['dictionnary']['options']['printer']['links']['search']
= '/front/ruledictionnaryprinter.php';
if (RuleDictionnaryPrinter::canCreate()) {
$menu['dictionnary']['options']['printer']['links']['add']
= '/front/ruledictionnaryprinter.form.php';
}
}
if (count($menu)) {
$menu['is_multi_entries'] = true;
return $menu;
}
return false;
}
/**
* @since versin 0.84
**/
function getRuleActionClass () {
return $this->ruleactionclass;
}
/**
* @since versin 0.84
**/
function getRuleCriteriaClass () {
return $this->rulecriteriaclass;
}
/**
* @since versin 0.84
**/
function getRuleIdField () {
return $this->rules_id_field;
}
function isEntityAssign() {
return false;
}
function post_getEmpty() {
$this->fields['is_active'] = 0;
}
/**
* Get title used in rule
*
* @return Title of the rule
**/
function getTitle() {
return __('Rules management');
}
/**
* @since 0.84
*
* @return string
**/
function getCollectionClassName() {
return $this->getType().'Collection';
}
/**
* @see CommonDBTM::getSpecificMassiveActions()
**/
function getSpecificMassiveActions($checkitem = null) {
$isadmin = static::canUpdate();
$actions = parent::getSpecificMassiveActions($checkitem);
$collectiontype = $this->getCollectionClassName();
if ($collection = getItemForItemtype($collectiontype)) {
if ($isadmin
&& ($collection->orderby == "ranking")) {
$actions[__CLASS__.MassiveAction::CLASS_ACTION_SEPARATOR.'move_rule']
= "";
echo "".__('Name')." ";
echo "";
Html::autocompletionTextField($this, "name");
echo " ";
echo "".__('Description')." ";
echo "";
Html::autocompletionTextField($this, "description");
echo " \n";
echo "";
echo "".__('Logical operator')." ";
echo "";
$this->dropdownRulesMatch(['value' => $this->fields["match"]]);
echo " ";
echo "".__('Active')." ";
echo "";
Dropdown::showYesNo("is_active", $this->fields["is_active"]);
echo " \n";
if ($this->useConditions()) {
echo "";
echo "".__('Use rule for')." ";
echo "";
$this->dropdownConditions(['value' => $this->fields["condition"]]);
echo " ";
echo "";
echo " \n";
}
echo "";
echo "".__('Comments')." ";
echo "";
echo "";
if (!$this->isNewID($ID)) {
if ($this->fields["date_mod"]) {
echo " \n";
if ($canedit) {
if ($ID > 0) {
if ($plugin = isPluginItemType($this->getType())) {
$url = $CFG_GLPI["root_doc"]."/plugins/".strtolower($plugin['plugin']);
} else {
$url = $CFG_GLPI["root_doc"];
}
echo "";
echo "".
_x('button', 'Test')." ";
Ajax::createIframeModalWindow('ruletest'.$rand,
$url."/front/rule.test.php?". "sub_type=".$this->getType().
"&rules_id=".$this->fields["id"],
['title' => _x('button', 'Test')]);
echo " ";
echo "".
__('It is possible to affect the result of a regular expression using the string #0').
"
\n";
}
if ($canedit
&& (($this->maxActionsCount() == 0)
|| (sizeof($this->actions) < $this->maxActionsCount()))) {
echo "\n";
echo "\n";
}
$nb = count($this->actions);
echo "";
if ($canedit && $nb) {
Html::openMassiveActionsForm('mass'.$this->ruleactionclass.$rand);
$massiveactionparams = ['num_displayed' => min($_SESSION['glpilist_limit'], $nb),
'check_itemtype' => get_class($this),
'check_items_id' => $rules_id,
'container' => 'mass'.$this->ruleactionclass.$rand,
'extraparams' => ['rule_class_name'
=> $this->getType()]];
Html::showMassiveActions($massiveactionparams);
}
echo "
";
echo "";
echo "" . _n('Action', 'Actions', Session::getPluralNumber()) . " ";
$header_begin = "";
$header_top = '';
$header_bottom = '';
$header_end = '';
if ($canedit && $nb) {
$header_top .= "";
$header_top .= Html::getCheckAllAsCheckbox('mass'.$this->ruleactionclass.$rand)." ";
$header_bottom .= "";
$header_bottom .= Html::getCheckAllAsCheckbox('mass'.$this->ruleactionclass.$rand)." ";
}
$header_end .= ""._n('Field', 'Fields', Session::getPluralNumber())." ";
$header_end .= "".__('Action type')." ";
$header_end .= "".__('Value')." ";
$header_end .= " \n";
echo $header_begin.$header_top.$header_end;
foreach ($this->actions as $action) {
$this->showMinimalActionForm($action->fields, $canedit, $rand);
}
if ($nb) {
echo $header_begin.$header_bottom.$header_end;
}
echo "
\n";
if ($canedit && $nb) {
$massiveactionparams['ontop'] = false;
Html::showMassiveActions($massiveactionparams);
Html::closeForm();
}
echo "
\n";
echo "\n";
echo "\n";
}
echo "";
$nb = sizeof($this->criterias);
if ($canedit && $nb) {
Html::openMassiveActionsForm('mass'.$this->rulecriteriaclass.$rand);
$massiveactionparams = ['num_displayed' => min($_SESSION['glpilist_limit'], $nb),
'check_itemtype' => get_class($this),
'check_items_id' => $rules_id,
'container' => 'mass'.$this->rulecriteriaclass.$rand,
'extraparams' => ['rule_class_name'
=> $this->getType()]];
Html::showMassiveActions($massiveactionparams);
}
echo "
";
echo "".
"". _n('Criterion', 'Criteria', Session::getPluralNumber())." ".
" \n";
$header_begin = "";
$header_top = '';
$header_bottom = '';
$header_end = '';
if ($canedit && $nb) {
$header_top .= "";
$header_top .= Html::getCheckAllAsCheckbox('mass'.$this->rulecriteriaclass.$rand);
$header_top .= " ";
$header_bottom .= "";
$header_bottom .= Html::getCheckAllAsCheckbox('mass'.$this->rulecriteriaclass.$rand);
$header_bottom .= " ";
}
$header_end .= ""._n('Criterion', 'Criteria', 1)." \n";
$header_end .= "".__('Condition')." \n";
$header_end .= "".__('Reason')." \n";
$header_end .= " \n";
echo $header_begin.$header_top.$header_end;
foreach ($this->criterias as $criterion) {
$this->showMinimalCriteriaForm($criterion->fields, $canedit, $rand);
}
if ($nb) {
echo $header_begin.$header_bottom.$header_end;
}
echo "
\n";
if ($canedit && $nb) {
$massiveactionparams['ontop'] = false;
Html::showMassiveActions($massiveactionparams);
Html::closeForm();
}
echo "
";
if ($canedit) {
echo "";
Html::showMassiveActionCheckBox($this->getType(), $this->fields["id"]);
echo " ";
} else {
echo " ";
}
$link = $this->getLink();
if (!empty($this->fields["comment"])) {
$link = sprintf(__('%1$s %2$s'), $link,
Html::showToolTip($this->fields["comment"], ['display' => false]));
}
echo "".$link." ";
echo "".$this->fields["description"]." ";
if ($this->useConditions()) {
echo "".$this->getConditionName($this->fields["condition"])." ";
}
echo "".Dropdown::getYesNo($this->fields["is_active"])." ";
if ($display_entities) {
$entname = Dropdown::getDropdownName('glpi_entities', $this->fields['entities_id']);
if ($this->maybeRecursive()
&& $this->fields['is_recursive']) {
$entname = sprintf(__('%1$s %2$s'), $entname, "(".__('R').") ");
}
echo "".$entname." ";
}
if (!$display_entities) {
if ($this->can_sort
&& !$first
&& $canedit) {
echo "";
Html::showSimpleForm($target, ['action' => 'up',
'condition' => $active_condition], '',
['type' => $this->fields["sub_type"],
'id' => $this->fields["id"],],
$CFG_GLPI["root_doc"]."/pics/deplier_up.png");
echo " ";
} else {
echo " ";
}
}
if (!$display_entities) {
if ($this->can_sort
&& !$last
&& $canedit) {
echo "";
Html::showSimpleForm($target, ['action' => 'down',
'condition' => $active_condition], '',
['type' => $this->fields["sub_type"],
'id' => $this->fields["id"]],
$CFG_GLPI["root_doc"]."/pics/deplier_down.png");
echo " ";
} else {
echo " ";
}
}
echo " \n";
}
/**
* @see CommonDBTM::prepareInputForAdd()
**/
function prepareInputForAdd($input) {
// Before adding, add the ranking of the new rule
$input["ranking"] = $input['ranking'] ?? $this->getNextRanking();
//If no uuid given, generate a new one
if (!isset($input['uuid'])) {
$input["uuid"] = self::getUuid();
}
if ($this->getType() == 'Rule' && !isset($input['sub_type'])) {
\Toolbox::logError('Sub type not specified creating a new rule');
return false;
}
if (!isset($input['sub_type'])) {
$input['sub_type'] = $this->getType();
} else if ($this->getType() != 'Rule' && $input['sub_type'] != $this->getType()) {
\Toolbox::logWarning(
sprintf(
'Creating a %s rule with %s subtype.',
$this->getType(),
$input['sub_type']
)
);
}
return $input;
}
/**
* Get the next ranking for a specified rule
**/
function getNextRanking() {
global $DB;
$iterator = $DB->request([
'SELECT' => ['MAX' => 'ranking AS rank'],
'FROM' => self::getTable(),
'WHERE' => ['sub_type' => $this->getType()]
]);
if (count($iterator)) {
$data = $iterator->next();
return $data["rank"] + 1;
}
return 0;
}
/**
* Show the minimal form for the action rule
*
* @param $fields datas used to display the action
* @param $canedit can edit the actions rule ?
* @param $rand random value of the form
**/
function showMinimalActionForm($fields, $canedit, $rand) {
global $CFG_GLPI;
$edit = ($canedit ? "style='cursor:pointer' onClick=\"viewEditAction".
$fields[$this->rules_id_field].$fields["id"]."$rand();\""
: '');
echo "";
if ($canedit) {
echo "";
Html::showMassiveActionCheckBox($this->ruleactionclass, $fields["id"]);
echo "\n\n";
echo " ";
}
echo $this->getMinimalActionText($fields, $edit);
echo " \n";
}
/**
* Show preview result of a rule
*
* @param $target where to go if action
* @param $input input data array
* @param $params params used (see addSpecificParamsForPreview)
**/
function showRulePreviewResultsForm($target, $input, $params) {
$actions = $this->getAllActions();
$check_results = [];
$output = [];
//Test all criteria, without stopping at the first good one
$this->testCriterias($input, $check_results);
//Process the rule
$this->process($input, $output, $params);
if (!$criteria = getItemForItemtype($this->rulecriteriaclass)) {
return;
}
echo "";
echo "
";
echo "" . __('Result details') . " ";
echo ""._n('Criterion', 'Criteria', 1)." ";
echo "".__('Condition')." ";
echo "".__('Reason')." ";
echo ""._n('Validation', 'Validations', 1)." ";
echo " \n";
foreach ($check_results as $ID => $criteria_result) {
echo "";
$criteria->getFromDB($criteria_result["id"]);
echo $this->getMinimalCriteriaText($criteria->fields);
if ($criteria->fields['condition'] != self::PATTERN_FIND) {
echo "".Dropdown::getYesNo($criteria_result["result"])." \n";
} else {
echo "".Dropdown::EMPTY_VALUE." \n";
}
}
echo "
";
echo "
";
echo "" . __('Rule results') . " ";
echo ""._n('Validation', 'Validations', 1)." ";
echo Dropdown::getYesNo($global_result)." ";
$output = $this->preProcessPreviewResults($output);
foreach ($output as $criteria => $value) {
if (isset($actions[$criteria])) {
echo "";
echo "".$actions[$criteria]["name"]." ";
if (isset($actions[$criteria]['type'])) {
$actiontype = $actions[$criteria]['type'];
} else {
$actiontype ='';
}
echo "".$this->getActionValue($criteria, $actiontype, $value);
echo " \n";
}
}
//If a regular expression was used, and matched, display the results
if (count($this->regex_results)) {
echo "";
echo "".__('Result of the regular expression')." ";
echo "";
if (!empty($this->regex_results[0])) {
echo "";
echo "".__('Key')." ".__('Value')." ";
echo "$key $value ";
}
echo "
";
}
echo " \n";
}
echo "\n";
echo "
";
if ($canedit) {
echo "";
Html::showMassiveActionCheckBox($this->rulecriteriaclass, $fields["id"]);
echo "\n\n";
echo " ";
}
echo $this->getMinimalCriteriaText($fields, $edit);
echo " \n";
}
/**
* @param $fields
* @param $addtotd (default '')
**/
function getMinimalCriteriaText($fields, $addtotd = '') {
$text = "" . $this->getCriteriaName($fields["criteria"]) . " ";
$text .= "" . RuleCriteria::getConditionByID($fields["condition"],
get_class($this),
$fields["criteria"])." ";
$text .= "" . $this->getCriteriaDisplayPattern($fields["criteria"],
$fields["condition"],
$fields["pattern"]) . " ";
return $text;
}
/**
* @param $fields
* @param $addtotd (default '')
**/
function getMinimalActionText($fields, $addtotd = '') {
$text = "" . $this->getActionName($fields["field"]) . " ";
$text .= "" . RuleAction::getActionByID($fields["action_type"]) . " ";
if (isset($fields["value"])) {
$text .= "" . $this->getActionValue($fields["field"], $fields['action_type'],
$fields["value"]) . " ";
} else {
$text .= " ";
}
return $text;
}
/**
* Return a value associated with a pattern associated to a criteria to display it
*
* @param $ID the given criteria
* @param $condition condition used
* @param $pattern the pattern
**/
function getCriteriaDisplayPattern($ID, $condition, $pattern) {
if (($condition == self::PATTERN_EXISTS)
|| ($condition == self::PATTERN_DOES_NOT_EXISTS)
|| ($condition == self::PATTERN_FIND)) {
return __('Yes');
} else if (in_array($condition, [self::PATTERN_IS, self::PATTERN_IS_NOT,
self::PATTERN_NOT_UNDER, self::PATTERN_UNDER])) {
$crit = $this->getCriteria($ID);
if (isset($crit['type'])) {
switch ($crit['type']) {
case "yesonly" :
case "yesno" :
return Dropdown::getYesNo($pattern);
case "dropdown" :
$addentity = Dropdown::getDropdownName($crit["table"], $pattern);
if ($this->isEntityAssign()) {
$itemtype = getItemTypeForTable($crit["table"]);
$item = getItemForItemtype($itemtype);
if ($item
&& $item->getFromDB($pattern)
&& $item->isEntityAssign()) {
$addentity = sprintf(__('%1$s (%2$s)'), $addentity,
Dropdown::getDropdownName('glpi_entities',
$item->getEntityID()));
}
}
$tmp = $addentity;
return (($tmp == ' ') ? NOT_AVAILABLE : $tmp);
case "dropdown_users" :
return getUserName($pattern);
case "dropdown_assets_itemtype" :
case "dropdown_tracking_itemtype" :
if ($item = getItemForItemtype($pattern)) {
return $item->getTypeName(1);
}
if (empty($pattern)) {
return __('General');
}
break;
case "dropdown_status" :
return Ticket::getStatus($pattern);
case "dropdown_priority" :
return Ticket::getPriorityName($pattern);
case "dropdown_urgency" :
return Ticket::getUrgencyName($pattern);
case "dropdown_impact" :
return Ticket::getImpactName($pattern);
case "dropdown_tickettype" :
return Ticket::getTicketTypeName($pattern);
}
}
}
if ($result = $this->getAdditionalCriteriaDisplayPattern($ID, $condition, $pattern)) {
return $result;
}
return $pattern;
}
/**
* Used to get specific criteria patterns
*
* @param $ID the given criteria
* @param $condition condition used
* @param $pattern the pattern
*
* @return a value associated with the criteria, or false otherwise
**/
function getAdditionalCriteriaDisplayPattern($ID, $condition, $pattern) {
return false;
}
/**
* Display item used to select a pattern for a criteria
*
* @param $name criteria name
* @param $ID the given criteria
* @param $condition condition used
* @param $value the pattern (default '')
* @param $test Is to test rule ? (false by default)
**/
function displayCriteriaSelectPattern($name, $ID, $condition, $value = "", $test = false) {
global $CFG_GLPI;
$crit = $this->getCriteria($ID);
$display = false;
$tested = false;
if (isset($crit['type'])
&& ($test
|| in_array($condition, [self::PATTERN_IS, self::PATTERN_IS_NOT,
self::PATTERN_NOT_UNDER, self::PATTERN_UNDER]))) {
$tested = true;
switch ($crit['type']) {
case "yesonly" :
Dropdown::showYesNo($name, $crit['table'], 0);
$display = true;
break;
case "yesno" :
Dropdown::showYesNo($name, $value);
$display = true;
break;
case "dropdown" :
$param = ['name' => $name,
'value' => $value];
if (isset($crit['condition'])) {
$param['condition'] = $crit['condition'];
}
Dropdown::show(getItemTypeForTable($crit['table']), $param);
$display = true;
break;
case "dropdown_users" :
User::dropdown(['value' => $value,
'name' => $name,
'right' => 'all']);
$display = true;
break;
case "dropdown_tracking_itemtype" :
Dropdown::showItemTypes($name, array_keys(Ticket::getAllTypesForHelpdesk()));
$display = true;
break;
case "dropdown_assets_itemtype" :
Dropdown::showItemTypes($name, $CFG_GLPI['asset_types'], ['value' => $value]);
$display = true;
break;
case "dropdown_import_type" :
RuleAsset::dropdownImportType($name, $value);
$display = true;
break;
case "dropdown_urgency" :
Ticket::dropdownUrgency(['name' => $name,
'value' => $value]);
$display = true;
break;
case "dropdown_impact" :
Ticket::dropdownImpact(['name' => $name,
'value' => $value]);
$display = true;
break;
case "dropdown_priority" :
Ticket::dropdownPriority(['name' => $name,
'value' => $value,
'withmajor' => true]);
$display = true;
break;
case "dropdown_status" :
Ticket::dropdownStatus(['name' => $name,
'value' => $value]);
$display = true;
break;
case "dropdown_tickettype" :
Ticket::dropdownType($name, ['value' => $value]);
$display = true;
break;
default:
$tested = false;
break;
}
}
//Not a standard condition
if (!$tested) {
$display = $this->displayAdditionalRuleCondition($condition, $crit, $name, $value, $test);
}
if (($condition == self::PATTERN_EXISTS)
|| ($condition == self::PATTERN_DOES_NOT_EXISTS)) {
echo "