telnetbbs/telnetbbs.pl - diff

Return to telnetbbs.pl CVS log

Up to [Local Repository] / telnetbbs

Diff for /telnetbbs/telnetbbs.pl between versions 1.4 and 1.10

version 1.4, 2010/12/10 23:28:09	version 1.10, 2010/12/17 20:15:24
Line 13 BEGIN {	Line 13 BEGIN {
delete @ENV{qw(IFS CDPATH ENV BASH_ENV PATH)};	delete @ENV{qw(IFS CDPATH ENV BASH_ENV PATH)};
$ENV{PATH} = "/bin:/usr/bin";	$ENV{PATH} = "/bin:/usr/bin";
$\|++;	$\|++;
# Flip this back on for more detailed error reporting
# $SIG{__DIE__} = sub { require Carp; Carp::confess(@_); }	# $SIG{__DIE__} = sub { require Carp; Carp::confess(@_); }
}	}

Line 30 use threads;	Line 29 use threads;
use threads::shared;	use threads::shared;

##	##
## Fetch our command line options	## Fetch our command line and configuration options
##	##
my %opts = &fetchOptions( );	my %opts = &fetchOptions( );
my $pidFile = "/var/run/telnetbbs.pid";	my %cfg = &fetchConfig( );
my $EOL = "\015\012";	my $EOL = "\015\012";

##	##
## These will be moved in to a config file	## These are read in from the config file
##	##
my $DISPLAY = ":0.0";	my $BBS_NODE = 0;
my $BBS_NAME = "Hell's Dominion BBS";	my $pidFile = $cfg{'pidfile'} \|\| "/tmp/telnetbbs.pid";
my $BBS_NODE = 0;	my $port = $opts{'port'} \|\| $cfg{'port'} \|\| 23;
my $DBCONF = "/tmp/dosbox-__NODE__.conf";	my $DISPLAY = $cfg{'display'} \|\| ":0.0";
my $BBS_CMD = "DISPLAY=$DISPLAY /usr/bin/dosbox -conf ";	my $BBS_NAME = $cfg{'bbs_name'} \|\| "Hell's Dominion BBS";
my $LOG = "/var/log/bbs.log";	my $DBCONF = $cfg{'dosbox_cfg'} \|\| "/tmp/dosbox-__NODE__.conf";
my $MAX_NODE = 1;	my $BBS_CMD = $cfg{'bbs_cmd'} \|\| "DISPLAY=__DISPLAY__ /usr/bin/dosbox -conf ";
my $DOSBOXT = "dosbox.conf.template";	my $LOGGING = $cfg{'logging'} \|\| 0;
my $BASE_PORT = 5000;	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'	## Check that we are 'root'
##	##
die( "Must be root user to run this.\n" )	die( "Must be root user to run this.\n" )
if ( getpwuid( $> ) ne "root" );	if ( getpwuid( $> ) ne "root" && $port < 1023 );

##	##
## Check for a PID	## Check for a PID
Line 74 local $SIG{HUP} = $SIG{INT} = $SIG{TERM	Line 78 local $SIG{HUP} = $SIG{INT} = $SIG{TERM
##	##
## Open the Log	## Open the Log
##	##
#open LOG, ">>$LOG";	open LOG, ">>$LOG" if ( $LOGGING );
&logmsg( "Starting telnetbbs server" );	&logmsg( "Starting telnetbbs server" );

##	##
	## Display running information
	##
	&display_config_and_options( \%opts, "Options" );
	&display_config_and_options( \%cfg, "Configuration" );

	##
## Start the network server	## Start the network server
##	##
my $netThread = threads->create( \&startNetServer( ) );	my $netThread = threads->create( \&startNetServer( ) );
Line 96 while( 1 ) { sleep 1; }	Line 106 while( 1 ) { sleep 1; }
## Sub-routines begin here	## 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( );	## startNetServer( );
Line 111 sub startNetServer	Line 158 sub startNetServer
{	{
my $hostConnection;	my $hostConnection;
my $childPID;	my $childPID;
my $port = $opts{'port'} \|\| 23;
my @nodes = ( );	my @nodes = ( );

my $server = IO::Socket::INET->new(	my $server = IO::Socket::INET->new(
Line 134 sub startNetServer	Line 180 sub startNetServer
## Find the next available node	## Find the next available node
##	##
my $node = 0;	my $node = 0;
foreach (1 .. $MAX_NODE)	my $lock_file = "";
	my $cnt = 0;
	while ( ! $node && $cnt < $MAX_NODE )
{	{
next if ( $node );	$cnt++;
if ( ! $nodes[$_] )	$lock_file = $LOCK_PATH . "/" . $BBS_NAME .
{	"_node" . $cnt . ".lock";
$node = $BBS_NODE = $_;	print "Checking for node lock: $lock_file\n";
$nodes[$node]++;	next if ( -f $lock_file );
}
	##
	## Create node lock file
	##
	open LOCK, ">$lock_file";
	close( LOCK );
	$BBS_NODE = $node = $cnt;
	print "Using node: $node\n";
}	}

print STDOUT "Node Status: \n" . Dumper( @nodes );

##	##
## Create our dosbox config	## Create our dosbox config
##	##
Line 175 print STDOUT "Node Status: \n" . Dumper(	Line 228 print STDOUT "Node Status: \n" . Dumper(
}	}
defined( $childPID ) \|\| die( "Cannot fork: $!\n" );	defined( $childPID ) \|\| die( "Cannot fork: $!\n" );

	select $hostConnection;

##	##
## Default file descriptor to the client and turn on autoflush	## Default file descriptor to the client and turn on autoflush
##	##
$hostConnection->autoflush( 1 );	$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;	exit;
}	}

print $hostConnection "Starting BBS on node $BBS_NODE...$EOL";	print "Starting BBS on node $BBS_NODE...$EOL";

##	##
## Launch BBS via dosbox	## Launch BBS via dosbox
Line 197 print STDOUT "Node Status: \n" . Dumper(	Line 252 print STDOUT "Node Status: \n" . Dumper(
my $bbsPID = fork( );	my $bbsPID = fork( );
if ( $bbsPID )	if ( $bbsPID )
{	{
	select STDOUT;
my $cmd = $BBS_CMD . $DBCONF;	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;	exit;
}	}

Line 229 print STDOUT "Node Status: \n" . Dumper(	Line 295 print STDOUT "Node Status: \n" . Dumper(
print $hostConnection $byte;	print $hostConnection $byte;
}	}
$nodes[$BBS_NODE] = 0;	$nodes[$BBS_NODE] = 0;
print "Post-Disconnect Node Status: \n" . Dumper( @nodes );
kill( "TERM" => $kidpid );	kill( "TERM" => $kidpid );
}	}
else	else
Line 244 print "Post-Disconnect Node Status: \n"	Line 309 print "Post-Disconnect Node Status: \n"
unlink( $DBCONF );	unlink( $DBCONF );
}	}
close( $hostConnection );	close( $hostConnection );
exit;	close( $server );

# close( $server );	exit;
}	}

###############################################################################	###############################################################################
Line 262 sub shutdown	Line 327 sub shutdown
{	{
my $signame = shift \|\| 0;	my $signame = shift \|\| 0;

	select STDOUT;

&logmsg( "$0: Shutdown (SIG$signame) received.\n" )	&logmsg( "$0: Shutdown (SIG$signame) received.\n" )
if( $signame );	if( $signame );

##	##
## Close Log	## Close Log
##	##
close( LOG );	close( LOG ) if ( $LOGGING );

##	##
## Remove the PID	## Remove the PID
Line 276 sub shutdown	Line 343 sub shutdown
unlink( $pidFile );	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	## Wait for the thread to shutdown
##	##
# $netThread->detach( );	# $netThread->detach( );
Line 384 sub processExists	Line 460 sub processExists
return 0;	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( <CONF> )
	{
	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;
	}

###############################################################################	###############################################################################
##	##
Line 396 sub fetchOptions {	Line 530 sub fetchOptions {
my %opts;	my %opts;

&GetOptions(	&GetOptions(
	"config:s" => \$opts{'config'},
"help\|?" => \$opts{'help'},	"help\|?" => \$opts{'help'},
"man" => \$opts{'man'},	"man" => \$opts{'man'},
"port:i" => \$opts{'port'},	"port:i" => \$opts{'port'},
	"verbose" => \$opts{'verbose'},
) \|\| &pod2usage( );	) \|\| &pod2usage( );
&pod2usage( ) if defined $opts{'help'};	&pod2usage( ) if defined $opts{'help'};
&pod2usage( { -verbose => 2, -input => \*DATA } ) if defined $opts{'man'};	&pod2usage( { -verbose => 2, -input => \*DATA } ) if defined $opts{'man'};
Line 417 telnetbbs.pl - A telnet server designed	Line 553 telnetbbs.pl - A telnet server designed
telnetbbs.pl [options]	telnetbbs.pl [options]

Options:	Options:
	--config,c Specify the configuration file to use
--help,? Display the basic help menu	--help,? Display the basic help menu
--man,m Display the detailed man page	--man,m Display the detailed man page
--port,p Port to listen on, default 23.	--port,p Port to listen on, default 23.
	--verbose,v Enable verbose output

=head1 DESCRIPTION	=head1 DESCRIPTION

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.4
changed lines
	Added in v.1.10