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
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2013, 2017-2018, 2020 Sadie Powell <sadie@witchery.services>
* Copyright (C) 2013, 2015 Attila Molnar <attilamolnar@hush.com>
* Copyright (C) 2012 Robby <robby@chatbelgie.be>
* Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
* Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
* Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
* Copyright (C) 2006 Craig Edwards <brain@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"
enum
{
// From ircd-ratbox.
ERR_HELPNOTFOUND = 524,
RPL_HELPSTART = 704,
RPL_HELPTXT = 705,
RPL_ENDOFHELP = 706
};
typedef std::vector<std::string> HelpMessage;
struct HelpTopic final
{
// The body of the help topic.
const HelpMessage body;
// The title of the help topic.
const std::string title;
HelpTopic(const HelpMessage& Body, const std::string& Title)
: body(Body)
, title(Title)
{
}
};
typedef std::map<std::string, HelpTopic, irc::insensitive_swo> HelpMap;
class CommandHelp final
: public Command
{
private:
const std::string startkey;
public:
HelpMap help;
std::string nohelp;
CommandHelp(Module* Creator)
: Command(Creator, "HELP")
, startkey("start")
{
syntax = { "<any-text>" };
}
CmdResult Handle(User* user, const Params& parameters) override
{
const std::string& topic = parameters.empty() ? startkey : parameters[0];
HelpMap::const_iterator titer = help.find(topic);
if (titer == help.end())
{
user->WriteNumeric(ERR_HELPNOTFOUND, topic, nohelp);
return CmdResult::FAILURE;
}
const HelpTopic& entry = titer->second;
user->WriteNumeric(RPL_HELPSTART, topic, entry.title);
for (const auto& line : entry.body)
user->WriteNumeric(RPL_HELPTXT, topic, line);
user->WriteNumeric(RPL_ENDOFHELP, topic, "End of /HELP.");
return CmdResult::SUCCESS;
}
};
class ModuleHelp final
: public Module
{
private:
CommandHelp cmd;
public:
ModuleHelp()
: Module(VF_VENDOR, "Adds the /HELP command which allows users to view help on various topics.")
, cmd(this)
{
}
void ReadConfig(ConfigStatus& status) override
{
size_t longestkey = 0;
HelpMap newhelp;
auto tags = ServerInstance->Config->ConfTags("helptopic", ServerInstance->Config->ConfTags("helpop"));
if (tags.empty())
throw ModuleException(this, "You have loaded the help module but not configured any help topics!");
for (const auto& [_, tag] : tags)
{
// Attempt to read the help key.
const std::string key = tag->getString("key");
if (key.empty())
throw ModuleException(this, INSP_FORMAT("<{}:key> is empty at {}", tag->name, tag->source.str()));
else if (irc::equals(key, "index"))
throw ModuleException(this, INSP_FORMAT("<{}:key> is set to \"index\" which is reserved at {}", tag->name, tag->source.str()));
else if (key.length() > longestkey)
longestkey = key.length();
// Attempt to read the help value.
std::string value;
if (!tag->readString("value", value, true) || value.empty())
throw ModuleException(this, INSP_FORMAT("<{}:value> is empty at {}", tag->name, tag->source.str()));
// Parse the help body. Empty lines are replaced with a single
// space because some clients are unable to show blank lines.
HelpMessage helpmsg;
irc::sepstream linestream(value, '\n', true);
for (std::string line; linestream.GetToken(line); )
helpmsg.push_back(line.empty() ? " " : line);
// Read the help title and store the topic.
const std::string title = tag->getString("title", INSP_FORMAT("*** Help for {}", key), 1);
if (!newhelp.emplace(key, HelpTopic(helpmsg, title)).second)
{
throw ModuleException(this, INSP_FORMAT("<{}> tag with duplicate key '{}' at {}",
tag->name, key, tag->source.str()));
}
}
// The number of items we can fit on a page.
HelpMessage indexmsg;
size_t maxcolumns = 80 / (longestkey + 2);
for (HelpMap::iterator iter = newhelp.begin(); iter != newhelp.end(); )
{
std::string indexline;
for (size_t column = 0; column != maxcolumns; )
{
if (iter == newhelp.end())
break;
indexline.append(iter->first);
if (++column != maxcolumns)
indexline.append(longestkey - iter->first.length() + 2, ' ');
iter++;
}
indexmsg.push_back(indexline);
}
newhelp.emplace("index", HelpTopic(indexmsg, "List of help topics"));
cmd.help.swap(newhelp);
const auto& tag = ServerInstance->Config->ConfValue("helpmsg");
cmd.nohelp = tag->getString("nohelp", "There is no help for the topic you searched for. Please try again.", 1);
}
};
MODULE_INIT(ModuleHelp)
|
