1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
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
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
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
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
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
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
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
|
/*
* WPA Supplicant / dbus-based control interface
* Copyright (c) 2006, Dan Williams <dcbw@redhat.com> and Red Hat, Inc.
* Copyright (c) 2009, Witold Sowa <witold.sowa@gmail.com>
*
* This software may be distributed under the terms of the BSD license.
* See README for more details.
*/
#include "utils/includes.h"
#include "utils/common.h"
#include "utils/eloop.h"
#include "dbus_common.h"
#include "dbus_common_i.h"
#include "dbus_new.h"
#include "dbus_new_helpers.h"
#include "dbus_dict_helpers.h"
static dbus_bool_t fill_dict_with_properties(
DBusMessageIter *dict_iter,
const struct wpa_dbus_property_desc *props,
const char *interface, void *user_data, DBusError *error)
{
DBusMessageIter entry_iter;
const struct wpa_dbus_property_desc *dsc;
for (dsc = props; dsc && dsc->dbus_property; dsc++) {
/* Only return properties for the requested D-Bus interface */
if (os_strncmp(dsc->dbus_interface, interface,
WPAS_DBUS_INTERFACE_MAX) != 0)
continue;
/* Skip write-only properties */
if (dsc->getter == NULL)
continue;
if (!dbus_message_iter_open_container(dict_iter,
DBUS_TYPE_DICT_ENTRY,
NULL, &entry_iter)) {
dbus_set_error_const(error, DBUS_ERROR_NO_MEMORY,
"no memory");
return FALSE;
}
if (!dbus_message_iter_append_basic(&entry_iter,
DBUS_TYPE_STRING,
&dsc->dbus_property)) {
dbus_set_error_const(error, DBUS_ERROR_NO_MEMORY,
"no memory");
return FALSE;
}
/* An error getting a property fails the request entirely */
if (!dsc->getter(&entry_iter, error, user_data))
return FALSE;
dbus_message_iter_close_container(dict_iter, &entry_iter);
}
return TRUE;
}
/**
* get_all_properties - Responds for GetAll properties calls on object
* @message: Message with GetAll call
* @interface: interface name which properties will be returned
* @property_dsc: list of object's properties
* Returns: Message with dict of variants as argument with properties values
*
* Iterates over all properties registered with object and execute getters
* of those, which are readable and which interface matches interface
* specified as argument. Returned message contains one dict argument
* with properties names as keys and theirs values as values.
*/
static DBusMessage * get_all_properties(DBusMessage *message, char *interface,
struct wpa_dbus_object_desc *obj_dsc)
{
DBusMessage *reply;
DBusMessageIter iter, dict_iter;
DBusError error;
reply = dbus_message_new_method_return(message);
if (reply == NULL) {
wpa_printf(MSG_ERROR, "%s: out of memory creating dbus reply",
__func__);
return NULL;
}
dbus_message_iter_init_append(reply, &iter);
if (!wpa_dbus_dict_open_write(&iter, &dict_iter)) {
wpa_printf(MSG_ERROR, "%s: out of memory creating reply",
__func__);
dbus_message_unref(reply);
reply = dbus_message_new_error(message, DBUS_ERROR_NO_MEMORY,
"out of memory");
return reply;
}
dbus_error_init(&error);
if (!fill_dict_with_properties(&dict_iter, obj_dsc->properties,
interface, obj_dsc->user_data, &error))
{
dbus_message_unref(reply);
reply = wpas_dbus_reply_new_from_error(message, &error,
DBUS_ERROR_INVALID_ARGS,
"No readable properties"
" in this interface");
dbus_error_free(&error);
return reply;
}
wpa_dbus_dict_close_write(&iter, &dict_iter);
return reply;
}
static int is_signature_correct(DBusMessage *message,
const struct wpa_dbus_method_desc *method_dsc)
{
/* According to DBus documentation max length of signature is 255 */
#define MAX_SIG_LEN 256
char registered_sig[MAX_SIG_LEN], *pos;
const char *sig = dbus_message_get_signature(message);
int ret;
const struct wpa_dbus_argument *arg;
pos = registered_sig;
*pos = '\0';
for (arg = method_dsc->args; arg && arg->name; arg++) {
if (arg->dir == ARG_IN) {
size_t blen = registered_sig + MAX_SIG_LEN - pos;
ret = os_snprintf(pos, blen, "%s", arg->type);
if (ret < 0 || (size_t) ret >= blen)
return 0;
pos += ret;
}
}
return !os_strncmp(registered_sig, sig, MAX_SIG_LEN);
}
static DBusMessage * properties_get_all(DBusMessage *message, char *interface,
struct wpa_dbus_object_desc *obj_dsc)
{
if (os_strcmp(dbus_message_get_signature(message), "s") != 0)
return dbus_message_new_error(message, DBUS_ERROR_INVALID_ARGS,
NULL);
return get_all_properties(message, interface, obj_dsc);
}
static DBusMessage * properties_get(DBusMessage *message,
const struct wpa_dbus_property_desc *dsc,
void *user_data)
{
DBusMessage *reply;
DBusMessageIter iter;
DBusError error;
if (os_strcmp(dbus_message_get_signature(message), "ss")) {
return dbus_message_new_error(message, DBUS_ERROR_INVALID_ARGS,
NULL);
}
if (dsc->getter == NULL) {
return dbus_message_new_error(message, DBUS_ERROR_INVALID_ARGS,
"Property is write-only");
}
reply = dbus_message_new_method_return(message);
dbus_message_iter_init_append(reply, &iter);
dbus_error_init(&error);
if (dsc->getter(&iter, &error, user_data) == FALSE) {
dbus_message_unref(reply);
reply = wpas_dbus_reply_new_from_error(
message, &error, DBUS_ERROR_FAILED,
"Failed to read property");
dbus_error_free(&error);
}
return reply;
}
static DBusMessage * properties_set(DBusMessage *message,
const struct wpa_dbus_property_desc *dsc,
void *user_data)
{
DBusMessage *reply;
DBusMessageIter iter;
DBusError error;
if (os_strcmp(dbus_message_get_signature(message), "ssv")) {
return dbus_message_new_error(message, DBUS_ERROR_INVALID_ARGS,
NULL);
}
if (dsc->setter == NULL) {
return dbus_message_new_error(message, DBUS_ERROR_INVALID_ARGS,
"Property is read-only");
}
dbus_message_iter_init(message, &iter);
/* Skip the interface name and the property name */
dbus_message_iter_next(&iter);
dbus_message_iter_next(&iter);
/* Iter will now point to the property's new value */
dbus_error_init(&error);
if (dsc->setter(&iter, &error, user_data) == TRUE) {
/* Success */
reply = dbus_message_new_method_return(message);
} else {
reply = wpas_dbus_reply_new_from_error(
message, &error, DBUS_ERROR_FAILED,
"Failed to set property");
dbus_error_free(&error);
}
return reply;
}
static DBusMessage *
properties_get_or_set(DBusMessage *message, DBusMessageIter *iter,
char *interface,
struct wpa_dbus_object_desc *obj_dsc)
{
const struct wpa_dbus_property_desc *property_dsc;
char *property;
const char *method;
method = dbus_message_get_member(message);
property_dsc = obj_dsc->properties;
/* Second argument: property name (DBUS_TYPE_STRING) */
if (!dbus_message_iter_next(iter) ||
dbus_message_iter_get_arg_type(iter) != DBUS_TYPE_STRING) {
return dbus_message_new_error(message, DBUS_ERROR_INVALID_ARGS,
NULL);
}
dbus_message_iter_get_basic(iter, &property);
while (property_dsc && property_dsc->dbus_property) {
/* compare property names and
* interfaces */
if (!os_strncmp(property_dsc->dbus_property, property,
WPAS_DBUS_METHOD_SIGNAL_PROP_MAX) &&
!os_strncmp(property_dsc->dbus_interface, interface,
WPAS_DBUS_INTERFACE_MAX))
break;
property_dsc++;
}
if (property_dsc == NULL || property_dsc->dbus_property == NULL) {
wpa_printf(MSG_DEBUG, "no property handler for %s.%s on %s",
interface, property,
dbus_message_get_path(message));
return dbus_message_new_error(message, DBUS_ERROR_INVALID_ARGS,
"No such property");
}
if (os_strncmp(WPA_DBUS_PROPERTIES_GET, method,
WPAS_DBUS_METHOD_SIGNAL_PROP_MAX) == 0)
return properties_get(message, property_dsc,
obj_dsc->user_data);
return properties_set(message, property_dsc, obj_dsc->user_data);
}
static DBusMessage * properties_handler(DBusMessage *message,
struct wpa_dbus_object_desc *obj_dsc)
{
DBusMessageIter iter;
char *interface;
const char *method;
method = dbus_message_get_member(message);
dbus_message_iter_init(message, &iter);
if (!os_strncmp(WPA_DBUS_PROPERTIES_GET, method,
WPAS_DBUS_METHOD_SIGNAL_PROP_MAX) ||
!os_strncmp(WPA_DBUS_PROPERTIES_SET, method,
WPAS_DBUS_METHOD_SIGNAL_PROP_MAX) ||
!os_strncmp(WPA_DBUS_PROPERTIES_GETALL, method,
WPAS_DBUS_METHOD_SIGNAL_PROP_MAX)) {
/* First argument: interface name (DBUS_TYPE_STRING) */
if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_STRING)
{
return dbus_message_new_error(message,
DBUS_ERROR_INVALID_ARGS,
NULL);
}
dbus_message_iter_get_basic(&iter, &interface);
if (!os_strncmp(WPA_DBUS_PROPERTIES_GETALL, method,
WPAS_DBUS_METHOD_SIGNAL_PROP_MAX)) {
/* GetAll */
return properties_get_all(message, interface, obj_dsc);
}
/* Get or Set */
return properties_get_or_set(message, &iter, interface,
obj_dsc);
}
return dbus_message_new_error(message, DBUS_ERROR_UNKNOWN_METHOD,
NULL);
}
static DBusMessage * msg_method_handler(DBusMessage *message,
struct wpa_dbus_object_desc *obj_dsc)
{
const struct wpa_dbus_method_desc *method_dsc = obj_dsc->methods;
const char *method;
const char *msg_interface;
method = dbus_message_get_member(message);
msg_interface = dbus_message_get_interface(message);
/* try match call to any registered method */
while (method_dsc && method_dsc->dbus_method) {
/* compare method names and interfaces */
if (!os_strncmp(method_dsc->dbus_method, method,
WPAS_DBUS_METHOD_SIGNAL_PROP_MAX) &&
!os_strncmp(method_dsc->dbus_interface, msg_interface,
WPAS_DBUS_INTERFACE_MAX))
break;
method_dsc++;
}
if (method_dsc == NULL || method_dsc->dbus_method == NULL) {
wpa_printf(MSG_DEBUG, "no method handler for %s.%s on %s",
msg_interface, method,
dbus_message_get_path(message));
return dbus_message_new_error(message,
DBUS_ERROR_UNKNOWN_METHOD, NULL);
}
if (!is_signature_correct(message, method_dsc)) {
return dbus_message_new_error(message, DBUS_ERROR_INVALID_ARGS,
NULL);
}
return method_dsc->method_handler(message,
obj_dsc->user_data);
}
/**
* message_handler - Handles incoming DBus messages
* @connection: DBus connection on which message was received
* @message: Received message
* @user_data: pointer to description of object to which message was sent
* Returns: Returns information whether message was handled or not
*
* Reads message interface and method name, then checks if they matches one
* of the special cases i.e. introspection call or properties get/getall/set
* methods and handles it. Else it iterates over registered methods list
* and tries to match method's name and interface to those read from message
* If appropriate method was found its handler function is called and
* response is sent. Otherwise, the DBUS_ERROR_UNKNOWN_METHOD error message
* will be sent.
*/
static DBusHandlerResult message_handler(DBusConnection *connection,
DBusMessage *message, void *user_data)
{
struct wpa_dbus_object_desc *obj_dsc = user_data;
const char *method;
const char *path;
const char *msg_interface;
DBusMessage *reply;
/* get method, interface and path the message is addressed to */
method = dbus_message_get_member(message);
path = dbus_message_get_path(message);
msg_interface = dbus_message_get_interface(message);
if (!method || !path || !msg_interface)
return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
wpa_printf(MSG_MSGDUMP, "dbus: %s.%s (%s)",
msg_interface, method, path);
/* if message is introspection method call */
if (!os_strncmp(WPA_DBUS_INTROSPECTION_METHOD, method,
WPAS_DBUS_METHOD_SIGNAL_PROP_MAX) &&
!os_strncmp(WPA_DBUS_INTROSPECTION_INTERFACE, msg_interface,
WPAS_DBUS_INTERFACE_MAX)) {
#ifdef CONFIG_CTRL_IFACE_DBUS_INTRO
reply = wpa_dbus_introspect(message, obj_dsc);
#else /* CONFIG_CTRL_IFACE_DBUS_INTRO */
reply = dbus_message_new_error(
message, DBUS_ERROR_UNKNOWN_METHOD,
"wpa_supplicant was compiled without "
"introspection support.");
#endif /* CONFIG_CTRL_IFACE_DBUS_INTRO */
} else if (!os_strncmp(WPA_DBUS_PROPERTIES_INTERFACE, msg_interface,
WPAS_DBUS_INTERFACE_MAX)) {
/* if message is properties method call */
reply = properties_handler(message, obj_dsc);
} else {
reply = msg_method_handler(message, obj_dsc);
}
/* If handler succeed returning NULL, reply empty message */
if (!reply)
reply = dbus_message_new_method_return(message);
if (reply) {
if (!dbus_message_get_no_reply(message))
dbus_connection_send(connection, reply, NULL);
dbus_message_unref(reply);
}
wpa_dbus_flush_all_changed_properties(connection);
return DBUS_HANDLER_RESULT_HANDLED;
}
/**
* free_dbus_object_desc - Frees object description data structure
* @connection: DBus connection
* @obj_dsc: Object description to free
*
* Frees each of properties, methods and signals description lists and
* the object description structure itself.
*/
void free_dbus_object_desc(struct wpa_dbus_object_desc *obj_dsc)
{
if (!obj_dsc)
return;
/* free handler's argument */
if (obj_dsc->user_data_free_func)
obj_dsc->user_data_free_func(obj_dsc->user_data);
os_free(obj_dsc->path);
os_free(obj_dsc->prop_changed_flags);
os_free(obj_dsc);
}
static void free_dbus_object_desc_cb(DBusConnection *connection, void *obj_dsc)
{
free_dbus_object_desc(obj_dsc);
}
/**
* wpa_dbus_ctrl_iface_init - Initialize dbus control interface
* @application_data: Pointer to application specific data structure
* @dbus_path: DBus path to interface object
* @dbus_service: DBus service name to register with
* @messageHandler: a pointer to function which will handle dbus messages
* coming on interface
* Returns: 0 on success, -1 on failure
*
* Initialize the dbus control interface and start receiving commands from
* external programs over the bus.
*/
int wpa_dbus_ctrl_iface_init(struct wpas_dbus_priv *iface,
char *dbus_path, char *dbus_service,
struct wpa_dbus_object_desc *obj_desc)
{
DBusError error;
int ret = -1;
DBusObjectPathVTable wpa_vtable = {
&free_dbus_object_desc_cb, &message_handler,
NULL, NULL, NULL, NULL
};
obj_desc->connection = iface->con;
obj_desc->path = os_strdup(dbus_path);
/* Register the message handler for the global dbus interface */
if (!dbus_connection_register_object_path(iface->con,
dbus_path, &wpa_vtable,
obj_desc)) {
wpa_printf(MSG_ERROR, "dbus: Could not set up message "
"handler");
return -1;
}
/* Register our service with the message bus */
dbus_error_init(&error);
switch (dbus_bus_request_name(iface->con, dbus_service,
0, &error)) {
case DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER:
ret = 0;
break;
case DBUS_REQUEST_NAME_REPLY_EXISTS:
case DBUS_REQUEST_NAME_REPLY_IN_QUEUE:
case DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER:
wpa_printf(MSG_ERROR, "dbus: Could not request service name: "
"already registered");
break;
default:
wpa_printf(MSG_ERROR, "dbus: Could not request service name: "
"%s %s", error.name, error.message);
break;
}
dbus_error_free(&error);
if (ret != 0)
return -1;
wpa_printf(MSG_DEBUG, "Providing DBus service '%s'.", dbus_service);
return 0;
}
/**
* wpa_dbus_register_object_per_iface - Register a new object with dbus
* @ctrl_iface: pointer to dbus private data
* @path: DBus path to object
* @ifname: interface name
* @obj_desc: description of object's methods, signals and properties
* Returns: 0 on success, -1 on error
*
* Registers a new interface with dbus and assigns it a dbus object path.
*/
int wpa_dbus_register_object_per_iface(
struct wpas_dbus_priv *ctrl_iface,
const char *path, const char *ifname,
struct wpa_dbus_object_desc *obj_desc)
{
DBusConnection *con;
DBusError error;
DBusObjectPathVTable vtable = {
&free_dbus_object_desc_cb, &message_handler,
NULL, NULL, NULL, NULL
};
/* Do nothing if the control interface is not turned on */
if (ctrl_iface == NULL)
return 0;
con = ctrl_iface->con;
obj_desc->connection = con;
obj_desc->path = os_strdup(path);
dbus_error_init(&error);
/* Register the message handler for the interface functions */
if (!dbus_connection_try_register_object_path(con, path, &vtable,
obj_desc, &error)) {
if (!os_strcmp(error.name, DBUS_ERROR_OBJECT_PATH_IN_USE)) {
wpa_printf(MSG_DEBUG, "dbus: %s", error.message);
} else {
wpa_printf(MSG_ERROR, "dbus: Could not set up message "
"handler for interface %s object %s",
ifname, path);
wpa_printf(MSG_ERROR, "dbus error: %s", error.name);
wpa_printf(MSG_ERROR, "dbus: %s", error.message);
}
dbus_error_free(&error);
return -1;
}
dbus_error_free(&error);
return 0;
}
static void flush_object_timeout_handler(void *eloop_ctx, void *timeout_ctx);
/**
* wpa_dbus_unregister_object_per_iface - Unregisters DBus object
* @ctrl_iface: Pointer to dbus private data
* @path: DBus path to object which will be unregistered
* Returns: Zero on success and -1 on failure
*
* Unregisters DBus object given by its path
*/
int wpa_dbus_unregister_object_per_iface(
struct wpas_dbus_priv *ctrl_iface, const char *path)
{
DBusConnection *con = ctrl_iface->con;
struct wpa_dbus_object_desc *obj_desc = NULL;
dbus_connection_get_object_path_data(con, path, (void **) &obj_desc);
if (!obj_desc) {
wpa_printf(MSG_ERROR, "dbus: %s: Could not obtain object's "
"private data: %s", __func__, path);
} else {
eloop_cancel_timeout(flush_object_timeout_handler, con,
obj_desc);
}
if (!dbus_connection_unregister_object_path(con, path))
return -1;
return 0;
}
static dbus_bool_t put_changed_properties(
const struct wpa_dbus_object_desc *obj_dsc, const char *interface,
DBusMessageIter *dict_iter, int clear_changed)
{
DBusMessageIter entry_iter;
const struct wpa_dbus_property_desc *dsc;
int i;
DBusError error;
for (dsc = obj_dsc->properties, i = 0; dsc && dsc->dbus_property;
dsc++, i++) {
if (obj_dsc->prop_changed_flags == NULL ||
!obj_dsc->prop_changed_flags[i])
continue;
if (os_strcmp(dsc->dbus_interface, interface) != 0)
continue;
if (clear_changed)
obj_dsc->prop_changed_flags[i] = 0;
if (!dbus_message_iter_open_container(dict_iter,
DBUS_TYPE_DICT_ENTRY,
NULL, &entry_iter))
return FALSE;
if (!dbus_message_iter_append_basic(&entry_iter,
DBUS_TYPE_STRING,
&dsc->dbus_property))
return FALSE;
dbus_error_init(&error);
if (!dsc->getter(&entry_iter, &error, obj_dsc->user_data)) {
if (dbus_error_is_set (&error)) {
wpa_printf(MSG_ERROR, "dbus: %s: Cannot get "
"new value of property %s: (%s) %s",
__func__, dsc->dbus_property,
error.name, error.message);
} else {
wpa_printf(MSG_ERROR, "dbus: %s: Cannot get "
"new value of property %s",
__func__, dsc->dbus_property);
}
dbus_error_free(&error);
return FALSE;
}
if (!dbus_message_iter_close_container(dict_iter, &entry_iter))
return FALSE;
}
return TRUE;
}
static void do_send_prop_changed_signal(
DBusConnection *con, const char *path, const char *interface,
const struct wpa_dbus_object_desc *obj_dsc)
{
DBusMessage *msg;
DBusMessageIter signal_iter, dict_iter;
msg = dbus_message_new_signal(path, DBUS_INTERFACE_PROPERTIES,
"PropertiesChanged");
if (msg == NULL)
return;
dbus_message_iter_init_append(msg, &signal_iter);
if (!dbus_message_iter_append_basic(&signal_iter, DBUS_TYPE_STRING,
&interface))
goto err;
/* Changed properties dict */
if (!dbus_message_iter_open_container(&signal_iter, DBUS_TYPE_ARRAY,
"{sv}", &dict_iter))
goto err;
if (!put_changed_properties(obj_dsc, interface, &dict_iter, 0))
goto err;
if (!dbus_message_iter_close_container(&signal_iter, &dict_iter))
goto err;
/* Invalidated properties array (empty) */
if (!dbus_message_iter_open_container(&signal_iter, DBUS_TYPE_ARRAY,
"s", &dict_iter))
goto err;
if (!dbus_message_iter_close_container(&signal_iter, &dict_iter))
goto err;
dbus_connection_send(con, msg, NULL);
out:
dbus_message_unref(msg);
return;
err:
wpa_printf(MSG_DEBUG, "dbus: %s: Failed to construct signal",
__func__);
goto out;
}
static void do_send_deprecated_prop_changed_signal(
DBusConnection *con, const char *path, const char *interface,
const struct wpa_dbus_object_desc *obj_dsc)
{
DBusMessage *msg;
DBusMessageIter signal_iter, dict_iter;
msg = dbus_message_new_signal(path, interface, "PropertiesChanged");
if (msg == NULL)
return;
dbus_message_iter_init_append(msg, &signal_iter);
if (!dbus_message_iter_open_container(&signal_iter, DBUS_TYPE_ARRAY,
"{sv}", &dict_iter))
goto err;
if (!put_changed_properties(obj_dsc, interface, &dict_iter, 1))
goto err;
if (!dbus_message_iter_close_container(&signal_iter, &dict_iter))
goto err;
dbus_connection_send(con, msg, NULL);
out:
dbus_message_unref(msg);
return;
err:
wpa_printf(MSG_DEBUG, "dbus: %s: Failed to construct signal",
__func__);
goto out;
}
static void send_prop_changed_signal(
DBusConnection *con, const char *path, const char *interface,
const struct wpa_dbus_object_desc *obj_dsc)
{
/*
* First, send property change notification on the standardized
* org.freedesktop.DBus.Properties interface. This call will not
* clear the property change bits, so that they are preserved for
* the call that follows.
*/
do_send_prop_changed_signal(con, path, interface, obj_dsc);
/*
* Now send PropertiesChanged on our own interface for backwards
* compatibility. This is deprecated and will be removed in a future
* release.
*/
do_send_deprecated_prop_changed_signal(con, path, interface, obj_dsc);
/* Property change bits have now been cleared. */
}
static void flush_object_timeout_handler(void *eloop_ctx, void *timeout_ctx)
{
DBusConnection *con = eloop_ctx;
struct wpa_dbus_object_desc *obj_desc = timeout_ctx;
wpa_printf(MSG_DEBUG, "dbus: %s: Timeout - sending changed properties "
"of object %s", __func__, obj_desc->path);
wpa_dbus_flush_object_changed_properties(con, obj_desc->path);
}
static void recursive_flush_changed_properties(DBusConnection *con,
const char *path)
{
char **objects = NULL;
char subobj_path[WPAS_DBUS_OBJECT_PATH_MAX];
int i;
wpa_dbus_flush_object_changed_properties(con, path);
if (!dbus_connection_list_registered(con, path, &objects))
goto out;
for (i = 0; objects[i]; i++) {
os_snprintf(subobj_path, WPAS_DBUS_OBJECT_PATH_MAX,
"%s/%s", path, objects[i]);
recursive_flush_changed_properties(con, subobj_path);
}
out:
dbus_free_string_array(objects);
}
/**
* wpa_dbus_flush_all_changed_properties - Send all PropertiesChanged signals
* @con: DBus connection
*
* Traverses through all registered objects and sends PropertiesChanged for
* each properties.
*/
void wpa_dbus_flush_all_changed_properties(DBusConnection *con)
{
recursive_flush_changed_properties(con, WPAS_DBUS_NEW_PATH);
}
/**
* wpa_dbus_flush_object_changed_properties - Send PropertiesChanged for object
* @con: DBus connection
* @path: path to a DBus object for which PropertiesChanged will be sent.
*
* Iterates over all properties registered with object and for each interface
* containing properties marked as changed, sends a PropertiesChanged signal
* containing names and new values of properties that have changed.
*
* You need to call this function after wpa_dbus_mark_property_changed()
* if you want to send PropertiesChanged signal immediately (i.e., without
* waiting timeout to expire). PropertiesChanged signal for an object is sent
* automatically short time after first marking property as changed. All
* PropertiesChanged signals are sent automatically after responding on DBus
* message, so if you marked a property changed as a result of DBus call
* (e.g., param setter), you usually do not need to call this function.
*/
void wpa_dbus_flush_object_changed_properties(DBusConnection *con,
const char *path)
{
struct wpa_dbus_object_desc *obj_desc = NULL;
const struct wpa_dbus_property_desc *dsc;
int i;
dbus_connection_get_object_path_data(con, path, (void **) &obj_desc);
if (!obj_desc)
return;
eloop_cancel_timeout(flush_object_timeout_handler, con, obj_desc);
dsc = obj_desc->properties;
for (dsc = obj_desc->properties, i = 0; dsc && dsc->dbus_property;
dsc++, i++) {
if (obj_desc->prop_changed_flags == NULL ||
!obj_desc->prop_changed_flags[i])
continue;
send_prop_changed_signal(con, path, dsc->dbus_interface,
obj_desc);
}
}
#define WPA_DBUS_SEND_PROP_CHANGED_TIMEOUT 5000
/**
* wpa_dbus_mark_property_changed - Mark a property as changed and
* @iface: dbus priv struct
* @path: path to DBus object which property has changed
* @interface: interface containing changed property
* @property: property name which has changed
*
* Iterates over all properties registered with an object and marks the one
* given in parameters as changed. All parameters registered for an object
* within a single interface will be aggregated together and sent in one
* PropertiesChanged signal when function
* wpa_dbus_flush_object_changed_properties() is called.
*/
void wpa_dbus_mark_property_changed(struct wpas_dbus_priv *iface,
const char *path, const char *interface,
const char *property)
{
struct wpa_dbus_object_desc *obj_desc = NULL;
const struct wpa_dbus_property_desc *dsc;
int i = 0;
if (iface == NULL)
return;
dbus_connection_get_object_path_data(iface->con, path,
(void **) &obj_desc);
if (!obj_desc) {
wpa_printf(MSG_ERROR, "dbus: wpa_dbus_property_changed: "
"could not obtain object's private data: %s", path);
return;
}
for (dsc = obj_desc->properties; dsc && dsc->dbus_property; dsc++, i++)
if (os_strcmp(property, dsc->dbus_property) == 0 &&
os_strcmp(interface, dsc->dbus_interface) == 0) {
if (obj_desc->prop_changed_flags)
obj_desc->prop_changed_flags[i] = 1;
break;
}
if (!dsc || !dsc->dbus_property) {
wpa_printf(MSG_ERROR, "dbus: wpa_dbus_property_changed: "
"no property %s in object %s", property, path);
return;
}
if (!eloop_is_timeout_registered(flush_object_timeout_handler,
iface->con, obj_desc->path)) {
eloop_register_timeout(0, WPA_DBUS_SEND_PROP_CHANGED_TIMEOUT,
flush_object_timeout_handler,
iface->con, obj_desc);
}
}
/**
* wpa_dbus_get_object_properties - Put object's properties into dictionary
* @iface: dbus priv struct
* @path: path to DBus object which properties will be obtained
* @interface: interface name which properties will be obtained
* @iter: DBus message iter at which to append property dictionary.
*
* Iterates over all properties registered with object and execute getters
* of those, which are readable and which interface matches interface
* specified as argument. Obtained properties values are stored in
* dict_iter dictionary.
*/
dbus_bool_t wpa_dbus_get_object_properties(struct wpas_dbus_priv *iface,
const char *path,
const char *interface,
DBusMessageIter *iter)
{
struct wpa_dbus_object_desc *obj_desc = NULL;
DBusMessageIter dict_iter;
DBusError error;
dbus_connection_get_object_path_data(iface->con, path,
(void **) &obj_desc);
if (!obj_desc) {
wpa_printf(MSG_ERROR, "dbus: %s: could not obtain object's "
"private data: %s", __func__, path);
return FALSE;
}
if (!wpa_dbus_dict_open_write(iter, &dict_iter)) {
wpa_printf(MSG_ERROR, "dbus: %s: failed to open message dict",
__func__);
return FALSE;
}
dbus_error_init(&error);
if (!fill_dict_with_properties(&dict_iter, obj_desc->properties,
interface, obj_desc->user_data,
&error)) {
wpa_printf(MSG_ERROR, "dbus: %s: failed to get object"
" properties: (%s) %s", __func__,
dbus_error_is_set(&error) ? error.name : "none",
dbus_error_is_set(&error) ? error.message : "none");
dbus_error_free(&error);
return FALSE;
}
return wpa_dbus_dict_close_write(iter, &dict_iter);
}
/**
* wpas_dbus_new_decompose_object_path - Decompose an interface object path into parts
* @path: The dbus object path
* @p2p_persistent_group: indicates whether to parse the path as a P2P
* persistent group object
* @network: (out) the configured network this object path refers to, if any
* @bssid: (out) the scanned bssid this object path refers to, if any
* Returns: The object path of the network interface this path refers to
*
* For a given object path, decomposes the object path into object id, network,
* and BSSID parts, if those parts exist.
*/
char *wpas_dbus_new_decompose_object_path(const char *path,
int p2p_persistent_group,
char **network,
char **bssid)
{
const unsigned int dev_path_prefix_len =
os_strlen(WPAS_DBUS_NEW_PATH_INTERFACES "/");
char *obj_path_only;
char *next_sep;
/* Be a bit paranoid about path */
if (!path || os_strncmp(path, WPAS_DBUS_NEW_PATH_INTERFACES "/",
dev_path_prefix_len))
return NULL;
/* Ensure there's something at the end of the path */
if ((path + dev_path_prefix_len)[0] == '\0')
return NULL;
obj_path_only = os_strdup(path);
if (obj_path_only == NULL)
return NULL;
next_sep = os_strchr(obj_path_only + dev_path_prefix_len, '/');
if (next_sep != NULL) {
const char *net_part = os_strstr(
next_sep, p2p_persistent_group ?
WPAS_DBUS_NEW_PERSISTENT_GROUPS_PART "/" :
WPAS_DBUS_NEW_NETWORKS_PART "/");
const char *bssid_part = os_strstr(
next_sep, WPAS_DBUS_NEW_BSSIDS_PART "/");
if (network && net_part) {
/* Deal with a request for a configured network */
const char *net_name = net_part +
os_strlen(p2p_persistent_group ?
WPAS_DBUS_NEW_PERSISTENT_GROUPS_PART
"/" :
WPAS_DBUS_NEW_NETWORKS_PART "/");
*network = NULL;
if (os_strlen(net_name))
*network = os_strdup(net_name);
} else if (bssid && bssid_part) {
/* Deal with a request for a scanned BSSID */
const char *bssid_name = bssid_part +
os_strlen(WPAS_DBUS_NEW_BSSIDS_PART "/");
if (os_strlen(bssid_name))
*bssid = os_strdup(bssid_name);
else
*bssid = NULL;
}
/* Cut off interface object path before "/" */
*next_sep = '\0';
}
return obj_path_only;
}
/**
* wpas_dbus_reply_new_from_error - Create a new D-Bus error message from a
* dbus error structure
* @message: The original request message for which the error is a reply
* @error: The error containing a name and a descriptive error cause
* @fallback_name: A generic error name if @error was not set
* @fallback_string: A generic error string if @error was not set
* Returns: A new D-Bus error message
*
* Given a DBusMessage structure, creates a new D-Bus error message using
* the error name and string contained in that structure.
*/
DBusMessage * wpas_dbus_reply_new_from_error(DBusMessage *message,
DBusError *error,
const char *fallback_name,
const char *fallback_string)
{
if (error && error->name && error->message) {
return dbus_message_new_error(message, error->name,
error->message);
}
if (fallback_name && fallback_string) {
return dbus_message_new_error(message, fallback_name,
fallback_string);
}
return NULL;
}
|