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
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2023-2025 Sadie Powell <sadie@witchery.services>
*
* 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/stats.h"
#include "modules/whois.h"
#include "timeutils.h"
class HelpOp final
: public SimpleUserMode
{
public:
std::vector<User*> helpers;
HelpOp(Module* mod)
: SimpleUserMode(mod, "helpop", 'h', true)
{
}
bool OnModeChange(User* source, User* dest, Channel* channel, Modes::Change& change) override
{
if (!SimpleUserMode::OnModeChange(source, dest, channel, change))
return false;
if (change.adding)
helpers.push_back(dest);
else
std::erase(helpers, dest);
return true;
}
};
class ModuleHelpMode final
: public Module
, public Stats::EventListener
, public Whois::EventListener
{
private:
bool ignorehideoper;
HelpOp helpop;
UserModeReference hideoper;
bool markhelpers;
// <helpchan:prefix>
using HelpChanMap = insp::flat_map<std::string, std::vector<ChanModeReference>>;
HelpChanMap helpchans;
public:
ModuleHelpMode()
: Module(VF_VENDOR, "Adds user mode h (helpop) which marks a user as being available for help.")
, Stats::EventListener(this, 50)
, Whois::EventListener(this)
, helpop(this)
, hideoper(this, "hideoper")
{
}
void ReadConfig(ConfigStatus& status) override
{
HelpChanMap newhelpchans;
for (const auto& [_, tag] : ServerInstance->Config->ConfTags("helpchan"))
{
const auto name = tag->getString("name");
if (name.empty())
throw ModuleException(this, "<helpchan:name> must not be empty at " + tag->source.str());
auto& newhelpchan = newhelpchans[name];
for (const auto modechr : tag->getString("prefix", "o", 1))
{
auto* mh = ServerInstance->Modes.FindPrefixMode(modechr);
if (mh)
newhelpchan.push_back(ChanModeReference(this, mh->service_name));
}
}
std::swap(helpchans, newhelpchans);
const auto& tag = ServerInstance->Config->ConfValue("helpmode");
ignorehideoper = tag->getBool("ignorehideoper");
markhelpers = tag->getBool("markhelpers", true);
}
ModResult OnStats(Stats::Context& stats) override
{
if (stats.GetSymbol() != 'P')
return MOD_RES_PASSTHRU;
for (auto* helper : helpop.helpers)
{
if (helper->server->IsService())
continue; // Ignore services.
if (helper->IsOper() && (!ignorehideoper || !helper->IsModeSet(hideoper)))
continue; // Ignore opers.
std::string extra;
if (helper->IsAway())
{
const std::string awayperiod = Duration::ToLongString(ServerInstance->Time() - helper->away->time, true);
const std::string awaytime = Time::ToString(helper->away->time);
extra = FMT::format(": away for {} [since {}] ({})", awayperiod, awaytime, helper->away->message);
}
auto* lhelper = helper->AsLocal();
if (lhelper)
{
const std::string idleperiod = Duration::ToLongString(ServerInstance->Time() - lhelper->idle_lastmsg, true);
const std::string idletime = Time::ToString(lhelper->idle_lastmsg);
extra += FMT::format("{} idle for {} [since {}]", extra.empty() ? ':' : ',', idleperiod, idletime);
}
stats.AddGenericRow(FMT::format("\x02{}\x02{} ({}){}", helper->nick, markhelpers ? " [helper]" : "",
helper->GetUserHost(), extra));
}
// Allow the core to add normal opers.
return MOD_RES_PASSTHRU;
}
ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, PrefixMode::Set& privs, const std::string& keygiven, bool override) override
{
if (!user->IsModeSet(helpop))
return MOD_RES_PASSTHRU;
for (auto& [helpchan, prefixes] : helpchans)
{
if (!InspIRCd::Match(cname, helpchan))
continue;
for (auto& prefix : prefixes)
{
if (prefix && prefix->IsPrefixMode())
privs.insert(prefix->IsPrefixMode());
}
break;
}
return MOD_RES_PASSTHRU;
}
void OnUserQuit(User* user, const std::string& message, const std::string& opermessage) override
{
if (user->IsModeSet(helpop))
std::erase(helpop.helpers, user);
}
void OnWhois(Whois::Context& whois) override
{
if (whois.GetTarget()->IsModeSet(helpop))
whois.SendLine(RPL_WHOISHELPOP, "is available for help.");
}
};
MODULE_INIT(ModuleHelpMode)
|
