]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/mode.cpp
Remove ModeParser::LastParseTranslate and GetLastParseTranslate()
[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, unsigned int Rank, char PrefixChar)
186         : ModeHandler(Creator, Name, ModeLetter, PARAM_ALWAYS, MODETYPE_CHANNEL, MC_PREFIX)
187         , prefix(PrefixChar), prefixrank(Rank)
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         LastChangeList.clear();
377
378         if ((!targetchannel) && ((!targetuser) || (IS_SERVER(targetuser))))
379         {
380                 user->WriteNumeric(ERR_NOSUCHNICK, "%s :No such nick/channel", target.c_str());
381                 return;
382         }
383         if (parameters.size() == 1)
384         {
385                 this->DisplayCurrentModes(user, targetuser, targetchannel, target.c_str());
386                 return;
387         }
388
389         ModResult MOD_RESULT;
390         FIRST_MOD_RESULT(OnPreMode, MOD_RESULT, (user, targetuser, targetchannel, parameters));
391
392         bool SkipAccessChecks = false;
393
394         if (!IS_LOCAL(user) || MOD_RESULT == MOD_RES_ALLOW)
395                 SkipAccessChecks = true;
396         else if (MOD_RESULT == MOD_RES_DENY)
397                 return;
398
399         if (targetuser && !SkipAccessChecks && user != targetuser)
400         {
401                 user->WriteNumeric(ERR_USERSDONTMATCH, ":Can't change mode for other users");
402                 return;
403         }
404
405         const std::string& mode_sequence = parameters[1];
406
407         std::string output_mode;
408         std::string output_parameters;
409
410         bool adding = true;
411         char output_pm = '\0'; // current output state, '+' or '-'
412         unsigned int param_at = 2;
413
414         for (std::string::const_iterator letter = mode_sequence.begin(); letter != mode_sequence.end(); letter++)
415         {
416                 unsigned char modechar = *letter;
417                 if (modechar == '+' || modechar == '-')
418                 {
419                         adding = (modechar == '+');
420                         continue;
421                 }
422
423                 ModeHandler *mh = this->FindMode(modechar, type);
424                 if (!mh)
425                 {
426                         /* No mode handler? Unknown mode character then. */
427                         user->WriteNumeric(type == MODETYPE_CHANNEL ? ERR_UNKNOWNMODE : ERR_UNKNOWNSNOMASK, "%c :is unknown mode char to me", modechar);
428                         continue;
429                 }
430
431                 std::string parameter;
432                 int pcnt = mh->GetNumParams(adding);
433                 if (pcnt && param_at == parameters.size())
434                 {
435                         /* No parameter, continue to the next mode */
436                         mh->OnParameterMissing(user, targetuser, targetchannel);
437                         continue;
438                 }
439                 else if (pcnt)
440                 {
441                         parameter = parameters[param_at++];
442                         /* Make sure the user isn't trying to slip in an invalid parameter */
443                         if ((parameter.find(':') == 0) || (parameter.rfind(' ') != std::string::npos))
444                                 continue;
445                         if ((flags & MODE_MERGE) && targetchannel && targetchannel->IsModeSet(mh) && !mh->IsListMode())
446                         {
447                                 std::string ours = targetchannel->GetModeParameter(mh);
448                                 if (!mh->ResolveModeConflict(parameter, ours, targetchannel))
449                                         /* we won the mode merge, don't apply this mode */
450                                         continue;
451                         }
452                 }
453
454                 ModeAction ma = TryMode(user, targetuser, targetchannel, adding, modechar, parameter, SkipAccessChecks);
455
456                 if (ma != MODEACTION_ALLOW)
457                         continue;
458
459                 char needed_pm = adding ? '+' : '-';
460                 if (needed_pm != output_pm)
461                 {
462                         output_pm = needed_pm;
463                         output_mode.append(1, output_pm);
464                 }
465                 output_mode.append(1, modechar);
466
467                 if (pcnt)
468                 {
469                         output_parameters.push_back(' ');
470                         output_parameters.append(parameter);
471                 }
472                 LastChangeList.push(mh, adding, parameter);
473
474                 if ((output_mode.length() + output_parameters.length() > 450)
475                                 || (output_mode.length() > 100)
476                                 || (LastChangeList.size() >= ServerInstance->Config->Limits.MaxModes))
477                 {
478                         /* mode sequence is getting too long */
479                         break;
480                 }
481         }
482
483         if (!output_mode.empty())
484         {
485                 LastParse = targetchannel ? targetchannel->name : targetuser->nick;
486                 LastParse.append(" ");
487                 LastParse.append(output_mode);
488                 LastParse.append(output_parameters);
489
490                 if (targetchannel)
491                         targetchannel->WriteChannel(user, "MODE " + LastParse);
492                 else
493                         targetuser->WriteFrom(user, "MODE " + LastParse);
494
495                 FOREACH_MOD(OnMode, (user, targetuser, targetchannel, LastChangeList, flags, output_mode));
496         }
497         else if (targetchannel && parameters.size() == 2)
498         {
499                 /* Special case for displaying the list for listmodes,
500                  * e.g. MODE #chan b, or MODE #chan +b without a parameter
501                  */
502                 this->DisplayListModes(user, targetchannel, mode_sequence);
503         }
504 }
505
506 void ModeParser::DisplayListModes(User* user, Channel* chan, const std::string& mode_sequence)
507 {
508         seq++;
509
510         for (std::string::const_iterator letter = mode_sequence.begin(); letter != mode_sequence.end(); letter++)
511         {
512                 unsigned char mletter = *letter;
513                 if (mletter == '+')
514                         continue;
515
516                 /* Ensure the user doesnt request the same mode twice,
517                  * so they cant flood themselves off out of idiocy.
518                  */
519                 if (sent[mletter] == seq)
520                         continue;
521
522                 sent[mletter] = seq;
523
524                 ModeHandler *mh = this->FindMode(mletter, MODETYPE_CHANNEL);
525
526                 if (!mh || !mh->IsListMode())
527                         return;
528
529                 ModResult MOD_RESULT;
530                 FIRST_MOD_RESULT(OnRawMode, MOD_RESULT, (user, chan, mh, "", true));
531                 if (MOD_RESULT == MOD_RES_DENY)
532                         continue;
533
534                 bool display = true;
535                 if (!user->HasPrivPermission("channels/auspex") && ServerInstance->Config->HideModeLists[mletter] && (chan->GetPrefixValue(user) < HALFOP_VALUE))
536                 {
537                         user->WriteNumeric(ERR_CHANOPRIVSNEEDED, "%s :You do not have access to view the +%c list",
538                                 chan->name.c_str(), mletter);
539                         display = false;
540                 }
541
542                 // Ask mode watchers whether it's OK to show the list
543                 std::pair<ModeWatchIter, ModeWatchIter> itpair = modewatchermap.equal_range(mh->name);
544                 for (ModeWatchIter i = itpair.first; i != itpair.second; ++i)
545                 {
546                         ModeWatcher* mw = i->second;
547                         if (mw->GetModeType() == MODETYPE_CHANNEL)
548                         {
549                                 std::string dummyparam;
550
551                                 if (!mw->BeforeMode(user, NULL, chan, dummyparam, true))
552                                 {
553                                         // A mode watcher doesn't want us to show the list
554                                         display = false;
555                                         break;
556                                 }
557                         }
558                 }
559
560                 if (display)
561                         mh->DisplayList(user, chan);
562                 else
563                         mh->DisplayEmptyList(user, chan);
564         }
565 }
566
567 void ModeParser::CleanMask(std::string &mask)
568 {
569         std::string::size_type pos_of_pling = mask.find_first_of('!');
570         std::string::size_type pos_of_at = mask.find_first_of('@');
571         std::string::size_type pos_of_dot = mask.find_first_of('.');
572         std::string::size_type pos_of_colons = mask.find("::"); /* Because ipv6 addresses are colon delimited -- double so it treats extban as nick */
573
574         if (mask.length() >= 2 && mask[1] == ':')
575                 return; // if it's an extban, don't even try guess how it needs to be formed.
576
577         if ((pos_of_pling == std::string::npos) && (pos_of_at == std::string::npos))
578         {
579                 /* Just a nick, or just a host - or clearly ipv6 (starting with :) */
580                 if ((pos_of_dot == std::string::npos) && (pos_of_colons == std::string::npos) && mask[0] != ':')
581                 {
582                         /* It has no '.' in it, it must be a nick. */
583                         mask.append("!*@*");
584                 }
585                 else
586                 {
587                         /* Got a dot in it? Has to be a host */
588                         mask = "*!*@" + mask;
589                 }
590         }
591         else if ((pos_of_pling == std::string::npos) && (pos_of_at != std::string::npos))
592         {
593                 /* Has an @ but no !, its a user@host */
594                  mask = "*!" + mask;
595         }
596         else if ((pos_of_pling != std::string::npos) && (pos_of_at == std::string::npos))
597         {
598                 /* Has a ! but no @, it must be a nick!ident */
599                 mask.append("@*");
600         }
601 }
602
603 ModeHandler::Id ModeParser::AllocateModeId(ModeType mt)
604 {
605         for (ModeHandler::Id i = 0; i != MODEID_MAX; ++i)
606         {
607                 if (!modehandlersbyid[mt][i])
608                         return i;
609         }
610
611         throw ModuleException("Out of ModeIds");
612 }
613
614 void ModeParser::AddMode(ModeHandler* mh)
615 {
616         /* Yes, i know, this might let people declare modes like '_' or '^'.
617          * If they do that, thats their problem, and if i ever EVER see an
618          * official InspIRCd developer do that, i'll beat them with a paddle!
619          */
620         if ((mh->GetModeChar() < 'A') || (mh->GetModeChar() > 'z'))
621                 throw ModuleException("Invalid letter for mode " + mh->name);
622
623         /* A mode prefix of ',' is not acceptable, it would fuck up server to server.
624          * A mode prefix of ':' will fuck up both server to server, and client to server.
625          * A mode prefix of '#' will mess up /whois and /privmsg
626          */
627         PrefixMode* pm = mh->IsPrefixMode();
628         if (pm)
629         {
630                 if ((pm->GetPrefix() > 126) || (pm->GetPrefix() == ',') || (pm->GetPrefix() == ':') || (pm->GetPrefix() == '#'))
631                         throw ModuleException("Invalid prefix for mode " + mh->name);
632
633                 if (FindPrefix(pm->GetPrefix()))
634                         throw ModuleException("Prefix already exists for mode " + mh->name);
635         }
636
637         ModeHandler*& slot = modehandlers[mh->GetModeType()][mh->GetModeChar()-65];
638         if (slot)
639                 throw ModuleException("Letter is already in use for mode " + mh->name);
640
641         // The mode needs an id if it is either a user mode, a simple mode (flag) or a parameter mode.
642         // Otherwise (for listmodes and prefix modes) the id remains MODEID_MAX, which is invalid.
643         ModeHandler::Id modeid = MODEID_MAX;
644         if ((mh->GetModeType() == MODETYPE_USER) || (mh->IsParameterMode()) || (!mh->IsListMode()))
645                 modeid = AllocateModeId(mh->GetModeType());
646
647         if (!modehandlersbyname[mh->GetModeType()].insert(std::make_pair(mh->name, mh)).second)
648                 throw ModuleException("Mode name already in use: " + mh->name);
649
650         // Everything is fine, add the mode
651
652         // If we allocated an id for this mode then save it and put the mode handler into the slot
653         if (modeid != MODEID_MAX)
654         {
655                 mh->modeid = modeid;
656                 modehandlersbyid[mh->GetModeType()][modeid] = mh;
657         }
658
659         slot = mh;
660         if (pm)
661                 mhlist.prefix.push_back(pm);
662         else if (mh->IsListModeBase())
663                 mhlist.list.push_back(mh->IsListModeBase());
664
665         RecreateModeListFor004Numeric();
666 }
667
668 bool ModeParser::DelMode(ModeHandler* mh)
669 {
670         if ((mh->GetModeChar() < 'A') || (mh->GetModeChar() > 'z'))
671                 return false;
672
673         ModeHandlerMap& mhmap = modehandlersbyname[mh->GetModeType()];
674         ModeHandlerMap::iterator mhmapit = mhmap.find(mh->name);
675         if ((mhmapit == mhmap.end()) || (mhmapit->second != mh))
676                 return false;
677
678         ModeHandler*& slot = modehandlers[mh->GetModeType()][mh->GetModeChar()-65];
679         if (slot != mh)
680                 return false;
681
682         /* Note: We can't stack here, as we have modes potentially being removed across many different channels.
683          * To stack here we have to make the algorithm slower. Discuss.
684          */
685         switch (mh->GetModeType())
686         {
687                 case MODETYPE_USER:
688                 {
689                         const user_hash& users = ServerInstance->Users->GetUsers();
690                         for (user_hash::const_iterator i = users.begin(); i != users.end(); )
691                         {
692                                 User* user = i->second;
693                                 ++i;
694                                 mh->RemoveMode(user);
695                         }
696                 }
697                 break;
698                 case MODETYPE_CHANNEL:
699                 {
700                         const chan_hash& chans = ServerInstance->GetChans();
701                         for (chan_hash::const_iterator i = chans.begin(); i != chans.end(); )
702                         {
703                                 // The channel may not be in the hash after RemoveMode(), see m_permchannels
704                                 Channel* chan = i->second;
705                                 ++i;
706
707                                 irc::modestacker stack(false);
708                                 mh->RemoveMode(chan, stack);
709
710                                 std::vector<std::string> stackresult;
711                                 stackresult.push_back(chan->name);
712                                 while (stack.GetStackedLine(stackresult))
713                                 {
714                                         this->Process(stackresult, ServerInstance->FakeClient, MODE_LOCALONLY);
715                                         stackresult.erase(stackresult.begin() + 1, stackresult.end());
716                                 }
717                         }
718                 }
719                 break;
720         }
721
722         mhmap.erase(mhmapit);
723         if (mh->GetId() != MODEID_MAX)
724                 modehandlersbyid[mh->GetModeType()][mh->GetId()] = NULL;
725         slot = NULL;
726         if (mh->IsPrefixMode())
727                 mhlist.prefix.erase(std::find(mhlist.prefix.begin(), mhlist.prefix.end(), mh->IsPrefixMode()));
728         else if (mh->IsListModeBase())
729                 mhlist.list.erase(std::find(mhlist.list.begin(), mhlist.list.end(), mh->IsListModeBase()));
730
731         RecreateModeListFor004Numeric();
732         return true;
733 }
734
735 ModeHandler* ModeParser::FindMode(const std::string& modename, ModeType mt)
736 {
737         ModeHandlerMap& mhmap = modehandlersbyname[mt];
738         ModeHandlerMap::const_iterator it = mhmap.find(modename);
739         if (it != mhmap.end())
740                 return it->second;
741
742         return NULL;
743 }
744
745 ModeHandler* ModeParser::FindMode(unsigned const char modeletter, ModeType mt)
746 {
747         if ((modeletter < 'A') || (modeletter > 'z'))
748                 return NULL;
749
750         return modehandlers[mt][modeletter-65];
751 }
752
753 PrefixMode* ModeParser::FindPrefixMode(unsigned char modeletter)
754 {
755         ModeHandler* mh = FindMode(modeletter, MODETYPE_CHANNEL);
756         if (!mh)
757                 return NULL;
758         return mh->IsPrefixMode();
759 }
760
761 std::string ModeParser::CreateModeList(ModeType mt, bool needparam)
762 {
763         std::string modestr;
764
765         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
766         {
767                 ModeHandler* mh = modehandlers[mt][mode-65];
768                 if ((mh) && ((!needparam) || (mh->GetNumParams(true))))
769                         modestr.push_back(mode);
770         }
771
772         return modestr;
773 }
774
775 void ModeParser::RecreateModeListFor004Numeric()
776 {
777         Cached004ModeList = CreateModeList(MODETYPE_USER) + " " + CreateModeList(MODETYPE_CHANNEL) + " " + CreateModeList(MODETYPE_CHANNEL, true);
778 }
779
780 PrefixMode* ModeParser::FindPrefix(unsigned const char pfxletter)
781 {
782         const PrefixModeList& list = GetPrefixModes();
783         for (PrefixModeList::const_iterator i = list.begin(); i != list.end(); ++i)
784         {
785                 PrefixMode* pm = *i;
786                 if (pm->GetPrefix() == pfxletter)
787                         return pm;
788         }
789         return NULL;
790 }
791
792 std::string ModeParser::GiveModeList(ModeType mt)
793 {
794         std::string type1;      /* Listmodes EXCEPT those with a prefix */
795         std::string type2;      /* Modes that take a param when adding or removing */
796         std::string type3;      /* Modes that only take a param when adding */
797         std::string type4;      /* Modes that dont take a param */
798
799         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
800         {
801                 ModeHandler* mh = modehandlers[mt][mode-65];
802                  /* One parameter when adding */
803                 if (mh)
804                 {
805                         if (mh->GetNumParams(true))
806                         {
807                                 PrefixMode* pm = mh->IsPrefixMode();
808                                 if ((mh->IsListMode()) && ((!pm) || (pm->GetPrefix() == 0)))
809                                 {
810                                         type1 += mh->GetModeChar();
811                                 }
812                                 else
813                                 {
814                                         /* ... and one parameter when removing */
815                                         if (mh->GetNumParams(false))
816                                         {
817                                                 /* But not a list mode */
818                                                 if (!pm)
819                                                 {
820                                                         type2 += mh->GetModeChar();
821                                                 }
822                                         }
823                                         else
824                                         {
825                                                 /* No parameters when removing */
826                                                 type3 += mh->GetModeChar();
827                                         }
828                                 }
829                         }
830                         else
831                         {
832                                 type4 += mh->GetModeChar();
833                         }
834                 }
835         }
836
837         return type1 + "," + type2 + "," + type3 + "," + type4;
838 }
839
840 std::string ModeParser::BuildPrefixes(bool lettersAndModes)
841 {
842         std::string mletters;
843         std::string mprefixes;
844         std::map<int,std::pair<char,char> > prefixes;
845
846         const PrefixModeList& list = GetPrefixModes();
847         for (PrefixModeList::const_iterator i = list.begin(); i != list.end(); ++i)
848         {
849                 PrefixMode* pm = *i;
850                 if (pm->GetPrefix())
851                         prefixes[pm->GetPrefixRank()] = std::make_pair(pm->GetPrefix(), pm->GetModeChar());
852         }
853
854         for(std::map<int,std::pair<char,char> >::reverse_iterator n = prefixes.rbegin(); n != prefixes.rend(); n++)
855         {
856                 mletters = mletters + n->second.first;
857                 mprefixes = mprefixes + n->second.second;
858         }
859
860         return lettersAndModes ? "(" + mprefixes + ")" + mletters : mletters;
861 }
862
863 void ModeParser::AddModeWatcher(ModeWatcher* mw)
864 {
865         modewatchermap.insert(std::make_pair(mw->GetModeName(), mw));
866 }
867
868 bool ModeParser::DelModeWatcher(ModeWatcher* mw)
869 {
870         std::pair<ModeWatchIter, ModeWatchIter> itpair = modewatchermap.equal_range(mw->GetModeName());
871         for (ModeWatchIter i = itpair.first; i != itpair.second; ++i)
872         {
873                 if (i->second == mw)
874                 {
875                         modewatchermap.erase(i);
876                         return true;
877                 }
878         }
879
880         return false;
881 }
882
883 void ModeHandler::RemoveMode(User* user)
884 {
885         // Remove the mode if it's set on the user
886         if (user->IsModeSet(this->GetModeChar()))
887         {
888                 std::vector<std::string> parameters;
889                 parameters.push_back(user->nick);
890                 parameters.push_back("-");
891                 parameters[1].push_back(this->GetModeChar());
892                 ServerInstance->Modes->Process(parameters, ServerInstance->FakeClient, ModeParser::MODE_LOCALONLY);
893         }
894 }
895
896 void ModeHandler::RemoveMode(Channel* channel, irc::modestacker& stack)
897 {
898         if (channel->IsModeSet(this))
899         {
900                 if (this->GetNumParams(false))
901                         // Removing this mode requires a parameter
902                         stack.Push(this->GetModeChar(), channel->GetModeParameter(this));
903                 else
904                         stack.Push(this->GetModeChar());
905         }
906 }
907
908 void PrefixMode::RemoveMode(Channel* chan, irc::modestacker& stack)
909 {
910         const Channel::MemberMap& userlist = chan->GetUsers();
911         for (Channel::MemberMap::const_iterator i = userlist.begin(); i != userlist.end(); ++i)
912         {
913                 if (i->second->hasMode(this->GetModeChar()))
914                         stack.Push(this->GetModeChar(), i->first->nick);
915         }
916 }
917
918 struct builtin_modes
919 {
920         SimpleChannelModeHandler s;
921         SimpleChannelModeHandler p;
922         SimpleChannelModeHandler m;
923         SimpleChannelModeHandler t;
924
925         SimpleChannelModeHandler n;
926         SimpleChannelModeHandler i;
927         ModeChannelKey k;
928         ModeChannelLimit l;
929
930         ModeChannelBan b;
931         ModeChannelOp o;
932         ModeChannelVoice v;
933
934         SimpleUserModeHandler ui;
935         ModeUserOperator uo;
936         ModeUserServerNoticeMask us;
937
938         builtin_modes()
939                 : s(NULL, "secret", 's')
940                 , p(NULL, "private", 'p')
941                 , m(NULL, "moderated", 'm')
942                 , t(NULL, "topiclock", 't')
943                 , n(NULL, "noextmsg", 'n')
944                 , i(NULL, "inviteonly", 'i')
945                 , ui(NULL, "invisible", 'i')
946         {
947         }
948
949         void init()
950         {
951                 ServiceProvider* modes[] = { &s, &p, &m, &t, &n, &i, &k, &l, &b, &o, &v,
952                                                                          &ui, &uo, &us };
953                 ServerInstance->Modules->AddServices(modes, sizeof(modes)/sizeof(ServiceProvider*));
954         }
955 };
956
957 static builtin_modes static_modes;
958
959 void ModeParser::InitBuiltinModes()
960 {
961         static_modes.init();
962         static_modes.b.DoRehash();
963 }
964
965 ModeParser::ModeParser()
966 {
967         /* Clear mode handler list */
968         memset(modehandlers, 0, sizeof(modehandlers));
969         memset(modehandlersbyid, 0, sizeof(modehandlersbyid));
970
971         seq = 0;
972         memset(&sent, 0, sizeof(sent));
973 }
974
975 ModeParser::~ModeParser()
976 {
977 }