]> arthur.barton.de Git - ngircd-alex.git/blobdiff - src/ngircd/channel.h
ngIRCd Release 27
[ngircd-alex.git] / src / ngircd / channel.h
index f258453135d19be41c1a7820ac383bdfe368d1e1..edf6a836aa7c7108a88e6a4eacce7f15b3505570 100644 (file)
@@ -1,68 +1,46 @@
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2024 Alexander Barton (alex@barton.de) and Contributors.
  *
- * Dieses Programm ist freie Software. Sie koennen es unter den Bedingungen
- * der GNU General Public License (GPL), wie von der Free Software Foundation
- * herausgegeben, weitergeben und/oder modifizieren, entweder unter Version 2
- * der Lizenz oder (wenn Sie es wuenschen) jeder spaeteren Version.
- * Naehere Informationen entnehmen Sie bitter der Datei COPYING. Eine Liste
- * der an ngIRCd beteiligten Autoren finden Sie in der Datei AUTHORS.
- *
- * $Id: channel.h,v 1.10 2002/02/06 16:49:10 alex Exp $
- *
- * channel.h: Management der Channels (Header)
- *
- * $Log: channel.h,v $
- * Revision 1.10  2002/02/06 16:49:10  alex
- * - neue Funktionen Channel_Modes() und Channel_IsValidName().
- *
- * Revision 1.9  2002/01/29 00:11:19  alex
- * - neue Funktionen Channel_FirstChannelOf() und Channel_NextChannelOf().
- *
- * Revision 1.8  2002/01/28 01:16:15  alex
- * - neue Funktionen Channel_Name(), Channel_First() und Channel_Next().
- *
- * Revision 1.7  2002/01/26 18:41:55  alex
- * - CHANNEL- und CL2CHAN-Strukturen in Header verlegt,
- * - einige neue Funktionen (Channel_GetChannel(), Channel_FirstMember(), ...)
- *
- * Revision 1.6  2002/01/21 00:11:59  alex
- * - Definition der CHANNEL-Struktur aus Header entfernt,
- * - neue Funktionen Channel_Join(), Channel_Part() und Channel_RemoveClient().
- *
- * Revision 1.5  2002/01/16 22:09:07  alex
- * - neue Funktion Channel_Count().
- *
- * Revision 1.4  2002/01/02 02:42:58  alex
- * - Copyright-Texte aktualisiert.
- *
- * Revision 1.3  2001/12/31 02:18:51  alex
- * - viele neue Befehle (WHOIS, ISON, OPER, DIE, RESTART),
- * - neuen Header "defines.h" mit (fast) allen Konstanten.
- * - Code Cleanups und viele "kleine" Aenderungen & Bugfixes.
- *
- * Revision 1.2  2001/12/23 21:54:30  alex
- * - Konstanten um Prefix "CHANNEL_" erweitert.
- *
- * Revision 1.1  2001/12/14 08:13:43  alex
- * - neues Modul begonnen :-)
+ * 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.
+ * Please read the file COPYING, README and AUTHORS for more information.
  */
 
-
 #ifndef __channel_h__
 #define __channel_h__
 
-#include "client.h"
+/**
+ * @file
+ * Channel management (header)
+ */
 
+#if defined(__channel_c__)
 
-#ifdef __channel_c__
+#include "lists.h"
+#include "defines.h"
+#include "array.h"
 
 typedef struct _CHANNEL
 {
        struct _CHANNEL *next;
-       CHAR name[CHANNEL_NAME_LEN];    /* Name des Channel */
-       CHAR modes[CHANNEL_MODE_LEN];   /* Channel-Modes */
+       char name[CHANNEL_NAME_LEN];    /* Name of the channel */
+       UINT32 hash;                    /* Hash of the (lowecase!) name */
+       char modes[CHANNEL_MODE_LEN];   /* Channel modes */
+       array topic;                    /* Topic of the channel */
+#ifndef STRICT_RFC
+       time_t creation_time;           /* Channel creation time */
+       time_t topic_time;              /* Time when topic was set */
+       char topic_who[CLIENT_NICK_LEN];/* Nickname of user that set topic */
+#endif
+       char key[CLIENT_PASS_LEN];      /* Channel key ("password", mode "k" ) */
+       unsigned long maxusers;         /* Maximum number of members (mode "l") */
+       struct list_head list_bans;     /* list head of banned users */
+       struct list_head list_excepts;  /* list head of (ban) exception list */
+       struct list_head list_invites;  /* list head of invited users */
+       array keyfile;                  /* Name of the channel key file */
 } CHANNEL;
 
 typedef struct _CLIENT2CHAN
@@ -70,7 +48,7 @@ typedef struct _CLIENT2CHAN
        struct _CLIENT2CHAN *next;
        CLIENT *client;
        CHANNEL *channel;
-       CHAR modes[CHANNEL_MODE_LEN];   /* User-Modes in dem Channel */
+       char modes[CHANNEL_MODE_LEN];   /* User-Modes in Channel */
 } CL2CHAN;
 
 #else
@@ -80,37 +58,96 @@ typedef POINTER CL2CHAN;
 
 #endif
 
+GLOBAL struct list_head *Channel_GetListBans PARAMS((CHANNEL *c));
+GLOBAL struct list_head *Channel_GetListExcepts PARAMS((CHANNEL *c));
+GLOBAL struct list_head *Channel_GetListInvites PARAMS((CHANNEL *c));
+
+GLOBAL void Channel_Init PARAMS(( void ));
+GLOBAL void Channel_InitPredefined PARAMS((  void ));
+GLOBAL void Channel_Exit PARAMS(( void ));
+
+GLOBAL bool Channel_Join PARAMS(( CLIENT *Client, const char *Name ));
+GLOBAL bool Channel_Part PARAMS(( CLIENT *Client, CLIENT *Origin, const char *Name, const char *Reason ));
+
+GLOBAL void Channel_Quit PARAMS(( CLIENT *Client, const char *Reason ));
+
+GLOBAL void Channel_Kick PARAMS((CLIENT *Peer, CLIENT *Target, CLIENT *Origin,
+                                const char *Name, const char *Reason));
+
+GLOBAL unsigned long Channel_CountVisible PARAMS((CLIENT *Client));
+GLOBAL unsigned long Channel_MemberCount PARAMS(( CHANNEL *Chan ));
+GLOBAL int Channel_CountForUser PARAMS(( CLIENT *Client ));
+
+GLOBAL const char *Channel_Name PARAMS(( const CHANNEL *Chan ));
+GLOBAL char *Channel_Topic PARAMS(( CHANNEL *Chan ));
+GLOBAL char *Channel_Key PARAMS(( CHANNEL *Chan ));
+GLOBAL unsigned long Channel_MaxUsers PARAMS(( CHANNEL *Chan ));
 
-GLOBAL VOID Channel_Init( VOID );
-GLOBAL VOID Channel_Exit( VOID );
+GLOBAL void Channel_SetTopic PARAMS(( CHANNEL *Chan, CLIENT *Client, const char *Topic ));
+GLOBAL void Channel_SetModes PARAMS(( CHANNEL *Chan, const char *Modes ));
+GLOBAL void Channel_SetKey PARAMS(( CHANNEL *Chan, const char *Key ));
+GLOBAL void Channel_SetMaxUsers PARAMS(( CHANNEL *Chan, unsigned long Count ));
 
-GLOBAL BOOLEAN Channel_Join( CLIENT *Client, CHAR *Name );
-GLOBAL BOOLEAN Channel_Part( CLIENT *Client, CLIENT *Origin, CHAR *Name, CHAR *Reason );
+GLOBAL CHANNEL *Channel_Search PARAMS(( const char *Name ));
 
-GLOBAL VOID Channel_RemoveClient( CLIENT *Client, CHAR *Reason );
+GLOBAL CHANNEL *Channel_First PARAMS(( void ));
+GLOBAL CHANNEL *Channel_Next PARAMS(( CHANNEL *Chan ));
 
-GLOBAL INT Channel_Count( VOID );
+GLOBAL CL2CHAN *Channel_FirstMember PARAMS(( CHANNEL *Chan ));
+GLOBAL CL2CHAN *Channel_NextMember PARAMS(( CHANNEL *Chan, CL2CHAN *Cl2Chan ));
+GLOBAL CL2CHAN *Channel_FirstChannelOf PARAMS(( CLIENT *Client ));
+GLOBAL CL2CHAN *Channel_NextChannelOf PARAMS(( CLIENT *Client, CL2CHAN *Cl2Chan ));
 
-GLOBAL CHAR *Channel_Name( CHANNEL *Chan );
-GLOBAL CHAR *Channel_Modes( CHANNEL *Chan );
+GLOBAL CLIENT *Channel_GetClient PARAMS(( CL2CHAN *Cl2Chan ));
+GLOBAL CHANNEL *Channel_GetChannel PARAMS(( CL2CHAN *Cl2Chan ));
 
-GLOBAL CHANNEL *Channel_Search( CHAR *Name );
+GLOBAL bool Channel_IsValidName PARAMS(( const char *Name ));
 
-GLOBAL CHANNEL *Channel_First( VOID );
-GLOBAL CHANNEL *Channel_Next( CHANNEL *Chan );
+GLOBAL bool Channel_ModeAdd PARAMS(( CHANNEL *Chan, char Mode ));
+GLOBAL bool Channel_ModeDel PARAMS(( CHANNEL *Chan, char Mode ));
+GLOBAL bool Channel_HasMode PARAMS(( CHANNEL *Chan, char Mode ));
+GLOBAL char *Channel_Modes PARAMS(( CHANNEL *Chan ));
 
-GLOBAL CL2CHAN *Channel_FirstMember( CHANNEL *Chan );
-GLOBAL CL2CHAN *Channel_NextMember( CHANNEL *Chan, CL2CHAN *Cl2Chan );
-GLOBAL CL2CHAN *Channel_FirstChannelOf( CLIENT *Client );
-GLOBAL CL2CHAN *Channel_NextChannelOf( CLIENT *Client, CL2CHAN *Cl2Chan );
+GLOBAL bool Channel_UserModeAdd PARAMS(( CHANNEL *Chan, CLIENT *Client, char Mode ));
+GLOBAL bool Channel_UserModeDel PARAMS(( CHANNEL *Chan, CLIENT *Client, char Mode ));
+GLOBAL bool Channel_UserHasMode PARAMS(( CHANNEL *Chan, CLIENT *Client, char Mode ));
+GLOBAL char *Channel_UserModes PARAMS(( CHANNEL *Chan, CLIENT *Client ));
 
-GLOBAL CLIENT *Channel_GetClient( CL2CHAN *Cl2Chan );
-GLOBAL CHANNEL *Channel_GetChannel( CL2CHAN *Cl2Chan );
+GLOBAL bool Channel_IsMemberOf PARAMS(( CHANNEL *Chan, CLIENT *Client ));
 
-GLOBAL BOOLEAN Channel_IsValidName( CHAR *Name );
+GLOBAL bool Channel_Write PARAMS((CHANNEL *Chan, CLIENT *From, CLIENT *Client,
+                                 const char *Command, bool SendErrors,
+                                 const char *Text));
 
+GLOBAL CHANNEL *Channel_Create PARAMS(( const char *Name ));
 
+#ifndef STRICT_RFC
+GLOBAL unsigned int Channel_TopicTime PARAMS(( CHANNEL *Chan ));
+GLOBAL char *Channel_TopicWho PARAMS(( CHANNEL *Chan ));
+GLOBAL unsigned int Channel_CreationTime PARAMS(( CHANNEL *Chan ));
 #endif
 
+GLOBAL bool Channel_AddBan PARAMS((CHANNEL *c, const char *Mask, const char *who));
+GLOBAL bool Channel_AddExcept PARAMS((CHANNEL *c, const char *Mask, const char *who));
+GLOBAL bool Channel_AddInvite PARAMS((CHANNEL *c, const char *Mask,
+                                     bool OnlyOnce, const char *who));
+
+GLOBAL bool Channel_ShowBans PARAMS((CLIENT *client, CHANNEL *c));
+GLOBAL bool Channel_ShowExcepts PARAMS((CLIENT *client, CHANNEL *c));
+GLOBAL bool Channel_ShowInvites PARAMS((CLIENT *client, CHANNEL *c));
+
+GLOBAL void Channel_LogServer PARAMS((const char *msg));
+
+GLOBAL bool Channel_CheckKey PARAMS((CHANNEL *Chan, CLIENT *Client,
+                                    const char *Key));
+
+GLOBAL void Channel_CheckAdminRights PARAMS((CHANNEL *Chan, CLIENT *Client,
+                                            CLIENT *Origin, bool *OnChannel,
+                                            bool *AdminOk, bool *UseServerMode));
+
+#define Channel_IsLocal(c) (Channel_Name(c)[0] == '&')
+#define Channel_IsModeless(c) (Channel_Name(c)[0] == '+')
+
+#endif
 
 /* -eof- */