]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/mode.cpp
Introduce ModeProcessFlags, can be passed to ModeParser::Process() to indicate local...
[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)
30         : ServiceProvider(Creator, Name, SERVICE_MODE), m_paramtype(TR_TEXT),
31         parameters_taken(Params), mode(modeletter), prefix(0), oper(false),
32         list(false), m_type(type), levelrequired(HALFOP_VALUE), prefixrank(0)
33 {
34 }
35
36 CullResult ModeHandler::cull()
37 {
38         if (ServerInstance->Modes)
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->GetModeChar()) == 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->GetModeChar(), 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->GetModeChar()) == 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->GetModeChar(), adding);
126
127         return MODEACTION_ALLOW;
128 }
129
130 ModeAction ParamChannelModeHandler::OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
131 {
132         if (adding && !ParamValidate(parameter))
133                 return MODEACTION_DENY;
134         std::string now = channel->GetModeParameter(this);
135         if (parameter == now)
136                 return MODEACTION_DENY;
137         if (adding)
138                 channel->SetModeParam(this, parameter);
139         else
140                 channel->SetModeParam(this, "");
141         return MODEACTION_ALLOW;
142 }
143
144 bool ParamChannelModeHandler::ParamValidate(std::string& parameter)
145 {
146         return true;
147 }
148
149 ModeWatcher::ModeWatcher(Module* Creator, const std::string& modename, ModeType type)
150         : mode(modename), m_type(type), creator(Creator)
151 {
152 }
153
154 ModeWatcher::~ModeWatcher()
155 {
156 }
157
158 ModeType ModeWatcher::GetModeType()
159 {
160         return m_type;
161 }
162
163 bool ModeWatcher::BeforeMode(User*, User*, Channel*, std::string&, bool)
164 {
165         return true;
166 }
167
168 void ModeWatcher::AfterMode(User*, User*, Channel*, const std::string&, bool)
169 {
170 }
171
172 void ModeParser::DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text)
173 {
174         if (targetchannel)
175         {
176                 /* Display channel's current mode string */
177                 user->WriteNumeric(RPL_CHANNELMODEIS, "%s %s +%s",user->nick.c_str(), targetchannel->name.c_str(), targetchannel->ChanModes(targetchannel->HasUser(user)));
178                 user->WriteNumeric(RPL_CHANNELCREATED, "%s %s %lu", user->nick.c_str(), targetchannel->name.c_str(), (unsigned long)targetchannel->age);
179                 return;
180         }
181         else
182         {
183                 if (targetuser == user || user->HasPrivPermission("users/auspex"))
184                 {
185                         /* Display user's current mode string */
186                         user->WriteNumeric(RPL_UMODEIS, "%s :+%s",targetuser->nick.c_str(),targetuser->FormatModes());
187                         if ((targetuser->IsOper()))
188                                 user->WriteNumeric(RPL_SNOMASKIS, "%s +%s :Server notice mask", targetuser->nick.c_str(), targetuser->FormatNoticeMasks().c_str());
189                         return;
190                 }
191                 else
192                 {
193                         user->WriteNumeric(ERR_USERSDONTMATCH, "%s :Can't view modes for other users", user->nick.c_str());
194                         return;
195                 }
196         }
197 }
198
199 ModeAction ModeParser::TryMode(User* user, User* targetuser, Channel* chan, bool adding, const unsigned char modechar,
200                 std::string &parameter, bool SkipACL)
201 {
202         ModeType type = chan ? MODETYPE_CHANNEL : MODETYPE_USER;
203
204         ModeHandler *mh = FindMode(modechar, type);
205         int pcnt = mh->GetNumParams(adding);
206
207         // crop mode parameter size to 250 characters
208         if (parameter.length() > 250 && adding)
209                 parameter = parameter.substr(0, 250);
210
211         ModResult MOD_RESULT;
212         FIRST_MOD_RESULT(OnRawMode, MOD_RESULT, (user, chan, modechar, parameter, adding, pcnt));
213
214         if (IS_LOCAL(user) && (MOD_RESULT == MOD_RES_DENY))
215                 return MODEACTION_DENY;
216
217         if (chan && !SkipACL && (MOD_RESULT != MOD_RES_ALLOW))
218         {
219                 MOD_RESULT = mh->AccessCheck(user, chan, parameter, adding);
220
221                 if (MOD_RESULT == MOD_RES_DENY)
222                         return MODEACTION_DENY;
223                 if (MOD_RESULT == MOD_RES_PASSTHRU)
224                 {
225                         unsigned int neededrank = mh->GetLevelRequired();
226                         /* Compare our rank on the channel against the rank of the required prefix,
227                          * allow if >= ours. Because mIRC and xchat throw a tizz if the modes shown
228                          * in NAMES(X) are not in rank order, we know the most powerful mode is listed
229                          * first, so we don't need to iterate, we just look up the first instead.
230                          */
231                         unsigned int ourrank = chan->GetPrefixValue(user);
232                         if (ourrank < neededrank)
233                         {
234                                 ModeHandler* neededmh = NULL;
235                                 for(char c='A'; c <= 'z'; c++)
236                                 {
237                                         ModeHandler *privmh = FindMode(c, MODETYPE_CHANNEL);
238                                         if (privmh && privmh->GetPrefixRank() >= neededrank)
239                                         {
240                                                 // this mode is sufficient to allow this action
241                                                 if (!neededmh || privmh->GetPrefixRank() < neededmh->GetPrefixRank())
242                                                         neededmh = privmh;
243                                         }
244                                 }
245                                 if (neededmh)
246                                         user->WriteNumeric(ERR_CHANOPRIVSNEEDED, "%s %s :You must have channel %s access or above to %sset channel mode %c",
247                                                 user->nick.c_str(), chan->name.c_str(), neededmh->name.c_str(), adding ? "" : "un", modechar);
248                                 else
249                                         user->WriteNumeric(ERR_CHANOPRIVSNEEDED, "%s %s :You cannot %sset channel mode %c",
250                                                 user->nick.c_str(), chan->name.c_str(), adding ? "" : "un", modechar);
251                                 return MODEACTION_DENY;
252                         }
253                 }
254         }
255
256         // Ask mode watchers whether this mode change is OK
257         std::pair<ModeWatchIter, ModeWatchIter> itpair = modewatchermap.equal_range(mh->name);
258         for (ModeWatchIter i = itpair.first; i != itpair.second; ++i)
259         {
260                 ModeWatcher* mw = i->second;
261                 if (mw->GetModeType() == type)
262                 {
263                         if (!mw->BeforeMode(user, targetuser, chan, parameter, adding))
264                                 return MODEACTION_DENY;
265
266                         // A module whacked the parameter completely, and there was one. Abort.
267                         if (pcnt && parameter.empty())
268                                 return MODEACTION_DENY;
269                 }
270         }
271
272         if (IS_LOCAL(user) && !user->IsOper())
273         {
274                 char* disabled = (type == MODETYPE_CHANNEL) ? ServerInstance->Config->DisabledCModes : ServerInstance->Config->DisabledUModes;
275                 if (disabled[modechar - 'A'])
276                 {
277                         user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - %s mode %c has been locked by the administrator",
278                                 user->nick.c_str(), type == MODETYPE_CHANNEL ? "channel" : "user", modechar);
279                         return MODEACTION_DENY;
280                 }
281         }
282
283         if (adding && IS_LOCAL(user) && mh->NeedsOper() && !user->HasModePermission(modechar, type))
284         {
285                 /* It's an oper only mode, and they don't have access to it. */
286                 if (user->IsOper())
287                 {
288                         user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - Oper type %s does not have access to set %s mode %c",
289                                         user->nick.c_str(), user->oper->name.c_str(), type == MODETYPE_CHANNEL ? "channel" : "user", modechar);
290                 }
291                 else
292                 {
293                         user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - Only operators may set %s mode %c",
294                                         user->nick.c_str(), type == MODETYPE_CHANNEL ? "channel" : "user", modechar);
295                 }
296                 return MODEACTION_DENY;
297         }
298
299         if (mh->GetTranslateType() == TR_NICK && !ServerInstance->FindNick(parameter))
300         {
301                 user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nick/channel", user->nick.c_str(), parameter.c_str());
302                 return MODEACTION_DENY;
303         }
304
305         if (mh->GetPrefixRank() && chan)
306         {
307                 User* user_to_prefix = ServerInstance->FindNick(parameter);
308                 if (!user_to_prefix)
309                         return MODEACTION_DENY;
310                 if (!chan->SetPrefix(user_to_prefix, modechar, adding))
311                         return MODEACTION_DENY;
312         }
313
314         /* Call the handler for the mode */
315         ModeAction ma = mh->OnModeChange(user, targetuser, chan, parameter, adding);
316
317         if (pcnt && parameter.empty())
318                 return MODEACTION_DENY;
319
320         if (ma != MODEACTION_ALLOW)
321                 return ma;
322
323         itpair = modewatchermap.equal_range(mh->name);
324         for (ModeWatchIter i = itpair.first; i != itpair.second; ++i)
325         {
326                 ModeWatcher* mw = i->second;
327                 if (mw->GetModeType() == type)
328                         mw->AfterMode(user, targetuser, chan, parameter, adding);
329         }
330
331         return MODEACTION_ALLOW;
332 }
333
334 void ModeParser::Process(const std::vector<std::string>& parameters, User* user, ModeProcessFlag flags)
335 {
336         std::string target = parameters[0];
337         Channel* targetchannel = ServerInstance->FindChan(target);
338         User* targetuser  = ServerInstance->FindNick(target);
339         ModeType type = targetchannel ? MODETYPE_CHANNEL : MODETYPE_USER;
340
341         LastParse.clear();
342         LastParseParams.clear();
343         LastParseTranslate.clear();
344
345         if ((!targetchannel) && ((!targetuser) || (IS_SERVER(targetuser))))
346         {
347                 user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nick/channel",user->nick.c_str(),target.c_str());
348                 return;
349         }
350         if (parameters.size() == 1)
351         {
352                 this->DisplayCurrentModes(user, targetuser, targetchannel, target.c_str());
353                 return;
354         }
355
356         ModResult MOD_RESULT;
357         FIRST_MOD_RESULT(OnPreMode, MOD_RESULT, (user, targetuser, targetchannel, parameters));
358
359         bool SkipAccessChecks = false;
360
361         if (!IS_LOCAL(user) || ServerInstance->ULine(user->server) || MOD_RESULT == MOD_RES_ALLOW)
362                 SkipAccessChecks = true;
363         else if (MOD_RESULT == MOD_RES_DENY)
364                 return;
365
366         if (targetuser && !SkipAccessChecks && user != targetuser)
367         {
368                 user->WriteNumeric(ERR_USERSDONTMATCH, "%s :Can't change mode for other users", user->nick.c_str());
369                 return;
370         }
371
372         std::string mode_sequence = parameters[1];
373
374         std::string output_mode;
375         std::ostringstream output_parameters;
376         LastParseParams.push_back(output_mode);
377         LastParseTranslate.push_back(TR_TEXT);
378
379         bool adding = true;
380         char output_pm = '\0'; // current output state, '+' or '-'
381         unsigned int param_at = 2;
382
383         for (std::string::const_iterator letter = mode_sequence.begin(); letter != mode_sequence.end(); letter++)
384         {
385                 unsigned char modechar = *letter;
386                 if (modechar == '+' || modechar == '-')
387                 {
388                         adding = (modechar == '+');
389                         continue;
390                 }
391
392                 ModeHandler *mh = this->FindMode(modechar, type);
393                 if (!mh)
394                 {
395                         /* No mode handler? Unknown mode character then. */
396                         user->WriteServ("%d %s %c :is unknown mode char to me", type == MODETYPE_CHANNEL ? 472 : 501, user->nick.c_str(), modechar);
397                         continue;
398                 }
399
400                 std::string parameter;
401                 int pcnt = mh->GetNumParams(adding);
402                 if (pcnt && param_at == parameters.size())
403                 {
404                         /* No parameter, continue to the next mode */
405                         mh->OnParameterMissing(user, targetuser, targetchannel);
406                         continue;
407                 }
408                 else if (pcnt)
409                 {
410                         parameter = parameters[param_at++];
411                         /* Make sure the user isn't trying to slip in an invalid parameter */
412                         if ((parameter.find(':') == 0) || (parameter.rfind(' ') != std::string::npos))
413                                 continue;
414                         if ((flags & MODE_MERGE) && targetchannel && targetchannel->IsModeSet(modechar) && !mh->IsListMode())
415                         {
416                                 std::string ours = targetchannel->GetModeParameter(modechar);
417                                 if (!mh->ResolveModeConflict(parameter, ours, targetchannel))
418                                         /* we won the mode merge, don't apply this mode */
419                                         continue;
420                         }
421                 }
422
423                 ModeAction ma = TryMode(user, targetuser, targetchannel, adding, modechar, parameter, SkipAccessChecks);
424
425                 if (ma != MODEACTION_ALLOW)
426                         continue;
427
428                 char needed_pm = adding ? '+' : '-';
429                 if (needed_pm != output_pm)
430                 {
431                         output_pm = needed_pm;
432                         output_mode.append(1, output_pm);
433                 }
434                 output_mode.append(1, modechar);
435
436                 if (pcnt)
437                 {
438                         TranslateType tt = mh->GetTranslateType();
439                         if (tt == TR_NICK)
440                         {
441                                 User* u = ServerInstance->FindNick(parameter);
442                                 if (u)
443                                         parameter = u->nick;
444                         }
445                         output_parameters << " " << parameter;
446                         LastParseParams.push_back(parameter);
447                         LastParseTranslate.push_back(tt);
448                 }
449
450                 if ( (output_mode.length() + output_parameters.str().length() > 450)
451                                 || (output_mode.length() > 100)
452                                 || (LastParseParams.size() > ServerInstance->Config->Limits.MaxModes))
453                 {
454                         /* mode sequence is getting too long */
455                         break;
456                 }
457         }
458
459         LastParseParams[0] = output_mode;
460
461         if (!output_mode.empty())
462         {
463                 LastParse = targetchannel ? targetchannel->name : targetuser->nick;
464                 LastParse.append(" ");
465                 LastParse.append(output_mode);
466                 LastParse.append(output_parameters.str());
467
468                 if (!(flags & MODE_LOCALONLY))
469                         ServerInstance->PI->SendMode(user, targetuser, targetchannel, LastParseParams, LastParseTranslate);
470
471                 if (targetchannel)
472                 {
473                         targetchannel->WriteChannel(user, "MODE %s", LastParse.c_str());
474                         FOREACH_MOD(I_OnMode,OnMode(user, targetchannel, TYPE_CHANNEL, LastParseParams, LastParseTranslate));
475                 }
476                 else
477                 {
478                         targetuser->WriteFrom(user, "MODE %s", LastParse.c_str());
479                         FOREACH_MOD(I_OnMode,OnMode(user, targetuser, TYPE_USER, LastParseParams, LastParseTranslate));
480                 }
481         }
482         else if (targetchannel && parameters.size() == 2)
483         {
484                 /* Special case for displaying the list for listmodes,
485                  * e.g. MODE #chan b, or MODE #chan +b without a parameter
486                  */
487                 this->DisplayListModes(user, targetchannel, mode_sequence);
488         }
489 }
490
491 void ModeParser::DisplayListModes(User* user, Channel* chan, std::string &mode_sequence)
492 {
493         seq++;
494
495         for (std::string::const_iterator letter = mode_sequence.begin(); letter != mode_sequence.end(); letter++)
496         {
497                 unsigned char mletter = *letter;
498                 if (mletter == '+')
499                         continue;
500
501                 /* Ensure the user doesnt request the same mode twice,
502                  * so they cant flood themselves off out of idiocy.
503                  */
504                 if (sent[mletter] == seq)
505                         continue;
506
507                 sent[mletter] = seq;
508
509                 ModeHandler *mh = this->FindMode(mletter, MODETYPE_CHANNEL);
510
511                 if (!mh || !mh->IsListMode())
512                         return;
513
514                 ModResult MOD_RESULT;
515                 FIRST_MOD_RESULT(OnRawMode, MOD_RESULT, (user, chan, mletter, "", true, 0));
516                 if (MOD_RESULT == MOD_RES_DENY)
517                         continue;
518
519                 bool display = true;
520                 if (!user->HasPrivPermission("channels/auspex") && ServerInstance->Config->HideModeLists[mletter] && (chan->GetPrefixValue(user) < HALFOP_VALUE))
521                 {
522                         user->WriteNumeric(ERR_CHANOPRIVSNEEDED, "%s %s :You do not have access to view the +%c list",
523                                 user->nick.c_str(), chan->name.c_str(), mletter);
524                         display = false;
525                 }
526
527                 // Ask mode watchers whether it's OK to show the list
528                 std::pair<ModeWatchIter, ModeWatchIter> itpair = modewatchermap.equal_range(mh->name);
529                 for (ModeWatchIter i = itpair.first; i != itpair.second; ++i)
530                 {
531                         ModeWatcher* mw = i->second;
532                         if (mw->GetModeType() == MODETYPE_CHANNEL)
533                         {
534                                 std::string dummyparam;
535
536                                 if (!mw->BeforeMode(user, NULL, chan, dummyparam, true))
537                                 {
538                                         // A mode watcher doesn't want us to show the list
539                                         display = false;
540                                         break;
541                                 }
542                         }
543                 }
544
545                 if (display)
546                         mh->DisplayList(user, chan);
547                 else
548                         mh->DisplayEmptyList(user, chan);
549         }
550 }
551
552 void ModeParser::CleanMask(std::string &mask)
553 {
554         std::string::size_type pos_of_pling = mask.find_first_of('!');
555         std::string::size_type pos_of_at = mask.find_first_of('@');
556         std::string::size_type pos_of_dot = mask.find_first_of('.');
557         std::string::size_type pos_of_colons = mask.find("::"); /* Because ipv6 addresses are colon delimited -- double so it treats extban as nick */
558
559         if (mask.length() >= 2 && mask[1] == ':')
560                 return; // if it's an extban, don't even try guess how it needs to be formed.
561
562         if ((pos_of_pling == std::string::npos) && (pos_of_at == std::string::npos))
563         {
564                 /* Just a nick, or just a host - or clearly ipv6 (starting with :) */
565                 if ((pos_of_dot == std::string::npos) && (pos_of_colons == std::string::npos) && mask[0] != ':')
566                 {
567                         /* It has no '.' in it, it must be a nick. */
568                         mask.append("!*@*");
569                 }
570                 else
571                 {
572                         /* Got a dot in it? Has to be a host */
573                         mask = "*!*@" + mask;
574                 }
575         }
576         else if ((pos_of_pling == std::string::npos) && (pos_of_at != std::string::npos))
577         {
578                 /* Has an @ but no !, its a user@host */
579                  mask = "*!" + mask;
580         }
581         else if ((pos_of_pling != std::string::npos) && (pos_of_at == std::string::npos))
582         {
583                 /* Has a ! but no @, it must be a nick!ident */
584                 mask.append("@*");
585         }
586 }
587
588 bool ModeParser::AddMode(ModeHandler* mh)
589 {
590         unsigned char mask = 0;
591         unsigned char pos = 0;
592
593         /* Yes, i know, this might let people declare modes like '_' or '^'.
594          * If they do that, thats their problem, and if i ever EVER see an
595          * official InspIRCd developer do that, i'll beat them with a paddle!
596          */
597         if ((mh->GetModeChar() < 'A') || (mh->GetModeChar() > 'z') || (mh->GetPrefix() > 126))
598                 return false;
599
600         /* A mode prefix of ',' is not acceptable, it would fuck up server to server.
601          * A mode prefix of ':' will fuck up both server to server, and client to server.
602          * A mode prefix of '#' will mess up /whois and /privmsg
603          */
604         if ((mh->GetPrefix() == ',') || (mh->GetPrefix() == ':') || (mh->GetPrefix() == '#'))
605                 return false;
606
607         if (mh->GetPrefix() && FindPrefix(mh->GetPrefix()))
608                 return false;
609
610         mh->GetModeType() == MODETYPE_USER ? mask = MASK_USER : mask = MASK_CHANNEL;
611         pos = (mh->GetModeChar()-65) | mask;
612
613         if (modehandlers[pos])
614                 return false;
615
616         modehandlers[pos] = mh;
617         RecreateModeListFor004Numeric();
618         return true;
619 }
620
621 bool ModeParser::DelMode(ModeHandler* mh)
622 {
623         unsigned char mask = 0;
624         unsigned char pos = 0;
625
626         if ((mh->GetModeChar() < 'A') || (mh->GetModeChar() > 'z'))
627                 return false;
628
629         mh->GetModeType() == MODETYPE_USER ? mask = MASK_USER : mask = MASK_CHANNEL;
630         pos = (mh->GetModeChar()-65) | mask;
631
632         if (modehandlers[pos] != mh)
633                 return false;
634
635         /* Note: We can't stack here, as we have modes potentially being removed across many different channels.
636          * To stack here we have to make the algorithm slower. Discuss.
637          */
638         switch (mh->GetModeType())
639         {
640                 case MODETYPE_USER:
641                         for (user_hash::iterator i = ServerInstance->Users->clientlist->begin(); i != ServerInstance->Users->clientlist->end(); )
642                         {
643                                 User* user = i->second;
644                                 ++i;
645                                 mh->RemoveMode(user);
646                         }
647                 break;
648                 case MODETYPE_CHANNEL:
649                         for (chan_hash::iterator i = ServerInstance->chanlist->begin(); i != ServerInstance->chanlist->end(); )
650                         {
651                                 // The channel may not be in the hash after RemoveMode(), see m_permchannels
652                                 Channel* chan = i->second;
653                                 ++i;
654
655                                 irc::modestacker stack(false);
656                                 mh->RemoveMode(chan, stack);
657
658                                 std::vector<std::string> stackresult;
659                                 stackresult.push_back(chan->name);
660                                 while (stack.GetStackedLine(stackresult))
661                                 {
662                                         this->Process(stackresult, ServerInstance->FakeClient, MODE_LOCALONLY);
663                                         stackresult.erase(stackresult.begin() + 1, stackresult.end());
664                                 }
665                         }
666                 break;
667         }
668
669         modehandlers[pos] = NULL;
670         RecreateModeListFor004Numeric();
671
672         return true;
673 }
674
675 ModeHandler* ModeParser::FindMode(unsigned const char modeletter, ModeType mt)
676 {
677         unsigned char mask = 0;
678         unsigned char pos = 0;
679
680         if ((modeletter < 'A') || (modeletter > 'z'))
681                 return NULL;
682
683         mt == MODETYPE_USER ? mask = MASK_USER : mask = MASK_CHANNEL;
684         pos = (modeletter-65) | mask;
685
686         return modehandlers[pos];
687 }
688
689 std::string ModeParser::CreateModeList(ModeType mt, bool needparam)
690 {
691         std::string modestr;
692         unsigned char mask = ((mt == MODETYPE_CHANNEL) ? MASK_CHANNEL : MASK_USER);
693
694         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
695         {
696                 unsigned char pos = (mode-65) | mask;
697
698                 if ((modehandlers[pos]) && ((!needparam) || (modehandlers[pos]->GetNumParams(true))))
699                         modestr.push_back(mode);
700         }
701
702         return modestr;
703 }
704
705 void ModeParser::RecreateModeListFor004Numeric()
706 {
707         Cached004ModeList = CreateModeList(MODETYPE_USER) + " " + CreateModeList(MODETYPE_CHANNEL) + " " + CreateModeList(MODETYPE_CHANNEL, true);
708 }
709
710 ModeHandler* ModeParser::FindPrefix(unsigned const char pfxletter)
711 {
712         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
713         {
714                 unsigned char pos = (mode-65) | MASK_CHANNEL;
715
716                 if ((modehandlers[pos]) && (modehandlers[pos]->GetPrefix() == pfxletter))
717                 {
718                         return modehandlers[pos];
719                 }
720         }
721         return NULL;
722 }
723
724 std::string ModeParser::GiveModeList(ModeMasks m)
725 {
726         std::string type1;      /* Listmodes EXCEPT those with a prefix */
727         std::string type2;      /* Modes that take a param when adding or removing */
728         std::string type3;      /* Modes that only take a param when adding */
729         std::string type4;      /* Modes that dont take a param */
730
731         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
732         {
733                 unsigned char pos = (mode-65) | m;
734                  /* One parameter when adding */
735                 if (modehandlers[pos])
736                 {
737                         if (modehandlers[pos]->GetNumParams(true))
738                         {
739                                 if ((modehandlers[pos]->IsListMode()) && (!modehandlers[pos]->GetPrefix()))
740                                 {
741                                         type1 += modehandlers[pos]->GetModeChar();
742                                 }
743                                 else
744                                 {
745                                         /* ... and one parameter when removing */
746                                         if (modehandlers[pos]->GetNumParams(false))
747                                         {
748                                                 /* But not a list mode */
749                                                 if (!modehandlers[pos]->GetPrefix())
750                                                 {
751                                                         type2 += modehandlers[pos]->GetModeChar();
752                                                 }
753                                         }
754                                         else
755                                         {
756                                                 /* No parameters when removing */
757                                                 type3 += modehandlers[pos]->GetModeChar();
758                                         }
759                                 }
760                         }
761                         else
762                         {
763                                 type4 += modehandlers[pos]->GetModeChar();
764                         }
765                 }
766         }
767
768         return type1 + "," + type2 + "," + type3 + "," + type4;
769 }
770
771 std::string ModeParser::BuildPrefixes(bool lettersAndModes)
772 {
773         std::string mletters;
774         std::string mprefixes;
775         std::map<int,std::pair<char,char> > prefixes;
776
777         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
778         {
779                 unsigned char pos = (mode-65) | MASK_CHANNEL;
780
781                 if ((modehandlers[pos]) && (modehandlers[pos]->GetPrefix()))
782                 {
783                         prefixes[modehandlers[pos]->GetPrefixRank()] = std::make_pair(
784                                 modehandlers[pos]->GetPrefix(), modehandlers[pos]->GetModeChar());
785                 }
786         }
787
788         for(std::map<int,std::pair<char,char> >::reverse_iterator n = prefixes.rbegin(); n != prefixes.rend(); n++)
789         {
790                 mletters = mletters + n->second.first;
791                 mprefixes = mprefixes + n->second.second;
792         }
793
794         return lettersAndModes ? "(" + mprefixes + ")" + mletters : mletters;
795 }
796
797 void ModeParser::AddModeWatcher(ModeWatcher* mw)
798 {
799         modewatchermap.insert(std::make_pair(mw->GetModeName(), mw));
800 }
801
802 bool ModeParser::DelModeWatcher(ModeWatcher* mw)
803 {
804         std::pair<ModeWatchIter, ModeWatchIter> itpair = modewatchermap.equal_range(mw->GetModeName());
805         for (ModeWatchIter i = itpair.first; i != itpair.second; ++i)
806         {
807                 if (i->second == mw)
808                 {
809                         modewatchermap.erase(i);
810                         return true;
811                 }
812         }
813
814         return false;
815 }
816
817 void ModeHandler::RemoveMode(User* user)
818 {
819         // Remove the mode if it's set on the user
820         if (user->IsModeSet(this->GetModeChar()))
821         {
822                 std::vector<std::string> parameters;
823                 parameters.push_back(user->nick);
824                 parameters.push_back("-");
825                 parameters[1].push_back(this->GetModeChar());
826                 ServerInstance->Modes->Process(parameters, ServerInstance->FakeClient);
827         }
828 }
829
830 void ModeHandler::RemoveMode(Channel* channel, irc::modestacker& stack)
831 {
832         if (this->GetPrefixRank())
833         {
834                 RemovePrefixMode(channel, stack);
835         }
836         else if (channel->IsModeSet(this->GetModeChar()))
837         {
838                 if (this->GetNumParams(false))
839                         // Removing this mode requires a parameter
840                         stack.Push(this->GetModeChar(), channel->GetModeParameter(this->GetModeChar()));
841                 else
842                         stack.Push(this->GetModeChar());
843         }
844 }
845
846 void ModeHandler::RemovePrefixMode(Channel* chan, irc::modestacker& stack)
847 {
848         const UserMembList* userlist = chan->GetUsers();
849         for (UserMembCIter i = userlist->begin(); i != userlist->end(); ++i)
850         {
851                 if (i->second->hasMode(this->GetModeChar()))
852                         stack.Push(this->GetModeChar(), i->first->nick);
853         }
854 }
855
856 struct builtin_modes
857 {
858         ModeChannelSecret s;
859         ModeChannelPrivate p;
860         ModeChannelModerated m;
861         ModeChannelTopicOps t;
862
863         ModeChannelNoExternal n;
864         ModeChannelInviteOnly i;
865         ModeChannelKey k;
866         ModeChannelLimit l;
867
868         ModeChannelBan b;
869         ModeChannelOp o;
870         ModeChannelVoice v;
871
872         ModeUserWallops uw;
873         ModeUserInvisible ui;
874         ModeUserOperator uo;
875         ModeUserServerNoticeMask us;
876
877         void init()
878         {
879                 ServiceProvider* modes[] = { &s, &p, &m, &t, &n, &i, &k, &l, &b, &o, &v,
880                                                                          &uw, &ui, &uo, &us };
881                 ServerInstance->Modules->AddServices(modes, sizeof(modes)/sizeof(ServiceProvider*));
882         }
883 };
884
885 static builtin_modes static_modes;
886
887 void ModeParser::InitBuiltinModes()
888 {
889         static_modes.init();
890         static_modes.b.DoRehash();
891 }
892
893 ModeParser::ModeParser()
894 {
895         /* Clear mode handler list */
896         memset(modehandlers, 0, sizeof(modehandlers));
897
898         /* Last parse string */
899         LastParse.clear();
900
901         seq = 0;
902         memset(&sent, 0, sizeof(sent));
903 }
904
905 ModeParser::~ModeParser()
906 {
907 }