feature: ZimMount

[lyc8503]

Current progress:

• Options to mount Zim files via command line interface
• List files

Not working:

• Tests / CI are failing
• [ ]

For kiwix/overview#79

[mgautierfr]

This first version seems good (well, it is a first version :) )

While we are here, I want to mention a important thing:

A zim file can contains this four entries:

• foo
• foo/
• foo/index.hmtl
• foo/bar.html.

So we have two entries in the zim files that are also directory on the filesystem. We have to handle that correctly (ignore them ? Map them to something else ?) and not crash or hide children.

For now, we would create a foo node with a index.
Then we would create , index.html and bar.html nodes in foo node.
But as the foo node has a index, it will be shown as a file on filesystem and other entries will be hidden.

I think this issue is the real challenge here. All the others are pretty technical.

[codecov]

Codecov Report

Patch coverage has no change and project coverage change: -27.44 ⚠️

Comparison is base (b352392) 27.43% compared to head (a88902c) 0.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #348       +/-   ##
==========================================
- Coverage   27.43%   0.00%   -27.44%     
==========================================
  Files          26      20        -6     
  Lines        2544    1683      -861     
  Branches     1389     926      -463     
==========================================
- Hits          698       0      -698     
- Misses       1333    1683      +350     
+ Partials      513       0      -513     

see 24 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[lyc8503]

This first version seems good (well, it is a first version :) )

While we are here, I want to mention a important thing:

A zim file can contains this four entries:

• foo
• foo/
• foo/index.hmtl
• foo/bar.html.

So we have two entries in the zim files that are also directory on the filesystem. We have to handle that correctly (ignore them ? Map them to something else ?) and not crash or hide children.

For now, we would create a foo node with a index. Then we would create , index.html and bar.html nodes in foo node. But as the foo node has a index, it will be shown as a file on filesystem and other entries will be hidden.

I think this issue is the real challenge here. All the others are pretty technical.

I took a look at the implementation of zimdump, and to my understanding, it would dump the file foo to _exceptions/foo and create foo folder (and its children) in its original place in such case.

I think I could try to implement the same behavior in zimmount.