1 /* ---------------------------------------------------------------------
3 * +------------------------------------+
4 * | Inspire Internet Relay Chat Daemon |
5 * +------------------------------------+
7 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
9 * <brain@chatspike.net>
10 * <Craig@chatspike.net>
12 * Written by Craig Edwards, Craig McLure, and others.
13 * This program is free but copyrighted software; you can redistribute
14 * it and/or modify it under the terms of the GNU General Public
15 * License as published by the Free Software Foundation, version 2
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 * ---------------------------------------------------------------------
31 #include "inspircd_config.h"
33 #include "configreader.h"
35 #include <sys/errno.h>
36 #include <sys/ioctl.h>
61 #include "inspstring.h"
63 #include "helperfuncs.h"
65 #include "socketengine.h"
66 #include "userprocess.h"
69 #include "command_parse.h"
71 InspIRCd* ServerInstance;
73 extern ModuleList modules;
74 extern FactoryList factory;
76 std::vector<InspSocket*> module_sockets;
77 std::vector<userrec*> local_users;
80 extern char LOG_FILE[MAXBUF];
83 insp_sockaddr client, server;
86 extern InspSocket* socket_ref[MAX_DESCRIPTORS];
88 time_t TIME = time(NULL), OLDTIME = time(NULL);
90 // This table references users by file descriptor.
91 // its an array to make it VERY fast, as all lookups are referenced
92 // by an integer, meaning there is no need for a scan/search operation.
93 userrec* fd_ref_table[MAX_DESCRIPTORS];
95 Server* MyServer = new Server;
96 ServerConfig *Config = new ServerConfig;
101 servernamelist servernames;
104 void AddServerName(const std::string &servername)
106 log(DEBUG,"Adding server name: %s",servername.c_str());
108 if(find(servernames.begin(), servernames.end(), servername) == servernames.end())
109 servernames.push_back(servername); /* Wasn't already there. */
112 const char* FindServerNamePtr(const std::string &servername)
114 servernamelist::iterator iter = find(servernames.begin(), servernames.end(), servername);
116 if(iter == servernames.end())
118 AddServerName(servername);
119 iter = --servernames.end();
122 return iter->c_str();
125 bool FindServerName(const std::string &servername)
127 return (find(servernames.begin(), servernames.end(), servername) != servernames.end());
130 void Exit(int status)
132 if (Config->log_file)
133 fclose(Config->log_file);
134 send_error("Server shutdown.");
138 void InspIRCd::Start()
140 printf("\033[1;32mInspire Internet Relay Chat Server, compiled %s at %s\n",__DATE__,__TIME__);
141 printf("(C) ChatSpike Development team.\033[0m\n\n");
142 printf("Developers:\t\t\033[1;32mBrain, FrostyCoolSlug, w00t, Om, Special\033[0m\n");
143 printf("Others:\t\t\t\033[1;32mSee /INFO Output\033[0m\n");
144 printf("Name concept:\t\t\033[1;32mLord_Zathras\033[0m\n\n");
147 void Killed(int status)
149 if (Config->log_file)
150 fclose(Config->log_file);
151 send_error("Server terminated.");
155 void Rehash(int status)
157 WriteOpers("Rehashing config file %s due to SIGHUP",CleanFilename(CONFIG_FILE));
158 fclose(Config->log_file);
160 Config->Read(false,NULL);
161 FOREACH_MOD(I_OnRehash,OnRehash(""));
164 void InspIRCd::SetSignals()
166 signal (SIGALRM, SIG_IGN);
167 signal (SIGHUP, Rehash);
168 signal (SIGPIPE, SIG_IGN);
169 signal (SIGTERM, Exit);
170 signal (SIGSEGV, Error);
173 bool InspIRCd::DaemonSeed()
176 if ((childpid = fork ()) < 0)
178 else if (childpid > 0)
180 /* We wait a few seconds here, so that the shell prompt doesnt come back over the output */
186 printf("InspIRCd Process ID: \033[1;32m%lu\033[0m\n",(unsigned long)getpid());
189 if (getrlimit(RLIMIT_CORE, &rl) == -1)
191 log(DEFAULT,"Failed to getrlimit()!");
196 rl.rlim_cur = rl.rlim_max;
197 if (setrlimit(RLIMIT_CORE, &rl) == -1)
198 log(DEFAULT,"setrlimit() failed, cannot increase coredump size.");
204 void InspIRCd::WritePID(const std::string &filename)
206 std::ofstream outfile(filename.c_str());
207 if (outfile.is_open())
214 printf("Failed to write PID-file '%s', exiting.\n",filename.c_str());
215 log(DEFAULT,"Failed to write PID-file '%s', exiting.",filename.c_str());
220 std::string InspIRCd::GetRevision()
225 void InspIRCd::MakeLowerMap()
227 // initialize the lowercase mapping table
228 for (unsigned int cn = 0; cn < 256; cn++)
230 // lowercase the uppercase chars
231 for (unsigned int cn = 65; cn < 91; cn++)
232 lowermap[cn] = tolower(cn);
233 // now replace the specific chars for scandanavian comparison
234 lowermap[(unsigned)'['] = '{';
235 lowermap[(unsigned)']'] = '}';
236 lowermap[(unsigned)'\\'] = '|';
239 InspIRCd::InspIRCd(int argc, char** argv)
242 module_sockets.clear();
244 this->startup_time = time(NULL);
246 log(DEBUG,"*** InspIRCd starting up!");
247 if (!FileExists(CONFIG_FILE))
249 printf("ERROR: Cannot open config file: %s\nExiting...\n",CONFIG_FILE);
250 log(DEFAULT,"main: no config");
251 printf("ERROR: Your config file is missing, this IRCd will self destruct in 10 seconds!\n");
256 for (int i = 1; i < argc; i++)
258 if (!strcmp(argv[i],"-nofork"))
260 Config->nofork = true;
262 else if(!strcmp(argv[i],"-debug"))
264 Config->forcedebug = true;
266 else if(!strcmp(argv[i],"-nolog"))
268 Config->writelog = false;
270 else if (!strcmp(argv[i],"-wait"))
274 else if (!strcmp(argv[i],"-nolimit"))
276 printf("WARNING: The `-nolimit' option is deprecated, and now on by default. This behaviour may change in the future.\n");
278 else if (!strcmp(argv[i],"-logfile"))
282 strlcpy(LOG_FILE,argv[i+1],MAXBUF);
283 printf("LOG: Setting logfile to %s\n",LOG_FILE);
287 printf("ERROR: The -logfile parameter must be followed by a log file name and path.\n");
294 strlcpy(Config->MyExecutable,argv[0],MAXBUF);
296 this->MakeLowerMap();
299 this->stats = new serverstats();
300 Config->ClearStack();
301 Config->Read(true,NULL);
303 this->ModeGrok = new ModeParser();
304 this->Parser = new CommandParser();
305 AddServerName(Config->ServerName);
307 stats->BoundPortCount = BindPorts(true);
309 for(int t = 0; t < 255; t++)
310 Config->global_implementation[t] = 0;
312 memset(&Config->implement_lists,0,sizeof(Config->implement_lists));
318 if (!this->DaemonSeed())
320 printf("ERROR: could not go into daemon mode. Shutting down.\n");
325 /* Because of limitations in kqueue on freebsd, we must fork BEFORE we
326 * initialize the socket engine.
328 SE = new SocketEngine();
330 /* We must load the modules AFTER initializing the socket engine, now */
335 std::string InspIRCd::GetVersionString()
337 char versiondata[MAXBUF];
339 char dnsengine[] = "multithread";
341 char dnsengine[] = "singlethread";
343 if (*Config->CustomVersion)
345 snprintf(versiondata,MAXBUF,"%s %s :%s",VERSION,Config->ServerName,Config->CustomVersion);
349 snprintf(versiondata,MAXBUF,"%s %s :%s [FLAGS=%lu,%s,%s]",VERSION,Config->ServerName,SYSTEM,(unsigned long)OPTIMISATION,SE->GetName().c_str(),dnsengine);
354 char* InspIRCd::ModuleError()
359 void InspIRCd::EraseFactory(int j)
362 for (std::vector<ircd_module*>::iterator t = factory.begin(); t != factory.end(); t++)
367 factory.push_back(NULL);
374 void InspIRCd::EraseModule(int j)
377 for (std::vector<Module*>::iterator m = modules.begin(); m!= modules.end(); m++)
383 modules.push_back(NULL);
389 for (std::vector<std::string>::iterator v = Config->module_names.begin(); v != Config->module_names.end(); v++)
393 Config->module_names.erase(v);
401 void InspIRCd::MoveTo(std::string modulename,int slot)
403 unsigned int v2 = 256;
404 for (unsigned int v = 0; v < Config->module_names.size(); v++)
406 if (Config->module_names[v] == modulename)
408 // found an instance, swap it with the item at MODCOUNT
413 if ((v2 != (unsigned int)slot) && (v2 < 256))
415 // Swap the module names over
416 Config->module_names[v2] = Config->module_names[slot];
417 Config->module_names[slot] = modulename;
418 // now swap the module factories
419 ircd_module* temp = factory[v2];
420 factory[v2] = factory[slot];
421 factory[slot] = temp;
422 // now swap the module objects
423 Module* temp_module = modules[v2];
424 modules[v2] = modules[slot];
425 modules[slot] = temp_module;
426 // now swap the implement lists (we dont
427 // need to swap the global or recount it)
428 for (int n = 0; n < 255; n++)
430 char x = Config->implement_lists[v2][n];
431 Config->implement_lists[v2][n] = Config->implement_lists[slot][n];
432 Config->implement_lists[slot][n] = x;
437 log(DEBUG,"Move of %s to slot failed!",modulename.c_str());
441 void InspIRCd::MoveAfter(std::string modulename, std::string after)
443 for (unsigned int v = 0; v < Config->module_names.size(); v++)
445 if (Config->module_names[v] == after)
447 MoveTo(modulename, v);
453 void InspIRCd::MoveBefore(std::string modulename, std::string before)
455 for (unsigned int v = 0; v < Config->module_names.size(); v++)
457 if (Config->module_names[v] == before)
461 MoveTo(modulename, v-1);
465 MoveTo(modulename, v);
472 void InspIRCd::MoveToFirst(std::string modulename)
474 MoveTo(modulename,0);
477 void InspIRCd::MoveToLast(std::string modulename)
479 MoveTo(modulename,MODCOUNT);
482 void InspIRCd::BuildISupport()
484 // the neatest way to construct the initial 005 numeric, considering the number of configure constants to go in it...
486 v << "WALLCHOPS WALLVOICES MODES=" << MAXMODES << " CHANTYPES=# PREFIX=(ohv)@%+ MAP MAXCHANNELS=" << MAXCHANS << " MAXBANS=60 VBANLIST NICKLEN=" << NICKMAX-1;
487 v << " CASEMAPPING=rfc1459 STATUSMSG=@%+ CHARSET=ascii TOPICLEN=" << MAXTOPIC << " KICKLEN=" << MAXKICK << " MAXTARGETS=" << Config->MaxTargets << " AWAYLEN=";
488 v << MAXAWAY << " CHANMODES=b,k,l,psmnti FNC NETWORK=" << Config->Network << " MAXPARA=32";
489 Config->data005 = v.str();
490 FOREACH_MOD(I_On005Numeric,On005Numeric(Config->data005));
493 bool InspIRCd::UnloadModule(const char* filename)
495 std::string filename_str = filename;
496 for (unsigned int j = 0; j != Config->module_names.size(); j++)
498 if (Config->module_names[j] == filename_str)
500 if (modules[j]->GetVersion().Flags & VF_STATIC)
502 log(DEFAULT,"Failed to unload STATIC module %s",filename);
503 snprintf(MODERR,MAXBUF,"Module not unloadable (marked static)");
506 /* Give the module a chance to tidy out all its metadata */
507 for (chan_hash::iterator c = chanlist.begin(); c != chanlist.end(); c++)
509 modules[j]->OnCleanup(TYPE_CHANNEL,c->second);
511 for (user_hash::iterator u = clientlist.begin(); u != clientlist.end(); u++)
513 modules[j]->OnCleanup(TYPE_USER,u->second);
516 FOREACH_MOD(I_OnUnloadModule,OnUnloadModule(modules[j],Config->module_names[j]));
518 for(int t = 0; t < 255; t++)
520 Config->global_implementation[t] -= Config->implement_lists[j][t];
523 /* We have to renumber implement_lists after unload because the module numbers change!
525 for(int j2 = j; j2 < 254; j2++)
527 for(int t = 0; t < 255; t++)
529 Config->implement_lists[j2][t] = Config->implement_lists[j2+1][t];
534 log(DEBUG,"Deleting module...");
535 this->EraseModule(j);
536 log(DEBUG,"Erasing module entry...");
537 this->EraseFactory(j);
538 log(DEBUG,"Removing dependent commands...");
539 Parser->RemoveCommands(filename);
540 log(DEFAULT,"Module %s unloaded",filename);
546 log(DEFAULT,"Module %s is not loaded, cannot unload it!",filename);
547 snprintf(MODERR,MAXBUF,"Module not loaded");
551 bool InspIRCd::LoadModule(const char* filename)
553 char modfile[MAXBUF];
555 strlcpy(modfile,filename,MAXBUF);
557 snprintf(modfile,MAXBUF,"%s/%s",Config->ModPath,filename);
559 std::string filename_str = filename;
562 if (!DirValid(modfile))
564 log(DEFAULT,"Module %s is not within the modules directory.",modfile);
565 snprintf(MODERR,MAXBUF,"Module %s is not within the modules directory.",modfile);
570 log(DEBUG,"Loading module: %s",modfile);
572 if (FileExists(modfile))
575 for (unsigned int j = 0; j < Config->module_names.size(); j++)
577 if (Config->module_names[j] == filename_str)
579 log(DEFAULT,"Module %s is already loaded, cannot load a module twice!",modfile);
580 snprintf(MODERR,MAXBUF,"Module already loaded");
584 ircd_module* a = new ircd_module(modfile);
585 factory[MODCOUNT+1] = a;
586 if (factory[MODCOUNT+1]->LastError())
588 log(DEFAULT,"Unable to load %s: %s",modfile,factory[MODCOUNT+1]->LastError());
589 snprintf(MODERR,MAXBUF,"Loader/Linker error: %s",factory[MODCOUNT+1]->LastError());
594 if (factory[MODCOUNT+1]->factory)
596 Module* m = factory[MODCOUNT+1]->factory->CreateModule(MyServer);
597 modules[MODCOUNT+1] = m;
598 /* save the module and the module's classfactory, if
599 * this isnt done, random crashes can occur :/ */
600 Config->module_names.push_back(filename);
602 char* x = &Config->implement_lists[MODCOUNT+1][0];
603 for(int t = 0; t < 255; t++)
606 modules[MODCOUNT+1]->Implements(x);
608 for(int t = 0; t < 255; t++)
609 Config->global_implementation[t] += Config->implement_lists[MODCOUNT+1][t];
613 log(DEFAULT,"Unable to load %s",modfile);
614 snprintf(MODERR,MAXBUF,"Factory function failed!");
618 catch (ModuleException& modexcept)
620 log(DEFAULT,"Unable to load %s: ",modfile,modexcept.GetReason());
621 snprintf(MODERR,MAXBUF,"Factory function threw an exception: %s",modexcept.GetReason());
628 log(DEFAULT,"InspIRCd: startup: Module Not Found %s",modfile);
629 snprintf(MODERR,MAXBUF,"Module file could not be found");
634 FOREACH_MOD(I_OnLoadModule,OnLoadModule(modules[MODCOUNT],filename_str));
635 // now work out which modules, if any, want to move to the back of the queue,
636 // and if they do, move them there.
637 std::vector<std::string> put_to_back;
638 std::vector<std::string> put_to_front;
639 std::map<std::string,std::string> put_before;
640 std::map<std::string,std::string> put_after;
641 for (unsigned int j = 0; j < Config->module_names.size(); j++)
643 if (modules[j]->Prioritize() == PRIORITY_LAST)
645 put_to_back.push_back(Config->module_names[j]);
647 else if (modules[j]->Prioritize() == PRIORITY_FIRST)
649 put_to_front.push_back(Config->module_names[j]);
651 else if ((modules[j]->Prioritize() & 0xFF) == PRIORITY_BEFORE)
653 put_before[Config->module_names[j]] = Config->module_names[modules[j]->Prioritize() >> 8];
655 else if ((modules[j]->Prioritize() & 0xFF) == PRIORITY_AFTER)
657 put_after[Config->module_names[j]] = Config->module_names[modules[j]->Prioritize() >> 8];
660 for (unsigned int j = 0; j < put_to_back.size(); j++)
662 MoveToLast(put_to_back[j]);
664 for (unsigned int j = 0; j < put_to_front.size(); j++)
666 MoveToFirst(put_to_front[j]);
668 for (std::map<std::string,std::string>::iterator j = put_before.begin(); j != put_before.end(); j++)
670 MoveBefore(j->first,j->second);
672 for (std::map<std::string,std::string>::iterator j = put_after.begin(); j != put_after.end(); j++)
674 MoveAfter(j->first,j->second);
680 void InspIRCd::DoOneIteration(bool process_module_sockets)
682 int activefds[MAX_DESCRIPTORS];
686 InspSocket* s = NULL;
687 InspSocket* s_del = NULL;
688 unsigned int numberactive;
689 insp_sockaddr sock_us; // our port number
690 socklen_t uslen; // length of our port number
692 /* time() seems to be a pretty expensive syscall, so avoid calling it too much.
693 * Once per loop iteration is pleanty.
698 /* Run background module timers every few seconds
699 * (the docs say modules shouldnt rely on accurate
700 * timing using this event, so we dont have to
701 * time this exactly).
703 if (((TIME % 5) == 0) && (!expire_run))
706 if (process_module_sockets)
708 /* Fix by brain - the addition of DoOneIteration means that this
709 * can end up getting called recursively in the following pattern:
711 * m_spanningtree DoPingChecks
712 * (server pings out and is squit)
713 * (squit causes call to DoOneIteration)
714 * DoOneIteration enters here
715 * calls DoBackground timer
716 * enters m_spanningtree DoPingChecks... see step 1.
718 * This should do the job and fix the bug.
720 FOREACH_MOD(I_OnBackgroundTimer,OnBackgroundTimer(TIME));
722 TickMissedTimers(TIME);
726 else if ((TIME % 5) == 1)
731 if (iterations++ == 15)
734 DoBackgroundUserStuff(TIME);
737 /* Once a second, do the background processing */
741 WriteOpers("*** \002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %d secs.",abs(OLDTIME-TIME));
742 if ((TIME % 3600) == 0)
744 MaintainWhoWas(TIME);
748 /* Process timeouts on module sockets each time around
749 * the loop. There shouldnt be many module sockets, at
750 * most, 20 or so, so this won't be much of a performance
753 if (process_module_sockets)
754 DoSocketTimeouts(TIME);
758 /* Call the socket engine to wait on the active
759 * file descriptors. The socket engine has everything's
760 * descriptors in its list... dns, modules, users,
761 * servers... so its nice and easy, just one call.
763 if (!(numberactive = SE->Wait(activefds)))
767 * Now process each of the fd's. For users, we have a fast
768 * lookup table which can find a user by file descriptor, so
769 * processing them by fd isnt expensive. If we have a lot of
770 * listening ports or module sockets though, things could get
773 log(DEBUG,"There are %d fd's to process.",numberactive);
775 for (unsigned int activefd = 0; activefd < numberactive; activefd++)
777 int socket_type = SE->GetType(activefds[activefd]);
782 log(DEBUG,"Type: X_ESTAB_CLIENT: fd=%d",activefds[activefd]);
783 cu = fd_ref_table[activefds[activefd]];
791 log(DEBUG,"Type: X_ESTAB_MODULE: fd=%d",activefds[activefd]);
793 if (!process_module_sockets)
796 /* Process module-owned sockets.
797 * Modules are encouraged to inherit their sockets from
798 * InspSocket so we can process them neatly like this.
800 s = socket_ref[activefds[activefd]];
802 if ((s) && (!s->Poll()))
804 log(DEBUG,"Socket poll returned false, close and bail");
805 SE->DelFd(s->GetFd());
806 socket_ref[activefds[activefd]] = NULL;
807 for (std::vector<InspSocket*>::iterator a = module_sockets.begin(); a < module_sockets.end(); a++)
810 if ((s_del) && (s_del->GetFd() == activefds[activefd]))
812 module_sockets.erase(a);
821 log(DEBUG,"WTF, X_ESTAB_MODULE for nonexistent InspSocket, removed!");
822 SE->DelFd(s->GetFd());
827 /* When we are using single-threaded dns,
828 * the sockets for dns end up in our mainloop.
829 * When we are using multi-threaded dns,
830 * each thread has its own basic poll() loop
831 * within it, making them 'fire and forget'
832 * and independent of the mainloop.
835 log(DEBUG,"Type: X_ESTAB_DNS: fd=%d",activefds[activefd]);
836 dns_poll(activefds[activefd]);
840 case X_ESTAB_CLASSDNS:
841 /* Handles instances of the Resolver class,
842 * a simple class extended by modules for
843 * nonblocking resolving of addresses.
846 dns_deal_with_classes(activefds[activefd]);
851 log(DEBUG,"Type: X_LISTEN_MODULE: fd=%d",activefds[activefd]);
853 /* It's a listener */
854 uslen = sizeof(sock_us);
855 length = sizeof(client);
856 incomingSockfd = accept (activefds[activefd],(struct sockaddr*)&client,&length);
858 if ((incomingSockfd > -1) && (!getsockname(incomingSockfd,(sockaddr*)&sock_us,&uslen)))
860 in_port = ntohs(sock_us.sin_port);
861 log(DEBUG,"Accepted socket %d",incomingSockfd);
862 /* Years and years ago, we used to resolve here
863 * using gethostbyaddr(). That is sucky and we
864 * don't do that any more...
866 NonBlocking(incomingSockfd);
867 if (Config->GetIOHook(in_port))
871 Config->GetIOHook(in_port)->OnRawSocketAccept(incomingSockfd, inet_ntoa(client.sin_addr), in_port);
873 catch (ModuleException& modexcept)
875 log(DEBUG,"Module exception cought: %s",modexcept.GetReason());
878 stats->statsAccept++;
879 AddClient(incomingSockfd, in_port, false, client.sin_addr);
880 log(DEBUG,"Adding client on port %lu fd=%lu",(unsigned long)in_port,(unsigned long)incomingSockfd);
884 log(DEBUG,"Accept failed on fd %lu: %s",(unsigned long)incomingSockfd,strerror(errno));
885 shutdown(incomingSockfd,2);
886 close(incomingSockfd);
887 stats->statsRefused++;
892 /* Something went wrong if we're in here.
893 * In fact, so wrong, im not quite sure
894 * what we would do, so for now, its going
895 * to safely do bugger all.
897 log(DEBUG,"Type: X_WHAT_THE_FUCK_BBQ: fd=%d",activefds[activefd]);
898 SE->DelFd(activefds[activefd]);
906 /* Until THIS point, ServerInstance == NULL */
908 LoadAllModules(this);
910 /* Just in case no modules were loaded - fix for bug #101 */
911 this->BuildISupport();
913 printf("\nInspIRCd is now running!\n");
922 /* Add the listening sockets used for client inbound connections
923 * to the socket engine
925 for (int count = 0; count < stats->BoundPortCount; count++)
926 SE->AddFd(Config->openSockfd[count],true,X_LISTEN);
928 this->WritePID(Config->PID);
930 /* main loop, this never returns */
936 DoOneIteration(true);
938 /* This is never reached -- we hope! */
942 /**********************************************************************************/
945 * An ircd in four lines! bwahahaha. ahahahahaha. ahahah *cough*.
948 int main(int argc, char** argv)
952 ServerInstance = new InspIRCd(argc, argv);
953 ServerInstance->Run();
954 DELETE(ServerInstance);
956 catch (std::bad_alloc)
958 log(DEFAULT,"You are out of memory! (got exception std::bad_alloc!)");
959 send_error("**** OUT OF MEMORY **** We're gonna need a bigger boat!");
960 printf("Out of memory! (got exception std::bad_alloc!");