#

# Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).

# All rights reserved.

# This component and the accompanying materials are made available

# under the terms of the License "Eclipse Public License v1.0"

# which accompanies this distribution, and is available

# at the URL "http://www.eclipse.org/legal/epl-v10.html".

#

# Initial Contributors:

# Nokia Corporation - initial contribution.

#

# Contributors:

#

# Description: 

# This package contains fuctions specific to data drive image generation

#

package datadriveimage;

require Exporter;

@ISA=qw(Exporter);

@EXPORT=qw(

			createDirectory 

			deleteDirectory 

			checkInArray 

			setPath 

			locateStubsisfiles 

			copyFilesToFolders 

			checkForSisFile 

			copyNonSisFiles

			invokeInterpretsis

			invokeReadImage

			compareArrays

			dumpDatadriveObydata

			TraverseDir

			writeDataToFile

			generate_datadriveheader

			checkForWhiteSpace

			reportError

);

use strict;

use File::Path;		# Module to provide functions to remove or create directories in a convenient way.

use File::Copy;		# Module to provide functions to copy file(s) from source to destination.

use Cwd;			# Module to provide functions for determining the pathname of the current working directory.

use romutl;

use romosvariant;

# This fuction is used primiarly to check for whitespace in the location for "zdrive" / "datadrive" folder creation,

# specified by the user, if yes then it returns one, else zero

sub checkForWhiteSpace

{

	my ($dirLoc,$dirName) = @_;

	if( $dirLoc =~ m/ / )

	{

		print "* Warning: $dirLoc contains whitespace, hence $dirName will be created in default location \n";

		return 1;

	}

	else

	{

		return 0;

	}

}

# This function reports the appropriate meassage supplied to it

# and does a exit if and only if keepgoing option is disabled.

sub reportError

{

	my( $message,$keepgoingOpt ) = @_;

	# print the specified meassage.

	print STDERR "$message \n";

	# bail out, if keepgoing option is not set.

	exit(1) if (!$keepgoingOpt);

}

# generate header for final datadrive oby file.

sub generate_datadriveheader

{

	my ($idx,$datadriveimage) = @_;

	my $header;

	$header =  "dataimagename=$$datadriveimage[$idx]{name}.img\n";

	$header .= "dataimagefilesystem=$$datadriveimage[$idx]{fstype}\n";

	# check whether the size of the image has been mentioned

	if(defined($$datadriveimage[$idx]{size}))

	{

		$header .= "dataimagesize=$$datadriveimage[$idx]{size}\n\n";

	}

	return $header;

}

# Create the specified directory by making use of mkpath function 

# from File::Path module.

sub createDirectory

{

	my($dir) = @_;

	if( !-d $dir )

	{

		mkpath($dir);

		if (! -e $dir) 

		{

			print ("ERROR: Couldn't create $dir\n");

		}

	}

}

# check if the given file is a reg file or ctl file or a txt file

# if it is any of these files then return true else false.

# This check is need since these three files or not valid not valid e32 file 

# and hence needs to be placed as an data file inside the image.

sub checkRegCtlFiles

{

	my ($fileName) = @_;

	# check whether the file has "reg","ctl" or "txt" extension.

	if( $fileName =~/\.(reg|ctl|txt)$/i )

	{

		return 1;		

	}

	else

	{

		return 0;

	}

}

# delete the given directory by making use of rmtree function 

# from File::Path module.

sub deleteDirectory

{

	my($dir,$verboseOpt) = @_;

	# check whether the directory exists.

	if( -d $dir )

	{

		print("found $dir directory \n") if($verboseOpt);

		if(rmtree($dir))

		{

			print("$dir directory deleted \n") if($verboseOpt);

			return 0;

		}

		else

		{

			print("$dir directory could'nt be deleted \n") if($verboseOpt);

			return 1;

		}

	}

}

# check for processed data drive image index.

# if there is a match return one else return zero.

# this check is done in order to ensure data drive image index is not repeated.

sub checkInArray

{

	my($array, $value) = @_;

	foreach my $aLine(@$array)

	{

		if( $aLine eq $value )

		{

			return 0;

		}

	}

	return 1;

}

# set the path for the given directory.

sub setPath

{

	my($dirName) = @_;

	# get the working directory.

	my $curWorkingDir = getcwd;

	# substitute slash with double backward slash.

	$curWorkingDir =~ s/\\/\//g;

 	#if $curWorkingDir already has trailing '\', don't include it again 

 	if( $curWorkingDir =~ /\/$/)

 	{

 		return $curWorkingDir.$dirName;

 	}

 	else

 	{

 		return $curWorkingDir."\/".$dirName;

 	}

}

# create directory and copy respective file on to that directory.

# is there is a problem while copying files from source to destination

# then bail out if and only if keep going option is disabled.

sub copyFilesToFolders

{

	my ($source,$dest,$dir,$verboseOpt) = @_;

	$source =~ s/\"//g; # remove double quotes from the string. 

	my $destFileName = "";	# name of the destination file.

	$dest =~ s/\"//g;	# remove double quotes from the string. 

	my $destDirectory = $dest;

	# strip the last substring to get destination file 

	if ($dest=~/.*[\/\\](\S+)/) 

	{

		$destFileName = $1;

	}

	else

	{

		$destFileName = $dest;

	}

	#get the destination directory along with full path

	#when "[" and "]" appear in the file name we need add "\" before "[" or "]"

	#like this: [filename].exe translate to \[filename\].exe 

	if($destFileName =~ /\[|\]/)

	{

		my $tempFileName = $destFileName;

		$tempFileName =~ s/(\[|\])/\\$1/g;

		$destDirectory =~ s/$tempFileName//;

	}

	else

	{	

		$destDirectory =~ s/$destFileName//;

	}

	my $destfile = $dir."\/".$dest;

	my $createdir = $dir."\/".$destDirectory ;

	# create the specified directory.

	&createDirectory($createdir);

	if (!copy($source,$destfile))

	{

		warn "warning : $source file could not found \n";

		return 0;

	}

	else

	{

		print "$source copied to $destfile\n" if($verboseOpt);

		return "\"".$destfile."\"";

	}

}

# Make a check for sisfile keyword by reading the specified iby/oby file,

# if sisfile keyword is found then push the respective image on to the respective array 

# and return true.

sub checkForSisFile 

{

	my($obyfile,$sisFileArray,$sisFilePrestent) = @_;

	# open the oby file in read only mode. 

	open (DATA, "< $obyfile") or die("* Can't open $obyfile\n");

	while  (my $line =<DATA>)

	{

		if($line =~ /^\s*sisfile\s*=\s*(\S+)/i )

		{

			# found a sis file.

			$$sisFilePrestent = 1;

			# push sis file on to stack.

			push(@$sisFileArray,$1);

			next;

		}

	}

	close(DATA);

	return $$sisFilePrestent;

}

# Make a check for zdriveimagename keyword by reading the specified iby/oby file,

# if zdriveimagename keyword is found then push the respective image on to the respective array 

# and return true.

sub checkForZDriveImageKeyword 

{

	#$ZDriveImageFilePresent

	my($obyfile,$ZDriveImageKeywordArray,$ImageFilePresent) = @_;

	# open the oby file in read only mode. 

	open (DATA, "< $obyfile") or die("* Can't open $obyfile\n");

	while  (my $line =<DATA>)

	{

		if($line =~ /^\s*zdriveimagename\s*=\s*(\S+)/i )

		{

			# found a Z Drive Image file.

			$$ImageFilePresent = 1;

			# push sis file on to stack.

			push(@$ZDriveImageKeywordArray,$1);

			next;

		}

	}

	close(DATA);

	return $$ImageFilePresent;

}

# copy all non-sis file(s) on to prototype data drive folder 

# which are mentioned under input data drive iby/oby file.

sub copyNonSisFiles

{

	my($dir,$obyfile,$nonsisFileArray,$renameArray,$aliasArray,$hideArray,$verboseOpt,$keepgoingOpt) = @_;

	open (OBEY ,$obyfile) or die($obyfile."\n");

	while(my $line =<OBEY>) 

	{

		if( $line =~ /^(file|data)\s*=\s*(\"[^"]+\")\s+(\"[^"]+\")/i || 

				$line =~ /^(file|data)\s*=\s*(\"[^"]+\")\s+(\S+)/i || 

				$line =~ /^(file|data)\s*=\s*(\S+)\s+(\"[^"]+\")/i || 

				$line =~ /^(file|data)\s*=\s*(\S+)\s+(\S+)/i )

		{

			my $keyWord=$1;

			my $source=$2;

			my $dest=$3;

			if( $source !~ /(\S+):([^"]+)/ )

			{ 

				$source = get_drive().$2;

			}

			my $var = &copyFilesToFolders( $source,$dest,$dir,$verboseOpt);

			if($var)

			{

				$line = $keyWord."=".$var."\t".$dest."\n";

				push(@$nonsisFileArray,$line);

			}

			else

			{

				exit(1)if(!$keepgoingOpt);

			}

		}

		elsif($line =~ /^rename\s+(\S+)\s+(\S+)/i)

		{

			my $oldFile = $dir.$1;	# existing-file

			my $newFile = $dir.$2;	# destination-file

			print"found rename keyword\nrenaming $oldFile to $newFile\n" if ($verboseOpt);

			if ( rename($oldFile, $newFile) )

			{

				# push the line on to the stack.

				push(@$renameArray,$1."\t".$2."\n");

			}

			else

			{

				&datadriveimage::reportError("* Warning : can't rename $oldFile to $newFile: $!",$keepgoingOpt);

			}

		}

		elsif($line =~ /^alias\s+(\S+)\s+(\S+)/i)

		{

			my $exFile = $dir.$1;	# existing-file

			my $destFile = $dir.$2;	# destination-file

			print"found alias keyword\n" if ($verboseOpt);

			if(!copy($exFile,$destFile))

			{

				&datadriveimage::reportError("* warning : couldnt create alias of $1 to $2 ",$keepgoingOpt);

			}

			else

			{

				# push the line on to the stack.

				push(@$aliasArray,$1."\t".$2."\n");

			}

		}

		elsif($line =~ /^hide\s+(\S+)/i)

		{

			print"found hide keyword\n" if ($verboseOpt);

			print "$1 is marked as hidden, hence will not be part of the image\n" if($verboseOpt);

			if( unlink($dir.$1) )

			{

				# push the line on to the stack.

				push(@$hideArray,$1);

			}

			else 

			{ 

				&datadriveimage::reportError("* Warning : Can't delete $1: $! ",$keepgoingOpt);

			}

		}

	}

	close(OBEY);

}

# invoke the INTERPRETSIS tool with appropriate parameters.

sub invokeInterpretsis

{

	my($sisFileArray,$dataDrivePath,$verboseOpt,$zDrivePath,$parafile,$keepgoingOpt,$interpretsisOptList) = @_;

	my $sisfile = ""; 

	# default system drive letter is specified since interpretsis doesnt allow overloading of options unless default 

	# options are specified.

	my $basicOption = "-d C: ";	# default system drive letter

	my $command = "interpretsis ";

	my $vOption = "-w info" if ($verboseOpt);

	is_existinpath("interpretsis", romutl::DIE_NOT_FOUND);

	# do a check if the path has a white space.

	if( $dataDrivePath =~ m/ /)

	{

		$dataDrivePath = '"'.$dataDrivePath.'"';

	}

	# find out size of the array

	my $sisarraysize = scalar(@$sisFileArray);

	for( my $i=0; $i<$sisarraysize; $i++ )

	{

		if($sisfile ne "")

		{

			$sisfile = pop(@$sisFileArray).",".$sisfile;

		}

		else

		{

			$sisfile = pop(@$sisFileArray);

		}

	}

	# check whether the directory exists or not 

	if( -d $zDrivePath )

	{ 

		# do a check if the path has a white space.

		if( $zDrivePath =~ m/ /)

		{

			$zDrivePath = '"'.$zDrivePath.'"';

		}

		$basicOption .= "-z $zDrivePath "; 

	}

	$basicOption .= "-c $dataDrivePath -s $sisfile $vOption";

	# if parameter file is specified then invoke the INTERPRETSIS

	# with the specified parameter file with "-p" option.

	if( defined($parafile) )

	{ 

		# do a check if the path has a white space.

		if( $parafile =~ m/ /)

		{

			$parafile = '"'.$parafile.'"';

		}

		$command .= "-p $parafile "; 

	}

	# else invoke the INTERPRETSIS with default parameter file with "-p" option. 

	else

	{

		# Truncate and open the parameter file for writing..

		open( OPTDATA, "> parameterfile.txt" )  or die "can't open parameterfile.txt";

		print OPTDATA $basicOption."\n";

		close( OPTDATA );

		$command .= "-p parameterfile.txt ";

	}

	if( $interpretsisOptList )

	{

		# find out size of the array

		my $arraysize = scalar( @$interpretsisOptList );

		for( my $i = 0; $i < $arraysize; $i++ )

		{

			$command .= $$interpretsisOptList[$i]." ";

		}

	}

	print "* Executing $command\n" if ( $verboseOpt );

	system ( $command );

	if ($? != 0)

	{

		&datadriveimage::reportError("* ERROR: INTERPRETSIS failed",$keepgoingOpt);

	}

}

# invoke the READIMAGE tool with appropriate parameters.

sub invokeReadImage

{

	my($imageName,$loc,$verboseOpt,$logFile,$keepgoingOpt) = @_;

	my $command = "readimage ";

	is_existinpath("readimage", romutl::DIE_NOT_FOUND);

	# check if log file has been supplied.

	if(defined($logFile))

	{

		if( $logFile =~ m/ /)

		{

			$logFile = '"'.$logFile.'"';

		}

		$command .= "-l $logFile ";

	}

	# do a check if the path has a white space.

	if( $loc =~ m/ /)

	{

		$loc = '"'.$loc.'"';

	}

	$command .= "-z ".$loc." ".$imageName;

	print "* Executing $command\n" if ($verboseOpt);

	system ($command);

	if ($? != 0)

	{

		&datadriveimage::reportError("* ERROR: READIMAGE failed to read the image",$keepgoingOpt);

		return 0;

	}

	return 1;

}

# Each line from the OBY file is read and if any of the line contains "rename"/ "alias" keyword

# then that corresponding line source and line destination is obtained and is passed to this function as one of the parameters.

# This fuction compares given array with non-sis file(s) array, when an given line destination matches with the destination of an

# element in the rename array/alias array(array holding list of file(s) that are renamed / made alias) then,

# that respective element is removed from the rename array and a further check is made to see whether the given

# line source matches with the destination of an element in the rename array/alias array.If a match is found then

# a keyword check is done,if the keyword is "rename" then corresponding element's source and destination file is replaced

# with given line destination file and if the keyword is "alias" then a new element will be added to non sis file array

# with line destination file as the source and destination file.

sub compareArrays

{

	my ( $firstarray,$nonsisArray,$linesource,$linedest,$linekeyword ) = @_;

	# count of array element(s).