Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/serj-kzv/mozlz4-edit


https://github.com/serj-kzv/mozlz4-edit

Last synced: 14 days ago
JSON representation

Awesome Lists containing this project

README 

        
# What is it?

**mozlz4-edit** is an addon (extension), which is a file archiver that can open, edit and save text ```mozlz4``` files.




The mozlz4-edit is developed as an WebExtension addon because a ```mozlz4```

file format is the [Mozilla Firefox](https://www.mozilla.org)-based products' format only.



# Installation

Click a [mozlz4-edit for Firefox](https://addons.mozilla.org/addon/mozlz4-edit/) link to install.



# (The way does not work with new versions of Firefox!) Using without the installation

**Note.** It seems that the way to run the extension without an installation **does not work anymore** cause new Firefox versions have restrictions to request local JavaScript files. You can still use the way to run the extension with old versions of Firefox or by installing the extension into Firefox.



**The method does not work with Google Chrome!** The method was tested with **Firefox 62**. There is no warranty for older versions.

1. Download an addon archive on [this link](https://github.com/serj-kzv/mozlz4-edit/archive/master.zip).

2. Unpack the archive and open a ```src/index.html``` file of the archive as a simple ```html``` page in Firefox.



It works **even faster** for **Firefox 62 and older** because in that case the extension is executed as a separate process. There is no such effect for **Firefox 63 and newer** because its extensions are executed in the separate process.




But there is no a configuration saving functionality and the addon auto updating.

In the mode you can manually edit a ```src/app/resources/engines.json``` file of the unpacked archive to change default engine list.

Don't forget to press ```Control + F5``` hot keys after the addon files are changed to update the addon page with **file cache resetting** in the mode!



# Description



The mozlz4 is a [lz4](https://lz4.github.io/lz4/) file archive format with Mozilla's "magic" file header.




mozlz4 is a ```legacy``` variant of lz4 format. If you use [liblz4-tool](https://packages.ubuntu.com/liblz4-tool) then you have to use ```-l```

flag to compress a file as the ```legacy``` lz4.



# Dependencies



This project uses [node-lz4](https://github.com/pierrec/node-lz4),

[dustjs](https://github.com/linkedin/dustjs),

[multi.js](https://github.com/fabianlindfors/multi.js)

and [CodeMirror](https://github.com/codemirror/CodeMirror) libraries.

They are inside of the source code and no need to advance installation.

Their licenses inside of a ```LICENSES``` source code directory.



# TODO

1. Use [Emscripten](http://kripken.github.io/emscripten-site/)

to convert C++ lz4 lib to JS ([asm.js](https://developer.mozilla.org/en-US/docs/Games/Tools/asm.js))

2. Replace an estimate of uncompressed file size of lz4

by proper formula



# Links

1. Format description and lz4 lib list is [here](https://github.com/lz4/lz4)  

2. lz4 archiver on js is [here](https://github.com/pierrec/node-lz4)

3. node-mozlz4a is a node.js lib to work with mozlz4 is [here](https://github.com/piroor/node-mozlz4a) (I didn't use it)

4. mozlz4 format description is [here](https://dxr.mozilla.org/mozilla-central/rev/2535bad09d720e71a982f3f70dd6925f66ab8ec7/toolkit/components/lz4/lz4.js#54)

5. A good article about lz4 is [LZ4 Data Compression](https://www.brutaldeluxe.fr/products/crossdevtools/lz4/index.html)

6. Firefox's [Use standard lz4 file format instead of the non-standard jsonlz4/mozlz4](https://bugzilla.mozilla.org/show_bug.cgi?id=1209390) bug



# About lz4

1. https://github.com/lz4/lz4/issues/276#issuecomment-262789645

2. https://github.com/lz4/lz4/wiki/lz4_Frame_format.md



# Mozilla specific lz4

1. https://hg.mozilla.org/mozilla-central/file/a9a24a28013b/toolkit/mozapps/extensions/AddonManagerStartup.cpp

2. https://hg.mozilla.org/mozilla-central/rev/a9a24a28013b

3. https://raw.githubusercontent.com/mozilla/gecko-dev/40e8eb46609dcb8780764774ec550afff1eed3a5/toolkit/mozapps/extensions/AddonManagerStartup.cpp