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 [<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 [<server>] [[$][+]<N> :<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 (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
-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
+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> [[$][+]<N> <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.
:<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 $server :[server] This is a test server, expect restarts.
+
Files:
include/handlers.h
ircd/ircd_parser.y
add PRIV_LOCAL_WELCOME PRIV_WELCOME
-diff -r 8bf1b05cdfe7 include/client.h
---- a/include/client.h
-+++ b/include/client.h
+diff -r 9096546c6212 include/client.h
+--- a/include/client.h Sat Jul 20 12:00:51 2013 +0100
++++ b/include/client.h Sat Jul 20 12:00:55 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 8bf1b05cdfe7 include/handlers.h
---- a/include/handlers.h
-+++ b/include/handlers.h
+diff -r 9096546c6212 include/handlers.h
+--- a/include/handlers.h Sat Jul 20 12:00:51 2013 +0100
++++ b/include/handlers.h Sat Jul 20 12:00:55 2013 +0100
@@ -138,6 +138,7 @@
extern int m_version(struct Client*, struct Client*, int, char*[]);
extern int m_wallchops(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 @@
+@@ -231,6 +233,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 8bf1b05cdfe7 include/ircd_features.h
---- a/include/ircd_features.h
-+++ b/include/ircd_features.h
+diff -r 9096546c6212 include/ircd_features.h
+--- a/include/ircd_features.h Sat Jul 20 12:00:51 2013 +0100
++++ b/include/ircd_features.h Sat Jul 20 12:00:55 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 8bf1b05cdfe7 include/msg.h
---- a/include/msg.h
-+++ b/include/msg.h
+diff -r 9096546c6212 include/msg.h
+--- a/include/msg.h Sat Jul 20 12:00:51 2013 +0100
++++ b/include/msg.h Sat Jul 20 12:00:55 2013 +0100
@@ -196,6 +196,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 8bf1b05cdfe7 include/numeric.h
---- a/include/numeric.h
-+++ b/include/numeric.h
+diff -r 9096546c6212 include/numeric.h
+--- a/include/numeric.h Sat Jul 20 12:00:51 2013 +0100
++++ b/include/numeric.h Sat Jul 20 12:00:55 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 8bf1b05cdfe7 include/welcome.h
---- /dev/null
-+++ b/include/welcome.h
-@@ -0,0 +1,79 @@
+diff -r 9096546c6212 include/welcome.h
+--- /dev/null Thu Jan 01 00:00:00 1970 +0000
++++ b/include/welcome.h Sat Jul 20 12:00:55 2013 +0100
+@@ -0,0 +1,86 @@
+#ifndef INCLUDED_welcome_h
+#define INCLUDED_welcome_h
+/*
+
+/* 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 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 WELCOMELEN 300
+
+
+/* Test if a welcome entry is in a valid range */
+#define WELCOME_LOCAL 0x01 /**< welcome is local */
+/** Welcome action flags */
+#define WELCOME_ANNOUNCE 0x02 /**< announce new welcome to users */
-+#define WELCOME_INSERT 0x04 /**< insert welcome message, move down all others one place */
-+#define WELCOME_DELETE 0x08 /**< delete welcome message, move up all others one place */
-+#define WELCOME_INCLASTMOD 0x10 /**< increase lastmod if needed */
-+#define WELCOME_FORCE 0x20 /**< force change, bypass lastmod check */
++#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 create, time_t lastmod, char *who, char *text, unsigned int flags);
+extern int welcome_memory_count(size_t *we_size);
+
+#endif /* INCLUDED_welcome_h */
-diff -r 8bf1b05cdfe7 ircd/Makefile.in
---- a/ircd/Makefile.in
-+++ b/ircd/Makefile.in
-@@ -186,6 +186,7 @@
+diff -r 9096546c6212 ircd/Makefile.in
+--- a/ircd/Makefile.in Sat Jul 20 12:00:51 2013 +0100
++++ b/ircd/Makefile.in Sat Jul 20 12:00:55 2013 +0100
+@@ -187,6 +187,7 @@
m_wallops.c \
m_wallusers.c \
m_wallvoices.c \
m_who.c \
m_whois.c \
m_whowas.c \
-@@ -215,6 +216,7 @@
+@@ -216,6 +217,7 @@
send.c \
uping.c \
userload.c \
whocmds.c \
whowas.c \
y.tab.c
-@@ -1161,6 +1163,11 @@
+@@ -1162,6 +1164,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 @@
+@@ -1423,6 +1430,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 8bf1b05cdfe7 ircd/client.c
---- a/ircd/client.c
-+++ b/ircd/client.c
+diff -r 9096546c6212 ircd/client.c
+--- a/ircd/client.c Sat Jul 20 12:00:51 2013 +0100
++++ b/ircd/client.c Sat Jul 20 12:00:55 2013 +0100
@@ -177,6 +177,7 @@
FlagSet(&privs_local, PRIV_WHOX);
FlagSet(&privs_local, PRIV_DISPLAY);
#undef P
{ 0, 0 }
};
-diff -r 8bf1b05cdfe7 ircd/ircd_features.c
---- a/ircd/ircd_features.c
-+++ b/ircd/ircd_features.c
+diff -r 9096546c6212 ircd/ircd_features.c
+--- a/ircd/ircd_features.c Sat Jul 20 12:00:51 2013 +0100
++++ b/ircd/ircd_features.c Sat Jul 20 12:00:55 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 8bf1b05cdfe7 ircd/ircd_lexer.l
---- a/ircd/ircd_lexer.l
-+++ b/ircd/ircd_lexer.l
+diff -r 9096546c6212 ircd/ircd_lexer.l
+--- a/ircd/ircd_lexer.l Sat Jul 20 12:00:51 2013 +0100
++++ b/ircd/ircd_lexer.l Sat Jul 20 12:00:55 2013 +0100
@@ -166,6 +166,8 @@
{ "serverinfo", TPRIV_SERVERINFO },
{ "user_privacy", TPRIV_USER_PRIVACY },
{ NULL, 0 }
};
static int ntokens;
-diff -r 8bf1b05cdfe7 ircd/ircd_parser.y
---- a/ircd/ircd_parser.y
-+++ b/ircd/ircd_parser.y
+diff -r 9096546c6212 ircd/ircd_parser.y
+--- a/ircd/ircd_parser.y Sat Jul 20 12:00:51 2013 +0100
++++ b/ircd/ircd_parser.y Sat Jul 20 12:00:55 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 8bf1b05cdfe7 ircd/m_welcome.c
---- /dev/null
-+++ b/ircd/m_welcome.c
-@@ -0,0 +1,346 @@
+ yesorno: YES { $$ = 1; } | NO { $$ = 0; };
+diff -r 9096546c6212 ircd/m_welcome.c
+--- /dev/null Thu Jan 01 00:00:00 1970 +0000
++++ b/ircd/m_welcome.c Sat Jul 20 12:00:55 2013 +0100
+@@ -0,0 +1,360 @@
+/*
+ * IRC - Internet Relay Chat, ircd/m_welcome.c
+ * Copyright (C) 1990 Jarkko Oikarinen and
+ * parv[0] = Send prefix
+ * parv[1] = Target: server or * for global (or left out for this server)
+ * parv[2] = Name
-+ * parv[3] = Text
++ * parv[parc - 1] = Text
+ *
+ */
+int mo_welcome(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
+ flags |= WELCOME_DELETE;
+ }
+
-+ /* empty text, set WELCOME_DELETE flag */
-+ if (*text == 0)
++ /* 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, create, lastmod, who, text, flags);
+ * parv[3] = Create
+ * parv[4] = LastMod
+ * parv[5] = Who
-+ * parv[6] = Text
++ * parv[parc - 1] = Text
+ *
+ */
+int ms_welcome(struct Client* cptr, struct Client* sptr, int parc, char* parv[])
+ 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')) {
+
+ flags |= WELCOME_DELETE;
+ }
+
++ /* empty text, set unset flag */
++ if (*text == 0)
++ flags |= WELCOME_UNSET;
++
+ /* and do it */
+ return welcome_do(cptr, sptr, name, create, lastmod, who, text, flags);
+}
-diff -r 8bf1b05cdfe7 ircd/parse.c
---- a/ircd/parse.c
-+++ b/ircd/parse.c
-@@ -661,6 +661,15 @@
+diff -r 9096546c6212 ircd/parse.c
+--- a/ircd/parse.c Sat Jul 20 12:00:51 2013 +0100
++++ b/ircd/parse.c Sat Jul 20 12:00:55 2013 +0100
+@@ -668,6 +668,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 8bf1b05cdfe7 ircd/s_debug.c
---- a/ircd/s_debug.c
-+++ b/ircd/s_debug.c
+diff -r 9096546c6212 ircd/s_debug.c
+--- a/ircd/s_debug.c Sat Jul 20 12:00:51 2013 +0100
++++ b/ircd/s_debug.c Sat Jul 20 12:00:55 2013 +0100
@@ -50,6 +50,7 @@
#include "send.h"
#include "struct.h"
send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
":Hash: client %d(%zu), chan is the same", HASHSIZE,
sizeof(void *) * HASHSIZE);
-diff -r 8bf1b05cdfe7 ircd/s_err.c
---- a/ircd/s_err.c
-+++ b/ircd/s_err.c
+diff -r 9096546c6212 ircd/s_err.c
+--- a/ircd/s_err.c Sat Jul 20 12:00:51 2013 +0100
++++ b/ircd/s_err.c Sat Jul 20 12:00:55 2013 +0100
@@ -486,7 +486,7 @@
/* 226 */
{ RPL_STATSALINE, "%s", "226" },
/* 510 */
{ 0 },
/* 511 */
-diff -r 8bf1b05cdfe7 ircd/s_serv.c
---- a/ircd/s_serv.c
-+++ b/ircd/s_serv.c
+diff -r 9096546c6212 ircd/s_serv.c
+--- a/ircd/s_serv.c Sat Jul 20 12:00:51 2013 +0100
++++ b/ircd/s_serv.c Sat Jul 20 12:00:55 2013 +0100
@@ -57,6 +57,7 @@
#include "struct.h"
#include "sys.h"
/*
* Pass on my client information to the new server
-diff -r 8bf1b05cdfe7 ircd/s_stats.c
---- a/ircd/s_stats.c
-+++ b/ircd/s_stats.c
+diff -r 9096546c6212 ircd/s_stats.c
+--- a/ircd/s_stats.c Sat Jul 20 12:00:51 2013 +0100
++++ b/ircd/s_stats.c Sat Jul 20 12:00:55 2013 +0100
@@ -54,6 +54,7 @@
#include "send.h"
#include "struct.h"
{ 'x', "memusage", STAT_FLAG_OPERFEAT, FEAT_HIS_STATS_x,
stats_meminfo, 0,
"List usage information." },
-diff -r 8bf1b05cdfe7 ircd/s_user.c
---- a/ircd/s_user.c
-+++ b/ircd/s_user.c
+diff -r 9096546c6212 ircd/s_user.c
+--- a/ircd/s_user.c Sat Jul 20 12:00:51 2013 +0100
++++ b/ircd/s_user.c Sat Jul 20 12:00:55 2013 +0100
@@ -63,6 +63,7 @@
#include "userload.h"
#include "version.h"
/* TODO: */
/* apply auto sethost if needed */
apply_spoofblock(sptr);
-diff -r 8bf1b05cdfe7 ircd/welcome.c
---- /dev/null
-+++ b/ircd/welcome.c
-@@ -0,0 +1,848 @@
+diff -r 9096546c6212 ircd/welcome.c
+--- /dev/null Thu Jan 01 00:00:00 1970 +0000
++++ b/ircd/welcome.c Sat Jul 20 12:00:55 2013 +0100
+@@ -0,0 +1,877 @@
+/*
+ * IRC - Internet Relay Chat, ircd/welcome.c
+ * Copyright (C) 1990 Jarkko Oikarinen and
+ 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 */
++ 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 insert=%s delete=%s inclastmod=%s)",
++ "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"));
+ ircd_strncpy(WelcomeArray[name].text, text, WELCOMELEN);
+ ircd_strncpy(WelcomeArray[name].who, who, ACCOUNTLEN);
+
-+ if (flags & WELCOME_INCLASTMOD && /* take current lastmod+1 if needed*/
++ 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*/
++ WelcomeLastMod(name) >= lastmod) /* current lastmod greater or equal than lastmod */
+ WelcomeArray[name].lastmod = WelcomeLastMod(name) +1;
+ else
+ WelcomeArray[name].lastmod = lastmod;
+ assert(NULL != sptr);
+ assert(NULL != cptr);
+ assert(WelcomeNameIsValid(nameint));
-+ assert(lastmod >= 0);
+ assert(lastmod > 0 || flags & WELCOME_FORCE); /* lastmod must not be 0 unless forced */
+ assert(!(flags & WELCOME_LOCAL)); /* must not be local */
+
+ if (!(flags & (WELCOME_INSERT|WELCOME_DELETE)))
+ return 0;
+
-+ /* loop over global entries - nameint+1 to max - 1 */
++ /* loop over global entries - namearray +1 to max - 1 */
+ for (name = namearray +1; name <= WELCOME_MAX_ENTRIES - 1; name++) {
-+ if (!WelcomeIsSet(name)) /* not set, force */
++
++ /* 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);
-+ else /* send our version */
-+ sendcmdto_one(&me, CMD_WELCOME, cptr, "* %d %Tu %Tu %s :%s",
++
++ /* 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));
+ assert(NULL != sptr);
+ assert(WelcomeNameIsValid(nameint));
+ assert(WelcomeArrayIsValid(namearray));
-+ assert(lastmod >= 0);
+ 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(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 insert=%s delete=%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"));
+
+ welcome_make(namearray, text, who, create, lastmod, flags);
+
+ /* create msg for log */
-+ ircd_snprintf(0, msg, 0, "%s%s%s WELCOME %d \"%s\" %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",
+ assert(NULL != sptr);
+ assert(WelcomeNameIsValid(nameint));
+ assert(WelcomeArrayIsValid(namearray));
-+ assert(!WelcomeIsEmpty(namearray) || flags & WELCOME_FORCE); /* must be set unless forced */
-+ assert(lastmod >= 0);
+ 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 */
+
+ /* 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 insert=%s delete=%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\" %s [%Tu]",
++ 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 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
++ * not when inserting, welcome_insert() handles that by calling welcome_set()
+ * not when deleting, welcome_delete() handles that
+ */
+ if (!(flags & (WELCOME_INSERT|WELCOME_DELETE)))
+ assert(NULL != sptr);
+ assert(WelcomeNameIsValid(nameint));
+ assert(WelcomeArrayIsValid(namearray));
-+ assert(lastmod >= 0);
+ assert(lastmod > 0 || flags & WELCOME_FORCE); /* lastmod must not be 0 unless forced */
+ assert(NULL != who);
+ assert(NULL != text);
+ /* debug */
+ 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 insert=%s delete=%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"));
+
+ empty = end;
+ }
+
-+ /* move entries down, update lastmod - lastmod for end is already updated above */
++ /* move entries down, update lastmod */
+ for (i = empty; i > namearray; i--)
+ welcome_make(i, WelcomeText(i-1), WelcomeWho(i-1), WelcomeCreate(i-1),
+ lastmod, flags | WELCOME_INCLASTMOD);
+ assert(NULL != sptr);
+ assert(WelcomeNameIsValid(nameint));
+ assert(WelcomeArrayIsValid(namearray));
-+ assert(lastmod >= 0);
+ 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 insert=%s delete=%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"));
+
+{
+ int nameint = atoi(name); /* transform to int */
+ int namearray = nameint - 1; /* used to test the array element */
++ int start = 0; /* this is the first server setting this welcome message from a user */
+
+ /* assert */
+ assert(NULL != cptr);
+ /* debug */
+ 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 insert=%s delete=%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 (*name == 0) {
-+ if (IsUser(sptr))
++ if (start)
+ sendcmdto_one(&me, CMD_NOTICE, sptr, "%C :Welcome: No message number given", sptr);
+ else
+ protocol_violation(cptr, "Received WELCOME with no message number from %C", sptr);
+
+ /* check name */
+ if (!WelcomeArrayIsValid(namearray)) {
-+ if (IsUser(sptr))
++ if (start)
+ sendcmdto_one(&me, CMD_NOTICE, sptr,
+ "%C :Welcome: Invalid message number %s - should between 1 and %d",
+ sptr, name, WELCOME_MAX_ENTRIES);
+ }
+
+ /* source is user, and is myuser or welcome is local, check length of the message */
-+ if (IsUser(sptr) && (MyConnect(sptr) || (flags & WELCOME_LOCAL)) && (strlen(text) > WELCOMELEN)) {
++ 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);
+ assert(WelcomeNameIsValid(nameint));
+
+ /* cannot unset welcome that is not set */
-+ if (!WelcomeIsSet(namearray) && *text == 0) {
++ 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
+ * we got a newer one
+ * or when lastmod is the same and our text is 'smaller'
+ */
-+ else if ((lastmod < WelcomeLastMod(namearray)) || /* we got a newer one */
-+ ((lastmod == WelcomeLastMod(namearray)) && /* same lastmod */
-+ (strcmp(WelcomeText(namearray), text) < 0))) { /* our text is 'smaller' */
++ 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;
+ lastmod = TStime();
+ }
+
-+ /* new global welcome from my user or local welcome
++ /* 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 (IsUser(sptr) && (MyConnect(sptr) || (flags & WELCOME_LOCAL))) {
-+ if (strcmp(text, WelcomeText(namearray)) == 0) { /* use strcmp instead of ircd_strcmp - oper may wish to change case */
-+ 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;
-+ }
++ if (start && strcmp(text, WelcomeText(namearray)) == 0) {
++ 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;
+ }
+ }
+
-+ /* do not insert for last global/local entry and when not set yet */
-+ if ((flags & WELCOME_INSERT) &&
-+ ((!WelcomeIsSet(namearray)) || (nameint == WELCOME_MAX_ENTRIES)))
++ /* 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;
++ }
++
++ /* 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;
+
-+ /* unset */
-+ if (*text == 0) {
++ /* clear delete flag when not unsetting so we do not propagate the - delete prefix */
++ if (flags & WELCOME_DELETE && !(flags & WELCOME_UNSET))
++ flags &= ~WELCOME_DELETE;
+
-+ /* clear insert flag,
-+ * when this flag is set, welcome_unset() assumes it is being called from welcome_insert()
-+ * and wont propagate the change
-+ * welcome_delete() calls welcome_unset()
-+ */
-+ flags &= ~WELCOME_INSERT;
++ /* unset */
++ if (flags & WELCOME_UNSET) {
+
+ /* delete */
+ if (flags & WELCOME_DELETE)
+
+ /* stats header */
+ send_reply(sptr, SND_EXPLICIT | RPL_STATSWELCOME,
-+ "W # Target Who Created LastMod Text");
++ "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++) {
projects / irc / quakenet / snircd-patchqueue.git / blobdiff