sl@0: // Copyright (c) 2004-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 "SCHTASK.H"
sl@0: #include "taskfile.h"
sl@0: #include "SCHEXEC.H"
sl@0: #include <schinfointernal.h>
sl@0: 
sl@0: /**
sl@0: Returns the index of the slot in the process environment data that contains the
sl@0: shared file server session (RFs) handle passed from the Task Scheduler.
sl@0: 
sl@0: @return The index of the shared file server session handle
sl@0: @see RFile::AdoptFromCreator
sl@0: */
sl@0: EXPORT_C TInt TScheduledTaskFile::FsHandleIndex()
sl@0: 	{
sl@0: 	return KTaskFsHandleIndex;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Returns the index of the slot in the process environment data that contains the
sl@0: shared file (RFile) handle passed from the Task Scheduler.
sl@0: 
sl@0: @return The index of the shared file handle
sl@0: @see RFile::AdoptFromCreator
sl@0: */
sl@0: EXPORT_C TInt TScheduledTaskFile::FileHandleIndex()
sl@0: 	{
sl@0: 	return KTaskFileHandleIndex;
sl@0: 	}
sl@0: 
sl@0: /** Creates the object from the specified stream.
sl@0: 
sl@0: @param aStream The stream containing the external representation of this object.
sl@0: @return A new instance of a CScheduledTask object. */
sl@0: EXPORT_C CScheduledTask* CScheduledTask::NewLC(RReadStream& aStream)
sl@0: 	{
sl@0: 	CScheduledTask* self = new(ELeave) CScheduledTask;
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->InternalizeL(aStream);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: CScheduledTask::CScheduledTask()
sl@0: 	{
sl@0: 	}
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: CScheduledTask::CScheduledTask(TTaskInfo& aInfo, 
sl@0: 								HBufC* aData, 
sl@0: 								TScheduleType aScheduleType,
sl@0: 								const TSecurityInfo& aSecurityInfo)
sl@0: :	iInfo(aInfo), 
sl@0: 	iData(aData),
sl@0: 	iScheduleType(aScheduleType),
sl@0: 	iSecurityInfo(aSecurityInfo)
sl@0: 	{
sl@0: 	iPLink.iPriority = aInfo.iPriority;
sl@0: 	}
sl@0: 
sl@0: CScheduledTask::~CScheduledTask()
sl@0: 	{
sl@0: 	delete iData;
sl@0: 	}
sl@0: /**
sl@0: Remove from queue
sl@0: @internalComponent only used by server
sl@0: */
sl@0: void CScheduledTask::Remove()
sl@0: 	{
sl@0: 	iPLink.Deque();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: queue offset
sl@0: @internalComponent only used by server
sl@0: */
sl@0: TInt CScheduledTask::Offset()
sl@0: 	{
sl@0: 	return (_FOFF(CScheduledTask,iPLink));
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Gets the detailed information for the task.
sl@0: 
sl@0: @return Detailed information about a task. */
sl@0: EXPORT_C const TTaskInfo& CScheduledTask::Info() const 
sl@0: 	{
sl@0: 	return iInfo;
sl@0: 	}
sl@0: 	
sl@0: /** Gets a reference to the data to be passed to the program on execution.
sl@0: 
sl@0: @return A reference to the descriptor containing the data. */
sl@0: EXPORT_C const HBufC& CScheduledTask::Data() const
sl@0: 	{
sl@0: 	return *iData;
sl@0: 	}
sl@0: 
sl@0: /** Gets the time when the task stops being valid.
sl@0: 
sl@0: If the executing program determines that this time is in the past, then it 
sl@0: should not run the task.
sl@0: 
sl@0: @return The time when the task stops being valid */
sl@0: EXPORT_C const TTsTime& CScheduledTask::ValidUntil() const
sl@0: 	{
sl@0: 	return iValidUntil;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Gets the schedules type.
sl@0: */	
sl@0: EXPORT_C TScheduleType CScheduledTask::ScheduleType() const
sl@0: 	{
sl@0: 	return iScheduleType;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Gets the security information for this scheduled task.  This information
sl@0: is the securityID, VenforID and capabilities of the client who created
sl@0: the schedule responsible for invoking this task.
sl@0: */
sl@0: EXPORT_C const TSecurityInfo& CScheduledTask::SecurityInfo() const
sl@0: 	{
sl@0: 	return iSecurityInfo;
sl@0: 	}
sl@0: 		
sl@0: /**
sl@0: Is this task due?
sl@0: @internalComponent only used by server
sl@0: */
sl@0: TBool CScheduledTask::Due() const
sl@0: 	{
sl@0: 	return iDue;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Decrement repeat counter
sl@0: @internalComponent only used by server
sl@0: */
sl@0: void CScheduledTask::DecRepeat()
sl@0: 	{
sl@0: 	iInfo.iRepeat--;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Set due flag.
sl@0: @internalComponent only used by server
sl@0: */
sl@0: void CScheduledTask::SetDue(TBool aDue)
sl@0: 	{
sl@0: 	iDue = aDue;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Mark task as being due.
sl@0: @param aValidUntil time this task will be valid until. 
sl@0: This information will be passed to the registered executable, 
sl@0: so they may check whether the task should still be executed.
sl@0: @internalComponent only used by server
sl@0: */
sl@0: void CScheduledTask::OnDue(const TTsTime& aValidUntil)
sl@0: 	{
sl@0: 	iValidUntil = aValidUntil;
sl@0: 	iDue = ETrue;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Return flag that determines if task is transisent or persistent.
sl@0: @internalComponent only used by server
sl@0: */	
sl@0: TBool CScheduledTask::Persists() const
sl@0: 	{return iPersists;}
sl@0: 
sl@0: /**
sl@0: Mark task as belonging to a persistent schedule.
sl@0: @internalComponent only used by server
sl@0: */	
sl@0: void CScheduledTask::SetPersists()
sl@0: 	{iPersists = ETrue;}
sl@0: 	
sl@0: /**
sl@0: externalize data to stream.
sl@0: @internalComponent only used by server
sl@0: */
sl@0: void CScheduledTask::ExternalizeL(RWriteStream& aStream) const
sl@0: 	{
sl@0: 	aStream << *iData;
sl@0: 	aStream << iValidUntil; 
sl@0: 	aStream << iInfo;
sl@0: 	aStream.WriteInt32L(iScheduleId);
sl@0: 	aStream.WriteInt32L(iScheduleType);
sl@0: 	aStream << iSecurityInfo;
sl@0: 	aStream.WriteInt32L(iPersists);
sl@0: 	}
sl@0: 
sl@0: void CScheduledTask::InternalizeL(RReadStream& aStream)
sl@0: 	{
sl@0: 	iData = HBufC::NewL(aStream, KMaxTInt);
sl@0: 	aStream >> iValidUntil;
sl@0: 	aStream >> iInfo;
sl@0: 	iScheduleId = aStream.ReadInt32L();
sl@0: 	iScheduleType = static_cast<TScheduleType>(aStream.ReadInt32L());
sl@0: 	aStream >> iSecurityInfo;
sl@0: 	iPersists = aStream.ReadInt32L();;	
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Gets the schedulesID
sl@0: @internalComponent only used by server
sl@0: */
sl@0: TInt CScheduledTask::ScheduleId() const
sl@0: 	{
sl@0: 	return iScheduleId;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Sets the schedules ID
sl@0: @internalComponent only used by server
sl@0: */
sl@0: void CScheduledTask::SetScheduleId(TInt aScheduleId)
sl@0: 	{
sl@0: 	iScheduleId = aScheduleId;
sl@0: 	}
sl@0: 
sl@0: 	
sl@0: // Streaming operators for TSecurityInfo	
sl@0: RWriteStream& operator<<(RWriteStream& aWriteStream, 
sl@0: 						const TSecurityInfo& aSecurityInfo)
sl@0: 	{
sl@0: 	//write security policy
sl@0: 	aWriteStream.WriteUint32L(aSecurityInfo.iSecureId);
sl@0: 	aWriteStream.WriteUint32L(aSecurityInfo.iVendorId);
sl@0: 	// write capabilities by looping through all available
sl@0: 	for (TUint jj = 0; jj < ECapability_Limit; ++jj)
sl@0: 		if(aSecurityInfo.iCaps.HasCapability((TCapability)jj))
sl@0: 			aWriteStream.WriteUint8L(jj);
sl@0: 	aWriteStream.WriteUint8L(ECapability_HardLimit); // terminate capabilities with hard limit
sl@0: 	return aWriteStream;
sl@0: 	}
sl@0: 
sl@0: RReadStream& operator>>(RReadStream& aReadStream,
sl@0: 						TSecurityInfo& aSecurityInfo)
sl@0: 	{
sl@0: 	
sl@0: 	aSecurityInfo.iSecureId = aReadStream.ReadUint32L();
sl@0: 	aSecurityInfo.iVendorId = aReadStream.ReadUint32L();
sl@0: 	aSecurityInfo.iCaps.SetEmpty();
sl@0: 	TCapability cap = ECapability_None; 
sl@0: 	aSecurityInfo.iCaps.AddCapability(cap);		
sl@0: 	while (cap != ECapability_HardLimit )
sl@0: 		{
sl@0: 		aSecurityInfo.iCaps.AddCapability(cap);
sl@0: 		cap = (TCapability)aReadStream.ReadUint8L();
sl@0: 		}
sl@0: 	return aReadStream;		
sl@0: 	}	
sl@0: 
sl@0: 
sl@0: