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/>.
26 static std::map<irc::string, std::string> helpop_map;
28 /** Handles user mode +h
30 class Helpop : public ModeHandler
33 Helpop(Module* Creator) : ModeHandler(Creator, "helpop", 'h', PARAM_NONE, MODETYPE_USER)
38 ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding)
42 if (!dest->IsModeSet('h'))
44 dest->SetMode('h',true);
45 return MODEACTION_ALLOW;
50 if (dest->IsModeSet('h'))
52 dest->SetMode('h',false);
53 return MODEACTION_ALLOW;
57 return MODEACTION_DENY;
63 class CommandHelpop : public Command
66 CommandHelpop(Module* Creator) : Command(Creator, "HELPOP", 0)
68 syntax = "<any-text>";
71 CmdResult Handle (const std::vector<std::string> ¶meters, User *user)
73 irc::string parameter("start");
74 if (parameters.size() > 0)
75 parameter = parameters[0].c_str();
77 if (parameter == "index")
79 /* iterate over all helpop items */
80 user->WriteServ("290 %s :HELPOP topic index", user->nick.c_str());
81 for (std::map<irc::string, std::string>::iterator iter = helpop_map.begin(); iter != helpop_map.end(); iter++)
83 user->WriteServ("292 %s : %s", user->nick.c_str(), iter->first.c_str());
85 user->WriteServ("292 %s :*** End of HELPOP topic index", user->nick.c_str());
89 user->WriteServ("290 %s :*** HELPOP for %s", user->nick.c_str(), parameter.c_str());
90 user->WriteServ("292 %s : -", user->nick.c_str());
92 std::map<irc::string, std::string>::iterator iter = helpop_map.find(parameter);
94 if (iter == helpop_map.end())
96 iter = helpop_map.find("nohelp");
99 std::string value = iter->second;
100 irc::sepstream stream(value, '\n');
101 std::string token = "*";
103 while (stream.GetToken(token))
105 // Writing a blank line will not work with some clients
107 user->WriteServ("292 %s : ", user->nick.c_str());
109 user->WriteServ("292 %s :%s", user->nick.c_str(), token.c_str());
112 user->WriteServ("292 %s : -", user->nick.c_str());
113 user->WriteServ("292 %s :*** End of HELPOP", user->nick.c_str());
119 class ModuleHelpop : public Module
128 : cmd(this), ho(this)
135 ServerInstance->Modules->AddService(ho);
136 ServerInstance->Modules->AddService(cmd);
137 Implementation eventlist[] = { I_OnRehash, I_OnWhois };
138 ServerInstance->Modules->Attach(eventlist, this, 2);
145 ConfigTagList tags = ServerInstance->Config->ConfTags("helpop");
146 for(ConfigIter i = tags.first; i != tags.second; ++i)
148 ConfigTag* tag = i->second;
149 irc::string key = assign(tag->getString("key"));
151 tag->readString("value", value, true); /* Linefeeds allowed */
155 throw ModuleException("m_helpop: The key 'index' is reserved for internal purposes. Please remove it.");
158 helpop_map[key] = value;
161 if (helpop_map.find("start") == helpop_map.end())
164 throw ModuleException("m_helpop: Helpop file is missing important entry 'start'. Please check the example conf.");
166 else if (helpop_map.find("nohelp") == helpop_map.end())
169 throw ModuleException("m_helpop: Helpop file is missing important entry 'nohelp'. Please check the example conf.");
174 void OnRehash(User* user)
179 void OnWhois(User* src, User* dst)
181 if (dst->IsModeSet('h'))
183 ServerInstance->SendWhoisLine(src, dst, 310, std::string(src->nick)+" "+std::string(dst->nick)+" :is available for help.");
189 return Version("Provides the /HELPOP command, works like UnrealIRCd's helpop", VF_VENDOR);
193 MODULE_INIT(ModuleHelpop)