jabber.developer2
b88d6216cf
Split the monolithic database_flatfile.c into: - database_flatfile.h: internal header with shared types and prototypes - database_flatfile_parser.c: parsing, escaping, IO helpers - database_flatfile_verify.c: integrity verification logic - database_flatfile.c: core backend (init, write, read, LMC, vtable)
379 lines
15 KiB
C
379 lines
15 KiB
C
/*
|
|
* database_flatfile_verify.c
|
|
* vim: expandtab:ts=4:sts=4:sw=4
|
|
*
|
|
* Copyright (C) 2026 Profanity Contributors
|
|
*
|
|
* This file is part of Profanity.
|
|
*
|
|
* Profanity 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.
|
|
*
|
|
* Profanity 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 Profanity. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
* Flat-file backend: integrity verification (/history verify).
|
|
* Checks: parsability, timestamp ordering, duplicate IDs, broken LMC
|
|
* references, file permissions, BOM, CRLF, UTF-8, control chars.
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include <sys/stat.h>
|
|
#include <glib.h>
|
|
#include <glib/gstdio.h>
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
|
|
#include "log.h"
|
|
#include "config/files.h"
|
|
#include "database_flatfile.h"
|
|
|
|
GSList*
|
|
ff_verify_integrity(const gchar* const contact_barejid)
|
|
{
|
|
GSList* issues = NULL;
|
|
|
|
if (!g_flatfile_account_jid) {
|
|
integrity_issue_t* issue = g_malloc0(sizeof(integrity_issue_t));
|
|
issue->level = INTEGRITY_ERROR;
|
|
issue->file = g_strdup("N/A");
|
|
issue->line = 0;
|
|
issue->message = g_strdup("Flat-file backend not initialized");
|
|
issues = g_slist_append(issues, issue);
|
|
return issues;
|
|
}
|
|
|
|
// If contact specified, verify just that contact; otherwise discover all contacts
|
|
GSList* contact_dirs = NULL;
|
|
|
|
if (contact_barejid) {
|
|
auto_gchar gchar* cdir = ff_get_contact_dir(contact_barejid);
|
|
if (cdir && g_file_test(cdir, G_FILE_TEST_IS_DIR)) {
|
|
contact_dirs = g_slist_append(contact_dirs, g_strdup(cdir));
|
|
} else {
|
|
integrity_issue_t* issue = g_malloc0(sizeof(integrity_issue_t));
|
|
issue->level = INTEGRITY_INFO;
|
|
issue->file = g_strdup(contact_barejid);
|
|
issue->line = 0;
|
|
issue->message = g_strdup("No log files found for this contact");
|
|
issues = g_slist_append(issues, issue);
|
|
return issues;
|
|
}
|
|
} else {
|
|
// Discover all contact directories
|
|
auto_gchar gchar* data_path = files_get_data_path(DIR_FLATLOG);
|
|
auto_gchar gchar* my_dir = ff_jid_to_dir(g_flatfile_account_jid);
|
|
auto_gchar gchar* base_dir = g_strdup_printf("%s/%s", data_path, my_dir);
|
|
|
|
GDir* dir = g_dir_open(base_dir, 0, NULL);
|
|
if (dir) {
|
|
const gchar* dname;
|
|
while ((dname = g_dir_read_name(dir)) != NULL) {
|
|
char* full = g_strdup_printf("%s/%s", base_dir, dname);
|
|
if (g_file_test(full, G_FILE_TEST_IS_DIR)) {
|
|
contact_dirs = g_slist_append(contact_dirs, full);
|
|
} else {
|
|
g_free(full);
|
|
}
|
|
}
|
|
g_dir_close(dir);
|
|
}
|
|
}
|
|
|
|
// Verify each contact directory
|
|
for (GSList* cd = contact_dirs; cd; cd = cd->next) {
|
|
const char* cdir_path = cd->data;
|
|
|
|
GDir* dir = g_dir_open(cdir_path, 0, NULL);
|
|
if (!dir)
|
|
continue;
|
|
|
|
GSList* log_files = NULL;
|
|
const gchar* fname;
|
|
while ((fname = g_dir_read_name(dir)) != NULL) {
|
|
if (g_str_has_suffix(fname, ".log")) {
|
|
log_files = g_slist_insert_sorted(log_files,
|
|
g_strdup_printf("%s/%s", cdir_path, fname),
|
|
(GCompareFunc)g_strcmp0);
|
|
}
|
|
}
|
|
g_dir_close(dir);
|
|
|
|
GDateTime* prev_file_last_ts = NULL;
|
|
GHashTable* seen_ids = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, NULL);
|
|
GHashTable* all_stanza_ids = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, NULL);
|
|
|
|
for (GSList* lf = log_files; lf; lf = lf->next) {
|
|
const char* filepath = lf->data;
|
|
const char* basename = strrchr(filepath, '/');
|
|
basename = basename ? basename + 1 : filepath;
|
|
|
|
// Check file permissions
|
|
struct stat st;
|
|
if (g_stat(filepath, &st) == 0) {
|
|
if ((st.st_mode & 0777) != (S_IRUSR | S_IWUSR)) {
|
|
integrity_issue_t* issue = g_malloc0(sizeof(integrity_issue_t));
|
|
issue->level = INTEGRITY_WARNING;
|
|
issue->file = g_strdup(basename);
|
|
issue->line = 0;
|
|
issue->message = g_strdup_printf("File permissions are %o, expected 600 (sensitive data)", st.st_mode & 0777);
|
|
issues = g_slist_append(issues, issue);
|
|
}
|
|
}
|
|
|
|
FILE* fp = fopen(filepath, "r");
|
|
if (!fp)
|
|
continue;
|
|
|
|
// BOM check
|
|
int c1 = fgetc(fp);
|
|
int c2 = fgetc(fp);
|
|
int c3 = fgetc(fp);
|
|
if (c1 == 0xEF && c2 == 0xBB && c3 == 0xBF) {
|
|
integrity_issue_t* issue = g_malloc0(sizeof(integrity_issue_t));
|
|
issue->level = INTEGRITY_INFO;
|
|
issue->file = g_strdup(basename);
|
|
issue->line = 0;
|
|
issue->message = g_strdup("File has UTF-8 BOM — harmless but unnecessary");
|
|
issues = g_slist_append(issues, issue);
|
|
} else {
|
|
fseek(fp, 0, SEEK_SET);
|
|
}
|
|
|
|
char* buf = NULL;
|
|
int lineno = 0;
|
|
GDateTime* prev_ts = NULL;
|
|
GDateTime* first_ts = NULL;
|
|
GDateTime* last_ts = NULL;
|
|
gboolean has_crlf = FALSE;
|
|
gboolean is_empty = TRUE;
|
|
|
|
while ((buf = ff_readline(fp, NULL)) != NULL) {
|
|
lineno++;
|
|
gsize len = strlen(buf);
|
|
|
|
// CRLF check
|
|
if (len > 0 && buf[len - 1] == '\r') {
|
|
has_crlf = TRUE;
|
|
buf[--len] = '\0';
|
|
}
|
|
|
|
// Skip empty lines and comments
|
|
if (len == 0 || buf[0] == '#') {
|
|
free(buf);
|
|
continue;
|
|
}
|
|
is_empty = FALSE;
|
|
|
|
// UTF-8 validation
|
|
const gchar* end;
|
|
if (!g_utf8_validate(buf, -1, &end)) {
|
|
integrity_issue_t* issue = g_malloc0(sizeof(integrity_issue_t));
|
|
issue->level = INTEGRITY_ERROR;
|
|
issue->file = g_strdup(basename);
|
|
issue->line = lineno;
|
|
issue->message = g_strdup_printf("Invalid UTF-8 at byte offset %ld", (long)(end - buf));
|
|
issues = g_slist_append(issues, issue);
|
|
free(buf);
|
|
continue;
|
|
}
|
|
|
|
// Control character check
|
|
for (gsize i = 0; i < len; i++) {
|
|
unsigned char ch = (unsigned char)buf[i];
|
|
if (ch < 0x20 && ch != '\t') {
|
|
integrity_issue_t* issue = g_malloc0(sizeof(integrity_issue_t));
|
|
issue->level = INTEGRITY_WARNING;
|
|
issue->file = g_strdup(basename);
|
|
issue->line = lineno;
|
|
issue->message = g_strdup_printf("Contains control character 0x%02x", ch);
|
|
issues = g_slist_append(issues, issue);
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Parse line
|
|
ff_parsed_line_t* pl = ff_parse_line(buf);
|
|
if (!pl) {
|
|
integrity_issue_t* issue = g_malloc0(sizeof(integrity_issue_t));
|
|
issue->level = INTEGRITY_ERROR;
|
|
issue->file = g_strdup(basename);
|
|
issue->line = lineno;
|
|
issue->message = g_strdup("Unparsable line");
|
|
issues = g_slist_append(issues, issue);
|
|
free(buf);
|
|
continue;
|
|
}
|
|
|
|
free(buf); // done with raw line
|
|
|
|
if (!first_ts)
|
|
first_ts = g_date_time_ref(pl->timestamp);
|
|
if (last_ts)
|
|
g_date_time_unref(last_ts);
|
|
last_ts = g_date_time_ref(pl->timestamp);
|
|
|
|
// Timestamp order within file
|
|
if (prev_ts && g_date_time_compare(pl->timestamp, prev_ts) < 0) {
|
|
auto_gchar gchar* ts_cur = g_date_time_format_iso8601(pl->timestamp);
|
|
auto_gchar gchar* ts_prev = g_date_time_format_iso8601(prev_ts);
|
|
integrity_issue_t* issue = g_malloc0(sizeof(integrity_issue_t));
|
|
issue->level = INTEGRITY_WARNING;
|
|
issue->file = g_strdup(basename);
|
|
issue->line = lineno;
|
|
issue->message = g_strdup_printf("Timestamp out of order (%s after %s)", ts_cur, ts_prev);
|
|
issues = g_slist_append(issues, issue);
|
|
}
|
|
if (prev_ts)
|
|
g_date_time_unref(prev_ts);
|
|
prev_ts = g_date_time_ref(pl->timestamp);
|
|
|
|
// Duplicate stanza-id / archive-id
|
|
if (pl->stanza_id && strlen(pl->stanza_id) > 0) {
|
|
if (g_hash_table_contains(seen_ids, pl->stanza_id)) {
|
|
integrity_issue_t* issue = g_malloc0(sizeof(integrity_issue_t));
|
|
issue->level = INTEGRITY_WARNING;
|
|
issue->file = g_strdup(basename);
|
|
issue->line = lineno;
|
|
issue->message = g_strdup_printf("Duplicate stanza-id \"%s\"", pl->stanza_id);
|
|
issues = g_slist_append(issues, issue);
|
|
} else {
|
|
g_hash_table_insert(seen_ids, g_strdup(pl->stanza_id), GINT_TO_POINTER(lineno));
|
|
}
|
|
g_hash_table_insert(all_stanza_ids, g_strdup(pl->stanza_id), GINT_TO_POINTER(lineno));
|
|
}
|
|
if (pl->archive_id && strlen(pl->archive_id) > 0) {
|
|
if (g_hash_table_contains(seen_ids, pl->archive_id)) {
|
|
integrity_issue_t* issue = g_malloc0(sizeof(integrity_issue_t));
|
|
issue->level = INTEGRITY_WARNING;
|
|
issue->file = g_strdup(basename);
|
|
issue->line = lineno;
|
|
issue->message = g_strdup_printf("Duplicate archive-id \"%s\"", pl->archive_id);
|
|
issues = g_slist_append(issues, issue);
|
|
} else {
|
|
g_hash_table_insert(seen_ids, g_strdup(pl->archive_id), GINT_TO_POINTER(lineno));
|
|
}
|
|
}
|
|
|
|
ff_parsed_line_free(pl);
|
|
}
|
|
|
|
fclose(fp);
|
|
|
|
// CRLF warning for file
|
|
if (has_crlf) {
|
|
integrity_issue_t* issue = g_malloc0(sizeof(integrity_issue_t));
|
|
issue->level = INTEGRITY_WARNING;
|
|
issue->file = g_strdup(basename);
|
|
issue->line = 0;
|
|
issue->message = g_strdup("File uses Windows line endings (CRLF) — consider converting to LF");
|
|
issues = g_slist_append(issues, issue);
|
|
}
|
|
|
|
// Empty file
|
|
if (is_empty) {
|
|
integrity_issue_t* issue = g_malloc0(sizeof(integrity_issue_t));
|
|
issue->level = INTEGRITY_INFO;
|
|
issue->file = g_strdup(basename);
|
|
issue->line = 0;
|
|
issue->message = g_strdup("File is empty (no message lines)");
|
|
issues = g_slist_append(issues, issue);
|
|
}
|
|
|
|
// Cross-file timestamp ordering
|
|
if (first_ts && prev_file_last_ts) {
|
|
if (g_date_time_compare(first_ts, prev_file_last_ts) < 0) {
|
|
auto_gchar gchar* ts_first = g_date_time_format_iso8601(first_ts);
|
|
auto_gchar gchar* ts_prev_last = g_date_time_format_iso8601(prev_file_last_ts);
|
|
integrity_issue_t* issue = g_malloc0(sizeof(integrity_issue_t));
|
|
issue->level = INTEGRITY_WARNING;
|
|
issue->file = g_strdup(basename);
|
|
issue->line = 0;
|
|
issue->message = g_strdup_printf("First timestamp (%s) is before previous file's last timestamp (%s)",
|
|
ts_first, ts_prev_last);
|
|
issues = g_slist_append(issues, issue);
|
|
}
|
|
}
|
|
|
|
if (prev_file_last_ts)
|
|
g_date_time_unref(prev_file_last_ts);
|
|
prev_file_last_ts = last_ts ? g_date_time_ref(last_ts) : NULL;
|
|
|
|
if (prev_ts)
|
|
g_date_time_unref(prev_ts);
|
|
if (first_ts)
|
|
g_date_time_unref(first_ts);
|
|
if (last_ts)
|
|
g_date_time_unref(last_ts);
|
|
}
|
|
|
|
// Second pass: check LMC references across all files
|
|
for (GSList* lf = log_files; lf; lf = lf->next) {
|
|
const char* filepath = lf->data;
|
|
const char* basename_lmc = strrchr(filepath, '/');
|
|
basename_lmc = basename_lmc ? basename_lmc + 1 : filepath;
|
|
|
|
FILE* fp = fopen(filepath, "r");
|
|
if (!fp)
|
|
continue;
|
|
|
|
// Skip BOM
|
|
int b1 = fgetc(fp);
|
|
int b2 = fgetc(fp);
|
|
int b3 = fgetc(fp);
|
|
if (!(b1 == 0xEF && b2 == 0xBB && b3 == 0xBF)) {
|
|
fseek(fp, 0, SEEK_SET);
|
|
}
|
|
|
|
char* buf = NULL;
|
|
int lineno = 0;
|
|
while ((buf = ff_readline(fp, NULL)) != NULL) {
|
|
lineno++;
|
|
gsize len = strlen(buf);
|
|
if (len > 0 && buf[len - 1] == '\r')
|
|
buf[--len] = '\0';
|
|
if (len == 0 || buf[0] == '#') {
|
|
free(buf);
|
|
continue;
|
|
}
|
|
|
|
ff_parsed_line_t* pl = ff_parse_line(buf);
|
|
free(buf);
|
|
if (!pl)
|
|
continue;
|
|
|
|
if (pl->replace_id && strlen(pl->replace_id) > 0) {
|
|
if (!g_hash_table_contains(all_stanza_ids, pl->replace_id)) {
|
|
integrity_issue_t* issue = g_malloc0(sizeof(integrity_issue_t));
|
|
issue->level = INTEGRITY_ERROR;
|
|
issue->file = g_strdup(basename_lmc);
|
|
issue->line = lineno;
|
|
issue->message = g_strdup_printf("Broken correction reference: corrects:%s not found", pl->replace_id);
|
|
issues = g_slist_append(issues, issue);
|
|
}
|
|
}
|
|
ff_parsed_line_free(pl);
|
|
}
|
|
fclose(fp);
|
|
}
|
|
|
|
if (prev_file_last_ts)
|
|
g_date_time_unref(prev_file_last_ts);
|
|
g_hash_table_destroy(seen_ids);
|
|
g_hash_table_destroy(all_stanza_ids);
|
|
g_slist_free_full(log_files, g_free);
|
|
}
|
|
|
|
g_slist_free_full(contact_dirs, g_free);
|
|
return issues;
|
|
}
|