411 lines
13 KiB
PHP
411 lines
13 KiB
PHP
<?php
|
|
|
|
/**
|
|
* FusionInventory
|
|
*
|
|
* Copyright (C) 2010-2016 by the FusionInventory Development Team.
|
|
*
|
|
* http://www.fusioninventory.org/
|
|
* https://github.com/fusioninventory/fusioninventory-for-glpi
|
|
* http://forge.fusioninventory.org/
|
|
*
|
|
* ------------------------------------------------------------------------
|
|
*
|
|
* LICENSE
|
|
*
|
|
* This file is part of FusionInventory project.
|
|
*
|
|
* FusionInventory is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* FusionInventory 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 Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with FusionInventory. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* ------------------------------------------------------------------------
|
|
*
|
|
* This file is used to manage the location rules for computer.
|
|
*
|
|
* ------------------------------------------------------------------------
|
|
*
|
|
* @package FusionInventory
|
|
* @author Walid Nouh
|
|
* @author David Durieux
|
|
* @copyright Copyright (c) 2010-2016 FusionInventory team
|
|
* @license AGPL License 3.0 or (at your option) any later version
|
|
* http://www.gnu.org/licenses/agpl-3.0-standalone.html
|
|
* @link http://www.fusioninventory.org/
|
|
* @link https://github.com/fusioninventory/fusioninventory-for-glpi
|
|
*
|
|
*/
|
|
|
|
if (!defined('GLPI_ROOT')) {
|
|
die("Sorry. You can't access directly to this file");
|
|
}
|
|
|
|
/**
|
|
* Manage the location rules for computer.
|
|
*/
|
|
class PluginFusioninventoryInventoryRuleLocation extends Rule {
|
|
|
|
/**
|
|
* The right name for this class
|
|
*
|
|
* @var string
|
|
*/
|
|
static $rightname = "plugin_fusioninventory_rulelocation";
|
|
|
|
/**
|
|
* Set these rules can be sorted
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $can_sort=true;
|
|
|
|
/**
|
|
* Set these rules don't have specific parameters
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $specific_parameters = false;
|
|
|
|
const PATTERN_CIDR = 333;
|
|
const PATTERN_NOT_CIDR = 334;
|
|
|
|
|
|
/**
|
|
* Get name of this type by language of the user connected
|
|
*
|
|
* @return string name of this type
|
|
*/
|
|
function getTitle() {
|
|
return __('Location rules', 'fusioninventory');
|
|
}
|
|
|
|
|
|
/**
|
|
* Make some changes before process review result
|
|
*
|
|
* @param array $output
|
|
* @return array
|
|
*/
|
|
function preProcessPreviewResults($output) {
|
|
return $output;
|
|
}
|
|
|
|
|
|
/**
|
|
* Define maximum number of actions possible in a rule
|
|
*
|
|
* @return integer
|
|
*/
|
|
function maxActionsCount() {
|
|
return 2;
|
|
}
|
|
|
|
|
|
/**
|
|
* Code execution of actions of the rule
|
|
*
|
|
* @param array $output
|
|
* @param array $params
|
|
* @return array
|
|
*/
|
|
function executeActions($output, $params, array $input = []) {
|
|
|
|
PluginFusioninventoryToolbox::logIfExtradebug(
|
|
"pluginFusioninventory-rules-location",
|
|
"execute actions, data:\n". print_r($output, true). "\n" . print_r($params, true)
|
|
);
|
|
|
|
PluginFusioninventoryToolbox::logIfExtradebug(
|
|
"pluginFusioninventory-rules-location",
|
|
"execute actions: ". count($this->actions) ."\n"
|
|
);
|
|
|
|
if (count($this->actions)) {
|
|
foreach ($this->actions as $action) {
|
|
PluginFusioninventoryToolbox::logIfExtradebug(
|
|
"pluginFusioninventory-rules-location",
|
|
"- action: ". $action->fields["action_type"] ." for: ". $action->fields["field"] ."\n"
|
|
);
|
|
|
|
switch ($action->fields["action_type"]) {
|
|
case "assign" :
|
|
PluginFusioninventoryToolbox::logIfExtradebug(
|
|
"pluginFusioninventory-rules-location",
|
|
"- value ".$action->fields["value"]."\n"
|
|
);
|
|
$output[$action->fields["field"]] = $action->fields["value"];
|
|
break;
|
|
|
|
case "regex_result" :
|
|
$res = '';
|
|
if (isset($this->regex_results[0])) {
|
|
PluginFusioninventoryToolbox::logIfExtradebug(
|
|
"pluginFusioninventory-rules-collect",
|
|
"- regex ".print_r($this->regex_results[0], true)."\n"
|
|
);
|
|
$res .= RuleAction::getRegexResultById($action->fields["value"],
|
|
$this->regex_results[0]);
|
|
PluginFusioninventoryToolbox::logIfExtradebug(
|
|
"pluginFusioninventory-rules-collect",
|
|
"- regex result: ".$res."\n"
|
|
);
|
|
} else {
|
|
$res .= $action->fields["value"];
|
|
}
|
|
if ($res != '') {
|
|
$entities_id = 0;
|
|
if (isset($_SESSION["plugin_fusioninventory_entity"])
|
|
&& $_SESSION["plugin_fusioninventory_entity"] > 0) {
|
|
$entities_id = $_SESSION["plugin_fusioninventory_entity"];
|
|
}
|
|
$res = Dropdown::importExternal(getItemtypeForForeignKeyField($action->fields['field']), $res, $entities_id);
|
|
}
|
|
PluginFusioninventoryToolbox::logIfExtradebug(
|
|
"pluginFusioninventory-rules-location",
|
|
"- value ".$res."\n"
|
|
);
|
|
$output[$action->fields["field"]] = $res;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
return $output;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get the criteria available for the rule
|
|
*
|
|
* @return array
|
|
*/
|
|
function getCriterias() {
|
|
|
|
$criterias = [];
|
|
|
|
$criterias['itemtype']['name'] = __('Assets', 'fusioninventory').' : '.
|
|
__('Item type');
|
|
$criterias['itemtype']['type'] = 'dropdown_itemtype';
|
|
$criterias['itemtype']['is_global'] = false;
|
|
$criterias['itemtype']['allow_condition'] = [Rule::PATTERN_IS,
|
|
Rule::PATTERN_IS_NOT,
|
|
Rule::REGEX_MATCH,
|
|
Rule::REGEX_NOT_MATCH
|
|
];
|
|
|
|
$criterias['tag']['field'] = 'name';
|
|
$criterias['tag']['name'] = __('FusionInventory tag', 'fusioninventory');
|
|
|
|
$criterias['domain']['field'] = 'name';
|
|
$criterias['domain']['name'] = __('Domain');
|
|
|
|
$criterias['subnet']['field'] = 'name';
|
|
$criterias['subnet']['name'] = __('Subnet');
|
|
|
|
$criterias['ip']['field'] = 'name';
|
|
$criterias['ip']['name'] = __('Address')." ".__('IP');
|
|
|
|
$criterias['name']['field'] = 'name';
|
|
$criterias['name']['name'] = __('Name');
|
|
|
|
$criterias['serial']['field'] = 'name';
|
|
$criterias['serial']['name'] = __('Serial number');
|
|
|
|
$criterias['oscomment']['field'] = 'name';
|
|
$criterias['oscomment']['name'] = OperatingSystem::getTypeName(1).'/'.__('Comments');
|
|
|
|
return $criterias;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get the actions available for the rule
|
|
*
|
|
* @return array
|
|
*/
|
|
function getActions() {
|
|
|
|
$actions = [];
|
|
|
|
$actions['locations_id']['name'] = __('Location');
|
|
|
|
$actions['locations_id']['type'] = 'dropdown';
|
|
$actions['locations_id']['table'] = 'glpi_locations';
|
|
$actions['locations_id']['force_actions'] = ['assign', 'regex_result'];
|
|
|
|
$actions['_ignore_import']['name'] =
|
|
__('Ignore in FusionInventory import', 'fusioninventory');
|
|
|
|
$actions['_ignore_import']['type'] = 'yesonly';
|
|
|
|
return $actions;
|
|
}
|
|
|
|
|
|
/**
|
|
* Display more conditions
|
|
*
|
|
* @param integer $condition
|
|
* @param object $criteria
|
|
* @param string $name
|
|
* @param string $value
|
|
* @param boolean $test
|
|
* @return boolean
|
|
*/
|
|
function displayAdditionalRuleCondition($condition, $criteria, $name, $value, $test = false) {
|
|
if ($test) {
|
|
return false;
|
|
}
|
|
switch ($condition) {
|
|
case Rule::PATTERN_FIND:
|
|
return false;
|
|
|
|
case PluginFusioninventoryInventoryRuleImport::PATTERN_IS_EMPTY :
|
|
Dropdown::showYesNo($name, 0, 0);
|
|
return true;
|
|
|
|
case Rule::PATTERN_EXISTS:
|
|
echo Dropdown::showYesNo($name, 1, 0);
|
|
return true;
|
|
|
|
case Rule::PATTERN_DOES_NOT_EXISTS:
|
|
echo Dropdown::showYesNo($name, 1, 0);
|
|
return true;
|
|
|
|
case Rule::PATTERN_IS:
|
|
case Rule::PATTERN_IS_NOT:
|
|
if (!empty($criteria)
|
|
&& isset($criteria['type'])
|
|
&& $criteria['type'] == 'dropdown_itemtype') {
|
|
$types = $this->getItemTypesForRules();
|
|
Dropdown::showItemTypes($name, array_keys($types),
|
|
['value' => $value]);
|
|
return true;
|
|
}
|
|
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
/**
|
|
* Add more criteria
|
|
*
|
|
* @param string $criterion
|
|
* @return array
|
|
*/
|
|
static function addMoreCriteria($criterion = '') {
|
|
if ($criterion == 'ip'
|
|
|| $criterion == 'subnet') {
|
|
return [self::PATTERN_CIDR => __('is CIDR', 'fusioninventory'),
|
|
self::PATTERN_NOT_CIDR => __('is not CIDR', 'fusioninventory')];
|
|
}
|
|
return [];
|
|
}
|
|
|
|
|
|
/**
|
|
* Check criteria
|
|
*
|
|
* @param object $criteria
|
|
* @param array $input
|
|
* @return boolean
|
|
*/
|
|
function checkCriteria(&$criteria, &$input) {
|
|
|
|
$res = parent::checkCriteria($criteria, $input);
|
|
|
|
if (in_array($criteria->fields["condition"], [self::PATTERN_CIDR])) {
|
|
$pattern = $criteria->fields['pattern'];
|
|
$value = $this->getCriteriaValue($criteria->fields["criteria"],
|
|
$criteria->fields["condition"],
|
|
$input[$criteria->fields["criteria"]]);
|
|
|
|
list ($subnet, $bits) = explode('/', $pattern);
|
|
$subnet = ip2long($subnet);
|
|
$mask = -1 << (32 - $bits);
|
|
$subnet &= $mask; // nb: in case the supplied subnet wasn't correctly aligned
|
|
|
|
if (is_array($value)) {
|
|
foreach ($value as $ip) {
|
|
if (isset($ip) && $ip != '') {
|
|
$ip = ip2long($ip);
|
|
if (($ip & $mask) == $subnet) {
|
|
$res = true;
|
|
break 1;
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
if (isset($value) && $value != '') {
|
|
$ip = ip2long($value);
|
|
if (($ip & $mask) == $subnet) {
|
|
$res = true;
|
|
}
|
|
}
|
|
}
|
|
} else if (in_array($criteria->fields["condition"], [self::PATTERN_NOT_CIDR])) {
|
|
$pattern = $criteria->fields['pattern'];
|
|
$value = $this->getCriteriaValue($criteria->fields["criteria"],
|
|
$criteria->fields["condition"],
|
|
$input[$criteria->fields["criteria"]]);
|
|
|
|
list ($subnet, $bits) = explode('/', $pattern);
|
|
$subnet = ip2long($subnet);
|
|
$mask = -1 << (32 - $bits);
|
|
$subnet &= $mask; // nb: in case the supplied subnet wasn't correctly aligned
|
|
|
|
if (is_array($value)) {
|
|
$resarray = true;
|
|
foreach ($value as $ip) {
|
|
if (isset($ip) && $ip != '') {
|
|
$ip = ip2long($ip);
|
|
if (($ip & $mask) == $subnet) {
|
|
$resarray = false;
|
|
}
|
|
}
|
|
}
|
|
$res = $resarray;
|
|
} else {
|
|
if (isset($value) && $value != '') {
|
|
$ip = ip2long($value);
|
|
if (($ip & $mask) != $subnet) {
|
|
$res = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Get itemtypes have state_type and unmanaged devices
|
|
*
|
|
* @global array $CFG_GLPI
|
|
* @return array
|
|
*/
|
|
function getItemTypesForRules() {
|
|
global $CFG_GLPI;
|
|
|
|
$types = [];
|
|
foreach ($CFG_GLPI["networkport_types"] as $itemtype) {
|
|
if (class_exists($itemtype)) {
|
|
$item = new $itemtype();
|
|
$types[$itemtype] = $item->getTypeName();
|
|
}
|
|
}
|
|
$types[""] = __('No itemtype defined', 'fusioninventory');
|
|
ksort($types);
|
|
return $types;
|
|
}
|
|
}
|