ejabberd is a free and open source instant messaging server written in Erlang/OTP.
ejabberd is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.
ejabberd is designed to be a rock-solid and feature rich XMPP server.
ejabberd is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.
@@ -1895,6 +1896,7 @@ all entries end with a comma:The user’s client can store an avatar in the user vCard. +The vCard-Based Avatars protocol (XEP-0153) +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.
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 XEP-0153 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.
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.
+This module implements Software Version (XEP-0092). Consequently, it answers ejabberd’s version when queried.
Options:
With the ejabberdctl command line administration script +
With the ejabberdctl command line administration script you can execute ejabberdctl commands (described in the next section, 4.1.1) and also many general ejabberd commands (described in section 4.2). This means you can start, stop and perform many other administrative tasks @@ -3429,7 +3445,7 @@ 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: echo $?
-When ejabberdctl is executed without any parameter, +
When ejabberdctl is executed without any parameter, it displays the available options. If there isn’t an ejabberd server running, the available parameters are:
ejabberd is an Erlang/OTP application that runs inside an Erlang runtime system. +
ejabberd is an Erlang/OTP application that runs inside an Erlang runtime system. This system is configured using environment variables and command line parameters. The ejabberdctl administration script uses many of those possibilities. You can configure some of them with the file ejabberdctl.cfg, @@ -3542,7 +3558,7 @@ not “Simple Authentication and Security Layer”.
Note that some characters need to be escaped when used in shell scripts, for instance " and {}.
You can find other options in the Erlang manual page (erl -man erl).
An ejabberd command is an abstract function identified by a name, +
An ejabberd command 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 ejabberd_commands service. Those commands can be defined in any Erlang module and executed using any valid frontend.
ejabberd includes a frontend to execute ejabberd commands: the script ejabberdctl. @@ -3550,7 +3566,7 @@ Other known frontends that can be installed to execute ejabberd commands in diff ejabberd_xmlrpc (XML-RPC service), mod_rest (HTTP POST service), mod_shcommands (ejabberd WebAdmin page).
-ejabberd includes a few ejabberd Commands by default. +
ejabberd includes a few ejabberd Commands by default. When more modules are installed, new commands may be available in the frontends.
The easiest way to get a list of the available commands, and get help for them is to use the ejabberdctl script:
$ ejabberdctl help @@ -3602,7 +3618,7 @@ is very high.
The frontends can be configured to restrict access to certain commands. +
The frontends can be configured to restrict access to certain commands. In that case, authentication information must be provided. In each frontend the AccessCommands option is defined in a different place. But in all cases the option syntax is the same: @@ -3647,7 +3663,7 @@ and the provided arguments do not contradict Arguments.
As an example to u {_bot_reg_test, [register, unregister], [{host, "test.org"}]} ]
-The ejabberd Web Admin allows to administer most of ejabberd using a web browser.
This feature is enabled by default: a ejabberd_http listener with the option web_admin (see section 3.1.3) is included in the listening ports. Then you can open @@ -3719,13 +3735,13 @@ The file is searched by default in The directory of the documentation can be specified in the environment variable EJABBERD_DOC_PATH. See section 4.1.2.
-If you enable mod_configure and mod_adhoc, +
If you enable mod_configure and mod_adhoc, you can perform several administrative tasks in ejabberd with a XMPP client. The client must support Ad-Hoc Commands (XEP-0050), and you must login in the XMPP server with an account with proper privileges.
-ejabberd uses the distributed Mnesia database. +
ejabberd 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 5.4). The name of an Erlang node includes the hostname of the computer. @@ -3771,8 +3787,8 @@ mv /var/lib/ejabberd/*.* /var/lib/ejabberd/oldfiles/
You need to take the following TCP ports in mind when configuring your firewall:
-
@@ -3783,7 +3799,7 @@ After you finish, remember to delete the temporary backup files from public dire Port Description port range Used for connections between Erlang nodes. This range is configurable (see section 5.2).
epmd (Erlang Port Mapper Daemon) +
epmd (Erlang Port Mapper Daemon) is a small name server included in Erlang/OTP and used by Erlang programs when establishing distributed Erlang communications. ejabberd needs epmd to use ejabberdctl and also when clustering ejabberd nodes. @@ -3808,7 +3824,7 @@ but can be configured in the file ejabberdctl.cfg. The Erlang command-line parameter used internally is, for example:
erl ... -kernel inet_dist_listen_min 4370 inet_dist_listen_max 4375-
The Erlang cookie is a string with numbers and letters. +
The Erlang cookie is a string with numbers and letters. An Erlang node reads the cookie at startup from the command-line parameter -setcookie. If not indicated, the cookie is read from the cookie file $HOME/.erlang.cookie. If this file does not exist, it is created immediately with a random cookie. @@ -3822,7 +3838,7 @@ 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.
-An Erlang node may have a node name. +
An Erlang node may have a node name. The name can be short (if indicated with the command-line parameter -sname) or long (if indicated with the parameter -name). Starting an Erlang node with -sname limits the communication between Erlang nodes to the LAN.
Using the option -sname instead of -name is a simple method @@ -3831,7 +3847,7 @@ 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 epmd. The recommended way to secure the Erlang node is to block the port 4369.
-ejabberd stores sensitive data in the file system either in plain text or binary files. +
ejabberd 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.
A XMPP domain is served by one or more ejabberd 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 @@ -3867,29 +3883,29 @@ router,
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.
-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.
-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.
-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.
-Suppose you already configured ejabberd on one machine named (first), and you need to setup another one to make an ejabberd cluster. Then do following steps:
access’ options because they will be taken from
enabled only on one machine in the cluster.
You can repeat these steps for other machines supposed to serve this domain.
-ejabberd includes an algorithm to load balance the components that are plugged on an ejabberd cluster. It means that you can plug one or several instances of the same component on each ejabberd cluster and that the traffic will be automatically distributed.
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.
If you need a different behaviour, you can change the load balancing behaviour with the option domain_balancing. The syntax of the option is the following:
Several balancing criteria are available:
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.
In this case, it is best to limit the problem to the sessions handled by the failing component. This is what the domain_balancing_component_number option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances.
The syntax is:
An ejabberd node writes two log files: +
An ejabberd node writes two log files:
The Debug Console is an Erlang shell attached to an already running ejabberd server. +
The Debug Console is an Erlang shell attached to an already running ejabberd server. With this Erlang shell, an experienced administrator can perform complex tasks.
This shell gives complete control over the ejabberd server, so it is important to use it with extremely care. There are some simple and safe examples in the article Interconnecting Erlang Nodes
To exit the shell, close the window or press the keys: control+c control+c.
-ejabberd includes a watchdog mechanism that may be useful to developers when troubleshooting a problem related to memory usage. If a process in the ejabberd server consumes more memory than the configured threshold, @@ -3991,7 +4007,7 @@ or in a conversation with the watchdog alert bot.
The syntax is: To remove all watchdog admins, set the option with an empty list:
{watchdog_admins, []}.
-The source code of ejabberd supports localization. The translators can edit the gettext .po files @@ -4026,9 +4042,9 @@ HTTP header ‘Accept-Language: ru’
Release notes are available from ejabberd Home Page
-Thanks to all people who contributed to this guide: +
Thanks to all people who contributed to this guide:
Ejabberd Installation and Operation Guide.
+
Ejabberd Installation and Operation Guide.
Copyright © 2003 — 2010 ProcessOne
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
diff --git a/doc/guide.tex b/doc/guide.tex
index 37a6c8bc6..455f6e912 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -98,6 +98,7 @@
\newcommand{\modvcard}{\module{mod\_vcard}}
\newcommand{\modvcardldap}{\module{mod\_vcard\_ldap}}
\newcommand{\modvcardodbc}{\module{mod\_vcard\_odbc}}
+\newcommand{\modvcardxupdate}{\module{mod\_vcard\_xupdate}}
\newcommand{\modversion}{\module{mod\_version}}
%% Contributed modules
@@ -2490,6 +2491,7 @@ The following table lists all modules included in \ejabberd{}.
\hline \ahrefloc{modvcard}{\modvcard{}} & vcard-temp (\xepref{0054}) & \\
\hline \ahrefloc{modvcardldap}{\modvcardldap{}} & vcard-temp (\xepref{0054}) & LDAP server \\
\hline \ahrefloc{modvcard}{\modvcardodbc{}} & vcard-temp (\xepref{0054}) & supported DB (*) \\
+ \hline \ahrefloc{modvcardxupdate}{\modvcardxupdate{}} & vCard-Based Avatars (\xepref{0153}) & \modvcard{} or \modvcardodbc{} \\
\hline \ahrefloc{modversion}{\modversion{}} & Software Version (\xepref{0092}) & \\
\hline
\end{tabular}
@@ -4321,6 +4323,27 @@ searching his info in LDAP.
\end{verbatim}
\end{itemize}
+\makesubsection{modvcardxupdate}{\modvcardxupdate{}}
+\ind{modules!\modvcardxupdate{}}\ind{protocols!XEP-0153: vCard-Based Avatars}
+
+The user's client can store an avatar in the user vCard.
+The vCard-Based Avatars protocol (\xepref{0153})
+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.
+
+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 \xepref{0153} 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.
+
+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.
+
\makesubsection{modversion}{\modversion{}}
\ind{modules!\modversion{}}\ind{protocols!XEP-0092: Software Version}
diff --git a/src/ejabberd_c2s.erl b/src/ejabberd_c2s.erl
index 04a3fbcb1..b09d41433 100644
--- a/src/ejabberd_c2s.erl
+++ b/src/ejabberd_c2s.erl
@@ -1332,6 +1332,25 @@ handle_info(system_shutdown, StateName, StateData) ->
ok
end,
{stop, normal, StateData};
+handle_info({force_update_presence, LUser}, StateName,
+ #state{user = LUser, server = LServer} = StateData) ->
+ NewStateData =
+ case StateData#state.pres_last of
+ {xmlelement, "presence", _Attrs, _Els} ->
+ PresenceEl = ejabberd_hooks:run_fold(
+ c2s_update_presence,
+ LServer,
+ StateData#state.pres_last,
+ [LUser, LServer]),
+ StateData2 = StateData#state{pres_last = PresenceEl},
+ presence_update(StateData2#state.jid,
+ PresenceEl,
+ StateData2),
+ StateData2;
+ _ ->
+ StateData
+ end,
+ {next_state, StateName, NewStateData};
handle_info(Info, StateName, StateData) ->
?ERROR_MSG("Unexpected info: ~p", [Info]),
fsm_next_state(StateName, StateData).
diff --git a/src/ejabberd_sm.erl b/src/ejabberd_sm.erl
index 296400f84..782732603 100644
--- a/src/ejabberd_sm.erl
+++ b/src/ejabberd_sm.erl
@@ -47,6 +47,7 @@
register_iq_handler/4,
register_iq_handler/5,
unregister_iq_handler/2,
+ force_update_presence/1,
connected_users/0,
connected_users_number/0,
user_resources/2,
@@ -711,6 +712,16 @@ process_iq(From, To, Packet) ->
ok
end.
+force_update_presence({LUser, _LServer} = US) ->
+ case catch mnesia:dirty_index_read(session, US, #session.us) of
+ {'EXIT', _Reason} ->
+ ok;
+ Ss ->
+ lists:foreach(fun(#session{sid = {_, Pid}}) ->
+ Pid ! {force_update_presence, LUser}
+ end, Ss)
+ end.
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% ejabberd commands
diff --git a/src/jlib.hrl b/src/jlib.hrl
index 8047c1a82..47c65f68a 100644
--- a/src/jlib.hrl
+++ b/src/jlib.hrl
@@ -22,6 +22,7 @@
-define(NS_DISCO_ITEMS, "http://jabber.org/protocol/disco#items").
-define(NS_DISCO_INFO, "http://jabber.org/protocol/disco#info").
-define(NS_VCARD, "vcard-temp").
+-define(NS_VCARD_UPDATE, "vcard-temp:x:update").
-define(NS_AUTH, "jabber:iq:auth").
-define(NS_AUTH_ERROR, "jabber:iq:auth:error").
-define(NS_REGISTER, "jabber:iq:register").
diff --git a/src/mod_vcard.erl b/src/mod_vcard.erl
index 4384087f4..3cdd3cffa 100644
--- a/src/mod_vcard.erl
+++ b/src/mod_vcard.erl
@@ -267,7 +267,8 @@ set_vcard(User, LServer, VCARD) ->
orgunit = OrgUnit, lorgunit = LOrgUnit
})
end,
- mnesia:transaction(F)
+ mnesia:transaction(F),
+ ejabberd_hooks:run(vcard_set, LServer, [LUser, LServer, VCARD])
end.
-define(TLFIELD(Type, Label, Var),
diff --git a/src/mod_vcard_odbc.erl b/src/mod_vcard_odbc.erl
index 30c28883a..aa35bd4be 100644
--- a/src/mod_vcard_odbc.erl
+++ b/src/mod_vcard_odbc.erl
@@ -247,7 +247,9 @@ set_vcard(User, LServer, VCARD) ->
SLLocality, SLMiddle, SLNickname,
SLOrgName, SLOrgUnit, SLocality,
SMiddle, SNickname, SOrgName,
- SOrgUnit, SVCARD, Username)
+ SOrgUnit, SVCARD, Username),
+
+ ejabberd_hooks:run(vcard_set, LServer, [LUser, LServer, VCARD])
end.
-define(TLFIELD(Type, Label, Var),
diff --git a/src/mod_vcard_xupdate.erl b/src/mod_vcard_xupdate.erl
new file mode 100644
index 000000000..38503c4c3
--- /dev/null
+++ b/src/mod_vcard_xupdate.erl
@@ -0,0 +1,121 @@
+%%%----------------------------------------------------------------------
+%%% File : mod_vcard_xupdate.erl
+%%% Author : Igor Goryachev