cacti/cli/import_template.php

#!/usr/bin/php -q
<?php
/*
 +-------------------------------------------------------------------------+
 | Copyright (C) 2004-2017 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/                                                   |
 +-------------------------------------------------------------------------+
*/

/* do NOT run this script through a web browser */
if (!isset($_SERVER['argv'][0]) || isset($_SERVER['REQUEST_METHOD'])  || isset($_SERVER['REMOTE_ADDR'])) {
	die('<br><strong>This script is only meant to run at the command line.</strong>');
}

/* We are not talking to the browser */
$no_http_headers = true;

include(dirname(__FILE__).'/../include/global.php');
include_once($config['base_path'] . '/lib/import.php');

/* process calling arguments */
$parms = $_SERVER['argv'];
array_shift($parms);

if (sizeof($parms)) {
	$filename = '';
	$import_custom_rra_settings = false;
	$rra_set = '';

	foreach($parms as $parameter) {
		if (strpos($parameter, '=')) {
			list($arg, $value) = explode('=', $parameter);
		} else {
			$arg = $parameter;
			$value = '';
		}

		switch ($arg) {
			case '--filename':
				$filename = trim($value);

				break;
			case '--with-template-rras':
				$import_custom_rra_settings = true;

				break;
			case '--with-user-rras':
				$rra_set = trim($value);

				break;
			case '--help':
			case '-H':
			case '-h':
				display_help();
				exit;
			case '--version':
			case '-V':
			case '-v':
				display_version();
				exit;
			default:
				echo "ERROR: Invalid Argument: ($arg)\n\n";
				exit(1);
		}
	}
	
	if($rra_set != '') {
		if ($import_custom_rra_settings) {
			echo "ERROR: '--with-template-rras' given and '--with-user-rras' given. Ignoring '--with-user-rras'\n";
		} else {
			$rra_array = explode(':', $rra_set);
			if (sizeof($rra_array)) {
				foreach ($rra_array as $key => $value) {
					$name = db_fetch_cell('SELECT name FROM rra WHERE id=' . intval($value));
					if (strlen($name)) {
						echo "using RRA $name\n";
					} else {
						echo "RRA id $value not found\n";
						unset($rra_array[$key]);
					}
				}
			}
		}
	}else{
		$rra_array = array();
		if (!$import_custom_rra_settings) {
			echo "ERROR: neither '--with-template-rras' given nor '--with-user-rras' given. Exiting'\n";
			return false;
		}
	}

	if($filename != '') {
		if(file_exists($filename) && is_readable($filename)) {
			$fp = fopen($filename,'r');
			$xml_data = fread($fp,filesize($filename));
			fclose($fp);

			echo 'Read ' . strlen($xml_data) . " bytes of XML data\n";

			$debug_data = import_xml_data($xml_data, $import_custom_rra_settings, $rra_array);

			while (list($type, $type_array) = each($debug_data)) {
				print '** ' . $hash_type_names[$type] . "\n";

				while (list($index, $vals) = each($type_array)) {
					if ($vals['result'] == 'success') {
						$result_text = ' [success]';
					}else{
						$result_text = ' [fail]';
					}

					if ($vals['type'] == 'update') {
						$type_text = ' [update]';
					}else{
						$type_text = ' [new]';
					}
					echo "   $result_text " . $vals['title'] . " $type_text\n";

					$dep_text = ''; $errors = false;
					if ((isset($vals['dep'])) && (sizeof($vals['dep']) > 0)) {
						while (list($dep_hash, $dep_status) = each($vals['dep'])) {
							if ($dep_status == 'met') {
								$dep_status_text = 'Found Dependency: ';
							} else {
								$dep_status_text = 'Unmet Dependency: ';
								$errors = true;
							}

							$dep_text .= "    + $dep_status_text " . hash_to_friendly_name($dep_hash, true) . "\n";
						}
					}

					/* dependency errors need to be reported */
					if ($errors) {
						echo $dep_text;
						exit(-1);
					}
				}
			}
		} else {
			echo "ERROR: file $filename is not readable, or does not exist\n\n";
			exit(1);
		}
	} else {
		echo "ERROR: no filename specified\n\n";
		display_help();
		exit(1);
	}
} else {
	echo "ERROR: no parameters given\n\n";
	display_help();
	exit(1);
}

/*  display_version - displays version information */
function display_version() {
	$version = db_fetch_cell('SELECT cacti FROM version');
	echo "Cacti Import Template Utility, Version $version, " . COPYRIGHT_YEARS . "\n";
}

function display_help() {
	display_version();

	echo "\nusage: import_template.php --filename=[filename] [--with-template-rras] [--with-user-rras=[n[:m]...]]\n\n";
	echo "A utility to allow Cacti Templates to be imported from the command line\n\n";
	echo "Required:\n";
	echo "    --filename     the name of the XML file to import\n\n";
	echo "Optional:\n";
	echo "    --with-template-rras    also import custom RRA definitions from the template\n";
	echo "    --with-user-rras        use your own set of RRA like '1:2:3:4'\n\n";
}