trunk/src/motd.c

/*
 *  ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
 *
 *  Copyright (c) 2000 Kevin L. Mitchell <klmitch@mit.edu>
 *  Copyright (c) 2013-2014 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 *  USA
 */

/*! \file motd.c
 * \brief Message-of-the-day manipulation implementation.
 * \version $Id$
 */

#include "stdinc.h"
#include "list.h"
#include "ircd.h"
#include "conf.h"
#include "send.h"
#include "s_serv.h"
#include "numeric.h"
#include "client.h"
#include "irc_string.h"
#include "memory.h"
#include "log.h"
#include "motd.h"
#include "hostmask.h"


/** Global list of messages of the day. */
static struct
{
  struct Motd *local;    /**< Local MOTD. */
  struct Motd *remote;   /**< Remote MOTD. */
  dlink_list other;      /**< MOTDs specified in configuration file. */
  dlink_list cachelist;  /**< List of MotdCache entries. */
} MotdList;


/*! \brief Create a struct Motd and initialize it.
 * \param hostmask Hostmask (or connection class name) to filter on.
 * \param path Path to MOTD file.
 */
static struct Motd *
motd_create(const char *hostmask, const char *path)
{
  struct Motd *tmp = MyMalloc(sizeof(struct Motd));

  if (EmptyString(hostmask))
    tmp->type = MOTD_UNIVERSAL;
  else if (class_find(hostmask, 1))
    tmp->type = MOTD_CLASS;
  else
  {
    switch (parse_netmask(hostmask, &tmp->address, &tmp->addrbits))
    {
      case HM_IPV4:
      tmp->type = MOTD_IPMASKV4;
      break;
#ifdef IPV6
    case HM_IPV6:
      tmp->type = MOTD_IPMASKV6;
      break;
#endif
    default: /* HM_HOST */
      tmp->type = MOTD_HOSTMASK;
      break;
    }
  }

  if (hostmask)
    tmp->hostmask = xstrdup(hostmask);

  tmp->path = xstrdup(path);
  tmp->maxcount = MOTD_MAXLINES;

  return tmp;
}

/*! brief\ This function reads a motd out of a file (if needed) and caches it.
 * If a matching cache entry already exists, reuse it. Otherwise,
 * allocate and populate a new MotdCache for it.
 * \param motd Specification for MOTD file.
 * \return Matching MotdCache entry.
 */
static struct MotdCache *
motd_cache(struct Motd *motd)
{
  FILE *file = NULL;
  struct MotdCache *cache = NULL;
  struct stat sb;
  char line[MOTD_LINESIZE + 2];  /* +2 for \r\n */
  char *tmp = NULL;
  unsigned int i = 0;
  dlink_node *ptr = NULL;

  assert(motd);
  assert(motd->path);

  if (motd->cache)
    return motd->cache;

  /* Try to find it in the list of cached files... */
  DLINK_FOREACH(ptr, MotdList.cachelist.head)
  {
    cache = ptr->data;

    if (!strcmp(cache->path, motd->path) && cache->maxcount == motd->maxcount)
    {
      cache->ref++;  /* Increase reference count... */
      motd->cache = cache;  /* Remember cache... */
      return motd->cache;  /* Return it */
    }
  }

  /* Need the file's modification time */
  if (stat(motd->path, &sb) == -1)
  {
    ilog(LOG_TYPE_IRCD, "Couldn't stat \"%s\": %s", motd->path,
         strerror(errno));
    return 0;
  }

  /* Gotta read in the file, now */
  if ((file = fopen(motd->path, "r")) == NULL)
  {
    ilog(LOG_TYPE_IRCD, "Couldn't open \"%s\": %s", motd->path,
         strerror(errno));
    return 0;
  }

  /* Ok, allocate a structure; we'll realloc later to trim memory */
  cache = MyMalloc(sizeof(struct MotdCache) + (MOTD_LINESIZE * MOTD_MAXLINES));
  cache->ref = 1;
  cache->path = xstrdup(motd->path);
  cache->maxcount = motd->maxcount;
  cache->modtime = *localtime((time_t *)&sb.st_mtime); /* store modtime */

  while (cache->count < cache->maxcount && fgets(line, sizeof(line), file))
  {
    /* Copy over line, stopping when we overflow or hit line end */
    for (tmp = line, i = 0; i < (MOTD_LINESIZE - 1) && *tmp && *tmp != '\r' && *tmp != '\n'; ++tmp, ++i)
      cache->motd[cache->count][i] = *tmp;
    cache->motd[cache->count][i] = '\0';

    cache->count++;
  }

  fclose(file);  /* Close the file */

  /* Trim memory usage a little */
  motd->cache = MyMalloc(sizeof(struct MotdCache) +
                         (MOTD_LINESIZE * cache->count));
  memcpy(motd->cache, cache, sizeof(struct MotdCache) +
         (MOTD_LINESIZE * cache->count));
  MyFree(cache);

  /* Now link it in... */
  dlinkAdd(motd->cache, &motd->cache->node, &MotdList.cachelist);

  return motd->cache;
}

/*! \brief Clear and dereference the Motd::cache element of \a motd.
 * If the MotdCache::ref count goes to zero, free it.
 * \param motd MOTD to uncache.
 */
static void
motd_decache(struct Motd *motd)
{
  struct MotdCache *cache = NULL;

  assert(motd);

  if ((cache = motd->cache) == NULL)  /* We can be called for records with no cache */
    return;

  motd->cache = NULL;  /* Zero the cache */

  if (--cache->ref == 0)  /* Reduce reference count... */
  {
    dlinkDelete(&cache->node, &MotdList.cachelist);
    MyFree(cache->path);  /* Free path info... */
    MyFree(cache);  /* Very simple for a reason... */
  }
}

/*! \brief Deallocate a MOTD structure.
 * If it has cached content, uncache it.
 * \param motd MOTD to destroy.
 */
static void
motd_destroy(struct Motd *motd)
{
  assert(motd);

  if (motd->cache)  /* Drop the cache */
    motd_decache(motd);

  MyFree(motd->path);  /* We always must have a path */
  MyFree(motd->hostmask);
  MyFree(motd);
}

/*! \brief Find the first matching MOTD block for a user.
 * If the user is remote, always use remote MOTD.
 * Otherwise, if there is a hostmask- or class-based MOTD that matches
 * the user, use it.
 * Otherwise, use the local MOTD.
 * \param client_p Client to find MOTD for.
 * \return Pointer to first matching MOTD for the client.
 */
static struct Motd *
motd_lookup(const struct Client *client_p)
{
  dlink_node *ptr = NULL;
  const struct ClassItem *class = NULL;

  assert(client_p);

  if (!MyClient(client_p))  /* Not my user, always return remote motd */
    return MotdList.remote;

  class = get_class_ptr(&client_p->localClient->confs);
  assert(class);

  /* Check the motd blocks first */
  DLINK_FOREACH(ptr, MotdList.other.head)
  {
    struct Motd *motd = ptr->data;

    switch (motd->type)
    {
      case MOTD_CLASS:
        if (!match(motd->hostmask, class->name))
          return motd;
        break;
      case MOTD_HOSTMASK:
        if (!match(motd->hostmask, client_p->host))
          return motd;
        break;
      case MOTD_IPMASKV4:
          if (client_p->localClient->aftype == AF_INET)
            if (match_ipv4(&client_p->localClient->ip, &motd->address, motd->addrbits))
              return motd;
        break;
#ifdef IPV6
      case MOTD_IPMASKV6:
          if (client_p->localClient->aftype == AF_INET6)
            if (match_ipv6(&client_p->localClient->ip, &motd->address, motd->addrbits))
              return motd;
        break;
#endif
      default: break;
    }
  }

  return MotdList.local;  /* Ok, return the default motd */
}

/*! \brief Send the content of a MotdCache to a user.
 * If \a cache is NULL, simply send ERR_NOMOTD to the client.
 * \param source_p Client to send MOTD to.
 * \param cache MOTD body to send to client.
 */
static void
motd_forward(struct Client *source_p, const struct MotdCache *cache)
{
  if (!cache)  /* No motd to send */
  {
    sendto_one_numeric(source_p, &me, ERR_NOMOTD);
    return;
  }

  /* Send the motd */
  sendto_one_numeric(source_p, &me, RPL_MOTDSTART, me.name);

  for (unsigned int i = 0; i < cache->count; ++i)
    sendto_one_numeric(source_p, &me, RPL_MOTD, cache->motd[i]);
  sendto_one_numeric(source_p, &me, RPL_ENDOFMOTD);
}

/*! \brief Find the MOTD for a client and send it.
 * \param client_p Client being greeted.
 */
void
motd_send(struct Client *client_p)
{
  assert(client_p);

  motd_forward(client_p, motd_cache(motd_lookup(client_p)));
}

/*! \brief Send the signon MOTD to a user.
 * If general::short_motd is true and a matching MOTD exists for the
 * user, direct the client to type /MOTD to read it. Otherwise, call
 * motd_forward() for the user.
 * \param source_p Client that has just connected.
 */
void
motd_signon(struct Client *source_p)
{
  const struct MotdCache *cache = motd_cache(motd_lookup(source_p));

  if (!ConfigFileEntry.short_motd || !cache)
    motd_forward(source_p, cache);
  else
  {
    sendto_one_notice(source_p, &me, ":*** Notice -- motd was last changed at %d/%d/%d %d:%02d",
                      cache->modtime.tm_year + 1900,
                      cache->modtime.tm_mon + 1,
                      cache->modtime.tm_mday,
                      cache->modtime.tm_hour,
                      cache->modtime.tm_min);
    sendto_one_notice(source_p, &me, ":*** Notice -- Please read the motd if you haven't read it");
    sendto_one_numeric(source_p, &me, RPL_MOTDSTART, me.name);
    sendto_one_numeric(source_p, &me, RPL_MOTD,
                       "*** This is the short motd ***");
    sendto_one_numeric(source_p, &me, RPL_ENDOFMOTD);
  }
}

/*! \brief Clear all cached MOTD bodies.
 * The local and remote MOTDs are re-cached immediately.
 */
void
motd_recache(void)
{
  dlink_node *ptr = NULL;

  motd_decache(MotdList.local);  /* Decache local and remote MOTDs */
  motd_decache(MotdList.remote);

  DLINK_FOREACH(ptr, MotdList.other.head)  /* Now all the others */
    motd_decache(ptr->data);

  /* now recache local and remote MOTDs */
  motd_cache(MotdList.local);
  motd_cache(MotdList.remote);
}

/*! \brief Re-cache the local and remote MOTDs.
 * If they already exist, they are deallocated first.
 */
void
motd_init(void)
{
  if (MotdList.local)  /* Destroy old local... */
    motd_destroy(MotdList.local);

  MotdList.local = motd_create(NULL, MPATH);
  motd_cache(MotdList.local);  /* Init local and cache it */

  if (MotdList.remote)  /* Destroy old remote... */
    motd_destroy(MotdList.remote);

  MotdList.remote = motd_create(NULL, MPATH);
  motd_cache(MotdList.remote);  /* Init remote and cache it */
}

/* \brief Add a new MOTD.
 * \param hostmask Hostmask (or connection class name) to send this to.
 * \param path Pathname of file to send.
 */
void
motd_add(const char *hostmask, const char *path)
{
  struct Motd *motd = motd_create(hostmask, path);  /* create the motd */

  dlinkAdd(motd, &motd->node, &MotdList.other);
}

/*! \brief Clear out all MOTDs.
 * Compared to motd_recache(), this destroys all hostmask- or
 * class-based MOTDs rather than simply uncaching them.
 * Re-cache the local and remote MOTDs.
 */
void
motd_clear(void)
{
  dlink_node *ptr = NULL, *ptr_next = NULL;

  motd_decache(MotdList.local);  /* Decache local and remote MOTDs */
  motd_decache(MotdList.remote);

  DLINK_FOREACH_SAFE(ptr, ptr_next, MotdList.other.head)  /* Destroy other MOTDs */
  {
    dlinkDelete(ptr, &MotdList.other);
    motd_destroy(ptr->data);
  }

  /* now recache local and remote MOTDs */
  motd_cache(MotdList.local);
  motd_cache(MotdList.remote);
}

/*! \brief Report list of non-default MOTDs.
 * \param source_p Client requesting statistics.
 */
void
motd_report(struct Client *source_p)
{
  const dlink_node *ptr = NULL;

  DLINK_FOREACH(ptr, MotdList.other.head)
  {
    const struct Motd *motd = ptr->data;

    sendto_one_numeric(source_p, &me, RPL_STATSTLINE,
                       motd->hostmask, motd->path);
  }
}

/*! \brief Report MOTD memory usage to a client.
 * \param source_p Client requesting memory usage.
 */
void
motd_memory_count(struct Client *source_p)
{
  const dlink_node *ptr = NULL;
  unsigned int mt  = 0;  /* motd count */
  unsigned int mtc = 0;  /* motd cache count */
  size_t mtm  = 0;  /* memory consumed by motd */
  size_t mtcm = 0;  /* memory consumed by motd cache */

  if (MotdList.local)
  {
    mt++;
    mtm += sizeof(struct Motd);
    mtm += MotdList.local->path ? (strlen(MotdList.local->path) + 1) : 0;
  }

  if (MotdList.remote)
  {
    mt++;
    mtm += sizeof(struct Motd);
    mtm += MotdList.remote->path ? (strlen(MotdList.remote->path) + 1) : 0;
  }

  DLINK_FOREACH(ptr, MotdList.other.head)
  {
    const struct Motd *motd = ptr->data;

    mt++;
    mtm += sizeof(struct Motd);
    mtm += motd->path ? (strlen(motd->path) + 1) : 0;
  }

  DLINK_FOREACH(ptr, MotdList.cachelist.head)
  {
    const struct MotdCache *cache = ptr->data;

    mtc++;
    mtcm += sizeof(struct MotdCache) + (MOTD_LINESIZE * (cache->count - 1));
  }

  sendto_one(source_p, ":%s %d %s z :Motds %u(%u) Cache %u(%u)",
             me.name, RPL_STATSDEBUG, source_p->name,
             mt, mtm, mtc, mtcm);
}
Revision:	3254
Committed:	Thu Apr 3 16:47:23 2014 UTC (11 years, 4 months ago) by michael
Content type:	text/x-csrc
File size:	13030 byte(s)
Log Message:	- motd.c: update/fix some comments
#	Content
1	/*
2	* ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
3	*
4	* Copyright (c) 2000 Kevin L. Mitchell <klmitch@mit.edu>
5	* Copyright (c) 2013-2014 ircd-hybrid development team
6	*
7	* This program is free software; you can redistribute it and/or modify
8	* it under the terms of the GNU General Public License as published by
9	* the Free Software Foundation; either version 2 of the License, or
10	* (at your option) any later version.
11	*
12	* This program is distributed in the hope that it will be useful,
13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15	* GNU General Public License for more details.
16	*
17	* You should have received a copy of the GNU General Public License
18	* along with this program; if not, write to the Free Software
19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20	* USA
21	*/
22
23	/*! \file motd.c
24	* \brief Message-of-the-day manipulation implementation.
25	* \version $Id$
26	*/
27
28	#include "stdinc.h"
29	#include "list.h"
30	#include "ircd.h"
31	#include "conf.h"
32	#include "send.h"
33	#include "s_serv.h"
34	#include "numeric.h"
35	#include "client.h"
36	#include "irc_string.h"
37	#include "memory.h"
38	#include "log.h"
39	#include "motd.h"
40	#include "hostmask.h"
41
42
43	/** Global list of messages of the day. */
44	static struct
45	{
46	struct Motd local; /< Local MOTD. /
47	struct Motd remote; /< Remote MOTD. /
48	dlink_list other; /*< MOTDs specified in configuration file. /
49	dlink_list cachelist; /*< List of MotdCache entries. /
50	} MotdList;
51
52
53	/*! \brief Create a struct Motd and initialize it.
54	* \param hostmask Hostmask (or connection class name) to filter on.
55	* \param path Path to MOTD file.
56	*/
57	static struct Motd *
58	motd_create(const char hostmask, const char path)
59	{
60	struct Motd *tmp = MyMalloc(sizeof(struct Motd));
61
62	if (EmptyString(hostmask))
63	tmp->type = MOTD_UNIVERSAL;
64	else if (class_find(hostmask, 1))
65	tmp->type = MOTD_CLASS;
66	else
67	{
68	switch (parse_netmask(hostmask, &tmp->address, &tmp->addrbits))
69	{
70	case HM_IPV4:
71	tmp->type = MOTD_IPMASKV4;
72	break;
73	#ifdef IPV6
74	case HM_IPV6:
75	tmp->type = MOTD_IPMASKV6;
76	break;
77	#endif
78	default: /* HM_HOST */
79	tmp->type = MOTD_HOSTMASK;
80	break;
81	}
82	}
83
84	if (hostmask)
85	tmp->hostmask = xstrdup(hostmask);
86
87	tmp->path = xstrdup(path);
88	tmp->maxcount = MOTD_MAXLINES;
89
90	return tmp;
91	}
92
93	/*! brief\ This function reads a motd out of a file (if needed) and caches it.
94	* If a matching cache entry already exists, reuse it. Otherwise,
95	* allocate and populate a new MotdCache for it.
96	* \param motd Specification for MOTD file.
97	* \return Matching MotdCache entry.
98	*/
99	static struct MotdCache *
100	motd_cache(struct Motd *motd)
101	{
102	FILE *file = NULL;
103	struct MotdCache *cache = NULL;
104	struct stat sb;
105	char line[MOTD_LINESIZE + 2]; /* +2 for \r\n */
106	char *tmp = NULL;
107	unsigned int i = 0;
108	dlink_node *ptr = NULL;
109
110	assert(motd);
111	assert(motd->path);
112
113	if (motd->cache)
114	return motd->cache;
115
116	/* Try to find it in the list of cached files... */
117	DLINK_FOREACH(ptr, MotdList.cachelist.head)
118	{
119	cache = ptr->data;
120
121	if (!strcmp(cache->path, motd->path) && cache->maxcount == motd->maxcount)
122	{
123	cache->ref++; /* Increase reference count... */
124	motd->cache = cache; /* Remember cache... */
125	return motd->cache; /* Return it */
126	}
127	}
128
129	/* Need the file's modification time */
130	if (stat(motd->path, &sb) == -1)
131	{
132	ilog(LOG_TYPE_IRCD, "Couldn't stat \"%s\": %s", motd->path,
133	strerror(errno));
134	return 0;
135	}
136
137	/* Gotta read in the file, now */
138	if ((file = fopen(motd->path, "r")) == NULL)
139	{
140	ilog(LOG_TYPE_IRCD, "Couldn't open \"%s\": %s", motd->path,
141	strerror(errno));
142	return 0;
143	}
144
145	/* Ok, allocate a structure; we'll realloc later to trim memory */
146	cache = MyMalloc(sizeof(struct MotdCache) + (MOTD_LINESIZE * MOTD_MAXLINES));
147	cache->ref = 1;
148	cache->path = xstrdup(motd->path);
149	cache->maxcount = motd->maxcount;
150	cache->modtime = localtime((time_t )&sb.st_mtime); /* store modtime */
151
152	while (cache->count < cache->maxcount && fgets(line, sizeof(line), file))
153	{
154	/* Copy over line, stopping when we overflow or hit line end */
155	for (tmp = line, i = 0; i < (MOTD_LINESIZE - 1) && tmp && tmp != '\r' && *tmp != '\n'; ++tmp, ++i)
156	cache->motd[cache->count][i] = *tmp;
157	cache->motd[cache->count][i] = '\0';
158
159	cache->count++;
160	}
161
162	fclose(file); /* Close the file */
163
164	/* Trim memory usage a little */
165	motd->cache = MyMalloc(sizeof(struct MotdCache) +
166	(MOTD_LINESIZE * cache->count));
167	memcpy(motd->cache, cache, sizeof(struct MotdCache) +
168	(MOTD_LINESIZE * cache->count));
169	MyFree(cache);
170
171	/* Now link it in... */
172	dlinkAdd(motd->cache, &motd->cache->node, &MotdList.cachelist);
173
174	return motd->cache;
175	}
176
177	/*! \brief Clear and dereference the Motd::cache element of \a motd.
178	* If the MotdCache::ref count goes to zero, free it.
179	* \param motd MOTD to uncache.
180	*/
181	static void
182	motd_decache(struct Motd *motd)
183	{
184	struct MotdCache *cache = NULL;
185
186	assert(motd);
187
188	if ((cache = motd->cache) == NULL) /* We can be called for records with no cache */
189	return;
190
191	motd->cache = NULL; /* Zero the cache */
192
193	if (--cache->ref == 0) /* Reduce reference count... */
194	{
195	dlinkDelete(&cache->node, &MotdList.cachelist);
196	MyFree(cache->path); /* Free path info... */
197	MyFree(cache); /* Very simple for a reason... */
198	}
199	}
200
201	/*! \brief Deallocate a MOTD structure.
202	* If it has cached content, uncache it.
203	* \param motd MOTD to destroy.
204	*/
205	static void
206	motd_destroy(struct Motd *motd)
207	{
208	assert(motd);
209
210	if (motd->cache) /* Drop the cache */
211	motd_decache(motd);
212
213	MyFree(motd->path); /* We always must have a path */
214	MyFree(motd->hostmask);
215	MyFree(motd);
216	}
217
218	/*! \brief Find the first matching MOTD block for a user.
219	* If the user is remote, always use remote MOTD.
220	* Otherwise, if there is a hostmask- or class-based MOTD that matches
221	* the user, use it.
222	* Otherwise, use the local MOTD.
223	* \param client_p Client to find MOTD for.
224	* \return Pointer to first matching MOTD for the client.
225	*/
226	static struct Motd *
227	motd_lookup(const struct Client *client_p)
228	{
229	dlink_node *ptr = NULL;
230	const struct ClassItem *class = NULL;
231
232	assert(client_p);
233
234	if (!MyClient(client_p)) /* Not my user, always return remote motd */
235	return MotdList.remote;
236
237	class = get_class_ptr(&client_p->localClient->confs);
238	assert(class);
239
240	/* Check the motd blocks first */
241	DLINK_FOREACH(ptr, MotdList.other.head)
242	{
243	struct Motd *motd = ptr->data;
244
245	switch (motd->type)
246	{
247	case MOTD_CLASS:
248	if (!match(motd->hostmask, class->name))
249	return motd;
250	break;
251	case MOTD_HOSTMASK:
252	if (!match(motd->hostmask, client_p->host))
253	return motd;
254	break;
255	case MOTD_IPMASKV4:
256	if (client_p->localClient->aftype == AF_INET)
257	if (match_ipv4(&client_p->localClient->ip, &motd->address, motd->addrbits))
258	return motd;
259	break;
260	#ifdef IPV6
261	case MOTD_IPMASKV6:
262	if (client_p->localClient->aftype == AF_INET6)
263	if (match_ipv6(&client_p->localClient->ip, &motd->address, motd->addrbits))
264	return motd;
265	break;
266	#endif
267	default: break;
268	}
269	}
270
271	return MotdList.local; /* Ok, return the default motd */
272	}
273
274	/*! \brief Send the content of a MotdCache to a user.
275	* If \a cache is NULL, simply send ERR_NOMOTD to the client.
276	* \param source_p Client to send MOTD to.
277	* \param cache MOTD body to send to client.
278	*/
279	static void
280	motd_forward(struct Client source_p, const struct MotdCache cache)
281	{
282	if (!cache) /* No motd to send */
283	{
284	sendto_one_numeric(source_p, &me, ERR_NOMOTD);
285	return;
286	}
287
288	/* Send the motd */
289	sendto_one_numeric(source_p, &me, RPL_MOTDSTART, me.name);
290
291	for (unsigned int i = 0; i < cache->count; ++i)
292	sendto_one_numeric(source_p, &me, RPL_MOTD, cache->motd[i]);
293	sendto_one_numeric(source_p, &me, RPL_ENDOFMOTD);
294	}
295
296	/*! \brief Find the MOTD for a client and send it.
297	* \param client_p Client being greeted.
298	*/
299	void
300	motd_send(struct Client *client_p)
301	{
302	assert(client_p);
303
304	motd_forward(client_p, motd_cache(motd_lookup(client_p)));
305	}
306
307	/*! \brief Send the signon MOTD to a user.
308	* If general::short_motd is true and a matching MOTD exists for the
309	* user, direct the client to type /MOTD to read it. Otherwise, call
310	* motd_forward() for the user.
311	* \param source_p Client that has just connected.
312	*/
313	void
314	motd_signon(struct Client *source_p)
315	{
316	const struct MotdCache *cache = motd_cache(motd_lookup(source_p));
317
318	if (!ConfigFileEntry.short_motd \|\| !cache)
319	motd_forward(source_p, cache);
320	else
321	{
322	sendto_one_notice(source_p, &me, ":*** Notice -- motd was last changed at %d/%d/%d %d:%02d",
323	cache->modtime.tm_year + 1900,
324	cache->modtime.tm_mon + 1,
325	cache->modtime.tm_mday,
326	cache->modtime.tm_hour,
327	cache->modtime.tm_min);
328	sendto_one_notice(source_p, &me, ":*** Notice -- Please read the motd if you haven't read it");
329	sendto_one_numeric(source_p, &me, RPL_MOTDSTART, me.name);
330	sendto_one_numeric(source_p, &me, RPL_MOTD,
331	"* This is the short motd *");
332	sendto_one_numeric(source_p, &me, RPL_ENDOFMOTD);
333	}
334	}
335
336	/*! \brief Clear all cached MOTD bodies.
337	* The local and remote MOTDs are re-cached immediately.
338	*/
339	void
340	motd_recache(void)
341	{
342	dlink_node *ptr = NULL;
343
344	motd_decache(MotdList.local); /* Decache local and remote MOTDs */
345	motd_decache(MotdList.remote);
346
347	DLINK_FOREACH(ptr, MotdList.other.head) /* Now all the others */
348	motd_decache(ptr->data);
349
350	/* now recache local and remote MOTDs */
351	motd_cache(MotdList.local);
352	motd_cache(MotdList.remote);
353	}
354
355	/*! \brief Re-cache the local and remote MOTDs.
356	* If they already exist, they are deallocated first.
357	*/
358	void
359	motd_init(void)
360	{
361	if (MotdList.local) /* Destroy old local... */
362	motd_destroy(MotdList.local);
363
364	MotdList.local = motd_create(NULL, MPATH);
365	motd_cache(MotdList.local); /* Init local and cache it */
366
367	if (MotdList.remote) /* Destroy old remote... */
368	motd_destroy(MotdList.remote);
369
370	MotdList.remote = motd_create(NULL, MPATH);
371	motd_cache(MotdList.remote); /* Init remote and cache it */
372	}
373
374	/* \brief Add a new MOTD.
375	* \param hostmask Hostmask (or connection class name) to send this to.
376	* \param path Pathname of file to send.
377	*/
378	void
379	motd_add(const char hostmask, const char path)
380	{
381	struct Motd motd = motd_create(hostmask, path); / create the motd */
382
383	dlinkAdd(motd, &motd->node, &MotdList.other);
384	}
385
386	/*! \brief Clear out all MOTDs.
387	* Compared to motd_recache(), this destroys all hostmask- or
388	* class-based MOTDs rather than simply uncaching them.
389	* Re-cache the local and remote MOTDs.
390	*/
391	void
392	motd_clear(void)
393	{
394	dlink_node ptr = NULL, ptr_next = NULL;
395
396	motd_decache(MotdList.local); /* Decache local and remote MOTDs */
397	motd_decache(MotdList.remote);
398
399	DLINK_FOREACH_SAFE(ptr, ptr_next, MotdList.other.head) /* Destroy other MOTDs */
400	{
401	dlinkDelete(ptr, &MotdList.other);
402	motd_destroy(ptr->data);
403	}
404
405	/* now recache local and remote MOTDs */
406	motd_cache(MotdList.local);
407	motd_cache(MotdList.remote);
408	}
409
410	/*! \brief Report list of non-default MOTDs.
411	* \param source_p Client requesting statistics.
412	*/
413	void
414	motd_report(struct Client *source_p)
415	{
416	const dlink_node *ptr = NULL;
417
418	DLINK_FOREACH(ptr, MotdList.other.head)
419	{
420	const struct Motd *motd = ptr->data;
421
422	sendto_one_numeric(source_p, &me, RPL_STATSTLINE,
423	motd->hostmask, motd->path);
424	}
425	}
426
427	/*! \brief Report MOTD memory usage to a client.
428	* \param source_p Client requesting memory usage.
429	*/
430	void
431	motd_memory_count(struct Client *source_p)
432	{
433	const dlink_node *ptr = NULL;
434	unsigned int mt = 0; /* motd count */
435	unsigned int mtc = 0; /* motd cache count */
436	size_t mtm = 0; /* memory consumed by motd */
437	size_t mtcm = 0; /* memory consumed by motd cache */
438
439	if (MotdList.local)
440	{
441	mt++;
442	mtm += sizeof(struct Motd);
443	mtm += MotdList.local->path ? (strlen(MotdList.local->path) + 1) : 0;
444	}
445
446	if (MotdList.remote)
447	{
448	mt++;
449	mtm += sizeof(struct Motd);
450	mtm += MotdList.remote->path ? (strlen(MotdList.remote->path) + 1) : 0;
451	}
452
453	DLINK_FOREACH(ptr, MotdList.other.head)
454	{
455	const struct Motd *motd = ptr->data;
456
457	mt++;
458	mtm += sizeof(struct Motd);
459	mtm += motd->path ? (strlen(motd->path) + 1) : 0;
460	}
461
462	DLINK_FOREACH(ptr, MotdList.cachelist.head)
463	{
464	const struct MotdCache *cache = ptr->data;
465
466	mtc++;
467	mtcm += sizeof(struct MotdCache) + (MOTD_LINESIZE * (cache->count - 1));
468	}
469
470	sendto_one(source_p, ":%s %d %s z :Motds %u(%u) Cache %u(%u)",
471	me.name, RPL_STATSDEBUG, source_p->name,
472	mt, mtm, mtc, mtcm);
473	}