#include <filelogger.h>

Inheritance diagram for FileLogger:

Collaboration diagram for FileLogger:

Public Types
enum	FileLogAgeType { DAYS , MONTHS , YEARS }

Public Member Functions
	FileLogger (const QString &path, bool backup, int maxSize, bool deleteOld, int age, FileLogAgeType ageType)

	~FileLogger ()

void	changePath (const QString &newPath)

void	deleteOld (int age, FileLogAgeType ageType)

void	setBackup (bool value)

void	setMaxSize (int value)

Private Slots
void	addLogMessage (const Log::Msg &msg)

void	flushLog ()

Private Member Functions
void	openLogFile ()

void	closeLogFile ()

Private Attributes
QString	m_path

bool	m_backup

int	m_maxSize

QFile	m_logFile

QTimer	m_flusher

Detailed Description

Definition at line 40 of file filelogger.h.

Member Enumeration Documentation

◆ FileLogAgeType

enum FileLogger::FileLogAgeType

Enumerator
DAYS
MONTHS
YEARS

Definition at line 46 of file filelogger.h.

     {
         DAYS,
         MONTHS,
         YEARS
     };

Constructor & Destructor Documentation

◆ FileLogger()

FileLogger::FileLogger	(	const QString &	path,
		bool	backup,
		int	maxSize,
		bool	deleteOld,
		int	age,
		FileLogAgeType	ageType
	)

Definition at line 47 of file filelogger.cpp.

     : m_backup(backup)
     , m_maxSize(maxSize)
 {
     m_flusher.setInterval(FLUSH_INTERVAL);
     m_flusher.setSingleShot(true);
     connect(&m_flusher, &QTimer::timeout, this, &FileLogger::flushLog);
  
     changePath(path);
     if (deleteOld)
         this->deleteOld(age, ageType);
  
     const Logger *const logger = Logger::instance();
     for (const Log::Msg &msg : asConst(logger->getMessages()))
         addLogMessage(msg);
  
     connect(logger, &Logger::newLogMessage, this, &FileLogger::addLogMessage);
 }

References addLogMessage(), asConst(), changePath(), deleteOld(), anonymous_namespace{filelogger.cpp}::FLUSH_INTERVAL, flushLog(), Logger::getMessages(), Logger::instance(), m_flusher, and Logger::newLogMessage().

Here is the call graph for this function:

◆ ~FileLogger()

FileLogger::~FileLogger ( )

Definition at line 66 of file filelogger.cpp.

 {
     closeLogFile();
 }

References closeLogFile().

Here is the call graph for this function:

Member Function Documentation

◆ addLogMessage

void FileLogger::addLogMessage ( const Log::Msg & msg )

privateslot

Definition at line 124 of file filelogger.cpp.

 {
     if (!m_logFile.isOpen()) return;
  
     QTextStream stream(&m_logFile);
 #if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
     stream.setCodec("UTF-8");
 #endif
  
     switch (msg.type)
     {
     case Log::INFO:
         stream << "(I) ";
         break;
     case Log::WARNING:
         stream << "(W) ";
         break;
     case Log::CRITICAL:
         stream << "(C) ";
         break;
     default:
         stream << "(N) ";
     }
  
     stream << QDateTime::fromMSecsSinceEpoch(msg.timestamp).toString(Qt::ISODate) << " - " << msg.message << '\n';
  
     if (m_backup && (m_logFile.size() >= m_maxSize))
     {
         closeLogFile();
         int counter = 0;
         QString backupLogFilename = m_path + ".bak";
  
         while (QFile::exists(backupLogFilename))
         {
             ++counter;
             backupLogFilename = m_path + ".bak" + QString::number(counter);
         }
  
         QFile::rename(m_path, backupLogFilename);
         openLogFile();
     }
     else
     {
         if (!m_flusher.isActive())
             m_flusher.start();
     }
 }

References closeLogFile(), Log::CRITICAL, Log::INFO, m_backup, m_flusher, m_logFile, m_maxSize, m_path, Log::Msg::message, openLogFile(), Log::Msg::timestamp, Log::Msg::type, and Log::WARNING.

Referenced by FileLogger().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ changePath()

void FileLogger::changePath ( const QString & newPath )

Definition at line 71 of file filelogger.cpp.

 {
     const QDir dir(newPath);
     dir.mkpath(newPath);
     const QString tmpPath = dir.absoluteFilePath("qbittorrent.log");
  
     if (tmpPath != m_path)
     {
         m_path = tmpPath;
  
         closeLogFile();
         m_logFile.setFileName(m_path);
         openLogFile();
     }
 }

References closeLogFile(), m_logFile, m_path, and openLogFile().

Referenced by FileLogger().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ closeLogFile()

void FileLogger::closeLogFile ( )

private

Definition at line 188 of file filelogger.cpp.

 {
     m_flusher.stop();
     m_logFile.close();
 }

References m_flusher, and m_logFile.

Referenced by addLogMessage(), changePath(), and ~FileLogger().

Here is the caller graph for this function:

◆ deleteOld()

void FileLogger::deleteOld	(	int	age,
		FileLogAgeType	ageType
	)

Definition at line 87 of file filelogger.cpp.

 {
     const QDateTime date = QDateTime::currentDateTime();
     const QDir dir(Utils::Fs::branchPath(m_path));
     const QFileInfoList fileList = dir.entryInfoList(QStringList("qbittorrent.log.bak*")
         , (QDir::Files | QDir::Writable), (QDir::Time | QDir::Reversed));
  
     for (const QFileInfo &file : fileList)
     {
         QDateTime modificationDate = file.lastModified();
         switch (ageType)
         {
         case DAYS:
             modificationDate = modificationDate.addDays(age);
             break;
         case MONTHS:
             modificationDate = modificationDate.addMonths(age);
             break;
         default:
             modificationDate = modificationDate.addYears(age);
         }
         if (modificationDate > date)
             break;
         Utils::Fs::forceRemove(file.absoluteFilePath());
     }
 }

References Utils::Fs::branchPath(), DAYS, file(), Utils::Fs::forceRemove(), m_path, and MONTHS.

Referenced by FileLogger().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ flushLog

void FileLogger::flushLog ( )

privateslot

Definition at line 172 of file filelogger.cpp.

 {
     if (m_logFile.isOpen())
         m_logFile.flush();
 }

References m_logFile.

Referenced by FileLogger().

Here is the caller graph for this function:

◆ openLogFile()

void FileLogger::openLogFile ( )

private

Definition at line 178 of file filelogger.cpp.

 {
     if (!m_logFile.open(QIODevice::WriteOnly | QIODevice::Append | QIODevice::Text)
         || !m_logFile.setPermissions(QFile::ReadOwner | QFile::WriteOwner))
     {
         m_logFile.close();
         LogMsg(tr("An error occurred while trying to open the log file. Logging to file is disabled."), Log::CRITICAL);
     }
 }