XMPP XEP-0133 服务管理

文章目录
  1. 1. 配置环境
  2. 2. 获取用户注册数
  3. 3. 获取注册用户列表
    1. 3.1. Ejabberd 实现
  4. 4. 获取在线用户列表
    1. 4.1. Ejabberd 实现
    2. 4.2. 标准实现
  5. 5. 广播通知
    1. 5.1. Ejabberd 实现
    2. 5.2. XEP 标准实现
  6. 6. 参考资料

本文说明了如何使用Javascript Strophe.js 实现XEP-0133扩展协议定义的XMPP服务器管理功能,

  1. 添加用户
  2. 删除用户
  3. 禁用一个用户
  4. 重新启用一个用户
  5. 结束用户会话
  6. 获取用户密码
  7. 修改用户密码
  8. 获取用户名册(联系人列表)
  9. 获取用户最后登录时间
  10. 获取用户统计
  11. 编辑黑名单
  12. 编辑白名单
  13. 获取已注册用户数
  14. 获取禁止用户数
  15. 获取在线用户数
  16. 获取活动用户数
  17. 获取空闲用户数
  18. 获取已注册用户列表
  19. 获取被禁止的用户列表
  20. 获取在线用户类别
  21. 获取活动用户列表
  22. 获取空闲用户列表
  23. 向在线用户发送通告
  24. 设置MOTD(Message of the Day)
  25. 编辑MOTD
  26. 删除MOTD
  27. 设置欢迎消息
  28. 删除欢迎消息
  29. 编辑管理员列表
  30. 重启服务
  31. 关闭服务

配置环境

操作系统 XMPP服务器 客户端库
Ubuntu 14.04 Ejabberd 14.07 Strophe.js

使用node-xmpp-bosh作为Websocket代理连接到Ejabberd, node-xmpp-bosh的安装和配置请看我写的这篇文章, 使用XEP-0133相关功能需要管理员账号, 在/etc/ejabberd/ejabberd.yml 的 acl 部分添加一个管理员账号 root@xmpp.myserver.info

1
...
...
...
###'   ACCESS CONTROL LISTS
acl:
  ##
  ## The 'admin' ACL grants administrative privileges to XMPP accounts.
  ## You can put here as many accounts as you want.
  ##
  admin:
     user:
       - "root": "xmpp.myserver.info"
...
...
...

获取用户注册数

  • 请求:

    1
    <iq to='xmpp.myserver.info' type='set' xml:lang='en' xmlns='jabber:client'>
  <command xmlns='http://jabber.org/protocol/commands'
           node='http://jabber.org/protocol/admin#get-registered-users-num'
           action='execute'/>
</iq>

  • 响应:

1
<iq from="xmpp.myserver.info"
    to="root@xmpp.myserver.info/40924564951411172979418239"
    type="result" xmlns="jabber:client"
    xmlns:stream="http://etherx.jabber.org/streams"
    version="1.0">
  <command xmlns="http://jabber.org/protocol/commands"
           sessionid="2014-09-20T00:29:51.291298Z"
           node="http://jabber.org/protocol/admin#get-registered-users-num"
           status="completed">
    <x xmlns="jabber:x:data">
      <field type="hidden" var="FORM_TYPE">
        <value>http://jabber.org/protocol/admin</value>
      </field>
      <field type="text-single" label="Number of registered users" var="registeredusersnum">
        <value>13</value>
      </field>
    </x>
  </command>
</iq>
  • Strophe.js代码:
1
var admin = {
  /**
   * 获取注册用户数
   * @return integer
   */
  get_register_users_number: function () {
    var iq = $iq({
      to: session.domain,
      type: 'set',
      'xml:lang': 'en'
    }).c('command', {
        xmlns: 'http://jabber.org/protocol/commands',
        node: 'http://jabber.org/protocol/admin#get-registered-users-num',
        action: 'execute'
      });
    connection.send(iq.tree());
  }
};

获取注册用户列表

Ejabberd实现和XEP-0133扩展协议有差异, Ejabberd使用非标准的方式获取已注册用户列表

Ejabberd 实现

  • 请求
1
<iq xmlns='jabber:client' type='get' to='xmpp.myserver.info' from='root@xmpp.myserver.info'>
  <query xmlns='http://jabber.org/protocol/disco#items' node='all users'/>
</iq>
  • 响应
1
# 响应IQ节
<iq
    from="xmpp.myserver.info"
    to="root@xmpp.myserver.info/231005051114111783732339"
    type="result" xmlns="jabber:client"
    xmlns:stream="http://etherx.jabber.org/streams"
    version="1.0">
  <query xmlns="http://jabber.org/protocol/disco#items" node="all users">
    <item jid="hezhiqiang@xmpp.myserver.info" name="hezhiqiang@xmpp.myserver.info"/>
    <item jid="root@xmpp.myserver.info" name="root@xmpp.myserver.info"/>
    <item jid="test1@xmpp.myserver.info" name="test1@xmpp.myserver.info"/>
    <item jid="test10@xmpp.myserver.info" name="test10@xmpp.myserver.info"/>
    <item jid="test2@xmpp.myserver.info" name="test2@xmpp.myserver.info"/>
    <item jid="test3@xmpp.myserver.info" name="test3@xmpp.myserver.info"/>
    <item jid="test4@xmpp.myserver.info" name="test4@xmpp.myserver.info"/>
    <item jid="test5@xmpp.myserver.info" name="test5@xmpp.myserver.info"/>
    <item jid="test6@xmpp.myserver.info" name="test6@xmpp.myserver.info"/>
    <item jid="test7@xmpp.myserver.info" name="test7@xmpp.myserver.info"/>
    <item jid="test8@xmpp.myserver.info" name="test8@xmpp.myserver.info"/>
    <item jid="test9@xmpp.myserver.info" name="test9@xmpp.myserver.info"/>
    <item jid="user2@xmpp.myserver.info" name="user2@xmpp.myserver.info"/>
  </query>
</iq>
  • Strophe.js代码:
1
function ServiceAdministration(host) {
  this.node_prefix = 'http://jabber.org/protocol/admin#';
  this.nodes = {
    ADD_USER: 'add-user',
    DELETE_USER: 'delete-user',
    DISABLE_USER: 'disable-user',
    REENABLE_USER: 'reenable-user',
    END_USER_SESSION: 'end-user-session',
    GET_USER_PASSWORD: 'get-user-password',
    CHANGE_USER_PASSWORD: 'change-user-password',
    GET_USER_ROSTER: 'get-user-roster',
    GET_USER_LASTLOGIN: 'get-user-lastlogin',
    USER_STATS: 'user-stats',
    EDIT_BLACKLIST: 'edit-blacklist',
    EDIT_WHITELIST: 'edit-whitelist',
    GET_REGISTERED_USERS_NUM: 'get-registered-users-num',
    GET_DISABLED_USERS_NUM: 'get-disabled-users-num',
    GET_ONLINE_USERS_NUM: 'get-online-users-num',
    GET_ACTIVE_USERS_NUM: 'get-active-users-num',
    GET_IDLE_USERS_NUM: 'get-idle-users-num',
    // Ejabberd 实现方式和XEP-0133标准有却别
    GET_REGISTERED_USERS_LIST_EJABBERD: 'all users',
    GET_REGISTERED_USERS_LIST: 'get-registered-users-list',
    GET_DISABLED_USERS_LIST: 'get-disabled-users-list',
    GET_ONLINE_USERS_LIST: 'get-online-users-list',
    GET_ACTIVE_USERS: 'get-active-users',
    GET_IDLE_USERS: 'get-idle-users',
    ANNOUNCE: 'announce',
    SET_MOTD: 'set-motd',
    EDIT_MOTD: 'edit-motd',
    DELETE_MOTD: 'delete-motd',
    SET_WELCOME: 'set-welcome',
    DELETE_WELCOME: 'delete-welcome',
    EDIT_ADMIN: 'edit-admin',
    RESTART: 'restart',
    SHUTDOWN: 'shutdown'
  };
  this.base_iq = {
    xmlns: 'jabber:client',
    type: 'set',
    to: host
  };
  this.getCopyBaseIQ = function () {
    return JSON.parse(JSON.stringify(this.base_iq));
  };
  this.getCommand = function (node) {
    return Strophe.xmlElement('command', {
        xmlns: 'http://jabber.org/protocol/commands',
        action: 'execute',
        node: this.node_prefix + node
    });
  };
  this.send = function (iq) {
    connection.send(iq.tree());
  };
  this.addUser = function () {
    var iq_attributes = this.getCopyBaseIQ();
    iq_attributes.from = jid;
    iq_attributes.to = session.domain;
    var iq = $iq(iq_attributes).cnode(this.getCommand(this.nodes.ADD_USER));
    this.send(iq);
  };
  this.getRegisterUserNumber = function () {
    var iq_attributes = this.getCopyBaseIQ();
    iq_attributes.from = jid;
    iq_attributes.to = session.domain;
    var iq = $iq(iq_attributes).cnode(this.getCommand(this.nodes.GET_REGISTERED_USERS_NUM));
    this.send(iq);
  };
  this.getRegisterUserList = function () {
    var iq_attributes = this.getCopyBaseIQ();
    iq_attributes.from = jid;
    iq_attributes.to = session.domain;
    var iq = $iq(iq_attributes).cnode(this.getCommand(this.nodes.GET_REGISTERED_USERS_LIST));
    this.send(iq);
  };
  /**
   * Ejabberd实现方式不兼容XEP-0133, Ejabberd采用Disco服务发现机制获取注册用户列表
   */
  this.getRegisterUserList2 = function () {
    var iq_attributes = this.getCopyBaseIQ();
    iq_attributes.from = jid;
    iq_attributes.to = session.domain;
    iq_attributes.type = 'get';
    var iq = $iq(iq_attributes).c('query', {
      xmlns: 'http://jabber.org/protocol/disco#items',
      node: this.nodes.GET_REGISTERED_USERS_LIST_EJABBERD
    });
    this.send(iq);
  };
};
var client_session = {
  user: 'root',
  domain: 'xmpp.myserver.info'
};
var serviceadmin = new ServiceAdministration(client_session.domain);
serviceadmin.getRegisterUserList2();

获取在线用户列表

和上面获取注册用户列表一样,此功能点在Ejabberd中的实现同样是非标准的.

Ejabberd 实现

  • 请求
1
<iq xmlns='jabber:client' type='get' to='xmpp.myserver.info' from='root@xmpp.myserver.info'>
  <query xmlns='http://jabber.org/protocol/disco#items' node='online users'/>
</iq>
  • 响应
1
<iq from="xmpp.myserver.info"
    to="root@xmpp.myserver.info/23683713071411180214453150"
    type="result"
    xmlns="jabber:client"
    xmlns:stream="http://etherx.jabber.org/streams"
    version="1.0">
  <query xmlns="http://jabber.org/protocol/disco#items" node="online users">
    <item jid="hezhiqiang@xmpp.myserver.info/hezhiqiang-2" name="hezhiqiang@xmpp.myserver.info"/>
    <item jid="root@xmpp.myserver.info/23683713071411180214453150" name="root@xmpp.myserver.info"/>
  </query>
</iq>
  • Strophe.js代码片段
1
this.getOnlineUserList2 = function(){
    var iq_attributes = this.getCopyBaseIQ();
    iq_attributes.from = jid;
    iq_attributes.to = session.domain;
    iq_attributes.type = 'get';
    var iq = $iq(iq_attributes).c('query', {
      xmlns: 'http://jabber.org/protocol/disco#items',
      node: this.nodes.GET_ONLINE_USERS_LIST_EJABBERD
    });
    this.send(iq);
};

标准实现

待测试

广播通知

Ejabberd 实现

作为系统通知显示在右上角的Adium客户端广播通知

  • 请求
1
<message to='xmpp.myserver.info/announce/all' xmlns='jabber:client'>
  <subject>Server Notification</subject>
  <body>Server will be upgrade in 2014-09-21 00:00:00, sorry for inconveniences</body>
  <nick xmlns='http://jabber.org/protocol/nick'>系统</nick>
</message>
  • 响应
1
<message
    from="xmpp.myserver.info"
    to="root@xmpp.myserver.info"
    xmlns="jabber:client" xmlns:stream="http://etherx.jabber.org/streams" version="1.0">
  <subject>Server Notification</subject>
  <body>Server will be upgrade in 2014-09-21 00:00:00, sorry for inconveniences</body>
  <nick xmlns="http://jabber.org/protocol/nick">系统</nick>
</message>
  • Strophe.js 代码片段
1
this.ejabberdAnnounce = function (range) {
  var range = range || 'all';
  var iq = $msg({to: session.domain + '/announce/'+range})
    .cnode(Strophe.xmlElement('subject', {}, 'Server Notification')).up()
    .cnode(Strophe.xmlElement(
      'body', {}, 'Server will be upgrade in 2014-09-21 00:00:00, sorry for inconveniences')
    ).up()
    .cnode(Strophe.xmlElement('nick', {xmlns: 'http://jabber.org/protocol/nick'}, '系统'));
  this.send(iq);
}

XEP 标准实现

  • 请求
1
<iq xmlns='jabber:client' type='set' to='xmpp.myserver.info' from='root@xmpp.myserver.info'>
  <command xmlns='http://jabber.org/protocol/commands' node='http://jabber.org/protocol/admin#announce'>
    <x xmlns='jabber:x:data' type='submit'>
      <field type='hidden' var='FROM_TYPE'>
        <value>http://jabber.org/protocol/admin</value>
      </field>
      <field var='announcement'>
        <value>Attention! This service will be going down for</value>
        <value>maintenance in 2 minutes. Please log off now!</value>
        <value>We apologize for the inconvenience.</value>
      </field>
    </x>
  </command>
</iq>
  • Ejabberd 错误响应
1
<iq from="xmpp.myserver.info" to="root@xmpp.myserver.info/13819390371411184835813106"
    type="error"
    xmlns="jabber:client"
    xmlns:stream="http://etherx.jabber.org/streams" version="1.0">
  <command
    xmlns="http://jabber.org/protocol/commands"
    node="http://jabber.org/protocol/admin#announce">
    <x xmlns="jabber:x:data" type="submit">
      <field type="hidden" var="FROM_TYPE">
        <value>http://jabber.org/protocol/admin</value>
      </field>
      <field var="announcement">
        <value>Attention! This service will be going down for</value>
        <value>maintenance in 2 minutes. Please log off now!</value>
        <value>We apologize for the inconvenience.</value>
      </field>
    </x>
  </command>
  <error code="406" type="modify">
    <not-acceptable xmlns="urn:ietf:params:xml:ns:xmpp-stanzas"/>
    <text xmlns="urn:ietf:params:xml:ns:xmpp-stanzas">No body provided for announce message</text>
  </error>
</iq>

TODO::其他按标准实现的服务器暂时未测试,深入研究后在补全

Strophe.js 代码片段

1
this.announce = function () {
  var iq_attributes = this.getCopyBaseIQ();
  iq_attributes.from = jid;
  iq_attributes.to = session.domain;
  var iq = $iq(iq_attributes)
    .c('command', {
      xmlns: 'http://jabber.org/protocol/commands',
      node: 'http://jabber.org/protocol/admin#announce'
    })
    .c('x', {xmlns: 'jabber:x:data', type: 'submit'})
    .c('field', {type: 'hidden', var: 'FROM_TYPE'})
    .cnode(Strophe.xmlElement('value', {}, 'http://jabber.org/protocol/admin'))
    .up().up()
    .c('field', {var: 'announcement'})
    .cnode(Strophe.xmlElement('value', {}, 'Attention! This service will be going down for'))
    .up()
    .cnode(Strophe.xmlElement('value', {}, 'maintenance in 2 minutes. Please log off now!'))
    .up()
    .cnode(Strophe.xmlElement('value', {}, 'We apologize for the inconvenience.'));
  this.send(iq);
};

参考资料

  1. XEP-0133 http://xmpp.org/extensions/xep-0133.html
  2. Strophe.js API Doc http://strophe.im/strophejs/doc/1.1.3/files/strophe-js.html
  3. Ejabberd Guide http://www.process-one.net/docs/ejabberd/guide_en.html