nm-client.c 74.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301 USA.
 *
 * Copyright 2007 - 2008 Novell, Inc.
19
 * Copyright 2007 - 2014 Red Hat, Inc.
20 21
 */

22
#include "nm-default.h"
23

24 25
#include <string.h>

26
#include "nm-utils.h"
27
#include "nm-client.h"
28
#include "nm-manager.h"
29
#include "nm-remote-settings.h"
30 31 32
#include "nm-device-ethernet.h"
#include "nm-device-wifi.h"
#include "nm-device-private.h"
33
#include "nm-core-internal.h"
34 35
#include "nm-active-connection.h"
#include "nm-vpn-connection.h"
36
#include "nm-remote-connection.h"
37
#include "nm-object-cache.h"
Dan Winship's avatar
Dan Winship committed
38 39
#include "nm-dbus-helpers.h"

40 41 42 43 44
void _nm_device_wifi_set_wireless_enabled (NMDeviceWifi *device, gboolean enabled);

static void nm_client_initable_iface_init (GInitableIface *iface);
static void nm_client_async_initable_iface_init (GAsyncInitableIface *iface);

45
G_DEFINE_TYPE_WITH_CODE (NMClient, nm_client, G_TYPE_OBJECT,
46 47 48 49 50 51 52
                         G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, nm_client_initable_iface_init);
                         G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, nm_client_async_initable_iface_init);
                         )

#define NM_CLIENT_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), NM_TYPE_CLIENT, NMClientPrivate))

typedef struct {
53
	NMManager *manager;
54
	NMRemoteSettings *settings;
55 56 57 58 59 60 61
} NMClientPrivate;

enum {
	PROP_0,
	PROP_VERSION,
	PROP_STATE,
	PROP_STARTUP,
62
	PROP_NM_RUNNING,
63 64 65 66 67 68 69 70 71 72 73 74
	PROP_NETWORKING_ENABLED,
	PROP_WIRELESS_ENABLED,
	PROP_WIRELESS_HARDWARE_ENABLED,
	PROP_WWAN_ENABLED,
	PROP_WWAN_HARDWARE_ENABLED,
	PROP_WIMAX_ENABLED,
	PROP_WIMAX_HARDWARE_ENABLED,
	PROP_ACTIVE_CONNECTIONS,
	PROP_CONNECTIVITY,
	PROP_PRIMARY_CONNECTION,
	PROP_ACTIVATING_CONNECTION,
	PROP_DEVICES,
75
	PROP_ALL_DEVICES,
76 77 78
	PROP_CONNECTIONS,
	PROP_HOSTNAME,
	PROP_CAN_MODIFY,
79
	PROP_METERED,
80 81 82 83 84 85 86

	LAST_PROP
};

enum {
	DEVICE_ADDED,
	DEVICE_REMOVED,
87 88
	ANY_DEVICE_ADDED,
	ANY_DEVICE_REMOVED,
89
	PERMISSION_CHANGED,
90 91
	CONNECTION_ADDED,
	CONNECTION_REMOVED,
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

	LAST_SIGNAL
};

static guint signals[LAST_SIGNAL] = { 0 };

/**********************************************************************/

/**
 * nm_client_error_quark:
 *
 * Registers an error quark for #NMClient if necessary.
 *
 * Returns: the error quark used for #NMClient errors.
 **/
GQuark
nm_client_error_quark (void)
{
	static GQuark quark;

	if (G_UNLIKELY (!quark))
		quark = g_quark_from_static_string ("nm-client-error-quark");
	return quark;
}

/**********************************************************************/

static void
nm_client_init (NMClient *client)
{
}

124 125 126 127 128 129 130 131 132 133 134 135 136 137
static gboolean
_nm_client_check_nm_running (NMClient *client, GError **error)
{
	if (nm_client_get_nm_running (client))
		return TRUE;
	else {
		g_set_error_literal (error,
		                     NM_CLIENT_ERROR,
		                     NM_CLIENT_ERROR_MANAGER_NOT_RUNNING,
		                     "NetworkManager is not running");
		return FALSE;
	}
}

138
/**
139
 * nm_client_get_version:
140 141
 * @client: a #NMClient
 *
142
 * Gets NetworkManager version.
143
 *
144
 * Returns: string with the version (or %NULL if NetworkManager is not running)
145
 **/
146 147
const char *
nm_client_get_version (NMClient *client)
148 149 150
{
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);

151
	return nm_manager_get_version (NM_CLIENT_GET_PRIVATE (client)->manager);
152 153 154
}

/**
155
 * nm_client_get_state:
156 157
 * @client: a #NMClient
 *
158
 * Gets the current daemon state.
159
 *
160
 * Returns: the current %NMState
161
 **/
162 163
NMState
nm_client_get_state (NMClient *client)
164
{
165
	g_return_val_if_fail (NM_IS_CLIENT (client), NM_STATE_UNKNOWN);
166

167
	return nm_manager_get_state (NM_CLIENT_GET_PRIVATE (client)->manager);
168 169 170
}

/**
171
 * nm_client_get_startup:
172 173
 * @client: a #NMClient
 *
174 175
 * Tests whether the daemon is still in the process of activating
 * connections at startup.
176
 *
177
 * Returns: whether the daemon is still starting up
178
 **/
179 180
gboolean
nm_client_get_startup (NMClient *client)
181
{
182
	g_return_val_if_fail (NM_IS_CLIENT (client), NM_STATE_UNKNOWN);
183

184
	return nm_manager_get_startup (NM_CLIENT_GET_PRIVATE (client)->manager);
185 186
}

187 188 189 190 191 192 193 194 195 196
/**
 * nm_client_get_nm_running:
 * @client: a #NMClient
 *
 * Determines whether the daemon is running.
 *
 * Returns: %TRUE if the daemon is running
 **/
gboolean
nm_client_get_nm_running (NMClient *client)
197
{
198
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
199

200
	return nm_manager_get_nm_running (NM_CLIENT_GET_PRIVATE (client)->manager);
201 202
}

203 204 205 206 207 208 209 210 211 212
/**
 * nm_client_networking_get_enabled:
 * @client: a #NMClient
 *
 * Whether networking is enabled or disabled.
 *
 * Returns: %TRUE if networking is enabled, %FALSE if networking is disabled
 **/
gboolean
nm_client_networking_get_enabled (NMClient *client)
213
{
214
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
215

216
	return nm_manager_networking_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
217 218
}

219 220 221 222 223 224 225 226 227 228 229 230 231 232
/**
 * nm_client_networking_set_enabled:
 * @client: a #NMClient
 * @enabled: %TRUE to set networking enabled, %FALSE to set networking disabled
 * @error: (allow-none): return location for a #GError, or %NULL
 *
 * Enables or disables networking.  When networking is disabled, all controlled
 * interfaces are disconnected and deactivated.  When networking is enabled,
 * all controlled interfaces are available for activation.
 *
 * Returns: %TRUE on success, %FALSE otherwise
 **/
gboolean
nm_client_networking_set_enabled (NMClient *client, gboolean enable, GError **error)
233
{
234
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
235

236
	if (!_nm_client_check_nm_running (client, error))
237
		return FALSE;
238

239 240
	return nm_manager_networking_set_enabled (NM_CLIENT_GET_PRIVATE (client)->manager,
	                                          enable, error);
241 242
}

243 244 245 246 247 248 249 250 251 252
/**
 * nm_client_wireless_get_enabled:
 * @client: a #NMClient
 *
 * Determines whether the wireless is enabled.
 *
 * Returns: %TRUE if wireless is enabled
 **/
gboolean
nm_client_wireless_get_enabled (NMClient *client)
253
{
254
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
255

256
	return nm_manager_wireless_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
257 258 259
}

/**
260
 * nm_client_wireless_set_enabled:
261
 * @client: a #NMClient
262
 * @enabled: %TRUE to enable wireless
263
 *
264
 * Enables or disables wireless devices.
265 266
 **/
void
267
nm_client_wireless_set_enabled (NMClient *client, gboolean enabled)
268 269 270
{
	g_return_if_fail (NM_IS_CLIENT (client));

271
	if (!_nm_client_check_nm_running (client, NULL))
272
		return;
273

274
	nm_manager_wireless_set_enabled (NM_CLIENT_GET_PRIVATE (client)->manager, enabled);
275 276
}

277
/**
278 279
 * nm_client_wireless_hardware_get_enabled:
 * @client: a #NMClient
280
 *
281
 * Determines whether the wireless hardware is enabled.
282
 *
283
 * Returns: %TRUE if the wireless hardware is enabled
284
 **/
285 286
gboolean
nm_client_wireless_hardware_get_enabled (NMClient *client)
287
{
288
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
289

290
	return nm_manager_wireless_hardware_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
291 292
}

293 294 295 296 297 298 299 300 301 302
/**
 * nm_client_wwan_get_enabled:
 * @client: a #NMClient
 *
 * Determines whether WWAN is enabled.
 *
 * Returns: %TRUE if WWAN is enabled
 **/
gboolean
nm_client_wwan_get_enabled (NMClient *client)
303
{
304
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
305

306
	return nm_manager_wwan_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
307 308 309
}

/**
310
 * nm_client_wwan_set_enabled:
311
 * @client: a #NMClient
312
 * @enabled: %TRUE to enable WWAN
313
 *
314
 * Enables or disables WWAN devices.
315 316
 **/
void
317
nm_client_wwan_set_enabled (NMClient *client, gboolean enabled)
318 319
{
	g_return_if_fail (NM_IS_CLIENT (client));
320

321
	if (!_nm_client_check_nm_running (client, NULL))
322
		return;
323

324
	nm_manager_wwan_set_enabled (NM_CLIENT_GET_PRIVATE (client)->manager, enabled);
325
}
326

327
/**
328 329
 * nm_client_wwan_hardware_get_enabled:
 * @client: a #NMClient
330
 *
331
 * Determines whether the WWAN hardware is enabled.
332
 *
333
 * Returns: %TRUE if the WWAN hardware is enabled
334
 **/
335 336
gboolean
nm_client_wwan_hardware_get_enabled (NMClient *client)
337
{
338
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
339

340
	return nm_manager_wwan_hardware_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
341 342 343
}

/**
344
 * nm_client_wimax_get_enabled:
345 346
 * @client: a #NMClient
 *
347
 * Determines whether WiMAX is enabled.
348
 *
349
 * Returns: %TRUE if WiMAX is enabled
350
 **/
351
gboolean
352
nm_client_wimax_get_enabled (NMClient *client)
353
{
354
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
355

356
	return nm_manager_wimax_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
357 358 359
}

/**
360
 * nm_client_wimax_set_enabled:
361
 * @client: a #NMClient
362
 * @enabled: %TRUE to enable WiMAX
363
 *
364
 * Enables or disables WiMAX devices.
365 366
 **/
void
367
nm_client_wimax_set_enabled (NMClient *client, gboolean enabled)
368 369 370
{
	g_return_if_fail (NM_IS_CLIENT (client));

371
	if (!_nm_client_check_nm_running (client, NULL))
372 373
		return;

374
	nm_manager_wimax_set_enabled (NM_CLIENT_GET_PRIVATE (client)->manager, enabled);
375 376 377
}

/**
378
 * nm_client_wimax_hardware_get_enabled:
379 380
 * @client: a #NMClient
 *
381
 * Determines whether the WiMAX hardware is enabled.
382
 *
383
 * Returns: %TRUE if the WiMAX hardware is enabled
384 385
 **/
gboolean
386
nm_client_wimax_hardware_get_enabled (NMClient *client)
387
{
388
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
389

390
	return nm_manager_wimax_hardware_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
391 392
}

393
/**
394
 * nm_client_get_logging:
395
 * @client: a #NMClient
396 397 398 399
 * @level: (allow-none): return location for logging level string
 * @domains: (allow-none): return location for log domains string. The string is
 *   a list of domains separated by ","
 * @error: (allow-none): return location for a #GError, or %NULL
400
 *
401
 * Gets NetworkManager current logging level and domains.
402
 *
403
 * Returns: %TRUE on success, %FALSE otherwise
404
 **/
405 406
gboolean
nm_client_get_logging (NMClient *client, char **level, char **domains, GError **error)
407
{
408 409 410 411
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
	g_return_val_if_fail (level == NULL || *level == NULL, FALSE);
	g_return_val_if_fail (domains == NULL || *domains == NULL, FALSE);
	g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
412

413
	if (!_nm_client_check_nm_running (client, error))
414
		return FALSE;
415

416 417
	return nm_manager_get_logging (NM_CLIENT_GET_PRIVATE (client)->manager,
	                               level, domains, error);
418 419 420
}

/**
421
 * nm_client_set_logging:
422
 * @client: a #NMClient
423 424 425 426
 * @level: (allow-none): logging level to set (%NULL or an empty string for no change)
 * @domains: (allow-none): logging domains to set. The string should be a list of log
 *   domains separated by ",". (%NULL or an empty string for no change)
 * @error: (allow-none): return location for a #GError, or %NULL
427
 *
428
 * Sets NetworkManager logging level and/or domains.
429
 *
430
 * Returns: %TRUE on success, %FALSE otherwise
431 432
 **/
gboolean
433
nm_client_set_logging (NMClient *client, const char *level, const char *domains, GError **error)
434 435
{
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
436
	g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
437

438
	if (!_nm_client_check_nm_running (client, error))
439
		return FALSE;
440

441 442
	return nm_manager_set_logging (NM_CLIENT_GET_PRIVATE (client)->manager,
	                               level, domains, error);
443 444 445
}

/**
446
 * nm_client_get_permission_result:
447
 * @client: a #NMClient
448
 * @permission: the permission for which to return the result, one of #NMClientPermission
449
 *
450 451
 * Requests the result of a specific permission, which indicates whether the
 * client can or cannot perform the action the permission represents
452
 *
453
 * Returns: the permission's result, one of #NMClientPermissionResult
454
 **/
455 456
NMClientPermissionResult
nm_client_get_permission_result (NMClient *client, NMClientPermission permission)
457
{
458 459
	g_return_val_if_fail (NM_IS_CLIENT (client), NM_CLIENT_PERMISSION_RESULT_UNKNOWN);

460
	return nm_manager_get_permission_result (NM_CLIENT_GET_PRIVATE (client)->manager, permission);
461 462 463
}

/**
464 465
 * nm_client_get_connectivity:
 * @client: an #NMClient
466
 *
467 468 469 470
 * Gets the current network connectivity state. Contrast
 * nm_client_check_connectivity() and
 * nm_client_check_connectivity_async(), which re-check the
 * connectivity state first before returning any information.
471
 *
472 473 474 475
 * Returns: the current connectivity state
 */
NMConnectivityState
nm_client_get_connectivity (NMClient *client)
476
{
477
	g_return_val_if_fail (NM_IS_CLIENT (client), NM_CONNECTIVITY_UNKNOWN);
478

479
	return nm_manager_get_connectivity (NM_CLIENT_GET_PRIVATE (client)->manager);
480 481 482
}

/**
483 484 485 486
 * nm_client_check_connectivity:
 * @client: an #NMClient
 * @cancellable: a #GCancellable
 * @error: return location for a #GError
487
 *
488 489 490 491 492 493 494 495 496 497 498 499 500
 * Updates the network connectivity state and returns the (new)
 * current state. Contrast nm_client_get_connectivity(), which returns
 * the most recent known state without re-checking.
 *
 * This is a blocking call; use nm_client_check_connectivity_async()
 * if you do not want to block.
 *
 * Returns: the (new) current connectivity state
 */
NMConnectivityState
nm_client_check_connectivity (NMClient *client,
                              GCancellable *cancellable,
                              GError **error)
501
{
502
	g_return_val_if_fail (NM_IS_CLIENT (client), NM_CONNECTIVITY_UNKNOWN);
503

504 505 506
	if (!_nm_client_check_nm_running (client, error))
		return NM_CONNECTIVITY_UNKNOWN;

507 508
	return nm_manager_check_connectivity (NM_CLIENT_GET_PRIVATE (client)->manager,
	                                      cancellable, error);
509 510 511 512 513 514 515 516
}

static void
check_connectivity_cb (GObject *object,
                       GAsyncResult *result,
                       gpointer user_data)
{
	GSimpleAsyncResult *simple = user_data;
517
	NMConnectivityState connectivity;
518 519
	GError *error = NULL;

520 521 522
	connectivity = nm_manager_check_connectivity_finish (NM_MANAGER (object),
	                                                     result, &error);
	if (!error)
523 524 525 526 527 528
		g_simple_async_result_set_op_res_gssize (simple, connectivity);
	else
		g_simple_async_result_take_error (simple, error);

	g_simple_async_result_complete (simple);
	g_object_unref (simple);
529 530 531
}

/**
532 533 534 535 536
 * nm_client_check_connectivity_async:
 * @client: an #NMClient
 * @cancellable: a #GCancellable
 * @callback: callback to call with the result
 * @user_data: data for @callback.
537
 *
538 539 540 541 542 543 544 545 546 547 548 549
 * Asynchronously updates the network connectivity state and invokes
 * @callback when complete. Contrast nm_client_get_connectivity(),
 * which (immediately) returns the most recent known state without
 * re-checking, and nm_client_check_connectivity(), which blocks.
 */
void
nm_client_check_connectivity_async (NMClient *client,
                                    GCancellable *cancellable,
                                    GAsyncReadyCallback callback,
                                    gpointer user_data)
{
	GSimpleAsyncResult *simple;
550
	GError *error = NULL;
551 552

	g_return_if_fail (NM_IS_CLIENT (client));
553 554 555 556 557

	if (!_nm_client_check_nm_running (client, &error)) {
		g_simple_async_report_take_gerror_in_idle (G_OBJECT (client), callback, user_data, error);
		return;
	}
558 559 560

	simple = g_simple_async_result_new (G_OBJECT (client), callback, user_data,
	                                    nm_client_check_connectivity_async);
561 562
	nm_manager_check_connectivity_async (NM_CLIENT_GET_PRIVATE (client)->manager,
	                                     cancellable, check_connectivity_cb, simple);
563 564 565 566 567 568 569
}

/**
 * nm_client_check_connectivity_finish:
 * @client: an #NMClient
 * @result: the #GAsyncResult
 * @error: return location for a #GError
570
 *
571 572 573 574 575 576 577 578 579
 * Retrieves the result of an nm_client_check_connectivity_async()
 * call.
 *
 * Returns: the (new) current connectivity state
 */
NMConnectivityState
nm_client_check_connectivity_finish (NMClient *client,
                                     GAsyncResult *result,
                                     GError **error)
580
{
581
	GSimpleAsyncResult *simple;
582

583 584
	g_return_val_if_fail (NM_IS_CLIENT (client), NM_CONNECTIVITY_UNKNOWN);
	g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (result), NM_CONNECTIVITY_UNKNOWN);
585 586 587 588 589 590

	simple = G_SIMPLE_ASYNC_RESULT (result);

	if (g_simple_async_result_propagate_error (simple, error))
		return NM_CONNECTIVITY_UNKNOWN;
	return (NMConnectivityState) g_simple_async_result_get_op_res_gssize (simple);
591 592
}

593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698

/**
 * nm_client_save_hostname:
 * @client: the %NMClient
 * @hostname: (allow-none): the new persistent hostname to set, or %NULL to
 *   clear any existing persistent hostname
 * @cancellable: a #GCancellable, or %NULL
 * @error: return location for #GError
 *
 * Requests that the machine's persistent hostname be set to the specified value
 * or cleared.
 *
 * Returns: %TRUE if the request was successful, %FALSE if it failed
 **/
gboolean
nm_client_save_hostname (NMClient *client,
                         const char *hostname,
                         GCancellable *cancellable,
                         GError **error)
{
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);

	return nm_remote_settings_save_hostname (NM_CLIENT_GET_PRIVATE (client)->settings,
	                                         hostname, cancellable, error);
}

static void
save_hostname_cb (GObject *object,
                  GAsyncResult *result,
                  gpointer user_data)
{
	GSimpleAsyncResult *simple = user_data;
	GError *error = NULL;

	if (nm_remote_settings_save_hostname_finish (NM_REMOTE_SETTINGS (object), result, &error))
		g_simple_async_result_set_op_res_gboolean (simple, TRUE);
	else
		g_simple_async_result_take_error (simple, error);

	g_simple_async_result_complete (simple);
	g_object_unref (simple);
}

/**
 * nm_client_save_hostname_async:
 * @client: the %NMClient
 * @hostname: (allow-none): the new persistent hostname to set, or %NULL to
 *   clear any existing persistent hostname
 * @cancellable: a #GCancellable, or %NULL
 * @callback: (scope async): callback to be called when the operation completes
 * @user_data: (closure): caller-specific data passed to @callback
 *
 * Requests that the machine's persistent hostname be set to the specified value
 * or cleared.
 **/
void
nm_client_save_hostname_async (NMClient *client,
                               const char *hostname,
                               GCancellable *cancellable,
                               GAsyncReadyCallback callback,
                               gpointer user_data)
{
	GSimpleAsyncResult *simple;
	GError *error = NULL;

	g_return_if_fail (NM_IS_CLIENT (client));

	if (!_nm_client_check_nm_running (client, &error)) {
		g_simple_async_report_take_gerror_in_idle (G_OBJECT (client), callback, user_data, error);
		return;
	}

	simple = g_simple_async_result_new (G_OBJECT (client), callback, user_data,
	                                    nm_client_save_hostname_async);
	nm_remote_settings_save_hostname_async (NM_CLIENT_GET_PRIVATE (client)->settings,
	                                        hostname,
	                                        cancellable, save_hostname_cb, simple);
}

/**
 * nm_client_save_hostname_finish:
 * @client: the %NMClient
 * @result: the result passed to the #GAsyncReadyCallback
 * @error: return location for #GError
 *
 * Gets the result of an nm_client_save_hostname_async() call.
 *
 * Returns: %TRUE if the request was successful, %FALSE if it failed
 **/
gboolean
nm_client_save_hostname_finish (NMClient *client,
                                GAsyncResult *result,
                                GError **error)
{
	GSimpleAsyncResult *simple;

	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
	g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (result), FALSE);

	simple = G_SIMPLE_ASYNC_RESULT (result);
	if (g_simple_async_result_propagate_error (simple, error))
		return FALSE;
	else
		return g_simple_async_result_get_op_res_gboolean (simple);
}

699 700 701 702
/****************************************************************/
/* Devices                                                      */
/****************************************************************/

703
/**
704
 * nm_client_get_devices:
705 706
 * @client: a #NMClient
 *
707
 * Gets all the known network devices.  Use nm_device_get_type() or the
Dan Winship's avatar
Dan Winship committed
708 709 710
 * <literal>NM_IS_DEVICE_XXXX</literal> functions to determine what kind of
 * device member of the returned array is, and then you may use device-specific
 * methods such as nm_device_ethernet_get_hw_address().
711
 *
712 713 714
 * Returns: (transfer none) (element-type NMDevice): a #GPtrArray
 * containing all the #NMDevices.  The returned array is owned by the
 * #NMClient object and should not be modified.
715
 **/
716 717
const GPtrArray *
nm_client_get_devices (NMClient *client)
718
{
719
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);
720

721
	return nm_manager_get_devices (NM_CLIENT_GET_PRIVATE (client)->manager);
722 723
}

724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
/**
 * nm_client_get_all_devices:
 * @client: a #NMClient
 *
 * Gets both real devices and device placeholders (eg, software devices which
 * do not currently exist, but could be created automatically by NetworkManager
 * if one of their NMDevice::ActivatableConnections was activated).  Use
 * nm_device_is_real() to determine whether each device is a real device or
 * a placeholder.
 *
 * Use nm_device_get_type() or the NM_IS_DEVICE_XXXX() functions to determine
 * what kind of device each member of the returned array is, and then you may
 * use device-specific methods such as nm_device_ethernet_get_hw_address().
 *
 * Returns: (transfer none) (element-type NMDevice): a #GPtrArray
 * containing all the #NMDevices.  The returned array is owned by the
 * #NMClient object and should not be modified.
 *
 * Since: 1.2
 **/
const GPtrArray *
nm_client_get_all_devices (NMClient *client)
{
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);

	return nm_manager_get_all_devices (NM_CLIENT_GET_PRIVATE (client)->manager);
}

752
/**
753
 * nm_client_get_device_by_path:
754
 * @client: a #NMClient
755
 * @object_path: the object path to search for
756
 *
757 758 759
 * Gets a #NMDevice from a #NMClient.
 *
 * Returns: (transfer none): the #NMDevice for the given @object_path or %NULL if none is found.
760
 **/
761 762
NMDevice *
nm_client_get_device_by_path (NMClient *client, const char *object_path)
763
{
764 765
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);
	g_return_val_if_fail (object_path, NULL);
766

767
	return nm_manager_get_device_by_path (NM_CLIENT_GET_PRIVATE (client)->manager, object_path);
768 769 770
}

/**
771
 * nm_client_get_device_by_iface:
772
 * @client: a #NMClient
773
 * @iface: the interface name to search for
774
 *
775
 * Gets a #NMDevice from a #NMClient.
776
 *
777
 * Returns: (transfer none): the #NMDevice for the given @iface or %NULL if none is found.
778
 **/
779 780
NMDevice *
nm_client_get_device_by_iface (NMClient *client, const char *iface)
781
{
782 783 784
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);
	g_return_val_if_fail (iface, NULL);

785
	return nm_manager_get_device_by_iface (NM_CLIENT_GET_PRIVATE (client)->manager, iface);
786 787
}

788 789 790 791
/****************************************************************/
/* Active Connections                                           */
/****************************************************************/

792
/**
793
 * nm_client_get_active_connections:
794 795
 * @client: a #NMClient
 *
796
 * Gets the active connections.
797
 *
798 799 800
 * Returns: (transfer none) (element-type NMActiveConnection): a #GPtrArray
 *  containing all the active #NMActiveConnections.
 * The returned array is owned by the client and should not be modified.
801
 **/
802 803
const GPtrArray *
nm_client_get_active_connections (NMClient *client)
804 805 806
{
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);

807
	return nm_manager_get_active_connections (NM_CLIENT_GET_PRIVATE (client)->manager);
808 809 810
}

/**
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
 * nm_client_get_primary_connection:
 * @client: an #NMClient
 *
 * Gets the #NMActiveConnection corresponding to the primary active
 * network device.
 *
 * In particular, when there is no VPN active, or the VPN does not
 * have the default route, this returns the active connection that has
 * the default route. If there is a VPN active with the default route,
 * then this function returns the active connection that contains the
 * route to the VPN endpoint.
 *
 * If there is no default route, or the default route is over a
 * non-NetworkManager-recognized device, this will return %NULL.
 *
 * Returns: (transfer none): the appropriate #NMActiveConnection, if
 * any
 */
NMActiveConnection *
nm_client_get_primary_connection (NMClient *client)
{
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);

834
	return nm_manager_get_primary_connection (NM_CLIENT_GET_PRIVATE (client)->manager);
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
}

/**
 * nm_client_get_activating_connection:
 * @client: an #NMClient
 *
 * Gets the #NMActiveConnection corresponding to a
 * currently-activating connection that is expected to become the new
 * #NMClient:primary-connection upon successful activation.
 *
 * Returns: (transfer none): the appropriate #NMActiveConnection, if
 * any.
 */
NMActiveConnection *
nm_client_get_activating_connection (NMClient *client)
{
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);

853
	return nm_manager_get_activating_connection (NM_CLIENT_GET_PRIVATE (client)->manager);
854 855 856 857 858 859 860
}

static void
activate_cb (GObject *object,
             GAsyncResult *result,
             gpointer user_data)
{
861 862
	GSimpleAsyncResult *simple = user_data;
	NMActiveConnection *ac;
863 864
	GError *error = NULL;

865 866 867 868 869 870 871 872
	ac = nm_manager_activate_connection_finish (NM_MANAGER (object), result, &error);
	if (ac)
		g_simple_async_result_set_op_res_gpointer (simple, ac, g_object_unref);
	else
		g_simple_async_result_take_error (simple, error);

	g_simple_async_result_complete (simple);
	g_object_unref (simple);
873 874 875 876
}

/**
 * nm_client_activate_connection_async:
877
 * @client: a #NMClient
878 879 880 881 882 883 884 885 886 887 888 889
 * @connection: (allow-none): an #NMConnection
 * @device: (allow-none): the #NMDevice
 * @specific_object: (allow-none): the object path of a connection-type-specific
 *   object this activation should use. This parameter is currently ignored for
 *   wired and mobile broadband connections, and the value of %NULL should be used
 *   (ie, no specific object).  For Wi-Fi or WiMAX connections, pass the object
 *   path of a #NMAccessPoint or #NMWimaxNsp owned by @device, which you can
 *   get using nm_object_get_path(), and which will be used to complete the
 *   details of the newly added connection.
 * @cancellable: a #GCancellable, or %NULL
 * @callback: callback to be called when the activation has started
 * @user_data: caller-specific data passed to @callback
890
 *
891 892 893 894 895 896 897 898
 * Asynchronously starts a connection to a particular network using the
 * configuration settings from @connection and the network device @device.
 * Certain connection types also take a "specific object" which is the object
 * path of a connection- specific object, like an #NMAccessPoint for Wi-Fi
 * connections, or an #NMWimaxNsp for WiMAX connections, to which you wish to
 * connect.  If the specific object is not given, NetworkManager can, in some
 * cases, automatically determine which network to connect to given the settings
 * in @connection.
899
 *
900 901 902 903 904 905 906
 * If @connection is not given for a device-based activation, NetworkManager
 * picks the best available connection for the device and activates it.
 *
 * Note that the callback is invoked when NetworkManager has started activating
 * the new connection, not when it finishes. You can used the returned
 * #NMActiveConnection object (in particular, #NMActiveConnection:state) to
 * track the activation to its completion.
907
 **/
908 909 910 911 912 913 914 915
void
nm_client_activate_connection_async (NMClient *client,
                                     NMConnection *connection,
                                     NMDevice *device,
                                     const char *specific_object,
                                     GCancellable *cancellable,
                                     GAsyncReadyCallback callback,
                                     gpointer user_data)
916
{
917
	GSimpleAsyncResult *simple;
918
	GError *error = NULL;
919 920 921 922 923 924 925

	g_return_if_fail (NM_IS_CLIENT (client));
	if (device)
		g_return_if_fail (NM_IS_DEVICE (device));
	if (connection)
		g_return_if_fail (NM_IS_CONNECTION (connection));

926 927
	if (!_nm_client_check_nm_running (client, &error)) {
		g_simple_async_report_take_gerror_in_idle (G_OBJECT (client), callback, user_data, error);
928 929 930
		return;
	}

931 932 933 934 935
	simple = g_simple_async_result_new (G_OBJECT (client), callback, user_data,
	                                    nm_client_activate_connection_async);
	nm_manager_activate_connection_async (NM_CLIENT_GET_PRIVATE (client)->manager,
	                                      connection, device, specific_object,
	                                      cancellable, activate_cb, simple);
936 937 938
}

/**
939 940 941 942
 * nm_client_activate_connection_finish:
 * @client: an #NMClient
 * @result: the result passed to the #GAsyncReadyCallback
 * @error: location for a #GError, or %NULL
943
 *
944
 * Gets the result of a call to nm_client_activate_connection_async().
945
 *
946 947
 * Returns: (transfer full): the new #NMActiveConnection on success, %NULL on
 *   failure, in which case @error will be set.
948
 **/
949 950 951 952
NMActiveConnection *
nm_client_activate_connection_finish (NMClient *client,
                                      GAsyncResult *result,
                                      GError **error)
953
{
954
	GSimpleAsyncResult *simple;
955

956 957
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);
	g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (result), NULL);
958 959 960 961 962 963

	simple = G_SIMPLE_ASYNC_RESULT (result);
	if (g_simple_async_result_propagate_error (simple, error))
		return NULL;
	else
		return g_object_ref (g_simple_async_result_get_op_res_gpointer (simple));
964 965
}

966 967 968 969
static void
add_activate_cb (GObject *object,
                 GAsyncResult *result,
                 gpointer user_data)
970
{
971 972
	GSimpleAsyncResult *simple = user_data;
	NMActiveConnection *ac;
973
	GError *error = NULL;
974

975 976 977 978 979 980 981 982
	ac = nm_manager_add_and_activate_connection_finish (NM_MANAGER (object), result, &error);
	if (ac)
		g_simple_async_result_set_op_res_gpointer (simple, ac, g_object_unref);
	else
		g_simple_async_result_take_error (simple, error);

	g_simple_async_result_complete (simple);
	g_object_unref (simple);
983 984 985
}

/**
986
 * nm_client_add_and_activate_connection_async:
987
 * @client: a #NMClient
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
 * @partial: (allow-none): an #NMConnection to add; the connection may be
 *   partially filled (or even %NULL) and will be completed by NetworkManager
 *   using the given @device and @specific_object before being added
 * @device: the #NMDevice
 * @specific_object: (allow-none): the object path of a connection-type-specific
 *   object this activation should use. This parameter is currently ignored for
 *   wired and mobile broadband connections, and the value of %NULL should be used
 *   (ie, no specific object).  For Wi-Fi or WiMAX connections, pass the object
 *   path of a #NMAccessPoint or #NMWimaxNsp owned by @device, which you can
 *   get using nm_object_get_path(), and which will be used to complete the
 *   details of the newly added connection.
 * @cancellable: a #GCancellable, or %NULL
 * @callback: callback to be called when the activation has started
 * @user_data: caller-specific data passed to @callback
1002
 *
1003 1004 1005 1006 1007
 * Adds a new connection using the given details (if any) as a template,
 * automatically filling in missing settings with the capabilities of the given
 * device and specific object.  The new connection is then asynchronously
 * activated as with nm_client_activate_connection_async(). Cannot be used for
 * VPN connections at this time.
1008
 *
1009 1010 1011 1012
 * Note that the callback is invoked when NetworkManager has started activating
 * the new connection, not when it finishes. You can used the returned
 * #NMActiveConnection object (in particular, #NMActiveConnection:state) to
 * track the activation to its completion.
1013
 **/
1014 1015 1016 1017 1018 1019 1020 1021
void
nm_client_add_and_activate_connection_async (NMClient *client,
                                             NMConnection *partial,
                                             NMDevice *device,
                                             const char *specific_object,
                                             GCancellable *cancellable,
                                             GAsyncReadyCallback callback,
                                             gpointer user_data)
1022
{
1023
	GSimpleAsyncResult *simple;
1024
	GError *error = NULL;
1025 1026 1027 1028 1029

	g_return_if_fail (NM_IS_CLIENT (client));
	g_return_if_fail (NM_IS_DEVICE (device));
	if (partial)
		g_return_if_fail (NM_IS_CONNECTION (partial));
1030

1031 1032
	if (!_nm_client_check_nm_running (client, &error)) {
		g_simple_async_report_take_gerror_in_idle (G_OBJECT (client), callback, user_data, error);
1033
		return;
1034
	}
1035

1036 1037 1038 1039 1040
	simple = g_simple_async_result_new (G_OBJECT (client), callback, user_data,
	                                    nm_client_add_and_activate_connection_async);
	nm_manager_add_and_activate_connection_async (NM_CLIENT_GET_PRIVATE (client)->manager,
	                                              partial, device, specific_object,
	                                              cancellable, add_activate_cb, simple);
1041 1042 1043
}

/**
1044 1045 1046 1047
 * nm_client_add_and_activate_connection_finish:
 * @client: an #NMClient
 * @result: the result passed to the #GAsyncReadyCallback
 * @error: location for a #GError, or %NULL
1048
 *
1049
 * Gets the result of a call to nm_client_add_and_activate_connection_async().
1050
 *
1051 1052 1053 1054 1055
 * You can call nm_active_connection_get_connection() on the returned
 * #NMActiveConnection to find the path of the created #NMConnection.
 *
 * Returns: (transfer full): the new #NMActiveConnection on success, %NULL on
 *   failure, in which case @error will be set.
1056
 **/
1057 1058 1059 1060
NMActiveConnection *
nm_client_add_and_activate_connection_finish (NMClient *client,
                                              GAsyncResult *result,
                                              GError **error)
1061
{
1062
	GSimpleAsyncResult *simple;
1063

1064 1065
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);
	g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (result), NULL);
1066 1067 1068 1069 1070 1071

	simple = G_SIMPLE_ASYNC_RESULT (result);
	if (g_simple_async_result_propagate_error (simple, error))
		return NULL;
	else
		return g_object_ref (g_simple_async_result_get_op_res_gpointer (simple));
1072 1073 1074
}

/**
1075
 * nm_client_deactivate_connection:
1076
 * @client: a #NMClient
1077 1078 1079
 * @active: the #NMActiveConnection to deactivate
 * @cancellable: a #GCancellable, or %NULL
 * @error: location for a #GError, or %NULL
1080
 *
1081
 * Deactivates an active #NMActiveConnection.
1082
 *
1083
 * Returns: success or failure
1084 1085
 **/
gboolean
1086 1087 1088 1089
nm_client_deactivate_connection (NMClient *client,
                                 NMActiveConnection *active,
                                 GCancellable *cancellable,
                                 GError **error)
1090 1091
{
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
1092
	g_return_val_if_fail (NM_IS_ACTIVE_CONNECTION (active), FALSE);
1093

1094
	if (!_nm_client_check_nm_running (client, NULL))
1095 1096
		return TRUE;

1097 1098
	return nm_manager_deactivate_connection (NM_CLIENT_GET_PRIVATE (client)->manager,
	                                         active, cancellable, error);
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
}

static void
deactivated_cb (GObject *object,
                GAsyncResult *result,
                gpointer user_data)
{
	GSimpleAsyncResult *simple = user_data;
	GError *error = NULL;

1109
	if (nm_manager_deactivate_connection_finish (NM_MANAGER (object), result, &error))
1110 1111 1112 1113 1114
		g_simple_async_result_set_op_res_gboolean (simple, TRUE);
	else
		g_simple_async_result_take_error (simple, error);
	g_simple_async_result_complete (simple);
	g_object_unref (simple);
1115 1116 1117
}

/**
1118
 * nm_client_deactivate_connection_async:
1119
 * @client: a #NMClient
1120 1121 1122 1123
 * @active: the #NMActiveConnection to deactivate
 * @cancellable: a #GCancellable, or %NULL
 * @callback: callback to be called when the deactivation has completed
 * @user_data: caller-specific data passed to @callback
1124
 *
1125
 * Asynchronously deactivates an active #NMActiveConnection.
1126
 **/
1127 1128 1129 1130 1131 1132
void
nm_client_deactivate_connection_async (NMClient *client,
                                       NMActiveConnection *active,
                                       GCancellable *cancellable,
                                       GAsyncReadyCallback callback,
                                       gpointer user_data)
1133
{
1134
	GSimpleAsyncResult *simple;
1135

1136 1137 1138 1139 1140
	g_return_if_fail (NM_IS_CLIENT (client));
	g_return_if_fail (NM_IS_ACTIVE_CONNECTION (active));

	simple = g_simple_async_result_new (G_OBJECT (client), callback, user_data,
	                                    nm_client_deactivate_connection_async);
1141

1142
	if (!_nm_client_check_nm_running (client, NULL)) {
1143 1144 1145 1146
		g_simple_async_result_set_op_res_gboolean (simple, TRUE);
		g_simple_async_result_complete_in_idle (simple);
		g_object_unref (simple);
		return;
1147 1148
	}

1149 1150 1151
	nm_manager_deactivate_connection_async (NM_CLIENT_GET_PRIVATE (client)->manager,
	                                        active,
	                                        cancellable, deactivated_cb, simple);
1152 1153 1154
}

/**
1155 1156 1157 1158
 * nm_client_deactivate_connection_finish:
 * @client: a #NMClient
 * @result: the result passed to the #GAsyncReadyCallback
 * @error: location for a #GError, or %NULL
1159
 *
1160
 * Gets the result of a call to nm_client_deactivate_connection_async().
1161
 *
1162 1163 1164 1165 1166 1167
 * Returns: success or failure
 **/
gboolean
nm_client_deactivate_connection_finish (NMClient *client,
                                        GAsyncResult *result,
                                        GError **error)
1168
{
1169
	GSimpleAsyncResult *simple;
1170

1171 1172
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
	g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (result), FALSE);
1173

1174 1175 1176 1177 1178
	simple = G_SIMPLE_ASYNC_RESULT (result);
	if (g_simple_async_result_propagate_error (simple, error))
		return FALSE;
	else
		return g_simple_async_result_get_op_res_gboolean (simple);
1179 1180
}