libervia-backend: sat_frontends/jp/base.py annotate

annotate sat_frontends/jp/base.py @ 3906:d8baf92cb921

cli (event): update commands following changes in events: - commands have been update to match changes in bridge method. - arguments have been completely reworked for `create` and `modify` commands, making it possible to fine tune events. - `list` has been removed in favor of `get` which can now display several events at once rel 372

author	Goffi <goffi@goffi.org>
date	Thu, 22 Sep 2022 00:01:48 +0200
parents	045af0eeda3f
children	6939594ba77e

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 c4bc297b82f0 sat: 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 c4bc297b82f0 sat: 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 c4bc297b82f0 sat: 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 c4bc297b82f0 sat: 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 c4bc297b82f0 sat: 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 c4bc297b82f0 sat: 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 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	26 ###
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	27
c4bc297b82f0 sat: 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
3866 915fb230cb28 cli (blog, pubsub): new `attachments` subcommands: Goffi <goffi@goffi.org> parents: 3834 diff changeset	37 from typing import Optional, Set
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 c4bc297b82f0 sat: 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 c4bc297b82f0 sat: 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 c4bc297b82f0 sat: 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):
3704 c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	124 # cf. https://unix.stackexchange.com/a/245568 (thanks!)
3046 d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	125 try:
3704 c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	126 # for VTE based terminals
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	127 vte_version = int(os.getenv("VTE_VERSION", 0))
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	128 except ValueError:
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	129 vte_version = 0
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	130
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	131 color_fg_bg = os.getenv("COLORFGBG")
3046 d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	132
3704 c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	133 if ((sys.stdin.isatty() and sys.stdout.isatty()
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	134 and (
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	135 # XTerm
3706 5131ed9163c0 cli (base): use `XTERM_VERSION` to detect XTerm: Goffi <goffi@goffi.org> parents: 3705 diff changeset	136 os.getenv("XTERM_VERSION")
3704 c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	137 # Konsole
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	138 or os.getenv("KONSOLE_VERSION")
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	139 # All VTE based terminals
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	140 or vte_version >= 3502
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	141 ))):
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	142 # ANSI escape sequence
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	143 stdin_fd = sys.stdin.fileno()
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	144 old_settings = termios.tcgetattr(stdin_fd)
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	145 try:
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	146 tty.setraw(sys.stdin.fileno())
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	147 # we request background color
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	148 sys.stdout.write("\033]11;?\a")
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	149 sys.stdout.flush()
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	150 expected = "\033]11;rgb:"
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	151 for c in expected:
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	152 ch = sys.stdin.read(1)
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	153 if ch != c:
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	154 # background id is not supported, we default to "dark"
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	155 # TODO: log something?
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	156 return 'dark'
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	157 red, green, blue = [
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	158 int(c, 16)/65535 for c in sys.stdin.read(14).split('/')
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	159 ]
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	160 # '\a' is the last character
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	161 sys.stdin.read(1)
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	162 finally:
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	163 termios.tcsetattr(stdin_fd, termios.TCSADRAIN, old_settings)
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	164
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	165 lum = utils.per_luminance(red, green, blue)
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	166 if lum <= 0.5:
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	167 return 'dark'
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	168 else:
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	169 return 'light'
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	170 elif color_fg_bg:
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	171 # no luck with ANSI escape sequence, we try COLORFGBG environment variable
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	172 try:
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	173 bg = int(color_fg_bg.split(";")[-1])
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	174 except ValueError:
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	175 return "dark"
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	176 if bg in list(range(7)) + [8]:
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	177 return "dark"
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	178 else:
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	179 return "light"
3046 d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	180 else:
3704 c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	181 # no autodetection method found
c143e7f35074 cli (base): better background detection: Goffi <goffi@goffi.org> parents: 3636 diff changeset	182 return "dark"
3046 d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	183
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	184 def set_color_theme(self):
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	185 background = self.get_config('background', default='auto')
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	186 if background == 'auto':
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	187 background = self.guess_background()
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	188 if background not in ('dark', 'light'):
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	189 raise exceptions.ConfigError(_(
3568 04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	190 'Invalid value set for "background" ({background}), please check '
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	191 'your settings in libervia.conf').format(
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	192 background=repr(background)
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	193 ))
3705 691dbd78981c cli (debug/theme): display currently used background Goffi <goffi@goffi.org> parents: 3704 diff changeset	194 self.background = background
3046 d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	195 if background == 'light':
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	196 C.A_HEADER = A.FG_MAGENTA
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	197 C.A_SUBHEADER = A.BOLD + A.FG_RED
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	198 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	199 C.A_SUCCESS = A.FG_GREEN
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	200 C.A_FAILURE = A.BOLD + A.FG_RED
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	201 C.A_WARNING = A.FG_RED
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	202 C.A_PROMPT_PATH = A.FG_BLUE
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	203 C.A_PROMPT_SUF = A.BOLD
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	204 C.A_DIRECTORY = A.BOLD + A.FG_MAGENTA
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	205 C.A_FILE = A.FG_BLACK
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	206
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	207 def _bridgeConnected(self):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	208 self.parser = argparse.ArgumentParser(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	209 formatter_class=argparse.RawDescriptionHelpFormatter, description=DESCRIPTION)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	210 self._make_parents()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	211 self.add_parser_options()
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	212 self.subparsers = self.parser.add_subparsers(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	213 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	214
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	215 # progress attributes
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	216 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	217 self.quit_on_progress_end = True
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	218
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	219 # outputs
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	220 self._outputs = {}
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	221 for type_ in C.OUTPUT_TYPES:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	222 self._outputs[type_] = OrderedDict()
2189 a25a256688e2 jp (base): output can now specify a default when registering Goffi <goffi@goffi.org> parents: 2188 diff changeset	223 self.default_output = {}
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	224
2705 0bb811aaf11d jp (base): new own_jid host attribute: Goffi <goffi@goffi.org> parents: 2704 diff changeset	225 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	226
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	227 @property
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	228 def progress_id(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	229 return self._progress_id
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	230
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	231 async def set_progress_id(self, progress_id):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	232 # because we use async, we need an explicit setter
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	233 self._progress_id = progress_id
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	234 await self.replayCache('progress_ids_cache')
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	235
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	236 @property
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	237 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	238 try:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	239 self.pbar
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	240 except AttributeError:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	241 return False
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	242 else:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	243 return True
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	244
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	245 @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	246 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	247 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	248 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	249
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	250 @property
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	251 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	252 try:
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	253 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	254 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	255 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	256
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	257 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	258 """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	259
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	260 @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	261 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	262 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	263 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	264 """
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	265 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	266 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	267 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	268 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	269 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	270 for cache_data in cache:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	271 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	272
3407 2f0be2b7de68 jp: replace `no_lf` argument by `end` in `disp` (same as in `print`) Goffi <goffi@goffi.org> parents: 3378 diff changeset	273 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	274 """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	275
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	276 @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	277 @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	278 @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	279 @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	280 """
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	281 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	282 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	283 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	284 else:
3407 2f0be2b7de68 jp: replace `no_lf` argument by `end` in `disp` (same as in `print`) Goffi <goffi@goffi.org> parents: 3378 diff changeset	285 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	286
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	287 async def output(self, type_, name, extra_outputs, data):
2155 cee6561ad086 jp (core): added extra_outputs: Goffi <goffi@goffi.org> parents: 2151 diff changeset	288 if name in extra_outputs:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	289 method = extra_outputs[name]
2155 cee6561ad086 jp (core): added extra_outputs: Goffi <goffi@goffi.org> parents: 2151 diff changeset	290 else:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	291 method = self._outputs[type_][name]['callback']
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	292
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	293 ret = method(data)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	294 if inspect.isawaitable(ret):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	295 await ret
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	296
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	297 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	298 """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	299
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	300 @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	301 """
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	302 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	303
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	304 def getOutputChoices(self, output_type):
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	305 """Return valid output filters for output_type
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	306
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	307 @param output_type: True for default,
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	308 else can be any registered type
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	309 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	310 return list(self._outputs[output_type].keys())
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	311
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	312 def _make_parents(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	313 self.parents = {}
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	314
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	315 # 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	316 # 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	317 # 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	318 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	319 parent = self.parents[parent_name] = argparse.ArgumentParser(add_help=False)
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	320 parent.add_argument(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	321 "-p", "--profile", action="store", type=str, default='@DEFAULT@',
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	322 help=_("Use PROFILE profile key (default: %(default)s)"))
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	323 parent.add_argument(
3049 9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	324 "--pwd", action="store", metavar='PASSWORD',
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	325 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	326
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	327 profile_parent, profile_session_parent = (self.parents['profile'],
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	328 self.parents['profile_session'])
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	329
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	330 connect_short, connect_long, connect_action, connect_help = (
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	331 "-c", "--connect", "store_true",
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	332 _("Connect the profile before doing anything else")
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	333 )
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	334 profile_parent.add_argument(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	335 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	336
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	337 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	338 profile_session_connect_group.add_argument(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	339 connect_short, connect_long, action=connect_action, help=connect_help)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	340 profile_session_connect_group.add_argument(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	341 "--start-session", action="store_true",
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	342 help=_("Start a profile session without connecting"))
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	343
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	344 progress_parent = self.parents['progress'] = argparse.ArgumentParser(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	345 add_help=False)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	346 if progressbar:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	347 progress_parent.add_argument(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	348 "-P", "--progress", action="store_true", help=_("Show progress bar"))
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	349
1600 8d41cd4da2f6 jp: added a --verbose command Goffi <goffi@goffi.org> parents: 1594 diff changeset	350 verbose_parent = self.parents['verbose'] = argparse.ArgumentParser(add_help=False)
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	351 verbose_parent.add_argument(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	352 '--verbose', '-v', action='count', default=0,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	353 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	354
3412 7b4ae3dbc041 jp (base, pubsub/set): new `--quiet` argument: Goffi <goffi@goffi.org> parents: 3409 diff changeset	355 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	356 quiet_parent.add_argument(
7b4ae3dbc041 jp (base, pubsub/set): new `--quiet` argument: Goffi <goffi@goffi.org> parents: 3409 diff changeset	357 '--quiet', '-q', action='store_true',
7b4ae3dbc041 jp (base, pubsub/set): new `--quiet` argument: Goffi <goffi@goffi.org> parents: 3409 diff changeset	358 help=_("be quiet (only output machine readable data)"))
7b4ae3dbc041 jp (base, pubsub/set): new `--quiet` argument: Goffi <goffi@goffi.org> parents: 3409 diff changeset	359
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	360 draft_parent = self.parents['draft'] = argparse.ArgumentParser(add_help=False)
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	361 draft_group = draft_parent.add_argument_group(_('draft handling'))
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	362 draft_group.add_argument(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	363 "-D", "--current", action="store_true", help=_("load current draft"))
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	364 draft_group.add_argument(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	365 "-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	366
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	367
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	368 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	369 """Generate pubsub options according to flags
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	370
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	371 @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	372 @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	373 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	374 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	375 @return (ArgumentParser): parser to add
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	376 """
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	377 flags = misc.FlagsHandler(flags)
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	378 parent = argparse.ArgumentParser(add_help=False)
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	379 pubsub_group = parent.add_argument_group('pubsub')
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	380 pubsub_group.add_argument("-u", "--pubsub-url",
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	381 help=_("Pubsub URL (xmpp or http)"))
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	382
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	383 service_help = _("JID of the PubSub service")
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	384 if not flags.service:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	385 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	386 if default is not None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	387 service_help += _(" (DEFAULT: {default})".format(default=default))
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	388 pubsub_group.add_argument("-s", "--service", default='',
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	389 help=service_help)
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	390
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	391 node_help = _("node to request")
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	392 if not flags.node:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	393 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	394 if default is not None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	395 node_help += _(" (DEFAULT: {default})".format(default=default))
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	396 pubsub_group.add_argument("-n", "--node", default='', help=node_help)
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	397
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	398 if flags.single_item:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	399 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	400 if not flags.item:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	401 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	402 if default is not None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	403 item_help += _(" (DEFAULT: {default})".format(default=default))
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	404 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	405 help=item_help)
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	406 pubsub_group.add_argument(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	407 "-L", "--last-item", action='store_true', help=_('retrieve last item'))
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	408 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	409 # 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	410 # and Orbder-by
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	411 pubsub_group.add_argument(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	412 "-i", "--item", action='append', dest='items', default=[],
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	413 help=_("items to retrieve (DEFAULT: all)"))
2539 dcc77f23e370 jp (base): add --max option: Goffi <goffi@goffi.org> parents: 2538 diff changeset	414 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	415 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	416 # 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	417 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	418 "-M", "--max-items", dest="max", type=int,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	419 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	420 .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	421 # 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	422 # 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	423 # 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	424 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	425 "-m", "--max", dest="rsm_max", type=int,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	426 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	427
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	428 # RSM
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	429
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	430 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	431 rsm_page_group.add_argument(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	432 "-a", "--after", dest="rsm_after",
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	433 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	434 rsm_page_group.add_argument(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	435 "-b", "--before", dest="rsm_before",
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	436 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	437 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	438 "--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	439 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	440
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	441
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	442 # MAM
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	443
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	444 pubsub_group.add_argument(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	445 "-f", "--filter", dest='mam_filters', nargs=2,
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	446 action='append', default=[], help=_("MAM filters to use"),
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	447 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	448 )
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	449
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	450 # Order-By
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	451
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	452 # 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	453 # 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	454 # 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	455 # available)
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	456 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	457 "-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	458 C.ORDER_BY_MODIFICATION],
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	459 help=_("how items should be ordered"))
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	460
3600 1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option Goffi <goffi@goffi.org> parents: 3586 diff changeset	461 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	462 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	463 "-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	464 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	465 )
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option Goffi <goffi@goffi.org> parents: 3586 diff changeset	466
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	467 if not flags.all_used:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	468 raise exceptions.InternalError('unknown flags: {flags}'.format(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	469 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	470 if defaults:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	471 raise exceptions.InternalError(f'unused defaults: {defaults}')
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	472
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	473 return parent
2235 4db836386641 jp: added use_pubsub and use_pubsub_node_req arguments to CommandBase Goffi <goffi@goffi.org> parents: 2213 diff changeset	474
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	475 def add_parser_options(self):
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	476 self.parser.add_argument(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	477 '--version',
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	478 action='version',
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	479 version=("{name} {version} {copyleft}".format(
3555 53fec6309fa3 cli: update constants to use new name Goffi <goffi@goffi.org> parents: 3547 diff changeset	480 name = C.APP_NAME,
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	481 version = self.version,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	482 copyleft = COPYLEFT))
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	483 )
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	484
2189 a25a256688e2 jp (base): output can now specify a default when registering Goffi <goffi@goffi.org> parents: 2188 diff changeset	485 def register_output(self, type_, name, callback, description="", default=False):
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	486 if type_ not in C.OUTPUT_TYPES:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	487 log.error("Invalid output type {}".format(type_))
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	488 return
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	489 self._outputs[type_][name] = {'callback': callback,
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	490 'description': description
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	491 }
2189 a25a256688e2 jp (base): output can now specify a default when registering Goffi <goffi@goffi.org> parents: 2188 diff changeset	492 if default:
a25a256688e2 jp (base): output can now specify a default when registering Goffi <goffi@goffi.org> parents: 2188 diff changeset	493 if type_ in self.default_output:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	494 self.disp(
3568 04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	495 _('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	496 .format(type=type_)
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	497 )
2189 a25a256688e2 jp (base): output can now specify a default when registering Goffi <goffi@goffi.org> parents: 2188 diff changeset	498 else:
a25a256688e2 jp (base): output can now specify a default when registering Goffi <goffi@goffi.org> parents: 2188 diff changeset	499 self.default_output[type_] = name
a25a256688e2 jp (base): output can now specify a default when registering Goffi <goffi@goffi.org> parents: 2188 diff changeset	500
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	501
2187 4ec72927a222 jp (outputs): moved output options parsing and checking to base methods Goffi <goffi@goffi.org> parents: 2178 diff changeset	502 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	503 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	504 options_dict = {}
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods Goffi <goffi@goffi.org> parents: 2178 diff changeset	505 for option in options:
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods Goffi <goffi@goffi.org> parents: 2178 diff changeset	506 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	507 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	508 except ValueError:
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods Goffi <goffi@goffi.org> parents: 2178 diff changeset	509 key, value = option, None
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods Goffi <goffi@goffi.org> parents: 2178 diff changeset	510 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	511 return options_dict
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods Goffi <goffi@goffi.org> parents: 2178 diff changeset	512
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods Goffi <goffi@goffi.org> parents: 2178 diff changeset	513 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	514 if not accepted_set.issuperset(options):
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	515 self.disp(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	516 _("The following output options are invalid: {invalid_options}").format(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	517 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	518 error=True)
4ec72927a222 jp (outputs): moved output options parsing and checking to base methods Goffi <goffi@goffi.org> parents: 2178 diff changeset	519 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	520
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	521 def import_plugins(self):
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	522 """Automaticaly import commands and outputs in jp
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	523
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	524 looks from modules names cmd_*.py in jp path and import them
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	525 """
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	526 path = os.path.dirname(sat_frontends.jp.__file__)
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	527 # 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	528 for type_, pattern in ((C.PLUGIN_OUTPUT, 'output_*.py'),
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	529 (C.PLUGIN_CMD, 'cmd_*.py')):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	530 modules = (
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	531 os.path.splitext(module)[0]
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	532 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	533 for module_name in modules:
2162 c9a67eb5bf72 jp (base): improved module import: Goffi <goffi@goffi.org> parents: 2161 diff changeset	534 module_path = "sat_frontends.jp." + module_name
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	535 try:
2162 c9a67eb5bf72 jp (base): improved module import: Goffi <goffi@goffi.org> parents: 2161 diff changeset	536 module = import_module(module_path)
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	537 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	538 except ImportError as e:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	539 self.disp(
3568 04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	540 _("Can't import {module_path} plugin, ignoring it: {e}")
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	541 .format(module_path=module_path, e=e),
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	542 error=True)
2162 c9a67eb5bf72 jp (base): improved module import: Goffi <goffi@goffi.org> parents: 2161 diff changeset	543 except exceptions.CancelError:
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	544 continue
2162 c9a67eb5bf72 jp (base): improved module import: Goffi <goffi@goffi.org> parents: 2161 diff changeset	545 except exceptions.MissingModule as e:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	546 self.disp(_("Missing module for plugin {name}: {missing}".format(
2162 c9a67eb5bf72 jp (base): improved module import: Goffi <goffi@goffi.org> parents: 2161 diff changeset	547 name = module_path,
2188 052d560d0dce jp (base): replaced log.warning by stderr prints Goffi <goffi@goffi.org> parents: 2187 diff changeset	548 missing = e)), error=True)
2162 c9a67eb5bf72 jp (base): improved module import: Goffi <goffi@goffi.org> parents: 2161 diff changeset	549
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	550
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	551 def import_plugin_module(self, module, type_):
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	552 """add commands or outpus from a module to jp
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	553
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	554 @param module: module containing commands or outputs
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	555 @param type_(str): one of C_PLUGIN_*
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	556 """
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	557 try:
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	558 class_names = getattr(module, '__{}__'.format(type_))
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	559 except AttributeError:
3568 04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	560 log.disp(
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	561 _("Invalid plugin module [{type}] {module}")
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	562 .format(type=type_, module=module),
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	563 error=True)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	564 raise ImportError
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	565 else:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	566 for class_name in class_names:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	567 cls = getattr(module, class_name)
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	568 cls(self)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	569
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	570 def get_xmpp_uri_from_http(self, http_url):
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	571 """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	572 if http_url.startswith('https'):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	573 scheme = 'https'
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	574 elif http_url.startswith('http'):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	575 scheme = 'http'
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	576 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	577 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	578 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	579 # HTTP URL, we try to find xmpp: links
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	580 try:
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	581 from lxml import etree
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	582 except ImportError:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	583 self.disp(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	584 "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	585 "with \"pip install lxml\"",
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	586 error=True)
2672 0bed6df9ee5d jp: fixed bad call to quit Goffi <goffi@goffi.org> parents: 2671 diff changeset	587 self.quit(1)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	588 import urllib.request, urllib.error, urllib.parse
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	589 parser = etree.HTMLParser()
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	590 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	591 root = etree.parse(urllib.request.urlopen(http_url), parser)
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	592 except etree.XMLSyntaxError as e:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	593 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	594 links = []
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	595 else:
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	596 links = root.xpath("//link[@rel='alternate' and starts-with(@href, 'xmpp:')]")
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	597 if not links:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	598 self.disp(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	599 _('Could not find alternate "xmpp:" URI, can\'t find associated XMPP '
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	600 'PubSub node/item'),
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	601 error=True)
2672 0bed6df9ee5d jp: fixed bad call to quit Goffi <goffi@goffi.org> parents: 2671 diff changeset	602 self.quit(1)
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	603 xmpp_uri = links[0].get('href')
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	604 return xmpp_uri
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	605
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	606 def parse_pubsub_args(self):
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	607 if self.args.pubsub_url is not None:
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	608 url = self.args.pubsub_url
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	609
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	610 if url.startswith('http'):
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	611 # http(s) URL, we try to retrieve xmpp one from there
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	612 url = self.get_xmpp_uri_from_http(url)
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	613
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	614 try:
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	615 uri_data = uri.parseXMPPUri(url)
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	616 except ValueError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	617 self.parser.error(_('invalid XMPP URL: {url}').format(url=url))
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	618 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	619 if uri_data['type'] == 'pubsub':
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	620 # 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	621 if not self.args.service:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	622 self.args.service = uri_data['path']
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	623 if not self.args.node:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	624 self.args.node = uri_data['node']
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	625 uri_item = uri_data.get('item')
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	626 if uri_item:
2556 340128e0b354 jp (base): fixed URI's item with use_pubsub Goffi <goffi@goffi.org> parents: 2552 diff changeset	627 # there is an item in URI
340128e0b354 jp (base): fixed URI's item with use_pubsub Goffi <goffi@goffi.org> parents: 2552 diff changeset	628 # 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	629 # and item_last is not used either
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	630 try:
2556 340128e0b354 jp (base): fixed URI's item with use_pubsub Goffi <goffi@goffi.org> parents: 2552 diff changeset	631 item = self.args.item
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	632 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	633 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	634 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	635 except AttributeError:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	636 self.disp(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	637 _("item specified in URL but not needed in command, "
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	638 "ignoring it"),
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	639 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	640 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	641 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	642 self.args.items = [uri_item]
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	643 else:
2556 340128e0b354 jp (base): fixed URI's item with use_pubsub Goffi <goffi@goffi.org> parents: 2552 diff changeset	644 if not item:
340128e0b354 jp (base): fixed URI's item with use_pubsub Goffi <goffi@goffi.org> parents: 2552 diff changeset	645 try:
340128e0b354 jp (base): fixed URI's item with use_pubsub Goffi <goffi@goffi.org> parents: 2552 diff changeset	646 item_last = self.args.item_last
340128e0b354 jp (base): fixed URI's item with use_pubsub Goffi <goffi@goffi.org> parents: 2552 diff changeset	647 except AttributeError:
340128e0b354 jp (base): fixed URI's item with use_pubsub Goffi <goffi@goffi.org> parents: 2552 diff changeset	648 item_last = False
340128e0b354 jp (base): fixed URI's item with use_pubsub Goffi <goffi@goffi.org> parents: 2552 diff changeset	649 if not item_last:
340128e0b354 jp (base): fixed URI's item with use_pubsub Goffi <goffi@goffi.org> parents: 2552 diff changeset	650 self.args.item = uri_item
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	651 else:
3568 04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	652 self.parser.error(
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	653 _('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	654 )
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	655 flags = self.args._cmd._pubsub_flags
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	656 # 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	657 # because the required argument can be set in URL
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	658 if C.SERVICE in flags and not self.args.service:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	659 self.parser.error(_("argument -s/--service is required"))
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	660 if C.NODE in flags and not self.args.node:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	661 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	662 if C.ITEM in flags and not self.args.item:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	663 self.parser.error(_("argument -i/--item is required"))
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	664
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	665 # 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	666 # 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	667 try:
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	668 if self.args.item and self.args.item_last:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	669 self.parser.error(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	670 _("--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	671 except AttributeError:
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	672 pass
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	673
2775 2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub Goffi <goffi@goffi.org> parents: 2771 diff changeset	674 try:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub Goffi <goffi@goffi.org> parents: 2771 diff changeset	675 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	676 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	677 except AttributeError:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub Goffi <goffi@goffi.org> parents: 2771 diff changeset	678 pass
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub Goffi <goffi@goffi.org> parents: 2771 diff changeset	679 else:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub Goffi <goffi@goffi.org> parents: 2771 diff changeset	680 # 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	681 # 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	682 # 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	683 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	684 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	685 'rsm_index')
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub Goffi <goffi@goffi.org> parents: 2771 diff changeset	686 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	687 # 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	688 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	689 else:
2dfd5b1d39df jp (base): fixed default values for --max-items and --max when using pubsub Goffi <goffi@goffi.org> parents: 2771 diff changeset	690 # 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	691 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	692 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	693 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	694
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	695 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	696 try:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	697 await self.bridge.bridgeConnect()
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	698 except Exception as e:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	699 if isinstance(e, exceptions.BridgeExceptionNoService):
3834 3260401fdb98 cli: helper method to retrieve profile's jid: Goffi <goffi@goffi.org> parents: 3765 diff changeset	700 print(
3260401fdb98 cli: helper method to retrieve profile's jid: Goffi <goffi@goffi.org> parents: 3765 diff changeset	701 _("Can't connect to Libervia backend, are you sure that it's "
3260401fdb98 cli: helper method to retrieve profile's jid: Goffi <goffi@goffi.org> parents: 3765 diff changeset	702 "launched ?")
3260401fdb98 cli: helper method to retrieve profile's jid: Goffi <goffi@goffi.org> parents: 3765 diff changeset	703 )
3490 509f7a1c67dc frontends: use new EXIT_BACKEND_NOT_FOUND exit code: Goffi <goffi@goffi.org> parents: 3486 diff changeset	704 self.quit(C.EXIT_BACKEND_NOT_FOUND, raise_exc=False)
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	705 elif isinstance(e, exceptions.BridgeInitError):
3568 04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	706 print(_("Can't init bridge"))
3490 509f7a1c67dc frontends: use new EXIT_BACKEND_NOT_FOUND exit code: Goffi <goffi@goffi.org> parents: 3486 diff changeset	707 self.quit(C.EXIT_BRIDGE_ERROR, raise_exc=False)
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	708 else:
3568 04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	709 print(
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	710 _("Error while initialising bridge: {e}").format(e=e)
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	711 )
3490 509f7a1c67dc frontends: use new EXIT_BACKEND_NOT_FOUND exit code: Goffi <goffi@goffi.org> parents: 3486 diff changeset	712 self.quit(C.EXIT_BRIDGE_ERROR, raise_exc=False)
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	713 return
3636 43542cf32e5a cli: call `bridge.getReady()` after bridge connection Goffi <goffi@goffi.org> parents: 3568 diff changeset	714 await self.bridge.getReady()
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	715 self.version = await self.bridge.getVersion()
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	716 self._bridgeConnected()
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	717 self.import_plugins()
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	718 try:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	719 self.args = self.parser.parse_args(args, namespace=None)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	720 if self.args._cmd._use_pubsub:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	721 self.parse_pubsub_args()
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	722 await self.args._cmd.run()
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	723 except SystemExit as e:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	724 self.quit(e.code, raise_exc=False)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	725 return
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	726 except QuitException:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	727 return
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	728
3481 7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers: Goffi <goffi@goffi.org> parents: 3479 diff changeset	729 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	730 self.loop = JPLoop()
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	731 self.loop.run(self, args, namespace)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	732
3481 7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers: Goffi <goffi@goffi.org> parents: 3479 diff changeset	733 @classmethod
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers: Goffi <goffi@goffi.org> parents: 3479 diff changeset	734 def run(cls):
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers: Goffi <goffi@goffi.org> parents: 3479 diff changeset	735 cls()._run()
7892585b7e17 core (setup), jp, primitivus: update console scripts + classifiers: Goffi <goffi@goffi.org> parents: 3479 diff changeset	736
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	737 def _read_stdin(self, stdin_fut):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	738 """Callback called by ainput to read stdin"""
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	739 line = sys.stdin.readline()
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	740 if line:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	741 stdin_fut.set_result(line.rstrip(os.linesep))
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	742 else:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	743 stdin_fut.set_exception(EOFError())
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	744
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	745 async def ainput(self, msg=''):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	746 """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	747 self.disp(msg, end=' ')
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	748 sys.stdout.flush()
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	749 loop = asyncio.get_running_loop()
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	750 stdin_fut = loop.create_future()
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	751 loop.add_reader(sys.stdin, self._read_stdin, stdin_fut)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	752 return await stdin_fut
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	753
3409 4ca5bc6b44b6 jp: new `confirm` method: Goffi <goffi@goffi.org> parents: 3408 diff changeset	754 async def confirm(self, message):
4ca5bc6b44b6 jp: new `confirm` method: Goffi <goffi@goffi.org> parents: 3408 diff changeset	755 """Request user to confirm action, return answer as boolean"""
4ca5bc6b44b6 jp: new `confirm` method: Goffi <goffi@goffi.org> parents: 3408 diff changeset	756 res = await self.ainput(f"{message} (y/N)? ")
4ca5bc6b44b6 jp: new `confirm` method: Goffi <goffi@goffi.org> parents: 3408 diff changeset	757 return res in ("y", "Y")
4ca5bc6b44b6 jp: new `confirm` method: Goffi <goffi@goffi.org> parents: 3408 diff changeset	758
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	759 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	760 """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	761 confirmed = await self.confirm(message)
4ca5bc6b44b6 jp: new `confirm` method: Goffi <goffi@goffi.org> parents: 3408 diff changeset	762 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	763 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	764 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	765
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	766 def quitFromSignal(self, exit_code=0):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	767 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	768
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	769 /!\: 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	770 """
1918 01d56efd488b jp: fixed traceback shown on a normal quit when a progression is finished Goffi <goffi@goffi.org> parents: 1884 diff changeset	771 # 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	772 # so we use this little timeout trick to avoid it
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	773 self.loop.call_later(0, self.quit, exit_code)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	774
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	775 def quit(self, exit_code=0, raise_exc=True):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	776 """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	777
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	778 This will stop the loop.
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	779 @param exit_code(int): code to return when quitting the program
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	780 @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	781 The default value should be used most of time.
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	782 """
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	783 # 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	784 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	785 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	786 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	787 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	788 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	789 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	790 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	791
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	792 self.loop.quit(exit_code)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	793 if raise_exc:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	794 raise QuitException
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	795
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	796 async def check_jids(self, jids):
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	797 """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	798
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	799 @param profile: profile name
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	800 @param jids: list of jids
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	801 @return: List of jids
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	802
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	803 """
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	804 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	805 nodes2jid = {}
393 393b35aa86d2 jp: added --connect option Goffi <goffi@goffi.org> parents: 391 diff changeset	806
3765 ea204216a505 CLI: don't fail when calling `getContacts` with a component profile Goffi <goffi@goffi.org> parents: 3709 diff changeset	807 try:
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile Goffi <goffi@goffi.org> parents: 3709 diff changeset	808 contacts = await self.bridge.getContacts(self.profile)
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile Goffi <goffi@goffi.org> parents: 3709 diff changeset	809 except BridgeException as e:
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile Goffi <goffi@goffi.org> parents: 3709 diff changeset	810 if e.classname == "AttributeError":
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile Goffi <goffi@goffi.org> parents: 3709 diff changeset	811 # we may get an AttributeError if we use a component profile
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile Goffi <goffi@goffi.org> parents: 3709 diff changeset	812 # as components don't have roster
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile Goffi <goffi@goffi.org> parents: 3709 diff changeset	813 contacts = []
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile Goffi <goffi@goffi.org> parents: 3709 diff changeset	814 else:
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile Goffi <goffi@goffi.org> parents: 3709 diff changeset	815 raise e
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile Goffi <goffi@goffi.org> parents: 3709 diff changeset	816
ea204216a505 CLI: don't fail when calling `getContacts` with a component profile Goffi <goffi@goffi.org> parents: 3709 diff changeset	817 for contact in contacts:
1395 1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node Goffi <goffi@goffi.org> parents: 1290 diff changeset	818 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	819 _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	820 try:
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node Goffi <goffi@goffi.org> parents: 1290 diff changeset	821 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	822 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	823 pass
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node Goffi <goffi@goffi.org> parents: 1290 diff changeset	824
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node Goffi <goffi@goffi.org> parents: 1290 diff changeset	825 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	826 nodes2jid[_jid.node.lower()] = jid_s
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	827
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	828 def expand_jid(jid):
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	829 _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	830 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	831 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	832 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	833 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	834 else:
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid Goffi <goffi@goffi.org> parents: 480 diff changeset	835 expanded = jid
2588 4011e4ee3151 jp (base): fixed jid encoding Goffi <goffi@goffi.org> parents: 2562 diff changeset	836 return expanded
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	837
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	838 def check(jid):
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	839 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	840 log.error (_("%s is not a valid JID !"), jid)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	841 self.quit(1)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	842
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	843 dest_jids=[]
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	844 try:
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	845 for i in range(len(jids)):
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	846 dest_jids.append(expand_jid(jids[i]))
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	847 check(dest_jids[i])
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	848 except AttributeError:
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	849 pass
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	850
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	851 return dest_jids
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	852
3049 9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	853 async def a_pwd_input(self, msg=''):
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	854 """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	855 # 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	856 # 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	857 # 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	858 # 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	859 stdin_fd = sys.stdin.fileno()
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	860 old = termios.tcgetattr(sys.stdin)
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	861 new = old[:]
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	862 new[3] &= ~termios.ECHO
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	863 tcsetattr_flags = termios.TCSAFLUSH
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	864 if hasattr(termios, 'TCSASOFT'):
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	865 tcsetattr_flags \|= termios.TCSASOFT
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	866 try:
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	867 termios.tcsetattr(stdin_fd, tcsetattr_flags, new)
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	868 pwd = await self.ainput(msg=msg)
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	869 finally:
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	870 termios.tcsetattr(stdin_fd, tcsetattr_flags, old)
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	871 sys.stderr.flush()
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	872 self.disp('')
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	873 return pwd
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	874
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	875 async def connectOrPrompt(self, method, err_msg=None):
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	876 """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	877
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	878 @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	879 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	880 properly
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	881 @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	882 """
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	883 password = self.args.pwd
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	884 while True:
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	885 try:
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	886 await method(password or '')
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	887 except Exception as e:
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	888 if ((isinstance(e, BridgeException)
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	889 and e.classname == 'PasswordError'
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	890 and self.args.pwd is None)):
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	891 if password is not None:
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	892 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	893 password = await self.a_pwd_input(
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	894 _("please enter profile password:"))
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	895 else:
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	896 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	897 self.quit(C.EXIT_ERROR)
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	898 else:
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	899 break
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	900
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	901 async def connect_profile(self):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	902 """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	903
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	904 @exit: - 1 when profile is not connected and --connect is not set
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	905 - 1 when the profile doesn't exists
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	906 - 1 when there is a connection error
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	907 """
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	908 # FIXME: need better exit codes
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	909
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	910 self.profile = await self.bridge.profileNameGet(self.args.profile)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	911
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	912 if not self.profile:
3568 04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	913 log.error(
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	914 _("The profile [{profile}] doesn't exist")
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	915 .format(profile=self.args.profile)
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	916 )
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	917 self.quit(C.EXIT_ERROR)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	918
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	919 try:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	920 start_session = self.args.start_session
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	921 except AttributeError:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	922 pass
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	923 else:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	924 if start_session:
3049 9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	925 await self.connectOrPrompt(
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	926 lambda pwd: self.bridge.profileStartSession(pwd, self.profile),
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	927 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	928 )
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	929 return
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	930 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	931 if not self.args.connect:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	932 self.disp(_(
3568 04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	933 "Session for [{profile}] is not started, please start it "
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	934 "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	935 "option"
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	936 .format(profile=self.profile)
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	937 ), error=True)
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	938 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	939 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	940 return
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	941
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	942
1401 265ff2bd8d67 jp: fixed crash on commands using profile without "connect" option Goffi <goffi@goffi.org> parents: 1396 diff changeset	943 if not hasattr(self.args, 'connect'):
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	944 # 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	945 # creation/deletion)
1401 265ff2bd8d67 jp: fixed crash on commands using profile without "connect" option Goffi <goffi@goffi.org> parents: 1396 diff changeset	946 return
1588 823a385235ef jp: fixed bad --connect option check Goffi <goffi@goffi.org> parents: 1544 diff changeset	947 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	948 await self.connectOrPrompt(
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	949 lambda pwd: self.bridge.connect(self.profile, pwd, {}),
9839ce068140 jp: password is now prompted if needed: Goffi <goffi@goffi.org> parents: 3046 diff changeset	950 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	951 )
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	952 return
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	953 else:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	954 if not await self.bridge.isConnected(self.profile):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	955 log.error(
3568 04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	956 _("Profile [{profile}] is not connected, please connect it "
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	957 "before using jp, or use --connect option")
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	958 .format(profile=self.profile)
04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	959 )
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	960 self.quit(1)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	961
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	962 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	963 """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	964 # 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	965 # as backend now handle jingles message initiation
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	966 _jid = JID(param_jid)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	967 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	968 #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	969 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	970 if main_resource:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	971 return f"{_jid.bare}/{main_resource}"
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	972 return param_jid
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	973
3834 3260401fdb98 cli: helper method to retrieve profile's jid: Goffi <goffi@goffi.org> parents: 3765 diff changeset	974 async def get_profile_jid(self):
3260401fdb98 cli: helper method to retrieve profile's jid: Goffi <goffi@goffi.org> parents: 3765 diff changeset	975 """Retrieve current profile bare JID if possible"""
3260401fdb98 cli: helper method to retrieve profile's jid: Goffi <goffi@goffi.org> parents: 3765 diff changeset	976 full_jid = await self.bridge.asyncGetParamA(
3260401fdb98 cli: helper method to retrieve profile's jid: Goffi <goffi@goffi.org> parents: 3765 diff changeset	977 "JabberID", "Connection", profile_key=self.profile
3260401fdb98 cli: helper method to retrieve profile's jid: Goffi <goffi@goffi.org> parents: 3765 diff changeset	978 )
3260401fdb98 cli: helper method to retrieve profile's jid: Goffi <goffi@goffi.org> parents: 3765 diff changeset	979 return full_jid.rsplit("/", 1)[0]
3260401fdb98 cli: helper method to retrieve profile's jid: Goffi <goffi@goffi.org> parents: 3765 diff changeset	980
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	981
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	982 class CommandBase(object):
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	983
2155 cee6561ad086 jp (core): added extra_outputs: Goffi <goffi@goffi.org> parents: 2151 diff changeset	984 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	985 need_connect=None, help=None, **kwargs):
2098 e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	986 """Initialise CommandBase
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	987
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	988 @param host: Jp instance
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	989 @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	990 @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	991 @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	992 @param extra_outputs(dict): list of command specific outputs:
cee6561ad086 jp (core): added extra_outputs: Goffi <goffi@goffi.org> parents: 2151 diff changeset	993 key is output name ("default" to use as main output)
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	994 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	995 argument)
2155 cee6561ad086 jp (core): added extra_outputs: Goffi <goffi@goffi.org> parents: 2151 diff changeset	996 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	997 @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	998 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	999 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	1000 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	1001 @param help(unicode): help message to display
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1002 @param **kwargs: args passed to ArgumentParser
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1003 use_* are handled directly, they can be:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1004 - use_progress(bool): if True, add progress bar activation option
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1005 progress* signals will be handled
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1006 - use_verbose(bool): if True, add verbosity option
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	1007 - use_pubsub(bool): if True, add pubsub options
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	1008 mandatory arguments are controlled by pubsub_req
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	1009 - use_draft(bool): if True, add draft handling options
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	1010 other arguments
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1011 - pubsub_flags(iterable[unicode]): tuple of flags to set pubsub options,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1012 can be:
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	1013 C.SERVICE: service is required
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	1014 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	1015 C.ITEM: item is required
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	1016 C.SINGLE_ITEM: only one item is allowed
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	1017 """
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1018 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	1019 self.host = host.host
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1020 except AttributeError:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1021 self.host = host
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1022
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1023 # --profile option
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1024 parents = kwargs.setdefault('parents', set())
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1025 if use_profile:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1026 # self.host.parents['profile'] is an ArgumentParser with profile connection
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1027 # arguments
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	1028 if need_connect is None:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	1029 need_connect = True
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1030 parents.add(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1031 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	1032 else:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	1033 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	1034 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	1035 # 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	1036 # 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	1037
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1038 # --output option
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1039 if use_output:
2155 cee6561ad086 jp (core): added extra_outputs: Goffi <goffi@goffi.org> parents: 2151 diff changeset	1040 if extra_outputs is None:
cee6561ad086 jp (core): added extra_outputs: Goffi <goffi@goffi.org> parents: 2151 diff changeset	1041 extra_outputs = {}
cee6561ad086 jp (core): added extra_outputs: Goffi <goffi@goffi.org> parents: 2151 diff changeset	1042 self.extra_outputs = extra_outputs
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1043 if use_output == True:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1044 use_output = C.OUTPUT_TEXT
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1045 assert use_output in C.OUTPUT_TYPES
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1046 self._output_type = use_output
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1047 output_parent = argparse.ArgumentParser(add_help=False)
2155 cee6561ad086 jp (core): added extra_outputs: Goffi <goffi@goffi.org> parents: 2151 diff changeset	1048 choices = set(self.host.getOutputChoices(use_output))
cee6561ad086 jp (core): added extra_outputs: Goffi <goffi@goffi.org> parents: 2151 diff changeset	1049 choices.update(extra_outputs)
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1050 if not choices:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1051 raise exceptions.InternalError(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1052 "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	1053 try:
a25a256688e2 jp (base): output can now specify a default when registering Goffi <goffi@goffi.org> parents: 2188 diff changeset	1054 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	1055 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1056 if 'default' in choices:
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1057 default = 'default'
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1058 elif 'simple' in choices:
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1059 default = 'simple'
2189 a25a256688e2 jp (base): output can now specify a default when registering Goffi <goffi@goffi.org> parents: 2188 diff changeset	1060 else:
a25a256688e2 jp (base): output can now specify a default when registering Goffi <goffi@goffi.org> parents: 2188 diff changeset	1061 default = list(choices)[0]
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1062 output_parent.add_argument(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1063 '--output', '-O', choices=sorted(choices), default=default,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1064 help=_("select output format (default: {})".format(default)))
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1065 output_parent.add_argument(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1066 '--output-option', '--oo', action="append", dest='output_opts',
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1067 default=[], help=_("output specific option"))
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1068 parents.add(output_parent)
2155 cee6561ad086 jp (core): added extra_outputs: Goffi <goffi@goffi.org> parents: 2151 diff changeset	1069 else:
cee6561ad086 jp (core): added extra_outputs: Goffi <goffi@goffi.org> parents: 2151 diff changeset	1070 assert extra_outputs is None
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1071
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	1072 self._use_pubsub = kwargs.pop('use_pubsub', False)
772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	1073 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	1074 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	1075 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	1076 parents.add(self.host.make_pubsub_group(flags, defaults))
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	1077 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	1078
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1079 # other common options
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1080 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	1081 for param, do_use in use_opts.items():
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1082 opt=param[4:] # if param is use_verbose, opt is verbose
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1083 if opt not in self.host.parents:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1084 raise exceptions.InternalError("Unknown parent option {}".format(opt))
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1085 del kwargs[param]
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1086 if do_use:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1087 parents.add(self.host.parents[opt])
1600 8d41cd4da2f6 jp: added a --verbose command Goffi <goffi@goffi.org> parents: 1594 diff changeset	1088
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1089 self.parser = host.subparsers.add_parser(name, help=help, **kwargs)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1090 if hasattr(self, "subcommands"):
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1091 self.subparsers = self.parser.add_subparsers(dest='subcommand', required=True)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1092 else:
2532 772447ec070f jp: pubsub options refactoring: Goffi <goffi@goffi.org> parents: 2490 diff changeset	1093 self.parser.set_defaults(_cmd=self)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1094 self.add_parser_options()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1095
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1096 @property
3046 d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	1097 def sat_conf(self):
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	1098 return self.host.sat_conf
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	1099
d9f328374473 jp: dark and light theme: Goffi <goffi@goffi.org> parents: 3043 diff changeset	1100 @property
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1101 def args(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1102 return self.host.args
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1103
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1104 @property
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1105 def profile(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1106 return self.host.profile
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1107
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1108 @property
2490 b4bf282d6354 jp (base): added verbosity property to CommandBase Goffi <goffi@goffi.org> parents: 2486 diff changeset	1109 def verbosity(self):
b4bf282d6354 jp (base): added verbosity property to CommandBase Goffi <goffi@goffi.org> parents: 2486 diff changeset	1110 return self.host.verbosity
b4bf282d6354 jp (base): added verbosity property to CommandBase Goffi <goffi@goffi.org> parents: 2486 diff changeset	1111
b4bf282d6354 jp (base): added verbosity property to CommandBase Goffi <goffi@goffi.org> parents: 2486 diff changeset	1112 @property
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1113 def progress_id(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1114 return self.host.progress_id
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	1115
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1116 async def set_progress_id(self, progress_id):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1117 return await self.host.set_progress_id(progress_id)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1118
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1119 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	1120 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	1121 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	1122 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	1123 # 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	1124 # 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	1125 # 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	1126 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	1127 try:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1128 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	1129 except AttributeError:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1130 cache = self.host.progress_ids_cache = []
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1131 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	1132 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	1133 if self.host.watch_progress and uid == self.progress_id:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1134 await self.onProgressStarted(metadata)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1135 while True:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1136 await asyncio.sleep(PROGRESS_DELAY)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1137 cont = await self.progressUpdate()
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1138 if not cont:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1139 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	1140
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1141 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	1142 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	1143 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	1144 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	1145 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	1146 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	1147 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	1148 pass
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1149 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	1150 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	1151 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	1152
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1153 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	1154 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	1155 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	1156 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	1157 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	1158 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	1159 if self.host.quit_on_progress_end:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1160 await self.onProgressError(message)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1161 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	1162
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1163 async def progressUpdate(self):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1164 """This method is continualy called to update the progress bar
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1165
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1166 @return (bool): False to stop being called
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1167 """
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1168 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	1169 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	1170 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	1171 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	1172 except KeyError:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1173 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	1174 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	1175 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	1176 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	1177 #first answer, we must construct the bar
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1178
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1179 # 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	1180 # else default one is used
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1181 # 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	1182 # 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	1183 # are used as widget arguments
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1184 try:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1185 template = self.pbar_template
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1186 except AttributeError:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1187 template = [
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1188 _("Progress: "), ["Percentage"], " ", ["Bar"], " ",
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1189 ["FileTransferSpeed"], " ", ["ETA"]
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1190 ]
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1191
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1192 widgets = []
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1193 for part in template:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1194 if isinstance(part, str):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1195 widgets.append(part)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1196 else:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1197 widget = getattr(progressbar, part.pop(0))
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1198 widgets.append(widget(*part))
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1199
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1200 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	1201 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	1202
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	1203 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	1204
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	1205 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	1206 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	1207
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1208 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	1209
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	1210 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	1211
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1212 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	1213 """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	1214
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	1215 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	1216 @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	1217 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1218 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	1219
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1220 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	1221 """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	1222
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	1223 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	1224 @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	1225 """
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	1226 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	1227
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1228 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	1229 """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	1230
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	1231 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	1232 @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	1233 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1234 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	1235
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1236 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	1237 """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	1238
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	1239 @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	1240 """
3568 04283582966f core, frontends: fix invalid translatable strings. Goffi <goffi@goffi.org> parents: 3555 diff changeset	1241 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	1242
3407 2f0be2b7de68 jp: replace `no_lf` argument by `end` in `disp` (same as in `print`) Goffi <goffi@goffi.org> parents: 3378 diff changeset	1243 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	1244 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	1245
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	1246 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	1247 try:
33b82250eadd jp (base): raise InternalError if output is used when use_output is not declared Goffi <goffi@goffi.org> parents: 2189 diff changeset	1248 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	1249 except AttributeError:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1250 raise exceptions.InternalError(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1251 _('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	1252 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	1253
3586 5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict Goffi <goffi@goffi.org> parents: 3568 diff changeset	1254 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	1255 """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	1256
3586 5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict Goffi <goffi@goffi.org> parents: 3568 diff changeset	1257 @param extra: base extra dict, or None to generate a new one
3893 045af0eeda3f core, CLI (base), tools (common/data_format): typing/core readability Goffi <goffi@goffi.org> parents: 3866 diff changeset	1258 @return: serialised 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	1259 """
4b693ea24d5f jp (base, pubsub, ticket): handle order-by: Goffi <goffi@goffi.org> parents: 2706 diff changeset	1260 if extra is None:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by: Goffi <goffi@goffi.org> parents: 2706 diff changeset	1261 extra = {}
4b693ea24d5f jp (base, pubsub, ticket): handle order-by: Goffi <goffi@goffi.org> parents: 2706 diff changeset	1262 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1263 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	1264 if intersection:
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	1265 raise exceptions.ConflictError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1266 "given extra dict has conflicting keys with pubsub keys "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1267 "{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	1268
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	1269 # RSM
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	1270
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1271 for attribute in ('max', 'after', 'before', 'index'):
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1272 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	1273 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	1274 raise exceptions.ConflictError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1275 "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	1276 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	1277 if value is not None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1278 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	1279
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	1280 # MAM
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	1281
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1282 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	1283 for key, value in self.args.mam_filters:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1284 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	1285 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	1286 raise exceptions.ConflictError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2910 diff changeset	1287 "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	1288 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	1289
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	1290 # Order-By
92af49cde255 jp (base): MAM and RSM arguments can now be used for pubsub commands: Goffi <goffi@goffi.org> parents: 2761 diff changeset	1291
2761 4b693ea24d5f jp (base, pubsub, ticket): handle order-by: Goffi <goffi@goffi.org> parents: 2706 diff changeset	1292 try:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by: Goffi <goffi@goffi.org> parents: 2706 diff changeset	1293 order_by = self.args.order_by
4b693ea24d5f jp (base, pubsub, ticket): handle order-by: Goffi <goffi@goffi.org> parents: 2706 diff changeset	1294 except AttributeError:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by: Goffi <goffi@goffi.org> parents: 2706 diff changeset	1295 pass
4b693ea24d5f jp (base, pubsub, ticket): handle order-by: Goffi <goffi@goffi.org> parents: 2706 diff changeset	1296 else:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by: Goffi <goffi@goffi.org> parents: 2706 diff changeset	1297 if order_by is not None:
4b693ea24d5f jp (base, pubsub, ticket): handle order-by: Goffi <goffi@goffi.org> parents: 2706 diff changeset	1298 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	1299
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option Goffi <goffi@goffi.org> parents: 3586 diff changeset	1300 # Cache
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option Goffi <goffi@goffi.org> parents: 3586 diff changeset	1301 try:
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option Goffi <goffi@goffi.org> parents: 3586 diff changeset	1302 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	1303 except AttributeError:
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option Goffi <goffi@goffi.org> parents: 3586 diff changeset	1304 pass
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option Goffi <goffi@goffi.org> parents: 3586 diff changeset	1305 else:
1709f0a78f50 jp (base): add flag for `use_pubsub` to add cache skipping option Goffi <goffi@goffi.org> parents: 3586 diff changeset	1306 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	1307 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	1308
3586 5f65f4e9f8cb plugin XEP-0060: getItems extra is now serialised dict Goffi <goffi@goffi.org> parents: 3568 diff changeset	1309 return data_format.serialise(extra)
2761 4b693ea24d5f jp (base, pubsub, ticket): handle order-by: Goffi <goffi@goffi.org> parents: 2706 diff changeset	1310
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1311 def add_parser_options(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1312 try:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1313 subcommands = self.subcommands
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1314 except AttributeError:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1315 # We don't have subcommands, the class need to implements add_parser_options
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1316 raise NotImplementedError
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1317
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1318 # now we add subcommands to ourself
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1319 for cls in subcommands:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1320 cls(self)
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	1321
3866 915fb230cb28 cli (blog, pubsub): new `attachments` subcommands: Goffi <goffi@goffi.org> parents: 3834 diff changeset	1322 def overridePubsubFlags(self, new_flags: Set[str]) -> None:
915fb230cb28 cli (blog, pubsub): new `attachments` subcommands: Goffi <goffi@goffi.org> parents: 3834 diff changeset	1323 """Replace pubsub_flags given in __init__
915fb230cb28 cli (blog, pubsub): new `attachments` subcommands: Goffi <goffi@goffi.org> parents: 3834 diff changeset	1324
915fb230cb28 cli (blog, pubsub): new `attachments` subcommands: Goffi <goffi@goffi.org> parents: 3834 diff changeset	1325 useful when a command is extending an other command (e.g. blog command which does
915fb230cb28 cli (blog, pubsub): new `attachments` subcommands: Goffi <goffi@goffi.org> parents: 3834 diff changeset	1326 the same as pubsub command, but with a default node)
915fb230cb28 cli (blog, pubsub): new `attachments` subcommands: Goffi <goffi@goffi.org> parents: 3834 diff changeset	1327 """
915fb230cb28 cli (blog, pubsub): new `attachments` subcommands: Goffi <goffi@goffi.org> parents: 3834 diff changeset	1328 self._pubsub_flags = new_flags
915fb230cb28 cli (blog, pubsub): new `attachments` subcommands: Goffi <goffi@goffi.org> parents: 3834 diff changeset	1329
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1330 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	1331 """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	1332
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	1333 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	1334 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	1335 """
2155 cee6561ad086 jp (core): added extra_outputs: Goffi <goffi@goffi.org> parents: 2151 diff changeset	1336 # 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	1337 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	1338
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1339 try:
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	1340 show_progress = self.args.progress
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1341 except AttributeError:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1342 # the command doesn't use progress bar
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1343 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	1344 else:
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	1345 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	1346 self.host.watch_progress = True
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1347 # 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	1348 # progress bar
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1349 self.host.bridge.register_signal(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1350 "progressStarted", self.progressStartedHandler)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1351 self.host.bridge.register_signal(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1352 "progressFinished", self.progressFinishedHandler)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1353 self.host.bridge.register_signal(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1354 "progressError", self.progressErrorHandler)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1355
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	1356 if self.need_connect is not None:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1357 await self.host.connect_profile()
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1358 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	1359
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1360 async def start(self):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1361 """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	1362
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	1363 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	1364 """
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1365 raise NotImplementedError
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1366
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1367
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1368 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	1369 """Specialised commands which answer to specific actions
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	1370
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	1371 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	1372 """
2409 d2ff5ff3de77 jp (ad-hoc): new "list" and "run" commands: Goffi <goffi@goffi.org> parents: 2368 diff changeset	1373 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	1374 # 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	1375 # 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	1376 # 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	1377
2486 031aa3cc67ac jp (base): fixed assertion error when using CommandAnswering Goffi <goffi@goffi.org> parents: 2483 diff changeset	1378 def __init__(self, args, *kwargs):
031aa3cc67ac jp (base): fixed assertion error when using CommandAnswering Goffi <goffi@goffi.org> parents: 2483 diff changeset	1379 super(CommandAnswering, self).__init__(args, *kwargs)
031aa3cc67ac jp (base): fixed assertion error when using CommandAnswering Goffi <goffi@goffi.org> parents: 2483 diff changeset	1380
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1381 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	1382 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	1383 return
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	1384 try:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	1385 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	1386 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	1387 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	1388 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	1389 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	1390 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	1391 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	1392 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	1393 else:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	1394 try:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	1395 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	1396 except KeyError:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	1397 pass
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1398 else:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1399 await callback(action_data, action_id, security_limit, profile)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1400
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	1401 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	1402 """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	1403
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	1404 @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	1405 """
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	1406 # 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	1407 # 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	1408 # 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	1409 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	1410 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	1411 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	1412 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	1413
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1414 async def start_answering(self):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1415 """Auto reply to confirmation requests"""
2368 3865a772c360 jp (base): fixed CommandAnswering and progress bar Goffi <goffi@goffi.org> parents: 2313 diff changeset	1416 self.host.bridge.register_signal("actionNew", self.onActionNew)
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1417 actions = await self.host.bridge.actionsGet(self.profile)
1623 ec48b35309dc jp: use the new actionsGet method Goffi <goffi@goffi.org> parents: 1606 diff changeset	1418 for action_data, action_id, security_limit in actions:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1419 await self.onActionNew(action_data, action_id, security_limit, self.profile)

Mercurial > libervia-backend

annotate sat_frontends/jp/base.py @ 3906:d8baf92cb921