1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2018 linuxdaemon <linuxdaemon.irc@gmail.com>
* Copyright (C) 2013, 2017-2020 Sadie Powell <sadie@witchery.services>
* Copyright (C) 2013 Daniel Vassdal <shutter@canternet.org>
* Copyright (C) 2012-2015, 2018 Attila Molnar <attilamolnar@hush.com>
* Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
* Copyright (C) 2010 Craig Edwards <brain@inspircd.org>
* Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
*
* This file is part of InspIRCd. InspIRCd is free software: you can
* redistribute it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation, version 2.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "inspircd.h"
#include "modules/ircv3_servertime.h"
#include "modules/ircv3_batch.h"
#include "modules/server.h"
typedef insp::flat_map<std::string, std::string> HistoryTagMap;
struct HistoryItem
{
time_t ts;
std::string text;
MessageType type;
HistoryTagMap tags;
std::string sourcemask;
HistoryItem(User* source, const MessageDetails& details)
: ts(ServerInstance->Time())
, text(details.text)
, type(details.type)
, sourcemask(source->GetFullHost())
{
tags.reserve(details.tags_out.size());
for (ClientProtocol::TagMap::const_iterator iter = details.tags_out.begin(); iter != details.tags_out.end(); ++iter)
tags[iter->first] = iter->second.value;
}
};
struct HistoryList
{
std::deque<HistoryItem> lines;
unsigned int maxlen;
unsigned int maxtime;
HistoryList(unsigned int len, unsigned int time)
: maxlen(len)
, maxtime(time)
{
}
};
class HistoryMode : public ParamMode<HistoryMode, SimpleExtItem<HistoryList> >
{
public:
unsigned int maxlines;
HistoryMode(Module* Creator)
: ParamMode<HistoryMode, SimpleExtItem<HistoryList> >(Creator, "history", 'H')
{
syntax = "<max-messages>:<max-duration>";
}
ModeAction OnSet(User* source, Channel* channel, std::string& parameter) CXX11_OVERRIDE
{
std::string::size_type colon = parameter.find(':');
if (colon == std::string::npos)
{
source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
return MODEACTION_DENY;
}
std::string duration(parameter, colon+1);
if ((IS_LOCAL(source)) && ((duration.length() > 10) || (!InspIRCd::IsValidDuration(duration))))
{
source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
return MODEACTION_DENY;
}
unsigned int len = ConvToNum<unsigned int>(parameter.substr(0, colon));
unsigned long time;
if (!InspIRCd::Duration(duration, time) || len == 0 || (len > maxlines && IS_LOCAL(source)))
{
source->WriteNumeric(Numerics::InvalidModeParameter(channel, this, parameter));
return MODEACTION_DENY;
}
if (len > maxlines)
len = maxlines;
HistoryList* history = ext.get(channel);
if (history)
{
// Shrink the list if the new line number limit is lower than the old one
if (len < history->lines.size())
history->lines.erase(history->lines.begin(), history->lines.begin() + (history->lines.size() - len));
history->maxlen = len;
history->maxtime = time;
}
else
{
ext.set(channel, new HistoryList(len, time));
}
return MODEACTION_ALLOW;
}
void SerializeParam(Channel* chan, const HistoryList* history, std::string& out)
{
out.append(ConvToStr(history->maxlen));
out.append(":");
out.append(InspIRCd::DurationString(history->maxtime));
}
};
class ModuleChanHistory
: public Module
, public ServerProtocol::BroadcastEventListener
{
private:
HistoryMode m;
bool prefixmsg;
UserModeReference botmode;
bool dobots;
IRCv3::Batch::CapReference batchcap;
IRCv3::Batch::API batchmanager;
IRCv3::Batch::Batch batch;
IRCv3::ServerTime::API servertimemanager;
ClientProtocol::MessageTagEvent tagevent;
void AddTag(ClientProtocol::Message& msg, const std::string& tagkey, std::string& tagval)
{
const Events::ModuleEventProvider::SubscriberList& list = tagevent.GetSubscribers();
for (Events::ModuleEventProvider::SubscriberList::const_iterator i = list.begin(); i != list.end(); ++i)
{
ClientProtocol::MessageTagProvider* const tagprov = static_cast<ClientProtocol::MessageTagProvider*>(*i);
const ModResult res = tagprov->OnProcessTag(ServerInstance->FakeClient, tagkey, tagval);
if (res == MOD_RES_ALLOW)
msg.AddTag(tagkey, tagprov, tagval);
else if (res == MOD_RES_DENY)
break;
}
}
void SendHistory(LocalUser* user, Channel* channel, HistoryList* list, time_t mintime)
{
if (batchmanager)
{
batchmanager->Start(batch);
batch.GetBatchStartMessage().PushParamRef(channel->name);
}
for(std::deque<HistoryItem>::iterator i = list->lines.begin(); i != list->lines.end(); ++i)
{
HistoryItem& item = *i;
if (item.ts >= mintime)
{
ClientProtocol::Messages::Privmsg msg(ClientProtocol::Messages::Privmsg::nocopy, item.sourcemask, channel, item.text, item.type);
for (HistoryTagMap::iterator iter = item.tags.begin(); iter != item.tags.end(); ++iter)
AddTag(msg, iter->first, iter->second);
if (servertimemanager)
servertimemanager->Set(msg, item.ts);
batch.AddToBatch(msg);
user->Send(ServerInstance->GetRFCEvents().privmsg, msg);
}
}
if (batchmanager)
batchmanager->End(batch);
}
public:
ModuleChanHistory()
: ServerProtocol::BroadcastEventListener(this)
, m(this)
, botmode(this, "bot")
, batchcap(this)
, batchmanager(this)
, batch("chathistory")
, servertimemanager(this)
, tagevent(this)
{
}
void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
ConfigTag* tag = ServerInstance->Config->ConfValue("chanhistory");
m.maxlines = tag->getUInt("maxlines", 50, 1);
prefixmsg = tag->getBool("prefixmsg", tag->getBool("notice", true));
dobots = tag->getBool("bots", true);
}
ModResult OnBroadcastMessage(Channel* channel, const Server* server) CXX11_OVERRIDE
{
return channel->IsModeSet(m) ? MOD_RES_ALLOW : MOD_RES_PASSTHRU;
}
void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE
{
std::string ctcpname;
if ((target.type == MessageTarget::TYPE_CHANNEL) && (target.status == 0) && (!details.IsCTCP(ctcpname) || irc::equals(ctcpname, "ACTION")))
{
Channel* c = target.Get<Channel>();
HistoryList* list = m.ext.get(c);
if (list)
{
list->lines.push_back(HistoryItem(user, details));
if (list->lines.size() > list->maxlen)
list->lines.pop_front();
}
}
}
void OnPostJoin(Membership* memb) CXX11_OVERRIDE
{
LocalUser* localuser = IS_LOCAL(memb->user);
if (!localuser)
return;
if (memb->user->IsModeSet(botmode) && !dobots)
return;
HistoryList* list = m.ext.get(memb->chan);
if (!list)
return;
if ((prefixmsg) && (!batchcap.get(localuser)))
{
std::string message("Replaying up to " + ConvToStr(list->maxlen) + " lines of pre-join history");
if (list->maxtime > 0)
message.append(" from the last " + InspIRCd::DurationString(list->maxtime));
memb->WriteNotice(message);
}
time_t mintime = 0;
if (list->maxtime)
mintime = ServerInstance->Time() - list->maxtime;
SendHistory(localuser, memb->chan, list, mintime);
}
Version GetVersion() CXX11_OVERRIDE
{
return Version("Adds channel mode H (history) which allows message history to be viewed on joining the channel.", VF_VENDOR);
}
};
MODULE_INIT(ModuleChanHistory)
|
