src/mode.cpp

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