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