src/helperfuncs.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2005-2008 Craig Edwards <craigedwards@brainbox.cc>
   7  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   8  *   Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
   9  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  10  *
  11  * This file is part of InspIRCd.  InspIRCd is free software: you can
  12  * redistribute it and/or modify it under the terms of the GNU General Public
  13  * License as published by the Free Software Foundation, version 2.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24
  25 /* $Core */
  26
  27 #ifdef _WIN32
  28 #define _CRT_RAND_S
  29 #include <stdlib.h>
  30 #endif
  31
  32 #include "inspircd.h"
  33 #include "xline.h"
  34 #include "exitcodes.h"
  35 #include <iostream>
  36
  37 std::string InspIRCd::GetServerDescription(const std::string& servername)
  38 {
  39         std::string description;
  40
  41         FOREACH_MOD(I_OnGetServerDescription,OnGetServerDescription(servername,description));
  42
  43         if (!description.empty())
  44         {
  45                 return description;
  46         }
  47         else
  48         {
  49                 // not a remote server that can be found, it must be me.
  50                 return Config->ServerDesc;
  51         }
  52 }
  53
  54 /* Find a user record by nickname and return a pointer to it */
  55 User* InspIRCd::FindNick(const std::string &nick)
  56 {
  57         if (!nick.empty() && isdigit(*nick.begin()))
  58                 return FindUUID(nick);
  59
  60         user_hash::iterator iter = this->Users->clientlist->find(nick);
  61
  62         if (iter == this->Users->clientlist->end())
  63                 /* Couldn't find it */
  64                 return NULL;
  65
  66         return iter->second;
  67 }
  68
  69 User* InspIRCd::FindNick(const char* nick)
  70 {
  71         if (isdigit(*nick))
  72                 return FindUUID(nick);
  73
  74         user_hash::iterator iter = this->Users->clientlist->find(nick);
  75
  76         if (iter == this->Users->clientlist->end())
  77                 return NULL;
  78
  79         return iter->second;
  80 }
  81
  82 User* InspIRCd::FindNickOnly(const std::string &nick)
  83 {
  84         user_hash::iterator iter = this->Users->clientlist->find(nick);
  85
  86         if (iter == this->Users->clientlist->end())
  87                 return NULL;
  88
  89         return iter->second;
  90 }
  91
  92 User* InspIRCd::FindNickOnly(const char* nick)
  93 {
  94         user_hash::iterator iter = this->Users->clientlist->find(nick);
  95
  96         if (iter == this->Users->clientlist->end())
  97                 return NULL;
  98
  99         return iter->second;
 100 }
 101
 102 User *InspIRCd::FindUUID(const std::string &uid)
 103 {
 104         user_hash::iterator finduuid = this->Users->uuidlist->find(uid);
 105
 106         if (finduuid == this->Users->uuidlist->end())
 107                 return NULL;
 108
 109         return finduuid->second;
 110 }
 111
 112 User *InspIRCd::FindUUID(const char *uid)
 113 {
 114         return FindUUID(std::string(uid));
 115 }
 116
 117 /* find a channel record by channel name and return a pointer to it */
 118 Channel* InspIRCd::FindChan(const char* chan)
 119 {
 120         chan_hash::iterator iter = chanlist->find(chan);
 121
 122         if (iter == chanlist->end())
 123                 /* Couldn't find it */
 124                 return NULL;
 125
 126         return iter->second;
 127 }
 128
 129 Channel* InspIRCd::FindChan(const std::string &chan)
 130 {
 131         chan_hash::iterator iter = chanlist->find(chan);
 132
 133         if (iter == chanlist->end())
 134                 /* Couldn't find it */
 135                 return NULL;
 136
 137         return iter->second;
 138 }
 139
 140 /* Send an error notice to all users, registered or not */
 141 void InspIRCd::SendError(const std::string &s)
 142 {
 143         for (LocalUserList::const_iterator i = this->Users->local_users.begin(); i != this->Users->local_users.end(); i++)
 144         {
 145                 User* u = *i;
 146                 if (u->registered == REG_ALL)
 147                 {
 148                         u->WriteServ("NOTICE %s :%s",u->nick.c_str(),s.c_str());
 149                 }
 150                 else
 151                 {
 152                         /* Unregistered connections receive ERROR, not a NOTICE */
 153                         u->Write("ERROR :" + s);
 154                 }
 155         }
 156 }
 157
 158 /* return channel count */
 159 long InspIRCd::ChannelCount()
 160 {
 161         return chanlist->size();
 162 }
 163
 164 bool InspIRCd::IsValidMask(const std::string &mask)
 165 {
 166         const char* dest = mask.c_str();
 167         int exclamation = 0;
 168         int atsign = 0;
 169
 170         for (const char* i = dest; *i; i++)
 171         {
 172                 /* out of range character, bad mask */
 173                 if (*i < 32 || *i > 126)
 174                 {
 175                         return false;
 176                 }
 177
 178                 switch (*i)
 179                 {
 180                         case '!':
 181                                 exclamation++;
 182                                 break;
 183                         case '@':
 184                                 atsign++;
 185                                 break;
 186                 }
 187         }
 188
 189         /* valid masks only have 1 ! and @ */
 190         if (exclamation != 1 || atsign != 1)
 191                 return false;
 192
 193         if (mask.length() > 250)
 194                 return false;
 195
 196         return true;
 197 }
 198
 199 void InspIRCd::StripColor(std::string &sentence)
 200 {
 201         /* refactor this completely due to SQUIT bug since the old code would strip last char and replace with \0 --peavey */
 202         int seq = 0;
 203
 204         for (std::string::iterator i = sentence.begin(); i != sentence.end();)
 205         {
 206                 if (*i == 3)
 207                         seq = 1;
 208                 else if (seq && (( ((*i >= '0') && (*i <= '9')) || (*i == ',') ) ))
 209                 {
 210                         seq++;
 211                         if ( (seq <= 4) && (*i == ',') )
 212                                 seq = 1;
 213                         else if (seq > 3)
 214                                 seq = 0;
 215                 }
 216                 else
 217                         seq = 0;
 218
 219                 if (seq || ((*i == 2) || (*i == 15) || (*i == 22) || (*i == 21) || (*i == 31)))
 220                         i = sentence.erase(i);
 221                 else
 222                         ++i;
 223         }
 224 }
 225
 226 void InspIRCd::ProcessColors(file_cache& input)
 227 {
 228         /*
 229          * Replace all color codes from the special[] array to actual
 230          * color code chars using C++ style escape sequences. You
 231          * can append other chars to replace if you like -- Justasic
 232          */
 233         static struct special_chars
 234         {
 235                 std::string character;
 236                 std::string replace;
 237                 special_chars(const std::string &c, const std::string &r) : character(c), replace(r) { }
 238         }
 239
 240         special[] = {
 241                 special_chars("\\002", "\002"),  // Bold
 242                 special_chars("\\037", "\037"),  // underline
 243                 special_chars("\\003", "\003"),  // Color
 244                 special_chars("\\017", "\017"), // Stop colors
 245                 special_chars("\\u", "\037"),    // Alias for underline
 246                 special_chars("\\b", "\002"),    // Alias for Bold
 247                 special_chars("\\x", "\017"),    // Alias for stop
 248                 special_chars("\\c", "\003"),    // Alias for color
 249                 special_chars("", "")
 250         };
 251
 252         for(file_cache::iterator it = input.begin(), it_end = input.end(); it != it_end; it++)
 253         {
 254                 std::string ret = *it;
 255                 for(int i = 0; special[i].character.empty() == false; ++i)
 256                 {
 257                         std::string::size_type pos = ret.find(special[i].character);
 258                         if(pos == std::string::npos) // Couldn't find the character, skip this line
 259                                 continue;
 260
 261                         if((pos > 0) && (ret[pos-1] == '\\') && (ret[pos] == '\\'))
 262                                 continue; // Skip double slashes.
 263
 264                         // Replace all our characters in the array
 265                         while(pos != std::string::npos)
 266                         {
 267                                 ret = ret.substr(0, pos) + special[i].replace + ret.substr(pos + special[i].character.size());
 268                                 pos = ret.find(special[i].character, pos + special[i].replace.size());
 269                         }
 270                 }
 271
 272                 // Replace double slashes with a single slash before we return
 273                 std::string::size_type pos = ret.find("\\\\");
 274                 while(pos != std::string::npos)
 275                 {
 276                         ret = ret.substr(0, pos) + "\\" + ret.substr(pos + 2);
 277                         pos = ret.find("\\\\", pos + 1);
 278                 }
 279                 *it = ret;
 280         }
 281 }
 282
 283 /* true for valid channel name, false else */
 284 bool IsChannelHandler::Call(const std::string& chname, size_t max)
 285 {
 286         if (chname.empty() || chname.length() > max)
 287                 return false;
 288
 289         if (chname[0] != '#')
 290                 return false;
 291
 292         for (std::string::const_iterator i = chname.begin()+1; i != chname.end(); ++i)
 293         {
 294                 switch (*i)
 295                 {
 296                         case ' ':
 297                         case ',':
 298                         case 7:
 299                                 return false;
 300                 }
 301         }
 302
 303         return true;
 304 }
 305
 306 /* true for valid nickname, false else */
 307 bool IsNickHandler::Call(const std::string& n, size_t max)
 308 {
 309         if (n.empty() || n.length() > max)
 310                 return false;
 311
 312         for (std::string::const_iterator i = n.begin(); i != n.end(); ++i)
 313         {
 314                 if ((*i >= 'A') && (*i <= '}'))
 315                 {
 316                         /* "A"-"}" can occur anywhere in a nickname */
 317                         continue;
 318                 }
 319
 320                 if ((((*i >= '0') && (*i <= '9')) || (*i == '-')) && (i != n.begin()))
 321                 {
 322                         /* "0"-"9", "-" can occur anywhere BUT the first char of a nickname */
 323                         continue;
 324                 }
 325
 326                 /* invalid character! abort */
 327                 return false;
 328         }
 329
 330         return true;
 331 }
 332
 333 /* return true for good ident, false else */
 334 bool IsIdentHandler::Call(const std::string& n)
 335 {
 336         if (n.empty())
 337                 return false;
 338
 339         for (std::string::const_iterator i = n.begin(); i != n.end(); ++i)
 340         {
 341                 if ((*i >= 'A') && (*i <= '}'))
 342                 {
 343                         continue;
 344                 }
 345
 346                 if (((*i >= '0') && (*i <= '9')) || (*i == '-') || (*i == '.'))
 347                 {
 348                         continue;
 349                 }
 350
 351                 return false;
 352         }
 353
 354         return true;
 355 }
 356
 357 bool InspIRCd::IsSID(const std::string &str)
 358 {
 359         /* Returns true if the string given is exactly 3 characters long,
 360          * starts with a digit, and the other two characters are A-Z or digits
 361          */
 362         return ((str.length() == 3) && isdigit(str[0]) &&
 363                         ((str[1] >= 'A' && str[1] <= 'Z') || isdigit(str[1])) &&
 364                          ((str[2] >= 'A' && str[2] <= 'Z') || isdigit(str[2])));
 365 }
 366
 367 /* open the proper logfile */
 368 bool InspIRCd::OpenLog(char**, int)
 369 {
 370         if (!Config->cmdline.writelog) return true; // Skip opening default log if -nolog
 371
 372         if (Config->cmdline.startup_log.empty())
 373                 Config->cmdline.startup_log = LOG_PATH "/startup.log";
 374         FILE* startup = fopen(Config->cmdline.startup_log.c_str(), "a+");
 375
 376         if (!startup)
 377         {
 378                 return false;
 379         }
 380
 381         FileWriter* fw = new FileWriter(startup);
 382         FileLogStream *f = new FileLogStream((Config->cmdline.forcedebug ? DEBUG : DEFAULT), fw);
 383
 384         this->Logs->AddLogType("*", f, true);
 385
 386         return true;
 387 }
 388
 389 void InspIRCd::CheckRoot()
 390 {
 391 #ifndef _WIN32
 392         if (geteuid() == 0)
 393         {
 394                 std::cout << "ERROR: You are running an irc server as root! DO NOT DO THIS!" << std::endl << std::endl;
 395                 this->Logs->Log("STARTUP",DEFAULT,"Can't start as root");
 396                 Exit(EXIT_STATUS_ROOT);
 397         }
 398 #endif
 399 }
 400
 401 void InspIRCd::SendWhoisLine(User* user, User* dest, int numeric, const std::string &text)
 402 {
 403         std::string copy_text = text;
 404
 405         ModResult MOD_RESULT;
 406         FIRST_MOD_RESULT(OnWhoisLine, MOD_RESULT, (user, dest, numeric, copy_text));
 407
 408         if (MOD_RESULT != MOD_RES_DENY)
 409                 user->WriteServ("%d %s", numeric, copy_text.c_str());
 410 }
 411
 412 void InspIRCd::SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...)
 413 {
 414         char textbuffer[MAXBUF];
 415         va_list argsPtr;
 416         va_start (argsPtr, format);
 417         vsnprintf(textbuffer, MAXBUF, format, argsPtr);
 418         va_end(argsPtr);
 419
 420         this->SendWhoisLine(user, dest, numeric, std::string(textbuffer));
 421 }
 422
 423 /** Refactored by Brain, Jun 2009. Much faster with some clever O(1) array
 424  * lookups and pointer maths.
 425  */
 426 unsigned long InspIRCd::Duration(const std::string &str)
 427 {
 428         unsigned char multiplier = 0;
 429         long total = 0;
 430         long times = 1;
 431         long subtotal = 0;
 432
 433         /* Iterate each item in the string, looking for number or multiplier */
 434         for (std::string::const_reverse_iterator i = str.rbegin(); i != str.rend(); ++i)
 435         {
 436                 /* Found a number, queue it onto the current number */
 437                 if ((*i >= '0') && (*i <= '9'))
 438                 {
 439                         subtotal = subtotal + ((*i - '0') * times);
 440                         times = times * 10;
 441                 }
 442                 else
 443                 {
 444                         /* Found something thats not a number, find out how much
 445                          * it multiplies the built up number by, multiply the total
 446                          * and reset the built up number.
 447                          */
 448                         if (subtotal)
 449                                 total += subtotal * duration_multi[multiplier];
 450
 451                         /* Next subtotal please */
 452                         subtotal = 0;
 453                         multiplier = *i;
 454                         times = 1;
 455                 }
 456         }
 457         if (multiplier)
 458         {
 459                 total += subtotal * duration_multi[multiplier];
 460                 subtotal = 0;
 461         }
 462         /* Any trailing values built up are treated as raw seconds */
 463         return total + subtotal;
 464 }
 465
 466 bool InspIRCd::ULine(const std::string& sserver)
 467 {
 468         if (sserver.empty())
 469                 return true;
 470
 471         return (Config->ulines.find(sserver.c_str()) != Config->ulines.end());
 472 }
 473
 474 bool InspIRCd::SilentULine(const std::string& sserver)
 475 {
 476         std::map<irc::string,bool>::iterator n = Config->ulines.find(sserver.c_str());
 477         if (n != Config->ulines.end())
 478                 return n->second;
 479         else
 480                 return false;
 481 }
 482
 483 std::string InspIRCd::TimeString(time_t curtime)
 484 {
 485         return std::string(ctime(&curtime),24);
 486 }
 487
 488 // You should only pass a single character to this.
 489 void InspIRCd::AddExtBanChar(char c)
 490 {
 491         std::string &tok = Config->data005;
 492         std::string::size_type ebpos = tok.find(" EXTBAN=,");
 493
 494         if (ebpos == std::string::npos)
 495         {
 496                 tok.append(" EXTBAN=,");
 497                 tok.push_back(c);
 498         }
 499         else
 500         {
 501                 ebpos += 9;
 502                 while (isalpha(tok[ebpos]) && tok[ebpos] < c)
 503                         ebpos++;
 504                 tok.insert(ebpos, 1, c);
 505         }
 506 }
 507
 508 std::string InspIRCd::GenRandomStr(int length, bool printable)
 509 {
 510         char* buf = new char[length];
 511         GenRandom(buf, length);
 512         std::string rv;
 513         rv.resize(length);
 514         for(int i=0; i < length; i++)
 515                 rv[i] = printable ? 0x3F + (buf[i] & 0x3F) : buf[i];
 516         delete[] buf;
 517         return rv;
 518 }
 519
 520 // NOTE: this has a slight bias for lower values if max is not a power of 2.
 521 // Don't use it if that matters.
 522 unsigned long InspIRCd::GenRandomInt(unsigned long max)
 523 {
 524         unsigned long rv;
 525         GenRandom((char*)&rv, sizeof(rv));
 526         return rv % max;
 527 }
 528
 529 // This is overridden by a higher-quality algorithm when SSL support is loaded
 530 void GenRandomHandler::Call(char *output, size_t max)
 531 {
 532         for(unsigned int i=0; i < max; i++)
 533 #ifdef _WIN32
 534         {
 535                 unsigned int uTemp;
 536                 if(rand_s(&uTemp) != 0)
 537                         output[i] = rand();
 538                 else
 539                         output[i] = uTemp;
 540         }
 541 #else
 542                 output[i] = random();
 543 #endif
 544 }
 545
 546 ModResult OnCheckExemptionHandler::Call(User* user, Channel* chan, const std::string& restriction)
 547 {
 548         unsigned int mypfx = chan->GetPrefixValue(user);
 549         char minmode = 0;
 550         std::string current;
 551
 552         irc::spacesepstream defaultstream(ServerInstance->Config->ConfValue("options")->getString("exemptchanops"));
 553
 554         while (defaultstream.GetToken(current))
 555         {
 556                 std::string::size_type pos = current.find(':');
 557                 if (pos == std::string::npos)
 558                         continue;
 559                 if (current.substr(0,pos) == restriction)
 560                         minmode = current[pos+1];
 561         }
 562
 563         ModeHandler* mh = ServerInstance->Modes->FindMode(minmode, MODETYPE_CHANNEL);
 564         if (mh && mypfx >= mh->GetPrefixRank())
 565                 return MOD_RES_ALLOW;
 566         if (mh || minmode == '*')
 567                 return MOD_RES_DENY;
 568         return MOD_RES_PASSTHRU;
 569 }