WIP: Switch to Illustration API

Creator `set_faviconpath(path)` is now replaced with `add_illustration(size, content)`
which instead of recording the path of a Favicon Entry, receives the bytes of a PNG
image for a specific size (adding a 48 sized one being mandatory as per zim spec.)

Archive `has_favicon_entry` is replaced with `has_illustration(size=None)`
Archive `favicon_entry` is replaced with `get_illustration_item(size=None)`
Size is optionnal and defaults to 48 in libzim.
Note that we used to retrieve an Entry and now receive an Item.

Additionnaly, Archive gets a `get_illustration_sizes()` which returns a set of int sizes
for which an illustration is present.
WARNING: this is not implemented ATM and simply return a set with 48 regarless of what's
currently in the ZIM.

Author: renaud gaudin

libzim/lib.h

@@ -81,8 +81,12 @@ class ZimArchive : public zim::Archive
     { return to_ptr<ZimEntry>(zim::Archive::getEntryByTitle(title)); }
     ZimEntry* getMainEntry() const
     { return to_ptr<ZimEntry>(zim::Archive::getMainEntry()); }
-    ZimEntry* getFaviconEntry() const
-    { return to_ptr<ZimEntry>(zim::Archive::getFaviconEntry()); }
+    // ZimEntry* getFaviconEntry() const
+    // { return to_ptr<ZimEntry>(zim::Archive::getFaviconEntry()); }
+    ZimItem* getIllustrationItem() const
+    { return to_ptr<ZimItem>(zim::Archive::getIllustrationItem()); }
+    ZimItem* getIllustrationItem(unsigned int size) const
+    { return to_ptr<ZimItem>(zim::Archive::getIllustrationItem(size)); }
     std::string getUuid() const
     { zim::Uuid uuid = zim::Archive::getUuid();
       std::string uuids(uuid.data, uuid.size()); return uuids; }

libzim/wrapper.pxd

@@ -69,7 +69,7 @@ cdef extern from "zim/writer/creator.h" namespace "zim::writer":
         void addRedirection(string path, string title, string targetpath) nogil except +
         void finishZimCreation() nogil except +
         void setMainPath(string mainPath)
-        void setFaviconPath(string faviconPath)
+        void addIllustration(unsigned int size, string content)
 
 cdef extern from "lib.h":
     # The only thing we need to know here is how to create the Wrapper.
@@ -144,15 +144,18 @@ cdef extern from "lib.h":
         vector[string] getMetadataKeys() except +
 
         ZimEntry* getMainEntry() except +
-        ZimEntry* getFaviconEntry() except +
+        ZimItem* getIllustrationItem() except +
+        ZimItem* getIllustrationItem(int size) except +
         size_type getEntryCount() except +
 
         string getChecksum() except +
         string getFilename() except +
         string getUuid() except +
 
         bool hasMainEntry() except +
-        bool hasFaviconEntry() except +
+        bool hasIllustration() except +
+        bool hasIllustration(unsigned int size) except +
+        # set[unsigned int] getIllustrationSizes() except +
         bool hasEntryByPath(string path) except +
         bool hasEntryByTitle(string title) except +
         bool is_multiPart() except +

libzim/wrapper.pyx

@@ -31,6 +31,7 @@ from cpython.buffer cimport PyBUF_WRITABLE
 from libc.stdint cimport uint64_t
 from libcpp.string cimport string
 from libcpp cimport bool
+from libcpp.set cimport set
 from libcpp.memory cimport shared_ptr, make_shared, unique_ptr
 
 import pathlib
@@ -240,9 +241,9 @@ cdef class Creator:
         self.c_creator.setMainPath(mainPath.encode('utf8'))
         return self
 
-    def set_faviconpath(self, str faviconPath) -> Creator:
-        self.c_creator.setFaviconPath(faviconPath.encode('utf8'))
-        return self
+    def add_illustration(self, size: int, content):
+        cdef string _content = content
+        self.c_creator.addIllustration(size, _content)
 
 #    def set_uuid(self, uuid) -> Creator:
 #        self.c_creator.setUuid(uuid)
@@ -561,14 +562,6 @@ cdef class PyArchive:
     def main_entry(self) -> Entry:
         return Entry.from_entry(self.c_archive.getMainEntry())
 
-    @property
-    def has_favicon_entry(self) -> bool:
-        return self.c_archive.hasFaviconEntry()
-
-    @property
-    def favicon_entry(self) -> Entry:
-        return Entry.from_entry(self.c_archive.getFaviconEntry())
-
     @property
     def uuid(self) -> UUID:
         return UUID(self.c_archive.getUuid().hex())
@@ -605,6 +598,26 @@ cdef class PyArchive:
     def entry_count(self) -> int:
         return self.c_archive.getEntryCount()
 
+    def get_illustration_sizes(self):
+        # FIXME: using static shortcut instead of libzim's
+        # cdef set[unsigned int] sizes = self.c_archive.getIllustrationSizes()
+        return {48}
+
+    def has_illustration(self, size: int = None) -> bool:
+        """ whether Archive has an Illustration metadata for this size """
+        if size is not None:
+            return self.c_archive.hasIllustration(size)
+        return self.c_archive.hasIllustration()
+
+    def get_illustration_item(self, size: int = None) -> Item:
+        """ Illustration Metadata Item for this size """
+        try:
+            if size is not None:
+                return Item.from_item(self.c_archive.getIllustrationItem(size))
+            return Item.from_item(self.c_archive.getIllustrationItem())
+        except RuntimeError as e:
+            raise KeyError(str(e))
+
     def suggest(self, query: str, start: int = 0, end: int = 10) -> Generator[str, None, None]:
         """ Paths of suggested entries in the archive from a title query -> Generator[str, None, None]
 

tests/test_libzim_creator.py

@@ -331,27 +331,18 @@ def test_creator_mainpath(fpath, lipsum_item):
         assert zim.main_entry
 
 
-def test_creator_faviconpath(fpath, favicon_data):
-    favicon_path = HOME_PATH
-    favicon_item = StaticItem(
-        mimetype="image/png", path=favicon_path, content=favicon_data
-    )
-    with Creator(fpath).set_faviconpath(favicon_path) as c:
-        c.add_item(favicon_item)
-
-    zim = Archive(fpath)
-    assert zim.has_favicon_entry is True
-    assert zim.favicon_entry.path == "favicon"
-    assert zim.favicon_entry.get_item().path == favicon_path
-
-    fpath.unlink()
-
+def test_creator_illustration(fpath, favicon_data):
     with Creator(fpath) as c:
-        c.add_item(favicon_item)
+        c.add_illustration(48, favicon_data)
+        c.add_illustration(96, favicon_data)
+
     zim = Archive(fpath)
-    assert zim.has_favicon_entry is False
-    with pytest.raises(RuntimeError):
-        assert zim.favicon_entry
+    assert zim.has_illustration() is True
+    assert zim.has_illustration(48) is True
+    assert zim.has_illustration(96) is True
+    assert zim.has_illustration(128) is False
+    assert bytes(zim.get_illustration_item().content) == favicon_data
+    assert bytes(zim.get_illustration_item(96).content) == favicon_data
 
 
 def test_creator_additem(fpath, lipsum_item):

tests/test_libzim_reader.py

@@ -318,14 +318,17 @@ def test_reader_main_favicon_entries(
             assert zim.main_entry.path == "mainPage"
 
     # make sure we have no favicon entry
-    assert zim.has_favicon_entry is has_favicon_entry
+    assert zim.has_illustration(48) is has_favicon_entry
+    if has_favicon_entry:
+        assert 48 in zim.get_illustration_sizes()
+
     if has_favicon_entry is False:
-        with pytest.raises(RuntimeError):
-            assert zim.favicon_entry
+        with pytest.raises(KeyError):
+            assert zim.get_illustration_item(48)
     else:
-        assert zim.favicon_entry
+        assert zim.get_illustration_item()
         if new_ns:
-            assert zim.favicon_entry.path == "-/favicon"
+            assert zim.get_illustration_item().path == "Illustration_48x48@1"
 
 
 @pytest.mark.parametrize(
@@ -438,7 +441,7 @@ def test_reader_get_entries(
     with pytest.raises(KeyError):
         zim.get_entry_by_title("___missing")
 
-    # FIXME: unable to re
+    # FIXME: unable to retrieve entry by title on example.zim
     if test_title and filename != "example.zim":
         assert zim.has_entry_by_title(test_title)
         assert zim.get_entry_by_title(test_title).path == entry.path