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