]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/mode.cpp
Update documentation and remove unused classes/functions
[user/henk/code/inspircd.git] / src / mode.cpp
1 /*       +------------------------------------+
2  *       | Inspire Internet Relay Chat Daemon |
3  *       +------------------------------------+
4  *
5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
6  * See: http://wiki.inspircd.org/Credits
7  *
8  * This program is free but copyrighted software; see
9  *            the file COPYING for details.
10  *
11  * ---------------------------------------------------
12  */
13
14 #include "inspircd.h"
15 #include "inspstring.h"
16
17 /* +s (secret) */
18 #include "modes/cmode_s.h"
19 /* +p (private) */
20 #include "modes/cmode_p.h"
21 /* +b (bans) */
22 #include "modes/cmode_b.h"
23 /* +m (moderated) */
24 #include "modes/cmode_m.h"
25 /* +t (only (half) ops can change topic) */
26 #include "modes/cmode_t.h"
27 /* +n (no external messages) */
28 #include "modes/cmode_n.h"
29 /* +i (invite only) */
30 #include "modes/cmode_i.h"
31 /* +k (keyed channel) */
32 #include "modes/cmode_k.h"
33 /* +l (channel user limit) */
34 #include "modes/cmode_l.h"
35 /* +o (channel op) */
36 #include "modes/cmode_o.h"
37 /* +h (channel halfop) */
38 #include "modes/cmode_h.h"
39 /* +v (channel voice) */
40 #include "modes/cmode_v.h"
41 /* +w (see wallops) */
42 #include "modes/umode_w.h"
43 /* +i (invisible) */
44 #include "modes/umode_i.h"
45 /* +o (operator) */
46 #include "modes/umode_o.h"
47 /* +s (server notice masks) */
48 #include "modes/umode_s.h"
49
50 ModeHandler::ModeHandler(Module* Creator, const std::string& Name, char modeletter, ParamSpec Params, ModeType type)
51         : m_paramtype(TR_TEXT), parameters_taken(Params), mode(modeletter), prefix(0), oper(false),
52         list(false), m_type(type), count(0), levelrequired(HALFOP_VALUE), creator(Creator), name(Name)
53 {
54 }
55
56 CullResult ModeHandler::cull()
57 {
58         if (ServerInstance->Modes)
59                 ServerInstance->Modes->DelMode(this);
60         return classbase::cull();
61 }
62
63 ModeHandler::~ModeHandler()
64 {
65         if (ServerInstance && ServerInstance->Modes && ServerInstance->Modes->FindMode(mode, m_type) == this)
66                 ServerInstance->Logs->Log("MODE", ERROR, "ERROR: Destructor for mode %c called while still registered", mode);
67 }
68
69 bool ModeHandler::IsListMode()
70 {
71         return list;
72 }
73
74 unsigned int ModeHandler::GetPrefixRank()
75 {
76         return 0;
77 }
78
79 unsigned int ModeHandler::GetCount()
80 {
81         return 0;
82 }
83
84 void ModeHandler::ChangeCount(int modifier)
85 {
86         count += modifier;
87         ServerInstance->Logs->Log("MODE", DEBUG,"Change count for mode %c is now %d", mode, count);
88 }
89
90 int ModeHandler::GetNumParams(bool adding)
91 {
92         switch (parameters_taken)
93         {
94                 case PARAM_ALWAYS:
95                         return 1;
96                 case PARAM_SETONLY:
97                         return adding ? 1 : 0;
98                 case PARAM_NONE:
99                         break;
100         }
101         return 0;
102 }
103
104 char ModeHandler::GetModeChar()
105 {
106         return mode;
107 }
108
109 std::string ModeHandler::GetUserParameter(User* user)
110 {
111         return "";
112 }
113
114 ModResult ModeHandler::AccessCheck(User*, Channel*, std::string &, bool)
115 {
116         return MOD_RES_PASSTHRU;
117 }
118
119 ModeAction ModeHandler::OnModeChange(User*, User*, Channel*, std::string&, bool)
120 {
121         return MODEACTION_DENY;
122 }
123
124 ModePair ModeHandler::ModeSet(User*, User* dest, Channel* channel, const std::string&)
125 {
126         if (dest)
127         {
128                 return std::make_pair(dest->IsModeSet(this->mode), "");
129         }
130         else
131         {
132                 return std::make_pair(channel->IsModeSet(this->mode), "");
133         }
134 }
135
136 void ModeHandler::DisplayList(User*, Channel*)
137 {
138 }
139
140 void ModeHandler::DisplayEmptyList(User*, Channel*)
141 {
142 }
143
144 void ModeHandler::OnParameterMissing(User* user, User* dest, Channel* channel)
145 {
146 }
147
148 bool ModeHandler::ResolveModeConflict(std::string& theirs, const std::string& ours, Channel*)
149 {
150         return (theirs < ours);
151 }
152
153 ModeAction SimpleUserModeHandler::OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
154 {
155         if (adding)
156         {
157                 if (!dest->IsModeSet(this->GetModeChar()))
158                 {
159                         dest->SetMode(this->GetModeChar(),true);
160                         return MODEACTION_ALLOW;
161                 }
162         }
163         else
164         {
165                 if (dest->IsModeSet(this->GetModeChar()))
166                 {
167                         dest->SetMode(this->GetModeChar(),false);
168                         return MODEACTION_ALLOW;
169                 }
170         }
171
172         return MODEACTION_DENY;
173 }
174
175
176 ModeAction SimpleChannelModeHandler::OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
177 {
178         if (adding)
179         {
180                 if (!channel->IsModeSet(this->GetModeChar()))
181                 {
182                         channel->SetMode(this->GetModeChar(),true);
183                         return MODEACTION_ALLOW;
184                 }
185         }
186         else
187         {
188                 if (channel->IsModeSet(this->GetModeChar()))
189                 {
190                         channel->SetMode(this->GetModeChar(),false);
191                         return MODEACTION_ALLOW;
192                 }
193         }
194
195         return MODEACTION_DENY;
196 }
197
198 ModeWatcher::ModeWatcher(Module* Creator, char modeletter, ModeType type)
199         : mode(modeletter), m_type(type), creator(Creator)
200 {
201 }
202
203 ModeWatcher::~ModeWatcher()
204 {
205 }
206
207 char ModeWatcher::GetModeChar()
208 {
209         return mode;
210 }
211
212 ModeType ModeWatcher::GetModeType()
213 {
214         return m_type;
215 }
216
217 bool ModeWatcher::BeforeMode(User*, User*, Channel*, std::string&, bool, ModeType)
218 {
219         return true;
220 }
221
222 void ModeWatcher::AfterMode(User*, User*, Channel*, const std::string&, bool, ModeType)
223 {
224 }
225
226 User* ModeParser::SanityChecks(User *user, const char *dest, Channel *chan, int)
227 {
228         User *d;
229         if ((!user) || (!dest) || (!chan) || (!*dest))
230         {
231                 return NULL;
232         }
233         d = ServerInstance->FindNick(dest);
234         if (!d)
235         {
236                 user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nick/channel",user->nick.c_str(), dest);
237                 return NULL;
238         }
239         return d;
240 }
241
242 void ModeParser::DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text)
243 {
244         if (targetchannel)
245         {
246                 /* Display channel's current mode string */
247                 user->WriteNumeric(RPL_CHANNELMODEIS, "%s %s +%s",user->nick.c_str(), targetchannel->name.c_str(), targetchannel->ChanModes(targetchannel->HasUser(user)));
248                 user->WriteNumeric(RPL_CHANNELCREATED, "%s %s %lu", user->nick.c_str(), targetchannel->name.c_str(), (unsigned long)targetchannel->age);
249                 return;
250         }
251         else
252         {
253                 if (targetuser == user || user->HasPrivPermission("users/auspex"))
254                 {
255                         /* Display user's current mode string */
256                         user->WriteNumeric(RPL_UMODEIS, "%s :+%s",targetuser->nick.c_str(),targetuser->FormatModes());
257                         if (IS_OPER(targetuser))
258                                 user->WriteNumeric(RPL_SNOMASKIS, "%s +%s :Server notice mask", targetuser->nick.c_str(), targetuser->FormatNoticeMasks());
259                         return;
260                 }
261                 else
262                 {
263                         user->WriteNumeric(ERR_USERSDONTMATCH, "%s :Can't view modes for other users", user->nick.c_str());
264                         return;
265                 }
266         }
267 }
268
269 ModeAction ModeParser::TryMode(User* user, User* targetuser, Channel* chan, bool adding, const unsigned char modechar,
270                 std::string &parameter, bool SkipACL)
271 {
272         ModeType type = chan ? MODETYPE_CHANNEL : MODETYPE_USER;
273         unsigned char mask = chan ? MASK_CHANNEL : MASK_USER;
274
275         ModeHandler *mh = FindMode(modechar, type);
276         int pcnt = mh->GetNumParams(adding);
277
278         ModResult MOD_RESULT;
279         FIRST_MOD_RESULT(OnRawMode, MOD_RESULT, (user, chan, modechar, parameter, adding, pcnt));
280
281         if (IS_LOCAL(user) && (MOD_RESULT == MOD_RES_DENY))
282                 return MODEACTION_DENY;
283
284         if (chan && !SkipACL && (MOD_RESULT != MOD_RES_ALLOW))
285         {
286                 MOD_RESULT = mh->AccessCheck(user, chan, parameter, adding);
287
288                 if (MOD_RESULT == MOD_RES_DENY)
289                         return MODEACTION_DENY;
290                 if (MOD_RESULT == MOD_RES_PASSTHRU)
291                 {
292                         unsigned int neededrank = mh->GetLevelRequired();
293                         /* Compare our rank on the channel against the rank of the required prefix,
294                          * allow if >= ours. Because mIRC and xchat throw a tizz if the modes shown
295                          * in NAMES(X) are not in rank order, we know the most powerful mode is listed
296                          * first, so we don't need to iterate, we just look up the first instead.
297                          */
298                         unsigned int ourrank = chan->GetPrefixValue(user);
299                         if (ourrank < neededrank)
300                         {
301                                 /* Bog off */
302                                 // TODO replace with a real search for the proper prefix
303                                 char needed = neededrank > HALFOP_VALUE ? '@' : '%';
304                                 user->WriteNumeric(ERR_CHANOPRIVSNEEDED, "%s %s :You must have channel privilege %c or above to %sset channel mode %c",
305                                                 user->nick.c_str(), chan->name.c_str(), needed, adding ? "" : "un", modechar);
306                                 return MODEACTION_DENY;
307                         }
308                 }
309         }
310
311         unsigned char handler_id = (modechar - 'A') | mask;
312
313         for (ModeWatchIter watchers = modewatchers[handler_id].begin(); watchers != modewatchers[handler_id].end(); watchers++)
314         {
315                 if ((*watchers)->BeforeMode(user, targetuser, chan, parameter, adding, type) == false)
316                         return MODEACTION_DENY;
317                 /* A module whacked the parameter completely, and there was one. abort. */
318                 if (pcnt && parameter.empty())
319                         return MODEACTION_DENY;
320         }
321
322         if (IS_LOCAL(user) && !IS_OPER(user))
323         {
324                 char* disabled = (type == MODETYPE_CHANNEL) ? ServerInstance->Config->DisabledCModes : ServerInstance->Config->DisabledUModes;
325                 if (disabled[modechar - 'A'])
326                 {
327                         user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - %s mode %c has been locked by the administrator",
328                                 user->nick.c_str(), type == MODETYPE_CHANNEL ? "channel" : "user", modechar);
329                         return MODEACTION_DENY;
330                 }
331         }
332
333         if (adding && IS_LOCAL(user) && mh->NeedsOper() && !user->HasModePermission(modechar, type))
334         {
335                 /* It's an oper only mode, and they don't have access to it. */
336                 if (IS_OPER(user))
337                 {
338                         user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - Oper type %s does not have access to set %s mode %c",
339                                         user->nick.c_str(), irc::Spacify(user->oper.c_str()), type == MODETYPE_CHANNEL ? "channel" : "user", modechar);
340                 }
341                 else
342                 {
343                         user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - Only operators may set %s mode %c",
344                                         user->nick.c_str(), type == MODETYPE_CHANNEL ? "channel" : "user", modechar);
345                 }
346                 return MODEACTION_DENY;
347         }
348
349         if (mh->GetTranslateType() == TR_NICK && !ServerInstance->FindNick(parameter))
350         {
351                 user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nick/channel", user->nick.c_str(), parameter.c_str());
352                 return MODEACTION_DENY;
353         }
354
355         /* Call the handler for the mode */
356         ModeAction ma = mh->OnModeChange(user, targetuser, chan, parameter, adding);
357
358         if (pcnt && parameter.empty())
359                 return MODEACTION_DENY;
360
361         if (ma != MODEACTION_ALLOW)
362                 return ma;
363
364         mh->ChangeCount(adding ? 1 : -1);
365
366         if (mh->GetPrefixRank() && chan)
367         {
368                 User* user_to_prefix = ServerInstance->FindNick(parameter);
369                 if (user_to_prefix)
370                         chan->SetPrefix(user_to_prefix, modechar, adding);
371         }
372
373         for (ModeWatchIter watchers = modewatchers[handler_id].begin(); watchers != modewatchers[handler_id].end(); watchers++)
374                 (*watchers)->AfterMode(user, targetuser, chan, parameter, adding, type);
375
376         return MODEACTION_ALLOW;
377 }
378
379 void ModeParser::Process(const std::vector<std::string>& parameters, User *user, bool merge)
380 {
381         std::string target = parameters[0];
382         Channel* targetchannel = ServerInstance->FindChan(target);
383         User* targetuser  = ServerInstance->FindNick(target);
384         ModeType type = targetchannel ? MODETYPE_CHANNEL : MODETYPE_USER;
385
386         LastParse.clear();
387         LastParseParams.clear();
388         LastParseTranslate.clear();
389
390         if (!targetchannel && !targetuser)
391         {
392                 user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nick/channel",user->nick.c_str(),target.c_str());
393                 return;
394         }
395         if (parameters.size() == 1)
396         {
397                 this->DisplayCurrentModes(user, targetuser, targetchannel, target.c_str());
398                 return;
399         }
400
401         ModResult MOD_RESULT;
402         FIRST_MOD_RESULT(OnPreMode, MOD_RESULT, (user, targetuser, targetchannel, parameters));
403
404         bool SkipAccessChecks = false;
405
406         if (!IS_LOCAL(user) || ServerInstance->ULine(user->server) || MOD_RESULT == MOD_RES_ALLOW)
407                 SkipAccessChecks = true;
408         else if (MOD_RESULT == MOD_RES_DENY)
409                 return;
410
411         if (targetuser && !SkipAccessChecks && user != targetuser)
412         {
413                 user->WriteNumeric(ERR_USERSDONTMATCH, "%s :Can't change mode for other users", user->nick.c_str());
414                 return;
415         }
416
417         std::string mode_sequence = parameters[1];
418
419         std::string output_mode;
420         std::ostringstream output_parameters;
421         LastParseParams.push_back(output_mode);
422         LastParseTranslate.push_back(TR_TEXT);
423
424         bool adding = true;
425         char output_pm = '\0'; // current output state, '+' or '-'
426         unsigned int param_at = 2;
427
428         for (std::string::const_iterator letter = mode_sequence.begin(); letter != mode_sequence.end(); letter++)
429         {
430                 unsigned char modechar = *letter;
431                 if (modechar == '+' || modechar == '-')
432                 {
433                         adding = (modechar == '+');
434                         continue;
435                 }
436
437                 ModeHandler *mh = this->FindMode(modechar, type);
438                 if (!mh)
439                 {
440                         /* No mode handler? Unknown mode character then. */
441                         user->WriteServ("%d %s %c :is unknown mode char to me", type == MODETYPE_CHANNEL ? 472 : 501, user->nick.c_str(), modechar);
442                         continue;
443                 }
444
445                 std::string parameter = "";
446                 int pcnt = mh->GetNumParams(adding);
447                 if (pcnt && param_at == parameters.size())
448                 {
449                         /* No parameter, continue to the next mode */
450                         mh->OnParameterMissing(user, targetuser, targetchannel);
451                         continue;
452                 }
453                 else if (pcnt)
454                 {
455                         parameter = parameters[param_at++];
456                         /* Make sure the user isn't trying to slip in an invalid parameter */
457                         if ((parameter.find(':') == 0) || (parameter.rfind(' ') != std::string::npos))
458                                 continue;
459                         if (merge && targetchannel && targetchannel->IsModeSet(modechar) && !mh->IsListMode())
460                         {
461                                 std::string ours = targetchannel->GetModeParameter(modechar);
462                                 if (!mh->ResolveModeConflict(parameter, ours, targetchannel))
463                                         /* we won the mode merge, don't apply this mode */
464                                         continue;
465                         }
466                 }
467
468                 ModeAction ma = TryMode(user, targetuser, targetchannel, adding, modechar, parameter, SkipAccessChecks);
469
470                 if (ma != MODEACTION_ALLOW)
471                         continue;
472
473                 char needed_pm = adding ? '+' : '-';
474                 if (needed_pm != output_pm)
475                 {
476                         output_pm = needed_pm;
477                         output_mode.append(1, output_pm);
478                 }
479                 output_mode.append(1, modechar);
480
481                 if (pcnt)
482                 {
483                         TranslateType tt = mh->GetTranslateType();
484                         if (tt == TR_NICK)
485                         {
486                                 User* u = ServerInstance->FindNick(parameter);
487                                 if (u)
488                                         parameter = u->nick;
489                         }
490                         output_parameters << " " << parameter;
491                         LastParseParams.push_back(parameter);
492                         LastParseTranslate.push_back(tt);
493                 }
494
495                 if ( (output_mode.length() + output_parameters.str().length() > 450)
496                                 || (output_mode.length() > 100)
497                                 || (LastParseParams.size() > ServerInstance->Config->Limits.MaxModes))
498                 {
499                         /* mode sequence is getting too long */
500                         break;
501                 }
502         }
503
504         LastParseParams[0] = output_mode;
505
506         if (!output_mode.empty())
507         {
508                 LastParse = targetchannel ? targetchannel->name : targetuser->nick;
509                 LastParse.append(" ");
510                 LastParse.append(output_mode);
511                 LastParse.append(output_parameters.str());
512
513                 if (targetchannel)
514                 {
515                         targetchannel->WriteChannel(user, "MODE %s", LastParse.c_str());
516                         FOREACH_MOD(I_OnMode,OnMode(user, targetchannel, TYPE_CHANNEL, LastParseParams, LastParseTranslate));
517                 }
518                 else
519                 {
520                         targetuser->WriteFrom(user, "MODE %s", LastParse.c_str());
521                         FOREACH_MOD(I_OnMode,OnMode(user, targetuser, TYPE_USER, LastParseParams, LastParseTranslate));
522                 }
523         }
524         else if (targetchannel && parameters.size() == 2)
525         {
526                 /* Special case for displaying the list for listmodes,
527                  * e.g. MODE #chan b, or MODE #chan +b without a parameter
528                  */
529                 this->DisplayListModes(user, targetchannel, mode_sequence);
530         }
531 }
532
533 void ModeParser::DisplayListModes(User* user, Channel* chan, std::string &mode_sequence)
534 {
535         seq++;
536
537         for (std::string::const_iterator letter = mode_sequence.begin(); letter != mode_sequence.end(); letter++)
538         {
539                 unsigned char mletter = *letter;
540                 if (mletter == '+')
541                         continue;
542
543                 /* Ensure the user doesnt request the same mode twice,
544                  * so they cant flood themselves off out of idiocy.
545                  */
546                 if (sent[mletter] == seq)
547                         continue;
548
549                 sent[mletter] = seq;
550
551                 ModeHandler *mh = this->FindMode(mletter, MODETYPE_CHANNEL);
552
553                 if (!mh || !mh->IsListMode())
554                         return;
555
556                 ModResult MOD_RESULT;
557                 FIRST_MOD_RESULT(OnRawMode, MOD_RESULT, (user, chan, mletter, "", true, 0));
558                 if (MOD_RESULT == MOD_RES_DENY)
559                         continue;
560
561                 bool display = true;
562                 if (!user->HasPrivPermission("channels/auspex") && ServerInstance->Config->HideModeLists[mletter] && (chan->GetPrefixValue(user) < HALFOP_VALUE))
563                 {
564                         user->WriteNumeric(ERR_CHANOPRIVSNEEDED, "%s %s :Only half-operators and above may view the +%c list",
565                                 user->nick.c_str(), chan->name.c_str(), mletter);
566                         display = false;
567                 }
568
569                 /** See below for a description of what craq this is :D
570                  */
571                 unsigned char handler_id = (mletter - 'A') | MASK_CHANNEL;
572
573                 for(ModeWatchIter watchers = modewatchers[handler_id].begin(); watchers != modewatchers[handler_id].end(); watchers++)
574                 {
575                         std::string dummyparam;
576
577                         if (!((*watchers)->BeforeMode(user, NULL, chan, dummyparam, true, MODETYPE_CHANNEL)))
578                                 display = false;
579                 }
580                 if (display)
581                         mh->DisplayList(user, chan);
582                 else
583                         mh->DisplayEmptyList(user, chan);
584         }
585 }
586
587 const std::string& ModeParser::GetLastParse()
588 {
589         return LastParse;
590 }
591
592 void ModeParser::CleanMask(std::string &mask)
593 {
594         std::string::size_type pos_of_pling = mask.find_first_of('!');
595         std::string::size_type pos_of_at = mask.find_first_of('@');
596         std::string::size_type pos_of_dot = mask.find_first_of('.');
597         std::string::size_type pos_of_colons = mask.find("::"); /* Because ipv6 addresses are colon delimited -- double so it treats extban as nick */
598
599         if (mask.length() >= 2 && mask[1] == ':')
600                 return; // if it's an extban, don't even try guess how it needs to be formed.
601
602         if ((pos_of_pling == std::string::npos) && (pos_of_at == std::string::npos))
603         {
604                 /* Just a nick, or just a host - or clearly ipv6 (starting with :) */
605                 if ((pos_of_dot == std::string::npos) && (pos_of_colons == std::string::npos) && mask[0] != ':')
606                 {
607                         /* It has no '.' in it, it must be a nick. */
608                         mask.append("!*@*");
609                 }
610                 else
611                 {
612                         /* Got a dot in it? Has to be a host */
613                         mask = "*!*@" + mask;
614                 }
615         }
616         else if ((pos_of_pling == std::string::npos) && (pos_of_at != std::string::npos))
617         {
618                 /* Has an @ but no !, its a user@host */
619                  mask = "*!" + mask;
620         }
621         else if ((pos_of_pling != std::string::npos) && (pos_of_at == std::string::npos))
622         {
623                 /* Has a ! but no @, it must be a nick!ident */
624                 mask.append("@*");
625         }
626 }
627
628 bool ModeParser::AddMode(ModeHandler* mh)
629 {
630         unsigned char mask = 0;
631         unsigned char pos = 0;
632
633         /* Yes, i know, this might let people declare modes like '_' or '^'.
634          * If they do that, thats their problem, and if i ever EVER see an
635          * official InspIRCd developer do that, i'll beat them with a paddle!
636          */
637         if ((mh->GetModeChar() < 'A') || (mh->GetModeChar() > 'z') || (mh->GetPrefix() > 126))
638                 return false;
639
640         /* A mode prefix of ',' is not acceptable, it would fuck up server to server.
641          * A mode prefix of ':' will fuck up both server to server, and client to server.
642          * A mode prefix of '#' will mess up /whois and /privmsg
643          */
644         if ((mh->GetPrefix() == ',') || (mh->GetPrefix() == ':') || (mh->GetPrefix() == '#'))
645                 return false;
646
647         mh->GetModeType() == MODETYPE_USER ? mask = MASK_USER : mask = MASK_CHANNEL;
648         pos = (mh->GetModeChar()-65) | mask;
649
650         if (modehandlers[pos])
651                 return false;
652
653         modehandlers[pos] = mh;
654         return true;
655 }
656
657 bool ModeParser::DelMode(ModeHandler* mh)
658 {
659         unsigned char mask = 0;
660         unsigned char pos = 0;
661
662         if ((mh->GetModeChar() < 'A') || (mh->GetModeChar() > 'z'))
663                 return false;
664
665         mh->GetModeType() == MODETYPE_USER ? mask = MASK_USER : mask = MASK_CHANNEL;
666         pos = (mh->GetModeChar()-65) | mask;
667
668         if (modehandlers[pos] != mh)
669                 return false;
670
671         /* Note: We can't stack here, as we have modes potentially being removed across many different channels.
672          * To stack here we have to make the algorithm slower. Discuss.
673          */
674         switch (mh->GetModeType())
675         {
676                 case MODETYPE_USER:
677                         for (user_hash::iterator i = ServerInstance->Users->clientlist->begin(); i != ServerInstance->Users->clientlist->end(); i++)
678                         {
679                                 mh->RemoveMode(i->second);
680                         }
681                 break;
682                 case MODETYPE_CHANNEL:
683                         for (chan_hash::iterator i = ServerInstance->chanlist->begin(); i != ServerInstance->chanlist->end(); i++)
684                         {
685                                 mh->RemoveMode(i->second);
686                         }
687                 break;
688         }
689
690         modehandlers[pos] = NULL;
691
692         return true;
693 }
694
695 ModeHandler* ModeParser::FindMode(unsigned const char modeletter, ModeType mt)
696 {
697         unsigned char mask = 0;
698         unsigned char pos = 0;
699
700         if ((modeletter < 'A') || (modeletter > 'z'))
701                 return NULL;
702
703         mt == MODETYPE_USER ? mask = MASK_USER : mask = MASK_CHANNEL;
704         pos = (modeletter-65) | mask;
705
706         return modehandlers[pos];
707 }
708
709 std::string ModeParser::UserModeList()
710 {
711         char modestr[256];
712         int pointer = 0;
713
714         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
715         {
716                 unsigned char pos = (mode-65) | MASK_USER;
717
718                 if (modehandlers[pos])
719                         modestr[pointer++] = mode;
720         }
721         modestr[pointer++] = 0;
722         return modestr;
723 }
724
725 std::string ModeParser::ChannelModeList()
726 {
727         char modestr[256];
728         int pointer = 0;
729
730         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
731         {
732                 unsigned char pos = (mode-65) | MASK_CHANNEL;
733
734                 if (modehandlers[pos])
735                         modestr[pointer++] = mode;
736         }
737         modestr[pointer++] = 0;
738         return modestr;
739 }
740
741 std::string ModeParser::ParaModeList()
742 {
743         char modestr[256];
744         int pointer = 0;
745
746         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
747         {
748                 unsigned char pos = (mode-65) | MASK_CHANNEL;
749
750                 if ((modehandlers[pos]) && (modehandlers[pos]->GetNumParams(true)))
751                         modestr[pointer++] = mode;
752         }
753         modestr[pointer++] = 0;
754         return modestr;
755 }
756
757 ModeHandler* ModeParser::FindPrefix(unsigned const char pfxletter)
758 {
759         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
760         {
761                 unsigned char pos = (mode-65) | MASK_CHANNEL;
762
763                 if ((modehandlers[pos]) && (modehandlers[pos]->GetPrefix() == pfxletter))
764                 {
765                         return modehandlers[pos];
766                 }
767         }
768         return NULL;
769 }
770
771 std::string ModeParser::ModeString(User* user, Channel* channel, bool nick_suffix)
772 {
773         std::string types;
774         std::string pars;
775
776         if (!channel || !user)
777                 return "";
778
779         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
780         {
781                 unsigned char pos = (mode-65) | MASK_CHANNEL;
782                 ModeHandler* mh = modehandlers[pos];
783                 if ((mh) && (mh->GetNumParams(true)) && (mh->GetNumParams(false)))
784                 {
785                         ModePair ret;
786                         ret = mh->ModeSet(NULL, user, channel, user->nick);
787                         if ((ret.first) && (ret.second == user->nick))
788                         {
789                                 if (nick_suffix)
790                                 {
791                                         pars.append(" ");
792                                         pars.append(user->nick);
793                                 }
794                                 types.push_back(mh->GetModeChar());
795                         }
796                 }
797         }
798
799         if (nick_suffix)
800                 return types+pars;
801         else
802                 return types;
803 }
804
805 std::string ModeParser::GiveModeList(ModeMasks m)
806 {
807         std::string type1;      /* Listmodes EXCEPT those with a prefix */
808         std::string type2;      /* Modes that take a param when adding or removing */
809         std::string type3;      /* Modes that only take a param when adding */
810         std::string type4;      /* Modes that dont take a param */
811
812         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
813         {
814                 unsigned char pos = (mode-65) | m;
815                  /* One parameter when adding */
816                 if (modehandlers[pos])
817                 {
818                         if (modehandlers[pos]->GetNumParams(true))
819                         {
820                                 if ((modehandlers[pos]->IsListMode()) && (!modehandlers[pos]->GetPrefix()))
821                                 {
822                                         type1 += modehandlers[pos]->GetModeChar();
823                                 }
824                                 else
825                                 {
826                                         /* ... and one parameter when removing */
827                                         if (modehandlers[pos]->GetNumParams(false))
828                                         {
829                                                 /* But not a list mode */
830                                                 if (!modehandlers[pos]->GetPrefix())
831                                                 {
832                                                         type2 += modehandlers[pos]->GetModeChar();
833                                                 }
834                                         }
835                                         else
836                                         {
837                                                 /* No parameters when removing */
838                                                 type3 += modehandlers[pos]->GetModeChar();
839                                         }
840                                 }
841                         }
842                         else
843                         {
844                                 type4 += modehandlers[pos]->GetModeChar();
845                         }
846                 }
847         }
848
849         return type1 + "," + type2 + "," + type3 + "," + type4;
850 }
851
852 std::string ModeParser::BuildPrefixes()
853 {
854         std::string mletters;
855         std::string mprefixes;
856         std::map<int,std::pair<char,char> > prefixes;
857
858         for (unsigned char mode = 'A'; mode <= 'z'; mode++)
859         {
860                 unsigned char pos = (mode-65) | MASK_CHANNEL;
861
862                 if ((modehandlers[pos]) && (modehandlers[pos]->GetPrefix()))
863                 {
864                         prefixes[modehandlers[pos]->GetPrefixRank()] = std::make_pair(
865                                 modehandlers[pos]->GetPrefix(), modehandlers[pos]->GetModeChar());
866                 }
867         }
868
869         for(std::map<int,std::pair<char,char> >::reverse_iterator n = prefixes.rbegin(); n != prefixes.rend(); n++)
870         {
871                 mletters = mletters + n->second.first;
872                 mprefixes = mprefixes + n->second.second;
873         }
874
875         return "(" + mprefixes + ")" + mletters;
876 }
877
878 bool ModeParser::AddModeWatcher(ModeWatcher* mw)
879 {
880         unsigned char mask = 0;
881         unsigned char pos = 0;
882
883         if (!mw)
884                 return false;
885
886         if ((mw->GetModeChar() < 'A') || (mw->GetModeChar() > 'z'))
887                 return false;
888
889         mw->GetModeType() == MODETYPE_USER ? mask = MASK_USER : mask = MASK_CHANNEL;
890         pos = (mw->GetModeChar()-65) | mask;
891
892         modewatchers[pos].push_back(mw);
893
894         return true;
895 }
896
897 bool ModeParser::DelModeWatcher(ModeWatcher* mw)
898 {
899         unsigned char mask = 0;
900         unsigned char pos = 0;
901
902         if (!mw)
903                 return false;
904
905         if ((mw->GetModeChar() < 'A') || (mw->GetModeChar() > 'z'))
906                 return false;
907
908         mw->GetModeType() == MODETYPE_USER ? mask = MASK_USER : mask = MASK_CHANNEL;
909         pos = (mw->GetModeChar()-65) | mask;
910
911         ModeWatchIter a = find(modewatchers[pos].begin(),modewatchers[pos].end(),mw);
912
913         if (a == modewatchers[pos].end())
914         {
915                 return false;
916         }
917
918         modewatchers[pos].erase(a);
919
920         return true;
921 }
922
923 /** This default implementation can remove simple user modes
924  */
925 void ModeHandler::RemoveMode(User* user, irc::modestacker* stack)
926 {
927         char moderemove[MAXBUF];
928         std::vector<std::string> parameters;
929
930         if (user->IsModeSet(this->GetModeChar()))
931         {
932                 if (stack)
933                 {
934                         stack->Push(this->GetModeChar());
935                 }
936                 else
937                 {
938                         sprintf(moderemove,"-%c",this->GetModeChar());
939                         parameters.push_back(user->nick);
940                         parameters.push_back(moderemove);
941                         ServerInstance->Modes->Process(parameters, ServerInstance->FakeClient);
942                 }
943         }
944 }
945
946 /** This default implementation can remove simple channel modes
947  * (no parameters)
948  */
949 void ModeHandler::RemoveMode(Channel* channel, irc::modestacker* stack)
950 {
951         char moderemove[MAXBUF];
952         std::vector<std::string> parameters;
953
954         if (channel->IsModeSet(this->GetModeChar()))
955         {
956                 if (stack)
957                 {
958                         stack->Push(this->GetModeChar());
959                 }
960                 else
961                 {
962                         sprintf(moderemove,"-%c",this->GetModeChar());
963                         parameters.push_back(channel->name);
964                         parameters.push_back(moderemove);
965                         ServerInstance->SendMode(parameters, ServerInstance->FakeClient);
966                 }
967         }
968 }
969
970 struct builtin_modes
971 {
972         ModeChannelSecret s;
973         ModeChannelPrivate p;
974         ModeChannelModerated m;
975         ModeChannelTopicOps t;
976
977         ModeChannelNoExternal n;
978         ModeChannelInviteOnly i;
979         ModeChannelKey k;
980         ModeChannelLimit l;
981
982         ModeChannelBan b;
983         ModeChannelOp o;
984         // halfop is added by configreader
985         ModeChannelVoice v;
986
987         ModeUserWallops uw;
988         ModeUserInvisible ui;
989         ModeUserOperator uo;
990         ModeUserServerNoticeMask us;
991
992         void init(ModeParser* modes)
993         {
994                 modes->AddMode(&s);
995                 modes->AddMode(&p);
996                 modes->AddMode(&m);
997                 modes->AddMode(&t);
998                 modes->AddMode(&n);
999                 modes->AddMode(&i);
1000                 modes->AddMode(&k);
1001                 modes->AddMode(&l);
1002                 modes->AddMode(&b);
1003                 modes->AddMode(&o);
1004                 modes->AddMode(&v);
1005                 modes->AddMode(&uw);
1006                 modes->AddMode(&ui);
1007                 modes->AddMode(&uo);
1008                 modes->AddMode(&us);
1009         }
1010 };
1011
1012 static builtin_modes static_modes;
1013
1014 ModeParser::ModeParser()
1015 {
1016         /* Clear mode handler list */
1017         memset(modehandlers, 0, sizeof(modehandlers));
1018
1019         /* Last parse string */
1020         LastParse.clear();
1021
1022         seq = 0;
1023         memset(&sent, 0, sizeof(sent));
1024
1025         static_modes.init(this);
1026 }
1027
1028 ModeParser::~ModeParser()
1029 {
1030         ModeHandler* mh = FindMode('h', MODETYPE_CHANNEL);
1031         if (mh)
1032         {
1033                 mh->cull();
1034                 delete mh;
1035         }
1036 }