Files
ModemManager/cli/mmcli-modem.c
T
Aleksander Morgado 6246944510 cli: allow option groups to force async/sync operations
Some operations are clearly asynchronous (e.g. monitoring modem state), while
others are clearly synchronous (e.g. printing modem info). So just allow option
groups to force the operation to be async or sync based on the detected action.
2012-03-15 14:14:33 +01:00

610 lines
18 KiB
C

/* -*- 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 {
GCancellable *cancellable;
MMObject *object;
MMModem *modem;
} Context;
static Context *ctx;
/* Options */
static gchar *modem_str;
static gboolean info_flag;
static gboolean monitor_state_flag;
static gboolean enable_flag;
static gboolean disable_flag;
static gboolean reset_flag;
static gchar *factory_reset_str;
static GOptionEntry entries[] = {
{ "modem", 'm', 0, G_OPTION_ARG_STRING, &modem_str,
"Specify modem by path or index",
NULL
},
{ "info", 'i', 0, G_OPTION_ARG_NONE, &info_flag,
"Get information of a given modem",
NULL
},
{ "monitor-state", 'w', 0, G_OPTION_ARG_NONE, &monitor_state_flag,
"Monitor state of a given modem",
NULL
},
{ "enable", 'e', 0, G_OPTION_ARG_NONE, &enable_flag,
"Enable a given modem",
NULL
},
{ "disable", 'd', 0, G_OPTION_ARG_NONE, &disable_flag,
"Disable a given modem",
NULL
},
{ "reset", 'r', 0, G_OPTION_ARG_NONE, &reset_flag,
"Reset a given modem",
NULL
},
{ "factory-reset", 0, 0, G_OPTION_ARG_STRING, &factory_reset_str,
"Reset a given modem to its factory state",
"[CODE]"
},
{ NULL }
};
GOptionGroup *
mmcli_modem_get_option_group (void)
{
GOptionGroup *group;
/* Status options */
group = g_option_group_new ("modem",
"Modem options",
"Show modem options",
NULL,
NULL);
g_option_group_add_entries (group, entries);
return group;
}
gboolean
mmcli_modem_options_enabled (void)
{
guint n_actions;
n_actions = (info_flag +
monitor_state_flag +
enable_flag +
disable_flag +
reset_flag +
!!factory_reset_str);
if (n_actions > 1) {
g_printerr ("error: too many modem actions requested\n");
exit (EXIT_FAILURE);
}
if (monitor_state_flag)
mmcli_force_async_operation ();
if (info_flag)
mmcli_force_sync_operation ();
return !!n_actions;
}
static void
context_free (Context *ctx)
{
if (!ctx)
return;
if (ctx->cancellable)
g_object_unref (ctx->cancellable);
if (ctx->modem)
g_object_unref (ctx->modem);
if (ctx->object)
g_object_unref (ctx->object);
g_free (ctx);
}
void
mmcli_modem_shutdown (void)
{
context_free (ctx);
}
/* static gchar * */
/* prefix_newlines (const gchar *prefix, */
/* const gchar *str) */
/* { */
/* GString *prefixed_string = NULL; */
/* const gchar *line_start = str; */
/* const gchar *line_end; */
/* while ((line_end = strchr (line_start, '\n'))) { */
/* gssize line_length; */
/* line_length = line_end - line_start; */
/* if (line_start[line_length - 1] == '\r') */
/* line_length--; */
/* if (line_length > 0) { */
/* if (prefixed_string) { */
/* /\* If not the first line, add the prefix *\/ */
/* g_string_append_printf (prefixed_string, */
/* "\n%s", prefix); */
/* } else { */
/* prefixed_string = g_string_new (""); */
/* } */
/* g_string_append_len (prefixed_string, */
/* line_start, */
/* line_length); */
/* } */
/* line_start = line_end + 1; */
/* } */
/* return (prefixed_string ? */
/* g_string_free (prefixed_string, FALSE) : */
/* NULL); */
/* } */
/* static void */
/* get_info_process_reply (gboolean result, */
/* const GError *error, */
/* const gchar *manufacturer, */
/* const gchar *model, */
/* const gchar *revision) */
/* { */
/* gchar *prefixed_revision; */
/* gchar *master_device; */
/* gchar *device; */
/* gchar *device_id; */
/* gchar *equipment_id; */
/* gchar *driver; */
/* gchar *plugin; */
/* MMModemType type; */
/* gboolean enabled; */
/* gchar *unlock_required; */
/* guint32 unlock_retries; */
/* gchar *unlock; */
/* MMModemIpMethod ip_method; */
/* MMModemState state; */
/* if (!result) { */
/* g_printerr ("couldn't get info from modem: '%s'\n", */
/* error ? error->message : "unknown error"); */
/* exit (EXIT_FAILURE); */
/* } */
/* /\* Get additional info from properties *\/ */
/* master_device = mm_modem_get_master_device (ctxt.modem); */
/* device = mm_modem_get_device (ctxt.modem); */
/* device_id = mm_modem_get_device_identifier (ctxt.modem); */
/* equipment_id = mm_modem_get_equipment_identifier (ctxt.modem); */
/* driver = mm_modem_get_driver (ctxt.modem); */
/* plugin = mm_modem_get_plugin (ctxt.modem); */
/* type = mm_modem_get_modem_type (ctxt.modem); */
/* enabled = mm_modem_get_enabled (ctxt.modem); */
/* unlock_required = mm_modem_get_unlock_required (ctxt.modem); */
/* unlock_retries = mm_modem_get_unlock_retries (ctxt.modem); */
/* ip_method = mm_modem_get_ip_method (ctxt.modem); */
/* state = mm_modem_get_state (ctxt.modem); */
/* /\* Strings with mixed properties *\/ */
/* unlock = (unlock_required ? */
/* g_strdup_printf ("%s (%u retries)", */
/* unlock_required, */
/* unlock_retries) : */
/* g_strdup ("not required")); */
/* /\* Rework possible multiline strings *\/ */
/* prefixed_revision = prefix_newlines (" | ", */
/* revision); */
/* g_print ("\n" */
/* "%s\n" */
/* " -------------------------\n" */
/* " Hardware | manufacturer: '%s'\n" */
/* " | model: '%s'\n" */
/* " | revision: '%s'\n" */
/* " | type: '%s'\n" */
/* " -------------------------\n" */
/* " System | master device: '%s'\n" */
/* " | device: '%s'\n" */
/* " | device id: '%s'\n" */
/* " | equipment id: '%s'\n" */
/* " | driver: '%s'\n" */
/* " | plugin: '%s'\n" */
/* " -------------------------\n" */
/* " Status | enabled: '%s'\n" */
/* " | unlock: '%s'\n" */
/* " | IP method: '%s'\n" */
/* " | state: '%s'\n" */
/* "\n", */
/* ctxt.modem_str, */
/* manufacturer, */
/* model, */
/* prefixed_revision ? prefixed_revision : revision, */
/* get_modem_type_string (type), */
/* master_device, */
/* device, */
/* device_id, */
/* equipment_id, */
/* driver, */
/* plugin, */
/* enabled ? "yes" : "no", */
/* unlock, */
/* get_ip_method_string (ip_method), */
/* get_state_string (state)); */
/* g_free (prefixed_revision); */
/* g_free (master_device); */
/* g_free (device); */
/* g_free (device_id); */
/* g_free (equipment_id); */
/* g_free (driver); */
/* g_free (plugin); */
/* g_free (unlock_required); */
/* g_free (unlock); */
/* } */
/* static void */
/* get_info_ready (MMModem *modem, */
/* GAsyncResult *result, */
/* gpointer nothing) */
/* { */
/* gboolean operation_result; */
/* gchar *manufacturer = NULL; */
/* gchar *model = NULL; */
/* gchar *revision = NULL; */
/* GError *error = NULL; */
/* operation_result = mm_modem_get_info_finish (modem, */
/* result, */
/* &manufacturer, */
/* &model, */
/* &revision, */
/* &error); */
/* get_info_process_reply (operation_result, */
/* error, */
/* manufacturer, */
/* model, */
/* revision); */
/* g_free (manufacturer); */
/* g_free (model); */
/* g_free (revision); */
/* mmcli_async_operation_done (); */
/* } */
static void
enable_process_reply (gboolean result,
const GError *error)
{
if (!result) {
g_printerr ("error: couldn't enable the modem: '%s'\n",
error ? error->message : "unknown error");
exit (EXIT_FAILURE);
}
g_print ("successfully enabled the modem\n");
}
static void
enable_ready (MMModem *modem,
GAsyncResult *result,
gpointer nothing)
{
gboolean operation_result;
GError *error = NULL;
operation_result = mm_modem_enable_finish (modem, result, &error);
enable_process_reply (operation_result, error);
mmcli_async_operation_done ();
}
static void
disable_process_reply (gboolean result,
const GError *error)
{
if (!result) {
g_printerr ("error: couldn't disable the modem: '%s'\n",
error ? error->message : "unknown error");
exit (EXIT_FAILURE);
}
g_print ("successfully disabled the modem\n");
}
static void
disable_ready (MMModem *modem,
GAsyncResult *result,
gpointer nothing)
{
gboolean operation_result;
GError *error = NULL;
operation_result = mm_modem_disable_finish (modem, result, &error);
disable_process_reply (operation_result, error);
mmcli_async_operation_done ();
}
static void
reset_process_reply (gboolean result,
const GError *error)
{
if (!result) {
g_printerr ("error: couldn't reset the modem: '%s'\n",
error ? error->message : "unknown error");
exit (EXIT_FAILURE);
}
g_print ("successfully reseted the modem\n");
}
static void
reset_ready (MMModem *modem,
GAsyncResult *result,
gpointer nothing)
{
gboolean operation_result;
GError *error = NULL;
operation_result = mm_modem_reset_finish (modem, result, &error);
reset_process_reply (operation_result, error);
mmcli_async_operation_done ();
}
static void
factory_reset_process_reply (gboolean result,
const GError *error)
{
if (!result) {
g_printerr ("error: couldn't reset the modem to factory state: '%s'\n",
error ? error->message : "unknown error");
exit (EXIT_FAILURE);
}
g_print ("successfully reseted the modem to factory state\n");
}
static void
factory_reset_ready (MMModem *modem,
GAsyncResult *result,
gpointer nothing)
{
gboolean operation_result;
GError *error = NULL;
operation_result = mm_modem_factory_reset_finish (modem, result, &error);
factory_reset_process_reply (operation_result, error);
mmcli_async_operation_done ();
}
static void
state_changed (MMObject *modem,
MMModemState old_state,
MMModemState new_state,
MMModemStateChangeReason reason)
{
g_print ("\t%s: State changed, '%s' --> '%s' (Reason: %s)\n",
mm_object_get_path (modem),
mmcli_get_state_string (old_state),
mmcli_get_state_string (new_state),
mmcli_get_state_reason_string (reason));
fflush (stdout);
}
static void
get_modem_ready (GObject *source,
GAsyncResult *result,
gpointer none)
{
ctx->object = mmcli_get_modem_finish (result);
ctx->modem = mm_object_get_modem (ctx->object);
if (info_flag)
g_assert_not_reached ();
/* Request to monitor modems? */
if (monitor_state_flag) {
MMModemState current;
g_signal_connect (ctx->modem,
"state-changed",
G_CALLBACK (state_changed),
NULL);
current = mm_modem_get_state (ctx->modem);
g_print ("\t%s: Initial state, '%s'\n",
mm_object_get_path (ctx->object),
mmcli_get_state_string (current));
return;
}
/* Request to enable the modem? */
if (enable_flag) {
g_debug ("Asynchronously enabling modem...");
mm_modem_enable (ctx->modem,
ctx->cancellable,
(GAsyncReadyCallback)enable_ready,
NULL);
return;
}
/* Request to disable the modem? */
if (disable_flag) {
g_debug ("Asynchronously disabling modem...");
mm_modem_disable (ctx->modem,
ctx->cancellable,
(GAsyncReadyCallback)disable_ready,
NULL);
return;
}
/* Request to reset the modem? */
if (reset_flag) {
g_debug ("Asynchronously reseting modem...");
mm_modem_reset (ctx->modem,
ctx->cancellable,
(GAsyncReadyCallback)reset_ready,
NULL);
return;
}
/* Request to reset the modem to factory state? */
if (factory_reset_str) {
g_debug ("Asynchronously factory-reseting modem...");
mm_modem_factory_reset (ctx->modem,
factory_reset_str,
ctx->cancellable,
(GAsyncReadyCallback)factory_reset_ready,
NULL);
return;
}
g_warn_if_reached ();
}
void
mmcli_modem_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,
modem_str,
cancellable,
(GAsyncReadyCallback)get_modem_ready,
NULL);
}
void
mmcli_modem_run_synchronous (GDBusConnection *connection)
{
GError *error = NULL;
if (monitor_state_flag)
g_assert_not_reached ();
/* Initialize context */
ctx = g_new0 (Context, 1);
ctx->object = mmcli_get_modem_sync (connection, modem_str);
ctx->modem = mm_object_get_modem (ctx->object);
/* Request to get info from modem? */
if (info_flag) {
/* TODO */
/* gboolean result; */
/* gchar *manufacturer = NULL; */
/* gchar *model = NULL; */
/* gchar *revision = NULL; */
/* result = mm_modem_get_info (ctxt.modem, */
/* &manufacturer, */
/* &model, */
/* &revision, */
/* &error); */
/* get_info_process_reply (result, */
/* error, */
/* manufacturer, */
/* model, */
/* revision); */
/* g_free (manufacturer); */
/* g_free (model); */
/* g_free (revision); */
return;
}
/* Request to enable the modem? */
if (enable_flag) {
gboolean result;
g_debug ("Synchronously enabling modem...");
result = mm_modem_enable_sync (ctx->modem, NULL, &error);
enable_process_reply (result, error);
return;
}
/* Request to disable the modem? */
if (disable_flag) {
gboolean result;
g_debug ("Synchronously disabling modem...");
result = mm_modem_disable_sync (ctx->modem, NULL, &error);
disable_process_reply (result, error);
return;
}
/* Request to reset the modem? */
if (reset_flag) {
gboolean result;
g_debug ("Synchronously reseting modem...");
result = mm_modem_reset_sync (ctx->modem, NULL, &error);
reset_process_reply (result, error);
return;
}
/* Request to reset the modem to factory state? */
if (factory_reset_str) {
gboolean result;
g_debug ("Synchronously factory-reseting modem...");
result = mm_modem_factory_reset_sync (ctx->modem,
factory_reset_str,
NULL,
&error);
factory_reset_process_reply (result, error);
return;
}
g_warn_if_reached ();
}