first commit
This commit is contained in:
325
inc/apiclient.class.php
Normal file
325
inc/apiclient.class.php
Normal file
@ -0,0 +1,325 @@
|
||||
<?php
|
||||
/**
|
||||
* ---------------------------------------------------------------------
|
||||
* GLPI - Gestionnaire Libre de Parc Informatique
|
||||
* Copyright (C) 2015-2020 Teclib' and contributors.
|
||||
*
|
||||
* http://glpi-project.org
|
||||
*
|
||||
* based on GLPI - Gestionnaire Libre de Parc Informatique
|
||||
* Copyright (C) 2003-2014 by the INDEPNET Development Team.
|
||||
*
|
||||
* ---------------------------------------------------------------------
|
||||
*
|
||||
* LICENSE
|
||||
*
|
||||
* This file is part of GLPI.
|
||||
*
|
||||
* GLPI 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 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* GLPI 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 GLPI. If not, see <http://www.gnu.org/licenses/>.
|
||||
* ---------------------------------------------------------------------
|
||||
*/
|
||||
|
||||
/**
|
||||
* @since 9.1
|
||||
*/
|
||||
|
||||
class APIClient extends CommonDBTM {
|
||||
|
||||
const DOLOG_DISABLED = 0;
|
||||
const DOLOG_LOGS = 1;
|
||||
const DOLOG_HISTORICAL = 2;
|
||||
|
||||
static $rightname = 'config';
|
||||
|
||||
// From CommonDBTM
|
||||
public $dohistory = true;
|
||||
|
||||
static $undisclosedFields = [
|
||||
'app_token'
|
||||
];
|
||||
|
||||
static function canCreate() {
|
||||
return Session::haveRight(static::$rightname, UPDATE);
|
||||
}
|
||||
|
||||
static function canPurge() {
|
||||
return Session::haveRight(static::$rightname, UPDATE);
|
||||
}
|
||||
|
||||
static function getTypeName($nb = 0) {
|
||||
return _n("API client", "API clients", $nb);
|
||||
}
|
||||
|
||||
function defineTabs($options = []) {
|
||||
|
||||
$ong = [];
|
||||
$this->addDefaultFormTab($ong)
|
||||
->addStandardTab('Log', $ong, $options);
|
||||
|
||||
return $ong;
|
||||
}
|
||||
|
||||
function rawSearchOptions() {
|
||||
$tab = [];
|
||||
|
||||
$tab[] = [
|
||||
'id' => 'common',
|
||||
'name' => self::GetTypeName()
|
||||
];
|
||||
|
||||
$tab[] = [
|
||||
'id' => '1',
|
||||
'table' => $this->getTable(),
|
||||
'field' => 'name',
|
||||
'name' => __('Name'),
|
||||
'datatype' => 'itemlink',
|
||||
'autocomplete' => true,
|
||||
];
|
||||
|
||||
$tab[] = [
|
||||
'id' => '2',
|
||||
'table' => $this->getTable(),
|
||||
'field' => 'id',
|
||||
'name' => __('ID'),
|
||||
'massiveaction' => false,
|
||||
'datatype' => 'number'
|
||||
];
|
||||
|
||||
$tab[] = [
|
||||
'id' => '3',
|
||||
'table' => $this->getTable(),
|
||||
'field' => 'is_active',
|
||||
'name' => __('Active'),
|
||||
'datatype' => 'bool'
|
||||
];
|
||||
|
||||
$tab[] = [
|
||||
'id' => '4',
|
||||
'table' => $this->getTable(),
|
||||
'field' => 'dolog_method',
|
||||
'name' => __('Log connections'),
|
||||
'datatype' => 'specific'
|
||||
];
|
||||
|
||||
$tab[] = [
|
||||
'id' => 'filter',
|
||||
'name' => __('Filter access')
|
||||
];
|
||||
|
||||
$tab[] = [
|
||||
'id' => '5',
|
||||
'table' => $this->getTable(),
|
||||
'field' => 'ipv4_range_start',
|
||||
'name' => __('IPv4 address range')." - ".__("Start"),
|
||||
'datatype' => 'specific'
|
||||
];
|
||||
|
||||
$tab[] = [
|
||||
'id' => '6',
|
||||
'table' => $this->getTable(),
|
||||
'field' => 'ipv4_range_end',
|
||||
'name' => __('IPv4 address range')." - ".__("End"),
|
||||
'datatype' => 'specific'
|
||||
];
|
||||
|
||||
$tab[] = [
|
||||
'id' => '7',
|
||||
'table' => $this->getTable(),
|
||||
'field' => 'ipv6',
|
||||
'name' => __('IPv6 address'),
|
||||
'datatype' => 'text',
|
||||
'autocomplete' => true,
|
||||
];
|
||||
|
||||
$tab[] = [
|
||||
'id' => '8',
|
||||
'table' => $this->getTable(),
|
||||
'field' => 'app_token',
|
||||
'name' => __('Application token'),
|
||||
'massiveaction' => false,
|
||||
'datatype' => 'text',
|
||||
'autocomplete' => true,
|
||||
];
|
||||
|
||||
return $tab;
|
||||
}
|
||||
|
||||
static function getSpecificValueToDisplay($field, $values, array $options = []) {
|
||||
|
||||
switch ($field) {
|
||||
case 'dolog_method' :
|
||||
$methods = self::getLogMethod();
|
||||
return $methods[$values[$field]];
|
||||
|
||||
case 'ipv4_range_start':
|
||||
case 'ipv4_range_end':
|
||||
if (empty($values[$field])) {
|
||||
return '';
|
||||
}
|
||||
return long2ip((int)$values[$field]);
|
||||
}
|
||||
|
||||
return parent::getSpecificValueToDisplay($field, $values, $options);
|
||||
}
|
||||
|
||||
/**
|
||||
* Show form
|
||||
*
|
||||
* @param integer $ID Item ID
|
||||
* @param array $options Options
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
function showForm ($ID, $options = []) {
|
||||
|
||||
$this->initForm($ID, $options);
|
||||
$this->showFormHeader($options);
|
||||
|
||||
echo "<tr class='tab_bg_1'>";
|
||||
echo "<td>".__('Name')."</td>";
|
||||
echo "<td>";
|
||||
Html::autocompletionTextField($this, "name");
|
||||
echo "</td>";
|
||||
echo "<td rowspan='3'>".__('Comments')."</td>";
|
||||
echo "<td rowspan='3'>";
|
||||
echo "<textarea name='comment' >".$this->fields["comment"]."</textarea>";
|
||||
echo "</td></tr>";
|
||||
|
||||
echo "<tr class='tab_bg_1'>";
|
||||
echo "<td >".__('Active')."</td>";
|
||||
echo "<td>";
|
||||
Dropdown::showYesNo("is_active", $this->fields["is_active"]);
|
||||
echo "</td></tr>";
|
||||
|
||||
echo "<tr class='tab_bg_1'>";
|
||||
echo "<td >".__('Log connections')."</td>";
|
||||
echo "<td>";
|
||||
Dropdown::showFromArray("dolog_method",
|
||||
self::getLogMethod(),
|
||||
['value' => $this->fields["dolog_method"]]);
|
||||
echo "</td></tr>";
|
||||
|
||||
echo "<tr class='tab_bg_1'>";
|
||||
echo "<th colspan='4'>";
|
||||
echo "<div class='center'>". __("Filter access")."</div>";
|
||||
echo "</th></tr>";
|
||||
|
||||
echo "<tr class='tab_bg_1'>";
|
||||
echo "<td colspan='4'>";
|
||||
echo "<i>".__('Leave these parameters empty to disable API access restriction')."</i>";
|
||||
echo "<br><br><br>";
|
||||
echo "</td></tr>";
|
||||
|
||||
echo "<tr class='tab_bg_1'>";
|
||||
echo "<td>".__('IPv4 address range')."</td>";
|
||||
echo "<td colspan='3'>";
|
||||
echo "<input type='text' name='ipv4_range_start' value='".
|
||||
($this->fields["ipv4_range_start"] ? long2ip($this->fields["ipv4_range_start"]) : '') .
|
||||
"' size='17'> - ";
|
||||
echo "<input type='text' name='ipv4_range_end' value='" .
|
||||
($this->fields["ipv4_range_end"] ? long2ip($this->fields["ipv4_range_end"]) : '') .
|
||||
"' size='17'>";
|
||||
echo "</td></tr>";
|
||||
|
||||
echo "<tr class='tab_bg_1'>";
|
||||
echo "<td>".__('IPv6 address')."</td>";
|
||||
echo "<td>";
|
||||
Html::autocompletionTextField($this, "ipv6");
|
||||
echo "</td>";
|
||||
echo "<td colspan='2'></td>";
|
||||
echo "</tr>";
|
||||
|
||||
echo "<tr class='tab_bg_1'>";
|
||||
echo "<td>".sprintf(__('%1$s (%2$s)'), __('Application token'), "app_token")."</td>";
|
||||
echo "<td colspan='2'>";
|
||||
Html::autocompletionTextField($this, "app_token");
|
||||
echo "<br><input type='checkbox' name='_reset_app_token' id='app_token'> ";
|
||||
echo "<label for='app_token'>".__('Regenerate')."</label>";
|
||||
echo "</td><td></td></tr>";
|
||||
|
||||
$this->showFormButtons($options);
|
||||
}
|
||||
|
||||
function prepareInputForAdd($input) {
|
||||
return $this->prepareInputForUpdate($input);
|
||||
}
|
||||
|
||||
function prepareInputForUpdate($input) {
|
||||
|
||||
if (isset($input['ipv4_range_start'])) {
|
||||
$input['ipv4_range_start'] = ip2long($input['ipv4_range_start']);
|
||||
}
|
||||
|
||||
if (isset($input['ipv4_range_end'])) {
|
||||
$input['ipv4_range_end'] = ip2long($input['ipv4_range_end']);
|
||||
}
|
||||
|
||||
if (isset($input['ipv4_range_start']) && isset($input['ipv4_range_end'])) {
|
||||
if (empty($input['ipv4_range_start'])) {
|
||||
$input['ipv4_range_start'] = "NULL";
|
||||
$input['ipv4_range_end'] = "NULL";
|
||||
} else {
|
||||
if (empty($input['ipv4_range_end'])) {
|
||||
$input['ipv4_range_end'] = $input['ipv4_range_start'];
|
||||
}
|
||||
|
||||
if ($input['ipv4_range_end'] < $input['ipv4_range_start']) {
|
||||
$tmp = $input['ipv4_range_end'];
|
||||
$input['ipv4_range_end'] = $input['ipv4_range_start'];
|
||||
$input['ipv4_range_start'] = $tmp;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($input['ipv6']) && empty($input['ipv6'])) {
|
||||
$input['ipv6'] = "NULL";
|
||||
}
|
||||
|
||||
if (isset($input['_reset_app_token'])) {
|
||||
$input['app_token'] = self::getUniqueAppToken();
|
||||
$input['app_token_date'] = $_SESSION['glpi_currenttime'];
|
||||
}
|
||||
|
||||
return $input;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get log methods
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
static function getLogMethod() {
|
||||
|
||||
return [self::DOLOG_DISABLED => __('Disabled'),
|
||||
self::DOLOG_HISTORICAL => __('Historical'),
|
||||
self::DOLOG_LOGS => _n('Log', 'Logs',
|
||||
Session::getPluralNumber())];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get app token checking that it is unique
|
||||
*
|
||||
* @return string app token
|
||||
*/
|
||||
static function getUniqueAppToken() {
|
||||
|
||||
$ok = false;
|
||||
do {
|
||||
$key = Toolbox::getRandomString(40);
|
||||
if (countElementsInTable(self::getTable(), ['app_token' => $key]) == 0) {
|
||||
return $key;
|
||||
}
|
||||
} while (!$ok);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user