summaryrefslogtreecommitdiff
path: root/mpris2/interfacetest.cpp
blob: 11fdd841ad15a24b65d629c40e897cf9b132d813 (plain)
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
/*
    <one line to give the program's name and a brief idea of what it does.>
    Copyright (C) 2011  Alex Merry <dev@randomguy3.me.uk>

    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.
*/

#define MPRIS2_PATH "/org/mpris/MediaPlayer2"
#define DBUS_PROPS_IFACE "org.freedesktop.DBus.Properties"

#include "interfacetest.h"

#include <QtDBus>
#include <QDebug>
#include <QTimer>

using namespace Mpris2;

InterfaceTest::InterfaceTest ( const QString& interface, const QString& service, QObject* parent ) : QObject(parent)
{
    iface = new QDBusInterface(service, MPRIS2_PATH, interface, QDBusConnection::sessionBus(), this);
    propsIface = new QDBusInterface(service, MPRIS2_PATH, DBUS_PROPS_IFACE, QDBusConnection::sessionBus(), this);
    delayedCheckTimer = new QTimer(this);
    delayedCheckTimer->setInterval(2000);
    connect(delayedCheckTimer, SIGNAL(timeout()),
            this, SLOT(delayedIncrementalCheck()));
}

InterfaceTest::~InterfaceTest()
{
}

void InterfaceTest::connectSignals()
{
}

QVariantMap InterfaceTest::properties() const
{
    return props;
}

bool InterfaceTest::getAllProps()
{
    if (!propsIface->isValid() || !iface->isValid()) {
        emit interfaceError(Other, "",
                            "No object with the "
                            + iface->interface() +
                            " and "
                            DBUS_PROPS_IFACE
                            " interfaces was not found at "
                            MPRIS2_PATH);
        return false;
    }

    QDBusReply<QVariantMap> propsReply = propsIface->call("GetAll", iface->interface());
    if (!propsReply.isValid()) {
        emit interfaceError(Other, "",
                            "The " DBUS_PROPS_IFACE
                            " interface was not implemented correctly at "
                            MPRIS2_PATH);
        return false;
    }
    props = propsReply.value();

    return true;
}

bool InterfaceTest::getProp(const QString& propName)
{
    if (!propsIface->isValid() || !iface->isValid()) {
        emit interfaceError(Other, "",
                            "No object with the "
                            + iface->interface() +
                            " and "
                            DBUS_PROPS_IFACE
                            " interfaces was not found at "
                            MPRIS2_PATH);
        return false;
    }

    QDBusReply<QVariant> propsReply = propsIface->call("Get", iface->interface(), propName);
    if (!propsReply.isValid()) {
        if (propsReply.error().type() == QDBusError::UnknownInterface) {
            emit interfaceError(Other, "",
                                "The " DBUS_PROPS_IFACE
                                " interface was not implemented correctly at "
                                MPRIS2_PATH "(replied \"unknown interface\")");
        } else if (propsReply.error().type() == QDBusError::UnknownMethod) {
            emit interfaceError(Other, "",
                                "The " DBUS_PROPS_IFACE
                                " interface was not implemented correctly at "
                                MPRIS2_PATH "(replied \"unknown method\" for method \"Get\")");
        } else if (propsReply.error().type() == QDBusError::InvalidArgs) {
            emit interfaceError(Property, propName,
                                DBUS_PROPS_IFACE ".Get failed; reported \"invalid args\" (ie: unknown property)");
        } else if (propsReply.error().name() == "org.freedesktop.DBus.UnknownProperty") {
            emit interfaceError(Property, propName,
                                DBUS_PROPS_IFACE ".Get failed; reported \"unknown property\"");
        } else {
            emit interfaceError(Other, "",
                                "Calling " DBUS_PROPS_IFACE
                                ".Get resulted in the error " + propsReply.error().name());
        }
        return false;
    }
    props[propName] = propsReply.value();

    return true;
}

bool InterfaceTest::checkPropValid(const QString& propName, QVariant::Type expType, const QVariantMap& oldProps) {
    if (!props.contains(propName)) {
        emit interfaceError(Property, propName, "Property " + propName + " is missing");
        return false;
    } else if (props[propName].type() != expType) {
        // FIXME: generate D-Bus type description
        const char * gotTypeCh = QDBusMetaType::typeToSignature(props[propName].userType());
        QString gotType = gotTypeCh ? QString::fromAscii(gotTypeCh) : "<unknown>";
        const char * expTypeCh = QDBusMetaType::typeToSignature(expType);
        QString expType = expTypeCh ? QString::fromAscii(expTypeCh) : "<unknown>";

        emit interfaceError(Property, propName, "Property " + propName + " has type '" + gotType + "', but should be type '" + expType + "'");
        return false;
    } else if (oldProps.contains(propName)) {
        // FIXME: QVariant equality only works for builtin types
        if (props[propName].type() < QVariant::UserType) {
            if (props[propName] != oldProps[propName]) {
                outOfDateProperties.insert(propName, props[propName]);
                props[propName] = oldProps[propName];
                // don't check right now
                return false;
            }
        } else {
            qDebug() << "Could not check equality for" << propName;
        }
    }
    return true;
}

bool InterfaceTest::checkNonEmptyStringPropValid(const QString& propName, const QVariantMap& oldProps) {
    if (checkPropValid(propName, QVariant::String, oldProps)) {
        if (props[propName].toString().isEmpty()) {
            emit interfaceError(Property, propName, "Property " + propName + " is present, but empty");
        } else {
            return true;
        }
    }
    return false;
}

void InterfaceTest::initialTest()
{
    if (!getAllProps())
        return;

    checkProps();

    QDBusConnection::sessionBus().connect(
            iface->service(),
            iface->path(),
            DBUS_PROPS_IFACE,
            "PropertiesChanged", /* signature, */
            this,
            SLOT( _m_propertiesChanged(QString,QVariantMap,QStringList,QDBusMessage)));
    connectSignals();

    emit propertiesChanged(properties().keys());
}

void InterfaceTest::incrementalTest()
{
    QVariantMap oldProps = props;

    if (!getAllProps())
        return;

    checkProps(oldProps);

    if (!delayedCheckTimer->isActive())
        delayedCheckTimer->start();
}

void InterfaceTest::_m_propertiesChanged(const QString& interface,
                                         const QVariantMap& changedProperties,
                                         const QStringList& invalidatedProperties,
                                         const QDBusMessage& signalMessage)
{
    Q_UNUSED(interface)
    Q_UNUSED(signalMessage)

    QStringList changedPropsList = invalidatedProperties;
    QVariantMap::const_iterator i = changedProperties.constBegin();
    while (i != changedProperties.constEnd()) {
        props[i.key()] = i.value();
        checkUpdatedProperty(i.key());
        outOfDateProperties.remove(i.key());
        changedPropsList << i.key();
        ++i;
    }
    QStringList::const_iterator j = invalidatedProperties.constBegin();
    while (j != invalidatedProperties.constEnd()) {
        if (getProp(*j))
            checkUpdatedProperty(*j);
        outOfDateProperties.remove(*j);
        ++j;
    }
    checkConsistency();

    emit propertiesChanged(changedPropsList);
}

void InterfaceTest::delayedIncrementalCheck()
{
    QVariantMap::const_iterator i = outOfDateProperties.constBegin();
    while (i != outOfDateProperties.constEnd()) {
        int warningsSoFar = propertyUpdateWarningCount.value(i.key());
        if (warningsSoFar < 4) {
            emit interfaceWarning(Property, i.key(), "Property was not updated via PropertiesChanged signal");
        } else if (warningsSoFar == 4) {
            emit interfaceWarning(Property, i.key(), "Property was not updated via PropertiesChanged signal [further warnings for this property suppressed]");
        }
        propertyUpdateWarningCount.insert(i.key(), warningsSoFar + 1);
        props[i.key()] = i.value();
        ++i;
    }
    outOfDateProperties.clear();
}