Forward port 2.10.11 /whois CPU limiter.
[ircu2.10.12-pk.git] / ircd / m_whois.c
1 /*
2  * IRC - Internet Relay Chat, ircd/m_whois.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$
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 "channel.h"
85 #include "client.h"
86 #include "hash.h"
87 #include "ircd.h"
88 #include "ircd_features.h"
89 #include "ircd_reply.h"
90 #include "ircd_string.h"
91 #include "match.h"
92 #include "msg.h"
93 #include "numeric.h"
94 #include "numnicks.h"
95 #include "s_user.h"
96 #include "send.h"
97 #include "whocmds.h"
98
99 #include <assert.h>
100 #include <string.h>
101
102 /*
103  * 2000-07-01: Isomer
104  *  * Rewritten to make this understandable
105  *  * You can nolonger /whois unregistered clients.
106  *  
107  *
108  * General rules:
109  *  /whois nick always shows the nick.
110  *  /whois wild* shows the nick if:
111  *   * they aren't +i and aren't on any channels.
112  *   * they are on a common channel.
113  *   * they aren't +i and are on a public channel. (not +p and not +s)
114  *   * they aren't +i and are on a private channel. (+p but not +s)
115  *  Or to look at it another way (I think):
116  *   * +i users are only shown if your on a common channel.
117  *   * users on +s channels only aren't shown.
118  *
119  *  whois doesn't show what channels a +k client is on, for the reason that
120  *  /whois X or /whois W floods a user off the server. :)
121  *
122  * nb: if the code and this comment disagree, the codes right and I screwed
123  *     up.
124  */
125
126 /*
127  * Send whois information for acptr to sptr
128  */
129 static void do_whois(struct Client* sptr, struct Client *acptr, int parc)
130 {
131   struct Client *a2cptr=0;
132   struct Channel *chptr=0;
133   int mlen;
134   int len;
135   static char buf[512];
136   
137   const struct User* user = cli_user(acptr);
138   const char* name = (!*(cli_name(acptr))) ? "?" : cli_name(acptr);  
139   a2cptr = user->server;
140   assert(user);
141   send_reply(sptr, RPL_WHOISUSER, name, user->username, user->host,
142                    cli_info(acptr));
143
144   /* Display the channels this user is on. */
145   if (!IsChannelService(acptr))
146   {
147     struct Membership* chan;
148     mlen = strlen(cli_name(&me)) + strlen(cli_name(sptr)) + 12 + strlen(name);
149     len = 0;
150     *buf = '\0';
151     for (chan = user->channel; chan; chan = chan->next_channel)
152     {
153        chptr = chan->channel;
154        
155        if (!ShowChannel(sptr, chptr))
156           continue;
157           
158        if (acptr != sptr && IsZombie(chan))
159           continue;
160           
161        if (len+strlen(chptr->chname) + mlen > BUFSIZE - 5) 
162        {
163           send_reply(sptr, SND_EXPLICIT | RPL_WHOISCHANNELS, "%s :%s", name, buf);
164           *buf = '\0';
165           len = 0;
166        }
167        if (IsDeaf(acptr))
168          *(buf + len++) = '-';
169        if (IsDelayedJoin(chan) && (sptr != acptr))
170          *(buf + len++) = '<';
171        else if (IsChanOp(chan))
172          *(buf + len++) = '@';
173        else if (HasVoice(chan))
174          *(buf + len++) = '+';
175        else if (IsZombie(chan))
176          *(buf + len++) = '!';
177        if (len)
178           *(buf + len) = '\0';
179        strcpy(buf + len, chptr->chname);
180        len += strlen(chptr->chname);
181        strcat(buf + len, " ");
182        len++;
183      }
184      if (buf[0] != '\0')
185         send_reply(sptr, RPL_WHOISCHANNELS, name, buf);
186   }
187
188   if (feature_bool(FEAT_HIS_WHOIS_SERVERNAME) && !IsAnOper(sptr) &&
189       sptr != acptr)
190     send_reply(sptr, RPL_WHOISSERVER, name, feature_str(FEAT_HIS_SERVERNAME),
191                feature_str(FEAT_HIS_SERVERINFO));
192   else
193     send_reply(sptr, RPL_WHOISSERVER, name, cli_name(a2cptr),
194                cli_info(a2cptr));
195
196   if (user)
197   {
198     if (user->away)
199        send_reply(sptr, RPL_AWAY, name, user->away);
200
201     if (SeeOper(sptr,acptr))
202        send_reply(sptr, RPL_WHOISOPERATOR, name);
203
204     if (IsAccount(acptr))
205       send_reply(sptr, RPL_WHOISACCOUNT, name, user->account);
206
207     if (HasHiddenHost(acptr) && (IsAnOper(sptr) || acptr == sptr))
208       send_reply(sptr, RPL_WHOISACTUALLY, name, user->username,
209                  user->realhost, ircd_ntoa((const char*) &(cli_ip(acptr))));
210     
211     /* Hint: if your looking to add more flags to a user, eg +h, here's
212      *       probably a good place to add them :)
213      */
214      
215     if (MyConnect(acptr) && (!feature_bool(FEAT_HIS_WHOIS_IDLETIME) ||
216                              (sptr == acptr || IsAnOper(sptr) || parc >= 3)))
217        send_reply(sptr, RPL_WHOISIDLE, name, CurrentTime - user->last, 
218                   cli_firsttime(acptr));
219   }
220 }
221
222 /*
223  * Search and return as many people as matched by the wild 'nick'.
224  * returns the number of people found (or, obviously, 0, if none where
225  * found).
226  */
227 static int do_wilds(struct Client* sptr, char *nick, int count, int parc)
228 {
229   struct Client *acptr; /* Current client we're concidering */
230   struct User *user;    /* the user portion of the client */
231   const char *name;     /* the name of this client */
232   struct Membership* chan; 
233   int invis;            /* does +i apply? */
234   int member;           /* Is this user on any channels? */
235   int showperson;       /* Should we show this person? */
236   int found = 0 ;       /* How many were found? */
237   
238   /* Ech! This is hidious! */
239   for (acptr = GlobalClientList; (acptr = next_client(acptr, nick));
240       acptr = cli_next(acptr))
241   {
242     if (!IsRegistered(acptr)) 
243       continue;
244       
245     if (IsServer(acptr))
246       continue;
247     /*
248      * I'm always last :-) and acptr->next == 0!!
249      *
250      * Isomer: Does this strike anyone else as being a horrible hidious
251      *         hack?
252      */
253     if (IsMe(acptr)) {
254       assert(!cli_next(acptr));
255       break;
256     }
257     
258     /*
259      * 'Rules' established for sending a WHOIS reply:
260      *
261      * - if wildcards are being used dont send a reply if
262      *   the querier isnt any common channels and the
263      *   client in question is invisible.
264      *
265      * - only send replies about common or public channels
266      *   the target user(s) are on;
267      */
268     user = cli_user(acptr);
269     name = (!*(cli_name(acptr))) ? "?" : cli_name(acptr);
270     assert(user);
271
272     invis = (acptr != sptr) && IsInvisible(acptr);
273     member = (user && user->channel) ? 1 : 0;
274     showperson = !invis && !member;
275     
276     /* Should we show this person now? */
277     if (showperson) {
278         found++;
279         do_whois(sptr, acptr, parc);
280         if (count+found>MAX_WHOIS_LINES)
281           return found;
282         continue;
283     }
284     
285     /* Step through the channels this user is on */
286     for (chan = user->channel; chan; chan = chan->next_channel)
287     {
288       struct Channel *chptr = chan->channel;
289
290       /* If this is a public channel, show the person */
291       if (!invis && PubChannel(chptr)) {
292         showperson = 1;
293         break;
294       }
295       
296       /* if this channel is +p and not +s, show them */
297       if (!invis && HiddenChannel(chptr) && !SecretChannel(chptr)) {
298           showperson = 1;
299           break;
300       }
301       
302       member = find_channel_member(sptr, chptr) ? 1 : 0;
303       if (invis && !member)
304         continue;
305
306       /* If sptr isn't really on this channel, skip it */
307       if (IsZombie(chan))
308         continue;
309        
310       /* Is this a common channel? */ 
311       if (member) {
312         showperson = 1;
313         break;
314       }
315     } /* of for (chan in channels) */
316     
317     /* Don't show this person */
318     if (!showperson)
319       continue;
320       
321     do_whois(sptr, acptr, parc);
322     found++;
323     if (count+found>MAX_WHOIS_LINES)
324        return found;  
325   } /* of global client list */
326   
327   return found;
328 }
329
330 /*
331  * m_whois - generic message handler
332  *
333  * parv[0] = sender prefix
334  * parv[1] = nickname masklist
335  *
336  * or
337  *
338  * parv[1] = target server, or a nickname representing a server to target.
339  * parv[2] = nickname masklist
340  */
341 int m_whois(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
342 {
343   char*           nick;
344   char*           tmp;
345   char*           p = 0;
346   int             found = 0;
347   int             total = 0;
348   int             wildscount = 0;
349
350   if (parc < 2)
351   {
352     send_reply(sptr, ERR_NONICKNAMEGIVEN);
353     return 0;
354   }
355
356   if (parc > 2)
357   {
358     /* For convenience: Accept a nickname as first parameter, by replacing
359      * it with the correct servername - as is needed by hunt_server().
360      * This is the secret behind the /whois nick nick trick.
361      */
362     if (feature_int(FEAT_HIS_REMOTE))
363     {
364       /* If remote queries are disabled, then use the *second* parameter of
365        * of whois, so /whois nick nick still works.
366        */
367       if (!IsAnOper(sptr))
368       {
369         if (!FindUser(parv[2]))
370         {
371           send_reply(sptr, ERR_NOSUCHNICK, parv[2]);
372           send_reply(sptr, RPL_ENDOFWHOIS, parv[2]);
373           return 0;
374         }
375         parv[1] = parv[2];
376       }
377     }
378
379     if (hunt_server_cmd(sptr, CMD_WHOIS, cptr, 0, "%C :%s", 1, parc, parv) !=
380        HUNTED_ISME)
381     return 0;
382     
383     parv[1] = parv[2];
384   }
385
386   for (tmp = parv[1]; (nick = ircd_strtok(&p, tmp, ",")); tmp = 0)
387   {
388     int wilds;
389
390     found = 0;
391     
392     collapse(nick);
393     
394     wilds = (strchr(nick, '?') || strchr(nick, '*'));
395     if (!wilds) {
396       struct Client *acptr = 0;
397       /* No wildcards */
398       acptr = FindUser(nick);
399       if (acptr && !IsServer(acptr)) {
400         do_whois(sptr, acptr, parc);
401         found = 1;
402       }
403     }
404     else /* wilds */
405     {
406       if (++wildscount > 3) {
407         send_reply(sptr, ERR_QUERYTOOLONG, parv[1]);
408         break;
409       }
410       found=do_wilds(sptr, nick, total, parc);
411     }
412
413     if (!found)
414       send_reply(sptr, ERR_NOSUCHNICK, nick);
415     total+=found;
416     if (total >= MAX_WHOIS_LINES) {
417       send_reply(sptr, ERR_QUERYTOOLONG, parv[1]);
418       break;
419     }
420     if (p)
421       p[-1] = ',';
422   } /* of tokenised parm[1] */
423   send_reply(sptr, RPL_ENDOFWHOIS, parv[1]);
424
425   return 0;
426 }
427
428 /*
429  * ms_whois - server message handler
430  *
431  * parv[0] = sender prefix
432  * parv[1] = nickname masklist
433  *
434  * or
435  *
436  * parv[1] = target server, or a nickname representing a server to target.
437  * parv[2] = nickname masklist
438  */
439 int ms_whois(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
440 {
441   char*           nick;
442   char*           tmp;
443   char*           p = 0;
444   int             found = 0;
445   int             total = 0;
446
447   if (parc < 2)
448   {
449     send_reply(sptr, ERR_NONICKNAMEGIVEN);
450     return 0;
451   }
452
453   if (parc > 2)
454   {
455     if (hunt_server_cmd(sptr, CMD_WHOIS, cptr, 0, "%C :%s", 1, parc, parv) !=
456         HUNTED_ISME)
457       return 0;
458     parv[1] = parv[2];
459   }
460
461   total = 0;
462   
463   for (tmp = parv[1]; (nick = ircd_strtok(&p, tmp, ",")); tmp = 0)
464   {
465     struct Client *acptr = 0;
466
467     found = 0;
468     
469     collapse(nick);
470     
471
472     acptr = FindUser(nick);
473     if (acptr && !IsServer(acptr)) {
474       found++;
475       do_whois(sptr, acptr, parc);
476     }
477
478     if (!found)
479       send_reply(sptr, ERR_NOSUCHNICK, nick);
480       
481     total+=found;
482       
483     if (total >= MAX_WHOIS_LINES) {
484       send_reply(sptr, ERR_QUERYTOOLONG, parv[1]);
485       break;
486     }
487       
488     if (p)
489       p[-1] = ',';
490   } /* of tokenised parm[1] */
491   send_reply(sptr, RPL_ENDOFWHOIS, parv[1]);
492
493   return 0;
494 }
495