]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/mode.cpp
Change return type of Channel::GetUsers() to reference from pointer as it is never...
[user/henk/code/inspircd.git] / src / mode.cpp
1 /*
2  * InspIRCd -- Internet Relay Chat Daemon
3  *
4  *   Copyright (C) 2012 Shawn Smith <shawn@inspircd.org>
5  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
6  *   Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
7  *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
8  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
9  *   Copyright (C) 2004-2008 Craig Edwards <craigedwards@brainbox.cc>
10  *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
11  *
12  * This file is part of InspIRCd.  InspIRCd is free software: you can
13  * redistribute it and/or modify it under the terms of the GNU General Public
14  * License as published by the Free Software Foundation, version 2.
15  *
16  * This program is distributed in the hope that it will be useful, but WITHOUT
17  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
19  * details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23  */
24
25
26 #include "inspircd.h"
27 #include "builtinmodes.h"
28
29 ModeHandler::ModeHandler(Module* Creator, const std::string& Name, char modeletter, ParamSpec Params, ModeType type, Class mclass)
30         : ServiceProvider(Creator, Name, SERVICE_MODE), modeid(ModeParser::MODEID_MAX), m_paramtype(TR_TEXT),
31         parameters_taken(Params), mode(modeletter), oper(false),
32         list(false), m_type(type), type_id(mclass), levelrequired(HALFOP_VALUE)
33 {
34 }
35
36 CullResult ModeHandler::cull()
37 {
38         if (ServerInstance)
39                 ServerInstance->Modes->DelMode(this);
40         return classbase::cull();
41 }
42
43 ModeHandler::~ModeHandler()
44 {
45 }
46
47 int ModeHandler::GetNumParams(bool adding)
48 {
49         switch (parameters_taken)
50         {
51                 case PARAM_ALWAYS:
52                         return 1;
53                 case PARAM_SETONLY:
54                         return adding ? 1 : 0;
55                 case PARAM_NONE:
56                         break;
57         }
58         return 0;
59 }
60
61 std::string ModeHandler::GetUserParameter(User* user)
62 {
63         return "";
64 }
65
66 ModResult ModeHandler::AccessCheck(User*, Channel*, std::string &, bool)
67 {
68         return MOD_RES_PASSTHRU;
69 }
70
71 ModeAction ModeHandler::OnModeChange(User*, User*, Channel*, std::string&, bool)
72 {
73         return MODEACTION_DENY;
74 }
75
76 void ModeHandler::DisplayList(User*, Channel*)
77 {
78 }
79
80 void ModeHandler::DisplayEmptyList(User*, Channel*)
81 {
82 }
83
84 void ModeHandler::OnParameterMissing(User* user, User* dest, Channel* channel)
85 {
86 }
87
88 bool ModeHandler::ResolveModeConflict(std::string& theirs, const std::string& ours, Channel*)
89 {
90         return (theirs < ours);
91 }
92
93 ModeAction SimpleUserModeHandler::OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
94 {
95         /* We're either trying to add a mode we already have or
96                 remove a mode we don't have, deny. */
97         if (dest->IsModeSet(this) == adding)
98                 return MODEACTION_DENY;
99
100         /* adding will be either true or false, depending on if we
101                 are adding or removing the mode, since we already checked
102                 to make sure we aren't adding a mode we have or that we
103                 aren't removing a mode we don't have, we don't have to do any
104                 other checks here to see if it's true or false, just add or
105                 remove the mode */
106         dest->SetMode(this, adding);
107
108         return MODEACTION_ALLOW;
109 }
110
111
112 ModeAction SimpleChannelModeHandler::OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
113 {
114         /* We're either trying to add a mode we already have or
115                 remove a mode we don't have, deny. */
116         if (channel->IsModeSet(this) == adding)
117                 return MODEACTION_DENY;
118
119         /* adding will be either true or false, depending on if we
120                 are adding or removing the mode, since we already checked
121                 to make sure we aren't adding a mode we have or that we
122                 aren't removing a mode we don't have, we don't have to do any
123                 other checks here to see if it's true or false, just add or
124                 remove the mode */
125         channel->SetMode(this, adding);
126
127         return MODEACTION_ALLOW;
128 }
129
130 ModeWatcher::ModeWatcher(Module* Creator, const std::string& modename, ModeType type)
131         : mode(modename), m_type(type), creator(Creator)
132 {
133         ServerInstance->Modes->AddModeWatcher(this);
134 }
135
136 ModeWatcher::~ModeWatcher()
137 {
138         ServerInstance->Modes->DelModeWatcher(this);
139 }
140
141 ModeType ModeWatcher::GetModeType()
142 {
143         return m_type;
144 }
145
146 bool ModeWatcher::BeforeMode(User*, User*, Channel*, std::string&, bool)
147 {
148         return true;
149 }
150
151 void ModeWatcher::AfterMode(User*, User*, Channel*, const std::string&, bool)
152 {
153 }
154
155 void ModeParser::DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text)
156 {
157         if (targetchannel)
158         {
159                 /* Display channel's current mode string */
160                 user->WriteNumeric(RPL_CHANNELMODEIS, "%s +%s", targetchannel->name.c_str(), targetchannel->ChanModes(targetchannel->HasUser(user)));
161                 user->WriteNumeric(RPL_CHANNELCREATED, "%s %lu", targetchannel->name.c_str(), (unsigned long)targetchannel->age);
162                 return;
163         }
164         else
165         {
166                 if (targetuser == user || user->HasPrivPermission("users/auspex"))
167                 {
168                         /* Display user's current mode string */
169                         user->WriteNumeric(RPL_UMODEIS, ":+%s", targetuser->FormatModes());
170                         if ((targetuser->IsOper()))
171                         {
172                                 ModeHandler* snomask = FindMode('s', MODETYPE_USER);
173                                 user->WriteNumeric(RPL_SNOMASKIS, "%s :Server notice mask", snomask->GetUserParameter(user).c_str());
174                         }
175                         return;
176                 }
177                 else
178                 {
179                         user->WriteNumeric(ERR_USERSDONTMATCH, ":Can't view modes for other users");
180                         return;
181                 }
182         }
183 }
184
185 PrefixMode::PrefixMode(Module* Creator, const std::string& Name, char ModeLetter)
186         : ModeHandler(Creator, Name, ModeLetter, PARAM_ALWAYS, MODETYPE_CHANNEL, MC_PREFIX)
187         , prefix(0), prefixrank(0)
188 {
189         list = true;
190         m_paramtype = TR_NICK;
191 }
192
193 ModeAction PrefixMode::OnModeChange(User* source, User*, Channel* chan, std::string& parameter, bool adding)
194 {
195         User* target;
196         if (IS_LOCAL(source))
197                 target = ServerInstance->FindNickOnly(parameter);
198         else
199                 target = ServerInstance->FindNick(parameter);
200
201         if (!target)
202         {
203                 source->WriteNumeric(ERR_NOSUCHNICK, "%s :No such nick/channel", parameter.c_str());
204                 return MODEACTION_DENY;
205         }
206
207         Membership* memb = chan->GetUser(target);
208         if (!memb)
209                 return MODEACTION_DENY;
210
211         parameter = target->nick;
212         return (memb->SetPrefix(this, adding) ? MODEACTION_ALLOW : MODEACTION_DENY);
213 }
214
215 ModeAction ParamModeBase::OnModeChange(User* source, User*, Channel* chan, std::string& parameter, bool adding)
216 {
217         if (adding)
218         {
219                 if (chan->GetModeParameter(this) == parameter)
220                         return MODEACTION_DENY;
221
222                 if (OnSet(source, chan, parameter) != MODEACTION_ALLOW)
223                         return MODEACTION_DENY;
224
225                 chan->SetMode(this, true);
226
227                 // Handler might have changed the parameter internally
228                 parameter.clear();
229                 this->GetParameter(chan, parameter);
230         }
231         else
232         {
233                 if (!chan->IsModeSet(this))
234                         return MODEACTION_DENY;
235                 this->OnUnsetInternal(source, chan);
236                 chan->SetMode(this, false);
237         }
238         return MODEACTION_ALLOW;
239 }
240
241 ModeAction ModeParser::TryMode(User* user, User* targetuser, Channel* chan, bool adding, const unsigned char modechar,
242                 std::string &parameter, bool SkipACL)
243 {
244         ModeType type = chan ? MODETYPE_CHANNEL : MODETYPE_USER;
245
246         ModeHandler *mh = FindMode(modechar, type);
247         int pcnt = mh->GetNumParams(adding);
248
249         // crop mode parameter size to 250 characters
250         if (parameter.length() > 250 && adding)
251                 parameter = parameter.substr(0, 250);
252
253         ModResult MOD_RESULT;
254         FIRST_MOD_RESULT(OnRawMode, MOD_RESULT, (user, chan, mh, parameter, adding));
255
256         if (IS_LOCAL(user) && (MOD_RESULT == MOD_RES_DENY))
257                 return MODEACTION_DENY;
258
259         if (chan && !SkipACL && (MOD_RESULT != MOD_RES_ALLOW))
260         {
261                 MOD_RESULT = mh->AccessCheck(user, chan, parameter, adding);
262
263                 if (MOD_RESULT == MOD_RES_DENY)
264                         return MODEACTION_DENY;
265                 if (MOD_RESULT == MOD_RES_PASSTHRU)
266                 {
267                         unsigned int neededrank = mh->GetLevelRequired();
268                         /* Compare our rank on the channel against the rank of the required prefix,
269                          * allow if >= ours. Because mIRC and xchat throw a tizz if the modes shown
270                          * in NAMES(X) are not in rank order, we know the most powerful mode is listed
271                          * first, so we don't need to iterate, we just look up the first instead.
272                          */
273                         unsigned int ourrank = chan->GetPrefixValue(user);
274                         if (ourrank < neededrank)
275                         {
276                                 PrefixMode* neededmh = NULL;
277                                 for(char c='A'; c <= 'z'; c++)
278                                 {
279                                         PrefixMode* privmh = FindPrefixMode(c);
280                                         if (privmh && privmh->GetPrefixRank() >= neededrank)
281                                         {
282                                                 // this mode is sufficient to allow this action
283                                                 if (!neededmh || privmh->GetPrefixRank() < neededmh->GetPrefixRank())
284                                                         neededmh = privmh;
285                                         }
286                                 }
287                                 if (neededmh)
288                                         user->WriteNumeric(ERR_CHANOPRIVSNEEDED, "%s :You must have channel %s access or above to %sset channel mode %c",
289                                                 chan->name.c_str(), neededmh->name.c_str(), adding ? "" : "un", modechar);
290                                 else
291                                         user->WriteNumeric(ERR_CHANOPRIVSNEEDED, "%s :You cannot %sset channel mode %c",
292                                                 chan->name.c_str(), adding ? "" : "un", modechar);
293                                 return MODEACTION_DENY;
294                         }
295                 }
296         }
297
298         // Ask mode watchers whether this mode change is OK
299         std::pair<ModeWatchIter, ModeWatchIter> itpair = modewatchermap.equal_range(mh->name);
300         for (ModeWatchIter i = itpair.first; i != itpair.second; ++i)
301         {
302                 ModeWatcher* mw = i->second;
303                 if (mw->GetModeType() == type)
304                 {
305                         if (!mw->BeforeMode(user, targetuser, chan, parameter, adding))
306                                 return MODEACTION_DENY;
307
308                         // A module whacked the parameter completely, and there was one. Abort.
309                         if (pcnt && parameter.empty())
310                                 return MODEACTION_DENY;
311                 }
312         }
313
314         if (IS_LOCAL(user) && !user->IsOper())
315         {
316                 char* disabled = (type == MODETYPE_CHANNEL) ? ServerInstance->Config->DisabledCModes : ServerInstance->Config->DisabledUModes;
317                 if (disabled[modechar - 'A'])
318                 {
319                         user->WriteNumeric(ERR_NOPRIVILEGES, ":Permission Denied - %s mode %c has been locked by the administrator",
320                                 type == MODETYPE_CHANNEL ? "channel" : "user", modechar);
321                         return MODEACTION_DENY;
322                 }
323         }
324
325         if (adding && IS_LOCAL(user) && mh->NeedsOper() && !user->HasModePermission(modechar, type))
326         {
327                 /* It's an oper only mode, and they don't have access to it. */
328                 if (user->IsOper())
329                 {
330                         user->WriteNumeric(ERR_NOPRIVILEGES, ":Permission Denied - Oper type %s does not have access to set %s mode %c",
331                                         user->oper->name.c_str(), type == MODETYPE_CHANNEL ? "channel" : "user", modechar);
332                 }
333                 else
334                 {
335                         user->WriteNumeric(ERR_NOPRIVILEGES, ":Permission Denied - Only operators may set %s mode %c",
336                                         type == MODETYPE_CHANNEL ? "channel" : "user", modechar);
337                 }
338                 return MODEACTION_DENY;
339         }
340
341         /* Call the handler for the mode */
342         ModeAction ma = mh->OnModeChange(user, targetuser, chan, parameter, adding);
343
344         if (pcnt && parameter.empty())
345                 return MODEACTION_DENY;
346
347         if (ma != MODEACTION_ALLOW)
348                 return ma;
349
350         itpair = modewatchermap.equal_range(mh->name);
351         for (ModeWatchIter i = itpair.first; i != itpair.second; ++i)
352         {
353                 ModeWatcher* mw = i->second;
354                 if (mw->GetModeType() == type)
355                         mw->AfterMode(user, targetuser, chan, parameter, adding);
356         }
357
358         return MODEACTION_ALLOW;
359 }
360
361 void ModeParser::Process(const std::vector<std::string>& parameters, User* user, ModeProcessFlag flags)
362 {
363         const std::string& target = parameters[0];
364         Channel* targetchannel = ServerInstance->FindChan(target);
365         User* targetuser = NULL;
366         if (!targetchannel)
367         {
368                 if (IS_LOCAL(user))
369                         targetuser = ServerInstance->FindNickOnly(target);
370                 else
371                         targetuser = ServerInstance->FindNick(target);
372         }
373         ModeType type = targetchannel ? MODETYPE_CHANNEL : MODETYPE_USER;
374
375         LastParse.clear();
376         LastParseParams.clear();
377         LastParseTranslate.clear();
378
379         if ((!targetchannel) && ((!targetuser) || (IS_SERVER(targetuser))))
380         {
381                 user->WriteNumeric(ERR_NOSUCHNICK, "%s :No such nick/channel", target.c_str());
382                 return;
383         }
384         if (parameters.size() == 1)
385         {
386                 this->DisplayCurrentModes(user, targetuser, targetchannel, target.c_str());
387                 return;
388         }
389
390         ModResult MOD_RESULT;
391         FIRST_MOD_RESULT(OnPreMode, MOD_RESULT, (user, targetuser, targetchannel, parameters));
392
393         bool SkipAccessChecks = false;
394
395         if (!IS_LOCAL(user) || MOD_RESULT == MOD_RES_ALLOW)
396                 SkipAccessChecks = true;
397         else if (MOD_RESULT == MOD_RES_DENY)
398                 return;
399
400         if (targetuser && !SkipAccessChecks && user != targetuser)
401         {
402                 user->WriteNumeric(ERR_USERSDONTMATCH, ":Can't change mode for other users");
403                 return;
404         }
405
406         std::string mode_sequence = parameters[1];
407
408         std::string output_mode;
409         std::ostringstream output_parameters;
410         LastParseParams.push_back(output_mode);
411         LastParseTranslate.push_back(TR_TEXT);
412
413         bool adding = true;
414         char output_pm = '\0'; // current output state, '+' or '-'
415         unsigned int param_at = 2;
416
417         for (std::string::const_iterator letter = mode_sequence.begin(); letter != mode_sequence.end(); letter++)
418         {
419                 unsigned char modechar = *letter;
420                 if (modechar == '+' || modechar == '-')
421                 {
422                         adding = (modechar == '+');
423                         continue;
424                 }
425
426                 ModeHandler *mh = this->FindMode(modechar, type);
427                 if (!mh)
428                 {
429                         /* No mode handler? Unknown mode character then. */
430                         user->WriteNumeric(type == MODETYPE_CHANNEL ? ERR_UNKNOWNMODE : ERR_UNKNOWNSNOMASK, "%c :is unknown mode char to me", modechar);
431                         continue;
432                 }
433
434                 std::string parameter;
435                 int pcnt = mh->GetNumParams(adding);
436                 if (pcnt && param_at == parameters.size())
437                 {
438                         /* No parameter, continue to the next mode */
439                         mh->OnParameterMissing(user, targetuser, targetchannel);
440                         continue;
441                 }
442                 else if (pcnt)
443                 {
444                         parameter = parameters[param_at++];
445                         /* Make sure the user isn't trying to slip in an invalid parameter */
446                         if ((parameter.find(':') == 0) || (parameter.rfind(' ') != std::string::npos))
447                                 continue;
448                         if ((flags & MODE_MERGE) && targetchannel && targetchannel->IsModeSet(mh) && !mh->IsListMode())
449                         {
450                                 std::string ours = targetchannel->GetModeParameter(mh);
451                                 if (!mh->ResolveModeConflict(parameter, ours, targetchannel))
452                                         /* we won the mode merge, don't apply this mode */
453                                         continue;
454                         }
455                 }
456
457                 ModeAction ma = TryMode(user, targetuser, targetchannel, adding, modechar, parameter, SkipAccessChecks);
458
459                 if (ma != MODEACTION_ALLOW)
460                         continue;
461
462                 char needed_pm = adding ? '+' : '-';
463                 if (needed_pm != output_pm)
464                 {
465                         output_pm = needed_pm;
466                         output_mode.append(1, output_pm);
467                 }
468                 output_mode.append(1, modechar);
469
470                 if (pcnt)
471                 {
472                         output_parameters << " " << parameter;
473                         LastParseParams.push_back(parameter);
474                         LastParseTranslate.push_back(mh->GetTranslateType());
475                 }
476
477                 if ( (output_mode.length() + output_parameters.str().length() > 450)
478                                 || (output_mode.length() > 100)
479                                 || (LastParseParams.size() > ServerInstance->Config->Limits.MaxModes))
480                 {
481                         /* mode sequence is getting too long */
482                         break;
483                 }
484         }
485
486         LastParseParams[0] = output_mode;
487
488         if (!output_mode.empty())
489         {
490                 LastParse = targetchannel ? targetchannel->name : targetuser->nick;
491                 LastParse.append(" ");
492                 LastParse.append(output_mode);
493                 LastParse.append(output_parameters.str());
494
495                 if (!(flags & MODE_LOCALONLY))
496                         ServerInstance->PI->SendMode(user, targetuser, targetchannel, LastParseParams, LastParseTranslate);
497
498                 if (targetchannel)
499                         targetchannel->WriteChannel(user, "MODE " + LastParse);
500                 else
501                         targetuser->WriteFrom(user, "MODE " + LastParse);
502
503                 FOREACH_MOD(OnMode, (user, targetuser, targetchannel, LastParseParams, LastParseTranslate));
504         }
505         else if (targetchannel && parameters.size() == 2)
506         {
507                 /* Special case for displaying the list for listmodes,
508                  * e.g. MODE #chan b, or MODE #chan +b without a parameter
509                  */
510                 this->DisplayListModes(user, targetchannel, mode_sequence);
511         }
512 }
513
514 void ModeParser::DisplayListModes(User* user, Channel* chan, std::string &mode_sequence)
515 {
516         seq++;
517
518         for (std::string::const_iterator letter = mode_sequence.begin(); letter != mode_sequence.end(); letter++)
519         {
520                 unsigned char mletter = *letter;
521                 if (mletter == '+')
522                         continue;
523
524                 /* Ensure the user doesnt request the same mode twice,
525                  * so they cant flood themselves off out of idiocy.
526                  */
527                 if (sent[mletter] == seq)
528                         continue;
529
530                 sent[mletter] = seq;
531
532                 ModeHandler *mh = this->FindMode(mletter, MODETYPE_CHANNEL);
533
534                 if (!mh || !mh->IsListMode())
535                         return;
536
537                 ModResult MOD_RESULT;
538                 FIRST_MOD_RESULT(OnRawMode, MOD_RESULT, (user, chan, mh, "", true));
539                 if (MOD_RESULT == MOD_RES_DENY)
540                         continue;
541
542                 bool display = true;
543                 if (!user->HasPrivPermission("channels/auspex") && ServerInstance->Config->HideModeLists[mletter] && (chan->GetPrefixValue(user) < HALFOP_VALUE))
544                 {
545                         user->WriteNumeric(ERR_CHANOPRIVSNEEDED, "%s :You do not have access to view the +%c list",
546                                 chan->name.c_str(), mletter);
547                         display = false;
548                 }
549
550                 // Ask mode watchers whether it's OK to show the list
551                 std::pair<ModeWatchIter, ModeWatchIter> itpair = modewatchermap.equal_range(mh->name);
552                 for (ModeWatchIter i = itpair.first; i != itpair.second; ++i)
553                 {
554                         ModeWatcher* mw = i->second;
555                         if (mw->GetModeType() == MODETYPE_CHANNEL)
556                         {
557                                 std::string dummyparam;
558
559                                 if (!mw->BeforeMode(user, NULL, chan, dummyparam, true))
560                                 {
561                                         // A mode watcher doesn't want us to show the list
562                                         display = false;
563                                         break;
564                                 }
565                         }
566                 }
567
568                 if (display)
569                         mh->DisplayList(user, chan);
570                 else
571                         mh->DisplayEmptyList(user, chan);
572         }
573 }
574
575 void ModeParser::CleanMask(std::string &mask)
576 {
577         std::string::size_type pos_of_pling = mask.find_first_of('!');
578         std::string::size_type pos_of_at = mask.find_first_of('@');
579         std::string::size_type pos_of_dot = mask.find_first_of('.');
580         std::string::size_type pos_of_colons = mask.find("::"); /* Because ipv6 addresses are colon delimited -- double so it treats extban as nick */
581
582         if (mask.length() >= 2 && mask[1] == ':')
583                 return; // if it's an extban, don't even try guess how it needs to be formed.
584
585         if ((pos_of_pling == std::string::npos) && (pos_of_at == std::string::npos))
586         {
587                 /* Just a nick, or just a host - or clearly ipv6 (starting with :) */
588                 if ((pos_of_dot == std::string::npos) && (pos_of_colons == std::string::npos) && mask[0] != ':')
589                 {
590                         /* It has no '.' in it, it must be a nick. */
591                         mask.append("!*@*");
592                 }
593                 else
594                 {
595                         /* Got a dot in it? Has to be a host */
596                         mask = "*!*@" + mask;
597                 }
598         }
599         else if ((pos_of_pling == std::string::npos) && (pos_of_at != std::string::npos))
600         {
601                 /* Has an @ but no !, its a user@host */
602                  mask = "*!" + mask;
603         }
604         else if ((pos_of_pling != std::string::npos) && (pos_of_at == std::string::npos))
605         {
606                 /* Has a ! but no @, it must be a nick!ident */
607                 mask.append("@*");
608         }
609 }
610
611 ModeHandler::Id ModeParser::AllocateModeId(ModeType mt)
612 {
613         for (ModeHandler::Id i = 0; i != MODEID_MAX; ++i)
614         {
615                 if (!modehandlersbyid[mt][i])
616                         return i;
617         }
618
619         throw ModuleException("Out of ModeIds");
620 }
621
622 void ModeParser::AddMode(ModeHandler* mh)
623 {
624         /* Yes, i know, this might let people declare modes like '_' or '^'.
625          * If they do that, thats their problem, and if i ever EVER see an
626          * official InspIRCd developer do that, i'll beat them with a paddle!
627          */
628         if ((mh->GetModeChar() < 'A') || (mh->GetModeChar() > 'z'))
629                 throw ModuleException("Invalid letter for mode " + mh->name);
630
631         /* A mode prefix of ',' is not acceptable, it would fuck up server to server.
632          * A mode prefix of ':' will fuck up both server to server, and client to server.
633          * A mode prefix of '#' will mess up /whois and /privmsg
634          */
635         PrefixMode* pm = mh->IsPrefixMode();
636         if (pm)
637         {
638                 if ((pm->GetPrefix() > 126) || (pm->GetPrefix() == ',') || (pm->GetPrefix() == ':') || (pm->GetPrefix() == '#'))
639                         throw ModuleException("Invalid prefix for mode " + mh->name);
640
641                 if (FindPrefix(pm->GetPrefix()))
642                         throw ModuleException("Prefix already exists for mode " + mh->name);
643         }
644
645         ModeHandler*& slot = modehandlers[mh->GetModeType()][mh->GetModeChar()-65];
646         if (slot)
647                 throw ModuleException("Letter is already in use for mode " + mh->name);
648
649         // The mode needs an id if it is either a user mode, a simple mode (flag) or a parameter mode.
650         // Otherwise (for listmodes and prefix modes) the id remains MODEID_MAX, which is invalid.
651         ModeHandler::Id modeid = MODEID_MAX;
652         if ((mh->GetModeType() == MODETYPE_USER) || (mh->IsParameterMode()) || (!mh->IsListMode()))
653                 modeid = AllocateModeId(mh->GetModeType());
654
655         if (!modehandlersbyname[mh->GetModeType()].insert(std::make_pair(mh->name, mh)).second)
656                 throw ModuleException("Mode name already in use: " + mh->name);
657
658         // Everything is fine, add the mode
659
660         // If we allocated an id for this mode then save it and put the mode handler into the slot
661         if (modeid != MODEID_MAX)
662         {
663                 mh->modeid = modeid;
664                 modehandlersbyid[mh->GetModeType()][modeid] = mh;
665         }
666
667         slot = mh;
668         if (pm)
669                 mhlist.prefix.push_back(pm);
670         else if (mh->IsListModeBase())
671                 mhlist.list.push_back(mh->IsListModeBase());
672
673         RecreateModeListFor004Numeric();
674 }
675
676 bool ModeParser::DelMode(ModeHandler* mh)
677 {
678         if ((mh->GetModeChar() < 'A') || (mh->GetModeChar() > 'z'))
679                 return false;
680
681         ModeHandlerMap& mhmap = modehandlersbyname[mh->GetModeType()];
682         ModeHandlerMap::iterator mhmapit = mhmap.find(mh->name);
683         if ((mhmapit == mhmap.end()) || (mhmapit->second != mh))
684                 return false;
685
686         ModeHandler*& slot = modehandlers[mh->GetModeType()][mh->GetModeChar()-65];
687         if (slot != mh)
688                 return false;
689
690         /* Note: We can't stack here, as we have modes potentially being removed across many different channels.
691          * To stack here we have to make the algorithm slower. Discuss.
692          */
693         switch (mh->GetModeType())
694         {
695                 case MODETYPE_USER:
696                 {
697                         const user_hash& users = ServerInstance->Users->GetUsers();
698                         for (user_hash::const_iterator i = users.begin(); i != users.end(); )
699                         {
700                                 User* user = i->second;
701                                 ++i;
702                                 mh->RemoveMode(user);
703                         }
704                 }
705                 break;
706                 case MODETYPE_CHANNEL:
707                 {
708                         const chan_hash& chans = ServerInstance->GetChans();
709                         for (chan_hash::const_iterator i = chans.begin(); i != chans.end(); )
710                         {
711                                 // The channel may not be in the hash after RemoveMode(), see m_permchannels
712                                 Channel* chan = i->second;
713                                 ++i;
714
715                                 irc::modestacker stack(false);
716                                 mh->RemoveMode(chan, stack);
717
718                                 std::vector<std::string> stackresult;
719                                 stackresult.push_back(chan->name);
720                                 while (stack.GetStackedLine(stackresult))
721                                 {
722                                         this->Process(stackresult, ServerInstance->FakeClient, MODE_LOCALONLY);
723                                         stackresult.erase(stackresult.begin() + 1, stackresult.end());
724                                 }
725                         }
726                 }
727                 break;
728         }
729
730         mhmap.erase(mhmapit);
731         if (mh->GetId() != MODEID_MAX)
732                 modehandlersbyid[mh->GetModeType()][mh->GetId()] = NULL;
733         slot = NULL;
734         if (mh->IsPrefixMode())
735                 mhlist.prefix.erase(std::find(mhlist.prefix.begin(), mhlist.prefix.end(), mh->IsPrefixMode()));
736         else if (mh->IsListModeBase())
737                 mhlist.list.erase(std::find(mhlist.list.begin(), mhlist.list.end(), mh->IsListModeBase()));
738
739         RecreateModeListFor004Numeric();
740         return true;
741 }
742
743 ModeHandler* ModeParser::FindMode(const std::string& modename, ModeType mt)
744 {
745         ModeHandlerMap& mhmap = modehandlersbyname[mt];
746         ModeHandlerMap::const_iterator it = mhmap.find(modename);
747         if (it != mhmap.end())
748                 return it->second;
749
750         return NULL;
751 }
752
753 ModeHandler* ModeParser::FindMode(unsigned const char modeletter, ModeType mt)
754 {
755         if ((modeletter < 'A') || (modeletter > 'z'))
756                 return NULL;
757
758         return modehandlers[mt][modeletter-65];
759 }
760
761 PrefixMode* ModeParser::FindPrefixMode(unsigned char modeletter)
762 {
763         ModeHandler* mh = FindMode(modeletter, MODETYPE_CHANNEL);
764         if (!mh)
765                 return NULL;
766         return mh->IsPrefixMode();
767 }
768
769 std::string ModeParser::CreateModeList(ModeType mt, bool needparam)
770 {
771         std::string modestr;
772
773         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
774         {
775                 ModeHandler* mh = modehandlers[mt][mode-65];
776                 if ((mh) && ((!needparam) || (mh->GetNumParams(true))))
777                         modestr.push_back(mode);
778         }
779
780         return modestr;
781 }
782
783 void ModeParser::RecreateModeListFor004Numeric()
784 {
785         Cached004ModeList = CreateModeList(MODETYPE_USER) + " " + CreateModeList(MODETYPE_CHANNEL) + " " + CreateModeList(MODETYPE_CHANNEL, true);
786 }
787
788 PrefixMode* ModeParser::FindPrefix(unsigned const char pfxletter)
789 {
790         const PrefixModeList& list = GetPrefixModes();
791         for (PrefixModeList::const_iterator i = list.begin(); i != list.end(); ++i)
792         {
793                 PrefixMode* pm = *i;
794                 if (pm->GetPrefix() == pfxletter)
795                         return pm;
796         }
797         return NULL;
798 }
799
800 std::string ModeParser::GiveModeList(ModeType mt)
801 {
802         std::string type1;      /* Listmodes EXCEPT those with a prefix */
803         std::string type2;      /* Modes that take a param when adding or removing */
804         std::string type3;      /* Modes that only take a param when adding */
805         std::string type4;      /* Modes that dont take a param */
806
807         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
808         {
809                 ModeHandler* mh = modehandlers[mt][mode-65];
810                  /* One parameter when adding */
811                 if (mh)
812                 {
813                         if (mh->GetNumParams(true))
814                         {
815                                 PrefixMode* pm = mh->IsPrefixMode();
816                                 if ((mh->IsListMode()) && ((!pm) || (pm->GetPrefix() == 0)))
817                                 {
818                                         type1 += mh->GetModeChar();
819                                 }
820                                 else
821                                 {
822                                         /* ... and one parameter when removing */
823                                         if (mh->GetNumParams(false))
824                                         {
825                                                 /* But not a list mode */
826                                                 if (!pm)
827                                                 {
828                                                         type2 += mh->GetModeChar();
829                                                 }
830                                         }
831                                         else
832                                         {
833                                                 /* No parameters when removing */
834                                                 type3 += mh->GetModeChar();
835                                         }
836                                 }
837                         }
838                         else
839                         {
840                                 type4 += mh->GetModeChar();
841                         }
842                 }
843         }
844
845         return type1 + "," + type2 + "," + type3 + "," + type4;
846 }
847
848 std::string ModeParser::BuildPrefixes(bool lettersAndModes)
849 {
850         std::string mletters;
851         std::string mprefixes;
852         std::map<int,std::pair<char,char> > prefixes;
853
854         const PrefixModeList& list = GetPrefixModes();
855         for (PrefixModeList::const_iterator i = list.begin(); i != list.end(); ++i)
856         {
857                 PrefixMode* pm = *i;
858                 if (pm->GetPrefix())
859                         prefixes[pm->GetPrefixRank()] = std::make_pair(pm->GetPrefix(), pm->GetModeChar());
860         }
861
862         for(std::map<int,std::pair<char,char> >::reverse_iterator n = prefixes.rbegin(); n != prefixes.rend(); n++)
863         {
864                 mletters = mletters + n->second.first;
865                 mprefixes = mprefixes + n->second.second;
866         }
867
868         return lettersAndModes ? "(" + mprefixes + ")" + mletters : mletters;
869 }
870
871 void ModeParser::AddModeWatcher(ModeWatcher* mw)
872 {
873         modewatchermap.insert(std::make_pair(mw->GetModeName(), mw));
874 }
875
876 bool ModeParser::DelModeWatcher(ModeWatcher* mw)
877 {
878         std::pair<ModeWatchIter, ModeWatchIter> itpair = modewatchermap.equal_range(mw->GetModeName());
879         for (ModeWatchIter i = itpair.first; i != itpair.second; ++i)
880         {
881                 if (i->second == mw)
882                 {
883                         modewatchermap.erase(i);
884                         return true;
885                 }
886         }
887
888         return false;
889 }
890
891 void ModeHandler::RemoveMode(User* user)
892 {
893         // Remove the mode if it's set on the user
894         if (user->IsModeSet(this->GetModeChar()))
895         {
896                 std::vector<std::string> parameters;
897                 parameters.push_back(user->nick);
898                 parameters.push_back("-");
899                 parameters[1].push_back(this->GetModeChar());
900                 ServerInstance->Modes->Process(parameters, ServerInstance->FakeClient, ModeParser::MODE_LOCALONLY);
901         }
902 }
903
904 void ModeHandler::RemoveMode(Channel* channel, irc::modestacker& stack)
905 {
906         if (channel->IsModeSet(this))
907         {
908                 if (this->GetNumParams(false))
909                         // Removing this mode requires a parameter
910                         stack.Push(this->GetModeChar(), channel->GetModeParameter(this));
911                 else
912                         stack.Push(this->GetModeChar());
913         }
914 }
915
916 void PrefixMode::RemoveMode(Channel* chan, irc::modestacker& stack)
917 {
918         const UserMembList& userlist = chan->GetUsers();
919         for (UserMembCIter i = userlist.begin(); i != userlist.end(); ++i)
920         {
921                 if (i->second->hasMode(this->GetModeChar()))
922                         stack.Push(this->GetModeChar(), i->first->nick);
923         }
924 }
925
926 struct builtin_modes
927 {
928         ModeChannelSecret s;
929         ModeChannelPrivate p;
930         ModeChannelModerated m;
931         ModeChannelTopicOps t;
932
933         ModeChannelNoExternal n;
934         ModeChannelInviteOnly i;
935         ModeChannelKey k;
936         ModeChannelLimit l;
937
938         ModeChannelBan b;
939         ModeChannelOp o;
940         ModeChannelVoice v;
941
942         ModeUserInvisible ui;
943         ModeUserOperator uo;
944         ModeUserServerNoticeMask us;
945
946         void init()
947         {
948                 ServiceProvider* modes[] = { &s, &p, &m, &t, &n, &i, &k, &l, &b, &o, &v,
949                                                                          &ui, &uo, &us };
950                 ServerInstance->Modules->AddServices(modes, sizeof(modes)/sizeof(ServiceProvider*));
951         }
952 };
953
954 static builtin_modes static_modes;
955
956 void ModeParser::InitBuiltinModes()
957 {
958         static_modes.init();
959         static_modes.b.DoRehash();
960 }
961
962 ModeParser::ModeParser()
963 {
964         /* Clear mode handler list */
965         memset(modehandlers, 0, sizeof(modehandlers));
966         memset(modehandlersbyid, 0, sizeof(modehandlersbyid));
967
968         seq = 0;
969         memset(&sent, 0, sizeof(sent));
970 }
971
972 ModeParser::~ModeParser()
973 {
974 }