forked from NextDom/extra-tools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tools.py
executable file
·1845 lines (1650 loc) · 62.6 KB
/
tools.py
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
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
Script pour la génération et la modification de plugins pour Jeedom.
"""
import json
import os
import re
import sys
##########
# Config #
##########
config = {
"plugin_template_repo": "https://github.com/NextDom/plugin-ExtraTemplate"
".git",
"default_package_name": "Exemple",
"default_changelog_url": "https://nextdom.github.io/plugin-%s/#language"
"#/changelog",
"default_documentation_url":
"https://nextdom.github.io/plugin-%s/#language#/",
"jeedom_categories": [
"security",
"automation protocol",
"programming",
"organization",
"weather",
"communication",
"devicecommunication",
"multimedia",
"wellness",
"monitoring",
"health",
"nature",
"automatisation",
"energy"
]
}
#################
# Templates PHP #
#################
php_header = """<?php
/* This file is part of Jeedom.
*
* Jeedom is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Jeedom is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Jeedom. If not, see <http://www.gnu.org/licenses/>.
*/
"""
feature_ajax = """
try {
require_once dirname(__FILE__) . '/../../../../core/php/core.inc.php';
include_file('core', 'authentification', 'php');
if (!isConnect('admin')) {
throw new \\Exception(__('401 - Accès non autorisé', __FILE__));
}
ajax::init();
throw new \\Exception(__('Aucune méthode correspondante à : ', __FILE__) .
init('action'));
/* * *********Catch exeption*************** */
} catch (\\Exception $e) {
ajax::error(displayException($e), $e->getCode());
}
"""
feature_cmd_class = """
require_once dirname(__FILE__) . '/../../../../core/php/core.inc.php';
class PluginNameCmd extends cmd
{
public function execute($_options = array())
{
}
}
"""
feature_core_class = """
require_once dirname(__FILE__) . '/../../../../core/php/core.inc.php';
class PluginName extends eqLogic
{
}
"""
wizard_configuration = """
require_once dirname(__FILE__) . '/../../../core/php/core.inc.php';
include_file('core', 'authentification', 'php');
if (!isConnect()) {
include_file('desktop', '404', 'php');
die();
}
"""
wizard_core_class = """
/* * ***************************Includes********************************* */
require_once dirname(__FILE__) . '/../../../../core/php/core.inc.php';
require_once 'PluginNameCmd.class.php';
class PluginName extends eqLogic
{
/* * *************************Attributs****************************** */
/* * ***********************Methode static*************************** */
/*
* Fonction exécutée automatiquement toutes les minutes par Jeedom
public static function cron() {
}
*/
/*
* Fonction exécutée automatiquement toutes les heures par Jeedom
public static function cronHourly() {
}
*/
/*
* Fonction exécutée automatiquement tous les jours par Jeedom
public static function cronDaily() {
}
*/
/* * *********************Méthodes
d'instance************************* */
public function preInsert()
{
}
public function postInsert()
{
}
public function preSave()
{
}
public function postSave()
{
}
public function preUpdate()
{
}
public function postUpdate()
{
}
public function preRemove()
{
}
public function postRemove()
{
}
/*
* Non obligatoire mais permet de modifier l'affichage du widget si vous
en avez besoin
public function toHtml($_version = 'dashboard') {
}
*/
/*
* Non obligatoire mais ca permet de déclencher une action après
modification de variable de configuration
public static function postConfig_<Variable>() {
}
*/
/*
* Non obligatoire mais ca permet de déclencher une action avant
modification de variable de configuration
public static function preConfig_<Variable>() {
}
*/
/* * **********************Getteur Setteur*************************** */
}
"""
wizard_core_cmd_class = """
/* * ***************************Includes********************************* */
require_once dirname(__FILE__) . '/../../../../core/php/core.inc.php';
class PluginNameCmd extends cmd
{
/* * *************************Attributs****************************** */
/* * ***********************Methode static*************************** */
/* * *********************Methode d'instance************************* */
/*
* Non obligatoire permet de demander de ne pas supprimer les commandes
même si elles ne sont pas dans la nouvelle configuration de l'équipement
envoyé en JS
public function dontRemoveCmd() {
return true;
}
*/
public function execute($_options = array())
{
}
/* * **********************Getteur Setteur*************************** */
}
"""
wizard_desktop_php = """
if (!isConnect('admin')) {
throw new Exception('{{401 - Accès non autorisé}}');
}
"""
wizard_install = """
require_once dirname(__FILE__) . '/../../../core/php/core.inc.php';
function PluginName_install() {
}
function PluginName_update() {
}
function PluginName_remove() {
}
"""
#######################
# Classes utilitaires #
#######################
class File(object):
"""
Librairie pour la gestion des fichiers
"""
@staticmethod
def sed_replace(regexp, replacement, target_file):
"""Exécute la commande sed sur un fichier
:params regexp: Expression régulière
:params replacement: Chaîne de remplacement
:params target_file: Fichier cible
:type regexp: str
:type replacement: str
:type target_file: str
"""
sed_replace_pattern = "sed -i'' 's/{}/{}/g' {} 2> /dev/null"
if 'darwin' in sys.platform: # pragma: no cover
sed_replace_pattern = "sed -i '' 's/{}/{}/g' {} 2> /dev/null"
os.system(sed_replace_pattern.format(regexp, replacement, target_file))
@staticmethod
def replace_in_file(target_file, old_name, new_name):
"""Remplace l'ancien nom par le nouveau
:param target_file: Fichier à traiter
:param old_name: Ancien nom du plugin
:param new_name: Nouveau nom du plugin
:type target_file: str
:type old_name: str
:type new_name: str
"""
File.sed_replace(old_name, new_name, target_file)
File.sed_replace(old_name[0].lower() + old_name[1:], new_name[
0].lower() + new_name[1:], target_file)
File.sed_replace(old_name.lower(), new_name.lower(), target_file)
File.sed_replace(old_name.upper(), new_name.upper(), target_file)
File.sed_replace(old_name.capitalize(),
new_name.capitalize(),
target_file)
@staticmethod
def create_php_file(content, dest_file):
"""
Créé un fichier PHP et son en-tête puis ajoute le contenu.
:param content: Contenu PHP
:param dest_file: Fichier destination
"""
with open(dest_file, 'w') as dest:
dest.write(php_header)
dest.write(content)
@staticmethod
def create_php_file_and_replace(content, dest_file, old_name, new_name):
"""
Créé un fichier PHP et son en-tête, ajoute le contenu, puis remplace
les valeurs nécessaires.
:param content: Contenu PHP
:param dest_file: Fichier destination
:param old_name: Ancien nom du plugin
:param new_name: Nouveau nom du plugin
"""
File.create_php_file(content, dest_file)
File.replace_in_file(dest_file, old_name, new_name)
@staticmethod
def is_content_in_file(file_path, content):
"""Test si un fichier contient une chaine de caractères
:param file_path: Chemin du fichier
:param content: Contenu à tester
:type file_path: str
:type content: str
:return: True si le contenu a été trouvé
:rtype: bool
"""
result = False
try:
with open(file_path, 'r') as file_content:
if content in file_content.read():
result = True
except FileNotFoundError:
pass
return result
@staticmethod
def add_line_under(path_file, needle, line_to_add):
"""
Ajoute une ligne après que le champ needle est été trouvé
:param path_file: Chemin du fichier à traiter
:param needle: Elément à rechercher
:param line_to_add: Contenu de la ligne à ajouter
:return:
"""
result = False
lines = []
with open(path_file, 'r') as core_file_content:
lines = core_file_content.readlines()
output = []
for line in lines:
output.append(line)
if needle in line and not result:
output.append(line_to_add + '\n')
result = True
with open(path_file, 'w') as core_file_content:
for line in output:
core_file_content.write(line)
return result
@staticmethod
def write_json_file(file_path, json_data):
"""
Ecrit le fichier au format JSON
:param file_path: Chemin du fichier
:param json_data: Données à écrire
:type file_path: str
:type json_data: dict
:return: True si l'écriture à réussie
:rtype: bool
"""
result = False
with open(file_path, 'w') as dest:
if sys.version_info[0] < 3: # pragma: no cover
dump = json.dumps(json_data, sort_keys=True, indent=4,
ensure_ascii=False)
dump = dump.encode('utf-8').decode('string-escape')
else:
dump = json.dumps(json_data, sort_keys=True, indent=4)
dump = dump.encode('utf-8').decode('unicode-escape')
dest.write(dump + '\n')
result = True
return result
class IO(object):
"""
Librairie pour la gestion des entrées sorties
"""
# Message afficher pour sortir du menu
cancel_menu = 'Sortir'
# Message affiché lors d'un choix
choice_prompt = 'Choix : '
# Message affiché lors d'un mauvais choix
bad_choice = 'Mauvais choix'
############################
# Couleur pour l'affichage #
############################
red_color = '\033[31m'
yellow_color = '\033[93m'
green_color = '\033[92m'
end_color = '\033[0m'
@staticmethod
def print_error(msg):
"""Affiche un message d'erreur
:params msg: Message à afficher
:type msg: str
"""
print(IO.red_color + '/' + IO.yellow_color + '!' + IO.red_color + '\\' +
IO.end_color + ' ' + msg)
@staticmethod
def print_success(msg):
"""Affiche un message de confirmation
:params msg: Message à afficher
:type msg: str
"""
print(IO.green_color + 'v' + IO.end_color + ' ' + msg)
@staticmethod
def is_string(obj):
"""Test si une variable est une chaine de caractères
:params obj: Objet à tester
:return: True si l'object est une chaine de caractères
:rtype: bool
"""
str_type = str
if sys.version_info[0] < 3: # pragma: no cover
str_type = basestring # pylint: disable=undefined-variable
return isinstance(obj, str_type)
@staticmethod
def get_user_input(msg):
"""Obtenir une entrée d'un utilisateur
Compatible Python 2 et 3
:params msg: Message à afficher
:type msg: str
:return: Entrée de l'utilisateur
:rtype: str
"""
result = None
if sys.version_info[0] < 3: # pragma: no cover
result = raw_input(msg) # pylint: disable=undefined-variable
else:
result = input(msg)
return result
@staticmethod
def show_menu(menu, title=None, show_cancel=True):
"""Afficher un menu
:params menu: Tableau des choix à afficher
:params show_cancel: Affiche un message pour sortir du menu
:params title: Titre du menu
:type menu: array
:type show_cancel: bool
:type title: str
"""
print('')
if title is not None:
print('-=| ' + title + ' |=-\n')
for index, menu_item in enumerate(menu):
print(' ' + str(index + 1) + '. ' + menu_item)
if show_cancel:
print(' 0. ' + IO.cancel_menu)
@staticmethod
def get_menu_choice(menu, title=None, show_cancel=True):
"""Demande à l'utilisateur de faire un choix dans un menu
:params menu: Tableau des choix à afficher
:params show_cancel: Affiche le 0 pour sortir
:params title: Titre du menu
:type menu: List[str]
:type show_cancel: bool
:type title: str
:return: Choix de l'utilisateur ou -1
:rtype: int
"""
loop = True
user_choice = 9999
menu_choice_length = len(menu)
while loop:
IO.show_menu(menu, title, show_cancel)
try:
raw_user_choice = IO.get_user_input(IO.choice_prompt)
user_choice = int(raw_user_choice)
except NameError:
user_choice = 9999
except ValueError:
user_choice = 9999
# Sortir si l'utilisateur appuie sur Enter
if show_cancel:
if IO.is_string(raw_user_choice) and \
raw_user_choice == "":
user_choice = 0
if user_choice < menu_choice_length + 1:
# Choix de l'utilisateur -1 pour retrouver l'index du tableau
# et -1 si l'utilisateur a choisi 0 (Sortir)
user_choice -= 1
loop = False
# Si l'utilisateur doit répondre, la boucle continue
if user_choice == -1 and not show_cancel:
loop = True
else:
IO.print_error(IO.bad_choice)
return user_choice
@staticmethod
def ask_y_n(question, default='o'):
"""Afficher une question dont la réponse est oui ou non
:param question: Question à afficher
:param default: Réponse par défaut. o par défaut
:type question: str
:type default: str
:return: Réponse de l'utilisateur
:rtype: str
"""
choices = 'O/n'
if default != 'o':
choices = 'o/N'
choice = IO.get_user_input(
'%s [%s] : ' % (question, choices)).lower()
if choice == default or choice == '':
return default
return choice
@staticmethod
def ask_with_default(question, default):
"""Affiche une question avec une réponse par défaut
:param question: Question à afficher
:param default: Réponse par défaut
:type question: str
:type default: str
:return: Réponse de l'utilisateur
:rtype: str
"""
answer = IO.get_user_input('%s [%s] : ' % (question, default))
if answer == '':
answer = default
return answer
class Jeedom(object):
"""
Librairie pour la gestion des informations spécifiques à Jeedom
"""
@staticmethod
def ask_for_i18n_folder_creation(i18n_path):
"""
Demande pour ajouter le répertoire de traduction
:param i18n_path: Chemin du plugin
:type i18n_path: str
"""
if not os.path.exists(i18n_path):
answer = IO.ask_y_n('Voulez-vous créer le répertoire core/i18n ?')
if answer == 'o':
os.mkdir(i18n_path)
@staticmethod
def add_language(plugin_path):
"""
Ajout un language
:param plugin_path: Chemin du plugin
:type plugin_path: str
:return: True si la traduction a été rajoutée
:rtype: bool
"""
i18n_path = Jeedom.get_i18n_path(plugin_path)
i18n_list = filter(lambda item: not item.startswith('.'),
os.listdir(i18n_path))
if i18n_list:
print('Liste des traductions présentes : ')
for i18n in i18n_list:
print(' - ' + i18n)
loop = True
language = ''
while loop:
language = IO.get_user_input('Nom de la traduction : ')
if language == '':
loop = False
elif Jeedom.is_valid_i18n_name(language):
if language + '.json' in os.listdir(i18n_path):
IO.print_error(language + ' existe déjà.')
else:
loop = False
else:
IO.print_error('La langue doit être au format fr_FR.')
if language != '':
scan_data = Jeedom.scan_for_strings(plugin_path)
json_data = Jeedom.merge_i18n_json(plugin_path, {}, scan_data)
File.write_json_file(i18n_path + os.sep + language + '.json',
json_data)
IO.print_success('La langue ' + language + ' a été ajoutée')
@staticmethod
def get_i18n_path(plugin_path):
"""
Renvoie le chemin du répertoire contenant les traductions du plugin
:return: Chemin vers le répertoire des traductions
:rtype: str
"""
return os.path.join(plugin_path, 'core', 'i18n')
@staticmethod
def merge_i18n_json(plugin_path, base_json, scan_data):
"""
Fusionne les anciennes données avec les nouvelles
:param plugin_path: Chemin du plugin
:param base_json: Données présentes
:param scan_data: Données scannées
:type plugin_path: str
:type base_json: dict
:type scan_data: List(dict)
:return: Données fusionnées
:rtype: dict
"""
for data in scan_data:
file_path = Jeedom.transform_path_to_i18n_path(plugin_path,
data['file_path'])
# Décode l'unicode si besoin
if not isinstance(file_path, str): # pragma: no cover
file_path = file_path.encode('ascii')
# Création du dictionnaire vide
if file_path not in base_json.keys():
base_json[file_path] = {}
# Ajoute les éléments
for item in data['items']:
if item not in base_json[file_path].keys():
base_json[file_path][item] = item
# Renomme la clé pour Jeedom
base_json[file_path] = base_json.pop(file_path)
return base_json
@staticmethod
def transform_path_to_i18n_path(plugin_path, file_path):
"""
Transforme le chemin pour qu'il soit compatible avec Jeedom
:param plugin_path: Chemin du plugin
:param file_path: Chemin du fichier
:type plugin_path: str
:type file_path: str
:return: Chemin converti
:rtype: str
"""
file_path_striped = file_path.replace(plugin_path, '')
normal_path = 'plugins' + os.sep + os.path.basename(plugin_path) + \
os.sep + file_path_striped
# En fonction du path fournit, il peut y avoir des doublons
normal_path = normal_path.replace('//', '/')
return normal_path # .replace('/', '\/')
@staticmethod
def scan_for_strings(path, result=None):
"""
Parcourt un répertoire à la recherche de chaines à traduire
:param path: Chemin du répertoire à parcourir
:param result: Résultat compléter par recursion
:type path: str
:type result: list
:return: Liste des chaines à traduire
:rtype: list
"""
if result is None:
result = []
for item in os.listdir(path):
item_path = path + os.sep + item
if os.path.isdir(item_path):
Jeedom.scan_for_strings(item_path, result)
else:
if item.endswith('php'):
content = Jeedom.scan_file_for_strings(item_path)
if content:
result.append({
'file_path': item_path,
'items': list(set(content))
})
return result
@staticmethod
def scan_file_for_strings(file_path):
"""
Parcourt les fichiers à la recherche de chaînes à traduire
:param file_path: Fichier à parcourir
:type file_path: str
:return: Liste des chaines à traduire
:rtype: list
"""
result = []
with open(file_path, 'r') as file_content:
readed_content = file_content.read()
# noinspection RegExpRedundantEscape
result.extend(re.findall('\\{\\{(.*?)\\}\\}', readed_content))
result.extend(re.findall('__\\(\'(.*?)\'', readed_content))
result.extend(re.findall('__\\("(.*?)"', readed_content))
return result
@staticmethod
def is_valid_i18n_name(name):
"""
Test si la langue est au bon format
:param name: Nom à tester
:type name: str
:return: True si le format est correct
:rtype: bool
"""
result = False
re_search = re.search('^[a-z]{2}_[A-Z]{2}$', name)
if re_search is not None:
result = True
return result
class MethodData:
"""
Classe contenant les informations d'une méthode
"""
class_file_path = ''
class_name = ''
method_name = ''
method_visibility = 'public'
method_is_static = False
method_comment = ''
method_params = ''
def get_method_declaration(self):
"""Obtenir la déclaration de la classe dans le fichier
"""
return 'class ' + self.class_name + ' '
def get_method_func(self):
"""Obtenir la déclaration de la méthode données
"""
output = '\n'
if self.method_comment != '':
output += ' /**\n * ' + self.method_comment + '\n */\n'
output += ' ' + self.method_visibility + ' '
if self.method_is_static:
output += 'static '
output += 'function ' + self.method_name + '('
if self.method_params != '':
output += self.method_params
output += ')\n {\n\n }\n'
return output
class PHPFile(object):
"""
Librairie pour la gestion des fichiers PHP
"""
@staticmethod
def add_method(method_data):
"""Ajoute la méthode à la classe
:params method_data: Données de la méthode
:type method_data: MethodData
"""
result = False
if os.path.exists(method_data.class_file_path):
if PHPFile.check_class(method_data.class_file_path,
method_data.class_name):
if not PHPFile.check_if_method_exists(
method_data.class_file_path,
method_data.method_name):
result = PHPFile.write_method_in_class(method_data)
else:
IO.print_error('La méthode existe déjà')
else:
IO.print_error('La classe n\'existe pas')
else:
IO.print_error('Le fichier global n\'existe pas')
return result
@staticmethod
def check_class(class_file_path, class_name):
"""Test si la classe existe
:params class_file_path: Répertoire de la classe
:params class_name: Nom de la classe
:type class_file_path: str
:type class_name: str
:return: True si la classe existe
:rtype: bool
"""
result = False
try:
with open(class_file_path) as file_content:
if class_name in file_content.read():
result = True
except FileNotFoundError:
pass
return result
@staticmethod
def check_if_method_exists(class_file_path, method_name):
"""Test si la classe existe
:params class_file_path: Répertoire de la classe
:params method_name: Nom de la méthode
:type class_file_path: str
:type method_name: str
:return: True si la méthode existe
:rtype: bool
"""
result = False
with open(class_file_path) as file_content:
if method_name + '()' in file_content.read():
result = True
return result
@staticmethod
def check_and_write_class(file_path, class_name, extends=None):
"""Lancer l'écriture d'une nouvelle classe
:params file_path: Chemin du fichier devant contenir la classe
:params class_name: Nom de la classe à créer
:params extends: Nom de la classe héritée
:type file_path: str
:type class_name: str
:type extends: str
"""
if PHPFile.write_class(file_path, class_name, extends):
IO.print_success('La classe ' + class_name + ' a été créée')
else:
IO.print_success('La classe ' + class_name +
' n\'a pas pu être créée')
@staticmethod
def write_class(file_path, class_name, extends=None):
"""Ajoute une classe à un fichier PHP
:params file_path: Chemin du fichier devant contenir la classe
:params class_name: Nom de la classe à créer
:params extends: Nom de la classe héritée
:type file_path: str
:type class_name: str
:type extends: str
"""
result = False
add_php_tag = False
if not os.path.exists(file_path):
add_php_tag = True
with open(file_path, 'a') as php_file:
if add_php_tag:
php_file.write('<?php\n')
class_declaration = '\n\nclass ' + class_name
if extends is not None:
class_declaration += ' extends ' + extends + '\n{\n\n}\n'
php_file.write(class_declaration)
result = True
return result
@staticmethod
def write_method_in_class(method_data):
"""Ecrit la méthode à la classe
:params method_data: Données de la méthode
:type method_data: MethodData
"""
output = []
bracket_count = 0
start_bracket_count = False
method_added = False
class_declaration = 'class ' + method_data.class_name
try:
content = None
with open(method_data.class_file_path,
'r') as class_file_content:
content = class_file_content.readlines()
# Recherche de la dernière accolade de la classe
for line in content:
if not start_bracket_count and (
class_declaration in line or
class_declaration == line):
start_bracket_count = True
if not method_added and start_bracket_count:
if '{' in line:
bracket_count += 1
if '}' in line:
bracket_count -= 1
# Dernière accolade de la classe
if bracket_count == 0:
output.append(method_data.get_method_func())
method_added = True
output.append(line)
# Réécrit le fichier
with open(method_data.class_file_path,
'w') as class_file_content:
for line in output:
class_file_content.write(line)
except FileNotFoundError:
pass
return method_added
class Tools(object):
"""
Classe facilitant l'initialisation de l'outil
"""
@staticmethod
def show_help():
"""Affiche l'aide
"""
print(sys.argv[0] + ' [PLUGIN-NAME] [--help]')
print(' --help : Affiche de menu.')
print(' PLUGIN-NAME : Indiquer le nom du plugin à modifier.')
@staticmethod
def parse_args(argv):
"""Analyse les arguments
:params argv: Arguments
:type argv: list
:return: Liste ou None si le programme doit quitter
"""
result = ''
if '--help' in argv or len(argv) > 2:
Tools.show_help()
result = None
elif len(argv) > 1:
result = argv[1]
return result
@staticmethod
def is_plugin_dir(path):
"""Test si le répertoire contient un plugin
:param path: Chemin à tester
:return: True si c'est un plugin
"""
info_path = os.path.join(path, 'plugin_info', 'info.json')
return os.path.exists(info_path)
@staticmethod
def get_plugin_data(path):
"""Lire les informations du plugin
:param path: Chemin du plugin
:return: Informations du plugin
:rtype: dict
"""
result = None
info_path = os.path.join(path, 'plugin_info', 'info.json')
try:
with open(info_path) as info_json:
info_json_data = json.load(info_json)
if 'id' in info_json_data.keys():
result = [path, info_json_data['id']]
except (json.decoder.JSONDecodeError, FileNotFoundError):
pass
return result
@staticmethod
def get_plugins_in_dir(path):
"""Obtenir la liste des plugins dans un répertoire
:param path: Répertoire parent
:return: Liste des plugins
:rtype: list
"""
result = []
abspath = os.path.abspath(path)
for item in os.listdir(abspath):
item_path = abspath + os.sep + item
if os.path.isdir(item_path):
if Tools.is_plugin_dir(item_path):
plugin = Tools.get_plugin_data(item_path)
if plugin is not None:
result.append(plugin)
return result
#####################
# Classes des menus #
#####################
class BaseMenu(object):
"""Classe mère des menus
Fournit les méthodes nécessaire à l'affichage des menus et des actions
courantes.
"""
title = None
menu = []
bad_command = 'Mauvaise commande'