Author: Kev <klmitch@mit.edu>
[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 (is_chan_op(acptr, chptr))
170          *(buf + len++) = '@';
171        else if (has_voice(acptr, chptr))
172          *(buf + len++) = '+';
173        else if (IsZombie(chan))
174          *(buf + len++) = '!';
175        if (len)
176           *(buf + len) = '\0';
177        strcpy(buf + len, chptr->chname);
178        len += strlen(chptr->chname);
179        strcat(buf + len, " ");
180        len++;
181      }
182      if (buf[0] != '\0')
183         send_reply(sptr, RPL_WHOISCHANNELS, name, buf);
184   }
185
186   if (feature_bool(FEAT_HIS_WHOIS_SERVERNAME) && !IsAnOper(sptr) &&
187       sptr != acptr)
188     send_reply(sptr, RPL_WHOISSERVER, name, feature_str(FEAT_HIS_SERVERNAME),
189                feature_str(FEAT_HIS_SERVERINFO));
190   else
191     send_reply(sptr, RPL_WHOISSERVER, name, cli_name(a2cptr),
192                cli_info(a2cptr));
193
194   if (user)
195   {
196     if (user->away)
197        send_reply(sptr, RPL_AWAY, name, user->away);
198
199     if (IsAnOper(acptr) && (HasPriv(acptr, PRIV_DISPLAY) ||
200                             HasPriv(sptr, PRIV_SEE_OPERS)))
201        send_reply(sptr, RPL_WHOISOPERATOR, name);
202
203     if (IsAccount(acptr))
204       send_reply(sptr, RPL_WHOISACCOUNT, name, user->account);
205
206     if (HasHiddenHost(acptr) && (IsAnOper(sptr) || acptr == sptr))
207       send_reply(sptr, RPL_WHOISACTUALLY, name, user->username,
208                  user->realhost, ircd_ntoa((const char*) &(cli_ip(acptr))));
209     
210     /* Hint: if your looking to add more flags to a user, eg +h, here's
211      *       probably a good place to add them :)
212      */
213      
214     if (MyConnect(acptr) && (!feature_bool(FEAT_HIS_WHOIS_IDLETIME) ||
215                              (sptr == acptr || IsAnOper(sptr) || parc >= 3)))
216        send_reply(sptr, RPL_WHOISIDLE, name, CurrentTime - user->last, 
217                   cli_firsttime(acptr));
218   }
219 }
220
221 /*
222  * Search and return as many people as matched by the wild 'nick'.
223  * returns the number of people found (or, obviously, 0, if none where
224  * found).
225  */
226 static int do_wilds(struct Client* sptr, char *nick, int count, int parc)
227 {
228   struct Client *acptr; /* Current client we're concidering */
229   struct User *user;    /* the user portion of the client */
230   char *name;           /* the name of this client */
231   struct Membership* chan; 
232   int invis;            /* does +i apply? */
233   int member;           /* Is this user on any channels? */
234   int showperson;       /* Should we show this person? */
235   int found = 0 ;       /* How many were found? */
236   
237   /* Ech! This is hidious! */
238   for (acptr = GlobalClientList; (acptr = next_client(acptr, nick));
239       acptr = cli_next(acptr))
240   {
241     if (!IsRegistered(acptr)) 
242       continue;
243       
244     if (IsServer(acptr))
245       continue;
246     /*
247      * I'm always last :-) and acptr->next == 0!!
248      *
249      * Isomer: Does this strike anyone else as being a horrible hidious
250      *         hack?
251      */
252     if (IsMe(acptr)) {
253       assert(!cli_next(acptr));
254       break;
255     }
256     
257     /*
258      * 'Rules' established for sending a WHOIS reply:
259      *
260      * - if wildcards are being used dont send a reply if
261      *   the querier isnt any common channels and the
262      *   client in question is invisible.
263      *
264      * - only send replies about common or public channels
265      *   the target user(s) are on;
266      */
267     user = cli_user(acptr);
268     name = (!*(cli_name(acptr))) ? "?" : cli_name(acptr);
269     assert(user);
270
271     invis = (acptr != sptr) && IsInvisible(acptr);
272     member = (user && user->channel) ? 1 : 0;
273     showperson = !invis && !member;
274     
275     /* Should we show this person now? */
276     if (showperson) {
277         found++;
278         do_whois(sptr, acptr, parc);
279         if (count+found>MAX_WHOIS_LINES)
280           return found;
281         continue;
282     }
283     
284     /* Step through the channels this user is on */
285     for (chan = user->channel; chan; chan = chan->next_channel)
286     {
287       struct Channel *chptr = chan->channel;
288
289       /* If this is a public channel, show the person */
290       if (!invis && PubChannel(chptr)) {
291         showperson = 1;
292         break;
293       }
294       
295       /* if this channel is +p and not +s, show them */
296       if (!invis && HiddenChannel(chptr) && !SecretChannel(chptr)) {
297           showperson = 1;
298           break;
299       }
300       
301       member = find_channel_member(sptr, chptr) ? 1 : 0;
302       if (invis && !member)
303         continue;
304
305       /* If sptr isn't really on this channel, skip it */
306       if (IsZombie(chan))
307         continue;
308        
309       /* Is this a common channel? */ 
310       if (member) {
311         showperson = 1;
312         break;
313       }
314     } /* of for (chan in channels) */
315     
316     /* Don't show this person */
317     if (!showperson)
318       continue;
319       
320     do_whois(sptr, acptr, parc);
321     found++;
322     if (count+found>MAX_WHOIS_LINES)
323        return found;  
324   } /* of global client list */
325   
326   return found;
327 }
328
329 /*
330  * m_whois - generic message handler
331  *
332  * parv[0] = sender prefix
333  * parv[1] = nickname masklist
334  *
335  * or
336  *
337  * parv[1] = target server, or a nickname representing a server to target.
338  * parv[2] = nickname masklist
339  */
340 int m_whois(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
341 {
342   char*           nick;
343   char*           tmp;
344   char*           p = 0;
345   int             found = 0;
346   int             total = 0;
347
348   if (parc < 2)
349   {
350     send_reply(sptr, ERR_NONICKNAMEGIVEN);
351     return 0;
352   }
353
354   if (parc > 2)
355   {
356     /* For convenience: Accept a nickname as first parameter, by replacing
357      * it with the correct servername - as is needed by hunt_server().
358      * This is the secret behind the /whois nick nick trick.
359      */
360     if (feature_int(FEAT_HIS_REMOTE))
361     {
362       /* If remote queries are disabled, then use the *second* parameter of
363        * of whois, so /whois nick nick still works.
364        */
365       if (!IsAnOper(sptr))
366       {
367         if (!FindUser(parv[2]))
368         {
369           send_reply(sptr, ERR_NOSUCHNICK, parv[2]);
370           send_reply(sptr, RPL_ENDOFWHOIS, parv[2]);
371           return 0;
372         }
373         parv[1] = parv[2];
374       }
375     }
376
377     if (hunt_server_cmd(sptr, CMD_WHOIS, cptr, 0, "%C :%s", 1, parc, parv) !=
378        HUNTED_ISME)
379     return 0;
380     
381     parv[1] = parv[2];
382   }
383
384   for (tmp = parv[1]; (nick = ircd_strtok(&p, tmp, ",")); tmp = 0)
385   {
386     int wilds;
387
388     found = 0;
389     
390     collapse(nick);
391     
392     wilds = (strchr(nick, '?') || strchr(nick, '*'));
393     if (!wilds) {
394       struct Client *acptr = 0;
395       /* No wildcards */
396       acptr = FindUser(nick);
397       if (acptr && !IsServer(acptr)) {
398         do_whois(sptr, acptr, parc);
399         found = 1;
400       }
401     }
402     else /* wilds */
403         found=do_wilds(sptr, nick, total, parc);
404
405     if (!found)
406       send_reply(sptr, ERR_NOSUCHNICK, nick);
407     total+=found;
408     if (total >= MAX_WHOIS_LINES) {
409       send_reply(sptr, ERR_QUERYTOOLONG, parv[1]);
410       break;
411     }
412     if (p)
413       p[-1] = ',';
414   } /* of tokenised parm[1] */
415   send_reply(sptr, RPL_ENDOFWHOIS, parv[1]);
416
417   return 0;
418 }
419
420 /*
421  * ms_whois - server message handler
422  *
423  * parv[0] = sender prefix
424  * parv[1] = nickname masklist
425  *
426  * or
427  *
428  * parv[1] = target server, or a nickname representing a server to target.
429  * parv[2] = nickname masklist
430  */
431 int ms_whois(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
432 {
433   char*           nick;
434   char*           tmp;
435   char*           p = 0;
436   int             found = 0;
437   int             total = 0;
438
439   if (parc < 2)
440   {
441     send_reply(sptr, ERR_NONICKNAMEGIVEN);
442     return 0;
443   }
444
445   if (parc > 2)
446   {
447     if (hunt_server_cmd(sptr, CMD_WHOIS, cptr, 0, "%C :%s", 1, parc, parv) !=
448         HUNTED_ISME)
449       return 0;
450     parv[1] = parv[2];
451   }
452
453   total = 0;
454   
455   for (tmp = parv[1]; (nick = ircd_strtok(&p, tmp, ",")); tmp = 0)
456   {
457     struct Client *acptr = 0;
458
459     found = 0;
460     
461     collapse(nick);
462     
463
464     acptr = FindUser(nick);
465     if (acptr && !IsServer(acptr)) {
466       found++;
467       do_whois(sptr, acptr, parc);
468     }
469
470     if (!found)
471       send_reply(sptr, ERR_NOSUCHNICK, nick);
472       
473     total+=found;
474       
475     if (total >= MAX_WHOIS_LINES) {
476       send_reply(sptr, ERR_QUERYTOOLONG, parv[1]);
477       break;
478     }
479       
480     if (p)
481       p[-1] = ',';
482   } /* of tokenised parm[1] */
483   send_reply(sptr, RPL_ENDOFWHOIS, parv[1]);
484
485   return 0;
486 }
487