Repository navigation
Expand file tree
/
Copy pathwidgets.py
More file actions
1869 lines (1641 loc) · 82.9 KB
/
Copy pathwidgets.py
File metadata and controls
1869 lines (1641 loc) · 82.9 KB
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/python3
# -*- coding: UTF-8 -*-
"""Widgets GTK personnalisés pour l'interface GCM."""
import os
import shutil
import subprocess
from typing import TYPE_CHECKING
import gi
gi.require_version("Gtk", "3.0")
from gi.repository import Gdk, Gio, GLib, GObject, Gtk, Vte
from folder_context_menu_core import build_folder_context_menu_layout, should_show_protocol_items
from gesture_trigger_core import classify_tab_label_click
from inline_editor_core import classify_editor_button_press, classify_editor_key_press
from popup_menu_core import (
POPUP_MENU_ACTIONS,
POPUP_MENU_SECTIONS,
compute_enabled_actions,
format_command_label,
)
from tab_context_menu_core import build_tab_context_menu_layout
from utils import conf, run_dialog_sync
if TYPE_CHECKING:
# `_` est injecté dans les builtins à l'exécution par bindtextdomain().
# Cette déclaration sert uniquement au type-checker (Pylance) : elle évite
# les faux positifs "_ is not defined" sans affecter le runtime.
def _(message: str) -> str: ...
from loguru import logger as _loguru_logger
try:
USERHOME_DIR = os.getenv("HOME")
except:
USERHOME_DIR = ""
if USERHOME_DIR is None or USERHOME_DIR == "":
try:
USERHOME_DIR = os.path.expanduser("~")
except:
USERHOME_DIR = ""
assert (USERHOME_DIR is not None) and (USERHOME_DIR != ""), (
"FATAL: Could not determine home directory for the current user"
)
assert os.path.isdir(USERHOME_DIR), (
"FATAL: Could not locate home directory '%s' for the current user" % (USERHOME_DIR)
)
CONFIG_DIR = USERHOME_DIR + "/.gcm"
CONFIG_FILE = CONFIG_DIR + "/gcm.conf"
KEY_FILE = CONFIG_DIR + "/.gcm.key"
if not os.path.exists(CONFIG_DIR):
os.makedirs(CONFIG_DIR)
app_name = "Gnome Connection Manager"
# Initialiser les valeurs de conf dépendantes du contexte d'exécution
conf.LOG_PATH = CONFIG_DIR + "/logs"
conf.CONTINUOUS_LOG_PATH = CONFIG_DIR + "/log"
conf.APP_TITLE = app_name
def _setup_app_logger():
"""Initialise le logger applicatif (Loguru).
Issue #130/#170 : configuration unique (``logging_config``), plus de
repli sur le module ``logging`` standard (loguru est une dépendance
obligatoire). Idempotent : si le point d'entrée a déjà configuré les
journaux, rien ne change ; sinon niveau INFO par défaut. Le point
d'entrée reconfigure ensuite avec le vrai dossier (--config) et --debug
(force=True) : pas de fichier ici, ~/.gcm n'est peut-être pas le dossier
demandé.
Returns:
loguru.Logger: Le logger configuré.
"""
_loguru_logger.debug("_setup_app_logger() called")
import logging_config
logging_config.configure_logging()
_loguru_logger.debug(
"_setup_app_logger() returning | niveau={}", logging_config.current_level()
)
return _loguru_logger
app_logger = _setup_app_logger()
SHELL = os.environ.get("SHELL") or "/bin/sh" # absent sous cron, systemd, CI
# check Terminal version
TERMINAL_V048 = "spawn_async" in Vte.Terminal.__dict__
# Vérification runtime du signal 'output-written' (VTE >= 0.60)
# GObject.signal_lookup retourne 0 si le signal n'existe pas.
# Détection du binaire serial disponible (picocom > minicom > screen)
RDP_BIN = shutil.which("xfreerdp") or shutil.which("xfreerdp3") or "xfreerdp"
# Combinaisons de touches usuellement interceptées par le gestionnaire de
# fenêtres local avant d'atteindre un widget d'affichage distant embarqué
# (RDP/VNC/SPICE). Noms de touches Gdk (cf. gdk_keyval_from_name).
_SPECIAL_KEY_COMBOS = [
("Ctrl+Alt+Suppr", ("Control_L", "Alt_L", "Delete")),
("Ctrl+Échap", ("Control_L", "Escape")),
("Alt+Tab", ("Alt_L", "Tab")),
("Alt+F4", ("Alt_L", "F4")),
("Impr. écran", ("Print",)),
]
def build_remote_desktop_context_menu(
btn_connect, btn_disconnect, send_special_keys_fn, extra_items=None
):
"""Construit le menu contextuel Connect/Disconnect/Touches speciales d'un onglet bureau distant.
Reutilise pour le clic droit sur l'onglet/titre des onglets RDP/VNC/SPICE,
a la place des boutons auparavant affiches dans la barre d'outils de
l'onglet, pour s'harmoniser avec le menu contextuel des autres onglets.
Args:
btn_connect (Gtk.Button): bouton "Connect" existant (conserve pour
son etat de sensibilite et son gestionnaire "clicked", mais non
empaquete dans la barre d'outils).
btn_disconnect (Gtk.Button): bouton "Disconnect" existant (idem).
send_special_keys_fn (callable): fonction(list[str]) d'envoi d'une
combinaison de touches a la session distante.
extra_items (list[tuple[str, callable]], optional): entrees
supplementaires (libelle, callback(widget)) inserees apres
Connect/Disconnect (ex: peripheriques USB pour SPICE).
Returns:
Gtk.Menu: menu pret a afficher via popup().
"""
menu = Gtk.Menu()
item_connect = Gtk.MenuItem(label=_("Connect"))
item_connect.set_sensitive(btn_connect.get_sensitive())
item_connect.connect("activate", lambda _w: btn_connect.clicked())
menu.append(item_connect)
item_disconnect = Gtk.MenuItem(label=_("Disconnect"))
item_disconnect.set_sensitive(btn_disconnect.get_sensitive())
item_disconnect.connect("activate", lambda _w: btn_disconnect.clicked())
menu.append(item_disconnect)
for label, callback in extra_items or []:
item = Gtk.MenuItem(label=label)
item.connect("activate", callback)
menu.append(item)
menu.append(Gtk.SeparatorMenuItem())
keys_item = Gtk.MenuItem(label=_("Special keys"))
keys_submenu = Gtk.Menu()
for key_label, keys in _SPECIAL_KEY_COMBOS:
key_item = Gtk.MenuItem(label=key_label)
key_item.connect("activate", lambda _w, k=keys: send_special_keys_fn(list(k)))
keys_submenu.append(key_item)
keys_item.set_submenu(keys_submenu)
menu.append(keys_item)
menu.show_all()
return menu
def mount_iso_temp(iso_path):
"""Monte un fichier ISO localement (lecture seule) via udisksctl.
Utilise udisksctl loop-setup + mount (mécanisme udisks2/polkit standard
sur un bureau Linux, sans nécessiter root ni sudo). Le point de montage
résultant peut ensuite être partagé comme un dossier classique (RDPDR
pour RDP, webdav pour SPICE).
Args:
iso_path (str): Chemin absolu du fichier .iso à monter.
Returns:
tuple[str, str] | None: (mountpoint, loop_device) si succès, sinon None.
"""
if not shutil.which("udisksctl"):
app_logger.warning(
f"mount_iso_temp | udisksctl introuvable, impossible de monter {iso_path}"
)
return None
try:
out = subprocess.run(
["udisksctl", "loop-setup", "-r", "-f", iso_path, "--no-user-interaction"],
capture_output=True,
text=True,
check=True,
).stdout.strip()
# Sortie typique : "Mapped file /path/to.iso as /dev/loop0."
loop_device = out.split(" as ")[-1].rstrip(".").strip()
out = subprocess.run(
["udisksctl", "mount", "-b", loop_device, "--no-user-interaction"],
capture_output=True,
text=True,
check=True,
).stdout.strip()
# Sortie typique : "Mounted /dev/loop0 at /run/media/user/LABEL."
mountpoint = out.split(" at ")[-1].rstrip(".").strip()
app_logger.debug(f"mount_iso_temp | {iso_path} monte sur {mountpoint} ({loop_device})")
return mountpoint, loop_device
except (subprocess.CalledProcessError, IndexError) as exc:
app_logger.error(f"mount_iso_temp | echec montage {iso_path} : {exc}")
return None
def umount_iso_temp(loop_device):
"""Démonte et libère un périphérique loop monté par mount_iso_temp().
Args:
loop_device (str): Chemin du périphérique loop (ex: /dev/loop0).
"""
if not loop_device:
return
try:
subprocess.run(
["udisksctl", "unmount", "-b", loop_device, "--no-user-interaction"],
capture_output=True,
text=True,
)
subprocess.run(
["udisksctl", "loop-delete", "-b", loop_device, "--no-user-interaction"],
capture_output=True,
text=True,
)
app_logger.debug(f"umount_iso_temp | {loop_device} demonte et libere")
except Exception as exc:
app_logger.warning(f"umount_iso_temp | erreur lors du demontage de {loop_device} : {exc}")
def vte_run(terminal, command, arg=None, extra_env=None):
"""Lance une commande dans un terminal VTE.
Construit l'environnement complet (PATH, TERM, SSH_AUTH_SOCK, DISPLAY, etc.)
et lance la commande via spawn_async (VTE >= 0.48) ou spawn_sync.
Args:
terminal (Vte.Terminal): Terminal VTE dans lequel lancer la commande.
command (str): Chemin de l'executable a lancer.
arg (list, optional): Arguments supplementaires. Defaults to None.
extra_env (dict, optional): Variables d'environnement additionnelles
(ex: mot de passe transmis via env plutot que ligne de commande,
pour ne pas apparaitre dans `ps aux`). Defaults to None.
"""
term_type = getattr(getattr(terminal, "host", None), "term", None) or "xterm"
# fix #89: transmettre SSH_AUTH_SOCK et vars essentielles au processus VTE
envv = ["PATH=%s" % os.getenv("PATH"), "TERM=%s" % term_type]
for _ekey in (
"SSH_AUTH_SOCK",
"SSH_AGENT_PID",
"DISPLAY",
"WAYLAND_DISPLAY",
"HOME",
"USER",
"LOGNAME",
"LANG",
"LC_ALL",
"XDG_RUNTIME_DIR",
"DBUS_SESSION_BUS_ADDRESS",
"GNOME_KEYRING_CONTROL",
):
_eval = os.getenv(_ekey)
if _eval:
envv.append("%s=%s" % (_ekey, _eval))
if extra_env:
for _k, _v in extra_env.items():
envv.append("%s=%s" % (_k, _v))
args = []
args.append(command)
if arg:
args += arg
flag_spawn = (
GLib.SpawnFlags.DEFAULT if command == SHELL else GLib.SpawnFlags.FILE_AND_ARGV_ZERO
)
if TERMINAL_V048:
terminal.spawn_async(
Vte.PtyFlags.DEFAULT,
os.getenv("HOME"),
args,
envv,
flag_spawn | GLib.SpawnFlags.SEARCH_PATH,
None,
None,
-1,
None,
lambda term, pid, err, user_data: None,
None,
)
else:
terminal.spawn_sync(
Vte.PtyFlags.DEFAULT,
os.getenv("HOME"),
args,
envv,
flag_spawn | GLib.SpawnFlags.DO_NOT_REAP_CHILD | GLib.SpawnFlags.SEARCH_PATH,
None,
None,
None,
)
class ManagementTabLabel(Gtk.Box):
"""Etiquette d'onglet pour les ecrans de gestion epingles (Parametres,
editeur d'hote, editeur ssh/config, import...).
Contrairement a ``NotebookTabLabel`` (onglets de session : menu
contextuel splits/log/reconnexion, etc.), cette etiquette se limite a un
titre et un bouton de fermeture : ces ecrans n'ont pas de notion de
session, de split ou de reconnexion.
"""
def __init__(self, title, on_close):
"""Initialise l'etiquette.
Args:
title (str): Texte affiche dans l'onglet.
on_close (callable): Appele (sans argument) quand l'utilisateur
clique sur le bouton de fermeture.
"""
Gtk.Box.__init__(
self, orientation=Gtk.Orientation.HORIZONTAL, homogeneous=False, spacing=4
)
self.label = Gtk.Label(label=title)
self.pack_start(self.label, True, True, 0)
self.label.show()
close_image = Gtk.Image.new_from_icon_name("window-close", Gtk.IconSize.MENU)
_, image_w, image_h = Gtk.icon_size_lookup(Gtk.IconSize.MENU)
close_btn = Gtk.Button()
close_btn.set_relief(Gtk.ReliefStyle.NONE)
close_btn.set_size_request(image_w + 7, image_h + 6)
close_btn.add(close_image)
close_btn.connect("clicked", lambda *_args: on_close())
self.pack_start(close_btn, False, False, 0)
close_btn.show_all()
self.show()
def get_text(self):
"""Retourne le texte de l'etiquette de l'onglet.
Returns:
str: Texte de l'onglet.
"""
return self.label.get_text()
class _LogActionShim:
"""Adapte une ``Gio.SimpleAction`` a etat booleen a l'interface ``Gtk.CheckMenuItem``.
Permet a ``Wmain.on_popupmenu`` (``gnome_connection_manager.py``, item
``"L"``) de continuer a lire/ecrire l'etat de la case a cocher "Enable
logging" via ``get_active()``/``set_active()`` sans etre modifie, alors
que le widget reel est desormais une ``Gio.SimpleAction`` portee par
:class:`TabContextMenu` plutot qu'un ``Gtk.CheckMenuItem`` (portage
GTK4-ready session-31, voir ``docs/gtk4-migration.md`` section 3.6-ter).
"""
def __init__(self, action):
"""Initialise l'instance.
Args:
action (Gio.SimpleAction): Action a etat booleen ("log") portee
par le ``Gio.SimpleActionGroup`` de :class:`TabContextMenu`.
"""
self._action = action
def get_active(self):
"""Retourne l'etat courant de la case a cocher simulee.
Returns:
bool: True si la case est cochee (action a l'etat ``True``).
"""
return self._action.get_state().get_boolean()
def set_active(self, value):
"""Definit l'etat de la case a cocher simulee.
Args:
value (bool): Nouvel etat a appliquer a l'action.
"""
self._action.set_state(GLib.Variant.new_boolean(bool(value)))
class TabContextMenu:
"""Menu contextuel d'un onglet ("clic droit sur un onglet"), sur ``Gio.Menu``.
Remplace l'ancien attribut ``popupMenuTab`` (un ``Gtk.Menu`` classique
avant la session-31, voir ``gnome_connection_manager.py::createMenu``)
par un trio ``Gio.Menu``/``Gio.SimpleActionGroup``/``Gtk.Popover``, sur le meme
principe deja adopte pour le menu principal
(``Wmain._build_primary_menu``) : ``Gio.Menu``/``Gio.SimpleAction``
existent depuis GTK 3.4 et ``Gtk.Popover.new_from_model()`` depuis
GTK 3.12, donc ce portage fonctionne des maintenant sous GTK3 et sera
repris tel quel lors du passage effectif a GTK4 (voir
``docs/gtk4-migration.md`` section 3.6-ter, choisi comme premier des
quatre menus contextuels a porter car le plus simple : pas d'injection
dynamique par plugin, seulement de la visibilite conditionnelle).
Portee initialement limitee a cette session (session-31) : seul le
*contenu* du menu changeait de mecanisme. Le *declenchement*
(``Gtk.EventBox`` + signal ``button-press-event`` sur
``Gdk.EventButton``, dans ``NotebookTabLabel.popupmenu``) restait
inchange — sa migration vers ``Gtk.GestureClick`` (point 3 de l'audit
session-29) etait alors un chantier distinct, commun aux quatre menus
contextuels. **Porte depuis la session-41**
(``NotebookTabLabel.on_label_pressed``, voir
``docs/gtk4-migration.md`` §3.6-decies) : :meth:`popup_at` prend
desormais ``x``/``y`` directement (fournis par le signal ``pressed``
de ``Gtk.GestureMultiPress``) plutot qu'un ``Gdk.EventButton`` complet,
meme principe que :meth:`FolderContextMenu.popup_at`/
:meth:`PopupMenu.popup_at` (sessions 39/40).
Difference de comportement assumee et documentee (point 1 de l'audit
session-29) : la case "Enable logging" n'est plus un ``Gtk.CheckMenuItem``
mais une ``Gio.SimpleAction`` a etat booleen (``Gio.SimpleAction.
new_stateful``) — voir :class:`_LogActionShim` pour l'adaptation cote
gestionnaire existant.
"""
#: Prefixe des actions dans le Gio.SimpleActionGroup, cf. references
#: "tabmenu.<nom>" dans :meth:`rebuild`.
ACTION_GROUP_PREFIX = "tabmenu"
def __init__(self, dispatch):
"""Initialise l'instance.
Args:
dispatch (Callable[[object, str], None]): Gestionnaire
d'activation existant (``Wmain.on_popupmenu``), reutilise
tel quel pour ne pas dupliquer la logique metier des items
du menu (renommer l'onglet, reset console, etc.) —
l'activation d'une action appelle ``dispatch(widget, code)``
exactement comme le faisait ``menuItem.connect("activate",
self.on_popupmenu, code)`` avant ce portage.
"""
app_logger.debug("TabContextMenu.__init__() called")
self._dispatch = dispatch
# Gtk.Label de l'onglet cible par le prochain popup_at() — fixe par
# l'appelant (NotebookTabLabel.on_label_pressed) avant chaque
# affichage, exactement comme l'ancien `self.popup.label = self.label`.
self.label = None
self.model = Gio.Menu()
self.actions = Gio.SimpleActionGroup()
self._log_action = Gio.SimpleAction.new_stateful(
"log", None, GLib.Variant.new_boolean(False)
)
self._log_action.connect("change-state", self._on_log_change_state)
self.actions.add_action(self._log_action)
for name, item_code in (
("rename", "R"),
("reset", "RS"),
("clear", "RC"),
("reopen", "RO"),
("clone", "CC"),
("split-h", "SPH"),
("split-v", "SPV"),
("unsplit", "USP"),
):
self._add_simple_action(name, item_code)
self.popover = Gtk.Popover.new_from_model(None, self.model)
self.popover.set_position(Gtk.PositionType.BOTTOM)
self.popover.insert_action_group(self.ACTION_GROUP_PREFIX, self.actions)
app_logger.debug("TabContextMenu.__init__() returning")
def _add_simple_action(self, name, item_code):
"""Enregistre une action simple qui relaie l'activation vers ``dispatch``.
Args:
name (str): Nom de l'action dans le ``Gio.SimpleActionGroup``
(sans le prefixe ``tabmenu.``).
item_code (str): Code d'action historique attendu par
``Wmain.on_popupmenu`` (ex. ``"R"`` pour "Rename tab").
"""
app_logger.debug(
f"TabContextMenu._add_simple_action() called | name={name!r} item_code={item_code!r}"
)
action = Gio.SimpleAction.new(name, None)
action.connect("activate", lambda a, p, code=item_code: self._dispatch(None, code))
self.actions.add_action(action)
app_logger.debug("TabContextMenu._add_simple_action() returning")
def _on_log_change_state(self, action, value):
"""Applique le changement d'etat de la case "Enable logging" puis relaie.
Reproduit l'ordre de l'ancien ``Gtk.CheckMenuItem`` : GTK bascule
l'etat affiche avant d'emettre l'evenement d'activation, et le
gestionnaire metier (``Wmain.on_popupmenu``, item ``"L"``) peut
ensuite revenir dessus (ex. mode de log continu actif — voir
``gnome_connection_manager.py``) via ``set_active(False)`` sur le
shim, qui rappelle ``action.set_state()``.
Args:
action (Gio.SimpleAction): Action a etat booleen ("log").
value (GLib.Variant): Nouvel etat demande.
"""
app_logger.debug(
f"TabContextMenu._on_log_change_state() called | value={value.get_boolean()!r}"
)
action.set_state(value)
self._dispatch(_LogActionShim(action), "L")
app_logger.debug("TabContextMenu._on_log_change_state() returning")
def rebuild(self, *, is_active, multi_pane, log_active):
"""Reconstruit le modele ``Gio.Menu`` selon l'etat courant de l'onglet.
Reproduit a l'identique la visibilite conditionnelle de l'ancien
``Gtk.Menu`` (``mnuReopen``, ``mnuSplitH``/``mnuSplitV`` — voir
``docs/gtk4-migration.md`` section 3.6-ter, point 2) : ``Gio.Menu``
restant mutable a l'execution (il notifie ``items-changed``, que le
``Gtk.Popover`` cree par ``new_from_model()`` ecoute pour se
redessiner automatiquement), chaque ouverture reconstruit
entierement le modele plutot que de cacher/afficher des
``Gtk.MenuItem`` persistants — qui n'existent plus dans ce
mecanisme.
Args:
is_active (bool): Etat "actif" de l'onglet
(``NotebookTabLabel.is_active``). Quand ``False``, l'entree
"Reconnect to host" est proposee (ancien
``mnuReopen.show()``).
multi_pane (bool): ``True`` si le notebook contient plusieurs
onglets (``nb.get_n_pages() > 1`` calcule par l'appelant) —
conditionne les entrees "Split H"/"Split V" (ancien
``mnuSplitH``/``mnuSplitV`` show/hide).
log_active (bool): Etat courant du log du terminal cible, pour
initialiser la case a cocher "Enable logging" (ancien
``mnuLog.set_active()``).
"""
app_logger.debug(
f"TabContextMenu.rebuild() called | is_active={is_active!r} "
f"multi_pane={multi_pane!r} log_active={log_active!r}"
)
self._log_action.set_state(GLib.Variant.new_boolean(bool(log_active)))
self.model.remove_all()
prefix = self.ACTION_GROUP_PREFIX
labels = {
"rename": _("Rename tab"),
"reset": _("Reset console"),
"clear": _("Reset and Clear console"),
"reopen": _("Reconnect to host"),
"clone": _("Clone console"),
"log": _("Enable logging"),
"split-h": _("Split H"),
"split-v": _("Split V"),
"unsplit": _("Unsplit all consoles"),
}
# Disposition (quelles entrees, dans quelles sections) calculee par
# une fonction pure sans dependance Gtk/Gio — voir
# tab_context_menu_core.py, extrait pour rester testable.
for section_names in build_tab_context_menu_layout(
is_active=is_active, multi_pane=multi_pane
):
section = Gio.Menu()
for name in section_names:
section.append(labels[name], f"{prefix}.{name}")
self.model.append_section(None, section)
app_logger.debug("TabContextMenu.rebuild() returning")
def popup_at(self, relative_to, x, y):
"""Affiche le popover positionne sur le point de clic.
Remplace l'ancien appel a la signature ``Gtk.Menu.popup()`` a six
arguments positionnels (deja depreciee en GTK3 et purement et
simplement supprimee en GTK4 avec ``Gtk.Menu`` lui-meme — voir
``docs/gtk4-migration.md`` section 3.6-ter point 3) par
``Gtk.Popover.set_pointing_to()`` + ``popup()``, disponibles a
l'identique en GTK3 comme en GTK4.
Signature changee en session-41 : recoit desormais ``x``/``y``
directement (coordonnees relatives a ``relative_to``) plutot qu'un
``Gdk.EventButton`` complet — consequence du portage du
declencheur (``NotebookTabLabel.on_label_pressed``) vers
``Gtk.GestureMultiPress``, dont le signal ``pressed`` fournit deja
ces coordonnees a part, sans objet evenement associe (voir
``docs/gtk4-migration.md`` section 3.6-decies) — meme changement
que :meth:`FolderContextMenu.popup_at`/:meth:`PopupMenu.popup_at`
(sessions 39/40). Seul appelant de cette methode dans tout le
depot, donc changement de signature sans impact ailleurs.
Args:
relative_to (Gtk.Widget): Widget sur lequel positionner le
popover (le ``Gtk.EventBox`` de l'onglet clique,
``self.eb``).
x (float): Coordonnee X du clic, relative a ``relative_to``.
y (float): Coordonnee Y du clic, relative a ``relative_to``.
"""
app_logger.debug(
f"TabContextMenu.popup_at() called | relative_to={relative_to!r} x={x!r} y={y!r}"
)
self.popover.set_relative_to(relative_to)
rect = Gdk.Rectangle()
rect.x = int(x)
rect.y = int(y)
rect.width = 1
rect.height = 1
self.popover.set_pointing_to(rect)
self.popover.popup()
app_logger.debug("TabContextMenu.popup_at() returning")
class FolderContextMenu:
"""Menu contextuel du panneau de serveurs ("clic droit sur treeServers"), sur ``Gio.Menu``.
Remplace l'ancien attribut ``popupMenuFolder`` (un ``Gtk.Menu`` classique
avant la session-32, voir ``gnome_connection_manager.py::createMenu``)
par un trio ``Gio.Menu``/``Gio.SimpleActionGroup``/``Gtk.Popover``, meme
principe que :class:`TabContextMenu` (session-31) et que le menu
principal (``Wmain._build_primary_menu``) : ``Gio.Menu``/
``Gio.SimpleAction`` existent depuis GTK 3.4 et
``Gtk.Popover.new_from_model()`` depuis GTK 3.12, donc ce portage
fonctionne des maintenant sous GTK3 et sera repris tel quel lors du
passage effectif a GTK4 (voir ``docs/gtk4-migration.md`` section
3.6-quinquies — deuxieme des quatre menus contextuels de l'audit
session-29 a etre porte, choisi apres ``popupMenuTab`` car son mecanisme
d'injection dynamique par plugin se ramene au meme motif ``add_action()``
deja utilise par ``Wmain._build_primary_menu``).
Portée volontairement limitée lors de sa création en session-32, comme
pour :class:`TabContextMenu` : seul le *contenu* du menu changeait alors
de mécanisme, le *déclenchement* (``button-press-event`` sur
``Gdk.EventButton``, dans ``Wmain.on_tvServers_button_press_event``)
restant inchangé — sa migration vers ``Gtk.GestureClick`` (point 3 de
l'audit session-29) était un chantier distinct, commun aux quatre menus
contextuels.
**Mise à jour session-39** : ce déclenchement est désormais porté lui
aussi, vers ``Gtk.GestureMultiPress`` (``Wmain.on_tvServers_pressed``,
premier des trois sites identifiés par l'audit session-38 — voir
``docs/gtk4-migration.md`` section 3.6-octies). Conséquence directe sur
cette classe : :meth:`popup_at` reçoit désormais des coordonnées
``x``/``y`` directement (fournies telles quelles par le signal
``pressed``) plutôt qu'un ``Gdk.EventButton`` complet, ce signal n'en
transmettant plus.
Difference de mecanisme assumee et documentee (comme pour la case
"Enable logging" de :class:`TabContextMenu`) : les items specifiques a
un protocole (``plugin.build_folder_context_menu_items()``) ne sont plus
des ``Gtk.MenuItem`` ajoutes une fois pour toutes a la construction, mais
des actions reconstruites a chaque ouverture par :meth:`rebuild`, sur le
meme principe que le reste du menu (``Gio.Menu`` mutable, cf.
``TabContextMenu.rebuild``) — pas de liste ``protocol_extra_items`` a
tenir a jour separement.
"""
#: Prefixe des actions dans le Gio.SimpleActionGroup, cf. references
#: "foldermenu.<nom>" dans :meth:`rebuild`.
ACTION_GROUP_PREFIX = "foldermenu"
def __init__(self, callbacks, dispatch):
"""Initialise l'instance.
Args:
callbacks (dict[str, Callable[[], None]]): Gestionnaires
zero-argument pour les entrees statiques cablees directement
sur une methode existante de ``Wmain`` plutot que sur
``on_popupmenu`` (cles attendues : ``"connect"``, ``"add"``,
``"new-group"``, ``"rename-group"``, ``"group-color"``,
``"group-color-reset"``, ``"edit"``, ``"delete"``,
``"expand"``, ``"collapse"`` — memes methodes qu'avant ce
portage, ex. ``lambda: self.on_btnConnect_clicked(None)``,
deja le motif utilise par ``Wmain._build_primary_menu``).
dispatch (Callable[[object, str], None]): Gestionnaire
d'activation existant (``Wmain.on_popupmenu``), reutilise
pour les deux entrees qui passaient deja par lui avant ce
portage (``"H"`` = Copy Address, ``"D"`` = Duplicate Host —
voir ``folder_context_menu_core.FOLDER_CONTEXT_MENU_DISPATCH_ACTIONS``).
"""
app_logger.debug("FolderContextMenu.__init__() called")
self._callbacks = callbacks
self._dispatch = dispatch
# Callback fournissant les items specifiques au protocole a inserer
# dans le menu (label, callback zero-argument), evalue a chaque
# rebuild() plutot que fige a la construction — fixe par l'appelant
# (Wmain.createMenu) avant le premier popup, meme principe que
# ``self.label`` sur TabContextMenu.
self.protocol_items_provider = None
self.model = Gio.Menu()
self.actions = Gio.SimpleActionGroup()
for name, handler in callbacks.items():
self._add_simple_action(name, lambda a, p, h=handler: h())
for name, item_code in (("copy-address", "H"), ("duplicate", "D")):
self._add_simple_action(name, lambda a, p, code=item_code: self._dispatch(None, code))
self.popover = Gtk.Popover.new_from_model(None, self.model)
self.popover.set_position(Gtk.PositionType.BOTTOM)
self.popover.insert_action_group(self.ACTION_GROUP_PREFIX, self.actions)
app_logger.debug("FolderContextMenu.__init__() returning")
def _add_simple_action(self, name, activate_handler):
"""Enregistre une action simple sur le Gio.SimpleActionGroup.
Args:
name (str): Nom de l'action (sans le prefixe ``foldermenu.``).
activate_handler (Callable[[Gio.SimpleAction, GLib.Variant], None]):
Gestionnaire connecte au signal ``activate`` de l'action.
"""
app_logger.debug(f"FolderContextMenu._add_simple_action() called | name={name!r}")
action = Gio.SimpleAction.new(name, None)
action.connect("activate", activate_handler)
self.actions.add_action(action)
app_logger.debug("FolderContextMenu._add_simple_action() returning")
def rebuild(self, *, click_target):
"""Reconstruit le modele ``Gio.Menu`` selon la cible du clic droit.
Reproduit a l'identique la visibilite conditionnelle de l'ancien
``Gtk.Menu`` (``Wmain.on_tvServers_button_press_event``, voir
``docs/gtk4-migration.md`` section 3.6-quinquies) : ``Gio.Menu``
restant mutable a l'execution, chaque ouverture reconstruit
entierement le modele plutot que de cacher/afficher des
``Gtk.MenuItem`` persistants — meme principe que
``TabContextMenu.rebuild``.
Args:
click_target (str): Cible du clic droit sur ``treeServers`` —
``"empty"``, ``"folder"`` ou ``"host"``, voir
``folder_context_menu_core.CLICK_TARGETS``.
"""
app_logger.debug(f"FolderContextMenu.rebuild() called | click_target={click_target!r}")
prefix = self.ACTION_GROUP_PREFIX
labels = {
"connect": _("Connect"),
"copy-address": _("Copy Address"),
"add": _("Add Host"),
"new-group": _("New Group…"),
"rename-group": _("Rename Group…"),
"group-color": _("Choose Color…"),
"group-color-reset": _("Reset Color"),
"edit": _("Edit"),
"delete": _("Remove"),
"duplicate": _("Duplicate Host"),
"expand": _("Expand all"),
"collapse": _("Collapse all"),
}
self.model.remove_all()
# Disposition (quelles entrees, dans quelles sections) calculee par
# une fonction pure sans dependance Gtk/Gio — voir
# folder_context_menu_core.py, extrait pour rester testable.
for section_names in build_folder_context_menu_layout(click_target=click_target):
section = Gio.Menu()
for name in section_names:
section.append(labels[name], f"{prefix}.{name}")
self.model.append_section(None, section)
if (
should_show_protocol_items(click_target=click_target)
and self.protocol_items_provider is not None
):
protocol_section = Gio.Menu()
for index, (label, callback) in enumerate(self.protocol_items_provider()):
action_name = f"protocol-{index}"
action = Gio.SimpleAction.new(action_name, None)
action.connect("activate", lambda a, p, cb=callback: cb())
# Remplace toute action du meme nom laissee par un rebuild()
# precedent (nombre d'items variable selon les plugins) :
# Gio.SimpleActionGroup n'a pas d'equivalent a foreach/remove
# sur les Gtk.Menu, on ecrase simplement l'action existante.
self.actions.add_action(action)
protocol_section.append(label, f"{prefix}.{action_name}")
self.model.append_section(None, protocol_section)
app_logger.debug("FolderContextMenu.rebuild() returning")
def popup_at(self, relative_to, x, y):
"""Affiche le popover positionné sur le point de clic.
Remplace l'ancien appel à ``Gtk.Menu.popup()`` à six arguments
positionnels (déjà dépréciée en GTK3 et purement et simplement
supprimée en GTK4 avec ``Gtk.Menu`` lui-même) par
``Gtk.Popover.set_pointing_to()`` + ``popup()``, disponibles à
l'identique en GTK3 comme en GTK4 — même principe que
``TabContextMenu.popup_at``.
Signature changée en session-39 : reçoit désormais ``x``/``y``
directement (coordonnées relatives à ``relative_to``) plutôt qu'un
``Gdk.EventButton`` complet — conséquence du portage du déclencheur
(``Wmain.on_tvServers_pressed``) vers ``Gtk.GestureMultiPress``,
dont le signal ``pressed`` fournit déjà ces coordonnées à part, sans
objet évènement associé (voir ``docs/gtk4-migration.md`` section
3.6-octies). Seul appelant de cette méthode dans tout le dépôt,
donc changement de signature sans impact ailleurs.
Args:
relative_to (Gtk.Widget): Widget sur lequel positionner le
popover (``treeServers``).
x (float): Coordonnée X du clic, relative à ``relative_to``.
y (float): Coordonnée Y du clic, relative à ``relative_to``.
"""
app_logger.debug(
f"FolderContextMenu.popup_at() called | relative_to={relative_to!r} x={x!r} y={y!r}"
)
self.popover.set_relative_to(relative_to)
rect = Gdk.Rectangle()
rect.x = int(x)
rect.y = int(y)
rect.width = 1
rect.height = 1
self.popover.set_pointing_to(rect)
self.popover.popup()
app_logger.debug("FolderContextMenu.popup_at() returning")
class PopupMenu:
"""Menu contextuel du terminal ("clic droit dans un terminal"), sur ``Gio.Menu``.
Remplace l'ancien attribut ``popupMenu`` (un ``Gtk.Menu`` classique avant
la session-33, voir ``gnome_connection_manager.py::createMenu``) par un
trio ``Gio.Menu``/``Gio.SimpleActionGroup``/``Gtk.Popover``, meme
principe que :class:`TabContextMenu` (session-31) et
:class:`FolderContextMenu` (session-32) : ``Gio.Menu``/``Gio.SimpleAction``
existent depuis GTK 3.4 et ``Gtk.Popover.new_from_model()`` depuis
GTK 3.12, donc ce portage fonctionne des maintenant sous GTK3 et sera
repris tel quel lors du passage effectif a GTK4 (voir
``docs/gtk4-migration.md`` section 3.6-sexies — troisieme et dernier des
quatre menus contextuels applicatifs de l'audit session-29 a etre porte).
Portee initialement limitee a cette session (session-33), comme pour
les deux precedents : seul le *contenu* du menu changeait de mecanisme,
le *declenchement* (``button-press-event`` sur ``Gdk.EventButton``,
dans ``Wmain.on_terminal_click``) restant inchange — sa migration vers
``Gtk.GestureClick`` (point 3 de l'audit session-29) etait alors un
chantier distinct, commun aux quatre menus contextuels. **Porte depuis
la session-40** (``Wmain.on_terminal_pressed``, voir
``docs/gtk4-migration.md`` §3.6-nonies) : :meth:`popup_at` prend
desormais ``x``/``y`` directement (fournis par le signal ``pressed`` de
``Gtk.GestureMultiPress``) plutot qu'un ``Gdk.EventButton`` complet,
meme principe que :meth:`FolderContextMenu.popup_at`.
Deux differences de mecanisme assumees et documentees :
- La case "Enable logging" n'est plus un ``Gtk.CheckMenuItem`` mais une
``Gio.SimpleAction`` a etat booleen, comme pour :class:`TabContextMenu`
— voir :class:`_LogActionShim`, reutilise tel quel (dispatch sur le
code historique ``"L2"`` plutot que ``"L"``, pour rester distinguable
cote ``Wmain.on_popupmenu``).
- Contrairement a :class:`TabContextMenu`/:class:`FolderContextMenu`, la
disposition du menu (``popup_menu_core.POPUP_MENU_SECTIONS``) est
CONSTANTE : ce qui varie a l'ouverture est la sensibilite de quatre
actions (ancien ``.set_sensitive()``), pas la presence d'un item —
voir :meth:`rebuild`, qui n'a donc pas besoin de reconstruire
``self.model`` a chaque appel (``Gio.SimpleAction`` emet
``notify::enabled``, ecoute automatiquement par le ``Gtk.Popover``
construit via ``new_from_model()``).
Le sous-menu dynamique "Custom commands" (ancien
``self.popupMenu.mnuCommands``/``populateCommandsMenu()``) devient un
veritable sous-menu ``Gio.Menu`` imbrique (``append_submenu()``, deja le
mecanisme utilise par ``Wmain._build_primary_menu`` pour "Imports"/
"Exports"/etc.) plutot qu'un ``Gtk.Menu`` attache via ``set_submenu()``
— voir :meth:`populate_commands`. Le pont depuis le menu hamburger
(ancien ``add_popup_action("custom-commands", ...)`` de
``_build_primary_menu``, qui appelait ``.popup()`` directement sur le
``Gtk.Menu``) est remplace par :meth:`popup_commands_at`, un second
``Gtk.Popover`` construit sur le meme modele partage.
"""
#: Prefixe des actions dans le Gio.SimpleActionGroup, cf. references
#: "popupmenu.<nom>" dans :meth:`__init__`/:meth:`populate_commands`.
ACTION_GROUP_PREFIX = "popupmenu"
def __init__(self, dispatch):
"""Initialise l'instance.
Args:
dispatch (Callable[[object, str], None]): Gestionnaire
d'activation existant (``Wmain.on_popupmenu``), reutilise
tel quel pour ne pas dupliquer la logique metier des items
du menu (copier/coller, reset console, etc.) — l'activation
d'une action appelle ``dispatch(widget, code)`` exactement
comme le faisait ``menuItem.connect("activate",
self.on_popupmenu, code)`` avant ce portage.
"""
app_logger.debug("PopupMenu.__init__() called")
self._dispatch = dispatch
# Terminal VTE cible du prochain popup_at() — fixe par l'appelant
# (Wmain.on_terminal_click) avant chaque affichage, exactement comme
# l'ancien `self.popupMenu.terminal = widget`.
self.terminal = None
self.model = Gio.Menu()
self.actions = Gio.SimpleActionGroup()
self._log_action = Gio.SimpleAction.new_stateful(
"log", None, GLib.Variant.new_boolean(False)
)
self._log_action.connect("change-state", self._on_log_change_state)
self.actions.add_action(self._log_action)
for name, item_code in POPUP_MENU_ACTIONS:
self._add_simple_action(name, item_code)
prefix = self.ACTION_GROUP_PREFIX
labels = {
"copy": _("Copy"),
"paste": _("Paste"),
"copy-paste": _("Copy and Paste"),
"select-all": _("Select all"),
"copy-all": _("Copy all"),
"save-buffer": _("Save buffer to file"),
"split-h": _("Split H"),
"split-v": _("Split V"),
"unsplit": _("Unsplit all consoles"),
"reset": _("Reset console"),
"clear": _("Reset and Clear console"),
"clone": _("Clone console"),
"log": _("Enable logging"),
"close": _("Close console"),
}
# Disposition constante (pas de rebuild du modele a l'ouverture, a
# la difference de TabContextMenu/FolderContextMenu) — voir
# popup_menu_core.POPUP_MENU_SECTIONS et la docstring de classe.
for section_names in POPUP_MENU_SECTIONS:
section = Gio.Menu()
for name in section_names:
section.append(labels[name], f"{prefix}.{name}")
self.model.append_section(None, section)
# Sous-menu dynamique "Custom commands" (3e section, non modelisee
# dans POPUP_MENU_SECTIONS — voir populate_commands()) : modele
# mutable repeuple par l'appelant, jamais reconstruit ici.
self.commands_model = Gio.Menu()
self._last_command_count = 0
commands_section = Gio.Menu()
commands_section.append_submenu(_("Custom commands"), self.commands_model)
self.model.append_section(None, commands_section)
self.popover = Gtk.Popover.new_from_model(None, self.model)
self.popover.set_position(Gtk.PositionType.BOTTOM)
self.popover.insert_action_group(prefix, self.actions)
# Popover autonome pour l'action-pont du menu hamburger (fusionne
# l'ancien add_popup_action("custom-commands", lambda: self.popupMenu
# .mnuCommands) de _build_primary_menu, qui appelait .popup()
# directement sur le Gtk.Menu) — meme modele et meme groupe
# d'actions que ci-dessus, donc toujours synchronise.
self.commands_popover = Gtk.Popover.new_from_model(None, self.commands_model)
self.commands_popover.set_position(Gtk.PositionType.BOTTOM)
self.commands_popover.insert_action_group(prefix, self.actions)
app_logger.debug("PopupMenu.__init__() returning")
def _add_simple_action(self, name, item_code):
"""Enregistre une action simple qui relaie l'activation vers ``dispatch``.
Args:
name (str): Nom de l'action dans le ``Gio.SimpleActionGroup``
(sans le prefixe ``popupmenu.``).
item_code (str): Code d'action historique attendu par
``Wmain.on_popupmenu`` (ex. ``"C"`` pour "Copy").
"""
app_logger.debug(
f"PopupMenu._add_simple_action() called | name={name!r} item_code={item_code!r}"
)
action = Gio.SimpleAction.new(name, None)
action.connect("activate", lambda a, p, code=item_code: self._dispatch(None, code))
self.actions.add_action(action)
app_logger.debug("PopupMenu._add_simple_action() returning")
def _on_log_change_state(self, action, value):
"""Applique le changement d'etat de la case "Enable logging" puis relaie.
Reproduit l'ordre de l'ancien ``Gtk.CheckMenuItem`` : GTK bascule
l'etat affiche avant d'emettre l'evenement d'activation, et le
gestionnaire metier (``Wmain.on_popupmenu``, item ``"L2"``) peut
ensuite revenir dessus (ex. mode de log continu actif — voir
``gnome_connection_manager.py``) via ``set_active(False)`` sur le
shim, qui rappelle ``action.set_state()`` — meme principe que
``TabContextMenu._on_log_change_state`` (code ``"L2"`` plutot que
``"L"`` pour rester distinguable cote ``Wmain.on_popupmenu``).
Args:
action (Gio.SimpleAction): Action a etat booleen ("log").
value (GLib.Variant): Nouvel etat demande.
"""
app_logger.debug(
f"PopupMenu._on_log_change_state() called | value={value.get_boolean()!r}"
)
action.set_state(value)
self._dispatch(_LogActionShim(action), "L2")
app_logger.debug("PopupMenu._on_log_change_state() returning")
def rebuild(self, *, has_selection, multi_pane, has_split_notebook, log_active):
"""Met a jour la sensibilite des actions variables et la case "Enable logging".
Contrairement a ``TabContextMenu.rebuild()``/
``FolderContextMenu.rebuild()``, ne touche PAS ``self.model`` : la
disposition de popupMenu (``popup_menu_core.POPUP_MENU_SECTIONS``)
est constante, seule la SENSIBILITE de quatre actions varie selon le
contexte du clic droit (ancien ``mnuCopy``/``mnuSplitH``/
``mnuSplitV``/``mnuUnsplit.set_sensitive()``, voir