versioned_csv_file.h

Go to the documentation of this file.

// Copyright (C) 2015-2026 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 VERSIONED_CSV_FILE_H
#define VERSIONED_CSV_FILE_H
 
#include <util/csv_file.h>
 
#include <cstdint>
 
namespace isc {
namespace util {

class VersionedCSVFileError : public Exception {
public:
    VersionedCSVFileError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { }
};

class VersionedColumn {
public:
    VersionedColumn(const std::string& name, const std::string& version,
               const std::string& default_value = "")
        : name_(name), version_(version), default_value_(default_value) {
    };

    virtual ~VersionedColumn(){};

    std::string name_;

    std::string version_;

    std::string default_value_;
};

typedef boost::shared_ptr<VersionedColumn> VersionedColumnPtr;

class VersionedCSVFile : public CSVFile {
public:

    enum InputSchemaState : uint16_t {
        CURRENT,
        NEEDS_UPGRADE,
        NEEDS_DOWNGRADE
    };

    VersionedCSVFile(const std::string& filename);

    virtual ~VersionedCSVFile();

    void addColumn(const std::string& col_name, const std::string& version,
                   const std::string& default_value = "");

    void setMinimumValidColumns(const std::string& column_name);

    size_t getMinimumValidColumns() const;

    size_t getInputHeaderCount() const;

    size_t getValidColumnCount() const;

    virtual void open(const bool seek_to_end = false);

    virtual void recreate();

    bool next(CSVRow& row);

    std::string getInputSchemaVersion() const;

    std::string getSchemaVersion() const;

    const VersionedColumnPtr& getVersionedColumn(const size_t index) const;

    enum InputSchemaState getInputSchemaState() const;

    bool needsConversion() const;
 
protected:

    virtual bool validateHeader(const CSVRow& header);

    void columnCountError(const CSVRow& row, const std::string& reason);
 
private:
    std::vector<VersionedColumnPtr> columns_;

    size_t valid_column_count_;

    size_t minimum_valid_columns_;

    size_t input_header_count_;

    enum InputSchemaState input_schema_state_;
};
 
 
} // namespace isc::util
} // namespace isc
 
#endif // VERSIONED_CSV_FILE_H