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 } CHANNEL;
41 
42 typedef struct _CLIENT2CHAN
43 {
44 	struct _CLIENT2CHAN *next;
45 	CLIENT *client;
46 	CHANNEL *channel;
47 	char modes[CHANNEL_MODE_LEN];	/* User-Modes in Channel */
48 } CL2CHAN;
49 
50 #else
51 
52 typedef POINTER CHANNEL;
53 typedef POINTER CL2CHAN;
54 
55 #endif
56 
57 GLOBAL struct list_head *Channel_GetListBans PARAMS((CHANNEL *c));
58 GLOBAL struct list_head *Channel_GetListInvites PARAMS((CHANNEL *c));
59 
60 GLOBAL void Channel_Init PARAMS(( void ));
61 GLOBAL void Channel_InitPredefined PARAMS((  void ));
62 GLOBAL void Channel_Exit PARAMS(( void ));
63 
64 GLOBAL bool Channel_Join PARAMS(( CLIENT *Client, char *Name ));
65 GLOBAL bool Channel_Part PARAMS(( CLIENT *Client, CLIENT *Origin, const char *Name, const char *Reason ));
66 
67 GLOBAL void Channel_Quit PARAMS(( CLIENT *Client, char *Reason ));
68 
69 GLOBAL void Channel_Kick PARAMS((CLIENT *Peer, CLIENT *Target, CLIENT *Origin,
70 				 const char *Name, const char *Reason));
71 
72 GLOBAL unsigned long Channel_Count PARAMS(( void ));
73 GLOBAL unsigned long Channel_MemberCount PARAMS(( CHANNEL *Chan ));
74 GLOBAL int Channel_CountForUser PARAMS(( CLIENT *Client ));
75 
76 GLOBAL const char *Channel_Name PARAMS(( const CHANNEL *Chan ));
77 GLOBAL char *Channel_Modes PARAMS(( CHANNEL *Chan ));
78 GLOBAL char *Channel_Topic PARAMS(( CHANNEL *Chan ));
79 GLOBAL char *Channel_Key PARAMS(( CHANNEL *Chan ));
80 GLOBAL unsigned long Channel_MaxUsers PARAMS(( CHANNEL *Chan ));
81 
82 GLOBAL void Channel_SetTopic PARAMS(( CHANNEL *Chan, CLIENT *Client, char *Topic ));
83 GLOBAL void Channel_SetModes PARAMS(( CHANNEL *Chan, char *Modes ));
84 GLOBAL void Channel_SetKey PARAMS(( CHANNEL *Chan, char *Key ));
85 GLOBAL void Channel_SetMaxUsers PARAMS(( CHANNEL *Chan, unsigned long Count ));
86 
87 GLOBAL CHANNEL *Channel_Search PARAMS(( const char *Name ));
88 
89 GLOBAL CHANNEL *Channel_First PARAMS(( void ));
90 GLOBAL CHANNEL *Channel_Next PARAMS(( CHANNEL *Chan ));
91 
92 GLOBAL CL2CHAN *Channel_FirstMember PARAMS(( CHANNEL *Chan ));
93 GLOBAL CL2CHAN *Channel_NextMember PARAMS(( CHANNEL *Chan, CL2CHAN *Cl2Chan ));
94 GLOBAL CL2CHAN *Channel_FirstChannelOf PARAMS(( CLIENT *Client ));
95 GLOBAL CL2CHAN *Channel_NextChannelOf PARAMS(( CLIENT *Client, CL2CHAN *Cl2Chan ));
96 
97 GLOBAL CLIENT *Channel_GetClient PARAMS(( CL2CHAN *Cl2Chan ));
98 GLOBAL CHANNEL *Channel_GetChannel PARAMS(( CL2CHAN *Cl2Chan ));
99 
100 GLOBAL bool Channel_IsValidName PARAMS(( const char *Name ));
101 
102 GLOBAL bool Channel_ModeAdd PARAMS(( CHANNEL *Chan, char Mode ));
103 GLOBAL bool Channel_ModeDel PARAMS(( CHANNEL *Chan, char Mode ));
104 
105 GLOBAL bool Channel_UserModeAdd PARAMS(( CHANNEL *Chan, CLIENT *Client, char Mode ));
106 GLOBAL bool Channel_UserModeDel PARAMS(( CHANNEL *Chan, CLIENT *Client, char Mode ));
107 GLOBAL char *Channel_UserModes PARAMS(( CHANNEL *Chan, CLIENT *Client ));
108 
109 GLOBAL bool Channel_IsMemberOf PARAMS(( CHANNEL *Chan, CLIENT *Client ));
110 
111 GLOBAL bool Channel_Write PARAMS((CHANNEL *Chan, CLIENT *From, CLIENT *Client,
112 				  const char *Command, bool SendErrors,
113 				  const char *Text));
114 
115 GLOBAL CHANNEL *Channel_Create PARAMS(( char *Name ));
116 
117 #ifndef STRICT_RFC
118 GLOBAL unsigned int Channel_TopicTime PARAMS(( CHANNEL *Chan ));
119 GLOBAL char *Channel_TopicWho PARAMS(( CHANNEL *Chan ));
120 #endif
121 
122 GLOBAL bool Channel_AddInvite PARAMS((CHANNEL *c, const char *Mask, bool OnlyOnce ));
123 GLOBAL bool Channel_AddBan PARAMS((CHANNEL *c, const char *Mask ));
124 
125 GLOBAL bool Channel_ShowBans PARAMS((CLIENT *client, CHANNEL *c));
126 GLOBAL bool Channel_ShowInvites PARAMS((CLIENT *client, CHANNEL *c));
127 #endif
128 /* -eof- */