zim::Archive::getIllustrations()

Author: veloman-yunkan

include/zim/archive.h

@@ -24,6 +24,7 @@
 
 #include "zim.h"
 #include "entry.h"
+#include "illustration.h"
 #include "uuid.h"
 
 #include <string>
@@ -101,6 +102,7 @@ namespace zim
     public:
       template<EntryOrder order> class EntryRange;
       template<EntryOrder order> class iterator;
+      typedef std::vector<IllustrationInfo> Illustrations;
 
       /** Archive constructor.
        *
@@ -359,6 +361,13 @@ namespace zim
       std::set<unsigned int> getIllustrationSizes() const;
 
 
+      /** Return the list of available illustations in the archive.
+       *
+       * @return A vector of IllustrationInfo data.
+       */
+      Illustrations getIllustrations() const;
+
+
       /** Get an entry using its "path" index.
        *
        *  Use the index of the entry to get the idx'th entry

src/archive.cpp

@@ -233,6 +233,32 @@ namespace zim
     return ret;
   }
 
+  Archive::Illustrations Archive::getIllustrations() const {
+    Illustrations r;
+    for(auto e = m_impl->findx('M', "Illustration_").second; ; ++e ) {
+      try {
+        const auto path = getEntryByPath(entry_index_type(e)).getPath();
+        if (path.find("Illustration_") != 0) {
+          break;
+        }
+        try {
+          r.push_back(zim::IllustrationInfo::fromMetadataItemName(path));
+        } catch (...) {}
+      } catch (const std::out_of_range& e) {
+        break;
+      }
+    }
+    const IllustrationInfo faviconLikeIllustration{48, 48, 1.0, {}};
+    if (std::find(r.begin(), r.end(), faviconLikeIllustration) == r.end()) {
+      try {
+        // raise a exception if we cannot find the (old format) favicon.
+        findFavicon(*m_impl);
+        r.push_back(faviconLikeIllustration);
+      } catch(EntryNotFound&) {}
+    }
+    return r;
+  }
+
   bool Archive::hasIllustration(unsigned int size) const {
     try {
       getIllustrationItem(size);

test/archive.cpp

@@ -200,6 +200,10 @@ TEST_F(ZimArchive, openCreatedArchive)
   ASSERT_EQ(archive.getUuid(), uuid);
   ASSERT_EQ(archive.getMetadataKeys(), std::vector<std::string>({"Counter", "Illustration_48x48@1", "Illustration_96x96@1", "Title"}));
   ASSERT_EQ(archive.getIllustrationSizes(), std::set<unsigned int>({48, 96}));
+  ASSERT_EQ(archive.getIllustrations(), zim::Archive::Illustrations({
+              {48, 48, 1.0, {}},
+              {96, 96, 1.0, {}},
+  }));
   ASSERT_TRUE(archive.hasMainEntry());
 
   ASSERT_EQ(archive.getMetadata("Title"), "This is a title");
@@ -612,6 +616,9 @@ TEST_F(ZimArchive, illustration)
         ASSERT_EQ(illustrationItem.getPath(), "Illustration_48x48@1") << ctx;
       }
       ASSERT_EQ(archive.getIllustrationSizes(), std::set<unsigned int>({48}));
+      ASSERT_EQ(archive.getIllustrations(), zim::Archive::Illustrations({
+                  {48, 48, 1.0, {}},
+      }));
     }
   }
 }