Files
scripts/Perl OTRS/Kernel/System/Daemon/DaemonModules/SchedulerGenericAgentTaskManager.pm
2024-10-14 00:08:40 +02:00

156 lines
3.8 KiB
Perl

# --
# Copyright (C) 2001-2019 OTRS AG, https://otrs.com/
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (GPL). If you
# did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.
# --
package Kernel::System::Daemon::DaemonModules::SchedulerGenericAgentTaskManager;
use strict;
use warnings;
use utf8;
use parent qw(Kernel::System::Daemon::BaseDaemon);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::System::Cache',
'Kernel::System::CronEvent',
'Kernel::System::DB',
'Kernel::System::Daemon::SchedulerDB',
'Kernel::System::GenericAgent',
'Kernel::System::Log',
);
=head1 NAME
Kernel::System::Daemon::DaemonModules::SchedulerGenericAgentTaskManager - daemon to manage scheduler generic agent tasks
=head1 DESCRIPTION
Scheduler generic agent task daemon
=head1 PUBLIC INTERFACE
=head2 new()
Create scheduler future task manager object.
=cut
sub new {
my ( $Type, %Param ) = @_;
# Allocate new hash for object.
my $Self = {};
bless $Self, $Type;
# Get objects in constructor to save performance.
$Self->{CacheObject} = $Kernel::OM->Get('Kernel::System::Cache');
$Self->{GenericAgentObject} = $Kernel::OM->Get('Kernel::System::GenericAgent');
$Self->{DBObject} = $Kernel::OM->Get('Kernel::System::DB');
$Self->{SchedulerDBObject} = $Kernel::OM->Get('Kernel::System::Daemon::SchedulerDB');
# Disable in memory cache to be clusterable.
$Self->{CacheObject}->Configure(
CacheInMemory => 0,
CacheInBackend => 1,
);
# Get the NodeID from the SysConfig settings, this is used on High Availability systems.
$Self->{NodeID} = $Kernel::OM->Get('Kernel::Config')->Get('NodeID') || 1;
# Check NodeID, if does not match is impossible to continue.
if ( $Self->{NodeID} !~ m{ \A \d+ \z }xms && $Self->{NodeID} > 0 && $Self->{NodeID} < 1000 ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "NodeID '$Self->{NodeID}' is invalid!",
);
return;
}
# Do not change the following values!
$Self->{SleepPost} = 20; # sleep 20 seconds after each loop
$Self->{Discard} = 60 * 60; # discard every hour
$Self->{DiscardCount} = $Self->{Discard} / $Self->{SleepPost};
$Self->{Debug} = $Param{Debug};
$Self->{DaemonName} = 'Daemon: SchedulerGenericAgentTaskManager';
return $Self;
}
sub PreRun {
my ( $Self, %Param ) = @_;
# Check if database is on-line.
return 1 if $Self->{DBObject}->Ping();
sleep 10;
return;
}
sub Run {
my ( $Self, %Param ) = @_;
return if !$Self->{SchedulerDBObject}->GenericAgentTaskToExecute(
NodeID => $Self->{NodeID},
PID => $$,
);
return 1;
}
sub PostRun {
my ( $Self, %Param ) = @_;
sleep $Self->{SleepPost};
$Self->{DiscardCount}--;
# Unlock long locked tasks.
$Self->{SchedulerDBObject}->RecurrentTaskUnlockExpired(
Type => 'GenericAgent',
);
# Remove obsolete tasks before destroy.
if ( $Self->{DiscardCount} == 0 ) {
$Self->{SchedulerDBObject}->GenericAgentTaskCleanup();
if ( $Self->{Debug} ) {
print " $Self->{DaemonName} will be stopped and set for restart!\n";
}
}
return if $Self->{DiscardCount} <= 0;
return 1;
}
sub Summary {
my ( $Self, %Param ) = @_;
return $Self->{SchedulerDBObject}->GenericAgentTaskSummary();
}
sub DESTROY {
my $Self = shift;
return 1;
}
1;
=head1 TERMS AND CONDITIONS
This software is part of the OTRS project (L<https://otrs.org/>).
This software comes with ABSOLUTELY NO WARRANTY. For details, see
the enclosed file COPYING for license information (GPL). If you
did not receive this file, see L<https://www.gnu.org/licenses/gpl-3.0.txt>.
=cut