]>
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'))
47 #define BT_VERSION "0.4.1"
63 static char bandb_letter
[LAST_BANDB_TYPE
] = {
64 'K', 'K', 'D', 'D', 'X', 'X', 'R', 'R'
67 static const char *bandb_table
[LAST_BANDB_TYPE
] = {
68 "kline", "kline", "dline", "dline", "xline", "xline", "resv", "resv"
71 static const char *bandb_suffix
[LAST_BANDB_TYPE
] = {
78 static char me
[PATH_MAX
];
89 } count
= {0, 0, 0, 0, 0};
91 /* flags set by command line options */
103 } flag
= {true, false, false, false, false, false, false, false, false};
106 static int table_has_rows(const char *table
);
107 static int table_exists(const char *table
);
109 static const char *clean_gecos_field(const char *gecos
);
110 static char *bt_smalldate(const char *string
);
111 static char *getfield(char *newline
);
112 static char *strip_quotes(const char *string
);
113 static char *mangle_reason(const char *string
);
114 static char *escape_quotes(const char *string
);
116 static void db_error_cb(const char *errstr
);
117 static void db_reclaim_slack(void);
118 static void export_config(const char *conf
, int id
);
119 static void import_config(const char *conf
, int id
);
120 static void check_schema(void);
121 static void print_help(int i_exit
) __attribute__((noreturn
));
122 static void wipe_schema(void);
123 static void drop_dupes(const char *user
, const char *host
, const char *t
);
129 main(int argc
, char *argv
[])
136 rb_strlcpy(me
, argv
[0], sizeof(me
));
138 while((opt
= getopt(argc
, argv
, "hieuspvwd")) != -1)
143 print_help(EXIT_SUCCESS
);
171 flag
.dupes_ok
= true;
174 print_help(EXIT_FAILURE
);
178 /* they should really read the help. */
180 print_help(EXIT_FAILURE
);
182 if((flag
.import && flag
.export
) || (flag
.export
&& flag
.wipe
)
183 || (flag
.verify
&& flag
.pretend
) || (flag
.export
&& flag
.pretend
))
185 fprintf(stderr
, "* Error: Conflicting flags.\n");
186 if(flag
.export
&& flag
.pretend
)
187 fprintf(stderr
, "* There is nothing to 'pretend' when exporting.\n");
189 fprintf(stderr
, "* For an explination of commands, run: %s -h\n", me
);
193 if(argv
[optind
] != NULL
)
194 rb_strlcpy(etc
, argv
[optind
], sizeof(etc
));
196 rb_strlcpy(etc
, ETCPATH
, sizeof(ETCPATH
));
199 "* charybdis bantool v.%s\n", BT_VERSION
);
201 if(flag
.pretend
== false)
203 if(rsdb_init(db_error_cb
) == -1)
205 fprintf(stderr
, "* Error: Unable to open database\n");
213 if(flag
.import && flag
.wipe
)
215 flag
.dupes_ok
= true; /* dont check for dupes if we are wiping the db clean */
216 for(i
= 0; i
< 3; i
++)
218 "* WARNING: YOU ARE ABOUT TO WIPE YOUR DATABASE!\n");
220 fprintf(stdout
, "* Press ^C to abort! ");
223 fprintf(stdout
, "Carrying on...\n");
227 if(flag
.verbose
&& flag
.dupes_ok
== true)
228 fprintf(stdout
, "* Allowing duplicate bans...\n");
230 /* checking for our files to import or export */
231 for(i
= 0; i
< LAST_BANDB_TYPE
; i
++)
233 if (snprintf(conf
, sizeof(conf
), "%s/%s.conf%s",
234 etc
, bandb_table
[i
], bandb_suffix
[i
]) >= sizeof(conf
)) {
235 fprintf(stderr
, "* Error: Config filename too long\n");
239 if(flag
.import && flag
.pretend
== false)
240 rsdb_transaction(RSDB_TRANS_START
);
243 import_config(conf
, i
);
246 export_config(conf
, i
);
248 if(flag
.import && flag
.pretend
== false)
249 rsdb_transaction(RSDB_TRANS_END
);
254 if(count
.error
&& flag
.verbose
)
255 fprintf(stderr
, "* I was unable to locate %u config files to import.\n",
258 fprintf(stdout
, "* Import Stats: Klines: %u, Dlines: %u, Xlines: %u, Resvs: %u \n",
259 count
.klines
, count
.dlines
, count
.xlines
, count
.resvs
);
262 "*\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");
266 "* Pretend mode engaged. Nothing was actually entered into the database.\n");
274 * export the database to old-style flat files
277 export_config(const char *conf
, int id
)
279 struct rsdb_table table
;
280 static char sql
[BUFSIZE
* 2];
281 static char buf
[512];
285 /* for sanity sake */
288 const int reason
= 2;
291 /* const int perm = 5; */
293 if(!table_has_rows(bandb_table
[id
]))
296 if(strstr(conf
, ".perm") != 0)
297 snprintf(sql
, sizeof(sql
),
298 "SELECT DISTINCT mask1,mask2,reason,oper,time FROM %s WHERE perm = 1 ORDER BY time",
301 snprintf(sql
, sizeof(sql
),
302 "SELECT DISTINCT mask1,mask2,reason,oper,time FROM %s WHERE perm = 0 ORDER BY time",
305 rsdb_exec_fetch(&table
, sql
);
306 if(table
.row_count
<= 0)
308 rsdb_exec_fetch_end(&table
);
313 fprintf(stdout
, "* checking for %s: ", conf
); /* debug */
315 /* open config for reading, or skip to the next */
316 if(!(fd
= fopen(conf
, "w")))
319 fprintf(stdout
, "\tmissing.\n");
324 for(j
= 0; j
< table
.row_count
; j
++)
329 case BANDB_DLINE_PERM
:
330 snprintf(buf
, sizeof(buf
),
331 "\"%s\",\"%s\",\"\",\"%s\",\"%s\",%s\n",
333 mangle_reason(table
.row
[j
][reason
]),
334 bt_smalldate(table
.row
[j
][ts
]),
335 table
.row
[j
][oper
], table
.row
[j
][ts
]);
339 case BANDB_XLINE_PERM
:
340 snprintf(buf
, sizeof(buf
),
341 "\"%s\",\"0\",\"%s\",\"%s\",%s\n",
342 escape_quotes(table
.row
[j
][mask1
]),
343 mangle_reason(table
.row
[j
][reason
]),
344 table
.row
[j
][oper
], table
.row
[j
][ts
]);
348 case BANDB_RESV_PERM
:
349 snprintf(buf
, sizeof(buf
),
350 "\"%s\",\"%s\",\"%s\",%s\n",
352 mangle_reason(table
.row
[j
][reason
]),
353 table
.row
[j
][oper
], table
.row
[j
][ts
]);
357 default: /* Klines */
358 snprintf(buf
, sizeof(buf
),
359 "\"%s\",\"%s\",\"%s\",\"\",\"%s\",\"%s\",%s\n",
360 table
.row
[j
][mask1
], table
.row
[j
][mask2
],
361 mangle_reason(table
.row
[j
][reason
]),
362 bt_smalldate(table
.row
[j
][ts
]), table
.row
[j
][oper
],
367 fprintf(fd
, "%s", buf
);
370 rsdb_exec_fetch_end(&table
);
372 fprintf(stdout
, "\twritten.\n");
377 * attempt to condense the individual conf functions into one
380 import_config(const char *conf
, int id
)
389 const char *f_mask1
= NULL
;
390 const char *f_mask2
= NULL
;
391 const char *f_oper
= NULL
;
392 const char *f_time
= NULL
;
393 const char *f_reason
= NULL
;
394 const char *f_oreason
= NULL
;
395 char newreason
[REASONLEN
];
398 fprintf(stdout
, "* checking for %s: ", conf
); /* debug */
400 /* open config for reading, or skip to the next */
401 if(!(fd
= fopen(conf
, "r")))
404 fprintf(stdout
, "%*s", strlen(bandb_suffix
[id
]) > 0 ? 10 : 15,
410 if(strstr(conf
, ".perm") != 0)
415 * "SYSTEM","0","banned","stevoo!stevoo@efnet.port80.se{stevoo}",1111080437
417 * "OseK","banned nickname","stevoo!stevoo@efnet.port80.se{stevoo}",1111031619
419 * "194.158.192.0/19","laptop scammers","","2005/3/17 05.33","stevoo!stevoo@efnet.port80.se{stevoo}",1111033988
421 while(fgets(line
, sizeof(line
), fd
))
423 if((p
= strpbrk(line
, "\r\n")) != NULL
)
426 if((*line
== '\0') || (*line
== '#'))
430 f_mask1
= getfield(line
);
432 if(EmptyString(f_mask1
))
439 case BANDB_XLINE_PERM
:
440 f_mask1
= escape_quotes(clean_gecos_field(f_mask1
));
441 getfield(NULL
); /* empty field */
445 case BANDB_RESV_PERM
:
447 case BANDB_DLINE_PERM
:
451 f_mask2
= getfield(NULL
);
452 if(EmptyString(f_mask2
))
458 f_reason
= getfield(NULL
);
459 if(EmptyString(f_reason
))
466 case BANDB_KLINE_PERM
:
468 case BANDB_DLINE_PERM
:
469 f_oreason
= getfield(NULL
);
477 f_oper
= getfield(NULL
);
478 f_time
= strip_quotes(f_oper
+ strlen(f_oper
) + 2);
479 if(EmptyString(f_oper
))
483 if(id
== BANDB_KLINE
|| id
== BANDB_KLINE_PERM
)
485 if(strstr(f_mask1
, "!") != NULL
)
488 "* SKIPPING INVALID KLINE %s@%s set by %s\n",
489 f_mask1
, f_mask2
, f_oper
);
490 fprintf(stderr
, " You may wish to re-apply it correctly.\n");
495 /* append operreason_field to reason_field */
496 if(!EmptyString(f_oreason
))
497 snprintf(newreason
, sizeof(newreason
), "%s | %s", f_reason
, f_oreason
);
499 snprintf(newreason
, sizeof(newreason
), "%s", f_reason
);
501 if(flag
.pretend
== false)
503 if(flag
.dupes_ok
== false)
504 drop_dupes(f_mask1
, f_mask2
, bandb_table
[id
]);
507 "INSERT INTO %s (mask1, mask2, oper, time, perm, reason) VALUES('%Q','%Q','%Q','%Q','%d','%Q')",
508 bandb_table
[id
], f_mask1
, f_mask2
, f_oper
, f_time
, f_perm
,
512 if(flag
.pretend
&& flag
.verbose
)
514 "%s: perm(%d) mask1(%s) mask2(%s) oper(%s) reason(%s) time(%s)\n",
515 bandb_table
[id
], f_perm
, f_mask1
, f_mask2
, f_oper
, newreason
,
521 switch (bandb_letter
[id
])
540 fprintf(stdout
, "%*s\n", strlen(bandb_suffix
[id
]) > 0 ? 10 : 15, "imported.");
550 * inputs - input buffer
551 * output - next field
552 * side effects - field breakup for ircd.conf file.
555 getfield(char *newline
)
557 static char *line
= NULL
;
568 /* XXX make this skip to first " if present */
572 return (NULL
); /* mal-formed field */
574 end
= strchr(line
, ',');
578 /* no trailing , - last field */
581 end
= line
+ strlen(line
);
594 /* look for a ", to mark the end of a field.. */
595 if(*(end
- 1) == '"')
603 /* search for the next ',' */
605 end
= strchr(end
, ',');
613 * strip away "quotes" from around strings
616 strip_quotes(const char *string
)
618 static char buf
[14]; /* int(11) + 2 + \0 */
637 * escape quotes in a string
640 escape_quotes(const char *string
)
642 static char buf
[BUFSIZE
* 2];
667 mangle_reason(const char *string
)
669 static char buf
[BUFSIZE
* 2];
698 * change spaces to \s in gecos field
701 clean_gecos_field(const char *gecos
)
703 static char buf
[BUFSIZE
* 2];
725 * verify the database integrity, and if necessary create apropriate tables
731 char type
[8]; /* longest string is 'INTEGER\0' */
733 if(flag
.verify
|| flag
.verbose
)
734 fprintf(stdout
, "* Verifying database.\n");
736 const char *columns
[] = {
746 for(i
= 0; i
< LAST_BANDB_TYPE
; i
+= 2 /* skip over _PERM */)
748 if(!table_exists(bandb_table
[i
]))
751 "CREATE TABLE %s (mask1 TEXT, mask2 TEXT, oper TEXT, time INTEGER, perm INTEGER, reason TEXT)",
756 * i can't think of any better way to do this, other then attempt to
757 * force the creation of column that may, or may not already exist. --dubkat
761 for(j
= 0; columns
[j
] != NULL
; j
++)
763 if(!strcmp(columns
[j
], "time") && !strcmp(columns
[j
], "perm"))
764 rb_strlcpy(type
, "INTEGER", sizeof(type
));
766 rb_strlcpy(type
, "TEXT", sizeof(type
));
768 /* attempt to add a column with extreme prejudice, errors are ignored */
769 rsdb_exec(NULL
, "ALTER TABLE %s ADD COLUMN %s %s", bandb_table
[i
],
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
+= 2 /* double increment to skip over _PERM */)
819 rsdb_exec(NULL
, "DROP TABLE %s", bandb_table
[i
]);
821 rsdb_transaction(RSDB_TRANS_END
);
827 * remove pre-existing duplicate bans from the database.
828 * we favor the new, imported ban over the one in the database
831 drop_dupes(const char *user
, const char *host
, const char *t
)
833 rsdb_exec(NULL
, "DELETE FROM %s WHERE mask1='%Q' AND mask2='%Q'", t
, user
, host
);
837 db_error_cb(const char *errstr
)
844 * convert unix timestamp to human readable (small) date
847 bt_smalldate(const char *string
)
849 static char buf
[MAX_DATE_STRING
];
852 t
= strtol(string
, NULL
, 10);
856 snprintf(buf
, sizeof(buf
), "%d/%d/%d %02d.%02d",
857 lt
->tm_year
+ 1900, lt
->tm_mon
+ 1, lt
->tm_mday
, lt
->tm_hour
, lt
->tm_min
);
865 print_help(int i_exit
)
867 fprintf(stderr
, "bantool v.%s - the charybdis database tool.\n", BT_VERSION
);
868 fprintf(stderr
, "Copyright (C) 2008 Daniel J Reidy <dubkat@gmail.com>\n");
869 fprintf(stderr
, "This program is distributed in the hope that it will be useful,\n"
870 "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
871 "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n"
872 "GNU General Public License for more details.\n\n");
874 fprintf(stderr
, "Usage: %s <-i|-e> [-p] [-v] [-h] [-d] [-w] [path]\n", me
);
875 fprintf(stderr
, " -h : Display some slightly useful help.\n");
876 fprintf(stderr
, " -i : Actually import configs into your database.\n");
877 fprintf(stderr
, " -e : Export your database to old-style flat files.\n");
879 " This is suitable for redistrubuting your banlists, or creating backups.\n");
880 fprintf(stderr
, " -s : Reclaim empty slack space the database may be taking up.\n");
881 fprintf(stderr
, " -u : Update the database tables to support any new features.\n");
883 " This is automaticlly done if you are importing or exporting\n");
884 fprintf(stderr
, " but should be run whenever you upgrade the ircd.\n");
886 " -p : pretend, checks for the configs, and parses them, then tells you some data...\n");
887 fprintf(stderr
, " but does not touch your database.\n");
889 " -v : Be verbose... and it *is* very verbose! (intended for debugging)\n");
890 fprintf(stderr
, " -d : Enable checking for redunant entries.\n");
891 fprintf(stderr
, " -w : Completly wipe your database clean. May be used with -i \n");
893 " path : An optional directory containing old ratbox configs for import, or export.\n");
894 fprintf(stderr
, " If not specified, it looks in PREFIX/etc.\n");