/*

* Copyright (c) 1020 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:  HSPS server

* 

*  Architecture

*  ************

*  ChspsThemeServer derives CPolicyServer when compiled on EKA2 based Symbian OS.

*  ChspsThemeServer depends on the following classes:

*  - ChspsInstallationHandler which implements MhspsInstallationHandler,

*  - ChspsMaintenanceHandler which implements MhspsMaintenanceHandler,

*  - ChspsClientRequestHandler which implements MhspsClientRequestHandler,

*  - ChspsDefinitionRepository and ChspsODT from Xuikon, 

*  - ChspsFileChangeListener,

*  - ChspsAutoInstaller, and

*  - CRepository from Symbian.

*

*  Functionality

*  *************

*  When client connects to hspsThemeServer, the access rights are checked. 

*  If access is granted, a server session is created. Once connected, client may

*  perform service requests as long as it is connected. Service requests are 

*  served by initiating appropriate service handlers. These service handlers are

*  Symbian active objects, based on CActive-class. In using active ojects, it is

*  possible to perform long-lasting service requests without blocking others 

*  clients getting served on-time. Active objects are also used to assist 

*  services to perform asynchronous operations internally, for e.g. when service

*  is executing slow media conversions. Furthermore, some of these services are

*  extended to implement timer-functionality, based on CTimer-class. 

*  These active timers are used to control different time-based server 

*  operations and initiate service-state refreshing functionality.

*  hspsThemeServer contains auto-install feature that can install Application

*  Theme on SISX-packet exctraction.

*    

*  

*  Installation Handler

*  ====================

*  ChspsInstallatioHandler-active object performs all installation related

*  functionality. Installation concerns reading installation instructions from 

*  manifest-file, utilizind Xuikon Definition Engine to parse xml- and 

*  css-files, and apply style and localisation information defined in dtd-files

*  into the DOM-document created. Installer also handles resources that theme 

*  may include. Some resource types may need conversions to fit on the target

*  device's screen or audio device etc. In this case, the installer performs 

*  media conversions by its Media Converter. Conversions are asynchronous and

*  they deploy MIME-types. For more information of media conversions, see 

*  ChspsMediaConverter documentation. When installation is successful, 

*  Installation Handler utilizes Xuikon Definition Repository to store the 

*  results. The resulted objects are for e.g. unlocalised and localised 

*  versions of application theme. Theme associated resources are also handled 

*  in unlocalised and localised versions. Resources are stored on repository 

*  and their related information is stored on the list of ChspsResource-objects

*  - a resource list. This list of ChspsResource-objects is called Resource List.

*  Definition Repository is located in hspsThemeServer private  folder. 

*  Repository is organisized by theme header information. 

*  For more information, see hspsResource documentation.

*  On theme updates, i.e. installation over previous one, Installation Handler

*  deploys ChspsSecurityEnforcer to control theme update rights.

*  For more information, see ChspsSecurityEnforcer documentation and 

*  ChspsInstallatioHandler documentation. 

*  

*  Maintenance Handler

*  ===================

*  ChspsMaintenanceHandler-active timer performs all theme maintenance related 

*  functionality. Maintenance services includes theme listing, theme activation,

*  theme removal and default theme restoring operations. Maintenance functions 

*  deploy Xuikon Definition Repository and Symbian Central Repository. 

*  Definition Repository maintains Application Themes in save place and Central

*  Repository maintains the information about which theme is active for what 

*  application. Information in Central Repository is presented in pairs of 

*  application UID and active theme UID.

*  For more information, see ChspsMaintenanceHandler documentation. 

*

*  Client Request Handler

*  ======================

*  ChspsClientRequestHandler-active timer performs all request accesses from 

*  Rendering Engine. When request exists, the just right one application theme 

*  is delivered to client process using memory chunk passing. Resource List is

*  delivered too. Client Request Handler uses Xuikon Definition Repository and 

*  Symbian Central Repository to get match theme on the request. Client Request

*  Handler serves also resource accesses. In using file handle passing 

*  introduced by Symbian Platform Security concept, Client Request Service 

*  arranges a resource access to hspsThemeServer's private folder for the client 

*  process. RFile handle passing is used. 

*  For more information, see ChspsClientRequestHandler documentation.

*

*  File Change Listener

*  ==================

*  ChspsFileChangeListener listens to given file folder and notifies its observer

*  if there is any file change. Observer is given as a parameter on 

*  initialising the listener. Observer must implement MhspsFileChangeObserver-interface.

*  FileChangeListener is asynchronous object that deploys Symbian RFs client-sideAutoInstaller

*  handle on File Manager. FileChangeListener is intended to be used by any object

*  that wants listen Symbian file system events.

*

*  Auto Installer

*  ==============

*  ChspsAutoInstaller installs theme from given location. It is intended

*  to be used by hspsThemeServer directly. AutoInstaller is initiated

*  when FileChangeListener finds installable theme source on given

*  location. Theme source is set during the SISX-package exctraction. 

*  AutoInstaller is deployed by calling its function InstallThemeL with manifest-file 

*  of the installable theme source set.

*  AutoInstaller deploys ChspsInstallationHandler. ChspsInstallationHandler

*  is asynchronous object, there for AutoInstaller is asynchronous object

*  as well capable to deploy asynchronous installation.

*  When installation ends, AutoInstaller calls its observer with 

*  ThspsServiceCompletedMessage-type parameter. Observer is given on

*  initialising of AutoInstaller and it must be ChspsThemeServer-type.

*  AutoInstaller have functions to get ODT-header of successfully installed

*  theme and ChspsResult-typed object expressing errors in unsuccessful cases.   

*

*  Security Enforcer

*  =================

*  ChspsSecurityEnforcer performs all security related functions in Xuikon

*  Application Theme Management services.

*  These functions are the following:

*  - locking policy functionality,

*  - style locking policy functionality,

*  - control user access on service request, and

*  - validate content of user queries.

*

*  Performance accelerators

*  ************************

*

*  HeaderListCache

*  ---------------

*  To speed up serving the theme request operations initiated by Rendering 

*  Engine in theme usage cases, hspsThemeServer maintains cache of the header

*  information of the themes stored in Definition Repository. When installation

*  occurs, cache is updated. First time the cache is updated when hspsThemeServer

*  starts - server is started by system starter service. This quaranties

*  that cache is up to date and hit will occur on the very first access. 

*  Cache is updated also by MaintenanceHandler and ClientRequestHandler on 

*  the cases where content of repository is affected.

* 

*  Pre-initialized objects

*  -----------------------

*  hspsThemeServer speeds up the performance also by pre-initialized objects 

*  which it passes to ChspsClientRequestHandler when one is initiated on new 

*  Client Request Service server session. These objects are the following:

*  - ChspsDefinitionRepository

*  - CRepository for the KhspsThemeStatusRepositoryUid  {0x10207342} 

*

*

*/

#ifndef __hspsTHEMESERVER_H__

#define __hspsTHEMESERVER_H__

#include <e32base.h>

#include <abclient.h>

#include "hspsfilechangelistener.h"

#include "hspscenreplistener.h"

#if defined(WINSCW) || defined(__WINS__)

#include "hspsfamilylistener.h"

#endif // defined(WINSCW)

#include "hspsthememanagement.h"

#include "hspsodt.h"

#include "hspsdefinitionrepository.h"

#include "hspsbrobserver.h"

#include "hspsbrhandler.h"

#include "hsps_builds_cfg.hrh"

// C-Drive directory for the SISX installation files

_LIT( KImportDirectoryC, "c:\\private\\200159c0\\import\\" );

// directory for the SISX installation files

_LIT( KImportDirectory, "\\private\\200159c0\\import\\" );

/** hspsThemeServer name: */

_LIT(KhspsThemeServerName,"hspsthemeserver");

/** Supported manifest version */

_LIT(KhspsSupportedManifestVersion,"2.0");

/** hspsThemeServer Uid3 = SECUREID. */

const TUid KhspsThemeServerUid3 = {0x200159C0}; //old uid 0x10207254};

/** 

*   KhspsThemeServerMajorVersionNumber, KhspsThemeServerMinorVersionNumber, 

*   and KhspsThemeServerBuildVersionNumber.

*   These constants define a version to be given for creating a session 

*   with the hspsThemeServer.

*/

const TUint KhspsThemeServerMajorVersionNumber=1;

const TUint KhspsThemeServerMinorVersionNumber=0;

const TUint KhspsThemeServerBuildVersionNumber=0;

/*

*  KDefaultMessageSlots. Number of hspsThemeServer message slots.

*  Server slots allocation rules: 1 for synchronous request, 1 for each

*  concurrent outstanding asynchronous requests and 1 for each cancellation

*  => 3 in this case.

*/

const TInt KDefaultMessageSlots = 3;

// Forward declarations.

class ChspsDefinitionRepository;

class ChspsDefinitionEngineInterface;

class CRepository;

class ChspsSecurityEnforcer;

class ChspsRomInstaller;

class ChspsAutoInstaller;

class ChspsThemeServerSession;

class ChspsFamily;

#ifdef HSPS_LOG_ACTIVE

class ChspsLogBus;

#endif

// Keys for the Central Repository

const TInt KCenrepKeyLang                = 100000001;      // Device language from previous startup

const TInt KCenrepKeyPostRFS             = 100000002;      // Holds information whether the post RFS initializations have been done 

const TInt KCenrepKeyCheckConf           = 100000003;      // Holds information whether the configuration states must be checked 

const TInt KCenrepKeyAccessControlList   = 100000004;      // Holds information about security access control list

const TInt KCenRepBufferSize = 255;   // Control Access List length

/*

* Server's policy.

*/

/* Total number of ranges */

const TUint hspsThemeRangeCount = 4;

/* Definition of the ranges of IPC numbers */

const TInt hspsThemeRanges[hspsThemeRangeCount] = 

        {

        EhspsInstallationBase, 	/* installation messages (0,1,2 ) */

        EhspsMaintenanceBase, 	/* maintenance messages (3,4,5,6,7,8) */

        EhspsClientRequestBase, /* client request messages (9,10,11,12,13) */

        EhspsNotSupported, 		/* and up; non implemented function end of range check ; ENotSupported */ 

        }; 

/* Policy to implement for each of the above ranges */       

const TUint8 hspsThemeElementsIndex[hspsThemeRangeCount] = 

        {

        CPolicyServer::ECustomCheck, //applies to 0th range

        CPolicyServer::ECustomCheck, //applies to 1st range

        CPolicyServer::ECustomCheck, //applies to 2nd range

        CPolicyServer::ENotSupported //applies to 3rd range (out of range IPC)

        };

/* Specific capability checks */

const CPolicyServer::TPolicyElement hspsThemeElements[] = 

        {

        {_INIT_SECURITY_POLICY_C1(ECapabilityReadUserData), CPolicyServer::EFailClient},  

        //policy "0"; fail call if ReadUserData not present

        {_INIT_SECURITY_POLICY_C1(ECapabilityTCB), CPolicyServer::EFailClient} 

        //policy "1"; fail call if TCB not present

        };

/* Package all the above together into a policy */

const CPolicyServer::TPolicy hspsThemePolicy =

        {

        CPolicyServer::EAlwaysPass, /* specifies all connect attempts should pass */

        hspsThemeRangeCount,  /* number of ranges */                                  

        hspsThemeRanges,  /* ranges array */

        hspsThemeElementsIndex, /* elements<->ranges index */

        hspsThemeElements,    /* array of elements */

        };

// File filters related to imports folder

_LIT( KFilterAllImportsV1, "*.dat");

_LIT( KFilterAllAppImportsV1, "app_*.dat");

_LIT( KFilterAllPluginImportsV1, "plugin_*.dat");

_LIT( KFilterAllImportsV2, "*.*");

#ifdef _hsps_SERVER_SHUTDOWN_ENABLED_

/** 

 * MShutdownObserver

 * Observer for automatic shutdown class.

 * 

 * @since S60 5.0  

 */

class MShutdownObserver

    {

public:

    /**

    * Notifies observer that shutdown is initiating.

    * 

    * @since S60 5.0

    */

    virtual void ShutdownInitiating() = 0;

    };

/** 

 * CShutdown.

 * Auto shutdown class (standard pattern)

 * 

 * @since S60 5.0  

 */

class CShutdown : public CTimer

    {    

public:

    /**

    * Create new shutdown timer.

    * 

    * @since S60 5.0 

    * @param aObserver Shutdown observer.

    */    

    static CShutdown* NewL( MShutdownObserver& aObserver );

    /**

    * Start shutdown timer.

    * 

    * @since S60 5.0

    */        

    void Start();

protected:

    /**

    * C++ constructor.

    *

    * @since S60 5.0  

    * @param aObserver Shutdown observer.

    */        

    CShutdown( MShutdownObserver& aObserver );    

    /**

    * Symbian 2nd phase constructor.

    * 

    * @since S60 5.0

    */        

    void ConstructL();

private:

    /**

    * From CActive.

    */        

    void RunL();

private:

    // Shutdown delay.

    enum { KhspsShutdownDelay = 2000000 };

    // Shutdown observer.

    MShutdownObserver& iObserver;

  };

#endif // _hsps_SERVER_SHUTDOWN_ENABLED_

// States of the auto installer

enum TAutoInstallerStates

    {

    EAutoInstallerStateIdle = 0,

    EAutoInstallerStateInstall = 1,

    EAutoInstallerUninstall = 2

    };

// Operations for header cache updates

enum ThspsCacheOperations 

    {

    EhspsCacheAddHeader,

    EhspsCacheRemoveHeader

    };

// Backup states

enum ThspsBRStates 

    {

    EhspsBRNormal = 0,

    EhspsBRBackup,

    EhspsBRRestore

    };

/**

 * @ingroup group_hspsserver

 * ChspsThemeServer. 

 * @since S60 5.0

 **/

class ChspsThemeServer : public CPolicyServer, 

                       public MhspsFileChangeObserver,

                       public MhspsDefinitionRepositoryObserver,

                       public MhspsCenRepObserver

#ifdef _hsps_SERVER_SHUTDOWN_ENABLED_

                       , public MShutdownObserver

#endif // _hsps_SERVER_SHUTDOWN_ENABLED_         

#if defined(WINSCW) || defined(__WINS__)                         

                       , public MhspsFamilyObserver

#endif // defined(WINSCW)

    {

public:

    /**

    * NewLC

    * @since S60 3.1

    */

    static CServer2* NewLC();

    /**

    * AddSession

    * 

    * @param aSession   Session that is added. Ownership not transferred!.

    * 

    * @since S60 3.1

    */

    void AddSession( ChspsThemeServerSession* aSession );

    /**

    * DropSession

    * 

    * @param aSession   Session that is dropped. Ownership not transferred!.

    * 

    * @since S60 3.1

    */

    void DropSession( ChspsThemeServerSession* aSession );

public: // public functions

    /**

    * UpdateHeaderListCacheL

    * Re-scans the file system under the Plug-in Repository. 

    * Execution is slow and should be used only when absolutely required. 

    * Updates headerlist cache

    * @since S60 5.0

    */

    void UpdateHeaderListCacheL();

    /**

     * Updates the header list cache based on the provided ODT information.

     * Should be preferred over the previous API.     

     * @since S60 5.0

     * @param aOperation is an enumeration of the cache operations

     * @param aRootUid is an UID of the application/interface

     * @param aProviderUid is an UID of the provider

     * @param aConfUid is an UID of the plug-in configuration

     */

    TInt UpdateHeaderListCache(    

        ThspsCacheOperations aOperation,

        const TInt aRootUid,

        const TInt aProviderUid,

        const TInt aConfigurationUid );

    /**

    * CleanupTemporaryFilesL

    * Cleans temporary files

    * @since S60 3.1

    */

    void CleanupTemporaryFilesL(TInt secureId = 0);

    /**

    * IncreaseRequestClientCount

    * Increases count of client requests

    * @since S60 5.0

    */

    void IncreaseRequestClientCount();

    /**

    * DecreaseRequestClientCount

    * Decreases count of client requests

    * @since S60 5.0

    */

    void DecreaseRequestClientCount();

    /**

    * HandleAutoInstallerEvent

    * Handles autoinstaller events

    * @since S60 3.1

    */

    void HandleAutoInstallerEvent( ThspsServiceCompletedMessage aMsg );

    /**

    * DefinitionRepository

    * @since S60 3.1

    */

    ChspsDefinitionRepository& DefinitionRepository();

    /**

    * SecurityEnforcer

    * @since S60 3.1

    */

    ChspsSecurityEnforcer& SecurityEnforcer();

    /**

    * CentralRepository

    * @since S60 3.1

    */

    CRepository& CentralRepository();

    /**

    * DeviceLanguage

    * Returns device language

    * @since S60 3.1

    */

    TLanguage DeviceLanguage();

    /**

    * HeaderListCache

    * Returns headerlist cache

    * @since S60 3.1

    */

    CArrayPtrSeg<ChspsODT>& HeaderListCache();

    /**

    * GetConfigurationL

    * Retrieves a configuration with the provided UIDs.

    * @since S60 5.0    

    * @param aInterfaceUid An uid of the interface or application (e.g. AI3, Java etc), optional.

    * @param aConfigurationUid An uid of the plugin configuration     

    * @param aRetrievedODT Retrieved configuration

    * @return KErrNone if operation succeeded

    */

    TInt GetConfigurationL(

		const TInt aInterfaceUid,

		const TInt aConfigurationUid,

		ChspsODT& aRetrievedODT );

    /**

    * GetConfigurationHeaderL

    * Retrieves a configuration header matching the search criteria

    * @since S60 5.0    

    * @param aSearchMask ODT header defining search criteria

    * @param aConfHeader Found ODT header

    * @param aPos Start/Found position