cycle.php

<?php
/*
 +-------------------------------------------------------------------------+
 | Copyright (C) 2004-2026 The Cacti Group                                 |
 |                                                                         |
 | 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.                            |
 +-------------------------------------------------------------------------+
 | Cacti: The Complete RRDTool-based Graphing Solution                     |
 +-------------------------------------------------------------------------+
 | This code is designed, written, and maintained by the Cacti Group. See  |
 | about.php and/or the AUTHORS file for specific developer information.   |
 +-------------------------------------------------------------------------+
 | http://www.cacti.net/                                                   |
 +-------------------------------------------------------------------------+
*/

$guest_account = true;

chdir('../../');

require_once('./include/auth.php');
require_once('./lib/time.php');
require_once('./lib/html_tree.php');
require_once('./lib/api_graph.php');
require_once('./lib/api_tree.php');
require_once('./lib/utility.php');
require_once('./lib/api_data_source.php');
require_once('./plugins/cycle/includes/functions.php');

set_default_action();

cycle_set_defaults();

validate_request_vars();

switch(get_request_var('action')) {
	case 'save':
		save_settings();

		break;
	case 'graphs':
		cycle_graphs();

		break;
	default:
		cycle();

		break;
}

/**
 * Computes the current graph timespan (start/end times) for the selected
 * 'timespan' filter value, honoring the user's configured first day of
 * the week. Called from cycle()/cycle_graphs() before building each
 * cycled graph's image URL.
 *
 * @return array The computed timespan details, including 'begin_now'
 *               (the timespan's start time).
 */
function cycle_get_timespan(): array {
	$timespan        = [];
	$first_weekdayid = read_user_setting('first_weekdayid');

	get_timespan($timespan, time(), get_request_var('timespan'), $first_weekdayid);

	return $timespan;
}

/**
 * Builds the HTML grid of graph images for the current page of cycled
 * graphs (filtered by tree/leaf/regex, sized and paged per the current
 * filter settings) and returns it as a JSON response, with the current/
 * next/previous graph ids alongside a base64-encoded 'image' field
 * holding the grid HTML. Invoked from this file's dispatcher when the
 * request's 'action' is 'graphs', called via AJAX by the client-side
 * cycle.js to refresh the displayed graphs.
 *
 * @return void Outputs a JSON-encoded response directly.
 *
 * @global array $graphs_ppage          Options for graphs-per-page
 *                                       (unused directly here; declared
 *                                       for parity with cycle()).
 * @global array $graph_cols            Options for graph columns per row
 *                                       (unused directly here; declared
 *                                       for parity with cycle()).
 * @global array $page_refresh_interval Reserved/declared for parity with
 *                                       cycle(); not used directly here.
 * @global array $graph_timespans       Reserved/declared for parity with
 *                                       cycle(); not used directly here.
 * @global array $cycle_width           Reserved/declared for parity with
 *                                       cycle(); not used directly here.
 * @global array $cycle_height          Reserved/declared for parity with
 *                                       cycle(); not used directly here.
 * @global int   $id                    Set from the request's 'id',
 *                                       identifying the currently
 *                                       displayed graph for next/prev
 *                                       navigation.
 * @global int   $graph_id              Set by get_next_graphid();
 *                                       included in the JSON response as
 *                                       the current graph id.
 * @global int   $next_graph_id         Set by get_next_graphid();
 *                                       included in the JSON response.
 * @global int   $prev_graph_id         Set by get_next_graphid();
 *                                       included in the JSON response.
 * @global array $graphs                Set by get_next_graphid(); the
 *                                       list of graphs in scope for the
 *                                       current page, iterated to build
 *                                       the HTML grid.
 */
function cycle_graphs(): void {
	global $graphs_ppage, $graph_cols, $graphs;
	global $page_refresh_interval, $graph_timespans;
	global $cycle_width, $cycle_height;
	global $id, $graph_id, $next_graph_id, $prev_graph_id;

	$tree_list = get_allowed_trees();
	$tree_list = is_array($tree_list) ? $tree_list : [];
	$legend    = get_request_var('legend');
	$tree_id   = get_request_var('tree_id');
	$leaf_id   = get_request_var('leaf_id');
	$graphpp   = get_request_var('graphs');
	$cols      = get_request_var('cols');
	$rfilter   = get_request_var('rfilter');
	$id        = get_request_var('id');
	$width     = get_request_var('width');
	$height    = get_request_var('height');

	if (empty($tree_id)) {
		$tree_id = db_fetch_cell('SELECT id FROM graph_tree ORDER BY name LIMIT 1');
	}

	if (empty($id)) {
		$id      = -1;
	}

	// get the start and end times for the graph
	$timespan = cycle_get_timespan();

	$graph_tree = $tree_id;
	$html       = '';
	$out        = '';

	get_next_graphid($graphpp, $rfilter, $graph_tree, $leaf_id);

	// create the graph structure and output
	$out       = '<table style="margin-left:auto;margin-right:auto;">';
	$max_cols  = $cols;
	$col_count = 1;

	if ($graphs !== null && $graphs !== false && sizeof($graphs)) {
		foreach ($graphs as $graph) {
			if ($col_count == 1) {
				$out .= '<tr>';
			}

			$out .= '<td align="center" class="graphholder">'
				. "<a href='../../graph.php?local_graph_id=" . $graph['graph_id'] . "&rra_id=all'>"
				. "<img class='cycle_image' "
				. "src='../../graph_image.php?image_format=svg&disable_cache=true&local_graph_id="
				. $graph['graph_id'] . '&rra_id=0&graph_start=' . $timespan['begin_now']
				. '&graph_end=' . time() . '&graph_width=' . $width . '&graph_height=' . $height
				. ($legend == '' || $legend == 'false' ? '&graph_nolegend=true' : '') . "'>"
				. '</a></td>';

			ob_start();
			$out .= ob_get_clean();

			if ($col_count == $max_cols) {
				$out .= '</tr>';
				$col_count = 1;
			} else {
				$col_count++;
			}
		}
	} else {
		$out = '<h1>' . __('No Graphs Found Matching Criteria', 'cycle') . '</h1>';
	}

	if ($col_count <= $max_cols) {
		$col_count--;
		$addcols = $max_cols - $col_count;

		for ($x = 1; $x <= $addcols; $x++) {
			$out .= '<td class="graphholder">&nbsp;</td>';
		}

		$out .= '</tr>';
	}

	$out .= '</table>';

	$output = ['graphid' => $graph_id, 'nextgraphid' => $next_graph_id, 'prevgraphid' => $prev_graph_id, 'image' => base64_encode($out)];

	print json_encode($output);
}

/**
 * Renders the main Cycle page: the filter toolbar (timespan, refresh
 * delay, graphs-per-page, columns, size, legend, tree/leaf or regex
 * filter) and an empty image container that the client-side cycle.js
 * fills in and periodically refreshes via the 'graphs' AJAX action.
 * Invoked from this file's dispatcher for the default (no 'action')
 * request.
 *
 * @return void Outputs the page HTML and JavaScript directly.
 *
 * @global array $graphs_ppage          Options for graphs-per-page, used
 *                                       to populate that filter selector.
 * @global array $graph_cols            Options for graph columns per row,
 *                                       used to populate that filter
 *                                       selector.
 * @global array $page_refresh_interval Options for the cycle rotation
 *                                       refresh delay, used to populate
 *                                       that filter selector.
 * @global array $graph_timespans       Cacti's predefined graph timespan
 *                                       options, used to populate the
 *                                       timespan selector.
 * @global array $cycle_width           Options for graph width, used to
 *                                       populate that filter selector.
 * @global array $cycle_height          Options for graph height, used to
 *                                       populate that filter selector.
 * @global array $config                Cacti global configuration
 *                                       array; used to build the
 *                                       cycle.js script URL when
 *                                       get_md5_include_js() isn't
 *                                       available.
 */
function cycle(): void {
	global $graphs_ppage, $graph_cols;
	global $page_refresh_interval, $graph_timespans;
	global $cycle_width, $cycle_height;

	general_header();

	global $config;

	if (function_exists('get_md5_include_js')) {
		print get_md5_include_js('plugins/cycle/js/cycle.js');
	} else {
		print '<script type="text/javascript"' . plugin_cycle_csp_nonce() . ' src="' . $config['url_path'] . 'plugins/cycle/js/cycle.js"></script>' . "\n";
	}

	$tree_list = get_allowed_trees();
	$tree_list = is_array($tree_list) ? $tree_list : [];
	$legend    = get_request_var('legend');
	$tree_id   = get_request_var('tree_id');
	$leaf_id   = get_request_var('leaf_id');
	$graphpp   = get_request_var('graphs');
	$cols      = get_request_var('cols');
	$rfilter   = get_request_var('rfilter');
	$id        = get_request_var('id');
	$width     = get_request_var('width');
	$height    = get_request_var('height');

	if (empty($tree_id)) {
		$tree_id = db_fetch_cell('SELECT id
			FROM graph_tree
			ORDER BY name
			LIMIT 1');
	}

	if (empty($id)) {
		$id      = -1;
	}

	// get the start and end times for the graph
	$timespan = cycle_get_timespan();

	$graph_tree = $tree_id;
	$html       = '';
	$out        = '';

	html_start_box(__('Cycle Graph Filter', 'cycle') . ' [ ' . __('Next Update In', 'cycle') . " <i id='countdown'></i> ]", '100%', false, 3, 'center', '');
	?>
	<tr class='odd'><td>
		<form id='form_cycle'>
			<table class='filterTable'>
				<tr>
					<td>
						<script type='text/javascript' <?php print plugin_cycle_csp_nonce(); ?>>
							var rtime=<?php print get_request_var('delay') * 1000; ?>;
						</script>
						<select id='timespan' title='<?php print __esc('Graph Display Timespan', 'cycle'); ?>'>
							<?php
							if (cacti_sizeof($graph_timespans)) {
								foreach ($graph_timespans as $key => $value) {
									print "<option value='$key'";

									if (get_request_var('timespan') == $key) {
										print ' selected';
									} print '>' . html_escape($value) . '</option>';
								}
							}
	?>
						</select>
					</td>
					<td>
						<select id='delay' title='<?php print __esc('Cycle Rotation Refresh Frequency', 'cycle'); ?>'>
							<?php
	if (cacti_sizeof($page_refresh_interval)) {
		foreach ($page_refresh_interval as $key => $value) {
			print "<option value='$key'";

			if (get_request_var('delay') == $key) {
				print ' selected';
			} print '>' . html_escape($value) . '</option>';
		}
	}
	?>
						</select>
					</td>
					<td>
						<select id='graphs' title='<?php print __esc('Number of Graphs per Page', 'cycle'); ?>'>
							<?php
	foreach ($graphs_ppage as $key => $value) {
		print "<option value='$key'";

		if (get_request_var('graphs') == $key) {
			print ' selected';
		} print '>' . $value . '</option>';
	}
	?>
						</select>
					</td>
					<td>
						<span class='nowrap'>
							<button type='button' id='prev' class='ui-button ui-corner-all ui-widet' title='<?php print __esc('Cycle to Previous Graphs', 'cycle'); ?>'><?php print __esc('Prev', 'cycle'); ?></button>
							<button type='button' id='cstop' class='ui-button ui-corner-all ui-widet' title='<?php print __esc('Stop Cycling', 'cycle'); ?>'><?php print __esc('Stop', 'cycle'); ?></button>
							<button type='button' id='cstart' class='ui-button ui-corner-all ui-widet' style='display:none;' title='<?php print __esc('Resume Cycling', 'cycle'); ?>'><?php print __esc('Start', 'cycle'); ?></button>
							<button type='button' id='next' class='ui-button ui-corner-all ui-widet' title='<?php print __esc('Cycle to Next Graphs', 'cycle'); ?>'><?php print __esc('Next', 'cycle'); ?></button>
							<button type='submit' id='refresh' class='ui-button ui-corner-all ui-widet ui-state-active' title='<?php print __esc('Refresh Graphs Now', 'cycle'); ?>'><?php print __esc('Refresh', 'cycle'); ?></button>
							<button type='button' id='clear' class='ui-button ui-corner-all ui-widet' title='<?php print __esc('Clear Filter', 'cycle'); ?>'><?php print __esc('Clear', 'cycle'); ?></button>
							<button type='button' id='save' class='ui-button ui-corner-all ui-widet' title='<?php print __esc('Save Filter Settings', 'cycle'); ?>'><?php print __esc('Save', 'cycle'); ?></button>
							<i id='text'></i>
						</span>
					</td>
				</table>
				<table class='filterTable'>
					<td>
						<select id='cols' title='<?php print __esc('Number of Graph Columns', 'cycle'); ?>'>
							<?php
	foreach ($graph_cols as $key=>$value) {
		print "<option value='$key'";

		if (get_request_var('cols') == $key) {
			print ' selected';
		} print '>' . $value . '</option>';
	}
	?>
						</select>
					</td>
					<td>
						<select id='height' title='<?php print __esc('Graph Height', 'cycle'); ?>'>
							<?php
	foreach ($cycle_height as $key=>$value) {
		print "<option value='$key'";

		if (get_request_var('height') == $key) {
			print ' selected';
		} print '>' . $key . '</option>';
	}
	?>
						</select>
					</td>
					<td>
						<span style='vertical-align:center;'>X</span>
					</td>
					<td>
						<select id='width' title='<?php print __esc('Graph Width', 'cycle'); ?>'>
							<?php
	foreach ($cycle_width as $key=>$value) {
		print "<option value='$key'";

		if (get_request_var('width') == $key) {
			print ' selected';
		} print '>' . $key . '</option>';
	}
	?>
						</select>
					</td>
					<td>
						<input type='checkbox' id='legend' <?php (get_request_var('legend') == 'true' || get_request_var('legend') == 'on' ? print " checked='checked'" : ''); ?> title='<?php print __esc('Display Graph Legend', 'cycle'); ?>'>
					</td>
					<td>
						<label for='legend' style='vertical-align:25%' title='<?php print __esc('Display Graph Legend', 'cycle'); ?>'><?php print __esc('Legend', 'cycle'); ?> </label>
					</td>
				</tr>
			</table>
			<table class='filterTable'>
				<tr>
					<?php
					switch(read_config_option('cycle_custom_graphs_type')) {
						case '0':
						case '1':
							// will only use the rfilter for full rotation

							break;
						case '2':
							if (cacti_sizeof($tree_list)) {
								$html = "<td><select id='tree_id' title='" . __esc('Select Tree to View', 'cycle') . "'>";

								foreach ($tree_list as $tree) {
									$html .= "<option value='" . $tree['id'] . "'" . ($graph_tree == $tree['id'] ? ' selected' : '') . '>' . html_escape($tree['name']) . '</option>';
								}

								$html .= '</select>';

								$leaves = db_fetch_assoc_prepared('SELECT *
								FROM graph_tree_items
								WHERE title != ""
								AND graph_tree_id = ?
								ORDER BY parent, position',
									[$graph_tree]);

								if (cacti_sizeof($leaves)) {
									$html .= "<select id='leaf_id' title='" . __esc('Select Tree Leaf to Display', 'cycle') . "'>";

									$html .= "<option value='-1'" . ($leaf_id == -1 ? ' selected' : '') . '>' . __('All Levels', 'cycle') . '</option>';
									$html .= "<option value='-2'" . ($leaf_id == -2 ? ' selected' : '') . '>' . __('Top Level', 'cycle') . '</option>';

									foreach ($leaves as $leaf) {
										$html .= "<option value='" . html_escape($leaf['id']) . "'" . ($leaf_id == $leaf['id'] ? ' selected' : '') . '>' . html_escape($leaf['title']) . '</option>';
									}

									$html .= '</select>';
								} else {
									$html .= '</td>';
								}
							}
					}

	// process the rfilter section
	$html .= "<td><input id='rfilter' type='textbox' title='" . __esc('Enter Regular Expression Match (only alpha, numeric, and special characters \"(^_|?)\" permitted)', 'cycle') . "' size='45' value='" . html_escape($rfilter) . "'></td>";

	print $html;
	?>
				</tr>
			</table>
			<table class='filterTable'>
				<tr id='izone'>
					<td>
					</td>
				</tr>
			</table>
		</form>
	</td></tr>
	<?php html_end_box(); ?>
	<?php html_start_box(__('Cycle Graphs', 'cycle'), '100%', false, 3, 'center', ''); ?>
	<tr>
		<td>
			<span style='text-align:center;' id='image'></span>
		</td>
	</tr>
	<tr>
		<td>
		<script type='text/javascript' <?php print plugin_cycle_csp_nonce(); ?>>
		$(function() {
			$('#timespan').change(function(){
				newTimespan()
			});

			$('#prev').click(function(){
				getPrev()
			});

			$('#next').click(function(){
				getNext()
			});

			$('#cstop').click(function(){
				stopTime()
			});

			$('#cstart').click(function(){
				startTime()
			});

			$('#clear').click(function(){
				clearFilter()
			});

			$('#save').click(function(){
				saveFilter()
			});

			$('#tree_id, #leaf_id, #height, #width, #cols, #graphs, #delay').change(function() {
				applyFilter();
			});

			$('#refresh, #legend').click(function() {
				applyFilter();
			});

			$('#form_cycle').submit(function(event) {
				event.preventDefault();
				applyFilter();
			});

			$('input, label, button').tooltip();

			stopTime();
			startTime();
			newGraph();
		});
		</script>
		</td>
	</tr>
	<?php

	html_end_box();

	bottom_footer();
}