harvester/server/src/harvesterserver.cpp
changeset 0 c53acadfccc6
child 15 3cebc1a84278
equal deleted inserted replaced
-1:000000000000 0:c53acadfccc6
       
     1 /*
       
     2 * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Harvester server*
       
    15 */
       
    16 
       
    17 #include <e32svr.h>
       
    18 #include <apgcli.h>
       
    19 #include <apmrec.h>
       
    20 
       
    21 #include "harvesterserver.h"
       
    22 #include "harvesterserversession.h"
       
    23 #include "harvestercommon.h"
       
    24 #include "harvesterlog.h"
       
    25 #include "harvesterao.h"
       
    26 #include "harvesterblacklist.h"
       
    27 #include "mdsactivescheduler.h"
       
    28 
       
    29 // ----------------------------------------------------------------------------------------
       
    30 // Server's policy here
       
    31 // ----------------------------------------------------------------------------------------
       
    32 
       
    33 // ----------------------------------------------------------------------------------------
       
    34 // Total number of ranges
       
    35 // ----------------------------------------------------------------------------------------
       
    36 const TUint KHarvesterServerRangeCount = 10;
       
    37  
       
    38 // ----------------------------------------------------------------------------------------
       
    39 // Definition of the ranges
       
    40 // ----------------------------------------------------------------------------------------
       
    41 const TInt KHarvesterServerRanges[KHarvesterServerRangeCount] = 
       
    42 {
       
    43 	EResumeHarvester,        // Resume/start Harvester server
       
    44 	EPauseHarvester,          // Pause Harvester server
       
    45 	EHarvestFile,
       
    46     ERegisterProcessOrigin,
       
    47     EUnregisterProcessOrigin,
       
    48     ERegisterHarvestComplete,
       
    49     EUnregisterHarvestComplete,
       
    50     ERegisterHarvesterEvent,
       
    51     EUnregisterHarvesterEvent,
       
    52     EHarvestFileWithUID,
       
    53 };
       
    54 
       
    55 // ----------------------------------------------------------------------------------------
       
    56 // Policy to implement for each of the above ranges 
       
    57 // ----------------------------------------------------------------------------------------      
       
    58 const TUint8 KHarvesterServerElementsIndex[KHarvesterServerRangeCount] = 
       
    59 	{
       
    60 	CPolicyServer::ECustomCheck,    // EResumeHarvester
       
    61     CPolicyServer::ECustomCheck,    // EPauseHarvester
       
    62     CPolicyServer::ECustomCheck,    // EHarvestFile
       
    63     CPolicyServer::ECustomCheck,    // ERegisterProcessOrigin
       
    64     CPolicyServer::ECustomCheck,    // EUnregisterProcessOrigin
       
    65     CPolicyServer::ECustomCheck,    // ERegisterHarvestComplete
       
    66     CPolicyServer::ECustomCheck,    // EUnregisterHarvestComplete
       
    67     CPolicyServer::ECustomCheck,    // ERegisterHarvesterEvent
       
    68     CPolicyServer::ECustomCheck,    // EUnregisterHarvesterEvent
       
    69     CPolicyServer::ECustomCheck,    // EHarvestFileWithUID
       
    70 	};
       
    71 
       
    72 // ----------------------------------------------------------------------------------------
       
    73 // Package all the above together into a policy 
       
    74 // ---------------------------------------------------------------------------------------- 
       
    75 const CPolicyServer::TPolicy KHarvesterServerPolicy =
       
    76 	{
       
    77 	CPolicyServer::EAlwaysPass,
       
    78 	KHarvesterServerRangeCount,      // number of ranges
       
    79 	KHarvesterServerRanges,          // ranges array
       
    80 	KHarvesterServerElementsIndex,   // elements<->ranges index
       
    81 	NULL 
       
    82 	                           // array of elements
       
    83 	};
       
    84 
       
    85 // ---------------------------------------------------------------------------
       
    86 // CustomSecurityCheckL
       
    87 // ---------------------------------------------------------------------------
       
    88 //
       
    89 CPolicyServer::TCustomResult CHarvesterServer::CustomSecurityCheckL(
       
    90         const RMessage2& aMsg, TInt& /*aAction*/, TSecurityInfo& /*aMissing*/ )
       
    91 	{
       
    92     WRITELOG( "CHarvesterServer::CustomSecurityCheckL()" );
       
    93     
       
    94     CPolicyServer::TCustomResult securityCheckResult = EFail;
       
    95     
       
    96     switch ( aMsg.Function() )
       
    97     	{
       
    98         case ERegisterHarvestComplete:
       
    99         case EUnregisterHarvestComplete:
       
   100         case ERegisterHarvesterEvent:
       
   101         case EUnregisterHarvesterEvent:
       
   102             {
       
   103             if( aMsg.HasCapability( ECapabilityReadUserData ) )
       
   104                 {
       
   105                 securityCheckResult = EPass;
       
   106                 }
       
   107             break;
       
   108             }
       
   109     	
       
   110         case EHarvestFileWithUID:
       
   111             {
       
   112             if( aMsg.HasCapability( ECapabilityWriteUserData ) )
       
   113                 {
       
   114                 securityCheckResult = EPass;
       
   115                 }
       
   116             break;
       
   117             }
       
   118             
       
   119         case EHarvestFile:
       
   120     	case EResumeHarvester:
       
   121     	case EPauseHarvester:
       
   122     	case ERegisterProcessOrigin:
       
   123     	case EUnregisterProcessOrigin:
       
   124     			{
       
   125             if( aMsg.HasCapability( ECapabilityWriteDeviceData ) )
       
   126                 {
       
   127                 securityCheckResult = EPass;
       
   128                 }
       
   129     		}
       
   130         break;
       
   131         
       
   132         default:
       
   133             {
       
   134             securityCheckResult = EFail;
       
   135             }
       
   136    	    }
       
   137     
       
   138     return securityCheckResult;
       
   139 	}
       
   140 // ---------------------------------------------------------------------------
       
   141 // CustomFailureActionL
       
   142 // ---------------------------------------------------------------------------
       
   143 //
       
   144 CPolicyServer::TCustomResult CHarvesterServer::CustomFailureActionL(
       
   145         const RMessage2& /*aMsg*/, TInt /*aAction*/, const TSecurityInfo& /*aMissing*/ )
       
   146 	{
       
   147     // Not used
       
   148     return EFail;
       
   149 	}
       
   150  
       
   151 // ---------------------------------------------------------------------------
       
   152 // NewLC
       
   153 // ---------------------------------------------------------------------------
       
   154 //
       
   155 CHarvesterServer* CHarvesterServer::NewLC()
       
   156 	{
       
   157     WRITELOG( "CHarvesterServer::NewLC() - begin" );
       
   158     
       
   159 	CHarvesterServer* self = new (ELeave) CHarvesterServer(
       
   160 			CActive::EPriorityStandard, KHarvesterServerPolicy, 
       
   161 			ESharableSessions );
       
   162 	CleanupStack::PushL( self );
       
   163 	self->ConstructL();
       
   164 	return self;
       
   165 	}
       
   166 // ---------------------------------------------------------------------------
       
   167 // NewL
       
   168 // ---------------------------------------------------------------------------
       
   169 //
       
   170 CHarvesterServer* CHarvesterServer::NewL()
       
   171 	{
       
   172     WRITELOG( "CHarvesterServer::NewL() - begin" );
       
   173     
       
   174 	CHarvesterServer* self = CHarvesterServer::NewLC();
       
   175 	CleanupStack::Pop( self );
       
   176 	return self;
       
   177 	}
       
   178 
       
   179 // ---------------------------------------------------------------------------
       
   180 // CHarvesterServer
       
   181 // ---------------------------------------------------------------------------
       
   182 //
       
   183 CHarvesterServer::CHarvesterServer( TInt aPriority, const TPolicy& aPolicy, 
       
   184 		TServerType aType )
       
   185  	: CPolicyServer( aPriority, aPolicy, aType )
       
   186  	{
       
   187     WRITELOG( "CHarvesterServer::CHarvesterServer() - begin" );
       
   188  	}
       
   189 
       
   190 // ---------------------------------------------------------------------------
       
   191 // ConstructL
       
   192 // ---------------------------------------------------------------------------
       
   193 //
       
   194 void CHarvesterServer::ConstructL()
       
   195 	{
       
   196 	WRITELOG( "CHarvesterServer::ConstructL() - begin" );
       
   197 	StartL( KHarvesterServerName );
       
   198 	iHarvesterAO = CHarvesterAO::NewL();
       
   199 	iHarvesterAO->SetHarvesterStatusObserver( this );
       
   200 	
       
   201 	iPauseObserverAO = CPauseObserverAO::NewL( *this );
       
   202 	
       
   203     // create shutdown observer
       
   204     iShutdownObserver = CHarvesterShutdownObserver::NewL( *this );                                                
       
   205 	
       
   206 	WRITELOG( "CHarvesterServer::ConstructL() - end" );
       
   207 	}
       
   208 
       
   209 // ---------------------------------------------------------------------------
       
   210 // Pause
       
   211 // ---------------------------------------------------------------------------
       
   212 //
       
   213 void CHarvesterServer::Pause( const RMessage2& aMessage )
       
   214 	{
       
   215 	WRITELOG( "CHarvesterServer::Pause() - begin" );
       
   216 
       
   217 	if ( !iHarvesterAO->IsServerPaused() )
       
   218 		{
       
   219 		iMessage = &aMessage;
       
   220 		iHarvesterAO->SetNextRequest( CHarvesterAO::ERequestPause );
       
   221 		}
       
   222 	else
       
   223 		{
       
   224 		aMessage.Complete( KErrInUse );
       
   225 		}
       
   226 	}
       
   227 
       
   228 
       
   229 // ---------------------------------------------------------------------------
       
   230 // Resume
       
   231 // ---------------------------------------------------------------------------
       
   232 //
       
   233 void CHarvesterServer::Resume( const RMessage2& aMessage )
       
   234 	{
       
   235 	WRITELOG( "CHarvesterServer::Resume()" ); 
       
   236 	
       
   237 	if ( iHarvesterAO->IsServerPaused() )
       
   238 		{
       
   239 		iMessage = &aMessage;
       
   240 		iHarvesterAO->SetNextRequest( CHarvesterAO::ERequestResume );
       
   241 		}
       
   242 	else
       
   243 		{
       
   244 		aMessage.Complete( KErrInUse );
       
   245 		}
       
   246 	}
       
   247 
       
   248 // ---------------------------------------------------------------------------
       
   249 // Pause
       
   250 // ---------------------------------------------------------------------------
       
   251 //
       
   252 void CHarvesterServer::Pause()
       
   253 	{
       
   254 	WRITELOG( "CHarvesterServer::Pause()" );
       
   255 
       
   256 	if ( !iHarvesterAO->IsServerPaused() )
       
   257 		{
       
   258 		iHarvesterAO->SetNextRequest( CHarvesterAO::ERequestPause );
       
   259 		}
       
   260 	}
       
   261 
       
   262 // ---------------------------------------------------------------------------
       
   263 // Resume
       
   264 // ---------------------------------------------------------------------------
       
   265 //
       
   266 void CHarvesterServer::Resume()
       
   267 	{
       
   268 	WRITELOG( "CHarvesterServer::Resume()" ); 
       
   269 
       
   270 	if ( iHarvesterAO->IsServerPaused() )
       
   271 		{
       
   272 		iHarvesterAO->SetNextRequest( CHarvesterAO::ERequestResume );
       
   273 		}
       
   274 	}
       
   275 
       
   276 
       
   277 void CHarvesterServer::PauseReady( TInt aError )
       
   278 	{
       
   279 	WRITELOG1( "CHarvesterServer::PauseReady( %d )", aError );
       
   280 	if( iMessage )
       
   281 		{
       
   282 		iMessage->Complete( aError );
       
   283 		iMessage = NULL;
       
   284 		}
       
   285 	}
       
   286 
       
   287 void CHarvesterServer::ResumeReady( TInt aError )
       
   288 	{
       
   289 	WRITELOG1( "CHarvesterServer::ResumeReady( %d )", aError );
       
   290 	if( iMessage )
       
   291 		{
       
   292 		iMessage->Complete( aError );
       
   293 		iMessage = NULL;
       
   294 		}
       
   295 	}
       
   296 
       
   297 // -----------------------------------------------------------------------------
       
   298 // CHarvesterServer::ShutdownNotification
       
   299 // -----------------------------------------------------------------------------
       
   300 //
       
   301 void CHarvesterServer::ShutdownNotification()
       
   302     {
       
   303     WRITELOG( "CHarvesterServer::ShutdownNotification" );
       
   304     CActiveScheduler::Stop();
       
   305     }
       
   306 
       
   307 // -----------------------------------------------------------------------------
       
   308 // CHarvesterServer::ShutdownNotification
       
   309 // -----------------------------------------------------------------------------
       
   310 //
       
   311 void CHarvesterServer::RestartNotification()
       
   312     {
       
   313     WRITELOG( "CHarvesterServer::RestartNotification" );    
       
   314     }
       
   315 
       
   316 
       
   317 // ---------------------------------------------------------------------------
       
   318 // Harvest File
       
   319 // ---------------------------------------------------------------------------
       
   320 //
       
   321 void CHarvesterServer::HarvestFile( const RMessage2& aMessage )
       
   322 	{
       
   323 	WRITELOG( "CHarvesterServer::HarvestFile()" );
       
   324 	
       
   325 	iHarvesterAO->HarvestFile( aMessage );
       
   326 	}
       
   327 
       
   328 // ---------------------------------------------------------------------------
       
   329 // Harvest File with UID
       
   330 // ---------------------------------------------------------------------------
       
   331 //
       
   332 void CHarvesterServer::HarvestFileWithUID( const RMessage2& aMessage )
       
   333     {
       
   334     WRITELOG( "CHarvesterServer::HarvestFile()" );
       
   335     
       
   336     iHarvesterAO->HarvestFileWithUID( aMessage );
       
   337     }
       
   338 
       
   339 // ---------------------------------------------------------------------------
       
   340 // CHarvesterServer::RegisterProcessOrigin()
       
   341 // ---------------------------------------------------------------------------
       
   342 //
       
   343 void CHarvesterServer::RegisterProcessOrigin( const RMessage2& aMessage )
       
   344     {
       
   345     WRITELOG( "CHarvesterServer::RegisterProcessOrigin()" );
       
   346     
       
   347     iHarvesterAO->RegisterProcessOrigin( aMessage );
       
   348     }
       
   349 
       
   350 // ---------------------------------------------------------------------------
       
   351 // CHarvesterServer::UnregisterProcessOrigin()
       
   352 // ---------------------------------------------------------------------------
       
   353 //
       
   354 void CHarvesterServer::UnregisterProcessOrigin( const RMessage2& aMessage )
       
   355     {
       
   356     WRITELOG( "CHarvesterServer::UnregisterProcessOrigin()" );
       
   357     
       
   358     iHarvesterAO->UnregisterProcessOrigin( aMessage );
       
   359     }
       
   360 
       
   361 // ---------------------------------------------------------------------------
       
   362 // CHarvesterServer::RegisterHarvestComplete()
       
   363 // ---------------------------------------------------------------------------
       
   364 //
       
   365 TInt CHarvesterServer::RegisterHarvestComplete( const CHarvesterServerSession& aSession, const RMessage2& aMessage )
       
   366     {
       
   367     WRITELOG( "CHarvesterServer::RegisterHarvestComplete()" );
       
   368     
       
   369     return iHarvesterAO->RegisterHarvestComplete( aSession, aMessage );
       
   370     }
       
   371 
       
   372 // ---------------------------------------------------------------------------
       
   373 // CHarvesterServer::UnregisterHarvestComplete()
       
   374 // ---------------------------------------------------------------------------
       
   375 //
       
   376 TInt CHarvesterServer::UnregisterHarvestComplete( const CHarvesterServerSession& aSession )
       
   377     {
       
   378     WRITELOG( "CHarvesterServer::UnregisterHarvestComplete()" );
       
   379     
       
   380     return iHarvesterAO->UnregisterHarvestComplete( aSession );
       
   381     }
       
   382 
       
   383 // ---------------------------------------------------------------------------
       
   384 // CHarvesterServer::RegisterHarvesterEvent()
       
   385 // ---------------------------------------------------------------------------
       
   386 //
       
   387 void CHarvesterServer::RegisterHarvesterEvent( const RMessage2& aMessage )
       
   388     {
       
   389     WRITELOG( "CHarvesterServer::RegisterHarvesterEvent()" );
       
   390     
       
   391     iHarvesterAO->RegisterHarvesterEvent( aMessage );
       
   392     }
       
   393 
       
   394 // ---------------------------------------------------------------------------
       
   395 // CHarvesterServer::UnregisterHarvesterEvent()
       
   396 // ---------------------------------------------------------------------------
       
   397 //
       
   398 void CHarvesterServer::UnregisterHarvesterEvent( const RMessage2& aMessage )
       
   399     {
       
   400     WRITELOG( "CHarvesterServer::UnregisterHarvesterEvent()" );
       
   401     
       
   402     iHarvesterAO->UnregisterHarvesterEvent( aMessage );
       
   403     }
       
   404 
       
   405 // ---------------------------------------------------------------------------
       
   406 // ~CHarvesterServer
       
   407 // ---------------------------------------------------------------------------
       
   408 //
       
   409 CHarvesterServer::~CHarvesterServer()
       
   410     {
       
   411     WRITELOG( "CHarvesterServer::~CHarvesterServer()" );
       
   412     delete iHarvesterAO;
       
   413     delete iPauseObserverAO;
       
   414     delete iShutdownObserver;
       
   415     WRITELOG( "CHarvesterServer::~CHarvesterServer() end" );
       
   416     }
       
   417 
       
   418 // ---------------------------------------------------------------------------
       
   419 // PanicClient
       
   420 // ---------------------------------------------------------------------------
       
   421 //
       
   422 void CHarvesterServer::PanicClient( const RMessage2& aMessage, TInt aPanic, 
       
   423 											const TDesC& aPanicDescription )
       
   424 	{
       
   425     WRITELOG( "CHarvesterServer::PanicClient()" );
       
   426     
       
   427     aMessage.Panic( aPanicDescription, aPanic );
       
   428  	}
       
   429 
       
   430 // ---------------------------------------------------------------------------
       
   431 // PanicServer
       
   432 // ---------------------------------------------------------------------------
       
   433 //
       
   434 void CHarvesterServer::PanicServer( TInt aPanic, const TDesC& aPanicDescription )
       
   435 	{   
       
   436     WRITELOG( "CHarvesterServer::PanicServer() - begin" );
       
   437     
       
   438     User::Panic( aPanicDescription, aPanic );
       
   439  	}
       
   440 
       
   441 // ---------------------------------------------------------------------------
       
   442 // NewSessionL
       
   443 // ---------------------------------------------------------------------------
       
   444 //
       
   445 CSession2* CHarvesterServer::NewSessionL(
       
   446     const TVersion& aVersion, const RMessage2& ) const
       
   447 	{
       
   448 	WRITELOG( "CHarvesterServer::NewSessionL() - begin" );
       
   449 
       
   450     //If there isn't connection to mde, we can't do much. Inform client about situation.
       
   451     //This doesn't leave on first client because Process::Rendezcvouz is called when mde:s
       
   452     //HandleSessionOpened is called.
       
   453 	if (!iHarvesterAO->IsConnectedToMde())
       
   454 	    {
       
   455 	    User::Leave(KErrNotReady);
       
   456 	    }
       
   457     
       
   458 	if ( iShutdownObserver->UpdateInProgress() )
       
   459 	    {
       
   460 	    WRITELOG( "CHarvesterServer::NewSessionL - iad update in progress: KErrLocked");
       
   461 	    User::Leave(KErrLocked);
       
   462 	    }
       
   463 
       
   464     // Check we are the right version
       
   465     if ( !User::QueryVersionSupported( TVersion( KHarvesterServerMajorVersion,
       
   466                                                  KHarvesterServerMinorVersion,
       
   467                                                  KHarvesterServerBuildVersion ),
       
   468                                        aVersion ) )
       
   469     	{
       
   470         User::Leave( KErrNotSupported );
       
   471     	}
       
   472 
       
   473     return CHarvesterServerSession::NewL( *const_cast<CHarvesterServer*>( this ) );
       
   474 	}
       
   475 
       
   476 	
       
   477 // ---------------------------------------------------------------------------
       
   478 // RunError
       
   479 // ---------------------------------------------------------------------------
       
   480 //
       
   481 TInt CHarvesterServer::RunError( TInt aError )
       
   482 	{
       
   483 	WRITELOG1( "CHarvesterServer::RunError - %d()", aError );
       
   484 	    
       
   485     if ( aError == KErrBadDescriptor )
       
   486  		{
       
   487         // A bad descriptor error implies a badly programmed client,
       
   488         // so panic it; otherwise report the error to the client
       
   489         PanicClient( Message(), KErrBadDescriptor );
       
   490     	}
       
   491     else
       
   492     	{
       
   493         Message().Complete( aError );
       
   494     	}
       
   495 
       
   496     // The leave will result in an early return from CServer::RunL(), skipping
       
   497     // the call to request another message. So do that now in order to keep the
       
   498     // server running.
       
   499     ReStart();
       
   500 
       
   501     return KErrNone;    // Handled the error fully
       
   502  	}
       
   503 
       
   504 // ---------------------------------------------------------------------------
       
   505 // ThreadFunctionL
       
   506 // ---------------------------------------------------------------------------
       
   507 //
       
   508 void CHarvesterServer::ThreadFunctionL()
       
   509 	{
       
   510 	WRITELOG( "CHarvesterServer::ThreadFunctionL() - begin" );
       
   511     
       
   512     User::LeaveIfError( User::RenameThread( KHarvesterServerName ) );
       
   513     // Construct active scheduler
       
   514     CActiveScheduler* activeScheduler = new (ELeave) CActiveScheduler;
       
   515     CleanupStack::PushL( activeScheduler );
       
   516 
       
   517     // Install active scheduler
       
   518     // We don't need to check whether an active scheduler is already installed
       
   519     // as this is a new thread, so there won't be one
       
   520     CActiveScheduler::Install( activeScheduler );
       
   521     
       
   522     CHarvesterServer::NewLC();
       
   523 
       
   524     RProcess::Rendezvous(KErrNone);
       
   525 
       
   526     // Start handling requests
       
   527 	CActiveScheduler::Start();
       
   528 
       
   529 	CleanupStack::PopAndDestroy( 2, activeScheduler );
       
   530     
       
   531     WRITELOG( "CHarvesterServer::ThreadFunctionL() - end" );
       
   532 	}
       
   533 
       
   534 // ---------------------------------------------------------------------------
       
   535 // ThreadFunction
       
   536 // ---------------------------------------------------------------------------
       
   537 //
       
   538 TInt CHarvesterServer::ThreadFunction( TAny* /*aNone*/ )
       
   539 	{    
       
   540  	WRITELOG( "CHarvesterServer::ThreadFunction() - TAny - begin" );
       
   541  	
       
   542     CTrapCleanup* cleanupStack = CTrapCleanup::New();
       
   543 	if ( !cleanupStack )
       
   544 		{
       
   545         PanicServer( KErrServerTerminated );
       
   546 	 	}
       
   547 
       
   548     TRAPD( err, ThreadFunctionL() );
       
   549 
       
   550     if ( cleanupStack )
       
   551     	{
       
   552         delete cleanupStack;
       
   553         cleanupStack = NULL;	
       
   554     	}
       
   555     WRITELOG( "CHarvesterServer::ThreadFunction() - TAny - end" );
       
   556     
       
   557     return err;
       
   558 	}
       
   559 
       
   560 // ---------------------------------------------------------------------------
       
   561 // E32Main
       
   562 // ---------------------------------------------------------------------------
       
   563 //
       
   564 TInt E32Main()
       
   565 	{    
       
   566     WRITELOG( "CHarvesterServer::E32Main() - begin" );
       
   567 
       
   568     __UHEAP_MARK;
       
   569 
       
   570     const TInt result = CHarvesterServer::ThreadFunction( NULL );
       
   571 
       
   572     __UHEAP_MARKEND;
       
   573 
       
   574     return result;
       
   575 	}
       
   576 
       
   577 // End of file
       
   578 
       
   579