/usr/share/perl5/Bio/Tools/Run/Analysis/soap.pm is in libbio-perl-run-perl 1.7.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 | # $Id$
#
# BioPerl module Bio::Tools::Run::Analysis::soap.pm
#
# Please direct questions and support issues to <bioperl-l@bioperl.org>
#
# Cared for by Martin Senger <martin.senger@gmail.com>
# For copyright and disclaimer see below.
# POD documentation - main docs before the code
=head1 NAME
Bio::Tools::Run::Analysis::soap - A SOAP-based access to the analysis tools
=head1 SYNOPSIS
Do not use this object directly, it is recommended to access it and use
it through the C<Bio::Tools::Run::Analysis> module:
use Bio::Tools::Run::Analysis;
my $tool = Bio::Tools::Run::Analysis->new(-access => 'soap',
-name => 'seqret');
=head1 DESCRIPTION
This object allows to execute and to control a remote analysis tool
(an application, a program) using the SOAP middleware,
All its public methods are documented in the interface module
C<Bio::AnalysisI> and explained in tutorial available in the
C<analysis.pl> script.
=head1 FEEDBACK
=head2 Mailing Lists
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list. Your participation is much appreciated.
bioperl-l@bioperl.org - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
=head2 Support
Please direct usage questions or support issues to the mailing list:
I<bioperl-l@bioperl.org>
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
=head2 Reporting Bugs
Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via the
web:
http://redmine.open-bio.org/projects/bioperl/
=head1 AUTHOR
Martin Senger (martin.senger@gmail.com)
=head1 COPYRIGHT
Copyright (c) 2003, Martin Senger and EMBL-EBI.
All Rights Reserved.
This module is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=head1 DISCLAIMER
This software is provided "as is" without warranty of any kind.
=head1 SEE ALSO
=over 4
=item *
http://www.ebi.ac.uk/soaplab/Perl_Client.html
=back
=head1 BUGS AND LIMITATIONS
None known at the time of writing this.
=head1 APPENDIX
Here is the rest of the object methods. Internal methods are preceded
with an underscore _.
=cut
# Let the code begin...
package Bio::Tools::Run::Analysis::soap;
use vars qw(@ISA $Revision $DEFAULT_LOCATION);
use strict;
use Bio::Tools::Run::Analysis;
use SOAP::Lite
on_fault => sub {
my $soap = shift;
my $res = shift;
my $msg =
ref $res ?
"--- SOAP FAULT ---\n" .
'faultcode: ' . $res->faultcode . "\n" .
'faultstring: ' . Bio::Tools::Run::Analysis::soap::_clean_msg ($res->faultstring)
: "--- TRANSPORT ERROR ---\n" . $soap->transport->status . "\n$res\n";
Bio::Tools::Run::Analysis::soap->throw ($msg);
}
;
@ISA = qw(Bio::Tools::Run::Analysis);
BEGIN {
$Revision = q[$Id$];
# where to go
$DEFAULT_LOCATION = 'http://www.ebi.ac.uk/soaplab/services';
}
# -----------------------------------------------------------------------------
=head2 _initialize
Usage : my $tool = Bio::Tools::Run::Analysis->new(-access => 'soap',
-name => 'seqret',
...);
(_initialize is internally called from the 'new()' method)
Returns : nothing interesting
Args : This module recognises and uses following arguments:
-location
-name
-httpproxy
-timeout
Additionally, the main module Bio::Tools::Run::Analysis
recognises also:
-access
It populates calling object with the given arguments, and then - for
some attributes and only if they are not yet populated - it assigns
some default values.
This is an actual new() method (except for the real object creation
and its blessing which is done in the parent class Bio::Root::Root in
method _create_object).
Note that this method is called always as an I<object> method (never
as a I<class> method) - and that the object who calls this method may
already be partly initiated (from Bio::Tools::Run::Analysis::new method);
so if you need to do some tricks with the 'class invocation' you need to
change Bio::Analysis I<new> method, not this one.
=over 4
=item -location
A URL (also called an I<endpoint>) defining where is located a Web Service
representing this analysis tool.
Default is C<http://www.ebi.ac.uk/soaplab/services> (services running
at European Bioinformatics Institute on top of most of EMBOSS
analyses, and few others).
For example, if you run your own Web Service using Java(TM) Apache Axis
toolkit, the location might be something like
C<http://localhost:8080/axis/services>.
=item -name
A name of a Web Service (also called a I<urn> or a I<namespace>).
There is no default value (which usually means that this parameter is
mandatory unless your I<-location> parameter includes also a Web
Service name).
=item -destroy_on_exit =E<gt> '0'
Default value is '1' which means that all Bio::Tools::Run::Analysis::Job
objects - when being finalised - will send a request
to the remote Web Service to forget the results of these jobs.
If you change it to '0' make sure that you know the job identification
- otherwise you will not be able to re-established connection with it
(later, when you use your script again). This can be done by calling
method C<id> on the job object (such object is returned by any of
these methods: C<create_job>, C<run>, C<wait_for>).
=item -httpproxy
In addition to the I<location> parameter, you may need
to specify also a location/URL of an HTTP proxy server
(if your site requires one). The expected format is C<http://server:port>.
There is no default value.
=item -timeout
For long(er) running jobs the HTTP connection may be time-outed. In
order to avoid it (or, vice-versa, to call timeout sooner) you may
specify C<timeout> with the number of seconds the connection will be
kept alive. Zero means to keep it alive forever. The default value is
two minutes.
=back
=cut
sub _initialize {
my ($self, @args) = @_;
# make a hashtable from @args
my %param = @args;
@param { map { lc $_ } keys %param } = values %param; # lowercase keys
# copy all @args into this object (overwriting what may already be
# there) - changing '-key' into '_key'
my $new_key;
foreach my $key (keys %param) {
($new_key = $key) =~ s/^-/_/;
$self->{ $new_key } = $param { $key };
}
# finally add default values for those keys who have default value
# and who are not yet in the object
$self->{'_location'} = $DEFAULT_LOCATION unless $self->{'_location'};
# create a SOAP::Lite object, the main worker
if (defined $self->{'_httpproxy'}) {
$self->{'_soap'} = SOAP::Lite
-> proxy ($self->{'_location'},
timeout => (defined $self->{'_timeout'} ? $self->{'_timeout'} : 120),
proxy => ['http' => $self->{'_httpproxy'}]);
} else {
$self->{'_soap'} = SOAP::Lite
-> proxy ($self->{'_location'},
timeout => (defined $self->{'_timeout'} ? $self->{'_timeout'} : 120),
);
}
$self->{'_soap'}->uri ($self->{'_name'}) if $self->{'_name'};
# forget cached things which should not be cloned into new
# instances (because they may represent a completely different
# analysis
delete $self->{'_analysis_spec'};
delete $self->{'_input_spec'};
delete $self->{'_result_spec'};
}
#
# Create a hash with named inputs, all extracted
# from the given data.
#
# The main job is done in the SUPER class - here we do
# only the SOAP-specific stuff.
#
sub _prepare_inputs {
my $self = shift;
my $rh_inputs = $self->SUPER::_prepare_inputs (@_);
foreach my $name (keys %{$rh_inputs}) {
my $value = $$rh_inputs{$name};
# value of type ref ARRAY is send as byte[][]
if (ref $value eq 'ARRAY') {
my @bytes =
map { SOAP::Data->new (type => 'base64',
value => $_) } @$value;
$$rh_inputs{$name} = \@bytes;
next;
}
}
return $rh_inputs;
}
# ---------------------------------------------------------------------
#
# Here are the methods implementing Bio::AnalysisI interface
# (documentation is in Bio::AnalysisI)
#
# ---------------------------------------------------------------------
sub analysis_name {
my $self = shift;
${ $self->analysis_spec }{'name'};
}
# Map getAnalysisType()
sub analysis_spec {
my ($self) = @_;
return $self->{'_analysis_spec'} if $self->{'_analysis_spec'};
my $soap = $self->{'_soap'};
$self->{'_analysis_spec'} = $soap->getAnalysisType->result;
}
# String describe()
sub describe {
my ($self) = @_;
my $soap = $self->{'_soap'};
$soap->describe->result;
}
# Map[] getInputSpec()
sub input_spec {
my ($self) = @_;
return $self->{'_input_spec'} if $self->{'_input_spec'};
my $soap = $self->{'_soap'};
$self->{'_input_spec'} = $soap->getInputSpec->result;
}
# Map[] getResultSpec()
sub result_spec {
my ($self) = @_;
return $self->{'_result_spec'} if $self->{'_result_spec'};
my $soap = $self->{'_soap'};
$self->{'_result_spec'} = $soap->getResultSpec->result;
}
# String createJob (Map inputs)
# String createJob (String id)
# String createJob ()
sub create_job {
my ($self, $params) = @_;
my $job_id;
my $force_to_live;
# if $params is a reference then it contains *all* input data
# (see details in '_prepare_inputs' how they can be coded) -
# send it to the server to get a unique job ID
if (ref $params) {
my $rh_inputs = $self->_prepare_inputs ($params);
my $soap = $self->{'_soap'};
$job_id = $soap->createJob (SOAP::Data->type (map => $rh_inputs))->result;
# if $params is a defined scalar it represents a job ID obtained in
# some previous invocation - such job already exists on the server
# side, just re-create it here using the same job ID
# (in this case, such job will *not* be implicitly destroyed on exit)
} elsif (defined $params) {
$job_id = $params;
$force_to_live = 1;
# finally, if $params is undef, ask server to create an empty job
# (and give me its unique job ID), the input data may be added
# later using 'set_data' method(s) - see scripts/applmaker.pl
} else {
my $soap = $self->{'_soap'};
$job_id = $soap->createEmptyJob->result; # this method may not exist on server (TBD)
}
if ($force_to_live) {
return new Bio::Tools::Run::Analysis::Job (-analysis => $self,
-id => $job_id,
-destroy_on_exit => 0,
);
} elsif (defined $self->{'_destroy_on_exit'}) {
return new Bio::Tools::Run::Analysis::Job (-analysis => $self,
-id => $job_id,
-destroy_on_exit => $self->{'_destroy_on_exit'},
);
} else {
return new Bio::Tools::Run::Analysis::Job (-analysis => $self,
-id => $job_id,
);
}
}
# String createAndRun (Map inputs)
sub run {
my $self = shift;
return $self->create_job (@_)->run;
}
# Map runAndWaitFor (Map inputs)
sub wait_for {
my $self = shift;
return $self->run (@_)->wait_for;
}
# ---------------------------------------------------------------------
#
# Here are internal methods fo Bio::Tools::Run::Analysis::soap...
#
# ---------------------------------------------------------------------
# Do something (or nothing) with $rh_resuls (coming from the server)
# depending on rules defined in $rh_rules.
#
# $rh_results: keys are result names, values are results themselves
# (either scalars or array references - if one result is split into
# more parts).
#
# $rh_rules: keys are result names, values say what to do with
# results: undef ... do nothing, return unchanged result
# - ... send it to STDOUT, return nothing
# @[template] ... put it into file (invent its name,
# perhaps based on template), return filename
# ?[template] ... ask server for result type, then decide:
# put a binary result into file (invent its name)
# and return the filename, for other result type
# do nothing and return result unchanged
# Special cases: if $rh_rules is scalar '@[template]', do with ALL results
# as described above for @[template], or
# if $rh_rules is scalar '?[template]', do with ALL results
# as described above for ?[template].
sub _process_results {
my ($self, $rh_results, $rh_rules) = @_;
my $default_rule = $rh_rules if defined $rh_rules && $rh_rules =~ /^[\?@]/;
foreach my $name (keys %$rh_results) {
my $rule = $default_rule ? $default_rule : $$rh_rules{$name};
next unless $rule;
next if $rule =~ /^\?/ && ! $self->is_binary ($name);
my ($prefix, $template) = $rule =~ /^([\?@])(.*)/;
$template = $ENV{'RESULT_FILENAME_TEMPLATE'} unless $template;
my $filename = $rule unless $template || $prefix;
my $stdout = ($rule eq '-');
if (ref $$rh_results{$name}) {
# --- result value is an array reference
my $seq = 1;
foreach my $part (@{ $$rh_results{$name} }) {
print STDOUT $part && next if $stdout;
$part = $self->_save_result (-value => $part,
-name => $name,
-filename => $filename,
-template => $template,
-seq => $seq++);
}
} else {
# --- result value is a scalar
print STDOUT $$rh_results{$name} && next if $stdout;
$$rh_results{$name} =
$self->_save_result (-value => $$rh_results{$name},
-name => $name,
-filename => $filename,
-template => $template);
}
delete $$rh_results{$name} if $stdout;
}
$rh_results;
}
# ---------------------------------------------------------------------
#
# is the given result $name binary?
#
=head2 is_binary
Usage : if ($service->is_binary ('graph_result')) { ... }
Returns : 1 or 0
Args : $name is a result name we are interested in
=cut
sub is_binary {
my ($self, $name) = @_;
foreach my $result (@{ $self->result_spec }) {
if ($result->{'name'} eq $name) {
return ($result->{'type'} =~ /^byte\[/);
}
}
return 0;
}
# ---------------------------------------------------------------------
#
# Here are internal subroutines (NOT methods)
# for Bio::Tools::Run::Analysis::soap
#
# ---------------------------------------------------------------------
sub _clean_msg {
my ($msg) = @_;
$msg =~ s/^org\.embl\.ebi\.SoaplabShare\.SoaplabException\:\s*//;
$msg;
}
# ---------------------------------------------------------------------
#
# Here is the rest of Bio::Analysis::soap
#
# ---------------------------------------------------------------------
=head2 VERSION and Revision
Usage : print $Bio::Tools::Run::Analysis::soap::VERSION;
print $Bio::Tools::Run::Analysis::soap::Revision;
=cut
=head2 Defaults
Usage : print $Bio::Tools::Run::Analysis::soap::DEFAULT_LOCATION;
=cut
# ---------------------------------------------------------------------
#
# Bio::Tools::Run::Analysis::Job::soap
# ------------------------------------
# A module representing a job (an invocation, an execution)
# of an analysis (the analysis itself is represented by
# a Bio::Tools::Run::Analysis::soap object)
#
# Documentation is in Bio::AnalysisI::JobI.
#
# ---------------------------------------------------------------------
package Bio::Tools::Run::Analysis::Job::soap;
use vars qw(@ISA);
use strict;
@ISA = qw(Bio::Tools::Run::Analysis::Job);
sub _initialize {
my ($self, @args) = @_;
# make a hashtable from @args
my %param = @args;
@param { map { lc $_ } keys %param } = values %param; # lowercase keys
# copy all @args into this object (overwriting what may already be
# there) - changing '-key' into '_key'
my $new_key;
foreach my $key (keys %param) {
($new_key = $key) =~ s/^-/_/;
$self->{ $new_key } = $param { $key };
}
# finally add default values for those keys who have default value
# and who are not yet in the object
$self->{'_destroy_on_exit'} = 1 unless defined $self->{'_destroy_on_exit'};
}
# ---------------------------------------------------------------------
#
# Here are the methods implementing Bio::AnalysisI::JobI interface
# (documentation is in Bio::AnalysisI)
#
# ---------------------------------------------------------------------
# void run (String jobID)
sub run {
my $self = shift;
my $soap = $self->{'_analysis'}->{'_soap'};
$soap->run (SOAP::Data->type (string => $self->{'_id'}));
return $self;
}
# void waitFor (String jobID)
sub wait_for {
my $self = shift;
my $soap = $self->{'_analysis'}->{'_soap'};
$soap->waitFor (SOAP::Data->type (string => $self->{'_id'}));
return $self;
}
# void terminate (String jobID)
sub terminate {
my $self = shift;
my $soap = $self->{'_analysis'}->{'_soap'};
$soap->terminate (SOAP::Data->type (string => $self->{'_id'}));
return $self;
}
# String getLastEvent (String jobID)
sub last_event {
my $self = shift;
my $soap = $self->{'_analysis'}->{'_soap'};
$soap->getLastEvent (SOAP::Data->type (string => $self->{'_id'}))->result;
}
# String getStatus (String jobID)
sub status {
my $self = shift;
my $soap = $self->{'_analysis'}->{'_soap'};
$soap->getStatus (SOAP::Data->type (string => $self->{'_id'}))->result;
}
# long getCreated (String jobID)
sub created {
my ($self, $formatted) = @_;
my $soap = $self->{'_analysis'}->{'_soap'};
my $time = $soap->getCreated (SOAP::Data->type (string => $self->{'_id'}))->result;
$formatted ? Bio::Tools::Run::Analysis::Utils::format_time ($time) : $time;
}
# long getStarted (String jobID)
sub started {
my ($self, $formatted) = @_;
my $soap = $self->{'_analysis'}->{'_soap'};
my $time = $soap->getStarted (SOAP::Data->type (string => $self->{'_id'}))->result;
$formatted ? Bio::Tools::Run::Analysis::Utils::format_time ($time) : $time;
}
# long getEnded (String jobID)
sub ended {
my ($self, $formatted) = @_;
my $soap = $self->{'_analysis'}->{'_soap'};
my $time = $soap->getEnded (SOAP::Data->type (string => $self->{'_id'}))->result;
$formatted ? Bio::Tools::Run::Analysis::Utils::format_time ($time) : $time;
}
# long getElapsed (String jobID)
sub elapsed {
my $self = shift;
my $soap = $self->{'_analysis'}->{'_soap'};
$soap->getElapsed (SOAP::Data->type (string => $self->{'_id'}))->result;
}
# Map getCharacterictics (String jobID)
sub times {
my ($self, $formatted) = @_;
my $soap = $self->{'_analysis'}->{'_soap'};
my $rh_times = $soap->getCharacteristics (SOAP::Data->type (string => $self->{'_id'}))->result;
map { $_ = Bio::Tools::Run::Analysis::Utils::format_time ($_) } values %$rh_times
if $formatted;
return $rh_times;
}
# Map getResults (String jobID)
# Map getResults (String jobID, String[] resultNames)
# Retrieving NAMED results:
# -------------------------
# results ('name1', ...) => return results as they are, no storing into files
#
# results ( { 'name1' => 'filename', ... } ) => store into 'filename', return 'filename'
# results ( 'name1=filename', ...) => ditto
#
# results ( { 'name1' => '-', ... } ) => send result to the STDOUT, do not return anything
# results ( 'name1=-', ...) => ditto
#
# results ( { 'name1' => '@', ... } ) => store into file whose name is invented by
# this method, perhaps using RESULT_NAME_TEMPLATE env
# results ( 'name1=@', ...) => ditto
#
# results ( { 'name1' => '?', ... } ) => find of what type is this result and then use
# {'name1'=>'@' for binary files, and a regular
# return for non-binary files
# results ( 'name=?', ...) => ditto
#
# Retrieving ALL results:
# -----------------------
# results() => return all results as they are, no storing into files
#
# results ('@') => return all results, as if each of them given
# as {'name' => '@'} (see above)
#
# results ('?') => return all results, as if each of them given
# as {'name' => '?'} (see above)
#
# Misc:
# -----
# * results(...) equals to result(...)
# * any result can be returned as a scalar value, or as an array reference
# (the latter is used for results consisting of more parts, such images);
# this applies regardless whether the returned result is the result itself
# or a filename created for the result
sub results {
my $self = shift;
my $rh_names = Bio::Tools::Run::Analysis::Utils::normalize_names (@_);
my $soap = $self->{'_analysis'}->{'_soap'};
if (ref $rh_names) {
# retrieve only named results
return
$self->{'_analysis'}->_process_results
($soap->getSomeResults (SOAP::Data->type (string => $self->{'_id'}),
[ keys %$rh_names ])->result,
$rh_names);
} else {
# no result names given: take all
return
$self->{'_analysis'}->_process_results
($soap->getResults (SOAP::Data->type (string => $self->{'_id'}))->result,
$rh_names);
}
}
sub result {
my $self = shift;
my $rh_results = $self->results (@_);
(values %$rh_results)[0];
}
sub remove {
shift->{'_destroy_on_exit'} = 1;
}
#
# job objects are being destroyed if they have attribute
# '_destroy_on_exit' set to true - which is a default value
# (void destroy (String jobID)
#
sub DESTROY {
my $self = shift;
my $soap = $self->{'_analysis'}->{'_soap'};
return unless $self->{'_destroy_on_exit'} && $self->{'_id'};
# ignore all errors here
eval {
$soap->destroy (SOAP::Data->type (string => $self->{'_id'}));
}
}
1;
__END__
|