Openfire 插件开发指南

 

英文版本链接

介绍

插件加强了Openfire的功能，这篇文档指导开发者如何创建一个插件。

插件的结构

插件位于openfireHome目录下的plugins目录中，当一个插件以一个JAR或者WAR文件部署时，他会被自动的解压。一个插件的目录结构如下所示：

 

myplugin/
 |- plugin.xml      <- 插件的声明文件
 |- readme.html     <- 可选 插件的自述文件，可以展示给使用用户
 |- changelog.html  <- 可选 插件的更新日志，可以展示给使用用户
 |- logo_small.gif  <- 可选 插件的小图标(16x16) (也可以是png文件)
 |- logo_large.gif  <- 可选 插件的大图标(32x32) (也可以是png文件)
 |- classes/        <- 插件的资源文件(即class文件或properties文件)
 |- database/       <- 可选 插件需要的数据库脚本
 |- i18n/           <- 可选 插件国际化所需要的i18n文件
 |- lib/            <- 插件所需要的lib文件 (JAR files)
 |- web             <- Admin集成所需要的资源
     |- WEB-INF/
         |- web.xml           <- 生成的web.xml文件，包括编译后的JSP实例
         |- web-custom.xml    <- 可选 用户定义的web.xml，包含定制的servlets
     |- images/

 

 

如果插件需要在Openfire的控制台添加页面，则需要创建web目录。下面将详细进行描述。

plugin.xml指定了插件的主类，示例如下：

 

<?xml version="1.0" encoding="UTF-8"?>
<plugin>
    <!-- Main plugin class -->
    <class>org.example.ExamplePlugin</class>
 
    <!-- Plugin meta-data -->
    <name>Example Plugin</name>
    <description>This is an example plugin.</description>
    <author>Jive Software</author>
 
    <version>1.0</version>
    <date>07/01/2006</date>
    <url>http://www.igniterealtime.org/projects/openfire/plugins.jsp</url>
    <minServerVersion>3.0.0</minServerVersion>
    <licenseType>gpl</licenseType>
 
    <!-- Admin console entries -->
    <adminconsole>
        <!-- More on this below -->
    </adminconsole>
</plugin>

 

plugin.xml文件中的元数据包括：

• name — 插件的名称
• description — 插件的描述
• author — 插件的作者
• version — 插件的版本
• date — 插件发布的日期，日期的格式必须是MM/dd/yyyy，比如07/01/2006
• url — 关于该插件更多信息的地址
• minServerVersion — 允许该插件最小的Openfire版本号（从Openfile 2.1.2版本开始支持），如果Openfire的版本号比需要的小，则插件不会被启动
• databaseKey — 如果插件需要自己的数据库表，databaseKey将被用于数据库脚本的名称（通常与插件名称相同）。可被支持的数据库脚本文件需要放置在 database目录下。例如，给定的databaseKey为foo，脚本文件可以为“foo_mysql.sql”、 “foo_oracle.sql”等。我们建议表名增加前缀“of”，避免与其他应用使用的表名产生冲突。databaseKey可以作为 ofVersion表的一条记录的key，这样脚本的版本信息可以被跟踪，例如：

  1	INSERT INTO ofVersion (name, version) VALUES ('foo', 0);

• databaseVersion — 数据库脚本的版本（如果使用数据库脚本的话）。一个新插件的数据库脚本文本从0开始。如果将来该插件的数据库脚本需要更新，则这些更新可以在 database/upgrade子目录下定义。例如，目录database/upgrade/1和database/upgrade/2都可以包含脚本 foo_myslq.sql和foo_oracle.sql，这些脚本中包含每个版本相关联的数据库修改。每个脚本都会更新ofVersion表中的版本 信息。

  1	UPDATE ofVersion set version=1 where name='foo';

• parentPlugin — 父插件的名称（对于foo.jar插件可以使用名称foo）。当一个插件有一个父插件，父插件的类加载器将被直接使用，而不需要创建一个新的类加载器。这将让插件能更紧密的合作。没有父插件的配合，子插件将不能正常使用。
• licenseType — 指明该插件使用的许可协议，有效的值有：
  • commercial：该插件是在商业许可协议下发布的
  • gpl：该插件是在GNU公共许可协议下（GPL）发布的
  • apache：该插件是在Apache协议下发布的
  • internal：该插件只能用于组织内部，且不允许扩散
  • other：该插件的发布许可协议不包含在上述列表中，详情可见插件中的自述文件

  如果许可类型没有指定，则会被设置为other。

插件中的几个附加文件可为最终的使用用户提供额外的信息（这些文件都位于插件的根目录）：

• readme.html — 可选 插件的自述文件，将展现给最终用户
• changelog.html — 可选 插件的更新李日，将展现给最终用户
• logo_small.png — 可选 插件的小图标（16×16），也可以是.gif文件
• logo_large.png — 可选 插件的大图标（32×32），也可以是.gif文件

插件类必须实现Plugin接口，他有一个默认的构造方法（无参数）。Plugin接口有方法用于初始化和销毁插件。

package org.example;
 
import org.jivesoftware.openfire.container.Plugin;
import org.jivesoftware.openfire.container.PluginManager;
 
import java.io.File;
 
/**
 * A sample plugin for Openfire.
 */
public class ExamplePlugin implements Plugin {
 
    public void initializePlugin(PluginManager manager, File pluginDirectory) {
        // Your code goes here
 
    }
 
    public void destroyPlugin() {
        // Your code goes here
    }
}

 

插件开发的最优方法

当选择一个包名作为你的插件名称时，我们推荐你选择对你或者你的组织来说有特色的名称，这将尽可能的避免可能的冲突。例如，所有人都是用org.example.PluginName，即使PluginName不同，你可能会碰到类名冲突的问题，特别是在集群运行时。

配置管理后台

插件可以在管理后台添加Tab标签、片段和页面，通过下面的几个步骤可以完成配置：

• 在plugin.xml文件中添加<adminconsole/>
• JSP文件必须已被编译，且添加到插件的classpath中。web.xml文件中包含被编译的JSP servlet实体，且被放置在插件的web目录下。注意：Openfile的build脚本可以完成JSP文件的编译和web.xml文件的创建，下面 将会详细描述。
• JSP页面中所需要的图片都必须放置在web/images/目录下，且只允许为GIF何PNG文件。

plugin.xml文件中的<adminconsole/>片段用于在管理后台框架中添加一个Tab标签、片段和页面。示例如下：

<?xml version="1.0" encoding="UTF-8"?>
<plugin>
    <!-- Main plugin class -->
    <class>org.example.ExamplePlugin</class>
 
    <!-- Admin console entries -->
 
    <adminconsole>
        <tab id="mytab" name="Example" url="my-plugin-admin.jsp" description="Click to manage...">
            <sidebar id="mysidebar" name="My Plugin">
               <item id="my-plugin" name="My Plugin Admin"
                   url="my-plugin-admin.jsp"
                   description="Click to administer settings for my plugin" />
            </sidebar>
        </tab>
 
    </adminconsole>
</plugin>

在示例中，我们定义了一个新Tab标签“Example”，一个工具条片段“My Plugin”和一个页面“My Plugin Admin”。我们同样注册了一个页面my-plugin-admin.jsp。你可以重写一个已经存在的Tab标签，片段和页面，通过在中使用已经存在的id。

管理后台最优方法

当通过插件对Openfile的管理后台有所调整时，这里有几条最优方法可供参考。通用主题可以使插件无缝的集成：

• 尽可能的集成到已经存在的Tab标签或者左侧导航，而不是创建自己的。只有在提供重大新功能时才创建新的Tab。
• 不要在Tab标签、左侧导航中中使用“plugin”字样，例如使用“Gateway Settings”，而不是“Gateway Plugin”。
• 在你定制的插件页面中，尽可能的匹配已经存在的管理后台的UI。
• 没有必要创建一个入口来展示插件的元数据信息，而是让用户直接使用Openfire提供的功能，了解哪些插件已被安装并对这些插件进行管理。

创建管理后台页面

Openfire使用Sitemesh框架来管理后台的页面。一个全局定义的状态被应用到各个页面中，用于渲染最终的输出，如下图：

使用Sitemesh创建创建一个页面很简单。先创建一个HTML页面，然后使用meta标签将指令传递给Sitemesh框架。在渲染输出时，Sitemesh将使用你提供的指令来渲染HTML页面中body标签中的所有内容。下面的meta标签可被使用：

• pageID — 页面的ID，他必须符合上述的管理后台的XML条目，pageID和subPageID必须被指定。
• subPageID — 子页面的ID，他必须符合上述的管理后台的XML条目。子页面用于具体的功能操作，他与父页面ID相关联。例如，编辑或删除一个组。pageID或者subPageID必须被指定。
• extraParams（可选）– 需要传递给页面的额外参数。例如，在一个页面中删除一个分组，那么分组的ID需要传递给该页面。所有的参数必须是做了URL encoded编码的。
• decorator（可选）– 为该页面重写Sitemesh装饰者。一个名为为none的装饰者将被用于渲染页面。

下面的HTML片段展示了一个有效的页面：

<html> <head> <title>My Plugin Page</title>   <meta name="pageID" content="myPluginPage"/> </head> <body> Body here! </body> </html>

在插件中使用i18n

如果想把你的插件翻译成多种语言，可以使用下面的步骤：

• 在插件的根目录下创建“i18n”目录
• 按照 %[plugin_name]%_i18n_language.properties 的命名规范来添加资源文件，[plugin_name]使用插件的目录名。
• 在JSP文件中使用国际化的key来代替确切的文本，例如：

  1 2 3 4

  <%@ taglib uri="http://java.sun.com/jstl/core_rt" prefix="c" %> <%@ taglib uri="http://java.sun.com/jstl/fmt_rt" prefix="fmt" %> ... <fmt:message key="some.key.name" />

• 在Java类中需要国际化的文本可以使用LocalUtils类：

  1	org.jivesoftware.util.LocaleUtils.getLocalizedString("some.key.name", "[plugin_name]");

• 在plugin.xml中需要国际化的文本使用${var}格式：

  1 2	<sidebar id="gateways" name="${plugin.sidebar.name}" description="${plugin.sidebar.description}"> <description>${plugin.description}</description>

 

使用Openfire的Build脚本

Openfire提供的build脚本可以帮助你编译和开发插件。脚本按照下面的目录结构寻找资源：

myplugin/

 |- plugin.xml      <- 插件描述文件
 |- readme.html     <- 插件自述文件
 |- changelog.html  <- 插件更新日志
 |- logo_small.gif  <- 插件小图标
 |- logo_large.gif  <- 插件大图标
 |- classes/        <- 插件的类和properties文件
 |- lib/            <- 插件需要的lib库
 |- src/
     |- database    <- 插件的数据库脚本
     |- java        <- 插件的Java源码
     |   |- com
     |       |- mycompany
     |           |- *.java
     |- web
         |- *.jsp      <- 插件用于管理后台的JSP页面
         |- images/    <- JSP页面中需要的图片文件
         |- WEB-INF
             |- web.xml    <- 当JSP被编译成servlet后，将在该文件中注册

 

build脚本将编译源码和JSP文件，并且按照插件的结构创建一个JAR文件。将你的插件目录拷贝到src/plugins目录下，然后使用命令 ant plugins 就可以编译你的插件了，但是这种方式会编译你所有的插件，如果需要编译一个单独的插件可以这样做：

在bulid目录下添加文件：build.properties内容如下：

packaged.plugin.name=broadcast

然后build.xml文件中加入加入以下target：

 

<target name="build.one.plugin" description="build one plugin">
        <mkdir dir="${plugin.dest.dir}"/>
        <delete dir="${plugin.dev.dest.dir}/${packaged.plugin.name}"/>
        <delete file="${plugin.dev.dest.dir}/${packaged.plugin.name}.jar"/>
        <delete file="${plugin.dest.dir}/${packaged.plugin.name}.jar"/>
<echo>building plugin ${packaged.plugin.name} ..</echo>
        <buildplugin plugin="${packaged.plugin.name}" pluginsrc="${plugin.src.dir}"/>
<delete dir="${target.openfireHome}/plugins/${packaged.plugin.name}"/>
<delete file="${target.openfireHome}/plugins/${packaged.plugin.name}.jar"/>
<copy file="${plugin.dest.dir}/${packaged.plugin.name}.jar" todir="${target.openfireHome}/plugins" overwrite="true"/>
    </target>

 

运行该任务就能将broadcast插件打包。因为在build.xml（3.8.1版本）文件中 68行   <property file="${basedir}/build/build.properties"/>。

如果你想通过打包指定的几个插件可以这样：build.properties内容如下

packaged.plugin.name=broadcast;fastpath

在build.xml文件中再加入如下target：

 <target name="build.more.plugin" description="build more plugin">
     <foreach target="build.one.plugin" param="packaged.plugin.name"   list="${packaged.plugin.name}" delimiter=";">
 </foreach>

</target>

 

这样你就能同时打包插件broadcast，fastpath。

 

你的插件所需要的所有JAR文件需要放到lib目录下。在编译过程中，这些JAR文件同样会被复制到插件的lib目录下。

如果你创建了一个src/web/WEB-INF/web.xml文件，当插件启动时，注册其中的servlet将被初始化。只有web.xml中注册和 映射的servlet将被认可。注意：此功能是通过JSP编译过程中所生成的web.xml文件合并到自定义的web.xml文件实现的。

实现你自己的插件

插件可以使用所有的Openfire API，这为插件的功能提供了极大的灵活性。下面有几种最常用的集成方式：

• 注册一个插件作为一个组件。组件可以接收发送给特定子域的所有数据包。例如，test_component.example.com，发送给 joe@test_component.example.com的数据包将被分发到该组件。注意：组件中定义的子域与DNS的子域是无关的。所有的 XMPP路由在socket级别已经通过使用主服务器域名完成路由（如example.com），子域名只用于XMPP服务器内部路由。
• 注册一个插件作为IQHandler，IQ处理器在特定的命名空间内相应IQ数据包，下面的代码片段展示如何注册一个IQHandler：

  1 2 3

  IQHandler myHandler = new MyIQHander(); IQRouter iqRouter = XMPPServer.getInstance().getIQRouter(); iqRouter.addHandler(myHandler);

• 注册一个插件作为PacketInterceptor，用于接收所有的数据包，并且可以随意的抛弃他们。例如，一个拦截器可以抛弃所有包含禁词的消息，或者标记他们让管理员进行审核。
• 你可以持久化存储插件的设置，通过使用JiveGlobals.getProperty(String)和 JiveGlobals.setProperty(String,String)方法，作为Openfire的属性。通过实现 org.jivesoftware.util.PropertyEventListener的方法，使你的插件可以监听他的属性值的变化。你可以使用 PropertyEventDispatcher.addListener(PropertyEventListener)方法注册你的插件作为一个监听器。务必在插件的destroyPlugin方法中注销你的插件。

常见问题

我可以使用一个目录而不是JAR文件来部署插件吗？

不可以，所有的插件必须使用JAR或者WAR文件来部署。当plugin目录下的JAR或者WAR文件不存在时，Openfire会认为该文件已经被删除用户期望卸载该插件，然后会同步删除对应的目录。