aboutsummaryrefslogtreecommitdiffstats
path: root/src/datasources/examplesdatasource.cpp
blob: 0682e7b4a8765bc9fff1ba131d296f4871da7241 (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
/****************************************************************************
**
** Copyright (C) 2019 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 "examplesdatasource.h"

#include <QtCore/QSettings>
#include <QtCore/QRegularExpression>

#include <projectexplorer/project.h>
#include <projectexplorer/session.h>

#include <common/scopedsettingsgroupsetter.h>

namespace UsageStatistic {
namespace Internal {

using namespace KUserFeedback;

ExamplesDataSource::ExamplesDataSource()
    : AbstractDataSource(QStringLiteral("examplesData"), Provider::DetailedUsageStatistics)
{
    connect(ProjectExplorer::SessionManager::instance(),
            &ProjectExplorer::SessionManager::startupProjectChanged,
            this, &ExamplesDataSource::updateOpenedExamples);

    connect(ProjectExplorer::SessionManager::instance(),
            &ProjectExplorer::SessionManager::projectAdded,
            this, &ExamplesDataSource::updateOpenedExamples);

    connect(ProjectExplorer::SessionManager::instance(),
            &ProjectExplorer::SessionManager::sessionLoaded,
            this, &ExamplesDataSource::updateOpenedExamples);
}

ExamplesDataSource::~ExamplesDataSource() = default;

QString ExamplesDataSource::name() const
{
    return tr("Examples");
}

QString ExamplesDataSource::description() const
{
    return tr("The list of examples opened by you. "
              "Only example paths are collected and sent, for example: "
              "widgets/mainwindows/application/application.pro");
}

static QString examplesKey() { return QStringLiteral("examples"); }

QVariant ExamplesDataSource::data()
{
    return QVariantMap{{examplesKey(), QVariant(m_examplePaths)}};
}

void ExamplesDataSource::loadImpl(QSettings *settings)
{
    auto setter = ScopedSettingsGroupSetter::forDataSource(*this, *settings);
    m_examplePaths = settings->value(examplesKey()).toStringList();
}

void ExamplesDataSource::storeImpl(QSettings *settings)
{
    auto setter = ScopedSettingsGroupSetter::forDataSource(*this, *settings);
    settings->setValue(examplesKey(), QStringList(m_examplePaths));
}

void ExamplesDataSource::resetImpl(QSettings *settings)
{
    m_examplePaths.clear();
    storeImpl(settings);
}

static QString examplePathGroupName() { return QStringLiteral("examplePathGroup"); }

static QString examplePattern()
{
    return QStringLiteral("/Examples/Qt-(\\d+\\.*){1,3}/(?<%1>.*)$");
}

void ExamplesDataSource::updateOpenedExamples()
{
    QRegularExpression re(examplePattern().arg(examplePathGroupName()));
    for (auto project : ProjectExplorer::SessionManager::projects()) {
        if (project) {
            auto projectPath = QDir::fromNativeSeparators(project->projectFilePath().toString());
            const auto match = re.match(projectPath);
            if (match.hasMatch()) {
                QString sanitizedPath = match.captured(examplePathGroupName());
                if (!m_examplePaths.contains(sanitizedPath))
                    m_examplePaths.append(sanitizedPath);
            }
        }
    }
}

} // namespace Internal
} // namespace UsageStatistic