1時間でOpenfire用のJabberボット

約2年間、ICQ用のボットを開発しています。 最近の一連のイベントの後、ICQボットはしばしば動作不能であることが判明し、また記事「jabberボットの紹介」の後、Jabberのボットの開発に関連する問題を研究したいと強く望みました。

この投稿では、この分野での最初の経験を皆さんと共有したいと思います。 簡単なJabberボットをゼロから記述し、1時間だけを費やす方法を説明します。

ボットを開発するためのプラットフォームとして、 Openfireを選択しました 。 この選択は、OpenfireがJavaで書かれているという事実に影響されました（私は絶対にPythonのようなものを学びたくありませんでした）。 Openfireのプラグイン構造により、ボット機能を迅速かつ便利に固定できます。 さらに、Openfireは簡単に構成でき、それまでに既にjabberサーバーとしてインストールされていました。

環境を設定する

まず、Openfireとそのプラグインをビルドして実行できる開発環境をセットアップする必要があります。 Windowsのインストールプロセスは次のとおりです。 他のオペレーティングシステムでは、プロセスは次のようになります。

1. Java SE Development Kit（JDK）をダウンロードしてインストールします 。 ここで取ることができます 。 JDKをC：\ Program Files \ Java （デフォルトのフォルダー）にインストールしました。 C：\ Program Files \ Javaにインストールした後、サブフォルダーjdk1.6.0_12およびjre6が表示されました 。
2. Java開発者向けのEclipse IDEは こちらからダウンロードしてください 。 同じフォルダーC：\ Program Files \ Javaに解凍します 。 その結果、別のサブフォルダー-eclipseが表示されます。
3. 環境変数を設定します（これは、 [マイコンピューター]> [プロパティ]> [詳細設定]> [環境変数]で行います ）：
   
   
   • JAVA_HOME = C：\ Program Files \ Java \ jdk1.6.0_12 JDKを別のフォルダーに解凍した場合は、適切なパスを指定します。
   • C：\ Program Files \ Java \ jre6 \ binを Path変数に追加します（パスが正しいことも確認します）。
4. 再起動します。
5. Eclipseを起動します。これにより、Workspace、つまりプロジェクトを配置するディレクトリを選択するように求められます。 C：\ Editとしましょう。 ワークスペースを選択すると、ようこそ画面が表示され、すぐに閉じることができます。

Openfireをビルドする

次に、2番目の段階、つまりOpenfireの構築と起動に進みます。 指示に正確に従うようにしてください。そうしないと、すぐに何も機能しない可能性があります。

1. ここから Openfireソースをダウンロードします 。 Openfire自体に加えて、アーカイブにはすべての無料プラグインのソースコードが含まれています。 プラグインを開発するとき、そのコードを調べることができます。
2. ソースアーカイブにはopenfire_srcフォルダーが含まれています。 C：\ Editで解凍します。
3. Eclipseに移動し、ソースに従って新しいプロジェクトを作成します。 これを行うには、メニューから[ ファイル]> [新規]> [プロジェクト]> [Javaプロジェクト ]を選択します。 新しいJavaプロジェクトを作成するためのウィンドウが表示されます。 次のように記述します。
   
   
   • プロジェクト名 = openfire_src
   • 既存のソースからプロジェクトを作成をマークします 。 ディレクトリで、 C：\ Edit \ openfire_srcを指定します。
   • 完了をクリックします。
4. Eclipseがプロジェクトを作成したら、それをビルドします。 これを行うには、メニューから「 ウィンドウ」>「ビューを表示」>「Ant」を選択します。 EclipseワークスペースにAntパネルが表示されます。 それを右クリックし、ドロップダウンメニューから[ ビルドファイルの追加 ]を選択します。
5. 表示されるツリーで、 openfire_src> build> build.xmlを選択します。 OKをクリックします。
6. Openfire XMPPサーバーが多くのビルドオプションとともにAntパネルに表示されます。
7. Openfireをビルドします。 これを行うには、ツリー内でopenfire [default]というアセンブリオプションを見つけてダブルクリックします。 ツリーのルート要素をクリックすることもできます。
8. アセンブリを開始するとすぐに、Eclipseにコンソールが表示され、アセンブリの進行状況に関する情報が表示されます。 私たちは、碑文が成功するのを待っています。
9. 次に、Openfireの起動パラメーターを構成します。これを実行するには、 [実行 ] > [構成の実行 ]メニューに移動します。
10. 表示されるウィンドウで、 Javaアプリケーションをダブルクリックします 。 新しい構成を作成していますが、アセンブリを正しく開始するように構成する必要があります。 以下を記述します。
    
    
    • 名前 = Openfire （または重要ではない任意のもの）。
    • プロジェクト = openfire_src
    • メインクラス = org.jivesoftware.openfire.starter.ServerStarter
    • VM 引数の [ 引数 ]タブで、 -DopenfireHome = "target / openfire"と記述します 。 -Dの後にスペースがないことに注意してください。
    • [ クラスパス ]タブで、[ ユーザーエントリ ]を選択し、[ 詳細設定 ]ボタンをクリックします。 [ フォルダーの追加]を選択し、 openfire_src \ src \ i18n フォルダーを追加します。 その後、同様にopenfire_src \ src \ resources \ jarフォルダーを追加します。
    • [ 適用] 、[ 実行]の順にクリックします 。

すべてが正常に完了すると、Openfireのバージョンを示す行と、管理者のコンソールがポート9090でリッスンしていることを示すメッセージがコンソールに表示されます。作業の主な部分はすでに遅れているため、コーヒーを飲むことができます。 また、大切な碑文がコンソールに表示されなかった人々に精神的に同情することができます。 後者に目を向ける-行動の順序を注意深く確認してください。 先に警告したように、指示は正確に守らなければならず、余分なことは何もしません。

Openfireをカスタマイズする

続けます。 次に、Openfireサーバー自体を構成する必要があります。 ブラウザにlocalhost ：9090と入力すると、構成手順が開始されます。 ここではすべてが非常に簡単です。 開発用の構成を設定しているので、特に哲学はしません。

• [サーバー設定]ページで、デフォルトのポートであるサーバー名 = localhostを設定します。
• [データベースの設定]ページで、[ 埋め込み データベース]を選択します。
• [プロファイル設定]ページでは、すべてをデフォルトのままにします。
• [ 管理者アカウント]ページで、存在しないメールボックスを入力します。 また、管理者パスワードを入力して記憶します。

その後、管理コンソールへのログインを選択し、認証ページに移動できます。 前に指定したパスワードで管理者アカウントでログインする必要があります。 同じadminの下で、任意のjabber-clientを使用してサーバーに接続することもできます。 すべてが正常であれば、サーバーを停止して次の手順に進むことができます。

ボットを書く

それで、最も重要な段階に到達しました。 次に、ボットの機能を実装するプラグインを作成する必要があります。

Openfireプラグインのすべてのソースは、 openfire_src \ src \ pluginsフォルダーにあります。 各プラグインには、少なくともプラグインの説明を含むplugin.xmlファイルと、プラグインのメインクラスの説明を含むJavaファイルが含まれる個別のフォルダーがあります。 詳細については、Openfireのドキュメントを参照してください（たとえば、 openfire_src \ documentation \ docs \ plugin-dev-guide.htmlを参照 ）。

新しいプラグインのフォルダーopenfire_src \ src \ plugins \ simplebotを作成します。 その中で、plugin.xmlファイルを開始し、そこに次の内容を書き込みます。

<? xml version ="1.0" encoding ="UTF-8" ? > <br><br> < plugin > <br> < class > org.jivesoftware.openfire.plugin.simplebot </ class > <br> < name > Simple Bot </ name > <br> < description > Provides simple bot functionality. </ description > <br> < author > Habrahabr </ author > <br> < version > 1.0.0 </ version > <br> < date > 18/2/2009 </ date > <br> < minServerVersion > 3.5.0 </ minServerVersion > <br> </ plugin > <br><br> <br> * This source code was highlighted with Source Code Highlighter .

次に、プラグインのソースコードを格納するフォルダーを作成する必要があります。 より正確には、一連のサブフォルダーになります： openfire_src \ src \ plugins \ simplebot \ src \ java \ org \ jivesoftware \ openfire \ plugin 各Openfireプラグインにはメインクラスへの同じパスがあるため、これらすべてのフォルダーを手動で作成するのではなく、単にMOTDプラグインからコピーしてから、古いコンテンツを削除しました。

最後に行うことは、ボットソースをopenfire_src \ src \ plugins \ simplebot \ src \ java \ org \ jivesoftware \ openfire \ pluginフォルダに配置することです。 これを行うには、 そこにsimplebot.javaファイルを作成し（大文字と小文字が重要です）、ソースコードをその中にコピーします。

package org.jivesoftware.openfire.plugin;<br><br>import java.io.File;<br>import org.jivesoftware.openfire.container.Plugin;<br>import org.jivesoftware.openfire.container.PluginManager;<br>import org.jivesoftware.openfire.XMPPServer;<br>import org.jivesoftware.openfire.auth.AuthToken;<br>import org.jivesoftware.openfire.multiplex.ClientSessionConnection;<br>import org.jivesoftware.openfire.SessionManager;<br>import org.jivesoftware.openfire.SessionPacketRouter;<br>import org.jivesoftware.openfire.session.Session;<br>import org.jivesoftware.openfire.session.LocalClientSession;<br>import org.jivesoftware.openfire.interceptor.*;<br>import org.xmpp.packet.*;<br><br> // <br> // Simple Bot Plugin <br> // <br> public class simplebot implements Plugin {<br><br> private JID myJID;<br> private LocalClientSession mySession;<br> private myPacketInterceptor myInterceptor = new myPacketInterceptor();<br><br> public void initializePlugin(PluginManager manager, File pluginDirectory) {<br> System. out .println( "Starting Simple Bot Plugin" );<br> <br> myJID = new JID( "test" , XMPPServer.getInstance().getServerInfo().getXMPPDomain(), "simplebot" );<br> <br> ClientSessionConnection connection = <br> new ClientSessionConnection(XMPPServer.getInstance().getConnectionManager().getClass().getName(),<br> "localhost" , "127.0.0.1" );<br> mySession = SessionManager.getInstance().createClientSession(connection);<br> mySession.setAuthToken( new AuthToken(myJID.getNode()), myJID.getResource());<br> <br> InterceptorManager.getInstance().addInterceptor(myInterceptor);<br> } // initializePlugin <br><br> public void destroyPlugin() {<br> // Resources are no longer needed <br> InterceptorManager.getInstance().removeInterceptor(myInterceptor);<br> mySession.close();<br><br> myJID = null ;<br> mySession = null ;<br> myInterceptor = null ;<br> } // destroyPlugin <br> <br> private class myPacketInterceptor implements PacketInterceptor {<br> <br> public void interceptPacket(Packet packet,<br> Session session,<br> boolean incoming,<br> boolean processed) throws PacketRejectedException<br> {<br> // If there is an incoming message for the bot <br> if (packet instanceof Message &&<br> packet.getTo().getNode().equals(myJID.getNode()) &&<br> incoming == true &&<br> processed == true )<br> {<br> // Create the response ... <br> Message message = new Message();<br> message.setTo(packet.getFrom());<br> message.setFrom(packet.getTo());<br> message.setSubject( "" );<br> message.setBody( "Hello from Simple OpenFire Bot" );<br> <br> // ... and send it <br> SessionPacketRouter router = new SessionPacketRouter(mySession);<br> router.route(message);<br> }<br> } // interceptPacket <br> <br> } // myPacketInterceptor <br><br>} // simplebot <br><br> <br> * This source code was highlighted with Source Code Highlighter .

すぐに、これは私がなんとか達成した作業コードの最小量であることに注意してください。 すべての追加機能とすべてのチェックがスローされます。 ボットは、ステータスを変更する方法を知らず、ユーザーを認証する方法も知りません。 しかし、彼は「Hello from Simple OpenFire Bot」というフレーズを使用して、すべての着信メッセージに安定して応答します。

それがどのように機能するかを見てみましょう。 プラグインのメインクラスは、内部に2つの関数を持つプラグインインターフェースの実装です。

• initializePlugin-起動時にプラグインを初期化します。 ここで、 myJID変数を初期化します。この変数には、 test @ domain \ simplebotという形式のボットJIDが含まれます。 localhostで実行する場合、これはそれぞれtest @ localhost \ simplebotになります 。 次に、JIDの新しいセッションを作成します。 これを行うには、サーバーへの接続（ connection ）を確立し、この接続内にセッション（ mySession ）を作成する必要があります。 結論として、このセッションでユーザーを承認する必要があります。
• destroyPlugin-プラグインが破棄されるときに呼び出されます。 ここでは、以前にキャプチャしたすべてのリソースをリリースします。

さらに、プラグインのメインクラスには、 PacketInterceptorインターフェイスを実装する補助クラスmyPacketInterceptorが含まれています。 このクラスは、Openfireサーバーを通過するすべてのメッセージをインターセプトします（このため、 initializePlugin内で、このクラスのインスタンスをサブスクライブして、 InterceptorManagerを使用してメッセージをインターセプトします）。 これで、メッセージが表示されると、このクラスのinterceptPacket関数が呼び出されます。 あとは、この関数内でJID宛てのメッセージを選択し、「Hello from Simple OpenFire Bot」というフレーズで返信するだけです。

次に、プラグインをビルドしてからOpenfireを実行する必要があります。 プラグイン（および他のすべてのプラグイン）をビルドするには、Antパネルでプラグインターゲットをダブルクリックする必要があります（ pluginと混同しないでください）。 その後、コンソールにBUILD SUCCESSFULが表示されるまで待ちます。 これで、コンソールでOpenfireを起動すると、特に「 シンプルボットプラグインの起動 」という碑文が表示されます。

さて、これですべてのjabberクライアントで（ 管理者アカウントを使用して）サーバーに接続し、 test @ localhostにメッセージを書き込んでボットをチェックできるようになりました。

次は？

前述したように、ここで説明するボットには最も控えめな機能が備わっています。 現在、追加機能を追加しており、それに関する一連のメモを作成する予定です。

いずれにせよ、ジャバーボットの開発は実際には一見したように難しくないという考えを願っています。