[Bio] / FigKernelPackages / ACHserver.pm Repository:
ViewVC logotype

Diff of /FigKernelPackages/ACHserver.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.6, Wed Sep 30 15:33:23 2009 UTC revision 1.11, Wed Nov 25 21:22:22 2009 UTC
# Line 7  Line 7 
7  use strict;  use strict;
8  use LWP::UserAgent;  use LWP::UserAgent;
9  use YAML;  use YAML;
10        use ErrorMessage;
11        no warnings qw(once);
12    
13  =head1 Annotation Clearinghouse Server Helper Object  =head1 Annotation Clearinghouse Server Helper Object
14    
# Line 43  Line 45 
45    
46  =head3 new  =head3 new
47    
48      my $ach = ACHserver->new(%options);      my $ss = ACHserver->new(%options);
49    
50  Construct a new ACHserver object. The following options are supported.  Construct a new server object. The
51    following options are supported.
52    
53  =over 4  =over 4
54    
55  =item url  =item url
56    
57  URL for the ACH server. This option may be used to redirect requests to a  URL for the server. This option is required.
 test version of the server, or to an older server script.  
58    
59  =item singleton  =item singleton (optional)
60    
61  If TRUE, results from methods will be returned in singleton mode. In singleton  If TRUE, results from methods will be returned in singleton mode. In singleton
62  mode, if a single result comes back, it will come back as a scalar rather than  mode, if a single result comes back, it will come back as a scalar rather than
# Line 67  Line 69 
69  sub new {  sub new {
70      # Get the parameters.      # Get the parameters.
71      my ($class, %options) = @_;      my ($class, %options) = @_;
72        # Turn off YAML compression, which causes problems with our hash keys.
73        $YAML::CompressSeries = 0;
74      # Get the options.      # Get the options.
75      my $url = $options{url} || "http://servers.nmpdr.org/ach/server.cgi";      my $url = $options{url} || "http://servers.nmpdr.org/ach/server.cgi";
76      my $singleton = $options{singleton} || 0;      my $singleton = $options{singleton} || 0;
77      # Create the fields of the object.      # Create the fields of the object. Note that if we're in localhost mode,
78        # the user agent is actually a SAP object.
79      my $server_url = $url;      my $server_url = $url;
80      my $ua = LWP::UserAgent->new();      my $ua;
81      # Create the SAPserver object.      if ($server_url ne 'localhost') {
82            require LWP::UserAgent;
83            $ua = LWP::UserAgent->new();
84            $ua->timeout(20 * 60);
85        } else {
86            require "ACH.pm";
87            $ua = ACH->new();
88        }
89        # Create the server object.
90      my $retVal = {      my $retVal = {
91                      server_url => $server_url,                      server_url => $server_url,
92                      ua => $ua,                      ua => $ua,
93                      singleton => $singleton,                      singleton => $singleton,
94                   };                   };
95      # Bless and return it.      # Bless it.
96      bless $retVal, $class;      bless $retVal, $class;
97        # Get the list of permitted methods from the server.
98        my $methodList = $retVal->_call_method(methods => []);
99        # Convert it to a hash and store it in this object.
100        $retVal->{methodHash} = { map { $_ => 1 } @$methodList };
101        # Return the object.
102      return $retVal;      return $retVal;
103  }  }
104    
 =head2 Public Methods  
   
 All L<ACH/Primary Methods> are also methods of this object.  
   
105  =head3 AUTOLOAD  =head3 AUTOLOAD
106    
107      my $result = $ach->method(%args);      my $result = $server->method(%args);
108    
109  Call a function on the server. Any method call on this object (other than  Call a function on the server. Any method call on this object (other than
110  the constructor) is translated into a request against the server. This  the constructor) is translated into a request against the server. This
111  enables us to add new server functions without requiring an update to this  enables us to add new server functions without requiring an update to this
112  module. The parameters are specified as a hash, and the result is a scalar  object or its parent. The parameters are usually specified as a hash, and the
113  or object reference. If an error occurred, we will throw an exception.  result is a scalar or object reference. In some cases the parameters are a list.
114    To deistinguish between the two cases, all hash keys must begin with hyphens.
115    
116    If an error occurs, we will throw an exception.
117    
118  =cut  =cut
119    
# Line 105  Line 122 
122    
123  sub AUTOLOAD {  sub AUTOLOAD {
124      # Get the parameters. We do some fancy dancing to allow the user to pass      # Get the parameters. We do some fancy dancing to allow the user to pass
125      # in a hash, a list, or a hash reference.      # in a hash, a list, a list reference, or a hash reference.
126      my $self = shift @_;      my $self = shift @_;
127      my $args = $_[0];      my $args = $_[0];
128      if (defined $args) {      if (defined $args) {
# Line 135  Line 152 
152      my $function = $AUTOLOAD;      my $function = $AUTOLOAD;
153      # Strip off the stuff before the method name.      # Strip off the stuff before the method name.
154      $function =~ s/.+:://;      $function =~ s/.+:://;
155      # Compute the argument document.      # Validate the method name.
156      my $argString = YAML::Dump($args);      if (! $self->{methodHash}{$function}) {
157      # Get our user agent.          die "Method \"$function\" not supported.";
     my $ua = $self->{ua};  
     # Request the function from the server.  
     my $response = $ua->post($self->{server_url},  
                              [function => $function, args => $argString,  
                               source => __PACKAGE__ ]);  
     # Get the response content.  
     my $content = $response->content;  
     if (! $response->is_success) {  
         die "Server error " . $response->status_line . "\n$content";  
158      } else {      } else {
159          $retVal = YAML::Load($content);          # Call the method.
160          # Figure out what we got back.          $retVal = $self->_call_method($function, $args);
161          my $returnType = ref $retVal;          # We have our result. Adjust for singleton mode.
162          if ($returnType) {          if ($self->{singleton} && ref $retVal eq 'HASH' && scalar(keys %$retVal) <= 1) {
             if ($returnType eq 'ErrorDocument') {  
                 # Here an error occurred, so we throw an exception using the  
                 # error message.  
                 die $retVal->{message};  
             } elsif ($self->{singleton} && $returnType eq 'HASH' &&  
                      scalar(keys %$retVal) <= 1) {  
163                  # Here we're in singleton mode and we got a single result,                  # Here we're in singleton mode and we got a single result,
164                  # so we dereference a bit to make it easier for the user                  # so we dereference a bit to make it easier for the user
165                  # to access it.                  # to access it.
166                  ($retVal) = values %$retVal;                  ($retVal) = values %$retVal;
167              }              }
168          }          }
     }  
169      # Return the result.      # Return the result.
170      return $retVal;      return $retVal;
171  }  }
# Line 180  Line 181 
181    
182  sub DESTROY { }  sub DESTROY { }
183    
184    =head2 Utility Methods
185    
186    =head3 _call_method
187    
188        my $result = $server->_call_method($method, $args);
189    
190    Call the specified method on the server with the specified arguments and
191    return the result. The arguments must already be packaged as a hash or
192    list reference. This method is the heart of the AUTOLOAD method, and is
193    provided as a utility for specialized methods that can't use the AUTOLOAD
194    facility.
195    
196    =over 4
197    
198    =item method
199    
200    Name of the server function being invoked.
201    
202    =item args
203    
204    Argument object to pass to the function.
205    
206    =item RETURN
207    
208    Returns a hash or list reference with the function results.
209    
210    =back
211    
212    =cut
213    
214    sub _call_method {
215        # Get the parameters.
216        my ($self, $method, $args) = @_;
217        # Declare the return variable.
218        my $retVal;
219        # Get our user agent.
220        my $ua = $self->{ua};
221        # Determine the type.
222        if (ref $ua eq 'LWP::UserAgent') {
223            # Here we're going to a server. Compute the argument document.
224            my $argString = YAML::Dump($args);
225            # Request the function from the server.
226            my $content = $self->_send_request(function => $method, args => $argString,
227                                               source => __PACKAGE__);
228            $retVal = YAML::Load($content);
229        } else {
230            # Here we're calling a local method.
231            $retVal = eval("\$ua->$method(\$args)");
232            # Check for an error.
233            if ($@) {
234                die "Package error: $@";
235            }
236        }
237        # Return the result.
238        return $retVal;
239    }
240    
241    =head3 _send_request
242    
243        my $result = $server->_send_request(%parms);
244    
245    Send a request to the server. This method must not be called in localhost
246    mode. If an error occurs, this method will die; otherwise, the content of
247    the response will be passed back as the result.
248    
249    =over 4
250    
251    =item parms
252    
253    Hash of CGI parameters to send to the server.
254    
255    =item RETURN
256    
257    Returns the string returned by the server in response to the request.
258    
259    =back
260    
261    =cut
262    
263    sub _send_request {
264        # Get the parameters.
265        my ($self, %parms) = @_;
266        # Get the user agent.
267        my $ua = $self->{ua};
268        # Request the function from the server. Note that the hash is actually passed
269        # as a list reference.
270    
271        #
272        # retries is the set of retry wait times in seconds we should use. when
273        # we run out the call will fail.
274        #
275    
276        my @retries = (1, 2, 5, 10, 20, 60, 60, 60, 60, 60, 60);
277        my %codes_to_retry =  map { $_ => 1 } qw(110 408 502 503 504 200) ;
278        my $response;
279        while (1)
280        {
281            $response = $ua->post($self->{server_url}, [ %parms ]);
282            if ($response->is_success)
283            {
284                my $retVal = $response->content;
285                return $retVal;
286            }
287    
288            #
289            # If this is not one of the error codes we retry for, or if we
290            # are out of retries, fail immediately
291            #
292            my $code = $response->code;
293            if (!$codes_to_retry{$code} || @retries == 0)
294            {
295                if ($ENV{SAS_DEBUG}) {
296                    confess $response->content;
297                } else {
298                    confess $response->status_line;
299                }
300            }
301    
302            #
303            # otherwise, sleep & loop.
304            #
305            my $retry_time = shift(@retries);
306            print STDERR "Request failed with code=$code, sleeping $retry_time and retrying\n";
307            sleep($retry_time);
308    
309        }
310    
311        #
312        # Should never get here.
313        #
314    }
315    
316    
317  1;  1;

Legend:
Removed from v.1.6  
changed lines
  Added in v.1.11

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3