'uniqueid',
* 'href' => 'value',
* 'title' => 'title',
* 'callback' => true|false,
* 'class' => 'fa fa-icon'
* ),
* ...
* );
*
* If the callback is true, the Cacti attribute will be added to the href
* to present only the contents and not to include both the headers. If
* the link must go off page, simply make sure $callback is false. There
* is a requirement to use fontawesome icon sets for this class, but it
* can include other classes. In addition, the href can be a hash '#' if
* your page has a ready function that has it's own javascript.
* @param $add_label - used with legacy behavior to add specific text to the link.
* This parameter is only used in the legacy behavior.
*/
function html_start_box($title, $width, $div, $cell_padding, $align, $add_text, $add_label = false) {
global $config;
static $table_suffix = 1;
static $help_count = 0;
static $mode_count = 0;
static $beta_count = 0;
if ($add_label === false) {
$add_label = __('Add');
}
if (!is_cacti_release() && $title != '' && $beta_count == 0) {
$title .= ' [ ' . CACTI_VERSION_BRIEF_FULL . ' ]';
$beta_count++;
}
if ($config['poller_id'] > 1 && $title != '' && $mode_count == 0) {
$title .= ' [ ' . __('Remote Server') . ': ';
if ($config['connection'] == 'offline') {
$title .= '' . __('Offline') . '';
} elseif ($config['connection'] == 'recovery') {
$title .= '' . __('Recovering') . '';
} else {
$title .= __('Online');
}
$title .= ' ]';
$mode_count++;
}
$table_prefix = basename(get_current_page(), '.php');
if (!isempty_request_var('action')) {
$table_prefix .= '_' . clean_up_name(get_nfilter_request_var('action'));
} elseif (!isempty_request_var('report')) {
$table_prefix .= '_' . clean_up_name(get_nfilter_request_var('report'));
} elseif (!isempty_request_var('tab')) {
$table_prefix .= '_' . clean_up_name(get_nfilter_request_var('tab'));
}
$table_id = $table_prefix . $table_suffix;
if ($title != '') {
print "
";
}
}
$table_suffix++;
}
/**
* html_sub_tabs - Creates a memory persistent sub-tab interface
* for a page or pages using a simple method to lay those tabs
* out.
*
* @param array - An associative array of tab variables and names
* Alternatively an array of names that can be converted
* using the strtoupper() function to titles.
* @param string - A string of URL parameters like 'action=edit&id=x'
* @param string - An option session variable to use to store
* the current tab status. Defaults to the page
* name and the suffic of current_tab
*
* @return null - Output is printed to standard output
*/
function html_sub_tabs($tabs, $uri = '', $session_var = '') {
/* determine the session variables if not set */
if ($session_var == '') {
$session_var = basename(get_current_page(), '.php') . '_current_tab';
}
$page_name = get_current_page() . '?' . $uri . ($uri != '' ? '&':'');
/* set the default settings category */
if (!isset_request_var('tab')) {
/* there is no selected tab; select the first one */
if (isset($_SESSION[$session_var])) {
$current_tab = $_SESSION[$session_var];
} else {
$current_tab = array_keys($tabs)[0];
}
} else {
$current_tab = get_request_var('tab');
}
/* Check to see if the tab exists, and if not, use the default */
if (!isset($tabs[$current_tab])) {
$current_tab = array_keys($tabs)[0];
}
$_SESSION[$session_var] = $current_tab;
set_request_var('tab', $current_tab);
/* draw the categories tabs on the top of the page */
print '
';
print "
';
print '
';
}
/**
* html_end_box - draws the end of an HTML box
*
* @param $trailing_br (bool) - whether to draw a trailing tag after ending
* @param $div (bool) - whether type of box is div or table
*/
function html_end_box($trailing_br = true, $div = false) {
if ($div) {
print '';
} else {
print '
";
}
}
}
/**
* html_graph_thumbnail_area - draws an area the contains thumbnail sized graphs
*
* @param $graph_array - the array to contains graph information. for each graph in the
* array, the following two keys must exist
* $arr[0]["local_graph_id"] // graph id
* $arr[0]["title_cache"] // graph title
* @param $no_graphs_message - display this message if no graphs are found in $graph_array
* @param $extra_url_args - extra arguments to append to the url
* @param $header - html to use as a header
* @param $columns - the number of columns to present
* @param $tree_id - the tree id if this is a tree thumbnail
* @param $branch_id - the branch id if this is a tree thumbnail
*/
function html_graph_thumbnail_area(&$graph_array, $no_graphs_message = '', $extra_url_args = '', $header = '', $columns = 0, $tree_id = 0, $branch_id = 0) {
global $config;
$i = 0;
$k = 0;
$j = 0;
$num_graphs = cacti_sizeof($graph_array);
if ($columns == 0) {
$columns = read_user_setting('num_columns');
}
?>
0) {
if ($header != '') {
print $header;
}
$start = true;
foreach ($graph_array as $graph) {
if (!isset($graph['host_id'])) {
list($graph['host_id'], $graph['disabled']) = db_fetch_row_prepared('SELECT host_id, disabled
FROM graph_local AS gl
LEFT JOIN host AS h
ON gl.host_id = h.id
WHERE gl.id = ?',
array($graph['local_graph_id']));
}
if (isset($graph['graph_template_name'])) {
if (isset($prev_graph_template_name)) {
if ($prev_graph_template_name != $graph['graph_template_name']) {
$prev_graph_template_name = $graph['graph_template_name'];
}
} else {
$prev_graph_template_name = $graph['graph_template_name'];
}
} elseif (isset($graph['data_query_name'])) {
if (isset($prev_data_query_name)) {
if ($prev_data_query_name != $graph['data_query_name']) {
$print = true;
$prev_data_query_name = $graph['data_query_name'];
} else {
$print = false;
}
} else {
$print = true;
$prev_data_query_name = $graph['data_query_name'];
}
if ($print) {
if (!$start) {
while (($i % $columns) != 0) {
print "
';
}
/**
* html_nav_bar - draws a navigation bar which includes previous/next links as well as current
* page information
*
* @param $base_url - the base URL will all filter options except page (should include url_path)
* @param $max_pages - the maximum number of pages to display
* @param $current_page - the current page in the navigation system
* @param $rows_per_page - the number of rows that are displayed on a single page
* @param $total_rows - the total number of rows in the navigation system
* @param $object - the object types that is being displayed
* @param $page_var - the object types that is being displayed
* @param $return_to - paint the resulting page into this dom object
* @param $page_count - provide a page count
*/
function html_nav_bar($base_url, $max_pages, $current_page, $rows_per_page, $total_rows, $colspan=30, $object = '', $page_var = 'page', $return_to = '', $page_count = true) {
if ($object == '') {
$object = __('Rows');
}
if ($total_rows >= $rows_per_page && $page_count) {
if (substr_count($base_url, '?') == 0) {
$base_url = trim($base_url) . '?';
} else {
$base_url = trim($base_url) . '&';
}
$url_page_select = get_page_list($current_page, $max_pages, $rows_per_page, $total_rows, $base_url, $page_var, $return_to);
$nav = "
';
}
return $nav;
}
/**
* html_header_sort - draws a header row suitable for display inside of a box element. When
* a user selects a column header, the callback function "filename" will be called to handle
* the sort the column and display the altered results.
*
* @param $header_items - an array containing a list of column items to display. The
* format is similar to the html_header, with the exception that it has three
* dimensions associated with each element (db_column => display_text, default_sort_order)
* alternatively (db_column => array('display' = 'blah', 'align' = 'blah', 'sort' = 'blah'))
* @param $sort_column - the value of current sort column.
* @param $sort_direction - the value the current sort direction. The actual sort direction
* will be opposite this direction if the user selects the same named column.
* @param $last_item_colspan - the TD 'colspan' to apply to the last cell in the row
* @param $url - a base url to redirect sort actions to
* @param $return_to - the id of the object to inject output into as a result of the sort action
*/
function html_header_sort($header_items, $sort_column, $sort_direction, $last_item_colspan = 1, $url = '', $return_to = '') {
static $page_count = 0;
/* reverse the sort direction */
if ($sort_direction == 'ASC') {
$new_sort_direction = 'DESC';
} else {
$new_sort_direction = 'ASC';
}
$page = $page_count . '_' . str_replace('.php', '', basename($_SERVER['SCRIPT_NAME']));
if (isset_request_var('action')) {
$page .= '_' . get_request_var('action');
}
if (isset_request_var('tab')) {
$page .= '_' . get_request_var('tab');
}
if (isset($_SESSION['sort_data'][$page])) {
$order_data = $_SESSION['sort_data'][$page];
} else {
$order_data = array(get_request_var('sort_column') => get_request_var('sort_direction'));
}
foreach ($order_data as $key => $direction) {
$primarySort = $key;
break;
}
print "
';
$page_count++;
}
/**
* html_header_sort_checkbox - draws a header row with a 'select all' checkbox in the last cell
* suitable for display inside of a box element. When a user selects a column header,
* the callback function "filename" will be called to handle the sort the column and display
* the altered results.
*
* @param $header_items - an array containing a list of column items to display. The
* fonrmat is similar to the html_header, with the exception that it has three
* dimensions associated with each element (db_column => display_text, default_sort_order)
* alternatively (db_column => array('display' = 'blah', 'align' = 'blah', 'sort' = 'blah'))
* @param $sort_column - the value of current sort column.
* @param $sort_direction - the value the current sort direction. The actual sort direction
* will be opposite this direction if the user selects the same named column.
* @param $form_action - the url to post the 'select all' form to
* @param $return_to - the id of the object to inject output into as a result of the sort action
*/
function html_header_sort_checkbox($header_items, $sort_column, $sort_direction, $include_form = true, $form_action = '', $return_to = '', $prefix = 'chk') {
static $page_count = 0;
/* reverse the sort direction */
if ($sort_direction == 'ASC') {
$new_sort_direction = 'DESC';
} else {
$new_sort_direction = 'ASC';
}
$page = $page_count . '_' . str_replace('.php', '', basename($_SERVER['SCRIPT_NAME']));
if (isset_request_var('action')) {
$page .= '_' . get_request_var('action');
}
if (isset_request_var('tab')) {
$page .= '_' . get_request_var('tab');
}
if (isset($_SESSION['sort_data'][$page])) {
$order_data = $_SESSION['sort_data'][$page];
} else {
$order_data = array(get_request_var('sort_column') => get_request_var('sort_direction'));
}
foreach ($order_data as $key => $direction) {
$primarySort = $key;
break;
}
/* default to the 'current' file */
if ($form_action == '') {
$form_action = get_current_page();
}
print "
';
$page_count++;
}
/**
* html_header - draws a header row suitable for display inside a box element
*
* @param $header_items - an array containing a list of items to be included in the header
* alternatively and array of header names and alignment array('display' = 'blah', 'align' = 'blah')
* @param $last_item_colspan - the TD 'colspan' to apply to the last cell in the row
*/
function html_header($header_items, $last_item_colspan = 1) {
print "
';
}
/**
* html_section_header - draws a header row suitable for display inside a box element
* but for display as a section title and not as a series of table header columns
*
* @param $header_name - an array of the display name of the header for the section and
* optional alignment.
* @param $last_item_colspan - the TD 'colspan' to apply to the last cell in the row
*/
function html_section_header($header_item, $last_item_colspan = 1) {
print "
";
if (is_array($header_item) && isset($header_item['display'])) {
print '
" . $header_item['display'] . '
';
} else {
print "
" . $header_item . '
';
}
print '
';
}
/**
* html_header_checkbox - draws a header row with a 'select all' checkbox in the last cell
* suitable for display inside a box element
*
* @param $header_items - an array containing a list of items to be included in the header
* alternatively and array of header names and alignment array('display' = 'blah', 'align' = 'blah')
* @param $form_action - the url to post the 'select all' form to
*/
function html_header_checkbox($header_items, $include_form = true, $form_action = '', $resizable = true, $prefix = 'chk') {
/* default to the 'current' file */
if ($form_action == '') {
$form_action = get_current_page();
}
print "
";
foreach ($header_items as $item) {
if (is_array($item)) {
if (isset($item['nohide'])) {
$nohide = 'nohide';
} else {
$nohide = '';
}
if (isset($item['align'])) {
$align = $item['align'];
} else {
$align = 'left';
}
if (isset($item['tip'])) {
$tip = $item['tip'];
} else {
$tip = '';
}
print '
" . html_escape($item['display']) . '
';
} else {
print "
" . html_escape($item) . '
';
}
}
print "
" . ($include_form ? "
":'');
print '
';
}
/**
* html_create_list - draws the items for a html dropdown given an array of data
*
* @param $form_data - an array containing data for this dropdown. it can be formatted
* in one of two ways:
* $array["id"] = "value";
* -- or --
* $array[0]["id"] = 43;
* $array[0]["name"] = "Red";
* @param $column_display - used to identify the key to be used for display data. this
* is only applicable if the array is formatted using the second method above
* @param $column_id - used to identify the key to be used for id data. this
* is only applicable if the array is formatted using the second method above
* @param $form_previous_value - the current value of this form element
*/
function html_create_list($form_data, $column_display, $column_id, $form_previous_value) {
if (empty($column_display)) {
if (cacti_sizeof($form_data)) {
foreach (array_keys($form_data) as $id) {
print '';
}
}
} else {
if (cacti_sizeof($form_data)) {
foreach ($form_data as $row) {
print "';
} else {
print '>' . html_escape(null_out_substitutions($row[$column_display])) . '';
}
}
}
}
}
/**
* html_escape_request_var - sanitizes a request variable for display
*
* @param $string - string the request variable to escape
*
* @return $new_string - the escaped request variable to be returned.
*/
function html_escape_request_var($string) {
return html_escape(get_request_var($string));
}
/**
* html_escape - sanitizes a string for display
*
* @param $string - string the string to escape
*
* @return $new_string - the escaped string to be returned.
*/
function html_escape($string) {
static $charset;
if ($charset == '') {
$charset = ini_get('default_charset');
}
if ($charset == '') {
$charset = 'UTF-8';
}
// Grave Accent character can lead to xss
if ($string !== null) {
$string = str_replace('`', '`', $string);
return htmlspecialchars($string, ENT_QUOTES | ENT_HTML5, $charset, false);
} else {
return $string;
}
}
/**
* html_split_string - takes a string and breaks it into a number of separated segments
*
* @param $string - string to be modified and returned
* @param $length - the maximal string length to split to
* @param $forgiveness - the maximum number of characters to walk back from to determine
* the correct break location.
*
* @return $new_string - the modified string to be returned.
*/
function html_split_string($string, $length = 90, $forgiveness = 10) {
$new_string = '';
$j = 0;
$done = false;
while (!$done) {
if (mb_strlen($string, 'UTF-8') > $length) {
for ($i = 0; $i < $forgiveness; $i++) {
if (substr($string, $length - $i, 1) == ' ') {
$new_string .= mb_substr($string, 0, $length - $i, 'UTF-8') . ' ';
break;
}
}
$string = mb_substr($string, $length - $i, null, 'UTF-8');
} else {
$new_string .= $string;
$done = true;
}
$j++;
if ($j > 4) {
break;
}
}
return $new_string;
}
/**
* draw_graph_items_list - draws a nicely formatted list of graph items for display
* on an edit form
*
* @param $item_list - an array representing the list of graph items. this array should
* come directly from the output of db_fetch_assoc()
* @param $filename - the filename to use when referencing any external url
* @param $url_data - any extra GET url information to pass on when referencing any
* external url
* @param $disable_controls - whether to hide all edit/delete functionality on this form
*/
function draw_graph_items_list($item_list, $filename, $url_data, $disable_controls) {
global $config;
include(CACTI_PATH_INCLUDE . '/global_arrays.php');
print "
";
/* pass 2: loop through each top level item and render it */
foreach ($header_array as $item_url => $item_title) {
$basename = explode('?', basename($item_url));
$basename = $basename[0];
$current_realm_id = (isset($user_auth_realm_filenames[$basename]) ? $user_auth_realm_filenames[$basename] : 0);
/**
* if this item is an array, then it contains sub-items. if not, is just
* the title string and needs to be displayed
*/
if (is_array($item_title)) {
$i = 0;
if ($current_realm_id == -1 || is_realm_allowed($current_realm_id) || !isset($user_auth_realm_filenames[$basename])) {
/* if the current page exists in the sub-items array, draw each sub-item */
if (array_key_exists(get_current_page(), $item_title) == true) {
$draw_sub_items = true;
} else {
$draw_sub_items = false;
}
foreach ($item_title as $item_sub_url => $item_sub_title) {
if (substr($item_sub_url, 0, 10) == 'EXTERNAL::') {
$item_sub_external = true;
$item_sub_url = substr($item_sub_url, 10);
} else {
$item_sub_external = false;
$item_sub_url = CACTI_PATH_URL . $item_sub_url;
}
/* always draw the first item (parent), only draw the children if we are viewing a page
that is contained in the sub-items array */
if (($i == 0) || ($draw_sub_items)) {
if (is_menu_pick_active($item_sub_url)) {
print "
';
}
/**
* draw_actions_dropdown - draws a table the allows the user to select an action to perform
* on one or more data elements
*
* @param $actions_array - an array that contains a list of possible actions. this array should
* be compatible with the form_dropdown() function
* @param $delete_action - if there is a delete action that should suppress removal of rows
* specify it here. If you don't want any delete actions, set to 0.
*/
function draw_actions_dropdown($actions_array, $delete_action = 1) {
global $config;
if ($actions_array === null || cacti_sizeof($actions_array) == 0) {
return;
}
if (!isset($actions_array[0])) {
$my_actions[0] = __('Choose an action');
$my_actions += $actions_array;
$actions_array = $my_actions;
}
?>
![](" . CACTI_PATH_URL . "images/cog.png "\" . __esc(")
![](" . CACTI_PATH_URL . "images/table_go.png "\" . __esc(")
![](" . CACTI_PATH_URL . "images/timeview.png "\" . __esc(")
![](" . CACTI_PATH_URL . "images/server_edit.png "\" . __esc(")
";
print '![](" . html_escape(CACTI_PATH_URL . )
";
print '![](" . CACTI_PATH_URL . "images/chart_curve_go.png "\" . __esc(")
![](" . get_theme_paths( "\" . __esc(")
";
print '![" . __(](" . CACTI_PATH_URL . "images/tab_graphs.gif)
";
}
}
}
if ($realm_allowed[21] || $realm_allowed[22]) {
if ($config['poller_id'] > 1) {
// Don't show reports table if not poller 1
} else {
if (substr_count($_SERVER['REQUEST_URI'], 'reports_')) {
print '
';
} else {
print '
';
}
}
}
if ($realm_allowed[18] || $realm_allowed[19]) {
if (substr_count($_SERVER['REQUEST_URI'], 'clog')) {
print '
';
} else {
print '
';
}
}
api_plugin_hook('top_graph_header_tabs');
if ($config['poller_id'] > 1 && $config['connection'] != 'online') {
// Only show external links when online
} else {
$external_links = db_fetch_assoc('SELECT id, title
FROM external_links
WHERE style="TAB"
AND enabled="on"
ORDER BY sortorder');
if (cacti_sizeof($external_links)) {
foreach ($external_links as $tab) {
if (is_realm_allowed($tab['id'] + 10000)) {
$parsed_url = parse_url($_SERVER['REQUEST_URI']);
$down = false;
if (basename($parsed_url['path']) == 'link.php') {
if (isset($parsed_url['query'])) {
$queries = explode('&', $parsed_url['query']);
foreach ($queries as $q) {
list($var, $value) = explode('=', $q);
if ($var == 'id') {
if ($value == $tab['id']) {
$down = true;
break;
}
}
}
}
}
print '