Get rid of ms_names(); clean up m_names() to be more uniform.
[ircu2.10.12-pk.git] / ircd / m_names.c
1 /*
2  * IRC - Internet Relay Chat, ircd/m_names.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_log.h"
89 #include "ircd_reply.h"
90 #include "ircd_string.h"
91 #include "msg.h"
92 #include "numeric.h"
93 #include "numnicks.h"
94 #include "s_user.h"
95 #include "send.h"
96  
97 /* #include <assert.h> -- Now using assert in ircd_log.h */
98 #include <string.h>
99
100 /*
101  *  Sends a suitably formatted 'names' reply to 'sptr' consisting of nicks within
102  *  'chptr', depending on 'filter'.
103  *
104  *  NAMES_ALL - Lists all users on channel.
105  *  NAMES_VIS - Only list visible (-i) users. --Gte (04/06/2000).
106  *  NAMES_DEL - Show join-delayed names list.
107  *  NAMES_EON - When OR'd with the other two, adds an 'End of Names' numeric
108  *              used by m_join
109  *
110  */
111
112 void do_names(struct Client* sptr, struct Channel* chptr, int filter)
113
114   int mlen;
115   int idx;
116   int flag;
117   int needs_space; 
118   int len; 
119   char buf[BUFSIZE];
120   struct Client *c2ptr;
121   struct Membership* member;
122   
123   assert(chptr);
124   assert(sptr);
125   assert((filter&NAMES_ALL) != (filter&NAMES_VIS));
126
127   /* Tag Pub/Secret channels accordingly. */
128
129   strcpy(buf, "* ");
130   if (PubChannel(chptr))
131     *buf = '=';
132   else if (SecretChannel(chptr))
133     *buf = '@';
134  
135   len = strlen(chptr->chname);
136   strcpy(buf + 2, chptr->chname);
137   strcpy(buf + 2 + len, " :");
138
139   idx = len + 4;
140   flag = 1;
141   needs_space = 0;
142
143   if (!ShowChannel(sptr, chptr)) /* Don't list private channels unless we are on them. */
144     return;
145
146   /* Iterate over all channel members, and build up the list. */
147
148   mlen = strlen(cli_name(&me)) + 10 + strlen(cli_name(sptr));
149   
150   for (member = chptr->members; member; member = member->next_member)
151   {
152     c2ptr = member->user;
153
154     if (((filter&NAMES_VIS)!=0) && IsInvisible(c2ptr))
155       continue;
156
157     if (IsZombie(member) && member->user != sptr)
158       continue;
159
160     if (IsDelayedJoin(member) && (member->user != sptr) && !(filter & NAMES_DEL))
161         continue;
162
163     if ((!IsDelayedJoin(member) || (member->user == sptr)) && (filter & NAMES_DEL))
164         continue;
165
166     if (needs_space)
167       buf[idx++] = ' ';
168     needs_space=1;
169     if (IsZombie(member))
170       buf[idx++] = '!';
171     else if (IsChanOp(member))
172       buf[idx++] = '@';
173     else if (HasVoice(member))
174       buf[idx++] = '+';
175     strcpy(buf + idx, cli_name(c2ptr));
176     idx += strlen(cli_name(c2ptr));
177     flag = 1;
178     if (mlen + idx + NICKLEN + 5 > BUFSIZE)
179       /* space, modifier, nick, \r \n \0 */
180     {
181       send_reply(sptr, (filter & NAMES_DEL) ? RPL_DELNAMREPLY : RPL_NAMREPLY, buf);
182       strcpy(buf, "* ");
183       ircd_strncpy(buf + 2, chptr->chname, len + 1);
184       buf[len + 2] = ':';
185       buf[len + 3] = '\0';
186       if (PubChannel(chptr))
187         *buf = '=';
188       else if (SecretChannel(chptr))
189         *buf = '@';
190       idx = len + 4;
191       flag = 0;
192       needs_space=0;
193     }
194   }
195   if (flag)
196     send_reply(sptr, (filter & NAMES_DEL) ? RPL_DELNAMREPLY : RPL_NAMREPLY, buf); 
197   if (filter&NAMES_EON)
198     send_reply(sptr, RPL_ENDOFNAMES, chptr->chname);
199 }
200
201 /*
202  * m_names - generic message handler
203  *
204  * parv[0] = sender prefix
205  * parv[1] = channel
206  */
207
208 int m_names(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
209 {
210   struct Channel *chptr; 
211   struct Channel *ch2ptr; 
212   struct Client *c2ptr;
213   struct Membership* member; 
214   char* s;
215   char* para = parc > 1 ? parv[1] : 0; 
216   int showingdelayed = 0;
217
218   if (parc > 1 && !ircd_strcmp(parv[1], "-D")) {
219     para = (parc > 2) ? parv[2] : 0;
220     showingdelayed = NAMES_DEL;
221     if (parc > 3 && hunt_server_cmd(sptr, CMD_NAMES, cptr, 1, "%s %s %C", 3, parc, parv))
222       return 0;
223   } else if (parc > 2 && hunt_server_cmd(sptr, CMD_NAMES, cptr, 1, "%s %C", 2, parc, parv))
224     return 0;
225
226   if (EmptyString(para)) {
227     send_reply(sptr, RPL_ENDOFNAMES, "*");
228     return 0;
229   }
230
231   do {
232     s = strchr(para, ',');
233     if (s)
234       *s++ = '\0';
235     /*
236      * Special Case 1: "/names 0". 
237      * Full list as per RFC. 
238      */
239     if ((*para == '0') || (*para == '\0'))
240     {
241       int idx; 
242       int mlen;
243       int flag;
244       struct Channel *ch3ptr;
245       char buf[BUFSIZE]; 
246
247       mlen = strlen(cli_name(&me)) + 10 + strlen(cli_name(sptr));
248
249       /* List all visible channels/visible members */ 
250
251       for (ch2ptr = GlobalChannelList; ch2ptr; ch2ptr = ch2ptr->next)
252       { 
253         if (!ShowChannel(sptr, ch2ptr))
254           continue;                 /* Don't show secret chans. */ 
255         else if (find_channel_member(sptr, ch2ptr))
256           do_names(sptr, ch2ptr, showingdelayed|NAMES_ALL); /* Full list if we're in this chan. */
257         else
258           do_names(sptr, ch2ptr, showingdelayed|NAMES_VIS);
259       } 
260
261       /* List all remaining users on channel '*' */
262
263       strcpy(buf, "* * :");
264       idx = 5;
265       flag = 0;
266
267       for (c2ptr = GlobalClientList; c2ptr; c2ptr = cli_next(c2ptr))
268       {
269         int showflag = 0;
270
271         if (!IsUser(c2ptr) || (sptr != c2ptr && IsInvisible(c2ptr)))
272           continue;
273
274         member = cli_user(c2ptr)->channel;
275
276         while (member)
277         {
278           ch3ptr = member->channel;
279   
280           if (PubChannel(ch3ptr) || find_channel_member(sptr, ch3ptr))
281             showflag = 1;
282  
283           member = member->next_channel;
284         }
285
286         if (showflag)               /* Have we already shown them? */
287           continue;
288  
289         strcpy(buf + idx, cli_name(c2ptr));
290         idx += strlen(cli_name(c2ptr));
291         buf[idx++] = ' ';
292         flag = 1;
293
294         if (mlen + idx + NICKLEN + 3 > BUFSIZE)     /* space, \r\n\0 */
295         {
296           send_reply(sptr, RPL_NAMREPLY, buf);
297           strcpy(buf, "* * :");
298           idx = 5;
299           flag = 0;
300         }
301       }
302       if (flag)
303         send_reply(sptr, RPL_NAMREPLY, buf);
304       send_reply(sptr, RPL_ENDOFNAMES, "*");
305     }
306     else if ((chptr = FindChannel(para)) != NULL)
307     {
308       member = find_member_link(chptr, sptr);
309       if (member)
310       {
311         /*
312          *  Special Case 2: User is on this channel, requesting full names list.
313          *  (As performed with each /join) - ** High frequency usage **
314          */
315         do_names(sptr, chptr, showingdelayed|NAMES_ALL|NAMES_EON);
316       }
317       else
318       {
319         /*
320          *  Special Case 3: User isn't on this channel, show all visible users, in 
321          *  non secret channels.
322          */ 
323         do_names(sptr, chptr, showingdelayed|NAMES_VIS|NAMES_EON);
324       } 
325     }
326     else
327         send_reply(sptr, RPL_ENDOFNAMES, para);
328   } while ((para = s) != NULL);
329
330   return 1;
331 }