nwipe/src/gui.c

/*
 *  gui.c: An ncurses GUI for nwipe. 
 *
 *  Copyright Darik Horn <dajhorn-dban@vanadac.com>.
 *  
 *  Modifications to original dwipe Copyright Andy Beverley <andy@andybev.com>
 *  
 *  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, version 2.
 *
 *  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.
 *
 *  You should have received a copy of the GNU General Public License along with
 *  this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 
 *
 */


/* RATIONALE:
 *
 *   This entire GUI is a non-portable task-specific thunk.
 *
 *   The alternatives are, however, no better. The CDK is large and clumsy,
 *   and things like ncurses libmenu are not worth the storage overhead.
 *
 */
#include <ncurses.h>
#include <panel.h>
#include <stdint.h>
#include <time.h>

#include "nwipe.h"
#include "context.h"
#include "method.h"
#include "prng.h"
#include "options.h"
#include "gui.h"
#include "pass.h"
#include "logging.h"
#include "version.h"


#define NWIPE_GUI_PANE        8

/* Header window: width, height, x coordinate, y coordinate. */
#define NWIPE_GUI_HEADER_W  COLS
#define NWIPE_GUI_HEADER_H  1
#define NWIPE_GUI_HEADER_X  0
#define NWIPE_GUI_HEADER_Y  0

/* Footer window: width, height, x coordinate, y coordinate. */
#define NWIPE_GUI_FOOTER_W  COLS
#define NWIPE_GUI_FOOTER_H  1
#define NWIPE_GUI_FOOTER_X  0
#define NWIPE_GUI_FOOTER_Y  (LINES -1)

/* Options window: width, height, x coorindate, y coordinate. */
#define NWIPE_GUI_OPTIONS_W   44
#define NWIPE_GUI_OPTIONS_H   7
#define NWIPE_GUI_OPTIONS_Y   1
#define NWIPE_GUI_OPTIONS_X   0

/* Options fields, relative to their window. */
#define NWIPE_GUI_OPTIONS_TAB        10
#define NWIPE_GUI_OPTIONS_ENTROPY_Y  1
#define NWIPE_GUI_OPTIONS_ENTROPY_X  1
#define NWIPE_GUI_OPTIONS_PRNG_Y     2
#define NWIPE_GUI_OPTIONS_PRNG_X     1
#define NWIPE_GUI_OPTIONS_METHOD_Y   3
#define NWIPE_GUI_OPTIONS_METHOD_X   1
#define NWIPE_GUI_OPTIONS_VERIFY_Y   4
#define NWIPE_GUI_OPTIONS_VERIFY_X   1
#define NWIPE_GUI_OPTIONS_ROUNDS_Y   5
#define NWIPE_GUI_OPTIONS_ROUNDS_X   1

/* Stats window: width, height, x coordinate, y coordinate. */
#define NWIPE_GUI_STATS_W 36
#define NWIPE_GUI_STATS_H 7
#define NWIPE_GUI_STATS_Y 1
#define NWIPE_GUI_STATS_X 44

/* Stats fields, relative to their window. */
#define NWIPE_GUI_STATS_RUNTIME_Y     1
#define NWIPE_GUI_STATS_RUNTIME_X     1
#define NWIPE_GUI_STATS_ETA_Y         2
#define NWIPE_GUI_STATS_ETA_X         1
#define NWIPE_GUI_STATS_LOAD_Y        3
#define NWIPE_GUI_STATS_LOAD_X        1
#define NWIPE_GUI_STATS_THROUGHPUT_Y  4
#define NWIPE_GUI_STATS_THROUGHPUT_X  1
#define NWIPE_GUI_STATS_ERRORS_Y      5
#define NWIPE_GUI_STATS_ERRORS_X      1
#define NWIPE_GUI_STATS_TAB           16


/* Select window: width, height, x coordinate, y coordinate. */
#define NWIPE_GUI_MAIN_W  COLS
#define NWIPE_GUI_MAIN_H  ( LINES - NWIPE_GUI_MAIN_Y -1 )
#define NWIPE_GUI_MAIN_Y  8
#define NWIPE_GUI_MAIN_X  0

#define SKIP_DEV_PREFIX 5


/* Window pointers. */
WINDOW* footer_window;
WINDOW* header_window;
WINDOW* main_window;
WINDOW* options_window;
WINDOW* stats_window;

PANEL* footer_panel;
PANEL* header_panel;
PANEL* main_panel;
PANEL* options_panel;
PANEL* stats_panel;


/* Options window title. */
const char* options_title = " Options ";

/* Statistics window title. */
const char* stats_title = " Statistics ";

/* Footer labels. */
const char* main_window_footer = "S=Start M=Method P=PRNG V=Verify R=Rounds B=Blanking Space=Select Ctrl-C=Quit";
const char* selection_footer = "J=Down K=Up Space=Select Backspace=Cancel Ctrl-C=Quit";
const char* end_wipe_footer = "B=Blank screen Ctrl-C=Quit";
const char* rounds_footer = "Left=Erase Esc=Cancel Ctrl-C=Quit";


void nwipe_gui_title( WINDOW* w, const char* s )
{
/**
 * Prints the string 's' centered on the first line of the window 'w'.
 *
 */

	/* The number of lines in the window. (Not used.) */
	int wy;
	(void) wy; /* flag wy not used to the compiler, to silence warning */

	/* The number of columns in the window. */
	int wx;

	/* Get the window dimensions. */
	getmaxyx( w, wy, wx );

	/*Calculate available total margin */
	int margin = (wx - strlen( s ));
	if (margin < 0) margin = 0;

	/* Print the title. */
	mvwprintw( w, 0, margin / 2, "%s", s );

} /* nwipe_gui_title */


void nwipe_gui_init( void )
{
/**
 * Initializes the ncurses gui.
 *
 */

	/* Initialize the screen. */
	initscr();

	/* Disable TTY line buffering. */
	cbreak();

	/* Disable TTY echo. */
	noecho();

	/* Enable most special keys. */
	keypad( stdscr, TRUE );

	if( has_colors() )
	{
		/* Initialize color capabilities. */
		start_color();

		if( can_change_color() )
		{
			/* Redefine cyan to gray. */
			init_color( COLOR_CYAN, 128, 128, 128 );
		}

		/* Set white on blue as the emphasis color. */
		init_pair( 1, COLOR_WHITE, COLOR_BLUE );

		/* Set gray (or cyan) on blue as the normal color. */
		init_pair( 2, COLOR_CYAN, COLOR_BLUE );

		/* Set red on blue as the hilite color. */
		init_pair( 3, COLOR_RED, COLOR_BLUE );

		/* Set blue on white as the color for the header and footer windows. */
		init_pair( 4, COLOR_BLUE, COLOR_WHITE );

		/* Set white on green for success messages. */
		init_pair( 5, COLOR_WHITE, COLOR_GREEN );

		/* Set white on green for failure messages. */
		init_pair( 6, COLOR_WHITE, COLOR_RED );

		/* Set black on black for when hiding the display. */
		init_pair( 7, COLOR_BLACK, COLOR_BLACK );

		/* Set the background style. */
		wbkgdset( stdscr, COLOR_PAIR(1) | ' ' );

	}

	/* Clear the screen. */
	wclear( stdscr );


	/* Create the header window. */
	header_window = newwin( NWIPE_GUI_HEADER_H, NWIPE_GUI_HEADER_W, NWIPE_GUI_HEADER_Y, NWIPE_GUI_HEADER_X );
	header_panel = new_panel( header_window );

	if( has_colors() )
	{
		/* Set the background style of the header window. */
		wbkgdset( header_window, COLOR_PAIR(4) | ' ' );
	}

	/* Clear the header window. */
	wclear( header_window );

	/* Print the product banner. */
    nwipe_gui_title( header_window, banner );

	/* Create the footer window. */
	footer_window = newwin( NWIPE_GUI_FOOTER_H, NWIPE_GUI_FOOTER_W, NWIPE_GUI_FOOTER_Y, NWIPE_GUI_FOOTER_X );
	footer_panel = new_panel( footer_window );

	if( has_colors() )
	{
		/* Set the background style of the footer window. */
		wbkgdset( footer_window, COLOR_PAIR(4) | ' ' );
	}

	/* Clear the footer window. */
	wclear( footer_window );

	/* Create the options window. */
	options_window = newwin( NWIPE_GUI_OPTIONS_H, NWIPE_GUI_OPTIONS_W, NWIPE_GUI_OPTIONS_Y, NWIPE_GUI_OPTIONS_X );
	options_panel = new_panel( options_window );

	if( has_colors() )
	{
		/* Set the background style of the options window. */
		wbkgdset( options_window, COLOR_PAIR(1) | ' ' );

		/* Apply the color change to the options window. */
		wattron( options_window, COLOR_PAIR(1) );
	}

	/* Clear the options window. */
	wclear( options_window );

	/* Add a border. */
	box( options_window, 0, 0 );

	/* Create the stats window. */
	stats_window = newwin( NWIPE_GUI_STATS_H, NWIPE_GUI_STATS_W, NWIPE_GUI_STATS_Y, NWIPE_GUI_STATS_X );
	stats_panel = new_panel( stats_window );

	if( has_colors() )
	{
		/* Set the background style of the stats window. */
		wbkgdset( stats_window, COLOR_PAIR(1) | ' ' );

		/* Apply the color change to the stats window. */
		wattron( stats_window, COLOR_PAIR(1) );
	}

	/* Clear the new window. */
	wclear( stats_window );

	/* Add a border. */
	box( stats_window, 0, 0 );

	/* Add a title. */
	nwipe_gui_title( stats_window, stats_title );

	/* Print field labels. */
	mvwprintw( stats_window, NWIPE_GUI_STATS_RUNTIME_Y,    NWIPE_GUI_STATS_RUNTIME_X,    "Runtime:       " );
	mvwprintw( stats_window, NWIPE_GUI_STATS_ETA_Y,        NWIPE_GUI_STATS_ETA_X,        "Remaining:     " );
	mvwprintw( stats_window, NWIPE_GUI_STATS_LOAD_Y,       NWIPE_GUI_STATS_LOAD_X,       "Load Averages: " );
	mvwprintw( stats_window, NWIPE_GUI_STATS_THROUGHPUT_Y, NWIPE_GUI_STATS_THROUGHPUT_X, "Throughput:    " );
	mvwprintw( stats_window, NWIPE_GUI_STATS_ERRORS_Y,     NWIPE_GUI_STATS_ERRORS_X,     "Errors:        " );

	/* Create the main window. */
	main_window = newwin( NWIPE_GUI_MAIN_H, NWIPE_GUI_MAIN_W, NWIPE_GUI_MAIN_Y, NWIPE_GUI_MAIN_X );
	main_panel = new_panel( main_window );

	if( has_colors() )
	{
		/* Set the background style. */
		wbkgdset( main_window, COLOR_PAIR(1) | ' ' );

	        /* Apply the color change. */
	        wattron( main_window, COLOR_PAIR(1) );
	}

	/* Clear the main window. */
	werase( main_window );

	/* Add a border. */
	box( main_window, 0, 0 );

	/* Refresh the screen. */
	wrefresh( stdscr );
	wrefresh( header_window );
	wrefresh( footer_window );
	wrefresh( options_window );
	wrefresh( stats_window );
	wrefresh( main_window );
	
	update_panels();
	doupdate();

	/* Hide the cursor. */
	curs_set( 0 );

} /* nwipe_gui_init */


void nwipe_gui_free( void )
{
/**
 * Releases the ncurses gui.
 *
 */
	/* Free ncurses resources. */
	if( del_panel( footer_panel ) != OK )
   {
      nwipe_log( NWIPE_LOG_ERROR, "Deleting footer panel failed!." );
   }
	if( del_panel( header_panel ) != OK )
   {
      nwipe_log( NWIPE_LOG_ERROR, "Deleting header panel failed!." );
   }
	if( del_panel( main_panel ) != OK )
   {
      nwipe_log( NWIPE_LOG_ERROR, "Deleting main panel failed!." );
   }
	if( del_panel( options_panel  ) != OK )
   {
      nwipe_log( NWIPE_LOG_ERROR, "Deleting options panel failed!." );
   }
	if( del_panel( stats_panel ) != OK )
   {
      nwipe_log( NWIPE_LOG_ERROR, "Deleting stats panel failed!." );
   }
	if( delwin( footer_window ) != OK )
   {
      nwipe_log( NWIPE_LOG_ERROR, "Deleting footer window failed!." );
   }
	if( delwin( header_window ) != OK )
   {
      nwipe_log( NWIPE_LOG_ERROR, "Deleting header window failed!." );
   }
	if( delwin( main_window ) != OK )
   {
      nwipe_log( NWIPE_LOG_ERROR, "Deleting main window failed!." );
   }
	if( delwin( options_window ) != OK )
   {
      nwipe_log( NWIPE_LOG_ERROR, "Deleting options window failed!." );
   }
	if( delwin( stats_window ) != OK )
   {
      nwipe_log( NWIPE_LOG_ERROR, "Deleting stats window failed!." );
   }
	if( endwin() != OK )
   {
      nwipe_log( NWIPE_LOG_ERROR, "Curses endwin() failed !" );
   }

} /* nwipe_gui_free */


void nwipe_gui_select( int count, nwipe_context_t** c )
{
/**
 * The primary user interface.  Allows the user to
 * change options and specify the devices to be wiped.
 *
 * @parameter  count       The number of contexts in the array.
 * @parameter  c           An array of device contexts.
 *
 * @modifies   c[].select  Sets the select flag according to user input.
 * @modifies   options     Sets program options according to to user input.
 *
 */

	extern int terminate_signal;

	/* Widget labels. */
	const char* select_title = " Disks and Partitions ";

	/* The number of lines available in the window. */
	int wlines;

	/* The number of columns available in the window. */
	int wcols;

	/* The number of selection elements that we can show in the window. */
	int slots;

	/* The index of the element that is visible in the first slot. */
	int offset = 0;

	/* The selection focus. */
	int focus = 0;

	/* A generic loop variable. */
	int i;

	/* User input buffer. */
	int keystroke;

	/* The current working line. */
	int yy;

	/* There is one slot per line. */
	getmaxyx( main_window, wlines, wcols );

	/* Less two lines for the box and two lines for padding. */
	slots = wlines - 4;


	do
	{
		/* Clear the main window. */
		werase( main_window );

		/* Update the footer window. */
		werase( footer_window );
		nwipe_gui_title( footer_window, main_window_footer );
		wrefresh( footer_window );

		/* Update the options window. */
		nwipe_gui_options();

		/* Initialize the line offset. */
		yy = 2;

		for( i = 0; i < slots && i < count ; i++ )
		{

			/* Move to the next line. */
			mvwprintw( main_window, yy++, 1, " " );

			if( i + offset == focus )
			{
				if( c[focus]->select == NWIPE_SELECT_TRUE || c[focus]->select == NWIPE_SELECT_FALSE )
				{
					/* Print the 'enabled' cursor. */
					waddch( main_window, ACS_RARROW );
				}

				else
				{
					/* Print the 'disabled' cursor. */
					waddch( main_window, ACS_DIAMOND );
				}
			}

			else
			{
				/* Print whitespace. */
				waddch( main_window, ' '  );
			}

			switch( c[i+offset]->select )
			{
				case NWIPE_SELECT_TRUE:

					wprintw( main_window, " [wipe] %i. %s - %s, S/N:%s, (%s)", (i + offset + 1),
										c[i+offset]->device_name+SKIP_DEV_PREFIX,
										c[i+offset]->label,
										c[i+offset]->serial_no,
										c[i+offset]->device_size_text );
					break;

				case NWIPE_SELECT_FALSE:
					/* Print an element that is not selected. */
					wprintw( main_window, " [    ] %i. %s - %s, S/N:%s, (%s)", (i + offset +1),
										c[i+offset]->device_name+SKIP_DEV_PREFIX,
										c[i+offset]->label,
										c[i+offset]->serial_no,
										c[i+offset]->device_size_text );
					break;

				case NWIPE_SELECT_TRUE_PARENT:

					/* This element will be wiped when its parent is wiped. */
					wprintw( main_window, " [****] %i. %s - %s, S/N:%s, (%s)", (i + offset +1),
										c[i+offset]->device_name+SKIP_DEV_PREFIX,
										c[i+offset]->label,
										c[i+offset]->serial_no,
										c[i+offset]->device_size_text );
					break;

				case NWIPE_SELECT_FALSE_CHILD:

					/* We can't wipe this element because it has a child that is being wiped. */
					wprintw( main_window, " [----] %i. %s - %s, S/N:%s, (%s)", (i + offset +1),
										c[i+offset]->device_name+SKIP_DEV_PREFIX,
										c[i+offset]->label,
										c[i+offset]->serial_no,
										c[i+offset]->device_size_text );
					break;

				case NWIPE_SELECT_DISABLED:

					/* We don't know how to wipe this device. (Iomega Zip drives.) */
					wprintw( main_window, " [????] %s", "Unrecognized Device" );
					break;

				default:

					/* TODO: Handle the sanity error. */
					break;


			} /* switch select */

		} /* for */

		if( offset > 0 )
		{
			mvwprintw( main_window, 1, wcols -8, " More " );
			waddch( main_window, ACS_UARROW );
		}

		if( count - offset > slots )
		{
			mvwprintw( main_window, wlines -2, wcols -8, " More " );
			waddch( main_window, ACS_DARROW );
		}

		/* Draw a border around the menu window. */
		box( main_window, 0, 0 );

		/* Print a title. */
		nwipe_gui_title( main_window, select_title );

		/* Refresh the window. */
		wrefresh( main_window );
      
		/* Wait 250ms for input from getch, if nothing getch will then continue,
		 * This is necessary so that the while loop can be exited by the
		 * terminate_signal e.g.. the user pressing control-c to exit.
		 * Do not change this value, a higher value means the keys become
		 * sluggish, any slower and more time is spent unnecessarily looping
		 * which wastes CPU cycles.
		 */
		timeout(250); /* block getch() for 250ms */
		keystroke = getch(); /* Get user input. */
		timeout(-1); /* Switch back to blocking mode */

		switch( keystroke )
		{
			case KEY_DOWN:
			case 'j':
			case 'J':

				/* Increment the focus. */
				focus += 1;

				if( focus >= count )
				{
					/* The focus is already at the last element. */
					focus = count -1;
					break;
				}

				if( focus - offset >= slots )
				{
					/* The next element is offscreen. Scroll down. */
					offset += 1;
					break;
				}

				break;

			case KEY_UP:
			case 'k':
			case 'K':

				/* Decrement the focus. */
				focus -= 1;

				if( focus < 0 )
				{
					/* The focus is already at the last element. */
					focus = 0;
					break;
				}

				if( focus < offset )
				{
					/* The next element is offscreen. Scroll up. */
					offset -= 1;
					break;
				}

				break;

			case KEY_ENTER:
			case 10:
			case ' ':

				/* TODO: This block should be made into a function. */

				if( c[focus]->select == NWIPE_SELECT_TRUE )
				{
					/* Reverse the selection of this element. */
					c[focus]->select = NWIPE_SELECT_FALSE;

					if( c[focus]->device_part == 0 )
					{
						/* Sub-deselect all partitions and slices within this disk. */
						for( i = 0 ; i < count ; i++ )
						{
							if
							(
								   c[i]->device_type   == c[focus]->device_type
								&& c[i]->device_host   == c[focus]->device_host
								&& c[i]->device_bus    == c[focus]->device_bus
								&& c[i]->device_target == c[focus]->device_target
								&& c[i]->device_lun    == c[focus]->device_lun
								&& c[i]->device_part   > 0
							)
							{
								c[i]->select = NWIPE_SELECT_FALSE;
							}

						} /* for all contexts */

					} /* if sub-deselect */

					else
					{
						/* The number of selected partitions or slices within this disk. */
						int j = 0;

						for( i = 0 ; i < count ; i++ )
						{
							if
							(
								   c[i]->device_type   == c[focus]->device_type
								&& c[i]->device_host   == c[focus]->device_host
								&& c[i]->device_bus    == c[focus]->device_bus
								&& c[i]->device_target == c[focus]->device_target
								&& c[i]->device_lun    == c[focus]->device_lun
								&& c[i]->device_part   > 0
								&& c[i]->select        == NWIPE_SELECT_TRUE
							)
							{
								/* Increment the counter. */
								j += 1;
							}

						} /* for all contexts */

						if( j == 0 )
						{
							/* Find the parent disk of this partition or slice. */
							for( i = 0 ; i < count ; i++ )
							{
								if
								(
									   c[i]->device_type   == c[focus]->device_type
								   && c[i]->device_host   == c[focus]->device_host
									&& c[i]->device_bus    == c[focus]->device_bus
									&& c[i]->device_target == c[focus]->device_target
									&& c[i]->device_lun    == c[focus]->device_lun
									&& c[i]->device_part   == 0
								)
								{
									/* Enable the disk element. */
									c[i]->select = NWIPE_SELECT_FALSE;
								}

							} /* for all contexts */

						} /* if */

					} /* else super-enable */

					break;

				} /* if NWIPE_SELECT_TRUE */

				if( c[focus]->select == NWIPE_SELECT_FALSE )
				{
					/* Reverse the selection. */
					c[focus]->select = NWIPE_SELECT_TRUE;

					if( c[focus]->device_part == 0 )
					{
						/* Sub-select all partitions and slices within this disk. */
						for( i = 0 ; i < count ; i++ )
						{
							if
							(
								   c[i]->device_type   == c[focus]->device_type
								&& c[i]->device_host   == c[focus]->device_host
								&& c[i]->device_bus    == c[focus]->device_bus
								&& c[i]->device_target == c[focus]->device_target
								&& c[i]->device_lun    == c[focus]->device_lun
								&& c[i]->device_part   > 0
							)
							{
								c[i]->select = NWIPE_SELECT_TRUE_PARENT;
							}

						} /* for */

					} /* if sub-select */

					else
					{
						/* ASSERT: ( c[focus]->device_part > 0 ) */

						/* Super-deselect the disk that contains this device. */
						for( i = 0 ; i < count ; i++ )
						{
							if
							(
								   c[i]->device_type   == c[focus]->device_type
								&& c[i]->device_host   == c[focus]->device_host
								&& c[i]->device_bus    == c[focus]->device_bus
								&& c[i]->device_target == c[focus]->device_target
								&& c[i]->device_lun    == c[focus]->device_lun
								&& c[i]->device_part   == 0
							)
							{
								c[i]->select = NWIPE_SELECT_FALSE_CHILD;
							}
						}

					} /* else super-deselect */

					break;

				} /* if NWIPE_SELECT_FALSE */

				/* TODO: Explain to the user why they can't change this. */
				break;

			case 'm':
			case 'M':
			
				/*  Run the method dialog. */
				nwipe_gui_method();
				break;

			case 'p':
			case 'P':

				/* Run the PRNG dialog. */
				nwipe_gui_prng();
				break;

			case 'r':
			case 'R':

				/* Run the rounds dialog. */
				nwipe_gui_rounds();
				break;

			case 'v':
			case 'V':

				/* Run the option dialog. */
				nwipe_gui_verify();
				break;

			case 'b':
			case 'B':

				/* Run the noblank dialog. */
				nwipe_gui_noblank();
				break;
            

		} /* keystroke switch */

	} while( keystroke != 'S' && terminate_signal !=1);

	/* Clear the main window. */
	werase( main_window );

	/* Refresh the main window. */
	wrefresh( main_window );

	/* Clear the footer. */
	werase( footer_window );

	/* Refresh the footer window. */
	wrefresh( footer_window );

} /* nwipe_gui_select */



void nwipe_gui_options( void )
{
/**
 * Updates the options window.
 *
 * @modifies  options_window
 *
 */

	/* Erase the window. */
	werase( options_window );

	mvwprintw( options_window, NWIPE_GUI_OPTIONS_ENTROPY_Y, NWIPE_GUI_OPTIONS_ENTROPY_X, \
	  "Entropy: Linux Kernel (urandom)" );

	mvwprintw( options_window, NWIPE_GUI_OPTIONS_PRNG_Y,    NWIPE_GUI_OPTIONS_PRNG_X, \
	  "PRNG:    %s", nwipe_options.prng->label );

	mvwprintw( options_window, NWIPE_GUI_OPTIONS_METHOD_Y,  NWIPE_GUI_OPTIONS_METHOD_X, \
	  "Method:  %s", nwipe_method_label( nwipe_options.method) );

	mvwprintw( options_window, NWIPE_GUI_OPTIONS_VERIFY_Y,  NWIPE_GUI_OPTIONS_VERIFY_X,  "Verify:  " );

	switch( nwipe_options.verify )
	{
		case NWIPE_VERIFY_NONE:
			wprintw( options_window, "Off" );
			break;

		case NWIPE_VERIFY_LAST:
			wprintw( options_window, "Last Pass" );
			break;

		case NWIPE_VERIFY_ALL:
			wprintw( options_window, "All Passes" );
			break;

		default:
			wprintw( options_window, "Unknown %i", nwipe_options.verify );
			
	} /* switch verify */

	mvwprintw( options_window, NWIPE_GUI_OPTIONS_ROUNDS_Y,  NWIPE_GUI_OPTIONS_ROUNDS_X,  "Rounds:  " );
	if ( nwipe_options.noblank )
	{
		wprintw( options_window, "%i (no final blanking pass)", nwipe_options.rounds);
	} else
	{
		wprintw( options_window, "%i (plus blanking pass)", nwipe_options.rounds);
	}

	/* Add a border. */
	box( options_window, 0, 0 );

	/* Add a title. */
	nwipe_gui_title( options_window, options_title );

	/* Refresh the window. */
	wrefresh( options_window );

} /* nwipe_gui_options */



void nwipe_gui_rounds( void )
{
/**
 * Allows the user to change the rounds option.
 *
 * @modifies  nwipe_options.rounds
 * @modifies  main_window
 *
 */

	/* Set the initial focus. */
	int focus = nwipe_options.rounds;

	/* The first tabstop. */
	const int tab1 = 2;

	/* The current working row. */
	int yy;

	/* Input buffer. */
	int keystroke;

	extern int terminate_signal;

	/* Update the footer window. */
	werase( footer_window );
	nwipe_gui_title( footer_window, rounds_footer );
	wrefresh( footer_window );

	do
	{
		/* Erase the main window. */
		werase( main_window );

		/* Add a border. */
		box( main_window, 0, 0 );

		/* Add a title. */
		nwipe_gui_title( main_window, " Rounds " );

		/* Initialize the working row. */
		yy = 4;

		/*                               0         1         2         3         4         5         6         7   */
		mvwprintw( main_window, yy++, tab1, "This is the number of times to run the wipe method on each device."  );
		mvwprintw( main_window, yy++, tab1, ""  );

		if( focus > 0 )
		{	
			/* Print the syslinux configuration hint. */
			mvwprintw( main_window, yy++, tab1, "syslinux.cfg:  nuke=\"nwipe --rounds %i\"", focus );

			/* Print this line last so that the cursor is in the right place. */
			mvwprintw( main_window, 2, tab1, "> %i", focus );
		}

		else
		{
			mvwprintw( main_window, yy++, tab1, "The number of rounds must be a non-negative integer." );

			/* Print this line last so that the cursor is in the right place. */
			mvwprintw( main_window, 2, tab1, "> " );
		}

		/* Reveal the cursor. */
		curs_set( 1 );

		/* Refresh the window. */
		wrefresh( main_window );

		/* Wait 250ms for input from getch, if nothing getch will then continue,
		 * This is necessary so that the while loop can be exited by the
		 * terminate_signal e.g.. the user pressing control-c to exit.
		 * Do not change this value, a higher value means the keys become
		 * sluggish, any slower and more time is spent unnecessarily looping
		 * which wastes CPU cycles.
		 */
		timeout(250);        /* block getch() for 250ms */
		keystroke = getch(); /* Get a keystroke. */
		timeout(-1);         /* Switch back to blocking mode */

		switch( keystroke )
		{
			case '0':
			case '1':
			case '2':
			case '3':
			case '4':
			case '5':
			case '6':
			case '7':
			case '8':
			case '9':

				if( focus < 100000000 )
				{
					/* Left shift, base ten. */
					focus *= 10;

					/* This assumes ASCII input, where the zero character is 0x30. */
					focus += keystroke - 48;
				}

				break;

			/* Escape key. */
			case 27:
				return;

			case KEY_BACKSPACE:
			case KEY_LEFT:
			case 127:

				/* Right shift, base ten. */
				focus /= 10;

				break;

		} /* switch keystroke */

		/* Hide the cursor. */
		curs_set( 0 );

	} while( keystroke != 10 && terminate_signal !=1 );

	if( focus > 0 )
	{
		/* Set the number of rounds. */
		nwipe_options.rounds = focus;
	}

} /* nwipe_guid_rounds */



void nwipe_gui_prng( void )
{
/**
 * Allows the user to change the PRNG.
 *
 * @modifies  nwipe_options.prng
 * @modifies  main_window
 *
 */

	extern nwipe_prng_t nwipe_twister;
	extern nwipe_prng_t nwipe_isaac;
	extern int terminate_signal;

	/* The number of implemented PRNGs. */
	const int count = 2;

	/* The first tabstop. */
	const int tab1 = 2;

	/* The second tabstop. */
	const int tab2 = 30;

	/* Set the initial focus. */
	int focus = 0;

	/* The current working row. */
	int yy;

	/* Input buffer. */
	int keystroke;

	/* Update the footer window. */
	werase( footer_window );
	nwipe_gui_title( footer_window, selection_footer );
	wrefresh( footer_window );

	if( nwipe_options.prng == &nwipe_twister ) { focus = 0; }
	if( nwipe_options.prng == &nwipe_isaac   ) { focus = 1; }


	do
	{
		/* Clear the main window. */
		werase( main_window );

		/* Initialize the working row. */
		yy = 2;

		/* Print the options. */
		mvwprintw( main_window, yy++, tab1, ""                  );
		mvwprintw( main_window, yy++, tab1, ""                  );
		mvwprintw( main_window, yy++, tab1, "  %s", nwipe_twister.label );
		mvwprintw( main_window, yy++, tab1, "  %s", nwipe_isaac.label   );
		mvwprintw( main_window, yy++, tab1, ""                  );

		/* Print the cursor. */
		mvwaddch( main_window, 4 + focus, tab1, ACS_RARROW );


		switch( focus )
		{
			case 0:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg:  nuke=\"nwipe --prng twister\"" );

				/*                                 0         1         2         3         4         5         6         7        8  */
				mvwprintw( main_window, yy++, tab1, "The Mersenne Twister, by Makoto Matsumoto and Takuji Nishimura, is a        " );
				mvwprintw( main_window, yy++, tab1, "generalized feedback shift register PRNG that is uniform and                " );
				mvwprintw( main_window, yy++, tab1, "equidistributed in 623-dimensions with a proven period of 2^19937-1.        " );
				mvwprintw( main_window, yy++, tab1, "                                                                            " );
				mvwprintw( main_window, yy++, tab1, "This implementation passes the Marsaglia Diehard test suite.                " );
				mvwprintw( main_window, yy++, tab1, "                                                                            " );
				break;

			case 1:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg:  nuke=\"nwipe --prng isaac\"" );

				/*                                 0         1         2         3         4         5         6         7        8  */
				mvwprintw( main_window, yy++, tab1, "ISAAC, by Bob Jenkins, is a PRNG derived from RC4 with a minimum period of  " );
				mvwprintw( main_window, yy++, tab1, "2^40 and an expected period of 2^8295.  It is difficult to recover the      " );
				mvwprintw( main_window, yy++, tab1, "initial PRNG state by cryptanalysis of the ISAAC stream.                    " );
				mvwprintw( main_window, yy++, tab1, "                                                                            " );
				break;

		} /* switch */

		/* Add a border. */
		box( main_window, 0, 0 );

		/* Add a title. */
		nwipe_gui_title( main_window, " Pseudo Random Number Generator " );

		/* Refresh the window. */
		wrefresh( main_window );

		/* Wait 250ms for input from getch, if nothing getch will then continue,
		 * This is necessary so that the while loop can be exited by the
		 * terminate_signal e.g.. the user pressing control-c to exit.
		 * Do not change this value, a higher value means the keys become
		 * sluggish, any slower and more time is spent unnecessarily looping
		 * which wastes CPU cycles.
		 */
		timeout(250);        /* block getch() for 250ms */
		keystroke = getch(); /* Get a keystroke. */
		timeout(-1);         /* Switch back to blocking mode */

		switch( keystroke )
		{
			case KEY_DOWN:
			case 'j':
			case 'J':

				if( focus < count -1 ) { focus += 1; } 
				break;

			case KEY_UP:
			case 'k':
			case 'K':

				if( focus > 0 ) { focus -= 1; } 
				break;

			case KEY_ENTER:
			case ' ':
			case 10:

				if( focus == 0 ) { nwipe_options.prng = &nwipe_twister; }
				if( focus == 1 ) { nwipe_options.prng = &nwipe_isaac;   }
				return;

			case KEY_BACKSPACE:
			case KEY_BREAK:

				return;

		} /* switch */
		
	}
	while( terminate_signal != 1 );

} /* nwipe_gui_prng */



void nwipe_gui_verify( void )
{
/**
 * Allows the user to change the verification option.
 *
 * @modifies  nwipe_options.verify
 * @modifies  main_window
 *
 */

   extern int terminate_signal;

	/* The number of definitions in the nwipe_verify_t enumeration. */
	const int count = 3;

	/* The first tabstop. */
	const int tab1 = 2;

	/* The second tabstop. */
	const int tab2 = 30;

	/* Set the initial focus. */
	int focus = nwipe_options.verify;

	/* The current working row. */
	int yy;

	/* Input buffer. */
	int keystroke;

	/* Update the footer window. */
	werase( footer_window );
	nwipe_gui_title( footer_window, selection_footer );
	wrefresh( footer_window );

	do
	{
		/* Clear the main window. */
		werase( main_window );

		/* Initialize the working row. */
		yy = 2;

		/* Print the options. */
		mvwprintw( main_window, yy++, tab1, "  Verification Off  "  );
		mvwprintw( main_window, yy++, tab1, "  Verify Last Pass  " );
		mvwprintw( main_window, yy++, tab1, "  Verify All Passes " );
		mvwprintw( main_window, yy++, tab1, "                    " );

		/* Print the cursor. */
		mvwaddch( main_window, 2 + focus, tab1, ACS_RARROW );


		switch( focus )
		{
			case 0:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg:  nuke=\"nwipe --verify off\"" );

				/*                                 0         1         2         3         4         5         6         7        8  */
				mvwprintw( main_window, yy++, tab1, "Do not verify passes. The wipe will be a write-only operation.              " );
				mvwprintw( main_window, yy++, tab1, "                                                                            " );
				break;

			case 1:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg:  nuke=\"nwipe --verify last\"" );

				/*                                 0         1         2         3         4         5         6         7        8  */
				mvwprintw( main_window, yy++, tab1, "Check whether the device is actually empty after the last pass fills the    " );
				mvwprintw( main_window, yy++, tab1, "device with zeros.                                                          " );
				break;

			case 2:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg:  nuke=\"nwipe --verify all\"" );

				/*                                 0         1         2         3         4         5         6         7        8  */
				mvwprintw( main_window, yy++, tab1, "After every pass, read back the pattern and check whether it is correct.    " );
				mvwprintw( main_window, yy++, tab1, "                                                                            " );
				mvwprintw( main_window, yy++, tab1, "This program writes the entire length of the device before it reads back    " );
				mvwprintw( main_window, yy++, tab1, "for verification, even for random pattern passes, to better ensure that     " );
				mvwprintw( main_window, yy++, tab1, "hardware caches are actually flushed.                                       " );
				break;

		} /* switch */

		/* Add a border. */
		box( main_window, 0, 0 );

		/* Add a title. */
		nwipe_gui_title( main_window, " Verification Mode " );

		/* Refresh the window. */
		wrefresh( main_window );

		/* Wait 250ms for input from getch, if nothing getch will then continue,
		 * This is necessary so that the while loop can be exited by the
		 * terminate_signal e.g.. the user pressing control-c to exit.
		 * Do not change this value, a higher value means the keys become
		 * sluggish, any slower and more time is spent unnecessarily looping
		 * which wastes CPU cycles.
		 */
		timeout(250);        /* block getch() for 250ms */
		keystroke = getch(); /* Get a keystroke. */
		timeout(-1);         /* Switch back to blocking mode */

		switch( keystroke )
		{
			case KEY_DOWN:
			case 'j':
			case 'J':

				if( focus < count -1 ) { focus += 1; } 
				break;

			case KEY_UP:
			case 'k':
			case 'K':

				if( focus > 0 ) { focus -= 1; } 
				break;

			case KEY_ENTER:
			case ' ':
			case 10:

				if( focus >= 0 && focus < count ) { nwipe_options.verify = focus; }
				if( nwipe_options.verify != NWIPE_VERIFY_NONE ) { nwipe_options.noblank = 0; }
				return;

			case KEY_BACKSPACE:
			case KEY_BREAK:

				return;

		} /* switch */
		
	}
	while( terminate_signal != 1 );

} /* nwipe_gui_verify */


void nwipe_gui_noblank( void )
{
/**
 * Allows the user to change the verification option.
 *
 * @modifies  nwipe_options.noblank
 * @modifies  main_window
 *
 */

   extern int terminate_signal;

	/* The number of options available. */
	const int count = 2;

	/* The first tabstop. */
	const int tab1 = 2;

	/* The second tabstop. */
	const int tab2 = 40;

	/* Set the initial focus. */
	int focus = nwipe_options.noblank;

	/* The current working row. */
	int yy;

	/* Input buffer. */
	int keystroke;

	/* Update the footer window. */
	werase( footer_window );
	nwipe_gui_title( footer_window, selection_footer );
	wrefresh( footer_window );

	do	
	{
		/* Clear the main window. */
		werase( main_window );

		/* Initialize the working row. */
		yy = 2;

		/* Print the options. */
		mvwprintw( main_window, yy++, tab1, "  Perform a final blanking pass       " );
		mvwprintw( main_window, yy++, tab1, "  Do not perform final blanking pass  " );
		mvwprintw( main_window, yy++, tab1, "                                      " );

		/* Print the cursor. */
		mvwaddch( main_window, 2 + focus, tab1, ACS_RARROW );


		switch( focus )
		{
			case 0:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg:  nuke=\"nwipe\"" );

				/*                                 0         1         2         3         4         5         6         7        8  */
				mvwprintw( main_window, yy++, tab1, "Perform a final blanking pass after the wipe, leaving disk with only zeros. " );
				mvwprintw( main_window, yy++, tab1, "Note that the RCMP TSSIT OPS-II method never blanks the device regardless   " );
				mvwprintw( main_window, yy++, tab1, "of this setting.                                                            " );
				mvwprintw( main_window, yy++, tab1, "                                                                            " );
				break;

			case 1:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg:  nuke=\"nwipe --noblank\"" );

				/*                                 0         1         2         3         4         5         6         7        8  */
				mvwprintw( main_window, yy++, tab1, "Do not perform a final blanking pass. Leave data as per final wiping pass.  " );
				mvwprintw( main_window, yy++, tab1, "Note that the RCMP TSSIT OPS-II method never blanks the device regardless   " );
				mvwprintw( main_window, yy++, tab1, "of this setting.                                                            " );
				mvwprintw( main_window, yy++, tab1, "                                                                            " );
				break;

		} /* switch */

		/* Add a border. */
		box( main_window, 0, 0 );

		/* Add a title. */
		nwipe_gui_title( main_window, " Final Blanking Pass " );

		/* Refresh the window. */
		wrefresh( main_window );

		/* Wait 250ms for input from getch, if nothing getch will then continue,
		 * This is necessary so that the while loop can be exited by the
		 * terminate_signal e.g.. the user pressing control-c to exit.
		 * Do not change this value, a higher value means the keys become
		 * sluggish, any slower and more time is spent unnecessarily looping
		 * which wastes CPU cycles.
		 */
		timeout(250);        /* block getch() for 250ms */
		keystroke = getch(); /* Get a keystroke. */
		timeout(-1);         /* Switch back to blocking mode */

		switch( keystroke )
		{
			case KEY_DOWN:
			case 'j':
			case 'J':

				if( focus < count -1 ) { focus += 1; } 
				break;

			case KEY_UP:
			case 'k':
			case 'K':

				if( focus > 0 ) { focus -= 1; } 
				break;

			case KEY_ENTER:
			case ' ':
			case 10:

				if( focus >= 0 && focus < count ){ nwipe_options.noblank = focus; }
				if ( nwipe_options.noblank ) { nwipe_options.verify = NWIPE_VERIFY_NONE; }
				return;

			case KEY_BACKSPACE:
			case KEY_BREAK:

				return;

		} /* switch */
		
	}

	while( terminate_signal != 1 );
} /* nwipe_gui_noblank */


void nwipe_gui_method( void )
{
/**
 * Allows the user to change the wipe method.
 *
 * @modifies  nwipe_options.method
 * @modifies  main_window
 *
 */

   extern int terminate_signal;

	/* The number of implemented methods. */
	const int count = 8;

	/* The first tabstop. */
	const int tab1 = 2;

	/* The second tabstop. */
	const int tab2 = 30;

	/* The currently selected method. */
	int focus = 0;

	/* The current working row. */
	int yy;

	/* Input buffer. */
	int keystroke;

	/* Update the footer window. */
	werase( footer_window );
	nwipe_gui_title( footer_window, selection_footer );
	wrefresh( footer_window );

	if( nwipe_options.method == &nwipe_zero       ) { focus = 0; }
        if( nwipe_options.method == &nwipe_ops2       ) { focus = 1; }
        if( nwipe_options.method == &nwipe_dodshort   ) { focus = 2; }
        if( nwipe_options.method == &nwipe_dod522022m ) { focus = 3; }
        if( nwipe_options.method == &nwipe_gutmann    ) { focus = 4; }
        if( nwipe_options.method == &nwipe_random     ) { focus = 5; }
        if( nwipe_options.method == &nwipe_verify     ) { focus = 6; }
        if( nwipe_options.method == &nwipe_is5enh     ) { focus = 7; }


	do
	{
		/* Clear the main window. */
		werase( main_window );

		/* Initialize the working row. */
		yy = 2;

		/* Print the options. */
		mvwprintw( main_window, yy++, tab1, "  %s", nwipe_method_label( &nwipe_zero       ) );
                mvwprintw( main_window, yy++, tab1, "  %s", nwipe_method_label( &nwipe_ops2       ) );
                mvwprintw( main_window, yy++, tab1, "  %s", nwipe_method_label( &nwipe_dodshort   ) );
                mvwprintw( main_window, yy++, tab1, "  %s", nwipe_method_label( &nwipe_dod522022m ) );
                mvwprintw( main_window, yy++, tab1, "  %s", nwipe_method_label( &nwipe_gutmann    ) );
                mvwprintw( main_window, yy++, tab1, "  %s", nwipe_method_label( &nwipe_random     ) );
                mvwprintw( main_window, yy++, tab1, "  %s", nwipe_method_label( &nwipe_verify     ) );
                mvwprintw( main_window, yy++, tab1, "  %s", nwipe_method_label( &nwipe_is5enh     ) );
                mvwprintw( main_window, yy++, tab1, "                                             " );

		/* Print the cursor. */
		mvwaddch( main_window, 2 + focus, tab1, ACS_RARROW );

		switch( focus )
		{
			case 0:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg: nuke=\"nwipe --method zero\"" );
				mvwprintw( main_window, 3, tab2, "Security Level: Low (1 pass)" );

				/*                                 0         1         2         3         4         5         6         7         8  */
				mvwprintw( main_window, yy++, tab1, "This method fills the device with zeros. Note that the rounds option does    " );
				mvwprintw( main_window, yy++, tab1, "not apply to this method. This method always runs one round.                 " );
				mvwprintw( main_window, yy++, tab1, "                                                                             " );
				mvwprintw( main_window, yy++, tab1, "Use this method to blank disks before internal redeployment, or before       " );
				mvwprintw( main_window, yy++, tab1, "reinstalling Microsoft Windows to remove the data areas that the format      " );
				mvwprintw( main_window, yy++, tab1, "utility preserves.                                                    " );
				break;

			case 1:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg: nuke=\"nwipe --method ops2\"" );
				mvwprintw( main_window, 3, tab2, "Security Level: Medium (8 passes)" );

				/*                                 0         1         2         3         4         5         6         7         8  */
				mvwprintw( main_window, yy++, tab1, "The Royal Canadian Mounted Police Technical Security Standard for            " );
				mvwprintw( main_window, yy++, tab1, "Information Technology, Appendix OPS-II: Media Sanitization.                 " );
				mvwprintw( main_window, yy++, tab1, "                                                                             " );
				mvwprintw( main_window, yy++, tab1, "This implementation, with regards to paragraph 2 section A of the standard,  " );
				mvwprintw( main_window, yy++, tab1, "uses a pattern that is one random byte and that is changed each round.       " );
				break;

			case 2:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg: nuke=\"nwipe --method dodshort\"" );
				mvwprintw( main_window, 3, tab2, "Security Level: Medium (3 passes)" );

				/*                                 0         1         2         3         4         5         6         7         8  */
				mvwprintw( main_window, yy++, tab1, "The American Department of Defense 5220.22-M short wipe.                     " );
				mvwprintw( main_window, yy++, tab1, "This method is composed of passes 1, 2 & 7 from the standard wipe.           " );
				break;

			case 3:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg: nuke=\"nwipe --method dod522022m\"" );
				mvwprintw( main_window, 3, tab2, "Security Level: Medium (7 passes)" );

				/*                                 0         1         2         3         4         5         6         7         8  */
				mvwprintw( main_window, yy++, tab1, "The American Department of Defense 5220.22-M standard wipe.                  " );
				mvwprintw( main_window, yy++, tab1, "This implementation uses the same algorithm as the Heidi Eraser product.     " );
				break;

			case 4:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg: nuke=\"nwipe --method gutmann\"" );
				mvwprintw( main_window, 3, tab2, "Security Level: High (35 passes)" );

				/*                                 0         1         2         3         4         5         6         7         8  */
				mvwprintw( main_window, yy++, tab1, "This is the method described by Peter Gutmann in the paper entitled          " );
				mvwprintw( main_window, yy++, tab1, "\"Secure Deletion of Data from Magnetic and Solid-State Memory\".            " );
				break;

			case 5:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg: nuke=\"nwipe --method random\"" );
				mvwprintw( main_window, 3, tab2, "Security Level: Depends on Rounds" );

				/*                                 0         1         2         3         4         5         6         7         8  */
				mvwprintw( main_window, yy++, tab1, "This method fills the device with a stream from the PRNG. It is probably the " );
				mvwprintw( main_window, yy++, tab1, "best method to use on modern hard disk drives because encoding schemes vary. " );
				mvwprintw( main_window, yy++, tab1, "                                                                             " );
				mvwprintw( main_window, yy++, tab1, "This method has a medium security level with 4 rounds, and a high security   " );
				mvwprintw( main_window, yy++, tab1, "level with 8 rounds.                                                         " );
				break;
			
			case 6:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg: nuke=\"nwipe --method verify\"" );
				mvwprintw( main_window, 3, tab2, "Security Level: None" );

				/*                                 0         1         2         3         4         5         6         7         8  */
				mvwprintw( main_window, yy++, tab1, "This method only reads the device and checks that it is all zero.            " );

				break;

			case 7:

				mvwprintw( main_window, 2, tab2, "syslinux.cfg: nuke=\"nwipe --method is5enh\"" );
				mvwprintw( main_window, 3, tab2, "Security Level: Medium (3 passes)" );

				/*                                 0         1         2         3         4         5         6         7         8  */
				mvwprintw( main_window, yy++, tab1, "HMG IA/IS 5 (Infosec Standard 5): Secure Sanitisation of Protectively Marked " );
				mvwprintw( main_window, yy++, tab1, "Information or Sensitive Information                                         " );
				mvwprintw( main_window, yy++, tab1, "                                                                             " );
				mvwprintw( main_window, yy++, tab1, "This method fills the device with 0s, then with 1s, then with a PRNG stream, " );
				mvwprintw( main_window, yy++, tab1, "then reads the device to verify the PRNG stream was successfully written.    " );
				break;

		} /* switch */

		/* Add a border. */
		box( main_window, 0, 0 );

		/* Add a title. */
		nwipe_gui_title( main_window, " Wipe Method " );

		/* Refresh the window. */
		wrefresh( main_window );

		/* Wait 250ms for input from getch, if nothing getch will then continue,
		 * This is necessary so that the while loop can be exited by the
		 * terminate_signal e.g.. the user pressing control-c to exit.
		 * Do not change this value, a higher value means the keys become
		 * sluggish, any slower and more time is spent unnecessarily looping
		 * which wastes CPU cycles.
		 */
		timeout(250);        /* block getch() for 250ms */
		keystroke = getch(); /* Get a keystroke. */
		timeout(-1);         /* Switch back to blocking mode */

		switch( keystroke )
		{
			case KEY_DOWN:
			case 'j':
			case 'J':

				if( focus < count -1 ) { focus += 1; } 
				break;

			case KEY_UP:
			case 'k':
			case 'K':

				if( focus > 0 ) { focus -= 1; } 
				break;

			case KEY_BACKSPACE:
			case KEY_BREAK:

				return;

		} /* switch */

	} while( keystroke != KEY_ENTER && keystroke != ' ' && keystroke != 10 && terminate_signal != 1 );


        switch( focus )
        {
                case 0:
                        nwipe_options.method = &nwipe_zero;
                        break;

                case 1:
                        nwipe_options.method = &nwipe_ops2;
                        break;

                case 2:
                        nwipe_options.method = &nwipe_dodshort;
                        break;

                case 3:
                        nwipe_options.method = &nwipe_dod522022m;
                        break;

                case 4:
                        nwipe_options.method = &nwipe_gutmann;
                        break;

                case 5:
                        nwipe_options.method = &nwipe_random;
                        break;
                
                case 6:
                        nwipe_options.method = &nwipe_verify;
                        break;

                case 7:
                        nwipe_options.method = &nwipe_is5enh;
                        break;
        }


} /* nwipe_gui_method */


void nwipe_gui_load( void )
{
/**
 * Prints the system load average to the statistics window.
 *
 * @modifies stat_window      Prints the system load average to the statistics window.
 *
 */

	/* A file handle for the stat file. */
	FILE* nwipe_fp;

	/* The one, five, and fifteen minute load averages. */
	float load_01;
	float load_05;
	float load_15;


	/* Open the loadavg file. */
	nwipe_fp = fopen( NWIPE_KNOB_LOADAVG, "r" );

	/* Print the label. */
	mvwprintw( stats_window, NWIPE_GUI_STATS_LOAD_Y, NWIPE_GUI_STATS_LOAD_X, "Load Averages:" );

	if( nwipe_fp )
	{
		/* The load averages are the first three numbers in the file. */
		if( 3 == fscanf( nwipe_fp, "%f %f %f", &load_01, &load_05, &load_15 ) )
		{
			/* Print the load average. */
			mvwprintw( stats_window, NWIPE_GUI_STATS_LOAD_Y, NWIPE_GUI_STATS_TAB,
			  "%04.2f %04.2f %04.2f", load_01, load_05, load_15 );
		}

		else
		{
			/* Print an error. */
			mvwprintw( stats_window, NWIPE_GUI_STATS_LOAD_Y, NWIPE_GUI_STATS_TAB, "(fscanf error %i)", errno );
		}

		/* Close the loadavg file. */
		fclose( nwipe_fp );
	}

	else
	{
		mvwprintw( stats_window, NWIPE_GUI_STATS_LOAD_Y, NWIPE_GUI_STATS_TAB, "(fopen error %i)", errno );
	}

} /* nwipe_gui_load */



void *nwipe_gui_status( void *ptr )
{
/**
 * Shows runtime statistics and overall progress.
 *
 * @parameter count           The number of contexts in the array.
 * @parameter c               An array of device contexts.
 *
 * @modifies  main_window     Prints information into the main window.
 * @modifies  c[].throughput  Updates the i/o throughput value. 
 *
 */

   extern int terminate_signal;

 	nwipe_thread_data_ptr_t *nwipe_thread_data_ptr;
 	nwipe_thread_data_ptr = (nwipe_thread_data_ptr_t *) ptr;

        nwipe_context_t **c;
        nwipe_misc_thread_data_t *nwipe_misc_thread_data;
	int count;
	        
	c = nwipe_thread_data_ptr->c;
	nwipe_misc_thread_data = nwipe_thread_data_ptr->nwipe_misc_thread_data;
	count = nwipe_misc_thread_data->nwipe_selected;

	/* Throughput print formats. */
	char* nwipe_tera = "%llu TB/s";
	char* nwipe_giga = "%llu GB/s";
	char* nwipe_mega = "%llu MB/s";
	char* nwipe_kilo = "%llu KB/s";
	char* nwipe_unit = "%llu B/s";

	/* The throughput format pointer. */
	char* nwipe_format;

	/* We count time from when this function is first called. */
	static time_t nwipe_time_start = 0;

	/* Whether the screen has been blanked by the user. */
	static int nwipe_gui_blank = 0;

	/* The current time. */
	time_t nwipe_time_now;

	/* The index of the element that is visible in the first slot. */
	static int offset;

	/* The number of elements that we can show in the window. */
	int slots;

	/* Window dimensions. */
	int wlines;
	int wcols;

	/* Generic loop variable. */
	int i;

	/* The current working line in the main window. */
	int yy;

	/* User input buffer. */
	int keystroke;

	/* The combined througput of all processes. */
	nwipe_misc_thread_data->throughput = 0;

	/* The estimated runtime of the slowest device. */
	nwipe_misc_thread_data->maxeta = 0;

	/* The combined number of errors of all processes. */
	nwipe_misc_thread_data->errors = 0;

	/* Time values. */
	int nwipe_hh;
	int nwipe_mm;
	int nwipe_ss;
   
   struct timespec tim, tim2;
   tim.tv_sec = 0;
   tim.tv_nsec = 100000000L; /* sleep for 0.1 seconds */

	/* The number of active wipe processes. */
	/* Set to 1 initially to start loop.    */
	int nwipe_active = 1;

	if( nwipe_time_start == 0 )
	{
		/* This is the first time that we have been called. */
		nwipe_time_start = time( NULL ) -1;
	}

	/* Get the window dimensions. */
	getmaxyx( main_window, wlines, wcols );

	/* Less four lines for the box and padding. */
	slots = wlines - 4;

	/* Each element prints three lines. */
	slots /= 3;

	/* Add text to footer window */
	nwipe_gui_title( footer_window, end_wipe_footer );
	wrefresh( footer_window );

	while ( nwipe_active && terminate_signal != 1) {

		/* Get the current time. */
		nwipe_time_now = time( NULL );

		/* Erase the main window. */
		werase( main_window );

		/* Erase the stats window. */
		werase( stats_window );

		/* Initialize our working offset to the third line. */
		yy = 2;

		/* Try to get a keystroke. */
		keystroke = getch();

		if ( keystroke > 0 && nwipe_gui_blank == 1 )
		{ 
			/* Show screen */
			nwipe_gui_blank = 0;
			
			/* Set background */
			wbkgdset( stdscr, COLOR_PAIR(1) );
			wclear( stdscr );

			/* Unhide panels */
			show_panel(header_panel);
			show_panel(footer_panel);
			show_panel(stats_panel);
			show_panel(options_panel);
			show_panel(main_panel);

			/* Update panels */
			update_panels();
			doupdate();

		}
		else if ( keystroke > 0 ) {

			switch( keystroke )
			{

				case 'b':
				case 'B':

					/* Blank screen. */
					nwipe_gui_blank = 1;
					hide_panel(header_panel);
					hide_panel(footer_panel);
					hide_panel(stats_panel);
					hide_panel(options_panel);
					hide_panel(main_panel);

					/* Set the background style. */
					wbkgdset( stdscr, COLOR_PAIR(7) );
					wclear( stdscr );

					break;

				case KEY_DOWN:
				case 'j':
				case 'J':

					/* Scroll down. */
					offset += 1;

					if( count < slots )
					{
						offset = 0;
					}

					else if( offset + slots > count )
					{
						offset = count - slots;
					}

					break;

				case KEY_UP:
				case 'k':
				case 'K':

					/* Scroll up. */
					offset -= 1;

					if( offset < 0 )
					{
						offset = 0;
					}

					break;

				default:

					/* Do nothing. */
					break;
			}

		} /* keystroke */


		/* Update screen if not blanked. */
		if ( nwipe_gui_blank == 0 )
		{

			nwipe_active = compute_stats(ptr); // Returns number of active wipe threads

			/* Print information for the user. */
			for( i = offset ; i < offset + slots && i < count ; i++ )
			{
				/* Print the context label. */
				if ( strlen((const char*)c[i]->serial_no) )	
				{
					mvwprintw( main_window, yy++, 2, "%s - %s (S/N:%s)", c[i]->device_name+SKIP_DEV_PREFIX,
												c[i]->label,
												c[i]->serial_no);
				}
				else {
					mvwprintw( main_window, yy++, 2, "%s - %s", c[i]->device_name+SKIP_DEV_PREFIX,
											c[i]->label );
				}

				/* Check whether the child process is still running the wipe. */
				//if( c[i]->thread > 0 )
				if( c[i]->wipe_status == 1 )
				{
					/* Print percentage and pass information. */
					mvwprintw( main_window, yy++, 4, "[%05.2f%%, round %i of %i, pass %i of %i] ", \
					  c[i]->round_percent, c[i]->round_working, c[i]->round_count, c[i]->pass_working, c[i]->pass_count );

				} /* child running */

				else
				{
					if( c[i]->result == 0 ) { mvwprintw( main_window, yy++, 4, "[%05.2f%% complete, SUCCESS! ", c[i]->round_percent); }
					else if( c[i]->signal ) { mvwprintw( main_window, yy++, 4, "(>>> FAILURE! <<<, signal %i) ", c[i]->signal ); }
					else                   { mvwprintw( main_window, yy++, 4, "(>>>FAILURE!<<<, code %i) ", c[i]->result );   }

				} /* child returned */

				if( c[i]->verify_errors ) { wprintw( main_window, "[verify errors: %llu] ", c[i]->verify_errors ); }
				if( c[i]->pass_errors   ) { wprintw( main_window, "[pass errors: %llu] ",   c[i]->pass_errors   ); }


				switch( c[i]->pass_type )
				{
					case NWIPE_PASS_FINAL_BLANK:
						wprintw( main_window, "[blanking] " );
						break;

					case NWIPE_PASS_FINAL_OPS2:
						wprintw( main_window, "[OPS-II final] " );
						break;

					case NWIPE_PASS_WRITE:
						wprintw( main_window, "[writing] " );
						break;

					case NWIPE_PASS_VERIFY:
						wprintw( main_window, "[verifying] " );
						break;

					case NWIPE_PASS_NONE:
						break;
				}

				if( c[i]->sync_status   ) { wprintw( main_window, "[syncing] "   ); }

				     if( c[i]->throughput >= INT64_C( 1000000000000    ) )
					    { wprintw( main_window, "[%llu TB/s] ", c[i]->throughput / INT64_C( 1000000000000 ) ); }
				else if( c[i]->throughput >= INT64_C( 1000000000       ) )
				       { wprintw( main_window, "[%llu GB/s] ", c[i]->throughput / INT64_C( 1000000000    ) ); }
				else if( c[i]->throughput >= INT64_C( 1000000          ) )
				       { wprintw( main_window, "[%llu MB/s] ", c[i]->throughput / INT64_C( 1000000       ) ); }
				else if( c[i]->throughput >= INT64_C( 1000             ) )
				       { wprintw( main_window, "[%llu KB/s] ", c[i]->throughput / INT64_C( 1000          ) ); }
				else
				       { wprintw( main_window, "[%llu B/s] ",  c[i]->throughput / INT64_C( 1             ) ); }

				/* Insert whitespace. */
				yy += 1;

			} /* for */


			if( offset > 0 )
			{
				mvwprintw( main_window, 1, wcols -8, " More " );
				waddch( main_window, ACS_UARROW );
			}

			if( count - offset > slots )
			{
				mvwprintw( main_window, wlines -2, wcols -8, " More " );
				waddch( main_window, ACS_DARROW );
			}


			/* Box the main window. */
			box( main_window, 0, 0 );

			/* Refresh the main window. */
			wrefresh( main_window );

			/* Update the load average field. */
			nwipe_gui_load();


			u64 nwipe_throughput = nwipe_misc_thread_data->throughput;
			     if( nwipe_throughput >= INT64_C( 1000000000000    ) )
				    { nwipe_throughput /= INT64_C( 1000000000000    ); nwipe_format = nwipe_tera; }
			else if( nwipe_throughput >= INT64_C( 1000000000       ) )
			       { nwipe_throughput /= INT64_C( 1000000000       ); nwipe_format = nwipe_giga; }
			else if( nwipe_throughput >= INT64_C( 1000000          ) )
			       { nwipe_throughput /= INT64_C( 1000000          ); nwipe_format = nwipe_mega; }
			else if( nwipe_throughput >= INT64_C( 1000             ) )
			       { nwipe_throughput /= INT64_C( 1000             ); nwipe_format = nwipe_kilo; }
			else
			       { nwipe_throughput /= INT64_C( 1                ); nwipe_format = nwipe_unit; }

			/* Print the combined throughput. */
			mvwprintw( stats_window, NWIPE_GUI_STATS_THROUGHPUT_Y, NWIPE_GUI_STATS_THROUGHPUT_X, "Throughput:" );

			if( nwipe_throughput > 0 )
			{
				mvwprintw( stats_window, NWIPE_GUI_STATS_THROUGHPUT_Y, NWIPE_GUI_STATS_TAB, nwipe_format, nwipe_throughput );
			}

			/* Change the current time into a delta. */
			nwipe_time_now -= nwipe_time_start;

			/* Put the delta into HH:mm:ss form. */
			nwipe_hh = nwipe_time_now / 3600;
			nwipe_time_now %= 3600;
			nwipe_mm = nwipe_time_now / 60;
			nwipe_time_now %= 60;
			nwipe_ss = nwipe_time_now;

			/* Print the runtime. */
			mvwprintw( stats_window, NWIPE_GUI_STATS_RUNTIME_Y, 1, "Runtime:" );
			mvwprintw( stats_window, NWIPE_GUI_STATS_RUNTIME_Y, NWIPE_GUI_STATS_TAB, "%02i:%02i:%02i", nwipe_hh, nwipe_mm, nwipe_ss );

			mvwprintw( stats_window, NWIPE_GUI_STATS_ETA_Y, 1, "Remaining:" );

			time_t nwipe_maxeta = nwipe_misc_thread_data->maxeta;
			if( nwipe_maxeta > 0 )
			{
				/* Do it again for the estimated runtime remaining. */
				nwipe_hh = nwipe_maxeta / 3600;
				nwipe_maxeta %= 3600;
				nwipe_mm = nwipe_maxeta / 60;
				nwipe_maxeta %= 60;
				nwipe_ss = nwipe_maxeta;
			
				/* Print the estimated runtime remaining. */
				mvwprintw( stats_window, NWIPE_GUI_STATS_ETA_Y, NWIPE_GUI_STATS_TAB, "%02i:%02i:%02i", nwipe_hh, nwipe_mm, nwipe_ss );
			}

			/* Print the error count. */
			mvwprintw( stats_window, NWIPE_GUI_STATS_ERRORS_Y, NWIPE_GUI_STATS_ERRORS_X, "Errors:" );
			mvwprintw( stats_window, NWIPE_GUI_STATS_ERRORS_Y, NWIPE_GUI_STATS_TAB, "%llu", nwipe_misc_thread_data->errors );

			/* Add a border. */
			box( stats_window, 0, 0 );

			/* Add a title. */
			mvwprintw( stats_window, 0, ( NWIPE_GUI_STATS_W - strlen( stats_title ) ) /2, "%s", stats_title );

			/* Refresh the stats window. */
			wrefresh( stats_window );

		} // end blank screen if

        	if (nwipe_options.logfile[0] == '\0') {
        	
        		// Logging to STDOUT. Flush log.

			def_prog_mode();                /* Save the tty modes             */
			endwin();                       /* End curses mode temporarily    */
			
			/* Flush stdout and disable buffering, otherwise output missed new lines. */
			fflush(stdout);
			setbuf(stdout, NULL);
			reset_prog_mode();              /* Return to the previous tty mode*/
							/* stored by def_prog_mode()      */
			refresh();                      /* Do refresh() to restore the    */
							/* Screen contents                */
		}
		
		/* Stop this function unnecessarily running the CPU or a CPU core at 100% */
		if(nanosleep(&tim , &tim2) < 0 )   
      {
         printf("Nano sleep system call failed \n");
      }

		/* Test for a thread cancellation request */
		pthread_testcancel();

	} // while

	if (nwipe_options.logfile[0] == '\0')
	{
		nwipe_gui_title( footer_window, "Wipe finished - press enter to exit. Logged to STDOUT" );
	}
	else {
		char finish_message[NWIPE_GUI_FOOTER_W];
		snprintf(finish_message, sizeof(finish_message), "Wipe finished - press enter to exit. Logged to %s",
			nwipe_options.logfile);
		nwipe_gui_title( footer_window, finish_message );
	}
	wrefresh( footer_window );
	nwipe_misc_thread_data->gui_thread = 0;
	
    return NULL;
} /* nwipe_gui_status */

int compute_stats(void *ptr)
{
        nwipe_thread_data_ptr_t *nwipe_thread_data_ptr;
        nwipe_thread_data_ptr = (nwipe_thread_data_ptr_t *) ptr;

        nwipe_context_t **c;   
        nwipe_misc_thread_data_t *nwipe_misc_thread_data;
                
        c = nwipe_thread_data_ptr->c;
        nwipe_misc_thread_data = nwipe_thread_data_ptr->nwipe_misc_thread_data;
        int count = nwipe_misc_thread_data->nwipe_selected;

	int nwipe_active = 0;
	int i;
	
	time_t nwipe_time_now = time( NULL );

	nwipe_misc_thread_data->throughput = 0;
	nwipe_misc_thread_data->maxeta = 0;
	nwipe_misc_thread_data->errors = 0;
	
	/* Enumerate all contexts to compute statistics. */
	for( i = 0 ; i < count ; i++ )
	{
		/* Check whether the child process is still running the wipe. */
//		if( c[i]->thread > 0 )
		if( c[i]->wipe_status == 1 )
		{
			/* Increment the child counter. */
			nwipe_active += 1;

			/* Maintain a rolling average of throughput. */
			nwipe_update_speedring( &c[i]->speedring, c[i]->round_done, nwipe_time_now );

			if( c[i]->speedring.timestotal > 0 )
			{
				/* Update the current average throughput in bytes-per-second. */
				c[i]->throughput = c[i]->speedring.bytestotal / c[i]->speedring.timestotal;

				/* Update the estimated remaining runtime. */
				/* Check that throughput is not zero (sometimes caused during a sync) */
				if (c[i]->throughput == 0)
				{
					c[i]->throughput = 1;
				}
				
				c[i]->eta = ( c[i]->round_size - c[i]->round_done ) / c[i]->throughput;

				if( c[i]->eta > nwipe_misc_thread_data->maxeta )
				{
					nwipe_misc_thread_data->maxeta = c[i]->eta;
				}
			}

			/* Update the percentage value. */
			c[i]->round_percent = (double) c[i]->round_done / (double) c[i]->round_size * 100;

			/* Accumulate combined throughput. */
			nwipe_misc_thread_data->throughput += c[i]->throughput;
		} /* child running */

		/* Accumulate the error count. */
		nwipe_misc_thread_data->errors += c[i]->pass_errors;
		nwipe_misc_thread_data->errors += c[i]->verify_errors;
	
	} /* for statistics */
	
	return nwipe_active;
}

void nwipe_update_speedring( nwipe_speedring_t* speedring, u64 speedring_bytes, time_t speedring_now )
{

	if( speedring->timeslast == 0 )
	{
		/* Ignore the first sample and initialize. */
		speedring->timeslast = speedring_now;
		return;
	}

	if( speedring_now - speedring->timeslast < NWIPE_KNOB_SPEEDRING_GRANULARITY )
	{
		/* Avoid jitter caused by frequent updates. */
		return;
	}

	/* Subtract the oldest speed sample from the accumulator. */
	speedring->bytestotal -= speedring->bytes[ speedring->position ];
	speedring->timestotal -= speedring->times[ speedring->position ];

	/* Put the lastest bytes-per-second sample into the ring buffer. */
	speedring->bytes[ speedring->position ] = speedring_bytes - speedring->byteslast;
	speedring->times[ speedring->position ] = speedring_now   - speedring->timeslast;

	/* Add the newest speed sample to the accumulator. */
	speedring->bytestotal += speedring->bytes[ speedring->position ];
	speedring->timestotal += speedring->times[ speedring->position ];

	/* Remember the last sample. */
	speedring->byteslast = speedring_bytes;
	speedring->timeslast = speedring_now;

	if( ++speedring->position >= NWIPE_KNOB_SPEEDRING_SIZE )
	{
		speedring->position = 0;
	}
}

/* eof */