nm-client.c 97.9 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
#include "nm-wimax-nsp.h"
#include "nm-object-private.h"

#include "nmdbus-manager.h"
#include "nmdbus-device-wifi.h"
#include "nmdbus-device.h"
43
#include "nmdbus-settings.h"
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
#include "nmdbus-settings-connection.h"
#include "nmdbus-vpn-connection.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
75

76 77 78 79 80
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);

81
G_DEFINE_TYPE_WITH_CODE (NMClient, nm_client, G_TYPE_OBJECT,
82 83 84 85 86 87 88
                         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 {
89
	NMManager *manager;
90
	NMRemoteSettings *settings;
91 92
	GDBusObjectManager *object_manager;
	GCancellable *new_object_manager_cancellable;
93 94 95 96 97 98 99
} NMClientPrivate;

enum {
	PROP_0,
	PROP_VERSION,
	PROP_STATE,
	PROP_STARTUP,
100
	PROP_NM_RUNNING,
101 102 103 104 105 106 107 108 109 110 111 112
	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,
113
	PROP_ALL_DEVICES,
114 115 116
	PROP_CONNECTIONS,
	PROP_HOSTNAME,
	PROP_CAN_MODIFY,
117
	PROP_METERED,
118 119 120 121 122 123 124

	LAST_PROP
};

enum {
	DEVICE_ADDED,
	DEVICE_REMOVED,
125 126
	ANY_DEVICE_ADDED,
	ANY_DEVICE_REMOVED,
127
	PERMISSION_CHANGED,
128 129
	CONNECTION_ADDED,
	CONNECTION_REMOVED,
130 131
	ACTIVE_CONNECTION_ADDED,
	ACTIVE_CONNECTION_REMOVED,
132 133 134 135 136 137

	LAST_SIGNAL
};

static guint signals[LAST_SIGNAL] = { 0 };

138 139
static const GPtrArray empty = { 0, };

140
/*****************************************************************************/
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158

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

159
/*****************************************************************************/
160 161 162 163 164 165

static void
nm_client_init (NMClient *client)
{
}

166 167 168 169 170 171 172 173 174 175 176 177 178 179
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;
	}
}

180
/**
181
 * nm_client_get_version:
182 183
 * @client: a #NMClient
 *
184
 * Gets NetworkManager version.
185
 *
186
 * Returns: string with the version (or %NULL if NetworkManager is not running)
187
 **/
188 189
const char *
nm_client_get_version (NMClient *client)
190 191 192
{
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);

193 194 195
	if (!nm_client_get_nm_running (client))
		return NULL;

196
	return nm_manager_get_version (NM_CLIENT_GET_PRIVATE (client)->manager);
197 198 199
}

/**
200
 * nm_client_get_state:
201 202
 * @client: a #NMClient
 *
203
 * Gets the current daemon state.
204
 *
205
 * Returns: the current %NMState
206
 **/
207 208
NMState
nm_client_get_state (NMClient *client)
209
{
210
	g_return_val_if_fail (NM_IS_CLIENT (client), NM_STATE_UNKNOWN);
211

212 213 214
	if (!nm_client_get_nm_running (client))
		return NM_STATE_UNKNOWN;

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

/**
219
 * nm_client_get_startup:
220 221
 * @client: a #NMClient
 *
222 223
 * Tests whether the daemon is still in the process of activating
 * connections at startup.
224
 *
225
 * Returns: whether the daemon is still starting up
226
 **/
227 228
gboolean
nm_client_get_startup (NMClient *client)
229
{
230 231 232 233
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);

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

235
	return nm_manager_get_startup (NM_CLIENT_GET_PRIVATE (client)->manager);
236 237
}

238 239 240 241 242 243 244 245 246 247
/**
 * 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)
248
{
249
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
250

251
	return NM_CLIENT_GET_PRIVATE (client)->manager != NULL;
252 253
}

254 255 256 257 258 259 260 261 262 263
/**
 * 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)
264
{
265
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
266

267 268 269
	if (!nm_client_get_nm_running (client))
		return FALSE;

270
	return nm_manager_networking_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
271 272
}

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

290
	if (!_nm_client_check_nm_running (client, error))
291
		return FALSE;
292

293 294
	return nm_manager_networking_set_enabled (NM_CLIENT_GET_PRIVATE (client)->manager,
	                                          enable, error);
295 296
}

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

310 311 312
	if (!nm_client_get_nm_running (client))
		return FALSE;

313
	return nm_manager_wireless_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
314 315 316
}

/**
317
 * nm_client_wireless_set_enabled:
318
 * @client: a #NMClient
319
 * @enabled: %TRUE to enable wireless
320
 *
321
 * Enables or disables wireless devices.
322 323
 **/
void
324
nm_client_wireless_set_enabled (NMClient *client, gboolean enabled)
325 326 327
{
	g_return_if_fail (NM_IS_CLIENT (client));

328
	if (!nm_client_get_nm_running (client))
329
		return;
330

331
	nm_manager_wireless_set_enabled (NM_CLIENT_GET_PRIVATE (client)->manager, enabled);
332 333
}

334
/**
335 336
 * nm_client_wireless_hardware_get_enabled:
 * @client: a #NMClient
337
 *
338
 * Determines whether the wireless hardware is enabled.
339
 *
340
 * Returns: %TRUE if the wireless hardware is enabled
341
 **/
342 343
gboolean
nm_client_wireless_hardware_get_enabled (NMClient *client)
344
{
345
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
346

347 348 349
	if (!nm_client_get_nm_running (client))
		return FALSE;

350
	return nm_manager_wireless_hardware_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
351 352
}

353 354 355 356 357 358 359 360 361 362
/**
 * 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)
363
{
364
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
365

366 367 368
	if (!nm_client_get_nm_running (client))
		return FALSE;

369
	return nm_manager_wwan_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
370 371 372
}

/**
373
 * nm_client_wwan_set_enabled:
374
 * @client: a #NMClient
375
 * @enabled: %TRUE to enable WWAN
376
 *
377
 * Enables or disables WWAN devices.
378 379
 **/
void
380
nm_client_wwan_set_enabled (NMClient *client, gboolean enabled)
381 382
{
	g_return_if_fail (NM_IS_CLIENT (client));
383

384
	if (!_nm_client_check_nm_running (client, NULL))
385
		return;
386

387
	nm_manager_wwan_set_enabled (NM_CLIENT_GET_PRIVATE (client)->manager, enabled);
388
}
389

390
/**
391 392
 * nm_client_wwan_hardware_get_enabled:
 * @client: a #NMClient
393
 *
394
 * Determines whether the WWAN hardware is enabled.
395
 *
396
 * Returns: %TRUE if the WWAN hardware is enabled
397
 **/
398 399
gboolean
nm_client_wwan_hardware_get_enabled (NMClient *client)
400
{
401
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
402

403 404 405
	if (!nm_client_get_nm_running (client))
		return FALSE;

406
	return nm_manager_wwan_hardware_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
407 408 409
}

/**
410
 * nm_client_wimax_get_enabled:
411 412
 * @client: a #NMClient
 *
413
 * Determines whether WiMAX is enabled.
414
 *
415
 * Returns: %TRUE if WiMAX is enabled
416
 **/
417
gboolean
418
nm_client_wimax_get_enabled (NMClient *client)
419
{
420
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
421

422 423 424
	if (!nm_client_get_nm_running (client))
		return FALSE;

425
	return nm_manager_wimax_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
426 427 428
}

/**
429
 * nm_client_wimax_set_enabled:
430
 * @client: a #NMClient
431
 * @enabled: %TRUE to enable WiMAX
432
 *
433
 * Enables or disables WiMAX devices.
434 435
 **/
void
436
nm_client_wimax_set_enabled (NMClient *client, gboolean enabled)
437 438 439
{
	g_return_if_fail (NM_IS_CLIENT (client));

440
	if (!nm_client_get_nm_running (client))
441 442
		return;

443
	nm_manager_wimax_set_enabled (NM_CLIENT_GET_PRIVATE (client)->manager, enabled);
444 445 446
}

/**
447
 * nm_client_wimax_hardware_get_enabled:
448 449
 * @client: a #NMClient
 *
450
 * Determines whether the WiMAX hardware is enabled.
451
 *
452
 * Returns: %TRUE if the WiMAX hardware is enabled
453 454
 **/
gboolean
455
nm_client_wimax_hardware_get_enabled (NMClient *client)
456
{
457
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
458

459 460 461
	if (!nm_client_get_nm_running (client))
		return FALSE;

462
	return nm_manager_wimax_hardware_get_enabled (NM_CLIENT_GET_PRIVATE (client)->manager);
463 464
}

465
/**
466
 * nm_client_get_logging:
467
 * @client: a #NMClient
468 469 470 471
 * @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
472
 *
473
 * Gets NetworkManager current logging level and domains.
474
 *
475
 * Returns: %TRUE on success, %FALSE otherwise
476
 **/
477 478
gboolean
nm_client_get_logging (NMClient *client, char **level, char **domains, GError **error)
479
{
480 481 482 483
	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);
484

485
	if (!_nm_client_check_nm_running (client, error))
486
		return FALSE;
487

488 489
	return nm_manager_get_logging (NM_CLIENT_GET_PRIVATE (client)->manager,
	                               level, domains, error);
490 491 492
}

/**
493
 * nm_client_set_logging:
494
 * @client: a #NMClient
495 496 497 498
 * @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
499
 *
500
 * Sets NetworkManager logging level and/or domains.
501
 *
502
 * Returns: %TRUE on success, %FALSE otherwise
503 504
 **/
gboolean
505
nm_client_set_logging (NMClient *client, const char *level, const char *domains, GError **error)
506 507
{
	g_return_val_if_fail (NM_IS_CLIENT (client), FALSE);
508
	g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
509

510
	if (!_nm_client_check_nm_running (client, error))
511
		return FALSE;
512

513 514
	return nm_manager_set_logging (NM_CLIENT_GET_PRIVATE (client)->manager,
	                               level, domains, error);
515 516 517
}

/**
518
 * nm_client_get_permission_result:
519
 * @client: a #NMClient
520
 * @permission: the permission for which to return the result, one of #NMClientPermission
521
 *
522 523
 * Requests the result of a specific permission, which indicates whether the
 * client can or cannot perform the action the permission represents
524
 *
525
 * Returns: the permission's result, one of #NMClientPermissionResult
526
 **/
527 528
NMClientPermissionResult
nm_client_get_permission_result (NMClient *client, NMClientPermission permission)
529
{
530 531
	g_return_val_if_fail (NM_IS_CLIENT (client), NM_CLIENT_PERMISSION_RESULT_UNKNOWN);

532 533 534
	if (!nm_client_get_nm_running (client))
		return NM_CLIENT_PERMISSION_RESULT_UNKNOWN;

535
	return nm_manager_get_permission_result (NM_CLIENT_GET_PRIVATE (client)->manager, permission);
536 537 538
}

/**
539 540
 * nm_client_get_connectivity:
 * @client: an #NMClient
541
 *
542 543 544 545
 * 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.
546
 *
547 548 549 550
 * Returns: the current connectivity state
 */
NMConnectivityState
nm_client_get_connectivity (NMClient *client)
551
{
552
	g_return_val_if_fail (NM_IS_CLIENT (client), NM_CONNECTIVITY_UNKNOWN);
553

554 555 556
	if (!nm_client_get_nm_running (client))
		return NM_CONNECTIVITY_UNKNOWN;

557
	return nm_manager_get_connectivity (NM_CLIENT_GET_PRIVATE (client)->manager);
558 559 560
}

/**
561 562 563 564
 * nm_client_check_connectivity:
 * @client: an #NMClient
 * @cancellable: a #GCancellable
 * @error: return location for a #GError
565
 *
566 567 568 569 570 571 572 573 574 575 576 577 578
 * 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)
579
{
580
	g_return_val_if_fail (NM_IS_CLIENT (client), NM_CONNECTIVITY_UNKNOWN);
581

582 583 584
	if (!_nm_client_check_nm_running (client, error))
		return NM_CONNECTIVITY_UNKNOWN;

585 586
	return nm_manager_check_connectivity (NM_CLIENT_GET_PRIVATE (client)->manager,
	                                      cancellable, error);
587 588 589 590 591 592 593 594
}

static void
check_connectivity_cb (GObject *object,
                       GAsyncResult *result,
                       gpointer user_data)
{
	GSimpleAsyncResult *simple = user_data;
595
	NMConnectivityState connectivity;
596 597
	GError *error = NULL;

598 599 600
	connectivity = nm_manager_check_connectivity_finish (NM_MANAGER (object),
	                                                     result, &error);
	if (!error)
601 602 603 604 605 606
		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);
607 608 609
}

/**
610 611 612 613 614
 * nm_client_check_connectivity_async:
 * @client: an #NMClient
 * @cancellable: a #GCancellable
 * @callback: callback to call with the result
 * @user_data: data for @callback.
615
 *
616 617 618 619 620 621 622 623 624 625 626 627
 * 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;
628
	GError *error = NULL;
629 630

	g_return_if_fail (NM_IS_CLIENT (client));
631 632 633 634 635

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

	simple = g_simple_async_result_new (G_OBJECT (client), callback, user_data,
	                                    nm_client_check_connectivity_async);
639 640
	nm_manager_check_connectivity_async (NM_CLIENT_GET_PRIVATE (client)->manager,
	                                     cancellable, check_connectivity_cb, simple);
641 642 643 644 645 646 647
}

/**
 * nm_client_check_connectivity_finish:
 * @client: an #NMClient
 * @result: the #GAsyncResult
 * @error: return location for a #GError
648
 *
649 650 651 652 653 654 655 656 657
 * 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)
658
{
659
	GSimpleAsyncResult *simple;
660

661 662
	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);
663 664 665 666 667 668

	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);
669 670
}

671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692

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

693 694 695
	if (!_nm_client_check_nm_running (client, error))
		return FALSE;

696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 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
	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);
}

780
/*****************************************************************************/
781
/* Devices                                                      */
782
/*****************************************************************************/
783

784
/**
785
 * nm_client_get_devices:
786 787
 * @client: a #NMClient
 *
788
 * Gets all the known network devices.  Use nm_device_get_type() or the
Dan Winship's avatar
Dan Winship committed
789 790 791
 * <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().
792
 *
793 794 795
 * 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.
796
 **/
797 798
const GPtrArray *
nm_client_get_devices (NMClient *client)
799
{
800
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);
801

802 803 804
	if (!nm_client_get_nm_running (client))
		return &empty;

805
	return nm_manager_get_devices (NM_CLIENT_GET_PRIVATE (client)->manager);
806 807
}

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

833 834 835
	if (!nm_client_get_nm_running (client))
		return &empty;

836 837 838
	return nm_manager_get_all_devices (NM_CLIENT_GET_PRIVATE (client)->manager);
}

839
/**
840
 * nm_client_get_device_by_path:
841
 * @client: a #NMClient
842
 * @object_path: the object path to search for
843
 *
844 845 846
 * Gets a #NMDevice from a #NMClient.
 *
 * Returns: (transfer none): the #NMDevice for the given @object_path or %NULL if none is found.
847
 **/
848 849
NMDevice *
nm_client_get_device_by_path (NMClient *client, const char *object_path)
850
{
851 852
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);
	g_return_val_if_fail (object_path, NULL);
853

854 855 856
	if (!nm_client_get_nm_running (client))
		return NULL;

857
	return nm_manager_get_device_by_path (NM_CLIENT_GET_PRIVATE (client)->manager, object_path);
858 859 860
}

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

875 876 877
	if (!nm_client_get_nm_running (client))
		return NULL;

878
	return nm_manager_get_device_by_iface (NM_CLIENT_GET_PRIVATE (client)->manager, iface);
879 880
}

881
/*****************************************************************************/
882
/* Active Connections                                           */
883
/*****************************************************************************/
884

885
/**
886
 * nm_client_get_active_connections:
887 888
 * @client: a #NMClient
 *
889
 * Gets the active connections.
890
 *
891 892 893
 * 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.
894
 **/
895 896
const GPtrArray *
nm_client_get_active_connections (NMClient *client)
897 898 899
{
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);

900 901 902
	if (!nm_client_get_nm_running (client))
		return &empty;

903
	return nm_manager_get_active_connections (NM_CLIENT_GET_PRIVATE (client)->manager);
904 905 906
}

/**
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
 * 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);

930 931 932
	if (!nm_client_get_nm_running (client))
		return NULL;

933
	return nm_manager_get_primary_connection (NM_CLIENT_GET_PRIVATE (client)->manager);
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
}

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

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

955
	return nm_manager_get_activating_connection (NM_CLIENT_GET_PRIVATE (client)->manager);
956 957 958 959 960 961 962
}

static void
activate_cb (GObject *object,
             GAsyncResult *result,
             gpointer user_data)
{
963 964
	GSimpleAsyncResult *simple = user_data;
	NMActiveConnection *ac;
965 966
	GError *error = NULL;

967 968 969 970 971 972 973 974
	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);
975 976 977 978
}

/**
 * nm_client_activate_connection_async:
979
 * @client: a #NMClient
980 981 982 983 984 985 986 987 988 989 990 991
 * @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
992
 *
993 994 995 996 997 998 999 1000
 * 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.
1001
 *
1002 1003 1004 1005 1006 1007 1008
 * 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.
1009
 **/
1010 1011 1012 1013 1014 1015 1016 1017
void
nm_client_activate_connection_async (NMClient *client,
                                     NMConnection *connection,
                                     NMDevice *device,
                                     const char *specific_object,
                                     GCancellable *cancellable,
                                     GAsyncReadyCallback callback,
                                     gpointer user_data)
1018
{
1019
	GSimpleAsyncResult *simple;
1020
	GError *error = NULL;
1021 1022 1023 1024 1025 1026 1027

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

1028 1029
	if (!_nm_client_check_nm_running (client, &error)) {
		g_simple_async_report_take_gerror_in_idle (G_OBJECT (client), callback, user_data, error);
1030 1031 1032
		return;
	}

1033 1034 1035 1036 1037
	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);
1038 1039 1040
}

/**
1041 1042 1043 1044
 * nm_client_activate_connection_finish:
 * @client: an #NMClient
 * @result: the result passed to the #GAsyncReadyCallback
 * @error: location for a #GError, or %NULL
1045
 *
1046
 * Gets the result of a call to nm_client_activate_connection_async().
1047
 *
1048 1049
 * Returns: (transfer full): the new #NMActiveConnection on success, %NULL on
 *   failure, in which case @error will be set.
1050
 **/
1051 1052 1053 1054
NMActiveConnection *
nm_client_activate_connection_finish (NMClient *client,
                                      GAsyncResult *result,
                                      GError **error)
1055
{
1056
	GSimpleAsyncResult *simple;
1057

1058 1059
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);
	g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (result), NULL);
1060 1061 1062 1063 1064 1065

	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));
1066 1067
}

1068 1069 1070 1071
static void
add_activate_cb (GObject *object,
                 GAsyncResult *result,
                 gpointer user_data)
1072
{
1073 1074
	GSimpleAsyncResult *simple = user_data;
	NMActiveConnection *ac;
1075
	GError *error = NULL;
1076

1077 1078 1079 1080 1081 1082 1083 1084
	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);
1085 1086 1087
}

/**
1088
 * nm_client_add_and_activate_connection_async:
1089
 * @client: a #NMClient
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
 * @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
1104
 *
1105 1106 1107 1108 1109
 * 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.
1110
 *
1111 1112 1113 1114
 * 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.
1115
 **/
1116 1117 1118 1119 1120 1121 1122 1123
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)
1124
{
1125
	GSimpleAsyncResult *simple;
1126
	GError *error = NULL;
1127 1128 1129 1130 1131

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

1133 1134
	if (!_nm_client_check_nm_running (client, &error)) {
		g_simple_async_report_take_gerror_in_idle (G_OBJECT (client), callback, user_data, error);
1135
		return;
1136
	}
1137

1138 1139 1140 1141 1142
	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);
1143 1144 1145
}

/**
1146 1147 1148 1149
 * nm_client_add_and_activate_connection_finish:
 * @client: an #NMClient
 * @result: the result passed to the #GAsyncReadyCallback
 * @error: location for a #GError, or %NULL
1150
 *
1151
 * Gets the result of a call to nm_client_add_and_activate_connection_async().
1152
 *
1153 1154 1155 1156 1157
 * 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.
1158
 **/
1159 1160 1161 1162
NMActiveConnection *
nm_client_add_and_activate_connection_finish (NMClient *client,
                                              GAsyncResult *result,
                                              GError **error)
1163
{
1164
	GSimpleAsyncResult *simple;
1165

1166 1167
	g_return_val_if_fail (NM_IS_CLIENT (client), NULL);
	g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (result), NULL);
1168 1169 1170 1171 1172 1173

	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));
1174 1175 1176
}

/**
1177
 * nm_client_deactivate_connection:
1178
 * @client: a #NMClient
1179 1180 1181
 * @active: the #NMActiveConnection to deactivate
 * @cancellable: a #GCancellable, or %NULL
 * @error: location for a #GError, or %NULL
1182
 *
1183
 * Deactivates an active #NMActiveConnection.
1184
 *
1185
 * Returns: success or failure
1186 1187
 **/
gboolean
1188 1189 1190 1191
nm_client_deactivate_connection (NMClient *client,
                                 NMActiveConnection *active,
                                 GCancellable *cancellable,
                                 GError **error)