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

annotate frontends/src/jp/base.py @ 2126:2f264f3df280

core (menus): improvments: - use the new convention for bridge names (getMenus ==> menusGet, etc.) - menu now use canonical path, which is the untranslated path with each element stripped and lowercase, it must be unique by menu type - added menuLaunch method to manually launch a menu like an action, canonical path is used instead of id - added SECURITY_LIMIT_MAX constant

author	Goffi <goffi@goffi.org>
date	Thu, 26 Jan 2017 20:29:48 +0100
parents	469702b46768
children	be96beb7ca14

rev	line source
1945 2c75011d7b2d jp: forgotten shebang fixes Goffi <goffi@goffi.org> parents: 1918 diff changeset	1 #!/usr/bin/env python2
0 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
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	32 from glob import iglob
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	33 from importlib import import_module
1139 75025461141f move sat.tools.jid to sat_frontends.tools.jid souliane <souliane@mailoo.org> parents: 1033 diff changeset	34 from sat_frontends.tools.jid import JID
2098 e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	35 from sat.tools import config
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	36 from sat.tools.common import dynamic_import
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
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	42 from collections import OrderedDict
1872 df1ca137b0cb jp (blog/edit): editor arguments can now be specified on sat.conf, and default on are applied for known editors: Goffi <goffi@goffi.org> parents: 1869 diff changeset	43
2098 e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	44 ## bridge handling
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	45 # we get bridge name from conf and initialise the right class accordingly
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	46 main_config = config.parseMainConf()
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	47 bridge_name = config.getConfig(main_config, '', 'bridge', 'dbus')
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	48
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	49
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	50 # TODO: move loops handling in a separated module
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	51 if 'dbus' in bridge_name:
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	52 from gi.repository import GLib
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	53
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	54
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	55 class JPLoop(object):
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	56
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	57 def __init__(self):
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	58 self.loop = GLib.MainLoop()
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	59
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	60 def run(self):
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	61 self.loop.run()
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	62
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	63 def quit(self):
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	64 self.loop.quit()
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	65
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	66 def call_later(self, delay, callback, *args):
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	67 """call a callback repeatedly
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	68
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	69 @param delay(int): delay between calls in ms
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	70 @param callback(callable): method to call
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	71 if the callback return True, the call will continue
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	72 else the calls will stop
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	73 @param *args: args of the callbac
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	74 """
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	75 GLib.timeout_add(delay, callback, *args)
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	76
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	77 else:
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	78 print u"can't start jp: only D-Bus bridge is currently handled"
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	79 sys.exit(C.EXIT_ERROR)
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	80 # FIXME: twisted loop can be used when jp can handle fully async bridges
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	81 # from twisted.internet import reactor
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	82
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	83 # class JPLoop(object):
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	84
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	85 # def run(self):
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	86 # reactor.run()
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	87
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	88 # def quit(self):
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	89 # reactor.stop()
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	90
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	91 # def _timeout_cb(self, args, callback, delay):
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	92 # ret = callback(*args)
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	93 # if ret:
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	94 # reactor.callLater(delay, self._timeout_cb, args, callback, delay)
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	95
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	96 # def call_later(self, delay, callback, *args):
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	97 # delay = float(delay) / 1000
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	98 # reactor.callLater(delay, self._timeout_cb, args, callback, delay)
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	99
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	100 if bridge_name == "embedded":
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	101 from sat.core import sat_main
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	102 sat = sat_main.SAT()
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	103
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	104 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	105 # 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	106 # 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	107 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	108 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	109 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	110 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	111
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	112 try:
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	113 import progressbar
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	114 except ImportError:
2098 e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	115 log.info (_(u'ProgressBar not available, please download it at http://pypi.python.org/pypi/progressbar'))
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	116 log.info (_(u'Progress bar deactivated\n--\n'))
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	117 progressbar=None
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	118
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	119 #consts
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	120 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	121 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	122 Get the latest version at """ + C.APP_URL
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	123
1766 d17772b0fe22 copyright update Goffi <goffi@goffi.org> parents: 1642 diff changeset	124 COPYLEFT = u"""Copyright (C) 2009-2016 Jérôme Poisson, Adrien Cossa
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	125 This program comes with ABSOLUTELY NO WARRANTY;
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	126 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	127 """
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	128
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	129 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	130
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	131
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	132 def unicode_decoder(arg):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	133 # Needed to have unicode strings from arguments
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	134 return arg.decode(locale.getpreferredencoding())
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	135
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	136
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	137 class Jp(object):
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	138 """
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	139 This class can be use to establish a connection with the
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	140 bridge. Moreover, it should manage a main loop.
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	141
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	142 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	143 specify what kind of operation you want to perform.
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	144
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	145 """
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	146 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	147 """
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	148
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	149 @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	150 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	151 @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	152 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	153 @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	154 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	155 @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	156 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	157 """
2098 e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	158 # FIXME: need_loop should be removed, everything must be async in bridge so
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	159 # loop will always be needed
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	160 bridge_module = dynamic_import.bridge(bridge_name, 'sat_frontends.bridge')
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	161 if bridge_module is None:
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	162 log.error(u"Can't import {} bridge".format(bridge_name))
165 8a2053de6f8c Frontends: management of unlaunched SàT Backend (information message and exit) Goffi <goffi@goffi.org> parents: 156 diff changeset	163 sys.exit(1)
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	164
2098 e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	165 self.bridge = bridge_module.Bridge()
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	166 self.bridge.bridgeConnect(callback=self._bridgeCb, errback=self._bridgeEb)
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	167
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	168 def _bridgeCb(self):
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	169 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	170 description=DESCRIPTION)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	171 self._make_parents()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	172 self.add_parser_options()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	173 self.subparsers = self.parser.add_subparsers(title=_('Available commands'), dest='subparser_name')
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	174 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	175 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	176
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	177 # progress attributes
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	178 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	179 self.quit_on_progress_end = True
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	180
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	181 # outputs
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	182 self._outputs = {}
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	183 for type_ in C.OUTPUT_TYPES:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	184 self._outputs[type_] = OrderedDict()
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	185
2098 e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	186 def _bridgeEb(self, failure):
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	187 if isinstance(failure, exceptions.BridgeExceptionNoService):
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	188 print(_(u"Can't connect to SàT backend, are you sure it's launched ?"))
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	189 elif isinstance(failure, exceptions.BridgeInitError):
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	190 print(_(u"Can't init bridge"))
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	191 else:
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	192 print(_(u"Error while initialising bridge: {}".format(failure)))
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	193 sys.exit(C.EXIT_BRIDGE_ERROR)
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	194
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	195 @property
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	196 def version(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	197 return self.bridge.getVersion()
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	198
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	199 @property
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	200 def progress_id(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	201 return self._progress_id
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	202
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	203 @progress_id.setter
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	204 def progress_id(self, value):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	205 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	206 self.replayCache('progress_ids_cache')
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	207
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	208 @property
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	209 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	210 try:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	211 self.pbar
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	212 except AttributeError:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	213 return False
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	214 else:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	215 return True
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	216
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	217 @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	218 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	219 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	220 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	221
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	222 @property
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	223 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	224 try:
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	225 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	226 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	227 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	228
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	229 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	230 """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	231
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id. Goffi <goffi@goffi.org> parents: 1641 diff changeset	232 @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	233 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	234 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	235 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	236 """
7ec7ce9cdc4c jp (base): progressStarted signals are cached until progress_id is known, this avoid missing the progression if we have the signal before the id. Goffi <goffi@goffi.org> parents: 1641 diff changeset	237 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	238 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	239 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	240 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	241 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	242 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	243 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	244
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	245 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	246 """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	247
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	248 @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	249 @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	250 @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	251 """
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	252 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	253 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	254 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	255 else:
0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	256 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	257
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	258 def output(self, type_, name, data):
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	259 self._outputs[type_][name]['callback'](data)
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	260
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	261 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	262 """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	263
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks Goffi <goffi@goffi.org> parents: 1600 diff changeset	264 @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	265 """
9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks Goffi <goffi@goffi.org> parents: 1600 diff changeset	266 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	267 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	268 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	269 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	270 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	271 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	272
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	273 def getOutputChoices(self, output_type):
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	274 """Return valid output filters for output_type
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	275
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	276 @param output_type: True for default,
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	277 else can be any registered type
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	278 """
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	279 return self._outputs[output_type].keys()
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	280
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	281 def _make_parents(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	282 self.parents = {}
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	283
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	284 # 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	285 # 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	286 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	287 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	288 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	289 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	290
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	291 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	292
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	293 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	294 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	295
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	296 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	297 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	298 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	299
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	300 progress_parent = self.parents['progress'] = argparse.ArgumentParser(add_help=False)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	301 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	302 progress_parent.add_argument("-P", "--progress", action="store_true", help=_("Show progress bar"))
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	303
1600 8d41cd4da2f6 jp: added a --verbose command Goffi <goffi@goffi.org> parents: 1594 diff changeset	304 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	305 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	306
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	307 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	308 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	309
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	310 def register_output(self, type_, name, callback, description=""):
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	311 if type_ not in C.OUTPUT_TYPES:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	312 log.error(u"Invalid output type {}".format(type_))
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	313 return
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	314 self._outputs[type_][name] = {'callback': callback,
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	315 'description': description
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	316 }
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	317
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	318 def import_plugins(self):
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	319 """Automaticaly import commands and outputs in jp
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	320
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	321 looks from modules names cmd_*.py in jp path and import them
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	322 """
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	323 path = os.path.dirname(sat_frontends.jp.__file__)
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	324 # XXX: outputs must be imported before commands as they are used for arguments
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	325 for type_, pattern in ((C.PLUGIN_OUTPUT, 'output_.py'), (C.PLUGIN_CMD, 'cmd_.py')):
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	326 modules = (os.path.splitext(module)[0] for module in map(os.path.basename, iglob(os.path.join(path, pattern))))
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	327 for module_name in modules:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	328 module = import_module("sat_frontends.jp."+module_name)
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	329 try:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	330 self.import_plugin_module(module, type_)
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	331 except ImportError:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	332 continue
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	333
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	334 def import_plugin_module(self, module, type_):
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	335 """add commands or outpus from a module to jp
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	336
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	337 @param module: module containing commands or outputs
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	338 @param type_(str): one of C_PLUGIN_*
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	339 """
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	340 try:
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	341 class_names = getattr(module, '__{}__'.format(type_))
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	342 except AttributeError:
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	343 log.warning(_("Invalid plugin module [{type}] {module}").format(type=type_, module=module))
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	344 raise ImportError
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	345 else:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	346 for class_name in class_names:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	347 cls = getattr(module, class_name)
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	348 cls(self)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	349
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	350 def run(self, args=None):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	351 self.args = self.parser.parse_args(args)
1884 0fe69871b71f jp: moved KeyboardInterrupt catch one level higher, so it is also catched if the loop is not started Goffi <goffi@goffi.org> parents: 1872 diff changeset	352 try:
0fe69871b71f jp: moved KeyboardInterrupt catch one level higher, so it is also catched if the loop is not started Goffi <goffi@goffi.org> parents: 1872 diff changeset	353 self.args.func()
0fe69871b71f jp: moved KeyboardInterrupt catch one level higher, so it is also catched if the loop is not started Goffi <goffi@goffi.org> parents: 1872 diff changeset	354 if self._need_loop or self._auto_loop:
0fe69871b71f jp: moved KeyboardInterrupt catch one level higher, so it is also catched if the loop is not started Goffi <goffi@goffi.org> parents: 1872 diff changeset	355 self._start_loop()
0fe69871b71f jp: moved KeyboardInterrupt catch one level higher, so it is also catched if the loop is not started Goffi <goffi@goffi.org> parents: 1872 diff changeset	356 except KeyboardInterrupt:
0fe69871b71f jp: moved KeyboardInterrupt catch one level higher, so it is also catched if the loop is not started Goffi <goffi@goffi.org> parents: 1872 diff changeset	357 log.info(_("User interruption: good bye"))
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	358
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	359 def _start_loop(self):
2098 e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	360 self.loop = JPLoop()
1884 0fe69871b71f jp: moved KeyboardInterrupt catch one level higher, so it is also catched if the loop is not started Goffi <goffi@goffi.org> parents: 1872 diff changeset	361 self.loop.run()
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	362
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	363 def stop_loop(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	364 try:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	365 self.loop.quit()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	366 except AttributeError:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	367 pass
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	368
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	369 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	370 """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	371
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	372 /!\: 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	373 """
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	374 assert self._need_loop
1918 01d56efd488b jp: fixed traceback shown on a normal quit when a progression is finished Goffi <goffi@goffi.org> parents: 1884 diff changeset	375 # XXX: python-dbus will show a traceback if we exit in a signal handler
1604 9ac78437000d jp (base): added quitFromSignal method to quit from signal handler with errcode without traceback, and addOnQuitCallback to manage cleaning callbacks Goffi <goffi@goffi.org> parents: 1600 diff changeset	376 # so we use this little timeout trick to avoid it
2098 e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	377 self.loop.call_later(0, self.quit, errcode)
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	378
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	379 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	380 # 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	381 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	382 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	383 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	384 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	385 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	386 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	387 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	388
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	389 self.stop_loop()
1869 9d9d61d53684 jp (base): fixed Jp.quit when exit code is 0 Goffi <goffi@goffi.org> parents: 1863 diff changeset	390 sys.exit(errcode)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	391
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	392 def check_jids(self, jids):
59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	393 """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	394
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	395 @param profile: profile name
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	396 @param jids: list of jids
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	397 @return: List of jids
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	398
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	399 """
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	400 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	401 nodes2jid = {}
393 393b35aa86d2 jp: added --connect option Goffi <goffi@goffi.org> parents: 391 diff changeset	402
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	403 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	404 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	405 _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	406 try:
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node Goffi <goffi@goffi.org> parents: 1290 diff changeset	407 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	408 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	409 pass
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node Goffi <goffi@goffi.org> parents: 1290 diff changeset	410
1ae9aa94c351 jp: fixed bad try/except hidding errors + fixed bad management of jids without node Goffi <goffi@goffi.org> parents: 1290 diff changeset	411 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	412 nodes2jid[_jid.node.lower()] = jid_s
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	413
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	414 def expand_jid(jid):
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	415 _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	416 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	417 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	418 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	419 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	420 else:
b7c4bb2c0668 jp: - better expandJid: roster's jids' nodes are used after names to expand jid Goffi <goffi@goffi.org> parents: 480 diff changeset	421 expanded = jid
965 5b95ce21c2d3 jp: fixed jid unicode decoding Goffi <goffi@goffi.org> parents: 964 diff changeset	422 return expanded.decode('utf-8')
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	423
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	424 def check(jid):
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	425 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	426 log.error (_("%s is not a valid JID !"), jid)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	427 self.quit(1)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	428
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	429 dest_jids=[]
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	430 try:
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	431 for i in range(len(jids)):
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	432 dest_jids.append(expand_jid(jids[i]))
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	433 check(dest_jids[i])
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	434 except AttributeError:
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	435 pass
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	436
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	437 return dest_jids
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	438
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	439 def connect_profile(self, callback):
1588 823a385235ef jp: fixed bad --connect option check Goffi <goffi@goffi.org> parents: 1544 diff changeset	440 """ 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	441
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	442 @param callback: method to call when profile is connected
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	443 @exit: - 1 when profile is not connected and --connect is not set
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	444 - 1 when the profile doesn't exists
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	445 - 1 when there is a connection error
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	446 """
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	447 # FIXME: need better exit codes
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	448
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	449 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	450 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	451 self.quit(1)
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	452
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	453 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	454 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	455 self.quit(1)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	456
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	457 self.profile = self.bridge.getProfileName(self.args.profile)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	458
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	459 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	460 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	461 self.quit(1)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	462
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	463 try:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	464 start_session = self.args.start_session
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	465 except AttributeError:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	466 pass
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	467 else:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	468 if start_session:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	469 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	470 self._auto_loop = True
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	471 return
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	472 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	473 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	474 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	475 self.quit(1)
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	476 else:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	477 callback()
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	478 return
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	479
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	480
1401 265ff2bd8d67 jp: fixed crash on commands using profile without "connect" option Goffi <goffi@goffi.org> parents: 1396 diff changeset	481 if not hasattr(self.args, 'connect'):
1588 823a385235ef jp: fixed bad --connect option check Goffi <goffi@goffi.org> parents: 1544 diff changeset	482 # 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	483 return
1588 823a385235ef jp: fixed bad --connect option check Goffi <goffi@goffi.org> parents: 1544 diff changeset	484 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	485 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	486 self._auto_loop = True
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	487 return
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	488 else:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	489 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	490 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	491 self.quit(1)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	492
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	493 callback()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	494
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	495 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	496 """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	497 _jid = JID(param_jid)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	498 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	499 #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	500 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	501 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	502 return "%s/%s" % (_jid.bare, main_resource)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	503 return param_jid
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	504
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	505
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	506 class CommandBase(object):
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	507
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	508 def __init__(self, host, name, use_profile=True, use_output=False,
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	509 need_connect=None, help=None, **kwargs):
2098 e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	510 """Initialise CommandBase
e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	511
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	512 @param host: Jp instance
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	513 @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	514 @param use_profile(bool): if True, add profile selection/connection commands
2114 dc5d214f0a3b jp (info/session): added a command to get data on current session Goffi <goffi@goffi.org> parents: 2098 diff changeset	515 @param use_output(bool, unicode): if not False, add --output option
1594 313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	516 @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	517 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	518 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	519 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	520 @param help(unicode): help message to display
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	521 @param **kwargs: args passed to ArgumentParser
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	522 use_* are handled directly, they can be:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	523 - use_progress(bool): if True, add progress bar activation option
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	524 progress* signals will be handled
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	525 - use_verbose(bool): if True, add verbosity option
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	526 @attribute need_loop(bool): to set by commands when loop is needed
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	527 """
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	528 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	529 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	530 self.host = host.host
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	531 except AttributeError:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	532 self.host = host
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	533
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	534 # --profile option
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	535 parents = kwargs.setdefault('parents', set())
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	536 if use_profile:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	537 #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	538 if need_connect is None:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	539 need_connect = True
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	540 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	541 else:
313f2bb7841b jp: profile session can now be started without connection: Goffi <goffi@goffi.org> parents: 1588 diff changeset	542 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	543 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	544 # 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	545 # 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	546
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	547 # --output option
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	548 if use_output:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	549 if use_output == True:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	550 use_output = C.OUTPUT_TEXT
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	551 assert use_output in C.OUTPUT_TYPES
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	552 self._output_type = use_output
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	553 output_parent = argparse.ArgumentParser(add_help=False)
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	554 choices = self.host.getOutputChoices(use_output)
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	555 if not choices:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	556 raise exceptions.InternalError("No choice found for {} output type".format(use_output))
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	557 default = 'default' if 'default' in choices else choices[0]
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	558 output_parent.add_argument('--output', '-O', choices=choices, default=default, help=_(u"Select output format"))
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	559 parents.add(output_parent)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	560
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	561 # other common options
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	562 use_opts = {k:v for k,v in kwargs.iteritems() if k.startswith('use_')}
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	563 for param, do_use in use_opts.iteritems():
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	564 opt=param[4:] # if param is use_verbose, opt is verbose
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	565 if opt not in self.host.parents:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	566 raise exceptions.InternalError(u"Unknown parent option {}".format(opt))
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	567 del kwargs[param]
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	568 if do_use:
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	569 parents.add(self.host.parents[opt])
1600 8d41cd4da2f6 jp: added a --verbose command Goffi <goffi@goffi.org> parents: 1594 diff changeset	570
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	571 self.parser = host.subparsers.add_parser(name, help=help, **kwargs)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	572 if hasattr(self, "subcommands"):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	573 self.subparsers = self.parser.add_subparsers()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	574 else:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	575 self.parser.set_defaults(func=self.run)
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	576 self.add_parser_options()
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	577
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	578 @property
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	579 def args(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	580 return self.host.args
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	581
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	582 @property
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	583 def profile(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	584 return self.host.profile
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	585
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	586 @property
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	587 def progress_id(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	588 return self.host.progress_id
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	589
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	590 @progress_id.setter
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	591 def progress_id(self, value):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	592 self.host.progress_id = value
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	593
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	594 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	595 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	596 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	597 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	598 # 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	599 # 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	600 # 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	601 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	602 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	603 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	604 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	605 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	606 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	607 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	608 self.onProgressStarted(metadata)
2098 e0066920a661 primitivus, jp: dynamic bridge + fixed D-Bus bridge: Goffi <goffi@goffi.org> parents: 2086 diff changeset	609 self.loop.call_later(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	610
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	611 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	612 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	613 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	614 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	615 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	616 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	617 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	618 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	619 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	620 if self.host.quit_on_progress_end:
1918 01d56efd488b jp: fixed traceback shown on a normal quit when a progression is finished Goffi <goffi@goffi.org> parents: 1884 diff changeset	621 self.host.quitFromSignal()
1627 5a641e7b858a jp (base, file): use of new progress API. Progress callbacks are managed through CommandBase.onProgress* method instead of host attributes. Goffi <goffi@goffi.org> parents: 1623 diff changeset	622
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	623 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	624 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	625 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	626 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	627 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	628 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	629 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	630 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	631 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	632
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	633 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	634 """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	635 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	636 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	637 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	638 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	639 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	640 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	641 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	642 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	643 #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	644 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	645 [_(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	646 " ",
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	647 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	648 " ",
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	649 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	650 " ",
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	651 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	652 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	653
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	654 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	655
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	656 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	657 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	658
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	659 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	660
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	661 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	662
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	663 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	664 """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	665
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	666 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	667 @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	668 """
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	669 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	670
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	671 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	672 """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	673
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	674 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	675 @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	676 """
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	677 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	678
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	679 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	680 """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	681
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	682 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	683 @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	684 """
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	685 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	686
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	687 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	688 """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	689
39545dc527a1 jp: an onProgressUpdate method is now called on each progress update, allowing to handle metadata Goffi <goffi@goffi.org> parents: 1766 diff changeset	690 @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	691 """
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	692 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	693
1605 0aded9648c5c jp (base): added a self.disp method which manage verbosity and stderr + verbosity property Goffi <goffi@goffi.org> parents: 1604 diff changeset	694 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	695 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	696
1950 227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	697 def output(self, data):
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	698 return self.host.output(self._output_type, self.args.output, data)
227a4e617549 jp: --output option: Goffi <goffi@goffi.org> parents: 1945 diff changeset	699
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	700 def add_parser_options(self):
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	701 try:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	702 subcommands = self.subcommands
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	703 except AttributeError:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	704 # We don't have subcommands, the class need to implements add_parser_options
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	705 raise NotImplementedError
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	706
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	707 # now we add subcommands to ourself
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	708 for cls in subcommands:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	709 cls(self)
814 59c7bc51c323 jp: refactoring using ArgParse Dal <kedals0@gmail.com> parents: 811 diff changeset	710
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	711 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	712 """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	713
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	714 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	715 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	716 """
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	717 # 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	718 # 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	719 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	720
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	721 try:
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	722 show_progress = self.args.progress
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	723 except AttributeError:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	724 # the command doesn't use progress bar
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	725 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	726 else:
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	727 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	728 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	729 # we need to register the following signal even if we don't display the progress bar
2119 469702b46768 jp (core): fixed signal registration for progressions Goffi <goffi@goffi.org> parents: 2114 diff changeset	730 self.host.bridge.register_signal("progressStarted", self.progressStartedHandler)
469702b46768 jp (core): fixed signal registration for progressions Goffi <goffi@goffi.org> parents: 2114 diff changeset	731 self.host.bridge.register_signal("progressFinished", self.progressFinishedHandler)
469702b46768 jp (core): fixed signal registration for progressions Goffi <goffi@goffi.org> parents: 2114 diff changeset	732 self.host.bridge.register_signal("progressError", self.progressErrorHandler)
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	733
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	734 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	735 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	736 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	737 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	738
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	739 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	740 """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	741
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	742 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	743 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	744 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	745 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	746 """
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	747 if not self.need_loop:
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	748 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	749 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	750
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	751 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	752 """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	753
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	754 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	755 """
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	756 pass
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	757
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	758
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	759 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	760 """Specialised commands which answer to specific actions
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	761
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	762 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	763 """
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	764 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	765 # 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	766 # 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	767 # 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	768
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	769 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	770 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	771 return
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	772 try:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	773 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	774 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	775 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	776 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	777 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	778 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	779 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	780 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	781 else:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	782 try:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	783 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	784 except KeyError:
de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	785 pass
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	786 else:
1606 de785fcf9a7b jp (base, file): file command and progress fixes and adaptation to new API: Goffi <goffi@goffi.org> parents: 1605 diff changeset	787 callback(action_data, action_id, security_limit, profile)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	788
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	789 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	790 """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	791
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	792 @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	793 """
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	794 # 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	795 # 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	796 # 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	797 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	798 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	799 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	800 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	801
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	802 def connected(self):
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: 393 diff changeset	803 """Auto reply to confirmations requests"""
817 c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	804 self.need_loop = True
c39117d00f35 jp: refactoring: Goffi <goffi@goffi.org> parents: 814 diff changeset	805 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	806 self.host.bridge.register("actionNew", self.onActionNew)
1623 ec48b35309dc jp: use the new actionsGet method Goffi <goffi@goffi.org> parents: 1606 diff changeset	807 actions = self.host.bridge.actionsGet(self.profile)
ec48b35309dc jp: use the new actionsGet method Goffi <goffi@goffi.org> parents: 1606 diff changeset	808 for action_data, action_id, security_limit in actions:
ec48b35309dc jp: use the new actionsGet method Goffi <goffi@goffi.org> parents: 1606 diff changeset	809 self.onActionNew(action_data, action_id, security_limit, self.profile)

Mercurial > libervia-backend

annotate frontends/src/jp/base.py @ 2126:2f264f3df280