cli: implement 3GPP related actions

cli/Makefile.am

@@ -16,6 +16,7 @@ mmcli_SOURCES = \
 	mmcli-common.c \
 	mmcli-manager.c \
 	mmcli-modem.c \
+	mmcli-modem-3gpp.c \
 	mmcli-bearer.c
 
 mmcli_LDADD = \

cli/mmcli-common.c

@@ -550,6 +550,19 @@ mmcli_get_lock_string (MMModemLock lock)
     return value->value_nick;
 }
 
+const gchar *
+mmcli_get_3gpp_network_availability_string (MMModem3gppNetworkAvailability availability)
+{
+    static GEnumClass *enum_class = NULL;
+    GEnumValue *value;
+
+    if (!enum_class)
+        enum_class = G_ENUM_CLASS (g_type_class_ref (MM_TYPE_MODEM_3GPP_NETWORK_AVAILABILITY));
+
+    value = g_enum_get_value (enum_class, availability);
+    return value->value_nick;
+}
+
 /* Common options */
 static gchar *modem_str;
 static gchar *bearer_str;

cli/mmcli-common.h

@@ -51,10 +51,11 @@ MMBearer *mmcli_get_bearer_sync   (GDBusConnection *connection,
                                    MMManager **manager,
                                    MMObject **object);
 
-const gchar *mmcli_get_bearer_ip_method_string (MMBearerIpMethod method);
-const gchar *mmcli_get_state_string            (MMModemState state);
-const gchar *mmcli_get_state_reason_string     (MMModemStateChangeReason reason);
-const gchar *mmcli_get_lock_string             (MMModemLock lock);
+const gchar *mmcli_get_bearer_ip_method_string          (MMBearerIpMethod method);
+const gchar *mmcli_get_state_string                     (MMModemState state);
+const gchar *mmcli_get_state_reason_string              (MMModemStateChangeReason reason);
+const gchar *mmcli_get_lock_string                      (MMModemLock lock);
+const gchar *mmcli_get_3gpp_network_availability_string (MMModem3gppNetworkAvailability availability);
 
 GOptionGroup *mmcli_get_common_option_group (void);
 const gchar  *mmcli_get_common_modem_string (void);

cli/mmcli-modem-3gpp.c

@@ -0,0 +1,298 @@
+/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * mmcli -- Control modem status & access information from the command line
+ *
+ * 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/>.
+ *
+ * Copyright (C) 2011 Aleksander Morgado <aleksander@gnu.org>
+ */
+
+#include "config.h"
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <locale.h>
+#include <string.h>
+
+#include <glib.h>
+#include <gio/gio.h>
+
+#include <libmm-glib.h>
+
+#include "mmcli.h"
+#include "mmcli-common.h"
+
+/* Context */
+typedef struct {
+    MMManager *manager;
+    GCancellable *cancellable;
+    MMObject *object;
+    MMModem3gpp *modem_3gpp;
+} Context;
+static Context *ctx;
+
+/* Options */
+static gboolean scan_flag;
+static gchar *register_str;
+
+static GOptionEntry entries[] = {
+    { "3gpp-scan", 0, 0, G_OPTION_ARG_NONE, &scan_flag,
+      "Scan for available networks in a given modem.",
+      NULL
+    },
+    { "3gpp-register", 0, 0, G_OPTION_ARG_STRING, &register_str,
+      "Request a given modem to register in the specified network",
+      "[NETWORK]"
+    },
+    { NULL }
+};
+
+GOptionGroup *
+mmcli_modem_3gpp_get_option_group (void)
+{
+	GOptionGroup *group;
+
+	group = g_option_group_new ("3gpp",
+	                            "3GPP options",
+	                            "Show 3GPP related options",
+	                            NULL,
+	                            NULL);
+	g_option_group_add_entries (group, entries);
+
+	return group;
+}
+
+gboolean
+mmcli_modem_3gpp_options_enabled (void)
+{
+    static guint n_actions = 0;
+    static gboolean checked = FALSE;
+
+    if (checked)
+        return !!n_actions;
+
+    n_actions = (scan_flag +
+                 !!register_str);
+
+    if (n_actions > 1) {
+        g_printerr ("error: too many 3GPP actions requested\n");
+        exit (EXIT_FAILURE);
+    }
+
+    /* Scanning networks takes really a long time, so we do it asynchronously
+     * always to avoid DBus timeouts */
+    if (scan_flag)
+        mmcli_force_async_operation ();
+
+    checked = TRUE;
+    return !!n_actions;
+}
+
+static void
+context_free (Context *ctx)
+{
+    if (!ctx)
+        return;
+
+    if (ctx->cancellable)
+        g_object_unref (ctx->cancellable);
+    if (ctx->modem_3gpp)
+        g_object_unref (ctx->modem_3gpp);
+    if (ctx->object)
+        g_object_unref (ctx->object);
+    if (ctx->manager)
+        g_object_unref (ctx->manager);
+    g_free (ctx);
+}
+
+void
+mmcli_modem_3gpp_shutdown (void)
+{
+    context_free (ctx);
+}
+
+static void
+print_network_info (MMModem3gppNetwork *network)
+{
+    const gchar *name;
+    gchar *access_technologies;
+
+    /* Not the best thing to do, as we may be doing _get() calls twice, but
+     * easiest to maintain */
+#undef VALIDATE
+#define VALIDATE(str) (str ? str : "unknown")
+
+    access_technologies = (mm_modem_get_access_technologies_string (
+                               mm_modem_3gpp_network_get_access_technology (network)));
+
+    /* Prefer long name */
+    name = mm_modem_3gpp_network_get_operator_long (network);
+    if (!name)
+        name = mm_modem_3gpp_network_get_operator_short (network);
+
+    g_print ("%s - %s (%s, %s)\n",
+             VALIDATE (mm_modem_3gpp_network_get_operator_code (network)),
+             VALIDATE (name),
+             access_technologies,
+             mmcli_get_3gpp_network_availability_string (
+                 mm_modem_3gpp_network_get_availability (network)));
+    g_free (access_technologies);
+}
+
+static void
+scan_process_reply (GList *result,
+                    const GError *error)
+{
+    if (!result) {
+        g_printerr ("error: couldn't scan networks in the modem: '%s'\n",
+                    error ? error->message : "unknown error");
+        exit (EXIT_FAILURE);
+    }
+
+    g_print ("\n");
+    if (!result)
+        g_print ("No networks were found\n");
+    else {
+        GList *l;
+
+        g_print ("Found %u networks:\n", g_list_length (result));
+        for (l = result; l; l = g_list_next (l)) {
+            print_network_info ((MMModem3gppNetwork *)(l->data));
+        }
+        g_list_foreach (result, (GFunc)mm_modem_3gpp_network_free, NULL);
+        g_list_free (result);
+    }
+    g_print ("\n");
+}
+
+static void
+scan_ready (MMModem3gpp  *modem_3gpp,
+            GAsyncResult *result,
+            gpointer      nothing)
+{
+    GList *operation_result;
+    GError *error = NULL;
+
+    operation_result = mm_modem_3gpp_scan_finish (modem_3gpp, result, &error);
+    scan_process_reply (operation_result, error);
+
+    mmcli_async_operation_done ();
+}
+
+static void
+register_process_reply (gboolean result,
+                        const GError *error)
+{
+    if (!result) {
+        g_printerr ("error: couldn't register the modem: '%s'\n",
+                    error ? error->message : "unknown error");
+        exit (EXIT_FAILURE);
+    }
+
+    g_print ("successfully registered the modem\n");
+}
+
+static void
+register_ready (MMModem3gpp  *modem_3gpp,
+                GAsyncResult *result,
+                gpointer      nothing)
+{
+    gboolean operation_result;
+    GError *error = NULL;
+
+    operation_result = mm_modem_3gpp_register_finish (modem_3gpp, result, &error);
+    register_process_reply (operation_result, error);
+
+    mmcli_async_operation_done ();
+}
+
+static void
+get_modem_ready (GObject      *source,
+                 GAsyncResult *result,
+                 gpointer      none)
+{
+    ctx->object = mmcli_get_modem_finish (result, &ctx->manager);
+    ctx->modem_3gpp = mm_object_get_modem_3gpp (ctx->object);
+
+    /* Request to scan networks? */
+    if (scan_flag) {
+        g_debug ("Asynchronously scanning for networks...");
+        mm_modem_3gpp_scan (ctx->modem_3gpp,
+                            ctx->cancellable,
+                            (GAsyncReadyCallback)scan_ready,
+                            NULL);
+        return;
+    }
+
+    /* Request to register the modem? */
+    if (register_str) {
+        g_debug ("Asynchronously registering the modem...");
+        mm_modem_3gpp_register (ctx->modem_3gpp,
+                                register_str,
+                                ctx->cancellable,
+                                (GAsyncReadyCallback)register_ready,
+                                NULL);
+        return;
+    }
+
+    g_warn_if_reached ();
+}
+
+void
+mmcli_modem_3gpp_run_asynchronous (GDBusConnection *connection,
+                                   GCancellable    *cancellable)
+{
+    /* Initialize context */
+    ctx = g_new0 (Context, 1);
+    if (cancellable)
+        ctx->cancellable = g_object_ref (cancellable);
+
+    /* Get proper modem */
+    mmcli_get_modem  (connection,
+                      mmcli_get_common_modem_string (),
+                      cancellable,
+                      (GAsyncReadyCallback)get_modem_ready,
+                      NULL);
+}
+
+void
+mmcli_modem_3gpp_run_synchronous (GDBusConnection *connection)
+{
+    GError *error = NULL;
+
+    /* Initialize context */
+    ctx = g_new0 (Context, 1);
+    ctx->object = mmcli_get_modem_sync (connection,
+                                        mmcli_get_common_modem_string (),
+                                        &ctx->manager);
+    ctx->modem_3gpp = mm_object_get_modem_3gpp (ctx->object);
+
+    if (scan_flag)
+        g_assert_not_reached ();
+
+    /* Request to register the modem? */
+    if (register_str) {
+        gboolean result;
+
+        g_debug ("Synchronously registering the modem...");
+        result = mm_modem_3gpp_register_sync (ctx->modem_3gpp,
+                                              register_str,
+                                              NULL,
+                                              &error);
+        register_process_reply (result, error);
+        return;
+    }
+
+    g_warn_if_reached ();
+}

cli/mmcli.c

@@ -182,6 +182,8 @@ main (gint argc, gchar **argv)
                                 mmcli_get_common_option_group ());
 	g_option_context_add_group (context,
 	                            mmcli_modem_get_option_group ());
+	g_option_context_add_group (context,
+	                            mmcli_modem_3gpp_get_option_group ());
 	g_option_context_add_group (context,
 	                            mmcli_bearer_get_option_group ());
     g_option_context_add_main_entries (context, main_entries, NULL);
@@ -232,6 +234,13 @@ main (gint argc, gchar **argv)
         else
             mmcli_bearer_run_synchronous (connection);
     }
+    /* Modem 3GPP options? */
+    else if (mmcli_modem_3gpp_options_enabled ()) {
+        if (async_flag)
+            mmcli_modem_3gpp_run_asynchronous (connection, cancellable);
+        else
+            mmcli_modem_3gpp_run_synchronous (connection);
+    }
     /* Modem options?
      * NOTE: let this check be always the last one, as other groups also need
      * having a modem specified, and therefore if -m is set, modem options
@@ -256,6 +265,8 @@ main (gint argc, gchar **argv)
         mmcli_manager_shutdown ();
     } else if (mmcli_modem_options_enabled ()) {
         mmcli_modem_shutdown ();
+    } else if (mmcli_modem_3gpp_options_enabled ()) {
+        mmcli_modem_3gpp_shutdown ();
     }  else if (mmcli_bearer_options_enabled ()) {
         mmcli_bearer_shutdown ();
     }

cli/mmcli.h

@@ -44,6 +44,14 @@ void          mmcli_modem_run_asynchronous   (GDBusConnection *connection,
 void          mmcli_modem_run_synchronous    (GDBusConnection *connection);
 void          mmcli_modem_shutdown           (void);
 
+/* 3GPP group */
+GOptionGroup *mmcli_modem_3gpp_get_option_group   (void);
+gboolean      mmcli_modem_3gpp_options_enabled    (void);
+void          mmcli_modem_3gpp_run_asynchronous   (GDBusConnection *connection,
+                                                   GCancellable    *cancellable);
+void          mmcli_modem_3gpp_run_synchronous    (GDBusConnection *connection);
+void          mmcli_modem_3gpp_shutdown           (void);
+
 /* Bearer group */
 GOptionGroup *mmcli_bearer_get_option_group   (void);
 gboolean      mmcli_bearer_options_enabled    (void);