annotate src/bridge/bridge.py @ 817:c39117d00f35

jp: refactoring: - imports from sat_frontends.jp instead of local imports - added __init__.py - commands now inherits from a base class: each base.CommandBase instance is a subcommand - new arguments are added in CommandBase.add_parser_options methods, starting point si CommandBase.run or CommandBase.connected if a profile connection is needed - commands are exported using a __commands__ variable at the top of the module - sub-subcommand are easily added by using an other CommandBase instance as parent instead of using a Jp instance. In this case, the parent subcommand must be the one exported, and have a subcommands iterable (see cmd_file or cmd_pipe for examples). - options which are often used (like --profile) are automatically added on demand (use_profile=True, use_progress=True) - commands are automatically loaded when there are in a module named cmd_XXX - restored --connect option - restored progress bar - restored getVersion bridge call on jp --version - fixed file and pipe commands - fixed forgotten translations - fixed non SàT compliant docstrings - better about/version dialog
author Goffi <goffi@goffi.org>
date Mon, 10 Feb 2014 13:44:09 +0100
parents 1fe00f0c9a91
children 1597fb8b9108
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
goffi@necton2
parents:
diff changeset
1 #!/usr/bin/python
goffi@necton2
parents:
diff changeset
2 #-*- coding: utf-8 -*-
goffi@necton2
parents:
diff changeset
3
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 595
diff changeset
4 # SAT: a jabber client
811
1fe00f0c9a91 dates update
Goffi <goffi@goffi.org>
parents: 777
diff changeset
5 # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 Jérôme Poisson (goffi@goffi.org)
0
goffi@necton2
parents:
diff changeset
6
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 595
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: 595
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: 595
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: 595
diff changeset
10 # (at your option) any later version.
0
goffi@necton2
parents:
diff changeset
11
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 595
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: 595
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: 595
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: 595
diff changeset
15 # GNU Affero General Public License for more details.
0
goffi@necton2
parents:
diff changeset
16
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 595
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: 595
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
0
goffi@necton2
parents:
diff changeset
19
goffi@necton2
parents:
diff changeset
20 from logging import debug, info, error
goffi@necton2
parents:
diff changeset
21
595
1f160467f5de Fix pep8 support in src/bridge.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
22
568
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/
Goffi <goffi@goffi.org>
parents: 480
diff changeset
23 class Bridge(object):
0
goffi@necton2
parents:
diff changeset
24 def __init__(self):
595
1f160467f5de Fix pep8 support in src/bridge.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
25 info("Bridge initialization")
0
goffi@necton2
parents:
diff changeset
26
goffi@necton2
parents:
diff changeset
27 ##signals
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
28 def newContact(self, contact):
0
goffi@necton2
parents:
diff changeset
29 raise NotImplementedError
goffi@necton2
parents:
diff changeset
30
goffi@necton2
parents:
diff changeset
31 def newMessage(self, from_jid, msg, type='chat'):
goffi@necton2
parents:
diff changeset
32 raise NotImplementedError
goffi@necton2
parents:
diff changeset
33
goffi@necton2
parents:
diff changeset
34 def presenceUpdate(self, type, jid, show, status, priority):
goffi@necton2
parents:
diff changeset
35 raise NotImplementedError
goffi@necton2
parents:
diff changeset
36
goffi@necton2
parents:
diff changeset
37 def paramUpdate(self, name, value):
goffi@necton2
parents:
diff changeset
38 raise NotImplementedError
goffi@necton2
parents:
diff changeset
39
goffi@necton2
parents:
diff changeset
40 ##methods
goffi@necton2
parents:
diff changeset
41 def connect(self):
goffi@necton2
parents:
diff changeset
42 raise NotImplementedError
goffi@necton2
parents:
diff changeset
43
goffi@necton2
parents:
diff changeset
44 def getContacts(self):
goffi@necton2
parents:
diff changeset
45 raise NotImplementedError
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
46
0
goffi@necton2
parents:
diff changeset
47 def getPresenceStatus(self):
goffi@necton2
parents:
diff changeset
48 raise NotImplementedError
goffi@necton2
parents:
diff changeset
49
goffi@necton2
parents:
diff changeset
50 def sendMessage(self):
goffi@necton2
parents:
diff changeset
51 raise NotImplementedError
goffi@necton2
parents:
diff changeset
52
goffi@necton2
parents:
diff changeset
53 def setPresence(self, to="", type="", show="", status="", priority=0):
goffi@necton2
parents:
diff changeset
54 raise NotImplementedError
goffi@necton2
parents:
diff changeset
55
goffi@necton2
parents:
diff changeset
56 def setParam(self, name, value, namespace):
goffi@necton2
parents:
diff changeset
57 raise NotImplementedError
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
58
0
goffi@necton2
parents:
diff changeset
59 def getParam(self, name, namespace):
goffi@necton2
parents:
diff changeset
60 raise NotImplementedError
goffi@necton2
parents:
diff changeset
61
777
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters
souliane <souliane@mailoo.org>
parents: 634
diff changeset
62 def getParams(self, security_limit, app, namespace):
0
goffi@necton2
parents:
diff changeset
63 raise NotImplementedError
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
64
0
goffi@necton2
parents:
diff changeset
65 def getHistory(self, from_jid, to_jid, size):
goffi@necton2
parents:
diff changeset
66 raise NotImplementedError