centreon-plugins/database/mysql/mysqlcmd.pm

351 lines
9.6 KiB
Perl

#
# Copyright 2020 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 database::mysql::mysqlcmd;
use strict;
use warnings;
use centreon::plugins::misc;
use Digest::MD5 qw(md5_hex);
sub new {
my ($class, %options) = @_;
my $self = {};
bless $self, $class;
# $options{options} = options object
# $options{output} = output object
# $options{exit_value} = integer
# $options{noptions} = integer
if (!defined($options{output})) {
print "Class mysqlcmd: Need to specify 'output' argument.\n";
exit 3;
}
if (!defined($options{options})) {
$options{output}->add_option_msg(short_msg => "Class Mysqlcmd: Need to specify 'options' argument.");
$options{output}->option_exit();
}
if (!defined($options{noptions})) {
$options{options}->add_options(arguments => {
'mysql-cmd:s' => { name => 'mysql_cmd', default => '/usr/bin/mysql' },
'host:s@' => { name => 'host' },
'port:s@' => { name => 'port' },
'username:s@' => { name => 'username' },
'password:s@' => { name => 'password' },
'socket:s@' => { name => 'socket' },
'sql-errors-exit:s' => { name => 'sql_errors_exit', default => 'unknown' }
});
}
$options{options}->add_help(package => __PACKAGE__, sections => 'MYSQLCMD OPTIONS', once => 1);
$self->{output} = $options{output};
$self->{sqlmode_name} = $options{sqlmode_name};
$self->{args} = undef;
$self->{stdout} = undef;
$self->{columns} = undef;
$self->{version} = undef;
$self->{host} = undef;
$self->{port} = undef;
$self->{socket} = undef;
$self->{username} = undef;
$self->{password} = undef;
return $self;
}
sub set_options {
my ($self, %options) = @_;
$self->{option_results} = $options{option_results};
}
sub set_defaults {
my ($self, %options) = @_;
foreach (keys %{$options{default}}) {
if ($_ eq $self->{sqlmode_name}) {
for (my $i = 0; $i < scalar(@{$options{default}->{$_}}); $i++) {
foreach my $opt (keys %{$options{default}->{$_}[$i]}) {
if (!defined($self->{option_results}->{$opt}[$i])) {
$self->{option_results}->{$opt}[$i] = $options{default}->{$_}[$i]->{$opt};
}
}
}
}
}
}
sub check_options {
my ($self, %options) = @_;
$self->{host} = (defined($self->{option_results}->{host})) ? shift(@{$self->{option_results}->{host}}) : undef;
$self->{port} = (defined($self->{option_results}->{port})) ? shift(@{$self->{option_results}->{port}}) : undef;
$self->{socket} = (defined($self->{option_results}->{socket})) ? shift(@{$self->{option_results}->{socket}}) : undef;
$self->{username} = (defined($self->{option_results}->{username})) ? shift(@{$self->{option_results}->{username}}) : undef;
$self->{password} = (defined($self->{option_results}->{password})) ? shift(@{$self->{option_results}->{password}}) : undef;
$self->{sql_errors_exit} = $self->{option_results}->{sql_errors_exit};
$self->{mysql_cmd} = $self->{option_results}->{mysql_cmd};
if (!defined($self->{host}) || $self->{host} eq '') {
$self->{output}->add_option_msg(short_msg => 'Need to specify host argument.');
$self->{output}->option_exit(exit_litteral => $self->{sql_errors_exit});
}
$self->{args} = ['--batch', '--raw', '--host', $self->{host}];
if (defined($self->{port})) {
push @{$self->{args}}, "--port", $self->{port};
}
if (defined($self->{username})) {
push @{$self->{args}}, "--user", $self->{username};
}
if (defined($self->{password}) && $self->{password} ne '') {
push @{$self->{args}}, "-p" . $self->{password};
}
if (defined($self->{socket}) && $self->{socket} ne '') {
push @{$self->{args}}, "--socket", $self->{socket};
}
if (scalar(@{$self->{option_results}->{host}}) == 0) {
return 0;
}
return 1;
}
sub is_version_minimum {
my ($self, %options) = @_;
# $options{version} = string version to check
my @version_src = split /\./, $self->{version};
my @versions = split /\./, $options{version};
for (my $i = 0; $i < scalar(@versions); $i++) {
return 1 if ($versions[$i] eq 'x');
return 1 if (!defined($version_src[$i]));
$version_src[$i] =~ /^([0-9]*)/;
next if ($versions[$i] == int($1));
return 0 if ($versions[$i] > int($1));
return 1 if ($versions[$i] < int($1));
}
return 1;
}
sub get_id {
my ($self, %options) = @_;
my $msg = $self->{host};
if (defined($self->{port})) {
$msg .= ":" . $self->{port};
}
return $msg;
}
sub get_unique_id4save {
my ($self, %options) = @_;
my $msg = $self->{host};
if (defined($self->{port})) {
$msg .= ":" . $self->{port};
}
return md5_hex($msg);
}
sub quote {
my $self = shift;
return undef;
}
sub command_execution {
my ($self, %options) = @_;
my ($lerror, $stdout, $exit_code) = centreon::plugins::misc::backtick(
command => $self->{mysql_cmd},
arguments => [@{$self->{args}}, '-e', $options{request}],
timeout => 30,
wait_exit => 1,
redirect_stderr => 1
);
if ($exit_code <= -1000) {
if ($exit_code == -1000) {
$self->{output}->output_add(severity => 'UNKNOWN',
short_msg => $stdout);
}
$self->{output}->display();
$self->{output}->exit();
}
return ($exit_code, $stdout);
}
sub disconnect {}
sub is_mariadb {
my ($self) = @_;
return $self->{is_mariadb};
}
sub set_version {
my ($self, %options) = @_;
$self->{is_mariadb} = 0;
$self->{version} = $options{version};
# MariaDB: 5.5.5-10.1.36-MariaDB or 10.1.36-MariaDB
if ($self->{version} =~ /([0-9\.]*?)-MariaDB/i) {
$self->{version} = $1;
$self->{is_mariadb} = 1;
}
}
sub connect {
my ($self, %options) = @_;
my $dontquit = (defined($options{dontquit}) && $options{dontquit} == 1) ? 1 : 0;
(my $exit_code, $self->{stdout}) = $self->command_execution(request => "SHOW VARIABLES LIKE 'version'");
if ($exit_code != 0) {
if ($dontquit == 0) {
$self->{output}->add_option_msg(short_msg => 'Cannot connect: ' . $self->{stdout});
$self->{output}->option_exit(exit_litteral => $self->{sql_errors_exit});
}
return (-1, 'Cannot connect: ' . $self->{stdout});
}
my $row = $self->fetchrow_hashref();
$self->set_version(version => $row->{Value});
return 0;
}
sub fetchall_arrayref {
my ($self, %options) = @_;
my $array_ref = [];
if (!defined($self->{columns})) {
$self->{stdout} =~ s/^(.*?)(\n|$)//;
@{$self->{columns}} = split(/\t/, $1);
}
foreach (split /\n/, $self->{stdout}) {
push @$array_ref, [map({ s/\\n/\x{0a}/g; s/\\t/\x{09}/g; s/\\/\x{5c}/g; $_; } split(/\t/, $_))];
}
return $array_ref;
}
sub fetchrow_array {
my ($self, %options) = @_;
my @array_result = ();
if (!defined($self->{columns})) {
$self->{stdout} =~ s/^(.*?)(\n|$)//;
@{$self->{columns}} = split(/\t/, $1);
}
if (($self->{stdout} =~ s/^(.*?)(\n|$)//)) {
push @array_result, map({ s/\\n/\x{0a}/g; s/\\t/\x{09}/g; s/\\/\x{5c}/g; $_; } split(/\t/, $1));
}
return @array_result;
}
sub fetchrow_hashref {
my ($self, %options) = @_;
my $array_result = undef;
if (!defined($self->{columns})) {
$self->{stdout} =~ s/^(.*?)(\n|$)//;
@{$self->{columns}} = split(/\t/, $1);
}
if ($self->{stdout} ne '' && $self->{stdout} =~ s/^(.*?)(\n|$)//) {
$array_result = {};
my @values = split(/\t/, $1);
for (my $i = 0; $i < scalar(@values); $i++) {
my $value = $values[$i];
$value =~ s/\\n/\x{0a}/g;
$value =~ s/\\t/\x{09}/g;
$value =~ s/\\/\x{5c}/g;
$array_result->{$self->{columns}[$i]} = $value;
}
}
return $array_result;
}
sub query {
my ($self, %options) = @_;
$self->{columns} = undef;
(my $exit_code, $self->{stdout}) = $self->command_execution(request => $options{query});
if ($exit_code != 0) {
$self->{output}->add_option_msg(short_msg => 'Cannot execute query: ' . $self->{stdout});
$self->{output}->option_exit(exit_litteral => $self->{sql_errors_exit});
}
}
1;
__END__
=head1 NAME
mysqlcmd global
=head1 SYNOPSIS
mysqlcmd class
=head1 MYSQLCMD OPTIONS
=over 8
=item B<--mysql-cmd>
mysql command (Default: '/usr/bin/mysql').
=item B<--host>
Database hostname.
=item B<--port>
Database port.
=item B<--username>
Database username.
=item B<--password>
Database password.
=item B<--sql-errors-exit>
Exit code for DB Errors (default: unknown)
=back
=head1 DESCRIPTION
B<snmp>.
=cut