傲游浏览器插件制作教程

Maxthon 插件类型

Maxthon 的插件类型由 ModuleType (Script,HTML,COM 及 EXE) 及 Type (Button,SideBar,Toolbar,及 Other) 2 个方面同时定义:

Button SideBar Toolbar Other
Script 支持 支持
HTML 支持
EXE 支持
COM 支持 支持 支持 支持
ModuleType - Script,HTML,COM 及 EXE

Script - 可以是按钮类型,在点击按钮时执行脚本。脚本可以采用 IE 支持的脚本语言编写,比如 javascript 及 vbscript。此外 Maxthon 2.0 提供额外的 mscript 脚本执行方式,可以实现更强大插件功能。Script 插件亦可以是侧边栏类型,在侧边栏显示插件指定的 HTML 档案。HTML 档案可以采用 IE 支持的 HTML 语言格式编写。

HTML - 是 Maxthon 2.0 新添加的插件类型,和 Script 侧边栏插件性质相同,主要分别是 Script 侧边栏插件在侧边栏显示,而 HTML 插件则以按钮型式在工具栏显示。

COM - 可以采用任何 MSCOM 支持的语言编写,比如 C++,C#,Visual Basic,Delphi 等。Maxthon 默认支持按钮类型,工具栏类型及侧边栏类型 COM 插件。另外,COM 插件亦可以自行添加拟采用的插件显现方式,比如菜单或弹出窗口。

EXE - 可以是任何可执行档案,以工具栏按钮形式在 Maxthon 显现。Maxthon 可以在执行 EXE 插件是提供参数,比如页面地址及 Maxthon 窗口的句柄等

Type - Button,SideBar,Toolbar,Other

Button - 插件会在插件栏添加一个按钮,点击按钮时会执行指定由脚本 (Script 插件),程序 (EXE 插件),DLL (COM 类型插件),指定的操作。Script 及 EXE类型按钮插件可以选择性在插件按钮添加下拉菜单。

SideBar - 插件会在侧边栏添加一个按钮,及在主菜 > 查看 > 侧边栏添加一个命令,在执行时会打开侧边栏及显示插件指定的 HTML 页面。

Toolbar - 插件会添加一个工具栏,新添加的工具栏可以在主菜 > 查看 > 工具栏选择是否显示。

Other - 插件没有固定显示接口,插件可以因应需要自行改变接口,比如改变菜单,添加按钮

制作 Maxthon 插件

Maxthon 插件的主要元件 Maxthon 插件一般具备以下档案:

INI 档案 – plugin.ini 必须,定义插件的各个属性
HTML/DLL/EXE 档案 – 必须,指定插件需要执行的操作,或需要显示的内容
图标档案 – 按钮图标 (*.ICO),适用于按钮类型及侧边栏类型插件,COM 或 EXE 插件可以用 DLL 或 EXE 内含图标
Config.html – 选择性,应用于 Script 及 HTML 类型插件的设置窗口

plugin.ini 档案
每个 Maxthon 插件必须具备一个 plugin.ini 档案,定义插件的各项属性。

[General] 必须,定义插件的主要属性


Name= 插件名称

Author= 作者名字

Version= 版本号

ModuleType= 可以是 Script,HTML,COM 或 EXE

FileName= 可以是 HTML 档案 (Script 及 HTML 插件),DLL 档案 (COM 插件),或 EXE 档案 (EXE 插件)

Comments= 在插件选项或按钮的工具提示所显示的描述

Type= 可以是 M2Plugin_BUTTON,M2Plugin_SIDEBAR,M2Plugin_Toolbar 或 M2Plugin_Other

IdealSize= 指定插件在接口显示的大小,比如 “120 20”(阔度 高度,适用于 HTML 插件)

IdealSizeVertical= 选摘性,指定当工具栏在垂直放置的插件接口显示的大小,比如 “120 20”(阔度 高度,适用于 HTML 插件)

Icon= 在按钮或侧边栏插件显示的图标 (适用于按钮及侧边栏插件)

HotIcon= 当鼠标移到插件按钮上时显示的图标 (适用于按钮插件)

CLSID= COM 插件的 CLSID (适用于 COM 插件)

StartAfterPageDone= 0 或 1,选摘性,设置 script 按钮插件是否自动执行

DefaultLocation= 按钮插件的默认显示位置,可以是 None (在插件栏,但不显示),MenuBar (菜单栏),ToolBar (标准工具栏),或 StatusBar (状态栏)。如果不设置则在插件栏显示。

StartAfterPageDoneUrl= 设置 script 按钮插件自动执行的地址,使用通配符格式,可以用 "|" 分隔多个网站,比如 *maxthon.com*|forum.maxthon.cn*。不设置的话在所有地址自动执行,等同设置为 *

StartAfterPageDoneUrlExclude= 设置 script 按钮插件不自动执行的地址,使用 startAfterPageDoneUrl 相同格式,比如 forum.maxthon.cn/index.php?|*.maxthon.cn/index.php?showtopic*


[MyIE2Buttons] 选摘性,定义按钮类型插件的下拉菜单,适用于 Script 及 EXE 类型插件


Count= 插件下拉菜单项目的数量

Name1= 第一个下拉菜单项目的名称,如此类推

FileName1= 提供第一个下拉菜单项目应执行的代码的档案,如此类推

安装 Maxthon 插件
Maxthon 插件是安装在 Maxthon 目录内的 Plugin 目录。每个插件在 Plugin 目录内均有独立的目录,目录内包含 plugin.ini 及其他插件档案或子目录。

制作好的插件可以把插件的目录连同内里的 plugin.ini 及所有其他档案及子目录打包成 ZIP 档案(*.zip) 发布

Maxthon 2.0 插件

Maxthon 2.0 支持专用的 M2P 插件安装包格式 (把*.zip 更名为 *.m2p 即可),用户只要双击 M2P 档案或把M2P 档案拖放到 Maxthon 2.0 窗口插件便会自动安装

Maxthon 1.X 插件

在 Maxthon 1.X 安装插件需按照以下步骤:

1. 关闭 Maxthon 浏览器。

2. 把 ZIP 档案解压到 Maxthon 目录内的 Plugin 目录。完成後插件的 plugin.ini 档案应在类似如下位置:C:\Program Files\Maxthon\Plugin\新插件\plugin.ini

3. 打开 Maxthon 浏览器,插件安装窗口会出现

4. 确认安装新插件

Maxthon 脚本插件指令

Maxthon 提供多种插件指令供脚本插件调用,以加强脚本插件的功能。这些插件指令可以透过 window.external 执行。部份插件指令需要提供 Security ID 参数方能执行,而Security ID则由 Maxthon 提供给脚本插件。


如何取得 Security ID

1. 按钮插件可以在脚本中直接使用 %max_security_id 作为 Security ID

2. 侧边栏及 HTML 插件需要载入由 Maxthon 自动产生的脚本 max.src,之後便能使用 max_security_id 作为 Security ID。

<script src=max.src></script>

Maxthon 插件指令
除特别注明外,以下插件指令同时适用于 Maxthon 2.0 及 Maxthon 1.X。

1. max_version - 传回 Maxthon 版本号

例子:
alert(external.max_version);

2. max_language_id - 传回 Maxthon 语言编码

例子:
alert(external.max_language_id);

注意 Maxthon 2.0 和 Maxthon 1.X 所采用的语言编码格式并不相同

3. tab_count - 传回 Maxthon 打开的标签数量

例子:
alert(external.tab_count);

4. cur_sel -传回 Maxthon 当前标签的 index

例子:
alert(external.cur_sel);

5. m2_plugin_folder( security_id , plugin_name ) - 传回指定插件目录位置

例子:
alert(external.m2_plugin_folder( %max_security_id , ViewSource! ));

6. m2_run_cmd( security_id , command_id ) - 执行指定的 Command ID

例子:external. m2_run_cmd( %max_security_id , 32772 ));

注意 Maxthon 2.0 和 Maxthon 1.X 所采用的 Command ID 并不相同,Command ID 可以在 Maxthon 的语言文件中找到

7. get_tab( security_id , tab_index ) - 传回指定标签的 window object

例子:
var oWin=external.get_tab(%max_security_id, 0);
alert(oWin.document.URL);



8. activate_tab( security_id , tab_index ) - 激活指定标签

例子:
external.activate_tab(%max_security_id, 0);
9. close_tab( security_id , tab_index ) - 关闭指定标签

例子:
external.activate_tab(%max_security_id, 0);
10. readFile( security_id, plugin_name, file_name) - 读取文本档案内容

例子:
var sText=external.readFile(%max_security_id, ViewPage, readme.txt);
alert(sText);
11. writeFile( security_id, plugin_name, file_name, content ) - 写入文本档案内容

例子:
external.writeFile(%max_security_id, ViewPage, test.txt, 测试);
12. m2_readIni( security_id, plugin_name , file_name , section_name , key , default_value) - 读取 INI 档案资料

例子:
var sDownloadTool=external.m2_readIni(%max_security_id, ViewPage, plugin.ini, Settings, DownloadTool, );
alert(sDownloadTool);
13. m2_writeIni( security_id , plugin_name , file_name , section_name , key , value ) - 写入INI 档案资料

例子:
external.m2_writeIni(%max_security_id, ViewPage, test.ini, Config, height, 100px);
14. max_modelessDialog( security_id , url , option , attr , window ) - 传回非模式网页对话框

例子:
var oDialog= external.max_modelessDialog( %max_security_id , blank.html, window , , window );
var oDoc=oDialog.document;
oDoc.write(测试);
oDoc.close();
15. max_activex(security_id ,program_id) -传回指定的 ActiveX object

例子:
var oWSH=external.max_activex(%max_security_id, WScript.Shell);
oWSH.run(notepad.exe);

16.max_callback(event_name) - 在 Maxthon 的一些事件发生时会被执行 (适用于 HTML 钮插件及 Script 侧边栏插件 )

HTML 按钮插件及 Script 侧边栏插件可以加入 max_callback 函数以便对 Maxthon 浏览器发生的一些事件作出反映。比如撤换到另一个标签,或当前的标签重新加载等。

例子:
function max_callback(x){
if(x==tab_change) alert(Current tab is changed.);
}

透过检查传回的 max_callback参数,插件可以探测一些在 Maxthon 浏览发生的事件,目前以下参数会被传回:

HTML 按钮插件
tab_change – 当改变当前的标签後传回
document_Complete - 当前的标签页面加载後传回

Script 侧边栏插件
sidebar_tab_change -当改变当前的标签後传回
sidebar_activate - 当侧边栏插件被激活後传回
sidebar_deactivate - 当侧边栏撤换到其他侧边栏项目後传回
sidebar_unload - 当侧边栏插件被卸做载时传回
17. max_getObj (只适用于 Maxthon 2.0) -传回指定的 Maxthon object,包括:

Info - 关于Maxthon 的资料
Adhunter – 关于广告猎手
FavManager – 关于收藏
RssManager – 关于 RSS

例子:
var oInfo=external.max_getObj(%max_security_id, info);

Info Object 支持以下 properties 及 method:

Property:
fileProxy - read-only,传回当前用户的代理设置文件位置

例子:
var oInfo=external.max_getObj(%max_security_id, info);
alert(oInfo.fileProxy);

folderUser - read-only,传回当前用户的设置目录位置

例子:
var oInfo=external.max_getObj(%max_security_id, info);
alert(oInfo. folderUser);

Method

getFolderPluginData(plugin_name) - 传回指定插件的设置目录位置

例子:
var oInfo=external.max_getObj(%max_security_id, info);
alert(oInfo.getFolderPluginData(ViewSource!));

AdHunter object支持以下method:

Method:
reloadFilter(filter_name) – 插件可以修改 filter 的 xml 文件,然後用这个指令让 Maxthon 重新载入,目前只支持 content

例子:
var oAdHunter=external.max_getObj(%max_security_id, AdHunter);
oAdHunter.reloadFilter(content);

enableFilter(filter_name, bEnable) – 插件可以用这个指令开启或关闭 Maxthon 的过滤功能,目前支持的 filter_name 为 content (内容过滤) 及popup (弹出窗口过滤)。bEnable 为 true 或 false

例子:
var oAdHunter=external.max_getObj(%max_security_id, AdHunter);
oAdHunter. enableFilter (content, false);

PluginManager Object 支持以下 method:

Method:

getPluginFolder - read only, 取得 Maxthon 的主插件目录

例子:
var oPluginManager=external.max_getObj(%max_security_id, PluginManager);
alert(oPluginManager.getPluginFolder);

getCount - read only, 取得所有安装插件的数量,包括启用及没启用的

例子:
var oPluginManager=external.max_getObj(%max_security_id, PluginManager);
alert(oPluginManager.getCount);

getList - read only, 取得插件清单,包括名字,作者等讯息

例子:
var oPluginManager=external.max_getObj(%max_security_id, PluginManager);
alert(oPluginManager.getList);

getCount - read only, 取得所有安装插件的数量,包括启用及没启用的

例子:
var oPluginManager=external.max_getObj(%max_security_id, PluginManager);
alert(oPluginManager.getCount);

getList - read only, 取得插件清单,包括名字,作者等讯息

例子:
var oPluginManager=external.max_getObj(%max_security_id, PluginManager);
alert(oPluginManager.getList);

getPlugin(Index) - Index 为数字,取得对应的插件对象

例子:
var oPluginManager=external.max_getObj(%max_security_id, PluginManager);
var oPlugin=oPluginManager.getPlugin(0);

由 getPlugin 取得的插件对象支持以下 property 及 method:

Property:

title - read only, read only, 传回插件的名字

例子:
alert(oPlugin.title);

folderName - read only, 传回插件的目录名称

例子:
alert(oPlugin.folderName);

fullPath - read only, 传回插件的目录的完整地址

例子:
alert(oPlugin.fullPath);

enable - read/write, 传回或设置插件的启用状态

例子:
oPlugin.enable=false;
alert(oPlugin.enable);
oPlugin.enable=true;
alert(oPlugin.enable);

startAfterPageDone - read/write, 传回或设置插件是否自动执行

例子:
oPlugin.startAfterPageDone=false;
alert(oPlugin.startAfterPageDone);
oPlugin.startAfterPageDone=true;
alert(oPlugin.startAfterPageDone);

startAfterPageDoneUrl - read/write, 传回或设置插件自动执行的地址

例子:
oPlugin.startAfterPageDoneUrl=*maxthon.com*|*maxthon.cn*
alert(oPlugin.startAfterPageDoneUrl)

Method:

config() - 打开插件的设置对话框 (config.html)

例子:
oPlugin.config();

remove() - 删除插件

例子:
oPlugin.remove();

Mscript

Maxthon 2.0 提供额外的 mscript 脚本执行方式供 Script 按钮插件使用。和一般脚本不同,mscript 并非在页面上执行脚本,因此 mscript 可以不受一般网页脚本安全限制,亦不用担心被网页恶意利用。mscript 可以在页面禁用脚本情况下执行,也可以处理页面内跨域的框架内容,能大大提升 Script 按钮插件能力。要在 Script 按钮插件采用 mscript 方式执行脚本,只需把 <script...> 标签改为 <mscript...>。


例子 - 以下的是一般 Script 按钮插件,可以透过内容控制禁止当前页面执行脚本:

<script language="javascript">
external.m2_run_cmd(%max_security_id, 33175);
</script>
但在插件运行後页面已经不能执行脚本,插件不能再次运行恢复在当前页面执行脚本。然而使用以下的 mscript 则没有这问题,在页面不能执行脚本情况下,mscript 插件仍然可以运行,恢复在当前页面执行脚本:

<mscript language="javascript">
external.m2_run_cmd(0, 33175);
</script>