#!perl -w

# Copyright (c) 2009 Symbian Foundation Ltd

# 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:

# Symbian Foundation Ltd - initial contribution.

#

# Contributors:

# Arnaud Lenoir

#

# Description:

# Task 243 - Generate FCLs details between 2 PDKs to be included as part of the release notes

# Here is the location for the naming convention for the PDKs: http://developer.symbian.org/wiki/index.php/Build_and_Integration

use strict;

use Getopt::Long;

#

# Configuration data and constants for the script

#

print "default_pdk_loc=$default_pdk_loc\n";

# Nb of arguments to be passed to the script to work. If that need to change, just modify nb_arg_to_pass!

my $nb_arg_to_pass=2;

# Name of the file that contains the data we need to extract for this script

my $build_bom_zip_file_to_extract="build_BOM.zip";

my $build_logs_zip_file_to_extract="build_logs.zip";

# Name of the file we need to work on to extract the data necessary for the Release Notes from build_BOM.zip

my $name_of_file_to_compare="build-info.xml";

# File used to extract path and component name for a package from build_logs.zip

my $pckg_extraction_data_file_name = "PkgComponentAnalysisSummary.csv";

# When using the script as part of the build system, we don't have access to the zip files yet, therefore we need to have a look for the file directly

# This is working only when using pdkloc2 only. In any other cases we are not bothered!!!!!

my $bom_dir="BOM";

my $analysis_dir="analysis";

# Pattern used to search for PDKs

my $pdk_start_pattern="PDK_";

# Pattern used to extract info from the xml file

my $starting_pattern_for_xml_extraction="<name>Sources</name>";

my $ending_pattern_for_xml_extraction="</project>";

# Pattern to extract data from the line in the file

# Branch type. If not a branch type, we are not interested

my $branch_type_extraction_pattern="(MCL|FCL)";

my $mcl_cste="MCL";

my $fcl_cste="FCL";

# package name

#/imgeditor/#:86a88f39b644</baseline>

# # is used to define the changeset number for mercurial.

# Therefore if we have a look what is before "/#", we should always find the package name!!

my $package_extraction_pattern = "([^/]+)/?#";

# When that "boolean value is set to 1 or true, then the line we read in the file can be search for the information we want to extract

# If $starting_pattern_for_xml_extraction true, then set extraction_from_xml_is_allowed to true/1

# If $ending_pattern_for_xml_extraction false, then reset extraction_from_xml_is_allowed to false/0

# $ending_pattern_for_xml_extraction is called several times in the program, but this is not a problem as we don't set it to false/0 and therefore do nothing!

my $extraction_from_xml_is_allowed=0;

# Temporary location used to do the work

my $working_drive="c:";

my $working_directory="temp";

my $working_sub_directory="fcl_extraction";

my $working_pdk1_directory="pdk1";

my $working_pdk2_directory="pdk2";

# Name of the file that we are creating to hold the information necessary for the Release Notes

my $name_of_file_to_publish="releaseNotes.wiki.txt";

#Location for that file

# This values need to be overwritten!!!

my $location_of_file_to_publish="c:\\temp";

#

# End configuration data for the script

#

# Arguments / Data used for the script

my $help = 0;

my $publishDir;

my @PDK = ({}, {});

GetOptions((

	'pdknb1=s' => \$PDK[0]->{number},

	'pdknb2=s' => \$PDK[1]->{number},

	'pdkname1=s' => \$PDK[0]->{name},

	'pdkname2=s' => \$PDK[1]->{name},

	'pdkloc1=s' => \$PDK[0]->{loc},

	'pdkloc2=s' => \$PDK[1]->{loc},

	'publish=s' => \$publishDir,

	'help!' => \$help,

));

if ($help)

{

	helpme();

	exit(0);

}

foreach my $pdkCount (0 .. $#PDK)

{

	if (scalar (grep {defined} keys %{$PDK[$pdkCount]}) == 0)

	{

		print "No data provided to identify PDK", $pdkCount + 1, "\n";

		helpme();

		exit (1);

	}

	if (scalar (grep { defined $_ } values %{$PDK[$pdkCount]}) > 1)

	{

		print "Multiple data provided to identify PDK", $pdkCount + 1, "\n";

		print values %{$PDK[$pdkCount]};

		helpme();

		exit (1);

	}

}

my $pdknb1 = $PDK[0]->{number} || "";

my $pdkname1 = $PDK[0]->{name} || "";

my $pdkloc1 = $PDK[0]->{loc} || "";

my $pdknb2 = $PDK[1]->{number} || "";

my $pdkname2 = $PDK[1]->{name} || "";

my $pdkloc2 = $PDK[1]->{loc} || "";

print "pdknb1=$pdknb1\n";

print "pdknb2=$pdknb2\n";

print "pdkname1=$pdkname1\n";

print "pdkname2=$pdkname2\n";

print "pdkloc1=$pdkloc1\n";

print "pdkloc2=$pdkloc2\n";

print "help=$help\n";

# Use the specified release location if supplied

$default_pdk_loc = $publishDir || $default_pdk_loc;

$default_pdk_loc =~ s{([^/\\])$}{$1\\};

# First PDK to check

my $pdk_path1="";

my $pdk_complete_name1=0;

my $pdk_complete_path1=0;

my $pdk_path1_exist=0;

my $pdk_zip1_exit=0; # Not necessary

my $pdk1_correct_name_to_use="";

my $loc1_contains_the_zip_file_we_need=0;

# Second PDK to check

my $pdk_path2="";

my $pdk_complete_name2=0;

my $pdk_complete_path2=0;

my $pdk_path2_exist=0;

my $pdk_zip2_exist=0; # Not necessary

my $pdk2_correct_name_to_use="";

my $loc2_contains_the_zip_file_we_need=0;		# Used to indicate that we have found the build_BOM.zip file

my $loc2_contains_the_xml_csv_files_we_need=0;	# Used to indicate that we have found the build-info.xml and PkgComponentAnalysisSummary.csv

my $nb_of_xml_csv_files_we_need=2;	# Used to define the number of files we need to have a look at when we are not looking for zip files.

my $nb_of_zip_files_we_need=2;	# Used to define the number of files we need to have a look at when we are looking for zip files.

# Default directory management

my @directories_list_default_location=();

my $nb_dir_in_default_loc;

my @pdk_dir_list_in_default_location=();

my @pdks_with_valid_zip_in_default_loc=();

my $nb_pdks_with_valid_zip_in_default_loc=0;

my @find_pdk_for_corresponding_nb1=();

my $nb_of_pdk_for_corresponding_nb1=0;

my @find_pdk_for_corresponding_nb2=();

my $nb_of_pdk_for_corresponding_nb2=0;

my @find_pdk_for_corresponding_name1=();

my $nb_of_pdk_for_corresponding_name1=0;

my @find_pdk_for_corresponding_name2=();

my $nb_of_pdk_for_corresponding_name2=0;

my @read_files_in_loc=();

# Data / statistics to be displayed in the release notes

# We consider that pdk1 is the old version and pdk2 is the new version.

# Note that for the moment, the scripts is not able to make sure that the old version of the pdk is set as pdk1 and the new version of the pdk is set as pdk2!!!!!

# Can be done for pdknb and pdkname but not for pdkloc as for the moment, no way to find out the pdk version from the build-info.xmL!!!!

# Totals

my $total_packages_pdk1=0;		# Nb of packages included in the pdk1

my $total_packages_pdk2=0;		# Nb of packages included in the pdk2

my $total_packages_added=0;		# Nb of packages added in the pdk2

my $total_packages_removed=0;	# Nb of packages removed from the pdk2

my $total_new_fcl=0;			# Nb of packages that are now on fcl in pdk2 (means were mcl in pdk1 and are now fcl in pdk2)

my $total_no_more_fcl=0;		# Nb of packages that are no more on fcl in pdk2 (means were fcl in pdk1 and are now mcl in pdk2)

my $total_still_fcl=0;			# Nb of packages that are still on fcl in pdk2 (means were fcl in pdk1 and are still fcl in pdk2)

my $total_very_good_mcl=0;		# Nb of packages that are very good on mcl in pdk1 and pdk2 (means were on mcl in pdk1 and are still mcl in pdk2)

# Tables

my @pdk1_sorting_table;			# Table for pdk1 that is used to sort out and compare the 2 pdks

my @pdk2_sorting_table;			# Table for pdk2 that is used to sort out and compare the 2 pdks

my @packages_added_table;		# Table that contains the packages that have been added to pdk2

my @packages_removed_table;		# Table that contains the packages that have been deleted from pdk2

my @new_fcl_table;				# Table containing the packages that are now on fcl in pdk2 (means were mcl in pdk1 and are now fcl in pdk2)

my @no_more_fcl_table;			# Table containing the packages that are no more on fcl in pdk2 (means were fcl in pdk1 and are now mcl in pdk2)

my @still_fcl_table;			# Table containing the packages that are still on fcl in pdk2 (means were fcl in pdk1 and are still fcl in pdk2)

my @very_good_mcl_table;		# Table containing the packages that are very good on mcl in pdk1 and pdk2 (means were on mcl in pdk1 and are still mcl in pdk2)

my %pckg_path_name_array;		# Table containing the path for each packages

my %pckg_name_array;			# Table containing the real meaning name for each packages, not the name of the package in the directory structure

if($pdknb1)

{

	$pdk_path1 = $default_pdk_loc;

	$pdk_complete_name1=1;

	$pdk_complete_path1=1;

}

if($pdknb2)

{

	$pdk_path2 = $default_pdk_loc;

	$pdk_complete_name2=1;

	$pdk_complete_path2=1;

}

if($pdkname1)

{

	$pdk_path1 = $default_pdk_loc;	

	$pdk_complete_path1=1;	

}

if($pdkname2)

{

	$pdk_path2 = $default_pdk_loc;	

	$pdk_complete_path2=1;

}

if($pdkloc1)

{

	$pdk_path1 = $pdkloc1;

}

if($pdkloc2)

{

	$pdk_path2 = $pdkloc2;

}

#

# If we reach this point, this means that we have the right numbers of arguments passed to the script.

#

print "\nWe are on the right path!!!!\n";

print "pdk_path1=$pdk_path1\n";

print "pdk_complete_name1=$pdk_complete_name1\n";

print "pdk_complete_path1=$pdk_complete_path1\n";

print "\n";

print "pdk_path2=$pdk_path2\n";

print "pdk_complete_name2=$pdk_complete_name2\n";

print "pdk_complete_path2=$pdk_complete_path2\n";

print "\n\n";

# Get directory listing of all directories in the default location $default_pdk_loc

extract_dir_default_loc();

extract_pdk_in_default_loc();

extract_pdk_with_valid_zip_in_default_loc();

# Compose path if necessary.

print "\n";

my $find_val=0;

if ($pdk_complete_path1)

{

	if ($pdk_complete_name1)

	{

		print "We have the PDK number, we need to define if possible the PDK name and therefore the path to the PDK\n";

		# Have a look in the default directory if there is a PDK with that number. If none or more than one with the same id, returns the list of PDKs with that same number

		foreach $find_val (@pdks_with_valid_zip_in_default_loc)

		{

			if($find_val =~ /$pdknb1/i)

			{

				$find_pdk_for_corresponding_nb1[$nb_of_pdk_for_corresponding_nb1++]=$find_val;

			}

		}

		print "Table find_pdk_for_corresponding_nb1 is:\n";

		display_array_one_line_at_the_time(@find_pdk_for_corresponding_nb1);

		if($nb_of_pdk_for_corresponding_nb1==1)

		{

			print "There is only $nb_of_pdk_for_corresponding_nb1 PDK with the name corresponding to the PDK number given, we can keep going!\n";

		}

		else

		{

			print "There is $nb_of_pdk_for_corresponding_nb1 PDKs with the same name, please select one in the list above and run the perl script again with the right PDK name\n";

			exit(0);

		}

		#extract PDK name if only one

		$pdk1_correct_name_to_use = $find_pdk_for_corresponding_nb1[0];

		$pdk_path1 .= $find_pdk_for_corresponding_nb1[0];

		print "pdknb1 = $pdknb1\n";

	}

	else

	{

		print "We have the PDK Name therefore we can define the path to the PDK\n";

		$pdk1_correct_name_to_use = $pdkname1;

		$pdk_path1 .= $pdkname1;

	}

	print "The PDK used is: $pdk1_correct_name_to_use\n";

	print "pdk_path1 = $pdk_path1\n";

}

$find_val=0;

if ($pdk_complete_path2)

{

	if ($pdk_complete_name2)

	{

		print "We have the PDK number, we need to define if possible the PDK name and therefore the path to the PDK\n";

		# Have a look in the default directory if there is a PDK with that number. If none or more than one with the same id, returns the list of PDKs with that same number

		foreach $find_val (@pdks_with_valid_zip_in_default_loc)

		{

			if($find_val =~ /$pdknb2/i)

			{

				$find_pdk_for_corresponding_nb2[$nb_of_pdk_for_corresponding_nb2++]=$find_val;

			}

		}

		print "Table find_pdk_for_corresponding_nb is:\n";

		display_array_one_line_at_the_time(@find_pdk_for_corresponding_nb2);

		if($nb_of_pdk_for_corresponding_nb2==1)

		{

			print "There is only $nb_of_pdk_for_corresponding_nb2 PDK with the name corresponding to the PDK number given, we can keep going!\n";

		}

		else

		{

			print "There is $nb_of_pdk_for_corresponding_nb2 PDKs with the same name, please select one in the list above and run the perl script again with the right PDK name\n";

			exit(0);

		}

		#extract PDK name if only one

		$pdk2_correct_name_to_use = $find_pdk_for_corresponding_nb2[0];

		$pdk_path2 .= $find_pdk_for_corresponding_nb2[0];

		print "pdknb2 = $pdknb2\n";

	}

	else

	{

		print "We have the PDK Name therefore we can define the path to the PDK\n";

		$pdk2_correct_name_to_use = $pdkname2;

		$pdk_path2 .= $pdkname2;

	}

	print "The PDK used is: $pdk2_correct_name_to_use\n";

	print "pdk_path2 = $pdk_path2\n";

}

# Find out if the locations are correct or not. We just need to make sure that the location contains the build_BOM.zip, if it's the case, then bingo! If not, exit the program.

my $loc_var;

if($pdkloc1)

{

	# Get the list of file in the location choosen.

	opendir(LOC1_DIR, $pdkloc1);

	@read_files_in_loc = readdir(LOC1_DIR);

	close(LOC1_DIR);

	foreach $loc_var (@read_files_in_loc)

	{

		if($loc_var =~ /$build_bom_zip_file_to_extract$/)

		{

			print "We found the file: $loc_var\n";

			$pdk1_correct_name_to_use = "PDK1";

			$pdk_path1 = $pdkloc1;

			print "The PDK used is: $pdk1_correct_name_to_use\n";

			print "pdk_path1 = $pdk_path1\n";

			$loc1_contains_the_zip_file_we_need=1;

			# As we have found the file, we can probably break!

		}

	}

	if(!$loc1_contains_the_zip_file_we_need)

	{

		print "We can't find the file $build_bom_zip_file_to_extract in the location $pdkloc2 and therefore we can't go any further!!\n";

		exit(0);

	}

}

print "\n";

if($pdkloc2)

{

	# Have a look at the zip files in the location choosen.

	opendir(LOC2_DIR, $pdkloc2);

	@read_files_in_loc = readdir(LOC2_DIR);	# Need to have a look at the sub directories too!!!!!!

	close(LOC2_DIR);	

	print "List of files in the directory: @read_files_in_loc\n";

	foreach $loc_var (@read_files_in_loc)

	{

		# Have a look for build_bom.zip and build_logs.zip

		if( ($loc_var =~ /$build_bom_zip_file_to_extract$/) || ($loc_var =~ /$build_logs_zip_file_to_extract$/) )

		{

			print "We found the file: $loc_var\n";

			$loc2_contains_the_zip_file_we_need++;

		}

	}

	if(!$loc2_contains_the_zip_file_we_need) # If we have the zip file, no need to have a look for the csv and xml files!

	{

		my $local_var_path;

		print "We are checking for xml file\n";

		$local_var_path = "$pdkloc2\\$bom_dir";

		print "local_var_path = $local_var_path\n";

		opendir(LOCBOM_DIR, $local_var_path);

		@read_files_in_loc = readdir(LOCBOM_DIR);

		close(LOCBOM_DIR);

		print "List of files in the directory: @read_files_in_loc\n";

		foreach $loc_var (@read_files_in_loc)

		{			

			if($loc_var =~ /$name_of_file_to_compare$/)

			{

				print "We are in the case of the build and instead of looking for zip files, we need to have a look for $name_of_file_to_compare\n";

				print "We found the file: $loc_var\n";

				$loc2_contains_the_xml_csv_files_we_need++;

			}

		}

		print "We are checking for csv file\n";

		$local_var_path = "$pdkloc2\\$analysis_dir";

		print "local_var_path = $local_var_path\n";

		opendir(LOCANALYSIS_DIR, $local_var_path);

		@read_files_in_loc = readdir(LOCANALYSIS_DIR);

		close(LOCANALYSIS_DIR);

		print "List of files in the directory: @read_files_in_loc\n";

		foreach $loc_var (@read_files_in_loc)

		{

			if($loc_var =~ /$pckg_extraction_data_file_name$/)

			{

				print "We are in the case of the build and instead of looking for zip files, we need to have a look for $pckg_extraction_data_file_name\n";

				print "We found the file: $loc_var\n";

				$loc2_contains_the_xml_csv_files_we_need++;

			}

		}

	}

	if(($loc2_contains_the_zip_file_we_need==$nb_of_zip_files_we_need) || ($loc2_contains_the_xml_csv_files_we_need==$nb_of_xml_csv_files_we_need))

	{

		$pdk2_correct_name_to_use = "PDK2";

		$pdk_path2 = $pdkloc2;

		print "The PDK used is: $pdk2_correct_name_to_use\n";

		print "pdk_path2 = $pdk_path2\n";

		if($loc2_contains_the_xml_csv_files_we_need==$nb_of_xml_csv_files_we_need)

		{

			$location_of_file_to_publish=$pdkloc2;

			print "location_of_file_to_publish=$location_of_file_to_publish\n";

		}

	}

	else

	{

		if($loc2_contains_the_xml_csv_files_we_need<=$nb_of_xml_csv_files_we_need)

		{

			print "We can't find the files $name_of_file_to_compare and/or $pckg_extraction_data_file_name in the location $pdkloc2 and therefore we can't go any further!!\n";

		}

		else

		{

			print "We can't find the files $build_bom_zip_file_to_extract in the location $pdkloc2 and therefore we can't go any further!!\n";

		}

		exit(0);

	}

}

print "\n";

print "If we are here, this means that both $build_bom_zip_file_to_extract have been found and we can start the real work to compare the 2 files to extract what we need!\n";

print "This is the value for the path we are looking at for pdk_path1: $pdk_path1\n";

print "This is the value for the path we are looking at for pdk_path2: $pdk_path2\n";

# When we are at this point, we know we have 2 build_BOM.zip files that we can compare them!!!!

my $system_cmd = "";

my $working_dir="$working_drive\\$working_directory\\$working_sub_directory";

my $working_dir1="$working_drive\\$working_directory\\$working_sub_directory\\$working_pdk1_directory";

my $working_dir2="$working_drive\\$working_directory\\$working_sub_directory\\$working_pdk2_directory";

# 1st step is to extract the 2 zip files to allow us to have access to build-info.xml

# Extract just one file from the zip file using "7z e -r -oOutput_Directory"

#7z e -r build_BOM.zip build-info.xml

# Where 7z is the unzip program

# Where e is for extraction of a file

# Where -r is for recursive to make sure we have a look in the subdirectories

# Where -oOutput_Directory is the directory where we want the files to be unzipped

#

# Where $working_sub_directory is the directory where we will be carry the work to be done for the script.

# Where $working_pdk1_directory is the subdirectory destination for the PDK1

# Where $build_bom_zip_file_to_extract is the name of the zip file (in our case: build_BOM.zip)

# Where $pdk_path1 is the place where the zip file to unzip is

# where $name_of_file_to_compare is the name of the file we want to extract from the zip file (in our case: build-info.xml)

# Example: 7z e -r -oc:\temp\fcl_extraction\pdk1 C:\temp\Task243Test\PDK_1\build_BOM.zip build-info.xml

# Extract file from 1st PDK

$system_cmd = "7z e -r -o$working_dir1 $pdk_path1\\$build_bom_zip_file_to_extract $name_of_file_to_compare";

print "Exec: $system_cmd\n";

system($system_cmd);