src/mode.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 using namespace std;
  18
  19 #include "inspircd_config.h"
  20 #include "inspircd.h"
  21 #include "configreader.h"
  22 #include <unistd.h>
  23 #include "hash_map.h"
  24 #include "connection.h"
  25 #include "users.h"
  26 #include "modules.h"
  27 #include "message.h"
  28 #include "inspstring.h"
  29 #include "helperfuncs.h"
  30 #include "commands.h"
  31 #include "mode.h"
  32
  33 /* +s (secret) */
  34 #include "modes/cmode_s.h"
  35 /* +p (private) */
  36 #include "modes/cmode_p.h"
  37 /* +b (bans) */
  38 #include "modes/cmode_b.h"
  39 /* +m (moderated) */
  40 #include "modes/cmode_m.h"
  41 /* +t (only (half) ops can change topic) */
  42 #include "modes/cmode_t.h"
  43 /* +n (no external messages) */
  44 #include "modes/cmode_n.h"
  45 /* +i (invite only) */
  46 #include "modes/cmode_i.h"
  47 /* +k (keyed channel) */
  48 #include "modes/cmode_k.h"
  49 /* +l (channel user limit) */
  50 #include "modes/cmode_l.h"
  51 /* +o (channel op) */
  52 #include "modes/cmode_o.h"
  53 /* +h (channel halfop) */
  54 #include "modes/cmode_h.h"
  55 /* +v (channel voice) */
  56 #include "modes/cmode_v.h"
  57
  58 /* +s (server notices) */
  59 #include "modes/umode_s.h"
  60 /* +w (see wallops) */
  61 #include "modes/umode_w.h"
  62 /* +i (invisible) */
  63 #include "modes/umode_i.h"
  64 /* +o (operator) */
  65 #include "modes/umode_o.h"
  66 /* +n (notice mask - our implementation of snomasks) */
  67 #include "modes/umode_n.h"
  68
  69 extern int MODCOUNT;
  70 extern std::vector<Module*> modules;
  71 extern std::vector<ircd_module*> factory;
  72 extern InspIRCd* ServerInstance;
  73 extern ServerConfig* Config;
  74
  75 extern time_t TIME;
  76
  77 ModeHandler::ModeHandler(char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly)
  78         : mode(modeletter), n_params_on(parameters_on), n_params_off(parameters_off), list(listmode), m_type(type), oper(operonly)
  79 {
  80 }
  81
  82 ModeHandler::~ModeHandler()
  83 {
  84 }
  85
  86 bool ModeHandler::IsListMode()
  87 {
  88         return list;
  89 }
  90
  91 ModeType ModeHandler::GetModeType()
  92 {
  93         return m_type;
  94 }
  95
  96 bool ModeHandler::NeedsOper()
  97 {
  98         return oper;
  99 }
 100
 101 int ModeHandler::GetNumParams(bool adding)
 102 {
 103         return adding ? n_params_on : n_params_off;
 104 }
 105
 106 char ModeHandler::GetModeChar()
 107 {
 108         return mode;
 109 }
 110
 111 ModeAction ModeHandler::OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)
 112 {
 113         return MODEACTION_DENY;
 114 }
 115
 116 void ModeHandler::DisplayList(userrec* user, chanrec* channel)
 117 {
 118 }
 119
 120 bool ModeHandler::CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, chanrec* channel)
 121 {
 122         return (ours < theirs);
 123 }
 124
 125 ModeWatcher::ModeWatcher(char modeletter, ModeType type) : mode(modeletter), m_type(type)
 126 {
 127 }
 128
 129 ModeWatcher::~ModeWatcher()
 130 {
 131 }
 132
 133 char ModeWatcher::GetModeChar()
 134 {
 135         return mode;
 136 }
 137
 138 ModeType ModeWatcher::GetModeType()
 139 {
 140         return m_type;
 141 }
 142
 143 bool ModeWatcher::BeforeMode(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding, ModeType type)
 144 {
 145         return true;
 146 }
 147
 148 void ModeWatcher::AfterMode(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter, bool adding, ModeType type)
 149 {
 150 }
 151
 152 userrec* ModeParser::SanityChecks(userrec *user,const char *dest,chanrec *chan,int status)
 153 {
 154         userrec *d;
 155         if ((!user) || (!dest) || (!chan) || (!*dest))
 156         {
 157                 return NULL;
 158         }
 159         d = Find(dest);
 160         if (!d)
 161         {
 162                 WriteServ(user->fd,"401 %s %s :No such nick/channel",user->nick, dest);
 163                 return NULL;
 164         }
 165         return d;
 166 }
 167
 168 const char* ModeParser::Grant(userrec *d,chanrec *chan,int MASK)
 169 {
 170         if (!chan)
 171                 return "";
 172
 173         for (std::vector<ucrec*>::const_iterator i = d->chans.begin(); i != d->chans.end(); i++)
 174         {
 175                 ucrec* n = (ucrec*)(*i);
 176                 if (n->channel == chan)
 177                 {
 178                         if (n->uc_modes & MASK)
 179                         {
 180                                 return "";
 181                         }
 182                         n->uc_modes = n->uc_modes | MASK;
 183                         switch (MASK)
 184                         {
 185                                 case UCMODE_OP:
 186                                         n->channel->AddOppedUser(d);
 187                                 break;
 188                                 case UCMODE_HOP:
 189                                         n->channel->AddHalfoppedUser(d);
 190                                 break;
 191                                 case UCMODE_VOICE:
 192                                         n->channel->AddVoicedUser(d);
 193                                 break;
 194                         }
 195                         log(DEBUG,"grant: %s %s",n->channel->name,d->nick);
 196                         return d->nick;
 197                 }
 198         }
 199         return "";
 200 }
 201
 202 const char* ModeParser::Revoke(userrec *d,chanrec *chan,int MASK)
 203 {
 204         if (!chan)
 205                 return "";
 206
 207         for (std::vector<ucrec*>::const_iterator i = d->chans.begin(); i != d->chans.end(); i++)
 208         {
 209                 ucrec* n = (ucrec*)(*i);
 210                 if (n->channel == chan)
 211                 {
 212                         if ((n->uc_modes & MASK) == 0)
 213                         {
 214                                 return "";
 215                         }
 216                         n->uc_modes ^= MASK;
 217                         switch (MASK)
 218                         {
 219                                 case UCMODE_OP:
 220                                         n->channel->DelOppedUser(d);
 221                                 break;
 222                                 case UCMODE_HOP:
 223                                         n->channel->DelHalfoppedUser(d);
 224                                 break;
 225                                 case UCMODE_VOICE:
 226                                         n->channel->DelVoicedUser(d);
 227                                 break;
 228                         }
 229                         log(DEBUG,"revoke: %s %s",n->channel->name,d->nick);
 230                         return d->nick;
 231                 }
 232         }
 233         return "";
 234 }
 235
 236 void ModeParser::DisplayCurrentModes(userrec *user, userrec* targetuser, chanrec* targetchannel, const char* text)
 237 {
 238         if (targetchannel)
 239         {
 240                 /* Display channel's current mode string */
 241                 WriteServ(user->fd,"324 %s %s +%s",user->nick, targetchannel->name, chanmodes(targetchannel, targetchannel->HasUser(user)));
 242                 WriteServ(user->fd,"329 %s %s %d", user->nick, targetchannel->name, targetchannel->created);
 243                 return;
 244         }
 245         else if (targetuser)
 246         {
 247                 /* Display user's current mode string */
 248                 WriteServ(user->fd,"221 %s :+%s",targetuser->nick,targetuser->FormatModes());
 249                 WriteServ(user->fd, "008 %s :+%s", targetuser->nick, targetuser->FormatNoticeMasks());
 250                 return;
 251         }
 252
 253         /* No such nick/channel */
 254         WriteServ(user->fd,"401 %s %s :No such nick/channel",user->nick, text);
 255         return;
 256 }
 257
 258 void ModeParser::Process(char **parameters, int pcnt, userrec *user, bool servermode)
 259 {
 260         std::string target = parameters[0];
 261         ModeType type = MODETYPE_USER;
 262         unsigned char mask = 0;
 263         chanrec* targetchannel = FindChan(parameters[0]);
 264         userrec* targetuser  = Find(parameters[0]);
 265
 266         log(DEBUG,"ModeParser::Process start");
 267
 268         if (pcnt == 1)
 269         {
 270                 this->DisplayCurrentModes(user, targetuser, targetchannel, parameters[0]);
 271         }
 272         else if (pcnt > 1)
 273         {
 274                 if (targetchannel)
 275                 {
 276                         type = MODETYPE_CHANNEL;
 277                         mask = MASK_CHANNEL;
 278
 279                         /* Extra security checks on channel modes
 280                          * (e.g. are they a (half)op?
 281                          */
 282
 283                         if (cstatus(user, targetchannel) < STATUS_HOP)
 284                         {
 285                                 /* We don't have halfop */
 286                                 log(DEBUG,"The user is not a halfop or above, checking other reasons for being able to set the modes");
 287
 288                                 /* Are we a uline or is it a servermode? */
 289                                 if ((!is_uline(user->server)) && (!servermode))
 290                                 {
 291                                         /* Not enough permission:
 292                                          * NOT a uline and NOT a servermode,
 293                                          * OR, NOT halfop or above.
 294                                          */
 295                                         WriteServ(user->fd,"482 %s %s :You're not a channel (half)operator",user->nick, targetchannel->name);
 296                                         return;
 297                                 }
 298                         }
 299                 }
 300                 else if (targetuser)
 301                 {
 302                         type = MODETYPE_USER;
 303                         mask = MASK_USER;
 304                 }
 305                 else
 306                 {
 307                         /* No such nick/channel */
 308                         WriteServ(user->fd,"401 %s %s :No such nick/channel",user->nick, parameters[0]);
 309                         return;
 310                 }
 311
 312                 /* Special case for displaying the list for listmodes,
 313                  * e.g. MODE #chan b, or MODE #chan +b without a parameter
 314                  */
 315                 if ((type== MODETYPE_CHANNEL) && (pcnt == 2))
 316                 {
 317                         char* mode = parameters[1];
 318                         if (*mode == '+')
 319                                 mode++;
 320
 321                         unsigned char handler_id = ((*mode) - 65) | mask;
 322                         ModeHandler* mh = modehandlers[handler_id];
 323
 324                         if ((mh) && (mh->IsListMode()))
 325                         {
 326                                 mh->DisplayList(user, targetchannel);
 327                         }
 328                 }
 329
 330                 std::string mode_sequence = parameters[1];
 331                 std::string parameter = "";
 332                 std::ostringstream parameter_list;
 333                 std::string output_sequence = "";
 334                 bool adding = true, state_change = false;
 335                 unsigned char handler_id = 0;
 336                 int parameter_counter = 2; /* Index of first parameter */
 337
 338                 for (std::string::const_iterator letter = mode_sequence.begin(); letter != mode_sequence.end(); letter++)
 339                 {
 340                         unsigned char modechar = *letter;
 341
 342                         switch (modechar)
 343                         {
 344                                 /* NB:
 345                                  * For + and - mode characters, we don't just stick the character into the output sequence.
 346                                  * This is because the user may do something dumb, like: +-+ooo or +oo-+. To prevent this
 347                                  * appearing in the output sequence, we store a flag which says there was a state change,
 348                                  * which is set on any + or -, however, the + or - that we finish on is only appended to
 349                                  * the output stream in the event it is followed by a non "+ or -" character, such as o or v.
 350                                  */
 351                                 case '+':
 352                                         /* The following expression prevents: +o+o nick nick, compressing it to +oo nick nick,
 353                                          * however, will allow the + if it is the first item in the sequence, regardless.
 354                                          */
 355                                         if ((!adding) || (!output_sequence.length()))
 356                                                 state_change = true;
 357                                         adding = true;
 358                                         continue;
 359                                 break;
 360                                 case '-':
 361                                         if ((adding) || (!output_sequence.length()))
 362                                                 state_change = true;
 363                                         adding = false;
 364                                         continue;
 365                                 break;
 366                                 default:
 367
 368                                         /**
 369                                          * Watch carefully for the sleight of hand trick.
 370                                          * 65 is the ascii value of 'A'. We take this from
 371                                          * the char we're looking at to get a number between
 372                                          * 1 and 127. We then logic-or it to get the hashed
 373                                          * position, dependent on wether its a channel or
 374                                          * a user mode. This is a little stranger, but a lot
 375                                          * faster, than using a map of pairs.
 376                                          */
 377                                         handler_id = (modechar - 65) | mask;
 378
 379                                         if (modehandlers[handler_id])
 380                                         {
 381                                                 bool abort = false;
 382
 383                                                 for (ModeWatchIter watchers = modewatchers[handler_id].begin(); watchers != modewatchers[handler_id].end(); watchers++)
 384                                                 {
 385                                                         if ((*watchers)->BeforeMode(user, targetuser, targetchannel, parameter, adding, type) == MODEACTION_DENY)
 386                                                                 abort = true;
 387                                                 }
 388                                                 if ((modehandlers[handler_id]->GetModeType() == type) && (!abort))
 389                                                 {
 390                                                         if (modehandlers[handler_id]->GetNumParams(adding))
 391                                                         {
 392                                                                 /* This mode expects a parameter, do we have any parameters left in our list to use? */
 393                                                                 if (parameter_counter < pcnt)
 394                                                                 {
 395                                                                         parameter = parameters[parameter_counter++];
 396                                                                 }
 397                                                                 else
 398                                                                 {
 399                                                                         /* No parameter, continue to the next mode */
 400                                                                         continue;
 401                                                                 }
 402                                                         }
 403
 404                                                         /* It's an oper only mode, check if theyre an oper. If they arent,
 405                                                          * eat any parameter that  came with the mode, and continue to next
 406                                                          */
 407                                                         if ((IS_LOCAL(user)) && (modehandlers[handler_id]->NeedsOper()) && (!*user->oper))
 408                                                                 continue;
 409
 410                                                         /* Call the handler for the mode */
 411                                                         ModeAction ma = modehandlers[handler_id]->OnModeChange(user, targetuser, targetchannel, parameter, adding);
 412
 413                                                         if ((modehandlers[handler_id]->GetNumParams(adding)) && (parameter == ""))
 414                                                         {
 415                                                                 /* The handler nuked the parameter and they are supposed to have one.
 416                                                                  * We CANT continue now, even if they actually returned MODEACTION_ALLOW,
 417                                                                  * so we bail to the next mode character.
 418                                                                  */
 419                                                                 continue;
 420                                                         }
 421
 422                                                         if (ma == MODEACTION_ALLOW)
 423                                                         {
 424                                                                 /* We're about to output a valid mode letter - was there previously a pending state-change? */
 425                                                                 if (state_change)
 426                                                                         output_sequence.append(adding ? "+" : "-");
 427
 428                                                                 /* Add the mode letter */
 429                                                                 output_sequence.push_back(modechar);
 430
 431                                                                 /* Is there a valid parameter for this mode? If so add it to the parameter list */
 432                                                                 if ((modehandlers[handler_id]->GetNumParams(adding)) && (parameter != ""))
 433                                                                         parameter_list << " " << parameter;
 434
 435                                                                 /* Call all the AfterMode events in the mode watchers for this mode */
 436                                                                 for (ModeWatchIter watchers = modewatchers[handler_id].begin(); watchers != modewatchers[handler_id].end(); watchers++)
 437                                                                         (*watchers)->AfterMode(user, targetuser, targetchannel, parameter, adding, type);
 438
 439                                                                 /* Reset the state change flag */
 440                                                                 state_change = false;
 441                                                         }
 442                                                 }
 443                                         }
 444                                         else
 445                                         {
 446                                                 /* No mode handler? Unknown mode character then. */
 447                                                 WriteServ(user->fd,"472 %s %c :is unknown mode char to me",user->nick, modechar);
 448                                         }
 449                                 break;
 450                         }
 451                 }
 452                 /* Was there at least one valid mode in the sequence? */
 453                 if (output_sequence != "")
 454                 {
 455                         if (servermode)
 456                         {
 457                                 if (type == MODETYPE_CHANNEL)
 458                                 {
 459                                         WriteChannelWithServ(Config->ServerName,targetchannel,"MODE %s %s%s",targetchannel->name,output_sequence.c_str(),parameter_list.str().c_str());
 460                                 }
 461                                 else
 462                                 {
 463                                         WriteServ(targetuser->fd,"MODE %s %s",targetuser->nick,output_sequence.c_str());
 464                                 }
 465                         }
 466                         else
 467                         {
 468                                 if (type == MODETYPE_CHANNEL)
 469                                 {
 470                                         log(DEBUG,"Write output sequence and parameters to channel: %s %s%s",targetchannel->name,output_sequence.c_str(),parameter_list.str().c_str());
 471                                         WriteChannel(targetchannel,user,"MODE %s %s%s",targetchannel->name,output_sequence.c_str(),parameter_list.str().c_str());
 472                                         FOREACH_MOD(I_OnMode,OnMode(user, targetchannel, TYPE_CHANNEL, output_sequence + parameter_list.str()));
 473                                 }
 474                                 else
 475                                 {
 476                                         WriteTo(user,targetuser,"MODE %s %s",targetuser->nick,output_sequence.c_str());
 477                                         FOREACH_MOD(I_OnMode,OnMode(user, targetuser, TYPE_USER, output_sequence));
 478                                 }
 479                         }
 480                 }
 481         }
 482 }
 483
 484
 485 void cmd_mode::Handle (char **parameters, int pcnt, userrec *user)
 486 {
 487         if (!user)
 488                 return;
 489
 490         ServerInstance->ModeGrok->Process(parameters, pcnt, user, false);
 491
 492         return;
 493 }
 494
 495 void ModeParser::CleanMask(std::string &mask)
 496 {
 497         std::string::size_type pos_of_pling = mask.find_first_of('!');
 498         std::string::size_type pos_of_at = mask.find_first_of('@');
 499         std::string::size_type pos_of_dot = mask.find_first_of('.');
 500         std::string::size_type pos_of_colon = mask.find_first_of(':'); /* Because ipv6 addresses are colon delimited */
 501
 502         if ((pos_of_pling == std::string::npos) && (pos_of_at == std::string::npos))
 503         {
 504                 /* Just a nick, or just a host */
 505                 if ((pos_of_dot == std::string::npos) && (pos_of_colon == std::string::npos))
 506                 {
 507                         /* It has no '.' in it, it must be a nick. */
 508                         mask.append("!*@*");
 509                 }
 510                 else
 511                 {
 512                         /* Got a dot in it? Has to be a host */
 513                         mask = "*!*@" + mask;
 514                 }
 515         }
 516         else if ((pos_of_pling == std::string::npos) && (pos_of_at != std::string::npos))
 517         {
 518                 /* Has an @ but no !, its a user@host */
 519                  mask = "*!" + mask;
 520         }
 521         else if ((pos_of_pling != std::string::npos) && (pos_of_at == std::string::npos))
 522         {
 523                 /* Has a ! but no @, it must be a nick!ident */
 524                 mask.append("@*");
 525         }
 526 }
 527
 528 bool ModeParser::AddMode(ModeHandler* mh, unsigned const char modeletter)
 529 {
 530         unsigned char mask = 0;
 531         unsigned char pos = 0;
 532
 533         /* Yes, i know, this might let people declare modes like '_' or '^'.
 534          * If they do that, thats their problem, and if i ever EVER see an
 535          * official InspIRCd developer do that, i'll beat them with a paddle!
 536          */
 537         if ((mh->GetModeChar() < 'A') || (mh->GetModeChar() > 'z'))
 538                 return false;
 539
 540         mh->GetModeType() == MODETYPE_USER ? mask = MASK_USER : mask = MASK_CHANNEL;
 541         pos = (mh->GetModeChar()-65) | mask;
 542
 543         if (modehandlers[pos])
 544                 return false;
 545
 546         modehandlers[pos] = mh;
 547         log(DEBUG,"ModeParser::AddMode: added mode %c",mh->GetModeChar());
 548         return true;
 549 }
 550
 551 bool ModeParser::AddModeWatcher(ModeWatcher* mw)
 552 {
 553         unsigned char mask = 0;
 554         unsigned char pos = 0;
 555
 556         if (!mw)
 557                 return false;
 558
 559         if ((mw->GetModeChar() < 'A') || (mw->GetModeChar() > 'z'))
 560                 return false;
 561
 562         mw->GetModeType() == MODETYPE_USER ? mask = MASK_USER : mask = MASK_CHANNEL;
 563         pos = (mw->GetModeChar()-65) | mask;
 564
 565         modewatchers[pos].push_back(mw);
 566         log(DEBUG,"ModeParser::AddModeWatcher: watching mode %c",mw->GetModeChar());
 567
 568         return true;
 569 }
 570
 571 bool ModeParser::DelModeWatcher(ModeWatcher* mw)
 572 {
 573         unsigned char mask = 0;
 574         unsigned char pos = 0;
 575
 576         if (!mw)
 577                 return false;
 578
 579         if ((mw->GetModeType() < 'A') || (mw->GetModeType() > 'z'))
 580                 return false;
 581
 582         mw->GetModeType() == MODETYPE_USER ? mask = MASK_USER : mask = MASK_CHANNEL;
 583         pos = (mw->GetModeChar()-65) | mask;
 584
 585         ModeWatchIter a = find(modewatchers[pos].begin(),modewatchers[pos].end(),mw);
 586
 587         if (a == modewatchers[pos].end())
 588                 return false;
 589
 590         modewatchers[pos].erase(a);
 591         log(DEBUG,"ModeParser::DelModeWatcher: stopped watching mode %c",mw->GetModeChar());
 592
 593         return true;
 594 }
 595
 596 ModeParser::ModeParser()
 597 {
 598         /* Clear mode list */
 599         memset(modehandlers, 0, sizeof(modehandlers));
 600         memset(modewatchers, 0, sizeof(modewatchers));
 601
 602         /* Initialise the RFC mode letters */
 603
 604         /* Start with channel simple modes, no params */
 605         this->AddMode(new ModeChannelSecret, 's');
 606         this->AddMode(new ModeChannelPrivate, 'p');
 607         this->AddMode(new ModeChannelModerated, 'm');
 608         this->AddMode(new ModeChannelTopicOps, 't');
 609         this->AddMode(new ModeChannelNoExternal, 'n');
 610         this->AddMode(new ModeChannelInviteOnly, 'i');
 611
 612         /* Cannel modes with params */
 613         this->AddMode(new ModeChannelKey, 'k');
 614         this->AddMode(new ModeChannelLimit, 'l');
 615
 616         /* Channel listmodes */
 617         this->AddMode(new ModeChannelBan, 'b');
 618         this->AddMode(new ModeChannelOp, 'o');
 619         this->AddMode(new ModeChannelHalfOp, 'h');
 620         this->AddMode(new ModeChannelVoice, 'v');
 621
 622         /* Now for usermodes */
 623         this->AddMode(new ModeUserServerNotice, 's');
 624         this->AddMode(new ModeUserWallops, 'w');
 625         this->AddMode(new ModeUserInvisible, 'i');
 626         this->AddMode(new ModeUserOperator, 'o');
 627         this->AddMode(new ModeUserServerNoticeMask, 'n');
 628 }
 629