]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - .inspircd.inc
Take advantage of link errors to check API_VERSION at module load time
[user/henk/code/inspircd.git] / .inspircd.inc
index 33626b1f333594c9a73d929dda5dc472cb5d0cbc..91a06ccfd6430f849f13abb93f05fcd5eb749851 100644 (file)
@@ -3,38 +3,80 @@
 #       | Inspire Internet Relay Chat Daemon |
 #       +------------------------------------+
 #
-#  InspIRCd: (C) 2002-2008 InspIRCd Development Team
-# See: http://www.inspircd.org/wiki/index.php/Credits
+#  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+# See: http://wiki.inspircd.org/Credits
 #
 # This program is free but copyrighted software; see
 #          the file COPYING for details.
 #
 # ---------------------------------------------------
 #
+use strict;
 use POSIX;
+use Fcntl;
 
 my $basepath   =       "@BASE_DIR@";
 my $confpath   =       "@CONFIG_DIR@/";
 my $binpath    =       "@BINARY_DIR@";
-my $libpath    =       "@LIBRARY_DIR@";
 my $valgrindlogpath    =       "$basepath/valgrindlogs";
 my $executable =       "@EXECUTABLE@";
 my $version    =       "@VERSION@";
-my @filesparsed;
-my @filechecked;
 
+our($pid,$pidfile);
 # Lets see what they want to do.. Set the variable (Cause i'm a lazy coder)
-my $arg = $ARGV[0];
-getpidfile($confpath."inspircd.conf");
-
-if ($arg eq "start") { start(); exit(); }
-if ($arg eq "debug") { debug(); exit(); }
-if ($arg eq "screendebug") { screendebug(); exit() }
-if ($arg eq "valdebug") { valdebug(); exit(); }
-if ($arg eq "valdebug-unattended") { valdebugunattended(); exit(); }
-if ($arg eq "screenvaldebug") { screenvaldebug(); exit(); }
-if ($arg eq "stop") { stop(); exit(); }
-if ($arg eq "status") {
+my $arg = shift(@ARGV);
+my $conf;
+for my $a (@ARGV)
+{
+       if ($a =~ m/^--config=(.*)$/)
+       {
+               $conf = $1;
+               last;
+       }
+}
+if (!defined $conf) {
+       $conf = $confpath . "inspircd.conf";
+       push @ARGV, '--config='.$conf;
+}
+
+getpidfile($conf);
+
+# System for naming script command subs:
+# cmd_<name> - Normal command for use by users.
+# dev_<name> - Developer commands.
+# hid_<name> - Hidden commands (ie Cheese-Sandwich)
+# Ideally command subs shouldn't return.
+
+my $subname = $arg;
+$subname =~ s/-/_/g;
+my $sub = main->can("cmd_$subname") || main->can("dev_$subname") || main->can("hid_$subname");
+if (!defined($sub))
+{
+       print STDERR "Invalid command or none given.\n";
+       cmd_help();
+       exit 1;
+}
+else
+{
+       $sub->(@ARGV);
+       exit 0;
+}
+
+sub cmd_help()
+{
+       my @subs = grep { $_ =~ m/^(cmd|dev)_/ && defined(main->can($_)) } keys(%::);
+       my @cmds = grep /^cmd_/, @subs;
+       my @devs = grep /^dev_/, @subs;
+       local $_;
+       $_ =~ s/^(cmd|dev)_// foreach (@cmds, @devs);
+       $_ =~ s/_/-/g foreach (@cmds, @devs);
+       print STDERR "Usage: ./inspircd (" . join("|", @cmds) . ")\n";
+       print STDERR "Developer arguments: (" . join("|", @devs) . ")\n";
+       exit 0;
+}
+
+sub cmd_status()
+{
        if (getstatus() == 1) {
                my $pid = getprocessid();
                print "InspIRCd is running (PID: $pid)\n";
@@ -44,7 +86,9 @@ if ($arg eq "status") {
                exit();
        }
 }
-if ($arg eq "rehash") {
+
+sub cmd_rehash()
+{
        if (getstatus() == 1) {
                my $pid = getprocessid();
                system("kill -HUP $pid >/dev/null 2>&1");
@@ -56,59 +100,46 @@ if ($arg eq "rehash") {
        }
 }
 
-if ($arg eq "cron") {
-       if (getstatus() == 0) { start(); }
+sub cmd_cron()
+{
+       if (getstatus() == 0) { goto &cmd_start(); }
        exit();
 }
 
-if ($arg eq "version") {
+sub cmd_version()
+{
        print "InspIRCd version: $version\n";
        exit();
 }
 
-if ($arg eq "restart") {
-       stop();
+sub cmd_restart(@)
+{
+       cmd_stop();
        unlink($pidfile) if (-e $pidfile);
-       start();
-       # kthxbye();
-       exit();
+       goto &cmd_start;
 }
 
-if ($arg eq "checkconf") {
-       checkconf();
-       exit();
-}
-
-if ($arg eq "Cheese-Sandwich") {
+sub hid_cheese_sandwich()
+{
        print "Creating Cheese Sandwich..\n";
        print "Done.\n";
        exit();
 }
 
-###
-# If we get here.. bad / no parameters.
-###
-print "Invalid Argument: $arg\n";
-print "Usage: inspircd (start|stop|restart|rehash|status|cron|checkconf|version)\n";
-print "Developer arguments: (debug|screendebug|valdebug|valdebug-unattended|screenvaldebug)\n";
-exit();
-
-###
-# Generic Helper Functions.
-###
-
-sub start {
+sub cmd_start(@)
+{
        # Check to see its not 'running' already.
        if (getstatus() == 1) { print "InspIRCd is already running.\n"; return 0; }
        # If we are still alive here.. Try starting the IRCd..
        print "$binpath/$executable doesn't exist\n" and return 0 unless(-e "$binpath/$executable");
        print "$binpath/$executable is not executable\n" and return 0 unless(-f "$binpath/$executable" && -x "$binpath/$executable");
 
-       system("$binpath/$executable");
-       return 1;
+       exec { "$binpath/$executable" } "$binpath/$executable", @_;
+       die "Failed to start IRCd: $!\n";
 }
 
-sub debug {
+sub dev_debug(@)
+{
        # Check to see its not 'running' already.
        if (getstatus() == 1) { print "InspIRCd is already running.\n"; return 0; }
 
@@ -119,10 +150,11 @@ sub debug {
        checkgdb();
 
        # If we are still alive here.. Try starting the IRCd..
-       system("gdb --command=$basepath/.gdbargs --args $binpath/$executable -nofork -debug");
+       exec 'gdb', "--command=$basepath/.gdbargs", '--args', "$binpath/$executable", qw(-nofork -debug), @_;
+       die "Failed to start GDB: $!\n";
 }
 
-sub screendebug
+sub dev_screendebug(@)
 {
        # Check to see its not 'running' already.
        if (getstatus() == 1) { print "InspIRCd is already running.\n"; return 0; }
@@ -136,10 +168,11 @@ sub screendebug
        # If we are still alive here.. Try starting the IRCd..
        print "Starting InspIRCd in `screen`, type `screen -r` when the ircd crashes to view the gdb output and get a backtrace.\n";
        print "Once you're inside the screen session press ^C + d to re-detach from the session\n";
-       system("screen -m -d gdb --command=$basepath/.gdbargs --args $binpath/$executable -nofork -debug -nolog");
+       exec qw(screen -m -d gdb), "--comand=$basepath/.gdbargs", '-args', "$binpath/$executable", qw(-nofork -debug -nolog), @_;
+       die "Failed to start screen: $!\n";
 }
 
-sub valdebug
+sub dev_valdebug(@)
 {
        # Check to see its not 'running' already.
        if (getstatus() == 1) { print "InspIRCd is already running.\n"; return 0; }
@@ -154,10 +187,11 @@ sub valdebug
        # If we are still alive here.. Try starting the IRCd..
        # May want to do something with these args at some point: --suppressions=.inspircd.sup --gen-suppressions=yes
        # Could be useful when we want to stop it complaining about things we're sure aren't issues.
-       system("valgrind -v --tool=memcheck --leak-check=yes --db-attach=yes --num-callers=10 $binpath/$executable -nofork -debug -nolog");
+       exec qw(valgrind -v --tool=memcheck --leak-check=yes --db-attach=yes --num-callers=10), "$binpath/$executable", qw(-nofork -debug -nolog), @_;
+       die "Failed to start valgrind: $!\n";
 }
 
-sub valdebugunattended
+sub dev_valdebug_unattended(@)
 {
        # NOTE: To make sure valgrind generates coredumps, set soft core limit in /etc/security/limits.conf to unlimited
        # Check to see its not 'running' already.
@@ -171,8 +205,6 @@ sub valdebugunattended
        checkgdb();
 
        # If we are still alive here.. Try starting the IRCd..
-       # May want to do something with these args at some point: --suppressions=.inspircd.sup --gen-suppressions=yes
-       # Could be useful when we want to stop it complaining about things we're sure aren't issues.
        #
        # NOTE: Saving the debug log (redirected stdout), while useful, is a potential security risk AND one hell of a spacehog. DO NOT SAVE THIS WHERE EVERYONE HAS ACCESS!
        # Redirect stdout to /dev/null if you're worried about the security.
@@ -180,18 +212,23 @@ sub valdebugunattended
        my $pid = fork;
        if ($pid == 0) {
                POSIX::setsid();
-               use Fcntl;
                -d $valgrindlogpath or mkdir $valgrindlogpath or die "Cannot create $valgrindlogpath: $!\n";
+               -e "$binpath/valgrind.sup" or do { open my $f, '>', "$binpath/valgrind.sup"; };
                my $suffix = strftime("%Y%m%d-%H%M%S", localtime(time)) . ".$$";
                open STDIN, '<', '/dev/null' or die "Can't redirect STDIN to /dev/null: $!\n";
                sysopen STDOUT, "$valgrindlogpath/out.$suffix", O_WRONLY | O_CREAT | O_NOCTTY | O_APPEND, 0600 or die "Can't open $valgrindlogpath/out.$suffix: $!\n";
                sysopen STDERR, "$valgrindlogpath/valdebug.$suffix", O_WRONLY | O_CREAT | O_NOCTTY | O_APPEND, 0666 or die "Can't open $valgrindlogpath/valdebug.$suffix: $!\n";
-               exec "valgrind -v --tool=memcheck --leak-check=yes --num-callers=10 --time-stamp=yes --log-fd=2 $binpath/$executable -nofork -debug -nolog";
+       # May want to do something with these args at some point: --suppressions=.inspircd.sup --gen-suppressions=yes
+       # Could be useful when we want to stop it complaining about things we're sure aren't issues.
+               exec qw(valgrind -v --tool=memcheck --leak-check=full --show-reachable=yes --num-callers=15 --track-fds=yes),
+                       "--suppressions=$binpath/valgrind.sup", qw(--gen-suppressions=all),
+                       qw(--leak-resolution=med --time-stamp=yes --log-fd=2 --),
+                       "$binpath/$executable", qw(-nofork -debug -nolog), @_;
                die "Can't execute valgrind: $!\n";
        }
 }
 
-sub screenvaldebug
+sub dev_screenvaldebug(@)
 {
        # Check to see its not 'running' already.
        if (getstatus() == 1) { print "InspIRCd is already running.\n"; return 0; }
@@ -207,27 +244,34 @@ sub screenvaldebug
        # If we are still alive here.. Try starting the IRCd..
        print "Starting InspIRCd in `screen`, type `screen -r` when the ircd crashes to view the valgrind and gdb output and get a backtrace.\n";
        print "Once you're inside the screen session press ^C + d to re-detach from the session\n";
-       system("screen -m -d valgrind -v --tool=memcheck --leak-check=yes --db-attach=yes --num-callers=10 $binpath/$executable -nofork -debug -nolog");
+       exec qw(screen -m -d valgrind -v --tool=memcheck --leak-check=yes --db-attach=yes --num-callers=10), "$binpath/$executable", qw(-nofork -debug -nolog), @_;
+       die "Failed to start screen: $!\n";
 }
 
-sub stop {
+sub cmd_stop()
+{
        if (getstatus() == 0) { print "InspIRCd is not running. (Or PID File not found)\n"; return 0; }
        # Get to here, we have something to kill.
        my $pid = getprocessid();
        print "Stopping InspIRCd (pid: $pid)...\n";
-       my $maxwait = (`ps -o command $pid` =~ /valgrind/i) ? 30 : 5;
-       kill TERM => $pid;
+       my $maxwait = (`ps -o command $pid` =~ /valgrind/i) ? 90 : 5;
+       kill TERM => $pid or die "Cannot terminate IRCd: $!\n";
        for (1..$maxwait) {
                sleep 1;
-               if (getstatus() == 1) {
+               if (getstatus() == 0) {
                        print "InspIRCd Stopped.\n";
                        return;
                }
        }
        print "InspIRCd not dying quietly -- forcing kill\n";
        kill KILL => $pid;
+       return 0;
 }
 
+###
+# Generic Helper Functions.
+###
+
 # GetPidfile Version 2 - Now With Include Support..
 # I beg for months for include support in insp, then..
 # when it is added, it comes around and BITES ME IN THE ASS,
@@ -240,7 +284,10 @@ sub stop {
 # defined, but defined in a comment (line starts with #)
 # -- Brain
 
-sub getpidfile {
+my %filesparsed;
+
+sub getpidfile
+{
        my ($file) = @_;
        # Before we start, do we have a PID already? (Should never occur)
        if ($pid ne "") {
@@ -253,18 +300,11 @@ sub getpidfile {
        }
 
        # Have we checked this file before?
-       for (my $i = 0; $i < $filesparsed; $i++) {
-               if ($filesparsed[$i] eq $file) {
-                       # Already Parsed, Possible recursive loop..
-                       return;
-               }
-       }
-
-       # If we get here, Mark as 'Read'
-       $filesparsed[$filesparsed] = $file;
+       return if $filesparsed{$file};
+       $filesparsed{$file} = 1;
 
        # Open the File..
-       open INFILE, "< $file" or die "Unable to open file $file\n";
+       open INFILE, "< $file" or die "Unable to open file $file included in configuration\n";
        # Grab entire file contents..
        my(@lines) = <INFILE>;
        # Close the file
@@ -272,7 +312,7 @@ sub getpidfile {
 
        # remove trailing spaces
        chomp(@lines);
-       foreach $i (@lines) {
+       for my $i (@lines) {
                # clean it up
                $i =~ s/[^=]+=\s(.*)/\1/;
                # Does this file have a pid?
@@ -280,18 +320,43 @@ sub getpidfile {
                {
                        # Set the PID file and return.
                        $pidfile = $1;
+                       if (-f $pidfile)
+                       {
+                               return;
+                       }
+                       else
+                       {
+                               if (-f $confpath . $pidfile)
+                               {
+                                       $pidfile = $confpath . $pidfile;
+                                       return;
+                               }
+                       }
                        return;
                }
        }
 
+
        # If we get here, NO PID FILE! -- Check for includes
-       foreach $i (@lines) {
+       for my $i (@lines) {
                $i =~ s/[^=]+=\s(.*)/\1/;
                if (($i =~ s/\<include file=\"(.+?)\"\>//i) && ($i !~ /^#/))
                {
                        # Decend into that file, and check for PIDs.. (that sounds like an STD ;/)
                        getpidfile($1);
                        # Was a PID found?
+                       if (-f $pidfile)
+                       {
+                               return;
+                       }
+                       else
+                       {
+                               if (-f $confpath . $pidfile)
+                               {
+                                       $pidfile = $confpath . $pidfile;
+                                       return;
+                               }
+                       }
                        if ($pidfile ne "") {
                                # Yes, Return.
                                return;
@@ -313,9 +378,9 @@ sub getstatus {
 sub getprocessid {
        my $pid;
        open PIDFILE, "< $pidfile" or return 0;
-       while($i = <PIDFILE>)
+       while(<PIDFILE>)
        {
-               $pid = $i;
+               $pid = $_;
        }
        close PIDFILE;
        return $pid;
@@ -353,13 +418,16 @@ sub checkxmllint
        open(FH, "xmllint|") or die "Couldn't start xmllint: $!\n";
 }
 
-sub checkconf
+sub cmd_checkconf()
 {
        checkxmllint();
-       validateconf($confpath."inspircd.conf");
+       validateconf($conf);
        print "Config check complete\n";
+       exit 0;
 }
 
+my %filechecked;
+
 sub validateconf
 {
        my ($file) = @_;
@@ -371,15 +439,8 @@ sub validateconf
        }
 
        # Have we checked this file before?
-       for (my $i = 0; $i < $filechecked; $i++) {
-               if ($filechecked[$i] eq $file) {
-                       # Already Parsed, Possible recursive loop..
-                       return;
-               }
-       }
-
-       # If we get here, Mark as 'Read'
-       $filechecked[$filechecked] = $file;
+       return if $filechecked{$file};
+       $filechecked{$file} = 1;
 
        # Open the File..
        open INFILE, "< $file" or die "Unable to open file $file\n";
@@ -399,7 +460,7 @@ sub validateconf
 #       push @newlines, "<!DOCTYPE config SYSTEM \"".$confpath."inspircd.dtd\">";
        push @newlines, "<config>";
 
-       foreach $i (@lines)
+       for my $i (@lines)
        {
                # remove trailing newlines
                chomp($i);
@@ -497,7 +558,7 @@ sub validateconf
                $tmpfile = tmpnam();
        } until sysopen(TF, $tmpfile, O_RDWR|O_CREAT|O_EXCL|O_NOFOLLOW, 0700);
 
-       foreach $n (@newlines)
+       for my $n (@newlines)
        {
                print TF "$n\n";
        }
@@ -507,7 +568,7 @@ sub validateconf
        chomp(@result);
 
        my $skip = 0;
-       foreach $n (@result)
+       for my $n (@result)
        {
                if ($skip)
                {