diff options
Diffstat (limited to 'src/dbus/qdbusabstractinterface.cpp')
| -rw-r--r-- | src/dbus/qdbusabstractinterface.cpp | 333 |
1 files changed, 144 insertions, 189 deletions
diff --git a/src/dbus/qdbusabstractinterface.cpp b/src/dbus/qdbusabstractinterface.cpp index 148bd54147..0c6dbf1b3b 100644 --- a/src/dbus/qdbusabstractinterface.cpp +++ b/src/dbus/qdbusabstractinterface.cpp @@ -1,42 +1,6 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Copyright (C) 2016 Intel Corporation. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the QtDBus module of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// Copyright (C) 2016 Intel Corporation. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qdbusabstractinterface.h" #include "qdbusabstractinterface_p.h" @@ -58,6 +22,8 @@ QT_BEGIN_NAMESPACE +using namespace Qt::StringLiterals; + namespace { // ### Qt6: change to a regular QEvent (customEvent) // We need to use a QMetaCallEvent here because we can't override customEvent() in @@ -66,11 +32,11 @@ namespace { // of to QDBusAbstractInterface::customEvent. // See solution in Patch Set 1 of this change in the Qt Gerrit servers. // (https://codereview.qt-project.org/#/c/126384/1) -class DisconnectRelayEvent : public QMetaCallEvent +class DisconnectRelayEvent : public QAbstractMetaCallEvent { public: DisconnectRelayEvent(QObject *sender, const QMetaMethod &m) - : QMetaCallEvent(0, 0, nullptr, sender, m.methodIndex()) + : QAbstractMetaCallEvent(sender, m.methodIndex()) {} void placeMetaCall(QObject *object) override @@ -113,6 +79,7 @@ QDBusAbstractInterfacePrivate::QDBusAbstractInterfacePrivate(const QString &serv lastError(checkIfValid(serv, p, iface, isDynamic, (connectionPrivate() && connectionPrivate()->mode == QDBusConnectionPrivate::PeerMode))), timeout(-1), + interactiveAuthorizationAllowed(false), isValid(!lastError.isValid()) { if (!isValid) @@ -154,18 +121,17 @@ bool QDBusAbstractInterfacePrivate::property(const QMetaProperty &mp, void *retu if (!isValid || !canMakeCalls()) // can't make calls return false; - const int type = mp.userType(); + QMetaType type = mp.metaType(); // is this metatype registered? const char *expectedSignature = ""; - if (int(mp.type()) != QMetaType::QVariant) { + if (type.id() != QMetaType::QVariant) { expectedSignature = QDBusMetaType::typeToSignature(type); - if (expectedSignature == 0) { + if (expectedSignature == nullptr) { qWarning("QDBusAbstractInterface: type %s must be registered with Qt D-Bus before it can be " "used to read property %s.%s", mp.typeName(), qPrintable(interface), mp.name()); - lastError = QDBusError(QDBusError::Failed, - QString::fromLatin1("Unregistered type %1 cannot be handled") - .arg(QLatin1String(mp.typeName()))); + lastError = QDBusError(QDBusError::Failed, "Unregistered type %1 cannot be handled"_L1 + .arg(QLatin1StringView(mp.typeName()))); return false; } } @@ -182,53 +148,53 @@ bool QDBusAbstractInterfacePrivate::property(const QMetaProperty &mp, void *retu lastError = QDBusError(reply); return false; } - if (reply.signature() != QLatin1String("v")) { - QString errmsg = QLatin1String("Invalid signature `%1' in return from call to " - DBUS_INTERFACE_PROPERTIES); - lastError = QDBusError(QDBusError::InvalidSignature, qMove(errmsg).arg(reply.signature())); + if (reply.signature() != "v"_L1) { + QString errmsg = + "Invalid signature '%1' in return from call to " DBUS_INTERFACE_PROPERTIES ""_L1; + lastError = QDBusError(QDBusError::InvalidSignature, std::move(errmsg).arg(reply.signature())); return false; } QByteArray foundSignature; - const char *foundType = 0; + const char *foundType = nullptr; QVariant value = qvariant_cast<QDBusVariant>(reply.arguments().at(0)).variant(); - if (value.userType() == type || type == QMetaType::QVariant + if (value.metaType() == type || type.id() == QMetaType::QVariant || (expectedSignature[0] == 'v' && expectedSignature[1] == '\0')) { // simple match - if (type == QMetaType::QVariant) { + if (type.id() == QMetaType::QVariant) { *reinterpret_cast<QVariant*>(returnValuePtr) = value; } else { - QMetaType::destruct(type, returnValuePtr); - QMetaType::construct(type, returnValuePtr, value.constData()); + QMetaType(type).destruct(returnValuePtr); + QMetaType(type).construct(returnValuePtr, value.constData()); } return true; } - if (value.userType() == qMetaTypeId<QDBusArgument>()) { + if (value.metaType() == QMetaType::fromType<QDBusArgument>()) { QDBusArgument arg = qvariant_cast<QDBusArgument>(value); foundType = "user type"; foundSignature = arg.currentSignature().toLatin1(); if (foundSignature == expectedSignature) { // signatures match, we can demarshall - return QDBusMetaType::demarshall(arg, type, returnValuePtr); + return QDBusMetaType::demarshall(arg, QMetaType(type), returnValuePtr); } } else { foundType = value.typeName(); - foundSignature = QDBusMetaType::typeToSignature(value.userType()); + foundSignature = QDBusMetaType::typeToSignature(value.metaType()); } // there was an error... - QString errmsg = QLatin1String("Unexpected `%1' (%2) when retrieving property `%3.%4' " - "(expected type `%5' (%6))"); + const auto errmsg = "Unexpected '%1' (%2) when retrieving property '%3.%4' " + "(expected type '%5' (%6))"_L1; lastError = QDBusError(QDBusError::InvalidSignature, - errmsg.arg(QString::fromLatin1(foundType), - QString::fromLatin1(foundSignature), + errmsg.arg(QLatin1StringView(foundType), + QLatin1StringView(foundSignature), interface, - QString::fromUtf8(mp.name()), - QString::fromLatin1(mp.typeName()), - QString::fromLatin1(expectedSignature))); + QLatin1StringView(mp.name()), + QLatin1StringView(mp.typeName()), + QLatin1StringView(expectedSignature))); return false; } @@ -257,7 +223,6 @@ void QDBusAbstractInterfacePrivate::_q_serviceOwnerChanged(const QString &name, const QString &newOwner) { Q_UNUSED(oldOwner); - Q_UNUSED(name); //qDebug() << "QDBusAbstractInterfacePrivate serviceOwnerChanged" << name << oldOwner << newOwner; Q_ASSERT(name == service); currentOwner = newOwner; @@ -281,10 +246,10 @@ int QDBusAbstractInterfaceBase::qt_metacall(QMetaObject::Call _c, int _id, void if (_c == QMetaObject::WriteProperty) { QVariant value; - if (mp.userType() == qMetaTypeId<QDBusVariant>()) + if (mp.metaType() == QMetaType::fromType<QDBusVariant>()) value = reinterpret_cast<const QDBusVariant*>(_a[0])->variant(); else - value = QVariant(mp.userType(), _a[0]); + value = QVariant(mp.metaType(), _a[0]); status = d_func()->setProperty(mp, value) ? 1 : 0; } else { bool readStatus = d_func()->property(mp, _a[0]); @@ -433,6 +398,43 @@ int QDBusAbstractInterface::timeout() const } /*! + Configures whether, for asynchronous calls, the caller + is prepared to wait for interactive authorization. + + If \a enable is set to \c true, the D-Bus messages generated for + asynchronous calls via this interface will set the + \c ALLOW_INTERACTIVE_AUTHORIZATION flag. + + This flag is only useful when unprivileged code calls a more privileged + method call, and an authorization framework is deployed that allows + possibly interactive authorization. + + The default is \c false. + + \since 6.7 + \sa QDBusMessage::setInteractiveAuthorizationAllowed() +*/ +void QDBusAbstractInterface::setInteractiveAuthorizationAllowed(bool enable) +{ + d_func()->interactiveAuthorizationAllowed = enable; +} + +/*! + Returns whether, for asynchronous calls, the caller + is prepared to wait for interactive authorization. + + The default is \c false. + + \since 6.7 + \sa setInteractiveAuthorizationAllowed(), + QDBusMessage::setInteractiveAuthorizationAllowed() +*/ +bool QDBusAbstractInterface::isInteractiveAuthorizationAllowed() const +{ + return d_func()->interactiveAuthorizationAllowed; +} + +/*! Places a call to the remote method specified by \a method on this interface, using \a args as arguments. This function returns the message that was received as a reply, which can be a normal QDBusMessage::ReplyMessage (indicating success) or QDBusMessage::ErrorMessage (if the call @@ -460,7 +462,7 @@ QDBusMessage QDBusAbstractInterface::callWithArgumentList(QDBus::CallMode mode, QString m = method; // split out the signature from the method - int pos = method.indexOf(QLatin1Char('.')); + int pos = method.indexOf(u'.'); if (pos != -1) m.truncate(pos); @@ -511,6 +513,9 @@ QDBusMessage QDBusAbstractInterface::callWithArgumentList(QDBus::CallMode mode, Normally, you should place calls using asyncCall(). + \note Method calls to objects registered by the application itself are never + asynchronous due to implementation limitations. + \threadsafe */ QDBusPendingCall QDBusAbstractInterface::asyncCallWithArgumentList(const QString& method, @@ -524,6 +529,8 @@ QDBusPendingCall QDBusAbstractInterface::asyncCallWithArgumentList(const QString QDBusMessage msg = QDBusMessage::createMethodCall(service(), path(), interface(), method); QDBusMessagePrivate::setParametersValidated(msg, true); msg.setArguments(args); + if (d->interactiveAuthorizationAllowed) + msg.setInteractiveAuthorizationAllowed(true); return d->connection.asyncCall(msg, d->timeout); } @@ -545,6 +552,9 @@ QDBusPendingCall QDBusAbstractInterface::asyncCallWithArgumentList(const QString parameter as its last or only parameter. The \a errorMethod must have a QDBusError as its only parameter. + \note Method calls to objects registered by the application itself are never + asynchronous due to implementation limitations. + \since 4.3 \sa QDBusError, QDBusMessage */ @@ -597,7 +607,7 @@ bool QDBusAbstractInterface::callWithCallback(const QString &method, QObject *receiver, const char *slot) { - return callWithCallback(method, args, receiver, slot, 0); + return callWithCallback(method, args, receiver, slot, nullptr); } /*! @@ -691,18 +701,20 @@ void QDBusAbstractInterface::internalPropSet(const char *propname, const QVarian } /*! - Calls the method \a method on this interface and passes the parameters to this function to the - method. + \fn QDBusAbstractInterface::call(const QString &message) + \internal +*/ + +/*! + \fn template <typename...Args> QDBusMessage QDBusAbstractInterface::call(const QString &method, Args&&...args) + + Calls the method \a method on this interface and passes \a args to the method. + All \a args must be convertible to QVariant. The parameters to \c call are passed on to the remote function via D-Bus as input arguments. Output arguments are returned in the QDBusMessage reply. If the reply is an error reply, lastError() will also be set to the contents of the error message. - This function can be used with up to 8 parameters, passed in arguments \a arg1, \a arg2, - \a arg3, \a arg4, \a arg5, \a arg6, \a arg7 and \a arg8. If you need more than 8 - parameters or if you have a variable number of parameters to be passed, use - callWithArgumentList(). - It can be used the following way: \snippet code/src_qdbus_qdbusabstractinterface.cpp 0 @@ -710,99 +722,57 @@ void QDBusAbstractInterface::internalPropSet(const char *propname, const QVarian This example illustrates function calling with 0, 1 and 2 parameters and illustrates different parameter types passed in each (the first call to \c "ProcessWorkUnicode" will contain one Unicode string, the second call to \c "ProcessWork" will contain one string and one byte array). + See asyncCall() for the same example in non-blocking (asynchronous) calls. + + \note Before Qt 5.14, this function accepted a maximum of just eight (8) arguments. + + \sa callWithArgumentList() */ -QDBusMessage QDBusAbstractInterface::call(const QString &method, const QVariant &arg1, - const QVariant &arg2, - const QVariant &arg3, - const QVariant &arg4, - const QVariant &arg5, - const QVariant &arg6, - const QVariant &arg7, - const QVariant &arg8) -{ - return call(QDBus::AutoDetect, method, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8); -} /*! + \fn QDBusAbstractInterface::call(QDBus::CallMode mode, const QString &message) + \internal +*/ + +/*! + \fn template <typename...Args> QDBusMessage QDBusAbstractInterface::call(QDBus::CallMode mode, const QString &method, Args&&...args) + \overload - Calls the method \a method on this interface and passes the - parameters to this function to the method. If \a mode is \c - NoWaitForReply, then this function will return immediately after + Calls the method \a method on this interface and passes \a args to the method. + All \a args must be convertible to QVariant. + + If \a mode is \c NoWaitForReply, then this function will return immediately after placing the call, without waiting for a reply from the remote method. Otherwise, \a mode indicates whether this function should activate the Qt Event Loop while waiting for the reply to arrive. - This function can be used with up to 8 parameters, passed in arguments \a arg1, \a arg2, - \a arg3, \a arg4, \a arg5, \a arg6, \a arg7 and \a arg8. If you need more than 8 - parameters or if you have a variable number of parameters to be passed, use - callWithArgumentList(). - If this function reenters the Qt event loop in order to wait for the reply, it will exclude user input. During the wait, it may deliver signals and other method calls to your application. Therefore, it must be prepared to handle a reentrancy whenever a call is placed with call(). -*/ -QDBusMessage QDBusAbstractInterface::call(QDBus::CallMode mode, const QString &method, - const QVariant &arg1, - const QVariant &arg2, - const QVariant &arg3, - const QVariant &arg4, - const QVariant &arg5, - const QVariant &arg6, - const QVariant &arg7, - const QVariant &arg8) -{ - QList<QVariant> argList; - int count = 0 + arg1.isValid() + arg2.isValid() + arg3.isValid() + arg4.isValid() + - arg5.isValid() + arg6.isValid() + arg7.isValid() + arg8.isValid(); - - switch (count) { - case 8: - argList.prepend(arg8); - Q_FALLTHROUGH(); - case 7: - argList.prepend(arg7); - Q_FALLTHROUGH(); - case 6: - argList.prepend(arg6); - Q_FALLTHROUGH(); - case 5: - argList.prepend(arg5); - Q_FALLTHROUGH(); - case 4: - argList.prepend(arg4); - Q_FALLTHROUGH(); - case 3: - argList.prepend(arg3); - Q_FALLTHROUGH(); - case 2: - argList.prepend(arg2); - Q_FALLTHROUGH(); - case 1: - argList.prepend(arg1); - break; - } - return callWithArgumentList(mode, method, argList); -} + \note Before Qt 5.14, this function accepted a maximum of just eight (8) arguments. + \sa callWithArgumentList() +*/ /*! - \since 4.5 - Calls the method \a method on this interface and passes the parameters to this function to the - method. + \fn QDBusAbstractInterface::asyncCall(const QString &message) + \internal +*/ + +/*! + \fn template <typename...Args> QDBusPendingCall QDBusAbstractInterface::asyncCall(const QString &method, Args&&...args) + + Calls the method \a method on this interface and passes \a args to the method. + All \a args must be convertible to QVariant. The parameters to \c call are passed on to the remote function via D-Bus as input arguments. The returned QDBusPendingCall object can be used to find out information about the reply. - This function can be used with up to 8 parameters, passed in arguments \a arg1, \a arg2, - \a arg3, \a arg4, \a arg5, \a arg6, \a arg7 and \a arg8. If you need more than 8 - parameters or if you have a variable number of parameters to be passed, use - asyncCallWithArgumentList(). - It can be used the following way: \snippet code/src_qdbus_qdbusabstractinterface.cpp 1 @@ -810,49 +780,16 @@ QDBusMessage QDBusAbstractInterface::call(QDBus::CallMode mode, const QString &m This example illustrates function calling with 0, 1 and 2 parameters and illustrates different parameter types passed in each (the first call to \c "ProcessWorkUnicode" will contain one Unicode string, the second call to \c "ProcessWork" will contain one string and one byte array). + See call() for the same example in blocking (synchronous) calls. + + \note Before Qt 5.14, this function accepted a maximum of just eight (8) arguments. + + \note Method calls to local \c{QDBusServer}'s are never asynchronous + due to implementation limitations. + + \sa asyncCallWithArgumentList() */ -QDBusPendingCall QDBusAbstractInterface::asyncCall(const QString &method, const QVariant &arg1, - const QVariant &arg2, - const QVariant &arg3, - const QVariant &arg4, - const QVariant &arg5, - const QVariant &arg6, - const QVariant &arg7, - const QVariant &arg8) -{ - QList<QVariant> argList; - int count = 0 + arg1.isValid() + arg2.isValid() + arg3.isValid() + arg4.isValid() + - arg5.isValid() + arg6.isValid() + arg7.isValid() + arg8.isValid(); - - switch (count) { - case 8: - argList.prepend(arg8); - Q_FALLTHROUGH(); - case 7: - argList.prepend(arg7); - Q_FALLTHROUGH(); - case 6: - argList.prepend(arg6); - Q_FALLTHROUGH(); - case 5: - argList.prepend(arg5); - Q_FALLTHROUGH(); - case 4: - argList.prepend(arg4); - Q_FALLTHROUGH(); - case 3: - argList.prepend(arg3); - Q_FALLTHROUGH(); - case 2: - argList.prepend(arg2); - Q_FALLTHROUGH(); - case 1: - argList.prepend(arg1); - break; - } - return asyncCallWithArgumentList(method, argList); -} /*! \internal @@ -865,6 +802,24 @@ QDBusMessage QDBusAbstractInterface::internalConstCall(QDBus::CallMode mode, return const_cast<QDBusAbstractInterface*>(this)->callWithArgumentList(mode, method, args); } +QDBusMessage QDBusAbstractInterface::doCall(QDBus::CallMode mode, const QString &method, const QVariant *args, size_t numArgs) +{ + QList<QVariant> list; + list.reserve(int(numArgs)); + for (size_t i = 0; i < numArgs; ++i) + list.append(args[i]); + return callWithArgumentList(mode, method, list); +} + +QDBusPendingCall QDBusAbstractInterface::doAsyncCall(const QString &method, const QVariant *args, size_t numArgs) +{ + QList<QVariant> list; + list.reserve(int(numArgs)); + for (size_t i = 0; i < numArgs; ++i) + list.append(args[i]); + return asyncCallWithArgumentList(method, list); +} + QT_END_NAMESPACE #endif // QT_NO_DBUS |