sl@0: // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: #include <bsul/bsul.h>
sl@0: #include "CSCHCODE.H"
sl@0: #include "SCHINFO.H"
sl@0: 
sl@0: using namespace BSUL;
sl@0: 
sl@0: /**
sl@0: Intended Usage : This Enum lists the currently supported Custom Parameter types.  
sl@0: The lower 16 bits of these enum values are used as indices to the 
sl@0: Parameter Factory Function which instantiates the appropriate 
sl@0: CMessageParammeterBase derived object to represent a given message parameter.  
sl@0: The upper 16 bits of these values are used as the index in the array 
sl@0: of custom validation functions.  If the upper 16bits are set to 0, the default
sl@0: validation is used.
sl@0: */
sl@0: enum TCustomParamType
sl@0: 	{
sl@0: 	EParamTScheduleSettings2 = (0x10000 | EParamPckg),
sl@0: 	EParamTTsTime = (0x20000 | EParamPckg),
sl@0: 	EParamTTaskInfo = (0x30000 | EParamPckg),
sl@0: 	EParamTScheduleInfo = (0x40000 | EParamPckg),
sl@0: 	EParamTSchedulerItemRef = (0x50000 | EParamPckg)
sl@0: 	};
sl@0: 
sl@0: /* These are the parameter description sets for each message to be handled by the
sl@0:  * server. These descriptions provide the type of the parameter and constraints
sl@0:  * used to validate messages recieved from the client.  The particular validation
sl@0:  * requirements are defined in the appropriate CMessageParameterBase derived class
sl@0:  * and parameter objects are instantiated via the Parameter factory Lookup table.
sl@0:  */
sl@0: const TInt KMaxInt32 = 	0x7FFFFFFF;
sl@0: const TInt KMinInt32 = 	0x80000000;
sl@0: const TInt KMaxTDes8 = 0x0FFFFFFF;
sl@0: const TInt KMaxSchedules = 25000;//Max of 25000 schedules
sl@0: const TInt KMaxScheduleId = (10000 * (KMaxSchedules - 1));//Schedule IDs have an offset of 10000
sl@0: const TInt KMaxTasks = 9999;//Max of 9999 tasks per schedule
sl@0: const TInt KMaxTaskId = (KMaxScheduleId + KMaxTasks);
sl@0: 
sl@0: const TParameterDetails KIntParam[] = {EParamInt,KMinInt32,KMaxInt32};
sl@0: 
sl@0: 
sl@0: const TParameterDetails KRegisterClientParam[] = 	{{EParamDes16Read,0,KMaxFileName},
sl@0: 													{EParamInt,0,KMaxInt32}};
sl@0: 
sl@0: const TParameterDetails KCreateTimeSchedParam[] = 	{{EParamTScheduleSettings2,sizeof(TScheduleSettings2),sizeof(TScheduleSettings2)},
sl@0: 													{EParamDes8Read,0,KMaxTDes8},
sl@0: 													{EParamPckg,sizeof(TInt),sizeof(TInt)}};
sl@0: 
sl@0: const TParameterDetails KCreateCondSchedParam[] = 	{{EParamTScheduleSettings2,sizeof(TScheduleSettings2),sizeof(TScheduleSettings2)},
sl@0: 													{EParamDes8Read,0,KMaxTDes8},
sl@0: 													{EParamTTsTime, sizeof(TTsTime), sizeof(TTsTime)},
sl@0: 													{EParamPckg,sizeof(TInt),sizeof(TInt)}};
sl@0: 
sl@0: const TParameterDetails KScheduleTaskParam[] = 		{{EParamTTaskInfo,sizeof(TTaskInfo),sizeof(TTaskInfo)},
sl@0: 													{EParamInt,0,KMaxScheduleId},
sl@0: 													{EParamPckg,sizeof(TInt),sizeof(TInt)},
sl@0: 													{EParamDes16,0,KMaxTDes8}};
sl@0: 
sl@0: const TParameterDetails KScheduleIdParam[] = 		{EParamInt,0,KMaxScheduleId};
sl@0: 
sl@0: const TParameterDetails KEditTimeSchedParam[] = 	{{EParamInt,0,KMaxTasks},
sl@0: 													{EParamInt,0,KMaxScheduleId},
sl@0: 													{EParamDes8Read,0,KMaxTDes8}};
sl@0: 
sl@0: const TParameterDetails KEditCondSchedParam[] = 	{{EParamInt,0,KMaxTasks},
sl@0: 													{EParamInt,0,KMaxScheduleId},
sl@0: 													{EParamDes8Read,0,KMaxTDes8},
sl@0: 													{EParamTTsTime, sizeof(TTsTime), sizeof(TTsTime)}};
sl@0: 
sl@0: const TParameterDetails KGetSchedRefsParam[] = 		{{EParamInt,0,KMaxSchedules},
sl@0: 													{EParamInt,EAllSchedules,EPendingSchedules},
sl@0: 													{EParamDes8,0,KMaxTDes8}};
sl@0: 
sl@0: const TParameterDetails KCountSchedulesParam[] = 	{{EParamPckg,sizeof(TInt),sizeof(TInt)},
sl@0: 													{EParamInt,EAllSchedules,EPendingSchedules}};
sl@0: 
sl@0: const TParameterDetails KGetSchedInfoParam[] = 		{{EParamInt,0,KMaxScheduleId},
sl@0: 													{EParamDes8,sizeof(TScheduleInfo), sizeof(TScheduleInfo)},
sl@0: 													{EParamDes8, 0, sizeof(TTsTime)}};
sl@0: 
sl@0: const TParameterDetails KGetTimeSchedDataParam[] = 	{{EParamInt,0,KMaxScheduleId},
sl@0: 													{EParamTScheduleInfo,sizeof(TScheduleInfo), sizeof(TScheduleInfo)},
sl@0: 													{EParamDes8,0,KMaxTDes8}};
sl@0: 
sl@0: const TParameterDetails KGetCondSchedDataParam[] = 	{{EParamInt,0,KMaxScheduleId},
sl@0: 													{EParamTScheduleInfo,sizeof(TScheduleInfo), sizeof(TScheduleInfo)},
sl@0: 													{EParamDes8,0,KMaxTDes8},
sl@0: 													{EParamDes8, 0, sizeof(TTsTime)}};
sl@0: 
sl@0: const TParameterDetails KGetTaskDataParam[] = 		{{EParamInt,0,KMaxScheduleId},
sl@0: 													{EParamTScheduleInfo,sizeof(TScheduleInfo), sizeof(TScheduleInfo)},
sl@0: 													{EParamDes8,0,KMaxTDes8}};
sl@0: 
sl@0: const TParameterDetails KGetTaskRefsParam[] = 		{{EParamInt,0,KMaxTasks},
sl@0: 													{EParamInt,EAllSchedules,EPendingSchedules},
sl@0: 													{EParamInt,EAllTasks,EMyTasks},
sl@0: 													{EParamDes8,0,KMaxTDes8}};
sl@0: 
sl@0: const TParameterDetails KCountTasksParam[] = 		{{EParamPckg,sizeof(TInt),sizeof(TInt)},
sl@0: 													{EParamInt,EAllSchedules,EPendingSchedules},
sl@0: 													{EParamInt,EAllTasks,EMyTasks}};
sl@0: 
sl@0: const TParameterDetails KGetTaskParam[] = 			{{EParamInt,KMinInt32,KMaxInt32},
sl@0: 													{EParamDes8,0,sizeof(TTaskInfo)},
sl@0: 													{EParamInt,KMinInt32,KMaxInt32},
sl@0: 													{EParamDes16,0,KMaxTDes8}};
sl@0: 
sl@0: const TParameterDetails KGetScheduledItemRefParam[] = {{EParamInt,0,KMaxTaskId},
sl@0: 													{EParamDes8,0, sizeof(TSchedulerItemRef)},
sl@0: 													{EParamDes8,0, sizeof(TTsTime)}};
sl@0: 
sl@0: const TParameterDetails KDeleteTaskParam[] = 		{EParamInt,KMinInt32,KMaxInt32};
sl@0: 
sl@0: const TParameterDetails KGetTaskDataSizeParam[] = 	{{EParamInt,KMinInt32,KMaxInt32},
sl@0: 													{EParamPckg,sizeof(TInt),sizeof(TInt)}};
sl@0: 
sl@0: const TParameterDetails KGetScheduleTypeParam[] = 	{{EParamInt,0,KMaxScheduleId},
sl@0: 													{EParamPckg,sizeof(TInt),sizeof(TInt)}};
sl@0: 
sl@0: 
sl@0: /* This Security Policy defines the requirements for a client to interact
sl@0:  * with the server. If a client sends a request to the server and doesnt
sl@0:  * meet the security policy, the request is denied with KErrAccessDenied.
sl@0:  * For the bakup server no policy is required so a default always pass
sl@0:  * policy is used.
sl@0:  */
sl@0: _LIT_SECURITY_POLICY_PASS(KDefaultPolicy);
sl@0: 
sl@0: /* This is the array of messages that will be accepted by the server.  
sl@0:  * The messages are defined as follows:
sl@0:  *  	{Function Number, Security Policy, Number of Parameters, Parameter Descriptions}
sl@0:  * A Binary search is used to locate the messages in the table therefore
sl@0:  * the messages MUST appear in the list below sorted by function number.
sl@0:  */
sl@0: const TClientMessageSchema KClientMessages[] = 
sl@0: 				{
sl@0: 				MESSAGE_SCHEMA(ERegisterClient,KDefaultPolicy,KRegisterClientParam),
sl@0: 				MESSAGE_SCHEMA(ECreateTimeSchedule,KDefaultPolicy,KCreateTimeSchedParam),
sl@0: 				MESSAGE_SCHEMA(ECreateConditionSchedule,KDefaultPolicy,KCreateCondSchedParam),
sl@0: 				MESSAGE_SCHEMA(EScheduleTask,KDefaultPolicy,KScheduleTaskParam),
sl@0: 				MESSAGE_SCHEMA(EDisableSchedule,KDefaultPolicy,KScheduleIdParam),
sl@0: 				MESSAGE_SCHEMA(EEnableSchedule,KDefaultPolicy,KScheduleIdParam),
sl@0: 				MESSAGE_SCHEMA(EDeleteSchedule,KDefaultPolicy,KScheduleIdParam),
sl@0: 				MESSAGE_SCHEMA(EEditTimeSchedule,KDefaultPolicy,KEditTimeSchedParam),
sl@0: 				MESSAGE_SCHEMA(EEditConditionSchedule,KDefaultPolicy,KEditCondSchedParam),
sl@0: 				MESSAGE_SCHEMA(EGetScheduleInfo,KDefaultPolicy,KGetSchedInfoParam),
sl@0: 				MESSAGE_SCHEMA(EGetTimeScheduleData,KDefaultPolicy,KGetTimeSchedDataParam),
sl@0: 				MESSAGE_SCHEMA(EGetConditionScheduleData,KDefaultPolicy,KGetCondSchedDataParam),
sl@0: 				MESSAGE_SCHEMA(EGetTaskData,KDefaultPolicy,KGetTaskDataParam),
sl@0: 				MESSAGE_SCHEMA(ECountSchedules,KDefaultPolicy,KCountSchedulesParam),
sl@0: 				MESSAGE_SCHEMA(ECountTasks,KDefaultPolicy,KCountTasksParam),
sl@0: 				MESSAGE_SCHEMA(EGetTaskRefs,KDefaultPolicy,KGetTaskRefsParam),
sl@0: 				MESSAGE_SCHEMA(EGetTask,KDefaultPolicy,KGetTaskParam),
sl@0: 				MESSAGE_SCHEMA(EGetTaskDataSize,KDefaultPolicy,KGetTaskDataSizeParam),
sl@0: 				MESSAGE_SCHEMA(EGetScheduleRefs,KDefaultPolicy,KGetSchedRefsParam),
sl@0: 				MESSAGE_SCHEMA(EDeleteTask,KDefaultPolicy,KDeleteTaskParam),
sl@0: 				MESSAGE_SCHEMA(EGetSchedulerItemRefAndNextDueTime,KDefaultPolicy,KGetScheduledItemRefParam),
sl@0: 				MESSAGE_SCHEMA(EGetScheduleType,KDefaultPolicy,KGetScheduleTypeParam),
sl@0: 				MESSAGE_SCHEMA_NO_PARAMS(ESchDbgMarkHeap,KDefaultPolicy),
sl@0: 				MESSAGE_SCHEMA(ESchDbgCheckHeap,KDefaultPolicy,KIntParam),
sl@0: 				MESSAGE_SCHEMA(ESchDbgMarkEnd,KDefaultPolicy,KIntParam),
sl@0: 				MESSAGE_SCHEMA(ESchDbgFailNext,KDefaultPolicy,KIntParam),
sl@0: 				MESSAGE_SCHEMA_NO_PARAMS(ESchDbgResetHeap,KDefaultPolicy),
sl@0: 				MESSAGE_SCHEMA_NO_PARAMS(ESchFaultServer,KDefaultPolicy)
sl@0: 				};
sl@0: 
sl@0: 
sl@0: static void ValidateTTsTimeL(CMessageParameterBase* aParameter);
sl@0: static void ValidateTTaskInfoL(CMessageParameterBase* aParameter);
sl@0: static void ValidateTScheduleInfoL(CMessageParameterBase* aParameter);
sl@0: static void ValidateTSchedulerItemRefL(CMessageParameterBase* aParameter);
sl@0: static void ValidateTScheduleSettingsL(CMessageParameterBase* aParameter);
sl@0: 
sl@0: /* This is the array of custom validation functions that are used to validate
sl@0:  * parameters based on CPckgParameter parameter types
sl@0:  */
sl@0: const TCustomValidationFn KCustomValidationFunctions[] = {NULL,
sl@0: 															&ValidateTScheduleSettingsL,
sl@0: 															&ValidateTTsTimeL,
sl@0: 															&ValidateTTaskInfoL,
sl@0: 															&ValidateTScheduleInfoL,
sl@0: 															&ValidateTSchedulerItemRefL
sl@0: 															};
sl@0: 
sl@0: /*This struct defines the server data to be passed to the message framework on
sl@0:  * initialisation
sl@0:  */
sl@0: extern const TClientMessageServerData KServerData = SERVER_DATA(KClientMessages,
sl@0: 																KCustomValidationFunctions,
sl@0: 																"Task Scheduler",
sl@0: 																ESrvFlagLogBadMessages);
sl@0: 	 
sl@0: /*
sl@0: Custom validation function for EParamTTsTime parameters.
sl@0: Checks that the TPckg passed in to the server is exactly the size 
sl@0: defined in the schema. Reads the value from the clients message to 
sl@0: ensure the data is valid.
sl@0: @param aParameter The parameter object to be validated
sl@0: @leave KErrBadDescriptor if the TPckg passed in to the server is not 
sl@0: 		the expected size	
sl@0: @leave Any other system-wide error code.
sl@0: */
sl@0: void ValidateTTsTimeL(CMessageParameterBase* aParameter)
sl@0: 	{
sl@0: 	TTsTime time;
sl@0: 	TPckg<TTsTime> pTime(time);
sl@0: 	
sl@0: 	TInt length = aParameter->GetDesLengthL();
sl@0: 	
sl@0: 	if((length < aParameter->Min())||(length > aParameter->Max()))
sl@0: 		{
sl@0: 		User::Leave(KErrBadDescriptor);
sl@0: 		}
sl@0: 	
sl@0: 	aParameter->ReadL(pTime,0);
sl@0: 		
sl@0: 	}
sl@0: 
sl@0: /*
sl@0: Custom validation function for EParamTTaskInfo parameters.
sl@0: Checks that the TPckg passed in to the server is exactly the size 
sl@0: defined in the schema. Reads the value from the clients message to 
sl@0: ensure the data is valid.
sl@0: @param aParameter The parameter object to be validated
sl@0: @leave KErrBadDescriptor if the TPckg passed in to the server is not 
sl@0: 		the expected size	
sl@0: @leave Any other system-wide error code.
sl@0: */
sl@0: void ValidateTTaskInfoL(CMessageParameterBase* aParameter)
sl@0: 	{
sl@0: 	TTaskInfo taskInfo;
sl@0: 	TPckg<TTaskInfo> pTaskInfo(taskInfo);
sl@0: 	
sl@0: 	TInt length = aParameter->GetDesLengthL();
sl@0: 	
sl@0: 	if((length < aParameter->Min())||(length > aParameter->Max()))
sl@0: 		{
sl@0: 		User::Leave(KErrBadDescriptor);
sl@0: 		}
sl@0: 	
sl@0: 	aParameter->ReadL(pTaskInfo,0);
sl@0: 	}
sl@0: 
sl@0: /*
sl@0: Custom validation function for EParamTScheduleInfo parameters.
sl@0: Checks that the TPckg passed in to the server is exactly the size 
sl@0: defined in the schema. Reads the value from the clients message to 
sl@0: ensure the data is valid.
sl@0: @param aParameter The parameter object to be validated
sl@0: @leave KErrBadDescriptor if the TPckg passed in to the server is not 
sl@0: 		the expected size	
sl@0: @leave Any other system-wide error code.
sl@0: */
sl@0: void ValidateTScheduleInfoL(CMessageParameterBase* aParameter)
sl@0: 	{
sl@0: 	TScheduleInfo scheduleInfo;
sl@0: 	TPckg<TScheduleInfo> pScheduleInfo(scheduleInfo);
sl@0: 	
sl@0: 	TInt length = aParameter->GetDesLengthL();
sl@0: 	
sl@0: 	if((length < aParameter->Min())||(length > aParameter->Max()))
sl@0: 		{
sl@0: 		User::Leave(KErrBadDescriptor);
sl@0: 		}
sl@0: 	
sl@0: 	aParameter->ReadL(pScheduleInfo,0);
sl@0: 	}
sl@0: 
sl@0: /*
sl@0: Custom validation function for EParamTSchedulerItemRef parameters.
sl@0: Checks that the TPckg passed in to the server is exactly the size 
sl@0: defined in the schema. Reads the value from the clients message to 
sl@0: ensure the data is valid.
sl@0: @param aParameter The parameter object to be validated
sl@0: @leave KErrBadDescriptor if the TPckg passed in to the server is not 
sl@0: 		the expected size	
sl@0: @leave Any other system-wide error code.
sl@0: */
sl@0: void ValidateTSchedulerItemRefL(CMessageParameterBase* aParameter)
sl@0: 	{
sl@0: 	TSchedulerItemRef itemRef;
sl@0: 	TPckg<TSchedulerItemRef> pItemRef(itemRef);
sl@0: 	
sl@0: 	TInt length = aParameter->GetDesLengthL();
sl@0: 	
sl@0: 	if((length < aParameter->Min())||(length > aParameter->Max()))
sl@0: 		{
sl@0: 		User::Leave(KErrBadDescriptor);
sl@0: 		}
sl@0: 	
sl@0: 	aParameter->ReadL(pItemRef,0);
sl@0: 	}
sl@0: 
sl@0: /*
sl@0: Custom validation function for EParamTScheduleSettings2 parameters.
sl@0: Checks that the TPckg passed in to the server is exactly the size 
sl@0: defined in the schema. Reads the value from the clients message to 
sl@0: ensure the data is valid. Checks iEntryCount is > 0.
sl@0: @param aParameter The parameter object to be validated
sl@0: @leave KErrBadDescriptor if the TPckg passed in to the server is not 
sl@0: 		the expected size	
sl@0: @leave Any other system-wide error code.
sl@0: */
sl@0: void ValidateTScheduleSettingsL(CMessageParameterBase* aParameter)
sl@0: 	{
sl@0: 	TScheduleSettings2 settings;
sl@0: 	TPckg<TScheduleSettings2> pSettings(settings);
sl@0: 	
sl@0: 	TInt length = aParameter->GetDesLengthL();
sl@0: 	
sl@0: 	if((length < aParameter->Min())||(length > aParameter->Max()))
sl@0: 		{
sl@0: 		User::Leave(KErrBadDescriptor);
sl@0: 		}
sl@0: 	
sl@0: 	aParameter->ReadL(pSettings,0);
sl@0: 	
sl@0: 	if(settings.iEntryCount < 0)
sl@0: 		{
sl@0: 		User::Leave(KErrBadParameter);
sl@0: 		}
sl@0: 
sl@0: 	}