まめ畑

ゆるゆると書いていきます

はてぶにブックマークを登録するJetpack Feature

Jetpack javascript

Jetpack ver0.6で追加されたAPIの1つにFirefoxのMenuを操作するAPIがあります。
これは、メニューバーやコンテキストメニューに追加が出来るというもので、FirefoxのUIを操作出来るAPIがまた1つ増えました。
プロパティなどはhttps://wiki.mozilla.org/Labs/Jetpack/JEP/14を参照して下さい(まだ実装されていない機能もあります)
既にJetpack GalleryにもMenu APIを使用したFeatureが登録されています。このAPIを使用するにはJetpack0.6以上が必要です(Jetpack Galleryからインストールする場合は自動的に最新版のJetpackのインストールが促されます)


Menu APIを使用して、簡単なFeatureを作ってみました。
インストールは: http://jetpackgallery.mozillalabs.com/jetpacks/135から
作ったものは、はてなブックマークに見ているページをブックマークするだけのFeatureです。
アカウントの設定などは「about:jetpack」のInstalled Featuresから「add2hateb」のsettingsから行えます。
このFeatureをインストールすると、ブックマークメニューとコンテキストメニューに以下の様なメニューが追加されます。


ブックマークしたいページで、このメニューを選択すると、コメントを入力するプロンプトが出るのでコメントを入力する事も出来ます。
試しに作ってみたので機能は今のところ追加のみですが、おいおい拡張していきたいと思います。


また、WSSE認証を使用するために、javascriptからWSSEを使う方法を検索していると、、、で公開されているbsd_wsse.jsを使用させて頂きました。(Feature内で使用可能にするために、259行目を window->jetpack.tabs.focused.contentWindow と変更しています)


触ってみた感じとして、Firefoxのメニュー(ファイルやブックマーク、ツールなど)が簡単に操作出来るようになり、作成するFeatureの種類も増えると思います。


コード

/*
   @author: con_mame
   @url: http://d.hatena.ne.jp/con_mame/
   @title: add2hateb
   @description: Add Bookmark to Hatena Bookmark
   @version: 0.1
*/

var manifest = {
  settings: [
    {
      name: "add2hateb",
      type: "group",
      label: "Hatena Account",
      settings: [
        { name: "hatenaId", type: "text", label: "Username" },
        { name: "hatenaPass", type: "password", label: "Password" }
      ]
    }
  ]
};

(function(){
    jetpack.future.import("menu");
    jetpack.future.import("storage.settings");

    const LABEL = "add2hateb";
    const HATEB_ICON = "http://b.hatena.ne.jp/favicon.ico";
    const HATEB_API_BASE = "http://b.hatena.ne.jp/";
    const ADD_API_URL = HATEB_API_BASE + "atom/post";
    const ADD_XML = "<entry xmlns=\"http://purl.org/atom/ns#\">"
                    +"<title>dummy</title>"
                    +"<link rel=\"related\" type=\"text/html\" href=\"##URL##\" />"
                    +"<summary type=\"text/plain\">##COMMENT##</summary>"
                    +"</entry>";

    function addHateb(url){
        var cWindow =  jetpack.tabs.focused.contentWindow;
        var sStorage = jetpack.storage.settings.add2hateb;

        if(!sStorage.hatenaId || !sStorage.hatenaPass){
            cWindow.alert("Set Your Hatena account.");
            return;
        }

        var comment = cWindow.prompt("Input Comment", " ");
        if(!comment) return;
        comment = (comment != " ") ? comment : "";

        var sendXML = ADD_XML.replace("##URL##", url).replace("##COMMENT##", comment);

        $.ajax({
            type: "POST",
            url: ADD_API_URL,
            processData: false,
            cache: false,
            beforeSend: function(xhr) {
                xhr.setRequestHeader("X-WSSE", wsseHeader(sStorage.hatenaId, sStorage.hatenaPass));
            },
            data: sendXML,
            dataType: "text",
            success: function(msg){
                jetpack.notifications.show({
                    title: "Added",
                    icon: HATEB_ICON,
                    body: "Success"
                });
            },
            error: function(xtr, status, thrown){
                if(xtr.readyState == 4 && xtr.status != 201){
                    jetpack.notifications.show({
                        title: "Error",
                        icon: HATEB_ICON,
                        body: status
                    });
                }
            }
        });
    }

    jetpack.menu.bookmarks.remove(LABEL);
    jetpack.menu.context.page.remove(LABEL);
    jetpack.menu.bookmarks.add();   //insert separator

    var config = {
            label: LABEL,
            mnemonic: "B",
            icon: HATEB_ICON,
            command: function(){
                var nowUrl = jetpack.tabs.focused.url;
                if(!/^about:.+$/.test(nowUrl)) addHateb(nowUrl);
            }
        };

    jetpack.menu.bookmarks.add(config);
    jetpack.menu.context.page.add(config);
})();

///////////////////////////////////////////////////////////
// Victor R. Ruizさん作成のwsse.jsからCreative Commonsライセンスと不明なライセンス由来のコードを抜いたコード
//
// Victor R. Ruizさんのページ↓
// http://rvr.typepad.com/wind/2005/07/wsse_for_javasc.html
// Victor R. Ruizさんのコメント↓
// I forgot to specify a license. I release my code under BSD, but please take care of other ones' licenses.
// Posted by: Victor R. Ruiz | August 25, 2005 at 03:31 PM
//
// ライセンスは、BSDライセンスのものだけです。
// Base64の処理にwindow.btoaを使っているので、Firefox(Gecko)専用になっています。
///////////////////////////////////////////////////////////
//
// wsse.js - Generate WSSE authentication header in JavaScript
// (C) 2005 Victor R. Ruiz <victor*sixapart.com> - http://rvr.typepad.com/
//
// Parts:
//   SHA-1 library (C) 2000-2002 Paul Johnston - BSD license
// 
// Example call:
//
//   var w = wsseHeader(Username, Password);
//   alert('X-WSSE: ' + w);
//
// Changelog:
//   2005.07.21 - Release 1.0
//

/*
 * A JavaScript implementation of the Secure Hash Algorithm, SHA-1, as defined
 * in FIPS PUB 180-1
 * Version 2.1a Copyright Paul Johnston 2000 - 2002.
 * Other contributors: Greg Holt, Andrew Kepert, Ydnar, Lostinet
 * Distributed under the BSD License
 * See http://pajhome.org.uk/crypt/md5 for details.
 */

/*
 * Configurable variables. You may need to tweak these to be compatible with
 * the server-side, but the defaults work in most cases.
 */
var hexcase = 0;  /* hex output format. 0 - lowercase; 1 - uppercase        */
var b64pad  = "="; /* base-64 pad character. "=" for strict RFC compliance   */
var chrsz   = 8;  /* bits per input character. 8 - ASCII; 16 - Unicode      */

/*
 * These are the functions you'll usually want to call
 * They take string arguments and return either hex or base-64 encoded strings
 */
function hex_sha1(s){return binb2hex(core_sha1(str2binb(s),s.length * chrsz));}
function b64_sha1(s){return binb2b64(core_sha1(str2binb(s),s.length * chrsz));}
function str_sha1(s){return binb2str(core_sha1(str2binb(s),s.length * chrsz));}
function hex_hmac_sha1(key, data){ return binb2hex(core_hmac_sha1(key, data));}
function b64_hmac_sha1(key, data){ return binb2b64(core_hmac_sha1(key, data));}
function str_hmac_sha1(key, data){ return binb2str(core_hmac_sha1(key, data));}

/*
 * Perform a simple self-test to see if the VM is working
 */
function sha1_vm_test()
{
  return hex_sha1("abc") == "a9993e364706816aba3e25717850c26c9cd0d89d";
}

/*
 * Calculate the SHA-1 of an array of big-endian words, and a bit length
 */
function core_sha1(x, len)
{
  /* append padding */
  x[len >> 5] |= 0x80 << (24 - len % 32);
  x[((len + 64 >> 9) << 4) + 15] = len;

  var w = Array(80);
  var a =  1732584193;
  var b = -271733879;
  var c = -1732584194;
  var d =  271733878;
  var e = -1009589776;

  for(var i = 0; i < x.length; i += 16)
  {
    var olda = a;
    var oldb = b;
    var oldc = c;
    var oldd = d;
    var olde = e;

    for(var j = 0; j < 80; j++)
    {
      if(j < 16) w[j] = x[i + j];
      else w[j] = rol(w[j-3] ^ w[j-8] ^ w[j-14] ^ w[j-16], 1);
      var t = safe_add(safe_add(rol(a, 5), sha1_ft(j, b, c, d)),
                       safe_add(safe_add(e, w[j]), sha1_kt(j)));
      e = d;
      d = c;
      c = rol(b, 30);
      b = a;
      a = t;
    }

    a = safe_add(a, olda);
    b = safe_add(b, oldb);
    c = safe_add(c, oldc);
    d = safe_add(d, oldd);
    e = safe_add(e, olde);
  }
  return Array(a, b, c, d, e);

}

/*
 * Perform the appropriate triplet combination function for the current
 * iteration
 */
function sha1_ft(t, b, c, d)
{
  if(t < 20) return (b & c) | ((~b) & d);
  if(t < 40) return b ^ c ^ d;
  if(t < 60) return (b & c) | (b & d) | (c & d);
  return b ^ c ^ d;
}

/*
 * Determine the appropriate additive constant for the current iteration
 */
function sha1_kt(t)
{
  return (t < 20) ?  1518500249 : (t < 40) ?  1859775393 :
         (t < 60) ? -1894007588 : -899497514;
}

/*
 * Calculate the HMAC-SHA1 of a key and some data
 */
function core_hmac_sha1(key, data)
{
  var bkey = str2binb(key);
  if(bkey.length > 16) bkey = core_sha1(bkey, key.length * chrsz);

  var ipad = Array(16), opad = Array(16);
  for(var i = 0; i < 16; i++)
  {
    ipad[i] = bkey[i] ^ 0x36363636;
    opad[i] = bkey[i] ^ 0x5C5C5C5C;
  }

  var hash = core_sha1(ipad.concat(str2binb(data)), 512 + data.length * chrsz);
  return core_sha1(opad.concat(hash), 512 + 160);
}

/*
 * Add integers, wrapping at 2^32. This uses 16-bit operations internally
 * to work around bugs in some JS interpreters.
 */
function safe_add(x, y)
{
  var lsw = (x & 0xFFFF) + (y & 0xFFFF);
  var msw = (x >> 16) + (y >> 16) + (lsw >> 16);
  return (msw << 16) | (lsw & 0xFFFF);
}

/*
 * Bitwise rotate a 32-bit number to the left.
 */
function rol(num, cnt)
{
  return (num << cnt) | (num >>> (32 - cnt));
}

/*
 * Convert an 8-bit or 16-bit string to an array of big-endian words
 * In 8-bit function, characters >255 have their hi-byte silently ignored.
 */
function str2binb(str)
{
  var bin = Array();
  var mask = (1 << chrsz) - 1;
  for(var i = 0; i < str.length * chrsz; i += chrsz)
    bin[i>>5] |= (str.charCodeAt(i / chrsz) & mask) << (32 - chrsz - i%32);
  return bin;
}

/*
 * Convert an array of big-endian words to a string
 */
function binb2str(bin)
{
  var str = "";
  var mask = (1 << chrsz) - 1;
  for(var i = 0; i < bin.length * 32; i += chrsz)
    str += String.fromCharCode((bin[i>>5] >>> (32 - chrsz - i%32)) & mask);
  return str;
}

/*
 * Convert an array of big-endian words to a hex string.
 */
function binb2hex(binarray)
{
  var hex_tab = hexcase ? "0123456789ABCDEF" : "0123456789abcdef";
  var str = "";
  for(var i = 0; i < binarray.length * 4; i++)
  {
    str += hex_tab.charAt((binarray[i>>2] >> ((3 - i%4)*8+4)) & 0xF) +
           hex_tab.charAt((binarray[i>>2] >> ((3 - i%4)*8  )) & 0xF);
  }
  return str;
}

/*
 * Convert an array of big-endian words to a base-64 string
 */
function binb2b64(binarray)
{
  var tab = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  var str = "";
  for(var i = 0; i < binarray.length * 4; i += 3)
  {
    var triplet = (((binarray[i   >> 2] >> 8 * (3 -  i   %4)) & 0xFF) << 16)
                | (((binarray[i+1 >> 2] >> 8 * (3 - (i+1)%4)) & 0xFF) << 8 )
                |  ((binarray[i+2 >> 2] >> 8 * (3 - (i+2)%4)) & 0xFF);
    for(var j = 0; j < 4; j++)
    {
      if(i * 8 + j * 6 > binarray.length * 32) str += b64pad;
      else str += tab.charAt((triplet >> 6*(3-j)) & 0x3F);
    }
  }
  return str;
}

/* Added by stts. http://d.hatena.ne.jp/stts/ */
function utcdatetime() {
                var d = new Date();
                return d.getUTCFullYear() +"-"+ d.getUTCMonth() +"-"+ d.getUTCDate()
                                +"T"+ d.getUTCHours() +"-"+ d.getUTCMinutes() +"-"+ d.getUTCSeconds() +"Z";
}

// (C) 2005 Victor R. Ruiz <victor*sixapart.com>
// Code to generate WSSE authentication header
//
// http://www.sixapart.com/pronet/docs/typepad_atom_api
//
// X-WSSE: UsernameToken Username="name", PasswordDigest="digest", Created="timestamp", Nonce="nonce"
//
//  * Username- The username that the user enters (the TypePad username).
//  * Nonce. A secure token generated anew for each HTTP request.
//  * Created. The ISO-8601 timestamp marking when Nonce was created.
//  * PasswordDigest. A SHA-1 digest of the Nonce, Created timestamp, and the password
//    that the user supplies, base64-encoded. In other words, this should be calculated
//    as: base64(sha1(Nonce . Created . Password))
//

function wsse(Password) {
    var PasswordDigest, Nonce, Created;
    var r = new Array;
    
    Nonce = b64_sha1(utcdatetime() + 'There is more than words');
    nonceEncoded = jetpack.tabs.focused.contentWindow.btoa(Nonce);  //Changed by con_mame. For using Jetpack Feature.
    Created = utcdatetime();
    PasswordDigest = b64_sha1(Nonce + Created + Password);

    r[0] = nonceEncoded;
    r[1] = Created;
    r[2] = PasswordDigest;
    return r;
}

function wsseHeader(Username, Password) {
    var w = wsse(Password);
    var header = 'UsernameToken Username="' + Username + '", PasswordDigest="' + w[2] + '", Created="' + w[1] + '", Nonce="' + w[0] + '"';
    return header;
}