Mozilla 的 XUL(XML User Interface Language,可讀作「zool」)是一套通用性極強的介面語言,既能用來開發獨立應用程式,也能用來打造瀏覽器擴充套件。在本系列的上一篇裡,我拆解了 XUL 擴充套件的基本組成元件;這一篇則要說明如何把這些零件組裝成一個真正可以在不同平台上安裝的 Firefox 擴充套件。
由於直接放在瀏覽器中執行的 XUL 檔案受到嚴格的安全規範限制,上一篇的程式碼只能做到很有限的功能。而擴充套件不受這些限制,因此本文也會把先前被裁掉的功能補回來。
第一步,是把上一篇文章中寫好的 XUL 及其相關檔案打包成擴充套件。如果你裝過其他 Firefox 附加元件,應該會注意到它們都以 .xpi 為副檔名的檔案形式發佈。XPI 代表「跨平台安裝檔」(Cross-platform Install),念起來像「zippy」。說穿了,XPI 就是一種有特定目錄結構、並包含若干清單(manifest)檔案的 .zip 壓縮檔,這點和 Java 的 JAR 格式相當類似——兩者都在 zip 內容裡塞進了描述用的清單。
下面的程式碼片段展示了我把上一篇文章的 XUL、JavaScript 與 CSS 打包後,這個 .zip(也就是 .xpi)檔案的目錄結構。
Firefox 擴充套件 XPI 包的 zip 目錄
Archive: /Users/uche/stats.xpi
Length Method Size Ratio Date Time CRC-32 Name
-------- ------ ----- ----- ---- ---- ------ ----
0 Stored 0 0% 10-08-07 23:10 00000000 Chrome/
0 Stored 0 0% 10-08-07 23:10 00000000 Chrome/content/
271 Defl:N 184 32% 10-09-07 00:13 44bb6d65 Chrome/content/overlay.JS
464 Defl:N 284 39% 10-09-07 00:13 1d873c24 Chrome/content/overlay.xul
909 Defl:N 366 60% 10-09-07 00:13 67869f05 Chrome/content/stats.JS
1581 Defl:N 544 66% 10-09-07 00:13 49def584 Chrome/content/stats.xul
0 Stored 0 0% 10-08-07 23:10 00000000 Chrome/skin/
230 Defl:N 147 36% 10-09-07 00:13 a732aecb Chrome/skin/stats.CSS
181 Defl:N 105 42% 10-09-07 00:13 f7317c0a Chrome.manifest
0 Stored 0 0% 10-08-07 23:10 00000000 defaults/
0 Stored 0 0% 10-08-07 23:10 00000000 defaults/preferences/
948 Defl:N 440 54% 10-09-07 00:13 50ee7971 install.rdf
0 Stored 0 0% 10-08-07 23:10 00000000 locale/
0 Stored 0 0% 10-08-07 23:10 00000000 locale/en-US/
43 Stored 43 0% 10-09-07 00:13 d9c38400 locale/en-US/overlay.dtd
-------- ------- --- -------
4627 2113 54% 15 files
請務必仔細核對這份目錄結構,因為擴充套件開發中最令人頭痛的一些問題,往往就出在檔案擺放的位置不對。你會發現其中有幾個檔案是上一篇文章裡沒出現過的,我會在接下来的各小節逐一說明。
在上一篇裡,那個 XUL 視窗是完全獨立的;但現在它被包成了擴充套件,就必須想辦法從 Firefox 裡把它叫出來。一般做法是對瀏覽器的使用者介面做點手腳,好讓使用者有入口可以啟動擴充套件。XUL 提供了一個很方便的機制——覆蓋(overlay),讓你能在不改動原始介面的情況下對它進行擴充。
下面的 overlay.xul 就是一個覆蓋檔,它往「工具」選單裡新增了一個項目,用來開啟 stats 檢視視窗。
overlay.xul:用覆蓋新增一個選單項目
<?XML version="1.0"?> <?XML-stylesheet href="Chrome://stats/skin/overlay.css" type="text/CSS"?> <!DOCTYPE overlay SYSTEM "Chrome://stats/locale/overlay.dtd"> <overlay XMLns="https://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul" id="stats-overlay"> <script src="overlay.JS"/> <menupopup id="menu_ToolsPopup"> <menuitem id="stats" label="&statsmenuitemname;" oncommand="Stats.onMenuItemCommand(event);"/> </menupopup> </overlay>
關於 chrome URL,稍後會再詳細解釋。這裡先注意最上方的 DOCTYPE 宣告,它負責載入一份 DTD,裡面放著所有需要在地化的字串——基本上就是所有會顯示給使用者看的自然語言文字。 Mozilla Chrome 應用程式就是靠這種方式來實作本地化(l10n)的,下一節會再深入說明。
在覆蓋檔內部,我透過 outer 元素的 id 指定了 Firefox 裡既有的目標選單——menu_ToolsPopup 對應的就是「工具」選單。新項目預設會被附加為最後一項。這個名為 stats 的新項目,其標籤以 DTD 實體的形式提供,因此顯示給使用者的是一段已經過本地化的字串。其中 oncommand 屬性格外關鍵,它決定了使用者點選該項目時要觸發什麼行為。這裡指定的 JavaScript 函式由獨立的 overlay.JS 檔案提供,如下所示。
overlay.JS:為新增的選單項目提供行為
var Stats = {
onLoad: function() {
//You can place set-up code for the extension here
},
onMenuItemCommand: function() {
window.open("chrome://stats/content/stats.xul", "", "Chrome, resizable=yes");
}
};
window.addEventListener("load", function(e) { Stats.onLoad(e); }, false);
這段腳本的核心,是定義了一個名為 Stats 的結構來封裝所有函式,你同樣應該把所有全域變數都放進這個結構裡。這樣做能降低擴充套件的記憶體佔用,因為它在全域命名空間中只會佔用一個名稱(也就是外層結構本身的名字),而且這是所有行為良好的擴充套件都會遵守的慣例,可以避免與其他擴充套件、甚至與內容腳本發生名稱衝突。
前面你已經看過如何透過 Stats.onMenuItemCommand(event); 這樣的片段去存取這個封裝物件,它呼叫的正是 overlay.JS 裡的第二個結構成員。為了完整起見,我保留了 Stats.onLoad 函式,但擴充套件實際上並沒有用到它——它是留給你放初始化程式碼的地方。腳本最後一行透過事件監聽器,讓 Stats.onLoad 在 chrome 載入完成後立即執行。
Stats.onMenuItemCommand 函式會呼叫上一篇那個 XUL 範例 applet 來開啟視窗。它的第二個參數是視窗 ID,這裡用不到;第三個參數則是一串旗標,其中 chrome 代表新視窗擁有自己獨立的 chrome,不會開在瀏覽器的 chrome 之內(因此新視窗不會繼承 Firefox 的選單、工具列、狀態列、分頁等等),而 resizable=yes 則讓使用者可以自由調整視窗大小。
到目前為止你應該已經發現,這個擴充套件周邊多了不少檔案,而 XPI 的一個重點,就是要能正確地在包裡找到這些檔案。這時就得靠 Chrome.manifest 這個清單檔了。
Stats 擴充套件的 Chrome 清單檔
content stats Chrome/content/ overlay chrome://browser/content/browser.xul Chrome://stats/content/overlay.xul locale stats en-US locale/en-US/ skin stats classic/1.0 Chrome/skin/
第一行決定了主要內容(例如 XUL 檔與腳本)的位置。它用 stats 這個別名來指代表作裡的 Chrome/content/ 資料夾,因此舉例來說,當你使用 chrome://stats/content/stats.xul 這樣的 chrome URL 時,系統會先把 stats 別名解析出來,再前往 Chrome/content/ 資料夾尋找 stats.xul 檔。第二行用 overlay.xul 對主瀏覽器的 chrome 建立一個覆蓋。第三行指定了存放自然語言字串之 DTD 的位置,用以支援本地化——範例裡只附了英文版,但你大可以把這些字串翻成法文放進 fr-FR 資料夾、翻成德文放進 de-DE 資料夾等等,瀏覽器會自動挑選與使用者偏好語言相符的版本。最後一行則替 CSS 檔建立位置,讓它能與標準的瀏覽器 chrome 合併呈現。
XPI 的另一個關鍵檔案是 install.rdf,它承載了擴充套件的安裝資訊,如下例所示。
install.rdf:Stats 擴充套件的安裝參數
<?XML version="1.0"?>
<RDF XMLns="https://www.w3.org/1999/02/22-rdf-syntax-ns#"
XMLns:em="https://www.mozilla.org/2004/em-rdf#">
<Description about="urn:mozilla:install-manifest">
<!-- Required Items -->
<em:id>xulapp@example.com</em:id>
<em:name>Stats vIEwer</em:name>
<em:version>1.0</em:version>
<em:targetApplication>
<Description>
<em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id>
<em:minVersion>1.5</em:minVersion>
<em:maxVersion>2.0.0.*</em:maxVersion>
</Description>
</em:targetApplication>
<!-- Optional Items -->
<em:creator>Uche Ogbuji</em:creator>
<em:description>
Opens a window in which you can vIEw simple stats about Web pages
</em:description>
<em:homepageURL>https://www.ibm.com/developerworks/web/</em:homepageURL>
</Description>
</RDF>
這份檔案大部分內容都可從字面上理解,這裡只補充一點:我透過 em:targetApplication 元素把支援範圍設為「Firefox 版本大於 1.5、小於 2.0.1」。而那串較長的 em:id,其實就是 Firefox 本身的應用程式全球唯一識別碼(UUID)。
完成這些之後,你應該就能把上一篇文章的範例檔案放進上面那份 zip 目錄所指定的位置,唯一需要調整的地方,是把 stats.xul 裡原本指向同目錄 stats.css 的樣式表連結,改成使用 chrome 連結 Chrome://stats/skin/stats.CSS。
由於先前受限於安全規範,我不得不把 stats.js 裡的部分功能拿掉。現在既然已經打包成擴充套件,就能把缺的部分補回來。下面的程式碼展示了更新後的 stats.JS,它才真正執行了擴充套件該有的統計運算。
Stats 檢視視窗的完整 JavaScript 程式碼
//Invoked in response to a click on the "Go!" button
function change_url(event)
{
//Variables for convenIEnt Access to specific elements in the XUL
var urlbox = document.getElementById("url");
var contentview = document.getElementById("contentvIEw");
var wordcountbox = document.getElementById("Wordcount");
var charcountbox = document.getElementById("charcount");
var elemcountbox = document.getElementById("elemcount");
alert(urlbox.value);
contentvIEw.contentDocument.location.href = urlbox.value;
//Use Firefox XPath to get the raw text of the document
var doctext = contentvIEw.contentDocument.evaluate(
"string(.)", document, null, XPathResult.STRING_TYPE, null).stringValue;
var Wordcount = doctext.split(" ").length()
alert(Wordcount);
wordcountbox.value = String(Wordcount);
charcountbox.value = String(doctext.length());
//Use Firefox XPath to count elements in the document
var elemcount = contentvIEw.contentDocument.evaluate(
"count(//*)", document, null, XPathResult.NUMBER_TYPE, null).numberValue;
elemcountbox.value = String(elemcount);
}
這一次,我對使用者載入到 contentvIEw 的網頁套用了兩個 XPath 運算式。第一個運算式 string(.) 用來取出整份文件的純文字,藉此計算字元數(字串長度)與字數(以空格切開字串後再數結果)。第二個運算式 //* 則用來取得文件的元素總數。接著我把這些數值回填到對應的文字方塊中。
打造 Firefox 擴充套件是件頗為繁瑣的工作,所幸社群提供了大量現成的擴充套件,能從各個層面提供支援(相關資源可參考原文的側欄)。透過這兩篇文章,你已經看到只要稍加琢磨,自己也能動手開發 Firefox 擴充套件,而且還能把這些知識延伸到完整應用程式的主要部分。XUL、JavaScript 與 Mozilla 平台三者結合所展現的力量令人印象深刻。
除了標準的網頁瀏覽器之外,你其實還能把更多平台作為目標。一般來說,把 Firefox 擴充套件移植到 Songbird 音樂管理程式、Flock 社群瀏覽器等這類以 XUL 為基礎的 Mozilla 應用程式上,往往並不困難。