centreon-plugins/apps/protocols/ftp/mode/filescount.pm

223 lines
7.0 KiB
Perl

#
# Copyright 2017 Centreon (http://www.centreon.com/)
#
# Centreon is a full-fledged industry-strength solution that meets
# the needs in IT infrastructure and application monitoring for
# service performance.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
package apps::protocols::ftp::mode::filescount;
use base qw(centreon::plugins::mode);
use strict;
use warnings;
use apps::protocols::ftp::lib::ftp;
use File::Basename;
# How much arguments i need and commands manages
my %map_commands = (
ls => { ssl => { name => 'list' }, nossl => { name => 'dir'} },
);
sub new {
my ($class, %options) = @_;
my $self = $class->SUPER::new(package => __PACKAGE__, %options);
bless $self, $class;
$self->{version} = '1.0';
$options{options}->add_options(arguments =>
{
"hostname:s" => { name => 'hostname' },
"port:s" => { name => 'port', },
"ssl" => { name => 'use_ssl' },
"ftp-options:s@" => { name => 'ftp_options' },
"directory:s@" => { name => 'directory' },
"max-depth:s" => { name => 'max_depth', default => 0 },
"username:s" => { name => 'username' },
"password:s" => { name => 'password' },
"warning:s" => { name => 'warning' },
"critical:s" => { name => 'critical' },
"filter-file:s" => { name => 'filter_file' },
"timeout:s" => { name => 'timeout', default => '30' },
});
return $self;
}
sub check_options {
my ($self, %options) = @_;
$self->SUPER::init(%options);
if (($self->{perfdata}->threshold_validate(label => 'warning', value => $self->{option_results}->{warning})) == 0) {
$self->{output}->add_option_msg(short_msg => "Wrong warning threshold '" . $self->{option_results}->{warning} . "'.");
$self->{output}->option_exit();
}
if (($self->{perfdata}->threshold_validate(label => 'critical', value => $self->{option_results}->{critical})) == 0) {
$self->{output}->add_option_msg(short_msg => "Wrong critical threshold '" . $self->{option_results}->{critical} . "'.");
$self->{output}->option_exit();
}
if (!defined($self->{option_results}->{hostname})) {
$self->{output}->add_option_msg(short_msg => "Please set the hostname option");
$self->{output}->option_exit();
}
$self->{ssl_or_not} = 'nossl';
if (defined($self->{option_results}->{use_ssl})) {
$self->{ssl_or_not} = 'ssl';
}
}
sub run {
my ($self, %options) = @_;
my $cpt;
my @files;
my @array;
apps::protocols::ftp::lib::ftp::connect($self);
my $count = $self->countFiles();
apps::protocols::ftp::lib::ftp::quit();
my $exit_code = $self->{perfdata}->threshold_check(value => $count,
threshold => [ { label => 'critical', exit_litteral => 'critical' }, { label => 'warning', exit_litteral => 'warning' } ]);
$self->{output}->output_add(severity => $exit_code,
short_msg => sprintf("Number of files : %s", $count));
$self->{output}->perfdata_add(label => 'files',
value => $count,
warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning'),
critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical'),
min => 0);
$self->{output}->display();
$self->{output}->exit();
}
sub countFiles {
my ($self) = @_;
my @listings;
my $count = 0;
if (!defined($self->{option_results}->{directory}) || scalar(@{$self->{option_results}->{directory}}) == 0) {
push @listings, [ { name => '.', level => 0 } ];
} else {
foreach my $dir (@{$self->{option_results}->{directory}}) {
push @listings, [ { name => $dir, level => 0 } ];
}
}
my @build_name = ();
foreach my $list (@listings) {
while (@$list) {
my @files;
my $hash = pop @$list;
my $dir = $hash->{name};
my $level = $hash->{level};
if (!(@files = apps::protocols::ftp::lib::ftp::execute($self, command => $map_commands{ls}->{$self->{ssl_or_not}}->{name}, command_args => [$dir]))) {
# Cannot list we skip
next;
}
foreach my $line (@files) {
# IIS: 05-13-15 10:59AM 1184403 test.jpg
next if ($line !~ /(\S+)\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+\S+\s+(.*)/ &&
$line !~ /^\s*\S+\s*\S+\s*(\S+)\s+(.*)/);
my ($rights, $filename) = ($1, $2);
my $bname = basename($filename);
next if ($bname eq '.' || $bname eq '..');
my $name = $dir . '/' . $bname;
if (defined($self->{option_results}->{filter_file}) && $self->{option_results}->{filter_file} ne '' &&
$name !~ /$self->{option_results}->{filter_file}/) {
$self->{output}->output_add(long_msg => sprintf("Skipping '%s'", $name));
next;
}
if ($rights =~ /^(d|<DIR>)/i) {
if (defined($self->{option_results}->{max_depth}) && $level + 1 <= $self->{option_results}->{max_depth}) {
push @$list, { name => $name, level => $level + 1};
}
} else {
$self->{output}->output_add(long_msg => sprintf("Match '%s'", $name));
$count++;
}
}
}
}
return $count;
}
1;
__END__
=head1 MODE
Count files in an FTP directory (can be recursive).
=over 8
=item B<--hostname>
IP Addr/FQDN of the ftp host
=item B<--port>
Port used
=item B<--ssl>
Use SSL connection
Need Perl 'Net::FTPSSL' module
=item B<--ftp-options>
Add custom ftp options.
Example: --ftp-options='Debug=1" --ftp-options='useSSL=1'
=item B<--username>
Specify username for authentification
=item B<--password>
Specify password for authentification
=item B<--timeout>
Connection timeout in seconds (Default: 30)
=item B<--warning>
Threshold warning (number of files)
=item B<--critical>
Threshold critical (number of files)
=item B<--directory>
Check files in the directory (Multiple option)
=item B<--max-depth>
Don't check fewer levels (Default: '0'. Means current dir only).
=item B<--filter-file>
Filter files (can be a regexp. Directory is in the name).
=back
=cut