trunk/src/motd.c

/*
 *  ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
 *
 *  Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
 *  Copyright (C) 2013 by the 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 != NULL)
    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]; /* \r\n */
  char *tmp = line;
  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 */
    }
  }

  /* 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;
  }

  /* need the file's modification time */
  if (stat(motd->path, &sb) == -1)
  {
    fclose(file);
    return 0;
  }

  /* Ok, allocate a structure; we'll realloc later to trim memory */
  cache = MyMalloc(sizeof(struct MotdCache) + (MOTD_LINESIZE * (MOTD_MAXLINES - 1)));
  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 (; 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 - 1)));
  memcpy(motd->cache, cache, sizeof(struct MotdCache) +
         (MOTD_LINESIZE * (cache->count - 1)));
  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);

  dlinkDelete(&motd->node, &MotdList.other);
  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(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)
{
  unsigned int i = 0;
  const char *from = ID_or_name(&me, source_p->from);
  const char *to = ID_or_name(source_p, source_p->from);

  assert(source_p);

  if (!cache)  /* no motd to send */
  {
    sendto_one(source_p, form_str(ERR_NOMOTD), from, to);
    return;
  }

  /* send the motd */
  sendto_one(source_p, form_str(RPL_MOTDSTART),
             from, to, me.name);

  for (; i < cache->count; ++i)
    sendto_one(source_p, form_str(RPL_MOTD),
               from, to, cache->motd[i]);
  sendto_one(source_p, form_str(RPL_ENDOFMOTD), from, to);
}

/*! \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 FEAT_NODEFAULTMOTD 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(source_p, ":%s NOTICE %s :*** Notice -- motd was last changed at %d/%d/%d %d:%02d",
               me.name, source_p->name, cache->modtime.tm_year + 1900,
               cache->modtime.tm_mon + 1,
               cache->modtime.tm_mday,
               cache->modtime.tm_hour,
               cache->modtime.tm_min);
    sendto_one(source_p,
               ":%s NOTICE %s :*** Notice -- Please read the motd if you haven't "
               "read it", me.name, source_p->name);
    sendto_one(source_p, form_str(RPL_MOTDSTART),
               me.name, source_p->name, me.name);
    sendto_one(source_p, form_str(RPL_MOTD),
               me.name, source_p->name,
               "*** This is the short motd ***");
    sendto_one(source_p, form_str(RPL_ENDOFMOTD),
               me.name, source_p->name);
  }
}

/*! \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(0, MPATH);
  motd_cache(MotdList.local);  /* init local and cache it */

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

  MotdList.remote = motd_create(0, 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 */
    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(source_p, form_str(RPL_STATSTLINE),
               me.name, source_p->name,
               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 MotdCache *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:	2168
Committed:	Sun Jun 2 20:08:01 2013 UTC (12 years, 2 months ago) by michael
Content type:	text/x-csrc
File size:	13303 byte(s)
Log Message:	- motd.c, motd.h: fix compile warnings
#	User	Rev	Content
1	adx	30	/*
2			* ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
3			*
4	michael	2150	* Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
5			* Copyright (C) 2013 by the Hybrid Development Team.
6	adx	30	*
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	michael	2150	/*! \file motd.c
24			* \brief Message-of-the-day manipulation implementation.
25			* \version $Id$
26			*/
27
28	adx	30	#include "stdinc.h"
29	michael	1011	#include "list.h"
30	adx	30	#include "ircd.h"
31	michael	1309	#include "conf.h"
32	adx	30	#include "send.h"
33	michael	2150	#include "s_serv.h"
34	adx	30	#include "numeric.h"
35			#include "client.h"
36			#include "irc_string.h"
37			#include "memory.h"
38	michael	2150	#include "log.h"
39			#include "motd.h"
40	michael	2167	#include "hostmask.h"
41	adx	30
42	michael	2150
43			/** Global list of messages of the day. */
44			static struct
45	adx	30	{
46	michael	2150	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	michael	2167	{
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	michael	2150
84			if (hostmask != NULL)
85			tmp->hostmask = xstrdup(hostmask);
86
87			tmp->path = xstrdup(path);
88			tmp->maxcount = MOTD_MAXLINES;
89
90			return tmp;
91	adx	30	}
92
93	michael	2150	/*! 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	adx	30	{
102	michael	2150	FILE *file = NULL;
103			struct MotdCache *cache = NULL;
104			struct stat sb;
105			char line[MOTD_LINESIZE + 2]; /* \r\n */
106	michael	2164	char *tmp = line;
107			unsigned int i = 0;
108	michael	2150	dlink_node *ptr = NULL;
109	adx	30
110	michael	2150	assert(motd);
111			assert(motd->path);
112	adx	30
113	michael	2150	if (motd->cache)
114			return motd->cache;
115	adx	30
116	michael	2150	/* try to find it in the list of cached files... */
117			DLINK_FOREACH(ptr, MotdList.cachelist.head)
118			{
119			cache = ptr->data;
120	adx	30
121	michael	2150	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			/* gotta read in the file, now */
130			if ((file = fopen(motd->path, "r")) == NULL)
131	adx	30	{
132	michael	2150	ilog(LOG_TYPE_IRCD, "Couldn't open \"%s\": %s", motd->path,
133			strerror(errno));
134			return 0;
135			}
136	adx	30
137	michael	2150	/* need the file's modification time */
138			if (stat(motd->path, &sb) == -1)
139			{
140			fclose(file);
141			return 0;
142			}
143	adx	30
144	michael	2150	/* Ok, allocate a structure; we'll realloc later to trim memory */
145			cache = MyMalloc(sizeof(struct MotdCache) + (MOTD_LINESIZE * (MOTD_MAXLINES - 1)));
146			cache->ref = 1;
147			cache->path = xstrdup(motd->path);
148			cache->maxcount = motd->maxcount;
149			cache->modtime = localtime((time_t )&sb.st_mtime); /* store modtime */
150	adx	30
151	michael	2150	while (cache->count < cache->maxcount && fgets(line, sizeof(line), file))
152			{
153			/* copy over line, stopping when we overflow or hit line end */
154	michael	2164	for (; i < (MOTD_LINESIZE - 1) && tmp && tmp != '\r' && *tmp != '\n'; ++tmp, ++i)
155	michael	2150	cache->motd[cache->count][i] = *tmp;
156			cache->motd[cache->count][i] = '\0';
157	adx	30
158	michael	2150	cache->count++;
159	adx	30	}
160
161	michael	2150	fclose(file); /* close the file */
162
163			/* trim memory usage a little */
164			motd->cache = MyMalloc(sizeof(struct MotdCache) +
165			(MOTD_LINESIZE * (cache->count - 1)));
166			memcpy(motd->cache, cache, sizeof(struct MotdCache) +
167			(MOTD_LINESIZE * (cache->count - 1)));
168			MyFree(cache);
169
170			/* now link it in... */
171			dlinkAdd(motd->cache, &motd->cache->node, &MotdList.cachelist);
172
173			return motd->cache;
174	adx	30	}
175
176	michael	2150	/*! \brief Clear and dereference the Motd::cache element of \a motd.
177			* If the MotdCache::ref count goes to zero, free it.
178			* \param motd MOTD to uncache.
179	adx	30	*/
180	michael	2150	static void
181			motd_decache(struct Motd *motd)
182	adx	30	{
183	michael	2150	struct MotdCache *cache = NULL;
184	adx	30
185	michael	2150	assert(motd);
186	adx	30
187	michael	2150	if ((cache = motd->cache) == NULL) /* we can be called for records with no cache */
188			return;
189	adx	30
190	michael	2150	motd->cache = NULL; /* zero the cache */
191	adx	30
192	michael	2164	if (--cache->ref == 0) /* reduce reference count... */
193	adx	30	{
194	michael	2150	dlinkDelete(&cache->node, &MotdList.cachelist);
195			MyFree(cache->path); /* free path info... */
196			MyFree(cache); /* very simple for a reason... */
197	adx	30	}
198	michael	2150	}
199	adx	30
200	michael	2150	/*! \brief Deallocate a MOTD structure.
201			* If it has cached content, uncache it.
202			* \param motd MOTD to destroy.
203			*/
204			static void
205			motd_destroy(struct Motd *motd)
206			{
207			assert(motd);
208	adx	30
209	michael	2150	if (motd->cache) /* drop the cache */
210			motd_decache(motd);
211	adx	30
212	michael	2150	dlinkDelete(&motd->node, &MotdList.other);
213			MyFree(motd->path); /* we always must have a path */
214			MyFree(motd->hostmask);
215			MyFree(motd);
216			}
217	adx	30
218	michael	2150	/*! \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(struct Client *client_p)
228			{
229			dlink_node *ptr = NULL;
230			const struct ClassItem *class = NULL;
231	adx	30
232	michael	2150	assert(client_p);
233	adx	30
234	michael	2150	if (!MyClient(client_p)) /* not my user, always return remote motd */
235			return MotdList.remote;
236	adx	30
237	michael	2150	class = get_class_ptr(&client_p->localClient->confs);
238			assert(class);
239	adx	30
240	michael	2150	/* check the motd blocks first */
241			DLINK_FOREACH(ptr, MotdList.other.head)
242			{
243			struct Motd *motd = ptr->data;
244	adx	30
245	michael	2150	switch (motd->type)
246	adx	30	{
247	michael	2150	case MOTD_CLASS:
248			if (!match(motd->hostmask, class->name))
249			return motd;
250	michael	2167	break;
251	michael	2150	case MOTD_HOSTMASK:
252			if (!match(motd->hostmask, client_p->host))
253			return motd;
254	michael	2167	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	michael	2168	#ifdef IPV6
261	michael	2167	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	michael	2168	#endif
267	michael	2150	default: break;
268	adx	30	}
269			}
270
271	michael	2150	return MotdList.local; /* Ok, return the default motd */
272	adx	30	}
273
274	michael	2150	/*! \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	adx	30	*/
279	michael	2150	static void
280			motd_forward(struct Client source_p, const struct MotdCache cache)
281			{
282	michael	2164	unsigned int i = 0;
283	michael	2150	const char *from = ID_or_name(&me, source_p->from);
284			const char *to = ID_or_name(source_p, source_p->from);
285	adx	30
286	michael	2150	assert(source_p);
287
288			if (!cache) /* no motd to send */
289			{
290			sendto_one(source_p, form_str(ERR_NOMOTD), from, to);
291			return;
292			}
293
294			/* send the motd */
295			sendto_one(source_p, form_str(RPL_MOTDSTART),
296			from, to, me.name);
297
298	michael	2164	for (; i < cache->count; ++i)
299	michael	2150	sendto_one(source_p, form_str(RPL_MOTD),
300			from, to, cache->motd[i]);
301			sendto_one(source_p, form_str(RPL_ENDOFMOTD), from, to);
302			}
303
304			/*! \brief Find the MOTD for a client and send it.
305			* \param client_p Client being greeted.
306			*/
307			void
308			motd_send(struct Client *client_p)
309	adx	30	{
310	michael	2150	assert(client_p);
311	adx	30
312	michael	2150	motd_forward(client_p, motd_cache(motd_lookup(client_p)));
313	adx	30	}
314
315	michael	2150	/*! \brief Send the signon MOTD to a user.
316			* If FEAT_NODEFAULTMOTD is true and a matching MOTD exists for the
317			* user, direct the client to type /MOTD to read it. Otherwise, call
318			* motd_forward() for the user.
319			* \param source_p Client that has just connected.
320	adx	30	*/
321			void
322	michael	2150	motd_signon(struct Client *source_p)
323	adx	30	{
324	michael	2150	const struct MotdCache *cache = motd_cache(motd_lookup(source_p));
325	adx	30
326	michael	2150	if (!ConfigFileEntry.short_motd \|\| !cache)
327			motd_forward(source_p, cache);
328			else
329	adx	30	{
330	michael	2150	sendto_one(source_p, ":%s NOTICE %s :*** Notice -- motd was last changed at %d/%d/%d %d:%02d",
331			me.name, source_p->name, cache->modtime.tm_year + 1900,
332			cache->modtime.tm_mon + 1,
333			cache->modtime.tm_mday,
334			cache->modtime.tm_hour,
335			cache->modtime.tm_min);
336			sendto_one(source_p,
337			":%s NOTICE %s :*** Notice -- Please read the motd if you haven't "
338			"read it", me.name, source_p->name);
339			sendto_one(source_p, form_str(RPL_MOTDSTART),
340			me.name, source_p->name, me.name);
341			sendto_one(source_p, form_str(RPL_MOTD),
342			me.name, source_p->name,
343			"* This is the short motd *");
344			sendto_one(source_p, form_str(RPL_ENDOFMOTD),
345			me.name, source_p->name);
346	adx	30	}
347	michael	2150	}
348
349			/*! \brief Clear all cached MOTD bodies.
350			* The local and remote MOTDs are re-cached immediately.
351			*/
352			void
353			motd_recache(void)
354			{
355			dlink_node *ptr = NULL;
356
357			motd_decache(MotdList.local); /* decache local and remote MOTDs */
358			motd_decache(MotdList.remote);
359
360			DLINK_FOREACH(ptr, MotdList.other.head) /* now all the others */
361			motd_decache(ptr->data);
362
363			/* now recache local and remote MOTDs */
364			motd_cache(MotdList.local);
365			motd_cache(MotdList.remote);
366			}
367
368			/*! \brief Re-cache the local and remote MOTDs.
369			* If they already exist, they are deallocated first.
370			*/
371			void
372			motd_init(void)
373			{
374			if (MotdList.local) /* destroy old local... */
375			motd_destroy(MotdList.local);
376
377			MotdList.local = motd_create(0, MPATH);
378			motd_cache(MotdList.local); /* init local and cache it */
379
380			if (MotdList.remote) /* destroy old remote... */
381			motd_destroy(MotdList.remote);
382
383			MotdList.remote = motd_create(0, MPATH);
384			motd_cache(MotdList.remote); /* init remote and cache it */
385			}
386
387			/* \brief Add a new MOTD.
388			* \param hostmask Hostmask (or connection class name) to send this to.
389			* \param path Pathname of file to send.
390			*/
391			void
392			motd_add(const char hostmask, const char path)
393			{
394			struct Motd motd = motd_create(hostmask, path); / create the motd */
395
396			dlinkAdd(motd, &motd->node, &MotdList.other);
397			}
398
399			/*! \brief Clear out all MOTDs.
400			* Compared to motd_recache(), this destroys all hostmask- or
401			* class-based MOTDs rather than simply uncaching them.
402			* Re-cache the local and remote MOTDs.
403			*/
404			void
405			motd_clear(void)
406			{
407			dlink_node ptr = NULL, ptr_next = NULL;
408
409			motd_decache(MotdList.local); /* decache local and remote MOTDs */
410			motd_decache(MotdList.remote);
411
412			DLINK_FOREACH_SAFE(ptr, ptr_next, MotdList.other.head) /* destroy other MOTDs */
413			motd_destroy(ptr->data);
414
415			/* now recache local and remote MOTDs */
416			motd_cache(MotdList.local);
417			motd_cache(MotdList.remote);
418			}
419
420			/*! \brief Report list of non-default MOTDs.
421			* \param source_p Client requesting statistics.
422			*/
423			void
424			motd_report(struct Client *source_p)
425			{
426			const dlink_node *ptr = NULL;
427
428			DLINK_FOREACH(ptr, MotdList.other.head)
429	adx	30	{
430	michael	2150	const struct Motd *motd = ptr->data;
431
432			sendto_one(source_p, form_str(RPL_STATSTLINE),
433			me.name, source_p->name,
434			motd->hostmask, motd->path);
435	adx	30	}
436			}
437
438	michael	2150	/*! \brief Report MOTD memory usage to a client.
439			* \param source_p Client requesting memory usage.
440	adx	30	*/
441			void
442	michael	2150	motd_memory_count(struct Client *source_p)
443	adx	30	{
444	michael	2150	const dlink_node *ptr = NULL;
445			unsigned int mt = 0; /* motd count */
446			unsigned int mtc = 0; /* motd cache count */
447			size_t mtm = 0; /* memory consumed by motd */
448			size_t mtcm = 0; /* memory consumed by motd cache */
449	adx	30
450	michael	2150	if (MotdList.local)
451			{
452			mt++;
453			mtm += sizeof(struct Motd);
454			mtm += MotdList.local->path ? (strlen(MotdList.local->path) + 1) : 0;
455			}
456	adx	30
457	michael	2150	if (MotdList.remote)
458	adx	30	{
459	michael	2150	mt++;
460			mtm += sizeof(struct Motd);
461			mtm += MotdList.remote->path ? (strlen(MotdList.remote->path) + 1) : 0;
462			}
463
464			DLINK_FOREACH(ptr, MotdList.other.head)
465			{
466			const struct MotdCache *motd = ptr->data;
467
468			mt++;
469			mtm += sizeof(struct Motd);
470			mtm += motd->path ? (strlen(motd->path) + 1) : 0;
471			}
472
473			DLINK_FOREACH(ptr, MotdList.cachelist.head)
474			{
475			const struct MotdCache *cache = ptr->data;
476
477			mtc++;
478			mtcm += sizeof(struct MotdCache) + (MOTD_LINESIZE * (cache->count - 1));
479			}
480
481			sendto_one(source_p, ":%s %d %s z :Motds %u(%u) Cache %u(%u)",
482			me.name, RPL_STATSDEBUG, source_p->name,
483			mt, mtm, mtc, mtcm);
484	adx	30	}