- Added some tools to detect memory leaks.
[ircu2.10.12-pk.git] / ircd / motd.c
index 56f0c126c19f92941198c69d32b384160fa3fda9..393d1ee4c1d2768ce6ed243c75e1aa57027724a9 100644 (file)
  *
  * $Id$
  */
+#include "config.h"
+
 #include "motd.h"
+#include "class.h"
 #include "client.h"
+#include "fileio.h"
 #include "ircd.h"
+#include "ircd_alloc.h"
+#include "ircd_features.h"
 #include "ircd_reply.h"
 #include "ircd_string.h"
 #include "match.h"
 #include "numeric.h"
 #include "numnicks.h"
 #include "s_conf.h"
-#include "class.h"
+#include "s_debug.h"
 #include "s_user.h"
 #include "send.h"
 
-#include <stdlib.h>
 #include <assert.h>
+#include <errno.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/stat.h>
+
+static struct {
+  struct Motd*     local;
+  struct Motd*     remote;
+  struct Motd*     other;
+  struct Motd*     freelist;
+  struct MotdCache* cachelist;
+} MotdList = { 0, 0, 0, 0, 0 };
+
+/* Create a struct Motd and initialize it */
+static struct Motd *
+motd_create(const char *hostmask, const char *path, int maxcount)
+{
+  struct Motd* tmp;
+  int type = MOTD_UNIVERSAL;
+  
+  assert(0 != path);
+  
+  if (hostmask != NULL && find_class(hostmask))
+    type = MOTD_CLASS;
+  else
+    type = MOTD_HOSTMASK;
+  /* allocate memory and initialize the structure */
+  if (MotdList.freelist)
+  {
+    tmp = MotdList.freelist;
+    MotdList.freelist = tmp->next;
+  } else
+    tmp = (struct Motd *)MyMalloc(sizeof(struct Motd));
+  
+  tmp->next = 0;
+  tmp->type = type;
+  
+  if (hostmask != NULL)
+    DupString(tmp->hostmask, hostmask);
+  
+  DupString(tmp->path, path);
+  tmp->maxcount = maxcount;
+  tmp->cache = 0;
+
+  return tmp;
+}
+
+/* This function reads a motd out of a file (if needed) and caches it */
+static struct MotdCache *
+motd_cache(struct Motd *motd)
+{
+  FBFILE*              file;
+  struct MotdCache*    cache;
+  struct stat          sb;
+  char                 line[MOTD_LINESIZE + 2]; /* \r\n */
+  char*                        tmp;
+  int                  i;
+
+  assert(0 != motd);
+  assert(0 != motd->path);
+
+  if (motd->cache)
+    return motd->cache;
+
+  /* try to find it in the list of cached files... */
+  for (cache = MotdList.cachelist; cache; cache = cache->next) {
+    if (!strcmp(cache->path, motd->path) &&
+       cache->maxcount == motd->maxcount) { /* found one... */
+      cache->ref++; /* increase reference count... */
+      motd->cache = cache; /* remember cache... */
+      return motd->cache; /* return it */
+    }
+  }
+
+  /* gotta read in the file, now */
+  if (!(file = fbopen(motd->path, "r"))) {
+    Debug((DEBUG_ERROR, "Couldn't open \"%s\": %s", motd->path,
+          strerror(errno)));
+    return 0;
+  }
+
+  /* need the file's modification time */
+  if (-1 == fbstat(&sb, file)) {
+    fbclose(file);
+    return 0;
+  }
+
+  /* Ok, allocate a structure; we'll realloc later to trim memory */
+  cache = (struct MotdCache *)MyMalloc(sizeof(struct MotdCache) +
+                                      (MOTD_LINESIZE * (MOTD_MAXLINES - 1)));
+
+  cache->ref = 1;
+  DupString(cache->path, motd->path);
+  cache->maxcount = motd->maxcount;
+
+  cache->modtime = *localtime((time_t *) &sb.st_mtime); /* store modtime */
+
+  cache->count = 0;
+  while (cache->count < cache->maxcount && fbgets(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';
 
-/* This routine returns the TRecord structure for a user, or 0 if there
- * is no matching T-line--in which case, we should use the standard
- * MOTD.
+    cache->count++;
+  }
+
+  fbclose(file); /* close the file */
+
+  /* trim memory usage a little */
+  motd->cache = (struct MotdCache*)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... */
+  motd->cache->next = MotdList.cachelist;
+  motd->cache->prev_p = &MotdList.cachelist;
+  if (MotdList.cachelist)
+    MotdList.cachelist->prev_p = &motd->cache->next;
+  MotdList.cachelist = motd->cache;
+
+  return motd->cache;
+}
+
+static void
+motd_decache(struct Motd *motd)
+{
+  struct MotdCache* cache;
+
+  assert(0 != motd);
+
+  if (!(cache = motd->cache)) /* we can be called for records with no cache */
+    return;
+
+  motd->cache = 0; /* zero the cache */
+
+  if (!--cache->ref) { /* reduce reference count... */
+    if (cache->next) /* ref is 0, delink from list and free */
+      cache->next->prev_p = cache->prev_p;
+    *cache->prev_p = cache->next;
+
+    MyFree(cache->path); /* free path info... */
+
+    MyFree(cache); /* very simple for a reason... */
+  }
+}
+
+/* This function destroys a struct Motd, destroying the cache if needed */
+static void
+motd_destroy(struct Motd *motd)
+{
+  assert(0 != motd);
+
+  MyFree(motd->path); /* we always must have a path */
+  MyFree(motd->hostmask);
+  if (motd->cache) /* drop the cache */
+    motd_decache(motd);
+
+  motd->next = MotdList.freelist;
+  MotdList.freelist = motd;
+}
+
+/* We use this routine to look up the struct Motd to send to any given
+ * user.
  */
-struct TRecord *
-motd_find(struct Client* cptr)
+static struct Motd *
+motd_lookup(struct Client *cptr)
 {
-  struct TRecord *ptr;
-  int class = -1;
+  struct Motd *ptr;
+  char *class = NULL;
 
   assert(0 != cptr);
 
-  if (MyUser(cptr))
-    class = get_client_class(cptr);
+  if (!MyUser(cptr)) /* not my user, always return remote motd */
+    return MotdList.remote;
+
+  class = get_client_class(cptr);
 
-  for (ptr = tdata; ptr; ptr = ptr->next) {
-    if (class >= 0 && IsDigit(*ptr->hostmask)) {
-      if (atoi(ptr->hostmask) == class)
-       return ptr;
-    } else if (!match(ptr->hostmask, cptr->sockhost))
+  /* check the motd blocks first */
+  for (ptr = MotdList.other; ptr; ptr = ptr->next)
+  {
+    if (ptr->type == MOTD_CLASS &&
+        !match(ptr->hostmask, class))
+      return ptr;
+    else if (ptr->type == MOTD_HOSTMASK && class != NULL &&
+             !match(ptr->hostmask, cli_sockhost(cptr)))
       return ptr;
   }
 
-  return 0;
+  return MotdList.local; /* Ok, return the default motd */
 }
 
-/* This routine is used to send the MOTD off to a user. */
-int
-motd_send(struct Client* cptr, struct TRecord* trec)
+/* Here is a routine that takes a MotdCache and sends it to a user */
+static int
+motd_forward(struct Client *cptr, struct MotdCache *cache)
 {
-  struct MotdItem *t_motd;
-  struct tm *t_tm;
-  int count;
+  int i;
 
   assert(0 != cptr);
 
-  if (!MyUser(cptr)) { /* not our user, send the remote MOTD */
-    t_motd = rmotd;
-    t_tm = 0;
-  } else if (trec) { /* We were given a TRecord */
-    t_motd = trec->tmotd;
-    t_tm = &trec->tmotd_tm;
-  } else { /* use the basic MOTD */
-    t_motd = motd;
-    t_tm = &motd_tm;
-  }
-
-  if (!t_motd) /* No motd to send */
+  if (!cache) /* no motd to send */
     return send_reply(cptr, ERR_NOMOTD);
 
-  /* this is a change; we now always send the start numeric */
-  send_reply(cptr, RPL_MOTDSTART, me.name);
+  /* send the motd */
+  send_reply(cptr, RPL_MOTDSTART, cli_name(&me));
+  send_reply(cptr, SND_EXPLICIT | RPL_MOTD, ":- %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);
 
-  if (t_tm) { /* We should probably go for ISO dates here: yyyy-mm-dd. */
-    send_reply(cptr, SND_EXPLICIT | RPL_MOTD, ":- %d/%d/%d %d:%02d",
-              t_tm->tm_mday, t_tm->tm_mon + 1, 1900 + t_tm->tm_year,
-              t_tm->tm_hour, t_tm->tm_min);
-    count = 100;
-  } else
-    count = 3;
+  for (i = 0; i < cache->count; i++)
+    send_reply(cptr, RPL_MOTD, cache->motd[i]);
 
-  for (; t_motd; t_motd = t_motd->next) { /* send along the MOTD */
-    send_reply(cptr, RPL_MOTD, t_motd->line);
-    if (!--count)
-      break;
-  }
+  return send_reply(cptr, RPL_ENDOFMOTD); /* end */
+}
 
-  send_reply(cptr, RPL_ENDOFMOTD); /* end */
+/* This routine is used to send the MOTD off to a user. */
+int
+motd_send(struct Client* cptr)
+{
+  assert(0 != cptr);
 
-  return 0; /* Convenience return */
+  return motd_forward(cptr, motd_cache(motd_lookup(cptr)));
 }
 
 /* This routine sends the MOTD or something to newly-registered users. */
 void
 motd_signon(struct Client* cptr)
 {
-  struct TRecord *trec;
-  struct tm *t_tm = &motd_tm;
-
-  if ((trec = motd_find(cptr)))
-    t_tm = &trec->tmotd_tm;
-
-#ifdef NODEFAULTMOTD
-  send_reply(cptr, RPL_MOTDSTART, me.name);
-  send_reply(cptr, SND_EXPLICIT | RPL_MOTD, ":\002Type /MOTD to read the AUP "
-            "before continuing using this service.\002");
-  /* Perhaps we should switch to an ISO date here? */
-  send_reply(cptr, SND_EXPLICIT | RPL_MOTD, ":The message of the day was last "
-            "changed: %d/%d/%d", t_tm->tm_mday, t_tm->tm_mon + 1,
-            1900 + t_tm->tm_year);
-  send_reply(cptr, RPL_ENDOFMOTD);
-#else
-  motd_send(cptr, trec);
-#endif
+  struct MotdCache *cache;
+  const char *banner = NULL;
+
+  cache = motd_cache(motd_lookup(cptr));
+
+  if (!feature_bool(FEAT_NODEFAULTMOTD) || !cache)
+    motd_forward(cptr, cache);
+  else {
+    send_reply(cptr, RPL_MOTDSTART, cli_name(&me));
+    if ((banner = feature_str(FEAT_MOTD_BANNER)))
+      send_reply(cptr, SND_EXPLICIT | RPL_MOTD, ":%s", banner);
+    send_reply(cptr, SND_EXPLICIT | RPL_MOTD, ":\002Type /MOTD to read the "
+              "AUP before continuing using this service.\002");
+    send_reply(cptr, SND_EXPLICIT | RPL_MOTD, ":The message of the day was "
+              "last changed: %d-%d-%d %d:%d", cache->modtime.tm_year + 1900,
+              cache->modtime.tm_mon + 1, cache->modtime.tm_mday,
+              cache->modtime.tm_hour, cache->modtime.tm_min);
+    send_reply(cptr, RPL_ENDOFMOTD);
+  }
+}
+
+/* motd_recache causes all the MOTD caches to be cleared */
+void
+motd_recache(void)
+{
+  struct Motd* tmp;
+
+  motd_decache(MotdList.local); /* decache local and remote MOTDs */
+  motd_decache(MotdList.remote);
+
+  for (tmp = MotdList.other; tmp; tmp = tmp->next) /* now all the others */
+    motd_decache(tmp);
+
+  /* now recache local and remote MOTDs */
+  motd_cache(MotdList.local);
+  motd_cache(MotdList.remote);
+}
+
+/* motd_init initializes the MOTD routines, including reading the
+ * ircd.motd and remote.motd files into cache
+ */
+void
+motd_init(void)
+{
+  if (MotdList.local) /* destroy old local... */
+    motd_destroy(MotdList.local);
+
+  MotdList.local = motd_create(0, feature_str(FEAT_MPATH), MOTD_MAXLINES);
+  motd_cache(MotdList.local); /* init local and cache it */
+
+  if (MotdList.remote) /* destroy old remote... */
+    motd_destroy(MotdList.remote);
+
+  MotdList.remote = motd_create(0, feature_str(FEAT_RPATH), MOTD_MAXREMOTE);
+  motd_cache(MotdList.remote); /* init remote and cache it */
+}
+
+/* This routine adds a MOTD */
+void
+motd_add(const char *hostmask, const char *path)
+{
+  struct Motd *tmp;
+
+  tmp = motd_create(hostmask, path, MOTD_MAXLINES); /* create the motd */
+
+  tmp->next = MotdList.other; /* link it into the list */
+  MotdList.other = tmp;
+}
+
+/* This routine clears the list of MOTDs */
+void
+motd_clear(void)
+{
+  struct Motd *ptr, *next;
+
+  motd_decache(MotdList.local); /* decache local and remote MOTDs */
+  motd_decache(MotdList.remote);
+
+  if (MotdList.other) /* destroy other MOTDs */
+    for (ptr = MotdList.other; ptr; ptr = next)
+    { 
+      next = ptr->next;
+      motd_destroy(ptr);
+    }
+
+  MotdList.other = 0;
+
+  /* now recache local and remote MOTDs */
+  motd_cache(MotdList.local);
+  motd_cache(MotdList.remote);
+}
+
+/* This is called to report T-lines */
+void
+motd_report(struct Client *to)
+{
+  struct Motd *ptr;
+
+  for (ptr = MotdList.other; ptr; ptr = ptr->next)
+    send_reply(to, SND_EXPLICIT | RPL_STATSTLINE, "T %s %s",
+               ptr->hostmask, ptr->path);
 }