Coverage Report

Created: 2025-10-08 19:34

/work/toxcore/tox_events.c
Line
Count
Source (jump to first uncovered line)
1
/* SPDX-License-Identifier: GPL-3.0-or-later
2
 * Copyright © 2022-2025 The TokTok team.
3
 */
4
5
#include "tox_events.h"
6
7
#include <assert.h>
8
#include <string.h>
9
10
#include "attributes.h"
11
#include "bin_pack.h"
12
#include "bin_unpack.h"
13
#include "ccompat.h"
14
#include "events/events_alloc.h"
15
#include "logger.h"
16
#include "mem.h"
17
#include "tox.h"
18
#include "tox_event.h"
19
#include "tox_private.h"
20
#include "tox_struct.h" // IWYU pragma: keep
21
22
/*****************************************************
23
 *
24
 * :: Set up event handlers.
25
 *
26
 *****************************************************/
27
28
void tox_events_init(Tox *tox)
29
1.21k
{
30
1.21k
    tox_callback_conference_connected(tox, tox_events_handle_conference_connected);
31
1.21k
    tox_callback_conference_invite(tox, tox_events_handle_conference_invite);
32
1.21k
    tox_callback_conference_message(tox, tox_events_handle_conference_message);
33
1.21k
    tox_callback_conference_peer_list_changed(tox, tox_events_handle_conference_peer_list_changed);
34
1.21k
    tox_callback_conference_peer_name(tox, tox_events_handle_conference_peer_name);
35
1.21k
    tox_callback_conference_title(tox, tox_events_handle_conference_title);
36
1.21k
    tox_callback_file_chunk_request(tox, tox_events_handle_file_chunk_request);
37
1.21k
    tox_callback_file_recv_chunk(tox, tox_events_handle_file_recv_chunk);
38
1.21k
    tox_callback_file_recv_control(tox, tox_events_handle_file_recv_control);
39
1.21k
    tox_callback_file_recv(tox, tox_events_handle_file_recv);
40
1.21k
    tox_callback_friend_connection_status(tox, tox_events_handle_friend_connection_status);
41
1.21k
    tox_callback_friend_lossless_packet(tox, tox_events_handle_friend_lossless_packet);
42
1.21k
    tox_callback_friend_lossy_packet(tox, tox_events_handle_friend_lossy_packet);
43
1.21k
    tox_callback_friend_message(tox, tox_events_handle_friend_message);
44
1.21k
    tox_callback_friend_name(tox, tox_events_handle_friend_name);
45
1.21k
    tox_callback_friend_read_receipt(tox, tox_events_handle_friend_read_receipt);
46
1.21k
    tox_callback_friend_request(tox, tox_events_handle_friend_request);
47
1.21k
    tox_callback_friend_status_message(tox, tox_events_handle_friend_status_message);
48
1.21k
    tox_callback_friend_status(tox, tox_events_handle_friend_status);
49
1.21k
    tox_callback_friend_typing(tox, tox_events_handle_friend_typing);
50
1.21k
    tox_callback_self_connection_status(tox, tox_events_handle_self_connection_status);
51
1.21k
    tox_callback_group_peer_name(tox, tox_events_handle_group_peer_name);
52
1.21k
    tox_callback_group_peer_status(tox, tox_events_handle_group_peer_status);
53
1.21k
    tox_callback_group_topic(tox, tox_events_handle_group_topic);
54
1.21k
    tox_callback_group_privacy_state(tox, tox_events_handle_group_privacy_state);
55
1.21k
    tox_callback_group_voice_state(tox, tox_events_handle_group_voice_state);
56
1.21k
    tox_callback_group_topic_lock(tox, tox_events_handle_group_topic_lock);
57
1.21k
    tox_callback_group_peer_limit(tox, tox_events_handle_group_peer_limit);
58
1.21k
    tox_callback_group_password(tox, tox_events_handle_group_password);
59
1.21k
    tox_callback_group_message(tox, tox_events_handle_group_message);
60
1.21k
    tox_callback_group_private_message(tox, tox_events_handle_group_private_message);
61
1.21k
    tox_callback_group_custom_packet(tox, tox_events_handle_group_custom_packet);
62
1.21k
    tox_callback_group_custom_private_packet(tox, tox_events_handle_group_custom_private_packet);
63
1.21k
    tox_callback_group_invite(tox, tox_events_handle_group_invite);
64
1.21k
    tox_callback_group_peer_join(tox, tox_events_handle_group_peer_join);
65
1.21k
    tox_callback_group_peer_exit(tox, tox_events_handle_group_peer_exit);
66
1.21k
    tox_callback_group_self_join(tox, tox_events_handle_group_self_join);
67
1.21k
    tox_callback_group_join_fail(tox, tox_events_handle_group_join_fail);
68
1.21k
    tox_callback_group_moderation(tox, tox_events_handle_group_moderation);
69
1.21k
    tox_callback_dht_nodes_response(tox, tox_events_handle_dht_nodes_response);
70
1.21k
}
71
72
uint32_t tox_events_get_size(const Tox_Events *events)
73
114k
{
74
114k
    return events == nullptr ? 0 : events->events_size;
75
114k
}
76
77
static const Tox_Event *tox_events_get_events(const Tox_Events *_Nullable events)
78
3.20k
{
79
3.20k
    return events == nullptr ? nullptr : events->events;
80
3.20k
}
81
82
const Tox_Event *tox_events_get(const Tox_Events *events, uint32_t index)
83
5
{
84
5
    if (index >= tox_events_get_size(events)) {
85
0
        return nullptr;
86
0
    }
87
88
5
    return &events->events[index];
89
5
}
90
91
Tox_Events *tox_events_iterate(Tox *tox, bool fail_hard, Tox_Err_Events_Iterate *error)
92
113k
{
93
113k
    const Tox_System *sys = tox_get_system(tox);
94
113k
    Tox_Events_State state = {TOX_ERR_EVENTS_ITERATE_OK, sys->mem};
95
113k
    tox_iterate(tox, &state);
96
97
113k
    if (error != nullptr) {
98
110k
        *error = state.error;
99
110k
    }
100
101
113k
    if (fail_hard && state.error != TOX_ERR_EVENTS_ITERATE_OK) {
102
137
        tox_events_free(state.events);
103
137
        return nullptr;
104
137
    }
105
106
113k
    return state.events;
107
113k
}
108
109
static bool tox_event_pack_handler(const void *_Nonnull arr, uint32_t index, const Logger *_Nonnull logger, Bin_Pack *_Nonnull bp)
110
1.89k
{
111
1.89k
    const Tox_Event *events = (const Tox_Event *)arr;
112
1.89k
    assert(events != nullptr);
113
1.89k
    return tox_event_pack(&events[index], bp);
114
1.89k
}
115
116
static bool tox_events_pack_handler(const void *_Nullable obj, const Logger *_Nullable logger, Bin_Pack *_Nonnull bp)
117
3.20k
{
118
3.20k
    const Tox_Events *events = (const Tox_Events *)obj;
119
3.20k
    return bin_pack_obj_array(bp, tox_event_pack_handler, tox_events_get_events(events), tox_events_get_size(events), logger);
120
3.20k
}
121
122
uint32_t tox_events_bytes_size(const Tox_Events *events)
123
1.39k
{
124
1.39k
    return bin_pack_obj_size(tox_events_pack_handler, events, nullptr);
125
1.39k
}
126
127
bool tox_events_get_bytes(const Tox_Events *events, uint8_t *bytes)
128
1.80k
{
129
1.80k
    return bin_pack_obj(tox_events_pack_handler, events, nullptr, bytes, UINT32_MAX);
130
1.80k
}
131
132
static bool tox_events_unpack_handler(void *_Nonnull obj, Bin_Unpack *_Nonnull bu)
133
1.08k
{
134
1.08k
    Tox_Events *events = (Tox_Events *)obj;
135
136
1.08k
    uint32_t size;
137
1.08k
    if (!bin_unpack_array(bu, &size)) {
138
65
        return false;
139
65
    }
140
141
2.35k
    for (uint32_t i = 0; i < size; ++i) {
142
1.76k
        Tox_Event event = {TOX_EVENT_INVALID};
143
1.76k
        if (!tox_event_unpack_into(&event, bu, events->mem)) {
144
425
            tox_event_destruct(&event, events->mem);
145
425
            return false;
146
425
        }
147
148
1.33k
        if (!tox_events_add(events, &event)) {
149
1
            tox_event_destruct(&event, events->mem);
150
1
            return false;
151
1
        }
152
1.33k
    }
153
154
    // Invariant: if all adds worked, the events size must be the input array size.
155
595
    assert(tox_events_get_size(events) == size);
156
595
    return true;
157
595
}
158
159
Tox_Events *tox_events_load(const Tox_System *sys, const uint8_t *bytes, uint32_t bytes_size)
160
1.08k
{
161
1.08k
    Tox_Events *events = (Tox_Events *)mem_alloc(sys->mem, sizeof(Tox_Events));
162
163
1.08k
    if (events == nullptr) {
164
1
        return nullptr;
165
1
    }
166
167
1.08k
    *events = (Tox_Events) {
168
1.08k
        nullptr
169
1.08k
    };
170
1.08k
    events->mem = sys->mem;
171
172
1.08k
    if (!bin_unpack_obj(sys->mem, tox_events_unpack_handler, events, bytes, bytes_size)) {
173
491
        tox_events_free(events);
174
491
        return nullptr;
175
491
    }
176
177
595
    return events;
178
1.08k
}
179
180
bool tox_events_equal(const Tox_System *sys, const Tox_Events *a, const Tox_Events *b)
181
402
{
182
402
    assert(sys != nullptr);
183
402
    assert(sys->mem != nullptr);
184
185
402
    const uint32_t a_size = tox_events_bytes_size(a);
186
402
    const uint32_t b_size = tox_events_bytes_size(b);
187
188
402
    if (a_size != b_size) {
189
0
        return false;
190
0
    }
191
192
402
    uint8_t *a_bytes = (uint8_t *)mem_balloc(sys->mem, a_size);
193
402
    uint8_t *b_bytes = (uint8_t *)mem_balloc(sys->mem, b_size);
194
195
402
    if (a_bytes == nullptr || b_bytes == nullptr) {
196
0
        mem_delete(sys->mem, b_bytes);
197
0
        mem_delete(sys->mem, a_bytes);
198
0
        return false;
199
0
    }
200
201
402
    tox_events_get_bytes(a, a_bytes);
202
402
    tox_events_get_bytes(b, b_bytes);
203
204
402
    const bool ret = memcmp(a_bytes, b_bytes, a_size) == 0;
205
206
402
    mem_delete(sys->mem, b_bytes);
207
402
    mem_delete(sys->mem, a_bytes);
208
209
402
    return ret;
210
402
}