Files
cproof/src/plugins/api.h
Jabber Developer 72f4f186da
All checks were successful
CI Code / Check spelling (push) Successful in 18s
CI Code / Check coding style (push) Successful in 34s
CI Code / Code Coverage (push) Successful in 2m36s
CI Code / Linux (debian) (push) Successful in 4m41s
CI Code / Linux (ubuntu) (push) Successful in 4m52s
CI Code / Linux (arch) (push) Successful in 5m40s
merge: sync upstream profanity-im/profanity
Sync with upstream profanity-im/profanity.

Major upstream changes incorporated:

Memory management
  - Replace malloc+memset with g_new0 throughout codebase
  - Adopt auto_gchar / auto_gcharv / auto_gerror / auto_jid cleanup macros
  - Replace free() with g_free() for GAlloc'd memory

Editor rewrite
  - Remove pthread-based async editor; use GChildWatch callback API
  - New launch_editor(initial_content, callback, user_data) interface
  - Proper signal handling (SIGINT, SIGTSTP, SIGPIPE reset in child)
  - ui_suspend()/ui_resume() integration for TTY management

OMEMO improvements
  - Dual backend support: libsignal-protocol-c and libomemo-c
  - Proper pre-key removal after use (XEP-0384 compliance)
  - Automatic pre-key regeneration when store drops below threshold
  - New functions: omemo_is_device_active(), omemo_is_jid_trusted()
  - omemo_get_jid_untrusted_fingerprints() for better error messages
  - Fingerprint notifications on new device identity discovery
  - Deterministic pre-key ID generation tracking max_pre_key_id
  - omemo_trust_changed() UI updates on trust state changes

JID validation
  - RFC 6122-compliant validation in jid_is_valid()
  - Character-level checks (RFC 6122 forbidden chars: & ' / : < > @)
  - Length limits: 1023 per component, 3071 total
  - New jid_is_valid_user_jid() for user vs. service JID distinction

Database
  - Schema migration v3: UNIQUE constraint on archive_id for deduplication
  - Triggers for corrected message tracking (replaces_db_id / replaced_by_db_id)
  - db_history_result_t return type, _truncate_datetime_suffix()

UI / console
  - win_warn_needed() / win_warn_sent() warning deduplication hash table
  - PAD_MIN_HEIGHT dynamic pad sizing with PAD_THRESHOLD auto-cleanup
  - Spellcheck integration in input field with Unicode word detection
  - cons_spellcheck_setting() for /settings ui output
  - /[command]? shortcut for command help

Account config
  - Account name sanitization for GKeyFile special chars ([ ] = # \n \r)
  - Replace popen() with g_spawn_sync() for eval_password
  - TLS policy: add "direct" option alongside legacy

Connection
  - Port validation with g_assert (0–65535)
  - SHA-256 certificate fingerprint support (XMPP_CERT_PUBKEY_FINGERPRINT_SHA256)
  - "direct" TLS policy alias for legacy SSL

Common utilities
  - str_xml_sanitize() for XML 1.0 illegal character removal
  - string_matches_one_of() with formatted error messages
  - valid_tls_policy_option() helper
  - prof_date_time_format_iso8601() utility
  - Improved strip_arg_quotes() with backslash unescaping
  - prof_occurrences() uses g_slist_prepend + reverse for performance

PGP / OX
  - Proper GPGME resource cleanup with goto-cleanup pattern
  - g_string_free(xmppuri) leak fix in _ox_key_lookup

CSV export
  - Use GString + g_file_set_contents instead of raw write() syscalls

Tests
  - Restructured into subdirectories: command/, config/, xmpp/, ui/, omemo/, otr/, pgp/
  - New test_cmd_ac.c for autocompleter unit tests
  - Updated stubs for new UI suspend/resume functions

License headers
  - Migrate to SPDX-3.0 identifiers (GPL-3.0-or-later WITH OpenSSL-exception)

────────────────────────────────────────────────────
cproof-specific preservations:

  - XEP-0308 LMC: replace_id ?: id logic in message/stanza/omemo
  - Force encryption: cmd_force_encryption, test_forced_encryption
  - CWE-134: format string protection (cons_show("%s", ...))
  - y_start_pos-based paging in window.c
  - db_history_result_t return type, _truncate_datetime_suffix()

Merge-time fixes:

  - common.c: format-security (-Werror) — cons_show(errmsg) → cons_show("%s", errmsg)
  - database.c: null-deref guard — !msg->timestamp → msg && !msg->timestamp
  - console.c: implicit size_t → int cast — (int)(maxlen + 1)
  - tlscerts.c: %d for size_t — %zu

Build system:
  - Kept autotools (Makefile.am, configure.ac); upstream uses Meson
  - Restored deleted files: bootstrap.sh, autogen.sh, ax_valgrind_check.m4, configure-debug
  - Updated Makefile.am test paths for subdirectory structure
  - Added test_cmd_ac, test_forced_encryption to test sources

Functional tests:
  - Use cproof version; upstream requires stbbr_for_xmlns from updated stabber
  - Not yet available in devs/stabber fork

Closes #64

Merge author: jabber.developer2
Commits authors:
 Michael Vetter <jubalh@iodoru.org>
& Steffen Jaeckel <s@jaeckel.eu>
2026-05-26 17:48:14 +00:00

99 lines
5.0 KiB
C

/*
* api.h
* vim: expandtab:ts=4:sts=4:sw=4
*
* Copyright (C) 2012 - 2019 James Booth <boothj5@gmail.com>
*
* SPDX-License-Identifier: GPL-3.0-or-later WITH OpenSSL-exception
*/
#ifndef PLUGINS_API_H
#define PLUGINS_API_H
#include "plugins/callbacks.h"
void api_cons_alert(void);
int api_cons_show(const char* const message);
int api_cons_show_themed(const char* const group, const char* const item, const char* const def, const char* const message);
int api_cons_bad_cmd_usage(const char* const cmd);
void api_notify(const char* message, const char* category, int timeout_ms);
void api_send_line(char* line);
char* api_get_current_recipient(void);
gchar* api_get_current_window(void);
char* api_get_current_muc(void);
gboolean api_current_win_is_console(void);
char* api_get_current_nick(void);
char* api_get_name_from_roster(const char* barejid);
char* api_get_barejid_from_roster(const char* name);
char** api_get_current_occupants(void);
char* api_get_room_nick(const char* barejid);
void api_register_command(const char* const plugin_name, const char* command_name, int min_args, int max_args,
char** synopsis, const char* description, char* arguments[][2], char** examples,
void* callback, void (*callback_func)(PluginCommand* command, gchar** args), void (*callback_destroy)(void* callback));
void api_register_timed(const char* const plugin_name, void* callback, int interval_seconds,
void (*callback_func)(PluginTimedFunction* timed_function), void (*callback_destroy)(void* callback));
void api_completer_add(const char* const plugin_name, const char* key, char** items);
void api_completer_remove(const char* const plugin_name, const char* key, char** items);
void api_completer_clear(const char* const plugin_name, const char* key);
void api_filepath_completer_add(const char* const plugin_name, const char* prefix);
void api_log_debug(const char* message);
void api_log_info(const char* message);
void api_log_warning(const char* message);
void api_log_error(const char* message);
int api_win_exists(const char* tag);
void api_win_create(
const char* const plugin_name,
const char* tag,
void* callback,
void (*callback_func)(PluginWindowCallback* window_callback, char* tag, char* line),
void (*destroy)(void* callback));
int api_win_focus(const char* tag);
int api_win_show(const char* tag, const char* line);
int api_win_show_themed(const char* tag, const char* const group, const char* const key, const char* const def, const char* line);
int api_send_stanza(const char* const stanza);
gboolean api_settings_boolean_get(const char* const group, const char* const key, gboolean def);
void api_settings_boolean_set(const char* const group, const char* const key, gboolean value);
char* api_settings_string_get(const char* const group, const char* const key, const char* const def);
void api_settings_string_set(const char* const group, const char* const key, const char* const value);
int api_settings_int_get(const char* const group, const char* const key, int def);
void api_settings_int_set(const char* const group, const char* const key, int value);
char** api_settings_string_list_get(const char* const group, const char* const key);
void api_settings_string_list_add(const char* const group, const char* const key, const char* const value);
int api_settings_string_list_remove(const char* const group, const char* const key, const char* const value);
int api_settings_string_list_clear(const char* const group, const char* const key);
void api_incoming_message(const char* const barejid, const char* const resource, const char* const message);
void api_disco_add_feature(char* plugin_name, char* feature);
void api_encryption_reset(const char* const barejid);
int api_chat_set_titlebar_enctext(const char* const barejid, const char* const enctext);
int api_chat_unset_titlebar_enctext(const char* const barejid);
int api_chat_set_incoming_char(const char* const barejid, const char* const ch);
int api_chat_unset_incoming_char(const char* const barejid);
int api_chat_set_outgoing_char(const char* const barejid, const char* const ch);
int api_chat_unset_outgoing_char(const char* const barejid);
int api_room_set_titlebar_enctext(const char* const roomjid, const char* const enctext);
int api_room_unset_titlebar_enctext(const char* const roomjid);
int api_room_set_message_char(const char* const roomjid, const char* const ch);
int api_room_unset_message_char(const char* const roomjid);
int api_chat_show(const char* const barejid, const char* const message);
int api_chat_show_themed(const char* const barejid, const char* const group, const char* const key, const char* const def,
const char* const ch, const char* const message);
int api_room_show(const char* const roomjid, const char* message);
int api_room_show_themed(const char* const roomjid, const char* const group, const char* const key, const char* const def,
const char* const ch, const char* const message);
#endif