rotating_file.h

Go to the documentation of this file.

// Copyright (C) 2016-2025 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef ROTATING_FILE_H
#define ROTATING_FILE_H
 
#include <dhcpsrv/legal_log_mgr_factory.h>
 
#include <mutex>

 
namespace isc {
namespace legal_log {

class RotatingFile : public isc::dhcp::LegalLogMgr {
public:

    enum class TimeUnit {
        Second,
        Day,
        Month,
        Year
    };

    RotatingFile(const isc::db::DatabaseConnection::ParameterMap& parameters);

    virtual ~RotatingFile();

    void apply(const isc::db::DatabaseConnection::ParameterMap& parameters);

    virtual void open();

    virtual void close();

    virtual void writeln(const std::string& text, const std::string& addr);

    virtual std::string getType() const {
        return (std::string("logfile"));
    }

    std::string getFileName() const {
        return (file_name_);
    }

    std::string getBaseName() const {
        return (base_name_);
    }

    std::string getPath() const {
        return (path_);
    }

    static std::string getYearMonthDay(const struct tm& time_info);

    void updateFileNameAndTimestamp(struct tm& time_info, bool use_existing);
 
protected:

    virtual void openInternal(struct tm& time_info, bool use_existing);

    void useExistingFiles(struct tm& time_info);

    virtual void rotate();

    virtual bool isOpen() const;
 
private:
    void writelnInternal(const std::string& text);

    std::string path_;

    std::string base_name_;

    TimeUnit time_unit_;

    uint32_t count_;

    std::string file_name_;

    std::ofstream file_;

    std::string prerotate_;

    std::string postrotate_;

    time_t timestamp_;

    std::mutex mutex_;
 
public:
    static isc::dhcp::LegalLogMgrPtr
    factory(const isc::db::DatabaseConnection::ParameterMap& parameters);
};

struct RotatingFileInit {
    // Constructor registers
    RotatingFileInit() {
        isc::dhcp::LegalLogMgrFactory::registerBackendFactory("logfile", RotatingFile::factory);
    }
 
    // Destructor deregisters
    ~RotatingFileInit() {
        isc::dhcp::LegalLogMgrFactory::unregisterBackendFactory("logfile");
    }
};
 
} // namespace legal_log
} // namespace isc
 
#endif