tomato-testing/toxcore/tox_events.c
Green Sky aae086cc65 Squashed 'external/toxcore/c-toxcore/' changes from e2c01e457b..b03b571272
b03b571272 fix: flaky tcp test This only fixes the symptoms, not the real problem. Sometimes or consistently on some platforms a socket might need a moment before it can be written to.
32e67ab4c2 cleanup: use typedef for private message ID's in callback
7b1db6adc1 feat: add message IDs to private group messages
99e0bcc27d refactor: Observers/ignored peers can now send and receive custom packets
b3c3c49d26 fix: Disable IPv6 in Windows cross-compilation tests
e742deddff feat: Check hashes of Windows dependencies when cross-compiling
dfb9a0b02b fix: Test the current Windows Dockerfile, not an old Dockerhub image
14de93ccec chore: Use WineHQ's Wine as Debian Bookworm's crashes
ed37616249 docs: Update the Windows cross-compilation section
9bb79c174f cleanup: Remove a couple of unnecessary misc_tools dependencies
19475adb70 chore: Statically link OpenMP into the cracker fun util on Windows
1be311e51f feat: Build the fun utils when cross-compiling to Windows
88133f8446 chore: Strip Windows binaries
3cc0ae7535 refactor: Copy over all of the required static dependencies
c4fa8f7fb1 feat: Generate .def, .exp and .lib files when building for Windows
74bbac5363 feat: Let CMake create the dll instead of doing so ourselves
246642e9ae feat: Harden Windows cross-compilation
8d431c0d11 chore: Bump Windows build dependency versions
e519f7998b fix: Remove unnecessary wsock32 dependency on Windows
ed2b60c217 chore: Use a specific non-broken slimcc version.
d7f21010a1 chore: Update github actions.
e71a68b7f2 docs: Update the list of CMake options
77e08876ff chore: Remove mod and founder from group API naming scheme
12bc042767 docs: add the experimental api build option to INSTALL.md
e1fa5cae96 refactor: Rename Queries to Query to align with other enums.
be82a3ea30 fix: Correct type for conference offline peer numbers.
0627c36716 test: Add pkgsrc build.
92578afe4b test: Add FreeBSD VM action on GitHub.
52ece0f57b test: Build toxcore on NetBSD (VM).
3fe8ee2c11 chore: Only install tox_private.h on request.
9a8dfa06ab fix: save_compatibility_test failing on big-endian systems
86f5e55578 fix: Don't serve files from websockify.
710eb674a5 fix: Correctly pass extended public keys to group moderation code.
021db7031c refactor: Use `struct`s for extended public/secret keys.
a1e999fd80 chore: Compile libsodium reference implementation with compcert.
fbe3c19cf5 cleanup: correct a few nullable annotations
623e3ee5c3 cleanup: Don't use `memcpy` to cast arbitrary `struct`s to `uint8_t[]`.
c71567dc18 fix: Pass array, not array pointer, to `memcmp`.
9b46a08144 cleanup: Never pass `void*` directly to `memcpy`.
5d7b7a7bbc refactor: Use tox rng to seed the keypair generation.
961891d568 cleanup: Small improvements found by PVS Studio.
8201019f0d chore: Disable NGC saving by default, enable through Tox_Options.
5dd9ee3f65 cleanup: Replace pointer arithmetic with explicit `&arr[i]`.
ca4606d49d refactor: Use strong typedef for NGC peer id.
442213b722 cleanup: Simplify custom packet length check in NGC.
08d3393def fix: Correct a few potential null derefs in bootstrap daemon.
b9877b32b0 fix: Add missing memunlock of local variable when it goes out of scope.
dab5fe44b9 fix: Zero out stack-allocated secret key before return.
f058103299 refactor: Make prune_gc_sanctions_list more obviously correct.
3ba7a0dec9 docs: Add static analysis tool list to README.
8d0811a0f3 docs: Run prettier-markdown on markdown files.
969e3a2bfc refactor: Fix network test not using the strong typedef
93c83fbc7c refactor: Use strong typedef instead of struct for `Socket`.
9fe18b176f fix: Fix some false positive from PVS Studio.
7c44379ccb cleanup: Check that WINXP macro exists before comparing it.
5c93231bef refactor: Make tox mutex non-recursive.
aacff73939 docs: Fix up doxyfile.
d55fc85ff5 docs: Add more documentation to crypto_core.
5bdaaaedb6 refactor: Remove `Tox *` from `tox_dispatch`.
e202341e76 refactor: Don't rely on tox_dispatch passing tox in tests.
34df938f52 chore: Use C++ mode for clang-tidy.
8b05296a78 chore: Check that both gtest and gmock exist for tests.
42010660e1 test: Add slimcc compiler compatibility test.
b473630321 chore: Add some comments to the astyle config.
b7404f24f6 cleanup: Remove implicit bool conversions.
4e2dba4d9f chore: Reformat sources with astyle.
4359e3a6bc chore: Rename C++ headers to .hh suffixes.
0c05566e58 cleanup: Further `#include` cleanups.
8d29935b7a chore: Only check the bootstrap daemon checksum on release.
f70e588bc6 cleanup: Add more `const` where possible.
511bfe39c8 cleanup: Use Bazel modules to enforce proper `#include` hygiene.
1710a0d091 refactor: Move pack/unpack `IP_Port` from DHT into network module.
a975943564 chore: Really fix coverage docker image build.
c08409390f chore: Fix post-submit coverage image.
39aadf8922 fix: Don't use `memcmp` to compare `IP_Port`s.
d94246a906 fix: partially fix a bug that prevented group part messages from sending.
eeaa039222 chore: Fix rpm build; add a CI check for it.
8328449c1a chore: Speed up docker builds a bit by reducing layer count.
d6d67d56f3 cleanup: Add `const` where possible in auto tests.
6aa9e6850d cleanup: Minor cleanup of event unpack code.
bdf460a3a9 refactor: Rename `system_{memory,...}` to `os_{memory,...}`.
203e1af81e fix: a few off by one errors in group autotests
5c093c4888 cleanup: Remove all uses of `SIZEOF_VLA`.
662c2140f3 test: Add goblint static analyser.
8f07755834 cleanup: Use `memzero(x, s)` instead of `memset(x, 0, s)`.
a7258e40cf cleanup: Use explicit 0 instead of `PACKET_ID_PADDING`.
6370d0f15d cleanup: Expand the `Tox_Options` accessor macros.
14a1a0b9bd cleanup: Remove plan9 support.
a05dccad13 test: Add a simple new/delete test for Tox.
1cdcf938b9 cleanup: Add comment after every `#endif`.
ba99d4dc4b test: Fix comment I broke in the events test PR.
e07248debb refactor: Migrate auto_tests to new events API.
bdd42b5452 refactor: Add common msgpack array packer with callback.
3c659f5288 cleanup: Rename group to conference in groupav documentation.
89957be230 cleanup: Ensure handler params are named after callback params.
c650d9d345 refactor: Pass `this` pointer as first param to s11n callbacks.
e7fb91ddb8 refactor: Allow NULL pointers for byte arrays in events.
5e2c8cabc1 cleanup: make some improvements to group moderation test
259de4867e cleanup: Remove `bin_pack_{new,free}`.
21a8ff5895 cleanup: skip a do_gc iteration before removing peers marked for deletion
16809dc36e feat: Add dht_get_nodes_response event to the events system.

git-subtree-dir: external/toxcore/c-toxcore
git-subtree-split: b03b5712720de9a9901ea12fd741f177327a7021
2024-03-07 23:12:55 +01:00

215 lines
7.4 KiB
C

/* SPDX-License-Identifier: GPL-3.0-or-later
* Copyright © 2022-2024 The TokTok team.
*/
#include "tox_events.h"
#include <assert.h>
#include <string.h>
#include "attributes.h"
#include "bin_pack.h"
#include "bin_unpack.h"
#include "ccompat.h"
#include "events/events_alloc.h"
#include "logger.h"
#include "mem.h"
#include "tox.h"
#include "tox_event.h"
#include "tox_private.h"
#include "tox_struct.h"
/*****************************************************
*
* :: Set up event handlers.
*
*****************************************************/
void tox_events_init(Tox *tox)
{
tox_callback_conference_connected(tox, tox_events_handle_conference_connected);
tox_callback_conference_invite(tox, tox_events_handle_conference_invite);
tox_callback_conference_message(tox, tox_events_handle_conference_message);
tox_callback_conference_peer_list_changed(tox, tox_events_handle_conference_peer_list_changed);
tox_callback_conference_peer_name(tox, tox_events_handle_conference_peer_name);
tox_callback_conference_title(tox, tox_events_handle_conference_title);
tox_callback_file_chunk_request(tox, tox_events_handle_file_chunk_request);
tox_callback_file_recv_chunk(tox, tox_events_handle_file_recv_chunk);
tox_callback_file_recv_control(tox, tox_events_handle_file_recv_control);
tox_callback_file_recv(tox, tox_events_handle_file_recv);
tox_callback_friend_connection_status(tox, tox_events_handle_friend_connection_status);
tox_callback_friend_lossless_packet(tox, tox_events_handle_friend_lossless_packet);
tox_callback_friend_lossy_packet(tox, tox_events_handle_friend_lossy_packet);
tox_callback_friend_message(tox, tox_events_handle_friend_message);
tox_callback_friend_name(tox, tox_events_handle_friend_name);
tox_callback_friend_read_receipt(tox, tox_events_handle_friend_read_receipt);
tox_callback_friend_request(tox, tox_events_handle_friend_request);
tox_callback_friend_status_message(tox, tox_events_handle_friend_status_message);
tox_callback_friend_status(tox, tox_events_handle_friend_status);
tox_callback_friend_typing(tox, tox_events_handle_friend_typing);
tox_callback_self_connection_status(tox, tox_events_handle_self_connection_status);
tox_callback_group_peer_name(tox, tox_events_handle_group_peer_name);
tox_callback_group_peer_status(tox, tox_events_handle_group_peer_status);
tox_callback_group_topic(tox, tox_events_handle_group_topic);
tox_callback_group_privacy_state(tox, tox_events_handle_group_privacy_state);
tox_callback_group_voice_state(tox, tox_events_handle_group_voice_state);
tox_callback_group_topic_lock(tox, tox_events_handle_group_topic_lock);
tox_callback_group_peer_limit(tox, tox_events_handle_group_peer_limit);
tox_callback_group_password(tox, tox_events_handle_group_password);
tox_callback_group_message(tox, tox_events_handle_group_message);
tox_callback_group_private_message(tox, tox_events_handle_group_private_message);
tox_callback_group_custom_packet(tox, tox_events_handle_group_custom_packet);
tox_callback_group_custom_private_packet(tox, tox_events_handle_group_custom_private_packet);
tox_callback_group_invite(tox, tox_events_handle_group_invite);
tox_callback_group_peer_join(tox, tox_events_handle_group_peer_join);
tox_callback_group_peer_exit(tox, tox_events_handle_group_peer_exit);
tox_callback_group_self_join(tox, tox_events_handle_group_self_join);
tox_callback_group_join_fail(tox, tox_events_handle_group_join_fail);
tox_callback_group_moderation(tox, tox_events_handle_group_moderation);
tox_callback_dht_get_nodes_response(tox, tox_events_handle_dht_get_nodes_response);
}
uint32_t tox_events_get_size(const Tox_Events *events)
{
return events == nullptr ? 0 : events->events_size;
}
nullable(1)
static const Tox_Event *tox_events_get_events(const Tox_Events *events)
{
return events == nullptr ? nullptr : events->events;
}
const Tox_Event *tox_events_get(const Tox_Events *events, uint32_t index)
{
if (index >= tox_events_get_size(events)) {
return nullptr;
}
return &events->events[index];
}
Tox_Events *tox_events_iterate(Tox *tox, bool fail_hard, Tox_Err_Events_Iterate *error)
{
const Tox_System *sys = tox_get_system(tox);
Tox_Events_State state = {TOX_ERR_EVENTS_ITERATE_OK, sys->mem};
tox_iterate(tox, &state);
if (error != nullptr) {
*error = state.error;
}
if (fail_hard && state.error != TOX_ERR_EVENTS_ITERATE_OK) {
tox_events_free(state.events);
return nullptr;
}
return state.events;
}
non_null()
static bool tox_event_pack_handler(const void *arr, uint32_t index, const Logger *logger, Bin_Pack *bp)
{
const Tox_Event *events = (const Tox_Event *)arr;
assert(events != nullptr);
return tox_event_pack(&events[index], bp);
}
non_null(3) nullable(1, 2)
static bool tox_events_pack_handler(const void *obj, const Logger *logger, Bin_Pack *bp)
{
const Tox_Events *events = (const Tox_Events *)obj;
return bin_pack_obj_array(bp, tox_event_pack_handler, tox_events_get_events(events), tox_events_get_size(events), logger);
}
uint32_t tox_events_bytes_size(const Tox_Events *events)
{
return bin_pack_obj_size(tox_events_pack_handler, events, nullptr);
}
bool tox_events_get_bytes(const Tox_Events *events, uint8_t *bytes)
{
return bin_pack_obj(tox_events_pack_handler, events, nullptr, bytes, UINT32_MAX);
}
non_null()
static bool tox_events_unpack_handler(void *obj, Bin_Unpack *bu)
{
Tox_Events *events = (Tox_Events *)obj;
uint32_t size;
if (!bin_unpack_array(bu, &size)) {
return false;
}
for (uint32_t i = 0; i < size; ++i) {
Tox_Event event = {TOX_EVENT_INVALID};
if (!tox_event_unpack_into(&event, bu, events->mem)) {
tox_event_destruct(&event, events->mem);
return false;
}
if (!tox_events_add(events, &event)) {
tox_event_destruct(&event, events->mem);
return false;
}
}
// Invariant: if all adds worked, the events size must be the input array size.
assert(tox_events_get_size(events) == size);
return true;
}
Tox_Events *tox_events_load(const Tox_System *sys, const uint8_t *bytes, uint32_t bytes_size)
{
Tox_Events *events = (Tox_Events *)mem_alloc(sys->mem, sizeof(Tox_Events));
if (events == nullptr) {
return nullptr;
}
*events = (Tox_Events) {
nullptr
};
events->mem = sys->mem;
if (!bin_unpack_obj(tox_events_unpack_handler, events, bytes, bytes_size)) {
tox_events_free(events);
return nullptr;
}
return events;
}
bool tox_events_equal(const Tox_System *sys, const Tox_Events *a, const Tox_Events *b)
{
assert(sys != nullptr);
assert(sys->mem != nullptr);
const uint32_t a_size = tox_events_bytes_size(a);
const uint32_t b_size = tox_events_bytes_size(b);
if (a_size != b_size) {
return false;
}
uint8_t *a_bytes = (uint8_t *)mem_balloc(sys->mem, a_size);
uint8_t *b_bytes = (uint8_t *)mem_balloc(sys->mem, b_size);
if (a_bytes == nullptr || b_bytes == nullptr) {
mem_delete(sys->mem, b_bytes);
mem_delete(sys->mem, a_bytes);
return false;
}
tox_events_get_bytes(a, a_bytes);
tox_events_get_bytes(b, b_bytes);
const bool ret = memcmp(a_bytes, b_bytes, a_size) == 0;
mem_delete(sys->mem, b_bytes);
mem_delete(sys->mem, a_bytes);
return ret;
}