File: deviceinfo.h

package info (click to toggle)
kdeconnect 25.04.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 9,584 kB
  • sloc: cpp: 22,922; xml: 520; python: 92; sh: 25; makefile: 5
file content (169 lines) | stat: -rw-r--r-- 5,655 bytes parent folder | download
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
/**
 * SPDX-FileCopyrightText: 2023 Albert Vaca <albertvaka@gmail.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
 */

#ifndef DEVICE_INFO_H
#define DEVICE_INFO_H

#include "networkpacket.h"
#include <QRegularExpression>
#include <QSet>
#include <QSslCertificate>
#include <QString>

struct DeviceType {
    enum Value {
        Unknown,
        Desktop,
        Laptop,
        Phone,
        Tablet,
        Tv,
    };

    static DeviceType FromString(const QString &deviceType)
    {
        if (deviceType == QLatin1String("desktop"))
            return DeviceType::Desktop;
        if (deviceType == QLatin1String("laptop"))
            return DeviceType::Laptop;
        if (deviceType == QLatin1String("smartphone") || deviceType == QLatin1String("phone"))
            return DeviceType::Phone;
        if (deviceType == QLatin1String("tablet"))
            return DeviceType::Tablet;
        if (deviceType == QLatin1String("tv"))
            return DeviceType::Tv;
        return DeviceType::Unknown;
    }

    QString toString() const
    {
        if (value == DeviceType::Desktop)
            return QStringLiteral("desktop");
        if (value == DeviceType::Laptop)
            return QStringLiteral("laptop");
        if (value == DeviceType::Phone)
            return QStringLiteral("phone");
        if (value == DeviceType::Tablet)
            return QStringLiteral("tablet");
        if (value == DeviceType::Tv)
            return QStringLiteral("tv");
        return QStringLiteral("unknown");
    }

    QString icon() const
    {
        return iconForStatus(true, false);
    }

    QString iconForStatus(bool reachable, bool trusted) const
    {
        QString type;
        switch (value) {
        case DeviceType::Unknown:
        case DeviceType::Phone:
            type = QStringLiteral("smartphone");
            break;
        case DeviceType::Desktop: // We don't have desktop icon yet
        case DeviceType::Laptop:
            type = QStringLiteral("laptop");
            break;
        default:
            type = toString();
        }
        QString status = (reachable ? (trusted ? QStringLiteral("connected") : QStringLiteral("disconnected")) : QStringLiteral("trusted"));
        return type + status;
    }

    constexpr DeviceType(Value value)
        : value(value)
    {
    }
    constexpr bool operator==(DeviceType a) const
    {
        return value == a.value;
    }
    constexpr bool operator!=(DeviceType a) const
    {
        return value != a.value;
    }

private:
    Value value;
};

struct DeviceInfo {
    QString id;
    QSslCertificate certificate;
    QString name;
    DeviceType type;
    int protocolVersion;
    QSet<QString> incomingCapabilities;
    QSet<QString> outgoingCapabilities;

    DeviceInfo(const QString &id,
               const QSslCertificate &certificate,
               const QString &name,
               DeviceType type,
               int protocolVersion = 0,
               const QSet<QString> &incomingCapabilities = QSet<QString>(),
               const QSet<QString> &outgoingCapabilities = QSet<QString>())
        : id(id)
        , certificate(certificate)
        , name(name)
        , type(type)
        , protocolVersion(protocolVersion)
        , incomingCapabilities(incomingCapabilities)
        , outgoingCapabilities(outgoingCapabilities)
    {
    }

    NetworkPacket toIdentityPacket()
    {
        NetworkPacket np(PACKET_TYPE_IDENTITY);
        np.set(QStringLiteral("deviceId"), id);
        np.set(QStringLiteral("deviceName"), name);
        np.set(QStringLiteral("deviceType"), type.toString());
        np.set(QStringLiteral("protocolVersion"), protocolVersion);
        np.set(QStringLiteral("incomingCapabilities"), incomingCapabilities.values());
        np.set(QStringLiteral("outgoingCapabilities"), outgoingCapabilities.values());
        return np;
    }

    static DeviceInfo FromIdentityPacketAndCert(const NetworkPacket &np, const QSslCertificate &certificate)
    {
        QStringList incomingCapabilities = np.get<QStringList>(QStringLiteral("incomingCapabilities"));
        QStringList outgoingCapabilities = np.get<QStringList>(QStringLiteral("outgoingCapabilities"));

        return DeviceInfo(np.get<QString>(QStringLiteral("deviceId")),
                          certificate,
                          filterName(np.get<QString>(QStringLiteral("deviceName"))),
                          DeviceType::FromString(np.get<QString>(QStringLiteral("deviceType"))),
                          np.get<int>(QStringLiteral("protocolVersion"), -1),
                          QSet<QString>(incomingCapabilities.begin(), incomingCapabilities.end()),
                          QSet<QString>(outgoingCapabilities.begin(), outgoingCapabilities.end()));
    }

    static QString filterName(QString input)
    {
        static const QRegularExpression NAME_INVALID_CHARACTERS_REGEX(QStringLiteral("[\"',;:.!?()\\[\\]<>]"));
        constexpr int MAX_DEVICE_NAME_LENGTH = 32;
        return input.remove(NAME_INVALID_CHARACTERS_REGEX).left(MAX_DEVICE_NAME_LENGTH);
    }

    static bool isValidIdentityPacket(NetworkPacket *np)
    {
        return np->type() == PACKET_TYPE_IDENTITY && !filterName(np->get(QLatin1String("deviceName"), QString())).isEmpty()
            && isValidDeviceId(np->get(QLatin1String("deviceId"), QString()));
    }

    static bool isValidDeviceId(const QString &deviceId)
    {
        static const QRegularExpression DEVICE_ID_REGEX(QStringLiteral("^[a-zA-Z0-9_-]{32,38}$"));
        return DEVICE_ID_REGEX.match(deviceId).hasMatch();
    }
};

#endif