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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
/*
* irc-tag.c - functions for IRC message tags
*
* Copyright (C) 2021 Sébastien Helleu <flashcode@flashtux.org>
*
* This file is part of WeeChat, the extensible chat client.
*
* WeeChat is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* WeeChat is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WeeChat. If not, see <https://www.gnu.org/licenses/>.
*/
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <ctype.h>
#include "../weechat-plugin.h"
#include "irc.h"
#include "irc-tag.h"
/*
* Escapes a tag value, the following sequences are replaced:
*
* character | escaped value
* ---------------+-------------------------
* ; (semicolon) | \: (backslash and colon)
* SPACE | \s
* \ | \\
* CR | \r
* LF | \n
* all others | the character itself
*
* See: https://ircv3.net/specs/extensions/message-tags#escaping-values
*
* Note: result must be freed after use.
*/
char *
irc_tag_escape_value (const char *string)
{
char **out, *result;
unsigned char *ptr_string;
int length;
if (!string)
return NULL;
length = strlen (string);
out = weechat_string_dyn_alloc (length + (length / 2) + 1);
if (!out)
return NULL;
ptr_string = (unsigned char *)string;
while (ptr_string && ptr_string[0])
{
switch (ptr_string[0])
{
case ';':
weechat_string_dyn_concat (out, "\\:", -1);
ptr_string++;
break;
case ' ':
weechat_string_dyn_concat (out, "\\s", -1);
ptr_string++;
break;
case '\\':
weechat_string_dyn_concat (out, "\\\\", -1);
ptr_string++;
break;
case '\r':
weechat_string_dyn_concat (out, "\\r", -1);
ptr_string++;
break;
case '\n':
weechat_string_dyn_concat (out, "\\n", -1);
ptr_string++;
break;
default:
length = weechat_utf8_char_size ((char *)ptr_string);
if (length == 0)
length = 1;
weechat_string_dyn_concat (out,
(const char *)ptr_string,
length);
ptr_string += length;
break;
}
}
result = *out;
weechat_string_dyn_free (out, 0);
return result;
}
/*
* Unescapes a tag value.
*
* See: https://ircv3.net/specs/extensions/message-tags#escaping-values
*
* Note: result must be freed after use.
*/
char *
irc_tag_unescape_value (const char *string)
{
char **out, *result;
unsigned char *ptr_string;
int length;
if (!string)
return NULL;
length = strlen (string);
out = weechat_string_dyn_alloc (length + (length / 2) + 1);
if (!out)
return NULL;
ptr_string = (unsigned char *)string;
while (ptr_string && ptr_string[0])
{
switch (ptr_string[0])
{
case '\\':
ptr_string++;
switch (ptr_string[0])
{
case ':':
weechat_string_dyn_concat (out, ";", -1);
ptr_string++;
break;
case 's':
weechat_string_dyn_concat (out, " ", -1);
ptr_string++;
break;
case '\\':
weechat_string_dyn_concat (out, "\\", -1);
ptr_string++;
break;
case 'r':
weechat_string_dyn_concat (out, "\r", -1);
ptr_string++;
break;
case 'n':
weechat_string_dyn_concat (out, "\n", -1);
ptr_string++;
break;
default:
if (ptr_string[0])
{
length = weechat_utf8_char_size ((char *)ptr_string);
if (length == 0)
length = 1;
weechat_string_dyn_concat (out,
(const char *)ptr_string,
length);
ptr_string += length;
}
break;
}
break;
default:
length = weechat_utf8_char_size ((char *)ptr_string);
if (length == 0)
length = 1;
weechat_string_dyn_concat (out,
(const char *)ptr_string,
length);
ptr_string += length;
break;
}
}
result = *out;
weechat_string_dyn_free (out, 0);
return result;
}
/*
* Callback for modifiers "irc_tag_escape_value" and "irc_tag_unescape_value".
*
* These modifiers can be used by other plugins to escape/unescape IRC message
* tags.
*/
char *
irc_tag_modifier_cb (const void *pointer, void *data,
const char *modifier, const char *modifier_data,
const char *string)
{
/* make C compiler happy */
(void) pointer;
(void) data;
(void) modifier_data;
if (strcmp (modifier, "irc_tag_escape_value") == 0)
return irc_tag_escape_value (string);
if (strcmp (modifier, "irc_tag_unescape_value") == 0)
return irc_tag_unescape_value (string);
/* unknown modifier */
return NULL;
}
/*
* Parses tags received in an IRC message and returns the number of tags
* set in the hasbtable "hashtable" (values are unescaped tag values).
*
* If prefix_key is not NULL, it is used as prefix before the name of keys.
*
* Example:
*
* input:
* tags == "aaa=bbb;ccc;example.com/ddd=value\swith\sspaces"
* prefix_key == "tag_"
* output:
* hashtable is completed with the following keys/values:
* "tag_aaa" => "bbb"
* "tag_ccc" => NULL
* "tag_example.com/ddd" => "value with spaces"
*/
int
irc_tag_parse (const char *tags,
struct t_hashtable *hashtable, const char *prefix_key)
{
char **items, *pos, *key, str_key[4096], *unescaped;
int num_items, i, num_tags;
if (!tags || !tags[0] || !hashtable)
return 0;
num_tags = 0;
items = weechat_string_split (tags, ";", NULL,
WEECHAT_STRING_SPLIT_STRIP_LEFT
| WEECHAT_STRING_SPLIT_STRIP_RIGHT
| WEECHAT_STRING_SPLIT_COLLAPSE_SEPS,
0, &num_items);
if (items)
{
for (i = 0; i < num_items; i++)
{
pos = strchr (items[i], '=');
if (pos)
{
/* format: "tag=value" */
key = weechat_strndup (items[i], pos - items[i]);
if (key)
{
snprintf (str_key, sizeof (str_key),
"%s%s",
(prefix_key) ? prefix_key : "",
key);
unescaped = irc_tag_unescape_value (pos + 1);
weechat_hashtable_set (hashtable, str_key, unescaped);
if (unescaped)
free (unescaped);
free (key);
num_tags++;
}
}
else
{
/* format: "tag" */
snprintf (str_key, sizeof (str_key),
"%s%s",
(prefix_key) ? prefix_key : "",
items[i]);
weechat_hashtable_set (hashtable, str_key, NULL);
num_tags++;
}
}
weechat_string_free_split (items);
}
return num_tags;
}
|
