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.

136 lines
3.1 KiB

<?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.
**/
/**
* A class for Zabbix re-branding.
*/
class CBrandHelper {
const BRAND_CONFIG_FILE_PATH = '/../../../local/conf/brand.conf.php';
/**
* Brand configuration array.
*
* @var array
*/
private static $config = [];
/**
* Lazy configuration loading.
*/
private static function loadConfig() {
if (!self::$config) {
$config_file_path = realpath(dirname(__FILE__).self::BRAND_CONFIG_FILE_PATH);
if (file_exists($config_file_path)) {
self::$config = include $config_file_path;
if (is_array(self::$config)) {
self::$config['IS_REBRANDED'] = true;
}
else {
self::$config = [];
}
}
}
}
/**
* Get value by key from configuration (load configuration if needed).
*
* @param string $key configuration key
* @param mixed $default default value
*
* @return mixed
*/
private static function getValue($key, $default = false) {
self::loadConfig();
return (array_key_exists($key, self::$config) ? self::$config[$key] : $default);
}
/**
* Is branding active ?
*
* @return boolean
*/
public static function isRebranded() {
return self::getValue('IS_REBRANDED');
}
/**
* Get help URL.
*
* @return string
*/
public static function getHelpUrl() {
return self::getValue('BRAND_HELP_URL', 'https://www.zabbix.com/documentation/'.
(preg_match('/^\d+\.\d+/', ZABBIX_VERSION, $version) ? $version[0].'/' : '')
);
}
/**
* Get logo of the specified type.
*
* @return string
*/
public static function getLogo(int $type): ?string {
switch ($type) {
case LOGO_TYPE_NORMAL:
return self::getValue('BRAND_LOGO', null);
case LOGO_TYPE_SIDEBAR:
return self::getValue('BRAND_LOGO_SIDEBAR', null);
case LOGO_TYPE_SIDEBAR_COMPACT:
return self::getValue('BRAND_LOGO_SIDEBAR_COMPACT', null);
}
return null;
}
/**
* Get footer content.
*
* @param boolean $with_version
*
* @return array
*/
public static function getFooterContent($with_version) {
$footer = self::getValue(
'BRAND_FOOTER',
[
$with_version ? 'Zabbix '.ZABBIX_VERSION.'. ' : null,
COPYR(), ' '.ZABBIX_COPYRIGHT_FROM, NDASH(), ZABBIX_COPYRIGHT_TO.', ',
(new CLink('Zabbix SIA', 'https://www.zabbix.com/'))
->addClass(ZBX_STYLE_GREY)
->addClass(ZBX_STYLE_LINK_ALT)
->setTarget('_blank')
]
);
if (!is_array($footer)) {
$footer = [$footer];
}
return $footer;
}
}