/*

* Copyright (c) 2006, 2008 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

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

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  This file contains the header file of the CMidletUI class.

*

*                This class implements the ECom SWInstUIPluginAPI interface

*                for midlet installation.

*

*

*/

#include <f32file.h>

#include <bautils.h>

#include <e32cmn.h>

#include "WidgetInstaller.h"

#include "WidgetConfigHandler.h" // info.plist parser

#include "WidgetRegistrationManager.h" // interface to "shell"

#include "IconConverter.h"

// CONSTANTS

_LIT( KInfoPList,"Info.plist" );

_LIT( KIconFile, "Icon.png" );

_LIT( KMBMExt, ".mbm");

_LIT( KLprojExt, ".lproj" );

_LIT( KInfoPlistStrings, "InfoPlist.strings" );

// TODO MW has a hard dependency to APP domain. Not very good...

// TODO Hard-coded UID.

_LIT( KWidgetAppDir, "\\private\\10282822\\" );

_LIT( KBackSlash, "\\" );

// todo: other keystring.dat for preference

_LIT(KWidgetPref, "prefs.dat");

// =========================== MEMBER FUNCTIONS ===============================

// ============================================================================

// CWidgetInstaller::NewL()

// two-phase constructor

//

// @since 3.1

// @return pointer to CWidgetInstaller

// ============================================================================

//

EXPORT_C CWidgetInstaller* CWidgetInstaller::NewL()

    {

    CWidgetInstaller* self

        = new (ELeave) CWidgetInstaller();

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

// ============================================================================

// CWidgetInstaller::CWidgetInstaller()

// C++ constructor

//

// @since 3.1

// ============================================================================

//

CWidgetInstaller::CWidgetInstaller()

    : iPropertyValues( EWidgetPropertyIdCount )

    {

    }

// ============================================================================

// CWidgetInstaller::ConstructL()

// Symbian second phase constructor

//

// @since 3.1

// ============================================================================

//

void CWidgetInstaller::ConstructL()

    {

    User::LeaveIfError( iRfs.Connect() );

    User::LeaveIfError( iRfs.ShareProtected() );

    iFileMgr = CFileMan::NewL( iRfs );

    iAppManager = CWidgetRegistrationManager::NewL( iRfs );

    iWidgetConfigHandler = CWidgetConfigHandler::NewL();

    // delay registry connect because registry is a client and that

    // produces a circular dependency

    iServerConnected = EFalse;

    // empty values

    for ( TInt i( 0 ); i < EWidgetPropertyIdCount; ++i )

        {

        CWidgetPropertyValue* value = CWidgetPropertyValue::NewL();

        User::LeaveIfError( iPropertyValues.Insert( value, i ) );

        }

    *(iPropertyValues[EWidgetPropertyListVersion]) = WIDGETPROPERTYLISTVERSION;

#ifdef _DEBUG

    _LIT(KDir, "WidgetBUR");

    _LIT(KFile, "WidgetBURInstaller.log");

    TInt err( 0 );

    err = iFileLogger.Connect();

    if ( err == KErrNone )

        {

        iFileLogger.CreateLog( KDir(), KFile(), EFileLoggingModeOverwrite );

        iCanLog = ETrue;

        }

#endif

    }

// ============================================================================

// CWidgetInstaller::~CWidgetInstaller()

// destructor

//

// @since 3.1

// ============================================================================

//

CWidgetInstaller::~CWidgetInstaller()

    {

    TInt i = 0;

    for ( ; i < EWidgetPropertyIdCount; ++i )

        {

        delete iPropertyValues[i];

        }

    iPropertyValues.Close();

    delete iFileMgr;

    iRfs.Close();

    delete iWidgetConfigHandler;

    delete iAppManager;

    if ( iServerConnected )

        {

        iRegistry.Disconnect();

        }

#ifdef _DEBUG

    iFileLogger.Close();

#endif

    }

// ============================================================================

// CWidgetInstaller::InstallL()

// NORMAL INSTALL STEPS:

// 2. get metadata file (e.g. Info.plist) and parse it

// 3. if needed, replace identically named existing widget)

// 4. do free space check

// 5. if replacing existing widget then move currently installed files

//    to backup for possible restore on install error

//

// @since 3.1

// ============================================================================

//

EXPORT_C void CWidgetInstaller::InstallL(

    TDesC& aRestoreDir )

    {

    if ( EFalse == iServerConnected )

        {

        User::LeaveIfError( iRegistry.Connect() );

        iServerConnected = ETrue;

        }

    // The bool will be flase until doing something that

    // needs to be cleaned up on error/cancel.

    iOverwriting = EFalse;

    TRAPD( error,

        {

        // do initial bundle processing (parse and validate, total size,

        // check if replacing existing widget with same bundle ID, etc.)

        //

        // this step doesn't do anything that would need to be undone

        TBool replaceExisting = PreprocessWidgetBundleL( aRestoreDir );

        SetDriveAndCheckSpaceL();

        if ( replaceExisting )

            {

            BackupL(); // nothing need be undone if backup leaves

            }

        }

        ); // TRAPD

    if ( error == KErrNone )

        {

        ProcessRestoreDirL( aRestoreDir );

        }

    else if ( error == KErrAlreadyExists )

        {

        // max number of uid reached, to avoid SBE undo previous widget restore, don't leave with error

        return;

        }

    else

        {

        User::Leave( error );

        }

    }

// ============================================================================

// CWidgetInstaller::SearchWidgetRootL

//

// @since 3.2

// ============================================================================

//

TInt CWidgetInstaller::SearchWidgetRootL( const TDesC& aDir, TFileName& aFoundName )

    {

    CDir* entryList = NULL;

    TBool found = EFalse;

    RFile rFile;

    // aDir = "\private\[WidgetBackupRestoreUid]\WidgetBURTemp\bundleID\"

    TInt err = iRfs.GetDir( aDir, KEntryAttMatchMask, EDirsFirst, entryList );

    if ( err == KErrNone )

        {

        CleanupStack::PushL(entryList);

        // check for directory entries

        TInt cnt = entryList->Count();

        for (TInt i=0; i<cnt; i++)

            {

            const TEntry& fileEntry = (*entryList)[i];

            TFileName tempFile( aDir );

            tempFile.Append( fileEntry.iName );

            tempFile.Append( KBackSlash );

            TInt64 dirSize = GetDirSizeL( tempFile );

            if ( 0 == dirSize )

                continue;

            tempFile.Append( KInfoPList );

            TInt error = rFile.Open( iRfs, tempFile, EFileRead );

            CleanupClosePushL( rFile );

            CleanupStack::PopAndDestroy();  // rFile

            if ( KErrNone == error )

                {

                aFoundName.Copy( fileEntry.iName );

                found = ETrue;

                break;

                }

            }  // end of for

            CleanupStack::PopAndDestroy();  // entryList

        }  // end of if  iRfs

    return found;

    }

// ============================================================================

// CWidgetInstaller::PreprocessWidgetBundleL()

// Handles parsing and creating widget

// Widget data are still in "\private\[WidgetBackupRestoreUid]\WidgetBURTemp\bundleID\

//

// @since 3.2

// ============================================================================

//

TBool CWidgetInstaller::PreprocessWidgetBundleL( TDesC& aRestoreDir )

    {

    TBool found = EFalse;

    RFile rFile;

    // Reset the PropertyValues array, so as to erase the previous widget values, 

    // otherwise widget installation can fail due to the check for duplicate keys 

    // in ParseValidateBundleMetadataL(). Starting from the second element in the 

    // array, since the first element (EWidgetPropertyListVersion) is already

    // initialized to WIDGETPROPERTYLISTVERSION.

    for (TInt i=1; i<EWidgetPropertyIdCount; i++)

        {

        iPropertyValues[i]->Reset();

        }

    //////////////////////////////////////////////////////////////////////////////////////////////////

    // find the top-level directory under which to get metadata

    // aRestoreDir = "\private\[WidgetBackupRestoreUid]\WidgetBURTemp\bundleID"

    // tempFile = "\private\[WidgetBackupRestoreUid]\WidgetBURTemp\bundleID\"

    // iBundleRootName = "WeatherBug.wdgt"

    TFileName tempFile( aRestoreDir );

    tempFile.Append( KBackSlash );

    // searching for a directory which contains info.plist (under tempFile), 

    // rather than return the first directory found.

    TInt foundRoot = SearchWidgetRootL( tempFile, iBundleRootName );

    if( !foundRoot )

        {

        User::Leave( KErrNotSupported );

        }

    // root dir in widget bundle (not install root) of WidgetBackupRestore

    // e.g. bundleRoot = "\private\[WidgetBackupRestoreUid]\WidgetBURTemp\bundleID\WeatherBug.wdgt\"

    TFileName bundleRoot( tempFile );

    bundleRoot.Append( iBundleRootName );

    bundleRoot.Append( KBackSlash );

    TInt64 bundleRootSize = GetDirSizeL( bundleRoot );

    if ( 0 == bundleRootSize )

        {

         User::Leave( KErrNotSupported );

        }

    *(iPropertyValues[EFileSize]) = bundleRootSize;

    //////////////////////////////////////////////////////////////////////////////////////////////////

    // metadata file: "\private\[WidgetBackupRestoreUid]\WidgetBURTemp\bundleID\WeatherBug.wdgt\Info.plist"

    tempFile.Copy( bundleRoot );

    tempFile.Append( KInfoPList );

    TInt err = rFile.Open( iRfs, tempFile, EFileRead );

    if ( KErrNone != err )

        {

        // missing metadata file

        User::Leave( KErrNotSupported );

        }

    CleanupClosePushL( rFile );

    TInt size = 0;

    rFile.Size( size );

    HBufC8* buffer = HBufC8::NewLC( size );

    TPtr8 bufferPtr( buffer->Des() );

    User::LeaveIfError( rFile.Read( bufferPtr ) );

    // METADATA PARSE

    iWidgetConfigHandler->ParseValidateBundleMetadataL(

        bufferPtr, iPropertyValues, iRfs );

    CleanupStack::PopAndDestroy( 2, &rFile ); // rFile, buffer

    //////////////////////////////////////////////////////////////////////////////////////////////////

    // EXISTING WIDGET?

    if( iRegistry.WidgetExistsL( *(iPropertyValues[EBundleIdentifier]) ) )

        {

        // replacement for currently installed widget

        *(iPropertyValues[EUid]) = iRegistry.GetWidgetUidL(

            *(iPropertyValues[EBundleIdentifier]));

        found = ETrue;

        // get original install dir from registry in case user

        // decides to "overrite" to another memory location

        // e.g. iOriginalDir = "\private\[WidgetUIUid]\bundleID\"

        iRegistry.GetWidgetPath( TUid::Uid( *(iPropertyValues[EUid]) ),

                                 iOriginalDir );

        }

    else

        {

        // new widget, get an unused UID for this widget

        TDriveUnit phoneMemDriveUnit( EDriveC );

        const TDesC& drive = phoneMemDriveUnit.Name();

        *(iPropertyValues[EUid]) = iRegistry.GetAvailableUidL(drive[0]).iUid;

        }

    //////////////////////////////////////////////////////////////////////////////////////////////////

    // see if main.html exists

    // main.html file: "\private\[WidgetBackupRestoreUid]\WidgetBURTemp\bundleID\WeatherBug.wdgt\YahooTraffic.html"

    tempFile.Copy( bundleRoot );

    tempFile.Append( *(iPropertyValues[EMainHTML]) );

    if( !BaflUtils::FileExists( iRfs, tempFile ) )

        {

        User::Leave( KErrCorrupt );

        }

    //////////////////////////////////////////////////////////////////////////////////////////////////

    // infoLoc file: "\private\[WidgetBackupRestoreUid]\WidgetBURTemp\bundleID\WeatherBug.wdgt\en.lproj\InfoPlist.strings"

    TBuf<32> lproj;

    iRegistry.GetLprojName( lproj ); // e.g. "en", "fr", "zh_Hans" ...

    TFileName infoLocFile( bundleRoot );

    infoLocFile.Append( lproj );

    infoLocFile.Append( KLprojExt );

    infoLocFile.Append( KBackSlash );

    infoLocFile.Append( KInfoPlistStrings );

    err = rFile.Open( iRfs, infoLocFile, EFileRead );

    CleanupClosePushL( rFile );

    if ( err == KErrNone )

        {

        TInt size = 0;

        rFile.Size( size );

        HBufC8* buffer = HBufC8::NewLC( size );

        TPtr8 bufferPtr( buffer->Des() );

        err = rFile.Read( bufferPtr );

        User::LeaveIfError( err );

        // parse the l10n file and localize the bundle display name

        iWidgetConfigHandler->ParseInfoLocL(

            bufferPtr, iRfs, *(iPropertyValues[EBundleDisplayName]) );

        CleanupStack::PopAndDestroy( buffer ); // buffer

        }

    CleanupStack::PopAndDestroy( &rFile ); // rFile

    return found;

    }

void CWidgetInstaller::ProcessRestoreDirL( TDesC& aRestoreDir )

    {

    TInt err = KErrNone;

    HBufC* newDir( HBufC::NewLC( KMaxFileName ) );

    HBufC* tmpDir( HBufC::NewLC( KMaxFileName ) );

    //////////////////////////////////////////////////////////////////////////////////////////////////

    // widgetAppDir = "\private\[WidgetUIUid]\"

    // If the path is missing create it.

    if ( !BaflUtils::FolderExists( iRfs, KWidgetAppDir ) )

        {

        User::LeaveIfError( iRfs.MkDir( KWidgetAppDir ) );

        }

    //////////////////////////////////////////////////////////////////////////////////////////////////

    // newDir = "\private\[WidgetUIUid]\bundleID\"    

    *newDir = *(iPropertyValues[EBasePath]);

    // oldDir = "\private\[WidgetBackupRestoreUid]\WidgetBURTemp\bundleID"

    *tmpDir =  aRestoreDir;

    // oldDir = "\private\[WidgetBackupRestoreUid]\WidgetBURTemp\bundleID\"

    tmpDir->Des().Append( KBackSlash );

    TInt renameError = iRfs.Rename( *tmpDir, *newDir );

    if (renameError)

        {

        // copy if different drive or KErrAlreadyExists

        CFileMan* fileManager = CFileMan::NewL( iRfs );

        CleanupStack::PushL( fileManager );

        User::LeaveIfError( fileManager->Copy( *tmpDir, *newDir, CFileMan::ERecurse ) );

        User::LeaveIfError( fileManager->Attribs(*newDir, KEntryAttNormal, KEntryAttReadOnly,

                            TTime(0), CFileMan::ERecurse) );

        CleanupStack::PopAndDestroy( fileManager );  // fileMananger

        }

    //////////////////////////////////////////////////////////////////////////////////////////////////

    // e.g. bundleRootWithDrive = "C:\private\[WidgetUIUid]\bundleID\WeatherBug.wdgt\"

    // e.g. iBundleRootName = "WeatherBug.wdgt"

    TFileName bundleRootWithDrive( *newDir );

    bundleRootWithDrive.Append( iBundleRootName );

    bundleRootWithDrive.Append( KBackSlash );

    //////////////////////////////////////////////////////////////////////////////////////////////////

    // update MainHTML info

    TFileName mainHtml( bundleRootWithDrive );

    mainHtml.Append( *(iPropertyValues[EMainHTML]) );

    *(iPropertyValues[EMainHTML]) = mainHtml;

    //////////////////////////////////////////////////////////////////////////////////////////////////

    // parse the Icon.png file

    // e.g. iconPath = "C:\private\[WidgetUIUid]\bundleID\WeatherBug.wdgt\"

    TFileName iconPath( bundleRootWithDrive );

    TFileName iconFile( iconPath );

    iconFile.Append( KIconFile );

    if ( BaflUtils::FileExists( iRfs, iconFile ) )

        {

        *(iPropertyValues[EIconPath]) = iconPath;

        // scan the bundleRootWithDrive directory

        TFileName oldMbmIconTemp( KNullDesC );

        TBool mbmIconFound = SearchByExtL( bundleRootWithDrive, EDirsLast | EDescending, KMBMExt, oldMbmIconTemp );

        // skip converting to .mbm file, simply rename oldUid.mbm to newUid.mbm

        // where oldUid comes from backup widget,

        // newUid comes from widget registration or reuse of existing widget uid

        if( mbmIconFound )

            {

            TUid uid = TUid::Uid( *(iPropertyValues[EUid]) );

            // e.g. newMbmIcon = "C:\private\[WidgetUIUid]\bundleID\WeatherBug.wdgt\[newUid].mbm"

            TFileName newMbmIcon( iconPath );

            newMbmIcon.Append( uid.Name() );

            newMbmIcon.Append( KMBMExt() );

            // e.g. oldMbmIcon = "C:\private\[WidgetUIUid]\bundleID\WeatherBug.wdgt\[oldUid].mbm"

            TFileName oldMbmIcon( iconPath );

            oldMbmIcon.Append( oldMbmIconTemp );

            err = iRfs.Rename( oldMbmIcon, newMbmIcon );

            // it's ok that oldMbm and newMbm share the same uid

            if( err != KErrNone && err != KErrAlreadyExists )

                {

                User::Leave( err );

                }

            }

         else

            {

            // This case is specific to the WidgetPreInstaller.

            // Once the mbm file can be generated by the script this won't be needed.

            // Create the mbm file from the icon file

            TUid uid = TUid::Uid( *(iPropertyValues[EUid]) );

            ConvertIconL(uid, iconPath);

            }

        }

    //////////////////////////////////////////////////////////////////////////////////////////////////

    // delete "\private\[WidgetUIUid]\bundleID\prefs.dat"

    TFileName   widgetPref( *newDir );

    widgetPref.Append(KWidgetPref);

    err = iRfs.Delete( widgetPref );

    // it's ok not to have pref.dat

    if( err != KErrNone && err != KErrNotFound )

        {

        User::Leave( err );

        }

    CleanupStack::PopAndDestroy( 2, newDir );    

    //////////////////////////////////////////////////////////////////////////////////////////////////

    FinishInstallL( KErrNone );

    }

// ============================================================================

// CWidgetInstaller::FinishInstallL()

//

// @since 3.1

// ============================================================================

//

EXPORT_C void CWidgetInstaller::FinishInstallL( TInt aErr )

    {

#ifdef _DEBUG

    _LIT(KText, "FinishInstallL, aErr = %d, iOverwriting=%d");

    if ( iCanLog )

        {

        iFileLogger.WriteFormat( KText, aErr, iOverwriting );

        }

#endif

    if ( EFalse == iServerConnected )

        {

        User::LeaveIfError( iRegistry.Connect() );

        iServerConnected = ETrue;

        }

    if ( !aErr )

       {

        if ( iOverwriting )

            {

            TUid uid = TUid::Uid( *(iPropertyValues[EUid]) );

            iRegistry.DeRegisterWidgetL( uid );

            iAppManager->DeregisterWidgetL( uid );

            }