らいふうっどの閑話休題

興味のあることをゆる~く書いていく

新訳:ADB Helperをハックしてみた(scanner.js)

この記事は『Firefox OS / B2G OS Advent Calendar 2016』 18日目の記事です。
Firefox OS で、使用されている「ADB Helper」を再度まとめ直してみました。

目次

 

前回、新訳:ADB Helperをハックしてみた(bootstrap.js)に引き続き、 adb-helperをハックしていきたいと思います

  1. フォルダ内のファイル構成
  2. scanner.js
  3. 予備知識
  4. モジュール構成
  5. 今回のまとめ
  6. 関連記事
  7. 今年のAdvent Calendar
フォルダ内のファイル構成
  [ 解凍フォルダ内のjsファイル群 ]
install.rdf
main.js
adb.js
adb-client.js
adb-running-checker.js
adb-socket.js
bootstrap.js
scanner.js
device.js
※1
※1
※1
devtools-import.js
※1
※1
※1
devtools-require.js
※1
※1
※1
fastboot.js
※1
※1
※1
subprocess.js
※2
※2
※2
subprocess_worker_win.js
※3
※3
※3
subprocess_worker_unix.js
※4
※4
※4
  ※1 : version 0.7.1 時点では無かったファイル
※2 : version 0.7.1 時点で有ったファイル
※3 : version 0.7.1 時点で有ったファイル、Windows用ファイル
※4 : version 0.7.1 時点で有ったファイル、maclinux用ファイル

OS毎に使用されるファイルが有る事が確認できます。


scanner.js
  前回に引き続き、scanner.js ファイルをハックしていきたいと思います。   ご覧の通り、各OSでの差異はありません。 2014.11.06 時点から、かなりバージョンアップしているのが分かります。 モジュールは下図の通りです



モジュール構成
  上記予備知識をもとにハックしていきます!
ファイル位置
処理概要
1 ~ 22 行目
  • Cu にchrome ライブラリ読み込み
  • EventEmitter に event-emitter 読み込み
  • Task に Task.jsm 読み込み
  • unload 時、system/unload 読み込み
  • ConnectionManager に connection-manager 読み込み
  • Devices に Devices.jsm 読み込み
  • Runtimes に WebIDE の runtime モジュール読み込み
  • 変数:promise を定義
  • 変数:promise に Promise オブジェクトを代入
23 ~ 82 行目
Scanner オブジェクト
  • enable() 関数
  • disable() 関数
  • _emitUpdated() 関数
  • _updateRuntimes() 関数
  • _detectRuntimes() 関数
  • scan() 関数
  • listRuntimes() 関数
84 ~ 90 行目
  • Scanner オブジェクト を decorate 関数に渡します
  • Runtime() オブジェクト
  • FirefoxOSRuntime オブジェクト
  • FirefoxOnAndroidRuntime() オブジェクト
  Scanner オブジェクトが、かなりのボリュームなので、下表にまとめました。
関数名
処理概要
enable() 関数
  • _updateRuntimes オブジェクトに bind します。
  • _updateRuntimes オブジェクト、引数:register で、
    Devices.on() 関数実行します。
  • _updateRuntimes オブジェクト、引数:unregister で、
    Devices.on() 関数実行します。
  • _updateRuntimes オブジェクト、引数:addon-status-updated で、
    Devices.on() 関数実行します。
  • _updateRuntimes()関数を実行します。
disable() 関数
  • _updateRuntimes オブジェクトに bind します。
  • _updateRuntimes オブジェクト、引数:register で、
    Devices.off() 関数実行します。
  • _updateRuntimes オブジェクト、引数:unregister で、
    Devices.off() 関数実行します。
  • _updateRuntimes オブジェクト、引数:addon-status-updated で、
    Devices.off() 関数実行します。
_emitUpdated() 関数
  • 引数:runtime-list-updated で、emit() 関数実行します。
_updateRuntimes() 関数
  • _updatingPromise オブジェクトが存在する時は、
    其のオブジェクトを返します
  • 変数:device に取得したデバイス情報をセットします。
  • 配列変数:promises に _detectRuntimes(device) の
    結果を push します。
  • _updatingPromise オブジェクトに promise.all(promises) の
    結果を push します。
  • _updatingPromise オブジェクトの then() 関数で、
    _emitUpdated()関数を実行します
  • _updatingPromise オブジェクトを初期化します。
_detectRuntimes() 関数
  • 変数:model にデバイス情報を取得します。
  • 変数:detectedRuntimes に FirefoxOSRuntime.detect
    オブジェクトを委任します。
  • _runtimes オブジェクトに detectedRuntimes を push します。
  • 変数:detectedRuntimes に FirefoxOnAndroidRuntime.detect
    オブジェクトを委任します。
  • _runtimes オブジェクトに detectedRuntimes を push します。
scan() 関数
  • _updateRuntimes オブジェクトを返します。
listRuntimes() 関数
  • _runtimesオブジェクトを返します。
  Runtime オブジェクトを下表にまとめました。
関数名
処理概要
Runtime() 関数
  • 引数:device をプロパティにセットします。
  • 引数:model をプロパティにセットします。
  • 引数:socketPath をプロパティにセットします。
connect() 関数
  • 変数:port に空いている TCP ポート情報を取得します。
  • 変数;local を定義します。
  • 変数:remote にソケットのパス情報をセットします。
  • device オブジェクトの forwardPort()関数を実行し、
    バイスの接続情報をセットします
id プロパティ
  • バイス ID とソケットパスを連結して返します。
  FirefoxOSRuntime オブジェクトを下表にまとめました。
関数名
処理概要
FirefoxOSRuntime() 関数
  • 引数を用いて、Runtime.call()関数を実行します。
FirefoxOSRuntime.detect
オブジェクト
  • Task.async()関数 実行し、同期が取れた結果格納します。
  • 引数に以下の無名関数を実行します。
    • 配列変数:runtimes を定義します。
    • クエリー実行用変数:query を定義します
    • 変数:b2gExists にクエリーの実行結果を取得します。
    • クエリーの実行結果をチェックします。
    • b2gExists === "0\r\n" の場合、以下の処理を実行します。
    • 新しいインスタンスで、FirefoxOSRuntime()を実行します。
    • 配列変数:runtimes 実行結果を push します。
  • 配列変数:runtimes を返します。
FirefoxOSRuntime.prototype
オブジェクト
  • FirefoxOSRuntime.prototype を渡して実行します
  FirefoxOnAndroidRuntime オブジェクトを下表にまとめました。
関数名
処理概要
FirefoxOnAndroidRuntime() 関数
  • 引数を用いて、Runtime.call()関数を実行します。
FirefoxOnAndroidRuntime.detect
オブジェクト
  • Task.async()関数 実行し、同期が取れた結果格納します。
  • 引数に以下の無名関数を実行します。
    • 配列変数:runtimes を定義します。
    • クエリー実行用変数:query を定義します
    • 変数:rawSocketInfo にクエリーの実行結果を取得します。
    • 変数:rawSocketInfo を用いて、変数:socketInfos にソケット情報を格納します。
    • 変数:socketInfos にフィルターを実行します。
    • 変数:socketPaths にソケット情報を追加していきます。
    • 変数:socketPaths 分 FirefoxOnAndroidRuntime()関数を実行します。
    • 配列変数:runtimes に実行結果を push します。
  • 配列変数:runtimes を返します。
FirefoxOnAndroidRuntime.prototype
オブジェクト
  • FirefoxOnAndroidRuntime.prototype を渡して実行します


今回のまとめ
  今回は、デバイスをスキャン,検出した時のモジュールをハックしました。 次回は、device.js をハックする予定です。


関連記事


今年のAdvent Calendar


去年のAdvent Calendar

新訳:ADB Helperをハックしてみた(bootstrap.js)

この記事は『Firefox OS / B2G OS Advent Calendar 2016』 17日目の記事です。
Firefox OS で、使用されている「ADB Helper」を再度まとめ直してみました。

目次

 

前回、新訳:ADB Helperをハックしてみた(adb-socket.js)に引き続き、 adb-helperをハックしていきたいと思います

  1. フォルダ内のファイル構成
  2. bootstrap.js
  3. 予備知識
  4. モジュール構成
  5. 今回のまとめ
  6. 関連記事
  7. 今年のAdvent Calendar
フォルダ内のファイル構成
  [ 解凍フォルダ内のjsファイル群 ]
install.rdf
main.js
adb.js
adb-client.js
adb-running-checker.js
adb-socket.js
bootstrap.js
scanner.js
device.js
※1
※1
※1
devtools-import.js
※1
※1
※1
devtools-require.js
※1
※1
※1
fastboot.js
※1
※1
※1
subprocess.js
※2
※2
※2
subprocess_worker_win.js
※3
※3
※3
subprocess_worker_unix.js
※4
※4
※4
  ※1 : version 0.7.1 時点では無かったファイル
※2 : version 0.7.1 時点で有ったファイル
※3 : version 0.7.1 時点で有ったファイル、Windows用ファイル
※4 : version 0.7.1 時点で有ったファイル、maclinux用ファイル

OS毎に使用されるファイルが有る事が確認できます。


bootstrap.js
  前回に引き続き、bootstrap.js ファイルをハックしていきたいと思います。   ご覧の通り、各OSでの差異はありません。

2014.11.06 時点から、かなりバージョンアップしているのが分かります。

モジュールは下図の通りです


予備知識
  ブートストラップ型拡張機能 - 拡張機能 | MDN
https://developer.mozilla.org/ja/docs/Extensions/Bootstrapped_extensions
bootstrap.js
http://mdn.beonex.com/en/Extensions/bootstrap.js.html
Components.interfaces
概要:プロパティがそれらの名前によって索引付けされたクラスである、読み出し専用オブジェクトです。
https://developer.mozilla.org/ja/docs/Components.interfaces
Components.utils
概要:便利でありながらも必須というわけではない、さまざまな XPConnect の機能のまとまりです。
そのインタフェースは js/src/xpconnect/idl/xpccomponents.idl で定義されています。
https://developer.mozilla.org/ja/docs/Components.utils
Preferences 概要:Mozilla 設定システムを利用しようとする拡張機能開発者向けのサンプルを示しています。
https://developer.mozilla.org/ja/docs/Code_snippets/Preferences


モジュール構成
  上記予備知識をもとにハックしていきます!
ファイル位置
処理概要
1 ~ 8 行目
  • Ci に Components.interfaces ライブラリ読み込み
  • Cu に Components.utils ライブラリ読み込み
  • Cu に Services.jsm をインポート
  • 定数:REASON を定義
    ['unknown', 'startup', 'shutdown', 'enable', 'disable', 'install', 'uninstall', 'upgrade', 'downgrade']
9 ~ 23 行目
registerAddonResourceHandler() 関数
  • 変数:file にパスを格納します。
  • 変数:fileuri file.isDirectory() を用いて、
    uri 情報を取得します。
  • encodeURIComponent() 関数を用いて、
    リソース名を格納します。
  • getProtocolHandler() 関数を用いて、
    リソース名をセットします。
  • リソース情報を返します。
9 ~ 23 行目
  • 変数:mainModule 定義
  • 変数:loader 定義
  • 変数:unload 定義
  • install() 関数
31 ~ 110 行目
startup オブジェクト
  • 変数:loaderModule を定義
  • 変数:unload を定義
  • 変数:loaderOptions を定義
  • 定数:LOGPREF を定義
  • 定数:LOGPREFIX を定義
  • canLog() 関数
  • 変数:ConsoleAPI を定義
  • 変数:consolePaths を定義
  • ConsoleAPI()インスタンス:_console を定義
  • 変数:loaderOptions.globals を定義
    • log() 関数を定義します。
    • warn() 関数を定義します。
    • error() 関数を定義します。
    • exception() 関数を定義します。
    • debug() 関数を定義します。
  • Loader() 関数に上記 loaderOptions を代入し、
    モジュールをロードします。
  • Require() 関数に引数:loader, { id: "./addon" } を
    代入し、変数:require_ を定義します。
  • 変数:mainModule にrequire_ を代入します。
112 ~ 121 行目
shutdown 関数
  • 引数:reasonCode を用いて、変数:reason に代入します。
  • 変数:loader = true の場合、unload() 関数を実行します。
  • mainModule = true かつ mainModule.shutdown = true の時
    mainModule.shutdown() 関数を実行します。
122 行目以降
  • uninstall() 関数


今回のまとめ
  今回のモジュールは、 アドオンのブート時の挙動をハックしました。 次回は、scanner.js をハックする予定です。


関連記事


今年のAdvent Calendar


去年のAdvent Calendar

新訳:ADB Helperをハックしてみた(adb-socket.js)

この記事は『Firefox OS / B2G OS Advent Calendar 2016』 16日目の記事です。
Firefox OS で、使用されている「ADB Helper」を再度まとめ直してみました。

目次

 

前回、新訳:ADB Helperをハックしてみた(adb-running-checker.js)に引き続き、 adb-helperをハックしていきたいと思います

  1. フォルダ内のファイル構成
  2. adb-socket.js
  3. 予備知識
  4. モジュール構成
  5. 今回のまとめ
  6. 関連記事
  7. 今年のAdvent Calendar
フォルダ内のファイル構成
  [ 解凍フォルダ内のjsファイル群 ]
install.rdf
main.js
adb.js
adb-client.js
adb-running-checker.js
adb-socket.js
bootstrap.js
scanner.js
device.js
※1
※1
※1
devtools-import.js
※1
※1
※1
devtools-require.js
※1
※1
※1
fastboot.js
※1
※1
※1
subprocess.js
※2
※2
※2
subprocess_worker_win.js
※3
※3
※3
subprocess_worker_unix.js
※4
※4
※4
  ※1 : version 0.7.1 時点では無かったファイル
※2 : version 0.7.1 時点で有ったファイル
※3 : version 0.7.1 時点で有ったファイル、Windows用ファイル
※4 : version 0.7.1 時点で有ったファイル、maclinux用ファイル

OS毎に使用されるファイルが有る事が確認できます。


adb-socket.js
  前回に引き続き、bootstrap.js ファイルをハックしていきたいと思います。
  ご覧の通り、各OSでの差異はありません。
2014.11.06 時点から、かなりバージョンアップしているのが分かります。 モジュールは下図の通りです


予備知識
  サンドボックス (セキュリティ)
http://is.gd/P7iDNm

JavaScript コードモジュールの利用(jsm)
JavaScript コードモジュールは、Gecko 1.9 で導入されたコンセプトであり、
特権を持った異なるスコープ間でコードを共有するために用いられます。
また、モジュールは、グローバルな JavaScript のシングルトンオブジェクトを
生成するために用いることもできます(以前は JavaScript XPCOM オブジェクトを使う必要がありました)。
JavaScript コードモジュールは、登録されたパスに配置された純粋な JavaScript のコードです。
Components.utils.import() を使って、 XUL スクリプトJavaScript XPCOM スクリプトのような
特定のJavaScript のスコープへモジュールを読み込むことができます。
https://developer.mozilla.org/ja/docs/Mozilla/JavaScript_code_modules/Using


モジュール構成
  上記予備知識をもとにハックしていきます!
ファイル位置
処理概要
1 ~ 13 行目
  • コメント
    ADB が実行中の場合、使用しているホストバージョン検出するサービス
    オリジナルの ADB の adb-file-transfer をモディファイ
  • Cu, Cc, Ci にchrome ライブラリ読み込み
  • Class にcore/heritage ライブラリ読み込み
  • Cu にServices.jsm をインポート
14 ~ 29 行目
createTCPSocket() 関数
  • TCPSocket にServices.jsm をインポート
  • TCPSocket = true 時に引数:location, port, options を用いて、TCPSocket を返します。
  • 変数:scope に nsIPushService の getSystemPrincipal() を用いて、代入します。
  • scope.DOMError にServices.jsm を用いて、格納します。
31 行目以降
AdbSocket オブジェクト
  • コメント
    adb インスタンスへ接続するソケットを生成します。
    このインスタンスは同期し、接続成功時に通知を返します。
    Callers は、S フィールドに attach させなければならない。
  • initialize() 関数
  • _hexdump() 関数
  • send() 関数
  • close() 関数
  AdbSocket オブジェクト をハックしていきます。
関数名
処理概要
initialize() 関数
  • アドレス:"127.0.0.1", ポート;5037 を用いて
    関数:createTCPSocket を実行します。
_hexdump() 関数
  • コメント
    受信したバイトデータをコンソールへダンプします。
  • 文字コードwindows-1252 で、TextDecoder 型で定義します。
  • 配列変数:array を Uint8Array 型で定義します。
  • 配列変数:array をデコードします。
  • 配列数分格納します。
  • コンソール出力します。
send() 関数
  • _hexdump() 関数を呼び出します。
  • データ送信します。
close() 関数
  • ソケット状態が "open" 又は "connecting" の場合、
    close() 関数を呼び出します。


今回のまとめ
  今回のモジュールは、 adb のソケットの挙動をハックしました。 次回は、bootstrap.js をハックする予定です。


関連記事


今年のAdvent Calendar


去年のAdvent Calendar

新訳:ADB Helperをハックしてみた(adb-running-checker.js)

この記事は『Firefox OS / B2G OS Advent Calendar 2016』 15日目の記事です。
Firefox OS で、使用されている「ADB Helper」を再度まとめ直してみました。

目次

 

前回、新訳:ADB Helperをハックしてみた(adb-client.js)に引き続き、 adb-helperをハックしていきたいと思います

  1. フォルダ内のファイル構成
  2. adb-running-checker.js
  3. 予備知識
  4. モジュール構成
  5. 今回のまとめ
  6. 関連記事
  7. 今年のAdvent Calendar
フォルダ内のファイル構成
  [ 解凍フォルダ内のjsファイル群 ]
install.rdf
main.js
adb.js
adb-client.js
adb-running-checker.js
adb-socket.js
bootstrap.js
scanner.js
device.js
※1
※1
※1
devtools-import.js
※1
※1
※1
devtools-require.js
※1
※1
※1
fastboot.js
※1
※1
※1
subprocess.js
※2
※2
※2
subprocess_worker_win.js
※3
※3
※3
subprocess_worker_unix.js
※4
※4
※4
  ※1 : version 0.7.1 時点では無かったファイル
※2 : version 0.7.1 時点で有ったファイル
※3 : version 0.7.1 時点で有ったファイル、Windows用ファイル
※4 : version 0.7.1 時点で有ったファイル、maclinux用ファイル

OS毎に使用されるファイルが有る事が確認できます。


adb-running-checker.js
  前回に引き続き、adb.jsファイルからハックしていきたいと思います。   ご覧の通り、各OSでの差異はありません。 2014.11.06 時点から、かなりバージョンアップしているのが分かります。 モジュールは下図の通りです



モジュール構成
  上記予備知識をもとにハックしていきます!
ファイル位置
処理概要
1 ~ 37 行目
  • コメント
    ADB が実行中の場合、使用しているホストバージョン検出するサービス
    オリジナルの ADB の adb-file-transfer をモディファイ
  • Cu, Cc, Ci にchrome ライブラリ読み込み
  • 変数 promise に Promise.jsm を代入
  • client を用いて、adb-client.js を読み込み
18 行目以降
check オブジェクト
  • Deferred オブジェクト deferred を promise.defer() 用いて生成
  • runFSM() 関数
  • setupSocket() 関数
 
関数名
処理概要
runFSM() 関数
  • 変数:state を判定し、状態毎の処理を実行します。
setupSocket() 関数
  • 関数 socket.s.onerror を定義し、引数:"running checker onerror" で、deferred.reject() を実行します。
  • 関数 socket.s.onopen を定義し、関数runFSM() を実行します。
  • 関数 socket.s.onclose を定義します。
  • 関数 socket.s.ondata を定義し、関数runFSM() を実行します。


今回のまとめ
  今回のモジュールは、 adb 実行時におけるチェック処理でした。 次回は、adb-socket.js をハックする予定です。


関連記事


今年のAdvent Calendar


去年のAdvent Calendar

新訳:ADB Helperをハックしてみた(adb-client.js)

この記事は『Firefox OS / B2G OS Advent Calendar 2016』 13日目の記事です。
Firefox OS で、使用されている「ADB Helper」を再度まとめ直してみました。

目次

 

前回、新訳:ADB Helperをハックしてみた(adb.js)に引き続き、 adb-helperをハックしていきたいと思います

  1. フォルダ内のファイル構成
  2. adb-client.js
  3. 予備知識
  4. モジュール構成
  5. 今回のまとめ
  6. 関連記事
  7. 今年のAdvent Calendar
フォルダ内のファイル構成
  [ 解凍フォルダ内のjsファイル群 ]
install.rdf
main.js
adb.js
adb-client.js
adb-running-checker.js
adb-socket.js
bootstrap.js
scanner.js
device.js
※1
※1
※1
devtools-import.js
※1
※1
※1
devtools-require.js
※1
※1
※1
fastboot.js
※1
※1
※1
subprocess.js
※2
※2
※2
subprocess_worker_win.js
※3
※3
※3
subprocess_worker_unix.js
※4
※4
※4
  ※1 : version 0.7.1 時点では無かったファイル
※2 : version 0.7.1 時点で有ったファイル
※3 : version 0.7.1 時点で有ったファイル、Windows用ファイル
※4 : version 0.7.1 時点で有ったファイル、maclinux用ファイル

OS毎に使用されるファイルが有る事が確認できます。


adb-client.js
  前回に引き続き、adb-client.js ファイルからハックしていきたいと思います。   ご覧の通り、各OSでの差異はありません。 2014.11.06 時点から、かなりバージョンアップしているのが分かります。 モジュールは下図の通りです



モジュール構成
  上記予備知識をもとにハックしていきます!
関数名
処理概要
getBuffer() 関数
  • コメント
    buffer を返します。Gecko バージョンの差異がある時
  • buffer を返します。
unpackPacket() 関数
  • 関数:getBuffer() を用いて、変数:buffer を定義します。
  • buffer = 4バイトかつ aIgnoreResponse = falseの時、
    JSON データ { length: 0, data: "" } を返します。
  • 上記以外の時、以降の処理を実行します。
  • 変数:lengthView を Uint8Array で定義します。
  • 変数:decoder を TextDecoder で定義します。
  • 変数:length に decoder を parseInt して取得します。
  • 変数:text に buffer, length を用いて、Uint8Array で定義します。
  • JSON データ { length: length, data: decoder.decode(text) }; を返します。
checkResponse() 関数
  • コメント
    レスポンスをチェックします。デフォルトは、定数:OKAY
  • 関数:getBuffer() を用いて、変数:buffer を定義します。
  • 配列変数:view を buffer を用いて初期化、 Uint32Array で定義します。
  • 配列変数:view[0] = 定数:FAIL の場合、ログ出力します。
  • 配列変数:view[0] に 定数:OKAY をセットし、返します。
createRequest() 関数
  • 関数:getBuffer() を用いて、変数:buffer を定義します。
  • 引数:aCommand を 大文字変換し、変数:length へ格納します。
  • 変数:length の長さが 4 バイトになるまで、0 を付加します。
  • 変数:encoder を TextEncoder で定義します。
  • 変数:length に 引数:aCommand 付加します。
  • 上記変数をエンコードしたものを返します。
close() 関数
  • ソケットを close します。
client オブジェクト定義
  • getBuffer 関数定義
  • unpackPacket 関数定義
  • checkResponse 関数定義
  • createRequest 関数定義
  • connect 関数定義
  • close 関数定義


今回のまとめ
  adb のクライアント側を制御する為のモジュールをハックしました。
上記モジュールが adb.js などで、exports されて使用できるようになります。
次回は、adb-running-checker.js をハックする予定です。


関連記事


今年のAdvent Calendar


去年のAdvent Calendar

新訳:ADB Helperをハックしてみた(adb.js)

この記事は『Firefox OS / B2G OS Advent Calendar 2016』 12日目の記事です。
Firefox OS で、使用されている「ADB Helper」を再度まとめ直してみました。

目次

 

前回、新訳:ADB Helperをハックしてみた(install.rdf,main.js)に引き続き、 adb-helperをハックしていきたいと思います

  1. フォルダ内のファイル構成
  2. adb.js
  3. 予備知識
  4. モジュール構成
  5. 今回のまとめ
  6. 関連記事
  7. 今年のAdvent Calendar
フォルダ内のファイル構成
  [ 解凍フォルダ内のjsファイル群 ]
install.rdf
main.js
adb.js
adb-client.js
adb-running-checker.js
adb-socket.js
bootstrap.js
scanner.js
device.js
※1
※1
※1
devtools-import.js
※1
※1
※1
devtools-require.js
※1
※1
※1
fastboot.js
※1
※1
※1
subprocess.js
※2
※2
※2
subprocess_worker_win.js
※3
※3
※3
subprocess_worker_unix.js
※4
※4
※4
  ※1 : version 0.7.1 時点では無かったファイル
※2 : version 0.7.1 時点で有ったファイル
※3 : version 0.7.1 時点で有ったファイル、Windows用ファイル
※4 : version 0.7.1 時点で有ったファイル、maclinux用ファイル

OS毎に使用されるファイルが有る事が確認できます。


adb.js
  前回に引き続き、adb.jsファイルからハックしていきたいと思います。   ご覧の通り、各OSでの差異はありません。 2014.11.06 時点から、かなりバージョンアップしているのが分かります。 モジュールは結構ありますね・・・・(^^;;;


予備知識
  1. Strict モード(use strict)

    ECMAScript 5 の strict モードは、JavaScript の制限された異形にオプトインする方法です。 strict モードは単なるサブセットではありません: strict モードは意図的に、通常モードとは異なる意味を持っています。 strict モードをサポートしないブラウザは、strict モードのコードについて サポートするブラウザとは異なる動作をする可能性がありますので、 strict モードに関する側面をサポートするかの機能テストを行わずに strict モードを頼らないでください。 strict モードのコードと非 strict モードのコードは共存できますので、 スクリプトを順次 strict モードにオプトインすることができます。 https://developer.mozilla.org/ja/docs/Web/JavaScript/Strict_mode

  2. let 文

    let 文は変数に対するローカルスコープを提供します。 let 文はコードのある 1 つのブロックのレキシカルスコープに 0 以上の変数を 結びつけることによって働き、それ以外はブロック文と全く同じです。 特に、let 文の内側で var を使って定義された変数のスコープは、 let 文の外側でそれが定義された場合と同じであり、 そのような変数は従来通り関数スコープを持つことに注意してください。 https://developer.mozilla.org/ja/docs/Web/JavaScript/New_in_JavaScript/1.7#let_.E6.96.87

  3. module

    module 現在のモジュールへの参照です。 特に module.exports は exports オブジェクトと同じです。 より詳しくは src/node.js を参照してください。 module は実際はグローバルではなく、各モジュール毎のローカルです。 http://d.hatena.ne.jp/jovi0608/20111226/1324879536

  4. JavaScript コードモジュールの利用(jsm)

    JavaScript コードモジュールは、Gecko 1.9 で導入されたコンセプトであり、 特権を持った異なるスコープ間でコードを共有するために用いられます。 また、モジュールは、グローバルな JavaScript のシングルトンオブジェクトを 生成するために用いることもできます (以前は JavaScript XPCOM オブジェクトを使う必要がありました)。 JavaScript コードモジュールは、登録されたパスに配置された純粋な JavaScript のコードです。 Components.utils.import() を使って、 XUL スクリプトJavaScript XPCOM スクリプトのような 特定のJavaScript のスコープへモジュールを読み込むことができます。 https://developer.mozilla.org/ja/docs/Mozilla/JavaScript_code_modules/Using

  5. subprocess

    subprocess subprocess.jsm - start a process in your Firefox Extension and read/write data to/from it using stdin/stdout/stderr streams. https://github.com/bit/subprocess


モジュール構成
  上記予備知識をもとにハックしていきます!
ファイル位置
処理概要
1 ~ 37 行目
  • Cc, Ci, Cu, Cr にchrome ライブラリ読み込み
  • subprocess にライブラリ読み込み
  • file にライブラリ読み込み
  • env にライブラリ読み込み
  • XPCOMABI にライブラリ読み込み
  • setTimeout にライブラリ読み込み
  • client を用いて、adb-client.js を読み込み
  • Cu, TextEncoder, TextDecoder に Services.jsm をインポート
  • 変数 promise に Promise.jsm を代入
  • Cu に OS.File for the main thread をインポート
50 行目以降
ADB オブジェクト
  • didRunInitially() プロパティ
  • ready() プロパティ
  • adb_init() 関数
  • adb_start() 関数
  • stop() 関数
  • adb_kill() 関数
  • _isAdbRunning() 関数
  • adb_trackDevices() 関数
  • adb_listDevices() 関数
  • adb_forwardPort() 関数
  • adb_checkFileMode() 関数
  • adb_pull() 関数
  • adb_push() 関数
  • adb_shell() 関数
  • adb_reboot() 関数
  • adb_rebootRecovery() 関数
  • rebootBootloader() 関数
  • adb_root() 関数
  • adb_runCommand() 関数
  ADB オブジェクトが、かなりのボリュームなので、下表にまとめました。
関数名
処理概要
adb_init() 関数
adb_start() 関数
stop() 関数
  • コメント
    adb サーバーが動作している時だけを停止します。
    起動前に使用した場合、immediately を返します。
  • 引数:sync を用いて、adb サーバーを停止させます
adb_kill() 関数
_isAdbRunning() 関数
  • platform に Services.appinfo.OS を代入
  • Deferred オブジェクト deferred を promise.defer() 用いて生成
  • platform 判定
    • WINNT の時、変数 ps に "C:\\windows\\system32\\tasklist.exe" をセット
    • 上記以外 の時、file.exists() を使用して 変数 ps に値をセット
  • 変数 ps を用いて、サブプロセス subprocess 呼出
adb_trackDevices() 関数
  • コメント
    バイスの接続/切断をトレースします。
    ソケットが繋がっている間、再利用できません。
  • adb-client.js の connect() 呼出
  • 引数:"adb-track-devices-start" で、
    関数 socket.s.onopen を定義し、同期
  • 引数:"adb-track-devices-stop" で、
    関数 socket.s.onerror を定義し、同期
  • 引数:"adb-track-devices-stop" で、
    関数 socket.s.onclose を定義し、同期
  • 関数 socket.s.ondata を定義し、同期
    • adb-client.js の checkResponse() 呼出
    • adb-client.js の unpackPacket() 呼出、変数 packet へ代入
    • packet.data を判定し、events.emit() を実行
adb_listDevices() 関数
  • コメント
    バイス名の配列を返します。
  • runCommand を実行し、データ取得成功時に
    バイス名を配列に格納します。
adb_forwardPort() 関数
  • runCommand を実行し、データ取得成功時に
    データを返します。
adb_checkFileMode() 関数
  • コメント
    ファイルのモードをチェックします。
  • チェック用配列:masks を定義
  • チェック用配列:masks に該当する値が無い時、false を返します。
  • 上記以外の時、チェック用配列:masks に該当する値を返します
adb_pull() 関数
  • コメント
    バイスからファイルを pull します。
  • Deferred オブジェクト deferred を promise.defer() 用いて生成
  • 各種変数を定義
  • 関数 shutdown を定義します。
  • 関数 extractChunkDataHeader を定義します。
    • 配列変数:headerArray を初期化します
    • 配列変数:headerArray に引数data を代入します。
  • 関数 checkChunkDataHeader を定義します。
    • データ長 + 現在のヘッダ長 > 8 バイト以上の時、
      以下の処理を実行します。
    • 関数 extractChunkDataHeader を実行します。
    • 配列変数:headerArray[0] と定数:DATAが不一致の時、shutdown() を実行し、false を返します。
    • ヘッダの長さにデータ長を加算します。
    • true を返します。
  • 関数 checkDone を定義します。
    • データ長が 8 バイト以外の時、false を返します。
    • 配列変数:doneFlagArray を Uint32Array で、定義します。
    • 配列変数:doneFlagArray[0] が定数:DONE の時、
      true を返します。
    • 上記以外の時、false を返します。
  • 関数 runFSM を定義します。
    • 変数:state を判定し、状態毎の処理を実行します。
  • 関数 setupSocket を定義します。
    • 関数 socket.s.onerror を定義し、引数:"SOCKET_ERROR" で、deferred.reject() を実行します。
    • 関数 socket.s.onopen を定義し、関数runFSM() を実行します。
    • 関数 socket.s.onclose を定義します。
    • 関数 socket.s.ondata を定義し、関数runFSM() を実行します。
  • adb-client.js の connect() 呼出
  • 関数 setupSocket() を実行します。
  • deferred を return
adb_push() 関数
  • コメント
    ファイルをデバイスへ push します。
  • Deferred オブジェクト deferred を promise.defer() 用いて生成
  • 各種変数を定義
  • 関数 shutdown を定義します。
  • 関数 runFSM を定義します。
    • 変数:state を判定し、状態毎の処理を実行します。
  • 関数 setupSocket を定義します。
    • 関数 socket.s.onerror を定義し、引数:"SOCKET_ERROR" で、deferred.reject() を実行します。
    • 関数 socket.s.onopen を定義し、関数runFSM() を実行します。
    • 関数 socket.s.onclose を定義します。
    • 関数 socket.s.ondata を定義し、関数runFSM() を実行します。
  • 関数 OS.File.stat() を実行します。
    • ファイル情報取得成功時、以下の処理を実行します。
    • 取得情報がディレクトリの場合、deferred.reject() を実行します。
    • 取得情報がファイルの場合、 ファイル情報を格納します。
    • ファイル情報取得失敗時、deferred.reject() を実行します。
  • deferred を return
adb_shell() 関数
  • コメント
    ファイルをデバイスへ push します。
  • Deferred オブジェクト deferred を promise.defer() 用いて生成
  • 各種変数を定義
  • 関数 shutdown を定義します。
  • 関数 runFSM を定義します。
    • 変数:state を判定し、状態毎の処理を実行します。
  • adb-client.js の connect() 呼出
  • 関数 socket.s.onerror を定義し、引数:"SOCKET_ERROR" で、deferred.reject() を実行します。
  • 関数 socket.s.onopen を定義し、関数runFSM() を実行します。
  • 関数 socket.s.onclose を定義します。
  • 関数 socket.s.ondata を定義し、関数runFSM() を実行します。
  • deferred を return
adb_reboot() 関数
  • shell() を実行します。
adb_rebootRecovery() 関数
  • shell() を実行します。
adb_rebootBootloader() 関数
  • shell() を実行します。
adb_root() 関数
  • Deferred オブジェクト deferred を promise.defer() 用いて生成
  • 各種変数を定義
  • 関数 shutdown を定義します。
  • 関数 runFSM を定義します。
    • 変数:state を判定し、状態毎の処理を実行します。
  • adb-client.js の connect() 呼出
  • 関数 socket.s.onerror を定義し、引数:"SOCKET_ERROR" で、deferred.reject() を実行します。
  • 関数 socket.s.onopen を定義し、関数runFSM() を実行します。
  • 関数 socket.s.onclose を定義し、deferred.resolve() を実行します。
  • 関数 socket.s.ondata を定義し、関数runFSM() を実行します。
  • deferred を return
adb_runCommand() 関数
  • コメント
    非同期的に adb コマンドを実行します。
  • Deferred オブジェクト deferred を promise.defer() 用いて生成
  • プロパティ:ready = false の時、以下の処理を実行します。
    • 関数:setTimeout を用いて、deferred.reject() を実行します。
    • deferred を return
  • adb-client.js の connect() 呼出
  • 関数 socket.s.onopen を定義し、同期します。
    • adb-client.js の createRequest() 呼出
    • adb コマンドを送信します。
  • 関数 socket.s.onerror を定義し、deferred.reject() を実行します。
  • 関数 socket.s.onclose を定義します。
  • 関数 socket.s.ondata を定義し、同期
    • adb-client.js の unpackPacket() 呼出
    • adb-client.js の unpackPacket() 呼出、変数 packet へ代入
    • packet.data を判定し、deferred.reject() を実行します。
    • deferred.resolve() を実行します。
  • deferred を return


今回のまとめ
  今回は、ADB Helper の中でも核となるコードをハックしました。
かなり長いブログになってしまったので、ご覧になる方にどう映るか些か心配です。
初めて見る方のソースコード解析のお役に立てば、幸いです。

次回は、adb-client.js をハックする予定です。


関連記事


今年のAdvent Calendar


去年のAdvent Calendar

新訳:ADB Helperをハックしてみた(install.rdf,main.js)

この記事は『Firefox OS / B2G OS Advent Calendar 2016』 10日目の記事です。
Firefox OS で、使用されている「ADB Helper」を再度まとめ直してみました。

目次

前回、新訳:ADB Helperをハックしてみた(前篇)に引き続き、adb-helperをハックしていきたいと思います

  1. フォルダ内のファイル構成
  2. install.rdf
  3. main.js
  4. 今回のまとめ
  5. 関連記事
  6. 今年のAdvent Calendar
フォルダ内のファイル構成
  [ 解凍フォルダ内のjsファイル群 ]
install.rdf
main.js
adb.js
adb-client.js
adb-running-checker.js
adb-socket.js
bootstrap.js
scanner.js
device.js
※1
※1
※1
devtools-import.js
※1
※1
※1
devtools-require.js
※1
※1
※1
fastboot.js
※1
※1
※1
subprocess.js
※2
※2
※2
subprocess_worker_win.js
※3
※3
※3
subprocess_worker_unix.js
※4
※4
※4
  ※1 : version 0.7.1 時点では無かったファイル
※2 : version 0.7.1 時点で有ったファイル
※3 : version 0.7.1 時点で有ったファイル、Windows用ファイル
※4 : version 0.7.1 時点で有ったファイル、maclinux用ファイル
OS毎に使用されるファイルが有る事が確認できます。


install.rdf
  ※rdfファイル Resource Description Framework (リソース・ディスクリプション・フレームワークRDF) とは、 ウェブ上にある「リソース」を記述するための統一された枠組 weblioより抜粋 ご覧の通り、中身はXMLファイルでした。 並びはWindos,macLinuxの順番です。 各OSとの差異は無いか比較してみると・・・・・。 トピックは、versionタグとupdateURLタグです。 updateURLタグは、ご覧の通り各OSのURLへ繋がるようになっていますね。 2014.11.06 時点から、かなりバージョンアップしているのが分かります。


main.js
  次は、main.jsを見たいと思います。 2014.11.06 時点から、かなりバージョンアップしているのが分かります。 こちらは、ご覧の通り、各OSでの差異はありません。 関数がどの程度有るか調べると・・・・・・・ 拡大すると下記画像になります。  
関数名
処理概要
ファイル先頭部
  • defineLazyGetter 定義
  • events 定義
  • system 定義
  • Devices 定義
  • gDevToolsBrowser 定義
  • defineLazyGetter を用いて、adb.js 取得
  • defineLazyGetter を用いて、fastboot.js 取得
  • defineLazyGetter を用いて、device.js 取得
onADBStart()
  • devtools/client/webide/modules 内の runtimes を読み込み
  • runtimes のインスタンス Runtimes が存在する時
    • scanner.js を読み込み
    • scanner.js を登録
  • adb.js が開始された時、trackDevices() 実行
onADBStop()
adb.js を停止します。
onFastbootStart()
fastboot.js の startPolling() を実行
onFastbootStop()
fastboot.js の stopPolling() を実行
onConnected(deviceId)
Device のインスタンス device を引数 deviceId 用いて登録
onDisconnected(deviceId)
Device のインスタンス device を引数 deviceId 用いて登録解除
  アドオンの main.js コードは、アドオンが読み込まれるとすぐに実行されます。 ※ADD-ON SDKより抜粋
参考リンク
  • アドオンのロードとアンロードのリッスン https://dev.mozilla.jp/addon-sdk-docs/dev-guide/tutorials/load-and-unload.html
  • Lifecycle - Add-on SDK (Jetpack SDK) - あすかぜ・ねっと http://www.asukaze.net/etc/jetpack/105.html
  • Device.jsm

  • 今回のまとめ
      数年ぶりに同じアドオン/ xpi ファイルをハックしてみると ソースの読み方やバージョンアップによる改変の度合いが良くわかります
    コードの見え方も変わっているのを感じます。
    引き続きハックしていきたいと思います。


    関連記事


    今年のAdvent Calendar


    去年のAdvent Calendar