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

#

# Description: Replace S60 header with Symbian Foundation license header.

#              Output file (results) is compatibe for SFMakeLxrLinks.pl as input.

#

use strict;

use File::Find;

use File::Basename;

use Getopt::Long;

use IO::Handle;

use FindBin qw($Bin);

use FileHandle;

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

# Constants

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

# Tool version

use constant VERSION => '2.1';

# Version history: 0.8 Added copyright year pick-up

# Version history: 0.9- Bug fixesg

# Version history: 0.95- EPL header support added

# Version history: 0.96 Minor script adjustments

# Version history: 0.97 Assembly files (.s, .cia, .asm) checked as well

# Version history: 0.98 Support for -oem added. Also @file tag removed from template

# Version history: 0.99 Testing -oem option

# Version history: 1.0 Comment column added for PostProcess script

# Version history: 1.01 Modify option bug fixed

# Version history: 1.1 Description bug fixed

# Version history: 1.2 Digia copyrights moved to SF as well. Also R/O attribute removed only for files modified

# Version history: 1.3 Distribution policy files handled as well. With -create also created

# Version history: 1.31 Fixes to distribution file handling (only non-empty directories acknowledged)

# Version history: 1.32 .pm files checked as well

# Version history: 1.4 Bug fixes and "ignorefile" agrument added

# Version history: 1.41 Bug fix in Description pick-up

# Version history: 1.42 Bug fix in -ignore option (also missing .s60 file creation need to be ignored). Default value set to ignore option

# Version history: 1.43 Description statistics fixed, .hpp added, description pick-up improved

# Version history: 1.5 -verify option implemented, ignorefile default value extended, statistics go to log

# Version history: 1.51 Copyright year pick-up bug fixed, ignorefilepattern comparison case-insensitive

# Version history: 1.52 current s60 dumped to result

# Version history: 1.53 abld.bat added ti ignorefile default

# Version history: 1.54 -verify statistics improved

# Version history: 1.55 -eula option added

# Version history: 1.56 .mmh files added, extra Non-Nokia check added for "No Copyright" case for weired headers

# Version history: 1.57 Changes to -verify

# Version history: 1.58 @echo on ... @echo off added to .cmd and .bat headers

# Version history: 1.59 EPL warning log entry --> info

# Version history: 1.60 and 1.61 -ignorelist option added

# Version history: 1.62 Uppercase REM text allowed

# Version history: 1.63 Internal directory check added to -verify

# Version history: 1.64 Symbian --> Symbian.*Ltd in $ExternalToNokiaCopyrPattern

# Version history: 1.65 Bug fixed in normalizeCppComment

# Version history: 1.70 Changes to better cope with ex-Symbian sources,

#                       Pasi's better "@rem" taken into use for .bat and .cmd files

# Version history: 1.71 Config file support added (option -config) for non 3/7 IDs

# Version history: 1.72 handleVerify checks improved to include also file start

# Version history: 1.73 \b added to Copyright word to reduce if "wrong" alarms

# Version history: 1.74 incomplete copyright check added to -verify

# Version history: 1.75 Support for ignoring generated headers (@sfGeneratedPatternArray) added

# Version history: 1.76 .script extension added (using Cpp comments e.g. // Text)

# Version history: 1.77 Reporting and logging improvements for wk19 checks (need to check / patch single files)

# Version history: 1.80 Few Qt specific file extensions added, -lgpl option added, 

#                       C++ comment fix in handleOem

# Version history: 1.90 checkNoMultipleLicenses function added, and call to handleVerify* added

# Version history: 2.0 handleDistributionValue() changes IDs 0-->3/7 and 3-->7, 

#                      isGeneratedHeader() checks for file content added.

# Version history: 2.01 checkPortionsCopyright implemented and applied

# Version history: 2.02 Extra license word taken out from EPL header

# Version history: 2.1 -verify -epl support added and switchLicense() tried first for SFL --> EPL switching

my $IGNORE_MAN ='Ignore-manually';

my $IGNORE ='Ignore';

my $INTERNAL = 'internal';

use constant KEEP_SYMBIAN => 0;

use constant REMOVE_SYMBIAN => 1;

#file extention list that headers should be replace

my @extlist = ('.cpp', '.c', '.h', '.mmp', '.mmpi', '.rss', '.hrh', '.inl', '.inf', '.iby', '.oby',

            '.loc', '.rh', '.ra', '.java', '.mk', '.bat', '.cmd', '.pkg', '.rls', '.rssi', '.pan', '.py', '.pl', '.s', '.asm', '.cia',

            '.s60', '.pm', '.hpp', '.mmh', '.script', 

            '.pro', '.pri');  # Qt specific

# Various header comment styles

my @header_regexps = 

(

'^\s*(\#.*?\n)*',           # Perl, Python

'^\s*(\@echo\s*off\s*\n)?\n*(@?(?i)rem.*?\n)*(\@echo\s*on\s*)?', # Windows command script

'^\s*(\;.*?\n)*',           # SIS package file

'\s*\/\*[\n\s\*-=].*?\*\/',  # C comment block

'(\s*\/\/.*\n)+',           # C++ comment block  (do not use /s in regexp evaluation !!!)

'^\s*((\/\/|\#).*?\n)*'       # Script file comment

);

# Comment regular expression (Indeces within @header_regexps)

use constant COMMENT_PERL => 0;

use constant COMMENT_CMD => 1;

use constant COMMENT_SIS_ASM => 2;

use constant COMMENT_C => 3;

use constant COMMENT_CPP => 4;

use constant COMMENT_SCRIPT => 5;

my $descrTemplateOnly = '\?Description';

my $linenumtext = "1";  # Use this linenumer in LXR links

# Copyright patterns

my $copyrYearPattern = 'Copyright\b.*\d{4}\s*([,-]\s*\d{4})*';

my $copyrYearPattern2 = '\d{4}(\s*[,-]\s*\d{4})*';

use constant DEFCOPYRIGHTYEAR => "2009";  # For error cases

my $NokiaCopyrPattern = '\bCopyright\b.*Nokia.*(All Rights)?';

my $NonNokiaCopyrPattern = '\bCopyright\b.*(?!Nokia).*(All Rights)?';

my $CopyrPattern = '\bCopyright\b';

my $RemoveS60TextBlockPattern = 'This material.*Nokia';

my $CC = 'CCHAR';

my $BeginLicenseBlockPattern = 'BEGIN LICENSE BLOCK';

my $OldNokiaPattern = 'Nokia\s*Corporation[\.\s]*\n';

my $NewNokiaText =  "Nokia Corporation and/or its subsidiary(-ies).\n";  # Used in substitu to text

my $NewNokiaPattern = "Nokia Corporation and/or its subsidiary";

my $OldNokiaPattern2 =  "This material.*including documentation and any related.*protected by copyright controlled.*Nokia";

my $PortionsNokiaCopyrPattern = 'Portions.*Copyright\b.*Nokia.*(All Rights)?';

my $NewPortionsNokiaCopyrPattern = 'Portions\s*Copyright\b.*' . $NewNokiaPattern;

# Move these copyrights to Nokia !!!

my $ExternalToNokiaCopyrPattern = 'Copyright\b.*(Symbian\sLtd|Symbian\s*Software\s*Ltd|Digia|SysopenDigia).*(All\s+Rights|All\s+rights)?';

my $PortionsSymbianCopyrPattern = 'Portions\s*Copyright\b.*(Symbian\sLtd|Symbian\s*Software\s*Ltd).*(All\s+Rights|All\s+rights)?';

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

# SFL headers

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

# SFL C/C++ style

#

my $SFLicenseHeader = 

'/*

* Copyright (c) 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

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:

*

*/'. "\n";

# Test string to test header have been changed

my $SFLHeaderTest = 'Symbian\s*Foundation\s*License.*www\.symbianfoundation\.org\/legal\/sfl';

# Partial SFL  header template (# will be replaced by actual comment syntax char)

# Prepare for cases where someone adds spaces to string. 

my $SFLicenseHeaderPartial_template = 

$CC . '\s*This\s*component\s*and\s*the\s*accompanying\s*materials\s*are\s*made\s*available\s*\n' .

$CC . '\s*under\s*the\s*terms\s*of\s*the\s*License\s*\"Symbian\s*Foundation\s*License\s*v1\.0\"\s*\n' .

$CC . '\s*which\s*accompanies\s*this\s*distribution\,\s*and\s*is\s*available\s*\n' .

$CC . '\s*at\s*the\s*URL\s*\"http\:\/\/www\.symbianfoundation\.org\/legal\/sfl\-v10\.html\"\s*\.';

# SFL other comment styles (replace # with actual comment starter)

#

my $SFLicenseHeader_other_template = 

'#

# Copyright (c) 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

#

# Initial Contributors:

# Nokia Corporation - initial contribution.

#

# Contributors:

#

# Description:

#

';

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

# EPL headers

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

# C/C++ style

my $EPLLicenseHeader = 

'/*

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

*

*/' . "\n";

# Test string to test header have been changed

my $EPLHeaderTest = 'Eclipse\s*Public\s*License.*www\.eclipse\.org\/legal\/epl';

# Partial EPL header  (replace # with actual comment starter)

# Prepare for cases where someone adds spaces to string. 

my $EPLLicenseHeaderPartial_template = 

$CC . '\s*This\s*component\s*and\s*the\s*accompanying\s*materials\s*are\s*made\s*available\s*\n' .

$CC . '\s*under\s*the\s*terms\s*of\s*\"Eclipse\s*Public\s*License\s*v1\.0\"\s*\n' .

$CC . '\s*which\s*accompanies\s*this\s*distribution,\s*and\s*is\s*available\s*\n' .

$CC . '\s*at\s*the\s*URL\s*\"http\:\/\/www\.eclipse\.org\/legal\/epl\-v10\.html\"\s*\.';

# EPL other comment styles (replace # with comment starter)

#

my $EPLLicenseHeader_other_template = 

'#

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

#

';

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

# LGPL headers

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

my $LGPLLicenseHeader = 

'/*

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

* All rights reserved.

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU Lesser General Public License as published by

* the Free Software Foundation, version 2.1 of the License.

* 

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU Lesser General Public License for more details.

*

* You should have received a copy of the GNU Lesser General Public License

* along with this program.  If not, 

* see "http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html/".

*

* Description:

*

*/';

# Test string to test header have been changed

my $LGPLHeaderTest = 'GNU\s*Lesser\s*General\s*Public\s*License.*www\.gnu\.org\/licenses/old-licenses\/lgpl-2\.1\.html';

# Partial LGPL header  (replace $CC with actual comment starter)

my $LGPLLicenseHeaderPartial_template = 

$CC . '\s*This\s*program\s*is\s*free\s*software\:\s*you\s*can\s*redistribute\s*it\s*and\/or\s*modify\n' .

$CC . '\s*it\s*under\s*the\s*terms\s*of\s*the\s*GNU\s*Lesser\s*General\s*Public\s*License\s*as\s*published\s*by\n' .

$CC . '\s*the\s*Free\s*Software\s*Foundation\,\s*version\s*2\.1\s*of\s*the\s*License\n';

# LGPL other comment styles (replace # with comment starter)

#

my $LGPLLicenseHeader_other_template = 

'#

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

# All rights reserved.

#

# This program is free software: you can redistribute it and/or modify

# it under the terms of the GNU Lesser General Public License as published by

# the Free Software Foundation, version 2.1 of the License.

# 

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU Lesser General Public License for more details.

#

# You should have received a copy of the GNU Lesser General Public License

# along with this program.  If not, 

# see "http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html/".

#

# Description:

#

';

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

# S60 headers

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

# C/C++ style

my $S60HeaderPartial_template = 

$CC . " This material, including documentation and any related computer\n" .

$CC . " programs, is protected by copyright controlled by Nokia. All\n" .

$CC . " rights are reserved. Copying, including reproducing, storing\n" .

$CC . " adapting or translating, any or all of this material requires the\n" .

$CC . " prior written consent of Nokia. This material also contains\n" .

$CC . " confidential information which may not be disclosed to others\n" .

$CC . " without the prior written consent of Nokia.";

# Test string to test header have been changed

my $S60HeaderTest = 'is\s*protected\s*by\s*copyright\s*controlled\s*by\s*Nokia';

my @SflHeaders = (\$SFLicenseHeader, \$SFLicenseHeader_other_template, \$SFLicenseHeaderPartial_template, \$SFLHeaderTest);   # contains refs

my @EplHeaders = (\$EPLLicenseHeader, \$EPLLicenseHeader_other_template, \$EPLLicenseHeaderPartial_template, \$EPLHeaderTest); # contains refs

my @S60Headers = (undef,undef,\$S60HeaderPartial_template, \$S60HeaderTest); # contains refs

my @LgplHeaders = (\$LGPLLicenseHeader, \$LGPLLicenseHeader_other_template, \$LGPLLicenseHeaderPartial_template, \$LGPLHeaderTest); # contains refs

# Header styles (indeces within @SflHeaders and @EplHeaders)

use constant CPP_HEADER => 0; 

use constant OTHER_HEADER => 1;

# switchLicense related values

use constant SFL_LICENSE => 3;

use constant EPL_LICENSE => 7;

use constant S60_LICENSE => 0;

use constant LGPL_LICENSE => 4;

use constant LICENSE_CHANGED => 1;

use constant LICENSE_NONE => 0;

use constant LICENSE_ERROR => -1;

use constant LICENSE_NOT_SUPPORTED => -2;

# Distribution policy file values

use constant INTERNAL_DISTRIBUTION_VALUE => "1";

use constant ZERO_DISTRIBUTION_VALUE => "0";

use constant SFL_DISTRIBUTION_VALUE => "3";  

use constant EPL_DISTRIBUTION_VALUE => "7"; # option -epl

use constant TSRC_DISTRIBUTION_VALUE => "950"; #

use constant NONSF_DISTRIBUTION_VALUE => "Other"; #

use constant DISTRIBUTION_FILENAME => "distribution.policy.s60";

my $usage = 'SFUpdateLicenHeader.pl tool, version: ' . VERSION .

'

Usages:

   perl SFUpdateLicenceHeader.pl [-modify] [-epl] [-oem] [-create]  [-ignorefile pattern]

        [-output csv-file] [-log logfile] [-verbose level] [-verify] [-append]

        [-oldoutput old-csv-file]  DIRECTORY|FILE

   Check switch to SFL header in a directory (and subdirectories under that):

      perl SFUpdateLicenceHeader.pl -output csv-file -log logfile DIRECTORY

   Switch to SFL header and modify .policy.s60 files in a directory (and subdirectories under that):

      perl SFUpdateLicenceHeader.pl -modify -output csv-file -log logfile DIRECTORY

   Switch to SFL header and modify .policy.s60 files in a single file:

      perl SFUpdateLicenceHeader.pl -modify -output csv-file -log logfile FILE

   Switch to EPL header and modify .policy.s60 files:

      perl SFUpdateLicenceHeader.pl -modify -epl -output csv-file -log logfile DIRECTORY

   Switch to SFL header and modify/create missing .policy.s60 files:

      perl SFUpdateLicenceHeader.pl -modify -create -output csv-file -log logfile DIRECTORY

   Switch to SFL header and ignore files matching CCM file pattern:

      perl SFUpdateLicenceHeader.pl -modify -ignore "_ccmwaid.inf" -output csv-file -log logfile DIRECTORY

   Switch to SFL header and ignore files matching  CCM or SVN file patterns:

      perl SFUpdateLicenceHeader.pl -modify -ignore "(_ccm|.svn)" -output csv-file -log logfile DIRECTORY

   Switch back to Nokia header (for OEM delivery team):

      perl SFUpdateLicenceHeader.pl -modify -oem -output csv-file -log logfile DIRECTORY

   Verify file header changes

      perl SFUpdateLicenceHeader.pl -verify -output csv-file -log logfile DIRECTORY

   Verify and append logs and results to single file

      perl SFUpdateLicenceHeader.pl -verify -append -output AllResults.csv -log AllLogs.log DIRECTORY

   Verify file header changes and use old result file as add-on configuation (used by -verbose only)

      perl SFUpdateLicenceHeader.pl -verify -oldoutput old-csv-file -output csv-file -log logfile DIRECTORY

For more info, see http://s60wiki.nokia.com/S60Wiki/SFDG-File-Header#SFUpdateLicenceHeader.pl

';

# Logging constants

use constant LOG_ALWAYS => 0;

use constant LOG_INFO => 3;

use constant LOG_ERROR => 1;

use constant LOG_WARNING => 2;

use constant LOG_DEBUG => 4;

my @LOGTEXTS = ("", "ERROR: ", "Warning: ", "Info: ", "DEBUG: ");

my $sep = ",";

my $logFile = "";

# Issue categories in result CSV formatted file

use constant HEADER_CONTEXT => 'header-issue';

use constant DISTRIBUTION_CONTEXT => 'distribution-issue';

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

# Global variables

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

# Command line options

my $help = 0;

my $outputfile;  

my $ignorefilepattern;  # File patterns to ignore

# my $optSfl = 1;  # By default sfl is on

my $optEpl = 0;  # Use EPL headers

my $optLgpl = 0;  # Use LGPL v2.1 headers

my $optLogLevel = LOG_INFO;

my $optModify = 0;  # (default mode is check)

my $optCreate = 0;  # (create missing files)

my $optOem = 0;  # OEM delivery to S60 license

my $optAppend = 0;  # Append results

my $optVerify = 0;  # Verify option

my $oldOutputFile;  # Version 1.60 old output file in CSV format

my %manualIgnoreFileHash; # Hash of files ignored

my $optDescription = 0;  # Output also missing description

my $optOutputOK = 0;  # Output also OK issues for -verify 

# The last distribution ID

my $lastDistributionValue = "";

# Config file specific gllobals

my $configFile;

my $configVersion = "";

my @sfDistributionIdArray = ();  # Distribution ID array

my @sfGeneratedPatternArray = ();  # Distribution ID array

#

# Statistics variables

#

my $fileCount = 0;

my $modifiedFileCount = 0;

my $willModifiedFileCount = 0;

my $noDescrcount = 0;

my $otherCopyrCount=0;

my $ExternalToNokiaCopyrCount=0;

my $NokiaCopyrCount=0;

my $NoCopyrCount=0;

my $UnclearCopyrCount=0;

my $SflToS60Changes = 0;

my $EplToS60Changes = 0;

my $SflToEplChanges = 0;

my $EplToSflChanges = 0;

my $LicenseChangeErrors = 0;

my $ignoreCount = 0;

my $unrecogCount = 0;

my $createCount = 0;

my @verifyFailedCount = (0,0,0,0,0,0,0,0,0,0,0); 

my @verifyFailedCountMsgs = ("Distribution file missing",  # Index 0

                             "SFL or EPL distribution ID missing",  #1

                             "SFL or EPL header missing",   #2

                             "Proper copyright missing",    #3

                             "Header vs. distribution ID mismatch",   #4

                             "Internal directory going to SF",         #5

                             "Old Nokia file header used",         #6

                             "Unclear Non-Nokia copyright",         #7

                             "Incomplete copyright",         #8

                             "OK",     #9

                             "OK (Non-Nokia)",     #10

                             "Multiple license"     #11

                              );

use constant VERI_MISSING_FILE => 0;

use constant VERI_MISSING_ID => 1;

use constant VERI_MISSING_HEADER => 2;

use constant VERI_PROPER_COPYRIGHT => 3;

use constant VERI_ID_HEADER_MISMATCH => 4;

use constant VERI_INTERNAL_TO_SF => 5;

use constant VERI_OLD_NOKIA_HEADER => 6;

use constant VERI_UNCLEAR_COPYR => 7;

use constant VERI_INCOMPLETE_COPYR => 8;

use constant VERI_OK => 9;

use constant VERI_OK_NON_NOKIA => 10;

use constant VERI_MULTIPLE_LICENSES => 11;

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

# Callback for the find function 

# (wanted)

# Note ! "no_chdir" not used

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

sub process_file

{

	my $full_filename = $File::Find::name; # Full name needed for result and logs !

    $full_filename =~ s/\\/\//g;  # Standardize name 

	my $filename = $_;  # This in filename in the current working directory !

	#Skip all directory entries

	return if -d;

    if ($ignorefilepattern && $full_filename =~ m/$ignorefilepattern/i)

    {

        printLog(LOG_DEBUG, "File ignored by pattern: ".  $full_filename . "\n");

        $ignoreCount++;

        return;

    }

    # Set initial value from options, turn off later if needed

    my $modify = $optModify;

    my $willmodify = 1; # For statistics only

	#skip non-source code files

	my ($name, $path, $suffix)=fileparse($_, qr/\.[^.]*/);

	my $match = grep {$_ eq lc($suffix)} @extlist;

    if (!$match)

    {

        printLog(LOG_DEBUG, "File ignored: ".  $full_filename . "\n");

        $ignoreCount++;

        return;

    }

    # As there have been cased where e.g. .pkg file has been saved as Unicode format

    # Check that we can really modify file (e.g. Unicode files not supported)

    if (! (-T $filename)) # Text file only !

    {

        printLog(LOG_WARNING, "File not in text format: $full_filename\n");

        return;

    }