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 "configreader.h"
38 #include "socketengine.h"
39 #include "inspircd_se_config.h"
42 #include "command_parse.h"
45 using irc::sockets::NonBlocking;
46 using irc::sockets::Blocking;
47 using irc::sockets::insp_ntoa;
48 using irc::sockets::insp_inaddr;
49 using irc::sockets::insp_sockaddr;
53 void InspIRCd::AddServerName(const std::string &servername)
55 this->Log(DEBUG,"Adding server name: %s",servername.c_str());
57 if(find(servernames.begin(), servernames.end(), servername) == servernames.end())
58 servernames.push_back(servername); /* Wasn't already there. */
61 const char* InspIRCd::FindServerNamePtr(const std::string &servername)
63 servernamelist::iterator iter = find(servernames.begin(), servernames.end(), servername);
65 if(iter == servernames.end())
67 AddServerName(servername);
68 iter = --servernames.end();
74 bool InspIRCd::FindServerName(const std::string &servername)
76 return (find(servernames.begin(), servernames.end(), servername) != servernames.end());
79 void InspIRCd::Exit(int status)
84 void InspIRCd::Start()
86 printf("\033[1;32mInspire Internet Relay Chat Server, compiled %s at %s\n",__DATE__,__TIME__);
87 printf("(C) ChatSpike Development team.\033[0m\n\n");
88 printf("Developers:\t\t\033[1;32mBrain, FrostyCoolSlug, w00t, Om, Special, pippijn, jamie\033[0m\n");
89 printf("Others:\t\t\t\033[1;32mSee /INFO Output\033[0m\n");
90 printf("Name concept:\t\t\033[1;32mLord_Zathras\033[0m\n\n");
93 void InspIRCd::Rehash(int status)
95 SI->WriteOpers("Rehashing config file %s due to SIGHUP",ServerConfig::CleanFilename(CONFIG_FILE));
96 fclose(SI->Config->log_file);
98 SI->Config->Read(false,NULL);
99 FOREACH_MOD_I(SI,I_OnRehash,OnRehash(""));
102 void InspIRCd::SetSignals()
104 signal(SIGALRM, SIG_IGN);
105 signal(SIGHUP, InspIRCd::Rehash);
106 signal(SIGPIPE, SIG_IGN);
107 signal(SIGTERM, InspIRCd::Exit);
108 signal(SIGCHLD, SIG_IGN);
111 bool InspIRCd::DaemonSeed()
114 if ((childpid = fork ()) < 0)
116 else if (childpid > 0)
118 /* We wait here for the child process to kill us,
119 * so that the shell prompt doesnt come back over
121 * Sending a kill with a signal of 0 just checks
122 * if the child pid is still around. If theyre not,
123 * they threw an error and we should give up.
125 while (kill(childpid, 0) != -1)
131 printf("InspIRCd Process ID: \033[1;32m%lu\033[0m\n",(unsigned long)getpid());
134 if (getrlimit(RLIMIT_CORE, &rl) == -1)
136 this->Log(DEFAULT,"Failed to getrlimit()!");
141 rl.rlim_cur = rl.rlim_max;
142 if (setrlimit(RLIMIT_CORE, &rl) == -1)
143 this->Log(DEFAULT,"setrlimit() failed, cannot increase coredump size.");
149 void InspIRCd::WritePID(const std::string &filename)
151 std::ofstream outfile(filename.c_str());
152 if (outfile.is_open())
159 printf("Failed to write PID-file '%s', exiting.\n",filename.c_str());
160 this->Log(DEFAULT,"Failed to write PID-file '%s', exiting.",filename.c_str());
165 std::string InspIRCd::GetRevision()
170 InspIRCd::InspIRCd(int argc, char** argv)
171 : ModCount(-1), duration_m(60), duration_h(60*60), duration_d(60*60*24), duration_w(60*60*24*7), duration_y(60*60*24*365)
176 this->Config = new ServerConfig(this);
177 this->SNO = new SnomaskManager(this);
179 this->TIME = this->OLDTIME = this->startup_time = time(NULL);
181 this->Log(DEBUG,"*** InspIRCd starting up!");
182 if (!ServerConfig::FileExists(CONFIG_FILE))
184 printf("ERROR: Cannot open config file: %s\nExiting...\n",CONFIG_FILE);
185 this->Log(DEFAULT,"main: no config");
186 printf("ERROR: Your config file is missing, this IRCd will self destruct in 10 seconds!\n");
189 *this->LogFileName = 0;
191 for (int i = 1; i < argc; i++)
193 if (!strcmp(argv[i],"-nofork"))
195 Config->nofork = true;
197 else if(!strcmp(argv[i],"-debug"))
199 Config->forcedebug = true;
201 else if(!strcmp(argv[i],"-nolog"))
203 Config->writelog = false;
205 else if (!strcmp(argv[i],"-wait"))
209 else if (!strcmp(argv[i],"-logfile"))
213 strlcpy(LogFileName,argv[i+1],MAXBUF);
214 printf("LOG: Setting logfile to %s\n",LogFileName);
218 printf("ERROR: The -logfile parameter must be followed by a log file name and path.\n");
225 printf("Usage: %s [-nofork] [-nolog] [-debug] [-wait] [-logfile <filename>]\n",argv[0]);
231 strlcpy(Config->MyExecutable,argv[0],MAXBUF);
233 this->OpenLog(argv, argc);
234 this->stats = new serverstats();
235 this->Parser = new CommandParser(this);
236 this->Timers = new TimerManager();
237 this->XLines = new XLineManager(this);
238 Config->ClearStack();
239 Config->Read(true, NULL);
241 this->Modes = new ModeParser(this);
242 this->AddServerName(Config->ServerName);
244 InitializeDisabledCommands(Config->DisabledCommands, this);
245 stats->BoundPortCount = BindPorts(true);
247 for(int t = 0; t < 255; t++)
248 Config->global_implementation[t] = 0;
250 memset(&Config->implement_lists,0,sizeof(Config->implement_lists));
256 if (!this->DaemonSeed())
258 printf("ERROR: could not go into daemon mode. Shutting down.\n");
263 /* Because of limitations in kqueue on freebsd, we must fork BEFORE we
264 * initialize the socket engine.
266 SocketEngineFactory* SEF = new SocketEngineFactory();
267 SE = SEF->Create(this);
270 this->Res = new DNS(this);
272 this->LoadAllModules();
273 /* Just in case no modules were loaded - fix for bug #101 */
274 this->BuildISupport();
276 if (!stats->BoundPortCount)
278 printf("\nERROR: I couldn't bind any ports! Are you sure you didn't start InspIRCd twice?\n");
282 /* Add the listening sockets used for client inbound connections
283 * to the socket engine
285 this->Log(DEBUG,"%d listeners",stats->BoundPortCount);
286 for (unsigned long count = 0; count < stats->BoundPortCount; count++)
288 this->Log(DEBUG,"Add listener: %d",Config->openSockfd[count]->GetFd());
289 if (!SE->AddFd(Config->openSockfd[count]))
291 printf("\nEH? Could not add listener to socketengine. You screwed up, aborting.\n");
298 if (kill(getppid(), SIGTERM) == -1)
299 printf("Error killing parent process: %s\n",strerror(errno));
305 printf("\nInspIRCd is now running!\n");
307 this->WritePID(Config->PID);
310 std::string InspIRCd::GetVersionString()
312 char versiondata[MAXBUF];
313 char dnsengine[] = "singlethread-object";
314 if (*Config->CustomVersion)
316 snprintf(versiondata,MAXBUF,"%s %s :%s",VERSION,Config->ServerName,Config->CustomVersion);
320 snprintf(versiondata,MAXBUF,"%s %s :%s [FLAGS=%lu,%s,%s]",VERSION,Config->ServerName,SYSTEM,(unsigned long)OPTIMISATION,SE->GetName().c_str(),dnsengine);
325 char* InspIRCd::ModuleError()
330 void InspIRCd::EraseFactory(int j)
333 for (std::vector<ircd_module*>::iterator t = factory.begin(); t != factory.end(); t++)
339 factory.push_back(NULL);
346 void InspIRCd::EraseModule(int j)
349 for (ModuleList::iterator m = modules.begin(); m!= modules.end(); m++)
355 modules.push_back(NULL);
361 for (std::vector<std::string>::iterator v = Config->module_names.begin(); v != Config->module_names.end(); v++)
365 Config->module_names.erase(v);
373 void InspIRCd::MoveTo(std::string modulename,int slot)
375 unsigned int v2 = 256;
376 for (unsigned int v = 0; v < Config->module_names.size(); v++)
378 if (Config->module_names[v] == modulename)
380 // found an instance, swap it with the item at the end
385 if ((v2 != (unsigned int)slot) && (v2 < 256))
387 // Swap the module names over
388 Config->module_names[v2] = Config->module_names[slot];
389 Config->module_names[slot] = modulename;
390 // now swap the module factories
391 ircd_module* temp = factory[v2];
392 factory[v2] = factory[slot];
393 factory[slot] = temp;
394 // now swap the module objects
395 Module* temp_module = modules[v2];
396 modules[v2] = modules[slot];
397 modules[slot] = temp_module;
398 // now swap the implement lists (we dont
399 // need to swap the global or recount it)
400 for (int n = 0; n < 255; n++)
402 char x = Config->implement_lists[v2][n];
403 Config->implement_lists[v2][n] = Config->implement_lists[slot][n];
404 Config->implement_lists[slot][n] = x;
409 this->Log(DEBUG,"Move of %s to slot failed!",modulename.c_str());
413 void InspIRCd::MoveAfter(std::string modulename, std::string after)
415 for (unsigned int v = 0; v < Config->module_names.size(); v++)
417 if (Config->module_names[v] == after)
419 MoveTo(modulename, v);
425 void InspIRCd::MoveBefore(std::string modulename, std::string before)
427 for (unsigned int v = 0; v < Config->module_names.size(); v++)
429 if (Config->module_names[v] == before)
433 MoveTo(modulename, v-1);
437 MoveTo(modulename, v);
444 void InspIRCd::MoveToFirst(std::string modulename)
446 MoveTo(modulename,0);
449 void InspIRCd::MoveToLast(std::string modulename)
451 MoveTo(modulename,this->GetModuleCount());
454 void InspIRCd::BuildISupport()
456 // the neatest way to construct the initial 005 numeric, considering the number of configure constants to go in it...
458 v << "WALLCHOPS WALLVOICES MODES=" << MAXMODES << " CHANTYPES=# PREFIX=" << this->Modes->BuildPrefixes() << " MAP MAXCHANNELS=" << MAXCHANS << " MAXBANS=60 VBANLIST NICKLEN=" << NICKMAX-1;
459 v << " CASEMAPPING=rfc1459 STATUSMSG=@%+ CHARSET=ascii TOPICLEN=" << MAXTOPIC << " KICKLEN=" << MAXKICK << " MAXTARGETS=" << Config->MaxTargets << " AWAYLEN=";
460 v << MAXAWAY << " CHANMODES=" << this->Modes->ChanModes() << " FNC NETWORK=" << Config->Network << " MAXPARA=32";
461 Config->data005 = v.str();
462 FOREACH_MOD_I(this,I_On005Numeric,On005Numeric(Config->data005));
465 bool InspIRCd::UnloadModule(const char* filename)
467 std::string filename_str = filename;
468 for (unsigned int j = 0; j != Config->module_names.size(); j++)
470 if (Config->module_names[j] == filename_str)
472 if (modules[j]->GetVersion().Flags & VF_STATIC)
474 this->Log(DEFAULT,"Failed to unload STATIC module %s",filename);
475 snprintf(MODERR,MAXBUF,"Module not unloadable (marked static)");
478 /* Give the module a chance to tidy out all its metadata */
479 for (chan_hash::iterator c = this->chanlist.begin(); c != this->chanlist.end(); c++)
481 modules[j]->OnCleanup(TYPE_CHANNEL,c->second);
483 for (user_hash::iterator u = this->clientlist.begin(); u != this->clientlist.end(); u++)
485 modules[j]->OnCleanup(TYPE_USER,u->second);
488 FOREACH_MOD_I(this,I_OnUnloadModule,OnUnloadModule(modules[j],Config->module_names[j]));
490 for(int t = 0; t < 255; t++)
492 Config->global_implementation[t] -= Config->implement_lists[j][t];
495 /* We have to renumber implement_lists after unload because the module numbers change!
497 for(int j2 = j; j2 < 254; j2++)
499 for(int t = 0; t < 255; t++)
501 Config->implement_lists[j2][t] = Config->implement_lists[j2+1][t];
506 this->Log(DEBUG,"Removing dependent commands...");
507 Parser->RemoveCommands(filename);
508 this->Log(DEBUG,"Deleting module...");
509 this->EraseModule(j);
510 this->Log(DEBUG,"Erasing module entry...");
511 this->EraseFactory(j);
512 this->Log(DEFAULT,"Module %s unloaded",filename);
518 this->Log(DEFAULT,"Module %s is not loaded, cannot unload it!",filename);
519 snprintf(MODERR,MAXBUF,"Module not loaded");
523 bool InspIRCd::LoadModule(const char* filename)
525 char modfile[MAXBUF];
527 strlcpy(modfile,filename,MAXBUF);
529 snprintf(modfile,MAXBUF,"%s/%s",Config->ModPath,filename);
531 std::string filename_str = filename;
534 if (!ServerConfig::DirValid(modfile))
536 this->Log(DEFAULT,"Module %s is not within the modules directory.",modfile);
537 snprintf(MODERR,MAXBUF,"Module %s is not within the modules directory.",modfile);
542 this->Log(DEBUG,"Loading module: %s",modfile);
544 if (ServerConfig::FileExists(modfile))
547 for (unsigned int j = 0; j < Config->module_names.size(); j++)
549 if (Config->module_names[j] == filename_str)
551 this->Log(DEFAULT,"Module %s is already loaded, cannot load a module twice!",modfile);
552 snprintf(MODERR,MAXBUF,"Module already loaded");
558 ircd_module* a = new ircd_module(this, modfile);
559 factory[this->ModCount+1] = a;
560 if (factory[this->ModCount+1]->LastError())
562 this->Log(DEFAULT,"Unable to load %s: %s",modfile,factory[this->ModCount+1]->LastError());
563 snprintf(MODERR,MAXBUF,"Loader/Linker error: %s",factory[this->ModCount+1]->LastError());
566 if ((long)factory[this->ModCount+1]->factory != -1)
568 Module* m = factory[this->ModCount+1]->factory->CreateModule(this);
570 Version v = m->GetVersion();
572 if (v.API != API_VERSION)
576 this->Log(DEFAULT,"Unable to load %s: Incorrect module API version: %d (our version: %d)",modfile,v.API,API_VERSION);
577 snprintf(MODERR,MAXBUF,"Loader/Linker error: Incorrect module API version: %d (our version: %d)",v.API,API_VERSION);
581 modules[this->ModCount+1] = m;
582 /* save the module and the module's classfactory, if
583 * this isnt done, random crashes can occur :/ */
584 Config->module_names.push_back(filename);
586 char* x = &Config->implement_lists[this->ModCount+1][0];
587 for(int t = 0; t < 255; t++)
590 modules[this->ModCount+1]->Implements(x);
592 for(int t = 0; t < 255; t++)
593 Config->global_implementation[t] += Config->implement_lists[this->ModCount+1][t];
597 this->Log(DEFAULT,"Unable to load %s",modfile);
598 snprintf(MODERR,MAXBUF,"Factory function failed: Probably missing init_module() entrypoint.");
602 catch (ModuleException& modexcept)
604 this->Log(DEFAULT,"Unable to load %s: ",modfile,modexcept.GetReason());
605 snprintf(MODERR,MAXBUF,"Factory function threw an exception: %s",modexcept.GetReason());
612 this->Log(DEFAULT,"InspIRCd: startup: Module Not Found %s",modfile);
613 snprintf(MODERR,MAXBUF,"Module file could not be found");
618 FOREACH_MOD_I(this,I_OnLoadModule,OnLoadModule(modules[this->ModCount],filename_str));
619 // now work out which modules, if any, want to move to the back of the queue,
620 // and if they do, move them there.
621 std::vector<std::string> put_to_back;
622 std::vector<std::string> put_to_front;
623 std::map<std::string,std::string> put_before;
624 std::map<std::string,std::string> put_after;
625 for (unsigned int j = 0; j < Config->module_names.size(); j++)
627 if (modules[j]->Prioritize() == PRIORITY_LAST)
628 put_to_back.push_back(Config->module_names[j]);
629 else if (modules[j]->Prioritize() == PRIORITY_FIRST)
630 put_to_front.push_back(Config->module_names[j]);
631 else if ((modules[j]->Prioritize() & 0xFF) == PRIORITY_BEFORE)
632 put_before[Config->module_names[j]] = Config->module_names[modules[j]->Prioritize() >> 8];
633 else if ((modules[j]->Prioritize() & 0xFF) == PRIORITY_AFTER)
634 put_after[Config->module_names[j]] = Config->module_names[modules[j]->Prioritize() >> 8];
636 for (unsigned int j = 0; j < put_to_back.size(); j++)
637 MoveToLast(put_to_back[j]);
638 for (unsigned int j = 0; j < put_to_front.size(); j++)
639 MoveToFirst(put_to_front[j]);
640 for (std::map<std::string,std::string>::iterator j = put_before.begin(); j != put_before.end(); j++)
641 MoveBefore(j->first,j->second);
642 for (std::map<std::string,std::string>::iterator j = put_after.begin(); j != put_after.end(); j++)
643 MoveAfter(j->first,j->second);
648 void InspIRCd::DoOneIteration(bool process_module_sockets)
650 /* time() seems to be a pretty expensive syscall, so avoid calling it too much.
651 * Once per loop iteration is pleanty.
656 /* Run background module timers every few seconds
657 * (the docs say modules shouldnt rely on accurate
658 * timing using this event, so we dont have to
659 * time this exactly).
664 WriteOpers("*** \002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %d secs.",abs(OLDTIME-TIME));
665 if ((TIME % 3600) == 0)
667 irc::whowas::MaintainWhoWas(this, TIME);
669 Timers->TickTimers(TIME);
670 this->DoBackgroundUserStuff(TIME);
674 XLines->expire_lines();
675 FOREACH_MOD_I(this,I_OnBackgroundTimer,OnBackgroundTimer(TIME));
676 Timers->TickMissedTimers(TIME);
680 /* Call the socket engine to wait on the active
681 * file descriptors. The socket engine has everything's
682 * descriptors in its list... dns, modules, users,
683 * servers... so its nice and easy, just one call.
684 * This will cause any read or write events to be
685 * dispatched to their handlers.
687 SE->DispatchEvents();
690 bool InspIRCd::IsIdent(const char* n)
695 for (char* i = (char*)n; *i; i++)
697 if ((*i >= 'A') && (*i <= '}'))
701 if (((*i >= '0') && (*i <= '9')) || (*i == '-') || (*i == '.'))
715 DoOneIteration(true);
717 /* This is never reached -- we hope! */
721 /**********************************************************************************/
724 * An ircd in four lines! bwahahaha. ahahahahaha. ahahah *cough*.
727 int main(int argc, char** argv)
729 SI = new InspIRCd(argc, argv);
735 /* this returns true when all modules are satisfied that the user should be allowed onto the irc server
736 * (until this returns true, a user will block in the waiting state, waiting to connect up to the
737 * registration timeout maximum seconds)
739 bool InspIRCd::AllModulesReportReady(userrec* user)
741 if (!Config->global_implementation[I_OnCheckReady])
744 for (int i = 0; i <= this->GetModuleCount(); i++)
746 if (Config->implement_lists[i][I_OnCheckReady])
748 int res = modules[i]->OnCheckReady(user);
756 int InspIRCd::GetModuleCount()
758 return this->ModCount;
761 time_t InspIRCd::Time()
766 bool FileLogger::Readable()
771 void FileLogger::HandleEvent(EventType et)
773 this->WriteLogLine("");
774 ServerInstance->SE->DelFd(this);
777 void FileLogger::WriteLogLine(const std::string &line)
784 int written = fprintf(log,"%s",buffer.c_str());
785 if ((written >= 0) && (written < (int)buffer.length()))
787 buffer.erase(0, buffer.length());
788 ServerInstance->SE->AddFd(this);
790 else if (written == -1)
793 ServerInstance->SE->AddFd(this);
797 /* Wrote the whole buffer, and no need for write callback */
807 void FileLogger::Close()
811 int flags = fcntl(fileno(log), F_GETFL, 0);
812 fcntl(fileno(log), F_SETFL, flags ^ O_NONBLOCK);
814 fprintf(log,"%s",buffer.c_str());
819 ServerInstance->SE->DelFd(this);
822 FileLogger::FileLogger(InspIRCd* Instance, FILE* logfile) : ServerInstance(Instance), log(logfile), writeops(0)
824 irc::sockets::NonBlocking(fileno(log));
825 this->SetFd(fileno(log));
829 FileLogger::~FileLogger()