src/inspircd.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  Inspire is copyright (C) 2002-2005 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 /* Now with added unF! ;) */
  18
  19 using namespace std;
  20
  21 #include "inspircd_config.h"
  22 #include "inspircd.h"
  23 #include "inspircd_io.h"
  24 #include <unistd.h>
  25 #include <fcntl.h>
  26 #include <sys/errno.h>
  27 #include <sys/ioctl.h>
  28 #include <sys/utsname.h>
  29 #include <time.h>
  30 #include <string>
  31 #ifdef GCC3
  32 #include <ext/hash_map>
  33 #else
  34 #include <hash_map>
  35 #endif
  36 #include <map>
  37 #include <sstream>
  38 #include <vector>
  39 #include <deque>
  40 #ifdef THREADED_DNS
  41 #include <pthread.h>
  42 #endif
  43 #include "users.h"
  44 #include "ctables.h"
  45 #include "globals.h"
  46 #include "modules.h"
  47 #include "dynamic.h"
  48 #include "wildcard.h"
  49 #include "message.h"
  50 #include "mode.h"
  51 #include "commands.h"
  52 #include "xline.h"
  53 #include "inspstring.h"
  54 #include "dnsqueue.h"
  55 #include "helperfuncs.h"
  56 #include "hashcomp.h"
  57 #include "socketengine.h"
  58 #include "userprocess.h"
  59 #include "socket.h"
  60 #include "typedefs.h"
  61 #include "command_parse.h"
  62
  63 InspIRCd* ServerInstance;
  64
  65 int WHOWAS_STALE = 48; // default WHOWAS Entries last 2 days before they go 'stale'
  66 int WHOWAS_MAX = 100;  // default 100 people maximum in the WHOWAS list
  67
  68 extern std::vector<Module*> modules;
  69 extern std::vector<ircd_module*> factory;
  70
  71 std::vector<InspSocket*> module_sockets;
  72 std::vector<userrec*> local_users;
  73
  74 extern int MODCOUNT;
  75 int openSockfd[MAXSOCKS];
  76 sockaddr_in client,server;
  77 socklen_t length;
  78
  79 extern InspSocket* socket_ref[65535];
  80
  81 time_t TIME = time(NULL), OLDTIME = time(NULL);
  82
  83 SocketEngine* SE = NULL;
  84
  85 // This table references users by file descriptor.
  86 // its an array to make it VERY fast, as all lookups are referenced
  87 // by an integer, meaning there is no need for a scan/search operation.
  88 userrec* fd_ref_table[65536];
  89
  90 Server* MyServer = new Server;
  91 ServerConfig *Config = new ServerConfig;
  92
  93 user_hash clientlist;
  94 chan_hash chanlist;
  95 whowas_hash whowas;
  96 servernamelist servernames;
  97 char lowermap[255];
  98
  99 void AddServerName(std::string servername)
 100 {
 101         log(DEBUG,"Adding server name: %s",servername.c_str());
 102         for (servernamelist::iterator a = servernames.begin(); a < servernames.end(); a++)
 103         {
 104                 if (*a == servername)
 105                         return;
 106         }
 107         servernames.push_back(servername);
 108 }
 109
 110 const char* FindServerNamePtr(std::string servername)
 111 {
 112         for (servernamelist::iterator a = servernames.begin(); a < servernames.end(); a++)
 113         {
 114                 if (*a == servername)
 115                         return a->c_str();
 116         }
 117         AddServerName(servername);
 118         return FindServerNamePtr(servername);
 119 }
 120
 121 std::string InspIRCd::GetRevision()
 122 {
 123         /* w00t got me to replace a bunch of strtok_r
 124          * with something nicer, so i did this. Its the
 125          * same thing really, only in C++. It places the
 126          * text into a std::stringstream which is a readable
 127          * and writeable buffer stream, and then pops two
 128          * words off it, space delimited. Because it reads
 129          * into the same variable twice, the first word
 130          * is discarded, and the second one returned.
 131          */
 132         std::stringstream Revision("$Revision$");
 133         std::string single;
 134         Revision >> single >> single;
 135         return single;
 136 }
 137
 138 void InspIRCd::MakeLowerMap()
 139 {
 140         // initialize the lowercase mapping table
 141         for (unsigned int cn = 0; cn < 256; cn++)
 142                 lowermap[cn] = cn;
 143         // lowercase the uppercase chars
 144         for (unsigned int cn = 65; cn < 91; cn++)
 145                 lowermap[cn] = tolower(cn);
 146         // now replace the specific chars for scandanavian comparison
 147         lowermap[(unsigned)'['] = '{';
 148         lowermap[(unsigned)']'] = '}';
 149         lowermap[(unsigned)'\\'] = '|';
 150 }
 151
 152 InspIRCd::InspIRCd(int argc, char** argv)
 153 {
 154         Start();
 155         module_sockets.clear();
 156         this->startup_time = time(NULL);
 157         srand(time(NULL));
 158         log(DEBUG,"*** InspIRCd starting up!");
 159         if (!FileExists(CONFIG_FILE))
 160         {
 161                 printf("ERROR: Cannot open config file: %s\nExiting...\n",CONFIG_FILE);
 162                 log(DEFAULT,"main: no config");
 163                 printf("ERROR: Your config file is missing, this IRCd will self destruct in 10 seconds!\n");
 164                 Exit(ERROR);
 165         }
 166         if (argc > 1) {
 167                 for (int i = 1; i < argc; i++)
 168                 {
 169                         if (!strcmp(argv[i],"-nofork")) {
 170                                 Config->nofork = true;
 171                         }
 172                         if (!strcmp(argv[i],"-wait")) {
 173                                 sleep(6);
 174                         }
 175                         if (!strcmp(argv[i],"-nolimit")) {
 176                                 Config->unlimitcore = true;
 177                         }
 178                 }
 179         }
 180
 181         strlcpy(Config->MyExecutable,argv[0],MAXBUF);
 182
 183         this->MakeLowerMap();
 184
 185         OpenLog(argv, argc);
 186         Config->ClearStack();
 187         Config->Read(true,NULL);
 188         CheckRoot();
 189         this->ModeGrok = new ModeParser();
 190         this->Parser = new CommandParser();
 191         this->stats = new serverstats();
 192         AddServerName(Config->ServerName);
 193         CheckDie();
 194         stats->BoundPortCount = BindPorts();
 195
 196         printf("\n");
 197         if (!Config->nofork)
 198         {
 199                 if (DaemonSeed() == ERROR)
 200                 {
 201                         printf("ERROR: could not go into daemon mode. Shutting down.\n");
 202                         Exit(ERROR);
 203                 }
 204         }
 205
 206         /* Because of limitations in kqueue on freebsd, we must fork BEFORE we
 207          * initialize the socket engine.
 208          */
 209         SE = new SocketEngine();
 210
 211         /* We must load the modules AFTER initializing the socket engine, now */
 212
 213         return;
 214 }
 215
 216 std::string InspIRCd::GetVersionString()
 217 {
 218         char versiondata[MAXBUF];
 219 #ifdef THREADED_DNS
 220         char dnsengine[] = "multithread";
 221 #else
 222         char dnsengine[] = "singlethread";
 223 #endif
 224         snprintf(versiondata,MAXBUF,"%s Rev. %s %s :%s [FLAGS=%lu,%s,%s]",VERSION,GetRevision().c_str(),Config->ServerName,SYSTEM,(unsigned long)OPTIMISATION,SE->GetName().c_str(),dnsengine);
 225         return versiondata;
 226 }
 227
 228 char* InspIRCd::ModuleError()
 229 {
 230         return MODERR;
 231 }
 232
 233 void InspIRCd::erase_factory(int j)
 234 {
 235         int v = 0;
 236         for (std::vector<ircd_module*>::iterator t = factory.begin(); t != factory.end(); t++)
 237         {
 238                 if (v == j)
 239                 {
 240                         factory.erase(t);
 241                         factory.push_back(NULL);
 242                         return;
 243                 }
 244                 v++;
 245         }
 246 }
 247
 248 void InspIRCd::erase_module(int j)
 249 {
 250         int v1 = 0;
 251         for (std::vector<Module*>::iterator m = modules.begin(); m!= modules.end(); m++)
 252         {
 253                 if (v1 == j)
 254                 {
 255                         delete *m;
 256                         modules.erase(m);
 257                         modules.push_back(NULL);
 258                         break;
 259                 }
 260                 v1++;
 261         }
 262         int v2 = 0;
 263         for (std::vector<std::string>::iterator v = Config->module_names.begin(); v != Config->module_names.end(); v++)
 264         {
 265                 if (v2 == j)
 266                 {
 267                        Config->module_names.erase(v);
 268                        break;
 269                 }
 270                 v2++;
 271         }
 272
 273 }
 274
 275 bool InspIRCd::UnloadModule(const char* filename)
 276 {
 277         std::string filename_str = filename;
 278         for (unsigned int j = 0; j != Config->module_names.size(); j++)
 279         {
 280                 if (Config->module_names[j] == filename_str)
 281                 {
 282                         if (modules[j]->GetVersion().Flags & VF_STATIC)
 283                         {
 284                                 log(DEFAULT,"Failed to unload STATIC module %s",filename);
 285                                 snprintf(MODERR,MAXBUF,"Module not unloadable (marked static)");
 286                                 return false;
 287                         }
 288                         /* Give the module a chance to tidy out all its metadata */
 289                         for (chan_hash::iterator c = chanlist.begin(); c != chanlist.end(); c++)
 290                         {
 291                                 modules[j]->OnCleanup(TYPE_CHANNEL,c->second);
 292                         }
 293                         for (user_hash::iterator u = clientlist.begin(); u != clientlist.end(); u++)
 294                         {
 295                                 modules[j]->OnCleanup(TYPE_USER,u->second);
 296                         }
 297                         FOREACH_MOD(I_OnUnloadModule,OnUnloadModule(modules[j],Config->module_names[j]));
 298                         // found the module
 299                         log(DEBUG,"Deleting module...");
 300                         erase_module(j);
 301                         log(DEBUG,"Erasing module entry...");
 302                         erase_factory(j);
 303                         log(DEBUG,"Removing dependent commands...");
 304                         Parser->RemoveCommands(filename);
 305                         log(DEFAULT,"Module %s unloaded",filename);
 306                         MODCOUNT--;
 307                         return true;
 308                 }
 309         }
 310         log(DEFAULT,"Module %s is not loaded, cannot unload it!",filename);
 311         snprintf(MODERR,MAXBUF,"Module not loaded");
 312         return false;
 313 }
 314
 315 bool InspIRCd::LoadModule(const char* filename)
 316 {
 317         char modfile[MAXBUF];
 318 #ifdef STATIC_LINK
 319         snprintf(modfile,MAXBUF,"%s",filename);
 320 #else
 321         snprintf(modfile,MAXBUF,"%s/%s",Config->ModPath,filename);
 322 #endif
 323         std::string filename_str = filename;
 324 #ifndef STATIC_LINK
 325         if (!DirValid(modfile))
 326         {
 327                 log(DEFAULT,"Module %s is not within the modules directory.",modfile);
 328                 snprintf(MODERR,MAXBUF,"Module %s is not within the modules directory.",modfile);
 329                 return false;
 330         }
 331 #endif
 332         log(DEBUG,"Loading module: %s",modfile);
 333 #ifndef STATIC_LINK
 334         if (FileExists(modfile))
 335         {
 336 #endif
 337                 for (unsigned int j = 0; j < Config->module_names.size(); j++)
 338                 {
 339                         if (Config->module_names[j] == filename_str)
 340                         {
 341                                 log(DEFAULT,"Module %s is already loaded, cannot load a module twice!",modfile);
 342                                 snprintf(MODERR,MAXBUF,"Module already loaded");
 343                                 return false;
 344                         }
 345                 }
 346                 ircd_module* a = new ircd_module(modfile);
 347                 factory[MODCOUNT+1] = a;
 348                 if (factory[MODCOUNT+1]->LastError())
 349                 {
 350                         log(DEFAULT,"Unable to load %s: %s",modfile,factory[MODCOUNT+1]->LastError());
 351                         snprintf(MODERR,MAXBUF,"Loader/Linker error: %s",factory[MODCOUNT+1]->LastError());
 352                         MODCOUNT--;
 353                         return false;
 354                 }
 355                 if (factory[MODCOUNT+1]->factory)
 356                 {
 357                         Module* m = factory[MODCOUNT+1]->factory->CreateModule(MyServer);
 358                         modules[MODCOUNT+1] = m;
 359                         /* save the module and the module's classfactory, if
 360                          * this isnt done, random crashes can occur :/ */
 361                         Config->module_names.push_back(filename);
 362                         modules[MODCOUNT+1]->Implements(Config->implement_lists[MODCOUNT+1]);
 363                 }
 364                 else
 365                 {
 366                         log(DEFAULT,"Unable to load %s",modfile);
 367                         snprintf(MODERR,MAXBUF,"Factory function failed!");
 368                         return false;
 369                 }
 370 #ifndef STATIC_LINK
 371         }
 372         else
 373         {
 374                 log(DEFAULT,"InspIRCd: startup: Module Not Found %s",modfile);
 375                 snprintf(MODERR,MAXBUF,"Module file could not be found");
 376                 return false;
 377         }
 378 #endif
 379         MODCOUNT++;
 380         FOREACH_MOD(I_OnLoadModule,OnLoadModule(modules[MODCOUNT],filename_str));
 381         return true;
 382 }
 383
 384 int InspIRCd::Run()
 385 {
 386         bool expire_run = false;
 387         std::vector<int> activefds;
 388         int incomingSockfd;
 389         int in_port;
 390         userrec* cu = NULL;
 391         InspSocket* s = NULL;
 392         InspSocket* s_del = NULL;
 393         char* target;
 394         unsigned int numberactive;
 395         sockaddr_in sock_us;     // our port number
 396         socklen_t uslen;         // length of our port number
 397
 398         /* Until THIS point, ServerInstance == NULL */
 399
 400         LoadAllModules(this);
 401
 402         printf("\nInspIRCd is now running!\n");
 403
 404         if (!Config->nofork)
 405         {
 406                 freopen("/dev/null","w",stdout);
 407                 freopen("/dev/null","w",stderr);
 408         }
 409
 410         /* Add the listening sockets used for client inbound connections
 411          * to the socket engine
 412          */
 413         for (int count = 0; count < stats->BoundPortCount; count++)
 414                 SE->AddFd(openSockfd[count],true,X_LISTEN);
 415
 416         WritePID(Config->PID);
 417
 418         /* main loop, this never returns */
 419         for (;;)
 420         {
 421                 /* time() seems to be a pretty expensive syscall, so avoid calling it too much.
 422                  * Once per loop iteration is pleanty.
 423                  */
 424                 OLDTIME = TIME;
 425                 TIME = time(NULL);
 426
 427                 /* Run background module timers every few seconds
 428                  * (the docs say modules shouldnt rely on accurate
 429                  * timing using this event, so we dont have to
 430                  * time this exactly).
 431                  */
 432                 if (((TIME % 8) == 0) && (!expire_run))
 433                 {
 434                         expire_lines();
 435                         FOREACH_MOD(I_OnBackgroundTimer,OnBackgroundTimer(TIME));
 436                         expire_run = true;
 437                         continue;
 438                 }
 439                 if ((TIME % 8) == 1)
 440                         expire_run = false;
 441
 442                 /* Once a second, do the background processing */
 443                 if (TIME != OLDTIME)
 444                         while (DoBackgroundUserStuff(TIME));
 445
 446                 /* Call the socket engine to wait on the active
 447                  * file descriptors. The socket engine has everything's
 448                  * descriptors in its list... dns, modules, users,
 449                  * servers... so its nice and easy, just one call.
 450                  */
 451                 SE->Wait(activefds);
 452
 453                 /**
 454                  * Now process each of the fd's. For users, we have a fast
 455                  * lookup table which can find a user by file descriptor, so
 456                  * processing them by fd isnt expensive. If we have a lot of
 457                  * listening ports or module sockets though, things could get
 458                  * ugly.
 459                  */
 460                 numberactive = activefds.size();
 461                 for (unsigned int activefd = 0; activefd < numberactive; activefd++)
 462                 {
 463                         int socket_type = SE->GetType(activefds[activefd]);
 464                         switch (socket_type)
 465                         {
 466                                 case X_ESTAB_CLIENT:
 467
 468                                         cu = fd_ref_table[activefds[activefd]];
 469                                         if (cu)
 470                                                 ProcessUser(cu);
 471
 472                                 break;
 473
 474                                 case X_ESTAB_MODULE:
 475
 476                                         /* Process module-owned sockets.
 477                                          * Modules are encouraged to inherit their sockets from
 478                                          * InspSocket so we can process them neatly like this.
 479                                          */
 480                                         s = socket_ref[activefds[activefd]];
 481
 482                                         if ((s) && (!s->Poll()))
 483                                         {
 484                                                 log(DEBUG,"Socket poll returned false, close and bail");
 485                                                 SE->DelFd(s->GetFd());
 486                                                 for (std::vector<InspSocket*>::iterator a = module_sockets.begin(); a < module_sockets.end(); a++)
 487                                                 {
 488                                                         s_del = (InspSocket*)*a;
 489                                                         if ((s_del) && (s_del->GetFd() == activefds[activefd]))
 490                                                         {
 491                                                                 module_sockets.erase(a);
 492                                                                 break;
 493                                                         }
 494                                                 }
 495                                                 s->Close();
 496                                                 delete s;
 497                                         }
 498
 499                                 break;
 500
 501                                 case X_ESTAB_DNS:
 502
 503                                         /* When we are using single-threaded dns,
 504                                          * the sockets for dns end up in our mainloop.
 505                                          * When we are using multi-threaded dns,
 506                                          * each thread has its own basic poll() loop
 507                                          * within it, making them 'fire and forget'
 508                                          * and independent of the mainloop.
 509                                          */
 510 #ifndef THREADED_DNS
 511                                         dns_poll(activefds[activefd]);
 512 #endif
 513                                 break;
 514
 515                                 case X_LISTEN:
 516
 517                                         /* It's a listener */
 518                                         uslen = sizeof(sock_us);
 519                                         length = sizeof(client);
 520                                         incomingSockfd = accept (activefds[activefd],(struct sockaddr*)&client,&length);
 521                                         if (!getsockname(incomingSockfd,(sockaddr*)&sock_us,&uslen))
 522                                         {
 523                                                 in_port = ntohs(sock_us.sin_port);
 524                                                 log(DEBUG,"Accepted socket %d",incomingSockfd);
 525                                                 target = (char*)inet_ntoa(client.sin_addr);
 526                                                 /* Years and years ago, we used to resolve here
 527                                                  * using gethostbyaddr(). That is sucky and we
 528                                                  * don't do that any more...
 529                                                  */
 530                                                 if (incomingSockfd >= 0)
 531                                                 {
 532                                                         NonBlocking(incomingSockfd);
 533                                                         if (Config->GetIOHook(in_port))
 534                                                         {
 535                                                                 Config->GetIOHook(in_port)->OnRawSocketAccept(incomingSockfd, target, in_port);
 536                                                         }
 537                                                         stats->statsAccept++;
 538                                                         AddClient(incomingSockfd, target, in_port, false, target);
 539                                                         log(DEBUG,"Adding client on port %lu fd=%lu",(unsigned long)in_port,(unsigned long)incomingSockfd);
 540                                                 }
 541                                                 else
 542                                                 {
 543                                                         WriteOpers("*** WARNING: accept() failed on port %lu (%s)",(unsigned long)in_port,target);
 544                                                         log(DEBUG,"accept failed: %lu",(unsigned long)in_port);
 545                                                         stats->statsRefused++;
 546                                                 }
 547                                         }
 548                                         else
 549                                         {
 550                                                 log(DEBUG,"Couldnt look up the port number for fd %lu (OS BROKEN?!)",incomingSockfd);
 551                                                 shutdown(incomingSockfd,2);
 552                                                 close(incomingSockfd);
 553                                         }
 554                                 break;
 555
 556                                 default:
 557                                         /* Something went wrong if we're in here.
 558                                          * In fact, so wrong, im not quite sure
 559                                          * what we would do, so for now, its going
 560                                          * to safely do bugger all.
 561                                          */
 562                                 break;
 563                         }
 564                 }
 565
 566         }
 567         /* This is never reached -- we hope! */
 568         return 0;
 569 }
 570
 571 /**********************************************************************************/
 572
 573 /**
 574  * An ircd in four lines! bwahahaha. ahahahahaha. ahahah *cough*.
 575  */
 576
 577 int main(int argc, char** argv)
 578 {
 579         ServerInstance = new InspIRCd(argc, argv);
 580         ServerInstance->Run();
 581         delete ServerInstance;
 582         return 0;
 583 }
 584