* 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., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id$
+ */
+/** @file
+ * @brief Channel management and maintanance
+ * @version $Id$
*/
#include "config.h"
#include <stdlib.h>
#include <string.h>
+/** Linked list containing the full list of all channels */
struct Channel* GlobalChannelList = 0;
+/** Number of struct Membership*'s allocated */
static unsigned int membershipAllocCount;
+/** Freelist for struct Membership*'s */
static struct Membership* membershipFreeList;
void del_invite(struct Client *, struct Channel *);
static struct SLink* prev_ban;
static struct SLink* removed_bans_list;
-/*
- * Use a global variable to remember if an oper set a mode on a local channel. Ugly,
- * but the only way to do it without changing set_mode intensively.
+/**
+ * Use a global variable to remember if an oper set a mode on a local channel.
+ * Ugly, but the only way to do it without changing set_mode intensively.
*/
int LocalChanOperMode = 0;
#if !defined(NDEBUG)
-/*
- * return the length (>=0) of a chain of links.
+/** return the length (>=0) of a chain of links.
+ * @param lp pointer to the start of the linked list
+ * @return the number of items in the list
*/
static int list_length(struct SLink *lp)
{
}
#endif
+/** return the struct Membership* that represents a client on a channel
+ * This function finds a struct Membership* which holds the state about
+ * a client on a specific channel. The code is smart enough to iterate
+ * over the channels a user is in, or the users in a channel to find the
+ * user depending on which is likely to be more efficient.
+ *
+ * @param chptr pointer to the channel struct
+ * @param cptr pointer to the client struct
+ *
+ * @returns pointer to the struct Membership representing this client on
+ * this channel. Returns NULL if the client is not on the channel.
+ * Returns NULL if the client is actually a server.
+ * @see find_channel_member()
+ */
struct Membership* find_member_link(struct Channel* chptr, const struct Client* cptr)
{
struct Membership *m;
return 0;
}
-/*
- * find_chasing - Find the client structure for a nick name (user)
+/** Find the client structure for a nick name (user)
+ * Find the client structure for a nick name (user)
* using history mechanism if necessary. If the client is not found, an error
* message (NO SUCH NICK) is generated. If the client was found
* through the history, chasing will be 1 and otherwise 0.
+ *
+ * This function was used extensively in the P09 days, and since we now have
+ * numeric nicks is no longer quite as important.
+ *
+ * @param sptr Pointer to the client that has requested the search
+ * @param user a string represeting the client to be found
+ * @param chasing a variable set to 0 if the user was found directly,
+ * 1 otherwise
+ * @returns a pointer the client, or NULL if the client wasn't found.
*/
struct Client* find_chasing(struct Client* sptr, const char* user, int* chasing)
{
return who;
}
-/*
+/** build up a hostmask
* Create a string of form "foo!bar@fubar" given foo, bar and fubar
* as the parameters. If NULL, they become "*".
+ * @param namebuf the buffer to build the hostmask into. Must be at least
+ * NICKLEN+USERLEN+HOSTLEN+3 charactors long.
+ * @param nick The nickname
+ * @param name The ident
+ * @param host the hostname
+ * @returns namebuf
+ * @see make_nick_user_ip()
*/
-#define NUH_BUFSIZE (NICKLEN + USERLEN + HOSTLEN + 3)
static char *make_nick_user_host(char *namebuf, const char *nick,
const char *name, const char *host)
{
+#define NUH_BUFSIZE (NICKLEN + USERLEN + HOSTLEN + 3)
ircd_snprintf(0, namebuf, NUH_BUFSIZE, "%s!%s@%s", nick, name, host);
return namebuf;
}
-/*
+/** Create a hostmask using an IP address
* Create a string of form "foo!bar@123.456.789.123" given foo, bar and the
* IP-number as the parameters. If NULL, they become "*".
+ *
+ * @param ipbuf Buffer at least NICKLEN+USERLEN+SOCKIPLEN+4 to hold the final
+ * match.
+ * @param nick The nickname (or NULL for *)
+ * @param name The ident (or NULL for *)
+ * @param ip The IP address
+ * @returns ipbuf
+ * @see make_nick_user_host()
*/
-#define NUI_BUFSIZE (NICKLEN + USERLEN + 16 + 3)
+#define NUI_BUFSIZE (NICKLEN + USERLEN + SOCKIPLEN + 4)
static char *make_nick_user_ip(char *ipbuf, char *nick, char *name,
- struct in_addr ip)
+ const struct irc_in_addr *ip)
{
- ircd_snprintf(0, ipbuf, NUI_BUFSIZE, "%s!%s@%s", nick, name,
- ircd_ntoa((const char*) &ip));
+ ircd_snprintf(0, ipbuf, NUI_BUFSIZE, "%s!%s@%s", nick, name, ircd_ntoa(ip));
return ipbuf;
}
-/*
- * Subtract one user from channel i (and free channel
- * block, if channel became empty).
- * Returns: true (1) if channel still has members.
+/** Decrement the count of users, and free if empty.
+ * Subtract one user from channel i (and free channel * block, if channel
+ * became empty).
+ *
+ * @param chptr The channel to subtract one from.
+ *
+ * @returns true (1) if channel still has members.
* false (0) if the channel is now empty.
*/
int sub1_from_channel(struct Channel* chptr)
return 0;
}
+/** Destroy an empty channel
+ * This function destroys an empty channel, removing it from hashtables,
+ * and removing any resources it may have consumed.
+ *
+ * @param chptr The channel to destroy
+ *
+ * @returns 0 (success)
+ *
+ * FIXME: Change to return void, this function never fails.
+ */
int destruct_channel(struct Channel* chptr)
{
struct SLink *tmp;
return 0;
}
-/*
- * add_banid
+/** add a ban to a channel
*
* `cptr' must be the client adding the ban.
*
* is reset (unless a non-zero value is returned, in which case the
* CHFL_BAN_OVERLAPPED flag might not have been reset!).
*
- * --Run
+ * @author Run
+ * @param cptr Client adding the ban
+ * @param chptr Channel to add the ban to
+ * @param change True if adding a ban, false if old bans should just be flagged
+ * @param firsttime Reset the next_overlapped_ban() iteration.
+ * @returns
+ * 0 if the ban was added
+ * -2 if the ban already existed and was marked CHFL_BURST_BAN_WIPEOUT
+ * -1 otherwise
*/
int add_banid(struct Client *cptr, struct Channel *chptr, char *banid,
int change, int firsttime)
return 0;
}
+/** return the next ban that is removed
+ * @returns the next ban that is removed because of overlapping
+ */
struct SLink *next_removed_overlapped_ban(void)
{
struct SLink *tmp = removed_bans_list;
return tmp;
}
-/*
- * find_channel_member - returns Membership * if a person is joined and not a zombie
+/** returns Membership * if a person is joined and not a zombie
+ * @param cptr Client
+ * @param chptr Channel
+ * @returns pointer to the client's struct Membership * on the channel if that
+ * user is a full member of the channel, or NULL otherwise.
+ *
+ * @see find_member_link()
*/
struct Membership* find_channel_member(struct Client* cptr, struct Channel* chptr)
{
return (member && !IsZombie(member)) ? member : 0;
}
-/*
- * is_banned - a non-zero value if banned else 0.
+/** return true if banned else false.
+ *
+ * This function returns true if the user is banned on the said channel.
+ * This function will check the ban cache if applicable, otherwise will
+ * do the comparisons and cache the result.
+ *
+ * @param cptr The client to test
+ * @param chptr The channel
+ * @param member The Membership * of this client on this channel
+ * (may be NULL if the member is not on the channel).
*/
static int is_banned(struct Client *cptr, struct Channel *chptr,
struct Membership* member)
if ((tmp->flags & CHFL_BAN_IPMASK)) {
if (!ip_s)
ip_s = make_nick_user_ip(nu_ip, cli_name(cptr),
- (cli_user(cptr))->username, cli_ip(cptr));
+ (cli_user(cptr))->username, &cli_ip(cptr));
if (match(tmp->value.ban.banstr, ip_s) == 0)
break;
}
- else if (match(tmp->value.ban.banstr, s) == 0)
+ if (match(tmp->value.ban.banstr, s) == 0)
break;
else if (sr && match(tmp->value.ban.banstr, sr) == 0)
break;
return (tmp != NULL);
}
-/*
+/** add a user to a channel.
* adds a user to a channel by adding another link to the channels member
* chain.
+ *
+ * @param chptr The channel to add to.
+ * @param who The user to add.
+ * @param flags The flags the user gets initially.
+ * @param oplevel The oplevel the user starts with.
*/
void add_user_to_channel(struct Channel* chptr, struct Client* who,
unsigned int flags, int oplevel)
}
}
+/** Remove a person from a channel, given their Membership*
+ *
+ * @param member A member of a channel.
+ *
+ * @returns true if there are more people in the channel.
+ */
static int remove_member_from_channel(struct Membership* member)
{
struct Channel* chptr;
member->prev_member->next_member = member->next_member;
else
member->channel->members = member->next_member;
-
+
+ /*
+ * If this is the last delayed-join user, may have to clear WASDELJOINS.
+ */
+ if (IsDelayedJoin(member))
+ CheckDelayedJoins(chptr);
+
/*
* unlink client channel list
*/
return sub1_from_channel(chptr);
}
+/** Check if all the remaining members on the channel are zombies
+ *
+ * @returns False if the channel has any non zombie members, True otherwise.
+ * @see \ref zombie
+ */
static int channel_all_zombies(struct Channel* chptr)
{
struct Membership* member;
}
+/** Remove a user from a channel
+ * This is the generic entry point for removing a user from a channel, this
+ * function will remove the client from the channel, and destory the channel
+ * if there are no more normal users left.
+ *
+ * @param cptr The client
+ * @param channel The channel
+ */
void remove_user_from_channel(struct Client* cptr, struct Channel* chptr)
{
}
}
+/** Remove a user from all channels they are on.
+ *
+ * This function removes a user from all channels they are on.
+ *
+ * @param cptr The client to remove.
+ */
void remove_user_from_all_channels(struct Client* cptr)
{
struct Membership* chan;
remove_user_from_channel(cptr, chan->channel);
}
+/** Check if this user is a legitimate chanop
+ *
+ * @param cptr Client to check
+ * @param chptr Channel to check
+ *
+ * @returns True if the user is a chanop (And not a zombie), False otherwise.
+ * @see \ref zombie
+ */
int is_chan_op(struct Client *cptr, struct Channel *chptr)
{
struct Membership* member;
return 0;
}
+/** Check if a user is a Zombie on a specific channel.
+ *
+ * @param cptr The client to check.
+ * @param chptr The channel to check.
+ *
+ * @returns True if the client (cptr) is a zombie on the channel (chptr),
+ * False otherwise.
+ *
+ * @see \ref zombie
+ */
int is_zombie(struct Client *cptr, struct Channel *chptr)
{
struct Membership* member;
return 0;
}
+/** Returns if a user has voice on a channel.
+ *
+ * @param cptr The client
+ * @param chptr The channel
+ *
+ * @returns True if the client (cptr) is voiced on (chptr) and is not a zombie.
+ * @see \ref zombie
+ */
int has_voice(struct Client* cptr, struct Channel* chptr)
{
struct Membership* member;
return 0;
}
-int member_can_send_to_channel(struct Membership* member)
+/** Can this member send to a channel
+ *
+ * A user can speak on a channel iff:
+ * <ol>
+ * <li> They didn't use the Apass to gain ops.
+ * <li> They are op'd or voice'd.
+ * <li> You aren't banned.
+ * <li> The channel isn't +m
+ * <li> The channel isn't +n or you are on the channel.
+ * </ol>
+ *
+ * This function will optionally reveal a user on a delayed join channel if
+ * they are allowed to send to the channel.
+ *
+ * @param member The membership of the user
+ * @param reveal If true, the user will be "revealed" on a delayed
+ * joined channel.
+ *
+ * @returns True if the client can speak on the channel.
+ */
+int member_can_send_to_channel(struct Membership* member, int reveal)
{
assert(0 != member);
*/
if (MyUser(member->user) && is_banned(member->user, member->channel, member))
return 0;
+
+ if (IsDelayedJoin(member) && reveal)
+ RevealDelayedJoin(member);
+
return 1;
}
-int client_can_send_to_channel(struct Client *cptr, struct Channel *chptr)
+/** Check if a client can send to a channel.
+ *
+ * Has the added check over member_can_send_to_channel() of servers can
+ * always speak.
+ *
+ * @param cptr The client to check
+ * @param chptr The channel to check
+ * @param reveal If the user should be revealed (see
+ * member_can_send_to_channel())
+ *
+ * @returns true if the client is allowed to speak on the channel, false
+ * otherwise
+ *
+ * @see member_can_send_to_channel()
+ */
+int client_can_send_to_channel(struct Client *cptr, struct Channel *chptr, int reveal)
{
struct Membership *member;
assert(0 != cptr);
else
return !is_banned(cptr, chptr, NULL);
}
- return member_can_send_to_channel(member);
+ return member_can_send_to_channel(member, reveal);
}
-/*
- * find_no_nickchange_channel
- * if a member and not (opped or voiced) and (banned or moderated)
- * return the name of the first channel banned on
+/** Returns the name of a channel that prevents the user from changing nick.
+ * if a member and not (opped or voiced) and (banned or moderated), return
+ * the name of the first channel banned on.
+ *
+ * @param cptr The client
+ *
+ * @returns the name of the first channel banned on, or NULL if the user
+ * can change nicks.
*/
const char* find_no_nickchange_channel(struct Client* cptr)
{
}
-/*
+/** Fill mbuf/pbuf with modes from chptr
* write the "simple" list of channel modes for channel chptr onto buffer mbuf
- * with the parameters in pbuf.
+ * with the parameters in pbuf as visible by cptr.
+ *
+ * This function will hide keys from non-op'd, non-server clients.
+ *
+ * @param cptr The client to generate the mode for.
+ * @param mbuf The buffer to write the modes into.
+ * @param pbuf The buffer to write the mode parameters into.
+ * @param buflen The length of the buffers.
+ * @param chptr The channel to get the modes from.
+ * @param membership The membership of this client on this channel (or NULL
+ * if this client isn't on this channel)
+ *
*/
void channel_modes(struct Client *cptr, char *mbuf, char *pbuf, int buflen,
struct Channel *chptr, struct Membership *member)
*mbuf++ = 'n';
if (chptr->mode.mode & MODE_REGONLY)
*mbuf++ = 'r';
+ if (chptr->mode.mode & MODE_DELJOINS)
+ *mbuf++ = 'D';
+ else if (MyUser(cptr) && (chptr->mode.mode & MODE_WASDELJOINS))
+ *mbuf++ = 'd';
if (chptr->mode.limit) {
*mbuf++ = 'l';
ircd_snprintf(0, pbuf, buflen, "%u", chptr->mode.limit);
previous_parameter = 1;
}
if (*chptr->mode.upass) {
- *mbuf++ = 'u';
+ *mbuf++ = 'U';
if (previous_parameter)
strcat(pbuf, " ");
if (IsServer(cptr) || (member && IsChanOp(member) && OpLevel(member) == 0)) {
*mbuf = '\0';
}
+/** Compare two members oplevel
+ *
+ * @param mp1 Pointer to a pointer to a membership
+ * @param mp2 Pointer to a pointer to a membership
+ *
+ * @returns 0 if equal, -1 if mp1 is lower, +1 otherwise.
+ *
+ * Used for qsort(3).
+ */
int compare_member_oplevel(const void *mp1, const void *mp2)
{
struct Membership const* member1 = *(struct Membership const**)mp1;
return (member1->oplevel < member2->oplevel) ? -1 : 1;
}
-/*
- * send "cptr" a full list of the modes for channel chptr.
+/* send "cptr" a full list of the modes for channel chptr.
+ *
+ * Sends a BURST line to cptr, bursting all the modes for the channel.
+ *
+ * @param cptr Client pointer
+ * @param chptr Channel pointer
*/
void send_channel_modes(struct Client *cptr, struct Channel *chptr)
{
int opped_members_index = 0;
struct Membership** opped_members = NULL;
int last_oplevel = 0;
+ int feat_oplevels = (chptr->mode.mode & MODE_APASS) != 0;
assert(0 != cptr);
assert(0 != chptr);
* Do we have a nick with a new mode ?
* Or are we starting a new BURST line?
*/
- if (new_mode)
+ if (new_mode || !feat_oplevels)
{
/*
* This means we are at the _first_ member that has only
tbuf[loc++] = 'v';
if (IsChanOp(member)) /* flag_cnt == 2 or 3 */
{
- /* append the absolute value of the oplevel */
- loc += ircd_snprintf(0, tbuf + loc, sizeof(tbuf) - loc, "%u", member->oplevel);
- last_oplevel = member->oplevel;
+ /* append the absolute value of the oplevel */
+ if (feat_oplevels)
+ loc += ircd_snprintf(0, tbuf + loc, sizeof(tbuf) - loc, "%u", last_oplevel = member->oplevel);
+ else
+ tbuf[loc++] = 'o';
}
tbuf[loc] = '\0';
msgq_append(&me, mb, tbuf);
that didn't fit (full==1) */
if (opped_members)
MyFree(opped_members);
+ if (feature_bool(FEAT_TOPIC_BURST) && (chptr->topic[0] != '\0'))
+ sendcmdto_one(&me, CMD_TOPIC, cptr, "%H %Tu %Tu :%s", chptr,
+ chptr->creationtime, chptr->topic_time, chptr->topic);
}
-/*
+/** Canonify a mask.
* pretty_mask
*
- * by Carlo Wood (Run), 05 Oct 1998.
- *
- * Canonify a mask.
+ * @author Carlo Wood (Run),
+ * 05 Oct 1998.
*
* When the nick is longer then NICKLEN, it is cut off (its an error of course).
* When the user name or host name are too long (USERLEN and HOSTLEN
* 3) xxx!yyy -> nick!user@*
* 4) xxx@yyy -> *!user@host
* 5) xxx!yyy@zzz -> nick!user@host
+ *
+ * @param mask The uncanonified mask.
+ * @returns The updated mask in a static buffer.
*/
char *pretty_mask(char *mask)
{
return make_nick_user_host(retmask, nick, user, host);
}
+/** send a banlist to a client for a channel
+ *
+ * @param cptr Client to send the banlist to.
+ * @param chptr Channel whose banlist to send.
+ */
static void send_ban_list(struct Client* cptr, struct Channel* chptr)
{
struct SLink* lp;
send_reply(cptr, RPL_ENDOFBANLIST, chptr->chname);
}
-/* We are now treating the <key> part of /join <channel list> <key> as a key
+/** Check a key against a keyring.
+ * We are now treating the <key> part of /join <channel list> <key> as a key
* ring; that is, we try one key against the actual channel key, and if that
* doesn't work, we try the next one, and so on. -Kev -Texaco
* Returns: 0 on match, 1 otherwise
* This version contributed by SeKs <intru@info.polymtl.ca>
+ *
+ * @param key Key to check
+ * @param keyring Comma seperated list of keys
+ *
+ * @returns True if the key was found and matches, false otherwise.
*/
static int compall(char *key, char *keyring)
{
goto top; /* and check it against the key */
}
+/** Returns if a user can join a channel with a specific key.
+ *
+ * @param sptr The client trying to join
+ * @param chptr The channel to join
+ * @param key The key to use
+ *
+ * @returns any error that occured bitwised OR'd with MAGIC_OPER_OVERRIDE
+ * if the oper used the magic key, 0 if no error occured.
+ */
int can_join(struct Client *sptr, struct Channel *chptr, char *key)
{
- struct SLink *lp;
int overrideJoin = 0;
/*
* Now a user CAN escape anything if invited -- Isomer
*/
- for (lp = (cli_user(sptr))->invited; lp; lp = lp->next)
- if (lp->value.chptr == chptr)
- return 0;
+ if (IsInvited(sptr, chptr))
+ return 0;
/* An oper can force a join on a local channel using "OVERRIDE" as the key.
a HACK(4) notice will be sent if he would not have been supposed
return 0;
}
-/*
- * Remove bells and commas from channel name
+/** Remove bells and commas from channel name
+ *
+ * @param ch Channel name to clean, modified in place.
*/
void clean_channelname(char *cn)
{
}
}
-/*
- * Get Channel block for i (and allocate a new channel
+/** Get a channel block, creating if necessary.
+ * Get Channel block for chname (and allocate a new channel
* block, if it didn't exists before).
+ *
+ * @param cptr Client joining the channel.
+ * @param chname The name of the channel to join.
+ * @param flag set to CGT_CREATE to create the channel if it doesn't
+ * exist
+ *
+ * @returns NULL if the channel is invalid, doesn't exist and CGT_CREATE
+ * wasn't specified or a pointer to the channel structure
*/
struct Channel *get_channel(struct Client *cptr, char *chname, ChannelGetType flag)
{
return chptr;
}
+/** invite a user to a channel.
+ *
+ * Adds an invite for a user to a channel. Limits the number of invites
+ * to FEAT_MAXCHANNELSPERUSER. Does not sent notification to the user.
+ *
+ * @param cptr The client to be invited.
+ * @param chptr The channel to be invited to.
+ */
void add_invite(struct Client *cptr, struct Channel *chptr)
{
struct SLink *inv, **tmp;
(cli_user(cptr))->invites++;
}
-/*
+/** Delete an invite
* Delete Invite block from channel invite list and client invite list
+ *
+ * @param cptr Client pointer
+ * @param chptr Channel pointer
*/
void del_invite(struct Client *cptr, struct Channel *chptr)
{
}
}
-/* List and skip all channels that are listen */
+/** List a set of channels
+ * Lists a series of channels that match a filter, skipping channels that
+ * have been listed before.
+ *
+ * @param cptr Client to send the list to.
+ * @param nr Number of channels to send this update.
+ */
void list_next_channels(struct Client *cptr, int nr)
{
struct ListingArgs *args = cli_listing(cptr);
{
for (; chptr; chptr = chptr->next)
{
- if (!cli_user(cptr) || (!(HasPriv(cptr, PRIV_LIST_CHAN) && IsAnOper(cptr)) &&
- SecretChannel(chptr) && !find_channel_member(cptr, chptr)))
+ if (!cli_user(cptr))
+ continue;
+ if (!(HasPriv(cptr, PRIV_LIST_CHAN) && IsAnOper(cptr)) &&
+ SecretChannel(chptr) && !find_channel_member(cptr, chptr))
continue;
if (chptr->users > args->min_users && chptr->users < args->max_users &&
chptr->creationtime > args->min_time &&
chptr->creationtime < args->max_time &&
- (!args->topic_limits || (*chptr->topic &&
+ (!(args->flags & LISTARG_TOPICLIMITS) || (*chptr->topic &&
chptr->topic_time > args->min_topic_time &&
chptr->topic_time < args->max_topic_time)))
{
- if (ShowChannel(cptr,chptr))
+ if ((args->flags & LISTARG_SHOWSECRET) || ShowChannel(cptr,chptr))
send_reply(cptr, RPL_LIST, chptr->chname, chptr->users,
chptr->topic);
chptr = chptr->next;
update_write(cptr);
}
-/*
+/** @page zombie Explaination of Zombies
+ *
* Consider:
*
* client
*
* --Run
*/
-void make_zombie(struct Membership* member, struct Client* who, struct Client* cptr,
- struct Client* sptr, struct Channel* chptr)
+
+/** Turn a user on a channel into a zombie
+ * This function turns a user into a zombie (see \ref zombie)
+ *
+ * @param member The structure representing this user on this channel.
+ * @param who The client that is being kicked.
+ * @param cptr The connection the kick came from.
+ * @param sptr The client that is doing the kicking.
+ * @param chptr The channel the user is being kicked from.
+ */
+void make_zombie(struct Membership* member, struct Client* who,
+ struct Client* cptr, struct Client* sptr, struct Channel* chptr)
{
assert(0 != member);
assert(0 != who);
*/
}
+/** returns the number of zombies on a channel
+ * @param chptr Channel to count zombies in.
+ *
+ * @returns The number of zombies on the channel.
+ */
int number_of_zombies(struct Channel *chptr)
{
struct Membership* member;
return count;
}
-/*
+/** Concatenate some strings together.
* This helper function builds an argument string in strptr, consisting
* of the original string, a space, and str1 and str2 concatenated (if,
* of course, str2 is not NULL)
+ *
+ * @param strptr The buffer to concatenate into
+ * @param strptr_i modified offset to the position to modify
+ * @param str1 The string to contatenate from.
+ * @param str2 The second string to contatenate from.
+ * @param c Charactor to seperate the string from str1 and str2.
*/
static void
build_string(char *strptr, int *strptr_i, const char *str1,
strptr[(*strptr_i)] = '\0';
}
-/*
+/** Flush out the modes
* This is the workhorse of our ModeBuf suite; this actually generates the
* output MODE commands, HACK notices, or whatever. It's pretty complicated.
+ *
+ * @param mbuf The mode buffer to flush
+ * @param all If true, flush all modes, otherwise leave partial modes in the
+ * buffer.
+ *
+ * @returns 0
*/
static int
modebuf_flush_int(struct ModeBuf *mbuf, int all)
MODE_INVITEONLY, 'i',
MODE_NOPRIVMSGS, 'n',
MODE_REGONLY, 'r',
+ MODE_DELJOINS, 'D',
+ MODE_WASDELJOINS, 'd',
/* MODE_KEY, 'k', */
/* MODE_BAN, 'b', */
-/* MODE_LIMIT, 'l', */
+ MODE_LIMIT, 'l',
/* MODE_APASS, 'A', */
-/* MODE_UPASS, 'u', */
+/* MODE_UPASS, 'U', */
0x0, 0x0
};
int i;
mode_char = 'A';
break;
case MODE_UPASS:
- mode_char = 'u';
+ mode_char = 'U';
break;
default:
mode_char = 'b';
if (mbuf->mb_dest & MODEBUF_DEST_HACK4)
sendto_opmask_butone(0, SNO_HACK4, "HACK(4): %s MODE %s %s%s%s%s%s%s "
"[%Tu]",
-#ifdef HEAD_IN_SAND_SNOTICES
- cli_name(mbuf->mb_source),
-#else
- cli_name(app_source),
-#endif
+ cli_name(feature_bool(FEAT_HIS_SNOTICES) ?
+ mbuf->mb_source : app_source),
mbuf->mb_channel->chname,
rembuf_i ? "-" : "", rembuf, addbuf_i ? "+" : "",
addbuf, remstr, addstr,
addbuf_i ? "+" : "", addbuf, remstr, addstr);
if (mbuf->mb_dest & MODEBUF_DEST_CHANNEL)
- sendcmdto_channel_butserv_butone(app_source, CMD_MODE, mbuf->mb_channel, NULL,
+ sendcmdto_channel_butserv_butone(app_source, CMD_MODE, mbuf->mb_channel, NULL, 0,
"%H %s%s%s%s%s%s", mbuf->mb_channel,
rembuf_i ? "-" : "", rembuf,
addbuf_i ? "+" : "", addbuf, remstr, addstr);
return 0;
}
-/*
+/** Initialise a modebuf
* This routine just initializes a ModeBuf structure with the information
* needed and the options given.
+ *
+ * @param mbuf The mode buffer to initialise.
+ * @param source The client that is performing the mode.
+ * @param connect ?
+ * @param chan The channel that the mode is being performed upon.
+ * @param dest ?
*/
void
modebuf_init(struct ModeBuf *mbuf, struct Client *source,
}
}
-/*
+/** Append a new mode to a modebuf
* This routine simply adds modes to be added or deleted; do a binary OR
* with either MODE_ADD or MODE_DEL
+ *
+ * @param mbuf Mode buffer
+ * @param mode MODE_ADD or MODE_DEL OR'd with MODE_PRIVATE etc.
*/
void
modebuf_mode(struct ModeBuf *mbuf, unsigned int mode)
assert(0 != (mode & (MODE_ADD | MODE_DEL)));
mode &= (MODE_ADD | MODE_DEL | MODE_PRIVATE | MODE_SECRET | MODE_MODERATED |
- MODE_TOPICLIMIT | MODE_INVITEONLY | MODE_NOPRIVMSGS | MODE_REGONLY);
+ MODE_TOPICLIMIT | MODE_INVITEONLY | MODE_NOPRIVMSGS | MODE_REGONLY |
+ MODE_DELJOINS | MODE_WASDELJOINS);
if (!(mode & ~(MODE_ADD | MODE_DEL))) /* don't add empty modes... */
return;
}
}
-/*
+/** Append a mode that takes an int argument to the modebuf
+ *
* This routine adds a mode to be added or deleted that takes a unsigned
* int parameter; mode may *only* be the relevant mode flag ORed with one
* of MODE_ADD or MODE_DEL
+ *
+ * @param mbuf The mode buffer to append to.
+ * @param mode The mode to append.
+ * @param uint The argument to the mode.
*/
void
modebuf_mode_uint(struct ModeBuf *mbuf, unsigned int mode, unsigned int uint)
assert(0 != mbuf);
assert(0 != (mode & (MODE_ADD | MODE_DEL)));
+ if (mode == (MODE_LIMIT | MODE_DEL)) {
+ mbuf->mb_rem |= mode;
+ return;
+ }
MB_TYPE(mbuf, mbuf->mb_count) = mode;
MB_UINT(mbuf, mbuf->mb_count) = uint;
modebuf_flush_int(mbuf, 0);
}
-/*
+/** append a string mode
* This routine adds a mode to be added or deleted that takes a string
* parameter; mode may *only* be the relevant mode flag ORed with one of
* MODE_ADD or MODE_DEL
+ *
+ * @param mbuf The mode buffer to append to.
+ * @param mode The mode to append.
+ * @param string The string parameter to append.
+ * @param free If the string should be free'd later.
*/
void
modebuf_mode_string(struct ModeBuf *mbuf, unsigned int mode, char *string,
modebuf_flush_int(mbuf, 0);
}
-/*
+/** Append a mode on a client to a modebuf.
* This routine adds a mode to be added or deleted that takes a client
* parameter; mode may *only* be the relevant mode flag ORed with one of
* MODE_ADD or MODE_DEL
+ *
+ * @param mbuf The modebuf to append the mode to.
+ * @param mode The mode to append.
+ * @param client The client argument to append.
*/
void
modebuf_mode_client(struct ModeBuf *mbuf, unsigned int mode,
modebuf_flush_int(mbuf, 0);
}
-/*
- * This is the exported binding for modebuf_flush()
+/** The exported binding for modebuf_flush()
+ *
+ * @param mbuf The mode buffer to flush.
+ *
+ * @see modebuf_flush_int()
*/
int
modebuf_flush(struct ModeBuf *mbuf)
{
+ struct Membership *memb;
+
+ /* Check if MODE_WASDELJOINS should be set */
+ if (!(mbuf->mb_channel->mode.mode & (MODE_DELJOINS | MODE_WASDELJOINS))
+ && (mbuf->mb_rem & MODE_DELJOINS)) {
+ for (memb = mbuf->mb_channel->members; memb; memb = memb->next_member) {
+ if (IsDelayedJoin(memb)) {
+ mbuf->mb_channel->mode.mode |= MODE_WASDELJOINS;
+ mbuf->mb_add |= MODE_WASDELJOINS;
+ mbuf->mb_rem &= ~MODE_WASDELJOINS;
+ break;
+ }
+ }
+ }
+
return modebuf_flush_int(mbuf, 1);
}
-/*
- * This extracts the simple modes contained in mbuf
+/* This extracts the simple modes contained in mbuf
+ *
+ * @param mbuf The mode buffer to extract the modes from.
+ * @param buf The string buffer to write the modes into.
*/
void
modebuf_extract(struct ModeBuf *mbuf, char *buf)
MODE_NOPRIVMSGS, 'n',
MODE_KEY, 'k',
MODE_APASS, 'A',
- MODE_UPASS, 'u',
+ MODE_UPASS, 'U',
/* MODE_BAN, 'b', */
MODE_LIMIT, 'l',
MODE_REGONLY, 'r',
+ MODE_DELJOINS, 'D',
0x0, 0x0
};
unsigned int add;
build_string(buf, &bufpos, key, 0, ' ');
else if (buf[i] == 'l')
build_string(buf, &bufpos, limitbuf, 0, ' ');
- else if (buf[i] == 'u')
+ else if (buf[i] == 'U')
build_string(buf, &bufpos, upass, 0, ' ');
else if (buf[i] == 'A')
build_string(buf, &bufpos, apass, 0, ' ');
return;
}
-/*
- * Simple function to invalidate bans
+/** Simple function to invalidate bans
+ *
+ * This function sets all bans as being valid.
+ *
+ * @param chan The channel to operate on.
*/
void
mode_ban_invalidate(struct Channel *chan)
ClearBanValid(member);
}
-/*
- * Simple function to drop invite structures
+/** Simple function to drop invite structures
+ *
+ * Remove all the invites on the channel.
+ *
+ * @param chan Channel to remove invites from.
+ *
*/
void
mode_invite_clear(struct Channel *chan)
}
/* What we've done for mode_parse so far... */
-#define DONE_LIMIT 0x01 /* We've set the limit */
-#define DONE_KEY 0x02 /* We've set the key */
-#define DONE_BANLIST 0x04 /* We've sent the ban list */
-#define DONE_NOTOPER 0x08 /* We've sent a "Not oper" error */
-#define DONE_BANCLEAN 0x10 /* We've cleaned bans... */
-#define DONE_UPASS 0x20 /* We've set user pass */
-#define DONE_APASS 0x40 /* We've set admin pass */
+#define DONE_LIMIT 0x01 /**< We've set the limit */
+#define DONE_KEY 0x02 /**< We've set the key */
+#define DONE_BANLIST 0x04 /**< We've sent the ban list */
+#define DONE_NOTOPER 0x08 /**< We've sent a "Not oper" error */
+#define DONE_BANCLEAN 0x10 /**< We've cleaned bans... */
+#define DONE_UPASS 0x20 /**< We've set user pass */
+#define DONE_APASS 0x40 /**< We've set admin pass */
struct ParseState {
struct ModeBuf *mbuf;
} cli_change[MAXPARA];
};
-/*
+/** Helper function to send "Not oper" or "Not member" messages
* Here's a helper function to deal with sending along "Not oper" or
* "Not member" messages
+ *
+ * @param state Parsing State object
*/
static void
send_notoper(struct ParseState *state)
state->done |= DONE_NOTOPER;
}
-/*
+/** Parse a limit
* Helper function to convert limits
+ *
+ * @param state Parsing state object.
+ * @param flag_p ?
*/
static void
mode_parse_limit(struct ParseState *state, int *flag_p)
state->parc--;
state->max_args--;
+ if ((int)t_limit<0) /* don't permit a negative limit */
+ return;
+
if (!(state->flags & MODE_PARSE_WIPEOUT) &&
(!t_limit || t_limit == state->chptr->mode.limit))
return;
return;
}
+ /* Can't remove a limit that's not there */
+ if (state->dir == MODE_DEL && !state->chptr->mode.limit)
+ return;
+
+ /* Skip if this is a burst and a lower limit than this is set already */
+ if ((state->flags & MODE_PARSE_BURST) &&
+ (state->chptr->mode.mode & flag_p[0]) &&
+ (state->chptr->mode.limit < t_limit))
+ return;
+
if (state->done & DONE_LIMIT) /* allow limit to be set only once */
return;
state->done |= DONE_LIMIT;
/* clean up the key string */
s = t_str;
- while (*++s > ' ' && *s != ':' && --t_len)
- ;
+ while (*s > ' ' && *s != ':' && *s != ',' && t_len--)
+ s++;
*s = '\0';
if (!*t_str) { /* warn if empty */
if (!state->mbuf)
return;
+ /* Skip if this is a burst, we have a key already and the new key is
+ * after the old one alphabetically */
+ if ((state->flags & MODE_PARSE_BURST) &&
+ *(state->chptr->mode.key) &&
+ ircd_strcmp(state->chptr->mode.key, t_str) <= 0)
+ return;
+
/* can't add a key if one is set, nor can one remove the wrong key */
if (!(state->flags & MODE_PARSE_FORCE))
if ((state->dir == MODE_ADD && *state->chptr->mode.key) ||
if (state->parc <= 0) { /* warn if not enough args */
if (MyUser(state->sptr))
- need_more_params(state->sptr, state->dir == MODE_ADD ? "MODE +u" :
- "MODE -u");
+ need_more_params(state->sptr, state->dir == MODE_ADD ? "MODE +U" :
+ "MODE -U");
return;
}
return;
}
+ /* If a non-service user is trying to force it, refuse. */
+ if (state->flags & MODE_PARSE_FORCE && !IsChannelService(state->sptr)) {
+ send_reply(state->sptr, ERR_NOTMANAGER, state->chptr->chname,
+ "Use /JOIN", state->chptr->chname, " <AdminPass>.");
+ return;
+ }
+
/* If they are not the channel manager, they are not allowed to change it */
if (MyUser(state->sptr) && !IsChannelManager(state->member)) {
if (*state->chptr->mode.apass) {
if (!*t_str) { /* warn if empty */
if (MyUser(state->sptr))
- need_more_params(state->sptr, state->dir == MODE_ADD ? "MODE +u" :
- "MODE -u");
+ need_more_params(state->sptr, state->dir == MODE_ADD ? "MODE +U" :
+ "MODE -U");
return;
}
return;
}
+ /* If a non-service user is trying to force it, refuse. */
+ if (state->flags & MODE_PARSE_FORCE && !IsChannelService(state->sptr)) {
+ send_reply(state->sptr, ERR_NOTMANAGER, state->chptr->chname,
+ "Use /JOIN", state->chptr->chname, " <AdminPass>.");
+ return;
+ }
+
/* Don't allow to change the Apass if the channel is older than 48 hours. */
if (TStime() - state->chptr->creationtime >= 172800 && !IsAnOper(state->sptr)) {
send_reply(state->sptr, ERR_CHANSECURED, state->chptr->chname);
if (MyUser(state->sptr)) {
/* don't allow local opers to be deopped on local channels */
- if (MyUser(state->sptr) &&
- state->cli_change[i].client != state->sptr &&
+ if (state->cli_change[i].client != state->sptr &&
IsLocalChannel(state->chptr->chname) &&
HasPriv(state->cli_change[i].client, PRIV_DEOP_LCHAN)) {
send_reply(state->sptr, ERR_ISOPERLCHAN,
SetOpLevel(member, old_level == MAXOPLEVEL ? MAXOPLEVEL : (old_level + level_increment));
}
- /* accumulate the change */
- modebuf_mode_client(state->mbuf, state->cli_change[i].flag,
- state->cli_change[i].client);
-
/* actually effect the change */
if (state->flags & MODE_PARSE_SET) {
if (state->cli_change[i].flag & MODE_ADD) {
+ if (IsDelayedJoin(member))
+ RevealDelayedJoin(member);
member->status |= (state->cli_change[i].flag &
(MODE_CHANOP | MODE_VOICE));
if (state->cli_change[i].flag & MODE_CHANOP)
member->status &= ~(state->cli_change[i].flag &
(MODE_CHANOP | MODE_VOICE));
}
+
+ /* accumulate the change */
+ modebuf_mode_client(state->mbuf, state->cli_change[i].flag,
+ state->cli_change[i].client);
} /* for (i = 0; state->cli_change[i].flags; i++) */
}
state->add &= ~MODE_SECRET;
state->del |= MODE_SECRET;
}
+ if (flag_p[0] & MODE_DELJOINS) {
+ state->add &= ~MODE_WASDELJOINS;
+ state->del |= MODE_WASDELJOINS;
+ }
} else {
state->add &= ~flag_p[0];
state->del |= flag_p[0];
MODE_NOPRIVMSGS, 'n',
MODE_KEY, 'k',
MODE_APASS, 'A',
- MODE_UPASS, 'u',
+ MODE_UPASS, 'U',
MODE_BAN, 'b',
MODE_LIMIT, 'l',
MODE_REGONLY, 'r',
+ MODE_DELJOINS, 'D',
MODE_ADD, '+',
MODE_DEL, '-',
0x0, 0x0
mode_parse_apass(&state, flag_p);
break;
- case 'u': /* deal with user passes */
+ case 'U': /* deal with user passes */
if (feature_bool(FEAT_OPLEVELS))
mode_parse_upass(&state, flag_p);
break;
SetUserParting(member);
/* Send notification to channel */
- if (!(flags & CHFL_ZOMBIE))
- sendcmdto_channel_butserv_butone(jbuf->jb_source, CMD_PART, chan, NULL,
+ if (!(flags & (CHFL_ZOMBIE | CHFL_DELAYED)))
+ sendcmdto_channel_butserv_butone(jbuf->jb_source, CMD_PART, chan, NULL, 0,
(flags & CHFL_BANNED || !jbuf->jb_comment) ?
":%H" : "%H :%s", chan, jbuf->jb_comment);
else if (MyUser(jbuf->jb_source))
remove_user_from_channel(jbuf->jb_source, chan);
} else {
/* Add user to channel */
- add_user_to_channel(chan, jbuf->jb_source, flags, 0);
+ if ((chan->mode.mode & MODE_DELJOINS) && !(flags & CHFL_VOICED_OR_OPPED))
+ add_user_to_channel(chan, jbuf->jb_source, flags | CHFL_DELAYED, 0);
+ else
+ add_user_to_channel(chan, jbuf->jb_source, flags, 0);
/* send notification to all servers */
if (jbuf->jb_type != JOINBUF_TYPE_CREATE && !is_local)
sendcmdto_serv_butone(jbuf->jb_source, CMD_JOIN, jbuf->jb_connect,
"%H %Tu", chan, chan->creationtime);
- /* Send the notification to the channel */
- sendcmdto_channel_butserv_butone(jbuf->jb_source, CMD_JOIN, chan, NULL, ":%H", chan);
+ if (!((chan->mode.mode & MODE_DELJOINS) && !(flags & CHFL_VOICED_OR_OPPED))) {
+ /* Send the notification to the channel */
+ sendcmdto_channel_butserv_butone(jbuf->jb_source, CMD_JOIN, chan, NULL, 0, "%H", chan);
- /* send an op, too, if needed */
- if (!MyUser(jbuf->jb_source) && jbuf->jb_type == JOINBUF_TYPE_CREATE)
- sendcmdto_channel_butserv_butone(jbuf->jb_source, CMD_MODE, chan, NULL, "%H +o %C",
- chan, jbuf->jb_source);
+ /* send an op, too, if needed */
+ if (!MyUser(jbuf->jb_source) && jbuf->jb_type == JOINBUF_TYPE_CREATE)
+ sendcmdto_channel_butserv_butone(jbuf->jb_source, CMD_MODE, chan, NULL, 0, "%H +o %C",
+ chan, jbuf->jb_source);
+ } else if (MyUser(jbuf->jb_source))
+ sendcmdto_one(jbuf->jb_source, CMD_JOIN, jbuf->jb_source, ":%H", chan);
}
if (jbuf->jb_type == JOINBUF_TYPE_PARTALL ||
return 1;
return 0;
}
+
+/* RevealDelayedJoin: sends a join for a hidden user */
+
+void RevealDelayedJoin(struct Membership *member) {
+ ClearDelayedJoin(member);
+ sendcmdto_channel_butserv_butone(member->user, CMD_JOIN, member->channel, member->user, 0, ":%H",
+ member->channel);
+ CheckDelayedJoins(member->channel);
+}
+
+/* CheckDelayedJoins: checks and clear +d if necessary */
+
+void CheckDelayedJoins(struct Channel *chan) {
+ struct Membership *memb2;
+
+ if (chan->mode.mode & MODE_WASDELJOINS) {
+ for (memb2=chan->members;memb2;memb2=memb2->next_member)
+ if (IsDelayedJoin(memb2))
+ break;
+
+ if (!memb2) {
+ /* clear +d */
+ chan->mode.mode &= ~MODE_WASDELJOINS;
+ sendcmdto_channel_butserv_butone(&me, CMD_MODE, chan, NULL, 0,
+ "%H -d", chan);
+ }
+ }
+}
projects / ircu2.10.12-pk.git / blobdiff