forked from dainok/unetlab
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path__lab.php
1252 lines (1145 loc) · 41.9 KB
/
__lab.php
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
# vim: syntax=php tabstop=4 softtabstop=0 noexpandtab laststatus=1 ruler
/**
* html/includes/__lab.php
*
* Class for UNetLab labs.
*
* @author Andrea Dainese <[email protected]>
* @copyright 2014-2016 Andrea Dainese
* @license BSD-3-Clause https://github.com/dainok/unetlab/blob/master/LICENSE
* @link http://www.unetlab.com/
* @version 20160719
* @property type $author Author name of the lab. It's optional.
* @property type $body Long text for lab usage. It's optional.
* @property type $description Description of the lab. It's optional
* @property type $filename The filename of the lab (without path). It's mandatory and automatically set.
* @property type $id UUID of the lab. It's mandatory and automatically set.
* @property type $name Name of the lab. It's mandatory and part of filename ($filename = $name + '.unl').
* @property type $networks List of configured networks. It's optional.
* @property type $nodes List of configured nodes. It's optional.
* @property type $path Full path of the lab. It's mandatory and automatically set.
* @property type $pictures List of included pictures. It's optional.
* @property type $tenant Tenant ID. It's mandatory and set during contruction phase.
* @property type $version Version of the lab. It's optional.
*/
class Lab {
private $author;
private $body;
private $description;
private $filename;
private $id;
private $name;
private $networks = array();
private $nodes = array();
private $path;
private $textobjects = array();
private $pictures = array();
private $tenant;
private $version;
private $scripttimeout;
/**
* Constructor which load an existent lab or create an empty one.
*
* @param string $f the file of the lab with full path
* @param int $tenant Tenant ID
* @return void
*/
public function __construct($f, $tenant) {
$modified = False;
if (!is_file($f)) {
// File does not exist, create a new empty lab
$this -> filename = basename($f);
$this -> path = dirname($f);
$this -> tenant = (int) $tenant;
if (!checkLabFilename($this -> filename)) {
// Invalid filename
error_log(date('M d H:i:s ').'ERROR: '.$f.' '.$GLOBALS['messages'][20001]);
throw new Exception('20001');
}
if (!checkLabPath($this -> path)) {
// Invalid path
error_log(date('M d H:i:s ').'ERROR: '.$f.' '.$GLOBALS['messages'][20002]);
throw new Exception('20002');
}
$this -> name = substr(basename($f), 0, -4);
$this -> id = genUuid();
$modified = True;
$this -> scripttimeout = 600;
} else {
// Load the existent lab
$this -> filename = basename($f);
$this -> path = dirname($f);
$this -> tenant = (int) $tenant;
if (!checkLabFilename($this -> filename)) {
// Invalid filename
error_log(date('M d H:i:s ').'ERROR: '.$f.' '.$GLOBALS['messages'][20001]);
throw new Exception('20001');
}
if (!checkLabPath($this -> path)) {
// Invalid path
error_log(date('M d H:i:s ').'ERROR: '.$f.' '.$GLOBALS['messages'][20002]);
throw new Exception('20002');
}
libxml_use_internal_errors(true);
$xml = simplexml_load_file($f);
if (!$xml) {
// Invalid XML document
error_log(date('M d H:i:s ').'ERROR: '.$f.' '.$GLOBALS['messages'][20003]);
throw new Exception('20003');
}
// Lab name
$patterns[0] = '/\.unl$/';
$replacements[0] = '';
$this -> name = preg_replace($patterns, $replacements, basename($f));
// Lab ID
$result = $xml -> xpath('//lab/@id');
if (empty($result)) {
// Lab ID not set, create a new one
$this -> id = genUuid();
error_log(date('M d H:i:s ').'WARNING: '.$f.' '.$GLOBALS['messages'][20011]);
$modified = True;
} else if (!checkUuid($result[0])) {
// Attribute not valid
$this -> id = genUuid();
error_log(date('M d H:i:s ').'WARNING: '.$f.' '.$GLOBALS['messages'][20012]);
$modified = True;
} else {
$this -> id = (string) $result[0];
}
// Lab description
$result = (string) array_pop($xml -> xpath('//lab/description'));
if (strlen($result) !== 0) {
$this -> description = htmlspecialchars($result, ENT_DISALLOWED, 'UTF-8', TRUE);
} else if (strlen($result) !== 0) {
error_log(date('M d H:i:s ').'WARNING: '.$f.' '.$GLOBALS['messages'][20006]);
}
// Lab body
$result = (string) array_pop($xml -> xpath('//lab/body'));
if (strlen($result) !== 0) {
$this -> body = htmlspecialchars($result, ENT_DISALLOWED, 'UTF-8', TRUE);
} else if (strlen($result) !== 0) {
error_log(date('M d H:i:s ').'WARNING: '.$f.' '.$GLOBALS['messages'][20006]);
}
// Lab author
$result = (string) array_pop($xml -> xpath('//lab/@author'));
if (strlen($result) !== 0) {
$this -> author = htmlspecialchars($result, ENT_DISALLOWED, 'UTF-8', TRUE);
} else if (strlen($result) !== 0) {
error_log(date('M d H:i:s ').'WARNING: '.$f.' '.$GLOBALS['messages'][20007]);
}
// Lab version
$result = (string) array_pop($xml -> xpath('//lab/@version'));
if (strlen($result) !== 0 && (int) $result >= 0) {
$this -> version = $result;
} else if (strlen($result) !== 0) {
error_log(date('M d H:i:s ').'WARNING: '.$f.' '.$GLOBALS['messages'][20008]);
}
// Lab networks
foreach ($xml -> xpath('//lab/topology/networks/network') as $network) {
$w = Array();
if (isset($network -> attributes() -> id)) $w['id'] = (string) $network -> attributes() -> id;
if (isset($network -> attributes() -> left)) $w['left'] = (string) $network -> attributes() -> left;
if (isset($network -> attributes() -> name)) $w['name'] = (string) $network -> attributes() -> name;
if (isset($network -> attributes() -> top)) $w['top'] = (string) $network -> attributes() -> top;
if (isset($network -> attributes() -> type)) $w['type'] = (string) $network -> attributes() -> type;
try {
$this -> networks[$w['id']] = new Network($w, $w['id'], $this -> tenant);
} catch (Exception $e) {
// Invalid network
error_log(date('M d H:i:s ').'WARNING: '.$f.':net'.$w['id'].' '.$GLOBALS['messages'][20009]);
error_log(date('M d H:i:s ').(string) $e);
continue;
}
}
// Lab nodes (networks must be alredy loaded)
foreach ($xml -> xpath('//lab/topology/nodes/node') as $node_id => $node) {
$n = Array();
if (isset($node -> attributes() -> config)) $n['config'] = (string) $node -> attributes() -> config;
if (isset($node -> attributes() -> console)) $n['console'] = (string) $node -> attributes() -> console;
if (isset($node -> attributes() -> cpu)) $n['cpu'] = (int) $node -> attributes() -> cpu;
if (isset($node -> attributes() -> delay)) $n['delay'] = (string) $node -> attributes() -> delay;
if (isset($node -> attributes() -> ethernet)) $n['ethernet'] = (int) $node -> attributes() -> ethernet;
if (isset($node -> attributes() -> icon)) $n['icon'] = (string) $node -> attributes() -> icon;
if (isset($node -> attributes() -> id)) $n['id'] = (int) $node -> attributes() -> id;
if (isset($node -> attributes() -> idlepc)) $n['idlepc'] = (string) $node -> attributes() -> idlepc;
if (isset($node -> attributes() -> image)) $n['image'] = (string) $node -> attributes() -> image;
if (isset($node -> attributes() -> left)) $n['left'] = (string) $node -> attributes() -> left;
if (isset($node -> attributes() -> name)) $n['name'] = (string) $node -> attributes() -> name;
if (isset($node -> attributes() -> nvram)) $n['nvram'] = (int) $node -> attributes() -> nvram;
if (isset($node -> attributes() -> ram)) $n['ram'] = (int) $node -> attributes() -> ram;
if (isset($node -> attributes() -> serial)) $n['serial'] = (int) $node -> attributes() -> serial;
if (isset($node -> attributes() -> template)) $n['template'] = (string) $node -> attributes() -> template;
if (isset($node -> attributes() -> top)) $n['top'] = (string) $node -> attributes() -> top;
if (isset($node -> attributes() -> type)) $n['type'] = (string) $node -> attributes() -> type;
if (isset($node -> attributes() -> uuid)) $n['uuid'] = (string) $node -> attributes() -> uuid;
$n['config'] == 'Exported' ? $n['config'] = '1' : $n['config']; // Fix startup-config
$n['config'] == 'None' ? $n['config'] = '0' : $n['config']; // Fix startup-config
// If config is empty, force "None"
$result = (string) array_pop($xml -> xpath('//lab/objects/configs/config[@id="'.$n['id'].'"]'));
if (strlen($result) == 0) {
$n['config'] = 0;
$config_data = False;
} else {
$config_data = base64_decode($result);
}
// F5 needs a first mac address
if ( $n['template'] == "bigip" ) {
if (isset($node -> attributes() -> firstmac)) {
$n['firstmac'] = (string) $node -> attributes() -> firstmac;
} else {
$n['firstmac'] = (string) '00:'.sprintf('%02x', $this -> tenant).':'.sprintf('%02x', $this -> id / 512).':'.sprintf('%02x', $this -> id % 512).':00:10';
}
}
try {
$this -> nodes[$n['id']] = new Node($n, $n['id'], $this -> tenant, $this -> id);
} catch (Exception $e) {
// Invalid node
error_log(date('M d H:i:s ').'WARNING: '.$f.':node'.$n['id'].' '.$GLOBALS['messages'][20010]);
error_log(date('M d H:i:s ').(string) $e);
continue;
}
// Slot must be loaded before interfaces
foreach ($node -> slot as $slot) {
// Loading configured slots for this node
$s = Array();
if (isset($slot -> attributes() -> id)) $s['id'] = (string) $slot -> attributes() -> id;
if (isset($slot -> attributes() -> module)) $s['module'] = (string) $slot -> attributes() -> module;
if ($this -> nodes[$n['id']] -> setSlot($s['id'], $s['module']) !== 0) {
error_log(date('M d H:i:s ').'WARNING: '.$f.':node'.$n['id'].':slot'.$s['id'].' '.$GLOBALS['messages'][20013]);
}
}
foreach ($node -> interface as $interface) {
// Loading configured interfaces for this node
$i = Array();
if (isset($interface -> attributes() -> id)) $i['id'] = (string) $interface -> attributes() -> id;
if (isset($interface -> attributes() -> network_id)) $i['network_id'] = (string) $interface -> attributes() -> network_id;
if (isset($interface -> attributes() -> remote_id)) $i['remote_id'] = (string) $interface -> attributes() -> remote_id;
if (isset($interface -> attributes() -> remote_if)) $i['remote_if'] = (string) $interface -> attributes() -> remote_if;
if (isset($interface -> attributes() -> remote_host)) $i['remote_host'] = (string) $interface -> attributes() -> remote_host;
if (isset($interface -> attributes() -> type)) $i['type'] = (string) $interface -> attributes() -> type;
switch ($i['type']) {
default:
error_log(date('M d H:i:s ').'WARNING: '.$f.':node'.$n['id'].':inv'.$s['id'].' '.$GLOBALS['messages'][20016]);
break;
case 'ethernet':
if ($this -> nodes[$n['id']] -> linkInterface($i) !== 0) {
error_log(date('M d H:i:s ').'WARNING: '.$f.':node'.$n['id'].':eth'.$i['id'].' '.$GLOBALS['messages'][20014]);
}
break;
case 'serial':
// Serial
if ($this -> nodes[$n['id']] -> linkInterface($i) !== 0) {
error_log(date('M d H:i:s ').'WARNING: '.$f.':node'.$n['id'].':ser'.$i['id'].' '.$GLOBALS['messages'][20015]);
}
break;
}
}
// startup-config (read before)
if ($config_data !== False) {
$rc = $this -> nodes[$n['id']] -> setConfigData($config_data);
if ($rc != 0) {
error_log(date('M d H:i:s ').'WARNING: '.$f.':cfg'.$node_id.' '.$GLOBALS['messages'][20037]);
}
}
}
// lab script timeout
$result = (string) array_pop($xml -> xpath('//lab/@scripttimeout'));
if (strlen($result) !== 0 && (int) $result >= 300) {
$this -> scripttimeout = $result;
} else if (strlen($result) !== 0) {
error_log(date('M d H:i:s ').'WARNING: '.$f.' '.$GLOBALS['messages'][20045]);
$this -> scripttimeout = 300;
}
// Lab Pictures
foreach ($xml -> xpath('//lab/objects/pictures/picture') as $picture) {
$p = Array();
if (isset($picture -> attributes() -> id)) $p['id'] = (string) $picture -> attributes() -> id;
if (isset($picture -> attributes() -> name)) $p['name'] = (string) $picture -> attributes() -> name;
if (isset($picture -> attributes() -> type)) $p['type'] = (string) $picture -> attributes() -> type;
$result = (string) array_pop($picture -> xpath('./data'));
if (strlen($result) > 0) $p['data'] = base64_decode($result);
$result = (string) array_pop($picture -> xpath('./map'));
if (strlen($result) > 0) $p['map'] = html_entity_decode($result);
try {
$this -> pictures[$p['id']] = new Picture($p, $p['id']);
} catch (Exception $e) {
// Invalid picture
error_log(date('M d H:i:s ').'WARNING: '.$f.':pic'.$p['id'].' '.$GLOBALS['messages'][20020]);
error_log(date('M d H:i:s ').(string) $e);
continue;
}
}
// Text Objects
foreach ($xml -> xpath('//lab/objects/textobjects/textobject') as $textobject) {
$p = Array();
if (isset($textobject -> attributes() -> id)) $p['id'] = (string) $textobject -> attributes() -> id;
if (isset($textobject -> attributes() -> name)) $p['name'] = (string) $textobject -> attributes() -> name;
if (isset($textobject -> attributes() -> type)) $p['type'] = (string) $textobject -> attributes() -> type;
$result = (string) array_pop($textobject -> xpath('./data'));
if (strlen($result) > 0) $p['data'] = $result;
try {
$this -> textobjects[$p['id']] = new TextObject($p, $p['id']);
} catch (Exception $e) {
// Invalid picture
error_log(date('M d H:i:s ').'WARNING: '.$f.':obj'.$p['id'].' '.$GLOBALS['messages'][20041]);
error_log(date('M d H:i:s ').(string) $e);
continue;
}
}
// Update attached network count
$this -> setNetworkCount();
}
if ($modified) {
// Need to save
$rc = $this -> save();
if ($rc != 0) {
throw new Exception($rc);
return $rc;
}
}
return 0;
}
/**
* Method to add a new network.
*
* @param Array $p Parameters
* @return int 0 if OK
*/
public function addNetwork($p) {
$p['id'] = $this -> getFreeNetworkId();
// Adding the network
try {
$this -> networks[$p['id']] = new Network($p, $p['id'], $this -> tenant);
return $this -> save();
} catch (Exception $e) {
// Failed to create the network
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?net='.$p['id'].' '.$GLOBALS['messages'][20021]);
error_log(date('M d H:i:s ').(string) $e);
return 20021;
}
return 0;
}
/**
* Method to add a new node.
*
* @param Array $p Parameters
* @return int 0 if OK
*/
public function addNode($p) {
$p['id'] = $this -> getFreeNodeId();
// Add the node
try {
$this -> nodes[$p['id']] = new Node($p, $p['id'], $this -> tenant, $this -> id);
return $this -> save();
} catch (Exception $e) {
// Failed to create the node
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?node='.$p['id'].' '.$GLOBALS['messages'][20022]);
error_log(date('M d H:i:s ').(string) $e);
return 20022;
}
}
/**
* Method to add a new text object.
*
* @param Array $p Parameters
* @return int 0 if OK
*/
public function addTextObject($p) {
$p['id'] = 1;
$object = new stdClass();
$object->id = -1;
$object->status = 0;
// Finding a free object ID
while (True) {
if (!isset($this -> textobjects[$p['id']])) {
break;
} else {
$p['id'] = $p['id'] + 1;
}
}
// Adding the object
try {
$this -> textobjects[$p['id']] = new TextObject($p, $p['id']);
$this -> save();
$object->id = $p['id'];
$object->status = 0;
return $object;
} catch (Exception $e) {
// Failed to create the picture
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?pic='.$p['id'].' '.$GLOBALS['messages'][20042]);
error_log(date('M d H:i:s ').(string) $e);
$object->status = 20042;
return $object;
}
}
/**
* Method to add a new picture.
*
* @param Array $p Parameters
* @return int 0 if OK
*/
public function addPicture($p) {
$p['id'] = 1;
// Finding a free picture ID
while (True) {
if (!isset($this -> pictures[$p['id']])) {
break;
} else {
$p['id'] = $p['id'] + 1;
}
}
// Adding the picture
try {
$this -> pictures[$p['id']] = new Picture($p, $p['id']);
return $this -> save();
} catch (Exception $e) {
// Failed to create the picture
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?pic='.$p['id'].' '.$GLOBALS['messages'][20017]);
error_log(date('M d H:i:s ').(string) $e);
return 20017;
}
}
/**
* Method to delete a network.
*
* @param int $i Network ID
* @return int 0 if OK
*/
public function deleteNetwork($i) {
if (isset($this -> networks[$i])) {
// Unlink node interfaces
foreach ($this -> getNodes() as $node_id => $node) {
foreach ($node -> getInterfaces() as $interface_id => $interface) {
if ($interface -> getNetworkId() === $i) {
$this -> nodes[$node_id] -> unlinkInterface($interface_id);
}
}
}
unset($this -> networks[$i]);
} else {
error_log(date('M d H:i:s ').'WARNING: '.$this -> path .'/'.$this -> filename.'?net='.$i.' '.$GLOBALS['messages'][20023]);
}
return $this -> save();
}
/**
* Method to delete a node.
*
* @param int $i Node ID
* @return int 0 if OK
*/
public function deleteNode($i) {
if (isset($this -> nodes[$i])) {
$node = $this -> nodes[$i];
if (!empty($node -> getSerials())) {
// Node has configured Serial interfaces
foreach ($node -> getSerials() as $interface_id => $interface) {
if ($interface -> getRemoteId() != 0) {
// Serial interface is configured, unlink remote node
$rc = $this -> nodes[$interface -> getRemoteId()] -> unlinkInterface($interface -> getRemoteIf());
if ($rc !== 0) {
error_log(date('M d H:i:s ').'WARNING: '.$this -> path .'/'.$this -> filename.'?node='.$interface -> getRemoteId().' '.$GLOBALS['messages'][20035]);
}
}
}
}
// Delete the node
unset($this -> nodes[$i]);
} else {
error_log(date('M d H:i:s ').'WARNING: '.$this -> path .'/'.$this -> filename.'?node='.$i.' '.$GLOBALS['messages'][20024]);
}
return $this -> save();
}
/**
* Method to delete a text object.
*
* @param int $i Object ID
* @return int 0 if OK
*/
public function deleteTextObject($i) {
if (isset($this -> textobjects[$i])) {
unset($this -> textobjects[$i]);
} else {
error_log(date('M d H:i:s ').'WARNING: '.$this -> path .'/'.$this -> filename.'?obj='.$i.' '.$GLOBALS['messages'][20043]);
}
return $this -> save();
}
/**
* Method to delete a picture.
*
* @param int $i Picture ID
* @return int 0 if OK
*/
public function deletePicture($i) {
if (isset($this -> pictures[$i])) {
unset($this -> pictures[$i]);
} else {
error_log(date('M d H:i:s ').'WARNING: '.$this -> path .'/'.$this -> filename.'?pic='.$i.' '.$GLOBALS['messages'][20018]);
}
return $this -> save();
}
/**
* Method to add or replace the lab metadata.
* Editable attributes:
* - author
* - description
* - version
* If an attribute is set and is valid, then it will be used. If an
* attribute is not set, then the original is maintained. If in attribute
* is set and empty '', then the current one is deleted.
*
* @param Array $p Parameters
* @return int 0 means ok
*/
public function edit($p) {
$modified = False;
if (isset($p['name']) && !checkLabFilename($p['name'].'.unl')) {
// Name is not valid, ignored
error_log(date('M d H:i:s ').'WARNING: '.$GLOBALS['messages'][20038]);
} else if (isset($p['name'])) {
$this -> name = $p['name'];
$modified = True;
}
if (isset($p['author']) && $p['author'] === '') {
// Author is empty, unset the current one
unset($this -> author);
$modified = True;
} else if (isset($p['author'])) {
$this -> author = htmlspecialchars($p['author'], ENT_DISALLOWED, 'UTF-8', TRUE);
$modified = True;
}
if (isset($p['body']) && $p['body'] === '') {
// Body is empty, unset the current one
unset($this -> body);
$modified = True;
} else if (isset($p['body'])) {
$this -> body = htmlspecialchars($p['body'], ENT_DISALLOWED, 'UTF-8', TRUE);
$modified = True;
}
if (isset($p['description']) && $p['description'] === '') {
// Description is empty, unset the current one
unset($this -> description);
$modified = True;
} else if (isset($p['description'])) {
$this -> description = htmlspecialchars($p['description'], ENT_DISALLOWED, 'UTF-8', TRUE);
$modified = True;
}
if (isset($p['version']) && $p['version'] === '') {
// Version is empty, unset the current one
unset($this -> version);
$modified = True;
} else if (isset($p['version']) && (int) $p['version'] < 0) {
// Version is not valid, ignored
error_log(date('M d H:i:s ').'WARNING: '.$GLOBALS['messages'][30008]);
} else if (isset($p['version'])) {
$this -> version = (int) $p['version'];
$modified = True;
}
if (isset($p['scripttimeout'])) {
$this -> scripttimeout = (int) $p['scripttimeout'];
$modified = True;
}
if ($modified) {
// At least an attribute is changed
return $this -> save();
} else {
// No attribute has been changed
error_log(date('M d H:i:s ').'ERROR: '.$GLOBALS['messages'][20030]);
return 20030;
}
}
/**
* Method to edit a network.
*
* @param Array $p Parameters
* @return int 0 if OK
*/
public function editNetwork($p) {
if (!isset($this -> networks[$p['id']])) {
// Network not found
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?net='.$p['id'].' '.$GLOBALS['messages'][20023]);
return 20023;
} else if ($this -> networks[$p['id']] -> edit($p) === 0) {
return $this -> save();
} else {
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?net='.$p['id'].' '.$GLOBALS['messages'][20025]);
return False;
}
}
/**
* Method to edit a node.
*
* @param Array $p Parameters
* @return int 0 if OK
*/
public function editNode($p) {
if (!isset($this -> nodes[$p['id']])) {
// Node not found
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?node='.$p['id'].' '.$GLOBALS['messages'][20024]);
return 20024;
} else if ($this -> nodes[$p['id']] -> edit($p) === 0) {
return $this -> save();
} else {
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?node='.$p['id'].' '.$GLOBALS['messages'][20026]);
return 20026;
}
}
/**
* Method to edit a text object.
*
* @param Array $p Parameters
* @return int 0 if OK
*/
public function editTextObject($p) {
if (!isset($this -> textobjects[$p['id']])) {
// Picture not found
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?obj='.$p['id'].' '.$GLOBALS['messages'][20043]);
return 20043;
} else if ($this -> textobjects[$p['id']] -> edit($p) === 0) {
return $this -> save();
} else {
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?obj='.$p['id'].' '.$GLOBALS['messages'][20044]);
return False;
}
}
/**
* Method to edit a picture.
*
* @param Array $p Parameters
* @return int 0 if OK
*/
public function editPicture($p) {
if (!isset($this -> pictures[$p['id']])) {
// Picture not found
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?pic='.$p['id'].' '.$GLOBALS['messages'][20018]);
return 20018;
} else if ($this -> pictures[$p['id']] -> edit($p) === 0) {
return $this -> save();
} else {
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?pic='.$p['id'].' '.$GLOBALS['messages'][20019]);
return False;
}
}
/**
* Method to get lab author.
*
* @return string Lab author or False if not set
*/
public function getAuthor() {
if (isset($this -> author)) {
return $this -> author;
} else {
// By default return an empty string
return '';
}
}
/**
* Method to get lab body.
*
* @return string Lab body or False if not set
*/
public function getBody() {
if (isset($this -> body)) {
return $this -> body;
} else {
// By default return an empty string
return '';
}
}
/**
* Method to get lab description.
*
* @return string Lab description or False if not set
*/
public function getDescription() {
if (isset($this -> description)) {
return $this -> description;
} else {
// By default return an empty string
return '';
}
}
/**
* Method to get lab filename.
*
* @return string Lab filename
*/
public function getFilename() {
return $this -> filename;
}
/**
* Method to get free network ID.
*
* @return int Free network ID
*/
public function getFreeNetworkId() {
$id = 1;
// Finding a free network ID
while (True) {
if (!isset($this -> networks[$id])) {
return $id;
}
$id = $id + 1;
}
}
/**
* Method to get free node ID.
*
* @return int Free node ID
*/
public function getFreeNodeId() {
$id = 1;
// Finding a free node ID
while (True) {
if (!isset($this -> nodes[$id])) {
return $id;
}
$id = $id + 1;
}
}
/**
* Method to get lab ID.
*
* @return string Lab ID
*/
public function getId() {
return $this -> id;
}
/**
* Method to get lab name.
*
* @return string Lab name
*/
public function getName() {
return $this -> name;
}
/**
* Method to get all lab networks.
*
* @return Array Lab networks
*/
public function getNetworks() {
if (!empty($this -> networks)) {
return $this -> networks;
} else {
// By default return an empty array
return Array();
}
}
/**
* Method to get all lab nodes.
*
* @return Array Lab nodes
*/
public function getNodes() {
if (!empty($this -> nodes)) {
return $this -> nodes;
} else {
// By default return an empty array
return Array();
}
}
/**
* Method to get all lab objects.
*
* @return Array Lab objects
*/
public function getTextObjects() {
if (!empty($this -> textobjects)) {
return $this -> textobjects;
} else {
// By default return an empty array
return Array();
}
}
/**
* Method to get all lab pictures.
*
* @return Array Lab pictures
*/
public function getPictures() {
if (!empty($this -> pictures)) {
return $this -> pictures;
} else {
// By default return an empty array
return Array();
}
}
/**
* Method to get lab path.
*
* @return string Lab absolute path
*/
public function getPath() {
return $this -> path;
}
/**
* Method to get tenant ID.
*
* @return int Tenant ID
*/
public function getTenant() {
return $this -> tenant;
}
/**
* Method to get lab version.
*
* @return string Lab version or False if not set
*/
public function getVersion() {
if (isset($this -> version)) {
return $this -> version;
} else {
// By default return 0
return 0;
}
}
/**
* Method to get lab scripttimeout
*
* @return int Lab version or False if not set
*/
public function getScriptTimeout() {
if (isset($this -> scripttimeout)) {
return (int) $this -> scripttimeout;
} else {
// By default return 0
return 0;
}
}
/**
* Method to connect a node to a network or to a remote node.
*
* @param int $n Node ID
* @param Array $p Array of interfaces to link (index = interface_id, value = remote)
* @return int 0 means ok
*/
public function connectNode($n, $p) {
if (!isset($this -> nodes[$n])) {
// Node not found
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?node='.$n.' '.$GLOBALS['messages'][20032]);
return 20032;
}
foreach ($p as $interface_id => $interface_link) {
if ($interface_link !== '') {
// Interface must be configured
$i = Array();
$i['id'] = $interface_id;
if (strpos($interface_link, ':') === False) {
// No ':' found -> simple Ethernet interface
if (isset($this -> getNetworks()[$interface_link])) {
// Network exists
$i['network_id'] = $interface_link;
// Link the interface
if ($this -> nodes[$n] -> linkInterface($i) !== 0) {
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?node='.$n.' '.$GLOBALS['messages'][20034]);
return 20034;
}
} else {
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?net='.$interface_link.' '.$GLOBALS['messages'][20033]);
return 20033;
}
} else {
// ':' found -> should be Serial interface
$remote_id = substr($interface_link, 0, strpos($interface_link, ':'));
$remote_if = substr($interface_link, strpos($interface_link, ':') + 1);
// Before connect, we need to unlink remote node of both source and destination node
$node = $this -> nodes[$n]; // Source node
if (isset($node -> getSerials()[$interface_id]) && $node -> getSerials()[$interface_id] -> getRemoteId() !== 0) {
// Serial interfaces was previously connected, need to unlink remote node
$rc = $this -> nodes[$node -> getSerials()[$interface_id] -> getRemoteId()] -> unlinkInterface($node -> getSerials()[$interface_id] -> getRemoteIf());
if ($rc !== 0) {
error_log(date('M d H:i:s ').'WARNING: '.$this -> path .'/'.$this -> filename.'?node='.$node_id.' '.$GLOBALS['messages'][20035]);
}
}
$node = $this -> nodes[$remote_id]; // Destination node
if (isset($node -> getSerials()[$remote_if]) && $node -> getSerials()[$remote_if] -> getRemoteId() !== 0) {
// Serial interfaces was previously connected, need to unlink remote node
$rc = $this -> nodes[$node -> getSerials()[$remote_if] -> getRemoteId()] -> unlinkInterface($node -> getSerials()[$remote_if] -> getRemoteIf());
if ($rc !== 0) {
error_log(date('M d H:i:s ').'WARNING: '.$this -> path .'/'.$this -> filename.'?node='.$node_id.' '.$GLOBALS['messages'][20035]);
}
}
// Connect local to remote: Local $n:$interface_id -> Remote $remote_id:$remote_if
$i['id'] = $interface_id;
$i['remote_id'] = $remote_id;
$i['remote_if'] = $remote_if;
// Link the interface
if ($this -> nodes[$n] -> linkInterface($i) !== 0) {
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?node='.$n.' '.$GLOBALS['messages'][20034]);
return 20034;
}
// Connect remote to local: Local $n:$interface_id <- Remote $remote_id:$remote_if
$i = Array();
$i['id'] = $remote_if;
$i['remote_id'] = $n;
$i['remote_if'] = $interface_id;
// Link the interface
if ($this -> nodes[$remote_id] -> linkInterface($i) !== 0) {
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?node='.$remote_id.' '.$GLOBALS['messages'][20034]);
return 20034;
}
}
} else {
// Interface must be deconfigured
$node = $this -> nodes[$n];
if (isset($node -> getSerials()[$interface_id]) && $node -> getSerials()[$interface_id] -> getRemoteId() !== 0) {
// Serial interfaces was previously connected, need to unlink remote node
$rc = $this -> nodes[$node -> getSerials()[$interface_id] -> getRemoteId()] -> unlinkInterface($node -> getSerials()[$interface_id] -> getRemoteIf());
if ($rc !== 0) {
error_log(date('M d H:i:s ').'WARNING: '.$this -> path .'/'.$this -> filename.'?node='.$node -> getSerials()[$interface_id] -> getRemoteId().' '.$GLOBALS['messages'][20035]);
}
}
// Now deconfigure local interface
if ($this -> nodes[$n] -> unlinkInterface($interface_id) !== 0) {
error_log(date('M d H:i:s ').'ERROR: '.$this -> path .'/'.$this -> filename.'?node='.$n.' '.$GLOBALS['messages'][20035]);
return 20035;
}
}
}
return $this -> save();
}
/**
* Method to save a lab into a file.
*
* @return int 0 means ok
*/
public function save() {
// TODO should lock file before editing it
// XML header is splitted because of a highlight syntax bug on VIM
$xml = new SimpleXMLElement('<?xml version="1.0" encoding="UTF-8" standalone="yes"?'.'><lab></lab>');
$xml -> addAttribute('name', $this -> name);