.inspircd.inc

   1 #!/usr/bin/perl
   2 #       +------------------------------------+
   3 #       | Inspire Internet Relay Chat Daemon |
   4 #       +------------------------------------+
   5 #
   6 #      (C) 2002-2008 InspIRCd Development Team
   7 #   http://www.inspircd.org/wiki/index.php/Credits
   8 #
   9 # Written by Craig Edwards, Craig McLure, and others.
  10 # This program is free but copyrighted software; see
  11 #            the file COPYING for details.
  12 #
  13 # ---------------------------------------------------
  14 use POSIX;
  15
  16 my $basepath    =       "@BASE_DIR@";
  17 my $confpath    =       "@CONFIG_DIR@/";
  18 my $binpath     =       "@BINARY_DIR@";
  19 my $libpath     =       "@LIBRARY_DIR@";
  20 my $valgrindlogpath     =       "$basepath/valgrindlogs";
  21 my $executable  =       "@EXECUTABLE@";
  22 my $version     =       "@VERSION@";
  23 my @filesparsed;
  24 my @filechecked;
  25
  26 # Lets see what they want to do.. Set the variable (Cause i'm a lazy coder)
  27 my $arg = $ARGV[0];
  28 getpidfile($confpath."inspircd.conf");
  29
  30 if ($arg eq "start") { start(); exit(); }
  31 if ($arg eq "debug") { debug(); exit(); }
  32 if ($arg eq "screendebug") { screendebug(); exit() }
  33 if ($arg eq "valdebug") { valdebug(); exit(); }
  34 if ($arg eq "valdebug-unattended") { valdebugunattended(); exit(); }
  35 if ($arg eq "screenvaldebug") { screenvaldebug(); exit(); }
  36 if ($arg eq "stop") { stop(); exit(); }
  37 if ($arg eq "status") {
  38         if (getstatus() == 1) {
  39                 my $pid = getprocessid();
  40                 print "InspIRCd is running (PID: $pid)\n";
  41                 exit();
  42         } else {
  43                 print "InspIRCd is not running. (Or PID File not found)\n";
  44                 exit();
  45         }
  46 }
  47 if ($arg eq "rehash") {
  48         if (getstatus() == 1) {
  49                 my $pid = getprocessid();
  50                 system("kill -HUP $pid >/dev/null 2>&1");
  51                 print "InspIRCd rehashed (pid: $pid).\n";
  52                 exit();
  53         } else {
  54                 print "InspIRCd is not running. (Or PID File not found)\n";
  55                 exit();
  56         }
  57 }
  58
  59 if ($arg eq "cron") {
  60         if (getstatus() == 0) { start(); }
  61         exit();
  62 }
  63
  64 if ($arg eq "version") {
  65         print "InspIRCd version: $version\n";
  66         exit();
  67 }
  68
  69 if ($arg eq "restart") {
  70         stop();
  71         unlink($pidfile) if (-e $pidfile);
  72         start();
  73         # kthxbye();
  74         exit();
  75 }
  76
  77 if ($arg eq "checkconf") {
  78         checkconf();
  79         exit();
  80 }
  81
  82 if ($arg eq "Cheese-Sandwich") {
  83         print "Creating Cheese Sandwich..\n";
  84         print "Done.\n";
  85         exit();
  86 }
  87
  88 ###
  89 # If we get here.. bad / no parameters.
  90 ###
  91 print "Invalid Argument: $arg\n";
  92 print "Usage: inspircd (start|stop|restart|rehash|status|cron|checkconf|version)\n";
  93 print "Developer arguments: (debug|screendebug|valdebug|valdebug-unattended|screenvaldebug)\n";
  94 exit();
  95
  96 ###
  97 # Generic Helper Functions.
  98 ###
  99
 100 sub start {
 101         # Check to see its not 'running' already.
 102         if (getstatus() == 1) { print "InspIRCd is already running.\n"; return 0; }
 103         # If we are still alive here.. Try starting the IRCd..
 104         print "$binpath/$executable doesn't exist\n" and return 0 unless(-e "$binpath/$executable");
 105         print "$binpath/$executable is not executable\n" and return 0 unless(-f "$binpath/$executable" && -x "$binpath/$executable");
 106
 107         system("$binpath/$executable");
 108         return 1;
 109 }
 110
 111 sub debug {
 112         # Check to see its not 'running' already.
 113         if (getstatus() == 1) { print "InspIRCd is already running.\n"; return 0; }
 114
 115         print "$binpath/$executable doesn't exist\n" and return 0 unless(-e "$binpath/$executable");
 116         print "$binpath/$executable is not executable\n" and return 0 unless(-f "$binpath/$executable" && -x "$binpath/$executable");
 117
 118         # Check we have gdb
 119         checkgdb();
 120
 121         # If we are still alive here.. Try starting the IRCd..
 122         system("gdb --command=$basepath/.gdbargs --args $binpath/$executable -nofork -debug");
 123 }
 124
 125 sub screendebug
 126 {
 127         # Check to see its not 'running' already.
 128         if (getstatus() == 1) { print "InspIRCd is already running.\n"; return 0; }
 129
 130         print "$binpath/$executable doesn't exist\n" and return 0 unless(-e "$binpath/$executable");
 131
 132         #Check we have gdb
 133         checkgdb();
 134         checkscreen();
 135
 136         # If we are still alive here.. Try starting the IRCd..
 137         print "Starting InspIRCd in `screen`, type `screen -r` when the ircd crashes to view the gdb output and get a backtrace.\n";
 138         print "Once you're inside the screen session press ^C + d to re-detach from the session\n";
 139         system("screen -m -d gdb --command=$basepath/.gdbargs --args $binpath/$executable -nofork -debug -nolog");
 140 }
 141
 142 sub valdebug
 143 {
 144         # Check to see its not 'running' already.
 145         if (getstatus() == 1) { print "InspIRCd is already running.\n"; return 0; }
 146
 147         print "$binpath/$executable doesn't exist\n" and return 0 unless(-e "$binpath/$executable");
 148         print "$binpath/$executable is not executable\n" and return 0 unless(-f "$binpath/$executable" && -x "$binpath/$executable");
 149
 150         # Check we have valgrind and gdb
 151         checkvalgrind();
 152         checkgdb();
 153
 154         # If we are still alive here.. Try starting the IRCd..
 155         # May want to do something with these args at some point: --suppressions=.inspircd.sup --gen-suppressions=yes
 156         # Could be useful when we want to stop it complaining about things we're sure aren't issues.
 157         system("valgrind -v --tool=memcheck --leak-check=yes --db-attach=yes --num-callers=10 $binpath/$executable -nofork -debug -nolog");
 158 }
 159
 160 sub valdebugunattended
 161 {
 162         # NOTE: To make sure valgrind generates coredumps, set soft core limit in /etc/security/limits.conf to unlimited
 163         # Check to see its not 'running' already.
 164         if (getstatus() == 1) { print "InspIRCd is already running.\n"; return 0; }
 165
 166         print "$binpath/$executable doesn't exist\n" and return 0 unless(-e "$binpath/$executable");
 167         print "$binpath/$executable is not executable\n" and return 0 unless(-f "$binpath/$executable" && -x "$binpath/$executable");
 168
 169         # Check we have valgrind and gdb
 170         checkvalgrind();
 171         checkgdb();
 172
 173         # If we are still alive here.. Try starting the IRCd..
 174         # May want to do something with these args at some point: --suppressions=.inspircd.sup --gen-suppressions=yes
 175         # Could be useful when we want to stop it complaining about things we're sure aren't issues.
 176         #
 177         # 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!
 178         # Redirect stdout to /dev/null if you're worried about the security.
 179         #
 180         # Note the & at the end. We *must* detach otherwise the script hangs.
 181         system("valgrind -v --tool=memcheck --leak-check=yes --num-callers=10 --time-stamp=yes --log-file=$valgrindlogpath/valdebug.%p $binpath/$executable -nofork -debug -nolog >> $basepath/valdebug.insp.out &");
 182         # Sleep 5 seconds to give valgrind time to initialize before chmodding the logdir for apache access.
 183         sleep(5);
 184         system("chmod 644 $valgrindlogpath/*");
 185 }
 186
 187 sub screenvaldebug
 188 {
 189         # Check to see its not 'running' already.
 190         if (getstatus() == 1) { print "InspIRCd is already running.\n"; return 0; }
 191
 192         print "$binpath/$executable doesn't exist\n" and return 0 unless(-e "$binpath/$executable");
 193         print "$binpath/$executable is not executable\n" and return 0 unless(-f "$binpath/$executable" && -x "$binpath/$executable");
 194
 195         #Check we have gdb
 196         checkvalgrind();
 197         checkgdb();
 198         checkscreen();
 199
 200         # If we are still alive here.. Try starting the IRCd..
 201         print "Starting InspIRCd in `screen`, type `screen -r` when the ircd crashes to view the valgrind and gdb output and get a backtrace.\n";
 202         print "Once you're inside the screen session press ^C + d to re-detach from the session\n";
 203         system("screen -m -d valgrind -v --tool=memcheck --leak-check=yes --db-attach=yes --num-callers=10 $binpath/$executable -nofork -debug -nolog");
 204 }
 205
 206 sub stop {
 207         if (getstatus() == 0) { print "InspIRCd is not running. (Or PID File not found)\n"; return 0; }
 208         # Get to here, we have something to kill.
 209         my $pid = getprocessid();
 210         print "Stopping InspIRCd (pid: $pid)...\n";
 211         system("kill -TERM $pid >/dev/null 2>&1");
 212         # Give it twenty seconds to exit, otherwise valgrind can't write out all output before being killed -9
 213         # TODO make this a variable number based on if it's valgrind or normal start.
 214         sleep(20);
 215         if (getstatus() == 1)
 216         {
 217                 print "InspIRCd not dying quietly -- forcing kill\n";
 218                 system("kill -9 $pid >/dev/null 2>&1");
 219         }
 220         print "InspIRCd Stopped.\n";
 221 }
 222
 223 # GetPidfile Version 2 - Now With Include Support..
 224 # I beg for months for include support in insp, then..
 225 # when it is added, it comes around and BITES ME IN THE ASS,
 226 # because i then have to code support into this script.. Evil.
 227
 228 # Craig got bitten in the ass again --
 229 # in 1.1 beta the include file is manditory, therefore
 230 # if we cant find it, default to %conf%/inspircd.pid.
 231 # Note, this also contains a fix for when the pid file is
 232 # defined, but defined in a comment (line starts with #)
 233 # -- Brain
 234
 235 sub getpidfile {
 236   my ($file) = @_;
 237   # Before we start, do we have a PID already? (Should never occur)
 238   if ($pid ne "") {
 239     return;
 240   }
 241   # Are We using a relative path?
 242   if ($file !~ /^\//) {
 243     # Convert it to a full path..
 244     $file = $confpath . $file;
 245   }
 246
 247   # Have we checked this file before?
 248   for (my $i = 0; $i < $filesparsed; $i++) {
 249     if ($filesparsed[$i] eq $file) {
 250       # Already Parsed, Possible recursive loop..
 251       return;
 252     }
 253   }
 254
 255   # If we get here, Mark as 'Read'
 256   $filesparsed[$filesparsed] = $file;
 257
 258   # Open the File..
 259   open INFILE, "< $file" or die "Unable to open file $file\n";
 260   # Grab entire file contents..
 261   my(@lines) = <INFILE>;
 262   # Close the file
 263   close INFILE;
 264
 265   # remove trailing spaces
 266   chomp(@lines);
 267   foreach $i (@lines) {
 268     # clean it up
 269     $i =~ s/[^=]+=\s(.*)/\1/;
 270     # Does this file have a pid?
 271     if (($i =~ /<pid file=\"(\S+)\">/i) && ($i !~ /^#/))
 272     {
 273       # Set the PID file and return.
 274       $pidfile = $1;
 275       return;
 276     }
 277   }
 278
 279   # If we get here, NO PID FILE! -- Check for includes
 280   foreach $i (@lines) {
 281     $i =~ s/[^=]+=\s(.*)/\1/;
 282     if (($i =~ s/\<include file=\"(.+?)\"\>//i) && ($i !~ /^#/))
 283     {
 284       # Decend into that file, and check for PIDs.. (that sounds like an STD ;/)
 285       getpidfile($1);
 286       # Was a PID found?
 287       if ($pidfile ne "") {
 288         # Yes, Return.
 289         return;
 290       }
 291     }
 292   }
 293
 294   # End of includes / No includes found. Using default.
 295   $pidfile = $confpath . "inspircd.pid";
 296 }
 297
 298 sub getstatus {
 299         my $pid = getprocessid();
 300         if ($pid == 0) { return 0; }
 301         $status = system("kill -0 $pid >/dev/null 2>&1") / 256;
 302         if ($status == 0) { return 1; }
 303         else { return 0; }
 304 }
 305
 306
 307 sub getprocessid {
 308         my $pid;
 309         open PIDFILE, "< $pidfile" or return 0;
 310         while($i = <PIDFILE>)
 311         {
 312                 $pid = $i;
 313         }
 314         close PIDFILE;
 315         return $pid;
 316 }
 317
 318 sub checkvalgrind
 319 {
 320         unless(`valgrind --version`)
 321         {
 322                 print "Couldn't start valgrind: $!\n";
 323                 exit;
 324         }
 325 }
 326
 327 sub checkgdb
 328 {
 329         unless(`gdb --version`)
 330         {
 331                 print "Couldn't start gdb: $!\n";
 332                 exit;
 333         }
 334 }
 335
 336 sub checkscreen
 337 {
 338         unless(`screen --version`)
 339         {
 340                 print "Couldn't start screen: $!\n";
 341                 exit;
 342         }
 343 }
 344
 345 sub checkxmllint
 346 {
 347         open(FH, "xmllint|") or die "Couldn't start xmllint: $!\n";
 348 }
 349
 350 sub checkconf
 351 {
 352         checkxmllint();
 353         validateconf($confpath."inspircd.conf");
 354         print "Config check complete\n";
 355 }
 356
 357 sub validateconf
 358 {
 359         my ($file) = @_;
 360
 361         # Are We using a relative path?
 362         if ($file !~ /^\//) {
 363                 # Convert it to a full path..
 364                 $file = $confpath . $file;
 365         }
 366
 367         # Have we checked this file before?
 368         for (my $i = 0; $i < $filechecked; $i++) {
 369                 if ($filechecked[$i] eq $file) {
 370                         # Already Parsed, Possible recursive loop..
 371                         return;
 372                 }
 373         }
 374
 375         # If we get here, Mark as 'Read'
 376         $filechecked[$filechecked] = $file;
 377
 378         # Open the File..
 379         open INFILE, "< $file" or die "Unable to open file $file\n";
 380         # Grab entire file contents..
 381         my(@lines) = <INFILE>;
 382         # Close the file
 383         close INFILE;
 384
 385         # remove trailing spaces
 386         chomp(@lines);
 387
 388         my @newlines = ();
 389         my @blanks = ();
 390         my $conline;
 391
 392         push @newlines, "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>";
 393 #       push @newlines, "<!DOCTYPE config SYSTEM \"".$confpath."inspircd.dtd\">";
 394         push @newlines, "<config>";
 395
 396         foreach $i (@lines)
 397         {
 398                 # remove trailing newlines
 399                 chomp($i);
 400
 401                 # convert tabs to spaces
 402                 $i =~ s/\t/ /g;
 403
 404                 # remove leading spaces
 405                 $i =~ s/^ *//;
 406
 407                 # remove comments
 408                 $i =~ s/^#.*//;
 409
 410                 # remove trailing #s
 411                 $i =~ s/(.*)#$/\1/;
 412
 413                 # remove trailing comments
 414                 my $line = "";
 415                 my $quote = 0;
 416                 for (my $j = 0; $j < length($i); $j++)
 417                 {
 418                         if (substr($i,$j, 1) eq '"') { $quote = ($quote) ? 0 : 1; } elsif (substr($i,$j, 1) eq "#" && !$quote) { last; }
 419                         $line .= substr($i,$j, 1);
 420                 }
 421                 $i = $line;
 422
 423                 # remove trailing spaces
 424                 $i =~ s/ *$//;
 425
 426                 # setup incf for include check and clean it up, since this breaks parsing use local var
 427                 my $incf = $i;
 428                 $incf =~ s/[^=]+=\s(.*)/\1/;
 429
 430                 # include file?
 431                 if (($incf =~ s/\<include file=\"(.+?)\"\>//i) && ($incf !~ /^#/))
 432                 {
 433                         # yes, process it
 434                         validateconf($1);
 435                 }
 436
 437                 if ($i =~ /^<.*/ && $conline =~ /^<.*/)
 438                 {
 439                         push @newlines, $conline;
 440                         push @newlines, @blanks;
 441                         $conline = $i;
 442                 }
 443
 444                 if ($i =~ /^<.*>$/)
 445                 {
 446                         $i =~ s/(.*)>$/\1 \/>/;
 447                         push @newlines, $i;
 448                 }
 449                 elsif ($i =~ /.*>$/)
 450                 {
 451                         $conline .= " $i";
 452                         $conline =~ s/(.*)>$/\1 \/>/;
 453                         push @blanks, "";
 454                         push @newlines, $conline;
 455                         push @newlines, @blanks;
 456                         $conline = "";
 457                         undef @blanks;
 458                 }
 459                 elsif ($i =~ /^<.*/)
 460                 {
 461                         $conline = $i;
 462                 }
 463                 elsif ($conline =~ /^<.*/ && $i)
 464                 {
 465                         $conline .= " $i";
 466                         push @blanks, "";
 467                 }
 468                 else
 469                 {
 470                         if ($conline)
 471                         {
 472                                 push @blanks, $i;
 473                         }
 474                         else
 475                         {
 476                                 push @newlines, $i;
 477                         }
 478                 }
 479         }
 480         if ($conline)
 481         {
 482                 push @newlines, $conline;
 483                 push @newlines, @blanks;
 484         }
 485
 486         push @newlines, "</config>";
 487
 488         my $tmpfile;
 489         do
 490         {
 491                 $tmpfile = tmpnam();
 492         } until sysopen(TF, $tmpfile, O_RDWR|O_CREAT|O_EXCL|O_NOFOLLOW, 0700);
 493
 494         foreach $n (@newlines)
 495         {
 496                 print TF "$n\n";
 497         }
 498         close TF;
 499
 500         my @result = `xmllint -noout $tmpfile 2>&1`;
 501         chomp(@result);
 502
 503         my $skip = 0;
 504         foreach $n (@result)
 505         {
 506                 if ($skip)
 507                 {
 508                         $skip = 0;
 509                         next;
 510                 }
 511                 $n =~ s/$tmpfile\:\d*\: *//g;
 512                 if ($n =~ /.*config>.*/)
 513                 {
 514                         $n = "";
 515                         $skip = 1;
 516                 }
 517
 518                 if ($n && !$skip)
 519                 {
 520                         if ($n =~ /line \d*/)
 521                         {
 522                                 my $lineno = $n;
 523                                 $lineno =~ s/.*line (\d*).*/\1/;
 524                                 $lineno = $lineno-2;
 525                                 $n =~ s/line (\d*)/line $lineno/;
 526                         }
 527                         print "$file : $n\n";
 528                 }
 529         }
 530         unlink($tmpfile);
 531 }