Add routines to validate D-Bus signature in QtDBus

5 files changed, 379 insertions, 2 deletions

diff --git a/src/dbus/qdbusutil.cpp b/src/dbus/qdbusutil.cpp
index 844af9a..a4bd168 100644
--- a/src/dbus/qdbusutil.cpp
+++ b/src/dbus/qdbusutil.cpp
@@ -238,6 +238,68 @@ bool argToString(const QDBusArgument &busArg, QString &out)
     return true;
 }
 
+//------- D-Bus Types --------
+static const char oneLetterTypes[] = "vsogybnqiuxtdh";
+static const char basicTypes[] =      "sogybnqiuxtdh";
+static const char fixedTypes[] =         "ybnqiuxtdh";
+
+static bool isBasicType(int c)
+{
+    return c != DBUS_TYPE_INVALID && strchr(basicTypes, c) != NULL;
+}
+
+static bool isFixedType(int c)
+{
+    return c != DBUS_TYPE_INVALID && strchr(fixedTypes, c) != NULL;
+}
+
+// Returns a pointer to one-past-end of this type if it's valid;
+// returns NULL if it isn't valid.
+static const char *validateSingleType(const char *signature)
+{
+    register char c = *signature;
+    if (c == DBUS_TYPE_INVALID)
+        return false;
+
+    // is it one of the one-letter types?
+    if (strchr(oneLetterTypes, c) != NULL)
+        return signature + 1;
+
+    // is it an array?
+    if (c == DBUS_TYPE_ARRAY) {
+        // then it's valid if the next type is valid
+        // or if it's a dict-entry
+        c = *++signature;
+        if (c == DBUS_DICT_ENTRY_BEGIN_CHAR) {
+            // beginning of a dictionary entry
+            // a dictionary entry has a key which is of basic types
+            // and a free value
+            c = *++signature;
+            if (!isBasicType(c))
+                return 0;
+            signature = validateSingleType(signature + 1);
+            return signature && *signature == DBUS_DICT_ENTRY_END_CHAR ? signature + 1 : 0;
+        }
+
+        return validateSingleType(signature);
+    }
+
+    if (c == DBUS_STRUCT_BEGIN_CHAR) {
+        // beginning of a struct
+        ++signature;
+        while (true) {
+            signature = validateSingleType(signature);
+            if (!signature)
+                return 0;
+            if (*signature == DBUS_STRUCT_END_CHAR)
+                return signature + 1;
+        }
+    }
+
+    // invalid/unknown type
+    return 0;
+}
+
 /*!
     \namespace QDBusUtil
     \inmodule QtDBus
@@ -447,6 +509,25 @@ namespace QDBusUtil
     }
 
     /*!
+        \fn bool QDBusUtil::isValidBasicType(int type)
+        Returns true if \a c is a valid, basic D-Bus type.
+     */
+    bool isValidBasicType(int c)
+    {
+        return isBasicType(c);
+    }
+
+    /*!
+        \fn bool QDBusUtil::isValidFixedType(int type)
+        Returns true if \a c is a valid, fixed D-Bus type.
+     */
+    bool isValidFixedType(int c)
+    {
+        return isFixedType(c);
+    }
+
+
+    /*!
         \fn bool QDBusUtil::isValidSignature(const QString &signature)
         Returns true if \a signature is a valid D-Bus type signature for one or more types.
         This function returns true if it can all of \a signature into valid, individual types and no
@@ -456,7 +537,15 @@ namespace QDBusUtil
     */
     bool isValidSignature(const QString &signature)
     {
-        return q_dbus_signature_validate(signature.toUtf8(), 0);
+        QByteArray ba = signature.toLatin1();
+        const char *data = ba.constData();
+        while (true) {
+            data = validateSingleType(data);
+            if (!data)
+                return false;
+            if (*data == '\0')
+                return true;
+        }
     }
 
     /*!
@@ -467,7 +556,9 @@ namespace QDBusUtil
     */
     bool isValidSingleSignature(const QString &signature)
     {
-        return q_dbus_signature_validate_single(signature.toUtf8(), 0);
+        QByteArray ba = signature.toLatin1();
+        const char *data = validateSingleType(ba.constData());
+        return data && *data == '\0';
     }
 
 } // namespace QDBusUtil
diff --git a/src/dbus/qdbusutil_p.h b/src/dbus/qdbusutil_p.h
index 3721e98..24b5cea 100644
--- a/src/dbus/qdbusutil_p.h
+++ b/src/dbus/qdbusutil_p.h
@@ -81,6 +81,10 @@ namespace QDBusUtil
 
     Q_DBUS_EXPORT bool isValidObjectPath(const QString &path);
 
+    Q_DBUS_EXPORT bool isValidFixedType(int c);
+
+    Q_DBUS_EXPORT bool isValidBasicType(int c);
+
     Q_DBUS_EXPORT bool isValidSignature(const QString &signature);
 
     Q_DBUS_EXPORT bool isValidSingleSignature(const QString &signature);
diff --git a/tests/auto/dbus.pro b/tests/auto/dbus.pro
index e5f87e3..fe21475 100644
--- a/tests/auto/dbus.pro
+++ b/tests/auto/dbus.pro
@@ -14,6 +14,7 @@ SUBDIRS=\
            qdbusperformance \
            qdbusreply \
            qdbusservicewatcher \
+           qdbustype \
            qdbusthreading \
            qdbusxmlparser \
 
diff --git a/tests/auto/qdbustype/qdbustype.pro b/tests/auto/qdbustype/qdbustype.pro
new file mode 100644
index 0000000..e2f0c90
--- /dev/null
+++ b/tests/auto/qdbustype/qdbustype.pro
@@ -0,0 +1,10 @@
+load(qttest_p4)
+QT = core
+contains(QT_CONFIG,dbus): {
+        SOURCES += tst_qdbustype.cpp
+        QT += dbus
+        QMAKE_CXXFLAGS += $$QT_CFLAGS_DBUS
+        LIBS_PRIVATE += $$QT_LIBS_DBUS
+} else {
+        SOURCES += ../qdbusmarshall/dummy.cpp
+}
diff --git a/tests/auto/qdbustype/tst_qdbustype.cpp b/tests/auto/qdbustype/tst_qdbustype.cpp
new file mode 100644
index 0000000..0469719
--- /dev/null
+++ b/tests/auto/qdbustype/tst_qdbustype.cpp
@@ -0,0 +1,271 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the FOO module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QtTest/QtTest>
+#include <QtCore/QCoreApplication>
+
+#include <QtDBus/private/qdbusutil_p.h>
+
+#include <dbus/dbus.h>
+
+class tst_QDBusType : public QObject
+{
+    Q_OBJECT
+
+private Q_SLOTS:
+    void isValidFixedType_data();
+    void isValidFixedType();
+    void isValidBasicType_data();
+    void isValidBasicType();
+    void isValidSingleSignature_data();
+    void isValidSingleSignature();
+    void isValidArray_data();
+    void isValidArray();
+    void isValidSignature_data();
+    void isValidSignature();
+};
+
+enum { Invalid = false, Valid = true };
+
+static void addColumns()
+{
+    // All tests use these two columns only
+    QTest::addColumn<QString>("data");
+    QTest::addColumn<bool>("result");
+    QTest::addColumn<bool>("isValid");
+}
+
+// ---- type adds ---
+static void addFixedTypes()
+{
+    QTest::newRow("bool") << DBUS_TYPE_BOOLEAN_AS_STRING << true << true;
+    QTest::newRow("byte") << DBUS_TYPE_BYTE_AS_STRING << true << true;
+    QTest::newRow("int16") << DBUS_TYPE_INT16_AS_STRING << true << true;
+    QTest::newRow("uint16") << DBUS_TYPE_UINT16_AS_STRING << true << true;
+    QTest::newRow("int32") << DBUS_TYPE_INT32_AS_STRING << true << true;
+    QTest::newRow("uint32") << DBUS_TYPE_UINT32_AS_STRING << true << true;
+    QTest::newRow("int64") << DBUS_TYPE_INT64_AS_STRING << true << true;
+    QTest::newRow("uint64") << DBUS_TYPE_UINT64_AS_STRING << true << true;
+    QTest::newRow("double") << DBUS_TYPE_DOUBLE_AS_STRING << true << true;
+    QTest::newRow("unixfd") << "h" << true << true;
+}
+
+static void addInvalidSingleLetterTypes()
+{
+    QChar nulString[] = { 0 };
+    QTest::newRow("nul") << QString(nulString, 1) << false << false;
+    QTest::newRow("tilde") << "~" << false << false;
+    QTest::newRow("struct-begin") << "(" << false << false;
+    QTest::newRow("struct-end") << ")" << false << false;
+    QTest::newRow("dict-entry-begin") << "{" << false << false;
+    QTest::newRow("dict-entry-end") << "}" << false << false;
+    QTest::newRow("array-no-element") << "a" << false << false;
+}
+
+static void addBasicTypes(bool basicsAreValid)
+{
+    addFixedTypes();
+    QTest::newRow("string") << DBUS_TYPE_STRING_AS_STRING << basicsAreValid << true;
+    QTest::newRow("object-path") << DBUS_TYPE_OBJECT_PATH_AS_STRING << basicsAreValid << true;
+    QTest::newRow("signature") << DBUS_TYPE_SIGNATURE_AS_STRING << basicsAreValid << true;
+}
+
+static void addVariant(bool variantIsValid)
+{
+    QTest::newRow("variant") << "v" << variantIsValid << true;
+}
+
+static void addSingleSignatures()
+{
+    addBasicTypes(Valid);
+    addVariant(Valid);
+    QTest::newRow("struct-1") << "(y)" << true;
+    QTest::newRow("struct-2") << "(yy)" << true;
+    QTest::newRow("struct-3") << "(yyv)" << true;
+
+    QTest::newRow("struct-nested-1") << "((y))" << true;
+    QTest::newRow("struct-nested-2") << "((yy))" << true;
+    QTest::newRow("struct-nested-3") << "(y(y))" << true;
+    QTest::newRow("struct-nested-4") << "((y)y)" << true;
+    QTest::newRow("struct-nested-5") << "(y(y)y)" << true;
+    QTest::newRow("struct-nested-6") << "((y)(y))" << true;
+
+    QTest::newRow("array-1") << "as" << true;
+    QTest::newRow("struct-array-1") << "(as)" << true;
+    QTest::newRow("struct-array-2") << "(yas)" << true;
+    QTest::newRow("struct-array-3") << "(asy)" << true;
+    QTest::newRow("struct-array-4") << "(yasy)" << true;
+
+    QTest::newRow("dict-1") << "a{sy}" << true;
+    QTest::newRow("dict-2") << "a{sv}" << true;
+    QTest::newRow("dict-struct-1") << "a{s(y)}" << true;
+    QTest::newRow("dict-struct-2") << "a{s(yyyy)}" << true;
+    QTest::newRow("dict-struct-array") << "a{s(ay)}" << true;
+    QTest::newRow("dict-array") << "a{sas}" << true;
+    QTest::newRow("dict-array-struct") << "a{sa(y)}" << true;
+
+    addInvalidSingleLetterTypes();
+    QTest::newRow("naked-dict-empty") << "{}" << false;
+    QTest::newRow("naked-dict-missing-value") << "{i}" << false;
+
+    QTest::newRow("dict-empty") << "a{}" << false;
+    QTest::newRow("dict-missing-value") << "a{i}" << false;
+    QTest::newRow("dict-non-basic-key") << "a{vi}" << false;
+    QTest::newRow("dict-struct-key") << "a{(y)y}" << false;
+    QTest::newRow("dict-missing-close") << "a{sv" << false;
+    QTest::newRow("dict-mismatched-close") << "a{sv)" << false;
+    QTest::newRow("dict-missing-value-close") << "a{s" << false;
+
+    QTest::newRow("empty-struct") << "()" << false;
+    QTest::newRow("struct-missing-close") << "(s" << false;
+    QTest::newRow("struct-nested-missing-close-1") << "((s)" << false;
+    QTest::newRow("struct-nested-missing-close-2") << "((s" << false;
+
+    QTest::newRow("struct-ending-array-no-element") << "(a)" << false;
+}
+
+static void addNakedDictEntry()
+{
+    QTest::newRow("naked-dict-entry") << "{sv}" << false;
+}
+
+// ---- tests ----
+
+void tst_QDBusType::isValidFixedType_data()
+{
+    addColumns();
+    addFixedTypes();
+    addBasicTypes(Invalid);
+    addVariant(Invalid);
+    addInvalidSingleLetterTypes();
+}
+
+void tst_QDBusType::isValidFixedType()
+{
+    QFETCH(QString, data);
+    QFETCH(bool, result);
+    QFETCH(bool, isValid);
+    Q_ASSERT_X(data.length() == 1, "tst_QDBusType", "Test is malformed, this function must test only one-letter types");
+    Q_ASSERT(isValid || (!isValid && !result));
+
+    int type = data.at(0).unicode();
+    if (isValid)
+        QCOMPARE(bool(dbus_type_is_fixed(type)), result);
+    QCOMPARE(QDBusUtil::isValidFixedType(type), result);
+}
+
+void tst_QDBusType::isValidBasicType_data()
+{
+    addColumns();
+    addBasicTypes(Valid);
+    addVariant(Invalid);
+    addInvalidSingleLetterTypes();
+}
+
+void tst_QDBusType::isValidBasicType()
+{
+    QFETCH(QString, data);
+    QFETCH(bool, result);
+    QFETCH(bool, isValid);
+    Q_ASSERT_X(data.length() == 1, "tst_QDBusType", "Test is malformed, this function must test only one-letter types");
+    Q_ASSERT(isValid || (!isValid && !result));
+
+    int type = data.at(0).unicode();
+    if (isValid)
+        QCOMPARE(bool(dbus_type_is_basic(type)), result);
+    QCOMPARE(QDBusUtil::isValidBasicType(type), result);
+}
+
+void tst_QDBusType::isValidSingleSignature_data()
+{
+    addColumns();
+    addSingleSignatures();
+    addNakedDictEntry();
+}
+
+void tst_QDBusType::isValidSingleSignature()
+{
+    QFETCH(QString, data);
+    QFETCH(bool, result);
+
+    QCOMPARE(bool(dbus_signature_validate_single(data.toLatin1(), 0)), result);
+    QCOMPARE(QDBusUtil::isValidSingleSignature(data), result);
+}
+
+void tst_QDBusType::isValidArray_data()
+{
+    addColumns();
+    addSingleSignatures();
+}
+
+void tst_QDBusType::isValidArray()
+{
+    QFETCH(QString, data);
+    QFETCH(bool, result);
+
+    data.prepend("a");
+    QCOMPARE(bool(dbus_signature_validate_single(data.toLatin1(), 0)), result);
+    QCOMPARE(QDBusUtil::isValidSingleSignature(data), result);
+
+    data.prepend("a");
+    QCOMPARE(bool(dbus_signature_validate_single(data.toLatin1(), 0)), result);
+    QCOMPARE(QDBusUtil::isValidSingleSignature(data), result);
+}
+
+void tst_QDBusType::isValidSignature_data()
+{
+    isValidSingleSignature_data();
+}
+
+void tst_QDBusType::isValidSignature()
+{
+    QFETCH(QString, data);
+    QFETCH(bool, result);
+
+    data.append(data);
+    if (data.at(0).unicode())
+        QCOMPARE(bool(dbus_signature_validate(data.toLatin1(), 0)), result);
+    QCOMPARE(QDBusUtil::isValidSignature(data), result);
+}
+
+QTEST_MAIN(tst_QDBusType)
+
+#include "tst_qdbustype.moc"