setup.php

<?php
/*
 +-------------------------------------------------------------------------+
 | Copyright (C) 2004-2024 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/                                                   |
 +-------------------------------------------------------------------------+
*/

function plugin_cycle_install() {
	api_plugin_register_hook('cycle', 'top_header_tabs',       'cycle_show_tab',             'setup.php');
	api_plugin_register_hook('cycle', 'top_graph_header_tabs', 'cycle_show_tab',             'setup.php');
	api_plugin_register_hook('cycle', 'config_arrays',         'cycle_config_arrays',        'setup.php');
	api_plugin_register_hook('cycle', 'draw_navigation_text',  'cycle_draw_navigation_text', 'setup.php');
	api_plugin_register_hook('cycle', 'config_settings',       'cycle_config_settings',      'setup.php');
	api_plugin_register_hook('cycle', 'api_graph_save',        'cycle_api_graph_save',       'setup.php');
	api_plugin_register_hook('cycle', 'page_head',             'cycle_page_head',            'setup.php');

	api_plugin_register_realm('cycle', 'cycle.php,cycle_ajax.php', __('Plugin -> Cycle Graphs', 'cycle'), 1);

	cycle_setup_table_new ();
}

function plugin_cycle_uninstall () {
	/* Do any extra Uninstall stuff here */
}

function plugin_cycle_check_config () {
	/* Here we will check to ensure everything is configured */
	cycle_check_upgrade();
	return true;
}

function plugin_cycle_upgrade () {
	/* Here we will upgrade to the newest version */
	cycle_check_upgrade();
	return false;
}

function cycle_check_upgrade () {
	global $config;

	$files = array('index.php', 'plugins.php', 'cycle.php');
	if (isset($_SERVER['PHP_SELF']) && !in_array(basename($_SERVER['PHP_SELF']), $files)) {
		return;
	}

	$info    = plugin_cycle_version();
	$current = $info['version'];
	$old     = db_fetch_row("SELECT * FROM plugin_config WHERE directory='cycle'");

	if (cacti_sizeof($old) && $current != $old['version']) {
		/* if the plugin is installed and/or active */
		if ($old['status'] == 1 || $old['status'] == 4) {
			/* re-register the hooks */
			plugin_cycle_install();

			/* perform a database upgrade */
			cycle_database_upgrade();
		}

		if ($old < '1.0') {
			api_plugin_register_realm('cycle', 'cycle.php,cycle_ajax.php', 'Plugin -> Cycle Graphs', 1);

			/* get the realm id's and change from old to new */
			$user  = db_fetch_cell("SELECT id FROM plugin_realms WHERE file='cycle.php'")+100;
			$users = db_fetch_assoc('SELECT user_id FROM user_auth_realm WHERE realm_id=42');
			if (sizeof($users)) {
				foreach($users as $u) {
					db_execute('INSERT INTO user_auth_realm
						(realm_id, user_id) VALUES (' . $user . ', ' . $u['user_id'] . ')
						ON DUPLICATE KEY UPDATE realm_id=VALUES(realm_id)');
					db_execute('DELETE FROM user_auth_realm
						WHERE user_id=' . $u['user_id'] . '
						AND realm_id=' . $user);
				}
			}
		}

		/* update the plugin information */
		$id = db_fetch_cell("SELECT id FROM plugin_config WHERE directory='cycle'");

		/* remove legacy hook */
		db_execute('DELETE FROM plugin_hooks WHERE name="cycle" AND hook="config_form"');

		db_execute_prepared('UPDATE plugin_config
			SET name = ?, author = ?, webpage = ?, version = ?
			WHERE id = ?',
			array($info['longname'], $info['author'], $info['homepage'], $info['version'], $id));
	}
}

function cycle_database_upgrade () {
}

function cycle_check_dependencies() {
	global $plugins, $config;

	return true;
}

function cycle_setup_table_new () {
}

function plugin_cycle_version () {
	global $config;
	$info = parse_ini_file($config['base_path'] . '/plugins/cycle/INFO', true);
	return $info['info'];
}

function cycle_page_head () {
}

function cycle_config_settings ($force = false) {
	global $tabs, $settings, $tabs_graphs, $settings_user, $page_refresh_interval, $graph_timespans;
	global $cycle_width, $cycle_height, $cycle_cols, $cycle_graphs;

	/* check for an upgrade */
	plugin_cycle_check_config();

	if ($force === false && isset($_SERVER['PHP_SELF']) &&
		basename($_SERVER['PHP_SELF']) != 'settings.php' &&
		basename($_SERVER['PHP_SELF']) != 'auth_profile.php')
		return;

	$tabs['cycle'] = __('Cycle', 'cycle');
	$tabs_graphs['cycle'] = __('Cycle', 'cycle');

	$treeList = array_rekey(get_allowed_trees(), 'id', 'name');
	$tempHeader = array('cycle_header' => array(
			'friendly_name' => __('Cycle Graphs', 'cycle'),
			'method' => 'spacer',
			));
	$temp = array(
		'cycle_delay' => array(
			'friendly_name' => __('Delay Interval', 'cycle'),
			'description' => __('This is the time in seconds before the next graph is displayed.', 'cycle'),
			'method' => 'drop_array',
			'default' => 60,
			'array' => $page_refresh_interval
			),
		'cycle_timespan' => array(
			'friendly_name' => __('Graph Timespan', 'cycle'),
			'description' => __('This is the default timespan that will be displayed on the page.', 'cycle'),
			'method' => 'drop_array',
			'default' => 5,
			'array' => $graph_timespans
			),
		'cycle_columns' => array(
			'friendly_name' => __('Column Count', 'cycle'),
			'description' => __('In Tree Mode this is the number of columns that will be used.', 'cycle'),
			'method' => 'drop_array',
			'default' => 2,
			'array' => $cycle_cols
			),
		'cycle_graphs' => array(
			'friendly_name' => __('Number of Graphs per Page', 'cycle'),
			'description' => __('Select the number of graphs to display per page', 'cycle'),
			'method' => 'drop_array',
			'default' => '4',
			'array' => $cycle_graphs,
			),
		'cycle_height' => array(
			'friendly_name' => __('Graph Height', 'cycle'),
			'description' => __('This sets the graph height for the displayed graphs.', 'cycle'),
			'method' => 'drop_array',
			'default' => '100',
			'array' => $cycle_height
			),
		'cycle_width' => array(
			'friendly_name' => __('Graph Width', 'cycle'),
			'description' => __('This sets the graph width for the displayed graphs.', 'cycle'),
			'method' => 'drop_array',
			'default' => '400',
			'array' => $cycle_width
			),
		'cycle_legend' => array(
			'friendly_name' => __('Display Legend', 'cycle'),
			'description' => __('Check this to display legend.', 'cycle'),
			'method' => 'checkbox',
			'default' => ''
			),
		'cycle_cheader' => array(
			'friendly_name' => __('Predefined Rotations', 'cycle'),
			'method' => 'spacer',
			),
		'cycle_custom_graphs_type' => array(
			'friendly_name' => __('Rotation Type', 'cycle'),
			'description' => __('Select which method to use for custom graph rotation.  If you select \'Specific List\', you must define a list of Graph ID\'s', 'cycle'),
			'method' => 'drop_array',
			'default' => '1',
			'array' => array(0 => __('Legacy (All)', 'cycle'), 1 => __('Specific List', 'cycle'), 2 => __('Tree Mode', 'cycle')),
			),
		'cycle_custom_graphs_list' => array(
			'friendly_name' => __('Custom Graph List', 'cycle'),
			'description' => __('This must be a comma delimited list of Graph ID\'s to cycle through. For example \'1,2,3,4\'', 'cycle'),
			'method' => 'textbox',
			'max_length' => 255,
			),
		'cycle_custom_graphs_tree' => array(
			'friendly_name' => __('Default Tree', 'cycle'),
			'description' => __('Select the graph tree to cycle if Tree Mode is selected', 'cycle'),
			'method' => 'drop_array',
			'default' => 'None',
			'array' => $treeList,
		)
	);

	if (isset($settings['cycle'])) {
		$settings['cycle'] = array_merge($settings['cycle'], $tempHeader, $temp);
	}else {
		$settings['cycle'] = array_merge($tempHeader, $temp);
	}

	if (isset($settings_user['cycle'])) {
		$settings_user['cycle'] = array_merge($settings_user['cycle'], $temp);
	}else {
		$settings_user['cycle'] = $temp;
	}
}

function cycle_show_tab () {
	global $config;

	if (api_user_realm_auth('cycle.php')) {
		if (substr_count($_SERVER['REQUEST_URI'], 'cycle.php')) {
			print '<a href="' . $config['url_path'] . 'plugins/cycle/cycle.php"><img src="' . $config['url_path'] . 'plugins/cycle/images/tab_cycle_down.gif" alt="' . __('Cycle') . '"></a>';
		}else{
			print '<a href="' . $config['url_path'] . 'plugins/cycle/cycle.php"><img src="' . $config['url_path'] . 'plugins/cycle/images/tab_cycle.gif" alt="' . __('Cycle') . '"></a>';
		}
	}
}

function cycle_config_arrays () {
	global $cycle_graphs, $cycle_cols, $cycle_width, $cycle_height;

	$cycle_graphs = array(
		1  => __('%d Graph', 1, 'cycle'),
		2  => __('%d Graphs', 2, 'cycle'),
		4  => __('%d Graphs', 4, 'cycle'),
		6  => __('%d Graphs', 6, 'cycle'),
		8  => __('%d Graphs', 8, 'cycle'),
		10 => __('%d Graphs', 10, 'cycle')
	);

	$cycle_cols   = array(
		1 => __('%d Column', 1, 'cycle'),
		2 => __('%d Columns', 2, 'cycle'),
		3 => __('%d Columns', 3, 'cycle'),
		4 => __('%d Columns', 4, 'cycle'),
		5 => __('%d Columns', 5, 'cycle')
	);

	$cycle_height = array(
		75  => __('%d Pixels', 75, 'cycle'),
		100 => __('%d Pixels', 100, 'cycle'),
		125 => __('%d Pixels', 125, 'cycle'),
		150 => __('%d Pixels', 150, 'cycle'),
		175 => __('%d Pixels', 175, 'cycle'),
		200 => __('%d Pixels', 200, 'cycle'),
		250 => __('%d Pixels', 250, 'cycle'),
		300 => __('%d Pixels', 300, 'cycle'),
		350 => __('%d Pixels', 350, 'cycle'),
		400 => __('%d Pixels', 400, 'cycle'),
		500 => __('%d Pixels', 500, 'cycle')
	);

	$cycle_width  = array(
		100 => __('%d Pixels', 100, 'cycle'),
		125 => __('%d Pixels', 125, 'cycle'),
		150 => __('%d Pixels', 150, 'cycle'),
		175 => __('%d Pixels', 175, 'cycle'),
		200 => __('%d Pixels', 200, 'cycle'),
		250 => __('%d Pixels', 250, 'cycle'),
		300 => __('%d Pixels', 300, 'cycle'),
		350 => __('%d Pixels', 350, 'cycle'),
		400 => __('%d Pixels', 400, 'cycle'),
		500 => __('%d Pixels', 500, 'cycle'),
		550 => __('%d Pixels', 550, 'cycle'),
		600 => __('%d Pixels', 600, 'cycle'),
		650 => __('%d Pixels', 650, 'cycle'),
		700 => __('%d Pixels', 700, 'cycle')
	);

	return true;
}

function cycle_draw_navigation_text ($nav) {
	$nav['cycle.php:'] = array('title' => __('Cycling', 'cycle'), 'mapping' => '', 'url' => 'cycle.php', 'level' => '1');
	$nav['cycle.php:view'] = array('title' => __('Cycling', 'cycle'), 'mapping' => '', 'url' => 'cycle.php', 'level' => '1');
	$nav['cycle.php:graphs'] = array('title' => __('Cycling', 'cycle'), 'mapping' => '', 'url' => 'cycle.php', 'level' => '1');
	$nav['cycle.php:save'] = array('title' => __('Cycling', 'cycle'), 'mapping' => '', 'url' => 'cycle.php', 'level' => '1');
	return $nav;
}

function cycle_api_graph_save ($save) {
}
?>