/* -*- mode: C++ -*- * * Copyright (C) 2006 Trolltech AS. All rights reserved. * Author: Thiago Macieira * * Licensed under the Academic Free License version 2.1 * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * 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. * */ #include "qdbusconnection_p.h" #include #include #include #include #include "qdbusabstractadaptor.h" #include "qdbusabstractadaptor_p.h" #include "qdbusinterface_p.h" // for ANNOTATION_NO_WAIT #include "qdbusmessage.h" #include "qdbusutil.h" static const char introspectableInterfaceXml[] = " \n" " \n" " \n" " \n" " \n"; static const char propertiesInterfaceXml[] = " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n"; // implement the D-Bus org.freedesktop.DBus.Introspectable interface // we do that by analysing the metaObject of all the adaptor interfaces static QString generateInterfaceXml(const QMetaObject *mo, int flags, int methodOffset, int propOffset) { QString retval; // start with properties: if (flags & QDBusConnection::ExportProperties) { for (int i = propOffset; i < mo->propertyCount(); ++i) { static const char *accessvalues[] = {0, "read", "write", "readwrite"}; QMetaProperty mp = mo->property(i); if (!mp.isScriptable() && (flags & QDBusConnection::ExportAllProperties) != QDBusConnection::ExportAllProperties) continue; int access = 0; if (mp.isReadable()) access |= 1; if (mp.isWritable()) access |= 2; int typeId = qDBusNameToTypeId(mp.typeName()); if (!typeId) continue; retval += QString(QLatin1String(" \n")) .arg(mp.name()) .arg(QLatin1String( QDBusUtil::typeToSignature( QVariant::Type(typeId) ))) .arg(QLatin1String( accessvalues[access] )); } } // now add methods: for (int i = methodOffset; i < mo->methodCount(); ++i) { QMetaMethod mm = mo->method(i); QByteArray signature = mm.signature(); int paren = signature.indexOf('('); bool isSignal; if (mm.methodType() == QMetaMethod::Signal) // adding a signal isSignal = true; else if (mm.methodType() == QMetaMethod::Slot && mm.access() == QMetaMethod::Public) isSignal = false; else continue; // neither signal nor public slot if ((isSignal && !(flags & QDBusConnection::ExportSignals)) || (!isSignal && !(flags & QDBusConnection::ExportSlots))) continue; QString xml = QString(QLatin1String(" <%1 name=\"%2\">\n")) .arg(isSignal ? QLatin1String("signal") : QLatin1String("method")) .arg(QLatin1String(signature.left(paren))); // check the return type first int typeId = qDBusNameToTypeId(mm.typeName()); if (typeId) xml += QString(QLatin1String(" \n")) .arg(QLatin1String(QDBusUtil::typeToSignature( QVariant::Type(typeId) ))); else if (*mm.typeName()) continue; // wasn't a valid type QList names = mm.parameterNames(); QList types; int inputCount = qDBusParametersForMethod(mm, types); if (inputCount == -1) continue; // invalid form if (isSignal && inputCount + 1 != types.count()) continue; // signal with output arguments? if (isSignal && types.at(inputCount) == QDBusConnectionPrivate::messageMetaType) continue; // signal with QDBusMessage argument? int j; bool isScriptable = mm.attributes() & QMetaMethod::Scriptable; for (j = 1; j < types.count(); ++j) { // input parameter for a slot or output for a signal if (types.at(j) == QDBusConnectionPrivate::messageMetaType) { isScriptable = true; continue; } QString name; if (!names.at(j - 1).isEmpty()) name = QString(QLatin1String("name=\"%1\" ")).arg(QLatin1String(names.at(j - 1))); bool isOutput = isSignal || j > inputCount; xml += QString(QLatin1String(" \n")) .arg(name) .arg(QLatin1String(QDBusUtil::typeToSignature( QVariant::Type(types.at(j)) ))) .arg(isOutput ? QLatin1String("out") : QLatin1String("in")); } if (!isScriptable) { // check if this was added by other means if (isSignal && (flags & QDBusConnection::ExportAllSignals) != QDBusConnection::ExportAllSignals) continue; if (!isSignal && (flags & QDBusConnection::ExportAllSlots) != QDBusConnection::ExportAllSlots) continue; } if (qDBusCheckAsyncTag(mm.tag())) // add the no-reply annotation xml += QLatin1String(" \n"); retval += xml; retval += QString(QLatin1String(" \n")) .arg(isSignal ? QLatin1String("signal") : QLatin1String("method")); } return retval; } static QString generateMetaObjectXml(QString interface, const QMetaObject *mo, const QMetaObject *base, int flags) { if (interface.isEmpty()) { // generate the interface name from the meta object int idx = mo->indexOfClassInfo(QCLASSINFO_DBUS_INTERFACE); if (idx >= mo->classInfoOffset()) { interface = QLatin1String(mo->classInfo(idx).value()); } else { interface = QLatin1String(mo->className()); interface.replace(QLatin1String("::"), QLatin1String(".")); if (interface.startsWith( QLatin1String("QDBus") )) { interface.prepend( QLatin1String("com.trolltech.QtDBus.") ); } else if (interface.startsWith( QLatin1Char('Q') )) { // assume it's Qt interface.prepend( QLatin1String("com.trolltech.Qt.") ); } else if (!QCoreApplication::instance() || QCoreApplication::instance()->applicationName().isEmpty()) { interface.prepend( QLatin1String("local.") ); } else { interface.prepend(QLatin1Char('.')).prepend( QCoreApplication::instance()->applicationName() ); QStringList domainName = QCoreApplication::instance()->organizationDomain().split(QLatin1Char('.')); foreach (const QString &part, domainName) interface.prepend(QLatin1Char('.')).prepend(part); } } } QString xml; int idx = mo->indexOfClassInfo(QCLASSINFO_DBUS_INTROSPECTION); if (idx >= mo->classInfoOffset()) xml = QString::fromUtf8(mo->classInfo(idx).value()); else xml = generateInterfaceXml(mo, flags, base->methodCount(), base->propertyCount()); return QString(QLatin1String(" \n%2 \n")) .arg(interface, xml); } static QString generateSubObjectXml(QObject *object) { QString retval; foreach (QObject *child, object->children()) { QString name = child->objectName(); if (!name.isEmpty()) retval += QString(QLatin1String(" \n")) .arg(name); } return retval; } QString qDBusIntrospectObject(const QDBusConnectionPrivate::ObjectTreeNode *node) { // object may be null QString xml_data(QLatin1String(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE)); xml_data += QLatin1String("\n"); if (node->obj) { if (node->flags & QDBusConnection::ExportContents) { const QMetaObject *mo = node->obj->metaObject(); for ( ; mo != &QObject::staticMetaObject; mo = mo->superClass()) xml_data += generateMetaObjectXml(QString(), mo, mo->superClass(), node->flags); } // does this object have adaptors? QDBusAdaptorConnector *connector; if (node->flags & QDBusConnection::ExportAdaptors && (connector = qDBusFindAdaptorConnector(node->obj))) { // trasverse every adaptor in this object QDBusAdaptorConnector::AdaptorMap::ConstIterator it = connector->adaptors.constBegin(); QDBusAdaptorConnector::AdaptorMap::ConstIterator end = connector->adaptors.constEnd(); for ( ; it != end; ++it) { // add the interface: QString ifaceXml = QDBusAbstractAdaptorPrivate::retrieveIntrospectionXml(it->adaptor); if (ifaceXml.isEmpty()) { // add the interface's contents: ifaceXml += generateMetaObjectXml(it->interface, it->metaObject, &QDBusAbstractAdaptor::staticMetaObject, QDBusConnection::ExportAllContents); QDBusAbstractAdaptorPrivate::saveIntrospectionXml(it->adaptor, ifaceXml); } xml_data += ifaceXml; } } xml_data += QLatin1String( introspectableInterfaceXml ); xml_data += QLatin1String( propertiesInterfaceXml ); } if (node->flags & QDBusConnection::ExportChildObjects) { xml_data += generateSubObjectXml(node->obj); } else { // generate from the object tree foreach (const QDBusConnectionPrivate::ObjectTreeNode::Data &entry, node->children) { if (entry.node && (entry.node->obj || !entry.node->children.isEmpty())) xml_data += QString(QLatin1String(" \n")) .arg(entry.name); } } xml_data += QLatin1String("\n"); return xml_data; } void qDBusIntrospectObject(const QDBusConnectionPrivate::ObjectTreeNode *node, const QDBusMessage &msg) { // now send it QDBusMessage reply = QDBusMessage::methodReply(msg); reply << qDBusIntrospectObject(node); msg.connection().send(reply); } // implement the D-Bus interface org.freedesktop.DBus.Properties static void sendPropertyError(const QDBusMessage &msg, const QString &interface_name) { QDBusMessage error = QDBusMessage::error(msg, QLatin1String(DBUS_ERROR_INVALID_ARGS), QString::fromLatin1("Interface %1 was not found in object %2") .arg(interface_name) .arg(msg.path())); msg.connection().send(error); } void qDBusPropertyGet(const QDBusConnectionPrivate::ObjectTreeNode *node, const QDBusMessage &msg) { Q_ASSERT(msg.count() == 2); QString interface_name = msg.at(0).toString(); QByteArray property_name = msg.at(1).toString().toUtf8(); QDBusAdaptorConnector *connector; QVariant value; if (node->flags & QDBusConnection::ExportAdaptors && (connector = qDBusFindAdaptorConnector(node->obj))) { // find the class that implements interface_name QDBusAdaptorConnector::AdaptorMap::ConstIterator it; it = qLowerBound(connector->adaptors.constBegin(), connector->adaptors.constEnd(), interface_name); if (it != connector->adaptors.end() && it->interface == interface_name) value = it->adaptor->property(property_name); } if (!value.isValid() && node->flags & QDBusConnection::ExportProperties) { // try the object itself int pidx = node->obj->metaObject()->indexOfProperty(property_name); if (pidx != -1) { QMetaProperty mp = node->obj->metaObject()->property(pidx); if (mp.isScriptable() || (node->flags & QDBusConnection::ExportAllProperties) == QDBusConnection::ExportAllProperties) value = mp.read(node->obj); } } if (!value.isValid()) { // the property was not found sendPropertyError(msg, interface_name); return; } QDBusMessage reply = QDBusMessage::methodReply(msg); reply.setSignature(QLatin1String("v")); reply << value; msg.connection().send(reply); } void qDBusPropertySet(const QDBusConnectionPrivate::ObjectTreeNode *node, const QDBusMessage &msg) { Q_ASSERT(msg.count() == 3); QString interface_name = msg.at(0).toString(); QByteArray property_name = msg.at(1).toString().toUtf8(); QVariant value = QDBusTypeHelper::fromVariant(msg.at(2)); QDBusAdaptorConnector *connector; if (node->flags & QDBusConnection::ExportAdaptors && (connector = qDBusFindAdaptorConnector(node->obj))) { // find the class that implements interface_name QDBusAdaptorConnector::AdaptorMap::ConstIterator it; it = qLowerBound(connector->adaptors.constBegin(), connector->adaptors.constEnd(), interface_name); if (it != connector->adaptors.end() && it->interface == interface_name) if (it->adaptor->setProperty(property_name, value)) { msg.connection().send(QDBusMessage::methodReply(msg)); return; } } if (node->flags & QDBusConnection::ExportProperties) { // try the object itself int pidx = node->obj->metaObject()->indexOfProperty(property_name); if (pidx != -1) { QMetaProperty mp = node->obj->metaObject()->property(pidx); if (mp.isScriptable() || (node->flags & QDBusConnection::ExportAllProperties) == QDBusConnection::ExportAllProperties) { if (mp.write(node->obj, value)) { msg.connection().send(QDBusMessage::methodReply(msg)); return; } } } } // the property was not found or not written to sendPropertyError(msg, interface_name); }