2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2005-2009 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2004-2006, 2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
8 * Copyright (C) 2004-2005 Craig McLure <craig@chatspike.net>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 /* $ModDesc: Provides the /HELPOP command, works like UnrealIRCd's helpop */
28 static std::map<irc::string, std::string> helpop_map;
30 /** Handles user mode +h
32 class Helpop : public ModeHandler
35 Helpop(Module* Creator) : ModeHandler(Creator, "helpop", 'h', PARAM_NONE, MODETYPE_USER)
40 ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding)
44 if (!dest->IsModeSet('h'))
46 dest->SetMode('h',true);
47 return MODEACTION_ALLOW;
52 if (dest->IsModeSet('h'))
54 dest->SetMode('h',false);
55 return MODEACTION_ALLOW;
59 return MODEACTION_DENY;
65 class CommandHelpop : public Command
68 CommandHelpop(Module* Creator) : Command(Creator, "HELPOP", 0)
70 syntax = "<any-text>";
73 CmdResult Handle (const std::vector<std::string> ¶meters, User *user)
75 irc::string parameter("start");
76 if (parameters.size() > 0)
77 parameter = parameters[0].c_str();
79 if (parameter == "index")
81 /* iterate over all helpop items */
82 user->WriteServ("290 %s :HELPOP topic index", user->nick.c_str());
83 for (std::map<irc::string, std::string>::iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++)
85 user->WriteServ("292 %s : %s", user->nick.c_str(), iter->first.c_str());
87 user->WriteServ("292 %s :*** End of HELPOP topic index", user->nick.c_str());
91 user->WriteServ("290 %s :*** HELPOP for %s", user->nick.c_str(), parameter.c_str());
92 user->WriteServ("292 %s : -", user->nick.c_str());
94 std::map<irc::string, std::string>::iterator iter = helpop_map.find(parameter);
96 if (iter == helpop_map.end())
98 iter = helpop_map.find("nohelp");
101 std::string value = iter->second;
102 irc::sepstream stream(value, '\n');
103 std::string token = "*";
105 while (stream.GetToken(token))
107 // Writing a blank line will not work with some clients
109 user->WriteServ("292 %s : ", user->nick.c_str());
111 user->WriteServ("292 %s :%s", user->nick.c_str(), token.c_str());
114 user->WriteServ("292 %s : -", user->nick.c_str());
115 user->WriteServ("292 %s :*** End of HELPOP", user->nick.c_str());
121 class ModuleHelpop : public Module
130 : cmd(this), ho(this)
137 ServerInstance->Modules->AddService(ho);
138 ServerInstance->Modules->AddService(cmd);
139 Implementation eventlist[] = { I_OnRehash, I_OnWhois };
140 ServerInstance->Modules->Attach(eventlist, this, 2);
147 ConfigTagList tags = ServerInstance->Config->ConfTags("helpop");
148 for(ConfigIter i = tags.first; i != tags.second; ++i)
150 ConfigTag* tag = i->second;
151 irc::string key = assign(tag->getString("key"));
153 tag->readString("value", value, true); /* Linefeeds allowed */
157 throw ModuleException("m_helpop: The key 'index' is reserved for internal purposes. Please remove it.");
160 helpop_map[key] = value;
163 if (helpop_map.find("start") == helpop_map.end())
166 throw ModuleException("m_helpop: Helpop file is missing important entry 'start'. Please check the example conf.");
168 else if (helpop_map.find("nohelp") == helpop_map.end())
171 throw ModuleException("m_helpop: Helpop file is missing important entry 'nohelp'. Please check the example conf.");
176 void OnRehash(User* user)
181 void OnWhois(User* src, User* dst)
183 if (dst->IsModeSet('h'))
185 ServerInstance->SendWhoisLine(src, dst, 310, std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help.");
191 return Version("Provides the /HELPOP command, works like UnrealIRCd's helpop", VF_VENDOR);
195 MODULE_INIT(ModuleHelpop)