2003-11-11 21:51:04 +01:00
< !DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
"http://www.w3.org/TR/REC-html40/loose.dtd">
< HTML >
2005-12-16 17:33:42 +01:00
< HEAD >
2011-05-31 10:14:19 +02:00
< TITLE > Ejabberd 2.1.7 Developers Guide
2007-12-06 20:47:49 +01:00
< / TITLE >
2005-12-16 17:33:42 +01:00
2007-12-06 20:47:49 +01:00
< META http-equiv = "Content-Type" content = "text/html; charset=US-ASCII" >
< META name = "GENERATOR" content = "hevea 1.10" >
2005-12-16 17:33:42 +01:00
< STYLE type = "text/css" >
2007-12-06 20:47:49 +01:00
.li-itemize{margin:1ex 0ex;}
.li-enumerate{margin:1ex 0ex;}
.dd-description{margin:0ex 0ex 1ex 4ex;}
.dt-description{margin:0ex;}
2005-12-16 17:33:42 +01:00
.toc{list-style:none;}
2007-12-06 20:47:49 +01:00
.thefootnotes{text-align:left;margin:0ex;}
.dt-thefootnotes{margin:0em;}
.dd-thefootnotes{margin:0em 0em 0em 2em;}
.footnoterule{margin:1em auto 1em 0px;width:50%;}
.caption{padding-left:2ex; padding-right:2ex; margin-left:auto; margin-right:auto}
.title{margin:2ex auto;text-align:center}
2005-12-16 17:33:42 +01:00
.center{text-align:center;margin-left:auto;margin-right:auto;}
.flushleft{text-align:left;margin-left:0ex;margin-right:auto;}
.flushright{text-align:right;margin-left:auto;margin-right:0ex;}
DIV TABLE{margin-left:inherit;margin-right:inherit;}
PRE{text-align:left;margin-left:0ex;margin-right:auto;}
BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}
2007-12-06 20:47:49 +01:00
TD P{margin:0px;}
.boxed{border:1px solid black}
.textboxed{border:1px solid black}
.vbar{border:none;width:2px;background-color:black;}
.hbar{border:none;height:2px;width:100%;background-color:black;}
.hfill{border:none;height:1px;width:200%;background-color:black;}
.vdisplay{border-collapse:separate;border-spacing:2px;width:auto; empty-cells:show; border:2px solid red;}
.vdcell{white-space:nowrap;padding:0px;width:auto; border:2px solid green;}
.display{border-collapse:separate;border-spacing:2px;width:auto; border:none;}
.dcell{white-space:nowrap;padding:0px;width:auto; border:none;}
.dcenter{margin:0ex auto;}
.vdcenter{border:solid #FF8000 2px; margin:0ex auto;}
.minipage{text-align:left; margin-left:0em; margin-right:auto;}
.marginpar{border:solid thin black; width:20%; text-align:left;}
.marginparleft{float:left; margin-left:0ex; margin-right:1ex;}
.marginparright{float:right; margin-left:1ex; margin-right:0ex;}
.theorem{text-align:left;margin:1ex auto 1ex 0ex;}
.part{margin:2ex auto;text-align:center}
2005-12-16 17:33:42 +01:00
< / STYLE >
2003-11-11 21:51:04 +01:00
< / HEAD >
< BODY >
2008-03-31 12:36:41 +02:00
<!-- HEVEA command line is: /usr/bin/hevea - fix - pedantic dev.tex -->
2007-12-06 20:47:49 +01:00
<!-- CUT DEF section 1 --> < P > < A NAME = "titlepage" > < / A >
2003-11-11 21:51:04 +01:00
2011-05-31 10:14:19 +02:00
< / P > < TABLE CLASS = "title" > < TR > < TD > < H1 CLASS = "titlemain" > Ejabberd 2.1.7 Developers Guide< / H1 > < H3 CLASS = "titlerest" > Alexey Shchepin< BR >
2007-12-06 20:47:49 +01:00
< A HREF = "mailto:alexey@sevcom.net" > < TT > mailto:alexey@sevcom.net< / TT > < / A > < BR >
< A HREF = "xmpp:aleksey@jabber.ru" > < TT > xmpp:aleksey@jabber.ru< / TT > < / A > < / H3 > < / TD > < / TR >
< / TABLE > < DIV CLASS = "center" >
2003-11-11 21:51:04 +01:00
2007-12-06 20:47:49 +01:00
< IMG SRC = "logo.png" ALT = "logo.png" >
2003-11-11 21:51:04 +01:00
2007-12-01 17:43:04 +01:00
2007-12-06 20:47:49 +01:00
< / DIV > < BLOCKQUOTE CLASS = "quotation" > < I > I can thoroughly recommend ejabberd for ease of setup –
Kevin Smith, Current maintainer of the Psi project< / I > < / BLOCKQUOTE > <!-- TOC section Contents -->
< H2 CLASS = "section" > <!-- SEC ANCHOR --> Contents< / H2 > <!-- SEC END --> < UL CLASS = "toc" > < LI CLASS = "li-toc" >
< A HREF = "#htoc1" > 1    Key Features< / A >
< / LI > < LI CLASS = "li-toc" > < A HREF = "#htoc2" > 2    Additional Features< / A >
< / LI > < LI CLASS = "li-toc" > < A HREF = "#htoc3" > 3    How it Works< / A >
2007-12-01 17:43:04 +01:00
< UL CLASS = "toc" > < LI CLASS = "li-toc" >
2007-12-06 20:47:49 +01:00
< A HREF = "#htoc4" > 3.1    Router< / A >
< / LI > < LI CLASS = "li-toc" > < A HREF = "#htoc5" > 3.2    Local Router< / A >
< / LI > < LI CLASS = "li-toc" > < A HREF = "#htoc6" > 3.3    Session Manager< / A >
< / LI > < LI CLASS = "li-toc" > < A HREF = "#htoc7" > 3.4    S2S Manager< / A >
< / LI > < / UL >
< / LI > < LI CLASS = "li-toc" > < A HREF = "#htoc8" > 4    Authentication< / A >
2007-12-01 17:43:04 +01:00
< UL CLASS = "toc" >
2005-12-16 17:33:42 +01:00
< UL CLASS = "toc" > < LI CLASS = "li-toc" >
2007-12-06 20:47:49 +01:00
< A HREF = "#htoc9" > 4.0.1    External< / A >
< / LI > < / UL >
2007-12-01 17:43:04 +01:00
< / UL >
2007-12-06 20:47:49 +01:00
< / LI > < LI CLASS = "li-toc" > < A HREF = "#htoc10" > 5    XML Representation< / A >
< / LI > < LI CLASS = "li-toc" > < A HREF = "#htoc11" > 6    Module < TT > xml< / TT > < / A >
< / LI > < LI CLASS = "li-toc" > < A HREF = "#htoc12" > 7    Module < TT > xml_stream< / TT > < / A >
< / LI > < LI CLASS = "li-toc" > < A HREF = "#htoc13" > 8    Modules< / A >
2007-12-01 17:43:04 +01:00
< UL CLASS = "toc" > < LI CLASS = "li-toc" >
2007-12-06 20:47:49 +01:00
< A HREF = "#htoc14" > 8.1    Module gen_iq_handler< / A >
< / LI > < LI CLASS = "li-toc" > < A HREF = "#htoc15" > 8.2    Services< / A >
< / LI > < / UL >
< / LI > < / UL > < P > Introduction
2009-08-12 16:15:59 +02:00
< A NAME = "intro" > < / A > < / P > < P > < TT > ejabberd< / TT > is a free and open source instant messaging server written in < A HREF = "http://www.erlang.org/" > Erlang/OTP< / A > .< / P > < P > < TT > ejabberd< / TT > is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.< / P > < P > < TT > ejabberd< / TT > is designed to be a rock-solid and feature rich XMPP server.< / P > < P > < TT > ejabberd< / TT > is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.< / P > <!-- TOC section Key Features -->
2007-12-06 20:47:49 +01:00
< H2 CLASS = "section" > <!-- SEC ANCHOR --> < A NAME = "htoc1" > 1< / A >     Key Features< / H2 > <!-- SEC END --> < P >
2007-01-11 09:17:18 +01:00
< A NAME = "keyfeatures" > < / A >
2007-12-06 20:47:49 +01:00
< / P > < P > < TT > ejabberd< / TT > is:
< / P > < UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
Cross-platform: < TT > ejabberd< / TT > runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.< / LI > < LI CLASS = "li-itemize" > Distributed: You can run < TT > ejabberd< / TT > on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.< / LI > < LI CLASS = "li-itemize" > Fault-tolerant: You can deploy an < TT > ejabberd< / TT > cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ‘ on the fly’ .< / LI > < LI CLASS = "li-itemize" > Administrator Friendly: < TT > ejabberd< / TT > is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include:
2005-12-16 17:33:42 +01:00
< UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
Comprehensive documentation.
2008-02-04 17:44:42 +01:00
< / LI > < LI CLASS = "li-itemize" > Straightforward installers for Linux, Mac OS X, and Windows. < / LI > < LI CLASS = "li-itemize" > Web Administration.
2007-12-06 20:47:49 +01:00
< / LI > < LI CLASS = "li-itemize" > Shared Roster Groups.
< / LI > < LI CLASS = "li-itemize" > Command line administration tool. < / LI > < LI CLASS = "li-itemize" > Can integrate with existing authentication mechanisms.
< / LI > < LI CLASS = "li-itemize" > Capability to send announce messages.
< / LI > < / UL > < / LI > < LI CLASS = "li-itemize" > Internationalized: < TT > ejabberd< / TT > leads in internationalization. Hence it is very well suited in a globalized world. Related features are:
2005-12-16 17:33:42 +01:00
< UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
2009-09-21 12:03:37 +02:00
Translated to 25 languages. < / LI > < LI CLASS = "li-itemize" > Support for < A HREF = "http://www.ietf.org/rfc/rfc3490.txt" > IDNA< / A > .
2007-12-06 20:47:49 +01:00
< / LI > < / UL > < / LI > < LI CLASS = "li-itemize" > Open Standards: < TT > ejabberd< / TT > is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
2005-12-16 17:33:42 +01:00
< UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
2006-09-22 11:09:28 +02:00
Fully XMPP compliant.
2007-12-06 20:47:49 +01:00
< / LI > < LI CLASS = "li-itemize" > XML-based protocol.
< / LI > < LI CLASS = "li-itemize" > < A HREF = "http://www.ejabberd.im/protocols" > Many protocols supported< / A > .
< / LI > < / UL > < / LI > < / UL > <!-- TOC section Additional Features -->
< H2 CLASS = "section" > <!-- SEC ANCHOR --> < A NAME = "htoc2" > 2< / A >     Additional Features< / H2 > <!-- SEC END --> < P >
2007-01-11 09:17:18 +01:00
< A NAME = "addfeatures" > < / A >
2007-12-06 20:47:49 +01:00
< / P > < P > Moreover, < TT > ejabberd< / TT > comes with a wide range of other state-of-the-art features:
< / P > < UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
2006-06-07 10:38:37 +02:00
Modular
2005-12-16 17:33:42 +01:00
< UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
Load only the modules you want.
2007-12-06 20:47:49 +01:00
< / LI > < LI CLASS = "li-itemize" > Extend < TT > ejabberd< / TT > with your own custom modules.
< / LI > < / UL >
< / LI > < LI CLASS = "li-itemize" > Security
2005-12-16 17:33:42 +01:00
< UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
SASL and STARTTLS for c2s and s2s connections.
2007-12-06 20:47:49 +01:00
< / LI > < LI CLASS = "li-itemize" > STARTTLS and Dialback s2s connections.
2008-02-04 17:44:42 +01:00
< / LI > < LI CLASS = "li-itemize" > Web Admin accessible via HTTPS secure access.
2007-12-06 20:47:49 +01:00
< / LI > < / UL >
< / LI > < LI CLASS = "li-itemize" > Databases
2005-12-16 17:33:42 +01:00
< UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
2008-02-04 17:44:42 +01:00
Internal database for fast deployment (Mnesia).
< / LI > < LI CLASS = "li-itemize" > Native MySQL support.
2007-12-06 20:47:49 +01:00
< / LI > < LI CLASS = "li-itemize" > Native PostgreSQL support.
< / LI > < LI CLASS = "li-itemize" > ODBC data storage support.
< / LI > < LI CLASS = "li-itemize" > Microsoft SQL Server support. < / LI > < / UL >
< / LI > < LI CLASS = "li-itemize" > Authentication
2005-12-16 17:33:42 +01:00
< UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
2008-02-04 17:44:42 +01:00
Internal Authentication.
< / LI > < LI CLASS = "li-itemize" > PAM, LDAP and ODBC. < / LI > < LI CLASS = "li-itemize" > External Authentication script.
2007-12-06 20:47:49 +01:00
< / LI > < / UL >
< / LI > < LI CLASS = "li-itemize" > Others
2005-12-16 17:33:42 +01:00
< UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
2008-02-04 17:44:42 +01:00
Support for virtual hosting.
< / LI > < LI CLASS = "li-itemize" > Compressing XML streams with Stream Compression (< A HREF = "http://www.xmpp.org/extensions/xep-0138.html" > XEP-0138< / A > ).
2007-12-06 20:47:49 +01:00
< / LI > < LI CLASS = "li-itemize" > Statistics via Statistics Gathering (< A HREF = "http://www.xmpp.org/extensions/xep-0039.html" > XEP-0039< / A > ).
< / LI > < LI CLASS = "li-itemize" > IPv6 support both for c2s and s2s connections.
2008-02-04 17:44:42 +01:00
< / LI > < LI CLASS = "li-itemize" > < A HREF = "http://www.xmpp.org/extensions/xep-0045.html" > Multi-User Chat< / A > module with support for clustering and HTML logging. < / LI > < LI CLASS = "li-itemize" > Users Directory based on users vCards.
2008-06-13 17:25:57 +02:00
< / LI > < LI CLASS = "li-itemize" > < A HREF = "http://www.xmpp.org/extensions/xep-0060.html" > Publish-Subscribe< / A > component with support for < A HREF = "http://www.xmpp.org/extensions/xep-0163.html" > Personal Eventing via Pubsub< / A > .
2008-02-04 17:44:42 +01:00
< / LI > < LI CLASS = "li-itemize" > Support for web clients: < A HREF = "http://www.xmpp.org/extensions/xep-0025.html" > HTTP Polling< / A > and < A HREF = "http://www.xmpp.org/extensions/xep-0206.html" > HTTP Binding (BOSH)< / A > services.
2007-12-06 20:47:49 +01:00
< / LI > < LI CLASS = "li-itemize" > IRC transport.
2008-02-04 17:44:42 +01:00
< / LI > < LI CLASS = "li-itemize" > Component support: interface with networks such as AIM, ICQ and MSN installing special tranports.
2007-12-06 20:47:49 +01:00
< / LI > < / UL >
< / LI > < / UL > <!-- TOC section How it Works -->
< H2 CLASS = "section" > <!-- SEC ANCHOR --> < A NAME = "htoc3" > 3< / A >     How it Works< / H2 > <!-- SEC END --> < P >
2009-09-23 17:28:53 +02:00
< A NAME = "howitworks" > < / A > < / P > < P > A XMPP domain is served by one or more < TT > ejabberd< / TT > nodes. These nodes can
2003-11-11 21:51:04 +01:00
be run on different machines that are connected via a network. They all must
have the ability to connect to port 4369 of all another nodes, and must have
the same magic cookie (see Erlang/OTP documentation, in other words the file
< TT > ~ejabberd/.erlang.cookie< / TT > must be the same on all nodes). This is
needed because all nodes exchange information about connected users, S2S
2007-12-06 20:47:49 +01:00
connections, registered services, etc… < / P > < P > Each < TT > ejabberd< / TT > node have following modules:
< / P > < UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
2003-11-11 21:51:04 +01:00
router;
2007-12-06 20:47:49 +01:00
< / LI > < LI CLASS = "li-itemize" > local router.
< / LI > < LI CLASS = "li-itemize" > session manager;
< / LI > < LI CLASS = "li-itemize" > S2S manager;
< / LI > < / UL > <!-- TOC subsection Router -->
2009-09-23 17:28:53 +02:00
< H3 CLASS = "subsection" > <!-- SEC ANCHOR --> < A NAME = "htoc4" > 3.1< / A >     Router< / H3 > <!-- SEC END --> < P > This module is the main router of XMPP packets on each node. It routes
2003-11-11 21:51:04 +01:00
them based on their destinations domains. It has two tables: local and global
routes. First, domain of packet destination searched in local table, and if it
found, then the packet is routed to appropriate process. If no, then it
searches in global table, and is routed to the appropriate < TT > ejabberd< / TT > node or
process. If it does not exists in either tables, then it sent to the S2S
2007-12-06 20:47:49 +01:00
manager.< / P > <!-- TOC subsection Local Router -->
< H3 CLASS = "subsection" > <!-- SEC ANCHOR --> < A NAME = "htoc5" > 3.2< / A >     Local Router< / H3 > <!-- SEC END --> < P > This module routes packets which have a destination domain equal to this server
2003-11-11 21:51:04 +01:00
name. If destination JID has a non-empty user part, then it routed to the
2007-12-06 20:47:49 +01:00
session manager, else it is processed depending on it’ s content.< / P > <!-- TOC subsection Session Manager -->
< H3 CLASS = "subsection" > <!-- SEC ANCHOR --> < A NAME = "htoc6" > 3.3< / A >     Session Manager< / H3 > <!-- SEC END --> < P > This module routes packets to local users. It searches for what user resource
2011-05-31 10:14:19 +02:00
packet must be sent via presence table. If this resource is connected to
2003-11-11 21:51:04 +01:00
this node, it is routed to C2S process, if it connected via another node, then
2007-12-06 20:47:49 +01:00
the packet is sent to session manager on that node.< / P > <!-- TOC subsection S2S Manager -->
2009-09-23 17:28:53 +02:00
< H3 CLASS = "subsection" > <!-- SEC ANCHOR --> < A NAME = "htoc7" > 3.4< / A >     S2S Manager< / H3 > <!-- SEC END --> < P > This module routes packets to other XMPP servers. First, it checks if an
2003-11-11 21:51:04 +01:00
open S2S connection from the domain of the packet source to the domain of
packet destination already exists. If it is open on another node, then it
routes the packet to S2S manager on that node, if it is open on this node, then
it is routed to the process that serves this connection, and if a connection
2007-12-06 20:47:49 +01:00
does not exist, then it is opened and registered.< / P > <!-- TOC section Authentication -->
< H2 CLASS = "section" > <!-- SEC ANCHOR --> < A NAME = "htoc8" > 4< / A >     Authentication< / H2 > <!-- SEC END --> <!-- TOC subsubsection External -->
< H4 CLASS = "subsubsection" > <!-- SEC ANCHOR --> < A NAME = "htoc9" > 4.0.1< / A >     External< / H4 > <!-- SEC END --> < P >
2007-12-01 17:43:04 +01:00
< A NAME = "externalauth" > < / A >
2007-12-06 20:47:49 +01:00
< / P > < P > The external authentication script follows
< A HREF = "http://www.erlang.org/doc/tutorial/c_portdriver.html" > the erlang port driver API< / A > .< / P > < P > That script is supposed to do theses actions, in an infinite loop:
< / P > < UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
2007-12-01 17:43:04 +01:00
read from stdin: AABBBBBBBBB.....
2007-12-06 20:47:49 +01:00
< UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
A: 2 bytes of length data (a short in network byte order)
< / LI > < LI CLASS = "li-itemize" > B: a string of length found in A that contains operation in plain text
operation are as follows:
< UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
auth:User:Server:Password (check if a username/password pair is correct)
< / LI > < LI CLASS = "li-itemize" > isuser:User:Server (check if it’ s a valid user)
< / LI > < LI CLASS = "li-itemize" > setpass:User:Server:Password (set user’ s password)
2010-05-10 16:42:54 +02:00
< / LI > < LI CLASS = "li-itemize" > tryregister:User:Server:Password (try to register an account)
< / LI > < LI CLASS = "li-itemize" > removeuser:User:Server (remove this account)
< / LI > < LI CLASS = "li-itemize" > removeuser3:User:Server:Password (remove this account if the password is correct)
2007-12-06 20:47:49 +01:00
< / LI > < / UL >
< / LI > < / UL >
< / LI > < LI CLASS = "li-itemize" > write to stdout: AABB
< UL CLASS = "itemize" > < LI CLASS = "li-itemize" >
A: the number 2 (coded as a short, which is bytes length of following result)
< / LI > < LI CLASS = "li-itemize" > B: the result code (coded as a short), should be 1 for success/valid, or 0 for failure/invalid
< / LI > < / UL >
< / LI > < / UL > < P > Example python script
< / P > < PRE CLASS = "verbatim" > #!/usr/bin/python
2007-12-01 17:43:04 +01:00
import sys
from struct import *
def from_ejabberd():
input_length = sys.stdin.read(2)
(size,) = unpack('> h', input_length)
return sys.stdin.read(size).split(':')
def to_ejabberd(bool):
answer = 0
if bool:
answer = 1
token = pack('> hh', 2, answer)
sys.stdout.write(token)
sys.stdout.flush()
def auth(username, server, password):
return True
def isuser(username, server):
return True
def setpass(username, server, password):
return True
while True:
data = from_ejabberd()
success = False
if data[0] == "auth":
success = auth(data[1], data[2], data[3])
elif data[0] == "isuser":
success = isuser(data[1], data[2])
elif data[0] == "setpass":
success = setpass(data[1], data[2], data[3])
to_ejabberd(success)
2007-12-06 20:47:49 +01:00
< / PRE > <!-- TOC section XML Representation -->
< H2 CLASS = "section" > <!-- SEC ANCHOR --> < A NAME = "htoc10" > 5< / A >     XML Representation< / H2 > <!-- SEC END --> < P >
< A NAME = "xmlrepr" > < / A > < / P > < P > Each XML stanza is represented as the following tuple:
< / P > < PRE CLASS = "verbatim" > XMLElement = {xmlelement, Name, Attrs, [ElementOrCDATA]}
2003-11-11 21:51:04 +01:00
Name = string()
Attrs = [Attr]
Attr = {Key, Val}
Key = string()
Val = string()
ElementOrCDATA = XMLElement | CDATA
CDATA = {xmlcdata, string()}
2007-12-06 20:47:49 +01:00
< / PRE > < P > E.  g. this stanza:
< / P > < PRE CLASS = "verbatim" > < message to='test@conference.example.org' type='groupchat'>
2003-11-11 21:51:04 +01:00
< body> test< /body>
< /message>
2007-12-06 20:47:49 +01:00
< / PRE > < P > is represented as the following structure:
< / P > < PRE CLASS = "verbatim" > {xmlelement, "message",
2005-05-23 21:47:57 +02:00
[{"to", "test@conference.example.org"},
2003-11-11 21:51:04 +01:00
{"type", "groupchat"}],
[{xmlelement, "body",
[],
[{xmlcdata, "test"}]}]}}
2007-12-06 20:47:49 +01:00
< / PRE > <!-- TOC section Module <TT>xml</TT> -->
< H2 CLASS = "section" > <!-- SEC ANCHOR --> < A NAME = "htoc11" > 6< / A >     Module < TT > xml< / TT > < / H2 > <!-- SEC END --> < P >
< A NAME = "xmlmod" > < / A > < / P > < DL CLASS = "description" > < DT CLASS = "dt-description" >
< / DT > < DD CLASS = "dd-description" > < CODE > element_to_string(El) -> string()< / CODE >
< PRE CLASS = "verbatim" > El = XMLElement
< / PRE > Returns string representation of XML stanza < TT > El< / TT > .< / DD > < DT CLASS = "dt-description" > < / DT > < DD CLASS = "dd-description" > < CODE > crypt(S) -> string()< / CODE >
< PRE CLASS = "verbatim" > S = string()
2003-11-11 21:51:04 +01:00
< / PRE > Returns string which correspond to < TT > S< / TT > with encoded XML special
2007-12-06 20:47:49 +01:00
characters.< / DD > < DT CLASS = "dt-description" > < / DT > < DD CLASS = "dd-description" > < CODE > remove_cdata(ECList) -> EList< / CODE >
< PRE CLASS = "verbatim" > ECList = [ElementOrCDATA]
2003-11-11 21:51:04 +01:00
EList = [XMLElement]
2007-12-06 20:47:49 +01:00
< / PRE > < TT > EList< / TT > is a list of all non-CDATA elements of ECList.< / DD > < DT CLASS = "dt-description" > < / DT > < DD CLASS = "dd-description" > < CODE > get_path_s(El, Path) -> Res< / CODE >
< PRE CLASS = "verbatim" > El = XMLElement
2003-11-11 21:51:04 +01:00
Path = [PathItem]
PathItem = PathElem | PathAttr | PathCDATA
PathElem = {elem, Name}
PathAttr = {attr, Name}
PathCDATA = cdata
Name = string()
Res = string() | XMLElement
< / PRE > If < TT > Path< / TT > is empty, then returns < TT > El< / TT > . Else sequentially
2007-12-06 20:47:49 +01:00
consider elements of < TT > Path< / TT > . Each element is one of:
< DL CLASS = "description" > < DT CLASS = "dt-description" >
< / DT > < DD CLASS = "dd-description" > < CODE > {elem, Name}< / CODE > < TT > Name< / TT > is name of subelement of
< TT > El< / TT > , if such element exists, then this element considered in
following steps, else returns empty string.
< / DD > < DT CLASS = "dt-description" > < / DT > < DD CLASS = "dd-description" > < CODE > {attr, Name}< / CODE > If < TT > El< / TT > have attribute < TT > Name< / TT > , then
returns value of this attribute, else returns empty string.
< / DD > < DT CLASS = "dt-description" > < / DT > < DD CLASS = "dd-description" > < CODE > cdata< / CODE > Returns CDATA of < TT > El< / TT > .
< / DD > < / DL > < / DD > < DT CLASS = "dt-description" > < / DT > < DD CLASS = "dd-description" > TODO:
< PRE CLASS = "verbatim" > get_cdata/1, get_tag_cdata/1
2003-11-11 21:51:04 +01:00
get_attr/2, get_attr_s/2
get_tag_attr/2, get_tag_attr_s/2
get_subtag/2
2007-12-06 20:47:49 +01:00
< / PRE > < / DD > < / DL > <!-- TOC section Module <TT>xml_stream</TT> -->
< H2 CLASS = "section" > <!-- SEC ANCHOR --> < A NAME = "htoc12" > 7< / A >     Module < TT > xml_stream< / TT > < / H2 > <!-- SEC END --> < P >
< A NAME = "xmlstreammod" > < / A > < / P > < DL CLASS = "description" > < DT CLASS = "dt-description" >
< / DT > < DD CLASS = "dd-description" > < CODE > parse_element(Str) -> XMLElement | {error, Err}< / CODE >
< PRE CLASS = "verbatim" > Str = string()
2005-08-25 22:48:45 +02:00
Err = term()
< / PRE > Parses < TT > Str< / TT > using XML parser, returns either parsed element or error
2007-12-06 20:47:49 +01:00
tuple.
< / DD > < / DL > <!-- TOC section Modules -->
< H2 CLASS = "section" > <!-- SEC ANCHOR --> < A NAME = "htoc13" > 8< / A >     Modules< / H2 > <!-- SEC END --> < P >
< A NAME = "emods" > < / A > < / P > <!-- TOC subsection Module gen_iq_handler -->
< H3 CLASS = "subsection" > <!-- SEC ANCHOR --> < A NAME = "htoc14" > 8.1< / A >     Module gen_iq_handler< / H3 > <!-- SEC END --> < P >
< A NAME = "geniqhandl" > < / A > < / P > < P > The module < CODE > gen_iq_handler< / CODE > allows to easily write handlers for IQ packets
of particular XML namespaces that addressed to server or to users bare JIDs.< / P > < P > In this module the following functions are defined:
< / P > < DL CLASS = "description" > < DT CLASS = "dt-description" >
< / DT > < DD CLASS = "dd-description" > < CODE > add_iq_handler(Component, Host, NS, Module, Function, Type)< / CODE >
< PRE CLASS = "verbatim" > Component = Module = Function = atom()
2005-08-25 22:48:45 +02:00
Host = NS = string()
2003-11-11 21:51:04 +01:00
Type = no_queue | one_queue | parallel
2005-08-25 22:48:45 +02:00
< / PRE > Registers function < CODE > Module:Function< / CODE > as handler for IQ packets on
2007-12-06 20:47:49 +01:00
virtual host < CODE > Host< / CODE > that contain child of namespace < CODE > NS< / CODE > in
< CODE > Component< / CODE > . Queueing discipline is < CODE > Type< / CODE > . There are at least
two components defined:
< DL CLASS = "description" > < DT CLASS = "dt-description" >
< / DT > < DD CLASS = "dd-description" > < CODE > ejabberd_local< / CODE > Handles packets that addressed to server JID;
< / DD > < DT CLASS = "dt-description" > < / DT > < DD CLASS = "dd-description" > < CODE > ejabberd_sm< / CODE > Handles packets that addressed to users bare JIDs.
< / DD > < / DL >
< / DD > < DT CLASS = "dt-description" > < / DT > < DD CLASS = "dd-description" > < CODE > remove_iq_handler(Component, Host, NS)< / CODE >
< PRE CLASS = "verbatim" > Component = atom()
2005-08-25 22:48:45 +02:00
Host = NS = string()
< / PRE > Removes IQ handler on virtual host < CODE > Host< / CODE > for namespace < CODE > NS< / CODE > from
2007-12-06 20:47:49 +01:00
< CODE > Component< / CODE > .
< / DD > < / DL > < P > Handler function must have the following type:
< / P > < DL CLASS = "description" > < DT CLASS = "dt-description" >
< / DT > < DD CLASS = "dd-description" > < CODE > Module:Function(From, To, IQ)< / CODE >
< PRE CLASS = "verbatim" > From = To = jid()
< / PRE > < / DD > < / DL > < PRE CLASS = "verbatim" > -module(mod_cputime).
2003-11-11 21:51:04 +01:00
-behaviour(gen_mod).
2005-08-25 22:48:45 +02:00
-export([start/2,
stop/1,
2003-11-11 21:51:04 +01:00
process_local_iq/3]).
-include("ejabberd.hrl").
-include("jlib.hrl").
-define(NS_CPUTIME, "ejabberd:cputime").
2005-08-25 22:48:45 +02:00
start(Host, Opts) ->
2003-11-11 21:51:04 +01:00
IQDisc = gen_mod:get_opt(iqdisc, Opts, one_queue),
2005-08-25 22:48:45 +02:00
gen_iq_handler:add_iq_handler(ejabberd_local, Host, ?NS_CPUTIME,
2003-11-11 21:51:04 +01:00
?MODULE, process_local_iq, IQDisc).
2005-08-25 22:48:45 +02:00
stop(Host) ->
gen_iq_handler:remove_iq_handler(ejabberd_local, Host, ?NS_CPUTIME).
2003-11-11 21:51:04 +01:00
process_local_iq(From, To, {iq, ID, Type, XMLNS, SubEl}) ->
case Type of
set ->
{iq, ID, error, XMLNS,
[SubEl, ?ERR_NOT_ALLOWED]};
get ->
CPUTime = element(1, erlang:statistics(runtime))/1000,
SCPUTime = lists:flatten(io_lib:format("~.3f", CPUTime)),
{iq, ID, result, XMLNS,
[{xmlelement, "query",
[{"xmlns", ?NS_CPUTIME}],
[{xmlelement, "cputime", [], [{xmlcdata, SCPUTime}]}]}]}
end.
2007-12-06 20:47:49 +01:00
< / PRE > <!-- TOC subsection Services -->
< H3 CLASS = "subsection" > <!-- SEC ANCHOR --> < A NAME = "htoc15" > 8.2< / A >     Services< / H3 > <!-- SEC END --> < P >
< A NAME = "services" > < / A > < / P > < PRE CLASS = "verbatim" > -module(mod_echo).
2003-11-11 21:51:04 +01:00
-behaviour(gen_mod).
2005-08-25 22:48:45 +02:00
-export([start/2, init/1, stop/1]).
2003-11-11 21:51:04 +01:00
-include("ejabberd.hrl").
-include("jlib.hrl").
2005-08-25 22:48:45 +02:00
start(Host, Opts) ->
MyHost = gen_mod:get_opt(host, Opts, "echo." ++ Host),
register(gen_mod:get_module_proc(Host, ?PROCNAME),
spawn(?MODULE, init, [MyHost])).
2003-11-11 21:51:04 +01:00
init(Host) ->
ejabberd_router:register_local_route(Host),
loop(Host).
loop(Host) ->
receive
{route, From, To, Packet} ->
ejabberd_router:route(To, From, Packet),
loop(Host);
stop ->
2005-08-25 22:48:45 +02:00
ejabberd_router:unregister_route(Host),
2003-11-11 21:51:04 +01:00
ok;
_ ->
loop(Host)
end.
2005-08-25 22:48:45 +02:00
stop(Host) ->
Proc = gen_mod:get_module_proc(Host, ?PROCNAME),
Proc ! stop,
{wait, Proc}.
2007-12-06 20:47:49 +01:00
< / PRE > <!-- CUT END -->
2003-11-11 21:51:04 +01:00
<!-- HTMLFOOT -->
<!-- ENDHTML -->
<!-- FOOTER -->
2005-12-16 17:33:42 +01:00
< HR SIZE = 2 > < BLOCKQUOTE CLASS = "quote" > < EM > This document was translated from L< sup > A< / sup > T< sub > E< / sub > X by
2007-12-06 20:47:49 +01:00
< / EM > < A HREF = "http://hevea.inria.fr/index.html" > < EM > H< / EM > < EM > < FONT SIZE = 2 > < sup > E< / sup > < / FONT > < / EM > < EM > V< / EM > < EM > < FONT SIZE = 2 > < sup > E< / sup > < / FONT > < / EM > < EM > A< / EM > < / A > < EM > .< / EM > < / BLOCKQUOTE > < / BODY >
2003-11-11 21:51:04 +01:00
< / HTML >
