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 char *s)
 278 {
 279         for (std::vector<userrec*>::const_iterator i = this->local_users.begin(); i != this->local_users.end(); i++)
 280         {
 281                 userrec* t = (userrec*)(*i);
 282                 if (t->registered == REG_ALL)
 283                 {
 284                         t->WriteServ("NOTICE %s :%s",t->nick,s);
 285                 }
 286                 else
 287                 {
 288                         // fix - unregistered connections receive ERROR, not NOTICE
 289                         t->Write("ERROR :%s",s);
 290                 }
 291         }
 292 }
 293
 294 // this function counts all users connected, wether they are registered or NOT.
 295 int InspIRCd::UserCount()
 296 {
 297         return clientlist.size();
 298 }
 299
 300 // this counts only registered users, so that the percentages in /MAP don't mess up when users are sitting in an unregistered state
 301 int InspIRCd::RegisteredUserCount()
 302 {
 303         return clientlist.size() - this->UnregisteredUserCount();
 304 }
 305
 306 int InspIRCd::InvisibleUserCount()
 307 {
 308         int c = 0;
 309
 310         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
 311         {
 312                 c += ((i->second->registered == REG_ALL) && (i->second->modes[UM_INVISIBLE]));
 313         }
 314
 315         return c;
 316 }
 317
 318 int InspIRCd::OperCount()
 319 {
 320         int c = 0;
 321
 322         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
 323         {
 324                 if (*(i->second->oper))
 325                         c++;
 326         }
 327         return c;
 328 }
 329
 330 int InspIRCd::UnregisteredUserCount()
 331 {
 332         int c = 0;
 333
 334         for (std::vector<userrec*>::const_iterator i = local_users.begin(); i != local_users.end(); i++)
 335         {
 336                 userrec* t = (userrec*)(*i);
 337                 if (t->registered != REG_ALL)
 338                         c++;
 339         }
 340
 341         return c;
 342 }
 343
 344 long InspIRCd::ChannelCount()
 345 {
 346         return chanlist.size();
 347 }
 348
 349 long InspIRCd::LocalUserCount()
 350 {
 351         int c = 0;
 352
 353         for (std::vector<userrec*>::const_iterator i = local_users.begin(); i != local_users.end(); i++)
 354         {
 355                 userrec* t = (userrec*)(*i);
 356                 if (t->registered == REG_ALL)
 357                         c++;
 358         }
 359
 360         return c;
 361 }
 362
 363 bool InspIRCd::IsChannel(const char *chname)
 364 {
 365         char *c;
 366
 367         /* check for no name - don't check for !*chname, as if it is empty, it won't be '#'! */
 368         if (!chname || *chname != '#')
 369         {
 370                 return false;
 371         }
 372
 373         c = (char *)chname + 1;
 374         while (*c)
 375         {
 376                 switch (*c)
 377                 {
 378                         case ' ':
 379                         case ',':
 380                         case 7:
 381                                 return false;
 382                 }
 383
 384                 c++;
 385         }
 386
 387         /* too long a name - note funky pointer arithmetic here. */
 388         if ((c - chname) > CHANMAX)
 389         {
 390                         return false;
 391         }
 392
 393         return true;
 394 }
 395
 396 bool InspIRCd::IsNick(const char* n)
 397 {
 398         if (!n || !*n)
 399                 return false;
 400
 401         int p = 0;
 402         for (char* i = (char*)n; *i; i++, p++)
 403         {
 404                 if ((*i >= 'A') && (*i <= '}'))
 405                 {
 406                         /* "A"-"}" can occur anywhere in a nickname */
 407                         continue;
 408                 }
 409
 410                 if ((((*i >= '0') && (*i <= '9')) || (*i == '-')) && (i > n))
 411                 {
 412                         /* "0"-"9", "-" can occur anywhere BUT the first char of a nickname */
 413                         continue;
 414                 }
 415
 416                 /* invalid character! abort */
 417                 return false;
 418         }
 419
 420         /* too long? or not -- pointer arithmetic rocks */
 421         return (p < NICKMAX - 1);
 422 }
 423
 424 void InspIRCd::OpenLog(char** argv, int argc)
 425 {
 426         if (!*this->LogFileName)
 427         {
 428                 if (Config->logpath == "")
 429                 {
 430                         Config->logpath = ServerConfig::GetFullProgDir(argv,argc) + "/ircd.log";
 431                 }
 432
 433                 Config->log_file = fopen(Config->logpath.c_str(),"a+");
 434         }
 435         else
 436         {
 437                 Config->log_file = fopen(this->LogFileName,"a+");
 438         }
 439
 440         if (!Config->log_file)
 441         {
 442                 printf("ERROR: Could not write to logfile %s: %s\n\n", Config->logpath.c_str(), strerror(errno));
 443                 Exit(ERROR);
 444         }
 445
 446         this->Logger = new FileLogger(this, Config->log_file);
 447 }
 448
 449 void InspIRCd::CheckRoot()
 450 {
 451         if (geteuid() == 0)
 452         {
 453                 printf("WARNING!!! You are running an irc server as ROOT!!! DO NOT DO THIS!!!\n\n");
 454                 this->Log(DEFAULT,"Cant start as root");
 455                 Exit(ERROR);
 456         }
 457 }
 458
 459 void InspIRCd::CheckDie()
 460 {
 461         if (*Config->DieValue)
 462         {
 463                 printf("WARNING: %s\n\n",Config->DieValue);
 464                 this->Log(DEFAULT,"Died because of <die> tag: %s",Config->DieValue);
 465                 Exit(ERROR);
 466         }
 467 }
 468
 469 /* We must load the modules AFTER initializing the socket engine, now */
 470 void InspIRCd::LoadAllModules()
 471 {
 472         char configToken[MAXBUF];
 473         Config->module_names.clear();
 474         this->ModCount = -1;
 475
 476         for (int count = 0; count < Config->ConfValueEnum(Config->config_data, "module"); count++)
 477         {
 478                 Config->ConfValue(Config->config_data, "module","name",count,configToken,MAXBUF);
 479                 printf("[\033[1;32m*\033[0m] Loading module:\t\033[1;32m%s\033[0m\n",configToken);
 480
 481                 if (!this->LoadModule(configToken))
 482                 {
 483                         this->Log(DEFAULT,"There was an error loading a module: %s", this->ModuleError());
 484                         printf("\nThere was an error loading a module: %s\n\n",this->ModuleError());
 485                         Exit(ERROR);
 486                 }
 487         }
 488         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");
 489         this->Log(DEFAULT,"Total loaded modules: %d", this->ModCount+1);
 490 }
 491
 492 void InspIRCd::SendWhoisLine(userrec* user, userrec* dest, int numeric, const std::string &text)
 493 {
 494         std::string copy_text = text;
 495
 496         int MOD_RESULT = 0;
 497         FOREACH_RESULT_I(this, I_OnWhoisLine, OnWhoisLine(user, dest, numeric, copy_text));
 498
 499         if (!MOD_RESULT)
 500                 user->WriteServ("%d %s", numeric, copy_text.c_str());
 501 }
 502
 503 void InspIRCd::SendWhoisLine(userrec* user, userrec* dest, int numeric, const char* format, ...)
 504 {
 505         char textbuffer[MAXBUF];
 506         va_list argsPtr;
 507         va_start (argsPtr, format);
 508         vsnprintf(textbuffer, MAXBUF, format, argsPtr);
 509         va_end(argsPtr);
 510
 511         this->SendWhoisLine(user, dest, numeric, std::string(textbuffer));
 512 }
 513