1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
|
<?php
/**
* @file remotepc.php
* @brief OpenGnsys Server REST API consumed by UDS Server for Remote PC implementation.
* @warning All input and output messages are formatted in JSON.
* @note Some ideas are based on article "How to create REST API for Android app using PHP, Slim and MySQL" by Ravi Tamada, thanx.
* @license GNU GPLv3+
* @author Ramón M. Gómez, ETSII Univ. Sevilla
* @version 1.1.0 - First version
* @date 2017-02-01
*/
// REST routes.
/**
* @brief Reserve a random client with an installed image and send a boot/reboot operation depending on its status.
* @warning If "lab" parameter is specified, then choose a client from this lab.
* @note Route: /ous/:ouid/labs/:labid/clients/:clntid/events, Method: POST
* @param integer ouid OU identificator
* @param integer imageid image identificator
* @param integer labid lab. identificator (optional)
*/
$app->post('/ous/:ouid/images/:imageid/reserve', 'validateApiKey',
function($ouid, $imageid) use ($app) {
global $cmd;
global $AMBITO_ORDENADORES;
global $EJECUCION_COMANDO;
global $ACCION_INICIADA;
global $ACCION_SINRESULTADO;
global $userid;
$response = Array();
$ogagent = Array();
// Checking parameters.
$ouid = htmlspecialchars($ouid);
$imageid = htmlspecialchars($imageid);
$labid = str_replace("%", "\%", htmlspecialchars($app->request()->params('lab')));
if (empty($labid)) $labid = '%'; // Clients in any lab.
// Randomly choose a client with image installed and get ogAdmServer data.
$cmd->texto = <<<EOD
SELECT entornos.ipserveradm, entornos.portserveradm,
ordenadores.idordenador, ordenadores.ip, ordenadores.mac, ordenadores.agentkey,
ordenadores_particiones.numdisk, ordenadores_particiones.numpar,
aulas.idaula, aulas.idcentro, remotepc.reserved
FROM entornos, ordenadores
JOIN aulas USING(idaula)
RIGHT JOIN administradores_centros USING(idcentro)
RIGHT JOIN usuarios USING(idusuario)
RIGHT JOIN ordenadores_particiones USING(idordenador)
RIGHT JOIN imagenes USING(idimagen)
LEFT JOIN remotepc ON remotepc.id=ordenadores.idordenador
WHERE administradores_centros.idadministradorcentro = '$userid'
AND aulas.idcentro = '$ouid' AND aulas.idaula LIKE '$labid' AND aulas.inremotepc = 1
AND imagenes.idimagen = '$imageid' AND imagenes.inremotepc = 1
ORDER BY RAND() LIMIT 1;
EOD;
$rs=new Recordset;
$rs->Comando=&$cmd;
if (!$rs->Abrir()) return(false); // Error opening recordset.
// Check if client exists.
$rs->Primero();
if (checkParameter($rs->campos["idordenador"])) {
// Check if client is not reserved.
if ($rs->campos["reserved"] !== 1) {
// Read query data.
$serverip = $rs->campos["ipserveradm"];
$serverport = $rs->campos["portserveradm"];
$clntid = $rs->campos["idordenador"];
$clntip = $rs->campos["ip"];
$clntmac = $rs->campos["mac"];
$agentkey = $rs->campos["agentkey"];
$disk = $rs->campos["numdisk"];
$part = $rs->campos["numpar"];
$labid = $rs->campos["idaula"];
$ouid = $rs->campos["idcentro"];
// Check client's status.
$ogagent[$clntip]['url'] = "https://$clntip:8000/opengnsys/status";
$result = multiRequest($ogagent);
if (empty($result[$clntip])) {
// Client is off, send a boot command to ogAdmServer.
$reqframe = "nfn=Arrancar\r".
"ido=$clntid\r".
"iph=$clntip\r".
"mac=$clntmac\r".
"mar=1\r";
sendCommand($serverip, $serverport, $reqframe, $values);
} else {
// Client is on, send a reboot command to its OGAgent.
$ogagent[$clntip]['url'] = "https://$clntip:8000/opengnsys/reboot";
$ogagent[$clntip]['header'] = Array("Authorization: ".$agentkey);
$result = multiRequest($ogagent);
// ... (check response)
// ...
}
// DB Transaction: mark choosed client as reserved and
// create an init session command into client's actions queue.
$cmd->texto = "START TRANSACTION;";
$cmd->Ejecutar();
$timestamp = time();
$cmd->texto = <<<EOD
INSERT INTO remotepc
SET id='$clntid', reserved=1, urllogin=NULL, urllogout=NULL
ON DUPLICATE KEY UPDATE
id=VALUES(id), reserved=VALUES(reserved),
urllogin=VALUES(urllogin), urllogout=VALUES(urllogout);
EOD;
$t1 = $cmd->Ejecutar();
$cmd->texto = <<<EOD
INSERT INTO acciones
SET tipoaccion=$EJECUCION_COMANDO,
idtipoaccion=9,
idcomando=9,
parametros='nfn=IniciarSesion\rdsk=$disk\rpar=$part',
descriaccion='RemotePC Session',
idordenador=$clntid,
ip='$clntip',
sesion=$timestamp,
fechahorareg=NOW(),
estado=$ACCION_INICIADA,
resultado=$ACCION_SINRESULTADO,
ambito=$AMBITO_ORDENADORES,
idambito=$clntid,
restrambito='$clntip',
idcentro=$ouid;
EOD;
$t2 = $cmd->Ejecutar();
if ($t1 and $t2) {
// Commit transaction on success.
$cmd->texto = "COMMIT;";
$cmd->Ejecutar();
// Send init session command if client is booted on ogLive.
$reqframe = "nfn=IniciarSesion\r".
"ido=$clntid\r".
"iph=$clntip\r".
"dsk=$disk\r".
"par=$part\r";
sendCommand($serverip, $serverport, $reqframe, $values);
// Compose JSON response.
$response['id'] = $clntid;
$response['ip'] = $clntip;
$response['mac'] = $clntmac;
$response['lab']['id'] = $labid;
$response['ou']['id'] = $ouid;
jsonResponse(200, $response);
} else{
// Roll-back transaction on DB error.
$cmd->texto = "ROLLBACK;";
$cmd->Ejecutar();
// Error message.
$response["message"] = "Error updating database";
jsonResponse(400, $response);
$app->stop();
}
} else {
// Error message.
$response["message"] = "Client is already reserved";
jsonResponse(400, $response);
$app->stop();
}
}
$rs->Cerrar();
}
);
/**
* @brief Store UDS server URLs to resend some events recieved from OGAgent.
* @note Route: /ous/:ouid/labs/:labid/clients/:clntid/events, Method: POST
* @param string urlLogin URL to redirect login notification.
* @param string urlLogout URL to redirect logout notification.
* @warning Events parameters will be stored in a new "remotepc" table.
*/
$app->post('/ous/:ouid/labs/:labid/clients/:clntid/events', 'validateApiKey',
function($ouid, $labid, $clntid) use ($app) {
global $cmd;
global $userid;
$response = Array();
// Reading JSON parameters.
try {
$input = json_decode($app->request()->getBody());
$urlLogin = htmlspecialchars($input->urlLogin);
$urlLogout = htmlspecialchars($input->urlLogout);
} catch (Exception $e) {
// Error message.
$response["message"] = $e->getMessage();
jsonResponse(400, $response);
$app->stop();
}
// Checking parameters.
$ouid = htmlspecialchars($ouid);
$labid = htmlspecialchars($labid);
$clntid = htmlspecialchars($clntid);
// Select client data for UDS compatibility.
$cmd->texto = <<<EOD
SELECT ordenadores.idordenador, remotepc.*
FROM remotepc
RIGHT JOIN ordenadores ON remotepc.id=ordenadores.idordenador
JOIN aulas USING(idaula)
RIGHT JOIN administradores_centros USING(idcentro)
RIGHT JOIN usuarios USING(idusuario)
WHERE administradores_centros.idadministradorcentro = '$userid'
AND idcentro = '$ouid' AND aulas.idaula ='$labid'
AND ordenadores.idordenador = '$clntid';
EOD;
$rs=new Recordset;
$rs->Comando=&$cmd;
if (!$rs->Abrir()) return(false); // Error opening recordset.
// Check if client exists.
$rs->Primero();
if (checkParameter($rs->campos["idordenador"])) {
// Check if client is reserved.
if ($rs->campos["reserved"] == 1) {
// Updating DB if client is reserved.
$cmd->texto = <<<EOD
INSERT INTO remotepc
SET id='$clntid', reserved=1, urllogin='$urlLogin', urllogout='$urlLogout'
ON DUPLICATE KEY UPDATE
id=VALUES(id), reserved=VALUES(reserved),
urllogin=VALUES(urllogin), urllogout=VALUES(urllogout);
EOD;
$cmd->Ejecutar();
// Confirm operation.
jsonResponse(200, "");
} else {
// Error message.
$response["message"] = "Client is not reserved";
jsonResponse(400, $response);
$app->stop();
}
}
$rs->Cerrar();
}
);
$app->post('/ous/:ouid/labs/:labid/clients/:clntid/session', 'validateApiKey',
function($ouid, $imageid) use ($app) {
}
);
$app->delete('/ous/:ouid/labs/:labid/clients/:clntid/unreserve', 'validateApiKey',
function($ouid, $labid, $clntid) {
global $cmd;
global $userid;
$response = Array();
$ogagent = Array();
// Checking parameters.
$ouid = htmlspecialchars($ouid);
$labid = htmlspecialchars($labid);
$clntid = htmlspecialchars($clntid);
// Select client data for UDS compatibility.
$cmd->texto = <<<EOD
SELECT ordenadores.idordenador, ordenadores.ip, ordenadores.agentkey, remotepc.reserved
FROM remotepc
RIGHT JOIN ordenadores ON remotepc.id=ordenadores.idordenador
JOIN aulas USING(idaula)
RIGHT JOIN administradores_centros USING(idcentro)
RIGHT JOIN usuarios USING(idusuario)
WHERE administradores_centros.idadministradorcentro = '$userid'
AND idcentro = '$ouid' AND aulas.idaula ='$labid'
AND ordenadores.idordenador = '$clntid';
EOD;
$rs=new Recordset;
$rs->Comando=&$cmd;
if (!$rs->Abrir()) return(false); // Error opening recordset.
// Check if client exists.
$rs->Primero();
if (checkParameter($rs->campos["idordenador"])) {
// Check if client is reserved.
if ($rs->campos["reserved"] == 1) {
// Read query data.
$clntip = $rs->campos["ip"];
$agentkey = $rs->campos["agentkey"];
// DB Transaction: clear client reservation data and
// remove pending boot commands from client's actions queue.
$cmd->texto = "START TRANSACTION;";
$cmd->Ejecutar();
$cmd->texto = <<<EOD
UPDATE remotepc
SET reserved=0, urllogin=NULL, urllogout=NULL
WHERE id='$clntid';
EOD;
$cmd->Ejecutar();
$cmd->texto = <<<EOD
DELETE FROM acciones
WHERE idordenador = '$clntid'
AND descriaccion = 'RemotePC Session'
AND fechahorafin = '0000-00-00 00:00:00';
EOD;
$cmd->Ejecutar();
$cmd->texto = "COMMIT;";
$cmd->Ejecutar();
// Send a poweroff command to client's OGAgent.
$ogagent[$clntip]['url'] = "https://$clntip:8000/opengnsys/poweroff";
$ogagent[$clntip]['header'] = Array("Authorization: ".$agentkey);
$result = multiRequest($ogagent);
// ... (check response)
// ...
// Confirm operation.
jsonResponse(200, "");
} else {
// Error message.
$response["message"] = "Client is not reserved";
jsonResponse(400, $response);
}
}
$rs->Cerrar();
}
);
?>
|
