8.2.x/include/channel.h

/*
 *  ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
 *
 *  Copyright (c) 1997-2015 ircd-hybrid development team
 *
 *  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.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 *  USA
 */

/*! \file channel.h
 * \brief Responsible for managing channels, members, bans and topics
 * \version $Id$
 */

#ifndef INCLUDED_channel_h
#define INCLUDED_channel_h

#include "ircd_defs.h"        /* KEYLEN, CHANNELLEN */

/* channel visible */
#define ShowChannel(v,c)        (PubChannel(c) || IsMember((v),(c)))

#define IsMember(who, chan) ((find_channel_link(who, chan)) ? 1 : 0)
#define AddMemberFlag(x, y) ((x)->flags |=  (y))
#define DelMemberFlag(x, y) ((x)->flags &= ~(y))

#define FLOOD_NOTICED           1
#define JOIN_FLOOD_NOTICED      2

#define SetFloodNoticed(x)   ((x)->flags |= FLOOD_NOTICED)
#define IsSetFloodNoticed(x) ((x)->flags & FLOOD_NOTICED)
#define ClearFloodNoticed(x) ((x)->flags &= ~FLOOD_NOTICED)

#define SetJoinFloodNoticed(x)   ((x)->flags |= JOIN_FLOOD_NOTICED)
#define IsSetJoinFloodNoticed(x) ((x)->flags & JOIN_FLOOD_NOTICED)
#define ClearJoinFloodNoticed(x) ((x)->flags &= ~JOIN_FLOOD_NOTICED)

struct Client;

/*! \brief Mode structure for channels */
struct Mode
{
  unsigned int mode;   /**< simple modes */
  unsigned int limit;  /**< +l userlimit */
  char key[KEYLEN + 1];    /**< +k key */
};

/*! \brief Channel structure */
struct Channel
{
  dlink_node node;

  struct Channel *hnextch;
  struct Mode mode;

  char topic[TOPICLEN + 1];
  char topic_info[USERHOST_REPLYLEN];

  time_t creationtime;
  time_t topic_time;
  time_t last_knock;  /**< Don't allow knock to flood */
  time_t last_join_time;
  time_t first_received_message_time; /*!< channel flood control */
  unsigned int flags;
  int received_number_of_privmsgs;

  dlink_list locmembers;  /*!< local members are here too */
  dlink_list members;
  dlink_list invites;
  dlink_list banlist;
  dlink_list exceptlist;
  dlink_list invexlist;

  float number_joined;

  char name[CHANNELLEN + 1];
};

/*! \brief Membership structure */
struct Membership
{
  dlink_node locchannode;  /**< link to chptr->locmembers */
  dlink_node channode;     /**< link to chptr->members    */
  dlink_node usernode;     /**< link to source_p->channel */
  struct Channel *chptr;   /**< Channel pointer */
  struct Client *client_p; /**< Client pointer */
  unsigned int flags;      /**< user/channel flags, e.g. CHFL_CHANOP */
};

/*! \brief Ban structure. Used for b/e/I n!u\@h masks */
struct Ban
{
  dlink_node node;
  char name[NICKLEN + 1];
  char user[USERLEN + 1];
  char host[HOSTLEN + 1];
  char who[NICKLEN + USERLEN + HOSTLEN + 3];
  size_t len;
  time_t when;
  struct irc_ssaddr addr;
  int bits;
  int type;
};

extern dlink_list channel_list;
extern struct event splitmode_event;

extern int check_channel_name(const char *, const int);
extern int can_send(struct Channel *, struct Client *, struct Membership *, const char *);
extern int is_banned(const struct Channel *, const struct Client *);
extern int can_join(struct Client *, const struct Channel *, const char *);
extern int has_member_flags(const struct Membership *, const unsigned int);

extern void channel_do_join(struct Client *, char *, char *);
extern void channel_do_join_0(struct Client *);
extern void channel_do_part(struct Client *, char *, const char *);
extern void remove_ban(struct Ban *, dlink_list *);
extern void channel_init(void);
extern void add_user_to_channel(struct Channel *, struct Client *, unsigned int, int);
extern void remove_user_from_channel(struct Membership *);
extern void channel_member_names(struct Client *, struct Channel *, int);
extern void add_invite(struct Channel *, struct Client *);
extern void del_invite(struct Channel *, struct Client *);
extern void clear_invites_channel(struct Channel *);
extern void clear_invites_client(struct Client *);
extern void send_channel_modes(struct Client *, struct Channel *);
extern void channel_modes(struct Channel *, struct Client *, char *, char *);
extern void check_spambot_warning(struct Client *, const char *);
extern void check_splitmode(void *);
extern void free_channel_list(dlink_list *);
extern void destroy_channel(struct Channel *);
extern void channel_set_topic(struct Channel *, const char *, const char *, time_t, int);

extern const char *get_member_status(const struct Membership *, const int);

extern struct Channel *make_channel(const char *);
extern struct Membership *find_channel_link(struct Client *, struct Channel *);
#endif
Revision:	5851
Committed:	Mon Apr 27 17:54:12 2015 UTC (8 years, 11 months ago) by michael
Content type:	text/x-chdr
File size:	5188 byte(s)
Log Message:	- Renamed clear_invites() to clear_invites_channel() - Added separate clear_invites_client()
#	User	Rev	Content
1	adx	30	/*
2	michael	2865	* ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
3	adx	30	*
4	michael	5346	* Copyright (c) 1997-2015 ircd-hybrid development team
5	adx	30	*
6			* This program is free software; you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation; either version 2 of the License, or
9			* (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License
17			* along with this program; if not, write to the Free Software
18	michael	4564	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
19	adx	30	* USA
20			*/
21
22			/*! \file channel.h
23			* \brief Responsible for managing channels, members, bans and topics
24	knight	31	* \version $Id$
25	adx	30	*/
26
27			#ifndef INCLUDED_channel_h
28			#define INCLUDED_channel_h
29
30			#include "ircd_defs.h" /* KEYLEN, CHANNELLEN */
31
32	michael	1798	/* channel visible */
33			#define ShowChannel(v,c) (PubChannel(c) \|\| IsMember((v),(c)))
34
35			#define IsMember(who, chan) ((find_channel_link(who, chan)) ? 1 : 0)
36			#define AddMemberFlag(x, y) ((x)->flags \|= (y))
37			#define DelMemberFlag(x, y) ((x)->flags &= ~(y))
38
39			#define FLOOD_NOTICED 1
40			#define JOIN_FLOOD_NOTICED 2
41
42			#define SetFloodNoticed(x) ((x)->flags \|= FLOOD_NOTICED)
43			#define IsSetFloodNoticed(x) ((x)->flags & FLOOD_NOTICED)
44			#define ClearFloodNoticed(x) ((x)->flags &= ~FLOOD_NOTICED)
45
46			#define SetJoinFloodNoticed(x) ((x)->flags \|= JOIN_FLOOD_NOTICED)
47			#define IsSetJoinFloodNoticed(x) ((x)->flags & JOIN_FLOOD_NOTICED)
48			#define ClearJoinFloodNoticed(x) ((x)->flags &= ~JOIN_FLOOD_NOTICED)
49
50	adx	30	struct Client;
51
52			/! \brief Mode structure for channels /
53			struct Mode
54			{
55	michael	4405	unsigned int mode; /*< simple modes /
56			unsigned int limit; /*< +l userlimit /
57			char key[KEYLEN + 1]; /*< +k key /
58	adx	30	};
59
60			/! \brief Channel structure /
61			struct Channel
62			{
63			dlink_node node;
64
65			struct Channel *hnextch;
66	michael	1013	struct Mode mode;
67	adx	30
68	michael	1203	char topic[TOPICLEN + 1];
69			char topic_info[USERHOST_REPLYLEN];
70	michael	1013
71	michael	4817	time_t creationtime;
72	adx	30	time_t topic_time;
73	michael	4405	time_t last_knock; /*< Don't allow knock to flood /
74	michael	1013	time_t last_join_time;
75			time_t first_received_message_time; /!< channel flood control /
76			unsigned int flags;
77			int received_number_of_privmsgs;
78	adx	30
79	michael	4171	dlink_list locmembers; /!< local members are here too /
80	adx	30	dlink_list members;
81			dlink_list invites;
82			dlink_list banlist;
83			dlink_list exceptlist;
84			dlink_list invexlist;
85
86			float number_joined;
87
88	michael	4617	char name[CHANNELLEN + 1];
89	adx	30	};
90
91			/! \brief Membership structure /
92			struct Membership
93			{
94	michael	4405	dlink_node locchannode; /*< link to chptr->locmembers /
95			dlink_node channode; /*< link to chptr->members /
96			dlink_node usernode; /*< link to source_p->channel /
97			struct Channel chptr; /< Channel pointer /
98			struct Client client_p; /< Client pointer /
99			unsigned int flags; /*< user/channel flags, e.g. CHFL_CHANOP /
100	adx	30	};
101
102	michael	4405	/! \brief Ban structure. Used for b/e/I n!u\@h masks /
103	adx	30	struct Ban
104			{
105			dlink_node node;
106	michael	5758	char name[NICKLEN + 1];
107			char user[USERLEN + 1];
108			char host[HOSTLEN + 1];
109			char who[NICKLEN + USERLEN + HOSTLEN + 3];
110	michael	1013	size_t len;
111	adx	30	time_t when;
112	michael	371	struct irc_ssaddr addr;
113			int bits;
114	michael	1644	int type;
115	adx	30	};
116
117	michael	3945	extern dlink_list channel_list;
118	michael	4095	extern struct event splitmode_event;
119	adx	30
120	michael	1847	extern int check_channel_name(const char *, const int);
121	michael	1937	extern int can_send(struct Channel , struct Client , struct Membership , const char );
122	michael	1013	extern int is_banned(const struct Channel , const struct Client );
123	michael	4784	extern int can_join(struct Client , const struct Channel , const char *);
124	michael	1847	extern int has_member_flags(const struct Membership *, const unsigned int);
125	adx	30
126	michael	3936	extern void channel_do_join(struct Client , char , char *);
127	michael	3913	extern void channel_do_join_0(struct Client *);
128	michael	4784	extern void channel_do_part(struct Client , char , const char *);
129	adx	30	extern void remove_ban(struct Ban , dlink_list );
130	michael	1798	extern void channel_init(void);
131	michael	4405	extern void add_user_to_channel(struct Channel , struct Client , unsigned int, int);
132	adx	30	extern void remove_user_from_channel(struct Membership *);
133			extern void channel_member_names(struct Client , struct Channel , int);
134			extern void add_invite(struct Channel , struct Client );
135			extern void del_invite(struct Channel , struct Client );
136	michael	5851	extern void clear_invites_channel(struct Channel *);
137			extern void clear_invites_client(struct Client *);
138	adx	30	extern void send_channel_modes(struct Client , struct Channel );
139			extern void channel_modes(struct Channel , struct Client , char , char );
140			extern void check_spambot_warning(struct Client , const char );
141			extern void check_splitmode(void *);
142			extern void free_channel_list(dlink_list *);
143			extern void destroy_channel(struct Channel *);
144	michael	3940	extern void channel_set_topic(struct Channel , const char , const char *, time_t, int);
145	adx	30
146	michael	2133	extern const char get_member_status(const struct Membership , const int);
147	adx	30
148	michael	632	extern struct Channel make_channel(const char );
149	adx	30	extern struct Membership find_channel_link(struct Client , struct Channel *);
150	michael	4405	#endif