File: tvbuilder.c

package info (click to toggle)
pidgin 2.14.12-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 52,348 kB
  • sloc: ansic: 253,272; sh: 4,565; makefile: 3,170; python: 1,232; perl: 533; cs: 209; tcl: 96; xml: 9
file content (426 lines) | stat: -rw-r--r-- 9,223 bytes parent folder | download | duplicates (10)
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
/* $Id$ */

/*
 *  (C) Copyright 2012 Tomek Wasilczyk <www.wasilczyk.pl>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License Version
 *  2.1 as published by the Free Software Foundation.
 *
 *  This program 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 Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307,
 *  USA.
 */

/**
 * \file tvbuilder.c
 *
 * \brief Bufor wspierający budowanie pakietów typu Type-Value(s)
 */

#include <stdlib.h>
#include <string.h>

#include "tvbuilder.h"

#include "internal.h"
#include "fileio.h"

#include <errno.h>

struct gg_tvbuilder
{
	char *buffer;
	size_t length;
	size_t alloc_length;
	int valid;

	struct gg_session *gs;
	struct gg_event *ge;
};

static char *gg_tvbuilder_extend(gg_tvbuilder_t *tvb, size_t length);

/**
 * \internal Tworzy nową instancję bufora.
 *
 * \param gs Struktura sesji
 * \param ge Struktura zdarzenia
 *
 * \return Zaalokowany bufor - musi być zwolniony przez gg_tvbuilder_free,
 *         gg_tvbuilder_fail lub gg_tvbuilder_send.
 */
gg_tvbuilder_t *gg_tvbuilder_new(struct gg_session *gs, struct gg_event *ge)
{
	gg_tvbuilder_t *tvb;

	tvb = malloc(sizeof(gg_tvbuilder_t));
	if (tvb == NULL)
		return NULL;
	memset(tvb, 0, sizeof(gg_tvbuilder_t));

	if (gs == NULL) {
		gg_debug(GG_DEBUG_ERROR, "// gg_tvbuilder_new() "
			"invalid arguments\n");
		tvb->valid = 0;
		return tvb;
	}

	tvb->buffer = NULL;
	tvb->length = 0;
	tvb->alloc_length = 0;
	tvb->valid = 1;

	tvb->gs = gs;
	tvb->ge = ge;

	return tvb;
}

/**
 * \internal Zwalnia bufor.
 *
 * \param tvb Bufor
 */
void gg_tvbuilder_free(gg_tvbuilder_t *tvb)
{
	if (tvb == NULL)
		return;

	free(tvb->buffer);
	free(tvb);
}

/**
 * \internal Zwalnia bufor i generuje błąd połączenia.
 *
 * \param tvb     Bufor
 * \param failure Powód błędu
 */
void gg_tvbuilder_fail(gg_tvbuilder_t *tvb, enum gg_failure_t failure)
{
	int errno_copy;

	if (tvb == NULL) {
		gg_debug(GG_DEBUG_WARNING, "// gg_tvbuilder_fail() "
			"NULL tvbuilder\n");
		return;
	}

	errno_copy = errno;
	close(tvb->gs->fd);
	tvb->gs->fd = -1;
	errno = errno_copy;

	if (tvb->ge) {
		tvb->ge->type = GG_EVENT_CONN_FAILED;
		tvb->ge->event.failure = failure;
	}
	tvb->gs->state = GG_STATE_IDLE;

	gg_tvbuilder_free(tvb);
}

/**
 * \internal Próbuje wysłać zawartość bufora i go zwalnia.
 *
 * \param tvb  Bufor
 * \param type Typ pakietu
 *
 * \return 1 jeśli się powiodło, 0 w p.p.
 */
int gg_tvbuilder_send(gg_tvbuilder_t *tvb, int type)
{
	int ret;
	enum gg_failure_t failure;

	if (tvb == NULL) {
		gg_debug(GG_DEBUG_WARNING, "// gg_tvbuilder_send() "
			"NULL tvbuilder\n");
		return 0;
	}

	if (!gg_tvbuilder_is_valid(tvb)) {
		gg_debug_session(tvb->gs, GG_DEBUG_ERROR, "// gg_tvbuilder_send() "
			"invalid buffer\n");
		ret = -1;
		failure = GG_FAILURE_INTERNAL;
	} else {
		const char *buffer = (tvb->length > 0) ? tvb->buffer : "";
		ret = gg_send_packet(tvb->gs, type, buffer, tvb->length, NULL);
		if (ret == -1) {
			failure = GG_FAILURE_WRITING;
			gg_debug_session(tvb->gs, GG_DEBUG_ERROR,
				"// gg_tvbuilder_send() "
				"sending packet %#x failed. (errno=%d, %s)\n",
				type, errno, strerror(errno));
		}
	}

	if (ret == -1) {
		gg_tvbuilder_fail(tvb, failure);
		return 0;
	}

	gg_tvbuilder_free(tvb);
	return 1;
}

/**
 * \internal Sprawdza, czy wszystkie zapisy do  bufora były prawidłowe.
 *
 * \param tvb Builder.
 *
 * \return Wartość różna od 0, jeżeli wszystkie zapisy były prawidłowe.
 */
int gg_tvbuilder_is_valid(const gg_tvbuilder_t *tvb)
{
	if (tvb == NULL)
		return 0;
	return tvb->valid;
}

/**
 * \internal Sprawdza rozmiar bufora.
 *
 * \param tvb Bufor
 *
 * \return Rozmiar bufora
 */
size_t gg_tvbuilder_get_size(const gg_tvbuilder_t *tvb)
{
	if (!gg_tvbuilder_is_valid(tvb))
		return 0;

	return tvb->length;
}

/**
 * \internal Określa oczekiwaną liczbę bajtów, o którą zostanie rozszerzony
 * bufor.
 *
 * Funkcja powoduje jedynie wzrost wydajności poprzez zmniejszenie ilości
 * realokacji.
 *
 * \param tvb    Builder.
 * \param length Oczekiwana liczba bajtów.
 */
void gg_tvbuilder_expected_size(gg_tvbuilder_t *tvb, size_t length)
{
	size_t length_new;
	char *buff_new;

	if (!gg_tvbuilder_is_valid(tvb) || length == 0)
		return;

	length_new = tvb->length + length;

	if (length_new <= tvb->alloc_length)
		return;

	if (tvb->alloc_length > 0) {
		gg_debug(GG_DEBUG_MISC, "// gg_tvbuilder_expected_size(%p, %"
			GG_SIZE_FMT ") realloc from %" GG_SIZE_FMT " to %"
			GG_SIZE_FMT "\n",
			tvb, length, tvb->alloc_length, length_new);
	}

	buff_new = realloc(tvb->buffer, length_new);
	if (buff_new != NULL) {
		tvb->buffer = buff_new;
		tvb->alloc_length = length_new;
		return;
	}

	gg_debug(GG_DEBUG_ERROR, "// gg_tvbuilder_expected_size(%p, %"
		GG_SIZE_FMT ") out of memory (new length: %" GG_SIZE_FMT
		")\n", tvb, length, length_new);
	free(tvb->buffer);
	tvb->buffer = NULL;
	tvb->length = 0;
	tvb->alloc_length = 0;
	tvb->valid = 0;
}

/**
 * \internal Poszerza bufor o podaną liczbę bajtów.
 *
 * \param tvb    Bufor
 * \param length Liczba bajtów do dodania
 *
 * \return Początek nowo dodanego bloku bufora
 */
static char * gg_tvbuilder_extend(gg_tvbuilder_t *tvb, size_t length)
{
	size_t length_old;

	gg_tvbuilder_expected_size(tvb, length);
	if (!gg_tvbuilder_is_valid(tvb))
		return NULL;

	length_old = tvb->length;
	tvb->length += length;

	return tvb->buffer + length_old;
}

/**
 * \internal Skraca bufor o podaną liczbę bajtów
 *
 * \param tvb Bufor
 * \param length Ilość bajtów do skrócenia
 */
void gg_tvbuilder_strip(gg_tvbuilder_t *tvb, size_t length)
{
	if (!gg_tvbuilder_is_valid(tvb))
		return;

	if (length > tvb->length) {
		gg_debug(GG_DEBUG_WARNING, "// gg_tvbuilder_strip() "
			"out of range\n");
		tvb->valid = 0;
		return;
	}

	tvb->length = length;
}

/**
 * \internal Zapisuje do bufora liczbę 8-bitową.
 *
 * \param tvb   Bufor
 * \param value Wartość do zapisania
 */
void gg_tvbuilder_write_uint8(gg_tvbuilder_t *tvb, uint8_t value)
{
	gg_tvbuilder_write_buff(tvb, (const char *)&value, 1);
}

/**
 * \internal Zapisuje do bufora liczbę 32-bitową.
 *
 * \param tvb   Bufor
 * \param value Wartość do zapisania
 */
void gg_tvbuilder_write_uint32(gg_tvbuilder_t *tvb, uint32_t value)
{
	value = gg_fix32(value);
	gg_tvbuilder_write_buff(tvb, (const char *)&value, 4);
}

/**
 * \internal Zapisuje do bufora liczbę 64-bitową.
 *
 * \param tvb   Bufor
 * \param value Wartość do zapisania
 */
void gg_tvbuilder_write_uint64(gg_tvbuilder_t *tvb, uint64_t value)
{
	value = gg_fix64(value);
	gg_tvbuilder_write_buff(tvb, (const char *)&value, 8);
}

/**
 * \internal Zapisuje do bufora liczbę 1-9 bajtową.
 *
 * \param tvb   Bufor
 * \param value Wartość do zapisania
 *
 * \see gg_tvbuff_read_packed_uint
 */
void gg_tvbuilder_write_packed_uint(gg_tvbuilder_t *tvb, uint64_t value)
{
	uint8_t buff[9];
	uint64_t val_curr;
	int i, val_len = 0;

	if (!gg_tvbuilder_is_valid(tvb))
		return;

	val_curr = value;
	while (val_curr > 0) {
		val_curr >>= 7;
		val_len++;
	}
	if (val_len == 0)
		val_len = 1;

	if (val_len > 9) {
		gg_debug(GG_DEBUG_WARNING, "// gg_tvbuilder_write_packed_uint() "
			"int size too big (%d): %" PRIu64 "\n", val_len, value);
		tvb->valid = 0;
		return;
	}

	val_curr = value;
	for (i = 0; i < val_len; i++) {
		uint8_t raw = val_curr & 0x7F;
		val_curr >>= 7;
		if (i + 1 < val_len)
			raw |= 0x80;
		buff[i] = raw;
	}

	gg_tvbuilder_write_buff(tvb, (const char*)buff, val_len);
}

/**
 * \internal Zapisuje do bufora zawartość innego bufora.
 *
 * \param tvb    Bufor docelowy
 * \param buffer Bufor źródłowy
 * \param length Ilość danych do skopiowania
 */
void gg_tvbuilder_write_buff(gg_tvbuilder_t *tvb, const char *buffer,
	size_t length)
{
	char *buff = gg_tvbuilder_extend(tvb, length);
	if (!buff)
		return;

	memcpy(buff, buffer, length);
}

/**
 * \internal Zapisuje do bufora ciąg tekstowy (mogący zawierać znaki \0).
 *
 * \param tvb    Bufor docelowy
 * \param buffer Bufor źródłowy
 * \param length Długość tekstu, lub -1, jeżeli ma zostać wyliczona
 *               automatycznie (do pierwszego znaku \0)
 */
void gg_tvbuilder_write_str(gg_tvbuilder_t *tvb, const char *buffer,
	ssize_t length)
{
	if (!gg_tvbuilder_is_valid(tvb))
		return;

	if (length == -1)
		length = strlen(buffer);

	gg_tvbuilder_write_packed_uint(tvb, length);
	gg_tvbuilder_write_buff(tvb, buffer, length);
}

/**
 * \internal Zapisuje do bufora identyfikator użytkownika.
 *
 * \param tvb          Bufor
 * \param uin          Identyfikator użytkownika
 */
void gg_tvbuilder_write_uin(gg_tvbuilder_t *tvb, uin_t uin)
{
	char uin_str[16];
	int uin_len;

	uin_len = snprintf(uin_str, sizeof(uin_str), "%u", uin);

	gg_tvbuilder_write_uint8(tvb, 0x00);
	gg_tvbuilder_write_str(tvb, uin_str, uin_len);
}