-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathTerminal.gd
2575 lines (2504 loc) · 86.7 KB
/
Terminal.gd
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
#warning-ignore-all:return_value_discarded
extends Object
class_name Terminal
const HELP_TEXT := "Ce terminal vous permet d'écrire des commandes Bash simplifiées.\n" \
+ "Le but est pédagogique. Vous pouvez apprendre des commandes et vous entrainer.\n" \
+ "Les commandes ont été reproduites le plus fidèlement possible, mais quelques différences peuvent apparaître.\n\n" \
+ "Rappels sur comment écrire une commande :\n" \
+ "Une commande vous permet de manipuler les fichiers et dossiers de votre environnement de travail.\n" \
+ "En règle générale, la syntaxe pour une commande ressemble à ça : [b]nom_de_la_commande[/b] [...[b]options[/b]] [...[b]arguments[/b]].\n\n" \
+ "Utilisez des redirections pour modifier le comportement d'une commande. Une redirection est un numéro : \n" \
+ "- 0 : entrée standard\n" \
+ "- 1 : sortie standard\n" \
+ "- 2 : sortie d'erreur\n" \
+ "Exemple : head file.txt 1>resultat.txt (réécris, ou crée, le fichier \"resultat.txt\" avec le résultat écrit de la commande).\n" \
+ "Utilisez les symboles :\n" \
+ "- > : réécrit le fichier\n" \
+ "- < : lit le fichier\n" \
+ "- >> : ajoute au fichier\n\n" \
+ "Enchainez des commandes sur la même ligne en les séparant par un \"|\" (\"pipe\" en anglais).\n" \
+ "L'entrée standard de la commande suivante sera le résultat écrit de la commande précédente.\n" \
+ "Exemple : echo yoyo | cat"
# The signal `interface_changed` can be used to read the standard output of a successful command.
# It is different from `command_executed` because `command_executed` might be thrown several times in a row.
# Indeed, several commands can be on the same line separated by pipes.
# Example:
# $ echo toto | echo tata
# `command_executed` will be emitted twice with `output` set to "toto" and then "tata"
# `interface_changed` will be emitted once with `content` set to "tata" (the last standard output of the row)
# NOTE: all the arguments passed to the signals are passed by REFERENCE.
# Therefore, any modification of the references will modify the terminal's system tree
# (unless the element is voluntarily removed by the algorithm which is the case for the `origin` argument of the `file_moved` signal).
# If a copy needs to be done, then see the following functions:
# - `copy_element()` (Terminal.gd)
# - `copy_children_of()` (Terminal.gd)
# - `move_inside_of()` (SystemElement.gd)
signal command_executed (command, output) # command is a dictionary and output is the content of standard output, the signal will be emitted only if the command didn't throw an error
signal error_thrown (command, reason) # emitted when the `command` threw an error, which text is the `reason`
signal permissions_changed (file) # file is a SystemElement (file or FOLDER)
signal file_created (file) # file is a SystemElement (file or FOLDER)
signal file_destroyed (file) # file is a SystemElement (file or FOLDER)
signal file_changed (file) # emitted when "nano" was used to edit the content of a file. It does not detect if the new content is different.
signal file_read (file) # emitted when the file is being read (via the cat command).
signal file_copied (origin, copy) # emitted when the `origin` is being copied. Note that `origin` != `copy` (not the same reference, and the absolute path of the copy, or its content, might be different from the origin's).
signal file_moved (origin, target) # emitted when the `origin` is being moved elsewhere. The origin is destroyed (but `file_destroyed` is not emitted) and `target` is the new instance of SystemElement.
signal directory_changed (target) # emitted when the `cd` command is used (and didn't throw an error)
signal interface_changed (content) # emitted when something is printed onto the screen. It is not emitted when the interface is cleared.
signal manual_asked (command_name, output) # emitted when the `man` command is used to open the manual page of a command.
signal variable_set (name, value, is_new) # emitted when a variable is created, "name" and "value" are strings, is_new is true if the variable was just created or false if it was modified.
signal script_executed (script, output) # emitted when a script was executed. `script` is the instance of SystemElement of the script, `output` is the output printed to the interface. It does not contain what's been redirected.
signal help_asked # emitted when the custom `help` command is used.
signal interface_cleared
var max_paragraph_width := 50
var nano_editor = null
var edited_file = null
var user_name := "vous" # the currently logged in user's name
var group_name := "votre_groupe" # the currently logged in user's group name
var error_handler := ErrorHandler.new() # this will be used in case specific erros happen deep into the logic
var system: System # we'll start the terminal with an empty root by default
var PWD := PathObject.new("/") # the absolute path we are currently on in the `system`
var pid: int # the number of the current process
var dns := DNS.new([])
var ip_address := ""
# The `runtime` variable holds all the execution contexts.
# Bash usually creates only global variables no matter where they've been initialised.
# We are not taking into account the "local" keyword.
# The first index of this array will be the global context.
# For now, we'll only have one context.
var runtime := [BashContext.new()]
var m99 := M99.new()
func _display_error_or(error: String):
return error_handler.clear() if error_handler.has_error else error
var COMMANDS := {
"man": {
"allowed": true, # if false, an error "the command does not exist" will be thrown instead
"reference": funcref(self, "man"),
"manual": {
"name": "man - affiche la page du manuel expliquant une commande précise.",
"synopsis": ["[b]man[/b] [u]nom[/u]"],
"description": "Cette commande fait référence au manuel qui contient une explication de toutes les commandes disponibles. Le 'nom' doit être le nom d'une commande valide, sinon une erreur sera renvoyée.",
"options": [],
"examples": []
}
},
"echo": {
"allowed": true,
"reference": funcref(self, "echo"),
"manual": {
"name": "echo - affiche un texte dans le terminal.",
"synopsis": ["[b]echo[/b] [-n] [[u]contenu[/u] [u]...[/u]]"],
"description": "Affiche tout le contenu séparé par un espace blanc entre le nom de la commande et la fin de la commande, sauf s'il y a l'option -n qui permet de ne pas continuer le résultat par un '\\n'.",
"options": [
{
"name": "-n",
"description": "N'ajoute pas un retour à la ligne à la fin du contenu."
}
],
"examples": [
"echo -n hello, world",
"echo \"hello world\""
]
}
},
"grep": {
"allowed": true,
"reference": funcref(self, "grep"),
"manual": {
"name": "grep - cherche un pattern dans l'entrée standard.",
"synopsis": ["[b]grep[/b] [[b]-c[/b] [u]nombre[/u]] [u]pattern[/u] [fichier]"],
"description": "Cherche dans l'entrée standard les lignes qui correspondent au pattern donné. Si le pattern n'y est pas trouvé, la ligne est ignorée. S'il est trouvé, elle est affichée et ce qui correspond au pattern est mis en évidence.",
"options": [],
"examples": [
"cat fichier.txt | grep hello",
"grep hello fichier.txt"
]
}
},
"tr": {
"allowed": true,
"reference": funcref(self, "tr_"),
"manual": {
"name": "tr - remplace, ou supprime, un pattern précis depuis l'entrée standard pour l'afficher dans la sortie standard.",
"synopsis": [
"[b]tr[/b] [u]pattern[/u] [u]remplacement[/u]",
"[b]tr[/b] [b]-d[/b] [u]pattern[/u]"
],
"description": "Remplace le pattern par la chaine de remplacement donnée. Si l'option -d est précisée, toutes les occurrences du pattern seront supprimées. Le résultat est affiché dans la sortie standard.",
"options": [
{
"name": "-d",
"description": "supprime les occurrences du pattern plutôt que de les remplacer."
}
],
"examples": [
"echo buste | tr u a",
"echo truc | tr -d u"
]
}
},
"cat": {
"allowed": true,
"reference": funcref(self, "cat"),
"manual": {
"name": "cat - affiche le contenu d'un fichier en sortie standard.",
"synopsis": ["[b]cat[/b] [u]fichier[/u]"],
"description": "Renvoie le contenu du fichier donné, s'il existe, dans la sortie standard. Cette action ne peut pas être réalisée sur un dossier.",
"options": [],
"examples": [
"cat fichier.txt"
]
}
},
"ls": {
"allowed": true,
"reference": funcref(self, "ls"),
"manual": {
"name": "ls - liste le contenu d'un dossier.",
"synopsis": ["[b]ls[/b] [[b]-a[/b]] [[b]-l[/b]] [[u]dossier[/u]]"],
"description": "La commande va lister le contenu des dossiers, en colorant en vert les dossiers, et en blanc les fichiers. Par défaut, les fichiers et dossiers cachés (c'est-à-dire ceux préfixés par un point) ne seront pas affichés. Pour les afficher, utilisez l'option -a.",
"options": [
{
"name": "-a",
"description": "Affiche les fichiers cachés (ceux préfixés d'un point)"
},
{
"name": "-l",
"description": "Affiche les fichiers et dossiers contenus dans la cible avec des données supplémentaires."
}
],
"examples": [
"ls folder",
"ls -a folder",
"ls -l ."
]
}
},
"clear": {
"allowed": true,
"reference": funcref(self, "clear"),
"manual": {
"name": "clear - vide le terminal de son contenu textuel.",
"synopsis": ["[b]clear[/b]"],
"description": "Le contenu du terminal est supprimé pour reprendre sur un écran vide.",
"options": [],
"examples": []
}
},
"pwd": {
"allowed": true,
"reference": funcref(self, "pwd"),
"manual": {
"name": "pwd - retourne le chemin absolu du dossier courant.",
"synopsis": ["[b]pwd[/b]"],
"description": "La commande pwd écrit dans la sortie standard le chemin absolu du dossier courant. Naviguez dans les dossiers en utilisant la commande \"cd\".",
"options": [],
"examples": []
}
},
"cd": {
"allowed": true,
"reference": funcref(self, "cd"),
"manual": {
"name": "cd - définit le chemin courant comme étant la cible.",
"synopsis": ["[b]cd[/b] [[u]chemin[/u]]"],
"description": "Définit la variable $PWD comme étant le chemin absolu de la destination ciblée par le chemin donné. Ne pas donner de chemin revient à écrire la racine, \"/\".",
"options": [],
"examples": [
"cd folder",
"cd"
]
}
},
"touch": {
"allowed": true,
"reference": funcref(self, "touch"),
"manual": {
"name": "touch - crée un nouveau fichier selon la destination donnée.",
"synopsis": ["[b]touch[/b] [u]chemin[/u]"],
"description": "La commande crée un nouveau fichier avec le nom donné dans le chemin. La cible doit nécessairement être un fichier. Pour créer un dossier, il vous faut utiliser la commande \"mkdir\".",
"options": [],
"examples": [
"touch folder/file.txt"
]
}
},
"mkdir": {
"allowed": true,
"reference": funcref(self, "mkdir"),
"manual": {
"name": "mkdir - crée un nouveau dossier selon la destination donnée.",
"synopsis": ["[b]mkdir[/b] [u]chemin[/u]"],
"description": "La commande crée un nouveau dossier avec le nom donné dans le chemin. Pour créer un fichier, vous devriez utiliser la commande \"touch\".",
"options": [],
"examples": [
"mkdir folder/newfolder"
]
}
},
"rm": {
"allowed": true,
"reference": funcref(self, "rm"),
"manual": {
"name": "rm - supprime de manière définitive un élément.",
"synopsis": ["[b]rm[/b] [[b]-rd[/b]] [u]file[/u]"],
"description": "Cette commande permet de supprimer un fichier, ou un dossier si spécifiée avec l'option -d. Par défaut, un dossier qui n'est pas vide ne peut être supprimé, sauf si l'option -r (pour \"récursif\") est mentionnée.",
"options": [
{
"name": "d",
"description": "Permet de supprimer un dossier. Inutile si -r est mentionnée."
},
{
"name": "r",
"description": "Permet de supprimer un dossier et son contenu avec."
}
],
"examples": [
"rm file.txt",
"rm -d emptyfolder",
"rm -r folder"
]
}
},
"cp": {
"allowed": true,
"reference": funcref(self, "cp"),
"manual": {
"name": "cp - copie un élément vers une autre destination.",
"synopsis": ["[b]cp[/b] [u]origine[/u] [u]destination[/u]"],
"options": [],
"description": "Réalise la copie de l'élément d'origine vers la nouvelle destination. La copie devient indépendante de l'originale. Si une copie d'un dossier vers un autre dossier est réalisée, et que cet autre dossier contient des fichiers de même nom que le premier, alors ces fichiers seront remplacés, leur contenu ainsi perdu.",
"examples": [
"cp file.txt copiedfile.txt",
"cp file.txt folder/file.txt",
"cp folder copiedfolder"
]
}
},
"mv": {
"allowed": true,
"reference": funcref(self, "mv"),
"manual": {
"name": "mv - déplace un élément vers une nouvelle destination.",
"synopsis": ["[b]mv[/b] [u]origine[/u] [u]destination[/u]"],
"description": "Déplace un élément d'origine vers une nouvelle destination. Ceci permet de renommer un élément. Si un déplacement a lieu d'un élément vers un autre qui existe déjà, alors, si la cible est un fichier, il est remplacé et l'élément d'origine est supprimé, ou s'il s'agit d'un dossier alors il est placé comme enfant de la cible.",
"options": [],
"examples": [
"mv file.txt renamedfile.txt",
"mv file.txt folder",
"mv folder otherfolder"
]
}
},
"help": {
"allowed": true,
"reference": funcref(self, "help"),
"manual": {
"name": "help - commande si vous avez besoin d'aide quant à Bash.",
"synopsis": ["[b]help[/b]"],
"description": "Utilisez cette commande si vous avez besoin de rappels quant au fonctionnement primaire de Bash. La commande vous propose également une liste de toutes les commandes disponibles, avec une rapide description de chacune.",
"options": [],
"examples": []
}
},
"tree": {
"allowed": true,
"reference": funcref(self, "tree"),
"manual": {
"name": "tree - affiche une reconstitution de l'arborescence du dossier courant.",
"synopsis": ["[b]tree[/b]"],
"description": "Cette commande est utile pour afficher le contenu du dossier courant, ainsi que le contenu des sous-dossiers, de façon à avoir une vue globale de l'environnement de travail. En revanche, elle ne permet pas de visualiser les fichiers cachés.",
"options": [],
"examples": []
}
},
"chmod": {
"allowed": true,
"reference": funcref(self, "chmod"),
"manual": {
"name": "chmod - définit les permissions accordées à un élément.",
"synopsis": ["[b]chmod[/b] [u]mode[/u] [u]fichier[/u]"],
"description": "Il y a trois catégories (utilisateur, groupe, autres) qui ont chacune trois types d'autorisations : lecture (r), écriture (w), exécution/franchissement (x). Les permissions s'écrivent \"-rwx--xr--\" où le premier caractère est soit \"d\" pour un dossier, ou \"-\" pour un fichier et où l'utilisateur a les droits combinés \"rwx\" (lecture, écriture et exécution) et où le groupe a les droits d'exécution seulement et les autres le droit de lecture uniquement. En règle générale, les permissions sont données sous la forme de trois chiffres en octal dont la somme est une combinaison unique : 4 pour la lecture, 2 pour l'écriture et 1 pour l'exécution. Par défaut un fichier, à sa création, a les droits 644. Accordez ou retirez un droit spécifique avec \"chmod u+x file.txt\" (raccourcie en \"chmod +x file.txt\" quand il s'agit de l'utilisateur, ([b]u[/b] pour utilisateur, [b]g[/b] pour groupe, [b]o[/b] pour autres)), ou détaillez la règle en octal à appliquer sur les trois catégories (\"chmod 657 file.txt\").",
"options": [],
"examples": [
"chmod u+x file.txt",
"chmod g-x folder/",
"chmod o-r folder/",
"chmod 007 file.txt"
]
}
},
"nano": {
"allowed": true,
"reference": funcref(self, "nano"),
"manual": {
"name": "nano - ouvre un éditeur pour éditer un fichier dans le terminal.",
"synopsis": ["[b]nano[/b] [u]fichier[/u]"],
"description": "Nano est l'éditeur par défaut de Bash. Utilisez cette commande pour éditer un fichier déjà existant. Si le fichier cible n'existe pas, il sera créé. La version de Nano proposée ici est modifiée pour convenir à une utilisation à la souris.",
"options": [],
"examples": [
"nano file.txt"
]
}
},
"seq": {
"allowed": true,
"reference": funcref(self, "seq"),
"manual": {
"name": "seq - affiche une séquence de nombres.",
"synopsis": ["[b]seq[/b] [[b]-s[/b] [u]string[/u]] [[b]-t[/b] [u]string[/u]] [[u]début[/u] [[u]saut[/u]]] [u]fin[/u]"],
"description": "Affiche une séquence de nombres, avec un nombre par ligne. La séquence commence à 1 par défaut et s'incrémente de 1 par défaut (le \"saut\" est de 1). Si la fin est inférieure au début, le saut sera par défaut de -1. Si le saut donné n'est pas négatif, une erreur sera renvoyée. Le séparateur entre chaque nombre peut être défini avec l'option -s, et la fin de la séquence peut être personnalisée avec l'option -t.",
"options": [
{
"name": "s",
"description": "Permet de définir le séparateur entre chaque nombre de la séquence."
},
{
"name": "t",
"description": "Permet d'afficher une chaine de caractères précise à la fin de la séquence."
}
],
"examples": [
"seq 10 0",
"seq 10 5 50",
"seq -s ',' 10 20",
"seq -t 'LANCEMENT' 10 0"
]
}
},
"ping": {
"allowed": true,
"reference": funcref(self, "ping"),
"manual": {
"name": "ping - établis une connexion simple à une autre adresse.",
"synopsis": ["[b]ping[/b] [u]adresse[/u]"],
"description": "Des paquets très simples sont envoyés à l'adresse cible. La cible peut être une adresse IP ou l'URL directement. Si une URL est précisée, alors la commande ira chercher dans le serveur DNS le plus proche l'adresse IP de la destination.",
"options": [],
"examples": [
"ping example.com",
"ping 192.168.10.1"
]
}
},
"head": {
"allowed": true,
"reference": funcref(self, "head"),
"manual": {
"name": "head - affiche les premières lignes d'un fichier.",
"synopsis": ["[b]head[/b] [[b]-n[/b] [u]nombre[/u]] [[u]fichier[/u]]"],
"description": "Par défaut, les 10 premières lignes du fichier sont affichées. Précisez le nombre de lignes désirées avec l'option -n.",
"options": [
{
"name": "n",
"description": "Précise le nombre de lignes voulues."
}
],
"examples": [
"head file.txt",
"head -n 1 file.txt",
"cat file.txt | head"
]
}
},
"tail": {
"allowed": true,
"reference": funcref(self, "tail"),
"manual": {
"name": "tail - affiche les dernières lignes d'un fichier.",
"synopsis": ["[b]tail[/b] [[b]-n[/b] [u]nombre[/u]] [[u]fichier[/u]]"],
"description": "Par défaut, les 10 dernières lignes du fichier sont affichées. Précisez le nombre de lignes désirées avec l'option -n. Vous pouvez partir du début du fichier en donnant plutôt un nombre qui commence par '+'. Ainsi, pour afficher un contenu sans la première ligne, ce serait 'tail +2'.",
"options": [
{
"name": "n",
"description": "Précise le nombre de lignes voulues."
}
],
"examples": [
"tail file.txt",
"tail -n 1 file.txt",
"cat file.txt | tail",
"cat file.csv | tail +2"
]
}
},
"cut": {
"allowed": true,
"reference": funcref(self, "cut"),
"manual": {
"name": "cut - sélectionne une portion précise de chaque ligne d'un fichier.",
"synopsis": [
"[b]cut[/b] [b]-c[/b] [u]liste[/u] [[u]fichier[/u]]",
"[b]cut[/b] [b]-f[/b] [u]liste[/u] [b]-d[/b] [u]délimiteur[/u] [[u]fichier[/u]]"
],
"description": "La commande va couper chaque ligne de manière à afficher une portion précise. Sélectionnez un groupe de caractères avec l'option '-c', ou des champs particuliers via le délimiteur donné par l'option '-d' (qui est par défaut TAB : '\\t'). Spécifiez quels champs sélectionner avec '-f'. Sélectionnez une liste de champs (les champs 2 et 5 par exemple) en écrivant une virgule : '2,5'. Sélectionnez un intervalle de x à y en écrivant : x-y.",
"options": [
{
"name": "c",
"description": "Sélectionne des caractères."
},
{
"name": "f",
"description": "Sélectionne un champ par un délimiteur particulier donné par l'option '-d'."
},
{
"name": "d",
"description": "Définit un délimiteur particulier avec lequel désigner des champs à sélectionner."
}
],
"examples": [
"cat fichier.csv | cut -c 5 # sélectionne le 5e caractère",
"cat fichier.csv | cut -c 5,10 # sélectionne le 5e et le 10e caractère",
"cat fichier.csv | cut -c 5-10 # sélectionne les caractères de la position 5 à 10",
"cat fichier.csv | cut -f 2 -d ',' # sélectionne le 2e champ séparé par une virgule",
"cat fichier.csv | cut -f 2,3,5-8 -d ',' # sélectionne le 2e et 3e champs, puis du 5e au 8e."
]
}
},
"startm99": {
"allowed": true,
"reference": funcref(self, "startm99"),
"manual": {
"name": "startm99 - commande custom pour démarrer un simulateur de langage tel que Assembler appelé M99.",
"synopsis": ["[b]startm99[/b]"],
"description": "Démarre un simulateur pédagogique pour apprendre les bases de l'Assembler.",
"options": [],
"examples": []
}
}
}
static func replace_bbcode(text: String, replacement: String) -> String:
var regex := RegEx.new()
regex.compile("\\[\\/?(?:b|i|u|s|left|center|right|quote|code|list|img|spoil|color).*?\\]")
var search := regex.search_all(text)
var result := text
for r in search:
result = result.replace(r.get_string(), replacement)
return result
static func remove_bbcode(text: String) -> String:
return replace_bbcode(text, "")
static func cut_paragraph(paragraph: String, line_length: int) -> Array:
if paragraph.length() <= line_length:
return [paragraph]
var lines := []
var i := 0
var pos := 0
while i < (paragraph.length() / line_length):
var e := 0
while (pos+line_length+e) < paragraph.length() and paragraph[pos+line_length+e] != " ":
e += 1
lines.append(paragraph.substr(pos, line_length + e).strip_edges())
pos += line_length + e
i += 1
lines.append(paragraph.substr(pos).strip_edges())
return lines
static func build_manual_page_using(manual: Dictionary, max_size: int) -> String:
var output := ""
output += "[b]NOM[/b]\n\t" + manual.name + "\n\n"
output += "[b]SYNOPSIS[/b]\n"
for synopsis in manual.synopsis:
output += "\t" + synopsis + "\n"
output += "\n[b]DESCRIPTION[/b]\n"
var description_lines := cut_paragraph(manual.description, max_size)
for line in description_lines:
output += "\t" + line + "\n"
if not manual.options.empty():
output += "[b]OPTIONS[/b]\n"
for option in manual.options:
output += "\t[b]" + option.name + "[/b]\n"
output += "\t\t" + option.description + "\n"
if not manual.examples.empty():
output += "\n[b]EXEMPLES[/b]\n"
for example in manual.examples:
output += "\t" + example + "\n"
return output
static func build_help_page(text: String, commands: Dictionary) -> String:
var output := text + "\n\n"
var max_synopsis_size := 40
var max_description_size := 60
for command in commands:
if "allowed" in commands[command] and not commands[command].allowed:
continue
var synopsis = replace_bbcode(commands[command].manual.synopsis[0], "")
var description = replace_bbcode(commands[command].manual.name, "")
var space = max_synopsis_size - synopsis.length()
description = description.right(description.find("-"))
output += synopsis.left(max_synopsis_size) + (" ".repeat(space + 3) if synopsis.length() < max_synopsis_size else "") + ("..." if synopsis.length() > max_synopsis_size else "") + " " + description.left(max_description_size) + ("..." if description.length() > max_description_size else "") + "\n"
return output
# Define a terminal with its unique PID.
# Set what System the terminal has to be using.
# `editor` is the scene to use for file editing (it must be an instance of WindowPopup)
# however `editor` is optional (null by default).
func _init(p: int, sys: System, editor = null):
pid = p
system = sys
if editor != null and editor is WindowDialog:
set_editor(editor)
func set_editor(editor: WindowDialog) -> void:
if nano_editor != null:
# If the editor is being changed,
# then we want to make sure that the old editor
# doesn't receive the signals anymore.
(nano_editor.get_node("Button") as Button).disconnect("pressed", self, "_on_nano_saved")
(nano_editor as WindowDialog).get_close_button().disconnect("pressed", self, "_on_nano_saved")
(editor as WindowDialog).get_node("Button").connect("pressed", self, "_on_nano_saved")
editor.get_close_button().connect("pressed", self, "_on_nano_saved")
nano_editor = editor
func set_dns(d: DNS) -> void:
dns = d
func set_custom_text_width(max_char: int) -> void:
max_paragraph_width = max_char
# Configures the IP address of the terminal.
# It will be used when using the `ping` command.
# Returns false if the given ip is not valid.
func set_ip_address(ip: String) -> bool:
if ip.is_valid_ip_address():
ip_address = ip
return true
return false
# Sets all commands to "allowed: false",
# except those given in `commands`.
func set_allowed_commands(commands: Array) -> void:
for c in COMMANDS:
if c == "help":
continue
COMMANDS[c].allowed = false
var keys := COMMANDS.keys()
for c in commands:
if c in keys:
COMMANDS[c].allowed = true
# Set "allowed: false" for all commands given in `commands`.
func forbid_commands(commands: Array) -> void:
var keys := COMMANDS.keys()
for c in commands:
if c in keys:
COMMANDS[c].allowed = false
func _write_to_redirection(redirection: Dictionary, output: String) -> void:
if redirection.type == Tokens.WRITING_REDIRECTION:
redirection.target.content = output
elif redirection.type == Tokens.APPEND_WRITING_REDIRECTION:
redirection.target.content += output
# Give as input the parsing result of a command.
# Let's take for example `cat $(echo file.txt)`
# This will read the substitution tokens
# and replace them with a PLAIN token
# with value the standard output of the sub-command.
# If the standard output of the sub-command is empty, it will be ignored.
# If the `clear` command is executed inside the sub-command, it is ignored.
# This function will return a dictionary.
# {"error": String or null, "tokens": Array or undefined }
func interpret_substitutions(options: Array) -> Dictionary:
var tokens := []
for option in options:
if option.is_command_substitution():
var interpretation = interpret_one_substitution(option)
if interpretation.error != null:
return interpretation
else:
if interpretation.tokens != null:
tokens.append_array(interpretation.tokens)
else:
tokens.append(option)
return {
"error": null,
"tokens": tokens
}
# Interprets a single substitution.
# Usually, we'll only want to use `interpret_substitutions`.
# However, it's useful for the substitutions that may be in the redirections.
# Returns a dictionary { "error": String or null, "tokens": array of PLAIN BashTokens, or just null if there is not output }
func interpret_one_substitution(token: BashToken) -> Dictionary:
var execution := execute(token.value, null, false)
# Because the execution possibly have multiple independant commands
# we have to make only one series of tokens out of everything.
var one_line_output := ""
for output in execution.outputs:
if output.error != null:
one_line_output += output.error
else:
one_line_output += output.text.strip_edges() + " "
one_line_output = one_line_output.strip_edges()
one_line_output = remove_bbcode(one_line_output)
var splitted_token := _split_variable_value(one_line_output)
if not one_line_output.empty():
return {
"error": null,
"tokens": splitted_token
}
return {
"error": null,
"tokens": null
}
# Executes the input of the user.
# The command substitutions will be recursively executed using `interpret_substitutions` on the input.
# If the commands fails, then this function will return { "error": String }.
# Otherwise, it will return { "error": null, "output": String, "interface_cleard": bool }
func execute(input: String, interface: RichTextLabel = null, can_change_interface := true) -> Dictionary:
var lexer := BashLexer.new(input)
if not lexer.error.empty():
return {
"outputs": [{
"error": lexer.error
}]
}
return _execute_tokens(lexer.tokens_list, interface, can_change_interface)
func _execute_tokens(tokens: Array, interface: RichTextLabel = null, can_change_interface := true) -> Dictionary:
var parser := BashParser.new(runtime[0], pid)
var parsing := parser.parse(tokens)
if not parser.error.empty():
return {
"outputs": [{
"error": parser.error
}]
}
if m99.started and parsing.size() > 1:
return {
"outputs": [{
"error": "Impossible d'enchainer plusieurs commandes à la suite de la sorte dans le M99."
}]
}
var outputs := [] # the array that will contain all outputs which are dictionaries : {"error": String or null, "text": String, "interface_cleared": bool }
var standard_input := "" # the last standard output
var cleared := false
for node in parsing:
for z in range(0, node.size()):
var command = node[z]
if command.type == "command":
if m99.started:
if not command.redirections.empty():
return {
"outputs": [{
"error": "M99 n'accepte aucune redirection."
}]
}
return execute_m99_command(command.name, command.options)
# The interpretation of the variables must be done here.
# It could have been done during the parsing process but the for loops would not work properly.
command.options = interpret_variables(command.options)
for i in range(0, command.redirections.size()):
var interpretation := interpret_variables([command.redirections[i].target])
if interpretation.size() > 1:
return {
"outputs": [{
"error": "Symbole inattendu après redirection du port " + str(command.redirections[i].port) + "."
}]
}
else:
command.redirections[i].target = interpretation[0]
var function = COMMANDS[command.name] if command.name in COMMANDS else null
if function == null and command.name.find('/') != -1:
var path_to_executable := PathObject.new(command.name)
if path_to_executable.is_valid:
# for now, an error in the file will stop the entire input
# even if there are other commands waiting, separated by semicolons
var executable = get_file_element_at(path_to_executable)
if executable == null:
outputs.append({
"error": _display_error_or("Le fichier n'existe pas")
})
break
if not executable.is_file():
outputs.append({
"error": "L'élément n'est pas un fichier !"
})
break
if not executable.can_execute_or_go_through():
outputs.append({
"error": "Permission refusée"
})
break
var file_execution = execute_file(executable, command.options, interpret_redirections(command.redirections), interface)
for o in file_execution.outputs:
outputs.append(o)
continue
# if the function doesn't exist,
# function.reference.is_valid() will be false.
if function == null or not function.reference.is_valid() or not function.allowed:
outputs.append({
"error": "La commande '" + command.name + "' n'existe pas."
})
break
else:
var substitutions_interpretation = interpret_substitutions(command.options)
if substitutions_interpretation.error != null:
outputs.append(substitutions_interpretation)
break
else:
command.options = substitutions_interpretation.tokens
var command_redirections = interpret_redirections(command.redirections)
if error_handler.has_error:
outputs.append({
"error": "Commande '" + command.name + "' : " + error_handler.clear()
})
break
command.redirections = command_redirections
for i in range(0, command_redirections.size()):
if command_redirections[i] != null and command_redirections[i].target == null:
outputs.append({
"error": "Impossible de localiser, ni de créer, la destination du descripteur " + str(i) + "."
})
break
var result = function.reference.call_func(command.options, command_redirections[0].target.content if command_redirections[0] != null and command_redirections[0].type == Tokens.READING_REDIRECTION else remove_bbcode(standard_input))
if command_redirections[2] != null:
if result.error == null:
if command_redirections[2].type == Tokens.WRITING_REDIRECTION:
command_redirections[2].target.content = ""
else:
if command_redirections[2].type == Tokens.WRITING_REDIRECTION:
command_redirections[2].target.content = "Commande '" + command.name + "' : " + result.error
elif command_redirections[2].type == Tokens.APPEND_WRITING_REDIRECTION:
command_redirections[2].target.content += "Commande '" + command.name + "' : " + result.error
emit_signal("error_thrown", command, result.error)
standard_input = ""
break # if there is an error, we have to stop the command anyway
if result.error != null:
emit_signal("error_thrown", command, result.error)
outputs.append({
"error": "Commande '" + command.name + "' : " + result.error
})
standard_input = ""
break
else:
var output_without_bbcode = remove_bbcode(result.output)
emit_signal("command_executed", command, output_without_bbcode)
if m99.started:
if interface != null:
interface.text = ""
cleared = true
standard_input = result.output
break
if command_redirections[0] != null:
# Even though it doesn't make any sense to try to write something
# to the standard input, Bash overwrites the content of the target anyway.
# We have to reproduce the same behaviour, no matter how weird it sounds.
# The output to apply on the standard input would always be an empty string.
# If the standard input doesn't have a writing redirection (> or >>),
# then this function won't do anything.
_write_to_redirection(command_redirections[0], "")
if command_redirections[1] != null:
_write_to_redirection(command_redirections[1], output_without_bbcode)
standard_input = ""
else:
standard_input = result.output
if command.name == "clear":
cleared = true
if interface != null:
emit_signal("interface_cleared")
elif command.type == "for":
outputs.append_array(_execute_for_loop(command).outputs)
else: # the line is a variable affectation
var variable_value = command.value # command.value is a BashToken
if variable_value.type == Tokens.SUBSTITUTION:
var interpretation = interpret_one_substitution(variable_value)
if interpretation.error != null:
outputs.append(interpretation)
var string_value := ""
for token in interpretation.tokens:
string_value += token.value.strip_edges() + " "
variable_value = BashToken.new(Tokens.PLAIN, string_value)
elif variable_value.type == Tokens.VARIABLE:
var interpretation := interpret_variables([variable_value])
var string_value := ""
for token in interpretation:
string_value += token.value.strip_edges() + " "
variable_value = BashToken.new(Tokens.PLAIN, string_value)
var is_new = runtime[0].set_variable(command.name, variable_value)
emit_signal("variable_set", command.name, variable_value.value, is_new)
# If it's not the last command (if it's the second one in "command1 | command2 | command3" for example),
# then we don't want to keep the bbcode in the standard input of the next command.
if (z + 1) < node.size():
standard_input = remove_bbcode(standard_input)
if cleared or not standard_input.empty():
if can_change_interface:
emit_signal("interface_changed", standard_input)
outputs.append({
"error": null,
"text": standard_input,
"interface_cleared": cleared
})
cleared = false
standard_input = ""
return {
"outputs": outputs,
}
# Interprets a token of type VAR.
# Those tokens are variables.
# Sometimes in the parsing process,
# we'll want to interpret them right away
# in order to use their value directly.
# However, in some cases we don't want them to be interpreted.
# This is the case for the for-loop.
# Also, because some variables might be interpreted as multiple tokens,
# we have to return an array, even though most of the time it will contain only one element.
func interpret_variables(tokens: Array) -> Array:
var list := []
var token: BashToken
for i in range(0, tokens.size()):
token = tokens[i]
if token.is_variable():
# If multiple variables are chained like this: "$$$yoyo"
# then we want a single token representing the concatenation of their value.
# To do that, if we detect that the previous token that we interpreted was also a variable,
# then we add to the value of the previous interpreted token the interpreted value of the current token.
var value: String = str(pid) if token.value == "$" else runtime[0].get_variable_value(token.value)
if i > 0 and tokens[i-1].is_variable():
list[i-1].value += value
else:
# If the value has multiple words separated by white space, then it must be interpreted as multiple PLAIN tokens.
# You can observe this behaviour by creating a variable with multiple words, like this: HELLO="HEL LO"
# Create a script that loops over $@ and does an echo of each value.
# You'll observe multiple lines getting printed, even if you just typed ./script $HELLO
# It does not happen if the variable is in a string.
# It's called "word-splitting"
var tokens_from_value := _split_variable_value(value)
for t in tokens_from_value:
list.append(t)
elif token.is_string():
if token.metadata.quote == "'":
list.append(token)
else:
list.append(_interpret_string(token))
elif token.is_plain() and token.value == "$$":
list.append(BashToken.new(Tokens.PLAIN, str(pid)))
else:
list.append(token)
return list
# This method interprets the value of a variable in order to make several PLAIN tokens out of it.
# Indeed, if the value holds multiple words, then each of them are different tokens.
# See the comments in `interpret_variables()` above.
# The tokens are returned in an array.
# We consider that no errors can happen during this process.
func _split_variable_value(value: String) -> Array:
var r = RegEx.new()
r.compile("\\S+") # any non-whitespace character (so none of these: " ", "\n", "\t")
var words: Array = []
for m in r.search_all(value):
words.append(m.get_string())
var tokens: Array = []
for word in words:
tokens.append(BashToken.new(Tokens.PLAIN, word))
return tokens
# Replaces the variables with their value.
# Call this method only if the string was created using double quotes.
func _interpret_string(token: BashToken) -> BashToken:
var identifier := ""
var identifier_pos := 0
var i := 0
var new_token := BashToken.new(Tokens.STRING, "", { "quote": '"' })
var value_to_add := ""
while i < token.value.length():
if token.value[i] == "$":
identifier_pos = i
i += 1
if i >= token.value.length():
new_token.value += "$"
break
if token.value[i] == "$":
identifier = "$$"
i += 1
elif token.value[i] == " ":
new_token.value += "$"
continue
else:
while i < token.value.length() and token.value[i] != " ":
if not (identifier + token.value[i]).is_valid_identifier():
break
identifier += token.value[i]
i += 1
if identifier == "$$":
value_to_add = str(pid)
else:
value_to_add = runtime[0].get_variable_value(identifier)
new_token.value += value_to_add
identifier = ""
else:
new_token.value += token.value[i]
i += 1
return new_token
# Executes a script.
# We assume that the given file is executable.
# Also, for now, the options are not interpreted as variables $1 etc.
# Here, because of the for loops, some nodes might be on multipe lines.
# We can't just get every line of the file and execute them one by one.
# We parse the whole file at once and go through each node.
# After the parsing, we execute everything and exit as soon as there is an error.
func execute_file(file: SystemElement, options: Array, redirections: Array, interface: RichTextLabel = null) -> Dictionary:
var result = execute(file.content, interface)
var cleared := false
var outputs := [] # we store all the outputs of the commands here
# ./script
# == prints everything on the screen
# ./script 1>result.txt
# == sends all the successfull outputs in result.txt, but prints all the errors on the screen
# ./script 1>result.txt 2>errors.txt
# == sends all the successfull outputs in result.txt, and all the errors in error.txt
for o in result.outputs:
if o.error == null and o.interface_cleared:
cleared = true
outputs = []
else:
outputs.append(o)
if redirections[2] != null:
var all_errors := ""
var indexes_to_remove := [] # we'll remove all errors from the outputs array
for i in range(0, outputs.size()):
if outputs[i].error != null:
all_errors += outputs[i].error + "\n"
indexes_to_remove.append(i)
for i in range(indexes_to_remove.size() - 1, -1, -1):
outputs.remove(indexes_to_remove[i])
all_errors = all_errors.strip_edges()
if redirections[2].type == Tokens.WRITING_REDIRECTION:
redirections[2].target.content = all_errors
elif redirections[2].type == Tokens.APPEND_WRITING_REDIRECTION:
redirections[2].target.content += all_errors
if redirections[0] != null:
_write_to_redirection(redirections[0], "") # the weird behaviour described above, in `execute()`
if redirections[1] != null:
# If a standard output is used in the command,
# then it will receive the content of the combined outputs
# without the errors
var output := ""
var indexes_to_remove := []
for i in range(0, outputs.size()):
if outputs[i].error == null:
output += outputs[i].text
indexes_to_remove.append(i)
for i in range(indexes_to_remove.size() - 1, -1, -1):
outputs.remove(indexes_to_remove[i])
_write_to_redirection(redirections[1], output)
emit_signal("script_executed", file, outputs)
return {
"outputs": outputs