[WIP] Ofono bridge

00-ofono.rules

@@ -0,0 +1,2 @@
+KERNEL=="ttyAMA0", ENV{OFONO_DRIVER}="sim900"
+

apps/personal/contacts/vcard_converter.py

@@ -1,9 +1,9 @@
-from helpers import setup_logger
-logger = setup_logger(__name__, "warning")
-
 import vobject
 
 from address_book import Contact
+from helpers import setup_logger
+
+logger = setup_logger(__name__)
 
 
 class VCardContactConverter(object):
@@ -52,3 +52,9 @@ def from_vcards(contact_card_files):
             contacts += VCardContactConverter.parse_vcard_file(file_path)
         logger.info("finished : {} contacts loaded", len(contacts))
         return [VCardContactConverter.to_zpui_contact(c) for c in contacts]
+
+    @classmethod
+    def from_string(cls, vcard_string):
+        # type: (str) -> list
+        # Returns a list of ZPUI contacts from a string in vcard format
+        return [c for c in vobject.readComponents(vcard_string, ignoreUnreadable=True)]

ofono/bridge.py

@@ -0,0 +1,147 @@
+import errno
+import logging
+import os
+from time import sleep
+
+import pydbus
+from dbus.mainloop.glib import DBusGMainLoop
+from gi.repository import GLib
+
+from helpers import Singleton, setup_logger
+
+logger = setup_logger(__name__, 'debug')
+logging.basicConfig(level=logging.DEBUG)
+
+
+class OfonoBridge(object):
+    """
+    Generic util class to bridge between ZPUI and ofono backend through D-Bus
+    """
+
+    def __init__(self):
+        self.modem_path = '/sim900_0'
+        self._check_default_modem()
+
+    def _check_default_modem(self):
+        bus = pydbus.SystemBus()
+        manager = bus.get('org.ofono', '/')
+        modem_path = manager.GetModems()[0][0]
+        if modem_path != self.modem_path:
+            raise ValueError("Default modem should be '{}', was '{}'".format(self.modem_path, modem_path))
+
+    def start(self):
+        self.power_on()
+        self._init_messages()
+        self._listen_messages()
+
+    @property
+    def _bus(self):
+        """SystemBus().get() returns a snapshot of the current exposed methods. Having it as a property ensures we always
+        have the latest snapshot (as opposed to storing it on start/after-init)"""
+        return pydbus.SystemBus().get('org.ofono', self.modem_path)
+
+    @property
+    def message_manager(self):
+        return self._get_dbus_interface('MessageManager')
+
+    def _get_dbus_interface(self, name):
+        full_name = name if name.startswith('org.ofono') else 'org.ofono.{}'.format(name)
+        if full_name in self._bus.GetProperties()['Interfaces']:
+            return self._bus[full_name]
+        raise Exception("Interface '{}' wasn't found on ofono D-Bus".format(full_name))
+
+    def power_on(self):
+        if self._bus.GetProperties()["Powered"]:
+            logger.info("Modem already powered up !")
+        else:
+            logger.info("Powering up modem...")
+            try:
+                self._bus.SetProperty("Powered", pydbus.Variant('b', True))
+                sleep(2)  # Let the modem some time to initialize
+            except Exception as e:
+                logger.error("Couldn't power up the modem !")
+                logger.exception(e)
+
+    def power_off(self):
+        self._bus.SetProperty("Powered", pydbus.Variant('b', False))
+
+    def send_sms(self, to, content):  # todo : untested
+        self.message_manager.SendMessage(to, content)
+        logger.info("Sending message to '{}'".format(to))
+        ConversationManager().on_new_message_sent(to, content)
+
+    @staticmethod
+    def on_message_received(message, details, path=None, interface=None):  # todo : untested
+        logger.info("Got message with path {}".format(path))
+        ConversationManager().on_new_message_received(message, details)
+
+    def _listen_messages(self):
+        logger.info("Connecting to dbus callbacks")
+        self.message_manager.IncomingMessage.connect(self.on_message_received)
+        self.message_manager.ImmediateMessage.connect(self.on_message_received)
+
+    def _init_messages(self):
+        self.message_manager.SetProperty("UseDeliveryReports", pydbus.Variant('b', True))
+
+
+class ConversationManager(Singleton):
+    """
+    Singleton dedicated to conversations. Logs every message sent and received in a flat file
+    for any given phone number
+    """
+
+    def __init__(self):
+        super(ConversationManager, self).__init__()
+        self.folder = os.path.expanduser("~/.phone/sms/")  # todo: store as a constant somewhere
+        self._create_folder()
+
+    def _create_folder(self):
+        if not os.path.exists(self.folder):
+            try:
+                os.makedirs(self.folder)
+            except OSError as exc:  # os.makedirs(exist_ok=True) does not exist for python <= 3.2
+                if exc.errno == errno.EEXIST and os.path.isdir(self.folder):
+                    pass
+                else:
+                    raise
+
+    def on_new_message_sent(self, to, content):
+        logger.info("Sent message to '{}'".format(to))
+        self._write_log(to, self._format_log(content, from_me=True))
+
+    def on_new_message_received(self, content, details):
+        origin = details['Sender']
+        logger.info("Received message from'{}'".format(origin))
+        self._write_log(origin, self._format_log(content, from_me=True))
+
+    def _write_log(self, phone_number, log):
+        with open(self._get_log_path(phone_number), 'a+') as log_file:
+            log_file.write(log)
+
+    def _get_log_path(self, phone_number):
+        file_name = "{}.txt".format(phone_number)
+        return os.path.join(self.folder, file_name)
+
+    @staticmethod
+    def _format_log(content, from_me=True):
+        start_char = '>' if from_me else '<'
+        return "{prefix}\t{msg}\n".format(prefix=start_char, msg=content)
+
+
+def main():
+    DBusGMainLoop(set_as_default=True)  # has to be called first
+    ofono = OfonoBridge()
+    try:
+        ofono.start()
+        mainloop = GLib.MainLoop()  # todo : own thread
+        mainloop.run()
+    except KeyboardInterrupt:
+        logger.info("Caught CTRL-C : exiting without powering off...")
+    except Exception as e:
+        logger.error("Error while starting ofono bridge ! Powering off...")
+        logger.exception(e)
+        ofono.power_off()
+
+
+if __name__ == '__main__':
+    main()

requirements.txt

@@ -1,3 +1,4 @@
+pydbus
 luma.oled
 python-nmap
 smspdu