libervia-backend: frontends/src/jp/base.py annotate

annotate frontends/src/jp/base.py @ 1878:7a07f232e7cb

misc (sat.sh): exec + better stop: - use exec to launch twistd which is specially useful in foreground mode, so signals and other stuff are handled correctly - sat.sh stop now wait until the backend is actually stopped before exiting (before it was just sending the signal and leaving)

author	Goffi <goffi@goffi.org>
date	Fri, 04 Mar 2016 23:24:06 +0100
parents	df1ca137b0cb
children	0fe69871b71f

rev	line source
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1 #! /usr/bin/python
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	2 # -- coding: utf-8 --
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	3
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 601 diff changeset	4 # jp: a SAT command line tool
1766 d17772b0fe22 copyright update Goffi <goffi@goffi.org> parents: 1642 diff changeset	5 # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	6
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 601 diff changeset	7 # 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	8 # 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	9 # 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	10 # (at your option) any later version.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	11
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 601 diff changeset	12 # 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	13 # 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	14 # 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	15 # GNU Affero General Public License for more details.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	16
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 601 diff changeset	17 # 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	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	19
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
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	24 log.basicConfig(level=log.DEBUG,
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	25 format='%(message)s')
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
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	29 import locale
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
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	32 from gi.repository import GLib
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	33 from glob import iglob
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	34 from importlib import import_module
1139 75025461141f move sat.tools.jid to sat_frontends.tools.jid souliane <souliane@mailoo.org> parents: 1033 diff changeset	35 from sat_frontends.tools.jid import JID
627 d207c2186519 core, bridge, jp, quick_frontend: SàT stop more gracefully if bridge can't be initialised: Goffi <goffi@goffi.org> parents: 613 diff changeset	36 from sat_frontends.bridge.DBus import DBusBridgeFrontend
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	37 from sat.core import exceptions
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	38 import sat_frontends.jp
970 2e052998c7eb jp: using C.APP_URL for application url Goffi <goffi@goffi.org> parents: 965 diff changeset	39 from sat_frontends.jp.constants import Const as C
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	40 import xml.etree.ElementTree as ET # FIXME: used temporarily to manage XMLUI
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	41 import shlex
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	42
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	43 if sys.version_info < (2, 7, 3):
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	44 # XXX: shlex.split only handle unicode since python 2.7.3
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	45 # this is a workaround for older versions
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	46 old_split = shlex.split
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	47 new_split = (lambda s, a, kw: [t.decode('utf-8') for t in old_split(s.encode('utf-8'), a, **kw)]
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	48 if isinstance(s, unicode) else old_split(s, a, *kw))
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	49 shlex.split = new_split
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	50
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	51 try:
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	52 import progressbar
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	53 except ImportError:
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	54 log.info (_('ProgressBar not available, please download it at http://pypi.python.org/pypi/progressbar'))
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	55 log.info (_('Progress bar deactivated\n--\n'))
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	56 progressbar=None
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	57
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	58 #consts
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	59 PROG_NAME = u"jp"
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	60 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	61 Get the latest version at """ + C.APP_URL
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	62
1766 d17772b0fe22 copyright update Goffi <goffi@goffi.org> parents: 1642 diff changeset	63 COPYLEFT = u"""Copyright (C) 2009-2016 Jérôme Poisson, Adrien Cossa
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	64 This program comes with ABSOLUTELY NO WARRANTY;
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	65 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	66 """
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	67
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	68 PROGRESS_DELAY = 10 # the progression will be checked every PROGRESS_DELAY ms
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	69
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	70
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	71 def unicode_decoder(arg):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	72 # Needed to have unicode strings from arguments
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	73 return arg.decode(locale.getpreferredencoding())
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	74
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	75
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	76 class Jp(object):
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	77 """
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	78 This class can be use to establish a connection with the
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	79 bridge. Moreover, it should manage a main loop.
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	80
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	81 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	82 specify what kind of operation you want to perform.
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	83
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	84 """
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	85 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	86 """
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	87
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	88 @attribute quit_on_progress_end (bool): set to False if you manage yourself exiting,
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	89 or if you want the user to stop by himself
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	90 @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	91 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	92 @attribute progress_success(callable): method to call when progress is successfully finished
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	93 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	94 @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	95 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	96 """
165 8a2053de6f8c Frontends: management of unlaunched SàT Backend (information message and exit) Goffi <goffi@goffi.org> parents: 156 diff changeset	97 try:
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	98 self.bridge = DBusBridgeFrontend()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	99 except exceptions.BridgeExceptionNoService:
165 8a2053de6f8c Frontends: management of unlaunched SàT Backend (information message and exit) Goffi <goffi@goffi.org> parents: 156 diff changeset	100 print(_(u"Can't connect to SàT backend, are you sure it's launched ?"))
627 d207c2186519 core, bridge, jp, quick_frontend: SàT stop more gracefully if bridge can't be initialised: Goffi <goffi@goffi.org> parents: 613 diff changeset	101 sys.exit(1)
864 241f6baa6687 frontends: fix typos, do not use logging in the xmlui tools: souliane <souliane@mailoo.org> parents: 823 diff changeset	102 except exceptions.BridgeInitError:
627 d207c2186519 core, bridge, jp, quick_frontend: SàT stop more gracefully if bridge can't be initialised: Goffi <goffi@goffi.org> parents: 613 diff changeset	103 print(_(u"Can't init bridge"))
165 8a2053de6f8c Frontends: management of unlaunched SàT Backend (information message and exit) Goffi <goffi@goffi.org> parents: 156 diff changeset	104 sys.exit(1)
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	105
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	106 self.parser = argparse.ArgumentParser(formatter_class=argparse.RawDescriptionHelpFormatter,
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	107 description=DESCRIPTION)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	108
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	109 self._make_parents()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	110 self.add_parser_options()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	111 self.subparsers = self.parser.add_subparsers(title=_('Available commands'), dest='subparser_name')
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	112 self._auto_loop = False # when loop is used for internal reasons
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	113 self._need_loop = False
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	114
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	115 # progress attributes
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	116 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	117 self.quit_on_progress_end = True
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	118
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	119 @property
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	120 def version(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	121 return self.bridge.getVersion()
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	122
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	123 @property
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	124 def progress_id(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	125 return self._progress_id
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	126
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	127 @progress_id.setter
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	128 def progress_id(self, value):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	129 self._progress_id = value
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	130 self.replayCache('progress_ids_cache')
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	131
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	132 @property
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	133 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	134 try:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	135 self.pbar
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	136 except AttributeError:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	137 return False
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	138 else:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	139 return True
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	140
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	141 @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	142 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	143 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	144 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	145
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	146 @property
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	147 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	148 try:
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	149 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	150 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	151 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	152
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	153 def replayCache(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	154 """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	155
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	156 @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	157 if the attribute doesn't exist, there is no cache and the call is ignored
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	158 else the cache must be a list of tuples containing the replay callback as first item,
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	159 then the arguments to use
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	160 """
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	161 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	162 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	163 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	164 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	165 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	166 for cache_data in 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	167 cache_data[0](*cache_data[1:])
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	168
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	169 def disp(self, msg, verbosity=0, error=False):
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	170 """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	171
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	172 @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	173 @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	174 @param error(bool): if True, print to stderr instead of stdout
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	175 """
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	176 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	177 if error:
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	178 print >>sys.stderr,msg
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	179 else:
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	180 print msg
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	181
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	182 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	183 """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	184
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	185 @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	186 """
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	187 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	188 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	189 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	190 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	191 finally:
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	192 callbacks_list.append((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	193
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	194 def _make_parents(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	195 self.parents = {}
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	196
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	197 # we have a special case here as the start-session option is present only if connection is not needed,
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	198 # so we create two similar parents, one with the option, the other one without it
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	199 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	200 parent = self.parents[parent_name] = argparse.ArgumentParser(add_help=False)
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	201 parent.add_argument("-p", "--profile", action="store", type=str, default='@DEFAULT@', help=_("Use PROFILE profile key (default: %(default)s)"))
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	202 parent.add_argument("--pwd", action="store", type=unicode, default='', metavar='PASSWORD', help=_("Password used to connect profile, if necessary"))
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	203
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	204 profile_parent, profile_session_parent = self.parents['profile'], self.parents['profile_session']
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	205
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	206 connect_short, connect_long, connect_action, connect_help = "-c", "--connect", "store_true", _(u"Connect the profile before doing anything else")
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	207 profile_parent.add_argument(connect_short, connect_long, action=connect_action, help=connect_help)
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	208
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	209 profile_session_connect_group = profile_session_parent.add_mutually_exclusive_group()
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	210 profile_session_connect_group.add_argument(connect_short, connect_long, action=connect_action, help=connect_help)
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	211 profile_session_connect_group.add_argument("--start-session", action="store_true", help=_("Start a profile session without connecting"))
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	212
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	213 progress_parent = self.parents['progress'] = argparse.ArgumentParser(add_help=False)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	214 if progressbar:
823 300b4de701a6 jp: short option for progress is now -P instead of -g, so -g can be used for groups Goffi <goffi@goffi.org> parents: 817 diff changeset	215 progress_parent.add_argument("-P", "--progress", action="store_true", help=_("Show progress bar"))
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	216
1600 8d41cd4da2f6 jp: added a --verbose command Goffi <goffi@goffi.org> parents: 1594 diff changeset	217 verbose_parent = self.parents['verbose'] = argparse.ArgumentParser(add_help=False)
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	218 verbose_parent.add_argument('--verbose', '-v', action='count', default=0, help=_(u"Add a verbosity level (can be used multiple times)"))
1600 8d41cd4da2f6 jp: added a --verbose command Goffi <goffi@goffi.org> parents: 1594 diff changeset	219
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	220 def add_parser_options(self):
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	221 self.parser.add_argument('--version', action='version', version=("%(name)s %(version)s %(copyleft)s" % {'name': PROG_NAME, 'version': self.version, 'copyleft': COPYLEFT}))
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	222
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	223 def import_commands(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	224 """ Automaticaly import commands to jp
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	225 looks from modules names cmd_*.py in jp path and import them
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	226
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	227 """
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	228 path = os.path.dirname(sat_frontends.jp.__file__)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	229 modules = (os.path.splitext(module)[0] for module in map(os.path.basename, iglob(os.path.join(path, "cmd_*.py"))))
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	230 for module_name in modules:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	231 module = import_module("sat_frontends.jp."+module_name)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	232 try:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	233 self.import_command_module(module)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	234 except ImportError:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	235 continue
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	236
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	237 def import_command_module(self, module):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	238 """ Add commands from a module to jp
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	239 @param module: module containing commands
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	240
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	241 """
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	242 try:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	243 for classname in module.__commands__:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	244 cls = getattr(module, classname)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	245 except AttributeError:
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	246 log.warning(_("Invalid module %s") % module)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	247 raise ImportError
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	248 cls(self)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	249
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	250 def run(self, args=None):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	251 self.args = self.parser.parse_args(args)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	252 self.args.func()
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	253 if self._need_loop or self._auto_loop:
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	254 self._start_loop()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	255
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	256 def _start_loop(self):
898 9720d3d0a764 jp: updated main loop to gobject 3 Matteo Cypriani <mcy@lm7.fr> parents: 864 diff changeset	257 self.loop = GLib.MainLoop()
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	258 try:
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	259 self.loop.run()
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	260 except KeyboardInterrupt:
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	261 log.info(_("User interruption: good bye"))
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	262
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	263 def stop_loop(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	264 try:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	265 self.loop.quit()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	266 except AttributeError:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	267 pass
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	268
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	269 def quitFromSignal(self, errcode=0):
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks Goffi <goffi@goffi.org> parents: 1600 diff changeset	270 """Same as self.quit, but from a signal handler
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	271
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	272 /!\: 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	273 """
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	274 assert self._need_loop
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	275 # XXX: python-dbus will show a traceback if we exit in a signal handler with an error code
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	276 # so we use this little timeout trick to avoid it
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	277 GLib.timeout_add(0, self.quit, errcode)
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	278
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	279 def quit(self, errcode=0):
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	280 # 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	281 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	282 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	283 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	284 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	285 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	286 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	287 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	288
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	289 self.stop_loop()
1869 9d9d61d53684 jp (base): fixed Jp.quit when exit code is 0 Goffi <goffi@goffi.org> parents: 1863 diff changeset	290 sys.exit(errcode)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	291
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	292 def check_jids(self, jids):
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	293 """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	294
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	295 @param profile: profile name
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	296 @param jids: list of jids
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	297 @return: List of jids
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	298
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	299 """
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	300 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	301 nodes2jid = {}
393 393b35aa86d2 jp: added --connect option Goffi <goffi@goffi.org> parents: 391 diff changeset	302
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	303 for contact in self.bridge.getContacts(self.profile):
1395 1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node Goffi <goffi@goffi.org> parents: 1290 diff changeset	304 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	305 _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	306 try:
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node Goffi <goffi@goffi.org> parents: 1290 diff changeset	307 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	308 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	309 pass
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node Goffi <goffi@goffi.org> parents: 1290 diff changeset	310
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node Goffi <goffi@goffi.org> parents: 1290 diff changeset	311 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	312 nodes2jid[_jid.node.lower()] = jid_s
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	313
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	314 def expand_jid(jid):
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	315 _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	316 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	317 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	318 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	319 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	320 else:
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid Goffi <goffi@goffi.org> parents: 480 diff changeset	321 expanded = jid
965 5b95ce21c2d3 jp: fixed jid unicode decoding Goffi <goffi@goffi.org> parents: 964 diff changeset	322 return expanded.decode('utf-8')
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	323
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	324 def check(jid):
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	325 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	326 log.error (_("%s is not a valid JID !"), jid)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	327 self.quit(1)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	328
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	329 dest_jids=[]
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	330 try:
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	331 for i in range(len(jids)):
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	332 dest_jids.append(expand_jid(jids[i]))
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	333 check(dest_jids[i])
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	334 except AttributeError:
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	335 pass
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	336
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	337 return dest_jids
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	338
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	339 def connect_profile(self, callback):
1588 823a385235ef jp: fixed bad --connect option check Goffi <goffi@goffi.org> parents: 1544 diff changeset	340 """ 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	341
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	342 @param callback: method to call when profile is connected
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	343 @exit: - 1 when profile is not connected and --connect is not set
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	344 - 1 when the profile doesn't exists
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	345 - 1 when there is a connection error
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	346 """
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	347 # FIXME: need better exit codes
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	348
971 8ca5c990ed92 jp: "disco" subcommand, moved into a new "info" subcommand + added "version" subcommand which get software version Goffi <goffi@goffi.org> parents: 970 diff changeset	349 def cant_connect(failure):
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	350 log.error(_(u"Can't connect profile: {reason}").format(reason=failure))
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	351 self.quit(1)
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	352
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	353 def cant_start_session(failure):
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	354 log.error(_(u"Can't start {profile}'s session: {reason}").format(profile=self.profile, reason=failure))
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	355 self.quit(1)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	356
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	357 self.profile = self.bridge.getProfileName(self.args.profile)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	358
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	359 if not self.profile:
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	360 log.error(_("The profile [{profile}] doesn't exist").format(profile=self.args.profile))
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	361 self.quit(1)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	362
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	363 try:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	364 start_session = self.args.start_session
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	365 except AttributeError:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	366 pass
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	367 else:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	368 if start_session:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	369 self.bridge.profileStartSession(self.args.pwd, self.profile, lambda dummy: callback(), cant_start_session)
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	370 self._auto_loop = True
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	371 return
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	372 elif not self.bridge.profileIsSessionStarted(self.profile):
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	373 if not self.args.connect:
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	374 log.error(_(u"Session for [{profile}] is not started, please start it before using jp, or use either --start-session or --connect option").format(profile=self.profile))
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	375 self.quit(1)
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	376 else:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	377 callback()
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	378 return
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	379
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	380
1401 265ff2bd8d67 jp: fixed crash on commands using profile without "connect" option Goffi <goffi@goffi.org> parents: 1396 diff changeset	381 if not hasattr(self.args, 'connect'):
1588 823a385235ef jp: fixed bad --connect option check Goffi <goffi@goffi.org> parents: 1544 diff changeset	382 # a profile can be present without connect option (e.g. on profile creation/deletion)
1401 265ff2bd8d67 jp: fixed crash on commands using profile without "connect" option Goffi <goffi@goffi.org> parents: 1396 diff changeset	383 return
1588 823a385235ef jp: fixed bad --connect option check Goffi <goffi@goffi.org> parents: 1544 diff changeset	384 elif self.args.connect is True: # if connection is asked, we connect the profile
1544 3d5193b4c582 jp: separate password and connection of profile in --connect and --pwd arguments Goffi <goffi@goffi.org> parents: 1401 diff changeset	385 self.bridge.asyncConnect(self.profile, self.args.pwd, lambda dummy: callback(), cant_connect)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	386 self._auto_loop = True
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	387 return
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	388 else:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	389 if not self.bridge.isConnected(self.profile):
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	390 log.error(_(u"Profile [{profile}] is not connected, please connect it before using jp, or use --connect option").format(profile=self.profile))
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	391 self.quit(1)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	392
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	393 callback()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	394
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	395 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	396 """Return the full jid if possible (add main resource when find a bare jid)"""
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	397 _jid = JID(param_jid)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	398 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	399 #if the resource is not given, we try to add the main resource
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	400 main_resource = self.bridge.getMainResource(param_jid, self.profile)
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	401 if main_resource:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	402 return "%s/%s" % (_jid.bare, main_resource)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	403 return param_jid
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	404
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	405
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	406 class CommandBase(object):
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	407
1600 8d41cd4da2f6 jp: added a --verbose command Goffi <goffi@goffi.org> parents: 1594 diff changeset	408 def __init__(self, host, name, use_profile=True, use_progress=False, use_verbose=False, need_connect=None, help=None, **kwargs):
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	409 """ Initialise CommandBase
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	410 @param host: Jp instance
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	411 @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	412 @param use_profile(bool): if True, add profile selection/connection commands
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	413 @param use_progress(bool): if True, add progress bar activation commands
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	414 progress* signals will be handled
1600 8d41cd4da2f6 jp: added a --verbose command Goffi <goffi@goffi.org> parents: 1594 diff changeset	415 @param use_verbose(bool): if True, add verbosity command
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	416 @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	417 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	418 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	419 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	420 @param help(unicode): help message to display
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	421 @param **kwargs: args passed to ArgumentParser
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	422 @attribute need_loop(bool): to set by commands when loop is needed
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	423
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	424 """
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	425 self.need_loop = False # to be set by commands when loop is needed
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	426 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	427 self.host = host.host
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	428 except AttributeError:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	429 self.host = host
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	430
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	431 parents = kwargs.setdefault('parents', set())
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	432 if use_profile:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	433 #self.host.parents['profile'] is an ArgumentParser with profile connection arguments
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	434 if need_connect is None:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	435 need_connect = True
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	436 parents.add(self.host.parents['profile' if need_connect else 'profile_session'])
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	437 else:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	438 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	439 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	440 # 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	441 # 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	442
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	443 if use_progress:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	444 parents.add(self.host.parents['progress'])
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	445
1600 8d41cd4da2f6 jp: added a --verbose command Goffi <goffi@goffi.org> parents: 1594 diff changeset	446 if use_verbose:
8d41cd4da2f6 jp: added a --verbose command Goffi <goffi@goffi.org> parents: 1594 diff changeset	447 parents.add(self.host.parents['verbose'])
8d41cd4da2f6 jp: added a --verbose command Goffi <goffi@goffi.org> parents: 1594 diff changeset	448
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	449 self.parser = host.subparsers.add_parser(name, help=help, **kwargs)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	450 if hasattr(self, "subcommands"):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	451 self.subparsers = self.parser.add_subparsers()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	452 else:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	453 self.parser.set_defaults(func=self.run)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	454 self.add_parser_options()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	455
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	456 @property
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	457 def args(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	458 return self.host.args
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	459
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	460 @property
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	461 def profile(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	462 return self.host.profile
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	463
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	464 @property
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	465 def progress_id(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	466 return self.host.progress_id
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	467
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	468 @progress_id.setter
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	469 def progress_id(self, value):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	470 self.host.progress_id = value
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	471
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	472 def progressStartedHandler(self, uid, metadata, 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	473 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	474 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	475 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	476 # 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	477 # 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	478 # 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	479 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	480 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	481 self.host.progress_ids_cache.append(cache_data)
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	482 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	483 self.host.progress_ids_cache = [cache_data]
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	484 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	485 if self.host.watch_progress and uid == self.progress_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	486 self.onProgressStarted(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	487 GLib.timeout_add(PROGRESS_DELAY, self.progressUpdate)
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	488
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	489 def progressFinishedHandler(self, uid, metadata, 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	490 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	491 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	492 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	493 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	494 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	495 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	496 pass
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	497 self.onProgressFinished(metadata)
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	498 if self.host.quit_on_progress_end:
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	499 self.host.quit()
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	500
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	501 def progressErrorHandler(self, uid, message, 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	502 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	503 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	504 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	505 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	506 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	507 if self.host.quit_on_progress_end:
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	508 self.onProgressError(message)
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	509 self.host.quitFromSignal(1)
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	510
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	511 def progressUpdate(self):
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	512 """This method is continualy called to update the progress bar"""
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	513 data = self.host.bridge.progressGet(self.progress_id, self.profile)
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	514 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	515 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	516 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	517 except KeyError:
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	518 self.disp(_(u"file size is not known, we can't show a progress bar"), 1, error=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	519 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	520 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	521 #first answer, we must construct the bar
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	522 self.host.pbar = progressbar.ProgressBar(int(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	523 [_(u"Progress: "),progressbar.Percentage(),
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	524 " ",
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	525 progressbar.Bar(),
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	526 " ",
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	527 progressbar.FileTransferSpeed(),
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	528 " ",
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	529 progressbar.ETA()])
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	530 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	531
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	532 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	533
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	534 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	535 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	536
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	537 self.onProgressUpdate(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	538
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	539 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	540
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	541 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	542 """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	543
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	544 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	545 @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	546 """
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	547 self.disp(_(u"Operation started"), 2)
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	548
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	549 def onProgressUpdate(self, 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	550 """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	551
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	552 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	553 @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	554 """
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	555 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	556
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	557 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	558 """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	559
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	560 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	561 @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	562 """
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	563 self.disp(_(u"Operation successfully finished"), 2)
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	564
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	565 def onProgressError(self, error_msg):
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	566 """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	567
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	568 @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	569 """
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	570 self.disp(_(u"Error while doing operation: {}").format(error_msg), error=True)
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	571
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	572 def disp(self, msg, verbosity=0, error=False):
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	573 return self.host.disp(msg, verbosity, error)
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	574
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	575 def add_parser_options(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	576 try:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	577 subcommands = self.subcommands
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	578 except AttributeError:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	579 # We don't have subcommands, the class need to implements add_parser_options
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	580 raise NotImplementedError
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	581
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	582 # now we add subcommands to ourself
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	583 for cls in subcommands:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	584 cls(self)
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	585
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	586 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	587 """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	588
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	589 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	590 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	591 """
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	592 # host._need_loop is set here from our current value and not before
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	593 # as the need_loop decision must be taken only by then running command
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	594 self.host._need_loop = self.need_loop
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	595
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	596 try:
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	597 show_progress = self.args.progress
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	598 except AttributeError:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	599 # the command doesn't use progress bar
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	600 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	601 else:
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	602 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	603 self.host.watch_progress = True
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	604 # we need to register the following signal even if we don't display the progress bar
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	605 self.host.bridge.register("progressStarted", self.progressStartedHandler)
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	606 self.host.bridge.register("progressFinished", self.progressFinishedHandler)
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	607 self.host.bridge.register("progressError", self.progressErrorHandler)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	608
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	609 if self.need_connect is not None:
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	610 self.host.connect_profile(self.connected)
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	611 else:
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	612 self.start()
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	613
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	614 def connected(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	615 """this method is called when profile is connected (or session is started)
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	616
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	617 this method is only called when use_profile is True
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	618 most of time you should override self.start instead of this method, but if loop
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	619 if not always needed depending on your arguments, you may override this method,
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	620 but don't forget to call the parent one (i.e. this one) after self.need_loop is set
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	621 """
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	622 if not self.need_loop:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	623 self.host.stop_loop()
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	624 self.start()
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	625
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	626 def start(self):
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	627 """This is the starting point of the command, this method should be overriden
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	628
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	629 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	630 """
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	631 pass
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	632
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	633
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	634 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	635 """Specialised commands which answer to specific actions
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	636
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	637 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	638 """
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	639 action_callbacks = {} # XXX: set managed action types in an dict here:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	640 # 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	641 # 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	642 # 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	643
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	644 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	645 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	646 return
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	647 try:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	648 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	649 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	650 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	651 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	652 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	653 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	654 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	655 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	656 else:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	657 try:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	658 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	659 except KeyError:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	660 pass
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	661 else:
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	662 callback(action_data, action_id, security_limit, profile)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	663
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	664 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	665 """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	666
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	667 @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	668 """
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	669 # 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	670 # 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	671 # 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	672 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	673 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	674 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	675 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	676
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	677 def connected(self):
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	678 """Auto reply to confirmations requests"""
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	679 self.need_loop = True
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	680 super(CommandAnswering, self).connected()
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	681 self.host.bridge.register("actionNew", self.onActionNew)
1623 ec48b35309dc jp: use the new actionsGet method Goffi <goffi@goffi.org> parents: 1606 diff changeset	682 actions = self.host.bridge.actionsGet(self.profile)
ec48b35309dc jp: use the new actionsGet method Goffi <goffi@goffi.org> parents: 1606 diff changeset	683 for action_data, action_id, security_limit in actions:
ec48b35309dc jp: use the new actionsGet method Goffi <goffi@goffi.org> parents: 1606 diff changeset	684 self.onActionNew(action_data, action_id, security_limit, self.profile)

Mercurial > libervia-backend

annotate frontends/src/jp/base.py @ 1878:7a07f232e7cb