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
|
#include "uri.h"
#include "logging.h"
#include <QtCore/QRegularExpression>
using namespace Quotient;
struct ReplacePair { QByteArray uriString; char sigil; };
/// Defines bi-directional mapping of path prefixes and sigils
static const auto replacePairs = {
ReplacePair { "user/", '@' },
{ "roomid/", '!' },
{ "room/", '#' },
// The notation for bare event ids is not proposed in MSC2312 but there's
// https://github.com/matrix-org/matrix-doc/pull/2644
{ "event/", '$' }
};
Uri::Uri(QByteArray primaryId, QByteArray secondaryId, QString query)
{
if (primaryId.isEmpty())
primaryType_ = Empty;
else {
setScheme("matrix");
QString pathToBe;
primaryType_ = Invalid;
if (primaryId.size() < 2) // There should be something after sigil
return;
for (const auto& p: replacePairs)
if (primaryId[0] == p.sigil) {
primaryType_ = Type(p.sigil);
auto safePrimaryId = primaryId.mid(1);
safePrimaryId.replace('/', "%2F");
pathToBe = p.uriString + safePrimaryId;
break;
}
if (!secondaryId.isEmpty()) {
if (secondaryId.size() < 2) {
primaryType_ = Invalid;
return;
}
auto safeSecondaryId = secondaryId.mid(1);
safeSecondaryId.replace('/', "%2F");
pathToBe += "/event/" + safeSecondaryId;
}
setPath(pathToBe, QUrl::TolerantMode);
}
if (!query.isEmpty())
setQuery(query);
}
static inline auto encodedPath(const QUrl& url)
{
return url.path(QUrl::EncodeDelimiters | QUrl::EncodeUnicode);
}
static QString pathSegment(const QUrl& url, int which)
{
return QUrl::fromPercentEncoding(
encodedPath(url).section('/', which, which).toUtf8());
}
static auto decodeFragmentPart(const QStringRef& part)
{
return QUrl::fromPercentEncoding(part.toLatin1()).toUtf8();
}
static auto matrixToUrlRegexInit()
{
// See https://matrix.org/docs/spec/appendices#matrix-to-navigation
const QRegularExpression MatrixToUrlRE {
"^/(?<main>[^:]+:[^/?]+)(/(?<sec>(\\$|%24)[^?]+))?(\\?(?<query>.+))?$"
};
Q_ASSERT(MatrixToUrlRE.isValid());
return MatrixToUrlRE;
}
Uri::Uri(QUrl url) : QUrl(std::move(url))
{
// NB: don't try to use `url` from here on, it's moved-from and empty
if (isEmpty())
return; // primaryType_ == Empty
primaryType_ = Invalid;
if (!QUrl::isValid()) // MatrixUri::isValid() checks primaryType_
return;
if (scheme() == "matrix") {
// Check sanity as per https://github.com/matrix-org/matrix-doc/pull/2312
const auto& urlPath = encodedPath(*this);
const auto& splitPath = urlPath.splitRef('/');
switch (splitPath.size()) {
case 2:
break;
case 4:
if (splitPath[2] == "event")
break;
[[fallthrough]];
default:
return; // Invalid
}
for (const auto& p: replacePairs)
if (urlPath.startsWith(p.uriString)) {
primaryType_ = Type(p.sigil);
return; // The only valid return path for matrix: URIs
}
qCDebug(MAIN) << "The matrix: URI is not recognised:"
<< toDisplayString();
return;
}
primaryType_ = NonMatrix; // Default, unless overridden by the code below
if (scheme() == "https" && authority() == "matrix.to") {
static const auto MatrixToUrlRE = matrixToUrlRegexInit();
// matrix.to accepts both literal sigils (as well as & and ? used in
// its "query" substitute) and their %-encoded forms;
// so force QUrl to decode everything.
auto f = fragment(QUrl::EncodeUnicode);
if (auto&& m = MatrixToUrlRE.match(f); m.hasMatch())
*this = Uri { decodeFragmentPart(m.capturedRef("main")),
decodeFragmentPart(m.capturedRef("sec")),
decodeFragmentPart(m.capturedRef("query")) };
}
}
Uri::Uri(const QString& uriOrId) : Uri(fromUserInput(uriOrId)) {}
Uri Uri::fromUserInput(const QString& uriOrId)
{
if (uriOrId.isEmpty())
return {}; // type() == None
// A quick check if uriOrId is a plain Matrix id
// Bare event ids cannot be resolved without a room scope as per the current
// spec but there's a movement towards making them navigable (see, e.g.,
// https://github.com/matrix-org/matrix-doc/pull/2644) - so treat them
// as valid
if (QStringLiteral("!@#+$").contains(uriOrId[0]))
return Uri { uriOrId.toUtf8() };
return Uri { QUrl::fromUserInput(uriOrId) };
}
Uri::Type Uri::type() const { return primaryType_; }
Uri::SecondaryType Uri::secondaryType() const
{
return pathSegment(*this, 2) == "event" ? EventId : NoSecondaryId;
}
QUrl Uri::toUrl(UriForm form) const
{
if (!isValid())
return {};
if (form == CanonicalUri || type() == NonMatrix)
return *this; // NOLINT(cppcoreguidelines-slicing): It's intentional
QUrl url;
url.setScheme("https");
url.setHost("matrix.to");
url.setPath("/");
auto fragment = '/' + primaryId();
if (const auto& secId = secondaryId(); !secId.isEmpty())
fragment += '/' + secId;
if (const auto& q = query(); !q.isEmpty())
fragment += '?' + q;
url.setFragment(fragment);
return url;
}
QString Uri::primaryId() const
{
if (primaryType_ == Empty || primaryType_ == Invalid)
return {};
const auto& idStem = pathSegment(*this, 1);
return idStem.isEmpty() ? idStem : primaryType_ + idStem;
}
QString Uri::secondaryId() const
{
const auto& idStem = pathSegment(*this, 3);
return idStem.isEmpty() ? idStem : secondaryType() + idStem;
}
static const auto ActionKey = QStringLiteral("action");
QString Uri::action() const
{
return type() == NonMatrix || !isValid()
? QString()
: QUrlQuery { query() }.queryItemValue(ActionKey);
}
void Uri::setAction(const QString& newAction)
{
if (!isValid()) {
qCWarning(MAIN) << "Cannot set an action on an invalid Quotient::Uri";
return;
}
QUrlQuery q { query() };
q.removeQueryItem(ActionKey);
q.addQueryItem(ActionKey, newAction);
setQuery(q);
}
QStringList Uri::viaServers() const
{
return QUrlQuery { query() }.allQueryItemValues(QStringLiteral("via"),
QUrl::EncodeReserved);
}
bool Uri::isValid() const
{
return primaryType_ != Empty && primaryType_ != Invalid;
}
|
