trunk/include/whowas.h

/*
 *  ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
 *
 *  Copyright (c) 1997-2016 ircd-hybrid 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 *  USA
 */

/*! \file whowas.h
 * \brief A header for the whowas functions.
 * \version $Id$
 */

#ifndef INCLUDED_whowas_h
#define INCLUDED_whowas_h

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


enum { NICKNAMEHISTORYLENGTH = 32768 };

struct Whowas
{
  int hashv;
  int shide;
  time_t logoff;
  char account[ACCOUNTLEN + 1];  /**< Services account */
  char name[NICKLEN + 1];
  char username[USERLEN + 1];
  char hostname[HOSTLEN + 1];
  char sockhost[HOSTIPLEN + 1];  /**< This is the host name from the socket ip address as string */
  char realname[REALLEN + 1];
  char servername[HOSTLEN + 1];
  struct Client *online; /* Pointer to new nickname for chasing or NULL */
  dlink_node tnode;      /* for hash table...                           */
  dlink_node cnode;      /* for client struct linked list               */
};

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

/*
** whowas_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.
*/
extern void whowas_add_history(struct Client *, const int);

/*
** whowas_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.
*/
extern void whowas_off_history(struct Client *);

/*
** whowas_get_history
**      Return the current client that was using the given
**      nickname within the timelimit. Returns NULL, if no
**      one found...
*/
extern struct Client *whowas_get_history(const char *, time_t);

/*
** for debugging...counts related structures stored in whowas array.
*/
extern void whowas_count_memory(unsigned int *const, size_t *const);
extern dlink_list WHOWASHASH[];
#endif /* INCLUDED_whowas_h */
Revision:	7006
Committed:	Fri Jan 1 00:07:54 2016 UTC (9 years, 7 months ago) by michael
Content type:	text/x-chdr
File size:	2788 byte(s)
Log Message:	- Update copyright years
#	User	Rev	Content
1	adx	30	/*
2	michael	2865	* ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
3	adx	30	*
4	michael	7006	* Copyright (c) 1997-2016 ircd-hybrid development team
5	adx	30	*
6			* This program 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 2 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 this program; if not, write to the Free Software
18	michael	4565	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
19	adx	30	* USA
20			*/
21
22	michael	2865	/*! \file whowas.h
23			* \brief A header for the whowas functions.
24			* \version $Id$
25			*/
26
27	adx	30	#ifndef INCLUDED_whowas_h
28			#define INCLUDED_whowas_h
29
30			#include "ircd_defs.h"
31			#include "client.h"
32	michael	912	#include "config.h"
33	adx	30
34	michael	1358
35	michael	6347	enum { NICKNAMEHISTORYLENGTH = 32768 };
36	michael	6123
37	adx	30	struct Whowas
38			{
39			int hashv;
40	michael	2748	int shide;
41	adx	30	time_t logoff;
42	michael	5573	char account[ACCOUNTLEN + 1]; /*< Services account /
43	michael	1431	char name[NICKLEN + 1];
44	michael	1358	char username[USERLEN + 1];
45	adx	30	char hostname[HOSTLEN + 1];
46	michael	5631	char sockhost[HOSTIPLEN + 1]; /*< This is the host name from the socket ip address as string /
47	adx	30	char realname[REALLEN + 1];
48			char servername[HOSTLEN + 1];
49			struct Client online; / Pointer to new nickname for chasing or NULL */
50	michael	1358	dlink_node tnode; /* for hash table... */
51			dlink_node cnode; /* for client struct linked list */
52	adx	30	};
53
54			/*
55			** initwhowas
56			*/
57	michael	1358	extern void whowas_init(void);
58	adx	30
59			/*
60	michael	2300	** whowas_add_history
61	adx	30	** Add the currently defined name of the client to history.
62			** usually called before changing to a new name (nick).
63			** Client must be a fully registered user.
64			*/
65	michael	2300	extern void whowas_add_history(struct Client *, const int);
66	adx	30
67			/*
68	michael	2300	** whowas_off_history
69	adx	30	** This must be called when the client structure is about to
70			** be released. History mechanism keeps pointers to client
71			** structures and it must know when they cease to exist. This
72			** also implicitly calls AddHistory.
73			*/
74	michael	2300	extern void whowas_off_history(struct Client *);
75	adx	30
76			/*
77	michael	2300	** whowas_get_history
78	adx	30	** Return the current client that was using the given
79			** nickname within the timelimit. Returns NULL, if no
80			** one found...
81			*/
82	michael	2300	extern struct Client whowas_get_history(const char , time_t);
83	adx	30
84			/*
85			** for debugging...counts related structures stored in whowas array.
86			*/
87	michael	6719	extern void whowas_count_memory(unsigned int const, size_t const);
88	michael	1358	extern dlink_list WHOWASHASH[];
89	adx	30	#endif /* INCLUDED_whowas_h */