/*

* Copyright (c) 2010 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 file contains the implementation of CJavaSifPlugin

*               class member functions. ECOM Plugin for USIF to handle

*               install, uninstall, get component info requests.

*

*/

#include <apgcli.h>

#include <apmstd.h>

#include <charconv.h>

#include <data_caging_path_literals.hrh>

#include <e32cmn.h>

#include <e32property.h>

#include <string.h>

#include <usif/usiferror.h>

#include "comms.h"

#include "commsclientendpoint.h"

#include "commsmessage.h"

#include "javacommonutils.h"

#include "javaoslayer.h"

#include "javaprocessconstants.h"

#include "javasymbianoslayer.h"

#include "javauids.h"

#include "logger.h"

#include "resultsserver.h"

#include "runtimeexception.h"

#include "javasifplugin.h"

using namespace java::installer;

using namespace java::util;

using namespace java::comms;

_LIT(KPrivateDataCage, "\\private\\");

_LIT(KInboxDataCage, "\\private\\1000484b\\");

_LIT(KJavaInstallerProcess, "Installer*");

_LIT(KJavaInstallCopierProcess, "javainstallcopier.exe");

_LIT(KJavaInstallerDataCage, "\\private\\102033e6\\");

_LIT(KJavaInstallerTmp, "\\private\\102033E6\\installer\\tmp\\");

_LIT(KAnyExtension, ".*");

_LIT(KComponentInfo, " componentinfo");

_LIT(KCommsResult, " -commsresult=");

_LIT(KJad, " -jad=");

_LIT(KJar, " -jar=");

_LIT(KDoubleQuote, "\"");

_LIT(KInstall, " install");

_LIT(KSilent, " -silent");

_LIT(KUninstall, " uninstall");

_LIT(KCid, " -cid=");

_LIT(KDrive, " -drive=");

_LIT(KYes, "yes");

_LIT(KNo, "no");

_LIT(KOcsp, " -ocsp=");

_LIT(KIgnoreOcspWarnings, " -ignore_ocsp_warnings=");

_LIT(KUpgrade, " -upgrade=");

_LIT(KUpgradeData, " -upgrade_data=");

_LIT(KUntrusted, " -untrusted=");

_LIT(KOverwrite, " -overwrite=");

_LIT(KDownload, " -download=");

_LIT(KIap, " -iap=");

_LIT(KSnap, " -snap=");

_LIT(KForceCancel, " -forcecancel");

_LIT(KBase64, " -base64=");

_LIT(KUsername, " -username=");

_LIT(KPassword, " -password=");

_LIT(KSourceUrl, " -sourceurl=");

_LIT(KCharSet, " -charset=");

_LIT(KJadMimeType, "text/vnd.sun.j2me.app-descriptor");

_LIT8(K8JadMimeType, "text/vnd.sun.j2me.app-descriptor");

// Long Java Installer command lines contain max 2 path names (512 chars max) and

// some options -> 1536 is long enough buffer

const TInt KLongCmdLineLen = 1536;

// When starting Java Installer for uninstallation the command line is much shorter

const TInt KShortCmdLineLen = 256;

// Java Installer is executed with same Uid as Java Runtime

_LIT_SECURE_ID(KJavaInstallerSecureID, KJavaMidpSecureId);

/**

 * This function is called to hide the 'Preparing Installation' dialog.

 */

LOCAL_C TInt HidePrepInstDialog(TAny* aPlugin)

{

    CJavaSifPlugin *pPlugin = (CJavaSifPlugin *)aPlugin;

    if (NULL != pPlugin)

    {

        TRAP_IGNORE(pPlugin->HidePrepInstDialogL());

    }

    return KErrNone;

}

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

CJavaSifPlugin* CJavaSifPlugin::NewL()

{

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

    CleanupStack::PushL(self);

    self->ConstructL();

    CleanupStack::Pop(self);

    return self;

}

CJavaSifPlugin::~CJavaSifPlugin()

{

    mRFs.Close();

    TInt nHandles = mHandlesToClose.Count();

    while (nHandles > 0)

    {

        nHandles--;

        mHandlesToClose[nHandles].Close();

    }

    mHandlesToClose.Reset();

    delete mResultsServer;

    mResultsServer = NULL;

    delete mDummyResults;

    mDummyResults = NULL;

    delete mDummyInfo;

    mDummyInfo = NULL;

    delete mPrepInstDialog;

    mPrepInstDialog = NULL;

    if (mWaitToHideDialog)

    {

        delete mWaitToHideDialog;

        mWaitToHideDialog = NULL;

    }

}

CJavaSifPlugin::CJavaSifPlugin()

{

}

void CJavaSifPlugin::ConstructL()

{

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

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

    mResultsServer = NULL;

    mDummyResults = COpaqueNamedParams::NewL(); // codescanner::forgottoputptroncleanupstack

    mDummyInfo = CComponentInfo::NewL();

    mWaitToHideDialog = NULL;

}

void CJavaSifPlugin::GetComponentInfo(

    const TDesC& aFileName,

    const TSecurityContext& aSecurityContext,

    CComponentInfo& aComponentInfo,

    TRequestStatus& aStatus)

{

    RFile fileHandle;

    TInt err = fileHandle.Open(mRFs, aFileName, EFileShareReadersOnly | EFileRead);

    if (KErrNone != err)

    {

        ELOG1(EJavaInstaller,

              "CJavaSifPlugin::GetComponentInfo Opening file for reading failed with error %d",

              err);

        TRequestStatus *statusPtr(&aStatus);

        User::RequestComplete(statusPtr, err);

        return;

    }

    GetComponentInfo(fileHandle, aSecurityContext, aComponentInfo, aStatus);

    fileHandle.Close();

}

void CJavaSifPlugin::GetComponentInfo(

    RFile& aFileHandle,

    const TSecurityContext& /* aSecurityContext */,

    CComponentInfo& aComponentInfo,

    TRequestStatus& aStatus)

{

    if (ExitIfJavaInstallerRunning(*mDummyResults, aStatus))

    {

        return;

    }

    RProcess rJavaInstaller;

    TFileName fileName;

    HBufC* pBufCommandLine = NULL;

    TRAPD(err, pBufCommandLine = HBufC::NewL(KLongCmdLineLen))

    if (KErrNone != err)

    {

        TRequestStatus *statusPtr(&aStatus);

        User::RequestComplete(statusPtr, err);

        return;

    }

    std::auto_ptr<HBufC> bufCommandLine(pBufCommandLine);

    TPtr commandLine = pBufCommandLine->Des();

    // Build command line used to pass all necessary info to Java Installer

    std::auto_ptr<HBufC> installerStarterDll(

        stringToDes(java::runtime::JAVA_INSTALLER_STARTER_DLL));

    commandLine = installerStarterDll->Des();

    commandLine.Append(KComponentInfo);

    // Ask Java Installer to send component info back

    // as Comms message. 11000 is IPC_ADDRESS_JAVA_SIF_PLUGIN_C Comms endpoint

    // that our ResultsServer will listen to.

    commandLine.Append(KCommsResult);

    commandLine.AppendNum(IPC_ADDRESS_JAVA_SIF_PLUGIN_C);

    err = aFileHandle.FullName(fileName);

    // Java Installer does not have AllFiles capability.

    // So if the .jad/.jar file is in the private data cage of

    // Remove Application Management system, it must be copied

    // to the private data cage of Java Installer in this

    // plugin which is executed in process which hopefully has

    // AllFiles capability.

    TRAP(err, CopyFilesIfNeededL(fileName));

    if (KErrNone != err)

    {

        TRequestStatus *statusPtr(&aStatus);

        User::RequestComplete(statusPtr, err);

        return;

    }

    // Check whether the file is .jad or .jar

    TBool isJad;

    err = IsJadFile(aFileHandle, isJad);

    if (KErrNone != err)

    {

        TRequestStatus *statusPtr(&aStatus);

        User::RequestComplete(statusPtr, err);

        return;

    }

    if (isJad)

    {

        // Installation should be started from JAD file

        commandLine.Append(KJad);

    }

    else

    {

        // from JAR file

        commandLine.Append(KJar);

    }

    // Filename parameter must be surrounded in double quotes to

    // ensure that spaces in filename are passed correctly.

    commandLine.Append(KDoubleQuote);

    commandLine.Append(fileName);

    commandLine.Append(KDoubleQuote);

    // Start JavaInstaller

    std::auto_ptr<HBufC> installerProcess(

        stringToDes(java::runtime::JAVA_PROCESS));

    err = rJavaInstaller.Create(installerProcess->Des(), commandLine);

    if (KErrNone == err)

    {

        err = StartResultsServer(*mDummyResults, aComponentInfo);

        if (KErrNone != err)

        {

            // server cannot be started

            rJavaInstaller.Close();

            ELOG1(EJavaInstaller,

                  "CJavaSifPlugin::GetComponentInfo: Cannot start results server, err %d", err);

            TRequestStatus *statusPtr(&aStatus);

            User::RequestComplete(statusPtr, err);

            return;

        }

        // The status of the component info operation == the exit status of Java Installer

        // It will be passed to the asynch caller through aStatus

        rJavaInstaller.Logon(aStatus);

    }

    else

    {

        rJavaInstaller.Close();

        ELOG1(EJavaInstaller,

              "CJavaSifPlugin::GetComponentInfo: starting JavaInstaller failed, err=%d", err);

        TRequestStatus *statusPtr(&aStatus);

        User::RequestComplete(statusPtr, err);

        return;

    }

    rJavaInstaller.Resume();

    // Do NOT close rJavaInstaller now -> the caller gets notification when the

    // process actually closes.

    err = mHandlesToClose.Append(rJavaInstaller);

    if ( err )

    {

        rJavaInstaller.Close();

        ELOG1(EJavaInstaller, "CJavaSifPlugin::GetComponentInfo  mHandles"

              "ToClose.Append failed with error %d", err);

        TRequestStatus *statusPtr(&aStatus);

        User::RequestComplete(statusPtr, err);

        return;

    }

}

void CJavaSifPlugin::Install(

    const TDesC& aFileName,

    const TSecurityContext& aSecurityContext,

    const COpaqueNamedParams& aArguments,

    COpaqueNamedParams& aResults,

    TRequestStatus& aStatus)

{

    RFile fileHandle;

    TInt err = fileHandle.Open(mRFs, aFileName, EFileShareReadersOnly | EFileRead);

    if (KErrNone != err)

    {

        ELOG1(EJavaInstaller,

              "CJavaSifPlugin::Install Opening file for reading failed with error %d", err);

        TRAP_IGNORE(aResults.AddIntL(KSifOutParam_ErrCategory, EUnexpectedError));

        TRequestStatus *statusPtr(&aStatus);

        User::RequestComplete(statusPtr, err);

        return;

    }

    Install(fileHandle, aSecurityContext, aArguments, aResults, aStatus);

    fileHandle.Close();

}

void CJavaSifPlugin::Install(

    RFile& aFileHandle,

    const TSecurityContext& aSecurityContext,

    const COpaqueNamedParams& aArguments,

    COpaqueNamedParams& aResults,

    TRequestStatus& aStatus)

{

    if (ExitIfJavaInstallerRunning(aResults, aStatus))

    {

        return;

    }

    // Create buffer for Java Installer command line

    HBufC* pBufCommandLine = NULL;

    TRAPD(err, pBufCommandLine = HBufC::NewL(KLongCmdLineLen))

    if (KErrNone != err)

    {

        TRAP_IGNORE(aResults.AddIntL(KSifOutParam_ErrCategory, ELowMemory));

        TRequestStatus *statusPtr(&aStatus);

        User::RequestComplete(statusPtr, err);

        return;

    }

    std::auto_ptr<HBufC> bufCommandLine(pBufCommandLine);

    TPtr commandLine = pBufCommandLine->Des();

    // Build command line used to pass all necessary info to Java Installer

    std::auto_ptr<HBufC> installerStarterDll(

        stringToDes(java::runtime::JAVA_INSTALLER_STARTER_DLL));

    commandLine = installerStarterDll->Des();

    commandLine.Append(KInstall);

    // Check whether this is silent installation

    TInt silentInstall = 0;

    TRAP_IGNORE(aArguments.GetIntByNameL(KSifInParam_InstallSilently, silentInstall));

    if (silentInstall)

    {

        // Silent installation requires TrustedUI capability

        if (!aSecurityContext.HasCapability(ECapabilityTrustedUI))

        {

            ELOG(EJavaInstaller,

                 "CJavaSifPlugin::Install The caller did not have TrustedUI capability");

            TRAP_IGNORE(aResults.AddIntL(KSifOutParam_ErrCategory, ESecurityError));

            TRequestStatus *statusPtr(&aStatus);

            User::RequestComplete(statusPtr, KErrPermissionDenied);

            return;

        }

        commandLine.Append(KSilent);

    }

    else

    {

        // Uncomment this to enable 'preparing installation' dialog.

        //TRAP(err, CreatePrepInstDialogL());

        //if (KErrNone != err)

        //{

        //    WLOG1(EJavaInstaller,

        //          "CJavaSifPlugin::Install Creating preparing installation dialog failed, err=%d",

        //          err);

        //}

    }

    BuildInstallCommandLine(commandLine, aArguments);

    // Ask Java Installer to send installation results back

    // as Comms message. 11000 is IPC_ADDRESS_JAVA_SIF_PLUGIN_C Comms endpoint

    // that our ResultsServer will listen to.

    commandLine.Append(KCommsResult);

    commandLine.AppendNum(IPC_ADDRESS_JAVA_SIF_PLUGIN_C);

    TFileName fileName;

    err = aFileHandle.FullName(fileName);

    // Java Installer does not have AllFiles capability.

    // So if the .jad/.jar file is in the private data cage of

    // Remove Application Management system, it must be copied

    // to the private data cage of Java Installer in this

    // plugin which is executed in process which hopefully has

    // AllFiles capability.

    TRAP(err, CopyFilesIfNeededL(fileName));

    if (KErrNone != err)

    {

        TRAP_IGNORE(aResults.AddIntL(KSifOutParam_ErrCategory, EUnexpectedError));

        TRequestStatus *statusPtr(&aStatus);

        User::RequestComplete(statusPtr, err);

        return;

    }

    // Check whether the file is .jad or .jar

    TBool isJad = EFalse;

    err = IsJadFile(aFileHandle, aArguments, isJad);

    if (KErrNone != err)

    {

        TRAP_IGNORE(aResults.AddIntL(KSifOutParam_ErrCategory, EUnexpectedError));

        TRequestStatus *statusPtr(&aStatus);

        User::RequestComplete(statusPtr, err);

        return;

    }

    if (isJad)

    {

        // Installation should be started from JAD file

        commandLine.Append(KJad);

    }

    else

    {

        // from JAR file

        commandLine.Append(KJar);

    }

    // Filename parameter must be surrounded in double quotes to

    // ensure that spaces in filename are passed correctly.

    commandLine.Append(KDoubleQuote);

    commandLine.Append(fileName);

    commandLine.Append(KDoubleQuote);

    // Start JavaInstaller

    std::auto_ptr<HBufC> installerProcess(

        stringToDes(java::runtime::JAVA_PROCESS));

    RProcess rJavaInstaller;

    err = rJavaInstaller.Create(installerProcess->Des(), commandLine);

    if (KErrNone == err)

    {

        err = StartResultsServer(aResults, *mDummyInfo);

        if (KErrNone != err)

        {

            // server cannot be started

            rJavaInstaller.Close();

            ELOG1(EJavaInstaller,

                  "CJavaSifPlugin::Install: Cannot start results server, err %d", err);

            TRAP_IGNORE(aResults.AddIntL(KSifOutParam_ErrCategory, EUnexpectedError));

            TRequestStatus *statusPtr(&aStatus);

            User::RequestComplete(statusPtr, err);

            return;

        }

        // The status of the install operation == the exit status of Java Installer

        // It will be passed to the asynch caller through aStatus

        rJavaInstaller.Logon(aStatus);

    }

    else

    {

        rJavaInstaller.Close();

        ELOG1(EJavaInstaller,

              "CJavaSifPlugin::Install: starting JavaInstaller failed, err=%d", err);

        TRAP_IGNORE(aResults.AddIntL(KSifOutParam_ErrCategory, EUnexpectedError));

        TRequestStatus *statusPtr(&aStatus);

        User::RequestComplete(statusPtr, err);

        return;

    }

    if (!silentInstall)

    {

        TRAP(err, mWaitToHideDialog =

             CAsyncWaitCallBack::NewL(TCallBack(HidePrepInstDialog, this)));

        if (KErrNone == err)

        {

            // The active object will wait until JavaInstaller process calls Rendezvous.

            // If JavaInstaller specifies reason code EJavaInstaller, then

            // the active object will call callback function that will hide the

            // 'Preparing installation' dialog. If reason code is not EJavaInstaller,

            // the wait object will automatically wait for the next rendezvous.

            mWaitToHideDialog->Wait( rJavaInstaller, EJavaInstaller );

        }

        else

        {

            ELOG1(EJavaInstaller, "CJavaSifPlugin::Install: Creating "

                  "mWaitToHideDialog failed, err %d", err);

        }

    }

    rJavaInstaller.Resume();

    // Do NOT close rJavaInstaller now -> the caller gets notification when the

    // process actually closes.