include/gline.h

   1 #ifndef INCLUDED_gline_h
   2 #define INCLUDED_gline_h
   3 /*
   4  * IRC - Internet Relay Chat, include/gline.h
   5  * Copyright (C) 1990 Jarkko Oikarinen and
   6  *                    University of Oulu, Computing Center
   7  * Copyright (C) 1996 -1997 Carlo Wood
   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 /** @file
  24  * @brief Structures and APIs for G-line manipulation.
  25  * @version $Id$
  26  */
  27 #ifndef INCLUDED_sys_types_h
  28 #include <sys/types.h>
  29 #define INCLUDED_sys_types_h
  30 #endif
  31
  32 #ifndef INCLUDED_res_h
  33 #include "res.h"
  34 #endif
  35
  36 struct Client;
  37 struct StatDesc;
  38
  39 #define GLINE_MAX_EXPIRE 604800 /**< max expire: 7 days */
  40
  41 /** Description of a G-line. */
  42 struct Gline {
  43   struct Gline *gl_next;      /**< Next G-line in linked list. */
  44   struct Gline**gl_prev_p;    /**< Previous pointer to this G-line. */
  45   char         *gl_user;      /**< Username mask (or channel/realname mask). */
  46   char         *gl_host;      /**< Host prtion of mask. */
  47   char         *gl_reason;    /**< Reason for G-line. */
  48   time_t        gl_expire;    /**< Expiration timestamp. */
  49   time_t        gl_lastmod;   /**< Last modification timestamp. */
  50   time_t        gl_rexpire;   /**< Record expiration timestamp. */
  51   struct irc_in_addr gl_addr; /**< IP address (for IP-based G-lines). */
  52   unsigned char gl_bits;      /**< Usable bits in gl_addr. */
  53   unsigned int  gl_flags;     /**< G-line status flags. */
  54 };
  55
  56 enum GlineAction {
  57   GLINE_ACTIVATE,
  58   GLINE_DEACTIVATE,
  59   GLINE_LOCAL_ACTIVATE,
  60   GLINE_LOCAL_DEACTIVATE,
  61   GLINE_MODIFY
  62 };
  63
  64 #define GLINE_ACTIVE    0x0001  /**< G-line is active. */
  65 #define GLINE_IPMASK    0x0002  /**< gl_addr and gl_bits fields are valid. */
  66 #define GLINE_BADCHAN   0x0004  /**< G-line prohibits users from joining a channel. */
  67 #define GLINE_LOCAL     0x0008  /**< G-line only applies to this server. */
  68 #define GLINE_ANY       0x0010  /**< Search flag: Find any G-line. */
  69 #define GLINE_FORCE     0x0020  /**< Override normal limits on G-lines. */
  70 #define GLINE_EXACT     0x0040  /**< Exact match only (no wildcards). */
  71 #define GLINE_LDEACT    0x0080  /**< Locally deactivated. */
  72 #define GLINE_GLOBAL    0x0100  /**< Find only global G-lines. */
  73 #define GLINE_LASTMOD   0x0200  /**< Find only G-lines with non-zero lastmod. */
  74 #define GLINE_OPERFORCE 0x0400  /**< Oper forcing G-line to be set. */
  75 #define GLINE_REALNAME  0x0800  /**< G-line matches only the realname field. */
  76
  77 /** Controllable flags that can be set on an actual G-line. */
  78 #define GLINE_MASK      (GLINE_ACTIVE | GLINE_BADCHAN | GLINE_LOCAL | GLINE_REALNAME)
  79 /** Mask for G-line activity flags. */
  80 #define GLINE_ACTMASK   (GLINE_ACTIVE | GLINE_LDEACT)
  81
  82 /** Test whether \a g is active. */
  83 #define GlineIsActive(g)        (((g)->gl_flags & GLINE_ACTMASK) == \
  84                                  GLINE_ACTIVE)
  85 /** Test whether \a g is remotely (globally) active. */
  86 #define GlineIsRemActive(g)     ((g)->gl_flags & GLINE_ACTIVE)
  87 /** Test whether \a g is an IP-based G-line. */
  88 #define GlineIsIpMask(g)        ((g)->gl_flags & GLINE_IPMASK)
  89 /** Test whether \a g is a realname-based G-line. */
  90 #define GlineIsRealName(g)      ((g)->gl_flags & GLINE_REALNAME)
  91 /** Test whether \a g is a BADCHAN. */
  92 #define GlineIsBadChan(g)       ((g)->gl_flags & GLINE_BADCHAN)
  93 /** Test whether \a g is local to this server. */
  94 #define GlineIsLocal(g)         ((g)->gl_flags & GLINE_LOCAL)
  95
  96 /** Return user mask of a G-line. */
  97 #define GlineUser(g)            ((g)->gl_user)
  98 /** Return host mask of a G-line. */
  99 #define GlineHost(g)            ((g)->gl_host)
 100 /** Return reason/message of a G-line. */
 101 #define GlineReason(g)          ((g)->gl_reason)
 102 /** Return last modification time of a G-line. */
 103 #define GlineLastMod(g)         ((g)->gl_lastmod)
 104
 105 extern int gline_propagate(struct Client *cptr, struct Client *sptr,
 106                            struct Gline *gline);
 107 extern int gline_add(struct Client *cptr, struct Client *sptr, char *userhost,
 108                      char *reason, time_t expire, time_t lastmod,
 109                      unsigned int flags);
 110 extern int gline_activate(struct Client *cptr, struct Client *sptr,
 111                           struct Gline *gline, time_t lastmod,
 112                           unsigned int flags);
 113 extern int gline_deactivate(struct Client *cptr, struct Client *sptr,
 114                             struct Gline *gline, time_t lastmod,
 115                             unsigned int flags);
 116 extern struct Gline *gline_find(char *userhost, unsigned int flags);
 117 extern struct Gline *gline_lookup(struct Client *cptr, unsigned int flags);
 118 extern void gline_free(struct Gline *gline);
 119 extern void gline_burst(struct Client *cptr);
 120 extern int gline_resend(struct Client *cptr, struct Gline *gline);
 121 extern int gline_list(struct Client *sptr, char *userhost);
 122 extern void gline_stats(struct Client *sptr, const struct StatDesc *sd,
 123                         char *param);
 124 extern int gline_memory_count(size_t *gl_size);
 125
 126 #endif /* INCLUDED_gline_h */