#

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

# All rights reserved.

# This component and the accompanying materials are made available

# under the terms of "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 module contains common helper functions for 

# handling excel sheets from perl.

# Version 0.9

#    - now checking that Int and Real values are really 

#      numbers

#    - rfs, cust config and backup are must fields for variant row

#    - All rows, which have "Comment:" in the uid name are ignored.

###################################################

###################################################

package cenrep_keys;

##########################################

# Libraries used

##########################################

use strict;

use Win32::OLE qw(in with);

use Win32::OLE::Const 'Microsoft Excel';

use Exporter ();     # Needed to make constants available to caller.

use excel_support;    # opening/closing workbook, etc.. functions.

##########################################

# Defining all the "global" variables, that we are using.

##########################################

use vars qw(

            @ISA

            @EXPORT

            );

@ISA = qw(Exporter); # Inherit from Exporter module (import method needed).

# Define all the functions defined by this module

use subs qw(

	    hasValue

	    addHash

	    readCol

	    readCentrepKeyInfo

	    checkCentrepKeyInfo

	    checkCentrepKeySheetName

	    );

##########################################

# Define the exports from this module that can be used

# Outside

##########################################

@EXPORT = qw(

	     &addHash

	     &readCol

             &readCentrepKeyInfo

	     &checkCentrepKeyInfo

	     &checkCentrepKeySheetName

             );

my $globalMaxColCount = 43;

my $globalMaxEmptyRowCount = 10;

#######################################

# Checks that the cell exists and has some value

#

# Params: refToWorkSheet,row,column

#

# Return: 1 if the cell had some value

#         0 if the cell did not have a value

#######################################

sub hasValue

{

    my $refToWorksheet = shift;

    my $row = shift;

    my $col = shift;

    if($col < 1)

    {

	return 0;

    }

    if(defined($$refToWorksheet->Cells( $row, $col  )->{ 'Value' }))

    {

	return 1;

    }

    if(!(defined($$refToWorksheet->Cells( $row, $col  ))  ||$$refToWorksheet->Cells( $row, $col  )->{ 'Value' }))

    {

	print "$row $col\n";

	print $$refToWorksheet->Name,"\n";

    }

    if($$refToWorksheet->Cells( $row, $col  )->{ 'Value' } !~ /^\s*$/)

    {

	return 1;

    }

    return 0;

}

#######################################

# Reads a cell value from given worksheet and given place.

# If the value is empty then initializes teh return value to the

# given default value

#

# Params: refToWorkSheet,row,column,defValue

#

# Return: the read value

#######################################

sub readCol

{

    my $refToWorksheet = shift;

    my $row = shift;

    my $col = shift;

    my $defValue = shift;

    my $retVal = undef;

    if($col > 0)

    {

	$retVal = $$refToWorksheet->Cells( $row, $col  )->{ 'Value' };

    }

    if(!defined($retVal) || $retVal =~ /^\s*$/)

    {

	$retVal = $defValue;

    }

    return $retVal;

}

#######################################

# If there is no given key defined in the given hash, then

# adds a key to point to a new hash

#

# Params: newKey,refToHash,refToHash

#

# Return: ref to added hash, or existing hash

#######################################

sub addHash

{

    my $key = shift;

    my $refToHash = shift;

    if(! defined( $$refToHash{$key}))

    {

	my %newHash;

	$$refToHash{$key} = \%newHash;

    }

    return $$refToHash{$key};

}

###########################################################################

#

###########################################################################

sub addCapability

{

    my $refToRList = shift;

    my $refToWList = shift;

    my $capaColumnValue = shift;

    my $capaName = shift;

    if($capaColumnValue =~ /R/i)

    {

	push(@$refToRList,$capaName);

    }

    if($capaColumnValue =~ /W/i)

    {

	push(@$refToWList,$capaName);

    }

}

###########################################################################

#

###########################################################################

sub readIndexes

{

   my $refToWorksheet = shift;

   my @retList;

   push(@retList,getIndexByColName($refToWorksheet,"Uid Name",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Uid Value",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Range From",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Range To",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Key Name",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Key Int",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Shared Data Name",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Removed",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Platform Release",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Variant Name",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Def Value",$globalMaxColCount));

   my $index = getIndexByColName($refToWorksheet,"Read Only",$globalMaxColCount);

   if($index  < 0)

   {

       $index = getIndexByColName($refToWorksheet,"Read  Only",$globalMaxColCount);

   }

   push(@retList,$index);

   push(@retList,getIndexByColName($refToWorksheet,"Key Type",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Backup",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"RFS",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Cust Config",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"None",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"All",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"All - TCB",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"NetworkServices",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"LocalServices",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"ReadUserData",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"WriteUserData",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Location",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"ReadDeviceData",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"WriteDeviceData",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"ProtServ",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"DRM",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"SwEvent",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"PowerMgmt",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"AllFiles",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"DiskAdmin",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"NetworkControl",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"MultiMediaDD",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"CommDD",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"TCB",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"TrustedUI",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"AlwaysPass",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"UserEnvironment",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"SurroundingsDD",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"SID Read",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"SID Write",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Range From",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Range To",$globalMaxColCount));

   push(@retList,getIndexByColName($refToWorksheet,"Owner",$globalMaxColCount));

   return @retList;

}

###########################################################################

# Function that reads all columns from the central repository sheet to the 

# given hash.

# The format of the returned hash is:

#  {

#  <uid> => 

#    {

#    "name" => <uidName>

#    "uid_specific"  

#           = > {

#               <variant>

#                   => {

#                      <release> 

#                          => { 

#                              "R" => (<capa1ForReading>,<capa2ForReading>)

#                              "W" => (<capa1ForWriting>,<capa2ForWriting>)

#                              "RSid" => (<sidForReading>)

#                              "WSid" => (<sidForWriting>)

#                              "owner" => <ownerSid>

#                              "rfs"  => <0/1>

#                              "backup"  => <0/1>

#                              }

#                      }

#               }

#    "ranges" 

#           => {

#              <rangeFrom> 

#                => {                  

#                   "common" => (   # == defined in range row

#                                "removed" => <release> [optional, only if specified]

#                                }

#                   "to" => {

#                          <rangeTo>

#                            => {

#                                <variant>

#                                    => {

#                                       <release> 

#                                            => { 

#                                               "R" => (<capa1ForReading>,<capa2ForReading>)

#                                               "W" => (<capa1ForWriting>,<capa2ForWriting>)

#                                               "RSid" => (<sidForReading>)

#                                               "WSid" => (<sidForWriting>)

#                                               "rfs"  => <0/1>

#                                               "backup"  => <0/1>

#                                               }

#                                        }

#                                }

#                             }   

#                      }

#                   }   

#              } # ranges end                

#    "keys" => {

#              <keyInt> 

#                   => {

#                      "common" => (   # == defined in key row

#                                  "name" => <keyName>

#                                  "sheetName" => <eexcelSheetName, from which this key was read>

#                                  "sd-name" => <sharedDataName> [optional, only if specified]

#                                  "read-only" => <0/1>

#                                  "key type" => <bin/int/str/bool>

#                                  "removed" => <release> [optional, only if specified]

#                                  "owner" => <ownerName>

#                                  "entity" => <ownerEntity>

#                                  }

#                      "release"

#                           => {

#                              <variant>  # "default" is special case

#                                 => {

#                                    <release> 

#                                        => { 

#                                           "R" => (<capa1ForReading>,<capa2ForReading>)

#                                           "W" => (<capa1ForWriting>,<capa2ForWriting>)

#                                           "RSid" => (<sidForReading>)

#                                           "WSid" => (<sidForWriting>)

#                                           "value" => <value>

#                                           "rfs"  => <0/1>

#                                           "backup"  => <0/1>

#                                            }

#                                    }

#                              }

#                       }

#                } # keys

#

#

#

#

# Params: referenceToWorksheet,refToHash

#

# Return: 0 on successfull reading

#         1 on case, where the worksheet was not OK (for isntance name is 

#                     not according to specification.

###########################################################################

sub readCentrepKeyInfo   

{

    my $refToWorksheet = shift;

    my $refToHash = shift;

    my $owner = shift;

    my $entity = shift;

    my $sheetName = shift;

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

    # look to header information

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

    # Uid value

    # Key name value

    # Key value

    # 

    # 

    # 

    # 

    # 

    my ($uidNameIndex,$uidValueIndex,$rangeFromIndex,$rangeToIndex,$keyNameValueIndex,$keyIntValueIndex,$sdNameIndex,$removedIndex,$releaseIndex,$variantNameIndex,$valueIndex,$readOnlyIndex,

	$keyTypeIndex,$backupIndex,$rfsIndex,$custConfigIndex,$capaNoneIndex,$capaAllIndex,$capaAllMinusTcbIndex,$capaNetworkServicesIndex,

	$capaLocalServicesIndex,$capaReadUserDataIndex,$capaWriteUserDataIndex,$capaLocationIndex,$capaReadDeviceDataIndex,

	$capaWriteDeviceDataIndex,$capaProtServIndex,$capaDrmIndex,$capaSwEventIndex,$capaPowerMgmtIndex,$capaAllFilesIndex,

	$capaDiskAdminIndex,$capaNetworkControlIndex,$capaMultiMediaDDIndex,$capaCommDDIndex,

	$capaTCBIndex,$capaTrustedUIIndex,$capaAlwaysPassIndex,$capaUserEnvIndex,$capaSurroundingsDDIndex,

	$capaSidReadIndex,$capaSidWriteIndex,$rangeFromIndex,$rangeToIndex,$ownerIndex) = readIndexes($refToWorksheet);

    if( $uidValueIndex < 0)

    {

	return;

    }

    my $row = 1;

    my $emptyRowCount = 0;

    ######################################################################

    # Loop row by row until we have found $globalMaxEmptyRowCount of rows

    # empty one after each other.

    ######################################################################

    my $currUid = "";

    my $currUidKeysHash;

    my $currUidRangesHash;

    my $currUidSpecificHash;

    my $currRangeHash = undef;

    my $currKey = "";

    my $currKeyReleaseHash;  # the ref to has that is found from "release"

    my $lastActiveRowType = 0;   # 0 = not defined, 1 = uid, 2 = range, 3 = key

    for( $row = 2;; $row++ ) 

    {	         

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

	# We only allow $globalMaxEmptyRowCount empty rows, before we stop

	# handling the specific sheet

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

	if(! (   hasValue($refToWorksheet,$row, $uidValueIndex )

	      || hasValue($refToWorksheet,$row, $keyIntValueIndex )	

	      || hasValue($refToWorksheet,$row, $valueIndex )	

	      || hasValue($refToWorksheet,$row, $releaseIndex )	

	      || hasValue($refToWorksheet,$row, $rangeFromIndex )	

	      || hasValue($refToWorksheet,$row, $rangeToIndex )	

	     ))

	{

	    $emptyRowCount++;

	    if($emptyRowCount > $globalMaxEmptyRowCount)

	    {

		last;

	    }

	    next;

	}

	else

	{

	    # Was not empty line, reset counter.

	    $emptyRowCount = 0;

	}

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

	# Read the needed rows from the row

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

	my $uidName             = readCol($refToWorksheet,$row,$uidNameIndex,"");

	my $uid                 = readCol($refToWorksheet,$row,$uidValueIndex,"");

	my $keyName             = readCol($refToWorksheet,$row,$keyNameValueIndex,"");

	my $key                 = readCol($refToWorksheet,$row,$keyIntValueIndex,"");

	my $sdName              = readCol($refToWorksheet,$row,$sdNameIndex,"");

	my $removed             = readCol($refToWorksheet,$row,$removedIndex,"");

	my $release             = readCol($refToWorksheet,$row,$releaseIndex,"");

	my $variant             = readCol($refToWorksheet,$row,$variantNameIndex,"");

	my $value               = readCol($refToWorksheet,$row,$valueIndex,"");

	my $ro                  = readCol($refToWorksheet,$row,$readOnlyIndex,"");

	my $keyType             = readCol($refToWorksheet,$row,$keyTypeIndex,"");

	my $backup              = readCol($refToWorksheet,$row,$backupIndex,"");

	my $rfs                 = readCol($refToWorksheet,$row,$rfsIndex,"");

	my $custConfig          = readCol($refToWorksheet,$row,$custConfigIndex,"");

	my $capaNone            = readCol($refToWorksheet,$row,$capaNoneIndex,"");         

	my $capaAll             = readCol($refToWorksheet,$row,$capaAllIndex,"");         

	my $capaAllMinusTcb     = readCol($refToWorksheet,$row,$capaAllMinusTcbIndex,"");

	my $capaNetworkServices = readCol($refToWorksheet,$row,$capaNetworkServicesIndex,"");

	my $capaLocalServices   = readCol($refToWorksheet,$row,$capaLocalServicesIndex,"");

	my $capaReadUserData    = readCol($refToWorksheet,$row,$capaReadUserDataIndex,"");  

	my $capaWriteUserData   = readCol($refToWorksheet,$row,$capaWriteUserDataIndex,"");

	my $capaLocation        = readCol($refToWorksheet,$row,$capaLocationIndex,"");  

	my $capaReadDeviceData  = readCol($refToWorksheet,$row,$capaReadDeviceDataIndex,"");

	my $capaWriteDeviceData = readCol($refToWorksheet,$row,$capaWriteDeviceDataIndex,"");

	my $capaProtServ        = readCol($refToWorksheet,$row,$capaProtServIndex,"");

	my $capaDrm             = readCol($refToWorksheet,$row,$capaDrmIndex,"");

	my $capaSwEvent         = readCol($refToWorksheet,$row,$capaSwEventIndex,"");

	my $capaPowerMgmt       = readCol($refToWorksheet,$row,$capaPowerMgmtIndex,"");

	my $capaAllFiles        = readCol($refToWorksheet,$row,$capaAllFilesIndex,"");

	my $capaDiskAdmin       = readCol($refToWorksheet,$row,$capaDiskAdminIndex,"");

	my $capaNetworkControl  = readCol($refToWorksheet,$row,$capaNetworkControlIndex,"");

	my $capaMultiMediaDD    = readCol($refToWorksheet,$row,$capaMultiMediaDDIndex,"");

	my $capaCommDD          = readCol($refToWorksheet,$row,$capaCommDDIndex,"");

	my $capaTCB             = readCol($refToWorksheet,$row,$capaTCBIndex,"");

	my $capaTrustedUI       = readCol($refToWorksheet,$row,$capaTrustedUIIndex,"");

	my $capaAlwaysPass      = readCol($refToWorksheet,$row,$capaAlwaysPassIndex,"");

	my $capaUserEnv         = readCol($refToWorksheet,$row,$capaUserEnvIndex,"");

	my $capaSurroundingsDD  = readCol($refToWorksheet,$row,$capaSurroundingsDDIndex,"");

	my $capaSidRead         = readCol($refToWorksheet,$row,$capaSidReadIndex,"");

	my $capaSidWrite        = readCol($refToWorksheet,$row,$capaSidWriteIndex,"");

	my $rangeFrom           = readCol($refToWorksheet,$row,$rangeFromIndex,"");

	my $rangeTo             = readCol($refToWorksheet,$row,$rangeToIndex,"");

	my $uidOwner            = readCol($refToWorksheet,$row,$ownerIndex,"");

	if($uidName =~ /^\s*Comment:/i)

	{

	    # comment rows are ignored

	    next;

	}

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

	# Handle UID row

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

	if($uid !~ /^\s*$/)

	{

	    $currUid = $uid;

	    $currKey = "";

	    $lastActiveRowType = 1;

	    my $tmpRefToHash = addHash($uid,$refToHash);

	    $currUidKeysHash = addHash("keys",$tmpRefToHash);

	    $$tmpRefToHash{"name"} = $uidName;

	    $currUidRangesHash = addHash("ranges",$tmpRefToHash);

	    $currUidSpecificHash = addHash("uid_specific",$tmpRefToHash);

	}

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

	# Handle range row

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

	elsif($rangeFrom !~ /^\s*$/ || $rangeTo !~ /^\s*$/)

	{

	    $currRangeHash = addHash($rangeFrom,$currUidRangesHash);

	    my $commonHash = addHash("common",$currRangeHash);

	    $currRangeHash = addHash("to",$currRangeHash);

	    $currRangeHash = addHash($rangeTo,$currRangeHash);

	    $$commonHash{"removed"} = $removed;

	    $lastActiveRowType = 2;

	}

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

	# Handle key row

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

	elsif($key !~ /^\s*$/)

	{

	    $currKey = $key;

	    $lastActiveRowType = 3;

	    my $keyHash = addHash($key,$currUidKeysHash);

	    ######################################################

            #   "common" => (

	    #               "name" => <someName>

	    #               "sheetName" => <someNameWithoutPath>

	    #               "sd-name" => <someName>  [optional]

            #               "read-only" => <0/1>

            #               "key type" => <bin/int/str/bool>

	    #               "removed" => <release>

	    #               "owner" => <ownerName>

	    #               "entity" => <entity>

            #               }

	    ######################################################

	    my $commonHash = addHash("common",$keyHash);

	    $$commonHash{"owner"} = $owner;

	    $$commonHash{"entity"} = $entity;

	    $$commonHash{"name"} = $keyName;

	    $$commonHash{"sheetName"} = $sheetName;

            # read-only attribute is set always from the "key row". 

	    # It can't be overwritten

	    $$commonHash{"read-only"} = 0;

	    if($ro =~ /^\s*yes\s*$/i)

	    {

		$$commonHash{"read-only"} = 1;

	    }

	    # key type attribute is set always from the "key row". It can't be overwritten

	    $$commonHash{"key type"} = $keyType;