You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

221 lines
4.8 KiB

1 year ago
<?php
/*
** Zabbix
** Copyright (C) 2001-2023 Zabbix SIA
**
** 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, or
** (at your option) any later version.
**
** 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, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
/**
* Abstract database backend class.
*/
abstract class DbBackend {
protected $warning;
/**
* Error message.
*
* @var string
*/
protected $error;
/**
* TLS encryption on/off.
*
* @var bool
*/
protected $tls_encryption = false;
/**
* Path to TLS key file.
*
* @var string
*/
protected $tls_key_file = '';
/**
* Path to TLS cert file.
*
* @var string
*/
protected $tls_cert_file = '';
/**
* Path to TLS ca file.
*
* @var string
*/
protected $tls_ca_file = '';
/**
* True - need host verification..
*
* @var bool
*/
protected $tls_verify_host = true;
/**
* Connection required cipher pattern.
*
* @var string
*/
protected $tls_cipher_list = '';
/**
* Set TLS specific options for db connection.
*
* @param string $key_file Path to TLS key file.
* @param string $cert_file Path to TLS cert file.
* @param string $ca_file Path to TLS ca file.
* @param bool $verify_host True - need host verification.
* @param string $cipher_list Connection required cipher pattern.
*/
public function setConnectionSecurity($key_file, $cert_file, $ca_file, $verify_host, $cipher_list) {
$this->tls_encryption = true;
$this->tls_key_file = $key_file;
$this->tls_cert_file = $cert_file;
$this->tls_ca_file = $ca_file;
$this->tls_verify_host = $verify_host;
$this->tls_cipher_list = $cipher_list;
}
/**
* Check if 'dbversion' table exists.
*
* @return boolean
*/
abstract protected function checkDbVersionTable();
/**
* Create connection to database server.
*
* @param string $host Host name.
* @param string $port Port.
* @param string $user User name.
* @param string $password Password.
* @param string $dbname Database name.
* @param string $schema DB schema.
*
* @return resource|null
*/
abstract public function connect($host, $port, $user, $password, $dbname, $schema);
/**
* Check if connected database version matches with frontend version.
*
* @return bool
*/
public function checkDbVersion() {
if (!$this->checkDbVersionTable()) {
return false;
}
$version = DBfetch(DBselect('SELECT dv.mandatory FROM dbversion dv'));
if ($version['mandatory'] != ZABBIX_DB_VERSION) {
$this->setError(_s('The Zabbix database version does not match current requirements. Your database version: %1$s. Required version: %2$s. Please contact your system administrator.',
$version['mandatory'], ZABBIX_DB_VERSION
));
return false;
}
return true;
}
/**
* Check the integrity of the table "config".
*
* @return bool
*/
public function checkConfig() {
if (!DBfetch(DBselect('SELECT NULL FROM config c'))) {
$this->setError(_('Unable to select configuration.'));
return false;
}
return true;
}
/**
* Create INSERT SQL query for MySQL, PostgreSQL.
* Creation example:
* INSERT INTO items (itemid,name,key_,type)
* VALUES ('10201','agent.hostname','agent.hostname',1),('10202','agent.ping','agent.ping',1);
*
* @param string $table
* @param array $fields
* @param array $values
*
* @return string
*/
public function createInsertQuery($table, array $fields, array $values) {
$sql = 'INSERT INTO '.$table.' ('.implode(',', $fields).') VALUES ';
foreach ($values as $row) {
$sql .= '('.implode(',', array_values($row)).'),';
}
$sql = substr($sql, 0, -1);
return $sql;
}
/**
* Set error string.
*
* @param string $error
*/
public function setError($error) {
$this->error = $error;
}
/**
* Return error or null if no error occurred.
*
* @return mixed
*/
public function getError() {
return $this->error;
}
/**
* Check database and table fields encoding.
*
* @return bool
*/
abstract public function checkEncoding();
/**
* Set warning message.
*
* @param string $message
*/
public function setWarning($message) {
$this->warning = $message;
}
/**
* Get warning message.
*
* @return mixed
*/
public function getWarning() {
return $this->warning;
}
}