Add welcome message functionality.
+To inform our users about events we currently have 3 means at our disposal.
+
+Outside of IRC like our website and other external/3rd party means such as facebook/twitter/whatever.
+I never visit the website, and I cannot imagine many people do just so they wont miss that lonely newspost every couple of months.
+(If it were an RSS newsfeed, then maybe it would reach more people..., but that's a different topic altogether.)
+
+Within the IRC world there are two ways to mass relay information to users.
+
+The first is the MOTD (Message of the Day).
+This is a misleading name, it simply is a text file played to connecting clients, and in practice never changes
+(our MOTDs display outdated information, and done so for years..., but again, that's a different topic altogether).
+The MOTD cannot be altered from IRC, so it cannot be used to inform users about upcoming events or news.
+
+The second are message on IRC sent to many recipients,
+broadcasts to all users on the network/server/country/host,
+and WALLUSERS to all users with mode +w set.
+They are not suitable to inform users about upcoming events or news:
+
+They only reach users which are connected at that time, and not everyone is connected to IRC all the time.
+Doing a broadcast one time a few days in advance and again a few minutes in advance, simply does not reach all of our users.
+Doing multiple broadcasts to make up of this, is annoying for users
+(as seen in the past when several broadcasts were made for a tutorial session) and thus not an option.
+
+Broadcasts are rather intrusive, and sending many of them probably wont be appreciated,
+leading to people adding the service(s) to ignore or filtering them.
+
+WALLUSERS is only received by a very small portion of our userbase, 1 to 2% of users on the network have set mode +w.
+We could make +w a default usermode (opt-out instead of opt-in), but we are left with the same problem as with broadcasts.
+
+
+We need a way to be able to announce news to all users,
+in a timely manner straight from IRC (so not the website, not the MOTD),
+in a non-intrusive way with a message on connect, and when people want to see it by command (so not broadcasts or wallusers).
+
+This is where WELCOME comes in.
+Messages set on IRC.
+Messages set per server (mostly for maintenance) or global (for news/pr/and such).
+Messages announced to connecting clients, and shown when users use /welcome.
+
+
+Why not use a service for this?
+Implemented in the IRCd it only uses local traffic, that is from server to client,
+instead of traffic over server links from service to server, and then server to client.
+Implemented in the IRCd it is not affected by netsplits as it would when done by a service.
+
+
+(But even if this patch is accepted, it will not be on quakenet any time soon.
+So it may still be worth it to create service for this in the mean time.)
+
+
+
+
+
client commands:
user:
-/WELCOME
+/WELCOME [<server>]
shows welcome messages set, same is shown on connect
+feature HIS_REMOTE controls whether ordinary users can request a listing from a remote server
-oper:
-/WELCOME [<target>] [[!]<name> :<message>]
+operator:
+/WELCOME [<server>] [[$][!][+|-]<N> :<message>]
to view welcome messages from a remote server
to set a local welcome message on this server or a remote server
-set a global welcome message (target *)
-the ! prefix makes the server annouce the welcome message to its clients when setting
+set a global welcome message (server *)
+the $ prefix makes the server annouce the welcome message to its clients when setting
+the ! prefix forces the change, bypassing lastmod checks
+the + prefix moves message in N and all after that one spot down, and inserts the new message
+in spot N, if there is no room, the last entry is deleted
+the - prefix is used when an entry is cleared (no text), then all entries after it are moved on place up, so all empty
+spots are at the end (this prefix is always used when an oper clears the text)
server:
-:<source> WE <target> [[!]<name> <timestamp> <who> :<text>]
+:<source> WE <target> [[$][!][+|-]<N> <timestamp> <lastmod> <who> :<text>]
who is who set the message, the server puts in the opername when a client sets it.
-:<name> is a number 1 to WELCOME_MAX_ENTRIES - currently set at 10 (should be more than we ever need)
+:<N> is a number 1 to WELCOME_MAX_ENTRIES - currently set at 10 (should be more than we ever need)
that means there is room for 10 local and 10 global entries
STATS W/welcome (/STATS w/userload made case sensitive)
-:server 230 nick W Name Target Who Timestamp :Message
-:server 227 nick W 1 * opername 1233072583 :Latest news: testing this welcome patch :)
-:server 227 nick W 2 * opername 1233072583 :
-:server 227 nick W 1 servername opername 1233072590 :This is a test server, expect restarts.
+:server 227 nick W # Target Who Timestamp LastMod :Text
+:server 227 nick W 1 * opername 1233072583 1233072583 :Latest news: testing this welcome patch :)
+:server 227 nick W 2 * opername 1233072583 1233072583 :
+:server 227 nick W 1 servername opername 1233072590 1233072590 :This is a test server, expect restarts.
:server 219 nick W :End of /STATS report
listing welcomes or on connect:
:server NOTICE nick :[QuakeNet] Latest news: testing this welcome patch :)
:server NOTICE nick :[server] This is a test server, expect restarts.
-announcement is done by a notice by the local server to $* with the same message
+announcement is done by a notice by the local server to $* ($servername for local) with the same message
format as for listing welcome messages.
:server NOTICE $* :[QuakeNet] Latest news: testing this welcome patch :)
-:server NOTICE $* :[server] This is a test server, expect restarts.
+:server NOTICE $server :[server] This is a test server, expect restarts.
+
Files:
include/handlers.h
-add m_welcome mo_welcome ms_welcome mh_welcome functions
+add m_welcome mo_welcome ms_welcome functions
include/features.h
ircd/features.c
ircd/s_user.c
add showing of welcome messages on connect
+ircd/s_debug.c
+add count and memusage of welcome messages
+
include/client.h
ircd/client.c
ircd/ircd_lexer.l
ircd/ircd_parser.y
add PRIV_LOCAL_WELCOME PRIV_WELCOME
-diff -r a9b437e961ec include/client.h
---- a/include/client.h
-+++ b/include/client.h
+diff -r 530975e1fd87 include/client.h
+--- a/include/client.h Sat Jul 20 15:39:54 2013 +0100
++++ b/include/client.h Sat Jul 20 15:40:27 2013 +0100
@@ -142,6 +142,8 @@
PRIV_USER_PRIVACY, /* oper can bypass user privacy +x etc gives i.e. see real ip's */
- PRIV_CHANNEL_PRIVACY, /* oper can bypass channel privacy i.e. can see modes on channels they are not on and channel keys */
+ PRIV_CHANNEL_PRIVACY, /* oper can bypass channel privacy i.e. can see modes on channels they are not on and channel keys */
PRIV_SERVERINFO, /* oper can use /get, /stats, /hash, retrieve remote information */
+ PRIV_WELCOME, /* oper can WELCOME */
+ PRIV_LOCAL_WELCOME, /* oper can local WELCOME */
PRIV_LAST_PRIV /**< number of privileges */
};
-diff -r a9b437e961ec include/handlers.h
---- a/include/handlers.h
-+++ b/include/handlers.h
-@@ -138,6 +138,7 @@
+diff -r 530975e1fd87 include/handlers.h
+--- a/include/handlers.h Sat Jul 20 15:39:54 2013 +0100
++++ b/include/handlers.h Sat Jul 20 15:40:27 2013 +0100
+@@ -139,6 +139,7 @@
extern int m_version(struct Client*, struct Client*, int, char*[]);
extern int m_wallchops(struct Client*, struct Client*, int, char*[]);
extern int m_wallvoices(struct Client*, struct Client*, int, char*[]);
extern int m_who(struct Client*, struct Client*, int, char*[]);
extern int m_whois(struct Client*, struct Client*, int, char*[]);
extern int m_whowas(struct Client*, struct Client*, int, char*[]);
-@@ -172,6 +173,7 @@
+@@ -173,6 +174,7 @@
extern int mo_version(struct Client*, struct Client*, int, char*[]);
extern int mo_wallops(struct Client*, struct Client*, int, char*[]);
extern int mo_wallusers(struct Client*, struct Client*, int, char*[]);
extern int mo_xquery(struct Client*, struct Client*, int, char*[]);
extern int mr_error(struct Client*, struct Client*, int, char*[]);
extern int mr_error(struct Client*, struct Client*, int, char*[]);
-@@ -230,6 +232,7 @@
+@@ -232,6 +234,7 @@
extern int ms_wallops(struct Client*, struct Client*, int, char*[]);
extern int ms_wallusers(struct Client*, struct Client*, int, char*[]);
extern int ms_wallvoices(struct Client*, struct Client*, int, char*[]);
extern int ms_whois(struct Client*, struct Client*, int, char*[]);
extern int ms_xquery(struct Client*, struct Client*, int, char*[]);
extern int ms_xreply(struct Client*, struct Client*, int, char*[]);
-diff -r a9b437e961ec include/ircd_features.h
---- a/include/ircd_features.h
-+++ b/include/ircd_features.h
+diff -r 530975e1fd87 include/ircd_features.h
+--- a/include/ircd_features.h Sat Jul 20 15:39:54 2013 +0100
++++ b/include/ircd_features.h Sat Jul 20 15:40:27 2013 +0100
@@ -101,6 +101,7 @@
FEAT_IRCD_RES_TIMEOUT,
FEAT_AUTH_TIMEOUT,
FEAT_HIS_STATS_w,
FEAT_HIS_STATS_x,
FEAT_HIS_STATS_y,
-diff -r a9b437e961ec include/msg.h
---- a/include/msg.h
-+++ b/include/msg.h
-@@ -196,6 +196,10 @@
+diff -r 530975e1fd87 include/msg.h
+--- a/include/msg.h Sat Jul 20 15:39:54 2013 +0100
++++ b/include/msg.h Sat Jul 20 15:40:27 2013 +0100
+@@ -201,6 +201,10 @@
#define TOK_NOTICE "O"
#define CMD_NOTICE MSG_NOTICE, TOK_NOTICE
#define MSG_WALLCHOPS "WALLCHOPS" /* WC */
#define TOK_WALLCHOPS "WC"
#define CMD_WALLCHOPS MSG_WALLCHOPS, TOK_WALLCHOPS
-diff -r a9b437e961ec include/numeric.h
---- a/include/numeric.h
-+++ b/include/numeric.h
+diff -r 530975e1fd87 include/numeric.h
+--- a/include/numeric.h Sat Jul 20 15:39:54 2013 +0100
++++ b/include/numeric.h Sat Jul 20 15:40:27 2013 +0100
@@ -116,6 +116,7 @@
RPL_STATSGLINE 227 Dalnet
RPL_STATSVLINE 227 unreal */
#define ERR_SILELISTFULL 511 /* Undernet extension */
/* ERR_NOTIFYFULL 512 aircd */
/* ERR_TOOMANYWATCH 512 Numeric List: Dalnet */
-diff -r a9b437e961ec include/welcome.h
---- /dev/null
-+++ b/include/welcome.h
-@@ -0,0 +1,63 @@
+diff -r 530975e1fd87 include/welcome.h
+--- /dev/null Thu Jan 01 00:00:00 1970 +0000
++++ b/include/welcome.h Sat Jul 20 15:40:27 2013 +0100
+@@ -0,0 +1,86 @@
+#ifndef INCLUDED_welcome_h
+#define INCLUDED_welcome_h
+/*
+/** @file
+ * @brief Interface and declarations for welcome message handling.
+ */
-+#ifndef INCLUDED_sys_types_h
-+#include <sys/types.h>
-+#define INCLUDED_sys_types_h
-+#endif
+
+struct Client;
+struct StatDesc;
+
+/* Maximum number of welcome entries (per type; X global, X local) */
+#define WELCOME_MAX_ENTRIES 10
-+/* Maximum length of a welcome message */
-+#define WELCOMELEN TOPICLEN
-+/* Maximum timestamp drift in seconds allowed ahead of our idea of nettime
-+ * before we throw a warning to ops
++/* Maximum length of a welcome message
++ * the maximum value for this is 300
++ * when set larger, this could lead to truncation when announcing
++ * ":server.name NOTICE $server.name :[server.name] text"
++ * 510 - (1+63+1+6+1+1+63+1+1+1+63+1+1) = 306 for text
++ * max length of a servername is 63 HOSTLEN
+ */
-+#define WELCOME_MAX_DRIFT 600
++#define WELCOMELEN 300
++
++
++/* Test if a welcome entry is in a valid range */
++#define WelcomeArrayIsValid(x) ((unsigned) (x) <= 2 * WELCOME_MAX_ENTRIES -1)
++/* Test if a welcome name is in a valid range */
++#define WelcomeNameIsValid(x) ((unsigned) (x) <= WELCOME_MAX_ENTRIES)
++/* Test if a welcome entry is set */
++#define WelcomeIsSet(x) (WelcomeArray[(x)].lastmod > 0)
++/* Test if a welcome entry is empty */
++#define WelcomeIsEmpty(x) (*WelcomeArray[(x)].text == 0)
++
++/* Get welcome create timestamp */
++#define WelcomeCreate(x) (WelcomeArray[(x)].create)
++/* Get welcome lastmod timestamp */
++#define WelcomeLastMod(x) (WelcomeArray[(x)].lastmod)
++/* Get welcome who info */
++#define WelcomeWho(x) (WelcomeArray[(x)].who)
++/* Get welcome text */
++#define WelcomeText(x) (WelcomeArray[(x)].text)
++
+
+/* Describes a Welcome message entry. */
+struct Welcome {
-+ time_t timestamp; /**< Timestamp of the welcome */
++ time_t create; /**< When it was set */
++ time_t lastmod; /**< Last modification timestamp (used for resolving conflicts in burst) */
+ char text[WELCOMELEN + 1]; /**< Message */
+ char who[ACCOUNTLEN + 1]; /**< Who set it */
+};
+
+/** Welcome type flags */
-+#define WELCOME_LOCAL 0x01 /**< welcome is local */
++#define WELCOME_LOCAL 0x01 /**< welcome is local */
+/** Welcome action flags */
-+#define WELCOME_ANNOUNCE 0x02 /**< announce change to users */
-+#define WELCOME_INSERT 0x04 /**< insert welcome message, move down all others one place */
++#define WELCOME_ANNOUNCE 0x02 /**< announce new welcome to users */
++#define WELCOME_UNSET 0x04 /**< unset welcome */
++#define WELCOME_INSERT 0x08 /**< insert welcome message, move down all others one place */
++#define WELCOME_DELETE 0x10 /**< delete welcome message, move up all others one place */
++#define WELCOME_INCLASTMOD 0x20 /**< increase lastmod if needed */
++#define WELCOME_FORCE 0x40 /**< force change, bypass lastmod check */
+
+extern int welcome_do(struct Client *cptr, struct Client *sptr, char *name,
-+ time_t timestamp, char *who, char *text, unsigned int flags);
-+extern void welcome_announce(int name);
++ time_t create, time_t lastmod, char *who, char *text, unsigned int flags);
+extern void welcome_burst(struct Client *cptr);
+extern int welcome_list(struct Client *sptr, int connect);
+extern void welcome_stats(struct Client *sptr, const struct StatDesc *sd, char *param);
++extern int welcome_memory_count(size_t *we_size);
+
+#endif /* INCLUDED_welcome_h */
-diff -r a9b437e961ec ircd/Makefile.in
---- a/ircd/Makefile.in
-+++ b/ircd/Makefile.in
-@@ -186,6 +186,7 @@
- m_wallops.c \
+diff -r 530975e1fd87 ircd/Makefile.in
+--- a/ircd/Makefile.in Sat Jul 20 15:39:54 2013 +0100
++++ b/ircd/Makefile.in Sat Jul 20 15:40:27 2013 +0100
+@@ -188,6 +188,7 @@
m_wallusers.c \
m_wallvoices.c \
-+ m_welcome.c \
+ m_webirc.c \
++ m_welcome.c \
m_who.c \
m_whois.c \
m_whowas.c \
-@@ -215,6 +216,7 @@
+@@ -217,6 +218,7 @@
send.c \
uping.c \
userload.c \
whocmds.c \
whowas.c \
y.tab.c
-@@ -1161,6 +1163,11 @@
+@@ -1163,6 +1165,11 @@
../include/ircd_reply.h ../include/ircd_string.h \
../include/ircd_chattr.h ../include/msg.h ../include/numeric.h \
../include/numnicks.h ../include/s_user.h ../include/send.h
m_who.o: m_who.c ../config.h ../include/channel.h ../include/ircd_defs.h \
../include/res.h ../config.h ../include/client.h ../include/dbuf.h \
../include/msgq.h ../include/ircd_events.h ../include/ircd_handler.h \
-@@ -1422,6 +1429,13 @@
+@@ -1424,6 +1431,13 @@
../include/numnicks.h ../include/querycmds.h ../include/ircd_features.h \
../include/s_misc.h ../include/s_stats.h ../include/send.h \
../include/struct.h ../include/sys.h
whocmds.o: whocmds.c ../config.h ../include/whocmds.h \
../include/channel.h ../include/ircd_defs.h ../include/res.h \
../config.h ../include/client.h ../include/dbuf.h ../include/msgq.h \
-diff -r a9b437e961ec ircd/client.c
---- a/ircd/client.c
-+++ b/ircd/client.c
+diff -r 530975e1fd87 ircd/client.c
+--- a/ircd/client.c Sat Jul 20 15:39:54 2013 +0100
++++ b/ircd/client.c Sat Jul 20 15:40:27 2013 +0100
@@ -177,6 +177,7 @@
FlagSet(&privs_local, PRIV_WHOX);
FlagSet(&privs_local, PRIV_DISPLAY);
#undef P
{ 0, 0 }
};
-diff -r a9b437e961ec ircd/ircd_features.c
---- a/ircd/ircd_features.c
-+++ b/ircd/ircd_features.c
+diff -r 530975e1fd87 ircd/ircd_features.c
+--- a/ircd/ircd_features.c Sat Jul 20 15:39:54 2013 +0100
++++ b/ircd/ircd_features.c Sat Jul 20 15:40:27 2013 +0100
@@ -366,6 +366,7 @@
F_I(IRCD_RES_TIMEOUT, 0, 4, 0),
F_I(AUTH_TIMEOUT, 0, 9, 0),
F_B(HIS_STATS_w, 0, 1, 0),
F_B(HIS_STATS_x, 0, 1, 0),
F_B(HIS_STATS_y, 0, 1, 0),
-diff -r a9b437e961ec ircd/ircd_lexer.l
---- a/ircd/ircd_lexer.l
-+++ b/ircd/ircd_lexer.l
+diff -r 530975e1fd87 ircd/ircd_lexer.l
+--- a/ircd/ircd_lexer.l Sat Jul 20 15:39:54 2013 +0100
++++ b/ircd/ircd_lexer.l Sat Jul 20 15:40:27 2013 +0100
@@ -166,6 +166,8 @@
{ "serverinfo", TPRIV_SERVERINFO },
{ "user_privacy", TPRIV_USER_PRIVACY },
{ NULL, 0 }
};
static int ntokens;
-diff -r a9b437e961ec ircd/ircd_parser.y
---- a/ircd/ircd_parser.y
-+++ b/ircd/ircd_parser.y
+diff -r 530975e1fd87 ircd/ircd_parser.y
+--- a/ircd/ircd_parser.y Sat Jul 20 15:39:54 2013 +0100
++++ b/ircd/ircd_parser.y Sat Jul 20 15:40:27 2013 +0100
@@ -189,6 +189,7 @@
%token TPRIV_CHANSERV TPRIV_XTRA_OPER TPRIV_NOIDLE TPRIV_FREEFORM TPRIV_PARANOID
%token TPRIV_CHECK TPRIV_WALL TPRIV_CLOSE TPRIV_ROUTE TPRIV_ROUTEINFO TPRIV_SERVERINFO
+ TPRIV_LOCAL_WELCOME { $$ = PRIV_LOCAL_WELCOME; } |
+ TPRIV_WELCOME { $$ = PRIV_WELCOME; } |
TPRIV_PARANOID { $$ = PRIV_PARANOID; } ;
- yesorno: YES { $$ = 1; } | NO { $$ = 0; };
-diff -r a9b437e961ec ircd/m_welcome.c
---- /dev/null
-+++ b/ircd/m_welcome.c
-@@ -0,0 +1,296 @@
+ yesorno: YES { $$ = 1; } | NO { $$ = 0; };
+diff -r 530975e1fd87 ircd/m_welcome.c
+--- /dev/null Thu Jan 01 00:00:00 1970 +0000
++++ b/ircd/m_welcome.c Sat Jul 20 15:40:27 2013 +0100
+@@ -0,0 +1,360 @@
+/*
+ * IRC - Internet Relay Chat, ircd/m_welcome.c
+ * Copyright (C) 1990 Jarkko Oikarinen and
+ * note: it is guaranteed that parv[0]..parv[parc-1] are all
+ * non-NULL pointers.
+ */
-+#include "config.h"
+
-+#include "channel.h"
+#include "client.h"
-+#include "hash.h"
+#include "ircd.h"
+#include "ircd_features.h"
-+#include "ircd_log.h"
-+#include "ircd_reply.h"
-+#include "ircd_snprintf.h"
-+#include "ircd_string.h"
+#include "msg.h"
+#include "numeric.h"
-+#include "numnicks.h"
+#include "s_user.h"
-+#include "send.h"
+#include "welcome.h"
+
-+/* #include <assert.h> -- Now using assert in ircd_log.h */
+
+/*
+ * m_welcome - local generic message handler
+ *
-+ * parv[0] = Send prefix
-+ * parv[1] = [remote server to query]
++ *
++ * WELCOME
++ *
++ * listing:
++ * parv[0] = Send prefix
++ *
++ *
++ * WELCOME [<server>]
++ *
++ * remote listing:
++ * parv[0] = Send prefix
++ * parv[1] = Target
++ *
+ */
+int m_welcome(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
+{
+/*
+ * mo_welcome - oper message handler
+ *
++ *
++ * WELCOME
++ *
+ * listing:
-+ * parv[0] = Send prefix
++ * parv[0] = Send prefix
++ *
++ *
++ * WELCOME <server>
+ *
+ * remote listing:
-+ * parv[0] = Send prefix
-+ * parv[1] = Target
++ * parv[0] = Send prefix
++ * parv[1] = Target
++ *
++ *
++ * WELCOME <server> <name> :<text>
+ *
+ * set global or on remote server:
-+ * parv[0] = Send prefix
-+ * parv[1] = Target: server or * for global (or left out for this server)
-+ * parv[2] = Name
-+ * parv[3] = Text
++ * parv[0] = Send prefix
++ * parv[1] = Target: server or * for global (or left out for this server)
++ * parv[2] = Name
++ * parv[parc - 1] = Text
++ *
+ */
+int mo_welcome(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
+{
+ char *target, *name, *who, *text, pattern[BUFSIZE];
-+ time_t timestamp;
++ time_t create, lastmod;
+ unsigned int flags = 0;
+ int local = 0;
+
+ target = parv[1];
+ name = parv[2];
+ }
-+ timestamp = TStime();
++ create = TStime();
++ lastmod = TStime();
+ who = cli_user(sptr)->opername;
+ text = parv[parc - 1];
+
+ if (!(target[0] == '*' && target[1] == '\0') && !local) {
+
+ /* build a pattern for hunt_server_cmd since we do not have all we need in parv */
-+ ircd_snprintf(0, pattern, sizeof(pattern), "%s %s %Tu %s :%s", "%C", name, timestamp, who, text);
++ ircd_snprintf(0, pattern, sizeof(pattern), "%s %s %Tu %Tu %s :%s", "%C", name, create, lastmod, who, text);
+ if (hunt_server_cmd(sptr, CMD_WELCOME, cptr, 0, pattern, 1, 2, parv) != HUNTED_ISME)
+ return 0;
+
+ flags |= WELCOME_LOCAL;
+ }
+
-+ /* TODO: disallow global announcement from oper?
-+ * as PRIVMSG/NOTICE to $* is not allowed either by the ircd
-+ * when PRIV for that is added, use that here? PRIV_BROADCAST or something
-+ *
-+ * change prefix to $ ?
-+ */
+ /* check for anounce prefix */
++ if (*name == '$') {
++ name++;
++ /* only allow announce by oper for local welcome */
++ if (flags & WELCOME_LOCAL)
++ flags |= WELCOME_ANNOUNCE;
++ }
++
++ /* check for force prefix */
+ if (*name == '!') {
+ name++;
-+ flags |= WELCOME_ANNOUNCE;
++ flags |= WELCOME_FORCE;
+ }
+
+ /* check for insert prefix */
+ flags |= WELCOME_INSERT;
+ }
+
++ /* check for delete prefix */
++ else if (*name == '-') {
++ name++;
++ flags |= WELCOME_DELETE;
++ }
++
++ /* empty text, set unset and delete flag */
++ if (*text == 0) {
++ flags |= WELCOME_UNSET;
++ flags |= WELCOME_DELETE;
++ }
++
+ /* and do it */
-+ return welcome_do(cptr, sptr, name, timestamp, who, text, flags);
++ return welcome_do(cptr, sptr, name, create, lastmod, who, text, flags);
+}
+
+
+/*
+ * ms_welcome - server message handler
+ *
-+ * parv[0] = Send prefix
-+ * parv[1] = Target: server numeric or * for global
-+ * parv[2] = Name
-+ * parv[3] = Timestamp
-+ * parv[4] = Who
-+ * parv[5] = Text
++ *
++ * <source> WE <target>
++ *
++ * remote listing:
++ * parv[0] = Send prefix
++ * parv[1] = Target: server numeric or * for global
++ *
++ *
++ * <source> WE <target> <name> <create> <lastmod> <who> :<text>
++ *
++ * set global or on remote server:
++ * parv[0] = Send prefix
++ * parv[1] = Target: server numeric or * for global
++ * parv[2] = Name
++ * parv[3] = Create
++ * parv[4] = LastMod
++ * parv[5] = Who
++ * parv[parc - 1] = Text
++ *
+ */
+int ms_welcome(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
+{
+ char *target, *name, *who, *text;
-+ time_t timestamp;
++ time_t create, lastmod;
+ unsigned int flags = 0;
+
+ /* not enough - complain */
+ if (parc < 2) {
-+ protocol_violation(sptr, "Too few parameters for WELCOME (got %d - need 2)", parc);
++ protocol_violation(cptr, "Received too few parameters for WELCOME from %C (got %d - need 2)", sptr, parc);
+ return need_more_params(sptr, "WELCOME");
+ }
+
+ /* remote listing request, see if it is for me or a remote server */
+ if (parc == 2) {
+ if (IsServer(sptr))
-+ return protocol_violation(cptr, "WELCOME listing request from server %C", sptr);
++ return protocol_violation(cptr, "Received WELCOME listing request from server %C", sptr);
+ if (hunt_server_cmd(sptr, CMD_WELCOME, cptr, 0, "%C", 1, parc, parv) != HUNTED_ISME)
+ return 0;
+ return welcome_list(sptr, 0);
+ }
+
-+ /* we need at least 6 parameters to continue - complain */
-+ if (parc < 6) {
-+ protocol_violation(sptr, "Too few parameters for WELCOME (got %d - need 6)", parc);
++ /* we need at least 7 parameters to continue - complain */
++ if (parc < 7) {
++ protocol_violation(cptr, "Received too few parameters for WELCOME from %C (got %d - need 7)", sptr, parc);
+ return need_more_params(sptr, "WELCOME");
+ }
+
+ /* set the parameters */
+ target = parv[1];
+ name = parv[2];
-+ timestamp = atoi(parv[3]);
-+ who = parv[4];
++ create = atoi(parv[3]);
++ lastmod = atoi(parv[4]);
++ who = parv[5];
+ text = parv[parc - 1]; /* parse reason as last parameter */
+
++ /* check if create is valid - create is 0 but parv[3] is not */
++ if (create == 0 && !(parv[3][0] == '0' && parv[3][1] == '\0'))
++ return protocol_violation(cptr, "Received WELCOME with invalid create timestamp %s from %C", parv[3], sptr);
++
++ /* check if lastmod is valid - lastmod is 0 but parv[4] is not */
++ if (lastmod == 0 && !(parv[4][0] == '0' && parv[4][1] == '\0'))
++ return protocol_violation(cptr, "Received WELCOME with invalid lastmod timestamp %s from %C", parv[4], sptr);
++
+ /* target is not global */
+ if (!(target[0] == '*' && target[1] == '\0')) {
+
+ /* not for me, and forward it */
-+ if (hunt_server_cmd(sptr, CMD_WELCOME, cptr, 0, "%C %s %s %s :%s", 1, parc, parv) != HUNTED_ISME)
++ if (hunt_server_cmd(sptr, CMD_WELCOME, cptr, 0, "%C %s %s %s %s :%s", 1, parc, parv) != HUNTED_ISME)
+ return 0;
+
+ /* local welcome for me */
+ }
+
+ /* check for anounce prefix */
-+ if (*name == '!') {
++ if (*name == '$') {
+ name++;
+ flags |= WELCOME_ANNOUNCE;
+ }
+
++ /* check for force prefix */
++ if (*name == '!') {
++ name++;
++ flags |= WELCOME_FORCE;
++ }
++
+ /* check for insert prefix */
+ if (*name == '+') {
+ name++;
+ flags |= WELCOME_INSERT;
+ }
+
++ /* check for delete prefix */
++ else if (*name == '-') {
++ name++;
++ flags |= WELCOME_DELETE;
++ }
++
++ /* empty text, set unset flag */
++ if (*text == 0)
++ flags |= WELCOME_UNSET;
++
+ /* and do it */
-+ return welcome_do(cptr, sptr, name, timestamp, who, text, flags);
++ return welcome_do(cptr, sptr, name, create, lastmod, who, text, flags);
+}
-diff -r a9b437e961ec ircd/parse.c
---- a/ircd/parse.c
-+++ b/ircd/parse.c
-@@ -661,6 +661,15 @@
+diff -r 530975e1fd87 ircd/parse.c
+--- a/ircd/parse.c Sat Jul 20 15:39:54 2013 +0100
++++ b/ircd/parse.c Sat Jul 20 15:40:27 2013 +0100
+@@ -675,6 +675,15 @@
/* UNREG, CLIENT, SERVER, OPER, SERVICE */
{ m_unregistered, m_not_oper, ms_check, mo_check, m_ignore }
},
/* This command is an alias for QUIT during the unregistered part of
* of the server. This is because someone jumping via a broken web
-diff -r a9b437e961ec ircd/s_err.c
---- a/ircd/s_err.c
-+++ b/ircd/s_err.c
+diff -r 530975e1fd87 ircd/s_debug.c
+--- a/ircd/s_debug.c Sat Jul 20 15:39:54 2013 +0100
++++ b/ircd/s_debug.c Sat Jul 20 15:40:27 2013 +0100
+@@ -50,6 +50,7 @@
+ #include "send.h"
+ #include "struct.h"
+ #include "sys.h"
++#include "welcome.h"
+ #include "whowas.h"
+
+ /* #include <assert.h> -- Now using assert in ircd_log.h */
+@@ -231,7 +232,8 @@
+ aw = 0, /* aways set */
+ wwa = 0, /* whowas aways */
+ gl = 0, /* glines */
+- ju = 0; /* jupes */
++ ju = 0, /* jupes */
++ we = 0; /* welcomes */
+
+ size_t chm = 0, /* memory used by channels */
+ chbm = 0, /* memory used by channel bans */
+@@ -244,6 +246,7 @@
+ wwm = 0, /* whowas array memory used */
+ glm = 0, /* memory used by glines */
+ jum = 0, /* memory used by jupes */
++ wem = 0, /* memory used by welcomes */
+ com = 0, /* memory used by conf lines */
+ dbufs_allocated = 0, /* memory used by dbufs */
+ dbufs_used = 0, /* memory used by dbufs */
+@@ -351,6 +354,10 @@
+ send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
+ ":Glines %d(%zu) Jupes %d(%zu)", gl, glm, ju, jum);
+
++ we = welcome_memory_count(&wem);
++ send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
++ ":Welcomes %d(%zu)", we, wem);
++
+ send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
+ ":Hash: client %d(%zu), chan is the same", HASHSIZE,
+ sizeof(void *) * HASHSIZE);
+diff -r 530975e1fd87 ircd/s_err.c
+--- a/ircd/s_err.c Sat Jul 20 15:39:54 2013 +0100
++++ b/ircd/s_err.c Sat Jul 20 15:40:27 2013 +0100
@@ -486,7 +486,7 @@
/* 226 */
{ RPL_STATSALINE, "%s", "226" },
/* 227 */
- { 0 },
-+ { RPL_STATSWELCOME, "W %d %s %s %Tu :%s", "227" },
++ { RPL_STATSWELCOME, "W %d %s %s %Tu %Tu :%s", "227" },
/* 228 */
{ RPL_STATSQLINE, "Q %s :%s", "228" },
/* 229 */
/* 510 */
{ 0 },
/* 511 */
-diff -r a9b437e961ec ircd/s_serv.c
---- a/ircd/s_serv.c
-+++ b/ircd/s_serv.c
+diff -r 530975e1fd87 ircd/s_serv.c
+--- a/ircd/s_serv.c Sat Jul 20 15:39:54 2013 +0100
++++ b/ircd/s_serv.c Sat Jul 20 15:40:27 2013 +0100
@@ -57,6 +57,7 @@
#include "struct.h"
#include "sys.h"
/*
* Pass on my client information to the new server
-diff -r a9b437e961ec ircd/s_stats.c
---- a/ircd/s_stats.c
-+++ b/ircd/s_stats.c
+diff -r 530975e1fd87 ircd/s_stats.c
+--- a/ircd/s_stats.c Sat Jul 20 15:39:54 2013 +0100
++++ b/ircd/s_stats.c Sat Jul 20 15:40:27 2013 +0100
@@ -54,6 +54,7 @@
#include "send.h"
#include "struct.h"
#include <stdio.h>
#include <stdlib.h>
-@@ -654,9 +655,12 @@
+@@ -650,9 +651,12 @@
{ 'V', "vserversmach", (STAT_FLAG_OPERFEAT | STAT_FLAG_VARPARAM | STAT_FLAG_CASESENS), FEAT_HIS_STATS_v,
stats_servers_verbose, 0,
"Verbose server information." },
{ 'x', "memusage", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_x,
stats_meminfo, 0,
"List usage information." },
-diff -r a9b437e961ec ircd/s_user.c
---- a/ircd/s_user.c
-+++ b/ircd/s_user.c
+diff -r 530975e1fd87 ircd/s_user.c
+--- a/ircd/s_user.c Sat Jul 20 15:39:54 2013 +0100
++++ b/ircd/s_user.c Sat Jul 20 15:40:27 2013 +0100
@@ -63,6 +63,7 @@
#include "userload.h"
#include "version.h"
#include "handlers.h" /* m_motd and m_lusers */
-@@ -410,6 +411,9 @@
- cli_info(sptr), NumNick(cptr) /* two %s's */);
+@@ -402,6 +403,10 @@
IPcheck_connect_succeeded(sptr);
-+
+
++ /* send welcome */
+ if (feature_bool(FEAT_WELCOME))
+ welcome_list(sptr, 1);
- }
- else {
- struct Client *acptr = user->server;
-diff -r a9b437e961ec ircd/welcome.c
---- /dev/null
-+++ b/ircd/welcome.c
-@@ -0,0 +1,585 @@
++
+ /* TODO: */
+ /* apply auto sethost if needed */
+ apply_spoofblock(sptr);
+diff -r 530975e1fd87 ircd/welcome.c
+--- /dev/null Thu Jan 01 00:00:00 1970 +0000
++++ b/ircd/welcome.c Sat Jul 20 15:40:27 2013 +0100
+@@ -0,0 +1,877 @@
+/*
+ * IRC - Internet Relay Chat, ircd/welcome.c
+ * Copyright (C) 1990 Jarkko Oikarinen and
+/** @file
+ * @brief Implementation of welcome message handling functions.
+ */
-+#include "config.h"
+
+#include "client.h"
-+#include "hash.h"
+#include "ircd.h"
-+#include "ircd_alloc.h"
+#include "ircd_features.h"
+#include "ircd_log.h"
+#include "ircd_reply.h"
+#include "ircd_string.h"
-+#include "match.h"
+#include "msg.h"
+#include "numeric.h"
-+#include "numnicks.h"
+#include "s_bsd.h"
+#include "s_debug.h"
-+#include "s_misc.h"
+#include "send.h"
-+#include "struct.h"
-+#include "sys.h" /* FALSE bleah */
+#include "welcome.h"
+
-+/* #include <assert.h> -- Now using assert in ircd_log.h */
-+#include <string.h>
-+
+
+/** List of welcome messages - first MAX for global, second MAX for local */
+static struct Welcome WelcomeArray[WELCOME_MAX_ENTRIES * 2] = { { 0 } };
+ * @param[in] name Name of the welcome message.
+ * @param[in] text The welcome message.
+ * @param[in] who Who set it.
-+ * @param[in] timestamp When it was set.
++ * @param[in] create When it was set.
++ * @param[in] lastmod Last modification timestamp.
+ * @return name Array number of the welcome set.
+ */
+static int
-+welcome_make(int name, char *text, char *who, time_t timestamp)
++welcome_make(int name, char *text, char *who, time_t create, time_t lastmod, unsigned int flags)
+{
-+ /* range 0 to 2 * max - 1 */
-+ assert(name >= 0 && name <= 2 * WELCOME_MAX_ENTRIES - 1);
++
++ /* assert */
++ assert(WelcomeArrayIsValid(name));
++ assert(NULL != text);
++ assert(NULL != who);
++ assert(flags & WELCOME_FORCE || lastmod > 0); /* lastmod must not be 0 unless forced */
++ assert(flags & WELCOME_LOCAL ||
++ flags & WELCOME_FORCE ||
++ lastmod >= WelcomeLastMod(name)); /* lastmod may not decrease for global welcome unless forced */
++
++ /* debug */
++ Debug((DEBUG_DEBUG, "welcome_make(name=%d, text=\"%s\", who=%s, create=%Tu, lastmod=%Tu, "
++ "FLAGS(0x%04x): local=%s announce=%s force=%s unset=%s insert=%s delete=%s inclastmod=%s)",
++ name, text, who, create, lastmod, flags,
++ (flags & WELCOME_LOCAL) ? "yes" : "no",
++ (flags & WELCOME_ANNOUNCE) ? "yes" : "no",
++ (flags & WELCOME_FORCE) ? "yes" : "no",
++ (flags & WELCOME_UNSET) ? "yes" : "no",
++ (flags & WELCOME_INSERT) ? "yes" : "no",
++ (flags & WELCOME_DELETE) ? "yes" : "no",
++ (flags & WELCOME_INCLASTMOD) ? "yes" : "no"));
++
++ /* forced and lastmod is zero, clear text and who */
++ if (flags & WELCOME_FORCE && lastmod == 0) {
++ text = "";
++ who = "";
++ }
+
+ /* store it */
+ ircd_strncpy(WelcomeArray[name].text, text, WELCOMELEN);
+ ircd_strncpy(WelcomeArray[name].who, who, ACCOUNTLEN);
-+ WelcomeArray[name].timestamp = timestamp;
++
++ if (flags & WELCOME_INCLASTMOD && /* take current lastmod+1 if needed */
++ !(flags & WELCOME_FORCE) && /* not forced */
++ WelcomeLastMod(name) >= lastmod) /* current lastmod greater or equal than lastmod */
++ WelcomeArray[name].lastmod = WelcomeLastMod(name) +1;
++ else
++ WelcomeArray[name].lastmod = lastmod;
++
++ WelcomeArray[name].create = create;
+
+ return name;
+}
+ * @param[in] cptr Local client that sent us the welcome.
+ * @param[in] sptr Originator of the welcome.
+ * @param[in] nameint Name of the message.
-+ * @param[in] timestamp Timestamp of when the message was set.
++ * @param[in] create When it was set.
++ * @param[in] lastmod Last modification timestamp.
+ * @param[in] who Who set this message.
+ * @param[in] text The welcome message.
+ * @param[in] flags Flags to set on welcome.
+ */
+int
+welcome_propagate(struct Client *cptr, struct Client *sptr, int nameint,
-+ time_t timestamp, char *who, char *text, unsigned int flags)
++ time_t create, time_t lastmod, char *who, char *text, unsigned int flags)
++{
++ /* assert */
++ assert(NULL != sptr);
++ assert(NULL != cptr);
++ assert(WelcomeNameIsValid(nameint));
++ assert(lastmod > 0 || flags & WELCOME_FORCE); /* lastmod must not be 0 unless forced */
++ assert(!(flags & WELCOME_LOCAL)); /* must not be local */
++
++ sendcmdto_serv_butone(sptr, CMD_WELCOME, cptr, "* %s%s%s%s%d %Tu %Tu %s :%s",
++ (flags & WELCOME_ANNOUNCE) ? "$" : "",
++ (flags & WELCOME_FORCE) ? "!" : "",
++ (flags & WELCOME_INSERT) ? "+" : "",
++ (flags & WELCOME_DELETE) ? "-" : "",
++ nameint, create, lastmod, who, text);
++
++ return 0;
++}
++
++
++/** Resend a welcome message.
++ * @param[in] cptr Local client that sent us the welcome.
++ * @param[in] nameint Name of the message.
++ * @param[in] namearray Name of the array item.
++ * @param[in] flags Flags to set on welcome.
++ * @return Zero
++ */
++int
++welcome_resend(struct Client *cptr, int nameint, int namearray, unsigned int flags)
+{
-+ /* must be global */
-+ assert(!(flags & WELCOME_LOCAL));
+
-+ sendcmdto_serv_butone(sptr, CMD_WELCOME, cptr, "* %s%s%d %Tu %s :%s",
-+ (flags & WELCOME_ANNOUNCE) ? "!" : "", (flags & WELCOME_INSERT) ? "+" : "",
-+ nameint, timestamp, who, text);
++ int name; /* loop variable */
++
++ /* assert */
++ assert(NULL != cptr);
++ assert(IsServer(cptr));
++ assert(WelcomeNameIsValid(nameint));
++ assert(WelcomeArrayIsValid(namearray));
++ assert(nameint - 1 == namearray);
++ assert(!(flags & WELCOME_LOCAL)); /* must not be local */
++ assert(!(flags & WELCOME_FORCE)); /* must not be forced */
++
++ /* send our version */
++ sendcmdto_one(&me, CMD_WELCOME, cptr, "* %d %Tu %Tu %s :%s",
++ nameint,
++ WelcomeCreate(namearray), WelcomeLastMod(namearray),
++ WelcomeWho(namearray), WelcomeText(namearray));
++
++ /* bad welcome did not have insert or delete prefix */
++ if (!(flags & (WELCOME_INSERT|WELCOME_DELETE)))
++ return 0;
++
++ /* loop over global entries - namearray +1 to max - 1 */
++ for (name = namearray +1; name <= WELCOME_MAX_ENTRIES - 1; name++) {
++
++ /* not set, force it to be unset on the other end */
++ if (!WelcomeIsSet(name))
++ sendcmdto_one(&me, CMD_WELCOME, cptr, "* !%d 0 0 0 :", name +1);
++
++ /* set, force change here too
++ * other side may have this lastmod+1, without force it would be ignored
++ */
++ else
++ sendcmdto_one(&me, CMD_WELCOME, cptr, "* !%d %Tu %Tu %s :%s",
++ name +1,
++ WelcomeCreate(name), WelcomeLastMod(name),
++ WelcomeWho(name), WelcomeText(name));
++ }
+
+ return 0;
+}
+/** Log a welcome message.
+ * @param[in] sptr Originator of the welcome.
+ * @param[in] msg The message to show.
-+ * @param[in] who Who set this message.
+ * @param[in] flags Flags to set on welcome.
+ * @return Zero
+ */
+int
-+welcome_log(struct Client *sptr, char *msg, char *who, unsigned int flags)
++welcome_log(struct Client *sptr, char *msg, unsigned int flags)
+{
++ /* assert */
++ assert(NULL != sptr);
++ assert(NULL != msg);
+
+ /* inform ops */
+ sendto_opmask_butone(0, SNO_OLDSNO, "%s %s",
+ get_client_name_and_opername(sptr) : cli_name((cli_user(sptr))->server), msg);
+
+ /* log it */
-+ log_write(LS_NETWORK, L_INFO, LOG_NOSNOTICE, "%#C (%s) %s", sptr, who, msg);
++ log_write(LS_NETWORK, L_INFO, LOG_NOSNOTICE, "%s %s", get_client_name_and_opername(sptr), msg);
+
-+ /* welcome by remote user, inform oper of success */
-+ if ((flags & WELCOME_LOCAL) && IsUser(sptr) && !MyUser(sptr)) {
++ /* welcome by remote oper, inform of success */
++ if ((flags & WELCOME_LOCAL) && IsUser(sptr) && !MyConnect(sptr)) {
+ sendcmdto_one(&me, CMD_NOTICE, sptr, "%C :%s %s",
+ sptr, get_client_name_and_opername(sptr), msg);
+
+}
+
+
++/** Announce a welcome message to local clients.
++ * @param[in] name Welcome message to announce.
++ * @param[in] flags Flags to set on welcome.
++ */
++void
++welcome_announce(int name, unsigned int flags)
++{
++ struct Client *acptr; /* local user */
++ struct MsgBuf *msgbuf; /* message to send */
++ int i; /* loop variable */
++
++ /* assert */
++ assert(flags & WELCOME_ANNOUNCE);
++ assert(WelcomeArrayIsValid(name));
++ assert(WelcomeIsSet(name));
++ assert(!WelcomeIsEmpty(name));
++
++ /* build msgbuf */
++ msgbuf = msgq_make(0, ":%C %s $%s :[%s] %s", &me, MSG_NOTICE,
++ (flags & WELCOME_LOCAL) ? cli_name(&me) : "*",
++ (flags & WELCOME_LOCAL) ? cli_name(&me) : feature_str(FEAT_NETWORK),
++ WelcomeText(name));
++
++ /* go over local clients */
++ for (i = HighestFd; i > 0; --i) {
++
++ /* skip unregistered clients, skip servers */
++ if (!(acptr = LocalClientArray[i]) || !IsRegistered(acptr) || IsServer(acptr))
++ continue;
++
++ /* send it away */
++ send_buffer(acptr, msgbuf, 0);
++ }
++}
++
++
+/** Set a welcome message.
+ * @param[in] cptr Local client that sent us the welcome.
+ * @param[in] sptr Originator of the welcome.
+ * @param[in] nameint Name of the message.
+ * @param[in] namearray Array entry.
-+ * @param[in] timestamp Timestamp of when the message was set.
++ * @param[in] create When it was set.
++ * @param[in] lastmod Last modification timestamp.
+ * @param[in] who Who set this message.
+ * @param[in] text The message.
+ * @param[in] flags Flags to set on welcome.
+ */
+int
+welcome_set(struct Client *cptr, struct Client *sptr, int nameint,
-+ int namearray, time_t timestamp, char *who, char *text, unsigned int flags)
++ int namearray, time_t create, time_t lastmod, char *who, char *text, unsigned int flags)
+{
+ char msg[BUFSIZE]; /* msg for logging */
-+ int new = 0;
++ int new = 0; /* welcome is new - not set yet */
++
++ /* assert */
++ assert(NULL != cptr);
++ assert(NULL != sptr);
++ assert(WelcomeNameIsValid(nameint));
++ assert(WelcomeArrayIsValid(namearray));
++ assert(lastmod > 0 || flags & WELCOME_FORCE); /* lastmod must not be 0 unless forced */
++ assert(NULL != who);
++ assert(NULL != text);
++ assert(!(flags & WELCOME_UNSET)); /* must not be unset */
+
+ /* debug */
-+ Debug((DEBUG_DEBUG, "welcome_set(\"%s\", \"%s\", %d, %d, %Tu, \"%s\", \"%s\", 0x%04x)",
-+ cli_name(cptr), cli_name(sptr), nameint, namearray, timestamp, who, text, flags));
++ Debug((DEBUG_DEBUG, "welcome_set(cptr=%s, sptr=%s, nameint=%d, namearray=%d, "
++ "create=%Tu, lastmod=%Tu, who=%s, text=\"%s\", "
++ "FLAGS(0x%04x): local=%s announce=%s force=%s unset=%s insert=%s delete=%s)",
++ cli_name(cptr), cli_name(sptr), nameint, namearray, create, lastmod, who, text, flags,
++ (flags & WELCOME_LOCAL) ? "yes" : "no",
++ (flags & WELCOME_ANNOUNCE) ? "yes" : "no",
++ (flags & WELCOME_FORCE) ? "yes" : "no",
++ (flags & WELCOME_UNSET) ? "yes" : "no",
++ (flags & WELCOME_INSERT) ? "yes" : "no",
++ (flags & WELCOME_DELETE) ? "yes" : "no"));
+
+ /* not set */
-+ if (*WelcomeArray[namearray].text == 0)
++ if (WelcomeIsEmpty(namearray))
+ new = 1;
+
+ /* update */
-+ welcome_make(namearray, text, who, timestamp);
++ welcome_make(namearray, text, who, create, lastmod, flags);
+
+ /* create msg for log */
-+ ircd_snprintf(0, msg, 0, "%s%s%s WELCOME %d \"%s\" [%Tu]",
++ ircd_snprintf(0, msg, 0, "%s%s%s%s WELCOME %d \"%s\" %s [%Tu]",
++ (flags & WELCOME_FORCE) ? "force " : "",
+ new ? "setting" : "changing",
+ (flags & WELCOME_ANNOUNCE) ? " and announcing " : " ",
+ (flags & WELCOME_LOCAL) ? "local" : "global",
-+ nameint, text, timestamp);
++ nameint, WelcomeText(namearray), WelcomeWho(namearray), create);
+
+ /* log it */
-+ welcome_log(sptr, msg, who, flags);
++ welcome_log(sptr, msg, flags);
+
+ /* propagate it */
+ if (!(flags & WELCOME_LOCAL))
-+ welcome_propagate(cptr, sptr, nameint, timestamp, who, text, flags);
++ welcome_propagate(cptr, sptr, nameint, create, lastmod, who, text, flags);
+
+ /* announce it */
+ if (flags & WELCOME_ANNOUNCE)
-+ welcome_announce(namearray);
++ welcome_announce(namearray, flags);
+
+ return 0;
+}
+ * @param[in] sptr Originator of the welcome.
+ * @param[in] nameint Name of the message.
+ * @param[in] namearray Array entry.
-+ * @param[in] timestamp Timestamp of when the message was set.
++ * @param[in] create When it was set.
++ * @param[in] lastmod Last modification timestamp.
+ * @param[in] who Who set this message.
+ * @param[in] flags Flags to set on welcome.
+ * @return Zero
+ */
+int
+welcome_unset(struct Client *cptr, struct Client *sptr, int nameint,
-+ int namearray, time_t timestamp, char *who, unsigned int flags)
++ int namearray, time_t create, time_t lastmod, char *who, unsigned int flags)
+{
+ char msg[BUFSIZE]; /* msg for logging */
-+ char text[WELCOMELEN + 1]; /* save old text */
-+ int i; /* loop variable */
-+ int empty = namearray; /* first empty spot in array after arrayname */
-+ int end = WELCOME_MAX_ENTRIES -1; /* last element to check in array */
+
-+ /* debug */
-+ Debug((DEBUG_DEBUG, "welcome_unset(\"%s\", \"%s\", %d, %d, %Tu, \"%s\", 0x%04x)",
-+ cli_name(cptr), cli_name(sptr), nameint, namearray, timestamp, who, flags));
-+
-+ /* save text */
-+ ircd_strncpy(text, WelcomeArray[namearray].text, WELCOMELEN);
++ /* assert */
++ assert(NULL != cptr);
++ assert(NULL != sptr);
++ assert(WelcomeNameIsValid(nameint));
++ assert(WelcomeArrayIsValid(namearray));
++ assert(lastmod > 0 || flags & WELCOME_FORCE); /* lastmod must not be 0 unless forced */
++ assert(NULL != who);
++ assert(flags & (WELCOME_UNSET|WELCOME_INSERT|WELCOME_DELETE)); /* must be unset, insert or delete */
+
-+ /* update */
-+ welcome_make(namearray, "", who, timestamp);
++ /* debug */
++ Debug((DEBUG_DEBUG, "welcome_unset(cptr=%s, sptr=%s, nameint=%d, namearray=%d, "
++ "create=%Tu, lastmod=%Tu, who=%s, "
++ "FLAGS(0x%04x): local=%s announce=%s force=%s unset=%s insert=%s delete=%s)",
++ cli_name(cptr), cli_name(sptr), nameint, namearray, create, lastmod, who, flags,
++ (flags & WELCOME_LOCAL) ? "yes" : "no",
++ (flags & WELCOME_ANNOUNCE) ? "yes" : "no",
++ (flags & WELCOME_FORCE) ? "yes" : "no",
++ (flags & WELCOME_UNSET) ? "yes" : "no",
++ (flags & WELCOME_INSERT) ? "yes" : "no",
++ (flags & WELCOME_DELETE) ? "yes" : "no"));
+
+ /* create msg for log */
-+ ircd_snprintf(0, msg, 0, "unsetting %s WELCOME %d \"%s\" [%Tu]",
-+ (flags & WELCOME_LOCAL) ? "local" : "global", nameint, text, timestamp);
++ ircd_snprintf(0, msg, 0, "%sunsetting %s WELCOME %d \"%s\" %s [%Tu]",
++ (flags & WELCOME_FORCE) ? "force " : "",
++ (flags & WELCOME_LOCAL) ? "local" : "global",
++ nameint, WelcomeText(namearray), WelcomeWho(namearray), create);
+
-+ /* log it */
-+ welcome_log(sptr, msg, who, flags);
++ /* log it but only if it was set
++ * welcome unset could have crossed with another welcome unset,
++ * still need to update lastmod
++ * can be a forced unset on a welcome that is not set
++ */
++ if (!WelcomeIsEmpty(namearray))
++ welcome_log(sptr, msg, flags);
++
++ /* update,
++ * not when inserting, welcome_insert() handles that by calling welcome_set()
++ * not when deleting, welcome_delete() handles that
++ */
++ if (!(flags & (WELCOME_INSERT|WELCOME_DELETE)))
++ welcome_make(namearray, "", who, create, lastmod, flags);
+
+ /* propagate it, but not when inserting */
+ if (!(flags & (WELCOME_LOCAL|WELCOME_INSERT)))
-+ welcome_propagate(cptr, sptr, nameint, timestamp, who, "", flags);
-+
-+ /* correct end for local offset */
-+ if (flags & WELCOME_LOCAL)
-+ end += WELCOME_MAX_ENTRIES;
-+
-+ /* move entries up, update timestamp */
-+ for (i = namearray; i < end; i++)
-+ welcome_make(i, WelcomeArray[i+1].text, WelcomeArray[i+1].who, timestamp);
-+
-+ /* clear last entry, update timestamp */
-+ welcome_make(end, "", who, timestamp);
++ welcome_propagate(cptr, sptr, nameint, create, lastmod, who, "", flags);
+
+ return 0;
+}
+ * @param[in] sptr Originator of the welcome.
+ * @param[in] nameint Name of the message.
+ * @param[in] namearray Array entry.
-+ * @param[in] timestamp Timestamp of when the message was set.
++ * @param[in] create When it was set.
++ * @param[in] lastmod Last modification timestamp.
+ * @param[in] who Who set this message.
+ * @param[in] text The welcome message.
+ * @param[in] flags Flags to set on welcome.
+ */
+int
+welcome_insert(struct Client *cptr, struct Client *sptr, int nameint,
-+ int namearray, time_t timestamp, char *who, char *text, unsigned int flags)
++ int namearray, time_t create, time_t lastmod, char *who, char *text, unsigned int flags)
+{
+ char msg[BUFSIZE]; /* msg for logging */
+ int i; /* loop variable */
-+ int empty = -1; /* first empty spot in array after arrayname */
++ int empty = -1; /* first empty spot in array after namearray */
+ int end = WELCOME_MAX_ENTRIES -1; /* last element to check in array */
+ int last = end; /* last welcome message to feed to welcome_unset */
+
++ /* assert */
++ assert(NULL != cptr);
++ assert(NULL != sptr);
++ assert(WelcomeNameIsValid(nameint));
++ assert(WelcomeArrayIsValid(namearray));
++ assert(lastmod > 0 || flags & WELCOME_FORCE); /* lastmod must not be 0 unless forced */
++ assert(NULL != who);
++ assert(NULL != text);
++ assert(flags & WELCOME_INSERT); /* must be insert */
++
+ /* debug */
-+ Debug((DEBUG_DEBUG, "welcome_insert(\"%s\", \"%s\", %d, %d, %Tu, \"%s\", \"%s\", 0x%04x)",
-+ cli_name(cptr), cli_name(sptr), nameint, namearray, timestamp, who, text, flags));
++ Debug((DEBUG_DEBUG, "welcome_insert(cptr=%s, sptr=%s, nameint=%d, namearray=%d, "
++ "create=%Tu, lastmod=%Tu, who=%s, text=\"%s\", "
++ "FLAGS(0x%04x): local=%s announce=%s force=%s unset=%s insert=%s delete=%s)",
++ cli_name(cptr), cli_name(sptr), nameint, namearray, create, lastmod, who, text, flags,
++ (flags & WELCOME_LOCAL) ? "yes" : "no",
++ (flags & WELCOME_ANNOUNCE) ? "yes" : "no",
++ (flags & WELCOME_FORCE) ? "yes" : "no",
++ (flags & WELCOME_UNSET) ? "yes" : "no",
++ (flags & WELCOME_INSERT) ? "yes" : "no",
++ (flags & WELCOME_DELETE) ? "yes" : "no"));
+
+ /* correct end for local offset */
+ if (flags & WELCOME_LOCAL)
+
+ /* find first empty spot */
+ for (i = namearray; i <= end; i++) {
-+ if (*WelcomeArray[i].text == 0) {
++ if (WelcomeIsEmpty(i)) {
+ empty = i;
+ break;
+ }
+
+ /* no empty spot, need to unset last */
+ if (empty == -1) {
-+ welcome_unset(cptr, sptr, end, namearray, timestamp, who, flags);
++ welcome_unset(cptr, sptr, end +1, end, create, lastmod, who, flags);
+ empty = end;
+ }
+
-+ /* move entries down, update timestamp */
++ /* move entries down, update lastmod */
+ for (i = empty; i > namearray; i--)
-+ welcome_make(i, WelcomeArray[i-1].text, WelcomeArray[i-1].who, timestamp);
++ welcome_make(i, WelcomeText(i-1), WelcomeWho(i-1), WelcomeCreate(i-1),
++ lastmod, flags | WELCOME_INCLASTMOD);
+
+ /* correct empty for local offset */
+ if (flags & WELCOME_LOCAL)
+ (flags & WELCOME_LOCAL) ? "local" : "global", nameint, (empty - nameint > 1) ? "to" : "and" , empty);
+
+ /* log it */
-+ welcome_log(sptr, msg, who, flags);
++ welcome_log(sptr, msg, flags);
+
+ /* set it */
-+ welcome_set(cptr, sptr, nameint, namearray, timestamp, who, text, flags);
++ welcome_set(cptr, sptr, nameint, namearray, create, lastmod, who, text, flags);
++
++ return 0;
++}
++
++
++/** Delete a welcome message.
++ * @param[in] cptr Local client that sent us the welcome.
++ * @param[in] sptr Originator of the welcome.
++ * @param[in] nameint Name of the message.
++ * @param[in] namearray Array entry.
++ * @param[in] create When it was set.
++ * @param[in] lastmod Last modification timestamp.
++ * @param[in] who Who set this message.
++ * @param[in] flags Flags to set on welcome.
++ * @return Zero
++ */
++int
++welcome_delete(struct Client *cptr, struct Client *sptr, int nameint,
++ int namearray, time_t create, time_t lastmod, char *who, unsigned int flags)
++{
++ int i; /* loop variable */
++ int empty = namearray; /* first empty spot in array after namearray */
++ int end = WELCOME_MAX_ENTRIES -1; /* last element to check in array */
++
++ /* assert */
++ assert(NULL != cptr);
++ assert(NULL != sptr);
++ assert(WelcomeNameIsValid(nameint));
++ assert(WelcomeArrayIsValid(namearray));
++ assert(lastmod > 0 || flags & WELCOME_FORCE); /* lastmod must not be 0 unless forced */
++ assert(NULL != who);
++ assert(flags & WELCOME_UNSET); /* must be unset */
++ assert(flags & WELCOME_DELETE); /* must be delete */
++
++ /* debug */
++ Debug((DEBUG_DEBUG, "welcome_delete(cptr=%s, sptr=%s, nameint=%d, namearray=%d, "
++ "create=%Tu, lastmod=%Tu, who=%s, "
++ "FLAGS(0x%04x): local=%s announce=%s force=%s unset=%s insert=%s delete=%s)",
++ cli_name(cptr), cli_name(sptr), nameint, namearray, create, lastmod, who, flags,
++ (flags & WELCOME_LOCAL) ? "yes" : "no",
++ (flags & WELCOME_ANNOUNCE) ? "yes" : "no",
++ (flags & WELCOME_FORCE) ? "yes" : "no",
++ (flags & WELCOME_UNSET) ? "yes" : "no",
++ (flags & WELCOME_INSERT) ? "yes" : "no",
++ (flags & WELCOME_DELETE) ? "yes" : "no"));
++
++ /* unset it */
++ welcome_unset(cptr, sptr, nameint, namearray, create, lastmod, who, flags);
++
++ /* correct end for local offset */
++ if (flags & WELCOME_LOCAL)
++ end += WELCOME_MAX_ENTRIES;
++
++ /* move entries up, update lastmod */
++ for (i = namearray; i < end; i++) {
++ if (!WelcomeIsSet(i+1))
++ break;
++ welcome_make(i, WelcomeText(i+1), WelcomeWho(i+1), WelcomeCreate(i+1),
++ lastmod, flags | WELCOME_INCLASTMOD);
++ }
++
++ /* clear last entry */
++ if (i == end)
++ welcome_make(i, "", who, create, lastmod, flags | WELCOME_INCLASTMOD);
++
++ /* nothing was moved, clear entry */
++ if (i == namearray)
++ welcome_make(i, "", who, create, lastmod, flags);
+
+ return 0;
+}
+ * @param[in] cptr Local client that sent us the welcome.
+ * @param[in] sptr Originator of the welcome.
+ * @param[in] name Name of the message.
-+ * @param[in] timestamp Timestamp of when the message was set.
++ * @param[in] create When it was set.
++ * @param[in] lastmod Last modification timestamp.
+ * @param[in] who Who set this message.
+ * @param[in] text The welcome message.
+ * @param[in] flags Flags to set on welcome.
+ */
+int
+welcome_do(struct Client *cptr, struct Client *sptr, char *name,
-+ time_t timestamp, char *who, char *text, unsigned int flags)
++ time_t create, time_t lastmod, char *who, char *text, unsigned int flags)
+{
+ int nameint = atoi(name); /* transform to int */
+ int namearray = nameint - 1; /* used to test the array element */
-+ static time_t rate; /* rate limit snomask message */
++ int start = 0; /* this is the first server setting this welcome message from a user */
+
++ /* assert */
+ assert(NULL != cptr);
+ assert(NULL != sptr);
+ assert(NULL != name);
+ assert(NULL != who);
+
+ /* debug */
-+ Debug((DEBUG_DEBUG, "welcome_do(\"%s\", \"%s\", \"%s\", %Tu, \"%s\", \"%s\", 0x%04x)",
-+ cli_name(cptr), cli_name(sptr), name, timestamp, who, text, flags));
++ Debug((DEBUG_DEBUG, "welcome_do(cptr=%s, sptr=%s, name=%s, "
++ "create=%Tu, lastmod=%Tu, who=%s, text=\"%s\", "
++ "FLAGS(0x%04x): local=%s announce=%s force=%s unset=%s insert=%s delete=%s)",
++ cli_name(cptr), cli_name(sptr), name, create, lastmod, who, text, flags,
++ (flags & WELCOME_LOCAL) ? "yes" : "no",
++ (flags & WELCOME_ANNOUNCE) ? "yes" : "no",
++ (flags & WELCOME_FORCE) ? "yes" : "no",
++ (flags & WELCOME_UNSET) ? "yes" : "no",
++ (flags & WELCOME_INSERT) ? "yes" : "no",
++ (flags & WELCOME_DELETE) ? "yes" : "no"));
++
++ /* welcome from my user, or a local welcome from a local/remote user */
++ start = (IsUser(sptr) && (MyConnect(sptr) || flags & WELCOME_LOCAL));
+
+ /* name empty after taking off the prefixes? */
-+ if (EmptyString(name)) {
-+ if (IsUser(sptr))
-+ sendcmdto_one(&me, CMD_NOTICE, sptr, "%C :WELCOME: No message number given", sptr);
++ if (*name == 0) {
++ if (start)
++ sendcmdto_one(&me, CMD_NOTICE, sptr, "%C :Welcome: No message number given", sptr);
+ else
-+ protocol_violation(cptr, "WELCOME: No message number given by %C", sptr);
++ protocol_violation(cptr, "Received WELCOME with no message number from %C", sptr);
+ return 0;
+ }
+
+ /* check name */
-+ if (nameint < 1 || nameint > WELCOME_MAX_ENTRIES) {
-+ if (IsUser(sptr))
++ if (!WelcomeArrayIsValid(namearray)) {
++ if (start)
+ sendcmdto_one(&me, CMD_NOTICE, sptr,
-+ "%C :WELCOME: Invalid message number %s - should between 1 and %d",
++ "%C :Welcome: Invalid message number %s - should between 1 and %d",
+ sptr, name, WELCOME_MAX_ENTRIES);
-+ else {
-+ protocol_violation(cptr, "WELCOME: Invalid message number %s from %C - should be between 1 and %d",
++ else
++ protocol_violation(cptr,
++ "Received WELCOME with invalid message number %s from %C - should be between 1 and %d",
+ name, sptr, WELCOME_MAX_ENTRIES);
-+ /* nameint greater than MAX, perhaps we are upgrading, but used extra slots too soon?
-+ * propagate it manually
-+ * TODO: cant do announce here?
-+ */
-+ if (nameint > WELCOME_MAX_ENTRIES && !(flags & WELCOME_LOCAL))
-+ welcome_propagate(cptr, sptr, nameint, timestamp, who, text, flags);
-+ }
++ return 0;
++ }
++
++ /* invalid lastmod */
++ if (lastmod <= 0) {
++ /* from my user - must be a glitch,
++ * someone set (my) network time to 0 ?
++ */
++ if (MyUser(sptr))
++ lastmod = 1;
++ /* not forced or negative, it is a protocol violation */
++ else if (!(flags & WELCOME_FORCE) || lastmod < 0)
++ return protocol_violation(cptr, "Received WELCOME with invalid lastmod timestamp %Tu from %C", lastmod, sptr);
++ }
++
++ /* source is user, and is myuser or welcome is local, check length of the message */
++ if (start && strlen(text) > WELCOMELEN) {
++ sendcmdto_one(&me, CMD_NOTICE, sptr,
++ "%C :Welcome: The message is too long with %d chars - max is %d chars",
++ sptr, strlen(text), WELCOMELEN);
++ ircd_strncpy(text, text, WELCOMELEN);
++ sendcmdto_one(&me, CMD_NOTICE, sptr,
++ "%C :Welcome: Change or truncate the message to: \"%s\"", sptr, text);
+ return 0;
+ }
+
+ namearray += WELCOME_MAX_ENTRIES;
+
+ /* must be true by now */
-+ assert(namearray >= 0 && namearray <= 2 * WELCOME_MAX_ENTRIES - 1);
++ assert(WelcomeArrayIsValid(namearray));
++ assert(WelcomeNameIsValid(nameint));
+
+ /* cannot unset welcome that is not set */
-+ if (WelcomeArray[namearray].timestamp == 0 && EmptyString(text)) {
++ if (!WelcomeIsSet(namearray) && flags & WELCOME_UNSET) {
+
+ /* from user, throw error */
-+ if (IsUser(sptr))
++ if (start)
+ return send_reply(sptr, ERR_NOSUCHWELCOME, name);
+
+ /* new local welcome from server, but empty - ignore
+
+ /* check if there is something to change */
+ /* we got a record for it */
-+ if (WelcomeArray[namearray].timestamp != 0) {
++ if (WelcomeIsSet(namearray)) {
+
-+ /* global */
-+ if (!(flags & WELCOME_LOCAL)) {
++ /* global and not forced */
++ if (!(flags & (WELCOME_LOCAL|WELCOME_FORCE))) {
+
-+ /* netburst and we got the same or a newer one
-+ *
-+ * we only use the timestamp for resolving conflicts in net burst
-+ * outside of netburst, we simply parse whatever we get
-+ * this way we will not get stuck with a welcome message set by a server
-+ * running ahead with the time
++ /* myuser changes it,
++ * WelcomeLastMod greater than or equal to lastmod, take WelcomeLastMod+1 as lastmod
++ * else the change is not accepted upstream because of the older TS
++ */
++ if (MyUser(sptr)) {
++ if (WelcomeLastMod(namearray) >= lastmod)
++ lastmod = WelcomeLastMod(namearray) +1;
++ }
++
++ /* compare lastmod, ignore welcome when:
++ * we got a newer one
++ * or when lastmod is the same and our text is 'smaller'
+ */
-+ if (IsBurstOrBurstAck(cptr) && timestamp <= WelcomeArray[namearray].timestamp)
-+ return 0;
++ else if (lastmod < WelcomeLastMod(namearray) || /* we got a newer one */
++ (lastmod == WelcomeLastMod(namearray) && /* same lastmod */
++ strcmp(WelcomeText(namearray), text) < 0)) { /* our text is 'smaller' */
++ /* burst or burst ack, cptr gets our version from the burst */
++ if (IsBurstOrBurstAck(cptr))
++ return 0;
++ /* sync server */
++ return welcome_resend(cptr, nameint, namearray, flags);
++ }
+
+ /* local welcome - we use our idea of the time */
-+ } else
-+ timestamp = TStime();
-+
-+ /* compare new message with old message */
-+ if (ircd_strcmp(text, WelcomeArray[namearray].text) == 0) {
-+ if (IsUser(sptr))
-+ sendcmdto_one(&me, CMD_NOTICE, sptr,
-+ "%C :WELCOME: Cannot change %s message for %s - nothing to change.",
-+ sptr, (flags & WELCOME_LOCAL) ? "local" : "global", name);
-+ return 0;
++ } else if (flags & WELCOME_LOCAL) {
++ create = TStime();
++ lastmod = TStime();
+ }
-+ }
+
-+ /* do not insert for last global/local entry and when not set yet */
-+ if (flags & WELCOME_INSERT) {
-+ if ((WelcomeArray[namearray].timestamp == 0) ||
-+ (!(flags & WELCOME_LOCAL) && nameint == WELCOME_MAX_ENTRIES) ||
-+ ((flags & WELCOME_LOCAL) && nameint == 2 * WELCOME_MAX_ENTRIES))
-+ flags &= ~WELCOME_INSERT;
-+ }
-+
-+ /* TODO: rate limited for what? max 10 welcome messages..? */
-+ /* possible timestamp drift - warn ops */
-+ if (timestamp - TStime() > WELCOME_MAX_DRIFT) {
-+ sendto_opmask_butone_ratelimited(0, SNO_NETWORK, &rate,
-+ "Possible timestamp drift from %C; timestamp in WELCOME message is %is ahead of time",
-+ IsServer(sptr) ? sptr : cli_user(sptr)->server, timestamp - TStime());
-+
-+ /* warn remote oper too */
-+ if (IsUser(sptr))
++ /* welcome from my user or local welcome from local/remote user
++ * compare new message with old message
++ * use strcmp instead of ircd_strcmp - oper may wish to change case
++ */
++ if (start && strcmp(text, WelcomeText(namearray)) == 0) {
+ sendcmdto_one(&me, CMD_NOTICE, sptr,
-+ "%C :Possible timestamp drift from %C; timestamp in WELCOME message is %is ahead of time",
-+ sptr, cli_user(sptr)->server, timestamp - TStime());
++ "%C :Welcome: Cannot change %s message for %s - nothing to change",
++ sptr, (flags & WELCOME_LOCAL) ? "local" : "global", name);
++ return 0;
++ }
+ }
+
-+ /* unset */
-+ if (EmptyString(text)) {
-+ /* clear insert flag,
-+ * when this flag is set, welcome_set() assumes it is being called from welcome_insert()
-+ * and wont propagate the change
-+ */
-+ flags &= ~WELCOME_INSERT;
-+ return welcome_unset(cptr, sptr, nameint, namearray, timestamp, who, flags);
++ /* welcome from my user, or local welcome from local/remote user
++ * forcing and unsetting, set create and lastmod to 0
++ * clear delete flag
++ */
++ if (start && (flags & WELCOME_FORCE) && (flags & WELCOME_UNSET)) {
++ flags &= ~WELCOME_DELETE;
++ create = 0;
++ lastmod = 0;
+ }
+
-+ /* insert */
-+ if (flags & WELCOME_INSERT)
-+ return welcome_insert(cptr, sptr, nameint, namearray, timestamp, who, text, flags);
-+
-+ /* new or change */
-+ return welcome_set(cptr, sptr, nameint, namearray, timestamp, who, text, flags);
-+}
++ /* clear insert flag
++ * when this flag is set, welcome_unset() assumes it is being called from welcome_insert()
++ * and does not propagate the change - welcome_delete() also calls welcome_unset()
++ * do not insert last global/local welcome
++ * do not insert when entry is not set
++ *
++ */
++ if (flags & WELCOME_INSERT &&
++ (flags & WELCOME_UNSET || !WelcomeIsSet(namearray) || nameint == WELCOME_MAX_ENTRIES))
++ flags &= ~WELCOME_INSERT;
+
++ /* clear delete flag when not unsetting so we do not propagate the - delete prefix */
++ if (flags & WELCOME_DELETE && !(flags & WELCOME_UNSET))
++ flags &= ~WELCOME_DELETE;
+
-+/** Announce a welcome message to local clients.
-+ * @param[in] name Welcome message to announce.
-+ */
-+void
-+welcome_announce(int name)
-+{
-+ struct Client *acptr;
-+ struct MsgBuf *msgbuf;
-+ int i;
-+
-+ /* range 0 to 2 * max - 1 */
-+ assert(name >= 0 && name <= 2 * WELCOME_MAX_ENTRIES - 1);
++ /* unset */
++ if (flags & WELCOME_UNSET) {
+
-+ /* TODO: target is $* as if it were a global broadcast
-+ * could make it $servername for local message announcement
-+ * but the type is shown between [ ] already
-+ * either [Network] or [servername] - using $* is just shorter.
-+ */
-+ /* build msgbuf */
-+ msgbuf = msgq_make(0, ":%C %s $* :[%s] %s", &me, MSG_NOTICE,
-+ name >= WELCOME_MAX_ENTRIES ? cli_name(&me) : feature_str(FEAT_NETWORK),
-+ WelcomeArray[name].text);
++ /* delete */
++ if (flags & WELCOME_DELETE)
++ return welcome_delete(cptr, sptr, nameint, namearray, create, lastmod, who, flags);
+
-+ /* go over local clients */
-+ for (i = HighestFd; i > 0; --i) {
++ /* unset */
++ return welcome_unset(cptr, sptr, nameint, namearray, create, lastmod, who, flags);
++ }
+
-+ /* skip unregistered clients - they see the message during login
-+ * skip servers
-+ */
-+ if (!(acptr = LocalClientArray[i]) || !IsRegistered(acptr) || IsServer(acptr))
-+ continue;
++ /* insert */
++ if (flags & WELCOME_INSERT)
++ return welcome_insert(cptr, sptr, nameint, namearray, create, lastmod, who, text, flags);
+
-+ /* send it away */
-+ send_buffer(acptr, msgbuf, 0);
-+ }
++ /* new or change */
++ return welcome_set(cptr, sptr, nameint, namearray, create, lastmod, who, text, flags);
+}
+
+
+void
+welcome_burst(struct Client *cptr)
+{
-+ int name;
++ int name; /* loop variable */
+
++ /* assert */
+ assert(NULL != cptr);
+
-+ /* loop over global entries - 0 to max - 1*/
++ /* loop over global entries - 0 to max - 1 */
+ for (name = 0; name <= WELCOME_MAX_ENTRIES - 1; name++) {
-+ if (WelcomeArray[name].timestamp != 0)
-+ sendcmdto_one(&me, CMD_WELCOME, cptr, "* %d %Tu %s :%s",
-+ name + 1, WelcomeArray[name].timestamp, WelcomeArray[name].who,
-+ WelcomeArray[name].text);
++ if (WelcomeIsSet(name))
++ sendcmdto_one(&me, CMD_WELCOME, cptr, "* %d %Tu %Tu %s :%s",
++ name + 1,
++ WelcomeCreate(name), WelcomeLastMod(name),
++ WelcomeWho(name), WelcomeText(name));
+ }
+}
+
+int
+welcome_list(struct Client *sptr, int connect)
+{
-+ int found = 0, local = 0, name;
++ int name; /* loop variable */
++ int found = 0; /* number of welcome messages set */
++ int local = 0; /* welcome is local or global */
+
++ /* assert */
+ assert(NULL != sptr);
+
+ /* loop over all entries - range 0 to 2 * max - 1 */
+ local = 1;
+
+ /* not set or empty - skip */
-+ /* TODO: EmptyString? */
-+ if (WelcomeArray[name].timestamp == 0 || *WelcomeArray[name].text == 0)
++ if (!WelcomeIsSet(name) || WelcomeIsEmpty(name))
+ continue;
+
+ /* got one */
+ found++;
+ sendcmdto_one(&me, CMD_NOTICE, sptr, "%C :[%s] %s",
-+ sptr, local ? cli_name(&me) : feature_str(FEAT_NETWORK), WelcomeArray[name].text);
++ sptr, local ? cli_name(&me) : feature_str(FEAT_NETWORK), WelcomeText(name));
+ }
+
+ /* nothing set */
+void
+welcome_stats(struct Client *sptr, const struct StatDesc *sd, char *param)
+{
-+ int name, local = 0;
++ int name; /* loop variable */
++ int local = 0; /* welcome is local or global */
+
++ /* assert */
+ assert(NULL != sptr);
+
-+ /* loop over all entries - range 0 to 2 * max - 1*/
++ /* stats header */
++ send_reply(sptr, SND_EXPLICIT | RPL_STATSWELCOME,
++ "W # Target Who Timestamp LastMod :Text");
++
++ /* loop over all entries - range 0 to 2 * max - 1 */
+ for (name = 0; name <= 2 * WELCOME_MAX_ENTRIES - 1; name++) {
+
+ /* local entries now */
+ local = 1;
+
+ /* not set */
-+ if (WelcomeArray[name].timestamp == 0)
++ if (!WelcomeIsSet(name))
+ continue;
+
+ /* send it */
+ send_reply(sptr, RPL_STATSWELCOME,
+ local ? name + 1 - WELCOME_MAX_ENTRIES : name + 1,
+ local ? cli_name(&me) : "*",
-+ WelcomeArray[name].who, WelcomeArray[name].timestamp,
-+ EmptyString(WelcomeArray[name].text) ? "<Empty>" : WelcomeArray[name].text);
++ WelcomeWho(name),
++ WelcomeCreate(name), WelcomeLastMod(name),
++ WelcomeIsEmpty(name) ? "<Empty>" : WelcomeText(name));
++ }
++}
++
++
++/** Count welcome messages and memory used by them.
++ * @param[out] we_size Receives total number of bytes allocated for welcomes.
++ * @return Number of welcome messages currently allocated.
++ */
++int
++welcome_memory_count(size_t *we_size)
++{
++ int name; /* loop variable */
++ unsigned int we = 0; /* number of welcome messages set */
++
++ /* loop over all entries - range 0 to 2 * max - 1 */
++ for (name = 0; name <= 2 * WELCOME_MAX_ENTRIES - 1; name++) {
++
++ /* not set */
++ if (!WelcomeIsSet(name))
++ continue;
++
++ /* count */
++ we++;
++ *we_size += WelcomeText(name) ? (strlen(WelcomeText(name)) + 1) : 0;
++ *we_size += WelcomeWho(name) ? (strlen(WelcomeWho(name)) + 1) : 0;
+ }
++ return we;
+}