Re: [mh] Process_item_queue <more partly solved>

=head1 B<Process_Item_queue>

=head2 SYNOPSIS

  
=head2 DESCRIPTION

use this object to add process items to a queue. 
This version has a single queue called @process_item_queue, the next item on the queue is forked when the previous one finishes

=head2 INHERITS

<>

=head2 METHODS

add_process_item_to_queue add a process item to the queue, passed the  Process_item 
check_process_item_queue This is called regularly to see if it has any items to process on the queue

=over

=cut

#-----------------------------------------------------------------------
# tests
#-----------------------------------------------------------------------
# noloop=start
$my_test1 = new Voice_Cmd 'test [1,2,3,4]';
my $v_check_process_queue = new Voice_Cmd 'process queue';

$p_longproc = new Process_Item;
set $p_longproc $config_parms{"code_dir"} . "/procs/longproc.sh";
$p_longproc->set_output( $config_parms{data_dir} . "/logs/longproc.txt" );
set_timeout $p_longproc 15;

$p_longproc1 = new Process_Item;
set $p_longproc1 $config_parms{"code_dir"} . "/procs/longproc1.sh";
$p_longproc1->set_output( $config_parms{data_dir} . "/logs/longproc1.txt" );
set_timeout $p_longproc1 15;

# noloop=stop

if ( $state = said $my_test1) {
	if ( $state == 1 ) {
		set $p_longproc $config_parms{"code_dir"}
		  . "/procs/longproc.sh 12 \"test with a quote\"";
		set_timeout $p_longproc 15;
		add_process_item_to_queue($p_longproc);
	}
	elsif ( $state == 2 ) {
		set $p_longproc1 $config_parms{"code_dir"} . "/procs/longproc1.sh 12";
		set_timeout $p_longproc1 15;
		add_process_item_to_queue($p_longproc1);

	}

	elsif ( $state == 3 ) {
		purge_process_item_queue();
	}
	elsif ( $state == 4 ) {

	}
}

if ( done_now $p_longproc) {
	print_log( "Longproc done", "INFORMATIONAL", "p_longproc" );
	if ( timed_out $p_longproc) {
		print_log( 'timed out', "ERROR", "p_longproc" );
	}
	print_process_log( "longproc.txt", "p_longproc" );
}

if ( done_now $p_longproc1) {
	print_log( "Longproc1 done", "INFORMATIONAL", "p_longproc1" );
	if ( timed_out $p_longproc1) {
		print_log( 'timed out', "ERROR", "p_longproc1" );
	}
	print_process_log( "longproc1.txt", "p_longproc1" );
}

#-----------------------------------------------------------------------
# every  seconds check the queue
#-----------------------------------------------------------------------

#if ($New_Second) {
if ( $state = said $v_check_process_queue) {
	check_process_item_queue();
}

#-----------------------------------------------------------------------
# globals
#-----------------------------------------------------------------------

#-----------------------------------------------------------------------
# Add a process item to the queue
#-----------------------------------------------------------------------

sub add_process_item_to_queue {
	my $this_process_object = $_[0];

	if ( $this_process_object->{cmd_index} > 1 ) {
		print_log(
			substr( $this_process_object->{object_name}, 1 )
			  . " has more than one command so cannot be queued",
			"WARNING", "add_process_item_to_queue"
		);
		return;
	}
	else {
		print_log(
			"Adding "
			  . substr( $this_process_object->{object_name}, 1 ) . " cmds"
			  . $this_process_object->{cmds}[0]
			  . " timeout"
			  . $this_process_object->{timeout}
			  . " to the queue",
			"INFORMATIONAL", "add_process_item_to_queue"
		);
	}

	my $no_of_queued_items = scalar scalar @process_item_queue;
	$process_item_queue[$no_of_queued_items]{process_name} =
	  substr( $this_process_object->{object_name}, 1 );
	$process_item_queue[$no_of_queued_items]{cmds} =
	  $this_process_object->{cmds}[0];
	$process_item_queue[$no_of_queued_items]{cmds} =~ s/\"/\\\"/g;
	$process_item_queue[$no_of_queued_items]{timeout} =
	  $this_process_object->{timeout};
	$process_item_queue[$no_of_queued_items]{queued_time} =
	  time();
	$process_item_queue[$no_of_queued_items]{status} = "waiting";
}

#-----------------------------------------------------------------------
# delete a process item from the queue,
# passed the index of the item in the queue starting at 0
#-----------------------------------------------------------------------

sub delete_process_item_from_queue {
	my $row_to_delete      = $_[0];
	my $no_of_queued_items = scalar scalar @process_item_queue;
	if ( $row_to_delete < 0 || $row_to_delete > $no_of_queued_items ) {
		print_log(
			$row_to_delete . "is out of range  0 to " . $no_of_queued_items,
			"WARNING", "delete_process_item_from_queue" );

	}
	print_log( "Deleting " . $row_to_delete . " from the queue",
		"INFORMATIONAL", "delete_process_item_from_queue" );

	splice @process_item_queue, $row_to_delete, 1;
	return;
}

#-----------------------------------------------------------------------
# check the process_item_queue
# if the previous one is done, delete it and action the next
#-----------------------------------------------------------------------
sub check_process_item_queue {

	my (
		$this_queued_process_name, $this_queued_process,
		$this_process_object,      $next_process_object
	);
	my $count_items_in_queue = scalar @process_item_queue;
	if ( $count_items_in_queue == 0 ) {

		# queue is empty
		return;
	}
	else {
		print_log(
			"there are  " . $count_items_in_queue . " items in the queue",
			"INFORMATIONAL", "check_process_item_queue" );
		my $last_queued_process_name = "";

		# sort the queue on process_name and the time it was put on the queue
		my @sortedq =
		  sort {
			$a->{process_name} cmp $b->{process_name}
			  || $a->{queued_time} <=> $b->{queued_time}
		  } @process_item_queue;
		@process_item_queue = @sortedq;

		# go through the sorted list
		# if its running, go to next item
		# if this is the first instance of a process; if its not started, then start it
		# if its finished delete it test the next one of this name
		for ( my $i = 0; $i < $count_items_in_queue; $i++ ) {
			$this_queued_process_name = $process_item_queue[$i]{process_name};
			print_log(
				"Checking "
				  . $this_queued_process_name
				  . " queued at "
				  . datestamp_to_hms( $process_item_queue[$i]{queued_time} ),
				"INFORMATIONAL", "check_process_item_queue"
			);
			if ( $this_queued_process_name ne $last_queued_process_name ) {
				$last_queued_process_name = $this_queued_process_name;

				# this is the first  ocurrence of this process in the queue
				# has it finished, if not go to the next item on the queue
				print_log(
					"first time check for "
					  . $this_queued_process_name
					  . " queued at "
					  . datestamp_to_hms(
						$process_item_queue[$i]{queued_time} ),
					"INFORMATIONAL", "check_process_item_queue"
				);
				$this_process_object =
				  get_object_by_name($this_queued_process_name);

				# has the process started
				if ( $process_item_queue[$i]{status} eq "waiting" )
				{    # this process hasnt started, so start it and move on
					print_log(
						$this_queued_process_name
						  . " has not started, starting it and moving on",
						"INFORMATIONAL", "check_process_item_queue"
					);
					start_process_object(
						$process_item_queue[$i]{process_name},
						$process_item_queue[$i]{cmds},
						$process_item_queue[$i]{timeout}
					);
					$process_item_queue[$i]{status} = "running";
					next;
				}

				# has it finished
				if ( !defined( $this_process_object->{done} )
					&& $process_item_queue[$i]{status} eq "running" )
				{
					print_log( $this_queued_process_name . " is still running",
						"INFORMATIONAL", "check_process_item_queue" );

					# this process is still running, move onto next one

					next;
				}
				else {
					# this process has finished, delete it
					$process_item_queue[$i]{status} = "finished";
					print_log(
						$this_queued_process_name . " finished, deleting it",
						"INFORMATIONAL", "check_process_item_queue" );
					if ( $count_items_in_queue == 1 ) {
						print_log(
							$this_queued_process_name
							  . " finished, purging queue",
							"INFORMATIONAL", "check_process_item_queue"
						);
						purge_process_item_queue();
					}
					else {
						print_log(
							$this_queued_process_name
							  . " finished, deleting it",
							"INFORMATIONAL", "check_process_item_queue"
						);
						delete_process_item_from_queue($i);

						$i--;
						$count_items_in_queue--;
					}
					next;
				}

			}
		}
		return;
	}

}

#-----------------------------------------------------------------------
# start a process item given its name, cmds and timeout
#-----------------------------------------------------------------------
sub start_process_object {
	my ( $this_process_name, $this_process_cmds, $this_process_timeout ) = @_;
	my $command;
	$command =
	  "set \$" . $this_process_name . " \"" . $this_process_cmds . "\";";
	print_log( "running " . $command, "INFORMATIONAL", "start_process_name" );
	eval $command;
	$command =
	  "set_timeout \$" . $this_process_name . " " . $this_process_timeout . ";";
	print_log( "running " . $command, "INFORMATIONAL", "start_process_object" );
	eval $command;
	$command = "start \$" . $this_process_name . ";";
	print_log( "running " . $command, "INFORMATIONAL", "start_process_object" );
	eval $command;
	return;
}

#-----------------------------------------------------------------------
# purge process item queue
#-----------------------------------------------------------------------
sub purge_process_item_queue {
	print_log( "Purging process item queue ",
		"INFORMATIONAL", "purge_process_item_queue" );
	@process_item_queue = ();
	return;
}
########################################################################
# History:
# 19-02-2021 new code
# 20-02-2021 fixed for changes on each queue entry

#!/bin/sh
# shell to sleep
now=$(date +"%T")
if [ -z ${1+x} ]; 
  then sleeptime=1; 
  else sleeptime=$1; 
fi
echo "$now longproc start $sleeptime second sleep string = $2  pid= $$"
sleep $sleeptime
now=$(date +"%T")
echo "$now longproc end"
exit 0