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
|
from ._private.address import get_bus_address, parse_address
from ._private.util import replace_fds_with_idx, replace_idx_with_fds
from .message import Message
from .constants import BusType, MessageFlag, MessageType, ErrorType, NameFlag, RequestNameReply, ReleaseNameReply
from .service import ServiceInterface
from .validators import assert_object_path_valid, assert_bus_name_valid
from .errors import DBusError, InvalidAddressError
from .signature import Variant
from .proxy_object import BaseProxyObject
from . import introspection as intr
import inspect
import socket
import logging
import xml.etree.ElementTree as ET
import traceback
from typing import Type, Callable, Optional, Union
class BaseMessageBus:
"""An abstract class to manage a connection to a DBus message bus.
The message bus class is the entry point into all the features of the
library. It sets up a connection to the DBus daemon and exposes an
interface to send and receive messages and expose services.
This class is not meant to be used directly by users. For more information,
see the documentation for the implementation of the message bus you plan to
use.
:param bus_type: The type of bus to connect to. Affects the search path for
the bus address.
:type bus_type: :class:`BusType <dbus_next.BusType>`
:param bus_address: A specific bus address to connect to. Should not be
used under normal circumstances.
:type bus_address: str
:param ProxyObject: The proxy object implementation for this message bus.
Must be passed in by an implementation that supports the high-level client.
:type ProxyObject: Type[:class:`BaseProxyObject
<dbus_next.proxy_object.BaseProxyObject>`]
:ivar unique_name: The unique name of the message bus connection. It will
be :class:`None` until the message bus connects.
:vartype unique_name: str
:ivar connected: True if this message bus is expected to be able to send
and receive messages.
:vartype connected: bool
"""
def __init__(self,
bus_address: Optional[str] = None,
bus_type: BusType = BusType.SESSION,
ProxyObject: Optional[Type[BaseProxyObject]] = None):
self.unique_name = None
self._disconnected = False
# True if the user disconnected himself, so don't throw errors out of
# the main loop.
self._user_disconnect = False
self._method_return_handlers = {}
self._serial = 0
self._user_message_handlers = []
# the key is the name and the value is the unique name of the owner.
# This cache is kept up to date by the NameOwnerChanged signal and is
# used to route messages to the correct proxy object. (used for the
# high level client only)
self._name_owners = {}
# used for the high level service
self._path_exports = {}
self._bus_address = parse_address(bus_address) if bus_address else parse_address(
get_bus_address(bus_type))
# the bus implementations need this rule for the high level client to
# work correctly.
self._name_owner_match_rule = "sender='org.freedesktop.DBus',interface='org.freedesktop.DBus',path='/org/freedesktop/DBus',member='NameOwnerChanged'"
# _match_rules: the keys are match rules and the values are ref counts
# (used for the high level client only)
self._match_rules = {}
self._high_level_client_initialized = False
self._ProxyObject = ProxyObject
# machine id is lazy loaded
self._machine_id = None
self._setup_socket()
@property
def connected(self):
if self.unique_name is None or self._disconnected or self._user_disconnect:
return False
return True
def export(self, path: str, interface: ServiceInterface):
"""Export the service interface on this message bus to make it available
to other clients.
:param path: The object path to export this interface on.
:type path: str
:param interface: The service interface to export.
:type interface: :class:`ServiceInterface
<dbus_next.service.ServiceInterface>`
:raises:
- :class:`InvalidObjectPathError <dbus_next.InvalidObjectPathError>` - If the given object path is not valid.
- :class:`ValueError` - If an interface with this name is already exported on the message bus at this path
"""
assert_object_path_valid(path)
if not isinstance(interface, ServiceInterface):
raise TypeError('interface must be a ServiceInterface')
if path not in self._path_exports:
self._path_exports[path] = []
for f in self._path_exports[path]:
if f.name == interface.name:
raise ValueError(
f'An interface with this name is already exported on this bus at path "{path}": "{interface.name}"'
)
self._path_exports[path].append(interface)
ServiceInterface._add_bus(interface, self)
self._emit_interface_added(path, interface)
def unexport(self, path: str, interface: Optional[Union[ServiceInterface, str]] = None):
"""Unexport the path or service interface to make it no longer
available to clients.
:param path: The object path to unexport.
:type path: str
:param interface: The interface instance or the name of the interface
to unexport. If ``None``, unexport every interface on the path.
:type interface: :class:`ServiceInterface
<dbus_next.service.ServiceInterface>` or str or None
:raises:
- :class:`InvalidObjectPathError <dbus_next.InvalidObjectPathError>` - If the given object path is not valid.
"""
assert_object_path_valid(path)
if type(interface) not in [str, type(None)] and not isinstance(interface, ServiceInterface):
raise TypeError('interface must be a ServiceInterface or interface name')
if path not in self._path_exports:
return
exports = self._path_exports[path]
if type(interface) is str:
try:
interface = next(iface for iface in exports if iface.name == interface)
except StopIteration:
return
removed_interfaces = []
if interface is None:
del self._path_exports[path]
for iface in filter(lambda e: not self._has_interface(e), exports):
removed_interfaces.append(iface.name)
ServiceInterface._remove_bus(iface, self)
else:
for i, iface in enumerate(exports):
if iface is interface:
removed_interfaces.append(iface.name)
del self._path_exports[path][i]
if not self._path_exports[path]:
del self._path_exports[path]
if not self._has_interface(iface):
ServiceInterface._remove_bus(iface, self)
break
self._emit_interface_removed(path, removed_interfaces)
def introspect(self, bus_name: str, path: str,
callback: Callable[[Optional[intr.Node], Optional[Exception]], None]):
"""Get introspection data for the node at the given path from the given
bus name.
Calls the standard ``org.freedesktop.DBus.Introspectable.Introspect``
on the bus for the path.
:param bus_name: The name to introspect.
:type bus_name: str
:param path: The path to introspect.
:type path: str
:param callback: A callback that will be called with the introspection
data as a :class:`Node <dbus_next.introspection.Node>`.
:type callback: :class:`Callable`
:raises:
- :class:`InvalidObjectPathError <dbus_next.InvalidObjectPathError>` - If the given object path is not valid.
- :class:`InvalidBusNameError <dbus_next.InvalidBusNameError>` - If the given bus name is not valid.
"""
BaseMessageBus._check_callback_type(callback)
def reply_notify(reply, err):
try:
BaseMessageBus._check_method_return(reply, err, 's')
result = intr.Node.parse(reply.body[0])
except Exception as e:
callback(None, e)
return
callback(result, None)
self._call(
Message(destination=bus_name,
path=path,
interface='org.freedesktop.DBus.Introspectable',
member='Introspect'), reply_notify)
def _emit_interface_added(self, path, interface):
"""Emit the ``org.freedesktop.DBus.ObjectManager.InterfacesAdded`` signal.
This signal is intended to be used to alert clients when
a new interface has been added.
:param path: Path of exported object.
:type path: str
:param interface: Exported service interface.
:type interface: :class:`ServiceInterface
<dbus_next.service.ServiceInterface>`
"""
if self._disconnected:
return
def get_properties_callback(interface, result, user_data, e):
if e is not None:
try:
raise e
except Exception:
logging.error(
'An exception ocurred when emitting ObjectManager.InterfacesAdded for %s. '
'Some properties will not be included in the signal.',
interface.name,
exc_info=True)
body = {interface.name: result}
self.send(
Message.new_signal(path=path,
interface='org.freedesktop.DBus.ObjectManager',
member='InterfacesAdded',
signature='oa{sa{sv}}',
body=[path, body]))
ServiceInterface._get_all_property_values(interface, get_properties_callback)
def _emit_interface_removed(self, path, removed_interfaces):
"""Emit the ``org.freedesktop.DBus.ObjectManager.InterfacesRemoved` signal.
This signal is intended to be used to alert clients when
a interface has been removed.
:param path: Path of removed (unexported) object.
:type path: str
:param removed_interfaces: List of unexported service interfaces.
:type removed_interfaces: list[str]
"""
if self._disconnected:
return
self.send(
Message.new_signal(path=path,
interface='org.freedesktop.DBus.ObjectManager',
member='InterfacesRemoved',
signature='oas',
body=[path, removed_interfaces]))
def request_name(self,
name: str,
flags: NameFlag = NameFlag.NONE,
callback: Optional[Callable[[Optional[RequestNameReply], Optional[Exception]],
None]] = None):
"""Request that this message bus owns the given name.
:param name: The name to request.
:type name: str
:param flags: Name flags that affect the behavior of the name request.
:type flags: :class:`NameFlag <dbus_next.NameFlag>`
:param callback: A callback that will be called with the reply of the
request as a :class:`RequestNameReply <dbus_next.RequestNameReply>`.
:type callback: :class:`Callable`
:raises:
- :class:`InvalidBusNameError <dbus_next.InvalidBusNameError>` - If the given bus name is not valid.
"""
assert_bus_name_valid(name)
if callback is not None:
BaseMessageBus._check_callback_type(callback)
def reply_notify(reply, err):
try:
BaseMessageBus._check_method_return(reply, err, 'u')
result = RequestNameReply(reply.body[0])
except Exception as e:
callback(None, e)
return
callback(result, None)
if type(flags) is not NameFlag:
flags = NameFlag(flags)
self._call(
Message(destination='org.freedesktop.DBus',
path='/org/freedesktop/DBus',
interface='org.freedesktop.DBus',
member='RequestName',
signature='su',
body=[name, flags]), reply_notify if callback else None)
def release_name(self,
name: str,
callback: Optional[Callable[[Optional[ReleaseNameReply], Optional[Exception]],
None]] = None):
"""Request that this message bus release the given name.
:param name: The name to release.
:type name: str
:param callback: A callback that will be called with the reply of the
release request as a :class:`ReleaseNameReply
<dbus_next.ReleaseNameReply>`.
:type callback: :class:`Callable`
:raises:
- :class:`InvalidBusNameError <dbus_next.InvalidBusNameError>` - If the given bus name is not valid.
"""
assert_bus_name_valid(name)
if callback is not None:
BaseMessageBus._check_callback_type(callback)
def reply_notify(reply, err):
try:
BaseMessageBus._check_method_return(reply, err, 'u')
result = ReleaseNameReply(reply.body[0])
except Exception as e:
callback(None, e)
return
callback(result, None)
self._call(
Message(destination='org.freedesktop.DBus',
path='/org/freedesktop/DBus',
interface='org.freedesktop.DBus',
member='ReleaseName',
signature='s',
body=[name]), reply_notify if callback else None)
def get_proxy_object(self, bus_name: str, path: str,
introspection: Union[intr.Node, str, ET.Element]) -> BaseProxyObject:
"""Get a proxy object for the path exported on the bus that owns the
name. The object is expected to export the interfaces and nodes
specified in the introspection data.
This is the entry point into the high-level client.
:param bus_name: The name on the bus to get the proxy object for.
:type bus_name: str
:param path: The path on the client for the proxy object.
:type path: str
:param introspection: XML introspection data used to build the
interfaces on the proxy object.
:type introspection: :class:`Node <dbus_next.introspection.Node>` or str or :class:`ElementTree`
:returns: A proxy object for the given path on the given name.
:rtype: :class:`BaseProxyObject <dbus_next.proxy_object.BaseProxyObject>`
:raises:
- :class:`InvalidBusNameError <dbus_next.InvalidBusNameError>` - If the given bus name is not valid.
- :class:`InvalidObjectPathError <dbus_next.InvalidObjectPathError>` - If the given object path is not valid.
- :class:`InvalidIntrospectionError <dbus_next.InvalidIntrospectionError>` - If the introspection data for the node is not valid.
"""
if self._ProxyObject is None:
raise Exception('the message bus implementation did not provide a proxy object class')
self._init_high_level_client()
return self._ProxyObject(bus_name, path, introspection, self)
def disconnect(self):
"""Disconnect the message bus by closing the underlying connection asynchronously.
All pending and future calls will error with a connection error.
"""
self._user_disconnect = True
try:
self._sock.shutdown(socket.SHUT_RDWR)
except Exception:
logging.warning('could not shut down socket', exc_info=True)
def next_serial(self) -> int:
"""Get the next serial for this bus. This can be used as the ``serial``
attribute of a :class:`Message <dbus_next.Message>` to manually handle
the serial of messages.
:returns: The next serial for the bus.
:rtype: int
"""
self._serial += 1
return self._serial
def add_message_handler(self, handler: Callable[[Message], Optional[Union[Message, bool]]]):
"""Add a custom message handler for incoming messages.
The handler should be a callable that takes a :class:`Message
<dbus_next.Message>`. If the message is a method call, you may return
another Message as a reply and it will be marked as handled. You may
also return ``True`` to mark the message as handled without sending a
reply.
:param handler: A handler that will be run for every message the bus
connection received.
:type handler: :class:`Callable` or None
"""
error_text = 'a message handler must be callable with a single parameter'
if not callable(handler):
raise TypeError(error_text)
handler_signature = inspect.signature(handler)
if len(handler_signature.parameters) != 1:
raise TypeError(error_text)
self._user_message_handlers.append(handler)
def remove_message_handler(self, handler: Callable[[Message], Optional[Union[Message, bool]]]):
"""Remove a message handler that was previously added by
:func:`add_message_handler()
<dbus_next.message_bus.BaseMessageBus.add_message_handler>`.
:param handler: A message handler.
:type handler: :class:`Callable`
"""
for i, h in enumerate(self._user_message_handlers):
if h == handler:
del self._user_message_handlers[i]
break
def send(self, msg: Message) -> None:
"""Asynchronously send a message on the message bus.
:param msg: The message to send.
:type msg: :class:`Message <dbus_next.Message>`
"""
raise NotImplementedError('the "send" method must be implemented in the inheriting class')
def _finalize(self, err):
'''should be called after the socket disconnects with the disconnection
error to clean up resources and put the bus in a disconnected state'''
if self._disconnected:
return
self._disconnected = True
for handler in self._method_return_handlers.values():
try:
handler(None, err)
except Exception:
logging.warning('a message handler threw an exception on shutdown', exc_info=True)
self._method_return_handlers.clear()
for path in list(self._path_exports.keys()):
self.unexport(path)
self._user_message_handlers.clear()
def _has_interface(self, interface: ServiceInterface) -> bool:
for _, exports in self._path_exports.items():
for iface in exports:
if iface is interface:
return True
return False
def _interface_signal_notify(self,
interface,
interface_name,
member,
signature,
body,
unix_fds=[]):
path = None
for p, ifaces in self._path_exports.items():
for i in ifaces:
if i is interface:
path = p
if path is None:
raise Exception('Could not find interface on bus (this is a bug in dbus-next)')
self.send(
Message.new_signal(path=path,
interface=interface_name,
member=member,
signature=signature,
body=body,
unix_fds=unix_fds))
def _introspect_export_path(self, path):
assert_object_path_valid(path)
if path in self._path_exports:
node = intr.Node.default(path)
for interface in self._path_exports[path]:
node.interfaces.append(interface.introspect())
else:
node = intr.Node(path)
children = set()
for export_path in self._path_exports:
try:
child_path = export_path.split(path, maxsplit=1)[1]
except IndexError:
continue
child_path = child_path.lstrip('/')
child_name = child_path.split('/', maxsplit=1)[0]
children.add(child_name)
node.nodes = [intr.Node(name) for name in children if name]
return node
def _setup_socket(self):
err = None
for transport, options in self._bus_address:
filename = None
ip_addr = ''
ip_port = 0
if transport == 'unix':
self._sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
self._stream = self._sock.makefile('rwb')
self._fd = self._sock.fileno()
if 'path' in options:
filename = options['path']
elif 'abstract' in options:
filename = f'\0{options["abstract"]}'
else:
raise InvalidAddressError('got unix transport with unknown path specifier')
try:
self._sock.connect(filename)
self._sock.setblocking(False)
break
except Exception as e:
err = e
elif transport == 'tcp':
self._sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self._stream = self._sock.makefile('rwb')
self._fd = self._sock.fileno()
if 'host' in options:
ip_addr = options['host']
if 'port' in options:
ip_port = int(options['port'])
try:
self._sock.connect((ip_addr, ip_port))
self._sock.setblocking(False)
break
except Exception as e:
err = e
else:
raise InvalidAddressError(f'got unknown address transport: {transport}')
if err:
raise err
def _call(self, msg, callback):
BaseMessageBus._check_callback_type(callback)
if not msg.serial:
msg.serial = self.next_serial()
def reply_notify(reply, err):
if reply:
self._name_owners[msg.destination] = reply.sender
callback(reply, err)
self.send(msg)
if msg.flags & MessageFlag.NO_REPLY_EXPECTED:
callback(None, None)
else:
self._method_return_handlers[msg.serial] = reply_notify
@staticmethod
def _check_callback_type(callback):
"""Raise a TypeError if the user gives an invalid callback as a parameter"""
text = 'a callback must be callable with two parameters'
if not callable(callback):
raise TypeError(text)
fn_signature = inspect.signature(callback)
if len(fn_signature.parameters) != 2:
raise TypeError(text)
@staticmethod
def _check_method_return(msg, err, signature):
if err:
raise err
elif msg.message_type == MessageType.METHOD_RETURN and msg.signature == signature:
return
elif msg.message_type == MessageType.ERROR:
raise DBusError._from_message(msg)
else:
raise DBusError(ErrorType.INTERNAL_ERROR, 'invalid message type for method call', msg)
def _on_message(self, msg):
try:
self._process_message(msg)
except Exception as e:
logging.error(
f'got unexpected error processing a message: {e}.\n{traceback.format_exc()}')
def _send_reply(self, msg):
bus = self
class SendReply:
def __enter__(self):
return self
def __call__(self, reply):
if msg.flags & MessageFlag.NO_REPLY_EXPECTED:
return
bus.send(reply)
def _exit(self, exc_type, exc_value, tb):
if exc_type is None:
return
if issubclass(exc_type, DBusError):
self(exc_value._as_message(msg))
return True
if issubclass(exc_type, Exception):
self(
Message.new_error(
msg, ErrorType.SERVICE_ERROR,
f'The service interface raised an error: {exc_value}.\n{traceback.format_tb(tb)}'
))
return True
def __exit__(self, exc_type, exc_value, tb):
self._exit(exc_type, exc_value, tb)
def send_error(self, exc):
self._exit(exc.__class__, exc, exc.__traceback__)
return SendReply()
def _process_message(self, msg):
handled = False
for handler in self._user_message_handlers:
try:
result = handler(msg)
if result:
if type(result) is Message:
self.send(result)
handled = True
break
except DBusError as e:
if msg.message_type == MessageType.METHOD_CALL:
self.send(e._as_message(msg))
handled = True
break
else:
logging.error(
f'A message handler raised an exception: {e}.\n{traceback.format_exc()}')
except Exception as e:
logging.error(
f'A message handler raised an exception: {e}.\n{traceback.format_exc()}')
if msg.message_type == MessageType.METHOD_CALL:
self.send(
Message.new_error(
msg, ErrorType.INTERNAL_ERROR,
f'An internal error occurred: {e}.\n{traceback.format_exc()}'))
handled = True
break
if msg.message_type == MessageType.SIGNAL:
if msg._matches(sender='org.freedesktop.DBus',
path='/org/freedesktop/DBus',
interface='org.freedesktop.DBus',
member='NameOwnerChanged'):
[name, old_owner, new_owner] = msg.body
if new_owner:
self._name_owners[name] = new_owner
elif name in self._name_owners:
del self._name_owners[name]
elif msg.message_type == MessageType.METHOD_CALL:
if not handled:
handler = self._find_message_handler(msg)
send_reply = self._send_reply(msg)
with send_reply:
if handler:
handler(msg, send_reply)
else:
send_reply(
Message.new_error(
msg, ErrorType.UNKNOWN_METHOD,
f'{msg.interface}.{msg.member} with signature "{msg.signature}" could not be found'
))
else:
# An ERROR or a METHOD_RETURN
if msg.reply_serial in self._method_return_handlers:
if not handled:
handler = self._method_return_handlers[msg.reply_serial]
handler(msg, None)
del self._method_return_handlers[msg.reply_serial]
def _make_method_handler(self, interface, method):
def handler(msg, send_reply):
args = ServiceInterface._msg_body_to_args(msg)
result = method.fn(interface, *args)
body, fds = ServiceInterface._fn_result_to_body(
result, signature_tree=method.out_signature_tree)
send_reply(Message.new_method_return(msg, method.out_signature, body, fds))
return handler
def _find_message_handler(self, msg):
handler = None
if msg._matches(interface='org.freedesktop.DBus.Introspectable',
member='Introspect',
signature=''):
handler = self._default_introspect_handler
elif msg._matches(interface='org.freedesktop.DBus.Properties'):
handler = self._default_properties_handler
elif msg._matches(interface='org.freedesktop.DBus.Peer'):
if msg._matches(member='Ping', signature=''):
handler = self._default_ping_handler
elif msg._matches(member='GetMachineId', signature=''):
handler = self._default_get_machine_id_handler
elif msg._matches(interface='org.freedesktop.DBus.ObjectManager',
member='GetManagedObjects'):
handler = self._default_get_managed_objects_handler
else:
for interface in self._path_exports.get(msg.path, []):
for method in ServiceInterface._get_methods(interface):
if method.disabled:
continue
if msg._matches(interface=interface.name,
member=method.name,
signature=method.in_signature):
handler = self._make_method_handler(interface, method)
break
if handler:
break
return handler
def _default_introspect_handler(self, msg, send_reply):
introspection = self._introspect_export_path(msg.path).tostring()
send_reply(Message.new_method_return(msg, 's', [introspection]))
def _default_ping_handler(self, msg, send_reply):
send_reply(Message.new_method_return(msg))
def _default_get_machine_id_handler(self, msg, send_reply):
if self._machine_id:
send_reply(Message.new_method_return(msg, 's', self._machine_id))
return
def reply_handler(reply, err):
if err:
# the bus has been disconnected, cannot send a reply
return
if reply.message_type == MessageType.METHOD_RETURN:
self._machine_id = reply.body[0]
send_reply(Message.new_method_return(msg, 's', [self._machine_id]))
elif reply.message_type == MessageType.ERROR:
send_reply(Message.new_error(msg, reply.error_name, reply.body))
else:
send_reply(Message.new_error(msg, ErrorType.FAILED, 'could not get machine_id'))
self._call(
Message(destination='org.freedesktop.DBus',
path='/org/freedesktop/DBus',
interface='org.freedesktop.DBus.Peer',
member='GetMachineId'), reply_handler)
def _default_get_managed_objects_handler(self, msg, send_reply):
result = {}
result_signature = 'a{oa{sa{sv}}}'
error_handled = False
def is_result_complete():
if not result:
return True
for n, interfaces in result.items():
for value in interfaces.values():
if value is None:
return False
return True
nodes = [
node for node in self._path_exports
if msg.path == '/' or node.startswith(msg.path + '/')
]
# first build up the result object to know when it's complete
for node in nodes:
result[node] = {}
for interface in self._path_exports[node]:
result[node][interface.name] = None
if is_result_complete():
send_reply(Message.new_method_return(msg, result_signature, [result]))
return
def get_all_properties_callback(interface, values, node, err):
nonlocal error_handled
if err is not None:
if not error_handled:
error_handled = True
send_reply.send_error(err)
return
result[node][interface.name] = values
if is_result_complete():
send_reply(Message.new_method_return(msg, result_signature, [result]))
for node in nodes:
for interface in self._path_exports[node]:
ServiceInterface._get_all_property_values(interface, get_all_properties_callback,
node)
def _default_properties_handler(self, msg, send_reply):
methods = {'Get': 'ss', 'Set': 'ssv', 'GetAll': 's'}
if msg.member not in methods or methods[msg.member] != msg.signature:
raise DBusError(
ErrorType.UNKNOWN_METHOD,
f'properties interface doesn\'t have method "{msg.member}" with signature "{msg.signature}"'
)
interface_name = msg.body[0]
if interface_name == '':
raise DBusError(
ErrorType.NOT_SUPPORTED,
'getting and setting properties with an empty interface string is not supported yet'
)
elif msg.path not in self._path_exports:
raise DBusError(ErrorType.UNKNOWN_OBJECT, f'no interfaces at path: "{msg.path}"')
match = [iface for iface in self._path_exports[msg.path] if iface.name == interface_name]
if not match:
if interface_name in [
'org.freedesktop.DBus.Properties', 'org.freedesktop.DBus.Introspectable',
'org.freedesktop.DBus.Peer', 'org.freedesktop.DBus.ObjectManager'
]:
# the standard interfaces do not have properties
if msg.member == 'Get' or msg.member == 'Set':
prop_name = msg.body[1]
raise DBusError(
ErrorType.UNKNOWN_PROPERTY,
f'interface "{interface_name}" does not have property "{prop_name}"')
elif msg.member == 'GetAll':
send_reply(Message.new_method_return(msg, 'a{sv}', [{}]))
return
else:
assert False
raise DBusError(
ErrorType.UNKNOWN_INTERFACE,
f'could not find an interface "{interface_name}" at path: "{msg.path}"')
interface = match[0]
properties = ServiceInterface._get_properties(interface)
if msg.member == 'Get' or msg.member == 'Set':
prop_name = msg.body[1]
match = [prop for prop in properties if prop.name == prop_name and not prop.disabled]
if not match:
raise DBusError(
ErrorType.UNKNOWN_PROPERTY,
f'interface "{interface_name}" does not have property "{prop_name}"')
prop = match[0]
if msg.member == 'Get':
if not prop.access.readable():
raise DBusError(ErrorType.UNKNOWN_PROPERTY,
'the property does not have read access')
def get_property_callback(interface, prop, prop_value, err):
try:
if err is not None:
send_reply.send_error(err)
return
body, unix_fds = replace_fds_with_idx(prop.signature, [prop_value])
send_reply(
Message.new_method_return(msg,
'v', [Variant(prop.signature, body[0])],
unix_fds=unix_fds))
except Exception as e:
send_reply.send_error(e)
ServiceInterface._get_property_value(interface, prop, get_property_callback)
elif msg.member == 'Set':
if not prop.access.writable():
raise DBusError(ErrorType.PROPERTY_READ_ONLY, 'the property is readonly')
value = msg.body[2]
if value.signature != prop.signature:
raise DBusError(ErrorType.INVALID_SIGNATURE,
f'wrong signature for property. expected "{prop.signature}"')
assert prop.prop_setter
def set_property_callback(interface, prop, err):
if err is not None:
send_reply.send_error(err)
return
send_reply(Message.new_method_return(msg))
body = replace_idx_with_fds(value.signature, [value.value], msg.unix_fds)
ServiceInterface._set_property_value(interface, prop, body[0],
set_property_callback)
elif msg.member == 'GetAll':
def get_all_properties_callback(interface, values, user_data, err):
if err is not None:
send_reply.send_error(err)
return
body, unix_fds = replace_fds_with_idx('a{sv}', [values])
send_reply(Message.new_method_return(msg, 'a{sv}', body, unix_fds=unix_fds))
ServiceInterface._get_all_property_values(interface, get_all_properties_callback)
else:
assert False
def _init_high_level_client(self):
'''The high level client is initialized when the first proxy object is
gotten. Currently just sets up the match rules for the name owner cache
so signals can be routed to the right objects.'''
if self._high_level_client_initialized:
return
self._high_level_client_initialized = True
def add_match_notify(msg, err):
if err:
logging.error(
f'add match request failed. match="{self._name_owner_match_rule}", {err}')
if msg.message_type == MessageType.ERROR:
logging.error(
f'add match request failed. match="{self._name_owner_match_rule}", {msg.body[0]}'
)
self._call(
Message(destination='org.freedesktop.DBus',
interface='org.freedesktop.DBus',
path='/org/freedesktop/DBus',
member='AddMatch',
signature='s',
body=[self._name_owner_match_rule]), add_match_notify)
def _add_match_rule(self, match_rule):
'''Add a match rule. Match rules added by this function are refcounted
and must be removed by _remove_match_rule(). This is for use in the
high level client only.'''
if match_rule == self._name_owner_match_rule:
return
if match_rule in self._match_rules:
self._match_rules[match_rule] += 1
return
self._match_rules[match_rule] = 1
def add_match_notify(msg, err):
if err:
logging.error(f'add match request failed. match="{match_rule}", {err}')
if msg.message_type == MessageType.ERROR:
logging.error(f'add match request failed. match="{match_rule}", {msg.body[0]}')
self._call(
Message(destination='org.freedesktop.DBus',
interface='org.freedesktop.DBus',
path='/org/freedesktop/DBus',
member='AddMatch',
signature='s',
body=[match_rule]), add_match_notify)
def _remove_match_rule(self, match_rule):
'''Remove a match rule added with _add_match_rule(). This is for use in
the high level client only.'''
if match_rule == self._name_owner_match_rule:
return
if match_rule in self._match_rules:
self._match_rules[match_rule] -= 1
if self._match_rules[match_rule] > 0:
return
del self._match_rules[match_rule]
def remove_match_notify(msg, err):
if self._disconnected:
return
if err:
logging.error(f'remove match request failed. match="{match_rule}", {err}')
if msg.message_type == MessageType.ERROR:
logging.error(f'remove match request failed. match="{match_rule}", {msg.body[0]}')
self._call(
Message(destination='org.freedesktop.DBus',
interface='org.freedesktop.DBus',
path='/org/freedesktop/DBus',
member='RemoveMatch',
signature='s',
body=[match_rule]), remove_match_notify)
|