sl@0: #!perl
sl@0: # Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: # All rights reserved.
sl@0: # This component and the accompanying materials are made available
sl@0: # under the terms of "Eclipse Public License v1.0"
sl@0: # which accompanies this distribution, and is available
sl@0: # at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: #
sl@0: # Initial Contributors:
sl@0: # Nokia Corporation - initial contribution.
sl@0: #
sl@0: # Contributors:
sl@0: #
sl@0: # Description:
sl@0: #
sl@0: 
sl@0: use strict;
sl@0: use FindBin;
sl@0: use File::Copy;
sl@0: 
sl@0: # Figure out what user has asked us to do...
sl@0: 
sl@0: my( $script_name ) = $0;
sl@0: my( $mode ) = $ARGV[0];
sl@0: my( $backup ) = $ARGV[1];
sl@0: my( $epocextra ) = $ARGV[2];
sl@0: my( $wsiniextra ) = $ARGV[3];
sl@0: 
sl@0: my( $usage ) = <<EOF;
sl@0: 
sl@0: This script will append or remove extra options to the epoc.ini and
sl@0: wsini.ini emulator configuration files. 
sl@0: It is intended to be used before and after any emulator tests
sl@0: that require multiple emulator screens.
sl@0: 
sl@0: Usage:
sl@0: 
sl@0: $script_name help
sl@0: 	Displays this message.
sl@0: 
sl@0: $script_name append $backup $epocextra $wsiniextra
sl@0: 	Makes back-up copies of the epoc.ini and wsini.ini config files to files 
sl@0: 	prefixed with $backup and then appends the contents of $epocextra and 
sl@0: 	$wsiniextra to the originals. Note that $backup must be unique or append 
sl@0: 	will fail.
sl@0: 
sl@0: $script_name restore $backup
sl@0: 	Moves the back-up copies of epoc.ini and wsini.ini to their original
sl@0: 	locations from files prefixed with $backup
sl@0: 
sl@0: Notes:
sl@0: 	The wsini.ini file is a unicode text file encoded using UTF-16. The
sl@0: 	wsini.extra file MUST therefore be saved with the same encoding
sl@0: 	otherwise the resulting concatenated file will not work. (You don't need
sl@0: 	to worry about the extra BOM at the start of wsini.extra since this
sl@0: 	script takes care of removing it before appending the file)
sl@0: 
sl@0: 	The original epoc.ini and wsini.ini files are NOT checked prior to the
sl@0: 	appending. If you have customised these files (especially with any
sl@0: 	multi-screen options) the resulting concatenated files may be invalid
sl@0: 	or cause the tests to fail.
sl@0: 
sl@0: EOF
sl@0: 
sl@0: if( ($mode eq 'help') || ( $mode eq '' ) ){
sl@0: 	print $usage;
sl@0: 	exit;
sl@0: }
sl@0: elsif( ($mode ne 'append') && ($mode ne 'restore') ){
sl@0: 	die "$script_name: ERROR: Invalid argument: \"$mode\". Must be either \"help\", \"append\" or \"restore\"\n".$usage;
sl@0: }
sl@0: 
sl@0: ##########################################
sl@0: 
sl@0: # Append $source to $dest. If $is_utf_16 the BOM marker at the start of $source will be
sl@0: # stripped off to ensure that the $dest remains a valid UTF-16 file.
sl@0: sub append_to_file{
sl@0: 	my( $source, $dest, $is_utf_16 ) = @_;
sl@0: 	my( $line, $did_first );
sl@0: 	$did_first = 0;
sl@0: 	
sl@0: 	open SOURCE, $source or die "$script_name: ERROR: Could not open $source ($!)\n";
sl@0: 	open DEST, '>>', $dest or die "$script_name: ERROR: Could not open $dest ($!)\n";
sl@0: 
sl@0: 	if( $is_utf_16 ){
sl@0: 		# since our old version of Perl does not have decent Unicode support
sl@0: 		# we'll use binary mode instead...
sl@0: 		binmode SOURCE;
sl@0: 		binmode DEST;
sl@0: 		
sl@0: 		while( read( SOURCE, $line, 1000 ) ){
sl@0: 			if( !$did_first ){
sl@0: 				# strip BOM (first two bytes) off first line, since it is being appended to an
sl@0: 				# existing UTF-16 file
sl@0: 				$line = substr( $line, 2 );
sl@0: 				$did_first = 1;
sl@0: 			}
sl@0: 			print DEST $line;
sl@0: 		}
sl@0: 	}
sl@0: 	else{
sl@0: 		# bog-standard ASCII
sl@0: 		while( $line = <SOURCE> ){		
sl@0: 			print DEST $line;
sl@0: 		}
sl@0: 	}
sl@0: 	
sl@0: 	close SOURCE;
sl@0: 	close DEST;
sl@0: }
sl@0: 
sl@0: ##########################################
sl@0: # Begin main logic...
sl@0: 
sl@0: # Figure out locations of INI files...
sl@0: my( $epoc_root, $epocini, $udeb_wsini, $urel_wsini, $extra_epocini, $extra_wsini, $copy_epocini, $copy_udeb_wsini, $copy_urel_wsini );
sl@0: 
sl@0: $epoc_root = $ENV{'EPOCROOT'};
sl@0: $epoc_root =~ tr:\\:/:; # change to Linux-friendly forward-slashes (Windows Perl compensates for this automagically)
sl@0: $epoc_root =~ s/\/$//; # remove any trailing slash to avoid double slashes when the paths are appended below
sl@0: 
sl@0: $epocini = $epoc_root.'/epoc32/data/epoc.ini';
sl@0: #if this is defined we are running Mistral
sl@0: if($ENV{'EPOC_INI'}) {$epocini = $ENV{'EPOC_INI'};}
sl@0: 
sl@0: $udeb_wsini = $epoc_root.'/epoc32/RELEASE/WINSCW/UDEB/Z/system/data/wsini.ini'; # this file is UTF-16 little-endian!
sl@0: $urel_wsini = $epoc_root.'/epoc32/RELEASE/WINSCW/UREL/Z/system/data/wsini.ini'; # this file is UTF-16 little-endian!
sl@0: 
sl@0: my $emu_data_dir = $ENV{'EMULATOR_DATA_DIR'};
sl@0: if($emu_data_dir) 
sl@0: 	{
sl@0: 	#this is mistral so we will overload $urel_wsini with absolute location
sl@0: 	$urel_wsini = $emu_data_dir.'z\system\data\wsini.ini';
sl@0: 	}
sl@0: 
sl@0: $extra_epocini = $FindBin::Bin.$epocextra; # this file is ASCII
sl@0: $extra_wsini = $FindBin::Bin.$wsiniextra; # this file is UTF-16 little-endian!
sl@0: 
sl@0: $copy_epocini = $FindBin::Bin.'/'.$backup.'_epoc.copy';
sl@0: $copy_udeb_wsini = $FindBin::Bin.'/'.$backup.'_wsini_udeb.copy';
sl@0: $copy_urel_wsini = $FindBin::Bin.'/'.$backup.'_wsini_urel.copy';
sl@0: 
sl@0: 
sl@0: if( $mode eq 'append' ){
sl@0: 	# Append mode: Append extra options to existing INI files
sl@0: 	
sl@0: 	# first make back-up of existing INI files
sl@0: 	# (without clobbering existing copies)	
sl@0: 	if( -e $copy_epocini ){
sl@0: 		die "$script_name: ERROR: Back-up of epoc.ini already exists at \"$copy_epocini\". Please run \"$script_name restore\" first.\n";
sl@0: 	}
sl@0: 	else{
sl@0: 		copy( $epocini, $copy_epocini ) or die "$script_name: ERROR: Could not copy $epocini ($!)\n";
sl@0: 	}
sl@0: 	# now append extra bits to original INI files
sl@0: 	append_to_file( $extra_epocini, $epocini, 0 );
sl@0: 	print "$script_name: NOTE: Extra settings have been appended to \"$epocini\". If you have customised this file and secondary display tests fail, please check for conflicting settings!\n";
sl@0: 	
sl@0: 	## UREL wsini.ini + mistral universal
sl@0: 	if( -e $copy_urel_wsini ){
sl@0: 		die "$script_name: ERROR: Back-up of UREL wsini.ini already exists at \"$copy_urel_wsini\". Please run \"$script_name restore\" first.\n";
sl@0: 	}
sl@0: 	else{
sl@0: 		copy( $urel_wsini, $copy_urel_wsini ) or die "$script_name: ERROR: Could not copy $urel_wsini ($!)\n";
sl@0: 	}
sl@0: 	#note mistral will provide absolute location dependant on running mode	
sl@0: 	append_to_file( $extra_wsini, $urel_wsini, 1 );
sl@0: 	print "$script_name: NOTE: Extra settings have been appended to \"$urel_wsini\". If you have customised this file and secondary display tests fail, please check for conflicting settings!\n";
sl@0: 	
sl@0: 	
sl@0: 	#unless mistral in which case we dont bother keeping a backup of udeb as we adjust universal copy 
sl@0: 	#under guise of UREL path
sl@0: 	if(!$emu_data_dir)
sl@0: 	{
sl@0: 		if( -e $copy_udeb_wsini ){
sl@0: 			die "$script_name: ERROR: Back-up of UDEB wsini.ini already exists at \"$copy_udeb_wsini\". Please run \"$script_name restore\" first.\n";
sl@0: 		}
sl@0: 		else{
sl@0: 			copy( $udeb_wsini, $copy_udeb_wsini ) or die "$script_name: ERROR: Could not copy $udeb_wsini ($!)\n";
sl@0: 		}
sl@0: 		#
sl@0: 		append_to_file( $extra_wsini, $udeb_wsini, 1 );
sl@0: 		print "$script_name: NOTE: Extra settings have been appended to \"$udeb_wsini\". If you have customised this file and secondary display tests fail, please check for conflicting settings!\n";
sl@0: 	}
sl@0: 	
sl@0: 	
sl@0: 	
sl@0: }else{
sl@0: 	# Restore mode: Move copies of original INI files back to original locations
sl@0: 	
sl@0: 	move( $copy_epocini, $epocini ) && print "$script_name: NOTE: \"$epocini\" has been restored to previous version.\n" or warn "$script_name: Could not restore $epocini from $copy_epocini ($!)\n";
sl@0: 	
sl@0: 	move( $copy_urel_wsini, $urel_wsini ) && print "$script_name: NOTE: \"$urel_wsini\" has been restored to previous version.\n" or warn "$script_name: Could not restore $urel_wsini from $copy_urel_wsini ($!)\n";
sl@0: 	
sl@0: 	if(!$emu_data_dir)
sl@0: 	{
sl@0: 		move( $copy_udeb_wsini, $udeb_wsini ) && print "$script_name: NOTE: \"$udeb_wsini\" has been restored to previous version.\n" or warn "$script_name: Could not restore $udeb_wsini from $copy_udeb_wsini ($!)\n";		
sl@0: 	}
sl@0: }