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:
+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
: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 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 8bf1b05cdfe7 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 8bf1b05cdfe7 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 8bf1b05cdfe7 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 8bf1b05cdfe7 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 8bf1b05cdfe7 include/welcome.h
---- /dev/null
-+++ b/include/welcome.h
+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
+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 @@
- 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 8bf1b05cdfe7 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 8bf1b05cdfe7 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 8bf1b05cdfe7 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 8bf1b05cdfe7 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 8bf1b05cdfe7 ircd/m_welcome.c
---- /dev/null
-+++ b/ircd/m_welcome.c
+ 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
+ /* 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 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 8bf1b05cdfe7 ircd/s_debug.c
---- a/ircd/s_debug.c
-+++ b/ircd/s_debug.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"
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 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" },
/* 510 */
{ 0 },
/* 511 */
-diff -r 8bf1b05cdfe7 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 8bf1b05cdfe7 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"
{ '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 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"
/* TODO: */
/* apply auto sethost if needed */
apply_spoofblock(sptr);
-diff -r 8bf1b05cdfe7 ircd/welcome.c
---- /dev/null
-+++ b/ircd/welcome.c
+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
projects / irc / quakenet / snircd-patchqueue.git / blobdiff