diff options
86 files changed, 4462 insertions, 14118 deletions
diff --git a/doc/Makefile b/doc/Makefile index a7ea171f2..b6235a2db 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -35,6 +35,7 @@ clean: rm -f *.out rm -f *.pdf rm -f *.toc + rm -f version.tex [ ! -f contributed_modules.tex ] || rm contributed_modules.tex distclean: clean diff --git a/doc/dev.html b/doc/dev.html deleted file mode 100644 index 9360a7987..000000000 --- a/doc/dev.html +++ /dev/null @@ -1,412 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" - "http://www.w3.org/TR/REC-html40/loose.dtd"> -<HTML> -<HEAD> -<TITLE>Ejabberd 3.0.0-prealpha Developers Guide -</TITLE> - -<META http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<META name="GENERATOR" content="hevea 1.10"> -<STYLE type="text/css"> -.li-itemize{margin:1ex 0ex;} -.li-enumerate{margin:1ex 0ex;} -.dd-description{margin:0ex 0ex 1ex 4ex;} -.dt-description{margin:0ex;} -.toc{list-style:none;} -.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} -.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;} -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} -</STYLE> -</HEAD> -<BODY > -<!--HEVEA command line is: /usr/bin/hevea -fix -pedantic dev.tex --> -<!--CUT DEF section 1 --><P><A NAME="titlepage"></A> - -</P><TABLE CLASS="title"><TR><TD><H1 CLASS="titlemain">Ejabberd 3.0.0-prealpha Developers Guide</H1><H3 CLASS="titlerest">Alexey Shchepin<BR> - <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"> - -<IMG SRC="logo.png" ALT="logo.png"> - - -</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> -<UL CLASS="toc"><LI CLASS="li-toc"> -<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> -<UL CLASS="toc"> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc9">4.0.1  External</A> -</LI></UL> -</UL> -</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> -<UL CLASS="toc"><LI CLASS="li-toc"> -<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 -<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--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc1">1</A>  Key Features</H2><!--SEC END --><P> -<A NAME="keyfeatures"></A> -</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: -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Comprehensive documentation. -</LI><LI CLASS="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows. </LI><LI CLASS="li-itemize">Web Administration. -</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: -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Translated to 24 languages. </LI><LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>. -</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. -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Fully XMPP compliant. -</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> -<A NAME="addfeatures"></A> -</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"> -Modular -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Load only the modules you want. -</LI><LI CLASS="li-itemize">Extend <TT>ejabberd</TT> with your own custom modules. -</LI></UL> -</LI><LI CLASS="li-itemize">Security -<UL CLASS="itemize"><LI CLASS="li-itemize"> -SASL and STARTTLS for c2s and s2s connections. -</LI><LI CLASS="li-itemize">STARTTLS and Dialback s2s connections. -</LI><LI CLASS="li-itemize">Web Admin accessible via HTTPS secure access. -</LI></UL> -</LI><LI CLASS="li-itemize">Databases -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Internal database for fast deployment (Mnesia). -</LI><LI CLASS="li-itemize">Native MySQL support. -</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 -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Internal Authentication. -</LI><LI CLASS="li-itemize">PAM, LDAP and ODBC. </LI><LI CLASS="li-itemize">External Authentication script. -</LI></UL> -</LI><LI CLASS="li-itemize">Others -<UL CLASS="itemize"><LI CLASS="li-itemize"> -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>). -</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. -</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. -</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>. -</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. -</LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports. -</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> -<A NAME="howitworks"></A></P><P>A XMPP domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can -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 -connections, registered services, etc…</P><P>Each <TT>ejabberd</TT> node have following modules: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -router; -</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--> -<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 -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 -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 -name. If destination JID has a non-empty user part, then it routed to the -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 -packet must be sended via presence table. If this resource is connected to -this node, it is routed to C2S process, if it connected via another node, then -the packet is sent to session manager on that node.</P><!--TOC subsection S2S Manager--> -<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 -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 -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> -<A NAME="externalauth"></A> -</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"> -read from stdin: AABBBBBBBBB..... -<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) -</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) -</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 - -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) -</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]} - Name = string() - Attrs = [Attr] - Attr = {Key, Val} - Key = string() - Val = string() - ElementOrCDATA = XMLElement | CDATA - CDATA = {xmlcdata, string()} -</PRE><P>E. g. this stanza: -</P><PRE CLASS="verbatim"><message to='test@conference.example.org' type='groupchat'> - <body>test</body> -</message> -</PRE><P>is represented as the following structure: -</P><PRE CLASS="verbatim">{xmlelement, "message", - [{"to", "test@conference.example.org"}, - {"type", "groupchat"}], - [{xmlelement, "body", - [], - [{xmlcdata, "test"}]}]}} -</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() -</PRE>Returns string which correspond to <TT>S</TT> with encoded XML special -characters.</DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>remove_cdata(ECList) -> EList</CODE> -<PRE CLASS="verbatim">ECList = [ElementOrCDATA] -EList = [XMLElement] -</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 -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 -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 - get_attr/2, get_attr_s/2 - get_tag_attr/2, get_tag_attr_s/2 - get_subtag/2 -</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() -Err = term() -</PRE>Parses <TT>Str</TT> using XML parser, returns either parsed element or error -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() -Host = NS = string() -Type = no_queue | one_queue | parallel -</PRE>Registers function <CODE>Module:Function</CODE> as handler for IQ packets on -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() -Host = NS = string() -</PRE>Removes IQ handler on virtual host <CODE>Host</CODE> for namespace <CODE>NS</CODE> from -<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). - --behaviour(gen_mod). - --export([start/2, - stop/1, - process_local_iq/3]). - --include("ejabberd.hrl"). --include("jlib.hrl"). - --define(NS_CPUTIME, "ejabberd:cputime"). - -start(Host, Opts) -> - IQDisc = gen_mod:get_opt(iqdisc, Opts, one_queue), - gen_iq_handler:add_iq_handler(ejabberd_local, Host, ?NS_CPUTIME, - ?MODULE, process_local_iq, IQDisc). - -stop(Host) -> - gen_iq_handler:remove_iq_handler(ejabberd_local, Host, ?NS_CPUTIME). - -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. -</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). - --behaviour(gen_mod). - --export([start/2, init/1, stop/1]). - --include("ejabberd.hrl"). --include("jlib.hrl"). - -start(Host, Opts) -> - MyHost = gen_mod:get_opt(host, Opts, "echo." ++ Host), - register(gen_mod:get_module_proc(Host, ?PROCNAME), - spawn(?MODULE, init, [MyHost])). - -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 -> - ejabberd_router:unregister_route(Host), - ok; - _ -> - loop(Host) - end. - -stop(Host) -> - Proc = gen_mod:get_module_proc(Host, ?PROCNAME), - Proc ! stop, - {wait, Proc}. -</PRE><!--CUT END --> -<!--HTMLFOOT--> -<!--ENDHTML--> -<!--FOOTER--> -<HR SIZE=2><BLOCKQUOTE CLASS="quote"><EM>This document was translated from L<sup>A</sup>T<sub>E</sub>X by -</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> -</HTML> diff --git a/doc/features.html b/doc/features.html deleted file mode 100644 index 62f98324d..000000000 --- a/doc/features.html +++ /dev/null @@ -1,131 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" - "http://www.w3.org/TR/REC-html40/loose.dtd"> -<HTML> -<HEAD> -<TITLE>Ejabberd 3.0.0-prealpha Feature Sheet -</TITLE> - -<META http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<META name="GENERATOR" content="hevea 1.10"> -<STYLE type="text/css"> -.li-itemize{margin:1ex 0ex;} -.li-enumerate{margin:1ex 0ex;} -.dd-description{margin:0ex 0ex 1ex 4ex;} -.dt-description{margin:0ex;} -.toc{list-style:none;} -.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} -.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;} -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} -SPAN{width:20%; float:right; text-align:left; margin-left:auto;} -</STYLE> -</HEAD> -<BODY > -<!--HEVEA command line is: /usr/bin/hevea -fix -pedantic features.tex --> -<!--CUT DEF section 1 --><P><A NAME="titlepage"></A> - -</P><TABLE CLASS="title"><TR><TD><H1 CLASS="titlemain">Ejabberd 3.0.0-prealpha Feature Sheet</H1><H3 CLASS="titlerest">Sander Devrieze<BR> - <A HREF="mailto:s.devrieze@pandora.be"><TT>mailto:s.devrieze@pandora.be</TT></A><BR> - <A HREF="xmpp:sander@devrieze.dyndns.org"><TT>xmpp:sander@devrieze.dyndns.org</TT></A></H3></TD></TR> -</TABLE><DIV CLASS="center"> - -<IMG SRC="logo.png" ALT="logo.png"> - - -</DIV><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>I can thoroughly recommend ejabberd for ease of setup – -Kevin Smith, Current maintainer of the Psi project</I></FONT></BLOCKQUOTE><P>Introduction -<A NAME="intro"></A></P><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>I just tried out ejabberd and was impressed both by ejabberd itself and the language it is written in, Erlang. — -Joeri</I></FONT></BLOCKQUOTE><P><TT>ejabberd</TT> is a <B><FONT SIZE=4><FONT COLOR="#001376">free and open source</FONT></FONT></B> instant messaging server written in <A HREF="http://www.erlang.org/">Erlang/OTP</A>.</P><P><TT>ejabberd</TT> is <B><FONT SIZE=4><FONT COLOR="#001376">cross-platform</FONT></FONT></B>, distributed, fault-tolerant, and based on open standards to achieve real-time communication.</P><P><TT>ejabberd</TT> is designed to be a <B><FONT SIZE=4><FONT COLOR="#001376">rock-solid and feature rich</FONT></FONT></B> XMPP server.</P><P><TT>ejabberd</TT> is suitable for small deployments, whether they need to be <B><FONT SIZE=4><FONT COLOR="#001376">scalable</FONT></FONT></B> or not, as well as extremely big deployments.</P><!--TOC section Key Features--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc1"></A>Key Features</H2><!--SEC END --><P> -<A NAME="keyfeatures"></A> -</P><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>Erlang seems to be tailor-made for writing stable, robust servers. — -Peter Saint-André, Executive Director of the Jabber Software Foundation</I></FONT></BLOCKQUOTE><P><TT>ejabberd</TT> is: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -<B><FONT SIZE=4><FONT COLOR="#001376">Cross-platform:</FONT></FONT></B> <TT>ejabberd</TT> runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.</LI><LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Distributed:</FONT></FONT></B> 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"><B><FONT SIZE=4><FONT COLOR="#001376">Fault-tolerant:</FONT></FONT></B> 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"><B><FONT SIZE=4><FONT COLOR="#001376">Administrator Friendly:</FONT></FONT></B> <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: -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Comprehensive documentation. -</LI><LI CLASS="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows. </LI><LI CLASS="li-itemize">Web Administration. -</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"><B><FONT SIZE=4><FONT COLOR="#001376">Internationalized:</FONT></FONT></B> <TT>ejabberd</TT> leads in internationalization. Hence it is very well suited in a globalized world. Related features are: -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Translated to 24 languages. </LI><LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>. -</LI></UL></LI><LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Open Standards:</FONT></FONT></B> <TT>ejabberd</TT> is the first Open Source Jabber server claiming to fully comply to the XMPP standard. -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Fully XMPP compliant. -</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"></A>Additional Features</H2><!--SEC END --><P> -<A NAME="addfeatures"></A> -</P><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>ejabberd is making inroads to solving the "buggy incomplete server" problem — -Justin Karneges, Founder of the Psi and the Delta projects</I></FONT></BLOCKQUOTE><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"> -Modular -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Load only the modules you want. -</LI><LI CLASS="li-itemize">Extend <TT>ejabberd</TT> with your own custom modules. -</LI></UL> -</LI><LI CLASS="li-itemize">Security -<UL CLASS="itemize"><LI CLASS="li-itemize"> -SASL and STARTTLS for c2s and s2s connections. -</LI><LI CLASS="li-itemize">STARTTLS and Dialback s2s connections. -</LI><LI CLASS="li-itemize">Web Admin accessible via HTTPS secure access. -</LI></UL> -</LI><LI CLASS="li-itemize">Databases -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Internal database for fast deployment (Mnesia). -</LI><LI CLASS="li-itemize">Native MySQL support. -</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 -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Internal Authentication. -</LI><LI CLASS="li-itemize">PAM, LDAP and ODBC. </LI><LI CLASS="li-itemize">External Authentication script. -</LI></UL> -</LI><LI CLASS="li-itemize">Others -<UL CLASS="itemize"><LI CLASS="li-itemize"> -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>). -</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. -</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. -</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>. -</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. -</LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports. -</LI></UL> -</LI></UL><!--CUT END --> -<!--HTMLFOOT--> -<!--ENDHTML--> -<!--FOOTER--> -<HR SIZE=2><BLOCKQUOTE CLASS="quote"><EM>This document was translated from L<sup>A</sup>T<sub>E</sub>X by -</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> -</HTML> diff --git a/doc/guide.html b/doc/guide.html deleted file mode 100644 index c242dbb77..000000000 --- a/doc/guide.html +++ /dev/null @@ -1,4174 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" - "http://www.w3.org/TR/REC-html40/loose.dtd"> -<HTML> -<HEAD> -<TITLE> - - - - ejabberd 3.0.0-alpha-x - - Installation and Operation Guide - - - - - - -</TITLE> - -<META http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<META name="GENERATOR" content="hevea 1.10"> -<STYLE type="text/css"> -.li-itemize{margin:1ex 0ex;} -.li-enumerate{margin:1ex 0ex;} -.dd-description{margin:0ex 0ex 1ex 4ex;} -.dt-description{margin:0ex;} -.toc{list-style:none;} -.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} -.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;} -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} -.SPAN{width:20%; float:right; text-align:left; margin-left:auto;} -H1.titlemain HR{display:none;} -TABLE.title{border-top:1px solid grey;border-bottom:1px solid grey; background: #efefef} -H1.chapter A, H2.section A, H3.subsection A, H4.subsubsection A, H5.paragraph A{color:#000000; text-decoration:none;} -H1.chapter, H2.section, H3.subsection, H4.subsubsection, H5.paragraph{border-top: 1px solid grey; background: #efefef; padding: 0.5ex} -pre.verbatim{margin:1ex 2ex;border:1px dashed lightgrey;background-color:#f9f9f9;padding:0.5ex;} -.dt-description{margin:0ex 2ex;} -table[border="1"]{border-collapse:collapse;margin-bottom:1em;} -table[border="1"] td{border:1px solid #aaa;padding:2px} -BLOCKQUOTE.table DIV.center DIV.center HR{display:none;} -BLOCKQUOTE.figure DIV.center DIV.center HR{display:none;} -</STYLE> -</HEAD> -<BODY > -<!--HEVEA command line is: /usr/bin/hevea -fix -pedantic guide.tex --> -<!--CUT DEF chapter 1 --><P><A NAME="titlepage"></A> - -</P><TABLE CLASS="title"><TR><TD><H1 CLASS="titlemain"> -<HR SIZE=2><BR> -<BR> - -<TABLE CELLSPACING=6 CELLPADDING=0><TR><TD ALIGN=right NOWRAP> <FONT SIZE=6><B>ejabberd 3.0.0-alpha-x </B></FONT></TD></TR> -<TR><TD ALIGN=right NOWRAP> </TD></TR> -<TR><TD ALIGN=right NOWRAP> <FONT SIZE=6>Installation and Operation Guide</FONT></TD></TR> -</TABLE><BR> -<BR> - -<HR SIZE=2> - -</H1></TD></TR> -</TABLE><P><A NAME="toc"></A> -</P><!--TOC chapter Contents--> -<H1 CLASS="chapter"><!--SEC ANCHOR -->Contents</H1><!--SEC END --><UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc1">Chapter 1  Introduction</A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc2">1.1  Key Features</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc3">1.2  Additional Features</A> -</LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc4">Chapter 2  Installing <TT>ejabberd</TT></A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc5">2.1  Installing <TT>ejabberd</TT> with Binary Installer</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc6">2.2  Installing <TT>ejabberd</TT> with Operating System Specific Packages</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc7">2.3  Installing <TT>ejabberd</TT> with CEAN</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc8">2.4  Installing <TT>ejabberd</TT> from Source Code</A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc9">2.4.1  Requirements</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc10">2.4.2  Download Source Code</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc11">2.4.3  Compile</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc12">2.4.4  Install</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc13">2.4.5  Start</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc14">2.4.6  Specific Notes for BSD</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc15">2.4.7  Specific Notes for Sun Solaris</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc16">2.4.8  Specific Notes for Microsoft Windows</A> -</LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc17">2.5  Create a XMPP Account for Administration</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc18">2.6  Upgrading <TT>ejabberd</TT></A> -</LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc19">Chapter 3  Configuring <TT>ejabberd</TT></A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc20">3.1  Basic Configuration</A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc21">3.1.1  Host Names</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc22">3.1.2  Virtual Hosting</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc23">3.1.3  Listening Ports</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc24">3.1.4  Authentication</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc25">3.1.5  Access Rules</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc26">3.1.6  Shapers</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc27">3.1.7  Default Language</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc28">3.1.8  CAPTCHA</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc29">3.1.9  STUN</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc30">3.1.10  Include Additional Configuration Files</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc31">3.1.11  Option Macros in Configuration File</A> -</LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc32">3.2  Database and LDAP Configuration</A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc33">3.2.1  MySQL</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc34">3.2.2  Microsoft SQL Server</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc35">3.2.3  PostgreSQL</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc36">3.2.4  ODBC Compatible</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc37">3.2.5  LDAP</A> -</LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc38">3.3  Modules Configuration</A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc39">3.3.1  Modules Overview</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc40">3.3.2  Common Options</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc41">3.3.3  <TT>mod_announce</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc42">3.3.4  <TT>mod_disco</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc43">3.3.5  <TT>mod_echo</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc44">3.3.6  <TT>mod_http_bind</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc45">3.3.7  <TT>mod_http_fileserver</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc46">3.3.8  <TT>mod_last</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc47">3.3.9  <TT>mod_muc</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc48">3.3.10  <TT>mod_muc_log</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc49">3.3.11  <TT>mod_multicast</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc50">3.3.12  <TT>mod_offline</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc51">3.3.13  <TT>mod_ping</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc52">3.3.14  <TT>mod_privacy</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc53">3.3.15  <TT>mod_private</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc54">3.3.16  <TT>mod_proxy65</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc55">3.3.17  <TT>mod_pubsub</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc56">3.3.18  <TT>mod_register</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc57">3.3.19  <TT>mod_roster</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc58">3.3.20  <TT>mod_service_log</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc59">3.3.21  <TT>mod_shared_roster</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc60">3.3.22  <TT>mod_sic</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc61">3.3.23  <TT>mod_stats</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc62">3.3.24  <TT>mod_time</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc63">3.3.25  <TT>mod_vcard</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc64">3.3.26  <TT>mod_vcard_ldap</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc65">3.3.27  <TT>mod_vcard_xupdate</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc66">3.3.28  <TT>mod_version</TT></A> -</LI></UL> -</LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc67">Chapter 4  Managing an <TT>ejabberd</TT> Server</A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc68">4.1  <TT>ejabberdctl</TT></A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc69">4.1.1  ejabberdctl Commands</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc70">4.1.2  Erlang Runtime System</A> -</LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc71">4.2  <TT>ejabberd</TT> Commands</A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc72">4.2.1  List of ejabberd Commands</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc73">4.2.2  Restrict Execution with AccessCommands</A> -</LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc74">4.3  Web Admin</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc75">4.4  Ad-hoc Commands</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc76">4.5  Change Computer Hostname</A> -</LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc77">Chapter 5  Securing <TT>ejabberd</TT></A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc78">5.1  Firewall Settings</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc79">5.2  epmd</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc80">5.3  Erlang Cookie</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc81">5.4  Erlang Node Name</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc82">5.5  Securing Sensitive Files</A> -</LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc83">Chapter 6  Clustering</A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc84">6.1  How it Works</A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc85">6.1.1  Router</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc86">6.1.2  Local Router</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc87">6.1.3  Session Manager</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc88">6.1.4  s2s Manager</A> -</LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc89">6.2  Clustering Setup</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc90">6.3  Service Load-Balancing</A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc91">6.3.1  Components Load-Balancing</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc92">6.3.2  Domain Load-Balancing Algorithm</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc93">6.3.3  Load-Balancing Buckets</A> -</LI></UL> -</LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc94">Chapter 7  Debugging</A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc95">7.1  Log Files</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc96">7.2  Debug Console</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc97">7.3  Watchdog Alerts</A> -</LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc98">Appendix A  Internationalization and Localization</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc99">Appendix B  Release Notes</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc100">Appendix C  Acknowledgements</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc101">Appendix D  Copyright Information</A> -</LI></UL><!--TOC chapter Introduction--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc1">Chapter 1</A>  Introduction</H1><!--SEC END --><P> -<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--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc2">1.1</A>  Key Features</H2><!--SEC END --><P> -<A NAME="keyfeatures"></A> -</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: -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Comprehensive documentation. -</LI><LI CLASS="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows. </LI><LI CLASS="li-itemize">Web Administration. -</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: -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Translated to 24 languages. </LI><LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>. -</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. -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Fully XMPP compliant. -</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="htoc3">1.2</A>  Additional Features</H2><!--SEC END --><P> -<A NAME="addfeatures"></A> -</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"> -Modular -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Load only the modules you want. -</LI><LI CLASS="li-itemize">Extend <TT>ejabberd</TT> with your own custom modules. -</LI></UL> -</LI><LI CLASS="li-itemize">Security -<UL CLASS="itemize"><LI CLASS="li-itemize"> -SASL and STARTTLS for c2s and s2s connections. -</LI><LI CLASS="li-itemize">STARTTLS and Dialback s2s connections. -</LI><LI CLASS="li-itemize">Web Admin accessible via HTTPS secure access. -</LI></UL> -</LI><LI CLASS="li-itemize">Databases -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Internal database for fast deployment (Mnesia). -</LI><LI CLASS="li-itemize">Native MySQL support. -</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 -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Internal Authentication. -</LI><LI CLASS="li-itemize">PAM, LDAP and ODBC. </LI><LI CLASS="li-itemize">External Authentication script. -</LI></UL> -</LI><LI CLASS="li-itemize">Others -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Support for virtual hosting. -</LI><LI CLASS="li-itemize">Compressing XML streams with Stream Compression (<A HREF="http://xmpp.org/extensions/xep-0138.html">XEP-0138</A>). -</LI><LI CLASS="li-itemize">Statistics via Statistics Gathering (<A HREF="http://xmpp.org/extensions/xep-0039.html">XEP-0039</A>). -</LI><LI CLASS="li-itemize">IPv6 support both for c2s and s2s connections. -</LI><LI CLASS="li-itemize"><A HREF="http://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. -</LI><LI CLASS="li-itemize"><A HREF="http://xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component with support for <A HREF="http://xmpp.org/extensions/xep-0163.html">Personal Eventing via Pubsub</A>. -</LI><LI CLASS="li-itemize">Support for web clients: <A HREF="http://xmpp.org/extensions/xep-0025.html">HTTP Polling</A> and <A HREF="http://xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</A> services. -</LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports. -</LI></UL> -</LI></UL><P> <A NAME="installing"></A> </P><!--TOC chapter Installing <TT>ejabberd</TT>--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc4">Chapter 2</A>  <A HREF="#installing">Installing <TT>ejabberd</TT></A></H1><!--SEC END --><P> <A NAME="installing"></A> </P><P> <A NAME="install.binary"></A> </P><!--TOC section Installing <TT>ejabberd</TT> with Binary Installer--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc5">2.1</A>  <A HREF="#install.binary">Installing <TT>ejabberd</TT> with Binary Installer</A></H2><!--SEC END --><P> <A NAME="install.binary"></A> </P><P>Probably the easiest way to install an <TT>ejabberd</TT> instant messaging server -is using the binary installer published by ProcessOne. -The binary installers of released <TT>ejabberd</TT> versions -are available in the ProcessOne <TT>ejabberd</TT> downloads page: -<A HREF="http://www.process-one.net/en/ejabberd/downloads"><TT>http://www.process-one.net/en/ejabberd/downloads</TT></A></P><P>The installer will deploy and configure a full featured <TT>ejabberd</TT> -server and does not require any extra dependencies.</P><P>In *nix systems, remember to set executable the binary installer before starting it. For example: -</P><PRE CLASS="verbatim">chmod +x ejabberd-2.0.0_1-linux-x86-installer.bin -./ejabberd-2.0.0_1-linux-x86-installer.bin -</PRE><P><TT>ejabberd</TT> can be started manually at any time, -or automatically by the operating system at system boot time.</P><P>To start and stop <TT>ejabberd</TT> manually, -use the desktop shortcuts created by the installer. -If the machine doesn’t have a graphical system, use the scripts ’start’ -and ’stop’ in the ’bin’ directory where <TT>ejabberd</TT> is installed.</P><P>The Windows installer also adds ejabberd as a system service, -and a shortcut to a debug console for experienced administrators. -If you want ejabberd to be started automatically at boot time, -go to the Windows service settings and set ejabberd to be automatically started. -Note that the Windows service is a feature still in development, -and for example it doesn’t read the file ejabberdctl.cfg.</P><P>On a *nix system, if you want ejabberd to be started as daemon at boot time, -copy <TT>ejabberd.init</TT> from the ’bin’ directory to something like <TT>/etc/init.d/ejabberd</TT> -(depending on your distribution). -Create a system user called <TT>ejabberd</TT>; -it will be used by the script to start the server. -Then you can call <TT>/etc/inid.d/ejabberd start</TT> as root to start the server.</P><P>If <TT>ejabberd</TT> doesn’t start correctly in Windows, -try to start it using the shortcut in desktop or start menu. -If the window shows error 14001, the solution is to install: -"Microsoft Visual C++ 2005 SP1 Redistributable Package". -You can download it from -<A HREF="http://www.microsoft.com/">www.microsoft.com</A>. -Then uninstall <TT>ejabberd</TT> and install it again.</P><P>If <TT>ejabberd</TT> doesn’t start correctly and a crash dump is generated, -there was a severe problem. -You can try starting <TT>ejabberd</TT> with -the script <TT>bin/live.bat</TT> in Windows, -or with the command <TT>bin/ejabberdctl live</TT> in other Operating Systems. -This way you see the error message provided by Erlang -and can identify what is exactly the problem.</P><P>The <TT>ejabberdctl</TT> administration script is included in the <TT>bin</TT> directory. -Please refer to the section <A HREF="#ejabberdctl">4.1</A> for details about <TT>ejabberdctl</TT>, -and configurable options to fine tune the Erlang runtime system.</P><P> <A NAME="install.os"></A> </P><!--TOC section Installing <TT>ejabberd</TT> with Operating System Specific Packages--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc6">2.2</A>  <A HREF="#install.os">Installing <TT>ejabberd</TT> with Operating System Specific Packages</A></H2><!--SEC END --><P> <A NAME="install.os"></A> </P><P>Some Operating Systems provide a specific <TT>ejabberd</TT> package adapted to -the system architecture and libraries. -It usually also checks dependencies -and performs basic configuration tasks like creating the initial -administrator account. Some examples are Debian and Gentoo. Consult the -resources provided by your Operating System for more information.</P><P>Usually those packages create a script like <TT>/etc/init.d/ejabberd</TT> -to start and stop <TT>ejabberd</TT> as a service at boot time.</P><P> <A NAME="install.cean"></A> </P><!--TOC section Installing <TT>ejabberd</TT> with CEAN--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc7">2.3</A>  <A HREF="#install.cean">Installing <TT>ejabberd</TT> with CEAN</A></H2><!--SEC END --><P> <A NAME="install.cean"></A> </P><P><A HREF="http://cean.process-one.net/">CEAN</A> -(Comprehensive Erlang Archive Network) is a repository that hosts binary -packages from many Erlang programs, including <TT>ejabberd</TT> and all its dependencies. -The binaries are available for many different system architectures, so this is an -alternative to the binary installer and Operating System’s <TT>ejabberd</TT> packages.</P><P>You will have to create your own <TT>ejabberd</TT> start -script depending of how you handle your CEAN installation. -The default <TT>ejabberdctl</TT> script is located -into <TT>ejabberd</TT>’s priv directory and can be used as an example.</P><P> <A NAME="installation"></A> </P><!--TOC section Installing <TT>ejabberd</TT> from Source Code--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc8">2.4</A>  <A HREF="#installation">Installing <TT>ejabberd</TT> from Source Code</A></H2><!--SEC END --><P> <A NAME="installation"></A> -</P><P>The canonical form for distribution of <TT>ejabberd</TT> stable releases is the source code package. -Compiling <TT>ejabberd</TT> from source code is quite easy in *nix systems, -as long as your system have all the dependencies.</P><P> <A NAME="installreq"></A> </P><!--TOC subsection Requirements--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc9">2.4.1</A>  <A HREF="#installreq">Requirements</A></H3><!--SEC END --><P> <A NAME="installreq"></A> -</P><P>To compile <TT>ejabberd</TT> on a ‘Unix-like’ operating system, you need: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -GNU Make -</LI><LI CLASS="li-itemize">GCC -</LI><LI CLASS="li-itemize">Erlang/OTP R12B-5 or higher. -</LI><LI CLASS="li-itemize">exmpp 0.9.6 or higher -</LI><LI CLASS="li-itemize">OpenSSL 0.9.8 or higher, for STARTTLS, SASL and SSL encryption. -</LI><LI CLASS="li-itemize">Zlib 1.2.3 or higher, for Stream Compression support (<A HREF="http://xmpp.org/extensions/xep-0138.html">XEP-0138</A>). Optional. -</LI><LI CLASS="li-itemize">Erlang mysql library. Optional. For MySQL authentication or storage. See section <A HREF="#compilemysql">3.2.1</A>. -</LI><LI CLASS="li-itemize">Erlang pgsql library. Optional. For PostgreSQL authentication or storage. See section <A HREF="#compilepgsql">3.2.3</A>. -</LI><LI CLASS="li-itemize">PAM library. Optional. For Pluggable Authentication Modules (PAM). See section <A HREF="#pam">3.1.4</A>. -</LI><LI CLASS="li-itemize">ESASL library. Optional. For SASL GSSAPI authentication. See section <A HREF="#gssapi">3.1.4</A>. -</LI><LI CLASS="li-itemize">ImageMagick’s Convert program. Optional. For CAPTCHA challenges. See section <A HREF="#captcha">3.1.8</A>. -</LI></UL><P> <A NAME="download"></A> </P><!--TOC subsection Download Source Code--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc10">2.4.2</A>  <A HREF="#download">Download Source Code</A></H3><!--SEC END --><P> <A NAME="download"></A> -</P><P>Released versions of <TT>ejabberd</TT> are available in the ProcessOne <TT>ejabberd</TT> downloads page: -<A HREF="http://www.process-one.net/en/ejabberd/downloads"><TT>http://www.process-one.net/en/ejabberd/downloads</TT></A></P><P> -Alternatively, the latest development source code can be retrieved from the Git repository using the commands: -</P><PRE CLASS="verbatim">git clone git://git.process-one.net/ejabberd/mainline.git ejabberd -cd ejabberd -</PRE><P> <A NAME="compile"></A> </P><!--TOC subsection Compile--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc11">2.4.3</A>  <A HREF="#compile">Compile</A></H3><!--SEC END --><P> <A NAME="compile"></A> -</P><P>To compile <TT>ejabberd</TT> execute the commands: -</P><PRE CLASS="verbatim">./configure -make -</PRE><P>The build configuration script allows several options. -To get the full list run the command: -</P><PRE CLASS="verbatim">./configure --help -</PRE><P>Some options that you may be interested in modifying: -</P><DL CLASS="description"><DT CLASS="dt-description"> - <B><TT>--prefix=/</TT></B></DT><DD CLASS="dd-description"> - Specify the path prefix where the files will be copied when running - the <TT>make install</TT> command.<P> </P></DD><DT CLASS="dt-description"><B><TT>--enable-user[=USER]</TT></B></DT><DD CLASS="dd-description"> - Allow this normal system user to execute the ejabberdctl script - (see section <A HREF="#ejabberdctl">4.1</A>), - read the configuration files, - read and write in the spool directory, - read and write in the log directory. - The account user and group must exist in the machine - before running <TT>make install</TT>. - This account doesn’t need an explicit HOME directory, because - <TT>/var/lib/ejabberd/</TT> will be used by default.<P> </P></DD><DT CLASS="dt-description"><B><TT>--enable-pam</TT></B></DT><DD CLASS="dd-description"> - Enable the PAM authentication method (see section <A HREF="#pam">3.1.4</A>).<P> </P></DD><DT CLASS="dt-description"><B><TT>--enable-odbc or --enable-mssql</TT></B></DT><DD CLASS="dd-description"> - Required if you want to use an external database. - See section <A HREF="#database">3.2</A> for more information.<P> </P></DD><DT CLASS="dt-description"><B><TT>--enable-full-xml</TT></B></DT><DD CLASS="dd-description"> - Enable the use of XML based optimisations. - It will for example use CDATA to escape characters in the XMPP stream. - Use this option only if you are sure your XMPP clients include a fully compliant XML parser.<P> </P></DD><DT CLASS="dt-description"><B><TT>--disable-transient-supervisors</TT></B></DT><DD CLASS="dd-description"> - Disable the use of Erlang/OTP supervision for transient processes. -</DD></DL><P> <A NAME="install"></A> </P><!--TOC subsection Install--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc12">2.4.4</A>  <A HREF="#install">Install</A></H3><!--SEC END --><P> <A NAME="install"></A> -</P><P>To install <TT>ejabberd</TT> in the destination directories, run the command: -</P><PRE CLASS="verbatim">make install -</PRE><P>Note that you probably need administrative privileges in the system -to install <TT>ejabberd</TT>.</P><P>The files and directories created are, by default: -</P><DL CLASS="description"><DT CLASS="dt-description"> - <B><TT>/etc/ejabberd/</TT></B></DT><DD CLASS="dd-description"> Configuration directory: - <DL CLASS="description"><DT CLASS="dt-description"> - <B><TT>ejabberd.cfg</TT></B></DT><DD CLASS="dd-description"> ejabberd configuration file - </DD><DT CLASS="dt-description"><B><TT>ejabberdctl.cfg</TT></B></DT><DD CLASS="dd-description"> Configuration file of the administration script - </DD><DT CLASS="dt-description"><B><TT>inetrc</TT></B></DT><DD CLASS="dd-description"> Network DNS configuration file - </DD></DL> - </DD><DT CLASS="dt-description"><B><TT>/lib/ejabberd/</TT></B></DT><DD CLASS="dd-description"> - <DL CLASS="description"><DT CLASS="dt-description"> - <B><TT>ebin/</TT></B></DT><DD CLASS="dd-description"> Erlang binary files (*.beam) - </DD><DT CLASS="dt-description"><B><TT>include/</TT></B></DT><DD CLASS="dd-description"> Erlang header files (*.hrl) - </DD><DT CLASS="dt-description"><B><TT>priv/</TT></B></DT><DD CLASS="dd-description"> Additional files required at runtime - <DL CLASS="description"><DT CLASS="dt-description"> - <B><TT>bin/</TT></B></DT><DD CLASS="dd-description"> Executable programs - </DD><DT CLASS="dt-description"><B><TT>lib/</TT></B></DT><DD CLASS="dd-description"> Binary system libraries (*.so) - </DD><DT CLASS="dt-description"><B><TT>msgs/</TT></B></DT><DD CLASS="dd-description"> Translation files (*.msgs) - </DD></DL> - </DD></DL> - </DD><DT CLASS="dt-description"><B><TT>/sbin/ejabberdctl</TT></B></DT><DD CLASS="dd-description"> Administration script (see section <A HREF="#ejabberdctl">4.1</A>) - </DD><DT CLASS="dt-description"><B><TT>/share/doc/ejabberd/</TT></B></DT><DD CLASS="dd-description"> Documentation of ejabberd - </DD><DT CLASS="dt-description"><B><TT>/var/lib/ejabberd/</TT></B></DT><DD CLASS="dd-description"> Spool directory: - <DL CLASS="description"><DT CLASS="dt-description"> - <B><TT>.erlang.cookie</TT></B></DT><DD CLASS="dd-description"> Erlang cookie file (see section <A HREF="#cookie">5.3</A>) - </DD><DT CLASS="dt-description"><B><TT>acl.DCD, ...</TT></B></DT><DD CLASS="dd-description"> Mnesia database spool files (*.DCD, *.DCL, *.DAT) - </DD></DL> - </DD><DT CLASS="dt-description"><B><TT>/var/log/ejabberd/</TT></B></DT><DD CLASS="dd-description"> Log directory (see section <A HREF="#logfiles">7.1</A>): - <DL CLASS="description"><DT CLASS="dt-description"> - <B><TT>ejabberd.log</TT></B></DT><DD CLASS="dd-description"> ejabberd service log - </DD><DT CLASS="dt-description"><B><TT>erlang.log</TT></B></DT><DD CLASS="dd-description"> Erlang/OTP system log - </DD></DL> -</DD></DL><P> <A NAME="start"></A> </P><!--TOC subsection Start--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc13">2.4.5</A>  <A HREF="#start">Start</A></H3><!--SEC END --><P> <A NAME="start"></A> -</P><P>You can use the <TT>ejabberdctl</TT> command line administration script to start and stop <TT>ejabberd</TT>. -If you provided the configure option <TT>--enable-user=USER</TT> (see <A HREF="#compile">2.4.3</A>), -you can execute <TT>ejabberdctl</TT> with either that system account or root.</P><P>Usage example: -</P><PRE CLASS="verbatim">ejabberdctl start - -ejabberdctl status -The node ejabberd@localhost is started with status: started -ejabberd is running in that node - -ejabberdctl stop -</PRE><P>If <TT>ejabberd</TT> doesn’t start correctly and a crash dump is generated, -there was a severe problem. -You can try starting <TT>ejabberd</TT> with -the command <TT>ejabberdctl live</TT> -to see the error message provided by Erlang -and can identify what is exactly the problem.</P><P>Please refer to the section <A HREF="#ejabberdctl">4.1</A> for details about <TT>ejabberdctl</TT>, -and configurable options to fine tune the Erlang runtime system.</P><P>If you want ejabberd to be started as daemon at boot time, -copy <TT>ejabberd.init</TT> to something like <TT>/etc/init.d/ejabberd</TT> -(depending on your distribution). -Create a system user called <TT>ejabberd</TT>; -it will be used by the script to start the server. -Then you can call <TT>/etc/inid.d/ejabberd start</TT> as root to start the server.</P><P> <A NAME="bsd"></A> </P><!--TOC subsection Specific Notes for BSD--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc14">2.4.6</A>  <A HREF="#bsd">Specific Notes for BSD</A></H3><!--SEC END --><P> <A NAME="bsd"></A> -</P><P>The command to compile <TT>ejabberd</TT> in BSD systems is: -</P><PRE CLASS="verbatim">gmake -</PRE><P> <A NAME="solaris"></A> </P><!--TOC subsection Specific Notes for Sun Solaris--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc15">2.4.7</A>  <A HREF="#solaris">Specific Notes for Sun Solaris</A></H3><!--SEC END --><P> <A NAME="solaris"></A> -</P><P>You need to have <TT>GNU install</TT>, -but it isn’t included in Solaris. -It can be easily installed if your Solaris system -is set up for <A HREF="http://www.blastwave.org/">blastwave.org</A> -package repository. -Make sure <TT>/opt/csw/bin</TT> is in your <TT>PATH</TT> and run: -</P><PRE CLASS="verbatim">pkg-get -i fileutils -</PRE><P>If that program is called <TT>ginstall</TT>, -modify the <TT>ejabberd</TT> <TT>Makefile</TT> script to suit your system, -for example: -</P><PRE CLASS="verbatim">cat Makefile | sed s/install/ginstall/ > Makefile.gi -</PRE><P>And finally install <TT>ejabberd</TT> with: -</P><PRE CLASS="verbatim">gmake -f Makefile.gi ginstall -</PRE><P> <A NAME="windows"></A> </P><!--TOC subsection Specific Notes for Microsoft Windows--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc16">2.4.8</A>  <A HREF="#windows">Specific Notes for Microsoft Windows</A></H3><!--SEC END --><P> <A NAME="windows"></A> -</P><P> <A NAME="windowsreq"></A> </P><!--TOC subsubsection Requirements--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#windowsreq">Requirements</A></H4><!--SEC END --><P> <A NAME="windowsreq"></A> </P><P>To compile <TT>ejabberd</TT> on a Microsoft Windows system, you need: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -MS Visual C++ 6.0 Compiler -</LI><LI CLASS="li-itemize"><A HREF="http://www.erlang.org/download.html">Erlang/OTP R12B-5</A>. Support for R13 or higher is experimental. -</LI><LI CLASS="li-itemize"><A HREF="http://support.process-one.net/doc/display/EXMPP">exmpp 0.9.5 or higher</A> -</LI><LI CLASS="li-itemize"><A HREF="http://www.slproweb.com/products/Win32OpenSSL.html">Shining Light OpenSSL 0.9.8d or higher</A> -(to enable SSL connections) -</LI><LI CLASS="li-itemize"><A HREF="http://www.zlib.net/">Zlib 1.2.3 or higher</A> -</LI></UL><P> <A NAME="windowscom"></A> </P><!--TOC subsubsection Compilation--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#windowscom">Compilation</A></H4><!--SEC END --><P> <A NAME="windowscom"></A> </P><P>We assume that we will try to put as much library as possible into <CODE>C:\sdk\</CODE> to make it easier to track what is install for <TT>ejabberd</TT>.</P><OL CLASS="enumerate" type=1><LI CLASS="li-enumerate"> -Install Erlang emulator (for example, into <CODE>C:\sdk\erl5.6.5</CODE>). -</LI><LI CLASS="li-enumerate">Install OpenSSL in <CODE>C:\sdk\OpenSSL</CODE> and add <CODE>C:\sdk\OpenSSL\lib\VC</CODE> to your path or copy the binaries to your system directory. -</LI><LI CLASS="li-enumerate">Install ZLib in <CODE>C:\sdk\gnuWin32</CODE>. Copy -<CODE>C:\sdk\GnuWin32\bin\zlib1.dll</CODE> to your system directory. -</LI><LI CLASS="li-enumerate">Make sure the you can access Erlang binaries from your path. For example: <CODE>set PATH=%PATH%;"C:\sdk\erl5.6.5\bin"</CODE> -</LI><LI CLASS="li-enumerate">Depending on how you end up actually installing the library you might need to check and tweak the paths in the file configure.erl. -</LI><LI CLASS="li-enumerate">While in the directory <CODE>ejabberd\src</CODE> run: -<PRE CLASS="verbatim">configure.bat -nmake -f Makefile.win32 -</PRE></LI><LI CLASS="li-enumerate">Edit the file <CODE>ejabberd\src\ejabberd.cfg</CODE> and run -<PRE CLASS="verbatim">werl -s ejabberd -name ejabberd -</PRE></LI></OL><P> <A NAME="initialadmin"></A> </P><!--TOC section Create a XMPP Account for Administration--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc17">2.5</A>  <A HREF="#initialadmin">Create a XMPP Account for Administration</A></H2><!--SEC END --><P> <A NAME="initialadmin"></A> </P><P>You need a XMPP account and grant him administrative privileges -to enter the <TT>ejabberd</TT> Web Admin: -</P><OL CLASS="enumerate" type=1><LI CLASS="li-enumerate"> -Register a XMPP account on your <TT>ejabberd</TT> server, for example <TT>admin1@example.org</TT>. -There are two ways to register a XMPP account: -<OL CLASS="enumerate" type=a><LI CLASS="li-enumerate"> -Using <TT>ejabberdctl</TT> (see section <A HREF="#ejabberdctl">4.1</A>): -<PRE CLASS="verbatim">ejabberdctl register admin1 example.org FgT5bk3 -</PRE></LI><LI CLASS="li-enumerate">Using a XMPP client and In-Band Registration (see section <A HREF="#modregister">3.3.18</A>). -</LI></OL> -</LI><LI CLASS="li-enumerate">Edit the <TT>ejabberd</TT> configuration file to give administration rights to the XMPP account you created: -<PRE CLASS="verbatim">{acl, admins, {user, "admin1", "example.org"}}. -{access, configure, [{allow, admins}]}. -</PRE>You can grant administrative privileges to many XMPP accounts, -and also to accounts in other XMPP servers. -</LI><LI CLASS="li-enumerate">Restart <TT>ejabberd</TT> to load the new configuration. -</LI><LI CLASS="li-enumerate">Open the Web Admin (<CODE>http://server:port/admin/</CODE>) in your -favourite browser. Make sure to enter the <EM>full</EM> JID as username (in this -example: <TT>admin1@example.org</TT>. The reason that you also need to enter the -suffix, is because <TT>ejabberd</TT>’s virtual hosting support. -</LI></OL><P> <A NAME="upgrade"></A> </P><!--TOC section Upgrading <TT>ejabberd</TT>--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc18">2.6</A>  <A HREF="#upgrade">Upgrading <TT>ejabberd</TT></A></H2><!--SEC END --><P> <A NAME="upgrade"></A> </P><P>To upgrade an ejabberd installation to a new version, -simply uninstall the old version, and then install the new one. -Of course, it is important that the configuration file -and Mnesia database spool directory are not removed.</P><P><TT>ejabberd</TT> automatically updates the Mnesia table definitions at startup when needed. -If you also use an external database for storage of some modules, -check if the release notes of the new ejabberd version -indicates you need to also update those tables.</P><P> <A NAME="configure"></A> </P><!--TOC chapter Configuring <TT>ejabberd</TT>--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc19">Chapter 3</A>  <A HREF="#configure">Configuring <TT>ejabberd</TT></A></H1><!--SEC END --><P> <A NAME="configure"></A> -</P><P> <A NAME="basicconfig"></A> </P><!--TOC section Basic Configuration--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc20">3.1</A>  <A HREF="#basicconfig">Basic Configuration</A></H2><!--SEC END --><P> <A NAME="basicconfig"></A> </P><P>The configuration file will be loaded the first time you start <TT>ejabberd</TT>. The -content from this file will be parsed and stored in the internal <TT>ejabberd</TT> database. Subsequently the -configuration will be loaded from the database and any commands in the -configuration file are appended to the entries in the database.</P><P>Note that <TT>ejabberd</TT> never edits the configuration file. -So, the configuration changes done using the Web Admin -are stored in the database, but are not reflected in the configuration file. -If you want those changes to be use after <TT>ejabberd</TT> restart, you can either -edit the configuration file, or remove all its content.</P><P>The configuration file contains a sequence of Erlang terms. Lines beginning with a -<TT>‘%’</TT> sign are ignored. Each term is a tuple of which the first element is -the name of an option, and any further elements are that option’s values. If the -configuration file do not contain for instance the ‘hosts’ option, the old -host name(s) stored in the database will be used.</P><P>You can override the old values stored in the database by adding next lines to -the beginning of the configuration file: -</P><PRE CLASS="verbatim">override_global. -override_local. -override_acls. -</PRE><P>With these lines the old global options (shared between all <TT>ejabberd</TT> nodes in a -cluster), local options (which are specific for this particular <TT>ejabberd</TT> node) -and ACLs will be removed before new ones are added.</P><P> <A NAME="hostnames"></A> </P><!--TOC subsection Host Names--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc21">3.1.1</A>  <A HREF="#hostnames">Host Names</A></H3><!--SEC END --><P> <A NAME="hostnames"></A> -</P><P>The option <TT>hosts</TT> defines a list containing one or more domains that -<TT>ejabberd</TT> will serve.</P><P>The syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{hosts, [HostName, ...]}.</TT></B></DT></DL><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -Serving one domain: -<PRE CLASS="verbatim">{hosts, ["example.org"]}. -</PRE></LI><LI CLASS="li-itemize">Serving three domains: -<PRE CLASS="verbatim">{hosts, ["example.net", "example.com", "jabber.somesite.org"]}. -</PRE></LI></UL><P> <A NAME="virtualhost"></A> </P><!--TOC subsection Virtual Hosting--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc22">3.1.2</A>  <A HREF="#virtualhost">Virtual Hosting</A></H3><!--SEC END --><P> <A NAME="virtualhost"></A> -</P><P>Options can be defined separately for every virtual host using the -<TT>host_config</TT> option.</P><P>The syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{host_config, HostName, [Option, ...]}</TT></B></DT></DL><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -Domain <TT>example.net</TT> is using the internal authentication method while -domain <TT>example.com</TT> is using the LDAP server running on the -domain <TT>localhost</TT> to perform authentication: -<PRE CLASS="verbatim">{host_config, "example.net", [{auth_method, storage}, - {auth_storage, mnesia}]}. - -{host_config, "example.com", [{auth_method, ldap], - {ldap_servers, ["localhost"]}, - {ldap_uids, [{"uid"}]}, - {ldap_rootdn, "dc=localdomain"}, - {ldap_rootdn, "dc=example,dc=com"}, - {ldap_password, ""}]}. -</PRE></LI><LI CLASS="li-itemize">Domain <TT>example.net</TT> is using ODBC to perform authentication -while domain <TT>example.com</TT> is using the LDAP servers running on the domains -<TT>localhost</TT> and <TT>otherhost</TT>: -<PRE CLASS="verbatim">{host_config, "example.net", [{auth_method, storage}, - {auth_storage, odbc}, - {odbc_server, "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"}]}. - -{host_config, "example.com", [{auth_method, ldap}, - {ldap_servers, ["localhost", "otherhost"]}, - {ldap_uids, [{"uid"}]}, - {ldap_rootdn, "dc=localdomain"}, - {ldap_rootdn, "dc=example,dc=com"}, - {ldap_password, ""}]}. -</PRE></LI></UL><P>To define specific ejabberd modules in a virtual host, -you can define the global <TT>modules</TT> option with the common modules, -and later add specific modules to certain virtual hosts. -To accomplish that, instead of defining each option in <TT>host_config</TT> with the general syntax -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{OptionName, OptionValue}</TT></B></DT></DL><P> -use this syntax: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{{add, OptionName}, OptionValue}</TT></B></DT></DL><P>In this example three virtual hosts have some similar modules, but there are also -other different modules for some specific virtual hosts: -</P><PRE CLASS="verbatim">%% This ejabberd server has three vhosts: -{hosts, ["one.example.org", "two.example.org", "three.example.org"]}. - -%% Configuration of modules that are common to all vhosts -{modules, - [ - {mod_roster, []}, - {mod_configure, []}, - {mod_disco, []}, - {mod_private, []}, - {mod_time, []}, - {mod_last, []}, - {mod_version, []} - ]}. - -%% Add some modules to vhost one: -{host_config, "one.example.org", - [{{add, modules}, [ - {mod_echo, [{host, "echo-service.one.example.org"}]} - {mod_http_bind, []}, - {mod_logxml, []} - ] - } - ]}. - -%% Add a module just to vhost two: -{host_config, "two.example.org", - [{{add, modules}, [ - {mod_echo, [{host, "mirror.two.example.org"}]} - ] - } - ]}. -</PRE><P> <A NAME="listened"></A> </P><!--TOC subsection Listening Ports--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc23">3.1.3</A>  <A HREF="#listened">Listening Ports</A></H3><!--SEC END --><P> <A NAME="listened"></A> -</P><P>The option <TT>listen</TT> defines for which ports, addresses and network protocols <TT>ejabberd</TT> -will listen and what services will be run on them. Each element of the list is a -tuple with the following elements: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -Port number. Optionally also the IP address and/or a transport protocol. -</LI><LI CLASS="li-itemize">Listening module that serves this port. -</LI><LI CLASS="li-itemize">Options for the TCP socket and for the listening module. -</LI></UL><P>The option syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{listen, [Listener, ...]}.</TT></B></DT></DL><P>To define a listener there are several syntax. -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{PortNumber, Module, [Option, ...]}</TT></B></DT></DL><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{{PortNumber, IPaddress}, Module, [Option, ...]}</TT></B></DT></DL><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{{PortNumber, TransportProtocol}, Module, [Option, ...]}</TT></B></DT></DL><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{{PortNumber, IPaddress, TransportProtocol}, Module, [Option, ...]}</TT></B></DT></DL><P> <A NAME="listened-port"></A> </P><!--TOC subsubsection Port Number, IP Address and Transport Protocol--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#listened-port">Port Number, IP Address and Transport Protocol</A></H4><!--SEC END --><P> <A NAME="listened-port"></A> </P><P>The port number defines which port to listen for incoming connections. -It can be a Jabber/XMPP standard port -(see section <A HREF="#firewall">5.1</A>) or any other valid port number.</P><P>The IP address can be represented with a string -or an Erlang tuple with decimal or hexadecimal numbers. -The socket will listen only in that network interface. -It is possible to specify a generic address, -so <TT>ejabberd</TT> will listen in all addresses. -Depending in the type of the IP address, IPv4 or IPv6 will be used. -When not specified the IP address, it will listen on all IPv4 network addresses.</P><P>Some example values for IP address: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -<CODE>"0.0.0.0"</CODE> to listen in all IPv4 network interfaces. This is the default value when no IP is specified. -</LI><LI CLASS="li-itemize"><CODE>"::"</CODE> to listen in all IPv6 network interfaces -</LI><LI CLASS="li-itemize"><CODE>"10.11.12.13"</CODE> is the IPv4 address <CODE>10.11.12.13</CODE> -</LI><LI CLASS="li-itemize"><CODE>"::FFFF:127.0.0.1"</CODE> is the IPv6 address <CODE>::FFFF:127.0.0.1/128</CODE> -</LI><LI CLASS="li-itemize"><CODE>{10, 11, 12, 13}</CODE> is the IPv4 address <CODE>10.11.12.13</CODE> -</LI><LI CLASS="li-itemize"><CODE>{0, 0, 0, 0, 0, 65535, 32512, 1}</CODE> is the IPv6 address <CODE>::FFFF:127.0.0.1/128</CODE> -</LI><LI CLASS="li-itemize"><CODE>{16#fdca, 16#8ab6, 16#a243, 16#75ef, 0, 0, 0, 1}</CODE> is the IPv6 address <CODE>FDCA:8AB6:A243:75EF::1/128</CODE> -</LI></UL><P>The transport protocol can be <TT>tcp</TT> or <TT>udp</TT>. -Default is <TT>tcp</TT>.</P><P> <A NAME="listened-module"></A> </P><!--TOC subsubsection Listening Module--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#listened-module">Listening Module</A></H4><!--SEC END --><P> <A NAME="listened-module"></A> </P><P> -The available modules, their purpose and the options allowed by each one are: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>ejabberd_c2s</TT></B></DT><DD CLASS="dd-description"> -Handles c2s connections.<BR> - Options: <TT>access</TT>, <TT>certfile</TT>, <TT>max_fsm_queue</TT>, -<TT>max_stanza_size</TT>, <TT>shaper</TT>, -<TT>starttls</TT>, <TT>starttls_required</TT>, <TT>tls</TT>, -<TT>zlib</TT> -</DD><DT CLASS="dt-description"><B><TT>ejabberd_s2s_in</TT></B></DT><DD CLASS="dd-description"> -Handles incoming s2s connections.<BR> - Options: <TT>max_stanza_size</TT>, <TT>shaper</TT> -</DD><DT CLASS="dt-description"><B><TT>ejabberd_service</TT></B></DT><DD CLASS="dd-description"> -Interacts with an <A HREF="http://www.ejabberd.im/tutorials-transports">external component</A> -(as defined in the Jabber Component Protocol (<A HREF="http://xmpp.org/extensions/xep-0114.html">XEP-0114</A>).<BR> - Options: <TT>access</TT>, <TT>hosts</TT>, <TT>max_fsm_queue</TT>, -<TT>service_check_from</TT>, <TT>shaper</TT> -</DD><DT CLASS="dt-description"><B><TT>ejabberd_stun</TT></B></DT><DD CLASS="dd-description"> -Handles STUN Binding requests as defined in -<A HREF="http://tools.ietf.org/html/rfc5389">RFC 5389</A>.<BR> - Options: <TT>certfile</TT> -</DD><DT CLASS="dt-description"><B><TT>ejabberd_http</TT></B></DT><DD CLASS="dd-description"> -Handles incoming HTTP connections.<BR> - Options: <TT>captcha</TT>, <TT>certfile</TT>, <TT>http_bind</TT>, <TT>http_poll</TT>, -<TT>request_handlers</TT>, <TT>tls</TT>, <TT>web_admin</TT><BR> -</DD></DL><P> <A NAME="listened-options"></A> </P><!--TOC subsubsection Options--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#listened-options">Options</A></H4><!--SEC END --><P> <A NAME="listened-options"></A> </P><P>This is a detailed description of each option allowed by the listening modules: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{access, AccessName}</TT></B></DT><DD CLASS="dd-description"> This option defines -access to the port. The default value is <TT>all</TT>. -</DD><DT CLASS="dt-description"><B><TT>{backlog, Value}</TT></B></DT><DD CLASS="dd-description"> The backlog value -defines the maximum length that the queue of pending connections may -grow to. This should be increased if the server is going to handle -lots of new incoming connections as they may be dropped if there is -no space in the queue (and ejabberd was not able to accept them -immediately). Default value is 5. -</DD><DT CLASS="dt-description"><B><TT>captcha</TT></B></DT><DD CLASS="dd-description"> -Simple web page that allows a user to fill a CAPTCHA challenge (see section <A HREF="#captcha">3.1.8</A>). -</DD><DT CLASS="dt-description"><B><TT>{certfile, Path}</TT></B></DT><DD CLASS="dd-description"> Full path to a file containing the default SSL certificate. -To define a certificate file specific for a given domain, use the global option <TT>domain_certfile</TT>. -</DD><DT CLASS="dt-description"><B><TT>{hosts, [Hostname, ...], [HostOption, ...]}</TT></B></DT><DD CLASS="dd-description"> -The external Jabber component that connects to this <TT>ejabberd_service</TT> -can serve one or more hostnames. -As <TT>HostOption</TT> you can define options for the component; -currently the only allowed option is the password required to the component -when attempt to connect to ejabberd: <TT>{password, Secret}</TT>. -Note that you cannot define in a single <TT>ejabberd_service</TT> components of -different services: add an <TT>ejabberd_service</TT> for each service, -as seen in an example below. -</DD><DT CLASS="dt-description"><B><TT>http_bind</TT></B></DT><DD CLASS="dd-description"> -This option enables HTTP Binding (<A HREF="http://xmpp.org/extensions/xep-0124.html">XEP-0124</A> and <A HREF="http://xmpp.org/extensions/xep-0206.html">XEP-0206</A>) support. HTTP Bind -enables access via HTTP requests to <TT>ejabberd</TT> from behind firewalls which -do not allow outgoing sockets on port 5222.<P>Remember that you must also install and enable the module mod_http_bind.</P><P>If HTTP Bind is enabled, it will be available at -<CODE>http://server:port/http-bind/</CODE>. Be aware that support for HTTP Bind -is also needed in the XMPP client. Remark also that HTTP Bind can be -interesting to host a web-based XMPP client such as -<A HREF="http://jwchat.sourceforge.net/">JWChat</A> -(check the tutorials to install JWChat with ejabberd and an -<A HREF="http://www.ejabberd.im/jwchat-localserver">embedded local web server</A> -or <A HREF="http://www.ejabberd.im/jwchat-apache">Apache</A>). -</P></DD><DT CLASS="dt-description"><B><TT>http_poll</TT></B></DT><DD CLASS="dd-description"> -This option enables HTTP Polling (<A HREF="http://xmpp.org/extensions/xep-0025.html">XEP-0025</A>) support. HTTP Polling -enables access via HTTP requests to <TT>ejabberd</TT> from behind firewalls which -do not allow outgoing sockets on port 5222.<P>If HTTP Polling is enabled, it will be available at -<CODE>http://server:port/http-poll/</CODE>. Be aware that support for HTTP Polling -is also needed in the XMPP client. Remark also that HTTP Polling can be -interesting to host a web-based XMPP client such as -<A HREF="http://jwchat.sourceforge.net/">JWChat</A>.</P><P>The maximum period of time to keep a client session active without -an incoming POST request can be configured with the global option -<TT>http_poll_timeout</TT>. The default value is five minutes. -The option can be defined in <TT>ejabberd.cfg</TT>, expressing the time -in seconds: <CODE>{http_poll_timeout, 300}.</CODE> -</P></DD><DT CLASS="dt-description"><B><TT>{max_fsm_queue, Size}</TT></B></DT><DD CLASS="dd-description"> -This option specifies the maximum number of elements in the queue of the FSM -(Finite State Machine). -Roughly speaking, each message in such queues represents one XML -stanza queued to be sent into its relevant outgoing stream. If queue size -reaches the limit (because, for example, the receiver of stanzas is too slow), -the FSM and the corresponding connection (if any) will be terminated -and error message will be logged. -The reasonable value for this option depends on your hardware configuration. -However, there is no much sense to set the size above 1000 elements. -This option can be specified for <TT>ejabberd_service</TT> and -<TT>ejabberd_c2s</TT> listeners, -or also globally for <TT>ejabberd_s2s_out</TT>. -If the option is not specified for <TT>ejabberd_service</TT> or -<TT>ejabberd_c2s</TT> listeners, -the globally configured value is used. -The allowed values are integers and ’undefined’. -Default value: ’undefined’. -</DD><DT CLASS="dt-description"><B><TT>{max_stanza_size, Size}</TT></B></DT><DD CLASS="dd-description"> -This option specifies an -approximate maximum size in bytes of XML stanzas. Approximate, -because it is calculated with the precision of one block of read -data. For example <CODE>{max_stanza_size, 65536}</CODE>. The default -value is <TT>infinity</TT>. Recommended values are 65536 for c2s -connections and 131072 for s2s connections. s2s max stanza size -must always much higher than c2s limit. Change this value with -extreme care as it can cause unwanted disconnect if set too low. -</DD><DT CLASS="dt-description"><B><TT>{request_handlers, [ {Path, Module}, ...]}</TT></B></DT><DD CLASS="dd-description"> To define one or several handlers that will serve HTTP requests. -The Path is a list of strings; so the URIs that start with that Path will be served by Module. -For example, if you want <TT>mod_foo</TT> to serve the URIs that start with <TT>/a/b/</TT>, -and you also want <TT>mod_http_bind</TT> to serve the URIs <TT>/http-bind/</TT>, -use this option: <TT>{request_handlers, [{["a", "b"], mod_foo}, {["http-bind"], mod_http_bind}]}</TT> -</DD><DT CLASS="dt-description"><B><TT>{service_check_from, true|false}</TT></B></DT><DD CLASS="dd-description"> - -This option can be used with <TT>ejabberd_service</TT> only. -<A HREF="http://xmpp.org/extensions/xep-0114.html">XEP-0114</A> requires that the domain must match the hostname of the component. -If this option is set to <TT>false</TT>, <TT>ejabberd</TT> will allow the component -to send stanzas with any arbitrary domain in the ’from’ attribute. -Only use this option if you are completely sure about it. -The default value is <TT>true</TT>, to be compliant with <A HREF="http://xmpp.org/extensions/xep-0114.html">XEP-0114</A>. -</DD><DT CLASS="dt-description"><B><TT>{shaper, none|ShaperName}</TT></B></DT><DD CLASS="dd-description"> This option defines a -shaper for the port (see section <A HREF="#shapers">3.1.6</A>). The default value -is <TT>none</TT>. -</DD><DT CLASS="dt-description"><B><TT>starttls</TT></B></DT><DD CLASS="dd-description"> This option -specifies that STARTTLS encryption is available on connections to the port. -You should also set the <TT>certfile</TT> option. -You can define a certificate file for a specific domain using the global option <TT>domain_certfile</TT>. -</DD><DT CLASS="dt-description"><B><TT>starttls_required</TT></B></DT><DD CLASS="dd-description"> This option -specifies that STARTTLS encryption is required on connections to the port. -No unencrypted connections will be allowed. -You should also set the <TT>certfile</TT> option. -You can define a certificate file for a specific domain using the global option <TT>domain_certfile</TT>. -</DD><DT CLASS="dt-description"><B><TT>tls</TT></B></DT><DD CLASS="dd-description"> This option specifies that traffic on -the port will be encrypted using SSL immediately after connecting. -This was the traditional encryption method in the early Jabber software, -commonly on port 5223 for client-to-server communications. -But this method is nowadays deprecated and not recommended. -The preferable encryption method is STARTTLS on port 5222, as defined -<A HREF="http://xmpp.org/rfcs/rfc3920.html#tls">RFC 3920: XMPP Core</A>, -which can be enabled in <TT>ejabberd</TT> with the option <TT>starttls</TT>. -If this option is set, you should also set the <TT>certfile</TT> option. -The option <TT>tls</TT> can also be used in <TT>ejabberd_http</TT> to support HTTPS. -</DD><DT CLASS="dt-description"><B><TT>web_admin</TT></B></DT><DD CLASS="dd-description"> This option -enables the Web Admin for <TT>ejabberd</TT> administration which is available -at <CODE>http://server:port/admin/</CODE>. Login and password are the username and -password of one of the registered users who are granted access by the -‘configure’ access rule. -</DD><DT CLASS="dt-description"><B><TT>zlib</TT></B></DT><DD CLASS="dd-description"> This -option specifies that Zlib stream compression (as defined in <A HREF="http://xmpp.org/extensions/xep-0138.html">XEP-0138</A>) -is available on connections to the port. -</DD></DL><P>There are some additional global options that can be specified in the ejabberd configuration file (outside <TT>listen</TT>): -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{s2s_use_starttls, true|false}</TT></B></DT><DD CLASS="dd-description"> -This option defines whether to -use STARTTLS for s2s connections. -</DD><DT CLASS="dt-description"><B><TT>{s2s_certfile, Path}</TT></B></DT><DD CLASS="dd-description"> Full path to a -file containing a SSL certificate. -</DD><DT CLASS="dt-description"><B><TT>{domain_certfile, Domain, Path}</TT></B></DT><DD CLASS="dd-description"> -Full path to the file containing the SSL certificate for a specific domain. -</DD><DT CLASS="dt-description"><B><TT>{outgoing_s2s_options, Methods, Timeout}</TT></B></DT><DD CLASS="dd-description"> -Specify which address families to try, in what order, and connect timeout in milliseconds. -By default it first tries connecting with IPv4, if that fails it tries using IPv6, -with a timeout of 10000 milliseconds. -</DD><DT CLASS="dt-description"><B><TT>{outgoing_s2s_local_address, IPaddress}</TT></B></DT><DD CLASS="dd-description"> -Specify which local IP address is desired for the outgoing S2S connections. -This option is used only if the local and remote addresses -are of the same IP version (either 4 or 6). -If this option is not defined, and the <TT>ejabberd_s2s_in</TT> -listener address is defined, then that one is used. -</DD><DT CLASS="dt-description"><B><TT>{s2s_dns_options, [ {Property, Value}, ...]}</TT></B></DT><DD CLASS="dd-description"> -Define properties to use for DNS resolving. -Allowed Properties are: <TT>timeout</TT> in seconds which default value is <TT>10</TT> -and <TT>retries</TT> which default value is <TT>2</TT>. -</DD><DT CLASS="dt-description"><B><TT>{s2s_default_policy, allow|deny}</TT></B></DT><DD CLASS="dd-description"> -The default policy for incoming and outgoing s2s connections to other XMPP servers. -The default value is <TT>allow</TT>. -</DD><DT CLASS="dt-description"><B><TT>{{s2s_host, Host}, allow|deny}</TT></B></DT><DD CLASS="dd-description"> -Defines if incoming and outgoing s2s connections with a specific remote host are allowed or denied. -This allows to restrict ejabberd to only establish s2s connections -with a small list of trusted servers, or to block some specific servers. -</DD><DT CLASS="dt-description"><B><TT>{s2s_max_retry_delay, Seconds}</TT></B></DT><DD CLASS="dd-description"> -The maximum allowed delay for retry to connect after a failed connection attempt. -Specified in seconds. The default value is 300 seconds (5 minutes). -</DD><DT CLASS="dt-description"><B><TT>{max_fsm_queue, Size}</TT></B></DT><DD CLASS="dd-description"> -This option specifies the maximum number of elements in the queue of the FSM -(Finite State Machine). -Roughly speaking, each message in such queues represents one XML -stanza queued to be sent into its relevant outgoing stream. If queue size -reaches the limit (because, for example, the receiver of stanzas is too slow), -the FSM and the corresponding connection (if any) will be terminated -and error message will be logged. -The reasonable value for this option depends on your hardware configuration. -However, there is no much sense to set the size above 1000 elements. -This option can be specified for <TT>ejabberd_service</TT> and -<TT>ejabberd_c2s</TT> listeners, -or also globally for <TT>ejabberd_s2s_out</TT>. -If the option is not specified for <TT>ejabberd_service</TT> or -<TT>ejabberd_c2s</TT> listeners, -the globally configured value is used. -The allowed values are integers and ’undefined’. -Default value: ’undefined’. -</DD><DT CLASS="dt-description"><B><TT>{route_subdomains, local|s2s}</TT></B></DT><DD CLASS="dd-description"> -Defines if ejabberd must route stanzas directed to subdomains locally (compliant with -<A HREF="http://xmpp.org/rfcs/rfc3920.html#rules.subdomain">RFC 3920: XMPP Core</A>), -or to foreign server using S2S (compliant with -<A HREF="http://tools.ietf.org/html/draft-saintandre-rfc3920bis-09#section-11.3">RFC 3920 bis</A>). -</DD></DL><P> <A NAME="listened-examples"></A> </P><!--TOC subsubsection Examples--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#listened-examples">Examples</A></H4><!--SEC END --><P> <A NAME="listened-examples"></A> </P><P>For example, the following simple configuration defines: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -There are three domains. The default certificate file is <TT>server.pem</TT>. -However, the c2s and s2s connections to the domain <TT>example.com</TT> use the file <TT>example_com.pem</TT>. -</LI><LI CLASS="li-itemize">Port 5222 listens for c2s connections with STARTTLS, -and also allows plain connections for old clients. -</LI><LI CLASS="li-itemize">Port 5223 listens for c2s connections with the old SSL. -</LI><LI CLASS="li-itemize">Port 5269 listens for s2s connections with STARTTLS. The socket is set for IPv6 instead of IPv4. -</LI><LI CLASS="li-itemize">Port 3478 listens for STUN requests over UDP. -</LI><LI CLASS="li-itemize">Port 5280 listens for HTTP requests, and serves the HTTP Poll service. -</LI><LI CLASS="li-itemize">Port 5281 listens for HTTP requests, and serves the Web Admin using HTTPS as explained in -section <A HREF="#webadmin">4.3</A>. The socket only listens connections to the IP address 127.0.0.1. -</LI></UL><PRE CLASS="verbatim">{hosts, ["example.com", "example.org", "example.net"]}. -{listen, - [ - {5222, ejabberd_c2s, [ - {access, c2s}, - {shaper, c2s_shaper}, - starttls, {certfile, "/etc/ejabberd/server.pem"}, - {max_stanza_size, 65536} - ]}, - {5223, ejabberd_c2s, [ - {access, c2s}, - {shaper, c2s_shaper}, - tls, {certfile, "/etc/ejabberd/server.pem"}, - {max_stanza_size, 65536} - ]}, - {{5269, "::"}, ejabberd_s2s_in, [ - {shaper, s2s_shaper}, - {max_stanza_size, 131072} - ]}, - {{3478, udp}, ejabberd_stun, []}, - {5280, ejabberd_http, [ - http_poll - ]}, - {{5281, "127.0.0.1"}, ejabberd_http, [ - web_admin, - tls, {certfile, "/etc/ejabberd/server.pem"}, - ]} - ] -}. -{s2s_use_starttls, true}. -{s2s_certfile, "/etc/ejabberd/server.pem"}. -{domain_certfile, "example.com", "/etc/ejabberd/example_com.pem"}. -</PRE><P>In this example, the following configuration defines that: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -c2s connections are listened for on port 5222 (all IPv4 addresses) and -on port 5223 (SSL, IP 192.168.0.1 and fdca:8ab6:a243:75ef::1) and denied -for the user called ‘<TT>bad</TT>’. -</LI><LI CLASS="li-itemize">s2s connections are listened for on port 5269 (all IPv4 addresses) -with STARTTLS for secured traffic enabled. -Incoming and outgoing connections of remote XMPP servers are denied, -only two servers can connect: "jabber.example.org" and "example.com". -</LI><LI CLASS="li-itemize">Port 5280 is serving the Web Admin and the HTTP Polling service -in all the IPv4 addresses. Note -that it is also possible to serve them on different ports. The second -example in section <A HREF="#webadmin">4.3</A> shows how exactly this can be done. -</LI><LI CLASS="li-itemize">All users except for the administrators have a traffic of limit -1,000 Bytes/second -</LI><LI CLASS="li-itemize">The -<A HREF="http://www.ejabberd.im/pyaimt">AIM transport</A> -<TT>aim.example.org</TT> is connected to port 5233 on localhost IP addresses -(127.0.0.1 and ::1) with password ‘<TT>aimsecret</TT>’. -</LI><LI CLASS="li-itemize">The ICQ transport JIT (<TT>icq.example.org</TT> and -<TT>sms.example.org</TT>) is connected to port 5234 with password -‘<TT>jitsecret</TT>’. -</LI><LI CLASS="li-itemize">The -<A HREF="http://www.ejabberd.im/pymsnt">MSN transport</A> -<TT>msn.example.org</TT> is connected to port 5235 with password -‘<TT>msnsecret</TT>’. -</LI><LI CLASS="li-itemize">The -<A HREF="http://www.ejabberd.im/yahoo-transport-2">Yahoo! transport</A> -<TT>yahoo.example.org</TT> is connected to port 5236 with password -‘<TT>yahoosecret</TT>’. -</LI><LI CLASS="li-itemize">The <A HREF="http://www.ejabberd.im/jabber-gg-transport">Gadu-Gadu transport</A> <TT>gg.example.org</TT> is -connected to port 5237 with password ‘<TT>ggsecret</TT>’. -</LI><LI CLASS="li-itemize">The -<A HREF="http://www.ejabberd.im/jmc">Jabber Mail Component</A> -<TT>jmc.example.org</TT> is connected to port 5238 with password -‘<TT>jmcsecret</TT>’. -</LI><LI CLASS="li-itemize">The service custom has enabled the special option to avoiding checking the <TT>from</TT> attribute in the packets send by this component. The component can send packets in behalf of any users from the server, or even on behalf of any server. -</LI></UL><PRE CLASS="verbatim">{acl, blocked, {user, "bad"}}. -{access, c2s, [{deny, blocked}, - {allow, all}]}. -{shaper, normal, {maxrate, 1000}}. -{access, c2s_shaper, [{none, admin}, - {normal, all}]}. -{listen, - [{5222, ejabberd_c2s, [ - {access, c2s}, - {shaper, c2s_shaper} - ]}, - {{5223, {192, 168, 0, 1}}, ejabberd_c2s, [ - {access, c2s}, - ssl, {certfile, "/path/to/ssl.pem"} - ]}, - {{5223, {16#fdca, 16#8ab6, 16#a243, 16#75ef, 0, 0, 0, 1}}, - ejabberd_c2s, [ - {access, c2s}, - ssl, {certfile, "/path/to/ssl.pem"} - ]}, - {5269, ejabberd_s2s_in, []}, - {{5280, {0, 0, 0, 0}}, ejabberd_http, [ - http_poll, - web_admin - ]}, - {{5233, {127, 0, 0, 1}}, ejabberd_service, [ - {hosts, ["aim.example.org"], - [{password, "aimsecret"}]} - ]}, - {{5233, "::1"}, ejabberd_service, [ - {hosts, ["aim.example.org"], - [{password, "aimsecret"}]} - ]}, - {5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"], - [{password, "jitsecret"}]}]}, - {5235, ejabberd_service, [{hosts, ["msn.example.org"], - [{password, "msnsecret"}]}]}, - {5236, ejabberd_service, [{hosts, ["yahoo.example.org"], - [{password, "yahoosecret"}]}]}, - {5237, ejabberd_service, [{hosts, ["gg.example.org"], - [{password, "ggsecret"}]}]}, - {5238, ejabberd_service, [{hosts, ["jmc.example.org"], - [{password, "jmcsecret"}]}]}, - {5239, ejabberd_service, [{hosts, ["custom.example.org"], - [{password, "customsecret"}]}, - {service_check_from, false}]} - ] -}. -{s2s_use_starttls, true}. -{s2s_certfile, "/path/to/ssl.pem"}. -{s2s_default_policy, deny}. -{{s2s_host,"jabber.example.org"}, allow}. -{{s2s_host,"example.com"}, allow}. -</PRE><P>Note, that for services based in jabberd14 or WPJabber -you have to make the transports log and do XDB by themselves: -</P><PRE CLASS="verbatim"> <!-- - You have to add elogger and rlogger entries here when using ejabberd. - In this case the transport will do the logging. - --> - - <log id='logger'> - <host/> - <logtype/> - <format>%d: [%t] (%h): %s</format> - <file>/var/log/jabber/service.log</file> - </log> - - <!-- - Some XMPP server implementations do not provide - XDB services (for example, jabberd2 and ejabberd). - xdb_file.so is loaded in to handle all XDB requests. - --> - - <xdb id="xdb"> - <host/> - <load> - <!-- this is a lib of wpjabber or jabberd14 --> - <xdb_file>/usr/lib/jabber/xdb_file.so</xdb_file> - </load> - <xdb_file xmlns="jabber:config:xdb_file"> - <spool><jabberd:cmdline flag='s'>/var/spool/jabber</jabberd:cmdline></spool> - </xdb_file> - </xdb> -</PRE><P> <A NAME="auth"></A> </P><!--TOC subsection Authentication--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc24">3.1.4</A>  <A HREF="#auth">Authentication</A></H3><!--SEC END --><P> <A NAME="auth"></A> -</P><P>The option <TT>auth_method</TT> defines the authentication methods that are used -for user authentication. -Usually only one method is defined, with this syntax: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{auth_method, Method}.</TT></B></DT></DL><P> -This full syntax can be used to specify one or more methods: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{auth_method, [Method1, Method2, ...]}.</TT></B></DT></DL><P>The following authentication methods are supported by <TT>ejabberd</TT>: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -database storage in internal Mnesia or ODBC — See section <A HREF="#authstorage">3.1.4</A>. -</LI><LI CLASS="li-itemize">external — See section <A HREF="#extauth">3.1.4</A>. -</LI><LI CLASS="li-itemize">ldap — See section <A HREF="#ldap">3.2.5</A>. -</LI><LI CLASS="li-itemize">anonymous — See section <A HREF="#saslanonymous">3.1.4</A>. -</LI><LI CLASS="li-itemize">pam — See section <A HREF="#pam">3.1.4</A>. -</LI><LI CLASS="li-itemize">a method with SASL GSSAPI — See section <A HREF="#gssapi">3.1.4</A>. -</LI></UL><P>Account creation is only supported by the methods: -internal Mnesia storage, ODBC storage, and external.</P><P> <A NAME="authstorage"></A> </P><!--TOC subsubsection Database Storage--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#authstorage">Database Storage</A></H4><!--SEC END --><P> <A NAME="authstorage"></A> -</P><P>You can configure <TT>ejabberd</TT> to use the database storage authentication method, -and store either in the internal Mnesia database or in an ODBC database. -The specific storage is configured with the option: -</P><PRE CLASS="verbatim">{auth_storage, mnesia|odbc} -</PRE><P>When the storage is configured for ODBC, the ODBC server is -configured with the <TT>odbc_server</TT> option, see -<A HREF="#mysql">3.2.1</A> for MySQL, <A HREF="#pgsql">3.2.3</A> for PostgreSQL, <A HREF="#mssql">3.2.2</A> for MSSQL, and <A HREF="#odbc">3.2.4</A> for generic ODBC.</P><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -To use internal Mnesia storage on all virtual hosts: -<PRE CLASS="verbatim">{auth_method, storage}. -{auth_storage, mnesia}. -</PRE></LI><LI CLASS="li-itemize">To use ODBC storage on all virtual hosts: -<PRE CLASS="verbatim">{auth_method, storage}. -{auth_storage, odbc}. -</PRE></LI><LI CLASS="li-itemize">To use Mnesia storage on <TT>example.org</TT>, -ODBC storage in a MySQL database on <TT>example.com</TT>, -ODBC storage in a PostgreSQL database on <TT>example2.com</TT>, -and LDAP on <TT>example.net</TT>: -<PRE CLASS="verbatim">{host_config, "example.org", [ - {auth_method, storage}, - {auth_storage, mnesia} -]}. -{host_config, "example.com", [ - {auth_method, storage}, - {auth_storage, odbc}, - {odbc_server, {mysql, "localhost", "test", "root", "password"}} -]}. -{host_config, "example2.com", [ - {auth_method, storage}, - {auth_storage, odbc}, - {odbc_server, "DSN=database;UID=ejabberd;PWD=password"} -]}. -{host_config, "example.net", [ - {auth_method, ldap} -]}. -</PRE></LI></UL><P> <A NAME="extauth"></A> </P><!--TOC subsubsection External Script--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#extauth">External Script</A></H4><!--SEC END --><P> <A NAME="extauth"></A> -</P><P>In this authentication method, when <TT>ejabberd</TT> starts, -it start a script, and calls it to perform authentication tasks.</P><P>The server administrator can write the external authentication script -in any language. -The details on the interface between ejabberd and the script are described -in the <TT>ejabberd Developers Guide</TT>. -There are also <A HREF="http://www.ejabberd.im/extauth">several example authentication scripts</A>.</P><P>These are the specific options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{extauth_program, PathToScript}</TT></B></DT><DD CLASS="dd-description"> -Indicate in this option the full path to the external authentication script. -The script must be executable by ejabberd.</DD><DT CLASS="dt-description"><B><TT>{extauth_instances, Integer}</TT></B></DT><DD CLASS="dd-description"> -Indicate how many instances of the script to run simultaneously to serve authentication in the virtual host. -The default value is the minimum number: 1.</DD><DT CLASS="dt-description"><B><TT>{extauth_cache, false|CacheTimeInteger}</TT></B></DT><DD CLASS="dd-description"> -The value <TT>false</TT> disables the caching feature, this is the default. -The integer <TT>0</TT> (zero) enables caching for statistics, but doesn’t use that cached information to authenticate users. -If another integer value is set, caching is enabled both for statistics and for authentication: -the CacheTimeInteger indicates the number of seconds that ejabberd can reuse -the authentication information since the user last disconnected, -to verify again the user authentication without querying again the extauth script. -Note: caching should not be enabled in a host if internal auth is also enabled. -If caching is enabled, <TT>mod_last</TT> must be enabled also in that vhost. -</DD></DL><P>This example sets external authentication, the extauth script, enables caching for 10 minutes, -and starts three instances of the script for each virtual host defined in ejabberd: -</P><PRE CLASS="verbatim">{auth_method, external}. -{extauth_program, "/etc/ejabberd/JabberAuth.class.php"}. -{extauth_cache, 600}. -{extauth_instances, 3}. -</PRE><P> <A NAME="saslanonymous"></A> </P><!--TOC subsubsection SASL Anonymous and Anonymous Login--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#saslanonymous">SASL Anonymous and Anonymous Login</A></H4><!--SEC END --><P> <A NAME="saslanonymous"></A> -</P><P>The value <TT>anonymous</TT> will enable the internal authentication method.</P><P>The anonymous authentication method can be configured with the following -options. Remember that you can use the <TT>host_config</TT> option to set virtual -host specific options (see section <A HREF="#virtualhost">3.1.2</A>). Note that there also -is a detailed tutorial regarding <A HREF="http://support.process-one.net/doc/display/MESSENGER/Anonymous+users+support">SASL -Anonymous and anonymous login configuration</A>.</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{allow_multiple_connections, false|true}</TT></B></DT><DD CLASS="dd-description"> This option is only used -when the anonymous mode is -enabled. Setting it to <TT>true</TT> means that the same username can be taken -multiple times in anonymous login mode if different resource are used to -connect. This option is only useful in very special occasions. The default -value is <TT>false</TT>. -</DD><DT CLASS="dt-description"><B><TT>{anonymous_protocol, sasl_anon | login_anon | both}</TT></B></DT><DD CLASS="dd-description"> -<TT>sasl_anon</TT> means -that the SASL Anonymous method will be used. <TT>login_anon</TT> means that the -anonymous login method will be used. <TT>both</TT> means that SASL Anonymous and -login anonymous are both enabled. -</DD></DL><P>Those options are defined for each virtual host with the <TT>host_config</TT> -parameter (see section <A HREF="#virtualhost">3.1.2</A>).</P><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -To enable anonymous login on all virtual hosts: -<PRE CLASS="verbatim">{auth_method, anonymous}. -{anonymous_protocol, login_anon}. -</PRE></LI><LI CLASS="li-itemize">Similar as previous example, but limited to <TT>public.example.org</TT>: -<PRE CLASS="verbatim">{host_config, "public.example.org", [{auth_method, anonymous}, - {anonymous_protocol, login_anon}]}. -</PRE></LI><LI CLASS="li-itemize">To enable anonymous login and internal authentication on a virtual host: -<PRE CLASS="verbatim">{host_config, "public.example.org", [{auth_method, [internal, anonymous]}, - {anonymous_protocol, login_anon}]}. -</PRE></LI><LI CLASS="li-itemize">To enable SASL Anonymous on a virtual host: -<PRE CLASS="verbatim">{host_config, "public.example.org", [{auth_method, anonymous}, - {anonymous_protocol, sasl_anon}]}. -</PRE></LI><LI CLASS="li-itemize">To enable SASL Anonymous and anonymous login on a virtual host: -<PRE CLASS="verbatim">{host_config, "public.example.org", [{auth_method, anonymous}, - {anonymous_protocol, both}]}. -</PRE></LI><LI CLASS="li-itemize">To enable SASL Anonymous, anonymous login, and internal authentication on -a virtual host: -<PRE CLASS="verbatim">{host_config, "public.example.org", [{auth_method, [internal, anonymous]}, - {anonymous_protocol, both}]}. -</PRE></LI></UL><P> <A NAME="pam"></A> </P><!--TOC subsubsection PAM Authentication--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#pam">PAM Authentication</A></H4><!--SEC END --><P> <A NAME="pam"></A> -</P><P><TT>ejabberd</TT> supports authentication via Pluggable Authentication Modules (PAM). -PAM is currently supported in AIX, FreeBSD, HP-UX, Linux, Mac OS X, NetBSD and Solaris. -PAM authentication is disabled by default, so you have to configure and compile -<TT>ejabberd</TT> with PAM support enabled: -</P><PRE CLASS="verbatim">./configure --enable-pam && make install -</PRE><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{pam_service, Name}</TT></B></DT><DD CLASS="dd-description">This option defines the PAM service name. -Default is <TT>"ejabberd"</TT>. Refer to the PAM documentation of your operation system -for more information. -</DD><DT CLASS="dt-description"><B><TT>{pam_userinfotype, username|jid}</TT></B></DT><DD CLASS="dd-description"> -This option defines what type of information about the user ejabberd -provides to the PAM service: only the username, or the user JID. -Default is <TT>username</TT>. -</DD></DL><P>Example: -</P><PRE CLASS="verbatim">{auth_method, pam}. -{pam_service, "ejabberd"}. -</PRE><P>Though it is quite easy to set up PAM support in <TT>ejabberd</TT>, PAM itself introduces some -security issues:</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -To perform PAM authentication <TT>ejabberd</TT> uses external C-program called -<TT>epam</TT>. By default, it is located in <CODE>/var/lib/ejabberd/priv/bin/</CODE> -directory. You have to set it root on execution in the case when your PAM module -requires root privileges (<TT>pam_unix.so</TT> for example). Also you have to grant access -for <TT>ejabberd</TT> to this file and remove all other permissions from it. -Execute with root privileges: -<PRE CLASS="verbatim">chown root:ejabberd /var/lib/ejabberd/priv/bin/epam -chmod 4750 /var/lib/ejabberd/priv/bin/epam -</PRE></LI><LI CLASS="li-itemize">Make sure you have the latest version of PAM installed on your system. -Some old versions of PAM modules cause memory leaks. If you are not able to use the latest -version, you can <TT>kill(1)</TT> <TT>epam</TT> process periodically to reduce its memory -consumption: <TT>ejabberd</TT> will restart this process immediately. -</LI><LI CLASS="li-itemize"><TT>epam</TT> program tries to turn off delays on authentication failures. -However, some PAM modules ignore this behavior and rely on their own configuration options. -You can create a configuration file <TT>ejabberd.pam</TT>. -This example shows how to turn off delays in <TT>pam_unix.so</TT> module: -<PRE CLASS="verbatim">#%PAM-1.0 -auth sufficient pam_unix.so likeauth nullok nodelay -account sufficient pam_unix.so -</PRE>That is not a ready to use configuration file: you must use it -as a hint when building your own PAM configuration instead. Note that if you want to disable -delays on authentication failures in the PAM configuration file, you have to restrict access -to this file, so a malicious user can’t use your configuration to perform brute-force -attacks. -</LI><LI CLASS="li-itemize">You may want to allow login access only for certain users. <TT>pam_listfile.so</TT> -module provides such functionality. -</LI><LI CLASS="li-itemize">If you use <TT>pam_winbind</TT> to authorise against a Windows Active Directory, -then <TT>/etc/nssswitch.conf</TT> must be configured to use <TT>winbind</TT> as well. -</LI></UL><P> <A NAME="gssapi"></A> </P><!--TOC subsubsection SASL GSSAPI Authentication--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#gssapi">SASL GSSAPI Authentication</A></H4><!--SEC END --><P> <A NAME="gssapi"></A> -</P><P><TT>ejabberd</TT> supports SASL GSSAPI authentication. -It is compatible with SSO as implemented in Spark 2.5.3.</P><P>To use this feature, you have to download the <TT>esasl</TT> library -source code from -<A HREF="http://github.com/mikma/esasl">http://github.com/mikma/esasl</A>, -compile and install it. Example instructions: -</P><PRE CLASS="verbatim">git clone git://github.com/mikma/esasl.git -cd esasl -./configure --prefix=/usr -make -sudo make install -</PRE><P>After doing this, check that esasl was installed in the <TT>/usr/lib/erlang/lib/</TT> directory. -For compiling esasl, maybe you need to get some development files; -(for example, in Debian, the package <TT>libgsasl7-dev</TT>).</P><P>The SASL GSSAPI mechanism uses a authentication backend only to check for a -valid user name when authorizing the user. -The authentication is done by esasl against a Kerberos key server (KDC). -Often Kerberos authentication is combined with LDAP to store user account information. -To do that, edit <TT>ejabberd.cfg</TT> and modify the <TT>auth_mehtod</TT> depending -on what you want to allow. For example: -</P><PRE CLASS="verbatim">{auth_method, [ldap]}. -</PRE><P>Now define the Kerberos realm: -</P><PRE CLASS="verbatim">{sasl_realm, "Kerberos realm"}. -</PRE><P>and manually set the FQDN. -<TT>ejabberd</TT> does a reverse lookup on the connecting IP and uses -that FQDN for locating its keytab entry in the keytab file. -</P><PRE CLASS="verbatim">{sasl_fqdn, "dbs.example.com"}. -</PRE><P>The environment variable <TT>KRB5_KTNAME</TT> is the location of the keytab file, -and needs to be set before starting ejabberd. -The keytab referenced by <TT>KRB5_KTNAME</TT> should contain the principal xmpp/FQDN, -where FQDN is the fully qualified host name of the ejabberd server. -For example, in Debian, add to the file <TT>/etc/ejabberd/default</TT> the line: -</P><PRE CLASS="verbatim">export KRB5_KTNAME="/etc/keytabs/xmpp-dbs.example.com-EXAMPLE.COM.keytab" -</PRE><P> <A NAME="accessrules"></A> </P><!--TOC subsection Access Rules--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc25">3.1.5</A>  <A HREF="#accessrules">Access Rules</A></H3><!--SEC END --><P> <A NAME="accessrules"></A> -</P><P> <A NAME="ACLDefinition"></A> </P><!--TOC subsubsection ACL Definition--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#ACLDefinition">ACL Definition</A></H4><!--SEC END --><P> <A NAME="ACLDefinition"></A> -</P><P>Access control in <TT>ejabberd</TT> is performed via Access Control Lists (ACLs). The -declarations of ACLs in the configuration file have the following syntax: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{acl, ACLName, ACLValue}.</TT></B></DT></DL><P><TT>ACLValue</TT> can be one of the following: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>all</TT></B></DT><DD CLASS="dd-description"> Matches all JIDs. Example: -<PRE CLASS="verbatim">{acl, all, all}. -</PRE></DD><DT CLASS="dt-description"><B><TT>{user, Username}</TT></B></DT><DD CLASS="dd-description"> Matches the user with the name -<TT>Username</TT> at the first virtual host. Example: -<PRE CLASS="verbatim">{acl, admin, {user, "yozhik"}}. -</PRE></DD><DT CLASS="dt-description"><B><TT>{user, Username, Server}</TT></B></DT><DD CLASS="dd-description"> Matches the user with the JID -<TT>Username@Server</TT> and any resource. Example: -<PRE CLASS="verbatim">{acl, admin, {user, "yozhik", "example.org"}}. -</PRE></DD><DT CLASS="dt-description"><B><TT>{server, Server}</TT></B></DT><DD CLASS="dd-description"> Matches any JID from server -<TT>Server</TT>. Example: -<PRE CLASS="verbatim">{acl, exampleorg, {server, "example.org"}}. -</PRE></DD><DT CLASS="dt-description"><B><TT>{resource, Resource}</TT></B></DT><DD CLASS="dd-description"> Matches any JID with a resource -<TT>Resource</TT>. Example: -<PRE CLASS="verbatim">{acl, mucklres, {resource, "muckl"}}. -</PRE></DD><DT CLASS="dt-description"><B><TT>{shared_group, Groupname}</TT></B></DT><DD CLASS="dd-description"> Matches any member of a Shared Roster Group with name <TT>Groupname</TT> in the virtual host. Example: -<PRE CLASS="verbatim">{acl, techgroupmembers, {shared_group, "techteam"}}. -</PRE></DD><DT CLASS="dt-description"><B><TT>{shared_group, Groupname, Server}</TT></B></DT><DD CLASS="dd-description"> Matches any member of a Shared Roster Group with name <TT>Groupname</TT> in the virtual host <TT>Server</TT>. Example: -<PRE CLASS="verbatim">{acl, techgroupmembers, {shared_group, "techteam", "example.org"}}. -</PRE></DD><DT CLASS="dt-description"><B><TT>{user_regexp, Regexp}</TT></B></DT><DD CLASS="dd-description"> Matches any local user with a name that -matches <TT>Regexp</TT> on local virtual hosts. Example: -<PRE CLASS="verbatim">{acl, tests, {user_regexp, "^test[0-9]*$"}}. -</PRE></DD><DT CLASS="dt-description"><B><TT>{user_regexp, UserRegexp, Server}</TT></B></DT><DD CLASS="dd-description"> Matches any user with a name -that matches <TT>Regexp</TT> at server <TT>Server</TT>. Example: -<PRE CLASS="verbatim">{acl, tests, {user_Userregexp, "^test", "example.org"}}. -</PRE></DD><DT CLASS="dt-description"><B><TT>{server_regexp, Regexp}</TT></B></DT><DD CLASS="dd-description"> Matches any JID from the server that -matches <TT>Regexp</TT>. Example: -<PRE CLASS="verbatim">{acl, icq, {server_regexp, "^icq\\."}}. -</PRE></DD><DT CLASS="dt-description"><B><TT>{resource_regexp, Regexp}</TT></B></DT><DD CLASS="dd-description"> Matches any JID with a resource that -matches <TT>Regexp</TT>. Example: -<PRE CLASS="verbatim">{acl, icq, {resource_regexp, "^laptop\\."}}. -</PRE></DD><DT CLASS="dt-description"><B><TT>{node_regexp, UserRegexp, ServerRegexp}</TT></B></DT><DD CLASS="dd-description"> Matches any user -with a name that matches <TT>UserRegexp</TT> at any server that matches -<TT>ServerRegexp</TT>. Example: -<PRE CLASS="verbatim">{acl, yohzik, {node_regexp, "^yohzik$", "^example.(com|org)$"}}. -</PRE></DD><DT CLASS="dt-description"><B><TT>{user_glob, Glob}</TT></B></DT><DD CLASS="dd-description"> -</DD><DT CLASS="dt-description"><B><TT>{user_glob, Glob, Server}</TT></B></DT><DD CLASS="dd-description"> -</DD><DT CLASS="dt-description"><B><TT>{server_glob, Glob}</TT></B></DT><DD CLASS="dd-description"> -</DD><DT CLASS="dt-description"><B><TT>{resource_glob, Glob}</TT></B></DT><DD CLASS="dd-description"> -</DD><DT CLASS="dt-description"><B><TT>{node_glob, UserGlob, ServerGlob}</TT></B></DT><DD CLASS="dd-description"> This is the same as -above. However, it uses shell glob patterns instead of regexp. These patterns -can have the following special characters: -<DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>*</TT></B></DT><DD CLASS="dd-description"> matches any string including the null string. -</DD><DT CLASS="dt-description"><B><TT>?</TT></B></DT><DD CLASS="dd-description"> matches any single character. -</DD><DT CLASS="dt-description"><B><TT>[...]</TT></B></DT><DD CLASS="dd-description"> matches any of the enclosed characters. Character -ranges are specified by a pair of characters separated by a <TT>‘-’</TT>. -If the first character after <TT>‘[’</TT> is a <TT>‘!’</TT>, any -character not enclosed is matched. -</DD></DL> -</DD></DL><P>The following <TT>ACLName</TT> are pre-defined: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>all</TT></B></DT><DD CLASS="dd-description"> Matches any JID. -</DD><DT CLASS="dt-description"><B><TT>none</TT></B></DT><DD CLASS="dd-description"> Matches no JID. -</DD></DL><P> <A NAME="AccessRights"></A> </P><!--TOC subsubsection Access Rights--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#AccessRights">Access Rights</A></H4><!--SEC END --><P> <A NAME="AccessRights"></A> -</P><P>An entry allowing or denying access to different services. -The syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{access, AccessName, [ {allow|deny, ACLName}, ...]}.</TT></B></DT></DL><P>When a JID is checked to have access to <TT>Accessname</TT>, the server -sequentially checks if that JID matches any of the ACLs that are named in the -second elements of the tuples in the list. If it matches, the first element of -the first matched tuple is returned, otherwise the value ‘<TT>deny</TT>’ is -returned.</P><P>If you define specific Access rights in a virtual host, -remember that the globally defined Access rights have precedence over those. -This means that, in case of conflict, the Access granted or denied in the global server is used -and the Access of a virtual host doesn’t have effect.</P><P>Example: -</P><PRE CLASS="verbatim">{access, configure, [{allow, admin}]}. -{access, something, [{deny, badmans}, - {allow, all}]}. -</PRE><P>The following <TT>AccessName</TT> are pre-defined: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>all</TT></B></DT><DD CLASS="dd-description"> Always returns the value ‘<TT>allow</TT>’. -</DD><DT CLASS="dt-description"><B><TT>none</TT></B></DT><DD CLASS="dd-description"> Always returns the value ‘<TT>deny</TT>’. -</DD></DL><P> <A NAME="configmaxsessions"></A> </P><!--TOC subsubsection Limiting Opened Sessions with ACL--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#configmaxsessions">Limiting Opened Sessions with ACL</A></H4><!--SEC END --><P> <A NAME="configmaxsessions"></A> -</P><P>The special access <TT>max_user_sessions</TT> specifies the maximum -number of sessions (authenticated connections) per user. If a user -tries to open more sessions by using different resources, the first -opened session will be disconnected. The error <TT>session replaced</TT> -will be sent to the disconnected session. The value for this option -can be either a number, or <TT>infinity</TT>. The default value is -<TT>infinity</TT>.</P><P>The syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{access, max_user_sessions, [ {MaxNumber, ACLName}, ...]}.</TT></B></DT></DL><P>This example limits the number of sessions per user to 5 for all users, and to 10 for admins: -</P><PRE CLASS="verbatim">{access, max_user_sessions, [{10, admin}, {5, all}]}. -</PRE><P> <A NAME="configmaxs2sconns"></A> </P><!--TOC subsubsection Several connections to a remote XMPP server with ACL--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#configmaxs2sconns">Several connections to a remote XMPP server with ACL</A></H4><!--SEC END --><P> <A NAME="configmaxs2sconns"></A> -</P><P>The special access <TT>max_s2s_connections</TT> specifies how many -simultaneous S2S connections can be established to a specific remote XMPP server. -The default value is <TT>1</TT>. -There’s also available the access <TT>max_s2s_connections_per_node</TT>.</P><P>The syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{access, max_s2s_connections, [ {MaxNumber, ACLName}, ...]}.</TT></B></DT></DL><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -Allow up to 3 connections with each remote server: -<PRE CLASS="verbatim">{access, max_s2s_connections, [{3, all}]}. -</PRE></LI></UL><P> <A NAME="shapers"></A> </P><!--TOC subsection Shapers--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc26">3.1.6</A>  <A HREF="#shapers">Shapers</A></H3><!--SEC END --><P> <A NAME="shapers"></A> -</P><P>Shapers enable you to limit connection traffic. -The syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{shaper, ShaperName, Kind}.</TT></B></DT></DL><P> -Currently only one kind of shaper called <TT>maxrate</TT> is available. It has the -following syntax: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{maxrate, Rate}</TT></B></DT></DL><P> -where <TT>Rate</TT> stands for the maximum allowed incoming rate in bytes per -second. -When a connection exceeds this limit, <TT>ejabberd</TT> stops reading from the socket -until the average rate is again below the allowed maximum.</P><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -To define a shaper named ‘<TT>normal</TT>’ with traffic speed limited to -1,000 bytes/second: -<PRE CLASS="verbatim">{shaper, normal, {maxrate, 1000}}. -</PRE></LI><LI CLASS="li-itemize">To define a shaper named ‘<TT>fast</TT>’ with traffic speed limited to -50,000 bytes/second: -<PRE CLASS="verbatim">{shaper, fast, {maxrate, 50000}}. -</PRE></LI></UL><P> <A NAME="language"></A> </P><!--TOC subsection Default Language--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc27">3.1.7</A>  <A HREF="#language">Default Language</A></H3><!--SEC END --><P> <A NAME="language"></A> -</P><P>The option <TT>language</TT> defines the default language of server strings that -can be seen by XMPP clients. If a XMPP client does not support -<TT>xml:lang</TT>, the specified language is used.</P><P>The option syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{language, Language}.</TT></B></DT></DL><P>The default value is <TT>en</TT>. -In order to take effect there must be a translation file -<TT>Language.msg</TT> in <TT>ejabberd</TT>’s <TT>msgs</TT> directory.</P><P>For example, to set Russian as default language: -</P><PRE CLASS="verbatim">{language, "ru"}. -</PRE><P>Appendix <A HREF="#i18ni10n">A</A> provides more details about internationalization and localization.</P><P> <A NAME="captcha"></A> </P><!--TOC subsection CAPTCHA--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc28">3.1.8</A>  <A HREF="#captcha">CAPTCHA</A></H3><!--SEC END --><P> <A NAME="captcha"></A> -</P><P>Some <TT>ejabberd</TT> modules can be configured to require a CAPTCHA challenge on certain actions. -If the client does not support CAPTCHA Forms (<A HREF="http://xmpp.org/extensions/xep-0158.html">XEP-0158</A>), -a web link is provided so the user can fill the challenge in a web browser.</P><P>An example script is provided that generates the image -using ImageMagick’s Convert program.</P><P>The configurable options are: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{captcha_cmd, Path}</TT></B></DT><DD CLASS="dd-description"> -Full path to a script that generates the image. -The default value is an empty string: <TT>""</TT> -</DD><DT CLASS="dt-description"><B><TT>{captcha_host, Host}</TT></B></DT><DD CLASS="dd-description"> -Host part of the URL sent to the user. -You can include the port number. -The URL sent to the user is formed by: <TT>http://Host/captcha/</TT> -The default value is the first hostname configured. -</DD></DL><P>Additionally, an <TT>ejabberd_http</TT> listener must be enabled with the <TT>captcha</TT> option. -See section <A HREF="#listened-module">3.1.3</A>.</P><P>Example configuration: -</P><PRE CLASS="verbatim">{hosts, ["example.org"]}. - -{captcha_cmd, "/lib/ejabberd/priv/bin/captcha.sh"}. -{captcha_host, "example.org:5280"}. - -{listen, - [ - ... - {5280, ejabberd_http, [ - captcha, - ... - ] - } - -]}. -</PRE><P> <A NAME="stun"></A> </P><!--TOC subsection STUN--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc29">3.1.9</A>  <A HREF="#stun">STUN</A></H3><!--SEC END --><P> <A NAME="stun"></A> -</P><P><TT>ejabberd</TT> is able to act as a stand-alone STUN server -(<A HREF="http://tools.ietf.org/html/rfc5389">RFC 5389</A>). Currently only Binding usage -is supported. In that role <TT>ejabberd</TT> helps clients with Jingle ICE (<A HREF="http://xmpp.org/extensions/xep-0176.html">XEP-0176</A>) support to discover their external addresses and ports.</P><P>You should configure <TT>ejabberd_stun</TT> listening module as described in <A HREF="#listened">3.1.3</A> section. -If <TT>certfile</TT> option is defined, <TT>ejabberd</TT> multiplexes TCP and -TLS over TCP connections on the same port. Obviously, <TT>certfile</TT> option -is defined for <TT>tcp</TT> only. Note however that TCP or TLS over TCP -support is not required for Binding usage and is reserved for -<A HREF="http://tools.ietf.org/html/draft-ietf-behave-turn-16">TURN</A> -functionality. Feel free to configure <TT>udp</TT> transport only.</P><P>Example configuration: -</P><PRE CLASS="verbatim">{listen, - [ - ... - {{3478, udp}, ejabberd_stun, []}, - {3478, ejabberd_stun, []}, - {5349, ejabberd_stun, [{certfile, "/etc/ejabberd/server.pem"}]}, - ... - ] -}. -</PRE><P>You also need to configure DNS SRV records properly so clients can easily discover a -STUN server serving your XMPP domain. Refer to section -<A HREF="http://tools.ietf.org/html/rfc5389#section-9">DNS Discovery of a Server</A> -of <A HREF="http://tools.ietf.org/html/rfc5389">RFC 5389</A> for details.</P><P>Example DNS SRV configuration: -</P><PRE CLASS="verbatim">_stun._udp IN SRV 0 0 3478 stun.example.com. -_stun._tcp IN SRV 0 0 3478 stun.example.com. -_stuns._tcp IN SRV 0 0 5349 stun.example.com. -</PRE><P> <A NAME="includeconfigfile"></A> </P><!--TOC subsection Include Additional Configuration Files--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc30">3.1.10</A>  <A HREF="#includeconfigfile">Include Additional Configuration Files</A></H3><!--SEC END --><P> <A NAME="includeconfigfile"></A> -</P><P>The option <TT>include_config_file</TT> in a configuration file instructs <TT>ejabberd</TT> to include other configuration files immediately.</P><P>The basic syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{include_config_file, Filename}.</TT></B></DT></DL><P> -It is possible to specify suboptions using the full syntax: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{include_config_file, Filename, [Suboption, ...]}.</TT></B></DT></DL><P>The filename can be indicated either as an absolute path, -or relative to the main <TT>ejabberd</TT> configuration file. -It isn’t possible to use wildcards. -The file must exist and be readable.</P><P>The allowed suboptions are: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{disallow, [Optionname, ...]}</TT></B></DT><DD CLASS="dd-description"> Disallows the usage of those options in the included configuration file. -The options that match this criteria are not accepted. -The default value is an empty list: <TT>[]</TT> -</DD><DT CLASS="dt-description"><B><TT>{allow_only, [Optionname, ...]}</TT></B></DT><DD CLASS="dd-description"> Allows only the usage of those options in the included configuration file. -The options that do not match this criteria are not accepted. -The default value is: <TT>all</TT> -</DD></DL><P>This is a basic example: -</P><PRE CLASS="verbatim">{include_config_file, "/etc/ejabberd/additional.cfg"}. -</PRE><P>In this example, the included file is not allowed to contain a <TT>listen</TT> option. -If such an option is present, the option will not be accepted. -The file is in a subdirectory from where the main configuration file is. -</P><PRE CLASS="verbatim">{include_config_file, "./example.org/additional_not_listen.cfg", [{disallow, [listen]}]}. -</PRE><P>In this example, <TT>ejabberd.cfg</TT> defines some ACL and Access rules, -and later includes another file with additional rules: -</P><PRE CLASS="verbatim">{acl, admin, {user, "admin", "localhost"}}. -{access, announce, [{allow, admin}]}. -{include_config_file, "/etc/ejabberd/acl_and_access.cfg", [{allow_only, [acl, access]}]}. -</PRE><P>and content of the file <TT>acl_and_access.cfg</TT> can be, for example: -</P><PRE CLASS="verbatim">{acl, admin, {user, "bob", "localhost"}}. -{acl, admin, {user, "jan", "localhost"}}. -</PRE><P> <A NAME="optionmacros"></A> </P><!--TOC subsection Option Macros in Configuration File--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc31">3.1.11</A>  <A HREF="#optionmacros">Option Macros in Configuration File</A></H3><!--SEC END --><P> <A NAME="optionmacros"></A> -</P><P>In the <TT>ejabberd</TT> configuration file, -it is possible to define a macro for a value -and later use this macro when defining an option.</P><P>A macro is defined with this syntax: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{define_macro, ’MACRO’, Value}.</TT></B></DT></DL><P> -The <TT>MACRO</TT> must be surrounded by single quotation marks, -and all letters in uppercase; check the examples bellow. -The <TT>value</TT> can be any valid arbitrary Erlang term.</P><P>The first definition of a macro is preserved, -and additional definitions of the same macro are forgotten.</P><P>Macros are processed after -additional configuration files have been included, -so it is possible to use macros that -are defined in configuration files included before the usage.</P><P>It isn’t possible to use a macro in the definition -of another macro.</P><P>There are two ways to use a macro: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>’MACRO’</TT></B></DT><DD CLASS="dd-description"> -You can put this instead of a value in an <TT>ejabberd</TT> option, -and will be replaced with the <TT>value</TT> previously defined. -If the macro is not defined previously, -the program will crash and report an error.</DD><DT CLASS="dt-description"><B><TT>{use_macro, ’MACRO’, Defaultvalue}</TT></B></DT><DD CLASS="dd-description"> -Use a macro even if it may not be defined. -If the macro is not defined previously, -the provided <TT>defaultvalue</TT> is used. -This usage behaves as if it were defined and used this way: -<PRE CLASS="verbatim">{define_macro, 'MACRO', Defaultvalue}. -'MACRO' -</PRE></DD></DL><P>This example shows the basic usage of a macro: -</P><PRE CLASS="verbatim">{define_macro, 'LOG_LEVEL_NUMBER', 5}. -{loglevel, 'LOG_LEVEL_NUMBER'}. -</PRE><P>The resulting option interpreted by <TT>ejabberd</TT> is: <TT>{loglevel, 5}</TT>.</P><P>This example shows that values can be any arbitrary Erlang term: -</P><PRE CLASS="verbatim">{define_macro, 'USERBOB', {user, "bob", "localhost"}}. -{acl, admin, 'USERBOB'}. -</PRE><P>The resulting option interpreted by <TT>ejabberd</TT> is: <TT>{acl, admin, {user, "bob", "localhost"}}</TT>.</P><P>This complex example: -</P><PRE CLASS="verbatim">{define_macro, 'NUMBER_PORT_C2S', 5222}. -{define_macro, 'PORT_S2S_IN', {5269, ejabberd_s2s_in, []}}. -{listen, - [ - {'NUMBER_PORT_C2S', ejabberd_c2s, []}, - 'PORT_S2S_IN', - {{use_macro, 'NUMBER_PORT_HTTP', 5280}, ejabberd_http, []} - ] -}. -</PRE><P>produces this result after being interpreted: -</P><PRE CLASS="verbatim">{listen, - [ - {5222, ejabberd_c2s, []}, - {5269, ejabberd_s2s_in, []}, - {5280, ejabberd_http, []} - ] -}. -</PRE><P> <A NAME="database"></A> </P><!--TOC section Database and LDAP Configuration--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc32">3.2</A>  <A HREF="#database">Database and LDAP Configuration</A></H2><!--SEC END --><P> <A NAME="database"></A> - -</P><P><TT>ejabberd</TT> uses its internal Mnesia database by default. However, it is -possible to use a relational database or an LDAP server to store persistent, -long-living data. <TT>ejabberd</TT> is very flexible: you can configure different -authentication methods for different virtual hosts, you can configure different -authentication mechanisms for the same virtual host (fallback), you can set -different storage systems for modules, and so forth.</P><P>The following databases are supported by <TT>ejabberd</TT>: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -<A HREF="http://www.microsoft.com/sql/">Microsoft SQL Server</A> -</LI><LI CLASS="li-itemize"><A HREF="http://www.erlang.org/doc/apps/mnesia/index.html">Mnesia</A> -</LI><LI CLASS="li-itemize"><A HREF="http://www.mysql.com/">MySQL</A> -</LI><LI CLASS="li-itemize"><A HREF="http://en.wikipedia.org/wiki/Open_Database_Connectivity">Any ODBC compatible database</A> -</LI><LI CLASS="li-itemize"><A HREF="http://www.postgresql.org/">PostgreSQL</A> -</LI></UL><P>The following LDAP servers are tested with <TT>ejabberd</TT>: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -<A HREF="http://www.microsoft.com/activedirectory/">Active Directory</A> -(see section <A HREF="#ad">3.2.5</A>) -</LI><LI CLASS="li-itemize"><A HREF="http://www.openldap.org/">OpenLDAP</A> -</LI><LI CLASS="li-itemize">Normally any LDAP compatible server should work; inform us about your -success with a not-listed server so that we can list it here. -</LI></UL><P>Important note about virtual hosting: -if you define several domains in ejabberd.cfg (see section <A HREF="#hostnames">3.1.1</A>), -you probably want that each virtual host uses a different configuration of database, authentication and storage, -so that usernames do not conflict and mix between different virtual hosts. -For that purpose, the options described in the next sections -must be set inside a <TT>host_config</TT> for each vhost (see section <A HREF="#virtualhost">3.1.2</A>). -For example: -</P><PRE CLASS="verbatim">{host_config, "public.example.org", [ - {odbc_server, {pgsql, "localhost", "database-public-example-org", "ejabberd", "password"}}, - {auth_method, storage}, - {auth_storage, odbc} -]}. -</PRE><P> <A NAME="mysql"></A> </P><!--TOC subsection MySQL--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc33">3.2.1</A>  <A HREF="#mysql">MySQL</A></H3><!--SEC END --><P> <A NAME="mysql"></A> -</P><P>Although this section will describe <TT>ejabberd</TT>’s configuration when you want to -use the native MySQL driver, it does not describe MySQL’s installation and -database creation. Check the MySQL documentation and the tutorial <A HREF="http://support.process-one.net/doc/display/MESSENGER/Using+ejabberd+with+MySQL+native+driver">Using ejabberd with MySQL native driver</A> for information regarding these topics. -Note that the tutorial contains information about <TT>ejabberd</TT>’s configuration -which is duplicate to this section.</P><P>Moreover, the file mysql.sql in the directory src/odbc might be interesting for -you. This file contains the <TT>ejabberd</TT> schema for MySQL. At the end of the file -you can find information to update your database schema.</P><P> <A NAME="compilemysql"></A> </P><!--TOC subsubsection Driver Compilation--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#compilemysql">Driver Compilation</A></H4><!--SEC END --><P> <A NAME="compilemysql"></A> -</P><P>You can skip this step if you installed <TT>ejabberd</TT> using a binary installer or -if the binary packages of <TT>ejabberd</TT> you are using include support for MySQL.</P><OL CLASS="enumerate" type=1><LI CLASS="li-enumerate"> -First, install the <A HREF="http://support.process-one.net/doc/display/CONTRIBS/Yxa">Erlang -MySQL library</A>. Make sure the compiled files are in your Erlang path; you can -put them for example in the same directory as your <TT>ejabberd</TT> .beam files. -</LI><LI CLASS="li-enumerate">Then, configure and install <TT>ejabberd</TT> with ODBC support enabled (this is -also needed for native MySQL support!). This can be done, by using next -commands: -<PRE CLASS="verbatim">./configure --enable-odbc && make install -</PRE></LI></OL><P> <A NAME="configuremysql"></A> </P><!--TOC subsubsection Database Connection--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#configuremysql">Database Connection</A></H4><!--SEC END --><P> <A NAME="configuremysql"></A> -</P><P>The actual database access is defined in the option <TT>odbc_server</TT>. Its -value is used to define if we want to use ODBC, or one of the two native -interface available, PostgreSQL or MySQL.</P><P>To use the native MySQL interface, you can pass a tuple of the following form as -parameter: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{mysql, "Server", "Database", "Username", "Password"}</TT></B></DT></DL><P><TT>mysql</TT> is a keyword that should be kept as is. For example: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{odbc_server, {mysql, "localhost", "test", "root", "password"}}.</TT></B></DT></DL><P>Optionally, it is possible to define the MySQL port to use. This -option is only useful, in very rare cases, when you are not running -MySQL with the default port setting. The <TT>mysql</TT> parameter -can thus take the following form: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{mysql, "Server", Port, "Database", "Username", "Password"}</TT></B></DT></DL><P>The <TT>Port</TT> value should be an integer, without quotes. For example: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{odbc_server, {mysql, "localhost", Port, "test", "root", "password"}}.</TT></B></DT></DL><P>By default <TT>ejabberd</TT> opens 10 connections to the database for each virtual host. -Use this option to modify the value: -</P><PRE CLASS="verbatim">{odbc_pool_size, 10}. -</PRE><P>You can configure an interval to make a dummy SQL request -to keep alive the connections to the database. -The default value is ’undefined’, so no keepalive requests are made. -Specify in seconds: for example 28800 means 8 hours. -</P><PRE CLASS="verbatim">{odbc_keepalive_interval, undefined}. -</PRE><P>If the connection to the database fails, <TT>ejabberd</TT> waits 30 seconds before retrying. -You can modify this interval with this option: -</P><PRE CLASS="verbatim">{odbc_start_interval, 30}. -</PRE><P> <A NAME="mysqlauth"></A> </P><!--TOC subsubsection Authentication--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#mysqlauth">Authentication</A></H4><!--SEC END --><P> <A NAME="mysqlauth"></A> -</P><P>See section <A HREF="#authstorage">3.1.4</A>.</P><P> <A NAME="mysqlstorage"></A> </P><!--TOC subsubsection Storage--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#mysqlstorage">Storage</A></H4><!--SEC END --><P> <A NAME="mysqlstorage"></A> -</P><P>MySQL also can be used to store information into from several <TT>ejabberd</TT> -modules. -See section <A HREF="#modoverview">3.3.1</A> to see which modules support an ODBC storage backend. -To configure the module to use ODBC as storage backend, add the option -<TT>{backend, odbc}</TT> to the module.</P><P> <A NAME="mssql"></A> </P><!--TOC subsection Microsoft SQL Server--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc34">3.2.2</A>  <A HREF="#mssql">Microsoft SQL Server</A></H3><!--SEC END --><P> <A NAME="mssql"></A> -</P><P>Although this section will describe <TT>ejabberd</TT>’s configuration when you want to -use Microsoft SQL Server, it does not describe Microsoft SQL Server’s -installation and database creation. Check the MySQL documentation and the -tutorial <A HREF="http://support.process-one.net/doc/display/MESSENGER/Using+ejabberd+with+MySQL+native+driver">Using ejabberd with MySQL native driver</A> for information regarding these topics. -Note that the tutorial contains information about <TT>ejabberd</TT>’s configuration -which is duplicate to this section.</P><P>Moreover, the file mssql.sql in the directory src/odbc might be interesting for -you. This file contains the <TT>ejabberd</TT> schema for Microsoft SQL Server. At the end -of the file you can find information to update your database schema.</P><P> <A NAME="compilemssql"></A> </P><!--TOC subsubsection Driver Compilation--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#compilemssql">Driver Compilation</A></H4><!--SEC END --><P> <A NAME="compilemssql"></A> -</P><P>You can skip this step if you installed <TT>ejabberd</TT> using a binary installer or -if the binary packages of <TT>ejabberd</TT> you are using include support for ODBC.</P><P>If you want to use Microsoft SQL Server with ODBC, you need to configure, -compile and install <TT>ejabberd</TT> with support for ODBC and Microsoft SQL Server -enabled. This can be done, by using next commands: -</P><PRE CLASS="verbatim">./configure --enable-odbc --enable-mssql && make install -</PRE><P> <A NAME="configuremssql"></A> </P><!--TOC subsubsection Database Connection--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#configuremssql">Database Connection</A></H4><!--SEC END --><P> <A NAME="configuremssql"></A> -</P><P>See section <A HREF="#authstorage">3.1.4</A>.</P><P> <A NAME="mssqlauth"></A> </P><!--TOC subsubsection Authentication--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#mssqlauth">Authentication</A></H4><!--SEC END --><P> <A NAME="mssqlauth"></A> -</P><P>The configuration of Authentication for a Microsoft SQL Server -is the same as the configuration for -ODBC compatible servers (see section <A HREF="#odbcauth">3.2.4</A>).</P><P> <A NAME="mssqlstorage"></A> </P><!--TOC subsubsection Storage--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#mssqlstorage">Storage</A></H4><!--SEC END --><P> <A NAME="mssqlstorage"></A> -</P><P>Microsoft SQL Server also can be used to store information into from several -<TT>ejabberd</TT> modules. -See section <A HREF="#modoverview">3.3.1</A> to see which modules support an ODBC storage backend. -To configure the module to use ODBC as storage backend, add the option -<TT>{backend, odbc}</TT> to the module.</P><P> <A NAME="pgsql"></A> </P><!--TOC subsection PostgreSQL--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc35">3.2.3</A>  <A HREF="#pgsql">PostgreSQL</A></H3><!--SEC END --><P> <A NAME="pgsql"></A> -</P><P>Although this section will describe <TT>ejabberd</TT>’s configuration when you want to -use the native PostgreSQL driver, it does not describe PostgreSQL’s installation -and database creation. Check the PostgreSQL documentation and the tutorial <A HREF="http://support.process-one.net/doc/display/MESSENGER/Using+ejabberd+with+MySQL+native+driver">Using ejabberd with MySQL native driver</A> for information regarding these topics. -Note that the tutorial contains information about <TT>ejabberd</TT>’s configuration -which is duplicate to this section.</P><P>Also the file pg.sql in the directory src/odbc might be interesting for you. -This file contains the <TT>ejabberd</TT> schema for PostgreSQL. At the end of the file -you can find information to update your database schema.</P><P> <A NAME="compilepgsql"></A> </P><!--TOC subsubsection Driver Compilation--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#compilepgsql">Driver Compilation</A></H4><!--SEC END --><P> <A NAME="compilepgsql"></A> -</P><P>You can skip this step if you installed <TT>ejabberd</TT> using a binary installer or -if the binary packages of <TT>ejabberd</TT> you are using include support for -PostgreSQL.</P><OL CLASS="enumerate" type=1><LI CLASS="li-enumerate"> -First, install the Erlang pgsql library from -<A HREF="http://www.ejabberd.im/ejabberd-modules/">ejabberd-modules SVN repository</A>. -Make sure the compiled -files are in your Erlang path; you can put them for example in the same -directory as your <TT>ejabberd</TT> .beam files. -</LI><LI CLASS="li-enumerate">Then, configure, compile and install <TT>ejabberd</TT> with ODBC support enabled -(this is also needed for native PostgreSQL support!). This can be done, by -using next commands: -<PRE CLASS="verbatim">./configure --enable-odbc && make install -</PRE></LI></OL><P> <A NAME="configurepgsql"></A> </P><!--TOC subsubsection Database Connection--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#configurepgsql">Database Connection</A></H4><!--SEC END --><P> <A NAME="configurepgsql"></A> -</P><P>The actual database access is defined in the option <TT>odbc_server</TT>. Its -value is used to define if we want to use ODBC, or one of the two native -interface available, PostgreSQL or MySQL.</P><P>To use the native PostgreSQL interface, you can pass a tuple of the following -form as parameter: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{pgsql, "Server", "Database", "Username", "Password"}</TT></B></DT></DL><P><TT>pgsql</TT> is a keyword that should be kept as is. For example: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{odbc_server, {pgsql, "localhost", "database", "ejabberd", "password"}}.</TT></B></DT></DL><P>Optionally, it is possible to define the PostgreSQL port to use. This -option is only useful, in very rare cases, when you are not running -PostgreSQL with the default port setting. The <TT>pgsql</TT> parameter -can thus take the following form: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{pgsql, "Server", Port, "Database", "Username", "Password"}</TT></B></DT></DL><P>The <TT>Port</TT> value should be an integer, without quotes. For example: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{odbc_server, {pgsql, "localhost", 5432, "database", "ejabberd", "password"}}.</TT></B></DT></DL><P>By default <TT>ejabberd</TT> opens 10 connections to the database for each virtual host. -Use this option to modify the value: -</P><PRE CLASS="verbatim">{odbc_pool_size, 10}. -</PRE><P>You can configure an interval to make a dummy SQL request -to keep alive the connections to the database. -The default value is ’undefined’, so no keepalive requests are made. -Specify in seconds: for example 28800 means 8 hours. -</P><PRE CLASS="verbatim">{odbc_keepalive_interval, undefined}. -</PRE><P> <A NAME="pgsqlauth"></A> </P><!--TOC subsubsection Authentication--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#pgsqlauth">Authentication</A></H4><!--SEC END --><P> <A NAME="pgsqlauth"></A> -</P><P>See section <A HREF="#authstorage">3.1.4</A>.</P><P> <A NAME="pgsqlstorage"></A> </P><!--TOC subsubsection Storage--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#pgsqlstorage">Storage</A></H4><!--SEC END --><P> <A NAME="pgsqlstorage"></A> -</P><P>PostgreSQL also can be used to store information into from several <TT>ejabberd</TT> -modules. -See section <A HREF="#modoverview">3.3.1</A> to see which modules support an ODBC storage backend. -To configure the module to use ODBC as storage backend, add the option -<TT>{backend, odbc}</TT> to the module.</P><P> <A NAME="odbc"></A> </P><!--TOC subsection ODBC Compatible--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc36">3.2.4</A>  <A HREF="#odbc">ODBC Compatible</A></H3><!--SEC END --><P> <A NAME="odbc"></A> -</P><P>Although this section will describe <TT>ejabberd</TT>’s configuration when you want to -use the ODBC driver, it does not describe the installation and database creation -of your database. Check the documentation of your database. The tutorial <A HREF="http://support.process-one.net/doc/display/MESSENGER/Using+ejabberd+with+MySQL+native+driver">Using ejabberd with MySQL native driver</A> also can help you. Note that the tutorial -contains information about <TT>ejabberd</TT>’s configuration which is duplicate to -this section.</P><P> <A NAME="compileodbc"></A> </P><!--TOC subsubsection Driver Compilation--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#compileodbc">Driver Compilation</A></H4><!--SEC END --><P> <A NAME="compileodbc"></A> </P><P>You can skip this step if you installed <TT>ejabberd</TT> using a binary installer or -if the binary packages of <TT>ejabberd</TT> you are using include support for -ODBC.</P><OL CLASS="enumerate" type=1><LI CLASS="li-enumerate"> -First, install the <A HREF="http://support.process-one.net/doc/display/CONTRIBS/Yxa">Erlang -MySQL library</A>. Make sure the compiled files are in your Erlang path; you can -put them for example in the same directory as your <TT>ejabberd</TT> .beam files. -</LI><LI CLASS="li-enumerate">Then, configure, compile and install <TT>ejabberd</TT> with ODBC support -enabled. This can be done, by using next commands: -<PRE CLASS="verbatim">./configure --enable-odbc && make install -</PRE></LI></OL><P> <A NAME="configureodbc"></A> </P><!--TOC subsubsection Database Connection--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#configureodbc">Database Connection</A></H4><!--SEC END --><P> <A NAME="configureodbc"></A> -</P><P>The actual database access is defined in the option <TT>odbc_server</TT>. Its -value is used to defined if we want to use ODBC, or one of the two native -interface available, PostgreSQL or MySQL.</P><P>To use a relational database through ODBC, you can pass the ODBC connection -string as <TT>odbc_server</TT> parameter. For example: -</P><PRE CLASS="verbatim">{odbc_server, "DSN=database;UID=ejabberd;PWD=password"}. -</PRE><P>By default <TT>ejabberd</TT> opens 10 connections to the database for each virtual host. -Use this option to modify the value: -</P><PRE CLASS="verbatim">{odbc_pool_size, 10}. -</PRE><P>You can configure an interval to make a dummy SQL request -to keep alive the connections to the database. -The default value is ’undefined’, so no keepalive requests are made. -Specify in seconds: for example 28800 means 8 hours. -</P><PRE CLASS="verbatim">{odbc_keepalive_interval, undefined}. -</PRE><P> <A NAME="odbcauth"></A> </P><!--TOC subsubsection Authentication--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#odbcauth">Authentication</A></H4><!--SEC END --><P> <A NAME="odbcauth"></A> -</P><P>See section <A HREF="#authstorage">3.1.4</A>.</P><P> <A NAME="odbcstorage"></A> </P><!--TOC subsubsection Storage--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#odbcstorage">Storage</A></H4><!--SEC END --><P> <A NAME="odbcstorage"></A> -</P><P>An ODBC compatible database also can be used to store information into from -several <TT>ejabberd</TT> modules. -See section <A HREF="#modoverview">3.3.1</A> to see which modules support an ODBC storage backend. -To configure the module to use ODBC as storage backend, add the option -<TT>{backend, odbc}</TT> to the module.</P><P> <A NAME="ldap"></A> </P><!--TOC subsection LDAP--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc37">3.2.5</A>  <A HREF="#ldap">LDAP</A></H3><!--SEC END --><P> <A NAME="ldap"></A> -</P><P><TT>ejabberd</TT> has built-in LDAP support. You can authenticate users against LDAP -server and use LDAP directory as vCard storage. Shared rosters are not supported -yet.</P><P>Usually <TT>ejabberd</TT> treats LDAP as a read-only storage: -it is possible to consult data, but not possible to -create accounts or edit vCard that is stored in LDAP. -However, it is possible to change passwords if <TT>mod_register</TT> module is enabled -and LDAP server supports -<A HREF="http://tools.ietf.org/html/rfc3062">RFC 3062</A>.</P><P> <A NAME="ldapconnection"></A> </P><!--TOC subsubsection Connection--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#ldapconnection">Connection</A></H4><!--SEC END --><P> <A NAME="ldapconnection"></A> </P><P>Two connections are established to the LDAP server per vhost, -one for authentication and other for regular calls.</P><P>Parameters: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{ldap_servers, [Servers, ...]}</TT></B></DT><DD CLASS="dd-description"> List of IP addresses or DNS names of your -LDAP servers. This option is required. -</DD><DT CLASS="dt-description"><B><TT>{ldap_encrypt, none|tls}</TT></B></DT><DD CLASS="dd-description"> Type of connection encryption to the LDAP server. -Allowed values are: <TT>none</TT>, <TT>tls</TT>. -The value <TT>tls</TT> enables encryption by using LDAP over SSL. -Note that STARTTLS encryption is not supported. -The default value is: <TT>none</TT>. -</DD><DT CLASS="dt-description"><B><TT>{ldap_tls_verify, false|soft|hard}</TT></B></DT><DD CLASS="dd-description"> -This option specifies whether to verify LDAP server certificate or not when TLS is enabled. -When <TT>hard</TT> is enabled <TT>ejabberd</TT> doesn’t proceed if a certificate is invalid. -When <TT>soft</TT> is enabled <TT>ejabberd</TT> proceeds even if check fails. -The default is <TT>false</TT> which means no checks are performed. -</DD><DT CLASS="dt-description"><B><TT>{ldap_port, Number}</TT></B></DT><DD CLASS="dd-description"> Port to connect to your LDAP server. -The default port is 389 if encryption is disabled; and 636 if encryption is enabled. -If you configure a value, it is stored in <TT>ejabberd</TT>’s database. -Then, if you remove that value from the configuration file, -the value previously stored in the database will be used instead of the default port. -</DD><DT CLASS="dt-description"><B><TT>{ldap_rootdn, RootDN}</TT></B></DT><DD CLASS="dd-description"> Bind DN. The default value -is <TT>""</TT> which means ‘anonymous connection’. -</DD><DT CLASS="dt-description"><B><TT>{ldap_password, Password}</TT></B></DT><DD CLASS="dd-description"> Bind password. The default -value is <TT>""</TT>. -</DD></DL><P>Example: -</P><PRE CLASS="verbatim">{auth_method, ldap}. -{ldap_servers, ["ldap.example.org"]}. -{ldap_port, 389}. -{ldap_rootdn, "cn=Manager,dc=domain,dc=org"}. -{ldap_password, "secret"}. -</PRE><P> <A NAME="ldapauth"></A> </P><!--TOC subsubsection Authentication--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#ldapauth">Authentication</A></H4><!--SEC END --><P> <A NAME="ldapauth"></A> </P><P>You can authenticate users against an LDAP directory. -Note that current LDAP implementation does not support SASL authentication.</P><P>Available options are:</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{ldap_base, Base}</TT></B></DT><DD CLASS="dd-description">LDAP base directory which stores -users accounts. This option is required. -</DD><DT CLASS="dt-description"><B><TT>{ldap_uids, [ {ldap_uidattr} | {ldap_uidattr, ldap_uidattr_format}, ...]}</TT></B></DT><DD CLASS="dd-description"> -LDAP attribute which holds a list of attributes to use as alternatives for getting the JID. -The default attributes are <TT>[{"uid", "%u"}]</TT>. -The attributes are of the form: -<TT>[{ldap_uidattr}]</TT> or <TT>[{ldap_uidattr, ldap_uidattr_format}]</TT>. -You can use as many comma separated attributes as needed. -The values for <TT>ldap_uidattr</TT> and -<TT>ldap_uidattr_format</TT> are described as follow: -<DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>ldap_uidattr</TT></B></DT><DD CLASS="dd-description">LDAP attribute which holds -the user’s part of a JID. The default value is <TT>"uid"</TT>. -</DD><DT CLASS="dt-description"><B><TT>ldap_uidattr_format</TT></B></DT><DD CLASS="dd-description">Format of -the <TT>ldap_uidattr</TT> variable. The format <EM>must</EM> contain one and -only one pattern variable <TT>"%u"</TT> which will be replaced by the -user’s part of a JID. For example, <TT>"%u@example.org"</TT>. The default -value is <TT>"%u"</TT>. -</DD></DL> -</DD><DT CLASS="dt-description"><B><TT>{ldap_filter, Filter}</TT></B></DT><DD CLASS="dd-description"> -<A HREF="http://tools.ietf.org/html/rfc4515">RFC 4515</A> LDAP filter. The -default Filter value is: <TT>undefined</TT>. Example: -<TT>"(&(objectClass=shadowAccount)(memberOf=Jabber Users))"</TT>. Please, do -not forget to close brackets and do not use superfluous whitespaces. Also you -<EM>must not</EM> use <TT>ldap_uidattr</TT> attribute in filter because this -attribute will be substituted in LDAP filter automatically. -</DD><DT CLASS="dt-description"><B><TT>{ldap_filter, Filter}</TT></B></DT><DD CLASS="dd-description"> -<A HREF="http://tools.ietf.org/html/rfc4515">RFC 4515</A> LDAP filter. The -default Filter value is: <TT>undefined</TT>. Example: -<TT>"(&(objectClass=shadowAccount)(memberOf=Jabber Users))"</TT>. Please, do -not forget to close brackets and do not use superfluous whitespaces. Also you -<EM>must not</EM> use <TT>ldap_uidattr</TT> attribute in filter because this -attribute will be substituted in LDAP filter automatically. -</DD><DT CLASS="dt-description"><B><TT>{ldap_dn_filter, { Filter, FilterAttrs }}</TT></B></DT><DD CLASS="dd-description"> -This filter is applied on the results returned by the main filter. This filter -performs additional LDAP lookup to make the complete result. This is useful -when you are unable to define all filter rules in <TT>ldap_filter</TT>. You -can define <TT>"%u"</TT>, <TT>"%d"</TT>, <TT>"%s"</TT> and <TT>"%D"</TT> pattern -variables in Filter: <TT>"%u"</TT> is replaced by a user’s part of a JID, -<TT>"%d"</TT> is replaced by the corresponding domain (virtual host), -all <TT>"%s"</TT> variables are consecutively replaced by values of FilterAttrs -attributes and <TT>"%D"</TT> is replaced by Distinguished Name. By default -<TT>ldap_dn_filter</TT> is undefined. -Example: -<PRE CLASS="verbatim">{ldap_dn_filter, {"(&(name=%s)(owner=%D)(user=%u@%d))", ["sn"]}}. -</PRE>Since this filter makes additional LDAP lookups, use it only in the -last resort: try to define all filter rules in <TT>ldap_filter</TT> if possible. -</DD><DT CLASS="dt-description"><B><TT>{ldap_local_filter, Filter}</TT></B></DT><DD CLASS="dd-description"> -If you can’t use <TT>ldap_filter</TT> due to performance reasons -(the LDAP server has many users registered), -you can use this local filter. -The local filter checks an attribute in ejabberd, -not in LDAP, so this limits the load on the LDAP directory. -The default filter is: <TT>undefined</TT>. -Example values: -<PRE CLASS="verbatim">{ldap_local_filter, {notequal, {"accountStatus",["disabled"]}}}. -{ldap_local_filter, {equal, {"accountStatus",["enabled"]}}}. -{ldap_local_filter, undefined}. -</PRE></DD></DL><P> <A NAME="ldapexamples"></A> </P><!--TOC subsubsection Examples--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#ldapexamples">Examples</A></H4><!--SEC END --><P> <A NAME="ldapexamples"></A> </P><P> <A NAME="ldapcommonexample"></A> </P><!--TOC paragraph Common example--> -<H5 CLASS="paragraph"><!--SEC ANCHOR --><A HREF="#ldapcommonexample">Common example</A></H5><!--SEC END --><P> <A NAME="ldapcommonexample"></A> </P><P>Let’s say <TT>ldap.example.org</TT> is the name of our LDAP server. We have -users with their passwords in <TT>"ou=Users,dc=example,dc=org"</TT> directory. -Also we have addressbook, which contains users emails and their additional -infos in <TT>"ou=AddressBook,dc=example,dc=org"</TT> directory. -The connection to the LDAP server is encrypted using TLS, -and using the custom port 6123. -Corresponding authentication section should looks like this:</P><PRE CLASS="verbatim">%% Authentication method -{auth_method, ldap}. -%% DNS name of our LDAP server -{ldap_servers, ["ldap.example.org"]}. -%% Bind to LDAP server as "cn=Manager,dc=example,dc=org" with password "secret" -{ldap_rootdn, "cn=Manager,dc=example,dc=org"}. -{ldap_password, "secret"}. -{ldap_encrypt, tls}. -{ldap_port, 6123}. -%% Define the user's base -{ldap_base, "ou=Users,dc=example,dc=org"}. -%% We want to authorize users from 'shadowAccount' object class only -{ldap_filter, "(objectClass=shadowAccount)"}. -</PRE><P>Now we want to use users LDAP-info as their vCards. We have four attributes -defined in our LDAP schema: <TT>"mail"</TT> — email address, <TT>"givenName"</TT> -— first name, <TT>"sn"</TT> — second name, <TT>"birthDay"</TT> — birthday. -Also we want users to search each other. Let’s see how we can set it up:</P><PRE CLASS="verbatim">{modules, - [ - ... - {mod_vcard_ldap, - [ - %% We use the same server and port, but want to bind anonymously because - %% our LDAP server accepts anonymous requests to - %% "ou=AddressBook,dc=example,dc=org" subtree. - {ldap_rootdn, ""}, - {ldap_password, ""}, - %% define the addressbook's base - {ldap_base, "ou=AddressBook,dc=example,dc=org"}, - %% uidattr: user's part of JID is located in the "mail" attribute - %% uidattr_format: common format for our emails - {ldap_uids, [{"mail", "%u@mail.example.org"}]}, - %% We have to define empty filter here, because entries in addressbook does not - %% belong to shadowAccount object class - {ldap_filter, ""}, - %% Now we want to define vCard pattern - {ldap_vcard_map, - [{"NICKNAME", "%u", []}, % just use user's part of JID as his nickname - {"GIVEN", "%s", ["givenName"]}, - {"FAMILY", "%s", ["sn"]}, - {"FN", "%s, %s", ["sn", "givenName"]}, % example: "Smith, John" - {"EMAIL", "%s", ["mail"]}, - {"BDAY", "%s", ["birthDay"]}]}, - %% Search form - {ldap_search_fields, - [{"User", "%u"}, - {"Name", "givenName"}, - {"Family Name", "sn"}, - {"Email", "mail"}, - {"Birthday", "birthDay"}]}, - %% vCard fields to be reported - %% Note that JID is always returned with search results - {ldap_search_reported, - [{"Full Name", "FN"}, - {"Nickname", "NICKNAME"}, - {"Birthday", "BDAY"}]} - ]}, - ... - ]}. -</PRE><P>Note that <TT>mod_vcard_ldap</TT> module checks for the existence of the user before -searching in his information in LDAP.</P><P> <A NAME="ad"></A> </P><!--TOC paragraph Active Directory--> -<H5 CLASS="paragraph"><!--SEC ANCHOR --><A HREF="#ad">Active Directory</A></H5><!--SEC END --><P> <A NAME="ad"></A> -</P><P>Active Directory is just an LDAP-server with predefined attributes. A sample -configuration is shown below:</P><PRE CLASS="verbatim">{auth_method, ldap}. -{ldap_servers, ["office.org"]}. % List of LDAP servers -{ldap_base, "DC=office,DC=org"}. % Search base of LDAP directory -{ldap_rootdn, "CN=Administrator,CN=Users,DC=office,DC=org"}. % LDAP manager -{ldap_password, "*******"}. % Password to LDAP manager -{ldap_uids, [{"sAMAccountName"}]}. -{ldap_filter, "(memberOf=*)"}. - -{modules, - [ - ... - {mod_vcard_ldap, - [{ldap_vcard_map, - [{"NICKNAME", "%u", []}, - {"GIVEN", "%s", ["givenName"]}, - {"MIDDLE", "%s", ["initials"]}, - {"FAMILY", "%s", ["sn"]}, - {"FN", "%s", ["displayName"]}, - {"EMAIL", "%s", ["mail"]}, - {"ORGNAME", "%s", ["company"]}, - {"ORGUNIT", "%s", ["department"]}, - {"CTRY", "%s", ["c"]}, - {"LOCALITY", "%s", ["l"]}, - {"STREET", "%s", ["streetAddress"]}, - {"REGION", "%s", ["st"]}, - {"PCODE", "%s", ["postalCode"]}, - {"TITLE", "%s", ["title"]}, - {"URL", "%s", ["wWWHomePage"]}, - {"DESC", "%s", ["description"]}, - {"TEL", "%s", ["telephoneNumber"]}]}, - {ldap_search_fields, - [{"User", "%u"}, - {"Name", "givenName"}, - {"Family Name", "sn"}, - {"Email", "mail"}, - {"Company", "company"}, - {"Department", "department"}, - {"Role", "title"}, - {"Description", "description"}, - {"Phone", "telephoneNumber"}]}, - {ldap_search_reported, - [{"Full Name", "FN"}, - {"Nickname", "NICKNAME"}, - {"Email", "EMAIL"}]} - ]}, - ... - ]}. -</PRE><P> <A NAME="modules"></A> </P><!--TOC section Modules Configuration--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc38">3.3</A>  <A HREF="#modules">Modules Configuration</A></H2><!--SEC END --><P> <A NAME="modules"></A> -</P><P>The option <TT>modules</TT> defines the list of modules that will be loaded after -<TT>ejabberd</TT>’s startup. Each entry in the list is a tuple in which the first -element is the name of a module and the second is a list of options for that -module.</P><P>The syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{modules, [ {ModuleName, ModuleOptions}, ...]}.</TT></B></DT></DL><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -In this example only the module <TT>mod_echo</TT> is loaded and no module -options are specified between the square brackets: -<PRE CLASS="verbatim">{modules, - [ - {mod_echo, []} - ]}. -</PRE></LI><LI CLASS="li-itemize">In the second example the modules <TT>mod_echo</TT>, <TT>mod_time</TT>, and -<TT>mod_version</TT> are loaded without options. Remark that, besides the last entry, -all entries end with a comma: -<PRE CLASS="verbatim">{modules, - [ - {mod_echo, []}, - {mod_time, []}, - {mod_version, []} - ]}. -</PRE></LI></UL><P> <A NAME="modoverview"></A> </P><!--TOC subsection Modules Overview--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc39">3.3.1</A>  <A HREF="#modoverview">Modules Overview</A></H3><!--SEC END --><P> <A NAME="modoverview"></A> -</P><P>The following table lists all modules included in <TT>ejabberd</TT>.</P><BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> -<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1><TR><TD ALIGN=left NOWRAP><B>Module</B></TD><TD ALIGN=left NOWRAP><B>Feature</B></TD><TD ALIGN=left NOWRAP><B>Dependencies</B></TD></TR> -<TR><TD ALIGN=left NOWRAP><TT>mod_adhoc</TT></TD><TD ALIGN=left NOWRAP>Ad-Hoc Commands (<A HREF="http://xmpp.org/extensions/xep-0050.html">XEP-0050</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modannounce"><TT>mod_announce</TT></A></TD><TD ALIGN=left NOWRAP>Manage announcements</TD><TD ALIGN=left NOWRAP>recommends <TT>mod_adhoc</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP><TT>mod_caps</TT></TD><TD ALIGN=left NOWRAP>Entity Capabilities (<A HREF="http://xmpp.org/extensions/xep-0115.html">XEP-0115</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><TT>mod_configure</TT></TD><TD ALIGN=left NOWRAP>Server configuration using Ad-Hoc</TD><TD ALIGN=left NOWRAP><TT>mod_adhoc</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#moddisco"><TT>mod_disco</TT></A></TD><TD ALIGN=left NOWRAP>Service Discovery (<A HREF="http://xmpp.org/extensions/xep-0030.html">XEP-0030</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modecho"><TT>mod_echo</TT></A></TD><TD ALIGN=left NOWRAP>Echoes XMPP stanzas</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modhttpbind"><TT>mod_http_bind</TT></A></TD><TD ALIGN=left NOWRAP>XMPP over Bosh service (HTTP Binding)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modhttpfileserver"><TT>mod_http_fileserver</TT></A></TD><TD ALIGN=left NOWRAP>Small HTTP file server</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modlast"><TT>mod_last</TT></A></TD><TD ALIGN=left NOWRAP>Last Activity (<A HREF="http://xmpp.org/extensions/xep-0012.html">XEP-0012</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modmuc"><TT>mod_muc</TT></A></TD><TD ALIGN=left NOWRAP>Multi-User Chat (<A HREF="http://xmpp.org/extensions/xep-0045.html">XEP-0045</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modmuclog"><TT>mod_muc_log</TT></A></TD><TD ALIGN=left NOWRAP>Multi-User Chat room logging</TD><TD ALIGN=left NOWRAP><TT>mod_muc</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modmulticast"><TT>mod_multicast</TT></A></TD><TD ALIGN=left NOWRAP>Multicast Service (<A HREF="http://xmpp.org/extensions/xep-0033.html">XEP-0033</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modoffline"><TT>mod_offline</TT></A></TD><TD ALIGN=left NOWRAP>Offline message storage (<A HREF="http://xmpp.org/extensions/xep-0160.html">XEP-0160</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modping"><TT>mod_ping</TT></A></TD><TD ALIGN=left NOWRAP>XMPP Ping and periodic keepalives (<A HREF="http://xmpp.org/extensions/xep-0199.html">XEP-0199</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modprivacy"><TT>mod_privacy</TT></A></TD><TD ALIGN=left NOWRAP>Blocking Communication (XMPP IM)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modprivate"><TT>mod_private</TT></A></TD><TD ALIGN=left NOWRAP>Private XML Storage (<A HREF="http://xmpp.org/extensions/xep-0049.html">XEP-0049</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modproxy"><TT>mod_proxy65</TT></A></TD><TD ALIGN=left NOWRAP>SOCKS5 Bytestreams (<A HREF="http://xmpp.org/extensions/xep-0065.html">XEP-0065</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modpubsub"><TT>mod_pubsub</TT></A></TD><TD ALIGN=left NOWRAP>Pub-Sub (<A HREF="http://xmpp.org/extensions/xep-0060.html">XEP-0060</A>), PEP (<A HREF="http://xmpp.org/extensions/xep-0163.html">XEP-0163</A>)</TD><TD ALIGN=left NOWRAP><TT>mod_caps</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modpubsub"><TT>mod_pubsub_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Pub-Sub (<A HREF="http://xmpp.org/extensions/xep-0060.html">XEP-0060</A>), PEP (<A HREF="http://xmpp.org/extensions/xep-0163.html">XEP-0163</A>)</TD><TD ALIGN=left NOWRAP>supported DB (*) and <TT>mod_caps</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modregister"><TT>mod_register</TT></A></TD><TD ALIGN=left NOWRAP>In-Band Registration (<A HREF="http://xmpp.org/extensions/xep-0077.html">XEP-0077</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modroster"><TT>mod_roster</TT></A></TD><TD ALIGN=left NOWRAP>Roster management (XMPP IM)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modservicelog"><TT>mod_service_log</TT></A></TD><TD ALIGN=left NOWRAP>Copy user messages to logger service</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modsharedroster"><TT>mod_shared_roster</TT></A></TD><TD ALIGN=left NOWRAP>Shared roster management</TD><TD ALIGN=left NOWRAP><TT>mod_roster</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modsic"><TT>mod_sic</TT></A></TD><TD ALIGN=left NOWRAP>Server IP Check (<A HREF="http://xmpp.org/extensions/xep-0279.html">XEP-0279</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modstats"><TT>mod_stats</TT></A></TD><TD ALIGN=left NOWRAP>Statistics Gathering (<A HREF="http://xmpp.org/extensions/xep-0039.html">XEP-0039</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modtime"><TT>mod_time</TT></A></TD><TD ALIGN=left NOWRAP>Entity Time (<A HREF="http://xmpp.org/extensions/xep-0202.html">XEP-0202</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modvcard"><TT>mod_vcard</TT></A></TD><TD ALIGN=left NOWRAP>vcard-temp (<A HREF="http://xmpp.org/extensions/xep-0054.html">XEP-0054</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modvcardldap"><TT>mod_vcard_ldap</TT></A></TD><TD ALIGN=left NOWRAP>vcard-temp (<A HREF="http://xmpp.org/extensions/xep-0054.html">XEP-0054</A>)</TD><TD ALIGN=left NOWRAP>LDAP server</TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modvcardxupdate"><TT>mod_vcard_xupdate</TT></A></TD><TD ALIGN=left NOWRAP>vCard-Based Avatars (<A HREF="http://xmpp.org/extensions/xep-0153.html">XEP-0153</A>)</TD><TD ALIGN=left NOWRAP><TT>mod_vcard</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modversion"><TT>mod_version</TT></A></TD><TD ALIGN=left NOWRAP>Software Version (<A HREF="http://xmpp.org/extensions/xep-0092.html">XEP-0092</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -</TABLE> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><UL CLASS="itemize"><LI CLASS="li-itemize"> -(*) This module requires a supported database. For a list of supported databases, see section <A HREF="#database">3.2</A>. -</LI></UL><P>You can see which database backend each module needs by looking at the suffix: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -No suffix, this means that the modules uses Erlang’s built-in database -Mnesia as backend, or in some cases it can be configured to use ODBC. -</LI><LI CLASS="li-itemize">‘_odbc’, this means that the module needs a supported database -(see <A HREF="#database">3.2</A>) as backend. -</LI><LI CLASS="li-itemize">‘_ldap’, this means that the module needs an LDAP server as backend. -</LI></UL><P>Those modules accept the option <TT>{backend, mnesia|odbc}</TT>, -and can store the tables in the configured backend:</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -<A HREF="#modlast"><TT>mod_last</TT></A>: Last connection date and time -</LI><LI CLASS="li-itemize"><A HREF="#modoffline"><TT>mod_offline</TT></A>: Offline messages -</LI><LI CLASS="li-itemize"><A HREF="#modprivacy"><TT>mod_privacy</TT></A>: User rules for blocking communications -</LI><LI CLASS="li-itemize"><A HREF="#modprivate"><TT>mod_private</TT></A>: Private XML storage -</LI><LI CLASS="li-itemize"><A HREF="#modroster"><TT>mod_roster</TT></A>: Rosters -</LI><LI CLASS="li-itemize"><A HREF="#modvcard"><TT>mod_vcard</TT></A>: Users’ vCard -</LI></UL><P>You can find more -<A HREF="http://www.ejabberd.im/contributions">contributed modules</A> on the -<TT>ejabberd</TT> website. Please remember that these contributions might not work or -that they can contain severe bugs and security leaks. Therefore, use them at -your own risk!</P><P> <A NAME="modcommonoptions"></A> </P><!--TOC subsection Common Options--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc40">3.3.2</A>  <A HREF="#modcommonoptions">Common Options</A></H3><!--SEC END --><P> <A NAME="modcommonoptions"></A> </P><P>The following options are used by many modules. Therefore, they are described in -this separate section.</P><P> <A NAME="modiqdiscoption"></A> </P><!--TOC subsubsection <TT>iqdisc</TT>--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#modiqdiscoption"><TT>iqdisc</TT></A></H4><!--SEC END --><P> <A NAME="modiqdiscoption"></A> -</P><P>Many modules define handlers for processing IQ queries of different namespaces -to this server or to a user (e. g. to <TT>example.org</TT> or to -<TT>user@example.org</TT>). This option defines processing discipline for -these queries.</P><P>The syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{iqdisc, Value}</TT></B></DT></DL><P>Possible <TT>Value</TT> are: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>no_queue</TT></B></DT><DD CLASS="dd-description"> All queries of a namespace with this processing discipline are -processed immediately. This also means that no other packets can be processed -until this one has been completely processed. Hence this discipline is not -recommended if the processing of a query can take a relatively long time. -</DD><DT CLASS="dt-description"><B><TT>one_queue</TT></B></DT><DD CLASS="dd-description"> In this case a separate queue is created for the processing -of IQ queries of a namespace with this discipline. In addition, the processing -of this queue is done in parallel with that of other packets. This discipline -is most recommended. -</DD><DT CLASS="dt-description"><B><TT>{queues, N}</TT></B></DT><DD CLASS="dd-description"> N separate queues are created to process the -queries. The queries are thus process in parallel, but in a -controlled way. -</DD><DT CLASS="dt-description"><B><TT>parallel</TT></B></DT><DD CLASS="dd-description"> For every packet with this discipline a separate Erlang process -is spawned. Consequently, all these packets are processed in parallel. -Although spawning of Erlang process has a relatively low cost, this can break -the server’s normal work, because the Erlang emulator has a limit on the -number of processes (32000 by default). -</DD></DL><P>Example: -</P><PRE CLASS="verbatim">{modules, - [ - ... - {mod_time, [{iqdisc, no_queue}]}, - ... - ]}. -</PRE><P> <A NAME="modhostoption"></A> </P><!--TOC subsubsection <TT>host</TT>--> -<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#modhostoption"><TT>host</TT></A></H4><!--SEC END --><P> <A NAME="modhostoption"></A> -</P><P>This option defines the Jabber ID of a service provided by an <TT>ejabberd</TT> module.</P><P>The syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{host, HostName}</TT></B></DT></DL><P>If you include the keyword "@HOST@" in the HostName, -it is replaced at start time with the real virtual host string.</P><P>This example configures -the echo module to provide its echoing service -in the Jabber ID <TT>mirror.example.org</TT>: -</P><PRE CLASS="verbatim">{modules, - [ - ... - {mod_echo, [{host, "mirror.example.org"}]}, - ... - ]}. -</PRE><P>However, if there are several virtual hosts and this module is enabled in all of them, -the "@HOST@" keyword must be used: -</P><PRE CLASS="verbatim">{modules, - [ - ... - {mod_echo, [{host, "mirror.@HOST@"}]}, - ... - ]}. -</PRE><P> <A NAME="modannounce"></A> </P><!--TOC subsection <TT>mod_announce</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc41">3.3.3</A>  <A HREF="#modannounce"><TT>mod_announce</TT></A></H3><!--SEC END --><P> <A NAME="modannounce"></A> -</P><P>This module enables configured users to broadcast announcements and to set -the message of the day (MOTD). -Configured users can perform these actions with a -XMPP client either using Ad-hoc commands -or sending messages to specific JIDs.</P><P>The Ad-hoc commands are listed in the Server Discovery. -For this feature to work, <TT>mod_adhoc</TT> must be enabled.</P><P>The specific JIDs where messages can be sent are listed bellow. -The first JID in each entry will apply only to the specified virtual host -<TT>example.org</TT>, while the JID between brackets will apply to all virtual -hosts in ejabberd. -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>example.org/announce/all (example.org/announce/all-hosts/all)</TT></B></DT><DD CLASS="dd-description"> The -message is sent to all registered users. If the user is online and connected -to several resources, only the resource with the highest priority will receive -the message. If the registered user is not connected, the message will be -stored offline in assumption that offline storage -(see section <A HREF="#modoffline">3.3.12</A>) is enabled. -</DD><DT CLASS="dt-description"><B><TT>example.org/announce/online (example.org/announce/all-hosts/online)</TT></B></DT><DD CLASS="dd-description">The -message is sent to all connected users. If the user is online and connected -to several resources, all resources will receive the message. -</DD><DT CLASS="dt-description"><B><TT>example.org/announce/motd (example.org/announce/all-hosts/motd)</TT></B></DT><DD CLASS="dd-description">The -message is set as the message of the day (MOTD) and is sent to users when they -login. In addition the message is sent to all connected users (similar to -<TT>announce/online</TT>). -</DD><DT CLASS="dt-description"><B><TT>example.org/announce/motd/update (example.org/announce/all-hosts/motd/update)</TT></B></DT><DD CLASS="dd-description"> -The message is set as message of the day (MOTD) and is sent to users when they -login. The message is <EM>not sent</EM> to any currently connected user. -</DD><DT CLASS="dt-description"><B><TT>example.org/announce/motd/delete (example.org/announce/all-hosts/motd/delete)</TT></B></DT><DD CLASS="dd-description"> -Any message sent to this JID removes the existing message of the day (MOTD). -</DD></DL><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{access, AccessName}</TT></B></DT><DD CLASS="dd-description"> This option specifies who is allowed to -send announcements and to set the message of the day (by default, nobody is -able to send such messages). -</DD></DL><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -Only administrators can send announcements: -<PRE CLASS="verbatim">{access, announce, [{allow, admins}]}. - -{modules, - [ - ... - {mod_adhoc, []}, - {mod_announce, [{access, announce}]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">Administrators as well as the direction can send announcements: -<PRE CLASS="verbatim">{acl, direction, {user, "big_boss", "example.org"}}. -{acl, direction, {user, "assistant", "example.org"}}. -{acl, admins, {user, "admin", "example.org"}}. - -{access, announce, [{allow, admins}, - {allow, direction}]}. - -{modules, - [ - ... - {mod_adhoc, []}, - {mod_announce, [{access, announce}]}, - ... - ]}. -</PRE></LI></UL><P>Note that <TT>mod_announce</TT> can be resource intensive on large -deployments as it can broadcast lot of messages. This module should be -disabled for instances of <TT>ejabberd</TT> with hundreds of thousands users.</P><P> <A NAME="moddisco"></A> </P><!--TOC subsection <TT>mod_disco</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc42">3.3.4</A>  <A HREF="#moddisco"><TT>mod_disco</TT></A></H3><!--SEC END --><P> <A NAME="moddisco"></A> - - - - -</P><P>This module adds support for Service Discovery (<A HREF="http://xmpp.org/extensions/xep-0030.html">XEP-0030</A>). With -this module enabled, services on your server can be discovered by -XMPP clients. Note that <TT>ejabberd</TT> has no modules with support -for the superseded Jabber Browsing (<A HREF="http://xmpp.org/extensions/xep-0011.html">XEP-0011</A>) and Agent Information -(<A HREF="http://xmpp.org/extensions/xep-0094.html">XEP-0094</A>). Accordingly, XMPP clients need to have support for -the newer Service Discovery protocol if you want them be able to discover -the services you offer.</P><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{iqdisc, Discipline}</TT></B></DT><DD CLASS="dd-description"> This specifies -the processing discipline for Service Discovery (<TT>http://jabber.org/protocol/disco#items</TT> and -<TT>http://jabber.org/protocol/disco#info</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>). -</DD><DT CLASS="dt-description"><B><TT>{extra_domains, [Domain, ...]}</TT></B></DT><DD CLASS="dd-description"> With this option, -you can specify a list of extra domains that are added to the Service Discovery item list. -</DD><DT CLASS="dt-description"><B><TT>{server_info, [ {Modules, Field, [Value, ...]}, ... ]}</TT></B></DT><DD CLASS="dd-description"> -Specify additional information about the server, -as described in Contact Addresses for XMPP Services (<A HREF="http://xmpp.org/extensions/xep-0157.html">XEP-0157</A>). -<TT>Modules</TT> can be the keyword ‘all’, -in which case the information is reported in all the services; -or a list of <TT>ejabberd</TT> modules, -in which case the information is only specified for the services provided by those modules. -Any arbitrary <TT>Field</TT> and <TT>Value</TT> can be specified, not only contact addresses. -</DD></DL><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -To serve a link to the Jabber User Directory on <TT>jabber.org</TT>: -<PRE CLASS="verbatim">{modules, - [ - ... - {mod_disco, [{extra_domains, ["users.jabber.org"]}]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">To serve a link to the transports on another server: -<PRE CLASS="verbatim">{modules, - [ - ... - {mod_disco, [{extra_domains, ["icq.example.com", - "msn.example.com"]}]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">To serve a link to a few friendly servers: -<PRE CLASS="verbatim">{modules, - [ - ... - {mod_disco, [{extra_domains, ["example.org", - "example.com"]}]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">With this configuration, all services show abuse addresses, -feedback address on the main server, -and admin addresses for both the main server and the vJUD service: -<PRE CLASS="verbatim">{modules, - [ - ... - {mod_disco, [{server_info, [ - {all, - "abuse-addresses", - ["mailto:abuse@shakespeare.lit"]}, - {[mod_muc], - "Web chatroom logs", - ["http://www.example.org/muc-logs"]}, - {[mod_disco], - "feedback-addresses", - ["http://shakespeare.lit/feedback.php", "mailto:feedback@shakespeare.lit", "xmpp:feedback@shakespeare.lit"]}, - {[mod_disco, mod_vcard], - "admin-addresses", - ["mailto:xmpp@shakespeare.lit", "xmpp:admins@shakespeare.lit"]} - ]}]}, - ... - ]}. -</PRE></LI></UL><P> <A NAME="modecho"></A> </P><!--TOC subsection <TT>mod_echo</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc43">3.3.5</A>  <A HREF="#modecho"><TT>mod_echo</TT></A></H3><!--SEC END --><P> <A NAME="modecho"></A> -</P><P>This module simply echoes any XMPP -packet back to the sender. This mirror can be of interest for -<TT>ejabberd</TT> and XMPP client debugging.</P><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> - -<B><TT>{host, HostName}</TT></B></DT><DD CLASS="dd-description"> This option defines the Jabber ID of the -service. If the <TT>host</TT> option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘<TT>echo.</TT>’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -</DD></DL><P>Example: Mirror, mirror, on the wall, who is the most beautiful -of them all? -</P><PRE CLASS="verbatim">{modules, - [ - ... - {mod_echo, [{host, "mirror.example.org"}]}, - ... - ]}. -</PRE><P> <A NAME="modhttpbind"></A> </P><!--TOC subsection <TT>mod_http_bind</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc44">3.3.6</A>  <A HREF="#modhttpbind"><TT>mod_http_bind</TT></A></H3><!--SEC END --><P> <A NAME="modhttpbind"></A> -</P><P>This module implements XMPP over Bosh (formerly known as HTTP Binding) -as defined in <A HREF="http://xmpp.org/extensions/xep-0124.html">XEP-0124</A> and <A HREF="http://xmpp.org/extensions/xep-0206.html">XEP-0206</A>. -It extends ejabberd’s built in HTTP service with a configurable -resource at which this service will be hosted.</P><P>To use HTTP-Binding, enable the module: -</P><PRE CLASS="verbatim">{modules, - [ - ... - {mod_http_bind, []}, - ... -]}. -</PRE><P>and add <CODE>http_bind</CODE> in the HTTP service. For example: -</P><PRE CLASS="verbatim">{listen, - [ - ... - {5280, ejabberd_http, [ - http_bind, - http_poll, - web_admin - ] - }, - ... -]}. -</PRE><P>With this configuration, the module will serve the requests sent to -<CODE>http://example.org:5280/http-bind/</CODE> -Remember that this page is not designed to be used by web browsers, -it is used by XMPP clients that support XMPP over Bosh.</P><P>If you want to set the service in a different URI path or use a different module, -you can configure it manually using the option <CODE>request_handlers</CODE>. -For example: -</P><PRE CLASS="verbatim">{listen, - [ - ... - {5280, ejabberd_http, [ - {request_handlers, [{["http-bind"], mod_http_bind}]}, - http_poll, - web_admin - ] - }, - ... -]}. -</PRE><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{max_inactivity, Seconds}</TT></B></DT><DD CLASS="dd-description"> -Define the maximum inactivity period in seconds. -Default value is 30 seconds. -For example, to set 50 seconds: -<PRE CLASS="verbatim">{modules, - [ - ... - {mod_http_bind, [ {max_inactivity, 50} ]}, - ... -]}. -</PRE></DD></DL><P> <A NAME="modhttpfileserver"></A> </P><!--TOC subsection <TT>mod_http_fileserver</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc45">3.3.7</A>  <A HREF="#modhttpfileserver"><TT>mod_http_fileserver</TT></A></H3><!--SEC END --><P> <A NAME="modhttpfileserver"></A> -</P><P>This simple module serves files from the local disk over HTTP.</P><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{docroot, Path}</TT></B></DT><DD CLASS="dd-description"> -Directory to serve the files. -</DD><DT CLASS="dt-description"><B><TT>{accesslog, Path}</TT></B></DT><DD CLASS="dd-description"> -File to log accesses using an Apache-like format. -No log will be recorded if this option is not specified. -</DD><DT CLASS="dt-description"><B><TT>{directory_indices, [Index, ...]}</TT></B></DT><DD CLASS="dd-description"> -Indicate one or more directory index files, similarly to Apache’s -DirectoryIndex variable. When a web request hits a directory -instead of a regular file, those directory indices are looked in -order, and the first one found is returned. -</DD><DT CLASS="dt-description"><B><TT>{custom_headers, [ {Name, Value}, ...]}</TT></B></DT><DD CLASS="dd-description"> -Indicate custom HTTP headers to be included in all responses. -Default value is: <TT>[]</TT> -</DD><DT CLASS="dt-description"><B><TT>{content_types, [ {Name, Type}, ...]}</TT></B></DT><DD CLASS="dd-description"> -Specify mappings of extension to content type. -There are several content types already defined, -with this option you can add new definitions, modify or delete existing ones. -To delete an existing definition, simply define it with a value: ‘undefined’. -</DD><DT CLASS="dt-description"><B><TT>{default_content_type, Type}</TT></B></DT><DD CLASS="dd-description"> -Specify the content type to use for unknown extensions. -Default value is ‘application/octet-stream’. -</DD></DL><P>This example configuration will serve the files from -the local directory <CODE>/var/www</CODE> -in the address <CODE>http://example.org:5280/pub/archive/</CODE>. -In this example a new content type <TT>ogg</TT> is defined, -<TT>png</TT> is redefined, and <TT>jpg</TT> definition is deleted. -To use this module you must enable it: -</P><PRE CLASS="verbatim">{modules, - [ - ... - {mod_http_fileserver, [ - {docroot, "/var/www"}, - {accesslog, "/var/log/ejabberd/access.log"}, - {directory_indices, ["index.html", "main.htm"]}, - {custom_headers, [{"X-Powered-By", "Erlang/OTP"}, - {"X-Fry", "It's a widely-believed fact!"} - ]}, - {content_types, [{".ogg", "audio/ogg"}, - {".png", "image/png"}, - {".jpg", undefined} - ]}, - {default_content_type, "text/html"} - ] - }, - ... -]}. -</PRE><P>And define it as a handler in the HTTP service: -</P><PRE CLASS="verbatim">{listen, - [ - ... - {5280, ejabberd_http, [ - ... - {request_handlers, [ - ... - {["pub", "archive"], mod_http_fileserver}, - ... - ] - }, - ... - ] - }, - ... -]}. -</PRE><P> <A NAME="modlast"></A> </P><!--TOC subsection <TT>mod_last</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc46">3.3.8</A>  <A HREF="#modlast"><TT>mod_last</TT></A></H3><!--SEC END --><P> <A NAME="modlast"></A> -</P><P>This module adds support for Last Activity (<A HREF="http://xmpp.org/extensions/xep-0012.html">XEP-0012</A>). It can be used to -discover when a disconnected user last accessed the server, to know when a -connected user was last active on the server, or to query the uptime of the -<TT>ejabberd</TT> server.</P><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{backend, mnesia|odbc}</TT></B></DT><DD CLASS="dd-description"> -Specify the backend used to store the tables: <TT>last_activity</TT>. -The default value is <TT>mnesia</TT>. -If configured to <TT>odbc</TT>, then you must also configure in ejabberd -the database connection (see the subsections of <A HREF="#database">3.2</A>). - -</DD><DT CLASS="dt-description"><B><TT>{iqdisc, Discipline}</TT></B></DT><DD CLASS="dd-description"> This specifies -the processing discipline for Last activity (<TT>jabber:iq:last</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>). -</DD></DL><P> <A NAME="modmuc"></A> </P><!--TOC subsection <TT>mod_muc</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc47">3.3.9</A>  <A HREF="#modmuc"><TT>mod_muc</TT></A></H3><!--SEC END --><P> <A NAME="modmuc"></A> -</P><P>This module provides a Multi-User Chat (<A HREF="http://xmpp.org/extensions/xep-0045.html">XEP-0045</A>) service. -Users can discover existing rooms, join or create them. -Occupants of a room can chat in public or have private chats.</P><P>Some of the features of Multi-User Chat: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -Sending public and private messages to room occupants. -</LI><LI CLASS="li-itemize">Inviting other users to a room. -</LI><LI CLASS="li-itemize">Setting a room subject. -</LI><LI CLASS="li-itemize">Creating password protected rooms. -</LI><LI CLASS="li-itemize">Kicking and banning occupants. -</LI></UL><P>The MUC service allows any Jabber ID to register a nickname, -so nobody else can use that nickname in any room in the MUC service. -To register a nickname, open the Service Discovery in your -XMPP client and register in the MUC service.</P><P>This module supports clustering and load -balancing. One module can be started per cluster node. Rooms are -distributed at creation time on all available MUC module -instances. The multi-user chat module is clustered but the rooms -themselves are not clustered nor fault-tolerant: if the node managing a -set of rooms goes down, the rooms disappear and they will be recreated -on an available node on first connection attempt.</P><P>Module options: -</P><DL CLASS="description"><DT CLASS="dt-description"> - -<B><TT>{host, HostName}</TT></B></DT><DD CLASS="dd-description"> This option defines the Jabber ID of the -service. If the <TT>host</TT> option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘<TT>conference.</TT>’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -</DD><DT CLASS="dt-description"><B><TT>{access, AccessName}</TT></B></DT><DD CLASS="dd-description"> You can specify who is allowed to use -the Multi-User Chat service. By default everyone is allowed to use it. -</DD><DT CLASS="dt-description"><B><TT>{access_create, AccessName}</TT></B></DT><DD CLASS="dd-description"> To configure who is -allowed to create new rooms at the Multi-User Chat service, this option can be used. -By default any account in the local ejabberd server is allowed to create rooms. -</DD><DT CLASS="dt-description"><B><TT>{access_persistent, AccessName}</TT></B></DT><DD CLASS="dd-description"> To configure who is -allowed to modify the ’persistent’ room option. -By default any account in the local ejabberd server is allowed to modify that option. -</DD><DT CLASS="dt-description"><B><TT>{access_admin, AccessName}</TT></B></DT><DD CLASS="dd-description"> This option specifies -who is allowed to administrate the Multi-User Chat service. The default -value is <TT>none</TT>, which means that only the room creator can -administer his room. -The administrators can send a normal message to the service JID, -and it will be shown in all active rooms as a service message. -The administrators can send a groupchat message to the JID of an active room, -and the message will be shown in the room as a service message. -</DD><DT CLASS="dt-description"><B><TT>{history_size, Size}</TT></B></DT><DD CLASS="dd-description"> A small history of -the current discussion is sent to users when they enter the -room. With this option you can define the number of history messages -to keep and send to users joining the room. The value is an -integer. Setting the value to <TT>0</TT> disables the history feature -and, as a result, nothing is kept in memory. The default value is -<TT>20</TT>. This value is global and thus affects all rooms on the -service. -</DD><DT CLASS="dt-description"><B><TT>{max_users, Number}</TT></B></DT><DD CLASS="dd-description"> This option defines at -the service level, the maximum number of users allowed per -room. It can be lowered in each room configuration but cannot be -increased in individual room configuration. The default value is -200. -</DD><DT CLASS="dt-description"><B><TT>{max_users_admin_threshold, Number}</TT></B></DT><DD CLASS="dd-description"> - This option defines the -number of service admins or room owners allowed to enter the room when -the maximum number of allowed occupants was reached. The default limit -is 5. -</DD><DT CLASS="dt-description"><B><TT>{max_user_conferences, Number}</TT></B></DT><DD CLASS="dd-description"> - This option defines the maximum -number of rooms that any given user can join. The default value -is 10. This option is used to prevent possible abuses. Note that -this is a soft limit: some users can sometimes join more conferences -in cluster configurations. -</DD><DT CLASS="dt-description"><B><TT>{max_room_id, Number}</TT></B></DT><DD CLASS="dd-description"> -This option defines the maximum number of characters that Room ID -can have when creating a new room. -The default value is to not limit: infinite. -</DD><DT CLASS="dt-description"><B><TT>{max_room_name, Number}</TT></B></DT><DD CLASS="dd-description"> -This option defines the maximum number of characters that Room Name -can have when configuring the room. -The default value is to not limit: infinite. -</DD><DT CLASS="dt-description"><B><TT>{max_room_desc, Number}</TT></B></DT><DD CLASS="dd-description"> -This option defines the maximum number of characters that Room Description -can have when configuring the room. -The default value is to not limit: infinite. -</DD><DT CLASS="dt-description"><B><TT>{min_message_interval, Number}</TT></B></DT><DD CLASS="dd-description"> -This option defines the minimum interval between two messages send -by an occupant in seconds. This option is global and valid for all -rooms. A decimal value can be used. When this option is not defined, -message rate is not limited. This feature can be used to protect a -MUC service from occupant abuses and limit number of messages that will -be broadcasted by the service. A good value for this minimum message -interval is 0.4 second. If an occupant tries to send messages faster, an -error is send back explaining that the message has been discarded -and describing the reason why the message is not acceptable. -</DD><DT CLASS="dt-description"><B><TT>{min_presence_interval, Number}</TT></B></DT><DD CLASS="dd-description"> - This option defines the -minimum of time between presence changes coming from a given occupant in -seconds. This option is global and valid for all rooms. A -decimal value can be used. When this option is not defined, no -restriction is applied. This option can be used to protect a MUC -service for occupants abuses. If an occupant tries -to change its presence more often than the specified interval, the -presence is cached by <TT>ejabberd</TT> and only the last presence is -broadcasted to all occupants in the room after expiration of the -interval delay. Intermediate presence packets are silently -discarded. A good value for this option is 4 seconds. -</DD><DT CLASS="dt-description"><B><TT>{default_room_options, [ {OptionName, OptionValue}, ...]}</TT></B></DT><DD CLASS="dd-description"> -This module option allows to define the desired default room options. -Note that the creator of a room can modify the options of his room -at any time using a XMPP client with MUC capability. -The available room options and the default values are: -<DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{allow_change_subj, true|false}</TT></B></DT><DD CLASS="dd-description"> Allow occupants to change the subject. -</DD><DT CLASS="dt-description"><B><TT>{allow_private_messages, true|false}</TT></B></DT><DD CLASS="dd-description"> Occupants can send private messages to other occupants. -</DD><DT CLASS="dt-description"><B><TT>{allow_query_users, true|false}</TT></B></DT><DD CLASS="dd-description"> Occupants can send IQ queries to other occupants. -</DD><DT CLASS="dt-description"><B><TT>{allow_user_invites, false|true}</TT></B></DT><DD CLASS="dd-description"> Allow occupants to send invitations. -</DD><DT CLASS="dt-description"><B><TT>{allow_visitor_nickchange, true|false}</TT></B></DT><DD CLASS="dd-description"> Allow visitors to -change nickname. -</DD><DT CLASS="dt-description"><B><TT>{allow_visitor_status, true|false}</TT></B></DT><DD CLASS="dd-description"> Allow visitors to send -status text in presence updates. If disallowed, the <TT>status</TT> -text is stripped before broadcasting the presence update to all -the room occupants. -</DD><DT CLASS="dt-description"><B><TT>{anonymous, true|false}</TT></B></DT><DD CLASS="dd-description"> The room is anonymous: -occupants don’t see the real JIDs of other occupants. -Note that the room moderators can always see the real JIDs of the occupants. -</DD><DT CLASS="dt-description"><B><TT>{captcha_protected, false}</TT></B></DT><DD CLASS="dd-description"> -When a user tries to join a room where he has no affiliation (not owner, admin or member), -the room requires him to fill a CAPTCHA challenge (see section <A HREF="#captcha">3.1.8</A>) -in order to accept her join in the room. -</DD><DT CLASS="dt-description"><B><TT>{logging, false|true}</TT></B></DT><DD CLASS="dd-description"> The public messages are logged using <TT>mod_muc_log</TT>. -</DD><DT CLASS="dt-description"><B><TT>{max_users, 200}</TT></B></DT><DD CLASS="dd-description"> Maximum number of occupants in the room. -</DD><DT CLASS="dt-description"><B><TT>{members_by_default, true|false}</TT></B></DT><DD CLASS="dd-description"> The occupants that enter the room are participants by default, so they have ’voice’. -</DD><DT CLASS="dt-description"><B><TT>{members_only, false|true}</TT></B></DT><DD CLASS="dd-description"> Only members of the room can enter. -</DD><DT CLASS="dt-description"><B><TT>{moderated, true|false}</TT></B></DT><DD CLASS="dd-description"> Only occupants with ’voice’ can send public messages. -</DD><DT CLASS="dt-description"><B><TT>{password, "roompass123"}</TT></B></DT><DD CLASS="dd-description"> Password of the room. You may want to enable the next option too. -</DD><DT CLASS="dt-description"><B><TT>{password_protected, false|true}</TT></B></DT><DD CLASS="dd-description"> The password is required to enter the room. -</DD><DT CLASS="dt-description"><B><TT>{persistent, false|true}</TT></B></DT><DD CLASS="dd-description"> The room persists even if the last participant leaves. -</DD><DT CLASS="dt-description"><B><TT>{public, true|false}</TT></B></DT><DD CLASS="dd-description"> The room is public in the list of the MUC service, so it can be discovered. -</DD><DT CLASS="dt-description"><B><TT>{public_list, true|false}</TT></B></DT><DD CLASS="dd-description"> The list of participants is public, without requiring to enter the room. -</DD><DT CLASS="dt-description"><B><TT>{title, "Room Title"}</TT></B></DT><DD CLASS="dd-description"> A human-readable title of the room. -</DD></DL> -All of those room options can be set to <TT>true</TT> or <TT>false</TT>, -except <TT>password</TT> and <TT>title</TT> which are strings, -and <TT>max_users</TT> that is integer. -</DD></DL><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -In the first example everyone is allowed to use the Multi-User Chat -service. Everyone will also be able to create new rooms but only the user -<TT>admin@example.org</TT> is allowed to administrate any room. In this -example he is also a global administrator. When <TT>admin@example.org</TT> -sends a message such as ‘Tomorrow, the XMPP server will be moved -to new hardware. This will involve service breakdowns around 23:00 UMT. -We apologise for this inconvenience.’ to <TT>conference.example.org</TT>, -it will be displayed in all active rooms. In this example the history -feature is disabled. -<PRE CLASS="verbatim">{acl, admin, {user, "admin", "example.org"}}. - -{access, muc_admin, [{allow, admin}]}. - -{modules, - [ - ... - {mod_muc, [{access, all}, - {access_create, all}, - {access_admin, muc_admin}, - {history_size, 0}]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">In the second example the Multi-User Chat service is only accessible by -paying customers registered on our domains and on other servers. Of course -the administrator is also allowed to access rooms. In addition, he is the -only authority able to create and administer rooms. When -<TT>admin@example.org</TT> sends a message such as ‘Tomorrow, the Jabber -server will be moved to new hardware. This will involve service breakdowns -around 23:00 UMT. We apologise for this inconvenience.’ to -<TT>conference.example.org</TT>, it will be displayed in all active rooms. No -<TT>history_size</TT> option is used, this means that the feature is enabled -and the default value of 20 history messages will be send to the users. -<PRE CLASS="verbatim">{acl, paying_customers, {user, "customer1", "example.net"}}. -{acl, paying_customers, {user, "customer2", "example.com"}}. -{acl, paying_customers, {user, "customer3", "example.org"}}. -{acl, admin, {user, "admin", "example.org"}}. - -{access, muc_admin, [{allow, admin}, - {deny, all}]}. -{access, muc_access, [{allow, paying_customers}, - {allow, admin}, - {deny, all}]}. - -{modules, - [ - ... - {mod_muc, [{access, muc_access}, - {access_create, muc_admin}, - {access_admin, muc_admin}]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">In the following example, MUC anti abuse options are used. An -occupant cannot send more than one message every 0.4 seconds and cannot -change its presence more than once every 4 seconds. -The length of Room IDs and Room Names are limited to 20 characters, -and Room Description to 300 characters. No ACLs are -defined, but some user restriction could be added as well:<PRE CLASS="verbatim">{modules, - [ - ... - {mod_muc, [{min_message_interval, 0.4}, - {min_presence_interval, 4}, - {max_room_id, 20}, - {max_room_name, 20}, - {max_room_desc, 300}]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">This example shows how to use <TT>default_room_options</TT> to make sure -the newly created rooms have by default those options. -<PRE CLASS="verbatim">{modules, - [ - ... - {mod_muc, [{access, muc_access}, - {access_create, muc_admin}, - {default_room_options, - [ - {allow_change_subj, false}, - {allow_query_users, true}, - {allow_private_messages, true}, - {members_by_default, false}, - {title, "New chatroom"}, - {anonymous, false} - ]}, - {access_admin, muc_admin}]}, - ... - ]}. -</PRE></LI></UL><P> <A NAME="modmuclog"></A> </P><!--TOC subsection <TT>mod_muc_log</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc48">3.3.10</A>  <A HREF="#modmuclog"><TT>mod_muc_log</TT></A></H3><!--SEC END --><P> <A NAME="modmuclog"></A> -</P><P>This module enables optional logging of Multi-User Chat (MUC) public conversations to -HTML. Once you enable this module, users can join a room using a MUC capable -XMPP client, and if they have enough privileges, they can request the -configuration form in which they can set the option to enable room logging.</P><P>Features: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -Room details are added on top of each page: room title, JID, -author, subject and configuration. -</LI><LI CLASS="li-itemize"> -The room JID in the generated HTML is a link to join the room (using -<A HREF="http://xmpp.org/rfcs/rfc5122.html">XMPP URI</A>). -</LI><LI CLASS="li-itemize">Subject and room configuration changes are tracked and displayed. -</LI><LI CLASS="li-itemize">Joins, leaves, nick changes, kicks, bans and ‘/me’ are tracked and -displayed, including the reason if available. -</LI><LI CLASS="li-itemize">Generated HTML files are XHTML 1.0 Transitional and CSS compliant. -</LI><LI CLASS="li-itemize">Timestamps are self-referencing links. -</LI><LI CLASS="li-itemize">Links on top for quicker navigation: Previous day, Next day, Up. -</LI><LI CLASS="li-itemize">CSS is used for style definition, and a custom CSS file can be used. -</LI><LI CLASS="li-itemize">URLs on messages and subjects are converted to hyperlinks. -</LI><LI CLASS="li-itemize">Timezone used on timestamps is shown on the log files. -</LI><LI CLASS="li-itemize">A custom link can be added on top of each page. -</LI></UL><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{access_log, AccessName}</TT></B></DT><DD CLASS="dd-description"> -This option restricts which occupants are allowed to enable or disable room -logging. The default value is <TT>muc_admin</TT>. Note for this default setting -you need to have an access rule for <TT>muc_admin</TT> in order to take effect. -</DD><DT CLASS="dt-description"><B><TT>{cssfile, false|URL}</TT></B></DT><DD CLASS="dd-description"> -With this option you can set whether the HTML files should have a custom CSS -file or if they need to use the embedded CSS file. Allowed values are -<TT>false</TT> and an URL to a CSS file. With the first value, HTML files will -include the embedded CSS code. With the latter, you can specify the URL of the -custom CSS file (for example: <TT>"http://example.com/my.css"</TT>). The default value -is <TT>false</TT>. -</DD><DT CLASS="dt-description"><B><TT>{dirname, room_jid|room_name}</TT></B></DT><DD CLASS="dd-description"> -Allows to configure the name of the room directory. -Allowed values are <TT>room_jid</TT> and <TT>room_name</TT>. -With the first value, the room directory name will be the full room JID. -With the latter, the room directory name will be only the room name, -not including the MUC service name. -The default value is <TT>room_jid</TT>. -</DD><DT CLASS="dt-description"><B><TT>{dirtype, subdirs|plain}</TT></B></DT><DD CLASS="dd-description"> -The type of the created directories can be specified with this option. Allowed -values are <TT>subdirs</TT> and <TT>plain</TT>. With the first value, -subdirectories are created for each year and month. With the latter, the -names of the log files contain the full date, and there are no subdirectories. -The default value is <TT>subdirs</TT>. -</DD><DT CLASS="dt-description"><B><TT>{file_format, html|plaintext}</TT></B></DT><DD CLASS="dd-description"> -Define the format of the log files: -<TT>html</TT> stores in HTML format, -<TT>plaintext</TT> stores in plain text. -The default value is <TT>html</TT>. -</DD><DT CLASS="dt-description"><B><TT>{outdir, Path}</TT></B></DT><DD CLASS="dd-description"> -This option sets the full path to the directory in which the HTML files should -be stored. Make sure the <TT>ejabberd</TT> daemon user has write access on that -directory. The default value is <TT>"www/muc"</TT>. -</DD><DT CLASS="dt-description"><B><TT>{link_nofollow true|false}</TT></B></DT><DD CLASS="dd-description"> -The option <TT>link_nofollow</TT> adds a special attribute -to links that prevent their indexation by search engines. The default value -is <TT>true</TT>, which means that <TT>nofollow</TT> attributes will be added to user -submitted links. -</DD><DT CLASS="dt-description"><B><TT>{timezone, local|universal}</TT></B></DT><DD CLASS="dd-description"> -The time zone for the logs is configurable with this option. Allowed values -are <TT>local</TT> and <TT>universal</TT>. With the first value, the local time, -as reported to Erlang by the operating system, will be used. With the latter, -GMT/UTC time will be used. The default value is <TT>local</TT>. -</DD><DT CLASS="dt-description"><B><TT>{top_link, {URL, Text}}</TT></B></DT><DD CLASS="dd-description"> -With this option you can customize the link on the top right corner of each -log file. The default value is <TT>{"/", "Home"}</TT>. -</DD></DL><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -In the first example any room owner can enable logging, and a -custom CSS file will be used (http://example.com/my.css). The names -of the log files will contain the full date, and there will be no -subdirectories. The log files will be stored in /var/www/muclogs, and the -time zone will be GMT/UTC. Finally, the top link will be -<CODE><a href="http://www.jabber.ru/">Jabber.ru</a></CODE>. -<PRE CLASS="verbatim">{access, muc, [{allow, all}]}. - -{modules, - [ - ... - {mod_muc_log, [ - {access_log, muc}, - {cssfile, "http://example.com/my.css"}, - {dirtype, plain}, - {dirname, room_jid}, - {outdir, "/var/www/muclogs"}, - {timezone, universal}, - {link_nofollow, true}, - {top_link, {"http://www.jabber.ru/", "Jabber.ru"}} - ]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">In the second example only <TT>admin1@example.org</TT> and -<TT>admin2@example.net</TT> can enable logging, and the embedded CSS file will be -used. The names of the log files will only contain the day (number), -and there will be subdirectories for each year and month. The log files will -be stored in /var/www/muclogs, and the local time will be used. Finally, the -top link will be the default <CODE><a href="/">Home</a></CODE>. -<PRE CLASS="verbatim">{acl, admins, {user, "admin1", "example.org"}}. -{acl, admins, {user, "admin2", "example.net"}}. - -{access, muc_log, [{allow, admins}, - {deny, all}]}. - -{modules, - [ - ... - {mod_muc_log, [ - {access_log, muc_log}, - {cssfile, false}, - {dirtype, subdirs}, - {outdir, "/var/www/muclogs"}, - {timezone, local} - ]}, - ... - ]}. -</PRE></LI></UL><P> <A NAME="modmulticast"></A> </P><!--TOC subsection <TT>mod_multicast</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc49">3.3.11</A>  <A HREF="#modmulticast"><TT>mod_multicast</TT></A></H3><!--SEC END --><P> <A NAME="modmulticast"></A> -</P><P>This module implements a service for Extended Stanza Addressing (<A HREF="http://xmpp.org/extensions/xep-0033.html">XEP-0033</A>) -that can be used by local or remote XMPP entities (users, components or servers). -If this service is enabled, it will be used by <TT>ejabberd</TT> to send -C2S presence broadcasts, and MUC groupchat messages.</P><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> - -<B><TT>{host, HostName}</TT></B></DT><DD CLASS="dd-description"> This option defines the Jabber ID of the -service. If the <TT>host</TT> option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘<TT>multicast.</TT>’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -</DD><DT CLASS="dt-description"><B><TT>{access, AccessName}</TT></B></DT><DD CLASS="dd-description"> -Specify who can send packets to the multicast service. -By default everyone is allowed to use it. -</DD><DT CLASS="dt-description"><B><TT>{limits, [ {Sender, Stanza, Number} ] }</TT></B></DT><DD CLASS="dd-description"> -Specify a list of custom limits which override the default ones. -<TT>Sender</TT> can be <TT>local</TT> or <TT>remote</TT>. -<TT>Stanza</TT> can be <TT>message</TT> or <TT>presence</TT>. -<TT>Number</TT> can be a positive integer or the key word <TT>infinite</TT>. -The default value of this option is: -<PRE CLASS="verbatim">[{local, message, 100}, - {local, presence, 100}, - {remote, message, 20}, - {remote, presence, 20}] -</PRE></DD></DL><P>Example configuration: -</P><PRE CLASS="verbatim">% Only admins can send packets to multicast service -{access, multicast, [{allow, admin}, {deny, all}]}. - -% If you want to allow all your users: -%{access, multicast, [{allow, all}]}. - -% This allows both admins and remote users to send packets, -% but does not allow local users: -%{acl, allservers, {server_glob, "*"}}. -%{access, multicast, [{allow, admin}, {deny, local}, {allow, allservers}]}. - -{modules, [ - ... - {mod_multicast, [ - {host, "multicast.example.org"}, - {access, multicast}, - {limits, [ - {local, message, 40}, - {local, presence, infinite}, - {remote, message, 150} - ]} - ]}, - ... -]}. -</PRE><P> <A NAME="modoffline"></A> </P><!--TOC subsection <TT>mod_offline</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc50">3.3.12</A>  <A HREF="#modoffline"><TT>mod_offline</TT></A></H3><!--SEC END --><P> <A NAME="modoffline"></A> -</P><P>This module implements offline message storage (<A HREF="http://xmpp.org/extensions/xep-0160.html">XEP-0160</A>). -This means that all messages -sent to an offline user will be stored on the server until that user comes -online again. Thus it is very similar to how email works. Note that -<TT>ejabberdctl</TT> has a command to delete expired messages -(see section <A HREF="#ejabberdctl">4.1</A>).</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{access_max_user_messages, AccessName}</TT></B></DT><DD CLASS="dd-description"> -This option defines which access rule will be enforced to limit -the maximum number of offline messages that a user can have (quota). -When a user has too many offline messages, any new messages that he receive are discarded, -and a resource-constraint error is returned to the sender. -The default value is <TT>max_user_offline_messages</TT>. -Then you can define an access rule with a syntax similar to -</DD><DT CLASS="dt-description"><B><TT>{backend, mnesia|odbc}</TT></B></DT><DD CLASS="dd-description"> -Specify the backend used to store the tables: <TT>offline_msg</TT>. -The default value is <TT>mnesia</TT>. -If configured to <TT>odbc</TT>, then you must also configure in ejabberd -the database connection (see the subsections of <A HREF="#database">3.2</A>). - -<TT>max_user_sessions</TT> (see <A HREF="#configmaxsessions">3.1.5</A>). -</DD></DL><P>This example allows power users to have as much as 5000 offline messages, -administrators up to 2000, -and all the other users up to 100. -</P><PRE CLASS="verbatim">{acl, admin, {user, "admin1", "localhost"}}. -{acl, admin, {user, "admin2", "example.org"}}. -{acl, poweruser, {user, "bob", "example.org"}}. -{acl, poweruser, {user, "jane", "example.org"}}. - -{access, max_user_offline_messages, [ {5000, poweruser}, {2000, admin}, {100, all} ]}. - -{modules, - [ - ... - {mod_offline, [ {access_max_user_messages, max_user_offline_messages} ]}, - ... - ]}. -</PRE><P> <A NAME="modping"></A> </P><!--TOC subsection <TT>mod_ping</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc51">3.3.13</A>  <A HREF="#modping"><TT>mod_ping</TT></A></H3><!--SEC END --><P> <A NAME="modping"></A> -</P><P>This module implements support for XMPP Ping (<A HREF="http://xmpp.org/extensions/xep-0199.html">XEP-0199</A>) and periodic keepalives. -When this module is enabled ejabberd responds correctly to -ping requests, as defined in the protocol.</P><P>Configuration options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{send_pings, true|false}</TT></B></DT><DD CLASS="dd-description"> -If this option is set to <TT>true</TT>, the server sends pings to connected clients -that are not active in a given interval <TT>ping_interval</TT>. -This is useful to keep client connections alive or checking availability. -By default this option is disabled. -</DD><DT CLASS="dt-description"><B><TT>{ping_interval, Seconds}</TT></B></DT><DD CLASS="dd-description"> -How often to send pings to connected clients, if the previous option is enabled. -If a client connection does not send or receive any stanza in this interval, -a ping request is sent to the client. -The default value is 60 seconds. -</DD><DT CLASS="dt-description"><B><TT>{timeout_action, none|kill}</TT></B></DT><DD CLASS="dd-description"> -What to do when a client does not answer to a server ping request in less than 32 seconds. -The default is to do nothing. -</DD></DL><P>This example enables Ping responses, configures the module to send pings -to client connections that are inactive for 4 minutes, -and if a client does not answer to the ping in less than 32 seconds, its connection is closed: -</P><PRE CLASS="verbatim">{modules, - [ - ... - {mod_ping, [{send_pings, true}, {ping_interval, 240}, {timeout_action, kill}]}, - ... - ]}. -</PRE><P> <A NAME="modprivacy"></A> </P><!--TOC subsection <TT>mod_privacy</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc52">3.3.14</A>  <A HREF="#modprivacy"><TT>mod_privacy</TT></A></H3><!--SEC END --><P> <A NAME="modprivacy"></A> -</P><P>This module implements Blocking Communication (also known as Privacy Rules) -as defined in section 10 from XMPP IM. If end users have support for it in -their XMPP client, they will be able to: -</P><BLOCKQUOTE CLASS="quote"> -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Retrieving one’s privacy lists. -</LI><LI CLASS="li-itemize">Adding, removing, and editing one’s privacy lists. -</LI><LI CLASS="li-itemize">Setting, changing, or declining active lists. -</LI><LI CLASS="li-itemize">Setting, changing, or declining the default list (i.e., the list that -is active by default). -</LI><LI CLASS="li-itemize">Allowing or blocking messages based on JID, group, or subscription type -(or globally). -</LI><LI CLASS="li-itemize">Allowing or blocking inbound presence notifications based on JID, group, -or subscription type (or globally). -</LI><LI CLASS="li-itemize">Allowing or blocking outbound presence notifications based on JID, group, -or subscription type (or globally). -</LI><LI CLASS="li-itemize">Allowing or blocking IQ stanzas based on JID, group, or subscription type -(or globally). -</LI><LI CLASS="li-itemize">Allowing or blocking all communications based on JID, group, or -subscription type (or globally). -</LI></UL> -(from <A HREF="http://xmpp.org/rfcs/rfc3921.html#privacy"><TT>http://xmpp.org/rfcs/rfc3921.html#privacy</TT></A>) -</BLOCKQUOTE><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{backend, mnesia|odbc}</TT></B></DT><DD CLASS="dd-description"> -Specify the backend used to store the tables: <TT>privacy_default_list</TT>, <TT>privacy_list</TT> and <TT>privacy_list_data</TT>. -The default value is <TT>mnesia</TT>. -If configured to <TT>odbc</TT>, then you must also configure in ejabberd -the database connection (see the subsections of <A HREF="#database">3.2</A>). - -</DD><DT CLASS="dt-description"><B><TT>{iqdisc, Discipline}</TT></B></DT><DD CLASS="dd-description"> This specifies -the processing discipline for Blocking Communication (<TT>jabber:iq:privacy</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>). -</DD></DL><P> <A NAME="modprivate"></A> </P><!--TOC subsection <TT>mod_private</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc53">3.3.15</A>  <A HREF="#modprivate"><TT>mod_private</TT></A></H3><!--SEC END --><P> <A NAME="modprivate"></A> -</P><P>This module adds support for Private XML Storage (<A HREF="http://xmpp.org/extensions/xep-0049.html">XEP-0049</A>): -</P><BLOCKQUOTE CLASS="quote"> -Using this method, XMPP entities can store private data on the server and -retrieve it whenever necessary. The data stored might be anything, as long as -it is valid XML. One typical usage for this namespace is the server-side storage -of client-specific preferences; another is Bookmark Storage (<A HREF="http://xmpp.org/extensions/xep-0048.html">XEP-0048</A>). -</BLOCKQUOTE><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{backend, mnesia|odbc}</TT></B></DT><DD CLASS="dd-description"> -Specify the backend used to store the tables: <TT>private_storage</TT>. -The default value is <TT>mnesia</TT>. -If configured to <TT>odbc</TT>, then you must also configure in ejabberd -the database connection (see the subsections of <A HREF="#database">3.2</A>). - -</DD><DT CLASS="dt-description"><B><TT>{iqdisc, Discipline}</TT></B></DT><DD CLASS="dd-description"> This specifies -the processing discipline for Private XML Storage (<TT>jabber:iq:private</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>). -</DD></DL><P> <A NAME="modproxy"></A> </P><!--TOC subsection <TT>mod_proxy65</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc54">3.3.16</A>  <A HREF="#modproxy"><TT>mod_proxy65</TT></A></H3><!--SEC END --><P> <A NAME="modproxy"></A> -</P><P>This module implements SOCKS5 Bytestreams (<A HREF="http://xmpp.org/extensions/xep-0065.html">XEP-0065</A>). -It allows <TT>ejabberd</TT> to act as a file transfer proxy between two -XMPP clients.</P><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> - -<B><TT>{host, HostName}</TT></B></DT><DD CLASS="dd-description"> This option defines the Jabber ID of the -service. If the <TT>host</TT> option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘<TT>proxy.</TT>’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -</DD><DT CLASS="dt-description"><B><TT>{name, Text}</TT></B></DT><DD CLASS="dd-description">Defines Service Discovery name of the service. -Default is <TT>"SOCKS5 Bytestreams"</TT>. -</DD><DT CLASS="dt-description"><B><TT>{ip, IPTuple}</TT></B></DT><DD CLASS="dd-description">This option specifies which network interface -to listen for. Default is an IP address of the service’s DNS name, or, -if fails, <CODE>{127,0,0,1}</CODE>. -</DD><DT CLASS="dt-description"><B><TT>{port, Number}</TT></B></DT><DD CLASS="dd-description">This option defines port to listen for -incoming connections. Default is 7777. -</DD><DT CLASS="dt-description"><B><TT>{hostname, HostName}</TT></B></DT><DD CLASS="dd-description">Defines a hostname advertised -by the service when establishing a session with clients. This is useful when -you run the service behind a NAT. The default is the value of <TT>ip</TT> option. -Examples: <TT>"proxy.mydomain.org"</TT>, <TT>"200.150.100.50"</TT>. Note that -not all clients understand domain names in stream negotiation, -so you should think twice before setting domain name in this option. -</DD><DT CLASS="dt-description"><B><TT>{auth_type, anonymous|plain}</TT></B></DT><DD CLASS="dd-description">SOCKS5 authentication type. -Possible values are <TT>anonymous</TT> and <TT>plain</TT>. Default is -<TT>anonymous</TT>. -</DD><DT CLASS="dt-description"><B><TT>{access, AccessName}</TT></B></DT><DD CLASS="dd-description">Defines ACL for file transfer initiators. -Default is <TT>all</TT>. -</DD><DT CLASS="dt-description"><B><TT>{max_connections, Number}</TT></B></DT><DD CLASS="dd-description">Maximum number of -active connections per file transfer initiator. No limit by default. -</DD><DT CLASS="dt-description"><B><TT>{shaper, none|ShaperName}</TT></B></DT><DD CLASS="dd-description">This option defines shaper for -the file transfer peers. Shaper with the maximum bandwidth will be selected. -Default is <TT>none</TT>. -</DD></DL><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -The simpliest configuration of the module: -<PRE CLASS="verbatim">{modules, - [ - ... - {mod_proxy65, []}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">More complicated configuration. -<PRE CLASS="verbatim">{acl, proxy_users, {server, "example.org"}}. -{access, proxy65_access, [{allow, proxy_users}, {deny, all}]}. - -{acl, admin, {user, "admin", "example.org"}}. -{shaper, proxyrate, {maxrate, 10240}}. %% 10 Kbytes/sec -{access, proxy65_shaper, [{none, admin}, {proxyrate, proxy_users}]}. - -{modules, - [ - ... - {mod_proxy65, [{host, "proxy1.example.org"}, - {name, "File Transfer Proxy"}, - {ip, {200,150,100,1}}, - {port, 7778}, - {max_connections, 5}, - {access, proxy65_access}, - {shaper, proxy65_shaper}]}, - ... - ]}. -</PRE></LI></UL><P> <A NAME="modpubsub"></A> </P><!--TOC subsection <TT>mod_pubsub</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc55">3.3.17</A>  <A HREF="#modpubsub"><TT>mod_pubsub</TT></A></H3><!--SEC END --><P> <A NAME="modpubsub"></A> -</P><P>This module offers a Publish-Subscribe Service (<A HREF="http://xmpp.org/extensions/xep-0060.html">XEP-0060</A>). -The functionality in <TT>mod_pubsub</TT> can be extended using plugins. -The plugin that implements PEP (Personal Eventing via Pubsub) (<A HREF="http://xmpp.org/extensions/xep-0163.html">XEP-0163</A>) -is enabled in the default ejabberd configuration file, -and it requires <TT>mod_caps</TT>.</P><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> - -<B><TT>{host, HostName}</TT></B></DT><DD CLASS="dd-description"> This option defines the Jabber ID of the -service. If the <TT>host</TT> option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘<TT>pubsub.</TT>’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -If you use <TT>mod_pubsub_odbc</TT>, please ensure the prefix contains only one dot, -for example ‘<TT>pubsub.</TT>’, or ‘<TT>publish.</TT>’,. -</DD><DT CLASS="dt-description"><B><TT>{access_createnode, AccessName}</TT></B></DT><DD CLASS="dd-description"> -This option restricts which users are allowed to create pubsub nodes using -ACL and ACCESS. -By default any account in the local ejabberd server is allowed to create pubsub nodes. -</DD><DT CLASS="dt-description"><B><TT>{max_items_node, MaxItems}</TT></B></DT><DD CLASS="dd-description"> -Define the maximum number of items that can be stored in a node. -Default value is 10. -</DD><DT CLASS="dt-description"><B><TT>{plugins, [ Plugin, ...]}</TT></B></DT><DD CLASS="dd-description"> -To specify which pubsub node plugins to use. If not defined, the default -pubsub plugin is always used. -</DD><DT CLASS="dt-description"><B><TT>{nodetree, Name}</TT></B></DT><DD CLASS="dd-description"> -To specify which nodetree to use. If not defined, the default pubsub -nodetree is used. Only one nodetree can be used per host, -and is shared by all node plugins. -</DD><DT CLASS="dt-description"><B><TT>{ignore_pep_from_offline, false|true}</TT></B></DT><DD CLASS="dd-description"> -To specify whether or not we should get last published PEP items -from users in our roster which are offline when we connect. Value is true or false. -If not defined, pubsub assumes true so we only get last items of online contacts. -</DD><DT CLASS="dt-description"><B><TT>{last_item_cache, false|true}</TT></B></DT><DD CLASS="dd-description"> -To specify whether or not pubsub should cache last items. Value is true -or false. If not defined, pubsub do not cache last items. On systems with not so many nodes, -caching last items speeds up pubsub and allows to raise user connection rate. The cost is memory -usage, as every item is stored in memory. -</DD><DT CLASS="dt-description"><B><TT>{pep_mapping, [ {Key, Value}, ...]}</TT></B></DT><DD CLASS="dd-description"> -This allow to define a Key-Value list to choose defined node plugins on given PEP namespace. -The following example will use node_tune instead of node_pep for every PEP node with tune namespace: -<PRE CLASS="verbatim"> {mod_pubsub, [{pep_mapping, [{"http://jabber.org/protocol/tune", "tune"}]}]} -</PRE></DD></DL><P>Example of configuration that uses flat nodes as default, and allows use of flat, nodetree and pep nodes: -</P><PRE CLASS="verbatim">{modules, - [ - ... - {mod_pubsub, [ - {access_createnode, pubsub_createnode}, - {plugins, ["flat", "hometree", "pep"]} - ]}, - ... - ]}. -</PRE><P>Using ODBC database requires use of dedicated plugins. The following example shows previous configuration -with ODBC usage: -</P><PRE CLASS="verbatim">{modules, - [ - ... - {mod_pubsub_odbc, [ - {access_createnode, pubsub_createnode}, - {plugins, ["flat_odbc", "hometree_odbc", "pep_odbc"]} - ]}, - ... - ]}. -</PRE><P> <A NAME="modregister"></A> </P><!--TOC subsection <TT>mod_register</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc56">3.3.18</A>  <A HREF="#modregister"><TT>mod_register</TT></A></H3><!--SEC END --><P> <A NAME="modregister"></A> -</P><P>This module adds support for In-Band Registration (<A HREF="http://xmpp.org/extensions/xep-0077.html">XEP-0077</A>). This protocol -enables end users to use a XMPP client to: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -Register a new account on the server. -</LI><LI CLASS="li-itemize">Change the password from an existing account on the server. -</LI><LI CLASS="li-itemize">Delete an existing account on the server. -</LI></UL><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{access, AccessName}</TT></B></DT><DD CLASS="dd-description"> This option can be configured to specify -rules to restrict registration. If a rule returns ‘deny’ on the requested -user name, registration for that user name is denied. (there are no -restrictions by default). -</DD><DT CLASS="dt-description"><B><TT>{access_from, AccessName}</TT></B></DT><DD CLASS="dd-description"> By default, <TT>ejabberd</TT> -doesn’t allow to register new accounts from s2s or existing c2s sessions. You can -change it by defining access rule in this option. Use with care: allowing registration -from s2s leads to uncontrolled massive accounts creation by rogue users. -</DD><DT CLASS="dt-description"><B><TT>{welcome_message, Message}</TT></B></DT><DD CLASS="dd-description"> Set a welcome message that -is sent to each newly registered account. The first string is the subject, and -the second string is the message body. -In the body you can set a newline with the characters: <CODE>\n</CODE> -</DD><DT CLASS="dt-description"><B><TT>{registration_watchers, [ JID, ...]}</TT></B></DT><DD CLASS="dd-description"> This option defines a -list of JIDs which will be notified each time a new account is registered. -</DD><DT CLASS="dt-description"><B><TT>{iqdisc, Discipline}</TT></B></DT><DD CLASS="dd-description"> This specifies -the processing discipline for In-Band Registration (<TT>jabber:iq:register</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>). -</DD></DL><P>This module reads also another option defined globally for the server: -<TT>{registration_timeout, Timeout}</TT>. -This option limits the frequency of registration from a given IP or username. -So, a user that tries to register a new account from the same IP address or JID during -this number of seconds after his previous registration -will receive an error <TT>resource-constraint</TT> with the explanation: -“Users are not allowed to register accounts so quickly”. -The timeout is expressed in seconds, and it must be an integer. -To disable this limitation, -instead of an integer put a word like: <TT>infinity</TT>. -Default value: 600 seconds.</P><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -Next example prohibits the registration of too short account names: -<PRE CLASS="verbatim">{acl, shortname, {user_glob, "?"}}. -{acl, shortname, {user_glob, "??"}}. -%% The same using regexp: -%%{acl, shortname, {user_regexp, "^..?$"}}. - -{access, register, [{deny, shortname}, - {allow, all}]}. - -{modules, - [ - ... - {mod_register, [{access, register}]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">This configuration prohibits usage of In-Band Registration -to create or delete accounts, -but allows existing accounts to change the password: -<PRE CLASS="verbatim">{access, register, [{deny, all}]}. - -{modules, - [ - ... - {mod_register, [{access, register}]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">This configuration disables all In-Band Registration -functionality: create, delete accounts and change password: -<PRE CLASS="verbatim">{modules, - [ - ... - %% {mod_register, [{access, register}]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">Define the welcome message and two registration watchers. -Also define a registration timeout of one hour: -<PRE CLASS="verbatim">{registration_timeout, 3600}. -{modules, - [ - ... - {mod_register, - [ - {welcome_message, {"Welcome!", "Hi.\nWelcome to this Jabber server.\n Check http://www.jabber.org\n\nBye"}}, - {registration_watchers, ["admin1@example.org", "boss@example.net"]} - ]}, - ... - ]}. -</PRE></LI></UL><P> <A NAME="modroster"></A> </P><!--TOC subsection <TT>mod_roster</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc57">3.3.19</A>  <A HREF="#modroster"><TT>mod_roster</TT></A></H3><!--SEC END --><P> <A NAME="modroster"></A> -</P><P>This module implements roster management as defined in -<A HREF="http://xmpp.org/rfcs/rfc3921.html#roster">RFC 3921: XMPP IM</A>. -It also supports Roster Versioning (<A HREF="http://xmpp.org/extensions/xep-0237.html">XEP-0237</A>).</P><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{backend, mnesia|odbc}</TT></B></DT><DD CLASS="dd-description"> -Specify the backend used to store the tables: <TT>rosteritem</TT> and <TT>rostergroup</TT>. -The default value is <TT>mnesia</TT>. -If configured to <TT>odbc</TT>, then you must also configure in ejabberd -the database connection (see the subsections of <A HREF="#database">3.2</A>). - -</DD><DT CLASS="dt-description"><B><TT>{iqdisc, Discipline}</TT></B></DT><DD CLASS="dd-description"> This specifies -the processing discipline for Roster Management (<TT>jabber:iq:roster</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>). -</DD><DT CLASS="dt-description"><B><TT>access</TT></B></DT><DD CLASS="dd-description"> -This option can be configured to specify rules to restrict roster management. -If a rule returns ‘deny’ on the requested user name, -that user cannot modify his personal roster: -not add/remove/modify contacts, -or subscribe/unsubscribe presence. -By default there aren’t restrictions. -</DD><DT CLASS="dt-description"><B><TT>{versioning, false|true}</TT></B></DT><DD CLASS="dd-description"> Enables -Roster Versioning. -This option is disabled by default. -</DD><DT CLASS="dt-description"><B><TT>{store_current_id, false|true}</TT></B></DT><DD CLASS="dd-description"> -If this option is enabled, the current version number is stored on the database. -If disabled, the version number is calculated on the fly each time. -Enabling this option reduces the load for both ejabberd and the database. -This option does not affect the client in any way. -This option is only useful if Roster Versioning is enabled. -This option is disabled by default. -Important: if you use <TT>mod_shared_roster</TT>, you must disable this option. -</DD></DL><P>This example configuration enables Roster Versioning with storage of current id: -</P><PRE CLASS="verbatim">{modules, - [ - ... - {mod_roster, [{versioning, true}, {store_current_id, true}]}, - ... - ]}. -</PRE><P>With this example configuration only admins can manage their rosters; -everybody else cannot modify the roster: -</P><PRE CLASS="verbatim">{acl, admin, {user, "bob", "example.org"}}. -{acl, admin, {user, "sarah", "example.org"}}. - -{access, roster, [{allow, admin}, - {deny, all}]}. - -{modules, - [ - ... - {mod_roster, [{access, roster}]}, - ... - ]}. -</PRE><P> <A NAME="modservicelog"></A> </P><!--TOC subsection <TT>mod_service_log</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc58">3.3.20</A>  <A HREF="#modservicelog"><TT>mod_service_log</TT></A></H3><!--SEC END --><P> <A NAME="modservicelog"></A> -</P><P>This module adds support for logging end user packets via a XMPP message -auditing service such as -<A HREF="http://www.funkypenguin.info/project/bandersnatch/">Bandersnatch</A>. All user -packets are encapsulated in a <CODE><route/></CODE> element and sent to the specified -service(s).</P><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{loggers, [Names, ...]}</TT></B></DT><DD CLASS="dd-description"> With this option a (list of) service(s) -that will receive the packets can be specified. -</DD></DL><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -To log all end user packets to the Bandersnatch service running on -<TT>bandersnatch.example.com</TT>: -<PRE CLASS="verbatim">{modules, - [ - ... - {mod_service_log, [{loggers, ["bandersnatch.example.com"]}]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">To log all end user packets to the Bandersnatch service running on -<TT>bandersnatch.example.com</TT> and the backup service on -<TT>bandersnatch.example.org</TT>: -<PRE CLASS="verbatim">{modules, - [ - ... - {mod_service_log, [{loggers, ["bandersnatch.example.com", - "bandersnatch.example.org"]}]}, - ... - ]}. -</PRE></LI></UL><P> <A NAME="modsharedroster"></A> </P><!--TOC subsection <TT>mod_shared_roster</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc59">3.3.21</A>  <A HREF="#modsharedroster"><TT>mod_shared_roster</TT></A></H3><!--SEC END --><P> <A NAME="modsharedroster"></A> -</P><P>This module enables you to create shared roster groups. This means that you can -create groups of people that can see members from (other) groups in their -rosters. The big advantages of this feature are that end users do not need to -manually add all users to their rosters, and that they cannot permanently delete -users from the shared roster groups. -A shared roster group can have members from any XMPP server, -but the presence will only be available from and to members -of the same virtual host where the group is created.</P><P>Shared roster groups can be edited <EM>only</EM> via the Web Admin. Each group -has a unique identification and the following parameters: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B>Name</B></DT><DD CLASS="dd-description"> The name of the group, which will be displayed in the roster. -</DD><DT CLASS="dt-description"><B>Description</B></DT><DD CLASS="dd-description"> The description of the group. This parameter does not affect -anything. -</DD><DT CLASS="dt-description"><B>Members</B></DT><DD CLASS="dd-description"> A list of full JIDs of group members, entered one per line in -the Web Admin. -To put as members all the registered users in the virtual hosts, -you can use the special directive: @all@. -Note that this directive is designed for a small server with just a few hundred users. -</DD><DT CLASS="dt-description"><B>Displayed groups</B></DT><DD CLASS="dd-description"> A list of groups that will be in the rosters of this -group’s members. -</DD></DL><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -Take the case of a computer club that wants all its members seeing each -other in their rosters. To achieve this, they need to create a shared roster -group similar to next table: -<BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> -<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1><TR><TD ALIGN=left NOWRAP>Identification</TD><TD ALIGN=left NOWRAP>Group ‘<TT>club_members</TT>’</TD></TR> -<TR><TD ALIGN=left NOWRAP>Name</TD><TD ALIGN=left NOWRAP>Club Members</TD></TR> -<TR><TD ALIGN=left NOWRAP>Description</TD><TD ALIGN=left NOWRAP>Members from the computer club</TD></TR> -<TR><TD ALIGN=left NOWRAP>Members</TD><TD ALIGN=left NOWRAP> <TABLE CELLSPACING=6 CELLPADDING=0><TR><TD ALIGN=left NOWRAP> <TT>member1@example.org</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>member2@example.org</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>member3@example.org</TT></TD></TR> -</TABLE></TD></TR> -<TR><TD ALIGN=left NOWRAP>Displayed groups</TD><TD ALIGN=left NOWRAP><TT>club_members</TT></TD></TR> -</TABLE> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> -</LI><LI CLASS="li-itemize">In another case we have a company which has three divisions: Management, -Marketing and Sales. All group members should see all other members in their -rosters. Additionally, all managers should have all marketing and sales people -in their roster. Simultaneously, all marketeers and the whole sales team -should see all managers. This scenario can be achieved by creating shared -roster groups as shown in the following table: -<BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> -<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1><TR><TD ALIGN=left NOWRAP>Identification</TD><TD ALIGN=left NOWRAP> Group ‘<TT>management</TT>’</TD><TD ALIGN=left NOWRAP> Group ‘<TT>marketing</TT>’</TD><TD ALIGN=left NOWRAP> Group ‘<TT>sales</TT>’</TD></TR> -<TR><TD ALIGN=left NOWRAP>Name</TD><TD ALIGN=left NOWRAP>Management</TD><TD ALIGN=left NOWRAP>Marketing</TD><TD ALIGN=left NOWRAP>Sales</TD></TR> -<TR><TD ALIGN=left NOWRAP>Description</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP> Members</TD><TD ALIGN=left NOWRAP> <TABLE CELLSPACING=6 CELLPADDING=0><TR><TD ALIGN=left NOWRAP> <TT>manager1@example.org</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>manager2@example.org</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>manager3@example.org</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>manager4@example.org</TT></TD></TR> -</TABLE> -</TD><TD ALIGN=left NOWRAP> <TABLE CELLSPACING=6 CELLPADDING=0><TR><TD ALIGN=left NOWRAP> <TT>marketeer1@example.org</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>marketeer2@example.org</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>marketeer3@example.org</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>marketeer4@example.org</TT></TD></TR> -</TABLE> -</TD><TD ALIGN=left NOWRAP> <TABLE CELLSPACING=6 CELLPADDING=0><TR><TD ALIGN=left NOWRAP> <TT>saleswoman1@example.org</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>salesman1@example.org</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>saleswoman2@example.org</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>salesman2@example.org</TT></TD></TR> -</TABLE></TD></TR> -<TR><TD ALIGN=left NOWRAP>Displayed groups</TD><TD ALIGN=left NOWRAP> <TABLE CELLSPACING=6 CELLPADDING=0><TR><TD ALIGN=left NOWRAP> <TT>management</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>marketing</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>sales</TT></TD></TR> -</TABLE> -</TD><TD ALIGN=left NOWRAP> <TABLE CELLSPACING=6 CELLPADDING=0><TR><TD ALIGN=left NOWRAP> <TT>management</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>marketing</TT></TD></TR> -</TABLE> -</TD><TD ALIGN=left NOWRAP> <TABLE CELLSPACING=6 CELLPADDING=0><TR><TD ALIGN=left NOWRAP> <TT>management</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP> <TT>sales</TT></TD></TR> -</TABLE></TD></TR> -</TABLE> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> -</LI></UL><P> <A NAME="modsic"></A> </P><!--TOC subsection <TT>mod_sic</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc60">3.3.22</A>  <A HREF="#modsic"><TT>mod_sic</TT></A></H3><!--SEC END --><P> <A NAME="modsic"></A> -</P><P>This module adds support for Server IP Check (<A HREF="http://xmpp.org/extensions/xep-0279.html">XEP-0279</A>). This protocol -enables a client to discover its external IP address.</P><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{iqdisc, Discipline}</TT></B></DT><DD CLASS="dd-description"> This specifies -the processing discipline for <TT>urn:xmpp:sic:0</TT> IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>). -</DD></DL><P> <A NAME="modstats"></A> </P><!--TOC subsection <TT>mod_stats</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc61">3.3.23</A>  <A HREF="#modstats"><TT>mod_stats</TT></A></H3><!--SEC END --><P> <A NAME="modstats"></A> -</P><P>This module adds support for Statistics Gathering (<A HREF="http://xmpp.org/extensions/xep-0039.html">XEP-0039</A>). This protocol -allows you to retrieve next statistics from your <TT>ejabberd</TT> deployment: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -Total number of registered users on the current virtual host (users/total). -</LI><LI CLASS="li-itemize">Total number of registered users on all virtual hosts (users/all-hosts/total). -</LI><LI CLASS="li-itemize">Total number of online users on the current virtual host (users/online). -</LI><LI CLASS="li-itemize">Total number of online users on all virtual hosts (users/all-hosts/online). -</LI></UL><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{iqdisc, Discipline}</TT></B></DT><DD CLASS="dd-description"> This specifies -the processing discipline for Statistics Gathering (<TT>http://jabber.org/protocol/stats</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>). -</DD></DL><P>As there are only a small amount of clients (for example -<A HREF="http://tkabber.jabber.ru/">Tkabber</A>) and software libraries with -support for this XEP, a few examples are given of the XML you need to send -in order to get the statistics. Here they are: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -You can request the number of online users on the current virtual host -(<TT>example.org</TT>) by sending: -<PRE CLASS="verbatim"><iq to='example.org' type='get'> - <query xmlns='http://jabber.org/protocol/stats'> - <stat name='users/online'/> - </query> -</iq> -</PRE></LI><LI CLASS="li-itemize">You can request the total number of registered users on all virtual hosts -by sending: -<PRE CLASS="verbatim"><iq to='example.org' type='get'> - <query xmlns='http://jabber.org/protocol/stats'> - <stat name='users/all-hosts/total'/> - </query> -</iq> -</PRE></LI></UL><P> <A NAME="modtime"></A> </P><!--TOC subsection <TT>mod_time</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc62">3.3.24</A>  <A HREF="#modtime"><TT>mod_time</TT></A></H3><!--SEC END --><P> <A NAME="modtime"></A> -</P><P>This module features support for Entity Time (<A HREF="http://xmpp.org/extensions/xep-0202.html">XEP-0202</A>). By using this XEP, -you are able to discover the time at another entity’s location.</P><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{iqdisc, Discipline}</TT></B></DT><DD CLASS="dd-description"> This specifies -the processing discipline for Entity Time (<TT>jabber:iq:time</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>). -</DD></DL><P> <A NAME="modvcard"></A> </P><!--TOC subsection <TT>mod_vcard</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc63">3.3.25</A>  <A HREF="#modvcard"><TT>mod_vcard</TT></A></H3><!--SEC END --><P> <A NAME="modvcard"></A> -</P><P>This module allows end users to store and retrieve their vCard, and to retrieve -other users vCards, as defined in vcard-temp (<A HREF="http://xmpp.org/extensions/xep-0054.html">XEP-0054</A>). The module also -implements an uncomplicated Jabber User Directory based on the vCards of -these users. Moreover, it enables the server to send its vCard when queried.</P><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{backend, mnesia|odbc}</TT></B></DT><DD CLASS="dd-description"> -Specify the backend used to store the tables: <TT>vcard</TT>. -The default value is <TT>mnesia</TT>. -If configured to <TT>odbc</TT>, then you must also configure in ejabberd -the database connection (see the subsections of <A HREF="#database">3.2</A>). - - -</DD><DT CLASS="dt-description"><B><TT>{host, HostName}</TT></B></DT><DD CLASS="dd-description"> This option defines the Jabber ID of the -service. If the <TT>host</TT> option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘<TT>vjud.</TT>’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -</DD><DT CLASS="dt-description"><B><TT>{iqdisc, Discipline}</TT></B></DT><DD CLASS="dd-description"> This specifies -the processing discipline for <TT>vcard-temp</TT> IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>). -</DD><DT CLASS="dt-description"><B><TT>{search, true|false}</TT></B></DT><DD CLASS="dd-description">This option specifies whether the search -functionality is enabled or not -If disabled, the option <TT>host</TT> will be ignored and the -Jabber User Directory service will not appear in the Service Discovery item -list. The default value is <TT>true</TT>. -</DD><DT CLASS="dt-description"><B><TT>{matches, infinity|Number}</TT></B></DT><DD CLASS="dd-description">With this option, the number of reported -search results can be limited. If the option’s value is set to <TT>infinity</TT>, -all search results are reported. The default value is <TT>30</TT>. -</DD><DT CLASS="dt-description"><B><TT>{allow_return_all, false|true}</TT></B></DT><DD CLASS="dd-description">This option enables -you to specify if search operations with empty input fields should return all -users who added some information to their vCard. The default value is -<TT>false</TT>. -</DD><DT CLASS="dt-description"><B><TT>{search_all_hosts, true|false}</TT></B></DT><DD CLASS="dd-description">If this option is set -to <TT>true</TT>, search operations will apply to all virtual hosts. Otherwise -only the current host will be searched. The default value is <TT>true</TT>. -</DD></DL><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -In this first situation, search results are limited to twenty items, -every user who added information to their vCard will be listed when people -do an empty search, and only users from the current host will be returned: -<PRE CLASS="verbatim">{modules, - [ - ... - {mod_vcard, [{search, true}, - {matches, 20}, - {allow_return_all, true}, - {search_all_hosts, false}]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">The second situation differs in a way that search results are not limited, -and that all virtual hosts will be searched instead of only the current one: -<PRE CLASS="verbatim">{modules, - [ - ... - {mod_vcard, [{search, true}, - {matches, infinity}, - {allow_return_all, true}]}, - ... - ]}. -</PRE></LI></UL><P> <A NAME="modvcardldap"></A> </P><!--TOC subsection <TT>mod_vcard_ldap</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc64">3.3.26</A>  <A HREF="#modvcardldap"><TT>mod_vcard_ldap</TT></A></H3><!--SEC END --><P> <A NAME="modvcardldap"></A> -</P><P><TT>ejabberd</TT> can map LDAP attributes to vCard fields. This behaviour is -implemented in the <TT>mod_vcard_ldap</TT> module. This module does not depend on the -authentication method (see <A HREF="#ldapauth">3.2.5</A>).</P><P>Usually <TT>ejabberd</TT> treats LDAP as a read-only storage: -it is possible to consult data, but not possible to -create accounts or edit vCard that is stored in LDAP. -However, it is possible to change passwords if <TT>mod_register</TT> module is enabled -and LDAP server supports -<A HREF="http://tools.ietf.org/html/rfc3062">RFC 3062</A>.</P><P>The <TT>mod_vcard_ldap</TT> module has -its own optional parameters. The first group of parameters has the same -meaning as the top-level LDAP parameters to set the authentication method: -<TT>ldap_servers</TT>, <TT>ldap_port</TT>, <TT>ldap_rootdn</TT>, -<TT>ldap_password</TT>, <TT>ldap_base</TT>, <TT>ldap_uids</TT>, and -<TT>ldap_filter</TT>. See section <A HREF="#ldapauth">3.2.5</A> for detailed information -about these options. If one of these options is not set, <TT>ejabberd</TT> will look -for the top-level option with the same name.</P><P>The second group of parameters -consists of the following <TT>mod_vcard_ldap</TT>-specific options:</P><DL CLASS="description"><DT CLASS="dt-description"> - -<B><TT>{host, HostName}</TT></B></DT><DD CLASS="dd-description"> This option defines the Jabber ID of the -service. If the <TT>host</TT> option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘<TT>vjud.</TT>’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -</DD><DT CLASS="dt-description"><B><TT>{iqdisc, Discipline}</TT></B></DT><DD CLASS="dd-description"> This specifies -the processing discipline for <TT>vcard-temp</TT> IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>). -</DD><DT CLASS="dt-description"><B><TT>{search, true|false}</TT></B></DT><DD CLASS="dd-description">This option specifies whether the search -functionality is enabled (value: <TT>true</TT>) or disabled (value: -<TT>false</TT>). If disabled, the option <TT>host</TT> will be ignored and the -Jabber User Directory service will not appear in the Service Discovery item -list. The default value is <TT>true</TT>. -</DD><DT CLASS="dt-description"><B><TT>{matches, infinity|Number}</TT></B></DT><DD CLASS="dd-description">With this option, the number of reported -search results can be limited. If the option’s value is set to <TT>infinity</TT>, -all search results are reported. The default value is <TT>30</TT>. -</DD><DT CLASS="dt-description"><B><TT>{ldap_vcard_map, [ {Name, Pattern, LDAPattributes}, ...]}</TT></B></DT><DD CLASS="dd-description"> -With this option you can set the table that maps LDAP attributes to vCard fields. - -<TT>Name</TT> is the type name of the vCard as defined in -<A HREF="http://tools.ietf.org/html/rfc2426">RFC 2426</A>. -<TT>Pattern</TT> is a string which contains pattern variables -<TT>"%u"</TT>, <TT>"%d"</TT> or <TT>"%s"</TT>. -<TT>LDAPattributes</TT> is the list containing LDAP attributes. -The pattern variables -<TT>"%s"</TT> will be sequentially replaced -with the values of LDAP attributes from <TT>List_of_LDAP_attributes</TT>, -<TT>"%u"</TT> will be replaced with the user part of a JID, -and <TT>"%d"</TT> will be replaced with the domain part of a JID. -The default is: -<PRE CLASS="verbatim">[{"NICKNAME", "%u", []}, - {"FN", "%s", ["displayName"]}, - {"LAST", "%s", ["sn"]}, - {"FIRST", "%s", ["givenName"]}, - {"MIDDLE", "%s", ["initials"]}, - {"ORGNAME", "%s", ["o"]}, - {"ORGUNIT", "%s", ["ou"]}, - {"CTRY", "%s", ["c"]}, - {"LOCALITY", "%s", ["l"]}, - {"STREET", "%s", ["street"]}, - {"REGION", "%s", ["st"]}, - {"PCODE", "%s", ["postalCode"]}, - {"TITLE", "%s", ["title"]}, - {"URL", "%s", ["labeleduri"]}, - {"DESC", "%s", ["description"]}, - {"TEL", "%s", ["telephoneNumber"]}, - {"EMAIL", "%s", ["mail"]}, - {"BDAY", "%s", ["birthDay"]}, - {"ROLE", "%s", ["employeeType"]}, - {"PHOTO", "%s", ["jpegPhoto"]}] -</PRE></DD><DT CLASS="dt-description"><B><TT>{ldap_search_fields, [ {Name, Attribute}, ...]}</TT></B></DT><DD CLASS="dd-description">This option -defines the search form and the LDAP attributes to search within. -<TT>Name</TT> is the name of a search form -field which will be automatically translated by using the translation -files (see <TT>msgs/*.msg</TT> for available words). <TT>Attribute</TT> is the -LDAP attribute or the pattern <TT>"%u"</TT>. The default is: -<PRE CLASS="verbatim">[{"User", "%u"}, - {"Full Name", "displayName"}, - {"Given Name", "givenName"}, - {"Middle Name", "initials"}, - {"Family Name", "sn"}, - {"Nickname", "%u"}, - {"Birthday", "birthDay"}, - {"Country", "c"}, - {"City", "l"}, - {"Email", "mail"}, - {"Organization Name", "o"}, - {"Organization Unit", "ou"}] -</PRE></DD><DT CLASS="dt-description"><B><TT>{ldap_search_reported, [ {SearchField, VcardField}, ...]}</TT></B></DT><DD CLASS="dd-description">This option -defines which search fields should be reported. -<TT>SearchField</TT> is the name of a search form -field which will be automatically translated by using the translation -files (see <TT>msgs/*.msg</TT> for available words). <TT>VcardField</TT> is the -vCard field name defined in the <TT>ldap_vcard_map</TT> option. The default -is: -<PRE CLASS="verbatim">[{"Full Name", "FN"}, - {"Given Name", "FIRST"}, - {"Middle Name", "MIDDLE"}, - {"Family Name", "LAST"}, - {"Nickname", "NICKNAME"}, - {"Birthday", "BDAY"}, - {"Country", "CTRY"}, - {"City", "LOCALITY"}, - {"Email", "EMAIL"}, - {"Organization Name", "ORGNAME"}, - {"Organization Unit", "ORGUNIT"}] -</PRE></DD></DL><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -<P>Let’s say <TT>ldap.example.org</TT> is the name of our LDAP server. We have -users with their passwords in <TT>"ou=Users,dc=example,dc=org"</TT> directory. -Also we have addressbook, which contains users emails and their additional -infos in <TT>"ou=AddressBook,dc=example,dc=org"</TT> directory. Corresponding -authentication section should looks like this:</P><PRE CLASS="verbatim">%% authentication method -{auth_method, ldap}. -%% DNS name of our LDAP server -{ldap_servers, ["ldap.example.org"]}. -%% We want to authorize users from 'shadowAccount' object class only -{ldap_filter, "(objectClass=shadowAccount)"}. -</PRE><P>Now we want to use users LDAP-info as their vCards. We have four attributes -defined in our LDAP schema: <TT>"mail"</TT> — email address, <TT>"givenName"</TT> -— first name, <TT>"sn"</TT> — second name, <TT>"birthDay"</TT> — birthday. -Also we want users to search each other. Let’s see how we can set it up:</P><PRE CLASS="verbatim">{modules, - ... - {mod_vcard_ldap, - [ - %% We use the same server and port, but want to bind anonymously because - %% our LDAP server accepts anonymous requests to - %% "ou=AddressBook,dc=example,dc=org" subtree. - {ldap_rootdn, ""}, - {ldap_password, ""}, - %% define the addressbook's base - {ldap_base, "ou=AddressBook,dc=example,dc=org"}, - %% uidattr: user's part of JID is located in the "mail" attribute - %% uidattr_format: common format for our emails - {ldap_uids, [{"mail","%u@mail.example.org"}]}, - %% We have to define empty filter here, because entries in addressbook does not - %% belong to shadowAccount object class - {ldap_filter, ""}, - %% Now we want to define vCard pattern - {ldap_vcard_map, - [{"NICKNAME", "%u", []}, % just use user's part of JID as his nickname - {"FIRST", "%s", ["givenName"]}, - {"LAST", "%s", ["sn"]}, - {"FN", "%s, %s", ["sn", "givenName"]}, % example: "Smith, John" - {"EMAIL", "%s", ["mail"]}, - {"BDAY", "%s", ["birthDay"]}]}, - %% Search form - {ldap_search_fields, - [{"User", "%u"}, - {"Name", "givenName"}, - {"Family Name", "sn"}, - {"Email", "mail"}, - {"Birthday", "birthDay"}]}, - %% vCard fields to be reported - %% Note that JID is always returned with search results - {ldap_search_reported, - [{"Full Name", "FN"}, - {"Nickname", "NICKNAME"}, - {"Birthday", "BDAY"}]} - ]} - ... -}. -</PRE><P>Note that <TT>mod_vcard_ldap</TT> module checks an existence of the user before -searching his info in LDAP.</P></LI><LI CLASS="li-itemize"><TT>ldap_vcard_map</TT> example: -<PRE CLASS="verbatim">{ldap_vcard_map, - [{"NICKNAME", "%u", []}, - {"FN", "%s", ["displayName"]}, - {"CTRY", "Russia", []}, - {"EMAIL", "%u@%d", []}, - {"DESC", "%s\n%s", ["title", "description"]} - ]}, -</PRE></LI><LI CLASS="li-itemize"><TT>ldap_search_fields</TT> example: -<PRE CLASS="verbatim">{ldap_search_fields, - [{"User", "uid"}, - {"Full Name", "displayName"}, - {"Email", "mail"} - ]}, -</PRE></LI><LI CLASS="li-itemize"><TT>ldap_search_reported</TT> example: -<PRE CLASS="verbatim">{ldap_search_reported, - [{"Full Name", "FN"}, - {"Email", "EMAIL"}, - {"Birthday", "BDAY"}, - {"Nickname", "NICKNAME"} - ]}, -</PRE></LI></UL><P> <A NAME="modvcardxupdate"></A> </P><!--TOC subsection <TT>mod_vcard_xupdate</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc65">3.3.27</A>  <A HREF="#modvcardxupdate"><TT>mod_vcard_xupdate</TT></A></H3><!--SEC END --><P> <A NAME="modvcardxupdate"></A> -</P><P>The user’s client can store an avatar in the user vCard. -The vCard-Based Avatars protocol (<A HREF="http://xmpp.org/extensions/xep-0153.html">XEP-0153</A>) -provides a method for clients to inform the contacts what is the avatar hash value. -However, simple or small clients may not implement that protocol.</P><P>If this module is enabled, all the outgoing client presence stanzas get automatically -the avatar hash on behalf of the client. -So, the contacts receive the presence stanzas with the Update Data described -in <A HREF="http://xmpp.org/extensions/xep-0153.html">XEP-0153</A> as if the client would had inserted it itself. -If the client had already included such element in the presence stanza, -it is replaced with the element generated by ejabberd.</P><P>By enabling this module, each vCard modification produces a hash recalculation, -and each presence sent by a client produces hash retrieval and a -presence stanza rewrite. -For this reason, enabling this module will introduce a computational overhead -in servers with clients that change frequently their presence.</P><P> <A NAME="modversion"></A> </P><!--TOC subsection <TT>mod_version</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc66">3.3.28</A>  <A HREF="#modversion"><TT>mod_version</TT></A></H3><!--SEC END --><P> <A NAME="modversion"></A> -</P><P>This module implements Software Version (<A HREF="http://xmpp.org/extensions/xep-0092.html">XEP-0092</A>). Consequently, it -answers <TT>ejabberd</TT>’s version when queried.</P><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>{show_os, true|false}</TT></B></DT><DD CLASS="dd-description">Should the operating system be revealed or not. -The default value is <TT>true</TT>. -</DD><DT CLASS="dt-description"><B><TT>{iqdisc, Discipline}</TT></B></DT><DD CLASS="dd-description"> This specifies -the processing discipline for Software Version (<TT>jabber:iq:version</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>). -</DD></DL><P> <A NAME="manage"></A> </P><!--TOC chapter Managing an <TT>ejabberd</TT> Server--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc67">Chapter 4</A>  <A HREF="#manage">Managing an <TT>ejabberd</TT> Server</A></H1><!--SEC END --><P> <A NAME="manage"></A> </P><P> <A NAME="ejabberdctl"></A> </P><!--TOC section <TT>ejabberdctl</TT>--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc68">4.1</A>  <A HREF="#ejabberdctl"><TT>ejabberdctl</TT></A></H2><!--SEC END --><P> <A NAME="ejabberdctl"></A> </P><P>With the <TT>ejabberdctl</TT> command line administration script -you can execute <TT>ejabberdctl commands</TT> (described in the next section, <A HREF="#ectl-commands">4.1.1</A>) -and also many general <TT>ejabberd commands</TT> (described in section <A HREF="#eja-commands">4.2</A>). -This means you can start, stop and perform many other administrative tasks -in a local or remote <TT>ejabberd</TT> server (by providing the argument <TT>--node NODENAME</TT>).</P><P>The <TT>ejabberdctl</TT> script can be configured in the file <TT>ejabberdctl.cfg</TT>. -This file includes detailed information about each configurable option. See section <A HREF="#erlangconfiguration">4.1.2</A>.</P><P>The <TT>ejabberdctl</TT> script returns a numerical status code. -Success is represented by <TT>0</TT>, -error is represented by <TT>1</TT>, -and other codes may be used for specific results. -This can be used by other scripts to determine automatically -if a command succeeded or failed, -for example using: <TT>echo $?</TT></P><P> <A NAME="ectl-commands"></A> </P><!--TOC subsection ejabberdctl Commands--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc69">4.1.1</A>  <A HREF="#ectl-commands">ejabberdctl Commands</A></H3><!--SEC END --><P> <A NAME="ectl-commands"></A> </P><P>When <TT>ejabberdctl</TT> is executed without any parameter, -it displays the available options. If there isn’t an <TT>ejabberd</TT> server running, -the available parameters are: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>start</TT></B></DT><DD CLASS="dd-description"> Start <TT>ejabberd</TT> in background mode. This is the default method. -</DD><DT CLASS="dt-description"><B><TT>debug</TT></B></DT><DD CLASS="dd-description"> Attach an Erlang shell to an already existing <TT>ejabberd</TT> server. This allows to execute commands interactively in the <TT>ejabberd</TT> server. -</DD><DT CLASS="dt-description"><B><TT>live</TT></B></DT><DD CLASS="dd-description"> Start <TT>ejabberd</TT> in live mode: the shell keeps attached to the started server, showing log messages and allowing to execute interactive commands. -</DD></DL><P>If there is an <TT>ejabberd</TT> server running in the system, -<TT>ejabberdctl</TT> shows the <TT>ejabberdctl commands</TT> described bellow -and all the <TT>ejabberd commands</TT> available in that server (see <A HREF="#list-eja-commands">4.2.1</A>).</P><P>The <TT>ejabberdctl commands</TT> are: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>help</TT></B></DT><DD CLASS="dd-description"> Get help about ejabberdctl or any available command. Try <TT>ejabberdctl help help</TT>. -</DD><DT CLASS="dt-description"><B><TT>status</TT></B></DT><DD CLASS="dd-description"> Check the status of the <TT>ejabberd</TT> server. -</DD><DT CLASS="dt-description"><B><TT>stop</TT></B></DT><DD CLASS="dd-description"> Stop the <TT>ejabberd</TT> server. -</DD><DT CLASS="dt-description"><B><TT>restart</TT></B></DT><DD CLASS="dd-description"> Restart the <TT>ejabberd</TT> server. -</DD><DT CLASS="dt-description"><B><TT>mnesia</TT></B></DT><DD CLASS="dd-description"> Get information about the Mnesia database. -</DD></DL><P>The <TT>ejabberdctl</TT> script can be restricted to require authentication -and execute some <TT>ejabberd commands</TT>; see <A HREF="#accesscommands">4.2.2</A>. -Add the option to the file <TT>ejabberd.cfg</TT>. -In this example there is no restriction: -</P><PRE CLASS="verbatim">{ejabberdctl_access_commands, []}. -</PRE><P>If account <TT>robot1@example.org</TT> is registered in <TT>ejabberd</TT> with password <TT>abcdef</TT> -(which MD5 is E8B501798950FC58AAD83C8C14978E), -and <TT>ejabberd.cfg</TT> contains this setting: -</P><PRE CLASS="verbatim">{hosts, ["example.org"]}. -{acl, bots, {user, "robot1", "example.org"}}. -{access, ctlaccess, [{allow, bots}]}. -{ejabberdctl_access_commands, [ {ctlaccess, [registered_users, register], []} ]}. -</PRE><P>then you can do this in the shell: -</P><PRE CLASS="verbatim">$ ejabberdctl registered_users example.org -Error: no_auth_provided -$ ejabberdctl --auth robot1 example.org E8B501798950FC58AAD83C8C14978E registered_users example.org -robot1 -testuser1 -testuser2 -</PRE><P> <A NAME="erlangconfiguration"></A> </P><!--TOC subsection Erlang Runtime System--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc70">4.1.2</A>  <A HREF="#erlangconfiguration">Erlang Runtime System</A></H3><!--SEC END --><P> <A NAME="erlangconfiguration"></A> </P><P><TT>ejabberd</TT> is an Erlang/OTP application that runs inside an Erlang runtime system. -This system is configured using environment variables and command line parameters. -The <TT>ejabberdctl</TT> administration script uses many of those possibilities. -You can configure some of them with the file <TT>ejabberdctl.cfg</TT>, -which includes detailed description about them. -This section describes for reference purposes -all the environment variables and command line parameters.</P><P>The environment variables: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>EJABBERD_CONFIG_PATH</TT></B></DT><DD CLASS="dd-description"> - Path to the ejabberd configuration file. -</DD><DT CLASS="dt-description"><B><TT>EJABBERD_MSGS_PATH</TT></B></DT><DD CLASS="dd-description"> - Path to the directory with translated strings. -</DD><DT CLASS="dt-description"><B><TT>EJABBERD_LOG_PATH</TT></B></DT><DD CLASS="dd-description"> - Path to the ejabberd service log file. -</DD><DT CLASS="dt-description"><B><TT>EJABBERD_SO_PATH</TT></B></DT><DD CLASS="dd-description"> - Path to the directory with binary system libraries. -</DD><DT CLASS="dt-description"><B><TT>EJABBERD_DOC_PATH</TT></B></DT><DD CLASS="dd-description"> - Path to the directory with ejabberd documentation. -</DD><DT CLASS="dt-description"><B><TT>EJABBERD_PID_PATH</TT></B></DT><DD CLASS="dd-description"> - Path to the PID file that ejabberd can create when started. -</DD><DT CLASS="dt-description"><B><TT>HOME</TT></B></DT><DD CLASS="dd-description"> - Path to the directory that is considered <TT>ejabberd</TT>’s home. - This path is used to read the file <TT>.erlang.cookie</TT>. -</DD><DT CLASS="dt-description"><B><TT>ERL_CRASH_DUMP</TT></B></DT><DD CLASS="dd-description"> - Path to the file where crash reports will be dumped. -</DD><DT CLASS="dt-description"><B><TT>ERL_INETRC</TT></B></DT><DD CLASS="dd-description"> - Indicates which IP name resolution to use. - If using <TT>-sname</TT>, specify either this option or <TT>-kernel inetrc filepath</TT>. -</DD><DT CLASS="dt-description"><B><TT>ERL_MAX_PORTS</TT></B></DT><DD CLASS="dd-description"> - Maximum number of simultaneously open Erlang ports. -</DD><DT CLASS="dt-description"><B><TT>ERL_MAX_ETS_TABLES</TT></B></DT><DD CLASS="dd-description"> - Maximum number of ETS and Mnesia tables. -</DD></DL><P>The command line parameters: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>-sname ejabberd</TT></B></DT><DD CLASS="dd-description"> - The Erlang node will be identified using only the first part - of the host name, i. e. other Erlang nodes outside this domain cannot contact - this node. This is the preferable option in most cases. -</DD><DT CLASS="dt-description"><B><TT>-name ejabberd</TT></B></DT><DD CLASS="dd-description"> - The Erlang node will be fully identified. -This is only useful if you plan to setup an <TT>ejabberd</TT> cluster with nodes in different networks. -</DD><DT CLASS="dt-description"><B><TT>-kernel inetrc ’"/etc/ejabberd/inetrc"’</TT></B></DT><DD CLASS="dd-description"> - Indicates which IP name resolution to use. - If using <TT>-sname</TT>, specify either this option or <TT>ERL_INETRC</TT>. -</DD><DT CLASS="dt-description"><B><TT>-kernel inet_dist_listen_min 4200 inet_dist_listen_min 4210</TT></B></DT><DD CLASS="dd-description"> - Define the first and last ports that <TT>epmd</TT> (section <A HREF="#epmd">5.2</A>) can listen to. -</DD><DT CLASS="dt-description"><B><TT>-detached</TT></B></DT><DD CLASS="dd-description"> -Starts the Erlang system detached from the system console. - Useful for running daemons and backgrounds processes. -</DD><DT CLASS="dt-description"><B><TT>-noinput</TT></B></DT><DD CLASS="dd-description"> - Ensures that the Erlang system never tries to read any input. - Useful for running daemons and backgrounds processes. -</DD><DT CLASS="dt-description"><B><TT>-pa /var/lib/ejabberd/ebin</TT></B></DT><DD CLASS="dd-description"> - Specify the directory where Erlang binary files (*.beam) are located. -</DD><DT CLASS="dt-description"><B><TT>-s ejabberd</TT></B></DT><DD CLASS="dd-description"> - Tell Erlang runtime system to start the <TT>ejabberd</TT> application. -</DD><DT CLASS="dt-description"><B><TT>-mnesia dir ’"/var/lib/ejabberd/"’</TT></B></DT><DD CLASS="dd-description"> - Specify the Mnesia database directory. -</DD><DT CLASS="dt-description"><B><TT>-sasl sasl_error_logger {file, "/var/log/ejabberd/erlang.log"}</TT></B></DT><DD CLASS="dd-description"> - Path to the Erlang/OTP system log file. -SASL here means “System Architecture Support Libraries” -not “Simple Authentication and Security Layer”. -</DD><DT CLASS="dt-description"><B><TT>+K [true|false]</TT></B></DT><DD CLASS="dd-description"> - Kernel polling. -</DD><DT CLASS="dt-description"><B><TT>-smp [auto|enable|disable]</TT></B></DT><DD CLASS="dd-description"> - SMP support. -</DD><DT CLASS="dt-description"><B><TT>+P 250000</TT></B></DT><DD CLASS="dd-description"> - Maximum number of Erlang processes. -</DD><DT CLASS="dt-description"><B><TT>-remsh ejabberd@localhost</TT></B></DT><DD CLASS="dd-description"> - Open an Erlang shell in a remote Erlang node. -</DD><DT CLASS="dt-description"><B><TT>-hidden</TT></B></DT><DD CLASS="dd-description"> - The connections to other nodes are hidden (not published). - The result is that this node is not considered part of the cluster. - This is important when starting a temporary <TT>ctl</TT> or <TT>debug</TT> node. -</DD></DL><P> -Note that some characters need to be escaped when used in shell scripts, for instance <CODE>"</CODE> and <CODE>{}</CODE>. -You can find other options in the Erlang manual page (<TT>erl -man erl</TT>).</P><P> <A NAME="eja-commands"></A> </P><!--TOC section <TT>ejabberd</TT> Commands--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc71">4.2</A>  <A HREF="#eja-commands"><TT>ejabberd</TT> Commands</A></H2><!--SEC END --><P> <A NAME="eja-commands"></A> </P><P>An <TT>ejabberd command</TT> is an abstract function identified by a name, -with a defined number and type of calling arguments and type of result -that is registered in the <TT>ejabberd_commands</TT> service. -Those commands can be defined in any Erlang module and executed using any valid frontend.</P><P><TT>ejabberd</TT> includes a frontend to execute <TT>ejabberd commands</TT>: the script <TT>ejabberdctl</TT>. -Other known frontends that can be installed to execute ejabberd commands in different ways are: -<TT>ejabberd_xmlrpc</TT> (XML-RPC service), -<TT>mod_rest</TT> (HTTP POST service), -<TT>mod_shcommands</TT> (ejabberd WebAdmin page).</P><P> <A NAME="list-eja-commands"></A> </P><!--TOC subsection List of ejabberd Commands--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc72">4.2.1</A>  <A HREF="#list-eja-commands">List of ejabberd Commands</A></H3><!--SEC END --><P> <A NAME="list-eja-commands"></A> </P><P><TT>ejabberd</TT> includes a few ejabberd Commands by default. -When more modules are installed, new commands may be available in the frontends.</P><P>The easiest way to get a list of the available commands, and get help for them is to use -the ejabberdctl script: -</P><PRE CLASS="verbatim">$ ejabberdctl help -Usage: ejabberdctl [--node nodename] [--auth user host password] command [options] - -Available commands in this ejabberd node: - backup file Store the database to backup file - connected_users List all established sessions - connected_users_number Get the number of established sessions - ... -</PRE><P>The most interesting ones are: -</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>reopen_log</TT></B></DT><DD CLASS="dd-description"> Reopen the log files after they were renamed. -If the old files were not renamed before calling this command, -they are automatically renamed to <TT>"*-old.log"</TT>. See section <A HREF="#logfiles">7.1</A>. -</DD><DT CLASS="dt-description"><B><TT>backup ejabberd.backup</TT></B></DT><DD CLASS="dd-description"> -Store internal Mnesia database to a binary backup file. -</DD><DT CLASS="dt-description"><B><TT>restore ejabberd.backup</TT></B></DT><DD CLASS="dd-description"> -Restore immediately from a binary backup file the internal Mnesia database. -This will consume a lot of memory if you have a large database, -so better use <TT>install_fallback</TT>. -</DD><DT CLASS="dt-description"><B><TT>install_fallback ejabberd.backup</TT></B></DT><DD CLASS="dd-description"> -The binary backup file is installed as fallback: -it will be used to restore the database at the next ejabberd start. -This means that, after running this command, you have to restart ejabberd. -This command requires less memory than <TT>restore</TT>. -</DD><DT CLASS="dt-description"><B><TT>dump ejabberd.dump</TT></B></DT><DD CLASS="dd-description"> -Dump internal Mnesia database to a text file dump. -</DD><DT CLASS="dt-description"><B><TT>load ejabberd.dump</TT></B></DT><DD CLASS="dd-description"> -Restore immediately from a text file dump. -This is not recommended for big databases, as it will consume much time, -memory and processor. In that case it’s preferable to use <TT>backup</TT> and <TT>install_fallback</TT>. -</DD><DT CLASS="dt-description"><B><TT>import_piefxis, export_piefxis, export_piefxis_host</TT></B></DT><DD CLASS="dd-description"> -These options can be used to migrate accounts -using <A HREF="http://xmpp.org/extensions/xep-0227.html">XEP-0227</A> formatted XML files -from/to other Jabber/XMPP servers -or move users of a vhost to another ejabberd installation. -See also <A HREF="https://support.process-one.net/doc/display/MESSENGER/ejabberd+migration+kit">ejabberd migration kit</A>. -</DD><DT CLASS="dt-description"><B><TT>import_file, import_dir</TT></B></DT><DD CLASS="dd-description"> -These options can be used to migrate accounts -using jabberd1.4 formatted XML files. -from other Jabber/XMPP servers -There exist tutorials to -<A HREF="http://www.ejabberd.im/migrate-to-ejabberd">migrate from other software to ejabberd</A>. -</DD><DT CLASS="dt-description"><B><TT>delete_expired_messages</TT></B></DT><DD CLASS="dd-description"> This option can be used to delete old messages -in offline storage. This might be useful when the number of offline messages -is very high. -</DD><DT CLASS="dt-description"><B><TT>delete_old_messages days</TT></B></DT><DD CLASS="dd-description"> Delete offline messages older than the given days. -</DD><DT CLASS="dt-description"><B><TT>register user host password</TT></B></DT><DD CLASS="dd-description"> Register an account in that domain with the given password. -</DD><DT CLASS="dt-description"><B><TT>unregister user host</TT></B></DT><DD CLASS="dd-description"> Unregister the given account. -</DD></DL><P> <A NAME="accesscommands"></A> </P><!--TOC subsection Restrict Execution with AccessCommands--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc73">4.2.2</A>  <A HREF="#accesscommands">Restrict Execution with AccessCommands</A></H3><!--SEC END --><P> <A NAME="accesscommands"></A> </P><P>The frontends can be configured to restrict access to certain commands. -In that case, authentication information must be provided. -In each frontend the <TT>AccessCommands</TT> option is defined -in a different place. But in all cases the option syntax is the same: -</P><PRE CLASS="verbatim">AccessCommands = [ {Access, CommandNames, Arguments}, ...] -Access = atom() -CommandNames = all | [CommandName] -CommandName = atom() -Arguments = [ {ArgumentName, ArgumentValue}, ...] -ArgumentName = atom() -ArgumentValue = any() -</PRE><P>The default value is to not define any restriction: <TT>[]</TT>. -The authentication information is provided when executing a command, -and is Username, Hostname and Password of a local XMPP account -that has permission to execute the corresponding command. -This means that the account must be registered in the local ejabberd, -because the information will be verified. -It is possible to provide the plaintext password or its MD5 sum.</P><P>When one or several access restrictions are defined and the -authentication information is provided, -each restriction is verified until one matches completely: -the account matches the Access rule, -the command name is listed in CommandNames, -and the provided arguments do not contradict Arguments.</P><P>As an example to understand the syntax, let’s suppose those options: -</P><PRE CLASS="verbatim">{hosts, ["example.org"]}. -{acl, bots, {user, "robot1", "example.org"}}. -{access, commaccess, [{allow, bots}]}. -</PRE><P>This list of access restrictions allows only <TT>robot1@example.org</TT> to execute all commands: -</P><PRE CLASS="verbatim">[{commaccess, all, []}] -</PRE><P>See another list of restrictions (the corresponding ACL and ACCESS are not shown): -</P><PRE CLASS="verbatim">[ - %% This bot can execute all commands: - {bot, all, []}, - %% This bot can only execute the command 'dump'. No argument restriction: - {bot_backups, [dump], []} - %% This bot can execute all commands, - %% but if a 'host' argument is provided, it must be "example.org": - {bot_all_example, all, [{host, "example.org"}]}, - %% This bot can only execute the command 'register', - %% and if argument 'host' is provided, it must be "example.org": - {bot_reg_example, [register], [{host, "example.org"}]}, - %% This bot can execute the commands 'register' and 'unregister', - %% if argument host is provided, it must be "test.org": - {_bot_reg_test, [register, unregister], [{host, "test.org"}]} -] -</PRE><P> <A NAME="webadmin"></A> </P><!--TOC section Web Admin--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc74">4.3</A>  <A HREF="#webadmin">Web Admin</A></H2><!--SEC END --><P> <A NAME="webadmin"></A> -</P><P>The <TT>ejabberd</TT> Web Admin allows to administer most of <TT>ejabberd</TT> using a web browser.</P><P>This feature is enabled by default: -a <TT>ejabberd_http</TT> listener with the option <TT>web_admin</TT> (see -section <A HREF="#listened">3.1.3</A>) is included in the listening ports. Then you can open -<CODE>http://server:port/admin/</CODE> in your favourite web browser. You -will be asked to enter the username (the <EM>full</EM> Jabber ID) and password -of an <TT>ejabberd</TT> user with administrator rights. After authentication -you will see a page similar to figure <A HREF="#fig:webadmmain">4.1</A>.</P><BLOCKQUOTE CLASS="figure"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> - -<IMG SRC="webadmmain.png" ALT="webadmmain.png"> - - -<DIV CLASS="caption"><TABLE CELLSPACING=6 CELLPADDING=0><TR><TD VALIGN=top ALIGN=left>Figure 4.1: Top page from the Web Admin</TD></TR> -</TABLE></DIV> -<A NAME="fig:webadmmain"></A> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><P> -Here you can edit access restrictions, manage users, create backups, -manage the database, enable/disable ports listened for, view server -statistics,…</P><P>The access rule <TT>configure</TT> determines what accounts can access the Web Admin and modify it. -The access rule <TT>webadmin_view</TT> is to grant only view access: those accounts can browse the Web Admin with read-only access.</P><P>Example configurations: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -You can serve the Web Admin on the same port as the -HTTP Polling interface. In this example -you should point your web browser to <CODE>http://example.org:5280/admin/</CODE> to -administer all virtual hosts or to -<CODE>http://example.org:5280/admin/server/example.com/</CODE> to administer only -the virtual host <TT>example.com</TT>. Before you get access to the Web Admin -you need to enter as username, the JID and password from a registered user -that is allowed to configure <TT>ejabberd</TT>. In this example you can enter as -username ‘<TT>admin@example.net</TT>’ to administer all virtual hosts (first -URL). If you log in with ‘<TT>admin@example.com</TT>’ on<BR> - <CODE>http://example.org:5280/admin/server/example.com/</CODE> you can only -administer the virtual host <TT>example.com</TT>. -The account ‘<TT>reviewer@example.com</TT>’ can browse that vhost in read-only mode. -<PRE CLASS="verbatim">{acl, admins, {user, "admin", "example.net"}}. -{host_config, "example.com", [{acl, admins, {user, "admin", "example.com"}}]}. -{host_config, "example.com", [{acl, viewers, {user, "reviewer", "example.com"}}]}. - -{access, configure, [{allow, admins}]}. -{access, webadmin_view, [{allow, viewers}]}. - -{hosts, ["example.org"]}. - -{listen, - [ - ... - {5280, ejabberd_http, [http_poll, web_admin]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">For security reasons, you can serve the Web Admin on a secured -connection, on a port differing from the HTTP Polling interface, and bind it -to the internal LAN IP. The Web Admin will be accessible by pointing your -web browser to <CODE>https://192.168.1.1:5282/admin/</CODE>: -<PRE CLASS="verbatim"> -{hosts, ["example.org"]}. - -{listen, - [ - ... - {5280, ejabberd_http, [ - http_poll - ]}, - {{5282, "192.168.1.1"}, ejabberd_http, [ - web_admin, - tls, {certfile, "/usr/local/etc/server.pem"} - ]}, - ... - ]}. -</PRE></LI></UL><P>Certain pages in the ejabberd Web Admin contain a link to a related -section in the ejabberd Installation and Operation Guide. -In order to view such links, a copy in HTML format of the Guide must -be installed in the system. -The file is searched by default in -<TT>"/share/doc/ejabberd/guide.html"</TT>. -The directory of the documentation can be specified in -the environment variable <TT>EJABBERD_DOC_PATH</TT>. -See section <A HREF="#erlangconfiguration">4.1.2</A>.</P><P> <A NAME="adhoccommands"></A> </P><!--TOC section Ad-hoc Commands--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc75">4.4</A>  <A HREF="#adhoccommands">Ad-hoc Commands</A></H2><!--SEC END --><P> <A NAME="adhoccommands"></A> </P><P>If you enable <TT>mod_configure</TT> and <TT>mod_adhoc</TT>, -you can perform several administrative tasks in <TT>ejabberd</TT> -with a XMPP client. -The client must support Ad-Hoc Commands (<A HREF="http://xmpp.org/extensions/xep-0050.html">XEP-0050</A>), -and you must login in the XMPP server with -an account with proper privileges.</P><P> <A NAME="changeerlangnodename"></A> </P><!--TOC section Change Computer Hostname--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc76">4.5</A>  <A HREF="#changeerlangnodename">Change Computer Hostname</A></H2><!--SEC END --><P> <A NAME="changeerlangnodename"></A> </P><P><TT>ejabberd</TT> uses the distributed Mnesia database. -Being distributed, Mnesia enforces consistency of its file, -so it stores the name of the Erlang node in it (see section <A HREF="#nodename">5.4</A>). -The name of an Erlang node includes the hostname of the computer. -So, the name of the Erlang node changes -if you change the name of the machine in which <TT>ejabberd</TT> runs, -or when you move <TT>ejabberd</TT> to a different machine.</P><P>You have two ways to use the old Mnesia database in an ejabberd with new node name: -put the old node name in <TT>ejabberdctl.cfg</TT>, -or convert the database to the new node name.</P><P>Those example steps will backup, convert and load the Mnesia database. -You need to have either the old Mnesia spool dir or a backup of Mnesia. -If you already have a backup file of the old database, you can go directly to step 5. -You also need to know the old node name and the new node name. -If you don’t know them, look for them by executing <TT>ejabberdctl</TT> -or in the ejabberd log files.</P><P>Before starting, setup some variables: -</P><PRE CLASS="verbatim">OLDNODE=ejabberd@oldmachine -NEWNODE=ejabberd@newmachine -OLDFILE=/tmp/old.backup -NEWFILE=/tmp/new.backup -</PRE><OL CLASS="enumerate" type=1><LI CLASS="li-enumerate"> -Start ejabberd enforcing the old node name: -<PRE CLASS="verbatim">ejabberdctl --node $OLDNODE start -</PRE></LI><LI CLASS="li-enumerate">Generate a backup file: -<PRE CLASS="verbatim">ejabberdctl --node $OLDNODE backup $OLDFILE -</PRE></LI><LI CLASS="li-enumerate">Stop the old node: -<PRE CLASS="verbatim">ejabberdctl --node $OLDNODE stop -</PRE></LI><LI CLASS="li-enumerate">Make sure there aren’t files in the Mnesia spool dir. For example: -<PRE CLASS="verbatim">mkdir /var/lib/ejabberd/oldfiles -mv /var/lib/ejabberd/*.* /var/lib/ejabberd/oldfiles/ -</PRE></LI><LI CLASS="li-enumerate">Start ejabberd. There isn’t any need to specify the node name anymore: -<PRE CLASS="verbatim">ejabberdctl start -</PRE></LI><LI CLASS="li-enumerate">Convert the backup to new node name: -<PRE CLASS="verbatim">ejabberdctl mnesia_change_nodename $OLDNODE $NEWNODE $OLDFILE $NEWFILE -</PRE></LI><LI CLASS="li-enumerate">Install the backup file as a fallback: -<PRE CLASS="verbatim">ejabberdctl install_fallback $NEWFILE -</PRE></LI><LI CLASS="li-enumerate">Stop ejabberd: -<PRE CLASS="verbatim">ejabberdctl stop -</PRE>You may see an error message in the log files, it’s normal, so don’t worry: -<PRE CLASS="verbatim">Mnesia(ejabberd@newmachine): -** ERROR ** (ignoring core) -** FATAL ** A fallback is installed and Mnesia must be restarted. - Forcing shutdown after mnesia_down from ejabberd@newmachine... -</PRE></LI><LI CLASS="li-enumerate">Now you can finally start ejabberd: -<PRE CLASS="verbatim">ejabberdctl start -</PRE></LI><LI CLASS="li-enumerate">Check that the information of the old database is available: accounts, rosters... -After you finish, remember to delete the temporary backup files from public directories. -</LI></OL><P> <A NAME="secure"></A> </P><!--TOC chapter Securing <TT>ejabberd</TT>--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc77">Chapter 5</A>  <A HREF="#secure">Securing <TT>ejabberd</TT></A></H1><!--SEC END --><P> <A NAME="secure"></A> </P><P> <A NAME="firewall"></A> </P><!--TOC section Firewall Settings--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc78">5.1</A>  <A HREF="#firewall">Firewall Settings</A></H2><!--SEC END --><P> <A NAME="firewall"></A> -</P><P>You need to take the following TCP ports in mind when configuring your firewall: -</P><BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> -<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1><TR><TD ALIGN=left NOWRAP><B>Port</B></TD><TD ALIGN=left NOWRAP><B>Description</B></TD></TR> -<TR><TD ALIGN=left NOWRAP>5222</TD><TD ALIGN=left NOWRAP>Standard port for Jabber/XMPP client connections, plain or STARTTLS.</TD></TR> -<TR><TD ALIGN=left NOWRAP>5223</TD><TD ALIGN=left NOWRAP>Standard port for Jabber client connections using the old SSL method.</TD></TR> -<TR><TD ALIGN=left NOWRAP>5269</TD><TD ALIGN=left NOWRAP>Standard port for Jabber/XMPP server connections.</TD></TR> -<TR><TD ALIGN=left NOWRAP>4369</TD><TD ALIGN=left NOWRAP>EPMD (section <A HREF="#epmd">5.2</A>) listens for Erlang node name requests.</TD></TR> -<TR><TD ALIGN=left NOWRAP>port range</TD><TD ALIGN=left NOWRAP>Used for connections between Erlang nodes. This range is configurable (see section <A HREF="#epmd">5.2</A>).</TD></TR> -</TABLE> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><P> <A NAME="epmd"></A> </P><!--TOC section epmd--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc79">5.2</A>  <A HREF="#epmd">epmd</A></H2><!--SEC END --><P> <A NAME="epmd"></A> </P><P><A HREF="http://www.erlang.org/doc/man/epmd.html">epmd (Erlang Port Mapper Daemon)</A> -is a small name server included in Erlang/OTP -and used by Erlang programs when establishing distributed Erlang communications. -<TT>ejabberd</TT> needs <TT>epmd</TT> to use <TT>ejabberdctl</TT> and also when clustering <TT>ejabberd</TT> nodes. -This small program is automatically started by Erlang, and is never stopped. -If <TT>ejabberd</TT> is stopped, and there aren’t any other Erlang programs -running in the system, you can safely stop <TT>epmd</TT> if you want.</P><P><TT>ejabberd</TT> runs inside an Erlang node. -To communicate with <TT>ejabberd</TT>, the script <TT>ejabberdctl</TT> starts a new Erlang node -and connects to the Erlang node that holds <TT>ejabberd</TT>. -In order for this communication to work, -<TT>epmd</TT> must be running and listening for name requests in the port 4369. -You should block the port 4369 in the firewall in such a way that -only the programs in your machine can access it.</P><P>If you build a cluster of several <TT>ejabberd</TT> instances, -each <TT>ejabberd</TT> instance is called an <TT>ejabberd</TT> node. -Those <TT>ejabberd</TT> nodes use a special Erlang communication method to -build the cluster, and EPMD is again needed listening in the port 4369. -So, if you plan to build a cluster of <TT>ejabberd</TT> nodes -you must open the port 4369 for the machines involved in the cluster. -Remember to block the port so Internet doesn’t have access to it.</P><P>Once an Erlang node solved the node name of another Erlang node using EPMD and port 4369, -the nodes communicate directly. -The ports used in this case by default are random, -but can be configured in the file <TT>ejabberdctl.cfg</TT>. -The Erlang command-line parameter used internally is, for example: -</P><PRE CLASS="verbatim">erl ... -kernel inet_dist_listen_min 4370 inet_dist_listen_max 4375 -</PRE><P> <A NAME="cookie"></A> </P><!--TOC section Erlang Cookie--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc80">5.3</A>  <A HREF="#cookie">Erlang Cookie</A></H2><!--SEC END --><P> <A NAME="cookie"></A> </P><P>The Erlang cookie is a string with numbers and letters. -An Erlang node reads the cookie at startup from the command-line parameter <TT>-setcookie</TT>. -If not indicated, the cookie is read from the cookie file <TT>$HOME/.erlang.cookie</TT>. -If this file does not exist, it is created immediately with a random cookie. -Two Erlang nodes communicate only if they have the same cookie. -Setting a cookie on the Erlang node allows you to structure your Erlang network -and define which nodes are allowed to connect to which.</P><P>Thanks to Erlang cookies, you can prevent access to the Erlang node by mistake, -for example when there are several Erlang nodes running different programs in the same machine.</P><P>Setting a secret cookie is a simple method -to difficult unauthorized access to your Erlang node. -However, the cookie system is not ultimately effective -to prevent unauthorized access or intrusion to an Erlang node. -The communication between Erlang nodes are not encrypted, -so the cookie could be read sniffing the traffic on the network. -The recommended way to secure the Erlang node is to block the port 4369.</P><P> <A NAME="nodename"></A> </P><!--TOC section Erlang Node Name--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc81">5.4</A>  <A HREF="#nodename">Erlang Node Name</A></H2><!--SEC END --><P> <A NAME="nodename"></A> </P><P>An Erlang node may have a node name. -The name can be short (if indicated with the command-line parameter <TT>-sname</TT>) -or long (if indicated with the parameter <TT>-name</TT>). -Starting an Erlang node with -sname limits the communication between Erlang nodes to the LAN.</P><P>Using the option <TT>-sname</TT> instead of <TT>-name</TT> is a simple method -to difficult unauthorized access to your Erlang node. -However, it is not ultimately effective to prevent access to the Erlang node, -because it may be possible to fake the fact that you are on another network -using a modified version of Erlang <TT>epmd</TT>. -The recommended way to secure the Erlang node is to block the port 4369.</P><P> <A NAME="secure-files"></A> </P><!--TOC section Securing Sensitive Files--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc82">5.5</A>  <A HREF="#secure-files">Securing Sensitive Files</A></H2><!--SEC END --><P> <A NAME="secure-files"></A> </P><P><TT>ejabberd</TT> stores sensitive data in the file system either in plain text or binary files. -The file system permissions should be set to only allow the proper user to read, -write and execute those files and directories.</P><DL CLASS="description"><DT CLASS="dt-description"> -<B><TT>ejabberd configuration file: /etc/ejabberd/ejabberd.cfg</TT></B></DT><DD CLASS="dd-description"> -Contains the JID of administrators -and passwords of external components. -The backup files probably contain also this information, -so it is preferable to secure the whole <TT>/etc/ejabberd/</TT> directory. -</DD><DT CLASS="dt-description"><B><TT>ejabberd service log: /var/log/ejabberd/ejabberd.log</TT></B></DT><DD CLASS="dd-description"> -Contains IP addresses of clients. -If the loglevel is set to 5, it contains whole conversations and passwords. -If a logrotate system is used, there may be several log files with similar information, -so it is preferable to secure the whole <TT>/var/log/ejabberd/</TT> directory. -</DD><DT CLASS="dt-description"><B><TT>Mnesia database spool files in /var/lib/ejabberd/</TT></B></DT><DD CLASS="dd-description"> -The files store binary data, but some parts are still readable. -The files are generated by Mnesia and their permissions cannot be set directly, -so it is preferable to secure the whole <TT>/var/lib/ejabberd/</TT> directory. -</DD><DT CLASS="dt-description"><B><TT>Erlang cookie file: /var/lib/ejabberd/.erlang.cookie</TT></B></DT><DD CLASS="dd-description"> -See section <A HREF="#cookie">5.3</A>. -</DD></DL><P> <A NAME="clustering"></A> </P><!--TOC chapter Clustering--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc83">Chapter 6</A>  <A HREF="#clustering">Clustering</A></H1><!--SEC END --><P> <A NAME="clustering"></A> -</P><P> <A NAME="howitworks"></A> </P><!--TOC section How it Works--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc84">6.1</A>  <A HREF="#howitworks">How it Works</A></H2><!--SEC END --><P> <A NAME="howitworks"></A> -</P><P>A XMPP domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can -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 -connections, registered services, etc…</P><P>Each <TT>ejabberd</TT> node has the following modules: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -router, -</LI><LI CLASS="li-itemize">local router, -</LI><LI CLASS="li-itemize">session manager, -</LI><LI CLASS="li-itemize">s2s manager. -</LI></UL><P> <A NAME="router"></A> </P><!--TOC subsection Router--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc85">6.1.1</A>  <A HREF="#router">Router</A></H3><!--SEC END --><P> <A NAME="router"></A> -</P><P>This module is the main router of XMPP packets on each node. It -routes them based on their destination’s domains. It uses a global -routing table. The domain of the packet’s destination is searched in the -routing table, and if it is found, the packet is routed to the -appropriate process. If not, it is sent to the s2s manager.</P><P> <A NAME="localrouter"></A> </P><!--TOC subsection Local Router--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc86">6.1.2</A>  <A HREF="#localrouter">Local Router</A></H3><!--SEC END --><P> <A NAME="localrouter"></A> -</P><P>This module routes packets which have a destination domain equal to -one of this server’s host names. If the destination JID has a non-empty user -part, it is routed to the session manager, otherwise it is processed depending -on its content.</P><P> <A NAME="sessionmanager"></A> </P><!--TOC subsection Session Manager--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc87">6.1.3</A>  <A HREF="#sessionmanager">Session Manager</A></H3><!--SEC END --><P> <A NAME="sessionmanager"></A> -</P><P>This module routes packets to local users. It looks up to which user -resource a packet must be sent via a presence table. Then the packet is -either routed to the appropriate c2s process, or stored in offline -storage, or bounced back.</P><P> <A NAME="s2smanager"></A> </P><!--TOC subsection s2s Manager--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc88">6.1.4</A>  <A HREF="#s2smanager">s2s Manager</A></H3><!--SEC END --><P> <A NAME="s2smanager"></A> -</P><P>This module routes packets to other XMPP servers. First, it -checks if an opened s2s connection from the domain of the packet’s -source to the domain of the packet’s destination exists. If that is the case, -the s2s manager routes the packet to the process -serving this connection, otherwise a new connection is opened.</P><P> <A NAME="cluster"></A> </P><!--TOC section Clustering Setup--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc89">6.2</A>  <A HREF="#cluster">Clustering Setup</A></H2><!--SEC END --><P> <A NAME="cluster"></A> -</P><P>Suppose you already configured <TT>ejabberd</TT> on one machine named (<TT>first</TT>), -and you need to setup another one to make an <TT>ejabberd</TT> cluster. Then do -following steps:</P><OL CLASS="enumerate" type=1><LI CLASS="li-enumerate"> -Copy <CODE>~ejabberd/.erlang.cookie</CODE> file from <TT>first</TT> to -<TT>second</TT>.<P>(alt) You can also add ‘<CODE>-setcookie content_of_.erlang.cookie</CODE>’ -option to all ‘<TT>erl</TT>’ commands below.</P></LI><LI CLASS="li-enumerate">On <TT>second</TT> run the following command as the <TT>ejabberd</TT> daemon user, -in the working directory of <TT>ejabberd</TT>:<PRE CLASS="verbatim">erl -sname ejabberd \ - -mnesia dir '"/var/lib/ejabberd/"' \ - -mnesia extra_db_nodes "['ejabberd@first']" \ - -s mnesia -</PRE><P>This will start Mnesia serving the same database as <TT>ejabberd@first</TT>. -You can check this by running the command ‘<CODE>mnesia:info().</CODE>’. You -should see a lot of remote tables and a line like the following:</P><P>Note: the Mnesia directory may be different in your system. -To know where does ejabberd expect Mnesia to be installed by default, -call <A HREF="#ejabberdctl">4.1</A> without options and it will show some help, -including the Mnesia database spool dir.</P><PRE CLASS="verbatim">running db nodes = [ejabberd@first, ejabberd@second] -</PRE></LI><LI CLASS="li-enumerate">Now run the following in the same ‘<TT>erl</TT>’ session:<PRE CLASS="verbatim">mnesia:change_table_copy_type(schema, node(), disc_copies). -</PRE><P>This will create local disc storage for the database.</P><P>(alt) Change storage type of the <TT>scheme</TT> table to ‘RAM and disc -copy’ on the second node via the Web Admin.</P></LI><LI CLASS="li-enumerate">Now you can add replicas of various tables to this node with -‘<CODE>mnesia:add_table_copy</CODE>’ or -‘<CODE>mnesia:change_table_copy_type</CODE>’ as above (just replace -‘<CODE>schema</CODE>’ with another table name and ‘<CODE>disc_copies</CODE>’ -can be replaced with ‘<CODE>ram_copies</CODE>’ or -‘<CODE>disc_only_copies</CODE>’).<P>Which tables to replicate is very dependant on your needs, you can get -some hints from the command ‘<CODE>mnesia:info().</CODE>’, by looking at the -size of tables and the default storage type for each table on ’first’.</P><P>Replicating a table makes lookups in this table faster on this node. -Writing, on the other hand, will be slower. And of course if machine with one -of the replicas is down, other replicas will be used.</P><P>Also <A HREF="http://www.erlang.org/doc/apps/mnesia/Mnesia_chap5.html#5.3">section 5.3 (Table Fragmentation) of Mnesia User’s Guide</A> can be helpful. -</P><P>(alt) Same as in previous item, but for other tables.</P></LI><LI CLASS="li-enumerate">Run ‘<CODE>init:stop().</CODE>’ or just ‘<CODE>q().</CODE>’ to exit from -the Erlang shell. This probably can take some time if Mnesia has not yet -transfered and processed all data it needed from <TT>first</TT>.</LI><LI CLASS="li-enumerate">Now run <TT>ejabberd</TT> on <TT>second</TT> with a configuration similar as -on <TT>first</TT>: you probably do not need to duplicate ‘<CODE>acl</CODE>’ -and ‘<CODE>access</CODE>’ options because they will be taken from -<TT>first</TT>. If you installed <CODE>mod_irc</CODE>, notice that it should be -enabled only on one machine in the cluster. -</LI></OL><P>You can repeat these steps for other machines supposed to serve this -domain.</P><P> <A NAME="servicelb"></A> </P><!--TOC section Service Load-Balancing--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc90">6.3</A>  <A HREF="#servicelb">Service Load-Balancing</A></H2><!--SEC END --><P> <A NAME="servicelb"></A> -</P><P> <A NAME="componentlb"></A> </P><!--TOC subsection Components Load-Balancing--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc91">6.3.1</A>  <A HREF="#componentlb">Components Load-Balancing</A></H3><!--SEC END --><P> <A NAME="componentlb"></A> </P><P> <A NAME="domainlb"></A> </P><!--TOC subsection Domain Load-Balancing Algorithm--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc92">6.3.2</A>  <A HREF="#domainlb">Domain Load-Balancing Algorithm</A></H3><!--SEC END --><P> <A NAME="domainlb"></A> -</P><P><TT>ejabberd</TT> includes an algorithm to load balance the components that are plugged on an <TT>ejabberd</TT> cluster. It means that you can plug one or several instances of the same component on each <TT>ejabberd</TT> cluster and that the traffic will be automatically distributed.</P><P>The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is chosen randomly. If no instance is available locally, one instance is chosen randomly among the remote component instances.</P><P>If you need a different behaviour, you can change the load balancing behaviour with the option <TT>domain_balancing</TT>. The syntax of the option is the following: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{domain_balancing, "component.example.com", BalancingCriteria}.</TT></B></DT></DL><P>Several balancing criteria are available: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -<TT>destination</TT>: the full JID of the packet <TT>to</TT> attribute is used. -</LI><LI CLASS="li-itemize"><TT>source</TT>: the full JID of the packet <TT>from</TT> attribute is used. -</LI><LI CLASS="li-itemize"><TT>bare_destination</TT>: the bare JID (without resource) of the packet <TT>to</TT> attribute is used. -</LI><LI CLASS="li-itemize"><TT>bare_source</TT>: the bare JID (without resource) of the packet <TT>from</TT> attribute is used. -</LI></UL><P>If the value corresponding to the criteria is the same, the same component instance in the cluster will be used.</P><P> <A NAME="lbbuckets"></A> </P><!--TOC subsection Load-Balancing Buckets--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc93">6.3.3</A>  <A HREF="#lbbuckets">Load-Balancing Buckets</A></H3><!--SEC END --><P> <A NAME="lbbuckets"></A> -</P><P>When there is a risk of failure for a given component, domain balancing can cause service trouble. If one component is failing the service will not work correctly unless the sessions are rebalanced.</P><P>In this case, it is best to limit the problem to the sessions handled by the failing component. This is what the <TT>domain_balancing_component_number</TT> option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances.</P><P>The syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{domain_balancing_component_number, "component.example.com", Number}.</TT></B></DT></DL><P> <A NAME="debugging"></A> </P><!--TOC chapter Debugging--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc94">Chapter 7</A>  <A HREF="#debugging">Debugging</A></H1><!--SEC END --><P> <A NAME="debugging"></A> -</P><P> <A NAME="logfiles"></A> </P><!--TOC section Log Files--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc95">7.1</A>  <A HREF="#logfiles">Log Files</A></H2><!--SEC END --><P> <A NAME="logfiles"></A> </P><P>An <TT>ejabberd</TT> node writes two log files: -</P><DL CLASS="description"><DT CLASS="dt-description"> - <B><TT>ejabberd.log</TT></B></DT><DD CLASS="dd-description"> is the ejabberd service log, with the messages reported by <TT>ejabberd</TT> code - </DD><DT CLASS="dt-description"><B><TT>erlang.log</TT></B></DT><DD CLASS="dd-description"> is the Erlang/OTP system log, with the messages reported by Erlang/OTP using SASL (System Architecture Support Libraries) -</DD></DL><P>The option <TT>loglevel</TT> modifies the verbosity of the file ejabberd.log. The syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{loglevel, Level}.</TT></B></DT></DL><P>The possible <TT>Level</TT> are: -</P><DL CLASS="description"><DT CLASS="dt-description"> - <B><TT>0</TT></B></DT><DD CLASS="dd-description"> No ejabberd log at all (not recommended) - </DD><DT CLASS="dt-description"><B><TT>1</TT></B></DT><DD CLASS="dd-description"> Critical - </DD><DT CLASS="dt-description"><B><TT>2</TT></B></DT><DD CLASS="dd-description"> Error - </DD><DT CLASS="dt-description"><B><TT>3</TT></B></DT><DD CLASS="dd-description"> Warning - </DD><DT CLASS="dt-description"><B><TT>4</TT></B></DT><DD CLASS="dd-description"> Info - </DD><DT CLASS="dt-description"><B><TT>5</TT></B></DT><DD CLASS="dd-description"> Debug -</DD></DL><P> -For example, the default configuration is: -</P><PRE CLASS="verbatim">{loglevel, 4}. -</PRE><P>The log files grow continually, so it is recommended to rotate them periodically. -To rotate the log files, rename the files and then reopen them. -The ejabberdctl command <TT>reopen-log</TT> -(please refer to section <A HREF="#ectl-commands">4.1.1</A>) -reopens the log files, -and also renames the old ones if you didn’t rename them.</P><P> <A NAME="debugconsole"></A> </P><!--TOC section Debug Console--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc96">7.2</A>  <A HREF="#debugconsole">Debug Console</A></H2><!--SEC END --><P> <A NAME="debugconsole"></A> </P><P>The Debug Console is an Erlang shell attached to an already running <TT>ejabberd</TT> server. -With this Erlang shell, an experienced administrator can perform complex tasks.</P><P>This shell gives complete control over the <TT>ejabberd</TT> server, -so it is important to use it with extremely care. -There are some simple and safe examples in the article -<A HREF="http://www.ejabberd.im/interconnect-erl-nodes">Interconnecting Erlang Nodes</A></P><P>To exit the shell, close the window or press the keys: control+c control+c.</P><P> <A NAME="watchdog"></A> </P><!--TOC section Watchdog Alerts--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc97">7.3</A>  <A HREF="#watchdog">Watchdog Alerts</A></H2><!--SEC END --><P> <A NAME="watchdog"></A> -</P><P><TT>ejabberd</TT> includes a watchdog mechanism that may be useful to developers -when troubleshooting a problem related to memory usage. -If a process in the <TT>ejabberd</TT> server consumes more memory than the configured threshold, -a message is sent to the XMPP accounts defined with the option -<TT>watchdog_admins</TT> - in the <TT>ejabberd</TT> configuration file.</P><P>The syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{watchdog_admins, [JID, ...]}.</TT></B></DT></DL><P>The memory consumed is measured in <TT>words</TT>: -a word on 32-bit architecture is 4 bytes, -and a word on 64-bit architecture is 8 bytes. -The threshold by default is 1000000 words. -This value can be configured with the option <TT>watchdog_large_heap</TT>, -or in a conversation with the watchdog alert bot.</P><P>The syntax is: -</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{watchdog_large_heap, Number}.</TT></B></DT></DL><P>Example configuration: -</P><PRE CLASS="verbatim">{watchdog_admins, ["admin2@localhost", "admin2@example.org"]}. -{watchdog_large_heap, 30000000}. -</PRE><P>To remove watchdog admins, remove them in the option. -To remove all watchdog admins, set the option with an empty list: -</P><PRE CLASS="verbatim">{watchdog_admins, []}. -</PRE><P> <A NAME="i18ni10n"></A> </P><!--TOC chapter Internationalization and Localization--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc98">Appendix A</A>  <A HREF="#i18ni10n">Internationalization and Localization</A></H1><!--SEC END --><P> <A NAME="i18ni10n"></A> -</P><P>The source code of <TT>ejabberd</TT> supports localization. -The translators can edit the -<A HREF="http://www.gnu.org/software/gettext/">gettext</A> .po files -using any capable program (KBabel, Lokalize, Poedit...) or a simple text editor.</P><P>Then gettext -is used to extract, update and export those .po files to the .msg format read by <TT>ejabberd</TT>. -To perform those management tasks, in the <TT>src/</TT> directory execute <TT>make translations</TT>. -The translatable strings are extracted from source code to generate the file <TT>ejabberd.pot</TT>. -This file is merged with each .po file to produce updated .po files. -Finally those .po files are exported to .msg files, that have a format easily readable by <TT>ejabberd</TT>.</P><P>All built-in modules support the <TT>xml:lang</TT> attribute inside IQ queries. -Figure <A HREF="#fig:discorus">A.1</A>, for example, shows the reply to the following query: -</P><PRE CLASS="verbatim"><iq id='5' - to='example.org' - type='get' - xml:lang='ru'> - <query xmlns='http://jabber.org/protocol/disco#items'/> -</iq> -</PRE><BLOCKQUOTE CLASS="figure"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> - -<IMG SRC="discorus.png" ALT="discorus.png"> - - -<DIV CLASS="caption"><TABLE CELLSPACING=6 CELLPADDING=0><TR><TD VALIGN=top ALIGN=left>Figure A.1: Service Discovery when <TT>xml:lang=’ru’</TT></TD></TR> -</TABLE></DIV> -<A NAME="fig:discorus"></A> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><P>The Web Admin also supports the <CODE>Accept-Language</CODE> HTTP header.</P><BLOCKQUOTE CLASS="figure"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> - -<IMG SRC="webadmmainru.png" ALT="webadmmainru.png"> - - -<DIV CLASS="caption"><TABLE CELLSPACING=6 CELLPADDING=0><TR><TD VALIGN=top ALIGN=left>Figure A.2: Web Admin showing a virtual host when the web browser provides the -HTTP header ‘Accept-Language: ru’</TD></TR> -</TABLE></DIV> -<A NAME="fig:webadmmainru"></A> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><P> <A NAME="releasenotes"></A> </P><!--TOC chapter Release Notes--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc99">Appendix B</A>  <A HREF="#releasenotes">Release Notes</A></H1><!--SEC END --><P> <A NAME="releasenotes"></A> -</P><P>Release notes are available from <A HREF="http://www.process-one.net/en/ejabberd/release_notes/">ejabberd Home Page</A></P><P> <A NAME="acknowledgements"></A> </P><!--TOC chapter Acknowledgements--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc100">Appendix C</A>  <A HREF="#acknowledgements">Acknowledgements</A></H1><!--SEC END --><P> <A NAME="acknowledgements"></A> </P><P>Thanks to all people who contributed to this guide: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -Alexey Shchepin (<A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT></A>) -</LI><LI CLASS="li-itemize">Badlop (<A HREF="xmpp:badlop@jabberes.org"><TT>xmpp:badlop@jabberes.org</TT></A>) -</LI><LI CLASS="li-itemize">Evgeniy Khramtsov (<A HREF="xmpp:xram@jabber.ru"><TT>xmpp:xram@jabber.ru</TT></A>) -</LI><LI CLASS="li-itemize">Florian Zumbiehl (<A HREF="xmpp:florz@florz.de"><TT>xmpp:florz@florz.de</TT></A>) -</LI><LI CLASS="li-itemize">Michael Grigutsch (<A HREF="xmpp:migri@jabber.i-pobox.net"><TT>xmpp:migri@jabber.i-pobox.net</TT></A>) -</LI><LI CLASS="li-itemize">Mickael Remond (<A HREF="xmpp:mremond@process-one.net"><TT>xmpp:mremond@process-one.net</TT></A>) -</LI><LI CLASS="li-itemize">Sander Devrieze (<A HREF="xmpp:s.devrieze@gmail.com"><TT>xmpp:s.devrieze@gmail.com</TT></A>) -</LI><LI CLASS="li-itemize">Sergei Golovan (<A HREF="xmpp:sgolovan@nes.ru"><TT>xmpp:sgolovan@nes.ru</TT></A>) -</LI><LI CLASS="li-itemize">Vsevolod Pelipas (<A HREF="xmpp:vsevoload@jabber.ru"><TT>xmpp:vsevoload@jabber.ru</TT></A>) -</LI></UL><P> <A NAME="copyright"></A> </P><!--TOC chapter Copyright Information--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc101">Appendix D</A>  <A HREF="#copyright">Copyright Information</A></H1><!--SEC END --><P> <A NAME="copyright"></A> </P><P>Ejabberd Installation and Operation Guide.<BR> -Copyright © 2003 — 2010 ProcessOne</P><P>This document is free software; you can redistribute it and/or -modify it under the terms of the GNU General Public License -as published by the Free Software Foundation; either version 2 -of the License, or (at your option) any later version.</P><P>This document is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details.</P><P>You should have received a copy of the GNU General Public License along with -this document; if not, write to the Free Software Foundation, Inc., 51 Franklin -Street, Fifth Floor, Boston, MA 02110-1301, USA.</P><!--CUT END --> -<!--HTMLFOOT--> -<!--ENDHTML--> -<!--FOOTER--> -<HR SIZE=2><BLOCKQUOTE CLASS="quote"><EM>This document was translated from L<sup>A</sup>T<sub>E</sub>X by -</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> -</HTML> diff --git a/doc/version.tex b/doc/version.tex deleted file mode 100644 index 42cf7d828..000000000 --- a/doc/version.tex +++ /dev/null @@ -1,2 +0,0 @@ -% ejabberd version (automatically generated). -\newcommand{\version}{3.0.0-alpha-x} diff --git a/examples/mtr/ejabberd b/examples/mtr/ejabberd deleted file mode 100644 index 4328b0697..000000000 --- a/examples/mtr/ejabberd +++ /dev/null @@ -1,75 +0,0 @@ -#!/bin/sh -# -# PROVIDE: ejabberd -# REQUIRE: DAEMON -# KEYWORD: shutdown -# - -HOME=/usr/pkg/jabber D=/usr/pkg/jabber/ejabberd export HOME - -name="ejabberd" -rcvar=$name - -if [ -r /etc/rc.conf ] -then - . /etc/rc.conf -else - eval ${rcvar}=YES -fi - -# $flags from environment overrides ${rcvar}_flags -if [ -n "${flags}" ] -then - eval ${rcvar}_flags="${flags}" -fi - -checkyesno() -{ - eval _value=\$${1} - case $_value in - [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1) return 0 ;; - [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|[Oo][Ff][Ff]|0) return 1 ;; - *) - echo "\$${1} is not set properly." - return 1 - ;; - esac -} - -cmd=${1:-start} -case ${cmd} in -force*) - cmd=${cmd#force} - eval ${rcvar}=YES - ;; -esac - -if checkyesno ${rcvar} -then -else - exit 0 -fi - -case ${cmd} in -start) - if [ -x $D/src ]; then - echo "Starting ${name}." - cd $D/src - ERL_MAX_PORTS=32000 export ERL_MAX_PORTS - ulimit -n $ERL_MAX_PORTS - su jabber -c "/usr/pkg/bin/erl -sname ejabberd -s ejabberd -heart -detached -sasl sasl_error_logger '{file, \"ejabberd-sasl.log\"}' &" \ - 1>/dev/null 2>&1 - fi - ;; -stop) - echo "rpc:call('ejabberd@`hostname -s`', init, stop, [])." | \ - su jabber -c "/usr/pkg/bin/erl -sname ejabberdstop" - ;; -restart) - echo "rpc:call('ejabberd@`hostname -s`', init, restart, [])." | \ - su jabber -c "/usr/pkg/bin/erl -sname ejabberdrestart" - ;; -*) - echo "Usage: $0 {start|stop|restart}" - exit 1 -esac diff --git a/examples/mtr/ejabberd-netbsd.sh b/examples/mtr/ejabberd-netbsd.sh deleted file mode 100644 index 31d01b6b8..000000000 --- a/examples/mtr/ejabberd-netbsd.sh +++ /dev/null @@ -1,81 +0,0 @@ -#!/bin/sh - -echo '1. fetch, compile, and install erlang' - -if [ ! pkg_info erlang 1>/dev/null 2>&1 ]; then - cd /usr/pkgsrc/lang/erlang - make fetch-list|sh - make - make install -fi -if pkg_info erlang | grep -q erlang-9.1nb1; then -else - echo "erlang-9.1nb1 not installed" 1>&2 - exit 1 -fi - - -echo '2. install crypt_drv.so' - -if [ ! -d /usr/pkg/lib/erlang/lib/crypto-1.1.2.1/priv/lib ] ; then - mkdir -p /usr/pkg/lib/erlang/lib/crypto-1.1.2.1/priv/lib -fi -if [ ! -f /usr/pkg/lib/erlang/lib/crypto-1.1.2.1/priv/lib/crypto_drv.so ]; then - cp work/otp*/lib/crypto/priv/*/*/crypto_drv.so \ - /usr/pkg/lib/erlang/lib/crypto-1.1.2.1/priv/lib -fi - - -echo '3. compile and install elibcrypto.so' - -if [ ! -f /usr/pkg/lib/erlang/lib/crypto-1.1.2.1/priv/lib/elibcrypto.so ]; then -cd /usr/pkgsrc/lang/erlang/work/otp_src_R9B-1/lib/crypto/c_src -ld -r -u CRYPTO_set_mem_functions -u MD5 -u MD5_Init -u MD5_Update \ - -u MD5_Final -u SHA1 -u SHA1_Init -u SHA1_Update -u SHA1_Final \ - -u des_set_key -u des_ncbc_encrypt -u des_ede3_cbc_encrypt \ - -L/usr/lib -lcrypto -o ../priv/obj/i386--netbsdelf/elibcrypto.o -cc -shared \ - -L/usr/pkgsrc/lang/erlang/work/otp_src_R9B-1/lib/erl_interface/obj/i386--netbsdelf \ - -o ../priv/obj/i386--netbsdelf/elibcrypto.so \ - ../priv/obj/i386--netbsdelf/elibcrypto.o -L/usr/lib -lcrypto -cp ../priv/obj/i386--netbsdelf/elibcrypto.so \ - /usr/pkg/lib/erlang/lib/crypto-1.1.2.1/priv/lib -fi - - -echo '4. compile and install ssl_esock' - -if [ ! -f /usr/pkg/lib/erlang/lib/ssl-2.3.5/priv/bin/ssl_esock ]; then - cd /usr/pkg/lib/erlang/lib/ssl-2.3.5/priv/obj/ - make -fi - - -echo '5. initial ejabberd configuration' - -cd /usr/pkg/jabber/ejabberd/src -./configure - - -echo '6. edit ejabberd Makefiles' - -for M in Makefile mod_*/Makefile; do - if [ ! -f $M.orig ]; then - mv $M $M.orig - sed -e s%/usr/local%/usr/pkg%g < $M.orig > $M - fi -done - - -echo '7. compile ejabberd' - -gmake -for A in mod_muc mod_pubsub; do - (cd $A; gmake) -done - - -echo '' -echo 'now edit ejabberd.cfg' -echo '' -echo 'to start ejabberd: erl -sname ejabberd -s ejabberd' diff --git a/examples/mtr/ejabberd.cfg b/examples/mtr/ejabberd.cfg deleted file mode 100644 index 6f4f4b284..000000000 --- a/examples/mtr/ejabberd.cfg +++ /dev/null @@ -1,66 +0,0 @@ -% jabber.dbc.mtview.ca.us - -override_acls. - -{acl, admin, {user, "mrose", "jabber.dbc.mtview.ca.us"}}. - - -{access, announce, [{allow, admin}, - {deny, all}]}. -{access, c2s, [{deny, blocked}, - {allow, all}]}. -{access, c2s_shaper, [{none, admin}, - {normal, all}]}. -{access, configure, [{allow, admin}, - {deny, all}]}. -{access, disco_admin, [{allow, admin}, - {deny, all}]}. -{access, muc_admin, [{allow, admin}, - {deny, all}]}. -{access, register, [{deny, all}]}. -{access, s2s_shaper, [{fast, all}]}. - - -{auth_method, internal}. -{host, "jabber.dbc.mtview.ca.us"}. -{outgoing_s2s_port, 5269}. -{shaper, normal, {maxrate, 1000}}. -{shaper, fast, {maxrate, 50000}}. -{welcome_message, none}. - - -{listen, [{5222, ejabberd_c2s, - [{access, c2s}, - {shaper, c2s_shaper}]}, - {5223, ejabberd_c2s, - [{access, c2s}, - {shaper, c2s_shaper}, - {ssl, [{certfile, "/etc/openssl/certs/ejabberd.pem"}]}]}, - {5269, ejabberd_s2s_in, - [{shaper, s2s_shaper}]}]}. - - -{modules, [ - {mod_register, []}, - {mod_roster, []}, - {mod_privacy, []}, - {mod_configure, []}, - {mod_disco, []}, - {mod_stats, []}, - {mod_vcard, []}, - {mod_offline, []}, - {mod_echo, [{host, "echo.jabber.dbc.mtview.ca.us"}]}, - {mod_private, []}, -% {mod_irc, []}, - {mod_muc, []}, - {mod_pubsub, []}, - {mod_time, []}, - {mod_last, []}, - {mod_version, []} - ]}. - - - -% Local Variables: -% mode: erlang -% End: diff --git a/examples/transport-configs/configs/aim-transport.xml b/examples/transport-configs/configs/aim-transport.xml deleted file mode 100644 index 41804c69d..000000000 --- a/examples/transport-configs/configs/aim-transport.xml +++ /dev/null @@ -1,77 +0,0 @@ -<!-- aim-transport.xml --> - -<jabber> - - <!-- - You need to add elogger and rlogger entries when using ejabberd. - In this case the transport will do the logging. - --> - - <log id='elogger'> - <host/> - <logtype/> - <format>%d: [%t] (%h): %s</format> - <file>/var/log/jabber/aim-transport-error.log</file> - </log> - - <log id='rlogger'> - <host/> - <logtype>record</logtype> - <format>%d %h %s</format> - <file>/var/log/jabber/aim-transport-record.log</file> - </log> - - <!-- - ejabberd do not provide XDB services. - xdb_file.so is loaded in to handle all XDB requests. - --> - - <xdb id="xdb"> - <host/> - <load> - <xdb_file>/usr/local/lib/jabber/libjabberdxdbfile.so</xdb_file> <!-- This file is part of jabberd-1.4.x. --> - </load> - <xdb_file xmlns="jabber:config:xdb_file"> - <spool><jabberd:cmdline flag='s'>/var/spool/jabber</jabberd:cmdline></spool> - </xdb_file> - </xdb> - - <!-- - Make sure that all host names here are resolveable via DNS if you - want the transport to be available to the public. - --> - - <service id='aim.SERVER.COM'> - <!-- aim-transport configuration. --> - <aimtrans xmlns='jabber:config:aimtrans'> - <vCard> - <FN>AIM/ICQ Transport</FN> - <DESC>This is the AIM/ICQ Transport.</DESC> - <MAIL>EMAIL@ADDRESS.COM</MAIL> - <URL>http://aim-transport.jabberstudio.org/</URL> - </vCard> - <charset>cp1252</charset> - </aimtrans> - <!-- aim-transport module. --> - <load> - <aim_transport>/usr/local/lib/jabber/aim-transport.so</aim_transport> - </load> - </service> - - <!-- - The settings below have to match the settings you made - in your ejabberd.cfg configuration file. - --> - - <service id="icq-linker"> - <uplink/> - <connect> - <ip>127.0.0.1</ip> - <port>5233</port> - <secret>SECRET</secret> - </connect> - </service> - - <pidfile>/var/run/jabber/aim-transport.pid</pidfile> - -</jabber> diff --git a/examples/transport-configs/configs/ile.xml b/examples/transport-configs/configs/ile.xml deleted file mode 100644 index 5999f0fbd..000000000 --- a/examples/transport-configs/configs/ile.xml +++ /dev/null @@ -1,136 +0,0 @@ -<!-- ile.xml --> - -<config> - <jabber> - <server>127.0.0.1</server> - <port>5238</port> - <secret>SECRET</secret> - <service>ile.SERVER.COM</service> - <connectsleep>7</connectsleep> <!-- seconds to wait if we get disconnected --> - <language>en</language> - <vCard> - <FN>I Love Email</FN> - <DESC>With this service you can receive email notifications. - -Security warning: Be careful when using this. Your password will travel in clear from your client to your jabber server if you don't use SSL and it will probably travel in clear from the jabber server to your email server. Use with care. This shouldn't be an issue in your Intranet, but it is if you use an ILE installed in a foreign jabber server.</DESC> - <MAIL>EMAIL@ADDRESS.COM</MAIL> - <URL>http://ile.jabberstudio.org/</URL> - </vCard> - </jabber> - - <debug> - <file>/var/log/jabber/ile.log</file> - <level>1</level> <!-- man Net::Jabber::Debug --> - </debug> - - <mail> - <checkinterval>10</checkinterval> <!-- in minutes --> - <timeout>20</timeout> <!-- timeout for IMAP/POP connection, in seconds --> - </mail> - - <files> - <users>/var/spool/jabber/ile.SERVER.COM/users.db</users> - <passwords>/var/spool/jabber/ile.SERVER.COM/passwords.db</passwords> - <hosts>/var/spool/jabber/ile.SERVER.COM/hosts.db</hosts> - <types>/var/spool/jabber/ile.SERVER.COM/types.db</types> - <notifyxa>/var/spool/jabber/ile.SERVER.COM/notifyxa.db</notifyxa> - <notifydnd>/var/spool/jabber/ile.SERVER.COM/notifydnd.db</notifydnd> - <urls>/var/spool/jabber/ile.SERVER.COM/urls.db</urls> - </files> - - <form> - <en> - <instructions>Please fill in the fields,according to your email account settings and notification preferences</instructions> - <title>ILE: Email notification service</title> - <email_options>Email account settings</email_options> - <user>Username</user> - <pass>Password</pass> - <host>Hostname</host> - <type>Type</type> - <newmail>You have received NUM email messages since last time I checked, which was CHECKINTERVAL minutes ago.</newmail> - <errorcheck>There was an error while trying to check mail for ACCOUNT.</errorcheck> - <notify_options>Notification Options</notify_options> - <notifyxa>Notify even when Xtended Away (XA)</notifyxa> - <notifydnd>Notify even when Do Not Disturb (DND)</notifydnd> - <webmail_url>Webmail URL</webmail_url> - <webmail_login>Login to ACCOUNT</webmail_login> - <iledesc>ILE: an email notifier component: http://ile.jabberstudio.org</iledesc> - </en> - - <es> - <instructions>Por favor, rellene los campos del formulario.</instructions> - <title>ILE: Servicio de notificación de correo</title> - <email_options>Configuración de la cuenta de correo</email_options> - <user>Usuario</user> - <pass>Clave</pass> - <host>Host</host> - <type>Tipo</type> - <newmail>Ha recibido NUM email(s) desde la última comprobación que fue hace CHECKINTERVAL minutos</newmail> - <errorcheck>Ha habido un error en la comprobación del correo para la cuenta ACCOUNT.</errorcheck> - <notify_options>Opciones de notificación</notify_options> - <notifyxa>Notificar incluso si muy ausente (XA)</notifyxa> - <notifydnd>Notificar incluso si no molestar (DND)</notifydnd> - <webmail_url>Webmail URL</webmail_url> - <webmail_login>Leer correo de ACCOUNT</webmail_login> - <iledesc>ILE: un notificador de nuevo email - http://ile.jabberstudio.org</iledesc> - </es> - - <ca> - <instructions>Ompli els camps del formulari.</instructions> - <title>ILE: Servei de notificació de nou email</title> - <email_options>Dades del compte de mail</email_options> - <user>Usuari</user> - <pass>Clau</pass> - <host>Host</host> - <type>Tipus</type> - <newmail>Ha rebut NUM email(s) des de la última comprobació que va ser fa CHECKINTERVAL minuts.</newmail> - <errorcheck>S'ha produit un error en la comprobació del correu per al compte ACCOUNT.</errorcheck> - <notify_options>Opcions de notificació</notify_options> - <notifyxa>Notificar si molt absent (XA)</notifyxa> - <notifydnd>Notificar si no molestar (DND)</notifydnd> - <webmail_url>Webmail URL</webmail_url> - <webmail_login>Llegir correu de ACCOUNT</webmail_login> - <iledesc>ILE: un notificador de nou email - http://ile.jabberstudio.org</iledesc> - </ca> - - <ro> - <!-- Contributed by Adrian Rappa --> - <instructions>Va rog completati urmatoarele campuri</instructions> - <title>I Love Email: new email notification service</title> - <email_options>Email account settings</email_options> - <user>Nume utilizator</user> - <pass>Parola</pass> - <host>Nume gazda</host> - <type>Tip</type> - <newmail>Ati primit NUM mesaj(e) de la ultima verificare, care a fost acum CHECKINTERVAL minute.</newmail> - <errorcheck>A fost eroare in timp ce incercam sa verific posta pentru ACCOUNT.</errorcheck> - <notify_options>Notification Options</notify_options> - <notifyxa>Notify even when Xtended Away (XA)</notifyxa> - <notifydnd>Notify even when Do Not Disturb (DND)</notifydnd> - <webmail_url>Webmail URL</webmail_url> - <webmail_login>Login to ACCOUNT</webmail_login> - <iledesc>ILE: an email notifier component: http://ile.jabberstudio.org</iledesc> - </ro> - - <nl> - <!-- Contributed by Sander Devrieze --> - <instructions>Vul volgende velden in.</instructions> - <title>ILE: Dienst voor e-mailnotificaties</title> - <email_options>Instellingen van e-mailaccount</email_options> - <user>Gebruikersnaam</user> - <pass>Wachtwoord</pass> - <host>Inkomende mailserver</host> - <type>Type verbinding</type> - <newmail>U hebt NUM berichten ontvangen sinds CHECKINTERVAL minuten geleden.</newmail> - <errorcheck>Fout tijdens controle op nieuwe e-mails bij ACCOUNT. ILE zal deze account niet meer opnieuw controleren tot u uw registratiegegevens wijzigt of opnieuw aanmeldt.</errorcheck> - <notify_options>Notificatie-instellingen</notify_options> - <notifyxa>Notificeer ook in de status Niet Beschikbaar (XA)</notifyxa> - <notifydnd>Notificeer ook in de status Niet Storen (DND)</notifydnd> - <webmail_url>URL van webmail</webmail_url> - <webmail_login>Aanmelden op ACCOUNT</webmail_login> - <iledesc>ILE: een dienst om e-mailnotificaties te ontvangen: http://ile.jabberstudio.org</iledesc> - </nl> - - </form> - -</config>
\ No newline at end of file diff --git a/examples/transport-configs/configs/jabber-gg-transport.xml b/examples/transport-configs/configs/jabber-gg-transport.xml deleted file mode 100644 index 39d8c0b64..000000000 --- a/examples/transport-configs/configs/jabber-gg-transport.xml +++ /dev/null @@ -1,149 +0,0 @@ -<jggtrans> - - <service jid="gg.SERVER.COM"/> - - <!-- This connects the jabber-gg-transport process to ejabberd. --> - <connect id="gglinker"> - <ip>127.0.0.1</ip> - <port>5237</port> - <secret>SECRET</secret> - </connect> - - <register> - <!-- This tag contains the message displayed to users at registration time. - You can use <p/> and/or <br/> to break lines. Multiple spaces and newlines - are converted to just one, so formatting of config file doesn't really matter. --> - <instructions> - Fill in your GG number (after "username") - and password to register on the transport. - <p/>To change your information in the GaduGadu directory you need to fill in the other fields. - <p/>To remove registration you need to leave the form blank. - </instructions> - </register> - - <search> - <!-- This tag contains the message displayed to users at search time. --> - <instructions> - To search people:<br/> - First fill in surname or family name, nickname, city, birthyear or range of birthyears (eg. 1950-1960) - and gender (you may fill in more fields at once).<br/> - or<br/> - Fill in phone number<br/> - or<br/> - Fill in the GG number of the person you are searching. - </instructions> - </search> - - <gateway> - <!-- This is message, that may be displayed to user when adding gg contact. --> - <desc>Please fill in the GaduGadu number of the person you want to add.</desc> - <!-- And this is the prompt for GG number. --> - <prompt>GG Nummer</prompt> - </gateway> - - <vCard> - <FN>Gadu-Gadu Transport</FN> - <DESC>This is the Gadu-Gadu Transport.</DESC> - <EMAIL>EMAIL@ADDRESS.COM</EMAIL> - <URL>http://www.jabberstudio.org/projects/jabber-gg-transport/</URL> - </vCard> - - <!-- Default user locale (language). - Empty means system locale setting, - no (or commented-out) <default_locale> tag means no translations. --> - <!-- <default_locale>pl_PL</default_locale> --> - - <!-- Logger configuration. - You may configure one logger of type "syslog" and/or one of type "file". - You may also not configure logging at all. --> - <log type="syslog" facility="local0"/> - <log type="file">/var/log/jabber/jabber-gg-transport.log</log> - - <!-- Uncomment this, if you want proxy to be used for Gadu-Gadu connection. --> - <!-- - <proxy> - <ip>127.0.0.1</ip> - <port>8080</port> - </proxy> - --> - - <!-- You can change these values according to your needs. --> - <conn_timeout>60</conn_timeout> - <ping_interval>10</ping_interval> - - <!-- Gadu-Gadu server doesn't seem to answer pings anymore :-( - So let's give it 10 year :-) --> - <pong_timeout>315360000</pong_timeout> - - <!-- This time after disconnection from Gadu-Gadu server the transport - will try to connect again. --> - <reconnect>300</reconnect> - - <!-- How long to wait before restart, after jabber server connection is broken - negative value means, that jggtrans should terminate. --> - <restart_timeout>60</restart_timeout> - - <!-- Delay between the unavailable presence is received from user and loggin out - from Gadu-Gadu - for nice <presence type="invisible"/> support. --> - <disconnect_delay>5</disconnect_delay> - - <!-- list of Gadu-Gadu servers to use. - <hub/> means "use GG hub to find server" - <server/> tag should contain server address and may contain "port" - attribute with port number. When TLS is available (supported by libgadu) - it will be used unless "tls" attribute is set to "no". Please notice, - that not all servers will accept TLS connections. - Servers (including hub) are tried in order as they appear in <servers/> - element. - A reasonable default server list is hardcoded in jggtrans. - --> - <!-- - <servers> - <hub/> - <server port="443">217.17.41.90</server> - <server tls="no">217.17.41.85</server> - <server tls="no">217.17.41.88</server> - </servers> - --> - - <!-- Spool directory. This is the place, where user info will be stored. --> - <!-- Be careful about permissions - users' Gadu-Gadu passwords are stored there. --> - <spool>/var/spool/jabber/gg.SERVER.COM/</spool> - - <!-- Where to store pid file. This tag is optional. --> - <pidfile>/var/run/jabber/jabber-gg-transport.pid</pidfile> - - <!-- jid allowed to do some administrative task (eg. discovering online users). - May be used multiple times. --> - <admin>GG_TRANSPORT_ADMIN@SERVER.COM</admin> - - <!-- ACL gives detailed access control to the transport. --> - <acl> - <!-- Example entries: --> - - <allow who="admin@SERVER.COM" what="iq/query?xmlns=http://jabber.org/protocol/stats"/> - <!-- will allow statistics gathering to admin@SERVER.COM --> - - <deny who="*" what="iq/query?xmlns=http://jabber.org/protocol/stats"/> - <!-- will deny statistics gathering for anybody else --> - - <!-- <allow who="*@SERVER.COM"/> --> - <!-- will allow anything else to users from "SERVER.COM" --> - - <!-- <deny what="iq/query?xmlns=jabber:x:register"/> --> - <!-- will deny registration for all other users --> - - <!-- <allow what="presence"/> --> - <!-- allow presence from anybody --> - - <!-- <allow what="iq"/> --> - <!-- allow iq from anybody --> - - <!-- <allow what="message"/> --> - <!-- allow message from anybody --> - - <!-- <deny/> --> - <!-- will deny anything else --> - </acl> - -</jggtrans> diff --git a/examples/transport-configs/configs/jit.xml b/examples/transport-configs/configs/jit.xml deleted file mode 100644 index c0d78c40a..000000000 --- a/examples/transport-configs/configs/jit.xml +++ /dev/null @@ -1,128 +0,0 @@ -<!-- jit.xml --> - -<jabber> - - <!-- - You need to add elogger and rlogger entries here when using ejabberd. - In this case the transport will do the logging. - --> - - <log id='elogger'> - <host/> - <logtype/> - <file>/var/log/jabber/jit-error</file> <!-- WPJabber logs with date. --> - </log> - - <log id='rlogger'> - <host/> - <logtype>record</logtype> - <file>/var/log/jabber/jit-record</file> <!-- WPJabber logs with date. --> - </log> - - <!-- - ejabberd do not provide XDB services. - xdb_file-jit.so (the renamed xdb_file.so from WPJabber) is - loaded in to handle all XDB requests. - Read also the documentation in xdb_file/README from the JIT package. - --> - - <xdb id="xdb"> - <host/> - <load> - <xdb_file>/usr/local/lib/jabber/xdb_file.so</xdb_file> <!-- The xdb_file.so from WPJabber/JIT. --> - </load> - <xdb_file xmlns="jabber:config:xdb_file"> - <spool><jabberd:cmdline flag='s'>/var/spool/jabber</jabberd:cmdline></spool> - </xdb_file> - </xdb> - - <!-- - Make sure that all host names here are resolveable via DNS if you - want the transport to be available to the public. - --> - - <service id="icq.SERVER.COM"> - <!-- - Replace SERVER.COM with the same as above to enable sms. - --> - <host>sms.icq.SERVER.COM</host> - <!-- JIT configuration. --> - <icqtrans xmlns="jabber:config:icqtrans"> - <sms> - <host>sms.icq.SERVER.COM</host> - <!-- Status of virtual "sms-contacts". --> - <show>away</show> - <status/> - </sms> - <instructions>Fill in your UIN and password.</instructions> - <search>Search ICQ users.</search> - <vCard> - <FN>ICQ Transport (JIT)</FN> - <DESC>This is the Jabber ICQ Transport.</DESC> - <MAIL>EMAIL@ADDRESS.COM</MAIL> - <URL>http://jit.jabberstudio.org/</URL> - </vCard> - <!-- Hashtable for users. --> - <prime>3907</prime> - <!-- Send messages from ICQ as chat to Jabber clients. --> - <chat/> - <!-- Enable this for ICQ web presence. --> - <web/> - <!-- - If you don't want jabber:x:data forms - in reg and search uncomment this tag - (Not recomended). - --> - <no_xdata/> - <!-- - This tag is necessary when using ejabberd. - In this way JIT will have its own contact list. - --> - <own_roster/> - <!-- - When present, this tag will tell JIT not to try to - get the user's roster (which will take a bit of time - to fail in scenarios described above). - --> - <no_jabber_roster/> - <!-- File with stats. --> - <user_count_file>/var/spool/jabber/jit-count</user_count_file> - <!-- - Interval beetween checking sessions: ping, messages, acks. - --> - <session_check>5</session_check> - <!-- Reconnect retries. --> - <reconnects>5</reconnects> - <!-- - Time in sec when session can be inactive, 0=disabled. - --> - <session_timeout>18000</session_timeout> - <charset>windows-1252</charset> - <server> - <host port="5190">login.icq.com</host> - </server> - </icqtrans> - <!-- JIT module. --> - <load> - <icqtrans>/usr/local/lib/jabber/jit.so</icqtrans> - </load> - </service> - - <!-- - The settings below have to match the settings you made - in your ejabberd.cfg configuration file. - --> - - <service id="icq-linker"> - <host>SERVER.COM</host> - <uplink/> - <connect> - <ip>127.0.0.1</ip> - <port>5234</port> - <secret>SECRET</secret> - </connect> - </service> - - <pidfile>/var/run/jabber/jit.pid</pidfile> - -</jabber> diff --git a/examples/transport-configs/configs/msn-transport.xml b/examples/transport-configs/configs/msn-transport.xml deleted file mode 100644 index a6f1391db..000000000 --- a/examples/transport-configs/configs/msn-transport.xml +++ /dev/null @@ -1,118 +0,0 @@ -<!-- msn-transport.xml --> - -<jabber> - - <!-- - You need to add elogger and rlogger entries here when using ejabberd. - In this case the transport will do the logging. - --> - - <log id='elogger'> - <host/> - <logtype/> - <format>%d: [%t] (%h): %s</format> - <file>/var/log/jabber/msn-transport-error.log</file> - </log> - - <log id='rlogger'> - <host/> - <logtype>record</logtype> - <format>%d %h %s</format> - <file>/var/log/jabber/msn-transport-record.log</file> - </log> - - <!-- - ejabberd do not provide XDB services. - xdb_file.so is loaded in to handle all XDB requests. - --> - - <xdb id="xdb"> - <host/> - <load> - <xdb_file>/usr/local/lib/jabber/libjabberdxdbfile.so</xdb_file> - </load> - <xdb_file xmlns="jabber:config:xdb_file"> - <spool><jabberd:cmdline flag='s'>/var/spool/jabber</jabberd:cmdline></spool> - </xdb_file> - </xdb> - - <!-- - Make sure that all host names here are resolveable via DNS if you - want the transport to be available to the public. - --> - - <service id="msn.SERVER.COM"> - <!-- msn-transport configuration. --> - <msntrans xmlns="jabber:config:msntrans"> - <instructions>Fill in your MSN account and password (eg: user1@hotmail.com). A nickname is optional.</instructions> - <vCard> - <FN>MSN Transport</FN> - <DESC>This is the MSN Transport.</DESC> - <EMAIL>EMAIL@ADDRESS.COM</EMAIL> - <URL>http://msn-transport.jabberstudio.org/</URL> - </vCard> - <!-- - Conference support allows you to create groupchat rooms on the - msn-transport and invite MSN users to join. - --> - <conference id="conference.msn.SERVER.COM"> - <!-- - This will make MSN transport invite you to a special groupchat - room when more then one user joins a normal one-on-one session. - Joining this room will make MSN transport "switch" the session - into groupchat mode. If you ignore it, MSN transport will - continue to send the messages as one-on-one chats. - --> - <invite>More than one user entered this chat session. Enter this room to switch to groupchat modus.</invite> - <notice> - <join> is available</join> - <leave> has leaved the room</leave> - </notice> - </conference> - <!-- Enable Hotmail inbox notification. --> - <headlines/> - <!-- - Enable fancy friendly names - If the user enters a nickname upon registration, and the user has - a status message, their MSN friendly name will be "nickname - status message". - - If the user does not enter a nickname on registration, but they do have - a status message, their friendly name will just be their status message. - - If the user did enter a nickname on registration, but they have a blank status message, - then their friendly name will just be the registered nickname. - - If the user did not enter a nickname on registration, and they have a blank status message, - their nickname will just be the username portion of their JID. - - If the above chosen friendly name is too long, then it will be truncated and "..." placed - at the end. MSN only supports friendly names of 128 characters, so this is unavoidable. - - If this is disabled, then the registered nick is always sent as the MSN friendly name, - or if that is blank, the username portion of their JID is sent instead. - --> - <fancy_friendly/> - </msntrans> - <!-- msn-transport module. --> - <load> - <msntrans>/usr/local/lib/jabber/msn-transport.so</msntrans> - </load> - </service> - - <!-- - The settings below have to match the settings you made - in your ejabberd.cfg configuration file. - --> - - <service id="msn-linker"> - <uplink/> - <connect> - <ip>127.0.0.1</ip> - <port>5235</port> - <secret>SECRET</secret> - </connect> - </service> - - <pidfile>/var/run/jabber/msn-transport.pid</pidfile> - -</jabber> diff --git a/examples/transport-configs/configs/yahoo-transport-2.xml b/examples/transport-configs/configs/yahoo-transport-2.xml deleted file mode 100644 index 2d077aa7a..000000000 --- a/examples/transport-configs/configs/yahoo-transport-2.xml +++ /dev/null @@ -1,86 +0,0 @@ -<!-- yahoo-transport-2.xml --> - -<jabber> - - <!-- - You need to add the elogger entry here when using ejabberd. - In this case the transport will do the logging. - --> - - <log id='elogger'> - <host/> - <logtype/> - <format>%d: [%t] (%h): %s</format> - <file>/var/log/jabber/yahoo-transport-2-error.log</file> - <stderr/> - </log> - - <!-- - ejabberd do not provide XDB services. - xdb_file.so is loaded in to handle all XDB requests. - --> - - <xdb id="xdb"> - <host/> - <load> - <xdb_file>/usr/local/lib/jabber/libjabberdxdbfile.so</xdb_file> - </load> - <xdb_file xmlns="jabber:config:xdb_file"> - <spool><jabberd:cmdline flag='s'>/var/spool/jabber</jabberd:cmdline></spool> - </xdb_file> - </xdb> - - <!-- - Make sure that all host names here are resolveable via DNS if you - want the transport to be available to the public. - --> - - <service id="yahoo.SERVER.COM"> - <!-- yahoo-transport-2 configuration. --> - <config xmlns="jabber:config:yahoo"> - <vCard> - <NAME>Yahoo! Transport</NAME> - <FN>vCard not implemented in current version</FN> - <DESC>This is the Yahoo! transport.</DESC> - <MAIL>EMAIL@ADDRESS.COM</MAIL> - <URL>http://yahoo-transport-2.jabberstudio.org/</URL> - </vCard> - <instructions>Fill in your YAHOO! Messenger username and password to register on this transport.</instructions> - <server>scs.msg.yahoo.com</server> - <port>5050</port> - <!-- - The character map. This provides character set translation from UTF-8 - to the indicated character map. See the man page for 'iconv' for available - character maps on your platform. CP1252 is the standard Windows character - set. - --> - <charmap>CP1252</charmap> - <!-- - When this element exists, the transport will send new mail notifications as - well as a count of unread messages when the user initially logs in. - --> - <newmail/> - </config> - <!-- yahoo-transport-2 module. --> - <load> - <yahoo_transport>/usr/local/lib/jabber/yahoo-transport-2.so</yahoo_transport> - </load> - </service> - - <!-- - The settings below have to match the settings you made - in your ejabberd.cfg configuration file. - --> - - <service id="yahoo-linker"> - <uplink/> - <connect> - <ip>127.0.0.1</ip> - <port>5236</port> - <secret>SECRET</secret> - </connect> - </service> - - <pidfile>/var/run/jabber/yahoo-transport-2.pid</pidfile> - -</jabber> diff --git a/examples/transport-configs/init-scripts/aim-transport b/examples/transport-configs/init-scripts/aim-transport deleted file mode 100755 index e13d6572f..000000000 --- a/examples/transport-configs/init-scripts/aim-transport +++ /dev/null @@ -1,45 +0,0 @@ -#!/bin/sh -######################################################### -# -# aim-transport -- script to start aim-transport. -# -######################################################### - -DAEMON=/usr/local/sbin/jabberd-aim-transport -CONF=/etc/jabber/aim-transport.xml -NAME=jabberd-aim-transport -HOME=/etc/jabber/ -USER=ejabberd - -######################################################### - -if [ "`/usr/bin/whoami`" != "$USER" ]; then - - echo "You need to be" $USER "user to run this script." - exit 1 -fi - -case "$1" in - debug) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME in debugging mode." - $DAEMON -D -H $HOME -c $CONF & - ;; - start) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME." - $DAEMON -H $HOME -c $CONF & - ;; - stop) - echo "Stopping $NAME." - killall $NAME & - ;; - restart|reload) - $0 stop - sleep 3 - $0 start - ;; - *) - echo "Usage: $0 {debug|start|stop|restart}" - exit 1 -esac diff --git a/examples/transport-configs/init-scripts/ile b/examples/transport-configs/init-scripts/ile deleted file mode 100755 index a1e072f2c..000000000 --- a/examples/transport-configs/init-scripts/ile +++ /dev/null @@ -1,43 +0,0 @@ -#!/bin/sh -######################################################### -# -# ile -- script to start ILE. -# -######################################################### - -DAEMON=/usr/local/sbin/ile.pl -NAME=ile.pl -CONF=/etc/jabber/ile.xml -USER=ejabberd - -######################################################### - -if [ "`/usr/bin/whoami`" != "$USER" ]; then - - echo "You need to be" $USER "user to run this script." - exit 1 -fi - -case "$1" in - debug) - echo "Not implemented yet. Starting in normal mode" - $0 start - ;; - start) - test -f $DAEMON || exit 0 - echo "Starting $NAME." - $DAEMON $CONF & - ;; - stop) - echo "Stopping $NAME." - killall $NAME & - ;; - restart|reload) - $0 stop - sleep 3 - $0 start - ;; - *) - echo "Usage: $0 {debug|start|stop|status|restart}" - exit 1 -esac diff --git a/examples/transport-configs/init-scripts/jabber-gg-transport b/examples/transport-configs/init-scripts/jabber-gg-transport deleted file mode 100755 index 269685d0d..000000000 --- a/examples/transport-configs/init-scripts/jabber-gg-transport +++ /dev/null @@ -1,47 +0,0 @@ -#!/bin/sh -######################################################### -# -# jabber-gg-transport -- script to start jabber-gg-transport. -# -######################################################### - -DAEMON=/usr/local/sbin/jggtrans -CONF=/etc/jabber/jabber-gg-transport.xml -NAME=jggtrans -HOME=/etc/jabber/ -USER=ejabberd - -######################################################### - -if [ "`/usr/bin/whoami`" != "$USER" ]; then - - echo "You need to be" $USER "user to run this script." - exit 1 -fi - -case "$1" in - debug) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME in debugging mode." - $DAEMON -D -H $HOME -c $CONF & - ;; - start) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME." - $DAEMON $CONF & - ;; - stop) - echo "Stopping $NAME." - killall $NAME & - rm /var/run/jabber/jabber-gg-transport.pid - ;; - - restart|reload) - $0 stop - sleep 3 - $0 start - ;; - *) - echo "Usage: $0 {debug|start|stop|restart}" - exit 1 -esac diff --git a/examples/transport-configs/init-scripts/jit b/examples/transport-configs/init-scripts/jit deleted file mode 100755 index 55e000ee8..000000000 --- a/examples/transport-configs/init-scripts/jit +++ /dev/null @@ -1,45 +0,0 @@ -#!/bin/sh -######################################################### -# -# jit -- script to start JIT. -# -######################################################### - -DAEMON=/usr/local/sbin/wpjabber-jit -CONF=/etc/jabber/jit.xml -NAME=wpjabber-jit -HOME=/etc/jabber/ -USER=ejabberd - -######################################################### - -if [ "`/usr/bin/whoami`" != "$USER" ]; then - - echo "You need to be" $USER "user to run this script." - exit 1 -fi - -case "$1" in - debug) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME in debugging mode." - $DAEMON -D -H $HOME -c $CONF & - ;; - start) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME." - $DAEMON -H $HOME -c $CONF & - ;; - stop) - echo "Stopping $NAME." - killall $NAME & - ;; - restart|reload) - $0 stop - sleep 3 - $0 start - ;; - *) - echo "Usage: $0 {debug|start|stop|restart}" - exit 1 -esac diff --git a/examples/transport-configs/init-scripts/msn-transport b/examples/transport-configs/init-scripts/msn-transport deleted file mode 100755 index 555ba2b0f..000000000 --- a/examples/transport-configs/init-scripts/msn-transport +++ /dev/null @@ -1,50 +0,0 @@ -#!/bin/sh -######################################################### -# -# msn-transport -- script to start MSN Transport. -# -######################################################### - -DAEMON=/usr/local/sbin/jabberd-msn-transport -CONF=/etc/jabber/msn-transport.xml -NAME=jabberd-msn-transport -HOME=/etc/jabber/ -USER=ejabberd - -######################################################### - -if [ "`/usr/bin/whoami`" != "$USER" ]; then - - echo "You need to be" $USER "user to run this script." - exit 1 -fi - -case "$1" in - strace) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME in strace mode." - strace -o /opt/ejabberd/var/log/jabber/strace.log $DAEMON -H $HOME -c $CONF & - ;; - debug) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME in debugging mode." - $DAEMON -D -H $HOME -c $CONF & - ;; - start) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME." - $DAEMON -H $HOME -c $CONF & - ;; - stop) - echo "Stopping $NAME." - killall $NAME & - ;; - restart|reload) - $0 stop - sleep 3 - $0 start - ;; - *) - echo "Usage: $0 {debug|start|stop|restart}" - exit 1 -esac diff --git a/examples/transport-configs/init-scripts/yahoo-transport-2 b/examples/transport-configs/init-scripts/yahoo-transport-2 deleted file mode 100755 index fde78a913..000000000 --- a/examples/transport-configs/init-scripts/yahoo-transport-2 +++ /dev/null @@ -1,45 +0,0 @@ -#!/bin/sh -############################################################## -# -# yahoo-transport-2 -- script to start Yahoo-transport-2. -# -############################################################# - -DAEMON=/usr/local/sbin/jabberd-yahoo-transport-2 -CONF=/etc/jabber/yahoo-transport-2.xml -NAME=jabberd-yahoo-transport-2 -HOME=/etc/jabber/ -USER=ejabberd - -############################################################# - -if [ "`/usr/bin/whoami`" != "$USER" ]; then - - echo "You need to be" $USER "user to run this script." - exit 1 -fi - -case "$1" in - debug) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME in debugging mode." - $DAEMON -D -H $HOME -c $CONF & - ;; - start) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME." - $DAEMON -H $HOME -c $CONF & - ;; - stop) - echo "Stopping $NAME." - killall $NAME & - ;; - restart|reload) - $0 stop - sleep 3 - $0 start - ;; - *) - echo "Usage: $0 {debug|start|stop|restart}" - exit 1 -esac diff --git a/src/Makefile.in b/src/Makefile.in index 808137a3c..f03f7fae8 100644 --- a/src/Makefile.in +++ b/src/Makefile.in @@ -166,7 +166,7 @@ $(ERLSHLIBS): %.so: %.c $(DYNAMIC_LIB_CFLAGS) translations: - ../contrib/extract_translations/prepare-translation.sh -updateall + ../tools/extract_translations/prepare-translation.sh -updateall install: all # @@ -248,9 +248,11 @@ install: all # # Documentation install -d $(DOCDIR) - install -m 644 ../doc/dev.html $(DOCDIR) - install -m 644 ../doc/guide.html $(DOCDIR) - install -m 644 ../doc/*.png $(DOCDIR) + [ -f ../doc/guide.html ] \ + && install -m 644 ../doc/dev.html $(DOCDIR) \ + && install -m 644 ../doc/guide.html $(DOCDIR) \ + && install -m 644 ../doc/*.png $(DOCDIR) \ + || echo "No ../doc/guide.html was built" install -m 644 ../doc/*.txt $(DOCDIR) [ -f ../doc/guide.pdf ] \ && install -m 644 ../doc/guide.pdf $(DOCDIR) \ diff --git a/src/cache_tab.erl b/src/cache_tab.erl new file mode 100644 index 000000000..6140453ca --- /dev/null +++ b/src/cache_tab.erl @@ -0,0 +1,563 @@ +%%%------------------------------------------------------------------- +%%% File : cache_tab.erl +%%% Author : Evgeniy Khramtsov <ekhramtsov@process-one.net> +%%% Description : Caching key-value table +%%% +%%% Created : 29 Aug 2010 by Evgeniy Khramtsov <ekhramtsov@process-one.net> +%%% +%%% +%%% ejabberd, Copyright (C) 2002-2010 ProcessOne +%%% +%%% This program is free software; you can redistribute it and/or +%%% modify it under the terms of the GNU General Public License as +%%% published by the Free Software Foundation; either version 2 of the +%%% License, or (at your option) any later version. +%%% +%%% This program is distributed in the hope that it will be useful, +%%% but WITHOUT ANY WARRANTY; without even the implied warranty of +%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +%%% General Public License for more details. +%%% +%%% You should have received a copy of the GNU General Public License +%%% along with this program; if not, write to the Free Software +%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA +%%% 02111-1307 USA +%%% +%%%------------------------------------------------------------------- +-module(cache_tab). + +-define(GEN_SERVER, gen_server). + +-behaviour(?GEN_SERVER). + +%% API +-export([start_link/4, new/2, delete/1, delete/3, lookup/3, + insert/4, info/2, tab2list/1, setopts/2, + dirty_lookup/3, dirty_insert/4, dirty_delete/3, + all/0, test/0]). + +%% gen_server callbacks +-export([init/1, handle_call/3, handle_cast/2, handle_info/2, + terminate/2, code_change/3]). + +-include("ejabberd.hrl"). + +-record(state, {tab = treap:empty(), + name, + size = 0, + owner, + max_size, + life_time, + warn, + hits = 0, + miss = 0, + procs_num, + cache_missed, + shrink_size}). + +-define(PROCNAME, ?MODULE). +-define(CALL_TIMEOUT, 60000). + +%% Defaults +-define(MAX_SIZE, 1000). +-define(WARN, true). +-define(CACHE_MISSED, true). +-define(LIFETIME, 600). %% 10 minutes + +%%==================================================================== +%% API +%%==================================================================== +start_link(Proc, Tab, Opts, Owner) -> + ?GEN_SERVER:start_link({local, Proc}, ?MODULE, + [Tab, Opts, get_proc_num(), Owner], []). + +new(Tab, Opts) -> + Res = lists:flatmap( + fun(Proc) -> + Spec = {{Tab, Proc}, + {?MODULE, start_link, + [Proc, Tab, Opts, self()]}, + permanent, + brutal_kill, + worker, + [?MODULE]}, + case supervisor:start_child(cache_tab_sup, Spec) of + {ok, _Pid} -> + [ok]; + R -> + [R] + end + end, get_all_procs(Tab)), + case lists:filter(fun(ok) -> false; (_) -> true end, Res) of + [] -> + ok; + Err -> + {error, Err} + end. + +delete(Tab) -> + lists:foreach( + fun(Proc) -> + supervisor:terminate_child(cache_tab_sup, {Tab, Proc}), + supervisor:delete_child(cache_tab_sup, {Tab, Proc}) + end, get_all_procs(Tab)). + +delete(Tab, Key, F) -> + ?GEN_SERVER:call( + get_proc_by_hash(Tab, Key), {delete, Key, F}, ?CALL_TIMEOUT). + +dirty_delete(Tab, Key, F) -> + F(), + ?GEN_SERVER:call( + get_proc_by_hash(Tab, Key), {dirty_delete, Key}, ?CALL_TIMEOUT). + +lookup(Tab, Key, F) -> + ?GEN_SERVER:call( + get_proc_by_hash(Tab, Key), {lookup, Key, F}, ?CALL_TIMEOUT). + +dirty_lookup(Tab, Key, F) -> + Proc = get_proc_by_hash(Tab, Key), + case ?GEN_SERVER:call(Proc, {dirty_lookup, Key}, ?CALL_TIMEOUT) of + {ok, '$cached_mismatch'} -> + error; + {ok, Val} -> + {ok, Val}; + _ -> + case F() of + {ok, Val} -> + ?GEN_SERVER:call( + Proc, {dirty_insert, Key, Val}, ?CALL_TIMEOUT), + {ok, Val}; + _ -> + error + end + end. + +insert(Tab, Key, Val, F) -> + ?GEN_SERVER:call( + get_proc_by_hash(Tab, Key), {insert, Key, Val, F}, ?CALL_TIMEOUT). + +dirty_insert(Tab, Key, Val, F) -> + F(), + ?GEN_SERVER:call( + get_proc_by_hash(Tab, Key), {dirty_insert, Key, Val}, ?CALL_TIMEOUT). + +info(Tab, Info) -> + case lists:map( + fun(Proc) -> + ?GEN_SERVER:call(Proc, {info, Info}, ?CALL_TIMEOUT) + end, get_all_procs(Tab)) of + Res when Info == size -> + {ok, lists:sum(Res)}; + Res when Info == all -> + {ok, Res}; + Res when Info == ratio -> + {H, M} = lists:foldl( + fun({Hits, Miss}, {HitsAcc, MissAcc}) -> + {HitsAcc + Hits, MissAcc + Miss} + end, {0, 0}, Res), + {ok, [{hits, H}, {miss, M}]}; + _ -> + {error, badarg} + end. + +setopts(Tab, Opts) -> + lists:foreach( + fun(Proc) -> + ?GEN_SERVER:call(Proc, {setopts, Opts}, ?CALL_TIMEOUT) + end, get_all_procs(Tab)). + +tab2list(Tab) -> + lists:flatmap( + fun(Proc) -> + ?GEN_SERVER:call(Proc, tab2list, ?CALL_TIMEOUT) + end, get_all_procs(Tab)). + +all() -> + lists:usort( + [Tab || {{Tab, _}, _, _, _} <- supervisor:which_children(cache_tab_sup)]). + +%%==================================================================== +%% gen_server callbacks +%%==================================================================== +init([Tab, Opts, N, Pid]) -> + State = #state{procs_num = N, + owner = Pid, + name = Tab}, + {ok, do_setopts(State, Opts)}. + +handle_call({lookup, Key, F}, _From, #state{tab = T} = State) -> + case treap:lookup(Key, T) of + {ok, _Prio, Val} -> + Hits = State#state.hits, + NewState = treap_update(Key, Val, State#state{hits = Hits + 1}), + case Val of + '$cached_mismatch' -> + {reply, error, NewState}; + _ -> + {reply, {ok, Val}, NewState} + end; + _ -> + case catch F() of + {ok, Val} -> + Miss = State#state.miss, + NewState = treap_insert(Key, Val, State), + {reply, {ok, Val}, NewState#state{miss = Miss + 1}}; + {'EXIT', Reason} -> + print_error(lookup, [Key], Reason, State), + {reply, error, State}; + _ -> + Miss = State#state.miss, + NewState = State#state{miss = Miss + 1}, + if State#state.cache_missed -> + {reply, error, + treap_insert(Key, '$cached_mismatch', NewState)}; + true -> + {reply, error, NewState} + end + end + end; +handle_call({dirty_lookup, Key}, _From, #state{tab = T} = State) -> + case treap:lookup(Key, T) of + {ok, _Prio, Val} -> + Hits = State#state.hits, + NewState = treap_update(Key, Val, State#state{hits = Hits + 1}), + {reply, {ok, Val}, NewState}; + _ -> + Miss = State#state.miss, + NewState = State#state{miss = Miss + 1}, + if State#state.cache_missed -> + {reply, error, + treap_insert(Key, '$cached_mismatch', NewState)}; + true -> + {reply, error, NewState} + end + end; +handle_call({insert, Key, Val, F}, _From, #state{tab = T} = State) -> + case treap:lookup(Key, T) of + {ok, _Prio, Val} -> + {reply, ok, State}; + Res -> + case catch F() of + {'EXIT', Reason} -> + print_error(insert, [Key, Val], Reason, State), + {reply, ok, State}; + _ -> + NewState = case Res of + {ok, _, _} -> + treap_update(Key, Val, State); + _ -> + treap_insert(Key, Val, State) + end, + {reply, ok, NewState} + end + end; +handle_call({dirty_insert, Key, Val}, _From, #state{tab = T} = State) -> + case treap:lookup(Key, T) of + {ok, _Prio, Val} -> + {reply, ok, State}; + {ok, _, _} -> + {reply, ok, treap_update(Key, Val, State)}; + _ -> + {reply, ok, treap_insert(Key, Val, State)} + end; +handle_call({delete, Key, F}, _From, State) -> + NewState = treap_delete(Key, State), + case catch F() of + {'EXIT', Reason} -> + print_error(delete, [Key], Reason, State); + _ -> + ok + end, + {reply, ok, NewState}; +handle_call({dirty_delete, Key}, _From, State) -> + NewState = treap_delete(Key, State), + {reply, ok, NewState}; +handle_call({info, Info}, _From, State) -> + Res = case Info of + size -> + State#state.size; + ratio -> + {State#state.hits, State#state.miss}; + all -> + [{max_size, State#state.max_size}, + {life_time, State#state.life_time}, + {shrink_size, State#state.shrink_size}, + {size, State#state.size}, + {owner, State#state.owner}, + {hits, State#state.hits}, + {miss, State#state.miss}, + {cache_missed, State#state.cache_missed}, + {warn, State#state.warn}]; + _ -> + badarg + end, + {reply, Res, State}; +handle_call(tab2list, _From, #state{tab = T} = State) -> + Res = treap:fold( + fun({Key, _, Val}, Acc) -> + [{Key, Val}|Acc] + end, [], T), + {reply, Res, State}; +handle_call({setopts, Opts}, _From, State) -> + {reply, ok, do_setopts(State, Opts)}; +handle_call(_Request, _From, State) -> + Reply = ok, + {reply, Reply, State}. + +handle_cast(_Msg, State) -> + {noreply, State}. + +handle_info(_Info, State) -> + {noreply, State}. + +terminate(_Reason, _State) -> + ok. + +code_change(_OldVsn, State, _Extra) -> + {ok, State}. + +%%-------------------------------------------------------------------- +%%% Internal functions +%%-------------------------------------------------------------------- +do_setopts(#state{procs_num = N} = State, Opts) -> + MaxSize = case {proplists:get_value(max_size, Opts), + State#state.max_size} of + {MS, _} when is_integer(MS), MS > 0 -> + round(MS/N); + {unlimited, _} -> + unlimited; + {_, undefined} -> + round(?MAX_SIZE/N); + {_, MS} -> + MS + end, + LifeTime = case {proplists:get_value(life_time, Opts), + State#state.life_time} of + {LT, _} when is_integer(LT), LT > 0 -> + LT*1000*1000; + {unlimited, _} -> + unlimited; + {_, undefined} -> + ?LIFETIME*1000*1000; + {_, LT} -> + LT + end, + ShrinkSize = case {proplists:get_value(shrink_size, Opts), + State#state.shrink_size} of + {SS, _} when is_integer(SS), SS > 0 -> + round(SS/N); + _ when is_integer(MaxSize) -> + round(MaxSize/2); + _ -> + unlimited + end, + Warn = case {proplists:get_value(warn, Opts), + State#state.warn} of + {true, _} -> + true; + {false, _} -> + false; + {_, undefined} -> + ?WARN; + {_, W} -> + W + end, + CacheMissed = case proplists:get_value( + cache_missed, Opts, State#state.cache_missed) of + false -> + false; + true -> + true; + _ -> + ?CACHE_MISSED + end, + State#state{max_size = MaxSize, + warn = Warn, + life_time = LifeTime, + cache_missed = CacheMissed, + shrink_size = ShrinkSize}. + +get_proc_num() -> + erlang:system_info(logical_processors). + +get_proc_by_hash(Tab, Term) -> + N = erlang:phash2(Term, get_proc_num()) + 1, + get_proc(Tab, N). + +get_proc(Tab, N) -> + list_to_atom(atom_to_list(?PROCNAME) ++ "_" ++ + atom_to_list(Tab) ++ "_" ++ integer_to_list(N)). + +get_all_procs(Tab) -> + [get_proc(Tab, N) || N <- lists:seq(1, get_proc_num())]. + +now_priority() -> + {MSec, Sec, USec} = now(), + -((MSec*1000000 + Sec)*1000000 + USec). + +treap_update(Key, Val, #state{tab = T} = State) -> + Priority = now_priority(), + NewT = treap:insert(Key, Priority, Val, T), + State#state{tab = NewT}. + +treap_insert(Key, Val, State) -> + State1 = clean_treap(State), + #state{size = Size} = State2 = shrink_treap(State1), + treap_update(Key, Val, State2#state{size = Size+1}). + +treap_delete(Key, #state{tab = T, size = Size} = State) -> + case treap:lookup(Key, T) of + {ok, _, _} -> + NewT = treap:delete(Key, T), + clean_treap(State#state{tab = NewT, size = Size-1}); + _ -> + State + end. + +clean_treap(#state{tab = T, size = Size, life_time = LifeTime} = State) -> + if is_integer(LifeTime) -> + Priority = now_priority(), + {Cleaned, NewT} = clean_treap(T, Priority + LifeTime, 0), + State#state{size = Size - Cleaned, tab = NewT}; + true -> + State + end. + +clean_treap(Treap, CleanPriority, N) -> + case treap:is_empty(Treap) of + true -> + {N, Treap}; + false -> + {_Key, Priority, _Value} = treap:get_root(Treap), + if Priority > CleanPriority -> + clean_treap(treap:delete_root(Treap), CleanPriority, N+1); + true -> + {N, Treap} + end + end. + +shrink_treap(#state{tab = T, + max_size = MaxSize, + shrink_size = ShrinkSize, + warn = Warn, + size = Size} = State) when Size >= MaxSize -> + if Warn -> + ?WARNING_MSG("shrinking table:~n" + "** Table: ~p~n" + "** Processes Number: ~p~n" + "** Max Size: ~p items~n" + "** Shrink Size: ~p items~n" + "** Life Time: ~p microseconds~n" + "** Hits/Miss: ~p/~p~n" + "** Owner: ~p~n" + "** Cache Missed: ~p~n" + "** Instruction: you have to tune cacheing options" + " if this message repeats too frequently", + [State#state.name, State#state.procs_num, + MaxSize, ShrinkSize, State#state.life_time, + State#state.hits, State#state.miss, + State#state.owner, State#state.cache_missed]); + true -> + ok + end, + {Shrinked, NewT} = shrink_treap(T, ShrinkSize, 0), + State#state{tab = NewT, size = Size - Shrinked}; +shrink_treap(State) -> + State. + +shrink_treap(T, ShrinkSize, ShrinkSize) -> + {ShrinkSize, T}; +shrink_treap(T, ShrinkSize, N) -> + case treap:is_empty(T) of + true -> + {N, T}; + false -> + shrink_treap(treap:delete_root(T), ShrinkSize, N+1) + end. + +print_error(Operation, Args, Reason, State) -> + ?ERROR_MSG("callback failed:~n" + "** Tab: ~p~n" + "** Owner: ~p~n" + "** Operation: ~p~n" + "** Args: ~p~n" + "** Reason: ~p", + [State#state.name, State#state.owner, + Operation, Args, Reason]). + +%%-------------------------------------------------------------------- +%%% Tests +%%-------------------------------------------------------------------- +-define(lookup, dirty_lookup). +-define(delete, dirty_delete). +-define(insert, dirty_insert). +%% -define(lookup, lookup). +%% -define(delete, delete). +%% -define(insert, insert). + +test() -> + LifeTime = 2, + ok = new(test_tbl, [{life_time, LifeTime}, {max_size, unlimited}]), + check([]), + ok = ?insert(test_tbl, "key", "value", fun() -> ok end), + check([{"key", "value"}]), + {ok, "value"} = ?lookup(test_tbl, "key", fun() -> error end), + check([{"key", "value"}]), + io:format("** waiting for ~p seconds to check if cleaner works fine...~n", + [LifeTime+1]), + timer:sleep(timer:seconds(LifeTime+1)), + ok = ?insert(test_tbl, "key1", "value1", fun() -> ok end), + check([{"key1", "value1"}]), + ok = ?delete(test_tbl, "key1", fun() -> ok end), + {ok, "value"} = ?lookup(test_tbl, "key", fun() -> {ok, "value"} end), + check([{"key", "value"}]), + ok = ?delete(test_tbl, "key", fun() -> ok end), + check([]), + %% io:format("** testing buggy callbacks...~n"), + %% delete(test_tbl, "key", fun() -> erlang:error(badarg) end), + %% insert(test_tbl, "key", "val", fun() -> erlang:error(badarg) end), + %% lookup(test_tbl, "key", fun() -> erlang:error(badarg) end), + check([]), + delete(test_tbl), + test1(). + +test1() -> + MaxSize = 10, + ok = new(test_tbl, [{max_size, MaxSize}, {shrink_size, 1}, {warn, false}]), + lists:foreach( + fun(N) -> + ok = ?insert(test_tbl, N, N, fun() -> ok end) + end, lists:seq(1, MaxSize*get_proc_num())), + {ok, MaxSize} = info(test_tbl, size), + delete(test_tbl), + io:format("** testing speed, this may take a while...~n"), + test2(1000), + test2(10000), + test2(100000), + test2(1000000). + +test2(Iter) -> + ok = new(test_tbl, [{max_size, unlimited}, {life_time, unlimited}]), + L = lists:seq(1, Iter), + T1 = now(), + lists:foreach( + fun(N) -> + ok = ?insert(test_tbl, N, N, fun() -> ok end) + end, L), + io:format("** average insert (size = ~p): ~p usec~n", + [Iter, round(timer:now_diff(now(), T1)/Iter)]), + T2 = now(), + lists:foreach( + fun(N) -> + {ok, N} = ?lookup(test_tbl, N, fun() -> ok end) + end, L), + io:format("** average lookup (size = ~p): ~p usec~n", + [Iter, round(timer:now_diff(now(), T2)/Iter)]), + {ok, Iter} = info(test_tbl, size), + delete(test_tbl). + +check(List) -> + Size = length(List), + {ok, Size} = info(test_tbl, size), + List = tab2list(test_tbl). diff --git a/src/cache_tab_sup.erl b/src/cache_tab_sup.erl new file mode 100644 index 000000000..a49593f5e --- /dev/null +++ b/src/cache_tab_sup.erl @@ -0,0 +1,53 @@ +%%%------------------------------------------------------------------- +%%% File : cache_tab_sup.erl +%%% Author : Evgeniy Khramtsov <ekhramtsov@process-one.net> +%%% Description : Cache tables supervisor +%%% +%%% Created : 30 Aug 2010 by Evgeniy Khramtsov <ekhramtsov@process-one.net> +%%% +%%% +%%% ejabberd, Copyright (C) 2002-2010 ProcessOne +%%% +%%% This program is free software; you can redistribute it and/or +%%% modify it under the terms of the GNU General Public License as +%%% published by the Free Software Foundation; either version 2 of the +%%% License, or (at your option) any later version. +%%% +%%% This program is distributed in the hope that it will be useful, +%%% but WITHOUT ANY WARRANTY; without even the implied warranty of +%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +%%% General Public License for more details. +%%% +%%% You should have received a copy of the GNU General Public License +%%% along with this program; if not, write to the Free Software +%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA +%%% 02111-1307 USA +%%% +%%%------------------------------------------------------------------- +-module(cache_tab_sup). + +-behaviour(supervisor). + +%% API +-export([start_link/0]). + +%% Supervisor callbacks +-export([init/1]). + +-define(SERVER, ?MODULE). + +%%==================================================================== +%% API functions +%%==================================================================== +start_link() -> + supervisor:start_link({local, ?SERVER}, ?MODULE, []). + +%%==================================================================== +%% Supervisor callbacks +%%==================================================================== +init([]) -> + {ok, {{one_for_one,10,1}, []}}. + +%%==================================================================== +%% Internal functions +%%==================================================================== diff --git a/src/configure b/src/configure deleted file mode 100755 index a71534543..000000000 --- a/src/configure +++ /dev/null @@ -1,5977 +0,0 @@ -#! /bin/sh -# Guess values for system-dependent variables and create Makefiles. -# Generated by GNU Autoconf 2.65 for ejabberd 3.0.0-alpha-x. -# -# Report bugs to <ejabberd@process-one.net>. -# -# -# Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, -# 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, -# Inc. -# -# -# This configure script is free software; the Free Software Foundation -# gives unlimited permission to copy, distribute and modify it. -## -------------------- ## -## M4sh Initialization. ## -## -------------------- ## - -# Be more Bourne compatible -DUALCASE=1; export DUALCASE # for MKS sh -if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then : - emulate sh - NULLCMD=: - # Pre-4.2 versions of Zsh do word splitting on ${1+"$@"}, which - # is contrary to our usage. Disable this feature. - alias -g '${1+"$@"}'='"$@"' - setopt NO_GLOB_SUBST -else - case `(set -o) 2>/dev/null` in #( - *posix*) : - set -o posix ;; #( - *) : - ;; -esac -fi - - -as_nl=' -' -export as_nl -# Printing a long string crashes Solaris 7 /usr/bin/printf. -as_echo='\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\' -as_echo=$as_echo$as_echo$as_echo$as_echo$as_echo -as_echo=$as_echo$as_echo$as_echo$as_echo$as_echo$as_echo -# Prefer a ksh shell builtin over an external printf program on Solaris, -# but without wasting forks for bash or zsh. -if test -z "$BASH_VERSION$ZSH_VERSION" \ - && (test "X`print -r -- $as_echo`" = "X$as_echo") 2>/dev/null; then - as_echo='print -r --' - as_echo_n='print -rn --' -elif (test "X`printf %s $as_echo`" = "X$as_echo") 2>/dev/null; then - as_echo='printf %s\n' - as_echo_n='printf %s' -else - if test "X`(/usr/ucb/echo -n -n $as_echo) 2>/dev/null`" = "X-n $as_echo"; then - as_echo_body='eval /usr/ucb/echo -n "$1$as_nl"' - as_echo_n='/usr/ucb/echo -n' - else - as_echo_body='eval expr "X$1" : "X\\(.*\\)"' - as_echo_n_body='eval - arg=$1; - case $arg in #( - *"$as_nl"*) - expr "X$arg" : "X\\(.*\\)$as_nl"; - arg=`expr "X$arg" : ".*$as_nl\\(.*\\)"`;; - esac; - expr "X$arg" : "X\\(.*\\)" | tr -d "$as_nl" - ' - export as_echo_n_body - as_echo_n='sh -c $as_echo_n_body as_echo' - fi - export as_echo_body - as_echo='sh -c $as_echo_body as_echo' -fi - -# The user is always right. -if test "${PATH_SEPARATOR+set}" != set; then - PATH_SEPARATOR=: - (PATH='/bin;/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 && { - (PATH='/bin:/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 || - PATH_SEPARATOR=';' - } -fi - - -# IFS -# We need space, tab and new line, in precisely that order. Quoting is -# there to prevent editors from complaining about space-tab. -# (If _AS_PATH_WALK were called with IFS unset, it would disable word -# splitting by setting IFS to empty value.) -IFS=" "" $as_nl" - -# Find who we are. Look in the path if we contain no directory separator. -case $0 in #(( - *[\\/]* ) as_myself=$0 ;; - *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - test -r "$as_dir/$0" && as_myself=$as_dir/$0 && break - done -IFS=$as_save_IFS - - ;; -esac -# We did not find ourselves, most probably we were run as `sh COMMAND' -# in which case we are not to be found in the path. -if test "x$as_myself" = x; then - as_myself=$0 -fi -if test ! -f "$as_myself"; then - $as_echo "$as_myself: error: cannot find myself; rerun with an absolute file name" >&2 - exit 1 -fi - -# Unset variables that we do not need and which cause bugs (e.g. in -# pre-3.0 UWIN ksh). But do not cause bugs in bash 2.01; the "|| exit 1" -# suppresses any "Segmentation fault" message there. '((' could -# trigger a bug in pdksh 5.2.14. -for as_var in BASH_ENV ENV MAIL MAILPATH -do eval test x\${$as_var+set} = xset \ - && ( (unset $as_var) || exit 1) >/dev/null 2>&1 && unset $as_var || : -done -PS1='$ ' -PS2='> ' -PS4='+ ' - -# NLS nuisances. -LC_ALL=C -export LC_ALL -LANGUAGE=C -export LANGUAGE - -# CDPATH. -(unset CDPATH) >/dev/null 2>&1 && unset CDPATH - -if test "x$CONFIG_SHELL" = x; then - as_bourne_compatible="if test -n \"\${ZSH_VERSION+set}\" && (emulate sh) >/dev/null 2>&1; then : - emulate sh - NULLCMD=: - # Pre-4.2 versions of Zsh do word splitting on \${1+\"\$@\"}, which - # is contrary to our usage. Disable this feature. - alias -g '\${1+\"\$@\"}'='\"\$@\"' - setopt NO_GLOB_SUBST -else - case \`(set -o) 2>/dev/null\` in #( - *posix*) : - set -o posix ;; #( - *) : - ;; -esac -fi -" - as_required="as_fn_return () { (exit \$1); } -as_fn_success () { as_fn_return 0; } -as_fn_failure () { as_fn_return 1; } -as_fn_ret_success () { return 0; } -as_fn_ret_failure () { return 1; } - -exitcode=0 -as_fn_success || { exitcode=1; echo as_fn_success failed.; } -as_fn_failure && { exitcode=1; echo as_fn_failure succeeded.; } -as_fn_ret_success || { exitcode=1; echo as_fn_ret_success failed.; } -as_fn_ret_failure && { exitcode=1; echo as_fn_ret_failure succeeded.; } -if ( set x; as_fn_ret_success y && test x = \"\$1\" ); then : - -else - exitcode=1; echo positional parameters were not saved. -fi -test x\$exitcode = x0 || exit 1" - as_suggested=" as_lineno_1=";as_suggested=$as_suggested$LINENO;as_suggested=$as_suggested" as_lineno_1a=\$LINENO - as_lineno_2=";as_suggested=$as_suggested$LINENO;as_suggested=$as_suggested" as_lineno_2a=\$LINENO - eval 'test \"x\$as_lineno_1'\$as_run'\" != \"x\$as_lineno_2'\$as_run'\" && - test \"x\`expr \$as_lineno_1'\$as_run' + 1\`\" = \"x\$as_lineno_2'\$as_run'\"' || exit 1 -test \$(( 1 + 1 )) = 2 || exit 1" - if (eval "$as_required") 2>/dev/null; then : - as_have_required=yes -else - as_have_required=no -fi - if test x$as_have_required = xyes && (eval "$as_suggested") 2>/dev/null; then : - -else - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -as_found=false -for as_dir in /bin$PATH_SEPARATOR/usr/bin$PATH_SEPARATOR$PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - as_found=: - case $as_dir in #( - /*) - for as_base in sh bash ksh sh5; do - # Try only shells that exist, to save several forks. - as_shell=$as_dir/$as_base - if { test -f "$as_shell" || test -f "$as_shell.exe"; } && - { $as_echo "$as_bourne_compatible""$as_required" | as_run=a "$as_shell"; } 2>/dev/null; then : - CONFIG_SHELL=$as_shell as_have_required=yes - if { $as_echo "$as_bourne_compatible""$as_suggested" | as_run=a "$as_shell"; } 2>/dev/null; then : - break 2 -fi -fi - done;; - esac - as_found=false -done -$as_found || { if { test -f "$SHELL" || test -f "$SHELL.exe"; } && - { $as_echo "$as_bourne_compatible""$as_required" | as_run=a "$SHELL"; } 2>/dev/null; then : - CONFIG_SHELL=$SHELL as_have_required=yes -fi; } -IFS=$as_save_IFS - - - if test "x$CONFIG_SHELL" != x; then : - # We cannot yet assume a decent shell, so we have to provide a - # neutralization value for shells without unset; and this also - # works around shells that cannot unset nonexistent variables. - BASH_ENV=/dev/null - ENV=/dev/null - (unset BASH_ENV) >/dev/null 2>&1 && unset BASH_ENV ENV - export CONFIG_SHELL - exec "$CONFIG_SHELL" "$as_myself" ${1+"$@"} -fi - - if test x$as_have_required = xno; then : - $as_echo "$0: This script requires a shell more modern than all" - $as_echo "$0: the shells that I found on your system." - if test x${ZSH_VERSION+set} = xset ; then - $as_echo "$0: In particular, zsh $ZSH_VERSION has bugs and should" - $as_echo "$0: be upgraded to zsh 4.3.4 or later." - else - $as_echo "$0: Please tell bug-autoconf@gnu.org and -$0: ejabberd@process-one.net about your system, including -$0: any error possibly output before this message. Then -$0: install a modern shell, or manually run the script -$0: under such a shell if you do have one." - fi - exit 1 -fi -fi -fi -SHELL=${CONFIG_SHELL-/bin/sh} -export SHELL -# Unset more variables known to interfere with behavior of common tools. -CLICOLOR_FORCE= GREP_OPTIONS= -unset CLICOLOR_FORCE GREP_OPTIONS - -## --------------------- ## -## M4sh Shell Functions. ## -## --------------------- ## -# as_fn_unset VAR -# --------------- -# Portably unset VAR. -as_fn_unset () -{ - { eval $1=; unset $1;} -} -as_unset=as_fn_unset - -# as_fn_set_status STATUS -# ----------------------- -# Set $? to STATUS, without forking. -as_fn_set_status () -{ - return $1 -} # as_fn_set_status - -# as_fn_exit STATUS -# ----------------- -# Exit the shell with STATUS, even in a "trap 0" or "set -e" context. -as_fn_exit () -{ - set +e - as_fn_set_status $1 - exit $1 -} # as_fn_exit - -# as_fn_mkdir_p -# ------------- -# Create "$as_dir" as a directory, including parents if necessary. -as_fn_mkdir_p () -{ - - case $as_dir in #( - -*) as_dir=./$as_dir;; - esac - test -d "$as_dir" || eval $as_mkdir_p || { - as_dirs= - while :; do - case $as_dir in #( - *\'*) as_qdir=`$as_echo "$as_dir" | sed "s/'/'\\\\\\\\''/g"`;; #'( - *) as_qdir=$as_dir;; - esac - as_dirs="'$as_qdir' $as_dirs" - as_dir=`$as_dirname -- "$as_dir" || -$as_expr X"$as_dir" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ - X"$as_dir" : 'X\(//\)[^/]' \| \ - X"$as_dir" : 'X\(//\)$' \| \ - X"$as_dir" : 'X\(/\)' \| . 2>/dev/null || -$as_echo X"$as_dir" | - sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ - s//\1/ - q - } - /^X\(\/\/\)[^/].*/{ - s//\1/ - q - } - /^X\(\/\/\)$/{ - s//\1/ - q - } - /^X\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - test -d "$as_dir" && break - done - test -z "$as_dirs" || eval "mkdir $as_dirs" - } || test -d "$as_dir" || as_fn_error "cannot create directory $as_dir" - - -} # as_fn_mkdir_p -# as_fn_append VAR VALUE -# ---------------------- -# Append the text in VALUE to the end of the definition contained in VAR. Take -# advantage of any shell optimizations that allow amortized linear growth over -# repeated appends, instead of the typical quadratic growth present in naive -# implementations. -if (eval "as_var=1; as_var+=2; test x\$as_var = x12") 2>/dev/null; then : - eval 'as_fn_append () - { - eval $1+=\$2 - }' -else - as_fn_append () - { - eval $1=\$$1\$2 - } -fi # as_fn_append - -# as_fn_arith ARG... -# ------------------ -# Perform arithmetic evaluation on the ARGs, and store the result in the -# global $as_val. Take advantage of shells that can avoid forks. The arguments -# must be portable across $(()) and expr. -if (eval "test \$(( 1 + 1 )) = 2") 2>/dev/null; then : - eval 'as_fn_arith () - { - as_val=$(( $* )) - }' -else - as_fn_arith () - { - as_val=`expr "$@" || test $? -eq 1` - } -fi # as_fn_arith - - -# as_fn_error ERROR [LINENO LOG_FD] -# --------------------------------- -# Output "`basename $0`: error: ERROR" to stderr. If LINENO and LOG_FD are -# provided, also output the error to LOG_FD, referencing LINENO. Then exit the -# script with status $?, using 1 if that was 0. -as_fn_error () -{ - as_status=$?; test $as_status -eq 0 && as_status=1 - if test "$3"; then - as_lineno=${as_lineno-"$2"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - $as_echo "$as_me:${as_lineno-$LINENO}: error: $1" >&$3 - fi - $as_echo "$as_me: error: $1" >&2 - as_fn_exit $as_status -} # as_fn_error - -if expr a : '\(a\)' >/dev/null 2>&1 && - test "X`expr 00001 : '.*\(...\)'`" = X001; then - as_expr=expr -else - as_expr=false -fi - -if (basename -- /) >/dev/null 2>&1 && test "X`basename -- / 2>&1`" = "X/"; then - as_basename=basename -else - as_basename=false -fi - -if (as_dir=`dirname -- /` && test "X$as_dir" = X/) >/dev/null 2>&1; then - as_dirname=dirname -else - as_dirname=false -fi - -as_me=`$as_basename -- "$0" || -$as_expr X/"$0" : '.*/\([^/][^/]*\)/*$' \| \ - X"$0" : 'X\(//\)$' \| \ - X"$0" : 'X\(/\)' \| . 2>/dev/null || -$as_echo X/"$0" | - sed '/^.*\/\([^/][^/]*\)\/*$/{ - s//\1/ - q - } - /^X\/\(\/\/\)$/{ - s//\1/ - q - } - /^X\/\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - -# Avoid depending upon Character Ranges. -as_cr_letters='abcdefghijklmnopqrstuvwxyz' -as_cr_LETTERS='ABCDEFGHIJKLMNOPQRSTUVWXYZ' -as_cr_Letters=$as_cr_letters$as_cr_LETTERS -as_cr_digits='0123456789' -as_cr_alnum=$as_cr_Letters$as_cr_digits - - - as_lineno_1=$LINENO as_lineno_1a=$LINENO - as_lineno_2=$LINENO as_lineno_2a=$LINENO - eval 'test "x$as_lineno_1'$as_run'" != "x$as_lineno_2'$as_run'" && - test "x`expr $as_lineno_1'$as_run' + 1`" = "x$as_lineno_2'$as_run'"' || { - # Blame Lee E. McMahon (1931-1989) for sed's syntax. :-) - sed -n ' - p - /[$]LINENO/= - ' <$as_myself | - sed ' - s/[$]LINENO.*/&-/ - t lineno - b - :lineno - N - :loop - s/[$]LINENO\([^'$as_cr_alnum'_].*\n\)\(.*\)/\2\1\2/ - t loop - s/-\n.*// - ' >$as_me.lineno && - chmod +x "$as_me.lineno" || - { $as_echo "$as_me: error: cannot create $as_me.lineno; rerun with a POSIX shell" >&2; as_fn_exit 1; } - - # Don't try to exec as it changes $[0], causing all sort of problems - # (the dirname of $[0] is not the place where we might find the - # original and so on. Autoconf is especially sensitive to this). - . "./$as_me.lineno" - # Exit status is that of the last command. - exit -} - -ECHO_C= ECHO_N= ECHO_T= -case `echo -n x` in #((((( --n*) - case `echo 'xy\c'` in - *c*) ECHO_T=' ';; # ECHO_T is single tab character. - xy) ECHO_C='\c';; - *) echo `echo ksh88 bug on AIX 6.1` > /dev/null - ECHO_T=' ';; - esac;; -*) - ECHO_N='-n';; -esac - -rm -f conf$$ conf$$.exe conf$$.file -if test -d conf$$.dir; then - rm -f conf$$.dir/conf$$.file -else - rm -f conf$$.dir - mkdir conf$$.dir 2>/dev/null -fi -if (echo >conf$$.file) 2>/dev/null; then - if ln -s conf$$.file conf$$ 2>/dev/null; then - as_ln_s='ln -s' - # ... but there are two gotchas: - # 1) On MSYS, both `ln -s file dir' and `ln file dir' fail. - # 2) DJGPP < 2.04 has no symlinks; `ln -s' creates a wrapper executable. - # In both cases, we have to default to `cp -p'. - ln -s conf$$.file conf$$.dir 2>/dev/null && test ! -f conf$$.exe || - as_ln_s='cp -p' - elif ln conf$$.file conf$$ 2>/dev/null; then - as_ln_s=ln - else - as_ln_s='cp -p' - fi -else - as_ln_s='cp -p' -fi -rm -f conf$$ conf$$.exe conf$$.dir/conf$$.file conf$$.file -rmdir conf$$.dir 2>/dev/null - -if mkdir -p . 2>/dev/null; then - as_mkdir_p='mkdir -p "$as_dir"' -else - test -d ./-p && rmdir ./-p - as_mkdir_p=false -fi - -if test -x / >/dev/null 2>&1; then - as_test_x='test -x' -else - if ls -dL / >/dev/null 2>&1; then - as_ls_L_option=L - else - as_ls_L_option= - fi - as_test_x=' - eval sh -c '\'' - if test -d "$1"; then - test -d "$1/."; - else - case $1 in #( - -*)set "./$1";; - esac; - case `ls -ld'$as_ls_L_option' "$1" 2>/dev/null` in #(( - ???[sx]*):;;*)false;;esac;fi - '\'' sh - ' -fi -as_executable_p=$as_test_x - -# Sed expression to map a string onto a valid CPP name. -as_tr_cpp="eval sed 'y%*$as_cr_letters%P$as_cr_LETTERS%;s%[^_$as_cr_alnum]%_%g'" - -# Sed expression to map a string onto a valid variable name. -as_tr_sh="eval sed 'y%*+%pp%;s%[^_$as_cr_alnum]%_%g'" - - -test -n "$DJDIR" || exec 7<&0 </dev/null -exec 6>&1 - -# Name of the host. -# hostname on some systems (SVR3.2, Linux) returns a bogus exit status, -# so uname gets run too. -ac_hostname=`(hostname || uname -n) 2>/dev/null | sed 1q` - -# -# Initializations. -# -ac_default_prefix=/usr/local -ac_clean_files= -ac_config_libobj_dir=. -LIBOBJS= -cross_compiling=no -subdirs= -MFLAGS= -MAKEFLAGS= - -# Identity of this package. -PACKAGE_NAME='ejabberd' -PACKAGE_TARNAME='ejabberd' -PACKAGE_VERSION='3.0.0-alpha-x' -PACKAGE_STRING='ejabberd 3.0.0-alpha-x' -PACKAGE_BUGREPORT='ejabberd@process-one.net' -PACKAGE_URL='' - -ac_default_prefix=/ -# Factoring default headers for most tests. -ac_includes_default="\ -#include <stdio.h> -#ifdef HAVE_SYS_TYPES_H -# include <sys/types.h> -#endif -#ifdef HAVE_SYS_STAT_H -# include <sys/stat.h> -#endif -#ifdef STDC_HEADERS -# include <stdlib.h> -# include <stddef.h> -#else -# ifdef HAVE_STDLIB_H -# include <stdlib.h> -# endif -#endif -#ifdef HAVE_STRING_H -# if !defined STDC_HEADERS && defined HAVE_MEMORY_H -# include <memory.h> -# endif -# include <string.h> -#endif -#ifdef HAVE_STRINGS_H -# include <strings.h> -#endif -#ifdef HAVE_INTTYPES_H -# include <inttypes.h> -#endif -#ifdef HAVE_STDINT_H -# include <stdint.h> -#endif -#ifdef HAVE_UNISTD_H -# include <unistd.h> -#endif" - -ac_subst_vars='LTLIBOBJS -ERLCFLAGS -target_os -target_vendor -target_cpu -target -host_os -host_vendor -host_cpu -host -build_os -build_vendor -build_cpu -build -md2 -INSTALLUSER -SSL_CFLAGS -SSL_LIBS -full_xml -transient_supervisors -db_type -roster_gateway_workaround -hipe -PAM_LIBS -PAM_CFLAGS -make_pam -pam -ZLIB_LIBS -ZLIB_CFLAGS -make_ejabberd_zlib -ejabberd_zlib -make_web -web -make_tls -tls -make_odbc -odbc -make_eldap -eldap -make_mod_pubsub -mod_pubsub -make_mod_proxy65 -mod_proxy65 -make_mod_muc -mod_muc -LIBOBJS -EGREP -GREP -CPP -ERLANG_EXMPP -ERLANG_LIBS -ERLANG_CFLAGS -ERL -ERLC -SET_MAKE -OBJEXT -EXEEXT -ac_ct_CC -CPPFLAGS -LDFLAGS -CFLAGS -CC -target_alias -host_alias -build_alias -LIBS -ECHO_T -ECHO_N -ECHO_C -DEFS -mandir -localedir -libdir -psdir -pdfdir -dvidir -htmldir -infodir -docdir -oldincludedir -includedir -localstatedir -sharedstatedir -sysconfdir -datadir -datarootdir -libexecdir -sbindir -bindir -program_transform_name -prefix -exec_prefix -PACKAGE_URL -PACKAGE_BUGREPORT -PACKAGE_STRING -PACKAGE_VERSION -PACKAGE_TARNAME -PACKAGE_NAME -PATH_SEPARATOR -SHELL' -ac_subst_files='' -ac_user_opts=' -enable_option_checking -with_erlang -enable_mod_muc -enable_mod_proxy65 -enable_mod_pubsub -enable_eldap -enable_odbc -enable_tls -enable_web -enable_ejabberd_zlib -with_zlib -enable_pam -with_pam -enable_hipe -enable_roster_gateway_workaround -enable_mssql -enable_transient_supervisors -enable_full_xml -with_openssl -enable_user -' - ac_precious_vars='build_alias -host_alias -target_alias -CC -CFLAGS -LDFLAGS -LIBS -CPPFLAGS -CPP -ERLC -ERLCFLAGS' - - -# Initialize some variables set by options. -ac_init_help= -ac_init_version=false -ac_unrecognized_opts= -ac_unrecognized_sep= -# The variables have the same names as the options, with -# dashes changed to underlines. -cache_file=/dev/null -exec_prefix=NONE -no_create= -no_recursion= -prefix=NONE -program_prefix=NONE -program_suffix=NONE -program_transform_name=s,x,x, -silent= -site= -srcdir= -verbose= -x_includes=NONE -x_libraries=NONE - -# Installation directory options. -# These are left unexpanded so users can "make install exec_prefix=/foo" -# and all the variables that are supposed to be based on exec_prefix -# by default will actually change. -# Use braces instead of parens because sh, perl, etc. also accept them. -# (The list follows the same order as the GNU Coding Standards.) -bindir='${exec_prefix}/bin' -sbindir='${exec_prefix}/sbin' -libexecdir='${exec_prefix}/libexec' -datarootdir='${prefix}/share' -datadir='${datarootdir}' -sysconfdir='${prefix}/etc' -sharedstatedir='${prefix}/com' -localstatedir='${prefix}/var' -includedir='${prefix}/include' -oldincludedir='/usr/include' -docdir='${datarootdir}/doc/${PACKAGE_TARNAME}' -infodir='${datarootdir}/info' -htmldir='${docdir}' -dvidir='${docdir}' -pdfdir='${docdir}' -psdir='${docdir}' -libdir='${exec_prefix}/lib' -localedir='${datarootdir}/locale' -mandir='${datarootdir}/man' - -ac_prev= -ac_dashdash= -for ac_option -do - # If the previous option needs an argument, assign it. - if test -n "$ac_prev"; then - eval $ac_prev=\$ac_option - ac_prev= - continue - fi - - case $ac_option in - *=*) ac_optarg=`expr "X$ac_option" : '[^=]*=\(.*\)'` ;; - *) ac_optarg=yes ;; - esac - - # Accept the important Cygnus configure options, so we can diagnose typos. - - case $ac_dashdash$ac_option in - --) - ac_dashdash=yes ;; - - -bindir | --bindir | --bindi | --bind | --bin | --bi) - ac_prev=bindir ;; - -bindir=* | --bindir=* | --bindi=* | --bind=* | --bin=* | --bi=*) - bindir=$ac_optarg ;; - - -build | --build | --buil | --bui | --bu) - ac_prev=build_alias ;; - -build=* | --build=* | --buil=* | --bui=* | --bu=*) - build_alias=$ac_optarg ;; - - -cache-file | --cache-file | --cache-fil | --cache-fi \ - | --cache-f | --cache- | --cache | --cach | --cac | --ca | --c) - ac_prev=cache_file ;; - -cache-file=* | --cache-file=* | --cache-fil=* | --cache-fi=* \ - | --cache-f=* | --cache-=* | --cache=* | --cach=* | --cac=* | --ca=* | --c=*) - cache_file=$ac_optarg ;; - - --config-cache | -C) - cache_file=config.cache ;; - - -datadir | --datadir | --datadi | --datad) - ac_prev=datadir ;; - -datadir=* | --datadir=* | --datadi=* | --datad=*) - datadir=$ac_optarg ;; - - -datarootdir | --datarootdir | --datarootdi | --datarootd | --dataroot \ - | --dataroo | --dataro | --datar) - ac_prev=datarootdir ;; - -datarootdir=* | --datarootdir=* | --datarootdi=* | --datarootd=* \ - | --dataroot=* | --dataroo=* | --dataro=* | --datar=*) - datarootdir=$ac_optarg ;; - - -disable-* | --disable-*) - ac_useropt=`expr "x$ac_option" : 'x-*disable-\(.*\)'` - # Reject names that are not valid shell variable names. - expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && - as_fn_error "invalid feature name: $ac_useropt" - ac_useropt_orig=$ac_useropt - ac_useropt=`$as_echo "$ac_useropt" | sed 's/[-+.]/_/g'` - case $ac_user_opts in - *" -"enable_$ac_useropt" -"*) ;; - *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--disable-$ac_useropt_orig" - ac_unrecognized_sep=', ';; - esac - eval enable_$ac_useropt=no ;; - - -docdir | --docdir | --docdi | --doc | --do) - ac_prev=docdir ;; - -docdir=* | --docdir=* | --docdi=* | --doc=* | --do=*) - docdir=$ac_optarg ;; - - -dvidir | --dvidir | --dvidi | --dvid | --dvi | --dv) - ac_prev=dvidir ;; - -dvidir=* | --dvidir=* | --dvidi=* | --dvid=* | --dvi=* | --dv=*) - dvidir=$ac_optarg ;; - - -enable-* | --enable-*) - ac_useropt=`expr "x$ac_option" : 'x-*enable-\([^=]*\)'` - # Reject names that are not valid shell variable names. - expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && - as_fn_error "invalid feature name: $ac_useropt" - ac_useropt_orig=$ac_useropt - ac_useropt=`$as_echo "$ac_useropt" | sed 's/[-+.]/_/g'` - case $ac_user_opts in - *" -"enable_$ac_useropt" -"*) ;; - *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--enable-$ac_useropt_orig" - ac_unrecognized_sep=', ';; - esac - eval enable_$ac_useropt=\$ac_optarg ;; - - -exec-prefix | --exec_prefix | --exec-prefix | --exec-prefi \ - | --exec-pref | --exec-pre | --exec-pr | --exec-p | --exec- \ - | --exec | --exe | --ex) - ac_prev=exec_prefix ;; - -exec-prefix=* | --exec_prefix=* | --exec-prefix=* | --exec-prefi=* \ - | --exec-pref=* | --exec-pre=* | --exec-pr=* | --exec-p=* | --exec-=* \ - | --exec=* | --exe=* | --ex=*) - exec_prefix=$ac_optarg ;; - - -gas | --gas | --ga | --g) - # Obsolete; use --with-gas. - with_gas=yes ;; - - -help | --help | --hel | --he | -h) - ac_init_help=long ;; - -help=r* | --help=r* | --hel=r* | --he=r* | -hr*) - ac_init_help=recursive ;; - -help=s* | --help=s* | --hel=s* | --he=s* | -hs*) - ac_init_help=short ;; - - -host | --host | --hos | --ho) - ac_prev=host_alias ;; - -host=* | --host=* | --hos=* | --ho=*) - host_alias=$ac_optarg ;; - - -htmldir | --htmldir | --htmldi | --htmld | --html | --htm | --ht) - ac_prev=htmldir ;; - -htmldir=* | --htmldir=* | --htmldi=* | --htmld=* | --html=* | --htm=* \ - | --ht=*) - htmldir=$ac_optarg ;; - - -includedir | --includedir | --includedi | --included | --include \ - | --includ | --inclu | --incl | --inc) - ac_prev=includedir ;; - -includedir=* | --includedir=* | --includedi=* | --included=* | --include=* \ - | --includ=* | --inclu=* | --incl=* | --inc=*) - includedir=$ac_optarg ;; - - -infodir | --infodir | --infodi | --infod | --info | --inf) - ac_prev=infodir ;; - -infodir=* | --infodir=* | --infodi=* | --infod=* | --info=* | --inf=*) - infodir=$ac_optarg ;; - - -libdir | --libdir | --libdi | --libd) - ac_prev=libdir ;; - -libdir=* | --libdir=* | --libdi=* | --libd=*) - libdir=$ac_optarg ;; - - -libexecdir | --libexecdir | --libexecdi | --libexecd | --libexec \ - | --libexe | --libex | --libe) - ac_prev=libexecdir ;; - -libexecdir=* | --libexecdir=* | --libexecdi=* | --libexecd=* | --libexec=* \ - | --libexe=* | --libex=* | --libe=*) - libexecdir=$ac_optarg ;; - - -localedir | --localedir | --localedi | --localed | --locale) - ac_prev=localedir ;; - -localedir=* | --localedir=* | --localedi=* | --localed=* | --locale=*) - localedir=$ac_optarg ;; - - -localstatedir | --localstatedir | --localstatedi | --localstated \ - | --localstate | --localstat | --localsta | --localst | --locals) - ac_prev=localstatedir ;; - -localstatedir=* | --localstatedir=* | --localstatedi=* | --localstated=* \ - | --localstate=* | --localstat=* | --localsta=* | --localst=* | --locals=*) - localstatedir=$ac_optarg ;; - - -mandir | --mandir | --mandi | --mand | --man | --ma | --m) - ac_prev=mandir ;; - -mandir=* | --mandir=* | --mandi=* | --mand=* | --man=* | --ma=* | --m=*) - mandir=$ac_optarg ;; - - -nfp | --nfp | --nf) - # Obsolete; use --without-fp. - with_fp=no ;; - - -no-create | --no-create | --no-creat | --no-crea | --no-cre \ - | --no-cr | --no-c | -n) - no_create=yes ;; - - -no-recursion | --no-recursion | --no-recursio | --no-recursi \ - | --no-recurs | --no-recur | --no-recu | --no-rec | --no-re | --no-r) - no_recursion=yes ;; - - -oldincludedir | --oldincludedir | --oldincludedi | --oldincluded \ - | --oldinclude | --oldinclud | --oldinclu | --oldincl | --oldinc \ - | --oldin | --oldi | --old | --ol | --o) - ac_prev=oldincludedir ;; - -oldincludedir=* | --oldincludedir=* | --oldincludedi=* | --oldincluded=* \ - | --oldinclude=* | --oldinclud=* | --oldinclu=* | --oldincl=* | --oldinc=* \ - | --oldin=* | --oldi=* | --old=* | --ol=* | --o=*) - oldincludedir=$ac_optarg ;; - - -prefix | --prefix | --prefi | --pref | --pre | --pr | --p) - ac_prev=prefix ;; - -prefix=* | --prefix=* | --prefi=* | --pref=* | --pre=* | --pr=* | --p=*) - prefix=$ac_optarg ;; - - -program-prefix | --program-prefix | --program-prefi | --program-pref \ - | --program-pre | --program-pr | --program-p) - ac_prev=program_prefix ;; - -program-prefix=* | --program-prefix=* | --program-prefi=* \ - | --program-pref=* | --program-pre=* | --program-pr=* | --program-p=*) - program_prefix=$ac_optarg ;; - - -program-suffix | --program-suffix | --program-suffi | --program-suff \ - | --program-suf | --program-su | --program-s) - ac_prev=program_suffix ;; - -program-suffix=* | --program-suffix=* | --program-suffi=* \ - | --program-suff=* | --program-suf=* | --program-su=* | --program-s=*) - program_suffix=$ac_optarg ;; - - -program-transform-name | --program-transform-name \ - | --program-transform-nam | --program-transform-na \ - | --program-transform-n | --program-transform- \ - | --program-transform | --program-transfor \ - | --program-transfo | --program-transf \ - | --program-trans | --program-tran \ - | --progr-tra | --program-tr | --program-t) - ac_prev=program_transform_name ;; - -program-transform-name=* | --program-transform-name=* \ - | --program-transform-nam=* | --program-transform-na=* \ - | --program-transform-n=* | --program-transform-=* \ - | --program-transform=* | --program-transfor=* \ - | --program-transfo=* | --program-transf=* \ - | --program-trans=* | --program-tran=* \ - | --progr-tra=* | --program-tr=* | --program-t=*) - program_transform_name=$ac_optarg ;; - - -pdfdir | --pdfdir | --pdfdi | --pdfd | --pdf | --pd) - ac_prev=pdfdir ;; - -pdfdir=* | --pdfdir=* | --pdfdi=* | --pdfd=* | --pdf=* | --pd=*) - pdfdir=$ac_optarg ;; - - -psdir | --psdir | --psdi | --psd | --ps) - ac_prev=psdir ;; - -psdir=* | --psdir=* | --psdi=* | --psd=* | --ps=*) - psdir=$ac_optarg ;; - - -q | -quiet | --quiet | --quie | --qui | --qu | --q \ - | -silent | --silent | --silen | --sile | --sil) - silent=yes ;; - - -sbindir | --sbindir | --sbindi | --sbind | --sbin | --sbi | --sb) - ac_prev=sbindir ;; - -sbindir=* | --sbindir=* | --sbindi=* | --sbind=* | --sbin=* \ - | --sbi=* | --sb=*) - sbindir=$ac_optarg ;; - - -sharedstatedir | --sharedstatedir | --sharedstatedi \ - | --sharedstated | --sharedstate | --sharedstat | --sharedsta \ - | --sharedst | --shareds | --shared | --share | --shar \ - | --sha | --sh) - ac_prev=sharedstatedir ;; - -sharedstatedir=* | --sharedstatedir=* | --sharedstatedi=* \ - | --sharedstated=* | --sharedstate=* | --sharedstat=* | --sharedsta=* \ - | --sharedst=* | --shareds=* | --shared=* | --share=* | --shar=* \ - | --sha=* | --sh=*) - sharedstatedir=$ac_optarg ;; - - -site | --site | --sit) - ac_prev=site ;; - -site=* | --site=* | --sit=*) - site=$ac_optarg ;; - - -srcdir | --srcdir | --srcdi | --srcd | --src | --sr) - ac_prev=srcdir ;; - -srcdir=* | --srcdir=* | --srcdi=* | --srcd=* | --src=* | --sr=*) - srcdir=$ac_optarg ;; - - -sysconfdir | --sysconfdir | --sysconfdi | --sysconfd | --sysconf \ - | --syscon | --sysco | --sysc | --sys | --sy) - ac_prev=sysconfdir ;; - -sysconfdir=* | --sysconfdir=* | --sysconfdi=* | --sysconfd=* | --sysconf=* \ - | --syscon=* | --sysco=* | --sysc=* | --sys=* | --sy=*) - sysconfdir=$ac_optarg ;; - - -target | --target | --targe | --targ | --tar | --ta | --t) - ac_prev=target_alias ;; - -target=* | --target=* | --targe=* | --targ=* | --tar=* | --ta=* | --t=*) - target_alias=$ac_optarg ;; - - -v | -verbose | --verbose | --verbos | --verbo | --verb) - verbose=yes ;; - - -version | --version | --versio | --versi | --vers | -V) - ac_init_version=: ;; - - -with-* | --with-*) - ac_useropt=`expr "x$ac_option" : 'x-*with-\([^=]*\)'` - # Reject names that are not valid shell variable names. - expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && - as_fn_error "invalid package name: $ac_useropt" - ac_useropt_orig=$ac_useropt - ac_useropt=`$as_echo "$ac_useropt" | sed 's/[-+.]/_/g'` - case $ac_user_opts in - *" -"with_$ac_useropt" -"*) ;; - *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--with-$ac_useropt_orig" - ac_unrecognized_sep=', ';; - esac - eval with_$ac_useropt=\$ac_optarg ;; - - -without-* | --without-*) - ac_useropt=`expr "x$ac_option" : 'x-*without-\(.*\)'` - # Reject names that are not valid shell variable names. - expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && - as_fn_error "invalid package name: $ac_useropt" - ac_useropt_orig=$ac_useropt - ac_useropt=`$as_echo "$ac_useropt" | sed 's/[-+.]/_/g'` - case $ac_user_opts in - *" -"with_$ac_useropt" -"*) ;; - *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--without-$ac_useropt_orig" - ac_unrecognized_sep=', ';; - esac - eval with_$ac_useropt=no ;; - - --x) - # Obsolete; use --with-x. - with_x=yes ;; - - -x-includes | --x-includes | --x-include | --x-includ | --x-inclu \ - | --x-incl | --x-inc | --x-in | --x-i) - ac_prev=x_includes ;; - -x-includes=* | --x-includes=* | --x-include=* | --x-includ=* | --x-inclu=* \ - | --x-incl=* | --x-inc=* | --x-in=* | --x-i=*) - x_includes=$ac_optarg ;; - - -x-libraries | --x-libraries | --x-librarie | --x-librari \ - | --x-librar | --x-libra | --x-libr | --x-lib | --x-li | --x-l) - ac_prev=x_libraries ;; - -x-libraries=* | --x-libraries=* | --x-librarie=* | --x-librari=* \ - | --x-librar=* | --x-libra=* | --x-libr=* | --x-lib=* | --x-li=* | --x-l=*) - x_libraries=$ac_optarg ;; - - -*) as_fn_error "unrecognized option: \`$ac_option' -Try \`$0 --help' for more information." - ;; - - *=*) - ac_envvar=`expr "x$ac_option" : 'x\([^=]*\)='` - # Reject names that are not valid shell variable names. - case $ac_envvar in #( - '' | [0-9]* | *[!_$as_cr_alnum]* ) - as_fn_error "invalid variable name: \`$ac_envvar'" ;; - esac - eval $ac_envvar=\$ac_optarg - export $ac_envvar ;; - - *) - # FIXME: should be removed in autoconf 3.0. - $as_echo "$as_me: WARNING: you should use --build, --host, --target" >&2 - expr "x$ac_option" : ".*[^-._$as_cr_alnum]" >/dev/null && - $as_echo "$as_me: WARNING: invalid host type: $ac_option" >&2 - : ${build_alias=$ac_option} ${host_alias=$ac_option} ${target_alias=$ac_option} - ;; - - esac -done - -if test -n "$ac_prev"; then - ac_option=--`echo $ac_prev | sed 's/_/-/g'` - as_fn_error "missing argument to $ac_option" -fi - -if test -n "$ac_unrecognized_opts"; then - case $enable_option_checking in - no) ;; - fatal) as_fn_error "unrecognized options: $ac_unrecognized_opts" ;; - *) $as_echo "$as_me: WARNING: unrecognized options: $ac_unrecognized_opts" >&2 ;; - esac -fi - -# Check all directory arguments for consistency. -for ac_var in exec_prefix prefix bindir sbindir libexecdir datarootdir \ - datadir sysconfdir sharedstatedir localstatedir includedir \ - oldincludedir docdir infodir htmldir dvidir pdfdir psdir \ - libdir localedir mandir -do - eval ac_val=\$$ac_var - # Remove trailing slashes. - case $ac_val in - */ ) - ac_val=`expr "X$ac_val" : 'X\(.*[^/]\)' \| "X$ac_val" : 'X\(.*\)'` - eval $ac_var=\$ac_val;; - esac - # Be sure to have absolute directory names. - case $ac_val in - [\\/$]* | ?:[\\/]* ) continue;; - NONE | '' ) case $ac_var in *prefix ) continue;; esac;; - esac - as_fn_error "expected an absolute directory name for --$ac_var: $ac_val" -done - -# There might be people who depend on the old broken behavior: `$host' -# used to hold the argument of --host etc. -# FIXME: To remove some day. -build=$build_alias -host=$host_alias -target=$target_alias - -# FIXME: To remove some day. -if test "x$host_alias" != x; then - if test "x$build_alias" = x; then - cross_compiling=maybe - $as_echo "$as_me: WARNING: If you wanted to set the --build type, don't use --host. - If a cross compiler is detected then cross compile mode will be used." >&2 - elif test "x$build_alias" != "x$host_alias"; then - cross_compiling=yes - fi -fi - -ac_tool_prefix= -test -n "$host_alias" && ac_tool_prefix=$host_alias- - -test "$silent" = yes && exec 6>/dev/null - - -ac_pwd=`pwd` && test -n "$ac_pwd" && -ac_ls_di=`ls -di .` && -ac_pwd_ls_di=`cd "$ac_pwd" && ls -di .` || - as_fn_error "working directory cannot be determined" -test "X$ac_ls_di" = "X$ac_pwd_ls_di" || - as_fn_error "pwd does not report name of working directory" - - -# Find the source files, if location was not specified. -if test -z "$srcdir"; then - ac_srcdir_defaulted=yes - # Try the directory containing this script, then the parent directory. - ac_confdir=`$as_dirname -- "$as_myself" || -$as_expr X"$as_myself" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ - X"$as_myself" : 'X\(//\)[^/]' \| \ - X"$as_myself" : 'X\(//\)$' \| \ - X"$as_myself" : 'X\(/\)' \| . 2>/dev/null || -$as_echo X"$as_myself" | - sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ - s//\1/ - q - } - /^X\(\/\/\)[^/].*/{ - s//\1/ - q - } - /^X\(\/\/\)$/{ - s//\1/ - q - } - /^X\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - srcdir=$ac_confdir - if test ! -r "$srcdir/$ac_unique_file"; then - srcdir=.. - fi -else - ac_srcdir_defaulted=no -fi -if test ! -r "$srcdir/$ac_unique_file"; then - test "$ac_srcdir_defaulted" = yes && srcdir="$ac_confdir or .." - as_fn_error "cannot find sources ($ac_unique_file) in $srcdir" -fi -ac_msg="sources are in $srcdir, but \`cd $srcdir' does not work" -ac_abs_confdir=`( - cd "$srcdir" && test -r "./$ac_unique_file" || as_fn_error "$ac_msg" - pwd)` -# When building in place, set srcdir=. -if test "$ac_abs_confdir" = "$ac_pwd"; then - srcdir=. -fi -# Remove unnecessary trailing slashes from srcdir. -# Double slashes in file names in object file debugging info -# mess up M-x gdb in Emacs. -case $srcdir in -*/) srcdir=`expr "X$srcdir" : 'X\(.*[^/]\)' \| "X$srcdir" : 'X\(.*\)'`;; -esac -for ac_var in $ac_precious_vars; do - eval ac_env_${ac_var}_set=\${${ac_var}+set} - eval ac_env_${ac_var}_value=\$${ac_var} - eval ac_cv_env_${ac_var}_set=\${${ac_var}+set} - eval ac_cv_env_${ac_var}_value=\$${ac_var} -done - -# -# Report the --help message. -# -if test "$ac_init_help" = "long"; then - # Omit some internal or obsolete options to make the list less imposing. - # This message is too long to be a string in the A/UX 3.1 sh. - cat <<_ACEOF -\`configure' configures ejabberd 3.0.0-alpha-x to adapt to many kinds of systems. - -Usage: $0 [OPTION]... [VAR=VALUE]... - -To assign environment variables (e.g., CC, CFLAGS...), specify them as -VAR=VALUE. See below for descriptions of some of the useful variables. - -Defaults for the options are specified in brackets. - -Configuration: - -h, --help display this help and exit - --help=short display options specific to this package - --help=recursive display the short help of all the included packages - -V, --version display version information and exit - -q, --quiet, --silent do not print \`checking...' messages - --cache-file=FILE cache test results in FILE [disabled] - -C, --config-cache alias for \`--cache-file=config.cache' - -n, --no-create do not create output files - --srcdir=DIR find the sources in DIR [configure dir or \`..'] - -Installation directories: - --prefix=PREFIX install architecture-independent files in PREFIX - [$ac_default_prefix] - --exec-prefix=EPREFIX install architecture-dependent files in EPREFIX - [PREFIX] - -By default, \`make install' will install all the files in -\`$ac_default_prefix/bin', \`$ac_default_prefix/lib' etc. You can specify -an installation prefix other than \`$ac_default_prefix' using \`--prefix', -for instance \`--prefix=\$HOME'. - -For better control, use the options below. - -Fine tuning of the installation directories: - --bindir=DIR user executables [EPREFIX/bin] - --sbindir=DIR system admin executables [EPREFIX/sbin] - --libexecdir=DIR program executables [EPREFIX/libexec] - --sysconfdir=DIR read-only single-machine data [PREFIX/etc] - --sharedstatedir=DIR modifiable architecture-independent data [PREFIX/com] - --localstatedir=DIR modifiable single-machine data [PREFIX/var] - --libdir=DIR object code libraries [EPREFIX/lib] - --includedir=DIR C header files [PREFIX/include] - --oldincludedir=DIR C header files for non-gcc [/usr/include] - --datarootdir=DIR read-only arch.-independent data root [PREFIX/share] - --datadir=DIR read-only architecture-independent data [DATAROOTDIR] - --infodir=DIR info documentation [DATAROOTDIR/info] - --localedir=DIR locale-dependent data [DATAROOTDIR/locale] - --mandir=DIR man documentation [DATAROOTDIR/man] - --docdir=DIR documentation root [DATAROOTDIR/doc/ejabberd] - --htmldir=DIR html documentation [DOCDIR] - --dvidir=DIR dvi documentation [DOCDIR] - --pdfdir=DIR pdf documentation [DOCDIR] - --psdir=DIR ps documentation [DOCDIR] -_ACEOF - - cat <<\_ACEOF - -System types: - --build=BUILD configure for building on BUILD [guessed] - --host=HOST cross-compile to build programs to run on HOST [BUILD] - --target=TARGET configure for building compilers for TARGET [HOST] -_ACEOF -fi - -if test -n "$ac_init_help"; then - case $ac_init_help in - short | recursive ) echo "Configuration of ejabberd 3.0.0-alpha-x:";; - esac - cat <<\_ACEOF - -Optional Features: - --disable-option-checking ignore unrecognized --enable/--with options - --disable-FEATURE do not include FEATURE (same as --enable-FEATURE=no) - --enable-FEATURE[=ARG] include FEATURE [ARG=yes] - --enable-mod_muc enable mod_muc (default: yes) - --enable-mod_proxy65 enable mod_proxy65 (default: yes) - --enable-mod_pubsub enable mod_pubsub (default: yes) - --enable-eldap enable eldap (default: yes) - --enable-odbc enable odbc (default: no) - --enable-tls enable tls (default: yes) - --enable-web enable web (default: yes) - --enable-ejabberd_zlib enable ejabberd_zlib (default: yes) - --enable-pam enable pam (default: no) - --enable-hipe compile natively with HiPE, not recommended - (default: no) - --enable-roster-gateway-workaround - turn on workaround for processing gateway - subscriptions (default: no) - --enable-mssql use Microsoft SQL Server database (default: no, - requires --enable-odbc) - --enable-transient_supervisors - use Erlang supervision for transient process - (default: yes) - --enable-full-xml use XML features in XMPP stream (ex: CDATA) - (default: no, requires XML compliant clients) - --enable-user[[[=USER]]] - allow this system user to start ejabberd (default: - no) - -Optional Packages: - --with-PACKAGE[=ARG] use PACKAGE [ARG=yes] - --without-PACKAGE do not use PACKAGE (same as --with-PACKAGE=no) - --with-erlang=PREFIX path to erlc and erl - --with-zlib=PREFIX prefix where zlib is installed - --with-pam=PREFIX prefix where PAM is installed - --with-openssl=PREFIX prefix where OPENSSL is installed - -Some influential environment variables: - CC C compiler command - CFLAGS C compiler flags - LDFLAGS linker flags, e.g. -L<lib dir> if you have libraries in a - nonstandard directory <lib dir> - LIBS libraries to pass to the linker, e.g. -l<library> - CPPFLAGS (Objective) C/C++ preprocessor flags, e.g. -I<include dir> if - you have headers in a nonstandard directory <include dir> - CPP C preprocessor - ERLC Erlang/OTP compiler command [autodetected] - ERLCFLAGS Erlang/OTP compiler flags [none] - -Use these variables to override the choices made by `configure' or to help -it to find libraries and programs with nonstandard names/locations. - -Report bugs to <ejabberd@process-one.net>. -_ACEOF -ac_status=$? -fi - -if test "$ac_init_help" = "recursive"; then - # If there are subdirs, report their specific --help. - for ac_dir in : $ac_subdirs_all; do test "x$ac_dir" = x: && continue - test -d "$ac_dir" || - { cd "$srcdir" && ac_pwd=`pwd` && srcdir=. && test -d "$ac_dir"; } || - continue - ac_builddir=. - -case "$ac_dir" in -.) ac_dir_suffix= ac_top_builddir_sub=. ac_top_build_prefix= ;; -*) - ac_dir_suffix=/`$as_echo "$ac_dir" | sed 's|^\.[\\/]||'` - # A ".." for each directory in $ac_dir_suffix. - ac_top_builddir_sub=`$as_echo "$ac_dir_suffix" | sed 's|/[^\\/]*|/..|g;s|/||'` - case $ac_top_builddir_sub in - "") ac_top_builddir_sub=. ac_top_build_prefix= ;; - *) ac_top_build_prefix=$ac_top_builddir_sub/ ;; - esac ;; -esac -ac_abs_top_builddir=$ac_pwd -ac_abs_builddir=$ac_pwd$ac_dir_suffix -# for backward compatibility: -ac_top_builddir=$ac_top_build_prefix - -case $srcdir in - .) # We are building in place. - ac_srcdir=. - ac_top_srcdir=$ac_top_builddir_sub - ac_abs_top_srcdir=$ac_pwd ;; - [\\/]* | ?:[\\/]* ) # Absolute name. - ac_srcdir=$srcdir$ac_dir_suffix; - ac_top_srcdir=$srcdir - ac_abs_top_srcdir=$srcdir ;; - *) # Relative name. - ac_srcdir=$ac_top_build_prefix$srcdir$ac_dir_suffix - ac_top_srcdir=$ac_top_build_prefix$srcdir - ac_abs_top_srcdir=$ac_pwd/$srcdir ;; -esac -ac_abs_srcdir=$ac_abs_top_srcdir$ac_dir_suffix - - cd "$ac_dir" || { ac_status=$?; continue; } - # Check for guested configure. - if test -f "$ac_srcdir/configure.gnu"; then - echo && - $SHELL "$ac_srcdir/configure.gnu" --help=recursive - elif test -f "$ac_srcdir/configure"; then - echo && - $SHELL "$ac_srcdir/configure" --help=recursive - else - $as_echo "$as_me: WARNING: no configuration information is in $ac_dir" >&2 - fi || ac_status=$? - cd "$ac_pwd" || { ac_status=$?; break; } - done -fi - -test -n "$ac_init_help" && exit $ac_status -if $ac_init_version; then - cat <<\_ACEOF -ejabberd configure 3.0.0-alpha-x -generated by GNU Autoconf 2.65 - -Copyright (C) 2009 Free Software Foundation, Inc. -This configure script is free software; the Free Software Foundation -gives unlimited permission to copy, distribute and modify it. -_ACEOF - exit -fi - -## ------------------------ ## -## Autoconf initialization. ## -## ------------------------ ## - -# ac_fn_c_try_compile LINENO -# -------------------------- -# Try to compile conftest.$ac_ext, and return whether this succeeded. -ac_fn_c_try_compile () -{ - as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - rm -f conftest.$ac_objext - if { { ac_try="$ac_compile" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_compile") 2>conftest.err - ac_status=$? - if test -s conftest.err; then - grep -v '^ *+' conftest.err >conftest.er1 - cat conftest.er1 >&5 - mv -f conftest.er1 conftest.err - fi - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; } && { - test -z "$ac_c_werror_flag" || - test ! -s conftest.err - } && test -s conftest.$ac_objext; then : - ac_retval=0 -else - $as_echo "$as_me: failed program was:" >&5 -sed 's/^/| /' conftest.$ac_ext >&5 - - ac_retval=1 -fi - eval $as_lineno_stack; test "x$as_lineno_stack" = x && { as_lineno=; unset as_lineno;} - as_fn_set_status $ac_retval - -} # ac_fn_c_try_compile - -# ac_fn_c_try_cpp LINENO -# ---------------------- -# Try to preprocess conftest.$ac_ext, and return whether this succeeded. -ac_fn_c_try_cpp () -{ - as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - if { { ac_try="$ac_cpp conftest.$ac_ext" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_cpp conftest.$ac_ext") 2>conftest.err - ac_status=$? - if test -s conftest.err; then - grep -v '^ *+' conftest.err >conftest.er1 - cat conftest.er1 >&5 - mv -f conftest.er1 conftest.err - fi - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; } >/dev/null && { - test -z "$ac_c_preproc_warn_flag$ac_c_werror_flag" || - test ! -s conftest.err - }; then : - ac_retval=0 -else - $as_echo "$as_me: failed program was:" >&5 -sed 's/^/| /' conftest.$ac_ext >&5 - - ac_retval=1 -fi - eval $as_lineno_stack; test "x$as_lineno_stack" = x && { as_lineno=; unset as_lineno;} - as_fn_set_status $ac_retval - -} # ac_fn_c_try_cpp - -# ac_fn_c_try_run LINENO -# ---------------------- -# Try to link conftest.$ac_ext, and return whether this succeeded. Assumes -# that executables *can* be run. -ac_fn_c_try_run () -{ - as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - if { { ac_try="$ac_link" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_link") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; } && { ac_try='./conftest$ac_exeext' - { { case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_try") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; }; }; then : - ac_retval=0 -else - $as_echo "$as_me: program exited with status $ac_status" >&5 - $as_echo "$as_me: failed program was:" >&5 -sed 's/^/| /' conftest.$ac_ext >&5 - - ac_retval=$ac_status -fi - rm -rf conftest.dSYM conftest_ipa8_conftest.oo - eval $as_lineno_stack; test "x$as_lineno_stack" = x && { as_lineno=; unset as_lineno;} - as_fn_set_status $ac_retval - -} # ac_fn_c_try_run - -# ac_fn_c_check_header_mongrel LINENO HEADER VAR INCLUDES -# ------------------------------------------------------- -# Tests whether HEADER exists, giving a warning if it cannot be compiled using -# the include files in INCLUDES and setting the cache variable VAR -# accordingly. -ac_fn_c_check_header_mongrel () -{ - as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - if { as_var=$3; eval "test \"\${$as_var+set}\" = set"; }; then : - { $as_echo "$as_me:${as_lineno-$LINENO}: checking for $2" >&5 -$as_echo_n "checking for $2... " >&6; } -if { as_var=$3; eval "test \"\${$as_var+set}\" = set"; }; then : - $as_echo_n "(cached) " >&6 -fi -eval ac_res=\$$3 - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_res" >&5 -$as_echo "$ac_res" >&6; } -else - # Is the header compilable? -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking $2 usability" >&5 -$as_echo_n "checking $2 usability... " >&6; } -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -$4 -#include <$2> -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - ac_header_compiler=yes -else - ac_header_compiler=no -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_header_compiler" >&5 -$as_echo "$ac_header_compiler" >&6; } - -# Is the header present? -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking $2 presence" >&5 -$as_echo_n "checking $2 presence... " >&6; } -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include <$2> -_ACEOF -if ac_fn_c_try_cpp "$LINENO"; then : - ac_header_preproc=yes -else - ac_header_preproc=no -fi -rm -f conftest.err conftest.$ac_ext -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_header_preproc" >&5 -$as_echo "$ac_header_preproc" >&6; } - -# So? What about this header? -case $ac_header_compiler:$ac_header_preproc:$ac_c_preproc_warn_flag in #(( - yes:no: ) - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $2: accepted by the compiler, rejected by the preprocessor!" >&5 -$as_echo "$as_me: WARNING: $2: accepted by the compiler, rejected by the preprocessor!" >&2;} - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $2: proceeding with the compiler's result" >&5 -$as_echo "$as_me: WARNING: $2: proceeding with the compiler's result" >&2;} - ;; - no:yes:* ) - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $2: present but cannot be compiled" >&5 -$as_echo "$as_me: WARNING: $2: present but cannot be compiled" >&2;} - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $2: check for missing prerequisite headers?" >&5 -$as_echo "$as_me: WARNING: $2: check for missing prerequisite headers?" >&2;} - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $2: see the Autoconf documentation" >&5 -$as_echo "$as_me: WARNING: $2: see the Autoconf documentation" >&2;} - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $2: section \"Present But Cannot Be Compiled\"" >&5 -$as_echo "$as_me: WARNING: $2: section \"Present But Cannot Be Compiled\"" >&2;} - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $2: proceeding with the compiler's result" >&5 -$as_echo "$as_me: WARNING: $2: proceeding with the compiler's result" >&2;} -( cat <<\_ASBOX -## --------------------------------------- ## -## Report this to ejabberd@process-one.net ## -## --------------------------------------- ## -_ASBOX - ) | sed "s/^/$as_me: WARNING: /" >&2 - ;; -esac - { $as_echo "$as_me:${as_lineno-$LINENO}: checking for $2" >&5 -$as_echo_n "checking for $2... " >&6; } -if { as_var=$3; eval "test \"\${$as_var+set}\" = set"; }; then : - $as_echo_n "(cached) " >&6 -else - eval "$3=\$ac_header_compiler" -fi -eval ac_res=\$$3 - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_res" >&5 -$as_echo "$ac_res" >&6; } -fi - eval $as_lineno_stack; test "x$as_lineno_stack" = x && { as_lineno=; unset as_lineno;} - -} # ac_fn_c_check_header_mongrel - -# ac_fn_c_check_header_compile LINENO HEADER VAR INCLUDES -# ------------------------------------------------------- -# Tests whether HEADER exists and can be compiled using the include files in -# INCLUDES, setting the cache variable VAR accordingly. -ac_fn_c_check_header_compile () -{ - as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - { $as_echo "$as_me:${as_lineno-$LINENO}: checking for $2" >&5 -$as_echo_n "checking for $2... " >&6; } -if { as_var=$3; eval "test \"\${$as_var+set}\" = set"; }; then : - $as_echo_n "(cached) " >&6 -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -$4 -#include <$2> -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - eval "$3=yes" -else - eval "$3=no" -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext -fi -eval ac_res=\$$3 - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_res" >&5 -$as_echo "$ac_res" >&6; } - eval $as_lineno_stack; test "x$as_lineno_stack" = x && { as_lineno=; unset as_lineno;} - -} # ac_fn_c_check_header_compile - -# ac_fn_c_try_link LINENO -# ----------------------- -# Try to link conftest.$ac_ext, and return whether this succeeded. -ac_fn_c_try_link () -{ - as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - rm -f conftest.$ac_objext conftest$ac_exeext - if { { ac_try="$ac_link" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_link") 2>conftest.err - ac_status=$? - if test -s conftest.err; then - grep -v '^ *+' conftest.err >conftest.er1 - cat conftest.er1 >&5 - mv -f conftest.er1 conftest.err - fi - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; } && { - test -z "$ac_c_werror_flag" || - test ! -s conftest.err - } && test -s conftest$ac_exeext && { - test "$cross_compiling" = yes || - $as_test_x conftest$ac_exeext - }; then : - ac_retval=0 -else - $as_echo "$as_me: failed program was:" >&5 -sed 's/^/| /' conftest.$ac_ext >&5 - - ac_retval=1 -fi - # Delete the IPA/IPO (Inter Procedural Analysis/Optimization) information - # created by the PGI compiler (conftest_ipa8_conftest.oo), as it would - # interfere with the next link command; also delete a directory that is - # left behind by Apple's compiler. We do this before executing the actions. - rm -rf conftest.dSYM conftest_ipa8_conftest.oo - eval $as_lineno_stack; test "x$as_lineno_stack" = x && { as_lineno=; unset as_lineno;} - as_fn_set_status $ac_retval - -} # ac_fn_c_try_link - -# ac_fn_erl_try_run LINENO -# ------------------------ -# Try to link conftest.$ac_ext, and return whether this succeeded. Assumes -# that executables *can* be run. -ac_fn_erl_try_run () -{ - as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - if { { ac_try="$ac_link" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_link") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; } && { ac_try='./conftest$ac_exeext' - { { case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_try") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; }; }; then : - ac_retval=0 -else - $as_echo "$as_me: program exited with status $ac_status" >&5 - $as_echo "$as_me: failed program was:" >&5 -sed 's/^/| /' conftest.$ac_ext >&5 - - ac_retval=$ac_status -fi - rm -rf conftest.dSYM conftest_ipa8_conftest.oo - eval $as_lineno_stack; test "x$as_lineno_stack" = x && { as_lineno=; unset as_lineno;} - as_fn_set_status $ac_retval - -} # ac_fn_erl_try_run -cat >config.log <<_ACEOF -This file contains any messages produced by compilers while -running configure, to aid debugging if configure makes a mistake. - -It was created by ejabberd $as_me 3.0.0-alpha-x, which was -generated by GNU Autoconf 2.65. Invocation command line was - - $ $0 $@ - -_ACEOF -exec 5>>config.log -{ -cat <<_ASUNAME -## --------- ## -## Platform. ## -## --------- ## - -hostname = `(hostname || uname -n) 2>/dev/null | sed 1q` -uname -m = `(uname -m) 2>/dev/null || echo unknown` -uname -r = `(uname -r) 2>/dev/null || echo unknown` -uname -s = `(uname -s) 2>/dev/null || echo unknown` -uname -v = `(uname -v) 2>/dev/null || echo unknown` - -/usr/bin/uname -p = `(/usr/bin/uname -p) 2>/dev/null || echo unknown` -/bin/uname -X = `(/bin/uname -X) 2>/dev/null || echo unknown` - -/bin/arch = `(/bin/arch) 2>/dev/null || echo unknown` -/usr/bin/arch -k = `(/usr/bin/arch -k) 2>/dev/null || echo unknown` -/usr/convex/getsysinfo = `(/usr/convex/getsysinfo) 2>/dev/null || echo unknown` -/usr/bin/hostinfo = `(/usr/bin/hostinfo) 2>/dev/null || echo unknown` -/bin/machine = `(/bin/machine) 2>/dev/null || echo unknown` -/usr/bin/oslevel = `(/usr/bin/oslevel) 2>/dev/null || echo unknown` -/bin/universe = `(/bin/universe) 2>/dev/null || echo unknown` - -_ASUNAME - -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - $as_echo "PATH: $as_dir" - done -IFS=$as_save_IFS - -} >&5 - -cat >&5 <<_ACEOF - - -## ----------- ## -## Core tests. ## -## ----------- ## - -_ACEOF - - -# Keep a trace of the command line. -# Strip out --no-create and --no-recursion so they do not pile up. -# Strip out --silent because we don't want to record it for future runs. -# Also quote any args containing shell meta-characters. -# Make two passes to allow for proper duplicate-argument suppression. -ac_configure_args= -ac_configure_args0= -ac_configure_args1= -ac_must_keep_next=false -for ac_pass in 1 2 -do - for ac_arg - do - case $ac_arg in - -no-create | --no-c* | -n | -no-recursion | --no-r*) continue ;; - -q | -quiet | --quiet | --quie | --qui | --qu | --q \ - | -silent | --silent | --silen | --sile | --sil) - continue ;; - *\'*) - ac_arg=`$as_echo "$ac_arg" | sed "s/'/'\\\\\\\\''/g"` ;; - esac - case $ac_pass in - 1) as_fn_append ac_configure_args0 " '$ac_arg'" ;; - 2) - as_fn_append ac_configure_args1 " '$ac_arg'" - if test $ac_must_keep_next = true; then - ac_must_keep_next=false # Got value, back to normal. - else - case $ac_arg in - *=* | --config-cache | -C | -disable-* | --disable-* \ - | -enable-* | --enable-* | -gas | --g* | -nfp | --nf* \ - | -q | -quiet | --q* | -silent | --sil* | -v | -verb* \ - | -with-* | --with-* | -without-* | --without-* | --x) - case "$ac_configure_args0 " in - "$ac_configure_args1"*" '$ac_arg' "* ) continue ;; - esac - ;; - -* ) ac_must_keep_next=true ;; - esac - fi - as_fn_append ac_configure_args " '$ac_arg'" - ;; - esac - done -done -{ ac_configure_args0=; unset ac_configure_args0;} -{ ac_configure_args1=; unset ac_configure_args1;} - -# When interrupted or exit'd, cleanup temporary files, and complete -# config.log. We remove comments because anyway the quotes in there -# would cause problems or look ugly. -# WARNING: Use '\'' to represent an apostrophe within the trap. -# WARNING: Do not start the trap code with a newline, due to a FreeBSD 4.0 bug. -trap 'exit_status=$? - # Save into config.log some information that might help in debugging. - { - echo - - cat <<\_ASBOX -## ---------------- ## -## Cache variables. ## -## ---------------- ## -_ASBOX - echo - # The following way of writing the cache mishandles newlines in values, -( - for ac_var in `(set) 2>&1 | sed -n '\''s/^\([a-zA-Z_][a-zA-Z0-9_]*\)=.*/\1/p'\''`; do - eval ac_val=\$$ac_var - case $ac_val in #( - *${as_nl}*) - case $ac_var in #( - *_cv_*) { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: cache variable $ac_var contains a newline" >&5 -$as_echo "$as_me: WARNING: cache variable $ac_var contains a newline" >&2;} ;; - esac - case $ac_var in #( - _ | IFS | as_nl) ;; #( - BASH_ARGV | BASH_SOURCE) eval $ac_var= ;; #( - *) { eval $ac_var=; unset $ac_var;} ;; - esac ;; - esac - done - (set) 2>&1 | - case $as_nl`(ac_space='\'' '\''; set) 2>&1` in #( - *${as_nl}ac_space=\ *) - sed -n \ - "s/'\''/'\''\\\\'\'''\''/g; - s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1='\''\\2'\''/p" - ;; #( - *) - sed -n "/^[_$as_cr_alnum]*_cv_[_$as_cr_alnum]*=/p" - ;; - esac | - sort -) - echo - - cat <<\_ASBOX -## ----------------- ## -## Output variables. ## -## ----------------- ## -_ASBOX - echo - for ac_var in $ac_subst_vars - do - eval ac_val=\$$ac_var - case $ac_val in - *\'\''*) ac_val=`$as_echo "$ac_val" | sed "s/'\''/'\''\\\\\\\\'\'''\''/g"`;; - esac - $as_echo "$ac_var='\''$ac_val'\''" - done | sort - echo - - if test -n "$ac_subst_files"; then - cat <<\_ASBOX -## ------------------- ## -## File substitutions. ## -## ------------------- ## -_ASBOX - echo - for ac_var in $ac_subst_files - do - eval ac_val=\$$ac_var - case $ac_val in - *\'\''*) ac_val=`$as_echo "$ac_val" | sed "s/'\''/'\''\\\\\\\\'\'''\''/g"`;; - esac - $as_echo "$ac_var='\''$ac_val'\''" - done | sort - echo - fi - - if test -s confdefs.h; then - cat <<\_ASBOX -## ----------- ## -## confdefs.h. ## -## ----------- ## -_ASBOX - echo - cat confdefs.h - echo - fi - test "$ac_signal" != 0 && - $as_echo "$as_me: caught signal $ac_signal" - $as_echo "$as_me: exit $exit_status" - } >&5 - rm -f core *.core core.conftest.* && - rm -f -r conftest* confdefs* conf$$* $ac_clean_files && - exit $exit_status -' 0 -for ac_signal in 1 2 13 15; do - trap 'ac_signal='$ac_signal'; as_fn_exit 1' $ac_signal -done -ac_signal=0 - -# confdefs.h avoids OS command line length limits that DEFS can exceed. -rm -f -r conftest* confdefs.h - -$as_echo "/* confdefs.h */" > confdefs.h - -# Predefined preprocessor variables. - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_NAME "$PACKAGE_NAME" -_ACEOF - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_TARNAME "$PACKAGE_TARNAME" -_ACEOF - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_VERSION "$PACKAGE_VERSION" -_ACEOF - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_STRING "$PACKAGE_STRING" -_ACEOF - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_BUGREPORT "$PACKAGE_BUGREPORT" -_ACEOF - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_URL "$PACKAGE_URL" -_ACEOF - - -# Let the site file select an alternate cache file if it wants to. -# Prefer an explicitly selected file to automatically selected ones. -ac_site_file1=NONE -ac_site_file2=NONE -if test -n "$CONFIG_SITE"; then - ac_site_file1=$CONFIG_SITE -elif test "x$prefix" != xNONE; then - ac_site_file1=$prefix/share/config.site - ac_site_file2=$prefix/etc/config.site -else - ac_site_file1=$ac_default_prefix/share/config.site - ac_site_file2=$ac_default_prefix/etc/config.site -fi -for ac_site_file in "$ac_site_file1" "$ac_site_file2" -do - test "x$ac_site_file" = xNONE && continue - if test /dev/null != "$ac_site_file" && test -r "$ac_site_file"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: loading site script $ac_site_file" >&5 -$as_echo "$as_me: loading site script $ac_site_file" >&6;} - sed 's/^/| /' "$ac_site_file" >&5 - . "$ac_site_file" - fi -done - -if test -r "$cache_file"; then - # Some versions of bash will fail to source /dev/null (special files - # actually), so we avoid doing that. DJGPP emulates it as a regular file. - if test /dev/null != "$cache_file" && test -f "$cache_file"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: loading cache $cache_file" >&5 -$as_echo "$as_me: loading cache $cache_file" >&6;} - case $cache_file in - [\\/]* | ?:[\\/]* ) . "$cache_file";; - *) . "./$cache_file";; - esac - fi -else - { $as_echo "$as_me:${as_lineno-$LINENO}: creating cache $cache_file" >&5 -$as_echo "$as_me: creating cache $cache_file" >&6;} - >$cache_file -fi - -# Check that the precious variables saved in the cache have kept the same -# value. -ac_cache_corrupted=false -for ac_var in $ac_precious_vars; do - eval ac_old_set=\$ac_cv_env_${ac_var}_set - eval ac_new_set=\$ac_env_${ac_var}_set - eval ac_old_val=\$ac_cv_env_${ac_var}_value - eval ac_new_val=\$ac_env_${ac_var}_value - case $ac_old_set,$ac_new_set in - set,) - { $as_echo "$as_me:${as_lineno-$LINENO}: error: \`$ac_var' was set to \`$ac_old_val' in the previous run" >&5 -$as_echo "$as_me: error: \`$ac_var' was set to \`$ac_old_val' in the previous run" >&2;} - ac_cache_corrupted=: ;; - ,set) - { $as_echo "$as_me:${as_lineno-$LINENO}: error: \`$ac_var' was not set in the previous run" >&5 -$as_echo "$as_me: error: \`$ac_var' was not set in the previous run" >&2;} - ac_cache_corrupted=: ;; - ,);; - *) - if test "x$ac_old_val" != "x$ac_new_val"; then - # differences in whitespace do not lead to failure. - ac_old_val_w=`echo x $ac_old_val` - ac_new_val_w=`echo x $ac_new_val` - if test "$ac_old_val_w" != "$ac_new_val_w"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: error: \`$ac_var' has changed since the previous run:" >&5 -$as_echo "$as_me: error: \`$ac_var' has changed since the previous run:" >&2;} - ac_cache_corrupted=: - else - { $as_echo "$as_me:${as_lineno-$LINENO}: warning: ignoring whitespace changes in \`$ac_var' since the previous run:" >&5 -$as_echo "$as_me: warning: ignoring whitespace changes in \`$ac_var' since the previous run:" >&2;} - eval $ac_var=\$ac_old_val - fi - { $as_echo "$as_me:${as_lineno-$LINENO}: former value: \`$ac_old_val'" >&5 -$as_echo "$as_me: former value: \`$ac_old_val'" >&2;} - { $as_echo "$as_me:${as_lineno-$LINENO}: current value: \`$ac_new_val'" >&5 -$as_echo "$as_me: current value: \`$ac_new_val'" >&2;} - fi;; - esac - # Pass precious variables to config.status. - if test "$ac_new_set" = set; then - case $ac_new_val in - *\'*) ac_arg=$ac_var=`$as_echo "$ac_new_val" | sed "s/'/'\\\\\\\\''/g"` ;; - *) ac_arg=$ac_var=$ac_new_val ;; - esac - case " $ac_configure_args " in - *" '$ac_arg' "*) ;; # Avoid dups. Use of quotes ensures accuracy. - *) as_fn_append ac_configure_args " '$ac_arg'" ;; - esac - fi -done -if $ac_cache_corrupted; then - { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} - { $as_echo "$as_me:${as_lineno-$LINENO}: error: changes in the environment can compromise the build" >&5 -$as_echo "$as_me: error: changes in the environment can compromise the build" >&2;} - as_fn_error "run \`make distclean' and/or \`rm $cache_file' and start over" "$LINENO" 5 -fi -## -------------------- ## -## Main body of script. ## -## -------------------- ## - -ac_ext=c -ac_cpp='$CPP $CPPFLAGS' -ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' -ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' -ac_compiler_gnu=$ac_cv_c_compiler_gnu - - - -# Checks for programs. -ac_ext=c -ac_cpp='$CPP $CPPFLAGS' -ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' -ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' -ac_compiler_gnu=$ac_cv_c_compiler_gnu -if test -n "$ac_tool_prefix"; then - # Extract the first word of "${ac_tool_prefix}gcc", so it can be a program name with args. -set dummy ${ac_tool_prefix}gcc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_prog_CC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test -n "$CC"; then - ac_cv_prog_CC="$CC" # Let the user override the test. -else -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_prog_CC="${ac_tool_prefix}gcc" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - -fi -fi -CC=$ac_cv_prog_CC -if test -n "$CC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $CC" >&5 -$as_echo "$CC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - -fi -if test -z "$ac_cv_prog_CC"; then - ac_ct_CC=$CC - # Extract the first word of "gcc", so it can be a program name with args. -set dummy gcc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_prog_ac_ct_CC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test -n "$ac_ct_CC"; then - ac_cv_prog_ac_ct_CC="$ac_ct_CC" # Let the user override the test. -else -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_prog_ac_ct_CC="gcc" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - -fi -fi -ac_ct_CC=$ac_cv_prog_ac_ct_CC -if test -n "$ac_ct_CC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_ct_CC" >&5 -$as_echo "$ac_ct_CC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - if test "x$ac_ct_CC" = x; then - CC="" - else - case $cross_compiling:$ac_tool_warned in -yes:) -{ $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 -$as_echo "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} -ac_tool_warned=yes ;; -esac - CC=$ac_ct_CC - fi -else - CC="$ac_cv_prog_CC" -fi - -if test -z "$CC"; then - if test -n "$ac_tool_prefix"; then - # Extract the first word of "${ac_tool_prefix}cc", so it can be a program name with args. -set dummy ${ac_tool_prefix}cc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_prog_CC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test -n "$CC"; then - ac_cv_prog_CC="$CC" # Let the user override the test. -else -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_prog_CC="${ac_tool_prefix}cc" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - -fi -fi -CC=$ac_cv_prog_CC -if test -n "$CC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $CC" >&5 -$as_echo "$CC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - - fi -fi -if test -z "$CC"; then - # Extract the first word of "cc", so it can be a program name with args. -set dummy cc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_prog_CC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test -n "$CC"; then - ac_cv_prog_CC="$CC" # Let the user override the test. -else - ac_prog_rejected=no -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - if test "$as_dir/$ac_word$ac_exec_ext" = "/usr/ucb/cc"; then - ac_prog_rejected=yes - continue - fi - ac_cv_prog_CC="cc" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - -if test $ac_prog_rejected = yes; then - # We found a bogon in the path, so make sure we never use it. - set dummy $ac_cv_prog_CC - shift - if test $# != 0; then - # We chose a different compiler from the bogus one. - # However, it has the same basename, so the bogon will be chosen - # first if we set CC to just the basename; use the full file name. - shift - ac_cv_prog_CC="$as_dir/$ac_word${1+' '}$@" - fi -fi -fi -fi -CC=$ac_cv_prog_CC -if test -n "$CC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $CC" >&5 -$as_echo "$CC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - -fi -if test -z "$CC"; then - if test -n "$ac_tool_prefix"; then - for ac_prog in cl.exe - do - # Extract the first word of "$ac_tool_prefix$ac_prog", so it can be a program name with args. -set dummy $ac_tool_prefix$ac_prog; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_prog_CC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test -n "$CC"; then - ac_cv_prog_CC="$CC" # Let the user override the test. -else -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_prog_CC="$ac_tool_prefix$ac_prog" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - -fi -fi -CC=$ac_cv_prog_CC -if test -n "$CC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $CC" >&5 -$as_echo "$CC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - - test -n "$CC" && break - done -fi -if test -z "$CC"; then - ac_ct_CC=$CC - for ac_prog in cl.exe -do - # Extract the first word of "$ac_prog", so it can be a program name with args. -set dummy $ac_prog; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_prog_ac_ct_CC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test -n "$ac_ct_CC"; then - ac_cv_prog_ac_ct_CC="$ac_ct_CC" # Let the user override the test. -else -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_prog_ac_ct_CC="$ac_prog" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - -fi -fi -ac_ct_CC=$ac_cv_prog_ac_ct_CC -if test -n "$ac_ct_CC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_ct_CC" >&5 -$as_echo "$ac_ct_CC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - - test -n "$ac_ct_CC" && break -done - - if test "x$ac_ct_CC" = x; then - CC="" - else - case $cross_compiling:$ac_tool_warned in -yes:) -{ $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 -$as_echo "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} -ac_tool_warned=yes ;; -esac - CC=$ac_ct_CC - fi -fi - -fi - - -test -z "$CC" && { { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} -as_fn_error "no acceptable C compiler found in \$PATH -See \`config.log' for more details." "$LINENO" 5; } - -# Provide some information about the compiler. -$as_echo "$as_me:${as_lineno-$LINENO}: checking for C compiler version" >&5 -set X $ac_compile -ac_compiler=$2 -for ac_option in --version -v -V -qversion; do - { { ac_try="$ac_compiler $ac_option >&5" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_compiler $ac_option >&5") 2>conftest.err - ac_status=$? - if test -s conftest.err; then - sed '10a\ -... rest of stderr output deleted ... - 10q' conftest.err >conftest.er1 - cat conftest.er1 >&5 - fi - rm -f conftest.er1 conftest.err - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; } -done - -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -int -main () -{ - - ; - return 0; -} -_ACEOF -ac_clean_files_save=$ac_clean_files -ac_clean_files="$ac_clean_files a.out a.out.dSYM a.exe b.out" -# Try to create an executable without -o first, disregard a.out. -# It will help us diagnose broken compilers, and finding out an intuition -# of exeext. -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether the C compiler works" >&5 -$as_echo_n "checking whether the C compiler works... " >&6; } -ac_link_default=`$as_echo "$ac_link" | sed 's/ -o *conftest[^ ]*//'` - -# The possible output files: -ac_files="a.out conftest.exe conftest a.exe a_out.exe b.out conftest.*" - -ac_rmfiles= -for ac_file in $ac_files -do - case $ac_file in - *.$ac_ext | *.xcoff | *.tds | *.d | *.pdb | *.xSYM | *.bb | *.bbg | *.map | *.inf | *.dSYM | *.o | *.obj ) ;; - * ) ac_rmfiles="$ac_rmfiles $ac_file";; - esac -done -rm -f $ac_rmfiles - -if { { ac_try="$ac_link_default" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_link_default") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; }; then : - # Autoconf-2.13 could set the ac_cv_exeext variable to `no'. -# So ignore a value of `no', otherwise this would lead to `EXEEXT = no' -# in a Makefile. We should not override ac_cv_exeext if it was cached, -# so that the user can short-circuit this test for compilers unknown to -# Autoconf. -for ac_file in $ac_files '' -do - test -f "$ac_file" || continue - case $ac_file in - *.$ac_ext | *.xcoff | *.tds | *.d | *.pdb | *.xSYM | *.bb | *.bbg | *.map | *.inf | *.dSYM | *.o | *.obj ) - ;; - [ab].out ) - # We found the default executable, but exeext='' is most - # certainly right. - break;; - *.* ) - if test "${ac_cv_exeext+set}" = set && test "$ac_cv_exeext" != no; - then :; else - ac_cv_exeext=`expr "$ac_file" : '[^.]*\(\..*\)'` - fi - # We set ac_cv_exeext here because the later test for it is not - # safe: cross compilers may not add the suffix if given an `-o' - # argument, so we may need to know it at that point already. - # Even if this section looks crufty: it has the advantage of - # actually working. - break;; - * ) - break;; - esac -done -test "$ac_cv_exeext" = no && ac_cv_exeext= - -else - ac_file='' -fi -if test -z "$ac_file"; then : - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -$as_echo "$as_me: failed program was:" >&5 -sed 's/^/| /' conftest.$ac_ext >&5 - -{ { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} -{ as_fn_set_status 77 -as_fn_error "C compiler cannot create executables -See \`config.log' for more details." "$LINENO" 5; }; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: yes" >&5 -$as_echo "yes" >&6; } -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for C compiler default output file name" >&5 -$as_echo_n "checking for C compiler default output file name... " >&6; } -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_file" >&5 -$as_echo "$ac_file" >&6; } -ac_exeext=$ac_cv_exeext - -rm -f -r a.out a.out.dSYM a.exe conftest$ac_cv_exeext b.out -ac_clean_files=$ac_clean_files_save -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for suffix of executables" >&5 -$as_echo_n "checking for suffix of executables... " >&6; } -if { { ac_try="$ac_link" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_link") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; }; then : - # If both `conftest.exe' and `conftest' are `present' (well, observable) -# catch `conftest.exe'. For instance with Cygwin, `ls conftest' will -# work properly (i.e., refer to `conftest.exe'), while it won't with -# `rm'. -for ac_file in conftest.exe conftest conftest.*; do - test -f "$ac_file" || continue - case $ac_file in - *.$ac_ext | *.xcoff | *.tds | *.d | *.pdb | *.xSYM | *.bb | *.bbg | *.map | *.inf | *.dSYM | *.o | *.obj ) ;; - *.* ) ac_cv_exeext=`expr "$ac_file" : '[^.]*\(\..*\)'` - break;; - * ) break;; - esac -done -else - { { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} -as_fn_error "cannot compute suffix of executables: cannot compile and link -See \`config.log' for more details." "$LINENO" 5; } -fi -rm -f conftest conftest$ac_cv_exeext -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_exeext" >&5 -$as_echo "$ac_cv_exeext" >&6; } - -rm -f conftest.$ac_ext -EXEEXT=$ac_cv_exeext -ac_exeext=$EXEEXT -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include <stdio.h> -int -main () -{ -FILE *f = fopen ("conftest.out", "w"); - return ferror (f) || fclose (f) != 0; - - ; - return 0; -} -_ACEOF -ac_clean_files="$ac_clean_files conftest.out" -# Check that the compiler produces executables we can run. If not, either -# the compiler is broken, or we cross compile. -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether we are cross compiling" >&5 -$as_echo_n "checking whether we are cross compiling... " >&6; } -if test "$cross_compiling" != yes; then - { { ac_try="$ac_link" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_link") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; } - if { ac_try='./conftest$ac_cv_exeext' - { { case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_try") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; }; }; then - cross_compiling=no - else - if test "$cross_compiling" = maybe; then - cross_compiling=yes - else - { { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} -as_fn_error "cannot run C compiled programs. -If you meant to cross compile, use \`--host'. -See \`config.log' for more details." "$LINENO" 5; } - fi - fi -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $cross_compiling" >&5 -$as_echo "$cross_compiling" >&6; } - -rm -f conftest.$ac_ext conftest$ac_cv_exeext conftest.out -ac_clean_files=$ac_clean_files_save -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for suffix of object files" >&5 -$as_echo_n "checking for suffix of object files... " >&6; } -if test "${ac_cv_objext+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -int -main () -{ - - ; - return 0; -} -_ACEOF -rm -f conftest.o conftest.obj -if { { ac_try="$ac_compile" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_compile") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; }; then : - for ac_file in conftest.o conftest.obj conftest.*; do - test -f "$ac_file" || continue; - case $ac_file in - *.$ac_ext | *.xcoff | *.tds | *.d | *.pdb | *.xSYM | *.bb | *.bbg | *.map | *.inf | *.dSYM ) ;; - *) ac_cv_objext=`expr "$ac_file" : '.*\.\(.*\)'` - break;; - esac -done -else - $as_echo "$as_me: failed program was:" >&5 -sed 's/^/| /' conftest.$ac_ext >&5 - -{ { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} -as_fn_error "cannot compute suffix of object files: cannot compile -See \`config.log' for more details." "$LINENO" 5; } -fi -rm -f conftest.$ac_cv_objext conftest.$ac_ext -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_objext" >&5 -$as_echo "$ac_cv_objext" >&6; } -OBJEXT=$ac_cv_objext -ac_objext=$OBJEXT -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether we are using the GNU C compiler" >&5 -$as_echo_n "checking whether we are using the GNU C compiler... " >&6; } -if test "${ac_cv_c_compiler_gnu+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -int -main () -{ -#ifndef __GNUC__ - choke me -#endif - - ; - return 0; -} -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - ac_compiler_gnu=yes -else - ac_compiler_gnu=no -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext -ac_cv_c_compiler_gnu=$ac_compiler_gnu - -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_c_compiler_gnu" >&5 -$as_echo "$ac_cv_c_compiler_gnu" >&6; } -if test $ac_compiler_gnu = yes; then - GCC=yes -else - GCC= -fi -ac_test_CFLAGS=${CFLAGS+set} -ac_save_CFLAGS=$CFLAGS -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether $CC accepts -g" >&5 -$as_echo_n "checking whether $CC accepts -g... " >&6; } -if test "${ac_cv_prog_cc_g+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - ac_save_c_werror_flag=$ac_c_werror_flag - ac_c_werror_flag=yes - ac_cv_prog_cc_g=no - CFLAGS="-g" - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -int -main () -{ - - ; - return 0; -} -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - ac_cv_prog_cc_g=yes -else - CFLAGS="" - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -int -main () -{ - - ; - return 0; -} -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - -else - ac_c_werror_flag=$ac_save_c_werror_flag - CFLAGS="-g" - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -int -main () -{ - - ; - return 0; -} -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - ac_cv_prog_cc_g=yes -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext - ac_c_werror_flag=$ac_save_c_werror_flag -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_prog_cc_g" >&5 -$as_echo "$ac_cv_prog_cc_g" >&6; } -if test "$ac_test_CFLAGS" = set; then - CFLAGS=$ac_save_CFLAGS -elif test $ac_cv_prog_cc_g = yes; then - if test "$GCC" = yes; then - CFLAGS="-g -O2" - else - CFLAGS="-g" - fi -else - if test "$GCC" = yes; then - CFLAGS="-O2" - else - CFLAGS= - fi -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $CC option to accept ISO C89" >&5 -$as_echo_n "checking for $CC option to accept ISO C89... " >&6; } -if test "${ac_cv_prog_cc_c89+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - ac_cv_prog_cc_c89=no -ac_save_CC=$CC -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include <stdarg.h> -#include <stdio.h> -#include <sys/types.h> -#include <sys/stat.h> -/* Most of the following tests are stolen from RCS 5.7's src/conf.sh. */ -struct buf { int x; }; -FILE * (*rcsopen) (struct buf *, struct stat *, int); -static char *e (p, i) - char **p; - int i; -{ - return p[i]; -} -static char *f (char * (*g) (char **, int), char **p, ...) -{ - char *s; - va_list v; - va_start (v,p); - s = g (p, va_arg (v,int)); - va_end (v); - return s; -} - -/* OSF 4.0 Compaq cc is some sort of almost-ANSI by default. It has - function prototypes and stuff, but not '\xHH' hex character constants. - These don't provoke an error unfortunately, instead are silently treated - as 'x'. The following induces an error, until -std is added to get - proper ANSI mode. Curiously '\x00'!='x' always comes out true, for an - array size at least. It's necessary to write '\x00'==0 to get something - that's true only with -std. */ -int osf4_cc_array ['\x00' == 0 ? 1 : -1]; - -/* IBM C 6 for AIX is almost-ANSI by default, but it replaces macro parameters - inside strings and character constants. */ -#define FOO(x) 'x' -int xlc6_cc_array[FOO(a) == 'x' ? 1 : -1]; - -int test (int i, double x); -struct s1 {int (*f) (int a);}; -struct s2 {int (*f) (double a);}; -int pairnames (int, char **, FILE *(*)(struct buf *, struct stat *, int), int, int); -int argc; -char **argv; -int -main () -{ -return f (e, argv, 0) != argv[0] || f (e, argv, 1) != argv[1]; - ; - return 0; -} -_ACEOF -for ac_arg in '' -qlanglvl=extc89 -qlanglvl=ansi -std \ - -Ae "-Aa -D_HPUX_SOURCE" "-Xc -D__EXTENSIONS__" -do - CC="$ac_save_CC $ac_arg" - if ac_fn_c_try_compile "$LINENO"; then : - ac_cv_prog_cc_c89=$ac_arg -fi -rm -f core conftest.err conftest.$ac_objext - test "x$ac_cv_prog_cc_c89" != "xno" && break -done -rm -f conftest.$ac_ext -CC=$ac_save_CC - -fi -# AC_CACHE_VAL -case "x$ac_cv_prog_cc_c89" in - x) - { $as_echo "$as_me:${as_lineno-$LINENO}: result: none needed" >&5 -$as_echo "none needed" >&6; } ;; - xno) - { $as_echo "$as_me:${as_lineno-$LINENO}: result: unsupported" >&5 -$as_echo "unsupported" >&6; } ;; - *) - CC="$CC $ac_cv_prog_cc_c89" - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_prog_cc_c89" >&5 -$as_echo "$ac_cv_prog_cc_c89" >&6; } ;; -esac -if test "x$ac_cv_prog_cc_c89" != xno; then : - -fi - -ac_ext=c -ac_cpp='$CPP $CPPFLAGS' -ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' -ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' -ac_compiler_gnu=$ac_cv_c_compiler_gnu - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether ${MAKE-make} sets \$(MAKE)" >&5 -$as_echo_n "checking whether ${MAKE-make} sets \$(MAKE)... " >&6; } -set x ${MAKE-make} -ac_make=`$as_echo "$2" | sed 's/+/p/g; s/[^a-zA-Z0-9_]/_/g'` -if { as_var=ac_cv_prog_make_${ac_make}_set; eval "test \"\${$as_var+set}\" = set"; }; then : - $as_echo_n "(cached) " >&6 -else - cat >conftest.make <<\_ACEOF -SHELL = /bin/sh -all: - @echo '@@@%%%=$(MAKE)=@@@%%%' -_ACEOF -# GNU make sometimes prints "make[1]: Entering...", which would confuse us. -case `${MAKE-make} -f conftest.make 2>/dev/null` in - *@@@%%%=?*=@@@%%%*) - eval ac_cv_prog_make_${ac_make}_set=yes;; - *) - eval ac_cv_prog_make_${ac_make}_set=no;; -esac -rm -f conftest.make -fi -if eval test \$ac_cv_prog_make_${ac_make}_set = yes; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: yes" >&5 -$as_echo "yes" >&6; } - SET_MAKE= -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } - SET_MAKE="MAKE=${MAKE-make}" -fi - - -if test "x$GCC" = "xyes"; then - CFLAGS="$CFLAGS -Wall" -fi - -#locating erlang - -# Check whether --with-erlang was given. -if test "${with_erlang+set}" = set; then : - withval=$with_erlang; -fi - - - if test -n "$ac_tool_prefix"; then - # Extract the first word of "${ac_tool_prefix}erlc", so it can be a program name with args. -set dummy ${ac_tool_prefix}erlc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_path_ERLC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - case $ERLC in - [\\/]* | ?:[\\/]*) - ac_cv_path_ERLC="$ERLC" # Let the user override the test with a path. - ;; - *) - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -as_dummy="$with_erlang:$with_erlang/bin:$PATH" -for as_dir in $as_dummy -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_path_ERLC="$as_dir/$ac_word$ac_exec_ext" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - - ;; -esac -fi -ERLC=$ac_cv_path_ERLC -if test -n "$ERLC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ERLC" >&5 -$as_echo "$ERLC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - -fi -if test -z "$ac_cv_path_ERLC"; then - ac_pt_ERLC=$ERLC - # Extract the first word of "erlc", so it can be a program name with args. -set dummy erlc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_path_ac_pt_ERLC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - case $ac_pt_ERLC in - [\\/]* | ?:[\\/]*) - ac_cv_path_ac_pt_ERLC="$ac_pt_ERLC" # Let the user override the test with a path. - ;; - *) - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -as_dummy="$with_erlang:$with_erlang/bin:$PATH" -for as_dir in $as_dummy -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_path_ac_pt_ERLC="$as_dir/$ac_word$ac_exec_ext" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - - ;; -esac -fi -ac_pt_ERLC=$ac_cv_path_ac_pt_ERLC -if test -n "$ac_pt_ERLC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_pt_ERLC" >&5 -$as_echo "$ac_pt_ERLC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - if test "x$ac_pt_ERLC" = x; then - ERLC="" - else - case $cross_compiling:$ac_tool_warned in -yes:) -{ $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 -$as_echo "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} -ac_tool_warned=yes ;; -esac - ERLC=$ac_pt_ERLC - fi -else - ERLC="$ac_cv_path_ERLC" -fi - - if test -n "$ac_tool_prefix"; then - # Extract the first word of "${ac_tool_prefix}erl", so it can be a program name with args. -set dummy ${ac_tool_prefix}erl; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_path_ERL+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - case $ERL in - [\\/]* | ?:[\\/]*) - ac_cv_path_ERL="$ERL" # Let the user override the test with a path. - ;; - *) - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -as_dummy="$with_erlang:$with_erlang/bin:$PATH" -for as_dir in $as_dummy -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_path_ERL="$as_dir/$ac_word$ac_exec_ext" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - - ;; -esac -fi -ERL=$ac_cv_path_ERL -if test -n "$ERL"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ERL" >&5 -$as_echo "$ERL" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - -fi -if test -z "$ac_cv_path_ERL"; then - ac_pt_ERL=$ERL - # Extract the first word of "erl", so it can be a program name with args. -set dummy erl; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_path_ac_pt_ERL+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - case $ac_pt_ERL in - [\\/]* | ?:[\\/]*) - ac_cv_path_ac_pt_ERL="$ac_pt_ERL" # Let the user override the test with a path. - ;; - *) - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -as_dummy="$with_erlang:$with_erlang/bin:$PATH" -for as_dir in $as_dummy -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_path_ac_pt_ERL="$as_dir/$ac_word$ac_exec_ext" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - - ;; -esac -fi -ac_pt_ERL=$ac_cv_path_ac_pt_ERL -if test -n "$ac_pt_ERL"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_pt_ERL" >&5 -$as_echo "$ac_pt_ERL" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - if test "x$ac_pt_ERL" = x; then - ERL="" - else - case $cross_compiling:$ac_tool_warned in -yes:) -{ $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 -$as_echo "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} -ac_tool_warned=yes ;; -esac - ERL=$ac_pt_ERL - fi -else - ERL="$ac_cv_path_ERL" -fi - - - if test "z$ERLC" = "z" || test "z$ERL" = "z"; then - as_fn_error "erlang not found" "$LINENO" 5 - fi - - - cat >>conftest.erl <<_EOF - --module(conftest). --author('alexey@sevcom.net'). - --export([start/0]). - -start() -> - EIDirS = code:lib_dir("erl_interface") ++ "\n", - EILibS = libpath("erl_interface") ++ "\n", - EXMPPDir = code:lib_dir("exmpp"), - case EXMPPDir of - {error, bad_name} -> exit("exmpp not found"); - _ -> ok - end, - EXMPPDirS = EXMPPDir ++ "\n", - RootDirS = code:root_dir() ++ "\n", - file:write_file("conftest.out", list_to_binary(EIDirS ++ EILibS ++ EXMPPDirS ++ RootDirS)), - halt(). - -%% return physical architecture based on OS/Processor -archname() -> - ArchStr = erlang:system_info(system_architecture), - case os:type() of - {win32, _} -> "windows"; - {unix,UnixName} -> - Specs = string:tokens(ArchStr,"-"), - Cpu = case lists:nth(2,Specs) of - "pc" -> "x86"; - _ -> hd(Specs) - end, - atom_to_list(UnixName) ++ "-" ++ Cpu; - _ -> "generic" - end. - -%% Return arch-based library path or a default value if this directory -%% does not exist -libpath(App) -> - PrivDir = code:priv_dir(App), - ArchDir = archname(), - LibArchDir = filename:join([PrivDir,"lib",ArchDir]), - case file:list_dir(LibArchDir) of - %% Arch lib dir exists: We use it - {ok, _List} -> LibArchDir; - %% Arch lib dir does not exist: Return the default value - %% ({error, enoent}): - _Error -> code:lib_dir("erl_interface") ++ "/lib" - end. - -_EOF - - if ! $ERLC conftest.erl; then - as_fn_error "could not compile sample program" "$LINENO" 5 - fi - - if ! $ERL -s conftest -noshell; then - as_fn_error "could not run sample program" "$LINENO" 5 - fi - - if ! test -f conftest.out; then - as_fn_error "erlang program was not properly executed, (conftest.out was not produced)" "$LINENO" 5 - fi - - # First line - ERLANG_EI_DIR=`cat conftest.out | head -n 1` - # Second line - ERLANG_EI_LIB=`cat conftest.out | head -n 2 | tail -n 1` - # Third line - ERLANG_EXMPP=`cat conftest.out | head -n 3 | tail -n 1` - # End line - ERLANG_DIR=`cat conftest.out | tail -n 1` - - ERLANG_CFLAGS="-I$ERLANG_EI_DIR/include -I$ERLANG_DIR/usr/include" - ERLANG_LIBS="-L$ERLANG_EI_LIB -lerl_interface -lei" - - - - - - - - -# Checks for typedefs, structures, and compiler characteristics. - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for an ANSI C-conforming const" >&5 -$as_echo_n "checking for an ANSI C-conforming const... " >&6; } -if test "${ac_cv_c_const+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -int -main () -{ -/* FIXME: Include the comments suggested by Paul. */ -#ifndef __cplusplus - /* Ultrix mips cc rejects this. */ - typedef int charset[2]; - const charset cs; - /* SunOS 4.1.1 cc rejects this. */ - char const *const *pcpcc; - char **ppc; - /* NEC SVR4.0.2 mips cc rejects this. */ - struct point {int x, y;}; - static struct point const zero = {0,0}; - /* AIX XL C 1.02.0.0 rejects this. - It does not let you subtract one const X* pointer from another in - an arm of an if-expression whose if-part is not a constant - expression */ - const char *g = "string"; - pcpcc = &g + (g ? g-g : 0); - /* HPUX 7.0 cc rejects these. */ - ++pcpcc; - ppc = (char**) pcpcc; - pcpcc = (char const *const *) ppc; - { /* SCO 3.2v4 cc rejects this. */ - char *t; - char const *s = 0 ? (char *) 0 : (char const *) 0; - - *t++ = 0; - if (s) return 0; - } - { /* Someone thinks the Sun supposedly-ANSI compiler will reject this. */ - int x[] = {25, 17}; - const int *foo = &x[0]; - ++foo; - } - { /* Sun SC1.0 ANSI compiler rejects this -- but not the above. */ - typedef const int *iptr; - iptr p = 0; - ++p; - } - { /* AIX XL C 1.02.0.0 rejects this saying - "k.c", line 2.27: 1506-025 (S) Operand must be a modifiable lvalue. */ - struct s { int j; const int *ap[3]; }; - struct s *b; b->j = 5; - } - { /* ULTRIX-32 V3.1 (Rev 9) vcc rejects this */ - const int foo = 10; - if (!foo) return 0; - } - return !cs[0] && !zero.x; -#endif - - ; - return 0; -} -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - ac_cv_c_const=yes -else - ac_cv_c_const=no -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_c_const" >&5 -$as_echo "$ac_cv_c_const" >&6; } -if test $ac_cv_c_const = no; then - -$as_echo "#define const /**/" >>confdefs.h - -fi - - -# Check Erlang headers are installed -#AC_CHECK_HEADER(erl_driver.h,,[AC_MSG_ERROR([cannot find Erlang header files])]) - -# Change default prefix - - -# Checks for library functions. -ac_ext=c -ac_cpp='$CPP $CPPFLAGS' -ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' -ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' -ac_compiler_gnu=$ac_cv_c_compiler_gnu -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking how to run the C preprocessor" >&5 -$as_echo_n "checking how to run the C preprocessor... " >&6; } -# On Suns, sometimes $CPP names a directory. -if test -n "$CPP" && test -d "$CPP"; then - CPP= -fi -if test -z "$CPP"; then - if test "${ac_cv_prog_CPP+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - # Double quotes because CPP needs to be expanded - for CPP in "$CC -E" "$CC -E -traditional-cpp" "/lib/cpp" - do - ac_preproc_ok=false -for ac_c_preproc_warn_flag in '' yes -do - # Use a header file that comes with gcc, so configuring glibc - # with a fresh cross-compiler works. - # Prefer <limits.h> to <assert.h> if __STDC__ is defined, since - # <limits.h> exists even on freestanding compilers. - # On the NeXT, cc -E runs the code through the compiler's parser, - # not just through cpp. "Syntax error" is here to catch this case. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#ifdef __STDC__ -# include <limits.h> -#else -# include <assert.h> -#endif - Syntax error -_ACEOF -if ac_fn_c_try_cpp "$LINENO"; then : - -else - # Broken: fails on valid input. -continue -fi -rm -f conftest.err conftest.$ac_ext - - # OK, works on sane cases. Now check whether nonexistent headers - # can be detected and how. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include <ac_nonexistent.h> -_ACEOF -if ac_fn_c_try_cpp "$LINENO"; then : - # Broken: success on invalid input. -continue -else - # Passes both tests. -ac_preproc_ok=: -break -fi -rm -f conftest.err conftest.$ac_ext - -done -# Because of `break', _AC_PREPROC_IFELSE's cleaning code was skipped. -rm -f conftest.err conftest.$ac_ext -if $ac_preproc_ok; then : - break -fi - - done - ac_cv_prog_CPP=$CPP - -fi - CPP=$ac_cv_prog_CPP -else - ac_cv_prog_CPP=$CPP -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $CPP" >&5 -$as_echo "$CPP" >&6; } -ac_preproc_ok=false -for ac_c_preproc_warn_flag in '' yes -do - # Use a header file that comes with gcc, so configuring glibc - # with a fresh cross-compiler works. - # Prefer <limits.h> to <assert.h> if __STDC__ is defined, since - # <limits.h> exists even on freestanding compilers. - # On the NeXT, cc -E runs the code through the compiler's parser, - # not just through cpp. "Syntax error" is here to catch this case. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#ifdef __STDC__ -# include <limits.h> -#else -# include <assert.h> -#endif - Syntax error -_ACEOF -if ac_fn_c_try_cpp "$LINENO"; then : - -else - # Broken: fails on valid input. -continue -fi -rm -f conftest.err conftest.$ac_ext - - # OK, works on sane cases. Now check whether nonexistent headers - # can be detected and how. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include <ac_nonexistent.h> -_ACEOF -if ac_fn_c_try_cpp "$LINENO"; then : - # Broken: success on invalid input. -continue -else - # Passes both tests. -ac_preproc_ok=: -break -fi -rm -f conftest.err conftest.$ac_ext - -done -# Because of `break', _AC_PREPROC_IFELSE's cleaning code was skipped. -rm -f conftest.err conftest.$ac_ext -if $ac_preproc_ok; then : - -else - { { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} -as_fn_error "C preprocessor \"$CPP\" fails sanity check -See \`config.log' for more details." "$LINENO" 5; } -fi - -ac_ext=c -ac_cpp='$CPP $CPPFLAGS' -ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' -ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' -ac_compiler_gnu=$ac_cv_c_compiler_gnu - - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for grep that handles long lines and -e" >&5 -$as_echo_n "checking for grep that handles long lines and -e... " >&6; } -if test "${ac_cv_path_GREP+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test -z "$GREP"; then - ac_path_GREP_found=false - # Loop through the user's path and test for each of PROGNAME-LIST - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH$PATH_SEPARATOR/usr/xpg4/bin -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_prog in grep ggrep; do - for ac_exec_ext in '' $ac_executable_extensions; do - ac_path_GREP="$as_dir/$ac_prog$ac_exec_ext" - { test -f "$ac_path_GREP" && $as_test_x "$ac_path_GREP"; } || continue -# Check for GNU ac_path_GREP and select it if it is found. - # Check for GNU $ac_path_GREP -case `"$ac_path_GREP" --version 2>&1` in -*GNU*) - ac_cv_path_GREP="$ac_path_GREP" ac_path_GREP_found=:;; -*) - ac_count=0 - $as_echo_n 0123456789 >"conftest.in" - while : - do - cat "conftest.in" "conftest.in" >"conftest.tmp" - mv "conftest.tmp" "conftest.in" - cp "conftest.in" "conftest.nl" - $as_echo 'GREP' >> "conftest.nl" - "$ac_path_GREP" -e 'GREP$' -e '-(cannot match)-' < "conftest.nl" >"conftest.out" 2>/dev/null || break - diff "conftest.out" "conftest.nl" >/dev/null 2>&1 || break - as_fn_arith $ac_count + 1 && ac_count=$as_val - if test $ac_count -gt ${ac_path_GREP_max-0}; then - # Best one so far, save it but keep looking for a better one - ac_cv_path_GREP="$ac_path_GREP" - ac_path_GREP_max=$ac_count - fi - # 10*(2^10) chars as input seems more than enough - test $ac_count -gt 10 && break - done - rm -f conftest.in conftest.tmp conftest.nl conftest.out;; -esac - - $ac_path_GREP_found && break 3 - done - done - done -IFS=$as_save_IFS - if test -z "$ac_cv_path_GREP"; then - as_fn_error "no acceptable grep could be found in $PATH$PATH_SEPARATOR/usr/xpg4/bin" "$LINENO" 5 - fi -else - ac_cv_path_GREP=$GREP -fi - -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_path_GREP" >&5 -$as_echo "$ac_cv_path_GREP" >&6; } - GREP="$ac_cv_path_GREP" - - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for egrep" >&5 -$as_echo_n "checking for egrep... " >&6; } -if test "${ac_cv_path_EGREP+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if echo a | $GREP -E '(a|b)' >/dev/null 2>&1 - then ac_cv_path_EGREP="$GREP -E" - else - if test -z "$EGREP"; then - ac_path_EGREP_found=false - # Loop through the user's path and test for each of PROGNAME-LIST - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH$PATH_SEPARATOR/usr/xpg4/bin -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_prog in egrep; do - for ac_exec_ext in '' $ac_executable_extensions; do - ac_path_EGREP="$as_dir/$ac_prog$ac_exec_ext" - { test -f "$ac_path_EGREP" && $as_test_x "$ac_path_EGREP"; } || continue -# Check for GNU ac_path_EGREP and select it if it is found. - # Check for GNU $ac_path_EGREP -case `"$ac_path_EGREP" --version 2>&1` in -*GNU*) - ac_cv_path_EGREP="$ac_path_EGREP" ac_path_EGREP_found=:;; -*) - ac_count=0 - $as_echo_n 0123456789 >"conftest.in" - while : - do - cat "conftest.in" "conftest.in" >"conftest.tmp" - mv "conftest.tmp" "conftest.in" - cp "conftest.in" "conftest.nl" - $as_echo 'EGREP' >> "conftest.nl" - "$ac_path_EGREP" 'EGREP$' < "conftest.nl" >"conftest.out" 2>/dev/null || break - diff "conftest.out" "conftest.nl" >/dev/null 2>&1 || break - as_fn_arith $ac_count + 1 && ac_count=$as_val - if test $ac_count -gt ${ac_path_EGREP_max-0}; then - # Best one so far, save it but keep looking for a better one - ac_cv_path_EGREP="$ac_path_EGREP" - ac_path_EGREP_max=$ac_count - fi - # 10*(2^10) chars as input seems more than enough - test $ac_count -gt 10 && break - done - rm -f conftest.in conftest.tmp conftest.nl conftest.out;; -esac - - $ac_path_EGREP_found && break 3 - done - done - done -IFS=$as_save_IFS - if test -z "$ac_cv_path_EGREP"; then - as_fn_error "no acceptable egrep could be found in $PATH$PATH_SEPARATOR/usr/xpg4/bin" "$LINENO" 5 - fi -else - ac_cv_path_EGREP=$EGREP -fi - - fi -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_path_EGREP" >&5 -$as_echo "$ac_cv_path_EGREP" >&6; } - EGREP="$ac_cv_path_EGREP" - - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for ANSI C header files" >&5 -$as_echo_n "checking for ANSI C header files... " >&6; } -if test "${ac_cv_header_stdc+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include <stdlib.h> -#include <stdarg.h> -#include <string.h> -#include <float.h> - -int -main () -{ - - ; - return 0; -} -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - ac_cv_header_stdc=yes -else - ac_cv_header_stdc=no -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext - -if test $ac_cv_header_stdc = yes; then - # SunOS 4.x string.h does not declare mem*, contrary to ANSI. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include <string.h> - -_ACEOF -if (eval "$ac_cpp conftest.$ac_ext") 2>&5 | - $EGREP "memchr" >/dev/null 2>&1; then : - -else - ac_cv_header_stdc=no -fi -rm -f conftest* - -fi - -if test $ac_cv_header_stdc = yes; then - # ISC 2.0.2 stdlib.h does not declare free, contrary to ANSI. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include <stdlib.h> - -_ACEOF -if (eval "$ac_cpp conftest.$ac_ext") 2>&5 | - $EGREP "free" >/dev/null 2>&1; then : - -else - ac_cv_header_stdc=no -fi -rm -f conftest* - -fi - -if test $ac_cv_header_stdc = yes; then - # /bin/cc in Irix-4.0.5 gets non-ANSI ctype macros unless using -ansi. - if test "$cross_compiling" = yes; then : - : -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include <ctype.h> -#include <stdlib.h> -#if ((' ' & 0x0FF) == 0x020) -# define ISLOWER(c) ('a' <= (c) && (c) <= 'z') -# define TOUPPER(c) (ISLOWER(c) ? 'A' + ((c) - 'a') : (c)) -#else -# define ISLOWER(c) \ - (('a' <= (c) && (c) <= 'i') \ - || ('j' <= (c) && (c) <= 'r') \ - || ('s' <= (c) && (c) <= 'z')) -# define TOUPPER(c) (ISLOWER(c) ? ((c) | 0x40) : (c)) -#endif - -#define XOR(e, f) (((e) && !(f)) || (!(e) && (f))) -int -main () -{ - int i; - for (i = 0; i < 256; i++) - if (XOR (islower (i), ISLOWER (i)) - || toupper (i) != TOUPPER (i)) - return 2; - return 0; -} -_ACEOF -if ac_fn_c_try_run "$LINENO"; then : - -else - ac_cv_header_stdc=no -fi -rm -f core *.core core.conftest.* gmon.out bb.out conftest$ac_exeext \ - conftest.$ac_objext conftest.beam conftest.$ac_ext -fi - -fi -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_header_stdc" >&5 -$as_echo "$ac_cv_header_stdc" >&6; } -if test $ac_cv_header_stdc = yes; then - -$as_echo "#define STDC_HEADERS 1" >>confdefs.h - -fi - -# On IRIX 5.3, sys/types and inttypes.h are conflicting. -for ac_header in sys/types.h sys/stat.h stdlib.h string.h memory.h strings.h \ - inttypes.h stdint.h unistd.h -do : - as_ac_Header=`$as_echo "ac_cv_header_$ac_header" | $as_tr_sh` -ac_fn_c_check_header_compile "$LINENO" "$ac_header" "$as_ac_Header" "$ac_includes_default -" -eval as_val=\$$as_ac_Header - if test "x$as_val" = x""yes; then : - cat >>confdefs.h <<_ACEOF -#define `$as_echo "HAVE_$ac_header" | $as_tr_cpp` 1 -_ACEOF - -fi - -done - - -for ac_header in stdlib.h -do : - ac_fn_c_check_header_mongrel "$LINENO" "stdlib.h" "ac_cv_header_stdlib_h" "$ac_includes_default" -if test "x$ac_cv_header_stdlib_h" = x""yes; then : - cat >>confdefs.h <<_ACEOF -#define HAVE_STDLIB_H 1 -_ACEOF - -fi - -done - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for GNU libc compatible malloc" >&5 -$as_echo_n "checking for GNU libc compatible malloc... " >&6; } -if test "${ac_cv_func_malloc_0_nonnull+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test "$cross_compiling" = yes; then : - ac_cv_func_malloc_0_nonnull=no -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#if defined STDC_HEADERS || defined HAVE_STDLIB_H -# include <stdlib.h> -#else -char *malloc (); -#endif - -int -main () -{ -return ! malloc (0); - ; - return 0; -} -_ACEOF -if ac_fn_c_try_run "$LINENO"; then : - ac_cv_func_malloc_0_nonnull=yes -else - ac_cv_func_malloc_0_nonnull=no -fi -rm -f core *.core core.conftest.* gmon.out bb.out conftest$ac_exeext \ - conftest.$ac_objext conftest.beam conftest.$ac_ext -fi - -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_func_malloc_0_nonnull" >&5 -$as_echo "$ac_cv_func_malloc_0_nonnull" >&6; } -if test $ac_cv_func_malloc_0_nonnull = yes; then : - -$as_echo "#define HAVE_MALLOC 1" >>confdefs.h - -else - $as_echo "#define HAVE_MALLOC 0" >>confdefs.h - - case " $LIBOBJS " in - *" malloc.$ac_objext "* ) ;; - *) LIBOBJS="$LIBOBJS malloc.$ac_objext" - ;; -esac - - -$as_echo "#define malloc rpl_malloc" >>confdefs.h - -fi - - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for ANSI C header files" >&5 -$as_echo_n "checking for ANSI C header files... " >&6; } -if test "${ac_cv_header_stdc+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include <stdlib.h> -#include <stdarg.h> -#include <string.h> -#include <float.h> - -int -main () -{ - - ; - return 0; -} -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - ac_cv_header_stdc=yes -else - ac_cv_header_stdc=no -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext - -if test $ac_cv_header_stdc = yes; then - # SunOS 4.x string.h does not declare mem*, contrary to ANSI. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include <string.h> - -_ACEOF -if (eval "$ac_cpp conftest.$ac_ext") 2>&5 | - $EGREP "memchr" >/dev/null 2>&1; then : - -else - ac_cv_header_stdc=no -fi -rm -f conftest* - -fi - -if test $ac_cv_header_stdc = yes; then - # ISC 2.0.2 stdlib.h does not declare free, contrary to ANSI. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include <stdlib.h> - -_ACEOF -if (eval "$ac_cpp conftest.$ac_ext") 2>&5 | - $EGREP "free" >/dev/null 2>&1; then : - -else - ac_cv_header_stdc=no -fi -rm -f conftest* - -fi - -if test $ac_cv_header_stdc = yes; then - # /bin/cc in Irix-4.0.5 gets non-ANSI ctype macros unless using -ansi. - if test "$cross_compiling" = yes; then : - : -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include <ctype.h> -#include <stdlib.h> -#if ((' ' & 0x0FF) == 0x020) -# define ISLOWER(c) ('a' <= (c) && (c) <= 'z') -# define TOUPPER(c) (ISLOWER(c) ? 'A' + ((c) - 'a') : (c)) -#else -# define ISLOWER(c) \ - (('a' <= (c) && (c) <= 'i') \ - || ('j' <= (c) && (c) <= 'r') \ - || ('s' <= (c) && (c) <= 'z')) -# define TOUPPER(c) (ISLOWER(c) ? ((c) | 0x40) : (c)) -#endif - -#define XOR(e, f) (((e) && !(f)) || (!(e) && (f))) -int -main () -{ - int i; - for (i = 0; i < 256; i++) - if (XOR (islower (i), ISLOWER (i)) - || toupper (i) != TOUPPER (i)) - return 2; - return 0; -} -_ACEOF -if ac_fn_c_try_run "$LINENO"; then : - -else - ac_cv_header_stdc=no -fi -rm -f core *.core core.conftest.* gmon.out bb.out conftest$ac_exeext \ - conftest.$ac_objext conftest.beam conftest.$ac_ext -fi - -fi -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_header_stdc" >&5 -$as_echo "$ac_cv_header_stdc" >&6; } -if test $ac_cv_header_stdc = yes; then - -$as_echo "#define STDC_HEADERS 1" >>confdefs.h - -fi - - - -mod_muc= -make_mod_muc= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build mod_muc" >&5 -$as_echo_n "checking whether build mod_muc... " >&6; } -# Check whether --enable-mod_muc was given. -if test "${enable_mod_muc+set}" = set; then : - enableval=$enable_mod_muc; mr_enable_mod_muc="$enableval" -else - mr_enable_mod_muc=yes -fi - -if test "$mr_enable_mod_muc" = "yes"; then -mod_muc=mod_muc -make_mod_muc=mod_muc/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_mod_muc" >&5 -$as_echo "$mr_enable_mod_muc" >&6; } - - - - - -mod_proxy65= -make_mod_proxy65= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build mod_proxy65" >&5 -$as_echo_n "checking whether build mod_proxy65... " >&6; } -# Check whether --enable-mod_proxy65 was given. -if test "${enable_mod_proxy65+set}" = set; then : - enableval=$enable_mod_proxy65; mr_enable_mod_proxy65="$enableval" -else - mr_enable_mod_proxy65=yes -fi - -if test "$mr_enable_mod_proxy65" = "yes"; then -mod_proxy65=mod_proxy65 -make_mod_proxy65=mod_proxy65/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_mod_proxy65" >&5 -$as_echo "$mr_enable_mod_proxy65" >&6; } - - - - - -mod_pubsub= -make_mod_pubsub= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build mod_pubsub" >&5 -$as_echo_n "checking whether build mod_pubsub... " >&6; } -# Check whether --enable-mod_pubsub was given. -if test "${enable_mod_pubsub+set}" = set; then : - enableval=$enable_mod_pubsub; mr_enable_mod_pubsub="$enableval" -else - mr_enable_mod_pubsub=yes -fi - -if test "$mr_enable_mod_pubsub" = "yes"; then -mod_pubsub=mod_pubsub -make_mod_pubsub=mod_pubsub/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_mod_pubsub" >&5 -$as_echo "$mr_enable_mod_pubsub" >&6; } - - - - - -eldap= -make_eldap= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build eldap" >&5 -$as_echo_n "checking whether build eldap... " >&6; } -# Check whether --enable-eldap was given. -if test "${enable_eldap+set}" = set; then : - enableval=$enable_eldap; mr_enable_eldap="$enableval" -else - mr_enable_eldap=yes -fi - -if test "$mr_enable_eldap" = "yes"; then -eldap=eldap -make_eldap=eldap/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_eldap" >&5 -$as_echo "$mr_enable_eldap" >&6; } - - - - - -odbc= -make_odbc= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build odbc" >&5 -$as_echo_n "checking whether build odbc... " >&6; } -# Check whether --enable-odbc was given. -if test "${enable_odbc+set}" = set; then : - enableval=$enable_odbc; mr_enable_odbc="$enableval" -else - mr_enable_odbc=no -fi - -if test "$mr_enable_odbc" = "yes"; then -odbc=odbc -make_odbc=odbc/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_odbc" >&5 -$as_echo "$mr_enable_odbc" >&6; } - - - - - -tls= -make_tls= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build tls" >&5 -$as_echo_n "checking whether build tls... " >&6; } -# Check whether --enable-tls was given. -if test "${enable_tls+set}" = set; then : - enableval=$enable_tls; mr_enable_tls="$enableval" -else - mr_enable_tls=yes -fi - -if test "$mr_enable_tls" = "yes"; then -tls=tls -make_tls=tls/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_tls" >&5 -$as_echo "$mr_enable_tls" >&6; } - - - - - -web= -make_web= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build web" >&5 -$as_echo_n "checking whether build web... " >&6; } -# Check whether --enable-web was given. -if test "${enable_web+set}" = set; then : - enableval=$enable_web; mr_enable_web="$enableval" -else - mr_enable_web=yes -fi - -if test "$mr_enable_web" = "yes"; then -web=web -make_web=web/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_web" >&5 -$as_echo "$mr_enable_web" >&6; } - - - - - - -ejabberd_zlib= -make_ejabberd_zlib= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build ejabberd_zlib" >&5 -$as_echo_n "checking whether build ejabberd_zlib... " >&6; } -# Check whether --enable-ejabberd_zlib was given. -if test "${enable_ejabberd_zlib+set}" = set; then : - enableval=$enable_ejabberd_zlib; mr_enable_ejabberd_zlib="$enableval" -else - mr_enable_ejabberd_zlib=yes -fi - -if test "$mr_enable_ejabberd_zlib" = "yes"; then -ejabberd_zlib=ejabberd_zlib -make_ejabberd_zlib=ejabberd_zlib/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_ejabberd_zlib" >&5 -$as_echo "$mr_enable_ejabberd_zlib" >&6; } - - - - -#locating zlib - -# Check whether --with-zlib was given. -if test "${with_zlib+set}" = set; then : - withval=$with_zlib; -fi - - -if test x"$ejabberd_zlib" != x; then - ZLIB_CFLAGS= - ZLIB_LIBS= - if test x"$with_zlib" != x; then - ZLIB_CFLAGS="-I$with_zlib/include" - ZLIB_LIBS="-L$with_zlib/lib" - fi - - { $as_echo "$as_me:${as_lineno-$LINENO}: checking for gzgets in -lz" >&5 -$as_echo_n "checking for gzgets in -lz... " >&6; } -if test "${ac_cv_lib_z_gzgets+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - ac_check_lib_save_LIBS=$LIBS -LIBS="-lz "$ZLIB_LIBS" $LIBS" -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -/* Override any GCC internal prototype to avoid an error. - Use char because int might match the return type of a GCC - builtin and then its argument prototype would still apply. */ -#ifdef __cplusplus -extern "C" -#endif -char gzgets (); -int -main () -{ -return gzgets (); - ; - return 0; -} -_ACEOF -if ac_fn_c_try_link "$LINENO"; then : - ac_cv_lib_z_gzgets=yes -else - ac_cv_lib_z_gzgets=no -fi -rm -f core conftest.err conftest.$ac_objext \ - conftest$ac_exeext conftest.$ac_ext -LIBS=$ac_check_lib_save_LIBS -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_lib_z_gzgets" >&5 -$as_echo "$ac_cv_lib_z_gzgets" >&6; } -if test "x$ac_cv_lib_z_gzgets" = x""yes; then : - ZLIB_LIBS="$ZLIB_LIBS -lz" - zlib_found=yes -else - zlib_found=no -fi - - if test $zlib_found = no; then - as_fn_error "Could not find development files of zlib library. Install them or disable \`ejabberd_zlib' with: --disable-ejabberd_zlib" "$LINENO" 5 - fi - zlib_save_CFLAGS="$CFLAGS" - CFLAGS="$CFLAGS $ZLIB_CFLAGS" - zlib_save_CPPFLAGS="$CFLAGS" - CPPFLAGS="$CPPFLAGS $ZLIB_CFLAGS" - for ac_header in zlib.h -do : - ac_fn_c_check_header_mongrel "$LINENO" "zlib.h" "ac_cv_header_zlib_h" "$ac_includes_default" -if test "x$ac_cv_header_zlib_h" = x""yes; then : - cat >>confdefs.h <<_ACEOF -#define HAVE_ZLIB_H 1 -_ACEOF - -else - zlib_found=no -fi - -done - - if test $zlib_found = no; then - as_fn_error "Could not find zlib.h. Install it or disable \`ejabberd_zlib' with: --disable-ejabberd_zlib" "$LINENO" 5 - fi - CFLAGS="$zlib_save_CFLAGS" - CPPFLAGS="$zlib_save_CPPFLAGS" - - - -fi - - - -pam= -make_pam= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build pam" >&5 -$as_echo_n "checking whether build pam... " >&6; } -# Check whether --enable-pam was given. -if test "${enable_pam+set}" = set; then : - enableval=$enable_pam; mr_enable_pam="$enableval" -else - mr_enable_pam=no -fi - -if test "$mr_enable_pam" = "yes"; then -pam=pam -make_pam=pam/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_pam" >&5 -$as_echo "$mr_enable_pam" >&6; } - - - - -#locating PAM - -# Check whether --with-pam was given. -if test "${with_pam+set}" = set; then : - withval=$with_pam; -fi - -if test x"$pam" != x; then - PAM_CFLAGS= - PAM_LIBS= - if test x"$with_pam" != x; then - PAM_CFLAGS="-I$with_pam/include" - PAM_LIBS="-L$with_pam/lib" - fi - - { $as_echo "$as_me:${as_lineno-$LINENO}: checking for pam_start in -lpam" >&5 -$as_echo_n "checking for pam_start in -lpam... " >&6; } -if test "${ac_cv_lib_pam_pam_start+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - ac_check_lib_save_LIBS=$LIBS -LIBS="-lpam "$PAM_LIBS" $LIBS" -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -/* Override any GCC internal prototype to avoid an error. - Use char because int might match the return type of a GCC - builtin and then its argument prototype would still apply. */ -#ifdef __cplusplus -extern "C" -#endif -char pam_start (); -int -main () -{ -return pam_start (); - ; - return 0; -} -_ACEOF -if ac_fn_c_try_link "$LINENO"; then : - ac_cv_lib_pam_pam_start=yes -else - ac_cv_lib_pam_pam_start=no -fi -rm -f core conftest.err conftest.$ac_objext \ - conftest$ac_exeext conftest.$ac_ext -LIBS=$ac_check_lib_save_LIBS -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_lib_pam_pam_start" >&5 -$as_echo "$ac_cv_lib_pam_pam_start" >&6; } -if test "x$ac_cv_lib_pam_pam_start" = x""yes; then : - PAM_LIBS="$PAM_LIBS -lpam" - pam_found=yes -else - pam_found=no -fi - - if test $pam_found = no; then - as_fn_error "Could not find development files of PAM library. Install them or disable \`pam' with: --disable-pam" "$LINENO" 5 - fi - pam_save_CFLAGS="$CFLAGS" - CFLAGS="$CFLAGS $PAM_CFLAGS" - pam_save_CPPFLAGS="$CPPFLAGS" - CPPFLAGS="$CPPFLAGS $PAM_CFLAGS" - for ac_header in security/pam_appl.h -do : - ac_fn_c_check_header_mongrel "$LINENO" "security/pam_appl.h" "ac_cv_header_security_pam_appl_h" "$ac_includes_default" -if test "x$ac_cv_header_security_pam_appl_h" = x""yes; then : - cat >>confdefs.h <<_ACEOF -#define HAVE_SECURITY_PAM_APPL_H 1 -_ACEOF - -else - pam_found=no -fi - -done - - if test $pam_found = no; then - as_fn_error "Could not find security/pam_appl.h. Install it or disable \`pam' with: --disable-pam" "$LINENO" 5 - fi - CFLAGS="$pam_save_CFLAGS" - CPPFLAGS="$pam_save_CPPFLAGS" - - - -fi - - -# Check whether --enable-hipe was given. -if test "${enable_hipe+set}" = set; then : - enableval=$enable_hipe; case "${enableval}" in - yes) hipe=true ;; - no) hipe=false ;; - *) as_fn_error "bad value ${enableval} for --enable-hipe" "$LINENO" 5 ;; -esac -else - hipe=false -fi - - - -# Check whether --enable-roster_gateway_workaround was given. -if test "${enable_roster_gateway_workaround+set}" = set; then : - enableval=$enable_roster_gateway_workaround; case "${enableval}" in - yes) roster_gateway_workaround=true ;; - no) roster_gateway_workaround=false ;; - *) as_fn_error "bad value ${enableval} for --enable-roster-gateway-workaround" "$LINENO" 5 ;; -esac -else - roster_gateway_workaround=false -fi - - - -# Check whether --enable-mssql was given. -if test "${enable_mssql+set}" = set; then : - enableval=$enable_mssql; case "${enableval}" in - yes) db_type=mssql ;; - no) db_type=generic ;; - *) as_fn_error "bad value ${enableval} for --enable-mssql" "$LINENO" 5 ;; -esac -else - db_type=generic -fi - - - -# Check whether --enable-transient_supervisors was given. -if test "${enable_transient_supervisors+set}" = set; then : - enableval=$enable_transient_supervisors; case "${enableval}" in - yes) transient_supervisors=true ;; - no) transient_supervisors=false ;; - *) as_fn_error "bad value ${enableval} for --enable-transient_supervisors" "$LINENO" 5 ;; -esac -else - transient_supervisors=true -fi - - - -# Check whether --enable-full_xml was given. -if test "${enable_full_xml+set}" = set; then : - enableval=$enable_full_xml; case "${enableval}" in - yes) full_xml=true ;; - no) full_xml=false ;; - *) as_fn_error "bad value ${enableval} for --enable-full-xml" "$LINENO" 5 ;; -esac -else - full_xml=false -fi - - - -ac_config_files="$ac_config_files Makefile $make_mod_muc $make_mod_pubsub $make_mod_proxy65 $make_eldap $make_pam $make_web stun/Makefile $make_tls $make_odbc $make_ejabberd_zlib" - -#openssl - -# Check whether --with-openssl was given. -if test "${with_openssl+set}" = set; then : - withval=$with_openssl; -fi - -unset SSL_LIBS; -unset SSL_CFLAGS; -have_openssl=no -if test x"$tls" != x; then - for ssl_prefix in $withval /usr/local/ssl /usr/lib/ssl /usr/ssl /usr/pkg /usr/local /usr; do - printf "looking for openssl in $ssl_prefix...\n" - SSL_CFLAGS="-I$ssl_prefix/include" - SSL_LIBS="-L$ssl_prefix/lib -lcrypto" - { $as_echo "$as_me:${as_lineno-$LINENO}: checking for SSL_new in -lssl" >&5 -$as_echo_n "checking for SSL_new in -lssl... " >&6; } -if test "${ac_cv_lib_ssl_SSL_new+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - ac_check_lib_save_LIBS=$LIBS -LIBS="-lssl $SSL_LIBS $SSL_CFLAGS $LIBS" -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -/* Override any GCC internal prototype to avoid an error. - Use char because int might match the return type of a GCC - builtin and then its argument prototype would still apply. */ -#ifdef __cplusplus -extern "C" -#endif -char SSL_new (); -int -main () -{ -return SSL_new (); - ; - return 0; -} -_ACEOF -if ac_fn_c_try_link "$LINENO"; then : - ac_cv_lib_ssl_SSL_new=yes -else - ac_cv_lib_ssl_SSL_new=no -fi -rm -f core conftest.err conftest.$ac_objext \ - conftest$ac_exeext conftest.$ac_ext -LIBS=$ac_check_lib_save_LIBS -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_lib_ssl_SSL_new" >&5 -$as_echo "$ac_cv_lib_ssl_SSL_new" >&6; } -if test "x$ac_cv_lib_ssl_SSL_new" = x""yes; then : - have_openssl=yes -else - have_openssl=no -fi - - if test x"$have_openssl" = xyes; then - save_CPPFLAGS=$CPPFLAGS - CPPFLAGS="-I$ssl_prefix/include $CPPFLAGS" - for ac_header in openssl/ssl.h -do : - ac_fn_c_check_header_mongrel "$LINENO" "openssl/ssl.h" "ac_cv_header_openssl_ssl_h" "$ac_includes_default" -if test "x$ac_cv_header_openssl_ssl_h" = x""yes; then : - cat >>confdefs.h <<_ACEOF -#define HAVE_OPENSSL_SSL_H 1 -_ACEOF - have_openssl_h=yes -fi - -done - - CPPFLAGS=$save_CPPFLAGS - if test x"$have_openssl_h" = xyes; then - have_openssl=yes - printf "openssl found in $ssl_prefix\n"; - SSL_LIBS="-L$ssl_prefix/lib -lssl -lcrypto" - CPPFLAGS="-I$ssl_prefix/include $CPPFLAGS" - SSL_CFLAGS="-DHAVE_SSL" - break - fi - else - # Clear this from the autoconf cache, so in the next pass of - # this loop with different -L arguments, it will test again. - unset ac_cv_lib_ssl_SSL_new - fi - done -if test x${have_openssl} != xyes; then - as_fn_error "Could not find development files of OpenSSL library. Install them or disable \`tls' with: --disable-tls" "$LINENO" 5 -fi - - -fi - -# If ssl is kerberized it need krb5.h -# On RedHat and OpenBSD, krb5.h is in an unsual place: -KRB5_INCLUDE="`krb5-config --cflags 2>/dev/null`" -if test -n "$KRB5_INCLUDE" ; then - CPPFLAGS="$CPPFLAGS $KRB5_INCLUDE" -else - # For RedHat For BSD - for D in /usr/kerberos/include /usr/include/kerberos /usr/include/kerberosV - do - if test -d $D ; then - CPPFLAGS="$CPPFLAGS -I$D" - fi - done -fi -ac_fn_c_check_header_mongrel "$LINENO" "krb5.h" "ac_cv_header_krb5_h" "$ac_includes_default" -if test "x$ac_cv_header_krb5_h" = x""yes; then : - -fi - - - -ENABLEUSER="" -# Check whether --enable-user was given. -if test "${enable_user+set}" = set; then : - enableval=$enable_user; case "${enableval}" in - yes) ENABLEUSER=`whoami` ;; - no) ENABLEUSER="" ;; - *) ENABLEUSER=$enableval - esac -fi - -if test "$ENABLEUSER" != ""; then - echo "allow this system user to start ejabberd: $ENABLEUSER" - INSTALLUSER=$ENABLEUSER - -fi - -ac_fn_c_check_header_mongrel "$LINENO" "openssl/md2.h" "ac_cv_header_openssl_md2_h" "$ac_includes_default" -if test "x$ac_cv_header_openssl_md2_h" = x""yes; then : - md2=true -else - md2=false -fi - - - - -ac_aux_dir= -for ac_dir in "$srcdir" "$srcdir/.." "$srcdir/../.."; do - for ac_t in install-sh install.sh shtool; do - if test -f "$ac_dir/$ac_t"; then - ac_aux_dir=$ac_dir - ac_install_sh="$ac_aux_dir/$ac_t -c" - break 2 - fi - done -done -if test -z "$ac_aux_dir"; then - as_fn_error "cannot find install-sh, install.sh, or shtool in \"$srcdir\" \"$srcdir/..\" \"$srcdir/../..\"" "$LINENO" 5 -fi - -# These three variables are undocumented and unsupported, -# and are intended to be withdrawn in a future Autoconf release. -# They can cause serious problems if a builder's source tree is in a directory -# whose full name contains unusual characters. -ac_config_guess="$SHELL $ac_aux_dir/config.guess" # Please don't use this var. -ac_config_sub="$SHELL $ac_aux_dir/config.sub" # Please don't use this var. -ac_configure="$SHELL $ac_aux_dir/configure" # Please don't use this var. - - -# Make sure we can run config.sub. -$SHELL "$ac_aux_dir/config.sub" sun4 >/dev/null 2>&1 || - as_fn_error "cannot run $SHELL $ac_aux_dir/config.sub" "$LINENO" 5 - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking build system type" >&5 -$as_echo_n "checking build system type... " >&6; } -if test "${ac_cv_build+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - ac_build_alias=$build_alias -test "x$ac_build_alias" = x && - ac_build_alias=`$SHELL "$ac_aux_dir/config.guess"` -test "x$ac_build_alias" = x && - as_fn_error "cannot guess build type; you must specify one" "$LINENO" 5 -ac_cv_build=`$SHELL "$ac_aux_dir/config.sub" $ac_build_alias` || - as_fn_error "$SHELL $ac_aux_dir/config.sub $ac_build_alias failed" "$LINENO" 5 - -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_build" >&5 -$as_echo "$ac_cv_build" >&6; } -case $ac_cv_build in -*-*-*) ;; -*) as_fn_error "invalid value of canonical build" "$LINENO" 5;; -esac -build=$ac_cv_build -ac_save_IFS=$IFS; IFS='-' -set x $ac_cv_build -shift -build_cpu=$1 -build_vendor=$2 -shift; shift -# Remember, the first character of IFS is used to create $*, -# except with old shells: -build_os=$* -IFS=$ac_save_IFS -case $build_os in *\ *) build_os=`echo "$build_os" | sed 's/ /-/g'`;; esac - - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking host system type" >&5 -$as_echo_n "checking host system type... " >&6; } -if test "${ac_cv_host+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test "x$host_alias" = x; then - ac_cv_host=$ac_cv_build -else - ac_cv_host=`$SHELL "$ac_aux_dir/config.sub" $host_alias` || - as_fn_error "$SHELL $ac_aux_dir/config.sub $host_alias failed" "$LINENO" 5 -fi - -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_host" >&5 -$as_echo "$ac_cv_host" >&6; } -case $ac_cv_host in -*-*-*) ;; -*) as_fn_error "invalid value of canonical host" "$LINENO" 5;; -esac -host=$ac_cv_host -ac_save_IFS=$IFS; IFS='-' -set x $ac_cv_host -shift -host_cpu=$1 -host_vendor=$2 -shift; shift -# Remember, the first character of IFS is used to create $*, -# except with old shells: -host_os=$* -IFS=$ac_save_IFS -case $host_os in *\ *) host_os=`echo "$host_os" | sed 's/ /-/g'`;; esac - - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking target system type" >&5 -$as_echo_n "checking target system type... " >&6; } -if test "${ac_cv_target+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test "x$target_alias" = x; then - ac_cv_target=$ac_cv_host -else - ac_cv_target=`$SHELL "$ac_aux_dir/config.sub" $target_alias` || - as_fn_error "$SHELL $ac_aux_dir/config.sub $target_alias failed" "$LINENO" 5 -fi - -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_target" >&5 -$as_echo "$ac_cv_target" >&6; } -case $ac_cv_target in -*-*-*) ;; -*) as_fn_error "invalid value of canonical target" "$LINENO" 5;; -esac -target=$ac_cv_target -ac_save_IFS=$IFS; IFS='-' -set x $ac_cv_target -shift -target_cpu=$1 -target_vendor=$2 -shift; shift -# Remember, the first character of IFS is used to create $*, -# except with old shells: -target_os=$* -IFS=$ac_save_IFS -case $target_os in *\ *) target_os=`echo "$target_os" | sed 's/ /-/g'`;; esac - - -# The aliases save the names the user supplied, while $host etc. -# will get canonicalized. -test -n "$target_alias" && - test "$program_prefix$program_suffix$program_transform_name" = \ - NONENONEs,x,x, && - program_prefix=${target_alias}- - -#AC_DEFINE_UNQUOTED(CPU_VENDOR_OS, "$target") -#AC_SUBST(target_os) - - -case "$target_os" in - *darwin10*) - echo "Target OS is 'Darwin10'" - ac_ext=erl -ac_compile='$ERLC $ERLCFLAGS -b beam conftest.$ac_ext >&5' -ac_link='$ERLC $ERLCFLAGS -b beam conftest.$ac_ext >&5 && echo "#!/bin/sh" > conftest$ac_exeext && $as_echo "\"$ERL\" -run conftest start -run init stop -noshell" >> conftest$ac_exeext && chmod +x conftest$ac_exeext' - - if test -n "$ERLC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: checking for erlc" >&5 -$as_echo_n "checking for erlc... " >&6; } - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ERLC" >&5 -$as_echo "$ERLC" >&6; } -else - if test -n "$ac_tool_prefix"; then - # Extract the first word of "${ac_tool_prefix}erlc", so it can be a program name with args. -set dummy ${ac_tool_prefix}erlc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_path_ERLC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - case $ERLC in - [\\/]* | ?:[\\/]*) - ac_cv_path_ERLC="$ERLC" # Let the user override the test with a path. - ;; - *) - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_path_ERLC="$as_dir/$ac_word$ac_exec_ext" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - - ;; -esac -fi -ERLC=$ac_cv_path_ERLC -if test -n "$ERLC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ERLC" >&5 -$as_echo "$ERLC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - -fi -if test -z "$ac_cv_path_ERLC"; then - ac_pt_ERLC=$ERLC - # Extract the first word of "erlc", so it can be a program name with args. -set dummy erlc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_path_ac_pt_ERLC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - case $ac_pt_ERLC in - [\\/]* | ?:[\\/]*) - ac_cv_path_ac_pt_ERLC="$ac_pt_ERLC" # Let the user override the test with a path. - ;; - *) - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_path_ac_pt_ERLC="$as_dir/$ac_word$ac_exec_ext" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - - ;; -esac -fi -ac_pt_ERLC=$ac_cv_path_ac_pt_ERLC -if test -n "$ac_pt_ERLC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_pt_ERLC" >&5 -$as_echo "$ac_pt_ERLC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - if test "x$ac_pt_ERLC" = x; then - ERLC="" - else - case $cross_compiling:$ac_tool_warned in -yes:) -{ $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 -$as_echo "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} -ac_tool_warned=yes ;; -esac - ERLC=$ac_pt_ERLC - fi -else - ERLC="$ac_cv_path_ERLC" -fi - -fi - - -if test "$cross_compiling" = yes; then : - { { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} -as_fn_error "cannot run test program while cross compiling -See \`config.log' for more details." "$LINENO" 5; } -else - cat > conftest.$ac_ext <<_ACEOF --module(conftest). --export([start/0]). - -start() -> - halt(case erlang:system_info(wordsize) of - 8 -> 0; 4 -> 1 end) -. - -_ACEOF -if ac_fn_erl_try_run "$LINENO"; then : - { $as_echo "$as_me:${as_lineno-$LINENO}: found 64-bit Erlang" >&5 -$as_echo "$as_me: found 64-bit Erlang" >&6;} - CBIT=-m64 -else - { $as_echo "$as_me:${as_lineno-$LINENO}: found 32-bit Erlang" >&5 -$as_echo "$as_me: found 32-bit Erlang" >&6;} - CBIT=-m32 -fi -rm -f core *.core core.conftest.* gmon.out bb.out conftest$ac_exeext \ - conftest.$ac_objext conftest.beam conftest.$ac_ext -fi - - ;; - *) - echo "Target OS is '$target_os'" - CBIT="" - ;; -esac -CFLAGS="$CFLAGS $CBIT" -LD_SHARED="$LD_SHARED $CBIT" -echo "CBIT is set to '$CBIT'" - -cat >confcache <<\_ACEOF -# This file is a shell script that caches the results of configure -# tests run on this system so they can be shared between configure -# scripts and configure runs, see configure's option --config-cache. -# It is not useful on other systems. If it contains results you don't -# want to keep, you may remove or edit it. -# -# config.status only pays attention to the cache file if you give it -# the --recheck option to rerun configure. -# -# `ac_cv_env_foo' variables (set or unset) will be overridden when -# loading this file, other *unset* `ac_cv_foo' will be assigned the -# following values. - -_ACEOF - -# The following way of writing the cache mishandles newlines in values, -# but we know of no workaround that is simple, portable, and efficient. -# So, we kill variables containing newlines. -# Ultrix sh set writes to stderr and can't be redirected directly, -# and sets the high bit in the cache file unless we assign to the vars. -( - for ac_var in `(set) 2>&1 | sed -n 's/^\([a-zA-Z_][a-zA-Z0-9_]*\)=.*/\1/p'`; do - eval ac_val=\$$ac_var - case $ac_val in #( - *${as_nl}*) - case $ac_var in #( - *_cv_*) { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: cache variable $ac_var contains a newline" >&5 -$as_echo "$as_me: WARNING: cache variable $ac_var contains a newline" >&2;} ;; - esac - case $ac_var in #( - _ | IFS | as_nl) ;; #( - BASH_ARGV | BASH_SOURCE) eval $ac_var= ;; #( - *) { eval $ac_var=; unset $ac_var;} ;; - esac ;; - esac - done - - (set) 2>&1 | - case $as_nl`(ac_space=' '; set) 2>&1` in #( - *${as_nl}ac_space=\ *) - # `set' does not quote correctly, so add quotes: double-quote - # substitution turns \\\\ into \\, and sed turns \\ into \. - sed -n \ - "s/'/'\\\\''/g; - s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1='\\2'/p" - ;; #( - *) - # `set' quotes correctly as required by POSIX, so do not add quotes. - sed -n "/^[_$as_cr_alnum]*_cv_[_$as_cr_alnum]*=/p" - ;; - esac | - sort -) | - sed ' - /^ac_cv_env_/b end - t clear - :clear - s/^\([^=]*\)=\(.*[{}].*\)$/test "${\1+set}" = set || &/ - t end - s/^\([^=]*\)=\(.*\)$/\1=${\1=\2}/ - :end' >>confcache -if diff "$cache_file" confcache >/dev/null 2>&1; then :; else - if test -w "$cache_file"; then - test "x$cache_file" != "x/dev/null" && - { $as_echo "$as_me:${as_lineno-$LINENO}: updating cache $cache_file" >&5 -$as_echo "$as_me: updating cache $cache_file" >&6;} - cat confcache >$cache_file - else - { $as_echo "$as_me:${as_lineno-$LINENO}: not updating unwritable cache $cache_file" >&5 -$as_echo "$as_me: not updating unwritable cache $cache_file" >&6;} - fi -fi -rm -f confcache - -test "x$prefix" = xNONE && prefix=$ac_default_prefix -# Let make expand exec_prefix. -test "x$exec_prefix" = xNONE && exec_prefix='${prefix}' - -# Transform confdefs.h into DEFS. -# Protect against shell expansion while executing Makefile rules. -# Protect against Makefile macro expansion. -# -# If the first sed substitution is executed (which looks for macros that -# take arguments), then branch to the quote section. Otherwise, -# look for a macro that doesn't take arguments. -ac_script=' -:mline -/\\$/{ - N - s,\\\n,, - b mline -} -t clear -:clear -s/^[ ]*#[ ]*define[ ][ ]*\([^ (][^ (]*([^)]*)\)[ ]*\(.*\)/-D\1=\2/g -t quote -s/^[ ]*#[ ]*define[ ][ ]*\([^ ][^ ]*\)[ ]*\(.*\)/-D\1=\2/g -t quote -b any -:quote -s/[ `~#$^&*(){}\\|;'\''"<>?]/\\&/g -s/\[/\\&/g -s/\]/\\&/g -s/\$/$$/g -H -:any -${ - g - s/^\n// - s/\n/ /g - p -} -' -DEFS=`sed -n "$ac_script" confdefs.h` - - -ac_libobjs= -ac_ltlibobjs= -for ac_i in : $LIBOBJS; do test "x$ac_i" = x: && continue - # 1. Remove the extension, and $U if already installed. - ac_script='s/\$U\././;s/\.o$//;s/\.obj$//' - ac_i=`$as_echo "$ac_i" | sed "$ac_script"` - # 2. Prepend LIBOBJDIR. When used with automake>=1.10 LIBOBJDIR - # will be set to the directory where LIBOBJS objects are built. - as_fn_append ac_libobjs " \${LIBOBJDIR}$ac_i\$U.$ac_objext" - as_fn_append ac_ltlibobjs " \${LIBOBJDIR}$ac_i"'$U.lo' -done -LIBOBJS=$ac_libobjs - -LTLIBOBJS=$ac_ltlibobjs - - - -: ${CONFIG_STATUS=./config.status} -ac_write_fail=0 -ac_clean_files_save=$ac_clean_files -ac_clean_files="$ac_clean_files $CONFIG_STATUS" -{ $as_echo "$as_me:${as_lineno-$LINENO}: creating $CONFIG_STATUS" >&5 -$as_echo "$as_me: creating $CONFIG_STATUS" >&6;} -as_write_fail=0 -cat >$CONFIG_STATUS <<_ASEOF || as_write_fail=1 -#! $SHELL -# Generated by $as_me. -# Run this file to recreate the current configuration. -# Compiler output produced by configure, useful for debugging -# configure, is in config.log if it exists. - -debug=false -ac_cs_recheck=false -ac_cs_silent=false - -SHELL=\${CONFIG_SHELL-$SHELL} -export SHELL -_ASEOF -cat >>$CONFIG_STATUS <<\_ASEOF || as_write_fail=1 -## -------------------- ## -## M4sh Initialization. ## -## -------------------- ## - -# Be more Bourne compatible -DUALCASE=1; export DUALCASE # for MKS sh -if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then : - emulate sh - NULLCMD=: - # Pre-4.2 versions of Zsh do word splitting on ${1+"$@"}, which - # is contrary to our usage. Disable this feature. - alias -g '${1+"$@"}'='"$@"' - setopt NO_GLOB_SUBST -else - case `(set -o) 2>/dev/null` in #( - *posix*) : - set -o posix ;; #( - *) : - ;; -esac -fi - - -as_nl=' -' -export as_nl -# Printing a long string crashes Solaris 7 /usr/bin/printf. -as_echo='\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\' -as_echo=$as_echo$as_echo$as_echo$as_echo$as_echo -as_echo=$as_echo$as_echo$as_echo$as_echo$as_echo$as_echo -# Prefer a ksh shell builtin over an external printf program on Solaris, -# but without wasting forks for bash or zsh. -if test -z "$BASH_VERSION$ZSH_VERSION" \ - && (test "X`print -r -- $as_echo`" = "X$as_echo") 2>/dev/null; then - as_echo='print -r --' - as_echo_n='print -rn --' -elif (test "X`printf %s $as_echo`" = "X$as_echo") 2>/dev/null; then - as_echo='printf %s\n' - as_echo_n='printf %s' -else - if test "X`(/usr/ucb/echo -n -n $as_echo) 2>/dev/null`" = "X-n $as_echo"; then - as_echo_body='eval /usr/ucb/echo -n "$1$as_nl"' - as_echo_n='/usr/ucb/echo -n' - else - as_echo_body='eval expr "X$1" : "X\\(.*\\)"' - as_echo_n_body='eval - arg=$1; - case $arg in #( - *"$as_nl"*) - expr "X$arg" : "X\\(.*\\)$as_nl"; - arg=`expr "X$arg" : ".*$as_nl\\(.*\\)"`;; - esac; - expr "X$arg" : "X\\(.*\\)" | tr -d "$as_nl" - ' - export as_echo_n_body - as_echo_n='sh -c $as_echo_n_body as_echo' - fi - export as_echo_body - as_echo='sh -c $as_echo_body as_echo' -fi - -# The user is always right. -if test "${PATH_SEPARATOR+set}" != set; then - PATH_SEPARATOR=: - (PATH='/bin;/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 && { - (PATH='/bin:/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 || - PATH_SEPARATOR=';' - } -fi - - -# IFS -# We need space, tab and new line, in precisely that order. Quoting is -# there to prevent editors from complaining about space-tab. -# (If _AS_PATH_WALK were called with IFS unset, it would disable word -# splitting by setting IFS to empty value.) -IFS=" "" $as_nl" - -# Find who we are. Look in the path if we contain no directory separator. -case $0 in #(( - *[\\/]* ) as_myself=$0 ;; - *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - test -r "$as_dir/$0" && as_myself=$as_dir/$0 && break - done -IFS=$as_save_IFS - - ;; -esac -# We did not find ourselves, most probably we were run as `sh COMMAND' -# in which case we are not to be found in the path. -if test "x$as_myself" = x; then - as_myself=$0 -fi -if test ! -f "$as_myself"; then - $as_echo "$as_myself: error: cannot find myself; rerun with an absolute file name" >&2 - exit 1 -fi - -# Unset variables that we do not need and which cause bugs (e.g. in -# pre-3.0 UWIN ksh). But do not cause bugs in bash 2.01; the "|| exit 1" -# suppresses any "Segmentation fault" message there. '((' could -# trigger a bug in pdksh 5.2.14. -for as_var in BASH_ENV ENV MAIL MAILPATH -do eval test x\${$as_var+set} = xset \ - && ( (unset $as_var) || exit 1) >/dev/null 2>&1 && unset $as_var || : -done -PS1='$ ' -PS2='> ' -PS4='+ ' - -# NLS nuisances. -LC_ALL=C -export LC_ALL -LANGUAGE=C -export LANGUAGE - -# CDPATH. -(unset CDPATH) >/dev/null 2>&1 && unset CDPATH - - -# as_fn_error ERROR [LINENO LOG_FD] -# --------------------------------- -# Output "`basename $0`: error: ERROR" to stderr. If LINENO and LOG_FD are -# provided, also output the error to LOG_FD, referencing LINENO. Then exit the -# script with status $?, using 1 if that was 0. -as_fn_error () -{ - as_status=$?; test $as_status -eq 0 && as_status=1 - if test "$3"; then - as_lineno=${as_lineno-"$2"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - $as_echo "$as_me:${as_lineno-$LINENO}: error: $1" >&$3 - fi - $as_echo "$as_me: error: $1" >&2 - as_fn_exit $as_status -} # as_fn_error - - -# as_fn_set_status STATUS -# ----------------------- -# Set $? to STATUS, without forking. -as_fn_set_status () -{ - return $1 -} # as_fn_set_status - -# as_fn_exit STATUS -# ----------------- -# Exit the shell with STATUS, even in a "trap 0" or "set -e" context. -as_fn_exit () -{ - set +e - as_fn_set_status $1 - exit $1 -} # as_fn_exit - -# as_fn_unset VAR -# --------------- -# Portably unset VAR. -as_fn_unset () -{ - { eval $1=; unset $1;} -} -as_unset=as_fn_unset -# as_fn_append VAR VALUE -# ---------------------- -# Append the text in VALUE to the end of the definition contained in VAR. Take -# advantage of any shell optimizations that allow amortized linear growth over -# repeated appends, instead of the typical quadratic growth present in naive -# implementations. -if (eval "as_var=1; as_var+=2; test x\$as_var = x12") 2>/dev/null; then : - eval 'as_fn_append () - { - eval $1+=\$2 - }' -else - as_fn_append () - { - eval $1=\$$1\$2 - } -fi # as_fn_append - -# as_fn_arith ARG... -# ------------------ -# Perform arithmetic evaluation on the ARGs, and store the result in the -# global $as_val. Take advantage of shells that can avoid forks. The arguments -# must be portable across $(()) and expr. -if (eval "test \$(( 1 + 1 )) = 2") 2>/dev/null; then : - eval 'as_fn_arith () - { - as_val=$(( $* )) - }' -else - as_fn_arith () - { - as_val=`expr "$@" || test $? -eq 1` - } -fi # as_fn_arith - - -if expr a : '\(a\)' >/dev/null 2>&1 && - test "X`expr 00001 : '.*\(...\)'`" = X001; then - as_expr=expr -else - as_expr=false -fi - -if (basename -- /) >/dev/null 2>&1 && test "X`basename -- / 2>&1`" = "X/"; then - as_basename=basename -else - as_basename=false -fi - -if (as_dir=`dirname -- /` && test "X$as_dir" = X/) >/dev/null 2>&1; then - as_dirname=dirname -else - as_dirname=false -fi - -as_me=`$as_basename -- "$0" || -$as_expr X/"$0" : '.*/\([^/][^/]*\)/*$' \| \ - X"$0" : 'X\(//\)$' \| \ - X"$0" : 'X\(/\)' \| . 2>/dev/null || -$as_echo X/"$0" | - sed '/^.*\/\([^/][^/]*\)\/*$/{ - s//\1/ - q - } - /^X\/\(\/\/\)$/{ - s//\1/ - q - } - /^X\/\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - -# Avoid depending upon Character Ranges. -as_cr_letters='abcdefghijklmnopqrstuvwxyz' -as_cr_LETTERS='ABCDEFGHIJKLMNOPQRSTUVWXYZ' -as_cr_Letters=$as_cr_letters$as_cr_LETTERS -as_cr_digits='0123456789' -as_cr_alnum=$as_cr_Letters$as_cr_digits - -ECHO_C= ECHO_N= ECHO_T= -case `echo -n x` in #((((( --n*) - case `echo 'xy\c'` in - *c*) ECHO_T=' ';; # ECHO_T is single tab character. - xy) ECHO_C='\c';; - *) echo `echo ksh88 bug on AIX 6.1` > /dev/null - ECHO_T=' ';; - esac;; -*) - ECHO_N='-n';; -esac - -rm -f conf$$ conf$$.exe conf$$.file -if test -d conf$$.dir; then - rm -f conf$$.dir/conf$$.file -else - rm -f conf$$.dir - mkdir conf$$.dir 2>/dev/null -fi -if (echo >conf$$.file) 2>/dev/null; then - if ln -s conf$$.file conf$$ 2>/dev/null; then - as_ln_s='ln -s' - # ... but there are two gotchas: - # 1) On MSYS, both `ln -s file dir' and `ln file dir' fail. - # 2) DJGPP < 2.04 has no symlinks; `ln -s' creates a wrapper executable. - # In both cases, we have to default to `cp -p'. - ln -s conf$$.file conf$$.dir 2>/dev/null && test ! -f conf$$.exe || - as_ln_s='cp -p' - elif ln conf$$.file conf$$ 2>/dev/null; then - as_ln_s=ln - else - as_ln_s='cp -p' - fi -else - as_ln_s='cp -p' -fi -rm -f conf$$ conf$$.exe conf$$.dir/conf$$.file conf$$.file -rmdir conf$$.dir 2>/dev/null - - -# as_fn_mkdir_p -# ------------- -# Create "$as_dir" as a directory, including parents if necessary. -as_fn_mkdir_p () -{ - - case $as_dir in #( - -*) as_dir=./$as_dir;; - esac - test -d "$as_dir" || eval $as_mkdir_p || { - as_dirs= - while :; do - case $as_dir in #( - *\'*) as_qdir=`$as_echo "$as_dir" | sed "s/'/'\\\\\\\\''/g"`;; #'( - *) as_qdir=$as_dir;; - esac - as_dirs="'$as_qdir' $as_dirs" - as_dir=`$as_dirname -- "$as_dir" || -$as_expr X"$as_dir" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ - X"$as_dir" : 'X\(//\)[^/]' \| \ - X"$as_dir" : 'X\(//\)$' \| \ - X"$as_dir" : 'X\(/\)' \| . 2>/dev/null || -$as_echo X"$as_dir" | - sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ - s//\1/ - q - } - /^X\(\/\/\)[^/].*/{ - s//\1/ - q - } - /^X\(\/\/\)$/{ - s//\1/ - q - } - /^X\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - test -d "$as_dir" && break - done - test -z "$as_dirs" || eval "mkdir $as_dirs" - } || test -d "$as_dir" || as_fn_error "cannot create directory $as_dir" - - -} # as_fn_mkdir_p -if mkdir -p . 2>/dev/null; then - as_mkdir_p='mkdir -p "$as_dir"' -else - test -d ./-p && rmdir ./-p - as_mkdir_p=false -fi - -if test -x / >/dev/null 2>&1; then - as_test_x='test -x' -else - if ls -dL / >/dev/null 2>&1; then - as_ls_L_option=L - else - as_ls_L_option= - fi - as_test_x=' - eval sh -c '\'' - if test -d "$1"; then - test -d "$1/."; - else - case $1 in #( - -*)set "./$1";; - esac; - case `ls -ld'$as_ls_L_option' "$1" 2>/dev/null` in #(( - ???[sx]*):;;*)false;;esac;fi - '\'' sh - ' -fi -as_executable_p=$as_test_x - -# Sed expression to map a string onto a valid CPP name. -as_tr_cpp="eval sed 'y%*$as_cr_letters%P$as_cr_LETTERS%;s%[^_$as_cr_alnum]%_%g'" - -# Sed expression to map a string onto a valid variable name. -as_tr_sh="eval sed 'y%*+%pp%;s%[^_$as_cr_alnum]%_%g'" - - -exec 6>&1 -## ----------------------------------- ## -## Main body of $CONFIG_STATUS script. ## -## ----------------------------------- ## -_ASEOF -test $as_write_fail = 0 && chmod +x $CONFIG_STATUS || ac_write_fail=1 - -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -# Save the log message, to keep $0 and so on meaningful, and to -# report actual input values of CONFIG_FILES etc. instead of their -# values after options handling. -ac_log=" -This file was extended by ejabberd $as_me 3.0.0-alpha-x, which was -generated by GNU Autoconf 2.65. Invocation command line was - - CONFIG_FILES = $CONFIG_FILES - CONFIG_HEADERS = $CONFIG_HEADERS - CONFIG_LINKS = $CONFIG_LINKS - CONFIG_COMMANDS = $CONFIG_COMMANDS - $ $0 $@ - -on `(hostname || uname -n) 2>/dev/null | sed 1q` -" - -_ACEOF - -case $ac_config_files in *" -"*) set x $ac_config_files; shift; ac_config_files=$*;; -esac - - - -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 -# Files that config.status was made for. -config_files="$ac_config_files" - -_ACEOF - -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -ac_cs_usage="\ -\`$as_me' instantiates files and other configuration actions -from templates according to the current configuration. Unless the files -and actions are specified as TAGs, all are instantiated by default. - -Usage: $0 [OPTION]... [TAG]... - - -h, --help print this help, then exit - -V, --version print version number and configuration settings, then exit - --config print configuration, then exit - -q, --quiet, --silent - do not print progress messages - -d, --debug don't remove temporary files - --recheck update $as_me by reconfiguring in the same conditions - --file=FILE[:TEMPLATE] - instantiate the configuration file FILE - -Configuration files: -$config_files - -Report bugs to <ejabberd@process-one.net>." - -_ACEOF -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 -ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`" -ac_cs_version="\\ -ejabberd config.status 3.0.0-alpha-x -configured by $0, generated by GNU Autoconf 2.65, - with options \\"\$ac_cs_config\\" - -Copyright (C) 2009 Free Software Foundation, Inc. -This config.status script is free software; the Free Software Foundation -gives unlimited permission to copy, distribute and modify it." - -ac_pwd='$ac_pwd' -srcdir='$srcdir' -test -n "\$AWK" || AWK=awk -_ACEOF - -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -# The default lists apply if the user does not specify any file. -ac_need_defaults=: -while test $# != 0 -do - case $1 in - --*=*) - ac_option=`expr "X$1" : 'X\([^=]*\)='` - ac_optarg=`expr "X$1" : 'X[^=]*=\(.*\)'` - ac_shift=: - ;; - *) - ac_option=$1 - ac_optarg=$2 - ac_shift=shift - ;; - esac - - case $ac_option in - # Handling of the options. - -recheck | --recheck | --rechec | --reche | --rech | --rec | --re | --r) - ac_cs_recheck=: ;; - --version | --versio | --versi | --vers | --ver | --ve | --v | -V ) - $as_echo "$ac_cs_version"; exit ;; - --config | --confi | --conf | --con | --co | --c ) - $as_echo "$ac_cs_config"; exit ;; - --debug | --debu | --deb | --de | --d | -d ) - debug=: ;; - --file | --fil | --fi | --f ) - $ac_shift - case $ac_optarg in - *\'*) ac_optarg=`$as_echo "$ac_optarg" | sed "s/'/'\\\\\\\\''/g"` ;; - esac - as_fn_append CONFIG_FILES " '$ac_optarg'" - ac_need_defaults=false;; - --he | --h | --help | --hel | -h ) - $as_echo "$ac_cs_usage"; exit ;; - -q | -quiet | --quiet | --quie | --qui | --qu | --q \ - | -silent | --silent | --silen | --sile | --sil | --si | --s) - ac_cs_silent=: ;; - - # This is an error. - -*) as_fn_error "unrecognized option: \`$1' -Try \`$0 --help' for more information." ;; - - *) as_fn_append ac_config_targets " $1" - ac_need_defaults=false ;; - - esac - shift -done - -ac_configure_extra_args= - -if $ac_cs_silent; then - exec 6>/dev/null - ac_configure_extra_args="$ac_configure_extra_args --silent" -fi - -_ACEOF -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 -if \$ac_cs_recheck; then - set X '$SHELL' '$0' $ac_configure_args \$ac_configure_extra_args --no-create --no-recursion - shift - \$as_echo "running CONFIG_SHELL=$SHELL \$*" >&6 - CONFIG_SHELL='$SHELL' - export CONFIG_SHELL - exec "\$@" -fi - -_ACEOF -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -exec 5>>config.log -{ - echo - sed 'h;s/./-/g;s/^.../## /;s/...$/ ##/;p;x;p;x' <<_ASBOX -## Running $as_me. ## -_ASBOX - $as_echo "$ac_log" -} >&5 - -_ACEOF -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 -_ACEOF - -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 - -# Handling of arguments. -for ac_config_target in $ac_config_targets -do - case $ac_config_target in - "Makefile") CONFIG_FILES="$CONFIG_FILES Makefile" ;; - "$make_mod_muc") CONFIG_FILES="$CONFIG_FILES $make_mod_muc" ;; - "$make_mod_pubsub") CONFIG_FILES="$CONFIG_FILES $make_mod_pubsub" ;; - "$make_mod_proxy65") CONFIG_FILES="$CONFIG_FILES $make_mod_proxy65" ;; - "$make_eldap") CONFIG_FILES="$CONFIG_FILES $make_eldap" ;; - "$make_pam") CONFIG_FILES="$CONFIG_FILES $make_pam" ;; - "$make_web") CONFIG_FILES="$CONFIG_FILES $make_web" ;; - "stun/Makefile") CONFIG_FILES="$CONFIG_FILES stun/Makefile" ;; - "$make_tls") CONFIG_FILES="$CONFIG_FILES $make_tls" ;; - "$make_odbc") CONFIG_FILES="$CONFIG_FILES $make_odbc" ;; - "$make_ejabberd_zlib") CONFIG_FILES="$CONFIG_FILES $make_ejabberd_zlib" ;; - - *) as_fn_error "invalid argument: \`$ac_config_target'" "$LINENO" 5;; - esac -done - - -# If the user did not use the arguments to specify the items to instantiate, -# then the envvar interface is used. Set only those that are not. -# We use the long form for the default assignment because of an extremely -# bizarre bug on SunOS 4.1.3. -if $ac_need_defaults; then - test "${CONFIG_FILES+set}" = set || CONFIG_FILES=$config_files -fi - -# Have a temporary directory for convenience. Make it in the build tree -# simply because there is no reason against having it here, and in addition, -# creating and moving files from /tmp can sometimes cause problems. -# Hook for its removal unless debugging. -# Note that there is a small window in which the directory will not be cleaned: -# after its creation but before its name has been assigned to `$tmp'. -$debug || -{ - tmp= - trap 'exit_status=$? - { test -z "$tmp" || test ! -d "$tmp" || rm -fr "$tmp"; } && exit $exit_status -' 0 - trap 'as_fn_exit 1' 1 2 13 15 -} -# Create a (secure) tmp directory for tmp files. - -{ - tmp=`(umask 077 && mktemp -d "./confXXXXXX") 2>/dev/null` && - test -n "$tmp" && test -d "$tmp" -} || -{ - tmp=./conf$$-$RANDOM - (umask 077 && mkdir "$tmp") -} || as_fn_error "cannot create a temporary directory in ." "$LINENO" 5 - -# Set up the scripts for CONFIG_FILES section. -# No need to generate them if there are no CONFIG_FILES. -# This happens for instance with `./config.status config.h'. -if test -n "$CONFIG_FILES"; then - - -ac_cr=`echo X | tr X '\015'` -# On cygwin, bash can eat \r inside `` if the user requested igncr. -# But we know of no other shell where ac_cr would be empty at this -# point, so we can use a bashism as a fallback. -if test "x$ac_cr" = x; then - eval ac_cr=\$\'\\r\' -fi -ac_cs_awk_cr=`$AWK 'BEGIN { print "a\rb" }' </dev/null 2>/dev/null` -if test "$ac_cs_awk_cr" = "a${ac_cr}b"; then - ac_cs_awk_cr='\r' -else - ac_cs_awk_cr=$ac_cr -fi - -echo 'BEGIN {' >"$tmp/subs1.awk" && -_ACEOF - - -{ - echo "cat >conf$$subs.awk <<_ACEOF" && - echo "$ac_subst_vars" | sed 's/.*/&!$&$ac_delim/' && - echo "_ACEOF" -} >conf$$subs.sh || - as_fn_error "could not make $CONFIG_STATUS" "$LINENO" 5 -ac_delim_num=`echo "$ac_subst_vars" | grep -c '$'` -ac_delim='%!_!# ' -for ac_last_try in false false false false false :; do - . ./conf$$subs.sh || - as_fn_error "could not make $CONFIG_STATUS" "$LINENO" 5 - - ac_delim_n=`sed -n "s/.*$ac_delim\$/X/p" conf$$subs.awk | grep -c X` - if test $ac_delim_n = $ac_delim_num; then - break - elif $ac_last_try; then - as_fn_error "could not make $CONFIG_STATUS" "$LINENO" 5 - else - ac_delim="$ac_delim!$ac_delim _$ac_delim!! " - fi -done -rm -f conf$$subs.sh - -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 -cat >>"\$tmp/subs1.awk" <<\\_ACAWK && -_ACEOF -sed -n ' -h -s/^/S["/; s/!.*/"]=/ -p -g -s/^[^!]*!// -:repl -t repl -s/'"$ac_delim"'$// -t delim -:nl -h -s/\(.\{148\}\)..*/\1/ -t more1 -s/["\\]/\\&/g; s/^/"/; s/$/\\n"\\/ -p -n -b repl -:more1 -s/["\\]/\\&/g; s/^/"/; s/$/"\\/ -p -g -s/.\{148\}// -t nl -:delim -h -s/\(.\{148\}\)..*/\1/ -t more2 -s/["\\]/\\&/g; s/^/"/; s/$/"/ -p -b -:more2 -s/["\\]/\\&/g; s/^/"/; s/$/"\\/ -p -g -s/.\{148\}// -t delim -' <conf$$subs.awk | sed ' -/^[^""]/{ - N - s/\n// -} -' >>$CONFIG_STATUS || ac_write_fail=1 -rm -f conf$$subs.awk -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 -_ACAWK -cat >>"\$tmp/subs1.awk" <<_ACAWK && - for (key in S) S_is_set[key] = 1 - FS = "" - -} -{ - line = $ 0 - nfields = split(line, field, "@") - substed = 0 - len = length(field[1]) - for (i = 2; i < nfields; i++) { - key = field[i] - keylen = length(key) - if (S_is_set[key]) { - value = S[key] - line = substr(line, 1, len) "" value "" substr(line, len + keylen + 3) - len += length(value) + length(field[++i]) - substed = 1 - } else - len += 1 + keylen - } - - print line -} - -_ACAWK -_ACEOF -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -if sed "s/$ac_cr//" < /dev/null > /dev/null 2>&1; then - sed "s/$ac_cr\$//; s/$ac_cr/$ac_cs_awk_cr/g" -else - cat -fi < "$tmp/subs1.awk" > "$tmp/subs.awk" \ - || as_fn_error "could not setup config files machinery" "$LINENO" 5 -_ACEOF - -# VPATH may cause trouble with some makes, so we remove $(srcdir), -# ${srcdir} and @srcdir@ from VPATH if srcdir is ".", strip leading and -# trailing colons and then remove the whole line if VPATH becomes empty -# (actually we leave an empty line to preserve line numbers). -if test "x$srcdir" = x.; then - ac_vpsub='/^[ ]*VPATH[ ]*=/{ -s/:*\$(srcdir):*/:/ -s/:*\${srcdir}:*/:/ -s/:*@srcdir@:*/:/ -s/^\([^=]*=[ ]*\):*/\1/ -s/:*$// -s/^[^=]*=[ ]*$// -}' -fi - -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -fi # test -n "$CONFIG_FILES" - - -eval set X " :F $CONFIG_FILES " -shift -for ac_tag -do - case $ac_tag in - :[FHLC]) ac_mode=$ac_tag; continue;; - esac - case $ac_mode$ac_tag in - :[FHL]*:*);; - :L* | :C*:*) as_fn_error "invalid tag \`$ac_tag'" "$LINENO" 5;; - :[FH]-) ac_tag=-:-;; - :[FH]*) ac_tag=$ac_tag:$ac_tag.in;; - esac - ac_save_IFS=$IFS - IFS=: - set x $ac_tag - IFS=$ac_save_IFS - shift - ac_file=$1 - shift - - case $ac_mode in - :L) ac_source=$1;; - :[FH]) - ac_file_inputs= - for ac_f - do - case $ac_f in - -) ac_f="$tmp/stdin";; - *) # Look for the file first in the build tree, then in the source tree - # (if the path is not absolute). The absolute path cannot be DOS-style, - # because $ac_f cannot contain `:'. - test -f "$ac_f" || - case $ac_f in - [\\/$]*) false;; - *) test -f "$srcdir/$ac_f" && ac_f="$srcdir/$ac_f";; - esac || - as_fn_error "cannot find input file: \`$ac_f'" "$LINENO" 5;; - esac - case $ac_f in *\'*) ac_f=`$as_echo "$ac_f" | sed "s/'/'\\\\\\\\''/g"`;; esac - as_fn_append ac_file_inputs " '$ac_f'" - done - - # Let's still pretend it is `configure' which instantiates (i.e., don't - # use $as_me), people would be surprised to read: - # /* config.h. Generated by config.status. */ - configure_input='Generated from '` - $as_echo "$*" | sed 's|^[^:]*/||;s|:[^:]*/|, |g' - `' by configure.' - if test x"$ac_file" != x-; then - configure_input="$ac_file. $configure_input" - { $as_echo "$as_me:${as_lineno-$LINENO}: creating $ac_file" >&5 -$as_echo "$as_me: creating $ac_file" >&6;} - fi - # Neutralize special characters interpreted by sed in replacement strings. - case $configure_input in #( - *\&* | *\|* | *\\* ) - ac_sed_conf_input=`$as_echo "$configure_input" | - sed 's/[\\\\&|]/\\\\&/g'`;; #( - *) ac_sed_conf_input=$configure_input;; - esac - - case $ac_tag in - *:-:* | *:-) cat >"$tmp/stdin" \ - || as_fn_error "could not create $ac_file" "$LINENO" 5 ;; - esac - ;; - esac - - ac_dir=`$as_dirname -- "$ac_file" || -$as_expr X"$ac_file" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ - X"$ac_file" : 'X\(//\)[^/]' \| \ - X"$ac_file" : 'X\(//\)$' \| \ - X"$ac_file" : 'X\(/\)' \| . 2>/dev/null || -$as_echo X"$ac_file" | - sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ - s//\1/ - q - } - /^X\(\/\/\)[^/].*/{ - s//\1/ - q - } - /^X\(\/\/\)$/{ - s//\1/ - q - } - /^X\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - as_dir="$ac_dir"; as_fn_mkdir_p - ac_builddir=. - -case "$ac_dir" in -.) ac_dir_suffix= ac_top_builddir_sub=. ac_top_build_prefix= ;; -*) - ac_dir_suffix=/`$as_echo "$ac_dir" | sed 's|^\.[\\/]||'` - # A ".." for each directory in $ac_dir_suffix. - ac_top_builddir_sub=`$as_echo "$ac_dir_suffix" | sed 's|/[^\\/]*|/..|g;s|/||'` - case $ac_top_builddir_sub in - "") ac_top_builddir_sub=. ac_top_build_prefix= ;; - *) ac_top_build_prefix=$ac_top_builddir_sub/ ;; - esac ;; -esac -ac_abs_top_builddir=$ac_pwd -ac_abs_builddir=$ac_pwd$ac_dir_suffix -# for backward compatibility: -ac_top_builddir=$ac_top_build_prefix - -case $srcdir in - .) # We are building in place. - ac_srcdir=. - ac_top_srcdir=$ac_top_builddir_sub - ac_abs_top_srcdir=$ac_pwd ;; - [\\/]* | ?:[\\/]* ) # Absolute name. - ac_srcdir=$srcdir$ac_dir_suffix; - ac_top_srcdir=$srcdir - ac_abs_top_srcdir=$srcdir ;; - *) # Relative name. - ac_srcdir=$ac_top_build_prefix$srcdir$ac_dir_suffix - ac_top_srcdir=$ac_top_build_prefix$srcdir - ac_abs_top_srcdir=$ac_pwd/$srcdir ;; -esac -ac_abs_srcdir=$ac_abs_top_srcdir$ac_dir_suffix - - - case $ac_mode in - :F) - # - # CONFIG_FILE - # - -_ACEOF - -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -# If the template does not know about datarootdir, expand it. -# FIXME: This hack should be removed a few years after 2.60. -ac_datarootdir_hack=; ac_datarootdir_seen= -ac_sed_dataroot=' -/datarootdir/ { - p - q -} -/@datadir@/p -/@docdir@/p -/@infodir@/p -/@localedir@/p -/@mandir@/p' -case `eval "sed -n \"\$ac_sed_dataroot\" $ac_file_inputs"` in -*datarootdir*) ac_datarootdir_seen=yes;; -*@datadir@*|*@docdir@*|*@infodir@*|*@localedir@*|*@mandir@*) - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $ac_file_inputs seems to ignore the --datarootdir setting" >&5 -$as_echo "$as_me: WARNING: $ac_file_inputs seems to ignore the --datarootdir setting" >&2;} -_ACEOF -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 - ac_datarootdir_hack=' - s&@datadir@&$datadir&g - s&@docdir@&$docdir&g - s&@infodir@&$infodir&g - s&@localedir@&$localedir&g - s&@mandir@&$mandir&g - s&\\\${datarootdir}&$datarootdir&g' ;; -esac -_ACEOF - -# Neutralize VPATH when `$srcdir' = `.'. -# Shell code in configure.ac might set extrasub. -# FIXME: do we really want to maintain this feature? -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 -ac_sed_extra="$ac_vpsub -$extrasub -_ACEOF -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -:t -/@[a-zA-Z_][a-zA-Z_0-9]*@/!b -s|@configure_input@|$ac_sed_conf_input|;t t -s&@top_builddir@&$ac_top_builddir_sub&;t t -s&@top_build_prefix@&$ac_top_build_prefix&;t t -s&@srcdir@&$ac_srcdir&;t t -s&@abs_srcdir@&$ac_abs_srcdir&;t t -s&@top_srcdir@&$ac_top_srcdir&;t t -s&@abs_top_srcdir@&$ac_abs_top_srcdir&;t t -s&@builddir@&$ac_builddir&;t t -s&@abs_builddir@&$ac_abs_builddir&;t t -s&@abs_top_builddir@&$ac_abs_top_builddir&;t t -$ac_datarootdir_hack -" -eval sed \"\$ac_sed_extra\" "$ac_file_inputs" | $AWK -f "$tmp/subs.awk" >$tmp/out \ - || as_fn_error "could not create $ac_file" "$LINENO" 5 - -test -z "$ac_datarootdir_hack$ac_datarootdir_seen" && - { ac_out=`sed -n '/\${datarootdir}/p' "$tmp/out"`; test -n "$ac_out"; } && - { ac_out=`sed -n '/^[ ]*datarootdir[ ]*:*=/p' "$tmp/out"`; test -z "$ac_out"; } && - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $ac_file contains a reference to the variable \`datarootdir' -which seems to be undefined. Please make sure it is defined." >&5 -$as_echo "$as_me: WARNING: $ac_file contains a reference to the variable \`datarootdir' -which seems to be undefined. Please make sure it is defined." >&2;} - - rm -f "$tmp/stdin" - case $ac_file in - -) cat "$tmp/out" && rm -f "$tmp/out";; - *) rm -f "$ac_file" && mv "$tmp/out" "$ac_file";; - esac \ - || as_fn_error "could not create $ac_file" "$LINENO" 5 - ;; - - - - esac - -done # for ac_tag - - -as_fn_exit 0 -_ACEOF -ac_clean_files=$ac_clean_files_save - -test $ac_write_fail = 0 || - as_fn_error "write failure creating $CONFIG_STATUS" "$LINENO" 5 - - -# configure is writing to config.log, and then calls config.status. -# config.status does its own redirection, appending to config.log. -# Unfortunately, on DOS this fails, as config.log is still kept open -# by configure, so config.status won't be able to write to it; its -# output is simply discarded. So we exec the FD to /dev/null, -# effectively closing config.log, so it can be properly (re)opened and -# appended to by config.status. When coming back to configure, we -# need to make the FD available again. -if test "$no_create" != yes; then - ac_cs_success=: - ac_config_status_args= - test "$silent" = yes && - ac_config_status_args="$ac_config_status_args --quiet" - exec 5>/dev/null - $SHELL $CONFIG_STATUS $ac_config_status_args || ac_cs_success=false - exec 5>>config.log - # Use ||, not &&, to avoid exiting from the if with $? = 1, which - # would make configure fail if this is the last instruction. - $ac_cs_success || as_fn_exit $? -fi -if test -n "$ac_unrecognized_opts" && test "$enable_option_checking" != no; then - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: unrecognized options: $ac_unrecognized_opts" >&5 -$as_echo "$as_me: WARNING: unrecognized options: $ac_unrecognized_opts" >&2;} -fi - - -echo -echo "********************** WARNING ! ************************" -echo "* ejabberd master is NOT ready for real usage yet, *" -echo "* because it is still in heavy development. *" -echo "* Don't use ejabberd master, it is still alpha code! *" -echo "* Please use ejabberd 2.1.x branch instead. *" -echo "*********************************************************" -echo diff --git a/src/ejabberd_admin.erl b/src/ejabberd_admin.erl index 6818e8c04..33728e877 100644 --- a/src/ejabberd_admin.erl +++ b/src/ejabberd_admin.erl @@ -261,8 +261,7 @@ get_sasl_error_logger_type () -> stop_kindly(DelaySeconds, AnnouncementText) -> Subject = io_lib:format("Server stop in ~p seconds!", [DelaySeconds]), WaitingDesc = io_lib:format("Waiting ~p seconds", [DelaySeconds]), - Steps = [ - {"Stopping ejabberd port listeners", + Steps = [{"Stopping ejabberd port listeners", ejabberd_listener, stop_listeners, []}, {"Sending announcement to connected users", mod_announce, send_announcement_to_all, @@ -388,11 +387,11 @@ import_dir(Path) -> %%% delete_expired_messages() -> - {atomic, ok} = mod_offline:remove_expired_messages(), + mod_offline:remove_expired_messages(), ok. delete_old_messages(Days) -> - {atomic, _} = mod_offline:remove_old_messages(Days), + mod_offline:remove_old_messages(Days), ok. diff --git a/src/ejabberd_auth_anonymous.erl b/src/ejabberd_auth_anonymous.erl index 1f5041f46..bd69964a4 100644 --- a/src/ejabberd_auth_anonymous.erl +++ b/src/ejabberd_auth_anonymous.erl @@ -140,8 +140,8 @@ anonymous_protocol(Host) when is_list(Host) -> %% defaults to false allow_multiple_connections(Host) when is_list(Host) -> - ejabberd_config:get_local_option( - {allow_multiple_connections, Host}) =:= true. + ejabberd_config:get_local_option({allow_multiple_connections, Host}) + =:= true. %% @spec (User, Server) -> bool() %% User = string() diff --git a/src/ejabberd_auth_ldap.erl b/src/ejabberd_auth_ldap.erl index 54419374e..fbdebeb16 100644 --- a/src/ejabberd_auth_ldap.erl +++ b/src/ejabberd_auth_ldap.erl @@ -440,10 +440,10 @@ is_valid_dn(DN, Server, Attrs, State) -> end ++ [{"%d", State#state.host}, {"%D", DN}], case eldap_filter:parse(State#state.dn_filter, SubstValues) of {ok, EldapFilter} -> - case eldap_pool:search(State#state.eldap_id, [ - {base, State#state.base}, - {filter, EldapFilter}, - {attributes, ["dn"]}]) of + case eldap_pool:search(State#state.eldap_id, + [{base, State#state.base}, + {filter, EldapFilter}, + {attributes, ["dn"]}]) of #eldap_search_result{entries = [_|_]} -> DN; _ -> diff --git a/src/ejabberd_c2s.erl b/src/ejabberd_c2s.erl index 0a3cfe6b5..074564225 100644 --- a/src/ejabberd_c2s.erl +++ b/src/ejabberd_c2s.erl @@ -71,6 +71,9 @@ -include("ejabberd.hrl"). -include("mod_privacy.hrl"). +%% Copied from ejabberd_socket.erl +-record(socket_state, {sockmod, socket, receiver}). + -define(SETS, gb_sets). -define(DICT, dict). @@ -528,6 +531,7 @@ wait_for_auth({xmlstreamelement, El}, StateData) -> "(~w) Accepted legacy authentication for ~s by ~s", [StateData#state.socket, exmpp_jid:to_binary(JID), AuthModule]), + erlang:link((StateData#state.socket)#socket_state.receiver), SID = {now(), self()}, Conn = get_conn_type(StateData), %% Info = [{ip, StateData#state.ip}, {conn, Conn}, @@ -664,8 +668,8 @@ wait_for_feature_request({xmlstreamelement, #xmlel{ns = NS, name = Name} = El}, TLSEnabled == false, SockMod == gen_tcp -> ServerString = binary_to_list(StateData#state.server), - TLSOpts = case ejabberd_config:get_local_option( - {domain_certfile, ServerString}) of + TLSOpts = case ejabberd_config:get_local_option + ({domain_certfile, ServerString}) of undefined -> StateData#state.tls_options; CertFile -> @@ -1595,9 +1599,6 @@ get_auth_tags([_ | L], U, P, D, R) -> get_auth_tags([], U, P, D, R) -> {U, P, D, R}. -%% Copied from ejabberd_socket.erl --record(socket_state, {sockmod, socket, receiver}). - get_conn_type(StateData) -> case (StateData#state.sockmod):get_sockmod(StateData#state.socket) of gen_tcp -> c2s; @@ -1606,8 +1607,8 @@ get_conn_type(StateData) -> if is_pid(StateData#state.socket) -> unknown; true -> - case ejabberd_zlib:get_sockmod( - (StateData#state.socket)#socket_state.socket) of + case ejabberd_zlib:get_sockmod + ((StateData#state.socket)#socket_state.socket) of gen_tcp -> c2s_compressed; tls -> c2s_compressed_tls end diff --git a/src/ejabberd_captcha.erl b/src/ejabberd_captcha.erl index bb75308f9..64bb74b3a 100644 --- a/src/ejabberd_captcha.erl +++ b/src/ejabberd_captcha.erl @@ -24,6 +24,22 @@ %%% %%%------------------------------------------------------------------- +%%% Database schema (version / storage / table) +%%% +%%% 2.1.x / mnesia / captcha +%%% id = string() +%%% pid = pid() +%%% key = string() +%%% tref = any() +%%% args = any() +%%% +%%% 3.0.0-alpha / ets / captcha +%%% id = string() +%%% pid = pid() +%%% key = string() +%%% tref = any() +%%% args = any() + -module(ejabberd_captcha). -behaviour(gen_server). @@ -47,23 +63,20 @@ -define(VFIELD(Type, Var, Value), #xmlel{name = 'field', attrs = [ - #xmlattr{ - name = 'type', + #xmlattr{name = 'type', value = Type }, - #xmlattr{ - name = 'var', + #xmlattr{name = 'var', value = Var } ], children = [ - #xmlel{ - name = 'value', + #xmlel{name = 'value', children = [Value] } ]}). --define(CAPTCHA_TEXT(Lang), translate:translate(Lang, "Enter the text you see")). +-define(CAPTCHA_TEXT(Lang), list_to_binary(translate:translate(Lang, "Enter the text you see"))). -define(CAPTCHA_LIFETIME, 120000). % two minutes -define(RPC_TIMEOUT, 5000). @@ -81,13 +94,13 @@ start_link() -> gen_server:start_link({local, ?MODULE}, ?MODULE, [], []). create_captcha(SID, From, To, Lang, Args) - when is_binary(Lang), is_list(SID) -> + when is_binary(Lang), is_binary(SID) -> case create_image() of {ok, Type, Key, Image} -> Id = randoms:get_string() ++ "-" ++ ejabberd_cluster:node_id(), - B64Image = jlib:encode_base64(binary_to_list(Image)), + B64Image = list_to_binary(jlib:encode_base64(binary_to_list(Image))), JID = exmpp_jid:to_list(From), - CID = "sha1+" ++ sha:sha(Image) ++ "@bob.xmpp.org", + CID = list_to_binary(["sha1+", sha:sha(Image), "@bob.xmpp.org"]), % Data = {xmlelement, "data", % [{"xmlns", ?NS_BOB}, {"cid", CID}, % {"max-age", "0"}, {"type", Type}], @@ -97,16 +110,13 @@ create_captcha(SID, From, To, Lang, Args) name = 'data', ns = ?NS_BOB, attrs = [ - #xmlattr{ - name = 'cid', + #xmlattr{name = 'cid', value = CID }, - #xmlattr{ - name = 'max-age', - value = "0" + #xmlattr{name = 'max-age', + value = <<"0">> }, - #xmlattr{ - name = 'type', + #xmlattr{name = 'type', value = Type } ], @@ -128,47 +138,39 @@ create_captcha(SID, From, To, Lang, Args) name = 'captcha', ns = ?NS_CAPTCHA, children = [ - #xmlel{ - name = 'x', + #xmlel{name = 'x', ns = ?NS_DATA_FORMS_s, attrs = [ - #xmlattr{ - name = 'type', - value = "form" + #xmlattr{name = 'type', + value = <<"form">> } ], children = [ - ?VFIELD("hidden", "FORM_TYPE", #xmlcdata{cdata = ?NS_CAPTCHA}), - ?VFIELD("hidden", "from", #xmlcdata{cdata = exmpp_jid:to_list(To)}), - ?VFIELD("hidden", "challenge", #xmlcdata{cdata = Id}), - ?VFIELD("hidden", "sid", #xmlcdata{cdata = SID}), - #xmlel{ - name = 'field', + ?VFIELD(<<"hidden">>, <<"FORM_TYPE">>, #xmlcdata{cdata = ?NS_CAPTCHA_b}), + ?VFIELD(<<"hidden">>, <<"from">>, #xmlcdata{cdata = exmpp_jid:to_binary(To)}), + ?VFIELD(<<"hidden">>, <<"challenge">>, #xmlcdata{cdata = list_to_binary(Id)}), + ?VFIELD(<<"hidden">>, <<"sid">>, #xmlcdata{cdata = SID}), + #xmlel{name = 'field', attrs = [ - #xmlattr{ - name = 'var', - value = "ocr" + #xmlattr{name = 'var', + value = <<"ocr">> }, - #xmlattr{ - name = 'label', + #xmlattr{name = 'label', value = ?CAPTCHA_TEXT(Lang) } ], children = [ - #xmlel{ - name = 'media', + #xmlel{name = 'media', ns = ?NS_DATA_FORMS_MEDIA_s, children = [ - #xmlel{ - name = 'uri', + #xmlel{name = 'uri', attrs = [ - #xmlattr{ - name = 'type', + #xmlattr{name = 'type', value = Type } ], children = [ - #xmlcdata{cdata = "cid:" ++ CID} + #xmlcdata{cdata = list_to_binary(["cid:", CID])} ] } ] @@ -182,24 +184,19 @@ create_captcha(SID, From, To, Lang, Args) BodyString1 = translate:translate(Lang, "Your messages to ~s are being blocked. To unblock them, visit ~s"), BodyString = io_lib:format(BodyString1, [JID, get_url(Id)]), Body = - #xmlel{ - name = 'body', + #xmlel{name = 'body', children = [ - #xmlcdata{ - cdata = BodyString + #xmlcdata{cdata = list_to_binary(BodyString) } ] }, OOB = - #xmlel{ - name = 'x', + #xmlel{name = 'x', ns = ?NS_OOBD_X_s, children = [ - #xmlel{ - name = 'url', + #xmlel{name = 'url', children = [ - #xmlcdata{ - cdata = get_url(Id)} + #xmlcdata{cdata = list_to_binary(get_url(Id))} ] } ] @@ -227,12 +224,10 @@ build_captcha_html(Id, Lang) -> {ok, _} -> %ImgEl = {xmlelement, "img", [{"src", get_url(Id ++ "/image")}], []}, ImgEl = - #xmlel{ - name = 'img', + #xmlel{name = 'img', attrs = [ - #xmlattr{ - name = 'src', - value = get_url(Id ++ "/image") + #xmlattr{name = 'src', + value = list_to_binary(get_url(Id ++ "/image")) } ] }, @@ -242,20 +237,16 @@ build_captcha_html(Id, Lang) -> % {"name", "id"}, % {"value", Id}], []}, IdEl = - #xmlel{ - name = 'input', + #xmlel{name = 'input', attrs = [ - #xmlattr{ - name = 'type', - value = "hidden" + #xmlattr{name = 'type', + value = <<"hidden">> }, - #xmlattr{ - name = 'name', - value = "id" + #xmlattr{name = 'name', + value = <<"id">> }, - #xmlattr{ - name = 'value', - value = Id + #xmlattr{name = 'value', + value = list_to_binary(Id) } ] }, @@ -263,20 +254,16 @@ build_captcha_html(Id, Lang) -> % {"name", "key"}, % {"size", "10"}], []}, KeyEl = - #xmlel{ - name = 'input', + #xmlel{name = 'input', attrs = [ - #xmlattr{ - name = 'type', - value = "text" + #xmlattr{name = 'type', + value = <<"text">> }, - #xmlattr{ - name = 'name', - value = "key" + #xmlattr{name = 'name', + value = <<"key">> }, - #xmlattr{ - name = 'size', - value = "10" + #xmlattr{name = 'size', + value = <<"10">> } ] }, @@ -295,50 +282,39 @@ build_captcha_html(Id, Lang) -> % {"value", "OK"}], []} % ]}, FormEl = - #xmlel{ - name = 'form', + #xmlel{name = 'form', attrs = [ - #xmlattr{ - name = 'action', - value = get_url(Id) + #xmlattr{name = 'action', + value = list_to_binary(get_url(Id)) }, - #xmlattr{ - name = 'name', - value = "captcha" + #xmlattr{name = 'name', + value = <<"captcha">> }, - #xmlattr{ - name = 'method', - value = "POST" + #xmlattr{name = 'method', + value = <<"POST">> } ], children = [ ImgEl, - #xmlel{ - name = 'br' + #xmlel{name = 'br' }, TextEl, - #xmlel{ - name = 'br' + #xmlel{name = 'br' }, IdEl, KeyEl, - #xmlel{ - name = 'br' + #xmlel{name = 'br' }, - #xmlel{ - name = 'input', + #xmlel{name = 'input', attrs = [ - #xmlattr{ - name = 'type', - value = "submit" + #xmlattr{name = 'type', + value = <<"submit">> }, - #xmlattr{ - name = 'name', - value = "enter" + #xmlattr{name = 'name', + value = <<"enter">> }, - #xmlattr{ - name = 'value', - value = "OK" + #xmlattr{name = 'value', + value = <<"OK">> } ] } @@ -399,16 +375,14 @@ process_reply(El) -> process(_Handlers, #request{method='GET', lang=Lang, path=[_, Id]}) -> case build_captcha_html(Id, Lang) of - {FormEl, _} when is_tuple(FormEl) -> + {FormEl, CaptchaTuple} when is_tuple(CaptchaTuple) -> Form = %{xmlelement, "div", [{"align", "center"}], %[FormEl]}, - #xmlel{ - name = 'div', + #xmlel{name = 'div', attrs = [ - #xmlattr{ - name = 'align', - value = "center" + #xmlattr{name = 'align', + value = <<"center">> } ], children = [FormEl] @@ -444,11 +418,9 @@ process(_Handlers, #request{method='POST', q=Q, lang=Lang, path=[_, Id]}) -> % [{xmlcdata, % translate:translate(Lang, "The captcha is valid.") % }]}, - #xmlel{ - name = 'p', + #xmlel{name = 'p', children = [ - #xmlcdata{ - cdata = translate:translate(Lang, "The captcha is valid.")} + #xmlcdata{cdata = translate:translate(Lang, "The captcha is valid.")} ] }, ejabberd_web:make_xhtml([Form]); @@ -502,7 +474,7 @@ code_change(_OldVsn, State, _Extra) -> %%-------------------------------------------------------------------- %% Function: create_image() -> {ok, Type, Key, Image} | {error, Reason} %% Type = "image/png" | "image/jpeg" | "image/gif" -%% Key = string() +%% Key = binary() %% Image = binary() %% Reason = atom() %%-------------------------------------------------------------------- @@ -516,11 +488,11 @@ create_image(Key) -> Cmd = lists:flatten(io_lib:format("~s ~s", [FileName, Key])), case cmd(Cmd) of {ok, <<16#89, $P, $N, $G, $\r, $\n, 16#1a, $\n, _/binary>> = Img} -> - {ok, "image/png", Key, Img}; + {ok, <<"image/png">>, Key, Img}; {ok, <<16#ff, 16#d8, _/binary>> = Img} -> - {ok, "image/jpeg", Key, Img}; + {ok, <<"image/jpeg">>, Key, Img}; {ok, <<$G, $I, $F, $8, X, $a, _/binary>> = Img} when X==$7; X==$9 -> - {ok, "image/gif", Key, Img}; + {ok, <<"image/gif">>, Key, Img}; {error, enodata = Reason} -> ?ERROR_MSG("Failed to process output from \"~s\". " "Maybe ImageMagick's Convert program is not installed.", @@ -547,6 +519,7 @@ get_prog_name() -> throw({error, option_not_configured_captcha_cmd}) end. +%% @doc (Str::string()) -> string() get_url(Str) -> case ejabberd_config:get_local_option(captcha_host) of Host when is_list(Host) -> diff --git a/src/ejabberd_check.erl b/src/ejabberd_check.erl index 8b315861a..637009980 100644 --- a/src/ejabberd_check.erl +++ b/src/ejabberd_check.erl @@ -88,8 +88,8 @@ get_db_used() -> DBs = lists:foldr( fun([Domain, DB], Acc) -> case check_odbc_option( - ejabberd_config:get_local_option( - {auth_method, Domain})) of + ejabberd_config:get_local_option + ({auth_method, Domain})) of true -> [get_db_type(DB)|Acc]; _ -> Acc end diff --git a/src/ejabberd_ctl.erl b/src/ejabberd_ctl.erl index 528b50aa5..e9bca6b21 100644 --- a/src/ejabberd_ctl.erl +++ b/src/ejabberd_ctl.erl @@ -438,8 +438,7 @@ print_usage() -> print_usage(dual, MaxC, ShCode). print_usage(HelpMode, MaxC, ShCode) -> AllCommands = - [ - {"status", [], "Get ejabberd status"}, + [{"status", [], "Get ejabberd status"}, {"stop", [], "Stop ejabberd"}, {"restart", [], "Restart ejabberd"}, {"help", ["[--tags [tag] | com?*]"], "Show help (try: ejabberdctl help help)"}, diff --git a/src/ejabberd_local.erl b/src/ejabberd_local.erl index ebcad372d..b6ae0a9f3 100644 --- a/src/ejabberd_local.erl +++ b/src/ejabberd_local.erl @@ -64,9 +64,8 @@ % These are the namespace already declared by the stream opening. This is % used at serialization time. -define(DEFAULT_NS, ?NS_JABBER_CLIENT). --define(PREFIXED_NS, [ - {?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx} -]). +-define(PREFIXED_NS, + [{?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx}]). %%==================================================================== %% API diff --git a/src/ejabberd_receiver.erl b/src/ejabberd_receiver.erl index f0cef9fe8..76a24c542 100644 --- a/src/ejabberd_receiver.erl +++ b/src/ejabberd_receiver.erl @@ -440,14 +440,12 @@ do_reset_stream(#state{xml_stream_state = XMLStreamState}) -> new_xmlstream(C2SPid, MaxStanzaSize) -> - Parser = exmpp_xml:start_parser([ - {names_as_atom, true}, - {check_nss, xmpp}, - {check_elems, xmpp}, - {check_attrs, xmpp}, - {max_size, MaxStanzaSize} - ]), - exmpp_xmlstream:start( - {gen_fsm, C2SPid}, Parser, - [{xmlstreamstart, new}] - ). + Parser = exmpp_xml:start_parser([{names_as_atom, true}, + {check_nss, xmpp}, + {check_elems, xmpp}, + {check_attrs, xmpp}, + {max_size, MaxStanzaSize} + ]), + exmpp_xmlstream:start({gen_fsm, C2SPid}, Parser, + [{xmlstreamstart, new}] + ). diff --git a/src/ejabberd_router.erl b/src/ejabberd_router.erl index be3a6401f..f9bc0ab76 100644 --- a/src/ejabberd_router.erl +++ b/src/ejabberd_router.erl @@ -427,8 +427,8 @@ do_route(OrigFrom, OrigTo, OrigPacket) -> drop end; Rs -> - Value = case ejabberd_config:get_local_option( - {domain_balancing, LDstDomain}) of + Value = case ejabberd_config:get_local_option + ({domain_balancing, LDstDomain}) of undefined -> now(); random -> now(); source -> jlib:short_prepd_jid(From); @@ -477,8 +477,8 @@ do_route(OrigFrom, OrigTo, OrigPacket) -> end. get_component_number(LDomain) -> - case ejabberd_config:get_local_option( - {domain_balancing_component_number, LDomain}) of + case ejabberd_config:get_local_option + ({domain_balancing_component_number, LDomain}) of N when is_integer(N), N > 1 -> N; diff --git a/src/ejabberd_s2s.erl b/src/ejabberd_s2s.erl index 59af8d9aa..8a69bcb04 100644 --- a/src/ejabberd_s2s.erl +++ b/src/ejabberd_s2s.erl @@ -61,9 +61,8 @@ % These are the namespace already declared by the stream opening. This is % used at serialization time. -define(DEFAULT_NS, ?NS_JABBER_CLIENT). --define(PREFIXED_NS, [ - {?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx} -]). +-define(PREFIXED_NS, + [{?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx}]). -record(s2s, {fromto, pid, key}). -record(state, {}). diff --git a/src/ejabberd_s2s_in.erl b/src/ejabberd_s2s_in.erl index b1b87c8df..e61e770a8 100644 --- a/src/ejabberd_s2s_in.erl +++ b/src/ejabberd_s2s_in.erl @@ -89,9 +89,8 @@ % These are the namespace already declared by the stream opening. This is % used at serialization time. -define(DEFAULT_NS, ?NS_JABBER_SERVER). --define(PREFIXED_NS, [ - {?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx} -]). +-define(PREFIXED_NS, + [{?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx}]). %%%---------------------------------------------------------------------- %%% API @@ -524,8 +523,7 @@ handle_sync_event(get_state_infos, _From, StateName, StateData) -> [D || {{D, _}, established} <- dict:to_list(Connections)] end, - Infos = [ - {direction, in}, + Infos = [{direction, in}, {statename, StateName}, {addr, Addr}, {port, Port}, diff --git a/src/ejabberd_s2s_out.erl b/src/ejabberd_s2s_out.erl index 37d20651b..7e686cce5 100644 --- a/src/ejabberd_s2s_out.erl +++ b/src/ejabberd_s2s_out.erl @@ -106,9 +106,8 @@ % These are the namespace already declared by the stream opening. This is % used at serialization time. -define(DEFAULT_NS, ?NS_JABBER_SERVER). --define(PREFIXED_NS, [ - {?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx} -]). +-define(PREFIXED_NS, + [{?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx}]). -define(SOCKET_DEFAULT_RESULT, {error, badarg}). @@ -606,9 +605,8 @@ wait_for_starttls_proceed({xmlstreamelement, El}, StateData) -> ?DEBUG("starttls: ~p", [{StateData#state.myname, StateData#state.server}]), Socket = StateData#state.socket, - TLSOpts = case ejabberd_config:get_local_option( - {domain_certfile, - StateData#state.server}) of + TLSOpts = case ejabberd_config:get_local_option + ({domain_certfile, StateData#state.server}) of undefined -> StateData#state.tls_options; CertFile -> @@ -763,8 +761,7 @@ handle_sync_event(get_state_infos, _From, StateName, StateData) -> _:_ -> {unknown,unknown} end, - Infos = [ - {direction, out}, + Infos = [{direction, out}, {statename, StateName}, {addr, Addr}, {port, Port}, @@ -862,8 +859,8 @@ terminate(Reason, StateName, StateData) -> false -> ok; Key -> - ejabberd_s2s:remove_connection( - {StateData#state.myname, StateData#state.server}, self(), Key) + ejabberd_s2s:remove_connectio + ({StateData#state.myname, StateData#state.server}, self(), Key) end, %% bounce queue manage by process and Erlang message queue bounce_queue(StateData#state.queue, 'remote-server-not-found'), @@ -953,8 +950,8 @@ send_db_request(StateData) -> Server = StateData#state.server, New = case StateData#state.new of false -> - case ejabberd_s2s:try_register( - {StateData#state.myname, Server}) of + case ejabberd_s2s:try_register + ({StateData#state.myname, Server}) of {key, Key} -> Key; false -> diff --git a/src/ejabberd_service.erl b/src/ejabberd_service.erl index a786a217f..943ce4e55 100644 --- a/src/ejabberd_service.erl +++ b/src/ejabberd_service.erl @@ -349,6 +349,9 @@ handle_info({route, From, To, Packet}, StateName, StateData) -> Err = exmpp_stanza:reply_with_error(Packet, 'not-allowed'), ejabberd_router:route_error(To, From, Err, Packet) end, + {next_state, StateName, StateData}; +handle_info(Info, StateName, StateData) -> + ?ERROR_MSG("Unexpected info: ~p", [Info]), {next_state, StateName, StateData}. diff --git a/src/ejabberd_sm.erl b/src/ejabberd_sm.erl index f6d09276f..4afeb08e7 100644 --- a/src/ejabberd_sm.erl +++ b/src/ejabberd_sm.erl @@ -80,9 +80,8 @@ % These are the namespace already declared by the stream opening. This is % used at serialization time. -define(DEFAULT_NS, ?NS_JABBER_CLIENT). --define(PREFIXED_NS, [ - {?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx} -]). +-define(PREFIXED_NS, + [{?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx}]). -define(IS_BINARY_OR_UNDEF(X), @@ -211,10 +210,12 @@ get_user_info(User, Server, Resource) end, if is_list(Ss), Ss /= [] -> Session = lists:max(Ss), - N = node(element(2, Session#session.sid)), Conn = proplists:get_value(conn, Session#session.info), IP = proplists:get_value(ip, Session#session.info), - [{node, N}, {conn, Conn}, {ip, IP}]; + Priority = Session#session.priority, %% integer() + {CreationNow, Pid} = Session#session.sid, + CreationString = jlib:now_to_utc_string(CreationNow), + [{node, Node}, {conn, Conn}, {ip, IP}, {priority, Priority}, {pid, Pid}, {creation, CreationString}]; true -> offline end. diff --git a/src/ejabberd_sup.erl b/src/ejabberd_sup.erl index e088c032b..7523eed2d 100644 --- a/src/ejabberd_sup.erl +++ b/src/ejabberd_sup.erl @@ -191,6 +191,13 @@ init([]) -> brutal_kill, worker, [ejabberd_cluster]}, + CacheTabSupervisor = + {cache_tab_sup, + {cache_tab_sup, start_link, []}, + permanent, + infinity, + supervisor, + [cache_tab_sup]}, {ok, {{one_for_one, 10, 1}, [Hooks, GlobalRouter, @@ -212,6 +219,7 @@ init([]) -> IQSupervisor, STUNSupervisor, FrontendSocketSupervisor, + CacheTabSupervisor, Listener]}}. diff --git a/src/eldap/eldap.erl b/src/eldap/eldap.erl index 7868f6036..7b14ae5c9 100644 --- a/src/eldap/eldap.erl +++ b/src/eldap/eldap.erl @@ -423,8 +423,8 @@ get_handle(Name) when is_list(Name) -> list_to_atom("eldap_" ++ Name). %%---------------------------------------------------------------------- init([]) -> case get_config() of - {ok, Hosts, Rootdn, Passwd, Opts} -> - init({Hosts, Rootdn, Passwd, Opts}); + {ok, Hosts, Port, Rootdn, Passwd, Opts} -> + init({Hosts, Port, Rootdn, Passwd, Opts}); {error, Reason} -> {stop, Reason} end; @@ -440,8 +440,6 @@ init({Hosts, Port, Rootdn, Passwd, Opts}) -> case Encrypt of tls -> ?LDAPS_PORT; - starttls -> - ?LDAP_PORT; _ -> ?LDAP_PORT end; @@ -886,14 +884,9 @@ cancel_timer(Timer) -> %%% Sanity check of received packet check_tag(Data) -> - case asn1rt_ber_bin:decode_tag(Data) of - {_Tag, Data1, _Rb} -> - case asn1rt_ber_bin:decode_length(Data1) of - {{_Len,_Data2}, _Rb2} -> ok; - _ -> throw({error,decoded_tag_length}) - end; - _ -> throw({error,decoded_tag}) - end. + {_Tag, Data1, _Rb} = asn1rt_ber_bin:decode_tag(Data), + {{_Len,_Data2}, _Rb2} = asn1rt_ber_bin:decode_length(Data1), + ok. close_and_retry(S, Timeout) -> catch (S#eldap.sockmod):close(S#eldap.fd), diff --git a/src/gen_mod.erl b/src/gen_mod.erl index d13b348d0..08ae0f88d 100644 --- a/src/gen_mod.erl +++ b/src/gen_mod.erl @@ -246,6 +246,8 @@ get_hosts(Opts, Prefix) -> Hosts end. +get_module_proc(Host, Base) when is_binary(Host) -> + get_module_proc(binary_to_list(Host), Base); get_module_proc(global, Base) -> list_to_atom(atom_to_list(Base) ++ "__global"); get_module_proc(Host, {frontend, Base}) -> diff --git a/src/gen_storage.erl b/src/gen_storage.erl index 99af489fe..541bcd776 100644 --- a/src/gen_storage.erl +++ b/src/gen_storage.erl @@ -58,14 +58,21 @@ behaviour_info(_) -> -include("ejabberd.hrl"). % This is used for ERROR_MSG %% Returns all hosts where the table Tab is defined --spec all_table_hosts(atom()) -> +-spec all_table_hosts(storage_table()) -> [storage_host()]. all_table_hosts(Tab) -> - mnesia:dirty_select(table, [{{table, {'$1', '$2'}, '_', '_'}, + TT = setelement(2, {table, {<<"hidding_from_dialyzer">>, '$2'}, '_', '_'}, {'$1', '$2'}), + Res = (catch mnesia:dirty_select(table, [{TT, [{'=:=', '$2', {const, Tab}}], - ['$1']}]). + ['$1']}])), + case Res of + Res when is_list(Res) -> + [HostB || HostB <- Res, is_binary(HostB)]; + _ -> + [] + end. --spec table_info(storage_host, storage_table, atom()) -> +-spec table_info(storage_host(), storage_table(), atom()) -> any(). table_info(Host, Tab, InfoKey) -> Info = @@ -108,7 +115,7 @@ table_info(Host, Tab, InfoKey) -> %% option() is any mnesia option %% columndef() defaults to text for all unspecified attributes --spec create_table(atom(), storage_host(), storage_table(), #table{}) -> +-spec create_table(atom(), storage_host(), storage_table(), list()) -> tuple(). create_table(mnesia, Host, Tab, Def) -> @@ -130,9 +137,9 @@ define_table(Backend, Host, Name, Def) -> backend = Backend, def = Def}). -%% @spec (#table{}) -> [{atom(), any()}] +%% @spec (list()) -> [{atom(), any()}] --spec filter_mnesia_tabdef(#table{}) -> +-spec filter_mnesia_tabdef(list()) -> [any()]. filter_mnesia_tabdef(TabDef) -> @@ -202,6 +209,7 @@ dirty_read(Host, Tab, Key) -> | {'or', matchrule(), matchrule()} | {'orelse', matchrule(), matchrule()} | {'=', Attribute::atom(), matchvalue()} + | {'<', Attribute::atom(), matchvalue()} | {'=/=', Attribute::atom(), matchvalue()} | {like, Attribute::atom(), matchvalue()}). diff --git a/src/gen_storage_odbc.erl b/src/gen_storage_odbc.erl index 6da489da2..9fd56b4a7 100644 --- a/src/gen_storage_odbc.erl +++ b/src/gen_storage_odbc.erl @@ -22,7 +22,7 @@ attributes :: [string()], % Columns columns :: string(), % "\"col1\", \"col2\" ,..." column_names :: [{string(), [string()]}], % [{string(), [string()]}] (already quoted) - types :: [{string(), atom()}], + types :: [{string(), atom() | tuple()}], host :: string() }). -record(odbc_cont, {tabdef, sql, offset = 0, limit}). diff --git a/src/mod_caps.erl b/src/mod_caps.erl index b338243a7..5cd8e274d 100644 --- a/src/mod_caps.erl +++ b/src/mod_caps.erl @@ -99,11 +99,12 @@ get_features(#caps{node = Node, version = Version, exts = Exts}) -> SubNodes = [Version | Exts], lists:foldl( fun(SubNode, Acc) -> - case mnesia:dirty_read({caps_features, - node_to_binary(Node, SubNode)}) of - [] -> + BinaryNode = node_to_binary(Node, SubNode), + case cache_tab:lookup(caps_features, BinaryNode, + caps_read_fun(BinaryNode)) of + error -> Acc; - [#caps_features{features = Features}] -> + {ok, Features} -> binary_to_features(Features) ++ Acc end end, [], SubNodes). @@ -189,13 +190,23 @@ disco_info(Acc, _Host, _Module, _Node, _Lang) -> %%==================================================================== %% gen_server callbacks %%==================================================================== - -init([Host, _Opts]) -> +init([Host, Opts]) -> + case catch mnesia:table_info(caps_features, storage_type) of + {'EXIT', _} -> + ok; + disc_only_copies -> + ok; + _ -> + mnesia:delete_table(caps_features) + end, mnesia:create_table(caps_features, - [{disc_copies, [node()]}, + [{disc_only_copies, [node()]}, {local_content, true}, {attributes, record_info(fields, caps_features)}]), - mnesia:add_table_copy(caps_features, node(), disc_copies), + mnesia:add_table_copy(caps_features, node(), disc_only_copies), + MaxSize = gen_mod:get_opt(cache_size, Opts, 1000), + LifeTime = gen_mod:get_opt(cache_life_time, Opts, timer:hours(24) div 1000), + cache_tab:new(caps_features, [{max_size, MaxSize}, {life_time, LifeTime}]), HostB = list_to_binary(Host), ejabberd_hooks:add(user_send_packet, HostB, ?MODULE, user_send_packet, 75), ejabberd_hooks:add(c2s_stream_features, HostB, @@ -245,8 +256,9 @@ code_change(_OldVsn, State, _Extra) -> feature_request(Host, From, Caps, [SubNode | Tail] = SubNodes) -> Node = Caps#caps.node, BinaryNode = node_to_binary(Node, SubNode), - case mnesia:dirty_read({caps_features, BinaryNode}) of - [] -> + case cache_tab:lookup(caps_features, BinaryNode, + caps_read_fun(BinaryNode)) of + error -> IQ = #iq{type = get, iq_ns = ?NS_JABBER_CLIENT, payload = #xmlel{ns = ?NS_DISCO_INFO, name = 'query', @@ -272,8 +284,10 @@ feature_response(#iq{type = result, payload = El}, [] end, El#xmlel.children), BinaryNode = node_to_binary(Caps#caps.node, SubNode), - mnesia:dirty_write(#caps_features{node_pair = BinaryNode, - features = features_to_binary(Features)}), + BinaryFeatures = features_to_binary(Features), + cache_tab:insert( + caps_features, BinaryNode, BinaryFeatures, + caps_write_fun(BinaryNode, BinaryFeatures)), feature_request(Host, From, Caps, SubNodes); feature_response(timeout, _Host, _From, _Caps, _SubNodes) -> ok; @@ -281,7 +295,8 @@ feature_response(_IQResult, Host, From, Caps, [SubNode | SubNodes]) -> %% We got type=error or invalid type=result stanza, so %% we cache empty feature not to probe the client permanently BinaryNode = node_to_binary(Caps#caps.node, SubNode), - mnesia:dirty_write(#caps_features{node_pair = BinaryNode}), + cache_tab:insert(caps_features, BinaryNode, [], + caps_write_fun(BinaryNode, [])), feature_request(Host, From, Caps, SubNodes). node_to_binary(Node, SubNode) -> @@ -290,6 +305,23 @@ node_to_binary(Node, SubNode) -> features_to_binary(L) -> [list_to_binary(I) || I <- L]. binary_to_features(L) -> [binary_to_list(I) || I <- L]. +caps_read_fun(Node) -> + fun() -> + case mnesia:dirty_read({caps_features, Node}) of + [#caps_features{features = Features}] -> + {ok, Features}; + _ -> + error + end + end. + +caps_write_fun(Node, Features) -> + fun() -> + mnesia:dirty_write( + #caps_features{node_pair = Node, + features = Features}) + end. + make_my_disco_hash(Host) -> JID = exmpp_jid:make(Host), case {ejabberd_hooks:run_fold(disco_local_features, diff --git a/src/mod_muc/mod_muc_room.erl b/src/mod_muc/mod_muc_room.erl index 157073389..cb8ec1cd8 100644 --- a/src/mod_muc/mod_muc_room.erl +++ b/src/mod_muc/mod_muc_room.erl @@ -232,9 +232,9 @@ normal_state({route, From, undefined, message_time = Now, message_shaper = MessageShaper, message = Packet}, - RoomQueue = queue:in( - {message, From}, - StateData#state.room_queue), + RoomQueue = + queue:in({message, From}, + StateData#state.room_queue), StateData2 = store_user_activity( From, NewActivity, StateData1), @@ -1684,7 +1684,7 @@ add_new_user(From, Nick, Packet, StateData) -> StateData; captcha_required -> SID = case exmpp_stanza:get_id(Packet) of - undefined -> ""; + undefined -> <<"">>; SID1 -> SID1 end, RoomJID = StateData#state.jid, @@ -1693,7 +1693,7 @@ add_new_user(From, Nick, Packet, StateData) -> SID, RoomJID, To, Lang, From) of {ok, ID, CaptchaEls} -> MsgPkt = #xmlel{name = 'message', - attrs = [#xmlattr{name = 'id', value = ID}], + attrs = [#xmlattr{name = 'id', value = list_to_binary(ID)}], children = CaptchaEls}, Robots = ?DICT:store(From, {Nick, Packet}, StateData#state.robots), @@ -3042,8 +3042,8 @@ get_config(Lang, StateData, From) -> true -> [#xmlel{name = 'option', attrs = [?XMLATTR('label', translate:translate(Lang, "No limit"))], - children = [#xmlel{name = 'value', children = [#xmlcdata{ - cdata = <<"none">>}]}]}] + children = [#xmlel{name = 'value', + children = [#xmlcdata{cdata = <<"none">>}]}]}] end ++ [#xmlel{name = 'option', attrs = [?XMLATTR('label', N)], children = [#xmlel{name = 'value', children = [ diff --git a/src/mod_privacy.erl b/src/mod_privacy.erl index e1b882e72..1e95553b9 100644 --- a/src/mod_privacy.erl +++ b/src/mod_privacy.erl @@ -157,8 +157,8 @@ start(Host, Opts) -> {match_presence_out, atom} ]}]), update_tables(Host, Backend), - gen_storage:add_table_index(Host, privacy_list, name), - gen_storage:add_table_index(Host, privacy_list_data, name), + gen_storage:add_table_index(HostB, privacy_list, name), + gen_storage:add_table_index(HostB, privacy_list_data, name), ejabberd_hooks:add(privacy_iq_get, HostB, ?MODULE, process_iq_get, 50), ejabberd_hooks:add(privacy_iq_set, HostB, @@ -215,20 +215,21 @@ process_iq_get(_, From, _To, #iq{payload = SubEl}, process_lists_get(LUser, LServer, Active) -> + LServerB = list_to_binary(LServer), F = fun() -> Default = - case gen_storage:read(LServer, {privacy_default_list, {LUser, LServer}}) of + case gen_storage:read(LServerB, {privacy_default_list, {LUser, LServer}}) of [#privacy_default_list{name = Name}] -> Name; _ -> none end, Lists = [List#privacy_list.name - || List <- gen_storage:read(LServer, {privacy_list, {LUser, LServer}})], + || List <- gen_storage:read(LServerB, {privacy_list, {LUser, LServer}})], {Default, Lists} end, - case gen_storage:transaction(LServer, privacy_list, F) of - {'EXIT', _Reason} -> + case gen_storage:transaction(LServerB, privacy_list, F) of + {aborted, _Reason} -> {error, 'internal-server-error'}; {atomic, {Default, Lists}} -> case Lists of @@ -258,19 +259,20 @@ process_list_get(_LUser, _LServer, false) -> {error, 'bad-request'}; process_list_get(LUser, LServer, Name) -> + LServerB = list_to_binary(LServer), F = fun() -> - case gen_storage:select(LServer, privacy_list, + case gen_storage:select(LServerB, privacy_list, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]) of [] -> none; [#privacy_list{}] -> - gen_storage:select(LServer, privacy_list_data, + gen_storage:select(LServerB, privacy_list_data, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]) end end, - case gen_storage:transaction(LServer, privacy_list, F) of + case gen_storage:transaction(LServerB, privacy_list, F) of {aborted, _Reason} -> {error, 'internal-server-error'}; {atomic, none} -> @@ -375,10 +377,11 @@ process_iq_set(_, From, _To, #iq{payload = SubEl}) -> process_default_set(LUser, LServer, false) -> + LServerB = list_to_binary(LServer), F = fun() -> - gen_storage:delete(LServer, {privacy_default_list, {LUser, LServer}}) + gen_storage:delete(LServerB, {privacy_default_list, {LUser, LServer}}) end, - case gen_storage:transaction(LServer, privacy_default_list, F) of + case gen_storage:transaction(LServerB, privacy_default_list, F) of {atomic, _} -> {result, []}; _ -> @@ -386,20 +389,21 @@ process_default_set(LUser, LServer, false) -> end; process_default_set(LUser, LServer, Name) -> + LServerB = list_to_binary(LServer), F = fun() -> - case gen_storage:select(LServer, privacy_list, + case gen_storage:select(LServerB, privacy_list, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]) of [] -> {error, 'item-not-found'}; [#privacy_list{}] -> - gen_storage:write(LServer, + gen_storage:write(LServerB, #privacy_default_list{user_host = {LUser, LServer}, name = Name}), {result, []} end end, - case gen_storage:transaction(LServer, privacy_list, F) of + case gen_storage:transaction(LServerB, privacy_list, F) of {atomic, {error, _} = Error} -> Error; {atomic, {result, _} = Res} -> @@ -413,21 +417,25 @@ process_active_set(_LUser, _LServer, false) -> {result, [], #userlist{}}; process_active_set(LUser, LServer, Name) -> + LServerB = list_to_binary(LServer), F = fun() -> - case gen_storage:select(LServer, privacy_list, + case gen_storage:select(LServerB, privacy_list, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]) of [#privacy_list{}] -> - List = gen_storage:select(LServer, privacy_list_data, + Data = gen_storage:select(LServerB, privacy_list_data, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]), + List = list_data_to_items(Data), + NeedDb = is_list_needdb(List), {result, [], #userlist{name = Name, - list = list_data_to_items(List)}}; + needdb = NeedDb, + list = List}}; [] -> {error, 'item-not-found'} end end, - case gen_storage:transaction(LServer, privacy_list, F) of + case gen_storage:transaction(LServerB, privacy_list, F) of {atomic, Res} -> Res; _ -> @@ -440,26 +448,27 @@ process_list_set(_LUser, _LServer, false, _Els) -> {error, 'bad-request'}; process_list_set(LUser, LServer, Name, Els) -> + LServerB = list_to_binary(LServer), case parse_items(Els) of false -> {error, 'bad-request'}; remove -> F = fun() -> - case gen_storage:read(LServer, + case gen_storage:read(LServerB, {privacy_default_list, {LUser, LServer}}) of [#privacy_default_list{name = Default}] when Name == Default -> {error, 'conflict'}; _ -> - gen_storage:delete_where(LServer, privacy_list, + gen_storage:delete_where(LServerB, privacy_list, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]), - gen_storage:delete_where(LServer, privacy_list_data, + gen_storage:delete_where(LServerB, privacy_list_data, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]), {result, []} end end, - case gen_storage:transaction(LServer, privacy_list, F) of + case gen_storage:transaction(LServerB, privacy_list, F) of {atomic, {error, _} = Error} -> Error; {atomic, {result, _} = Res} -> @@ -477,24 +486,24 @@ process_list_set(LUser, LServer, Name, Els) -> List -> F = fun() -> OldData = - gen_storage:select(LServer, privacy_list_data, + gen_storage:select(LServerB, privacy_list_data, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]), lists:foreach( fun(Data1) -> - gen_storage:delete_object(LServer, Data1) + gen_storage:delete_object(LServerB, Data1) end, OldData), - gen_storage:write(LServer, #privacy_list{user_host = {LUser, LServer}, + gen_storage:write(LServerB, #privacy_list{user_host = {LUser, LServer}, name = Name}), NewData = list_items_to_data(LUser, LServer, Name, List), lists:foreach( fun(Data1) -> - gen_storage:write(LServer, Data1) + gen_storage:write(LServerB, Data1) end, NewData), {result, []} end, - case gen_storage:transaction(LServer, privacy_list, F) of + case gen_storage:transaction(LServerB, privacy_list, F) of {atomic, {error, _} = Error} -> Error; {atomic, {result, _} = Res} -> @@ -647,17 +656,17 @@ is_list_needdb(Items) -> end end, Items). -get_user_list(_, User, Server) - when is_binary(User), is_binary(Server) -> +get_user_list(_, User, LServerB) + when is_binary(User), is_binary(LServerB) -> LUser = binary_to_list(User), - LServer = binary_to_list(Server), + LServer = binary_to_list(LServerB), F = fun() -> - case gen_storage:read(LServer, + case gen_storage:read(LServerB, {privacy_default_list, {LUser, LServer}}) of [] -> #userlist{}; [#privacy_default_list{name = Default}] -> - Data = gen_storage:select(LServer, privacy_list_data, + Data = gen_storage:select(LServerB, privacy_list_data, [{'=', user_host, {LUser, LServer}}, {'=', name, Default}]), List = list_data_to_items(Data), @@ -667,7 +676,7 @@ get_user_list(_, User, Server) list = List} end end, - {atomic, Res} = gen_storage:transaction(LServer, privacy_default_list, F), + {atomic, Res} = gen_storage:transaction(LServerB, privacy_default_list, F), Res. @@ -768,9 +777,9 @@ is_ptype_match(Item, PType) -> %% TODO: Investigate this: sometimes Value has binaries, other times has strings is_type_match(jid, Value, JID, _Subscription, _Groups) -> {User, Server, Resource} = exmpp_jid:to_lower(exmpp_jid:parse(Value)), - ((User == undefined) orelse (User == []) orelse (User == exmpp_jid:prep_node(JID))) - andalso ((Server == undefined) orelse (Server == []) orelse (Server == exmpp_jid:prep_domain(JID))) - andalso ((Resource == undefined) orelse (Resource == []) orelse (Resource == exmpp_jid:prep_resource(JID))); + ((User == undefined) orelse (User == exmpp_jid:prep_node(JID))) + andalso ((Server == undefined) orelse (Server == exmpp_jid:prep_domain(JID))) + andalso ((Resource == undefined) orelse (Resource == exmpp_jid:prep_resource(JID))); is_type_match(subscription, Value, _JID, Subscription, _Groups) -> Value == Subscription; is_type_match(group, Value, _JID, _Subscription, Groups) -> @@ -780,10 +789,11 @@ is_type_match(group, Value, _JID, _Subscription, Groups) -> remove_user(User, Server) -> LUser = exmpp_stringprep:nodeprep(User), LServer = exmpp_stringprep:nameprep(Server), + LServerB = list_to_binary(LServer), F = fun() -> - gen_storage:delete(LServer, {privacy_list, {LUser, LServer}}) + gen_storage:delete(LServerB, {privacy_list, {LUser, LServer}}) end, - case gen_storage:transaction(LServer, privacy_list, F) of + case gen_storage:transaction(LServerB, privacy_list, F) of {atomic, _} -> {result, []}; _ -> diff --git a/src/mod_pubsub/mod_pubsub.erl b/src/mod_pubsub/mod_pubsub.erl index 9ece1fe53..77737b44d 100644 --- a/src/mod_pubsub/mod_pubsub.erl +++ b/src/mod_pubsub/mod_pubsub.erl @@ -49,8 +49,6 @@ -behaviour(gen_server). -behaviour(gen_mod). --include_lib("exmpp/include/exmpp.hrl"). - -include("ejabberd.hrl"). -include("adhoc.hrl"). -include("pubsub.hrl"). @@ -296,18 +294,18 @@ update_node_database(Host, ServerHost) -> ?INFO_MSG("upgrade node pubsub tables",[]), F = fun() -> {Result, LastIdx} = lists:foldl( - fun({pubsub_node, NodeId, ParentId, {nodeinfo, Items, Options, Entities}}, {RecList, NodeIdx}) -> + fun({pubsub_node, NodeId, ParentId, {nodeinfo, Items, Options, Entities}}, {RecList, Nidx}) -> ItemsList = lists:foldl( - fun({item, IID, Publisher, Payload}, Acc) -> + fun({item, ItemName, Publisher, Payload}, Acc) -> C = {unknown, Publisher}, M = {now(), Publisher}, mnesia:write( - #pubsub_item{itemid = {IID, NodeIdx}, + #pubsub_item{id = {ItemName, Nidx}, creation = C, modification = M, payload = Payload}), - [{Publisher, IID} | Acc] + [{Publisher, ItemName} | Acc] end, [], Items), Owners = dict:fold( @@ -321,7 +319,7 @@ update_node_database(Host, ServerHost) -> end end, [], ItemsList), mnesia:write({pubsub_state, - {JID, NodeIdx}, + {JID, Nidx}, UsrItems, Aff, Sub}), @@ -331,15 +329,15 @@ update_node_database(Host, ServerHost) -> end end, [], Entities), mnesia:delete({pubsub_node, NodeId}), - {[#pubsub_node{nodeid = NodeId, - id = NodeIdx, + {[#pubsub_node{id = NodeId, + idx = Nidx, parents = [element(2, ParentId)], owners = Owners, options = Options} | - RecList], NodeIdx + 1} + RecList], Nidx + 1} end, {[], 1}, - mnesia:match_object( - {pubsub_node, {Host, '_'}, '_', '_'})), + mnesia:match_object + ({pubsub_node, {Host, '_'}, '_', '_'})), mnesia:write(#pubsub_index{index = node, last = LastIdx, free = []}), Result end, @@ -361,36 +359,37 @@ update_node_database(Host, ServerHost) -> [nodeid, parentid, type, owners, options] -> F = fun({pubsub_node, NodeId, {_, Parent}, Type, Owners, Options}) -> #pubsub_node{ - nodeid = NodeId, - id = 0, + id = NodeId, + idx = 0, parents = [Parent], type = Type, owners = Owners, options = Options} end, + %% TODO : to change nodeid/id and id/idx or not to change ? mnesia:transform_table(pubsub_node, F, [nodeid, id, parents, type, owners, options]), FNew = fun() -> - LastIdx = lists:foldl(fun(#pubsub_node{nodeid = NodeId} = PubsubNode, NodeIdx) -> - mnesia:write(PubsubNode#pubsub_node{id = NodeIdx}), - lists:foreach(fun(#pubsub_state{stateid = StateId} = State) -> + LastIdx = lists:foldl(fun(#pubsub_node{id = NodeId} = PubsubNode, Nidx) -> + mnesia:write(PubsubNode#pubsub_node{idx = Nidx}), + lists:foreach(fun(#pubsub_state{id = StateId} = State) -> {JID, _} = StateId, mnesia:delete({pubsub_state, StateId}), - mnesia:write(State#pubsub_state{stateid = {JID, NodeIdx}}) - end, mnesia:match_object(#pubsub_state{stateid = {'_', NodeId}, _ = '_'})), - lists:foreach(fun(#pubsub_item{itemid = ItemId} = Item) -> - {IID, _} = ItemId, + mnesia:write(State#pubsub_state{id = {JID, Nidx}}) + end, mnesia:match_object(#pubsub_state{id = {'_', NodeId}, _ = '_'})), + lists:foreach(fun(#pubsub_item{id = ItemId} = Item) -> + {ItemName, _} = ItemId, {M1, M2} = Item#pubsub_item.modification, {C1, C2} = Item#pubsub_item.creation, mnesia:delete({pubsub_item, ItemId}), - mnesia:write(Item#pubsub_item{itemid = {IID, NodeIdx}, + mnesia:write(Item#pubsub_item{id = {ItemName, Nidx}, modification = {M2, M1}, creation = {C2, C1}}) - end, mnesia:match_object(#pubsub_item{itemid = {'_', NodeId}, _ = '_'})), - NodeIdx + 1 - end, 1, mnesia:match_object( - {pubsub_node, {Host, '_'}, '_', '_', '_', '_', '_'}) - ++ mnesia:match_object( - {pubsub_node, {{'_', ServerHost, '_'}, '_'}, '_', '_', '_', '_', '_'})), + end, mnesia:match_object(#pubsub_item{id = {'_', NodeId}, _ = '_'})), + Nidx + 1 + end, 1, mnesia:match_object + ({pubsub_node, {Host, '_'}, '_', '_', '_', '_', '_'}) + ++ mnesia:match_object + ({pubsub_node, {{'_', ServerHost, '_'}, '_'}, '_', '_', '_', '_', '_'})), mnesia:write(#pubsub_index{index = node, last = LastIdx, free = []}) end, case mnesia:transaction(FNew) of @@ -403,13 +402,14 @@ update_node_database(Host, ServerHost) -> [nodeid, id, parent, type, owners, options] -> F = fun({pubsub_node, NodeId, Id, Parent, Type, Owners, Options}) -> #pubsub_node{ - nodeid = NodeId, - id = Id, + id = NodeId, + idx = Id, parents = [Parent], type = Type, owners = Owners, options = Options} end, + %% TODO : to change nodeid/id and id/idx or not to change ? mnesia:transform_table(pubsub_node, F, [nodeid, id, parents, type, owners, options]), rename_default_nodeplugin(); _ -> @@ -427,7 +427,7 @@ update_node_database(Host, ServerHost) -> [<<>>] -> []; Parents -> Parents end, - mnesia:write(Node#pubsub_node{nodeid={H, BN}, parents=BP}), + mnesia:write(Node#pubsub_node{id={H, BN}, parents=BP}), mnesia:delete({pubsub_node, {H, N}}); (_) -> ok @@ -446,15 +446,15 @@ update_state_database(_Host, _ServerHost) -> case catch mnesia:table_info(pubsub_state, attributes) of [stateid, items, affiliation, subscription] -> ?INFO_MSG("upgrade state pubsub tables", []), - F = fun ({pubsub_state, {JID, NodeID}, Items, Aff, Sub}, Acc) -> + F = fun ({pubsub_state, {JID, NodeId}, Items, Aff, Sub}, Acc) -> Subs = case Sub of none -> []; _ -> - {result, SubID} = pubsub_subscription:subscribe_node(JID, NodeID, []), - [{Sub, SubID}] + {result, SubId} = pubsub_subscription:subscribe_node(JID, NodeId, []), + [{Sub, SubId}] end, - NewState = #pubsub_state{stateid = {JID, NodeID}, + NewState = #pubsub_state{id = {JID, NodeId}, items = Items, affiliation = Aff, subscriptions = Subs}, @@ -495,10 +495,10 @@ send_loop(State) -> lists:foreach( fun({Node, subscribed, _, SubJID}) -> if (SubJID == LJID) or (SubJID == BJID) -> - #pubsub_node{nodeid = {H, N}, type = Type, id = NodeId, options = Options} = Node, + #pubsub_node{id = {H, N}, type = Type, idx = Nidx, options = Options} = Node, case get_option(Options, send_last_published_item) of on_sub_and_presence -> - send_items(H, N, NodeId, Type, LJID, last); + send_items(H, N, Nidx, Type, LJID, last); _ -> ok end; @@ -548,7 +548,7 @@ send_loop(State) -> spawn(fun() -> Host = State#state.host, Owner = jlib:short_prepd_bare_jid(JID), - lists:foreach(fun(#pubsub_node{nodeid = {_, Node}, type = Type, id = NodeId, options = Options}) -> + lists:foreach(fun(#pubsub_node{id = {_, Node}, type = Type, idx = Nidx, options = Options}) -> case get_option(Options, send_last_published_item) of on_sub_and_presence -> lists:foreach(fun(Resource) -> @@ -563,7 +563,7 @@ send_loop(State) -> {OU, OS, _} = Owner, element(2, get_roster_info(OU, OS, LJID, Grps)) end, - if Subscribed -> send_items(Owner, Node, NodeId, Type, LJID, last); + if Subscribed -> send_items(Owner, Node, Nidx, Type, LJID, last); true -> ok end end, Resources); @@ -616,8 +616,8 @@ disco_identity(_Host, <<>>, _From) -> [#xmlel{name = 'identity', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('category', <<"pubsub">>), ?XMLATTR('type', <<"pep">>)]}]; disco_identity(Host, Node, From) -> - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> {result, [#xmlel{name = 'identity', ns = ?NS_DISCO_INFO, @@ -647,8 +647,8 @@ disco_features(_Host, <<>>, _From) -> [?NS_PUBSUB_s | [?NS_PUBSUB_s++"#"++Feature || Feature <- features("pep")]]; disco_features(Host, Node, From) -> - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> {result, [?NS_PUBSUB_s | [?NS_PUBSUB_s ++ "#" ++ Feature || Feature <- features("pep")]]}; @@ -666,12 +666,12 @@ disco_sm_items({result, OtherItems}, From, To, Node, _Lang) -> {result, disco_items(To, Node, From) ++ OtherItems}. disco_items(Host, <<>>, From) -> - Action = fun(#pubsub_node{nodeid ={_, NodeID}, options = Options, type = Type, id = Idx, owners = Owners}, Acc) -> - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{id ={_, NodeId}, options = Options, type = Type, idx = Nidx, owners = Owners}, Acc) -> + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> [#xmlel{name = 'item', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('jid', exmpp_jid:to_binary(Host)), - ?XMLATTR('node', NodeID) | + ?XMLATTR('node', NodeId) | case get_option(Options, title) of false -> []; [Title] -> [?XMLATTR('title', Title)] @@ -686,14 +686,14 @@ disco_items(Host, <<>>, From) -> end; disco_items(Host, Node, From) -> - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, Items} -> {result, [#xmlel{name = 'item', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('jid', exmpp_jid:to_binary(Host)), - ?XMLATTR('name', ItemID)]} - || #pubsub_item{itemid = {ItemID,_}} <- Items]}; + ?XMLATTR('name', ItemId)]} + || #pubsub_item{id = {ItemId,_}} <- Items]}; _ -> {result, []} end end, @@ -723,6 +723,7 @@ presence_probe(Peer, JID, Pid) -> presence(Host, {presence, User, Server, [Resource], JID}) end end. + presence(ServerHost, Presence) when is_binary(ServerHost) -> presence(binary_to_list(ServerHost), Presence); presence(ServerHost, Presence) -> @@ -771,12 +772,12 @@ unsubscribe_user(Entity, Owner) -> lists:foreach(fun(PType) -> {result, Subscriptions} = node_action(Host, PType, get_entity_subscriptions, [Host, Entity]), lists:foreach(fun - ({#pubsub_node{options = Options, owners = Owners, id = NodeId}, subscribed, _, JID}) -> + ({#pubsub_node{options = Options, owners = Owners, idx = Nidx}, subscribed, _, JID}) -> case get_option(Options, access_model) of presence -> case lists:member(BJID, Owners) of true -> - node_action(Host, PType, unsubscribe_node, [NodeId, Entity, JID, all]); + node_action(Host, PType, unsubscribe_node, [Nidx, Entity, JID, all]); false -> {result, ok} end; @@ -807,13 +808,13 @@ remove_user(UserB, ServerB) -> lists:foreach(fun(PType) -> {result, Subscriptions} = node_action(Host, PType, get_entity_subscriptions, [Host, Entity]), lists:foreach(fun - ({#pubsub_node{id = NodeId}, _, _, JID}) -> node_action(Host, PType, unsubscribe_node, [NodeId, Entity, JID, all]) + ({#pubsub_node{idx = Nidx}, _, _, JID}) -> node_action(Host, PType, unsubscribe_node, [Nidx, Entity, JID, all]) end, Subscriptions), {result, Affiliations} = node_action(Host, PType, get_entity_affiliations, [Host, Entity]), lists:foreach(fun - ({#pubsub_node{nodeid = {H, N}, parents = []}, owner}) -> delete_node(H, N, Entity); - ({#pubsub_node{nodeid = {H, N}, type = "hometree"}, owner}) when N == HomeTreeBase -> delete_node(H, N, Entity); - ({#pubsub_node{id = NodeId}, publisher}) -> node_action(Host, PType, set_affiliation, [NodeId, Entity, none]); + ({#pubsub_node{id = {H, N}, parents = []}, owner}) -> delete_node(H, N, Entity); + ({#pubsub_node{id = {H, N}, type = "hometree"}, owner}) when N == HomeTreeBase -> delete_node(H, N, Entity); + ({#pubsub_node{idx = Nidx}, publisher}) -> node_action(Host, PType, set_affiliation, [Nidx, Entity, none]); (_) -> ok end, Affiliations) end, plugins(Host)) @@ -1079,7 +1080,7 @@ node_disco_info(Host, Node, From) -> node_disco_info(Host, Node, From, true, true). node_disco_info(Host, Node, From, Identity, Features) -> Action = - fun(#pubsub_node{type = Type, id = NodeId}) -> + fun(#pubsub_node{type = Type, idx = Nidx}) -> I = case Identity of false -> []; @@ -1089,7 +1090,7 @@ node_disco_info(Host, Node, From, Identity, Features) -> [] -> ["leaf"]; %% No sub-nodes: it's a leaf node _ -> - case node_call(Type, get_items, [NodeId, From]) of + case node_call(Type, get_items, [Nidx, From]) of {result, []} -> ["collection"]; {result, _} -> ["leaf", "collection"]; _ -> [] @@ -1150,7 +1151,7 @@ iq_disco_items(Host, [], From) -> case tree_action(Host, get_subnodes, [Host, <<>>, From]) of Nodes when is_list(Nodes) -> {result, lists:map( - fun(#pubsub_node{nodeid = {_, SubNode}, options = Options}) -> + fun(#pubsub_node{id = {_, SubNode}, options = Options}) -> Attrs = case get_option(Options, title) of false -> @@ -1177,17 +1178,17 @@ iq_disco_items(_Host, ?NS_PUBSUB_GET_PENDING, _From) -> {result, CommandItems}; iq_disco_items(Host, Item, From) -> case string:tokens(Item, "!") of - [_SNode, _ItemID] -> + [_SNode, _ItemId] -> {result, []}; [SNode] -> Node = string_to_node(SNode), - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> - NodeItems = case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> + NodeItems = case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, R} -> R; _ -> [] end, Nodes = lists:map( - fun(#pubsub_node{nodeid = {_, SubNode}, options = SubOptions}) -> + fun(#pubsub_node{id = {_, SubNode}, options = SubOptions}) -> Attrs = case get_option(SubOptions, title) of false -> @@ -1198,7 +1199,7 @@ iq_disco_items(Host, Item, From) -> #xmlel{ns = ?NS_DISCO_ITEMS, name = 'item', attrs = Attrs} end, tree_call(Host, get_subnodes, [Host, Node, From])), Items = lists:map( - fun(#pubsub_item{itemid = {RN, _}}) -> + fun(#pubsub_item{id = {RN, _}}) -> {result, Name} = node_call(Type, get_item_name, [Host, Node, RN]), #xmlel{ns = ?NS_DISCO_ITEMS, name = 'item', attrs = [?XMLATTR('jid', Host), ?XMLATTR('name', Name)]} end, NodeItems), @@ -1210,11 +1211,11 @@ iq_disco_items(Host, Item, From) -> end end. -get_allowed_items_call(Host, NodeIdx, From, Type, Options, Owners) -> +get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) -> AccessModel = get_option(Options, access_model), AllowedGroups = get_option(Options, roster_groups_allowed, []), {PresenceSubscription, RosterGroup} = get_presence_and_roster_permissions(Host, From, Owners, AccessModel, AllowedGroups), - node_call(Type, get_items, [NodeIdx, From, AccessModel, PresenceSubscription, RosterGroup, undefined]). + node_call(Type, get_items, [Nidx, From, AccessModel, PresenceSubscription, RosterGroup, undefined]). get_presence_and_roster_permissions(Host, From, Owners, AccessModel, AllowedGroups) -> if (AccessModel == presence) or (AccessModel == roster) -> @@ -1324,28 +1325,28 @@ iq_pubsub(Host, ServerHost, From, IQType, SubEl, Lang, Access, Plugins) -> {get, 'items'} -> MaxItems = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'max_items', ""), SubId = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), - ItemIDs = lists:foldl(fun + ItemIds = lists:foldl(fun (#xmlel{name = 'item', attrs = ItemAttrs}, Acc) -> case exmpp_xml:get_attribute_from_list_as_list(ItemAttrs, 'id', "") of "" -> Acc; - ItemID -> [ItemID|Acc] + ItemId -> [ItemId|Acc] end; (_, Acc) -> Acc end, [], exmpp_xml:remove_cdata_from_list(Els)), - get_items(Host, Node, From, SubId, MaxItems, ItemIDs); + get_items(Host, Node, From, SubId, MaxItems, ItemIds); {get, 'subscriptions'} -> get_subscriptions(Host, Node, From, Plugins); {get, 'affiliations'} -> get_affiliations(Host, From, Plugins); {get, 'options'} -> - SubID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), + SubId = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), JID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'jid', ""), - get_options(Host, Node, JID, SubID, Lang); + get_options(Host, Node, JID, SubId, Lang); {set, 'options'} -> - SubID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), + SubId = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), JID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'jid', ""), - set_options(Host, Node, JID, SubID, Els); + set_options(Host, Node, JID, SubId, Els); _ -> {error, 'feature-not-implemented'} end; @@ -1503,12 +1504,12 @@ send_pending_auth_events(Host, Node, Owner) -> ?DEBUG("Sending pending auth events for ~s on ~s:~s", [exmpp_jid:to_list(Owner), Host, node_to_string(Node)]), Action = - fun(#pubsub_node{id = NodeID, type = Type}) -> + fun(#pubsub_node{idx = Nidx, type = Type}) -> case lists:member("get-pending", features(Type)) of true -> - case node_call(Type, get_affiliation, [NodeID, Owner]) of + case node_call(Type, get_affiliation, [Nidx, Owner]) of {result, owner} -> - node_call(Type, get_node_subscriptions, [NodeID]); + node_call(Type, get_node_subscriptions, [Nidx]); _ -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'forbidden')} end; @@ -1518,7 +1519,7 @@ send_pending_auth_events(Host, Node, Owner) -> end, case transaction(Host, Node, Action, sync_dirty) of {result, {N, Subscriptions}} -> - lists:foreach(fun({J, pending, _SubID}) -> + lists:foreach(fun({J, pending, _SubId}) -> {U, S, R} = J, send_authorization_request(N, exmpp_jid:make(U,S,R)); ({J, pending}) -> @@ -1534,7 +1535,7 @@ send_pending_auth_events(Host, Node, Owner) -> %%% authorization handling -send_authorization_request(#pubsub_node{owners = Owners, nodeid = {Host, Node}}, Subscriber) -> +send_authorization_request(#pubsub_node{owners = Owners, id = {Host, Node}}, Subscriber) -> Lang = <<"en">>, %% TODO fix {U, S, R} = Subscriber, Stanza = #xmlel{ns = ?NS_JABBER_CLIENT, name = 'message', children = @@ -1623,14 +1624,14 @@ handle_authorization_response(Host, From, To, Packet, XFields) -> "true" -> true; _ -> false end, - Action = fun(#pubsub_node{type = Type, owners = Owners, id = NodeId}) -> + Action = fun(#pubsub_node{type = Type, owners = Owners, idx = Nidx}) -> IsApprover = lists:member(jlib:short_prepd_bare_jid(From), Owners), - {result, Subscriptions} = node_call(Type, get_subscriptions, [NodeId, Subscriber]), + {result, Subscriptions} = node_call(Type, get_subscriptions, [Nidx, Subscriber]), if not IsApprover -> {error, 'forbidden'}; true -> - update_auth(Host, SNode, Type, NodeId, + update_auth(Host, SNode, Type, Nidx, Subscriber, Allow, Subscriptions) end @@ -1650,19 +1651,19 @@ handle_authorization_response(Host, From, To, Packet, XFields) -> exmpp_stanza:reply_with_error(Packet, 'not-acceptable')) end. -update_auth(Host, Node, Type, NodeId, Subscriber, +update_auth(Host, Node, Type, Nidx, Subscriber, Allow, Subscriptions) -> Subscription = lists:filter(fun({pending, _}) -> true; (_) -> false end, Subscriptions), case Subscription of - [{pending, SubID}] -> %% TODO does not work if several pending + [{pending, SubId}] -> %% TODO does not work if several pending NewSubscription = case Allow of true -> subscribed; false -> none end, node_call(Type, set_subscriptions, - [NodeId, Subscriber, NewSubscription, SubID]), + [Nidx, Subscriber, NewSubscription, SubId]), send_authorization_approval(Host, Subscriber, Node, NewSubscription), {result, ok}; @@ -1734,8 +1735,8 @@ update_auth(Host, Node, Type, NodeId, Subscriber, %%<li>The service does not support node creation.</li> %%<li>Only entities that are registered with the service are allowed to create nodes but the requesting entity is not registered.</li> %%<li>The requesting entity does not have sufficient privileges to create nodes.</li> -%%<li>The requested NodeID already exists.</li> -%%<li>The request did not include a NodeID and "instant nodes" are not supported.</li> +%%<li>The requested NodeId already exists.</li> +%%<li>The request did not include a NodeId and "instant nodes" are not supported.</li> %%</ul> %%<p>ote: node creation is a particular case, error return code is evaluated at many places:</p> %%<ul> @@ -1861,8 +1862,8 @@ delete_node(_Host, <<>>, _Owner) -> %% Node is the root {error, 'not-allowed'}; delete_node(Host, Node, Owner) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - case node_call(Type, get_affiliation, [NodeId, Owner]) of + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + case node_call(Type, get_affiliation, [Nidx, Owner]) of {result, owner} -> ParentTree = tree_call(Host, get_parentnodes_tree, [Host, Node, service_jid(Host)]), SubsByDepth = [{Depth, [{N, get_node_subs(N)} || N <- Nodes]} || {Depth, Nodes} <- ParentTree], @@ -1880,12 +1881,12 @@ delete_node(Host, Node, Owner) -> case transaction(Host, Node, Action, transaction) of {result, {_, {SubsByDepth, {Result, broadcast, Removed}}}} -> lists:foreach(fun({RNode, _RSubscriptions}) -> - {RH, RN} = RNode#pubsub_node.nodeid, - NodeId = RNode#pubsub_node.id, + {RH, RN} = RNode#pubsub_node.id, + Nidx = RNode#pubsub_node.idx, Type = RNode#pubsub_node.type, Options = RNode#pubsub_node.options, - broadcast_removed_node(RH, RN, NodeId, Type, Options, SubsByDepth), - unset_cached_item(RH, NodeId) + broadcast_removed_node(RH, RN, Nidx, Type, Options, SubsByDepth), + unset_cached_item(RH, Nidx) end, Removed), case Result of default -> {result, Reply}; @@ -1937,7 +1938,7 @@ subscribe_node(Host, Node, From, JID, Configuration) -> _:_ -> {undefined, undefined, undefined} end, - Action = fun(#pubsub_node{options = Options, owners = Owners, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, owners = Owners, type = Type, idx = Nidx}) -> Features = features(Type), SubscribeFeature = lists:member("subscribe", Features), OptionsFeature = lists:member("subscription-options", Features), @@ -1962,7 +1963,7 @@ subscribe_node(Host, Node, From, JID, Configuration) -> {error, extended_error('bad-request', "invalid-options")}; true -> node_call(Type, subscribe_node, - [NodeId, From, Subscriber, + [Nidx, From, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, SubOpts]) @@ -1984,9 +1985,9 @@ subscribe_node(Host, Node, From, JID, Configuration) -> end, case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, subscribed, SubId, send_last}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, - send_items(Host, Node, NodeId, Type, Subscriber, last), + send_items(Host, Node, Nidx, Type, Subscriber, last), notify_owners(get_option(TNode#pubsub_node.options, notify_sub), Subscriber, Host, Node, TNode#pubsub_node.owners, "subscribed"), case Result of default -> {result, Reply({subscribed, SubId})}; @@ -2037,8 +2038,8 @@ unsubscribe_node(Host, Node, From, JID, SubId) when is_list(JID) -> end, unsubscribe_node(Host, Node, From, Subscriber, SubId); unsubscribe_node(Host, Node, From, Subscriber, SubId) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - node_call(Type, unsubscribe_node, [NodeId, From, Subscriber, SubId]) + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + node_call(Type, unsubscribe_node, [Nidx, From, Subscriber, SubId]) end, case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, default}} -> @@ -2069,7 +2070,7 @@ publish_item(Host, ServerHost, Node, Publisher, "", Payload) -> %% if publisher does not specify an ItemId, the service MUST generate the ItemId publish_item(Host, ServerHost, Node, Publisher, uniqid(), Payload); publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), PublishFeature = lists:member("publish", Features), PublishModel = get_option(Options, publish_model), @@ -2107,7 +2108,7 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> %% Publisher attempts to publish to persistent node with no item {error, extended_error('bad-request', "item-required")}; true -> - node_call(Type, publish_item, [NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload]) + node_call(Type, publish_item, [Nidx, Publisher, PublishModel, MaxItems, ItemId, Payload]) end end, ServerHostB = list_to_binary(ServerHost), @@ -2117,7 +2118,7 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> [#xmlel{ns = ?NS_PUBSUB, name = 'item', attrs = itemAttr(ItemId)}]}]}, case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, Broadcast, Removed}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, BroadcastPayload = case Broadcast of @@ -2125,25 +2126,25 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> broadcast -> Payload; PluginPayload -> PluginPayload end, - broadcast_publish_item(Host, Node, NodeId, Type, Options, Removed, ItemId, jlib:short_prepd_jid(Publisher), BroadcastPayload), - set_cached_item(Host, NodeId, ItemId, Publisher, Payload), + broadcast_publish_item(Host, Node, Nidx, Type, Options, Removed, ItemId, jlib:short_prepd_jid(Publisher), BroadcastPayload), + set_cached_item(Host, Nidx, ItemId, Publisher, Payload), case Result of default -> {result, Reply}; _ -> {result, Result} end; {result, {TNode, {default, Removed}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_retract_items(Host, Node, NodeId, Type, Options, Removed), - set_cached_item(Host, NodeId, ItemId, Publisher, Payload), + broadcast_retract_items(Host, Node, Nidx, Type, Options, Removed), + set_cached_item(Host, Nidx, ItemId, Publisher, Payload), {result, Reply}; {result, {TNode, {Result, Removed}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_retract_items(Host, Node, NodeId, Type, Options, Removed), - set_cached_item(Host, NodeId, ItemId, Publisher, Payload), + broadcast_retract_items(Host, Node, Nidx, Type, Options, Removed), + set_cached_item(Host, Nidx, ItemId, Publisher, Payload), {result, Result}; {result, {_, default}} -> {result, Reply}; @@ -2189,7 +2190,7 @@ delete_item(_, "", _, _, _) -> %% Request does not specify a node {error, extended_error('bad-request', "node-required")}; delete_item(Host, Node, Publisher, ItemId, ForceNotify) -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), PersistentFeature = lists:member("persistent-items", Features), DeleteFeature = lists:member("delete-items", Features), @@ -2205,18 +2206,18 @@ delete_item(Host, Node, Publisher, ItemId, ForceNotify) -> %% Service does not support item deletion {error, extended_error('feature-not-implemented', unsupported, "delete-items")}; true -> - node_call(Type, delete_item, [NodeId, Publisher, PublishModel, ItemId]) + node_call(Type, delete_item, [Nidx, Publisher, PublishModel, ItemId]) end end, Reply = [], case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, broadcast}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_retract_items(Host, Node, NodeId, Type, Options, [ItemId], ForceNotify), - case get_cached_item(Host, NodeId) of - #pubsub_item{itemid = {ItemId, NodeId}, _ = '_'} -> unset_cached_item(Host, NodeId); + broadcast_retract_items(Host, Node, Nidx, Type, Options, [ItemId], ForceNotify), + case get_cached_item(Host, Nidx) of + #pubsub_item{id = {ItemId, Nidx}} -> unset_cached_item(Host, Nidx); _ -> ok end, case Result of @@ -2246,7 +2247,7 @@ delete_item(Host, Node, Publisher, ItemId, ForceNotify) -> %%<li>The specified node does not exist.</li> %%</ul> purge_node(Host, Node, Owner) -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), PurgeFeature = lists:member("purge-nodes", Features), PersistentFeature = lists:member("persistent-items", Features), @@ -2262,17 +2263,17 @@ purge_node(Host, Node, Owner) -> %% Node is not configured for persistent items {error, extended_error('feature-not-implemented', unsupported, "persistent-items")}; true -> - node_call(Type, purge_node, [NodeId, Owner]) + node_call(Type, purge_node, [Nidx, Owner]) end end, Reply = [], case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, broadcast}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_purge_node(Host, Node, NodeId, Type, Options), - unset_cached_item(Host, NodeId), + broadcast_purge_node(Host, Node, Nidx, Type, Options), + unset_cached_item(Host, Nidx), case Result of default -> {result, Reply}; _ -> {result, Result} @@ -2290,7 +2291,7 @@ purge_node(Host, Node, Owner) -> %% <p>The permission are not checked in this function.</p> %% @todo We probably need to check that the user doing the query has the right %% to read the items. -get_items(Host, Node, From, SubId, SMaxItems, ItemIDs) -> +get_items(Host, Node, From, SubId, SMaxItems, ItemIds) -> MaxItems = if SMaxItems == "" -> get_max_items_node(Host); @@ -2304,7 +2305,7 @@ get_items(Host, Node, From, SubId, SMaxItems, ItemIDs) -> {error, Error} -> {error, Error}; _ -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId, owners = Owners}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx, owners = Owners}) -> Features = features(Type), RetreiveFeature = lists:member("retrieve-items", Features), PersistentFeature = lists:member("persistent-items", Features), @@ -2320,19 +2321,19 @@ get_items(Host, Node, From, SubId, SMaxItems, ItemIDs) -> {error, extended_error('feature-not-implemented', unsupported, "persistent-items")}; true -> node_call(Type, get_items, - [NodeId, From, + [Nidx, From, AccessModel, PresenceSubscription, RosterGroup, SubId]) end end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Items}} -> - SendItems = case ItemIDs of + SendItems = case ItemIds of [] -> Items; _ -> - lists:filter(fun(#pubsub_item{itemid = {ItemId, _}}) -> - lists:member(ItemId, ItemIDs) + lists:filter(fun(#pubsub_item{id = {ItemId, _}}) -> + lists:member(ItemId, ItemIds) end, Items) end, %% Generate the XML response (Item list), limiting the @@ -2344,17 +2345,19 @@ get_items(Host, Node, From, SubId, SMaxItems, ItemIDs) -> Error end end. + get_items(Host, Node) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - node_call(Type, get_items, [NodeId, service_jid(Host)]) + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + node_call(Type, get_items, [Nidx, service_jid(Host)]) end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Items}} -> Items; Error -> Error end. + get_item(Host, Node, ItemId) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - node_call(Type, get_item, [NodeId, ItemId]) + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + node_call(Type, get_item, [Nidx, ItemId]) end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Items}} -> Items; @@ -2431,7 +2434,7 @@ get_affiliations(Host, JID, Plugins) when is_list(Plugins) -> {ok, Affiliations} -> Entities = lists:flatmap( fun({_, none}) -> []; - ({#pubsub_node{nodeid = {_, Node}}, Affiliation}) -> + ({#pubsub_node{id = {_, Node}}, Affiliation}) -> [#xmlel{ns = ?NS_PUBSUB, name = 'affiliation', attrs = [?XMLATTR('node', node_to_string(Node)), ?XMLATTR('affiliation', affiliation_to_string(Affiliation))]}] @@ -2443,10 +2446,10 @@ get_affiliations(Host, JID, Plugins) when is_list(Plugins) -> Error end; get_affiliations(Host, Node, JID) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> Features = features(Type), RetrieveFeature = lists:member("modify-affiliations", Features), - {result, Affiliation} = node_call(Type, get_affiliation, [NodeId, JID]), + {result, Affiliation} = node_call(Type, get_affiliation, [Nidx, JID]), if not RetrieveFeature -> %% Service does not support modify affiliations @@ -2455,7 +2458,7 @@ get_affiliations(Host, Node, JID) -> %% Entity is not an owner {error, 'forbidden'}; true -> - node_call(Type, get_node_affiliations, [NodeId]) + node_call(Type, get_node_affiliations, [Nidx]) end end, case transaction(Host, Node, Action, sync_dirty) of @@ -2507,7 +2510,7 @@ set_affiliations(Host, Node, From, EntitiesEls) -> error -> {error, 'bad-request'}; _ -> - Action = fun(#pubsub_node{owners = Owners, type = Type, id = NodeId}=N) -> + Action = fun(#pubsub_node{owners = Owners, type = Type, idx = Nidx}=N) -> case lists:member(Owner, Owners) of true -> OwnerJID = exmpp_jid:make(Owner), @@ -2517,7 +2520,7 @@ set_affiliations(Host, Node, From, EntitiesEls) -> end, lists:foreach( fun({JID, Affiliation}) -> - {result, _} = node_call(Type, set_affiliation, [NodeId, JID, Affiliation]), + {result, _} = node_call(Type, set_affiliation, [Nidx, JID, Affiliation]), case Affiliation of owner -> NewOwner = jlib:short_prepd_bare_jid(JID), @@ -2547,11 +2550,11 @@ set_affiliations(Host, Node, From, EntitiesEls) -> end end. -get_options(Host, Node, JID, SubID, Lang) -> - Action = fun(#pubsub_node{type = Type, id = NodeID}) -> +get_options(Host, Node, JID, SubId, Lang) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> case lists:member("subscription-options", features(Type)) of true -> - get_options_helper(JID, Lang, Node, NodeID, SubID, Type); + get_options_helper(JID, Lang, Node, Nidx, SubId, Type); false -> {error, extended_error( 'feature-not-implemented', @@ -2563,7 +2566,7 @@ get_options(Host, Node, JID, SubID, Lang) -> Error -> Error end. -get_options_helper(JID, Lang, Node, NodeID, SubID, Type) -> +get_options_helper(JID, Lang, Node, NodeId, SubId, Type) -> Subscriber = try exmpp_jid:parse(JID) of J -> jlib:short_jid(J) catch @@ -2571,43 +2574,43 @@ get_options_helper(JID, Lang, Node, NodeID, SubID, Type) -> exmpp_jid:make("", "", "") %% TODO, check if use <<>> instead of "" end, {result, Subs} = node_call(Type, get_subscriptions, - [NodeID, Subscriber]), - SubIDs = lists:foldl(fun({subscribed, SID}, Acc) -> + [NodeId, Subscriber]), + SubIds = lists:foldl(fun({subscribed, SID}, Acc) -> [SID | Acc]; (_, Acc) -> Acc end, [], Subs), - case {SubID, SubIDs} of + case {SubId, SubIds} of {_, []} -> {error, extended_error('not-acceptable', "not-subscribed")}; {[], [SID]} -> - read_sub(Subscriber, Node, NodeID, SID, Lang); + read_sub(Subscriber, Node, NodeId, SID, Lang); {[], _} -> {error, extended_error('not-acceptable', "subid-required")}; {_, _} -> - read_sub(Subscriber, Node, NodeID, SubID, Lang) + read_sub(Subscriber, Node, NodeId, SubId, Lang) end. -read_sub(Subscriber, Node, NodeID, SubID, Lang) -> - case pubsub_subscription:get_subscription(Subscriber, NodeID, SubID) of +read_sub(Subscriber, Node, NodeId, SubId, Lang) -> + case pubsub_subscription:get_subscription(Subscriber, NodeId, SubId) of {error, notfound} -> {error, extended_error('not-acceptable', "invalid-subid")}; {result, #pubsub_subscription{options = Options}} -> {result, XdataEl} = pubsub_subscription:get_options_xform(Lang, Options), OptionsEl = #xmlel{ns = ?NS_PUBSUB, name = 'options', attrs = [ ?XMLATTR('jid', exmpp_jid:to_binary(Subscriber)), - ?XMLATTR('subid', SubID) | nodeAttr(Node)], + ?XMLATTR('subid', SubId) | nodeAttr(Node)], children = [XdataEl]}, PubsubEl = #xmlel{ns = ?NS_PUBSUB, name = 'pubsub', children = [OptionsEl]}, {result, PubsubEl} end. -set_options(Host, Node, JID, SubID, Configuration) -> - Action = fun(#pubsub_node{type = Type, id = NodeID}) -> +set_options(Host, Node, JID, SubId, Configuration) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> case lists:member("subscription-options", features(Type)) of true -> - set_options_helper(Configuration, JID, NodeID, - SubID, Type); + set_options_helper(Configuration, JID, Nidx, + SubId, Type); false -> {error, extended_error( 'feature-not-implemented', @@ -2619,7 +2622,7 @@ set_options(Host, Node, JID, SubID, Configuration) -> Error -> Error end. -set_options_helper(Configuration, JID, NodeID, SubID, Type) -> +set_options_helper(Configuration, JID, NodeId, SubId, Type) -> SubOpts = case pubsub_subscription:parse_options_xform(Configuration) of {result, GoodSubOpts} -> GoodSubOpts; _ -> invalid @@ -2630,27 +2633,27 @@ set_options_helper(Configuration, JID, NodeID, SubID, Type) -> _ -> exmpp_jid:make("", "", "") %% TODO, check if use <<>> instead of "" end, {result, Subs} = node_call(Type, get_subscriptions, - [NodeID, Subscriber]), - SubIDs = lists:foldl(fun({subscribed, SID}, Acc) -> + [NodeId, Subscriber]), + SubIds = lists:foldl(fun({subscribed, SID}, Acc) -> [SID | Acc]; (_, Acc) -> Acc end, [], Subs), - case {SubID, SubIDs} of + case {SubId, SubIds} of {_, []} -> {error, extended_error('not-acceptable', "not-subscribed")}; {[], [SID]} -> - write_sub(Subscriber, NodeID, SID, SubOpts); + write_sub(Subscriber, NodeId, SID, SubOpts); {[], _} -> {error, extended_error('not-acceptable', "subid-required")}; {_, _} -> - write_sub(Subscriber, NodeID, SubID, SubOpts) + write_sub(Subscriber, NodeId, SubId, SubOpts) end. -write_sub(_Subscriber, _NodeID, _SubID, invalid) -> +write_sub(_Subscriber, _NodeId, _SubId, invalid) -> {error, extended_error('bad-request', "invalid-options")}; -write_sub(Subscriber, NodeID, SubID, Options) -> - case pubsub_subscription:set_subscription(Subscriber, NodeID, SubID, Options) of +write_sub(Subscriber, NodeId, SubId, Options) -> + case pubsub_subscription:set_subscription(Subscriber, NodeId, SubId, Options) of {error, notfound} -> {error, extended_error('not-acceptable', "invalid-subid")}; {result, _} -> @@ -2685,7 +2688,7 @@ get_subscriptions(Host, Node, JID, Plugins) when is_list(Plugins) -> Entities = lists:flatmap( fun({_, none}) -> []; - ({#pubsub_node{nodeid = {_, SubsNode}}, Subscription}) -> + ({#pubsub_node{id = {_, SubsNode}}, Subscription}) -> case Node of <<>> -> [#xmlel{ns = ?NS_PUBSUB, name = 'subscription', attrs = @@ -2699,22 +2702,22 @@ get_subscriptions(Host, Node, JID, Plugins) when is_list(Plugins) -> end; ({_, none, _}) -> []; - ({#pubsub_node{nodeid = {_, SubsNode}}, Subscription, SubID, SubJID}) -> + ({#pubsub_node{id = {_, SubsNode}}, Subscription, SubId, SubJID}) -> case Node of <<>> -> [#xmlel{ns = ?NS_PUBSUB, name='subscription', attrs = [?XMLATTR('jid', exmpp_jid:to_binary(SubJID)), - ?XMLATTR('subid', SubID), + ?XMLATTR('subid', SubId), ?XMLATTR('subscription', subscription_to_string(Subscription)) | nodeAttr(SubsNode)]}]; SubsNode -> [#xmlel{ns = ?NS_PUBSUB, name = 'subscription', attrs = [?XMLATTR('jid', exmpp_jid:to_binary(SubJID)), - ?XMLATTR('subid', SubID), + ?XMLATTR('subid', SubId), ?XMLATTR('subscription', subscription_to_string(Subscription))]}]; _ -> [] end; - ({#pubsub_node{nodeid = {_, SubsNode}}, Subscription, SubJID}) -> + ({#pubsub_node{id = {_, SubsNode}}, Subscription, SubJID}) -> case Node of <<>> -> [#xmlel{ns = ?NS_PUBSUB, name = 'subscription', attrs = @@ -2736,10 +2739,10 @@ get_subscriptions(Host, Node, JID, Plugins) when is_list(Plugins) -> Error end. get_subscriptions(Host, Node, JID) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> Features = features(Type), RetrieveFeature = lists:member("manage-subscriptions", Features), - {result, Affiliation} = node_call(Type, get_affiliation, [NodeId, JID]), + {result, Affiliation} = node_call(Type, get_affiliation, [Nidx, JID]), if not RetrieveFeature -> %% Service does not support manage subscriptions @@ -2748,7 +2751,7 @@ get_subscriptions(Host, Node, JID) -> %% Entity is not an owner {error, 'forbidden'}; true -> - node_call(Type, get_node_subscriptions, [NodeId]) + node_call(Type, get_node_subscriptions, [Nidx]) end end, case transaction(Host, Node, Action, sync_dirty) of @@ -2824,12 +2827,12 @@ set_subscriptions(Host, Node, From, EntitiesEls) -> ?XMLATTR('subsription', subscription_to_string(Sub)) | nodeAttr(Node)]}]}]}, ejabberd_router:route(service_jid(Host), JID, Stanza) end, - Action = fun(#pubsub_node{owners = Owners, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{owners = Owners, type = Type, idx = Nidx}) -> case lists:member(Owner, Owners) of true -> Result = lists:foldl(fun({JID, Subscription, SubId}, Acc) -> - case node_call(Type, set_subscriptions, [NodeId, JID, Subscription, SubId]) of + case node_call(Type, set_subscriptions, [Nidx, JID, Subscription, SubId]) of {error, Err} -> [{error, Err} | Acc]; _ -> Notify(JID, Subscription, SubId), Acc end @@ -3179,18 +3182,17 @@ get_collection_subscriptions(Host, Node) -> _ -> [] end. -get_node_subs(#pubsub_node{type = Type, - id = NodeID}) -> - case node_call(Type, get_node_subscriptions, [NodeID]) of - {result, Subs} -> get_options_for_subs(NodeID, Subs); +get_node_subs(#pubsub_node{type = Type, idx = Nidx}) -> + case node_call(Type, get_node_subscriptions, [Nidx]) of + {result, Subs} -> get_options_for_subs(Nidx, Subs); Other -> Other end. -get_options_for_subs(NodeID, Subs) -> - lists:foldl(fun({JID, subscribed, SubID}, Acc) -> - case pubsub_subscription:read_subscription(JID, NodeID, SubID) of - {error, notfound} -> [{JID, SubID, []} | Acc]; - #pubsub_subscription{options = Options} -> [{JID, SubID, Options} | Acc]; +get_options_for_subs(Nidx, Subs) -> + lists:foldl(fun({JID, subscribed, SubId}, Acc) -> + case pubsub_subscription:read_subscription(JID, Nidx, SubId) of + {error, notfound} -> [{JID, SubId, []} | Acc]; + #pubsub_subscription{options = Options} -> [{JID, SubId, Options} | Acc]; _ -> Acc end; (_, Acc) -> @@ -3224,8 +3226,8 @@ broadcast_stanza(Host, _Node, _NodeId, _Type, NodeOptions, SubsByDepth, NotifyTy MsgType -> add_message_type(BaseStanza, atom_to_list(MsgType)) end, %% Handles explicit subscriptions - SubIDsByJID = subscribed_nodes_by_jid(NotifyType, SubsByDepth), - lists:foreach(fun ({LJID, NodeName, SubIDs}) -> + SubIdsByJID = subscribed_nodes_by_jid(NotifyType, SubsByDepth), + lists:foreach(fun ({LJID, NodeName, SubIds}) -> LJIDs = case BroadcastAll of true -> {U, S, _} = LJID, @@ -3233,19 +3235,19 @@ broadcast_stanza(Host, _Node, _NodeId, _Type, NodeOptions, SubsByDepth, NotifyTy false -> [LJID] end, - %% Determine if the stanza should have SHIM ('SubID' and 'name') headers - StanzaToSend = case {SHIM, SubIDs} of + %% Determine if the stanza should have SHIM ('SubId' and 'name') headers + StanzaToSend = case {SHIM, SubIds} of {false, _} -> Stanza; {true, [_]} -> add_shim_headers(Stanza, collection_shim(NodeName)); - {true, SubIDs} -> - add_shim_headers(Stanza, lists:append(collection_shim(NodeName), subid_shim(SubIDs))) + {true, SubIds} -> + add_shim_headers(Stanza, lists:append(collection_shim(NodeName), subid_shim(SubIds))) end, lists:foreach(fun(To) -> ejabberd_router:route(From, exmpp_jid:make(To), StanzaToSend) end, LJIDs) - end, SubIDsByJID). + end, SubIdsByJID). broadcast_stanza({LUser, LServer, LResource}, Publisher, Node, NodeId, Type, NodeOptions, SubsByDepth, NotifyType, BaseStanza, SHIM) -> broadcast_stanza({LUser, LServer, LResource}, Node, NodeId, Type, NodeOptions, SubsByDepth, NotifyType, BaseStanza, SHIM), @@ -3296,12 +3298,12 @@ broadcast_stanza(Host, _Publisher, Node, NodeId, Type, NodeOptions, SubsByDepth, subscribed_nodes_by_jid(NotifyType, SubsByDepth) -> NodesToDeliver = fun(Depth, Node, Subs, Acc) -> - NodeName = case Node#pubsub_node.nodeid of + NodeName = case Node#pubsub_node.id of {_, N} -> N; Other -> Other end, NodeOptions = Node#pubsub_node.options, - lists:foldl(fun({LJID, SubID, SubOptions}, {JIDs, Recipients}) -> + lists:foldl(fun({LJID, SubId, SubOptions}, {JIDs, Recipients}) -> case is_to_deliver(LJID, NotifyType, Depth, NodeOptions, SubOptions) of true -> %% If is to deliver : @@ -3311,26 +3313,26 @@ subscribed_nodes_by_jid(NotifyType, SubsByDepth) -> lists:foldl( fun(JIDToDeliver, {JIDsAcc, RecipientsAcc}) -> case lists:member(JIDToDeliver, JIDs) of - %% check if the JIDs co-accumulator contains the Subscription Jid, + %% check if the JIDs co-accumulator contains the Subscription JID, false -> %% - if not, - %% - add the Jid to JIDs list co-accumulator ; - %% - create a tuple of the Jid, NodeId, and SubID (as list), + %% - add the JID to JIDs list co-accumulator ; + %% - create a tuple of the JID, NodeId, and SubId (as list), %% and add the tuple to the Recipients list co-accumulator - {[JIDToDeliver | JIDsAcc], [{JIDToDeliver, NodeName, [SubID]} | RecipientsAcc]}; + {[JIDToDeliver | JIDsAcc], [{JIDToDeliver, NodeName, [SubId]} | RecipientsAcc]}; true -> - %% - if the JIDs co-accumulator contains the Jid - %% get the tuple containing the Jid from the Recipient list co-accumulator - {_, {JIDToDeliver, NodeName1, SubIDs}} = lists:keysearch(JIDToDeliver, 1, RecipientsAcc), + %% - if the JIDs co-accumulator contains the JID + %% get the tuple containing the JID from the Recipient list co-accumulator + {_, {JIDToDeliver, NodeName1, SubIds}} = lists:keysearch(JIDToDeliver, 1, RecipientsAcc), %% delete the tuple from the Recipients list % v1 : Recipients1 = lists:keydelete(LJID, 1, Recipients), - % v2 : Recipients1 = lists:keyreplace(LJID, 1, Recipients, {LJID, NodeId1, [SubID | SubIDs]}), - %% add the SubID to the SubIDs list in the tuple, + % v2 : Recipients1 = lists:keyreplace(LJID, 1, Recipients, {LJID, NodeId1, [SubId | SubIds]}), + %% add the SubId to the SubIds list in the tuple, %% and add the tuple back to the Recipients list co-accumulator - % v1.1 : {JIDs, lists:append(Recipients1, [{LJID, NodeId1, lists:append(SubIDs, [SubID])}])} - % v1.2 : {JIDs, [{LJID, NodeId1, [SubID | SubIDs]} | Recipients1]} + % v1.1 : {JIDs, lists:append(Recipients1, [{LJID, NodeId1, lists:append(SubIds, [SubId])}])} + % v1.2 : {JIDs, [{LJID, NodeId1, [SubId | SubIds]} | Recipients1]} % v2: {JIDs, Recipients1} - {JIDsAcc, lists:keyreplace(JIDToDeliver, 1, RecipientsAcc, {JIDToDeliver, NodeName1, [SubID | SubIDs]})} + {JIDsAcc, lists:keyreplace(JIDToDeliver, 1, RecipientsAcc, {JIDToDeliver, NodeName1, [SubId | SubIds]})} end end, {JIDs, Recipients}, JIDsToDeliver) end; @@ -3360,8 +3362,8 @@ user_resources(User, Server) -> get_configure(Host, ServerHost, Node, From, Lang) -> ServerHostB = list_to_binary(ServerHost), Action = - fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> - case node_call(Type, get_affiliation, [NodeId, From]) of + fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> + case node_call(Type, get_affiliation, [Nidx, From]) of {result, owner} -> Groups = ejabberd_hooks:run_fold(roster_groups, ServerHostB, [], [ServerHostB]), {result, @@ -3518,8 +3520,8 @@ set_configure(Host, Node, From, Els, Lang) -> {result, []}; "submit" -> Action = - fun(#pubsub_node{options = Options, type = Type, id = NodeId} = N) -> - case node_call(Type, get_affiliation, [NodeId, From]) of + fun(#pubsub_node{options = Options, type = Type, idx = Nidx} = N) -> + case node_call(Type, get_affiliation, [Nidx, From]) of {result, owner} -> case jlib:parse_xdata_submit(XEl) of invalid -> @@ -3545,10 +3547,10 @@ set_configure(Host, Node, From, Els, Lang) -> end, case transaction(Host, Node, Action, transaction) of {result, {TNode, ok}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_config_notification(Host, Node, NodeId, Type, Options, Lang), + broadcast_config_notification(Host, Node, Nidx, Type, Options, Lang), {result, []}; Other -> Other @@ -3695,7 +3697,7 @@ get_cached_item(Host, NodeId) -> true -> case mnesia:dirty_read({pubsub_last_item, NodeId}) of [{pubsub_last_item, NodeId, ItemId, Creation, Payload}] -> - #pubsub_item{itemid = {ItemId, NodeId}, payload = Payload, + #pubsub_item{id = {ItemId, NodeId}, payload = Payload, creation = Creation, modification = Creation}; _ -> undefined @@ -3906,7 +3908,7 @@ itemAttr(ItemId) -> [?XMLATTR('id', ItemId)]. % build item elements from item list itemsEls(Items) -> - lists:map(fun(#pubsub_item{itemid = {ItemId, _}, payload = Payload}) -> + lists:map(fun(#pubsub_item{id = {ItemId, _}, payload = Payload}) -> #xmlel{ns = ?NS_PUBSUB, name = 'item', attrs = itemAttr(ItemId), children = Payload} end, Items). @@ -3946,17 +3948,17 @@ collection_shim(Node) -> attrs = [?XMLATTR('name', <<"Collection">>)], children = [?XMLCDATA(node_to_string(Node))]}]. -subid_shim(SubIDs) -> +subid_shim(SubIds) -> [#xmlel{ns = ?NS_PUBSUB, name ='header', - attrs = [?XMLATTR('name', <<"SubID">>)], - children = [?XMLCDATA(SubID)]} - || SubID <- SubIDs]. + attrs = [?XMLATTR('name', <<"SubId">>)], + children = [?XMLCDATA(SubId)]} + || SubId <- SubIds]. -extended_headers(Jids) -> +extended_headers(JIDs) -> [#xmlel{ns = ?NS_ADDRESS, name = 'address', - attrs = [?XMLATTR('type', <<"replyto">>), ?XMLATTR('jid', Jid)]} - || Jid <- Jids]. + attrs = [?XMLATTR('type', <<"replyto">>), ?XMLATTR('jid', JID)]} + || JID <- JIDs]. feature_check_packet(allow, _User, Server, Pres, {From, _To, El}, in) -> Host = list_to_binary(host(Server)), @@ -4012,10 +4014,10 @@ purge_offline({User, Server, _} = LJID) -> case Result of {ok, Affiliations} -> lists:foreach( - fun({#pubsub_node{nodeid = {_, NodeId}, options = Options, type = Type}, Affiliation}) + fun({#pubsub_node{id = {_, NodeId}, options = Options, type = Type}, Affiliation}) when Affiliation == 'owner' orelse Affiliation == 'publisher' -> - Action = fun(#pubsub_node{type = NType, id = NodeIdx}) -> - node_call(NType, get_items, [NodeIdx, service_jid(Host)]) + Action = fun(#pubsub_node{type = NType, idx = Nidx}) -> + node_call(NType, get_items, [Nidx, service_jid(Host)]) end, case transaction(Host, NodeId, Action, sync_dirty) of {result, {_, []}} -> @@ -4031,7 +4033,7 @@ purge_offline({User, Server, _} = LJID) -> {true, true, true, true} -> ForceNotify = get_option(Options, notify_retract), lists:foreach( - fun(#pubsub_item{itemid = {ItemId, _}, modification = {_, Modification}}) -> + fun(#pubsub_item{id = {ItemId, _}, modification = {_, Modification}}) -> case Modification of {User, Server, _} -> delete_item(Host, NodeId, LJID, ItemId, ForceNotify); diff --git a/src/mod_pubsub/mod_pubsub_odbc.erl b/src/mod_pubsub/mod_pubsub_odbc.erl index e49971c03..f8b72155f 100644 --- a/src/mod_pubsub/mod_pubsub_odbc.erl +++ b/src/mod_pubsub/mod_pubsub_odbc.erl @@ -49,8 +49,6 @@ -behaviour(gen_server). -behaviour(gen_mod). --include_lib("exmpp/include/exmpp.hrl"). - -include("ejabberd.hrl"). -include("adhoc.hrl"). -include("pubsub.hrl"). @@ -281,13 +279,11 @@ init_nodes(Host, ServerHost, _NodeTree, Plugins) -> case lists:member("hometree_odbc", Plugins) of true -> create_node(Host, ServerHost, string_to_node("/home"), service_jid(Host), "hometree_odbc"), - create_node(Host, ServerHost, string_to_node("/home/" ++ ServerHost), service_jid(Host), "hometree_odbc"); + create_node(Host, ServerHost, string_to_node("/home/" ++ ServerHost), service_jid(Host), "hometree_odbc"); false -> ok end. - - send_loop(State) -> receive {presence, JID, Pid} -> @@ -305,10 +301,10 @@ send_loop(State) -> lists:foreach( fun({Node, subscribed, _, SubJID}) -> if (SubJID == LJID) or (SubJID == BJID) -> - #pubsub_node{nodeid = {H, N}, type = Type, id = NodeId, options = Options} = Node, + #pubsub_node{id = {H, N}, type = Type, idx = Nidx, options = Options} = Node, case get_option(Options, send_last_published_item) of on_sub_and_presence -> - send_items(H, N, NodeId, Type, LJID, last); + send_items(H, N, Nidx, Type, LJID, last); _ -> ok end; @@ -358,7 +354,7 @@ send_loop(State) -> spawn(fun() -> Host = State#state.host, Owner = jlib:short_prepd_bare_jid(JID), - lists:foreach(fun(#pubsub_node{nodeid = {_, Node}, type = Type, id = NodeId, options = Options}) -> + lists:foreach(fun(#pubsub_node{id = {_, Node}, type = Type, idx = Nidx, options = Options}) -> case get_option(Options, send_last_published_item) of on_sub_and_presence -> lists:foreach(fun(Resource) -> @@ -373,7 +369,7 @@ send_loop(State) -> {OU, OS, _} = Owner, element(2, get_roster_info(OU, OS, LJID, Grps)) end, - if Subscribed -> send_items(Owner, Node, NodeId, Type, LJID, last); + if Subscribed -> send_items(Owner, Node, Nidx, Type, LJID, last); true -> ok end end, Resources); @@ -426,9 +422,9 @@ disco_identity(_Host, <<>>, _From) -> [#xmlel{name = 'identity', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('category', <<"pubsub">>), ?XMLATTR('type', <<"pep">>)]}]; disco_identity(Host, Node, From) -> - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> - Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> + Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> {result, [#xmlel{name = 'identity', ns = ?NS_DISCO_INFO, @@ -458,9 +454,9 @@ disco_features(_Host, <<>>, _From) -> [?NS_PUBSUB_s | [?NS_PUBSUB_s++"#"++Feature || Feature <- features("pep")]]; disco_features(Host, Node, From) -> - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> - Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> + Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> {result, [?NS_PUBSUB_s | [?NS_PUBSUB_s ++ "#" ++ Feature || Feature <- features("pep")]]}; @@ -478,13 +474,13 @@ disco_sm_items({result, OtherItems}, From, To, Node, _Lang) -> {result, disco_items(To, Node, From) ++ OtherItems}. disco_items(Host, <<>>, From) -> - Action = fun(#pubsub_node{nodeid ={_, NodeID}, options = Options, type = Type, id = Idx}, Acc) -> - Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{id ={_, NodeId}, options = Options, type = Type, idx = Nidx}, Acc) -> + Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> [#xmlel{name = 'item', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('jid', exmpp_jid:to_binary(Host)), - ?XMLATTR('node', NodeID) | + ?XMLATTR('node', NodeId) | case get_option(Options, title) of false -> []; [Title] -> [?XMLATTR('title', Title)] @@ -499,15 +495,15 @@ disco_items(Host, <<>>, From) -> end; disco_items(Host, Node, From) -> - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> - Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> + Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, Items} -> {result, [#xmlel{name = 'item', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('jid', exmpp_jid:to_binary(Host)), - ?XMLATTR('name', ItemID)]} - || #pubsub_item{itemid = {ItemID,_}} <- Items]}; + ?XMLATTR('name', ItemId)]} + || #pubsub_item{id = {ItemId,_}} <- Items]}; _ -> {result, []} end end, @@ -537,6 +533,7 @@ presence_probe(Peer, JID, Pid) -> presence(Host, {presence, User, Server, [Resource], JID}) end end. + presence(ServerHost, Presence) when is_binary(ServerHost) -> presence(binary_to_list(ServerHost), Presence); presence(ServerHost, Presence) -> @@ -585,12 +582,12 @@ unsubscribe_user(Entity, Owner) -> lists:foreach(fun(PType) -> {result, Subscriptions} = node_action(Host, PType, get_entity_subscriptions, [Host, Entity]), lists:foreach(fun - ({#pubsub_node{options = Options, id = NodeId}, subscribed, _, JID}) -> + ({#pubsub_node{options = Options, idx = Nidx}, subscribed, _, JID}) -> case get_option(Options, access_model) of presence -> - case lists:member(BJID, node_owners(Host, PType, NodeId)) of + case lists:member(BJID, node_owners(Host, PType, Nidx)) of true -> - node_action(Host, PType, unsubscribe_node, [NodeId, Entity, JID, all]); + node_action(Host, PType, unsubscribe_node, [Nidx, Entity, JID, all]); false -> {result, ok} end; @@ -621,13 +618,13 @@ remove_user(UserB, ServerB) -> lists:foreach(fun(PType) -> {result, Subscriptions} = node_action(Host, PType, get_entity_subscriptions, [Host, Entity]), lists:foreach(fun - ({#pubsub_node{id = NodeId}, _, _, JID}) -> node_action(Host, PType, unsubscribe_node, [NodeId, Entity, JID, all]) + ({#pubsub_node{idx = Nidx}, _, _, JID}) -> node_action(Host, PType, unsubscribe_node, [Nidx, Entity, JID, all]) end, Subscriptions), {result, Affiliations} = node_action(Host, PType, get_entity_affiliations, [Host, Entity]), lists:foreach(fun - ({#pubsub_node{nodeid = {H, N}, parents = []}, owner}) -> delete_node(H, N, Entity); - ({#pubsub_node{nodeid = {H, N}, type = "hometree"}, owner}) when N == HomeTreeBase -> delete_node(H, N, Entity); - ({#pubsub_node{id = NodeId}, publisher}) -> node_action(Host, PType, set_affiliation, [NodeId, Entity, none]); + ({#pubsub_node{id = {H, N}, parents = []}, owner}) -> delete_node(H, N, Entity); + ({#pubsub_node{id = {H, N}, type = "hometree"}, owner}) when N == HomeTreeBase -> delete_node(H, N, Entity); + ({#pubsub_node{idx = Nidx}, publisher}) -> node_action(Host, PType, set_affiliation, [Nidx, Entity, none]); (_) -> ok end, Affiliations) end, plugins(Host)) @@ -894,7 +891,7 @@ node_disco_info(Host, Node, From) -> node_disco_info(Host, Node, From, true, true). node_disco_info(Host, Node, From, Identity, Features) -> Action = - fun(#pubsub_node{type = Type, id = NodeId}) -> + fun(#pubsub_node{type = Type, idx = Nidx}) -> I = case Identity of false -> []; @@ -904,7 +901,7 @@ node_disco_info(Host, Node, From, Identity, Features) -> [] -> ["leaf"]; %% No sub-nodes: it's a leaf node _ -> - case node_call(Type, get_items, [NodeId, From, none]) of + case node_call(Type, get_items, [Nidx, From, none]) of {result, []} -> ["collection"]; {result, _} -> ["leaf", "collection"]; _ -> [] @@ -967,7 +964,7 @@ iq_disco_items(Host, [], From, _RSM) -> case tree_action(Host, get_subnodes, [Host, <<>>, From]) of Nodes when is_list(Nodes) -> {result, lists:map( - fun(#pubsub_node{nodeid = {_, SubNode}, options = Options}) -> + fun(#pubsub_node{id = {_, SubNode}, options = Options}) -> Attrs = case get_option(Options, title) of false -> @@ -994,18 +991,18 @@ iq_disco_items(_Host, ?NS_PUBSUB_GET_PENDING, _From, _RSM) -> {result, CommandItems}; iq_disco_items(Host, Item, From, RSM) -> case string:tokens(Item, "!") of - [_SNode, _ItemID] -> + [_SNode, _ItemId] -> {result, []}; [SNode] -> Node = string_to_node(SNode), - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> - Owners = node_owners_call(Type, Idx), - {NodeItems, RsmOut} = case get_allowed_items_call(Host, Idx, From, Type, Options, Owners, RSM) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> + Owners = node_owners_call(Type, Nidx), + {NodeItems, RsmOut} = case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners, RSM) of {result, R} -> R; _ -> {[], none} end, Nodes = lists:map( - fun(#pubsub_node{nodeid = {_, SubNode}, options = SubOptions}) -> + fun(#pubsub_node{id = {_, SubNode}, options = SubOptions}) -> Attrs = case get_option(SubOptions, title) of false -> @@ -1016,7 +1013,7 @@ iq_disco_items(Host, Item, From, RSM) -> #xmlel{ns = ?NS_DISCO_ITEMS, name = 'item', attrs = Attrs} end, tree_call(Host, get_subnodes, [Host, Node, From])), Items = lists:map( - fun(#pubsub_item{itemid = {RN, _}}) -> + fun(#pubsub_item{id = {RN, _}}) -> {result, Name} = node_call(Type, get_item_name, [Host, Node, RN]), #xmlel{ns = ?NS_DISCO_ITEMS, name = 'item', attrs = [?XMLATTR('jid', Host), ?XMLATTR('name', Name)]} end, NodeItems), @@ -1136,29 +1133,28 @@ iq_pubsub(Host, ServerHost, From, IQType, SubEl, Lang, Access, Plugins) -> {get, 'items'} -> MaxItems = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'max_items', ""), SubId = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), - ItemIDs = lists:foldl(fun + ItemIds = lists:foldl(fun (#xmlel{name = 'item', attrs = ItemAttrs}, Acc) -> case exmpp_xml:get_attribute_from_list_as_list(ItemAttrs, 'id', "") of "" -> Acc; - ItemID -> [ItemID|Acc] + ItemId -> [ItemId|Acc] end; (_, Acc) -> Acc end, [], exmpp_xml:remove_cdata_from_list(Els)), - RSM = jlib:rsm_decode(SubEl), - get_items(Host, Node, From, SubId, MaxItems, ItemIDs, RSM); + get_items(Host, Node, From, SubId, MaxItems, ItemIds, jlib:rsm_decode(SubEl)); {get, 'subscriptions'} -> get_subscriptions(Host, Node, From, Plugins); {get, 'affiliations'} -> get_affiliations(Host, From, Plugins); {get, 'options'} -> - SubID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), + SubId = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), JID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'jid', ""), - get_options(Host, Node, JID, SubID, Lang); + get_options(Host, Node, JID, SubId, Lang); {set, 'options'} -> - SubID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), + SubId = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), JID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'jid', ""), - set_options(Host, Node, JID, SubID, Els); + set_options(Host, Node, JID, SubId, Els); _ -> {error, 'feature-not-implemented'} end; @@ -1317,12 +1313,12 @@ send_pending_auth_events(Host, Node, Owner) -> ?DEBUG("Sending pending auth events for ~s on ~s:~s", [exmpp_jid:to_list(Owner), Host, node_to_string(Node)]), Action = - fun(#pubsub_node{id = NodeID, type = Type}) -> + fun(#pubsub_node{idx = Nidx, type = Type}) -> case lists:member("get-pending", features(Type)) of true -> - case node_call(Type, get_affiliation, [NodeID, Owner]) of + case node_call(Type, get_affiliation, [Nidx, Owner]) of {result, owner} -> - node_call(Type, get_node_subscriptions, [NodeID]); + node_call(Type, get_node_subscriptions, [Nidx]); _ -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'forbidden')} end; @@ -1332,7 +1328,7 @@ send_pending_auth_events(Host, Node, Owner) -> end, case transaction(Host, Node, Action, sync_dirty) of {result, {N, Subscriptions}} -> - lists:foreach(fun({J, pending, _SubID}) -> + lists:foreach(fun({J, pending, _SubId}) -> {U, S, R} = J, send_authorization_request(N, exmpp_jid:make(U,S,R)); ({J, pending}) -> @@ -1348,7 +1344,7 @@ send_pending_auth_events(Host, Node, Owner) -> %%% authorization handling -send_authorization_request(#pubsub_node{nodeid = {Host, Node}, type = Type, id = NodeId}, Subscriber) -> +send_authorization_request(#pubsub_node{id = {Host, Node}, type = Type, idx = Nidx}, Subscriber) -> Lang = <<"en">>, %% TODO fix {U, S, R} = Subscriber, Stanza = #xmlel{ns = ?NS_JABBER_CLIENT, name = 'message', children = @@ -1378,7 +1374,7 @@ send_authorization_request(#pubsub_node{nodeid = {Host, Node}, type = Type, id = lists:foreach(fun(Owner) -> {U, S, R} = Owner, ejabberd_router:route(service_jid(Host), exmpp_jid:make(U, S, R), Stanza) - end, node_owners(Host, Type, NodeId)). + end, node_owners(Host, Type, Nidx)). find_authorization_response(Packet) -> Els = Packet#xmlel.children, @@ -1437,14 +1433,14 @@ handle_authorization_response(Host, From, To, Packet, XFields) -> "true" -> true; _ -> false end, - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - IsApprover = lists:member(jlib:short_prepd_bare_jid(From), node_owners_call(Type, NodeId)), - {result, Subscriptions} = node_call(Type, get_subscriptions, [NodeId, Subscriber]), + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + IsApprover = lists:member(jlib:short_prepd_bare_jid(From), node_owners_call(Type, Nidx)), + {result, Subscriptions} = node_call(Type, get_subscriptions, [Nidx, Subscriber]), if not IsApprover -> {error, 'forbidden'}; true -> - update_auth(Host, SNode, Type, NodeId, + update_auth(Host, SNode, Type, Nidx, Subscriber, Allow, Subscriptions) end @@ -1464,19 +1460,19 @@ handle_authorization_response(Host, From, To, Packet, XFields) -> exmpp_stanza:reply_with_error(Packet, 'not-acceptable')) end. -update_auth(Host, Node, Type, NodeId, Subscriber, +update_auth(Host, Node, Type, Nidx, Subscriber, Allow, Subscriptions) -> Subscription = lists:filter(fun({pending, _}) -> true; (_) -> false end, Subscriptions), case Subscription of - [{pending, SubID}] -> %% TODO does not work if several pending + [{pending, SubId}] -> %% TODO does not work if several pending NewSubscription = case Allow of true -> subscribed; false -> none end, node_call(Type, set_subscriptions, - [NodeId, Subscriber, NewSubscription, SubID]), + [Nidx, Subscriber, NewSubscription, SubId]), send_authorization_approval(Host, Subscriber, Node, NewSubscription), {result, ok}; @@ -1548,8 +1544,8 @@ update_auth(Host, Node, Type, NodeId, Subscriber, %%<li>The service does not support node creation.</li> %%<li>Only entities that are registered with the service are allowed to create nodes but the requesting entity is not registered.</li> %%<li>The requesting entity does not have sufficient privileges to create nodes.</li> -%%<li>The requested NodeID already exists.</li> -%%<li>The request did not include a NodeID and "instant nodes" are not supported.</li> +%%<li>The requested NodeId already exists.</li> +%%<li>The request did not include a NodeId and "instant nodes" are not supported.</li> %%</ul> %%<p>ote: node creation is a particular case, error return code is evaluated at many places:</p> %%<ul> @@ -1675,8 +1671,8 @@ delete_node(_Host, <<>>, _Owner) -> %% Node is the root {error, 'not-allowed'}; delete_node(Host, Node, Owner) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - case node_call(Type, get_affiliation, [NodeId, Owner]) of + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + case node_call(Type, get_affiliation, [Nidx, Owner]) of {result, owner} -> ParentTree = tree_call(Host, get_parentnodes_tree, [Host, Node, service_jid(Host)]), SubsByDepth = [{Depth, [{N, get_node_subs(N)} || N <- Nodes]} || {Depth, Nodes} <- ParentTree], @@ -1694,12 +1690,12 @@ delete_node(Host, Node, Owner) -> case transaction(Host, Node, Action, transaction) of {result, {_, {SubsByDepth, {Result, broadcast, Removed}}}} -> lists:foreach(fun({RNode, _RSubscriptions}) -> - {RH, RN} = RNode#pubsub_node.nodeid, - NodeId = RNode#pubsub_node.id, + {RH, RN} = RNode#pubsub_node.id, + Nidx = RNode#pubsub_node.idx, Type = RNode#pubsub_node.type, Options = RNode#pubsub_node.options, - broadcast_removed_node(RH, RN, NodeId, Type, Options, SubsByDepth), - unset_cached_item(RH, NodeId) + broadcast_removed_node(RH, RN, Nidx, Type, Options, SubsByDepth), + unset_cached_item(RH, Nidx) end, Removed), case Result of default -> {result, Reply}; @@ -1751,7 +1747,7 @@ subscribe_node(Host, Node, From, JID, Configuration) -> _:_ -> {undefined, undefined, undefined} end, - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), SubscribeFeature = lists:member("subscribe", Features), OptionsFeature = lists:member("subscription-options", Features), @@ -1760,7 +1756,7 @@ subscribe_node(Host, Node, From, JID, Configuration) -> AccessModel = get_option(Options, access_model), SendLast = get_option(Options, send_last_published_item), AllowedGroups = get_option(Options, roster_groups_allowed, []), - Owners = node_owners_call(Type, NodeId), + Owners = node_owners_call(Type, Nidx), {PresenceSubscription, RosterGroup} = get_presence_and_roster_permissions(Host, Subscriber, Owners, AccessModel, AllowedGroups), if not SubscribeFeature -> @@ -1777,7 +1773,7 @@ subscribe_node(Host, Node, From, JID, Configuration) -> {error, extended_error('bad-request', "invalid-options")}; true -> node_call(Type, subscribe_node, - [NodeId, From, Subscriber, + [Nidx, From, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, SubOpts]) @@ -1799,9 +1795,9 @@ subscribe_node(Host, Node, From, JID, Configuration) -> end, case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, subscribed, SubId, send_last}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, - send_items(Host, Node, NodeId, Type, Subscriber, last), + send_items(Host, Node, Nidx, Type, Subscriber, last), notify_owners(get_option(TNode#pubsub_node.options, notify_sub), Subscriber, Host, Node, TNode#pubsub_node.owners, "subscribed"), case Result of default -> {result, Reply({subscribed, SubId})}; @@ -1852,8 +1848,8 @@ unsubscribe_node(Host, Node, From, JID, SubId) when is_list(JID) -> end, unsubscribe_node(Host, Node, From, Subscriber, SubId); unsubscribe_node(Host, Node, From, Subscriber, SubId) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - node_call(Type, unsubscribe_node, [NodeId, From, Subscriber, SubId]) + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + node_call(Type, unsubscribe_node, [Nidx, From, Subscriber, SubId]) end, case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, default}} -> @@ -1884,7 +1880,7 @@ publish_item(Host, ServerHost, Node, Publisher, "", Payload) -> %% if publisher does not specify an ItemId, the service MUST generate the ItemId publish_item(Host, ServerHost, Node, Publisher, uniqid(), Payload); publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), PublishFeature = lists:member("publish", Features), PublishModel = get_option(Options, publish_model), @@ -1922,7 +1918,7 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> %% Publisher attempts to publish to persistent node with no item {error, extended_error('bad-request', "item-required")}; true -> - node_call(Type, publish_item, [NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload]) + node_call(Type, publish_item, [Nidx, Publisher, PublishModel, MaxItems, ItemId, Payload]) end end, ServerHostB = list_to_binary(ServerHost), @@ -1932,7 +1928,7 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> [#xmlel{ns = ?NS_PUBSUB, name = 'item', attrs = itemAttr(ItemId)}]}]}, case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, Broadcast, Removed}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, BroadcastPayload = case Broadcast of @@ -1940,25 +1936,25 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> broadcast -> Payload; PluginPayload -> PluginPayload end, - broadcast_publish_item(Host, Node, NodeId, Type, Options, Removed, ItemId, jlib:short_prepd_jid(Publisher), BroadcastPayload), - set_cached_item(Host, NodeId, ItemId, Publisher, Payload), + broadcast_publish_item(Host, Node, Nidx, Type, Options, Removed, ItemId, jlib:short_prepd_jid(Publisher), BroadcastPayload), + set_cached_item(Host, Nidx, ItemId, Publisher, Payload), case Result of default -> {result, Reply}; _ -> {result, Result} end; {result, {TNode, {default, Removed}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_retract_items(Host, Node, NodeId, Type, Options, Removed), - set_cached_item(Host, NodeId, ItemId, Publisher, Payload), + broadcast_retract_items(Host, Node, Nidx, Type, Options, Removed), + set_cached_item(Host, Nidx, ItemId, Publisher, Payload), {result, Reply}; {result, {TNode, {Result, Removed}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_retract_items(Host, Node, NodeId, Type, Options, Removed), - set_cached_item(Host, NodeId, ItemId, Publisher, Payload), + broadcast_retract_items(Host, Node, Nidx, Type, Options, Removed), + set_cached_item(Host, Nidx, ItemId, Publisher, Payload), {result, Result}; {result, {_, default}} -> {result, Reply}; @@ -2004,7 +2000,7 @@ delete_item(_, "", _, _, _) -> %% Request does not specify a node {error, extended_error('bad-request', "node-required")}; delete_item(Host, Node, Publisher, ItemId, ForceNotify) -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), PersistentFeature = lists:member("persistent-items", Features), DeleteFeature = lists:member("delete-items", Features), @@ -2020,18 +2016,18 @@ delete_item(Host, Node, Publisher, ItemId, ForceNotify) -> %% Service does not support item deletion {error, extended_error('feature-not-implemented', unsupported, "delete-items")}; true -> - node_call(Type, delete_item, [NodeId, Publisher, PublishModel, ItemId]) + node_call(Type, delete_item, [Nidx, Publisher, PublishModel, ItemId]) end end, Reply = [], case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, broadcast}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_retract_items(Host, Node, NodeId, Type, Options, [ItemId], ForceNotify), - case get_cached_item(Host, NodeId) of - #pubsub_item{itemid = {ItemId, NodeId}, _ = '_'} -> unset_cached_item(Host, NodeId); + broadcast_retract_items(Host, Node, Nidx, Type, Options, [ItemId], ForceNotify), + case get_cached_item(Host, Nidx) of + #pubsub_item{id = {ItemId, Nidx}} -> unset_cached_item(Host, Nidx); _ -> ok end, case Result of @@ -2061,7 +2057,7 @@ delete_item(Host, Node, Publisher, ItemId, ForceNotify) -> %%<li>The specified node does not exist.</li> %%</ul> purge_node(Host, Node, Owner) -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), PurgeFeature = lists:member("purge-nodes", Features), PersistentFeature = lists:member("persistent-items", Features), @@ -2077,17 +2073,17 @@ purge_node(Host, Node, Owner) -> %% Node is not configured for persistent items {error, extended_error('feature-not-implemented', unsupported, "persistent-items")}; true -> - node_call(Type, purge_node, [NodeId, Owner]) + node_call(Type, purge_node, [Nidx, Owner]) end end, Reply = [], case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, broadcast}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_purge_node(Host, Node, NodeId, Type, Options), - unset_cached_item(Host, NodeId), + broadcast_purge_node(Host, Node, Nidx, Type, Options), + unset_cached_item(Host, Nidx), case Result of default -> {result, Reply}; _ -> {result, Result} @@ -2105,7 +2101,7 @@ purge_node(Host, Node, Owner) -> %% <p>The permission are not checked in this function.</p> %% @todo We probably need to check that the user doing the query has the right %% to read the items. -get_items(Host, Node, From, SubId, SMaxItems, ItemIDs, RSM) -> +get_items(Host, Node, From, SubId, SMaxItems, ItemIds, RSM) -> MaxItems = if SMaxItems == "" -> get_max_items_node(Host); @@ -2119,13 +2115,13 @@ get_items(Host, Node, From, SubId, SMaxItems, ItemIDs, RSM) -> {error, Error} -> {error, Error}; _ -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), RetreiveFeature = lists:member("retrieve-items", Features), PersistentFeature = lists:member("persistent-items", Features), AccessModel = get_option(Options, access_model), AllowedGroups = get_option(Options, roster_groups_allowed, []), - Owners = node_owners_call(Type, NodeId), + Owners = node_owners_call(Type, Nidx), {PresenceSubscription, RosterGroup} = get_presence_and_roster_permissions(Host, From, Owners, AccessModel, AllowedGroups), if not RetreiveFeature -> @@ -2136,19 +2132,19 @@ get_items(Host, Node, From, SubId, SMaxItems, ItemIDs, RSM) -> {error, extended_error('feature-not-implemented', unsupported, "persistent-items")}; true -> node_call(Type, get_items, - [NodeId, From, + [Nidx, From, AccessModel, PresenceSubscription, RosterGroup, SubId, RSM]) end end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Items, RSMOut}} -> - SendItems = case ItemIDs of + SendItems = case ItemIds of [] -> Items; _ -> - lists:filter(fun(#pubsub_item{itemid = {ItemId, _}}) -> - lists:member(ItemId, ItemIDs) + lists:filter(fun(#pubsub_item{id = {ItemId, _}}) -> + lists:member(ItemId, ItemIds) end, Items) end, %% Generate the XML response (Item list), limiting the @@ -2160,17 +2156,19 @@ get_items(Host, Node, From, SubId, SMaxItems, ItemIDs, RSM) -> Error end end. + get_items(Host, Node) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - node_call(Type, get_items, [NodeId, service_jid(Host)]) + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + node_call(Type, get_items, [Nidx, service_jid(Host)]) end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Items}} -> Items; Error -> Error end. + get_item(Host, Node, ItemId) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - node_call(Type, get_item, [NodeId, ItemId]) + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + node_call(Type, get_item, [Nidx, ItemId]) end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Items}} -> Items; @@ -2271,7 +2269,7 @@ get_affiliations(Host, JID, Plugins) when is_list(Plugins) -> {ok, Affiliations} -> Entities = lists:flatmap( fun({_, none}) -> []; - ({#pubsub_node{nodeid = {_, Node}}, Affiliation}) -> + ({#pubsub_node{id = {_, Node}}, Affiliation}) -> [#xmlel{ns = ?NS_PUBSUB, name = 'affiliation', attrs = [?XMLATTR('node', node_to_string(Node)), ?XMLATTR('affiliation', affiliation_to_string(Affiliation))]}] @@ -2283,10 +2281,10 @@ get_affiliations(Host, JID, Plugins) when is_list(Plugins) -> Error end; get_affiliations(Host, Node, JID) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> Features = features(Type), RetrieveFeature = lists:member("modify-affiliations", Features), - {result, Affiliation} = node_call(Type, get_affiliation, [NodeId, JID]), + {result, Affiliation} = node_call(Type, get_affiliation, [Nidx, JID]), if not RetrieveFeature -> %% Service does not support modify affiliations @@ -2295,7 +2293,7 @@ get_affiliations(Host, Node, JID) -> %% Entity is not an owner {error, 'forbidden'}; true -> - node_call(Type, get_node_affiliations, [NodeId]) + node_call(Type, get_node_affiliations, [Nidx]) end end, case transaction(Host, Node, Action, sync_dirty) of @@ -2347,8 +2345,8 @@ set_affiliations(Host, Node, From, EntitiesEls) -> error -> {error, 'bad-request'}; _ -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - Owners = node_owners_call(Type, NodeId), + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + Owners = node_owners_call(Type, Nidx), case lists:member(Owner, Owners) of true -> OwnerJID = exmpp_jid:make(Owner), @@ -2359,7 +2357,7 @@ set_affiliations(Host, Node, From, EntitiesEls) -> lists:foreach( fun({JID, Affiliation}) -> % TODO, check if nothing missing here about new owners - node_call(Type, set_affiliation, [NodeId, JID, Affiliation]) + node_call(Type, set_affiliation, [Nidx, JID, Affiliation]) end, FilteredEntities), {result, []}; _ -> @@ -2372,11 +2370,11 @@ set_affiliations(Host, Node, From, EntitiesEls) -> end end. -get_options(Host, Node, JID, SubID, Lang) -> - Action = fun(#pubsub_node{type = Type, id = NodeID}) -> +get_options(Host, Node, JID, SubId, Lang) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> case lists:member("subscription-options", features(Type)) of true -> - get_options_helper(JID, Lang, Node, NodeID, SubID, Type); + get_options_helper(JID, Lang, Node, Nidx, SubId, Type); false -> {error, extended_error( 'feature-not-implemented', @@ -2388,7 +2386,7 @@ get_options(Host, Node, JID, SubID, Lang) -> Error -> Error end. -get_options_helper(JID, Lang, Node, NodeID, SubID, Type) -> +get_options_helper(JID, Lang, Node, NodeId, SubId, Type) -> Subscriber = try exmpp_jid:parse(JID) of J -> jlib:short_jid(J) catch @@ -2396,43 +2394,43 @@ get_options_helper(JID, Lang, Node, NodeID, SubID, Type) -> exmpp_jid:make("", "", "") %% TODO, check if use <<>> instead of "" end, {result, Subs} = node_call(Type, get_subscriptions, - [NodeID, Subscriber]), - SubIDs = lists:foldl(fun({subscribed, SID}, Acc) -> + [NodeId, Subscriber]), + SubIds = lists:foldl(fun({subscribed, SID}, Acc) -> [SID | Acc]; (_, Acc) -> Acc end, [], Subs), - case {SubID, SubIDs} of + case {SubId, SubIds} of {_, []} -> {error, extended_error('not-acceptable', "not-subscribed")}; {[], [SID]} -> - read_sub(Subscriber, Node, NodeID, SID, Lang); + read_sub(Subscriber, Node, NodeId, SID, Lang); {[], _} -> {error, extended_error('not-acceptable', "subid-required")}; {_, _} -> - read_sub(Subscriber, Node, NodeID, SubID, Lang) + read_sub(Subscriber, Node, NodeId, SubId, Lang) end. -read_sub(Subscriber, Node, NodeID, SubID, Lang) -> - case pubsub_subscription_odbc:get_subscription(Subscriber, NodeID, SubID) of +read_sub(Subscriber, Node, NodeId, SubId, Lang) -> + case pubsub_subscription_odbc:get_subscription(Subscriber, NodeId, SubId) of {error, notfound} -> {error, extended_error('not-acceptable', "invalid-subid")}; {result, #pubsub_subscription{options = Options}} -> {result, XdataEl} = pubsub_subscription_odbc:get_options_xform(Lang, Options), OptionsEl = #xmlel{ns = ?NS_PUBSUB, name = 'options', attrs = [ ?XMLATTR('jid', exmpp_jid:to_binary(Subscriber)), - ?XMLATTR('subid', SubID) | nodeAttr(Node)], + ?XMLATTR('subid', SubId) | nodeAttr(Node)], children = [XdataEl]}, PubsubEl = #xmlel{ns = ?NS_PUBSUB, name = 'pubsub', children = [OptionsEl]}, {result, PubsubEl} end. -set_options(Host, Node, JID, SubID, Configuration) -> - Action = fun(#pubsub_node{type = Type, id = NodeID}) -> +set_options(Host, Node, JID, SubId, Configuration) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> case lists:member("subscription-options", features(Type)) of true -> - set_options_helper(Configuration, JID, NodeID, - SubID, Type); + set_options_helper(Configuration, JID, Nidx, + SubId, Type); false -> {error, extended_error( 'feature-not-implemented', @@ -2444,7 +2442,7 @@ set_options(Host, Node, JID, SubID, Configuration) -> Error -> Error end. -set_options_helper(Configuration, JID, NodeID, SubID, Type) -> +set_options_helper(Configuration, JID, NodeId, SubId, Type) -> SubOpts = case pubsub_subscription_odbc:parse_options_xform(Configuration) of {result, GoodSubOpts} -> GoodSubOpts; _ -> invalid @@ -2455,27 +2453,27 @@ set_options_helper(Configuration, JID, NodeID, SubID, Type) -> _ -> exmpp_jid:make("", "", "") %% TODO, check if use <<>> instead of "" end, {result, Subs} = node_call(Type, get_subscriptions, - [NodeID, Subscriber]), - SubIDs = lists:foldl(fun({subscribed, SID}, Acc) -> + [NodeId, Subscriber]), + SubIds = lists:foldl(fun({subscribed, SID}, Acc) -> [SID | Acc]; (_, Acc) -> Acc end, [], Subs), - case {SubID, SubIDs} of + case {SubId, SubIds} of {_, []} -> {error, extended_error('not-acceptable', "not-subscribed")}; {[], [SID]} -> - write_sub(Subscriber, NodeID, SID, SubOpts); + write_sub(Subscriber, NodeId, SID, SubOpts); {[], _} -> {error, extended_error('not-acceptable', "subid-required")}; {_, _} -> - write_sub(Subscriber, NodeID, SubID, SubOpts) + write_sub(Subscriber, NodeId, SubId, SubOpts) end. -write_sub(_Subscriber, _NodeID, _SubID, invalid) -> +write_sub(_Subscriber, _NodeId, _SubId, invalid) -> {error, extended_error('bad-request', "invalid-options")}; -write_sub(Subscriber, NodeID, SubID, Options) -> - case pubsub_subscription_odbc:set_subscription(Subscriber, NodeID, SubID, Options) of +write_sub(Subscriber, NodeId, SubId, Options) -> + case pubsub_subscription_odbc:set_subscription(Subscriber, NodeId, SubId, Options) of {error, notfound} -> {error, extended_error('not-acceptable', "invalid-subid")}; {result, _} -> @@ -2510,7 +2508,7 @@ get_subscriptions(Host, Node, JID, Plugins) when is_list(Plugins) -> Entities = lists:flatmap( fun({_, none}) -> []; - ({#pubsub_node{nodeid = {_, SubsNode}}, Subscription}) -> + ({#pubsub_node{id = {_, SubsNode}}, Subscription}) -> case Node of <<>> -> [#xmlel{ns = ?NS_PUBSUB, name = 'subscription', attrs = @@ -2524,22 +2522,22 @@ get_subscriptions(Host, Node, JID, Plugins) when is_list(Plugins) -> end; ({_, none, _}) -> []; - ({#pubsub_node{nodeid = {_, SubsNode}}, Subscription, SubID, SubJID}) -> + ({#pubsub_node{id = {_, SubsNode}}, Subscription, SubId, SubJID}) -> case Node of <<>> -> [#xmlel{ns = ?NS_PUBSUB, name='subscription', attrs = [?XMLATTR('jid', exmpp_jid:to_binary(SubJID)), - ?XMLATTR('subid', SubID), + ?XMLATTR('subid', SubId), ?XMLATTR('subscription', subscription_to_string(Subscription)) | nodeAttr(SubsNode)]}]; SubsNode -> [#xmlel{ns = ?NS_PUBSUB, name = 'subscription', attrs = [?XMLATTR('jid', exmpp_jid:to_binary(SubJID)), - ?XMLATTR('subid', SubID), + ?XMLATTR('subid', SubId), ?XMLATTR('subscription', subscription_to_string(Subscription))]}]; _ -> [] end; - ({#pubsub_node{nodeid = {_, SubsNode}}, Subscription, SubJID}) -> + ({#pubsub_node{id = {_, SubsNode}}, Subscription, SubJID}) -> case Node of <<>> -> [#xmlel{ns = ?NS_PUBSUB, name = 'subscription', attrs = @@ -2561,10 +2559,10 @@ get_subscriptions(Host, Node, JID, Plugins) when is_list(Plugins) -> Error end. get_subscriptions(Host, Node, JID) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> Features = features(Type), RetrieveFeature = lists:member("manage-subscriptions", Features), - {result, Affiliation} = node_call(Type, get_affiliation, [NodeId, JID]), + {result, Affiliation} = node_call(Type, get_affiliation, [Nidx, JID]), if not RetrieveFeature -> %% Service does not support manage subscriptions @@ -2573,7 +2571,7 @@ get_subscriptions(Host, Node, JID) -> %% Entity is not an owner {error, 'forbidden'}; true -> - node_call(Type, get_node_subscriptions, [NodeId]) + node_call(Type, get_node_subscriptions, [Nidx]) end end, case transaction(Host, Node, Action, sync_dirty) of @@ -2649,12 +2647,12 @@ set_subscriptions(Host, Node, From, EntitiesEls) -> ?XMLATTR('subsription', subscription_to_string(Sub)) | nodeAttr(Node)]}]}]}, ejabberd_router:route(service_jid(Host), JID, Stanza) end, - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - case lists:member(Owner, node_owners_call(Type, NodeId)) of + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + case lists:member(Owner, node_owners_call(Type, Nidx)) of true -> Result = lists:foldl(fun({JID, Subscription, SubId}, Acc) -> - case node_call(Type, set_subscriptions, [NodeId, JID, Subscription, SubId]) of + case node_call(Type, set_subscriptions, [Nidx, JID, Subscription, SubId]) of {error, Err} -> [{error, Err} | Acc]; _ -> Notify(JID, Subscription, SubId), Acc end @@ -3004,18 +3002,17 @@ get_collection_subscriptions(Host, Node) -> _ -> [] end. -get_node_subs(#pubsub_node{type = Type, - id = NodeID}) -> - case node_call(Type, get_node_subscriptions, [NodeID]) of - {result, Subs} -> get_options_for_subs(NodeID, Subs); +get_node_subs(#pubsub_node{type = Type, idx = Nidx}) -> + case node_call(Type, get_node_subscriptions, [Nidx]) of + {result, Subs} -> get_options_for_subs(Nidx, Subs); Other -> Other end. -get_options_for_subs(NodeID, Subs) -> - lists:foldl(fun({JID, subscribed, SubID}, Acc) -> - case pubsub_subscription_odbc:get_subscription(JID, NodeID, SubID) of - {error, notfound} -> [{JID, SubID, []} | Acc]; - {result, #pubsub_subscription{options = Options}} -> [{JID, SubID, Options} | Acc]; +get_options_for_subs(Nidx, Subs) -> + lists:foldl(fun({JID, subscribed, SubId}, Acc) -> + case pubsub_subscription_odbc:read_subscription(JID, Nidx, SubId) of + {error, notfound} -> [{JID, SubId, []} | Acc]; + #pubsub_subscription{options = Options} -> [{JID, SubId, Options} | Acc]; _ -> Acc end; (_, Acc) -> @@ -3049,8 +3046,8 @@ broadcast_stanza(Host, _Node, _NodeId, _Type, NodeOptions, SubsByDepth, NotifyTy MsgType -> add_message_type(BaseStanza, atom_to_list(MsgType)) end, %% Handles explicit subscriptions - SubIDsByJID = subscribed_nodes_by_jid(NotifyType, SubsByDepth), - lists:foreach(fun ({LJID, NodeName, SubIDs}) -> + SubIdsByJID = subscribed_nodes_by_jid(NotifyType, SubsByDepth), + lists:foreach(fun ({LJID, NodeName, SubIds}) -> LJIDs = case BroadcastAll of true -> {U, S, _} = LJID, @@ -3058,19 +3055,19 @@ broadcast_stanza(Host, _Node, _NodeId, _Type, NodeOptions, SubsByDepth, NotifyTy false -> [LJID] end, - %% Determine if the stanza should have SHIM ('SubID' and 'name') headers - StanzaToSend = case {SHIM, SubIDs} of + %% Determine if the stanza should have SHIM ('SubId' and 'name') headers + StanzaToSend = case {SHIM, SubIds} of {false, _} -> Stanza; {true, [_]} -> add_shim_headers(Stanza, collection_shim(NodeName)); - {true, SubIDs} -> - add_shim_headers(Stanza, lists:append(collection_shim(NodeName), subid_shim(SubIDs))) + {true, SubIds} -> + add_shim_headers(Stanza, lists:append(collection_shim(NodeName), subid_shim(SubIds))) end, lists:foreach(fun(To) -> ejabberd_router:route(From, exmpp_jid:make(To), StanzaToSend) end, LJIDs) - end, SubIDsByJID). + end, SubIdsByJID). broadcast_stanza({LUser, LServer, LResource}, Publisher, Node, NodeId, Type, NodeOptions, SubsByDepth, NotifyType, BaseStanza, SHIM) -> broadcast_stanza({LUser, LServer, LResource}, Node, NodeId, Type, NodeOptions, SubsByDepth, NotifyType, BaseStanza, SHIM), @@ -3121,12 +3118,12 @@ broadcast_stanza(Host, _Publisher, Node, NodeId, Type, NodeOptions, SubsByDepth, subscribed_nodes_by_jid(NotifyType, SubsByDepth) -> NodesToDeliver = fun(Depth, Node, Subs, Acc) -> - NodeName = case Node#pubsub_node.nodeid of + NodeName = case Node#pubsub_node.id of {_, N} -> N; Other -> Other end, NodeOptions = Node#pubsub_node.options, - lists:foldl(fun({LJID, SubID, SubOptions}, {JIDs, Recipients}) -> + lists:foldl(fun({LJID, SubId, SubOptions}, {JIDs, Recipients}) -> case is_to_deliver(LJID, NotifyType, Depth, NodeOptions, SubOptions) of true -> %% If is to deliver : @@ -3136,26 +3133,26 @@ subscribed_nodes_by_jid(NotifyType, SubsByDepth) -> lists:foldl( fun(JIDToDeliver, {JIDsAcc, RecipientsAcc}) -> case lists:member(JIDToDeliver, JIDs) of - %% check if the JIDs co-accumulator contains the Subscription Jid, + %% check if the JIDs co-accumulator contains the Subscription JID, false -> %% - if not, - %% - add the Jid to JIDs list co-accumulator ; - %% - create a tuple of the Jid, NodeId, and SubID (as list), + %% - add the JID to JIDs list co-accumulator ; + %% - create a tuple of the JID, NodeId, and SubId (as list), %% and add the tuple to the Recipients list co-accumulator - {[JIDToDeliver | JIDsAcc], [{JIDToDeliver, NodeName, [SubID]} | RecipientsAcc]}; + {[JIDToDeliver | JIDsAcc], [{JIDToDeliver, NodeName, [SubId]} | RecipientsAcc]}; true -> - %% - if the JIDs co-accumulator contains the Jid - %% get the tuple containing the Jid from the Recipient list co-accumulator - {_, {JIDToDeliver, NodeName1, SubIDs}} = lists:keysearch(JIDToDeliver, 1, RecipientsAcc), + %% - if the JIDs co-accumulator contains the JID + %% get the tuple containing the JID from the Recipient list co-accumulator + {_, {JIDToDeliver, NodeName1, SubIds}} = lists:keysearch(JIDToDeliver, 1, RecipientsAcc), %% delete the tuple from the Recipients list % v1 : Recipients1 = lists:keydelete(LJID, 1, Recipients), - % v2 : Recipients1 = lists:keyreplace(LJID, 1, Recipients, {LJID, NodeId1, [SubID | SubIDs]}), - %% add the SubID to the SubIDs list in the tuple, + % v2 : Recipients1 = lists:keyreplace(LJID, 1, Recipients, {LJID, NodeId1, [SubId | SubIds]}), + %% add the SubId to the SubIds list in the tuple, %% and add the tuple back to the Recipients list co-accumulator - % v1.1 : {JIDs, lists:append(Recipients1, [{LJID, NodeId1, lists:append(SubIDs, [SubID])}])} - % v1.2 : {JIDs, [{LJID, NodeId1, [SubID | SubIDs]} | Recipients1]} + % v1.1 : {JIDs, lists:append(Recipients1, [{LJID, NodeId1, lists:append(SubIds, [SubId])}])} + % v1.2 : {JIDs, [{LJID, NodeId1, [SubId | SubIds]} | Recipients1]} % v2: {JIDs, Recipients1} - {JIDsAcc, lists:keyreplace(JIDToDeliver, 1, RecipientsAcc, {JIDToDeliver, NodeName1, [SubID | SubIDs]})} + {JIDsAcc, lists:keyreplace(JIDToDeliver, 1, RecipientsAcc, {JIDToDeliver, NodeName1, [SubId | SubIds]})} end end, {JIDs, Recipients}, JIDsToDeliver) end; @@ -3185,8 +3182,8 @@ user_resources(User, Server) -> get_configure(Host, ServerHost, Node, From, Lang) -> ServerHostB = list_to_binary(ServerHost), Action = - fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> - case node_call(Type, get_affiliation, [NodeId, From]) of + fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> + case node_call(Type, get_affiliation, [Nidx, From]) of {result, owner} -> Groups = ejabberd_hooks:run_fold(roster_groups, ServerHostB, [], [ServerHostB]), {result, @@ -3367,8 +3364,8 @@ set_configure(Host, Node, From, Els, Lang) -> {result, []}; "submit" -> Action = - fun(#pubsub_node{options = Options, type = Type, id = NodeId} = N) -> - case node_call(Type, get_affiliation, [NodeId, From]) of + fun(#pubsub_node{options = Options, type = Type, idx = Nidx} = N) -> + case node_call(Type, get_affiliation, [Nidx, From]) of {result, owner} -> case jlib:parse_xdata_submit(XEl) of invalid -> @@ -3394,10 +3391,10 @@ set_configure(Host, Node, From, Els, Lang) -> end, case transaction(Host, Node, Action, transaction) of {result, {TNode, ok}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_config_notification(Host, Node, NodeId, Type, Options, Lang), + broadcast_config_notification(Host, Node, Nidx, Type, Options, Lang), {result, []}; Other -> Other @@ -3544,7 +3541,7 @@ get_cached_item(Host, NodeId) -> true -> case mnesia:dirty_read({pubsub_last_item, NodeId}) of [{pubsub_last_item, NodeId, ItemId, Creation, Payload}] -> - #pubsub_item{itemid = {ItemId, NodeId}, payload = Payload, + #pubsub_item{id = {ItemId, NodeId}, payload = Payload, creation = Creation, modification = Creation}; _ -> undefined @@ -3787,7 +3784,7 @@ itemAttr(ItemId) -> [?XMLATTR('id', ItemId)]. % build item elements from item list itemsEls(Items) -> - lists:map(fun(#pubsub_item{itemid = {ItemId, _}, payload = Payload}) -> + lists:map(fun(#pubsub_item{id = {ItemId, _}, payload = Payload}) -> #xmlel{ns = ?NS_PUBSUB, name = 'item', attrs = itemAttr(ItemId), children = Payload} end, Items). @@ -3827,17 +3824,17 @@ collection_shim(Node) -> attrs = [?XMLATTR('name', <<"Collection">>)], children = [?XMLCDATA(node_to_string(Node))]}]. -subid_shim(SubIDs) -> +subid_shim(SubIds) -> [#xmlel{ns = ?NS_PUBSUB, name ='header', - attrs = [?XMLATTR('name', <<"SubID">>)], - children = [?XMLCDATA(SubID)]} - || SubID <- SubIDs]. + attrs = [?XMLATTR('name', <<"SubId">>)], + children = [?XMLCDATA(SubId)]} + || SubId <- SubIds]. -extended_headers(Jids) -> +extended_headers(JIDs) -> [#xmlel{ns = ?NS_ADDRESS, name = 'address', - attrs = [?XMLATTR('type', <<"replyto">>), ?XMLATTR('jid', Jid)]} - || Jid <- Jids]. + attrs = [?XMLATTR('type', <<"replyto">>), ?XMLATTR('jid', JID)]} + || JID <- JIDs]. feature_check_packet(allow, _User, Server, Pres, {From, _To, El}, in) -> Host = list_to_binary(host(Server)), @@ -3893,10 +3890,10 @@ purge_offline({User, Server, _} = LJID) -> case Result of {ok, Affiliations} -> lists:foreach( - fun({#pubsub_node{nodeid = {_, NodeId}, options = Options, type = Type}, Affiliation}) + fun({#pubsub_node{id = {_, NodeId}, options = Options, type = Type}, Affiliation}) when Affiliation == 'owner' orelse Affiliation == 'publisher' -> - Action = fun(#pubsub_node{type = NType, id = NodeIdx}) -> - node_call(NType, get_items, [NodeIdx, service_jid(Host)]) + Action = fun(#pubsub_node{type = NType, idx = Nidx}) -> + node_call(NType, get_items, [Nidx, service_jid(Host)]) end, case transaction(Host, NodeId, Action, sync_dirty) of {result, {_, []}} -> @@ -3912,7 +3909,7 @@ purge_offline({User, Server, _} = LJID) -> {true, true, true, true} -> ForceNotify = get_option(Options, notify_retract), lists:foreach( - fun(#pubsub_item{itemid = {ItemId, _}, modification = {_, Modification}}) -> + fun(#pubsub_item{id = {ItemId, _}, modification = {_, Modification}}) -> case Modification of {User, Server, _} -> delete_item(Host, NodeId, LJID, ItemId, ForceNotify); diff --git a/src/mod_pubsub/node.template b/src/mod_pubsub/node.template index 0efe75418..b6f39e6d2 100644 --- a/src/mod_pubsub/node.template +++ b/src/mod_pubsub/node.template @@ -75,8 +75,7 @@ terminate(Host, ServerHost) -> node_flat:terminate(Host, ServerHost). options() -> - [{node_type, __TO_BE_DEFINED__}, - {deliver_payloads, true}, + [{deliver_payloads, true}, {notify_config, false}, {notify_delete, false}, {notify_retract, true}, @@ -123,8 +122,8 @@ delete_node(Removed) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup) -> node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/node_buddy.erl b/src/mod_pubsub/node_buddy.erl index 78af0a00e..46f63ecdf 100644 --- a/src/mod_pubsub/node_buddy.erl +++ b/src/mod_pubsub/node_buddy.erl @@ -26,8 +26,6 @@ -module(node_buddy). -author('christophe.romain@process-one.net'). --include_lib("exmpp/include/exmpp.hrl"). - -include("pubsub.hrl"). -behaviour(gen_pubsub_node). @@ -130,8 +128,8 @@ delete_node(Removed) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/node_club.erl b/src/mod_pubsub/node_club.erl index a8988819f..b7bb7cd4e 100644 --- a/src/mod_pubsub/node_club.erl +++ b/src/mod_pubsub/node_club.erl @@ -27,7 +27,6 @@ -author('christophe.romain@process-one.net'). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -behaviour(gen_pubsub_node). @@ -128,8 +127,8 @@ delete_node(Removed) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/node_dag.erl b/src/mod_pubsub/node_dag.erl index 768e50cbd..7f92cbc57 100644 --- a/src/mod_pubsub/node_dag.erl +++ b/src/mod_pubsub/node_dag.erl @@ -53,128 +53,417 @@ get_item/2, set_item/1, get_item_name/3, - node_to_path/1, - path_to_node/1]). + node_to_path/1, + path_to_node/1]). +-spec(init/3 :: + ( + Host :: string(), + ServerHost :: string(), + Opts :: [{Key::atom(), Value::term()}]) + -> 'ok' + ). + init(Host, ServerHost, Opts) -> node_flat:init(Host, ServerHost, Opts). + +-spec(terminate/2 :: + ( + Host :: string(), + ServerHost :: string()) + -> 'ok' + ). + terminate(Host, ServerHost) -> node_flat:terminate(Host, ServerHost). + +-spec(options/0 :: () -> [nodeOption()]). + options() -> - [{node_type, leaf} | node_flat:options()]. + [{'node_type', 'leaf'} | node_flat:options()]. + + +-spec(features/0 :: () -> [Feature::string()]). features() -> ["multi-collection" | node_flat:features()]. -create_node_permission(_Host, _ServerHost, _Node, _ParentNode, - _Owner, _Access) -> - {result, true}. -create_node(NodeID, Owner) -> - node_flat:create_node(NodeID, Owner). +-spec(create_node_permission/6 :: + ( + Host :: hostPubsub(), + ServerHost :: string(), + NodeId :: nodeId(), + ParentNodeId :: nodeId(), + JID :: jidEntity(), + Access :: atom()) + -> {'result', 'true'} + ). -delete_node(Removed) -> - node_flat:delete_node(Removed). +create_node_permission(_Host, _ServerHost, _NodeId, _ParentNodeId, + _JID, _Access) -> + {result, true}. -subscribe_node(NodeID, Sender, Subscriber, AccessModel, + +-spec(create_node/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', {'default', 'broadcast'}} + ). + +create_node(NodeIdx, JID) -> + node_flat:create_node(NodeIdx, JID). + + +-spec(delete_node/1 :: + ( + Nodes :: [Node::pubsubNode()]) + -> {result, {'default', 'broadcast', + Reply :: [{Node :: pubsubNode(), + [{Owner :: bareUsr(), + Subscriptions :: [{Subscription :: subscription(), + SubId :: subId()}]}]}]}} + ). + +delete_node(Nodes) -> + node_flat:delete_node(Nodes). + + +-spec(subscribe_node/8 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscriber :: jidEntity(), + AccessModel :: accessModel(), + SendLast :: atom(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + Options :: [nodeOption()]) + -> {'result', {'default', + Subscription :: 'subscribed', + SubId :: subId()}} + | {'result', {'default', + Subscription :: 'subscribed', + SubId :: subId(), + SendLast ::' send_last'}} + | {'result', {'default', + Subscription :: 'pending', + SubId :: subId()}} + | {'error', _} %% TODO add all error cases + ). + +subscribe_node(NodeIdx, JID, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> - node_flat:subscribe_node(NodeID, Sender, Subscriber, AccessModel, + node_flat:subscribe_node(NodeIdx, JID, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeID, Sender, Subscriber, SubID) -> - node_flat:unsubscribe_node(NodeID, Sender, Subscriber, SubID). -publish_item(NodeID, Publisher, Model, MaxItems, ItemID, Payload) -> +-spec(unsubscribe_node/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscriber :: jidEntity(), + SubId :: subId()) + -> {'result', 'default'} | {'error', _} %% TODO : add all error cases + ). + +unsubscribe_node(NodeIdx, JID, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeIdx, JID, Subscriber, SubId). + + +-spec(publish_item/6 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + PublishModel :: atom(), %% TODO : make a generic publishMod() type + MaxItems :: 'unlimited' | integer(), + ItemId :: itemId(), + Payload :: payload()) + -> {'result', {'default', 'broadcast', ItemIds :: [] | [itemId()]}} + | {'error', _} + ). + +publish_item(NodeIdx, JID, PublishModel, MaxItems, ItemId, Payload) -> %% TODO: should look up the NodeTree plugin here. There's no %% access to the Host of the request at this level, so for now we %% just use nodetree_dag. - case nodetree_dag:get_node(NodeID) of + case nodetree_dag:get_node(NodeIdx) of #pubsub_node{options = Options} -> - case find_opt(node_type, Options) of - collection -> + case find_opt('node_type', Options) of + 'collection' -> {error, mod_pubsub:extended_error('not-allowed', "publish")}; _ -> - node_flat:publish_item(NodeID, Publisher, Model, - MaxItems, ItemID, Payload) + node_flat:publish_item(NodeIdx, JID, PublishModel, + MaxItems, ItemId, Payload) end; - Err -> - Err + Error -> + Error end. -find_opt(_, []) -> false; -find_opt(Option, [{Option, Value} | _]) -> Value; -find_opt(Option, [_ | T]) -> find_opt(Option, T). -remove_extra_items(NodeID, MaxItems, ItemIDs) -> - node_flat:remove_extra_items(NodeID, MaxItems, ItemIDs). +-spec(find_opt/2 :: + ( + Key :: atom(), + Options :: [] | [Option::nodeOption()]) + -> Value :: 'false' | term() + ). -delete_item(NodeID, Publisher, PublishModel, ItemID) -> - node_flat:delete_item(NodeID, Publisher, PublishModel, ItemID). +find_opt(_, []) -> false; +find_opt(Key, [{Key, Value} | _]) -> Value; +find_opt(Key, [_ | Options]) -> find_opt(Key, Options). -purge_node(NodeID, Owner) -> - node_flat:purge_node(NodeID, Owner). -get_entity_affiliations(Host, Owner) -> - node_flat:get_entity_affiliations(Host, Owner). +-spec(remove_extra_items/3 :: + ( + NodeIdx :: nodeIdx(), + MaxItems :: 'unlimited' | integer(), + ItemsIds :: [ItemId::itemId()]) + -> {'result', + {OldItems :: [] | [ItemId::itemId()], + NewItems :: [] | [ItemId::itemId()]}} + ). -get_node_affiliations(NodeID) -> - node_flat:get_node_affiliations(NodeID). +remove_extra_items(NodeIdx, MaxItems, ItemIds) -> + node_flat:remove_extra_items(NodeIdx, MaxItems, ItemIds). -get_affiliation(NodeID, Owner) -> - node_flat:get_affiliation(NodeID, Owner). -set_affiliation(NodeID, Owner, Affiliation) -> - node_flat:set_affiliation(NodeID, Owner, Affiliation). +-spec(delete_item/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + PublishModel :: atom(), + ItemId :: itemId()) + -> {'result', {'default', 'broadcast'}} | {'error', _} + ). -get_entity_subscriptions(Host, Owner) -> - node_flat:get_entity_subscriptions(Host, Owner). +delete_item(NodeIdx, JID, PublishModel, ItemId) -> + node_flat:delete_item(NodeIdx, JID, PublishModel, ItemId). -get_node_subscriptions(NodeID) -> - node_flat:get_node_subscriptions(NodeID). -get_subscriptions(NodeID, Owner) -> - node_flat:get_subscriptions(NodeID, Owner). +-spec(purge_node/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', {'default', 'broadcast'}} | {'error', 'forbidden'} + ). -set_subscriptions(NodeID, Owner, Subscription, SubID) -> - node_flat:set_subscriptions(NodeID, Owner, Subscription, SubID). +purge_node(NodeIdx, JID) -> + node_flat:purge_node(NodeIdx, JID). -get_pending_nodes(Host, Owner) -> - node_flat:get_pending_nodes(Host, Owner). -get_states(NodeID) -> - node_flat:get_states(NodeID). +-spec(get_entity_affiliations/2 :: + ( + Host :: binary(), + JID :: jidEntity()) + -> {'result', Reply :: [] | [{Node::pubsubNode(), Affiliation::affiliation()}]} + ). -get_state(NodeID, JID) -> - node_flat:get_state(NodeID, JID). +get_entity_affiliations(Host, JID) -> + node_flat:get_entity_affiliations(Host, JID). -set_state(State) -> - node_flat:set_state(State). -get_items(NodeID, From) -> - node_flat:get_items(NodeID, From). +-spec(get_node_affiliations/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', [] | [{Entity::fullUsr(), Affiliation::affiliation()}]} + ). + +get_node_affiliations(NodeIdx) -> + node_flat:get_node_affiliations(NodeIdx). + + +-spec(get_affiliation/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', Affiliation::affiliation()} + ). + +get_affiliation(NodeIdx, JID) -> + node_flat:get_affiliation(NodeIdx, JID). + + +-spec(set_affiliation/3 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Affiliation :: affiliation()) + -> 'ok' | {error, 'internal-server-error'} + ). + +set_affiliation(NodeIdx, JID, Affiliation) -> + node_flat:set_affiliation(NodeIdx, JID, Affiliation). + + +-spec(get_entity_subscriptions/2 :: + ( + Host :: hostPubsub(), + JID :: jidEntity()) + -> {'result', [] + | [{Node :: pubsubNode(), + Subscription :: subscription(), + SubId :: subId(), + Entity :: fullUsr()}]} + ). + +get_entity_subscriptions(Host, JID) -> + node_flat:get_entity_subscriptions(Host, JID). -get_items(NodeID, JID, AccessModel, PresenceSubscription, - RosterGroup, SubID) -> - node_flat:get_items(NodeID, JID, AccessModel, PresenceSubscription, - RosterGroup, SubID). -get_item(NodeID, ItemID) -> - node_flat:get_item(NodeID, ItemID). +-spec(get_node_subscriptions/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', [] + | [{Entity::fullUsr(), 'none'}] + | [{Entity::fullUsr(), Subscription::subscription(), SubId::subId()}]} + ). + +get_node_subscriptions(NodeIdx) -> + node_flat:get_node_subscriptions(NodeIdx). + + +-spec(get_subscriptions/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', Subscriptions :: [] | [{Subscription::subscription(), SubId::subId()}]} + ). + +get_subscriptions(NodeIdx, JID) -> + node_flat:get_subscriptions(NodeIdx, JID). + + +-spec(set_subscriptions/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscription :: subscription(), + SubId :: subId()) + -> 'ok' + | {Subscription::subscription(), SubId::subId()} + | {error, _} + ). + +set_subscriptions(NodeIdx, JID, Subscription, SubId) -> + node_flat:set_subscriptions(NodeIdx, JID, Subscription, SubId). + + +-spec(get_pending_nodes/2 :: + ( + Host :: hostPubsub(), + JID :: jidEntity()) + -> 'false' | {'value', NodeId::nodeId()} + ). + +get_pending_nodes(Host, JID) -> + node_flat:get_pending_nodes(Host, JID). + + +-spec(get_states/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', States :: [] | [State::pubsubState()]} + ). + +get_states(NodeIdx) -> + node_flat:get_states(NodeIdx). + + +-spec(get_state/2 :: + ( + NodeIdx :: nodeIdx(), + Entity :: fullUsr()) + -> State::pubsubState() + ). + +get_state(NodeIdx, Entity) -> + node_flat:get_state(NodeIdx, Entity). + + +-spec(set_state/1 :: + ( + State :: pubsubState()) + -> 'ok' | {error, 'internal-server-error'} + ). + +set_state(State) -> + node_flat:set_state(State). + -get_item(NodeID, ItemID, JID, AccessModel, PresenceSubscription, - RosterGroup, SubID) -> - node_flat:get_item(NodeID, ItemID, JID, AccessModel, - PresenceSubscription, RosterGroup, SubID). +-spec(get_items/2 :: + ( + NodeIdx :: nodeIdx(), + Entity :: fullUsr()) + -> {'result', Items :: [] | [Item::pubsubItem()]} + ). + +get_items(NodeIdx, Entity) -> + node_flat:get_items(NodeIdx, Entity). + + +-spec(get_items/6 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + AccessModel :: accessModel(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + SubId :: subId()) + -> {'result', Items :: [] | [Item::pubsubItem()]} + | {'error', _} + ). + +get_items(NodeIdx, JID, AccessModel, PresenceSubscription, + RosterGroup, SubId) -> + node_flat:get_items(NodeIdx, JID, AccessModel, PresenceSubscription, + RosterGroup, SubId). + + +-spec(get_item/2 :: + ( + NodeIdx :: nodeIdx(), + ItemId :: itemId()) + -> {'result', Item::pubsubItem()} | {'error', 'item-not-found'} + ). + +get_item(NodeIdx, ItemId) -> + node_flat:get_item(NodeIdx, ItemId). + + +-spec(get_item/7 :: + ( + NodeIdx :: nodeIdx(), + ItemId :: itemId(), + JID :: jidEntity(), + AccessModel :: accessModel(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + SubId :: subId()) + -> {'result', Item::pubsubItem()} | {'error', 'item-not-found'} + ). + +get_item(NodeIdx, ItemId, JID, AccessModel, PresenceSubscription, + RosterGroup, SubId) -> + node_flat:get_item(NodeIdx, ItemId, JID, AccessModel, + PresenceSubscription, RosterGroup, SubId). + + +-spec(set_item/1 :: + ( + Item :: pubsubItem()) + -> 'ok' | {error, 'internal-server-error'} + ). set_item(Item) -> node_flat:set_item(Item). -get_item_name(Host, Node, ID) -> - node_flat:get_item_name(Host, Node, ID). +get_item_name(Host, Node, ItemId) -> + node_flat:get_item_name(Host, Node, ItemId). node_to_path(Node) -> node_flat:node_to_path(Node). diff --git a/src/mod_pubsub/node_dispatch.erl b/src/mod_pubsub/node_dispatch.erl index 1876d0c06..b5b8419c6 100644 --- a/src/mod_pubsub/node_dispatch.erl +++ b/src/mod_pubsub/node_dispatch.erl @@ -27,7 +27,6 @@ -author('christophe.romain@process-one.net'). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -behaviour(gen_pubsub_node). @@ -126,13 +125,13 @@ subscribe_node(_NodeId, _Sender, _Subscriber, _AccessModel, _SendLast, _PresenceSubscription, _RosterGroup, _Options) -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'forbidden')}. -unsubscribe_node(_NodeId, _Sender, _Subscriber, _SubID) -> +unsubscribe_node(_NodeId, _Sender, _Subscriber, _SubId) -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'forbidden')}. publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> lists:foreach(fun(SubNode) -> node_flat:publish_item( - SubNode#pubsub_node.id, Publisher, Model, + SubNode#pubsub_node.idx, Publisher, Model, MaxItems, ItemId, Payload) end, nodetree_tree:get_subnodes(NodeId, Publisher, Publisher)). diff --git a/src/mod_pubsub/node_flat.erl b/src/mod_pubsub/node_flat.erl index 985bc9421..1d1096461 100644 --- a/src/mod_pubsub/node_flat.erl +++ b/src/mod_pubsub/node_flat.erl @@ -42,13 +42,15 @@ -author('christophe.romain@process-one.net'). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -behaviour(gen_pubsub_node). %% API definition --export([init/3, terminate/2, - options/0, features/0, +-export([ + init/3, + terminate/2, + options/0, + features/0, create_node_permission/6, create_node/2, delete_node/1, @@ -80,6 +82,7 @@ path_to_node/1 ]). + %% ================ %% API definition %% ================ @@ -93,6 +96,14 @@ %% <p>This function is mainly used to trigger the setup task necessary for the %% plugin. It can be used for example by the developer to create the specific %% module database schema if it does not exists yet.</p> +-spec(init/3 :: + ( + Host :: string(), + ServerHost :: string(), + Opts :: [{Key::atom(), Value::term()}]) + -> 'ok' + ). + init(_Host, _ServerHost, _Opts) -> pubsub_subscription:init(), mnesia:create_table(pubsub_state, @@ -104,8 +115,7 @@ init(_Host, _ServerHost, _Opts) -> ItemsFields = record_info(fields, pubsub_item), case mnesia:table_info(pubsub_item, attributes) of ItemsFields -> ok; - _ -> - mnesia:transform_table(pubsub_item, ignore, ItemsFields) + _ -> mnesia:transform_table(pubsub_item, ignore, ItemsFields) end, ok. @@ -114,6 +124,13 @@ init(_Host, _ServerHost, _Opts) -> %% ServerHost = host() %% @doc <p>Called during pubsub modules termination. Any pubsub plugin must %% implement this function. It can return anything.</p> +-spec(terminate/2 :: + ( + Host :: string(), + ServerHost :: string()) + -> 'ok' + ). + terminate(_Host, _ServerHost) -> ok. @@ -134,27 +151,31 @@ terminate(_Host, _ServerHost) -> %% {max_payload_size, 100000}, %% {send_last_published_item, never}, %% {presence_based_delivery, false}]''' +-spec(options/0 :: () -> [nodeOption()]). + options() -> - [{deliver_payloads, true}, - {notify_config, false}, - {notify_delete, false}, - {notify_retract, true}, - {notify_sub, false}, - {purge_offline, false}, - {persist_items, true}, - {max_items, ?MAXITEMS}, - {subscribe, true}, - {access_model, open}, - {roster_groups_allowed, []}, - {publish_model, publishers}, - {notification_type, headline}, - {max_payload_size, ?MAX_PAYLOAD_SIZE}, - {send_last_published_item, on_sub_and_presence}, - {deliver_notifications, true}, - {presence_based_delivery, false}]. + [{'deliver_payloads', true}, + {'notify_config', false}, + {'notify_delete', false}, + {'notify_retract', true}, + {'notify_sub', false}, + {'purge_offline', false}, + {'persist_items', true}, + {'max_items', ?MAXITEMS}, + {'subscribe', true}, + {'access_model', open}, + {'roster_groups_allowed', []}, + {'publish_model', publishers}, + {'notification_type', headline}, + {'max_payload_size', ?MAX_PAYLOAD_SIZE}, + {'send_last_published_item', on_sub_and_presence}, + {'deliver_notifications', true}, + {'presence_based_delivery', false}]. %% @spec () -> [] %% @doc Returns the node features +-spec(features/0 :: () -> [Feature::string()]). + features() -> ["create-nodes", "auto-create", @@ -182,47 +203,67 @@ features() -> %% use same code as node_flat, but do not limite node to %% the home/localhost/user/... hierarchy %% any node is allowed -create_node_permission(Host, ServerHost, _Node, _ParentNode, Owner, Access) -> - LOwner = jlib:short_prepd_jid(Owner), - Allowed = case LOwner of - {undefined, Host, undefined} -> - true; % pubsub service always allowed - _ -> - {LU, LS, LR} = LOwner, - acl:match_rule(ServerHost, Access, exmpp_jid:make(LU, LS, LR)) =:= allow - end, - {result, Allowed}. +-spec(create_node_permission/6 :: + ( + Host :: hostPubsub(), + ServerHost :: string(), + NodeId :: nodeId(), + ParentNodeId :: nodeId(), + JID :: jidEntity(), + Access :: atom()) + -> {'result', IsAllowed::boolean()} + ). + +create_node_permission(Host, ServerHost, _NodeId, _ParentNodeId, #jid{node = U, domain = S, resource = R} = JID, Access) -> + Owner = {U,S,R}, + IsAllowed = case Owner of + {undefined, Host, undefined} -> true; % pubsub service always allowed + _ -> acl:match_rule(ServerHost, Access, JID) =:= 'allow' + end, + {result, IsAllowed}. %% @spec (NodeId, Owner) -> %% {result, Result} | exit -%% NodeId = mod_pubsub:pubsubNodeId() -%% Owner = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Owner = ljid() %% @doc <p></p> -create_node(NodeId, Owner) -> - OwnerKey = jlib:short_prepd_bare_jid(Owner), - set_state(#pubsub_state{stateid = {OwnerKey, NodeId}, affiliation = owner}), - {result, {default, broadcast}}. +-spec(create_node/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', {'default', 'broadcast'}} + ). + +create_node(NodeIdx, #jid{node = U, domain = S} = _JID) -> + set_state(#pubsub_state{id = {{U,S,undefined}, NodeIdx}, affiliation = 'owner'}), + {'result', {'default', 'broadcast'}}. %% @spec (Removed) -> ok -%% Removed = [mod_pubsub:pubsubNode()] +%% Removed = [mod_pubsub:pubsub_node()] %% @doc <p>purge items of deleted nodes after effective deletion.</p> -delete_node(Removed) -> - Tr = fun(#pubsub_state{stateid = {J, _}, subscriptions = Ss}) -> - lists:map(fun(S) -> - {J, S} - end, Ss) - end, - Reply = lists:map( - fun(#pubsub_node{id = NodeId} = PubsubNode) -> - {result, States} = get_states(NodeId), - lists:foreach( - fun(#pubsub_state{stateid = {LJID, _}, items = Items}) -> - del_items(NodeId, Items), - del_state(NodeId, LJID) - end, States), - {PubsubNode, lists:flatmap(Tr, States)} - end, Removed), - {result, {default, broadcast, Reply}}. +-spec(delete_node/1 :: + ( + Nodes :: [Node::pubsubNode()]) + -> {result, {'default', 'broadcast', + Reply :: [{Node :: pubsubNode(), + [{Owner :: bareUsr(), + Subscriptions :: [{Subscription :: subscription(), + SubId :: subId()}]}]}]}} + ). + +delete_node(Nodes) -> + Fun = fun(#pubsub_state{id = {Entity, _}, subscriptions = Subscriptions}) -> + [{Entity, Subscription} || Subscription <- Subscriptions] + end, + Reply = lists:map(fun(#pubsub_node{idx = NodeIdx} = Node) -> + {result, States} = get_states(NodeIdx), + lists:foreach(fun(#pubsub_state{id = {Owner, _}, items = ItemIds}) -> + del_items(NodeIdx, ItemIds), + del_state(NodeIdx, Owner), + {Node, lists:flatmap(Fun, States)} + end, States) + end, Nodes), + {'result', {'default', 'broadcast', Reply}}. %% @spec (NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> %% {error, Reason} | {result, Result} @@ -257,153 +298,189 @@ delete_node(Removed) -> %% to completly disable persistance.</li></ul> %% </p> %% <p>In the default plugin module, the record is unchanged.</p> -subscribe_node(NodeId, Sender, {U,S,R} = Subscriber, AccessModel, - SendLast, PresenceSubscription, RosterGroup, Options) -> +-spec(subscribe_node/8 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscriber :: jidEntity(), + AccessModel :: accessModel(), + SendLast :: atom(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + Options :: [nodeOption()]) + -> {'result', {'default', + Subscription :: 'subscribed', + SubId :: subId()}} + | {'result', {'default', + Subscription :: 'subscribed', + SubId :: subId(), + SendLast ::' send_last'}} + | {'result', {'default', + Subscription :: 'pending', + SubId :: subId()}} + | {'error', _} %% TODO add all error cases + ). + +subscribe_node(NodeIdx, #jid{node = Usender, domain = Ssender} = _Sender, #jid{node = U, domain = S, resource = R} = Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> SubKey = {U, S, R}, GenKey = {U, S, undefined}, - Authorized = (jlib:short_prepd_bare_jid(Sender) == GenKey), - GenState = get_state(NodeId, GenKey), - SubState = case SubKey of - GenKey -> GenState; - _ -> get_state(NodeId, SubKey) - end, - Affiliation = GenState#pubsub_state.affiliation, - Subscriptions = SubState#pubsub_state.subscriptions, - Whitelisted = lists:member(Affiliation, [member, publisher, owner]), - PendingSubscription = lists:any(fun({pending, _}) -> true; - (_) -> false - end, Subscriptions), + Authorized = ({Usender, Ssender, undefined} == GenKey), + GenState = #pubsub_state{affiliation = Affiliation} = get_state(NodeIdx, GenKey), + SubState = #pubsub_state{subscriptions = Subscriptions} = case SubKey of + GenKey -> GenState; + _ -> get_state(NodeIdx, SubKey) + end, + Whitelisted = lists:member(Affiliation, ['member', 'publisher', 'owner']), + PendingSubscription = lists:any(fun + ({'pending', _}) -> true; + (_) -> false + end, Subscriptions), if not Authorized -> %% JIDs do not match - {error, ?ERR_EXTENDED('bad-request', "invalid-jid")}; - Affiliation == outcast -> + {'error', ?ERR_EXTENDED('bad-request', "invalid-jid")}; + Affiliation == 'outcast' -> %% Requesting entity is blocked - {error, 'forbidden'}; + {'error', 'forbidden'}; PendingSubscription -> %% Requesting entity has pending subscription - {error, ?ERR_EXTENDED('not-authorized', "pending-subscription")}; - (AccessModel == presence) and (not PresenceSubscription) -> + {'error', ?ERR_EXTENDED('not-authorized', "pending-subscription")}; + (AccessModel == 'presence') and (not PresenceSubscription) -> %% Entity is not authorized to create a subscription (presence subscription required) - {error, ?ERR_EXTENDED('not-authorized', "presence-subscription-required")}; - (AccessModel == roster) and (not RosterGroup) -> + {'error', ?ERR_EXTENDED('not-authorized', "presence-subscription-required")}; + (AccessModel == 'roster') and (not RosterGroup) -> %% Entity is not authorized to create a subscription (not in roster group) - {error, ?ERR_EXTENDED('not-authorized', "not-in-roster-group")}; - (AccessModel == whitelist) and (not Whitelisted) -> + {'error', ?ERR_EXTENDED('not-authorized', "not-in-roster-group")}; + (AccessModel == 'whitelist') and (not Whitelisted) -> %% Node has whitelist access model and entity lacks required affiliation - {error, ?ERR_EXTENDED('not-allowed', "closed-node")}; + {'error', ?ERR_EXTENDED('not-allowed', "closed-node")}; %%MustPay -> - %% % Payment is required for a subscription - %% {error, ?ERR_PAYMENT_REQUIRED}; + %% Payment is required for a subscription + %% {'error', ?ERR_PAYMENT_REQUIRED}; %%ForbiddenAnonymous -> - %% % Requesting entity is anonymous - %% {error, 'forbidden'}; + %% Requesting entity is anonymous + %% {'error', 'forbidden'}; true -> - case pubsub_subscription:subscribe_node(Subscriber, NodeId, Options) of - {result, SubId} -> - NewSub = case AccessModel of - authorize -> pending; - _ -> subscribed - end, - set_state(SubState#pubsub_state{subscriptions = [{NewSub, SubId} | Subscriptions]}), - case {NewSub, SendLast} of - {subscribed, never} -> - {result, {default, subscribed, SubId}}; - {subscribed, _} -> - {result, {default, subscribed, SubId, send_last}}; - {_, _} -> - {result, {default, pending, SubId}} + case pubsub_subscription:subscribe_node(Subscriber, NodeIdx, Options) of + {'result', SubId} -> + NewSubscription = case AccessModel of + 'authorize' -> 'pending'; + _ -> 'subscribed' + end, + set_state(SubState#pubsub_state{subscriptions = [{NewSubscription, SubId} | Subscriptions]}), + case {NewSubscription, SendLast} of + {'subscribed', 'never'} -> {'result', {'default', 'subscribed', SubId}}; + {'subscribed', _} -> {'result', {'default', 'subscribed', SubId, 'send_last'}}; + {_, _} -> {'result', {'default', 'pending', SubId}} end; _ -> - {error, 'internal-server-error'} + {'error', 'internal-server-error'} end end. %% @spec (NodeId, Sender, Subscriber, SubId) -> %% {error, Reason} | {result, []} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Sender = mod_pubsub:jid() -%% Subscriber = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Sender = ljid() +%% Subscriber = ljid() %% SubId = mod_pubsub:subid() %% Reason = mod_pubsub:stanzaError() %% @doc <p>Unsubscribe the <tt>Subscriber</tt> from the <tt>Node</tt>.</p> -unsubscribe_node(NodeId, Sender, {U, S, R} = Subscriber, SubId) -> +-spec(unsubscribe_node/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscriber :: jidEntity(), + SubId :: subId()) + -> {'result', 'default'} | {'error', _} %% TODO : add all error cases + ). + +unsubscribe_node(NodeIdx, #jid{node = Usender, domain = Ssender} = _Sender, #jid{node = U, domain = S, resource = R} = _Subscriber, SubId) -> SubKey = {U, S, R}, GenKey = {U, S, undefined}, - Authorized = (jlib:short_prepd_bare_jid(Sender) == GenKey), - GenState = get_state(NodeId, GenKey), + Authorized = ({Usender, Ssender, undefined} == GenKey), + GenState = get_state(NodeIdx, GenKey), SubState = case SubKey of - GenKey -> GenState; - _ -> get_state(NodeId, SubKey) - end, - Subscriptions = lists:filter(fun({_Sub, _SubId}) -> true; - (_SubId) -> false - end, SubState#pubsub_state.subscriptions), + GenKey -> GenState; + _ -> get_state(NodeIdx, SubKey) + end, + Subscriptions = SubState#pubsub_state.subscriptions, SubIdExists = case SubId of - [] -> false; - List when is_list(List) -> true; - _ -> false + <<>> -> false; + SubId when is_binary(SubId) -> true; + _ -> false end, if %% Requesting entity is prohibited from unsubscribing entity not Authorized -> - {error, 'forbidden'}; + {'error', 'forbidden'}; %% Entity did not specify SubId %%SubId == "", ?? -> - %% {error, ?ERR_EXTENDED('bad-request', "subid-required")}; + %% {'error', ?ERR_EXTENDED('bad-request', "subid-required")}; %% Invalid subscription identifier %%InvalidSubId -> - %% {error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; + %% {'error', ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; %% Requesting entity is not a subscriber Subscriptions == [] -> - {error, ?ERR_EXTENDED('unexpected-request', "not-subscribed")}; + {'error', ?ERR_EXTENDED('unexpected-request', "not-subscribed")}; %% Subid supplied, so use that. SubIdExists -> - Sub = first_in_list(fun({_, Id}) when Id == SubId -> true; - (_) -> false - end, Subscriptions), - case Sub of - {value, Subscribed} -> - delete_subscriptions(Subscriber, NodeId, [Subscribed], SubState), - {result, default}; + OldSubscription = first_in_list(fun + ({_, OldSubId}) when OldSubId == SubId -> true; + (_) -> false + end, Subscriptions), + case OldSubscription of + {'value', Subscribed} -> + delete_subscriptions(SubKey, NodeIdx, [Subscribed], SubState), + {'result', 'default'}; false -> - {error, ?ERR_EXTENDED('unexpected-request', "not-subscribed")} + {'error', ?ERR_EXTENDED('unexpected-request', "not-subscribed")} end; %% Asking to remove all subscriptions to the given node - SubId == all -> - delete_subscriptions(SubKey, NodeId, Subscriptions, SubState), - {result, default}; + SubId == 'all' -> + delete_subscriptions(SubKey, NodeIdx, Subscriptions, SubState), + {'result', 'default'}; %% No subid supplied, but there's only one matching %% subscription, so use that. length(Subscriptions) == 1 -> - delete_subscriptions(SubKey, NodeId, Subscriptions, SubState), - {result, default}; + delete_subscriptions(SubKey, NodeIdx, Subscriptions, SubState), + {'result', 'default'}; true -> - {error, ?ERR_EXTENDED('bad-request', "subid-required")} + {'error', ?ERR_EXTENDED('bad-request', "subid-required")} end. -delete_subscriptions(SubKey, NodeId, Subscriptions, SubState) -> - NewSubs = lists:foldl(fun({Subscription, SubId}, Acc) -> - pubsub_subscription:delete_subscription(SubKey, NodeId, SubId), - Acc -- [{Subscription, SubId}] - end, SubState#pubsub_state.subscriptions, Subscriptions), - case {SubState#pubsub_state.affiliation, NewSubs} of - {none, []} -> - % Just a regular subscriber, and this is final item, so - % delete the state. - del_state(NodeId, SubKey); + +-spec(delete_subscriptions/4 :: + ( + Entity :: fullUsr(), + NodeIdx :: nodeIdx(), + Subscriptions :: [{Subscription::subscription(), SubId::subId()}], + State :: pubsubState()) + -> 'ok' | {error, 'internal-server-error'} + ). + +delete_subscriptions(Entity, NodeIdx, Subscriptions, State) -> + NewSubscriptions = lists:foldl(fun({Subscription, SubId}, Acc) -> + pubsub_subscription:delete_subscription(Entity, NodeIdx, SubId), + Acc -- [{Subscription, SubId}] + end, State#pubsub_state.subscriptions, Subscriptions), + case {State#pubsub_state.affiliation, NewSubscriptions} of + {'none', []} -> + % Just a regular subscriber, and this is final item, so + % delete the state. + del_state(NodeIdx, Entity); _ -> - set_state(SubState#pubsub_state{subscriptions = NewSubs}) + set_state(State#pubsub_state{subscriptions = NewSubscriptions}) end. %% @spec (NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) -> %% {true, PubsubItem} | {result, Reply} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Publisher = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Publisher = ljid() %% PublishModel = atom() %% MaxItems = integer() -%% ItemId = string() +%% ItemId = item() %% Payload = term() %% @doc <p>Publishes the item passed as parameter.</p> %% <p>The mechanism works as follow: @@ -435,53 +512,64 @@ delete_subscriptions(SubKey, NodeId, Subscriptions, SubState) -> %% to completly disable persistance.</li></ul> %% </p> %% <p>In the default plugin module, the record is unchanged.</p> -publish_item(NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) -> - SubKey = jlib:short_prepd_jid(Publisher), - GenKey = jlib:short_prepd_bare_jid(Publisher), - GenState = get_state(NodeId, GenKey), +-spec(publish_item/6 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + PublishModel :: atom(), %% TODO : make a generic publishMod() type + MaxItems :: 'unlimited' | integer(), + ItemId :: itemId(), + Payload :: payload()) + -> {'result', {'default', 'broadcast', ItemIds :: [] | [itemId()]}} + | {'error', _} + ). + +publish_item(NodeIdx, #jid{node = U, domain = S, resource = R} = _JID, PublishModel, MaxItems, ItemId, Payload) -> + SubKey = {U,S,R}, + GenKey = {U,S,undefined}, + GenState = get_state(NodeIdx, GenKey), SubState = case SubKey of - GenKey -> GenState; - _ -> get_state(NodeId, SubKey) - end, + GenKey -> GenState; + _ -> get_state(NodeIdx, SubKey) + end, Affiliation = GenState#pubsub_state.affiliation, Subscribed = case PublishModel of - subscribers -> is_subscribed(SubState#pubsub_state.subscriptions); - _ -> undefined - end, + 'subscribers' -> is_subscribed(SubState#pubsub_state.subscriptions); + _ -> undefined + end, if - not ((PublishModel == open) - or ((PublishModel == publishers) - and ((Affiliation == owner) or (Affiliation == publisher))) - or (Subscribed == true)) -> + not ((PublishModel == 'open') or ((PublishModel == 'publishers') + and ((Affiliation == 'owner') or (Affiliation == 'publisher'))) + or (Subscribed == 'true')) -> %% Entity does not have sufficient privileges to publish to node - {error, 'forbidden'}; + {'error', 'forbidden'}; true -> %% TODO: check creation, presence, roster if MaxItems > 0 -> - Now = now(), - PubId = {Now, SubKey}, - Item = case get_item(NodeId, ItemId) of - {result, OldItem} -> - OldItem#pubsub_item{modification = PubId, - payload = Payload}; - _ -> - #pubsub_item{itemid = {ItemId, NodeId}, - creation = {Now, GenKey}, - modification = PubId, - payload = Payload} - end, - Items = [ItemId | GenState#pubsub_state.items--[ItemId]], - {result, {NI, OI}} = remove_extra_items(NodeId, MaxItems, Items), - set_item(Item), - set_state(GenState#pubsub_state{items = NI}), - {result, {default, broadcast, OI}}; + Now = now(), + Modification = {Now, SubKey}, + Item = case get_item(NodeIdx, ItemId) of + {'result', OldItem} -> + OldItem#pubsub_item{modification = Modification, payload = Payload}; + _ -> + #pubsub_item{ + id = {ItemId, NodeIdx}, + creation = {Now, GenKey}, % TODO, better use {Now, SubKey} ? + modification = Modification, + payload = Payload} + end, + Items = [ItemId | GenState#pubsub_state.items--[ItemId]], + {result, {NewItems, OldItems}} = remove_extra_items(NodeIdx, MaxItems, Items), + set_item(Item), + set_state(GenState#pubsub_state{items = NewItems}), + {'result', {'default', 'broadcast', OldItems}}; true -> - {result, {default, broadcast, []}} + {'result', {'default', 'broadcast', []}} end end. %% @spec (NodeId, MaxItems, ItemIds) -> {NewItemIds,OldItemIds} -%% NodeId = mod_pubsub:pubsubNodeId() +%% NodeId = nodeidx() %% MaxItems = integer() | unlimited %% ItemIds = [ItemId::string()] %% NewItemIds = [ItemId::string()] @@ -495,67 +583,84 @@ publish_item(NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) -> %% plugin is using the default pubsub storage), it can implements this function like this: %% ```remove_extra_items(NodeId, MaxItems, ItemIds) -> %% node_default:remove_extra_items(NodeId, MaxItems, ItemIds).'''</p> -remove_extra_items(_NodeId, unlimited, ItemIds) -> - {result, {ItemIds, []}}; -remove_extra_items(NodeId, MaxItems, ItemIds) -> +-spec(remove_extra_items/3 :: + ( + NodeIdx :: nodeIdx(), + MaxItems :: 'unlimited' | integer(), + ItemsIds :: [ItemId::itemId()]) + -> {'result', + {OldItems :: [] | [ItemId::itemId()], + NewItems :: [] | [ItemId::itemId()]}} + ). + +remove_extra_items(_NodeIdx, 'unlimited', ItemIds) -> + {'result', {ItemIds, []}}; +remove_extra_items(NodeIdx, MaxItems, ItemIds) -> NewItems = lists:sublist(ItemIds, MaxItems), OldItems = lists:nthtail(length(NewItems), ItemIds), %% Remove extra items: - del_items(NodeId, OldItems), + del_items(NodeIdx, OldItems), %% Return the new items list: - {result, {NewItems, OldItems}}. + {'result', {NewItems, OldItems}}. %% @spec (NodeId, Publisher, PublishModel, ItemId) -> %% {error, Reason::stanzaError()} | %% {result, []} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Publisher = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Publisher = ljid() %% PublishModel = atom() -%% ItemId = string() +%% ItemId = item() %% @doc <p>Triggers item deletion.</p> %% <p>Default plugin: The user performing the deletion must be the node owner %% or a publisher, or PublishModel being open.</p> -delete_item(NodeId, Publisher, PublishModel, ItemId) -> - GenKey = jlib:short_prepd_bare_jid(Publisher), - GenState = get_state(NodeId, GenKey), - #pubsub_state{affiliation = Affiliation, items = Items} = GenState, - Allowed = (Affiliation == publisher) orelse (Affiliation == owner) - orelse (PublishModel == open) - orelse case get_item(NodeId, ItemId) of +-spec(delete_item/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + PublishModel :: atom(), + ItemId :: itemId()) + -> {'result', {'default', 'broadcast'}} | {'error', _} + ). + +delete_item(NodeIdx, #jid{node = U, domain = S} = _JID, PublishModel, ItemId) -> + GenKey = {U,S,undefined}, + GenState = #pubsub_state{affiliation = Affiliation, items = Items} = get_state(NodeIdx, GenKey), + Allowed = (Affiliation == 'publisher') + orelse (Affiliation == 'owner') + orelse (PublishModel == 'open') + orelse case get_item(NodeIdx, ItemId) of {result, #pubsub_item{creation = {_, GenKey}}} -> true; - _ -> false + _ -> false end, if not Allowed -> %% Requesting entity does not have sufficient privileges - {error, 'forbidden'}; + {'error', 'forbidden'}; true -> case lists:member(ItemId, Items) of true -> - del_item(NodeId, ItemId), + del_item(NodeIdx, ItemId), set_state(GenState#pubsub_state{items = lists:delete(ItemId, Items)}), - {result, {default, broadcast}}; + {'result', {'default', 'broadcast'}}; false -> case Affiliation of - owner -> + 'owner' -> %% Owner can delete other publishers items as well - {result, States} = get_states(NodeId), - lists:foldl( - fun(#pubsub_state{items = PI, affiliation = publisher} = S, Res) -> - case lists:member(ItemId, PI) of - true -> - del_item(NodeId, ItemId), - set_state(S#pubsub_state{items = lists:delete(ItemId, PI)}), - {result, {default, broadcast}}; - false -> - Res - end; - (_, Res) -> - Res - end, {error, 'item-not-found'}, States); + {'result', States} = get_states(NodeIdx), + lists:foldl(fun + (#pubsub_state{items = ItemIds, affiliation = publisher} = State, Result) -> + case lists:member(ItemId, ItemIds) of + true -> + del_item(NodeIdx, ItemId), + set_state(State#pubsub_state{items = lists:delete(ItemId, ItemIds)}), + {'result', {'default', 'broadcast'}}; + false -> Result + end; + (_, Result) -> Result + end, {'error', 'item-not-found'}, States); _ -> %% Non-existent node or item - {error, 'item-not-found'} + {'error', 'item-not-found'} end end end. @@ -563,30 +668,36 @@ delete_item(NodeId, Publisher, PublishModel, ItemId) -> %% @spec (NodeId, Owner) -> %% {error, Reason::stanzaError()} | %% {result, {default, broadcast}} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Owner = mod_pubsub:jid() -purge_node(NodeId, Owner) -> - GenKey = jlib:short_prepd_bare_jid(Owner), - GenState = get_state(NodeId, GenKey), - case GenState of - #pubsub_state{affiliation = owner} -> - {result, States} = get_states(NodeId), - lists:foreach( - fun(#pubsub_state{items = []}) -> - ok; - (#pubsub_state{items = Items} = S) -> - del_items(NodeId, Items), - set_state(S#pubsub_state{items = []}) - end, States), - {result, {default, broadcast}}; - _ -> - %% Entity is not owner - {error, 'forbidden'} +%% NodeId = nodeidx() +%% Owner = ljid() +-spec(purge_node/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', {'default', 'broadcast'}} | {'error', 'forbidden'} + ). + +purge_node(NodeIdx, #jid{node = U, domain = S} = _JID) -> + %GenKey = {U,S,undefined} + %GenState = get_state(NodeIdx, _GenKey = {U,S,undefined}), + case _GenState = get_state(NodeIdx, _GenKey = {U,S,undefined}) of % experimental + #pubsub_state{affiliation = 'owner'} -> + {'result', States} = get_states(NodeIdx), + lists:foreach(fun + (#pubsub_state{items = []}) -> + ok; + (#pubsub_state{items = Items} = State) -> + del_items(NodeIdx, Items), + set_state(State#pubsub_state{items = []}) + end, States), + {'result', {'default', 'broadcast'}}; + _ -> %% Entity is not owner + {'error', 'forbidden'} end. %% @spec (Host, JID) -> [{Node,Affiliation}] %% Host = host() -%% JID = mod_pubsub:jid() +%% JID = ljid() %% @doc <p>Return the current affiliations for the given user</p> %% <p>The default module reads affiliations in the main Mnesia %% <tt>pubsub_state</tt> table. If a plugin stores its data in the same @@ -594,46 +705,74 @@ purge_node(NodeId, Owner) -> %% the default PubSub module. Otherwise, it should return its own affiliation, %% that will be added to the affiliation stored in the main %% <tt>pubsub_state</tt> table.</p> -get_entity_affiliations(Host, Owner) -> - GenKey = jlib:short_prepd_bare_jid(Owner), - States = mnesia:match_object(#pubsub_state{stateid = {GenKey, '_'}, _ = '_'}), - NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of - [{nodetree, N}] -> N; - _ -> nodetree_tree - end, - Reply = lists:foldl(fun(#pubsub_state{stateid = {_, N}, affiliation = A}, Acc) -> - case NodeTree:get_node(N) of - #pubsub_node{nodeid = {Host, _}} = Node -> [{Node, A}|Acc]; - _ -> Acc - end - end, [], States), +-spec(get_entity_affiliations/2 :: + ( + Host :: binary(), + JID :: jidEntity()) + -> {'result', Reply :: [] | [{Node::pubsubNode(), Affiliation::affiliation()}]} + ). + +get_entity_affiliations(Host, #jid{node = U, domain = S} = _JID) -> + States = mnesia:match_object(#pubsub_state{id = {{U,S,undefined}, '_'}, _ = '_'}), + NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, 'config'), 'nodetree') of + [{'nodetree', Tree}] -> Tree; + _ -> 'nodetree_tree' + end, + Reply = lists:foldl(fun + (#pubsub_state{id = {_, NodeIdx}, affiliation = Affiliation}, Acc) -> + case NodeTree:get_node(NodeIdx) of + #pubsub_node{id = {Host, _}} = Node -> [{Node, Affiliation}|Acc]; + _ -> Acc + end + end, [], States), {result, Reply}. -get_node_affiliations(NodeId) -> - {result, States} = get_states(NodeId), - Tr = fun(#pubsub_state{stateid = {J, _}, affiliation = A}) -> - {J, A} - end, - {result, lists:map(Tr, States)}. - -get_affiliation(NodeId, Owner) -> - GenKey = jlib:short_prepd_bare_jid(Owner), - GenState = get_state(NodeId, GenKey), - {result, GenState#pubsub_state.affiliation}. - -set_affiliation(NodeId, Owner, Affiliation) when ?IS_JID(Owner)-> - GenKey = jlib:short_prepd_bare_jid(Owner), - GenState = get_state(NodeId, GenKey), - case {Affiliation, GenState#pubsub_state.subscriptions} of - {none, none} -> - del_state(NodeId, GenKey); - _ -> - set_state(GenState#pubsub_state{affiliation = Affiliation}) + +-spec(get_node_affiliations/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', [] | [{Entity::fullUsr(), Affiliation::affiliation()}]} + ). + +get_node_affiliations(NodeIdx) -> + {result, States} = get_states(NodeIdx), + Fun = fun(#pubsub_state{id = {Entity, _}, affiliation = Affiliation}) -> + {Entity, Affiliation} + end, + {result, lists:map(Fun, States)}. + + +-spec(get_affiliation/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', Affiliation::affiliation()} + ). + +get_affiliation(NodeIdx, #jid{node = U, domain = S} = _JID) -> + #pubsub_state{affiliation = Affiliation} = get_state(NodeIdx, _GenKey = {U,S,undefined}), + {'result', Affiliation}. + + +-spec(set_affiliation/3 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Affiliation :: affiliation()) + -> 'ok' | {error, 'internal-server-error'} + ). + +set_affiliation(NodeIdx, #jid{node = U, domain = S} = _JID, Affiliation) -> + GenKey = {U,S,undefined}, + GenState = #pubsub_state{subscriptions = Subscriptions} = get_state(NodeIdx, GenKey), + case {Affiliation, Subscriptions} of + {'none', []} -> del_state(NodeIdx, GenKey); + _ -> set_state(GenState#pubsub_state{affiliation = Affiliation}) end. %% @spec (Host, Owner) -> [{Node,Subscription}] %% Host = host() -%% Owner = mod_pubsub:jid() +%% Owner = ljid() %% @doc <p>Return the current subscriptions for the given user</p> %% <p>The default module reads subscriptions in the main Mnesia %% <tt>pubsub_state</tt> table. If a plugin stores its data in the same @@ -641,157 +780,228 @@ set_affiliation(NodeId, Owner, Affiliation) when ?IS_JID(Owner)-> %% the default PubSub module. Otherwise, it should return its own affiliation, %% that will be added to the affiliation stored in the main %% <tt>pubsub_state</tt> table.</p> -get_entity_subscriptions(Host, Owner) -> - {U, D, _} = SubKey = jlib:short_prepd_jid(Owner), - GenKey = jlib:short_prepd_bare_jid(Owner), +-spec(get_entity_subscriptions/2 :: + ( + Host :: hostPubsub(), + JID :: jidEntity()) + -> {'result', [] + | [{Node :: pubsubNode(), + Subscription :: subscription(), + SubId :: subId(), + Entity :: fullUsr()}]} + ). + +get_entity_subscriptions(Host, #jid{node = U, domain = S, resource = R} = _JID) -> + SubKey = {U,S,R}, + GenKey = {U,S,undefined}, States = case SubKey of - GenKey -> mnesia:match_object( - #pubsub_state{stateid = {{U, D, '_'}, '_'}, _ = '_'}); - _ -> mnesia:match_object( - #pubsub_state{stateid = {GenKey, '_'}, _ = '_'}) - ++ mnesia:match_object( - #pubsub_state{stateid = {SubKey, '_'}, _ = '_'}) - end, - NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of - [{nodetree, N}] -> N; - _ -> nodetree_tree - end, - Reply = lists:foldl(fun(#pubsub_state{stateid = {J, N}, subscriptions = Ss}, Acc) -> - case NodeTree:get_node(N) of - #pubsub_node{nodeid = {Host, _}} = Node -> - lists:foldl(fun({Sub, SubId}, Acc2) -> - [{Node, Sub, SubId, J} | Acc2]; - (S, Acc2) -> - [{Node, S, J} | Acc2] - end, Acc, Ss); - _ -> Acc - end - end, [], States), + GenKey -> + mnesia:match_object(#pubsub_state{id = {{U, S, '_'}, '_'}, _ = '_'}); + _ -> + mnesia:match_object(#pubsub_state{id = {GenKey, '_'}, _ = '_'}) + ++ + mnesia:match_object(#pubsub_state{id = {SubKey, '_'}, _ = '_'}) + end, + NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, 'config'), 'nodetree') of + [{'nodetree', Tree}] -> Tree; + _ -> 'nodetree_tree' + end, + Reply = lists:foldl(fun + (#pubsub_state{id = {Entity, NodeIdx}, subscriptions = Subscriptions}, Acc) -> + case NodeTree:get_node(NodeIdx) of + #pubsub_node{id = {Host, _}} = Node -> + lists:foldl(fun + ({Subscription, SubId}, Acc2) -> [{Node, Subscription, SubId, Entity} | Acc2] + %(Subscriptions, Acc2) -> [{Node, Subscription, Entity} | Acc2] + end, Acc, Subscriptions); + _ -> Acc + end + end, [], States), {result, Reply}. -get_node_subscriptions(NodeId) -> - {result, States} = get_states(NodeId), - Tr = fun(#pubsub_state{stateid = {J, _}, subscriptions = Subscriptions}) -> - %% TODO: get rid of cases to handle non-list subscriptions - case Subscriptions of - [_|_] -> - lists:foldl(fun({S, SubId}, Acc) -> - [{J, S, SubId} | Acc]; - (S, Acc) -> - [{J, S} | Acc] - end, [], Subscriptions); - [] -> - []; - _ -> - [{J, none}] - end - end, - {result, lists:flatmap(Tr, States)}. - -get_subscriptions(NodeId, Owner) -> - SubKey = jlib:short_prepd_jid(Owner), - SubState = get_state(NodeId, SubKey), - {result, SubState#pubsub_state.subscriptions}. - -set_subscriptions(NodeId, Owner, Subscription, SubId) -> - SubKey = jlib:short_prepd_jid(Owner), - SubState = get_state(NodeId, SubKey), - case {SubId, SubState#pubsub_state.subscriptions} of + +-spec(get_node_subscriptions/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', [] + | [{Entity::fullUsr(), 'none'}] + %| [{Entity::fullUsr(), Subscription::subscription()}] %% still useful case ? + | [{Entity::fullUsr(), Subscription::subscription(), SubId::subId()}]} + ). + +get_node_subscriptions(NodeIdx) -> + {result, States} = get_states(NodeIdx), + Fun = fun(#pubsub_state{id = {Entity, _}, subscriptions = Subscriptions}) -> + [{Entity, Subscription, SubId} || {Subscription, SubId} <- Subscriptions] + end, + {result, lists:flatmap(Fun, States)}. + + +-spec(get_subscriptions/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', Subscriptions :: [] | [{Subscription::subscription(), SubId::subId()}]} + ). + +get_subscriptions(NodeIdx, #jid{node = U, domain = S, resource = R} = _JID) -> + #pubsub_state{subscriptions = Subscriptions} = get_state(NodeIdx, _SubKey = {U,S,R}), + {result, Subscriptions}. + + +-spec(set_subscriptions/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscription :: subscription(), + SubId :: subId()) + -> 'ok' + | {Subscription::subscription(), SubId::subId()} + | {error, _} + ). + +set_subscriptions(NodeIdx, #jid{node = U, domain = S, resource = R} = JID, Subscription, SubId) -> + SubKey = {U,S,R}, + SubState = #pubsub_state{subscriptions = Subscriptions} = get_state(NodeIdx, SubKey), + case {SubId, Subscriptions} of {_, []} -> case Subscription of - none -> {error, ?ERR_EXTENDED('bad_request', "not-subscribed")}; - _ -> new_subscription(NodeId, Owner, Subscription, SubState) + 'none' -> {'error', ?ERR_EXTENDED('bad_request', "not-subscribed")}; + _ -> new_subscription(NodeIdx, JID, Subscription, SubState) end; - {"", [{_, SID}]} -> + {<<>>, [{_, OtherSubId}]} -> case Subscription of - none -> unsub_with_subid(NodeId, SID, SubState); - _ -> replace_subscription({Subscription, SID}, SubState) + 'none' -> unsub_with_subid(NodeIdx, OtherSubId, SubState); + _ -> replace_subscription({Subscription, OtherSubId}, SubState) end; - {"", [_|_]} -> + {<<>>, [_|_]} -> {error, ?ERR_EXTENDED('bad_request', "subid-required")}; _ -> case Subscription of - none -> unsub_with_subid(NodeId, SubId, SubState); - _ -> replace_subscription({Subscription, SubId}, SubState) + 'none' -> unsub_with_subid(NodeIdx, SubId, SubState); + _ -> replace_subscription({Subscription, SubId}, SubState) end end. -replace_subscription(NewSub, SubState) -> - NewSubs = replace_subscription(NewSub, - SubState#pubsub_state.subscriptions, []), - set_state(SubState#pubsub_state{subscriptions = NewSubs}). +-spec(replace_subscription/2 :: + ( + NewSubscription :: {Subscription::subscription(), SubId::subId()}, + SubState :: pubsubState()) + -> 'ok' | {error, 'internal-server-error'} + ). + +replace_subscription(NewSubcription, #pubsub_state{subscriptions = Subscriptions} = SubState) -> + NewSubcriptions = replace_subscription(NewSubcription, Subscriptions, []), + set_state(SubState#pubsub_state{subscriptions = NewSubcriptions}). + + +-spec(replace_subscription/3 :: + ( + NewSubscription :: {Subscription::subscription(), SubId::subId()}, + Subscriptions :: [{Subscription::subscription(), SubId::subId()}], + Acc :: [] | [{Subscription::subscription(), SubId::subId()}]) + -> NewSubscriptions :: [] | [{Subscription::subscription(), SubId::subId()}] + ). +%% TODO : add clause case in -spec replace_subscription(_, [], Acc) -> Acc; -replace_subscription({Sub, SubId}, [{_, SubID} | T], Acc) -> - replace_subscription({Sub, SubId}, T, [{Sub, SubID} | Acc]). +replace_subscription({Subcription, SubId}, [{_, SubId} | OtherSubcriptions], Acc) -> + replace_subscription({Subcription, SubId}, OtherSubcriptions, [{Subcription, SubId} | Acc]). -new_subscription(NodeId, Owner, Subscription, SubState) -> - SubId = pubsub_subscription:add_subscription(Owner, NodeId, []), - Subscriptions = SubState#pubsub_state.subscriptions, + +-spec(new_subscription/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscriptions :: subscription(), + SubState :: pubsubState()) + -> {Subscription::subscription(), SubId::subId()} + ). + +new_subscription(NodeIdx, #jid{node = U, domain = S, resource = R} = _JID, Subscription, #pubsub_state{subscriptions = Subscriptions} = SubState) -> + SubId = pubsub_subscription:add_subscription({U,S,R}, NodeIdx, []), set_state(SubState#pubsub_state{subscriptions = [{Subscription, SubId} | Subscriptions]}), {Subscription, SubId}. -unsub_with_subid(NodeId, SubId, SubState) -> - pubsub_subscription:delete_subscription(SubState#pubsub_state.stateid, - NodeId, SubId), - NewSubs = lists:filter(fun ({_, SID}) -> SubId =/= SID end, - SubState#pubsub_state.subscriptions), - case {NewSubs, SubState#pubsub_state.affiliation} of - {[], none} -> - del_state(NodeId, element(1, SubState#pubsub_state.stateid)); - _ -> - set_state(SubState#pubsub_state{subscriptions = NewSubs}) + +-spec(unsub_with_subid/3 :: + ( + NodeIdx :: nodeIdx(), + SubId :: subId(), + SubState :: pubsubState()) + -> 'ok' | {'error', 'internal-server-error'} + ). + +unsub_with_subid(NodeIdx, SubId, #pubsub_state{id = {Entity, _}} = SubState) -> + pubsub_subscription:delete_subscription(Entity, NodeIdx, SubId), + NewSubcriptions = lists:filter(fun + ({_, SID}) -> SubId =/= SID + end, SubState#pubsub_state.subscriptions), + case {NewSubcriptions, SubState#pubsub_state.affiliation} of + {[], 'none'} -> del_state(NodeIdx, Entity); + _ -> set_state(SubState#pubsub_state{subscriptions = NewSubcriptions}) end. + %% @spec (Host, Owner) -> {result, [Node]} | {error, Reason} %% Host = host() %% Owner = jid() -%% Node = pubsubNode() +%% Node = node() %% @doc <p>Returns a list of Owner's nodes on Host with pending %% subscriptions.</p> -get_pending_nodes(Host, Owner) -> - GenKey = jlib:short_prepd_bare_jid(Owner), - States = mnesia:match_object(#pubsub_state{stateid = {GenKey, '_'}, - affiliation = owner, - _ = '_'}), - NodeIDs = [ID || #pubsub_state{stateid = {_, ID}} <- States], - NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of - [{nodetree, N}] -> N; - _ -> nodetree_tree +-spec(get_pending_nodes/2 :: + ( + Host :: hostPubsub(), + JID :: jidEntity()) + -> 'false' | {'value', NodeId::nodeId()} + ). + +get_pending_nodes(Host, #jid{node = U, domain = S} = _JID) -> + States = mnesia:match_object( + #pubsub_state{id = {{U,S,undefined}, '_'}, affiliation = 'owner', _ = '_'}), + NodeIdxs = [NodeIdx || #pubsub_state{id = {_, NodeIdx}} <- States], + NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, 'config'), 'nodetree') of + [{'nodetree', Tree}] -> Tree; + _ -> 'nodetree_tree' end, - Reply = mnesia:foldl(fun(#pubsub_state{stateid = {_, NID}} = S, Acc) -> - case lists:member(NID, NodeIDs) of - true -> - case get_nodes_helper(NodeTree, S) of - {value, Node} -> [Node | Acc]; - false -> Acc - end; - false -> - Acc - end - end, [], pubsub_state), + Reply = mnesia:foldl(fun + (#pubsub_state{id = {_, NodeIdx}} = State, Acc) -> + case lists:member(NodeIdx, NodeIdxs) of + true -> + case get_nodes_helper(NodeTree, State) of + {value, NodeId} -> [NodeId | Acc]; + false -> Acc + end; + false -> Acc + end + end, [], pubsub_state), {result, Reply}. -get_nodes_helper(NodeTree, - #pubsub_state{stateid = {_, N}, subscriptions = Subs}) -> - HasPending = fun ({pending, _}) -> true; - (pending) -> true; - (_) -> false - end, - case lists:any(HasPending, Subs) of - true -> - case NodeTree:get_node(N) of - #pubsub_node{nodeid = {_, Node}} -> - {value, Node}; - _ -> - false - end; - false -> - false - end. + +-spec(get_nodes_helper/2 :: + ( + NodeTree :: atom(), + State :: pubsubState()) + -> 'false' | {'value', NodeId::nodeId()} + ). + +get_nodes_helper(NodeTree, #pubsub_state{id = {_, NodeIdx}, subscriptions = Subscriptions}) -> + HasPending = fun + ({'pending', _}) -> 'true'; + %('pending') -> 'true'; %% Not useful anymore + (_) -> 'false' + end, +case lists:any(HasPending, Subscriptions) of + true -> + case NodeTree:get_node(NodeIdx) of + #pubsub_node{id = {_, NodeId}} -> {value, NodeId}; + _ -> false + end; + false -> false +end. %% @spec (NodeId) -> {result, [State] | []} -%% NodeId = mod_pubsub:pubsubNodeId() +%% NodeId = nodeidx() %% State = mod_pubsub:pubsubState() %% @doc Returns the list of stored states for a given node. %% <p>For the default PubSub module, states are stored in Mnesia database.</p> @@ -803,43 +1013,66 @@ get_nodes_helper(NodeTree, %% they can implement this function like this: %% ```get_states(NodeId) -> %% node_default:get_states(NodeId).'''</p> -get_states(NodeId) -> - States = case catch mnesia:match_object( - #pubsub_state{stateid = {'_', NodeId}, _ = '_'}) of - List when is_list(List) -> List; - _ -> [] - end, +-spec(get_states/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', States :: [] | [State::pubsubState()]} + ). + +get_states(NodeIdx) -> + States = case + catch mnesia:match_object(#pubsub_state{id = {'_', NodeIdx}, _ = '_'}) + of + PubsubStates when is_list(PubsubStates) -> PubsubStates; %% is_list(PubsubStates) useful ? + _ -> [] + end, {result, States}. %% @spec (NodeId, JID) -> [State] | [] -%% NodeId = mod_pubsub:pubsubNodeId() -%% JID = mod_pubsub:jid() -%% State = mod_pubsub:pubsubItems() +%% NodeId = nodeidx() +%% JID = ljid() +%% State = mod_pubsub:pubsub_item() %% @doc <p>Returns a state (one state list), given its reference.</p> -get_state(NodeId, JID) -> - StateId = {JID, NodeId}, - case catch mnesia:read({pubsub_state, StateId}) of - [State] when is_record(State, pubsub_state) -> State; - _ -> #pubsub_state{stateid=StateId} +-spec(get_state/2 :: + ( + NodeIdx :: nodeIdx(), + Entity :: fullUsr()) + -> State::pubsubState() + ). + +get_state(NodeIdx, Entity) -> + case catch mnesia:read({pubsub_state, {Entity, NodeIdx}}) of + [#pubsub_state{} = State] -> State; + _ -> #pubsub_state{id = {Entity, NodeIdx}} end. %% @spec (State) -> ok | {error, Reason::stanzaError()} -%% State = mod_pubsub:pubsubStates() +%% State = mod_pubsub:pubsub_state() %% @doc <p>Write a state into database.</p> -set_state(State) when is_record(State, pubsub_state) -> - mnesia:write(State); -set_state(_) -> - {error, 'internal-server-error'}. +-spec(set_state/1 :: + ( + State :: pubsubState()) + -> 'ok' | {error, 'internal-server-error'} + ). +set_state(#pubsub_state{} = State) -> mnesia:write(State); +set_state(_) -> {error, 'internal-server-error'}. %% @spec (NodeId, JID) -> ok | {error, Reason::stanzaError()} -%% NodeId = mod_pubsub:pubsubNodeId() +%% NodeId = nodeidx() %% @doc <p>Delete a state from database.</p> -del_state(NodeId, JID) -> - mnesia:delete({pubsub_state, {JID, NodeId}}). +-spec(del_state/2 :: + ( + NodeIdx :: nodeIdx(), + Entity :: fullUsr()) + -> 'ok' + ). + +del_state(NodeIdx, Entity) -> + mnesia:delete({pubsub_state, {Entity, NodeIdx}}). %% @spec (NodeId, From) -> [Items] | [] -%% NodeId = mod_pubsub:pubsubNodeId() -%% Items = mod_pubsub:pubsubItems() +%% NodeId = nodeidx() +%% Items = mod_pubsub:pubsub_item() %% @doc Returns the list of stored items for a given node. %% <p>For the default PubSub module, items are stored in Mnesia database.</p> %% <p>We can consider that the pubsub_item table have been created by the main @@ -850,111 +1083,171 @@ del_state(NodeId, JID) -> %% they can implement this function like this: %% ```get_items(NodeId, From) -> %% node_default:get_items(NodeId, From).'''</p> -get_items(NodeId, _From) -> - Items = mnesia:match_object(#pubsub_item{itemid = {'_', NodeId}, _ = '_'}), +-spec(get_items/2 :: + ( + NodeIdx :: nodeIdx(), + Entity :: fullUsr()) + -> {'result', Items :: [] | [Item::pubsubItem()]} + ). + +get_items(NodeIdx, _Entity) -> + Items = mnesia:match_object(#pubsub_item{id = {'_', NodeIdx}, _ = '_'}), {result, lists:reverse(lists:keysort(#pubsub_item.modification, Items))}. -get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) -> - SubKey = jlib:short_prepd_jid(JID), - GenKey = jlib:short_prepd_bare_jid(JID), - GenState = get_state(NodeId, GenKey), - SubState = get_state(NodeId, SubKey), + + +-spec(get_items/6 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + AccessModel :: accessModel(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + SubId :: subId()) + -> {'result', Items :: [] | [Item::pubsubItem()]} + | {'error', _} + ). + +get_items(NodeIdx, #jid{node = U, domain = S, resource = R} = _JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) -> + SubKey = {U,S,R}, + GenKey = {U,S,undefined}, + GenState = get_state(NodeIdx, GenKey), + SubState = get_state(NodeIdx, SubKey), Affiliation = GenState#pubsub_state.affiliation, Subscriptions = SubState#pubsub_state.subscriptions, Whitelisted = can_fetch_item(Affiliation, Subscriptions), if %%SubId == "", ?? -> - %% Entity has multiple subscriptions to the node but does not specify a subscription ID - %{error, ?ERR_EXTENDED('bad-request', "subid-required")}; + %% Entity has multiple subscriptions to the node but does not specify a subscription ID + %{error, ?ERR_EXTENDED('bad-request', "subid-required")}; %%InvalidSubId -> - %% Entity is subscribed but specifies an invalid subscription ID - %{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; - Affiliation == outcast -> + %% Entity is subscribed but specifies an invalid subscription ID + %{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; + Affiliation == 'outcast' -> %% Requesting entity is blocked - {error, 'forbidden'}; - (AccessModel == presence) and (not PresenceSubscription) -> + {'error', 'forbidden'}; + (AccessModel == 'presence') and (not PresenceSubscription) -> %% Entity is not authorized to create a subscription (presence subscription required) - {error, ?ERR_EXTENDED('not-authorized', "presence-subscription-required")}; - (AccessModel == roster) and (not RosterGroup) -> + {'error', ?ERR_EXTENDED('not-authorized', "presence-subscription-required")}; + (AccessModel == 'roster') and (not RosterGroup) -> %% Entity is not authorized to create a subscription (not in roster group) - {error, ?ERR_EXTENDED('not-authorized', "not-in-roster-group")}; - (AccessModel == whitelist) and (not Whitelisted) -> + {'error', ?ERR_EXTENDED('not-authorized', "not-in-roster-group")}; + (AccessModel == 'whitelist') and (not Whitelisted) -> %% Node has whitelist access model and entity lacks required affiliation - {error, ?ERR_EXTENDED('not-allowed', "closed-node")}; - (AccessModel == authorize) and (not Whitelisted) -> + {'error', ?ERR_EXTENDED('not-allowed', "closed-node")}; + (AccessModel == 'authorize') and (not Whitelisted) -> %% Node has authorize access model - {error, 'forbidden'}; + {'error', 'forbidden'}; %%MustPay -> - %% % Payment is required for a subscription - %% {error, ?ERR_PAYMENT_REQUIRED}; + %% % Payment is required for a subscription + %% {error, ?ERR_PAYMENT_REQUIRED}; true -> - get_items(NodeId, JID) + get_items(NodeIdx, {U,S,R}) end. %% @spec (NodeId, ItemId) -> [Item] | [] -%% NodeId = mod_pubsub:pubsubNodeId() -%% ItemId = string() -%% Item = mod_pubsub:pubsubItems() +%% NodeId = nodeidx() +%% ItemId = item() +%% Item = mod_pubsub:pubsub_item() %% @doc <p>Returns an item (one item list), given its reference.</p> -get_item(NodeId, ItemId) -> - case mnesia:read({pubsub_item, {ItemId, NodeId}}) of - [Item] when is_record(Item, pubsub_item) -> - {result, Item}; - _ -> - {error, 'item-not-found'} +-spec(get_item/2 :: + ( + NodeIdx :: nodeIdx(), + ItemId :: itemId()) + -> {'result', Item::pubsubItem()} | {'error', 'item-not-found'} + ). + +get_item(NodeIdx, ItemId) -> + case mnesia:read({pubsub_item, {ItemId, NodeIdx}}) of + [#pubsub_item{} = Item] -> {result, Item}; + _ -> {error, 'item-not-found'} end. -get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) -> - GenKey = jlib:short_prepd_bare_jid(JID), - GenState = get_state(NodeId, GenKey), + + +-spec(get_item/7 :: + ( + NodeIdx :: nodeIdx(), + ItemId :: itemId(), + JID :: jidEntity(), + AccessModel :: accessModel(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + SubId :: subId()) + -> {'result', Item::pubsubItem()} | {'error', 'item-not-found'} + ). + +get_item(NodeIdx, ItemId, #jid{node = U, domain = S} = _JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) -> + GenKey = {U,S,undefined}, + GenState = get_state(NodeIdx, GenKey), Affiliation = GenState#pubsub_state.affiliation, Subscriptions = GenState#pubsub_state.subscriptions, Whitelisted = can_fetch_item(Affiliation, Subscriptions), if %%SubId == "", ?? -> - %% Entity has multiple subscriptions to the node but does not specify a subscription ID - %{error, ?ERR_EXTENDED('bad-request', "subid-required")}; - %%InvalidSubID -> - %% Entity is subscribed but specifies an invalid subscription ID - %{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; - Affiliation == outcast -> + %% Entity has multiple subscriptions to the node but does not specify a subscription ID + %{error, ?ERR_EXTENDED('bad-request', "subid-required")}; + %%InvalidSubId -> + %% Entity is subscribed but specifies an invalid subscription ID + %{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; + Affiliation == 'outcast' -> %% Requesting entity is blocked - {error, 'forbidden'}; - (AccessModel == presence) and (not PresenceSubscription) -> + {'error', 'forbidden'}; + (AccessModel == 'presence') and (not PresenceSubscription) -> %% Entity is not authorized to create a subscription (presence subscription required) - {error, ?ERR_EXTENDED('not-authorized', "presence-subscription-required")}; - (AccessModel == roster) and (not RosterGroup) -> + {'error', ?ERR_EXTENDED('not-authorized', "presence-subscription-required")}; + (AccessModel == 'roster') and (not RosterGroup) -> %% Entity is not authorized to create a subscription (not in roster group) - {error, ?ERR_EXTENDED('not-authorized', "not-in-roster-group")}; - (AccessModel == whitelist) and (not Whitelisted) -> + {'error', ?ERR_EXTENDED('not-authorized', "not-in-roster-group")}; + (AccessModel == 'whitelist') and (not Whitelisted) -> %% Node has whitelist access model and entity lacks required affiliation - {error, ?ERR_EXTENDED('not-allowed', "closed-node")}; - (AccessModel == authorize) and (not Whitelisted) -> + {'error', ?ERR_EXTENDED('not-allowed', "closed-node")}; + (AccessModel == 'authorize') and (not Whitelisted) -> %% Node has authorize access model - {error, 'forbidden'}; + {'error', 'forbidden'}; %%MustPay -> - %% % Payment is required for a subscription - %% {error, ?ERR_PAYMENT_REQUIRED}; + %% % Payment is required for a subscription + %% {error, ?ERR_PAYMENT_REQUIRED}; true -> - get_item(NodeId, ItemId) + get_item(NodeIdx, ItemId) end. %% @spec (Item) -> ok | {error, Reason::stanzaError()} -%% Item = mod_pubsub:pubsubItems() +%% Item = mod_pubsub:pubsub_item() %% @doc <p>Write an item into database.</p> -set_item(Item) when is_record(Item, pubsub_item) -> - mnesia:write(Item); -set_item(_) -> - {error, 'internal-server-error'}. +-spec(set_item/1 :: + ( + Item :: pubsubItem()) + -> 'ok' | {error, 'internal-server-error'} + ). + +set_item(#pubsub_item{} = Item) -> mnesia:write(Item); +set_item(_) -> {error, 'internal-server-error'}. %% @spec (NodeId, ItemId) -> ok | {error, Reason::stanzaError()} -%% NodeId = mod_pubsub:pubsubNodeId() -%% ItemId = string() +%% NodeId = nodeidx() +%% ItemId = item() %% @doc <p>Delete an item from database.</p> -del_item(NodeId, ItemId) -> - mnesia:delete({pubsub_item, {ItemId, NodeId}}). -del_items(NodeId, ItemIds) -> +-spec(del_item/2 :: + ( + NodeIdx :: nodeIdx(), + ItemId :: itemId()) + -> 'ok' + ). + +del_item(NodeIdx, ItemId) -> + mnesia:delete({pubsub_item, {ItemId, NodeIdx}}). + + +-spec(del_items/2 :: + ( + NodeIdx :: nodeIdx(), + ItemIds :: [itemId()]) + -> 'ok' + ). + +del_items(NodeIdx, ItemIds) -> lists:foreach(fun(ItemId) -> - del_item(NodeId, ItemId) - end, ItemIds). + del_item(NodeIdx, ItemId) + end, ItemIds). %% @doc <p>Return the name of the node if known: Default is to return %% node id.</p> @@ -968,12 +1261,12 @@ path_to_node([]) -> <<>>; path_to_node(Path) -> case Path of - % default slot - [Node] -> Node; - % handle old possible entries, used when migrating database content to new format - [Node|_] when is_list(Node) -> list_to_binary(string:join([""|Path], "/")); - % default case (used by PEP for example) - _ -> list_to_binary(Path) + % default slot + [Node] -> Node; + % handle old possible entries, used when migrating database content to new format + [Node|_] when is_list(Node) -> list_to_binary(string:join([""|Path], "/")); + % default case (used by PEP for example) + _ -> list_to_binary(Path) end. %% @spec (Affiliation, Subscription) -> true | false @@ -981,24 +1274,45 @@ path_to_node(Path) -> %% Subscription = subscribed | none %% @doc Determines if the combination of Affiliation and Subscribed %% are allowed to get items from a node. -can_fetch_item(owner, _) -> true; -can_fetch_item(member, _) -> true; -can_fetch_item(publisher, _) -> true; -can_fetch_item(outcast, _) -> false; -can_fetch_item(none, Subscriptions) -> is_subscribed(Subscriptions); +-spec(can_fetch_item/2 :: + ( + Affiliation :: affiliation(), + Subscriptions :: [{subscription(), subId()}]) + -> CanFetchItem::boolean() + ). +%% TODO : add 'publish-only' case +can_fetch_item('owner', _) -> true; +can_fetch_item('member', _) -> true; +can_fetch_item('publisher',_) -> true; +can_fetch_item('outcast', _) -> false; +can_fetch_item('none', Subscriptions) -> is_subscribed(Subscriptions); can_fetch_item(_Affiliation, _Subscription) -> false. + +-spec(is_subscribed/1 :: + ( + Subscriptions :: [{Subscription::subscription(), SubId::subId()}]) + -> IsSubscribed::boolean() + ). + is_subscribed(Subscriptions) -> - lists:any(fun ({subscribed, _SubId}) -> true; - (_) -> false - end, Subscriptions). + lists:any(fun + ({'subscribed', _SubId}) -> true; + (_) -> false + end, Subscriptions). + %% Returns the first item where Pred() is true in List -first_in_list(_Pred, []) -> - false; -first_in_list(Pred, [H | T]) -> - case Pred(H) of - true -> {value, H}; - _ -> first_in_list(Pred, T) - end. +-spec(first_in_list/2 :: + ( + Predicate :: fun(), + Subscriptions :: [{Subscription::subscription(), SubId::subId()}]) + -> 'false' | {'value', {Subscription::subscription(), SubId::subId()}} + ). +first_in_list(_Predicate, []) -> false; +first_in_list(Predicate, [Subscription | OtherSubscriptions]) -> + case Predicate(Subscription) of + true -> {'value', Subscription}; + _ -> first_in_list(Predicate, OtherSubscriptions) + end. diff --git a/src/mod_pubsub/node_flat_odbc.erl b/src/mod_pubsub/node_flat_odbc.erl index 2a15af325..fa249df69 100644 --- a/src/mod_pubsub/node_flat_odbc.erl +++ b/src/mod_pubsub/node_flat_odbc.erl @@ -37,12 +37,11 @@ %%% development is still a work in progress. However, the system is already %%% useable and useful as is. Please, send us comments, feedback and %%% improvements.</p> - +%%TODO : fix SQL requests with nodeid/id and id/idx changes -module(node_flat_odbc). -author('christophe.romain@process-one.net'). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -include("jlib.hrl"). %% for rsm_in and rsm_out records definitions -define(PUBSUB, mod_pubsub_odbc). @@ -191,9 +190,9 @@ features() -> %% @spec (Host, ServerHost, Node, ParentNode, Owner, Access) -> bool() %% Host = mod_pubsub:host() %% ServerHost = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() -%% ParentNode = mod_pubsub:pubsubNode() -%% Owner = mod_pubsub:jid() +%% Node = mod_pubsub:node() +%% ParentNode = mod_pubsub:node() +%% Owner = ljid() %% Access = all | atom() %% @doc Checks if the current user has the permission to create the requested node %% <p>In {@link node_default}, the permission is decided by the place in the @@ -212,34 +211,27 @@ create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) -> %% @spec (NodeId, Owner) -> %% {result, Result} | exit -%% NodeId = mod_pubsub:pubsubNodeId() -%% Owner = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Owner = ljid() %% @doc <p></p> create_node(NodeId, Owner) -> OwnerKey = jlib:short_prepd_bare_jid(Owner), - State = #pubsub_state{stateid = {OwnerKey, NodeId}, affiliation = owner}, + State = #pubsub_state{id = {OwnerKey, NodeId}, affiliation = owner}, catch ejabberd_odbc:sql_query_t( ["insert into pubsub_state(nodeid, jid, affiliation, subscriptions) " "values(", state_to_raw(NodeId, State), ");"]), {result, {default, broadcast}}. %% @spec (Removed) -> ok -%% Removed = [mod_pubsub:pubsubNode()] +%% Removed = [mod_pubsub:node()] %% @doc <p>purge items of deleted nodes after effective deletion.</p> delete_node(Removed) -> -%% pablo: TODO, this is present on trunk/node_flat but not on trunk/node_flat_odbc. -%% check what is the desired behaviour -%% Tr = fun(#pubsub_state{stateid = {J, _}, subscriptions = Ss}) -> -%% lists:map(fun(S) -> -%% {J, S} -%% end, Ss) -%% end, Reply = lists:map( - fun(#pubsub_node{id = NodeId} = PubsubNode) -> + fun(#pubsub_node{idx = Nidx} = PubsubNode) -> Subscriptions = case catch ejabberd_odbc:sql_query_t( ["select jid, subscriptions " "from pubsub_state " - "where nodeid='", NodeId, ";"]) of + "where nodeid='", Nidx, ";"]) of {selected, ["jid", "subscriptions"], RItems} -> lists:map(fun({SJID, Subscriptions}) -> {decode_jid(SJID), decode_subscriptions(Subscriptions)} @@ -345,9 +337,9 @@ subscribe_node(NodeId, Sender, Subscriber, AccessModel, %% @spec (NodeId, Sender, Subscriber, SubId) -> %% {error, Reason} | {result, []} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Sender = mod_pubsub:jid() -%% Subscriber = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Sender = ljid() +%% Subscriber = ljid() %% SubId = mod_pubsub:subid() %% Reason = mod_pubsub:stanzaError() %% @doc <p>Unsubscribe the <tt>Subscriber</tt> from the <tt>Node</tt>.</p> @@ -417,11 +409,11 @@ delete_subscription(SubKey, NodeId, {Subscription, SubId}, Affiliation, Subscrip %% @spec (NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) -> %% {true, PubsubItem} | {result, Reply} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Publisher = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Publisher = ljid() %% PublishModel = atom() %% MaxItems = integer() -%% ItemId = string() +%% ItemId = item() %% Payload = term() %% @doc <p>Publishes the item passed as parameter.</p> %% <p>The mechanism works as follow: @@ -474,7 +466,7 @@ publish_item(NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) -> %% Note: this works cause set_item tries an update before %% the insert, and the update just ignore creation field. PubId = {now(), SubKey}, - set_item(#pubsub_item{itemid = {ItemId, NodeId}, + set_item(#pubsub_item{id = {ItemId, NodeId}, creation = {now(), GenKey}, modification = PubId, payload = Payload}), @@ -488,10 +480,10 @@ publish_item(NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) -> end. %% @spec (NodeId, MaxItems, ItemIds) -> {NewItemIds,OldItemIds} -%% NodeId = mod_pubsub:pubsubNodeId() +%% NodeId = nodeidx() %% MaxItems = integer() | unlimited -%% ItemIds = [ItemId::string()] -%% NewItemIds = [ItemId::string()] +%% ItemIds = [item()] +%% NewItemIds = [item()] %% @doc <p>This function is used to remove extra items, most notably when the %% maximum number of items has been reached.</p> %% <p>This function is used internally by the core PubSub module, as no @@ -515,10 +507,10 @@ remove_extra_items(NodeId, MaxItems, ItemIds) -> %% @spec (NodeId, Publisher, PublishModel, ItemId) -> %% {error, Reason::stanzaError()} | %% {result, []} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Publisher = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Publisher = ljid() %% PublishModel = atom() -%% ItemId = string() +%% ItemId = item() %% @doc <p>Triggers item deletion.</p> %% <p>Default plugin: The user performing the deletion must be the node owner %% or a publisher, or PublishModel being open.</p> @@ -549,8 +541,8 @@ delete_item(NodeId, Publisher, PublishModel, ItemId) -> %% @spec (NodeId, Owner) -> %% {error, Reason::stanzaError()} | %% {result, {default, broadcast}} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Owner = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Owner = ljid() purge_node(NodeId, Owner) -> GenKey = jlib:short_prepd_bare_jid(Owner), GenState = get_state(NodeId, GenKey), @@ -569,7 +561,7 @@ purge_node(NodeId, Owner) -> %% @spec (Host, JID) -> [{Node,Affiliation}] %% Host = host() -%% JID = mod_pubsub:jid() +%% JID = ljid() %% @doc <p>Return the current affiliations for the given user</p> %% <p>The default module reads affiliations in the main Mnesia %% <tt>pubsub_state</tt> table. If a plugin stores its data in the same @@ -632,7 +624,7 @@ set_affiliation(NodeId, Owner, Affiliation) when ?IS_JID(Owner)-> %% @spec (Host, Owner) -> [{Node,Subscription}] %% Host = host() -%% Owner = mod_pubsub:jid() +%% Owner = ljid() %% @doc <p>Return the current subscriptions for the given user</p> %% <p>The default module reads subscriptions in the main Mnesia %% <tt>pubsub_state</tt> table. If a plugin stores its data in the same @@ -664,13 +656,13 @@ get_entity_subscriptions(Host, Owner) -> {selected, ["node", "type", "nodeid", "jid", "subscriptions"], RItems} -> lists:foldl(fun({N, T, I, J, S}, Acc) -> Node = nodetree_tree_odbc:raw_to_node(Host, {N, "", T, I}), - Jid = decode_jid(J), + JID = decode_jid(J), case decode_subscriptions(S) of [] -> - [{Node, none, Jid}|Acc]; + [{Node, none, JID}|Acc]; Subs -> - lists:foldl(fun({Sub, SubId}, Acc2) -> [{Node, Sub, SubId, Jid}|Acc2]; - (Sub, Acc2) -> [{Node, Sub, Jid}|Acc2] + lists:foldl(fun({Sub, SubId}, Acc2) -> [{Node, Sub, SubId, JID}|Acc2]; + (Sub, Acc2) -> [{Node, Sub, JID}|Acc2] end, Acc, Subs) end end, [], RItems); @@ -707,13 +699,13 @@ get_entity_subscriptions_for_send_last(Host, Owner) -> {selected, ["node", "type", "nodeid", "jid", "subscriptions"], RItems} -> lists:foldl(fun({N, T, I, J, S}, Acc) -> Node = nodetree_tree_odbc:raw_to_node(Host, {N, "", T, I}), - Jid = decode_jid(J), + JID = decode_jid(J), case decode_subscriptions(S) of [] -> - [{Node, none, Jid}|Acc]; + [{Node, none, JID}|Acc]; Subs -> - lists:foldl(fun({Sub, SubId}, Acc2) -> [{Node, Sub, SubId, Jid}|Acc2]; - (Sub, Acc2) -> [{Node, Sub, Jid}|Acc2] + lists:foldl(fun({Sub, SubId}, Acc2) -> [{Node, Sub, SubId, JID}|Acc2]; + (Sub, Acc2) -> [{Node, Sub, JID}|Acc2] end, Acc, Subs) end end, [], RItems); @@ -729,13 +721,13 @@ get_node_subscriptions(NodeId) -> "where nodeid='", NodeId, "';"]) of {selected, ["jid", "subscriptions"], RItems} -> lists:foldl(fun({J, S}, Acc) -> - Jid = decode_jid(J), + JID = decode_jid(J), case decode_subscriptions(S) of [] -> - [{Jid, none}|Acc]; + [{JID, none}|Acc]; Subs -> - lists:foldl(fun({Sub, SubId}, Acc2) -> [{Jid, Sub, SubId}|Acc2]; - (Sub, Acc2) -> [{Jid, Sub}|Acc2] + lists:foldl(fun({Sub, SubId}, Acc2) -> [{JID, Sub, SubId}|Acc2]; + (Sub, Acc2) -> [{JID, Sub}|Acc2] end, Acc, Subs) end end, [], RItems); @@ -786,8 +778,8 @@ replace_subscription(NewSub, SubState) -> replace_subscription(_, [], Acc) -> Acc; -replace_subscription({Sub, SubId}, [{_, SubID} | T], Acc) -> - replace_subscription({Sub, SubId}, T, [{Sub, SubID} | Acc]). +replace_subscription({Sub, SubId}, [{_, SubId} | T], Acc) -> + replace_subscription({Sub, SubId}, T, [{Sub, SubId} | Acc]). new_subscription(NodeId, Owner, Subscription, SubState) -> case pubsub_subscription_odbc:subscribe_node(Owner, NodeId, []) of @@ -800,13 +792,13 @@ new_subscription(NodeId, Owner, Subscription, SubState) -> end. unsub_with_subid(NodeId, SubId, SubState) -> - pubsub_subscription_odbc:unsubscribe_node(SubState#pubsub_state.stateid, + pubsub_subscription_odbc:unsubscribe_node(SubState#pubsub_state.id, NodeId, SubId), NewSubs = lists:filter(fun ({_, SID}) -> SubId =/= SID end, SubState#pubsub_state.subscriptions), case {NewSubs, SubState#pubsub_state.affiliation} of {[], none} -> - del_state(NodeId, element(1, SubState#pubsub_state.stateid)); + del_state(NodeId, element(1, SubState#pubsub_state.id)); _ -> set_state(SubState#pubsub_state{subscriptions = NewSubs}) end. @@ -814,21 +806,21 @@ unsub_with_subid(NodeId, SubId, SubState) -> %% @spec (Host, Owner) -> {result, [Node]} | {error, Reason} %% Host = host() %% Owner = jid() -%% Node = pubsubNode() +%% Node = node() %% @doc <p>Returns a list of Owner's nodes on Host with pending %% subscriptions.</p> get_pending_nodes(Host, Owner) -> GenKey = jlib:short_prepd_bare_jid(Owner), - States = mnesia:match_object(#pubsub_state{stateid = {GenKey, '_'}, + States = mnesia:match_object(#pubsub_state{id = {GenKey, '_'}, affiliation = owner, _ = '_'}), - NodeIDs = [ID || #pubsub_state{stateid = {_, ID}} <- States], + Nidxs = [Nidx || #pubsub_state{id = {_, Nidx}} <- States], NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of [{nodetree, N}] -> N; _ -> nodetree_tree_odbc end, - Reply = mnesia:foldl(fun(#pubsub_state{stateid = {_, NID}} = S, Acc) -> - case lists:member(NID, NodeIDs) of + Reply = mnesia:foldl(fun(#pubsub_state{id = {_, Nidx}} = S, Acc) -> + case lists:member(Nidx, Nidxs) of true -> case get_nodes_helper(NodeTree, S) of {value, Node} -> [Node | Acc]; @@ -841,7 +833,7 @@ get_pending_nodes(Host, Owner) -> {result, Reply}. get_nodes_helper(NodeTree, - #pubsub_state{stateid = {_, N}, subscriptions = Subs}) -> + #pubsub_state{id = {_, N}, subscriptions = Subs}) -> HasPending = fun ({pending, _}) -> true; (pending) -> true; (_) -> false @@ -849,7 +841,7 @@ get_nodes_helper(NodeTree, case lists:any(HasPending, Subs) of true -> case NodeTree:get_node(N) of - #pubsub_node{nodeid = {_, Node}} -> + #pubsub_node{id = {_, Node}} -> {value, Node}; _ -> false @@ -859,7 +851,7 @@ get_nodes_helper(NodeTree, end. %% @spec (NodeId) -> {result, [State] | []} -%% NodeId = mod_pubsub:pubsubNodeId() +%% NodeId = nodeidx() %% State = mod_pubsub:pubsubState() %% @doc Returns the list of stored states for a given node. %% <p>For the default PubSub module, states are stored in Mnesia database.</p> @@ -878,7 +870,7 @@ get_states(NodeId) -> "where nodeid='", NodeId, "';"]) of {selected, ["jid", "affiliation", "subscriptions"], RItems} -> {result, lists:map(fun({SJID, Affiliation, Subscriptions}) -> - #pubsub_state{stateid = {decode_jid(SJID), NodeId}, + #pubsub_state{id = {decode_jid(SJID), NodeId}, items = itemids(NodeId, SJID), affiliation = decode_affiliation(Affiliation), subscriptions = decode_subscriptions(Subscriptions)} @@ -889,13 +881,13 @@ get_states(NodeId) -> %% @spec (NodeId, JID) -> [State] | [] -%% NodeId = mod_pubsub:pubsubNodeId() -%% JID = mod_pubsub:jid() -%% State = mod_pubsub:pubsubItems() +%% NodeId = nodeidx() +%% JID = ljid() +%% State = mod_pubsub:pubsub_state() %% @doc <p>Returns a state (one state list), given its reference.</p> get_state(NodeId, JID) -> State = get_state_without_itemids(NodeId, JID), - {SJID, _} = State#pubsub_state.stateid, + {SJID, _} = State#pubsub_state.id, State#pubsub_state{items = itemids(NodeId, SJID)}. get_state_without_itemids(NodeId, JID) -> J = encode_jid(JID), @@ -905,25 +897,25 @@ get_state_without_itemids(NodeId, JID) -> "where jid='", J, "' " "and nodeid='", NodeId, "';"]) of {selected, ["jid", "affiliation", "subscriptions"], [{SJID, Affiliation, Subscriptions}]} -> - #pubsub_state{stateid = {decode_jid(SJID), NodeId}, + #pubsub_state{id = {decode_jid(SJID), NodeId}, affiliation = decode_affiliation(Affiliation), subscriptions = decode_subscriptions(Subscriptions)}; _ -> - #pubsub_state{stateid={JID, NodeId}} + #pubsub_state{id={JID, NodeId}} end. %% @spec (State) -> ok | {error, Reason::stanzaError()} %% State = mod_pubsub:pubsubStates() %% @doc <p>Write a state into database.</p> set_state(State) when is_record(State, pubsub_state) -> - {_, NodeId} = State#pubsub_state.stateid, + {_, NodeId} = State#pubsub_state.id, set_state(NodeId, State). set_state(NodeId, State) -> %% NOTE: in odbc version, as we do not handle item list, %% we just need to update affiliation and subscription %% cause {JID,NodeId} is the key. if it does not exists, then we insert it. %% MySQL can be optimized using INSERT ... ON DUPLICATE KEY as well - {JID, _} = State#pubsub_state.stateid, + {JID, _} = State#pubsub_state.id, J = encode_jid(JID), S = encode_subscriptions(State#pubsub_state.subscriptions), A = encode_affiliation(State#pubsub_state.affiliation), @@ -941,7 +933,7 @@ set_state(NodeId, State) -> {result, []}. %% @spec (NodeId, JID) -> ok | {error, Reason::stanzaError()} -%% NodeId = mod_pubsub:pubsubNodeId() +%% NodeId = nodeidx() %% @doc <p>Delete a state from database.</p> del_state(NodeId, JID) -> J = encode_jid(JID), @@ -952,8 +944,8 @@ del_state(NodeId, JID) -> ok. %% @spec (NodeId, From) -> {[Items], RsmOut} | [] -%% NodeId = mod_pubsub:pubsubNodeId() -%% Items = mod_pubsub:pubsubItems() +%% NodeId = nodeidx() +%% Items = mod_pubsub:pubsub_item() %% @doc Returns the list of stored items for a given node. %% <p>For the default PubSub module, items are stored in Mnesia database.</p> %% <p>We can consider that the pubsub_item table have been created by the main @@ -1100,9 +1092,9 @@ get_last_items(NodeId, _From, Count) -> end. %% @spec (NodeId, ItemId) -> [Item] | [] -%% NodeId = mod_pubsub:pubsubNodeId() -%% ItemId = string() -%% Item = mod_pubsub:pubsubItems() +%% NodeId = nodeidx() +%% ItemId = item() +%% Item = mod_pubsub:pubsub_item() %% @doc <p>Returns an item (one item list), given its reference.</p> get_item(NodeId, ItemId) -> I = ?PUBSUB:escape(ItemId), @@ -1126,7 +1118,7 @@ get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, _S %%SubId == "", ?? -> %% Entity has multiple subscriptions to the node but does not specify a subscription ID %{error, ?ERR_EXTENDED('bad-request', "subid-required")}; - %%InvalidSubID -> + %%InvalidSubId -> %% Entity is subscribed but specifies an invalid subscription ID %{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; Affiliation == outcast -> @@ -1152,10 +1144,10 @@ get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, _S end. %% @spec (Item) -> ok | {error, Reason::stanzaError()} -%% Item = mod_pubsub:pubsubItems() +%% Item = mod_pubsub:pubsub_item() %% @doc <p>Write an item into database.</p> set_item(Item) -> - {ItemId, NodeId} = Item#pubsub_item.itemid, + {ItemId, NodeId} = Item#pubsub_item.id, I = ?PUBSUB:escape(ItemId), {C, _} = Item#pubsub_item.creation, {M, JID} = Item#pubsub_item.modification, @@ -1182,8 +1174,8 @@ set_item(Item) -> {result, []}. %% @spec (NodeId, ItemId) -> ok | {error, Reason::stanzaError()} -%% NodeId = mod_pubsub:pubsubNodeId() -%% ItemId = string() +%% NodeId = nodeidx() +%% ItemId = item() %% @doc <p>Delete an item from database.</p> del_item(NodeId, ItemId) -> I = ?PUBSUB:escape(ItemId), @@ -1337,7 +1329,7 @@ encode_subscriptions(Subscriptions) -> %%% record getter/setter state_to_raw(NodeId, State) -> - {JID, _} = State#pubsub_state.stateid, + {JID, _} = State#pubsub_state.id, J = encode_jid(JID), A = encode_affiliation(State#pubsub_state.affiliation), S = encode_subscriptions(State#pubsub_state.subscriptions), @@ -1353,7 +1345,7 @@ raw_to_item(NodeId, {ItemId, SJID, Creation, Modification, XML}) -> {error, _Reason} -> []; [El] -> [El] end, - #pubsub_item{itemid = {ItemId, NodeId}, + #pubsub_item{id = {ItemId, NodeId}, creation={ToTime(Creation), JID}, modification={ToTime(Modification), JID}, payload = Payload}. diff --git a/src/mod_pubsub/node_hometree.erl b/src/mod_pubsub/node_hometree.erl index 069f38599..901e6cc72 100644 --- a/src/mod_pubsub/node_hometree.erl +++ b/src/mod_pubsub/node_hometree.erl @@ -26,7 +26,6 @@ -author('christophe.romain@process-one.net'). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -behaviour(gen_pubsub_node). @@ -140,8 +139,8 @@ delete_node(Removed) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/node_hometree_odbc.erl b/src/mod_pubsub/node_hometree_odbc.erl index 2dd0503c5..711914511 100644 --- a/src/mod_pubsub/node_hometree_odbc.erl +++ b/src/mod_pubsub/node_hometree_odbc.erl @@ -26,7 +26,6 @@ -author('christophe.romain@process-one.net'). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -behaviour(gen_pubsub_node). @@ -111,8 +110,8 @@ delete_node(Removed) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> node_flat_odbc:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_flat_odbc:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat_odbc:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_flat_odbc:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/node_mb.erl b/src/mod_pubsub/node_mb.erl index 57d155558..162a1e96e 100644 --- a/src/mod_pubsub/node_mb.erl +++ b/src/mod_pubsub/node_mb.erl @@ -36,8 +36,6 @@ -module(node_mb). -author('eric@ohmforce.com'). --include_lib("exmpp/include/exmpp.hrl"). - -include("ejabberd.hrl"). -include("pubsub.hrl"). @@ -137,8 +135,8 @@ subscribe_node(NodeId, Sender, Subscriber, AccessModel, NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_pep:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_pep:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_pep:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/node_pep.erl b/src/mod_pubsub/node_pep.erl index 66522460b..1a4fb2aa5 100644 --- a/src/mod_pubsub/node_pep.erl +++ b/src/mod_pubsub/node_pep.erl @@ -29,8 +29,6 @@ -module(node_pep). -author('christophe.romain@process-one.net'). --include_lib("exmpp/include/exmpp.hrl"). - -include("ejabberd.hrl"). -include("pubsub.hrl"). @@ -70,15 +68,35 @@ path_to_node/1 ]). + +-spec(init/3 :: + ( + Host :: string(), + ServerHost :: string(), + Opts :: [{Key::atom(), Value::term()}]) + -> 'ok' + ). + init(Host, ServerHost, Opts) -> node_flat:init(Host, ServerHost, Opts), complain_if_modcaps_disabled(ServerHost), ok. + +-spec(terminate/2 :: + ( + Host :: string(), + ServerHost :: string()) + -> 'ok' + ). + terminate(Host, ServerHost) -> node_flat:terminate(Host, ServerHost), ok. + +-spec(options/0 :: () -> [nodeOption()]). + options() -> [{deliver_payloads, true}, {notify_config, false}, @@ -98,6 +116,9 @@ options() -> {deliver_notifications, true}, {presence_based_delivery, true}]. + +-spec(features/0 :: () -> [Feature::string()]). + features() -> ["create-nodes", %* "auto-create", %* @@ -117,165 +138,429 @@ features() -> "subscribe" %* ]. -create_node_permission(Host, ServerHost, _Node, _ParentNode, Owner, Access) -> - LOwner = jlib:short_prepd_jid(Owner), - {User, Server, Resource} = LOwner, - Allowed = case LOwner of + +-spec(create_node_permission/6 :: + ( + Host :: hostPEP(), + ServerHost :: string(), + NodeId :: nodeId(), + ParentNodeId :: nodeId(), + JID :: jidEntity(), + Access :: atom()) + -> {'result', IsAllowed::boolean()} + ). + +create_node_permission(Host, ServerHost, _NodeId, _ParentNodeId, #jid{node = U, domain = S, resource = R} = JID, Access) -> + Owner = {U,S,R}, + Allowed = case Owner of {undefined, Host, undefined} -> true; % pubsub service always allowed _ -> - JID = exmpp_jid:make(User, Server, Resource), case acl:match_rule(ServerHost, Access, JID) of - allow -> + 'allow' -> case Host of - {User, Server, _} -> true; + {_, _, _} -> true; _ -> false end; - E -> - ?DEBUG("Create not allowed : ~p~n", [E]), + Error -> + ?DEBUG("Create not allowed : ~p~n", [Error]), false end end, {result, Allowed}. -create_node(NodeId, Owner) -> - case node_flat:create_node(NodeId, Owner) of - {result, _} -> {result, []}; - Error -> Error - end. -delete_node(Removed) -> - case node_flat:delete_node(Removed) of - {result, {_, _, Removed}} -> {result, {[], Removed}}; - Error -> Error - end. - -subscribe_node(NodeId, Sender, Subscriber, AccessModel, +-spec(create_node/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', []}% | {'error', 'internal-server-error'} + ). + +create_node(NodeIdx, JID) -> + {result, _} = node_flat:create_node(NodeIdx, JID), + {result, []}. +% case node_flat:create_node(NodeIdx, JID) of +% {result, _} -> {result, []}; +% Error -> Error +% end. + + +-spec(delete_node/1 :: + ( + Nodes :: [Node::pubsubNode()]) + -> {result, {[], + Removed :: [] | [{Node :: pubsubNode(), + [{Owner :: bareUsr(), + Subscriptions :: [{Subscription :: subscription(), + SubId :: subId()}]}]}]}} + %| {'error', 'internal-server-error'} + ). + +delete_node(Nodes) -> + {result, {_, _, Nodes}} = node_flat:delete_node(Nodes), + {result, {[], Nodes}}. +% case node_flat:delete_node(Nodes) of +% {result, {_, _, Nodes}} -> {result, {[], Nodes}}; +% Error -> Error +% end. + + +-spec(subscribe_node/8 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscriber :: jidEntity(), + AccessModel :: accessModel(), + SendLast :: atom(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + Options :: [nodeOption()]) + -> {'result', {'default', + Subscription :: 'subscribed', + SubId :: subId()}} + | {'result', {'default', + Subscription :: 'subscribed', + SubId :: subId(), + SendLast ::' send_last'}} + | {'result', {'default', + Subscription :: 'pending', + SubId :: subId()}} + | {'error', _} %% TODO add all error cases + ). + +subscribe_node(NodeIdx, JID, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> node_flat:subscribe_node( - NodeId, Sender, Subscriber, AccessModel, SendLast, + NodeIdx, JID, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - case node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID) of + +-spec(unsubscribe_node/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscriber :: jidEntity(), + SubId :: subId()) + -> {'result', []} | {'error', _} %% TODO : add all error cases + ). + +unsubscribe_node(NodeIdx, JID, Subscriber, SubId) -> + case node_flat:unsubscribe_node(NodeIdx, JID, Subscriber, SubId) of {error, Error} -> {error, Error}; {result, _} -> {result, []} end. -publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> - node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). - -remove_extra_items(NodeId, MaxItems, ItemIds) -> - node_flat:remove_extra_items(NodeId, MaxItems, ItemIds). - -delete_item(NodeId, Publisher, PublishModel, ItemId) -> - node_flat:delete_item(NodeId, Publisher, PublishModel, ItemId). - -purge_node(NodeId, Owner) -> - node_flat:purge_node(NodeId, Owner). -get_entity_affiliations(_Host, Owner) -> - {_, D, _} = jlib:short_prepd_jid(Owner), - GenKey = jlib:short_prepd_bare_jid(Owner), - States = mnesia:match_object(#pubsub_state{stateid = {GenKey, '_'}, _ = '_'}), - NodeTree = case catch ets:lookup(gen_mod:get_module_proc(D, config), nodetree) of - [{nodetree, N}] -> N; - _ -> nodetree_tree +-spec(publish_item/6 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + PublishModel :: atom(), %% TODO : make a generic publishMod() type + MaxItems :: 'unlimited' | integer(), + ItemId :: itemId(), + Payload :: payload()) + -> {'result', {'default', 'broadcast', ItemIds :: [] | [itemId()]}} + | {'error', _} + ). + +publish_item(NodeIdx, JID, PublishModel, MaxItems, ItemId, Payload) -> + node_flat:publish_item(NodeIdx, JID, PublishModel, MaxItems, ItemId, Payload). + + +-spec(remove_extra_items/3 :: + ( + NodeIdx :: nodeIdx(), + MaxItems :: 'unlimited' | integer(), + ItemsIds :: [ItemId::itemId()]) + -> {'result', + {OldItems :: [] | [ItemId::itemId()], + NewItems :: [] | [ItemId::itemId()]}} + ). + +remove_extra_items(NodeIdx, MaxItems, ItemIds) -> + node_flat:remove_extra_items(NodeIdx, MaxItems, ItemIds). + + +-spec(delete_item/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + PublishModel :: atom(), + ItemId :: itemId()) + -> {'result', {'default', 'broadcast'}} | {'error', _} + ). + +delete_item(NodeIdx, JID, PublishModel, ItemId) -> + node_flat:delete_item(NodeIdx, JID, PublishModel, ItemId). + + +-spec(purge_node/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', {'default', 'broadcast'}} | {'error', 'forbidden'} + ). + +purge_node(NodeIdx, JID) -> + node_flat:purge_node(NodeIdx, JID). + + +-spec(get_entity_affiliations/2 :: + ( + Host :: binary(), + JID :: jidEntity()) + -> {'result', Reply :: [] | [{Node::pubsubNode(), Affiliation::affiliation()}]} + ). + +get_entity_affiliations(_Host, #jid{node = U, domain = S} = _JID) -> + States = mnesia:match_object(#pubsub_state{id = {_GenKey = {U,S,undefined}, '_'}, _ = '_'}), + NodeTree = case catch ets:lookup(gen_mod:get_module_proc(S, 'config'), 'nodetree') of + [{'nodetree', Tree}] -> Tree; + _ -> 'nodetree_tree' end, - Reply = lists:foldl(fun(#pubsub_state{stateid = {_, N}, affiliation = A}, Acc) -> - case NodeTree:get_node(N) of - #pubsub_node{nodeid = {{_, D, _}, _}} = Node -> [{Node, A}|Acc]; + Reply = lists:foldl(fun(#pubsub_state{id = {_, NodeIdx}, affiliation = Affiliation}, Acc) -> + case NodeTree:get_node(NodeIdx) of + #pubsub_node{id = {{_, S, _}, _}} = Node -> [{Node, Affiliation}|Acc]; _ -> Acc end end, [], States), {result, Reply}. -get_node_affiliations(NodeId) -> - node_flat:get_node_affiliations(NodeId). -get_affiliation(NodeId, Owner) -> - node_flat:get_affiliation(NodeId, Owner). +-spec(get_node_affiliations/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', [] | [{Entity::fullUsr(), Affiliation::affiliation()}]} + ). + +get_node_affiliations(NodeIdx) -> + node_flat:get_node_affiliations(NodeIdx). + + +-spec(get_affiliation/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', Affiliation::affiliation()} + ). -set_affiliation(NodeId, Owner, Affiliation) -> - node_flat:set_affiliation(NodeId, Owner, Affiliation). +get_affiliation(NodeIdx, JID) -> + node_flat:get_affiliation(NodeIdx, JID). -get_entity_subscriptions(_Host, Owner) -> - {U, D, _} = SubKey = jlib:short_prepd_jid(Owner), - GenKey = jlib:short_prepd_bare_jid(Owner), + +-spec(set_affiliation/3 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Affiliation :: affiliation()) + -> 'ok' | {error, 'internal-server-error'} + ). + +set_affiliation(NodeIdx, JID, Affiliation) -> + node_flat:set_affiliation(NodeIdx, JID, Affiliation). + + +-spec(get_entity_subscriptions/2 :: + ( + Host :: hostPEP(), + JID :: jidEntity()) + -> {'result', [] + | [{Node :: pubsubNode(), + Subscription :: subscription(), + SubId :: subId(), + Entity :: fullUsr()}]} + ). + +get_entity_subscriptions(_Host, #jid{node = U, domain = S, resource = R} = _JID) -> + SubKey = {U,S,R}, + GenKey = {U,S,undefined}, States = case SubKey of GenKey -> mnesia:match_object( - #pubsub_state{stateid = {{U, D, '_'}, '_'}, _ = '_'}); + #pubsub_state{id = {{U, S, '_'}, '_'}, _ = '_'}); _ -> mnesia:match_object( - #pubsub_state{stateid = {GenKey, '_'}, _ = '_'}) + #pubsub_state{id = {GenKey, '_'}, _ = '_'}) ++ mnesia:match_object( - #pubsub_state{stateid = {SubKey, '_'}, _ = '_'}) + #pubsub_state{id = {SubKey, '_'}, _ = '_'}) end, - NodeTree = case catch ets:lookup(gen_mod:get_module_proc(D, config), nodetree) of - [{nodetree, N}] -> N; - _ -> nodetree_tree + NodeTree = case catch ets:lookup(gen_mod:get_module_proc(S, 'config'), 'nodetree') of + [{nodetree, Tree}] -> Tree; + _ -> 'nodetree_tree' end, - Reply = lists:foldl(fun(#pubsub_state{stateid = {J, N}, subscriptions = Ss}, Acc) -> - case NodeTree:get_node(N) of - #pubsub_node{nodeid = {{_, D, _}, _}} = Node -> - lists:foldl(fun({subscribed, SubID}, Acc2) -> - [{Node, subscribed, SubID, J} | Acc2]; - ({pending, _SubID}, Acc2) -> - [{Node, pending, J} | Acc2]; - (S, Acc2) -> - [{Node, S, J} | Acc2] - end, Acc, Ss); + Reply = lists:foldl(fun(#pubsub_state{id = {Entity, NodeIdx}, subscriptions = Subscriptions}, Acc) -> + case NodeTree:get_node(NodeIdx) of + #pubsub_node{id = {{_, S, _}, _}} = Node -> + lists:foldl(fun({subscribed, SubId}, Acc2) -> + [{Node, subscribed, SubId, Entity} | Acc2]; + ({pending, _SubId}, Acc2) -> + [{Node, pending, Entity} | Acc2]; + (Subscription, Acc2) -> + [{Node, Subscription, Entity} | Acc2] + end, Acc, Subscriptions); _ -> Acc end end, [], States), {result, Reply}. -get_node_subscriptions(NodeId) -> + +-spec(get_node_subscriptions/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', [] + | [{Entity::fullUsr(), 'none'}] + %| [{Entity::fullUsr(), Subscription::subscription()}] %% still useful case ? + | [{Entity::fullUsr(), Subscription::subscription(), SubId::subId()}]} + ). + +get_node_subscriptions(NodeIdx) -> %% note: get_node_subscriptions is used for broadcasting %% there should not have any subscriptions %% but that call returns also all subscription to none %% and this is required for broadcast to occurs %% DO NOT REMOVE - node_flat:get_node_subscriptions(NodeId). + node_flat:get_node_subscriptions(NodeIdx). + + +-spec(get_subscriptions/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', Subscriptions :: [] | [{Subscription::subscription(), SubId::subId()}]} + ). + +get_subscriptions(NodeIdx, JID) -> + node_flat:get_subscriptions(NodeIdx, JID). + + +-spec(set_subscriptions/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscription :: subscription(), + SubId :: subId()) + -> 'ok' + | {Subscription::subscription(), SubId::subId()} + | {error, _} + ). + +set_subscriptions(NodeIdx, JID, Subscription, SubId) -> + node_flat:set_subscriptions(NodeIdx, JID, Subscription, SubId). -get_subscriptions(NodeId, Owner) -> - node_flat:get_subscriptions(NodeId, Owner). -set_subscriptions(NodeId, Owner, Subscription, SubId) -> - node_flat:set_subscriptions(NodeId, Owner, Subscription, SubId). +-spec(get_pending_nodes/2 :: + ( + Host :: hostPEP(), + JID :: jidEntity()) + -> 'false' | {'value', NodeId::nodeId()} + ). -get_pending_nodes(Host, Owner) -> - node_flat:get_pending_nodes(Host, Owner). +get_pending_nodes(Host, JID) -> + node_flat:get_pending_nodes(Host, JID). -get_states(NodeId) -> - node_flat:get_states(NodeId). -get_state(NodeId, JID) -> - node_flat:get_state(NodeId, JID). +-spec(get_states/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', States :: [] | [State::pubsubState()]} + ). + +get_states(NodeIdx) -> + node_flat:get_states(NodeIdx). + + +-spec(get_state/2 :: + ( + NodeIdx :: nodeIdx(), + Entity :: fullUsr()) + -> State::pubsubState() + ). + +get_state(NodeIdx, Entity) -> + node_flat:get_state(NodeIdx, Entity). + + +-spec(set_state/1 :: + ( + State :: pubsubState()) + -> 'ok' | {'error', 'internal-server-error'} + ). set_state(State) -> node_flat:set_state(State). -get_items(NodeId, From) -> - node_flat:get_items(NodeId, From). -get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> - node_flat:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). +-spec(get_items/2 :: + ( + NodeIdx :: nodeIdx(), + Entity :: fullUsr()) + -> {'result', Items :: [] | [Item::pubsubItem()]} + ). + +get_items(NodeIdx, Entity) -> + node_flat:get_items(NodeIdx, Entity). -get_item(NodeId, ItemId) -> - node_flat:get_item(NodeId, ItemId). -get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> - node_flat:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). +-spec(get_items/6 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + AccessModel :: accessModel(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + SubId :: subId()) + -> {'result', Items :: [] | [Item::pubsubItem()]} + | {'error', _} + ). + +get_items(NodeIdx, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_flat:get_items(NodeIdx, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + + +-spec(get_item/2 :: + ( + NodeIdx :: nodeIdx(), + ItemId :: itemId()) + -> {'result', Item::pubsubItem()} | {'error', 'item-not-found'} + ). + +get_item(NodeIdx, ItemId) -> + node_flat:get_item(NodeIdx, ItemId). + + +-spec(get_item/7 :: + ( + NodeIdx :: nodeIdx(), + ItemId :: itemId(), + JID :: jidEntity(), + AccessModel :: accessModel(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + SubId :: subId()) + -> {'result', Item::pubsubItem()} | {'error', 'item-not-found'} + ). + +get_item(NodeIdx, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_flat:get_item(NodeIdx, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + + +-spec(set_item/1 :: + ( + Item :: pubsubItem()) + -> 'ok' | {error, 'internal-server-error'} + ). set_item(Item) -> node_flat:set_item(Item). + get_item_name(Host, Node, Id) -> node_flat:get_item_name(Host, Node, Id). + node_to_path(Node) -> node_flat:node_to_path(Node). + path_to_node(Path) -> node_flat:path_to_node(Path). @@ -288,6 +573,12 @@ path_to_node(Path) -> %% The PEP plugin for mod_pubsub requires mod_caps to be enabled in the host. %% Check that the mod_caps module is enabled in that Jabber Host %% If not, show a warning message in the ejabberd log file. +-spec(complain_if_modcaps_disabled/1 :: + ( + ServerHost :: string()) + -> 'ok' | true + ). + complain_if_modcaps_disabled(ServerHost) -> Modules = ejabberd_config:get_local_option({modules, ServerHost}), ModCaps = [mod_caps_enabled || {mod_caps, _Opts} <- Modules], diff --git a/src/mod_pubsub/node_pep_odbc.erl b/src/mod_pubsub/node_pep_odbc.erl index b567d9f19..14d0875cc 100644 --- a/src/mod_pubsub/node_pep_odbc.erl +++ b/src/mod_pubsub/node_pep_odbc.erl @@ -25,12 +25,10 @@ %%% @doc The module <strong>{@module}</strong> is the pep PubSub plugin. %%% <p>PubSub plugin nodes are using the {@link gen_pubsub_node} behaviour.</p> - +%%TODO : fix SQL requests with nodeid/id and id/idx changes -module(node_pep_odbc). -author('christophe.romain@process-one.net'). --include_lib("exmpp/include/exmpp.hrl"). - -include("ejabberd.hrl"). -include("pubsub.hrl"). @@ -86,7 +84,6 @@ terminate(Host, ServerHost) -> options() -> [{odbc, true}, - {node_type, pep}, {deliver_payloads, true}, {notify_config, false}, {notify_delete, false}, @@ -163,8 +160,8 @@ subscribe_node(NodeId, Sender, Subscriber, AccessModel, NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - case node_flat_odbc:unsubscribe_node(NodeId, Sender, Subscriber, SubID) of +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + case node_flat_odbc:unsubscribe_node(NodeId, Sender, Subscriber, SubId) of {error, Error} -> {error, Error}; {result, _} -> {result, []} end. diff --git a/src/mod_pubsub/node_private.erl b/src/mod_pubsub/node_private.erl index cbde859e1..c069ad1b2 100644 --- a/src/mod_pubsub/node_private.erl +++ b/src/mod_pubsub/node_private.erl @@ -26,8 +26,6 @@ -module(node_private). -author('christophe.romain@process-one.net'). --include_lib("exmpp/include/exmpp.hrl"). - -include("pubsub.hrl"). -behaviour(gen_pubsub_node). @@ -133,8 +131,8 @@ subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/node_public.erl b/src/mod_pubsub/node_public.erl index 720ab706b..b5719b5e7 100644 --- a/src/mod_pubsub/node_public.erl +++ b/src/mod_pubsub/node_public.erl @@ -26,8 +26,6 @@ -module(node_public). -author('christophe.romain@process-one.net'). --include_lib("exmpp/include/exmpp.hrl"). - -include("pubsub.hrl"). -behaviour(gen_pubsub_node). @@ -82,8 +80,7 @@ terminate(Host, ServerHost) -> node_flat:terminate(Host, ServerHost). options() -> - [{node_type, public}, - {deliver_payloads, true}, + [{deliver_payloads, true}, {notify_config, false}, {notify_delete, false}, {notify_retract, true}, @@ -130,8 +127,8 @@ delete_node(Removed) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/nodetree_dag.erl b/src/mod_pubsub/nodetree_dag.erl index 6713720bc..890934557 100644 --- a/src/mod_pubsub/nodetree_dag.erl +++ b/src/mod_pubsub/nodetree_dag.erl @@ -39,7 +39,6 @@ -include("ejabberd.hrl"). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -behaviour(gen_pubsub_nodetree). @@ -52,130 +51,265 @@ %%==================================================================== %% API %%==================================================================== +-spec(init/3 :: + ( + Host :: string(), + ServerHost :: string(), + Opts :: [{Key::atom(), Value::term()}]) + -> 'ok' + ). + init(Host, ServerHost, Opts) -> nodetree_tree:init(Host, ServerHost, Opts). + +-spec(terminate/2 :: + ( + Host :: string(), + ServerHost :: string()) + -> 'ok' + ). + terminate(Host, ServerHost) -> nodetree_tree:terminate(Host, ServerHost). -create_node(Key, NodeID, Type, Owner, Options, Parents) -> - OwnerJID = jlib:short_prepd_bare_jid(Owner), - case find_node(Key, NodeID) of + +-spec(create_node/6 :: + ( + Host :: hostPubsub(), + NodeId :: nodeId(), + Type :: nodeType(), + JID :: jidEntity(), + Options :: [nodeOption()], + ParentNodeIds :: [] | [nodeId()]) + -> {'ok', NodeIdx::nodeIdx()} | {'error', _} + ). + +create_node(Host, NodeId, Type, #jid{node = U, domain = S} = _JID, Options, ParentNodeIds) -> + case find_node(Host, NodeId) of false -> - ID = pubsub_index:new(node), - N = #pubsub_node{nodeid = oid(Key, NodeID), - id = ID, + NodeIdx = pubsub_index:new(node), + Node = #pubsub_node{id = {Host, NodeId}, + idx = NodeIdx, type = Type, - parents = Parents, - owners = [OwnerJID], + parents = ParentNodeIds, + owners = [_Owner = {U,S,undefined}], options = Options}, - case set_node(N) of - ok -> {ok, ID}; + case set_node(Node) of + ok -> {ok, NodeIdx}; Other -> Other end; _ -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'conflict')} end. -set_node(#pubsub_node{nodeid = {Key, _}, + +-spec(set_node/1 :: + ( + Node :: pubsubNode()) + -> 'ok' | {'error', _} + ). + +set_node(#pubsub_node{id = {Host, _}, owners = Owners, options = Options} = Node) -> - Parents = find_opt(collection, ?DEFAULT_PARENTS, Options), - case validate_parentage(Key, Owners, Parents) of + ParentNodeIds = find_opt('collection', ?DEFAULT_PARENTS, Options), + case validate_parentage(Host, Owners, ParentNodeIds) of true -> %% Update parents whenever the config changes. - mnesia:write(Node#pubsub_node{parents = Parents}); + mnesia:write(Node#pubsub_node{parents = ParentNodeIds}); Other -> Other end. -delete_node(Key, NodeID) -> - case find_node(Key, NodeID) of + +-spec(delete_node/2 :: + ( + Host :: hostPubsub(), + NodeId :: nodeId()) + -> [pubsubNode()] | {'error', _} + ). + +delete_node(Host, NodeId) -> + case find_node(Host, NodeId) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item-not-found')}; - Node -> + ParentNode -> %% Find all of N's children, update their configs to %% remove N from the collection setting. - lists:foreach(fun (#pubsub_node{options = Opts} = Child) -> - NewOpts = remove_config_parent(NodeID, Opts), - Parents = find_opt(collection, ?DEFAULT_PARENTS, NewOpts), + lists:foreach(fun (#pubsub_node{options = Options} = Node) -> + NewOptions = remove_config_parent(NodeId, Options), + Parents = find_opt('collection', ?DEFAULT_PARENTS, NewOptions), ok = mnesia:write(pubsub_node, - Child#pubsub_node{ + Node#pubsub_node{ parents = Parents, - options = NewOpts}, + options = NewOptions}, write) - end, get_subnodes(Key, NodeID)), + end, get_subnodes(Host, NodeId)), %% Remove and return the requested node. - pubsub_index:free(node, Node#pubsub_node.id), - mnesia:delete_object(pubsub_node, Node, write), - [Node] + pubsub_index:free(node, ParentNode#pubsub_node.idx), + mnesia:delete_object(pubsub_node, ParentNode, write), + [ParentNode] end. -options() -> - nodetree_tree:options(). -get_node(Host, NodeID, _From) -> - get_node(Host, NodeID). +-spec(options/0 :: () -> Options::[Option::nodeOption()]). + %Options::[{'virtual_tree', 'false'}]) + +options() -> nodetree_tree:options(). + + +-spec(get_node/3 :: + ( + Host :: hostPubsub(), + NodeId :: nodeId(), + JID :: jidEntity()) + -> pubsubNode() | {'error', _} + ). -get_node(Host, NodeID) -> - case find_node(Host, NodeID) of +get_node(Host, NodeId, _JID) -> + get_node(Host, NodeId). + + +-spec(get_node/2 :: + ( + Host :: hostPubsub(), + NodeId :: nodeId()) + -> pubsubNode() | {'error', _} + ). + +get_node(Host, NodeId) -> + case find_node(Host, NodeId) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item-not-found')}; - Node -> Node + Node -> Node end. -get_node(NodeId) -> - nodetree_tree:get_node(NodeId). -get_nodes(Key, From) -> - nodetree_tree:get_nodes(Key, From). +-spec(get_node/1 :: + ( + NodeIdx :: nodeIdx()) + -> pubsubNode() | {'error', 'item-not-found'} + ). + +get_node(NodeIdx) -> + nodetree_tree:get_node(NodeIdx). + + +-spec(get_nodes/2 :: + ( + Host :: hostPubsub(), + JID :: jidEntity()) + -> Nodes :: [] | [Node::pubsubNode()] + ). + +get_nodes(Host, JID) -> + nodetree_tree:get_nodes(Host, JID). + + +-spec(get_nodes/1 :: + ( + Host :: hostPubsub()) + -> Nodes :: [] | [Node::pubsubNode()] + ). + +get_nodes(Host) -> + nodetree_tree:get_nodes(Host). + -get_nodes(Key) -> - nodetree_tree:get_nodes(Key). +-spec(get_parentnodes/3 :: + ( + Host :: hostPubsub(), + NodeId :: nodeId(), + JID :: jidEntity()) + -> ParentNodes :: [] | [ParentNode::pubsubNode()] + ). -get_parentnodes(Host, NodeID, _From) -> - case find_node(Host, NodeID) of +get_parentnodes(Host, NodeId, _JID) -> + case find_node(Host, NodeId) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item-not-found')}; - #pubsub_node{parents = Parents} -> - Q = qlc:q([N || #pubsub_node{nodeid = {NHost, NNode}} = N <- mnesia:table(pubsub_node), - Parent <- Parents, + #pubsub_node{parents = ParentNodeIds} -> + Q = qlc:q([Node || #pubsub_node{id = {NHost, NNodeId}} = Node + <- mnesia:table(pubsub_node), + ParentNodeId <- ParentNodeIds, Host == NHost, - Parent == NNode]), + ParentNodeId == NNodeId]), qlc:e(Q) end. -get_parentnodes_tree(Host, NodeID, _From) -> - Pred = fun (NID, #pubsub_node{nodeid = {_, NNodeID}}) -> - NID == NNodeID - end, + +-spec(get_parentnodes_tree/3 :: + ( + Host :: hostPubsub(), + NodeId :: nodeId(), + JID :: jidEntity()) + -> [] | [{Depth::integer(), Nodes :: [] | [Node::pubsubNode()]}] + ). + +get_parentnodes_tree(Host, NodeId, _JID) -> + Pred = fun (Name, #pubsub_node{id = {_, NodeName}}) -> Name == NodeName end, Tr = fun (#pubsub_node{parents = Parents}) -> Parents end, - traversal_helper(Pred, Tr, Host, [NodeID]). + traversal_helper(Pred, Tr, Host, [NodeId]). + + +-spec(get_subnodes/3 :: + ( + ParentNodeHost :: hostPubsub(), + ParentNodeId :: nodeId(), + JID :: jidEntity()) + -> [] | [Node::pubsubNode()] | {'error', _} + ). + +get_subnodes(Host, Node, _JID) -> + get_subnodes(Host, Node). -get_subnodes(Host, NodeID, _From) -> - get_subnodes(Host, NodeID). -get_subnodes(Host, <<>>) -> - get_subnodes_helper(Host, <<>>); -get_subnodes(Host, NodeID) -> - case find_node(Host, NodeID) of +-spec(get_subnodes/2 :: + ( + ParentNodeHost :: hostPubsub(), + ParentNodeId :: nodeId()) + -> [] | [Node::pubsubNode()] | {'error', _} + ). + +get_subnodes(ParentNodeHost, <<>>) -> + get_subnodes_helper(ParentNodeHost, <<>>); +get_subnodes(ParentNodeHost, ParentNodeId) -> + case find_node(ParentNodeHost, ParentNodeId) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item-not-found')}; - _ -> get_subnodes_helper(Host, NodeID) + _ -> get_subnodes_helper(ParentNodeHost, ParentNodeId) end. -get_subnodes_helper(Host, NodeID) -> - Q = qlc:q([Node || #pubsub_node{nodeid = {NHost, _}, - parents = Parents} = Node <- mnesia:table(pubsub_node), - Host == NHost, - lists:member(NodeID, Parents)]), + +-spec(get_subnodes_helper/2 :: + ( + ParentNodeHost :: hostPubsub(), + ParentNodeId :: nodeId()) + -> SubNodes :: [] | [Node::pubsubNode()] + ). + +get_subnodes_helper(ParentNodeHost, ParentNodeId) -> + Q = qlc:q([Node || #pubsub_node{id = {Host, _}, + parents = ParentNodeIds} = Node <- mnesia:table(pubsub_node), + ParentNodeHost == Host, + lists:member(ParentNodeId, ParentNodeIds)]), qlc:e(Q). -get_subnodes_tree(Host, NodeID, From) -> - Pred = fun (NID, #pubsub_node{parents = Parents}) -> - lists:member(NID, Parents) + +-spec(get_subnodes_tree/3 :: + ( + ParentNodeHost :: hostPubsub(), + ParentNodeId :: nodeId(), + JID :: jidEntity()) + -> [] | [{Depth::integer(), Nodes :: [] | [Node::pubsubNode()]}] + ). + +get_subnodes_tree(Host, ParentNodeId, JID) -> + Pred = fun(NodeId, #pubsub_node{parents = ParentNodeIds}) -> + lists:member(NodeId, ParentNodeIds) end, - Tr = fun (#pubsub_node{nodeid = {_, N}}) -> [N] end, - traversal_helper(Pred, Tr, 1, Host, [NodeID], - [{0, [get_node(Host, NodeID, From)]}]). + Tr = fun (#pubsub_node{id = {_, NodeId}}) -> [NodeId] end, + traversal_helper(Pred, Tr, 1, Host, [ParentNodeId], + [{0, [get_node(Host, ParentNodeId, JID)]}]). %%==================================================================== %% Internal functions @@ -183,9 +317,16 @@ get_subnodes_tree(Host, NodeID, From) -> oid(Key, Name) -> {Key, Name}. %% Key = jlib:jid() | host() -%% NodeID = string() -find_node(Key, NodeID) -> - case mnesia:read(pubsub_node, oid(Key, NodeID), read) of +%% Node = string() +-spec(find_node/2 :: + ( + Host :: hostPubsub(), + NodeId :: nodeId()) + -> pubsubNode() | 'false' + ). + +find_node(Host, NodeId) -> + case mnesia:read({pubsub_node, {Host, NodeId}}) of [] -> false; [Node] -> Node end. @@ -193,53 +334,109 @@ find_node(Key, NodeID) -> %% Key = jlib:jid() | host() %% Default = term() %% Options = [{Key = atom(), Value = term()}] +-spec(find_opt/3 :: + ( + Key :: atom(), + Default :: term(), + Options :: [Option::nodeOption()]) + -> Value::term() + ). + find_opt(Key, Default, Options) -> case lists:keysearch(Key, 1, Options) of - {value, {Key, Val}} -> Val; + {value, {Key, Value}} -> Value; _ -> Default end. -traversal_helper(Pred, Tr, Host, NodeIDs) -> - traversal_helper(Pred, Tr, 0, Host, NodeIDs, []). + +-spec(traversal_helper/4 :: + ( + Pred :: fun(), + Tr :: fun(), + ParentNodeHost :: hostPubsub(), + ParentNodeIds :: [] | [ParentNodeId::nodeId()]) + -> [] | [{Depth::integer(), Nodes :: [] | [Node::pubsubNode()]}] + ). + +traversal_helper(Pred, Tr, ParentNodeHost, ParentNodeIds) -> + traversal_helper(Pred, Tr, 0, ParentNodeHost, ParentNodeIds, []). + + +-spec(traversal_helper/6 :: + ( + Pred :: fun(), + Tr :: fun(), + Depth :: integer(), + ParentNodeHost :: hostPubsub(), + ParentNodeIds :: [] | [ParentNodeId::nodeId()], + Acc :: [] | [{Depth::integer(), Nodes :: [] | [Node::pubsubNode()]}]) + -> [] | [{Depth::integer(), Nodes :: [] | [Node::pubsubNode()]}] + ). traversal_helper(_Pred, _Tr, _Depth, _Host, [], Acc) -> Acc; -traversal_helper(Pred, Tr, Depth, Host, NodeIDs, Acc) -> - Q = qlc:q([Node || #pubsub_node{nodeid = {NHost, _}} = Node <- mnesia:table(pubsub_node), - NodeID <- NodeIDs, - Host == NHost, - Pred(NodeID, Node)]), +traversal_helper(Pred, Tr, Depth, ParentNodeHost, ParentNodeIds, Acc) -> + Q = qlc:q([Node || #pubsub_node{id = {Host, _}} = Node <- mnesia:table(pubsub_node), + ParentNodeId <- ParentNodeIds, + ParentNodeHost == Host, + Pred(ParentNodeId, Node)]), Nodes = qlc:e(Q), - IDs = lists:flatmap(Tr, Nodes), - traversal_helper(Pred, Tr, Depth + 1, Host, IDs, [{Depth, Nodes} | Acc]). + Ids = lists:flatmap(Tr, Nodes), + traversal_helper(Pred, Tr, Depth + 1, ParentNodeHost, Ids, [{Depth, Nodes} | Acc]). -remove_config_parent(NodeID, Options) -> - remove_config_parent(NodeID, Options, []). -remove_config_parent(_NodeID, [], Acc) -> - lists:reverse(Acc); -remove_config_parent(NodeID, [{collection, Parents} | T], Acc) -> - remove_config_parent(NodeID, T, - [{collection, lists:delete(NodeID, Parents)} | Acc]); -remove_config_parent(NodeID, [H | T], Acc) -> - remove_config_parent(NodeID, T, [H | Acc]). +-spec(remove_config_parent/2 :: + ( + NodeId :: nodeId(), + Options :: [Option::nodeOption()]) + -> [Option::nodeOption()] + ). -validate_parentage(_Key, _Owners, []) -> +remove_config_parent(NodeId, Options) -> + remove_config_parent(NodeId, Options, []). + + +-spec(remove_config_parent/3 :: + ( + NodeId :: nodeId(), + Options :: [] | [Option::nodeOption()], + Acc :: [Option::nodeOption()]) + -> [Option::nodeOption()] + ). + +remove_config_parent(_NodeId, [], Acc) -> + lists:reverse(Acc); +remove_config_parent(NodeId, [{'collection', ParentNodeIds} | Options], Acc) -> + remove_config_parent(NodeId, Options, + [{'collection', lists:delete(NodeId, ParentNodeIds)} | Acc]); +remove_config_parent(NodeId, [Option | Options], Acc) -> + remove_config_parent(NodeId, Options, [Option | Acc]). + + +-spec(validate_parentage/3 :: + ( + Host :: hostPubsub(), + Owners :: [Owner::bareUsr()], + ParentNodeIds :: [] | [ParentNodeId::nodeId()] | [ParentNodeId :: nodeId() | []]) + -> 'true' | {'error', _} + ). + +validate_parentage(_Host, _Owners, []) -> true; -validate_parentage(Key, Owners, [[] | T]) -> - validate_parentage(Key, Owners, T); -validate_parentage(Key, Owners, [<<>> | T]) -> - validate_parentage(Key, Owners, T); -validate_parentage(Key, Owners, [ParentID | T]) -> - case find_node(Key, ParentID) of +validate_parentage(Host, Owners, [[] | ParentNodeIds]) -> + validate_parentage(Host, Owners, ParentNodeIds); +validate_parentage(Host, Owners, [<<>> | ParentNodeIds]) -> + validate_parentage(Host, Owners, ParentNodeIds); +validate_parentage(Host, Owners, [ParentNodeId | ParentNodeIds]) -> + case find_node(Host, ParentNodeId) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item_not_found')}; - #pubsub_node{owners = POwners, options = POptions} -> - NodeType = find_opt(node_type, ?DEFAULT_NODETYPE, POptions), - MutualOwners = [O || O <- Owners, PO <- POwners, - O == PO], + #pubsub_node{owners = ParentNodeOwners, options = Options} -> + NodeType = find_opt('node_type', ?DEFAULT_NODETYPE, Options), + MutualOwners = [Owner || Owner <- Owners, ParentNodeOwner <- ParentNodeOwners, + Owner == ParentNodeOwner], case {MutualOwners, NodeType} of {[], _} -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'forbidden')}; - {_, collection} -> validate_parentage(Key, Owners, T); + {_, 'collection'} -> validate_parentage(Host, Owners, ParentNodeIds); {_, _} -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'not-allowed')} end end. @@ -247,6 +444,12 @@ validate_parentage(Key, Owners, [ParentID | T]) -> %% @spec (Host) -> jid() %% Host = host() %% @doc <p>Generate pubsub service JID.</p> +-spec(service_jid/1 :: + ( + Host :: hostPubsub()) + -> ServiceJID :: jidContact() | jidComponent() %% should only return jidContact() + ). + service_jid(Host) -> case Host of {U,S,_} -> exmpp_jid:make(U, S); diff --git a/src/mod_pubsub/nodetree_tree.erl b/src/mod_pubsub/nodetree_tree.erl index 6c6329482..d46452f24 100644 --- a/src/mod_pubsub/nodetree_tree.erl +++ b/src/mod_pubsub/nodetree_tree.erl @@ -37,13 +37,13 @@ -author('christophe.romain@process-one.net'). -include_lib("stdlib/include/qlc.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -include("pubsub.hrl"). -behaviour(gen_pubsub_nodetree). --export([init/3, +-export([ + init/3, terminate/2, options/0, set_node/1, @@ -61,6 +61,7 @@ ]). + %% ================ %% API definition %% ================ @@ -74,182 +75,309 @@ %% <p>This function is mainly used to trigger the setup task necessary for the %% plugin. It can be used for example by the developer to create the specific %% module database schema if it does not exists yet.</p> +-spec(init/3 :: + ( + Host :: string(), + ServerHost :: string(), + Opts :: [{Key::atom(), Value::term()}]) + -> 'ok' + ). + init(_Host, _ServerHost, _Opts) -> mnesia:create_table(pubsub_node, [{disc_copies, [node()]}, {attributes, record_info(fields, pubsub_node)}]), - mnesia:add_table_index(pubsub_node, id), + mnesia:add_table_index(pubsub_node, idx), NodesFields = record_info(fields, pubsub_node), case mnesia:table_info(pubsub_node, attributes) of NodesFields -> ok; - _ -> - ok - %% mnesia:transform_table(pubsub_state, ignore, StatesFields) + _ -> ok %% mnesia:transform_table(pubsub_state, ignore, StatesFields) end, ok. + + +-spec(terminate/2 :: + ( + Host :: string(), + ServerHost :: string()) + -> 'ok' + ). + terminate(_Host, _ServerHost) -> ok. %% @spec () -> [Option] %% Option = mod_pubsub:nodetreeOption() %% @doc Returns the default pubsub node tree options. -options() -> - [{virtual_tree, false}]. +-spec(options/0 :: () -> Options::[{'virtual_tree', 'false'}]). + +options() -> [{'virtual_tree', 'false'}]. %% @spec (NodeRecord) -> ok | {error, Reason} %% Record = mod_pubsub:pubsub_node() -set_node(Record) when is_record(Record, pubsub_node) -> - mnesia:write(Record); -set_node(_) -> - {error, 'internal-server-error'}. + %( + % Node :: pubsubNode() -> 'ok' | {'error', Reason::_}; + % Node :: any() -> {'error', 'internal-server-error'} + %). +%% -spec breaks compilation + +set_node(#pubsub_node{} = Node) -> mnesia:write(Node); +set_node(_) -> {error, 'internal-server-error'}. %% @spec (Host, Node, From) -> pubsubNode() | {error, Reason} %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() -get_node(Host, Node, _From) -> - get_node(Host, Node). -get_node(Host, Node) -> - case catch mnesia:read({pubsub_node, {Host, Node}}) of - [Record] when is_record(Record, pubsub_node) -> Record; - [] -> {error, 'item-not-found'}; - Error -> Error +%% Node = node() +-spec(get_node/3 :: + ( + Host :: host(), % hostPubsub | hostPEP() + NodeId :: nodeId(), + JID :: jidEntity()) + -> pubsubNode() | {error, 'item-not-found'} | any() + ). + +get_node(Host, NodeId, _JID) -> + get_node(Host, NodeId). + + +-spec(get_node/2 :: + ( + Host :: host(), % hostPubsub | hostPEP() + NodeId :: nodeId()) + -> pubsubNode() | {error, 'item-not-found'} | any() + ). + +get_node(Host, NodeId) -> + case catch mnesia:read({pubsub_node, {Host, NodeId}}) of + [#pubsub_node{} = Node] -> Node; + [] -> {error, 'item-not-found'}; + Error -> Error end. -get_node(NodeId) -> - case catch mnesia:index_read(pubsub_node, NodeId, #pubsub_node.id) of - [Record] when is_record(Record, pubsub_node) -> Record; - [] -> {error, 'item-not-found'}; - Error -> Error + + +-spec(get_node/1 :: + ( + NodeIdx :: nodeIdx()) + -> pubsubNode() | {'error', 'item-not-found'} + ). + +get_node(NodeIdx) -> + case catch mnesia:index_read(pubsub_node, NodeIdx, #pubsub_node.idx) of + [#pubsub_node{} = Node] -> Node; + [] -> {error, 'item-not-found'}; + Error -> Error end. %% @spec (Host, From) -> [pubsubNode()] | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() -get_nodes(Host, _From) -> +%% Host = mod_pubsub:host() | ljid() +-spec(get_nodes/2 :: + ( + Host :: host(), % hostPubsub | hostPEP() + JID :: jidEntity()) + -> Nodes :: [] | [Node::pubsubNode()] + ). + +get_nodes(Host, _JID) -> get_nodes(Host). + + +-spec(get_nodes/1 :: + ( + Host :: host()) % hostPubsub | hostPEP() + -> Nodes :: [] | [Node::pubsubNode()] + ). + get_nodes(Host) -> - mnesia:match_object(#pubsub_node{nodeid = {Host, '_'}, _ = '_'}). + mnesia:match_object(#pubsub_node{id = {Host, '_'}, _ = '_'}). %% @spec (Host, Node, From) -> [{Depth, Record}] | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() +%% Host = mod_pubsub:host() | ljid() +%% Node = node() +%% From = ljid() %% Depth = integer() %% Record = pubsubNode() %% @doc <p>Default node tree does not handle parents, return empty list.</p> -get_parentnodes(_Host, _Node, _From) -> +-spec(get_parentnodes/3 :: + ( + Host :: host(), % hostPubsub | hostPEP() + NodeId :: nodeId(), + JID :: jidEntity()) + -> ParentNodes :: [] + ). + +get_parentnodes(_Host, _NodeId, _JID) -> []. %% @spec (Host, Node, From) -> [{Depth, Record}] | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() +%% Host = mod_pubsub:host() | ljid() +%% Node = node() +%% From = ljid() %% Depth = integer() %% Record = pubsubNode() %% @doc <p>Default node tree does not handle parents, return a list %% containing just this node.</p> -get_parentnodes_tree(Host, Node, From) -> - case get_node(Host, Node, From) of - N when is_record(N, pubsub_node) -> [{0, [N]}]; - _Error -> [] +-spec(get_parentnodes_tree/3 :: + ( + Host :: host(), % hostPubsub | hostPEP() + NodeId :: nodeId(), + JID :: jidEntity()) + -> ParentNodesTree :: [] | [{0, [ParentNode::pubsubNode()]}] + ). + +get_parentnodes_tree(Host, NodeId, JID) -> + case get_node(Host, NodeId, JID) of + #pubsub_node{} = ParentNode -> [{0, [ParentNode]}]; + _Error -> [] end. %% @spec (Host, Node, From) -> [pubsubNode()] | {error, Reason} %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() -get_subnodes(Host, Node, _From) -> - get_subnodes(Host, Node). -get_subnodes(Host, <<>>) -> - Q = qlc:q([N || #pubsub_node{nodeid = {NHost, _}, - parents = Parents} = N <- mnesia:table(pubsub_node), - Host == NHost, - Parents == []]), +%% Node = node() +%% From = ljid() +-spec(get_subnodes/3 :: + ( + Host :: host(), % hostPubsub | hostPEP() + NodeId :: nodeId(), + JID :: jidEntity()) + -> SubNodes :: [] | [Node::pubsubNode()] + ). + +get_subnodes(Host, NodeId, _JID) -> + get_subnodes(Host, NodeId). + + +-spec(get_subnodes/2 :: + ( + ParentNodeHost :: host(), % hostPubsub | hostPEP() + ParentNodeId :: nodeId()) + -> SubNodes :: [] | [Node::pubsubNode()] + ). + +get_subnodes(ParentNodeHost, <<>>) -> + Q = qlc:q( + [Node + || #pubsub_node{id = {Host, _}, parents = ParentNodeIds} = Node + <- mnesia:table(pubsub_node), + ParentNodeHost == Host, + ParentNodeIds == []]), qlc:e(Q); -get_subnodes(Host, Node) -> - Q = qlc:q([N || #pubsub_node{nodeid = {NHost, _}, - parents = Parents} = N <- mnesia:table(pubsub_node), - Host == NHost, - lists:member(Node, Parents)]), +get_subnodes(ParentNodeHost, ParentNodeId) -> + Q = qlc:q( + [Node + || #pubsub_node{id = {Host, _}, parents = ParentNodeIds} = Node + <- mnesia:table(pubsub_node), + ParentNodeHost == Host, + lists:member(ParentNodeId, ParentNodeIds)]), qlc:e(Q). -%% @spec (Host, Index, From) -> [pubsubNodeIdx()] | {error, Reason} +%% @spec (Host, Index, From) -> [nodeidx()] | {error, Reason} %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() -get_subnodes_tree(Host, Node, _From) -> - get_subnodes_tree(Host, Node). -get_subnodes_tree(Host, Node) -> - case get_node(Host, Node) of - {error, _} -> - []; - Rec -> - BasePlugin = list_to_atom("node_"++Rec#pubsub_node.type), - BasePath = BasePlugin:node_to_path(Node), - mnesia:foldl(fun(#pubsub_node{nodeid = {H, N}} = R, Acc) -> - Plugin = list_to_atom("node_"++R#pubsub_node.type), - Path = Plugin:node_to_path(N), - case lists:prefix(BasePath, Path) and (H == Host) of - true -> [R | Acc]; - false -> Acc - end - end, [], pubsub_node) +%% Node = node() +%% From = ljid() +-spec(get_subnodes_tree/3 :: + ( + Host :: host(), % hostPubsub | hostPEP() + ParentNodeId :: nodeId(), + JID :: jidEntity()) + -> SubNodes :: [] | [Node::pubsubNode()] + ). + +get_subnodes_tree(Host, ParentNodeId, _JID) -> + get_subnodes_tree(Host, ParentNodeId). + + +-spec(get_subnodes_tree/2 :: + ( + Host :: host(), % hostPubsub | hostPEP() + ParentNodeId :: nodeId()) + -> SubNodes :: [] | [Node::pubsubNode()] + ). + +get_subnodes_tree(ParentNodeHost, ParentNodeId) -> + case get_node(ParentNodeHost, ParentNodeId) of + {error, _} -> []; + #pubsub_node{type = ParentNodeType} = _ParentNode -> + BasePlugin = list_to_atom("node_"++ParentNodeType), + BasePath = BasePlugin:node_to_path(ParentNodeId), + mnesia:foldl(fun + (#pubsub_node{id = {Host, NodeId}, type = Type} = Node, Acc) -> + Plugin = list_to_atom("node_"++Type), + Path = Plugin:node_to_path(NodeId), + case lists:prefix(BasePath, Path) and (Host == ParentNodeHost) of + true -> [Node | Acc]; + false -> Acc + end + end, [], pubsub_node) end. %% @spec (Host, Node, Type, Owner, Options, Parents) -> ok | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() -%% NodeType = mod_pubsub:nodeType() -%% Owner = mod_pubsub:jid() +%% Host = mod_pubsub:host() | ljid() +%% Node = node() +%% NodeType = nodeType() +%% Owner = ljid() %% Options = list() -create_node(Host, Node, Type, Owner, Options, Parents) -> - BJID = jlib:short_prepd_bare_jid(Owner), - case mnesia:read({pubsub_node, {Host, Node}}) of +-spec(create_node/6 :: + ( + Host :: host(), % hostPubsub | hostPEP() + NodeId :: nodeId(), + Type :: nodeType(), + JID :: jidEntity(), + Options :: [nodeOption()], + ParentNodeIds :: [] | [nodeId()]) + -> {'ok', NodeIdx::nodeIdx()} + | {'error', 'conflict' | 'forbidden'} + ). + +create_node(Host, NodeId, Type, #jid{node = U, domain = S} = _JID, Options, ParentNodeIds) -> + Owner = {U,S,undefined}, + case mnesia:read({pubsub_node, {Host, NodeId}}) of [] -> - ParentExists = - case Host of - {_U, _S, _R} -> - %% This is special case for PEP handling - %% PEP does not uses hierarchy - true; - _ -> - case Parents of - [] -> true; - [Parent | _] -> - BHost = list_to_binary(Host), - case mnesia:read({pubsub_node, {Host, Parent}}) of - [#pubsub_node{owners = [{undefined, BHost, undefined}]}] -> true; - [#pubsub_node{owners = Owners}] -> lists:member(BJID, Owners); - _ -> false - end; - _ -> - false - end - end, + ParentExists = case Host of + %% This is special case for PEP handling, PEP does not uses hierarchy + {_, _, _} -> true; + _ -> + case ParentNodeIds of + [] -> true; + [ParentNodeId | _] -> + case mnesia:read({pubsub_node, {Host, ParentNodeId}}) of + [#pubsub_node{owners = [{undefined, Host, undefined}]}] -> true; + [#pubsub_node{owners = Owners}] -> lists:member(Owner, Owners); + _ -> false + end; + _ -> false + end + end, case ParentExists of true -> - NodeId = pubsub_index:new(node), - mnesia:write(#pubsub_node{nodeid = {Host, Node}, - id = NodeId, - parents = Parents, - type = Type, - owners = [BJID], - options = Options}), - {ok, NodeId}; - false -> - %% Requesting entity is prohibited from creating nodes - {error, 'forbidden'} - end; - _ -> - %% NodeID already exists - {error, 'conflict'} + NodeIdx = pubsub_index:new(node), + mnesia:write( + #pubsub_node{id = {Host, NodeId}, + idx = NodeIdx, + parents = ParentNodeIds, + type = Type, + owners = [Owner], + options = Options}), + {ok, NodeIdx}; + false -> %% Requesting entity is prohibited from creating nodes + {error, 'forbidden'} + end; + _ -> %% Node already exists + {error, 'conflict'} end. %% @spec (Host, Node) -> [mod_pubsub:node()] -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() -delete_node(Host, Node) -> - Removed = get_subnodes_tree(Host, Node), - lists:foreach(fun(#pubsub_node{nodeid = {_, N}, id = I}) -> - pubsub_index:free(node, I), - mnesia:delete({pubsub_node, {Host, N}}) - end, Removed), - Removed. +%% Host = mod_pubsub:host() | ljid() +%% Node = node() +-spec(delete_node/2 :: +( + Host :: host(), % hostPubsub | hostPEP() + ParentNodeId :: nodeId()) + -> DeletedNodes :: [] | [Node::pubsubNode()] +). + +delete_node(Host, ParentNodeId) -> + DeletedNodes = get_subnodes_tree(Host, ParentNodeId), + lists:foreach(fun(#pubsub_node{id = {_, NodeId}, idx = NodeIdx}) -> + pubsub_index:free(node, NodeIdx), + mnesia:delete({pubsub_node, {Host, NodeId}}) + end, DeletedNodes), + DeletedNodes. diff --git a/src/mod_pubsub/nodetree_tree_odbc.erl b/src/mod_pubsub/nodetree_tree_odbc.erl index 55c611345..4c2efa7f4 100644 --- a/src/mod_pubsub/nodetree_tree_odbc.erl +++ b/src/mod_pubsub/nodetree_tree_odbc.erl @@ -32,12 +32,10 @@ %%% development is still a work in progress. However, the system is already %%% useable and useful as is. Please, send us comments, feedback and %%% improvements.</p> - -module(nodetree_tree_odbc). -author('christophe.romain@process-one.net'). -include_lib("stdlib/include/qlc.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -include("pubsub.hrl"). @@ -84,16 +82,16 @@ terminate(_Host, _ServerHost) -> ok. %% @spec () -> [Option] -%% Option = mod_pubsub:nodetreeOption() +%% Option = nodetreeOption() %% @doc Returns the default pubsub node tree options. options() -> [{virtual_tree, false}, {odbc, true}]. -%% @spec (Host, Node, From) -> pubsubNode() | {error, Reason} +%% @spec (Host, Node, From) -> node() | {error, Reason} %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() +%% Node = node() get_node(Host, Node, _From) -> get_node(Host, Node). get_node(Host, Node) -> @@ -111,22 +109,22 @@ get_node(Host, Node) -> _ -> {error, 'item_not_found'} end. -get_node(NodeId) -> +get_node(Nidx) -> case catch ejabberd_odbc:sql_query_t( ["select host, node, parent, type " "from pubsub_node " - "where nodeid='", NodeId, "';"]) + "where nodeid='", Nidx, "';"]) of {selected, ["host", "node", "parent", "type"], [{Host, Node, Parent, Type}]} -> - raw_to_node(Host, {Node, Parent, Type, NodeId}); + raw_to_node(Host, {Node, Parent, Type, Nidx}); {'EXIT', _Reason} -> {error, 'internal_server_error'}; _ -> {error, 'item_not_found'} end. -%% @spec (Host, From) -> [pubsubNode()] | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() +%% @spec (Host, From) -> [node()] | {error, Reason} +%% Host = mod_pubsub:host() | ljid() get_nodes(Host, _From) -> get_nodes(Host). get_nodes(Host) -> @@ -143,21 +141,21 @@ get_nodes(Host) -> end. %% @spec (Host, Node, From) -> [{Depth, Record}] | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() -%% Depth = integer() -%% Record = pubsubNode() +%% Host = mod_pubsub:host() | ljid() +%% Node = node() +%% From = ljid() +%% Depth = int() +%% Record = mod_pubsub:pubsub_node() %% @doc <p>Default node tree does not handle parents, return empty list.</p> get_parentnodes(_Host, _Node, _From) -> []. %% @spec (Host, Node, From) -> [{Depth, Record}] | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() -%% Depth = integer() -%% Record = pubsubNode() +%% Host = mod_pubsub:host() | ljid() +%% Node = node() +%% From = ljid() +%% Depth = int() +%% Record = mod_pubsub:pubsub_node() %% @doc <p>Default node tree does not handle parents, return a list %% containing just this node.</p> get_parentnodes_tree(Host, Node, From) -> @@ -182,10 +180,10 @@ get_subnodes(Host, Node) -> [] end. -%% @spec (Host, Index, From) -> [pubsubNodeIdx()] | {error, Reason} +%% @spec (Host, Index, From) -> [nodeidx()] | {error, Reason} %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() +%% Node = node() +%% From = ljid() get_subnodes_tree(Host, Node, _From) -> get_subnodes_tree(Host, Node). get_subnodes_tree(Host, Node) -> @@ -203,10 +201,10 @@ get_subnodes_tree(Host, Node) -> end. %% @spec (Host, Node, Type, Owner, Options, Parents) -> ok | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() -%% NodeType = mod_pubsub:nodeType() -%% Owner = mod_pubsub:jid() +%% Host = mod_pubsub:host() | ljid() +%% Node = node() +%% NodeType = nodeType() +%% Owner = ljid() %% Options = list() create_node(Host, Node, Type, Owner, Options, Parents) -> BJID = jlib:short_prepd_bare_jid(Owner), @@ -223,9 +221,9 @@ create_node(Host, Node, Type, Owner, Options, Parents) -> true; [Parent | _] -> case nodeid(Host, Parent) of - {result, PNodeId} -> + {result, Pidx} -> BHost = list_to_binary(Host), - case nodeowners(PNodeId) of + case nodeowners(Pidx) of [{undefined, BHost, undefined}] -> true; Owners -> lists:member(BJID, Owners) end; @@ -238,12 +236,11 @@ create_node(Host, Node, Type, Owner, Options, Parents) -> end, case ParentExists of true -> - case set_node(#pubsub_node{ - nodeid={Host, Node}, - parents=Parents, - type=Type, - options=Options}) of - {result, NodeId} -> {ok, NodeId}; + case set_node(#pubsub_node{id={Host, Node}, + parents=Parents, + type=Type, + options=Options}) of + {result, Nidx} -> {ok, Nidx}; Other -> Other end; false -> @@ -251,16 +248,16 @@ create_node(Host, Node, Type, Owner, Options, Parents) -> {error, 'forbidden'} end; {result, _} -> - %% NodeID already exists + %% Node already exists {error, 'conflict'}; Error -> Error end. -%% @spec (Host, Node) -> [mod_pubsub:node()] -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() +%% @spec (Host, Node) -> [node()] +%% Host = mod_pubsub:host() | ljid() +%% Node = node() delete_node(Host, Node) -> H = ?PUBSUB:escape(Host), N = ?PUBSUB:escape(?PUBSUB:node_to_string(Node)), @@ -273,11 +270,11 @@ delete_node(Host, Node) -> %% helpers -raw_to_node(Host, {Node, Parent, Type, NodeId}) -> +raw_to_node(Host, {Node, Parent, Type, Nidx}) -> Options = case catch ejabberd_odbc:sql_query_t( ["select name,val " "from pubsub_node_option " - "where nodeid='", NodeId, "';"]) + "where nodeid='", Nidx, "';"]) of {selected, ["name", "val"], ROptions} -> DbOpts = lists:map(fun({Key, Value}) -> @@ -295,16 +292,16 @@ raw_to_node(Host, {Node, Parent, Type, NodeId}) -> [] end, #pubsub_node{ - nodeid = {Host, ?PUBSUB:string_to_node(Node)}, + id = {Host, ?PUBSUB:string_to_node(Node)}, parents = [?PUBSUB:string_to_node(Parent)], - id = NodeId, + idx = Nidx, type = Type, options = Options}. %% @spec (NodeRecord) -> ok | {error, Reason} %% Record = mod_pubsub:pubsub_node() set_node(Record) -> - {Host, Node} = Record#pubsub_node.nodeid, + {Host, Node} = Record#pubsub_node.id, Parent = case Record#pubsub_node.parents of [] -> <<>>; [First | _] -> First @@ -313,29 +310,29 @@ set_node(Record) -> H = ?PUBSUB:escape(Host), N = ?PUBSUB:escape(?PUBSUB:node_to_string(Node)), P = ?PUBSUB:escape(?PUBSUB:node_to_string(Parent)), - NodeId = case nodeid(Host, Node) of - {result, OldNodeId} -> + Nidx = case nodeid(Host, Node) of + {result, OldNidx} -> catch ejabberd_odbc:sql_query_t( ["delete from pubsub_node_option " - "where nodeid='", OldNodeId, "';"]), + "where nodeid='", OldNidx, "';"]), catch ejabberd_odbc:sql_query_t( ["update pubsub_node " "set host='", H, "' " "node='", N, "' " "parent='", P, "' " "type='", Type, "' " - "where nodeid='", OldNodeId, "';"]), - OldNodeId; + "where nodeid='", OldNidx, "';"]), + OldNidx; _ -> catch ejabberd_odbc:sql_query_t( ["insert into pubsub_node(host, node, parent, type) " "values('", H, "', '", N, "', '", P, "', '", Type, "');"]), case nodeid(Host, Node) of - {result, NewNodeId} -> NewNodeId; - _ -> none % this should not happen + {result, NewNidx} -> NewNidx; + _ -> none % this should not happe end end, - case NodeId of + case Nidx of none -> {error, 'internal_server_error'}; _ -> @@ -344,9 +341,9 @@ set_node(Record) -> SValue = ?PUBSUB:escape(lists:flatten(io_lib:fwrite("~p",[Value]))), catch ejabberd_odbc:sql_query_t( ["insert into pubsub_node_option(nodeid, name, val) " - "values('", NodeId, "', '", SKey, "', '", SValue, "');"]) + "values('", Nidx, "', '", SKey, "', '", SValue, "');"]) end, Record#pubsub_node.options), - {result, NodeId} + {result, Nidx} end. nodeid(Host, Node) -> @@ -357,16 +354,16 @@ nodeid(Host, Node) -> "from pubsub_node " "where host='", H, "' and node='", N, "';"]) of - {selected, ["nodeid"], [{NodeId}]} -> - {result, NodeId}; + {selected, ["nodeid"], [{Nidx}]} -> + {result, Nidx}; {'EXIT', _Reason} -> {error, 'internal_server_error'}; _ -> {error, 'item_not_found'} end. -nodeowners(NodeId) -> - {result, Res} = node_flat_odbc:get_node_affiliations(NodeId), +nodeowners(Nidx) -> + {result, Res} = node_flat_odbc:get_node_affiliations(Nidx), lists:foldl(fun({LJID, owner}, Acc) -> [LJID|Acc]; (_, Acc) -> Acc end, [], Res). diff --git a/src/mod_pubsub/nodetree_virtual.erl b/src/mod_pubsub/nodetree_virtual.erl index 8433b9b54..c23ec82f9 100644 --- a/src/mod_pubsub/nodetree_virtual.erl +++ b/src/mod_pubsub/nodetree_virtual.erl @@ -33,8 +33,6 @@ -module(nodetree_virtual). -author('christophe.romain@process-one.net'). --include_lib("exmpp/include/exmpp.hrl"). - -include("pubsub.hrl"). -behaviour(gen_pubsub_nodetree). @@ -86,18 +84,19 @@ set_node(_NodeRecord) -> %% @spec (Host, Node, From) -> pubsubNode() %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() +%% Node = node() %% @doc <p>Virtual node tree does not handle a node database. Any node is considered %% as existing. Node record contains default values.</p> get_node(Host, Node, _From) -> get_node(Host, Node). get_node(Host, Node) -> - #pubsub_node{nodeid = {Host, Node}, id = {Host, Node}, owners = [{undefined, list_to_binary(Host), undefined}]}. + %% TODO : to fix idx + #pubsub_node{id = {Host, Node}, idx = {Host, Node}, owners = [{undefined, list_to_binary(Host), undefined}]}. get_node({Host, _} = NodeId) -> - #pubsub_node{nodeid = NodeId, id = NodeId, owners = [{undefined, list_to_binary(Host), undefined}]}. + #pubsub_node{id = NodeId, idx = NodeId, owners = [{undefined, list_to_binary(Host), undefined}]}. %% @spec (Host, From) -> [pubsubNode()] -%% Host = mod_pubsub:host() | mod_pubsub:jid() +%% Host = mod_pubsub:host() | ljid() %% @doc <p>Virtual node tree does not handle a node database. Any node is considered %% as existing. Nodes list can not be determined.</p> get_nodes(Host, _From) -> @@ -107,8 +106,8 @@ get_nodes(_Host) -> %% @spec (Host, Node, From) -> [pubsubNode()] %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() +%% Node = node() +%% From = ljid() %% @doc <p>Virtual node tree does not handle parent/child. Child list is empty.</p> get_subnodes(Host, Node, _From) -> get_subnodes(Host, Node). @@ -117,7 +116,7 @@ get_subnodes(_Host, _Node) -> %% @spec (Host, Index, From) -> [pubsubNode()] %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() +%% Node = node() %% @doc <p>Virtual node tree does not handle parent/child. Child list is empty.</p> get_subnodes_tree(Host, Node, _From) -> get_subnodes_tree(Host, Node). @@ -126,9 +125,9 @@ get_subnodes_tree(_Host, _Node) -> %% @spec (Host, Node, Type, Owner, Options, Parents) -> ok %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() -%% Type = mod_pubsub:nodeType() -%% Owner = mod_pubsub:jid() +%% Node = node() +%% Type = nodeType() +%% Owner = ljid() %% Options = list() %% @doc <p>No node record is stored on database. Any valid node %% is considered as already created.</p> @@ -143,7 +142,7 @@ create_node(Host, Node, _Type, Owner, _Options, _Parents) -> %% @spec (Host, Node) -> [mod_pubsub:node()] %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() +%% Node = node() %% @doc <p>Virtual node tree does not handle parent/child. %% node deletion just affects the corresponding node.</p> delete_node(Host, Node) -> diff --git a/src/mod_pubsub/pubsub.hrl b/src/mod_pubsub/pubsub.hrl index 9fd5ebd1c..832b4d8c4 100644 --- a/src/mod_pubsub/pubsub.hrl +++ b/src/mod_pubsub/pubsub.hrl @@ -21,6 +21,11 @@ %%% This file contains pubsub types definition. %%% ==================================================================== + +-include_lib("exmpp/include/exmpp.hrl"). +-include_lib("exmpp/include/exmpp_jid.hrl"). + + %% ------------------------------- %% Pubsub constants -define(ERR_EXTENDED(E,C), mod_pubsub:extended_error(E,C)). @@ -32,19 +37,176 @@ %% Would be nice to have it configurable. -define(MAX_PAYLOAD_SIZE, 60000). -%% ------------------------------- + +%% ------------ %% Pubsub types +%% ------------ + +%%% @type hostPubsub() = binary(). +%%% +%%% <p><tt>hostPubsub</tt> is the name of the PubSub service. For example, it can be +%%% <tt>pubsub.localhost</tt>.</p> + +-type(hostPubsub() :: binary()). + + +%%% @type hostPEP() = {User, Server, Resource} +%%% User = binary() +%%% Server = binary() +%%% Resource = undefined. + +-type(hostPEP() :: {User::binary(), Server::binary, Resource::undefined}). + + +%%% @type host() = hostPubsub() | hostPEP(). + +-type(host() :: hostPubsub() | hostPEP()). + + +%% TODO : move upper in exmpp +%%% @type nodeId() = binary(). +%%% +%%% <p>A <tt>nodeId</tt> is the name of a Node. It can be anything and may represent +%%% some hierarchical tree depending of the node type. +%%% For example: +%%% /home/localhost/user/node +%%% princely_musings +%%% http://jabber.org/protocol/tune +%%% My-Own_Node</p> + +-type(nodeId() :: binary()). + + +%%% @type itemId() = binary(). +%%% +%%% <p>An <tt>itemId</tt> is the name of an Item. It can be anything. +%%% For example: +%%% 38964 +%%% my-tune +%%% FD6SBE6a27d</p> + +-type(itemId() :: binary()). + + +%%% @type subId() = binary(). + +-type(subId() :: binary()). + + +%%% @type nodeType() = string(). +%%% +%%% <p>The <tt>nodeType</tt> is a string containing the name of the PubSub +%%% plugin to use to manage a given node. For example, it can be +%%% <tt>"flat"</tt>, <tt>"hometree"</tt> or <tt>"blog"</tt>.</p> + +-type(nodeType() :: string()). + + +%%% @type ljid() = {User, Server, Resource} +%%% User = undefined | binary() +%%% Server = binary() +%%% Resource = undefined | binary(). + +-type(ljid() :: {User::binary(), Server::binary(), Resource::binary()}). + + +%% TODO : move upper in exmpp +%%% @type jidComponent() = {jid, Raw, Node, Domain, Resource} +%%% Raw = binary() +%%% Node = undefined +%%% Domain = binary() +%%% Resource = undefined. + +-type(jidComponent() :: + #jid{raw::binary(), node::undefined, domain::binary(), resource::undefined}). + + +%% TODO : move upper in exmpp +%%% @type jidContact() = {jid, Raw, Node, Domain, Resource} +%%% Raw = binary() +%%% Node = binary() +%%% Domain = binary() +%%% Resource = undefined. + +-type(jidContact() :: + #jid{raw::binary(), node::binary(), domain::binary(), resource::undefined}). + + +%% TODO : move upper in exmpp +%%% @type jidEntity() = {jid, Raw, Node, Domain, Resource} +%%% Raw = binary() +%%% Node = undefined | binary() +%%% Domain = binary() +%%% Resource = undefined | binary(). + + +-type(jidEntity() :: + %% Contact bare JID + #jid{raw::binary(), node::binary(), domain::binary(), resource::undefined} | + %% Contact full JID + #jid{raw::binary(), node::binary(), domain::binary(), resource::binary()} | + %% Component bare JID + #jid{raw::binary(), node::undefined, domain::binary(), resource::undefined} | + %% Component full JID + #jid{raw::binary(), node::undefined, domain::binary(), resource::binary()}). + + +%%% @type bareUsr() = {User, Server, Resource} +%%% User = undefined | binary() +%%% Server = binary() +%%% Resource = undefined. + +-type(bareUsr() :: {User::binary(), Server::binary(), Resource::undefined} + | {User::undefined, Server::binary(), Resource::undefined}). + + +%%% @type fullUsr() = {User, Server, Resource} +%%% User = undefined | binary() +%%% Server = binary() +%%% Resource = undefined | binary(). + + +-type(fullUsr() :: {User::binary(), Server::binary(), Resource::undefined} + | {User::binary(), Server::binary(), Resource::binary()} + | {User::undefined, Server::binary(), Resource::undefined} + | {User::undefined, Server::binary(), Resource::binary()}). + + +%%% @type nodeIdx() = integer(). -%%% @type host() = string(). -%%% <p><tt>host</tt> is the name of the PubSub service. For example, it can be -%%% <tt>"pubsub.localhost"</tt>.</p> +-type(nodeIdx() :: integer()). + + +%%% @type now() = {Megaseconds, Seconds, Microseconds} +%%% Megaseconds = integer() +%%% Seconds = integer() +%%% Microseconds = integer(). + +-type(now() :: {Megaseconds::integer(), Seconds::integer(), Microseconds::integer()}). + + +%%% @type affiliation() = 'none' | 'owner' | 'publisher' |'publish-only' | 'member' | 'outcast'. + +-type(affiliation() :: 'none' | 'owner' | 'publisher' |'publish-only' | 'member' | 'outcast'). + + +%%% @type subscription() = 'none' | 'pending' | 'unconfigured' | 'subscribed'. + +-type(subscription() :: 'none' | 'pending' | 'unconfigured' | 'subscribed'). + + +%%% @type accessModel() = 'open' | 'presence' | 'roster' | 'authorize' | 'whitelist'. + +-type(accessModel() :: 'open' | 'presence' | 'roster' | 'authorize' | 'whitelist'). + + +%%% @type payload() = [] | [#xmlel{}]. + +-type(payload() :: [] | [#xmlel{}]). -%%% @type pubsubNode() = [string()]. -%%% <p>A node is defined by a list of its ancestors. The last element is the name -%%% of the current node. For example: -%%% ```["home", "localhost", "cromain", "node1"]'''</p> %%% @type stanzaError() = #xmlel{}. +%%% %%% Example: %%% ```#xmlel{name = 'error' %%% ns = ?NS_STANZAS, @@ -62,7 +224,11 @@ %%% } %%% ]}''' +-type(stanzaError() :: #xmlel{}). + + %%% @type pubsubIQResponse() = #xmlel{}. +%%% %%% Example: %%% ```#xmlel{name = 'pubsub', %%% ns = ?NS_PUBSUB, @@ -73,89 +239,145 @@ %%% ] %%% }''' -%%% @type nodeOption() = {Option::atom(), Value::term()}. +-type(pubsubIQResponse() :: #xmlel{}). + + +%%% @type features() = [Feature] +%%% Feature = string(). + +-type(features() :: [Feature::string()]). + +%%% @type nodeOption() = {Option, Value}. +%%% Option = atom() +%%% Value = term(). +%%% %%% Example: %%% ```{deliver_payloads, true}''' -%%% @type nodeType() = string(). -%%% <p>The <tt>nodeType</tt> is a string containing the name of the PubSub -%%% plugin to use to manage a given node. For example, it can be -%%% <tt>"flat"</tt>, <tt>"hometree"</tt> or <tt>"blog"</tt>.</p> +-type(nodeOption() :: {Option::atom(), Value::term()}). -%%% @type jid() = #jid{ -%%% user = string(), -%%% server = string(), -%%% resource = string(), -%%% luser = string(), -%%% lserver = string(), -%%% lresource = string()}. -%%% @type ljid() = {User::string(), Server::string(), Resource::string()}. +%%% @type subOption() = {Option, Value}. +%%% Option = atom() +%%% Value = term(). -%%% @type affiliation() = none | owner | publisher | outcast. -%%% @type subscription() = none | pending | unconfigured | subscribed. +-type(subOption() :: {Option::atom(), Value::term()}). -%%% internal pubsub index table --record(pubsub_index, {index, last, free}). -%%% @type pubsubNode() = #pubsub_node{ -%%% nodeid = {Host::host(), Node::pubsubNode()}, -%%% parentid = Node::pubsubNode(), -%%% nodeidx = int(), -%%% type = nodeType(), -%%% options = [nodeOption()]}. +%%% @type pubsubIndex() = {pubsub_index, Index, Last, Free}. +%%% Index = atom() +%%% Last = nodeIdx() +%%% Free = [nodeIdx()]. +%%% +%%% Internal pubsub index table. + +-record(pubsub_index, + { + index :: atom(), + last :: integer(), + free :: [integer()] + }). + +-type(pubsubIndex() :: #pubsub_index{}). + + +%%% @type pubsubNode() = {pubsub_node, Id, Idx, Parents, Type, Owners, Options} +%%% Id = {host(), nodeId()} +%%% Idx = nodeIdx() +%%% Parents = [nodeId()] +%%% Type = nodeType() +%%% Owners = [bareUsr()] +%%% Options = [nodeOption()]. +%%% %%% <p>This is the format of the <tt>nodes</tt> table. The type of the table %%% is: <tt>set</tt>,<tt>ram/disc</tt>.</p> -%%% <p>The <tt>parentid</tt> and <tt>type</tt> fields are indexed.</p> -%%% <p><tt>nodeidx</tt> can be anything you want.</p> --record(pubsub_node, {nodeid, - id, - parents = [], - type = "flat", - owners = [], - options = [] - }). - -%%% @type pubsubState() = #pubsub_state{ -%%% stateid = {ljid(), nodeidx()}, -%%% items = [ItemId::string()], -%%% affiliation = affiliation(), -%%% subscriptions = [subscription()]}. +%%% <p>The <tt>parents</tt> and <tt>type</tt> fields are indexed.</p> +%%% <p><tt>idx</tt> is an integer.</p> + +-record(pubsub_node, + { + id :: {host(), nodeId()}, + idx :: nodeIdx(), + parents = [] :: [nodeId()], + type = "flat" :: nodeType(), + owners = [] :: [bareUsr()], + options = [] :: [nodeOption()] + }). + +-type(pubsubNode() :: #pubsub_node{}). + + +%%% @type pubsubState() = {pubsub_state, Id, Items, Affiliation, Subscriptions} +%%% Id = {fullUsr(), nodeIdx()} +%%% Items = [itemId()] +%%% Affiliation = affiliation() +%%% Subscriptions = [{subscription(), subId()}]. +%%% %%% <p>This is the format of the <tt>affiliations</tt> table. The type of the %%% table is: <tt>set</tt>,<tt>ram/disc</tt>.</p> --record(pubsub_state, {stateid, - items = [], - affiliation = none, - subscriptions = [] -}). - -%%% @type pubsubItem() = #pubsub_item{ -%%% itemid = {ItemId::string(), nodeidx()}, -%%% creation = {now(), ljid()}, -%%% modification = {now(), ljid()}, -%%% payload = XMLContent::string()}. + +-record(pubsub_state, + { + id :: {fullUsr(), nodeIdx()}, + items = [] :: [itemId()], + affiliation = 'none' :: affiliation(), + subscriptions = [] :: [{subscription(), subId()}] + }). + +-type(pubsubState() :: #pubsub_state{}). + + +%%% @type pubsubItem() = {pubsub_item, Id, Creation, Modification, Payload} +%%% Id = {itemId(), nodeIdx()} +%%% Creation = {now(), bareUsr()} +%%% Modification = {now(), fullUsr()} +%%% Payload = payload(). +%%% %%% <p>This is the format of the <tt>published items</tt> table. The type of the %%% table is: <tt>set</tt>,<tt>disc</tt>,<tt>fragmented</tt>.</p> --record(pubsub_item, {itemid, - creation = {unknown,unknown}, - modification = {unknown,unknown}, - payload = [] - }). - -%% @type pubsubSubscription() = #pubsub_subscription{ -%% subid = string(), -%% state_key = {ljid(), pubsubNodeId()}, -%% options = [{atom(), term()}] -%% }. + +-record(pubsub_item, + { + id :: {itemId(), nodeIdx()}, + creation = {unknown,unknown} :: {now(), bareUsr()}, + modification = {unknown,unknown} :: {now(), fullUsr()}, + payload = [] :: payload() + }). + +-type(pubsubItem() :: #pubsub_item{}). + + +%%% @type pubsubSubscription() = {pubsub_subscription, SubId, Options} +%%% SubId = subId() +%%% Options = [nodeOption()]. +%%% %% <p>This is the format of the <tt>subscriptions</tt> table. The type of the %% table is: <tt>set</tt>,<tt>ram/disc</tt>.</p> --record(pubsub_subscription, {subid, options}). -%% @type pubsubLastItem() = #pubsub_last_item{ -%% nodeid = nodeidx(), -%% itemid = string(), -%% creation = {now(), ljid()}, -%% payload = XMLContent::string()}. +-record(pubsub_subscription, + { + subid :: subId(), + options :: [subOption()] + }). + +-type(pubsubSubscription() :: #pubsub_subscription{}). + + +%%% @type pubsubLastItem() = {pubsub_last_item, NodeId, ItemId, Creation, Payload} +%%% NodeId = nodeIdx() +%%% ItemId = itemId() +%%% Creation = {now(), bareUsr()} +%%% Payload = payload(). +%%% %% <p>This is the format of the <tt>last items</tt> table. it stores last item payload %% for every node</p> --record(pubsub_last_item, {nodeid, itemid, creation, payload}). + +-record(pubsub_last_item, + { + nodeid :: nodeIdx(), + itemid :: itemId(), + creation :: {now(), bareUsr()}, + payload :: payload() + }). + +-type(pubsubLastItem() :: #pubsub_last_item{}). diff --git a/src/mod_pubsub/pubsub_db_odbc.erl b/src/mod_pubsub/pubsub_db_odbc.erl index dfdcbbc2c..42811786b 100644 --- a/src/mod_pubsub/pubsub_db_odbc.erl +++ b/src/mod_pubsub/pubsub_db_odbc.erl @@ -32,27 +32,27 @@ %% Those -spec lines produce errors in old Erlang versions. %% They can be enabled again in ejabberd 3.0 because it uses R12B or higher. --spec read_subscription(SubID :: string()) -> {ok, #pubsub_subscription{}} | notfound. -read_subscription(SubID) -> +-spec read_subscription(SubId :: string()) -> {ok, #pubsub_subscription{}} | notfound. +read_subscription(SubId) -> case ejabberd_odbc:sql_query_t( ["select opt_name, opt_value " "from pubsub_subscription_opt " - "where subid = '", ejabberd_odbc:escape(SubID), "'"]) of + "where subid = '", ejabberd_odbc:escape(SubId), "'"]) of {selected, ["opt_name", "opt_value"], []} -> notfound; {selected, ["opt_name", "opt_value"], Options} -> - {ok, #pubsub_subscription{subid = SubID, + {ok, #pubsub_subscription{subid = SubId, options = lists:map(fun subscription_opt_from_odbc/1, Options)}} end. --spec delete_subscription(SubID :: string()) -> ok. -delete_subscription(SubID) -> +-spec delete_subscription(SubId :: string()) -> ok. +delete_subscription(SubId) -> ejabberd_odbc:sql_query_t(["delete from pubsub_subscription_opt " - "where subid = '", ejabberd_odbc:escape(SubID), "'"]), + "where subid = '", ejabberd_odbc:escape(SubId), "'"]), ok. diff --git a/src/mod_pubsub/pubsub_index.erl b/src/mod_pubsub/pubsub_index.erl index 6cde91dcc..3b1601bc8 100644 --- a/src/mod_pubsub/pubsub_index.erl +++ b/src/mod_pubsub/pubsub_index.erl @@ -31,35 +31,58 @@ -include("pubsub.hrl"). --export([init/3, new/1, free/2]). +-export([ + init/3, + new/1, + free/2 + ]). + + +-spec(init/3 :: + ( + Host :: string(), + ServerHost :: string(), + Opts :: [{Key::atom(), Value::term()}]) + -> 'ok' + ). init(_Host, _ServerHost, _Opts) -> mnesia:create_table(pubsub_index, [{disc_copies, [node()]}, {attributes, record_info(fields, pubsub_index)}]). + +-spec(new/1 :: + ( + Index::atom()) + -> Idx::integer() + ). + new(Index) -> case mnesia:read({pubsub_index, Index}) of - [I] -> - case I#pubsub_index.free of - [] -> - Id = I#pubsub_index.last + 1, - mnesia:write(I#pubsub_index{last = Id}), - Id; - [Id|Free] -> - mnesia:write(I#pubsub_index{free = Free}), - Id - end; - _ -> - mnesia:write(#pubsub_index{index = Index, last = 1, free = []}), - 1 + [#pubsub_index{free = [], last = Last} = PubsubIndex] -> + Idx = Last + 1, + mnesia:write(PubsubIndex#pubsub_index{last = Idx}), + Idx; + [#pubsub_index{free = [Idx|Free]} = PubsubIndex] -> + mnesia:write(PubsubIndex#pubsub_index{free = Free}), + Idx; + _ -> + mnesia:write(#pubsub_index{index = Index, last = 1, free = []}), + 1 end. -free(Index, Id) -> + +-spec(free/2 :: + ( + Index :: atom(), + Idx :: integer()) + -> 'ok' + ). + +free(Index, Idx) -> case mnesia:read({pubsub_index, Index}) of - [I] -> - Free = I#pubsub_index.free, - mnesia:write(I#pubsub_index{free = [Id|Free]}); - _ -> - ok + [#pubsub_index{free = Free} = PubsubIndex] -> + mnesia:write(PubsubIndex#pubsub_index{free = [Idx|Free]}); + _ -> ok end. diff --git a/src/mod_pubsub/pubsub_odbc.patch b/src/mod_pubsub/pubsub_odbc.patch index 4ca79a9bd..5309386ff 100644 --- a/src/mod_pubsub/pubsub_odbc.patch +++ b/src/mod_pubsub/pubsub_odbc.patch @@ -1,5 +1,5 @@ ---- mod_pubsub.erl 2010-08-04 18:28:18.000000000 +0200 -+++ mod_pubsub_odbc.erl 2010-08-04 18:29:41.000000000 +0200 +--- mod_pubsub.erl 2010-09-23 10:43:43.000000000 +0200 ++++ mod_pubsub_odbc.erl 2010-09-29 11:46:22.000000000 +0200 @@ -42,7 +42,7 @@ %%% 6.2.3.1, 6.2.3.5, and 6.3. For information on subscription leases see %%% XEP-0060 section 12.18. @@ -9,7 +9,7 @@ -author('christophe.romain@process-one.net'). -version('1.13-0'). -@@ -55,9 +55,9 @@ +@@ -53,9 +53,9 @@ -include("adhoc.hrl"). -include("pubsub.hrl"). @@ -22,7 +22,7 @@ %% exports for hooks -export([presence_probe/3, -@@ -104,7 +104,7 @@ +@@ -102,7 +102,7 @@ string_to_affiliation/1, extended_error/2, extended_error/3, @@ -31,7 +31,7 @@ ]). %% API and gen_server callbacks -@@ -123,7 +123,7 @@ +@@ -121,7 +121,7 @@ -export([send_loop/1 ]). @@ -40,7 +40,7 @@ -define(LOOPNAME, ejabberd_mod_pubsub_loop). -define(PLUGIN_PREFIX, "node_"). -define(TREE_PREFIX, "nodetree_"). -@@ -220,8 +220,6 @@ +@@ -218,8 +218,6 @@ ok end, ejabberd_router:register_route(Host), @@ -49,7 +49,7 @@ init_nodes(Host, ServerHost, NodeTree, Plugins), State = #state{host = Host, server_host = ServerHost, -@@ -280,206 +278,15 @@ +@@ -278,209 +276,14 @@ init_nodes(Host, ServerHost, _NodeTree, Plugins) -> %% TODO, this call should be done plugin side @@ -59,7 +59,7 @@ - create_node(Host, ServerHost, string_to_node("/home"), service_jid(Host), "hometree"), - create_node(Host, ServerHost, string_to_node("/home/" ++ ServerHost), service_jid(Host), "hometree"); + create_node(Host, ServerHost, string_to_node("/home"), service_jid(Host), "hometree_odbc"), -+ create_node(Host, ServerHost, string_to_node("/home/" ++ ServerHost), service_jid(Host), "hometree_odbc"); ++ create_node(Host, ServerHost, string_to_node("/home/" ++ ServerHost), service_jid(Host), "hometree_odbc"); false -> ok end. @@ -72,18 +72,18 @@ - ?INFO_MSG("upgrade node pubsub tables",[]), - F = fun() -> - {Result, LastIdx} = lists:foldl( -- fun({pubsub_node, NodeId, ParentId, {nodeinfo, Items, Options, Entities}}, {RecList, NodeIdx}) -> +- fun({pubsub_node, NodeId, ParentId, {nodeinfo, Items, Options, Entities}}, {RecList, Nidx}) -> - ItemsList = - lists:foldl( -- fun({item, IID, Publisher, Payload}, Acc) -> +- fun({item, ItemName, Publisher, Payload}, Acc) -> - C = {unknown, Publisher}, - M = {now(), Publisher}, - mnesia:write( -- #pubsub_item{itemid = {IID, NodeIdx}, +- #pubsub_item{id = {ItemName, Nidx}, - creation = C, - modification = M, - payload = Payload}), -- [{Publisher, IID} | Acc] +- [{Publisher, ItemName} | Acc] - end, [], Items), - Owners = - dict:fold( @@ -97,7 +97,7 @@ - end - end, [], ItemsList), - mnesia:write({pubsub_state, -- {JID, NodeIdx}, +- {JID, Nidx}, - UsrItems, - Aff, - Sub}), @@ -107,12 +107,12 @@ - end - end, [], Entities), - mnesia:delete({pubsub_node, NodeId}), -- {[#pubsub_node{nodeid = NodeId, -- id = NodeIdx, +- {[#pubsub_node{id = NodeId, +- idx = Nidx, - parents = [element(2, ParentId)], - owners = Owners, - options = Options} | -- RecList], NodeIdx + 1} +- RecList], Nidx + 1} - end, {[], 1}, - mnesia:match_object( - {pubsub_node, {Host, '_'}, '_', '_'})), @@ -137,32 +137,33 @@ - [nodeid, parentid, type, owners, options] -> - F = fun({pubsub_node, NodeId, {_, Parent}, Type, Owners, Options}) -> - #pubsub_node{ -- nodeid = NodeId, -- id = 0, +- id = NodeId, +- idx = 0, - parents = [Parent], - type = Type, - owners = Owners, - options = Options} - end, +- %% TODO : to change nodeid/id and id/idx or not to change ? - mnesia:transform_table(pubsub_node, F, [nodeid, id, parents, type, owners, options]), - FNew = fun() -> -- LastIdx = lists:foldl(fun(#pubsub_node{nodeid = NodeId} = PubsubNode, NodeIdx) -> -- mnesia:write(PubsubNode#pubsub_node{id = NodeIdx}), -- lists:foreach(fun(#pubsub_state{stateid = StateId} = State) -> +- LastIdx = lists:foldl(fun(#pubsub_node{id = NodeId} = PubsubNode, Nidx) -> +- mnesia:write(PubsubNode#pubsub_node{idx = Nidx}), +- lists:foreach(fun(#pubsub_state{id = StateId} = State) -> - {JID, _} = StateId, - mnesia:delete({pubsub_state, StateId}), -- mnesia:write(State#pubsub_state{stateid = {JID, NodeIdx}}) -- end, mnesia:match_object(#pubsub_state{stateid = {'_', NodeId}, _ = '_'})), -- lists:foreach(fun(#pubsub_item{itemid = ItemId} = Item) -> -- {IID, _} = ItemId, +- mnesia:write(State#pubsub_state{id = {JID, Nidx}}) +- end, mnesia:match_object(#pubsub_state{id = {'_', NodeId}, _ = '_'})), +- lists:foreach(fun(#pubsub_item{id = ItemId} = Item) -> +- {ItemName, _} = ItemId, - {M1, M2} = Item#pubsub_item.modification, - {C1, C2} = Item#pubsub_item.creation, - mnesia:delete({pubsub_item, ItemId}), -- mnesia:write(Item#pubsub_item{itemid = {IID, NodeIdx}, +- mnesia:write(Item#pubsub_item{id = {ItemName, Nidx}, - modification = {M2, M1}, - creation = {C2, C1}}) -- end, mnesia:match_object(#pubsub_item{itemid = {'_', NodeId}, _ = '_'})), -- NodeIdx + 1 +- end, mnesia:match_object(#pubsub_item{id = {'_', NodeId}, _ = '_'})), +- Nidx + 1 - end, 1, mnesia:match_object( - {pubsub_node, {Host, '_'}, '_', '_', '_', '_', '_'}) - ++ mnesia:match_object( @@ -179,13 +180,14 @@ - [nodeid, id, parent, type, owners, options] -> - F = fun({pubsub_node, NodeId, Id, Parent, Type, Owners, Options}) -> - #pubsub_node{ -- nodeid = NodeId, -- id = Id, +- id = NodeId, +- idx = Id, - parents = [Parent], - type = Type, - owners = Owners, - options = Options} - end, +- %% TODO : to change nodeid/id and id/idx or not to change ? - mnesia:transform_table(pubsub_node, F, [nodeid, id, parents, type, owners, options]), - rename_default_nodeplugin(); - _ -> @@ -203,7 +205,7 @@ - [<<>>] -> []; - Parents -> Parents - end, -- mnesia:write(Node#pubsub_node{nodeid={H, BN}, parents=BP}), +- mnesia:write(Node#pubsub_node{id={H, BN}, parents=BP}), - mnesia:delete({pubsub_node, {H, N}}); - (_) -> - ok @@ -222,15 +224,15 @@ - case catch mnesia:table_info(pubsub_state, attributes) of - [stateid, items, affiliation, subscription] -> - ?INFO_MSG("upgrade state pubsub tables", []), -- F = fun ({pubsub_state, {JID, NodeID}, Items, Aff, Sub}, Acc) -> +- F = fun ({pubsub_state, {JID, NodeId}, Items, Aff, Sub}, Acc) -> - Subs = case Sub of - none -> - []; - _ -> -- {result, SubID} = pubsub_subscription:subscribe_node(JID, NodeID, []), -- [{Sub, SubID}] +- {result, SubId} = pubsub_subscription:subscribe_node(JID, NodeId, []), +- [{Sub, SubId}] - end, -- NewState = #pubsub_state{stateid = {JID, NodeID}, +- NewState = #pubsub_state{id = {JID, NodeId}, - items = Items, - affiliation = Aff, - subscriptions = Subs}, @@ -256,11 +258,11 @@ - _ -> - ok - end. -+ - +- send_loop(State) -> receive -@@ -491,7 +298,10 @@ + {presence, JID, Pid} -> +@@ -491,7 +294,10 @@ %% for each node From is subscribed to %% and if the node is so configured, send the last published item to From lists:foreach(fun(PType) -> @@ -272,37 +274,37 @@ lists:foreach( fun({Node, subscribed, _, SubJID}) -> if (SubJID == LJID) or (SubJID == BJID) -> -@@ -616,7 +426,8 @@ +@@ -616,7 +422,8 @@ [#xmlel{name = 'identity', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('category', <<"pubsub">>), ?XMLATTR('type', <<"pep">>)]}]; disco_identity(Host, Node, From) -> -- Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> -+ Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> -+ Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of +- Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> ++ Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> ++ Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> {result, -@@ -647,7 +458,8 @@ +@@ -647,7 +454,8 @@ [?NS_PUBSUB_s | [?NS_PUBSUB_s++"#"++Feature || Feature <- features("pep")]]; disco_features(Host, Node, From) -> -- Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> -+ Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> -+ Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of +- Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> ++ Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> ++ Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> {result, [?NS_PUBSUB_s -@@ -666,7 +478,8 @@ +@@ -666,7 +474,8 @@ {result, disco_items(To, Node, From) ++ OtherItems}. disco_items(Host, <<>>, From) -> -- Action = fun(#pubsub_node{nodeid ={_, NodeID}, options = Options, type = Type, id = Idx, owners = Owners}, Acc) -> -+ Action = fun(#pubsub_node{nodeid ={_, NodeID}, options = Options, type = Type, id = Idx}, Acc) -> -+ Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of +- Action = fun(#pubsub_node{id ={_, NodeId}, options = Options, type = Type, idx = Nidx, owners = Owners}, Acc) -> ++ Action = fun(#pubsub_node{id ={_, NodeId}, options = Options, type = Type, idx = Nidx}, Acc) -> ++ Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> [#xmlel{name = 'item', ns = ?NS_DISCO_INFO, -@@ -680,13 +493,14 @@ +@@ -680,13 +489,14 @@ _ -> Acc end end, @@ -313,26 +315,26 @@ end; disco_items(Host, Node, From) -> -- Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> -+ Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> -+ Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of +- Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> ++ Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> ++ Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, Items} -> {result, -@@ -771,10 +585,10 @@ +@@ -772,10 +582,10 @@ lists:foreach(fun(PType) -> {result, Subscriptions} = node_action(Host, PType, get_entity_subscriptions, [Host, Entity]), lists:foreach(fun -- ({#pubsub_node{options = Options, owners = Owners, id = NodeId}, subscribed, _, JID}) -> -+ ({#pubsub_node{options = Options, id = NodeId}, subscribed, _, JID}) -> +- ({#pubsub_node{options = Options, owners = Owners, idx = Nidx}, subscribed, _, JID}) -> ++ ({#pubsub_node{options = Options, idx = Nidx}, subscribed, _, JID}) -> case get_option(Options, access_model) of presence -> - case lists:member(BJID, Owners) of -+ case lists:member(BJID, node_owners(Host, PType, NodeId)) of ++ case lists:member(BJID, node_owners(Host, PType, Nidx)) of true -> - node_action(Host, PType, unsubscribe_node, [NodeId, Entity, JID, all]); + node_action(Host, PType, unsubscribe_node, [Nidx, Entity, JID, all]); false -> -@@ -949,10 +763,11 @@ +@@ -950,10 +760,11 @@ end, ejabberd_router:route(To, From, Res); #iq{type = get, ns = ?NS_DISCO_ITEMS, @@ -346,16 +348,16 @@ {result, IQRes} -> Result = #xmlel{ns = ?NS_DISCO_ITEMS, name = 'query', attrs = QAttrs, -@@ -1089,7 +904,7 @@ +@@ -1090,7 +901,7 @@ [] -> ["leaf"]; %% No sub-nodes: it's a leaf node _ -> -- case node_call(Type, get_items, [NodeId, From]) of -+ case node_call(Type, get_items, [NodeId, From, none]) of +- case node_call(Type, get_items, [Nidx, From]) of ++ case node_call(Type, get_items, [Nidx, From, none]) of {result, []} -> ["collection"]; {result, _} -> ["leaf", "collection"]; _ -> [] -@@ -1105,8 +920,9 @@ +@@ -1106,8 +917,9 @@ []; true -> [#xmlel{ns = ?NS_DISCO_INFO, name = 'feature', attrs = [?XMLATTR('var', ?NS_PUBSUB_s)]} | @@ -367,7 +369,7 @@ end, features(Type))] end, %% TODO: add meta-data info (spec section 5.4) -@@ -1135,8 +951,9 @@ +@@ -1136,8 +948,9 @@ #xmlel{ns = ?NS_DISCO_INFO, name = 'feature', attrs = [?XMLATTR('var', ?NS_PUBSUB_s)]}, #xmlel{ns = ?NS_DISCO_INFO, name = 'feature', attrs = [?XMLATTR('var', ?NS_ADHOC_s)]}, #xmlel{ns = ?NS_DISCO_INFO, name = 'feature', attrs = [?XMLATTR('var', ?NS_VCARD_s)]}] ++ @@ -379,7 +381,7 @@ end, features(Host, Node))}; ?NS_ADHOC_b -> command_disco_info(Host, Node, From); -@@ -1146,7 +963,7 @@ +@@ -1147,7 +960,7 @@ node_disco_info(Host, Node, From) end. @@ -388,7 +390,7 @@ case tree_action(Host, get_subnodes, [Host, <<>>, From]) of Nodes when is_list(Nodes) -> {result, lists:map( -@@ -1163,7 +980,7 @@ +@@ -1164,7 +977,7 @@ Other -> Other end; @@ -397,7 +399,7 @@ %% TODO: support localization of this string CommandItems = [ #xmlel{ns = ?NS_DISCO_ITEMS, name = 'item', -@@ -1172,19 +989,20 @@ +@@ -1173,19 +986,20 @@ ?XMLATTR('name', "Get Pending") ]}], {result, CommandItems}; @@ -408,22 +410,22 @@ -iq_disco_items(Host, Item, From) -> +iq_disco_items(Host, Item, From, RSM) -> case string:tokens(Item, "!") of - [_SNode, _ItemID] -> + [_SNode, _ItemId] -> {result, []}; [SNode] -> Node = string_to_node(SNode), -- Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> -- NodeItems = case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of -+ Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> -+ Owners = node_owners_call(Type, Idx), -+ {NodeItems, RsmOut} = case get_allowed_items_call(Host, Idx, From, Type, Options, Owners, RSM) of +- Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> +- NodeItems = case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of ++ Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> ++ Owners = node_owners_call(Type, Nidx), ++ {NodeItems, RsmOut} = case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners, RSM) of {result, R} -> R; - _ -> [] + _ -> {[], none} end, Nodes = lists:map( - fun(#pubsub_node{nodeid = {_, SubNode}, options = SubOptions}) -> -@@ -1202,7 +1020,7 @@ + fun(#pubsub_node{id = {_, SubNode}, options = SubOptions}) -> +@@ -1203,7 +1017,7 @@ {result, Name} = node_call(Type, get_item_name, [Host, Node, RN]), #xmlel{ns = ?NS_DISCO_ITEMS, name = 'item', attrs = [?XMLATTR('jid', Host), ?XMLATTR('name', Name)]} end, NodeItems), @@ -432,30 +434,29 @@ end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Result}} -> {result, Result}; -@@ -1210,12 +1028,6 @@ +@@ -1211,12 +1025,6 @@ end end. --get_allowed_items_call(Host, NodeIdx, From, Type, Options, Owners) -> +-get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) -> - AccessModel = get_option(Options, access_model), - AllowedGroups = get_option(Options, roster_groups_allowed, []), - {PresenceSubscription, RosterGroup} = get_presence_and_roster_permissions(Host, From, Owners, AccessModel, AllowedGroups), -- node_call(Type, get_items, [NodeIdx, From, AccessModel, PresenceSubscription, RosterGroup, undefined]). +- node_call(Type, get_items, [Nidx, From, AccessModel, PresenceSubscription, RosterGroup, undefined]). - get_presence_and_roster_permissions(Host, From, Owners, AccessModel, AllowedGroups) -> if (AccessModel == presence) or (AccessModel == roster) -> case Host of -@@ -1333,7 +1145,8 @@ +@@ -1334,7 +1142,7 @@ (_, Acc) -> Acc end, [], exmpp_xml:remove_cdata_from_list(Els)), -- get_items(Host, Node, From, SubId, MaxItems, ItemIDs); -+ RSM = jlib:rsm_decode(SubEl), -+ get_items(Host, Node, From, SubId, MaxItems, ItemIDs, RSM); +- get_items(Host, Node, From, SubId, MaxItems, ItemIds); ++ get_items(Host, Node, From, SubId, MaxItems, ItemIds, jlib:rsm_decode(SubEl)); {get, 'subscriptions'} -> get_subscriptions(Host, Node, From, Plugins); {get, 'affiliations'} -> -@@ -1490,7 +1303,8 @@ +@@ -1491,7 +1299,8 @@ _ -> [] end end, @@ -465,36 +466,36 @@ sync_dirty) of {result, Res} -> Res; Err -> Err -@@ -1534,7 +1348,7 @@ +@@ -1535,7 +1344,7 @@ %%% authorization handling --send_authorization_request(#pubsub_node{owners = Owners, nodeid = {Host, Node}}, Subscriber) -> -+send_authorization_request(#pubsub_node{nodeid = {Host, Node}, type = Type, id = NodeId}, Subscriber) -> +-send_authorization_request(#pubsub_node{owners = Owners, id = {Host, Node}}, Subscriber) -> ++send_authorization_request(#pubsub_node{id = {Host, Node}, type = Type, idx = Nidx}, Subscriber) -> Lang = <<"en">>, %% TODO fix {U, S, R} = Subscriber, Stanza = #xmlel{ns = ?NS_JABBER_CLIENT, name = 'message', children = -@@ -1564,7 +1378,7 @@ +@@ -1565,7 +1374,7 @@ lists:foreach(fun(Owner) -> {U, S, R} = Owner, ejabberd_router:route(service_jid(Host), exmpp_jid:make(U, S, R), Stanza) - end, Owners). -+ end, node_owners(Host, Type, NodeId)). ++ end, node_owners(Host, Type, Nidx)). find_authorization_response(Packet) -> Els = Packet#xmlel.children, -@@ -1623,8 +1437,8 @@ +@@ -1624,8 +1433,8 @@ "true" -> true; _ -> false end, -- Action = fun(#pubsub_node{type = Type, owners = Owners, id = NodeId}) -> +- Action = fun(#pubsub_node{type = Type, owners = Owners, idx = Nidx}) -> - IsApprover = lists:member(jlib:short_prepd_bare_jid(From), Owners), -+ Action = fun(#pubsub_node{type = Type, id = NodeId}) -> -+ IsApprover = lists:member(jlib:short_prepd_bare_jid(From), node_owners_call(Type, NodeId)), - {result, Subscriptions} = node_call(Type, get_subscriptions, [NodeId, Subscriber]), ++ Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> ++ IsApprover = lists:member(jlib:short_prepd_bare_jid(From), node_owners_call(Type, Nidx)), + {result, Subscriptions} = node_call(Type, get_subscriptions, [Nidx, Subscriber]), if not IsApprover -> -@@ -1823,7 +1637,7 @@ +@@ -1824,7 +1633,7 @@ end, Reply = #xmlel{ns = ?NS_PUBSUB, name = 'pubsub', children = [#xmlel{ns = ?NS_PUBSUB, name = 'create', attrs = nodeAttr(Node)}]}, @@ -503,7 +504,7 @@ {result, {NodeId, SubsByDepth, {Result, broadcast}}} -> broadcast_created_node(Host, Node, NodeId, Type, NodeOptions, SubsByDepth), case Result of -@@ -1927,7 +1741,7 @@ +@@ -1928,7 +1737,7 @@ %%<li>The node does not exist.</li> %%</ul> subscribe_node(Host, Node, From, JID, Configuration) -> @@ -512,50 +513,50 @@ {result, GoodSubOpts} -> GoodSubOpts; _ -> invalid end, -@@ -1937,7 +1751,7 @@ +@@ -1938,7 +1747,7 @@ _:_ -> {undefined, undefined, undefined} end, -- Action = fun(#pubsub_node{options = Options, owners = Owners, type = Type, id = NodeId}) -> -+ Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> +- Action = fun(#pubsub_node{options = Options, owners = Owners, type = Type, idx = Nidx}) -> ++ Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), SubscribeFeature = lists:member("subscribe", Features), OptionsFeature = lists:member("subscription-options", Features), -@@ -1946,6 +1760,7 @@ +@@ -1947,6 +1756,7 @@ AccessModel = get_option(Options, access_model), SendLast = get_option(Options, send_last_published_item), AllowedGroups = get_option(Options, roster_groups_allowed, []), -+ Owners = node_owners_call(Type, NodeId), ++ Owners = node_owners_call(Type, Nidx), {PresenceSubscription, RosterGroup} = get_presence_and_roster_permissions(Host, Subscriber, Owners, AccessModel, AllowedGroups), if not SubscribeFeature -> -@@ -2290,7 +2105,7 @@ +@@ -2291,7 +2101,7 @@ %% <p>The permission are not checked in this function.</p> %% @todo We probably need to check that the user doing the query has the right %% to read the items. --get_items(Host, Node, From, SubId, SMaxItems, ItemIDs) -> -+get_items(Host, Node, From, SubId, SMaxItems, ItemIDs, RSM) -> +-get_items(Host, Node, From, SubId, SMaxItems, ItemIds) -> ++get_items(Host, Node, From, SubId, SMaxItems, ItemIds, RSM) -> MaxItems = if SMaxItems == "" -> get_max_items_node(Host); -@@ -2304,12 +2119,13 @@ +@@ -2305,12 +2115,13 @@ {error, Error} -> {error, Error}; _ -> -- Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId, owners = Owners}) -> -+ Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> +- Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx, owners = Owners}) -> ++ Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), RetreiveFeature = lists:member("retrieve-items", Features), PersistentFeature = lists:member("persistent-items", Features), AccessModel = get_option(Options, access_model), AllowedGroups = get_option(Options, roster_groups_allowed, []), -+ Owners = node_owners_call(Type, NodeId), ++ Owners = node_owners_call(Type, Nidx), {PresenceSubscription, RosterGroup} = get_presence_and_roster_permissions(Host, From, Owners, AccessModel, AllowedGroups), if not RetreiveFeature -> -@@ -2322,11 +2138,11 @@ +@@ -2323,11 +2134,11 @@ node_call(Type, get_items, - [NodeId, From, + [Nidx, From, AccessModel, PresenceSubscription, RosterGroup, - SubId]) + SubId, RSM]) @@ -564,10 +565,10 @@ case transaction(Host, Node, Action, sync_dirty) of - {result, {_, Items}} -> + {result, {_, Items, RSMOut}} -> - SendItems = case ItemIDs of + SendItems = case ItemIds of [] -> Items; -@@ -2339,7 +2155,7 @@ +@@ -2340,7 +2151,7 @@ %% number of items sent to MaxItems: {result, #xmlel{ns = ?NS_PUBSUB, name = 'pubsub', children = [#xmlel{ns = ?NS_PUBSUB, name = 'items', attrs = nodeAttr(Node), children = @@ -576,7 +577,7 @@ Error -> Error end -@@ -2360,6 +2176,17 @@ +@@ -2363,6 +2174,17 @@ {result, {_, Items}} -> Items; Error -> Error end. @@ -594,7 +595,7 @@ %% @spec (Host, Node, NodeId, Type, LJID, Number) -> any() %% Host = pubsubHost() -@@ -2371,16 +2198,29 @@ +@@ -2374,16 +2196,29 @@ %% @doc <p>Resend the items of a node to the user.</p> %% @todo use cache-last-item feature send_items(Host, Node, NodeId, Type, LJID, last) -> @@ -630,21 +631,21 @@ send_items(Host, Node, NodeId, Type, {LU, LS, LR} = LJID, Number) -> ToSend = case node_action(Host, Type, get_items, [NodeId, LJID]) of {result, []} -> -@@ -2507,7 +2347,8 @@ +@@ -2510,7 +2345,8 @@ error -> {error, 'bad-request'}; _ -> -- Action = fun(#pubsub_node{owners = Owners, type = Type, id = NodeId}=N) -> -+ Action = fun(#pubsub_node{type = Type, id = NodeId}) -> -+ Owners = node_owners_call(Type, NodeId), +- Action = fun(#pubsub_node{owners = Owners, type = Type, idx = Nidx}=N) -> ++ Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> ++ Owners = node_owners_call(Type, Nidx), case lists:member(Owner, Owners) of true -> OwnerJID = exmpp_jid:make(Owner), -@@ -2517,24 +2358,8 @@ +@@ -2520,24 +2356,8 @@ end, lists:foreach( fun({JID, Affiliation}) -> -- {result, _} = node_call(Type, set_affiliation, [NodeId, JID, Affiliation]), +- {result, _} = node_call(Type, set_affiliation, [Nidx, JID, Affiliation]), - case Affiliation of - owner -> - NewOwner = jlib:short_prepd_bare_jid(JID), @@ -663,16 +664,16 @@ - ok - end + % TODO, check if nothing missing here about new owners -+ node_call(Type, set_affiliation, [NodeId, JID, Affiliation]) ++ node_call(Type, set_affiliation, [Nidx, JID, Affiliation]) end, FilteredEntities), {result, []}; _ -> -@@ -2589,11 +2414,11 @@ +@@ -2592,11 +2412,11 @@ end. - read_sub(Subscriber, Node, NodeID, SubID, Lang) -> -- case pubsub_subscription:get_subscription(Subscriber, NodeID, SubID) of -+ case pubsub_subscription_odbc:get_subscription(Subscriber, NodeID, SubID) of + read_sub(Subscriber, Node, NodeId, SubId, Lang) -> +- case pubsub_subscription:get_subscription(Subscriber, NodeId, SubId) of ++ case pubsub_subscription_odbc:get_subscription(Subscriber, NodeId, SubId) of {error, notfound} -> {error, extended_error('not-acceptable', "invalid-subid")}; {result, #pubsub_subscription{options = Options}} -> @@ -680,37 +681,37 @@ + {result, XdataEl} = pubsub_subscription_odbc:get_options_xform(Lang, Options), OptionsEl = #xmlel{ns = ?NS_PUBSUB, name = 'options', attrs = [ ?XMLATTR('jid', exmpp_jid:to_binary(Subscriber)), - ?XMLATTR('subid', SubID) | nodeAttr(Node)], -@@ -2620,7 +2445,7 @@ + ?XMLATTR('subid', SubId) | nodeAttr(Node)], +@@ -2623,7 +2443,7 @@ end. - set_options_helper(Configuration, JID, NodeID, SubID, Type) -> + set_options_helper(Configuration, JID, NodeId, SubId, Type) -> - SubOpts = case pubsub_subscription:parse_options_xform(Configuration) of + SubOpts = case pubsub_subscription_odbc:parse_options_xform(Configuration) of {result, GoodSubOpts} -> GoodSubOpts; _ -> invalid end, -@@ -2650,7 +2475,7 @@ - write_sub(_Subscriber, _NodeID, _SubID, invalid) -> +@@ -2653,7 +2473,7 @@ + write_sub(_Subscriber, _NodeId, _SubId, invalid) -> {error, extended_error('bad-request', "invalid-options")}; - write_sub(Subscriber, NodeID, SubID, Options) -> -- case pubsub_subscription:set_subscription(Subscriber, NodeID, SubID, Options) of -+ case pubsub_subscription_odbc:set_subscription(Subscriber, NodeID, SubID, Options) of + write_sub(Subscriber, NodeId, SubId, Options) -> +- case pubsub_subscription:set_subscription(Subscriber, NodeId, SubId, Options) of ++ case pubsub_subscription_odbc:set_subscription(Subscriber, NodeId, SubId, Options) of {error, notfound} -> {error, extended_error('not-acceptable', "invalid-subid")}; {result, _} -> -@@ -2824,8 +2649,8 @@ +@@ -2827,8 +2647,8 @@ ?XMLATTR('subsription', subscription_to_string(Sub)) | nodeAttr(Node)]}]}]}, ejabberd_router:route(service_jid(Host), JID, Stanza) end, -- Action = fun(#pubsub_node{owners = Owners, type = Type, id = NodeId}) -> +- Action = fun(#pubsub_node{owners = Owners, type = Type, idx = Nidx}) -> - case lists:member(Owner, Owners) of -+ Action = fun(#pubsub_node{type = Type, id = NodeId}) -> -+ case lists:member(Owner, node_owners_call(Type, NodeId)) of ++ Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> ++ case lists:member(Owner, node_owners_call(Type, Nidx)) of true -> Result = lists:foldl(fun({JID, Subscription, SubId}, Acc) -> -@@ -3174,7 +2999,7 @@ +@@ -3177,7 +2997,7 @@ {Depth, [{N, get_node_subs(N)} || N <- Nodes]} end, tree_call(Host, get_parentnodes_tree, [Host, Node, service_jid(Host)]))} end, @@ -719,19 +720,16 @@ {result, CollSubs} -> CollSubs; _ -> [] end. -@@ -3188,9 +3013,9 @@ +@@ -3190,7 +3010,7 @@ - get_options_for_subs(NodeID, Subs) -> - lists:foldl(fun({JID, subscribed, SubID}, Acc) -> -- case pubsub_subscription:read_subscription(JID, NodeID, SubID) of -+ case pubsub_subscription_odbc:get_subscription(JID, NodeID, SubID) of - {error, notfound} -> [{JID, SubID, []} | Acc]; -- #pubsub_subscription{options = Options} -> [{JID, SubID, Options} | Acc]; -+ {result, #pubsub_subscription{options = Options}} -> [{JID, SubID, Options} | Acc]; + get_options_for_subs(Nidx, Subs) -> + lists:foldl(fun({JID, subscribed, SubId}, Acc) -> +- case pubsub_subscription:read_subscription(JID, Nidx, SubId) of ++ case pubsub_subscription_odbc:read_subscription(JID, Nidx, SubId) of + {error, notfound} -> [{JID, SubId, []} | Acc]; + #pubsub_subscription{options = Options} -> [{JID, SubId, Options} | Acc]; _ -> Acc - end; - (_, Acc) -> -@@ -3412,6 +3237,30 @@ +@@ -3414,6 +3234,30 @@ Result end. @@ -762,7 +760,7 @@ %% @spec (Host, Options) -> MaxItems %% Host = host() %% Options = [Option] -@@ -3815,7 +3664,13 @@ +@@ -3817,7 +3661,13 @@ tree_action(Host, Function, Args) -> ?DEBUG("tree_action ~p ~p ~p",[Host,Function,Args]), Fun = fun() -> tree_call(Host, Function, Args) end, @@ -777,7 +775,7 @@ %% @doc <p>node plugin call.</p> node_call(Type, Function, Args) -> -@@ -3835,13 +3690,13 @@ +@@ -3837,13 +3687,13 @@ node_action(Host, Type, Function, Args) -> ?DEBUG("node_action ~p ~p ~p ~p",[Host,Type,Function,Args]), @@ -793,7 +791,7 @@ case tree_call(Host, get_node, [Host, Node]) of N when is_record(N, pubsub_node) -> case Action(N) of -@@ -3854,13 +3709,20 @@ +@@ -3856,13 +3706,20 @@ end end, Trans). @@ -818,7 +816,7 @@ {result, Result} -> {result, Result}; {error, Error} -> {error, Error}; {atomic, {result, Result}} -> {result, Result}; -@@ -3868,6 +3730,15 @@ +@@ -3870,6 +3727,15 @@ {aborted, Reason} -> ?ERROR_MSG("transaction return internal error: ~p~n", [{aborted, Reason}]), {error, 'internal-server-error'}; @@ -834,7 +832,7 @@ {'EXIT', Reason} -> ?ERROR_MSG("transaction return internal error: ~p~n", [{'EXIT', Reason}]), {error, 'internal-server-error'}; -@@ -3876,6 +3747,16 @@ +@@ -3878,6 +3744,16 @@ {error, 'internal-server-error'} end. diff --git a/src/mod_pubsub/pubsub_subscription.erl b/src/mod_pubsub/pubsub_subscription.erl index 72a721877..be33aa0ea 100644 --- a/src/mod_pubsub/pubsub_subscription.erl +++ b/src/mod_pubsub/pubsub_subscription.erl @@ -24,29 +24,32 @@ -author("bjc@kublai.com"). %% API --export([init/0, +-export([ + init/0, subscribe_node/3, unsubscribe_node/3, get_subscription/3, set_subscription/4, get_options_xform/2, - parse_options_xform/1]). + parse_options_xform/1 + ]). -% Internal function also exported for use in transactional bloc from pubsub plugins --export([add_subscription/3, + % Internal function also exported for use in transactional bloc from pubsub plugins +-export([ + add_subscription/3, delete_subscription/3, read_subscription/3, - write_subscription/4]). + write_subscription/4 + ]). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). --define(PUBSUB_DELIVER, "pubsub#deliver"). --define(PUBSUB_DIGEST, "pubsub#digest"). +-define(PUBSUB_DELIVER, "pubsub#deliver"). +-define(PUBSUB_DIGEST, "pubsub#digest"). -define(PUBSUB_DIGEST_FREQUENCY, "pubsub#digest_frequency"). --define(PUBSUB_EXPIRE, "pubsub#expire"). +-define(PUBSUB_EXPIRE, "pubsub#expire"). -define(PUBSUB_INCLUDE_BODY, "pubsub#include_body"). --define(PUBSUB_SHOW_VALUES, "pubsub#show-values"). +-define(PUBSUB_SHOW_VALUES, "pubsub#show-values"). -define(PUBSUB_SUBSCRIPTION_TYPE, "pubsub#subscription_type"). -define(PUBSUB_SUBSCRIPTION_DEPTH, "pubsub#subscription_depth"). @@ -55,11 +58,11 @@ -define(DIGEST_LABEL, "Whether an entity wants to receive digests (aggregations) of notifications or all notifications individually"). -define(DIGEST_FREQUENCY_LABEL, - "The minimum number of milliseconds between sending any two notification digests"). + "The minimum number of milliseconds between sending any two notification digests"). -define(EXPIRE_LABEL, "The DateTime at which a leased subscription will end or has ended"). -define(INCLUDE_BODY_LABEL, - "Whether an entity wants to receive an XMPP message body in addition to the payload format"). + "Whether an entity wants to receive an XMPP message body in addition to the payload format"). -define(SHOW_VALUES_LABEL, "The presence states for which an entity wants to receive notifications"). -define(SUBSCRIPTION_TYPE_LABEL, @@ -86,113 +89,194 @@ %%==================================================================== %% API %%==================================================================== +-spec(init/0 :: () -> 'ok'). + init() -> ok = create_table(). -subscribe_node(JID, NodeID, Options) -> - try mnesia:sync_dirty(fun add_subscription/3, - [JID, NodeID, Options]) of +-spec(subscribe_node/3 :: + ( + Entity :: jidEntity() | fullUsr(), + NodeIdx :: nodeIdx(), + Options :: [nodeOption()]) + -> {'result', SubId::subId()} | {'error', _} + ). + +subscribe_node(#jid{node = U, domain = S, resource = R}, NodeIdx, Options) -> + subscribe_node({U,S,R}, NodeIdx, Options); +subscribe_node(Entity, NodeIdx, Options) -> + try mnesia:sync_dirty(fun add_subscription/3, [Entity, NodeIdx, Options]) of {error, Error} -> {error, Error}; - Result -> {result, Result} + Result -> {result, Result} catch - Error -> Error + Error -> Error end. -unsubscribe_node(JID, NodeID, SubID) -> - try mnesia:sync_dirty(fun delete_subscription/3, - [JID, NodeID, SubID]) of + +-spec(unsubscribe_node/3 :: + ( + JID :: jidEntity(), + NodeIdx :: nodeIdx(), + SubId :: subId()) + -> {'result','ok'} | {'error', _} + ). + +unsubscribe_node(#jid{node = U, domain = S, resource = R} = _JID, NodeIdx, SubId) -> + try mnesia:sync_dirty(fun delete_subscription/3, [{U,S,R}, NodeIdx, SubId]) of {error, Error} -> {error, Error}; - Result -> {result, Result} + Result -> {result, Result} catch Error -> Error end. -get_subscription(JID, NodeID, SubID) -> - try mnesia:sync_dirty(fun read_subscription/3, - [JID, NodeID, SubID]) of + +-spec(get_subscription/3 :: + ( + JID :: jidEntity(), + NodeIdx :: nodeIdx(), + SubId :: subId()) + -> {'result', pubsubSubscription()} | {'error', _} + ). + +get_subscription(#jid{node = U, domain = S, resource = R} = _JID, NodeIdx, SubId) -> + try mnesia:sync_dirty(fun read_subscription/3, [{U,S,R}, NodeIdx, SubId]) of {error, Error} -> {error, Error}; - Result -> {result, Result} + Subscription -> {result, Subscription} catch Error -> Error end. -set_subscription(JID, NodeID, SubID, Options) -> - try mnesia:sync_dirty(fun write_subscription/4, - [JID, NodeID, SubID, Options]) of + +-spec(set_subscription/4 :: + ( + JID :: jidEntity(), + NodeIdx :: nodeIdx(), + SubId :: subId(), + Options :: [nodeOption()]) + -> {'result', 'ok'} | {'error', _} + ). + +set_subscription(#jid{node = U, domain = S, resource = R} = _JID, NodeIdx, SubId, Options) -> + try mnesia:sync_dirty(fun write_subscription/4, [{U,S,R}, NodeIdx, SubId, Options]) of {error, Error} -> {error, Error}; - Result -> {result, Result} + Result -> {result, Result} catch Error -> Error end. + +%% TODO : check input type data get_options_xform(Lang, Options) -> Keys = [deliver, digest, digest_frequency, expire, include_body, show_values, subscription_type, subscription_depth], XFields = [get_option_xfield(Lang, Key, Options) || Key <- Keys], - {result, #xmlel{ns = ?NS_DATA_FORMS, name = 'x', attrs = [?XMLATTR('type', <<"form">>)], children = - [#xmlel{ns = ?NS_DATA_FORMS, - name = 'field', - attrs = [?XMLATTR('var', <<"FORM_TYPE">>), ?XMLATTR('type', <<"hidden">>)], - children = [#xmlel{ns = ?NS_DATA_FORMS, - name = 'value', - children = [?XMLCDATA(?NS_PUBSUB_SUBSCRIBE_OPTIONS_s)]}]}] ++ XFields}}. + {result, #xmlel{ns = ?NS_DATA_FORMS, name = 'x', attrs = [?XMLATTR('type', <<"form">>)], children = + [#xmlel{ns = ?NS_DATA_FORMS, + name = 'field', + attrs = [?XMLATTR('var', <<"FORM_TYPE">>), ?XMLATTR('type', <<"hidden">>)], + children = [#xmlel{ns = ?NS_DATA_FORMS, + name = 'value', + children = [?XMLCDATA(?NS_PUBSUB_SUBSCRIBE_OPTIONS_s)]}]}] ++ XFields}}. +%% TODO : check input type data parse_options_xform(XFields) -> case XFields of - [] -> {result, []}; - _ -> case exmpp_xml:remove_cdata_from_list(XFields) of - [] -> {result, []}; - [#xmlel{name = 'x'} = XEl] -> - case jlib:parse_xdata_submit(XEl) of - XData when is_list(XData) -> - case set_xoption(XData, []) of - Opts when is_list(Opts) -> {result, Opts}; - Other -> Other - end; - Other -> - Other - end; - Other -> - Other - end + [] -> {result, []}; + _ -> case exmpp_xml:remove_cdata_from_list(XFields) of + [] -> {result, []}; + [#xmlel{name = 'x'} = XEl] -> + case jlib:parse_xdata_submit(XEl) of + XData when is_list(XData) -> + case set_xoption(XData, []) of + Opts when is_list(Opts) -> {result, Opts}; + Other -> Other + end; + Other -> + Other + end; + Other -> + Other + end end. %%==================================================================== %% Internal functions %%==================================================================== +-spec(create_table/0 :: () -> 'ok'). + create_table() -> case mnesia:create_table(pubsub_subscription, [{disc_copies, [node()]}, {attributes, record_info(fields, pubsub_subscription)}, - {type, set}]) of - {atomic, ok} -> ok; + {type, set}]) + of + {atomic, ok} -> ok; {aborted, {already_exists, _}} -> ok; - Other -> Other + Other -> Other + end. + +-spec(add_subscription/3 :: + ( + Entity :: fullUsr(), + NodeIdx :: nodeIdx(), + Options :: [nodeOption()]) + -> SubId::subId() + ). + +add_subscription(_Entity, _NodeIdx, Options) -> + SubId = make_subid(), + mnesia:write(#pubsub_subscription{subid = SubId, options = Options}), + SubId. + + +-spec(delete_subscription/3 :: + ( + Entity :: fullUsr(), + NodeIdx :: nodeIdx(), + SubId :: subId()) + -> 'ok' + ). + +delete_subscription(_Entity, _NodeIdx, SubId) -> + mnesia:delete({pubsub_subscription, SubId}). + + +-spec(read_subscription/3 :: + ( + Entity :: fullUsr(), + NodeIdx :: nodeIdx(), + SubId :: subId()) + -> pubsubSubscription() | {'error', 'notfound'} + ). + +read_subscription(_Entity, _NodeIdx, SubId) -> + case mnesia:read({pubsub_subscription, SubId}) of + [Subscription] -> Subscription; + _ -> {'error', 'notfound'} end. -add_subscription(_JID, _NodeID, Options) -> - SubID = make_subid(), - mnesia:write(#pubsub_subscription{subid = SubID, options = Options}), - SubID. -delete_subscription(_JID, _NodeID, SubID) -> - mnesia:delete({pubsub_subscription, SubID}). +-spec(write_subscription/4 :: + ( + Entity :: fullUsr(), + NodeIdx :: nodeIdx(), + SubId :: subId(), + Options :: [nodeOption()]) + -> 'ok' | {'error', 'notfound'} + ). -read_subscription(_JID, _NodeID, SubID) -> - case mnesia:read({pubsub_subscription, SubID}) of - [Sub] -> Sub; - _ -> {error, notfound} +write_subscription(Entity, NodeIdx, SubId, Options) -> + case read_subscription(Entity, NodeIdx, SubId) of + {error, 'notfound'} -> {error, 'notfound'}; + Subscription -> mnesia:write(Subscription#pubsub_subscription{options = Options}) end. -write_subscription(JID, NodeID, SubID, Options) -> - case read_subscription(JID, NodeID, SubID) of - {error, notfound} -> {error, notfound}; - Sub -> mnesia:write(Sub#pubsub_subscription{options = Options}) - end. + +-spec(make_subid/0 :: () -> SubId::subId()). make_subid() -> {T1, T2, T3} = now(), - lists:flatten(io_lib:fwrite("~.16B~.16B~.16B", [T1, T2, T3])). + list_to_binary(lists:flatten(io_lib:fwrite("~.16B~.16B~.16B", [T1, T2, T3]))). %% %% Subscription XForm processing. @@ -200,6 +284,7 @@ make_subid() -> %% Return processed options, with types converted and so forth, using %% Opts as defaults. +%% TODO : check input type data set_xoption([], Opts) -> Opts; set_xoption([{Var, Value} | T], Opts) -> @@ -212,33 +297,36 @@ set_xoption([{Var, Value} | T], Opts) -> end, set_xoption(T, NewOpts). + %% Return the options list's key for an XForm var. -var_xfield(?PUBSUB_DELIVER) -> deliver; -var_xfield(?PUBSUB_DIGEST) -> digest; -var_xfield(?PUBSUB_DIGEST_FREQUENCY) -> digest_frequency; -var_xfield(?PUBSUB_EXPIRE) -> expire; -var_xfield(?PUBSUB_INCLUDE_BODY) -> include_body; -var_xfield(?PUBSUB_SHOW_VALUES) -> show_values; -var_xfield(?PUBSUB_SUBSCRIPTION_TYPE) -> subscription_type; -var_xfield(?PUBSUB_SUBSCRIPTION_DEPTH) -> subscription_depth; -var_xfield(_) -> {error, badarg}. +var_xfield(?PUBSUB_DELIVER) -> 'deliver'; +var_xfield(?PUBSUB_DIGEST) -> 'digest'; +var_xfield(?PUBSUB_DIGEST_FREQUENCY) -> 'digest_frequency'; +var_xfield(?PUBSUB_EXPIRE) -> 'expire'; +var_xfield(?PUBSUB_INCLUDE_BODY) -> 'include_body'; +var_xfield(?PUBSUB_SHOW_VALUES) -> 'show_values'; +var_xfield(?PUBSUB_SUBSCRIPTION_TYPE) -> 'subscription_type'; +var_xfield(?PUBSUB_SUBSCRIPTION_DEPTH) -> 'subscription_depth'; +var_xfield(_) -> {error, 'badarg'}. + %% Convert Values for option list's Key. -val_xfield(deliver, [Val]) -> xopt_to_bool(Val); -val_xfield(digest, [Val]) -> xopt_to_bool(Val); -val_xfield(digest_frequency, [Val]) -> list_to_integer(Val); -val_xfield(expire, [Val]) -> jlib:datetime_string_to_timestamp(Val); -val_xfield(include_body, [Val]) -> xopt_to_bool(Val); -val_xfield(show_values, Vals) -> Vals; -val_xfield(subscription_type, ["items"]) -> items; -val_xfield(subscription_type, ["nodes"]) -> nodes; -val_xfield(subscription_depth, ["all"]) -> all; -val_xfield(subscription_depth, [Depth]) -> +val_xfield('deliver', [Val]) -> xopt_to_bool(Val); +val_xfield('digest', [Val]) -> xopt_to_bool(Val); +val_xfield('digest_frequency', [Val]) -> list_to_integer(Val); +val_xfield('expire', [Val]) -> jlib:datetime_string_to_timestamp(Val); +val_xfield('include_body', [Val]) -> xopt_to_bool(Val); +val_xfield('show_values', Vals) -> Vals; +val_xfield('subscription_type', ["items"]) -> items; +val_xfield('subscription_type', ["nodes"]) -> nodes; +val_xfield('subscription_depth', ["all"]) -> all; +val_xfield('subscription_depth', [Depth]) -> case catch list_to_integer(Depth) of - N when is_integer(N) -> N; - _ -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'not-acceptable')} + Integer when is_integer(Integer) -> Integer; + _ -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'not-acceptable')} end. + %% Convert XForm booleans to Erlang booleans. xopt_to_bool("0") -> false; xopt_to_bool("1") -> true; @@ -248,6 +336,7 @@ xopt_to_bool(_) -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'not-acce %% Return a field for an XForm for Key, with data filled in, if %% applicable, from Options. +%% TODO : check input type data get_option_xfield(Lang, Key, Options) -> Var = xfield_var(Key), Label = xfield_label(Key), @@ -263,73 +352,76 @@ get_option_xfield(Lang, Key, Options) -> attrs = [?XMLATTR('var', Var), ?XMLATTR('type', Type), ?XMLATTR('label', translate:translate(Lang, Label))], children = OptEls ++ Vals}. +%% TODO : check input type data type_and_options({Type, Options}, Lang) -> {Type, [tr_xfield_options(O, Lang) || O <- Options]}; type_and_options(Type, _Lang) -> {Type, []}. +%% TODO : check input type data tr_xfield_options({Value, Label}, Lang) -> #xmlel{ns = ?NS_DATA_FORMS, - name = 'option', - attrs = [?XMLATTR('label', translate:translate(Lang, Label))], - children = [#xmlel{ns = ?NS_DATA_FORMS, - name = 'value', - children = [?XMLCDATA(Value)]}]}. + name = 'option', + attrs = [?XMLATTR('label', translate:translate(Lang, Label))], + children = [#xmlel{ns = ?NS_DATA_FORMS, + name = 'value', + children = [?XMLCDATA(Value)]}]}. +%% TODO : check input type data tr_xfield_values(Value) -> #xmlel{ns = ?NS_DATA_FORMS, name ='value', children = [?XMLCDATA(Value)]}. %% Return the XForm variable name for a subscription option key. -xfield_var(deliver) -> ?PUBSUB_DELIVER; -xfield_var(digest) -> ?PUBSUB_DIGEST; -xfield_var(digest_frequency) -> ?PUBSUB_DIGEST_FREQUENCY; -xfield_var(expire) -> ?PUBSUB_EXPIRE; -xfield_var(include_body) -> ?PUBSUB_INCLUDE_BODY; -xfield_var(show_values) -> ?PUBSUB_SHOW_VALUES; -xfield_var(subscription_type) -> ?PUBSUB_SUBSCRIPTION_TYPE; -xfield_var(subscription_depth) -> ?PUBSUB_SUBSCRIPTION_DEPTH. +xfield_var('deliver') -> ?PUBSUB_DELIVER; +xfield_var('digest') -> ?PUBSUB_DIGEST; +xfield_var('digest_frequency') -> ?PUBSUB_DIGEST_FREQUENCY; +xfield_var('expire') -> ?PUBSUB_EXPIRE; +xfield_var('include_body') -> ?PUBSUB_INCLUDE_BODY; +xfield_var('show_values') -> ?PUBSUB_SHOW_VALUES; +xfield_var('subscription_type') -> ?PUBSUB_SUBSCRIPTION_TYPE; +xfield_var('subscription_depth') -> ?PUBSUB_SUBSCRIPTION_DEPTH. %% Return the XForm variable type for a subscription option key. -xfield_type(deliver) -> "boolean"; -xfield_type(digest) -> "boolean"; -xfield_type(digest_frequency) -> "text-single"; -xfield_type(expire) -> "text-single"; -xfield_type(include_body) -> "boolean"; -xfield_type(show_values) -> +xfield_type('deliver') -> "boolean"; +xfield_type('digest') -> "boolean"; +xfield_type('digest_frequency') -> "text-single"; +xfield_type('expire') -> "text-single"; +xfield_type('include_body') -> "boolean"; +xfield_type('show_values') -> {"list-multi", [{"away", ?SHOW_VALUE_AWAY_LABEL}, {"chat", ?SHOW_VALUE_CHAT_LABEL}, {"dnd", ?SHOW_VALUE_DND_LABEL}, {"online", ?SHOW_VALUE_ONLINE_LABEL}, {"xa", ?SHOW_VALUE_XA_LABEL}]}; -xfield_type(subscription_type) -> +xfield_type(subscription_type) -> {"list-single", [{"items", ?SUBSCRIPTION_TYPE_VALUE_ITEMS_LABEL}, {"nodes", ?SUBSCRIPTION_TYPE_VALUE_NODES_LABEL}]}; xfield_type(subscription_depth) -> - {"list-single", [{"1", ?SUBSCRIPTION_DEPTH_VALUE_ONE_LABEL}, + {"list-single", [{"1", ?SUBSCRIPTION_DEPTH_VALUE_ONE_LABEL}, {"all", ?SUBSCRIPTION_DEPTH_VALUE_ALL_LABEL}]}. %% Return the XForm variable label for a subscription option key. -xfield_label(deliver) -> ?DELIVER_LABEL; -xfield_label(digest) -> ?DIGEST_LABEL; -xfield_label(digest_frequency) -> ?DIGEST_FREQUENCY_LABEL; -xfield_label(expire) -> ?EXPIRE_LABEL; -xfield_label(include_body) -> ?INCLUDE_BODY_LABEL; -xfield_label(show_values) -> ?SHOW_VALUES_LABEL; -xfield_label(subscription_type) -> ?SUBSCRIPTION_TYPE_LABEL; -xfield_label(subscription_depth) -> ?SUBSCRIPTION_DEPTH_LABEL. +xfield_label('deliver') -> ?DELIVER_LABEL; +xfield_label('digest') -> ?DIGEST_LABEL; +xfield_label('digest_frequency') -> ?DIGEST_FREQUENCY_LABEL; +xfield_label('expire') -> ?EXPIRE_LABEL; +xfield_label('include_body') -> ?INCLUDE_BODY_LABEL; +xfield_label('show_values') -> ?SHOW_VALUES_LABEL; +xfield_label('subscription_type') -> ?SUBSCRIPTION_TYPE_LABEL; +xfield_label('subscription_depth') -> ?SUBSCRIPTION_DEPTH_LABEL. %% Return the XForm value for a subscription option key. -xfield_val(deliver, Val) -> [bool_to_xopt(Val)]; -xfield_val(digest, Val) -> [bool_to_xopt(Val)]; -xfield_val(digest_frequency, Val) -> [integer_to_list(Val)]; -xfield_val(expire, Val) -> [jlib:now_to_utc_string(Val)]; -xfield_val(include_body, Val) -> [bool_to_xopt(Val)]; -xfield_val(show_values, Val) -> Val; -xfield_val(subscription_type, items) -> ["items"]; -xfield_val(subscription_type, nodes) -> ["nodes"]; -xfield_val(subscription_depth, all) -> ["all"]; -xfield_val(subscription_depth, N) -> [integer_to_list(N)]. +xfield_val('deliver', Val) -> [bool_to_xopt(Val)]; +xfield_val('digest', Val) -> [bool_to_xopt(Val)]; +xfield_val('digest_frequency', Val) -> [integer_to_list(Val)]; +xfield_val('expire', Val) -> [jlib:now_to_utc_string(Val)]; +xfield_val('include_body', Val) -> [bool_to_xopt(Val)]; +xfield_val('show_values', Val) -> Val; +xfield_val('subscription_type', 'items') -> ["items"]; +xfield_val('subscription_type', 'nodes') -> ["nodes"]; +xfield_val('subscription_depth', 'all') -> ["all"]; +xfield_val('subscription_depth', Depth) -> [integer_to_list(Depth)]. %% Convert erlang booleans to XForms. -bool_to_xopt(false) -> "false"; -bool_to_xopt(true) -> "true". +bool_to_xopt('false') -> "false"; +bool_to_xopt('true') -> "true". diff --git a/src/mod_pubsub/pubsub_subscription_odbc.erl b/src/mod_pubsub/pubsub_subscription_odbc.erl index f5591e032..b03b10cd2 100644 --- a/src/mod_pubsub/pubsub_subscription_odbc.erl +++ b/src/mod_pubsub/pubsub_subscription_odbc.erl @@ -37,7 +37,6 @@ -include_lib("stdlib/include/qlc.hrl"). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -define(PUBSUB_DELIVER, "pubsub#deliver"). -define(PUBSUB_DIGEST, "pubsub#digest"). @@ -89,33 +88,33 @@ init() -> ok = create_table(). -subscribe_node(_JID, _NodeID, Options) -> - SubID = make_subid(), - ?DB_MOD:add_subscription(#pubsub_subscription{subid = SubID, options = Options}), - {result, SubID}. +subscribe_node(_JID, _Nidx, Options) -> + SubId = make_subid(), + ?DB_MOD:add_subscription(#pubsub_subscription{subid = SubId, options = Options}), + {result, SubId}. -unsubscribe_node(_JID, _NodeID, SubID) -> - case ?DB_MOD:read_subscription(SubID) of +unsubscribe_node(_JID, _Nidx, SubId) -> + case ?DB_MOD:read_subscription(SubId) of {ok, Sub} -> - ?DB_MOD:delete_subscription(SubID), + ?DB_MOD:delete_subscription(SubId), {result, Sub}; notfound -> {error, notfound} end. -get_subscription(_JID, _NodeID, SubID) -> - case ?DB_MOD:read_subscription(SubID) of +get_subscription(_JID, _Nidx, SubId) -> + case ?DB_MOD:read_subscription(SubId) of {ok, Sub} -> {result, Sub}; notfound -> {error, notfound} end. -set_subscription(_JID, _NodeID, SubID, Options) -> - case ?DB_MOD:read_subscription(SubID) of +set_subscription(_JID, _Nidx, SubId, Options) -> + case ?DB_MOD:read_subscription(SubId) of {ok, _} -> - ?DB_MOD:update_subscription(#pubsub_subscription{subid = SubID, options = Options}), + ?DB_MOD:update_subscription(#pubsub_subscription{subid = SubId, options = Options}), {result, ok}; notfound -> - ?DB_MOD:add_subscription(#pubsub_subscription{subid = SubID, options = Options}), + ?DB_MOD:add_subscription(#pubsub_subscription{subid = SubId, options = Options}), {result, ok} end. diff --git a/src/mod_roster.erl b/src/mod_roster.erl index a0037151c..1a7756113 100644 --- a/src/mod_roster.erl +++ b/src/mod_roster.erl @@ -1183,15 +1183,15 @@ get_jid_info(_, User, Server, JID) LServer = exmpp_stringprep:nameprep(Server), try F = fun() -> - LJID = jlib:short_prepd_jid(JID), - case catch gen_storage:read(LServer, {rosteritem, {LUser, LServer, LJID}}) of + LJID = jlib:short_prepd_jid(JID), + LRJID = jlib:short_prepd_bare_jid(JID), + case catch gen_storage:read(LServer, {rosteritem, {LUser, LServer, LRJID}}) of [#rosteritem{subscription = Subscription}] -> Groups = [Group || #rostergroup{grp = Group} <- - gen_storage:read(LServer, {rostergroup, {LUser, LServer, LJID}})], + gen_storage:read(LServer, {rostergroup, {LUser, LServer, LRJID}})], {Subscription, Groups}; _ -> - LRJID = jlib:short_prepd_bare_jid(JID), if LRJID == LJID -> {none, []}; @@ -1202,7 +1202,7 @@ get_jid_info(_, User, Server, JID) [#rosteritem{subscription = Subscription}] -> Groups = [Group || #rostergroup{grp = Group} <- - gen_storage:read(LServer, {rostergroup, {LUser, LServer, LJID}})], + gen_storage:read(LServer, {rostergroup, {LUser, LServer, LRJID}})], {Subscription, Groups}; _ -> {none, []} @@ -1518,7 +1518,7 @@ user_roster_item_parse_query(User, Server, Items, Query) -> ns = ?NS_ROSTER, name = 'query', children = [Item]}, - process_iq( + process_iq_set( UJID, UJID, #iq{type = set, ns = ?NS_JABBER_CLIENT, payload = Request}), throw(submitted); diff --git a/src/mod_sic.erl b/src/mod_sic.erl index 3a3f14b02..c9756df73 100644 --- a/src/mod_sic.erl +++ b/src/mod_sic.erl @@ -62,8 +62,8 @@ process_local_iq(_From, _To, #iq{type = 'set'} = IQ) -> process_sm_iq( - #jid{prep_node = Node, prep_domain = Domain} = From, - #jid{prep_node = Node, prep_domain = Domain} = _To, + #jid{node = Node, domain = Domain} = From, + #jid{node = Node, domain = Domain} = _To, #iq{type = 'get'} = IQ) -> get_ip(From, IQ); diff --git a/src/mod_time.erl b/src/mod_time.erl index b7482bcda..4f2eb1ac3 100644 --- a/src/mod_time.erl +++ b/src/mod_time.erl @@ -59,7 +59,13 @@ process_local_iq(_From, _To, #iq{type = get} = IQ_Rec) -> {UTC, UTC_diff} = jlib:timestamp_to_iso(Now_universal, utc), Seconds_diff = calendar:datetime_to_gregorian_seconds(Now_local) - calendar:datetime_to_gregorian_seconds(Now_universal), - {Hd, Md, _} = calendar:seconds_to_time(Seconds_diff), + {Hd, Md, _} = case Seconds_diff >= 0 of + true -> + calendar:seconds_to_time(Seconds_diff); + false -> + {Hd0, Md0, Sd0} = calendar:seconds_to_time(-Seconds_diff), + {-Hd0, Md0, Sd0} + end, {_, TZO_diff} = jlib:timestamp_to_iso({{0, 0, 0}, {0, 0, 0}}, {Hd, Md}), Result = #xmlel{ns = ?NS_TIME, name = 'time', children = [ #xmlel{ns = ?NS_TIME, name = 'tzo', children = [ diff --git a/src/mod_vcard.erl b/src/mod_vcard.erl index e090ab112..79fe4d29a 100644 --- a/src/mod_vcard.erl +++ b/src/mod_vcard.erl @@ -218,8 +218,8 @@ process_local_iq(_From, _To, #iq{type = set} = IQ_Rec) -> process_sm_iq(_From, To, #iq{type = get} = IQ_Rec) -> - LUser = exmpp_jid:prep_node_as_list(To), - LServer = exmpp_jid:prep_domain_as_list(To), + LUser = exmpp_jid:prep_node(To), + LServer = exmpp_jid:prep_domain(To), case get_vcard(LUser, LServer) of {vcard, VCard} -> exmpp_iq:result(IQ_Rec, VCard); @@ -229,15 +229,16 @@ process_sm_iq(_From, To, #iq{type = get} = IQ_Rec) -> process_sm_iq(From, _To, #iq{type = set, payload = Request} = IQ_Rec) -> User = exmpp_jid:node_as_list(From), LServer = exmpp_jid:prep_domain_as_list(From), + LServerB = exmpp_jid:prep_domain(From), case ?IS_MY_HOST(LServer) of true -> - set_vcard(User, LServer, Request), + set_vcard(User, LServer, LServerB, Request), exmpp_iq:result(IQ_Rec); false -> exmpp_iq:error(IQ_Rec, 'not-allowed') end. -%% @spec (User::string(), Host::string()) -> {vcard, xmlel()} | novcard +%% @spec (User::binary(), Host::binary()) -> {vcard, xmlel()} | novcard get_vcard(User, Host) -> US = {User, Host}, case gen_storage:dirty_read(Host, {vcard, US}) of @@ -253,7 +254,7 @@ get_vcard(User, Host) -> end. -set_vcard(User, LServer, VCARD) -> +set_vcard(User, LServer, LServerB, VCARD) -> FN = exmpp_xml:get_path(VCARD, [{element, 'FN'}, cdata_as_list]), Family = exmpp_xml:get_path(VCARD, @@ -301,14 +302,14 @@ set_vcard(User, LServer, VCARD) -> US = {LUser, LServer}, - VcardToStore = case gen_storage:table_info(LServer, vcard, backend) of + VcardToStore = case gen_storage:table_info(LServerB, vcard, backend) of mnesia -> VCARD; odbc -> lists:flatten(exmpp_xml:document_to_list(VCARD)) end, F = fun() -> - gen_storage:write(LServer, #vcard{user_host = US, vcard = VcardToStore}), - gen_storage:write(LServer, + gen_storage:write(LServerB, #vcard{user_host = US, vcard = VcardToStore}), + gen_storage:write(LServerB, #vcard_search{user_host=US, username = User, lusername = LUser, fn = FN, lfn = LFN, @@ -324,8 +325,8 @@ set_vcard(User, LServer, VCARD) -> orgunit = OrgUnit, lorgunit = LOrgUnit }) end, - gen_storage:transaction(LServer, vcard, F), LServerB = list_to_binary(LServer), + gen_storage:transaction(LServerB, vcard, F), ejabberd_hooks:run(vcard_set, LServerB, [list_to_binary(LUser), LServerB, VCARD]) catch _ -> @@ -402,9 +403,8 @@ do_route(ServerHost, From, To, Packet) -> Result = #xmlel{ ns = ?NS_SEARCH, name = 'query', - children = [ - #xmlel{ - ns = ?NS_DATA_FORMS, + children = + [#xmlel{ns = ?NS_DATA_FORMS, name = 'x', attrs = [?XMLATTR('type', <<"result">>)], @@ -729,10 +729,10 @@ remove_user(User, Server) when is_binary(User), is_binary(Server) -> LServer = binary_to_list(exmpp_stringprep:nameprep(Server)), US = {LUser, LServer}, F = fun() -> - gen_storage:delete(LServer, {vcard, US}), - gen_storage:delete(LServer, {vcard_search, US}) + gen_storage:delete(Server, {vcard, US}), + gen_storage:delete(Server, {vcard_search, US}) end, - gen_storage:transaction(LServer, vcard, F). + gen_storage:transaction(Server, vcard, F). %%% @@ -892,6 +892,7 @@ get_user_photo(User, Host) -> user_queue_parse_query(US, Query) -> {User, Server} = US, + ?INFO_MSG("Query vcard: ~p", [Query]), %+++ case lists:keysearch("removevcard", 1, Query) of {value, _} -> case remove_user(list_to_binary(User), list_to_binary(Server)) of diff --git a/src/mod_vcard_ldap.erl b/src/mod_vcard_ldap.erl index 3487ad1fc..7368194a3 100644 --- a/src/mod_vcard_ldap.erl +++ b/src/mod_vcard_ldap.erl @@ -172,7 +172,7 @@ start_link(Host, Opts) -> init([Host, Opts]) -> HostB = list_to_binary(Host), State = parse_options(Host, Opts), - IQDisc = gen_mod:get_opt(iqdisc, Opts, parallel), + IQDisc = gen_mod:get_opt(iqdisc, Opts, one_queue), gen_iq_handler:add_iq_handler(ejabberd_local, HostB, ?NS_VCARD, ?MODULE, process_local_iq, IQDisc), gen_iq_handler:add_iq_handler(ejabberd_sm, HostB, ?NS_VCARD, @@ -439,9 +439,8 @@ route(State, From, To, Packet) -> Result = #xmlel{ ns = ?NS_SEARCH, name = 'query', - children = [ - #xmlel{ - ns = ?NS_DATA_FORMS, + children = + [#xmlel{ns = ?NS_DATA_FORMS, name = 'x', attrs = [?XMLATTR('type', <<"result">>)], diff --git a/src/mod_vcard_odbc.erl b/src/mod_vcard_odbc.erl index bb0ad5ca8..7682646dd 100644 --- a/src/mod_vcard_odbc.erl +++ b/src/mod_vcard_odbc.erl @@ -464,12 +464,6 @@ record_to_item(LServer, {Username, FN, Family, Given, Middle, search(LServer, Data) -> MatchSpec = make_matchspec(LServer, Data), - AllowReturnAll = gen_mod:get_module_opt(LServer, ?MODULE, - allow_return_all, false), - if - (MatchSpec == "") and (not AllowReturnAll) -> - []; - true -> Limit = case gen_mod:get_module_opt(LServer, ?MODULE, matches, ?JUD_MATCHES) of infinity -> @@ -491,7 +485,6 @@ search(LServer, Data) -> Error -> ?ERROR_MSG("~p", [Error]), [] - end end. @@ -500,12 +493,7 @@ make_matchspec(LServer, Data) -> filter_fields(Data, ["host = '", Host, "'"], LServer). filter_fields([], Match, _LServer) -> - case Match of - "" -> - ""; - _ -> - [" where ", Match] - end; + [" where ", Match]; filter_fields([{SVar, [Val]} | Ds], Match, LServer) when is_list(Val) and (Val /= "") -> LVal = exmpp_stringprep:to_lower(Val), @@ -539,12 +527,7 @@ make_val(Match, Field, Val) -> SVal = ejabberd_odbc:escape(Val), [Field, " = '", SVal, "'"] end, - case Match of - "" -> - Condition; - _ -> - [Match, " and ", Condition] - end. + [Match, " and ", Condition]. diff --git a/src/web/ejabberd_http_bind.erl b/src/web/ejabberd_http_bind.erl index a9bdbdd39..52e38d76d 100644 --- a/src/web/ejabberd_http_bind.erl +++ b/src/web/ejabberd_http_bind.erl @@ -59,7 +59,7 @@ rid = none, key, socket, - output = "", + output = [], input = queue:new(), waiting_input = false, shaper_state, @@ -1157,7 +1157,7 @@ send_outpacket(#http_bind{pid = FsmRef}, OutPacket) -> case SEls of [{xmlstreamelement, #xmlel{name = 'features', - declared_ns = [{undefined, 'stream'}], + declared_ns = [{undefined, "stream"}], attrs = StreamAttribs, children = StreamEls}} | % {xmlelement, diff --git a/src/web/ejabberd_http_poll.erl b/src/web/ejabberd_http_poll.erl index f18774b2e..1033cbc3b 100644 --- a/src/web/ejabberd_http_poll.erl +++ b/src/web/ejabberd_http_poll.erl @@ -73,9 +73,7 @@ -define(CT, {"Content-Type", "text/xml; charset=utf-8"}). -define(BAD_REQUEST, [?CT, {"Set-Cookie", "ID=-3:0; expires=-1"}]). --define(PARSER_OPTIONS, [ - {names_as_atom, true} -]). +-define(PARSER_OPTIONS, [{names_as_atom, true}]). %%%---------------------------------------------------------------------- %%% API diff --git a/src/web/ejabberd_web_admin.erl b/src/web/ejabberd_web_admin.erl index 60c19e58d..cfbdbe746 100644 --- a/src/web/ejabberd_web_admin.erl +++ b/src/web/ejabberd_web_admin.erl @@ -1001,8 +1001,8 @@ process_admin(Host, {value, {_, String}} -> case parse_access_rule(String) of {ok, Rs} -> - ejabberd_config:add_global_option( - {access, Name, Host}, Rs), + ejabberd_config:add_global_option + ({access, Name, Host}, Rs), ok; _ -> error @@ -1732,10 +1732,17 @@ user_info(User, Server, Query, Lang) -> FIP = case ejabberd_sm:get_user_info( UserB, ServerB, R) of offline -> + NodePidS = "", ""; Info when is_list(Info) -> Node = proplists:get_value(node, Info), + NodeS = atom_to_list(Node), Conn = proplists:get_value(conn, Info), + Priority = proplists:get_value(priority, Info), + Creation = proplists:get_value(creation, Info), + Pid = proplists:get_value(pid, Info), + PidS = pid_to_list(Pid), + NodePidS = NodeS ++ "/pid/" ++ PidS, {IP, Port} = proplists:get_value(ip, Info), ConnS = case Conn of c2s -> "plain"; @@ -1746,14 +1753,16 @@ user_info(User, Server, Query, Lang) -> http_poll -> "http-poll" end, " (" ++ + " #" ++ integer_to_list(Priority) ++ " " ++ ConnS ++ "://" ++ inet_parse:ntoa(IP) ++ ":" ++ - integer_to_list(Port) - ++ "#" ++ atom_to_list(Node) - ++ ")" + integer_to_list(Port) ++ + "#" ++ NodeS ++ + " " ++ Creation ++ + ") " end, - ?LI([?C(binary_to_list(R) ++ FIP)]) + ?LI([?C(binary_to_list(R) ++ FIP), ?AC("/admin/node/" ++ NodePidS ++ "/", "View Process")]) end, lists:sort(Resources)))] end, Password = ejabberd_auth:get_password_s(User, Server), @@ -2149,6 +2158,7 @@ get_node(global, Node, [], Query, Lang) -> [?XE('ul', [?LI([?ACT(Base ++ "db/", "Database")]), ?LI([?ACT(Base ++ "backup/", "Backup")]), + ?LI([?ACT(Base ++ "pid/", "Erlang Processes")]), ?LI([?ACT(Base ++ "ports/", "Listened Ports")]), ?LI([?ACT(Base ++ "stats/", "Statistics")]), ?LI([?ACT(Base ++ "update/", "Update")]) @@ -2326,6 +2336,71 @@ get_node(global, Node, ["backup"], Query, Lang) -> ]) ])])]; +get_node(global, Node, ["pid"], _Query, Lang) -> + NodeS = atom_to_list(Node), + Processes = rpc:call(Node, erlang, processes, []), + ProcessesNumber = length(Processes), + ProcessesList = lists:map( + fun(P) -> + PS = pid_to_list(P), + NodePidS = NodeS ++ "/pid/" ++ PS, + ?AC("/admin/node/" ++ NodePidS ++ "/", PS) + end, + Processes), + [?XC('h1', io_lib:format(?T("Erlang Processes at node ~p"), [Node])), + ?XAE('table', [], + [?XE('tbody', + [?XE('tr', [?XCT('td', "Number of processes:"), + ?XAC('td', [?XMLATTR('class', <<"alignright">>)], + pretty_string_int(ProcessesNumber))]) + ]) + ]), + ?XAE('p', [], + [?CT("Processes: ")] ++ ProcessesList + )]; + +get_node(global, Node, ["pid", PidS], _Query, Lang) -> + NodeS = atom_to_list(Node), + ProcessInfo = rpc:call(Node, erlang, process_info, [list_to_pid(PidS)]), + ProcessInfoS = io_lib:format("~p", [ProcessInfo]), + ProcLinkList = case re:run(ProcessInfoS, "<[0-9]+\\.[0-9]+\\.[0-9]+>", + [global, {capture, all, list}]) of + {match, PidsRareList} -> + lists:map( + fun([PS]) -> + NodePidS = NodeS ++ "/pid/" ++ PS, + ?AC("/admin/node/" ++ NodePidS ++ "/", PS) + end, + PidsRareList); + _ -> + [] + end, + PortLinkList = + case proplists:get_value(links, ProcessInfo) of + Links when is_list(Links) -> + lists:foldl( + fun(Link, LinkRes) when is_port(Link) -> + PortInfo = rpc:call(Node, erlang, port_info, [Link]), + PortInfoString = io_lib:format("~p", [PortInfo]), + LinkRes ++ [{erlang:port_to_list(Link), PortInfoString}]; + (_Link, LinkRes) -> LinkRes + end, + [], + Links); + _ -> + [] + end, + [?XC('h1', io_lib:format(?T("Erlang Process ~s at node ~p"), [PidS, Node])), + ?XC('h3', ?T("Process Information:")), + ?XAE('pre', [], [?C(ProcessInfoS)]), + ?XC('h3', ?T("Related Processes:")), + ?XAE('p', [], ProcLinkList), + ?XC('h3', ?T("Linked Ports:")), + ?XE('ul', + [ ?XE('li', [ ?C(PortName), ?BR, ?C(PortDescr) ]) + || {PortName, PortDescr} <- PortLinkList]) + ]; + get_node(global, Node, ["ports"], Query, Lang) -> Ports = rpc:call(Node, ejabberd_config, get_local_option, [listen]), Res = case catch node_ports_parse_query(Node, Ports, Query) of @@ -2964,6 +3039,7 @@ make_node_menu(global, Node, Lang) -> NodeBase = get_base_path(global, Node), NodeFixed = [{"db/", "Database"}, {"backup/", "Backup"}, + {"pid/", "Erlang Processes"}, {"ports/", "Listened Ports"}, {"stats/", "Statistics"}, {"update/", "Update"}] diff --git a/examples/extauth/check_pass_null.pl b/tools/check_pass_null.pl index f15fe910b..f15fe910b 100755 --- a/examples/extauth/check_pass_null.pl +++ b/tools/check_pass_null.pl diff --git a/contrib/extract_translations/README b/tools/extract_translations/README index 9278dd106..9278dd106 100644 --- a/contrib/extract_translations/README +++ b/tools/extract_translations/README diff --git a/contrib/extract_translations/extract_translations.erl b/tools/extract_translations/extract_translations.erl index f2fc113d6..f2fc113d6 100644 --- a/contrib/extract_translations/extract_translations.erl +++ b/tools/extract_translations/extract_translations.erl diff --git a/contrib/extract_translations/prepare-translation.sh b/tools/extract_translations/prepare-translation.sh index 7a40fee78..847c4f5d2 100755 --- a/contrib/extract_translations/prepare-translation.sh +++ b/tools/extract_translations/prepare-translation.sh @@ -16,7 +16,7 @@ prepare_dirs () EJA_SRC_DIR=$EJA_DIR/src/ EJA_MSGS_DIR=$EJA_SRC_DIR/msgs/ - EXTRACT_DIR=$EJA_DIR/contrib/extract_translations/ + EXTRACT_DIR=$EJA_DIR/tools/extract_translations/ EXTRACT_ERL=$EXTRACT_DIR/extract_translations.erl EXTRACT_BEAM=$EXTRACT_DIR/extract_translations.beam |