File System

This library is an implementation of an "homemade" File System, similar to FAT. It's based on steganography so data can be stored and loaded from a supported image file (Image must be drawable with CanvasRenderingContext2D.drawImage). A GUI is also included with multiples applications.

• Live demo
• Documentation

Features

• Configurable Image disk

  • size : change image size
  • table size : change max entries (folders and files) number
  • block size : change block size
  • entry name length : change number of bytes allocated to entries names
  • table extended : choose if creation and last edition dates and permissions should be stored in FAT

• Graphical user interface (GUI) included with the following applications :

  • File Explorer : navigate through the disk easily
    • Create, delete and edit files and folders
    • Show file and disk properties**
    • Support hidden entries
  • Command-line interface : use powerful commands
  • User sessions : manage sessions
  • Image loader : load existing image
  • Disk dissembler (using steganography) : hide data on an existing image
  • Disk encrypter/decrypter* : protect data with a passphrase
  • Text editor : Create and edit text files
  • Image displayer : Display Base64 encoded image files
  • Audio player : Play Base64 encoded audio files
  • Script interpreter : Expand functionnality yourself thanks to the JavaScript interpreter

Getting Started

First of all, you'll need to include the library :

    <script src="./bin/lowlight.fs.js"></script>

You may include the minified library instead :

    <script src="./bin/lowlight.fs.min.js"></script>

Then you may create alias for convenience :

    let GUI = Lowlight.FileSystem.GUI
    let Image = Lowlight.FileSystem.Image

Note that jQuery is used by this library and must be loaded first :

    <script src="./path/to/jquery.js"></script>

Setup

The following html structure is required :

    <canvas class="app-view" width="400" height="400">
    <div class="app-controller"></div>

Then add the following code snippet :

    $("<img>").attr("src", "/src/file-system/demo/image.png").on("load", function () {
        //Draw initial image
            $(".app-view canvas").get(0).getContext("2d").drawImage($(this).get(0), 0, 0)
        //Create interface
            new GUI(
                Image.open($(".app-view canvas").get(0).getContext("2d")),
                $(".app-controller").get(0)
            )
    })

You may also add the stylesheet and pictures from /demo to have a nice GUI visual render.

If you're a developper and want to expand library, you may want to read documentation to understand how this project has been coded.

Don't forget to check and update src/Interfaces/GUI/Gui.static.js to update text and icons.

Commands list

GUI is pretty intuitive but if you want to use command-line interface instead, you can use the following commands. Note that's the only way to create a new disk.

Applications

Entries management

Folders management

Files management

Users management

Encryption and decryption

System

Disk image

Project content

Rebuild project and expanding the library

You'll need to run the following command the first time to install dependencies.

npm install

Then to rebuild project, just run the following command :

npm run build

This will update /bin files with included /src files. Although package.json (which contains "source" and "output" paths) are preconfigured, you may need to reconfigure them if you're planning to expand this library.

To include a file just use the following syntax in the "source" file :

    /* #include <path/to/file.js> */

• File minification is performed with Babel minify.
• Documentation is generated with JSDoc 3.

Although package.json (which contains "jsdoc_source", "jsdoc_output", "jsdoc_config" and "jsdoc_readme") and docs/categories.json are preconfigured, you may need to reconfigure them if you're planning to expand this library.

License

This project is licensed under the MIT License.

See LICENSE.md file for details.