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
|
package Smokeping::probes::Curl;
=head1 301 Moved Permanently
This is a Smokeping probe module. Please use the command
C<smokeping -man Smokeping::probes::Curl>
to view the documentation or the command
C<smokeping -makepod Smokeping::probes::Curl>
to generate the POD document.
=cut
use strict;
use base qw(Smokeping::probes::basefork);
use Carp;
my $DEFAULTBIN = "/usr/bin/curl";
sub pod_hash {
return {
name => "Smokeping::probes::Curl - a curl(1) probe for SmokePing",
overview => "Fetches an HTTP or HTTPS URL using curl(1).",
description => "(see curl(1) for details of the options below)",
authors => <<'DOC',
Gerald Combs <gerald [AT] ethereal.com>
Niko Tyni <ntyni@iki.fi>
DOC
notes => <<DOC,
You should consider setting a lower value for the C<pings> variable than the
default 20, as repetitive URL fetching may be quite heavy on the server.
The URL to be tested used to be specified by the variable 'url' in earlier
versions of Smokeping, and the 'host' setting did not influence it in any
way. The variable name has now been changed to 'urlformat', and it can
(and in most cases should) contain a placeholder for the 'host' variable.
DOC
see_also => "curl(1), L<http://curl.haxx.se/>",
}
}
sub probevars {
my $class = shift;
my $h = $class->SUPER::probevars;
delete $h->{timeout};
return $class->_makevars($h, {
binary => {
_doc => "The location of your curl binary.",
_default => $DEFAULTBIN,
_sub => sub {
my $val = shift;
return "ERROR: Curl 'binary' $val does not point to an executable"
unless -f $val and -x _;
return undef;
},
},
});
}
sub targetvars {
my $class = shift;
return $class->_makevars($class->SUPER::targetvars, {
_mandatory => [ 'urlformat' ],
agent => {
_doc => <<DOC,
The "-A" curl(1) option. This is a full HTTP User-Agent header including
the words "User-Agent:". Note that it does not need any quotes around it.
DOC
_example => 'User-Agent: Lynx/2.8.4rel.1 libwww-FM/2.14 SSL-MM/1.4.1 OpenSSL/0.9.6c',
_sub => sub {
my $val = shift;
return "The Curl 'agent' string does not need any quotes around it anymore."
if $val =~ /^["']/ or $val =~ /["']$/;
return undef;
},
},
timeout => {
_doc => qq{The "-m" curl(1) option. Maximum timeout in seconds.},
_re => '\d+',
_example => 20,
_default => 10,
},
interface => {
_doc => <<DOC,
The "--interface" curl(1) option. Bind to a specific interface, IP address or
host name.
DOC
_example => 'eth0',
},
ssl2 => {
_doc => qq{The "-2" curl(1) option. Force SSL2.},
_example => 1,
},
urlformat => {
_doc => <<DOC,
The template of the URL to fetch. Can be any one that curl supports.
Any occurrence of the string '%host%' will be replaced with the
host to be probed.
DOC
_example => "http://%host%/",
},
});
}
# derived class will mess with this through the 'features' method below
my $featurehash = {
agent => "-A",
timeout => "-m",
interface => "--interface",
};
sub features {
my $self = shift;
my $newval = shift;
$featurehash = $newval if defined $newval;
return $featurehash;
}
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = $class->SUPER::new(@_);
$self->_init if $self->can('_init');
$self->test_usage;
return $self;
}
# warn about unsupported features
sub test_usage {
my $self = shift;
my $bin = $self->{properties}{binary};
my @unsupported;
my $arghashref = $self->features;
my %arghash = %$arghashref;
for my $feature (keys %arghash) {
if (`$bin $arghash{$feature} 1 127.0.0.1 2>&1` =~ /invalid option|usage/i) {
push @unsupported, $feature;
$self->do_log("Note: your curl doesn't support the $feature feature (option $arghash{$feature}), disabling it");
}
}
map { delete $arghashref->{$_} } @unsupported;
return;
}
sub ProbeDesc($) {
return "URLs using curl(1)";
}
# other than host, count and protocol-specific args come from here
sub make_args {
my $self = shift;
my $target = shift;
my @args;
my %arghash = %{$self->features};
for (keys %arghash) {
my $val = $target->{vars}{$_};
push @args, ($arghash{$_}, $val) if defined $val;
}
return @args;
}
# This is what derived classes will override
sub proto_args {
my $self = shift;
my $target = shift;
# XXX - It would be neat if curl had a "time_transfer". For now,
# we take the total time minus the DNS lookup time.
my @args = ("-o", "/dev/null", "-w", "Time: %{time_total} DNS time: %{time_namelookup}\\n");
my $ssl2 = $target->{vars}{ssl2};
push (@args, "-2") if defined($ssl2);
return(@args);
}
sub make_commandline {
my $self = shift;
my $target = shift;
my $count = shift;
my @args = $self->make_args($target);
my $url = $target->{vars}{urlformat};
my $host = $target->{addr};
$url =~ s/%host%/$host/g;
push @args, $self->proto_args($target);
return ($self->{properties}{binary}, @args, $url);
}
sub pingone {
my $self = shift;
my $t = shift;
my @cmd = $self->make_commandline($t);
$self->do_debug("executing command list " . join(",", map { qq('$_') } @cmd));
my @times;
my $count = $self->pings($t);
for (my $i = 0 ; $i < $count; $i++) {
open(P, "-|", @cmd) or croak("fork: $!");
my $val;
while (<P>) {
/^Time: (\d+\.\d+) DNS time: (\d+\.\d+)/ and $val = $1 - $2;
}
close P and defined $val and push @times, $val;
}
# carp("Got @times") if $self->debug;
return sort { $a <=> $b } @times;
}
1;
|
