glishd.cc

This Source-Navigator, an IDE for C/C++/Fortran/Java/Tcl/PHP/Python and a host of other languages.

// $Header: /cvsroot/sourcenav/src/snavigator/demo/c++_demo/glish/clients/glishd.cc,v 1.1.1.1 2002/04/18 23:35:25 mdejong Exp $

#include "system.h"

#include <stdio.h>
#include <stdlib.h>
#include <osfcn.h>
#include <string.h>
#include <signal.h>
#include <errno.h>

#ifdef HAVE_SYS_SELECT_H
#include <sys/select.h>
#endif

#include "Glish/Dict.h"
#include "Glish/Client.h"

#include "LocalExec.h"
#include "Channel.h"
#include "Reporter.h"
#include "Socket.h"
#include "ports.h"


extern "C" {
	extern char* sys_errlist[];
	extern int chdir( const char* path );
}


inline int streq( const char* a, const char* b )
	{
	return ! strcmp( a, b );
	}


declare(PDict,LocalExec);


// A GlishDaemon can be thought of as a "thread" inside the Glish
// daemon which works on behalf of a particular Glish interpreter.

class GlishDaemon {
public:
	GlishDaemon( Client* client );
	~GlishDaemon();

	// Read and act on the next interpreter request.  Returns 0 to
	// indicate that the interpreter exited, non-zero otherwise.
	//
	// ~mask" corresponds to a select() mask previously constructed
	// using Interpreter()->AddInputMask().
	//
	// Upon return, "internal_event" will be non-zero if the received
	// event was directed to glishd itself; otherwise, "internal_event"
	// will be set to zero upon return.
	int NextRequest( fd_set* mask, GlishEvent*& internal_event );

	Client* Interpreter() const	{ return interpreter; }

	// Informs the GlishDaemon that the given client has terminated.
	// Returns non-zero if that client belonged to the GlishDaemon,
	// zero if it didn't.
	int ClientHasTerminated( int pid );

protected:
	void SetWD( Value* wd );
	void PingClient( Value* client_id );
	void CreateClient( Value* argv );
	void ShellCommand( Value* cmd );
	void KillClient( Value* client_id );
	void Probe( Value* probe_val );

	void ChangeDir();	// Change to our working-directory.

	Client* interpreter;	// Client used for connection to interpreter.
	char* work_dir;		// working-directory for this interpreter.

	// Whether we've generated an error message for a bad work_dir.
	int did_wd_msg;

	// Clients created on behalf of interpreter.
	PDict(LocalExec) clients;
	};


declare(PList,GlishDaemon);


void internal_request( GlishEvent* event );
const char* prog_name;


int main( int /* argc */, char** argv )
	{
	static char prog_name_buf[1024];
	sprintf( prog_name_buf, "%s @ %s [%d]", argv[0],
			local_host_name(), int( getpid() ) );

	prog_name = prog_name_buf;

	// First, try to grab the glishd daemon port; possession indicates
	// we're the sole daemon for this host.
	AcceptSocket a( 0, DAEMON_PORT, 0 );

	if ( a.Port() == 0 )
		{
		// Didn't get it.
		fprintf( stderr, "%s: daemon apparently already running\n",
			prog_name );
		exit( 1 );
		}

	// Add bullet-proofing for common signals.
	(void) signal( SIGINT, SIG_IGN );
	(void) signal( SIGTERM, SIG_IGN );
	(void) signal( SIGPIPE, SIG_IGN );

	// Don't let our children inherit the accept socket fd; we want
	// it to go away when we do.
	mark_close_on_exec( a.FD() );

	PList(GlishDaemon) threads;

	for ( ; ; )
		{
		fd_set input_fds;
		fd_set* mask = &input_fds;

		FD_ZERO( mask );
		FD_SET( a.FD(), mask );

		loop_over_list( threads, i )
			threads[i]->Interpreter()->AddInputMask( mask );

		while ( select( FD_SETSIZE, mask, 0, 0, 0 ) < 0 )
			{
			if ( errno != EINTR )
				{
				fprintf( stderr, "%s: ", prog_name );
				perror( "error during select()" );
				exit( 1 );
				}
			}

		// Look for any threads that have activity.
		for ( i = 0; i < threads.length(); ++i )
			{
			GlishDaemon* d = threads[i];

			if ( d->Interpreter()->HasClientInput( mask ) )
				{
				GlishEvent* internal;
				if ( ! d->NextRequest( mask, internal ) )
					{ // Delete this thread.
					threads.remove_nth( i );
					delete d;

					// Balance the loop increment since
					// we've now shortened the list.
					--i;

					continue;
					}

				if ( internal )
					internal_request( internal );
				}
			}

		// Now look for any new interpreters contacting us.
		if ( FD_ISSET( a.FD(), mask ) )
			{
			int s = accept_connection( a.FD() );

			if ( s < 0 )
				{
				fprintf( stderr, "%s: ", prog_name );
				perror( "error when accepting connection" );
				exit( 1 );
				}

			// Don't let our children inherit this socket fd; if
			// they do, then when we exit our remote Glish-
			// interpreter peers won't see select() activity
			// and detect out exit.
			mark_close_on_exec( s );

			Client* c = new Client( s, s, prog_name );
			GlishDaemon* d = new GlishDaemon( c );
			threads.append( d );
			}

		// Pick up any clients that have exited.
		int pid;

		while ( (pid = reap_terminated_process()) )
			{ // Remove terminated process from list of clients.
			loop_over_list( threads, i )
				if ( threads[i]->ClientHasTerminated( pid ) )
					break;	// no need to look further
			}
		}
	}


void internal_request( GlishEvent* event )
	{
	const char* name = event->name;

	if ( streq( name, "*terminate-daemon*" ) )
		exit( 0 );

	else
		{
		fprintf( stderr, "%s: bad internal event \"%s\"\n",
				prog_name, name );
		exit( 1 );
		}
	}


GlishDaemon::GlishDaemon( Client* client )
	{
	interpreter = client;
	work_dir = 0;
	did_wd_msg = 0;
	}

GlishDaemon::~GlishDaemon()
	{
	delete interpreter;
	delete work_dir;
	}

int GlishDaemon::NextRequest( fd_set* mask, GlishEvent*& internal_event )
	{
	internal_event = 0;

	GlishEvent* e = interpreter->NextEvent( mask );

	if ( ! e )
		return 0;

	if ( streq( e->name, "setwd" ) )
		SetWD( e->value );

	else if ( streq( e->name, "ping" ) )
		PingClient( e->value );

	else if ( streq( e->name, "client" ) )
		CreateClient( e->value );

	else if ( streq( e->name, "shell" ) )
		ShellCommand( e->value );

	else if ( streq( e->name, "kill" ) )
		KillClient( e->value );

	else if ( streq( e->name, "probe" ) )
		Probe( e->value );

	else if ( e->name[0] == '*' )
		// Internal event for glishd itself.
		internal_event = e;

	else
		interpreter->Unrecognized();

	return 1;
	}

int GlishDaemon::ClientHasTerminated( int pid )
	{
	IterCookie* c = clients.InitForIteration();

	const char* key;
	LocalExec* exec;
	while ( (exec = clients.NextEntry( key, c )) )
		if ( exec->PID() == pid )
			{
			char* client_key = clients.Remove( key );
			delete client_key;
			return 1;
			}

	return 0;
	}

void GlishDaemon::SetWD( Value* v )
	{
	delete work_dir;
	did_wd_msg = 0;
	work_dir = v->StringVal();

	ChangeDir();	// try it out to see if it's okay
	}

void GlishDaemon::PingClient( Value* client_id )
	{
	char* id = client_id->StringVal();
	LocalExec* client = clients[id];

	if ( ! client )
		error->Report( "no such client ", id );
	else
		client->Ping();

	delete id;
	}


void GlishDaemon::CreateClient( Value* argv )
	{
	argv->Polymorph( TYPE_STRING );

	int argc = argv->Length();

	if ( argc <= 1 )
		{
		error->Report(
			"no arguments given for creating remote client" );
		return;
		}

	// First strip off the id.
	charptr* argv_ptr = argv->StringPtr();
	char* client_id = strdup( argv_ptr[0] );

	--argc;
	++argv_ptr;

	charptr* client_argv = new charptr[argc + 1];

	for ( int i = 0; i < argc; ++i )
		client_argv[i] = argv_ptr[i];

	client_argv[argc] = 0;

	const char* exec_name = which_executable( client_argv[0] );
	if ( ! exec_name )
		error->Report( "no such executable ", client_argv[0] );

	else
		{
		ChangeDir();

		LocalExec* exec = new LocalExec( exec_name, client_argv );

		if ( exec->ExecError() )
			error->Report( "problem exec'ing client ", 
				client_argv[0], ": ", sys_errlist[errno] );

		clients.Insert( client_id, exec );
		}

	delete client_argv;
	}


void GlishDaemon::ShellCommand( Value* cmd )
	{
	char* command;
	if ( ! cmd->FieldVal( "command", command ) )
		error->Report( "remote glishd received bad shell command:",
				cmd );

	char* input;
	if ( ! cmd->FieldVal( "input", input ) )
		input = 0;

	ChangeDir();

	FILE* shell = popen_with_input( command, input );

	if ( ! shell )
		{
		Value F( glish_false );
		interpreter->PostEvent( "fail", &F );
		}
	else
		{
		// ### This is an awful lot of events; much simpler would
		// be to slurp up the entire output into an array of strings
		// and send that back.  Value::AssignElements makes this
		// easy since it will grow the array as needed.  The
		// entire result could then be stuffed into a record.

		Value T( glish_true );

		interpreter->PostEvent( "okay", &T );
		char line_buf[8192];

		while ( fgets( line_buf, sizeof( line_buf ), shell ) )
			interpreter->PostEvent( "shell_out", line_buf );

		interpreter->PostEvent( "done", &T );

		// Cfront, in its infinite bugginess, complains about
		// "int assigned to enum glish_bool" if we use
		//
		//	Value status_val( pclose( shell ) );
		//
		// here, so instead we create status_val dynamically.

		Value* status_val = new Value( pclose_with_input( shell ) );

		interpreter->PostEvent( "status", status_val );

		Unref( status_val );
		}

	delete command;
	delete input;
	}


void GlishDaemon::KillClient( Value* client_id )
	{
	char* id = client_id->StringVal();
	LocalExec* client = clients[id];

	if ( ! client )
		error->Report( "no such client ", id );

	else
		{
		delete client;
		char* client_key = clients.Remove( id );
		delete client_key;
		}

	delete id;
	}


void GlishDaemon::Probe( Value* /* probe_val */ )
	{
	interpreter->PostEvent( "probe-reply", false_value );
	}

void GlishDaemon::ChangeDir()
	{
	if ( chdir( work_dir ) < 0 && ! did_wd_msg )
		{
		error->Report( "couldn't change to directory ", work_dir, ": ",
					sys_errlist[errno] );
		did_wd_msg = 1;
		}
	}