#!perl

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

# All rights reserved.

# This component and the accompanying materials are made available

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

#

use strict;

use Getopt::Long;

use Cwd;

use XML::Simple;

use FindBin;

use lib "$FindBin::Bin";

my $Now = &Today;

my $IncludesRestrictedSource = 0;

my $ZippedCatA = 0;

my $ZippedCatX = 0;

my $WorkPath = uc cwd;

$WorkPath =~s-/-\\-go;            # replace forward slash with backslash

$WorkPath =~s/^(.:)(\S+)$/$2/o;   # remove drive letter

my $WorkDrv = $1;

$WorkPath =~s-^(.*[^\\])$-$1\\-o; # ensure it ends with a backslash

my %HTMLFileErrors = ();

my %ASCIIFileErrors = ();

my %Components = ();

my %ComponentsUsed = ();

my @UnrepresentedComponents = ();

my %Cmdopts = ();

unless (GetOptions( \%Cmdopts, "cats|c=s", "dir|d=s", "export|e", "full|f:i",

        "genpkg|g=s", "help|h", "licensee|l=s", "manifest|m=s", "nosub|n", "overrideexpiry|o",

        "project|p=s", "report|r=s", "showfiles|s", "xclude|x=s", "zip|z=s",

        "outdir=s"))

  {

  print "For help, use -h option\n";

  exit 1;

  }

if (@ARGV && ($ARGV[0]=~/help/io || $ARGV[0]=~/\?/io))

  {

  &Usage();

  }

# Open Schedule12 File for Component name checking

if ($Cmdopts{'report'})

{

    my $Build = $Cmdopts{'report'};

    my $Version = $1 if ( $Build =~ /Symbian_OS_v(.*)/i );

    # Define the source root directory (assumes it's 3 levels up)

    my $sourcedir = Cwd::abs_path("$FindBin::Bin\\..\\..\\..");

    my $Schedule12File = "$sourcedir\\os\\deviceplatformrelease\\symbianosbld\\cedarutils\\Symbian_OS_v"."$Version"."_Schedule12.xml";

    my $xml = new XML::Simple;

    my $Schedule12 = $xml->XMLin($Schedule12File);

    my $CommonReplaceable = %$Schedule12->{'CR'};

    for (keys %$CommonReplaceable)

    {

        $Components{$_} = "Common Replaceable";

        $ComponentsUsed{$_} = 0;

    }

    my $CommonSymbian = %$Schedule12->{'CS'};

    for (keys %$CommonSymbian)

    {

        $Components{$_} = "Common Symbian";

        $ComponentsUsed{$_} = 0;

    }

    my $OptionalReplaceable = %$Schedule12->{'OR'};

    for (keys %$OptionalReplaceable)

    {

        $Components{$_} = "Optional Replaceable";

        $ComponentsUsed{$_} = 0;

    }

    my $OptionalSymbian = %$Schedule12->{'OS'};

    for (keys %$OptionalSymbian)

    {

        $Components{$_} = "Optional Symbian";

        $ComponentsUsed{$_} = 0;

    }

    my $ReferenceTest = %$Schedule12->{'REF'};

    for (keys %$ReferenceTest)

    {

        $Components{$_} = "Reference/Test";

        $ComponentsUsed{$_} = 0;

    }

    my $ReferenceTest = %$Schedule12->{'TEST'};

    for (keys %$ReferenceTest)

    {

        $Components{$_} = "Reference/Test";

        $ComponentsUsed{$_} = 0;

    }

    my $ReferenceTest = %$Schedule12->{'RT'};	# v9.1 style combined Ref/Test

    for (keys %$ReferenceTest)

    {

        $Components{$_} = "Reference/Test";

        $ComponentsUsed{$_} = 0;

    }

}

# Handle -h flag

# --------------

if ($Cmdopts{'help'})

  {

  &Usage();

  }

# --------------

# Handle -c flag

# --------------

my $Categories = 'EFGOT';

if ($Cmdopts{'cats'})

  {

  if ($Cmdopts{'cats'} =~ /[^A-GIOTX]/i)

    {

    &NotifyError("Unrecognised category list \"$Cmdopts{'cats'}\" ignored");

    }

  else

    {

    $Categories = uc($Cmdopts{'cats'});

    }

  }

# --------------

# Handle -d flag

# --------------

my @TopDirs;

if (!$Cmdopts{'dir'})

  {

  $TopDirs[0] = $WorkPath;

  }

else

  {

  if (!(-e $Cmdopts{'dir'}))

    {

    die "$Cmdopts{'dir'} does not exist\n";

    }

  if (-d $Cmdopts{'dir'})

    {

    $TopDirs[0] = $Cmdopts{'dir'};

    }

  else

    {

    @TopDirs = &ReadDirFile($Cmdopts{'dir'});

    }

  @TopDirs = &MakeAbs($WorkPath, @TopDirs);

  foreach my $p (@TopDirs)

    {

    $p = &ValidateIncPath($p);

    }

  }

# --------------

# Handle -e flag

# --------------

my $ForceExport = $Cmdopts{'export'} ? 1 : 0;

# --------------

# Handle -f flag

# --------------

my $Full = $Cmdopts{'full'} || 0;

# --------------

# Handle -g flag

# --------------

my $PkgFile;

my $GenPkg = $Cmdopts{'genpkg'} ? 1 : 0;

if ($GenPkg)

  {

  $PkgFile = $Cmdopts{'genpkg'};

  if (index($PkgFile, "\.") < 0)

    {

    $PkgFile .= "\.xml";

    }

  if ((-e $PkgFile) and (-f $PkgFile))

    {

    unlink ($PkgFile) or die "Can't overwrite $PkgFile\n";

    }

  open PKGLIST, ">$PkgFile" or die "Can't open $PkgFile\n";

  }

# --------------

# Handle -l flag

# --------------

my $Recipient = 'generic';

if ($Cmdopts{'licensee'})

  {

  $Recipient = lc($Cmdopts{'licensee'});

  }

# --------------

# Handle -m flag

# --------------

my $Manifest = $Cmdopts{'manifest'} ? 1 : 0;

if ($Manifest)

  {

  my $MfsFile = $Cmdopts{'manifest'};

  if (index($MfsFile, "\.") < 0)

    {

    $MfsFile .= "\.txt";

    }

  if ((-e $MfsFile) and (-f $MfsFile))

    {

    unlink ($MfsFile) or die "Can't overwrite $MfsFile\n";

    }

  open MFSLIST, ">$MfsFile" or die "Can't open $MfsFile\n";

  }

# --------------

# Handle -n flag

# --------------

my $SubDirs = $Cmdopts{'nosub'} ? 0 : 1;

# --------------

# Handle -o flag

# --------------

my $OverrideExpiry = $Cmdopts{'overrideexpiry'} ? 1 : 0;

# --------------

# Handle -outdir flag

# --------------

my $outdir = $Cmdopts{'outdir'};

# --------------

# Handle -p flag

# --------------

my $Project = 'generic';

if ($Cmdopts{'project'})

  {

  $Project = lc($Cmdopts{'project'});

  }

# --------------

# Handle -s flag

# --------------

my $ShowFiles = $Cmdopts{'showfiles'} ? 1 : 0;

# --------------

# Handle -x flag

# --------------

my @XDirs;

if (!$Cmdopts{'xclude'})

  {

  $XDirs[0] = "";

  }

else

  {

  if (!(-e $Cmdopts{'xclude'}))

    {

    die "Exclusion $Cmdopts{'xclude'} does not exist\n";

    }

  if (-d $Cmdopts{'xclude'})

    {

    $XDirs[0] = $Cmdopts{'xclude'};

    }

  else

    {

    @XDirs = &ReadDirFile($Cmdopts{'xclude'});

    }

  @XDirs = &MakeAbs($WorkPath, @XDirs);

  foreach my $p (@XDirs)

    {

    $p = &ValidateExcPath($p);

    }

  }

# --------------

# Handle -z flag

# --------------

my $ZipFile;

my $ZipTmpFile;

my $ZipLogFile;

my $Zip = $Cmdopts{'zip'} ? 1 : 0;

if ($Zip)

  {

   if ( &FindZip == 0 )

   {

      die "Cannot find zip.exe in path. $?\n";

   }

  $ZipFile = $Cmdopts{'zip'};

  if (index($ZipFile, "\.") < 0)

    {

    $ZipFile .= "\.zip";

    }

  $ZipLogFile = $ZipFile . "log";

  $ZipTmpFile = $ZipFile . "tmp";

  if ((-e $ZipFile) and (-f $ZipFile))

    {

    unlink ($ZipFile) or die "Can't overwrite $ZipFile\n";

    }

  if ((-e $ZipTmpFile) and (-f $ZipTmpFile))

    {

    unlink ($ZipTmpFile) or die "Can't overwrite $ZipTmpFile\n";

    }

  open ZIPLIST, ">$ZipTmpFile" or die "Can't open $ZipTmpFile\n";

  }

# --------------

# print Pkg header

# --------------

  if ($GenPkg)

    {

    &PkgPrint ("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");

    &PkgPrint ("\n");

    &PkgPrint ("<packagedef version=\"1.0\">\n");

    &PkgPrint ("   <package name=\"$PkgFile\" major-version=\"0\" minor-version=\"0\">\n");

    &PkgPrint ("     <supplier>Symbian Ltd</supplier>\n");

    &PkgPrint ("     <sdk-version>7.0</sdk-version>\n");

    &PkgPrint ("   </package>\n");

    &PkgPrint ("\n");

    &PkgPrint ("   <manifest>\n");

    }

#------ Do the report header ------

my $temp ="IPR Report, ".&DateValToStr($Now);

&DataPrint("$temp\n");

$temp = '-' x length($temp);

&DataPrint("$temp\n");

&DataPrint ("Report type:                  ");

if ($Full < 0)

  {

  &DataPrint ("No IPR data\n") ;

  }

else

  {

  &DataPrint ($Full ? "Full IPR data\n" : "Reduced IPR data\n");

  }

&DataPrint ("Recipient:                    ", ucfirst($Recipient), "\n");

&DataPrint ("Include DTI restricted files: ", $ForceExport ? 'Yes' : 'No', "\n");

&DataPrint ("Include time-expired files:   ", $OverrideExpiry ? 'Yes' : 'No', "\n");

&DataPrint ("List selected files:          ", $ShowFiles ? 'Yes' : 'No', "\n");

&DataPrint ("\n");

#------ Do header for standard section ------

$temp ="Standard source for ".ucfirst($Recipient);

&DataPrint ("$temp\n");

$temp = '-' x length($temp);

&DataPrint ("$temp\n");

&DataPrint ("Categories:                   $Categories\n");

&DataPrint ("Include subdirectories:       ", $SubDirs ? 'Yes' : 'No', "\n");

&DataPrint ("Top level directories:\n");

foreach my $name (@TopDirs)

  {

  &DataPrint ("                              $name\n");

  }

&DataPrint ("\n");

&ProcessDir(@TopDirs, $SubDirs, 1, $Manifest);

#------ Do optional header for extra section ------

if (($Project ne 'generic') and (-e "$Project\.extra"))

  {

  my @ExtraDirs = ReadDirFile("$Project\.extra");

  @ExtraDirs = &MakeAbs($WorkPath, @ExtraDirs);

  foreach my $p (@ExtraDirs)

    {

    $p = &ValidateIncPath($p);

    }

  &DataPrint ("\n");

  $temp ="Extra source for ".ucfirst($Project);

  &DataPrint ("$temp\n");

  $temp = '-' x length($temp);

  &DataPrint ("$temp\n");

  $Categories = 'ABCDEFGIOTX';

  &DataPrint ("Categories:                   $Categories\n");

  &DataPrint ("Include subdirectories:       No\n");

  &DataPrint ("Additional directories:\n");

  foreach my $name (@ExtraDirs)

    {

    if ($name)

      {

      &DataPrint ("                              $name\n");

      }

    }

  &DataPrint ("\n");

  &ProcessDir(@ExtraDirs, 0, 0, 0); # Note, no extra directories in a product manifest

  }

if ($Zip)

  {

   if ( &FindZip == 0 )

   {

      die "Cannot find zip.exe in path. $?\n";

   }

   close ZIPLIST;

   `zip -@ $ZipFile <$ZipTmpFile >$ZipLogFile`;

   unlink ($ZipTmpFile);

  }

if ($Manifest)

  {

  close MFSLIST;

  }

# --------------------------

# print Pkg footer and close

# --------------------------

if ($GenPkg)

  {

  &PkgPrint ("   </manifest>\n");

  &PkgPrint ("</packagedef>\n");

  close PKGLIST;

  }

#------ Do optional warning for restricted export source ------

&ExportWarning() if ($IncludesRestrictedSource);

&NotifyWarning("zip file contains Category A source\n") if ($ZippedCatA);

&NotifyWarning("zip file contains uncategorised source\n") if ($ZippedCatX);

if ($Cmdopts{'report'})

    {

    #------ Produce Distribution Policy File Error Report --------

    my ( $s, $min, $hour, $mday, $mon, $year, $w, $y, $i)= localtime(time);

    $year+= 1900;

    $mon++;

    my $builddir = $outdir;

    if (!defined $builddir)

    	{

    	# Assume default setup for Symbian build machines...

    	$builddir = Cwd::abs_path("$FindBin::Bin\\..\\..\\..\\..");

    	$builddir.= "\\logs\\cedar";

    	}

    open HTMLOUTFILE, ">> $builddir\\$Cmdopts{'report'}_Distribution_Policy_Report.html";

    open ASCIIOUTFILE, ">> $builddir\\$Cmdopts{'report'}_Distribution_Policy_Report.txt";

    foreach my $key (sort keys %ComponentsUsed)

    {

        push @UnrepresentedComponents, $key if ($ComponentsUsed{$key} == 0);

    }

    my $UnrepCKLComponents = @UnrepresentedComponents;

    my $NonCompliantFiles = scalar(keys %ASCIIFileErrors);

    print HTMLOUTFILE <<HEADING_EOF;

    <html><head><title>Distribution Policy File Report for $Cmdopts{'report'}</title></head>

    <body>

    <h1><center>Distribution Policy File Report<br>for<br>$Cmdopts{'report'}</center></h1>

    <h2><center>Created - $mday/$mon/$year</center></h2>

    <hr width=60% size=1 noshade> <p><p><p><p>

    <TABLE BORDER Align=center>

    <TH COLSPAN=2><font color=red>Report Summary</font></TH>

    <TR><TD>Total number of Non-compliant Files</TD><TD><b>$NonCompliantFiles</b></TD></TR>

    <TR><TD>Total number of Unrepresented CKL Components</TD><TD><b>$UnrepCKLComponents</b></TD></TR>

    </TABLE><p><p><p><p>

    <TABLE BORDER ALIGN=center>

    <TH COLSPAN=2>Non-Compliant Files</font></TH>

    <TR><TH>File Location</TH><TH>Errors</TH></TR>

HEADING_EOF

    print ASCIIOUTFILE <<HEADING_EOF;

Distribution Policy File Report for $Cmdopts{'report'}

Created - $mday/$mon/$year

================================

HEADING_EOF

    foreach my $key (sort keys %ASCIIFileErrors)

    {

        my $path = lc $key;

        $path =~ s/^.*?\\master\\.*?\\src\\/\\src\\/i;

        print HTMLOUTFILE "<TR><TD><font face=verdana size=4>$path</TD><TD>@{$HTMLFileErrors{$key}}</TD></TR>";

        print ASCIIOUTFILE "@{$ASCIIFileErrors{$key}}";

    }

    print HTMLOUTFILE "</TABLE><p><p><p><p>";

    if (@UnrepresentedComponents != 0)

    {

        print HTMLOUTFILE "<TABLE BORDER ALIGN=center>";

        print HTMLOUTFILE "<TR><TH>Unrepresented Components</TH></TR>";

        foreach my $component (@UnrepresentedComponents)

        {

            print HTMLOUTFILE "<TR><TD>Component '$component' as recorded in

                Schedule 12 of the CKL has no representation in any of the source directories that are used to build this product</TD></TR>";

            print ASCIIOUTFILE "Unrepresented Component, Component '$component' as recorded in Schedule 12 of the CKL has no representation in any of the source directories that are used to build this product.\n";

        }

        print HTMLOUTFILE "</TABLE>";

    }

    close HTMLOUTFILE;

    close ASCIIOUTFILE;

    }

sub ProcessDir

{

my $ForManifest = pop @_;

my $ObeyExcludes = pop @_;

my $Subdirs =  pop @_;

my $Category = 'X';

my $ExpiryDate = 0;

my $NoExport = 0;

my $Skip = 0;