Add ModemManager provider

README.md

@@ -8,7 +8,7 @@ Calls is licensed under the GPLv3+.
 
 ## Dependencies
 
-    sudo apt-get install libgtk-3-dev libhandy-0.0-dev
+    sudo apt-get install libgtk-3-dev libhandy-0.0-dev modemmanager-dev libmm-glib-dev
 
 ## Building
 

src/calls-mm-call.c

+/*
+ * Copyright (C) 2018 Purism SPC
+ *
+ * This file is part of Calls.
+ *
+ * Calls 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.
+ *
+ * Calls 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 Calls.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author: Bob Ham <bob.ham@puri.sm>
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
+#include "calls-mm-call.h"
+#include "calls-call.h"
+#include "calls-message-source.h"
+#include "util.h"
+
+#include <libmm-glib/libmm-glib.h>
+#include <glib/gi18n.h>
+
+
+struct _CallsMMCall
+{
+  GObject parent_instance;
+  MMCall *mm_call;
+  GString *number;
+  CallsCallState state;
+  gchar *disconnect_reason;
+};
+
+static void calls_mm_call_message_source_interface_init (CallsCallInterface *iface);
+static void calls_mm_call_call_interface_init (CallsCallInterface *iface);
+
+G_DEFINE_TYPE_WITH_CODE (CallsMMCall, calls_mm_call, G_TYPE_OBJECT,
+                         G_IMPLEMENT_INTERFACE (CALLS_TYPE_MESSAGE_SOURCE,
+                                                calls_mm_call_message_source_interface_init)
+                         G_IMPLEMENT_INTERFACE (CALLS_TYPE_CALL,
+                                                calls_mm_call_call_interface_init))
+
+enum {
+  PROP_0,
+  PROP_MM_CALL,
+  PROP_LAST_PROP,
+};
+static GParamSpec *props[PROP_LAST_PROP];
+
+
+static const gchar *
+get_name (CallsCall *call)
+{
+  return NULL;
+}
+
+
+static const gchar *
+get_number (CallsCall *call)
+{
+  CallsMMCall *self = CALLS_MM_CALL (call);
+  return self->number->str;
+}
+
+
+static CallsCallState
+get_state (CallsCall *call)
+{
+  CallsMMCall *self = CALLS_MM_CALL (call);
+  return self->state;
+}
+
+
+static void
+change_state (CallsMMCall *self,
+              MMCallState  state)
+{
+  self->state = state;
+  g_signal_emit_by_name (CALLS_CALL (self),
+                         "state-changed", state);
+}
+
+
+static void
+notify_number_cb (CallsMMCall *self,
+                  const gchar *number)
+{
+  g_string_assign (self->number, number);
+}
+
+
+struct CallsMMCallStateReasonMap
+{
+  MMCallStateReason  value;
+  const gchar       *desc;
+};
+
+static const struct CallsMMCallStateReasonMap STATE_REASON_MAP[] = {
+
+#define row(ENUMVALUE,DESCRIPTION)              \
+  { MM_CALL_STATE_REASON_##ENUMVALUE, DESCRIPTION }    \
+
+  row (UNKNOWN,          "Outgoing call created"),
+  row (OUTGOING_STARTED, "Outgoing call started"),
+  row (INCOMING_NEW,     "Incoming call"),
+  row (ACCEPTED,         "Call accepted"),
+  row (TERMINATED,       "Call terminated"),
+  row (REFUSED_OR_BUSY,  "Busy or call refused"),
+  row (ERROR,            "Wrong number or network problem"),
+
+#undef row
+
+  { -1, NULL }
+};
+
+static void
+set_disconnect_reason (CallsMMCall       *self,
+                       MMCallStateReason  reason)
+{
+  const struct CallsMMCallStateReasonMap *map_row;
+  GString *reason_str;
+
+  for (map_row = STATE_REASON_MAP; map_row->desc; ++map_row)
+    {
+      if (map_row->value == reason)
+        {
+          self->disconnect_reason = g_strdup(map_row->desc);
+          return;
+        }
+    }
+
+  reason_str = g_string_new ("Unknown disconnect reason ");
+  g_string_append_printf (reason_str, "(%i)", (int)reason);
+
+  g_warning ("%s", reason_str->str);
+  CALLS_SET_PTR_PROPERTY (self->disconnect_reason,
+                          reason_str->str);
+
+  g_string_free (reason_str, FALSE);
+}
+
+
+struct CallsMMCallStateMap
+{
+  MMCallState    mm;
+  CallsCallState calls;
+};
+
+static const struct CallsMMCallStateMap STATE_MAP[] = {
+
+#define row(MMENUM,CALLSENUM)                                   \
+  { MM_CALL_STATE_##MMENUM, CALLS_CALL_STATE_##CALLSENUM }      \
+
+  row (DIALING, DIALING),
+  row (RINGING_OUT, INCOMING),
+  row (RINGING_IN, ALERTING),
+  row (ACTIVE, ACTIVE),
+  row (HELD, HELD),
+  row (WAITING, INCOMING),
+  row (TERMINATED, DISCONNECTED),
+
+#undef row
+
+  { MM_CALL_STATE_UNKNOWN, (CallsCallState)0 },
+  { -1, -1 }
+};
+
+static void
+state_changed_cb (CallsMMCall       *self,
+                  MMCallState        old,
+                  MMCallState        mm_new,
+                  MMCallStateReason  reason)
+{
+  const struct CallsMMCallStateMap *map_row;
+
+  if (mm_new == MM_CALL_STATE_TERMINATED)
+    {
+      set_disconnect_reason (self, reason);
+    }
+
+  for (map_row = STATE_MAP; map_row->mm != -1; ++map_row)
+    {
+      if (map_row->mm == mm_new)
+        {
+          change_state (self, map_row->calls);
+          return;
+        }
+    }
+}
+
+
+struct CallsMMOperationData
+{
+  const gchar *desc;
+  CallsMMCall *self;
+  gboolean (*finish_func) (MMCall *, GAsyncResult *, GError **);
+};
+
+static void
+operation_cb (MMCall                      *mm_call,
+              GAsyncResult                *res,
+              struct CallsMMOperationData *data)
+{
+  gboolean ok;
+  GError *error = NULL;
+
+  ok = data->finish_func (mm_call, res, &error);
+  if (!ok)
+    {
+      g_warning ("Error %s ModemManager call to `%s': %s",
+                 data->desc, data->self->number->str, error->message);
+      CALLS_ERROR (data->self, error);
+    }
+
+  g_free (data);
+}
+
+#define DEFINE_OPERATION(op,name,desc_str)              \
+  static void                                           \
+  name (CallsCall *call)                                \
+  {                                                     \
+    CallsMMCall *self = CALLS_MM_CALL (call);           \
+    struct CallsMMOperationData *data;                  \
+                                                        \
+    data = g_new0 (struct CallsMMOperationData, 1);     \
+    data->desc = desc_str;                              \
+    data->self = self;                                  \
+    data->finish_func = mm_call_##op##_finish;          \
+                                                        \
+    mm_call_##op                                        \
+      (self->mm_call,                                   \
+       NULL,                                            \
+       (GAsyncReadyCallback) operation_cb,              \
+       data);                                           \
+  }
+
+DEFINE_OPERATION(accept, answer, "accepting");
+DEFINE_OPERATION(hangup, hang_up, "hanging up");
+DEFINE_OPERATION(start, start_call, "starting outgoing call");
+
+
+static void
+tone_start (CallsCall *call, gchar key)
+{
+  CallsMMCall *self = CALLS_MM_CALL (call);
+  struct CallsMMOperationData *data;
+  char key_str[2] = { key, '\0' };
+
+  data = g_new0 (struct CallsMMOperationData, 1);
+  data->desc = "sending DTMF";
+  data->self = self;
+  data->finish_func = mm_call_send_dtmf_finish;
+
+  mm_call_send_dtmf
+    (self->mm_call,
+     key_str,
+     NULL,
+     (GAsyncReadyCallback) operation_cb,
+     data);
+}
+
+
+static void
+set_property (GObject      *object,
+              guint         property_id,
+              const GValue *value,
+              GParamSpec   *pspec)
+{
+  CallsMMCall *self = CALLS_MM_CALL (object);
+
+  switch (property_id) {
+  case PROP_MM_CALL:
+    g_set_object (&self->mm_call,
+                  MM_CALL (g_value_get_object (value)));
+    break;
+
+  default:
+    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+    break;
+  }
+}
+
+
+static void
+constructed (GObject *object)
+{
+  GObjectClass *parent_class = g_type_class_peek (G_TYPE_OBJECT);
+  CallsMMCall *self = CALLS_MM_CALL (object);
+  MmGdbusCall *gdbus_call = MM_GDBUS_CALL (self->mm_call);
+
+  g_signal_connect_swapped (gdbus_call, "notify::number",
+                            G_CALLBACK (notify_number_cb), self);
+  g_signal_connect_swapped (gdbus_call, "state-changed",
+                            G_CALLBACK (state_changed_cb), self);
+
+  notify_number_cb (self, mm_call_get_number (self->mm_call));
+
+  /* Start outgoing call */
+  if (mm_call_get_state (self->mm_call) == MM_CALL_STATE_UNKNOWN
+      && mm_call_get_direction (self->mm_call) == MM_CALL_DIRECTION_OUTGOING)
+    {
+      start_call (CALLS_CALL (self));
+    }
+
+  parent_class->constructed (object);
+}
+
+
+static void
+dispose (GObject *object)
+{
+  GObjectClass *parent_class = g_type_class_peek (G_TYPE_OBJECT);
+  CallsMMCall *self = CALLS_MM_CALL (object);
+
+  g_clear_object (&self->mm_call);
+
+  parent_class->dispose (object);
+}
+
+
+static void
+finalize (GObject *object)
+{
+  GObjectClass *parent_class = g_type_class_peek (G_TYPE_OBJECT);
+  CallsMMCall *self = CALLS_MM_CALL (object);
+
+  g_free (self->disconnect_reason);
+  g_string_free (self->number, TRUE);
+
+  parent_class->finalize (object);
+}
+
+
+static void
+calls_mm_call_class_init (CallsMMCallClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+  object_class->set_property = set_property;
+  object_class->constructed = constructed;
+  object_class->dispose = dispose;
+  object_class->finalize = finalize;
+
+  props[PROP_MM_CALL] =
+    g_param_spec_object ("mm-call",
+                         _("MM call"),
+                         _("A libmm-glib proxy object for the underlying call object"),
+                         MM_TYPE_CALL,
+                         G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY);
+
+  g_object_class_install_properties (object_class, PROP_LAST_PROP, props);
+}
+
+
+static void
+calls_mm_call_message_source_interface_init (CallsCallInterface *iface)
+{
+}
+
+
+static void
+calls_mm_call_call_interface_init (CallsCallInterface *iface)
+{
+  iface->get_number = get_number;
+  iface->get_name   = get_name;
+  iface->get_state  = get_state;
+  iface->answer     = answer;
+  iface->hang_up    = hang_up;
+  iface->tone_start = tone_start;
+}
+
+
+static void
+calls_mm_call_init (CallsMMCall *self)
+{
+  self->number = g_string_new (NULL);
+}
+
+
+CallsMMCall *
+calls_mm_call_new (MMCall *mm_call)
+{
+  g_return_val_if_fail (MM_IS_CALL (mm_call), NULL);
+
+  return g_object_new (CALLS_TYPE_MM_CALL,
+                       "mm-call", mm_call,
+                       NULL);
+}
+
+
+const gchar *
+calls_mm_call_get_object_path (CallsMMCall *call)
+{
+  return mm_call_get_path (call->mm_call);
+}
+
+
+const gchar *
+calls_mm_call_get_disconnect_reason (CallsMMCall *call)
+{
+  return call->disconnect_reason;
+}

src/calls-mm-call.h

+/*
+ * Copyright (C) 2018 Purism SPC
+ *
+ * This file is part of Calls.
+ *
+ * Calls 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.
+ *
+ * Calls 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 Calls.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author: Bob Ham <bob.ham@puri.sm>
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
+#ifndef CALLS_MM_CALL_H__
+#define CALLS_MM_CALL_H__
+
+#include <libmm-glib.h>
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+#define CALLS_TYPE_MM_CALL (calls_mm_call_get_type ())
+
+G_DECLARE_FINAL_TYPE (CallsMMCall, calls_mm_call, CALLS, MM_CALL, GObject);
+
+CallsMMCall *calls_mm_call_new                   (MMCall *mm_call);
+const gchar *calls_mm_call_get_object_path       (CallsMMCall *call);
+const gchar *calls_mm_call_get_disconnect_reason (CallsMMCall *call);
+
+G_END_DECLS
+
+#endif /* CALLS_MM_CALL_H__ */

src/calls-mm-origin.c

+/*
+ * Copyright (C) 2018 Purism SPC
+ *
+ * This file is part of Calls.
+ *
+ * Calls 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.
+ *
+ * Calls 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 Calls.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author: Bob Ham <bob.ham@puri.sm>
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
+#include "calls-mm-origin.h"
+#include "calls-origin.h"
+#include "calls-mm-call.h"
+#include "calls-message-source.h"
+
+#include <glib/gi18n.h>
+
+
+struct _CallsMMOrigin
+{
+  GObject parent_instance;
+  MMObject *mm_obj;
+  MMModemVoice *voice;
+  gchar *name;
+  GHashTable *calls;
+};
+
+static void calls_mm_origin_message_source_interface_init (CallsOriginInterface *iface);
+static void calls_mm_origin_origin_interface_init (CallsOriginInterface *iface);
+
+G_DEFINE_TYPE_WITH_CODE (CallsMMOrigin, calls_mm_origin, G_TYPE_OBJECT,
+                         G_IMPLEMENT_INTERFACE (CALLS_TYPE_MESSAGE_SOURCE,
+                                                calls_mm_origin_message_source_interface_init)
+                         G_IMPLEMENT_INTERFACE (CALLS_TYPE_ORIGIN,
+                                                calls_mm_origin_origin_interface_init))
+
+enum {
+  PROP_0,
+  PROP_MODEM,
+  PROP_LAST_PROP,
+};
+static GParamSpec *props[PROP_LAST_PROP];
+
+
+static const gchar *
+get_name (CallsOrigin *origin)
+{
+  CallsMMOrigin *self = CALLS_MM_ORIGIN (origin);
+  return self->name;
+}
+
+
+static GList *
+get_calls (CallsOrigin * origin)
+{
+  CallsMMOrigin *self = CALLS_MM_ORIGIN (origin);
+  return g_hash_table_get_values (self->calls);
+}
+
+
+static void
+dial_cb (MMModemVoice  *voice,
+         GAsyncResult  *res,
+         CallsMMOrigin *self)
+{
+  MMCall *call;
+  GError *error = NULL;
+
+  call = mm_modem_voice_create_call_finish (voice, res, &error);
+  if (!call)
+    {
+      g_warning ("Error dialing number on ModemManager modem `%s': %s",
+                 self->name, error->message);
+      CALLS_ERROR (self, error);
+    }
+}
+
+
+static void
+dial (CallsOrigin *origin, const gchar *number)
+{
+  CallsMMOrigin *self = CALLS_MM_ORIGIN (origin);
+  MMCallProperties *props;
+
+  g_assert (self->voice != NULL);
+
+  props = mm_call_properties_new();
+  mm_call_properties_set_number (props, number);
+
+  mm_modem_voice_create_call
+    (self->voice,
+     props,
+     NULL,
+     (GAsyncReadyCallback) dial_cb,
+     self);
+
+  g_object_unref (props);
+}
+
+
+static void
+remove_call (CallsMMOrigin *self,
+             CallsMMCall   *call,
+             const gchar   *path,
+             const gchar   *reason)
+{
+  g_signal_emit_by_name (CALLS_ORIGIN(self), "call-removed",
+                         CALLS_CALL(call), reason);
+  g_hash_table_remove (self->calls, path);
+}
+
+
+struct CallsMMRemoveCallsData
+{
+  CallsOrigin *origin;
+  const gchar *reason;
+};
+
+
+static gboolean
+remove_calls_cb (const gchar                   *path,
+                 CallsMMCall                   *call,
+                 struct CallsMMRemoveCallsData *data)
+{
+  g_signal_emit_by_name (data->origin, "call-removed",
+                         CALLS_CALL(call), data->reason);
+  return TRUE;
+}
+
+
+static void
+remove_calls (CallsMMOrigin *self, const gchar *reason)
+{
+  struct CallsMMRemoveCallsData data = { CALLS_ORIGIN (self), reason };
+
+  g_hash_table_foreach_remove (self->calls,
+                               (GHRFunc) remove_calls_cb,
+                               &data);
+}
+
+
+struct CallsMMOriginDeleteCallData
+{
+  CallsMMOrigin *self;
+  gchar *path;
+};
+
+
+static void
+delete_call_cb (MMModemVoice                       *voice,
+                GAsyncResult                       *res,
+                struct CallsMMOriginDeleteCallData *data)
+{
+  gboolean ok;
+  GError *error = NULL;
+
+  ok = mm_modem_voice_delete_call_finish (voice, res, &error);
+  i