src/helperfuncs.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include <stdarg.h>
  15 #include "configreader.h"
  16 #include "users.h"
  17 #include "modules.h"
  18 #include "wildcard.h"
  19 #include "mode.h"
  20 #include "xline.h"
  21 #include "inspircd.h"
  22
  23 static char TIMESTR[26];
  24 static time_t LAST = 0;
  25
  26 /** Log()
  27  *  Write a line of text `text' to the logfile (and stdout, if in nofork) if the level `level'
  28  *  is greater than the configured loglevel.
  29  */
  30 void InspIRCd::Log(int level, const char* text, ...)
  31 {
  32         /* Do this check again here so that we save pointless vsnprintf calls */
  33         if ((level < Config->LogLevel) && !Config->forcedebug)
  34                 return;
  35
  36         va_list argsPtr;
  37         char textbuffer[65536];
  38
  39         va_start(argsPtr, text);
  40         vsnprintf(textbuffer, 65536, text, argsPtr);
  41         va_end(argsPtr);
  42
  43         this->Log(level, std::string(textbuffer));
  44 }
  45
  46 void InspIRCd::Log(int level, const std::string &text)
  47 {
  48         if (!this->Config)
  49                 return;
  50
  51         /* If we were given -debug we output all messages, regardless of configured loglevel */
  52         if ((level < Config->LogLevel) && !Config->forcedebug)
  53                 return;
  54
  55         if (Time() != LAST)
  56         {
  57                 time_t local = Time();
  58                 struct tm *timeinfo = localtime(&local);
  59
  60                 strlcpy(TIMESTR,asctime(timeinfo),26);
  61                 TIMESTR[24] = ':';
  62                 LAST = Time();
  63         }
  64
  65         if (Config->log_file && Config->writelog)
  66         {
  67                 std::string out = std::string(TIMESTR) + " " + text.c_str() + "\n";
  68                 this->Logger->WriteLogLine(out);
  69         }
  70
  71         if (Config->nofork)
  72         {
  73                 printf("%s %s\n", TIMESTR, text.c_str());
  74         }
  75 }
  76
  77 std::string InspIRCd::GetServerDescription(const char* servername)
  78 {
  79         std::string description;
  80
  81         FOREACH_MOD_I(this,I_OnGetServerDescription,OnGetServerDescription(servername,description));
  82
  83         if (description != "")
  84         {
  85                 return description;
  86         }
  87         else
  88         {
  89                 // not a remote server that can be found, it must be me.
  90                 return Config->ServerDesc;
  91         }
  92 }
  93
  94 /* XXX - We don't use WriteMode for this because WriteMode is very slow and
  95  * this isnt. Basically WriteMode has to iterate ALL the users 'n' times for
  96  * the number of modes provided, e.g. if you send WriteMode 'og' to write to
  97  * opers with globops, and you have 2000 users, thats 4000 iterations. WriteOpers
  98  * uses the oper list, which means if you have 2000 users but only 5 opers,
  99  * it iterates 5 times.
 100  */
 101 void InspIRCd::WriteOpers(const char* text, ...)
 102 {
 103         char textbuffer[MAXBUF];
 104         va_list argsPtr;
 105
 106         va_start(argsPtr, text);
 107         vsnprintf(textbuffer, MAXBUF, text, argsPtr);
 108         va_end(argsPtr);
 109
 110         this->WriteOpers(std::string(textbuffer));
 111 }
 112
 113 void InspIRCd::WriteOpers(const std::string &text)
 114 {
 115         for (std::vector<userrec*>::iterator i = this->all_opers.begin(); i != this->all_opers.end(); i++)
 116         {
 117                 userrec* a = *i;
 118                 if (IS_LOCAL(a) && a->modes[UM_SERVERNOTICE])
 119                 {
 120                         // send server notices to all with +s
 121                         a->WriteServ("NOTICE %s :%s",a->nick,text.c_str());
 122                 }
 123         }
 124 }
 125
 126 void InspIRCd::ServerNoticeAll(char* text, ...)
 127 {
 128         if (!text)
 129                 return;
 130
 131         char textbuffer[MAXBUF];
 132         char formatbuffer[MAXBUF];
 133         va_list argsPtr;
 134         va_start (argsPtr, text);
 135         vsnprintf(textbuffer, MAXBUF, text, argsPtr);
 136         va_end(argsPtr);
 137
 138         snprintf(formatbuffer,MAXBUF,"NOTICE $%s :%s",Config->ServerName,textbuffer);
 139
 140         for (std::vector<userrec*>::const_iterator i = local_users.begin(); i != local_users.end(); i++)
 141         {
 142                 userrec* t = *i;
 143                 t->WriteServ(std::string(formatbuffer));
 144         }
 145 }
 146
 147 void InspIRCd::ServerPrivmsgAll(char* text, ...)
 148 {
 149         if (!text)
 150                 return;
 151
 152         char textbuffer[MAXBUF];
 153         char formatbuffer[MAXBUF];
 154         va_list argsPtr;
 155         va_start (argsPtr, text);
 156         vsnprintf(textbuffer, MAXBUF, text, argsPtr);
 157         va_end(argsPtr);
 158
 159         snprintf(formatbuffer,MAXBUF,"PRIVMSG $%s :%s",Config->ServerName,textbuffer);
 160
 161         for (std::vector<userrec*>::const_iterator i = local_users.begin(); i != local_users.end(); i++)
 162         {
 163                 userrec* t = *i;
 164                 t->WriteServ(std::string(formatbuffer));
 165         }
 166 }
 167
 168 void InspIRCd::WriteMode(const char* modes, int flags, const char* text, ...)
 169 {
 170         char textbuffer[MAXBUF];
 171         int modelen;
 172         va_list argsPtr;
 173
 174         if (!text || !modes || !flags)
 175         {
 176                 this->Log(DEFAULT,"*** BUG *** WriteMode was given an invalid parameter");
 177                 return;
 178         }
 179
 180         va_start(argsPtr, text);
 181         vsnprintf(textbuffer, MAXBUF, text, argsPtr);
 182         va_end(argsPtr);
 183         modelen = strlen(modes);
 184
 185         if (flags == WM_AND)
 186         {
 187                 for (std::vector<userrec*>::const_iterator i = local_users.begin(); i != local_users.end(); i++)
 188                 {
 189                         userrec* t = *i;
 190                         bool send_to_user = true;
 191
 192                         for (int n = 0; n < modelen; n++)
 193                         {
 194                                 if (!t->modes[modes[n]-65])
 195                                 {
 196                                         send_to_user = false;
 197                                         break;
 198                                 }
 199                         }
 200                         if (send_to_user)
 201                                 t->WriteServ("NOTICE %s :%s",t->nick,textbuffer);
 202                 }
 203         }
 204         else
 205         if (flags == WM_OR)
 206         {
 207                 for (std::vector<userrec*>::const_iterator i = local_users.begin(); i != local_users.end(); i++)
 208                 {
 209                         userrec* t = *i;
 210                         bool send_to_user = false;
 211
 212                         for (int n = 0; n < modelen; n++)
 213                         {
 214                                 if (t->modes[modes[n]-65])
 215                                 {
 216                                         send_to_user = true;
 217                                         break;
 218                                 }
 219                         }
 220                         if (send_to_user)
 221                                 t->WriteServ("NOTICE %s :%s",t->nick,textbuffer);
 222                 }
 223         }
 224 }
 225
 226 /* Find a user record by nickname and return a pointer to it */
 227
 228 userrec* InspIRCd::FindNick(const std::string &nick)
 229 {
 230         user_hash::iterator iter = clientlist.find(nick);
 231
 232         if (iter == clientlist.end())
 233                 /* Couldn't find it */
 234                 return NULL;
 235
 236         return iter->second;
 237 }
 238
 239 userrec* InspIRCd::FindNick(const char* nick)
 240 {
 241         user_hash::iterator iter = clientlist.find(nick);
 242
 243         if (iter == clientlist.end())
 244                 return NULL;
 245
 246         return iter->second;
 247 }
 248
 249 /* find a channel record by channel name and return a pointer to it */
 250
 251 chanrec* InspIRCd::FindChan(const char* chan)
 252 {
 253         chan_hash::iterator iter = chanlist.find(chan);
 254
 255         if (iter == chanlist.end())
 256                 /* Couldn't find it */
 257                 return NULL;
 258
 259         return iter->second;
 260 }
 261
 262 chanrec* InspIRCd::FindChan(const std::string &chan)
 263 {
 264         chan_hash::iterator iter = chanlist.find(chan);
 265
 266         if (iter == chanlist.end())
 267                 /* Couldn't find it */
 268                 return NULL;
 269
 270         return iter->second;
 271 }
 272
 273 /*
 274  * sends out an error notice to all connected clients (not to be used
 275  * lightly!)
 276  */
 277 void InspIRCd::SendError(const std::string &s)
 278 {
 279         for (std::vector<userrec*>::const_iterator i = this->local_users.begin(); i != this->local_users.end(); i++)
 280         {
 281                 if ((*i)->registered == REG_ALL)
 282                 {
 283                         (*i)->WriteServ("NOTICE %s :%s",(*i)->nick,s.c_str());
 284                 }
 285                 else
 286                 {
 287                         /* Unregistered connections receive ERROR, not a NOTICE */
 288                         (*i)->Write("ERROR :" + s);
 289                 }
 290                 /* This might generate a whole load of EAGAIN, but we dont really
 291                  * care about this, as if we call SendError something catastrophic
 292                  * has occured anyway, and we wont receive the events for these.
 293                  */
 294                 (*i)->FlushWriteBuf();
 295         }
 296 }
 297
 298 // this function counts all users connected, wether they are registered or NOT.
 299 int InspIRCd::UserCount()
 300 {
 301         return clientlist.size();
 302 }
 303
 304 // this counts only registered users, so that the percentages in /MAP don't mess up when users are sitting in an unregistered state
 305 int InspIRCd::RegisteredUserCount()
 306 {
 307         return clientlist.size() - this->UnregisteredUserCount();
 308 }
 309
 310 int InspIRCd::InvisibleUserCount()
 311 {
 312         int c = 0;
 313
 314         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
 315         {
 316                 c += ((i->second->registered == REG_ALL) && (i->second->modes[UM_INVISIBLE]));
 317         }
 318
 319         return c;
 320 }
 321
 322 int InspIRCd::OperCount()
 323 {
 324         int c = 0;
 325
 326         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
 327         {
 328                 if (*(i->second->oper))
 329                         c++;
 330         }
 331         return c;
 332 }
 333
 334 int InspIRCd::UnregisteredUserCount()
 335 {
 336         int c = 0;
 337
 338         for (std::vector<userrec*>::const_iterator i = local_users.begin(); i != local_users.end(); i++)
 339         {
 340                 userrec* t = (userrec*)(*i);
 341                 if (t->registered != REG_ALL)
 342                         c++;
 343         }
 344
 345         return c;
 346 }
 347
 348 long InspIRCd::ChannelCount()
 349 {
 350         return chanlist.size();
 351 }
 352
 353 long InspIRCd::LocalUserCount()
 354 {
 355         int c = 0;
 356
 357         for (std::vector<userrec*>::const_iterator i = local_users.begin(); i != local_users.end(); i++)
 358         {
 359                 userrec* t = (userrec*)(*i);
 360                 if (t->registered == REG_ALL)
 361                         c++;
 362         }
 363
 364         return c;
 365 }
 366
 367 bool InspIRCd::IsChannel(const char *chname)
 368 {
 369         char *c;
 370
 371         /* check for no name - don't check for !*chname, as if it is empty, it won't be '#'! */
 372         if (!chname || *chname != '#')
 373         {
 374                 return false;
 375         }
 376
 377         c = (char *)chname + 1;
 378         while (*c)
 379         {
 380                 switch (*c)
 381                 {
 382                         case ' ':
 383                         case ',':
 384                         case 7:
 385                                 return false;
 386                 }
 387
 388                 c++;
 389         }
 390
 391         /* too long a name - note funky pointer arithmetic here. */
 392         if ((c - chname) > CHANMAX)
 393         {
 394                         return false;
 395         }
 396
 397         return true;
 398 }
 399
 400 bool InspIRCd::IsNick(const char* n)
 401 {
 402         if (!n || !*n)
 403                 return false;
 404
 405         int p = 0;
 406         for (char* i = (char*)n; *i; i++, p++)
 407         {
 408                 if ((*i >= 'A') && (*i <= '}'))
 409                 {
 410                         /* "A"-"}" can occur anywhere in a nickname */
 411                         continue;
 412                 }
 413
 414                 if ((((*i >= '0') && (*i <= '9')) || (*i == '-')) && (i > n))
 415                 {
 416                         /* "0"-"9", "-" can occur anywhere BUT the first char of a nickname */
 417                         continue;
 418                 }
 419
 420                 /* invalid character! abort */
 421                 return false;
 422         }
 423
 424         /* too long? or not -- pointer arithmetic rocks */
 425         return (p < NICKMAX - 1);
 426 }
 427
 428 void InspIRCd::OpenLog(char** argv, int argc)
 429 {
 430         Config->MyDir = ServerConfig::GetFullProgDir(argv,argc);
 431         Config->argv = argv;
 432         Config->argc = argc;
 433
 434         if (!*this->LogFileName)
 435         {
 436                 if (Config->logpath == "")
 437                 {
 438                         Config->logpath = Config->MyDir + "/ircd.log";
 439                 }
 440
 441                 Config->log_file = fopen(Config->logpath.c_str(),"a+");
 442         }
 443         else
 444         {
 445                 Config->log_file = fopen(this->LogFileName,"a+");
 446         }
 447
 448         if (!Config->log_file)
 449         {
 450                 printf("ERROR: Could not write to logfile %s: %s\n\n", Config->logpath.c_str(), strerror(errno));
 451                 Exit(ERROR);
 452         }
 453
 454         this->Logger = new FileLogger(this, Config->log_file);
 455 }
 456
 457 void InspIRCd::CheckRoot()
 458 {
 459         if (geteuid() == 0)
 460         {
 461                 printf("WARNING!!! You are running an irc server as ROOT!!! DO NOT DO THIS!!!\n\n");
 462                 this->Log(DEFAULT,"Cant start as root");
 463                 Exit(ERROR);
 464         }
 465 }
 466
 467 void InspIRCd::CheckDie()
 468 {
 469         if (*Config->DieValue)
 470         {
 471                 printf("WARNING: %s\n\n",Config->DieValue);
 472                 this->Log(DEFAULT,"Died because of <die> tag: %s",Config->DieValue);
 473                 Exit(ERROR);
 474         }
 475 }
 476
 477 /* We must load the modules AFTER initializing the socket engine, now */
 478 void InspIRCd::LoadAllModules()
 479 {
 480         char configToken[MAXBUF];
 481         Config->module_names.clear();
 482         this->ModCount = -1;
 483
 484         for (int count = 0; count < Config->ConfValueEnum(Config->config_data, "module"); count++)
 485         {
 486                 Config->ConfValue(Config->config_data, "module","name",count,configToken,MAXBUF);
 487                 printf("[\033[1;32m*\033[0m] Loading module:\t\033[1;32m%s\033[0m\n",configToken);
 488
 489                 if (!this->LoadModule(configToken))
 490                 {
 491                         this->Log(DEFAULT,"There was an error loading a module: %s", this->ModuleError());
 492                         printf("\nThere was an error loading a module: %s\n\n",this->ModuleError());
 493                         Exit(ERROR);
 494                 }
 495         }
 496         printf("\nA total of \033[1;32m%d\033[0m module%s been loaded.\n", this->ModCount+1, this->ModCount+1 == 1 ? " has" : "s have");
 497         this->Log(DEFAULT,"Total loaded modules: %d", this->ModCount+1);
 498 }
 499
 500 void InspIRCd::SendWhoisLine(userrec* user, userrec* dest, int numeric, const std::string &text)
 501 {
 502         std::string copy_text = text;
 503
 504         int MOD_RESULT = 0;
 505         FOREACH_RESULT_I(this, I_OnWhoisLine, OnWhoisLine(user, dest, numeric, copy_text));
 506
 507         if (!MOD_RESULT)
 508                 user->WriteServ("%d %s", numeric, copy_text.c_str());
 509 }
 510
 511 void InspIRCd::SendWhoisLine(userrec* user, userrec* dest, int numeric, const char* format, ...)
 512 {
 513         char textbuffer[MAXBUF];
 514         va_list argsPtr;
 515         va_start (argsPtr, format);
 516         vsnprintf(textbuffer, MAXBUF, format, argsPtr);
 517         va_end(argsPtr);
 518
 519         this->SendWhoisLine(user, dest, numeric, std::string(textbuffer));
 520 }
 521