我的Firefox外掛程式開發之旅（6）——FF外掛程式的一些基礎知識

上篇文章學習了npruntime的例子程式，接下來迫不及待地想實現自己的一個外掛程式了。我決定使用VS 2005來做。

建立了一個名為npgnet的工程，按照npruntime例子，建立了np_entry.cpp、npn_gate.cpp、
npp_gate.cpp、npgnet.def四個檔案，然後建立了一個類CGnetFFPlugin，並且把例子中的關鍵代碼添加了進來（我刪除了一

些cplugin類中的函數實體代碼，因為我實現的功能和例子中的無關）。編譯後，將產生的npgnet.dll放到FF的plugins目錄下，然後在

地址欄鍵入about:plugins，我靠，竟然沒有我的外掛程式！怎麼回事？三個匯出函數我都按照標準寫了啊？比較了一下檔案，我的工程沒有添加.rc和
resource.h，可能是這個原因。

回到VS
2005，在資源面板添加了一個VERSION資源項，修改ProductName等資源項以後，和npruntime例子比較了一下，還差
MIMEType。這個東東很重要，這個給我的感覺就是FF外掛程式的身份證，FF就是靠這個東東來匹配和識別你的外掛程式的。但是我不知道VS
2005中怎麼添加一個VERSION的索引值，所以我只好用EditPlus開啟npgnet.rc，手動添加了
MIMEType：application/mozilla-npgnet-scriptable-plugin。OK，現在.rc和
resource.h都歐了，再編譯，將產生的npgnet.dll放到FF的plugins目錄下，然後在地址欄鍵入about:plugins，我
靠，竟然還是沒有我的外掛程式！真費解啊！

頭大……接下來我進行了一系列的代碼比較和嘗試，失敗了N多次，這裡就省略不說了。最後發現原因原來在這個.rc上面。我的這個.rc是在VS
2005中使用功能表命令添加的，預設語言是簡體中文，而npruntime例子是英文，用檔案比較工具比較了一下，codepage和部分代碼的位置都不

太一樣。其實只要把npruntime的這個.rc檔案替換我的這個，然後編譯輸出的dll，FF就可以識別了！究竟是什麼原因呢？是我的.rc缺少了些

什麼東西？還是FF只能識別英文的.rc？先不打算研究那麼多了，至少我的外掛程式的關鍵點不在這個上面，後面我還有很多事情需要去做。只要能讓FF認出來，
那就好。

既然決定要寫外掛程式，就要先理解外掛程式的概念，在這個頁面上有很詳細的介紹：https://developer.mozilla.org/en/Gecko_Plugin_API_Reference/Plug-in_Basics

下面的文字是我的一些閱讀筆記和體會：

一、外掛程式的載入過程

當一個頁面開啟時，如果該頁面上有嵌入一個外掛程式，瀏覽器將會做以下事情：

• 通過MIMEType檢查是否有匹配外掛程式
• 載入外掛程式代碼到記憶體
• 初始化外掛程式
• 建立一個新的外掛程式執行個體

外掛程式可以在一個頁面上被執行個體多個對象，也可以在同一時刻在不同的視窗中被執行個體化。當頁面被關閉時，外掛程式的執行個體就會被銷毀。當最後一個執行個體被刪除後，
外掛程式代碼就會從記憶體中被卸載掉。

下面是外掛程式內的函數調用過程：

• 如果外掛程式是首次被載入記憶體，瀏覽器會調用外掛程式的NP_Initialize
  方法。為了方便起見，所有
  的外掛程式定義函數以“NPP”開頭，所有的瀏覽器定義函數以“NPN”開頭。
• 當瀏覽器建立外掛程式執行個體時，會調用NPP_New
  方法。
• 當外掛程式執行個體被刪除時（如關閉頁面、關閉視窗），會調用NPP_Destroy
  方法。
• 當最後一個執行個體被刪除，外掛程式從記憶體中卸載時，會調用NP_Shutdown
  方法。

二、外掛程式檢測

可以使用Javascript來檢測一個外掛程式是不是已經安裝了，下面是測試代碼：
function DetectFFPlugin()
{
var mimetype =
navigator.mimeTypes["application/mozilla-npgnet-scriptable-plugin"];
if(mimetype)
{
var plugin = mimetype.enabledPlugin;
if(plugin)
{
document.writeln("Plugin had been installed and be enabled.");
}
}
else
{
document.writeln("Sorry, Plugin has NOT been installed.");
}
}

嗯，看到這裡，覺得這個檢測很有用。當檢測使用者尚未安裝時，可以指導使用者到哪哪哪去下載安裝（轉向一個漂亮點兒的頁面），當檢測已經安裝了，就動態
載入外掛程式代碼。不錯。：）

三、外掛程式結構概述

一個外掛程式中的方法分為外掛程式方法（Plug-in Methods）和瀏覽器方法（Browser
Methods）。外掛程式方法是你在外掛程式中自己去執行的那些方法，以NPP為首碼命名。瀏覽器方法是被Gecko所執行的那些方法，以NPN為首碼命名。數
據結構（Data Structures）以NP開頭。

外掛程式可分為有視窗和無視窗兩種，不過文章中建議使用有視窗的，說這樣會更穩定和易於控制。另外文中提到了可以將外掛程式作為頁面的一部分，並且可以使用
HTML代碼來控制外掛程式的顯示與否。

有兩種方式可以使一個外掛程式不可見：

1、如果你使用embed標籤，可以使用其hidden屬性，例如：<embed src="audiplay.aiff"
type="audio/x-aiff" hidden="true">
2、如果你是用object標籤，由於它沒有hidden屬性，你可以用CSS來完成隱藏：

object
{
visibility: visible;
}
object.hiddenObject
{
visibility: hidden !important;
width: 0px !important;
height: 0px !important;
margin: 0px !important;
padding: 0px !important;
border-style: none !important;
border-width: 0px !important;
max-width: 0px !important;
max-height: 0px !important;
}

<object data="audiplay.aiff" type="audio/x-aiff" class="hiddenObject"
></object>

接下來文中介紹了object這個標籤的使用。並且給了一個例子來說明ActiveX和外掛程式如何融為一體來使用。

最後面的部分是對object和embed兩種標籤的各種屬性的說明和舉例。

值得一提的是，對於object和embed兩種標籤都可以在頁面上嵌入一個外掛程式。如何取捨呢？文章中有這麼一段話：

Though the object
element is the preferred way to invoke
plug-ins, the embed
element can be used for backward
compatibility with Netscape 4.x browsers, and in cases where you
specifically want to prompt the user to install a plug-in, because the
default plug-in is only automatically invoked when you use the embed
element.

意思是說：儘管object是推薦使用的調用外掛程式的方式，embed也可嵌入外掛程式（Netscape
4.x以上的瀏覽器），但如果你想在使用者沒有安裝外掛程式時，提示他進行安裝，那麼就應該選擇用embed，因為FF的預設外掛程式系統僅僅在你使用embed標
簽的時候，才會自動協助你完成這種提示使用者安裝的效果。

我看過以後的感覺是，object使用起來似乎比embed要複雜，起碼針對FF這個瀏覽器是這樣，雖然他是HTML
W3C的標準。多數情況下使用embed就可以了，何況現在誰還在用Netscape 4.x以下版本的瀏覽器啊，您說是不是？：）

OK，通過這幾天的學習，終於對FF的外掛程式編寫有了一個初步的感性認識。到目前為之一切還比較順利。