include/motd.h

   1 #ifndef INCLUDED_motd_h
   2 #define INCLUDED_motd_h
   3 /*
   4  * IRC - Internet Relay Chat, include/motd.h
   5  * Copyright (C) 1990 Jarkko Oikarinen and
   6  *                    University of Oulu, Computing Center
   7  * Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2, or (at your option)
  12  * any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  *
  23  * $Id$
  24  */
  25 #ifndef INCLUDED_time_h
  26 #include <time.h>               /* struct tm */
  27 #define INCLUDED_time_h
  28 #endif
  29 #ifndef INCLUDED_sys_types_h
  30 #include <sys/types.h>
  31 #define INCLUDED_sys_types_h
  32 #endif
  33
  34
  35 struct Client;
  36 struct TRecord;
  37
  38 struct Motd {
  39   struct Motd*          next;
  40   int                   type;
  41   union {
  42     char*               hostmask;
  43     int                 class;
  44   }                     id;
  45   char*                 path;
  46   int                   maxcount;
  47   struct MotdCache*     cache;
  48 };
  49
  50 #define MOTD_UNIVERSAL  0       /* MOTD selected by no criteria */
  51 #define MOTD_HOSTMASK   1       /* MOTD selected by hostmask */
  52 #define MOTD_CLASS      2       /* MOTD selected by connection class */
  53
  54 #define MOTD_LINESIZE   81      /* 80 chars + '\0' */
  55 #define MOTD_MAXLINES   100
  56 #define MOTD_MAXREMOTE  3
  57
  58 struct MotdCache {
  59   struct MotdCache*     next; /* these fields let us read MOTDs only once */
  60   struct MotdCache**    prev_p;
  61   int                   ref;
  62   char*                 path;
  63   int                   maxcount;
  64   struct tm             modtime;
  65   int                   count;
  66   char                  motd[1][MOTD_LINESIZE];
  67 };
  68
  69 /* motd_send sends a MOTD off to a user */
  70 int motd_send(struct Client* cptr);
  71
  72 /* motd_signon sends a MOTD off to a newly-registered user */
  73 void motd_signon(struct Client* cptr);
  74
  75 /* motd_recache causes all the MOTD caches to be cleared */
  76 void motd_recache(void);
  77
  78 /* motd_init initializes the MOTD routines, including reading the
  79  * ircd.motd and remote.motd files into cache
  80  */
  81 void motd_init(void);
  82
  83 /* This routine adds a MOTD */
  84 void motd_add(const char *hostmask, const char *path);
  85
  86 /* This routine clears the list of MOTDs */
  87 void motd_clear(void);
  88
  89 /* This is called to report T-lines */
  90 void motd_report(struct Client *to);
  91
  92 #endif /* INCLUDED_motd_h */