ircd/m_away.c

   1 /*
   2  * IRC - Internet Relay Chat, ircd/m_away.c
   3  * Copyright (C) 1990 Jarkko Oikarinen and
   4  *                    University of Oulu, Computing Center
   5  *
   6  * See file AUTHORS in IRC package for additional names of
   7  * the programmers.
   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 1, or (at your option)
  12  * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  *
  23  * $Id: m_away.c,v 1.13 2004/12/11 05:13:46 klmitch Exp $
  24  */
  25
  26 /*
  27  * m_functions execute protocol messages on this server:
  28  *
  29  *    cptr    is always NON-NULL, pointing to a *LOCAL* client
  30  *            structure (with an open socket connected!). This
  31  *            identifies the physical socket where the message
  32  *            originated (or which caused the m_function to be
  33  *            executed--some m_functions may call others...).
  34  *
  35  *    sptr    is the source of the message, defined by the
  36  *            prefix part of the message if present. If not
  37  *            or prefix not found, then sptr==cptr.
  38  *
  39  *            (!IsServer(cptr)) => (cptr == sptr), because
  40  *            prefixes are taken *only* from servers...
  41  *
  42  *            (IsServer(cptr))
  43  *                    (sptr == cptr) => the message didn't
  44  *                    have the prefix.
  45  *
  46  *                    (sptr != cptr && IsServer(sptr) means
  47  *                    the prefix specified servername. (?)
  48  *
  49  *                    (sptr != cptr && !IsServer(sptr) means
  50  *                    that message originated from a remote
  51  *                    user (not local).
  52  *
  53  *            combining
  54  *
  55  *            (!IsServer(sptr)) means that, sptr can safely
  56  *            taken as defining the target structure of the
  57  *            message in this server.
  58  *
  59  *    *Always* true (if 'parse' and others are working correct):
  60  *
  61  *    1)      sptr->from == cptr  (note: cptr->from == cptr)
  62  *
  63  *    2)      MyConnect(sptr) <=> sptr == cptr (e.g. sptr
  64  *            *cannot* be a local connection, unless it's
  65  *            actually cptr!). [MyConnect(x) should probably
  66  *            be defined as (x == x->from) --msa ]
  67  *
  68  *    parc    number of variable parameter strings (if zero,
  69  *            parv is allowed to be NULL)
  70  *
  71  *    parv    a NULL terminated list of parameter pointers,
  72  *
  73  *                    parv[0], sender (prefix string), if not present
  74  *                            this points to an empty string.
  75  *                    parv[1]...parv[parc-1]
  76  *                            pointers to additional parameters
  77  *                    parv[parc] == NULL, *always*
  78  *
  79  *            note:   it is guaranteed that parv[0]..parv[parc-1] are all
  80  *                    non-NULL pointers.
  81  */
  82 #include "config.h"
  83
  84 #include "client.h"
  85 #include "ircd.h"
  86 #include "ircd_alloc.h"
  87 #include "ircd_log.h"
  88 #include "ircd_reply.h"
  89 #include "ircd_string.h"
  90 #include "msg.h"
  91 #include "numeric.h"
  92 #include "numnicks.h"
  93 #include "s_user.h"
  94 #include "send.h"
  95
  96 /* #include <assert.h> -- Now using assert in ircd_log.h */
  97 #include <string.h>
  98
  99 /*
 100  * user_set_away - set user away state
 101  * returns 1 if client is away or changed away message, 0 if
 102  * client is removing away status.
 103  * NOTE: this function may modify user and message, so they
 104  * must be mutable.
 105  */
 106 static int user_set_away(struct User* user, char* message)
 107 {
 108   char* away;
 109   assert(0 != user);
 110
 111   away = user->away;
 112
 113   if (EmptyString(message)) {
 114     /*
 115      * Marking as not away
 116      */
 117     if (away) {
 118       MyFree(away);
 119       user->away = 0;
 120     }
 121   }
 122   else {
 123     /*
 124      * Marking as away
 125      */
 126     unsigned int len = strlen(message);
 127
 128     if (len > AWAYLEN) {
 129       message[AWAYLEN] = '\0';
 130       len = AWAYLEN;
 131     }
 132     if (away)
 133       MyFree(away);
 134     away = (char*) MyMalloc(len + 1);
 135     assert(0 != away);
 136
 137     user->away = away;
 138     strcpy(away, message);
 139   }
 140   return (user->away != 0);
 141 }
 142
 143
 144 /*
 145  * m_away - generic message handler
 146  * - Added 14 Dec 1988 by jto.
 147  *
 148  * parv[0] = sender prefix
 149  * parv[1] = away message
 150  *
 151  * TODO: Throttle aways - many people have a script which resets the away
 152  *       message every 10 seconds which really chews the bandwidth.
 153  */
 154 int m_away(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 155 {
 156   char* away_message = parv[1];
 157   int was_away = cli_user(sptr)->away != 0;
 158
 159   assert(0 != cptr);
 160   assert(cptr == sptr);
 161
 162   if (user_set_away(cli_user(sptr), away_message))
 163   {
 164     if (!was_away)
 165       sendcmdto_serv_butone(sptr, CMD_AWAY, cptr, ":%s", away_message);
 166     send_reply(sptr, RPL_NOWAWAY);
 167   }
 168   else {
 169     sendcmdto_serv_butone(sptr, CMD_AWAY, cptr, "");
 170     send_reply(sptr, RPL_UNAWAY);
 171   }
 172   return 0;
 173 }
 174
 175 /*
 176  * ms_away - server message handler
 177  * - Added 14 Dec 1988 by jto.
 178  *
 179  * parv[0] = sender prefix
 180  * parv[1] = away message
 181  */
 182 int ms_away(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 183 {
 184   char* away_message = parv[1];
 185
 186   assert(0 != cptr);
 187   assert(0 != sptr);
 188   /*
 189    * servers can't set away
 190    */
 191   if (IsServer(sptr))
 192     return protocol_violation(sptr,"Server trying to set itself away");
 193
 194   if (user_set_away(cli_user(sptr), away_message))
 195     sendcmdto_serv_butone(sptr, CMD_AWAY, cptr, ":%s", away_message);
 196   else
 197     sendcmdto_serv_butone(sptr, CMD_AWAY, cptr, "");
 198   return 0;
 199 }
 200
 201