/*

    kbs - Simple, easily fooled, POP3 spam filter

    Copyright (C) 2003  Ian Cowburn (ianc@noddybox.demon.co.uk)

    This program 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 2 of the License, or
    (at your option) any later version.

    This program 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 this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    -------------------------------------------------------------------------

    $Id$

    Rules database

*/

#ifndef KBS_DBASE_H
#define KBS_DBASE_H "$Id$"

#include "msg.h"
#include "rexp.h"

/* ---------------------------------------- TYPES
*/
struct Domain;

typedef struct Domain Domain;


/* ---------------------------------------- INTERFACES
*/

/* Add a new domain and define the regular expression that defines it.
   re will be freed by the database when closed.
*/
Domain		*DBNewDomain(RE_Expression name);


/* Define the default mode for a domain
*/
void		DBDefault(Domain *domain, int block);


/* Adds a disallowed username for a domain
*/
void		DBBlockUser(Domain *domain, const char *username);


/* Add an allowable subject for a domain.
   re will be freed by the database when closed.
*/
void		DBAllowSubject(Domain *domain, RE_Expression re);


/* Adds a disallowed subject for a domain.
   re will be freed by the database when closed.
*/
void		DBBlockSubject(Domain *domain, RE_Expression re);


/* Sets the allowed 'To:' name for a domain.
   re will be freed by the database when closed.
*/
void		DBAllowTo(Domain *domain, RE_Expression re);


/* Adds a trusted username
*/
void		DBTrustedUser(const char *username);


/* Adds a trusted domain
*/
void		DBTrustedDomain(const char *domain);


/* Adds a blacklisted domain
*/
void		DBBlacklist(RE_Expression re);


/* Returns TRUE if message is to be blocked
*/
int		DBBlockMessage(const POP3Message *msg);


/* Returns reason for last block if message is to be blocked.
*/
const char	*DBBlockReason(void);


/* Free up memory allocated to database.
*/
void		DBClose(void);


/* Dump the database if debugging is enabled
*/
void		DBDump(void);


#endif

/* END OF FILE */