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, jamie\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)
188 this->Config = new ServerConfig(this);
189 this->Config->opertypes.clear();
190 this->Config->operclass.clear();
191 this->SNO = new SnomaskManager(this);
193 this->TIME = this->OLDTIME = this->startup_time = time(NULL);
194 this->next_call = this->TIME + 3;
196 this->Log(DEBUG,"*** InspIRCd starting up!");
197 if (!ServerConfig::FileExists(CONFIG_FILE))
199 printf("ERROR: Cannot open config file: %s\nExiting...\n",CONFIG_FILE);
200 this->Log(DEFAULT,"main: no config");
201 printf("ERROR: Your config file is missing, this IRCd will self destruct in 10 seconds!\n");
204 *this->LogFileName = 0;
206 for (int i = 1; i < argc; i++)
208 if (!strcmp(argv[i],"-nofork"))
210 Config->nofork = true;
212 else if(!strcmp(argv[i],"-debug"))
214 Config->forcedebug = true;
216 else if(!strcmp(argv[i],"-nolog"))
218 Config->writelog = false;
220 else if (!strcmp(argv[i],"-wait"))
224 else if (!strcmp(argv[i],"-logfile"))
228 strlcpy(LogFileName,argv[i+1],MAXBUF);
229 printf("LOG: Setting logfile to %s\n",LogFileName);
233 printf("ERROR: The -logfile parameter must be followed by a log file name and path.\n");
240 printf("Usage: %s [-nofork] [-nolog] [-debug] [-wait] [-logfile <filename>]\n",argv[0]);
246 strlcpy(Config->MyExecutable,argv[0],MAXBUF);
248 this->OpenLog(argv, argc);
249 this->stats = new serverstats();
250 this->Parser = new CommandParser(this);
251 this->Timers = new TimerManager();
252 this->XLines = new XLineManager(this);
253 Config->ClearStack();
254 Config->Read(true, NULL);
256 this->Modes = new ModeParser(this);
257 this->AddServerName(Config->ServerName);
259 InitializeDisabledCommands(Config->DisabledCommands, this);
260 stats->BoundPortCount = BindPorts(true);
262 for(int t = 0; t < 255; t++)
263 Config->global_implementation[t] = 0;
265 memset(&Config->implement_lists,0,sizeof(Config->implement_lists));
271 if (!this->DaemonSeed())
273 printf("ERROR: could not go into daemon mode. Shutting down.\n");
278 /* Because of limitations in kqueue on freebsd, we must fork BEFORE we
279 * initialize the socket engine.
281 SocketEngineFactory* SEF = new SocketEngineFactory();
282 SE = SEF->Create(this);
285 this->Res = new DNS(this);
287 this->LoadAllModules();
288 /* Just in case no modules were loaded - fix for bug #101 */
289 this->BuildISupport();
291 if (!stats->BoundPortCount)
293 printf("\nERROR: I couldn't bind any ports! Are you sure you didn't start InspIRCd twice?\n");
297 /* Add the listening sockets used for client inbound connections
298 * to the socket engine
300 this->Log(DEBUG,"%d listeners",stats->BoundPortCount);
301 for (unsigned long count = 0; count < stats->BoundPortCount; count++)
303 this->Log(DEBUG,"Add listener: %d",Config->openSockfd[count]->GetFd());
304 if (!SE->AddFd(Config->openSockfd[count]))
306 printf("\nEH? Could not add listener to socketengine. You screwed up, aborting.\n");
313 if (kill(getppid(), SIGTERM) == -1)
314 printf("Error killing parent process: %s\n",strerror(errno));
320 printf("\nInspIRCd is now running!\n");
322 this->WritePID(Config->PID);
325 std::string InspIRCd::GetVersionString()
327 char versiondata[MAXBUF];
328 char dnsengine[] = "singlethread-object";
329 if (*Config->CustomVersion)
331 snprintf(versiondata,MAXBUF,"%s %s :%s",VERSION,Config->ServerName,Config->CustomVersion);
335 snprintf(versiondata,MAXBUF,"%s %s :%s [FLAGS=%lu,%s,%s]",VERSION,Config->ServerName,SYSTEM,(unsigned long)OPTIMISATION,SE->GetName().c_str(),dnsengine);
340 char* InspIRCd::ModuleError()
345 void InspIRCd::EraseFactory(int j)
348 for (std::vector<ircd_module*>::iterator t = factory.begin(); t != factory.end(); t++)
354 factory.push_back(NULL);
361 void InspIRCd::EraseModule(int j)
364 for (ModuleList::iterator m = modules.begin(); m!= modules.end(); m++)
370 modules.push_back(NULL);
376 for (std::vector<std::string>::iterator v = Config->module_names.begin(); v != Config->module_names.end(); v++)
380 Config->module_names.erase(v);
388 void InspIRCd::MoveTo(std::string modulename,int slot)
390 unsigned int v2 = 256;
391 for (unsigned int v = 0; v < Config->module_names.size(); v++)
393 if (Config->module_names[v] == modulename)
395 // found an instance, swap it with the item at the end
400 if ((v2 != (unsigned int)slot) && (v2 < 256))
402 // Swap the module names over
403 Config->module_names[v2] = Config->module_names[slot];
404 Config->module_names[slot] = modulename;
405 // now swap the module factories
406 ircd_module* temp = factory[v2];
407 factory[v2] = factory[slot];
408 factory[slot] = temp;
409 // now swap the module objects
410 Module* temp_module = modules[v2];
411 modules[v2] = modules[slot];
412 modules[slot] = temp_module;
413 // now swap the implement lists (we dont
414 // need to swap the global or recount it)
415 for (int n = 0; n < 255; n++)
417 char x = Config->implement_lists[v2][n];
418 Config->implement_lists[v2][n] = Config->implement_lists[slot][n];
419 Config->implement_lists[slot][n] = x;
424 this->Log(DEBUG,"Move of %s to slot failed!",modulename.c_str());
428 void InspIRCd::MoveAfter(std::string modulename, std::string after)
430 for (unsigned int v = 0; v < Config->module_names.size(); v++)
432 if (Config->module_names[v] == after)
434 MoveTo(modulename, v);
440 void InspIRCd::MoveBefore(std::string modulename, std::string before)
442 for (unsigned int v = 0; v < Config->module_names.size(); v++)
444 if (Config->module_names[v] == before)
448 MoveTo(modulename, v-1);
452 MoveTo(modulename, v);
459 void InspIRCd::MoveToFirst(std::string modulename)
461 MoveTo(modulename,0);
464 void InspIRCd::MoveToLast(std::string modulename)
466 MoveTo(modulename,this->GetModuleCount());
469 void InspIRCd::BuildISupport()
471 // the neatest way to construct the initial 005 numeric, considering the number of configure constants to go in it...
473 v << "WALLCHOPS WALLVOICES MODES=" << MAXMODES << " CHANTYPES=# PREFIX=" << this->Modes->BuildPrefixes() << " MAP MAXCHANNELS=" << MAXCHANS << " MAXBANS=60 VBANLIST NICKLEN=" << NICKMAX-1;
474 v << " CASEMAPPING=rfc1459 STATUSMSG=@%+ CHARSET=ascii TOPICLEN=" << MAXTOPIC << " KICKLEN=" << MAXKICK << " MAXTARGETS=" << Config->MaxTargets << " AWAYLEN=";
475 v << MAXAWAY << " CHANMODES=" << this->Modes->ChanModes() << " FNC NETWORK=" << Config->Network << " MAXPARA=32";
476 Config->data005 = v.str();
477 FOREACH_MOD_I(this,I_On005Numeric,On005Numeric(Config->data005));
480 bool InspIRCd::UnloadModule(const char* filename)
482 std::string filename_str = filename;
483 for (unsigned int j = 0; j != Config->module_names.size(); j++)
485 if (Config->module_names[j] == filename_str)
487 if (modules[j]->GetVersion().Flags & VF_STATIC)
489 this->Log(DEFAULT,"Failed to unload STATIC module %s",filename);
490 snprintf(MODERR,MAXBUF,"Module not unloadable (marked static)");
493 /* Give the module a chance to tidy out all its metadata */
494 for (chan_hash::iterator c = this->chanlist.begin(); c != this->chanlist.end(); c++)
496 modules[j]->OnCleanup(TYPE_CHANNEL,c->second);
498 for (user_hash::iterator u = this->clientlist.begin(); u != this->clientlist.end(); u++)
500 modules[j]->OnCleanup(TYPE_USER,u->second);
503 FOREACH_MOD_I(this,I_OnUnloadModule,OnUnloadModule(modules[j],Config->module_names[j]));
505 for(int t = 0; t < 255; t++)
507 Config->global_implementation[t] -= Config->implement_lists[j][t];
510 /* We have to renumber implement_lists after unload because the module numbers change!
512 for(int j2 = j; j2 < 254; j2++)
514 for(int t = 0; t < 255; t++)
516 Config->implement_lists[j2][t] = Config->implement_lists[j2+1][t];
521 this->Log(DEBUG,"Removing dependent commands...");
522 Parser->RemoveCommands(filename);
523 this->Log(DEBUG,"Deleting module...");
524 this->EraseModule(j);
525 this->Log(DEBUG,"Erasing module entry...");
526 this->EraseFactory(j);
527 this->Log(DEFAULT,"Module %s unloaded",filename);
533 this->Log(DEFAULT,"Module %s is not loaded, cannot unload it!",filename);
534 snprintf(MODERR,MAXBUF,"Module not loaded");
538 bool InspIRCd::LoadModule(const char* filename)
540 /* Do we have a glob pattern in the filename?
541 * The user wants to load multiple modules which
544 if (strchr(filename,'*') || (strchr(filename,'?')))
547 DIR* library = opendir(Config->ModPath);
550 /* Try and locate and load all modules matching the pattern */
551 dirent* entry = NULL;
552 while ((entry = readdir(library)))
554 if (this->MatchText(entry->d_name, filename))
556 if (!this->LoadModule(entry->d_name))
562 /* Loadmodule will now return false if any one of the modules failed
563 * to load (but wont abort when it encounters a bad one) and when 1 or
564 * more modules were actually loaded.
566 return (n_match > 0);
569 char modfile[MAXBUF];
570 snprintf(modfile,MAXBUF,"%s/%s",Config->ModPath,filename);
571 std::string filename_str = filename;
573 if (!ServerConfig::DirValid(modfile))
575 this->Log(DEFAULT,"Module %s is not within the modules directory.",modfile);
576 snprintf(MODERR,MAXBUF,"Module %s is not within the modules directory.",modfile);
579 this->Log(DEBUG,"Loading module: %s",modfile);
581 if (ServerConfig::FileExists(modfile))
584 for (unsigned int j = 0; j < Config->module_names.size(); j++)
586 if (Config->module_names[j] == filename_str)
588 this->Log(DEFAULT,"Module %s is already loaded, cannot load a module twice!",modfile);
589 snprintf(MODERR,MAXBUF,"Module already loaded");
595 ircd_module* a = new ircd_module(this, modfile);
596 factory[this->ModCount+1] = a;
597 if (factory[this->ModCount+1]->LastError())
599 this->Log(DEFAULT,"Unable to load %s: %s",modfile,factory[this->ModCount+1]->LastError());
600 snprintf(MODERR,MAXBUF,"Loader/Linker error: %s",factory[this->ModCount+1]->LastError());
603 if ((long)factory[this->ModCount+1]->factory != -1)
605 Module* m = factory[this->ModCount+1]->factory->CreateModule(this);
607 Version v = m->GetVersion();
609 if (v.API != API_VERSION)
613 this->Log(DEFAULT,"Unable to load %s: Incorrect module API version: %d (our version: %d)",modfile,v.API,API_VERSION);
614 snprintf(MODERR,MAXBUF,"Loader/Linker error: Incorrect module API version: %d (our version: %d)",v.API,API_VERSION);
619 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]"));
622 modules[this->ModCount+1] = m;
623 /* save the module and the module's classfactory, if
624 * this isnt done, random crashes can occur :/ */
625 Config->module_names.push_back(filename);
627 char* x = &Config->implement_lists[this->ModCount+1][0];
628 for(int t = 0; t < 255; t++)
631 modules[this->ModCount+1]->Implements(x);
633 for(int t = 0; t < 255; t++)
634 Config->global_implementation[t] += Config->implement_lists[this->ModCount+1][t];
638 this->Log(DEFAULT,"Unable to load %s",modfile);
639 snprintf(MODERR,MAXBUF,"Factory function failed: Probably missing init_module() entrypoint.");
643 catch (ModuleException& modexcept)
645 this->Log(DEFAULT,"Unable to load %s: ",modfile,modexcept.GetReason());
646 snprintf(MODERR,MAXBUF,"Factory function threw an exception: %s",modexcept.GetReason());
652 this->Log(DEFAULT,"InspIRCd: startup: Module Not Found %s",modfile);
653 snprintf(MODERR,MAXBUF,"Module file could not be found");
657 FOREACH_MOD_I(this,I_OnLoadModule,OnLoadModule(modules[this->ModCount],filename_str));
658 // now work out which modules, if any, want to move to the back of the queue,
659 // and if they do, move them there.
660 std::vector<std::string> put_to_back;
661 std::vector<std::string> put_to_front;
662 std::map<std::string,std::string> put_before;
663 std::map<std::string,std::string> put_after;
664 for (unsigned int j = 0; j < Config->module_names.size(); j++)
666 if (modules[j]->Prioritize() == PRIORITY_LAST)
667 put_to_back.push_back(Config->module_names[j]);
668 else if (modules[j]->Prioritize() == PRIORITY_FIRST)
669 put_to_front.push_back(Config->module_names[j]);
670 else if ((modules[j]->Prioritize() & 0xFF) == PRIORITY_BEFORE)
671 put_before[Config->module_names[j]] = Config->module_names[modules[j]->Prioritize() >> 8];
672 else if ((modules[j]->Prioritize() & 0xFF) == PRIORITY_AFTER)
673 put_after[Config->module_names[j]] = Config->module_names[modules[j]->Prioritize() >> 8];
675 for (unsigned int j = 0; j < put_to_back.size(); j++)
676 MoveToLast(put_to_back[j]);
677 for (unsigned int j = 0; j < put_to_front.size(); j++)
678 MoveToFirst(put_to_front[j]);
679 for (std::map<std::string,std::string>::iterator j = put_before.begin(); j != put_before.end(); j++)
680 MoveBefore(j->first,j->second);
681 for (std::map<std::string,std::string>::iterator j = put_after.begin(); j != put_after.end(); j++)
682 MoveAfter(j->first,j->second);
687 void InspIRCd::DoOneIteration(bool process_module_sockets)
689 /* time() seems to be a pretty expensive syscall, so avoid calling it too much.
690 * Once per loop iteration is pleanty.
695 /* Run background module timers every few seconds
696 * (the docs say modules shouldnt rely on accurate
697 * timing using this event, so we dont have to
698 * time this exactly).
703 WriteOpers("*** \002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %d secs.",abs(OLDTIME-TIME));
704 if ((TIME % 3600) == 0)
706 irc::whowas::MaintainWhoWas(this, TIME);
708 Timers->TickTimers(TIME);
709 this->DoBackgroundUserStuff(TIME);
713 XLines->expire_lines();
714 FOREACH_MOD_I(this,I_OnBackgroundTimer,OnBackgroundTimer(TIME));
715 Timers->TickMissedTimers(TIME);
719 /* Call the socket engine to wait on the active
720 * file descriptors. The socket engine has everything's
721 * descriptors in its list... dns, modules, users,
722 * servers... so its nice and easy, just one call.
723 * This will cause any read or write events to be
724 * dispatched to their handlers.
726 SE->DispatchEvents();
729 bool InspIRCd::IsIdent(const char* n)
734 for (char* i = (char*)n; *i; i++)
736 if ((*i >= 'A') && (*i <= '}'))
740 if (((*i >= '0') && (*i <= '9')) || (*i == '-') || (*i == '.'))
754 DoOneIteration(true);
756 /* This is never reached -- we hope! */
760 /**********************************************************************************/
763 * An ircd in four lines! bwahahaha. ahahahahaha. ahahah *cough*.
766 int main(int argc, char** argv)
768 SI = new InspIRCd(argc, argv);
774 /* this returns true when all modules are satisfied that the user should be allowed onto the irc server
775 * (until this returns true, a user will block in the waiting state, waiting to connect up to the
776 * registration timeout maximum seconds)
778 bool InspIRCd::AllModulesReportReady(userrec* user)
780 if (!Config->global_implementation[I_OnCheckReady])
783 for (int i = 0; i <= this->GetModuleCount(); i++)
785 if (Config->implement_lists[i][I_OnCheckReady])
787 int res = modules[i]->OnCheckReady(user);
795 int InspIRCd::GetModuleCount()
797 return this->ModCount;
800 time_t InspIRCd::Time()
805 bool FileLogger::Readable()
810 void FileLogger::HandleEvent(EventType et, int errornum)
812 this->WriteLogLine("");
813 ServerInstance->SE->DelFd(this);
816 void FileLogger::WriteLogLine(const std::string &line)
823 int written = fprintf(log,"%s",buffer.c_str());
824 if ((written >= 0) && (written < (int)buffer.length()))
826 buffer.erase(0, buffer.length());
827 ServerInstance->SE->AddFd(this);
829 else if (written == -1)
832 ServerInstance->SE->AddFd(this);
836 /* Wrote the whole buffer, and no need for write callback */
846 void FileLogger::Close()
850 int flags = fcntl(fileno(log), F_GETFL, 0);
851 fcntl(fileno(log), F_SETFL, flags ^ O_NONBLOCK);
853 fprintf(log,"%s",buffer.c_str());
858 ServerInstance->SE->DelFd(this);
861 FileLogger::FileLogger(InspIRCd* Instance, FILE* logfile) : ServerInstance(Instance), log(logfile), writeops(0)
863 irc::sockets::NonBlocking(fileno(log));
864 this->SetFd(fileno(log));
868 FileLogger::~FileLogger()