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