takane
Validators for ArtifactDB file formats
Loading...
Searching...
No Matches
rds_file.hpp
Go to the documentation of this file.
1#ifndef TAKANE_RDS_FILE_HPP
2#define TAKANE_RDS_FILE_HPP
3
4#include "utils_files.hpp"
5#include "ritsuko/ritsuko.hpp"
6
7#include <filesystem>
8#include <stdexcept>
9#include <string>
10
16namespace takane {
17
22namespace rds_file {
23
32inline void validate(const std::filesystem::path& path, const ObjectMetadata& metadata, Options& options) {
33 const std::string type_name = "rds_file"; // use a separate variable to avoid dangling reference warnings from GCC.
34 const auto& rdsmap = internal_json::extract_typed_object_from_metadata(metadata.other, type_name);
35
36 const std::string version_name = "version"; // again, avoid dangling reference warnings.
37 const std::string& vstring = internal_json::extract_string_from_typed_object(rdsmap, version_name, type_name);
38 auto version = ritsuko::parse_version_string(vstring.c_str(), vstring.size(), /* skip_patch = */ true);
39 if (version.major != 1) {
40 throw std::runtime_error("unsupported version string '" + vstring + "'");
41 }
42
43 auto fpath = path / "file.rds";
44
45 // Check magic numbers.
46 internal_files::check_gzip_signature(fpath);
47
48 const char* expected = "X\n";
49 size_t expected_len = 2;
50
51 auto reader = internal_other::open_reader<byteme::GzipFileReader>(fpath, expected_len);
52 byteme::PerByte<> pb(&reader);
53 bool okay = pb.valid();
54
55 for (size_t i = 0; i < expected_len; ++i) {
56 if (!okay) {
57 throw std::runtime_error("incomplete RDS file signature for '" + fpath.string() + "'");
58 }
59 if (pb.get() != expected[i]) {
60 throw std::runtime_error("incorrect RDS file signature for '" + fpath.string() + "'");
61 }
62 okay = pb.advance();
63 }
64
65 if (options.rds_file_strict_check) {
66 options.rds_file_strict_check(path, metadata, options);
67 }
68}
69
70}
71
72}
73
74#endif
void validate(const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)
Definition rds_file.hpp:32
takane validation functions.
Definition _derived_from.hpp:15
Object metadata, including the type and other fields.
Definition utils_public.hpp:26
std::unordered_map< std::string, std::shared_ptr< millijson::Base > > other
Definition utils_public.hpp:35
Validation options.
Definition utils_public.hpp:94
std::function< void(const std::filesystem::path &, const ObjectMetadata &, Options &)> rds_file_strict_check
Definition utils_public.hpp:229