source: admin/WebConsole/rest/server.php @ 3b5daf8

918-git-images-111dconfigfileconfigure-oglivegit-imageslgromero-new-oglivemainmaint-cronmount-efivarfsmultivmmultivm-ogboot-installerogClonningEngineogboot-installer-jenkinsoglive-ipv6test-python-scriptsticket-301ticket-50ticket-50-oldticket-577ticket-585ticket-611ticket-612ticket-693ticket-700ubu24tplunification2use-local-agent-oglivevarios-instalacionwebconsole3
Last change on this file since 3b5daf8 was 3b5daf8, checked in by ramon <ramongomez@…>, 9 years ago

#708: Continuar con la documentación de la API REST con Swagger; modificar la respuesta de la ruta GET /ous/:ouid/images/:imageid para normalizar la salida de datos.

git-svn-id: https://opengnsys.es/svn/branches/version1.1@5017 a21b9725-9963-47de-94b9-378ad31fedc9
  • Property mode set to 100644
File size: 29.8 KB
Line 
1<?php
2/**
3 * @file    index.php
4 * @brief   OpenGnsys REST API manager.
5 * @warning All input and output messages are formatted in JSON.
6 * @note    Some ideas are based on article "How to create REST API for Android app using PHP, Slim and MySQL" by Ravi Tamada, thanx.
7 * @license GNU GPLv3+
8 * @author  Ramón M. Gómez, ETSII Univ. Sevilla
9 * @version 1.1.0 - Primera versión para OpenGnsys
10 * @date    2016-09-19
11 */
12
13
14// Auxiliar functions.
15
16/**
17 * @brief   Compose JSON response.
18 * @param   int status      Status code for HTTP response.
19 * @param   array response  Response data.
20 * @return  string          JSON response.
21 */
22function jsonResponse($status, $response) {
23        $app = \Slim\Slim::getInstance();
24        // HTTP status code.
25        $app->status($status);
26        // Content-type HTTP header.
27        $app->contentType('application/json');
28        // JSON response.
29        echo json_encode($response);
30}
31
32/**
33 * @brief    Validate API key included in "Authorization" HTTP header.
34 * @return   JSON response on error.
35 */
36function validateApiKey() {
37        global $cmd;
38        global $userid;
39        $response = array();
40
41        // Read Authorization HTTP header.
42        $headers = apache_request_headers();
43        if (! empty($headers['Authorization'])) {
44                // Assign user id. that match this key to global variable.
45                $apikey = htmlspecialchars($headers['Authorization']);
46                $cmd->texto = "SELECT idusuario
47                                 FROM usuarios
48                                WHERE apikey='$apikey'";
49                $rs=new Recordset;
50                $rs->Comando=&$cmd;
51                if ($rs->Abrir()) {
52                        $rs->Primero();
53                        if (!$rs->EOF){
54                                // Fetch user id.
55                                $userid = $rs->campos["idusuario"];
56                        } else {
57                                // Credentials error.
58                                $response['message'] = 'Login failed. Incorrect credentials';
59                                jsonResponse(401, $response);
60                                $app->stop();
61                        }
62                        $rs->Cerrar();
63                } else {
64                        // Access error.
65                        $response['message'] = "An error occurred, please try again";
66                        jsonResponse(500, $response);
67                }
68        } else {
69                // Error: missing API key.
70                $response['message'] = 'Missing API key';
71                jsonResponse(400, $response);
72                $app->stop();
73        }
74}
75
76/**
77 * @brief    Check if parameter is set and print error messages if empty.
78 * @param    string param    Parameter to check.
79 * @return   boolean         "false" if parameter is null, otherwise "true".
80 */
81function checkParameter($param) {
82        if (isset($param)) {
83                return true;
84        } else {
85                // Print error message.
86                $response['message'] = 'Parameter not found';
87                jsonResponse(400, $response);
88                return false;
89        }
90}
91
92/**
93 * @brief    Check if user is administrator and print error messages if not.
94 * @param    int adminid   Administrator id.
95 * @return   boolean       "true" if admin id. is equals to global user id., otherwise "false".
96 */
97function checkAdmin($adminid) {
98        global $userid;
99
100        if ($adminid == $userid) {
101                return true;
102        } else {
103                // Print error message.
104                $response['message'] = 'Cannot access this resource';
105                jsonResponse(401, $response);
106                return false;
107        }
108}
109
110
111/**
112 * @fn       sendCommand($serverip, $serverport, $reqframe, &$values)
113 * @brief    Send a command to an OpenGnsys ogAdmServer and get request.
114 * @param    string serverip    Server IP address.
115 * @param    string serverport  Server port.
116 * @param    string reqframe    Request frame (field's separator is "\r").
117 * @param    array values       Response values (out parameter).
118 * @return   boolean            "true" if success, otherwise "false".
119 */
120function sendCommand($serverip, $serverport, $reqframe, &$values) {
121        global $LONCABECERA;
122        global $LONHEXPRM;
123
124        // Connect to server.
125        $respvalues = "";
126        $connect = new SockHidra($serverip, $serverport);
127        if ($connect->conectar()) {
128                // Send request frame to server.
129                $result = $connect->envia_peticion($reqframe);
130                if ($result) {
131                        // Parse request frame.
132                        $respframe = $connect->recibe_respuesta();
133                        $connect->desconectar();
134                        $paramlen = hexdec(substr($respframe, $LONCABECERA, $LONHEXPRM));
135                        $params = substr($respframe, $LONCABECERA+$LONHEXPRM, $paramlen);
136                        // Fetch values and return result.
137                        $values = extrae_parametros($params, "\r", '=');
138                        return ($values);
139                } else {
140                        // Return with error.
141                        return (false);
142                }
143        } else {
144                // Return with error.
145                return (false);
146        }
147}
148
149// Define REST routes.
150
151/**
152 * @brief    user login.
153 * @note     Route: /login, Method: POST
154 * @param    string username   User name.
155 * @param    string password   User password.
156 * @return   string            JSON response with user id. and API key.
157 * @note     User's API key is stored in a new field of "usuarios" table.
158 */
159$app->post('/login',
160    function() use ($app) {
161        global $cmd;
162        global $userid;
163
164        $response = array();
165
166        // Reading JSON parameters.
167        try {
168                $input = json_decode($app->request()->getBody());
169                $user = htmlspecialchars($input->username);
170                $pass = htmlspecialchars($input->password);
171        } catch (Exception $e) {
172                // Error message.
173                $response["message"] = $e->getMessage();
174                jsonResponse(400, $response);
175                $app->stop();
176        }
177
178        // Check parameters.
179        if (! empty($user) and ! empty($pass)) {
180                // Database query.
181                $cmd->texto = "SELECT idusuario, apikey
182                                 FROM usuarios
183                                WHERE usuario='$user' AND pasguor='$pass'";
184                $rs=new Recordset;
185                $rs->Comando=&$cmd;
186                if ($rs->Abrir()) {
187                        $rs->Primero();
188                        if (!$rs->EOF){
189                                // JSON response.
190                                $userid=$rs->campos["idusuario"];
191                                $apikey=$rs->campos["apikey"];
192                                $response['userid'] = $userid;
193                                $response['apikey'] = $apikey;
194                                jsonResponse(200, $response);
195                        } else {
196                                // Credentials error.
197                                $response['message'] = 'Login failed. Incorrect credentials';
198                                jsonResponse(401, $response);
199                                $app->stop();
200                        }
201                        $rs->Cerrar();
202                } else {
203                        // Access error.
204                        $response['message'] = "An error occurred. Please try again";
205                        jsonResponse(500, $response);
206                        $app->stop();
207                }
208        } else {
209                # Error: missing some input parameter.
210                $response['message'] = 'Missing username or password';
211                jsonResponse(400, $response);
212                $app->stop();
213        }
214    }
215);
216
217/**
218 * @brief    List all defined Organizational Units
219 * @note     Route: /ous, Method: GET
220 * @param    no
221 * @return   JSON array with id. and name for every defined OU
222 */
223$app->get('/ous', function() {
224        global $cmd;
225
226        $cmd->texto = "SELECT * FROM centros";
227        $rs=new Recordset;
228        $rs->Comando=&$cmd;
229        if (!$rs->Abrir()) return(false); // Error al abrir recordset
230        $response = array();
231        $rs->Primero();
232        while (!$rs->EOF) {
233                $tmp = array();
234                $tmp['id'] = $rs->campos["idcentro"];
235                $tmp['name'] = $rs->campos["nombrecentro"];
236                array_push($response, $tmp);
237                $rs->Siguiente();
238        }
239        $rs->Cerrar();
240        jsonResponse(200, $response);
241}
242);
243
244/**
245 * @brief    Get Organizational Unit data
246 * @note     Route: /ous/id, Method: GET
247 * @param    id      OU id.
248 * @return   JSON string with OU's parameters
249 */
250$app->get('/ous/:ouid', 'validateApiKey',
251    function($ouid) {
252        global $cmd;
253
254        $ouid = htmlspecialchars($ouid);
255        $cmd->texto = "SELECT * FROM centros WHERE idcentro='$ouid';";
256        $rs=new Recordset;
257        $rs->Comando=&$cmd;
258        if (!$rs->Abrir()) return(false); // Error al abrir recordset
259        $rs->Primero();
260        if (checkParameter($rs->campos["nombrecentro"])) {
261                $response['id'] = $ouid;
262                $response['name'] = $rs->campos["nombrecentro"];
263                $response['description'] = $rs->campos["comentarios"];
264                jsonResponse(200, $response);
265        }
266        $rs->Cerrar();
267    }
268);
269
270/**
271 * @brief    List all labs defined in an OU
272 * @note     Route: /ous/id/labs, Method: GET
273 * @param    id      OU id.
274 * @return   JSON string with all UO's labs parameters
275 */
276$app->get('/ous/:ouid/labs', 'validateApiKey',
277    function($ouid) {
278        global $cmd;
279
280        $ouid = htmlspecialchars($ouid);
281        // Listar las salas de la UO si el usuario de la apikey es su admin.
282        $cmd->texto = <<<EOD
283SELECT aulas.*, adm.idadministradorcentro
284  FROM aulas
285 RIGHT JOIN administradores_centros AS adm USING(idcentro)
286 RIGHT JOIN usuarios USING(idusuario)
287 WHERE idcentro='$ouid';
288EOD;
289        $rs=new Recordset;
290        $rs->Comando=&$cmd;
291        if (!$rs->Abrir()) return(false);       // Error al abrir recordset
292        // Comprobar que exista la UO y que el usuario sea su administrador.
293        $rs->Primero();
294        if (checkParameter($rs->campos["idcentro"]) and checkAdmin($rs->campos["idadministradorcentro"])) {
295                $response = array();
296                while (!$rs->EOF) {
297                        $tmp = array();
298                        $tmp['id'] = $rs->campos["idaula"];
299                        $tmp['name'] = $rs->campos["nombreaula"];
300                        $tmp['inremotepc'] = $rs->campos["inremotepc"]==0 ? false: true;
301                        $tmp['ou']['id'] = $ouid;
302                        array_push($response, $tmp);
303                        $rs->Siguiente();
304                }
305                jsonResponse(200, $response);
306        }
307        $rs->Cerrar();
308    }
309);
310
311/**
312 * @brief    Get lab data
313 * @note     Route: /ous/id1/labs/id2, Method: GET
314 * @param    id1     OU id.
315 * @param    id2     lab id.
316 * @return   JSON string with lab parameters
317 */
318$app->get('/ous/:ouid/labs/:labid', 'validateApiKey',
319    function($ouid, $labid) {
320        global $cmd;
321
322        $ouid = htmlspecialchars($ouid);
323        $labid = htmlspecialchars($labid);
324        $cmd->texto = <<<EOD
325SELECT COUNT(idordenador) AS defclients, aulas.*, adm.idadministradorcentro
326  FROM aulas
327 RIGHT JOIN administradores_centros AS adm USING(idcentro)
328 RIGHT JOIN usuarios USING(idusuario)
329  LEFT JOIN ordenadores USING(idaula)
330 WHERE idcentro='$ouid'
331   AND idaula='$labid';
332EOD;
333        $rs=new Recordset;
334        $rs->Comando=&$cmd;
335        if (!$rs->Abrir()) return(false); // Error al abrir recordset
336        $rs->Primero();
337        if (checkParameter($rs->campos["idaula"]) and checkAdmin($rs->campos["idadministradorcentro"])) {
338                $response['id'] = $rs->campos["idaula"];
339                $response['name'] = $rs->campos["nombreaula"];
340                $response['location'] = $rs->campos["ubicacion"];
341                $response['description'] = $rs->campos["comentarios"];
342                $response['inremotepc'] = $rs->campos["inremotepc"]==0 ? false: true;
343                $response['capacity'] = $rs->campos["puestos"];
344                $response['defclients'] = $rs->campos["defclients"];
345                $response['projector'] = $rs->campos["cagnon"]==0 ? false: true;
346                $response['board'] = $rs->campos["pizarra"]==0 ? false: true;
347                $response['routerip'] = $rs->campos["router"];
348                $response['netmask'] = $rs->campos["netmask"];
349                $response['ntp'] = $rs->campos["ntp"];
350                $response['dns'] = $rs->campos["dns"];
351                $response['proxyurl'] = $rs->campos["proxy"];
352                switch ($rs->campos["modomul"]) {
353                        case 1:  $response['mcastmode'] = "half-duplex"; break;
354                        case 2:  $response['mcastmode'] = "full-duplex"; break;
355                        default: $response['mcastmode'] = $rs->campos["modomul"];
356                }
357                $response['mcastip'] = $rs->campos["ipmul"];
358                $response['mcastport'] = $rs->campos["pormul"];
359                $response['mcastspeed'] = $rs->campos["velmul"];
360                $response['p2pmode'] = $rs->campos["modp2p"];
361                $response['p2ptime'] = $rs->campos["timep2p"];
362                $response['image'] = $rs->campos["urlfoto"];
363                jsonResponse(200, $response);
364        }
365        $rs->Cerrar();
366    }
367);
368
369// Listar clientes de un aula.
370$app->get('/ous/:ouid/labs/:labid/clients', 'validateApiKey',
371    function($ouid, $labid) {
372        global $cmd;
373
374        $ouid = htmlspecialchars($ouid);
375        $labid = htmlspecialchars($labid);
376        // Listar los clientes del aula si el usuario de la apikey es admin de su UO.
377        $cmd->texto = <<<EOD
378SELECT ordenadores.*, adm.idadministradorcentro
379  FROM ordenadores
380  JOIN aulas USING(idaula)
381 RIGHT JOIN administradores_centros AS adm USING(idcentro)
382 RIGHT JOIN usuarios USING(idusuario)
383 WHERE idcentro='$ouid'
384   AND idaula='$labid';
385EOD;
386        $rs=new Recordset;
387        $rs->Comando=&$cmd;
388        if (!$rs->Abrir()) return(false);       // Recordset open error.
389        $rs->Primero();
390        if (checkParameter($rs->campos["idaula"]) and checkAdmin($rs->campos["idadministradorcentro"])) {
391                $response['ouid'] = $ouid;
392                $response['labid'] = $labid;
393                $response = array();
394                while (!$rs->EOF) {
395                        $tmp = array();
396                        $tmp['id'] = $rs->campos["idordenador"];
397                        $tmp['name'] = $rs->campos["nombreordenador"];
398                        $tmp['ou']['id'] = $ouid;
399                        $tmp['lab']['id'] = $labid;
400                        array_push($response, $tmp);
401                        $rs->Siguiente();
402                }
403                jsonResponse(200, $response);
404        }
405        $rs->Cerrar();
406    }
407);
408
409// Obtener datos de un cliente.
410$app->get('/ous/:ouid/labs/:labid/clients/:clntid', 'validateApiKey',
411    function($ouid, $labid, $clntid) {
412        global $cmd;
413
414        $ouid = htmlspecialchars($ouid);
415        $labid = htmlspecialchars($labid);
416        $clntid = htmlspecialchars($clntid);
417        // Obtener datos del cliente del aula si el usuario de la apikey es admin de su UO.
418        $cmd->texto = <<<EOD
419SELECT ordenadores.*, adm.idadministradorcentro
420  FROM ordenadores
421  JOIN aulas USING(idaula)
422 RIGHT JOIN administradores_centros AS adm USING(idcentro)
423 RIGHT JOIN usuarios USING(idusuario)
424 WHERE idcentro='$ouid'
425   AND idaula='$labid'
426   AND idordenador='$clntid';
427EOD;
428        $rs=new Recordset;
429        $rs->Comando=&$cmd;
430        if (!$rs->Abrir()) return(false); // Error al abrir recordset
431        $rs->Primero();
432        if (checkParameter($rs->campos["idordenador"]) and checkParameter($rs->campos["idaula"]) and checkAdmin($rs->campos["idadministradorcentro"])) {
433                $response['id'] = $rs->campos["idordenador"];
434                $response['name'] = $rs->campos["nombreordenador"];
435                $response['serialno'] = $rs->campos["numserie"];
436                $response['netiface'] = $rs->campos["netiface"];
437                $response['netdriver'] = $rs->campos["netdriver"];
438                $response['mac'] = $rs->campos["mac"];
439                $response['ip'] = $rs->campos["ip"];
440                $response['netmask'] = $rs->campos["mascara"];
441                $response['routerip'] = $rs->campos["router"];
442                $response['repo']['id'] = $rs->campos["idrepositorio"];
443                //$response['hardprofile']['id'] = $rs->campos["idperfilhard"];
444                //$response['menu']['id'] = $rs->campos["idmenu"];
445                $response['validation'] = $rs->campos["validacion"]==0 ? false: true;
446                $response['boottype'] = $rs->campos["arranque"];
447                $response['image'] = $rs->campos["fotoord"];
448                jsonResponse(200, $response);
449        }
450        $rs->Cerrar();
451    }
452);
453
454// Obtener la configuración de hardware de un cliente.
455$app->get('/ous/:ouid/labs/:labid/clients/:clntid/hardware', 'validateApiKey',
456    function($ouid, $labid, $clntid) {
457        global $cmd;
458
459        $ouid = htmlspecialchars($ouid);
460        $labid = htmlspecialchars($labid);
461        $clntid = htmlspecialchars($clntid);
462        $cmd->texto = <<<EOD
463SELECT ordenadores.idordenador, ordenadores.nombreordenador,
464       tipohardwares.nemonico, hardwares.descripcion
465  FROM perfileshard
466 RIGHT JOIN ordenadores USING(idperfilhard)
467  JOIN perfileshard_hardwares USING(idperfilhard)
468  JOIN hardwares ON perfileshard_hardwares.idhardware=hardwares.idhardware
469  JOIN tipohardwares ON tipohardwares.idtipohardware=hardwares.idtipohardware
470 WHERE ordenadores.idordenador='$clntid'
471EOD;
472        $rs=new Recordset;
473        $rs->Comando=&$cmd;
474        if (!$rs->Abrir()) return(false); // Error al abrir recordset
475        $rs->Primero();
476//      if ($ouid != $rs->campos["idcentro"]) ...
477//      if ($labid != $rs->campos["idaula"]) ...
478        if (checkParameter($rs->campos["idordenador"])) {
479                $response['id'] = $rs->campos["idordenador"];
480                $response['name'] = $rs->campos["nombreordenador"];
481                $response['hardware'] = array();
482                while (!$rs->EOF) {
483                        $tmp = array();
484                        $tmp['type'] = $rs->campos["nemonico"];
485                        $tmp['description'] = $rs->campos["descripcion"];
486                        array_push($response['hardware'], $tmp);
487                        $rs->Siguiente();
488                }
489                jsonResponse(200, $response);
490        }
491        $rs->Cerrar();
492    }
493);
494
495// Obtener datos de configuración de discos del cliente.
496$app->get('/ous/:ouid/labs/:labid/clients/:clntid/diskcfg', 'validateApiKey',
497    function($ouid, $labid, $clntid) {
498        global $cmd;
499
500        $ouid = htmlspecialchars($ouid);
501        $labid = htmlspecialchars($labid);
502        $clntid = htmlspecialchars($clntid);
503        $cmd->texto = <<<EOD
504SELECT ordenadores.idordenador AS clientid, ordenadores.nombreordenador,
505       ordenadores_particiones.*, tipospar.tipopar,
506       sistemasficheros.nemonico, nombresos.nombreso, imagenes.nombreca
507  FROM ordenadores_particiones
508 RIGHT JOIN ordenadores USING(idordenador)
509  LEFT JOIN tipospar USING(codpar)
510  LEFT JOIN sistemasficheros USING(idsistemafichero)
511  LEFT JOIN nombresos USING(idnombreso)
512  LEFT JOIN imagenes USING(idimagen)
513 WHERE ordenadores.idordenador='$clntid'
514 ORDER BY numdisk ASC, numpar ASC;
515EOD;
516        $rs=new Recordset;
517        $rs->Comando=&$cmd;
518        if (!$rs->Abrir()) return(false); // Error al abrir recordset
519        $rs->Primero();
520//      if ($labid != $rs->campos["idaula"]) ...
521        if (checkParameter($rs->campos["clientid"])) {
522                $response['id'] = $rs->campos["clientid"];
523                $response['name'] = $rs->campos["nombreordenador"];
524                $response['diskcfg'] = array();
525                while (!$rs->EOF) {
526                        if ($rs->campos["numdisk"] == 0) {
527                                $rs->Siguiente();
528                                continue;
529                        }
530                        $tmp = array();
531                        if ($rs->campos["numpar"] == 0) {
532                                $tmp['disk'] = $rs->campos["numdisk"];
533                                switch ($rs->campos["codpar"]) {
534                                        case 1:  $tmp['parttable'] = "MSDOS"; break;
535                                        case 2:  $tmp['parttable'] = "GPT"; break;
536                                        case 3:  $tmp['parttable'] = "LVM"; break;
537                                        case 4:  $tmp['parttable'] = "ZPOOL"; break;
538                                        default: $tmp['parttable'] = $rs->campos["codpar"];
539                                }
540                                $tmp['size'] = $rs->campos["tamano"];
541                        } else {
542                                $tmp['partition'] = $rs->campos["numpar"];
543                                $tmp['parttype'] = $rs->campos["tipopar"];
544                                $tmp['filesystem'] = $rs->campos["nemonico"];
545                                $tmp['size'] = $rs->campos["tamano"];
546                                $tmp['usage'] = $rs->campos["uso"];
547                                if ($rs->campos["nombreso"] != null) {
548                                        $tmp['os'] = $rs->campos["nombreso"];
549                                        $tmp['imageid'] = $rs->campos["idimagen"];
550                                        $tmp['deploydate'] = $rs->campos["fechadespliegue"];
551                                        // Comprobar si la imagen está actualizada.
552                                        $tmp['updated'] = ($rs->campos["difimagen"]>0 ? "false" : "true");
553                                }
554                                //$tmp['cachedata'] = $rs->campos["cache"];
555                        }
556                        array_push($response['diskcfg'], $tmp);
557                        $rs->Siguiente();
558                }
559                jsonResponse(200, $response);
560        }
561        $rs->Cerrar();
562    }
563);
564
565// Obtener estado de ejecución del cliente.
566$app->get('/ous/:ouid/labs/:labid/clients/:clntid/status', 'validateApiKey',
567    function($ouid, $labid, $clntid) {
568        global $cmd;
569        global $LONCABECERA;
570        global $LONHEXPRM;
571
572        // Parameters.
573        $ouid = htmlspecialchars($ouid);
574        $labid = htmlspecialchars($labid);
575        $clntid = htmlspecialchars($clntid);
576
577        // Database query.
578        $cmd->texto = <<<EOD
579SELECT serv.ipserveradm, serv.portserveradm, clnt.idordenador, clnt.ip
580  FROM entornos AS serv, ordenadores AS clnt
581 WHERE clnt.idordenador='$clntid';
582EOD;
583        $rs=new Recordset;
584        $rs->Comando=&$cmd;
585        if (!$rs->Abrir()) return(false); // Error al abrir recordset
586        $rs->Primero();
587        if (checkParameter($rs->campos["idordenador"])) {
588                //
589                // Probar primero el estado de OGAgent y luego de ogAdmClient
590                //
591
592                $serverip = $rs->campos["ipserveradm"];
593                $serverport = $rs->campos["portserveradm"];
594                $clientid = $rs->campos["idordenador"];
595                $clientip = $rs->campos["ip"];
596
597                // Connect to reset client's status.
598                $reqframe = "nfn=Sondeo\r".
599                            "ido=$clientid\r".
600                            "iph=$clientip\r";
601                $result = sendCommand($serverip, $serverport, $reqframe, $values);
602
603                // Connect to fetch client's status.
604                // Asuming client is off by default.
605                $values["tso"]="OFF";
606                // Iterate to check client's status.
607                // Exit if status!=OFF or end iterations (status=OFF).
608                $maxIter = 30;
609                for ($i=1; $i<$maxIter and preg_match('/OFF/', $values["tso"]); $i++) {
610                        // Connect to check status.
611                        $reqframe = "nfn=respuestaSondeo\r".
612                                    "ido=$clientid\r".
613                                    "iph=$clientip\r";
614                        $result = sendCommand($serverip, $serverport, $reqframe, $values);
615                        // Wait until next checking (0.1 ms).
616                        usleep(100000);
617                }
618
619                // Parse status response.
620                if ($result) {
621                        // Check status type.
622                        if (checkParameter($values["tso"])) {
623                                // Compose JSON response.
624                                $response['id'] = $clientid;
625                                $response['ip'] = $clientip;
626                                $stat = array();
627                                preg_match('/\/[A-Z]*;/', $values["tso"], $stat);
628                                // Check if data exists.
629                                if (empty($stat[0])) {
630                                        $response['status'] = "nodata";
631                                } else {
632                                        // Status mapping.
633                                        $status = array('OFF'=>"off",
634                                                        'INI'=>"initializing",
635                                                        'OPG'=>"ogclient",
636                                                        'BSY'=>"busy",
637                                                        'LNX'=>"linux",
638                                                        'WIN'=>"windows");
639                                        $response['status'] = $status[substr($stat[0], 1, 3)];
640                                        if (empty($response['status'])) {
641                                                $response['status'] = "unknown";
642                                        }
643                                }
644                                jsonResponse(200, $response);
645                        }
646                } else {
647                        // Access error.
648                        $response['message'] = "Cannot access to OpenGnsys server";
649                        jsonResponse(500, $response);
650                }
651        }
652        $rs->Cerrar();
653    }
654);
655
656
657// Listar repositorios.
658$app->get('/ous/:ouid/repos', 'validateApiKey',
659    function($ouid) {
660        global $cmd;
661
662        $ouid = htmlspecialchars($ouid);
663        // Listar las salas de la UO si el usuario de la apikey es su admin.
664        // Consulta temporal,
665        $cmd->texto = "SELECT * FROM repositorios WHERE idcentro='$ouid';";
666        $rs=new Recordset;
667        $rs->Comando=&$cmd;
668        if (!$rs->Abrir()) return(false); // Error al abrir recordset
669        $rs->Primero();
670        // Comprobar que exista la UO.
671        if (checkParameter($rs->campos["idcentro"])) {
672                $response = array();
673                while (!$rs->EOF) {
674                        $tmp = array();
675                        $tmp['id'] = $rs->campos["idrepositorio"];
676                        $tmp['name'] = $rs->campos["nombrerepositorio"];
677                        $tmp['ou']['id'] = $ouid;
678                        array_push($response, $tmp);
679                        $rs->Siguiente();
680                }
681                jsonResponse(200, $response);
682        }
683        $rs->Cerrar();
684    }
685);
686
687// Obtener datos de un repositorio.
688$app->get('/ous/:ouid/repos/:repoid', 'validateApiKey',
689    function($ouid, $repoid) {
690        global $cmd;
691
692        $ouid = htmlspecialchars($ouid);
693        $repoid = htmlspecialchars($repoid);
694        $cmd->texto = "SELECT * FROM repositorios WHERE idrepositorio='$repoid';";
695        $rs=new Recordset;
696        $rs->Comando=&$cmd;
697        if (!$rs->Abrir()) return(false); // Error al abrir recordset
698        $rs->Primero();
699        // Comprobar que exista el repositorio.
700        if (checkParameter($rs->campos["idrepositorio"])) {
701                $response['id'] = $rs->campos["idrepositorio"];
702                $response['name'] = $rs->campos["nombrerepositorio"];
703                $response['description'] = $rs->campos["comentarios"];
704                $response['ip'] = $rs->campos["ip"];
705                //$response['port'] = $rs->campos["puertorepo"];
706                jsonResponse(200, $response);
707        }
708        $rs->Cerrar();
709    }
710);
711
712// Listar imágenes.
713$app->get('/ous/:ouid/images', 'validateApiKey',
714    function($ouid) {
715        global $cmd;
716
717        $ouid = htmlspecialchars($ouid);
718        // Listar las salas de la UO si el usuario de la apikey es su admin.
719        // Consulta temporal,
720        $cmd->texto = "SELECT * FROM imagenes WHERE idcentro='$ouid';";
721        $rs=new Recordset;
722        $rs->Comando=&$cmd;
723        if (!$rs->Abrir()) return(false); // Error al abrir recordset
724        // Comprobar que exista la UO.
725        $rs->Primero();
726        if (checkParameter($rs->campos["idcentro"])) {
727                $response = array();
728                while (!$rs->EOF) {
729                        $tmp = array();
730                        $tmp['id'] = $rs->campos["idimagen"];
731                        $tmp['name'] = $rs->campos["nombreca"];
732                        $tmp['inremotepc'] = $rs->campos["inremotepc"]==0 ? false: true;
733                        $tmp['ou']['id'] = $ouid;
734                        array_push($response, $tmp);
735                        $rs->Siguiente();
736                }
737                jsonResponse(200, $response);
738        }
739    }
740);
741
742// Obtener datos de una imagen.
743$app->get('/ous/:ouid/images/:imgid', 'validateApiKey',
744    function($ouid, $imgid) {
745        global $cmd;
746
747        $ouid = htmlspecialchars($ouid);
748        $imgid = htmlspecialchars($imgid);
749        $cmd->texto = "SELECT * FROM imagenes WHERE idimagen='$imgid';";
750        $rs=new Recordset;
751        $rs->Comando=&$cmd;
752        if (!$rs->Abrir()) return(false); // Error al abrir recordset
753        $rs->Primero();
754        // Comprobar que exista el repositorio.
755        if (checkParameter($rs->campos["idimagen"])) {
756                $response['id'] = $rs->campos["idimagen"];
757                $response['name'] = $rs->campos["nombreca"];
758                $response['description'] = $rs->campos["descripcion"];
759                $response['comments'] = $rs->campos["comentarios"];
760                $response['inremotepc'] = $rs->campos["inremotepc"]==0 ? false: true;
761                $response['repo']['id'] = $rs->campos["idrepositorio"];
762                switch ($rs->campos["tipo"]) {
763                        case 1:  $response['type'] = "monolithic"; break;
764                        case 2:  $response['type'] = "base"; break;
765                        case 3:  $response['type'] = "incremental";
766                                 $response['baseimg'] = $rs->campos["imagenid"];
767                                 $response['path'] = $rs->campos["ruta"];
768                                 break;
769                        default: $response['type'] = $rs->campos["tipo"];
770                }
771                if ($rs->campos["idordenador"] != 0) {
772                        $response['client']['id'] = $rs->campos["idordenador"];
773                        $response['client']['disk'] = $rs->campos["numdisk"];
774                        $response['client']['partition'] = $rs->campos["numpar"];
775                        $response['creationdate'] = $rs->campos["fechacreacion"];
776                        $response['release'] = $rs->campos["revision"];
777                }
778                jsonResponse(200, $response);
779        }
780        $rs->Cerrar();
781    }
782);
783
784// Lista de softeare instalado en una imagen.
785$app->get('/ous/:ouid/images/:imgid/software', 'validateApiKey',
786    function($ouid, $imgid) {
787        global $cmd;
788
789        $ouid = htmlspecialchars($ouid);
790        $imgid = htmlspecialchars($imgid);
791        $cmd->texto = <<<EOD
792SELECT imagenes.idimagen, imagenes.nombreca, nombresos.nombreso, softwares.descripcion
793  FROM perfilessoft
794 RIGHT JOIN imagenes USING(idperfilsoft)
795  LEFT JOIN nombresos USING(idnombreso)
796  LEFT JOIN perfilessoft_softwares USING(idperfilsoft)
797  LEFT JOIN softwares USING(idsoftware)
798 WHERE imagenes.idimagen='$imgid'
799 ORDER BY softwares.descripcion ASC;
800EOD;
801        $rs=new Recordset;
802        $rs->Comando=&$cmd;
803        if (!$rs->Abrir()) return(false);       // Error al abrir recordset
804        $rs->Primero();
805        // Comprobar que exista el repositorio.
806        if (checkParameter($rs->campos["idimagen"])) {
807                $response['id'] = $rs->campos["idimagen"];
808                $response['name'] = $rs->campos["nombreca"];
809                $response['os'] = $rs->campos["nombreso"];
810                //$response['ostype'] = Tipo de SO (agrupar en array con nombre SO).
811                $response['software'] = array();
812                while (!$rs->EOF) {
813                        if ($rs->campos["descripcion"] == null) {
814                                $rs->Siguiente();
815                                continue;
816                        }
817                        $tmp = array();
818                        $tmp['application'] = $rs->campos["descripcion"];
819                        array_push($response['software'], $tmp);
820                        $rs->Siguiente();
821                }
822                jsonResponse(200, $response);
823        }
824        $rs->Cerrar();
825    }
826);
827
828// Arrancar un ordenador con una imagen instalada, elegido al azar.
829$app->get('/ous/:id1/images/:id2/boot', 'validateApiKey',
830    function($ouid, $imageid) {
831        global $cmd;
832        global $AMBITO_ORDENADORES;
833        global $EJECUCION_COMANDO;
834        global $ACCION_INICIADA;
835        global $ACCION_SINRESULTADO;
836
837        // Pparameters.
838        $ouid = htmlspecialchars($ouid);
839        $imegeid = htmlspecialchars($imageid);
840        // Boot 1 client.
841        $nclients = 1;
842
843        // Query: server data and all clients' boot data availabe for Remote PC with this image installed (random order).
844        $cmd->texto = <<<EOD
845SELECT s.ipserveradm, s.portserveradm,
846       c.idordenador, c.ip, c.mac, p.numdisk, p.numpar
847  FROM entornos AS s, ordenadores AS c
848  JOIN aulas USING(idaula)
849  JOIN centros USING(idcentro)
850  JOIN ordenadores_particiones AS p USING(idordenador)
851  JOIN imagenes USING(idimagen)
852 WHERE centros.idcentro='$ouid'
853   AND aulas.inremotepc=1
854   AND imagenes.idimagen='$imageid'
855   AND imagenes.inremotepc=1
856 ORDER BY RAND();
857EOD;
858        $rs=new Recordset;
859        $rs->Comando=&$cmd;
860        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
861        $rs->Primero();
862        if (checkParameter($rs->campos["ipserveradm"])) {
863
864                $response['imageid'] = $imageid;
865                $response['sendto'] = array();
866
867                // AVISO: Procesar datos del servidor (solo 1er registro).
868
869                $serverip = $rs->campos["ipserveradm"];
870                $serverport = $rs->campos["portserveradm"];
871
872                // AVISO: Procesar datos de los clientes.
873
874                $clientid = array();
875                $clientip = array();
876                $clientmac = array();
877                $clientdisk = array();
878                $clientpart = array();
879                while (!$rs->EOF) {
880                        array_push($clientid, $rs->campos["idordenador"]);
881                        array_push($clientip, $rs->campos["ip"]);
882                        array_push($clientmac, $rs->campos["mac"]);
883                        array_push($clientdisk, $rs->campos["numdisk"]);
884                        array_push($clientpart, $rs->campos["numpar"]);
885                        $rs->Siguiente();
886                }
887                $rs->Cerrar();
888
889                // AVISO: consultar el estado de todos los clientes y
890                //        quitar aquellos que no tengan "OFF", "OPG" o ""
891                //        (estudiar si incluir los "BSY")
892
893                // Reset clients' status.
894                $reqframe = "nfn=Sondeo\r".
895                            "ido=".implode(',', $clientid)."\r".
896                            "iph=".implode(';', $clientip)."\r";
897                sendCommand($serverip, $serverport, $reqframe, $values);
898                 // Wait to get response.
899                sleep(3);
900                // Connect to check status.
901                $reqframe = "nfn=respuestaSondeo\r".
902                            "ido=".implode(',', $clientid)."\r".
903                            "iph=".implode(';', $clientip)."\r";
904                sendCommand($serverip, $serverport, $reqframe, $values);
905                // Check status type.
906                if (isset($values["tso"])) {
907                        preg_match_all('/[A-Z]{3}/', $values["tso"], $stat);
908                }
909                if (isset($stat[0])) {
910                        for ($i=0; $i<sizeof($stat[0]); $i++) {
911                                if (! in_array($stat[0][$i], array("OFF", "OPG", ""))) {
912                                        unset($clientid[$i]);
913                                        unset($clientip[$i]);
914                                        unset($clientmac[$i]);
915                                        unset($clientdisk[$i]);
916                                        unset($clientpart[$i]);
917                                }
918                        }
919                }
920
921                // AVISO: el siguiente código inicia un único cliente.
922                //        Para iniciar varios:
923                //        - id. clientes separados por carácter ','.
924                //        - IP clientes separadas por carácter ';'
925                //        - MAC clientes separadas por carácter ';'
926
927                // Executing boot command.
928                $reqframe = "nfn=Arrancar\r".
929                            "ido=".implode(',', $clientid)."\r".
930                            "iph=".implode(';', $clientip)."\r".
931                            "mac=".implode(';', $clientmac)."\r".
932                            "mar=1\r";
933echo "req=".str_replace("\r"," ",$reqframe).".\n";
934                sendCommand($serverip, $serverport, $reqframe, $values);
935                if ($values["res"]) {
936print_r($values);
937                        $tmp = array();
938                        for ($i=0, $boot=0; $i<sizeof($clientid) and $boot!=1; $i++) {
939                                $reqframe = "nfn=IniciarSesion\r".
940                                            "ido=".$clientid[$i]."\r".
941                                            "iph=".$clientip[$i]."\r".
942                                            "dsk=".$clientdisk[$i]."\r".
943                                            "par=".$clientpart[$i]."\r";
944echo "i=$i: req=".str_replace("\r"," ",$reqframe).".\n";
945                                sendCommand($serverip, $serverport, $reqframe, $values);
946                                if ($values["res"]) {
947
948                                        // AVISO: incluir comando Iniciar sesión en cola de acciones.
949                                        $timestamp=time();
950                                        $cmd->texto = <<<EOD
951INSERT INTO acciones
952        SET tipoaccion=$EJECUCION_COMANDO,
953            idtipoaccion=9,
954            idcomando=9,
955            parametros='nfn=IniciarSesion\rdsk=$clientdisk[$i]\rpar=$clientpart[$i]',
956            descriaccion='RemotePC Session',
957            idordenador=$clientid[$i],
958            ip='$clientip[$i]',
959            sesion=$timestamp,
960            fechahorareg=NOW(),
961            estado=$ACCION_INICIADA,
962            resultado=$ACCION_SINRESULTADO,
963            ambito=$AMBITO_ORDENADORES,
964            idambito=$clientid[$i],
965            restrambito='$clientip[$i]',
966            idcentro=$ouid;
967EOD;
968                                        $result = $cmd->Ejecutar();
969                                        if ($result) {
970                                                $tmp['id'] = $clientid[$i];
971                                                $tmp['ip'] = $clientip[$i];
972                                                $tmp['mac'] = $clientmac[$i];
973                                                array_push($response['sendto'], $tmp);
974                                                $boot = 1;
975                                        }
976                                }
977                        }
978                }
979                jsonResponse(200, $response);
980        }
981    }
982);
983// Alternativa como método GET.
984//$app->get('/ous/:id1/images/:id2/boot/:number', 'validateApiKey',
985//    function($ouid, $imageid, $number) {
986//
987//   }
988//);
989
990
991
Note: See TracBrowser for help on using the repository browser.