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"
39 #include "socketengine.h"
40 #include "inspircd_se_config.h"
43 #include "command_parse.h"
46 using irc::sockets::NonBlocking;
47 using irc::sockets::Blocking;
48 using irc::sockets::insp_ntoa;
49 using irc::sockets::insp_inaddr;
50 using irc::sockets::insp_sockaddr;
54 void InspIRCd::AddServerName(const std::string &servername)
56 this->Log(DEBUG,"Adding server name: %s",servername.c_str());
58 if(find(servernames.begin(), servernames.end(), servername) == servernames.end())
59 servernames.push_back(servername); /* Wasn't already there. */
62 const char* InspIRCd::FindServerNamePtr(const std::string &servername)
64 servernamelist::iterator iter = find(servernames.begin(), servernames.end(), servername);
66 if(iter == servernames.end())
68 AddServerName(servername);
69 iter = --servernames.end();
75 bool InspIRCd::FindServerName(const std::string &servername)
77 return (find(servernames.begin(), servernames.end(), servername) != servernames.end());
80 void InspIRCd::Exit(int status)
85 void InspIRCd::Start()
87 printf("\033[1;32mInspire Internet Relay Chat Server, compiled %s at %s\n",__DATE__,__TIME__);
88 printf("(C) ChatSpike Development team.\033[0m\n\n");
89 printf("Developers:\t\t\033[1;32mBrain, FrostyCoolSlug, w00t, Om, Special, pippijn, peavey\033[0m\n");
90 printf("Others:\t\t\t\033[1;32mSee /INFO Output\033[0m\n");
91 printf("Name concept:\t\t\033[1;32mLord_Zathras\033[0m\n\n");
94 void InspIRCd::Rehash(int status)
96 SI->WriteOpers("Rehashing config file %s due to SIGHUP",ServerConfig::CleanFilename(CONFIG_FILE));
97 fclose(SI->Config->log_file);
99 SI->Config->Read(false,NULL);
100 FOREACH_MOD_I(SI,I_OnRehash,OnRehash(""));
103 void InspIRCd::SetSignals()
105 signal(SIGALRM, SIG_IGN);
106 signal(SIGHUP, InspIRCd::Rehash);
107 signal(SIGPIPE, SIG_IGN);
108 signal(SIGTERM, InspIRCd::Exit);
109 signal(SIGCHLD, SIG_IGN);
112 bool InspIRCd::DaemonSeed()
115 if ((childpid = fork ()) < 0)
117 else if (childpid > 0)
119 /* We wait here for the child process to kill us,
120 * so that the shell prompt doesnt come back over
122 * Sending a kill with a signal of 0 just checks
123 * if the child pid is still around. If theyre not,
124 * they threw an error and we should give up.
126 while (kill(childpid, 0) != -1)
132 printf("InspIRCd Process ID: \033[1;32m%lu\033[0m\n",(unsigned long)getpid());
135 if (getrlimit(RLIMIT_CORE, &rl) == -1)
137 this->Log(DEFAULT,"Failed to getrlimit()!");
142 rl.rlim_cur = rl.rlim_max;
143 if (setrlimit(RLIMIT_CORE, &rl) == -1)
144 this->Log(DEFAULT,"setrlimit() failed, cannot increase coredump size.");
150 void InspIRCd::WritePID(const std::string &filename)
152 std::string fname = (filename.empty() ? "inspircd.pid" : filename);
153 if (*(fname.begin()) != '/')
155 std::string::size_type pos;
156 std::string confpath = CONFIG_FILE;
157 if ((pos = confpath.find("/inspircd.conf")) != std::string::npos)
159 /* Leaves us with just the path */
160 fname = confpath.substr(0, pos) + std::string("/") + fname;
163 std::ofstream outfile(fname.c_str());
164 if (outfile.is_open())
171 printf("Failed to write PID-file '%s', exiting.\n",fname.c_str());
172 this->Log(DEFAULT,"Failed to write PID-file '%s', exiting.",fname.c_str());
177 std::string InspIRCd::GetRevision()
182 InspIRCd::InspIRCd(int argc, char** argv)
183 : 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)
190 this->Config = new ServerConfig(this);
191 this->Config->opertypes.clear();
192 this->Config->operclass.clear();
193 this->SNO = new SnomaskManager(this);
195 this->TIME = this->OLDTIME = this->startup_time = time(NULL);
196 this->time_delta = 0;
197 this->next_call = this->TIME + 3;
199 this->Log(DEBUG,"*** InspIRCd starting up!");
200 if (!ServerConfig::FileExists(CONFIG_FILE))
202 printf("ERROR: Cannot open config file: %s\nExiting...\n",CONFIG_FILE);
203 this->Log(DEFAULT,"main: no config");
204 printf("ERROR: Your config file is missing, this IRCd will self destruct in 10 seconds!\n");
207 *this->LogFileName = 0;
209 for (int i = 1; i < argc; i++)
211 if (!strcmp(argv[i],"-nofork"))
213 Config->nofork = true;
215 else if(!strcmp(argv[i],"-debug"))
217 Config->forcedebug = true;
219 else if(!strcmp(argv[i],"-nolog"))
221 Config->writelog = false;
223 else if (!strcmp(argv[i],"-wait"))
227 else if (!strcmp(argv[i],"-logfile"))
231 strlcpy(LogFileName,argv[i+1],MAXBUF);
232 printf("LOG: Setting logfile to %s\n",LogFileName);
236 printf("ERROR: The -logfile parameter must be followed by a log file name and path.\n");
243 printf("Usage: %s [-nofork] [-nolog] [-debug] [-wait] [-logfile <filename>]\n",argv[0]);
249 strlcpy(Config->MyExecutable,argv[0],MAXBUF);
251 this->OpenLog(argv, argc);
252 this->stats = new serverstats();
253 this->Parser = new CommandParser(this);
254 this->Timers = new TimerManager();
255 this->XLines = new XLineManager(this);
256 Config->ClearStack();
257 Config->Read(true, NULL);
259 this->Modes = new ModeParser(this);
260 this->AddServerName(Config->ServerName);
262 InitializeDisabledCommands(Config->DisabledCommands, this);
263 stats->BoundPortCount = BindPorts(true, found_ports);
265 for(int t = 0; t < 255; t++)
266 Config->global_implementation[t] = 0;
268 memset(&Config->implement_lists,0,sizeof(Config->implement_lists));
274 if (!this->DaemonSeed())
276 printf("ERROR: could not go into daemon mode. Shutting down.\n");
281 /* Because of limitations in kqueue on freebsd, we must fork BEFORE we
282 * initialize the socket engine.
284 SocketEngineFactory* SEF = new SocketEngineFactory();
285 SE = SEF->Create(this);
288 this->Res = new DNS(this);
290 this->LoadAllModules();
291 /* Just in case no modules were loaded - fix for bug #101 */
292 this->BuildISupport();
294 if ((stats->BoundPortCount == 0) && (found_ports > 0))
296 printf("\nERROR: I couldn't bind any ports! Are you sure you didn't start InspIRCd twice?\n");
300 if (stats->BoundPortCount != (unsigned int)found_ports)
302 printf("\nWARNING: Not all your client ports could be bound --\n starting anyway with %ld of %d client ports bound.\n", stats->BoundPortCount, found_ports);
305 /* Add the listening sockets used for client inbound connections
306 * to the socket engine
308 this->Log(DEBUG,"%d listeners",stats->BoundPortCount);
309 for (unsigned long count = 0; count < stats->BoundPortCount; count++)
311 this->Log(DEBUG,"Add listener: %d",Config->openSockfd[count]->GetFd());
312 if (!SE->AddFd(Config->openSockfd[count]))
314 printf("\nEH? Could not add listener to socketengine. You screwed up, aborting.\n");
321 if (kill(getppid(), SIGTERM) == -1)
322 printf("Error killing parent process: %s\n",strerror(errno));
328 printf("\nInspIRCd is now running!\n");
330 this->WritePID(Config->PID);
333 std::string InspIRCd::GetVersionString()
335 char versiondata[MAXBUF];
336 char dnsengine[] = "singlethread-object";
337 if (*Config->CustomVersion)
339 snprintf(versiondata,MAXBUF,"%s %s :%s",VERSION,Config->ServerName,Config->CustomVersion);
343 snprintf(versiondata,MAXBUF,"%s %s :%s [FLAGS=%lu,%s,%s]",VERSION,Config->ServerName,SYSTEM,(unsigned long)OPTIMISATION,SE->GetName().c_str(),dnsengine);
348 char* InspIRCd::ModuleError()
353 void InspIRCd::EraseFactory(int j)
356 for (std::vector<ircd_module*>::iterator t = factory.begin(); t != factory.end(); t++)
362 factory.push_back(NULL);
369 void InspIRCd::EraseModule(int j)
372 for (ModuleList::iterator m = modules.begin(); m!= modules.end(); m++)
378 modules.push_back(NULL);
384 for (std::vector<std::string>::iterator v = Config->module_names.begin(); v != Config->module_names.end(); v++)
388 Config->module_names.erase(v);
396 void InspIRCd::MoveTo(std::string modulename,int slot)
398 unsigned int v2 = 256;
399 for (unsigned int v = 0; v < Config->module_names.size(); v++)
401 if (Config->module_names[v] == modulename)
403 // found an instance, swap it with the item at the end
408 if ((v2 != (unsigned int)slot) && (v2 < 256))
410 // Swap the module names over
411 Config->module_names[v2] = Config->module_names[slot];
412 Config->module_names[slot] = modulename;
413 // now swap the module factories
414 ircd_module* temp = factory[v2];
415 factory[v2] = factory[slot];
416 factory[slot] = temp;
417 // now swap the module objects
418 Module* temp_module = modules[v2];
419 modules[v2] = modules[slot];
420 modules[slot] = temp_module;
421 // now swap the implement lists (we dont
422 // need to swap the global or recount it)
423 for (int n = 0; n < 255; n++)
425 char x = Config->implement_lists[v2][n];
426 Config->implement_lists[v2][n] = Config->implement_lists[slot][n];
427 Config->implement_lists[slot][n] = x;
432 this->Log(DEBUG,"Move of %s to slot failed!",modulename.c_str());
436 void InspIRCd::MoveAfter(std::string modulename, std::string after)
438 for (unsigned int v = 0; v < Config->module_names.size(); v++)
440 if (Config->module_names[v] == after)
442 MoveTo(modulename, v);
448 void InspIRCd::MoveBefore(std::string modulename, std::string before)
450 for (unsigned int v = 0; v < Config->module_names.size(); v++)
452 if (Config->module_names[v] == before)
456 MoveTo(modulename, v-1);
460 MoveTo(modulename, v);
467 void InspIRCd::MoveToFirst(std::string modulename)
469 MoveTo(modulename,0);
472 void InspIRCd::MoveToLast(std::string modulename)
474 MoveTo(modulename,this->GetModuleCount());
477 void InspIRCd::BuildISupport()
479 // the neatest way to construct the initial 005 numeric, considering the number of configure constants to go in it...
481 v << "WALLCHOPS WALLVOICES MODES=" << MAXMODES << " CHANTYPES=# PREFIX=" << this->Modes->BuildPrefixes() << " MAP MAXCHANNELS=" << MAXCHANS << " MAXBANS=60 VBANLIST NICKLEN=" << NICKMAX-1;
482 v << " CASEMAPPING=rfc1459 STATUSMSG=@%+ CHARSET=ascii TOPICLEN=" << MAXTOPIC << " KICKLEN=" << MAXKICK << " MAXTARGETS=" << Config->MaxTargets << " AWAYLEN=";
483 v << MAXAWAY << " CHANMODES=" << this->Modes->ChanModes() << " FNC NETWORK=" << Config->Network << " MAXPARA=32";
484 Config->data005 = v.str();
485 FOREACH_MOD_I(this,I_On005Numeric,On005Numeric(Config->data005));
488 bool InspIRCd::UnloadModule(const char* filename)
490 std::string filename_str = filename;
491 for (unsigned int j = 0; j != Config->module_names.size(); j++)
493 if (Config->module_names[j] == filename_str)
495 if (modules[j]->GetVersion().Flags & VF_STATIC)
497 this->Log(DEFAULT,"Failed to unload STATIC module %s",filename);
498 snprintf(MODERR,MAXBUF,"Module not unloadable (marked static)");
501 /* Give the module a chance to tidy out all its metadata */
502 for (chan_hash::iterator c = this->chanlist.begin(); c != this->chanlist.end(); c++)
504 modules[j]->OnCleanup(TYPE_CHANNEL,c->second);
506 for (user_hash::iterator u = this->clientlist.begin(); u != this->clientlist.end(); u++)
508 modules[j]->OnCleanup(TYPE_USER,u->second);
511 FOREACH_MOD_I(this,I_OnUnloadModule,OnUnloadModule(modules[j],Config->module_names[j]));
513 for(int t = 0; t < 255; t++)
515 Config->global_implementation[t] -= Config->implement_lists[j][t];
518 /* We have to renumber implement_lists after unload because the module numbers change!
520 for(int j2 = j; j2 < 254; j2++)
522 for(int t = 0; t < 255; t++)
524 Config->implement_lists[j2][t] = Config->implement_lists[j2+1][t];
529 this->Log(DEBUG,"Removing dependent commands...");
530 Parser->RemoveCommands(filename);
531 this->Log(DEBUG,"Deleting module...");
532 this->EraseModule(j);
533 this->Log(DEBUG,"Erasing module entry...");
534 this->EraseFactory(j);
535 this->Log(DEFAULT,"Module %s unloaded",filename);
541 this->Log(DEFAULT,"Module %s is not loaded, cannot unload it!",filename);
542 snprintf(MODERR,MAXBUF,"Module not loaded");
546 bool InspIRCd::LoadModule(const char* filename)
548 /* Do we have a glob pattern in the filename?
549 * The user wants to load multiple modules which
552 if (strchr(filename,'*') || (strchr(filename,'?')))
555 DIR* library = opendir(Config->ModPath);
558 /* Try and locate and load all modules matching the pattern */
559 dirent* entry = NULL;
560 while ((entry = readdir(library)))
562 if (this->MatchText(entry->d_name, filename))
564 if (!this->LoadModule(entry->d_name))
570 /* Loadmodule will now return false if any one of the modules failed
571 * to load (but wont abort when it encounters a bad one) and when 1 or
572 * more modules were actually loaded.
574 return (n_match > 0);
577 char modfile[MAXBUF];
578 snprintf(modfile,MAXBUF,"%s/%s",Config->ModPath,filename);
579 std::string filename_str = filename;
581 if (!ServerConfig::DirValid(modfile))
583 this->Log(DEFAULT,"Module %s is not within the modules directory.",modfile);
584 snprintf(MODERR,MAXBUF,"Module %s is not within the modules directory.",modfile);
587 this->Log(DEBUG,"Loading module: %s",modfile);
589 if (ServerConfig::FileExists(modfile))
592 for (unsigned int j = 0; j < Config->module_names.size(); j++)
594 if (Config->module_names[j] == filename_str)
596 this->Log(DEFAULT,"Module %s is already loaded, cannot load a module twice!",modfile);
597 snprintf(MODERR,MAXBUF,"Module already loaded");
603 ircd_module* a = new ircd_module(this, modfile);
604 factory[this->ModCount+1] = a;
605 if (factory[this->ModCount+1]->LastError())
607 this->Log(DEFAULT,"Unable to load %s: %s",modfile,factory[this->ModCount+1]->LastError());
608 snprintf(MODERR,MAXBUF,"Loader/Linker error: %s",factory[this->ModCount+1]->LastError());
611 if ((long)factory[this->ModCount+1]->factory != -1)
613 Module* m = factory[this->ModCount+1]->factory->CreateModule(this);
615 Version v = m->GetVersion();
617 if (v.API != API_VERSION)
621 this->Log(DEFAULT,"Unable to load %s: Incorrect module API version: %d (our version: %d)",modfile,v.API,API_VERSION);
622 snprintf(MODERR,MAXBUF,"Loader/Linker error: Incorrect module API version: %d (our version: %d)",v.API,API_VERSION);
627 this->Log(DEFAULT,"New module introduced: %s (API version %d, Module version %d.%d.%d.%d)%s", filename, v.API, v.Major, v.Minor, v.Revision, v.Build, (!(v.Flags & VF_VENDOR) ? " [3rd Party]" : " [Vendor]"));
630 modules[this->ModCount+1] = m;
631 /* save the module and the module's classfactory, if
632 * this isnt done, random crashes can occur :/ */
633 Config->module_names.push_back(filename);
635 char* x = &Config->implement_lists[this->ModCount+1][0];
636 for(int t = 0; t < 255; t++)
639 modules[this->ModCount+1]->Implements(x);
641 for(int t = 0; t < 255; t++)
642 Config->global_implementation[t] += Config->implement_lists[this->ModCount+1][t];
646 this->Log(DEFAULT,"Unable to load %s",modfile);
647 snprintf(MODERR,MAXBUF,"Factory function failed: Probably missing init_module() entrypoint.");
651 catch (ModuleException& modexcept)
653 this->Log(DEFAULT,"Unable to load %s: ",modfile,modexcept.GetReason());
654 snprintf(MODERR,MAXBUF,"Factory function threw an exception: %s",modexcept.GetReason());
660 this->Log(DEFAULT,"InspIRCd: startup: Module Not Found %s",modfile);
661 snprintf(MODERR,MAXBUF,"Module file could not be found");
665 FOREACH_MOD_I(this,I_OnLoadModule,OnLoadModule(modules[this->ModCount],filename_str));
666 // now work out which modules, if any, want to move to the back of the queue,
667 // and if they do, move them there.
668 std::vector<std::string> put_to_back;
669 std::vector<std::string> put_to_front;
670 std::map<std::string,std::string> put_before;
671 std::map<std::string,std::string> put_after;
672 for (unsigned int j = 0; j < Config->module_names.size(); j++)
674 if (modules[j]->Prioritize() == PRIORITY_LAST)
675 put_to_back.push_back(Config->module_names[j]);
676 else if (modules[j]->Prioritize() == PRIORITY_FIRST)
677 put_to_front.push_back(Config->module_names[j]);
678 else if ((modules[j]->Prioritize() & 0xFF) == PRIORITY_BEFORE)
679 put_before[Config->module_names[j]] = Config->module_names[modules[j]->Prioritize() >> 8];
680 else if ((modules[j]->Prioritize() & 0xFF) == PRIORITY_AFTER)
681 put_after[Config->module_names[j]] = Config->module_names[modules[j]->Prioritize() >> 8];
683 for (unsigned int j = 0; j < put_to_back.size(); j++)
684 MoveToLast(put_to_back[j]);
685 for (unsigned int j = 0; j < put_to_front.size(); j++)
686 MoveToFirst(put_to_front[j]);
687 for (std::map<std::string,std::string>::iterator j = put_before.begin(); j != put_before.end(); j++)
688 MoveBefore(j->first,j->second);
689 for (std::map<std::string,std::string>::iterator j = put_after.begin(); j != put_after.end(); j++)
690 MoveAfter(j->first,j->second);
695 void InspIRCd::DoOneIteration(bool process_module_sockets)
697 /* time() seems to be a pretty expensive syscall, so avoid calling it too much.
698 * Once per loop iteration is pleanty.
703 /* Run background module timers every few seconds
704 * (the docs say modules shouldnt rely on accurate
705 * timing using this event, so we dont have to
706 * time this exactly).
711 WriteOpers("*** \002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %d secs.",abs(OLDTIME-TIME));
712 if ((TIME % 3600) == 0)
714 irc::whowas::MaintainWhoWas(this, TIME);
716 Timers->TickTimers(TIME);
717 this->DoBackgroundUserStuff(TIME);
721 XLines->expire_lines();
722 FOREACH_MOD_I(this,I_OnBackgroundTimer,OnBackgroundTimer(TIME));
723 Timers->TickMissedTimers(TIME);
727 /* Call the socket engine to wait on the active
728 * file descriptors. The socket engine has everything's
729 * descriptors in its list... dns, modules, users,
730 * servers... so its nice and easy, just one call.
731 * This will cause any read or write events to be
732 * dispatched to their handlers.
734 SE->DispatchEvents();
737 bool InspIRCd::IsIdent(const char* n)
742 for (char* i = (char*)n; *i; i++)
744 if ((*i >= 'A') && (*i <= '}'))
748 if (((*i >= '0') && (*i <= '9')) || (*i == '-') || (*i == '.'))
762 DoOneIteration(true);
764 /* This is never reached -- we hope! */
768 /**********************************************************************************/
771 * An ircd in four lines! bwahahaha. ahahahahaha. ahahah *cough*.
774 int main(int argc, char** argv)
776 SI = new InspIRCd(argc, argv);
782 /* this returns true when all modules are satisfied that the user should be allowed onto the irc server
783 * (until this returns true, a user will block in the waiting state, waiting to connect up to the
784 * registration timeout maximum seconds)
786 bool InspIRCd::AllModulesReportReady(userrec* user)
788 if (!Config->global_implementation[I_OnCheckReady])
791 for (int i = 0; i <= this->GetModuleCount(); i++)
793 if (Config->implement_lists[i][I_OnCheckReady])
795 int res = modules[i]->OnCheckReady(user);
803 int InspIRCd::GetModuleCount()
805 return this->ModCount;
808 time_t InspIRCd::Time(bool delta)
811 return TIME + time_delta;
815 int InspIRCd::SetTimeDelta(int delta)
817 int old = time_delta;
819 this->Log(DEBUG, "Time delta set to %d (was %d)", time_delta, old);
823 bool FileLogger::Readable()
828 void FileLogger::HandleEvent(EventType et, int errornum)
830 this->WriteLogLine("");
831 ServerInstance->SE->DelFd(this);
834 void FileLogger::WriteLogLine(const std::string &line)
841 int written = fprintf(log,"%s",buffer.c_str());
842 if ((written >= 0) && (written < (int)buffer.length()))
844 buffer.erase(0, buffer.length());
845 ServerInstance->SE->AddFd(this);
847 else if (written == -1)
850 ServerInstance->SE->AddFd(this);
854 /* Wrote the whole buffer, and no need for write callback */
864 void FileLogger::Close()
868 int flags = fcntl(fileno(log), F_GETFL, 0);
869 fcntl(fileno(log), F_SETFL, flags ^ O_NONBLOCK);
871 fprintf(log,"%s",buffer.c_str());
876 ServerInstance->SE->DelFd(this);
879 FileLogger::FileLogger(InspIRCd* Instance, FILE* logfile) : ServerInstance(Instance), log(logfile), writeops(0)
881 irc::sockets::NonBlocking(fileno(log));
882 this->SetFd(fileno(log));
886 FileLogger::~FileLogger()