1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
/******************************************************************************
*
* package:
* file: fileappender.cpp
* created: September 2007
* author: Martin Heinrich
*
*
* Copyright 2007 Martin Heinrich
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
******************************************************************************/
/******************************************************************************
* Dependencies
******************************************************************************/
#include "fileappender.h"
#include <QtCore/QDir>
#include <QtCore/QFile>
#include <QtCore/QFileInfo>
#include <QtCore/QDebug>
#include <QtCore/QTextStream>
#include <QtCore/QTextCodec>
#include "layout.h"
#include "loggingevent.h"
// if we are in WIN*
#if defined(__WIN32__) || defined(WIN) || defined(WIN32) || defined(Q_OS_WIN32)
#include <windows.h>
#endif
namespace Log4Qt
{
/**************************************************************************
* Declarations
**************************************************************************/
/**************************************************************************
* C helper functions
**************************************************************************/
/**************************************************************************
* Class implementation: FileAppender
**************************************************************************/
FileAppender::FileAppender(QObject *pParent) :
WriterAppender(pParent),
mAppendFile(false),
mBufferedIo(true),
mFileName(),
mpFile(0),
mpTextStream(0)
{
}
FileAppender::FileAppender(Layout *pLayout,
const QString &rFileName,
QObject *pParent) :
WriterAppender(pLayout, pParent),
mAppendFile(false),
mBufferedIo(true),
mFileName(rFileName),
mpFile(0),
mpTextStream(0)
{
}
FileAppender::FileAppender(Layout *pLayout,
const QString &rFileName,
bool append,
QObject *pParent) :
WriterAppender(pLayout, pParent),
mAppendFile(append),
mBufferedIo(true),
mFileName(rFileName),
mpFile(0),
mpTextStream(0)
{
}
FileAppender::FileAppender(Layout *pLayout,
const QString &rFileName,
bool append,
bool buffered,
QObject *pParent) :
WriterAppender(pLayout, pParent),
mAppendFile(append),
mBufferedIo(buffered),
mFileName(rFileName),
mpFile(0),
mpTextStream(0)
{
}
FileAppender::~FileAppender()
{
close();
}
void FileAppender::activateOptions()
{
QMutexLocker locker(&mObjectGuard);
if (mFileName.isEmpty())
{
LogError e = LOG4QT_QCLASS_ERROR(QT_TR_NOOP("Activation of Appender '%1' that requires file and has no file set"),
APPENDER_ACTIVATE_MISSING_FILE_ERROR);
e << name();
logger()->error(e);
return;
}
closeFile();
openFile();
WriterAppender::activateOptions();
}
void FileAppender::close()
{
QMutexLocker locker(&mObjectGuard);
if (isClosed())
return;
WriterAppender::close();
closeFile();
}
bool FileAppender::checkEntryConditions() const
{
// Q_ASSERT_X(, "FileAppender::checkEntryConditions()", "Lock must be held by caller")
if (!mpFile || !mpTextStream)
{
LogError e = LOG4QT_QCLASS_ERROR(QT_TR_NOOP("Use of appender '%1' without open file"),
APPENDER_NO_OPEN_FILE_ERROR);
e << name();
logger()->error(e);
return false;
}
return WriterAppender::checkEntryConditions();
}
void FileAppender::closeFile()
{
// Q_ASSERT_X(, "FileAppender::closeFile()", "Lock must be held by caller")
if (mpFile)
logger()->debug("Closing file '%1' for appender '%2'", mpFile->fileName(), name());
setWriter(0);
delete mpTextStream;
mpTextStream = 0;
delete mpFile;
mpFile = 0;
}
#ifndef QT_NO_DEBUG_STREAM
QDebug FileAppender::debug(QDebug &rDebug) const
{
QString layout_name;
if (layout())
layout_name = layout()->name();
QString codec_name;
if (encoding())
codec_name = QLatin1String(encoding()->name());
rDebug.nospace() << "FileAppender("
<< "name:" << name() << " "
<< "appendfile:" << appendFile() << " "
<< "bufferedio:" << bufferedIo() << " "
<< "encoding:" << codec_name << " "
<< "file:" << file() << " "
<< "filter:" << firstFilter() << " "
<< "immediateflush:" << immediateFlush() << " "
<< "isactive:" << isActive() << " "
<< "isclosed:" << isClosed() << " "
<< "layout:" << layout_name << " "
<< "referencecount:" << referenceCount() << " "
<< "threshold:" << threshold().toString() << " "
<< "writer:" << writer()
<< ")";
return rDebug.space();
}
#endif // QT_NO_DEBUG_STREAM
bool FileAppender::handleIoErrors() const
{
// Q_ASSERT_X(, "FileAppender::handleIoErrors()", "Lock must be held by caller")
if (mpFile->error() == QFile::NoError)
return false;
LogError e = LOG4QT_QCLASS_ERROR(QT_TR_NOOP("Unable to write to file '%1' for appender '%2'"),
APPENDER_WRITING_FILE_ERROR);
e << mFileName << name();
e.addCausingError(LogError(mpFile->errorString(), mpFile->error()));
logger()->error(e);
return true;
}
void FileAppender::openFile()
{
Q_ASSERT_X(mpFile == 0 && mpTextStream == 0, "FileAppender::openFile()", "Opening file without closing previous file");
QFileInfo file_info(mFileName);
QDir parent_dir = file_info.dir();
if (!parent_dir.exists())
{
logger()->trace("Creating missing parent directory for file %1", mFileName);
QString name = parent_dir.dirName();
parent_dir.cdUp();
parent_dir.mkdir(name);
}
#if defined(__WIN32__) || defined(WIN) || defined(WIN32) || defined(Q_OS_WIN32)
// Let windows resolve any environment variables included in the file path
wchar_t buffer[MAX_PATH];
if (ExpandEnvironmentStringsW((wchar_t*)mFileName.utf16(), buffer, MAX_PATH)) {
mFileName = QString::fromWCharArray(buffer);
}
#endif
mpFile = new QFile(mFileName);
QFile::OpenMode mode = QIODevice::WriteOnly | QIODevice::Text;
if (mAppendFile)
mode |= QIODevice::Append;
else
mode |= QIODevice::Truncate;
if (!mBufferedIo)
mode |= QIODevice::Unbuffered;
if (!mpFile->open(mode))
{
LogError e = LOG4QT_QCLASS_ERROR(QT_TR_NOOP("Unable to open file '%1' for appender '%2'"),
APPENDER_OPENING_FILE_ERROR);
e << mFileName << name();
e.addCausingError(LogError(mpFile->errorString(), mpFile->error()));
logger()->error(e);
return;
}
mpTextStream = new QTextStream(mpFile);
setWriter(mpTextStream);
logger()->debug("Opened file '%1' for appender '%2'", mpFile->fileName(), name());
}
bool FileAppender::removeFile(QFile &rFile) const
{
if (rFile.remove())
return true;
LogError e = LOG4QT_QCLASS_ERROR(QT_TR_NOOP("Unable to remove file '%1' for appender '%2'"),
APPENDER_REMOVE_FILE_ERROR);
e << rFile.fileName() << name();
e.addCausingError(LogError(rFile.errorString(), rFile.error()));
logger()->error(e);
return false;
}
bool FileAppender::renameFile(QFile &rFile,
const QString &rFileName) const
{
logger()->debug("Renaming file '%1' to '%2'", rFile.fileName(), rFileName);
if (rFile.rename(rFileName))
return true;
LogError e = LOG4QT_QCLASS_ERROR(QT_TR_NOOP("Unable to rename file '%1' to '%2' for appender '%3'"),
APPENDER_RENAMING_FILE_ERROR);
e << rFile.fileName() << rFileName << name();
e.addCausingError(LogError(rFile.errorString(), rFile.error()));
logger()->error(e);
return false;
}
/**************************************************************************
* Implementation: Operators, Helper
**************************************************************************/
} // namespace Log4Qt
|
