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