#!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:
#
# Description:
# Generate the BRAG-compatible XML summary of the Raptor log from the CSV output of the raptor parser

use strict;

use FindBin;
use lib "$FindBin::Bin";

use XML::Parser;
#use Getopt::Long;

use ToBrag;

my $raptorLogGlob = shift or die "First argument must be raptor XML log to read\n";
shift and die "Only one argument please\n";

@ARGV = glob $raptorLogGlob;

# Start to build structure to be output as XML (same format as XML::Parser would create for us)
my ($doc, $buildStatus) = ToBrag::createDocumentAndRoot("buildStatus");
# Obtain a phase object
my $buildPhase = ToBrag::ensureChild($buildStatus, "phase", "name", "Build");

# Parse the Raptor logs
# (Use XML::Parser in "Stream" mode so we don't have to hold all the data in memory at the same time)
my $xml = XML::Parser->new(Style => "Stream", Pkg => "main");

foreach my $log (@ARGV)
{
	$xml->parsefile($log);
}

print "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
print "<?xml-stylesheet type='text/xsl' href='brag.xsl'?>\n";
ToBrag::printTree($doc->[0]);
print "\n";

exit (0);

my $recipeContext;
my $errorContext;

sub StartTag
{
	my $expat = shift;
	my $tagName = shift;
	my %attrib = %_;

	if ($tagName eq "recipe")
	{
		$recipeContext = {%attrib};
	}
	elsif ($tagName eq "status")
	{
		$recipeContext->{"exit"} = $attrib{"exit"};
	}
	elsif ($tagName eq "error")
	{
		$errorContext = {%attrib};
	}
}
sub EndTag
{
	my $expat = shift;
	my $tagName = shift;

	if ($tagName eq "recipe")
	{
		die unless $recipeContext;

		if ($recipeContext->{"exit"} ne "ok")
		{
			# Create a more readable error message
			my %errorIdToDetail = (
				tem => {message => "Failed to execute '$recipeContext->{source}' invoked via $recipeContext->{bldinf}", severity => "major"},
				msvctoolscompile => {message => "Failed to compile $recipeContext->{source}", severity => "minor"},
				compile => {message => "Failed to compile $recipeContext->{source}", severity => "minor"},
				compile2object => {message => "Failed to compile $recipeContext->{source}", severity => "minor"},
				win32compile2object => {message => "Failed to compile $recipeContext->{source}", severity => "minor"},
				tools2lib => {message => "Failed to build library $recipeContext->{target}", severity => "minor"},
				ar => {message => "Failed to build library $recipeContext->{target}", severity => "minor"},
				win32archive => {message => "Failed to build library $recipeContext->{target}", severity => "minor"},
				win32def2lib => {message => "Failed to build DLL entry point library $recipeContext->{target}", severity => "minor"},
				"link" => {message => "Failed to create symbols for $recipeContext->{target}", severity => "minor"},
				postlink => {message => "Failed to link $recipeContext->{target}", severity => "minor"},
				win32stageonelink => {message => "Failed to link $recipeContext->{target} (stage 1)", severity => "minor"},
				win32stagetwolink => {message => "Failed to link $recipeContext->{target}", severity => "minor"},
				win32simplelink => {message => "Failed to link $recipeContext->{target}", severity => "minor"},
				win32processexports => {message => "Failed to export $recipeContext->{source} to $recipeContext->{target}", severity => "minor"},
				tracecompile => {message => "Trace compile failure for $recipeContext->{target}", severity => "unknown"},
				extension_makefile => {message => "Failed within an extension makefile connected to $recipeContext->{bldinf}", severity => "major"},
			);

			my $message = $errorIdToDetail{$recipeContext->{name}}->{message} || "Unknown failure tag '$recipeContext->{name}' ($recipeContext->{source} -> $recipeContext->{target})";
			$recipeContext->{severity} = $errorIdToDetail{$recipeContext->{name}}->{severity} || "unknown";

			# Obtain a step object
			my $step = ToBrag::ensureStep($buildPhase, $recipeContext->{config});
			# Also create empty <failures> tags with severities in a sensible order
			ToBrag::ensureFailureSet($step, "critical");
			ToBrag::ensureFailureSet($step, "major");
			ToBrag::ensureFailureSet($step, "minor");
			# Obtain a failures object
			my $failureSet = ToBrag::ensureFailureSet($step, $recipeContext->{severity});

			# Now create the failure itself, and add it to this failure set
			my $failureItem = bless {
				Kids => [ bless { Kids => [ bless { Text => $message }, "Characters" ]}, "effect" ],
			}, "failure";
			if ($recipeContext->{component})
			{
				$recipeContext->{bldinf} =~ s{^\w:(/sf/.*?/.*?)/.*$}{$1};
				$failureItem->{package} = $recipeContext->{bldinf};
			}
			my @causes = grep { $_ && ! m/^\+ / } split("\n", $recipeContext->{Chars});
			@causes = map { "  $_" } @causes;
			if (@causes)
			{
				my @reportedCauses = @causes[0 .. min($#causes, 49)];
				my $causesItem = bless {
					Kids => [ bless { Text => join "\n", @reportedCauses }, "Characters" ]
				}, "causes";
				push @{$failureItem->{Kids}}, $causesItem;
				my $unreportedCauses = scalar @causes - scalar @reportedCauses;
				$failureItem->{unreported_causes} = $unreportedCauses;
			}
			push @{$failureSet->{Kids}}, $failureItem, $ToBrag::xmlNewline;
		}
		
		$recipeContext = undef;
	}
	elsif ($tagName eq "error")
	{
		die unless $errorContext;

		# Add error to output tree

		my $severity = "unknown";
		my @messageInterpretation = (
			{regexp => qr{Cannot process schema version .* of file}, severity => "critical"},
			{regexp => qr{No bld\.inf found at}, severity => "major"},
			{regexp => qr{^Preprocessor exception}, severity => "major"},
			{regexp => qr{No such file or directory$}, severity => "major"},
			{regexp => qr{Can't find mmp file}, severity => "minor"},
			{regexp => qr{The make-engine exited with errors}, severity => "critical"},
			{regexp => qr{tool 'MS_.+?' from config '.*' did not return version '.*' as required\.}, severity => "inconsequential"},
			{regexp => qr{tool '.+?' from config '.*' did not return version '.*' as required\.}, severity => "critical"},
			{regexp => qr{Unknown build configuration '.*'}, severity => "critical"},
			{regexp => qr{No build configurations given}, severity => "critical"},
			{regexp => qr{Source of export does not exist:}, severity => "minor"},
			{regexp => qr{Could not export}, severity => "minor"},
			{regexp => qr{Could not export}, severity => "minor"},
			{regexp => qr{Source zip for export does not exist:}, severity => "minor"},
			{regexp => qr{^(INCLUDE|LIB) is not set in the environment and has no default}, severity => "inconsequential"},
		);

		foreach (@messageInterpretation)
		{
			if ($errorContext->{Chars} =~ $_->{regexp})
			{
				$severity = $_->{severity};
				last;
			}
		}

		# Obtain a step object
		my $step = ToBrag::ensureStep($buildPhase, "Raptor Initialisation");
		# Also create empty <failures> tags with severities in a sensible order
		ToBrag::ensureFailureSet($step, "critical");
		ToBrag::ensureFailureSet($step, "major");
		ToBrag::ensureFailureSet($step, "minor");
		# Obtain a failures object
		my $failureSet = ToBrag::ensureFailureSet($step, $severity);

		# Now create the failure itself, and add it to this failure set
		my $failureItem = bless {
			Kids => [ bless { Kids => [ bless { Text => $errorContext->{Chars} }, "Characters" ]}, "effect" ],
		}, "failure";
		push @{$failureSet->{Kids}}, $failureItem, $ToBrag::xmlNewline;

		$errorContext = undef;
	}
}
sub Text
{
	s/^\n*//;
	if ($recipeContext)
	{
		$recipeContext->{Chars} .= $_;
	}
	elsif ($errorContext)
	{
		$errorContext->{Chars} .= $_;
	}
}

sub min
{
	return ($_[0] < $_[1]) ? $_[0] : $_[1] ;
}