trunk/src/whowas.c

/*
 *  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.c
 * \brief WHOWAS user cache.
 * \version $Id$
 */

#include "stdinc.h"
#include "list.h"
#include "mempool.h"
#include "whowas.h"
#include "client.h"
#include "hash.h"
#include "irc_string.h"
#include "ircd.h"
#include "send.h"
#include "conf.h"


static mp_pool_t *whowas_pool;

static dlink_list whowas_list;  /*! Chain of struct Whowas pointers */
dlink_list WHOWASHASH[HASHSIZE];


/*! \brief Initializes the whowas memory pool.
 */
void
whowas_init(void)
{
  whowas_pool = mp_pool_new(sizeof(struct Whowas), MP_CHUNK_SIZE_WHOWAS);
}

/*! \brief Unlinks a Whowas struct from its associated lists.
 * \param whowas Pointer to Whowas struct to be unlinked.
 */
static struct Whowas *
whowas_unlink(struct Whowas *whowas)
{
  if (!whowas)  /* Can be NULL. */
    return NULL;

  if (whowas->online)
    dlinkDelete(&whowas->cnode, &whowas->online->whowas);

  dlinkDelete(&whowas->tnode, &WHOWASHASH[whowas->hashv]);
  dlinkDelete(&whowas->lnode, &whowas_list);

  return whowas;
}

/*! \brief Unlinks a Whowas struct from its associated lists
 *         and returns memory back to the pooling allocator.
 * \param whowas Pointer to Whowas struct to be unlinked and freed.
 */
static void
whowas_free(struct Whowas *whowas)
{
  whowas_unlink(whowas);
  mp_pool_release(whowas);
}

/*! \brief Returns a Whowas struct for further use. Either allocates
 *         a new one, or returns the oldest entry from the whowas_list
 *         if it ran over ConfigGeneral.whowas_history_length
 */
static struct Whowas *
whowas_make(void)
{
  struct Whowas *whowas;

  if (dlink_list_length(&whowas_list) >= ConfigGeneral.whowas_history_length)
    whowas = whowas_unlink(whowas_list.tail->data);  /* Re-use oldest item */
  else
    whowas = mp_pool_get(whowas_pool);

  return whowas;
}

/*! \brief Trims the whowas_list if necessary until there are no
 *         more than ConfigGeneral.whowas_history_length Whowas
 *         struct items.
 */
void
whowas_trim(void)
{
  while (dlink_list_length(&whowas_list) >= ConfigGeneral.whowas_history_length)
  {
    if (!whowas_list.tail->data)
      return;  /* whowas_list is now empty. No more items can be freed. */

    whowas_free(whowas_list.tail->data);
  }
}

/*! \brief Adds 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.
 * \param client_p Pointer to Client struct to add to whowas history
 * \param online   Either 1 if it's a nick change or 0 on client exit
 */
void
whowas_add_history(struct Client *client_p, const int online)
{
  struct Whowas *whowas = whowas_make();

  if (!whowas)  /* Can be NULL. */
    return;

  assert(IsClient(client_p));

  whowas->hashv = strhash(client_p->name);
  whowas->shide = IsHidden(client_p->servptr) != 0;
  whowas->logoff = CurrentTime;

  strlcpy(whowas->account, client_p->account, sizeof(whowas->account));
  strlcpy(whowas->name, client_p->name, sizeof(whowas->name));
  strlcpy(whowas->username, client_p->username, sizeof(whowas->username));
  strlcpy(whowas->hostname, client_p->host, sizeof(whowas->hostname));
  strlcpy(whowas->sockhost, client_p->sockhost, sizeof(whowas->sockhost));
  strlcpy(whowas->realname, client_p->info, sizeof(whowas->realname));
  strlcpy(whowas->servername, client_p->servptr->name, sizeof(whowas->servername));

  if (online)
  {
    whowas->online = client_p;
    dlinkAdd(whowas, &whowas->cnode, &client_p->whowas);
  }
  else
    whowas->online = NULL;

  dlinkAdd(whowas, &whowas->tnode, &WHOWASHASH[whowas->hashv]);
  dlinkAdd(whowas, &whowas->lnode, &whowas_list);
}

/*! \brief 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.
 * \param client_p Pointer to Client struct
 */
void
whowas_off_history(struct Client *client_p)
{
  while (client_p->whowas.head)
  {
    struct Whowas *whowas = client_p->whowas.head->data;

    whowas->online = NULL;
    dlinkDelete(&whowas->cnode, &client_p->whowas);
  }
}

/*! \brief Returns the current client that was using the given
 *         nickname within the timelimit. Returns NULL, if no
 *         one found.
 * \param name      Name of the nick
 * \param timelimit Maximum age for a client since log-off
 */
struct Client *
whowas_get_history(const char *name, uintmax_t timelimit)
{
  dlink_node *node = NULL;

  timelimit = CurrentTime - timelimit;

  DLINK_FOREACH(node, WHOWASHASH[strhash(name)].head)
  {
    struct Whowas *whowas = node->data;

    if (whowas->logoff < timelimit)
      continue;
    if (irccmp(name, whowas->name))
      continue;
    return whowas->online;
  }

  return NULL;
}

/*! \brief For debugging. Counts allocated structures stored in whowas_list
 */
void
whowas_count_memory(unsigned int *const count, size_t *const bytes)
{
  (*count) = dlink_list_length(&whowas_list);
  (*bytes) = dlink_list_length(&whowas_list) * sizeof(struct Whowas);
}
Revision:	7442
Committed:	Thu Mar 10 20:27:23 2016 UTC (9 years, 5 months ago) by michael
Content type:	text/x-csrc
File size:	5918 byte(s)
Log Message:	- whowas.c: documentation
#	User	Rev	Content
1	adx	30	/*
2	michael	2916	* 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	2916	/*! \file whowas.c
23			* \brief WHOWAS user cache.
24			* \version $Id$
25			*/
26
27	adx	30	#include "stdinc.h"
28	michael	1358	#include "list.h"
29	michael	7437	#include "mempool.h"
30	adx	30	#include "whowas.h"
31			#include "client.h"
32			#include "hash.h"
33			#include "irc_string.h"
34			#include "ircd.h"
35	michael	7437	#include "send.h"
36			#include "conf.h"
37	adx	30
38
39	michael	7437	static mp_pool_t *whowas_pool;
40
41			static dlink_list whowas_list; /! Chain of struct Whowas pointers /
42	michael	1358	dlink_list WHOWASHASH[HASHSIZE];
43	adx	30
44
45	michael	7442	/*! \brief Initializes the whowas memory pool.
46	michael	7393	*/
47	adx	30	void
48	michael	1997	whowas_init(void)
49			{
50	michael	7442	whowas_pool = mp_pool_new(sizeof(struct Whowas), MP_CHUNK_SIZE_WHOWAS);
51	michael	1997	}
52
53	michael	7437	/*! \brief Unlinks a Whowas struct from its associated lists.
54	michael	7442	* \param whowas Pointer to Whowas struct to be unlinked.
55	michael	7437	*/
56			static struct Whowas *
57			whowas_unlink(struct Whowas *whowas)
58			{
59			if (!whowas) /* Can be NULL. */
60			return NULL;
61
62			if (whowas->online)
63			dlinkDelete(&whowas->cnode, &whowas->online->whowas);
64
65			dlinkDelete(&whowas->tnode, &WHOWASHASH[whowas->hashv]);
66			dlinkDelete(&whowas->lnode, &whowas_list);
67
68			return whowas;
69			}
70
71			/*! \brief Unlinks a Whowas struct from its associated lists
72			* and returns memory back to the pooling allocator.
73	michael	7442	* \param whowas Pointer to Whowas struct to be unlinked and freed.
74	michael	7437	*/
75			static void
76			whowas_free(struct Whowas *whowas)
77			{
78			whowas_unlink(whowas);
79			mp_pool_release(whowas);
80			}
81
82			/*! \brief Returns a Whowas struct for further use. Either allocates
83			* a new one, or returns the oldest entry from the whowas_list
84			* if it ran over ConfigGeneral.whowas_history_length
85			*/
86			static struct Whowas *
87			whowas_make(void)
88			{
89			struct Whowas *whowas;
90
91			if (dlink_list_length(&whowas_list) >= ConfigGeneral.whowas_history_length)
92	michael	7441	whowas = whowas_unlink(whowas_list.tail->data); /* Re-use oldest item */
93	michael	7437	else
94			whowas = mp_pool_get(whowas_pool);
95
96			return whowas;
97			}
98
99			/*! \brief Trims the whowas_list if necessary until there are no
100			* more than ConfigGeneral.whowas_history_length Whowas
101			* struct items.
102			*/
103			void
104			whowas_trim(void)
105			{
106			while (dlink_list_length(&whowas_list) >= ConfigGeneral.whowas_history_length)
107			{
108			if (!whowas_list.tail->data)
109			return; /* whowas_list is now empty. No more items can be freed. */
110
111			whowas_free(whowas_list.tail->data);
112			}
113			}
114
115	michael	7393	/*! \brief Adds the currently defined name of the client to history.
116			* Usually called before changing to a new name (nick).
117			* Client must be a fully registered user.
118	michael	7442	* \param client_p Pointer to Client struct to add to whowas history
119			* \param online Either 1 if it's a nick change or 0 on client exit
120	michael	7393	*/
121	michael	1997	void
122	michael	2300	whowas_add_history(struct Client *client_p, const int online)
123	adx	30	{
124	michael	7437	struct Whowas *whowas = whowas_make();
125	adx	30
126	michael	7437	if (!whowas) /* Can be NULL. */
127			return;
128
129	michael	3273	assert(IsClient(client_p));
130	adx	30
131	michael	6654	whowas->hashv = strhash(client_p->name);
132			whowas->shide = IsHidden(client_p->servptr) != 0;
133			whowas->logoff = CurrentTime;
134	adx	30
135	michael	6654	strlcpy(whowas->account, client_p->account, sizeof(whowas->account));
136			strlcpy(whowas->name, client_p->name, sizeof(whowas->name));
137			strlcpy(whowas->username, client_p->username, sizeof(whowas->username));
138			strlcpy(whowas->hostname, client_p->host, sizeof(whowas->hostname));
139			strlcpy(whowas->sockhost, client_p->sockhost, sizeof(whowas->sockhost));
140			strlcpy(whowas->realname, client_p->info, sizeof(whowas->realname));
141			strlcpy(whowas->servername, client_p->servptr->name, sizeof(whowas->servername));
142	adx	30
143			if (online)
144			{
145	michael	6654	whowas->online = client_p;
146			dlinkAdd(whowas, &whowas->cnode, &client_p->whowas);
147	adx	30	}
148			else
149	michael	6654	whowas->online = NULL;
150	adx	30
151	michael	6654	dlinkAdd(whowas, &whowas->tnode, &WHOWASHASH[whowas->hashv]);
152	michael	7437	dlinkAdd(whowas, &whowas->lnode, &whowas_list);
153	adx	30	}
154
155	michael	7393	/*! \brief This must be called when the client structure is about to
156			* be released. History mechanism keeps pointers to client
157			* structures and it must know when they cease to exist.
158	michael	7442	* \param client_p Pointer to Client struct
159	michael	7393	*/
160	adx	30	void
161	michael	2300	whowas_off_history(struct Client *client_p)
162	adx	30	{
163	michael	7244	while (client_p->whowas.head)
164	adx	30	{
165	michael	7244	struct Whowas *whowas = client_p->whowas.head->data;
166	michael	1358
167	michael	6654	whowas->online = NULL;
168			dlinkDelete(&whowas->cnode, &client_p->whowas);
169	adx	30	}
170			}
171
172	michael	7393	/*! \brief Returns the current client that was using the given
173			* nickname within the timelimit. Returns NULL, if no
174	michael	7437	* one found.
175	michael	7442	* \param name Name of the nick
176			* \param timelimit Maximum age for a client since log-off
177	michael	7393	*/
178	adx	30	struct Client *
179	michael	7394	whowas_get_history(const char *name, uintmax_t timelimit)
180	adx	30	{
181	michael	4800	dlink_node *node = NULL;
182	adx	30
183			timelimit = CurrentTime - timelimit;
184
185	michael	7394	DLINK_FOREACH(node, WHOWASHASH[strhash(name)].head)
186	adx	30	{
187	michael	6654	struct Whowas *whowas = node->data;
188	michael	1358
189	michael	6654	if (whowas->logoff < timelimit)
190	michael	1358	continue;
191	michael	7394	if (irccmp(name, whowas->name))
192	adx	30	continue;
193	michael	6654	return whowas->online;
194	adx	30	}
195
196	michael	1298	return NULL;
197	adx	30	}
198
199	michael	7437	/*! \brief For debugging. Counts allocated structures stored in whowas_list
200	michael	7393	*/
201	adx	30	void
202	michael	6719	whowas_count_memory(unsigned int const count, size_t const bytes)
203	adx	30	{
204	michael	7437	(*count) = dlink_list_length(&whowas_list);
205			(bytes) = dlink_list_length(&whowas_list) sizeof(struct Whowas);
206	adx	30	}