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 #ifdef _WIN32
  26 #define _CRT_RAND_S
  27 #include <stdlib.h>
  28 #endif
  29
  30 #include "inspircd.h"
  31 #include "xline.h"
  32 #include "exitcodes.h"
  33 #include <iostream>
  34
  35 /* Find a user record by nickname and return a pointer to it */
  36 User* InspIRCd::FindNick(const std::string &nick)
  37 {
  38         if (!nick.empty() && isdigit(*nick.begin()))
  39                 return FindUUID(nick);
  40         return FindNickOnly(nick);
  41 }
  42
  43 User* InspIRCd::FindNickOnly(const std::string &nick)
  44 {
  45         user_hash::iterator iter = this->Users->clientlist.find(nick);
  46
  47         if (iter == this->Users->clientlist.end())
  48                 return NULL;
  49
  50         return iter->second;
  51 }
  52
  53 User *InspIRCd::FindUUID(const std::string &uid)
  54 {
  55         user_hash::iterator finduuid = this->Users->uuidlist.find(uid);
  56
  57         if (finduuid == this->Users->uuidlist.end())
  58                 return NULL;
  59
  60         return finduuid->second;
  61 }
  62 /* find a channel record by channel name and return a pointer to it */
  63
  64 Channel* InspIRCd::FindChan(const std::string &chan)
  65 {
  66         chan_hash::iterator iter = chanlist.find(chan);
  67
  68         if (iter == chanlist.end())
  69                 /* Couldn't find it */
  70                 return NULL;
  71
  72         return iter->second;
  73 }
  74
  75 bool InspIRCd::IsValidMask(const std::string &mask)
  76 {
  77         const char* dest = mask.c_str();
  78         int exclamation = 0;
  79         int atsign = 0;
  80
  81         for (const char* i = dest; *i; i++)
  82         {
  83                 /* out of range character, bad mask */
  84                 if (*i < 32 || *i > 126)
  85                 {
  86                         return false;
  87                 }
  88
  89                 switch (*i)
  90                 {
  91                         case '!':
  92                                 exclamation++;
  93                                 break;
  94                         case '@':
  95                                 atsign++;
  96                                 break;
  97                 }
  98         }
  99
 100         /* valid masks only have 1 ! and @ */
 101         if (exclamation != 1 || atsign != 1)
 102                 return false;
 103
 104         if (mask.length() > ServerInstance->Config->Limits.GetMaxMask())
 105                 return false;
 106
 107         return true;
 108 }
 109
 110 void InspIRCd::StripColor(std::string &sentence)
 111 {
 112         /* refactor this completely due to SQUIT bug since the old code would strip last char and replace with \0 --peavey */
 113         int seq = 0;
 114
 115         for (std::string::iterator i = sentence.begin(); i != sentence.end();)
 116         {
 117                 if (*i == 3)
 118                         seq = 1;
 119                 else if (seq && (( ((*i >= '0') && (*i <= '9')) || (*i == ',') ) ))
 120                 {
 121                         seq++;
 122                         if ( (seq <= 4) && (*i == ',') )
 123                                 seq = 1;
 124                         else if (seq > 3)
 125                                 seq = 0;
 126                 }
 127                 else
 128                         seq = 0;
 129
 130                 // Strip all control codes too except \001 for CTCP
 131                 if (seq || ((*i >= 0) && (*i < 32) && (*i != 1)))
 132                         i = sentence.erase(i);
 133                 else
 134                         ++i;
 135         }
 136 }
 137
 138 void InspIRCd::ProcessColors(file_cache& input)
 139 {
 140         /*
 141          * Replace all color codes from the special[] array to actual
 142          * color code chars using C++ style escape sequences. You
 143          * can append other chars to replace if you like -- Justasic
 144          */
 145         static struct special_chars
 146         {
 147                 std::string character;
 148                 std::string replace;
 149                 special_chars(const std::string& c, const std::string& r)
 150                         : character(c)
 151                         , replace(r)
 152                 {
 153                 }
 154         } special[] = {
 155                 special_chars("\\b", "\x02"), // Bold
 156                 special_chars("\\c", "\x03"), // Color
 157                 special_chars("\\i", "\x1D"), // Italic
 158                 special_chars("\\m", "\x11"), // Monospace
 159                 special_chars("\\s", "\x1E"), // Strikethrough
 160                 special_chars("\\u", "\x1F"), // Underline
 161                 special_chars("\\x", "\x0F"), // Reset
 162                 special_chars("\\", "")
 163         };
 164
 165         for(file_cache::iterator it = input.begin(), it_end = input.end(); it != it_end; it++)
 166         {
 167                 std::string ret = *it;
 168                 for(int i = 0; special[i].character.empty() == false; ++i)
 169                 {
 170                         std::string::size_type pos = ret.find(special[i].character);
 171                         if(pos == std::string::npos) // Couldn't find the character, skip this line
 172                                 continue;
 173
 174                         if((pos > 0) && (ret[pos-1] == '\\') && (ret[pos] == '\\'))
 175                                 continue; // Skip double slashes.
 176
 177                         // Replace all our characters in the array
 178                         while(pos != std::string::npos)
 179                         {
 180                                 ret = ret.substr(0, pos) + special[i].replace + ret.substr(pos + special[i].character.size());
 181                                 pos = ret.find(special[i].character, pos + special[i].replace.size());
 182                         }
 183                 }
 184
 185                 // Replace double slashes with a single slash before we return
 186                 std::string::size_type pos = ret.find("\\\\");
 187                 while(pos != std::string::npos)
 188                 {
 189                         ret = ret.substr(0, pos) + "\\" + ret.substr(pos + 2);
 190                         pos = ret.find("\\\\", pos + 1);
 191                 }
 192                 *it = ret;
 193         }
 194 }
 195
 196 /* true for valid channel name, false else */
 197 bool InspIRCd::DefaultIsChannel(const std::string& chname)
 198 {
 199         if (chname.empty() || chname.length() > ServerInstance->Config->Limits.ChanMax)
 200                 return false;
 201
 202         if (chname[0] != '#')
 203                 return false;
 204
 205         for (std::string::const_iterator i = chname.begin()+1; i != chname.end(); ++i)
 206         {
 207                 switch (*i)
 208                 {
 209                         case ' ':
 210                         case ',':
 211                         case 7:
 212                                 return false;
 213                 }
 214         }
 215
 216         return true;
 217 }
 218
 219 /* true for valid nickname, false else */
 220 bool InspIRCd::DefaultIsNick(const std::string& n)
 221 {
 222         if (n.empty() || n.length() > ServerInstance->Config->Limits.NickMax)
 223                 return false;
 224
 225         for (std::string::const_iterator i = n.begin(); i != n.end(); ++i)
 226         {
 227                 if ((*i >= 'A') && (*i <= '}'))
 228                 {
 229                         /* "A"-"}" can occur anywhere in a nickname */
 230                         continue;
 231                 }
 232
 233                 if ((((*i >= '0') && (*i <= '9')) || (*i == '-')) && (i != n.begin()))
 234                 {
 235                         /* "0"-"9", "-" can occur anywhere BUT the first char of a nickname */
 236                         continue;
 237                 }
 238
 239                 /* invalid character! abort */
 240                 return false;
 241         }
 242
 243         return true;
 244 }
 245
 246 /* return true for good ident, false else */
 247 bool InspIRCd::DefaultIsIdent(const std::string& n)
 248 {
 249         if (n.empty())
 250                 return false;
 251
 252         for (std::string::const_iterator i = n.begin(); i != n.end(); ++i)
 253         {
 254                 if ((*i >= 'A') && (*i <= '}'))
 255                 {
 256                         continue;
 257                 }
 258
 259                 if (((*i >= '0') && (*i <= '9')) || (*i == '-') || (*i == '.'))
 260                 {
 261                         continue;
 262                 }
 263
 264                 return false;
 265         }
 266
 267         return true;
 268 }
 269
 270 bool InspIRCd::IsHost(const std::string& host)
 271 {
 272         // Hostnames must be non-empty and shorter than the maximum hostname length.
 273         if (host.empty() || host.length() > ServerInstance->Config->Limits.MaxHost)
 274                 return false;
 275
 276         unsigned int numdashes = 0;
 277         unsigned int numdots = 0;
 278         bool seendot = false;
 279         const std::string::const_iterator hostend = host.end() - 1;
 280         for (std::string::const_iterator iter = host.begin(); iter != host.end(); ++iter)
 281         {
 282                 unsigned char chr = static_cast<unsigned char>(*iter);
 283
 284                 // If the current character is a label separator.
 285                 if (chr == '.')
 286                 {
 287                         numdots++;
 288
 289                         // Consecutive separators are not allowed and dashes can not exist at the start or end
 290                         // of labels and separators must only exist between labels.
 291                         if (seendot || numdashes || iter == host.begin() || iter == hostend)
 292                                 return false;
 293
 294                         seendot = true;
 295                         continue;
 296                 }
 297
 298                 // If this point is reached then the character is not a dot.
 299                 seendot = false;
 300
 301                 // If the current character is a dash.
 302                 if (chr == '-')
 303                 {
 304                         // Consecutive separators are not allowed and dashes can not exist at the start or end
 305                         // of labels and separators must only exist between labels.
 306                         if (seendot || numdashes >= 2 || iter == host.begin() || iter == hostend)
 307                                 return false;
 308
 309                         numdashes += 1;
 310                         continue;
 311                 }
 312
 313                 // If this point is reached then the character is not a dash.
 314                 numdashes = 0;
 315
 316                 // Alphanumeric characters are allowed at any position.
 317                 if ((chr >= '0' && chr <= '9') || (chr >= 'A' && chr <= 'Z') || (chr >= 'a' && chr <= 'z'))
 318                         continue;
 319
 320                 return false;
 321         }
 322
 323         // Whilst simple hostnames (e.g. localhost) are valid we do not allow the server to use
 324         // them to prevent issues with clients that differentiate between short client and server
 325         // prefixes by checking whether the nickname contains a dot.
 326         return numdots;
 327 }
 328
 329 bool InspIRCd::IsSID(const std::string &str)
 330 {
 331         /* Returns true if the string given is exactly 3 characters long,
 332          * starts with a digit, and the other two characters are A-Z or digits
 333          */
 334         return ((str.length() == 3) && isdigit(str[0]) &&
 335                         ((str[1] >= 'A' && str[1] <= 'Z') || isdigit(str[1])) &&
 336                          ((str[2] >= 'A' && str[2] <= 'Z') || isdigit(str[2])));
 337 }
 338
 339 void InspIRCd::CheckRoot()
 340 {
 341 #ifndef _WIN32
 342         if (geteuid() == 0)
 343         {
 344                 std::cout << "ERROR: You are running an irc server as root! DO NOT DO THIS!" << std::endl << std::endl;
 345                 this->Logs->Log("STARTUP", LOG_DEFAULT, "Can't start as root");
 346                 Exit(EXIT_STATUS_ROOT);
 347         }
 348 #endif
 349 }
 350
 351 /** Refactored by Brain, Jun 2009. Much faster with some clever O(1) array
 352  * lookups and pointer maths.
 353  */
 354 unsigned long InspIRCd::Duration(const std::string &str)
 355 {
 356         unsigned char multiplier = 0;
 357         long total = 0;
 358         long times = 1;
 359         long subtotal = 0;
 360
 361         /* Iterate each item in the string, looking for number or multiplier */
 362         for (std::string::const_reverse_iterator i = str.rbegin(); i != str.rend(); ++i)
 363         {
 364                 /* Found a number, queue it onto the current number */
 365                 if ((*i >= '0') && (*i <= '9'))
 366                 {
 367                         subtotal = subtotal + ((*i - '0') * times);
 368                         times = times * 10;
 369                 }
 370                 else
 371                 {
 372                         /* Found something thats not a number, find out how much
 373                          * it multiplies the built up number by, multiply the total
 374                          * and reset the built up number.
 375                          */
 376                         if (subtotal)
 377                                 total += subtotal * duration_multi[multiplier];
 378
 379                         /* Next subtotal please */
 380                         subtotal = 0;
 381                         multiplier = *i;
 382                         times = 1;
 383                 }
 384         }
 385         if (multiplier)
 386         {
 387                 total += subtotal * duration_multi[multiplier];
 388                 subtotal = 0;
 389         }
 390         /* Any trailing values built up are treated as raw seconds */
 391         return total + subtotal;
 392 }
 393
 394 std::string InspIRCd::Format(va_list& vaList, const char* formatString)
 395 {
 396         static std::vector<char> formatBuffer(1024);
 397
 398         while (true)
 399         {
 400                 va_list dst;
 401                 va_copy(dst, vaList);
 402
 403                 int vsnret = vsnprintf(&formatBuffer[0], formatBuffer.size(), formatString, dst);
 404                 va_end(dst);
 405
 406                 if (vsnret > 0 && static_cast<unsigned>(vsnret) < formatBuffer.size())
 407                 {
 408                         break;
 409                 }
 410
 411                 formatBuffer.resize(formatBuffer.size() * 2);
 412         }
 413
 414         return std::string(&formatBuffer[0]);
 415 }
 416
 417 std::string InspIRCd::Format(const char* formatString, ...)
 418 {
 419         std::string ret;
 420         VAFORMAT(ret, formatString, formatString);
 421         return ret;
 422 }
 423
 424 std::string InspIRCd::TimeString(time_t curtime, const char* format, bool utc)
 425 {
 426 #ifdef _WIN32
 427         if (curtime < 0)
 428                 curtime = 0;
 429 #endif
 430
 431         struct tm* timeinfo = utc ? gmtime(&curtime) : localtime(&curtime);
 432         if (!timeinfo)
 433         {
 434                 curtime = 0;
 435                 timeinfo = localtime(&curtime);
 436         }
 437
 438         // If the calculated year exceeds four digits or is less than the year 1000,
 439         // the behavior of asctime() is undefined
 440         if (timeinfo->tm_year + 1900 > 9999)
 441                 timeinfo->tm_year = 9999 - 1900;
 442         else if (timeinfo->tm_year + 1900 < 1000)
 443                 timeinfo->tm_year = 0;
 444
 445         // This is the default format used by asctime without the terminating new line.
 446         if (!format)
 447                 format = "%a %b %d %Y %H:%M:%S";
 448
 449         char buffer[512];
 450         if (!strftime(buffer, sizeof(buffer), format, timeinfo))
 451                 buffer[0] = '\0';
 452
 453         return buffer;
 454 }
 455
 456 std::string InspIRCd::GenRandomStr(unsigned int length, bool printable)
 457 {
 458         char* buf = new char[length];
 459         GenRandom(buf, length);
 460         std::string rv;
 461         rv.resize(length);
 462         for(size_t i = 0; i < length; i++)
 463                 rv[i] = printable ? 0x3F + (buf[i] & 0x3F) : buf[i];
 464         delete[] buf;
 465         return rv;
 466 }
 467
 468 // NOTE: this has a slight bias for lower values if max is not a power of 2.
 469 // Don't use it if that matters.
 470 unsigned long InspIRCd::GenRandomInt(unsigned long max)
 471 {
 472         unsigned long rv;
 473         GenRandom((char*)&rv, sizeof(rv));
 474         return rv % max;
 475 }
 476
 477 // This is overridden by a higher-quality algorithm when SSL support is loaded
 478 void InspIRCd::DefaultGenRandom(char* output, size_t max)
 479 {
 480         for(unsigned int i=0; i < max; i++)
 481 #ifdef _WIN32
 482         {
 483                 unsigned int uTemp;
 484                 if(rand_s(&uTemp) != 0)
 485                         output[i] = rand();
 486                 else
 487                         output[i] = uTemp;
 488         }
 489 #else
 490                 output[i] = random();
 491 #endif
 492 }