src/ngircd/channel.h

   1 /*
   2  * ngIRCd -- The Next Generation IRC Daemon
   3  * Copyright (c)2001-2008 by Alexander Barton (alex@barton.de)
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  * Please read the file COPYING, README and AUTHORS for more information.
  10  *
  11  * Channel management (header)
  12  */
  13
  14
  15 #ifndef __channel_h__
  16 #define __channel_h__
  17
  18
  19 #if defined(__channel_c__) | defined(S_SPLINT_S)
  20
  21 #include "lists.h"
  22 #include "defines.h"
  23 #include "array.h"
  24
  25 typedef struct _CHANNEL
  26 {
  27         struct _CHANNEL *next;
  28         char name[CHANNEL_NAME_LEN];    /* Name of the channel */
  29         UINT32 hash;                    /* Hash of the (lowecase!) name */
  30         char modes[CHANNEL_MODE_LEN];   /* Channel modes */
  31         array topic;                    /* Topic of the channel */
  32 #ifndef STRICT_RFC
  33         time_t topic_time;              /* Time when topic was set */
  34         char topic_who[CLIENT_NICK_LEN];/* Nickname of user that set topic */
  35 #endif
  36         char key[CLIENT_PASS_LEN];      /* Channel key ("password", mode "k" ) */
  37         unsigned long maxusers;         /* Maximum number of members (mode "l") */
  38         struct list_head list_bans;     /* list head of banned users */
  39         struct list_head list_invites;  /* list head of invited users */
  40         array keyfile;                  /* Name of the channel key file */
  41 } CHANNEL;
  42
  43 typedef struct _CLIENT2CHAN
  44 {
  45         struct _CLIENT2CHAN *next;
  46         CLIENT *client;
  47         CHANNEL *channel;
  48         char modes[CHANNEL_MODE_LEN];   /* User-Modes in Channel */
  49 } CL2CHAN;
  50
  51 #else
  52
  53 typedef POINTER CHANNEL;
  54 typedef POINTER CL2CHAN;
  55
  56 #endif
  57
  58 GLOBAL struct list_head *Channel_GetListBans PARAMS((CHANNEL *c));
  59 GLOBAL struct list_head *Channel_GetListInvites PARAMS((CHANNEL *c));
  60
  61 GLOBAL void Channel_Init PARAMS(( void ));
  62 GLOBAL void Channel_InitPredefined PARAMS((  void ));
  63 GLOBAL void Channel_Exit PARAMS(( void ));
  64
  65 GLOBAL bool Channel_Join PARAMS(( CLIENT *Client, const char *Name ));
  66 GLOBAL bool Channel_Part PARAMS(( CLIENT *Client, CLIENT *Origin, const char *Name, const char *Reason ));
  67
  68 GLOBAL void Channel_Quit PARAMS(( CLIENT *Client, const char *Reason ));
  69
  70 GLOBAL void Channel_Kick PARAMS((CLIENT *Peer, CLIENT *Target, CLIENT *Origin,
  71                                  const char *Name, const char *Reason));
  72
  73 GLOBAL unsigned long Channel_Count PARAMS(( void ));
  74 GLOBAL unsigned long Channel_MemberCount PARAMS(( CHANNEL *Chan ));
  75 GLOBAL int Channel_CountForUser PARAMS(( CLIENT *Client ));
  76
  77 GLOBAL const char *Channel_Name PARAMS(( const CHANNEL *Chan ));
  78 GLOBAL char *Channel_Modes PARAMS(( CHANNEL *Chan ));
  79 GLOBAL char *Channel_Topic PARAMS(( CHANNEL *Chan ));
  80 GLOBAL char *Channel_Key PARAMS(( CHANNEL *Chan ));
  81 GLOBAL unsigned long Channel_MaxUsers PARAMS(( CHANNEL *Chan ));
  82
  83 GLOBAL void Channel_SetTopic PARAMS(( CHANNEL *Chan, CLIENT *Client, const char *Topic ));
  84 GLOBAL void Channel_SetModes PARAMS(( CHANNEL *Chan, const char *Modes ));
  85 GLOBAL void Channel_SetKey PARAMS(( CHANNEL *Chan, const char *Key ));
  86 GLOBAL void Channel_SetMaxUsers PARAMS(( CHANNEL *Chan, unsigned long Count ));
  87
  88 GLOBAL CHANNEL *Channel_Search PARAMS(( const char *Name ));
  89
  90 GLOBAL CHANNEL *Channel_First PARAMS(( void ));
  91 GLOBAL CHANNEL *Channel_Next PARAMS(( CHANNEL *Chan ));
  92
  93 GLOBAL CL2CHAN *Channel_FirstMember PARAMS(( CHANNEL *Chan ));
  94 GLOBAL CL2CHAN *Channel_NextMember PARAMS(( CHANNEL *Chan, CL2CHAN *Cl2Chan ));
  95 GLOBAL CL2CHAN *Channel_FirstChannelOf PARAMS(( CLIENT *Client ));
  96 GLOBAL CL2CHAN *Channel_NextChannelOf PARAMS(( CLIENT *Client, CL2CHAN *Cl2Chan ));
  97
  98 GLOBAL CLIENT *Channel_GetClient PARAMS(( CL2CHAN *Cl2Chan ));
  99 GLOBAL CHANNEL *Channel_GetChannel PARAMS(( CL2CHAN *Cl2Chan ));
 100
 101 GLOBAL bool Channel_IsValidName PARAMS(( const char *Name ));
 102
 103 GLOBAL bool Channel_ModeAdd PARAMS(( CHANNEL *Chan, char Mode ));
 104 GLOBAL bool Channel_ModeDel PARAMS(( CHANNEL *Chan, char Mode ));
 105
 106 GLOBAL bool Channel_UserModeAdd PARAMS(( CHANNEL *Chan, CLIENT *Client, char Mode ));
 107 GLOBAL bool Channel_UserModeDel PARAMS(( CHANNEL *Chan, CLIENT *Client, char Mode ));
 108 GLOBAL char *Channel_UserModes PARAMS(( CHANNEL *Chan, CLIENT *Client ));
 109
 110 GLOBAL bool Channel_IsMemberOf PARAMS(( CHANNEL *Chan, CLIENT *Client ));
 111
 112 GLOBAL bool Channel_Write PARAMS((CHANNEL *Chan, CLIENT *From, CLIENT *Client,
 113                                   const char *Command, bool SendErrors,
 114                                   const char *Text));
 115
 116 GLOBAL CHANNEL *Channel_Create PARAMS(( const char *Name ));
 117
 118 #ifndef STRICT_RFC
 119 GLOBAL unsigned int Channel_TopicTime PARAMS(( CHANNEL *Chan ));
 120 GLOBAL char *Channel_TopicWho PARAMS(( CHANNEL *Chan ));
 121 #endif
 122
 123 GLOBAL bool Channel_AddInvite PARAMS((CHANNEL *c, const char *Mask, bool OnlyOnce ));
 124 GLOBAL bool Channel_AddBan PARAMS((CHANNEL *c, const char *Mask ));
 125
 126 GLOBAL bool Channel_ShowBans PARAMS((CLIENT *client, CHANNEL *c));
 127 GLOBAL bool Channel_ShowInvites PARAMS((CLIENT *client, CHANNEL *c));
 128
 129 GLOBAL void Channel_LogServer PARAMS((const char *msg));
 130
 131 GLOBAL bool Channel_CheckKey PARAMS((CHANNEL *Chan, CLIENT *Client,
 132                                      const char *Key));
 133
 134 #define Channel_IsLocal(c) (Channel_Name(c)[0] == '&')
 135 #define Channel_IsModeless(c) (Channel_Name(c)[0] == '+')
 136
 137 #endif
 138
 139 /* -eof- */