loviuz/openstamanager
1
0
Fork 0
mirror of https://github.com/devcode-it/openstamanager.git synced 2025-06-05 22:09:38 +02:00
Code Issues Releases Activity

Aggiornamento dell'API

Browse Source 
Aggiornamento dell'API, con introduzione del supporto a tutte le operazioni specifiche e miglioramento della documentazione integrata.
This commit is contained in:
Thomas Zilio
2017-08-29 12:42:42 +02:00
parent 56a9aefd0d
commit fd054bf13c
10 changed files with 230 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
lib/classes/API.php
View File

@@ -7,8 +7,10 @@
*/
class API extends \Util\Singleton
{
/** @var array Elenco delle risorse disponibili suddivise per categoria */
protected static $resources;
/** @var array Stati previsti dall'API */
protected static $status = [
'ok' => [
'code' => 200,
@@ -32,7 +34,10 @@ class API extends \Util\Singleton
],
];
public function __construct($token)
/**
* @throws InvalidArgumentException
*/
public function __construct()
{
$user = Auth::user();
@@ -41,18 +46,25 @@ class API extends \Util\Singleton
}
}
public function retrieve($resource)
/**
* Gestisce le richieste di informazioni riguardanti gli elementi esistenti.
*
* @param array $request
*
* @return string
*/
public function retrieve($request)
{
$table = '';
$select = '*';
// Selezione personalizzata
$display = filter('display');
$display = $request['display'];
$select = !empty($display) ? explode(',', substr($display, 1, -1)) : $select;
$where = [];
// Ricerca personalizzata
$filter = (array) filter('filter');
$filter = (array) $request['filter'];
foreach ($filter as $key => $value) {
$value = substr($value, 1, -1);
$result = [];
@@ -75,20 +87,21 @@ class API extends \Util\Singleton
$order = [];
// Ordinamento personalizzato
$order_request = (array) filter('order');
$order_request = (array) $request['order'];
foreach ($order_request as $value) {
$pieces = explode('|', $value);
$order[] = empty($pieces[1]) ? $pieces[0] : [$pieces[0] => $pieces[1]];
}
// Date di interesse
$updated = filter('upd');
$created = filter('crd');
$updated = $request['upd'];
$created = $request['crd'];
$dbo = Database::getConnection();
$kind = 'retrieve';
$resources = self::getResources()[$kind];
$resource = $request['resource'];
if (!in_array($resource, $resources)) {
$excluded = explode(',', Settings::get('Tabelle escluse per la sincronizzazione API automatica'));
@@ -105,7 +118,7 @@ class API extends \Util\Singleton
}
// Paginazione dell'API
$page = (int) filter('page') ?: 0;
$page = (int) $request['page'] ?: 0;
$length = Settings::get('Lunghezza pagine per API');
// Generazione automatica delle query
@@ -129,24 +142,53 @@ class API extends \Util\Singleton
return self::response($results);
}
public function create($resource)
/**
* Gestisce le richieste di creazione nuovi elementi.
*
* @param array $request
*
* @return string
*/
public function create($request)
{
return $this->fileRequest($resource, 'create');
return $this->fileRequest($request, 'create');
}
public function update($resource)
/**
* Gestisce le richieste di aggiornamento di elementi esistenti.
*
* @param array $request
*
* @return string
*/
public function update($request)
{
return $this->fileRequest($resource, 'update');
return $this->fileRequest($request, 'update');
}
public function delete($resource)
/**
* Gestisce le richieste di eliminazione di elementi esistenti.
*
* @param array $request
*
* @return string
*/
public function delete($request)
{
return $this->fileRequest($resource, 'delete');
return $this->fileRequest($request, 'delete');
}
protected function fileRequest($resource, $kind)
/**
* Gestisce le richieste in modo generalizzato, con il relativo richiamo ai file specifici responsabili dell'operazione.
*
* @param array $request
*
* @return string
*/
protected function fileRequest($request, $kind)
{
$resources = self::getResources()[$kind];
$resource = $request['resource'];
if (!in_array($resource, array_keys($resources))) {
return self::error('notFound');
@@ -157,10 +199,6 @@ class API extends \Util\Singleton
$dbo->query('START TRANSACTION');
// Variabili GET e POST
$post = Filter::getPOST();
$get = Filter::getGET();
$filename = DOCROOT.'/modules/'.$resources[$resource].'/api/'.$kind.'.php';
include $filename;
@@ -169,17 +207,31 @@ class API extends \Util\Singleton
return self::response($results);
}
/**
* Genera i contenuti di risposta nel caso si verifichi un errore.
*
* @param string|int $error
*
* @return string
*/
public static function error($error)
{
$keys = array_keys(self::$status);
$error = (in_array($error, $keys)) ? $error : end($keys);
http_response_code(self::$status[$error]['code']);
return self::response([
'status' => self::$status[$error]['code'],
'message' => self::$status[$error]['message'],
]);
}
/**
* Restituisce l'elenco delle risorse disponibili per l'API, suddivise per categoria.
*
* @return array
*/
public static function getResources()
{
if (!is_array(self::$resources)) {
@@ -217,6 +269,13 @@ class API extends \Util\Singleton
return self::$resources;
}
/**
* Formatta i contentuti della risposta secondo il formato JSON.
*
* @param array $array
*
* @return string
*/
public static function response($array)
{
if (empty($array['status'])) {
@@ -225,15 +284,38 @@ class API extends \Util\Singleton
}
$flags = JSON_FORCE_OBJECT;
if (filter('beautify') !== null) {
if (get('beautify') !== null) {
$flags |= JSON_PRETTY_PRINT;
}
return json_encode($array, $flags);
}
/**
* Restituisce l'elenco degli stati dell'API.
*
* @return array
*/
public static function getStatus()
{
return self::$status;
}
/**
* Controlla se la richiesta effettuata è rivolta all'API.
*
* @return bool
*/
public static function isAPIRequest()
{
return slashes($_SERVER['SCRIPT_FILENAME']) == slashes(DOCROOT.'/api/index.php');
}
/**
* Restituisce i parametri specificati dalla richiesta.
*/
public static function getRequest()
{
return (array) json_decode(file_get_contents('php://input'), true);
}
}

65
lib/classes/Auth.php
View File

@@ -7,6 +7,7 @@
*/
class Auth extends \Util\Singleton
{
/** @var array Stati previsti dal sistema di autenticazione */
protected static $status = [
'success' => [
'code' => 1,
@@ -26,12 +27,15 @@ class Auth extends \Util\Singleton
],
];
/** @var array Opzioni di sicurezza relative all'hashing delle password */
protected static $passwordOptions = [
'algorithm' => PASSWORD_BCRYPT,
'options' => [],
];
/** @var array Informazioni riguardanti l'utente autenticato */
protected $infos;
/** @var string Nome del primo modulo su cui l'utente ha permessi di navigazione */
protected $first_module;
protected function __construct()
@@ -40,7 +44,8 @@ class Auth extends \Util\Singleton
if ($database->isInstalled()) {
if (API::isAPIRequest()) {
$token = filter('token');
$token = API::getRequest()['token'];
$token = !empty($token) ? $token : get('token');
$id = $database->fetchArray('SELECT `id_utente` FROM `zz_tokens` WHERE `token` = '.prepare($token))[0]['id_utente'];
}
@@ -59,6 +64,14 @@ class Auth extends \Util\Singleton
}
}
/**
* Effettua un tentativo di accesso con le credenziali fornite.
*
* @param string $username
* @param string $password
*
* @return bool
*/
public function attempt($username, $password)
{
session_regenerate_id();
@@ -113,6 +126,13 @@ class Auth extends \Util\Singleton
return $this->isAuthenticated();
}
/**
* Controlla la corrispondeza delle password ed eventalmente effettua un rehashing.
*
* @param string $password
* @param string $hash
* @param int $user_id
*/
protected function password_check($password, $hash, $user_id = null)
{
$result = false;
@@ -140,6 +160,9 @@ class Auth extends \Util\Singleton
return $result;
}
/**
* Memorizza le informazioni riguardanti l'utente all'interno della sessione.
*/
protected function saveToSession()
{
foreach ($this->infos as $key => $value) {
@@ -153,6 +176,11 @@ class Auth extends \Util\Singleton
}
}
/**
* Identifica l'utente interessato dall'autenticazione.
*
* @param int $user_id
*/
protected function identifyUser($user_id)
{
$database = Database::getConnection();
@@ -165,21 +193,39 @@ class Auth extends \Util\Singleton
}
}
/**
* Controlla se l'utente è autenticato.
*
* @return bool
*/
public function isAuthenticated()
{
return !empty($this->infos);
}
/**
* Controlla se l'utente appartiene al gruppo degli Amministratori.
*
* @return bool
*/
public function isAdmin()
{
return $this->isAuthenticated() && !empty($this->infos['is_admin']);
}
/**
* Restituisce le informazioni riguardanti l'utente autenticato.
*
* @return array
*/
public function getUser()
{
return $this->infos;
}
/**
* Distrugge le informazioni riguardanti l'utente autenticato, forzando il logout.
*/
public function destory()
{
if ($this->isAuthenticated() || !empty($_SESSION['idutente'])) {
@@ -197,6 +243,11 @@ class Auth extends \Util\Singleton
}
}
/**
* Restituisce il nome del primo modulo navigabile dall'utente autenticato.
*
* @return string
*/
public function getFirstModule()
{
if (empty($this->first_module)) {
@@ -225,6 +276,13 @@ class Auth extends \Util\Singleton
return $this->first_module;
}
/**
* Restituisce l'hashing della password per la relativa memorizzazione nel database.
*
* @param string $password
*
* @return string
*/
public static function hashPassword($password)
{
return password_hash($password, self::$passwordOptions['algorithm'], self::$passwordOptions['options']);
@@ -255,6 +313,11 @@ class Auth extends \Util\Singleton
return self::getInstance()->getFirstModule();
}
/**
* Restituisce l'elenco degli stati del sistema di autenticazione.
*
* @return array
*/
public static function getStatus()
{
return self::$status;