aboutsummaryrefslogtreecommitdiff
path: root/src/ppm/modemproxy.py
blob: 3943b7f138966792724b7b09ff2aa6c61a5bf4ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
# vim: set fileencoding=utf-8 :
#
# (C) 2010 Guido Guenther <agx@sigxcpu.org>
#    This program is free software; you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation; either version 3 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program; if not, see <http://www.gnu.org/licenses/>.

from gi.repository import GObject
from gi.repository import GLib
from gi.repository import Gio

import logging

MM_DBUS_SERVICE = 'org.freedesktop.ModemManager1'
MM_DBUS_TIMEOUT = 5000
MM_DBUS_FLAGS = (Gio.DBusProxyFlags.DO_NOT_LOAD_PROPERTIES |
                 Gio.DBusProxyFlags.DO_NOT_CONNECT_SIGNALS)

class ModemError(Exception):
    def __init__(self, msg):
        self.msg = msg

    def is_forbidden(self):
        return [False, True][self.msg.find("Operation not allowed") != -1]

    def is_disabled(self):
        return [False, True][self.msg.find("not enabled") != -1]


class Modem(GObject.GObject):
    MM_DBUS_INTERFACE_MODEM = 'org.freedesktop.ModemManager1.Modem'
    MM_DBUS_INTERFACE_MODEM_GSM_USSD = "{}.Modem3gpp.Ussd".format(MM_DBUS_INTERFACE_MODEM)

    MM_STATE_ENABLED = 6

    def on_new_proxy_done(self, proxy, res, iface_name):
        try:
            _proxy = proxy.new_for_bus_finish(res)
        except GLib.Error:
            logging.exception("Failed to get iface '%s' for modem %s",
                              iface_name, self.path)
        setattr(self, "_%s_proxy" % iface_name, _proxy)

    def __init__(self, path):
        GObject.GObject.__init__(self)
        self._path = path

        self._modem_proxy = None
        Gio.DBusProxy.new_for_bus(Gio.BusType.SYSTEM,
                                  Gio.DBusProxyFlags.DO_NOT_CONNECT_SIGNALS,
                                  None,
                                  MM_DBUS_SERVICE,
                                  self.path,
                                  self.MM_DBUS_INTERFACE_MODEM,
                                  None,
                                  self.on_new_proxy_done,
                                  'modem')

        self._ussd_proxy = None
        Gio.DBusProxy.new_for_bus(Gio.BusType.SYSTEM,
                                  MM_DBUS_FLAGS,
                                  None,
                                  MM_DBUS_SERVICE,
                                  self.path,
                                  self.MM_DBUS_INTERFACE_MODEM_GSM_USSD,
                                  None,
                                  self.on_new_proxy_done,
                                  'ussd')

    @property
    def path(self):
        return self._path

    @property
    def modem_proxy(self):
        return self._modem_proxy

    @property
    def ussd_proxy(self):
        return self._ussd_proxy

    @property
    def enabled(self):
        variant = self.modem_proxy.get_cached_property("State")
        return variant.get_int32() >= self.MM_STATE_ENABLED


class ModemManagerProxy(GObject.GObject):
    """Interface to ModemManager DBus API
    @ivar request: current pending request to ModemManager
    @type request: string
    @ivar modem: dbus path of modem we're currently acting on
    @type modem: string
    """

    DBUS_INTERFACE_PROPERTIES = 'org.freedesktop.DBus.Properties'
    DBUS_INTERFACE_OBJECT_MANAGER = 'org.freedesktop.DBus.ObjectManager'
    MM_DBUS_INTERFACE_MODEM_MANAGER = 'org.freedesktop.ModemManager1'
    MM_DBUS_OBJECT_MODEM_MANAGER = '/org/freedesktop/ModemManager1'
    MM_DBUS_INTERFACE_SIM = 'org.freedesktop.ModemManager1.Sim'
    # IMSIs are 14 or 15 digits
    IMSI_RE = r'\d{14,15}'

    __gsignals__ = {
        # Emitted when a request to MM starts
        'request-started': (GObject.SignalFlags.RUN_FIRST, None,
                            [object]),
        # Emitted when a request has finished
        'request-finished': (GObject.SignalFlags.RUN_FIRST, None,
                             [object]),
        # Emitted when modem search completed
        'got-modems': (GObject.SignalFlags.RUN_FIRST, None,
                       [object]),
    }

    def on_new_object_manager_done(self, obj, res):
        try:
            proxy = Gio.DBusProxy.new_for_bus_finish(res)
        except GLib.Error:
            logging.exception("Connecting to MM failed")
        else:
            self.object_manager = proxy

    def __init__(self):
        GObject.GObject.__init__(self)
        self.request = None
        self.reply_func = None
        self.error_func = None
        self.modem = None
        self.obj = None
        self.objs = None

        self.object_manager = None
        Gio.DBusProxy.new_for_bus(Gio.BusType.SYSTEM,
                                  MM_DBUS_FLAGS,
                                  None,
                                  MM_DBUS_SERVICE,
                                  self.MM_DBUS_OBJECT_MODEM_MANAGER,
                                  self.DBUS_INTERFACE_OBJECT_MANAGER,
                                  None,
                                  self.on_new_object_manager_done)
        self._modems = []

    def ready(self):
        return True if self.object_manager else False

    def get_objects(self):
        self.objs = self.object_manager.GetManagedObjects()

    def objects(self):
        if self.objs is None:
            self.get_objects()
        return self.objs

    def set_modem(self, modem):
        self.modem = modem

    def mm_request(func):
        def wrapped_f(self, *args, **kw):
            self.request = "%s" % func.__name__
            if 'reply_func' in kw:
                self.reply_func = kw['reply_func']
            if 'error_func' in kw:
                self.error_func = kw['error_func']
            self.emit('request-started', self)
            func(self, *args, **kw)
        wrapped_f.__name__ = func.__name__
        wrapped_f.__doc__ = func.__doc__
        return wrapped_f

    def mm_request_done(func):
        def wrapped_f(self, *args, **kw):
            self.emit('request-finished', self)
            ret = func(self, *args, **kw)
            self.reply_func = None
            self.error_func = None
            self.request = None
            return ret
        wrapped_f.__name__ = func.__name__
        wrapped_f.__doc__ = func.__doc__
        return wrapped_f

    def request_pending(self):
        if self.request:
            return True
        else:
            return False

    @property
    def modems(self):
        return self._modems

    @mm_request_done
    def handle_dbus_reply(self, obj, result, user_data):
        try:
            res = obj.call_finish(result)
            if self.reply_func:
                self.reply_func(res, user_data)
        except Exception as err:
            if self.error_func:
                me = ModemError("%s failed: %s" % (self.request, err))
                self.error_func(me)

    def on_get_managed_objects_finished(self, proxy, res, user_data):
        self._modems = []

        try:
            objs = proxy.call_finish(res)
        except Exception as err:
            logging.error("Failed to get managed modems: %s", err)
            objs = []
            return

        for obj in objs:
            for path, ifaces in obj.items():
                if Modem.MM_DBUS_INTERFACE_MODEM in ifaces:
                    self._modems.append(Modem(path))
        logging.debug("Found modems: %s", self.modems)
        self.emit('got-modems', self)

    def dbus_find_modems(self):
        """
        Async method to find modems

        Result will be in modems property
        """
        self.object_manager.call("GetManagedObjects",
                                 None,
                                 Gio.DBusCallFlags.NO_AUTO_START,
                                 MM_DBUS_TIMEOUT,
                                 None,
                                 self.on_get_managed_objects_finished,
                                 None)

    def get_imsi(self):
        card = Gio.DBusProxy.new_for_bus_sync(
            Gio.BusType.SYSTEM,
            MM_DBUS_FLAGS,
            None,
            MM_DBUS_SERVICE,
            self.objects()[self.modem.path][Modem.MM_DBUS_INTERFACE_MODEM]['Sim'],
            self.DBUS_INTERFACE_PROPERTIES,
            None)
        try:
            return card.Get('(ss)', self.MM_DBUS_INTERFACE_SIM, 'Imsi')
        except Exception as msg:
            raise ModemError("Getting IMSI failed: %s" % msg)

    def get_network_id(self):
        imsi = self.get_imsi()
        mcc = imsi[0:3]
        mnc = imsi[3:5]
        return (mcc, mnc)

    @mm_request
    def ussd_initiate(self, command, reply_func=None, error_func=None):
        self.modem.ussd_proxy.call("Initiate", GLib.Variant('(s)', (command,)),
                                   Gio.DBusCallFlags.NO_AUTO_START, MM_DBUS_TIMEOUT, None,
                                   self.handle_dbus_reply, None)

    @mm_request
    def _modem__enable(self, enable, reply_func=None, error_func=None):
        self.modem.modem_proxy.call("Enable", GLib.Variant('(b)', (enable,)),
                                    Gio.DBusCallFlags.NO_AUTO_START, MM_DBUS_TIMEOUT, None,
                                    self.handle_dbus_reply, None)

    def modem_enable(self, reply_func=None, error_func=None):
        self._modem__enable(True,
                            reply_func=reply_func,
                            error_func=error_func)

    def modem_disable(self, reply_func=None, error_func=None):
        self._modem_enable(False,
                           reply_func=reply_func,
                           error_func=error_func)