oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

cleaned up some spectre code and fixed a few bugs

Browse source
This commit is contained in:
JT Smith 2006-07-03 19:22:14 +00:00
parent 2b9efcb217
commit d95fbffa39
5 changed files with 75 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/changelog/7.x.x.txt
View file

@ -19,4 +19,5 @@
- fix: Edit LDAP Connection - fix: Edit LDAP Connection
- fix: SQL Report w/ pagination and nested queries - fix: SQL Report w/ pagination and nested queries
- fix: Unable to add Web Services Client - fix: Unable to add Web Services Client
- Fixed a bug in spectre where it wasn't using session cookies.

2
lib/Spectre/Admin.pm
View file

@ -153,7 +153,7 @@ sub new {
args=>[["shutdown","ping"]] args=>[["shutdown","ping"]]
); );
$self->{_workflow} = Spectre::Workflow->new($config, $logger, $debug); $self->{_workflow} = Spectre::Workflow->new($config, $logger, $debug);
$self->{_cron} = Spectre::Cron->new($config, $logger, $self->{_workflow}, $debug); $self->{_cron} = Spectre::Cron->new($config, $logger, $debug);
POE::Kernel->run(); POE::Kernel->run();
} }

142
lib/Spectre/Cron.pm
View file

@ -137,8 +137,9 @@ An integer (1,2,3) that determines what priority the workflow should be executed
sub addJob { sub addJob {
my ($self, $params) = @_[OBJECT, ARG0]; my ($self, $params) = @_[OBJECT, ARG0];
return 0 unless ($params->{enabled}); return 0 unless ($params->{enabled});
my $id = $params->{config}."-".$params->{taskId};
$self->debug("Adding schedule ".$params->{taskId}." to the queue."); $self->debug("Adding schedule ".$params->{taskId}." to the queue.");
$self->{_jobs}{$params->{config}}{$params->{taskId}} = { $self->{_jobs}{$id} = {
taskId=>$params->{taskId}, taskId=>$params->{taskId},
config=>$params->{config}, config=>$params->{config},
gateway=>$params->{gateway}, gateway=>$params->{gateway},
@ -160,9 +161,9 @@ sub addJob {
Compares a schedule with the current time and kicks off an event if necessary. This method should only ever need to be called by checkSchedules(). Compares a schedule with the current time and kicks off an event if necessary. This method should only ever need to be called by checkSchedules().
=head3 job =head3 jobId
A job definition created through the addJob() method. A jobId definition created through the addJob() method.
=head3 now =head3 now
@ -171,12 +172,12 @@ A DateTime object representing the time to compare the schedule with.
=cut =cut
sub checkSchedule { sub checkSchedule {
my ($kernel, $self, $job, $now) = @_[KERNEL, OBJECT, ARG0, ARG1]; my ($kernel, $self, $id, $now) = @_[KERNEL, OBJECT, ARG0, ARG1];
$self->debug("Checking schedule ".$job->{taskId}." for ".$job->{config}." against the current time."); $self->debug("Checking schedule ".$id." against the current time.");
my $cron = DateTime::Cron::Simple->new($job->{schedule}); my $cron = DateTime::Cron::Simple->new($self->getJob($id)->{schedule});
if ($cron->validate_time($now)) { if ($cron->validate_time($now)) {
$self->debug("It's time to run ".$job->{taskId}." for ".$job->{config}.". Creating workflow instance."); $self->debug("It's time to run ".$id.". Creating workflow instance.");
$kernel->yield("runJob",$job); $kernel->yield("runJob",$id);
} }
} }
@ -192,10 +193,8 @@ sub checkSchedules {
my ($kernel, $self) = @_[KERNEL, OBJECT]; my ($kernel, $self) = @_[KERNEL, OBJECT];
$self->debug("Checking schedules against current time."); $self->debug("Checking schedules against current time.");
my $now = DateTime->from_epoch(epoch=>time()); my $now = DateTime->from_epoch(epoch=>time());
foreach my $config (keys %{$self->{_jobs}}) { foreach my $id (keys %{$self->{_jobs}}) {
foreach my $taskId (keys %{$self->{_jobs}{$config}}) { $kernel->yield("checkSchedule", $id, $now)
$kernel->yield("checkSchedule", $self->{_jobs}{$config}{$taskId}, $now)
}
} }
$kernel->delay_set("checkSchedules",60); $kernel->delay_set("checkSchedules",60);
} }
@ -243,21 +242,17 @@ Removes a job from the monitoring queue.
A hash reference containing the info needed to delete this job. A hash reference containing the info needed to delete this job.
=head4 taskId =head4 id
The unique ID for this job. The unique ID for this job.
=head4 config
The config file name for the site this job belongs to.
=cut =cut
sub deleteJob { sub deleteJob {
my ($self, $params) = @_[OBJECT, ARG0]; my ($self, $id) = @_[OBJECT, ARG0];
$self->debug("Deleting schedule ".$params->{taskId}." for ".$params->{config}." from queue."); $self->debug("Deleting schedule ".$id." from queue.");
delete $self->{_errorCount}{$params->{config}}{$params->{taskId}}; delete $self->{_errorCount}{$id};
delete $self->{_jobs}{$params->{config}}{$params->{taskId}}; delete $self->{_jobs}{$id};
} }
@ -282,6 +277,24 @@ sub error {
#------------------------------------------------------------------- #-------------------------------------------------------------------
=head2 getJob ( id )
Returns a hash reference to a job.
=head3 id
The unique id of the job to fetch.
=cut
sub getJob {
my $self = shift;
my $id = shift;
return $self->{_jobs}{$id};
}
#-------------------------------------------------------------------
=head3 getLogger ( ) =head3 getLogger ( )
Returns a reference to the logger. Returns a reference to the logger.
@ -349,9 +362,8 @@ sub new {
my $class = shift; my $class = shift;
my $config = shift; my $config = shift;
my $logger = shift; my $logger = shift;
my $workflowSession = shift;
my $debug = shift; my $debug = shift;
my $self = {_debug=>$debug, _workflowSession=>$workflowSession, _config=>$config, _logger=>$logger}; my $self = {_jobs=>{}, _debug=>$debug, _config=>$config, _logger=>$logger};
bless $self, $class; bless $self, $class;
my @publicEvents = qw(runJob runJobResponse addJob deleteJob); my @publicEvents = qw(runJob runJobResponse addJob deleteJob);
POE::Session->create( POE::Session->create(
@ -370,27 +382,27 @@ Calls a worker to execute a cron job.
=cut =cut
sub runJob { sub runJob {
my ($kernel, $self, $job, $session) = @_[KERNEL, OBJECT, ARG0, SESSION]; my ($kernel, $self, $id, $session) = @_[KERNEL, OBJECT, ARG0, SESSION];
$self->debug("Preparing to run a scheduled job ".$job->{taskId}."."); $self->debug("Preparing to run a job ".$id.".");
POE::Component::Client::UserAgent->new; my $job = $self->getJob($id);
if ($job->{sitename} eq "" || $job->{config} eq "" || $job->{taskId} eq "") { if ($job->{sitename} eq "" || $job->{config} eq "" || $job->{taskId} eq "") {
$self->error("A scheduled task has corrupt information and is not able to be run. Skipping execution."); $self->error("A job has corrupt information and is not able to be run. Skipping execution.");
$kernel->yield("deleteJob",{config=>$job->{config}, taskId=>$job->{taskId}}) if ($job->{config} ne "" && $job->{taskId} ne ""); $kernel->yield("deleteJob",$id);
} elsif ($self->{_errorCount}{$job->{config}}{$job->{taskId}} >= 5) { } elsif ($self->{_errorCount}{$id} >= 5) {
$self->error("Scheduled task ".$job->{config}." / ".$job->{taskId}." has failed ".$self->{_errorCount}{$job->{config}}{$job->{taskId}}." times in a row and will no longer attempt to execute."); $self->error("Job ".$id." has failed ".$self->{_errorCount}{$id}." times in a row and will no longer attempt to execute.");
$kernel->yield("deleteJob",{config=>$job->{config}, taskId=>$job->{taskId}}); $kernel->yield("deleteJob",$id);
} else { } else {
POE::Component::Client::UserAgent->new;
my $url = "http://".$job->{sitename}.':'.$self->config->get("webguiPort").$job->{gateway}; my $url = "http://".$job->{sitename}.':'.$self->config->get("webguiPort").$job->{gateway};
my $request = POST $url, [op=>"runCronJob", taskId=>$job->{taskId}]; my $request = POST $url, [op=>"runCronJob", taskId=>$job->{taskId}];
my $cookie = $self->{_cookies}{$job->{sitename}}; my $cookie = $self->{_cookies}{$job->{sitename}};
$request->header("Cookie","wgSession=".$cookie) if (defined $cookie); $request->header("Cookie","wgSession=".$cookie) if (defined $cookie);
$request->header("User-Agent","Spectre"); $request->header("User-Agent","Spectre");
$request->header("X-taskId",$job->{taskId}); $request->header("X-jobId",$id);
$request->header("X-config",$job->{config}); $self->debug("Posting job ".$id." to $url.");
$self->debug("Posting schedule job ".$job->{taskId}." to $url.");
$kernel->post( useragent => 'request', { request => $request, response => $session->postback('runJobResponse') }); $kernel->post( useragent => 'request', { request => $request, response => $session->postback('runJobResponse') });
$kernel->post( useragent => 'shutdown'); # we'll still get the response, we're just done sending the request $kernel->post( useragent => 'shutdown'); # we'll still get the response, we're just done sending the request
$self->debug("Cron job ".$job->{taskId}." posted."); $self->debug("Cron job ".$id." posted.");
} }
} }
@ -404,59 +416,43 @@ This method is called when the response from the runJob() method is received.
sub runJobResponse { sub runJobResponse {
my ($self, $kernel) = @_[OBJECT, KERNEL]; my ($self, $kernel) = @_[OBJECT, KERNEL];
$self->debug("Retrieving response from scheduled job."); $self->debug("Retrieving response from job.");
my ($request, $response, $entry) = @{$_[ARG1]}; my ($request, $response, $entry) = @{$_[ARG1]};
my $taskId = $request->header("X-taskId"); # got to figure out how to get this from the request, cuz the response may die my $id = $request->header("X-jobId"); # got to figure out how to get this from the request, cuz the response may die
my $config = $request->header("X-config"); # got to figure out how to get this from the request, cuz the response may die $self->debug("Response retrieved is for job $id.");
$self->debug("Response retrieved is for scheduled task $config / $taskId.");
my $job = $self->{_jobs}{$config}{$taskId};
if ($response->is_success) { if ($response->is_success) {
$self->debug("Response for scheduled task $config / $taskId retrieved successfully."); $self->debug("Response for job $id retrieved successfully.");
if ($response->header("Cookie") ne "") { if ($response->header("Set-Cookie") ne "") {
$self->debug("Storing cookie for $config / $taskId for later use."); $self->debug("Storing cookie for $id for later use.");
my $cookie = $response->header("Set-Cookie"); my $cookie = $response->header("Set-Cookie");
$cookie =~ s/wgSession=([a-zA-Z0-9\_\-]{22})/$1/; $cookie =~ s/wgSession=([a-zA-Z0-9\_\-]{22}).*/$1/;
$self->{_cookies}{$job->{sitename}} = $cookie; $self->{_cookies}{$self->getJob($id)->{sitename}} = $cookie;
} }
my $state = $response->content; my $state = $response->content;
if ($state eq "done") { if ($state eq "done") {
delete $self->{_errorCount}{$config}{$taskId}; delete $self->{_errorCount}{$id};
$self->debug("Scheduled task $config / $taskId is now complete."); $self->debug("Job $id is now complete.");
if ($job->{runOnce}) { if ($self->getJob($id)->{runOnce}) {
$kernel->yield("deleteJob",{config=>$job->{config}, taskId=>$job->{taskId}}); $kernel->yield("deleteJob",$id);
} }
} elsif ($state eq "error") { } elsif ($state eq "error") {
$self->{_errorCount}{$config}{$taskId}++; $self->{_errorCount}{$id}++;
$self->debug("Got an error response for scheduled task $config / $taskId, will try again in ".$self->config->get("suspensionDelay")." seconds."); $self->debug("Got an error response for job $id, will try again in ".$self->config->get("suspensionDelay")." seconds.");
$kernel->delay_set("runJob",$self->config->get("suspensionDelay"),$job); $kernel->delay_set("runJob",$self->config->get("suspensionDelay"),$id);
} else { } else {
$self->{_errorCount}{$config}{$taskId}++; $self->{_errorCount}{$id}++;
$self->error("Something bad happened on the return of scheduled task $config / $taskId, will try again in ".$self->config->get("suspensionDelay")." seconds. ".$response->error_as_HTML); $self->error("Something bad happened on the return of job $id, will try again in ".$self->config->get("suspensionDelay")." seconds. ".$response->error_as_HTML);
$kernel->delay_set("runJob",$self->config->get("suspensionDelay"),$job); $kernel->delay_set("runJob",$self->config->get("suspensionDelay"),$id);
} }
} elsif ($response->is_redirect) { } elsif ($response->is_redirect) {
$self->error("Response for $config / $taskId was redirected. This should never happen if configured properly!!!"); $self->error("Response for $id was redirected. This should never happen if configured properly!!!");
} elsif ($response->is_error) { } elsif ($response->is_error) {
$self->error("Response for scheduled task $config / $taskId had a communications error. ".$response->error_as_HTML); $self->error("Response for job $id had a communications error. ".$response->error_as_HTML);
$self->{_errorCount}{$config}{$taskId}++; $self->{_errorCount}{$id}++;
$kernel->delay_set("runJob",$self->config->get("suspensionDelay"),$job); $kernel->delay_set("runJob",$self->config->get("suspensionDelay"),$id);
} }
} }
#-------------------------------------------------------------------
=head2 workflowSession ( )
Returns a reference to the workflow session.
=cut
sub workflowSession {
my $self = shift;
return $self->{_workflowSession};
}
1; 1;

4
lib/Spectre/Workflow.pm
View file

@ -393,10 +393,10 @@ sub workerResponse {
$self->debug("Response retrieved is for $instanceId."); $self->debug("Response retrieved is for $instanceId.");
if ($response->is_success) { if ($response->is_success) {
$self->debug("Response for $instanceId retrieved successfully."); $self->debug("Response for $instanceId retrieved successfully.");
if ($response->header("Cookie") ne "") { if ($response->header("Set-Cookie") ne "") {
$self->debug("Storing cookie for $instanceId for later use."); $self->debug("Storing cookie for $instanceId for later use.");
my $cookie = $response->header("Set-Cookie"); my $cookie = $response->header("Set-Cookie");
$cookie =~ s/wgSession=([a-zA-Z0-9\_\-]{22})/$1/; $cookie =~ s/wgSession=([a-zA-Z0-9\_\-]{22}).*/$1/;
$self->{_cookies}{$self->{_instances}{$instanceId}{sitename}} = $cookie; $self->{_cookies}{$self->{_instances}{$instanceId}{sitename}} = $cookie;
} }
my $state = $response->content; my $state = $response->content;

4
lib/WebGUI/Workflow/Cron.pm
View file

@ -85,7 +85,7 @@ sub delete {
my $skipNotify = shift; my $skipNotify = shift;
$self->session->db->deleteRow("WorkflowSchedule","taskId",$self->getId); $self->session->db->deleteRow("WorkflowSchedule","taskId",$self->getId);
if ($skipNotify) { if ($skipNotify) {
WebGUI::Workflow::Spectre->new($self->session)->notify("cron/deleteJob",{taskId=>$self->getId, config=>$self->session->config->getFilename}); WebGUI::Workflow::Spectre->new($self->session)->notify("cron/deleteJob", $self->session->config->getFilename."-".$self->getId);
} }
undef $self; undef $self;
} }
@ -283,7 +283,7 @@ sub set {
$self->{_data}{enabled} = 0 unless ($self->{_data}{workflowId}); $self->{_data}{enabled} = 0 unless ($self->{_data}{workflowId});
my $spectre = WebGUI::Workflow::Spectre->new($self->session); my $spectre = WebGUI::Workflow::Spectre->new($self->session);
$self->session->db->setRow("WorkflowSchedule","taskId",$self->{_data}); $self->session->db->setRow("WorkflowSchedule","taskId",$self->{_data});
$spectre->notify("cron/deleteJob",{taskId=>$self->getId,config=>$self->session->config->getFilename}); $spectre->notify("cron/deleteJob", $self->session->config->getFilename."-".$self->getId);
my %params = %{$self->{_data}}; my %params = %{$self->{_data}};
$params{parameters} = $self->get("parameters"); $params{parameters} = $self->get("parameters");
$params{config} = $self->session->config->getFilename; $params{config} = $self->session->config->getFilename;