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"
46 #include "socketengine.h"
47 #include "inspircd_se_config.h"
50 #include "command_parse.h"
52 using irc::sockets::NonBlocking;
53 using irc::sockets::insp_ntoa;
54 using irc::sockets::insp_inaddr;
55 using irc::sockets::insp_sockaddr;
59 void InspIRCd::AddServerName(const std::string &servername)
61 this->Log(DEBUG,"Adding server name: %s",servername.c_str());
63 if(find(servernames.begin(), servernames.end(), servername) == servernames.end())
64 servernames.push_back(servername); /* Wasn't already there. */
67 const char* InspIRCd::FindServerNamePtr(const std::string &servername)
69 servernamelist::iterator iter = find(servernames.begin(), servernames.end(), servername);
71 if(iter == servernames.end())
73 AddServerName(servername);
74 iter = --servernames.end();
80 bool InspIRCd::FindServerName(const std::string &servername)
82 return (find(servernames.begin(), servernames.end(), servername) != servernames.end());
85 void InspIRCd::Exit(int status)
90 void InspIRCd::Start()
92 printf("\033[1;32mInspire Internet Relay Chat Server, compiled %s at %s\n",__DATE__,__TIME__);
93 printf("(C) ChatSpike Development team.\033[0m\n\n");
94 printf("Developers:\t\t\033[1;32mBrain, FrostyCoolSlug, w00t, Om, Special\033[0m\n");
95 printf("Others:\t\t\t\033[1;32mSee /INFO Output\033[0m\n");
96 printf("Name concept:\t\t\033[1;32mLord_Zathras\033[0m\n\n");
99 void InspIRCd::Rehash(int status)
101 SI->WriteOpers("Rehashing config file %s due to SIGHUP",ServerConfig::CleanFilename(CONFIG_FILE));
102 fclose(SI->Config->log_file);
104 SI->Config->Read(false,NULL);
105 FOREACH_MOD_I(SI,I_OnRehash,OnRehash(""));
108 void InspIRCd::SetSignals(bool SEGVHandler)
110 signal (SIGALRM, SIG_IGN);
111 signal (SIGHUP, InspIRCd::Rehash);
112 signal (SIGPIPE, SIG_IGN);
113 signal (SIGTERM, InspIRCd::Exit);
116 bool InspIRCd::DaemonSeed()
119 if ((childpid = fork ()) < 0)
121 else if (childpid > 0)
123 /* We wait here for the child process to kill us,
124 * so that the shell prompt doesnt come back over
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)
173 bool SEGVHandler = false;
178 this->Config = new ServerConfig(this);
180 this->module_sockets.clear();
181 this->TIME = this->OLDTIME = this->startup_time = time(NULL);
183 this->Log(DEBUG,"*** InspIRCd starting up!");
184 if (!ServerConfig::FileExists(CONFIG_FILE))
186 printf("ERROR: Cannot open config file: %s\nExiting...\n",CONFIG_FILE);
187 this->Log(DEFAULT,"main: no config");
188 printf("ERROR: Your config file is missing, this IRCd will self destruct in 10 seconds!\n");
191 *this->LogFileName = 0;
193 for (int i = 1; i < argc; i++)
195 if (!strcmp(argv[i],"-nofork"))
197 Config->nofork = true;
199 else if(!strcmp(argv[i],"-debug"))
201 Config->forcedebug = true;
203 else if(!strcmp(argv[i],"-nolog"))
205 Config->writelog = false;
207 else if (!strcmp(argv[i],"-wait"))
211 else if (!strcmp(argv[i],"-nolimit"))
213 printf("WARNING: The `-nolimit' option is deprecated, and now on by default. This behaviour may change in the future.\n");
215 else if (!strcmp(argv[i],"-notraceback"))
219 else if (!strcmp(argv[i],"-logfile"))
223 strlcpy(LogFileName,argv[i+1],MAXBUF);
224 printf("LOG: Setting logfile to %s\n",LogFileName);
228 printf("ERROR: The -logfile parameter must be followed by a log file name and path.\n");
235 printf("Usage: %s [-nofork] [-nolog] [-debug] [-wait] [-nolimit] [-notraceback] [-logfile <filename>]\n",argv[0]);
241 strlcpy(Config->MyExecutable,argv[0],MAXBUF);
243 this->OpenLog(argv, argc);
244 this->stats = new serverstats();
245 this->Parser = new CommandParser(this);
246 this->Timers = new TimerManager();
247 this->XLines = new XLineManager(this);
248 Config->ClearStack();
249 Config->Read(true, NULL);
251 this->Modes = new ModeParser(this);
252 this->AddServerName(Config->ServerName);
254 InitializeDisabledCommands(Config->DisabledCommands, this);
255 stats->BoundPortCount = BindPorts(true);
257 for(int t = 0; t < 255; t++)
258 Config->global_implementation[t] = 0;
260 memset(&Config->implement_lists,0,sizeof(Config->implement_lists));
263 this->SetSignals(SEGVHandler);
266 if (!this->DaemonSeed())
268 printf("ERROR: could not go into daemon mode. Shutting down.\n");
273 /* Because of limitations in kqueue on freebsd, we must fork BEFORE we
274 * initialize the socket engine.
276 SocketEngineFactory* SEF = new SocketEngineFactory();
277 SE = SEF->Create(this);
280 this->Res = new DNS(this);
282 this->LoadAllModules();
283 /* Just in case no modules were loaded - fix for bug #101 */
284 this->BuildISupport();
286 if (!stats->BoundPortCount)
288 printf("\nERROR: I couldn't bind any ports! Are you sure you didn't start InspIRCd twice?\n");
292 /* Add the listening sockets used for client inbound connections
293 * to the socket engine
295 this->Log(DEBUG,"%d listeners",stats->BoundPortCount);
296 for (unsigned long count = 0; count < stats->BoundPortCount; count++)
298 this->Log(DEBUG,"Add listener: %d",Config->openSockfd[count]);
299 if (!SE->AddFd(Config->openSockfd[count]))
301 printf("\nEH? Could not add listener to socketengine. You screwed up, aborting.\n");
308 if (kill(getppid(), SIGTERM) == -1)
309 printf("Error killing parent process: %s\n",strerror(errno));
315 printf("\nInspIRCd is now running!\n");
317 this->WritePID(Config->PID);
320 std::string InspIRCd::GetVersionString()
322 char versiondata[MAXBUF];
323 char dnsengine[] = "singlethread-object";
324 if (*Config->CustomVersion)
326 snprintf(versiondata,MAXBUF,"%s %s :%s",VERSION,Config->ServerName,Config->CustomVersion);
330 snprintf(versiondata,MAXBUF,"%s %s :%s [FLAGS=%lu,%s,%s]",VERSION,Config->ServerName,SYSTEM,(unsigned long)OPTIMISATION,SE->GetName().c_str(),dnsengine);
335 char* InspIRCd::ModuleError()
340 void InspIRCd::EraseFactory(int j)
343 for (std::vector<ircd_module*>::iterator t = factory.begin(); t != factory.end(); t++)
348 factory.push_back(NULL);
355 void InspIRCd::EraseModule(int j)
358 for (ModuleList::iterator m = modules.begin(); m!= modules.end(); m++)
364 modules.push_back(NULL);
370 for (std::vector<std::string>::iterator v = Config->module_names.begin(); v != Config->module_names.end(); v++)
374 Config->module_names.erase(v);
382 void InspIRCd::MoveTo(std::string modulename,int slot)
384 unsigned int v2 = 256;
385 for (unsigned int v = 0; v < Config->module_names.size(); v++)
387 if (Config->module_names[v] == modulename)
389 // found an instance, swap it with the item at the end
394 if ((v2 != (unsigned int)slot) && (v2 < 256))
396 // Swap the module names over
397 Config->module_names[v2] = Config->module_names[slot];
398 Config->module_names[slot] = modulename;
399 // now swap the module factories
400 ircd_module* temp = factory[v2];
401 factory[v2] = factory[slot];
402 factory[slot] = temp;
403 // now swap the module objects
404 Module* temp_module = modules[v2];
405 modules[v2] = modules[slot];
406 modules[slot] = temp_module;
407 // now swap the implement lists (we dont
408 // need to swap the global or recount it)
409 for (int n = 0; n < 255; n++)
411 char x = Config->implement_lists[v2][n];
412 Config->implement_lists[v2][n] = Config->implement_lists[slot][n];
413 Config->implement_lists[slot][n] = x;
418 this->Log(DEBUG,"Move of %s to slot failed!",modulename.c_str());
422 void InspIRCd::MoveAfter(std::string modulename, std::string after)
424 for (unsigned int v = 0; v < Config->module_names.size(); v++)
426 if (Config->module_names[v] == after)
428 MoveTo(modulename, v);
434 void InspIRCd::MoveBefore(std::string modulename, std::string before)
436 for (unsigned int v = 0; v < Config->module_names.size(); v++)
438 if (Config->module_names[v] == before)
442 MoveTo(modulename, v-1);
446 MoveTo(modulename, v);
453 void InspIRCd::MoveToFirst(std::string modulename)
455 MoveTo(modulename,0);
458 void InspIRCd::MoveToLast(std::string modulename)
460 MoveTo(modulename,this->GetModuleCount());
463 void InspIRCd::BuildISupport()
465 // the neatest way to construct the initial 005 numeric, considering the number of configure constants to go in it...
467 v << "WALLCHOPS WALLVOICES MODES=" << MAXMODES << " CHANTYPES=# PREFIX=(ohv)@%+ MAP MAXCHANNELS=" << MAXCHANS << " MAXBANS=60 VBANLIST NICKLEN=" << NICKMAX-1;
468 v << " CASEMAPPING=rfc1459 STATUSMSG=@%+ CHARSET=ascii TOPICLEN=" << MAXTOPIC << " KICKLEN=" << MAXKICK << " MAXTARGETS=" << Config->MaxTargets << " AWAYLEN=";
469 v << MAXAWAY << " CHANMODES=b,k,l,psmnti FNC NETWORK=" << Config->Network << " MAXPARA=32";
470 Config->data005 = v.str();
471 FOREACH_MOD_I(this,I_On005Numeric,On005Numeric(Config->data005));
474 bool InspIRCd::UnloadModule(const char* filename)
476 std::string filename_str = filename;
477 for (unsigned int j = 0; j != Config->module_names.size(); j++)
479 if (Config->module_names[j] == filename_str)
481 if (modules[j]->GetVersion().Flags & VF_STATIC)
483 this->Log(DEFAULT,"Failed to unload STATIC module %s",filename);
484 snprintf(MODERR,MAXBUF,"Module not unloadable (marked static)");
487 /* Give the module a chance to tidy out all its metadata */
488 for (chan_hash::iterator c = this->chanlist.begin(); c != this->chanlist.end(); c++)
490 modules[j]->OnCleanup(TYPE_CHANNEL,c->second);
492 for (user_hash::iterator u = this->clientlist.begin(); u != this->clientlist.end(); u++)
494 modules[j]->OnCleanup(TYPE_USER,u->second);
497 FOREACH_MOD_I(this,I_OnUnloadModule,OnUnloadModule(modules[j],Config->module_names[j]));
499 for(int t = 0; t < 255; t++)
501 Config->global_implementation[t] -= Config->implement_lists[j][t];
504 /* We have to renumber implement_lists after unload because the module numbers change!
506 for(int j2 = j; j2 < 254; j2++)
508 for(int t = 0; t < 255; t++)
510 Config->implement_lists[j2][t] = Config->implement_lists[j2+1][t];
515 this->Log(DEBUG,"Removing dependent commands...");
516 Parser->RemoveCommands(filename);
517 this->Log(DEBUG,"Deleting module...");
518 this->EraseModule(j);
519 this->Log(DEBUG,"Erasing module entry...");
520 this->EraseFactory(j);
521 this->Log(DEFAULT,"Module %s unloaded",filename);
527 this->Log(DEFAULT,"Module %s is not loaded, cannot unload it!",filename);
528 snprintf(MODERR,MAXBUF,"Module not loaded");
532 bool InspIRCd::LoadModule(const char* filename)
534 char modfile[MAXBUF];
536 strlcpy(modfile,filename,MAXBUF);
538 snprintf(modfile,MAXBUF,"%s/%s",Config->ModPath,filename);
540 std::string filename_str = filename;
543 if (!ServerConfig::DirValid(modfile))
545 this->Log(DEFAULT,"Module %s is not within the modules directory.",modfile);
546 snprintf(MODERR,MAXBUF,"Module %s is not within the modules directory.",modfile);
551 this->Log(DEBUG,"Loading module: %s",modfile);
553 if (ServerConfig::FileExists(modfile))
556 for (unsigned int j = 0; j < Config->module_names.size(); j++)
558 if (Config->module_names[j] == filename_str)
560 this->Log(DEFAULT,"Module %s is already loaded, cannot load a module twice!",modfile);
561 snprintf(MODERR,MAXBUF,"Module already loaded");
567 ircd_module* a = new ircd_module(this, modfile);
568 factory[this->ModCount+1] = a;
569 if (factory[this->ModCount+1]->LastError())
571 this->Log(DEFAULT,"Unable to load %s: %s",modfile,factory[this->ModCount+1]->LastError());
572 snprintf(MODERR,MAXBUF,"Loader/Linker error: %s",factory[this->ModCount+1]->LastError());
575 if ((long)factory[this->ModCount+1]->factory != -1)
577 Module* m = factory[this->ModCount+1]->factory->CreateModule(this);
578 modules[this->ModCount+1] = m;
579 /* save the module and the module's classfactory, if
580 * this isnt done, random crashes can occur :/ */
581 Config->module_names.push_back(filename);
583 char* x = &Config->implement_lists[this->ModCount+1][0];
584 for(int t = 0; t < 255; t++)
587 modules[this->ModCount+1]->Implements(x);
589 for(int t = 0; t < 255; t++)
590 Config->global_implementation[t] += Config->implement_lists[this->ModCount+1][t];
594 this->Log(DEFAULT,"Unable to load %s",modfile);
595 snprintf(MODERR,MAXBUF,"Factory function failed: Probably missing init_module() entrypoint.");
599 catch (ModuleException& modexcept)
601 this->Log(DEFAULT,"Unable to load %s: ",modfile,modexcept.GetReason());
602 snprintf(MODERR,MAXBUF,"Factory function threw an exception: %s",modexcept.GetReason());
609 this->Log(DEFAULT,"InspIRCd: startup: Module Not Found %s",modfile);
610 snprintf(MODERR,MAXBUF,"Module file could not be found");
615 FOREACH_MOD_I(this,I_OnLoadModule,OnLoadModule(modules[this->ModCount],filename_str));
616 // now work out which modules, if any, want to move to the back of the queue,
617 // and if they do, move them there.
618 std::vector<std::string> put_to_back;
619 std::vector<std::string> put_to_front;
620 std::map<std::string,std::string> put_before;
621 std::map<std::string,std::string> put_after;
622 for (unsigned int j = 0; j < Config->module_names.size(); j++)
624 if (modules[j]->Prioritize() == PRIORITY_LAST)
625 put_to_back.push_back(Config->module_names[j]);
626 else if (modules[j]->Prioritize() == PRIORITY_FIRST)
627 put_to_front.push_back(Config->module_names[j]);
628 else if ((modules[j]->Prioritize() & 0xFF) == PRIORITY_BEFORE)
629 put_before[Config->module_names[j]] = Config->module_names[modules[j]->Prioritize() >> 8];
630 else if ((modules[j]->Prioritize() & 0xFF) == PRIORITY_AFTER)
631 put_after[Config->module_names[j]] = Config->module_names[modules[j]->Prioritize() >> 8];
633 for (unsigned int j = 0; j < put_to_back.size(); j++)
634 MoveToLast(put_to_back[j]);
635 for (unsigned int j = 0; j < put_to_front.size(); j++)
636 MoveToFirst(put_to_front[j]);
637 for (std::map<std::string,std::string>::iterator j = put_before.begin(); j != put_before.end(); j++)
638 MoveBefore(j->first,j->second);
639 for (std::map<std::string,std::string>::iterator j = put_after.begin(); j != put_after.end(); j++)
640 MoveAfter(j->first,j->second);
645 void InspIRCd::DoOneIteration(bool process_module_sockets)
647 /* time() seems to be a pretty expensive syscall, so avoid calling it too much.
648 * Once per loop iteration is pleanty.
653 /* Run background module timers every few seconds
654 * (the docs say modules shouldnt rely on accurate
655 * timing using this event, so we dont have to
656 * time this exactly).
661 WriteOpers("*** \002EH?!\002 -- Time is flowing BACKWARDS in this dimension! Clock drifted backwards %d secs.",abs(OLDTIME-TIME));
662 if ((TIME % 3600) == 0)
664 irc::whowas::MaintainWhoWas(TIME);
666 Timers->TickTimers(TIME);
667 if (process_module_sockets)
668 this->DoSocketTimeouts(TIME);
669 this->DoBackgroundUserStuff(TIME);
673 XLines->expire_lines();
674 FOREACH_MOD_I(this,I_OnBackgroundTimer,OnBackgroundTimer(TIME));
675 Timers->TickMissedTimers(TIME);
679 /* Call the socket engine to wait on the active
680 * file descriptors. The socket engine has everything's
681 * descriptors in its list... dns, modules, users,
682 * servers... so its nice and easy, just one call.
683 * This will cause any read or write events to be
684 * dispatched to their handlers.
686 SE->DispatchEvents();
689 bool InspIRCd::IsIdent(const char* n)
694 for (char* i = (char*)n; *i; i++)
696 if ((*i >= 'A') && (*i <= '}'))
700 if (((*i >= '0') && (*i <= '9')) || (*i == '-') || (*i == '.'))
710 bool InspIRCd::IsNick(const char* n)
716 for (char* i = (char*)n; *i; i++, p++)
718 /* "A"-"}" can occur anywhere in a nickname */
719 if ((*i >= 'A') && (*i <= '}'))
723 /* "0"-"9", "-" can occur anywhere BUT the first char of a nickname */
724 if ((((*i >= '0') && (*i <= '9')) || (*i == '-')) && (i > n))
728 /* invalid character! abort */
731 return (p < NICKMAX - 1);
738 DoOneIteration(true);
740 /* This is never reached -- we hope! */
744 /**********************************************************************************/
747 * An ircd in four lines! bwahahaha. ahahahahaha. ahahah *cough*.
750 int main(int argc, char** argv)
752 SI = new InspIRCd(argc, argv);
758 /* this returns true when all modules are satisfied that the user should be allowed onto the irc server
759 * (until this returns true, a user will block in the waiting state, waiting to connect up to the
760 * registration timeout maximum seconds)
762 bool InspIRCd::AllModulesReportReady(userrec* user)
764 if (!Config->global_implementation[I_OnCheckReady])
767 for (int i = 0; i <= this->GetModuleCount(); i++)
769 if (Config->implement_lists[i][I_OnCheckReady])
771 int res = modules[i]->OnCheckReady(user);
779 int InspIRCd::GetModuleCount()
781 return this->ModCount;
784 time_t InspIRCd::Time()