aboutsummaryrefslogtreecommitdiffstats
path: root/src/datasources/qmldesignerusageeventsource.cpp
blob: 00a614b1ceb2875f8b79d994a0459d01f0d4d18d (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
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company
** Contact: https://www.qt.io/licensing/
**
** This file is part of UsageStatistic plugin for Qt Creator.
**
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** 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-3.0.html.
**
****************************************************************************/
#include "qmldesignerusageeventsource.h"

#include "common/scopedsettingsgroupsetter.h"

#include <coreplugin/icore.h>
#include <extensionsystem/iplugin.h>
#include <extensionsystem/pluginmanager.h>
#include <extensionsystem/pluginspec.h>
#include <QtQuick/QQuickItem>

#include <KUserFeedback/Provider>

namespace UsageStatistic {
namespace Internal {

using namespace KUserFeedback;

static bool isQmlDesigner(const ExtensionSystem::PluginSpec *spec)
{
    if (!spec)
        return false;

    return spec->name().contains("QmlDesigner");
}

const char qmlDesignerEventsKey[] = "qmlDesignerEvents";
const char qmlDesignerTimesKey[] = "qmlDesignerTimes";

// For feedback popup
const char qmlDesignerFeedbackTextKey[] = "qmlDesignerFeedbackTextKey";
const char qmlDesignerFeedbackRatingKey[] = "qmlDesignerFeedbackRatingKey";
const char qmlDesignerFeedbackPoppedKey[] = "qmlDesignerFeedbackPoppedKey";

QmlDesignerUsageEventSource::QmlDesignerUsageEventSource()
    : KUserFeedback::AbstractDataSource("qmlDesignerUsageEvents", Provider::DetailedUsageStatistics)
{
    const auto plugins = ExtensionSystem::PluginManager::plugins();
    const auto it = std::find_if(plugins.begin(), plugins.end(), &isQmlDesigner);
    if (it != plugins.end()) {
        const QObject *qmlDesignerPlugin = (*it)->plugin();
        connect(qmlDesignerPlugin,
                SIGNAL(usageStatisticsNotifier(QString)),
                this,
                SLOT(handleUsageStatisticsNotifier(QString)));
        connect(qmlDesignerPlugin,
                SIGNAL(usageStatisticsUsageTimer(QString,int)),
                this,
                SLOT(handleUsageStatisticsUsageTimer(QString,int)));
    }
}

QString QmlDesignerUsageEventSource::name() const
{
    return tr("Qt Quick Designer usage of views and actions");
}

QString QmlDesignerUsageEventSource::description() const
{
    return tr("What views and actions are used in QML Design mode.");
}

void QmlDesignerUsageEventSource::closeFeedbackPopup()
{
    m_feedbackWidget->deleteLater();
}

void QmlDesignerUsageEventSource::insertFeedback(const QString &feedback, int rating)
{
    if (!feedback.isEmpty())
        m_feedbackTextData.insert(currentIdentifier, feedback);

    m_feedbackRatingData.insert(currentIdentifier, rating);
}

void QmlDesignerUsageEventSource::launchPopup(const QString &identifier)
{
    currentIdentifier = identifier;

    if (!m_feedbackWidget) {
        m_feedbackWidget = new QQuickWidget(Core::ICore::dialogParent());
        m_feedbackWidget->setSource(QUrl("qrc:/usagestatistic/ui/FeedbackPopup.qml"));
        m_feedbackWidget->setWindowModality(Qt::ApplicationModal);
        m_feedbackWidget->setWindowFlags(Qt::SplashScreen);
        m_feedbackWidget->setAttribute(Qt::WA_DeleteOnClose);

        QQuickItem *root = m_feedbackWidget->rootObject();
        QObject *title = root->findChild<QObject *>("title");
        QString name = tr("Enjoying %1?").arg(identifier);
        title->setProperty("text", name);

        QObject::connect(root, SIGNAL(submitFeedback(QString,int)),
                         this, SLOT(insertFeedback(QString,int)));
        QObject::connect(root, SIGNAL(closeClicked()), this, SLOT(closeFeedbackPopup()));
    }

    m_feedbackWidget->show();
}

void QmlDesignerUsageEventSource::handleUsageStatisticsNotifier(const QString &identifier)
{
    auto it = m_eventData.find(identifier);

    if (it != m_eventData.end())
        it.value() = it.value().toInt() + 1;
    else
        m_eventData.insert(identifier, 1);
}

void QmlDesignerUsageEventSource::handleUsageStatisticsUsageTimer(const QString &identifier, int elapsed)
{
    auto it = m_timeData.find(identifier);

    if (it != m_timeData.end()) {
        it.value() = it.value().toInt() + elapsed;

        // Show the user feedback prompt after time limit is passed
        static const QSet<QString> supportedViews {"Form Editor", "3D Editor", "Timeline",
                                                   "Transition Editor", "Curve Editor"};
        static const int timeLimit = 864'000'000; // 10 days
        if (supportedViews.contains(identifier) && !m_feedbackPoppedData[identifier].toBool()
                && m_timeData.value(identifier).toInt() >= timeLimit) {
            launchPopup(identifier);
            m_feedbackPoppedData[identifier] = QVariant(true);
        }
    } else {
        m_timeData.insert(identifier, elapsed);
    }
}

QVariant QmlDesignerUsageEventSource::data()
{
    return QVariantMap{{qmlDesignerEventsKey, m_eventData}, {qmlDesignerTimesKey, m_timeData},
           {qmlDesignerFeedbackTextKey, m_feedbackTextData}, {qmlDesignerFeedbackRatingKey, m_feedbackRatingData},
           {qmlDesignerFeedbackPoppedKey, m_feedbackPoppedData}};
}

void QmlDesignerUsageEventSource::loadImpl(QSettings *settings)
{
    auto setter = ScopedSettingsGroupSetter::forDataSource(*this, *settings);
    m_eventData = settings->value(qmlDesignerEventsKey).toMap();
    m_timeData = settings->value(qmlDesignerTimesKey).toMap();
    m_feedbackTextData = settings->value(qmlDesignerFeedbackTextKey).toHash();
    m_feedbackRatingData = settings->value(qmlDesignerFeedbackRatingKey).toHash();
    m_feedbackPoppedData = settings->value(qmlDesignerFeedbackPoppedKey).toHash();
}

void QmlDesignerUsageEventSource::storeImpl(QSettings *settings)
{
    auto setter = ScopedSettingsGroupSetter::forDataSource(*this, *settings);
    settings->setValue(qmlDesignerEventsKey, m_eventData);
    settings->setValue(qmlDesignerTimesKey, m_timeData);
    settings->setValue(qmlDesignerFeedbackTextKey, m_feedbackTextData);
    settings->setValue(qmlDesignerFeedbackRatingKey, m_feedbackRatingData);
    settings->setValue(qmlDesignerFeedbackPoppedKey, m_feedbackPoppedData);
}

void QmlDesignerUsageEventSource::resetImpl(QSettings *settings)
{
    m_eventData.clear();
    storeImpl(settings);
}

} // namespace Internal
} // namespace UsageStatistic