';
// header row
if (isset($options['columns'])) {
$html .= get_table_header($options['columns']);
unset($options['columns']);
} else {
$html .= '';
foreach ($array[0] as $key => $value) {
$html .= '' . escape_html(nicecase($key)) . ' | ';
}
$html .= '
';
}
// data rows
foreach ($array as $key => $value) {
$html .= '
';
foreach ($value as $key2 => $value2) {
// Entry defaults
$escape = TRUE;
$style = '';
$class = '';
if (isset($options[$key2])) {
$options2 = $options[$key2];
if (is_array($options2)) {
$type = $options2['type'];
// Allow extra options
if (isset($options2['escape'])) {
$escape = $options2['escape'];
}
if (isset($options2['style'])) {
$style = $options2['style'];
}
if (isset($options2['class'])) {
$class = $options2['class'];
}
} else {
$type = $options2;
}
} else {
$type = NULL;
}
switch ($type) {
case 'unixtime':
$value2 = format_unixtime($value2);
break;
case 'prettytime':
$value2 = generate_tooltip_time($value2, 'ago');
break;
case 'device':
$value2 = generate_device_link($value2);
break;
case 'json':
$json = safe_json_encode(safe_json_decode($value2), JSON_PRETTY_PRINT);
$value2 = '' . $json . '
';
break;
default:
if ($escape) {
$value2 = escape_html($value2);
}
}
if ($style || $class) {
$value2 = '' . $value2 . '';
}
$html .= '' . $value2 . ' | ';
}
$html .= '
';
}
// finish table and return it
$html .= '';
return $html;
}
function build_table_row($array, $options = [])
{
// Calculate max columns
$cols = 0;
foreach ($array as $entry) {
$cols = max(safe_count($entry), $cols);
}
// start table
$html = '';
// header row
/*
$html .= '';
foreach($array[0] as $key => $value)
{
$html .= '' . $key . ' | ';
}
$html .= '
';
*/
// data rows
foreach ($array as $key => $entry) {
$html .= '';
$html .= '' . $key . ' | ';
$values = array_values((array)$entry);
for ($i = 0; $i <= $cols; $i++) {
$value = $values[$i];
switch ($options[$key]) {
case 'prettytime':
$value = generate_tooltip_time($value, 'ago');
break;
case 'unixtime':
$value = format_unixtime($value);
break;
case 'device':
$value = generate_device_link($value);
break;
}
$html .= '' . $value . ' | ';
}
$html .= '
';
}
// finish table and return it
$html .= '
';
return $html;
}
/**
* Print refresh meta header
*
* This function print refresh meta header and return status for current page
* with refresh time, list and allowed refresh times.
* Uses variables $vars['refresh'], $_SESSION['refresh'], $config['page_refresh']
*
* @param array $vars
*
* @return array $return
* @global string $GLOBALS ['config']['page_refresh']
* @global string $_SESSION ['refresh']
*/
function print_refresh($vars)
{
if (!$_SESSION['authenticated']) {
// Do not print refresh header if not authenticated session, common use in logon page
return ['allowed' => FALSE];
}
$refresh_array = $GLOBALS['config']['wui']['refresh_times']; // Allowed refresh times
$refresh_time = 300; // Default page reload time (5 minutes)
if (isset($vars['refresh'])) {
if (is_numeric($vars['refresh']) && in_array($vars['refresh'], $refresh_array)) {
$refresh_time = (int)$vars['refresh'];
// Store for SESSION
session_set_var('page_refresh', $refresh_time);
}
// Unset refresh var after
unset($GLOBALS['vars']['refresh']);
} elseif (isset($_SESSION['page_refresh']) && in_array($_SESSION['page_refresh'], $refresh_array)) {
$refresh_time = (int)$_SESSION['page_refresh'];
} elseif (is_numeric($GLOBALS['config']['page_refresh']) && in_array($GLOBALS['config']['page_refresh'], $refresh_array)) {
$refresh_time = (int)$GLOBALS['config']['page_refresh'];
}
// List vars where page refresh full disabled - FIXME move to definitions!
$refresh_disabled = $GLOBALS['config']['wui']['refresh_disabled'];
$refresh_allowed = TRUE;
foreach ($refresh_disabled as $var_test) {
$var_count = safe_count($var_test);
foreach ($var_test as $key => $value) {
if (isset($vars[$key]) && $vars[$key] == $value) {
$var_count--;
}
}
if ($var_count === 0) {
$refresh_allowed = FALSE;
break;
}
}
$return = ['allowed' => $refresh_allowed,
'current' => $refresh_time,
'list' => $refresh_array];
if ($refresh_allowed && $refresh_time) {
register_html_meta('refresh', $refresh_time, 'http-equiv');
//echo(' ' . "\n");
$return['nexttime'] = time() + $refresh_time; // Add unixtime for next refresh
}
return $return;
}
/**
* Print box styled text, default with shadow and centered. For change defaults use no-shadow or no-center options
* @param string $text
* @param string $type
* @param array|string|bool $options
*
* @return void
*/
function print_box($text, $type = '', $options = []) {
if (is_bool($options)) {
// boolean manage only no-shadow option
$options = $options ? [ 'no-shadow' ] : [];
} elseif (!is_array($options)) {
// option string convert to array
$options = explode(' ', $options);
}
$class = 'shadow-box'; // boxed class (default with shadow)
switch ($type) {
case 'ok':
case 'success':
$class .= ' text-success bg-success'; // green
break;
case 'warning':
$class .= ' text-warning bg-warning'; // yellow
break;
case 'error':
case 'danger':
case 'alert':
$class .= ' text-danger bg-danger'; // red
break;
case 'suppressed':
$class .= ' text-suppressed bg-suppressed'; // magenta
break;
case 'info':
$class .= ' text-info bg-info'; // blue
break;
default:
$class .= ''; // clean
break;
}
// disable shadow when requested in options
if (in_array('no-shadow', $options, TRUE)) {
$class .= ' no-shadow';
}
// default centered text while no-center requested
if (!in_array('no-center', $options, TRUE)) {
$class .= ' text-center';
}
// strip cli tags from text when requested
if (in_array('strip', $options, TRUE)) {
$text = message_strip_tags($text);
}
// escape text when requested
if (in_array('escape', $options, TRUE)) {
$text = escape_html($text);
}
// use div container instead
if (in_array('div', $options, TRUE)) {
echo ''.$text.'
';
return;
}
//r($text);
echo ''.$text.'
';
}
/**
* This generates an HTML element based on the contents of the $header array, modified by the current request $vars
*
* @param array $header Array with table header definition including columns and classes.
* @param array $vars Array with current selected column ID and/or variables for generate column link
*
* @return string $string
*/
function generate_table_header($header = [], $vars = []) {
// Store current $vars sort variables
if (safe_empty($vars) || get_var_false($vars['show_sort'] ?? '')) {
// disable sorting, when empty vars, because unknown current page
$sort = FALSE;
} else {
$sort = $vars['sort'];
}
$sort_order = strtolower($vars['sort_order']);
if (!in_array($sort_order, [ 'asc', 'desc', 'reset' ])) {
$sort_order = 'asc';
}
if (isset($vars['show_header']) && get_var_false($vars['show_header'])) {
// Override style as invisible
$header['style'] = 'line-height: 0; visibility: collapse;';
}
$output = ' ' . PHP_EOL;
return $output;
}
function generate_table_header_field($field_id, $field, $vars, $sort, $sort_order) {
if (empty($field)) {
// No label, generate empty column header.
return '';
}
if (is_numeric($field_id) && !is_array($field)) {
// Label without id, generate simple column header
return $field;
}
if (!is_array($field)) {
$field = [ 'label' => $field ];
}
// Sorting fields
if (!isset($field['label'])) {
$field['label'] = $field[0];
}
if ($sort === FALSE) {
// Sorting forced to disable
$return = $field['label'];
} else {
if ($sort == $field_id) {
$field['label'] = '' . $field['label'] . '';
if ($sort_order === 'asc') {
$new_vars = [ 'sort' => $field_id, 'sort_order' => 'desc' ];
$field['caret'] = ' '; // glyphicon-triangle-top
} else {
$new_vars = [ 'sort' => NULL, 'sort_order' => NULL ];
$field['caret'] = ' '; // glyphicon-triangle-bottom
}
} else {
$new_vars = [ 'sort' => $field_id ];
}
$return = '' . $field['label'] . $field['caret'] . '';
}
// Generate slash separated links for subfields
if (isset($field['subfields'])) {
$subfields = [];
foreach ($field['subfields'] as $subfield_id => $subfield) {
//r($subfield); r($subfield_id);
$subfields[] = generate_table_header_field($subfield_id, $subfield, $vars, $sort, $sort_order);
}
$return .= ' [' . implode(" / ", $subfields) . ']';
}
return $return;
}
/**
* WARNING.
* Deprecated, convert to generate_table_header().
*
* Helper function for generate table header with sort links
* This used in other print_* functions
*
* @param array $cols Array with column IDs, names and column styles
* @param array $vars Array with current selected column ID and/or variables for generate column link
*
* @return string $string
*/
function get_table_header($cols, $vars = [])
{
// Convert to new format for generate_table_header()
$new_cols = [];
foreach ($cols as $id => $col) {
if (is_array($col)) {
if (str_contains($col[1], 'state-marker')) {
$new_cols['state-marker'] = '';
continue;
}
if (empty($col)) {
$new_cols[$id] = [ NULL ];
continue;
}
$new_cols[$id] = [ $id => $col[0] ];
if (str_starts_with($col[1], 'class=')) {
$new_cols[$id]['class'] = preg_replace('/^class=(["\'])(.+?)\1/', '$2', $col[1]);
}
if (str_starts_with($col[1], 'style=')) {
$new_cols[$id]['style'] = preg_replace('/^style=(["\'])(.+?)\1/', '$2', $col[1]);
}
} else {
$new_cols[$id] = [ $id => $col ];
}
}
return generate_table_header($new_cols, $vars);
}
function print_error_permission($text = NULL, $escape = TRUE)
{
if (empty($text)) {
$text = 'You have insufficient permissions to view this page.';
} elseif ($escape) {
$text = escape_html($text);
}
echo('');
print_error('
Permission error
' . PHP_EOL . $text);
echo('');
}
/**
* Generate html with label group
*
* @param array $params List of button items
* @param array $opt Array with group params and styles
* @param bool $escape Escape or not Item text
*
* @return string Generated html
*/
function get_label_group($params = [], $opt = [], $escape = TRUE)
{
$html = ' $param) {
// If param is just string, convert to simple group
if (is_string($param)) {
$param = [ 'text' => $param, 'event' => 'default' ];
}
$param['div'] = TRUE; // use div for fix display label group in navbar
$param['id'] = $param_id;
$html_params[] = get_label_span($param['text'], $param['event'], $param, $escape);
}
// Return single label (without group), since label group for single item is incorrect
if (safe_count($params) === 1) {
return array_shift($html_params);
}
$html .= implode('', $html_params) . PHP_EOL;
$html .= '' . PHP_EOL;
return $html;
}
function get_label_span($text, $type = '', $opt = [], $escape = TRUE) {
if ($opt['div']) {
$html = '';
$html .= (bool)$escape ? escape_html($text) : $text;
if ($opt['div']) {
$html .= '
'; // close div
} else {
$html .= ''; // close span
}
return $html;
}
/**
* Generate html with button group
*
* @param array $params List of button items
* @param array $opt Array with group params and styles
* @param bool $escape Escape or not Item text
*
* @return string Generated html
*/
function generate_button_group($params = [], $opt = [], $escape = TRUE) {
$class = 'btn-group';
if ($opt['class']) {
$class .= ' ' . $opt['class'];
}
if ($opt['size']) {
$class .= ' btn-group-' . $opt['size'];
} elseif (!str_contains($class, 'btn-group-')) {
// default size xs
$class .= ' btn-group-xs';
}
$buttons_start = ' $param) {
// If param is just string, convert to simple group
if (is_string($param)) {
$param = [ 'text' => $param, 'event' => 'default' ];
}
$html_param = '
' . PHP_EOL;
return $buttons_start . $html . $buttons_end;
}
/**
* Generate html by Markdown formatted text.
*
* @param string $markdown Markdown formatted text
* @param bool $escape Escape html entities
* @param bool $extra Allow Extra Markdown syntax
*
* @return string HTML formatted text
*/
function get_markdown($markdown, $escape = TRUE, $extra = FALSE) {
if ($extra) {
// Allow Extra Markdown syntax
//$parsedown = new ParsedownExtra();
$parsedown = new ParsedownExtraPlugin();
} else {
$parsedown = new Parsedown();
}
if (str_contains_array($markdown, ["\n", "\r"])) {
// Multiline texts must use text()
$html = $parsedown
-> setMarkupEscaped($escape) # escapes markup (HTML)
-> setBreaksEnabled(TRUE) # enables automatic line breaks
-> text($markdown);
return '' . PHP_EOL . $html . PHP_EOL . '
';
}
// Single line (used for messages, eventlogs)
$html = $parsedown
-> setMarkupEscaped($escape) # escapes markup (HTML)
-> setBreaksEnabled(TRUE) # enables automatic line breaks
-> line($markdown);
//print_vars($html);
return '' . $html . '';
}
function get_markdown_extra($markdown, $escape = TRUE) {
return get_markdown($markdown, $escape, TRUE);
}
/**
* Generate icon html tag
*
* @param string $icon Icon name in definitions (ie: flag) or by css class (ie: sprite-flag)
* @param string $class Additional class(es) for changing main icon view
* @param array $attribs Url/link extended attributes (ie data-*, class, style)
*
* @return string HTML icon tag like or emoji style :flag-us: -> 🇺🇸
*/
function get_icon($icon, $class = '', $attribs = [])
{
global $config;
// If the icon is already an HTML tag, return it as is
if (str_contains_array($icon, ['<', '>'])) {
return $icon;
}
$icon = strtolower(trim($icon));
// Use the defined icon if available, else check for an empty icon and return an empty string
$icon = $config['icon'][$icon] ?? ($icon ?: '');
// Handle emoji styled icons
if (preg_match('/^:[\w\-_]+:$/', $icon) || is_intnum($icon)) {
return '' . get_icon_emoji($icon) . '';
}
// Append glyphicon main class if these icons are used
if (str_starts_with($icon, 'glyphicon-')) {
$icon = 'glyphicon ' . $icon;
}
/* elseif (str_starts_with($icon, 'icon-')) {
// Compat old (3.x) fontawesome classes with new (6.x)
// Brands
if (preg_match(OBS_PATTERN_FONTAWESOME_BRANDS, $icon)) {
$icon = 'icon-brands ' . $icon;
}
//$icon .= ' icon-sm';
} */
// Initialize the 'class' key in $attribs if not already set and merge additional classes
$attribs['class'] = array_merge([$icon], (array)$class, $attribs['class'] ?? []);
return '';
}
/**
* Generate emoji icon (ie html hex entity)
*
* @param string $emoji Emoji name in definitions (ie: flag-us or :flag-us:)
* @param string $type Type of emoji for return (currently only html supported)
* @param array $attribs Url/link extended attributes (currently unused)
*
* @return string Emoji in requested type, for html ie: :flag-us: -> 🇺🇸
*/
function get_icon_emoji($emoji, $type = 'html', $attribs = [])
{
global $config;
// Emoji definitions not loaded by default!
// Load of first request
if (!isset($config['emoji']['zero'])) {
include_once $config['install_dir'] . '/includes/definitions/emoji.inc.php';
}
$emoji_name = strtolower(trim($emoji, ": \t\n\r\0\x0B"));
if (is_intnum($emoji)) {
// convert int number string to emoji number
$return = '';
foreach (str_split($emoji) as $num) {
switch ($num) {
case '0':
$return .= get_icon_emoji(':zero:', $type, $attribs);
break;
case '1':
$return .= get_icon_emoji(':one:', $type, $attribs);
break;
case '2':
$return .= get_icon_emoji(':two:', $type, $attribs);
break;
case '3':
$return .= get_icon_emoji(':three:', $type, $attribs);
break;
case '4':
$return .= get_icon_emoji(':four:', $type, $attribs);
break;
case '5':
$return .= get_icon_emoji(':five:', $type, $attribs);
break;
case '6':
$return .= get_icon_emoji(':six:', $type, $attribs);
break;
case '7':
$return .= get_icon_emoji(':seven:', $type, $attribs);
break;
case '8':
$return .= get_icon_emoji(':eight:', $type, $attribs);
break;
case '9':
$return .= get_icon_emoji(':nine:', $type, $attribs);
break;
}
}
return $return;
}
// Unknown emoji name, return original string
if (!isset($config['emoji'][$emoji_name])) {
return $emoji;
}
$type = strtolower($type);
$entry = $config['emoji'][$emoji_name];
switch ($type) {
case 'unified':
case 'non_qualified':
$return = escape_html($entry[$type]);
break;
case 'html':
default:
// 26A0-FE0F -> ⚠️
$emoji_html = explode('-', escape_html($entry['unified'])); // escaping for prevent pass to definitions html code
$return = '' . implode(';', $emoji_html) . ';';
}
return $return;
}
/**
* Generate icon html tag with country flag
*
* @param string $country Country name or code
*
* @return string HTML icon tag like
*/
function get_icon_country($country)
{
global $config;
// Unificate country name
$country = country_from_code($country);
// Find ISO 2 country code (must be first in definitions)
$code = strtolower(array_search($country, $config['rewrites']['countries']));
if (empty($code)) {
return get_icon('location');
}
return '';
}
function print_json_status($status, $message = '', $array = [])
{
if (!in_array($status, ['ok', 'failed', 'warning'])) {
$status = 'failed';
}
$return = ['status' => $status, 'message' => $message];
if (safe_count($array)) {
if (isset($array['message']) && empty($message)) {
// prefer not empty message
unset($return['message']);
}
$return = array_merge($return, $array);
}
header('Content-Type: application/json');
print safe_json_encode($return);
}
// EOF