149 lines
4.4 KiB
C++
149 lines
4.4 KiB
C++
/******************************************************************************
|
|
*
|
|
* This file is part of Log4Qt library.
|
|
*
|
|
* Copyright (C) 2007 - 2020 Log4Qt contributors
|
|
*
|
|
* 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.
|
|
*
|
|
******************************************************************************/
|
|
|
|
#ifndef LOG4QT_DAILYROLLINGFILEAPPENDER_H
|
|
#define LOG4QT_DAILYROLLINGFILEAPPENDER_H
|
|
|
|
#include "fileappender.h"
|
|
|
|
#include <QDateTime>
|
|
|
|
namespace Log4Qt
|
|
{
|
|
|
|
/*!
|
|
* \brief The class DailyRollingFileAppender extends FileAppender so that the
|
|
* underlying file is rolled over at a specified frequency.
|
|
*
|
|
* \note All the functions declared in this class are thread-safe.
|
|
*
|
|
* \note The ownership and lifetime of objects of this class are managed. See
|
|
* \ref Ownership "Object ownership" for more details.
|
|
*/
|
|
class LOG4QT_EXPORT DailyRollingFileAppender : public FileAppender
|
|
{
|
|
Q_OBJECT
|
|
|
|
/*!
|
|
* The property holds the date pattern used by the appender.
|
|
*
|
|
* The default is DAILY_ROLLOVER for rollover at midnight each day.
|
|
*
|
|
* \sa datePattern(), setDatePattern()
|
|
*/
|
|
Q_PROPERTY(QString datePattern READ datePattern WRITE setDatePattern)
|
|
|
|
public:
|
|
/*!
|
|
* The enum DatePattern defines constants for date patterns.
|
|
*
|
|
* \sa setDatePattern(DatePattern)
|
|
*/
|
|
enum DatePattern
|
|
{
|
|
/*! The minutely date pattern string is "'.'yyyy-MM-dd-hh-mm". */
|
|
MINUTELY_ROLLOVER = 0,
|
|
/*! The hourly date pattern string is "'.'yyyy-MM-dd-hh". */
|
|
HOURLY_ROLLOVER,
|
|
/*! The half-daily date pattern string is "'.'yyyy-MM-dd-a". */
|
|
HALFDAILY_ROLLOVER,
|
|
/*! The daily date pattern string is "'.'yyyy-MM-dd". */
|
|
DAILY_ROLLOVER,
|
|
/*! The weekly date pattern string is "'.'yyyy-ww". */
|
|
WEEKLY_ROLLOVER,
|
|
/*! The monthly date pattern string is "'.'yyyy-MM". */
|
|
MONTHLY_ROLLOVER
|
|
};
|
|
Q_ENUM(DatePattern)
|
|
|
|
DailyRollingFileAppender(QObject *parent = nullptr);
|
|
DailyRollingFileAppender(const LayoutSharedPtr &layout,
|
|
const QString &fileName,
|
|
const QString &datePattern,
|
|
QObject *parent = nullptr);
|
|
|
|
private:
|
|
Q_DISABLE_COPY(DailyRollingFileAppender)
|
|
public:
|
|
QString datePattern() const;
|
|
|
|
/*!
|
|
* Sets the datePattern to the value specified by the \a datePattern
|
|
* constant.
|
|
*/
|
|
void setDatePattern(DatePattern datePattern);
|
|
|
|
void setDatePattern(const QString &datePattern);
|
|
|
|
void activateOptions() override;
|
|
|
|
protected:
|
|
void append(const LoggingEvent &event) override;
|
|
|
|
/*!
|
|
* Tests if all entry conditions for using append() in this class are
|
|
* met.
|
|
*
|
|
* If a conditions is not met, an error is logged and the function
|
|
* returns false. Otherwise the result of
|
|
* FileAppender::checkEntryConditions() is returned.
|
|
*
|
|
* The checked conditions are:
|
|
* - A valid pattern has been set (APPENDER_USE_INVALID_PATTERN_ERROR)
|
|
*
|
|
* The function is called as part of the checkEntryConditions() chain
|
|
* started by AppenderSkeleton::doAppend().
|
|
*
|
|
* \sa AppenderSkeleton::doAppend(),
|
|
* AppenderSkeleton::checkEntryConditions()
|
|
*/
|
|
bool checkEntryConditions() const override;
|
|
|
|
private:
|
|
void computeFrequency();
|
|
void computeRollOvetime();
|
|
QString frequencyToString() const;
|
|
void rollOver();
|
|
|
|
private:
|
|
QString mDatePattern;
|
|
DatePattern mFrequency;
|
|
QString mActiveDatePattern;
|
|
QDateTime mRollOvetime;
|
|
QString mRollOverSuffix;
|
|
};
|
|
|
|
inline QString DailyRollingFileAppender::datePattern() const
|
|
{
|
|
QMutexLocker locker(&mObjectGuard);
|
|
return mDatePattern;
|
|
}
|
|
|
|
inline void DailyRollingFileAppender::setDatePattern(const QString &datePattern)
|
|
{
|
|
QMutexLocker locker(&mObjectGuard);
|
|
mDatePattern = datePattern;
|
|
}
|
|
|
|
|
|
} // namespace Log4Qt
|
|
|
|
#endif // LOG4QT_DAILYROLLINGFILEAPPENDER_H
|