ircd/send.c

   1 /*
   2  * IRC - Internet Relay Chat, common/send.c
   3  * Copyright (C) 1990 Jarkko Oikarinen and
   4  *                    University of Oulu, Computing Center
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 1, or (at your option)
   9  * any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19  *
  20  * $Id$
  21  */
  22 #include "config.h"
  23
  24 #include "send.h"
  25 #include "channel.h"
  26 #include "class.h"
  27 #include "client.h"
  28 #include "ircd.h"
  29 #include "ircd_snprintf.h"
  30 #include "ircd_string.h"
  31 #include "list.h"
  32 #include "match.h"
  33 #include "msg.h"
  34 #include "numnicks.h"
  35 #include "s_bsd.h"
  36 #include "s_debug.h"
  37 #include "s_misc.h"
  38 #include "s_user.h"
  39 #include "sprintf_irc.h"
  40 #include "struct.h"
  41 #include "sys.h"
  42
  43 #include <assert.h>
  44 #include <stdio.h>
  45 #include <string.h>
  46
  47
  48 static int sentalong[MAXCONNECTIONS];
  49 static int sentalong_marker;
  50 struct SLink *opsarray[32];     /* don't use highest bit unless you change
  51                                    atoi to strtoul in sendto_op_mask() */
  52 static struct Connection *send_queues = 0;
  53
  54 /*
  55  * dead_link
  56  *
  57  * An error has been detected. The link *must* be closed,
  58  * but *cannot* call ExitClient (m_bye) from here.
  59  * Instead, mark it with FLAGS_DEADSOCKET. This should
  60  * generate ExitClient from the main loop.
  61  *
  62  * If 'notice' is not NULL, it is assumed to be a format
  63  * for a message to local opers. It can contain only one
  64  * '%s', which will be replaced by the sockhost field of
  65  * the failing link.
  66  *
  67  * Also, the notice is skipped for "uninteresting" cases,
  68  * like Persons and yet unknown connections...
  69  */
  70
  71 static void dead_link(struct Client *to, char *notice)
  72 {
  73   cli_flags(to) |= FLAGS_DEADSOCKET;
  74   /*
  75    * If because of BUFFERPOOL problem then clean dbuf's now so that
  76    * notices don't hurt operators below.
  77    */
  78   DBufClear(&(cli_recvQ(to)));
  79   MsgQClear(&(cli_sendQ(to)));
  80   client_drop_sendq(cli_connect(to));
  81
  82   /*
  83    * Keep a copy of the last comment, for later use...
  84    */
  85   ircd_strncpy(cli_info(to), notice, REALLEN);
  86
  87   if (!IsUser(to) && !IsUnknown(to) && !(cli_flags(to) & FLAGS_CLOSING))
  88     sendto_opmask_butone(0, SNO_OLDSNO, "%s for %s", cli_info(to), cli_name(to));
  89   Debug((DEBUG_ERROR, cli_info(to)));
  90 }
  91
  92 static int can_send(struct Client* to)
  93 {
  94   assert(0 != to);
  95   return (IsDead(to) || IsMe(to) || -1 == cli_fd(to)) ? 0 : 1;
  96 }
  97
  98 /*
  99  * flush_connections
 100  *
 101  * Used to empty all output buffers for all connections. Should only
 102  * be called once per scan of connections. There should be a select in
 103  * here perhaps but that means either forcing a timeout or doing a poll.
 104  * When flushing, all we do is empty the obuffer array for each local
 105  * client and try to send it. if we cant send it, it goes into the sendQ
 106  * -avalon
 107  */
 108 void flush_connections(struct Client* cptr)
 109 {
 110   if (cptr) {
 111     send_queued(cptr);
 112   }
 113   else {
 114     struct Connection* con;
 115     for (con = send_queues; con; con = con_next(con)) {
 116       assert(0 < MsgQLength(&(con_sendQ(con))));
 117       send_queued(con_client(con));
 118     }
 119   }
 120 }
 121
 122 /*
 123  * send_queued
 124  *
 125  * This function is called from the main select-loop (or whatever)
 126  * when there is a chance that some output would be possible. This
 127  * attempts to empty the send queue as far as possible...
 128  */
 129 void send_queued(struct Client *to)
 130 {
 131   assert(0 != to);
 132   assert(0 != cli_local(to));
 133
 134   if (IsBlocked(to) || !can_send(to))
 135     return;                     /* Don't bother */
 136
 137   while (MsgQLength(&(cli_sendQ(to))) > 0) {
 138     unsigned int len;
 139
 140     if ((len = deliver_it(to, &(cli_sendQ(to))))) {
 141       msgq_delete(&(cli_sendQ(to)), len);
 142       cli_lastsq(to) = MsgQLength(&(cli_sendQ(to))) / 1024;
 143       if (IsBlocked(to))
 144         return;
 145     }
 146     else {
 147       if (IsDead(to)) {
 148         char tmp[512];
 149         sprintf(tmp,"Write error: %s",(strerror(cli_error(to))) ? (strerror(cli_error(to))) : "Unknown error" );
 150         dead_link(to, tmp);
 151       }
 152       return;
 153     }
 154   }
 155
 156   /* Ok, sendq is now empty... */
 157   client_drop_sendq(cli_connect(to));
 158 }
 159
 160 void send_buffer(struct Client* to, struct MsgBuf* buf, int prio)
 161 {
 162   assert(0 != to);
 163   assert(0 != buf);
 164
 165   if (cli_from(to))
 166     to = cli_from(to);
 167
 168   if (!can_send(to))
 169     /*
 170      * This socket has already been marked as dead
 171      */
 172     return;
 173
 174   if (MsgQLength(&(cli_sendQ(to))) > get_sendq(to)) {
 175     if (IsServer(to))
 176       sendto_opmask_butone(0, SNO_OLDSNO, "Max SendQ limit exceeded for %C: "
 177                            "%zu > %zu", to, MsgQLength(&(cli_sendQ(to))),
 178                            get_sendq(to));
 179     dead_link(to, "Max sendQ exceeded");
 180     return;
 181   }
 182
 183   Debug((DEBUG_SEND, "Sending [%p] to %s", buf, cli_name(to)));
 184
 185   msgq_add(&(cli_sendQ(to)), buf, prio);
 186   client_add_sendq(cli_connect(to), &send_queues);
 187
 188   /*
 189    * Update statistics. The following is slightly incorrect
 190    * because it counts messages even if queued, but bytes
 191    * only really sent. Queued bytes get updated in SendQueued.
 192    */
 193   ++(cli_sendM(to));
 194   ++(cli_sendM(&me));
 195   /*
 196    * This little bit is to stop the sendQ from growing too large when
 197    * there is no need for it to. Thus we call send_queued() every time
 198    * 2k has been added to the queue since the last non-fatal write.
 199    * Also stops us from deliberately building a large sendQ and then
 200    * trying to flood that link with data (possible during the net
 201    * relinking done by servers with a large load).
 202    */
 203   if (MsgQLength(&(cli_sendQ(to))) / 1024 > cli_lastsq(to))
 204     send_queued(to);
 205 }
 206
 207 /*
 208  * Send a msg to all ppl on servers/hosts that match a specified mask
 209  * (used for enhanced PRIVMSGs)
 210  *
 211  *  addition -- Armin, 8jun90 (gruner@informatik.tu-muenchen.de)
 212  */
 213
 214 static int match_it(struct Client *one, const char *mask, int what)
 215 {
 216   switch (what)
 217   {
 218     case MATCH_HOST:
 219       return (match(mask, cli_user(one)->host) == 0);
 220     case MATCH_SERVER:
 221     default:
 222       return (match(mask, cli_name(cli_user(one)->server)) == 0);
 223   }
 224 }
 225
 226 /*
 227  * Send a raw command to a single client; use *ONLY* if you absolutely
 228  * must send a command without a prefix.
 229  */
 230 void sendrawto_one(struct Client *to, const char *pattern, ...)
 231 {
 232   struct MsgBuf *mb;
 233   va_list vl;
 234
 235   va_start(vl, pattern);
 236   mb = msgq_vmake(to, pattern, vl);
 237   va_end(vl);
 238
 239   send_buffer(to, mb, 0);
 240
 241   msgq_clean(mb);
 242 }
 243
 244 /*
 245  * Send a (prefixed) command to a single client; select which of <cmd>
 246  * <tok> to use depending on if to is a server or not.  <from> is the
 247  * originator of the command.
 248  */
 249 void sendcmdto_one(struct Client *from, const char *cmd, const char *tok,
 250                    struct Client *to, const char *pattern, ...)
 251 {
 252   va_list vl;
 253
 254   va_start(vl, pattern);
 255   vsendcmdto_one(from, cmd, tok, to, pattern, vl);
 256   va_end(vl);
 257 }
 258
 259 void vsendcmdto_one(struct Client *from, const char *cmd, const char *tok,
 260                     struct Client *to, const char *pattern, va_list vl)
 261 {
 262   struct VarData vd;
 263   struct MsgBuf *mb;
 264
 265   to = cli_from(to);
 266
 267   vd.vd_format = pattern; /* set up the struct VarData for %v */
 268   vd.vd_args = vl;
 269
 270   mb = msgq_make(to, "%:#C %s %v", from, IsServer(to) || IsMe(to) ? tok : cmd,
 271                  &vd);
 272
 273   send_buffer(to, mb, 0);
 274
 275   msgq_clean(mb);
 276 }
 277
 278 /*
 279  * Send a (prefixed) command to all servers but one, using tok; cmd
 280  * is ignored in this particular function.
 281  */
 282 void sendcmdto_serv_butone(struct Client *from, const char *cmd,
 283                            const char *tok, struct Client *one,
 284                            const char *pattern, ...)
 285 {
 286   struct VarData vd;
 287   struct MsgBuf *mb;
 288   struct DLink *lp;
 289
 290   vd.vd_format = pattern; /* set up the struct VarData for %v */
 291   va_start(vd.vd_args, pattern);
 292
 293   /* use token */
 294   mb = msgq_make(&me, "%C %s %v", from, tok, &vd);
 295   va_end(vd.vd_args);
 296
 297   /* send it to our downlinks */
 298   for (lp = cli_serv(&me)->down; lp; lp = lp->next) {
 299     if (one && lp->value.cptr == cli_from(one))
 300       continue;
 301     send_buffer(lp->value.cptr, mb, 0);
 302   }
 303
 304   msgq_clean(mb);
 305 }
 306
 307 /*
 308  * Send a (prefix) command originating from <from> to all channels
 309  * <from> is locally on.  <from> must be a user. <tok> is ignored in
 310  * this function.
 311  */
 312 /* XXX sentalong_marker used XXX
 313  *
 314  * There is not an easy way to revoke the need for sentalong_marker
 315  * from this function.  Thoughts and ideas would be welcome... -Kev
 316  *
 317  * One possibility would be to internalize the sentalong array; that
 318  * could be prohibitively big, though.  We could get around that by
 319  * making one that's the number of connected servers or something...
 320  * or perhaps by adding a special flag to the servers we've sent a
 321  * message to, and then a final loop through the connected servers
 322  * to delete the flag. -Kev
 323  */
 324 void sendcmdto_common_channels(struct Client *from, const char *cmd,
 325                                const char *tok, const char *pattern, ...)
 326 {
 327   struct VarData vd;
 328   struct MsgBuf *mb;
 329   struct Membership *chan;
 330   struct Membership *member;
 331
 332   assert(0 != from);
 333   assert(0 != cli_from(from));
 334   assert(0 != pattern);
 335   assert(!IsServer(from) && !IsMe(from));
 336
 337   vd.vd_format = pattern; /* set up the struct VarData for %v */
 338
 339   va_start(vd.vd_args, pattern);
 340
 341   /* build the buffer */
 342   mb = msgq_make(0, "%:#C %s %v", from, cmd, &vd);
 343   va_end(vd.vd_args);
 344
 345   sentalong_marker++;
 346   if (-1 < cli_fd(cli_from(from)))
 347     sentalong[cli_fd(cli_from(from))] = sentalong_marker;
 348   /*
 349    * loop through from's channels, and the members on their channels
 350    */
 351   for (chan = cli_user(from)->channel; chan; chan = chan->next_channel)
 352     for (member = chan->channel->members; member;
 353          member = member->next_member)
 354       if (MyConnect(member->user) && -1 < cli_fd(cli_from(member->user)) &&
 355           sentalong[cli_fd(cli_from(member->user))] != sentalong_marker) {
 356         sentalong[cli_fd(cli_from(member->user))] = sentalong_marker;
 357         send_buffer(member->user, mb, 0);
 358       }
 359
 360   if (MyConnect(from))
 361     send_buffer(from, mb, 0);
 362
 363   msgq_clean(mb);
 364 }
 365
 366 /*
 367  * Send a (prefixed) command to all local users on the channel specified
 368  * by <to>; <tok> is ignored by this function
 369  */
 370 void sendcmdto_channel_butserv(struct Client *from, const char *cmd,
 371                                const char *tok, struct Channel *to,
 372                                const char *pattern, ...)
 373 {
 374   struct VarData vd;
 375   struct MsgBuf *mb;
 376   struct Membership *member;
 377
 378   vd.vd_format = pattern; /* set up the struct VarData for %v */
 379   va_start(vd.vd_args, pattern);
 380
 381   /* build the buffer */
 382   mb = msgq_make(0, "%:#C %s %v", from, cmd, &vd);
 383   va_end(vd.vd_args);
 384
 385   /* send the buffer to each local channel member */
 386   for (member = to->members; member; member = member->next_member) {
 387     if (MyConnect(member->user) && !IsZombie(member))
 388       send_buffer(member->user, mb, 0);
 389   }
 390
 391   msgq_clean(mb);
 392 }
 393
 394 /*
 395  * Send a (prefixed) command to all users on this channel, including
 396  * remote users; users to skip may be specified by setting appropriate
 397  * flags in the <skip> argument.  <one> will also be skipped.
 398  */
 399 /* XXX sentalong_marker used XXX
 400  *
 401  * We can drop sentalong_marker from this function by adding a field to
 402  * channels and to connections; what we do is make a user's connection
 403  * a "member" of the channel by adding it to the new list, and we use
 404  * the struct Membership status as a reference count.  Then, to implement
 405  * this function, we just walk the list of connections.  Unfortunately,
 406  * this doesn't account for sending only to channel ops, or for not
 407  * sending to +d users; we could account for that by splitting those
 408  * counts out, but that would imply adding two more fields (at least) to
 409  * the struct Membership... -Kev
 410  */
 411 void sendcmdto_channel_butone(struct Client *from, const char *cmd,
 412                               const char *tok, struct Channel *to,
 413                               struct Client *one, unsigned int skip,
 414                               const char *pattern, ...)
 415 {
 416   struct Membership *member;
 417   struct VarData vd;
 418   struct MsgBuf *user_mb;
 419   struct MsgBuf *serv_mb;
 420
 421   vd.vd_format = pattern;
 422
 423   /* Build buffer to send to users */
 424   va_start(vd.vd_args, pattern);
 425   user_mb = msgq_make(0, skip & SKIP_NONOPS ? "%:#C %s @%v" : "%:#C %s %v",
 426                       from, skip & SKIP_NONOPS ? MSG_NOTICE : cmd, &vd);
 427   va_end(vd.vd_args);
 428
 429   /* Build buffer to send to servers */
 430   va_start(vd.vd_args, pattern);
 431   serv_mb = msgq_make(&me, "%C %s %v", from, tok, &vd);
 432   va_end(vd.vd_args);
 433
 434   /* send buffer along! */
 435   sentalong_marker++;
 436   for (member = to->members; member; member = member->next_member) {
 437     /* skip one, zombies, and deaf users... */
 438     if (cli_from(member->user) == one || IsZombie(member) ||
 439         (skip & SKIP_DEAF && IsDeaf(member->user)) ||
 440         (skip & SKIP_NONOPS && !IsChanOp(member)) ||
 441         (skip & SKIP_BURST && IsBurstOrBurstAck(cli_from(member->user))) ||
 442         cli_fd(cli_from(member->user)) < 0 ||
 443         sentalong[cli_fd(cli_from(member->user))] == sentalong_marker)
 444       continue;
 445     sentalong[cli_fd(cli_from(member->user))] = sentalong_marker;
 446
 447     if (MyConnect(member->user)) /* pick right buffer to send */
 448       send_buffer(member->user, user_mb, 0);
 449     else
 450       send_buffer(member->user, serv_mb, 0);
 451   }
 452
 453   msgq_clean(user_mb);
 454   msgq_clean(serv_mb);
 455 }
 456
 457 /*
 458  * Send a (prefixed) command to all users except <one> that have
 459  * <flag> set.
 460  */
 461 void sendcmdto_flag_butone(struct Client *from, const char *cmd,
 462                            const char *tok, struct Client *one,
 463                            unsigned int flag, const char *pattern, ...)
 464 {
 465   struct VarData vd;
 466   struct Client *cptr;
 467   struct MsgBuf *mb;
 468   struct DLink *lp;
 469   unsigned int oper_fl = 0;
 470   int i;
 471
 472   if (flag & FLAGS_OPER) {
 473     flag &= ~FLAGS_OPER;
 474     oper_fl++;
 475   }
 476
 477   vd.vd_format = pattern;
 478
 479   /* Build buffer to send to users */
 480   va_start(vd.vd_args, pattern);
 481   mb = msgq_make(0, "%:#C " MSG_WALLOPS " %v", from, &vd);
 482   va_end(vd.vd_args);
 483
 484   /* send buffer along! */
 485   for (i = 0; i <= HighestFd; i++) {
 486     if (!(cptr = LocalClientArray[i]) || !(cli_flags(cptr) & flag) ||
 487         (oper_fl && !IsAnOper(cptr)) || cli_fd(cli_from(cptr)) < 0)
 488       continue; /* skip it */
 489     send_buffer(cptr, mb, 1);
 490   }
 491
 492   msgq_clean(mb);
 493
 494   /* Build buffer to send to servers */
 495   va_start(vd.vd_args, pattern);
 496   mb = msgq_make(&me, "%C %s %v", from, tok, &vd);
 497   va_end(vd.vd_args);
 498
 499   /* send buffer along! */
 500   for (lp = cli_serv(&me)->down; lp; lp = lp->next) {
 501     if (one && lp->value.cptr == cli_from(one))
 502       continue;
 503     send_buffer(lp->value.cptr, mb, 0);
 504   }
 505
 506   msgq_clean(mb);
 507 }
 508
 509 /*
 510  * Send a (prefixed) command to all users who match <to>, under control
 511  * of <who>
 512  */
 513 /* XXX sentalong_marker used XXX
 514  *
 515  * This is also a difficult one to solve.  The basic approach would be
 516  * to walk the client list of each connected server until we find a
 517  * match--but then, we also have to walk the client list of all the
 518  * servers behind that one.  We could implement this recursively--or we
 519  * could add (yet another) field to the connection struct that would be
 520  * a linked list of clients introduced through that link, and just walk
 521  * that, making this into an iterative implementation.  Unfortunately,
 522  * we probably would not be able to use tail recursion for the recursive
 523  * solution, so a deep network could exhaust our stack space; therefore
 524  * I favor the extra linked list, even though that increases the
 525  * complexity of the database. -Kev
 526  */
 527 void sendcmdto_match_butone(struct Client *from, const char *cmd,
 528                             const char *tok, const char *to,
 529                             struct Client *one, unsigned int who,
 530                             const char *pattern, ...)
 531 {
 532   struct VarData vd;
 533   struct Client *cptr;
 534   struct MsgBuf *user_mb;
 535   struct MsgBuf *serv_mb;
 536
 537   vd.vd_format = pattern;
 538
 539   /* Build buffer to send to users */
 540   va_start(vd.vd_args, pattern);
 541   user_mb = msgq_make(0, "%:#C %s %v", from, cmd, &vd);
 542   va_end(vd.vd_args);
 543
 544   /* Build buffer to send to servers */
 545   va_start(vd.vd_args, pattern);
 546   serv_mb = msgq_make(&me, "%C %s %v", from, tok, &vd);
 547   va_end(vd.vd_args);
 548
 549   /* send buffer along */
 550   sentalong_marker++;
 551   for (cptr = GlobalClientList; cptr; cptr = cli_next(cptr)) {
 552     if (cli_from(cptr) == one || IsServer(cptr) || IsMe(cptr) ||
 553         !match_it(cptr, to, who) || cli_fd(cli_from(cptr)) < 0 ||
 554         sentalong[cli_fd(cli_from(cptr))] == sentalong_marker)
 555       continue; /* skip it */
 556     sentalong[cli_fd(cli_from(cptr))] = sentalong_marker;
 557
 558     if (MyConnect(cptr)) /* send right buffer */
 559       send_buffer(cptr, user_mb, 0);
 560     else
 561       send_buffer(cptr, serv_mb, 0);
 562   }
 563
 564   msgq_clean(user_mb);
 565   msgq_clean(serv_mb);
 566 }
 567
 568 /*
 569  * Send a server notice to all users subscribing to the indicated <mask>
 570  * except for <one>
 571  */
 572 void sendto_opmask_butone(struct Client *one, unsigned int mask,
 573                           const char *pattern, ...)
 574 {
 575   va_list vl;
 576
 577   va_start(vl, pattern);
 578   vsendto_opmask_butone(one, mask, pattern, vl);
 579   va_end(vl);
 580 }
 581
 582 /*
 583  * Same as above, except called with a variable argument list
 584  */
 585 void vsendto_opmask_butone(struct Client *one, unsigned int mask,
 586                            const char *pattern, va_list vl)
 587 {
 588   struct VarData vd;
 589   struct MsgBuf *mb;
 590   int i = 0; /* so that 1 points to opsarray[0] */
 591   struct SLink *opslist;
 592
 593   while ((mask >>= 1))
 594     i++;
 595
 596   if (!(opslist = opsarray[i]))
 597     return;
 598
 599   /*
 600    * build string; I don't want to bother with client nicknames, so I hope
 601    * this is ok...
 602    */
 603   vd.vd_format = pattern;
 604   vd.vd_args = vl;
 605   mb = msgq_make(0, ":%s " MSG_NOTICE " * :*** Notice -- %v", cli_name(&me),
 606                  &vd);
 607
 608   for (; opslist; opslist = opslist->next)
 609     send_buffer(opslist->value.cptr, mb, 0);
 610
 611   msgq_clean(mb);
 612 }