nm-client.c 98.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
#include "nm-device-ethernet.h"
#include "nm-device-wifi.h"
32
#include "nm-core-internal.h"
33 34
#include "nm-active-connection.h"
#include "nm-vpn-connection.h"
35
#include "nm-remote-connection.h"
Dan Winship's avatar
Dan Winship committed
36
#include "nm-dbus-helpers.h"
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
#include "nm-wimax-nsp.h"
#include "nm-object-private.h"

#include "nmdbus-manager.h"
#include "nmdbus-settings.h"
#include "nmdbus-access-point.h"
#include "nmdbus-active-connection.h"
#include "nmdbus-device-adsl.h"
#include "nmdbus-device-bond.h"
#include "nmdbus-device-bridge.h"
#include "nmdbus-device-bt.h"
#include "nmdbus-device-ethernet.h"
#include "nmdbus-device-generic.h"
#include "nmdbus-device-infiniband.h"
#include "nmdbus-device-ip-tunnel.h"
#include "nmdbus-device-macvlan.h"
#include "nmdbus-device-modem.h"
#include "nmdbus-device-olpc-mesh.h"
#include "nmdbus-device-team.h"
#include "nmdbus-device-tun.h"
#include "nmdbus-device-vlan.h"
#include "nmdbus-device-vxlan.h"
#include "nmdbus-device-wifi.h"
#include "nmdbus-device-wimax.h"
#include "nmdbus-device.h"
#include "nmdbus-dhcp4-config.h"
#include "nmdbus-dhcp6-config.h"
#include "nmdbus-ip4-config.h"
#include "nmdbus-ip6-config.h"
#include "nmdbus-settings-connection.h"
#include "nmdbus-vpn-connection.h"
#include "nmdbus-wimax-nsp.h"

#include "nm-access-point.h"
#include "nm-active-connection.h"
#include "nm-device-adsl.h"
#include "nm-device-bond.h"
#include "nm-device-bridge.h"
#include "nm-device-bt.h"
#include "nm-device-ethernet.h"
#include "nm-device-generic.h"
#include "nm-device-infiniband.h"
#include "nm-device-ip-tunnel.h"
#include "nm-device-macvlan.h"
#include "nm-device-modem.h"
#include "nm-device-olpc-mesh.h"
#include "nm-device-team.h"
#include "nm-device-tun.h"
#include "nm-device-vlan.h"
#include "nm-device-vxlan.h"
#include "nm-device-wifi.h"
#include "nm-device-wimax.h"
#include "nm-dhcp4-config.h"
#include "nm-dhcp6-config.h"
#include "nm-dhcp-config.h"
#include "nm-ip4-config.h"
#include "nm-ip6-config.h"
#include "nm-manager.h"
#include "nm-remote-connection.h"
#include "nm-remote-settings.h"
#include "nm-vpn-connection.h"
Dan Winship's avatar
Dan Winship committed
98

99 100 101 102 103
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);

104
G_DEFINE_TYPE_WITH_CODE (NMClient, nm_client, G_TYPE_OBJECT,
105 106 107 108 109 110 111
                         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 {
112
	NMManager *manager;
113
	NMRemoteSettings *settings;
114 115
	GDBusObjectManager *object_manager;
	GCancellable *new_object_manager_cancellable;
116 117 118 119 120 121 122
} NMClientPrivate;

enum {
	PROP_0,
	PROP_VERSION,
	PROP_STATE,
	PROP_STARTUP,
123
	PROP_NM_RUNNING,
124 125 126 127 128 129 130 131 132 133 134 135
	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,
136
	PROP_ALL_DEVICES,
137 138 139
	PROP_CONNECTIONS,
	PROP_HOSTNAME,
	PROP_CAN_MODIFY,
140
	PROP_METERED,
141 142 143 144 145 146 147

	LAST_PROP
};

enum {
	DEVICE_ADDED,
	DEVICE_REMOVED,
148 149
	ANY_DEVICE_ADDED,
	ANY_DEVICE_REMOVED,
150
	PERMISSION_CHANGED,
151 152
	CONNECTION_ADDED,
	CONNECTION_REMOVED,
153 154
	ACTIVE_CONNECTION_ADDED,
	ACTIVE_CONNECTION_REMOVED,
155 156 157 158 159 160

	LAST_SIGNAL
};

static guint signals[LAST_SIGNAL] = { 0 };

161 162
static const GPtrArray empty = { 0, };

163
/*****************************************************************************/
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181

/**
 * 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;
}

182
/*****************************************************************************/
183 184 185 186 187 188

static void
nm_client_init (NMClient *client)
{
}

189 190 191 192 193 194 195 196 197 198 199 200 201 202
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;
	}
}

203
/**
204
 * nm_client_get_version:
205 206
 * @client: a #NMClient
 *
207
 * Gets NetworkManager version.
208
 *
209
 * Returns: string with the version (or %NULL if NetworkManager is not running)
210
 **/
211 212
const char *
nm_client_get_version (NMClient *client)
213 214 215
{
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);

216 217 218
	if (!nm_client_get_nm_running (client))
		return NULL;

219
	return nm_manager_get_version (NM_CLIENT_GET_PRIVATE (client)->manager);
220 221 222
}

/**
223
 * nm_client_get_state:
224 225
 * @client: a #NMClient
 *
226
 * Gets the current daemon state.
227
 *
228
 * Returns: the current %NMState
229
 **/
230 231
NMState
nm_client_get_state (NMClient *client)
232
{
233
	g_return_val_if_fail (NM_IS_CLIENT (client), NM_STATE_UNKNOWN);
234

235 236 237
	if (!nm_client_get_nm_running (client))
		return NM_STATE_UNKNOWN;

238
	return nm_manager_get_state (NM_CLIENT_GET_PRIVATE (client)->manager);
239 240 241
}

/**
242
 * nm_client_get_startup:
243 244
 * @client: a #NMClient
 *
245 246
 * Tests whether the daemon is still in the process of activating
 * connections at startup.
247
 *
248
 * Returns: whether the daemon is still starting up
249
 **/
250 251
gboolean
nm_client_get_startup (NMClient *client)
252
{
253 254 255 256
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);

	if (!nm_client_get_nm_running (client))
		return FALSE;
257

258
	return nm_manager_get_startup (NM_CLIENT_GET_PRIVATE (client)->manager);
259 260
}

261 262 263 264 265 266 267 268 269 270
/**
 * 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)
271
{
272
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
273

274
	return NM_CLIENT_GET_PRIVATE (client)->manager != NULL;
275 276
}

277 278 279 280 281 282 283 284 285 286
/**
 * 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)
287
{
288
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
289

290 291 292
	if (!nm_client_get_nm_running (client))
		return FALSE;

293
	return nm_manager_networking_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
294 295
}

296 297 298 299 300 301 302 303 304 305 306 307 308 309
/**
 * 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)
310
{
311
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
312

313
	if (!_nm_client_check_nm_running (client, error))
314
		return FALSE;
315

316 317
	return nm_manager_networking_set_enabled (NM_CLIENT_GET_PRIVATE (client)->manager,
	                                          enable, error);
318 319
}

320 321 322 323 324 325 326 327 328 329
/**
 * 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)
330
{
331
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
332

333 334 335
	if (!nm_client_get_nm_running (client))
		return FALSE;

336
	return nm_manager_wireless_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
337 338 339
}

/**
340
 * nm_client_wireless_set_enabled:
341
 * @client: a #NMClient
342
 * @enabled: %TRUE to enable wireless
343
 *
344
 * Enables or disables wireless devices.
345 346
 **/
void
347
nm_client_wireless_set_enabled (NMClient *client, gboolean enabled)
348 349 350
{
	g_return_if_fail (NM_IS_CLIENT (client));

351
	if (!nm_client_get_nm_running (client))
352
		return;
353

354
	nm_manager_wireless_set_enabled (NM_CLIENT_GET_PRIVATE (client)->manager, enabled);
355 356
}

357
/**
358 359
 * nm_client_wireless_hardware_get_enabled:
 * @client: a #NMClient
360
 *
361
 * Determines whether the wireless hardware is enabled.
362
 *
363
 * Returns: %TRUE if the wireless hardware is enabled
364
 **/
365 366
gboolean
nm_client_wireless_hardware_get_enabled (NMClient *client)
367
{
368
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
369

370 371 372
	if (!nm_client_get_nm_running (client))
		return FALSE;

373
	return nm_manager_wireless_hardware_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
374 375
}

376 377 378 379 380 381 382 383 384 385
/**
 * 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)
386
{
387
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
388

389 390 391
	if (!nm_client_get_nm_running (client))
		return FALSE;

392
	return nm_manager_wwan_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
393 394 395
}

/**
396
 * nm_client_wwan_set_enabled:
397
 * @client: a #NMClient
398
 * @enabled: %TRUE to enable WWAN
399
 *
400
 * Enables or disables WWAN devices.
401 402
 **/
void
403
nm_client_wwan_set_enabled (NMClient *client, gboolean enabled)
404 405
{
	g_return_if_fail (NM_IS_CLIENT (client));
406

407
	if (!_nm_client_check_nm_running (client, NULL))
408
		return;
409

410
	nm_manager_wwan_set_enabled (NM_CLIENT_GET_PRIVATE (client)->manager, enabled);
411
}
412

413
/**
414 415
 * nm_client_wwan_hardware_get_enabled:
 * @client: a #NMClient
416
 *
417
 * Determines whether the WWAN hardware is enabled.
418
 *
419
 * Returns: %TRUE if the WWAN hardware is enabled
420
 **/
421 422
gboolean
nm_client_wwan_hardware_get_enabled (NMClient *client)
423
{
424
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
425

426 427 428
	if (!nm_client_get_nm_running (client))
		return FALSE;

429
	return nm_manager_wwan_hardware_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
430 431 432
}

/**
433
 * nm_client_wimax_get_enabled:
434 435
 * @client: a #NMClient
 *
436
 * Determines whether WiMAX is enabled.
437
 *
438
 * Returns: %TRUE if WiMAX is enabled
439
 **/
440
gboolean
441
nm_client_wimax_get_enabled (NMClient *client)
442
{
443
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
444

445 446 447
	if (!nm_client_get_nm_running (client))
		return FALSE;

448
	return nm_manager_wimax_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
449 450 451
}

/**
452
 * nm_client_wimax_set_enabled:
453
 * @client: a #NMClient
454
 * @enabled: %TRUE to enable WiMAX
455
 *
456
 * Enables or disables WiMAX devices.
457 458
 **/
void
459
nm_client_wimax_set_enabled (NMClient *client, gboolean enabled)
460 461 462
{
	g_return_if_fail (NM_IS_CLIENT (client));

463
	if (!nm_client_get_nm_running (client))
464 465
		return;

466
	nm_manager_wimax_set_enabled (NM_CLIENT_GET_PRIVATE (client)->manager, enabled);
467 468 469
}

/**
470
 * nm_client_wimax_hardware_get_enabled:
471 472
 * @client: a #NMClient
 *
473
 * Determines whether the WiMAX hardware is enabled.
474
 *
475
 * Returns: %TRUE if the WiMAX hardware is enabled
476 477
 **/
gboolean
478
nm_client_wimax_hardware_get_enabled (NMClient *client)
479
{
480
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
481

482 483 484
	if (!nm_client_get_nm_running (client))
		return FALSE;

485
	return nm_manager_wimax_hardware_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
486 487
}

488
/**
489
 * nm_client_get_logging:
490
 * @client: a #NMClient
491 492 493 494
 * @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
495
 *
496
 * Gets NetworkManager current logging level and domains.
497
 *
498
 * Returns: %TRUE on success, %FALSE otherwise
499
 **/
500 501
gboolean
nm_client_get_logging (NMClient *client, char **level, char **domains, GError **error)
502
{
503 504 505 506
	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);
507

508
	if (!_nm_client_check_nm_running (client, error))
509
		return FALSE;
510

511 512
	return nm_manager_get_logging (NM_CLIENT_GET_PRIVATE (client)->manager,
	                               level, domains, error);
513 514 515
}

/**
516
 * nm_client_set_logging:
517
 * @client: a #NMClient
518 519 520 521
 * @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
522
 *
523
 * Sets NetworkManager logging level and/or domains.
524
 *
525
 * Returns: %TRUE on success, %FALSE otherwise
526 527
 **/
gboolean
528
nm_client_set_logging (NMClient *client, const char *level, const char *domains, GError **error)
529 530
{
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
531
	g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
532

533
	if (!_nm_client_check_nm_running (client, error))
534
		return FALSE;
535

536 537
	return nm_manager_set_logging (NM_CLIENT_GET_PRIVATE (client)->manager,
	                               level, domains, error);
538 539 540
}

/**
541
 * nm_client_get_permission_result:
542
 * @client: a #NMClient
543
 * @permission: the permission for which to return the result, one of #NMClientPermission
544
 *
545 546
 * Requests the result of a specific permission, which indicates whether the
 * client can or cannot perform the action the permission represents
547
 *
548
 * Returns: the permission's result, one of #NMClientPermissionResult
549
 **/
550 551
NMClientPermissionResult
nm_client_get_permission_result (NMClient *client, NMClientPermission permission)
552
{
553 554
	g_return_val_if_fail (NM_IS_CLIENT (client), NM_CLIENT_PERMISSION_RESULT_UNKNOWN);

555 556 557
	if (!nm_client_get_nm_running (client))
		return NM_CLIENT_PERMISSION_RESULT_UNKNOWN;

558
	return nm_manager_get_permission_result (NM_CLIENT_GET_PRIVATE (client)->manager, permission);
559 560 561
}

/**
562 563
 * nm_client_get_connectivity:
 * @client: an #NMClient
564
 *
565 566 567 568
 * 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.
569
 *
570 571 572 573
 * Returns: the current connectivity state
 */
NMConnectivityState
nm_client_get_connectivity (NMClient *client)
574
{
575
	g_return_val_if_fail (NM_IS_CLIENT (client), NM_CONNECTIVITY_UNKNOWN);
576

577 578 579
	if (!nm_client_get_nm_running (client))
		return NM_CONNECTIVITY_UNKNOWN;

580
	return nm_manager_get_connectivity (NM_CLIENT_GET_PRIVATE (client)->manager);
581 582 583
}

/**
584 585 586 587
 * nm_client_check_connectivity:
 * @client: an #NMClient
 * @cancellable: a #GCancellable
 * @error: return location for a #GError
588
 *
589 590 591 592 593 594 595 596 597 598 599 600 601
 * 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)
602
{
603
	g_return_val_if_fail (NM_IS_CLIENT (client), NM_CONNECTIVITY_UNKNOWN);
604

605 606 607
	if (!_nm_client_check_nm_running (client, error))
		return NM_CONNECTIVITY_UNKNOWN;

608 609
	return nm_manager_check_connectivity (NM_CLIENT_GET_PRIVATE (client)->manager,
	                                      cancellable, error);
610 611 612 613 614 615 616 617
}

static void
check_connectivity_cb (GObject *object,
                       GAsyncResult *result,
                       gpointer user_data)
{
	GSimpleAsyncResult *simple = user_data;
618
	NMConnectivityState connectivity;
619 620
	GError *error = NULL;

621 622 623
	connectivity = nm_manager_check_connectivity_finish (NM_MANAGER (object),
	                                                     result, &error);
	if (!error)
624 625 626 627 628 629
		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);
630 631 632
}

/**
633 634 635 636 637
 * nm_client_check_connectivity_async:
 * @client: an #NMClient
 * @cancellable: a #GCancellable
 * @callback: callback to call with the result
 * @user_data: data for @callback.
638
 *
639 640 641 642 643 644 645 646 647 648 649 650
 * 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;
651
	GError *error = NULL;
652 653

	g_return_if_fail (NM_IS_CLIENT (client));
654 655 656 657 658

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

	simple = g_simple_async_result_new (G_OBJECT (client), callback, user_data,
	                                    nm_client_check_connectivity_async);
662 663
	nm_manager_check_connectivity_async (NM_CLIENT_GET_PRIVATE (client)->manager,
	                                     cancellable, check_connectivity_cb, simple);
664 665 666 667 668 669 670
}

/**
 * nm_client_check_connectivity_finish:
 * @client: an #NMClient
 * @result: the #GAsyncResult
 * @error: return location for a #GError
671
 *
672 673 674 675 676 677 678 679 680
 * 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)
681
{
682
	GSimpleAsyncResult *simple;
683

684 685
	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);
686 687 688 689 690 691

	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);
692 693
}

694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715

/**
 * 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);

716 717 718
	if (!_nm_client_check_nm_running (client, error))
		return FALSE;

719 720 721 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 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
	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);
}

803
/*****************************************************************************/
804
/* Devices                                                      */
805
/*****************************************************************************/
806

807
/**
808
 * nm_client_get_devices:
809 810
 * @client: a #NMClient
 *
811
 * Gets all the known network devices.  Use nm_device_get_type() or the
Dan Winship's avatar
Dan Winship committed
812 813 814
 * <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().
815
 *
816 817 818
 * 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.
819
 **/
820 821
const GPtrArray *
nm_client_get_devices (NMClient *client)
822
{
823
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);
824

825 826 827
	if (!nm_client_get_nm_running (client))
		return &empty;

828
	return nm_manager_get_devices (NM_CLIENT_GET_PRIVATE (client)->manager);
829 830
}

831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
/**
 * 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);

856 857 858
	if (!nm_client_get_nm_running (client))
		return &empty;

859 860 861
	return nm_manager_get_all_devices (NM_CLIENT_GET_PRIVATE (client)->manager);
}

862
/**
863
 * nm_client_get_device_by_path:
864
 * @client: a #NMClient
865
 * @object_path: the object path to search for
866
 *
867 868 869
 * Gets a #NMDevice from a #NMClient.
 *
 * Returns: (transfer none): the #NMDevice for the given @object_path or %NULL if none is found.
870
 **/
871 872
NMDevice *
nm_client_get_device_by_path (NMClient *client, const char *object_path)
873
{
874 875
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);
	g_return_val_if_fail (object_path, NULL);
876

877 878 879
	if (!nm_client_get_nm_running (client))
		return NULL;

880
	return nm_manager_get_device_by_path (NM_CLIENT_GET_PRIVATE (client)->manager, object_path);
881 882 883
}

/**
884
 * nm_client_get_device_by_iface:
885
 * @client: a #NMClient
886
 * @iface: the interface name to search for
887
 *
888
 * Gets a #NMDevice from a #NMClient.
889
 *
890
 * Returns: (transfer none): the #NMDevice for the given @iface or %NULL if none is found.
891
 **/
892 893
NMDevice *
nm_client_get_device_by_iface (NMClient *client, const char *iface)
894
{
895 896 897
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);
	g_return_val_if_fail (iface, NULL);

898 899 900
	if (!nm_client_get_nm_running (client))
		return NULL;

901
	return nm_manager_get_device_by_iface (NM_CLIENT_GET_PRIVATE (client)->manager, iface);
902 903
}

904
/*****************************************************************************/
905
/* Active Connections                                           */
906
/*****************************************************************************/
907

908
/**
909
 * nm_client_get_active_connections:
910 911
 * @client: a #NMClient
 *
912
 * Gets the active connections.
913
 *
914 915 916
 * 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.
917
 **/
918 919
const GPtrArray *
nm_client_get_active_connections (NMClient *client)
920 921 922
{
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);

923 924 925
	if (!nm_client_get_nm_running (client))
		return &empty;

926
	return nm_manager_get_active_connections (NM_CLIENT_GET_PRIVATE (client)->manager);
927 928 929
}

/**
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
 * 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);

953 954 955
	if (!nm_client_get_nm_running (client))
		return NULL;

956
	return nm_manager_get_primary_connection (NM_CLIENT_GET_PRIVATE (client)->manager);
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
}

/**
 * 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);

975 976 977
	if (!nm_client_get_nm_running (client))
		return NULL;

978
	return nm_manager_get_activating_connection (NM_CLIENT_GET_PRIVATE (client)->manager);
979 980 981 982 983 984 985
}

static void
activate_cb (GObject *object,
             GAsyncResult *result,
             gpointer user_data)
{
986 987
	GSimpleAsyncResult *simple = user_data;
	NMActiveConnection *ac;
988 989
	GError *error = NULL;

990 991 992 993 994 995 996 997
	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);
998 999 1000 1001
}

/**
 * nm_client_activate_connection_async:
1002
 * @client: a #NMClient
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
 * @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
1015
 *
1016 1017 1018 1019 1020 1021 1022 1023
 * 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.
1024
 *
1025 1026 1027 1028 1029 1030 1031
 * 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.
1032
 **/
1033 1034 1035 1036 1037 1038 1039 1040
void
nm_client_activate_connection_async (NMClient *client,
                                     NMConnection *connection,
                                     NMDevice *device,
                                     const char *specific_object,
                                     GCancellable *cancellable,
                                     GAsyncReadyCallback callback,
                                     gpointer user_data)
1041
{
1042
	GSimpleAsyncResult *simple;
1043
	GError *error = NULL;
1044 1045 1046 1047 1048 1049 1050

	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));

1051 1052
	if (!_nm_client_check_nm_running (client, &error)) {
		g_simple_async_report_take_gerror_in_idle (G_OBJECT (client), callback, user_data, error);
1053 1054 1055
		return;
	}

1056 1057 1058 1059 1060
	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);
1061 1062 1063
}

/**
1064 1065 1066 1067
 * nm_client_activate_connection_finish:
 * @client: an #NMClient
 * @result: the result passed to the #GAsyncReadyCallback
 * @error: location for a #GError, or %NULL
1068
 *
1069
 * Gets the result of a call to nm_client_activate_connection_async().
1070
 *
1071 1072
 * Returns: (transfer full): the new #NMActiveConnection on success, %NULL on
 *   failure, in which case @error will be set.
1073
 **/
1074 1075 1076 1077
NMActiveConnection *
nm_client_activate_connection_finish (NMClient *client,
                                      GAsyncResult *result,
                                      GError **error)
1078
{
1079
	GSimpleAsyncResult *simple;
1080

1081 1082
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);
	g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (result), NULL);
1083 1084 1085 1086 1087 1088

	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));
1089 1090
}

1091 1092 1093 1094
static void
add_activate_cb (GObject *object,
                 GAsyncResult *result,
                 gpointer user_data)
1095
{
1096 1097
	GSimpleAsyncResult *simple = user_data;
	NMActiveConnection *ac;
1098
	GError *error = NULL;
1099

1100 1101 1102 1103 1104 1105 1106 1107
	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);
1108 1109 1110
}

/**
1111
 * nm_client_add_and_activate_connection_async:
1112
 * @client: a #NMClient
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
 * @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
1127
 *
1128 1129 1130 1131 1132
 * 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.
1133
 *
1134 1135 1136 1137
 * 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.
1138
 **/
1139 1140 1141 1142 1143 1144 1145 1146
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)
1147
{
1148
	GSimpleAsyncResult *simple;
1149
	GError *error = NULL;
1150 1151 1152 1153 1154

	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));
1155

1156 1157
	if (!_nm_client_check_nm_running (client, &error)) {
		g_simple_async_report_take_gerror_in_idle (G_OBJECT (client), callback, user_data, error);
1158
		return;
1159
	}
1160

1161 1162 1163 1164 1165
	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);
1166 1167 1168
}

/**
1169 1170 1171 1172
 * nm_client_add_and_activate_connection_finish:
 * @client: an #NMClient
 * @result: the result passed to the #GAsyncReadyCallback
 * @error: location for a #GError, or %NULL
1173
 *
1174
 * Gets the result of a call to nm_client_add_and_activate_connection_async().
1175
 *
1176 1177 1178 1179 1180
 * 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.
1181
 **/
1182 1183 1184 1185
NMActiveConnection *
nm_client_add_and_activate_connection_finish (NMClient *client,
                                              GAsyncResult *result,
                                              GError **error)
1186
{
1187
	GSimpleAsyncResult *simple;
1188

1189 1190
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);
	g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (result), NULL);
1191 1192 1193 1194 1195 1196

	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));
1197 1198 1199
}

/**
1200
 * nm_client_deactivate_connection:
1201
 * @client: a #NMClient
1202 1203 1204
 * @active: the #NMActiveConnection to deactivate
 * @cancellable: a #GCancellable, or %NULL
 * @error: location for a #GError, or %NULL
1205
 *
1206
 * Deactivates an active #NMActiveConnection.
1207
 *
1208
 * Returns: success or failure
1209 1210
 **/
gboolean