modules/core/m_part.c

   1 /*
   2  *  ircd-ratbox: A slightly useful ircd.
   3  *  m_part.c: Parts a user from a channel.
   4  *
   5  *  Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
   6  *  Copyright (C) 1996-2002 Hybrid Development Team
   7  *  Copyright (C) 2002-2005 ircd-ratbox development team
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; either version 2 of the License, or
  12  *  (at your option) any later version.
  13  *
  14  *  This program is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License
  20  *  along with this program; if not, write to the Free Software
  21  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
  22  *  USA
  23  */
  24
  25 #include "stdinc.h"
  26 #include "channel.h"
  27 #include "client.h"
  28 #include "hash.h"
  29 #include "match.h"
  30 #include "ircd.h"
  31 #include "numeric.h"
  32 #include "send.h"
  33 #include "s_serv.h"
  34 #include "msg.h"
  35 #include "parse.h"
  36 #include "modules.h"
  37 #include "s_conf.h"
  38 #include "packet.h"
  39 #include "inline/stringops.h"
  40 #include "hook.h"
  41
  42 static const char part_desc[] = "Provides the PART command to leave a channel";
  43
  44 static void m_part(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
  45
  46 struct Message part_msgtab = {
  47         "PART", 0, 0, 0, 0,
  48         {mg_unreg, {m_part, 2}, {m_part, 2}, mg_ignore, mg_ignore, {m_part, 2}}
  49 };
  50
  51 mapi_clist_av1 part_clist[] = { &part_msgtab, NULL };
  52
  53 DECLARE_MODULE_AV2(part, NULL, NULL, part_clist, NULL, NULL, NULL, NULL, part_desc);
  54
  55 static void part_one_client(struct Client *client_p,
  56                             struct Client *source_p, char *name,
  57                             const char *reason);
  58 static bool can_send_part(struct Client *source_p, struct Channel *chptr, struct membership *msptr);
  59 static bool do_message_hook(struct Client *source_p, struct Channel *chptr, const char **reason);
  60
  61
  62 /*
  63 ** m_part
  64 **      parv[1] = channel
  65 **      parv[2] = reason
  66 */
  67 static void
  68 m_part(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
  69 {
  70         char *p, *name;
  71         char reason[REASONLEN + 1];
  72         char *s = LOCAL_COPY(parv[1]);
  73
  74         reason[0] = '\0';
  75
  76         if(parc > 2)
  77                 rb_strlcpy(reason, parv[2], sizeof(reason));
  78
  79         name = rb_strtok_r(s, ",", &p);
  80
  81         /* Finish the flood grace period... */
  82         if(MyClient(source_p) && !IsFloodDone(source_p))
  83                 flood_endgrace(source_p);
  84
  85         while(name)
  86         {
  87                 part_one_client(client_p, source_p, name, reason);
  88                 name = rb_strtok_r(NULL, ",", &p);
  89         }
  90 }
  91
  92 /*
  93  * part_one_client
  94  *
  95  * inputs       - pointer to server
  96  *              - pointer to source client to remove
  97  *              - char pointer of name of channel to remove from
  98  * output       - none
  99  * side effects - remove ONE client given the channel name
 100  */
 101 static void
 102 part_one_client(struct Client *client_p, struct Client *source_p, char *name, const char *reason)
 103 {
 104         struct Channel *chptr;
 105         struct membership *msptr;
 106
 107         if((chptr = find_channel(name)) == NULL)
 108         {
 109                 sendto_one_numeric(source_p, ERR_NOSUCHCHANNEL, form_str(ERR_NOSUCHCHANNEL), name);
 110                 return;
 111         }
 112
 113         msptr = find_channel_membership(chptr, source_p);
 114         if(msptr == NULL)
 115         {
 116                 sendto_one_numeric(source_p, ERR_NOTONCHANNEL, form_str(ERR_NOTONCHANNEL), name);
 117                 return;
 118         }
 119
 120         if(MyConnect(source_p) && !IsOper(source_p) && !IsExemptSpambot(source_p))
 121                 check_spambot_warning(source_p, NULL);
 122
 123         /*
 124          *  Remove user from the old channel (if any)
 125          *  only allow /part reasons in -m chans
 126          */
 127         if(!EmptyString(reason) &&
 128                 (!MyConnect(source_p) ||
 129                  (can_send_part(source_p, chptr, msptr) && do_message_hook(source_p, chptr, &reason))
 130                 )
 131           )
 132         {
 133
 134                 sendto_server(client_p, chptr, CAP_TS6, NOCAPS,
 135                               ":%s PART %s :%s", use_id(source_p), chptr->chname, reason);
 136                 sendto_channel_local(ALL_MEMBERS, chptr, ":%s!%s@%s PART %s :%s",
 137                                      source_p->name, source_p->username,
 138                                      source_p->host, chptr->chname, reason);
 139         }
 140         else
 141         {
 142                 sendto_server(client_p, chptr, CAP_TS6, NOCAPS,
 143                               ":%s PART %s", use_id(source_p), chptr->chname);
 144                 sendto_channel_local(ALL_MEMBERS, chptr, ":%s!%s@%s PART %s",
 145                                      source_p->name, source_p->username,
 146                                      source_p->host, chptr->chname);
 147         }
 148         remove_user_from_channel(msptr);
 149 }
 150
 151 /*
 152  * can_send_part - whether a part message can be sent.
 153  *
 154  * inputs:
 155  *    - client parting
 156  *    - channel being parted
 157  *    - membership pointer
 158  * outputs:
 159  *    - true if message allowed
 160  *    - false if message denied
 161  * side effects:
 162  *    - none.
 163  */
 164 static bool
 165 can_send_part(struct Client *source_p, struct Channel *chptr, struct membership *msptr)
 166 {
 167         if (!can_send(chptr, source_p, msptr))
 168                 return false;
 169         /* Allow chanops to bypass anti_spam_exit_message_time for part messages. */
 170         if (is_chanop(msptr))
 171                 return true;
 172         return (source_p->localClient->firsttime + ConfigFileEntry.anti_spam_exit_message_time) < rb_current_time();
 173 }
 174
 175 /*
 176  * do_message_hook - execute the message hook on a part message reason.
 177  *
 178  * inputs:
 179  *    - client parting
 180  *    - channel being parted
 181  *    - pointer to reason
 182  * outputs:
 183  *    - true if message is allowed
 184  *    - false if message is denied or message is now empty
 185  * side effects:
 186  *    - reason may be modified.
 187  */
 188 static bool
 189 do_message_hook(struct Client *source_p, struct Channel *chptr, const char **reason)
 190 {
 191         hook_data_privmsg_channel hdata;
 192
 193         hdata.msgtype = MESSAGE_TYPE_PART;
 194         hdata.source_p = source_p;
 195         hdata.chptr = chptr;
 196         hdata.text = *reason;
 197         hdata.approved = 0;
 198
 199         call_hook(h_privmsg_channel, &hdata);
 200
 201         /* The reason may have been changed by a hook... */
 202         *reason = hdata.text;
 203
 204         return (hdata.approved == 0 && !EmptyString(*reason));
 205 }