2 * IRC - Internet Relay Chat, ircd/m_away.c
3 * Copyright (C) 1990 Jarkko Oikarinen and
4 * University of Oulu, Computing Center
6 * See file AUTHORS in IRC package for additional names of
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)
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.
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.
27 * m_functions execute protocol messages on this server:
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...).
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.
39 * (!IsServer(cptr)) => (cptr == sptr), because
40 * prefixes are taken *only* from servers...
43 * (sptr == cptr) => the message didn't
46 * (sptr != cptr && IsServer(sptr) means
47 * the prefix specified servername. (?)
49 * (sptr != cptr && !IsServer(sptr) means
50 * that message originated from a remote
55 * (!IsServer(sptr)) means that, sptr can safely
56 * taken as defining the target structure of the
57 * message in this server.
59 * *Always* true (if 'parse' and others are working correct):
61 * 1) sptr->from == cptr (note: cptr->from == cptr)
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 ]
68 * parc number of variable parameter strings (if zero,
69 * parv is allowed to be NULL)
71 * parv a NULL terminated list of parameter pointers,
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*
79 * note: it is guaranteed that parv[0]..parv[parc-1] are all
86 * No need to include handlers.h here the signatures must match
87 * and we don't need to force a rebuild of all the handlers everytime
88 * we add a new one to the list. --Bleep
94 #include "ircd_alloc.h"
95 #include "ircd_reply.h"
96 #include "ircd_string.h"
106 * user_set_away - set user away state
107 * returns 1 if client is away or changed away message, 0 if
108 * client is removing away status.
109 * NOTE: this function may modify user and message, so they
112 static int user_set_away(struct User* user, char* message)
119 if (EmptyString(message)) {
121 * Marking as not away
132 unsigned int len = strlen(message);
134 if (len > TOPICLEN) {
135 message[TOPICLEN] = '\0';
139 away = (char*) MyRealloc(away, len + 1);
141 away = (char*) MyMalloc(len + 1);
145 strcpy(away, message);
147 return (user->away != 0);
152 * m_away - generic message handler template
153 * - Added 14 Dec 1988 by jto.
155 * parv[0] = sender prefix
156 * parv[1] = away message
158 * TODO: Throttle aways - many people have a script which resets the away
159 * message every 10 seconds which really chews the bandwidth.
161 int m_away(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
163 char* away_message = parv[1];
166 assert(cptr == sptr);
168 if (user_set_away(cli_user(sptr), away_message)) {
169 sendcmdto_serv_butone(sptr, CMD_AWAY, cptr, ":%s", away_message);
170 send_reply(sptr, RPL_NOWAWAY);
173 sendcmdto_serv_butone(sptr, CMD_AWAY, cptr, "");
174 send_reply(sptr, RPL_UNAWAY);
180 * ms_away - server message handler template
181 * - Added 14 Dec 1988 by jto.
183 * parv[0] = sender prefix
184 * parv[1] = away message
186 int ms_away(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
188 char* away_message = parv[1];
193 * servers can't set away
196 return protocol_violation(sptr,"Server trying to set itself away");
198 if (user_set_away(cli_user(sptr), away_message))
199 sendcmdto_serv_butone(sptr, CMD_AWAY, cptr, ":%s", away_message);
201 sendcmdto_serv_butone(sptr, CMD_AWAY, cptr, "");