Skip to content
GitLab
Commit a158b1d8 authored by Adrien Clairembault's avatar Adrien Clairembault Committed by Johan Cwiklinski
Browse files

Api support for deprecated itemtypes

parent 5eb08dd1
Hide whitespace changes
Inline Side-by-side
.gitignore
View file @ a158b1d8
......@@ -34,3 +34,4 @@ phpunit.xml
.package.hash
/public/build/
/public/lib/
/tests/web/error.log
\ No newline at end of file
apirest.php
View file @ a158b1d8
......@@ -44,5 +44,5 @@ include_once (GLPI_ROOT . "/inc/based_config.php");
//init cache
$GLPI_CACHE = Config::getCache('cache_db');
$api = new APIRest;
$api = new Glpi\Api\APIRest;
$api->call();
apixmlrpc.php
View file @ a158b1d8
......@@ -43,5 +43,5 @@ include_once (GLPI_ROOT . "/inc/based_config.php");
//init cache
$GLPI_CACHE = Config::getCache('cache_db');
$api = new APIXmlrpc;
$api = new Glpi\Api\APIXmlrpc;
$api->call();
inc/api.class.php → inc/api/api.class.php
View file @ a158b1d8
<?php
/**
* ---------------------------------------------------------------------
* GLPI - Gestionnaire Libre de Parc Informatique
......@@ -34,8 +35,36 @@
* @since 9.1
*/
namespace Glpi\Api;
use APIClient;
use Auth;
use Change;
use CommonDevice;
use CommonGLPI;
use Config;
use Contract;
use Document;
use Dropdown;
use Glpi\Exception\ForgetPasswordException;
use Glpi\Exception\PasswordTooWeakException;
use Html;
use Infocom;
use Item_Devices;
use Log;
use Michelf\MarkdownExtra;
use NetworkEquipment;
use NetworkPort;
use Notepad;
use Problem;
use QueryExpression;
use SavedSearch;
use Search;
use Session;
use Software;
use Ticket;
use Toolbox;
use User;
abstract class API extends CommonGLPI {
......@@ -49,6 +78,7 @@ abstract class API extends CommonGLPI {
protected $ipnum = "";
protected $app_tokens = [];
protected $apiclients_id = 0;
protected $deprecated_item = null;
/**
* First function used on api call
......@@ -490,7 +520,6 @@ abstract class API extends CommonGLPI {
}
/**
* Return the instance fields of itemtype identified by id
*
......@@ -521,6 +550,7 @@ abstract class API extends CommonGLPI {
global $CFG_GLPI, $DB;
$this->initEndpoint();
$itemtype = $this->handleDepreciation($itemtype);
// default params
$default = ['expand_dropdowns' => false,
......@@ -1088,6 +1118,14 @@ abstract class API extends CommonGLPI {
);
}
// Convert fields to the format expected by the deprecated type
if ($this->isDeprecated()) {
$fields = $this->deprecated_item->mapCurrentToDeprecatedFields($fields);
$fields["links"] = $this->deprecated_item->mapCurrentToDeprecatedHateoas(
$fields["links"] ?? []
);
}
return $fields;
}
......@@ -1132,6 +1170,7 @@ abstract class API extends CommonGLPI {
global $DB;
$this->initEndpoint();
$itemtype = $this->handleDepreciation($itemtype);
// default params
$default = ['expand_dropdowns' => false,
......@@ -1194,8 +1233,9 @@ abstract class API extends CommonGLPI {
&& isset($this->parameters['parent_id'])) {
// check parent itemtype
if (!class_exists($this->parameters['parent_itemtype'])
|| !is_subclass_of($this->parameters['parent_itemtype'], 'CommonDBTM')) {
if (!Toolbox::isCommonDBTM($this->parameters['parent_itemtype'])
&& !Toolbox::isAPIDeprecated($this->parameters['parent_itemtype'])
) {
$this->returnError(__("parent itemtype not found or not an instance of CommonDBTM"),
400,
"ERROR_ITEMTYPE_NOT_FOUND_NOR_COMMONDBTM");
......@@ -1331,6 +1371,15 @@ abstract class API extends CommonGLPI {
}
}
}
// Break reference
unset($fields);
// Map values for deprecated itemtypes
if ($this->isDeprecated()) {
$found = array_map(function($fields) {
return $this->deprecated_item->mapCurrentToDeprecatedFields($fields);
}, $found);
}
return array_values($found);
}
......@@ -1389,14 +1438,25 @@ abstract class API extends CommonGLPI {
/**
* List the searchoptions of provided itemtype. To use with searchItems function
*
* @param string $itemtype itemtype (class) of object
* @param array $params parameters
* @param string $itemtype itemtype (class) of object
* @param array $params parameters
* @param bool $check_depreciation disable depreciation check, useful
* if depreciation have already been
* handled by a parent call (e.g. search)
*
* @return array all searchoptions of specified itemtype
*/
protected function listSearchOptions($itemtype, $params = []) {
protected function listSearchOptions(
$itemtype,
$params = [],
bool $check_depreciation = true
) {
$this->initEndpoint();
if ($check_depreciation) {
$itemtype = $this->handleDepreciation($itemtype);
}
$soptions = Search::getOptions($itemtype);
if (isset($params['raw'])) {
......@@ -1430,6 +1490,10 @@ abstract class API extends CommonGLPI {
}
}
if ($check_depreciation && $this->isDeprecated()) {
$cleaned_soptions = $this->deprecated_item->mapCurrentToDeprecatedSearchOptions($cleaned_soptions);
}
return $cleaned_soptions;
}
......@@ -1541,6 +1605,7 @@ abstract class API extends CommonGLPI {
global $DEBUG_SQL;
$this->initEndpoint();
$itemtype = $this->handleDepreciation($itemtype);
// check rights
if ($itemtype != 'AllAssets'
......@@ -1549,14 +1614,23 @@ abstract class API extends CommonGLPI {
}
// retrieve searchoptions
$soptions = $this->listSearchOptions($itemtype);
$soptions = $this->listSearchOptions($itemtype, [], false);
if ($this->isDeprecated()) {
$criteria = $this->deprecated_item->mapDeprecatedToCurrentCriteria(
$params['criteria'] ?? []
);
if (count($criteria)) {
$params['criteria'] = $criteria;
}
}
// Check the criterias are valid
if (isset($params['criteria']) && is_array($params['criteria'])) {
// use a recursive closure to check each nested criteria
$check_message = "";
$check_criteria = function($criteria) use (&$check_criteria, $soptions, $check_message) {
$check_criteria = function($criteria) use (&$check_criteria, $soptions) {
foreach ($criteria as $criterion) {
// recursive call
if (isset($criterion['criteria'])) {
......@@ -1565,21 +1639,18 @@ abstract class API extends CommonGLPI {
if (!isset($criterion['field']) || !isset($criterion['searchtype'])
|| !isset($criterion['value'])) {
$check_message = __("Malformed search criteria");
return false;
return __("Malformed search criteria");
}
if (!ctype_digit((string) $criterion['field'])
|| !array_key_exists($criterion['field'], $soptions)) {
$check_message = __("Bad field ID in search criteria");
return false;
return __("Bad field ID in search criteria");
}
if (isset($soptions[$criterion['field']])
&& isset($soptions[$criterion['field']]['nosearch'])
&& $soptions[$criterion['field']]['nosearch']) {
$check_message = __("Forbidden field ID in search criteria");
return false;
return __("Forbidden field ID in search criteria");
}
}
......@@ -1587,8 +1658,9 @@ abstract class API extends CommonGLPI {
};
// call the closure
if (!$check_criteria($params['criteria'])) {
return $this->returnError($check_message);
$check_criteria_result = $check_criteria($params['criteria']);
if ($check_criteria_result !== true) {
return $this->returnError($check_criteria_result);
}
}
......@@ -1758,6 +1830,8 @@ abstract class API extends CommonGLPI {
*/
protected function createItems($itemtype, $params = []) {
$this->initEndpoint();
$itemtype = $this->handleDepreciation($itemtype);
$input = isset($params['input']) ? $params["input"] : null;
$item = new $itemtype;
......@@ -1768,6 +1842,12 @@ abstract class API extends CommonGLPI {
$isMultiple = true;
}
if ($this->isDeprecated()) {
$input = array_map(function($item) {
return $this->deprecated_item->mapDeprecatedToCurrentFields($item);
}, $input);
}
if (is_array($input)) {
$idCollection = [];
$failed = 0;
......@@ -1868,8 +1948,9 @@ abstract class API extends CommonGLPI {
* @return array of boolean
*/
protected function updateItems($itemtype, $params = []) {
$this->initEndpoint();
$itemtype = $this->handleDepreciation($itemtype);
$input = isset($params['input']) ? $params["input"] : null;
$item = new $itemtype;
......@@ -1880,6 +1961,12 @@ abstract class API extends CommonGLPI {
$isMultiple = true;
}
if ($this->isDeprecated()) {
$input = array_map(function($item) {
return $this->deprecated_item->mapDeprecatedToCurrentFields($item);
}, $input);
}
if (is_array($input)) {
$idCollection = [];
$failed = 0;
......@@ -1972,6 +2059,8 @@ abstract class API extends CommonGLPI {
protected function deleteItems($itemtype, $params = []) {
$this->initEndpoint();
$itemtype = $this->handleDepreciation($itemtype);
$default = ['force_purge' => false,
'history' => true];
$params = array_merge($default, $params);
......@@ -1985,6 +2074,12 @@ abstract class API extends CommonGLPI {
$isMultiple = true;
}
if ($this->isDeprecated()) {
$input = array_map(function($item) {
return $this->deprecated_item->mapDeprecatedToCurrentFields($item);
}, $input);
}
if (is_array($input)) {
$idCollection = [];
$failed = 0;
......@@ -2324,7 +2419,7 @@ abstract class API extends CommonGLPI {
echo "<div class='documentation'>";
$documentation = file_get_contents(GLPI_ROOT.'/'.$file);
$md = new Michelf\MarkdownExtra();
$md = new MarkdownExtra();
$md->code_class_prefix = "language-";
$md->header_id_func = function($headerName) {
$headerName = str_replace(['(', ')'], '', $headerName);
......@@ -2670,7 +2765,7 @@ abstract class API extends CommonGLPI {
} else {
if (!isset($data[$kn_fkey])) {
\Toolbox::logWarning(
Toolbox::logWarning(
"Invalid value: \"$kn_fkey\" doesn't exist.
");
continue;
......@@ -2684,7 +2779,7 @@ abstract class API extends CommonGLPI {
// Check itemtype is valid
$kn_item = getItemForItemtype($kn_itemtype);
if (!$kn_item) {
\Toolbox::logWarning(
Toolbox::logWarning(
"Invalid itemtype \"$kn_itemtype\" for fkey \"$kn_fkey\""
);
continue;
......@@ -2708,7 +2803,7 @@ abstract class API extends CommonGLPI {
$this->initEndpoint();
// Try to load target user
$user = new \User();
$user = new User();
if (!$user->getFromDB($user_id)) {
$this->returnError("Bad request: user with id '$user_id' not found");
}
......@@ -2723,4 +2818,36 @@ abstract class API extends CommonGLPI {
}
die;
}
/**
* If the given itemtype is deprecated, replace it by it's current
* equivalent and keep a reference to the deprecation logic so we can convert
* the API input and/or output to the exêcted format.
*
* @param string $itemtype
* @return string The corrected itemtype.
*/
public function handleDepreciation(string $itemtype): string {
$deprecated = Toolbox::isAPIDeprecated($itemtype);
if ($deprecated) {
// Keep a reference to deprecated item
$class = "Glpi\Api\Deprecated\\$itemtype";
$this->deprecated_item = new $class();
// Get correct itemtype
$itemtype = $this->deprecated_item->getType();
}
return $itemtype;
}
/**
* Check if the current call is using a deprecated item
*
* @return bool
*/
public function isDeprecated(): bool {
return $this->deprecated_item !== null;
}
}
inc/apirest.class.php → inc/api/apirest.class.php
View file @ a158b1d8
......@@ -34,6 +34,12 @@
* @since 9.1
*/
namespace Glpi\Api;
use GLPIUploadHandler;
use stdClass;
use Toolbox;
class APIRest extends API {
protected $request_uri;
......@@ -326,10 +332,12 @@ class APIRest extends API {
private function getItemtype($index = 0, $recursive = true, $all_assets = false) {
if (isset($this->url_elements[$index])) {
if ((class_exists($this->url_elements[$index])
&& is_subclass_of($this->url_elements[$index], 'CommonDBTM'))
|| ($all_assets
&& $this->url_elements[$index] == "AllAssets")) {
$all_assets = $all_assets && $this->url_elements[$index] == "AllAssets";
$valid_class = Toolbox::isCommonDBTM($this->url_elements[$index])
|| Toolbox::isAPIDeprecated($this->url_elements[$index]
);
if ($all_assets || $valid_class) {
$itemtype = $this->url_elements[$index];
if ($recursive
......@@ -339,13 +347,18 @@ class APIRest extends API {
}
// AllAssets
if ($all_assets && $this->url_elements[$index] == "AllAssets") {
if ($all_assets) {
return "AllAssets";
}
// Load namespace for deprecated
if (Toolbox::isAPIDeprecated($itemtype)) {
$itemtype = "Glpi\Api\Deprecated\\$itemtype";
}
// Get case sensitive itemtype name
$rc = new \ReflectionClass($itemtype);
$itemtype = $rc->getName();
$itemtype = $rc->getShortName();
return $itemtype;
}
$this->returnError(__("resource not found or not an instance of CommonDBTM"),
......
inc/apixmlrpc.class.php → inc/api/apixmlrpc.class.php
View file @ a158b1d8
......@@ -30,6 +30,10 @@
* ---------------------------------------------------------------------
*/
namespace Glpi\Api;
use Toolbox;
class APIXmlrpc extends API {
protected $request_uri;
protected $url_elements;
......@@ -225,7 +229,7 @@ class APIXmlrpc extends API {
} else if ($resource === "deleteItems") { // delete one or many CommonDBTM items
if (isset($this->parameters['id'])) {
//override input
$this->parameters['input'] = new stdClass();;
$this->parameters['input'] = new \stdClass();
$this->parameters['input']->id = $this->parameters['id'];
}
return $this->returnResponse($this->deleteItems($this->parameters['itemtype'],
......
inc/api/deprecated/commondeprecatedtrait.class.php 0 → 100644
View file @ a158b1d8
<?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/>.
* ---------------------------------------------------------------------
*/
namespace Glpi\Api\Deprecated;
if (!defined('GLPI_ROOT')) {
die("Sorry. You can't access this file directly");
}
/**
* @since 9.5
*/
trait CommonDeprecatedTrait
{
abstract public function getType(): string;
/**
* Get the class short name for the deprecated itemtpe
*
* @return string
*/
private function getDeprecatedClass(): string {
return (new \ReflectionClass(static::class))->getShortName();
}
/**
* For each hateoas, update the href ref to match the deprecated type
*
* @param array $hateoas Current hateoas
* @return array Updated hateoas
*/
public function replaceCurrentHateoasRefByDeprecated(array $hateoas): array {
foreach ($hateoas as $key => $value) {
if (isset($value["href"])) {
$hateoas[$key]["href"] = str_replace(
$this->getType(),
$this->getDeprecatedClass(),
$value["href"]
);
}
}
return $hateoas;
}
/**
* For each searchoption, update the UID ref to match the deprecated type
*
* @param array $soptions
* @return CommonDeprecatedTrait Return self to allow method chaining
*/
public function updateSearchOptionsUids(array &$soptions) {
$soptions = array_map(function($soption) {
if (isset($soption['uid'])) {
$new_uid = str_replace(
$this->getType(),
$this->getDeprecatedClass(),
$soption['uid']
);
$soption['uid'] = $new_uid;
}
return $soption;
}, $soptions);
return $this;
}
/**
* For each searchoption, update the table ref to match the deprecated type
*
* @param array $soptions
* @return CommonDeprecatedTrait Return self to allow method chaining
*/
public function updateSearchOptionsTables(array &$soptions) {
$soptions = array_map(function($soption) {
if (isset($soption['table'])) {
$new_table = str_replace(
getTableForItemType($this->getType()),
getTableForItemType($this->getDeprecatedClass()),
$soption['table']
);
$soption['table'] = $new_table;
}
return $soption;
}, $soptions);
return $this;
}
/**
* Add a field in an array or an object
*
* @param array|object $fields
* @param string $name
* @param string $value
* @return CommonDeprecatedTrait Return self to allow method chaining
*/
public function addField(&$fields, string $name, string $value) {
if (is_object($fields)) {
if (!isset($fields->$name)) {
$fields->$name = $value;
}
} else if (is_array($fields)) {
if (!isset($fields[$name])) {
$fields[$name] = $value;
}
}
return $this;
}
/**
* Rename a field in an array or an object
*
* @param array|object $fields
* @param string $old
* @param string $new
* @return CommonDeprecatedTrait Return self to allow method chaining
*/
public function renameField(&$fields, string $old, string $new) {
if (is_object($fields)) {
if (isset($fields->$old)) {
$fields->$new = $fields->$old;
unset($fields->$old);
}
} else if (is_array($fields)) {
if (isset($fields[$old])) {
$fields[$new] = $fields[$old];
unset($fields[$old]);
}
}
return $this;
}
/**
* Delete a field in an array or an object
*
* @param array|object $fields
* @param string $name
* @return CommonDeprecatedTrait Return self to allow method chaining