--- telnetbbs/telnetbbs.pl 2010/01/11 05:02:27 1.3 +++ telnetbbs/telnetbbs.pl 2010/12/20 20:51:39 1.11 @@ -6,14 +6,13 @@ ## ## Nicholas DeClario ## October 2009 -## $Id: telnetbbs.pl,v 1.3 2010/01/11 05:02:27 nick Exp $ +## $Id: telnetbbs.pl,v 1.11 2010/12/20 20:51:39 nick Exp $ ## ################################################################################ BEGIN { delete @ENV{qw(IFS CDPATH ENV BASH_ENV PATH)}; $ENV{PATH} = "/bin:/usr/bin"; $|++; -# Flip this back on for more detailed error reporting # $SIG{__DIE__} = sub { require Carp; Carp::confess(@_); } } @@ -30,31 +29,35 @@ use threads; use threads::shared; ## -## Fetch our command line options +## Fetch our command line and configuration options ## my %opts = &fetchOptions( ); -my $pidFile = "/var/run/telnetbbs.pid"; -my @nodes = ( ); +my %cfg = &fetchConfig( ); my $EOL = "\015\012"; ## -## These will be moved in to a config file +## These are read in from the config file ## -my $DISPLAY = ":1018.0"; -my $BBS_NAME = "Hell's Dominion BBS"; -my $BBS_NODE = 0; -my $DBCONF = "/tmp/dosbox-__NODE__.conf"; -my $BBS_CMD = "DISPLAY=$DISPLAY /usr/bin/dosbox -conf "; -my $LOG = "/var/log/bbs.log"; -my $MAX_NODE = 6; -my $DOSBOXT = "dosbox.conf.template"; -my $BASE_PORT = 5000; +my $BBS_NODE = 0; +my $pidFile = $cfg{'pidfile'} || "/tmp/telnetbbs.pid"; +my $port = $opts{'port'} || $cfg{'port'} || 23; +my $DISPLAY = $cfg{'display'} || ":0.0"; +my $BBS_NAME = $cfg{'bbs_name'} || "Hell's Dominion BBS"; +my $DBCONF = $cfg{'dosbox_cfg'} || "/tmp/dosbox-__NODE__.conf"; +my $BBS_CMD = $cfg{'bbs_cmd'} || "DISPLAY=__DISPLAY__ /usr/bin/dosbox -conf "; +my $LOGGING = $cfg{'logging'} || 0; +my $LOG = $cfg{'log_path'} || "/tmp/bbs.log"; +my $MAX_NODE = $cfg{'nodes'} || 1; +my $DOSBOXT = $cfg{'dosboxt'} || "dosbox.conf.template"; +my $BASE_PORT = $cfg{'base_port'} || 7000; +my $LOCK_PATH = $cfg{'lock_path'} || "/tmp"; + $BBS_CMD =~ s/__DISPLAY__/$DISPLAY/g; ## ## Check that we are 'root' ## die( "Must be root user to run this.\n" ) - if ( getpwuid( $> ) ne "root" ); + if ( getpwuid( $> ) ne "root" && $port < 1023 ); ## ## Check for a PID @@ -75,13 +78,20 @@ local $SIG{HUP} = $SIG{INT} = $SIG{TERM ## ## Open the Log ## -#open LOG, ">>$LOG"; +open LOG, ">>$LOG" if ( $LOGGING ); &logmsg( "Starting telnetbbs server" ); ## +## Display running information +## +&display_config_and_options( \%opts, "Options" ); +&display_config_and_options( \%cfg, "Configuration" ); + +## ## Start the network server ## -my $netThread = threads->create( \&startNetServer ); +my $netThread = threads->create( \&startNetServer( ) ); + while( 1 ) { sleep 1; } @@ -96,9 +106,46 @@ while( 1 ) { sleep 1; } ## Sub-routines begin here ## ############################################################################### + + +############################################################################### +## +## &logmsg( "string" ); +## +## This takes a string and prepends the process name, ID and timestamp +## to the message. It then displays it to STDOUT and logs it if enabled. +## ############################################################################### +sub logmsg +{ + my $message = "$0 $$ " . scalar( localtime( ) ) . ":@_\n"; + print STDOUT $message; + print LOG $message if ( $LOGGING ); +} -sub logmsg { print "$0 $$ ", scalar localtime, ":@_\n" } + +############################################################################### +## +## &display_config_and_options( %hash ); +## +## This will display via Data::Dumper a hash that is passed to it. +## If verbose is enabled it will got to STDOUT and if logging is enabled +## it will be logged. +## +## This is called only once during startup. +## +############################################################################### +sub display_config_and_options +{ + my $hr = shift || 0; + my $name = shift || "Unknown"; + my $title = "Displaying $name\n"; + + return $hr if ( ! $hr ); + + print LOG $title . Dumper( $hr ) if ( $LOGGING ); + print STDOUT $title . Dumper( $hr ) if ( $opts{'verbose'}); +} ############################################################################### ## startNetServer( ); @@ -111,7 +158,7 @@ sub startNetServer { my $hostConnection; my $childPID; - my $port = $opts{'port'} || 23; + my @nodes = ( ); my $server = IO::Socket::INET->new( LocalPort => $port, @@ -133,14 +180,23 @@ sub startNetServer ## Find the next available node ## my $node = 0; - foreach (1 .. $MAX_NODE) + my $lock_file = ""; + my $cnt = 0; + while ( ! $node && $cnt < $MAX_NODE ) { - next if ( $node ); - if ( ! $nodes[$_] ) - { - $node = $BBS_NODE = $_; - $nodes[$_]++; - } + $cnt++; + $lock_file = $LOCK_PATH . "/" . $BBS_NAME . + "_node" . $cnt . ".lock"; +print "Checking for node lock: $lock_file\n"; + next if ( -f $lock_file ); + + ## + ## Create node lock file + ## + open LOCK, ">$lock_file"; + close( LOCK ); + $BBS_NODE = $node = $cnt; +print "Using node: $node\n"; } ## @@ -150,7 +206,7 @@ sub startNetServer my @dbt = ; close( DBT ); - my $bpn = $BASE_PORT + $BBS_NODE; + my $bpn = $BASE_PORT + $BBS_NODE - 1; $DBCONF =~ s/__NODE__/$BBS_NODE/g; open( DBC, ">$DBCONF" ); foreach( @dbt ) @@ -172,21 +228,23 @@ sub startNetServer } defined( $childPID ) || die( "Cannot fork: $!\n" ); + select $hostConnection; + ## ## Default file descriptor to the client and turn on autoflush ## $hostConnection->autoflush( 1 ); - print $hostConnection "Welcome to $BBS_NAME!" . $EOL; + print "Welcome to $BBS_NAME!" . $EOL; ## - if ( ! $BBS_NODE ) + if ( ! $node ) { - print $hostConnection "No available nodes. Try again later.".$EOL; + print "No available nodes. Try again later.".$EOL; exit; } - print $hostConnection "Starting BBS on node $BBS_NODE...$EOL"; + print "Starting BBS on node $BBS_NODE...$EOL"; ## ## Launch BBS via dosbox @@ -194,8 +252,19 @@ sub startNetServer my $bbsPID = fork( ); if ( $bbsPID ) { + select STDOUT; my $cmd = $BBS_CMD . $DBCONF; - exec( $cmd ); + system( $cmd ); + print "Shutting down node $BBS_NODE\n"; + + ## + ## Remove Lock + ## + unlink( $lock_file ); + unlink( $DBCONF ); + close( $hostConnection ); + close( $server ); + kill( "TERM" => $bbsPID ); exit; } @@ -225,7 +294,8 @@ sub startNetServer { print $hostConnection $byte; } - kill( "TERM" => $childPID ); + $nodes[$BBS_NODE] = 0; + kill( "TERM" => $kidpid ); } else { @@ -239,9 +309,9 @@ sub startNetServer unlink( $DBCONF ); } close( $hostConnection ); - exit; + close( $server ); -# close( $server ); + exit; } ############################################################################### @@ -257,13 +327,15 @@ sub shutdown { my $signame = shift || 0; + select STDOUT; + &logmsg( "$0: Shutdown (SIG$signame) received.\n" ) if( $signame ); ## ## Close Log ## - close( LOG ); + close( LOG ) if ( $LOGGING ); ## ## Remove the PID @@ -271,6 +343,15 @@ sub shutdown unlink( $pidFile ); ## + ## Remove node lock files + ## + foreach (1 .. $MAX_NODE) + { + my $node_lock = $LOCK_PATH."/".$BBS_NAME."_node".$_.".lock"; + unlink( $node_lock ) if ( -f $node_lock ); + } + + ## ## Wait for the thread to shutdown ## # $netThread->detach( ); @@ -379,6 +460,64 @@ sub processExists return 0; } +############################################################################### +## +## %config_hash = &fetchConfig( ); +## +## This reads in a file in the format of "key = value" and stores them +## in to a hash of $hash{$key} = $value. Lines starting with '#' are +## considered comments and ignored. +## +############################################################################### +sub fetchConfig +{ + my %conf = ( ); + my $cf = &findConfig; + + if ( $cf ) + { + open( CONF, "<$cf" ) or die ( "Error opening $cf: $!\n" ); + while( ) + { + next if ( $_ =~ m/^#/ ); + if ( $_ =~ m/(.*?)=(.*)/ ) + { + my $k = $1; my $v = $2; + $k =~ s/\s+//; + $v =~ s/\s+//; + $conf{$k} = $v; + } + } + close( CONF ); + } + + return %conf; +} + +############################################################################### +## +## my $file = &fetchConfig( ); +## +## This function will look for 'telnetbbs.conf' or whatever was specified +## on the command line. It will search the @paths below for the default +## filename if none is specifed. +## +############################################################################### +sub findConfig +{ + my $cf = 0; + my @paths = qw| ./ ./.telnetbbs /etc /usr/local/etc |; + + return $opts{'config'} if defined $opts{'config'}; + + foreach ( @paths ) + { + my $fn = $_ . "/telnetbbs.conf"; + return $fn if ( -f $fn ); + } + + return $cf; +} ############################################################################### ## @@ -391,9 +530,11 @@ sub fetchOptions { my %opts; &GetOptions( + "config:s" => \$opts{'config'}, "help|?" => \$opts{'help'}, "man" => \$opts{'man'}, "port:i" => \$opts{'port'}, + "verbose" => \$opts{'verbose'}, ) || &pod2usage( ); &pod2usage( ) if defined $opts{'help'}; &pod2usage( { -verbose => 2, -input => \*DATA } ) if defined $opts{'man'}; @@ -412,9 +553,11 @@ telnetbbs.pl - A telnet server designed telnetbbs.pl [options] Options: + --config,c Specify the configuration file to use --help,? Display the basic help menu --man,m Display the detailed man page --port,p Port to listen on, default 23. + --verbose,v Enable verbose output =head1 DESCRIPTION