localisation/apparchitecture/apserv/APSRECUTIL.CPP
branchSymbian2
changeset 1 8758140453c0
child 6 c108117318cb
equal deleted inserted replaced
0:e8c1ea2c6496 1:8758140453c0
       
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of the License "Symbian Foundation License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.symbianfoundation.org/legal/sfl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // Classes for synchronous and asynchronous file recognitions (of a directory)
       
    15 // 
       
    16 //
       
    17 
       
    18 
       
    19 #include "APSRECUTIL.H"
       
    20 #include "APSRECCACHE.h"
       
    21 
       
    22 //////////////////////////////
       
    23 // CRecognitionResult
       
    24 //////////////////////////////
       
    25 
       
    26 CRecognitionResult* CRecognitionResult::NewL(const TDesC& aFileName, const TDataRecognitionResult& aRecognitionResult)
       
    27 	{
       
    28 	ASSERT(aFileName.Find(_L("\\")) == KErrNotFound); // the filename should not contain any path
       
    29 
       
    30 	HBufC* fileName = aFileName.AllocLC();
       
    31 	HBufC8* dataType = aRecognitionResult.iDataType.Des8().AllocLC();	
       
    32 	CRecognitionResult* self = new(ELeave) CRecognitionResult(fileName, dataType, aRecognitionResult.iDataType.Uid(), aRecognitionResult.iConfidence);
       
    33 	CleanupStack::Pop(2, fileName);
       
    34 	return self;
       
    35 	}
       
    36 
       
    37 CRecognitionResult::CRecognitionResult(HBufC* aFileName, HBufC8* aDataType, TUid aUid, TInt aConfidence)
       
    38 	: iFileName(aFileName),
       
    39 	  iDataType(aDataType),
       
    40  	  iUid(aUid), 
       
    41 	  iConfidence(aConfidence)
       
    42 	{
       
    43 	}
       
    44 
       
    45 CRecognitionResult::~CRecognitionResult()
       
    46 	{
       
    47 	delete iFileName;
       
    48 	delete iDataType;
       
    49 	}
       
    50 
       
    51 void CRecognitionResult::Get(TDataRecognitionResult& aRecognitionResult)
       
    52 	{
       
    53 	if(iUid == KNullUid)
       
    54 
       
    55 		{
       
    56 		aRecognitionResult.iDataType = TDataType(*iDataType);
       
    57 		}
       
    58 	else
       
    59 		{
       
    60 		aRecognitionResult.iDataType = TDataType(iUid);
       
    61 		}
       
    62 	aRecognitionResult.iConfidence = iConfidence;
       
    63 	}
       
    64 	
       
    65 
       
    66 
       
    67 TUint CRecognitionResult::GetRequiredBufferSize() const
       
    68 	{
       
    69 	return iFileName->Size() + iDataType->Size() + sizeof(TUid) + sizeof(TInt) + 2;
       
    70 	}
       
    71 
       
    72 void CRecognitionResult::WriteToStreamL(RWriteStream& aWriteStream)
       
    73 	{
       
    74 	aWriteStream.WriteUint8L(iFileName->Length());
       
    75 	aWriteStream.WriteL(*iFileName);
       
    76 	aWriteStream.WriteUint8L(iDataType->Length());
       
    77 	aWriteStream.WriteL(*iDataType);
       
    78 	aWriteStream.WriteInt32L(iUid.iUid);
       
    79 	aWriteStream.WriteInt32L(iConfidence);
       
    80 	}
       
    81 	
       
    82 ///////////////////////////////////
       
    83 // CDirectoryRecognitionResult
       
    84 ///////////////////////////////////
       
    85 
       
    86 CDirectoryRecognitionResult::CDirectoryRecognitionResult(HBufC* aPath, HBufC8* aDataTypeFilter)
       
    87 	: iPath(aPath), iDataTypeFilter(aDataTypeFilter)
       
    88 	{
       
    89 	iRequiredBufferSize = sizeof(TUint);
       
    90 	}
       
    91 
       
    92 CDirectoryRecognitionResult::~CDirectoryRecognitionResult()
       
    93 	{
       
    94 	delete iPath;
       
    95 	delete iDataTypeFilter;
       
    96 	
       
    97 	const TInt count = iEntries.Count();
       
    98 	for(TInt i = 0; i < count; i++)
       
    99 		{
       
   100 		iEntries[i]->Close();
       
   101 		}
       
   102 	iEntries.Reset();
       
   103 	}
       
   104 
       
   105 void CDirectoryRecognitionResult::AppendL(CRecognitionResult* aEntry)
       
   106 	{
       
   107 	if(iDataTypeFilter)
       
   108 		{
       
   109 		if(aEntry->DataType().Match(*iDataTypeFilter) == KErrNotFound)
       
   110 			{
       
   111 			aEntry->Close(); //if we don't take ownership we must decrease reference count
       
   112 			return;
       
   113 			}
       
   114 		}
       
   115 
       
   116 	iEntries.AppendL(aEntry);
       
   117 	iRequiredBufferSize += aEntry->GetRequiredBufferSize();
       
   118 	} //lint !e818: Pointer parameter could be declared as pointing to const
       
   119 
       
   120 void CDirectoryRecognitionResult::WriteToStreamL(RWriteStream& aWriteStream)
       
   121 	{
       
   122 	aWriteStream.WriteUint32L(iEntries.Count());
       
   123 	for (TInt i=0; i < iEntries.Count(); i++)
       
   124 		{
       
   125 		iEntries[i]->WriteToStreamL(aWriteStream);
       
   126 		}
       
   127 	aWriteStream.CommitL();
       
   128 	}
       
   129 
       
   130 //////////////////////////////////////////////////////////
       
   131 // CFileRecognitionUtility
       
   132 //////////////////////////////////////////////////////////
       
   133 
       
   134 CFileRecognitionUtility::CFileRecognitionUtility(CApaAppListServer& aServer, TInt aMaxBufSize, RFs& aFs)
       
   135 	: CActive(0), 
       
   136 	  iServer(aServer), 
       
   137 	  iMaxBufSize(aMaxBufSize), 
       
   138 	  iFs(aFs),
       
   139 	  iIndex(0),
       
   140 	  iStep(0)
       
   141 	{
       
   142 	CActiveScheduler::Add(this);
       
   143 	}
       
   144 
       
   145 CFileRecognitionUtility::~CFileRecognitionUtility()
       
   146 	{
       
   147 	Cancel();
       
   148 	delete iEntryList;
       
   149 	
       
   150 	iPath = NULL;
       
   151 	iResult = NULL;
       
   152 	}
       
   153 
       
   154 void CFileRecognitionUtility::RecognizeSynchronouslyL(CDirectoryRecognitionResult& aResult)
       
   155 	{
       
   156 	iPath = &(aResult.Path());
       
   157 	iResult = &aResult;
       
   158 
       
   159 	User::LeaveIfError(iFs.IsValidName(iPath->Des()));
       
   160 
       
   161 	ReadDirectoryL();
       
   162 
       
   163 	// recognize files and calculate size of buffer
       
   164 	for(iIndex=0;iIndex<iEntryList->Count();iIndex++)
       
   165 		{
       
   166 		RecognizeFileL();
       
   167 		}
       
   168 		
       
   169 	delete iEntryList;
       
   170 	iEntryList = NULL;
       
   171 	}
       
   172 
       
   173 void CFileRecognitionUtility::RecognizeAsynchronously(CDirectoryRecognitionResult& aResult, const RMessage2& aMessage)
       
   174 	{
       
   175 	iIndex = 0;
       
   176 	iStep = 0;
       
   177 	iPath = &(aResult.Path());
       
   178 	iResult = &aResult;
       
   179 	iMessage = aMessage;
       
   180 
       
   181 	NextStep();
       
   182 	}
       
   183 
       
   184 void CFileRecognitionUtility::ReadDirectoryL()
       
   185 	{
       
   186 	delete iEntryList;
       
   187 	iEntryList = NULL;
       
   188 
       
   189 	// read directory content
       
   190 	User::LeaveIfError(iFs.GetDir(iPath->Des(),KEntryAttNormal,EDirsAnyOrder,iEntryList));
       
   191 	}
       
   192 	
       
   193 TInt CFileRecognitionUtility::BufferSizeL() const
       
   194 	{
       
   195 	const TInt preferredBufferSize = iServer.DataRecognizerPreferredBufSizeL();
       
   196 	TInt bufSize=Min(preferredBufferSize,iMaxBufSize);
       
   197 	if (bufSize<1)
       
   198 		{
       
   199 		bufSize=8; // sensible minimum.
       
   200 		}
       
   201 	return bufSize;
       
   202 	}
       
   203 
       
   204 void CFileRecognitionUtility::RecognizeFileL()
       
   205 	{
       
   206 	TFileName fullFileName(*iPath);
       
   207 	fullFileName.Append((*iEntryList)[iIndex].iName);
       
   208 	RFile file;
       
   209 	User::LeaveIfError(file.Open(iFs, fullFileName, EFileRead | EFileShareReadersOnly));
       
   210 	CleanupClosePushL(file);
       
   211 	
       
   212 	CRecognitionResult* result = NULL;
       
   213 	TRAP_IGNORE(result = iServer.RecognizeDataAsCRecognitionResultL(file, BufferSizeL()));
       
   214 	if(result)
       
   215 		{
       
   216 		CleanupClosePushL(*result);
       
   217 		iResult->AppendL(result);
       
   218 		CleanupStack::Pop(result);
       
   219 		}
       
   220 	
       
   221 	CleanupStack::PopAndDestroy(&file);
       
   222 	}
       
   223 
       
   224 void CFileRecognitionUtility::CancelRecognitionRequest()
       
   225 	{
       
   226 	if(iStep <= 1)
       
   227 		{
       
   228 		Cancel();
       
   229 		iMessage.Complete(KErrCancel);	
       
   230 		}
       
   231 	}
       
   232 
       
   233 void CFileRecognitionUtility::NextStep()
       
   234 	{
       
   235 	TRequestStatus* pStatus = &iStatus;
       
   236 	User::RequestComplete(pStatus, KErrNone);
       
   237 	SetActive();
       
   238 	}
       
   239 
       
   240 void CFileRecognitionUtility::RunL()
       
   241 	{
       
   242 	switch(iStep)
       
   243 		{
       
   244 		case 0:		// first step: read the directory content
       
   245 			ReadDirectoryL();
       
   246 			iIndex=0;
       
   247 			iStep++;
       
   248 			NextStep();
       
   249 			break;
       
   250 		case 1:		// read current file and recognize it
       
   251 			if(iIndex < iEntryList->Count())
       
   252 				{
       
   253 				RecognizeFileL();
       
   254 				iIndex++;
       
   255 				NextStep();
       
   256 				}
       
   257 			else	// finished
       
   258 				{
       
   259 				iMessage.WriteL(1,TPckgBuf<TUint>(iResult->RequiredBufferSize()));
       
   260 				iMessage.Complete(KErrNone);
       
   261 				iStep++;	// to show that we have completed the request
       
   262 				delete iEntryList;
       
   263 				iEntryList = NULL;
       
   264 				}
       
   265 			break;
       
   266 		default:
       
   267 			break;
       
   268 		}
       
   269 	}
       
   270 
       
   271 void CFileRecognitionUtility::DoCancel()
       
   272 	{
       
   273 	iIndex = 0;
       
   274 	iStep = 0;
       
   275 	}