poco/Foundation/include/Poco/ArchiveStrategy.h

147 lines
3.2 KiB
C
Raw Normal View History

2012-04-29 20:52:25 +02:00
//
// ArchiveStrategy.h
//
// Library: Foundation
// Package: Logging
// Module: FileChannel
//
// Definition of the ArchiveStrategy class and subclasses.
//
// Copyright (c) 2004-2008, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// SPDX-License-Identifier: BSL-1.0
2012-04-29 20:52:25 +02:00
//
#ifndef Foundation_ArchiveStrategy_INCLUDED
#define Foundation_ArchiveStrategy_INCLUDED
#include "Poco/Foundation.h"
#include "Poco/LogFile.h"
#include "Poco/File.h"
#include "Poco/DateTimeFormatter.h"
#include "Poco/NumberFormatter.h"
namespace Poco {
class ArchiveCompressor;
class Foundation_API ArchiveStrategy
2022-07-07 11:18:20 +02:00
/// The ArchiveStrategy is used by FileChannel
2012-04-29 20:52:25 +02:00
/// to rename a rotated log file for archiving.
///
/// Archived files can be automatically compressed,
/// using the gzip file format.
{
public:
ArchiveStrategy();
virtual ~ArchiveStrategy();
virtual LogFile* archive(LogFile* pFile) = 0;
/// Renames the given log file for archiving
/// and creates and returns a new log file.
/// The given LogFile object is deleted.
void compress(bool flag = true);
2022-07-07 11:18:20 +02:00
/// Enables or disables compression of archived files.
2012-04-29 20:52:25 +02:00
protected:
void moveFile(const std::string& oldName, const std::string& newName);
bool exists(const std::string& name);
2022-07-07 11:18:20 +02:00
2012-04-29 20:52:25 +02:00
private:
ArchiveStrategy(const ArchiveStrategy&);
ArchiveStrategy& operator = (const ArchiveStrategy&);
2022-07-07 11:18:20 +02:00
2012-04-29 20:52:25 +02:00
bool _compress;
ArchiveCompressor* _pCompressor;
};
class Foundation_API ArchiveByNumberStrategy: public ArchiveStrategy
/// A monotonic increasing number is appended to the
/// log file name. The most recent archived file
/// always has the number zero.
{
public:
ArchiveByNumberStrategy();
~ArchiveByNumberStrategy();
LogFile* archive(LogFile* pFile);
};
template <class DT>
class ArchiveByTimestampStrategy: public ArchiveStrategy
/// A timestamp (YYYYMMDDhhmmssiii) is appended to archived
/// log files.
{
public:
ArchiveByTimestampStrategy()
{
}
2022-07-07 11:18:20 +02:00
2012-04-29 20:52:25 +02:00
~ArchiveByTimestampStrategy()
{
}
2022-07-07 11:18:20 +02:00
2012-04-29 20:52:25 +02:00
LogFile* archive(LogFile* pFile)
/// Archives the file by appending the current timestamp to the
/// file name. If the new file name exists, additionally a monotonic
/// increasing number is appended to the log file name.
{
std::string path = pFile->path();
delete pFile;
std::string archPath = path;
archPath.append(".");
DateTimeFormatter::append(archPath, DT().timestamp(), "%Y%m%d%H%M%S%i");
2022-07-07 11:18:20 +02:00
2012-04-29 20:52:25 +02:00
if (exists(archPath)) archiveByNumber(archPath);
else moveFile(path, archPath);
return new LogFile(path);
}
private:
void archiveByNumber(const std::string& basePath)
/// A monotonic increasing number is appended to the
/// log file name. The most recent archived file
/// always has the number zero.
{
int n = -1;
std::string path;
do
{
path = basePath;
path.append(".");
NumberFormatter::append(path, ++n);
}
while (exists(path));
2022-07-07 11:18:20 +02:00
2012-04-29 20:52:25 +02:00
while (n >= 0)
{
std::string oldPath = basePath;
if (n > 0)
{
oldPath.append(".");
NumberFormatter::append(oldPath, n - 1);
}
std::string newPath = basePath;
newPath.append(".");
NumberFormatter::append(newPath, n);
moveFile(oldPath, newPath);
--n;
}
}
};
} // namespace Poco
#endif // Foundation_ArchiveStrategy_INCLUDED