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
|
/* libnih
*
* dbus_object.c - D-Bus local object implementation
*
* Copyright © 2009 Scott James Remnant <scott@netsplit.com>.
* Copyright © 2009 Canonical Ltd.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2, as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif /* HAVE_CONFIG_H */
#include <dbus/dbus.h>
#include <nih/macros.h>
#include <nih/alloc.h>
#include <nih/list.h>
#include <nih/hash.h>
#include <nih/string.h>
#include <nih/logging.h>
#include <nih/error.h>
#include <nih-dbus/dbus_message.h>
#include <nih-dbus/dbus_error.h>
#include <nih-dbus/errors.h>
#include "dbus_object.h"
/* Prototypes for static functions */
static int nih_dbus_object_destroy (NihDBusObject *object);
static void nih_dbus_object_unregister (DBusConnection *connection,
NihDBusObject *object);
static DBusHandlerResult nih_dbus_object_message (DBusConnection *connection,
DBusMessage *message,
NihDBusObject *object);
static DBusHandlerResult nih_dbus_object_introspect (DBusConnection *connection,
DBusMessage *message,
NihDBusObject *object);
static DBusHandlerResult nih_dbus_object_property_get (DBusConnection *connection,
DBusMessage *message,
NihDBusObject *object);
static DBusHandlerResult nih_dbus_object_property_get_all (DBusConnection *connection,
DBusMessage *message,
NihDBusObject *object);
static DBusHandlerResult nih_dbus_object_property_set (DBusConnection *connection,
DBusMessage *message,
NihDBusObject *object);
/**
* nih_dbus_object_vtable:
*
* Table of functions for handling D-Bus objects.
**/
static const DBusObjectPathVTable nih_dbus_object_vtable = {
(DBusObjectPathUnregisterFunction)nih_dbus_object_unregister,
(DBusObjectPathMessageFunction)nih_dbus_object_message,
NULL,
};
/**
* nih_dbus_object_new:
* @parent: parent object for new object,
* @connection: D-Bus connection to associate with,
* @path: path of object,
* @interfaces: interfaces list to attach,
* @data: data pointer.
*
* Creates a new D-Bus object with the attached list of @interfaces which
* specify the methods, signals and properties that object will export
* and the C functions that will handle them.
*
* @interfaces should be a NULL-terminated array of pointers to
* NihDBusInterface structures. Normally this is constructed using pointers
* to structures defined by nih-dbus-tool which provides all the necessary
* glue arrays and functions.
*
* The object structure is allocated using nih_alloc() and connected to
* the given @connection, it can be unregistered by freeing it and it will be
* automatically unregistered should @connection be disconnected.
*
* If @parent is not NULL, it should be a pointer to another object which
* will be used as a parent for the returned object. When all parents
* of the returned object are freed, the returned object will also be
* freed.
*
* Returns: new NihDBusObject structure on success, or NULL if
* insufficient memory.
**/
NihDBusObject *
nih_dbus_object_new (const void * parent,
DBusConnection * connection,
const char * path,
const NihDBusInterface **interfaces,
void * data)
{
NihDBusObject *object;
nih_assert (connection != NULL);
nih_assert (path != NULL);
nih_assert (interfaces != NULL);
object = nih_new (parent, NihDBusObject);
if (! object)
return NULL;
object->path = nih_strdup (object, path);
if (! object->path) {
nih_free (object);
return NULL;
}
/* We don't reference the connection, it's only used to unregister
* the object when freed directly; in addition, we get called if
* the connection is freed and discard this object - and don't want
* to block that happening.
*/
object->connection = connection;
object->data = data;
object->interfaces = interfaces;
object->registered = FALSE;
if (! dbus_connection_register_object_path (object->connection,
object->path,
&nih_dbus_object_vtable,
object)) {
nih_free (object);
return NULL;
}
object->registered = TRUE;
nih_alloc_set_destructor (object, nih_dbus_object_destroy);
return object;
}
/**
* nih_dbus_object_destroy:
* @object: D-Bus object being destroyed.
*
* Destructor function for an NihDBusObject structure, ensures that it
* is unregistered from the attached D-Bus connection and path.
*
* Returns: always zero.
**/
static int
nih_dbus_object_destroy (NihDBusObject *object)
{
nih_assert (object != NULL);
if (object->registered) {
object->registered = FALSE;
dbus_connection_unregister_object_path (object->connection,
object->path);
}
return 0;
}
/**
* nih_dbus_object_unregister:
* @connection: D-Bus connection,
* @object: D-Bus object to destroy.
*
* Called by D-Bus to unregister the @object attached to the D-Bus connection
* @connection, requires us to free the attached structure.
**/
static void
nih_dbus_object_unregister (DBusConnection *connection,
NihDBusObject * object)
{
nih_assert (connection != NULL);
nih_assert (object != NULL);
nih_assert (object->connection == connection);
if (object->registered) {
object->registered = FALSE;
nih_free (object);
}
}
/**
* nih_dbus_object_message:
* @connection: D-Bus connection,
* @message: D-Bus message received,
* @object: Object that received the message.
*
* Called by D-Bus when a @message is received for a registered @object. We
* handle messages related to introspection and properties ourselves,
* otherwise the method invoked is located in the @object's interfaces array
* and the handler function called to handle it.
*
* Returns: result of handling the message.
**/
static DBusHandlerResult
nih_dbus_object_message (DBusConnection *connection,
DBusMessage * message,
NihDBusObject * object)
{
const NihDBusInterface **interface;
nih_assert (connection != NULL);
nih_assert (message != NULL);
nih_assert (object != NULL);
nih_assert (object->connection == connection);
/* Handle introspection internally */
if (dbus_message_is_method_call (
message, DBUS_INTERFACE_INTROSPECTABLE, "Introspect"))
return nih_dbus_object_introspect (connection, message, object);
/* Handle properties semi-internally */
if (dbus_message_is_method_call (
message, DBUS_INTERFACE_PROPERTIES, "Get"))
return nih_dbus_object_property_get (connection, message, object);
if (dbus_message_is_method_call (
message, DBUS_INTERFACE_PROPERTIES, "Set"))
return nih_dbus_object_property_set (connection, message, object);
if (dbus_message_is_method_call (
message, DBUS_INTERFACE_PROPERTIES, "GetAll"))
return nih_dbus_object_property_get_all (connection, message, object);
/* No built-in handling, locate a handler function in the defined
* interfaces that can handle it.
*/
for (interface = object->interfaces; interface && *interface;
interface++) {
const NihDBusMethod *method;
for (method = (*interface)->methods; method && method->name;
method++) {
nih_assert (method->handler != NULL);
if (dbus_message_is_method_call (message,
(*interface)->name,
method->name)) {
nih_local NihDBusMessage *msg = NULL;
DBusHandlerResult result;
msg = nih_dbus_message_new (NULL,
connection, message);
if (! msg)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
nih_error_push_context ();
result = method->handler (object, msg);
nih_error_pop_context ();
if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
return result;
}
}
}
return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}
/**
* nih_dbus_object_introspect:
* @connection: D-Bus connection,
* @message: D-Bus message received,
* @object: Object that received the message.
*
* Called because the D-Bus introspection method has been invoked on @object,
* we return an XML description of the object's interfaces, methods, signals
* and properties based on its interfaces array.
*
* Returns: result of handling the message.
**/
static DBusHandlerResult
nih_dbus_object_introspect (DBusConnection *connection,
DBusMessage * message,
NihDBusObject * object)
{
const NihDBusInterface **interface;
nih_local char * xml = NULL;
char ** children = NULL;
char ** child;
DBusMessage * reply = NULL;
int have_props = FALSE;
nih_assert (connection != NULL);
nih_assert (message != NULL);
nih_assert (object != NULL);
nih_assert (object->connection == connection);
/* Make sure the message signature was what we expected */
if (! dbus_message_has_signature (message, "")) {
reply = dbus_message_new_error (message, DBUS_ERROR_INVALID_ARGS,
_("Invalid arguments to Introspect method"));
if (! reply)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
if (! dbus_connection_send (connection, reply, NULL)) {
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_HANDLED;
}
xml = nih_strdup (NULL, DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE);
if (! xml)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
/* Root node */
if (! nih_strcat_sprintf (&xml, NULL, "<node name=\"%s\">\n",
object->path))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
/* Add each interface definition */
for (interface = object->interfaces; interface && *interface;
interface++) {
const NihDBusMethod * method;
const NihDBusSignal * signal;
const NihDBusProperty *property;
if (! nih_strcat_sprintf (&xml, NULL,
" <interface name=\"%s\">\n",
(*interface)->name))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
for (method = (*interface)->methods; method && method->name;
method++) {
const NihDBusArg *arg;
if (! nih_strcat_sprintf (&xml, NULL,
" <method name=\"%s\">\n",
method->name))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
for (arg = method->args; arg && arg->type; arg++) {
if (! nih_strcat_sprintf (
&xml, NULL,
" <arg"))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
if (arg->name)
if (! nih_strcat_sprintf (
&xml, NULL,
" name=\"%s\"",
arg->name))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
if (! nih_strcat_sprintf (
&xml, NULL,
" type=\"%s\""
" direction=\"%s\"/>\n",
arg->type,
(arg->dir == NIH_DBUS_ARG_IN ? "in"
: "out")))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
if (! nih_strcat (&xml, NULL, " </method>\n"))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
for (signal = (*interface)->signals; signal && signal->name;
signal++) {
const NihDBusArg *arg;
if (! nih_strcat_sprintf (&xml, NULL,
" <signal name=\"%s\">\n",
signal->name))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
for (arg = signal->args; arg && arg->type; arg++) {
if (! nih_strcat_sprintf (
&xml, NULL,
" <arg"))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
if (arg->name)
if (! nih_strcat_sprintf (
&xml, NULL,
" name=\"%s\"",
arg->name))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
if (! nih_strcat_sprintf (
&xml, NULL,
" type=\"%s\"/>\n",
arg->type))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
if (! nih_strcat (&xml, NULL, " </signal>\n"))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
for (property = (*interface)->properties;
property && property->name; property++) {
have_props = TRUE;
if (! nih_strcat_sprintf (
&xml, NULL,
" <property name=\"%s\" type=\"%s\" "
"access=\"%s\"/>\n",
property->name, property->type,
(property->access == NIH_DBUS_READ ? "read"
: (property->access == NIH_DBUS_WRITE
? "write" : "readwrite"))))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
if (! nih_strcat (&xml, NULL, " </interface>\n"))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
/* We may also support properties, but don't want to announce that
* unless we really do have some.
*/
if (have_props)
if (! nih_strcat_sprintf (
&xml, NULL,
" <interface name=\"%s\">\n"
" <method name=\"Get\">\n"
" <arg name=\"interface_name\" type=\"s\" direction=\"in\"/>\n"
" <arg name=\"property_name\" type=\"s\" direction=\"in\"/>\n"
" <arg name=\"value\" type=\"v\" direction=\"out\"/>\n"
" </method>\n"
" <method name=\"Set\">\n"
" <arg name=\"interface_name\" type=\"s\" direction=\"in\"/>\n"
" <arg name=\"property_name\" type=\"s\" direction=\"in\"/>\n"
" <arg name=\"value\" type=\"v\" direction=\"in\"/>\n"
" </method>\n"
" <method name=\"GetAll\">\n"
" <arg name=\"interface_name\" type=\"s\" direction=\"in\"/>\n"
" <arg name=\"props\" type=\"a{sv}\" direction=\"out\"/>\n"
" </method>\n"
" </interface>\n",
DBUS_INTERFACE_PROPERTIES))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
/* Obviously we support introspection */
if (! nih_strcat_sprintf (&xml, NULL,
" <interface name=\"%s\">\n"
" <method name=\"Introspect\">\n"
" <arg name=\"data\" type=\"s\" direction=\"out\"/>\n"
" </method>\n"
" </interface>\n",
DBUS_INTERFACE_INTROSPECTABLE))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
/* Add node items for children */
if (! dbus_connection_list_registered (connection, object->path, &children))
return DBUS_HANDLER_RESULT_NEED_MEMORY;
for (child = children; *child; child++) {
if (! nih_strcat_sprintf (&xml, NULL, " <node name=\"%s\"/>\n",
*child)) {
dbus_free_string_array (children);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
}
if (! nih_strcat (&xml, NULL, "</node>\n")) {
dbus_free_string_array (children);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
dbus_free_string_array (children);
/* Generate and send the reply */
reply = dbus_message_new_method_return (message);
if (! reply)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
if (! dbus_message_append_args (reply,
DBUS_TYPE_STRING, &xml,
DBUS_TYPE_INVALID)) {
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
if (! dbus_connection_send (connection, reply, NULL)) {
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_HANDLED;
}
/**
* nih_dbus_object_property_get:
* @connection: D-Bus connection,
* @message: D-Bus message received,
* @object: Object that received the message.
*
* Called because the D-Bus properties Get method has been invoked on
* @object We locate the property in the @object's interfaces array and
* call the getter function to append a variant onto the reply we
* generate.
*
* Returns: result of handling the message.
**/
static DBusHandlerResult
nih_dbus_object_property_get (DBusConnection *connection,
DBusMessage * message,
NihDBusObject * object)
{
DBusMessage * reply;
DBusMessageIter iter;
const char * interface_name;
const char * property_name;
const NihDBusInterface **interface;
nih_assert (connection != NULL);
nih_assert (message != NULL);
nih_assert (object != NULL);
nih_assert (object->connection == connection);
/* Retrieve the requested interface and property names from the
* method call, first making sure the message signature was what
* we expected.
*/
if (! dbus_message_has_signature (message,
(DBUS_TYPE_STRING_AS_STRING
DBUS_TYPE_STRING_AS_STRING))) {
reply = dbus_message_new_error (message, DBUS_ERROR_INVALID_ARGS,
_("Invalid arguments to Get method"));
if (! reply)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
if (! dbus_connection_send (connection, reply, NULL)) {
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_HANDLED;
}
dbus_message_iter_init (message, &iter);
dbus_message_iter_get_basic (&iter, &interface_name);
dbus_message_iter_next (&iter);
dbus_message_iter_get_basic (&iter, &property_name);
dbus_message_iter_next (&iter);
/* Locate a getter function in the defined interfaces. */
for (interface = object->interfaces; interface && *interface;
interface++) {
const NihDBusProperty *property;
for (property = (*interface)->properties;
property && property->name;
property++) {
nih_local NihDBusMessage *msg = NULL;
int ret;
if (strcmp (property->name, property_name)
|| (strlen (interface_name)
&& strcmp ((*interface)->name, interface_name)))
continue;
if (property->getter) {
msg = nih_dbus_message_new (NULL,
connection, message);
if (! msg)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
reply = dbus_message_new_method_return (message);
if (! reply)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
dbus_message_iter_init_append (reply, &iter);
nih_error_push_context ();
ret = property->getter (object, msg, &iter);
if (ret < 0) {
NihError *err;
dbus_message_unref (reply);
err = nih_error_get ();
if (err->number == ENOMEM) {
nih_free (err);
nih_error_pop_context ();
return DBUS_HANDLER_RESULT_NEED_MEMORY;
} else if (err->number == NIH_DBUS_ERROR) {
NihDBusError *dbus_err = (NihDBusError *)err;
reply = NIH_MUST (dbus_message_new_error (
message,
dbus_err->name,
dbus_err->message));
nih_free (err);
nih_error_pop_context ();
} else {
reply = NIH_MUST (dbus_message_new_error (
message,
DBUS_ERROR_FAILED,
err->message));
nih_free (err);
nih_error_pop_context ();
}
} else {
nih_error_pop_context ();
}
} else {
reply = dbus_message_new_error_printf (
message, DBUS_ERROR_ACCESS_DENIED,
_("The %s property is write-only"),
property->name);
if (! reply)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
if (! dbus_connection_send (connection, reply, NULL)) {
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_HANDLED;
}
}
return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}
/**
* nih_dbus_object_property_get_all:
* @connection: D-Bus connection,
* @message: D-Bus message received,
* @object: Object that received the message.
*
* Called because the D-Bus properties Get method has been invoked on
* @object We locate the property in the @object's interfaces array and
* call the getter function to append a variant onto the reply we
* generate.
*
* Returns: result of handling the message.
**/
static DBusHandlerResult
nih_dbus_object_property_get_all (DBusConnection *connection,
DBusMessage * message,
NihDBusObject * object)
{
DBusMessage * reply;
DBusMessageIter iter;
DBusMessageIter arrayiter;
const char * interface_name;
nih_local NihHash * name_hash = NULL;
nih_local NihDBusMessage *msg = NULL;
const NihDBusInterface ** interface;
nih_assert (connection != NULL);
nih_assert (message != NULL);
nih_assert (object != NULL);
nih_assert (object->connection == connection);
/* Retrieve the requested interface name from the method call,
* first making sure the message signature was what we expected.
*/
if (! dbus_message_has_signature (message, DBUS_TYPE_STRING_AS_STRING)) {
reply = dbus_message_new_error (message, DBUS_ERROR_INVALID_ARGS,
_("Invalid arguments to GetAll method"));
if (! reply)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
if (! dbus_connection_send (connection, reply, NULL)) {
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_HANDLED;
}
dbus_message_iter_init (message, &iter);
dbus_message_iter_get_basic (&iter, &interface_name);
dbus_message_iter_next (&iter);
/* D-Bus forbids us from returning multiple properties with the
* same name in the dictionary, so we actually have to build
* a dictionary of the properties we've visited.
*/
name_hash = nih_hash_string_new (NULL, 0);
if (! name_hash)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
/* Use the same NihDBusMessage object for each of the getters we
* call for efficiency
*/
msg = nih_dbus_message_new (NULL, connection, message);
if (! msg)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
/* Begin constructing the reply immediately as well */
reply = dbus_message_new_method_return (message);
if (! reply)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
dbus_message_iter_init_append (reply, &iter);
if (! dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
(DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
DBUS_TYPE_STRING_AS_STRING
DBUS_TYPE_VARIANT_AS_STRING
DBUS_DICT_ENTRY_END_CHAR_AS_STRING),
&arrayiter)) {
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
/* Call each of the getter functions for the matching interface,
* or all of them if it's an empty string.
*/
for (interface = object->interfaces; interface && *interface;
interface++) {
const NihDBusProperty *property;
if (strlen (interface_name)
&& strcmp ((*interface)->name, interface_name))
continue;
for (property = (*interface)->properties;
property && property->name;
property++) {
if (property->getter
&& (! nih_hash_lookup (name_hash, property->name))) {
NihListEntry * entry;
DBusMessageIter dictiter;
int ret;
entry = nih_list_entry_new (name_hash);
if (! entry) {
dbus_message_iter_abandon_container (&iter, &arrayiter);
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
entry->str = (char *)property->name;
nih_hash_add (name_hash, &entry->entry);
if (! dbus_message_iter_open_container (
&arrayiter, DBUS_TYPE_DICT_ENTRY,
NULL, &dictiter)) {
dbus_message_iter_abandon_container (&iter, &arrayiter);
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
if (! dbus_message_iter_append_basic (
&dictiter, DBUS_TYPE_STRING,
&(property->name))) {
dbus_message_iter_abandon_container (&arrayiter, &dictiter);
dbus_message_iter_abandon_container (&iter, &arrayiter);
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
nih_error_push_context ();
ret = property->getter (object, msg, &dictiter);
if (ret < 0) {
NihError *err;
dbus_message_iter_abandon_container (&arrayiter, &dictiter);
dbus_message_iter_abandon_container (&iter, &arrayiter);
dbus_message_unref (reply);
err = nih_error_get ();
if (err->number == ENOMEM) {
nih_free (err);
nih_error_pop_context ();
return DBUS_HANDLER_RESULT_NEED_MEMORY;
} else if (err->number == NIH_DBUS_ERROR) {
NihDBusError *dbus_err = (NihDBusError *)err;
reply = NIH_MUST (dbus_message_new_error (
message,
dbus_err->name,
dbus_err->message));
nih_free (err);
nih_error_pop_context ();
} else {
reply = NIH_MUST (dbus_message_new_error (
message,
DBUS_ERROR_FAILED,
err->message));
nih_free (err);
nih_error_pop_context ();
}
goto reply;
} else {
nih_error_pop_context ();
if (! dbus_message_iter_close_container (
&arrayiter, &dictiter)) {
dbus_message_iter_abandon_container (&iter, &arrayiter);
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
}
}
}
}
/* Close the array and send the reply */
if (! dbus_message_iter_close_container (&iter, &arrayiter)) {
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
reply:
if (! dbus_connection_send (connection, reply, NULL)) {
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_HANDLED;
}
/**
* nih_dbus_object_property_set:
* @connection: D-Bus connection,
* @message: D-Bus message received,
* @object: Object that received the message.
*
* Called because the D-Bus properties Set method has been invoked on
* @object We locate the property in the @object's interfaces array and
* call the setter function to retrieve the variant and generate a reply.
*
* Returns: result of handling the message.
**/
static DBusHandlerResult
nih_dbus_object_property_set (DBusConnection *connection,
DBusMessage * message,
NihDBusObject * object)
{
DBusMessage * reply;
DBusMessageIter iter;
const char * interface_name;
const char * property_name;
const NihDBusInterface **interface;
nih_assert (connection != NULL);
nih_assert (message != NULL);
nih_assert (object != NULL);
nih_assert (object->connection == connection);
/* Retrieve the requested interface and property names from the
* method call, first making sure the message signature was what
* we expected.
*/
if (! dbus_message_has_signature (message,
(DBUS_TYPE_STRING_AS_STRING
DBUS_TYPE_STRING_AS_STRING
DBUS_TYPE_VARIANT_AS_STRING))) {
reply = dbus_message_new_error (message, DBUS_ERROR_INVALID_ARGS,
_("Invalid arguments to Set method"));
if (! reply)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
if (! dbus_connection_send (connection, reply, NULL)) {
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_HANDLED;
}
dbus_message_iter_init (message, &iter);
dbus_message_iter_get_basic (&iter, &interface_name);
dbus_message_iter_next (&iter);
dbus_message_iter_get_basic (&iter, &property_name);
dbus_message_iter_next (&iter);
/* Locate a setter function in the defined interfaces. */
for (interface = object->interfaces; interface && *interface;
interface++) {
const NihDBusProperty *property;
for (property = (*interface)->properties;
property && property->name;
property++) {
nih_local NihDBusMessage *msg = NULL;
DBusMessage * reply;
int ret;
if (strcmp (property->name, property_name)
|| (strlen (interface_name)
&& strcmp ((*interface)->name, interface_name)))
continue;
if (property->setter) {
msg = nih_dbus_message_new (NULL,
connection, message);
if (! msg)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
nih_error_push_context ();
ret = property->setter (object, msg, &iter);
if (ret < 0) {
NihError *err;
err = nih_error_get ();
if (err->number == ENOMEM) {
nih_free (err);
nih_error_pop_context ();
return DBUS_HANDLER_RESULT_NEED_MEMORY;
} else if (err->number == NIH_DBUS_ERROR) {
NihDBusError *dbus_err = (NihDBusError *)err;
reply = NIH_MUST (dbus_message_new_error (
message,
dbus_err->name,
dbus_err->message));
nih_free (err);
nih_error_pop_context ();
} else {
reply = NIH_MUST (dbus_message_new_error (
message,
DBUS_ERROR_FAILED,
err->message));
nih_free (err);
nih_error_pop_context ();
}
} else {
nih_error_pop_context ();
reply = NIH_MUST (dbus_message_new_method_return (message));
}
} else {
reply = dbus_message_new_error_printf (
message, DBUS_ERROR_ACCESS_DENIED,
_("The %s property is read-only"),
property->name);
if (! reply)
return DBUS_HANDLER_RESULT_NEED_MEMORY;
}
NIH_MUST (dbus_connection_send (connection, reply, NULL));
dbus_message_unref (reply);
return DBUS_HANDLER_RESULT_HANDLED;
}
}
return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}
|