【原創】我的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的插件編寫有了一個初步的感性認識。到目前為之一切還比較順利。
posted on 2008-11-12 14:40 深藍色系統 閱讀(13866) 評論(13) 編輯 收藏 引用 所屬分類: Firefox開發