[irc/rqf/shadowircd.git] / include / whowas.h

/*
 *  ircd-ratbox: A slightly useful ircd.
 *  whowas.h: Header for the whowas functions.
 *
 *  Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
 *  Copyright (C) 1996-2002 Hybrid Development Team
 *  Copyright (C) 2002-2004 ircd-ratbox development team
 *
 *  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: whowas.h 1717 2006-07-04 14:41:11Z jilles $
 */
#ifndef INCLUDED_whowas_h
#define INCLUDED_whowas_h

#include "ircd_defs.h"
#include "client.h"

#include "setup.h"

/*
 * Whowas hash table size
 *
 */
#define WW_MAX_BITS 16
#define WW_MAX 65536

struct User;
struct Client;

/*
  lets speed this up...
  also removed away information. *tough*
  - Dianora
 */
struct Whowas
{
	int hashv;
	char name[NICKLEN + 1];
	char username[USERLEN + 1];
	char hostname[HOSTLEN + 1];
	char sockhost[HOSTIPLEN + 1];
	const char *servername;
	char realname[REALLEN + 1];
	time_t logoff;
	struct Client *online;	/* Pointer to new nickname for chasing or NULL */
	struct Whowas *next;	/* for hash table... */
	struct Whowas *prev;	/* for hash table... */
	struct Whowas *cnext;	/* for client struct linked list */
	struct Whowas *cprev;	/* for client struct linked list */
};

/*
** initwhowas
*/
extern void initwhowas(void);

/*
** add_history
**      Add the currently defined name of the client to history.
**      usually called before changing to a new name (nick).
**      Client must be a fully registered user (specifically,
**      the user structure must have been allocated).
*/
void add_history(struct Client *, int);

/*
** off_history
**      This must be called when the client structure is about to
**      be released. History mechanism keeps pointers to client
**      structures and it must know when they cease to exist. This
**      also implicitly calls AddHistory.
*/
void off_history(struct Client *);

/*
** get_history
**      Return the current client that was using the given
**      nickname within the timelimit. Returns NULL, if no
**      one found...
*/
struct Client *get_history(const char *, time_t);
					/* Nick name */
					/* Time limit in seconds */

/*
** for debugging...counts related structures stored in whowas array.
*/
void count_whowas_memory(size_t *, size_t *);

/* XXX m_whowas.c in modules needs these */
extern struct Whowas WHOWAS[];
extern struct Whowas *WHOWASHASH[];
extern unsigned int hash_whowas_name(const char *name);

#endif /* INCLUDED_whowas_h */
Commit	Line	Data
212380e3	1	/*
	2	* ircd-ratbox: A slightly useful ircd.
	3	* whowas.h: Header for the whowas functions.
	4	*
	5	* Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
	6	* Copyright (C) 1996-2002 Hybrid Development Team
	7	* Copyright (C) 2002-2004 ircd-ratbox development team
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
	22	* USA
	23	*
	24	* $Id: whowas.h 1717 2006-07-04 14:41:11Z jilles $
	25	*/
	26	#ifndef INCLUDED_whowas_h
	27	#define INCLUDED_whowas_h
	28
	29	#include "ircd_defs.h"
	30	#include "client.h"
	31
	32	#include "setup.h"
	33
	34	/*
	35	* Whowas hash table size
	36	*
	37	*/
	38	#define WW_MAX_BITS 16
	39	#define WW_MAX 65536
	40
	41	struct User;
	42	struct Client;
	43
	44	/*
	45	lets speed this up...
	46	also removed away information. tough
	47	- Dianora
	48	*/
	49	struct Whowas
	50	{
	51	int hashv;
	52	char name[NICKLEN + 1];
	53	char username[USERLEN + 1];
	54	char hostname[HOSTLEN + 1];
	55	char sockhost[HOSTIPLEN + 1];
	56	const char *servername;
	57	char realname[REALLEN + 1];
	58	time_t logoff;
	59	struct Client online; / Pointer to new nickname for chasing or NULL */
	60	struct Whowas next; / for hash table... */
	61	struct Whowas prev; / for hash table... */
	62	struct Whowas cnext; / for client struct linked list */
	63	struct Whowas cprev; / for client struct linked list */
	64	};
65
66	/*
67	** initwhowas
68	*/
69	extern void initwhowas(void);
70
71	/*
72	** add_history
73	** Add the currently defined name of the client to history.
74	** usually called before changing to a new name (nick).
75	** Client must be a fully registered user (specifically,
76	** the user structure must have been allocated).
77	*/
78	void add_history(struct Client *, int);
79
80	/*
81	** off_history
82	** This must be called when the client structure is about to
83	** be released. History mechanism keeps pointers to client
84	** structures and it must know when they cease to exist. This
85	** also implicitly calls AddHistory.
86	*/
87	void off_history(struct Client *);
88
89	/*
90	** get_history
91	** Return the current client that was using the given
92	** nickname within the timelimit. Returns NULL, if no
93	** one found...
94	*/
95	struct Client get_history(const char , time_t);
96	/* Nick name */
97	/* Time limit in seconds */
98
99	/*
100	** for debugging...counts related structures stored in whowas array.
101	*/
102	void count_whowas_memory(size_t , size_t );
103
104	/* XXX m_whowas.c in modules needs these */
105	extern struct Whowas WHOWAS[];
106	extern struct Whowas *WHOWASHASH[];
107	extern unsigned int hash_whowas_name(const char *name);
108
109	#endif /* INCLUDED_whowas_h */