trunk/include/channel.h

/*
 *  ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
 *
 *  Copyright (C) 2002 by the past and present ircd coders, and others.
 *
 *  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., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 *  USA
 */

/*! \file channel.h
 * \brief Responsible for managing channels, members, bans and topics
 * \version $Id: channel.h,v 7.166 2005/09/18 10:56:33 michael Exp $
 */

#ifndef INCLUDED_channel_h
#define INCLUDED_channel_h

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

struct Client;

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

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

  struct Channel *hnextch;

  struct Mode mode;
  char *topic;
  char *topic_info;
  time_t topic_time;
  unsigned long lazyLinkChannelExists;
  time_t last_knock; /*!< don't allow knock to flood */

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

  time_t first_received_message_time; /*!< channel flood control */
  int received_number_of_privmsgs;
  int flags;
  float number_joined;
  time_t last_join_time;

  time_t channelts;
  char chname[CHANNELLEN + 1];
};

/*! \brief Membership structure */
struct Membership
{
  dlink_node channode;     /*!< link to chptr->members    */
  dlink_node locchannode;  /*!< link to chptr->locmembers */
  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;
  size_t len;
  char *name;
  char *username;
  char *host;
  char *who;
  time_t when;
};

extern dlink_list global_channel_list;

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

extern void remove_ban(struct Ban *, dlink_list *);
extern void init_channels(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 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 free_topic(struct Channel *);
extern void destroy_channel(struct Channel *);
extern void set_channel_topic(struct Channel *, const char *, const char *, time_t);

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

extern struct Channel *get_or_create_channel(struct Client *, const char *, int *);
extern struct Membership *find_channel_link(struct Client *, struct Channel *);

/* 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)

#endif  /* INCLUDED_channel_h */
Revision:	30
Committed:	Sun Oct 2 20:03:27 2005 UTC (20 years, 9 months ago) by adx
Content type:	text/x-chdr
Original Path:	*ircd-hybrid/include/channel.h*
File size:	4940 byte(s)
Log Message:	- imported sources - can be moved later according to the directory/branching scheme, but we need the svn up
#	User	Rev	Content
1	adx	30	/*
2			* ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
3			*
4			* Copyright (C) 2002 by the past and present ircd coders, and others.
5			*
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			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19			* USA
20			*/
21
22			/*! \file channel.h
23			* \brief Responsible for managing channels, members, bans and topics
24			* \version $Id: channel.h,v 7.166 2005/09/18 10:56:33 michael Exp $
25			*/
26
27			#ifndef INCLUDED_channel_h
28			#define INCLUDED_channel_h
29
30			#include "ircd_defs.h" /* KEYLEN, CHANNELLEN */
31			#include "tools.h"
32
33			struct Client;
34
35			/! \brief Mode structure for channels /
36			struct Mode
37			{
38			unsigned int mode; /!< simple modes /
39			unsigned int limit; /!< +l userlimit /
40			char key[KEYLEN]; /!< +k key /
41			};
42
43			/! \brief Channel structure /
44			struct Channel
45			{
46			dlink_node node;
47
48			struct Channel *hnextch;
49
50			struct Mode mode;
51			char *topic;
52			char *topic_info;
53			time_t topic_time;
54			unsigned long lazyLinkChannelExists;
55			time_t last_knock; /!< don't allow knock to flood /
56
57			dlink_list members;
58			dlink_list locmembers; /!< local members are here too /
59			dlink_list invites;
60			dlink_list banlist;
61			dlink_list exceptlist;
62			dlink_list invexlist;
63
64			time_t first_received_message_time; /!< channel flood control /
65			int received_number_of_privmsgs;
66			int flags;
67			float number_joined;
68			time_t last_join_time;
69
70			time_t channelts;
71			char chname[CHANNELLEN + 1];
72			};
73
74			/! \brief Membership structure /
75			struct Membership
76			{
77			dlink_node channode; /!< link to chptr->members /
78			dlink_node locchannode; /!< link to chptr->locmembers /
79			dlink_node usernode; /!< link to source_p->channel /
80			struct Channel chptr; /!< Channel pointer */
81			struct Client client_p; /!< Client pointer */
82			unsigned int flags; /!< user/channel flags, e.g. CHFL_CHANOP /
83			};
84
85			/! \brief Ban structure. Used for b/e/I n!u\@h masks /
86			struct Ban
87			{
88			dlink_node node;
89			size_t len;
90			char *name;
91			char *username;
92			char *host;
93			char *who;
94			time_t when;
95			};
96
97			extern dlink_list global_channel_list;
98
99			extern int check_channel_name(const char *);
100			extern int can_send(struct Channel , struct Client );
101			extern int can_send_part(struct Membership , struct Channel , struct Client *);
102			extern int is_banned(struct Channel , struct Client );
103			extern int can_join(struct Client , struct Channel , const char *);
104			extern int has_member_flags(struct Membership *, unsigned int);
105
106			extern void remove_ban(struct Ban , dlink_list );
107			extern void init_channels(void);
108			extern void add_user_to_channel(struct Channel , struct Client ,
109			unsigned int, int);
110			extern void remove_user_from_channel(struct Membership *);
111			extern void channel_member_names(struct Client , struct Channel , int);
112			extern void add_invite(struct Channel , struct Client );
113			extern void del_invite(struct Channel , struct Client );
114			extern void send_channel_modes(struct Client , struct Channel );
115			extern void channel_modes(struct Channel , struct Client , char , char );
116			extern void check_spambot_warning(struct Client , const char );
117			extern void check_splitmode(void *);
118			extern void free_channel_list(dlink_list *);
119			extern void free_topic(struct Channel *);
120			extern void destroy_channel(struct Channel *);
121			extern void set_channel_topic(struct Channel , const char , const char *, time_t);
122
123			extern const char get_member_status(const struct Membership , int);
124
125			extern struct Channel get_or_create_channel(struct Client , const char , int );
126			extern struct Membership find_channel_link(struct Client , struct Channel *);
127
128			/* channel visible */
129			#define ShowChannel(v,c) (PubChannel(c) \|\| IsMember((v),(c)))
130
131			#define IsMember(who, chan) ((find_channel_link(who, chan)) ? 1 : 0)
132			#define AddMemberFlag(x, y) ((x)->flags \|= (y))
133			#define DelMemberFlag(x, y) ((x)->flags &= ~(y))
134
135			#define FLOOD_NOTICED 1
136			#define JOIN_FLOOD_NOTICED 2
137
138			#define SetFloodNoticed(x) ((x)->flags \|= FLOOD_NOTICED)
139			#define IsSetFloodNoticed(x) ((x)->flags & FLOOD_NOTICED)
140			#define ClearFloodNoticed(x) ((x)->flags &= ~FLOOD_NOTICED)
141
142			#define SetJoinFloodNoticed(x) ((x)->flags \|= JOIN_FLOOD_NOTICED)
143			#define IsSetJoinFloodNoticed(x) ((x)->flags & JOIN_FLOOD_NOTICED)
144			#define ClearJoinFloodNoticed(x) ((x)->flags &= ~JOIN_FLOOD_NOTICED)
145
146			#endif /* INCLUDED_channel_h */