/*

* Copyright (c) 2006 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:  Widget installer info file parsing.

*

*/

#include <e32base.h>

#include <f32file.h>

#include <centralrepository.h>

#include <libxml2_globals.h>

#include <libxml2_parser.h>

#include "WidgetConfigHandler.h"

#include "SWInstWidgetUid.h"

#include "WidgetInstallerInternalCRKeys.h"

#include <charconv.h>

// DTD

_LIT8( KNokiaId, "-//Nokia//DTD PLIST" );  // only the first part without version

_LIT8( KAppleId, "-//Apple Computer//DTD PLIST" ); // only the first part without version

// parsed elements in the DTD (XML element names are case sensitive)

_LIT8( KKey,"key" );

_LIT8( KString,"string" );

_LIT8( KInt,"integer" );

_LIT8( KTrue,"true" );

_LIT8( KFalse,"false" );

// properties from widget metadata file

// NOTE: Comments "required" and "optional" apply to our requirements

// for registering a widget.

// NOTE: These property names are not XML element names, they are text

// content for the <key> element, so we have made the match case

// insensitive and capitalization here is just for readability.

// Apple unique key names

_LIT( KAppleBundleIdentifier,      "CFBundleIdentifier" );      // required

_LIT( KAppleDisplayName,           "CFBundleDisplayName" );     // required

_LIT( KAppleBundleVersion,         "CFBundleVersion" );         // optional

_LIT( KAppleAllowFullAccess,       "AllowFullAccess" );         // optional

// For Apple, AllowFullAccess is mapped to AllowNetworkAccess unless

// AllowNetworkAccess appears too.

// Nokia unique key names

_LIT( KNokiaIdentifier,            "Identifier" );              // required

_LIT( KNokiaDisplayName,           "DisplayName" );             // required

_LIT( KNokiaVersion,               "Version" );                 // optional

_LIT( KNokiaMiniViewEnabled,       "MiniViewEnabled" );         // optional

_LIT( KBlanketPermGranted,          "BlanketPermissionGranted" );// optional 

_LIT( KPreInstalled,               "PreInstalled" );            // optional

// Apple/Nokia shared key names

_LIT( KMainHTML,                   "MainHTML" );                // required

_LIT( KAllowNetworkAccess,         "AllowNetworkAccess" );      // optional

_LIT( KHeight,                     "Height" );                  // optional

_LIT( KWidth,                      "Width" );                   // optional

enum TWidgetPropertyFlag

    {

    EMandatory = 1,

    EConfig = 2,

    EApple = 4,

    ENokia = 8,

    ESpecial = 16

    };

#define CONFIG_MUST ( EMandatory | EConfig )

#define CONFIG_APPLE_MUST ( EMandatory | EConfig | EApple )

#define CONFIG_NOKIA_MUST ( EMandatory | EConfig | ENokia )

#define CONFIG_MAY ( EConfig )

#define CONFIG_APPLE_MAY ( EConfig | EApple )

#define CONFIG_NOKIA_MAY ( EConfig | ENokia )

#define CONFIG_APPLE_SPECIAL ( EConfig | EApple | ESpecial )

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

// Traverse to the next Node

//

// @param aNode: current node

// @since 3.1

// @return next node

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

//

xmlNode* CWidgetConfigHandler::TraverseNextNode( xmlNode* n )

    {

    // depth first

    if ( n->children )

        {

        n = n->children;

        }

    else

        {

        // go up while no sibling

        while ( n->parent && !n->next )

            {

            n = n->parent;

            }

        // sibling?

        if ( n->next )

            {

            n = n->next;

            }

        else // done

            {

            n = NULL;

            }

        }

    return n;

    }

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

// CWidgetConfigHandler::NewL()

// two-phase constructor

//

// @since 3.1

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

//

CWidgetConfigHandler* CWidgetConfigHandler::NewL()

    {

    CWidgetConfigHandler *self = new (ELeave) CWidgetConfigHandler();

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop();

    return self;

    }

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

// CWidgetConfigHandler::CWidgetConfigHandler()

// C++ constructor

//

// @since 3.1

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

//

CWidgetConfigHandler::CWidgetConfigHandler()

    {

    iProperties[EPropertyDescriptionAppleBundleIdentifier].id = EBundleIdentifier;

    iProperties[EPropertyDescriptionAppleBundleIdentifier].name.Set( KAppleBundleIdentifier );

    iProperties[EPropertyDescriptionAppleBundleIdentifier].type = EWidgetPropTypeString;

    iProperties[EPropertyDescriptionAppleBundleIdentifier].flags = CONFIG_APPLE_MUST;

    //

    iProperties[EPropertyDescriptionAppleBundleDisplayName].id = EBundleDisplayName;

    iProperties[EPropertyDescriptionAppleBundleDisplayName].name.Set( KAppleDisplayName );

    iProperties[EPropertyDescriptionAppleBundleDisplayName].type = EWidgetPropTypeString;

    iProperties[EPropertyDescriptionAppleBundleDisplayName].flags = CONFIG_APPLE_MUST;

    //

    iProperties[EPropertyDescriptionAppleBundleVersion].id = EBundleVersion;

    iProperties[EPropertyDescriptionAppleBundleVersion].name.Set( KAppleBundleVersion );

    iProperties[EPropertyDescriptionAppleBundleVersion].type = EWidgetPropTypeString;

    iProperties[EPropertyDescriptionAppleBundleVersion].flags = CONFIG_APPLE_MAY;

    //

    iProperties[EPropertyDescriptionAppleAllowFullAccess].id = EWidgetPropertyIdInvalid;

    iProperties[EPropertyDescriptionAppleAllowFullAccess].name.Set( KAppleAllowFullAccess );

    iProperties[EPropertyDescriptionAppleAllowFullAccess].type = EWidgetPropTypeBool;

    iProperties[EPropertyDescriptionAppleAllowFullAccess].flags = CONFIG_APPLE_SPECIAL;

    //

    iProperties[EPropertyDescriptionNokiaIdentifier].id = EBundleIdentifier;

    iProperties[EPropertyDescriptionNokiaIdentifier].name.Set( KNokiaIdentifier );

    iProperties[EPropertyDescriptionNokiaIdentifier].type = EWidgetPropTypeString;

    iProperties[EPropertyDescriptionNokiaIdentifier].flags = CONFIG_NOKIA_MUST;

    //

    iProperties[EPropertyDescriptionNokiaDisplayName].id = EBundleDisplayName;

    iProperties[EPropertyDescriptionNokiaDisplayName].name.Set( KNokiaDisplayName );

    iProperties[EPropertyDescriptionNokiaDisplayName].type = EWidgetPropTypeString;

    iProperties[EPropertyDescriptionNokiaDisplayName].flags = CONFIG_NOKIA_MUST;

    //

    iProperties[EPropertyDescriptionNokiaVersion].id = EBundleVersion;

    iProperties[EPropertyDescriptionNokiaVersion].name.Set( KNokiaVersion );

    iProperties[EPropertyDescriptionNokiaVersion].type = EWidgetPropTypeString;

    iProperties[EPropertyDescriptionNokiaVersion].flags = CONFIG_NOKIA_MAY;

    //

    iProperties[EPropertyDescriptionMainHTML].id = EMainHTML;

    iProperties[EPropertyDescriptionMainHTML].name.Set( KMainHTML );

    iProperties[EPropertyDescriptionMainHTML].type = EWidgetPropTypeString;

    iProperties[EPropertyDescriptionMainHTML].flags = CONFIG_MUST;

    //

    iProperties[EPropertyDescriptionAllowNetworkAccess].id = EAllowNetworkAccess;

    iProperties[EPropertyDescriptionAllowNetworkAccess].name.Set( KAllowNetworkAccess );

    iProperties[EPropertyDescriptionAllowNetworkAccess].type = EWidgetPropTypeBool;

    iProperties[EPropertyDescriptionAllowNetworkAccess].flags = CONFIG_MAY;

    //

    iProperties[EPropertyDescriptionHeight].id = EHeight;

    iProperties[EPropertyDescriptionHeight].name.Set( KHeight );

    iProperties[EPropertyDescriptionHeight].type = EWidgetPropTypeInt;

    iProperties[EPropertyDescriptionHeight].flags = CONFIG_MAY;

    //

    iProperties[EPropertyDescriptionWidth].id = EWidth;

    iProperties[EPropertyDescriptionWidth].name.Set( KWidth );

    iProperties[EPropertyDescriptionWidth].type = EWidgetPropTypeInt;

    iProperties[EPropertyDescriptionWidth].flags = CONFIG_MAY;

	//

	iProperties[EPropertyDescriptionNokiaMiniViewEnable].id = EMiniViewEnable;

    iProperties[EPropertyDescriptionNokiaMiniViewEnable].name.Set( KNokiaMiniViewEnabled );

    iProperties[EPropertyDescriptionNokiaMiniViewEnable].type = EWidgetPropTypeBool;

    iProperties[EPropertyDescriptionNokiaMiniViewEnable].flags = CONFIG_NOKIA_MAY;

    //

    iProperties[EPropertyDescriptionNokiaPromptNeeded].id = EBlanketPermGranted;

    iProperties[EPropertyDescriptionNokiaPromptNeeded].name.Set( KBlanketPermGranted );

    iProperties[EPropertyDescriptionNokiaPromptNeeded].type = EWidgetPropTypeBool;

    iProperties[EPropertyDescriptionNokiaPromptNeeded].flags = CONFIG_NOKIA_MAY;

    //

    iProperties[EPropertyDescriptionNokiaPreInstalled].id = EPreInstalled;

    iProperties[EPropertyDescriptionNokiaPreInstalled].name.Set( KPreInstalled );

    iProperties[EPropertyDescriptionNokiaPreInstalled].type = EWidgetPropTypeBool;

    iProperties[EPropertyDescriptionNokiaPreInstalled].flags = CONFIG_NOKIA_MAY;

    }

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

// CWidgetConfigHandler::ConstructL()

// C++ constructor

//

// @since 3.1

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

//

void CWidgetConfigHandler::ConstructL()

    {

    }

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

// CWidgetConfigHandler::~CWidgetConfigHandler()

// destructor

//

// @since 3.1

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

//

CWidgetConfigHandler::~CWidgetConfigHandler()

    {

    }

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

// Get the key type out of the keyname

//

// @param aKeyName The name of the key: <key>KeyName</key>

// @since 3.1

// @return Key type.

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

//

TWidgetPropertyId CWidgetConfigHandler::GetPropertyId(

    const TDesC& aKeyName,

    DtdType aDtdType,

    TWidgetPropertyDescriptionId& aPropertyDescriptionId )

    {

    aPropertyDescriptionId = EPropertyDescriptionIdInvalid;

    TInt i = 0;

    for (; i < EPropertyDescriptionIdCount; ++i )

        {

        if ( (EDtdTypeApple == aDtdType)

             && ( iProperties[i].flags & ENokia ) )

            {

            continue;

            }

        if ( (EDtdTypeNokia == aDtdType)

             && ( iProperties[i].flags & EApple ) )

            {

            continue;

            }

        // we use case insensitive match for property names

        if ( 0 == aKeyName.CompareF( iProperties[i].name ) )

            {

            aPropertyDescriptionId = static_cast<TWidgetPropertyDescriptionId>(i);

            if ( iProperties[i].flags & ESpecial )

                {

                return EWidgetPropertyIdInvalid;

                }

            return iProperties[i].id;

            }

        }

    return EWidgetPropertyIdInvalid;

    }

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

// CWidgetConfigHandler::ToUnicodeL

// Utility to bundle transcoding to unicode steps.

//

// @since 3.1

// @param aEncoding input buffer encoding

// @param aUnicodeSizeMultiplier how many bytes of input make one unicode char

// @param aInBuf input data in encoding

// @param aOutBuf malloc'ed output buf, caller takes ownership

// @param aFileSession CCnvCharacterSetConverter requires it

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

//

void CWidgetConfigHandler::ToUnicodeL( TInt aEncoding,

                                       TInt aUnicodeSizeMultiplier,

                                       TPtrC8 aInBuf, HBufC16** aOutBuf,

                                       RFs& aFileSession )

    {

    *aOutBuf = NULL;

    // outbuf sizing and alloction

    HBufC16* outBuf = HBufC16::NewLC(aUnicodeSizeMultiplier * aInBuf.Length());

    TPtr16 outPtr = outBuf->Des();

    // convert to unicode

    CCnvCharacterSetConverter* charConv = CCnvCharacterSetConverter::NewLC();

    charConv->PrepareToConvertToOrFromL( aEncoding, aFileSession );

    TInt state = CCnvCharacterSetConverter::KStateDefault;

    TInt rep = 0; // number of unconvertible characters

    TInt rIndx = 0; // index of first unconvertible character

    User::LeaveIfError(

        charConv->ConvertToUnicode( outPtr, aInBuf, state, rep, rIndx ) );

    CleanupStack::PopAndDestroy( charConv );

    CleanupStack::Pop(); // outBuf

    *aOutBuf = outBuf;

    }

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

// CWidgetConfigHandler::GetContentL

// Utility to bundle extraction of XML text content

//

// @since 3.1

// @param aEncoding input buffer encoding

// @param aUnicodeSizeMultiplier how many bytes of input make one unicode char

// @param aInBuf input data in encoding

// @param aOutBuf malloc'ed output buf, caller takes ownership

// @param aFileSession CCnvCharacterSetConverter requires it

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

//

void CWidgetConfigHandler::GetContentL( RFs& aFileSession,

                                        xmlDocPtr aDoc,

                                        xmlNode* aNode,

                                        HBufC** aContent )

    {

    // xml uses UTF-8 for the internal representation

    xmlChar* xmlContent =

        xmlNodeListGetString( aDoc, aNode, 1 /* expand entities inline */);

    if ( NULL == xmlContent )

        {

        User::Leave( OOM_FLAG ? KErrNoMemory : KErrCorrupt );

        }

    // we must transcode UTF-8 to UCS-2 (historical

    // and now inaccurate name "unicode")

    CleanupStack::PushL( xmlContent );

    TPtrC8 content( xmlContent );

    ToUnicodeL( KCharacterSetIdentifierUtf8, 2,

                content, aContent, aFileSession );

    CleanupStack::PopAndDestroy(); // xmlContent equivalent to xmlFree()

    if ( NULL == *aContent )

        {

        User::Leave( KErrCorrupt );

        }

    }

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

// CWidgetConfigHandler::ParseValidateBundleMetadataL

// Parse the widget info file and create widget entry

// check for required keys and values

//

// @since 3.1

// @param aBuffer The buffer contains widget info file content.

// @param aPropertyValues output filled with parsed values from buf

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

//

void CWidgetConfigHandler::ParseValidateBundleMetadataL(

    TPtr8 aBuffer,

    RPointerArray<CWidgetPropertyValue>& aPropertyValues,

    RFs& aFileSession )

    {

    /*

      steps: 1. parse bundle metadata (ex., info.plist) and put

      results in aPropertyValues; 2. validate the metadata 2a. are

      required keys present? 2b. are values sane?

      leaves: 1. doesn't parse -> KErrCorrupt; 2. DTD not Nokia and

      cenrep key KWidgetInstallerStrictMode is 1 -> KErrNotSupported;

      3. key type bool but child element not true or false ->

      KErrCorrupt; 4. key type integer but child element not integer

      -> KErrCorrupt; 5. key type integer and child element integer

      but unparsable integer value -> KErrCorrupt; 6. key type string

      and child element not string -> KErrCorrupt; 7. key type string

      and child element string but does not contain text ->

      KErrCorrupt; 8. required keys not present -> KErrNotSupported

      9. key values not sane -> KErrNotSupported; 10. Heap allocation

      failure -> KErrNoMem

    */

    TInt nokiaOnly = 0;

    TRAP_IGNORE(

        CRepository* rep = CRepository::NewL( TUid::Uid( KSWInstWidgetUIUid ) );

        rep->Get( KWidgetInstallerStrictMode, nokiaOnly );

        delete rep; );

    // initialize the parser and check compiled code matches lib version

#if 0

// xmllib has a memory leak, so in order to detect mem leaks outside

// of the xmllib, this code fills in the values that the parse step

// would and returns.  you have to fill in the values for the specific

// Info.plist you are installing

    _LIT( KIdentifier, "com.aws.widget.beta1" );

    _LIT( KName, "WeatherBug" );

    _LIT( KHtml, "index.html" );

    *(aPropertyValues[EBundleIdentifier]) = KIdentifier;

    *(aPropertyValues[EBundleDisplayName]) = KName();

    *(aPropertyValues[EMainHTML]) = KHtml;

    *(aPropertyValues[EAllowNetworkAccess]) = 1;

    *(aPropertyValues[ENokiaWidget]) = 0;

    // TODO: We decided to drop BundleName and just use

    // DisplayName but the registry code has errors in it and uses

    // BundleName when it should use DisplayName so as a workaround,

    // set BundleName to DisplayName.  Should eventually remove

    // BundleName from set of registry values.

    const TDesC& name = *(aPropertyValues[EBundleDisplayName]);

    *(aPropertyValues[EBundleName]) = name;

#else

    LIBXML_TEST_VERSION

    xmlDocPtr doc; // resulting document tree

    doc = xmlReadMemory( (const char *)aBuffer.Ptr(), aBuffer.Length(),

                         NULL, // no base URL

                         NULL, // get encoding from doc

                         XML_PARSE_NOWARNING | XML_PARSE_NONET ); // options

    // parse failed check

    if ( !doc )

      {

      xmlCleanupParser();

      User::Leave( KErrCorrupt );

      }

    // determine doctype

    xmlNode* n;

    xmlDtd* dtd = NULL;

    for ( n = doc->children; n; n = n->next )

        {

        if ( XML_DTD_NODE == n->type )

            {

            dtd = (xmlDtd*)n;

            break;

            }

        }

    iDtdType = EDtdTypeUnknown;

    if ( dtd )

        {

        TPtrC8 id( dtd->ExternalID );

        if ( 0 == id.Left(KNokiaId().Length()).Compare(KNokiaId()) )

            {

            iDtdType = EDtdTypeNokia;

            }

        else if ( 0 == id.Left(KAppleId().Length()).Compare(KAppleId()) )

            {

            iDtdType = EDtdTypeApple;

            }

        }

    // save for registry so non-nokia installed on memory cards can be blocked

    // when inserted in nokia-only configured device

    *(aPropertyValues[ENokiaWidget]) = ( (EDtdTypeNokia == iDtdType) ? 1 : 0 );

    // handle cenrep nokia only setting

    if ( (EDtdTypeUnknown == iDtdType)

         || (nokiaOnly && ( EDtdTypeNokia != iDtdType )) )

        {

        User::Leave( KErrNotSupported );

        }

    xmlNode* rootElement = xmlDocGetRootElement( doc );

    TWidgetPropertyId valId( EWidgetPropertyIdInvalid );

    TWidgetPropertyDescriptionId propertyDescriptionId( EPropertyDescriptionIdInvalid );

    for ( n = rootElement; n; n = TraverseNextNode( n ) )

        {

        if ( XML_ELEMENT_NODE == n->type )

            {

            TPtrC8 element( n->name );

            if ( 0 == element.Compare( KKey() ) )

                {

                valId = EWidgetPropertyIdInvalid;

                HBufC* keyName;

                GetContentL( aFileSession, doc, n->children, &keyName );

                CleanupStack::PushL( keyName );

                TPtr name( keyName->Des() );

                name.Trim(); // remove surrounding whitespace

                valId = GetPropertyId( name, iDtdType, propertyDescriptionId );

                CleanupStack::PopAndDestroy( keyName );

                // reject duplicate keys based on value already being

                // set (unset values have type unknown)

                if ( ( EWidgetPropertyIdInvalid != valId )

                     && ( EWidgetPropTypeUnknown

                          != aPropertyValues[valId]->iType ) )

                    {

                    User::Leave( KErrCorrupt );

                    }

                }

            else if ( EWidgetPropertyIdInvalid != valId )

                {

                switch ( iProperties[propertyDescriptionId].type )

                    {

                case EWidgetPropTypeBool:

                    // map true to 1 and false to 0

                    if ( 0 == element.Compare( KTrue ) )

                        {

                        *(aPropertyValues[valId]) = 1;

                        }

                    else if ( 0 == element.Compare( KFalse ) )

                        {

                        *(aPropertyValues[valId]) = 0;

                        }

                    else

                        {

                        User::Leave( KErrCorrupt );

                        }