source: admin/WebConsole/rest/server.php @ 4d9240ce

918-git-images-111dconfigure-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-instalacion
Last change on this file since 4d9240ce was 16491c9, checked in by Ramón M. Gómez <ramongomez@…>, 5 years ago

#839 #915: Fix bug in route GET /ous/:ouid/labs/:labid/clients/:clntid/status when a client has never connected to the server.
  • Property mode set to 100644
File size: 31.4 KB
Line 
1<?php
2/**
3 * @file    index.php
4 * @brief   OpenGnsys Server 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 - First version
10 * @date    2016-09-19
11 */
12
13
14// Auxiliar functions.
15
16/**
17 * @brief    Check if user is administrator and print error messages if not.
18 * @param    int adminid  Administrator id.
19 * @return   boolean      "true" if admin id. is equals to global user id., otherwise "false".
20 */
21function checkAdmin($adminid) {
22        global $userid;
23
24        if ($adminid == $userid) {
25                return true;
26        } else {
27                // Print error message.
28                $response['message'] = 'Cannot access this resource';
29                jsonResponse(401, $response);
30                return false;
31        }
32}
33
34/**
35 * @fn    addClassroomGroup(&$classroomGroups, $rs)
36 * @brief Funcion privada usada para añadir grupos de aulas recursivamente
37 * @param classroomGroups Grupos de aulas que pueden contener más grupos
38 * @param rs resultset de la consulta a la base de datos.
39 */
40function addClassroomGroup(&$classroomGroups, $rs){
41
42        array_walk($classroomGroups, function(&$group,$key){
43                global $rs;
44                if (isset($group['id']) && $group['id'] === $rs->campos["group_group_id"]) {
45                        array_push($group["classroomGroups"],array("id" => $rs->campos["group_id"],
46                                "name" => $rs->campos["nombregrupoordenador"],
47                                "comments" => $rs->campos["comentarios"],
48                                "classroomGroups" => array()));
49                }
50                else if(count($group["classroomGroups"]) > 0){
51                        addClassroomGroup($group["classroomGroups"], $rs);
52                }
53                /**/
54        });
55}
56
57/**
58 * @fn    getStatus(ouid, labid, [clntid])
59 * @brief    Returns client execution status or status of all lab's clients.
60 * @param    int ouid    OU id.
61 * @param    int labid   Lab. id.
62 * @param    int clntid  Client id. (optional)
63 * @return   string      JSON object or array of objects including status data.
64 */
65function getStatus($ouid, $labid, $clntid=0) {
66        global $userid;
67        global $cmd;
68        global $LONCABECERA;
69        global $LONHEXPRM;
70        $app = \Slim\Slim::getInstance();
71        $response = [];
72        $id = [];
73        $stat = [];
74        $ip = "";
75        $urls = [];
76        // Status mapping.
77        $status = ['OFF'=>"off",
78                   'INI'=>"initializing",
79                   'OPG'=>"oglive",
80                   'BSY'=>"busy",
81                   'LNX'=>"linux",
82                   'OSX'=>"macos",
83                   'WIN'=>"windows",
84                   'UNK'=>"unknown"];
85        // Parameters.
86        $ouid = htmlspecialchars($ouid);
87        $labid = htmlspecialchars($labid);
88        $single = is_numeric(explode("/", $app->request->getResourceUri())[6]);
89
90        // Database query.
91        $cmd->texto = <<<EOD
92SELECT adm.idusuario, aulas.idaula, ordenadores.idordenador, ordenadores.ip
93  FROM ordenadores
94  JOIN aulas USING(idaula)
95 RIGHT JOIN administradores_centros AS adm USING(idcentro)
96 WHERE adm.idusuario = '$userid'
97   AND adm.idcentro='$ouid'
98   AND aulas.idaula='$labid'
99EOD;
100        // Request for a single client.
101        if ($single) {
102                $clntid = htmlspecialchars($clntid);
103                $cmd->texto .= <<<EOD
104   AND ordenadores.idordenador='$clntid';
105EOD;
106        }
107        $rs=new Recordset;
108        $rs->Comando=&$cmd;
109        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
110        $rs->Primero();
111        // Check if user is an UO admin and asset exists.
112        if (checkAdmin($rs->campos["idusuario"]) and (($single and checkParameter($rs->campos["idordenador"])) or (! $single and checkParameter($rs->campos["idaula"])))) {
113                while (!$rs->EOF) {
114                        $id[$rs->campos["ip"]] = $rs->campos["idordenador"];
115                        $stat[$rs->campos["ip"]] = $status['OFF'];
116                        $rs->Siguiente();
117                }
118                // Get client status.
119                $clientid = implode(",", $id);
120                $clientip = implode(";", array_keys($id));
121                $result = clients(2, $clientip);
122                // Check status type.
123                if (checkParameter($result)) {
124                        foreach (explode(";", $result) as $data) {
125                                if (!empty($data)) {
126                                        list($clip, $clst) = explode("/", $data);
127                                        if ($clst != "OFF") {
128                                                // Update current status.
129                                                $stat[$clip] = $status[$clst];
130                                        }
131                                }
132                        }
133                }
134                // Prepare request to new OGAgent for OSes.
135                foreach ($stat as $ip => $st) {
136                        if ($st == "off") {
137                                $urls[$ip] = "https://$ip:8000/opengnsys/status";
138                        }
139                }
140                // Send request to OGAgents.
141                if (isset($urls)) {
142                        $result = multiRequest($urls);
143                }
144                // Parse responses.
145                reset($urls);
146                foreach ($result as $res) {
147                        if (!empty($res['data'])) {
148                                // Get status and session data.
149                                $ip = key($urls);
150                                $data = json_decode($res['data']);
151                                if (@isset($status[$data->status])) {
152                                        $stat[$ip] = $status[$data->status];
153                                        $logged[$ip] = $data->loggedin;
154                                } else {
155                                        $stat[$ip] = $status['UNK'];
156                                }
157                        }
158                        unset($urls[$ip]);
159                }
160                // Compose JSON response.
161                if ($single) {
162                        // Single response.
163                        $response['id'] = (int)reset($id);
164                        $response['ip'] = key($id);
165                        $response['status'] = $stat[key($id)];
166                        empty($logged[$ip]) || $response['loggedin'] = $logged[$ip];
167                } else {
168                        // Multiple responses.
169                        foreach ($stat as $ip => $st) {
170                                $tmp = Array();
171                                $tmp['id'] = (int)$id[$ip];
172                                $tmp['ip'] = $ip;
173                                $tmp['status'] = $stat[$ip];
174                                empty($logged[$ip]) || $tmp['loggedin'] = $logged[$ip];
175                                array_push($response, $tmp);
176                        }
177                }
178                jsonResponse(200, $response);
179        }
180        $rs->Cerrar();
181}
182
183
184// REST routes.
185
186/**
187 * @brief    user login.
188 * @note     Route: /login, Method: POST
189 * @param    string username   User name.
190 * @param    string password   User password.
191 * @return   string            JSON response with user id. and API key.
192 * @note     User's API key is stored in a new field of "usuarios" table.
193 */
194$app->post('/login',
195    function() use ($app) {
196        global $cmd;
197        global $userid;
198
199        $response = Array();
200        // Reading JSON parameters.
201        try {
202                $input = json_decode($app->request()->getBody());
203                $user = htmlspecialchars($input->username);
204                $pass = htmlspecialchars($input->password);
205        } catch (Exception $e) {
206                // Error message.
207                $response["message"] = $e->getMessage();
208                jsonResponse(400, $response);
209                $app->stop();
210        }
211
212        // Checking parameters.
213        if (! empty($user) and ! empty($pass)) {
214                // Database query.
215                $cmd->texto = "SELECT idusuario, apikey
216                                 FROM usuarios
217                                WHERE usuario='$user' AND pasguor=SHA2('$pass',224)";
218                $rs=new Recordset;
219                $rs->Comando=&$cmd;
220                if ($rs->Abrir()) {
221                        $rs->Primero();
222                        if (!$rs->EOF){
223                                // JSON response.
224                                $userid=$rs->campos["idusuario"];
225                                $apikey=$rs->campos["apikey"];
226                                $response['userid'] = $userid;
227                                $response['apikey'] = $apikey;
228                                jsonResponse(200, $response);
229                        } else {
230                                // Credentials error.
231                                $response['message'] = 'Login failed. Incorrect credentials';
232                                jsonResponse(401, $response);
233                                $app->stop();
234                        }
235                        $rs->Cerrar();
236                } else {
237                        // Access error.
238                        $response['message'] = "An error occurred. Please try again";
239                        jsonResponse(500, $response);
240                        $app->stop();
241                }
242        } else {
243                # Error: missing some input parameter.
244                $response['message'] = 'Missing username or password';
245                jsonResponse(400, $response);
246                $app->stop();
247        }
248    }
249);
250
251/**
252 * @brief    List all defined Organizational Units
253 * @note     Route: /ous, Method: GET
254 * @return   string  JSON array with id. and name for every defined OU
255 */
256$app->get('/ous(/)', function() {
257        global $cmd;
258
259        $cmd->texto = "SELECT * FROM centros";
260        $rs=new Recordset;
261        $rs->Comando=&$cmd;
262        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
263        $response = Array();
264        $rs->Primero();
265        while (!$rs->EOF) {
266                $tmp = Array();
267                $tmp['id'] = (int)$rs->campos["idcentro"];
268                $tmp['name'] = $rs->campos["nombrecentro"];
269                array_push($response, $tmp);
270                $rs->Siguiente();
271        }
272        $rs->Cerrar();
273        jsonResponse(200, $response);
274   }
275);
276
277/**
278 * @brief    Get Organizational Unit data
279 * @note     Route: /ous/:ouid, Method: GET
280 * @param    int ouid  OU id.
281 * @return   string    JSON string with OU's parameters
282 */
283$app->get('/ous/:ouid(/)', 'validateApiKey',
284    function($ouid) {
285        global $cmd;
286        global $userid;
287
288        $ouid = htmlspecialchars($ouid);
289        // Show OU information if user is OU's admin.
290        $cmd->texto = <<<EOD
291SELECT *
292  FROM centros
293 RIGHT JOIN administradores_centros USING(idcentro)
294 WHERE administradores_centros.idusuario = '$userid'
295   AND centros.idcentro = '$ouid'
296 LIMIT 1;
297EOD;
298        $rs=new Recordset;
299        $rs->Comando=&$cmd;
300        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
301        $rs->Primero();
302        if (checkAdmin($rs->campos["idusuario"]) and
303            checkParameter($rs->campos["idcentro"])) {
304                $response['id'] = (int)$ouid;
305                $response['name'] = $rs->campos["nombrecentro"];
306                $response['description'] = $rs->campos["comentarios"];
307                jsonResponse(200, $response);
308        }
309        $rs->Cerrar();
310    }
311);
312
313/**
314 * @brief    List group of labs in an Organizational Unit
315 * @note     Route: /ous/:ouid/groups, Method: GET
316 * @param    int ouid   OU id.
317 * @return   string      JSON array of OU groups
318 */
319$app->get('/ous/:ouid/groups(/)', 'validateApiKey', function($ouid) {
320        global $cmd;
321        global $userid;
322
323        $ouid = htmlspecialchars($ouid);
324        // List group of labs if user is OU's admin.
325        $cmd->texto = <<<EOD
326SELECT adm.idusuario, grupos.*
327  FROM grupos
328 RIGHT JOIN administradores_centros AS adm USING(idcentro)
329 WHERE adm.idusuario = '$userid'
330   AND idcentro='$ouid';
331EOD;
332        $rs=new Recordset;
333        $rs->Comando=&$cmd;
334        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
335        $rs->Primero();
336        // Check if user is an UO admin.
337        if (checkAdmin($rs->campos["idusuario"])) {
338                $response = Array();
339                // Read data.
340                if (! is_null($rs->campos["idcentro"])) {
341                        while (!$rs->EOF) {
342                                $tmp = Array();
343                                $tmp['id'] = (int)$rs->campos["idgrupo"];
344                                $tmp['name'] = $rs->campos["nombregrupo"];
345                                $tmp['type'] = $rs->campos["tipo"];
346                                $tmp['comments'] = $rs->campos["comentarios"];
347                                if($rs->campos["grupoid"] != 0){
348                                        $tmp['parent']['id'] = (int)$rs->campos["grupoid"];
349                                }
350                                array_push($response, $tmp);
351                                $rs->Siguiente();
352                        }
353                }
354                jsonResponse(200, $response);
355        }
356        $rs->Cerrar();
357    }
358);
359
360/**
361 * @brief    List all labs defined in an OU
362 * @note     Route: /ous/:ouid/labs, Method: GET
363 * @param    int ouid  OU id.
364 * @return   string    JSON array of all UO's labs data
365 */
366$app->get('/ous/:ouid/labs(/)', 'validateApiKey',
367    function($ouid) {
368        global $userid;
369        global $cmd;
370
371        $ouid = htmlspecialchars($ouid);
372        // Database query.
373        $cmd->texto = <<<EOD
374SELECT adm.idusuario, aulas.*, grp.idgrupo AS group_id,
375       grp.nombregrupoordenador, grp.grupoid AS group_group_id, grp.comentarios
376  FROM aulas
377 RIGHT JOIN administradores_centros AS adm USING(idcentro)
378  LEFT JOIN gruposordenadores AS grp USING(idaula)
379 WHERE adm.idusuario = '$userid'
380   AND adm.idcentro='$ouid'
381 ORDER BY aulas.idaula, grp.idgrupo
382EOD;
383        $rs=new Recordset;
384        $rs->Comando=&$cmd;
385        if (!$rs->Abrir()) return(false);       // Error opening recordset.
386        // Check if user is an UO admin.
387        $rs->Primero();
388        if (checkAdmin($rs->campos["idusuario"])) {
389                $response = Array();
390                if (! is_null($rs->campos["idcentro"])) {
391                        while (!$rs->EOF) {
392                                // En los resultados las aulas vienen repetidas tantas veces como grupos tengan, solo dejamos uno
393                                $classroomIndex = -1;
394                                $found=false;
395                                $index = 0;
396                                while(!$found && $index < count($response)){
397                                        if(isset($response[$index]["id"]) && $response[$index]["id"] == $rs->campos["idaula"]){
398                                                $classroomIndex = $index;
399                                                $found = true;
400                                        }
401                                        $index++;
402                                }
403                                if(!$found){
404                                        $tmp = Array();
405                                        $tmp['id'] = (int)$rs->campos["idaula"];
406                                        $tmp['name'] = $rs->campos["nombreaula"];
407                                        $tmp['inremotepc'] = ($rs->campos["inremotepc"] == 1);
408                                        $tmp['group']['id'] = (int)$rs->campos["grupoid"];
409                                        $tmp['ou']['id'] = (int)$ouid;
410                                        array_push($response, $tmp);
411                                }
412                                else{
413                                        // Le añadimos el grupo en cuestion siempre que no sea un subgrupo
414                                        if($rs->campos["group_group_id"] == 0){
415                                                array_push($response[$classroomIndex]['classroomGroups'],
416                                                        array("id" => (int)$rs->campos["group_id"],
417                                                        "name" => $rs->campos["nombregrupoordenador"],
418                                                        "comments" => $rs->campos["comentarios"],
419                                                        "classroomGroups" => array()));
420                                        }
421                                        else {
422                                                // Buscamos el grupo donde añadir el grupo
423                                                addClassroomGroup($response[$classroomIndex]['classroomGroups'], $rs);
424                                        }
425                                }
426                                $rs->Siguiente();
427                        }
428                }
429                jsonResponse(200, $response);
430        }
431        $rs->Cerrar();
432    }
433);
434
435/**
436 * @brief    Get lab data
437 * @note     Route: /ous/:ouid/labs/:labid, Method: GET
438 * @param    int ouid   OU id.
439 * @param    int labid  lab id.
440 * @return   string     JSON string with lab parameters
441 */
442$app->get('/ous/:ouid/labs/:labid(/)', 'validateApiKey',
443    function($ouid, $labid) {
444        global $userid;
445        global $cmd;
446
447        $ouid = htmlspecialchars($ouid);
448        $labid = htmlspecialchars($labid);
449        // Database query.
450        $cmd->texto = <<<EOD
451SELECT adm.idusuario, COUNT(idordenador) AS defclients, aulas.*
452  FROM aulas
453 RIGHT JOIN administradores_centros AS adm USING(idcentro)
454  LEFT JOIN ordenadores USING(idaula)
455 WHERE adm.idusuario = '$userid'
456   AND idcentro='$ouid'
457   AND idaula='$labid';
458EOD;
459        $rs=new Recordset;
460        $rs->Comando=&$cmd;
461        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
462        $rs->Primero();
463        // Check if user is an UO admin and lab exists.
464        if (checkAdmin($rs->campos["idusuario"]) and checkParameter($rs->campos["idaula"])) {
465                $response['id'] = (int)$rs->campos["idaula"];
466                $response['name'] = $rs->campos["nombreaula"];
467                $response['location'] = $rs->campos["ubicacion"];
468                $response['description'] = $rs->campos["comentarios"];
469                $response['inremotepc'] = ($rs->campos["inremotepc"] == 1);
470                $response['capacity'] = (int)$rs->campos["puestos"];
471                if ($rs->campos["idordprofesor"]) {
472                        $response['profclient']['id'] = (int)$rs->campos["idordprofesor"];
473                }
474                $response['defclients'] = (int)$rs->campos["defclients"];
475                $response['projector'] = ($rs->campos["cagnon"] == 1);
476                $response['board'] = ($rs->campos["pizarra"] == 1);
477                $response['routerip'] = $rs->campos["router"];
478                $response['netmask'] = $rs->campos["netmask"];
479                $response['ntp'] = $rs->campos["ntp"];
480                $response['dns'] = $rs->campos["dns"];
481                $response['proxyurl'] = $rs->campos["proxy"];
482                switch ($rs->campos["modomul"]) {
483                        case 1:  $response['mcastmode'] = "half-duplex"; break;
484                        case 2:  $response['mcastmode'] = "full-duplex"; break;
485                        default: $response['mcastmode'] = $rs->campos["modomul"];
486                }
487                $response['mcastip'] = $rs->campos["ipmul"];
488                $response['mcastport'] = $rs->campos["pormul"];
489                $response['mcastspeed'] = $rs->campos["velmul"];
490                $response['p2pmode'] = $rs->campos["modp2p"];
491                $response['p2ptime'] = $rs->campos["timep2p"];
492                $response['picture'] = $rs->campos["urlfoto"];
493                jsonResponse(200, $response);
494        }
495        $rs->Cerrar();
496    }
497);
498
499
500/**
501 * @brief    List all clients defined in a lab
502 * @note     Route: /ous/:ouid/labs/:labid/clients, Method: GET
503 * @param    int ouid   OU id.
504 * @param    int labid  lab id.
505 * @return   string     JSON data with lab id. and array of lab parameters
506 */
507$app->get('/ous/:ouid/labs/:labid/clients(/)', 'validateApiKey',
508    function($ouid, $labid) {
509        global $userid;
510        global $cmd;
511
512        $ouid = htmlspecialchars($ouid);
513        $labid = htmlspecialchars($labid);
514        // Database query.
515        $cmd->texto = <<<EOD
516SELECT adm.idusuario, ordenadores.*, aulas.idaula AS labid
517  FROM ordenadores
518 RIGHT JOIN aulas USING(idaula)
519 RIGHT JOIN administradores_centros AS adm USING(idcentro)
520 WHERE adm.idusuario = '$userid'
521   AND adm.idcentro='$ouid'
522   AND aulas.idaula='$labid';
523EOD;
524        $rs=new Recordset;
525        $rs->Comando=&$cmd;
526        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
527        $rs->Primero();
528        // Check if user is an UO admin and lab exists.
529        if (checkAdmin($rs->campos["idusuario"]) and checkParameter($rs->campos["labid"])) {
530                $response = Array();
531                while (!$rs->EOF) {
532                        if (!is_null($rs->campos["idordenador"])) {
533                                $tmp = Array();
534                                $tmp['id'] = (int)$rs->campos["idordenador"];
535                                $tmp['name'] = $rs->campos["nombreordenador"];
536                                $tmp['ip'] = $rs->campos["ip"];
537                                $tmp['mac'] = $rs->campos["mac"];
538                                $tmp['ou']['id'] = (int)$ouid;
539                                $tmp['lab']['id'] = (int)$labid;
540                                array_push($response, $tmp);
541                        }
542                        $rs->Siguiente();
543                }
544                jsonResponse(200, $response);
545        }
546        $rs->Cerrar();
547    }
548);
549
550/**
551 * @brief    Get execution status of all clients defined in a lab
552 * @note     Route: /ous/:ouid/labs/:labid/clients/:clntid/status, Method: GET
553 * @param    int ouid   OU id.
554 * @param    int labid  lab id.
555 * @return   string     JSON string with array of all client status defined in a lab
556 */
557$app->get('/ous/:ouid/labs/:labid/clients/status(/)', 'validateApiKey', 'getStatus');
558
559/**
560 * @brief    Get client data
561 * @note     Route: /ous/id1/labs/id2clients/id3, Method: GET
562 * @param    int ouid    OU id.
563 * @param    int labid   lab id.
564 * @param    int clntid  client id.
565 * @return   string      JSON string with hardware parameters
566 */
567$app->get('/ous/:ouid/labs/:labid/clients/:clntid(/)', 'validateApiKey',
568    function($ouid, $labid, $clntid) {
569        global $userid;
570        global $cmd;
571
572        $ouid = htmlspecialchars($ouid);
573        $labid = htmlspecialchars($labid);
574        $clntid = htmlspecialchars($clntid);
575        // Database query.
576        $cmd->texto = <<<EOD
577SELECT adm.idusuario, ordenadores.*,
578       IF(ordenadores.idordenador=aulas.idordprofesor, 1, 0) AS profclient
579  FROM ordenadores
580  JOIN aulas USING(idaula)
581 RIGHT JOIN administradores_centros AS adm USING(idcentro)
582 WHERE adm.idusuario = '$userid'
583   AND idcentro='$ouid'
584   AND idaula='$labid'
585   AND idordenador='$clntid';
586EOD;
587        $rs=new Recordset;
588        $rs->Comando=&$cmd;
589        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
590        $rs->Primero();
591        // Check if user is an UO admin, lab exists and client exists.
592        if (checkAdmin($rs->campos["idusuario"]) and checkParameter($rs->campos["idaula"]) and checkParameter($rs->campos["idordenador"])) {
593                // Read data.
594                $response['id'] = (int)$rs->campos["idordenador"];
595                $response['name'] = $rs->campos["nombreordenador"];
596                $response['serialno'] = $rs->campos["numserie"];
597                $response['netiface'] = $rs->campos["netiface"];
598                $response['netdriver'] = $rs->campos["netdriver"];
599                $response['mac'] = $rs->campos["mac"];
600                $response['ip'] = $rs->campos["ip"];
601                $response['netmask'] = $rs->campos["mascara"];
602                $response['routerip'] = $rs->campos["router"];
603                $response['repo']['id'] = (int)$rs->campos["idrepositorio"];
604                $response['profclient'] = ($rs->campos["profclient"] == 1);
605                //$response['hardprofile']['id'] = $rs->campos["idperfilhard"];
606                //$response['menu']['id'] = $rs->campos["idmenu"];
607                $response['validation'] = ($rs->campos["validacion"] == 1);
608                $response['boottype'] = $rs->campos["arranque"];
609                $response['picture'] = $rs->campos["fotoord"];
610                jsonResponse(200, $response);
611        }
612        $rs->Cerrar();
613    }
614);
615
616/**
617 * @brief    Get client's harware configuration data
618 * @note     Route: /ous/:ouid/labs/:labid/clients/:clntid/hardware, Method: GET
619 * @param    int ouid    OU id.
620 * @param    int labid   lab id.
621 * @param    int clntid  client id.
622 * @return   string      JSON string with cleint parameters
623 */
624$app->get('/ous/:ouid/labs/:labid/clients/:clntid/hardware(/)', 'validateApiKey',
625    function($ouid, $labid, $clntid) {
626        global $userid;
627        global $cmd;
628
629        $ouid = htmlspecialchars($ouid);
630        $labid = htmlspecialchars($labid);
631        $clntid = htmlspecialchars($clntid);
632        // Database query.
633        $cmd->texto = <<<EOD
634SELECT adm.idusuario, ordenadores.idordenador, ordenadores.nombreordenador,
635       tipohardwares.nemonico, hardwares.descripcion
636  FROM ordenadores
637  JOIN aulas USING(idaula)
638 RIGHT JOIN administradores_centros AS adm USING(idcentro)
639  LEFT JOIN perfileshard_hardwares USING(idperfilhard)
640  LEFT JOIN hardwares ON perfileshard_hardwares.idhardware=hardwares.idhardware
641  LEFT JOIN tipohardwares ON tipohardwares.idtipohardware=hardwares.idtipohardware
642 WHERE adm.idusuario = '$userid'
643   AND adm.idcentro='$ouid'
644   AND aulas.idaula='$labid'
645   AND ordenadores.idordenador='$clntid';
646EOD;
647        $rs=new Recordset;
648        $rs->Comando=&$cmd;
649        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
650        $rs->Primero();
651        // Check if user is an UO admin and client exists.
652        if (checkAdmin($rs->campos["idusuario"]) and checkParameter($rs->campos["idordenador"])) {
653                // Read data.
654                $response['id'] = (int)$rs->campos["idordenador"];
655                $response['name'] = $rs->campos["nombreordenador"];
656                $response['hardware'] = Array();
657                while (!$rs->EOF) {
658                        if (!is_null($rs->campos["nemonico"])) {
659                                $tmp = Array();
660                                $tmp['type'] = $rs->campos["nemonico"];
661                                $tmp['description'] = $rs->campos["descripcion"];
662                                array_push($response['hardware'], $tmp);
663                        }
664                        $rs->Siguiente();
665                }
666                jsonResponse(200, $response);
667        }
668        $rs->Cerrar();
669    }
670);
671
672/**
673 * @brief    Get client's disk configuration data
674 * @note     Route: /ous/:ouid1/labs/:labid/clients/:clntid/diskcfg, Method: GET
675 * @param    int ouid    OU id.
676 * @param    int labid   lab id.
677 * @param    int clntid  client id.
678 * @return   string      JSON string with disk parameters
679 */
680$app->get('/ous/:ouid/labs/:labid/clients/:clntid/diskcfg(/)', 'validateApiKey',
681    function($ouid, $labid, $clntid) {
682        global $userid;
683        global $cmd;
684
685        $ouid = htmlspecialchars($ouid);
686        $labid = htmlspecialchars($labid);
687        $clntid = htmlspecialchars($clntid);
688        // Database query.
689        $cmd->texto = <<<EOD
690SELECT adm.idusuario, ordenadores.idordenador AS clientid,
691       ordenadores.nombreordenador, ordenadores_particiones.*, tipospar.tipopar,
692       sistemasficheros.nemonico, nombresos.nombreso, imagenes.nombreca,
693       (imagenes.revision - ordenadores_particiones.revision) AS difimagen
694  FROM ordenadores_particiones
695 RIGHT JOIN ordenadores USING(idordenador)
696  JOIN aulas USING(idaula)
697 RIGHT JOIN administradores_centros AS adm USING(idcentro)
698  LEFT JOIN tipospar USING(codpar)
699  LEFT JOIN sistemasficheros USING(idsistemafichero)
700  LEFT JOIN nombresos USING(idnombreso)
701  LEFT JOIN imagenes USING(idimagen)
702 WHERE adm.idusuario = '$userid'
703   AND adm.idcentro='$ouid'
704   AND aulas.idaula='$labid'
705   AND ordenadores.idordenador='$clntid'
706 ORDER BY numdisk ASC, numpar ASC;
707EOD;
708        $rs=new Recordset;
709        $rs->Comando=&$cmd;
710        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
711        $rs->Primero();
712        // Check if user is an UO admin and client exists.
713        if (checkAdmin($rs->campos["idusuario"]) and checkParameter($rs->campos["clientid"])) {
714                // Read data.
715                $response['id'] = (int)$rs->campos["clientid"];
716                $response['name'] = $rs->campos["nombreordenador"];
717                $response['diskcfg'] = Array();
718                while (!$rs->EOF) {
719                        // Skip header.
720                        if ($rs->campos["numdisk"] == 0) {
721                                $rs->Siguiente();
722                                continue;
723                        }
724                        $tmp = Array();
725                        // Common data.
726                        $tmp['disk'] = (int)$rs->campos["numdisk"];
727                        $tmp['size'] = (int)$rs->campos["tamano"];
728                        if ($rs->campos["numpar"] == 0) {
729                                // Disk data.
730                                switch ($rs->campos["codpar"]) {
731                                        case 1:  $tmp['parttable'] = "MSDOS"; break;
732                                        case 2:  $tmp['parttable'] = "GPT"; break;
733                                        case 3:  $tmp['parttable'] = "LVM"; break;
734                                        case 4:  $tmp['parttable'] = "ZPOOL"; break;
735                                        default: $tmp['parttable'] = $rs->campos["codpar"];
736                                }
737                        } else {
738                                // Partition data.
739                                $tmp['partition'] = (int)$rs->campos["numpar"];
740                                $tmp['parttype'] = $rs->campos["tipopar"];
741                                $tmp['filesystem'] = $rs->campos["nemonico"];
742                                $tmp['usage'] = (int)$rs->campos["uso"];
743                                if ($rs->campos["nombreso"] != null) {
744                                        $tmp['os'] = $rs->campos["nombreso"];
745                                        if ($rs->campos["idimagen"] > 0) {
746                                                // Restored image data.
747                                                $tmp['image']['id'] = (int)$rs->campos["idimagen"];
748                                                $tmp['image']['deploydate'] = $rs->campos["fechadespliegue"];
749                                                // Check if image is updated.
750                                                $tmp['image']['updated'] = ($rs->campos["difimagen"] == 0);
751                                        }
752                                }
753                                //$tmp['cachedata'] = $rs->campos["cache"];
754                        }
755                        array_push($response['diskcfg'], $tmp);
756                        $rs->Siguiente();
757                }
758                jsonResponse(200, $response);
759        }
760        $rs->Cerrar();
761    }
762);
763
764/**
765 * @brief    Get client's execution status
766 * @note     Route: /ous/:ouid/labs/:labid/clients/:clntid/status, Method: GET
767 * @param    int ouid    OU id.
768 * @param    int labid   lab id.
769 * @param    int clntid  client id.
770 * @return   string      JSON string with client status
771 */
772$app->get('/ous/:ouid/labs/:labid/clients/:clntid/status(/)', 'validateApiKey', 'getStatus');
773
774/**
775 * @brief    List all image repositories defined in an OU
776 * @note     Route: /ous/id/repos, Method: GET
777 * @param    int ouid  OU id.
778 * @return   string    JSON array of all UO's repo data
779 */
780$app->get('/ous/:ouid/repos(/)', 'validateApiKey',
781    function($ouid) {
782        global $userid;
783        global $cmd;
784
785        $ouid = htmlspecialchars($ouid);
786        // Database query.
787        $cmd->texto = <<<EOD
788SELECT adm.idusuario, adm.idcentro AS ouid, repositorios.*
789  FROM repositorios
790 RIGHT JOIN administradores_centros AS adm USING(idcentro)
791 WHERE adm.idusuario = '$userid'
792   AND adm.idcentro='$ouid';
793EOD;
794        $rs=new Recordset;
795        $rs->Comando=&$cmd;
796        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
797        $rs->Primero();
798        // Check if user is an UO admin.
799        if (checkAdmin($rs->campos["idusuario"]) and checkParameter($rs->campos["ouid"])) {
800                $response = Array();
801                while (!$rs->EOF) {
802                        if (! is_null($rs->campos["idcentro"])) {
803                                $tmp = Array();
804                                $tmp['id'] = (int)$rs->campos["idrepositorio"];
805                                $tmp['name'] = $rs->campos["nombrerepositorio"];
806                                $tmp['ou']['id'] = (int)$ouid;
807                                array_push($response, $tmp);
808                        }
809                        $rs->Siguiente();
810                }
811                jsonResponse(200, $response);
812        }
813        $rs->Cerrar();
814    }
815);
816
817/**
818 * @brief    Get image repository data
819 * @note     Route: /ous/:ouid/repos/:repoid, Method: GET
820 * @param    int ouid    OU id.
821 * @param    int repoid  repository id.
822 * @return   string      JSON string with repo parameters
823 */
824$app->get('/ous/:ouid/repos/:repoid(/)', 'validateApiKey',
825    function($ouid, $repoid) {
826        global $userid;
827        global $cmd;
828
829        $ouid = htmlspecialchars($ouid);
830        $repoid = htmlspecialchars($repoid);
831        // Database query.
832        $cmd->texto = <<<EOD
833SELECT adm.idusuario, repositorios.*
834  FROM repositorios
835 RIGHT JOIN administradores_centros AS adm USING(idcentro)
836 WHERE adm.idusuario = '$userid'
837   AND adm.idcentro='$ouid'
838   AND idrepositorio='$repoid';
839EOD;
840        $rs=new Recordset;
841        $rs->Comando=&$cmd;
842        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
843        $rs->Primero();
844        // Check if user is an UO admin and repo exists.
845        if (checkAdmin($rs->campos["idusuario"]) and checkParameter($rs->campos["idrepositorio"])) {
846                // Read data.
847                $response['id'] = (int)$rs->campos["idrepositorio"];
848                $response['name'] = $rs->campos["nombrerepositorio"];
849                $response['description'] = $rs->campos["comentarios"];
850                $response['ip'] = $rs->campos["ip"];
851                jsonResponse(200, $response);
852        }
853        $rs->Cerrar();
854    }
855);
856
857/**
858 * @brief    List all images defined in an OU
859 * @note     Route: /ous/:ouid/images, Method: GET
860 * @param    int ouid  OU id.
861 * @return   string    JSON array of all UO's image data
862 */
863$app->get('/ous/:ouid/images(/)', 'validateApiKey',
864    function($ouid) {
865        global $userid;
866        global $cmd;
867
868        $ouid = htmlspecialchars($ouid);
869        // Database query.
870        $cmd->texto = <<<EOD
871SELECT adm.idusuario, adm.idcentro AS ouid, imagenes.*
872  FROM imagenes
873 RIGHT JOIN administradores_centros AS adm USING(idcentro)
874 WHERE adm.idusuario = '$userid'
875   AND adm.idcentro='$ouid';
876EOD;
877        $rs=new Recordset;
878        $rs->Comando=&$cmd;
879        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
880        $rs->Primero();
881        // Check if user is an UO admin.
882        if (checkAdmin($rs->campos["idusuario"]) and checkParameter($rs->campos["ouid"])) {
883                $response = Array();
884                while (!$rs->EOF) {
885                        if (! is_null($rs->campos["idcentro"])) {
886                                $tmp = Array();
887                                $tmp['id'] = (int)$rs->campos["idimagen"];
888                                $tmp['name'] = $rs->campos["nombreca"];
889                                $tmp['inremotepc'] = ($rs->campos["inremotepc"] == 1);
890                                $tmp['ou']['id'] = (int)$ouid;
891                                array_push($response, $tmp);
892                        }
893                        $rs->Siguiente();
894                }
895                jsonResponse(200, $response);
896        }
897    }
898);
899
900/**
901 * @brief    Get image data
902 * @note     Route: /ous/:ouid/images/:imgid, Method: GET
903 * @param    int ouid   OU id.
904 * @param    int imgid  image id.
905 * @return   string     JSON string with image parameters
906 */
907$app->get('/ous/:ouid/images/:imgid(/)', 'validateApiKey',
908    function($ouid, $imgid) {
909        global $userid;
910        global $cmd;
911
912        $ouid = htmlspecialchars($ouid);
913        $imgid = htmlspecialchars($imgid);
914        // Database query.
915        $cmd->texto = <<<EOD
916SELECT adm.idusuario, imagenes.*, nombreso AS os
917  FROM imagenes
918 RIGHT JOIN administradores_centros AS adm USING(idcentro)
919  LEFT JOIN perfilessoft USING(idperfilsoft)
920  LEFT JOIN nombresos USING(idnombreso)
921 WHERE adm.idusuario = '$userid'
922   AND adm.idcentro='$ouid'
923   AND idimagen='$imgid';
924EOD;
925        $rs=new Recordset;
926        $rs->Comando=&$cmd;
927        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
928        $rs->Primero();
929        // Check if user is an UO admin and repo exists.
930        if (checkAdmin($rs->campos["idusuario"]) and checkParameter($rs->campos["idimagen"])) {
931                // Read data.
932                $response['id'] = (int)$rs->campos["idimagen"];
933                $response['name'] = $rs->campos["nombreca"];
934                $response['description'] = $rs->campos["descripcion"];
935                $response['comments'] = $rs->campos["comentarios"];
936                $response['inremotepc'] = ($rs->campos["inremotepc"] == 1);
937                $response['repo']['id'] = (int)$rs->campos["idrepositorio"];
938                switch ($rs->campos["tipo"]) {
939                        // Image type.
940                        case 1:  $response['type'] = "monolithic"; break;
941                        case 2:  $response['type'] = "base"; break;
942                        case 3:  $response['type'] = "incremental";
943                                 $response['baseimg'] = $rs->campos["imagenid"];
944                                 $response['path'] = $rs->campos["ruta"];
945                                 break;
946                        default: $response['type'] = $rs->campos["tipo"];
947                }
948                if ($rs->campos["idordenador"] != 0) {
949                        // Source client data.
950                        $response['client']['id'] = (int)$rs->campos["idordenador"];
951                        $response['client']['disk'] = (int)$rs->campos["numdisk"];
952                        $response['client']['partition'] = (int)$rs->campos["numpar"];
953                        $response['creationdate'] = $rs->campos["fechacreacion"];
954                        $response['release'] = (int)$rs->campos["revision"];
955                        $response['os'] = $rs->campos["os"];
956                }
957                jsonResponse(200, $response);
958        }
959        $rs->Cerrar();
960    }
961);
962
963// Lista de softeare instalado en una imagen.
964/**
965 * @brief    List software installed in an image
966 * @note     Route: /ous/:ouid/images/:imgid/software, Method: GET
967 * @param    int ouid   OU id.
968 * @param    int imgid  image id.
969 * @return   string     JSON array with installed software
970 */$app->get('/ous/:ouid/images/:imgid/software(/)', 'validateApiKey',
971    function($ouid, $imgid) {
972        global $userid;
973        global $cmd;
974
975        $ouid = htmlspecialchars($ouid);
976        $imgid = htmlspecialchars($imgid);
977        // Database query.
978        $cmd->texto = <<<EOD
979SELECT adm.idusuario, imagenes.idimagen, imagenes.nombreca,
980       nombresos.nombreso, softwares.descripcion
981  FROM imagenes
982 RIGHT JOIN administradores_centros AS adm USING(idcentro)
983  LEFT JOIN perfilessoft USING(idperfilsoft)
984  LEFT JOIN nombresos USING(idnombreso)
985  LEFT JOIN perfilessoft_softwares USING(idperfilsoft)
986  LEFT JOIN softwares USING(idsoftware)
987 WHERE adm.idusuario = '$userid'
988   AND adm.idcentro='$ouid'
989   AND imagenes.idimagen='$imgid'
990 ORDER BY softwares.descripcion ASC;
991EOD;
992        $rs=new Recordset;
993        $rs->Comando=&$cmd;
994        if (!$rs->Abrir()) return(false);       // Error oppening recordset.
995        $rs->Primero();
996        // Check if user is an UO admin and repo exists.
997        if (checkAdmin($rs->campos["idusuario"]) and checkParameter($rs->campos["idimagen"])) {
998                $response['id'] = (int)$rs->campos["idimagen"];
999                $response['name'] = $rs->campos["nombreca"];
1000                if (is_null($rs->campos["nombreso"])) {
1001                        // Null object.
1002                        $response['software'] = Array();
1003                        jsonResponse(200, $response, JSON_FORCE_OBJECT);
1004                } else {
1005                        // Read data.
1006                        $response['software']['os'] = $rs->campos["nombreso"];
1007                        //$response['software']['type'] = ...;  // OS type
1008                        $response['software']['applications'] = Array();
1009                        while (!$rs->EOF) {
1010                                // Ignoring empty fields.
1011                                if (!is_null($rs->campos["descripcion"])) {
1012                                        array_push($response['software']['applications'], $rs->campos["descripcion"]);
1013                                }
1014                                $rs->Siguiente();
1015                        }
1016                        jsonResponse(200, $response);
1017                }
1018        }
1019        $rs->Cerrar();
1020    }
1021);
1022
Note: See TracBrowser for help on using the repository browser.