1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
|
/// Program to test .nif files both on the FileSystem and in BSA archives.
#include <exception>
#include <filesystem>
#include <iostream>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include <components/bgsm/file.hpp>
#include <components/files/configurationmanager.hpp>
#include <components/files/constrainedfilestream.hpp>
#include <components/files/conversion.hpp>
#include <components/misc/strings/algorithm.hpp>
#include <components/nif/niffile.hpp>
#include <components/vfs/archive.hpp>
#include <components/vfs/bsaarchive.hpp>
#include <components/vfs/filesystemarchive.hpp>
#include <components/vfs/manager.hpp>
#include <components/vfs/recursivedirectoryiterator.hpp>
#include <boost/program_options.hpp>
// Create local aliases for brevity
namespace bpo = boost::program_options;
enum class FileType
{
BSA,
BA2,
BGEM,
BGSM,
NIF,
KF,
BTO,
BTR,
RDT,
PSA,
Unknown,
};
enum class FileClass
{
Archive,
Material,
NIF,
Unknown,
};
std::pair<FileType, FileClass> classifyFile(const std::filesystem::path& filename)
{
const std::string extension = Misc::StringUtils::lowerCase(Files::pathToUnicodeString(filename.extension()));
if (extension == ".bsa")
return { FileType::BSA, FileClass::Archive };
if (extension == ".ba2")
return { FileType::BA2, FileClass::Archive };
if (extension == ".bgem")
return { FileType::BGEM, FileClass::Material };
if (extension == ".bgsm")
return { FileType::BGSM, FileClass::Material };
if (extension == ".nif")
return { FileType::NIF, FileClass::NIF };
if (extension == ".kf")
return { FileType::KF, FileClass::NIF };
if (extension == ".bto")
return { FileType::BTO, FileClass::NIF };
if (extension == ".btr")
return { FileType::BTR, FileClass::NIF };
if (extension == ".rdt")
return { FileType::RDT, FileClass::NIF };
if (extension == ".psa")
return { FileType::PSA, FileClass::NIF };
return { FileType::Unknown, FileClass::Unknown };
}
std::string getFileTypeName(FileType fileType)
{
switch (fileType)
{
case FileType::BSA:
return "BSA";
case FileType::BA2:
return "BA2";
case FileType::BGEM:
return "BGEM";
case FileType::BGSM:
return "BGSM";
case FileType::NIF:
return "NIF";
case FileType::KF:
return "KF";
case FileType::BTO:
return "BTO";
case FileType::BTR:
return "BTR";
case FileType::RDT:
return "RDT";
case FileType::PSA:
return "PSA";
case FileType::Unknown:
default:
return {};
}
}
bool isBSA(const std::filesystem::path& path)
{
return classifyFile(path).second == FileClass::Archive;
}
std::unique_ptr<VFS::Archive> makeArchive(const std::filesystem::path& path)
{
if (isBSA(path))
return VFS::makeBsaArchive(path);
if (std::filesystem::is_directory(path))
return std::make_unique<VFS::FileSystemArchive>(path);
return nullptr;
}
bool readFile(
const std::filesystem::path& source, const std::filesystem::path& path, const VFS::Manager* vfs, bool quiet)
{
const auto [fileType, fileClass] = classifyFile(path);
if (fileClass != FileClass::NIF && fileClass != FileClass::Material)
return false;
const std::string pathStr = Files::pathToUnicodeString(path);
if (!quiet)
{
std::cout << "Reading " << getFileTypeName(fileType) << " file '" << pathStr << "'";
if (!source.empty())
std::cout << " from '" << Files::pathToUnicodeString(isBSA(source) ? source.filename() : source) << "'";
std::cout << std::endl;
}
const std::filesystem::path fullPath = !source.empty() ? source / path : path;
try
{
switch (fileClass)
{
case FileClass::NIF:
{
Nif::NIFFile file(VFS::Path::Normalized(Files::pathToUnicodeString(fullPath)));
Nif::Reader reader(file, nullptr);
if (vfs != nullptr)
reader.parse(vfs->get(pathStr));
else
reader.parse(Files::openConstrainedFileStream(fullPath));
break;
}
case FileClass::Material:
{
if (vfs != nullptr)
Bgsm::parse(vfs->get(pathStr));
else
Bgsm::parse(Files::openConstrainedFileStream(fullPath));
break;
}
default:
break;
}
}
catch (std::exception& e)
{
std::cerr << "Failed to read '" << pathStr << "':" << std::endl << e.what() << std::endl;
}
return true;
}
/// Check all the nif files in a given VFS::Archive
/// \note Can not read a bsa file inside of a bsa file.
void readVFS(std::unique_ptr<VFS::Archive>&& archive, const std::filesystem::path& archivePath, bool quiet)
{
if (archive == nullptr)
return;
if (!quiet)
std::cout << "Reading data source '" << Files::pathToUnicodeString(archivePath) << "'" << std::endl;
VFS::Manager vfs;
vfs.addArchive(std::move(archive));
vfs.buildIndex();
for (const auto& name : vfs.getRecursiveDirectoryIterator())
{
readFile(archivePath, name.value(), &vfs, quiet);
}
if (!archivePath.empty() && !isBSA(archivePath))
{
const Files::Collections fileCollections({ archivePath });
const Files::MultiDirCollection& bsaCol = fileCollections.getCollection(".bsa");
const Files::MultiDirCollection& ba2Col = fileCollections.getCollection(".ba2");
for (const Files::MultiDirCollection& collection : { bsaCol, ba2Col })
{
for (auto& file : collection)
{
try
{
readVFS(VFS::makeBsaArchive(file.second), file.second, quiet);
}
catch (const std::exception& e)
{
std::cerr << "Failed to read archive file '" << Files::pathToUnicodeString(file.second)
<< "': " << e.what() << std::endl;
}
}
}
}
}
bool parseOptions(int argc, char** argv, Files::PathContainer& files, Files::PathContainer& archives,
bool& writeDebugLog, bool& quiet)
{
bpo::options_description desc(
R"(Ensure that OpenMW can use the provided NIF, KF, BTO/BTR, RDT, PSA, BGEM/BGSM and BSA/BA2 files
Usages:
niftest <nif files, kf files, bto/btr files, rdt files, psa files, bgem/bgsm files, BSA/BA2 files, or directories>
Scan the file or directories for NIF errors.
Allowed options)");
auto addOption = desc.add_options();
addOption("help,h", "print help message.");
addOption("write-debug-log,v", "write debug log for unsupported nif files");
addOption("quiet,q", "do not log read archives/files");
addOption("archives", bpo::value<Files::MaybeQuotedPathContainer>(), "path to archive files to provide files");
addOption("input-file", bpo::value<Files::MaybeQuotedPathContainer>(), "input file");
// Default option if none provided
bpo::positional_options_description p;
p.add("input-file", -1);
bpo::variables_map variables;
try
{
bpo::parsed_options valid_opts = bpo::command_line_parser(argc, argv).options(desc).positional(p).run();
bpo::store(valid_opts, variables);
bpo::notify(variables);
if (variables.count("help"))
{
std::cout << desc << std::endl;
return false;
}
writeDebugLog = variables.count("write-debug-log") > 0;
quiet = variables.count("quiet") > 0;
if (variables.count("input-file"))
{
files = asPathContainer(variables["input-file"].as<Files::MaybeQuotedPathContainer>());
if (const auto it = variables.find("archives"); it != variables.end())
archives = asPathContainer(it->second.as<Files::MaybeQuotedPathContainer>());
return true;
}
}
catch (std::exception& e)
{
std::cout << "Error parsing arguments: " << e.what() << "\n\n" << desc << std::endl;
return false;
}
std::cout << "No input files or directories specified!" << std::endl;
std::cout << desc << std::endl;
return false;
}
int main(int argc, char** argv)
{
Files::PathContainer files, sources;
bool writeDebugLog = false;
bool quiet = false;
if (!parseOptions(argc, argv, files, sources, writeDebugLog, quiet))
return 1;
Nif::Reader::setLoadUnsupportedFiles(true);
Nif::Reader::setWriteNifDebugLog(writeDebugLog);
std::unique_ptr<VFS::Manager> vfs;
if (!sources.empty())
{
vfs = std::make_unique<VFS::Manager>();
for (const std::filesystem::path& path : sources)
{
const std::string pathStr = Files::pathToUnicodeString(path);
if (!quiet)
std::cout << "Adding data source '" << pathStr << "'" << std::endl;
try
{
if (auto archive = makeArchive(path))
vfs->addArchive(std::move(archive));
else
std::cerr << "Error: '" << pathStr << "' is not an archive or directory" << std::endl;
}
catch (std::exception& e)
{
std::cerr << "Failed to add data source '" << pathStr << "': " << e.what() << std::endl;
}
}
vfs->buildIndex();
}
for (const auto& path : files)
{
const std::string pathStr = Files::pathToUnicodeString(path);
try
{
const bool isFile = readFile({}, path, vfs.get(), quiet);
if (!isFile)
{
if (auto archive = makeArchive(path))
{
readVFS(std::move(archive), path, quiet);
}
else
{
std::cerr << "Error: '" << pathStr << "' is not a NIF file, material file, archive, or directory"
<< std::endl;
}
}
}
catch (std::exception& e)
{
std::cerr << "Failed to read '" << pathStr << "': " << e.what() << std::endl;
}
}
return 0;
}
|