ArchiveAPI

ArchiveAPI – read out archive file contents + Introducing Bleeding Edge

Working with files on the web has been a challenge for a long time, and when things like various File APIs have surfaced, it has made me really happy! Now on to the latest edition: ArchiveAPI, giving the ability to work with archive files.

Introducing Bleeding Edge

Before I start talking about the ArchiveAPI, I wanted to introduce the new Bleeding Edge category here on Mozilla Hacks. What this means is that we cover technologies/features/APIs that haven’t been released in an official version of Firefox, or any other web browser, yet. It covers things that, in most cases, have their first initial implementation in Firefox Nightly or Firefox Aurora.

The goal is to have these features shipped, but given feedback from you, dear developers, or any other findings during this phase might result in changes to them before they are released.

So, feel more than welcome to try them out! Either you have a headstart on knowing what’s coming, or you have the possibility of affecting the future of features for developers on the web. Win-win! 🙂

What it is

As part of our WebAPI initiative at Mozilla to make the web an even more powerful platform, I was lucky to talk to Andrea Marchesini, the Lead Developer of the ArchiveAPI. Basically, it allows you to read the content of archive files, e.g. ZIP files, directly in web browsers.

Basically, we have an ArchiveReader object and when it successfully manages to read the contents of an archive file, we can iterate over them, read out file data, show previews of each file’s content etc.

var archiveFile = new ArchiveReader(archiveFileReference),
    fileNames = archiveFile.getFilenames();

When you trigger an action/method on this file, like getFilenames, you will have two handlers: onsuccess and onerror. Like this:

fileNames.onerror = function () {
    console.log("Error reading filenames");
};
 
fileNames.onsuccess = function (request) {
    // Get list of files in the archive
    var result = this.result;
 
    // Iterate over those files
    for (var i=0, l=result.length; i<l; i++) {
        file = archiveFile.getFile(result[i]);
 
        file.onerror = function () {
            console.log("Error accessing file");
        };
 
        file.onsuccess = function () {
            // Read out data for that file, such as name, type and size
            var currentFile = this.result;
            console.log(currentFile.name);
        }
    }
}

Demo

I’ve put together an ArchiveAPI demo where you can upload an archive file and for any of the image or text files within that archive, it will directly generate a preview in the web page. The code is available on GitHub, as part of our mozhacks GitHub repositiory.

Note: currently this demo only works in Firefox Aurora and Firefox Nightly.

I’ve also put together a screencast of this demo at YouTube:

(If you’ve opted in to HTML5 video on YouTube you will get that, otherwise it will fallback to Flash)

Feedback

I hope you find this interesting, and one more step forward for the web as a platform! Please let us know what you think in a comment here.

Additionally, there’s a poll/questionnaire you can take with regards to the asynchronous nature of ArchiveAPI. It’s available in Feedback on potential ArchiveReader APIs.

View full post on Mozilla Hacks – the Web developer blog

VN:F [1.9.22_1171]
Rating: 0.0/10 (0 votes cast)
VN:F [1.9.22_1171]
Rating: 0 (from 0 votes)