annotate sat_frontends/jp/base.py @ 3637:51983c55c5b6

merge branche "@"
author Goffi <goffi@goffi.org>
date Wed, 01 Sep 2021 13:47:17 +0200
parents 1709f0a78f50 43542cf32e5a
children 09f5ac48ffe3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3043
3df611adb598 jp: handle dbus bridge with asyncio:
Goffi <goffi@goffi.org>
parents: 3040
diff changeset
1 #!/usr/bin/env python3
0
goffi@necton2
parents:
diff changeset
2
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
3 # jp: a SAT command line tool
3479
be6d91572633 date update
Goffi <goffi@goffi.org>
parents: 3412
diff changeset
4 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
0
goffi@necton2
parents:
diff changeset
5
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
6 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
7 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
8 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
9 # (at your option) any later version.
0
goffi@necton2
parents:
diff changeset
10
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
11 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
14 # GNU Affero General Public License for more details.
0
goffi@necton2
parents:
diff changeset
15
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
16 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 601
diff changeset
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
0
goffi@necton2
parents:
diff changeset
18
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
19 import asyncio
771
bfabeedbf32e core: i18n refactoring:
Goffi <goffi@goffi.org>
parents: 721
diff changeset
20 from sat.core.i18n import _
402
f03688bdb858 jp: use with statement to open fifo
Goffi <goffi@goffi.org>
parents: 401
diff changeset
21
0
goffi@necton2
parents:
diff changeset
22 ### logging ###
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
23 import logging as log
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
24 log.basicConfig(level=log.WARNING,
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
25 format='[%(name)s] %(message)s')
0
goffi@necton2
parents:
diff changeset
26 ###
goffi@necton2
parents:
diff changeset
27
goffi@necton2
parents:
diff changeset
28 import sys
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
29 import os
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
30 import os.path
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
31 import argparse
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
32 import inspect
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
33 import tty
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
34 import termios
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
35 from pathlib import Path
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
36 from glob import iglob
3600
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
37 from typing import Optional
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
38 from importlib import import_module
1139
75025461141f move sat.tools.jid to sat_frontends.tools.jid
souliane <souliane@mailoo.org>
parents: 1033
diff changeset
39 from sat_frontends.tools.jid import JID
2098
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
40 from sat.tools import config
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
41 from sat.tools.common import dynamic_import
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
42 from sat.tools.common import uri
2704
ab37d1c7c38c jp (base): new date_decoder to specify dates in arguments
Goffi <goffi@goffi.org>
parents: 2692
diff changeset
43 from sat.tools.common import date_utils
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
44 from sat.tools.common import utils
3586
5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict
Goffi <goffi@goffi.org>
parents: 3568
diff changeset
45 from sat.tools.common import data_format
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
46 from sat.tools.common.ansi import ANSI as A
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
47 from sat.core import exceptions
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
48 import sat_frontends.jp
3043
3df611adb598 jp: handle dbus bridge with asyncio:
Goffi <goffi@goffi.org>
parents: 3040
diff changeset
49 from sat_frontends.jp.loops import QuitException, getJPLoop
970
2e052998c7eb jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents: 965
diff changeset
50 from sat_frontends.jp.constants import Const as C
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
51 from sat_frontends.bridge.bridge_frontend import BridgeException
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
52 from sat_frontends.tools import misc
1840
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
53 import xml.etree.ElementTree as ET # FIXME: used temporarily to manage XMLUI
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
54 from collections import OrderedDict
1872
df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors:
Goffi <goffi@goffi.org>
parents: 1869
diff changeset
55
2098
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
56 ## bridge handling
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
57 # we get bridge name from conf and initialise the right class accordingly
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
58 main_config = config.parseMainConf()
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
59 bridge_name = config.getConfig(main_config, '', 'bridge', 'dbus')
3043
3df611adb598 jp: handle dbus bridge with asyncio:
Goffi <goffi@goffi.org>
parents: 3040
diff changeset
60 JPLoop = getJPLoop(bridge_name)
2098
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
61
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
62
0
goffi@necton2
parents:
diff changeset
63 try:
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
64 import progressbar
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
65 except ImportError:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
66 msg = (_('ProgressBar not available, please download it at '
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
67 'http://pypi.python.org/pypi/progressbar\n'
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
68 'Progress bar deactivated\n--\n'))
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
69 print(msg, file=sys.stderr)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
70 progressbar=None
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
71
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
72 #consts
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
73 DESCRIPTION = """This software is a command line tool for XMPP.
970
2e052998c7eb jp: using C.APP_URL for application url
Goffi <goffi@goffi.org>
parents: 965
diff changeset
74 Get the latest version at """ + C.APP_URL
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
75
3479
be6d91572633 date update
Goffi <goffi@goffi.org>
parents: 3412
diff changeset
76 COPYLEFT = """Copyright (C) 2009-2021 Jérôme Poisson, Adrien Cossa
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
77 This program comes with ABSOLUTELY NO WARRANTY;
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
78 This is free software, and you are welcome to redistribute it under certain conditions.
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
79 """
0
goffi@necton2
parents:
diff changeset
80
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
81 PROGRESS_DELAY = 0.1 # the progression will be checked every PROGRESS_DELAY s
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
82
0
goffi@necton2
parents:
diff changeset
83
2704
ab37d1c7c38c jp (base): new date_decoder to specify dates in arguments
Goffi <goffi@goffi.org>
parents: 2692
diff changeset
84 def date_decoder(arg):
ab37d1c7c38c jp (base): new date_decoder to specify dates in arguments
Goffi <goffi@goffi.org>
parents: 2692
diff changeset
85 return date_utils.date_parse_ext(arg, default_tz=date_utils.TZ_LOCAL)
ab37d1c7c38c jp (base): new date_decoder to specify dates in arguments
Goffi <goffi@goffi.org>
parents: 2692
diff changeset
86
ab37d1c7c38c jp (base): new date_decoder to specify dates in arguments
Goffi <goffi@goffi.org>
parents: 2692
diff changeset
87
3481
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
88 class LiberviaCli:
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
89 """
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
90 This class can be use to establish a connection with the
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
91 bridge. Moreover, it should manage a main loop.
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
92
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
93 To use it, you mainly have to redefine the method run to perform
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
94 specify what kind of operation you want to perform.
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
95
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
96 """
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
97 def __init__(self):
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
98 """
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
99
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
100 @attribute quit_on_progress_end (bool): set to False if you manage yourself
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
101 exiting, or if you want the user to stop by himself
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
102 @attribute progress_success(callable): method to call when progress just started
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
103 by default display a message
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
104 @attribute progress_success(callable): method to call when progress is
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
105 successfully finished by default display a message
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
106 @attribute progress_failure(callable): method to call when progress failed
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
107 by default display a message
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
108 """
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
109 self.sat_conf = main_config
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
110 self.set_color_theme()
2098
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
111 bridge_module = dynamic_import.bridge(bridge_name, 'sat_frontends.bridge')
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
112 if bridge_module is None:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
113 log.error("Can't import {} bridge".format(bridge_name))
165
8a2053de6f8c Frontends: management of unlaunched SàT Backend (information message and exit)
Goffi <goffi@goffi.org>
parents: 156
diff changeset
114 sys.exit(1)
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
115
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
116 self.bridge = bridge_module.AIOBridge()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
117 self._onQuitCallbacks = []
2098
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
118
3555
53fec6309fa3 cli: update constants to use new name
Goffi <goffi@goffi.org>
parents: 3547
diff changeset
119 def get_config(self, name, section=C.CONFIG_SECTION, default=None):
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
120 """Retrieve a setting value from sat.conf"""
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
121 return config.getConfig(self.sat_conf, section, name, default=default)
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
122
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
123 def guess_background(self):
3547
1ac5570fa998 jp: fix background guessing when stdin is redirected
Goffi <goffi@goffi.org>
parents: 3490
diff changeset
124 if not sys.stdin.isatty() or not sys.stdout.isatty():
3378
67e306cae157 jp: don't guess background when stdout is not a tty
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
125 return 'dark'
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
126 stdin_fd = sys.stdin.fileno()
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
127 old_settings = termios.tcgetattr(stdin_fd)
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
128 try:
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
129 tty.setraw(sys.stdin.fileno())
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
130 # we request background color
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
131 sys.stdout.write("\033]11;?\a")
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
132 sys.stdout.flush()
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
133 expected = "\033]11;rgb:"
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
134 for c in expected:
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
135 ch = sys.stdin.read(1)
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
136 if ch != c:
3051
ee2654308a57 jp: default to "dark" if background is not set and can't be detected
Goffi <goffi@goffi.org>
parents: 3049
diff changeset
137 # background id is not supported, we default to "dark"
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
138 # TODO: log something?
3051
ee2654308a57 jp: default to "dark" if background is not set and can't be detected
Goffi <goffi@goffi.org>
parents: 3049
diff changeset
139 return 'dark'
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
140 red, green, blue = [int(c, 16)/65535 for c in sys.stdin.read(14).split('/')]
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
141 # '\a' is the last character
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
142 sys.stdin.read(1)
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
143 finally:
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
144 termios.tcsetattr(stdin_fd, termios.TCSADRAIN, old_settings)
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
145
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
146 lum = utils.per_luminance(red, green, blue)
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
147 if lum <= 0.5:
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
148 return 'dark'
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
149 else:
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
150 return 'light'
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
151
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
152 def set_color_theme(self):
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
153 background = self.get_config('background', default='auto')
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
154 if background == 'auto':
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
155 background = self.guess_background()
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
156 if background not in ('dark', 'light'):
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
157 raise exceptions.ConfigError(_(
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
158 'Invalid value set for "background" ({background}), please check '
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
159 'your settings in libervia.conf').format(
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
160 background=repr(background)
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
161 ))
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
162 if background == 'light':
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
163 C.A_HEADER = A.FG_MAGENTA
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
164 C.A_SUBHEADER = A.BOLD + A.FG_RED
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
165 C.A_LEVEL_COLORS = (C.A_HEADER, A.BOLD + A.FG_BLUE, A.FG_MAGENTA, A.FG_CYAN)
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
166 C.A_SUCCESS = A.FG_GREEN
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
167 C.A_FAILURE = A.BOLD + A.FG_RED
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
168 C.A_WARNING = A.FG_RED
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
169 C.A_PROMPT_PATH = A.FG_BLUE
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
170 C.A_PROMPT_SUF = A.BOLD
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
171 C.A_DIRECTORY = A.BOLD + A.FG_MAGENTA
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
172 C.A_FILE = A.FG_BLACK
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
173
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
174 def _bridgeConnected(self):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
175 self.parser = argparse.ArgumentParser(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
176 formatter_class=argparse.RawDescriptionHelpFormatter, description=DESCRIPTION)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
177 self._make_parents()
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
178 self.add_parser_options()
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
179 self.subparsers = self.parser.add_subparsers(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
180 title=_('Available commands'), dest='command', required=True)
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
181
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
182 # progress attributes
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
183 self._progress_id = None # TODO: manage several progress ids
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
184 self.quit_on_progress_end = True
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
185
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
186 # outputs
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
187 self._outputs = {}
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
188 for type_ in C.OUTPUT_TYPES:
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
189 self._outputs[type_] = OrderedDict()
2189
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
190 self.default_output = {}
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
191
2705
0bb811aaf11d jp (base): new own_jid host attribute:
Goffi <goffi@goffi.org>
parents: 2704
diff changeset
192 self.own_jid = None # must be filled at runtime if needed
0bb811aaf11d jp (base): new own_jid host attribute:
Goffi <goffi@goffi.org>
parents: 2704
diff changeset
193
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
194 @property
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
195 def progress_id(self):
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
196 return self._progress_id
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
197
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
198 async def set_progress_id(self, progress_id):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
199 # because we use async, we need an explicit setter
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
200 self._progress_id = progress_id
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
201 await self.replayCache('progress_ids_cache')
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
202
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
203 @property
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
204 def watch_progress(self):
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
205 try:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
206 self.pbar
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
207 except AttributeError:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
208 return False
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
209 else:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
210 return True
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
211
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
212 @watch_progress.setter
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
213 def watch_progress(self, watch_progress):
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
214 if watch_progress:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
215 self.pbar = None
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
216
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
217 @property
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
218 def verbosity(self):
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
219 try:
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
220 return self.args.verbose
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
221 except AttributeError:
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
222 return 0
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
223
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
224 async def replayCache(self, cache_attribute):
1642
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
225 """Replay cached signals
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
226
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
227 @param cache_attribute(str): name of the attribute containing the cache
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
228 if the attribute doesn't exist, there is no cache and the call is ignored
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
229 else the cache must be a list of tuples containing the replay callback as
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
230 first item, then the arguments to use
1642
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
231 """
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
232 try:
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
233 cache = getattr(self, cache_attribute)
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
234 except AttributeError:
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
235 pass
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
236 else:
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
237 for cache_data in cache:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
238 await cache_data[0](*cache_data[1:])
1642
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
239
3407
2f0be2b7de68 jp: replace `no_lf` argument by `end` in `disp` (same as in `print`)
Goffi <goffi@goffi.org>
parents: 3378
diff changeset
240 def disp(self, msg, verbosity=0, error=False, end='\n'):
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
241 """Print a message to user
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
242
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
243 @param msg(unicode): message to print
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
244 @param verbosity(int): minimal verbosity to display the message
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
245 @param error(bool): if True, print to stderr instead of stdout
3407
2f0be2b7de68 jp: replace `no_lf` argument by `end` in `disp` (same as in `print`)
Goffi <goffi@goffi.org>
parents: 3378
diff changeset
246 @param end(str): string appended after the last value, default a newline
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
247 """
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
248 if self.verbosity >= verbosity:
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
249 if error:
3407
2f0be2b7de68 jp: replace `no_lf` argument by `end` in `disp` (same as in `print`)
Goffi <goffi@goffi.org>
parents: 3378
diff changeset
250 print(msg, end=end, file=sys.stderr)
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
251 else:
3407
2f0be2b7de68 jp: replace `no_lf` argument by `end` in `disp` (same as in `print`)
Goffi <goffi@goffi.org>
parents: 3378
diff changeset
252 print(msg, end=end)
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
253
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
254 async def output(self, type_, name, extra_outputs, data):
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
255 if name in extra_outputs:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
256 method = extra_outputs[name]
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
257 else:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
258 method = self._outputs[type_][name]['callback']
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
259
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
260 ret = method(data)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
261 if inspect.isawaitable(ret):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
262 await ret
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
263
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
264 def addOnQuitCallback(self, callback, *args, **kwargs):
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
265 """Add a callback which will be called on quit command
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
266
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
267 @param callback(callback): method to call
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
268 """
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
269 self._onQuitCallbacks.append((callback, args, kwargs))
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
270
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
271 def getOutputChoices(self, output_type):
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
272 """Return valid output filters for output_type
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
273
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
274 @param output_type: True for default,
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
275 else can be any registered type
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
276 """
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
277 return list(self._outputs[output_type].keys())
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
278
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
279 def _make_parents(self):
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
280 self.parents = {}
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
281
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
282 # we have a special case here as the start-session option is present only if
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
283 # connection is not needed, so we create two similar parents, one with the
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
284 # option, the other one without it
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
285 for parent_name in ('profile', 'profile_session'):
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
286 parent = self.parents[parent_name] = argparse.ArgumentParser(add_help=False)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
287 parent.add_argument(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
288 "-p", "--profile", action="store", type=str, default='@DEFAULT@',
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
289 help=_("Use PROFILE profile key (default: %(default)s)"))
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
290 parent.add_argument(
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
291 "--pwd", action="store", metavar='PASSWORD',
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
292 help=_("Password used to connect profile, if necessary"))
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
293
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
294 profile_parent, profile_session_parent = (self.parents['profile'],
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
295 self.parents['profile_session'])
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
296
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
297 connect_short, connect_long, connect_action, connect_help = (
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
298 "-c", "--connect", "store_true",
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
299 _("Connect the profile before doing anything else")
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
300 )
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
301 profile_parent.add_argument(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
302 connect_short, connect_long, action=connect_action, help=connect_help)
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
303
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
304 profile_session_connect_group = profile_session_parent.add_mutually_exclusive_group()
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
305 profile_session_connect_group.add_argument(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
306 connect_short, connect_long, action=connect_action, help=connect_help)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
307 profile_session_connect_group.add_argument(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
308 "--start-session", action="store_true",
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
309 help=_("Start a profile session without connecting"))
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
310
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
311 progress_parent = self.parents['progress'] = argparse.ArgumentParser(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
312 add_help=False)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
313 if progressbar:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
314 progress_parent.add_argument(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
315 "-P", "--progress", action="store_true", help=_("Show progress bar"))
0
goffi@necton2
parents:
diff changeset
316
1600
8d41cd4da2f6 jp: added a --verbose command
Goffi <goffi@goffi.org>
parents: 1594
diff changeset
317 verbose_parent = self.parents['verbose'] = argparse.ArgumentParser(add_help=False)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
318 verbose_parent.add_argument(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
319 '--verbose', '-v', action='count', default=0,
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
320 help=_("Add a verbosity level (can be used multiple times)"))
1600
8d41cd4da2f6 jp: added a --verbose command
Goffi <goffi@goffi.org>
parents: 1594
diff changeset
321
3412
7b4ae3dbc041 jp (base, pubsub/set): new `--quiet` argument:
Goffi <goffi@goffi.org>
parents: 3409
diff changeset
322 quiet_parent = self.parents['quiet'] = argparse.ArgumentParser(add_help=False)
7b4ae3dbc041 jp (base, pubsub/set): new `--quiet` argument:
Goffi <goffi@goffi.org>
parents: 3409
diff changeset
323 quiet_parent.add_argument(
7b4ae3dbc041 jp (base, pubsub/set): new `--quiet` argument:
Goffi <goffi@goffi.org>
parents: 3409
diff changeset
324 '--quiet', '-q', action='store_true',
7b4ae3dbc041 jp (base, pubsub/set): new `--quiet` argument:
Goffi <goffi@goffi.org>
parents: 3409
diff changeset
325 help=_("be quiet (only output machine readable data)"))
7b4ae3dbc041 jp (base, pubsub/set): new `--quiet` argument:
Goffi <goffi@goffi.org>
parents: 3409
diff changeset
326
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
327 draft_parent = self.parents['draft'] = argparse.ArgumentParser(add_help=False)
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
328 draft_group = draft_parent.add_argument_group(_('draft handling'))
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
329 draft_group.add_argument(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
330 "-D", "--current", action="store_true", help=_("load current draft"))
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
331 draft_group.add_argument(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
332 "-F", "--draft-path", type=Path, help=_("path to a draft file to retrieve"))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
333
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
334
2547
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
335 def make_pubsub_group(self, flags, defaults):
3600
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
336 """Generate pubsub options according to flags
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
337
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
338 @param flags(iterable[unicode]): see [CommandBase.__init__]
2547
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
339 @param defaults(dict[unicode, unicode]): help text for default value
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
340 key can be "service" or "node"
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
341 value will be set in " (DEFAULT: {value})", or can be None to remove DEFAULT
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
342 @return (ArgumentParser): parser to add
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
343 """
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
344 flags = misc.FlagsHandler(flags)
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
345 parent = argparse.ArgumentParser(add_help=False)
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
346 pubsub_group = parent.add_argument_group('pubsub')
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
347 pubsub_group.add_argument("-u", "--pubsub-url",
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
348 help=_("Pubsub URL (xmpp or http)"))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
349
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
350 service_help = _("JID of the PubSub service")
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
351 if not flags.service:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
352 default = defaults.pop('service', _('PEP service'))
2547
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
353 if default is not None:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
354 service_help += _(" (DEFAULT: {default})".format(default=default))
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
355 pubsub_group.add_argument("-s", "--service", default='',
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
356 help=service_help)
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
357
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
358 node_help = _("node to request")
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
359 if not flags.node:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
360 default = defaults.pop('node', _('standard node'))
2547
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
361 if default is not None:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
362 node_help += _(" (DEFAULT: {default})".format(default=default))
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
363 pubsub_group.add_argument("-n", "--node", default='', help=node_help)
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
364
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
365 if flags.single_item:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
366 item_help = ("item to retrieve")
2552
38e1e29c48e9 jp (base): added C.ITEM pubsub flag when --item is required
Goffi <goffi@goffi.org>
parents: 2550
diff changeset
367 if not flags.item:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
368 default = defaults.pop('item', _('last item'))
2552
38e1e29c48e9 jp (base): added C.ITEM pubsub flag when --item is required
Goffi <goffi@goffi.org>
parents: 2550
diff changeset
369 if default is not None:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
370 item_help += _(" (DEFAULT: {default})".format(default=default))
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
371 pubsub_group.add_argument("-i", "--item", default='',
2910
b2f323237fce jp, plugin merge-requests: used u'' as default for item id in pubsub arguments + fixed some required arguments:
Goffi <goffi@goffi.org>
parents: 2775
diff changeset
372 help=item_help)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
373 pubsub_group.add_argument(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
374 "-L", "--last-item", action='store_true', help=_('retrieve last item'))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
375 elif flags.multi_items:
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
376 # mutiple items, this activate several features: max-items, RSM, MAM
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
377 # and Orbder-by
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
378 pubsub_group.add_argument(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
379 "-i", "--item", action='append', dest='items', default=[],
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
380 help=_("items to retrieve (DEFAULT: all)"))
2539
dcc77f23e370 jp (base): add --max option:
Goffi <goffi@goffi.org>
parents: 2538
diff changeset
381 if not flags.no_max:
2775
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
382 max_group = pubsub_group.add_mutually_exclusive_group()
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
383 # XXX: defaut value for --max-items or --max is set in parse_pubsub_args
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
384 max_group.add_argument(
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
385 "-M", "--max-items", dest="max", type=int,
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
386 help=_("maximum number of items to get ({no_limit} to get all items)"
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
387 .format(no_limit=C.NO_LIMIT)))
2775
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
388 # FIXME: it could be possible to no duplicate max (between pubsub
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
389 # max-items and RSM max)should not be duplicated, RSM could be
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
390 # used when available and pubsub max otherwise
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
391 max_group.add_argument(
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
392 "-m", "--max", dest="rsm_max", type=int,
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
393 help=_("maximum number of items to get per page (DEFAULT: 10)"))
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
394
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
395 # RSM
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
396
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
397 rsm_page_group = pubsub_group.add_mutually_exclusive_group()
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
398 rsm_page_group.add_argument(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
399 "-a", "--after", dest="rsm_after",
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
400 help=_("find page after this item"), metavar='ITEM_ID')
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
401 rsm_page_group.add_argument(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
402 "-b", "--before", dest="rsm_before",
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
403 help=_("find page before this item"), metavar='ITEM_ID')
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
404 rsm_page_group.add_argument(
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
405 "--index", dest="rsm_index", type=int,
3600
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
406 help=_("index of the first item to retrieve"))
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
407
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
408
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
409 # MAM
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
410
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
411 pubsub_group.add_argument(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
412 "-f", "--filter", dest='mam_filters', nargs=2,
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
413 action='append', default=[], help=_("MAM filters to use"),
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
414 metavar=("FILTER_NAME", "VALUE")
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
415 )
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
416
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
417 # Order-By
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
418
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
419 # TODO: order-by should be a list to handle several levels of ordering
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
420 # but this is not yet done in SàT (and not really useful with
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
421 # current specifications, as only "creation" and "modification" are
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
422 # available)
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
423 pubsub_group.add_argument(
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
424 "-o", "--order-by", choices=[C.ORDER_BY_CREATION,
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
425 C.ORDER_BY_MODIFICATION],
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
426 help=_("how items should be ordered"))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
427
3600
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
428 if flags[C.CACHE]:
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
429 pubsub_group.add_argument(
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
430 "-C", "--no-cache", dest="use_cache", action='store_false',
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
431 help=_("don't use Pubsub cache")
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
432 )
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
433
2615
b4ecbcc2fd08 tools (misc): do not remove flags while using them anymore, instead added "all_used" and "unused" properties in FlagsHandler
Goffi <goffi@goffi.org>
parents: 2614
diff changeset
434 if not flags.all_used:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
435 raise exceptions.InternalError('unknown flags: {flags}'.format(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
436 flags=', '.join(flags.unused)))
2547
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
437 if defaults:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
438 raise exceptions.InternalError(f'unused defaults: {defaults}')
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
439
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
440 return parent
2235
4db836386641 jp: added use_pubsub and use_pubsub_node_req arguments to CommandBase
Goffi <goffi@goffi.org>
parents: 2213
diff changeset
441
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
442 def add_parser_options(self):
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
443 self.parser.add_argument(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
444 '--version',
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
445 action='version',
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
446 version=("{name} {version} {copyleft}".format(
3555
53fec6309fa3 cli: update constants to use new name
Goffi <goffi@goffi.org>
parents: 3547
diff changeset
447 name = C.APP_NAME,
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
448 version = self.version,
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
449 copyleft = COPYLEFT))
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
450 )
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
451
2189
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
452 def register_output(self, type_, name, callback, description="", default=False):
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
453 if type_ not in C.OUTPUT_TYPES:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
454 log.error("Invalid output type {}".format(type_))
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
455 return
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
456 self._outputs[type_][name] = {'callback': callback,
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
457 'description': description
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
458 }
2189
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
459 if default:
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
460 if type_ in self.default_output:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
461 self.disp(
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
462 _('there is already a default output for {type}, ignoring new one')
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
463 .format(type=type_)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
464 )
2189
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
465 else:
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
466 self.default_output[type_] = name
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
467
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
468
2187
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
469 def parse_output_options(self):
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
470 options = self.command.args.output_opts
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
471 options_dict = {}
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
472 for option in options:
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
473 try:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
474 key, value = option.split('=', 1)
2187
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
475 except ValueError:
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
476 key, value = option, None
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
477 options_dict[key.strip()] = value.strip() if value is not None else None
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
478 return options_dict
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
479
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
480 def check_output_options(self, accepted_set, options):
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
481 if not accepted_set.issuperset(options):
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
482 self.disp(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
483 _("The following output options are invalid: {invalid_options}").format(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
484 invalid_options = ', '.join(set(options).difference(accepted_set))),
2187
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
485 error=True)
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
486 self.quit(C.EXIT_BAD_ARG)
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods
Goffi <goffi@goffi.org>
parents: 2178
diff changeset
487
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
488 def import_plugins(self):
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
489 """Automaticaly import commands and outputs in jp
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
490
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
491 looks from modules names cmd_*.py in jp path and import them
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
492 """
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
493 path = os.path.dirname(sat_frontends.jp.__file__)
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
494 # XXX: outputs must be imported before commands as they are used for arguments
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
495 for type_, pattern in ((C.PLUGIN_OUTPUT, 'output_*.py'),
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
496 (C.PLUGIN_CMD, 'cmd_*.py')):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
497 modules = (
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
498 os.path.splitext(module)[0]
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
499 for module in map(os.path.basename, iglob(os.path.join(path, pattern))))
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
500 for module_name in modules:
2162
c9a67eb5bf72 jp (base): improved module import:
Goffi <goffi@goffi.org>
parents: 2161
diff changeset
501 module_path = "sat_frontends.jp." + module_name
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
502 try:
2162
c9a67eb5bf72 jp (base): improved module import:
Goffi <goffi@goffi.org>
parents: 2161
diff changeset
503 module = import_module(module_path)
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
504 self.import_plugin_module(module, type_)
2178
b9bfc45cea22 jp (base): added generic errback to CommandBase + show error message on plugin ImportError
Goffi <goffi@goffi.org>
parents: 2168
diff changeset
505 except ImportError as e:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
506 self.disp(
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
507 _("Can't import {module_path} plugin, ignoring it: {e}")
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
508 .format(module_path=module_path, e=e),
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
509 error=True)
2162
c9a67eb5bf72 jp (base): improved module import:
Goffi <goffi@goffi.org>
parents: 2161
diff changeset
510 except exceptions.CancelError:
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
511 continue
2162
c9a67eb5bf72 jp (base): improved module import:
Goffi <goffi@goffi.org>
parents: 2161
diff changeset
512 except exceptions.MissingModule as e:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
513 self.disp(_("Missing module for plugin {name}: {missing}".format(
2162
c9a67eb5bf72 jp (base): improved module import:
Goffi <goffi@goffi.org>
parents: 2161
diff changeset
514 name = module_path,
2188
052d560d0dce jp (base): replaced log.warning by stderr prints
Goffi <goffi@goffi.org>
parents: 2187
diff changeset
515 missing = e)), error=True)
2162
c9a67eb5bf72 jp (base): improved module import:
Goffi <goffi@goffi.org>
parents: 2161
diff changeset
516
0
goffi@necton2
parents:
diff changeset
517
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
518 def import_plugin_module(self, module, type_):
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
519 """add commands or outpus from a module to jp
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
520
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
521 @param module: module containing commands or outputs
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
522 @param type_(str): one of C_PLUGIN_*
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
523 """
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
524 try:
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
525 class_names = getattr(module, '__{}__'.format(type_))
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
526 except AttributeError:
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
527 log.disp(
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
528 _("Invalid plugin module [{type}] {module}")
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
529 .format(type=type_, module=module),
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
530 error=True)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
531 raise ImportError
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
532 else:
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
533 for class_name in class_names:
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
534 cls = getattr(module, class_name)
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
535 cls(self)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
536
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
537 def get_xmpp_uri_from_http(self, http_url):
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
538 """parse HTML page at http(s) URL, and looks for xmpp: uri"""
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
539 if http_url.startswith('https'):
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
540 scheme = 'https'
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
541 elif http_url.startswith('http'):
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
542 scheme = 'http'
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
543 else:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
544 raise exceptions.InternalError('An HTTP scheme is expected in this method')
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
545 self.disp(f"{scheme.upper()} URL found, trying to find associated xmpp: URI", 1)
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
546 # HTTP URL, we try to find xmpp: links
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
547 try:
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
548 from lxml import etree
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
549 except ImportError:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
550 self.disp(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
551 "lxml module must be installed to use http(s) scheme, please install it "
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
552 "with \"pip install lxml\"",
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
553 error=True)
2672
0bed6df9ee5d jp: fixed bad call to quit
Goffi <goffi@goffi.org>
parents: 2671
diff changeset
554 self.quit(1)
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
555 import urllib.request, urllib.error, urllib.parse
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
556 parser = etree.HTMLParser()
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
557 try:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
558 root = etree.parse(urllib.request.urlopen(http_url), parser)
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
559 except etree.XMLSyntaxError as e:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
560 self.disp(_("Can't parse HTML page : {msg}").format(msg=e))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
561 links = []
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
562 else:
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
563 links = root.xpath("//link[@rel='alternate' and starts-with(@href, 'xmpp:')]")
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
564 if not links:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
565 self.disp(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
566 _('Could not find alternate "xmpp:" URI, can\'t find associated XMPP '
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
567 'PubSub node/item'),
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
568 error=True)
2672
0bed6df9ee5d jp: fixed bad call to quit
Goffi <goffi@goffi.org>
parents: 2671
diff changeset
569 self.quit(1)
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
570 xmpp_uri = links[0].get('href')
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
571 return xmpp_uri
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
572
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
573 def parse_pubsub_args(self):
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
574 if self.args.pubsub_url is not None:
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
575 url = self.args.pubsub_url
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
576
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
577 if url.startswith('http'):
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
578 # http(s) URL, we try to retrieve xmpp one from there
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
579 url = self.get_xmpp_uri_from_http(url)
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
580
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
581 try:
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
582 uri_data = uri.parseXMPPUri(url)
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
583 except ValueError:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
584 self.parser.error(_('invalid XMPP URL: {url}').format(url=url))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
585 else:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
586 if uri_data['type'] == 'pubsub':
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
587 # URL is alright, we only set data not already set by other options
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
588 if not self.args.service:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
589 self.args.service = uri_data['path']
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
590 if not self.args.node:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
591 self.args.node = uri_data['node']
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
592 uri_item = uri_data.get('item')
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
593 if uri_item:
2556
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
594 # there is an item in URI
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
595 # we use it only if item is not already set
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
596 # and item_last is not used either
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
597 try:
2556
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
598 item = self.args.item
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
599 except AttributeError:
2609
75d2ac872965 jp (base): do not crash when item is specified (e.g. in URL) but not needed in command, but display a message on stderr.
Goffi <goffi@goffi.org>
parents: 2588
diff changeset
600 try:
75d2ac872965 jp (base): do not crash when item is specified (e.g. in URL) but not needed in command, but display a message on stderr.
Goffi <goffi@goffi.org>
parents: 2588
diff changeset
601 items = self.args.items
75d2ac872965 jp (base): do not crash when item is specified (e.g. in URL) but not needed in command, but display a message on stderr.
Goffi <goffi@goffi.org>
parents: 2588
diff changeset
602 except AttributeError:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
603 self.disp(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
604 _("item specified in URL but not needed in command, "
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
605 "ignoring it"),
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
606 error=True)
2609
75d2ac872965 jp (base): do not crash when item is specified (e.g. in URL) but not needed in command, but display a message on stderr.
Goffi <goffi@goffi.org>
parents: 2588
diff changeset
607 else:
75d2ac872965 jp (base): do not crash when item is specified (e.g. in URL) but not needed in command, but display a message on stderr.
Goffi <goffi@goffi.org>
parents: 2588
diff changeset
608 if not items:
75d2ac872965 jp (base): do not crash when item is specified (e.g. in URL) but not needed in command, but display a message on stderr.
Goffi <goffi@goffi.org>
parents: 2588
diff changeset
609 self.args.items = [uri_item]
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
610 else:
2556
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
611 if not item:
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
612 try:
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
613 item_last = self.args.item_last
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
614 except AttributeError:
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
615 item_last = False
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
616 if not item_last:
340128e0b354 jp (base): fixed URI's item with use_pubsub
Goffi <goffi@goffi.org>
parents: 2552
diff changeset
617 self.args.item = uri_item
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
618 else:
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
619 self.parser.error(
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
620 _('XMPP URL is not a pubsub one: {url}').format(url=url)
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
621 )
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
622 flags = self.args._cmd._pubsub_flags
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
623 # we check required arguments here instead of using add_arguments' required option
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
624 # because the required argument can be set in URL
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
625 if C.SERVICE in flags and not self.args.service:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
626 self.parser.error(_("argument -s/--service is required"))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
627 if C.NODE in flags and not self.args.node:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
628 self.parser.error(_("argument -n/--node is required"))
2552
38e1e29c48e9 jp (base): added C.ITEM pubsub flag when --item is required
Goffi <goffi@goffi.org>
parents: 2550
diff changeset
629 if C.ITEM in flags and not self.args.item:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
630 self.parser.error(_("argument -i/--item is required"))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
631
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
632 # FIXME: mutually groups can't be nested in a group and don't support title
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
633 # so we check conflict here. This may be fixed in Python 3, to be checked
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
634 try:
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
635 if self.args.item and self.args.item_last:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
636 self.parser.error(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
637 _("--item and --item-last can't be used at the same time"))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
638 except AttributeError:
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
639 pass
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
640
2775
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
641 try:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
642 max_items = self.args.max
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
643 rsm_max = self.args.rsm_max
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
644 except AttributeError:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
645 pass
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
646 else:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
647 # we need to set a default value for max, but we need to know if we want
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
648 # to use pubsub's max or RSM's max. The later is used if any RSM or MAM
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
649 # argument is set
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
650 if max_items is None and rsm_max is None:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
651 to_check = ('mam_filters', 'rsm_max', 'rsm_after', 'rsm_before',
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
652 'rsm_index')
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
653 if any((getattr(self.args, name) for name in to_check)):
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
654 # we use RSM
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
655 self.args.rsm_max = 10
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
656 else:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
657 # we use pubsub without RSM
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
658 self.args.max = 10
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
659 if self.args.max is None:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
660 self.args.max = C.NO_LIMIT
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
661
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
662 async def main(self, args, namespace):
1884
0fe69871b71f jp: moved KeyboardInterrupt catch one level higher, so it is also catched if the loop is not started
Goffi <goffi@goffi.org>
parents: 1872
diff changeset
663 try:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
664 await self.bridge.bridgeConnect()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
665 except Exception as e:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
666 if isinstance(e, exceptions.BridgeExceptionNoService):
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
667 print(_("Can't connect to SàT backend, are you sure it's launched ?"))
3490
509f7a1c67dc frontends: use new EXIT_BACKEND_NOT_FOUND exit code:
Goffi <goffi@goffi.org>
parents: 3486
diff changeset
668 self.quit(C.EXIT_BACKEND_NOT_FOUND, raise_exc=False)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
669 elif isinstance(e, exceptions.BridgeInitError):
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
670 print(_("Can't init bridge"))
3490
509f7a1c67dc frontends: use new EXIT_BACKEND_NOT_FOUND exit code:
Goffi <goffi@goffi.org>
parents: 3486
diff changeset
671 self.quit(C.EXIT_BRIDGE_ERROR, raise_exc=False)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
672 else:
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
673 print(
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
674 _("Error while initialising bridge: {e}").format(e=e)
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
675 )
3490
509f7a1c67dc frontends: use new EXIT_BACKEND_NOT_FOUND exit code:
Goffi <goffi@goffi.org>
parents: 3486
diff changeset
676 self.quit(C.EXIT_BRIDGE_ERROR, raise_exc=False)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
677 return
3636
43542cf32e5a cli: call `bridge.getReady()` after bridge connection
Goffi <goffi@goffi.org>
parents: 3568
diff changeset
678 await self.bridge.getReady()
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
679 self.version = await self.bridge.getVersion()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
680 self._bridgeConnected()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
681 self.import_plugins()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
682 try:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
683 self.args = self.parser.parse_args(args, namespace=None)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
684 if self.args._cmd._use_pubsub:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
685 self.parse_pubsub_args()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
686 await self.args._cmd.run()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
687 except SystemExit as e:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
688 self.quit(e.code, raise_exc=False)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
689 return
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
690 except QuitException:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
691 return
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
692
3481
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
693 def _run(self, args=None, namespace=None):
2098
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
694 self.loop = JPLoop()
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
695 self.loop.run(self, args, namespace)
0
goffi@necton2
parents:
diff changeset
696
3481
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
697 @classmethod
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
698 def run(cls):
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
699 cls()._run()
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
700
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
701 def _read_stdin(self, stdin_fut):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
702 """Callback called by ainput to read stdin"""
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
703 line = sys.stdin.readline()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
704 if line:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
705 stdin_fut.set_result(line.rstrip(os.linesep))
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
706 else:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
707 stdin_fut.set_exception(EOFError())
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
708
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
709 async def ainput(self, msg=''):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
710 """Asynchronous version of buildin "input" function"""
3407
2f0be2b7de68 jp: replace `no_lf` argument by `end` in `disp` (same as in `print`)
Goffi <goffi@goffi.org>
parents: 3378
diff changeset
711 self.disp(msg, end=' ')
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
712 sys.stdout.flush()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
713 loop = asyncio.get_running_loop()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
714 stdin_fut = loop.create_future()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
715 loop.add_reader(sys.stdin, self._read_stdin, stdin_fut)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
716 return await stdin_fut
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
717
3409
4ca5bc6b44b6 jp: new `confirm` method:
Goffi <goffi@goffi.org>
parents: 3408
diff changeset
718 async def confirm(self, message):
4ca5bc6b44b6 jp: new `confirm` method:
Goffi <goffi@goffi.org>
parents: 3408
diff changeset
719 """Request user to confirm action, return answer as boolean"""
4ca5bc6b44b6 jp: new `confirm` method:
Goffi <goffi@goffi.org>
parents: 3408
diff changeset
720 res = await self.ainput(f"{message} (y/N)? ")
4ca5bc6b44b6 jp: new `confirm` method:
Goffi <goffi@goffi.org>
parents: 3408
diff changeset
721 return res in ("y", "Y")
4ca5bc6b44b6 jp: new `confirm` method:
Goffi <goffi@goffi.org>
parents: 3408
diff changeset
722
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
723 async def confirmOrQuit(self, message, cancel_message=_("action cancelled by user")):
2550
1d754bc14381 jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents: 2547
diff changeset
724 """Request user to confirm action, and quit if he doesn't"""
3409
4ca5bc6b44b6 jp: new `confirm` method:
Goffi <goffi@goffi.org>
parents: 3408
diff changeset
725 confirmed = await self.confirm(message)
4ca5bc6b44b6 jp: new `confirm` method:
Goffi <goffi@goffi.org>
parents: 3408
diff changeset
726 if not confirmed:
2550
1d754bc14381 jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents: 2547
diff changeset
727 self.disp(cancel_message)
1d754bc14381 jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents: 2547
diff changeset
728 self.quit(C.EXIT_USER_CANCELLED)
1d754bc14381 jp (base): new confirmOrQuit helper method to ask confirmation to user, and quit if he cancel
Goffi <goffi@goffi.org>
parents: 2547
diff changeset
729
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
730 def quitFromSignal(self, exit_code=0):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
731 r"""Same as self.quit, but from a signal handler
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
732
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
733 /!\: return must be used after calling this method !
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
734 """
1918
01d56efd488b jp: fixed traceback shown on a normal quit when a progression is finished
Goffi <goffi@goffi.org>
parents: 1884
diff changeset
735 # XXX: python-dbus will show a traceback if we exit in a signal handler
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
736 # so we use this little timeout trick to avoid it
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
737 self.loop.call_later(0, self.quit, exit_code)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
738
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
739 def quit(self, exit_code=0, raise_exc=True):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
740 """Terminate the execution with specified exit_code
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
741
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
742 This will stop the loop.
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
743 @param exit_code(int): code to return when quitting the program
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
744 @param raise_exp(boolean): if True raise a QuitException to stop code execution
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
745 The default value should be used most of time.
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
746 """
1604
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
747 # first the onQuitCallbacks
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
748 try:
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
749 callbacks_list = self._onQuitCallbacks
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
750 except AttributeError:
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
751 pass
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
752 else:
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
753 for callback, args, kwargs in callbacks_list:
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
754 callback(*args, **kwargs)
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks
Goffi <goffi@goffi.org>
parents: 1600
diff changeset
755
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
756 self.loop.quit(exit_code)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
757 if raise_exc:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
758 raise QuitException
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
759
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
760 async def check_jids(self, jids):
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
761 """Check jids validity, transform roster name to corresponding jids
110
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
762
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
763 @param profile: profile name
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
764 @param jids: list of jids
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
765 @return: List of jids
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
766
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
767 """
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
768 names2jid = {}
493
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid
Goffi <goffi@goffi.org>
parents: 480
diff changeset
769 nodes2jid = {}
393
393b35aa86d2 jp: added --connect option
Goffi <goffi@goffi.org>
parents: 391
diff changeset
770
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
771 for contact in await self.bridge.getContacts(self.profile):
1395
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
772 jid_s, attr, groups = contact
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
773 _jid = JID(jid_s)
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
774 try:
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
775 names2jid[attr["name"].lower()] = jid_s
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
776 except KeyError:
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
777 pass
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
778
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
779 if _jid.node:
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
780 nodes2jid[_jid.node.lower()] = jid_s
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
781
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
782 def expand_jid(jid):
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
783 _jid = jid.lower()
493
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid
Goffi <goffi@goffi.org>
parents: 480
diff changeset
784 if _jid in names2jid:
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid
Goffi <goffi@goffi.org>
parents: 480
diff changeset
785 expanded = names2jid[_jid]
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid
Goffi <goffi@goffi.org>
parents: 480
diff changeset
786 elif _jid in nodes2jid:
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid
Goffi <goffi@goffi.org>
parents: 480
diff changeset
787 expanded = nodes2jid[_jid]
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid
Goffi <goffi@goffi.org>
parents: 480
diff changeset
788 else:
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid
Goffi <goffi@goffi.org>
parents: 480
diff changeset
789 expanded = jid
2588
4011e4ee3151 jp (base): fixed jid encoding
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
790 return expanded
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
791
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
792 def check(jid):
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
793 if not jid.is_valid:
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
794 log.error (_("%s is not a valid JID !"), jid)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
795 self.quit(1)
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
796
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
797 dest_jids=[]
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
798 try:
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
799 for i in range(len(jids)):
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
800 dest_jids.append(expand_jid(jids[i]))
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
801 check(dest_jids[i])
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
802 except AttributeError:
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
803 pass
0
goffi@necton2
parents:
diff changeset
804
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
805 return dest_jids
0
goffi@necton2
parents:
diff changeset
806
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
807 async def a_pwd_input(self, msg=''):
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
808 """Like ainput but with echo disabled (useful for passwords)"""
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
809 # we disable echo, code adapted from getpass standard module which has been
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
810 # written by Piers Lauder (original), Guido van Rossum (Windows support and
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
811 # cleanup) and Gregory P. Smith (tty support & GetPassWarning), a big thanks
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
812 # to them (and for all the amazing work on Python).
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
813 stdin_fd = sys.stdin.fileno()
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
814 old = termios.tcgetattr(sys.stdin)
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
815 new = old[:]
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
816 new[3] &= ~termios.ECHO
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
817 tcsetattr_flags = termios.TCSAFLUSH
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
818 if hasattr(termios, 'TCSASOFT'):
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
819 tcsetattr_flags |= termios.TCSASOFT
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
820 try:
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
821 termios.tcsetattr(stdin_fd, tcsetattr_flags, new)
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
822 pwd = await self.ainput(msg=msg)
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
823 finally:
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
824 termios.tcsetattr(stdin_fd, tcsetattr_flags, old)
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
825 sys.stderr.flush()
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
826 self.disp('')
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
827 return pwd
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
828
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
829 async def connectOrPrompt(self, method, err_msg=None):
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
830 """Try to connect/start profile session and prompt for password if needed
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
831
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
832 @param method(callable): bridge method to either connect or start profile session
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
833 It will be called with password as sole argument, use lambda to do the call
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
834 properly
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
835 @param err_msg(str): message to show if connection fail
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
836 """
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
837 password = self.args.pwd
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
838 while True:
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
839 try:
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
840 await method(password or '')
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
841 except Exception as e:
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
842 if ((isinstance(e, BridgeException)
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
843 and e.classname == 'PasswordError'
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
844 and self.args.pwd is None)):
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
845 if password is not None:
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
846 self.disp(A.color(C.A_WARNING, _("invalid password")))
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
847 password = await self.a_pwd_input(
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
848 _("please enter profile password:"))
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
849 else:
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
850 self.disp(err_msg.format(profile=self.profile, e=e), error=True)
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
851 self.quit(C.EXIT_ERROR)
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
852 else:
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
853 break
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
854
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
855 async def connect_profile(self):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
856 """Check if the profile is connected and do it if requested
1401
265ff2bd8d67 jp: fixed crash on commands using profile without "connect" option
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
857
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
858 @exit: - 1 when profile is not connected and --connect is not set
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
859 - 1 when the profile doesn't exists
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
860 - 1 when there is a connection error
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
861 """
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
862 # FIXME: need better exit codes
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
863
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
864 self.profile = await self.bridge.profileNameGet(self.args.profile)
0
goffi@necton2
parents:
diff changeset
865
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
866 if not self.profile:
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
867 log.error(
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
868 _("The profile [{profile}] doesn't exist")
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
869 .format(profile=self.args.profile)
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
870 )
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
871 self.quit(C.EXIT_ERROR)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
872
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
873 try:
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
874 start_session = self.args.start_session
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
875 except AttributeError:
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
876 pass
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
877 else:
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
878 if start_session:
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
879 await self.connectOrPrompt(
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
880 lambda pwd: self.bridge.profileStartSession(pwd, self.profile),
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
881 err_msg="Can't start {profile}'s session: {e}"
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
882 )
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
883 return
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
884 elif not await self.bridge.profileIsSessionStarted(self.profile):
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
885 if not self.args.connect:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
886 self.disp(_(
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
887 "Session for [{profile}] is not started, please start it "
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
888 "before using jp, or use either --start-session or --connect "
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
889 "option"
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
890 .format(profile=self.profile)
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
891 ), error=True)
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
892 self.quit(1)
2692
7d4679ee7ded jp (base): fixed connection when start_session arg exists but is False
Goffi <goffi@goffi.org>
parents: 2672
diff changeset
893 elif not getattr(self.args, "connect", False):
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
894 return
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
895
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
896
1401
265ff2bd8d67 jp: fixed crash on commands using profile without "connect" option
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
897 if not hasattr(self.args, 'connect'):
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
898 # a profile can be present without connect option (e.g. on profile
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
899 # creation/deletion)
1401
265ff2bd8d67 jp: fixed crash on commands using profile without "connect" option
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
900 return
1588
823a385235ef jp: fixed bad --connect option check
Goffi <goffi@goffi.org>
parents: 1544
diff changeset
901 elif self.args.connect is True: # if connection is asked, we connect the profile
3049
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
902 await self.connectOrPrompt(
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
903 lambda pwd: self.bridge.connect(self.profile, pwd, {}),
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
904 err_msg = 'Can\'t connect profile "{profile!s}": {e}'
9839ce068140 jp: password is now prompted if needed:
Goffi <goffi@goffi.org>
parents: 3046
diff changeset
905 )
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
906 return
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
907 else:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
908 if not await self.bridge.isConnected(self.profile):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
909 log.error(
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
910 _("Profile [{profile}] is not connected, please connect it "
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
911 "before using jp, or use --connect option")
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
912 .format(profile=self.profile)
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
913 )
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
914 self.quit(1)
0
goffi@necton2
parents:
diff changeset
915
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
916 async def get_full_jid(self, param_jid):
1290
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit):
Goffi <goffi@goffi.org>
parents: 1139
diff changeset
917 """Return the full jid if possible (add main resource when find a bare jid)"""
3408
19bc03743aeb jp (file/send): don't add main resource to bare jid anymore:
Goffi <goffi@goffi.org>
parents: 3407
diff changeset
918 # TODO: to be removed, bare jid should work with all commands, notably for file
19bc03743aeb jp (file/send): don't add main resource to bare jid anymore:
Goffi <goffi@goffi.org>
parents: 3407
diff changeset
919 # as backend now handle jingles message initiation
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
920 _jid = JID(param_jid)
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
921 if not _jid.resource:
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
922 #if the resource is not given, we try to add the main resource
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
923 main_resource = await self.bridge.getMainResource(param_jid, self.profile)
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
924 if main_resource:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
925 return f"{_jid.bare}/{main_resource}"
401
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
926 return param_jid
b2caa2615c4c jp roster name manegement + Pipe transfer
Goffi <goffi@goffi.org>
parents: 393
diff changeset
927
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
928
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
929 class CommandBase(object):
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
930
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
931 def __init__(self, host, name, use_profile=True, use_output=False, extra_outputs=None,
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
932 need_connect=None, help=None, **kwargs):
2098
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
933 """Initialise CommandBase
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge:
Goffi <goffi@goffi.org>
parents: 2086
diff changeset
934
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
935 @param host: Jp instance
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
936 @param name(unicode): name of the new command
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
937 @param use_profile(bool): if True, add profile selection/connection commands
2114
dc5d214f0a3b jp (info/session): added a command to get data on current session
Goffi <goffi@goffi.org>
parents: 2098
diff changeset
938 @param use_output(bool, unicode): if not False, add --output option
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
939 @param extra_outputs(dict): list of command specific outputs:
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
940 key is output name ("default" to use as main output)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
941 value is a callable which will format the output (data will be used as only
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
942 argument)
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
943 if a key already exists with normal outputs, the extra one will be used
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
944 @param need_connect(bool, None): True if profile connection is needed
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
945 False else (profile session must still be started)
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
946 None to set auto value (i.e. True if use_profile is set)
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
947 Can't be set if use_profile is False
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
948 @param help(unicode): help message to display
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
949 @param **kwargs: args passed to ArgumentParser
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
950 use_* are handled directly, they can be:
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
951 - use_progress(bool): if True, add progress bar activation option
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
952 progress* signals will be handled
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
953 - use_verbose(bool): if True, add verbosity option
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
954 - use_pubsub(bool): if True, add pubsub options
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
955 mandatory arguments are controlled by pubsub_req
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
956 - use_draft(bool): if True, add draft handling options
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
957 ** other arguments **
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
958 - pubsub_flags(iterable[unicode]): tuple of flags to set pubsub options,
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
959 can be:
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
960 C.SERVICE: service is required
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
961 C.NODE: node is required
2614
a5b96950b81a jp (event): fixed crash on missing item in get and inviteeGet by making it mandatory.
Goffi <goffi@goffi.org>
parents: 2609
diff changeset
962 C.ITEM: item is required
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
963 C.SINGLE_ITEM: only one item is allowed
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
964 """
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
965 try: # If we have subcommands, host is a CommandBase and we need to use host.host
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
966 self.host = host.host
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
967 except AttributeError:
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
968 self.host = host
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
969
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
970 # --profile option
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
971 parents = kwargs.setdefault('parents', set())
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
972 if use_profile:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
973 # self.host.parents['profile'] is an ArgumentParser with profile connection
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
974 # arguments
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
975 if need_connect is None:
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
976 need_connect = True
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
977 parents.add(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
978 self.host.parents['profile' if need_connect else 'profile_session'])
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
979 else:
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
980 assert need_connect is None
1860
afc7f6328394 jp (base): use need_connect attribue to detect if connection is needed instead of self.args.profile, as profile argument can be used by any command even if use_profile is False
Goffi <goffi@goffi.org>
parents: 1840
diff changeset
981 self.need_connect = need_connect
afc7f6328394 jp (base): use need_connect attribue to detect if connection is needed instead of self.args.profile, as profile argument can be used by any command even if use_profile is False
Goffi <goffi@goffi.org>
parents: 1840
diff changeset
982 # from this point, self.need_connect is None if connection is not needed at all
afc7f6328394 jp (base): use need_connect attribue to detect if connection is needed instead of self.args.profile, as profile argument can be used by any command even if use_profile is False
Goffi <goffi@goffi.org>
parents: 1840
diff changeset
983 # False if session starting is needed, and True if full connection is needed
1594
313f2bb7841b jp: profile session can now be started without connection:
Goffi <goffi@goffi.org>
parents: 1588
diff changeset
984
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
985 # --output option
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
986 if use_output:
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
987 if extra_outputs is None:
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
988 extra_outputs = {}
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
989 self.extra_outputs = extra_outputs
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
990 if use_output == True:
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
991 use_output = C.OUTPUT_TEXT
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
992 assert use_output in C.OUTPUT_TYPES
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
993 self._output_type = use_output
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
994 output_parent = argparse.ArgumentParser(add_help=False)
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
995 choices = set(self.host.getOutputChoices(use_output))
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
996 choices.update(extra_outputs)
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
997 if not choices:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
998 raise exceptions.InternalError(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
999 "No choice found for {} output type".format(use_output))
2189
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
1000 try:
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
1001 default = self.host.default_output[use_output]
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
1002 except KeyError:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1003 if 'default' in choices:
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1004 default = 'default'
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1005 elif 'simple' in choices:
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1006 default = 'simple'
2189
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
1007 else:
a25a256688e2 jp (base): output can now specify a default when registering
Goffi <goffi@goffi.org>
parents: 2188
diff changeset
1008 default = list(choices)[0]
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1009 output_parent.add_argument(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1010 '--output', '-O', choices=sorted(choices), default=default,
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1011 help=_("select output format (default: {})".format(default)))
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1012 output_parent.add_argument(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1013 '--output-option', '--oo', action="append", dest='output_opts',
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1014 default=[], help=_("output specific option"))
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1015 parents.add(output_parent)
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
1016 else:
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
1017 assert extra_outputs is None
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1018
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
1019 self._use_pubsub = kwargs.pop('use_pubsub', False)
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
1020 if self._use_pubsub:
2538
0a22dc80d671 jp (base): fixed use_pubsub when pubsub_flags is not needed
Goffi <goffi@goffi.org>
parents: 2532
diff changeset
1021 flags = kwargs.pop('pubsub_flags', [])
2547
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
1022 defaults = kwargs.pop('pubsub_defaults', {})
2d69a0afe039 jp: new argument pubsub_default can be used in Commands to replace default value in help string
Goffi <goffi@goffi.org>
parents: 2539
diff changeset
1023 parents.add(self.host.make_pubsub_group(flags, defaults))
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
1024 self._pubsub_flags = flags
2235
4db836386641 jp: added use_pubsub and use_pubsub_node_req arguments to CommandBase
Goffi <goffi@goffi.org>
parents: 2213
diff changeset
1025
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1026 # other common options
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1027 use_opts = {k:v for k,v in kwargs.items() if k.startswith('use_')}
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1028 for param, do_use in use_opts.items():
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1029 opt=param[4:] # if param is use_verbose, opt is verbose
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1030 if opt not in self.host.parents:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1031 raise exceptions.InternalError("Unknown parent option {}".format(opt))
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1032 del kwargs[param]
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1033 if do_use:
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1034 parents.add(self.host.parents[opt])
1600
8d41cd4da2f6 jp: added a --verbose command
Goffi <goffi@goffi.org>
parents: 1594
diff changeset
1035
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1036 self.parser = host.subparsers.add_parser(name, help=help, **kwargs)
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1037 if hasattr(self, "subcommands"):
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1038 self.subparsers = self.parser.add_subparsers(dest='subcommand', required=True)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1039 else:
2532
772447ec070f jp: pubsub options refactoring:
Goffi <goffi@goffi.org>
parents: 2490
diff changeset
1040 self.parser.set_defaults(_cmd=self)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1041 self.add_parser_options()
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1042
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1043 @property
3046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
1044 def sat_conf(self):
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
1045 return self.host.sat_conf
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
1046
d9f328374473 jp: dark and light theme:
Goffi <goffi@goffi.org>
parents: 3043
diff changeset
1047 @property
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1048 def args(self):
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1049 return self.host.args
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1050
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1051 @property
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1052 def profile(self):
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1053 return self.host.profile
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1054
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1055 @property
2490
b4bf282d6354 jp (base): added verbosity property to CommandBase
Goffi <goffi@goffi.org>
parents: 2486
diff changeset
1056 def verbosity(self):
b4bf282d6354 jp (base): added verbosity property to CommandBase
Goffi <goffi@goffi.org>
parents: 2486
diff changeset
1057 return self.host.verbosity
b4bf282d6354 jp (base): added verbosity property to CommandBase
Goffi <goffi@goffi.org>
parents: 2486
diff changeset
1058
b4bf282d6354 jp (base): added verbosity property to CommandBase
Goffi <goffi@goffi.org>
parents: 2486
diff changeset
1059 @property
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1060 def progress_id(self):
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1061 return self.host.progress_id
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
1062
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1063 async def set_progress_id(self, progress_id):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1064 return await self.host.set_progress_id(progress_id)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1065
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1066 async def progressStartedHandler(self, uid, metadata, profile):
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1067 if profile != self.profile:
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1068 return
1642
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1069 if self.progress_id is None:
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1070 # the progress started message can be received before the id
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1071 # so we keep progressStarted signals in cache to replay they
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1072 # when the progress_id is received
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1073 cache_data = (self.progressStartedHandler, uid, metadata, profile)
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1074 try:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1075 cache = self.host.progress_ids_cache
1642
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1076 except AttributeError:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1077 cache = self.host.progress_ids_cache = []
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1078 cache.append(cache_data)
1642
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1079 else:
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id.
Goffi <goffi@goffi.org>
parents: 1641
diff changeset
1080 if self.host.watch_progress and uid == self.progress_id:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1081 await self.onProgressStarted(metadata)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1082 while True:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1083 await asyncio.sleep(PROGRESS_DELAY)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1084 cont = await self.progressUpdate()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1085 if not cont:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1086 break
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1087
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1088 async def progressFinishedHandler(self, uid, metadata, profile):
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1089 if profile != self.profile:
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1090 return
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1091 if uid == self.progress_id:
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1092 try:
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1093 self.host.pbar.finish()
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1094 except AttributeError:
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1095 pass
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1096 await self.onProgressFinished(metadata)
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1097 if self.host.quit_on_progress_end:
1918
01d56efd488b jp: fixed traceback shown on a normal quit when a progression is finished
Goffi <goffi@goffi.org>
parents: 1884
diff changeset
1098 self.host.quitFromSignal()
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1099
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1100 async def progressErrorHandler(self, uid, message, profile):
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1101 if profile != self.profile:
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1102 return
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1103 if uid == self.progress_id:
1641
44a14f83e64b jp (base): fixed verbose option + there is a new line on ProgressErrorHandler only if the progress bar is actually displayed
Goffi <goffi@goffi.org>
parents: 1627
diff changeset
1104 if self.args.progress:
44a14f83e64b jp (base): fixed verbose option + there is a new line on ProgressErrorHandler only if the progress bar is actually displayed
Goffi <goffi@goffi.org>
parents: 1627
diff changeset
1105 self.disp('') # progress is not finished, so we skip a line
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1106 if self.host.quit_on_progress_end:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1107 await self.onProgressError(message)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1108 self.host.quitFromSignal(C.EXIT_ERROR)
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1109
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1110 async def progressUpdate(self):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1111 """This method is continualy called to update the progress bar
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1112
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1113 @return (bool): False to stop being called
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1114 """
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1115 data = await self.host.bridge.progressGet(self.progress_id, self.profile)
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1116 if data:
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1117 try:
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1118 size = data['size']
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1119 except KeyError:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1120 self.disp(_("file size is not known, we can't show a progress bar"), 1,
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1121 error=True)
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1122 return False
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1123 if self.host.pbar is None:
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1124 #first answer, we must construct the bar
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1125
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1126 # if the instance has a pbar_template attribute, it is used has model,
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1127 # else default one is used
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1128 # template is a list of part, where part can be either a str to show directly
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1129 # or a list where first argument is a name of a progressbar widget, and others
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1130 # are used as widget arguments
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1131 try:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1132 template = self.pbar_template
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1133 except AttributeError:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1134 template = [
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1135 _("Progress: "), ["Percentage"], " ", ["Bar"], " ",
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1136 ["FileTransferSpeed"], " ", ["ETA"]
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1137 ]
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1138
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1139 widgets = []
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1140 for part in template:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1141 if isinstance(part, str):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1142 widgets.append(part)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1143 else:
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1144 widget = getattr(progressbar, part.pop(0))
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1145 widgets.append(widget(*part))
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1146
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1147 self.host.pbar = progressbar.ProgressBar(max_value=int(size), widgets=widgets)
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1148 self.host.pbar.start()
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1149
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1150 self.host.pbar.update(int(data['position']))
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1151
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1152 elif self.host.pbar is not None:
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1153 return False
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1154
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1155 await self.onProgressUpdate(data)
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1156
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1157 return True
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1158
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1159 async def onProgressStarted(self, metadata):
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1160 """Called when progress has just started
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1161
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1162 can be overidden by a command
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1163 @param metadata(dict): metadata as sent by bridge.progressStarted
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1164 """
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1165 self.disp(_("Operation started"), 2)
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1166
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1167 async def onProgressUpdate(self, metadata):
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1168 """Method called on each progress updata
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1169
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1170 can be overidden by a command to handle progress metadata
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1171 @para metadata(dict): metadata as returned by bridge.progressGet
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1172 """
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1173 pass
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1174
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1175 async def onProgressFinished(self, metadata):
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1176 """Called when progress has just finished
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1177
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1178 can be overidden by a command
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1179 @param metadata(dict): metadata as sent by bridge.progressFinished
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1180 """
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1181 self.disp(_("Operation successfully finished"), 2)
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1182
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1183 async def onProgressError(self, e):
1832
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1184 """Called when a progress failed
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1185
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1186 @param error_msg(unicode): error message as sent by bridge.progressError
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1187 """
3568
04283582966f core, frontends: fix invalid translatable strings.
Goffi <goffi@goffi.org>
parents: 3555
diff changeset
1188 self.disp(_("Error while doing operation: {e}").format(e=e), error=True)
1627
5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes.
Goffi <goffi@goffi.org>
parents: 1623
diff changeset
1189
3407
2f0be2b7de68 jp: replace `no_lf` argument by `end` in `disp` (same as in `print`)
Goffi <goffi@goffi.org>
parents: 3378
diff changeset
1190 def disp(self, msg, verbosity=0, error=False, end='\n'):
2f0be2b7de68 jp: replace `no_lf` argument by `end` in `disp` (same as in `print`)
Goffi <goffi@goffi.org>
parents: 3378
diff changeset
1191 return self.host.disp(msg, verbosity, error, end)
1605
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property
Goffi <goffi@goffi.org>
parents: 1604
diff changeset
1192
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1193 def output(self, data):
2193
33b82250eadd jp (base): raise InternalError if output is used when use_output is not declared
Goffi <goffi@goffi.org>
parents: 2189
diff changeset
1194 try:
33b82250eadd jp (base): raise InternalError if output is used when use_output is not declared
Goffi <goffi@goffi.org>
parents: 2189
diff changeset
1195 output_type = self._output_type
33b82250eadd jp (base): raise InternalError if output is used when use_output is not declared
Goffi <goffi@goffi.org>
parents: 2189
diff changeset
1196 except AttributeError:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1197 raise exceptions.InternalError(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1198 _('trying to use output when use_output has not been set'))
2193
33b82250eadd jp (base): raise InternalError if output is used when use_output is not declared
Goffi <goffi@goffi.org>
parents: 2189
diff changeset
1199 return self.host.output(output_type, self.args.output, self.extra_outputs, data)
1950
227a4e617549 jp: --output option:
Goffi <goffi@goffi.org>
parents: 1945
diff changeset
1200
3586
5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict
Goffi <goffi@goffi.org>
parents: 3568
diff changeset
1201 def getPubsubExtra(self, extra: Optional[dict] = None) -> str:
2761
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1202 """Helper method to compute extra data from pubsub arguments
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1203
3586
5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict
Goffi <goffi@goffi.org>
parents: 3568
diff changeset
1204 @param extra: base extra dict, or None to generate a new one
5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict
Goffi <goffi@goffi.org>
parents: 3568
diff changeset
1205 @return: dict which can be used directly in the bridge for pubsub
2761
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1206 """
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1207 if extra is None:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1208 extra = {}
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1209 else:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1210 intersection = {C.KEY_ORDER_BY}.intersection(list(extra.keys()))
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1211 if intersection:
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1212 raise exceptions.ConflictError(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1213 "given extra dict has conflicting keys with pubsub keys "
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1214 "{intersection}".format(intersection=intersection))
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1215
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1216 # RSM
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1217
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1218 for attribute in ('max', 'after', 'before', 'index'):
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1219 key = 'rsm_' + attribute
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1220 if key in extra:
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1221 raise exceptions.ConflictError(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1222 "This key already exists in extra: u{key}".format(key=key))
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1223 value = getattr(self.args, key, None)
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1224 if value is not None:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1225 extra[key] = str(value)
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1226
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1227 # MAM
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1228
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1229 if hasattr(self.args, 'mam_filters'):
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1230 for key, value in self.args.mam_filters:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1231 key = 'filter_' + key
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1232 if key in extra:
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1233 raise exceptions.ConflictError(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2910
diff changeset
1234 "This key already exists in extra: u{key}".format(key=key))
2764
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1235 extra[key] = value
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1236
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1237 # Order-By
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands:
Goffi <goffi@goffi.org>
parents: 2761
diff changeset
1238
2761
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1239 try:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1240 order_by = self.args.order_by
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1241 except AttributeError:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1242 pass
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1243 else:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1244 if order_by is not None:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1245 extra[C.KEY_ORDER_BY] = self.args.order_by
3600
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1246
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1247 # Cache
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1248 try:
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1249 use_cache = self.args.use_cache
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1250 except AttributeError:
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1251 pass
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1252 else:
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1253 if not use_cache:
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1254 extra[C.KEY_USE_CACHE] = use_cache
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option
Goffi <goffi@goffi.org>
parents: 3586
diff changeset
1255
3586
5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict
Goffi <goffi@goffi.org>
parents: 3568
diff changeset
1256 return data_format.serialise(extra)
2761
4b693ea24d5f jp (base, pubsub, ticket): handle order-by:
Goffi <goffi@goffi.org>
parents: 2706
diff changeset
1257
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1258 def add_parser_options(self):
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1259 try:
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1260 subcommands = self.subcommands
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1261 except AttributeError:
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1262 # We don't have subcommands, the class need to implements add_parser_options
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1263 raise NotImplementedError
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1264
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1265 # now we add subcommands to ourself
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1266 for cls in subcommands:
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1267 cls(self)
814
59c7bc51c323 jp: refactoring using ArgParse
Dal <kedals0@gmail.com>
parents: 811
diff changeset
1268
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1269 async def run(self):
1862
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1270 """this method is called when a command is actually run
1395
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
1271
1862
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1272 It set stuff like progression callbacks and profile connection
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1273 You should not overide this method: you should call self.start instead
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1274 """
2155
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
1275 # we keep a reference to run command, it may be useful e.g. for outputs
cee6561ad086 jp (core): added extra_outputs:
Goffi <goffi@goffi.org>
parents: 2151
diff changeset
1276 self.host.command = self
1863
b2ddd7f5dcdf jp (base): refactored need_loop so it is set only when the command is run. It can now be set in __init__ methods of commands classes
Goffi <goffi@goffi.org>
parents: 1862
diff changeset
1277
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1278 try:
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1279 show_progress = self.args.progress
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1280 except AttributeError:
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1281 # the command doesn't use progress bar
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1282 pass
1395
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node
Goffi <goffi@goffi.org>
parents: 1290
diff changeset
1283 else:
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1284 if show_progress:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1285 self.host.watch_progress = True
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1286 # we need to register the following signal even if we don't display the
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1287 # progress bar
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1288 self.host.bridge.register_signal(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1289 "progressStarted", self.progressStartedHandler)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1290 self.host.bridge.register_signal(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1291 "progressFinished", self.progressFinishedHandler)
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1292 self.host.bridge.register_signal(
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1293 "progressError", self.progressErrorHandler)
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1294
1862
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1295 if self.need_connect is not None:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1296 await self.host.connect_profile()
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1297 await self.start()
1862
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1298
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1299 async def start(self):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1300 """This is the starting point of the command, this method must be overriden
1862
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1301
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1302 at this point, profile are connected if needed
6d9c87bdc452 jp (base): added a CommandBase.start method which is called by run or connected, so subclasses can implement it (this is for simplicity sake, as it's not always clear if run or connected must be used)
Goffi <goffi@goffi.org>
parents: 1860
diff changeset
1303 """
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1304 raise NotImplementedError
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1305
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1306
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1307 class CommandAnswering(CommandBase):
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1308 """Specialised commands which answer to specific actions
817
c39117d00f35 jp: refactoring:
Goffi <goffi@goffi.org>
parents: 814
diff changeset
1309
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1310 to manage action_types answer,
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1311 """
2409
d2ff5ff3de77 jp (ad-hoc): new "list" and "run" commands:
Goffi <goffi@goffi.org>
parents: 2368
diff changeset
1312 action_callbacks = {} # XXX: set managed action types in a dict here:
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1313 # key is the action_type, value is the callable
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1314 # which will manage the answer. profile filtering is
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1315 # already managed when callback is called
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1316
2486
031aa3cc67ac jp (base): fixed assertion error when using CommandAnswering
Goffi <goffi@goffi.org>
parents: 2483
diff changeset
1317 def __init__(self, *args, **kwargs):
031aa3cc67ac jp (base): fixed assertion error when using CommandAnswering
Goffi <goffi@goffi.org>
parents: 2483
diff changeset
1318 super(CommandAnswering, self).__init__(*args, **kwargs)
031aa3cc67ac jp (base): fixed assertion error when using CommandAnswering
Goffi <goffi@goffi.org>
parents: 2483
diff changeset
1319
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1320 async def onActionNew(self, action_data, action_id, security_limit, profile):
538
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles
Goffi <goffi@goffi.org>
parents: 493
diff changeset
1321 if profile != self.profile:
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles
Goffi <goffi@goffi.org>
parents: 493
diff changeset
1322 return
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1323 try:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1324 action_type = action_data['meta_type']
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1325 except KeyError:
1840
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1326 try:
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1327 xml_ui = action_data["xmlui"]
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1328 except KeyError:
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1329 pass
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1330 else:
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1331 self.onXMLUI(xml_ui)
1606
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1332 else:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1333 try:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1334 callback = self.action_callbacks[action_type]
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1335 except KeyError:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API:
Goffi <goffi@goffi.org>
parents: 1605
diff changeset
1336 pass
0
goffi@necton2
parents:
diff changeset
1337 else:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1338 await callback(action_data, action_id, security_limit, profile)
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
1339
1840
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1340 def onXMLUI(self, xml_ui):
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1341 """Display a dialog received from the backend.
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1342
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1343 @param xml_ui (unicode): dialog XML representation
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1344 """
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1345 # FIXME: we temporarily use ElementTree, but a real XMLUI managing module
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1346 # should be available in the future
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1347 # TODO: XMLUI module
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1348 ui = ET.fromstring(xml_ui.encode('utf-8'))
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1349 dialog = ui.find("dialog")
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1350 if dialog is not None:
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1351 self.disp(dialog.findtext("message"), error=dialog.get("level") == "error")
9eabf7fadfdd frontends (jp): onActionNew displays xmlui message if no meta_type is defined and xmlui is defined
souliane <souliane@mailoo.org>
parents: 1832
diff changeset
1352
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1353 async def start_answering(self):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1354 """Auto reply to confirmation requests"""
2368
3865a772c360 jp (base): fixed CommandAnswering and progress bar
Goffi <goffi@goffi.org>
parents: 2313
diff changeset
1355 self.host.bridge.register_signal("actionNew", self.onActionNew)
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1356 actions = await self.host.bridge.actionsGet(self.profile)
1623
ec48b35309dc jp: use the new actionsGet method
Goffi <goffi@goffi.org>
parents: 1606
diff changeset
1357 for action_data, action_id, security_limit in actions:
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
1358 await self.onActionNew(action_data, action_id, security_limit, self.profile)