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         return FindUUID(uid.c_str());
 105 }
 106
 107 User *InspIRCd::FindUUID(const char *uid)
 108 {
 109         user_hash::iterator finduuid = this->Users->uuidlist->find(uid);
 110
 111         if (finduuid == this->Users->uuidlist->end())
 112                 return NULL;
 113
 114         return finduuid->second;
 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 (std::vector<LocalUser*>::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 /* true for valid channel name, false else */
 200 bool IsChannelHandler::Call(const char *chname, size_t max)
 201 {
 202         const char *c = chname + 1;
 203
 204         /* check for no name - don't check for !*chname, as if it is empty, it won't be '#'! */
 205         if (!chname || *chname != '#')
 206         {
 207                 return false;
 208         }
 209
 210         while (*c)
 211         {
 212                 switch (*c)
 213                 {
 214                         case ' ':
 215                         case ',':
 216                         case 7:
 217                                 return false;
 218                 }
 219
 220                 c++;
 221         }
 222
 223         size_t len = c - chname;
 224         /* too long a name - note funky pointer arithmetic here. */
 225         if (len > max)
 226         {
 227                         return false;
 228         }
 229
 230         return true;
 231 }
 232
 233 /* true for valid nickname, false else */
 234 bool IsNickHandler::Call(const char* n, size_t max)
 235 {
 236         if (!n || !*n)
 237                 return false;
 238
 239         unsigned int p = 0;
 240         for (const char* i = n; *i; i++, p++)
 241         {
 242                 if ((*i >= 'A') && (*i <= '}'))
 243                 {
 244                         /* "A"-"}" can occur anywhere in a nickname */
 245                         continue;
 246                 }
 247
 248                 if ((((*i >= '0') && (*i <= '9')) || (*i == '-')) && (i > n))
 249                 {
 250                         /* "0"-"9", "-" can occur anywhere BUT the first char of a nickname */
 251                         continue;
 252                 }
 253
 254                 /* invalid character! abort */
 255                 return false;
 256         }
 257
 258         /* too long? or not -- pointer arithmetic rocks */
 259         return (p < max);
 260 }
 261
 262 /* return true for good ident, false else */
 263 bool IsIdentHandler::Call(const char* n)
 264 {
 265         if (!n || !*n)
 266                 return false;
 267
 268         for (const char* i = n; *i; i++)
 269         {
 270                 if ((*i >= 'A') && (*i <= '}'))
 271                 {
 272                         continue;
 273                 }
 274
 275                 if (((*i >= '0') && (*i <= '9')) || (*i == '-') || (*i == '.'))
 276                 {
 277                         continue;
 278                 }
 279
 280                 return false;
 281         }
 282
 283         return true;
 284 }
 285
 286 bool IsSIDHandler::Call(const std::string &str)
 287 {
 288         /* Returns true if the string given is exactly 3 characters long,
 289          * starts with a digit, and the other two characters are A-Z or digits
 290          */
 291         return ((str.length() == 3) && isdigit(str[0]) &&
 292                         ((str[1] >= 'A' && str[1] <= 'Z') || isdigit(str[1])) &&
 293                          ((str[2] >= 'A' && str[2] <= 'Z') || isdigit(str[2])));
 294 }
 295
 296 /* open the proper logfile */
 297 bool InspIRCd::OpenLog(char**, int)
 298 {
 299         if (!Config->cmdline.writelog) return true; // Skip opening default log if -nolog
 300
 301         if (Config->cmdline.startup_log.empty())
 302                 Config->cmdline.startup_log = LOG_PATH "/startup.log";
 303         FILE* startup = fopen(Config->cmdline.startup_log.c_str(), "a+");
 304
 305         if (!startup)
 306         {
 307                 return false;
 308         }
 309
 310         FileWriter* fw = new FileWriter(startup);
 311         FileLogStream *f = new FileLogStream((Config->cmdline.forcedebug ? DEBUG : DEFAULT), fw);
 312
 313         this->Logs->AddLogType("*", f, true);
 314
 315         return true;
 316 }
 317
 318 void InspIRCd::CheckRoot()
 319 {
 320 #ifndef _WIN32
 321         if (geteuid() == 0)
 322         {
 323                 std::cout << "ERROR: You are running an irc server as root! DO NOT DO THIS!" << std::endl << std::endl;
 324                 this->Logs->Log("STARTUP",DEFAULT,"Can't start as root");
 325                 Exit(EXIT_STATUS_ROOT);
 326         }
 327 #endif
 328 }
 329
 330 void InspIRCd::SendWhoisLine(User* user, User* dest, int numeric, const std::string &text)
 331 {
 332         std::string copy_text = text;
 333
 334         ModResult MOD_RESULT;
 335         FIRST_MOD_RESULT(OnWhoisLine, MOD_RESULT, (user, dest, numeric, copy_text));
 336
 337         if (MOD_RESULT != MOD_RES_DENY)
 338                 user->WriteServ("%d %s", numeric, copy_text.c_str());
 339 }
 340
 341 void InspIRCd::SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...)
 342 {
 343         char textbuffer[MAXBUF];
 344         va_list argsPtr;
 345         va_start (argsPtr, format);
 346         vsnprintf(textbuffer, MAXBUF, format, argsPtr);
 347         va_end(argsPtr);
 348
 349         this->SendWhoisLine(user, dest, numeric, std::string(textbuffer));
 350 }
 351
 352 /** Refactored by Brain, Jun 2009. Much faster with some clever O(1) array
 353  * lookups and pointer maths.
 354  */
 355 long InspIRCd::Duration(const std::string &str)
 356 {
 357         unsigned char multiplier = 0;
 358         long total = 0;
 359         long times = 1;
 360         long subtotal = 0;
 361
 362         /* Iterate each item in the string, looking for number or multiplier */
 363         for (std::string::const_reverse_iterator i = str.rbegin(); i != str.rend(); ++i)
 364         {
 365                 /* Found a number, queue it onto the current number */
 366                 if ((*i >= '0') && (*i <= '9'))
 367                 {
 368                         subtotal = subtotal + ((*i - '0') * times);
 369                         times = times * 10;
 370                 }
 371                 else
 372                 {
 373                         /* Found something thats not a number, find out how much
 374                          * it multiplies the built up number by, multiply the total
 375                          * and reset the built up number.
 376                          */
 377                         if (subtotal)
 378                                 total += subtotal * duration_multi[multiplier];
 379
 380                         /* Next subtotal please */
 381                         subtotal = 0;
 382                         multiplier = *i;
 383                         times = 1;
 384                 }
 385         }
 386         if (multiplier)
 387         {
 388                 total += subtotal * duration_multi[multiplier];
 389                 subtotal = 0;
 390         }
 391         /* Any trailing values built up are treated as raw seconds */
 392         return total + subtotal;
 393 }
 394
 395 bool InspIRCd::ULine(const std::string& sserver)
 396 {
 397         if (sserver.empty())
 398                 return true;
 399
 400         return (Config->ulines.find(sserver.c_str()) != Config->ulines.end());
 401 }
 402
 403 bool InspIRCd::SilentULine(const std::string& sserver)
 404 {
 405         std::map<irc::string,bool>::iterator n = Config->ulines.find(sserver.c_str());
 406         if (n != Config->ulines.end())
 407                 return n->second;
 408         else
 409                 return false;
 410 }
 411
 412 std::string InspIRCd::TimeString(time_t curtime)
 413 {
 414         return std::string(ctime(&curtime),24);
 415 }
 416
 417 // You should only pass a single character to this.
 418 void InspIRCd::AddExtBanChar(char c)
 419 {
 420         std::string &tok = Config->data005;
 421         std::string::size_type ebpos = tok.find(" EXTBAN=,");
 422
 423         if (ebpos == std::string::npos)
 424         {
 425                 tok.append(" EXTBAN=,");
 426                 tok.push_back(c);
 427         }
 428         else
 429         {
 430                 ebpos += 9;
 431                 while (isalpha(tok[ebpos]) && tok[ebpos] < c)
 432                         ebpos++;
 433                 tok.insert(ebpos, 1, c);
 434         }
 435 }
 436
 437 std::string InspIRCd::GenRandomStr(int length, bool printable)
 438 {
 439         char* buf = new char[length];
 440         GenRandom(buf, length);
 441         std::string rv;
 442         rv.resize(length);
 443         for(int i=0; i < length; i++)
 444                 rv[i] = printable ? 0x3F + (buf[i] & 0x3F) : buf[i];
 445         delete[] buf;
 446         return rv;
 447 }
 448
 449 // NOTE: this has a slight bias for lower values if max is not a power of 2.
 450 // Don't use it if that matters.
 451 unsigned long InspIRCd::GenRandomInt(unsigned long max)
 452 {
 453         unsigned long rv;
 454         GenRandom((char*)&rv, sizeof(rv));
 455         return rv % max;
 456 }
 457
 458 // This is overridden by a higher-quality algorithm when SSL support is loaded
 459 void GenRandomHandler::Call(char *output, size_t max)
 460 {
 461         for(unsigned int i=0; i < max; i++)
 462 #ifdef _WIN32
 463         {
 464                 unsigned int uTemp;
 465                 if(rand_s(&uTemp) != 0)
 466                         output[i] = rand();
 467                 else
 468                         output[i] = uTemp;
 469         }
 470 #else
 471                 output[i] = random();
 472 #endif
 473 }
 474
 475 ModResult OnCheckExemptionHandler::Call(User* user, Channel* chan, const std::string& restriction)
 476 {
 477         unsigned int mypfx = chan->GetPrefixValue(user);
 478         char minmode = 0;
 479         std::string current;
 480
 481         irc::spacesepstream defaultstream(ServerInstance->Config->ConfValue("options")->getString("exemptchanops"));
 482
 483         while (defaultstream.GetToken(current))
 484         {
 485                 std::string::size_type pos = current.find(':');
 486                 if (pos == std::string::npos)
 487                         continue;
 488                 if (current.substr(0,pos) == restriction)
 489                         minmode = current[pos+1];
 490         }
 491
 492         ModeHandler* mh = ServerInstance->Modes->FindMode(minmode, MODETYPE_CHANNEL);
 493         if (mh && mypfx >= mh->GetPrefixRank())
 494                 return MOD_RES_ALLOW;
 495         if (mh || minmode == '*')
 496                 return MOD_RES_DENY;
 497         return MOD_RES_PASSTHRU;
 498 }