src/modules/m_spanningtree/compat.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *
   6  * This file is part of InspIRCd.  InspIRCd is free software: you can
   7  * redistribute it and/or modify it under the terms of the GNU General Public
   8  * License as published by the Free Software Foundation, version 2.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  13  * details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19
  20 #include "inspircd.h"
  21 #include "main.h"
  22 #include "treesocket.h"
  23 #include "treeserver.h"
  24
  25 static std::string newline("\n");
  26
  27 void TreeSocket::WriteLineNoCompat(const std::string& line)
  28 {
  29         ServerInstance->Logs->Log(MODNAME, LOG_RAWIO, "S[%d] O %s", this->GetFd(), line.c_str());
  30         this->WriteData(line);
  31         this->WriteData(newline);
  32 }
  33
  34 void TreeSocket::WriteLine(const std::string& original_line)
  35 {
  36         if (LinkState == CONNECTED)
  37         {
  38                 if (original_line.c_str()[0] != ':')
  39                 {
  40                         ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Sending line without server prefix!");
  41                         WriteLine(":" + ServerInstance->Config->GetSID() + " " + original_line);
  42                         return;
  43                 }
  44                 if (proto_version != ProtocolVersion)
  45                 {
  46                         std::string line = original_line;
  47                         std::string::size_type a = line.find(' ');
  48                         std::string::size_type b = line.find(' ', a + 1);
  49                         std::string command(line, a + 1, b-a-1);
  50                         // now try to find a translation entry
  51                         // TODO a more efficient lookup method will be needed later
  52                         if (proto_version < 1205)
  53                         {
  54                                 if (command == "IJOIN")
  55                                 {
  56                                         // Convert
  57                                         // :<uid> IJOIN <chan> <membid> [<ts> [<flags>]]
  58                                         // to
  59                                         // :<sid> FJOIN <chan> <ts> + [<flags>],<uuid>
  60                                         std::string::size_type c = line.find(' ', b + 1);
  61                                         if (c == std::string::npos)
  62                                                 return;
  63
  64                                         std::string::size_type d = line.find(' ', c + 1);
  65                                         // Erase membership id first
  66                                         line.erase(c, d-c);
  67                                         if (d == std::string::npos)
  68                                         {
  69                                                 // No TS or modes in the command
  70                                                 // :22DAAAAAB IJOIN #chan
  71                                                 const std::string channame(line, b+1, c-b-1);
  72                                                 Channel* chan = ServerInstance->FindChan(channame);
  73                                                 if (!chan)
  74                                                         return;
  75
  76                                                 line.push_back(' ');
  77                                                 line.append(ConvToStr(chan->age));
  78                                                 line.append(" + ,");
  79                                         }
  80                                         else
  81                                         {
  82                                                 d = line.find(' ', c + 1);
  83                                                 if (d == std::string::npos)
  84                                                 {
  85                                                         // TS present, no modes
  86                                                         // :22DAAAAAC IJOIN #chan 12345
  87                                                         line.append(" + ,");
  88                                                 }
  89                                                 else
  90                                                 {
  91                                                         // Both TS and modes are present
  92                                                         // :22DAAAAAC IJOIN #chan 12345 ov
  93                                                         std::string::size_type e = line.find(' ', d + 1);
  94                                                         if (e != std::string::npos)
  95                                                                 line.erase(e);
  96
  97                                                         line.insert(d, " +");
  98                                                         line.push_back(',');
  99                                                 }
 100                                         }
 101
 102                                         // Move the uuid to the end and replace the I with an F
 103                                         line.append(line.substr(1, 9));
 104                                         line.erase(4, 6);
 105                                         line[5] = 'F';
 106                                 }
 107                                 else if (command == "RESYNC")
 108                                         return;
 109                                 else if (command == "METADATA")
 110                                 {
 111                                         // Drop TS for channel METADATA, translate METADATA operquit into an OPERQUIT command
 112                                         // :sid METADATA #target TS extname ...
 113                                         //     A        B       C  D
 114                                         if (b == std::string::npos)
 115                                                 return;
 116
 117                                         std::string::size_type c = line.find(' ', b + 1);
 118                                         if (c == std::string::npos)
 119                                                 return;
 120
 121                                         std::string::size_type d = line.find(' ', c + 1);
 122                                         if (d == std::string::npos)
 123                                                 return;
 124
 125                                         if (line[b + 1] == '#')
 126                                         {
 127                                                 // We're sending channel metadata
 128                                                 line.erase(c, d-c);
 129                                         }
 130                                         else if (!line.compare(c, d-c, " operquit", 9))
 131                                         {
 132                                                 // ":22D METADATA 22DAAAAAX operquit :message" -> ":22DAAAAAX OPERQUIT :message"
 133                                                 line = ":" + line.substr(b+1, c-b) + "OPERQUIT" + line.substr(d);
 134                                         }
 135                                 }
 136                                 else if (command == "FTOPIC")
 137                                 {
 138                                         // Drop channel TS for FTOPIC
 139                                         // :sid FTOPIC #target TS TopicTS setter :newtopic
 140                                         //     A      B       C  D       E      F
 141                                         // :uid FTOPIC #target TS TopicTS :newtopic
 142                                         //     A      B       C  D       E
 143                                         if (b == std::string::npos)
 144                                                 return;
 145
 146                                         std::string::size_type c = line.find(' ', b + 1);
 147                                         if (c == std::string::npos)
 148                                                 return;
 149
 150                                         std::string::size_type d = line.find(' ', c + 1);
 151                                         if (d == std::string::npos)
 152                                                 return;
 153
 154                                         std::string::size_type e = line.find(' ', d + 1);
 155                                         if (line[e+1] == ':')
 156                                         {
 157                                                 line.erase(c, e-c);
 158                                                 line.erase(a+1, 1);
 159                                         }
 160                                         else
 161                                                 line.erase(c, d-c);
 162                                 }
 163                                 else if ((command == "PING") || (command == "PONG"))
 164                                 {
 165                                         // :22D PING 20D
 166                                         if (line.length() < 13)
 167                                                 return;
 168
 169                                         // Insert the source SID (and a space) between the command and the first parameter
 170                                         line.insert(10, line.substr(1, 4));
 171                                 }
 172                                 else if (command == "OPERTYPE")
 173                                 {
 174                                         std::string::size_type colon = line.find(':', b);
 175                                         if (colon != std::string::npos)
 176                                         {
 177                                                 for (std::string::iterator i = line.begin()+colon; i != line.end(); ++i)
 178                                                 {
 179                                                         if (*i == ' ')
 180                                                                 *i = '_';
 181                                                 }
 182                                                 line.erase(colon, 1);
 183                                         }
 184                                 }
 185                                 else if (command == "INVITE")
 186                                 {
 187                                         // :22D INVITE 22DAAAAAN #chan TS ExpirationTime
 188                                         //     A      B         C     D  E
 189                                         if (b == std::string::npos)
 190                                                 return;
 191
 192                                         std::string::size_type c = line.find(' ', b + 1);
 193                                         if (c == std::string::npos)
 194                                                 return;
 195
 196                                         std::string::size_type d = line.find(' ', c + 1);
 197                                         if (d == std::string::npos)
 198                                                 return;
 199
 200                                         std::string::size_type e = line.find(' ', d + 1);
 201                                         // If there is no expiration time then everything will be erased from 'd'
 202                                         line.erase(d, e-d);
 203                                 }
 204                                 else if (command == "FJOIN")
 205                                 {
 206                                         // Strip membership ids
 207                                         // :22D FJOIN #chan 1234 +f 4:3 :o,22DAAAAAB:15 o,22DAAAAAA:15
 208                                         // :22D FJOIN #chan 1234 +f 4:3 o,22DAAAAAB:15
 209                                         // :22D FJOIN #chan 1234 +Pf 4:3 :
 210
 211                                         // If the last parameter is prefixed by a colon then it's a userlist which may have 0 or more users;
 212                                         // if it isn't, then it is a single member
 213                                         std::string::size_type spcolon = line.find(" :");
 214                                         if (spcolon != std::string::npos)
 215                                         {
 216                                                 spcolon++;
 217                                                 // Loop while there is a ':' in the userlist, this is never true if the channel is empty
 218                                                 std::string::size_type pos = std::string::npos;
 219                                                 while ((pos = line.rfind(':', pos-1)) > spcolon)
 220                                                 {
 221                                                         // Find the next space after the ':'
 222                                                         std::string::size_type sp = line.find(' ', pos);
 223                                                         // Erase characters between the ':' and the next space after it, including the ':' but not the space;
 224                                                         // if there is no next space, everything will be erased between pos and the end of the line
 225                                                         line.erase(pos, sp-pos);
 226                                                 }
 227                                         }
 228                                         else
 229                                         {
 230                                                 // Last parameter is a single member
 231                                                 std::string::size_type sp = line.rfind(' ');
 232                                                 std::string::size_type colon = line.find(':', sp);
 233                                                 line.erase(colon);
 234                                         }
 235                                 }
 236                                 else if (command == "KICK")
 237                                 {
 238                                         // Strip membership id if the KICK has one
 239                                         if (b == std::string::npos)
 240                                                 return;
 241
 242                                         std::string::size_type c = line.find(' ', b + 1);
 243                                         if (c == std::string::npos)
 244                                                 return;
 245
 246                                         std::string::size_type d = line.find(' ', c + 1);
 247                                         if ((d < line.size()-1) && (original_line[d+1] != ':'))
 248                                         {
 249                                                 // There is a third parameter which doesn't begin with a colon, erase it
 250                                                 std::string::size_type e = line.find(' ', d + 1);
 251                                                 line.erase(d, e-d);
 252                                         }
 253                                 }
 254                                 else if (command == "SINFO")
 255                                 {
 256                                         // :22D SINFO version :InspIRCd-3.0
 257                                         //     A     B       C
 258                                         std::string::size_type c = line.find(' ', b + 1);
 259                                         if (c == std::string::npos)
 260                                                 return;
 261
 262                                         // Only translating SINFO version, discard everything else
 263                                         if (line.compare(b, 9, " version ", 9))
 264                                                 return;
 265
 266                                         line = line.substr(0, 5) + "VERSION" + line.substr(c);
 267                                 }
 268                                 else if (command == "SERVER")
 269                                 {
 270                                         // :001 SERVER inspircd.test 002 [<anything> ...] :description
 271                                         //     A      B             C
 272                                         std::string::size_type c = line.find(' ', b + 1);
 273                                         if (c == std::string::npos)
 274                                                 return;
 275
 276                                         std::string::size_type d = c + 4;
 277                                         std::string::size_type spcolon = line.find(" :", d);
 278                                         if (spcolon == std::string::npos)
 279                                                 return;
 280
 281                                         line.erase(d, spcolon-d);
 282                                         line.insert(c, " * 0");
 283
 284                                         if (burstsent)
 285                                         {
 286                                                 WriteLineNoCompat(line);
 287
 288                                                 // Synthesize a :<newserver> BURST <time> message
 289                                                 spcolon = line.find(" :");
 290                                                 line = CmdBuilder(line.substr(spcolon-3, 3), "BURST").push_int(ServerInstance->Time()).str();
 291                                         }
 292                                 }
 293                                 else if (command == "NUM")
 294                                 {
 295                                         // :<sid> NUM <numeric source sid> <target uuid> <3 digit number> <params>
 296                                         // Translate to
 297                                         // :<sid> PUSH <target uuid> :<numeric source name> <3 digit number> <target nick> <params>
 298
 299                                         TreeServer* const numericsource = Utils->FindServerID(line.substr(9, 3));
 300                                         if (!numericsource)
 301                                                 return;
 302
 303                                         // The nick of the target is necessary for building the PUSH message
 304                                         User* const target = ServerInstance->FindUUID(line.substr(13, UIDGenerator::UUID_LENGTH));
 305                                         if (!target)
 306                                                 return;
 307
 308                                         std::string push = InspIRCd::Format(":%.*s PUSH %s ::%s %.*s %s", 3, line.c_str()+1, target->uuid.c_str(), numericsource->GetName().c_str(), 3, line.c_str()+23, target->nick.c_str());
 309                                         push.append(line, 26, std::string::npos);
 310                                         push.swap(line);
 311                                 }
 312                         }
 313                         WriteLineNoCompat(line);
 314                         return;
 315                 }
 316         }
 317
 318         WriteLineNoCompat(original_line);
 319 }
 320
 321 namespace
 322 {
 323         bool InsertCurrentChannelTS(std::vector<std::string>& params, unsigned int chanindex = 0, unsigned int pos = 1)
 324         {
 325                 Channel* chan = ServerInstance->FindChan(params[chanindex]);
 326                 if (!chan)
 327                         return false;
 328
 329                 // Insert the current TS of the channel after the pos-th parameter
 330                 params.insert(params.begin()+pos, ConvToStr(chan->age));
 331                 return true;
 332         }
 333 }
 334
 335 bool TreeSocket::PreProcessOldProtocolMessage(User*& who, std::string& cmd, std::vector<std::string>& params)
 336 {
 337         if ((cmd == "METADATA") && (params.size() >= 3) && (params[0][0] == '#'))
 338         {
 339                 // :20D METADATA #channel extname :extdata
 340                 return InsertCurrentChannelTS(params);
 341         }
 342         else if ((cmd == "FTOPIC") && (params.size() >= 4))
 343         {
 344                 // :20D FTOPIC #channel 100 Attila :topic text
 345                 return InsertCurrentChannelTS(params);
 346         }
 347         else if ((cmd == "PING") || (cmd == "PONG"))
 348         {
 349                 if (params.size() == 1)
 350                 {
 351                         // If it's a PING with 1 parameter, reply with a PONG now, if it's a PONG with 1 parameter (weird), do nothing
 352                         if (cmd[1] == 'I')
 353                                 this->WriteData(":" + ServerInstance->Config->GetSID() + " PONG " + params[0] + newline);
 354
 355                         // Don't process this message further
 356                         return false;
 357                 }
 358
 359                 // :20D PING 20D 22D
 360                 // :20D PONG 20D 22D
 361                 // Drop the first parameter
 362                 params.erase(params.begin());
 363
 364                 // If the target is a server name, translate it to a SID
 365                 if (!InspIRCd::IsSID(params[0]))
 366                 {
 367                         TreeServer* server = Utils->FindServer(params[0]);
 368                         if (!server)
 369                         {
 370                                 // We've no idea what this is, log and stop processing
 371                                 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Received a " + cmd + " with an unknown target: \"" + params[0] + "\", command dropped");
 372                                 return false;
 373                         }
 374
 375                         params[0] = server->GetID();
 376                 }
 377         }
 378         else if ((cmd == "GLINE") || (cmd == "KLINE") || (cmd == "ELINE") || (cmd == "ZLINE") || (cmd == "QLINE"))
 379         {
 380                 // Fix undocumented protocol usage: translate GLINE, ZLINE, etc. into ADDLINE or DELLINE
 381                 if ((params.size() != 1) && (params.size() != 3))
 382                         return false;
 383
 384                 parameterlist p;
 385                 p.push_back(cmd.substr(0, 1));
 386                 p.push_back(params[0]);
 387
 388                 if (params.size() == 3)
 389                 {
 390                         cmd = "ADDLINE";
 391                         p.push_back(who->nick);
 392                         p.push_back(ConvToStr(ServerInstance->Time()));
 393                         p.push_back(ConvToStr(InspIRCd::Duration(params[1])));
 394                         p.push_back(params[2]);
 395                 }
 396                 else
 397                         cmd = "DELLINE";
 398
 399                 params.swap(p);
 400         }
 401         else if (cmd == "SVSMODE")
 402         {
 403                 cmd = "MODE";
 404         }
 405         else if (cmd == "OPERQUIT")
 406         {
 407                 // Translate OPERQUIT into METADATA
 408                 if (params.empty())
 409                         return false;
 410
 411                 cmd = "METADATA";
 412                 params.insert(params.begin(), who->uuid);
 413                 params.insert(params.begin()+1, "operquit");
 414                 who = MyRoot->ServerUser;
 415         }
 416         else if ((cmd == "TOPIC") && (params.size() >= 2))
 417         {
 418                 // :20DAAAAAC TOPIC #chan :new topic
 419                 cmd = "FTOPIC";
 420                 if (!InsertCurrentChannelTS(params))
 421                         return false;
 422
 423                 params.insert(params.begin()+2, ConvToStr(ServerInstance->Time()));
 424         }
 425         else if (cmd == "MODENOTICE")
 426         {
 427                 // MODENOTICE is always supported by 2.0 but it's optional in 3.0.
 428                 params.insert(params.begin(), "*");
 429                 params.insert(params.begin()+1, cmd);
 430                 cmd = "ENCAP";
 431         }
 432         else if (cmd == "RULES")
 433         {
 434                 return false;
 435         }
 436         else if (cmd == "INVITE")
 437         {
 438                 // :20D INVITE 22DAAABBB #chan
 439                 // :20D INVITE 22DAAABBB #chan 123456789
 440                 // Insert channel timestamp after the channel name; the 3rd parameter, if there, is the invite expiration time
 441                 return InsertCurrentChannelTS(params, 1, 2);
 442         }
 443         else if (cmd == "VERSION")
 444         {
 445                 // :20D VERSION :InspIRCd-2.0
 446                 // change to
 447                 // :20D SINFO version :InspIRCd-2.0
 448                 cmd = "SINFO";
 449                 params.insert(params.begin(), "version");
 450         }
 451         else if (cmd == "JOIN")
 452         {
 453                 // 2.0 allows and forwards legacy JOINs but we don't, so translate them to FJOINs before processing
 454                 if ((params.size() != 1) || (IS_SERVER(who)))
 455                         return false; // Huh?
 456
 457                 cmd = "FJOIN";
 458                 Channel* chan = ServerInstance->FindChan(params[0]);
 459                 params.push_back(ConvToStr(chan ? chan->age : ServerInstance->Time()));
 460                 params.push_back("+");
 461                 params.push_back(",");
 462                 params.back().append(who->uuid);
 463                 who = TreeServer::Get(who)->ServerUser;
 464         }
 465         else if ((cmd == "FMODE") && (params.size() >= 2))
 466         {
 467                 // Translate user mode changes with timestamp to MODE
 468                 if (params[0][0] != '#')
 469                 {
 470                         User* user = ServerInstance->FindUUID(params[0]);
 471                         if (!user)
 472                                 return false;
 473
 474                         // Emulate the old nonsensical behavior
 475                         if (user->age < ServerCommand::ExtractTS(params[1]))
 476                                 return false;
 477
 478                         cmd = "MODE";
 479                         params.erase(params.begin()+1);
 480                 }
 481         }
 482         else if ((cmd == "SERVER") && (params.size() > 4))
 483         {
 484                 // This does not affect the initial SERVER line as it is sent before the link state is CONNECTED
 485                 // :20D SERVER <name> * 0 <sid> <desc>
 486                 // change to
 487                 // :20D SERVER <name> <sid> <desc>
 488
 489                 params[1].swap(params[3]);
 490                 params.erase(params.begin()+2, params.begin()+4);
 491
 492                 // If the source of this SERVER message is not bursting, then new servers it introduces are bursting
 493                 TreeServer* server = TreeServer::Get(who);
 494                 if (!server->IsBursting())
 495                         params.insert(params.begin()+2, "burst=" + ConvToStr(((uint64_t)ServerInstance->Time())*1000));
 496         }
 497         else if (cmd == "BURST")
 498         {
 499                 // A server is introducing another one, drop unnecessary BURST
 500                 return false;
 501         }
 502         else if (cmd == "SVSWATCH")
 503         {
 504                 // SVSWATCH was removed because nothing was using it, but better be sure
 505                 return false;
 506         }
 507         else if (cmd == "PUSH")
 508         {
 509                 if ((params.size() != 2) || (!this->MyRoot))
 510                         return false; // Huh?
 511
 512                 irc::tokenstream ts(params.back());
 513
 514                 std::string srcstr;
 515                 ts.GetToken(srcstr);
 516                 srcstr.erase(0, 1);
 517
 518                 std::string token;
 519                 ts.GetToken(token);
 520
 521                 // See if it's a numeric being sent to the target via PUSH
 522                 unsigned int numeric_number = 0;
 523                 if (token.length() == 3)
 524                         numeric_number = ConvToInt(token);
 525
 526                 if ((numeric_number > 0) && (numeric_number < 1000))
 527                 {
 528                         // It's a numeric, translate to NUM
 529
 530                         // srcstr must be a valid server name
 531                         TreeServer* const numericsource = Utils->FindServer(srcstr);
 532                         if (!numericsource)
 533                         {
 534                                 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Unable to translate PUSH numeric %s to user %s from 1202 protocol server %s: source \"%s\" doesn't exist", token.c_str(), params[0].c_str(), this->MyRoot->GetName().c_str(), srcstr.c_str());
 535                                 return false;
 536                         }
 537
 538                         cmd = "NUM";
 539
 540                         // Second parameter becomes the target uuid
 541                         params[0].swap(params[1]);
 542                         // Replace first param (now the PUSH payload, not needed) with the source sid
 543                         params[0] = numericsource->GetID();
 544
 545                         params.push_back(InspIRCd::Format("%03u", numeric_number));
 546
 547                         // Ignore the nickname in the numeric in PUSH
 548                         ts.GetToken(token);
 549
 550                         // Rest of the tokens are the numeric parameters, add them to NUM
 551                         while (ts.GetToken(token))
 552                                 params.push_back(token);
 553                 }
 554                 else if ((token == "PRIVMSG") || (token == "NOTICE"))
 555                 {
 556                         // Command is a PRIVMSG/NOTICE
 557                         cmd.swap(token);
 558
 559                         // Check if the PRIVMSG/NOTICE target is a nickname
 560                         ts.GetToken(token);
 561                         if (token.c_str()[0] == '#')
 562                         {
 563                                 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Unable to translate PUSH %s to user %s from 1202 protocol server %s, target \"%s\"", cmd.c_str(), params[0].c_str(), this->MyRoot->GetName().c_str(), token.c_str());
 564                                 return false;
 565                         }
 566
 567                         // Replace second parameter with the message
 568                         ts.GetToken(params[1]);
 569                 }
 570                 else
 571                 {
 572                         ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Unable to translate PUSH to user %s from 1202 protocol server %s", params[0].c_str(), this->MyRoot->GetName().c_str());
 573                         return false;
 574                 }
 575
 576                 return true;
 577         }
 578
 579         return true; // Passthru
 580 }