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
  52 extern int MODCOUNT;
  53 extern std::vector<Module*> modules;
  54 extern std::vector<ircd_module*> factory;
  55 extern InspIRCd* ServerInstance;
  56 extern ServerConfig* Config;
  57
  58 extern time_t TIME;
  59
  60 ModeHandler::ModeHandler(char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly)
  61         : mode(modeletter), n_params_on(parameters_on), n_params_off(parameters_off), list(listmode), m_type(type), oper(operonly)
  62 {
  63 }
  64
  65 ModeHandler::~ModeHandler()
  66 {
  67 }
  68
  69 bool ModeHandler::IsListMode()
  70 {
  71         return list;
  72 }
  73
  74 ModeType ModeHandler::GetModeType()
  75 {
  76         return m_type;
  77 }
  78
  79 bool ModeHandler::NeedsOper()
  80 {
  81         return oper;
  82 }
  83
  84 int ModeHandler::GetNumParams(bool adding)
  85 {
  86         return adding ? n_params_on : n_params_off;
  87 }
  88
  89 char ModeHandler::GetModeChar()
  90 {
  91         return mode;
  92 }
  93
  94 ModeAction ModeHandler::OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)
  95 {
  96         return MODEACTION_DENY;
  97 }
  98
  99 void ModeHandler::DisplayList(userrec* user, chanrec* channel)
 100 {
 101 }
 102
 103 bool ModeHandler::CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, chanrec* channel)
 104 {
 105         return (ours < theirs);
 106 }
 107
 108 ModeWatcher::ModeWatcher(char modeletter, ModeType type) : mode(modeletter), m_type(type)
 109 {
 110 }
 111
 112 ModeWatcher::~ModeWatcher()
 113 {
 114 }
 115
 116 char ModeWatcher::GetModeChar()
 117 {
 118         return mode;
 119 }
 120
 121 ModeType ModeWatcher::GetModeType()
 122 {
 123         return m_type;
 124 }
 125
 126 bool ModeWatcher::BeforeMode(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding, ModeType type)
 127 {
 128         return true;
 129 }
 130
 131 void ModeWatcher::AfterMode(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter, bool adding, ModeType type)
 132 {
 133 }
 134
 135 userrec* ModeParser::SanityChecks(userrec *user,const char *dest,chanrec *chan,int status)
 136 {
 137         userrec *d;
 138         if ((!user) || (!dest) || (!chan) || (!*dest))
 139         {
 140                 return NULL;
 141         }
 142         d = Find(dest);
 143         if (!d)
 144         {
 145                 WriteServ(user->fd,"401 %s %s :No such nick/channel",user->nick, dest);
 146                 return NULL;
 147         }
 148         return d;
 149 }
 150
 151 const char* ModeParser::Grant(userrec *d,chanrec *chan,int MASK)
 152 {
 153         if (!chan)
 154                 return "";
 155
 156         for (std::vector<ucrec*>::const_iterator i = d->chans.begin(); i != d->chans.end(); i++)
 157         {
 158                 ucrec* n = (ucrec*)(*i);
 159                 if (n->channel == chan)
 160                 {
 161                         if (n->uc_modes & MASK)
 162                         {
 163                                 return "";
 164                         }
 165                         n->uc_modes = ((ucrec*)(*i))->uc_modes | MASK;
 166                         switch (MASK)
 167                         {
 168                                 case UCMODE_OP:
 169                                         n->channel->AddOppedUser(d);
 170                                 break;
 171                                 case UCMODE_HOP:
 172                                         n->channel->AddHalfoppedUser(d);
 173                                 break;
 174                                 case UCMODE_VOICE:
 175                                         n->channel->AddVoicedUser(d);
 176                                 break;
 177                         }
 178                         log(DEBUG,"grant: %s %s",n->channel->name,d->nick);
 179                         return d->nick;
 180                 }
 181         }
 182         return "";
 183 }
 184
 185 const char* ModeParser::Revoke(userrec *d,chanrec *chan,int MASK)
 186 {
 187         if (!chan)
 188                 return "";
 189
 190         for (std::vector<ucrec*>::const_iterator i = d->chans.begin(); i != d->chans.end(); i++)
 191         {
 192                 ucrec* n = (ucrec*)(*i);
 193                 if (n->channel == chan)
 194                 {
 195                         if ((n->uc_modes & MASK) == 0)
 196                         {
 197                                 return "";
 198                         }
 199                         n->uc_modes ^= MASK;
 200                         switch (MASK)
 201                         {
 202                                 case UCMODE_OP:
 203                                         n->channel->DelOppedUser(d);
 204                                 break;
 205                                 case UCMODE_HOP:
 206                                         n->channel->DelHalfoppedUser(d);
 207                                 break;
 208                                 case UCMODE_VOICE:
 209                                         n->channel->DelVoicedUser(d);
 210                                 break;
 211                         }
 212                         log(DEBUG,"revoke: %s %s",n->channel->name,d->nick);
 213                         return d->nick;
 214                 }
 215         }
 216         return "";
 217 }
 218
 219 /*char* ModeParser::GiveHops(userrec *user,char *dest,chanrec *chan,int status)
 220 {
 221         userrec *d = this->SanityChecks(user,dest,chan,status);
 222
 223         if (d)
 224         {
 225                 if (IS_LOCAL(user))
 226                 {
 227                         int MOD_RESULT = 0;
 228                         FOREACH_RESULT(I_OnAccessCheck,OnAccessCheck(user,d,chan,AC_HALFOP));
 229
 230                         if (MOD_RESULT == ACR_DENY)
 231                                 return NULL;
 232                         if (MOD_RESULT == ACR_DEFAULT)
 233                         {
 234                                 if ((status < STATUS_OP) && (!is_uline(user->server)))
 235                                 {
 236                                         WriteServ(user->fd,"482 %s %s :You're not a channel operator",user->nick, chan->name);
 237                                         return NULL;
 238                                 }
 239                         }
 240                 }
 241
 242                 return this->Grant(d,chan,UCMODE_HOP);
 243         }
 244         return NULL;
 245 }
 246
 247 char* ModeParser::GiveVoice(userrec *user,char *dest,chanrec *chan,int status)
 248 {
 249         userrec *d = this->SanityChecks(user,dest,chan,status);
 250
 251         if (d)
 252         {
 253                 if (IS_LOCAL(user))
 254                 {
 255                         int MOD_RESULT = 0;
 256                         FOREACH_RESULT(I_OnAccessCheck,OnAccessCheck(user,d,chan,AC_VOICE));
 257
 258                         if (MOD_RESULT == ACR_DENY)
 259                                 return NULL;
 260                         if (MOD_RESULT == ACR_DEFAULT)
 261                         {
 262                                 if ((status < STATUS_HOP) && (!is_uline(user->server)))
 263                                 {
 264                                         WriteServ(user->fd,"482 %s %s :You must be at least a half-operator to change modes on this channel",user->nick, chan->name);
 265                                         return NULL;
 266                                 }
 267                         }
 268                 }
 269
 270                 return this->Grant(d,chan,UCMODE_VOICE);
 271         }
 272         return NULL;
 273 }
 274
 275 char* ModeParser::TakeHops(userrec *user,char *dest,chanrec *chan,int status)
 276 {
 277         userrec *d = this->SanityChecks(user,dest,chan,status);
 278
 279         if (d)
 280         {
 281                 if (IS_LOCAL(user))
 282                 {
 283                         int MOD_RESULT = 0;
 284                         FOREACH_RESULT(I_OnAccessCheck,OnAccessCheck(user,d,chan,AC_DEHALFOP));
 285
 286                         if (MOD_RESULT == ACR_DENY)
 287                                 return NULL;
 288                         if (MOD_RESULT == ACR_DEFAULT)
 289                         {
 290                                 // Tweak by Brain suggested by w00t, allow a halfop to dehalfop themselves
 291                                 if ((user != d) && ((status < STATUS_OP) && (!is_uline(user->server))))
 292                                 {
 293                                         WriteServ(user->fd,"482 %s %s :You are not a channel operator",user->nick, chan->name);
 294                                         return NULL;
 295                                 }
 296                         }
 297                 }
 298
 299                 return this->Revoke(d,chan,UCMODE_HOP);
 300         }
 301         return NULL;
 302 }
 303
 304 char* ModeParser::TakeVoice(userrec *user,char *dest,chanrec *chan,int status)
 305 {
 306         userrec *d = this->SanityChecks(user,dest,chan,status);
 307
 308         if (d)
 309         {
 310                 if (IS_LOCAL(user))
 311                 {
 312                         int MOD_RESULT = 0;
 313                         FOREACH_RESULT(I_OnAccessCheck,OnAccessCheck(user,d,chan,AC_DEVOICE));
 314
 315                         if (MOD_RESULT == ACR_DENY)
 316                                 return NULL;
 317                         if (MOD_RESULT == ACR_DEFAULT)
 318                         {
 319                                 if ((status < STATUS_HOP) && (!is_uline(user->server)))
 320                                 {
 321                                         WriteServ(user->fd,"482 %s %s :You must be at least a half-operator to change modes on this channel",user->nick, chan->name);
 322                                         return NULL;
 323                                 }
 324                         }
 325                 }
 326
 327                 return this->Revoke(d,chan,UCMODE_VOICE);
 328         }
 329         return NULL;
 330 }*/
 331
 332 void ModeParser::Process(char **parameters, int pcnt, userrec *user, bool servermode)
 333 {
 334         std::string target = parameters[0];
 335         ModeType type = MODETYPE_USER;
 336         unsigned char mask = 0;
 337         chanrec* targetchannel = FindChan(parameters[0]);
 338         userrec* targetuser  = Find(parameters[0]);
 339
 340         log(DEBUG,"ModeParser::Process start");
 341
 342         if (pcnt > 1)
 343         {
 344                 if (targetchannel)
 345                 {
 346                         log(DEBUG,"Target type is CHANNEL");
 347                         type = MODETYPE_CHANNEL;
 348                         mask = MASK_CHANNEL;
 349                 }
 350                 else if (targetuser)
 351                 {
 352                         log(DEBUG,"Target type is USER");
 353                         type = MODETYPE_USER;
 354                         mask = MASK_USER;
 355                 }
 356                 else
 357                 {
 358                         /* No such nick/channel */
 359                         log(DEBUG,"Target type is UNKNOWN, bailing");
 360                         return;
 361                 }
 362                 std::string mode_sequence = parameters[1];
 363                 std::string parameter = "";
 364                 std::ostringstream parameter_list;
 365                 std::string output_sequence = "";
 366                 bool adding = true, state_change = false;
 367                 int handler_id = 0;
 368                 int parameter_counter = 2; /* Index of first parameter */
 369
 370                 for (std::string::const_iterator letter = mode_sequence.begin(); letter != mode_sequence.end(); letter++)
 371                 {
 372                         unsigned char modechar = *letter;
 373
 374                         switch (modechar)
 375                         {
 376
 377                                 log(DEBUG,"Iterate mode letter %c",modechar);
 378
 379                                 /* NB:
 380                                  * For + and - mode characters, we don't just stick the character into the output sequence.
 381                                  * This is because the user may do something dumb, like: +-+ooo or +oo-+. To prevent this
 382                                  * appearing in the output sequence, we store a flag which says there was a state change,
 383                                  * which is set on any + or -, however, the + or - that we finish on is only appended to
 384                                  * the output stream in the event it is followed by a non "+ or -" character, such as o or v.
 385                                  */
 386                                 case '+':
 387                                         /* The following expression prevents: +o+o nick nick, compressing it to +oo nick nick,
 388                                          * however, will allow the + if it is the first item in the sequence, regardless.
 389                                          */
 390                                         if ((!adding) || (!output_sequence.length()))
 391                                                 state_change = true;
 392                                         adding = true;
 393                                         continue;
 394                                 break;
 395                                 case '-':
 396                                         if ((adding) || (!output_sequence.length()))
 397                                                 state_change = true;
 398                                         adding = false;
 399                                         continue;
 400                                 break;
 401                                 default:
 402
 403                                         /**
 404                                          * Watch carefully for the sleight of hand trick.
 405                                          * 65 is the ascii value of 'A'. We take this from
 406                                          * the char we're looking at to get a number between
 407                                          * 1 and 127. We then logic-or it to get the hashed
 408                                          * position, dependent on wether its a channel or
 409                                          * a user mode. This is a little stranger, but a lot
 410                                          * faster, than using a map of pairs.
 411                                          */
 412                                         handler_id = (modechar - 65) | mask;
 413
 414                                         if (modehandlers[handler_id])
 415                                         {
 416                                                 bool abort = false;
 417
 418                                                 log(DEBUG,"Found a ModeHandler* for mode %c",modechar);
 419
 420                                                 for (ModeWatchIter watchers = modewatchers[handler_id].begin(); watchers != modewatchers[handler_id].end(); watchers++)
 421                                                 {
 422                                                         log(DEBUG,"Call a ModeWatcher*");
 423                                                         if ((*watchers)->BeforeMode(user, targetuser, targetchannel, parameter, adding, type) == MODEACTION_DENY)
 424                                                                 abort = true;
 425                                                 }
 426                                                 if ((modehandlers[handler_id]->GetModeType() == type) && (!abort))
 427                                                 {
 428                                                         log(DEBUG,"Modetype match, calling handler");
 429
 430                                                         if (modehandlers[handler_id]->GetNumParams(adding))
 431                                                         {
 432                                                                 log(DEBUG,"ModeHandler* for this mode says it has parameters. pcnt=%d parameter_counter=%d",pcnt,parameter_counter);
 433
 434                                                                 if (parameter_counter < pcnt)
 435                                                                 {
 436                                                                         parameter = parameters[parameter_counter++];
 437                                                                 }
 438                                                                 else
 439                                                                 {
 440                                                                         /* No parameter, continue to the next mode */
 441                                                                         continue;
 442                                                                 }
 443                                                         }
 444                                                         ModeAction ma = modehandlers[handler_id]->OnModeChange(user, targetuser, targetchannel, parameter, adding);
 445
 446                                                         if ((modehandlers[handler_id]->GetNumParams(adding)) && (parameter == ""))
 447                                                         {
 448                                                                 /* The handler nuked the parameter and they are supposed to have one.
 449                                                                  * We CANT continue now, even if they actually returned MODEACTION_ALLOW,
 450                                                                  * so we bail to the next mode character.
 451                                                                  */
 452                                                                 continue;
 453                                                         }
 454
 455                                                         if (ma == MODEACTION_ALLOW)
 456                                                         {
 457                                                                 log(DEBUG,"ModeAction was allow");
 458
 459                                                                 /* We're about to output a valid mode letter - was there previously a pending state-change? */
 460                                                                 if (state_change)
 461                                                                 {
 462                                                                         log(DEBUG,"Appending state change");
 463                                                                         output_sequence.append(adding ? "+" : "-");
 464                                                                 }
 465
 466                                                                 /* Add the mode letter */
 467                                                                 output_sequence.push_back(modechar);
 468                                                                 log(DEBUG,"Added mode letter to output sequence, sequence now: '%s'",output_sequence.c_str());
 469
 470                                                                 /* Is there a valid parameter for this mode? If so add it to the parameter list */
 471                                                                 if ((modehandlers[handler_id]->GetNumParams(adding)) && (parameter != ""))
 472                                                                 {
 473                                                                         log(DEBUG,"Added parameter to parameter_list, list now: '%s'",parameter_list.str().c_str());
 474                                                                         parameter_list << " " << parameter;
 475                                                                 }
 476
 477                                                                 /* Call all the AfterMode events in the mode watchers for this mode */
 478                                                                 for (ModeWatchIter watchers = modewatchers[handler_id].begin(); watchers != modewatchers[handler_id].end(); watchers++)
 479                                                                 {
 480                                                                         log(DEBUG,"Called a ModeWatcher* after event");
 481                                                                         (*watchers)->AfterMode(user, targetuser, targetchannel, parameter, adding, type);
 482                                                                 }
 483
 484                                                                 /* Reset the state change flag */
 485                                                                 state_change = false;
 486                                                         }
 487                                                 }
 488                                         }
 489                                 break;
 490                         }
 491                 }
 492                 /* Was there at least one valid mode in the sequence? */
 493                 if (output_sequence != "")
 494                 {
 495                         if (servermode)
 496                         {
 497                                 if (type == MODETYPE_CHANNEL)
 498                                 {
 499                                         WriteChannelWithServ(Config->ServerName,targetchannel,"MODE %s %s%s",targetchannel->name,output_sequence.c_str(),parameter_list.str().c_str());
 500                                 }
 501                         }
 502                         else
 503                         {
 504                                 if (type == MODETYPE_CHANNEL)
 505                                 {
 506                                         log(DEBUG,"Write output sequence and parameters to channel: %s %s%s",targetchannel->name,output_sequence.c_str(),parameter_list.str().c_str());
 507                                         WriteChannel(targetchannel,user,"MODE %s %s%s",targetchannel->name,output_sequence.c_str(),parameter_list.str().c_str());
 508                                         FOREACH_MOD(I_OnMode,OnMode(user, targetchannel, TYPE_CHANNEL, output_sequence + parameter_list.str()));
 509                                 }
 510                         }
 511                 }
 512         }
 513 }
 514
 515
 516 void cmd_mode::Handle (char **parameters, int pcnt, userrec *user)
 517 {
 518         if (!user)
 519                 return;
 520
 521         ServerInstance->ModeGrok->Process(parameters, pcnt, user, false);
 522
 523         return;
 524 }
 525
 526 void ModeParser::CleanMask(std::string &mask)
 527 {
 528         std::string::size_type pos_of_pling = mask.find_first_of('!');
 529         std::string::size_type pos_of_at = mask.find_first_of('@');
 530         std::string::size_type pos_of_dot = mask.find_first_of('.');
 531         std::string::size_type pos_of_colon = mask.find_first_of(':'); /* Because ipv6 addresses are colon delimited */
 532
 533         if ((pos_of_pling == std::string::npos) && (pos_of_at == std::string::npos))
 534         {
 535                 /* Just a nick, or just a host */
 536                 if ((pos_of_dot == std::string::npos) && (pos_of_colon == std::string::npos))
 537                 {
 538                         /* It has no '.' in it, it must be a nick. */
 539                         mask.append("!*@*");
 540                 }
 541                 else
 542                 {
 543                         /* Got a dot in it? Has to be a host */
 544                         mask = "*!*@" + mask;
 545                 }
 546         }
 547         else if ((pos_of_pling == std::string::npos) && (pos_of_at != std::string::npos))
 548         {
 549                 /* Has an @ but no !, its a user@host */
 550                  mask = "*!" + mask;
 551         }
 552         else if ((pos_of_pling != std::string::npos) && (pos_of_at == std::string::npos))
 553         {
 554                 /* Has a ! but no @, it must be a nick!ident */
 555                 mask.append("@*");
 556         }
 557 }
 558
 559 bool ModeParser::AddMode(ModeHandler* mh, unsigned const char modeletter)
 560 {
 561         unsigned char mask = 0;
 562         unsigned char pos = 0;
 563
 564         /* Yes, i know, this might let people declare modes like '_' or '^'.
 565          * If they do that, thats their problem, and if i ever EVER see an
 566          * official InspIRCd developer do that, i'll beat them with a paddle!
 567          */
 568         if ((modeletter < 'A') || (modeletter > 'z'))
 569                 return false;
 570
 571         mh->GetModeType() == MODETYPE_USER ? mask = MASK_USER : mask = MASK_CHANNEL;
 572         pos = (modeletter-65) | mask;
 573
 574         if (modehandlers[pos])
 575                 return false;
 576
 577         modehandlers[pos] = mh;
 578         log(DEBUG,"ModeParser::AddMode: added mode %c",modeletter);
 579         return true;
 580 }
 581
 582 ModeParser::ModeParser()
 583 {
 584         /* Clear mode list */
 585         memset(modehandlers, 0, sizeof(modehandlers));
 586         memset(modewatchers, 0, sizeof(modewatchers));
 587
 588         /* Initialise the RFC mode letters */
 589         this->AddMode(new ModeChannelSecret, 's');
 590         this->AddMode(new ModeChannelPrivate, 'p');
 591         this->AddMode(new ModeChannelBan, 'b');
 592         this->AddMode(new ModeChannelModerated, 'm');
 593         this->AddMode(new ModeChannelTopicOps, 't');
 594         this->AddMode(new ModeChannelNoExternal, 'n');
 595         this->AddMode(new ModeChannelInviteOnly, 'i');
 596         this->AddMode(new ModeChannelKey, 'k');
 597         this->AddMode(new ModeChannelLimit, 'l');
 598         /* TODO: Modes +o, +v, +h */
 599 }
 600