setup.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/                                                   |
 +-------------------------------------------------------------------------+
*/

/**
 * Installs the Graph Export plugin: registers its Cacti hooks
 * (config_arrays, draw_navigation_text, poller_bottom), registers its
 * gexport.php realm, and creates its database tables. Invoked by Cacti's
 * plugin architecture when an administrator installs this plugin from
 * Console > Plugin Management.
 *
 * @return void
 */
function plugin_gexport_install() {
	# graph setup all arrays needed for automation
	api_plugin_register_hook('gexport', 'config_arrays',        'gexport_config_arrays',        'setup.php');
	api_plugin_register_hook('gexport', 'draw_navigation_text', 'gexport_draw_navigation_text', 'setup.php');
	api_plugin_register_hook('gexport', 'poller_bottom',        'gexport_poller_bottom',        'setup.php');

	api_plugin_register_realm('gexport', 'gexport.php', __('Export Cacti Graphs Settings', 'gexport'), 1);

	gexport_setup_table();
}

/**
 * Uninstalls the Graph Export plugin, dropping its graph_exports and
 * graph_exports_tasks tables. Invoked by Cacti's plugin architecture
 * when an administrator uninstalls this plugin from Console > Plugin
 * Management.
 *
 * @return bool Always returns true.
 */
function plugin_gexport_uninstall() {
	db_execute('DROP TABLE graph_exports');
	db_execute('DROP TABLE graph_exports_tasks');

	return true;
}

/**
 * Verifies the plugin's configuration; currently a no-op placeholder.
 * Invoked by Cacti's plugin architecture on relevant page loads.
 *
 * @return bool Always returns true.
 */
function plugin_gexport_check_config() {
	return true;
}

/**
 * Reads this plugin's INFO file and returns its [info] section. Used by
 * Cacti's plugin architecture via the api_plugin_version hook, and
 * internally by gexport_check_upgrade() and poller_export.php's
 * display_version() to detect/report the plugin's version.
 *
 * @return array The parsed [info] section of the plugin's INFO file (keys
 *               such as name, version, author, homepage, longname).
 *
 * @global array $config Cacti global configuration array; used to locate
 *                        the plugin's base path.
 */
function plugin_gexport_version() {
	global $config;
	$info = parse_ini_file($config['base_path'] . '/plugins/gexport/INFO', true);
	return $info['info'];
}

/**
 * Hook implementation for Cacti's 'poller_bottom' filter. On the primary
 * poller, when at least one graph export configuration is enabled,
 * launches poller_export.php as a background process to perform this
 * cycle's graph exports. Called by Cacti's poller via
 * api_plugin_hook('poller_bottom', ...) at the end of each polling cycle.
 *
 * @return void
 *
 * @global array $config Cacti global configuration array; used to locate
 *                        the PHP binary and this plugin's poller script,
 *                        and to check the current poller_id.
 */
function gexport_poller_bottom() {
	global $config;

	/* graph export */
	if ($config['poller_id'] == 1) {
		$exports = db_fetch_assoc('SELECT * FROM graph_exports WHERE enabled="on"');
		if (sizeof($exports)) {
			$command_string = read_config_option('path_php_binary');
			$extra_args = '-q "' . $config['base_path'] . '/plugins/gexport/poller_export.php"';
			exec_background($command_string, $extra_args);
		}
	}
}

/**
 * Detects whether the installed plugin_config version differs from this
 * plugin's INFO file version and, if so, re-enables its hooks (to pick
 * up any newly added ones), applies a series of version-gated
 * graph_exports/graph_exports_tasks schema migrations, and updates the
 * stored plugin_config record. Only runs on plugins.php/gexport.php.
 * Called from gexport_config_arrays() on every relevant page load.
 *
 * @return void
 *
 * @global array  $config           Cacti global configuration array;
 *                                   used to load database.php/
 *                                   functions.php.
 * @global object $database_default Cacti's default database connection
 *                                   handle (unused directly here;
 *                                   declared for parity with other
 *                                   database-touching functions in this
 *                                   file).
 */
function gexport_check_upgrade() {
	global $config, $database_default;

	include_once($config['library_path'] . '/database.php');
	include_once($config['library_path'] . '/functions.php');

	// Let's only run this check if we are on a page that actually needs the data
	$files = ['plugins.php', 'gexport.php'];
	if (!in_array(get_current_page(), $files)) {
		return;
	}

	$info    = plugin_gexport_version ();
	$current = $info['version'];
	$old     = db_fetch_cell("SELECT version FROM plugin_config WHERE directory='gexport'");

	if (cacti_version_compare($old,$current,'<')) {
		if (api_plugin_is_enabled('gexport')) {
			# may sound ridiculous, but enables new hooks
			api_plugin_enable_hooks('gexport');
		}

		if (cacti_version_compare($old,'1.4.1', '<')) {
			if (db_column_exists('graph_exports','export_index_key_path')) {
				db_execute('ALTER TABLE graph_exports
					CHANGE COLUMN `export_index_key_path` `export_private_key_path` varchar(255)');
			}
		}

		if (cacti_version_compare($old,'1.4','<')) {
			gexport_create_table_tasks();

			if (!db_column_exists('graph_exports','export_threads')) {
				db_execute('ALTER TABLE graph_exports
					ADD COLUMN `export_threads` int(10) DEFAULT \'0\'');
			}

			if (!db_column_exists('graph_exports','export_args')) {
				db_execute('ALTER TABLE graph_exports
					ADD COLUMN `export_args` char(25) DEFAULT \'-zav\'');
			}

			if (!db_column_exists('graph_exports','export_clear')) {
				db_execute('ALTER TABLE graph_exports
					ADD COLUMN `export_clear` char(3) DEFAULT \'\'');
			}

			if (!db_column_exists('graph_exports','export_thumbs')) {
				db_execute('ALTER TABLE graph_exports
					ADD COLUMN `export_thumbs` char(3) DEFAULT \'on\'');
			}

			if (!db_index_exists('graph_exports_tasks','status')) {
				db_execute('ALTER TABLE graph_exports_tasks
					ADD KEY `status` (`status`)');
			}

			if (!db_index_exists('graph_exports_tasks','pid')) {
				db_execute('ALTER TABLE graph_exports_tasks
					ADD KEY `pid` (`pid`)');
			}

			if (!db_index_exists('graph_exports_tasks','start_time')) {
				db_execute('ALTER TABLE graph_exports_tasks
					ADD KEY `start_time` (`start_time`)');
			}
		}

		if (cacti_version_compare($old,'1.3','<')) {
			db_execute('ALTER TABLE graph_exports
				MODIFY column export_user VARCHAR(40) DEFAULT \'\'');
		}

		db_execute("UPDATE plugin_config
			SET version='$current'
			WHERE directory='gexport'");

		db_execute("UPDATE plugin_config SET
			version='" . $info['version']  . "',
			name='"    . $info['longname'] . "',
			author='"  . $info['author']   . "',
			webpage='" . $info['homepage'] . "'
			WHERE directory='" . $info['name'] . "' ");
	}
}

/**
 * Verifies that this plugin's PHP/Cacti dependencies are met; currently
 * always reports success. Invoked by Cacti's plugin architecture before
 * enabling the plugin.
 *
 * @return bool Always returns true.
 */
function gexport_check_dependencies() {
	return true;
}

/**
 * Creates this plugin's graph_exports (export configuration) and
 * graph_exports_tasks (per-export worker task) database tables, if they
 * don't already exist. Called from plugin_gexport_install() during
 * plugin installation.
 *
 * @return bool Always returns true.
 *
 * @global array  $config           Cacti global configuration array;
 *                                   used to load database.php.
 * @global object $database_default Cacti's default database connection
 *                                   handle (unused directly here;
 *                                   declared for parity with other
 *                                   database-touching functions in this
 *                                   file).
 */
function gexport_setup_table() {
	global $config, $database_default;
	include_once($config['library_path'] . '/database.php');

	gexport_create_table();
	gexport_create_table_tasks();

	return true;
}

/**
 * Creates the graph_exports table (holding each configured export job's
 * settings and last-run status), if it doesn't already exist. Called
 * from gexport_setup_table() during installation.
 *
 * @return bool Always returns true.
 */
function gexport_create_table() {
	if (!db_table_exists('graph_exports')) {
		db_execute("CREATE TABLE `graph_exports` (
			`id` int(10) unsigned NOT NULL AUTO_INCREMENT,
			`name` varchar(64) DEFAULT '',
			`export_type` varchar(12) DEFAULT '',
			`enabled` char(3) DEFAULT 'on',
			`export_presentation` varchar(20) DEFAULT '',
			`export_effective_user` int(10) unsigned DEFAULT '0',
			`export_expand_hosts` char(3) DEFAULT '',
			`export_theme` varchar(20) DEFAULT 'modern',
			`graph_tree` varchar(255) DEFAULT '',
			`graph_site` varchar(255) DEFAULT '',
			`graph_height` int(10) unsigned DEFAULT '100',
			`graph_width` int(10) unsigned DEFAULT '300',
			`graph_thumbnails` char(3) DEFAULT '',
			`graph_columns` int(10) unsigned DEFAULT '2',
			`graph_perpage` int(10) unsigned DEFAULT '50',
			`graph_max` int(10) unsigned DEFAULT '2000',
			`export_clear` char(3) DEFAULT '',
			`export_thumbs` char(3) DEFAULT 'on',
			`export_args` char(25) DEFAULT '-zav',
			`export_directory` varchar(255) DEFAULT '',
			`export_temp_directory` varchar(255) DEFAULT '',
			`export_timing` varchar(20) DEFAULT 'disabled',
			`export_skip` int(10) unsigned DEFAULT '0',
			`export_hourly` varchar(20) DEFAULT '',
			`export_daily` varchar(20) DEFAULT '',
			`export_threads` int(10) DEFAULT '0',
			`export_sanitize_remote` char(3) DEFAULT '',
			`export_host` varchar(64) DEFAULT '',
			`export_port` varchar(5) DEFAULT '',
			`export_passive` char(3) DEFAULT '',
			`export_user` varchar(40) DEFAULT '',
			`export_password` varchar(64) DEFAULT '',
			`export_private_key_path` varchar(255) DEFAULT '',
			`status` int(10) unsigned DEFAULT '0',
			`export_pid` int(10) unsigned DEFAULT NULL,
			`next_start` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
			`last_checked` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
			`last_started` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
			`last_ended` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
			`last_errored` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
			`last_runtime` double NOT NULL DEFAULT '0',
			`last_error` varchar(255) DEFAULT NULL,
			`total_graphs` double DEFAULT '0',
			PRIMARY KEY (`id`))
			ENGINE=InnoDB
			COMMENT='Stores Graph Export Settings for Cacti'");
	}
	return true;
}

/**
 * Creates the graph_exports_tasks table (holding per-graph worker tasks
 * for an in-progress export job), if it doesn't already exist. Called
 * from gexport_setup_table() during installation and
 * gexport_check_upgrade() when upgrading from a version that predates
 * this table.
 *
 * @return bool Always returns true.
 */
function gexport_create_table_tasks() {
	if (!db_table_exists('graph_exports_tasks')) {
		db_execute("CREATE TABLE `graph_exports_tasks` (
			`id` int(10) unsigned NOT NULL AUTO_INCREMENT,
			`local_graph_id` int(10) unsigned NOT NULL DEFAULT '0',
			`export_id` int(10) unsigned NOT NULL DEFAULT '0',
			`pid` int(10) unsigned NOT NULL DEFAULT '0',
			`user` int(10) unsigned NOT NULL DEFAULT '0',
			`folder` varchar(255) DEFAULT '',
			`status` int(1) unsigned NOT NULL DEFAULT '0',
			`start_time` int(1) unsigned NOT NULL DEFAULT '0',
			PRIMARY KEY (`id`),
			KEY `status` (`status`),
			KEY `pid` (`pid`),
			KEY `start_time` (`start_time`))
			ENGINE=InnoDB
			COMMENT='Stores Graph Export Tasks for Cacti'");
	}
	return true;
}

/**
 * Hook implementation for Cacti's 'config_arrays' filter. Triggers this
 * plugin's database upgrade check, discovers available Cacti themes,
 * resolves the system temp directory, and defines the Export edit form's
 * field set (presentation/theme/tree/site selection, graph sizing,
 * timing, and remote-delivery/SCP options). Called by Cacti core via
 * api_plugin_hook('config_arrays', ...) while building the navigation
 * menu.
 *
 * @return void
 *
 * @global array $menu               Cacti's registered admin menu;
 *                                    appended with this plugin's
 *                                    'Graph Export' entry under
 *                                    'Utilities'.
 * @global array $fields_export_edit Populated here with the Export edit
 *                                    form's field definitions, used by
 *                                    gexport.php's edit form.
 * @global array $messages           Populated here (from the session)
 *                                    with a pending flash message for
 *                                    the Export edit form, when one is
 *                                    set.
 * @global array $config             Cacti global configuration array;
 *                                    used to discover installed themes.
 * @global array $graphs_per_page    Reserved/declared for parity with
 *                                    other config_arrays hook
 *                                    implementations; not used directly
 *                                    here.
 */
function gexport_config_arrays() {
	global $menu, $fields_export_edit, $messages, $config, $graphs_per_page;

	/* perform database upgrade, if required */
	gexport_check_upgrade();

	$dir = dir($config['base_path'] . '/include/themes/');
	while (false !== ($entry = $dir->read())) {
		if ($entry != '.' && $entry != '..') {
			if (is_dir($config['base_path'] . '/include/themes/' . $entry)) {
				$themes[$entry] = ucwords($entry);
			}
		}
	}
	asort($themes);
	$dir->close();

	// Replace OS check and fixed temp dir with sys_get_temp_dir()
	$tmp = sys_get_temp_dir() . DIRECTORY_SEPARATOR;

	if (isset($_SESSION['gexport_message']) && $_SESSION['gexport_message'] != '') {
		$messages['gexport_message'] = ['message' => $_SESSION['gexport_message'], 'type' => 'info'];
	}

	$menu[__('Utilities')]['plugins/gexport/gexport.php'] = __('Graph Exports', 'gexport');

	if (function_exists('auth_augment_roles')) {
		auth_augment_roles(__('General Administration'), ['gexport.php']);
	}

	$sites = array_rekey(db_fetch_assoc('SELECT "0" AS id, "All Sites" AS name UNION SELECT id, name FROM sites ORDER BY name'), 'id', 'name');
	$trees = array_rekey(db_fetch_assoc('SELECT "0" AS id, "All Trees" AS name UNION SELECT id, name FROM graph_tree ORDER BY name'), 'id', 'name');

	$fields_export_edit = array(
		'export_hdr_general' => array(
			'friendly_name' => __('General', 'gexport'),
			'collapsible' => 'true',
			'method' => 'spacer',
		),
		'name' => array(
			'friendly_name' => __('Export Name', 'gexport'),
			'description' => __('The name of this Graph Export Definition.', 'gexport'),
			'method' => 'textbox',
			'value' => '|arg1:name|',
			'default' => 'New Graph Export',
			'max_length' => '64',
			'size' => '40'
		),
		'enabled' => array(
			'friendly_name' => __('Enabled', 'gexport'),
			'description' => __('Check this Checkbox if you wish this Graph Export Definition to be enabled.', 'gexport'),
			'value' => '|arg1:enabled|',
			'default' => 'on',
			'method' => 'checkbox',
		),
		'export_type' => array(
			'friendly_name' => __('Export Method', 'gexport'),
			'description' => __('Choose which export method to use.', 'gexport'),
			'method' => 'drop_array',
			'value' => '|arg1:export_type|',
			'default' => 'disabled',
			'array' => array(
				'local' => __('Local', 'gexport'),
				'ftp' => __('FTP', 'gexport'),
				'sftp' => __('SFTP', 'gexport'),
				'ftp_nc' => __('FTP NC', 'gexport'),
				'scp' => __('SCP', 'gexport'),
				'rsync' => __('RSYNC', 'gexport')
			)
		),
		'export_args' => array(
			'friendly_name' => __('Export Command Arguments','gexport'),
			'description' => __('Arguments to use with non-local export methods. rsync should use ', 'gexport'),
			'method' => 'drop_array',
			'default' => '-zav',
			'value' => '|arg1:export_args|',
			'array' => array(
				'-zav' => ('rsync -zav'),
				'-avpro' => ('rsync -avpro'),
				'-avpro --delete-excluded' => ('rsync -avpro --delete-excluded'),
				'-rp' => ('scp -rp')
			)
		),
		'export_theme' => array(
			'friendly_name' => __('Theme', 'gexport'),
			'description' => __('Please select one of the available Themes to skin your Cacti Graph Exports with.', 'gexport'),
			'method' => 'drop_array',
			'value' => '|arg1:export_theme|',
			'default' => 'modern',
			'array' => $themes
		),
		'export_presentation' => array(
			'friendly_name' => __('Presentation Method', 'gexport'),
			'description' => __('Choose which presentation would you want for the html generated pages. If you choose classical presentation; the Graphs will be in a only-one-html page. If you choose tree presentation, the Graph Tree architecture will be kept in the static html pages', 'gexport'),
			'method' => 'drop_array',
			'value' => '|arg1:export_presentation|',
			'default' => 'disabled',
			'array' => array(
				'preview' => __('Site', 'gexport'),
				'tree' => __('Tree', 'gexport'),
			)
		),
		'export_hdr_timing' => array(
			'friendly_name' => __('Export Timing', 'gexport'),
			'method' => 'spacer',
		),
		'export_timing' => array(
			'friendly_name' => __('Timing Method', 'gexport'),
			'description' => __('Choose when to Export Graphs.', 'gexport'),
			'method' => 'drop_array',
			'value' => '|arg1:export_timing|',
			'default' => 'export_hourly',
			'array' => array(
				'periodic' => __('Periodic', 'gexport'),
				'hourly' => __('Hourly', 'gexport'),
				'daily' => __('Daily', 'gexport')
			),
		),
		'export_skip' => array(
			'friendly_name' => __('Periodic Export Cycle', 'gexport'),
			'description' => __('How often do you wish Cacti to Export Graphs.  This is the unit of Polling Cycles you wish to export Graphs.', 'gexport'),
			'method' => 'drop_array',
			'value' => '|arg1:export_skip|',
			'array' => array(
				1  => __('Every Polling Cycle', 'gexport'),
				2  => __('Every %d Polling Cycles', 2, 'gexport'),
				3  => __('Every %d Polling Cycles', 3, 'gexport'),
				4  => __('Every %d Polling Cycles', 4, 'gexport'),
				5  => __('Every %d Polling Cycles', 5, 'gexport'),
				6  => __('Every %d Polling Cycles', 6, 'gexport'),
				7  => __('Every %d Polling Cycles', 7, 'gexport'),
				8  => __('Every %d Polling Cycles', 8, 'gexport'),
				9  => __('Every %d Polling Cycles', 9, 'gexport'),
				10 => __('Every %d Polling Cycles', 10, 'gexport'),
				11 => __('Every %d Polling Cycles', 11, 'gexport'),
				12 => __('Every %d Polling Cycles', 12, 'gexport')
			),
		),
		'export_hourly' => array(
			'friendly_name' => __('Hourly at specified minutes', 'gexport'),
			'description' => __('If you want Cacti to export static images on an hourly basis, put the minutes of the hour when to do that. Cacti assumes that you run the data gathering script every 5 minutes, so it will round your value to the one closest to its runtime. For instance, 43 would equal 40 minutes past the hour.', 'gexport'),
			'method' => 'textbox',
			'placeholder' => 'MM',
			'value' => '|arg1:export_hourly|',
			'default' => '00',
			'max_length' => '10',
			'size' => '5'
		),
		'export_daily' => array(
			'friendly_name' => __('Daily at specified time', 'gexport'),
			'description' => __('If you want Cacti to export static images on an daily basis, put here the time when to do that. Cacti assumes that you run the data gathering script every 5 minutes, so it will round your value to the one closest to its runtime. For instance, 21:23 would equal 20 minutes after 9 PM.', 'gexport'),
			'method' => 'textbox',
			'placeholder' => 'HH:MM',
			'value' => '|arg1:export_daily|',
			'default' => '00:00',
			'max_length' => '10',
			'size' => '5'
		),
		'export_threads' => array(
			'friendly_name' => __('Use x Threads', 'gexport'),
			'description' => __('How many background threads do you wish Cacti to use when exporting graphs.  Default is 0 to run all export in poller thread, 1 or more to spawn separate background threads','gexport'),
			'method' => 'textbox',
			'value' => '|arg1:export_threads|',
			'default' => '0',
			'max_length' => '10',
			'size' => '5'
		),
		'export_thumb_options' => array(
			'friendly_name' => __('Graph Selection & Settings', 'gexport'),
			'collapsible' => 'true',
			'method' => 'spacer',
		),
		'export_effective_user' => array(
			'friendly_name' => __('Effective User', 'gexport'),
			'description' => __('The user name to utilize for establishing permissions to Cacti Graphs.  This user name will be used to determine which Graphs/Trees can be exported.  N/A means don\'t assume any security is in place.', 'gexport'),
			'method' => 'drop_sql',
			'value' => '|arg1:export_effective_user|',
			'sql' => 'SELECT id, username AS name FROM user_auth ORDER BY name',
			'none_value' => __('N/A', 'gexport'),
			'default' => '0'
		),
		'graph_tree' => array(
			'friendly_name' => __('Tree', 'gexport'),
			'description' => __('The Tree(s) to export.', 'gexport'),
			'method' => 'drop_multi',
			'value' => '|arg1:graph_tree|',
			'array' => $trees,
			'default' => '0'
		),
		'export_expand_hosts' => array(
			'friendly_name' => __('Expand Devices/Sites', 'gexport'),
			'description' => __('This setting determines if Tree Devices and Site Templates and Devices will be expanded or not.  If set to expanded, each host will have a sub-folder containing either Graph Templates or Data Query items.', 'gexport'),
			'method' => 'drop_array',
			'value' => '|arg1:export_expand_hosts|',
			'default' => 'off',
			'array' => array(
				'off' => __('Off', 'gexport'),
				'on' => __('On', 'gexport')
			)
		),
		'graph_site' => array(
			'friendly_name' => __('Site', 'gexport'),
			'description' => __('The Site for Cacti Graphs to be Exported from.', 'gexport'),
			'method' => 'drop_multi',
			'value' => '|arg1:graph_site|',
			'array' => $sites,
			'default' => '0'
		),
		'graph_width' => array(
			'friendly_name' => __('Graph Thumbnail Width', 'gexport'),
			'description' => __('The default width of Thumbnail Graphs in pixels.', 'gexport'),
			'method' => 'textbox',
			'value' => '|arg1:graph_width|',
			'default' => '300',
			'max_length' => '10',
			'size' => '5'
		),
		'graph_height' => array(
			'friendly_name' => __('Graph Thumbnail Height', 'gexport'),
			'description' => __('The height of Thumbnail Graphs in pixels.', 'gexport'),
			'method' => 'textbox',
			'value' => '|arg1:graph_height|',
			'default' => '100',
			'max_length' => '10',
			'size' => '5'
		),
		'graph_thumbnails' => array(
			'friendly_name' => __('Default View Thumbnails', 'gexport'),
			'description' => __('Check this if you want the default Graph View to be in Thumbnail mode.', 'gexport'),
			'method' => 'checkbox',
			'value' => '|arg1:graph_thumbnails|',
		),
		'graph_columns' => array(
			'friendly_name' => __('Default Graph Columns', 'gexport'),
			'description' => __('The number of columns to use by default when displaying Graphs.', 'gexport'),
			'method' => 'textbox',
			'value' => '|arg1:graph_columns|',
			'default' => '2',
			'max_length' => '5',
			'size' => '5'
		),
		'graph_perpage' => array(
			'friendly_name' => __('Graphs Per Page', 'gexport'),
			'description' => __('Choose the number of Graphs Per Page to display.', 'gexport'),
			'method' => 'drop_array',
			'value' => '|arg1:graph_perpage|',
			'default' => 20,
			'array' => $graphs_per_page,
		),
		'graph_max' => array(
			'friendly_name' => __('Maximum Graphs to Export', 'gexport'),
			'description' => __('After this number is reached, an error will be generated, but exporting will continue.  Set to 0 for no limit.', 'gexport'),
			'method' => 'textbox',
			'value' => '|arg1:graph_max|',
			'default' => '2000',
			'max_length' => '5',
			'size' => '5'
		),
		'export_hdr_paths' => array(
			'friendly_name' => __('Export Location Information', 'gexport'),
			'collapsible' => 'true',
			'method' => 'spacer',
		),
		'export_thumbs' => array(
			'friendly_name' => __('Export Thumbnails', 'gexport'),
			'description' => __('Check this if you want the export thumbnails mode.', 'gexport'),
			'method' => 'checkbox',
			'value' => '|arg1:export_thumbs|',
		),
		'export_clear' => array(
			'friendly_name' => __('Clear Directory', 'gexport'),
			'description' => __('Check this Checkbox if you wish this Graph Export to clear the final directory before populating.', 'gexport'),
			'value' => '|arg1:export_clear|',
			'method' => 'checkbox',
		),
		'export_directory' => array(
			'friendly_name' => __('Export Directory', 'gexport'),
			'description' => __('This is the directory, either on the local system or on the remote system, that will contain the exported data.', 'gexport'),
			'method' => 'dirpath',
			'value' => '|arg1:export_directory|',
			'max_length' => '255'
		),
		'export_temp_directory' => array(
			'friendly_name' => __('Local Scratch Directory', 'gexport'),
			'description' => __('This is the directory that Cacti will temporarily store output prior to sending to the remote site via the transfer method.  The contents of this directory will be deleted after the data is transferred.', 'gexport'),
			'method' => 'dirpath',
			'value' => '|arg1:export_temp_directory|',
			'default' => $tmp,
			'max_length' => '255'
		),
		'export_hdr_remote' => array(
			'friendly_name' => __('Remote Options', 'gexport'),
			'method' => 'spacer',
			'collapsible' => 'true'
		),
		'export_sanitize_remote' => array(
			'friendly_name' => __('Sanitize remote directory', 'gexport'),
			'description' => __('Check this if you want to delete any existing files in the FTP remote directory. This option is in use only when using the PHP built-in ftp functions.', 'gexport'),
			'method' => 'checkbox',
			'value' => '|arg1:export_sanitize_remote|',
		),
		'export_host' => array(
			'friendly_name' => __('Remote Host', 'gexport'),
			'description' => __('Denotes the host to send Exported Graphs to.', 'gexport'),
			'placeholder' => 'hostname',
			'method' => 'textbox',
			'value' => '|arg1:export_host|',
			'max_length' => '255'
		),
		'export_port' => array(
			'friendly_name' => __('Remote Port', 'gexport'),
			'description' => __('Communication port to use for the export method if non-standard (leave empty for defaults).', 'gexport'),
			'placeholder' => 'default',
			'method' => 'textbox',
			'value' => '|arg1:export_port|',
			'max_length' => '10',
			'size' => '5'
		),
		'export_passive' => array(
			'friendly_name' => __('Use passive mode', 'gexport'),
			'description' => __('Check this if you want to connect in passive mode to the FTP server.', 'gexport'),
			'method' => 'checkbox',
			'value' => '|arg1:export_passive|',
		),
		'export_user' => array(
			'friendly_name' => __('User', 'gexport'),
			'description' => __('Account to logon on the remote server (leave empty for defaults).', 'gexport'),
			'method' => 'textbox',
			'value' => '|arg1:export_user|',
			'max_length' => '40',
			'size' => 30
		),
		'export_password' => array(
			'friendly_name' => __('Password', 'gexport'),
			'description' => __('Password for the remote ftp account (leave empty for blank).', 'gexport'),
			'method' => 'textbox_password',
			'value' => '|arg1:export_password|',
			'max_length' => '64',
			'size' => 30
		),
		'export_private_index_path' => array(
			'friendly_name' => __('Private Key Path', 'gexport'),
			'description' => __('For SCP and RSYNC, enter the Private Key path if required.', 'gexport'),
			'method' => 'filepath',
			'value' => '|arg1:export_private_index_path|',
			'max_length' => '255',
			'size' => 50
		)
	);
}

/**
 * Hook implementation for Cacti's 'draw_navigation_text' filter. Adds
 * breadcrumb entries for gexport.php's default, edit, and actions views.
 * Called by Cacti core via api_plugin_hook('draw_navigation_text', ...)
 * while rendering the page breadcrumb trail.
 *
 * @param array $nav The existing breadcrumb map contributed by Cacti
 *                    core and other plugins.
 *
 * @return array The $nav array with this plugin's breadcrumb entries
 *               added.
 */
function gexport_draw_navigation_text($nav) {
	$nav['gexport.php:'] = array(
		'title' => __('Exported Cacti Graph Pages', 'gexport'),
		'mapping' => 'index.php:',
		'url' => 'gexport.php',
		'level' => '1');

	$nav['gexport.php:edit'] = array(
		'title' => __('(Edit)', 'gexport'),
		'mapping' => 'index.php:,gexport.php:',
		'url' => '',
		'level' => '2');

	$nav['gexport.php:actions'] = array(
		'title' => __('Actions', 'gexport'),
		'mapping' => 'index.php:,gexport.php:',
		'url' => '',
		'level' => '2');

	return $nav;
}