Пример использования telnet-сервера в firefox

Каждый раз, когда мне говорят «о! новый хромиум стал еще быстре, а новая опера — еще мелодичнее», в ответ я задаю простой вопрос: «А в вашем браузере есть telnet-сервер? А вот в firefox — есть», — после чего адепты других религий понимают, что пропаганда бесполезна.

В этой заметке речь пойдет о том, как можно расширять и управлять огненной лисицей из других приложений через вышеупомянутый telnet-сервер, реализуемый плагином mozrepl. В качестве примера я покажу, как реализовать функцию создания скриншота сайта с минимальными усилиями.

Но сперва несколько дополнительных предусловий. Во-первых, скриншот должен быть полноразмерным, а не обрезанным по viewport. Во-вторых, я не очень хочу писать без необходимости на низкоуровневых языках.

В числе прочих были рассмотрены варианты использования khtml2png и пары из xwd+imagemagic, но рендерялка khtml3 безбожно глючила, а второй вариант был не так тривиален, как хотелось бы.

Если все крутится вокруг бразуера — значит надо либо дописывать код к браузеру, либо воздействовать на браузер из внешней программы. В процессе поиска решения был найден чудесный плагин Screen grab!, который снимал нужные варианты скриншотов и оставалось только научиться управлять этим плагином. Вспоминая, что в случае с OpenOffice подобную функциональность можно получить используя возможность тестирования пользовательского интерфейса, я отправился на поиски тестовых плагинов. Поиск увенчался успехом и после просмотра вдохновляющего скринкаста о управлении firefox-ом из emacs-а был достаточно быстро написан черновик кода.

Идея проста до невозможности — на лету патчится функция открытия файла screengrab-а после чего вызывается одна из функций плагина и, соответственно, скриншот сохранятеся прямо в файл без каких-либо вопросов к пользователю.

Впоследствие код превратился вот в это:

var ScreenshotSaver = {
    lambda: null, // EventListener
    mixin:  null, // our file opener
    pure:   null, // screengrab's file opener
    answer: 42,   // to check `this' validity
};

ScreenshotSaver.assert = function(bool) {
    if (!bool) {
        repl.print('assertion failed');
        repl.print(arguments.callee.caller);
    }
};

ScreenshotSaver.save = function(url, fpath) {
    this._install_onload(fpath);
    window.content.location.href = url;
};

ScreenshotSaver._install_onload = function(fpath) {
    this.assert(this.lambda === null);

    // Looks like hack, but I need valid `this' in _dump_screenshot
    // I need this.lambda to be precise.
    this.lambda = function(ev) {
        repl.print('ScreenshotSaver: some `load\' event catched...');
        if (!ev.target.mIsBusy)
            ScreenshotSaver._dump_screenshot(fpath);
    };
    window.getBrowser().addEventListener("load", this.lambda, false);
};

ScreenshotSaver._uninstall_onload = function() {
    this.assert(this.lambda !== null);
    window.getBrowser().removeEventListener("load", this.lambda, false);
    this.lambda = null;
};

ScreenshotSaver._dump_screenshot = function(fpath) {
    this.assert(this.answer === 42);
    this.assert(this.lambda !== null);

    repl.print('ScreenshotSaver._dump_screenshot starts');
    /* Wanna deregister handler from itself? Here are some useless links:
     * http://code.activestate.com/recipes/576366/
     * http://en.wikipedia.org/wiki/Fixed_point_combinator
     * eval:"repl.print(arguments.callee)" */
    this._uninstall_onload();

    this._install_screengrab_mixin(fpath);
    Screengrab.grabCompleteDocument();
    this._uninstall_screengrab_mixin();

    repl.print('ScreenshotSaver._dump_screenshot exits');
};

ScreenshotSaver._install_screengrab_mixin = function(fpath) {
    this.assert(this.mixin === null && this.pure === null);

    this.mixin = function(defaultName) {
        var file = Components.classes["@mozilla.org/file/local;1"].
                        createInstance(Components.interfaces.nsILocalFile);
        file.initWithPath(fpath);
        return file;
    }

    this.pure = SGNsUtils.askUserForFile;
    SGNsUtils.askUserForFile = this.mixin;
};

ScreenshotSaver._uninstall_screengrab_mixin = function() {
    this.assert(SGNsUtils.askUserForFile === this.mixin);
    this.assert(this.mixin !== null && this.pure !== null);

    SGNsUtils.askUserForFile = this.pure;
    this.pure = null;
    this.mixin = null;
};


Скачать файл можно тут.

Загружается такое «расширение» на лету не менее тривиально:

$ firefox &
$ telnet localhost 4242 # 4242 — порт, на котором слушает mozrepl
repl> repl.load('file:///home/luser/ScreenshotSaver.js');
repl> ScreenshotSaver.save('http://habrahabr.ru', '/tmp/habr.png');
repl> ScreenshotSaver.save('http://linux.org.ru', '/tmp/lor.png');

После чего в /tmp появляется два соответствующих скриншота.

Как еще можно использовать mozrepl? Да как угодно — от автоматизированного тестирования веб-сайтов и «интерактивной консоли» при разработке плагинов для firefox до www-ботов, которые будут практически не отличимы от людей без проведения теста Тьюринга.

UPD: спасибо за карму, перенёс топик в «огненного лиса».

Из открытых вопросов остаются, например, обработка ошибок и скрывание вертикального scrollbar-а. При разрешении 1024x768 сделанный таким образом скриншот будет иметь ширину 1009px, т.е. будет уже на ширину полосы прокрутки — 15px.