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

require('./include/auth.php');
require_once(CACTI_PATH_LIBRARY . '/export.php');
require_once(CACTI_PATH_LIBRARY . '/import.php');
require_once(CACTI_PATH_LIBRARY . '/package.php');
require_once(CACTI_PATH_LIBRARY . '/xml.php');

// set default action
set_default_action();

if (check_get_author_info() === false) {
	exit;
}

switch (grv('action')) {
	case 'save':
		form_save();

		break;
	case 'get_contents':
		$export_type    = gnrv('export_type');
		$export_item_id = gnrv('export_item_id');
		$include_deps   = (gnrv('include_deps') == 'true' ? true : false);

		print get_package_contents($export_type, $export_item_id);

		break;
	default:
		top_header();
		export();
		bottom_footer();

		break;
}

function form_save() : void {
	global $export_types, $export_errors, $debug, $package_file;

	// ================= input validation =================
	gfrv('export_item_id');
	// ====================================================

	$export_okay = false;

	$export_type    = gnrv('export_type');
	$export_item_id = intval(gfrv('export_item_id'));

	if (isrv('include_deps') && gnrv('include_deps') == '') {
		$include_deps = false;
	} else {
		$include_deps = true;
	}

	$xml_data = get_item_xml($export_type, $export_item_id, $include_deps);

	$info                 = [];
	$info['name']         = gnrv('name');
	$info['author']       = gnrv('author');
	$info['homepage']     = gnrv('homepage');
	$info['email']        = gnrv('email');
	$info['description']  = gnrv('description');
	$info['class']        = gnrv('class');
	$info['tags']         = gnrv('tags');
	$info['installation'] = gnrv('installation');
	$info['version']      = gnrv('version');
	$info['copyright']    = gnrv('copyright');

	// Let's store the Template information for subsequent exports
	$hash = get_export_hash(gnrv('export_type'), gnrv('export_item_id'));

	$export_okay = save_packager_metadata($hash, $info);

	$debug = '';

	if ($export_okay) {
		$files = find_dependent_files($xml_data);

		// search xml files for scripts
		if (cacti_sizeof($files)) {
			foreach ($files as $file) {
				if (str_contains($file['file'], '.xml')) {
					$files = array_merge($files, find_dependent_files((string) file_get_contents($file['file'])));
				}
			}
		}

		$success = package_template($xml_data, $info, $files, $debug);
	} else {
		top_header();
		print __('WARNING: Export Errors Encountered. Refresh Browser Window for Details!') . "\n";
		print $xml_data;
		bottom_footer();

		exit;
	}

	if ($export_errors || !$success) {
		raise_message('package_error', __('There were errors packaging your Templates.  Errors Follow. ') . str_replace("\n", '<br>', $debug), MESSAGE_LEVEL_ERROR);
		header('Location: package.php');

		exit;
	}

	if ($package_file != '') {
		header('Content-Type: application/gzip');
		header('Content-Disposition: attachment; filename="' . basename($package_file) . '"');
		header('Content-Length: ' . filesize($package_file));
		header('Content-Control: no-cache');
		header('Pragma: public');
		header('Expires: 0');
		readfile($package_file);
		unlink($package_file);

		exit;
	}
}

function export() : void {
	global $export_types, $device_classes, $graph_template_classes, $copyrights;

	// 'graph_template' should be the default
	if (!isrv('export_type')) {
		srv('export_type', 'host_template');

		$id = db_fetch_cell('SELECT id FROM host_template ORDER BY name LIMIT 1');

		srv('export_item_id', $id);
	}

	unset($export_types['data_template']);
	unset($export_types['data_query']);

	switch (gnrv('export_type')) {
		case 'host_template':
		case 'graph_template':
		case 'data_query':
			break;
		default:
			srv('export_type', 'host_template');
	}

	html_start_box(__('Package Templates'), '100%', false, 3, 'center', '');

	?>
	<tr class='tableRow'>
		<td>
			<table role='presentation'>
				<tr>
					<td><span class='formItemName'><label for='package_export_type'><?php print __('What would you like to Package?'); ?></label>&nbsp;</span></td>
					<td>
						<select id='package_export_type'>
							<?php
							foreach ($export_types as $key => $array) {
								print "<option value='$key'";

								if (gnrv('export_type') == $key) {
									print ' selected';
								} print '>' . htmle($array['name']) . '</option>';
							}
	?>
						</select>
					</td>
				</tr>
			</table>
		</td>
	</tr>
	<?php

	html_end_box();

	$info = check_get_author_info();

	if ($info === false) {
		exit;
	}

	// Let's get any saved package details from the last time the template was packaged
	$data = [];
	$hash = get_export_hash(gnrv('export_type'), gnrv('export_item_id'));

	// Two methods, one with SQLite and one without

	$data    = [];
	$detail  = [];
	$classes = [];

	if (class_exists('SQLite3')) {
		$data = get_packager_metadata($hash);
	}

	// Legacy support, to be deprecated eventually
	if (!cacti_sizeof($data)) {
		$data = read_config_option('package_export_' . $hash);

		if ($data != '') {
			$data = json_decode($data, true);
		}
	}

	// If this template has not been saved before, initialize values
	switch(gnrv('export_type')) {
		case 'host_template':
			$classes = $device_classes;

			if (!isrv('export_item_id')) {
				$detail = db_fetch_row('SELECT *
					FROM host_template
					ORDER BY name
					LIMIT 1');
			} else {
				$detail = db_fetch_row_prepared('SELECT *
					FROM host_template
					WHERE id = ?',
					[gfrv('export_item_id')]);
			}

			break;
		case 'graph_template':
			$classes = $graph_template_classes;

			if (!isrv('export_item_id')) {
				$detail = db_fetch_row('SELECT *
					FROM graph_templates
					ORDER BY name
					LIMIT 1');
			} else {
				$detail = db_fetch_row_prepared('SELECT *
					FROM graph_templates
					WHERE id = ?',
					[gfrv('export_item_id')]);
			}

			break;
		case 'data_query':
			$classes = $graph_template_classes;

			if (!isrv('export_item_id')) {
				$detail = db_fetch_row('SELECT id, name
					FROM snmp_query
					ORDER BY name
					LIMIT 1');
			} else {
				$detail = db_fetch_row_prepared('SELECT id, name
					FROM snmp_query
					WHERE id = ?',
					[gfrv('export_item_id')]);
			}

			break;
	}

	if (cacti_sizeof($detail)) {
		switch(gnrv('export_type')) {
			case 'host_template':
				$data['description'] = __('%s Device Package', $detail['name']);

				break;
			case 'graph_template':
				$data['description'] = __('%s Graph Template Package', $detail['name']);

				break;
			case 'data_query':
				$data['description'] = __('%s Data Query Package', $detail['name']);

				break;
		}

		$meta_columns = ['version', 'class', 'author', 'email', 'tags', 'copyright', 'installation'];

		foreach ($meta_columns as $m) {
			if (isset($detail[$m]) && $detail[$m] != '') {
				$data[$m] = $detail[$m];
			} else {
				$default = read_config_option("package_$m");

				if (!empty($default)) {
					$data[$m] = $default;
				}
			}
		}

		$data['name'] = $detail['name'];
	}

	if (cacti_sizeof($data)) {
		$info = array_merge($info, $data);
	}

	form_start('package.php', 'form_id');

	html_start_box(__('Available Templates [%s]', $export_types[gnrv('export_type')]['name']), '100%', false, 3, 'center', '');

	$package_form = [
		'spacer0' => [
			'method'        => 'spacer',
			'friendly_name' => __('Available Templates'),
		],
		'export_item_id' => [
			'method'        => 'drop_sql',
			'friendly_name' => __('%s to Export', $export_types[gnrv('export_type')]['name']),
			'description'   => __('Choose the exact items to export in the Package.'),
			'value'         => (isrv('export_item_id') ? gfrv('export_item_id') : '|arg1:export_item_id|'),
			'sql'           => $export_types[gnrv('export_type')]['dropdown_sql']
		],
		'include_deps' => [
			'method'        => 'checkbox',
			'friendly_name' => __('Include Dependencies'),
			'description'   => __('Some templates rely on other items in Cacti to function properly. It is highly recommended that you select this box or the resulting import may fail.'),
			'value'         => 'on',
			'sql'           => $export_types[gnrv('export_type')]['dropdown_sql']
		],
		'spacer1' => [
			'method'        => 'spacer',
			'friendly_name' => __('Package Information'),
		],
		'description' => [
			'method'        => 'textbox',
			'friendly_name' => __('Description'),
			'description'   => __('The Package Description.'),
			'value'         => (isset($info['description']) ? $info['description'] : read_config_option('package_description', true)),
			'max_length'    => '255',
			'size'          => '80'
		],
		'copyright' => [
			'method'        => 'drop_array',
			'friendly_name' => __('Copyright'),
			'description'   => __('The license type for this package.'),
			'value'         => (isset($info['copyright']) ? $info['copyright'] : 'GNU General Public License'),
			'array'         => [
				'Apache License 2.0'                 => __('Apache License 2.0'),
				'Creative Commons'                   => __('Creative Commons'),
				'GNU General Public License'         => __('GNU General Public License'),
				'MIT License'                        => __('MIT License'),
				'Eclipse Public License version 2.0' => __('Eclipse Public License version 2.0'),
			],
			'default' => 'GNU General Public License'
		],
		'version' => [
			'method'        => 'textbox',
			'friendly_name' => __('Version'),
			'description'   => __('The version number to publish for this Package.'),
			'value'         => (isset($info['version']) ? $info['version'] : read_config_option('package_version', true)),
			'max_length'    => '10',
			'size'          => '10'
		],
		'class' => [
			'method'        => 'drop_array',
			'friendly_name' => __('Class'),
			'description'   => __('The Classification of the Package.'),
			'value'         => (isset($info['class']) ? $info['class'] : read_config_option('package_class', true)),
			'array'         => $classes,
			'default'       => 'unassigned'
		],
		'tags' => [
			'method'        => 'textarea',
			'friendly_name' => __('Tags'),
			'description'   => __('Assign various searchable attributes to the Package.'),
			'value'         => (isset($info['tags']) ? $info['tags'] : read_config_option('package_tags', true)),
			'textarea_rows' => '2',
			'textarea_cols' => '80'
		],
		'installation' => [
			'method'        => 'textarea',
			'friendly_name' => __('Installation Instructions'),
			'description'   => __('Some Packages require additional changes outside of Cacti\'s scope such as setting up an SNMP Agent Extension on the Devices to be monitored.  You should add those instructions here..'),
			'value'         => (isset($info['installation']) ? $info['installation'] : read_config_option('package_installation', true)),
			'textarea_rows' => '5',
			'textarea_cols' => '80'
		],
		'spacer2' => [
			'method'        => 'spacer',
			'friendly_name' => __('Author Information'),
		],
		'author' => [
			'method'        => 'other',
			'friendly_name' => __('Author Name'),
			'description'   => __('The Registered Authors Name.'),
			'value'         => $info['author'],
			'max_length'    => '40',
			'size'          => '40'
		],
		'homepage' => [
			'method'        => 'other',
			'friendly_name' => __('Homepage'),
			'description'   => __('The Registered Authors Home Page.'),
			'value'         => $info['homepage'],
			'max_length'    => '60',
			'size'          => '60'
		],
		'email' => [
			'method'        => 'other',
			'friendly_name' => __('Email Address'),
			'description'   => __('The Registered Authors Email Address.'),
			'value'         => $info['email'],
			'max_length'    => '60',
			'size'          => '60'
		],
		'export_type' => [
			'method' => 'hidden',
			'value'  => gnrv('export_type')
		]
	];

	draw_edit_form(
		[
			'config' => ['no_form_tag' => true],
			'fields' => $package_form
		]
	);

	html_end_box();

	?>
	<table role='presentation' style='width:100%;text-align:center;'>
		<tr>
			<td class='saveRow'>
				<input type='hidden' name='action' value='save'>
				<input type='hidden' id='name' name='name' value='<?php print htmle($detail['name']); ?>'>
				<button class='export ui-button ui-corner-all ui-widget ui-state-active' type='submit'><?php print __('Package'); ?></button>
			</td>
		</tr>
	</table>
	</form>
	<script type='text/javascript'>
	var stopTimer = null;

	$(function() {
		$('#package_export_type').change(function() {
			strURL  = urlPath+'package.php';
			strURL += '?export_type='+$('#package_export_type').val();
			strURL += '&author='+$('#author').val();
			strURL += '&homepage='+escape($('#homepage').val());
			strURL += '&email='+$('#email').val();
			strURL += '&description='+escape($('#description').val());
			strURL += '&version='+escape($('#version').val());
			loadPageNoHeader(strURL);
		});

		$('#export_item_id').change(function() {
			strURL  = urlPath+'package.php';
			strURL += '?export_type='+$('#package_export_type').val();
			strURL += '&export_item_id='+$('#export_item_id').val();
			strURL += '&author='+$('#author').val();
			strURL += '&homepage='+escape($('#homepage').val());
			strURL += '&email='+$('#email').val();
			strURL += '&description='+escape($('#description').val());
			strURL += '&version='+escape($('#version').val());
			loadPageNoHeader(strURL);
		});

		if ($('#details').length) {
			strURL  = urlPath+'package.php';
			strURL += '?action=get_contents';
			strURL += '&export_type='+$('#package_export_type').val();
			strURL += '&export_item_id='+$('#export_item_id').val();
			strURL += '&include_deps='+$('#include_deps').is(':checked');
			$.get(strURL, function(data) {
				$('#details').html(data);
				$('#name').val($('#export_item_id option:selected').text());
			});
		}

		$('form#form_id').submit(function(event) {
			stopTimer = setTimeout(function() { Pace.stop() }, 1000);
		});

		if ($('#name').val() == '') {
			$('#name').val($('#export_item_id option:selected').text());
		}
	});
	</script>
	<?php

	html_start_box(__('Package Contents Include'), '100%', false, 3, 'center', '');

	if (isrv('export_type') && isrv('export_item_id')) {
		print get_package_contents(grv('export_type'), grv('export_item_id'));
	} else {
		print '<div id="details" style="vertical-align:top">';
		print '</div>';
	}

	html_end_box();
}