pfSense

#!/usr/local/bin/php-cgi -q

<?php

/*

 * rc.restore_config_backup

 *

 * part of pfSense (https://www.pfsense.org)

 * Copyright (c) 2004-2016 Rubicon Communications, LLC (Netgate)

 * All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions are met:

 *

 * 1. Redistributions of source code must retain the above copyright notice,

 *    this list of conditions and the following disclaimer.

 *

 * 2. Redistributions in binary form must reproduce the above copyright

 *    notice, this list of conditions and the following disclaimer in

 *    the documentation and/or other materials provided with the

 *    distribution.

 *

 * 3. All advertising materials mentioning features or use of this software

 *    must display the following acknowledgment:

 *    "This product includes software developed by the pfSense Project

 *    for use in the pfSense® software distribution. (http://www.pfsense.org/).

 *

 * 4. The names "pfSense" and "pfSense Project" must not be used to

 *    endorse or promote products derived from this software without

 *    prior written permission. For written permission, please contact

 *    coreteam@pfsense.org.

 *

 * 5. Products derived from this software may not be called "pfSense"

 *    nor may "pfSense" appear in their names without prior written

 *    permission of the Electric Sheep Fencing, LLC.

 *

 * 6. Redistributions of any form whatsoever must retain the following

 *    acknowledgment:

 *

 * "This product includes software developed by the pfSense Project

 * for use in the pfSense software distribution (http://www.pfsense.org/).

 *

 * THIS SOFTWARE IS PROVIDED BY THE pfSense PROJECT ``AS IS'' AND ANY

 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE pfSense PROJECT OR

 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT

 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,

 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED

 * OF THE POSSIBILITY OF SUCH DAMAGE.

 */

require_once('config.inc');

cleanup_backupcache();

$confvers = get_backups();

unset($confvers['versions']);

$fp = fopen('php://stdin', 'r');

function print_backup_info($backup_info, $number) {

	if ($backup_info['time'] != 0) {

		$date = date(gettext("n/j/y H:i:s"), $backup_info['time']);

	} else {

		$date = gettext("Unknown");

	}

	list($page, $reason) = explode(": ", $backup_info['description'], 2);

	if (empty($reason)) {

		$reason = $page;

		$page = gettext("Unknown Page");

	}

	echo sprintf("%02d", $number) . ". {$date}\tv{$backup_info['version']}\t{$page}\n";

	if ($reason) {

		echo "    {$reason}\n";

	}

}

function list_backups($which="all", $return=false) {

	global $confvers;

	if (count($confvers) == 0) {

		echo gettext("No backups found in the configuration history.");

		return;

	}

	for ($c = count($confvers)-1; $c >= 0; $c--) {

		if (is_numeric($which) && ($c != $which)) {

			continue;

		}

		print_backup_info($confvers[$c], $c+1);

		echo "\n";

	}

}

function choose_backup() {

	global $fp, $confvers;

	if (count($confvers) == 0) {

		echo gettext("No backups found in the configuration history.");

		return -1;

	}

	echo gettext("Which configuration would you like to restore?") . "\n";

	echo " 1-" . count($confvers) . " : ";

	$number = strtoupper(chop(fgets($fp)));

	if (is_numeric($number) && ($number > 0) && ($number <= count($confvers))) {

		return $number;

	} else {

		echo gettext("That is not a valid backup number.\n");

		return -1;

	}

}

function restore_history_backup($number) {

	global $g, $fp, $confvers;

	if (is_numeric($number) && ($number > 0) && ($number <= count($confvers))) {

		$realnumber = $number - 1;

		echo "\n" . gettext("Is this the backup you wish to restore?") . "\n";

		list_backups($realnumber);

		$thisbackup = $confvers[$realnumber];

		echo gettext("Y/N?") . " : ";

		$confirm = strtoupper(chop(fgets($fp)));

		if ($confirm == gettext("Y")) {

			conf_mount_rw();

			if (config_restore($g['conf_path'] . '/backup/config-' . $thisbackup['time'] . '.xml') == 0) {

				echo "\n";

				echo sprintf(gettext('Successfully reverted to timestamp %1$s with description "%2$s".'), date(gettext("n/j/y H:i:s"), $thisbackup['time']), $thisbackup['description']);

				echo "\n" . gettext("You may need to reboot the firewall or restart services before the restored configuration is fully active.") . "\n\n";

			} else {

				echo gettext("Unable to revert to the selected configuration.") . "\n";

			}

			conf_mount_ro();

		} else {

			echo gettext("Restore cancelled.") . "\n";

		}

	} else {

		echo gettext("Restore cancelled due to invalid input.") . "\n";

	}

}

while (true) {

	echo "\n";

	echo gettext("Restore Backup from Configuration History") . "\n\n";

	echo "1) " . gettext("List Backups") . "\n";

	echo "2) " . gettext("Restore Backup") . "\n";

	echo "Q) " . gettext("Quit") . "\n";

	echo "\n\n";

	echo gettext("Please select an option to continue") . ": ";

	$command = strtolower(chop(fgets($fp)));

	// Make sure we can detect a foreign language "quit" command.

	if (strtolower($command) == gettext("quit")) {

		$command = "quit";

	}

	switch ($command) {

		case "q":

		case "quit":

			echo "\n";

			fclose($fp);

			die;

			break;

		case "1":

			list_backups();

			break;

		case "2":

			$number = choose_backup();

			restore_history_backup($number);

			fclose($fp);

			die;

			break;

	}

}

fclose($fp);

die;

?>