|
1 // Copyright (c) 2006-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 "Eclipse Public License v1.0" |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // |
|
15 |
|
16 #include "cimaplogger.h" |
|
17 #include "cimaputils.h" |
|
18 #include <utf.h> |
|
19 #include <bautils.h> |
|
20 |
|
21 #ifdef __IMAP_LOGGING |
|
22 |
|
23 _LIT(KLogDir, "c:\\logs\\email"); |
|
24 _LIT(KBackupLogDir, "c:\\logs\\email\\backup"); |
|
25 |
|
26 _LIT(KDefaultLogFileFormat, "%S\\%S.txt"); |
|
27 _LIT(KStandardLogFileFormat, "%S\\%S_%d.txt"); |
|
28 _LIT(KBackupLogFileFormat, "%S\\%S_%d_%d.txt"); |
|
29 |
|
30 _LIT8(KTxtCRLF, "\r\n"); |
|
31 _LIT8(KTxtOverflowCRLF, "... Overflow... \r\n"); |
|
32 _LIT8(KTxtFormatText, "%S"); |
|
33 _LIT8(KTxtFormatDataIn, "<<(%3d)<< %S"); |
|
34 _LIT8(KTxtFormatDataOut, ">>(%3d)>> %S"); |
|
35 _LIT(KTxtLogDateFormat, "%D%M%*Y%1%/1%2%/2%3 %H%:1%T%:2%S "); |
|
36 |
|
37 _LIT8(KTxtFormatStandardLogStarted, "Started Log: %S"); |
|
38 |
|
39 const TInt KDateFormatLength = 18; |
|
40 const TInt KLogBufferSize = 2560; |
|
41 const TInt KMaxBackupOffset = 6; |
|
42 |
|
43 #endif //__IMAP_LOGGING |
|
44 |
|
45 CImapLogger* CImapLogger::NewL() |
|
46 { |
|
47 CImapLogger* self = new (ELeave) CImapLogger(); |
|
48 CleanupStack::PushL(self); |
|
49 self->ConstructL(); |
|
50 CleanupStack::Pop(); |
|
51 return self; |
|
52 } |
|
53 |
|
54 CImapLogger::CImapLogger() |
|
55 { |
|
56 } |
|
57 |
|
58 void CImapLogger::ConstructL() |
|
59 { |
|
60 #ifdef __IMAP_LOGGING |
|
61 iLogBuffer = HBufC8::NewL(KLogBufferSize); |
|
62 |
|
63 // Add an entry for the default log file |
|
64 TLogFileInfo info; |
|
65 info.iLoggingOn = ETrue; |
|
66 iFileList.AppendL(info); |
|
67 #endif |
|
68 } |
|
69 |
|
70 CImapLogger::~CImapLogger() |
|
71 { |
|
72 #ifdef __IMAP_LOGGING |
|
73 delete iLogBuffer; |
|
74 |
|
75 for (TInt pos = 0; pos < iFileList.Count(); ++pos) |
|
76 { |
|
77 iFileList[pos].iFile.Close(); |
|
78 } |
|
79 |
|
80 iFileList.Reset(); |
|
81 #endif |
|
82 } |
|
83 |
|
84 #ifdef __IMAP_LOGGING |
|
85 EXPORT_C void CImapLogger::CreateDefaultLog(const TDesC& aFilePartName) |
|
86 #else //__IMAP_LOGGING |
|
87 EXPORT_C void CImapLogger::CreateDefaultLog(const TDesC& /*aFilePartName*/) |
|
88 #endif //__IMAP_LOGGING |
|
89 { |
|
90 #ifdef __IMAP_LOGGING |
|
91 TRAP_IGNORE(DoCreateDefaultLogL(aFilePartName)); |
|
92 #endif |
|
93 } |
|
94 |
|
95 #ifdef __IMAP_LOGGING |
|
96 void CImapLogger::DoCreateDefaultLogL(const TDesC& aFilePartName) |
|
97 #else //__IMAP_LOGGING |
|
98 void CImapLogger::DoCreateDefaultLogL(const TDesC& /*aFilePartName*/) |
|
99 #endif //__IMAP_LOGGING |
|
100 { |
|
101 #ifdef __IMAP_LOGGING |
|
102 if (iDefaultLogFileInUse) |
|
103 { |
|
104 return; |
|
105 } |
|
106 |
|
107 TFileName filename; |
|
108 filename.Format(KDefaultLogFileFormat, &KLogDir(), &aFilePartName); |
|
109 |
|
110 CImapUtils& utils = CImapUtils::GetRef(); |
|
111 |
|
112 TInt err = iFileList[KDefaultLog].iFile.Replace(utils.Fs(), filename, EFileWrite | EFileShareAny); |
|
113 |
|
114 if (err == KErrNone) |
|
115 { |
|
116 iDefaultLogFileInUse = ETrue; |
|
117 } |
|
118 #endif //__IMAP_LOGGING |
|
119 } |
|
120 |
|
121 #ifdef __IMAP_LOGGING |
|
122 EXPORT_C void CImapLogger::CreateStandardLog(const TDesC& aFilePartName, TInt& aLogId) |
|
123 #else //__IMAP_LOGGING |
|
124 EXPORT_C void CImapLogger::CreateStandardLog(const TDesC& /*aFilePartName*/, TInt& /*aLogId*/) |
|
125 #endif //__IMAP_LOGGING |
|
126 { |
|
127 #ifdef __IMAP_LOGGING |
|
128 TRAP_IGNORE(DoCreateStandardLogL(aFilePartName, aLogId)); |
|
129 #endif //__IMAP_LOGGING |
|
130 } |
|
131 |
|
132 #ifdef __IMAP_LOGGING |
|
133 void CImapLogger::DoCreateStandardLogL(const TDesC& aFilePartName, TInt& aLogId) |
|
134 #else //__IMAP_LOGGING |
|
135 void CImapLogger::DoCreateStandardLogL(const TDesC& /*aFilePartName*/, TInt& /*aLogId*/) |
|
136 #endif //__IMAP_LOGGING |
|
137 { |
|
138 #ifdef __IMAP_LOGGING |
|
139 aLogId = KDefaultLog; |
|
140 |
|
141 TBool fileOpen(ETrue); |
|
142 TFileName filename; |
|
143 TInt err; |
|
144 TInt fileOffset(0); |
|
145 |
|
146 do |
|
147 { |
|
148 ++fileOffset; |
|
149 filename.Format(KStandardLogFileFormat, &KLogDir(), &aFilePartName, fileOffset); |
|
150 |
|
151 err = CImapUtils::GetRef().Fs().IsFileOpen(filename, fileOpen); |
|
152 if (err == KErrNotFound) |
|
153 { |
|
154 err = KErrNone; |
|
155 fileOpen = EFalse; |
|
156 } |
|
157 |
|
158 User::LeaveIfError(err); |
|
159 } |
|
160 while (fileOpen); |
|
161 |
|
162 // See if we should take a backup of the log file |
|
163 if (BaflUtils::FolderExists(CImapUtils::GetRef().Fs(), KBackupLogDir)) |
|
164 { |
|
165 TInt backupOffset(KMaxBackupOffset); |
|
166 TFileName source; |
|
167 TFileName dest; |
|
168 |
|
169 dest.Format(KBackupLogFileFormat, &KBackupLogDir(), &aFilePartName, fileOffset, backupOffset); |
|
170 |
|
171 while (backupOffset > 1) |
|
172 { |
|
173 --backupOffset; |
|
174 source.Format(KBackupLogFileFormat, &KBackupLogDir(), &aFilePartName, fileOffset, backupOffset); |
|
175 BaflUtils::CopyFile(CImapUtils::GetRef().Fs(), source, dest); |
|
176 dest = source; |
|
177 } |
|
178 |
|
179 BaflUtils::CopyFile(CImapUtils::GetRef().Fs(), filename, dest); |
|
180 } |
|
181 |
|
182 TLogFileInfo info; |
|
183 info.iLoggingOn = ETrue; |
|
184 err = info.iFile.Replace(CImapUtils::GetRef().Fs(), filename, EFileWrite | EFileShareAny); |
|
185 |
|
186 if (err != KErrNone) |
|
187 { |
|
188 return; |
|
189 } |
|
190 |
|
191 CleanupClosePushL(info.iFile); |
|
192 iFileList.AppendL(info); |
|
193 CleanupStack::Pop(&info.iFile); |
|
194 |
|
195 HBufC8* buf; |
|
196 TRAP(err, buf = CnvUtfConverter::ConvertFromUnicodeToUtf8L(filename)); |
|
197 if (err == KErrNone) |
|
198 { |
|
199 const TDesC8& bufRef = *buf; |
|
200 LogFormat(KDefaultLog, KTxtFormatStandardLogStarted, &bufRef); |
|
201 delete buf; |
|
202 } |
|
203 |
|
204 aLogId = iFileList.Count() - 1; |
|
205 #endif //__IMAP_LOGGING |
|
206 } |
|
207 |
|
208 #ifdef __IMAP_LOGGING |
|
209 EXPORT_C void CImapLogger::CloseLog(TInt aFilePos) |
|
210 #else //__IMAP_LOGGING |
|
211 EXPORT_C void CImapLogger::CloseLog(TInt /*aFilePos*/) |
|
212 #endif //__IMAP_LOGGING |
|
213 { |
|
214 #ifdef __IMAP_LOGGING |
|
215 if (aFilePos < iFileList.Count()) |
|
216 { |
|
217 iFileList[aFilePos].iFile.Close(); |
|
218 |
|
219 if (aFilePos == KDefaultLog) |
|
220 { |
|
221 iDefaultLogFileInUse = EFalse; |
|
222 } |
|
223 } |
|
224 #endif //__IMAP_LOGGING |
|
225 } |
|
226 |
|
227 #ifdef __IMAP_LOGGING |
|
228 EXPORT_C void CImapLogger::LogText(TInt aFilePos, char const* aText) |
|
229 #else //__IMAP_LOGGING |
|
230 EXPORT_C void CImapLogger::LogText(TInt /*aFilePos*/, char const* /*aText*/) |
|
231 #endif //__IMAP_LOGGING |
|
232 { |
|
233 #ifdef __IMAP_LOGGING |
|
234 |
|
235 TPtrC8 buf(reinterpret_cast<TUint8*>(const_cast<char*>(aText))); |
|
236 LogFormat(aFilePos, KTxtFormatText, &buf); |
|
237 |
|
238 #endif //__IMAP_LOGGING |
|
239 } |
|
240 |
|
241 #ifdef __IMAP_LOGGING |
|
242 EXPORT_C void CImapLogger::LogText(TInt aFilePos, const TDesC8& aText) |
|
243 #else //__IMAP_LOGGING |
|
244 EXPORT_C void CImapLogger::LogText(TInt /*aFilePos*/, const TDesC8& /*aText*/) |
|
245 #endif //__IMAP_LOGGING |
|
246 { |
|
247 #ifdef __IMAP_LOGGING |
|
248 LogFormat(aFilePos, KTxtFormatText, &aText); |
|
249 #endif //__IMAP_LOGGING |
|
250 } |
|
251 |
|
252 #ifdef __IMAP_LOGGING |
|
253 EXPORT_C void CImapLogger::LogDataIn(TInt aFilePos, const TDesC8& aText) |
|
254 #else //__IMAP_LOGGING |
|
255 EXPORT_C void CImapLogger::LogDataIn(TInt /*aFilePos*/, const TDesC8& /*aText*/) |
|
256 #endif //__IMAP_LOGGING |
|
257 { |
|
258 #ifdef __IMAP_LOGGING |
|
259 LogData(aFilePos, aText, KTxtFormatDataIn); |
|
260 #endif //__IMAP_LOGGING |
|
261 } |
|
262 |
|
263 #ifdef __IMAP_LOGGING |
|
264 EXPORT_C void CImapLogger::LogDataOut(TInt aFilePos, const TDesC8& aText) |
|
265 #else //__IMAP_LOGGING |
|
266 EXPORT_C void CImapLogger::LogDataOut(TInt /*aFilePos*/, const TDesC8& /*aText*/) |
|
267 #endif //__IMAP_LOGGING |
|
268 { |
|
269 #ifdef __IMAP_LOGGING |
|
270 LogData(aFilePos, aText, KTxtFormatDataOut); |
|
271 #endif //__IMAP_LOGGING |
|
272 } |
|
273 |
|
274 #ifdef __IMAP_LOGGING |
|
275 void CImapLogger::LogData(TInt aFilePos, const TDesC8& aText, const TDesC8& aFmt) |
|
276 #else //__IMAP_LOGGING |
|
277 void CImapLogger::LogData(TInt /*aFilePos*/, const TDesC8& /*aText*/, const TDesC8& /*aFmt*/) |
|
278 #endif //__IMAP_LOGGING |
|
279 { |
|
280 #ifdef __IMAP_LOGGING |
|
281 |
|
282 TPtrC8 text(aText); |
|
283 TPtrC8 line; |
|
284 TInt crlfPos(0); |
|
285 |
|
286 for(;;) |
|
287 { |
|
288 crlfPos = text.Find(KTxtCRLF); |
|
289 |
|
290 if (crlfPos == KErrNotFound) |
|
291 { |
|
292 if (text.Length() > 0) |
|
293 { |
|
294 LogFormat(aFilePos, aFmt, text.Length(), &text); |
|
295 } |
|
296 |
|
297 break; |
|
298 } |
|
299 |
|
300 line.Set(text.Left(crlfPos)); |
|
301 LogFormat(aFilePos, aFmt, crlfPos + 2, &line); |
|
302 |
|
303 if (text.Length() > crlfPos + 2) |
|
304 { |
|
305 text.Set(text.Mid(crlfPos + 2)); |
|
306 } |
|
307 else |
|
308 { |
|
309 break; |
|
310 } |
|
311 } |
|
312 #endif //__IMAP_LOGGING |
|
313 } |
|
314 |
|
315 #ifdef __IMAP_LOGGING |
|
316 EXPORT_C void CImapLogger::LogFormat(TInt aFilePos, char const* aFmt, ...) |
|
317 #else //__IMAP_LOGGING |
|
318 EXPORT_C void CImapLogger::LogFormat(TInt /*aFilePos*/, char const* /*aFmt*/, ...) |
|
319 #endif //__IMAP_LOGGING |
|
320 { |
|
321 #ifdef __IMAP_LOGGING |
|
322 VA_LIST list; |
|
323 VA_START(list, aFmt); |
|
324 |
|
325 TPtrC8 fmt(reinterpret_cast<TUint8*>(const_cast<char*>(aFmt))); |
|
326 |
|
327 LogFormat(aFilePos, list, fmt); |
|
328 #endif //__IMAP_LOGGING |
|
329 } |
|
330 |
|
331 #ifdef __IMAP_LOGGING |
|
332 EXPORT_C void CImapLogger::LogFormat(TInt aFilePos, TRefByValue<const TDesC8> aFmt, ...) |
|
333 #else //__IMAP_LOGGING |
|
334 EXPORT_C void CImapLogger::LogFormat(TInt /*aFilePos*/, TRefByValue<const TDesC8> /*aFmt*/, ...) |
|
335 #endif //__IMAP_LOGGING |
|
336 { |
|
337 #ifdef __IMAP_LOGGING |
|
338 VA_LIST list; |
|
339 VA_START(list, aFmt); |
|
340 |
|
341 LogFormat(aFilePos, list, aFmt); |
|
342 #endif //__IMAP_LOGGING |
|
343 } |
|
344 |
|
345 #ifdef __IMAP_LOGGING |
|
346 EXPORT_C void CImapLogger::LogOn(TInt aFilePos, TBool aLoggingOn) |
|
347 #else //__IMAP_LOGGING |
|
348 EXPORT_C void CImapLogger::LogOn(TInt /*aFilePos*/, TBool /*aLoggingOn*/) |
|
349 #endif //__IMAP_LOGGING |
|
350 { |
|
351 #ifdef __IMAP_LOGGING |
|
352 if (iFileList.Count() > aFilePos) |
|
353 { |
|
354 if (!aLoggingOn) |
|
355 { |
|
356 LogText(aFilePos, "Logging Off"); |
|
357 } |
|
358 iFileList[aFilePos].iLoggingOn = aLoggingOn; |
|
359 if (aLoggingOn) |
|
360 { |
|
361 LogText(aFilePos, "Logging On"); |
|
362 } |
|
363 } |
|
364 #endif //__IMAP_LOGGING |
|
365 } |
|
366 |
|
367 #ifdef __IMAP_LOGGING |
|
368 void CImapLogger::LogFormat(TInt aFilePos, VA_LIST& aList, TRefByValue<const TDesC8> aFmt) |
|
369 #else //__IMAP_LOGGING |
|
370 void CImapLogger::LogFormat(TInt /*aFilePos*/, VA_LIST& /*aList*/, TRefByValue<const TDesC8> /*aFmt*/) |
|
371 #endif //__IMAP_LOGGING |
|
372 { |
|
373 #ifdef __IMAP_LOGGING |
|
374 |
|
375 if (iFileList.Count() == 0) |
|
376 { |
|
377 return; |
|
378 } |
|
379 |
|
380 if (aFilePos >= iFileList.Count()) |
|
381 { |
|
382 aFilePos = KDefaultLog; |
|
383 } |
|
384 |
|
385 if ((aFilePos == KDefaultLog) && (iDefaultLogFileInUse == EFalse)) |
|
386 { |
|
387 return; |
|
388 } |
|
389 |
|
390 if (!iFileList[aFilePos].iLoggingOn) |
|
391 { |
|
392 return; |
|
393 } |
|
394 |
|
395 iFile = &iFileList[aFilePos].iFile; |
|
396 |
|
397 TPtr8 buf = iLogBuffer->Des(); |
|
398 buf.Zero(); |
|
399 |
|
400 TTime date; |
|
401 date.UniversalTime(); |
|
402 TBuf<KDateFormatLength> dateString; |
|
403 TRAP_IGNORE(date.FormatL(dateString, KTxtLogDateFormat)); |
|
404 buf.Copy(dateString); |
|
405 |
|
406 buf.AppendFormatList(aFmt, aList, this); |
|
407 iFile->Write(buf); |
|
408 iFile->Write(KTxtCRLF()); |
|
409 |
|
410 #endif //__IMAP_LOGGING |
|
411 } |
|
412 |
|
413 #ifdef __IMAP_LOGGING |
|
414 void CImapLogger::Overflow(TDes8& aDes) |
|
415 #else //__IMAP_LOGGING |
|
416 void CImapLogger::Overflow(TDes8& /*aDes*/) |
|
417 #endif //__IMAP_LOGGING |
|
418 { |
|
419 #ifdef __IMAP_LOGGING |
|
420 iFile->Write(aDes); |
|
421 iFile->Write(KTxtOverflowCRLF()); |
|
422 #endif //__IMAP_LOGGING |
|
423 } |