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
|
#*************************************************************************
#
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
#
# Copyright 2000, 2010 Oracle and/or its affiliates.
#
# OpenOffice.org - a multi-platform office productivity suite
#
# This file is part of OpenOffice.org.
#
# OpenOffice.org is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License version 3
# only, as published by the Free Software Foundation.
#
# OpenOffice.org is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License version 3 for more details
# (a copy is included in the LICENSE file that accompanied this code).
#
# You should have received a copy of the GNU Lesser General Public License
# version 3 along with OpenOffice.org. If not, see
# <http://www.openoffice.org/license.html>
# for a copy of the LGPLv3 License.
#
#*************************************************************************
#
# Eis.pm - package for accessing/manipulating the EIS database via SOAP
#
package Eis;
use strict;
use SOAP::Lite;
use Class::Struct;
use Carp;
# Declaration of class Eis together with ctor and accessors.
# See 'perldoc Class::Struct' for details
struct Eis => [
# public members
uri => '$', # name of webservice
proxy_list => '@', # list of proxy URLs
current_proxy => '$', # current proxy (index in proxy_list)
net_proxy => '$', # network proxy to pass through firewall
# private members
eis_connector => '$' # SOAP connector to EIS database
];
#### public methods ####
# Any not predeclared method call to this package is
# interpreted as a SOAP method call. We use the AUTOLOAD
# mechanism to intercept these calls and delgate them
# to the eis_connector.
# See the 'Camel Book', 3rd edition, page 337 for an
# explanation of the AUTOLOAD mechanism.
sub AUTOLOAD
{
my $self = shift;
my $callee = $Eis::AUTOLOAD; # $callee now holds the name of
# called subroutine
#
return if $callee =~ /::DESTROY$/;
$callee = substr($callee, 5);
my $sl = $self->eis_connector();
if ( !$sl ) {
$sl = $self->init_eis_connector();
$self->eis_connector($sl);
}
my $response;
while ( 1 ) {
# Call callee() on web service.
eval { $response = $sl->$callee(@_) };
if ( $@ ) {
# Transport error (server not available, timeout, etc).
# Use backup server.
print STDERR ("Warning: web service unavailable. Trying backup server.\n");
if ( !$self->set_next_proxy() ) {
# All proxies tried, out of luck
carp("ERROR: Connection to EIS database failed.\n");
return undef;
}
}
else {
last;
}
}
if ( $response->fault() ) {
my $fault_msg = get_soap_fault_message($response);
die $fault_msg; # throw $fault_msg as exception
}
else {
return $response->result();
}
}
#### public class methods ####
# Turn scalar into SOAP string.
sub to_string
{
my $value = shift;
return SOAP::Data->type(string => $value);
}
#### non public instance methods ####
# Initialize SOAP connection to EIS.
sub init_eis_connector
{
my $self = shift;
# Init current_proxy with first element of the proxy list.
my $current = $self->current_proxy(0);
if ( !$self->uri() ) {
carp("ERROR: web service URI not set.");
return undef;
}
if ( !$self->proxy_list->[$current] ) {
carp("ERROR: proxy list not proper initialized.");
return undef;
}
# might be needed to get through a firewall
if ( defined($self->net_proxy()) ) {
$ENV{HTTPS_PROXY}=$self->net_proxy();
}
my $proxy = $self->proxy_list()->[$current];
if ( $proxy =~ /^\s*https\:\/\// ) {
# SOAP::Lite does not complain if Crypt::SSLeay is not available,
# but crypted connections will just not work. Force the detection of
# Crypt::SSLeay for https connections and fail with a meaningful
# message if it's not available.
require Crypt::SSLeay;
}
return create_eis_connector($self->uri(), $proxy);
}
# Advance one entry in proxy list.
sub set_next_proxy
{
my $self = shift;
my @proxies = @{$self->proxy_list()};
my $current = $self->current_proxy();
if ( $current == $#proxies ) {
return 0;
}
else {
$self->current_proxy(++$current);
my $next_proxy = $self->proxy_list()->[$current];
$self->eis_connector()->proxy($next_proxy);
return 1;
}
}
#### misc ####
# Create new SOAP EIS conector.
sub create_eis_connector
{
my $uri = shift;
my $proxy = shift;
my $sl;
# With version 0.66 of SOAP::Lite the uri() method
# has been deprecated in favour of ns(). There
# seems to be no way to switch of the deprecation warning
# (which may be a bug in this version of SOAP::Lite).
# Since older versions do not support the ns() method we
# either force everyone to upgrade now, or make the following
# dependent on the SOAP::Lite version.
my ($vmaj, $vmin) = (0, 0);
if( $SOAP::Lite::VERSION =~ m/([0-9]*)\.([0-9]*)/ ) {
$vmaj = $1;
$vmin = $2;
if ( $vmaj > 0 || ( $vmaj == 0 && $vmin >= 66 ) ) {
$sl = SOAP::Lite
-> ns($uri)
-> proxy($proxy);
}
else {
$sl = SOAP::Lite
-> uri($uri)
-> proxy($proxy);
}
}
else {
carp("ERROR: Can't determine SOAP::Lite version.");
}
return $sl;
}
# Retrieve SOAP fault message.
sub get_soap_fault_message
{
my $faulty_response = shift;
my $fault_msg = join(', ', $faulty_response->faultcode(),
$faulty_response->faultstring(),
$faulty_response->faultdetail());
return $fault_msg;
}
####
1; # needed by "use" or "require"
|
