]>
jfr.im git - solanum.git/blob - bandb/bantool.c
2 * ircd-ratbox: A slightly useful ircd.
3 * bantool.c: The ircd-ratbox database managment tool.
5 * Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
6 * Copyright (C) 1996-2002 Hybrid Development Team
7 * Copyright (C) 2002-2008 ircd-ratbox development team
8 * Copyright (C) 2008 Daniel J Reidy <dubkat@gmail.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
25 * The following server admins have either contributed various configs to test against,
26 * or helped with debugging and feature requests. Many thanks to them.
27 * stevoo / efnet.port80.se
28 * AndroSyn / irc2.choopa.net, irc.igs.ca
29 * Salvation / irc.blessed.net
30 * JamesOff / efnet.demon.co.uk
32 * Thanks to AndroSyn for challenging me to learn C on the fly :)
33 * BUGS Direct Question, Bug Reports, and Feature Requests to #ratbox on EFnet.
34 * BUGS Complaints >/dev/null
45 #define EmptyString(x) ((x == NULL) || (*(x) == '\0'))
46 #define CheckEmpty(x) EmptyString(x) ? "" : x
48 #define BT_VERSION "0.4.1"
64 static char bandb_letter
[LAST_BANDB_TYPE
] = {
65 'K', 'K', 'D', 'D', 'X', 'X', 'R', 'R'
68 static const char *bandb_table
[LAST_BANDB_TYPE
] = {
69 "kline", "kline", "dline", "dline", "xline", "xline", "resv", "resv"
72 static const char *bandb_suffix
[LAST_BANDB_TYPE
] = {
79 static char me
[PATH_MAX
];
90 } count
= {0, 0, 0, 0, 0};
92 /* flags set by command line options */
104 } flag
= {true, false, false, false, false, false, false, false, false};
107 static int table_has_rows(const char *table
);
108 static int table_exists(const char *table
);
110 static const char *clean_gecos_field(const char *gecos
);
111 static char *bt_smalldate(const char *string
);
112 static char *getfield(char *newline
);
113 static char *strip_quotes(const char *string
);
114 static char *mangle_reason(const char *string
);
115 static char *escape_quotes(const char *string
);
117 static void db_error_cb(const char *errstr
);
118 static void db_reclaim_slack(void);
119 static void export_config(const char *conf
, int id
);
120 static void import_config(const char *conf
, int id
);
121 static void check_schema(void);
122 static void print_help(int i_exit
);
123 static void wipe_schema(void);
124 static void drop_dupes(const char *user
, const char *host
, const char *t
);
130 main(int argc
, char *argv
[])
137 rb_strlcpy(me
, argv
[0], sizeof(me
));
139 while((opt
= getopt(argc
, argv
, "hieuspvwd")) != -1)
144 print_help(EXIT_SUCCESS
);
172 flag
.dupes_ok
= true;
175 print_help(EXIT_FAILURE
);
179 /* they should really read the help. */
181 print_help(EXIT_FAILURE
);
183 if((flag
.import && flag
.export
) || (flag
.export
&& flag
.wipe
)
184 || (flag
.verify
&& flag
.pretend
) || (flag
.export
&& flag
.pretend
))
186 fprintf(stderr
, "* Error: Conflicting flags.\n");
187 if(flag
.export
&& flag
.pretend
)
188 fprintf(stderr
, "* There is nothing to 'pretend' when exporting.\n");
190 fprintf(stderr
, "* For an explination of commands, run: %s -h\n", me
);
194 if(argv
[optind
] != NULL
)
195 rb_strlcpy(etc
, argv
[optind
], sizeof(etc
));
197 rb_strlcpy(etc
, ETCPATH
, sizeof(ETCPATH
));
200 "* charybdis bantool v.%s\n", BT_VERSION
);
202 if(flag
.pretend
== false)
204 if(rsdb_init(db_error_cb
) == -1)
206 fprintf(stderr
, "* Error: Unable to open database\n");
214 if(flag
.import && flag
.wipe
)
216 flag
.dupes_ok
= true; /* dont check for dupes if we are wiping the db clean */
217 for(i
= 0; i
< 3; i
++)
219 "* WARNING: YOU ARE ABOUT TO WIPE YOUR DATABASE!\n");
221 fprintf(stdout
, "* Press ^C to abort! ");
224 fprintf(stdout
, "Carrying on...\n");
228 if(flag
.verbose
&& flag
.dupes_ok
== true)
229 fprintf(stdout
, "* Allowing duplicate bans...\n");
231 /* checking for our files to import or export */
232 for(i
= 0; i
< LAST_BANDB_TYPE
; i
++)
234 snprintf(conf
, sizeof(conf
), "%s/%s.conf%s",
235 etc
, bandb_table
[i
], bandb_suffix
[i
]);
237 if(flag
.import && flag
.pretend
== false)
238 rsdb_transaction(RSDB_TRANS_START
);
241 import_config(conf
, i
);
244 export_config(conf
, i
);
246 if(flag
.import && flag
.pretend
== false)
247 rsdb_transaction(RSDB_TRANS_END
);
252 if(count
.error
&& flag
.verbose
)
253 fprintf(stderr
, "* I was unable to locate %u config files to import.\n",
256 fprintf(stdout
, "* Import Stats: Klines: %u, Dlines: %u, Xlines: %u, Resvs: %u \n",
257 count
.klines
, count
.dlines
, count
.xlines
, count
.resvs
);
260 "*\n* If your IRC server is currently running, newly imported bans \n* will not take effect until you issue the command: /quote rehash bans\n");
264 "* Pretend mode engaged. Nothing was actually entered into the database.\n");
272 * export the database to old-style flat files
275 export_config(const char *conf
, int id
)
277 struct rsdb_table table
;
278 static char sql
[BUFSIZE
* 2];
279 static char buf
[512];
283 /* for sanity sake */
286 const int reason
= 2;
289 /* const int perm = 5; */
291 if(!table_has_rows(bandb_table
[id
]))
294 if(strstr(conf
, ".perm") != 0)
295 snprintf(sql
, sizeof(sql
),
296 "SELECT DISTINCT mask1,mask2,reason,oper,time FROM %s WHERE perm = 1 ORDER BY time",
299 snprintf(sql
, sizeof(sql
),
300 "SELECT DISTINCT mask1,mask2,reason,oper,time FROM %s WHERE perm = 0 ORDER BY time",
303 rsdb_exec_fetch(&table
, sql
);
304 if(table
.row_count
<= 0)
306 rsdb_exec_fetch_end(&table
);
311 fprintf(stdout
, "* checking for %s: ", conf
); /* debug */
313 /* open config for reading, or skip to the next */
314 if(!(fd
= fopen(conf
, "w")))
317 fprintf(stdout
, "\tmissing.\n");
322 for(j
= 0; j
< table
.row_count
; j
++)
327 case BANDB_DLINE_PERM
:
328 snprintf(buf
, sizeof(buf
),
329 "\"%s\",\"%s\",\"\",\"%s\",\"%s\",%s\n",
331 mangle_reason(table
.row
[j
][reason
]),
332 bt_smalldate(table
.row
[j
][ts
]),
333 table
.row
[j
][oper
], table
.row
[j
][ts
]);
337 case BANDB_XLINE_PERM
:
338 snprintf(buf
, sizeof(buf
),
339 "\"%s\",\"0\",\"%s\",\"%s\",%s\n",
340 escape_quotes(table
.row
[j
][mask1
]),
341 mangle_reason(table
.row
[j
][reason
]),
342 table
.row
[j
][oper
], table
.row
[j
][ts
]);
346 case BANDB_RESV_PERM
:
347 snprintf(buf
, sizeof(buf
),
348 "\"%s\",\"%s\",\"%s\",%s\n",
350 mangle_reason(table
.row
[j
][reason
]),
351 table
.row
[j
][oper
], table
.row
[j
][ts
]);
355 default: /* Klines */
356 snprintf(buf
, sizeof(buf
),
357 "\"%s\",\"%s\",\"%s\",\"\",\"%s\",\"%s\",%s\n",
358 table
.row
[j
][mask1
], table
.row
[j
][mask2
],
359 mangle_reason(table
.row
[j
][reason
]),
360 bt_smalldate(table
.row
[j
][ts
]), table
.row
[j
][oper
],
365 fprintf(fd
, "%s", buf
);
368 rsdb_exec_fetch_end(&table
);
370 fprintf(stdout
, "\twritten.\n");
375 * attempt to condense the individual conf functions into one
378 import_config(const char *conf
, int id
)
387 const char *f_mask1
= NULL
;
388 const char *f_mask2
= NULL
;
389 const char *f_oper
= NULL
;
390 const char *f_time
= NULL
;
391 const char *f_reason
= NULL
;
392 const char *f_oreason
= NULL
;
393 char newreason
[REASONLEN
];
396 fprintf(stdout
, "* checking for %s: ", conf
); /* debug */
398 /* open config for reading, or skip to the next */
399 if(!(fd
= fopen(conf
, "r")))
402 fprintf(stdout
, "%*s", strlen(bandb_suffix
[id
]) > 0 ? 10 : 15,
408 if(strstr(conf
, ".perm") != 0)
413 * "SYSTEM","0","banned","stevoo!stevoo@efnet.port80.se{stevoo}",1111080437
415 * "OseK","banned nickname","stevoo!stevoo@efnet.port80.se{stevoo}",1111031619
417 * "194.158.192.0/19","laptop scammers","","2005/3/17 05.33","stevoo!stevoo@efnet.port80.se{stevoo}",1111033988
419 while(fgets(line
, sizeof(line
), fd
))
421 if((p
= strpbrk(line
, "\r\n")) != NULL
)
424 if((*line
== '\0') || (*line
== '#'))
428 f_mask1
= getfield(line
);
430 if(EmptyString(f_mask1
))
437 case BANDB_XLINE_PERM
:
438 f_mask1
= escape_quotes(clean_gecos_field(f_mask1
));
439 getfield(NULL
); /* empty field */
443 case BANDB_RESV_PERM
:
445 case BANDB_DLINE_PERM
:
449 f_mask2
= getfield(NULL
);
450 if(EmptyString(f_mask2
))
456 f_reason
= getfield(NULL
);
457 if(EmptyString(f_reason
))
464 case BANDB_KLINE_PERM
:
466 case BANDB_DLINE_PERM
:
467 f_oreason
= getfield(NULL
);
475 f_oper
= getfield(NULL
);
476 f_time
= strip_quotes(f_oper
+ strlen(f_oper
) + 2);
477 if(EmptyString(f_oper
))
481 if(id
== BANDB_KLINE
|| id
== BANDB_KLINE_PERM
)
483 if(strstr(f_mask1
, "!") != NULL
)
486 "* SKIPPING INVALID KLINE %s@%s set by %s\n",
487 f_mask1
, f_mask2
, f_oper
);
488 fprintf(stderr
, " You may wish to re-apply it correctly.\n");
493 /* append operreason_field to reason_field */
494 if(!EmptyString(f_oreason
))
495 snprintf(newreason
, sizeof(newreason
), "%s | %s", f_reason
, f_oreason
);
497 snprintf(newreason
, sizeof(newreason
), "%s", f_reason
);
499 if(flag
.pretend
== false)
501 if(flag
.dupes_ok
== false)
502 drop_dupes(f_mask1
, f_mask2
, bandb_table
[id
]);
505 "INSERT INTO %s (mask1, mask2, oper, time, perm, reason) VALUES('%Q','%Q','%Q','%Q','%d','%Q')",
506 bandb_table
[id
], f_mask1
, f_mask2
, f_oper
, f_time
, f_perm
,
510 if(flag
.pretend
&& flag
.verbose
)
512 "%s: perm(%d) mask1(%s) mask2(%s) oper(%s) reason(%s) time(%s)\n",
513 bandb_table
[id
], f_perm
, f_mask1
, f_mask2
, f_oper
, newreason
,
519 switch (bandb_letter
[id
])
538 fprintf(stdout
, "%*s\n", strlen(bandb_suffix
[id
]) > 0 ? 10 : 15, "imported.");
548 * inputs - input buffer
549 * output - next field
550 * side effects - field breakup for ircd.conf file.
553 getfield(char *newline
)
555 static char *line
= NULL
;
566 /* XXX make this skip to first " if present */
570 return (NULL
); /* mal-formed field */
572 end
= strchr(line
, ',');
576 /* no trailing , - last field */
579 end
= line
+ strlen(line
);
592 /* look for a ", to mark the end of a field.. */
593 if(*(end
- 1) == '"')
601 /* search for the next ',' */
603 end
= strchr(end
, ',');
611 * strip away "quotes" from around strings
614 strip_quotes(const char *string
)
616 static char buf
[14]; /* int(11) + 2 + \0 */
635 * escape quotes in a string
638 escape_quotes(const char *string
)
640 static char buf
[BUFSIZE
* 2];
665 mangle_reason(const char *string
)
667 static char buf
[BUFSIZE
* 2];
696 * change spaces to \s in gecos field
699 clean_gecos_field(const char *gecos
)
701 static char buf
[BUFSIZE
* 2];
723 * verify the database integrity, and if necessary create apropriate tables
729 char type
[8]; /* longest string is 'INTEGER\0' */
731 if(flag
.verify
|| flag
.verbose
)
732 fprintf(stdout
, "* Verifying database.\n");
734 const char *columns
[] = {
744 for(i
= 0; i
< LAST_BANDB_TYPE
; i
++)
746 if(!table_exists(bandb_table
[i
]))
749 "CREATE TABLE %s (mask1 TEXT, mask2 TEXT, oper TEXT, time INTEGER, perm INTEGER, reason TEXT)",
754 * i can't think of any better way to do this, other then attempt to
755 * force the creation of column that may, or may not already exist. --dubkat
759 for(j
= 0; columns
[j
] != NULL
; j
++)
761 if(!strcmp(columns
[j
], "time") && !strcmp(columns
[j
], "perm"))
762 rb_strlcpy(type
, "INTEGER", sizeof(type
));
764 rb_strlcpy(type
, "TEXT", sizeof(type
));
766 /* attempt to add a column with extreme prejudice, errors are ignored */
767 rsdb_exec(NULL
, "ALTER TABLE %s ADD COLUMN %s %s", bandb_table
[i
],
772 i
++; /* skip over .perm */
777 db_reclaim_slack(void)
779 fprintf(stdout
, "* Reclaiming free space.\n");
780 rsdb_exec(NULL
, "VACUUM");
785 * check that appropriate tables exist.
788 table_exists(const char *dbtab
)
790 struct rsdb_table table
;
791 rsdb_exec_fetch(&table
, "SELECT name FROM sqlite_master WHERE type='table' AND name='%s'",
793 rsdb_exec_fetch_end(&table
);
794 return table
.row_count
;
798 * check that there are actual entries in a table
801 table_has_rows(const char *dbtab
)
803 struct rsdb_table table
;
804 rsdb_exec_fetch(&table
, "SELECT * FROM %s", dbtab
);
805 rsdb_exec_fetch_end(&table
);
806 return table
.row_count
;
810 * completly wipes out an existing ban.db of all entries.
816 rsdb_transaction(RSDB_TRANS_START
);
817 for(i
= 0; i
< LAST_BANDB_TYPE
; i
++)
819 rsdb_exec(NULL
, "DROP TABLE %s", bandb_table
[i
]);
820 i
++; /* double increment to skip over .perm */
822 rsdb_transaction(RSDB_TRANS_END
);
828 * remove pre-existing duplicate bans from the database.
829 * we favor the new, imported ban over the one in the database
832 drop_dupes(const char *user
, const char *host
, const char *t
)
834 rsdb_exec(NULL
, "DELETE FROM %s WHERE mask1='%Q' AND mask2='%Q'", t
, user
, host
);
838 db_error_cb(const char *errstr
)
845 * convert unix timestamp to human readable (small) date
848 bt_smalldate(const char *string
)
850 static char buf
[MAX_DATE_STRING
];
853 t
= strtol(string
, NULL
, 10);
857 snprintf(buf
, sizeof(buf
), "%d/%d/%d %02d.%02d",
858 lt
->tm_year
+ 1900, lt
->tm_mon
+ 1, lt
->tm_mday
, lt
->tm_hour
, lt
->tm_min
);
866 print_help(int i_exit
)
868 fprintf(stderr
, "bantool v.%s - the charybdis database tool.\n", BT_VERSION
);
869 fprintf(stderr
, "Copyright (C) 2008 Daniel J Reidy <dubkat@gmail.com>\n");
870 fprintf(stderr
, "This program is distributed in the hope that it will be useful,\n"
871 "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
872 "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n"
873 "GNU General Public License for more details.\n\n");
875 fprintf(stderr
, "Usage: %s <-i|-e> [-p] [-v] [-h] [-d] [-w] [path]\n", me
);
876 fprintf(stderr
, " -h : Display some slightly useful help.\n");
877 fprintf(stderr
, " -i : Actually import configs into your database.\n");
878 fprintf(stderr
, " -e : Export your database to old-style flat files.\n");
880 " This is suitable for redistrubuting your banlists, or creating backups.\n");
881 fprintf(stderr
, " -s : Reclaim empty slack space the database may be taking up.\n");
882 fprintf(stderr
, " -u : Update the database tables to support any new features.\n");
884 " This is automaticlly done if you are importing or exporting\n");
885 fprintf(stderr
, " but should be run whenever you upgrade the ircd.\n");
887 " -p : pretend, checks for the configs, and parses them, then tells you some data...\n");
888 fprintf(stderr
, " but does not touch your database.\n");
890 " -v : Be verbose... and it *is* very verbose! (intended for debugging)\n");
891 fprintf(stderr
, " -d : Enable checking for redunant entries.\n");
892 fprintf(stderr
, " -w : Completly wipe your database clean. May be used with -i \n");
894 " path : An optional directory containing old ratbox configs for import, or export.\n");
895 fprintf(stderr
, " If not specified, it looks in PREFIX/etc.\n");