annotate src/tools/common/dynamic_import.py @ 2144:1d3f73e065e1

core, jp: component handling + client handling refactoring: - SàT can now handle components - plugin have now a "modes" key in PLUGIN_INFO where they declare if they can be used with clients and or components. They default to be client only. - components are really similar to clients, but with some changes in behaviour: * component has "entry point", which is a special plugin with a componentStart method, which is called just after component is connected * trigger end with a different suffixes (e.g. profileConnected vs profileConnectedComponent), so a plugin which manage both clients and components can have different workflow * for clients, only triggers of plugins handling client mode are launched * for components, only triggers of plugins needed in dependencies are launched. They all must handle component mode. * component have a sendHistory attribute (False by default) which can be set to True to allow saving sent messages into history * for convenience, "client" is still used in method even if it can now be a component * a new "component" boolean attribute tells if we have a component or a client * components have to add themselve Message protocol * roster and presence protocols are not added for components * component default port is 5347 (which is Prosody's default port) - asyncCreateProfile has been renamed for profileCreate, both to follow new naming convention and to prepare the transition to fully asynchronous bridge - createProfile has a new "component" attribute. When used to create a component, it must be set to a component entry point - jp: added --component argument to profile/create - disconnect bridge method is now asynchronous, this way frontends can know when disconnection is finished - new PI_* constants for PLUGIN_INFO values (not used everywhere yet) - client/component connection workflow has been moved to their classes instead of being a host methods - host.messageSend is now client.sendMessage, and former client.sendMessage is now client.sendMessageData. - identities are now handled in client.identities list, so it can be updated dynamically by plugins (in the future, frontends should be able to update them too through bridge) - profileConnecting* profileConnected* profileDisconnected* and getHandler now all use client instead of profile
author Goffi <goffi@goffi.org>
date Sun, 12 Feb 2017 17:55:43 +0100
parents c02f96756d5c
children 8b37a62336c3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2088
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
1 #!/usr/bin/env python2
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
2 # -*- coding: utf-8 -*-
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
3
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
4 # SàT: a XMPP
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
5 # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org)
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
6
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # This program is free software: you can redistribute it and/or modify
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
10 # (at your option) any later version.
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
11
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # This program is distributed in the hope that it will be useful,
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
15 # GNU Affero General Public License for more details.
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
16
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
19
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
20 """ tools dynamic import """
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
21
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
22 from importlib import import_module
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
23
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
24
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
25 def bridge(name, module_path='sat.bridge'):
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
26 """Import bridge module
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
27
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
28 @param module_path(str): path of the module to import
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
29 @param name(str): name of the bridge to import (e.g.: dbus)
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
30 @return (module, None): imported module or None if nothing is found
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
31 """
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
32 try:
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
33 bridge_module = import_module(module_path + '.' + name)
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
34 except ImportError:
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
35 try:
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
36 bridge_module = import_module(module_path + '.' + name + '_bridge')
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
37 except ImportError:
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
38 bridge_module = None
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
39 return bridge_module