welcome.patch

   1 Add welcome message functionality.
   2
   3 client commands:
   4 user:
   5 /WELCOME
   6 shows welcome messages set, same is shown on connect
   7
   8 oper:
   9 /WELCOME [<target>] [[!]<name> :<message>]
  10 to view welcome messages from a remote server
  11 to set a local welcome message on this server or a remote server
  12 set a global welcome message (target *)
  13 the ! prefix makes the server annouce the welcome message to its clients when setting
  14
  15 server:
  16 :<source> WE <target> [[!]<name> <timestamp> <who> :<text>]
  17 who is who set the message, the server puts in the opername when a client sets it.
  18 :<name> is a number 1 to WELCOME_MAX_ENTRIES - currently set at 10 (should be more than we ever need)
  19 that means there is room for 10 local and 10 global entries
  20
  21 STATS W/welcome (/STATS w/userload made case sensitive)
  22 :server 230 nick W Name Target Who Timestamp :Message
  23 :server 227 nick W 1 * opername 1233072583 :Latest news: testing this welcome patch :)
  24 :server 227 nick W 2 * opername 1233072583 :
  25 :server 227 nick W 1 servername opername 1233072590 :This is a test server, expect restarts.
  26 :server 219 nick W :End of /STATS report
  27
  28 listing welcomes or on connect:
  29 :server NOTICE nick :[QuakeNet] Latest news: testing this welcome patch :)
  30 :server NOTICE nick :[server] This is a test server, expect restarts.
  31
  32 announcement is done by a notice by the local server to $* with the same message
  33 format as for listing welcome messages.
  34 :server NOTICE $* :[QuakeNet] Latest news: testing this welcome patch :)
  35 :server NOTICE $* :[server] This is a test server, expect restarts.
  36
  37
  38 Files:
  39
  40 include/handlers.h
  41 add m_welcome mo_welcome ms_welcome mh_welcome functions
  42
  43 include/features.h
  44 ircd/features.c
  45 add features FEAT_WELCOME and FEAT_HIS_STATS_W
  46
  47 include/msg.h
  48 add MSG_WELCOME TOK_WELCOME CMD_WELCOME
  49
  50 ircd/parse.c
  51 add welcome message functions
  52
  53 include/numeric.h
  54 ircd/s_err.c
  55 add RPL_STATSWELCOME ERR_NOSUCHWELCOME
  56
  57 include/welcome.h
  58 ircd/welcome.c
  59 ircd/m_welcome.c
  60 new
  61
  62 ircd/Makefile.in
  63 add welcome.c and m_welcome.c files
  64
  65 ircd/s_serv.c
  66 add burst welcome message
  67
  68 ircd/s_stats.c
  69 add /STATS W/welcome
  70
  71 ircd/s_user.c
  72 add showing of welcome messages on connect
  73
  74 include/client.h
  75 ircd/client.c
  76 ircd/ircd_lexer.l
  77 ircd/ircd_parser.y
  78 add PRIV_LOCAL_WELCOME PRIV_WELCOME
  79
  80 diff -r 4676d2565f9b include/client.h
  81 --- a/include/client.h
  82 +++ b/include/client.h
  83 @@ -142,6 +142,8 @@
  84      PRIV_USER_PRIVACY,  /* oper can bypass user privacy +x etc gives i.e. see real ip's */
  85      PRIV_CHANNEL_PRIVACY, /* oper can bypass channel privacy i.e. can see modes on channels they are not on and channel keys */
  86      PRIV_SERVERINFO,     /* oper can use /get, /stats, /hash, retrieve remote information */
  87 +    PRIV_WELCOME,        /* oper can WELCOME */
  88 +    PRIV_LOCAL_WELCOME,  /* oper can local WELCOME */
  89      PRIV_LAST_PRIV /**< number of privileges */
  90    };
  91
  92 diff -r 4676d2565f9b include/handlers.h
  93 --- a/include/handlers.h
  94 +++ b/include/handlers.h
  95 @@ -138,6 +138,7 @@
  96  extern int m_version(struct Client*, struct Client*, int, char*[]);
  97  extern int m_wallchops(struct Client*, struct Client*, int, char*[]);
  98  extern int m_wallvoices(struct Client*, struct Client*, int, char*[]);
  99 +extern int m_welcome(struct Client*, struct Client*, int, char*[]);
 100  extern int m_who(struct Client*, struct Client*, int, char*[]);
 101  extern int m_whois(struct Client*, struct Client*, int, char*[]);
 102  extern int m_whowas(struct Client*, struct Client*, int, char*[]);
 103 @@ -172,6 +173,7 @@
 104  extern int mo_version(struct Client*, struct Client*, int, char*[]);
 105  extern int mo_wallops(struct Client*, struct Client*, int, char*[]);
 106  extern int mo_wallusers(struct Client*, struct Client*, int, char*[]);
 107 +extern int mo_welcome(struct Client*, struct Client*, int, char*[]);
 108  extern int mo_xquery(struct Client*, struct Client*, int, char*[]);
 109  extern int mr_error(struct Client*, struct Client*, int, char*[]);
 110  extern int mr_error(struct Client*, struct Client*, int, char*[]);
 111 @@ -230,6 +232,7 @@
 112  extern int ms_wallops(struct Client*, struct Client*, int, char*[]);
 113  extern int ms_wallusers(struct Client*, struct Client*, int, char*[]);
 114  extern int ms_wallvoices(struct Client*, struct Client*, int, char*[]);
 115 +extern int ms_welcome(struct Client*, struct Client*, int, char*[]);
 116  extern int ms_whois(struct Client*, struct Client*, int, char*[]);
 117  extern int ms_xquery(struct Client*, struct Client*, int, char*[]);
 118  extern int ms_xreply(struct Client*, struct Client*, int, char*[]);
 119 diff -r 4676d2565f9b include/ircd_features.h
 120 --- a/include/ircd_features.h
 121 +++ b/include/ircd_features.h
 122 @@ -101,6 +101,7 @@
 123    FEAT_IRCD_RES_TIMEOUT,
 124    FEAT_AUTH_TIMEOUT,
 125    FEAT_ANNOUNCE_INVITES,
 126 +  FEAT_WELCOME,
 127
 128    /* features that affect all operators */
 129    FEAT_EXTENDED_CHECKCMD,
 130 @@ -142,6 +143,7 @@
 131    FEAT_HIS_STATS_u,
 132    FEAT_HIS_STATS_U,
 133    FEAT_HIS_STATS_v,
 134 +  FEAT_HIS_STATS_W,
 135    FEAT_HIS_STATS_w,
 136    FEAT_HIS_STATS_x,
 137    FEAT_HIS_STATS_y,
 138 diff -r 4676d2565f9b include/msg.h
 139 --- a/include/msg.h
 140 +++ b/include/msg.h
 141 @@ -196,6 +196,10 @@
 142  #define TOK_NOTICE              "O"
 143  #define CMD_NOTICE             MSG_NOTICE, TOK_NOTICE
 144
 145 +#define MSG_WELCOME             "WELCOME"       /* WELC */
 146 +#define TOK_WELCOME             "WE"
 147 +#define CMD_WELCOME            MSG_WELCOME, TOK_WELCOME
 148 +
 149  #define MSG_WALLCHOPS           "WALLCHOPS"     /* WC */
 150  #define TOK_WALLCHOPS           "WC"
 151  #define CMD_WALLCHOPS          MSG_WALLCHOPS, TOK_WALLCHOPS
 152 diff -r 4676d2565f9b include/numeric.h
 153 --- a/include/numeric.h
 154 +++ b/include/numeric.h
 155 @@ -116,6 +116,7 @@
 156         RPL_STATSGLINE       227           Dalnet
 157         RPL_STATSVLINE       227           unreal */
 158  #define RPL_STATSALINE       226        /* Hybrid, Undernet */
 159 +#define RPL_STATSWELCOME     227        /* QuakeNet extension */
 160  #define RPL_STATSQLINE       228        /* Undernet extension */
 161
 162  /*      RPL_SERVICEINFO      231       unused */
 163 @@ -440,6 +441,8 @@
 164  /*      ERR_GHOSTEDCLIENT    503           efnet */
 165  /*     ERR_VWORLDWARN       503           austnet */
 166
 167 +#define ERR_NOSUCHWELCOME    509        /* QuakeNet extension */
 168 +
 169  #define ERR_SILELISTFULL     511        /* Undernet extension */
 170  /*      ERR_NOTIFYFULL       512           aircd */
 171  /*     ERR_TOOMANYWATCH     512           Numeric List: Dalnet */
 172 diff -r 4676d2565f9b include/welcome.h
 173 --- /dev/null
 174 +++ b/include/welcome.h
 175 @@ -0,0 +1,63 @@
 176 +#ifndef INCLUDED_welcome_h
 177 +#define INCLUDED_welcome_h
 178 +/*
 179 + * IRC - Internet Relay Chat, include/welcome.h
 180 + * Copyright (C) 1990 Jarkko Oikarinen and
 181 + *                    University of Oulu, Computing Center
 182 + * Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
 183 + *
 184 + * This program is free software; you can redistribute it and/or modify
 185 + * it under the terms of the GNU General Public License as published by
 186 + * the Free Software Foundation; either version 2, or (at your option)
 187 + * any later version.
 188 + *
 189 + * This program is distributed in the hope that it will be useful,
 190 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
 191 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 192 + * GNU General Public License for more details.
 193 + *
 194 + * You should have received a copy of the GNU General Public License
 195 + * along with this program; if not, write to the Free Software
 196 + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 197 + */
 198 +/** @file
 199 + * @brief  Interface and declarations for welcome message handling.
 200 + */
 201 +#ifndef INCLUDED_sys_types_h
 202 +#include <sys/types.h>
 203 +#define INCLUDED_sys_types_h
 204 +#endif
 205 +
 206 +struct Client;
 207 +struct StatDesc;
 208 +
 209 +/* Maximum number of welcome entries (per type; X global, X local) */
 210 +#define WELCOME_MAX_ENTRIES  10
 211 +/* Maximum length of a welcome message */
 212 +#define WELCOMELEN TOPICLEN
 213 +/* Maximum timestamp drift in seconds allowed ahead of our idea of nettime
 214 + * before we throw a warning to ops
 215 + */
 216 +#define WELCOME_MAX_DRIFT   600
 217 +
 218 +/* Describes a Welcome message entry. */
 219 +struct Welcome {
 220 +  time_t             timestamp;            /**< Timestamp of the welcome */
 221 +  char               text[WELCOMELEN + 1]; /**< Message */
 222 +  char               who[ACCOUNTLEN + 1];  /**< Who set it */
 223 +};
 224 +
 225 +/** Welcome type flags */
 226 +#define WELCOME_LOCAL    0x01 /**< welcome is local */
 227 +/** Welcome action flags */
 228 +#define WELCOME_ANNOUNCE 0x02 /**< announce change to users */
 229 +#define WELCOME_INSERT   0x04 /**< insert welcome message, move down all others one place */
 230 +
 231 +extern int welcome_do(struct Client *cptr, struct Client *sptr, char *name, char *text,
 232 +  char *who, time_t timestamp, unsigned int flags, int insert);
 233 +extern void welcome_announce(int name);
 234 +extern void welcome_burst(struct Client *cptr);
 235 +extern int welcome_list(struct Client *sptr, int connect);
 236 +extern void welcome_stats(struct Client *sptr, const struct StatDesc *sd, char *param);
 237 +
 238 +#endif /* INCLUDED_welcome_h */
 239 diff -r 4676d2565f9b ircd/Makefile.in
 240 --- a/ircd/Makefile.in
 241 +++ b/ircd/Makefile.in
 242 @@ -186,6 +186,7 @@
 243         m_wallops.c \
 244         m_wallusers.c \
 245         m_wallvoices.c \
 246 +       m_welcome.c \
 247         m_who.c \
 248         m_whois.c \
 249         m_whowas.c \
 250 @@ -215,6 +216,7 @@
 251         send.c \
 252         uping.c \
 253         userload.c \
 254 +       welcome.c \
 255         whocmds.c \
 256         whowas.c \
 257         y.tab.c
 258 @@ -1161,6 +1163,11 @@
 259    ../include/ircd_reply.h ../include/ircd_string.h \
 260    ../include/ircd_chattr.h ../include/msg.h ../include/numeric.h \
 261    ../include/numnicks.h ../include/s_user.h ../include/send.h
 262 +m_welcome.o: m_welcome.c ../config.h ../include/channel.h \
 263 +  ../include/client.h ../include/hash.h ../include/ircd.h ../include/ircd_log.h \
 264 +  ../include/ircd_reply.h ../include/ircd_string.h ../include/msg.h \
 265 +  ../include/numeric.h ../include/numnicks.h ../include/s_user.h \
 266 +  ../include/send.h ../include/welcome.h
 267  m_who.o: m_who.c ../config.h ../include/channel.h ../include/ircd_defs.h \
 268    ../include/res.h ../config.h ../include/client.h ../include/dbuf.h \
 269    ../include/msgq.h ../include/ircd_events.h ../include/ircd_handler.h \
 270 @@ -1422,6 +1429,13 @@
 271    ../include/numnicks.h ../include/querycmds.h ../include/ircd_features.h \
 272    ../include/s_misc.h ../include/s_stats.h ../include/send.h \
 273    ../include/struct.h ../include/sys.h
 274 +welcome.o: welcome.c ../config.h ../include/client.h \
 275 +  ../include/hash.h ../include/ircd.h ../include/ircd_alloc.h \
 276 +  ../include/ircd_features.h ../include/ircd_log.h ../include/ircd_reply.h \
 277 +  ../include/match.h ../include/msg.h ../include/numeric.h \
 278 +  ../include/numnicks.h ../include/s_debug.h ../include/s_bsd.h \
 279 +  ../include/s_misc.h ../include/send.h ../include/struct.h \
 280 +  ../include/sys.h ../include/welcome.h
 281  whocmds.o: whocmds.c ../config.h ../include/whocmds.h \
 282    ../include/channel.h ../include/ircd_defs.h ../include/res.h \
 283    ../config.h ../include/client.h ../include/dbuf.h ../include/msgq.h \
 284 diff -r 4676d2565f9b ircd/client.c
 285 --- a/ircd/client.c
 286 +++ b/ircd/client.c
 287 @@ -177,6 +177,7 @@
 288      FlagSet(&privs_local, PRIV_WHOX);
 289      FlagSet(&privs_local, PRIV_DISPLAY);
 290      FlagSet(&privs_local, PRIV_FORCE_LOCAL_OPMODE);
 291 +    FlagSet(&privs_local, PRIV_LOCAL_WELCOME);
 292
 293      privs_defaults_set = 1;
 294    }
 295 @@ -223,6 +224,7 @@
 296      ClrPriv(client, PRIV_JUPE);
 297      ClrPriv(client, PRIV_OPMODE);
 298      ClrPriv(client, PRIV_BADCHAN);
 299 +    ClrPriv(client, PRIV_WELCOME);
 300    }
 301  }
 302
 303 @@ -244,7 +246,7 @@
 304    P(CHANSERV),       P(XTRA_OPER),      P(NOIDLE),        P(FREEFORM),
 305    P(PARANOID),       P(CHECK),          P(WALL),          P(CLOSE),
 306    P(ROUTE),          P(ROUTEINFO),      P(SERVERINFO),    P(CHANNEL_PRIVACY),
 307 -  P(USER_PRIVACY),
 308 +  P(USER_PRIVACY),   P(WELCOME),        P(LOCAL_WELCOME),
 309  #undef P
 310    { 0, 0 }
 311  };
 312 diff -r 4676d2565f9b ircd/ircd_features.c
 313 --- a/ircd/ircd_features.c
 314 +++ b/ircd/ircd_features.c
 315 @@ -366,6 +366,7 @@
 316    F_I(IRCD_RES_TIMEOUT, 0, 4, 0),
 317    F_I(AUTH_TIMEOUT, 0, 9, 0),
 318    F_B(ANNOUNCE_INVITES, 0, 0, 0),
 319 +  F_B(WELCOME, 0, 1, 0),
 320
 321    /* features that affect all operators */
 322    F_B(EXTENDED_CHECKCMD, 0, 0, 0),
 323 @@ -407,6 +408,7 @@
 324    F_B(HIS_STATS_u, 0, 1, 0),
 325    F_B(HIS_STATS_U, 0, 1, 0),
 326    F_B(HIS_STATS_v, 0, 1, 0),
 327 +  F_B(HIS_STATS_W, 0, 1, 0),
 328    F_B(HIS_STATS_w, 0, 1, 0),
 329    F_B(HIS_STATS_x, 0, 1, 0),
 330    F_B(HIS_STATS_y, 0, 1, 0),
 331 diff -r 4676d2565f9b ircd/ircd_lexer.l
 332 --- a/ircd/ircd_lexer.l
 333 +++ b/ircd/ircd_lexer.l
 334 @@ -166,6 +166,8 @@
 335    { "serverinfo", TPRIV_SERVERINFO },
 336    { "user_privacy", TPRIV_USER_PRIVACY },
 337    { "channel_privacy", TPRIV_CHANNEL_PRIVACY },
 338 +  { "local_welcome", TPRIV_LOCAL_WELCOME },
 339 +  { "welcome", TPRIV_WELCOME },
 340    { NULL, 0 }
 341  };
 342  static int ntokens;
 343 diff -r 4676d2565f9b ircd/ircd_parser.y
 344 --- a/ircd/ircd_parser.y
 345 +++ b/ircd/ircd_parser.y
 346 @@ -189,6 +189,7 @@
 347  %token TPRIV_CHANSERV TPRIV_XTRA_OPER TPRIV_NOIDLE TPRIV_FREEFORM TPRIV_PARANOID
 348  %token TPRIV_CHECK TPRIV_WALL TPRIV_CLOSE TPRIV_ROUTE TPRIV_ROUTEINFO TPRIV_SERVERINFO
 349  %token TPRIV_CHANNEL_PRIVACY TPRIV_USER_PRIVACY TPRIV_LIST_CHAN
 350 +%token TPRIV_LOCAL_WELCOME TPRIV_WELCOME
 351  /* and some types... */
 352  %type <num> sizespec
 353  %type <num> timespec timefactor factoredtimes factoredtime
 354 @@ -703,6 +704,8 @@
 355            TPRIV_SERVERINFO { $$ = PRIV_SERVERINFO ; } |
 356            TPRIV_CHANNEL_PRIVACY { $$ = PRIV_CHANNEL_PRIVACY ; } |
 357            TPRIV_USER_PRIVACY { $$ = PRIV_USER_PRIVACY ; } |
 358 +          TPRIV_LOCAL_WELCOME { $$ = PRIV_LOCAL_WELCOME; } |
 359 +          TPRIV_WELCOME { $$ = PRIV_WELCOME; } |
 360            TPRIV_PARANOID { $$ = PRIV_PARANOID; } ;
 361  yesorno: YES { $$ = 1; } | NO { $$ = 0; };
 362
 363 diff -r 4676d2565f9b ircd/m_welcome.c
 364 --- /dev/null
 365 +++ b/ircd/m_welcome.c
 366 @@ -0,0 +1,296 @@
 367 +/*
 368 + * IRC - Internet Relay Chat, ircd/m_welcome.c
 369 + * Copyright (C) 1990 Jarkko Oikarinen and
 370 + *                    University of Oulu, Computing Center
 371 + *
 372 + * See file AUTHORS in IRC package for additional names of
 373 + * the programmers.
 374 + *
 375 + * This program is free software; you can redistribute it and/or modify
 376 + * it under the terms of the GNU General Public License as published by
 377 + * the Free Software Foundation; either version 1, or (at your option)
 378 + * any later version.
 379 + *
 380 + * This program is distributed in the hope that it will be useful,
 381 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
 382 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 383 + * GNU General Public License for more details.
 384 + *
 385 + * You should have received a copy of the GNU General Public License
 386 + * along with this program; if not, write to the Free Software
 387 + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 388 + *
 389 + */
 390 +
 391 +/*
 392 + * m_functions execute protocol messages on this server:
 393 + *
 394 + *    cptr    is always NON-NULL, pointing to a *LOCAL* client
 395 + *            structure (with an open socket connected!). This
 396 + *            identifies the physical socket where the message
 397 + *            originated (or which caused the m_function to be
 398 + *            executed--some m_functions may call others...).
 399 + *
 400 + *    sptr    is the source of the message, defined by the
 401 + *            prefix part of the message if present. If not
 402 + *            or prefix not found, then sptr==cptr.
 403 + *
 404 + *            (!IsServer(cptr)) => (cptr == sptr), because
 405 + *            prefixes are taken *only* from servers...
 406 + *
 407 + *            (IsServer(cptr))
 408 + *                    (sptr == cptr) => the message didn't
 409 + *                    have the prefix.
 410 + *
 411 + *                    (sptr != cptr && IsServer(sptr) means
 412 + *                    the prefix specified servername. (?)
 413 + *
 414 + *                    (sptr != cptr && !IsServer(sptr) means
 415 + *                    that message originated from a remote
 416 + *                    user (not local).
 417 + *
 418 + *            combining
 419 + *
 420 + *            (!IsServer(sptr)) means that, sptr can safely
 421 + *            taken as defining the target structure of the
 422 + *            message in this server.
 423 + *
 424 + *    *Always* true (if 'parse' and others are working correct):
 425 + *
 426 + *    1)      sptr->from == cptr  (note: cptr->from == cptr)
 427 + *
 428 + *    2)      MyConnect(sptr) <=> sptr == cptr (e.g. sptr
 429 + *            *cannot* be a local connection, unless it's
 430 + *            actually cptr!). [MyConnect(x) should probably
 431 + *            be defined as (x == x->from) --msa ]
 432 + *
 433 + *    parc    number of variable parameter strings (if zero,
 434 + *            parv is allowed to be NULL)
 435 + *
 436 + *    parv    a NULL terminated list of parameter pointers,
 437 + *
 438 + *                    parv[0], sender (prefix string), if not present
 439 + *                            this points to an empty string.
 440 + *                    parv[1]...parv[parc-1]
 441 + *                            pointers to additional parameters
 442 + *                    parv[parc] == NULL, *always*
 443 + *
 444 + *            note:   it is guaranteed that parv[0]..parv[parc-1] are all
 445 + *                    non-NULL pointers.
 446 + */
 447 +#include "config.h"
 448 +
 449 +#include "channel.h"
 450 +#include "client.h"
 451 +#include "hash.h"
 452 +#include "ircd.h"
 453 +#include "ircd_features.h"
 454 +#include "ircd_log.h"
 455 +#include "ircd_reply.h"
 456 +#include "ircd_snprintf.h"
 457 +#include "ircd_string.h"
 458 +#include "msg.h"
 459 +#include "numeric.h"
 460 +#include "numnicks.h"
 461 +#include "s_user.h"
 462 +#include "send.h"
 463 +#include "welcome.h"
 464 +
 465 +/* #include <assert.h> -- Now using assert in ircd_log.h */
 466 +
 467 +/*
 468 + * m_welcome - local generic message handler
 469 + *
 470 + * parv[0] = Send prefix
 471 + * parv[1] = [remote server to query]
 472 + */
 473 +int m_welcome(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 474 +{
 475 +  /* feature disabled */
 476 +  if (!feature_bool(FEAT_WELCOME))
 477 +    return send_reply(sptr, ERR_DISABLED, "WELCOME");
 478 +
 479 +  /* only opers can set the welcome messages */
 480 +  if (parc > 2)
 481 +    return send_reply(sptr, ERR_NOPRIVILEGES);
 482 +
 483 +  /* remote listing request, see if it is for me or a remote server
 484 +   *  check FEAT_HIS_REMOTE to decide if an ordinary user can do this
 485 +   */
 486 +  if ((parc > 1) && (hunt_server_cmd(sptr, CMD_WELCOME, cptr, feature_int(FEAT_HIS_REMOTE),
 487 +        "%C", 1, parc, parv) != HUNTED_ISME))
 488 +    return 0;
 489 +
 490 +  /* local listing */
 491 +  return welcome_list(sptr, 0);
 492 +}
 493 +
 494 +
 495 +/*
 496 + * mo_welcome - oper message handler
 497 + *
 498 + * listing:
 499 + * parv[0] = Send prefix
 500 + *
 501 + * remote listing:
 502 + * parv[0] = Send prefix
 503 + * parv[1] = Target
 504 + *
 505 + * set global or on remote server:
 506 + * parv[0] = Send prefix
 507 + * parv[1] = Target: server or * for global (or left out for this server)
 508 + * parv[2] = Name
 509 + * parv[3] = Text
 510 + */
 511 +int mo_welcome(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 512 +{
 513 +  char *target, *name, *who, *text, pattern[BUFSIZE];
 514 +  time_t timestamp;
 515 +  unsigned int flags = 0;
 516 +  int local = 0;
 517 +
 518 +  /* feature disabled */
 519 +  if (!feature_bool(FEAT_WELCOME))
 520 +    return send_reply(sptr, ERR_DISABLED, "WELCOME");
 521 +
 522 +  /* TODO: move feature check here? */
 523 +  /* remote listing request, see if it is for me or a remote server */
 524 +  if ((parc == 2) && (hunt_server_cmd(sptr, CMD_WELCOME, cptr, 0, "%C", 1, parc, parv) != HUNTED_ISME))
 525 +    return 0;
 526 +
 527 +  /* local listing */
 528 +  if (parc <= 2)
 529 +    return welcome_list(sptr, 0);
 530 +
 531 +  /* check PRIVS */
 532 +  /* local - need PRIV LOCAL_WELCOME or WELCOME */
 533 +  if (parc == 3 && !HasPriv(sptr,PRIV_LOCAL_WELCOME) && !HasPriv(sptr,PRIV_WELCOME))
 534 +    return send_reply(sptr, ERR_NOPRIVILEGES);
 535 +
 536 +  /* global or remote - need PRIV WELCOME */
 537 +  if (parc >= 4 && !HasPriv(sptr,PRIV_WELCOME))
 538 +    return send_reply(sptr, ERR_NOPRIVILEGES);
 539 +
 540 +  /* set the parameters */
 541 +
 542 +  /* target not given, only name - setting local welcome */
 543 +  if (parc < 4) {
 544 +    local++;
 545 +    target = cli_name(&me);
 546 +    name = parv[1];
 547 +    flags |= WELCOME_LOCAL;
 548 +
 549 +  /* target and name given */
 550 +  } else {
 551 +    target = parv[1];
 552 +    name = parv[2];
 553 +  }
 554 +  timestamp = TStime();
 555 +  who = cli_user(sptr)->opername;
 556 +  text = parv[parc - 1];
 557 +
 558 +  /* target is not global */
 559 +  if (!(target[0] == '*' && target[1] == '\0') && !local) {
 560 +
 561 +    /* build a pattern for hunt_server_cmd since we do not have all we need in parv */
 562 +    ircd_snprintf(0, pattern, sizeof(pattern), "%s %s %Tu %s :%s", "%C", name, timestamp, who, text);
 563 +    if (hunt_server_cmd(sptr, CMD_WELCOME, cptr, 0, pattern, 1, 2, parv) != HUNTED_ISME)
 564 +      return 0;
 565 +
 566 +   /* else it is a local welcome, for me */
 567 +    flags |= WELCOME_LOCAL;
 568 +  }
 569 +
 570 +  /* TODO: disallow global announcement from oper?
 571 +   * as PRIVMSG/NOTICE to $* is not allowed either by the ircd
 572 +   * when PRIV for that is added, use that here? PRIV_BROADCAST or something
 573 +   *
 574 +   * change prefix to $ ?
 575 +   */
 576 +  /* check for anounce prefix */
 577 +  if (*name == '!') {
 578 +     name++;
 579 +     flags |= WELCOME_ANNOUNCE;
 580 +  }
 581 +
 582 +  /* check for insert prefix */
 583 +  if (*name == '+') {
 584 +     name++;
 585 +     flags |= WELCOME_INSERT;
 586 +  }
 587 +
 588 +  /* and do it */
 589 +  return welcome_do(cptr, sptr, name, text, who, timestamp, flags, 0);
 590 +}
 591 +
 592 +
 593 +/*
 594 + * ms_welcome - server message handler
 595 + *
 596 + * parv[0] = Send prefix
 597 + * parv[1] = Target: server numeric or * for global
 598 + * parv[2] = Name
 599 + * parv[3] = Timestamp
 600 + * parv[4] = Who
 601 + * parv[5] = Text
 602 + */
 603 +int ms_welcome(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 604 +{
 605 +  char *target, *name, *who, *text;
 606 +  time_t timestamp;
 607 +  unsigned int flags = 0;
 608 +
 609 +  /* not enough - complain */
 610 +  if (parc < 2) {
 611 +    protocol_violation(sptr, "Too few parameters for WELCOME (got %d - need 2)", parc);
 612 +    return need_more_params(sptr, "WELCOME");
 613 +  }
 614 +
 615 +  /* remote listing request, see if it is for me or a remote server */
 616 +  if (parc == 2) {
 617 +    if (IsServer(sptr))
 618 +      return protocol_violation(cptr, "WELCOME listing request from server %C", sptr);
 619 +    if (hunt_server_cmd(sptr, CMD_WELCOME, cptr, 0, "%C", 1, parc, parv) != HUNTED_ISME)
 620 +      return 0;
 621 +    return welcome_list(sptr, 0);
 622 +  }
 623 +
 624 +  /* we need at least 6 parameters to continue - complain */
 625 +  if (parc < 6) {
 626 +    protocol_violation(sptr, "Too few parameters for WELCOME (got %d - need 6)", parc);
 627 +    return need_more_params(sptr, "WELCOME");
 628 +  }
 629 +
 630 +  /* set the parameters */
 631 +  target = parv[1];
 632 +  name = parv[2];
 633 +  timestamp = atoi(parv[3]);
 634 +  who = parv[4];
 635 +  text = parv[parc - 1]; /* parse reason as last parameter */
 636 +
 637 +  /* target is not global */
 638 +  if (!(target[0] == '*' && target[1] == '\0')) {
 639 +
 640 +    /* not for me, and forward it */
 641 +    if (hunt_server_cmd(sptr, CMD_WELCOME, cptr, 0, "%C %s %s %s :%s", 1, parc, parv) != HUNTED_ISME)
 642 +      return 0;
 643 +
 644 +    /* local welcome for me */
 645 +    flags |= WELCOME_LOCAL;
 646 +  }
 647 +
 648 +  /* check for anounce prefix */
 649 +  if (*name == '!') {
 650 +     name++;
 651 +     flags |= WELCOME_ANNOUNCE;
 652 +  }
 653 +
 654 +  /* check for insert prefix */
 655 +  if (*name == '+') {
 656 +     name++;
 657 +     flags |= WELCOME_INSERT;
 658 +  }
 659 +
 660 +  /* and do it */
 661 +  return welcome_do(cptr, sptr, name, text, who, timestamp, flags, 0);
 662 +}
 663 diff -r 4676d2565f9b ircd/parse.c
 664 --- a/ircd/parse.c
 665 +++ b/ircd/parse.c
 666 @@ -661,6 +661,15 @@
 667      /* UNREG, CLIENT, SERVER, OPER, SERVICE */
 668      { m_unregistered, m_not_oper, ms_check, mo_check, m_ignore }
 669    },
 670 +
 671 +  /* add command for WELCOME */
 672 +  {
 673 +    MSG_WELCOME,
 674 +    TOK_WELCOME,
 675 +    0, MAXPARA, MFLG_SLOW, 0, NULL,
 676 +    /* UNREG, CLIENT, SERVER, OPER, SERVICE, HELP */
 677 +    { m_unregistered, m_welcome, ms_welcome, mo_welcome, m_ignore }
 678 +  },
 679
 680    /* This command is an alias for QUIT during the unregistered part of
 681     * of the server.  This is because someone jumping via a broken web
 682 diff -r 4676d2565f9b ircd/s_err.c
 683 --- a/ircd/s_err.c
 684 +++ b/ircd/s_err.c
 685 @@ -486,7 +486,7 @@
 686  /* 226 */
 687    { RPL_STATSALINE, "%s", "226" },
 688  /* 227 */
 689 -  { 0 },
 690 +  { RPL_STATSWELCOME, "W %d %s %s %Tu :%s", "227" },
 691  /* 228 */
 692    { RPL_STATSQLINE, "Q %s :%s", "228" },
 693  /* 229 */
 694 @@ -1050,7 +1050,7 @@
 695  /* 508 */
 696    { 0 },
 697  /* 509 */
 698 -  { 0 },
 699 +  { ERR_NOSUCHWELCOME, "%s :No such welcome", "509" },
 700  /* 510 */
 701    { 0 },
 702  /* 511 */
 703 diff -r 4676d2565f9b ircd/s_serv.c
 704 --- a/ircd/s_serv.c
 705 +++ b/ircd/s_serv.c
 706 @@ -57,6 +57,7 @@
 707  #include "struct.h"
 708  #include "sys.h"
 709  #include "userload.h"
 710 +#include "welcome.h"
 711
 712  /* #include <assert.h> -- Now using assert in ircd_log.h */
 713  #include <stdlib.h>
 714 @@ -196,6 +197,7 @@
 715     */
 716    gline_burst(cptr);
 717    jupe_burst(cptr);
 718 +  welcome_burst(cptr);
 719
 720    /*
 721     * Pass on my client information to the new server
 722 diff -r 4676d2565f9b ircd/s_stats.c
 723 --- a/ircd/s_stats.c
 724 +++ b/ircd/s_stats.c
 725 @@ -54,6 +54,7 @@
 726  #include "send.h"
 727  #include "struct.h"
 728  #include "userload.h"
 729 +#include "welcome.h"
 730
 731  #include <stdio.h>
 732  #include <stdlib.h>
 733 @@ -654,9 +655,12 @@
 734    { 'V', "vserversmach", (STAT_FLAG_OPERFEAT | STAT_FLAG_VARPARAM | STAT_FLAG_CASESENS), FEAT_HIS_STATS_v,
 735      stats_servers_verbose, 0,
 736      "Verbose server information." },
 737 -  { 'w', "userload", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_w,
 738 +  { 'w', "userload", STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS, FEAT_HIS_STATS_w,
 739      calc_load, 0,
 740      "Userload statistics." },
 741 +  { 'W', "welcome", STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS, FEAT_HIS_STATS_W,
 742 +    welcome_stats, 0,
 743 +    "Welcome messages." },
 744    { 'x', "memusage", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_x,
 745      stats_meminfo, 0,
 746      "List usage information." },
 747 diff -r 4676d2565f9b ircd/s_user.c
 748 --- a/ircd/s_user.c
 749 +++ b/ircd/s_user.c
 750 @@ -63,6 +63,7 @@
 751  #include "userload.h"
 752  #include "version.h"
 753  #include "whowas.h"
 754 +#include "welcome.h"
 755
 756  #include "handlers.h" /* m_motd and m_lusers */
 757
 758 @@ -410,6 +411,9 @@
 759                             cli_info(sptr), NumNick(cptr) /* two %s's */);
 760
 761      IPcheck_connect_succeeded(sptr);
 762 +
 763 +    if (feature_bool(FEAT_WELCOME))
 764 +      welcome_list(sptr, 1);
 765    }
 766    else {
 767      struct Client *acptr = user->server;
 768 diff -r 4676d2565f9b ircd/welcome.c
 769 --- /dev/null
 770 +++ b/ircd/welcome.c
 771 @@ -0,0 +1,480 @@
 772 +/*
 773 + * IRC - Internet Relay Chat, ircd/welcome.c
 774 + * Copyright (C) 1990 Jarkko Oikarinen and
 775 + *                    University of Oulu, Finland
 776 + * Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
 777 + *
 778 + * This program is free software; you can redistribute it and/or modify
 779 + * it under the terms of the GNU General Public License as published by
 780 + * the Free Software Foundation; either version 1, or (at your option)
 781 + * any later version.
 782 + *
 783 + * This program is distributed in the hope that it will be useful,
 784 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
 785 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 786 + * GNU General Public License for more details.
 787 + *
 788 + * You should have received a copy of the GNU General Public License
 789 + * along with this program; if not, write to the Free Software
 790 + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 791 + */
 792 +/** @file
 793 + * @brief Implementation of welcome message handling functions.
 794 + */
 795 +#include "config.h"
 796 +
 797 +#include "client.h"
 798 +#include "hash.h"
 799 +#include "ircd.h"
 800 +#include "ircd_alloc.h"
 801 +#include "ircd_features.h"
 802 +#include "ircd_log.h"
 803 +#include "ircd_reply.h"
 804 +#include "ircd_string.h"
 805 +#include "match.h"
 806 +#include "msg.h"
 807 +#include "numeric.h"
 808 +#include "numnicks.h"
 809 +#include "s_bsd.h"
 810 +#include "s_debug.h"
 811 +#include "s_misc.h"
 812 +#include "send.h"
 813 +#include "struct.h"
 814 +#include "sys.h"    /* FALSE bleah */
 815 +#include "welcome.h"
 816 +
 817 +/* #include <assert.h> -- Now using assert in ircd_log.h */
 818 +#include <string.h>
 819 +
 820 +
 821 +/** List of welcome messages - first MAX for global, second MAX for local */
 822 +static struct Welcome WelcomeArray[WELCOME_MAX_ENTRIES * 2] = { { 0 } };
 823 +
 824 +
 825 +/** Allocate a new welcome with the given parameters.
 826 + * @param[in] name Name of the welcome message.
 827 + * @param[in] text The welcome message.
 828 + * @param[in] who Who set it.
 829 + * @param[in] timestamp When it was set.
 830 + * @return name Array number of the welcome set.
 831 + */
 832 +static int
 833 +welcome_make(int name, char *text, char *who, time_t timestamp)
 834 +{
 835 +  /* range 0 to 2 * max - 1 */
 836 +  assert(name >= 0 && name <= 2 * WELCOME_MAX_ENTRIES - 1);
 837 +
 838 +  /* store it */
 839 +  ircd_strncpy(WelcomeArray[name].text, text, WELCOMELEN);
 840 +  ircd_strncpy(WelcomeArray[name].who, who, ACCOUNTLEN);
 841 +  WelcomeArray[name].timestamp = timestamp;
 842 +
 843 +  return name;
 844 +}
 845 +
 846 +
 847 +/** Change a welcome message.
 848 + * @param[in] cptr Local client that sent us the welcome.
 849 + * @param[in] sptr Originator of the welcome.
 850 + * @param[in] name Name of the message.
 851 + * @param[in] text The welcome message.
 852 + * @param[in] who Who set this message.
 853 + * @param[in] timestamp Timestamp of when the message was set.
 854 + * @param[in] flags Flags to set on welcome.
 855 + * @param[in] insert Non-zero do not propagate change (welcome_insert)
 856 + * @return Zero
 857 + */
 858 +int
 859 +welcome_do(struct Client *cptr, struct Client *sptr, char *name, char *text,
 860 +  char *who, time_t timestamp, unsigned int flags, int insert)
 861 +{
 862 +  int nameint = atoi(name);                /* transform to int */
 863 +  int namearray = nameint - 1;             /* used to test the array element */
 864 +  char oldtext[WELCOMELEN + 1];            /* save old text when unsetting */
 865 +  char msg[BUFSIZE];                       /* msg for snomask, logging, etc. */
 866 +  static time_t rate;                      /* rate limit snomask message */
 867 +
 868 +  assert(NULL != cptr);
 869 +  assert(NULL != sptr);
 870 +  assert(NULL != name);
 871 +  assert(NULL != text);
 872 +  assert(NULL != who);
 873 +
 874 +  /* debug */
 875 +  Debug((DEBUG_DEBUG, "welcome_do(\"%s\", \"%s\", \"%s\", \"%s\" \"%s\", %Tu, 0x%04x, %d)",
 876 +   cli_name(cptr), cli_name(sptr), name, text, who, timestamp, flags, insert));
 877 +
 878 +  /* name empty after taking off the prefixes? */
 879 +  if (EmptyString(name)) {
 880 +    if (IsUser(sptr))
 881 +      sendcmdto_one(&me, CMD_NOTICE, sptr, "%C :WELCOME: No message number given", sptr);
 882 +    else
 883 +      protocol_violation(cptr, "WELCOME: No message number given by %C", sptr);
 884 +    return 0;
 885 +  }
 886 +
 887 +  /* check name */
 888 +  if (nameint < 1 || nameint > WELCOME_MAX_ENTRIES) {
 889 +    if (IsUser(sptr))
 890 +      sendcmdto_one(&me, CMD_NOTICE, sptr,
 891 +        "%C :WELCOME: Invalid message number %s - should between 1 and %d",
 892 +        sptr, name, WELCOME_MAX_ENTRIES);
 893 +    else {
 894 +      protocol_violation(cptr, "WELCOME: Invalid message number %s from %C - should be between 1 and %d",
 895 +        name, sptr, WELCOME_MAX_ENTRIES);
 896 +      /* nameint greater than MAX, perhaps we are upgrading, but used extra slots too soon?
 897 +       *   propagate it manually
 898 +       * TODO: cant do announce here?
 899 +       */
 900 +      if (nameint > WELCOME_MAX_ENTRIES && !(flags & WELCOME_LOCAL) && !insert)
 901 +        sendcmdto_serv_butone(sptr, CMD_WELCOME, cptr, "* %s%s%d %Tu %s :%s",
 902 +          (flags & WELCOME_ANNOUNCE) ? "!" : "", (flags & WELCOME_INSERT) ? "+" : "",
 903 +          nameint, timestamp, who, text);
 904 +    }
 905 +    return 0;
 906 +  }
 907 +
 908 +  /* correct namearray for local offset */
 909 +  if (flags & WELCOME_LOCAL)
 910 +    namearray += WELCOME_MAX_ENTRIES;
 911 +
 912 +  /* cannot unset welcome that is not set */
 913 +  if (WelcomeArray[namearray].timestamp == 0 && EmptyString(text)) {
 914 +
 915 +    /* from user, throw error */
 916 +    if (IsUser(sptr))
 917 +      return send_reply(sptr, ERR_NOSUCHWELCOME, name);
 918 +
 919 +     /* new local welcome from server, but empty - ignore
 920 +      * we do accept a new global welcome message that is empty
 921 +      */
 922 +    if (flags & WELCOME_LOCAL)
 923 +      return 0;
 924 +  }
 925 +
 926 +  /* check if there is something to change */
 927 +  /* we got a record for it */
 928 +  if (WelcomeArray[namearray].timestamp != 0) {
 929 +
 930 +    /* global */
 931 +    if (!(flags & WELCOME_LOCAL)) {
 932 +
 933 +      /* netburst and we got the same or a newer one
 934 +       *
 935 +       *   we only use the timestamp for resolving conflicts in net burst
 936 +       *   outside of netburst, we simply parse whatever we get
 937 +       *   this way we will not get stuck with a welcome message set by a server
 938 +       *   running ahead with the time
 939 +       */
 940 +      if (IsBurstOrBurstAck(cptr) && timestamp <= WelcomeArray[namearray].timestamp)
 941 +        return 0;
 942 +
 943 +    /* local welcome - we use our idea of the time */
 944 +    } else
 945 +      timestamp = TStime();
 946 +
 947 +    /* compare new message with old message */
 948 +    if (ircd_strcmp(text, WelcomeArray[namearray].text) == 0) {
 949 +      if (IsUser(sptr))
 950 +        sendcmdto_one(&me, CMD_NOTICE, sptr,
 951 +          "%C :WELCOME: Cannot change %s message for %s - nothing to change.",
 952 +          sptr, (flags & WELCOME_LOCAL) ? "local" : "global", name);
 953 +      return 0;
 954 +    }
 955 +  }
 956 +
 957 +  /* TODO: rate limited for what? max 10 welcome messages..? */
 958 +  /* possible timestamp drift - warn ops */
 959 +  if (timestamp - TStime() > WELCOME_MAX_DRIFT) {
 960 +    sendto_opmask_butone_ratelimited(0, SNO_NETWORK, &rate,
 961 +      "Possible timestamp drift from %C; timestamp in WELCOME message is %is ahead of time",
 962 +      IsServer(sptr) ? sptr : cli_user(sptr)->server, timestamp - TStime());
 963 +
 964 +    /* warn remote oper too */
 965 +    if (IsUser(sptr))
 966 +      sendcmdto_one(&me, CMD_NOTICE, sptr,
 967 +        "%C :Possible timestamp drift from %C; timestamp in WELCOME message is %is ahead of time",
 968 +        sptr, cli_user(sptr)->server, timestamp - TStime());
 969 +  }
 970 +
 971 +  /* unsetting - do not announce, do not insert, save text */
 972 +  if (EmptyString(text)) {
 973 +    flags &= ~WELCOME_ANNOUNCE;
 974 +    flags &= ~WELCOME_INSERT;
 975 +    ircd_strncpy(oldtext, WelcomeArray[namearray].text, WELCOMELEN);
 976 +  }
 977 +
 978 +  /* make space if needed */
 979 +  if (flags & WELCOME_INSERT)
 980 +    welcome_insert(cptr, sptr, name, nameint, namearray, who, timestamp, flags);
 981 +
 982 +  /* update */
 983 +  welcome_make(namearray, text, who, timestamp);
 984 +
 985 +  /* create msg for snomask, logging, etc. */
 986 +  ircd_snprintf(0, msg, 0, "%s%s%s WELCOME %d \"%s\" [%Tu]",
 987 +    EmptyString(text) ? "unsetting" : "changing",
 988 +    (flags & WELCOME_ANNOUNCE) ? " and announcing " : " ",
 989 +    (flags & WELCOME_LOCAL) ? "local" : "global",
 990 +    nameint, EmptyString(text) ? oldtext : text, timestamp);
 991 +
 992 +  /* inform ops */
 993 +  sendto_opmask_butone(0, SNO_OLDSNO, "%s %s",
 994 +    (feature_bool(FEAT_HIS_SNOTICES) || IsServer(sptr)) ?
 995 +    get_client_name_and_opername(sptr) : cli_name((cli_user(sptr))->server), msg);
 996 +
 997 +  /* log it */
 998 +  log_write(LS_NETWORK, L_INFO, LOG_NOSNOTICE, "%#C (%s) %s", sptr, who, msg);
 999 +
1000 +  /* welcome set by remote user, inform oper of success */
1001 +  if ((flags & WELCOME_LOCAL) && IsUser(sptr) && !MyUser(sptr)) {
1002 +    sendcmdto_one(&me, CMD_NOTICE, sptr, "%C :%s %s",
1003 +      sptr, get_client_name_and_opername(sptr), msg);
1004 +
1005 +    /* TODO: wallops all local changes, by both local and remote opers? */
1006 +    /* tell all opers about the local message being set remotely */
1007 +    sendwallto_group_butone(&me, WALL_WALLOPS, 0, "%s %s", get_client_name_and_opername(sptr), msg);
1008 +  }
1009 +
1010 +  /* propagate it */
1011 +  if (!(flags & WELCOME_LOCAL) && !insert)
1012 +    sendcmdto_serv_butone(sptr, CMD_WELCOME, cptr, "* %s%s%d %Tu %s :%s",
1013 +      (flags & WELCOME_ANNOUNCE) ? "!" : "", (flags & WELCOME_INSERT) ? "+" : "",
1014 +      nameint, timestamp, who, text);
1015 +
1016 +  /* announce it */
1017 +  if (flags & WELCOME_ANNOUNCE)
1018 +    welcome_announce(namearray);
1019 +
1020 +  return 0;
1021 +}
1022 +
1023 +
1024 +/** Change a welcome message.
1025 + * @param[in] cptr Local client that sent us the welcome.
1026 + * @param[in] sptr Originator of the welcome.
1027 + * @param[in] name Name of the message.
1028 + * @param[in] nameint Name of the message.
1029 + * @param[in] namearray Array entry.
1030 + * @param[in] who Who set this message.
1031 + * @param[in] timestamp Timestamp of when the message was set.
1032 + * @param[in] flags Flags to set on welcome.
1033 + * @return Zero
1034 + */
1035 +int
1036 +welcome_insert(struct Client *cptr, struct Client *sptr, char *name, int nameint,
1037 +  int namearray, char *who, time_t timestamp, unsigned int flags)
1038 +{
1039 +  char *text = "";                      /* empty text to clear to feed to welcome_do */
1040 +  char *last = "10";                    /* last welcome message to feed to welcome_do */
1041 +  char msg[BUFSIZE];                    /* msg for snomask, logging, etc. */
1042 +  unsigned int newflags = flags;        /* new flags to feed back to welcome_do */
1043 +  int i;                                /* loop variable */
1044 +  int empty = -1;                       /* first empty spot array after arrayname */
1045 +  int end = WELCOME_MAX_ENTRIES -1;     /* last element to check in array */
1046 +
1047 +  assert(NULL != cptr);
1048 +  assert(NULL != sptr);
1049 +  assert(flags & WELCOME_INSERT);
1050 +  assert(namearray >= 0 && namearray <= 2 * WELCOME_MAX_ENTRIES - 1);
1051 +
1052 +  /* debug */
1053 +  Debug((DEBUG_DEBUG, "welcome_insert(\"%s\", \"%s\", \"%s\", %d, %d, \"%s\", %Tu, 0x%04x)",
1054 +   cli_name(cptr), cli_name(sptr), name, nameint, namearray, who, timestamp, flags));
1055 +
1056 +  /* not set yet, do not insert */
1057 +  if (WelcomeArray[namearray].timestamp == 0)
1058 +    return 0;
1059 +
1060 +  /* last global entry */
1061 +  if (!(flags & WELCOME_LOCAL) && (nameint == WELCOME_MAX_ENTRIES))
1062 +    return 0;
1063 +
1064 +  /* last local entry */
1065 +  if ((flags & WELCOME_LOCAL) && (nameint == 2 * WELCOME_MAX_ENTRIES))
1066 +    return 0;
1067 +
1068 +  /* correct end for local offset */
1069 +  if (flags & WELCOME_LOCAL)
1070 +    end += WELCOME_MAX_ENTRIES;
1071 +
1072 +  /* found first empty spot */
1073 +  for (i = namearray; i <= end; i++) {
1074 +    if (*WelcomeArray[i].text == 0) {
1075 +      empty = i;
1076 +      break;
1077 +    }
1078 +  }
1079 +
1080 +  /* no empty spot, need to unset last, do not insert or announce */
1081 +  if (empty == -1) {
1082 +    newflags &= ~WELCOME_INSERT;
1083 +    newflags &= ~WELCOME_ANNOUNCE;
1084 +    welcome_do(cptr, sptr, last, text, who, timestamp, newflags, 1);
1085 +    empty = end;
1086 +  }
1087 +
1088 +  /* move entries down */
1089 +  for (i = empty; i > namearray; i--)
1090 +    welcome_make(i, WelcomeArray[i-1].text, WelcomeArray[i-1].who, WelcomeArray[i-1].timestamp);
1091 +
1092 +  /* correct empty for local offset */
1093 +  if (flags & WELCOME_LOCAL)
1094 +    empty -= WELCOME_MAX_ENTRIES;
1095 +
1096 +  /* create msg for snomask, logging, etc. */
1097 +  if (nameint == empty)
1098 +    ircd_snprintf(0, msg, 0, "moving %s WELCOME message %d one place down",
1099 +      (flags & WELCOME_LOCAL) ? "local" : "global", nameint);
1100 +  else
1101 +    ircd_snprintf(0, msg, 0, "moving %s WELCOME message %d %s %d one place down",
1102 +      (flags & WELCOME_LOCAL) ? "local" : "global", nameint, (empty - nameint > 1) ? "to" : "and" , empty);
1103 +
1104 +  /* inform ops */
1105 +  sendto_opmask_butone(0, SNO_OLDSNO, "%s %s",
1106 +    (feature_bool(FEAT_HIS_SNOTICES) || IsServer(sptr)) ?
1107 +    get_client_name_and_opername(sptr) : cli_name((cli_user(sptr))->server), msg);
1108 +
1109 +  /* log it */
1110 +  log_write(LS_NETWORK, L_INFO, LOG_NOSNOTICE, "%#C (%s) %s", sptr, who, msg);
1111 +
1112 +  /* welcome set by remote user, inform oper */
1113 +  if ((flags & WELCOME_LOCAL) && IsUser(sptr) && !MyUser(sptr)) {
1114 +    sendcmdto_one(&me, CMD_NOTICE, sptr, "%C :%s %s",
1115 +      sptr, get_client_name_and_opername(sptr), msg);
1116 +
1117 +    /* TODO: wallops all local changes, by both local and remote opers? */
1118 +    /* tell all opers about the local message being set remotely */
1119 +    sendwallto_group_butone(&me, WALL_WALLOPS, 0, "%s %s", get_client_name_and_opername(sptr), msg);
1120 +  }
1121 +  return 0;
1122 +}
1123 +
1124 +
1125 +/** Announce a welcome message to local clients.
1126 + * @param[in] name Welcome message to announce.
1127 + */
1128 +void
1129 +welcome_announce(int name)
1130 +{
1131 +  struct Client *acptr;
1132 +  struct MsgBuf *msgbuf;
1133 +  int i;
1134 +
1135 +  /* range 0 to 2 * max - 1 */
1136 +  assert(name >= 0 && name <= 2 * WELCOME_MAX_ENTRIES - 1);
1137 +
1138 +  /* TODO: target is $* as if it were a global broadcast
1139 +   * could make it $servername for local message announcement
1140 +   * but the type is shown between [ ] already
1141 +   * either [Network] or [servername] - using $* is just shorter.
1142 +   */
1143 +  /* build msgbuf */
1144 +  msgbuf = msgq_make(0, ":%C %s $* :[%s] %s", &me, MSG_NOTICE,
1145 +    name >= WELCOME_MAX_ENTRIES ? cli_name(&me) : feature_str(FEAT_NETWORK),
1146 +    WelcomeArray[name].text);
1147 +
1148 +  /* go over local clients */
1149 +  for (i = HighestFd; i > 0; --i) {
1150 +
1151 +    /* skip unregistered clients - they see the message during login
1152 +     * skip servers
1153 +     */
1154 +    if (!(acptr = LocalClientArray[i]) || !IsRegistered(acptr) || IsServer(acptr))
1155 +      continue;
1156 +
1157 +    /* send it away */
1158 +    send_buffer(acptr, msgbuf, 0);
1159 +  }
1160 +}
1161 +
1162 +
1163 +/** Send the full list of welcome message to \a cptr.
1164 + * @param[in] cptr Local server to send welcomes to.
1165 + */
1166 +void
1167 +welcome_burst(struct Client *cptr)
1168 +{
1169 +  int name;
1170 +
1171 +  assert(NULL != cptr);
1172 +
1173 +  /* loop over global entries - 0 to max - 1*/
1174 +  for (name = 0; name <= WELCOME_MAX_ENTRIES - 1; name++) {
1175 +    if (WelcomeArray[name].timestamp != 0)
1176 +      sendcmdto_one(&me, CMD_WELCOME, cptr, "* %d %Tu %s :%s",
1177 +        name + 1, WelcomeArray[name].timestamp, WelcomeArray[name].who,
1178 +        WelcomeArray[name].text);
1179 +  }
1180 +}
1181 +
1182 +
1183 +/** List welcome messages.
1184 + * @param[in] sptr Client requesting the listing.
1185 + * @param[in] connect When non zero do not report no welcome is set
1186 + * @return Zero.
1187 + */
1188 +int
1189 +welcome_list(struct Client *sptr, int connect)
1190 +{
1191 +  int found = 0, local = 0, name;
1192 +
1193 +  assert(NULL != sptr);
1194 +
1195 +  /* loop over all entries - range 0 to 2 * max - 1 */
1196 +  for (name = 0; name <= 2 * WELCOME_MAX_ENTRIES - 1; name++) {
1197 +
1198 +    /* local entries now */
1199 +    if (name == WELCOME_MAX_ENTRIES)
1200 +      local = 1;
1201 +
1202 +    /* not set or empty - skip */
1203 +    /* TODO: EmptyString? */
1204 +    if (WelcomeArray[name].timestamp == 0 || *WelcomeArray[name].text == 0)
1205 +      continue;
1206 +
1207 +    /* got one */
1208 +    found++;
1209 +    sendcmdto_one(&me, CMD_NOTICE, sptr, "%C :[%s] %s",
1210 +      sptr, local ? cli_name(&me) : feature_str(FEAT_NETWORK), WelcomeArray[name].text);
1211 +  }
1212 +
1213 +  /* nothing set */
1214 +  if (!found && !connect)
1215 +    sendcmdto_one(&me, CMD_NOTICE, sptr, "%C :No welcome message set.", sptr);
1216 +
1217 +  return 0;
1218 +}
1219 +
1220 +
1221 +/** Statistics callback to list Welcome messages.
1222 + * @param[in] sptr Client requesting statistics.
1223 + * @param[in] sd Stats descriptor for request (ignored).
1224 + * @param[in] param Extra parameter from user (ignored).
1225 + */
1226 +void
1227 +welcome_stats(struct Client *sptr, const struct StatDesc *sd, char *param)
1228 +{
1229 +  int name, local = 0;
1230 +
1231 +  assert(NULL != sptr);
1232 +
1233 +  /* loop over all entries - range 0 to 2 * max - 1*/
1234 +  for (name = 0; name <= 2 * WELCOME_MAX_ENTRIES - 1; name++) {
1235 +
1236 +    /* local entries now */
1237 +    if (name == WELCOME_MAX_ENTRIES)
1238 +      local = 1;
1239 +
1240 +    /* not set */
1241 +    if (WelcomeArray[name].timestamp == 0)
1242 +      continue;
1243 +
1244 +    /* send it */
1245 +    send_reply(sptr, RPL_STATSWELCOME,
1246 +      local ? name + 1 - WELCOME_MAX_ENTRIES : name + 1,
1247 +      local ? cli_name(&me) : "*",
1248 +      WelcomeArray[name].who, WelcomeArray[name].timestamp,
1249 +      EmptyString(WelcomeArray[name].text)  ? "<Empty>" : WelcomeArray[name].text);
1250 +  }
1251 +}