Mercurial > libervia-backend
annotate frontends/src/jp/cmd_profile.py @ 1950:227a4e617549
jp: --output option:
- new --output option can be added wich use_output. use_output can be True (in which case it wild default to C.OUTPUT_TEXT), or any of C.OUTPUT_TYPES (currently text, list and dict)
- output change the output format mainly to make command result parsing more easy, but it can also be use to add fancy effects (like coloration)
- outputs are added with plugins in the same way as commands (import of both is done in the same method)
- in the command class, output need to be declared with use_output=C.OUTPUT_xxx, then the data only need to be processed with self.output(data)
- outputs can have description (not used yet)
- use_xxx argument handling has been refactored (minor refactoring) to be more generic
- first outputs are "default", "json" (pretty printed) and "json_raw" (compact json)
- the first command to use them is "profile list"
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sat, 23 Apr 2016 23:10:03 +0200 |
| parents | 96ba685162f6 |
| children | 5fbe09b9b568 |
| rev | line source |
|---|---|
| 815 | 1 #! /usr/bin/python |
| 2 # -*- coding: utf-8 -*- | |
| 3 | |
| 4 # jp: a SAT command line tool | |
| 1766 | 5 # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org) |
| 815 | 6 |
| 7 # This program is free software: you can redistribute it and/or modify | |
| 8 # it under the terms of the GNU Affero General Public License as published by | |
| 9 # the Free Software Foundation, either version 3 of the License, or | |
| 10 # (at your option) any later version. | |
| 11 | |
| 12 # This program is distributed in the hope that it will be useful, | |
| 13 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 # GNU Affero General Public License for more details. | |
| 16 | |
| 17 # You should have received a copy of the GNU Affero General Public License | |
| 18 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 | |
| 814 | 20 """This module permits to manage profiles. It can list, create, delete |
| 1199 | 21 and retrieve information about a profile.""" |
| 0 | 22 |
| 1596 | 23 import logging as log |
| 771 | 24 from sat.core.i18n import _ |
| 817 | 25 from sat_frontends.jp import base |
|
402
f03688bdb858
jp: use with statement to open fifo
Goffi <goffi@goffi.org>
parents:
401
diff
changeset
|
26 |
| 817 | 27 __commands__ = ["Profile"] |
| 28 | |
| 29 PROFILE_HELP = _('The name of the profile') | |
| 0 | 30 |
| 31 | |
| 1597 | 32 class ProfileConnect(base.CommandBase): |
| 33 """Dummy command to use profile_session parent, i.e. to be able to connect without doing anything else""" | |
| 34 | |
| 35 def __init__(self, host): | |
| 36 # it's weird to have a command named "connect" with need_connect=False, but it can be handy to be able | |
| 37 # to launch just the session, so some paradox don't hurt | |
| 38 super(ProfileConnect, self).__init__(host, 'connect', need_connect=False, help=_('connect a profile')) | |
| 39 | |
| 40 def add_parser_options(self): | |
| 41 pass | |
| 42 | |
| 43 | |
| 1596 | 44 class ProfileDefault(base.CommandBase): |
| 45 def __init__(self, host): | |
| 46 super(ProfileDefault, self).__init__(host, 'default', use_profile=False, help=_('print default profile')) | |
| 47 | |
| 48 def add_parser_options(self): | |
| 49 pass | |
| 50 | |
|
1864
96ba685162f6
jp: all commands now use the new start method and set need_loop in __init__ when needed
Goffi <goffi@goffi.org>
parents:
1861
diff
changeset
|
51 def start(self): |
| 1596 | 52 print self.host.bridge.getProfileName('@DEFAULT@') |
| 53 | |
| 54 | |
| 817 | 55 class ProfileDelete(base.CommandBase): |
| 56 def __init__(self, host): | |
| 1596 | 57 super(ProfileDelete, self).__init__(host, 'delete', use_profile=False, help=_('delete a profile')) |
| 817 | 58 |
| 59 def add_parser_options(self): | |
| 60 self.parser.add_argument('profile', type=str, help=PROFILE_HELP) | |
|
1861
3b2a236fa743
jp (profile): added confirmation and --force arguement to profile/delete
Goffi <goffi@goffi.org>
parents:
1766
diff
changeset
|
61 self.parser.add_argument('-f', '--force', action='store_true', help=_(u'delete profile without confirmation')) |
| 0 | 62 |
|
1864
96ba685162f6
jp: all commands now use the new start method and set need_loop in __init__ when needed
Goffi <goffi@goffi.org>
parents:
1861
diff
changeset
|
63 def start(self): |
| 817 | 64 if self.args.profile not in self.host.bridge.getProfilesList(): |
| 1596 | 65 log.error("Profile %s doesn't exist." % self.args.profile) |
| 817 | 66 self.host.quit(1) |
|
1861
3b2a236fa743
jp (profile): added confirmation and --force arguement to profile/delete
Goffi <goffi@goffi.org>
parents:
1766
diff
changeset
|
67 message = u"Are you sure to delete profile [{}] ?".format(self.args.profile) |
|
3b2a236fa743
jp (profile): added confirmation and --force arguement to profile/delete
Goffi <goffi@goffi.org>
parents:
1766
diff
changeset
|
68 if not self.args.force: |
|
3b2a236fa743
jp (profile): added confirmation and --force arguement to profile/delete
Goffi <goffi@goffi.org>
parents:
1766
diff
changeset
|
69 res = raw_input("{} (y/N)? ".format(message)) |
|
3b2a236fa743
jp (profile): added confirmation and --force arguement to profile/delete
Goffi <goffi@goffi.org>
parents:
1766
diff
changeset
|
70 if res not in ("y", "Y"): |
|
3b2a236fa743
jp (profile): added confirmation and --force arguement to profile/delete
Goffi <goffi@goffi.org>
parents:
1766
diff
changeset
|
71 self.disp(_(u"Profile deletion cancelled")) |
|
3b2a236fa743
jp (profile): added confirmation and --force arguement to profile/delete
Goffi <goffi@goffi.org>
parents:
1766
diff
changeset
|
72 self.host.quit(2) |
|
3b2a236fa743
jp (profile): added confirmation and --force arguement to profile/delete
Goffi <goffi@goffi.org>
parents:
1766
diff
changeset
|
73 |
|
893
308a96bc7c1b
core, frontends: add method asyncDeleteProfile, remove synchronous methods createProfile and deleteProfile
souliane <souliane@mailoo.org>
parents:
817
diff
changeset
|
74 self.host.bridge.asyncDeleteProfile(self.args.profile, callback=lambda dummy: None) |
| 817 | 75 |
| 0 | 76 |
| 817 | 77 class ProfileInfo(base.CommandBase): |
| 78 def __init__(self, host): | |
| 1596 | 79 super(ProfileInfo, self).__init__(host, 'info', need_connect=False, help=_('get information about a profile')) |
|
1864
96ba685162f6
jp: all commands now use the new start method and set need_loop in __init__ when needed
Goffi <goffi@goffi.org>
parents:
1861
diff
changeset
|
80 self.need_loop = True |
| 1596 | 81 self.to_show = [(_(u"jid"), "Connection", "JabberID"),] |
|
1402
391b0c21f4be
jp (profile): fixed "profile info" to use profile, and then manage connection.
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
82 self.largest = max([len(item[0]) for item in self.to_show]) |
|
391b0c21f4be
jp (profile): fixed "profile info" to use profile, and then manage connection.
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
83 |
| 0 | 84 |
| 817 | 85 def add_parser_options(self): |
| 1596 | 86 self.parser.add_argument('--show-password', action='store_true', help=_(u'show the XMPP password IN CLEAR TEXT')) |
| 814 | 87 |
|
1402
391b0c21f4be
jp (profile): fixed "profile info" to use profile, and then manage connection.
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
88 def showNextValue(self, label=None, category=None, value=None): |
|
391b0c21f4be
jp (profile): fixed "profile info" to use profile, and then manage connection.
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
89 """Show next value from self.to_show and quit on last one""" |
|
391b0c21f4be
jp (profile): fixed "profile info" to use profile, and then manage connection.
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
90 if label is not None: |
|
391b0c21f4be
jp (profile): fixed "profile info" to use profile, and then manage connection.
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
91 print((u"{label:<"+unicode(self.largest+2)+"}{value}").format(label=label+": ", value=value)) |
|
391b0c21f4be
jp (profile): fixed "profile info" to use profile, and then manage connection.
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
92 try: |
|
391b0c21f4be
jp (profile): fixed "profile info" to use profile, and then manage connection.
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
93 label, category, name = self.to_show.pop(0) |
|
391b0c21f4be
jp (profile): fixed "profile info" to use profile, and then manage connection.
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
94 except IndexError: |
|
391b0c21f4be
jp (profile): fixed "profile info" to use profile, and then manage connection.
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
95 self.host.quit() |
|
391b0c21f4be
jp (profile): fixed "profile info" to use profile, and then manage connection.
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
96 else: |
|
391b0c21f4be
jp (profile): fixed "profile info" to use profile, and then manage connection.
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
97 self.host.bridge.asyncGetParamA(name, category, profile_key=self.host.profile, |
|
391b0c21f4be
jp (profile): fixed "profile info" to use profile, and then manage connection.
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
98 callback=lambda value: self.showNextValue(label, category, value)) |
| 814 | 99 |
|
1864
96ba685162f6
jp: all commands now use the new start method and set need_loop in __init__ when needed
Goffi <goffi@goffi.org>
parents:
1861
diff
changeset
|
100 def start(self): |
| 1596 | 101 if self.args.show_password: |
| 102 self.to_show.append((_(u"XMPP password"), "Connection", "Password")) | |
|
1402
391b0c21f4be
jp (profile): fixed "profile info" to use profile, and then manage connection.
Goffi <goffi@goffi.org>
parents:
1396
diff
changeset
|
103 self.showNextValue() |
| 817 | 104 |
| 105 | |
| 106 class ProfileList(base.CommandBase): | |
| 107 def __init__(self, host): | |
| 1950 | 108 super(ProfileList, self).__init__(host, 'list', use_profile=False, use_output='list', help=_('list profiles')) |
| 657 | 109 |
| 817 | 110 def add_parser_options(self): |
| 111 pass | |
| 112 | |
|
1864
96ba685162f6
jp: all commands now use the new start method and set need_loop in __init__ when needed
Goffi <goffi@goffi.org>
parents:
1861
diff
changeset
|
113 def start(self): |
| 1950 | 114 self.output(self.host.bridge.getProfilesList()) |
| 817 | 115 |
| 814 | 116 |
| 817 | 117 class ProfileCreate(base.CommandBase): |
| 118 def __init__(self, host): | |
| 1597 | 119 super(ProfileCreate, self).__init__(host, 'create', use_profile=False, help=_('create a new profile')) |
|
1864
96ba685162f6
jp: all commands now use the new start method and set need_loop in __init__ when needed
Goffi <goffi@goffi.org>
parents:
1861
diff
changeset
|
120 self.need_loop = True |
| 657 | 121 |
| 817 | 122 def add_parser_options(self): |
| 123 self.parser.add_argument('profile', type=str, help=_('the name of the profile')) | |
|
1403
f913b09cd9cc
jp (profile): in "profile create", jid and password arguments are now optional + added a new --xmpp-password option to set XMPP password separately (default to the same password as for profile).
Goffi <goffi@goffi.org>
parents:
1402
diff
changeset
|
124 self.parser.add_argument('-p', '--password', type=str, default='', help=_('the password of the profile')) |
|
f913b09cd9cc
jp (profile): in "profile create", jid and password arguments are now optional + added a new --xmpp-password option to set XMPP password separately (default to the same password as for profile).
Goffi <goffi@goffi.org>
parents:
1402
diff
changeset
|
125 self.parser.add_argument('-j', '--jid', type=str, help=_('the jid of the profile')) |
|
f913b09cd9cc
jp (profile): in "profile create", jid and password arguments are now optional + added a new --xmpp-password option to set XMPP password separately (default to the same password as for profile).
Goffi <goffi@goffi.org>
parents:
1402
diff
changeset
|
126 self.parser.add_argument('-x', '--xmpp-password', type=str, help=_('the password of the XMPP account (use profile password if not specified)'), |
|
f913b09cd9cc
jp (profile): in "profile create", jid and password arguments are now optional + added a new --xmpp-password option to set XMPP password separately (default to the same password as for profile).
Goffi <goffi@goffi.org>
parents:
1402
diff
changeset
|
127 metavar='PASSWORD') |
| 817 | 128 |
|
1702
bc7e3ff3c838
jp (profile): fixed creating profile with given JID and XMPP password
souliane <souliane@mailoo.org>
parents:
1687
diff
changeset
|
129 def _session_started(self, dummy): |
|
1403
f913b09cd9cc
jp (profile): in "profile create", jid and password arguments are now optional + added a new --xmpp-password option to set XMPP password separately (default to the same password as for profile).
Goffi <goffi@goffi.org>
parents:
1402
diff
changeset
|
130 if self.args.jid: |
|
f913b09cd9cc
jp (profile): in "profile create", jid and password arguments are now optional + added a new --xmpp-password option to set XMPP password separately (default to the same password as for profile).
Goffi <goffi@goffi.org>
parents:
1402
diff
changeset
|
131 self.host.bridge.setParam("JabberID", self.args.jid, "Connection" ,profile_key=self.args.profile) |
|
f913b09cd9cc
jp (profile): in "profile create", jid and password arguments are now optional + added a new --xmpp-password option to set XMPP password separately (default to the same password as for profile).
Goffi <goffi@goffi.org>
parents:
1402
diff
changeset
|
132 xmpp_pwd = self.args.password or self.args.xmpp_password |
|
f913b09cd9cc
jp (profile): in "profile create", jid and password arguments are now optional + added a new --xmpp-password option to set XMPP password separately (default to the same password as for profile).
Goffi <goffi@goffi.org>
parents:
1402
diff
changeset
|
133 if xmpp_pwd: |
|
f913b09cd9cc
jp (profile): in "profile create", jid and password arguments are now optional + added a new --xmpp-password option to set XMPP password separately (default to the same password as for profile).
Goffi <goffi@goffi.org>
parents:
1402
diff
changeset
|
134 self.host.bridge.setParam("Password", xmpp_pwd, "Connection", profile_key=self.args.profile) |
| 817 | 135 self.host.quit() |
| 657 | 136 |
|
1702
bc7e3ff3c838
jp (profile): fixed creating profile with given JID and XMPP password
souliane <souliane@mailoo.org>
parents:
1687
diff
changeset
|
137 def _profile_created(self): |
|
bc7e3ff3c838
jp (profile): fixed creating profile with given JID and XMPP password
souliane <souliane@mailoo.org>
parents:
1687
diff
changeset
|
138 self.host.bridge.profileStartSession(self.args.password, self.args.profile, callback=self._session_started, errback=None) |
|
bc7e3ff3c838
jp (profile): fixed creating profile with given JID and XMPP password
souliane <souliane@mailoo.org>
parents:
1687
diff
changeset
|
139 |
|
1864
96ba685162f6
jp: all commands now use the new start method and set need_loop in __init__ when needed
Goffi <goffi@goffi.org>
parents:
1861
diff
changeset
|
140 def start(self): |
| 814 | 141 """Create a new profile""" |
| 817 | 142 if self.args.profile in self.host.bridge.getProfilesList(): |
| 1596 | 143 log.error("Profile %s already exists." % self.args.profile) |
| 817 | 144 self.host.quit(1) |
|
1403
f913b09cd9cc
jp (profile): in "profile create", jid and password arguments are now optional + added a new --xmpp-password option to set XMPP password separately (default to the same password as for profile).
Goffi <goffi@goffi.org>
parents:
1402
diff
changeset
|
145 self.host.bridge.asyncCreateProfile(self.args.profile, self.args.password, callback=self._profile_created, errback=None) |
| 0 | 146 |
| 817 | 147 |
|
1404
e4e960d285b0
jp (profile): added "profile modify" command
Goffi <goffi@goffi.org>
parents:
1403
diff
changeset
|
148 class ProfileModify(base.CommandBase): |
|
e4e960d285b0
jp (profile): added "profile modify" command
Goffi <goffi@goffi.org>
parents:
1403
diff
changeset
|
149 def __init__(self, host): |
| 1597 | 150 super(ProfileModify, self).__init__(host, 'modify', need_connect=False, help=_('modify an existing profile')) |
|
1404
e4e960d285b0
jp (profile): added "profile modify" command
Goffi <goffi@goffi.org>
parents:
1403
diff
changeset
|
151 |
|
e4e960d285b0
jp (profile): added "profile modify" command
Goffi <goffi@goffi.org>
parents:
1403
diff
changeset
|
152 def add_parser_options(self): |
|
1687
de9cc4d62a4a
jp (profile): fixed profile/modify command:
Goffi <goffi@goffi.org>
parents:
1597
diff
changeset
|
153 profile_pwd_group = self.parser.add_mutually_exclusive_group() |
|
de9cc4d62a4a
jp (profile): fixed profile/modify command:
Goffi <goffi@goffi.org>
parents:
1597
diff
changeset
|
154 profile_pwd_group.add_argument('-w', '--password', type=base.unicode_decoder, help=_('change the password of the profile')) |
|
de9cc4d62a4a
jp (profile): fixed profile/modify command:
Goffi <goffi@goffi.org>
parents:
1597
diff
changeset
|
155 profile_pwd_group.add_argument('--disable-password', action='store_true', help=_('disable profile password (dangerous!)')) |
|
de9cc4d62a4a
jp (profile): fixed profile/modify command:
Goffi <goffi@goffi.org>
parents:
1597
diff
changeset
|
156 self.parser.add_argument('-j', '--jid', type=base.unicode_decoder, help=_('the jid of the profile')) |
|
de9cc4d62a4a
jp (profile): fixed profile/modify command:
Goffi <goffi@goffi.org>
parents:
1597
diff
changeset
|
157 self.parser.add_argument('-x', '--xmpp-password', type=base.unicode_decoder, help=_('change the password of the XMPP account'), |
|
1404
e4e960d285b0
jp (profile): added "profile modify" command
Goffi <goffi@goffi.org>
parents:
1403
diff
changeset
|
158 metavar='PASSWORD') |
| 1596 | 159 self.parser.add_argument('-D', '--default', action='store_true', help=_(u'set as default profile')) |
|
1404
e4e960d285b0
jp (profile): added "profile modify" command
Goffi <goffi@goffi.org>
parents:
1403
diff
changeset
|
160 |
|
1864
96ba685162f6
jp: all commands now use the new start method and set need_loop in __init__ when needed
Goffi <goffi@goffi.org>
parents:
1861
diff
changeset
|
161 def start(self): |
|
1687
de9cc4d62a4a
jp (profile): fixed profile/modify command:
Goffi <goffi@goffi.org>
parents:
1597
diff
changeset
|
162 if self.args.disable_password: |
|
de9cc4d62a4a
jp (profile): fixed profile/modify command:
Goffi <goffi@goffi.org>
parents:
1597
diff
changeset
|
163 self.args.password = '' |
|
1404
e4e960d285b0
jp (profile): added "profile modify" command
Goffi <goffi@goffi.org>
parents:
1403
diff
changeset
|
164 if self.args.password is not None: |
|
e4e960d285b0
jp (profile): added "profile modify" command
Goffi <goffi@goffi.org>
parents:
1403
diff
changeset
|
165 self.host.bridge.setParam("Password", self.args.password, "General", profile_key=self.host.profile) |
|
e4e960d285b0
jp (profile): added "profile modify" command
Goffi <goffi@goffi.org>
parents:
1403
diff
changeset
|
166 if self.args.jid is not None: |
|
e4e960d285b0
jp (profile): added "profile modify" command
Goffi <goffi@goffi.org>
parents:
1403
diff
changeset
|
167 self.host.bridge.setParam("JabberID", self.args.jid, "Connection", profile_key=self.host.profile) |
|
e4e960d285b0
jp (profile): added "profile modify" command
Goffi <goffi@goffi.org>
parents:
1403
diff
changeset
|
168 if self.args.xmpp_password is not None: |
|
e4e960d285b0
jp (profile): added "profile modify" command
Goffi <goffi@goffi.org>
parents:
1403
diff
changeset
|
169 self.host.bridge.setParam("Password", self.args.xmpp_password, "Connection", profile_key=self.host.profile) |
| 1596 | 170 if self.args.default: |
| 171 self.host.bridge.profileSetDefault(self.host.profile) | |
|
1404
e4e960d285b0
jp (profile): added "profile modify" command
Goffi <goffi@goffi.org>
parents:
1403
diff
changeset
|
172 |
|
e4e960d285b0
jp (profile): added "profile modify" command
Goffi <goffi@goffi.org>
parents:
1403
diff
changeset
|
173 |
| 817 | 174 class Profile(base.CommandBase): |
| 1597 | 175 subcommands = (ProfileConnect, ProfileCreate, ProfileDefault, ProfileDelete, ProfileInfo, ProfileList, ProfileModify) |
| 817 | 176 |
| 177 def __init__(self, host): | |
| 178 super(Profile, self).__init__(host, 'profile', use_profile=False, help=_('Profile commands')) |