From 8c084618efcd27fb3e925b90d0eaf5239af4df7e Mon Sep 17 00:00:00 2001 From: Simon BOMM Date: Fri, 12 Sep 2014 11:55:46 +0200 Subject: [PATCH] Add filescount mode for FTP protocol, recursive count available --- apps/protocols/ftp/mode/filescount.pm | 209 ++++++++++++++++++++++++++ apps/protocols/ftp/plugin.pm | 1 + 2 files changed, 210 insertions(+) create mode 100644 apps/protocols/ftp/mode/filescount.pm diff --git a/apps/protocols/ftp/mode/filescount.pm b/apps/protocols/ftp/mode/filescount.pm new file mode 100644 index 000000000..65f87e67c --- /dev/null +++ b/apps/protocols/ftp/mode/filescount.pm @@ -0,0 +1,209 @@ +############################################################################### +# Copyright 2005-2014 MERETHIS +# Centreon is developped by : Julien Mathis and Romain Le Merlus under +# GPL Licence 2.0. +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free Software +# Foundation ; either version 2 of the License. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License along with +# this program; if not, see . +# +# Linking this program statically or dynamically with other modules is making a +# combined work based on this program. Thus, the terms and conditions of the GNU +# General Public License cover the whole combination. +# +# As a special exception, the copyright holders of this program give MERETHIS +# permission to link this program with independent modules to produce an timeelapsedutable, +# regardless of the license terms of these independent modules, and to copy and +# distribute the resulting timeelapsedutable under terms of MERETHIS choice, provided that +# MERETHIS also meet, for each linked independent module, the terms and conditions +# of the license of that module. An independent module is a module which is not +# derived from this program. If you modify this program, you may extend this +# exception to your version of the program, but you are not obliged to do so. If you +# do not wish to do so, delete this exception statement from your version. +# +# For more information : contact@centreon.com +# Author : Quentin Garnier +# +#################################################################################### + +package apps::protocols::ftp::mode::filescount; + +use base qw(centreon::plugins::mode); + +use strict; +use warnings; +use apps::protocols::ftp::lib::ftp; + +# How much arguments i need and commands manages +my %map_commands = ( + mdtm => { ssl => { name => '_mdtm' }, nossl => { name => 'mdtm' } }, + ls => { ssl => { name => 'nlst' }, nossl => { name => 'ls'} }, +); + +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' }, + "recursive" => { name => 'recursive' }, + "username:s" => { name => 'username' }, + "password:s" => { name => 'password' }, + "warning:s" => { name => 'warning' }, + "critical:s" => { name => 'critical' }, + "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 ($ref_array, $globalCount, $flag) = $self->countFiles(@{$self->{option_results}->{directory}}); + @array = @$ref_array; + + if (defined($self->{option_results}->{recursive})) { + while ($flag == 1) { + ($ref_array, $cpt, $flag) = $self->countFiles(@array); + $globalCount = $globalCount + $cpt; + @array = @$ref_array; + } + } + apps::protocols::ftp::lib::ftp::quit(); + + my $exit_code = $self->{perfdata}->threshold_check(value => $globalCount, + 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", $globalCount)); + $self->{output}->perfdata_add(label => 'files', + value => $globalCount, + warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning'), + critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical'), + ); + $self->{output}->display(); + $self->{output}->exit(); +} + +sub countFiles { + my ($self, @array) = @_; + my @files; + my @subdirs; + my $size; + my $cpt = 0; + my $time_result; + my $flag = 0; + + foreach my $dir (@array) { + if (!(@files = apps::protocols::ftp::lib::ftp::execute($self, command => $map_commands{ls}->{$self->{ssl_or_not}}->{name}, command_args => [$dir]))) { + $flag = 0; + } + + foreach my $file (@files) { + if (!($time_result = apps::protocols::ftp::lib::ftp::execute($self, command => $map_commands{mdtm}->{$self->{ssl_or_not}}->{name}, command_args => [$file]))) { + push(@subdirs, $file); + $flag = 1; + } + $cpt++; + } + $size = @subdirs; + } + $cpt = $cpt - $size; + return \@subdirs, $cpt, $flag; +} + +1; + +__END__ + +=head1 MODE + +Count files in an FTP directory, cab 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) + +=back + +=cut diff --git a/apps/protocols/ftp/plugin.pm b/apps/protocols/ftp/plugin.pm index 389a7f5f6..410530ecf 100644 --- a/apps/protocols/ftp/plugin.pm +++ b/apps/protocols/ftp/plugin.pm @@ -50,6 +50,7 @@ sub new { 'login' => 'apps::protocols::ftp::mode::login', 'commands' => 'apps::protocols::ftp::mode::commands', 'date' => 'apps::protocols::ftp::mode::date', + 'filescount'=> 'apps::protocols::ftp::mode::filescount', ); return $self; }