summaryrefslogtreecommitdiff
path: root/src/modules/os_ignore_db.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/modules/os_ignore_db.c')
-rw-r--r--src/modules/os_ignore_db.c490
1 files changed, 0 insertions, 490 deletions
diff --git a/src/modules/os_ignore_db.c b/src/modules/os_ignore_db.c
deleted file mode 100644
index 3989bde85..000000000
--- a/src/modules/os_ignore_db.c
+++ /dev/null
@@ -1,490 +0,0 @@
-/* os_ignore_db.c - Provides a database backend for OS IGNORE.
- *
- * (C) 2003-2009 Anope Team
- * Contact us at team@anope.org
- *
- * Included in the Anope module pack since Anope 1.7.23
- * Anope Coder: Viper <viper@anope.org>
- *
- * Please read COPYING and README for further details.
- *
- */
-/* ------------------------------------------------------------------------------- */
-
-#include "module.h"
-
-#define AUTHOR "Viper"
-#define VERSION "$Id$"
-
-/* Default database name */
-#define DefIgnoreDB "os_ignore.db"
-#define IGNOREDBVERSION 1
-
-/* Database seperators */
-#define SEPARATOR '^' /* End of a key, seperates keys from values */
-#define BLOCKEND '\n' /* End of a block, e.g. a whole ignore */
-#define VALUEEND '\000' /* End of a value */
-#define SUBSTART '\010' /* Beginning of a new subblock, closed by a BLOCKEND */
-
-/* Database reading return values */
-#define DB_READ_SUCCESS 0
-#define DB_READ_ERROR 1
-#define DB_EOF_ERROR 2
-#define DB_VERSION_ERROR 3
-#define DB_READ_BLOCKEND 4
-#define DB_READ_SUBSTART 5
-
-#define DB_WRITE_SUCCESS 0
-#define DB_WRITE_ERROR 1
-#define DB_WRITE_NOVAL 2
-
-/* Database Key, Value max length */
-#define MAXKEYLEN 128
-#define MAXVALLEN 1024
-
-/* Structs */
-typedef struct db_file_ DBFile;
-
-struct db_file_ {
- FILE *fptr; /* Pointer to the opened file */
- int db_version; /* The db version of the datafiles (only needed for reading) */
- int core_db_version; /* The current db version of this anope source */
- char service[256]; /* StatServ/etc. */
- char filename[256]; /* Filename of the database */
- char temp_name[262]; /* Temp filename of the database */
-};
-
-
-/* Variables */
-char *IgnoreDB;
-
-/* Functions */
-int new_open_db_read(DBFile *dbptr, char **key, char **value);
-int new_open_db_write(DBFile *dbptr);
-void new_close_db(FILE *fptr, char **key, char **value);
-int new_read_db_entry(char **key, char **value, FILE * fptr);
-int new_write_db_entry(const char *key, DBFile *dbptr, const char *fmt, ...);
-int new_write_db_endofblock(DBFile *dbptr);
-void fill_db_ptr(DBFile *dbptr, int version, int core_version, char service[256], char filename[256]);
-
-void load_ignore_db();
-void load_config();
-
-/* ------------------------------------------------------------------------------- */
-
-class OSIgnoreDB : public Module
-{
- public:
- OSIgnoreDB(const std::string &modname, const std::string &creator) : Module(modname, creator)
- {
- IgnoreDB = NULL;
-
- this->SetAuthor(AUTHOR);
- this->SetVersion(VERSION);
- this->SetType(SUPPORTED);
-
- ModuleManager::Attach(I_OnSaveDatabase, this);
- ModuleManager::Attach(I_OnBackupDatabase, this);
-
- load_config();
- /* Load the ignore database and re-add them to anopes ignorelist. */
- load_ignore_db();
- ModuleManager::Attach(I_OnReload, this);
- }
-
- ~OSIgnoreDB()
- {
- /* Save the ignore database before bailing out.. */
- OnSaveDatabase();
-
- if (IgnoreDB)
- delete [] IgnoreDB;
- }
-
- void OnReload(bool starting)
- {
- load_config();
- }
-
- void OnSaveDatabase()
- {
- DBFile *dbptr = new DBFile;
- time_t now;
- IgnoreData *ign, *next;
-
- now = time(NULL);
- fill_db_ptr(dbptr, 0, IGNOREDBVERSION, Config.s_OperServ, IgnoreDB);
-
- /* time to backup the old db */
- rename(IgnoreDB, dbptr->temp_name);
-
- if (new_open_db_write(dbptr)) {
- rename(dbptr->temp_name, IgnoreDB);
- delete dbptr;
- return; /* Bang, an error occurred */
- }
-
- /* Store the version of the DB in the DB as well...
- * This will make stuff a lot easier if the database scheme needs to modified. */
- new_write_db_entry("IGNORE_DB_VERSION", dbptr, "%d", IGNOREDBVERSION);
- new_write_db_endofblock(dbptr);
-
- /* Go over the entire ignorelist, check whether each entry is still valid
- * and write it to the database if it is.*/
- for (ign = ignore; ign; ign = next) {
- next = ign->next;
-
- if (ign->time != 0 && ign->time <= now) {
- if (debug)
- alog("[os_ignore_db] debug: Expiring ignore entry %s", ign->mask);
- if (ign->prev)
- ign->prev->next = ign->next;
- else if (ignore == ign)
- ignore = ign->next;
- if (ign->next)
- ign->next->prev = ign->prev;
- delete [] ign->mask;
- delete ign;
- ign = NULL;
- } else {
- new_write_db_entry("m", dbptr, "%s", ign->mask);
- new_write_db_entry("t", dbptr, "%d", ign->time);
- new_write_db_endofblock(dbptr);
- }
- }
-
- if (dbptr) {
- new_close_db(dbptr->fptr, NULL, NULL); /* close file */
- remove(dbptr->temp_name); /* saved successfully, no need to keep the old one */
- delete dbptr; /* free the db struct */
- }
- }
-
- void OnBackupDatabase()
- {
- ModuleDatabaseBackup(IgnoreDB);
- }
-
-
-};
-
-
-/* ------------------------------------------------------------------------------- */
-
-void load_config() {
- ConfigReader config;
- std::string tmp = config.ReadValue("os_ignore", "database", DefIgnoreDB, 0);
-
- if (IgnoreDB)
- delete [] IgnoreDB;
- IgnoreDB = sstrdup(tmp.c_str());
-
- if (debug)
- alog("[os_ignore_db] debug: Set config vars: OSIgnoreDBName='%s'", IgnoreDB);
-}
-
-/* ------------------------------------------------------------------------------- */
-
-/**************************************************************************
- * DataBase Handling
- **************************************************************************/
-
-void load_ignore_db() {
- DBFile *dbptr = new DBFile;
- char *key, *value, *mask = NULL;
- int retval = 0;
- time_t expiry_time;
- IgnoreData *ign;
-
- expiry_time = time(NULL);
- fill_db_ptr(dbptr, 0, IGNOREDBVERSION, Config.s_OperServ, IgnoreDB);
-
- /* let's remove existing temp files here, because we only load dbs on startup */
- remove(dbptr->temp_name);
-
- /* Open the db, fill the rest of dbptr and allocate memory for key and value */
- if (new_open_db_read(dbptr, &key, &value)) {
- delete dbptr;
- return; /* Bang, an error occurred */
- }
-
- while (1) {
- /* read a new entry and fill key and value with it -Certus */
- retval = new_read_db_entry(&key, &value, dbptr->fptr);
-
- if (retval == DB_READ_ERROR) {
- new_close_db(dbptr->fptr, &key, &value);
- delete dbptr;
- return;
-
- } else if (retval == DB_EOF_ERROR) {
- new_close_db(dbptr->fptr, &key, &value);
- delete dbptr;
- return;
- } else if (retval == DB_READ_BLOCKEND) { /* DB_READ_BLOCKEND */
- /* Check if we have everything to add the ignore..
- * We shouldn't bother with already expired ignores either.. */
- if (mask && (expiry_time > time(NULL) || expiry_time == 0)) {
- /* We should check for double entries.. */
- for (ign = ignore; ign; ign = ign->next)
- if (!stricmp(ign->mask, mask))
- break;
-
- if (!ign) {
- /* Create a fresh entry.. */
- ign = new IgnoreData;
- ign->mask = sstrdup(mask);
- ign->time = expiry_time;
- ign->prev = NULL;
- ign->next = ignore;
- if (ignore)
- ignore->prev = ign;
- ignore = ign;
- if (debug)
- alog("[os_ignore_db] debug: Added new ignore entry for %s", mask);
- } else {
- /* Update time on existing entry.
- * The longest expiry time survives.. */
- if (expiry_time == 0 || ign->time == 0)
- ign->time = 0;
- else if (expiry_time > ign->time)
- ign->time = expiry_time;
- }
- }
-
- if (mask) delete [] mask;
- mask = NULL;
- expiry_time = time(NULL);
- } else { /* DB_READ_SUCCESS */
- if (!*key || !*value)
- continue;
-
- /* mask */
- if (!stricmp(key, "m")) {
- if (mask)
- delete [] mask;
- mask = sstrdup(value);
-
- /* expiry time */
- } else if (!stricmp(key, "t")) {
- expiry_time = atoi(value);
-
- } else if (!stricmp(key, "IGNORE_DB_VERSION")) {
- if (atoi(value) != IGNOREDBVERSION) {
- alog("[\002os_ignore_db\002] Database version does not match any database versions supported by this module.");
- alog("[\002os_ignore_db\002] Continuing with clean database...");
- break;
- }
- }
- } /* else */
- } /* while */
-
- delete dbptr;
-}
-
-
-/* ------------------------------------------------------------------------------- */
-
-/**************************************************************************
- * Generic DataBase Functions (Borrowed this from Trystan :-) )
- **************************************************************************/
-
-
-int new_open_db_read(DBFile *dbptr, char **key, char **value) {
- *key = new char[MAXKEYLEN];
- *value = new char[MAXVALLEN];
-
- if (!(dbptr->fptr = fopen(dbptr->filename, "rb"))) {
- if (debug) {
- alog("debug: Can't read %s database %s : errno(%d)", dbptr->service,
- dbptr->filename, errno);
- }
- delete [] *key;
- *key = NULL;
- delete [] *value;
- *value = NULL;
- return DB_READ_ERROR;
- }
- dbptr->db_version = fgetc(dbptr->fptr) << 24 | fgetc(dbptr->fptr) << 16
- | fgetc(dbptr->fptr) << 8 | fgetc(dbptr->fptr);
-
- if (ferror(dbptr->fptr)) {
- if (debug) {
- alog("debug: Error reading version number on %s", dbptr->filename);
- }
- delete [] *key;
- *key = NULL;
- delete [] *value;
- *value = NULL;
- return DB_READ_ERROR;
- } else if (feof(dbptr->fptr)) {
- if (debug) {
- alog("debug: Error reading version number on %s: End of file detected",
- dbptr->filename);
- }
- delete [] *key;
- *key = NULL;
- delete [] *value;
- *value = NULL;
- return DB_EOF_ERROR;
- } else if (dbptr->db_version < 1) {
- if (debug) {
- alog("debug: Invalid version number (%d) on %s", dbptr->db_version, dbptr->filename);
- }
- delete [] *key;
- *key = NULL;
- delete [] *value;
- *value = NULL;
- return DB_VERSION_ERROR;
- }
- return DB_READ_SUCCESS;
-}
-
-
-int new_open_db_write(DBFile *dbptr) {
- if (!(dbptr->fptr = fopen(dbptr->filename, "wb"))) {
- if (debug) {
- alog("debug: %s Can't open %s database for writing", dbptr->service, dbptr->filename);
- }
- return DB_WRITE_ERROR;
- }
-
- if (fputc(dbptr->core_db_version >> 24 & 0xFF, dbptr->fptr) < 0 ||
- fputc(dbptr->core_db_version >> 16 & 0xFF, dbptr->fptr) < 0 ||
- fputc(dbptr->core_db_version >> 8 & 0xFF, dbptr->fptr) < 0 ||
- fputc(dbptr->core_db_version & 0xFF, dbptr->fptr) < 0) {
- if (debug) {
- alog("debug: Error writing version number on %s", dbptr->filename);
- }
- return DB_WRITE_ERROR;
- }
- return DB_WRITE_SUCCESS;
-}
-
-
-void new_close_db(FILE *fptr, char **key, char **value) {
- if (key && *key) {
- delete [] *key;
- *key = NULL;
- }
- if (value && *value) {
- delete [] *value;
- *value = NULL;
- }
-
- if (fptr) {
- fclose(fptr);
- }
-}
-
-
-int new_read_db_entry(char **key, char **value, FILE *fptr) {
- char *string = *key;
- int character;
- int i = 0;
-
- **key = '\0';
- **value = '\0';
-
- while (1) {
- if ((character = fgetc(fptr)) == EOF) { /* a problem occurred reading the file */
- if (ferror(fptr)) {
- return DB_READ_ERROR; /* error! */
- }
- return DB_EOF_ERROR; /* end of file */
- } else if (character == BLOCKEND) { /* END OF BLOCK */
- return DB_READ_BLOCKEND;
- } else if (character == VALUEEND) { /* END OF VALUE */
- string[i] = '\0'; /* end of value */
- return DB_READ_SUCCESS;
- } else if (character == SEPARATOR) { /* END OF KEY */
- string[i] = '\0'; /* end of key */
- string = *value; /* beginning of value */
- i = 0; /* start with the first character of our value */
- } else {
- if ((i == (MAXKEYLEN - 1)) && (string == *key)) { /* max key length reached, continuing with value */
- string[i] = '\0'; /* end of key */
- string = *value; /* beginning of value */
- i = 0; /* start with the first character of our value */
- } else if ((i == (MAXVALLEN - 1)) && (string == *value)) { /* max value length reached, returning */
- string[i] = '\0';
- return DB_READ_SUCCESS;
- } else {
- string[i] = character; /* read string (key or value) */
- i++;
- }
- }
- }
-}
-
-
-int new_write_db_entry(const char *key, DBFile *dbptr, const char *fmt, ...) {
- char string[MAXKEYLEN + MAXVALLEN + 2], value[MAXVALLEN]; /* safety byte :P */
- va_list ap;
- unsigned int length;
-
- if (!dbptr) {
- return DB_WRITE_ERROR;
- }
-
- va_start(ap, fmt);
- vsnprintf(value, MAXVALLEN, fmt, ap);
- va_end(ap);
-
- if (!stricmp(value, "(null)")) {
- return DB_WRITE_NOVAL;
- }
- snprintf(string, MAXKEYLEN + MAXVALLEN + 1, "%s%c%s", key, SEPARATOR, value);
- length = strlen(string);
- string[length] = VALUEEND;
- length++;
-
- if (fwrite(string, 1, length, dbptr->fptr) < length) {
- if (debug) {
- alog("debug: Error writing to %s", dbptr->filename);
- }
- new_close_db(dbptr->fptr, NULL, NULL);
- if (debug) {
- alog("debug: Restoring backup.");
- }
- remove(dbptr->filename);
- rename(dbptr->temp_name, dbptr->filename);
- delete dbptr;
- dbptr = NULL;
- return DB_WRITE_ERROR;
- }
- return DB_WRITE_SUCCESS;
-}
-
-
-int new_write_db_endofblock(DBFile *dbptr) {
- if (!dbptr) {
- return DB_WRITE_ERROR;
- }
- if (fputc(BLOCKEND, dbptr->fptr) == EOF) {
- if (debug) {
- alog("debug: Error writing to %s", dbptr->filename);
- }
- new_close_db(dbptr->fptr, NULL, NULL);
- return DB_WRITE_ERROR;
- }
- return DB_WRITE_SUCCESS;
-}
-
-
-
-void fill_db_ptr(DBFile *dbptr, int version, int core_version,
- char service[256], char filename[256]) {
- dbptr->db_version = version;
- dbptr->core_db_version = core_version;
- if (!service)
- strlcpy(dbptr->service, service, sizeof(dbptr->service));
- else
- strlcpy(dbptr->service, "", sizeof(dbptr->service));
-
- strlcpy(dbptr->filename, filename, sizeof(dbptr->filename));
- snprintf(dbptr->temp_name, sizeof(dbptr->temp_name), "%s.temp", filename);
- return;
-}
-
-MODULE_INIT(OSIgnoreDB)