Cleanup and TODO

lib/Epub/Epub/BookMetadataCache.cpp

@@ -131,6 +131,9 @@ bool BookMetadataCache::buildBookBin(const std::string& epubPath, const BookMeta
     tocFile.close();
     return false;
   }
+  // TODO: For large ZIPs loading the all localHeaderOffsets will crash.
+  //       However not having them loaded is extremely slow. Need a better solution here.
+  //       Perhaps only a cache of spine items or a better way to speedup lookups?
   if (!zip.loadAllLocalHeaderOffsets()) {
     Serial.printf("[%lu] [BMC] Could not load zip local header offsets for size calculations\n", millis());
     bookFile.close();
@@ -241,6 +244,8 @@ void BookMetadataCache::createTocEntry(const std::string& title, const std::stri
 
   int spineIndex = -1;
   // find spine index
+  // TODO: This lookup is slow as need to scan through all items each time. We can't hold it all in memory due to size.
+  //       But perhaps we can load just the hrefs in a vector/list to do an index lookup?
   spineFile.seek(0);
   for (int i = 0; i < spineCount; i++) {
     auto spineEntry = readSpineEntry(spineFile);

lib/Epub/Epub/parsers/ContentOpfParser.cpp

@@ -182,6 +182,8 @@ void XMLCALL ContentOpfParser::startElement(void* userData, const XML_Char* name
         if (strcmp(atts[i], "idref") == 0) {
           const std::string idref = atts[i + 1];
           // Resolve the idref to href using items map
+          // TODO: This lookup is slow as need to scan through all items each time.
+          //       It can take up to 200ms per item when getting to 1500 items.
           self->tempItemStore.seek(0);
           std::string itemId;
           std::string href;

lib/ZipFile/ZipFile.cpp

@@ -47,6 +47,9 @@ bool ZipFile::loadAllLocalHeaderOffsets() {
   uint32_t sig;
   char itemName[256];
 
+  localHeaderOffsets.clear();
+  localHeaderOffsets.reserve(zipDetails.totalEntries);
+
   while (file.available()) {
     file.read(reinterpret_cast<uint8_t*>(&sig), 4);
     if (sig != 0x02014b50) break;  // End of list
@@ -77,11 +80,14 @@ bool ZipFile::loadAllLocalHeaderOffsets() {
 }
 
 bool ZipFile::loadLocalHeaderOffset(const char* filename, uint32_t* localHeaderOffset) {
-  if (localHeaderOffsets.count(filename) > 0) {
-    *localHeaderOffset = localHeaderOffsets.at(filename);
-    Serial.printf("[%lu] [ZIP] Found cached local header offset for file: %s (LHO: %lu)\n", millis(), filename,
-                  static_cast<unsigned long>(*localHeaderOffset));
-    return true;
+  // If we have saved any offset, assume they're all loaded
+  if (!localHeaderOffsets.empty()) {
+    if (localHeaderOffsets.count(filename) > 0) {
+      *localHeaderOffset = localHeaderOffsets.at(filename);
+      return true;
+    }
+
+    return false;
   }
 
   const bool wasOpen = isOpen();

lib/ZipFile/ZipFile.h

@@ -1,8 +1,8 @@
 #pragma once
 #include <FS.h>
 
-#include <map>
 #include <string>
+#include <unordered_map>
 
 class ZipFile {
  public:
@@ -23,7 +23,7 @@ class ZipFile {
   const std::string& filePath;
   File file;
   ZipDetails zipDetails = {0, 0, false};
-  std::map<std::string, uint32_t> localHeaderOffsets;
+  std::unordered_map<std::string, uint32_t> localHeaderOffsets;
   bool loadLocalHeaderOffset(const char* filename, uint32_t* localHeaderOffset);
 
   bool loadFileStatSlim(const char* filename, FileStatSlim* fileStat);