scan_blacklist.hpp

Go to the documentation of this file.

#pragma once
 
// Scan blacklist companion to HostScanCache.
//
// When a plugin crashes the scanner, the out-of-process scan worker records
// the plugin path + its (mtime, size) pair here. Subsequent scans skip
// blacklisted entries entirely so one bad plugin can't loop the entire scan
// on every startup.
//
// Format is a newline-delimited text file — one entry per line — so a
// user can hand-edit if they want to retry a blacklisted plugin. Lines
// starting with `#` are comments.
 
#include <cstdint>
#include <optional>
#include <string>
#include <unordered_map>
#include <vector>
 
namespace pulp::host {
 
struct BlacklistEntry {
    int64_t mtime = 0;
    int64_t size = 0;
    std::string reason;   
};
 
class ScanBlacklist {
public:
    std::optional<BlacklistEntry> get(const std::string& path) const;

    void blacklist(const std::string& path, std::string reason);

    void clear(const std::string& path) { entries_.erase(path); }
 
    std::size_t size() const { return entries_.size(); }
    bool is_blacklisted(const std::string& path) const {
        return get(path).has_value();
    }

    std::string to_text() const;

    bool from_text(const std::string& text);
 
    bool save_to(const std::string& file_path) const;
    bool load_from(const std::string& file_path);
 
    const std::unordered_map<std::string, BlacklistEntry>& entries() const {
        return entries_;
    }
 
private:
    std::unordered_map<std::string, BlacklistEntry> entries_;
};
 
} // namespace pulp::host