aboutsummaryrefslogtreecommitdiffstats
path: root/src/tools/sdktool/rmkeysoperation.cpp
blob: 5ef77a3ab948453368ce6803c90254d7d2f565e6 (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
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0

#include "rmkeysoperation.h"

#include <iostream>

#ifdef WITH_TESTS
#include <QTest>
#endif

#include <QLoggingCategory>
#include <QRegularExpression>

Q_LOGGING_CATEGORY(rmkeyslog, "qtc.sdktool.operations.rmkeys", QtWarningMsg)

QString RmKeysOperation::name() const
{
    return QLatin1String("rmKeys");
}

QString RmKeysOperation::helpText() const
{
    return QLatin1String("remove settings from configuration");
}

QString RmKeysOperation::argumentsHelpText() const
{
    return QLatin1String("A file (relative to top-level settings directory and without .xml extension)\n"
                         "followed by one or more keys to remove.\n");
}

bool RmKeysOperation::setArguments(const QStringList &args)
{
    if (args.count() < 2)
        return false;

    m_keys = args;
    m_file = m_keys.takeFirst();

    if (m_file.isEmpty())
        qCCritical(rmkeyslog) << "No file given.";
    if (m_keys.isEmpty())
        qCCritical(rmkeyslog) << "No keys given.";

    return !m_file.isEmpty() && !m_keys.isEmpty();
}

int RmKeysOperation::execute() const
{
    Q_ASSERT(!m_keys.isEmpty());
    QVariantMap map = load(m_file);

    QVariantMap result = rmKeys(map, m_keys);
    if (map == result)
        return 1;

    // Write data again:
    return save(result, m_file) ? 0 : 2;
}

#ifdef WITH_TESTS
void RmKeysOperation::unittest()
{
    QVariantMap testMap;
    QVariantMap subKeys;
    QVariantMap cur;
    cur.insert(QLatin1String("testint2"), 53);
    subKeys.insert(QLatin1String("subsubkeys"), cur);
    subKeys.insert(QLatin1String("testbool"), true);
    testMap.insert(QLatin1String("subkeys"), subKeys);
    subKeys.clear();
    testMap.insert(QLatin1String("subkeys2"), subKeys);
    testMap.insert(QLatin1String("testint"), 23);

    QStringList data;

    QVariantMap result = rmKeys(testMap, data);

    QVERIFY(result == testMap);

    data.append(QLatin1String("testint"));
    result = rmKeys(testMap, data);

    QCOMPARE(result.count(), 2);
    QVERIFY(result.contains(QLatin1String("subkeys")));
    QVERIFY(result.contains(QLatin1String("subkeys2")));

    cur = result.value(QLatin1String("subkeys")).toMap();
    QCOMPARE(cur.count(), 2);
    QVERIFY(cur.contains(QLatin1String("subsubkeys")));
    QVERIFY(cur.contains(QLatin1String("testbool")));

    cur = cur.value(QLatin1String("subsubkeys")).toMap();
    QCOMPARE(cur.count(), 1);
    QVERIFY(cur.contains(QLatin1String("testint2")));

    cur = result.value(QLatin1String("subkeys2")).toMap();
    QVERIFY(cur.isEmpty());

    data.clear();
    data.append(QLatin1String("subkeys/subsubkeys"));
    result = rmKeys(testMap, data);

    QCOMPARE(result.count(), 3);
    QVERIFY(result.contains(QLatin1String("subkeys")));
    QVERIFY(result.contains(QLatin1String("subkeys2")));
    QVERIFY(result.contains(QLatin1String("testint")));

    cur = result.value(QLatin1String("subkeys")).toMap();
    QCOMPARE(cur.count(), 1);
    QVERIFY(cur.contains(QLatin1String("testbool")));

    cur = result.value(QLatin1String("subkeys2")).toMap();
    QVERIFY(cur.isEmpty());

    data.clear();
    data.append(QLatin1String("subkeys/testbool"));
    result = rmKeys(testMap, data);

    QCOMPARE(result.count(), 3);
    QVERIFY(result.contains(QLatin1String("subkeys")));
    QVERIFY(result.contains(QLatin1String("subkeys2")));
    QVERIFY(result.contains(QLatin1String("testint")));

    cur = result.value(QLatin1String("subkeys")).toMap();
    QCOMPARE(cur.count(), 1);
    QVERIFY(cur.contains(QLatin1String("subsubkeys")));

    cur = cur.value(QLatin1String("subsubkeys")).toMap();
    QCOMPARE(cur.count(), 1);
    QVERIFY(cur.contains(QLatin1String("testint2")));

    cur = result.value(QLatin1String("subkeys2")).toMap();
    QVERIFY(cur.isEmpty());

    cur = result.value(QLatin1String("subkeys2")).toMap();
    QVERIFY(cur.isEmpty());

    // Test removing of non-existent key ...
    testMap = rmKeys(testMap, data);

    QTest::ignoreMessage(QtWarningMsg,
                         QRegularExpression("Key .* not found."));
    testMap = rmKeys(testMap, data);
}
#endif

QVariantMap RmKeysOperation::rmKeys(const QVariantMap &map, const QStringList &removals)
{
    QVariantMap result = map;

    for (const QString &r : removals) {
        QList<QVariantMap> stack;

        const QStringList keys = r.split(QLatin1Char('/'));

        // Set up a stack of QVariantMaps along the path we take:
        stack.append(result);
        for (int i = 0; i < keys.count() - 1; ++i) {
            QVariantMap subMap;
            if (stack.last().contains(keys.at(i))) {
                subMap = stack.last().value(keys.at(i)).toMap();
            } else {
                qCWarning(rmkeyslog) << "Key" << qPrintable(r) << "not found.";
                continue;
            }
            stack.append(subMap);
        }

        // remove
        Q_ASSERT(stack.count() == keys.count());
        if (!stack.last().contains(keys.last())) {
            qCWarning(rmkeyslog) << "Key" << qPrintable(r) << "not found.";
            continue;
        }
        stack.last().remove(keys.last());

        // Generate new resultset by folding maps back in:
        QVariantMap foldBack = stack.takeLast();
        for (int i = keys.count() - 2; i >= 0; --i) { // skip last key, that is already taken care of
            const QString k = keys.at(i);
            QVariantMap current = stack.takeLast();
            current.insert(k, foldBack);
            foldBack = current;
        }

        Q_ASSERT(stack.isEmpty());
        Q_ASSERT(foldBack != map);

        result = foldBack;
    }

    return result;
}