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 a9b437e961ec 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 a9b437e961ec 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 a9b437e961ec 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 a9b437e961ec 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 a9b437e961ec 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 a9b437e961ec include/welcome.h
 173 --- /dev/null
 174 +++ b/include/welcome.h
 175 @@ -0,0 +1,75 @@
 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 +
 214 +
 215 +/* Test if a welcome entry is in a valid range */
 216 +#define WelcomeIsValid(x)     ((x) >= 0 && (x) <= 2 * WELCOME_MAX_ENTRIES - 1)
 217 +/* Test if a welcome entry is set */
 218 +#define WelcomeIsSet(x)       (WelcomeArray[(x)].timestamp > 0)
 219 +/* Test if a welcome entry is empty */
 220 +#define WelcomeIsEmpty(x)     (*WelcomeArray[(x)].text == 0)
 221 +
 222 +/* Get welcome timestamp */
 223 +#define WelcomeTS(x)          (WelcomeArray[(x)].timestamp)
 224 +/* Get welcome text */
 225 +#define WelcomeText(x)        (WelcomeArray[(x)].text)
 226 +/* Get welcome who info */
 227 +#define WelcomeWho(x)         (WelcomeArray[(x)].who)
 228 +
 229 +
 230 +/* Describes a Welcome message entry. */
 231 +struct Welcome {
 232 +  time_t             timestamp;            /**< Timestamp of the welcome */
 233 +  char               text[WELCOMELEN + 1]; /**< Message */
 234 +  char               who[ACCOUNTLEN + 1];  /**< Who set it */
 235 +};
 236 +
 237 +/** Welcome type flags */
 238 +#define WELCOME_LOCAL    0x01 /**< welcome is local */
 239 +/** Welcome action flags */
 240 +#define WELCOME_ANNOUNCE 0x02 /**< announce change to users */
 241 +#define WELCOME_INSERT   0x04 /**< insert welcome message, move down all others one place */
 242 +
 243 +extern int welcome_do(struct Client *cptr, struct Client *sptr, char *name,
 244 +  time_t timestamp, char *who, char *text, unsigned int flags);
 245 +extern void welcome_announce(int name);
 246 +extern void welcome_burst(struct Client *cptr);
 247 +extern int welcome_list(struct Client *sptr, int connect);
 248 +extern void welcome_stats(struct Client *sptr, const struct StatDesc *sd, char *param);
 249 +
 250 +#endif /* INCLUDED_welcome_h */
 251 diff -r a9b437e961ec ircd/Makefile.in
 252 --- a/ircd/Makefile.in
 253 +++ b/ircd/Makefile.in
 254 @@ -186,6 +186,7 @@
 255         m_wallops.c \
 256         m_wallusers.c \
 257         m_wallvoices.c \
 258 +       m_welcome.c \
 259         m_who.c \
 260         m_whois.c \
 261         m_whowas.c \
 262 @@ -215,6 +216,7 @@
 263         send.c \
 264         uping.c \
 265         userload.c \
 266 +       welcome.c \
 267         whocmds.c \
 268         whowas.c \
 269         y.tab.c
 270 @@ -1161,6 +1163,11 @@
 271    ../include/ircd_reply.h ../include/ircd_string.h \
 272    ../include/ircd_chattr.h ../include/msg.h ../include/numeric.h \
 273    ../include/numnicks.h ../include/s_user.h ../include/send.h
 274 +m_welcome.o: m_welcome.c ../config.h ../include/channel.h \
 275 +  ../include/client.h ../include/hash.h ../include/ircd.h ../include/ircd_log.h \
 276 +  ../include/ircd_reply.h ../include/ircd_string.h ../include/msg.h \
 277 +  ../include/numeric.h ../include/numnicks.h ../include/s_user.h \
 278 +  ../include/send.h ../include/welcome.h
 279  m_who.o: m_who.c ../config.h ../include/channel.h ../include/ircd_defs.h \
 280    ../include/res.h ../config.h ../include/client.h ../include/dbuf.h \
 281    ../include/msgq.h ../include/ircd_events.h ../include/ircd_handler.h \
 282 @@ -1422,6 +1429,13 @@
 283    ../include/numnicks.h ../include/querycmds.h ../include/ircd_features.h \
 284    ../include/s_misc.h ../include/s_stats.h ../include/send.h \
 285    ../include/struct.h ../include/sys.h
 286 +welcome.o: welcome.c ../config.h ../include/client.h \
 287 +  ../include/hash.h ../include/ircd.h ../include/ircd_alloc.h \
 288 +  ../include/ircd_features.h ../include/ircd_log.h ../include/ircd_reply.h \
 289 +  ../include/match.h ../include/msg.h ../include/numeric.h \
 290 +  ../include/numnicks.h ../include/s_debug.h ../include/s_bsd.h \
 291 +  ../include/s_misc.h ../include/send.h ../include/struct.h \
 292 +  ../include/sys.h ../include/welcome.h
 293  whocmds.o: whocmds.c ../config.h ../include/whocmds.h \
 294    ../include/channel.h ../include/ircd_defs.h ../include/res.h \
 295    ../config.h ../include/client.h ../include/dbuf.h ../include/msgq.h \
 296 diff -r a9b437e961ec ircd/client.c
 297 --- a/ircd/client.c
 298 +++ b/ircd/client.c
 299 @@ -177,6 +177,7 @@
 300      FlagSet(&privs_local, PRIV_WHOX);
 301      FlagSet(&privs_local, PRIV_DISPLAY);
 302      FlagSet(&privs_local, PRIV_FORCE_LOCAL_OPMODE);
 303 +    FlagSet(&privs_local, PRIV_LOCAL_WELCOME);
 304
 305      privs_defaults_set = 1;
 306    }
 307 @@ -223,6 +224,7 @@
 308      ClrPriv(client, PRIV_JUPE);
 309      ClrPriv(client, PRIV_OPMODE);
 310      ClrPriv(client, PRIV_BADCHAN);
 311 +    ClrPriv(client, PRIV_WELCOME);
 312    }
 313  }
 314
 315 @@ -244,7 +246,7 @@
 316    P(CHANSERV),       P(XTRA_OPER),      P(NOIDLE),        P(FREEFORM),
 317    P(PARANOID),       P(CHECK),          P(WALL),          P(CLOSE),
 318    P(ROUTE),          P(ROUTEINFO),      P(SERVERINFO),    P(CHANNEL_PRIVACY),
 319 -  P(USER_PRIVACY),
 320 +  P(USER_PRIVACY),   P(WELCOME),        P(LOCAL_WELCOME),
 321  #undef P
 322    { 0, 0 }
 323  };
 324 diff -r a9b437e961ec ircd/ircd_features.c
 325 --- a/ircd/ircd_features.c
 326 +++ b/ircd/ircd_features.c
 327 @@ -366,6 +366,7 @@
 328    F_I(IRCD_RES_TIMEOUT, 0, 4, 0),
 329    F_I(AUTH_TIMEOUT, 0, 9, 0),
 330    F_B(ANNOUNCE_INVITES, 0, 0, 0),
 331 +  F_B(WELCOME, 0, 1, 0),
 332
 333    /* features that affect all operators */
 334    F_B(EXTENDED_CHECKCMD, 0, 0, 0),
 335 @@ -407,6 +408,7 @@
 336    F_B(HIS_STATS_u, 0, 1, 0),
 337    F_B(HIS_STATS_U, 0, 1, 0),
 338    F_B(HIS_STATS_v, 0, 1, 0),
 339 +  F_B(HIS_STATS_W, 0, 1, 0),
 340    F_B(HIS_STATS_w, 0, 1, 0),
 341    F_B(HIS_STATS_x, 0, 1, 0),
 342    F_B(HIS_STATS_y, 0, 1, 0),
 343 diff -r a9b437e961ec ircd/ircd_lexer.l
 344 --- a/ircd/ircd_lexer.l
 345 +++ b/ircd/ircd_lexer.l
 346 @@ -166,6 +166,8 @@
 347    { "serverinfo", TPRIV_SERVERINFO },
 348    { "user_privacy", TPRIV_USER_PRIVACY },
 349    { "channel_privacy", TPRIV_CHANNEL_PRIVACY },
 350 +  { "local_welcome", TPRIV_LOCAL_WELCOME },
 351 +  { "welcome", TPRIV_WELCOME },
 352    { NULL, 0 }
 353  };
 354  static int ntokens;
 355 diff -r a9b437e961ec ircd/ircd_parser.y
 356 --- a/ircd/ircd_parser.y
 357 +++ b/ircd/ircd_parser.y
 358 @@ -189,6 +189,7 @@
 359  %token TPRIV_CHANSERV TPRIV_XTRA_OPER TPRIV_NOIDLE TPRIV_FREEFORM TPRIV_PARANOID
 360  %token TPRIV_CHECK TPRIV_WALL TPRIV_CLOSE TPRIV_ROUTE TPRIV_ROUTEINFO TPRIV_SERVERINFO
 361  %token TPRIV_CHANNEL_PRIVACY TPRIV_USER_PRIVACY TPRIV_LIST_CHAN
 362 +%token TPRIV_LOCAL_WELCOME TPRIV_WELCOME
 363  /* and some types... */
 364  %type <num> sizespec
 365  %type <num> timespec timefactor factoredtimes factoredtime
 366 @@ -703,6 +704,8 @@
 367            TPRIV_SERVERINFO { $$ = PRIV_SERVERINFO ; } |
 368            TPRIV_CHANNEL_PRIVACY { $$ = PRIV_CHANNEL_PRIVACY ; } |
 369            TPRIV_USER_PRIVACY { $$ = PRIV_USER_PRIVACY ; } |
 370 +          TPRIV_LOCAL_WELCOME { $$ = PRIV_LOCAL_WELCOME; } |
 371 +          TPRIV_WELCOME { $$ = PRIV_WELCOME; } |
 372            TPRIV_PARANOID { $$ = PRIV_PARANOID; } ;
 373  yesorno: YES { $$ = 1; } | NO { $$ = 0; };
 374
 375 diff -r a9b437e961ec ircd/m_welcome.c
 376 --- /dev/null
 377 +++ b/ircd/m_welcome.c
 378 @@ -0,0 +1,296 @@
 379 +/*
 380 + * IRC - Internet Relay Chat, ircd/m_welcome.c
 381 + * Copyright (C) 1990 Jarkko Oikarinen and
 382 + *                    University of Oulu, Computing Center
 383 + *
 384 + * See file AUTHORS in IRC package for additional names of
 385 + * the programmers.
 386 + *
 387 + * This program is free software; you can redistribute it and/or modify
 388 + * it under the terms of the GNU General Public License as published by
 389 + * the Free Software Foundation; either version 1, or (at your option)
 390 + * any later version.
 391 + *
 392 + * This program is distributed in the hope that it will be useful,
 393 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
 394 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 395 + * GNU General Public License for more details.
 396 + *
 397 + * You should have received a copy of the GNU General Public License
 398 + * along with this program; if not, write to the Free Software
 399 + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 400 + *
 401 + */
 402 +
 403 +/*
 404 + * m_functions execute protocol messages on this server:
 405 + *
 406 + *    cptr    is always NON-NULL, pointing to a *LOCAL* client
 407 + *            structure (with an open socket connected!). This
 408 + *            identifies the physical socket where the message
 409 + *            originated (or which caused the m_function to be
 410 + *            executed--some m_functions may call others...).
 411 + *
 412 + *    sptr    is the source of the message, defined by the
 413 + *            prefix part of the message if present. If not
 414 + *            or prefix not found, then sptr==cptr.
 415 + *
 416 + *            (!IsServer(cptr)) => (cptr == sptr), because
 417 + *            prefixes are taken *only* from servers...
 418 + *
 419 + *            (IsServer(cptr))
 420 + *                    (sptr == cptr) => the message didn't
 421 + *                    have the prefix.
 422 + *
 423 + *                    (sptr != cptr && IsServer(sptr) means
 424 + *                    the prefix specified servername. (?)
 425 + *
 426 + *                    (sptr != cptr && !IsServer(sptr) means
 427 + *                    that message originated from a remote
 428 + *                    user (not local).
 429 + *
 430 + *            combining
 431 + *
 432 + *            (!IsServer(sptr)) means that, sptr can safely
 433 + *            taken as defining the target structure of the
 434 + *            message in this server.
 435 + *
 436 + *    *Always* true (if 'parse' and others are working correct):
 437 + *
 438 + *    1)      sptr->from == cptr  (note: cptr->from == cptr)
 439 + *
 440 + *    2)      MyConnect(sptr) <=> sptr == cptr (e.g. sptr
 441 + *            *cannot* be a local connection, unless it's
 442 + *            actually cptr!). [MyConnect(x) should probably
 443 + *            be defined as (x == x->from) --msa ]
 444 + *
 445 + *    parc    number of variable parameter strings (if zero,
 446 + *            parv is allowed to be NULL)
 447 + *
 448 + *    parv    a NULL terminated list of parameter pointers,
 449 + *
 450 + *                    parv[0], sender (prefix string), if not present
 451 + *                            this points to an empty string.
 452 + *                    parv[1]...parv[parc-1]
 453 + *                            pointers to additional parameters
 454 + *                    parv[parc] == NULL, *always*
 455 + *
 456 + *            note:   it is guaranteed that parv[0]..parv[parc-1] are all
 457 + *                    non-NULL pointers.
 458 + */
 459 +#include "config.h"
 460 +
 461 +#include "channel.h"
 462 +#include "client.h"
 463 +#include "hash.h"
 464 +#include "ircd.h"
 465 +#include "ircd_features.h"
 466 +#include "ircd_log.h"
 467 +#include "ircd_reply.h"
 468 +#include "ircd_snprintf.h"
 469 +#include "ircd_string.h"
 470 +#include "msg.h"
 471 +#include "numeric.h"
 472 +#include "numnicks.h"
 473 +#include "s_user.h"
 474 +#include "send.h"
 475 +#include "welcome.h"
 476 +
 477 +/* #include <assert.h> -- Now using assert in ircd_log.h */
 478 +
 479 +/*
 480 + * m_welcome - local generic message handler
 481 + *
 482 + * parv[0] = Send prefix
 483 + * parv[1] = [remote server to query]
 484 + */
 485 +int m_welcome(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 486 +{
 487 +  /* feature disabled */
 488 +  if (!feature_bool(FEAT_WELCOME))
 489 +    return send_reply(sptr, ERR_DISABLED, "WELCOME");
 490 +
 491 +  /* only opers can set the welcome messages */
 492 +  if (parc > 2)
 493 +    return send_reply(sptr, ERR_NOPRIVILEGES);
 494 +
 495 +  /* remote listing request, see if it is for me or a remote server
 496 +   *  check FEAT_HIS_REMOTE to decide if an ordinary user can do this
 497 +   */
 498 +  if ((parc > 1) && (hunt_server_cmd(sptr, CMD_WELCOME, cptr, feature_int(FEAT_HIS_REMOTE),
 499 +        "%C", 1, parc, parv) != HUNTED_ISME))
 500 +    return 0;
 501 +
 502 +  /* local listing */
 503 +  return welcome_list(sptr, 0);
 504 +}
 505 +
 506 +
 507 +/*
 508 + * mo_welcome - oper message handler
 509 + *
 510 + * listing:
 511 + * parv[0] = Send prefix
 512 + *
 513 + * remote listing:
 514 + * parv[0] = Send prefix
 515 + * parv[1] = Target
 516 + *
 517 + * set global or on remote server:
 518 + * parv[0] = Send prefix
 519 + * parv[1] = Target: server or * for global (or left out for this server)
 520 + * parv[2] = Name
 521 + * parv[3] = Text
 522 + */
 523 +int mo_welcome(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 524 +{
 525 +  char *target, *name, *who, *text, pattern[BUFSIZE];
 526 +  time_t timestamp;
 527 +  unsigned int flags = 0;
 528 +  int local = 0;
 529 +
 530 +  /* feature disabled */
 531 +  if (!feature_bool(FEAT_WELCOME))
 532 +    return send_reply(sptr, ERR_DISABLED, "WELCOME");
 533 +
 534 +  /* TODO: move feature check here? */
 535 +  /* remote listing request, see if it is for me or a remote server */
 536 +  if ((parc == 2) && (hunt_server_cmd(sptr, CMD_WELCOME, cptr, 0, "%C", 1, parc, parv) != HUNTED_ISME))
 537 +    return 0;
 538 +
 539 +  /* local listing */
 540 +  if (parc <= 2)
 541 +    return welcome_list(sptr, 0);
 542 +
 543 +  /* check PRIVS */
 544 +  /* local - need PRIV LOCAL_WELCOME or WELCOME */
 545 +  if (parc == 3 && !HasPriv(sptr,PRIV_LOCAL_WELCOME) && !HasPriv(sptr,PRIV_WELCOME))
 546 +    return send_reply(sptr, ERR_NOPRIVILEGES);
 547 +
 548 +  /* global or remote - need PRIV WELCOME */
 549 +  if (parc >= 4 && !HasPriv(sptr,PRIV_WELCOME))
 550 +    return send_reply(sptr, ERR_NOPRIVILEGES);
 551 +
 552 +  /* set the parameters */
 553 +
 554 +  /* target not given, only name - setting local welcome */
 555 +  if (parc < 4) {
 556 +    local++;
 557 +    target = cli_name(&me);
 558 +    name = parv[1];
 559 +    flags |= WELCOME_LOCAL;
 560 +
 561 +  /* target and name given */
 562 +  } else {
 563 +    target = parv[1];
 564 +    name = parv[2];
 565 +  }
 566 +  timestamp = TStime();
 567 +  who = cli_user(sptr)->opername;
 568 +  text = parv[parc - 1];
 569 +
 570 +  /* target is not global */
 571 +  if (!(target[0] == '*' && target[1] == '\0') && !local) {
 572 +
 573 +    /* build a pattern for hunt_server_cmd since we do not have all we need in parv */
 574 +    ircd_snprintf(0, pattern, sizeof(pattern), "%s %s %Tu %s :%s", "%C", name, timestamp, who, text);
 575 +    if (hunt_server_cmd(sptr, CMD_WELCOME, cptr, 0, pattern, 1, 2, parv) != HUNTED_ISME)
 576 +      return 0;
 577 +
 578 +   /* else it is a local welcome, for me */
 579 +    flags |= WELCOME_LOCAL;
 580 +  }
 581 +
 582 +  /* TODO: disallow global announcement from oper?
 583 +   * as PRIVMSG/NOTICE to $* is not allowed either by the ircd
 584 +   * when PRIV for that is added, use that here? PRIV_BROADCAST or something
 585 +   *
 586 +   * change prefix to $ ?
 587 +   */
 588 +  /* check for anounce prefix */
 589 +  if (*name == '!') {
 590 +     name++;
 591 +     flags |= WELCOME_ANNOUNCE;
 592 +  }
 593 +
 594 +  /* check for insert prefix */
 595 +  if (*name == '+') {
 596 +     name++;
 597 +     flags |= WELCOME_INSERT;
 598 +  }
 599 +
 600 +  /* and do it */
 601 +  return welcome_do(cptr, sptr, name, timestamp, who, text, flags);
 602 +}
 603 +
 604 +
 605 +/*
 606 + * ms_welcome - server message handler
 607 + *
 608 + * parv[0] = Send prefix
 609 + * parv[1] = Target: server numeric or * for global
 610 + * parv[2] = Name
 611 + * parv[3] = Timestamp
 612 + * parv[4] = Who
 613 + * parv[5] = Text
 614 + */
 615 +int ms_welcome(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
 616 +{
 617 +  char *target, *name, *who, *text;
 618 +  time_t timestamp;
 619 +  unsigned int flags = 0;
 620 +
 621 +  /* not enough - complain */
 622 +  if (parc < 2) {
 623 +    protocol_violation(sptr, "Too few parameters for WELCOME (got %d - need 2)", parc);
 624 +    return need_more_params(sptr, "WELCOME");
 625 +  }
 626 +
 627 +  /* remote listing request, see if it is for me or a remote server */
 628 +  if (parc == 2) {
 629 +    if (IsServer(sptr))
 630 +      return protocol_violation(cptr, "WELCOME listing request from server %C", sptr);
 631 +    if (hunt_server_cmd(sptr, CMD_WELCOME, cptr, 0, "%C", 1, parc, parv) != HUNTED_ISME)
 632 +      return 0;
 633 +    return welcome_list(sptr, 0);
 634 +  }
 635 +
 636 +  /* we need at least 6 parameters to continue - complain */
 637 +  if (parc < 6) {
 638 +    protocol_violation(sptr, "Too few parameters for WELCOME (got %d - need 6)", parc);
 639 +    return need_more_params(sptr, "WELCOME");
 640 +  }
 641 +
 642 +  /* set the parameters */
 643 +  target = parv[1];
 644 +  name = parv[2];
 645 +  timestamp = atoi(parv[3]);
 646 +  who = parv[4];
 647 +  text = parv[parc - 1]; /* parse reason as last parameter */
 648 +
 649 +  /* target is not global */
 650 +  if (!(target[0] == '*' && target[1] == '\0')) {
 651 +
 652 +    /* not for me, and forward it */
 653 +    if (hunt_server_cmd(sptr, CMD_WELCOME, cptr, 0, "%C %s %s %s :%s", 1, parc, parv) != HUNTED_ISME)
 654 +      return 0;
 655 +
 656 +    /* local welcome for me */
 657 +    flags |= WELCOME_LOCAL;
 658 +  }
 659 +
 660 +  /* check for anounce prefix */
 661 +  if (*name == '!') {
 662 +     name++;
 663 +     flags |= WELCOME_ANNOUNCE;
 664 +  }
 665 +
 666 +  /* check for insert prefix */
 667 +  if (*name == '+') {
 668 +     name++;
 669 +     flags |= WELCOME_INSERT;
 670 +  }
 671 +
 672 +  /* and do it */
 673 +  return welcome_do(cptr, sptr, name, timestamp, who, text, flags);
 674 +}
 675 diff -r a9b437e961ec ircd/parse.c
 676 --- a/ircd/parse.c
 677 +++ b/ircd/parse.c
 678 @@ -661,6 +661,15 @@
 679      /* UNREG, CLIENT, SERVER, OPER, SERVICE */
 680      { m_unregistered, m_not_oper, ms_check, mo_check, m_ignore }
 681    },
 682 +
 683 +  /* add command for WELCOME */
 684 +  {
 685 +    MSG_WELCOME,
 686 +    TOK_WELCOME,
 687 +    0, MAXPARA, MFLG_SLOW, 0, NULL,
 688 +    /* UNREG, CLIENT, SERVER, OPER, SERVICE, HELP */
 689 +    { m_unregistered, m_welcome, ms_welcome, mo_welcome, m_ignore }
 690 +  },
 691
 692    /* This command is an alias for QUIT during the unregistered part of
 693     * of the server.  This is because someone jumping via a broken web
 694 diff -r a9b437e961ec ircd/s_err.c
 695 --- a/ircd/s_err.c
 696 +++ b/ircd/s_err.c
 697 @@ -486,7 +486,7 @@
 698  /* 226 */
 699    { RPL_STATSALINE, "%s", "226" },
 700  /* 227 */
 701 -  { 0 },
 702 +  { RPL_STATSWELCOME, "W %d %s %s %Tu :%s", "227" },
 703  /* 228 */
 704    { RPL_STATSQLINE, "Q %s :%s", "228" },
 705  /* 229 */
 706 @@ -1050,7 +1050,7 @@
 707  /* 508 */
 708    { 0 },
 709  /* 509 */
 710 -  { 0 },
 711 +  { ERR_NOSUCHWELCOME, "%s :No such welcome", "509" },
 712  /* 510 */
 713    { 0 },
 714  /* 511 */
 715 diff -r a9b437e961ec ircd/s_serv.c
 716 --- a/ircd/s_serv.c
 717 +++ b/ircd/s_serv.c
 718 @@ -57,6 +57,7 @@
 719  #include "struct.h"
 720  #include "sys.h"
 721  #include "userload.h"
 722 +#include "welcome.h"
 723
 724  /* #include <assert.h> -- Now using assert in ircd_log.h */
 725  #include <stdlib.h>
 726 @@ -196,6 +197,7 @@
 727     */
 728    gline_burst(cptr);
 729    jupe_burst(cptr);
 730 +  welcome_burst(cptr);
 731
 732    /*
 733     * Pass on my client information to the new server
 734 diff -r a9b437e961ec ircd/s_stats.c
 735 --- a/ircd/s_stats.c
 736 +++ b/ircd/s_stats.c
 737 @@ -54,6 +54,7 @@
 738  #include "send.h"
 739  #include "struct.h"
 740  #include "userload.h"
 741 +#include "welcome.h"
 742
 743  #include <stdio.h>
 744  #include <stdlib.h>
 745 @@ -654,9 +655,12 @@
 746    { 'V', "vserversmach", (STAT_FLAG_OPERFEAT | STAT_FLAG_VARPARAM | STAT_FLAG_CASESENS), FEAT_HIS_STATS_v,
 747      stats_servers_verbose, 0,
 748      "Verbose server information." },
 749 -  { 'w', "userload", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_w,
 750 +  { 'w', "userload", STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS, FEAT_HIS_STATS_w,
 751      calc_load, 0,
 752      "Userload statistics." },
 753 +  { 'W', "welcome", STAT_FLAG_OPERFEAT | STAT_FLAG_CASESENS, FEAT_HIS_STATS_W,
 754 +    welcome_stats, 0,
 755 +    "Welcome messages." },
 756    { 'x', "memusage", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_x,
 757      stats_meminfo, 0,
 758      "List usage information." },
 759 diff -r a9b437e961ec ircd/s_user.c
 760 --- a/ircd/s_user.c
 761 +++ b/ircd/s_user.c
 762 @@ -63,6 +63,7 @@
 763  #include "userload.h"
 764  #include "version.h"
 765  #include "whowas.h"
 766 +#include "welcome.h"
 767
 768  #include "handlers.h" /* m_motd and m_lusers */
 769
 770 @@ -410,6 +411,9 @@
 771                             cli_info(sptr), NumNick(cptr) /* two %s's */);
 772
 773      IPcheck_connect_succeeded(sptr);
 774 +
 775 +    if (feature_bool(FEAT_WELCOME))
 776 +      welcome_list(sptr, 1);
 777    }
 778    else {
 779      struct Client *acptr = user->server;
 780 diff -r a9b437e961ec ircd/welcome.c
 781 --- /dev/null
 782 +++ b/ircd/welcome.c
 783 @@ -0,0 +1,611 @@
 784 +/*
 785 + * IRC - Internet Relay Chat, ircd/welcome.c
 786 + * Copyright (C) 1990 Jarkko Oikarinen and
 787 + *                    University of Oulu, Finland
 788 + * Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
 789 + *
 790 + * This program is free software; you can redistribute it and/or modify
 791 + * it under the terms of the GNU General Public License as published by
 792 + * the Free Software Foundation; either version 1, or (at your option)
 793 + * any later version.
 794 + *
 795 + * This program is distributed in the hope that it will be useful,
 796 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
 797 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 798 + * GNU General Public License for more details.
 799 + *
 800 + * You should have received a copy of the GNU General Public License
 801 + * along with this program; if not, write to the Free Software
 802 + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 803 + */
 804 +/** @file
 805 + * @brief Implementation of welcome message handling functions.
 806 + */
 807 +#include "config.h"
 808 +
 809 +#include "client.h"
 810 +#include "hash.h"
 811 +#include "ircd.h"
 812 +#include "ircd_alloc.h"
 813 +#include "ircd_features.h"
 814 +#include "ircd_log.h"
 815 +#include "ircd_reply.h"
 816 +#include "ircd_string.h"
 817 +#include "match.h"
 818 +#include "msg.h"
 819 +#include "numeric.h"
 820 +#include "numnicks.h"
 821 +#include "s_bsd.h"
 822 +#include "s_debug.h"
 823 +#include "s_misc.h"
 824 +#include "send.h"
 825 +#include "struct.h"
 826 +#include "sys.h"    /* FALSE bleah */
 827 +#include "welcome.h"
 828 +
 829 +/* #include <assert.h> -- Now using assert in ircd_log.h */
 830 +#include <string.h>
 831 +
 832 +
 833 +/** List of welcome messages - first MAX for global, second MAX for local */
 834 +static struct Welcome WelcomeArray[WELCOME_MAX_ENTRIES * 2] = { { 0 } };
 835 +
 836 +
 837 +/** Allocate a new welcome with the given parameters.
 838 + * @param[in] name Name of the welcome message.
 839 + * @param[in] text The welcome message.
 840 + * @param[in] who Who set it.
 841 + * @param[in] timestamp When it was set.
 842 + * @return name Array number of the welcome set.
 843 + */
 844 +static int
 845 +welcome_make(int name, char *text, char *who, time_t timestamp)
 846 +{
 847 +  /* valid range */
 848 +  assert(WelcomeIsValid(name));
 849 +
 850 +  /* store it */
 851 +  ircd_strncpy(WelcomeArray[name].text, text, WELCOMELEN);
 852 +  ircd_strncpy(WelcomeArray[name].who, who, ACCOUNTLEN);
 853 +  WelcomeArray[name].timestamp = timestamp;
 854 +
 855 +  return name;
 856 +}
 857 +
 858 +
 859 +/** Propagate a welcome message.
 860 + * @param[in] cptr Local client that sent us the welcome.
 861 + * @param[in] sptr Originator of the welcome.
 862 + * @param[in] nameint Name of the message.
 863 + * @param[in] timestamp Timestamp of when the message was set.
 864 + * @param[in] who Who set this message.
 865 + * @param[in] text The welcome message.
 866 + * @param[in] flags Flags to set on welcome.
 867 + * @return Zero
 868 + */
 869 +int
 870 +welcome_propagate(struct Client *cptr, struct Client *sptr, int nameint,
 871 +  time_t timestamp, char *who, char *text, unsigned int flags)
 872 +{
 873 +  /* must be global */
 874 +  assert(!(flags & WELCOME_LOCAL));
 875 +  assert(NULL != sptr);
 876 +  assert(NULL != cptr);
 877 +
 878 +  sendcmdto_serv_butone(sptr, CMD_WELCOME, cptr, "* %s%s%d %Tu %s :%s",
 879 +    (flags & WELCOME_ANNOUNCE) ? "!" : "", (flags & WELCOME_INSERT) ? "+" : "",
 880 +    nameint, timestamp, who, text);
 881 +
 882 +  return 0;
 883 +}
 884 +
 885 +
 886 +/** Resend a welcome message.
 887 + * @param[in] cptr Local client that sent us the welcome.
 888 + * @param[in] nameint Name of the message.
 889 + * @param[in] namearray Name of the array item.
 890 + * @return Zero
 891 + */
 892 +int
 893 +welcome_resend(struct Client *cptr, int nameint, int namearray)
 894 +{
 895 +  /* must be valid */
 896 +  assert(WelcomeIsValid(namearray));
 897 +  assert(NULL != cptr);
 898 +  assert(IsServer(cptr));
 899 +
 900 +  sendcmdto_one(&me, CMD_WELCOME, cptr, "* %d %Tu %s :%s",
 901 +    nameint, WelcomeTS(namearray), WelcomeWho(namearray), WelcomeText(namearray));
 902 +
 903 +  return 0;
 904 +}
 905 +
 906 +
 907 +/** Log a welcome message.
 908 + * @param[in] sptr Originator of the welcome.
 909 + * @param[in] msg The message to show.
 910 + * @param[in] flags Flags to set on welcome.
 911 + * @return Zero
 912 + */
 913 +int
 914 +welcome_log(struct Client *sptr, char *msg, unsigned int flags)
 915 +{
 916 +  assert(NULL != sptr);
 917 +  assert(NULL != msg);
 918 +
 919 +  /* inform ops */
 920 +  sendto_opmask_butone(0, SNO_OLDSNO, "%s %s",
 921 +    (feature_bool(FEAT_HIS_SNOTICES) || IsServer(sptr)) ?
 922 +    get_client_name_and_opername(sptr) : cli_name((cli_user(sptr))->server), msg);
 923 +
 924 +  /* log it */
 925 +  log_write(LS_NETWORK, L_INFO, LOG_NOSNOTICE, "%s %s", get_client_name_and_opername(sptr), msg);
 926 +
 927 +  /* welcome by remote user, inform oper of success */
 928 +  if ((flags & WELCOME_LOCAL) && IsUser(sptr) && !MyUser(sptr)) {
 929 +    sendcmdto_one(&me, CMD_NOTICE, sptr, "%C :%s %s",
 930 +      sptr, get_client_name_and_opername(sptr), msg);
 931 +
 932 +    /* TODO: wallops all local changes, by both local and remote opers? */
 933 +    /* tell all opers about the local message being set remotely */
 934 +    sendwallto_group_butone(&me, WALL_WALLOPS, 0, "%s %s", get_client_name_and_opername(sptr), msg);
 935 +  }
 936 +
 937 +  return 0;
 938 +}
 939 +
 940 +
 941 +/** Set a welcome message.
 942 + * @param[in] cptr Local client that sent us the welcome.
 943 + * @param[in] sptr Originator of the welcome.
 944 + * @param[in] nameint Name of the message.
 945 + * @param[in] namearray Array entry.
 946 + * @param[in] timestamp Timestamp of when the message was set.
 947 + * @param[in] who Who set this message.
 948 + * @param[in] text The message.
 949 + * @param[in] flags Flags to set on welcome.
 950 + * @return Zero
 951 + */
 952 +int
 953 +welcome_set(struct Client *cptr, struct Client *sptr, int nameint,
 954 +  int namearray, time_t timestamp, char *who, char *text, unsigned int flags)
 955 +{
 956 +  char msg[BUFSIZE];                    /* msg for logging */
 957 +  int new = 0;
 958 +
 959 +  /* debug */
 960 +  Debug((DEBUG_DEBUG, "welcome_set(\"%s\", \"%s\", %d, %d, %Tu, \"%s\", \"%s\", 0x%04x)",
 961 +   cli_name(cptr), cli_name(sptr), nameint, namearray, timestamp, who, text, flags));
 962 +
 963 +  /* not set */
 964 +  if (WelcomeIsEmpty(namearray))
 965 +    new = 1;
 966 +
 967 +  /* update */
 968 +  welcome_make(namearray, text, who, timestamp);
 969 +
 970 +  /* create msg for log */
 971 +  ircd_snprintf(0, msg, 0, "%s%s%s WELCOME %d \"%s\" %s [%Tu]",
 972 +    new ? "setting" : "changing",
 973 +    (flags & WELCOME_ANNOUNCE) ? " and announcing " : " ",
 974 +    (flags & WELCOME_LOCAL) ? "local" : "global",
 975 +    nameint, WelcomeText(namearray), WelcomeWho(namearray), timestamp);
 976 +
 977 +  /* log it */
 978 +  welcome_log(sptr, msg, flags);
 979 +
 980 +  /* propagate it */
 981 +  if (!(flags & WELCOME_LOCAL))
 982 +    welcome_propagate(cptr, sptr, nameint, timestamp, who, text, flags);
 983 +
 984 +  /* announce it */
 985 +  if (flags & WELCOME_ANNOUNCE)
 986 +    welcome_announce(namearray);
 987 +
 988 +  return 0;
 989 +}
 990 +
 991 +
 992 +/** Unset a welcome message.
 993 + * @param[in] cptr Local client that sent us the welcome.
 994 + * @param[in] sptr Originator of the welcome.
 995 + * @param[in] nameint Name of the message.
 996 + * @param[in] namearray Array entry.
 997 + * @param[in] timestamp Timestamp of when the message was set.
 998 + * @param[in] who Who set this message.
 999 + * @param[in] flags Flags to set on welcome.
1000 + * @return Zero
1001 + */
1002 +int
1003 +welcome_unset(struct Client *cptr, struct Client *sptr, int nameint,
1004 +  int namearray, time_t timestamp, char *who, unsigned int flags)
1005 +{
1006 +  char msg[BUFSIZE];                    /* msg for logging */
1007 +  int i;                                /* loop variable */
1008 +  int empty = namearray;                /* first empty spot in array after namearray */
1009 +  int end = WELCOME_MAX_ENTRIES -1;     /* last element to check in array */
1010 +
1011 +  /* debug */
1012 +  Debug((DEBUG_DEBUG, "welcome_unset(\"%s\", \"%s\", %d, %d, %Tu, \"%s\", 0x%04x)",
1013 +   cli_name(cptr), cli_name(sptr), nameint, namearray, timestamp, who, flags));
1014 +
1015 +  /* create msg for log */
1016 +  ircd_snprintf(0, msg, 0, "unsetting %s WELCOME %d \"%s\" %s [%Tu]",
1017 +    (flags & WELCOME_LOCAL) ? "local" : "global",
1018 +    nameint, WelcomeText(namearray), WelcomeWho(namearray), timestamp);
1019 +
1020 +  /* log it */
1021 +  welcome_log(sptr, msg, flags);
1022 +
1023 +  /* update */
1024 +  welcome_make(namearray, "", who, timestamp);
1025 +
1026 +  /* propagate it, but not when inserting */
1027 +  if (!(flags & (WELCOME_LOCAL|WELCOME_INSERT)))
1028 +    welcome_propagate(cptr, sptr, nameint, timestamp, who, "", flags);
1029 +
1030 +  /* correct end for local offset */
1031 +  if (flags & WELCOME_LOCAL)
1032 +    end += WELCOME_MAX_ENTRIES;
1033 +
1034 +  /* move entries up, update timestamp */
1035 +  for (i = namearray; i < end; i++)
1036 +    welcome_make(i, WelcomeText(i+1), WelcomeWho(i+1), timestamp);
1037 +
1038 +  /* clear last entry, update timestamp */
1039 +  welcome_make(end, "", who, timestamp);
1040 +
1041 +  return 0;
1042 +}
1043 +
1044 +
1045 +/** Insert a welcome message.
1046 + * @param[in] cptr Local client that sent us the welcome.
1047 + * @param[in] sptr Originator of the welcome.
1048 + * @param[in] nameint Name of the message.
1049 + * @param[in] namearray Array entry.
1050 + * @param[in] timestamp Timestamp of when the message was set.
1051 + * @param[in] who Who set this message.
1052 + * @param[in] text The welcome message.
1053 + * @param[in] flags Flags to set on welcome.
1054 + * @return Zero
1055 + */
1056 +int
1057 +welcome_insert(struct Client *cptr, struct Client *sptr, int nameint,
1058 +  int namearray, time_t timestamp, char *who, char *text, unsigned int flags)
1059 +{
1060 +  char msg[BUFSIZE];                    /* msg for logging */
1061 +  int i;                                /* loop variable */
1062 +  int empty = -1;                       /* first empty spot in array after namearray */
1063 +  int end = WELCOME_MAX_ENTRIES -1;     /* last element to check in array */
1064 +  int last = end;                       /* last welcome message to feed to welcome_unset */
1065 +
1066 +  /* debug */
1067 +  Debug((DEBUG_DEBUG, "welcome_insert(\"%s\", \"%s\", %d, %d, %Tu, \"%s\", \"%s\", 0x%04x)",
1068 +   cli_name(cptr), cli_name(sptr), nameint, namearray, timestamp, who, text, flags));
1069 +
1070 +  /* correct end for local offset */
1071 +  if (flags & WELCOME_LOCAL)
1072 +    end += WELCOME_MAX_ENTRIES;
1073 +
1074 +  /* find first empty spot */
1075 +  for (i = namearray; i <= end; i++) {
1076 +    if (WelcomeIsEmpty(i)) {
1077 +      empty = i;
1078 +      break;
1079 +    }
1080 +  }
1081 +
1082 +  /* no empty spot, need to unset last */
1083 +  if (empty == -1) {
1084 +    welcome_unset(cptr, sptr, end, namearray, timestamp, who, flags);
1085 +    empty = end;
1086 +  }
1087 +
1088 +  /* move entries down, update timestamp */
1089 +  for (i = empty; i > namearray; i--)
1090 +    welcome_make(i, WelcomeText(i-1), WelcomeWho(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 log */
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 +  /* log it */
1105 +  welcome_log(sptr, msg, flags);
1106 +
1107 +  /* set it */
1108 +  welcome_set(cptr, sptr, nameint, namearray, timestamp, who, text, flags);
1109 +
1110 +  return 0;
1111 +}
1112 +
1113 +
1114 +/** Change a welcome message.
1115 + * @param[in] cptr Local client that sent us the welcome.
1116 + * @param[in] sptr Originator of the welcome.
1117 + * @param[in] name Name of the message.
1118 + * @param[in] timestamp Timestamp of when the message was set.
1119 + * @param[in] who Who set this message.
1120 + * @param[in] text The welcome message.
1121 + * @param[in] flags Flags to set on welcome.
1122 + * @return Zero
1123 + */
1124 +int
1125 +welcome_do(struct Client *cptr, struct Client *sptr, char *name,
1126 +  time_t timestamp, char *who, char *text, unsigned int flags)
1127 +{
1128 +  int nameint = atoi(name);                /* transform to int */
1129 +  int namearray = nameint - 1;             /* used to test the array element */
1130 +  int max = WELCOME_MAX_ENTRIES;           /* max number of entries */
1131 +
1132 +  assert(NULL != cptr);
1133 +  assert(NULL != sptr);
1134 +  assert(NULL != name);
1135 +  assert(NULL != text);
1136 +  assert(NULL != who);
1137 +
1138 +  /* debug */
1139 +  Debug((DEBUG_DEBUG, "welcome_do(\"%s\", \"%s\", \"%s\", %Tu, \"%s\", \"%s\", 0x%04x)",
1140 +   cli_name(cptr), cli_name(sptr), name, timestamp, who, text, flags));
1141 +
1142 +  /* if for some reason timestamp is 0, increase it */
1143 +  if (timestamp == 0)
1144 +    timestamp++;
1145 +
1146 +  /* name empty after taking off the prefixes? */
1147 +  if (EmptyString(name)) {
1148 +    if (IsUser(sptr))
1149 +      sendcmdto_one(&me, CMD_NOTICE, sptr, "%C :WELCOME: No message number given", sptr);
1150 +    else
1151 +      protocol_violation(cptr, "WELCOME: No message number given by %C", sptr);
1152 +    return 0;
1153 +  }
1154 +
1155 +  /* check name */
1156 +  if (!WelcomeIsValid(namearray)) {
1157 +    if (IsUser(sptr))
1158 +      sendcmdto_one(&me, CMD_NOTICE, sptr,
1159 +        "%C :WELCOME: Invalid message number %s - should between 1 and %d",
1160 +        sptr, name, max);
1161 +    else
1162 +      protocol_violation(cptr,
1163 +        "WELCOME: Invalid message number %s from %C - should be between 1 and %d",
1164 +        name, sptr, max);
1165 +    return 0;
1166 +  }
1167 +
1168 +  /* source is user, and is myuser or welcome is local, check length of the message */
1169 +  if ((IsUser(sptr)) && ((MyUser(sptr)) || (flags & WELCOME_LOCAL)) && (strlen(text) > WELCOMELEN)) {
1170 +    sendcmdto_one(&me, CMD_NOTICE, sptr,
1171 +      "%C :WELCOME: The message is too long with %d chars - max is %d chars",
1172 +      sptr, strlen(text), WELCOMELEN);
1173 +    ircd_strncpy(text, text, WELCOMELEN);
1174 +    sendcmdto_one(&me, CMD_NOTICE, sptr,
1175 +      "%C :WELCOME: Change or truncate the message to: \"%s\"", sptr, text);
1176 +    return 0;
1177 +  }
1178 +
1179 +  /* correct namearray for local offset */
1180 +  if (flags & WELCOME_LOCAL)
1181 +    namearray += WELCOME_MAX_ENTRIES;
1182 +
1183 +  /* must be true by now */
1184 +  assert(WelcomeIsValid(namearray));
1185 +
1186 +  /* cannot unset welcome that is not set */
1187 +  if (!WelcomeIsSet(namearray) && EmptyString(text)) {
1188 +
1189 +    /* from user, throw error */
1190 +    if (IsUser(sptr))
1191 +      return send_reply(sptr, ERR_NOSUCHWELCOME, name);
1192 +
1193 +     /* new local welcome from server, but empty - ignore
1194 +      * we do accept a new global welcome message that is empty
1195 +      */
1196 +    if (flags & WELCOME_LOCAL)
1197 +      return 0;
1198 +  }
1199 +
1200 +  /* check if there is something to change */
1201 +  /* we got a record for it */
1202 +  if (WelcomeIsSet(namearray)) {
1203 +
1204 +    /* global */
1205 +    if (!(flags & WELCOME_LOCAL)) {
1206 +
1207 +      /* myuser changes it,
1208 +       *   welcomeTS greater than or equal to timestamp, take welcomeTS+1 as timestamp
1209 +       *   else the change is not accepted upstream because of the older TS
1210 +       */
1211 +      if (MyUser(sptr) && WelcomeTS(namearray) >= timestamp)
1212 +        timestamp = WelcomeTS(namearray) +1;
1213 +
1214 +      /* compare timestamps, ignore welcome when:
1215 +       *  we got a newer one
1216 +       *  or when timestamps are the same
1217 +       *  our text is shorter or our text is 'smaller'
1218 +       */
1219 +      if ((timestamp < WelcomeTS(namearray)) ||                 /* we got a newer one */
1220 +           ((timestamp == WelcomeTS(namearray)) &&              /* same timestamp */
1221 +           ((strlen(WelcomeText(namearray)) < strlen(text)) ||  /* our text is shorter */
1222 +           (ircd_strcmp(WelcomeText(namearray), text) < 0)))) { /* our text is 'smaller' */
1223 +        /* burst or burst ack, cptr gets our version from the burst */
1224 +        if (IsBurstOrBurstAck(cptr))
1225 +          return 0;
1226 +        /* sync server */
1227 +        return welcome_resend(cptr, nameint, namearray);
1228 +      }
1229 +
1230 +    /* local welcome - we use our idea of the time */
1231 +    } else
1232 +      timestamp = TStime();
1233 +
1234 +    /* new global welcome from my user or local welcome
1235 +     *   compare new message with old message
1236 +     */
1237 +    if (IsUser(sptr) && (MyUser(sptr) || (flags & WELCOME_LOCAL))) {
1238 +      if (ircd_strcmp(text, WelcomeText(namearray)) == 0) {
1239 +        sendcmdto_one(&me, CMD_NOTICE, sptr,
1240 +          "%C :WELCOME: Cannot change %s message for %s - nothing to change",
1241 +          sptr, (flags & WELCOME_LOCAL) ? "local" : "global", name);
1242 +        return 0;
1243 +      }
1244 +    }
1245 +  }
1246 +
1247 +  /* do not insert for last global/local entry and when not set yet */
1248 +  if ((flags & WELCOME_INSERT) && ((!WelcomeIsSet(namearray)) || (nameint == max)))
1249 +    flags &= ~WELCOME_INSERT;
1250 +
1251 +  /* unset */
1252 +  if (EmptyString(text)) {
1253 +    /* clear insert flag,
1254 +     * when this flag is set, welcome_unset() assumes it is being called from welcome_insert()
1255 +     * and wont propagate the change
1256 +     */
1257 +    flags &= ~WELCOME_INSERT;
1258 +    return welcome_unset(cptr, sptr, nameint, namearray, timestamp, who, flags);
1259 +  }
1260 +
1261 +  /* insert */
1262 +  if (flags & WELCOME_INSERT)
1263 +    return welcome_insert(cptr, sptr, nameint, namearray, timestamp, who, text, flags);
1264 +
1265 +  /* new or change */
1266 +  return welcome_set(cptr, sptr, nameint, namearray, timestamp, who, text, flags);
1267 +}
1268 +
1269 +
1270 +/** Announce a welcome message to local clients.
1271 + * @param[in] name Welcome message to announce.
1272 + */
1273 +void
1274 +welcome_announce(int name)
1275 +{
1276 +  struct Client *acptr;
1277 +  struct MsgBuf *msgbuf;
1278 +  int i;
1279 +
1280 +  /* valid range, set and not empty */
1281 +  assert(WelcomeIsValid(name));
1282 +  assert(WelcomeIsSet(name));
1283 +  assert(!WelcomeIsEmpty(name));
1284 +
1285 +  /* TODO: target is $* as if it were a global broadcast
1286 +   * could make it $servername for local message announcement
1287 +   * but the type is shown between [ ] already
1288 +   * either [Network] or [servername] - using $* is just shorter.
1289 +   */
1290 +  /* build msgbuf */
1291 +  msgbuf = msgq_make(0, ":%C %s $* :[%s] %s", &me, MSG_NOTICE,
1292 +    name >= WELCOME_MAX_ENTRIES ? cli_name(&me) : feature_str(FEAT_NETWORK),
1293 +    WelcomeText(name));
1294 +
1295 +  /* go over local clients */
1296 +  for (i = HighestFd; i > 0; --i) {
1297 +
1298 +    /* skip unregistered clients, skip servers */
1299 +    if (!(acptr = LocalClientArray[i]) || !IsRegistered(acptr) || IsServer(acptr))
1300 +      continue;
1301 +
1302 +    /* send it away */
1303 +    send_buffer(acptr, msgbuf, 0);
1304 +  }
1305 +}
1306 +
1307 +
1308 +/** Send the full list of welcome message to \a cptr.
1309 + * @param[in] cptr Local server to send welcomes to.
1310 + */
1311 +void
1312 +welcome_burst(struct Client *cptr)
1313 +{
1314 +  int name;
1315 +
1316 +  assert(NULL != cptr);
1317 +
1318 +  /* loop over global entries - 0 to max - 1*/
1319 +  for (name = 0; name <= WELCOME_MAX_ENTRIES - 1; name++) {
1320 +    if (WelcomeIsSet(name))
1321 +      sendcmdto_one(&me, CMD_WELCOME, cptr, "* %d %Tu %s :%s",
1322 +        name + 1, WelcomeTS(name), WelcomeWho(name), WelcomeText(name));
1323 +  }
1324 +}
1325 +
1326 +
1327 +/** List welcome messages.
1328 + * @param[in] sptr Client requesting the listing.
1329 + * @param[in] connect When non zero do not report no welcome is set
1330 + * @return Zero.
1331 + */
1332 +int
1333 +welcome_list(struct Client *sptr, int connect)
1334 +{
1335 +  int found = 0, local = 0, name;
1336 +
1337 +  assert(NULL != sptr);
1338 +
1339 +  /* loop over all entries - range 0 to 2 * max - 1 */
1340 +  for (name = 0; name <= 2 * WELCOME_MAX_ENTRIES - 1; name++) {
1341 +
1342 +    /* local entries now */
1343 +    if (name == WELCOME_MAX_ENTRIES)
1344 +      local = 1;
1345 +
1346 +    /* not set or empty - skip */
1347 +    if (!WelcomeIsSet(name) || WelcomeIsEmpty(name))
1348 +      continue;
1349 +
1350 +    /* got one */
1351 +    found++;
1352 +    sendcmdto_one(&me, CMD_NOTICE, sptr, "%C :[%s] %s",
1353 +      sptr, local ? cli_name(&me) : feature_str(FEAT_NETWORK), WelcomeText(name));
1354 +  }
1355 +
1356 +  /* nothing set */
1357 +  if (!found && !connect)
1358 +    sendcmdto_one(&me, CMD_NOTICE, sptr, "%C :No welcome message set.", sptr);
1359 +
1360 +  return 0;
1361 +}
1362 +
1363 +
1364 +/** Statistics callback to list Welcome messages.
1365 + * @param[in] sptr Client requesting statistics.
1366 + * @param[in] sd Stats descriptor for request (ignored).
1367 + * @param[in] param Extra parameter from user (ignored).
1368 + */
1369 +void
1370 +welcome_stats(struct Client *sptr, const struct StatDesc *sd, char *param)
1371 +{
1372 +  int name, local = 0;
1373 +
1374 +  assert(NULL != sptr);
1375 +
1376 +  /* loop over all entries - range 0 to 2 * max - 1*/
1377 +  for (name = 0; name <= 2 * WELCOME_MAX_ENTRIES - 1; name++) {
1378 +
1379 +    /* local entries now */
1380 +    if (name == WELCOME_MAX_ENTRIES)
1381 +      local = 1;
1382 +
1383 +    /* not set */
1384 +    if (!WelcomeIsSet(name))
1385 +      continue;
1386 +
1387 +    /* send it */
1388 +    send_reply(sptr, RPL_STATSWELCOME,
1389 +      local ? name + 1 - WELCOME_MAX_ENTRIES : name + 1,
1390 +      local ? cli_name(&me) : "*",
1391 +      WelcomeWho(name), WelcomeTS(name),
1392 +      WelcomeIsEmpty(name) ? "<Empty>" : WelcomeText(name));
1393 +  }
1394 +}