src/saxdb.c

   1 /* saxdb.c - srvx database manager
   2  * Copyright 2002-2004 srvx Development Team
   3  *
   4  * This file is part of x3.
   5  *
   6  * x3 is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with srvx; if not, write to the Free Software Foundation,
  18  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
  19  */
  20
  21 #include "conf.h"
  22 #include "hash.h"
  23 #include "modcmd.h"
  24 #include "saxdb.h"
  25 #include "timeq.h"
  26
  27 #if !defined(SAXDB_BUFFER_SIZE)
  28 # define SAXDB_BUFFER_SIZE (32 * 1024)
  29 #endif
  30
  31 DEFINE_LIST(int_list, int)
  32
  33 struct saxdb {
  34     char *name;
  35     char *filename;
  36     char *mondo_section;
  37     saxdb_reader_func_t *reader;
  38     saxdb_writer_func_t *writer;
  39     unsigned int write_interval;
  40     time_t last_write;
  41     unsigned int last_write_duration;
  42     struct saxdb *prev;
  43 };
  44
  45 struct saxdb_context {
  46     struct string_buffer obuf;
  47     FILE *output;
  48     unsigned int indent;
  49     struct int_list complex;
  50     jmp_buf jbuf;
  51 };
  52
  53 #define COMPLEX(CTX) ((CTX)->complex.used ? ((CTX)->complex.list[(CTX)->complex.used-1]) : 1)
  54
  55 static struct saxdb *last_db;
  56 static struct dict *saxdbs; /* -> struct saxdb */
  57 static struct dict *mondo_db;
  58 static struct module *saxdb_module;
  59
  60 static SAXDB_WRITER(saxdb_mondo_writer);
  61 static void saxdb_timed_write(void *data);
  62
  63 static void
  64 saxdb_read_db(struct saxdb *db) {
  65     struct dict *data;
  66
  67     assert(db);
  68     assert(db->filename);
  69     data = parse_database(db->filename);
  70     if (!data)
  71         return;
  72     if (db->writer == saxdb_mondo_writer) {
  73         free_database(mondo_db);
  74         mondo_db = data;
  75     } else {
  76         db->reader(data);
  77         free_database(data);
  78     }
  79 }
  80
  81 struct saxdb *
  82 saxdb_register(const char *name, saxdb_reader_func_t *reader, saxdb_writer_func_t *writer) {
  83     struct saxdb *db;
  84     struct dict *conf;
  85     int ii;
  86     const char *filename = NULL, *str;
  87     char conf_path[MAXLEN];
  88
  89     db = calloc(1, sizeof(*db));
  90     db->name = strdup(name);
  91     db->reader = reader;
  92     db->writer = writer;
  93     /* Look up configuration */
  94     sprintf(conf_path, "dbs/%s", name);
  95     if ((conf = conf_get_data(conf_path, RECDB_OBJECT))) {
  96         if ((str = database_get_data(conf, "mondo_section", RECDB_QSTRING))) {
  97             db->mondo_section = strdup(str);
  98         }
  99         str = database_get_data(conf, "frequency", RECDB_QSTRING);
 100         db->write_interval = str ? ParseInterval(str) : 1800;
 101         filename = database_get_data(conf, "filename", RECDB_QSTRING);
 102     } else {
 103         db->write_interval = 1800;
 104     }
 105     /* Schedule database writes */
 106     if (db->write_interval && !db->mondo_section) {
 107         timeq_add(now + db->write_interval, saxdb_timed_write, db);
 108     }
 109     /* Insert filename */
 110     if (filename) {
 111         db->filename = strdup(filename);
 112     } else {
 113         db->filename = malloc(strlen(db->name)+4);
 114         for (ii=0; db->name[ii]; ++ii) db->filename[ii] = tolower(db->name[ii]);
 115         strcpy(db->filename+ii, ".db");
 116     }
 117     /* Read from disk (or mondo DB) */
 118     if (db->mondo_section) {
 119         if (mondo_db && (conf = database_get_data(mondo_db, db->mondo_section, RECDB_OBJECT))) {
 120             db->reader(conf);
 121         }
 122     } else {
 123         saxdb_read_db(db);
 124     }
 125     /* Remember the database */
 126     dict_insert(saxdbs, db->name, db);
 127     db->prev = last_db;
 128     last_db = db;
 129     return db;
 130 }
 131
 132 static int
 133 saxdb_write_db(struct saxdb *db) {
 134     struct saxdb_context *ctx;
 135     FILE *output;
 136     char tmp_fname[MAXLEN];
 137     int res, res2;
 138     time_t start, finish;
 139
 140     assert(db->filename);
 141     sprintf(tmp_fname, "%s.new", db->filename);
 142     output = fopen(tmp_fname, "w+");
 143
 144     if (!output) {
 145         log_module(MAIN_LOG, LOG_ERROR, "Unable to write to %s: %s", tmp_fname, strerror(errno));
 146         return 1;
 147     }
 148     ctx = saxdb_open_context(output);
 149     start = time(NULL);
 150     if ((res = setjmp(*saxdb_jmp_buf(ctx))) || (res2 = db->writer(ctx))) {
 151         if (res) {
 152             log_module(MAIN_LOG, LOG_ERROR, "Error writing to %s: %s", tmp_fname, strerror(res));
 153         } else {
 154             log_module(MAIN_LOG, LOG_ERROR, "Internal error %d while writing to %s", res2, tmp_fname);
 155         }
 156         ctx->complex.used = 0; /* Squelch asserts about unbalanced output. */
 157         saxdb_close_context(ctx, 1);
 158         remove(tmp_fname);
 159         return 2;
 160     }
 161     finish = time(NULL);
 162     saxdb_close_context(ctx, 1);
 163     if (rename(tmp_fname, db->filename) < 0) {
 164         log_module(MAIN_LOG, LOG_ERROR, "Unable to rename %s to %s: %s", tmp_fname, db->filename, strerror(errno));
 165     }
 166     db->last_write = now;
 167     db->last_write_duration = finish - start;
 168     log_module(MAIN_LOG, LOG_INFO, "Wrote %s database to disk.", db->name);
 169     return 0;
 170 }
 171
 172 static void
 173 saxdb_timed_write(void *data) {
 174     struct saxdb *db = data;
 175     saxdb_write_db(db);
 176     timeq_add(now + db->write_interval, saxdb_timed_write, db);
 177 }
 178
 179 void
 180 saxdb_write(const char *db_name) {
 181     struct saxdb *db;
 182     db = dict_find(saxdbs, db_name, NULL);
 183     if (db) saxdb_write_db(db);
 184 }
 185
 186 void
 187 saxdb_write_all(void) {
 188     dict_iterator_t it;
 189     struct saxdb *db;
 190
 191     for (it = dict_first(saxdbs); it; it = iter_next(it)) {
 192         db = iter_data(it);
 193         if (!db->mondo_section)
 194             saxdb_write_db(db);
 195     }
 196 }
 197
 198 static void
 199 saxdb_flush(struct saxdb_context *dest) {
 200     ssize_t nbw;
 201     size_t ofs;
 202     int fd;
 203
 204     assert(dest->obuf.used <= dest->obuf.size);
 205     fd = fileno(dest->output);
 206     for (ofs = 0; ofs < dest->obuf.used; ofs += nbw) {
 207         nbw = write(fd, dest->obuf.list + ofs, dest->obuf.used);
 208         if (nbw < 0) {
 209             longjmp(dest->jbuf, errno);
 210         }
 211     }
 212     dest->obuf.used = 0;
 213 }
 214
 215 static void
 216 saxdb_put_char(struct saxdb_context *dest, char ch) {
 217     dest->obuf.list[dest->obuf.used] = ch;
 218     if (++dest->obuf.used == dest->obuf.size)
 219         saxdb_flush(dest);
 220 }
 221
 222 static void
 223 saxdb_put_nchars(struct saxdb_context *dest, const char *name, int len) {
 224     int frag;
 225     int ofs;
 226
 227     for (ofs = 0; ofs < len; ofs += frag) {
 228         frag = dest->obuf.size - dest->obuf.used;
 229         if (frag > len - ofs)
 230             frag = len - ofs;
 231         memcpy(dest->obuf.list + dest->obuf.used, name + ofs, frag);
 232         dest->obuf.used += frag;
 233         if (dest->obuf.used == dest->obuf.size)
 234             saxdb_flush(dest);
 235     }
 236 }
 237
 238 #define saxdb_put_string(DEST, STR) do { \
 239     saxdb_put_nchars((DEST), (STR), strlen(STR)); \
 240     } while (0)
 241
 242 static void
 243 saxdb_put_qstring(struct saxdb_context *dest, const char *str) {
 244     size_t ofs;
 245     size_t span;
 246
 247     assert(str);
 248     saxdb_put_char(dest, '"');
 249     for (ofs = 0; str[ofs] != '\0'; ) {
 250         char stop;
 251         span = strcspn(str + ofs, "\\\a\b\t\n\v\f\r\"");
 252         saxdb_put_nchars(dest, str + ofs, span);
 253         ofs += span;
 254         stop = str[ofs];
 255         switch (stop) {
 256         case '\0': continue;
 257         case '\a': stop = 'a'; break;
 258         case '\b': stop = 'b'; break;
 259         case '\t': stop = 't'; break;
 260         case '\n': stop = 'n'; break;
 261         case '\v': stop = 'v'; break;
 262         case '\f': stop = 'f'; break;
 263         case '\r': stop = 'r'; break;
 264         }
 265         saxdb_put_char(dest, '\\');
 266         saxdb_put_char(dest, stop);
 267         ofs++;
 268
 269     }
 270     saxdb_put_char(dest, '"');
 271 }
 272
 273 #ifndef NDEBUG
 274 static void
 275 saxdb_pre_object(struct saxdb_context *dest) {
 276     unsigned int ii;
 277     if (COMPLEX(dest)) {
 278         for (ii=0; ii<dest->indent; ++ii) saxdb_put_char(dest, '\t');
 279     }
 280 }
 281 #else
 282 #define saxdb_pre_object(DEST)
 283 #endif
 284
 285 static inline void
 286 saxdb_post_object(struct saxdb_context *dest) {
 287     saxdb_put_char(dest, ';');
 288     saxdb_put_char(dest, COMPLEX(dest) ? '\n' : ' ');
 289 }
 290
 291 void
 292 saxdb_start_record(struct saxdb_context *dest, const char *name, int complex) {
 293     saxdb_pre_object(dest);
 294     saxdb_put_qstring(dest, name);
 295     saxdb_put_string(dest, " { ");
 296     int_list_append(&dest->complex, complex);
 297     if (complex) {
 298         dest->indent++;
 299         saxdb_put_char(dest, '\n');
 300     }
 301 }
 302
 303 void
 304 saxdb_end_record(struct saxdb_context *dest) {
 305     assert(dest->complex.used > 0);
 306     if (COMPLEX(dest)) dest->indent--;
 307     saxdb_pre_object(dest);
 308     dest->complex.used--;
 309     saxdb_put_char(dest, '}');
 310     saxdb_post_object(dest);
 311 }
 312
 313 void
 314 saxdb_write_string_list(struct saxdb_context *dest, const char *name, struct string_list *list) {
 315     unsigned int ii;
 316
 317     saxdb_pre_object(dest);
 318     saxdb_put_qstring(dest, name);
 319     saxdb_put_string(dest, " (");
 320     if (list->used) {
 321         for (ii=0; ii<list->used-1; ++ii) {
 322             saxdb_put_qstring(dest, list->list[ii]);
 323             saxdb_put_string(dest, ", ");
 324         }
 325         saxdb_put_qstring(dest, list->list[list->used-1]);
 326     }
 327     saxdb_put_string(dest, ")");
 328     saxdb_post_object(dest);
 329 }
 330
 331 void
 332 saxdb_write_string(struct saxdb_context *dest, const char *name, const char *value) {
 333     saxdb_pre_object(dest);
 334     saxdb_put_qstring(dest, name);
 335     saxdb_put_char(dest, ' ');
 336     saxdb_put_qstring(dest, value);
 337     saxdb_post_object(dest);
 338 }
 339
 340 void
 341 saxdb_write_int(struct saxdb_context *dest, const char *name, unsigned long value) {
 342     char buf[16];
 343     /* we could optimize this to take advantage of the fact that buf will never need escapes */
 344     snprintf(buf, sizeof(buf), "%lu", value);
 345     saxdb_write_string(dest, name, buf);
 346 }
 347
 348 void
 349 saxdb_write_sint(struct saxdb_context *dest, const char *name, long value) {
 350     char buf[16];
 351     /* we could optimize this to take advantage of the fact that buf will never need escapes */
 352     snprintf(buf, sizeof(buf), "%ld", value);
 353     saxdb_write_string(dest, name, buf);
 354 }
 355
 356 static void
 357 saxdb_free(void *data) {
 358     struct saxdb *db = data;
 359     free(db->name);
 360     free(db->filename);
 361     free(db->mondo_section);
 362     free(db);
 363 }
 364
 365 static int
 366 saxdb_mondo_read(struct dict *db, struct saxdb *saxdb) {
 367     int res;
 368     struct dict *subdb;
 369
 370     if (saxdb->prev && (res = saxdb_mondo_read(db, saxdb->prev))) return res;
 371     if (saxdb->mondo_section
 372         && (subdb = database_get_data(db, saxdb->mondo_section, RECDB_OBJECT))
 373         && (res = saxdb->reader(subdb))) {
 374         log_module(MAIN_LOG, LOG_INFO, " mondo section read for %s failed: %d", saxdb->mondo_section, res);
 375         return res;
 376     }
 377     return 0;
 378 }
 379
 380 static SAXDB_READER(saxdb_mondo_reader) {
 381     return saxdb_mondo_read(db, last_db);
 382 }
 383
 384 static int
 385 saxdb_mondo_write(struct saxdb_context *ctx, struct saxdb *saxdb) {
 386     int res;
 387     if (saxdb->prev && (res = saxdb_mondo_write(ctx, saxdb->prev))) return res;
 388     if (saxdb->mondo_section) {
 389         saxdb_start_record(ctx, saxdb->mondo_section, 1);
 390         if ((res = saxdb->writer(ctx))) {
 391             log_module(MAIN_LOG, LOG_INFO, " mondo section write for %s failed: %d", saxdb->mondo_section, res);
 392             return res;
 393         }
 394         saxdb_end_record(ctx);
 395         /* cheat a little here to put a newline between mondo sections */
 396         saxdb_put_char(ctx, '\n');
 397     }
 398     return 0;
 399 }
 400
 401 static SAXDB_WRITER(saxdb_mondo_writer) {
 402     return saxdb_mondo_write(ctx, last_db);
 403 }
 404
 405 static MODCMD_FUNC(cmd_write) {
 406     struct timeval start, stop;
 407     unsigned int ii, written;
 408     struct saxdb *db;
 409
 410     assert(argc >= 2);
 411     written = 0;
 412     for (ii=1; ii<argc; ++ii) {
 413         if (!(db = dict_find(saxdbs, argv[ii], NULL))) {
 414             reply("MSG_DB_UNKNOWN", argv[ii]);
 415             continue;
 416         }
 417         if (db->mondo_section) {
 418             reply("MSG_DB_IS_MONDO", db->name);
 419             continue;
 420         }
 421         gettimeofday(&start, NULL);
 422         if (saxdb_write_db(db)) {
 423             reply("MSG_DB_WRITE_ERROR", db->name);
 424         } else {
 425             gettimeofday(&stop, NULL);
 426             stop.tv_sec -= start.tv_sec;
 427             stop.tv_usec -= start.tv_usec;
 428             if (stop.tv_usec < 0) {
 429                 stop.tv_sec -= 1;
 430                 stop.tv_usec += 1000000;
 431             }
 432             reply("MSG_DB_WROTE_DB", db->name, stop.tv_sec, stop.tv_usec);
 433             written++;
 434         }
 435     }
 436     return written;
 437 }
 438
 439 static MODCMD_FUNC(cmd_writeall) {
 440     struct timeval start, stop;
 441
 442     gettimeofday(&start, NULL);
 443     saxdb_write_all();
 444     gettimeofday(&stop, NULL);
 445     stop.tv_sec -= start.tv_sec;
 446     stop.tv_usec -= start.tv_usec;
 447     if (stop.tv_usec < 0) {
 448         stop.tv_sec -= 1;
 449         stop.tv_usec += 1000000;
 450     }
 451     reply("MSG_DB_WROTE_ALL", stop.tv_sec, stop.tv_usec);
 452     return 1;
 453 }
 454
 455 static MODCMD_FUNC(cmd_stats_databases) {
 456     struct helpfile_table tbl;
 457     dict_iterator_t it;
 458     unsigned int ii;
 459
 460     tbl.length = dict_size(saxdbs) + 1;
 461     tbl.width = 5;
 462     tbl.flags = TABLE_NO_FREE;
 463     tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
 464     tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
 465     tbl.contents[0][0] = "Database";
 466     tbl.contents[0][1] = "Filename/Section";
 467     tbl.contents[0][2] = "Interval";
 468     tbl.contents[0][3] = "Last Written";
 469     tbl.contents[0][4] = "Last Duration";
 470     for (ii=1, it=dict_first(saxdbs); it; it=iter_next(it), ++ii) {
 471         struct saxdb *db = iter_data(it);
 472         if (db->mondo_section) {
 473             --ii;
 474             continue;
 475         }
 476         char *buf = malloc(INTERVALLEN*3);
 477         tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
 478         tbl.contents[ii][0] = db->name;
 479         tbl.contents[ii][1] = db->mondo_section ? db->mondo_section : db->filename;
 480         if (db->write_interval) {
 481             intervalString(buf, db->write_interval, user->handle_info);
 482         } else {
 483             strcpy(buf, "Never");
 484         }
 485         tbl.contents[ii][2] = buf;
 486         if (db->last_write) {
 487             intervalString(buf+INTERVALLEN, now - db->last_write, user->handle_info);
 488             intervalString(buf+INTERVALLEN*2, db->last_write_duration, user->handle_info);
 489         } else {
 490             strcpy(buf+INTERVALLEN, "Never");
 491             strcpy(buf+INTERVALLEN*2, "Never");
 492         }
 493         tbl.contents[ii][3] = buf+INTERVALLEN;
 494         tbl.contents[ii][4] = buf+INTERVALLEN*2;
 495     }
 496     tbl.length = ii;
 497     table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
 498     free(tbl.contents[0]);
 499     for (ii=1; ii<tbl.length; ++ii) {
 500         free((char*)tbl.contents[ii][2]);
 501         free(tbl.contents[ii]);
 502     }
 503     free(tbl.contents);
 504     return 0;
 505 }
 506
 507 static void
 508 saxdb_cleanup(void) {
 509     dict_delete(saxdbs);
 510 }
 511
 512 static struct helpfile_expansion
 513 saxdb_expand_help(const char *variable) {
 514     struct helpfile_expansion exp;
 515     if (!strcasecmp(variable, "dblist")) {
 516         dict_iterator_t it;
 517         struct string_buffer sbuf;
 518         struct saxdb *db;
 519
 520         exp.type = HF_STRING;
 521         string_buffer_init(&sbuf);
 522         for (it = dict_first(saxdbs); it; it = iter_next(it)) {
 523             db = iter_data(it);
 524             if (db->mondo_section) continue;
 525             if (sbuf.used) string_buffer_append_string(&sbuf, ", ");
 526             string_buffer_append_string(&sbuf, iter_key(it));
 527         }
 528         exp.value.str = sbuf.list;
 529     } else {
 530         exp.type = HF_STRING;
 531         exp.value.str = NULL;
 532     }
 533     return exp;
 534 }
 535
 536 void
 537 saxdb_init(void) {
 538     reg_exit_func(saxdb_cleanup);
 539     saxdbs = dict_new();
 540     dict_set_free_data(saxdbs, saxdb_free);
 541     saxdb_register("mondo", saxdb_mondo_reader, saxdb_mondo_writer);
 542     saxdb_module = module_register("saxdb", MAIN_LOG, "saxdb.help", saxdb_expand_help);
 543     modcmd_register(saxdb_module, "write", cmd_write, 2, MODCMD_REQUIRE_AUTHED, "level", "800", NULL);
 544     modcmd_register(saxdb_module, "writeall", cmd_writeall, 0, MODCMD_REQUIRE_AUTHED, "level", "800", NULL);
 545     modcmd_register(saxdb_module, "stats databases", cmd_stats_databases, 0, 0, NULL);
 546 }
 547
 548 void
 549 saxdb_finalize(void) {
 550     free_database(mondo_db);
 551 }
 552
 553 static void
 554 write_database_helper(struct saxdb_context *ctx, struct dict *db) {
 555     dict_iterator_t it;
 556     struct record_data *rd;
 557
 558     for (it = dict_first(db); it; it = iter_next(it)) {
 559         rd = iter_data(it);
 560         switch (rd->type) {
 561         case RECDB_INVALID: break;
 562         case RECDB_QSTRING: saxdb_write_string(ctx, iter_key(it), rd->d.qstring); break;
 563         case RECDB_STRING_LIST: saxdb_write_string_list(ctx, iter_key(it), rd->d.slist); break;
 564         case RECDB_OBJECT:
 565             saxdb_start_record(ctx, iter_key(it), 1);
 566             write_database_helper(ctx, rd->d.object);
 567             saxdb_end_record(ctx);
 568             break;
 569         }
 570     }
 571 }
 572
 573 int
 574 write_database(FILE *out, struct dict *db) {
 575     struct saxdb_context *ctx;
 576     int res;
 577
 578     ctx = saxdb_open_context(out);
 579     if (!(res = setjmp(*saxdb_jmp_buf(ctx)))) {
 580         write_database_helper(ctx, db);
 581     } else {
 582         log_module(MAIN_LOG, LOG_ERROR, "Exception %d caught while writing to stream", res);
 583         ctx->complex.used = 0; /* Squelch asserts about unbalanced output. */
 584         saxdb_close_context(ctx, 0);
 585         return 1;
 586     }
 587     saxdb_close_context(ctx, 0);
 588     return 0;
 589 }
 590
 591 struct saxdb_context *
 592 saxdb_open_context(FILE *file) {
 593     struct saxdb_context *ctx;
 594
 595     assert(file);
 596     ctx = calloc(1, sizeof(*ctx));
 597     ctx->output = file;
 598     ctx->obuf.size = SAXDB_BUFFER_SIZE;
 599     ctx->obuf.list = calloc(1, ctx->obuf.size);
 600     int_list_init(&ctx->complex);
 601
 602     return ctx;
 603 }
 604
 605 jmp_buf *
 606 saxdb_jmp_buf(struct saxdb_context *ctx) {
 607     return &ctx->jbuf;
 608 }
 609
 610 void
 611 saxdb_close_context(struct saxdb_context *ctx, int close_file) {
 612     assert(ctx->complex.used == 0);
 613     saxdb_flush(ctx);
 614     int_list_clean(&ctx->complex);
 615     free(ctx->obuf.list);
 616     if (close_file)
 617         fclose(ctx->output);
 618     else
 619         fflush(ctx->output);
 620     free(ctx);
 621 }