From 332fb55e3abcce272d7ba2b0c32e363b57a0979b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jean-S=C3=A9bastien=20P=C3=A9dron?= Date: Fri, 11 Jul 2008 12:48:27 +0000 Subject: [PATCH] MFC: Merge revisions from 1362 to revision 1434 from trunk. SVN Revision: 1435 --- ChangeLog | 138 ++++++++++- doc/guide.html | 360 ++++++++++++++++------------- doc/guide.tex | 74 +++++- src/Makefile.in | 6 +- src/configure | 3 + src/configure.ac | 3 + src/ejabberd.cfg.example | 2 +- src/ejabberd_c2s.erl | 3 + src/ejabberd_config.erl | 6 +- src/ejabberd_ctl.erl | 1 + src/ejabberd_local.erl | 7 + src/ejabberd_receiver.erl | 6 +- src/ejabberd_sm.erl | 15 +- src/mod_caps.erl | 12 + src/mod_configure.erl | 2 +- src/mod_muc/mod_muc_log.erl | 19 +- src/mod_muc/mod_muc_room.erl | 13 +- src/mod_privacy_odbc.erl | 25 +- src/mod_pubsub/gen_pubsub_node.erl | 2 + src/mod_pubsub/mod_pubsub.erl | 109 ++++++--- src/mod_pubsub/node.template | 9 +- src/mod_pubsub/node_buddy.erl | 8 + src/mod_pubsub/node_club.erl | 9 +- src/mod_pubsub/node_default.erl | 116 ++++++++-- src/mod_pubsub/node_dispatch.erl | 9 +- src/mod_pubsub/node_pep.erl | 35 ++- src/mod_pubsub/node_private.erl | 9 +- src/mod_pubsub/node_public.erl | 9 +- src/mod_pubsub/node_zoo.erl | 181 +++++++++++++++ src/mod_register.erl | 3 +- src/mod_roster.erl | 1 + src/mod_shared_roster.erl | 88 ++++++- src/web/ejabberd_http.erl | 27 ++- src/web/ejabberd_http_poll.erl | 38 ++- src/web/ejabberd_web_admin.erl | 2 +- tools/ejabberdctl | 3 +- 36 files changed, 1055 insertions(+), 298 deletions(-) create mode 100644 src/mod_pubsub/node_zoo.erl diff --git a/ChangeLog b/ChangeLog index cd04540e4..72fe05cb9 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2008-07-11 Jean-Sébastien Pédron + + Merge revisions from 1362 to revision 1434 from trunk. + 2008-07-11 Jean-Sébastien Pédron * src/ejabberd_s2s_in.erl, src/ejabberd_s2s_out.erl, @@ -7,6 +11,11 @@ * src/ejabberd_service.erl: Convert to exmpp. Note that this module hasn't been tested yet! +2008-07-10 Badlop + + * src/configure.ac: Don't check for erlang header file (EJAB-232) + * src/configure: Likewise + 2008-07-09 Jean-Sébastien Pédron * src/ejabberd_c2s.erl: Convert #xmlelement returned by the @@ -16,12 +25,99 @@ src/ejabberd_auth_odbc.erl, src/ejabberd_auth_ldap.erl, src/ejabberd_auth_anonymous.erl: Convert to exmpp. +2008-07-09 Badlop + + * src/configure.ac: Check for erlang header files (EJAB-232) + * src/configure: Likewise + + * src/mod_pubsub/mod_pubsub.erl: Fix compilation warnings + * src/mod_pubsub/node_zoo.erl: Likewise + + * src/mod_shared_roster.erl: Allow to get subscribed to a contact + that is already in the roster by means of a shared roster group: + add it to another roster group and it gets subscribed + automatically (EJAB-407) + + * src/mod_roster.erl: Likewise + + * src/mod_muc/mod_muc_log.erl: Fix XHTML compliance: ensure some + language is set, include ID attribute in each message, add + microseconds to ensure unique value (EJAB-497) + + * src/mod_register.erl: Support for io_lib newline character in + the body of welcome_message (EJAB-501) + * doc/guide.tex: Document the newline character + * src/ejabberd.cfg.example: Example usage of newline character + + * src/ejabberd_config.erl (load_file): error message on sasl.log + is not flattened (EJAB-616) + + * doc/guide.tex: mod_muc_log XMPP URI supports the updated version + RFC 5122 (EJAB-631) + * doc/guide.html: Likewise + 2008-07-08 Jean-Sébastien Pédron * src/cyrsasl.erl, src/cyrsasl_anonymous.erl, src/cyrsasl_digest.erl, src/cyrsasl_plain.erl, src/ejabberd_c2s.erl: Errors are now atoms, not strings anymore. +2008-07-08 Badlop + + * tools/ejabberdctl: Work also when 'which' is unavailable + +2008-07-08 Christophe Romain + + * src/web/ejabberd_http_poll.erl: improve ip fetching patch + +2008-07-07 Badlop + + * src/Makefile.in: Spool, config and log dirs: writtable by owner, + readable by group, nothing by others (EJAB-686) + * doc/guide.tex: New section Securing sensible files + * doc/guide.html: Likewise + + * doc/guide.tex: Solaris Makefile install: use ginstall (thanks to + Jonathan Auer)(EJAB-649) + * doc/guide.html: Likewise + +2008-07-03 Jerome Sautret + + * src/mod_privacy_odbc.erl: Support for privacy lists in MySQL + (thanks to Igor Goryachev)(EJAB-538) + +2008-07-03 Christophe Romain + + * src/mod_pubsub/mod_pubsub.erl: Fix permission control on item + retrieve (EJAB-453) + * src/mod_pubsub/node_dispatch.erl: Likewise + * src/mod_pubsub/node_buddy.erl: Likewise + * src/mod_pubsub/node_private.erl: Likewise + * src/mod_pubsub/node_public.erl: Likewise + * src/mod_pubsub/node_default.erl: Likewise + * src/mod_pubsub/node_pep.erl: Likewise + * src/mod_pubsub/node_club.erl: Likewise + * src/mod_pubsub/gen_pubsub_node.erl: Likewise + * src/mod_pubsub/node.template: Likewise + + * src/mod_pubsub/mod_pubsub.erl: Allow subscriber to request specific + items by ItemID; Allow to retrieve pubsub#title configuration (thanks + to Kevin Crosbie); Fix forbidden result on setting + affiliation/subscription + + * src/mod_pubsub/node_zoo.erl: Add node type without + home// constraint + + * src/ejabberd_local.erl: prevent iq_response table overload + (EJAB-608) + * src/mod_caps.erl: Likewise + + * src/web/ejabberd_http.erl: Retrieve correct IP from http connection + * src/web/ejabberd_http_poll.erl: Likewise + * src/ejabberd_receiver.erl: Likewise + * src/ejabberd_sm.erl: Likewise + * src/ejabberd_c2s.erl: Likewise + 2008-07-01 Jean-Sébastien Pédron * src/ejabberd_sm.erl: Convert to exmpp. @@ -100,6 +196,19 @@ src/ejabberd_s2s_out.erl: No conversion is done before calling ejabberd_router:route/3. +2008-06-29 Badlop + + * src/ejabberd_ctl.erl: Web Admin and Ad-hoc admin: dump only + persistent tables (EJAB-678) + + * src/mod_pubsub/node_pep.erl: Complain if mod_caps disabled and + mod_pubsub has PEP plugin enabled (EJAB-677) + +2008-06-28 Badlop + + * src/mod_muc/mod_muc_room.erl: Allow to store room + description (thanks to Christopher Dupont)(EJAB-670) + 2008-06-27 Jean-Sébastien Pédron * src/ejabberd_c2s.erl, src/ejabberd_s2s_out.erl, @@ -150,6 +259,15 @@ expected form outside of the C2S (empty fields must be set to the empty string). This fixes the broken routing. +2008-06-21 Badlop + + * src/web/ejabberd_http.erl: Support PUT and DELETE methods in + ejabberd_http (thanks to Eric Cestari)(EJAB-662) + + * doc/guide.tex: Explain that S2S outgoing first tries IPv4 and if + that fails then tries IPv6 + * doc/guide.html: Likewise + 2008-06-20 Jean-Sébastien Pédron * src/configure, src/aclocal.m4, src/Makefile.in: Add exmpp detection. @@ -271,7 +389,7 @@ 2008-05-19 Mickael Remond * src/ejabberd_s2s_out.erl: Avoid an harmless error (function clause in - logs) + logs) 2008-05-17 Badlop @@ -344,11 +462,11 @@ being immediately shown in an 'all' special shared roster group (thanks to Alexey Shchepin) (EJAB-71) * src/mod_register.erl: New vhost event user_registered - + * doc/guide.tex: Document option registration_timeout (EJAB-614) 2008-04-25 Badlop - + * src/ejabberd_c2s.erl: Added forbidden_session_hook * src/acl.erl: New access types: resource, resource_regexp and @@ -506,7 +624,7 @@ * doc/webadmmainru.png: Likewise * doc/disco.png: Removed because not used - + * doc/guide.tex: Fix Latex reference to webadmin section. Update explanation of screenshots. Update xmpp addresses of Mickael Remond and Sander Devrieze. @@ -619,7 +737,7 @@ * src/eldap.erl: Faster LDAP reconnection (Thanks to Christophe Romain) (EJAB-581) - + 2008-03-17 Mickael Remond * src/ejabberd_s2s.erl: Only trigger s2s_connect_hook on @@ -630,7 +748,7 @@ * src/ejabberd_ctl.erl: API improvement: Added reopen_log_hook (EJAB-565) - + * src/ejabberd_s2s.erl: API improvement: Added s2s_connect_hook (EJAB-566). @@ -722,7 +840,7 @@ configuration sanity checks (EJAB-533) * src/src/ejabberd_app.erl: Likewise * src/ejabberd_app.erl: Likewise - + 2008-02-26 Badlop * src/msgs/it.msg: Updated (thanks to Smart2128) @@ -858,7 +976,7 @@ * src/mod_pubsub/node_pep.erl: Likewise * src/mod_pubsub/node_private.erl: Likewise * src/mod_pubsub/node.template: Likewise - + * src/mod_pubsub/gen_pubsub_node.erl: API improvement: Added a way to generate custom item name * src/mod_pubsub/node_dispatch.erl: Likewise @@ -895,7 +1013,7 @@ * src/mod_pubsub/gen_pubsub_nodetree.erl: Likewise * src/mod_pubsub/nodetree_default.erl: Likewise * src/mod_pubsub/nodetree_virtual.erl: Likewise - + 2008-01-30 Badlop * doc/guide.tex: Removed the option served_hosts in mod_pubsub @@ -960,7 +1078,7 @@ * src/ejabberd.hrl: Likewise * doc/introduction.tex: Updated to 22 languages - + * doc/Makefile: Ensure that Bash is used * doc/guide.tex: Updated copyright dates to 2008. diff --git a/doc/guide.html b/doc/guide.html index b94c65959..b7f10839b 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -106,105 +106,107 @@ BLOCKQUOTE.figure DIV.center DIV.center HR{display:none;}
  • 2.4.4  Install
  • 2.4.5  Start
  • 2.4.6  Specific Notes for BSD -
  • 2.4.7  Specific Notes for Microsoft Windows +
  • 2.4.7  Specific Notes for Sun Solaris +
  • 2.4.8  Specific Notes for Microsoft Windows
  • -
  • 2.5  Create a Jabber Account for Administration -
  • 2.6  Upgrading ejabberd +
  • 2.5  Create a Jabber Account for Administration +
  • 2.6  Upgrading ejabberd
  • -
  • Chapter 3  Configuring ejabberd +
  • Chapter 3  Configuring ejabberd -
  • Chapter 4  Managing an ejabberd server +
  • Chapter 4  Managing an ejabberd server -
  • Chapter 5  Securing ejabberd +
  • Chapter 5  Securing ejabberd -
  • Chapter 6  Clustering +
  • Chapter 6  Clustering -
  • Chapter 7  Debugging +
  • Chapter 7  Debugging -
  • Appendix A  Internationalization and Localization -
  • Appendix B  Release Notes -
  • Appendix C  Acknowledgements -
  • Appendix D  Copyright Information +
  • Appendix A  Internationalization and Localization +
  • Appendix B  Release Notes +
  • Appendix C  Acknowledgements +
  • Appendix D  Copyright Information
  • Chapter 1  Introduction

    ejabberd is a free and open source instant messaging server written in Erlang.

    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.

    @@ -360,7 +362,7 @@ To get the full list run the command:
    /sbin/ejabberdctl
    Administration script
    /var/lib/ejabberd/
    - .erlang.cookie
    Erlang cookie file + .erlang.cookie
    Erlang cookie file (see section 5.3)
    db
    Mnesia database spool files
    ebin
    Binary Erlang files (*.beam)
    priv
    @@ -389,8 +391,23 @@ and configurable options to fine tune the Erlang runtime system.

    2.4.6  Specific Notes for BSD

    The command to compile ejabberd in BSD systems is:

    gmake
    +

    +

    2.4.7  Specific Notes for Sun Solaris

    +

    You need to have GNU install, +but it isn’t included in Solaris. +It can be easily installed if your Solaris system +is set up for blastwave.org +package repository. +Make sure /opt/csw/bin is in your PATH and run: +

    pkg-get -i fileutils
    +

    If that program is called ginstall, +modify the ejabberd Makefile script to suit your system, +for example: +

    cat Makefile | sed s/install/ginstall/ > Makefile.gi
    +

    And finally install ejabberd with: +

    gmake -f Makefile.gi ginstall
     

    -

    2.4.7  Specific Notes for Microsoft Windows

    +

    2.4.8  Specific Notes for Microsoft Windows

    Requirements

    To compile ejabberd on a Microsoft Windows system, you need:

    • @@ -428,7 +445,7 @@ nmake -f Makefile.win32
    • Edit the file ejabberd\src\ejabberd.cfg and run
      werl -s ejabberd -name ejabberd
       
    • -

      2.5  Create a Jabber Account for Administration

      You need a Jabber account and grant him administrative privileges +

      2.5  Create a Jabber Account for Administration

      You need a Jabber account and grant him administrative privileges to enter the ejabberd Web Admin:

      1. Register a Jabber account on your ejabberd server, for example admin1@example.org. @@ -449,16 +466,16 @@ favourite browser. Make sure to enter the full JID as username (in this example: admin1@example.org. The reason that you also need to enter the suffix, is because ejabberd’s virtual hosting support.

      -

      2.6  Upgrading ejabberd

      To upgrade an ejabberd installation to a new version, +

      2.6  Upgrading ejabberd

      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.

      ejabberd 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.

      -

      Chapter 3  Configuring ejabberd

      +

      Chapter 3  Configuring ejabberd

      -

      3.1  Basic Configuration

      The configuration file will be loaded the first time you start ejabberd. The +

      3.1  Basic Configuration

      The configuration file will be loaded the first time you start ejabberd. The content from this file will be parsed and stored in the internal ejabberd 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.

      Note that ejabberd never edits the configuration file. @@ -477,7 +494,7 @@ override_acls.

      With these lines the old global options (shared between all ejabberd nodes in a cluster), local options (which are specific for this particular ejabberd node) and ACLs will be removed before new ones are added.

      -

      3.1.1  Host Names

      +

      3.1.1  Host Names

      The option hosts defines a list containing one or more domains that ejabberd will serve.

      Examples:

      • @@ -489,7 +506,7 @@ versions:
      • Serving two domains:
        {hosts, ["example.net", "example.com"]}.
         

      -

      3.1.2  Virtual Hosting

      +

      3.1.2  Virtual Hosting

      Options can be defined separately for every virtual host using the host_config option. It has the following syntax: @@ -561,7 +578,7 @@ other different modules for some specific virtual hosts: } ]}.

      -

      3.1.3  Listening Ports

      +

      3.1.3  Listening Ports

      The option listen defines for which addresses and ports ejabberd will listen and what services will be run on them. Each element of the list is a tuple with the following elements: @@ -623,7 +640,10 @@ do not allow outgoing sockets on port 5222.

      If HTTP Polling is enabled, it wil is also needed in the Jabber client. Remark also that HTTP Polling can be interesting to host a web-based Jabber client such as JWChat. -

    inet6
    Set up the socket for IPv6. +

    inet6
    Set up the socket for IPv6 instead of IPv4. +Note: this option is not required for S2S outgoing connections, +because when ejabberd attempts to establish a S2S outgoing connection +it first tries IPv4, and if that fails it attempts with IPv6.
    {ip, IPAddress}
    This option specifies which network interface to listen for. For example {ip, {192, 168, 1, 1}}.
    {max_stanza_size, Size}
    @@ -832,7 +852,7 @@ services you have to make the transports log and do XDB by themselves: </xdb_file> </xdb>

    -

    3.1.4  Authentication

    +

    3.1.4  Authentication

    The option auth_method defines the authentication method that is used for user authentication:

    {auth_method, [<method>]}.
    @@ -941,7 +961,7 @@ attacks.
     
  • You may want to allow login access only for certain users. pam_listfile.so module provides such functionality.
  • -

    3.1.5  Access Rules

    +

    3.1.5  Access Rules

    ACL Definition

    Access control in ejabberd is performed via Access Control Lists (ACLs). The @@ -1048,7 +1068,7 @@ There’s also available the access max_s2s_connections_per_node.< Allow up to 3 connections with each remote server:

    {access, max_s2s_connections, [{3, all}]}.
     

    -

    3.1.6  Shapers

    +

    3.1.6  Shapers

    Shapers enable you to limit connection traffic. The syntax of shapers is like this:

    {shaper, <shapername>, <kind>}.
    @@ -1067,7 +1087,7 @@ To define a shaper named ‘normal’ with traffic speed limi
     50,000 bytes/second:
     
    {shaper, fast, {maxrate, 50000}}.
     

    -

    3.1.7  Default Language

    +

    3.1.7  Default Language

    The option language defines the default language of server strings that can be seen by Jabber clients. If a Jabber client do not support xml:lang, the specified language is used. The default value is @@ -1079,7 +1099,7 @@ To set Russian as default language:

  • To set Spanish as default language:
    {language, "es"}.
     
  • -

    3.1.8  Include Additional Configuration Files

    +

    3.1.8  Include Additional Configuration Files

    The option include_config_file in a configuration file instructs ejabberd to include other configuration files immediately.

    The basic usage is:

    {include_config_file, <filename>}.
     

    It is also possible to specify suboptions: @@ -1110,7 +1130,7 @@ and later includes another file with additional rules:

    {acl, admin, {user, "bob", "localhost"}}.
     {acl, admin, {user, "jan", "localhost"}}.
     

    -

    3.1.9  Option Macros in Configuration File

    +

    3.1.9  Option Macros in Configuration File

    In the ejabberd configuration file, it is possible to define a macro for a value and later use this macro when defining an option.

    A macro is defined with this syntax: @@ -1159,7 +1179,7 @@ This usage behaves as if it were defined and used this way: ] }.

    -

    3.2  Database and LDAP Configuration

    +

    3.2  Database and LDAP Configuration

    ejabberd uses its internal Mnesia database by default. However, it is possible to use a relational database or an LDAP server to store persistent, @@ -1181,7 +1201,7 @@ different storage systems for modules, and so forth.

    The following databas

  • Normally any LDAP compatible server should work; inform us about your success with a not-listed server so that we can list it here.
  • -

    3.2.1  MySQL

    +

    3.2.1  MySQL

    Although this section will describe ejabberd’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 Using ejabberd with MySQL native driver for information regarding these topics. @@ -1237,7 +1257,7 @@ relational databases like MySQL. To enable storage to your database, just make sure that your database is running well (see previous sections), and replace the suffix-less or ldap module variant with the odbc module variant. Keep in mind that you cannot have several variants of the same module loaded!

    -

    3.2.2  Microsoft SQL Server

    +

    3.2.2  Microsoft SQL Server

    Although this section will describe ejabberd’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 @@ -1273,7 +1293,7 @@ database, just make sure that your database is running well (see previous sections), and replace the suffix-less or ldap module variant with the odbc module variant. Keep in mind that you cannot have several variants of the same module loaded!

    -

    3.2.3  PostgreSQL

    +

    3.2.3  PostgreSQL

    Although this section will describe ejabberd’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 Using ejabberd with MySQL native driver for information regarding these topics. @@ -1332,7 +1352,7 @@ relational databases like PostgreSQL. To enable storage to your database, just make sure that your database is running well (see previous sections), and replace the suffix-less or ldap module variant with the odbc module variant. Keep in mind that you cannot have several variants of the same module loaded!

    -

    3.2.4  ODBC Compatible

    +

    3.2.4  ODBC Compatible

    Although this section will describe ejabberd’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 Using ejabberd with MySQL native driver also can help you. Note that the tutorial @@ -1375,7 +1395,7 @@ database, just make sure that your database is running well (see previous sections), and replace the suffix-less or ldap module variant with the odbc module variant. Keep in mind that you cannot have several variants of the same module loaded!

    -

    3.2.5  LDAP

    +

    3.2.5  LDAP

    ejabberd 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.

    @@ -1552,7 +1572,7 @@ configuration is shown below:

    {auth_method, ldap}.
       ...
      ]}.
     

    -

    3.3  Modules Configuration

    +

    3.3  Modules Configuration

    The option modules defines the list of modules that will be loaded after ejabberd’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 @@ -1574,7 +1594,7 @@ all entries end with a comma: {mod_version, []} ]}.

    -

    3.3.1  Modules Overview

    +

    3.3.1  Modules Overview

    The following table lists all modules included in ejabberd.


    @@ -1636,7 +1656,7 @@ Last connection date and time: Use mod_last_odbc instead of ejabberd 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!

    -

    3.3.2  Common Options

    The following options are used by many modules. Therefore, they are described in +

    3.3.2  Common Options

    The following options are used by many modules. Therefore, they are described in this separate section.

    iqdisc

    Many modules define handlers for processing IQ queries of different namespaces @@ -1688,7 +1708,7 @@ the "@HOST@" keyword must be used: ... ]}.

    -

    3.3.3  mod_announce

    +

    3.3.3  mod_announce

    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 @@ -1752,7 +1772,7 @@ Only administrators can send announcements:

    Note that mod_announce can be resource intensive on large deployments as it can broadcast lot of messages. This module should be disabled for instances of ejabberd with hundreds of thousands users.

    -

    3.3.4  mod_disco

    +

    3.3.4  mod_disco

    @@ -1795,7 +1815,7 @@ To serve a link to the Jabber User Directory on jabber.org: ... ]}.

    -

    3.3.5  mod_echo

    +

    3.3.5  mod_echo

    This module simply echoes any Jabber packet back to the sender. This mirror can be of interest for ejabberd and Jabber client debugging.

    Options: @@ -1815,7 +1835,7 @@ of them all? ... ]}.

    -

    3.3.6  mod_irc

    +

    3.3.6  mod_irc

    This module is an IRC transport that can be used to join channels on IRC servers.

    End user information: @@ -1874,7 +1894,7 @@ our domains and on other servers. ... ]}.

    -

    3.3.7  mod_last

    +

    3.3.7  mod_last

    This module adds support for Last Activity (XEP-0012). 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 @@ -1883,7 +1903,7 @@ connected user was last active on the server, or to query the uptime of the iqdisc

    This specifies the processing discipline for Last activity (jabber:iq:last) IQ queries (see section 3.3.2).

    -

    3.3.8  mod_muc

    +

    3.3.8  mod_muc

    With this module enabled, your server will support Multi-User Chat (XEP-0045). End users will be able to join text conferences.

    Some of the features of Multi-User Chat:

    • @@ -2083,7 +2103,7 @@ newly created chatrooms have by default those options. ... ]}.

    -

    3.3.9  mod_muc_log

    +

    3.3.9  mod_muc_log

    This module enables optional logging of Multi-User Chat (MUC) conversations to HTML. Once you enable this module, users can join a chatroom using a MUC capable Jabber client, and if they have enough privileges, they can request the @@ -2092,8 +2112,8 @@ configuration form in which they can set the option to enable chatroom logging.< Chatroom details are added on top of each page: room title, JID, author, subject and configuration.

  • -Room title and JID are links to join the chatroom (using -XMPP URIs). +The room JID in the generated HTML is a link to join the chatroom (using +XMPP URI).
  • Subject and chatroom configuration changes are tracked and displayed.
  • Joins, leaves, nick changes, kicks, bans and ‘/me’ are tracked and displayed, including the reason if available. @@ -2190,7 +2210,7 @@ top link will be the default <a href="/">Home</a>. ... ]}.
  • -

    3.3.10  mod_offline

    +

    3.3.10  mod_offline

    This module implements offline message storage. 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 @@ -2201,7 +2221,7 @@ is use to set a max number of offline messages per user (quota). Its value can be either infinity or a strictly positive integer. The default value is infinity.

    -

    3.3.11  mod_privacy

    +

    3.3.11  mod_privacy

    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 Jabber client, they will be able to: @@ -2229,7 +2249,7 @@ subscription type (or globally). iqdisc

    This specifies the processing discipline for Blocking Communication (jabber:iq:privacy) IQ queries (see section 3.3.2).

    -

    3.3.12  mod_private

    +

    3.3.12  mod_private

    This module adds support for Private XML Storage (XEP-0049):

    Using this method, Jabber entities can store private data on the server and @@ -2241,7 +2261,7 @@ of client-specific preferences; another is Bookmark Storage ( This specifies the processing discipline for Private XML Storage (jabber:iq:private) IQ queries (see section 3.3.2).

    -

    3.3.13  mod_proxy65

    +

    3.3.13  mod_proxy65

    This module implements SOCKS5 Bytestreams (XEP-0065). It allows ejabberd to act as a file transfer proxy between two XMPP clients.

    Options: @@ -2296,7 +2316,7 @@ The simpliest configuration of the module: ... ]}.

    -

    3.3.14  mod_pubsub

    +

    3.3.14  mod_pubsub

    This module offers a Publish-Subscribe Service (XEP-0060). The functionality in mod_pubsub can be extended using plugins. The plugin that implements PEP (Personal Eventing via Pubsub) (XEP-0163) @@ -2327,7 +2347,7 @@ and is shared by all node plugins. ... ]}.

    -

    3.3.15  mod_register

    +

    3.3.15  mod_register

    This module adds support for In-Band Registration (XEP-0077). This protocol enables end users to use a Jabber client to:

    • @@ -2343,6 +2363,7 @@ restrictions by default).
      welcome_message
      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: ~n.
      registration_watchers
      This option defines a list of JIDs which will be notified each time a new account is registered.
      iqdisc
      This specifies @@ -2393,19 +2414,19 @@ Also define a registration timeout of one hour: ... {mod_register, [ - {welcome_message, {"Welcome!", "Welcome to this Jabber server. Check http://www.jabber.org"}}, + {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"]} ]}, ... ]}.

    -

    3.3.16  mod_roster

    +

    3.3.16  mod_roster

    This module implements roster management as defined in RFC 3921: XMPP IM.

    Options:

    iqdisc
    This specifies the processing discipline for Roster Management (jabber:iq:roster) IQ queries (see section 3.3.2).

    -

    3.3.17  mod_service_log

    +

    3.3.17  mod_service_log

    This module adds support for logging end user packets via a Jabber message auditing service such as Bandersnatch. All user @@ -2435,7 +2456,7 @@ To log all end user packets to the Bandersnatch service running on ... ]}.

    -

    3.3.18  mod_shared_roster

    +

    3.3.18  mod_shared_roster

    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 @@ -2510,7 +2531,7 @@ roster groups as shown in the following table:

    ModuleFeatureDependencies
    mod_adhocAd-Hoc Commands (XEP-0050) 

    -

    3.3.19  mod_stats

    +

    3.3.19  mod_stats

    This module adds support for Statistics Gathering (XEP-0039). This protocol allows you to retrieve next statistics from your ejabberd deployment:

    • @@ -2542,14 +2563,14 @@ by sending: </query> </iq>

    -

    3.3.20  mod_time

    +

    3.3.20  mod_time

    This module features support for Entity Time (XEP-0090). By using this XEP, you are able to discover the time at another entity’s location.

    Options:

    iqdisc
    This specifies the processing discipline for Entity Time (jabber:iq:time) IQ queries (see section 3.3.2).

    -

    3.3.21  mod_vcard

    +

    3.3.21  mod_vcard

    This module allows end users to store and retrieve their vCard, and to retrieve other users vCards, as defined in vcard-temp (XEP-0054). The module also implements an uncomplicated Jabber User Directory based on the vCards of @@ -2604,7 +2625,7 @@ and that all virtual hosts will be searched instead of only the current one: ... ]}.

    -

    3.3.22  mod_vcard_ldap

    +

    3.3.22  mod_vcard_ldap

    ejabberd can map LDAP attributes to vCard fields. This behaviour is implemented in the mod_vcard_ldap module. This module does not depend on the authentication method (see 3.2.5).

    The mod_vcard_ldap module has @@ -2778,7 +2799,7 @@ searching his info in LDAP.

  • ldap_vcard_map
  • -

    3.3.23  mod_version

    +

    3.3.23  mod_version

    This module implements Software Version (XEP-0092). Consequently, it answers ejabberd’s version when queried.

    Options:

    @@ -2787,9 +2808,9 @@ The default value is true.
    iqdisc
    This specifies the processing discipline for Software Version (jabber:iq:version) IQ queries (see section 3.3.2).

    -

    Chapter 4  Managing an ejabberd server

    -

    4.1  ejabberdctl

    -

    4.1.1  Commands

    The ejabberdctl command line administration script allows to start, stop and perform +

    Chapter 4  Managing an ejabberd server

    +

    4.1  ejabberdctl

    +

    4.1.1  Commands

    The ejabberdctl command line administration script allows to start, stop and perform many other administrative tasks in a local or remote ejabberd server.

    When ejabberdctl is executed without any parameter, it displays the available options. If there isn’t an ejabberd server running, the available parameters are: @@ -2822,7 +2843,7 @@ and other codes may be used for specifical results. This can be used by other scripts to determine automatically if a command succedded or failed, for example using: echo $?

    -

    4.1.2  Erlang runtime system

    ejabberd is an Erlang/OTP application that runs inside an Erlang runtime system. +

    4.1.2  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, @@ -2889,7 +2910,7 @@ Starts the Erlang system detached from the system console.

    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).

    -

    4.2  Web Admin

    +

    4.2  Web Admin

    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 @@ -2949,15 +2970,15 @@ web browser to https://192.168.1.1:5280/admin/: ... ]}.

    -

    4.3  Ad-hoc Commands

    If you enable mod_configure and mod_adhoc, +

    4.3  Ad-hoc Commands

    If you enable mod_configure and mod_adhoc, you can perform several administrative tasks in ejabberd with a Jabber client. The client must support Ad-Hoc Commands (XEP-0050), and you must login in the Jabber server with an account with proper privileges.

    -

    4.4  Change Computer Hostname

    ejabberd uses the distributed Mnesia database. +

    4.4  Change Computer Hostname

    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. +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. So, the name of the Erlang node changes if you change the name of the machine in which ejabberd runs, @@ -2971,8 +2992,8 @@ you must follow these instructions: For example:

    ejabberdctl restore /tmp/ejabberd-oldhost.backup
     

    -

    Chapter 5  Securing ejabberd

    -

    5.1  Firewall Settings

    +

    Chapter 5  Securing ejabberd

    +

    5.1  Firewall Settings

    You need to take the following TCP ports in mind when configuring your firewall:


    @@ -2983,7 +3004,7 @@ you must follow these instructions:
    PortDescription
    port rangeUsed for connections between Erlang nodes. This range is configurable (see section 5.2).

    -

    5.2  epmd

    epmd (Erlang Port Mapper Daemon) +

    5.2  epmd

    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. @@ -3008,9 +3029,10 @@ 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
     

    -

    5.3  Erlang Cookie

    The Erlang cookie is a string with numbers and letters. -An Erlang node reads the cookie at startup from the command-line parameter -setcookie -or from a cookie file. +

    5.3  Erlang Cookie

    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. 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.

    Thanks to Erlang cookies, you can prevent access to the Erlang node by mistake, @@ -3021,7 +3043,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.

    -

    5.4  Erlang node name

    An Erlang node may have a node name. +

    5.4  Erlang 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 @@ -3029,10 +3051,30 @@ 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 epmd. -The recommended way to secure the Erlang node is to block the port 4369.

    -

    Chapter 6  Clustering

    +The recommended way to secure the Erlang node is to block the port 4369.

    +

    5.5  Securing sensible files

    ejabberd stores sensible 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.

    +ejabberd configuration file: /etc/ejabberd/ejabberd.cfg
    +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 /etc/ejabberd/ directory. +
    ejabberd service log: /var/log/ejabberd/ejabberd.log
    +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 /var/log/ejabberd/ directory. +
    Mnesia database spool files: /var/lib/ejabberd/db/*
    +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 /var/lib/ejabberd/db/ directory. +
    Erlang cookie file: /var/lib/ejabberd/.erlang.cookie
    +See section 5.3. +

    +

    Chapter 6  Clustering

    -

    6.1  How it Works

    +

    6.1  How it Works

    A Jabber 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 @@ -3046,29 +3088,29 @@ router,

  • session manager,
  • s2s manager.
  • -

    6.1.1  Router

    +

    6.1.1  Router

    This module is the main router of Jabber 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.

    -

    6.1.2  Local Router

    +

    6.1.2  Local Router

    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.

    -

    6.1.3  Session Manager

    +

    6.1.3  Session Manager

    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.

    -

    6.1.4  s2s Manager

    +

    6.1.4  s2s Manager

    This module routes packets to other Jabber 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.

    -

    6.2  Clustering Setup

    +

    6.2  Clustering Setup

    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:

    1. @@ -3102,10 +3144,10 @@ and ‘access’ options — 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.

    -

    6.3  Service Load-Balancing

    +

    6.3  Service Load-Balancing

    -

    6.3.1  Components Load-Balancing

    -

    6.3.2  Domain Load-Balancing Algorithm

    +

    6.3.1  Components Load-Balancing

    +

    6.3.2  Domain Load-Balancing Algorithm

    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:

    {domain_balancing, "component.example.com", <balancing_criterium>}.                                   
     

    Several balancing criteria are available:

    • @@ -3114,13 +3156,13 @@ domain.

      -

      6.3.3  Load-Balancing Buckets

      +

      6.3.3  Load-Balancing Buckets

      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 the following:

      {domain_balancing_component_number, "component.example.com", N}
       

      -

      Chapter 7  Debugging

      +

      Chapter 7  Debugging

      -

      7.1  Watchdog Alerts

      +

      7.1  Watchdog Alerts

      ejabberd includes a watchdog mechanism. If a process in the ejabberd server consumes too much memory, a message is sent to the Jabber accounts defined with the option @@ -3132,7 +3174,7 @@ Example configuration: To remove all watchdog admins, set the option with an empty list:

      {watchdog_admins, []}.
       

      -

      7.2  Log Files

      An ejabberd node writes two log files: +

      7.2  Log Files

      An ejabberd node writes two log files:

      ejabberd.log
      is the ejabberd service log, with the messages reported by ejabberd code
      sasl.log
      is the Erlang/OTP system log, with the messages reported by Erlang/OTP using SASL (System Architecture Support Libraries) @@ -3149,12 +3191,12 @@ The possible levels are: For example, the default configuration is:

      {loglevel, 4}.
       

      -

      7.3  Debug Console

      The Debug Console is an Erlang shell attached to an already running ejabberd server. +

      7.3  Debug Console

      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.

      -

      Appendix A  Internationalization and Localization

      +

      Appendix A  Internationalization and Localization

      All built-in modules support the xml:lang attribute inside IQ queries. Figure A.1, for example, shows the reply to the following query:

      <iq id='5'
      @@ -3181,9 +3223,9 @@ HTTP header ‘Accept-Language: ru’
       
       
       

      -

      Appendix B  Release Notes

      +

      Appendix B  Release Notes

      Release notes are available from ejabberd Home Page

      -

      Appendix C  Acknowledgements

      Thanks to all people who contributed to this guide: +

      Appendix C  Acknowledgements

      Thanks to all people who contributed to this guide:

      -

      Appendix D  Copyright Information

      Ejabberd Installation and Operation Guide.
      +

      Appendix D  Copyright Information

      Ejabberd Installation and Operation Guide.
      Copyright © 2003 — 2008 Process-one

      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 73d889fc5..5a23a359a 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -361,7 +361,7 @@ The files and directories created are, by default: \titem{/sbin/ejabberdctl} Administration script \titem{/var/lib/ejabberd/} \begin{description} - \titem{.erlang.cookie} Erlang cookie file + \titem{.erlang.cookie} Erlang cookie file (see section \ref{cookie}) \titem{db} Mnesia database spool files \titem{ebin} Binary Erlang files (*.beam) \titem{priv} @@ -405,6 +405,31 @@ gmake \end{verbatim} +\makesubsection{solaris}{Specific Notes for Sun Solaris} +\ind{install!solaris} + +You need to have \term{GNU install}, +but it isn't included in Solaris. +It can be easily installed if your Solaris system +is set up for \footahref{http://www.blastwave.org/}{blastwave.org} +package repository. +Make sure \term{/opt/csw/bin} is in your \term{PATH} and run: +\begin{verbatim} +pkg-get -i fileutils +\end{verbatim} + +If that program is called \term{ginstall}, +modify the \ejabberd{} \term{Makefile} script to suit your system, +for example: +\begin{verbatim} +cat Makefile | sed s/install/ginstall/ > Makefile.gi +\end{verbatim} +And finally install \ejabberd{} with: +\begin{verbatim} +gmake -f Makefile.gi ginstall +\end{verbatim} + + \makesubsection{windows}{Specific Notes for Microsoft Windows} \ind{install!windows} @@ -729,7 +754,10 @@ This is a detailed description of each option allowed by the listening modules: is also needed in the \Jabber{} client. Remark also that HTTP Polling can be interesting to host a web-based \Jabber{} client such as \footahref{http://jwchat.sourceforge.net/}{JWChat}. - \titem{inet6} \ind{options!inet6}\ind{IPv6}Set up the socket for IPv6. + \titem{inet6} \ind{options!inet6}\ind{IPv6}Set up the socket for IPv6 instead of IPv4. + Note: this option is not required for S2S outgoing connections, + because when ejabberd attempts to establish a S2S outgoing connection + it first tries IPv4, and if that fails it attempts with IPv6. \titem{\{ip, IPAddress\}} \ind{options!ip}This option specifies which network interface to listen for. For example \verb|{ip, {192, 168, 1, 1}}|. \titem{\{max\_stanza\_size, Size\}} @@ -2710,9 +2738,9 @@ Features: \begin{itemize} \item Chatroom details are added on top of each page: room title, JID, author, subject and configuration. -\item \ind{protocols!RFC 4622: Internationalized Resource Identifiers (IRIs) and Uniform Resource Identifiers (URIs) for the Extensible Messaging and Presence Protocol (XMPP)} - Room title and JID are links to join the chatroom (using - \footahref{http://www.ietf.org/rfc/rfc4622.txt}{XMPP URIs}). +\item \ind{protocols!RFC 5122: Internationalized Resource Identifiers (IRIs) and Uniform Resource Identifiers (URIs) for the Extensible Messaging and Presence Protocol (XMPP)} + The room JID in the generated HTML is a link to join the chatroom (using + \footahref{http://www.xmpp.org/rfcs/rfc5122.html}{XMPP URI}). \item Subject and chatroom configuration changes are tracked and displayed. \item Joins, leaves, nick changes, kicks, bans and `/me' are tracked and displayed, including the reason if available. @@ -3008,6 +3036,7 @@ Options: \titem{welcome\_message} \ind{options!welcomem}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: \term{\~\ n}. \titem{registration\_watchers} \ind{options!rwatchers}This option defines a list of JIDs which will be notified each time a new account is registered. \iqdiscitem{In-Band Registration (\ns{jabber:iq:register})} @@ -3066,7 +3095,7 @@ Also define a registration timeout of one hour: ... {mod_register, [ - {welcome_message, {"Welcome!", "Welcome to this Jabber server. Check http://www.jabber.org"}}, + {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"]} ]}, ... @@ -3781,7 +3810,7 @@ an account with proper privileges. \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. +so it stores the name of the Erlang node in it (see section \ref{nodename}). 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 \ejabberd{} runs, @@ -3861,8 +3890,9 @@ erl ... -kernel inet_dist_listen_min 4370 inet_dist_listen_max 4375 \makesection{cookie}{Erlang Cookie} The Erlang cookie is a string with numbers and letters. -An Erlang node reads the cookie at startup from the command-line parameter \term{-setcookie} -or from a cookie file. +An Erlang node reads the cookie at startup from the command-line parameter \term{-setcookie}. +If not indicated, the cookie is read from the cookie file \term{\$HOME/.erlang.cookie}. +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. @@ -3894,6 +3924,32 @@ using a modified version of Erlang \term{epmd}. The recommended way to secure the Erlang node is to block the port 4369. +\makesection{secure-files}{Securing sensible files} + +\ejabberd{} stores sensible 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. + +\begin{description} + \titem{ejabberd configuration file: /etc/ejabberd/ejabberd.cfg} + 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 \term{/etc/ejabberd/} directory. + \titem{ejabberd service log: /var/log/ejabberd/ejabberd.log} + 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 \term{/var/log/ejabberd/} directory. + \titem{Mnesia database spool files: /var/lib/ejabberd/db/*} + 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 \term{/var/lib/ejabberd/db/} directory. + \titem{Erlang cookie file: /var/lib/ejabberd/.erlang.cookie} + See section \ref{cookie}. +\end{description} + + \makechapter{clustering}{Clustering} \ind{clustering} diff --git a/src/Makefile.in b/src/Makefile.in index 57bb56333..607af353e 100644 --- a/src/Makefile.in +++ b/src/Makefile.in @@ -60,6 +60,7 @@ DESTDIR = EJABBERDDIR = $(DESTDIR)@localstatedir@/lib/ejabberd BEAMDIR = $(EJABBERDDIR)/ebin +SPOOLDIR = $(EJABBERDDIR)/db PRIVDIR = $(EJABBERDDIR)/priv SODIR = $(PRIVDIR)/lib PBINDIR = $(PRIVDIR)/bin @@ -116,20 +117,21 @@ install: all install -m 644 *.beam $(BEAMDIR) rm -f $(BEAMDIR)/configure.beam install -m 644 *.app $(BEAMDIR) + install -d -m 750 $(SPOOLDIR) install -d $(SODIR) install -d $(PBINDIR) install -m 644 *.so $(SODIR) $(INSTALL_EPAM) install -d $(MSGSDIR) install -m 644 msgs/*.msg $(MSGSDIR) - install -d $(ETCDIR) + install -d -m 750 $(ETCDIR) [ -f $(ETCDIR)/ejabberd.cfg ] && install -b -m 644 ejabberd.cfg.example $(ETCDIR)/ejabberd.cfg-new || install -b -m 644 ejabberd.cfg.example $(ETCDIR)/ejabberd.cfg sed -e "s*@rootdir@*@prefix@*" ejabberdctl.template > ejabberdctl.example [ -f $(ETCDIR)/ejabberdctl.cfg ] && install -b -m 644 ejabberdctl.cfg.example $(ETCDIR)/ejabberdctl.cfg-new || install -b -m 644 ejabberdctl.cfg.example $(ETCDIR)/ejabberdctl.cfg install -b -m 644 inetrc $(ETCDIR)/inetrc install -d $(SBINDIR) install -m 755 ejabberdctl.example $(SBINDIR)/ejabberdctl - install -d $(LOGDIR) + install -d -m 750 $(LOGDIR) uninstall: uninstall-binary diff --git a/src/configure b/src/configure index 573a17ee7..034868416 100755 --- a/src/configure +++ b/src/configure @@ -4765,6 +4765,9 @@ _ACEOF fi +# Check Erlang headers are installed +#AC_CHECK_HEADER(erl_driver.h,,[AC_MSG_ERROR([cannot find Erlang header files])]) + # Change default prefix diff --git a/src/configure.ac b/src/configure.ac index a3e8894e9..254b16b06 100644 --- a/src/configure.ac +++ b/src/configure.ac @@ -26,6 +26,9 @@ AM_WITH_PAM # Checks for typedefs, structures, and compiler characteristics. AC_C_CONST +# Check Erlang headers are installed +#AC_CHECK_HEADER(erl_driver.h,,[AC_MSG_ERROR([cannot find Erlang header files])]) + # Change default prefix AC_PREFIX_DEFAULT(/) diff --git a/src/ejabberd.cfg.example b/src/ejabberd.cfg.example index e1d63ed9e..eb43bb3ca 100644 --- a/src/ejabberd.cfg.example +++ b/src/ejabberd.cfg.example @@ -459,7 +459,7 @@ %% a message with this subject and body. %% {welcome_message, {"Welcome!", - "Welcome to this Jabber server."}}, + "Hi.~nWelcome to this Jabber server."}}, %% %% When a user registers, send a notification to diff --git a/src/ejabberd_c2s.erl b/src/ejabberd_c2s.erl index dae88f07a..82fd029ce 100644 --- a/src/ejabberd_c2s.erl +++ b/src/ejabberd_c2s.erl @@ -1223,6 +1223,9 @@ handle_info({route, FromOld, ToOld, PacketOld}, StateName, StateData) -> handle_info({'DOWN', Monitor, _Type, _Object, _Info}, _StateName, StateData) when Monitor == StateData#state.socket_monitor -> {stop, normal, StateData}; +handle_info({peername, IP}, StateName, StateData) -> + ejabberd_sm:set_session_ip(StateData#state.sid, IP), + fsm_next_state(StateName, StateData#state{ip = IP}); handle_info(Info, StateName, StateData) -> ?ERROR_MSG("Unexpected info: ~p", [Info]), fsm_next_state(StateName, StateData). diff --git a/src/ejabberd_config.erl b/src/ejabberd_config.erl index 7a9cade1f..c18cfe6de 100644 --- a/src/ejabberd_config.erl +++ b/src/ejabberd_config.erl @@ -96,8 +96,10 @@ get_plain_terms_file(File1) -> {ok, Terms} -> include_config_files(Terms); {error, Reason} -> - ?ERROR_MSG("Can't load config file ~p: ~p", [File, Reason]), - exit(File ++ ": " ++ file:format_error(Reason)) + ExitText = lists:flatten(File ++ ": around line " + ++ file:format_error(Reason)), + ?ERROR_MSG("Problem loading ejabberd config file:~n~s", [ExitText]), + exit(ExitText) end. %% @doc Convert configuration filename to absolute path. diff --git a/src/ejabberd_ctl.erl b/src/ejabberd_ctl.erl index 7cb36141d..9a84b592e 100644 --- a/src/ejabberd_ctl.erl +++ b/src/ejabberd_ctl.erl @@ -30,6 +30,7 @@ -export([start/0, init/0, process/1, + dump_to_textfile/1, register_commands/3, register_commands/4, unregister_commands/3, diff --git a/src/ejabberd_local.erl b/src/ejabberd_local.erl index 76719bbb8..c3786ca53 100644 --- a/src/ejabberd_local.erl +++ b/src/ejabberd_local.erl @@ -37,6 +37,7 @@ register_iq_handler/5, register_iq_response_handler/4, unregister_iq_handler/2, + unregister_iq_response_handler/2, refresh_iq_handlers/0, bounce_resource_packet/3 ]). @@ -168,6 +169,9 @@ register_iq_handler(Host, XMLNS, Module, Fun) -> register_iq_handler(Host, XMLNS, Module, Fun, Opts) -> ejabberd_local ! {register_iq_handler, Host, XMLNS, Module, Fun, Opts}. +unregister_iq_response_handler(Host, ID) -> + ejabberd_local ! {unregister_iq_response_handler, Host, ID}. + unregister_iq_handler(Host, XMLNS) -> ejabberd_local ! {unregister_iq_handler, Host, XMLNS}. @@ -254,6 +258,9 @@ handle_info({route, From, To, Packet}, State) -> handle_info({register_iq_response_handler, _Host, ID, Module, Function}, State) -> mnesia:dirty_write(#iq_response{id = ID, module = Module, function = Function}), {noreply, State}; +handle_info({unregister_iq_response_handler, _Host, ID}, State) -> + mnesia:dirty_delete({iq_response, ID}), + {noreply, State}; handle_info({register_iq_handler, Host, XMLNS, Module, Function}, State) -> ets:insert(?IQTABLE, {{XMLNS, Host}, Module, Function}), catch mod_disco:register_feature(Host, XMLNS), diff --git a/src/ejabberd_receiver.erl b/src/ejabberd_receiver.erl index 5fdad76af..3b6c80439 100644 --- a/src/ejabberd_receiver.erl +++ b/src/ejabberd_receiver.erl @@ -268,7 +268,8 @@ code_change(_OldVsn, State, _Extra) -> %%-------------------------------------------------------------------- activate_socket(#state{socket = Socket, - sock_mod = SockMod}) -> + sock_mod = SockMod, + c2s_pid = C2SPid}) -> PeerName = case SockMod of gen_tcp -> @@ -281,7 +282,8 @@ activate_socket(#state{socket = Socket, case PeerName of {error, _Reason} -> self() ! {tcp_closed, Socket}; - {ok, _} -> + {ok, IP} -> + C2SPid ! {peername, IP}, ok end. diff --git a/src/ejabberd_sm.erl b/src/ejabberd_sm.erl index 9300958d5..ccf679386 100644 --- a/src/ejabberd_sm.erl +++ b/src/ejabberd_sm.erl @@ -49,7 +49,8 @@ ctl_process/2, get_session_pid/3, get_user_info/3, - get_user_ip/3 + get_user_ip/3, + set_session_ip/2 ]). %% gen_server callbacks @@ -186,6 +187,18 @@ get_user_info(User, Server, Resource) -> [{node, Node}, {conn, Conn}, {ip, IP}] end. +set_session_ip(SID, IP) -> + case mnesia:dirty_read(session, SID) of + [#session{info = Info} = Session] -> + NewInfo = case lists:keymember(ip, 1, Info) of + true -> lists:keyreplace(ip, 1, Info, {ip, IP}); + false -> [{ip, IP}|Info] + end, + mnesia:dirty_write(Session#session{info = NewInfo}); + _ -> + ok + end. + set_presence(SID, User, Server, Resource, Priority, Presence, Info) -> set_session(SID, User, Server, Resource, Priority, Info), % XXX OLD FORMAT: Presence. diff --git a/src/mod_caps.erl b/src/mod_caps.erl index 2be0fac66..3240aa6e2 100644 --- a/src/mod_caps.erl +++ b/src/mod_caps.erl @@ -53,6 +53,7 @@ -define(PROCNAME, ejabberd_mod_caps). -define(DICT, dict). +-define(CAPS_QUERY_TIMEOUT, 60000). % 1mn without answer, consider client never answer -record(caps, {node, version, exts}). -record(caps_features, {node_pair, features}). @@ -220,6 +221,7 @@ handle_cast({note_caps, From, ejabberd_local:register_iq_response_handler (Host, ID, ?MODULE, handle_disco_response), ejabberd_router:route(jlib:make_jid("", Host, ""), From, Stanza), + timer:send_after(?CAPS_QUERY_TIMEOUT, self(), {disco_timeout, ID}), ?DICT:store(ID, {Node, SubNode}, Dict) end, Requests, Missing), {noreply, State#state{disco_requests = NewRequests}}; @@ -274,6 +276,16 @@ handle_cast({disco_response, From, _To, end, NewRequests = ?DICT:erase(ID, Requests), {noreply, State#state{disco_requests = NewRequests}}; +handle_cast({disco_timeout, ID}, #state{host = Host, disco_requests = Requests} = State) -> + %% do not wait a response anymore for this IQ, client certainly will never answer + NewRequests = case ?DICT:is_key(ID, Requests) of + true -> + ejabberd_local:unregister_iq_response_handler(Host, ID), + ?DICT:erase(ID, Requests); + false -> + Requests + end, + {noreply, State#state{disco_requests = NewRequests}}; handle_cast(visit_feature_queries, #state{feature_queries = FeatureQueries} = State) -> Timestamp = timestamp(), NewFeatureQueries = diff --git a/src/mod_configure.erl b/src/mod_configure.erl index 625e380cd..e012794dd 100644 --- a/src/mod_configure.erl +++ b/src/mod_configure.erl @@ -1416,7 +1416,7 @@ set_form(_From, _Host, ["running nodes", ENode, "backup", "textfile"], _Lang, XD false -> {error, ?ERR_BAD_REQUEST}; {value, {_, [String]}} -> - case rpc:call(Node, mnesia, dump_to_textfile, [String]) of + case rpc:call(Node, ejabberd_ctl, dump_to_textfile, [String]) of {badrpc, _Reason} -> {error, ?ERR_INTERNAL_SERVER_ERROR}; {error, _Reason} -> diff --git a/src/mod_muc/mod_muc_log.erl b/src/mod_muc/mod_muc_log.erl index fce9c15b2..9ab8d4ce2 100644 --- a/src/mod_muc/mod_muc_log.erl +++ b/src/mod_muc/mod_muc_log.erl @@ -120,9 +120,11 @@ init([Host, Opts]) -> NoFollow = gen_mod:get_opt(spam_prevention, Opts, true), Lang = case ejabberd_config:get_local_option({language, Host}) of undefined -> - ""; - L -> - L + case ejabberd_config:get_global_option(language) of + undefined -> "en"; + L -> L + end; + L -> L end, {ok, #state{host = Host, out_dir = OutDir, @@ -286,9 +288,10 @@ add_message_to_log(Nick1, Message, RoomJID, Opts, State) -> top_link = TopLink} = State, Room = get_room_info(RoomJID, Opts), + Now = now(), TimeStamp = case Timezone of - local -> calendar:now_to_local_time(now()); - universal -> calendar:now_to_universal_time(now()) + local -> calendar:now_to_local_time(Now); + universal -> calendar:now_to_universal_time(Now) end, {Fd, Fn, _Dir} = build_filename_string(TimeStamp, OutDir, Room#room.jid, DirType), {Date, Time} = TimeStamp, @@ -382,10 +385,12 @@ add_message_to_log(Nick1, Message, RoomJID, Opts, State) -> {Hour, Minute, Second} = Time, STime = lists:flatten( io_lib:format("~2..0w:~2..0w:~2..0w", [Hour, Minute, Second])), + {_, _, Microsecs} = Now, + STimeUnique = io_lib:format("~s.~w", [STime, Microsecs]), % Write message - file:write(F, io_lib:format("[~s] ~s~n", - [STime, STime, STime, Text])), + file:write(F, io_lib:format("[~s] ~s~n", + [STimeUnique, STimeUnique, STimeUnique, STime, Text])), % Close file file:close(F), diff --git a/src/mod_muc/mod_muc_room.erl b/src/mod_muc/mod_muc_room.erl index e858d680f..64957a70a 100644 --- a/src/mod_muc/mod_muc_room.erl +++ b/src/mod_muc/mod_muc_room.erl @@ -59,6 +59,7 @@ -record(lqueue, {queue, len, max}). -record(config, {title = "", + description = "", allow_change_subj = true, allow_query_users = true, allow_private_messages = true, @@ -2614,7 +2615,10 @@ get_config(Lang, StateData, From) -> [{xmlcdata, "http://jabber.org/protocol/muc#roomconfig"}]}]}, ?STRINGXFIELD("Room title", "muc#roomconfig_roomname", - Config#config.title) + Config#config.title), + ?STRINGXFIELD("Room description", + "muc#roomconfig_roomdesc", + Config#config.description) ] ++ case acl:match_rule(StateData#state.server_host, AccessPersistent, From) of allow -> @@ -2761,6 +2765,8 @@ set_xoption([], Config) -> Config; set_xoption([{"muc#roomconfig_roomname", [Val]} | Opts], Config) -> ?SET_STRING_XOPT(title, Val); +set_xoption([{"muc#roomconfig_roomdesc", [Val]} | Opts], Config) -> + ?SET_STRING_XOPT(description, Val); set_xoption([{"muc#roomconfig_changesubject", [Val]} | Opts], Config) -> ?SET_BOOL_XOPT(allow_change_subj, Val); set_xoption([{"allow_query_users", [Val]} | Opts], Config) -> @@ -2856,6 +2862,7 @@ set_opts([], StateData) -> set_opts([{Opt, Val} | Opts], StateData) -> NSD = case Opt of title -> StateData#state{config = (StateData#state.config)#config{title = Val}}; + description -> StateData#state{config = (StateData#state.config)#config{description = Val}}; allow_change_subj -> StateData#state{config = (StateData#state.config)#config{allow_change_subj = Val}}; allow_query_users -> StateData#state{config = (StateData#state.config)#config{allow_query_users = Val}}; allow_private_messages -> StateData#state{config = (StateData#state.config)#config{allow_private_messages = Val}}; @@ -2895,6 +2902,7 @@ make_opts(StateData) -> Config = StateData#state.config, [ ?MAKE_CONFIG_OPT(title), + ?MAKE_CONFIG_OPT(description), ?MAKE_CONFIG_OPT(allow_change_subj), ?MAKE_CONFIG_OPT(allow_query_users), ?MAKE_CONFIG_OPT(allow_private_messages), @@ -2991,9 +2999,12 @@ process_iq_disco_info(_From, get, Lang, StateData) -> iq_disco_info_extras(Lang, StateData) -> Len = length(?DICT:to_list(StateData#state.users)), + RoomDescription = (StateData#state.config)#config.description, [{xmlelement, "x", [{"xmlns", ?NS_XDATA}, {"type", "result"}], [?RFIELDT("hidden", "FORM_TYPE", "http://jabber.org/protocol/muc#roominfo"), + ?RFIELD("Room description", "muc#roominfo_description", + RoomDescription), ?RFIELD("Number of occupants", "muc#roominfo_occupants", integer_to_list(Len)) ]}]. diff --git a/src/mod_privacy_odbc.erl b/src/mod_privacy_odbc.erl index 8db812d0b..b4e267d28 100644 --- a/src/mod_privacy_odbc.erl +++ b/src/mod_privacy_odbc.erl @@ -16,7 +16,7 @@ %%% 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 @@ -698,11 +698,11 @@ raw_to_item({SType, SValue, SAction, SOrder, SMatchAll, SMatchIQ, "d" -> deny end, Order = list_to_integer(SOrder), - MatchAll = SMatchAll == "t", - MatchIQ = SMatchIQ == "t", - MatchMessage = SMatchMessage == "t", - MatchPresenceIn = SMatchPresenceIn == "t", - MatchPresenceOut = SMatchPresenceOut == "t", + MatchAll = SMatchAll == "1" orelse SMatchAll == "t", + MatchIQ = SMatchIQ == "1" orelse SMatchIQ == "t" , + MatchMessage = SMatchMessage == "1" orelse SMatchMessage == "t", + MatchPresenceIn = SMatchPresenceIn == "1" orelse SMatchPresenceIn == "t", + MatchPresenceOut = SMatchPresenceOut == "1" orelse SMatchPresenceOut == "t", #listitem{type = Type, value = Value, action = Action, @@ -750,11 +750,11 @@ item_to_raw(#listitem{type = Type, deny -> "d" end, SOrder = integer_to_list(Order), - SMatchAll = if MatchAll -> "t"; true -> "f" end, - SMatchIQ = if MatchIQ -> "t"; true -> "f" end, - SMatchMessage = if MatchMessage -> "t"; true -> "f" end, - SMatchPresenceIn = if MatchPresenceIn -> "t"; true -> "f" end, - SMatchPresenceOut = if MatchPresenceOut -> "t"; true -> "f" end, + SMatchAll = if MatchAll -> "1"; true -> "0" end, + SMatchIQ = if MatchIQ -> "1"; true -> "0" end, + SMatchMessage = if MatchMessage -> "1"; true -> "0" end, + SMatchPresenceIn = if MatchPresenceIn -> "1"; true -> "0" end, + SMatchPresenceOut = if MatchPresenceOut -> "1"; true -> "0" end, ["'", SType, "', " "'", SValue, "', " "'", SAction, "', " @@ -871,6 +871,3 @@ sql_set_privacy_list(ID, RItems) -> ") " "values ('", ID, "', ", Items, ");"]) end, RItems). - - - diff --git a/src/mod_pubsub/gen_pubsub_node.erl b/src/mod_pubsub/gen_pubsub_node.erl index 195ed3934..bbbb5c409 100644 --- a/src/mod_pubsub/gen_pubsub_node.erl +++ b/src/mod_pubsub/gen_pubsub_node.erl @@ -62,7 +62,9 @@ behaviour_info(callbacks) -> {get_states, 2}, {get_state, 3}, {set_state, 1}, + {get_items, 7}, {get_items, 2}, + {get_item, 8}, {get_item, 3}, {set_item, 1}, {get_item_name, 3} diff --git a/src/mod_pubsub/mod_pubsub.erl b/src/mod_pubsub/mod_pubsub.erl index cb8ce997d..e83e0170f 100644 --- a/src/mod_pubsub/mod_pubsub.erl +++ b/src/mod_pubsub/mod_pubsub.erl @@ -30,16 +30,17 @@ %%% %%% @reference See XEP-0060: Pubsub for %%% the latest version of the PubSub specification. -%%% This module uses version 1.10 of the specification as a base. +%%% This module uses version 1.11 of the specification as a base. %%% Most of the specification is implemented. -%%% Code is derivated from the original pubsub v1.7, functions concerning config may be rewritten. -%%% Code also inspired from the original PEP patch by Magnus Henoch (mangeATfreemail.hu) +%%% Functions concerning configuration should be rewritten. +%%% Code is derivated from the original pubsub v1.7, by Alexey Shchepin %%% TODO %%% plugin: generate Reply (do not use broadcast atom anymore) -module(mod_pubsub). --version('1.10-01'). +-author('christophe.romain@process-one.net'). +-version('1.11-01'). -behaviour(gen_server). -behaviour(gen_mod). @@ -912,7 +913,17 @@ iq_pubsub(Host, ServerHost, From, IQType, SubEl, _Lang, Access, Plugins) -> unsubscribe_node(Host, Node, From, JID, SubId); {get, "items"} -> MaxItems = xml:get_attr_s("max_items", Attrs), - get_items(Host, Node, From, MaxItems); + SubId = xml:get_attr_s("subid", Attrs), + ItemIDs = lists:foldl(fun + ({xmlelement, "item", ItemAttrs, _}, Acc) -> + case xml:get_attr_s("id", ItemAttrs) of + "" -> Acc; + ItemID -> ItemID + end; + (_, Acc) -> + Acc + end, [], xml:remove_cdata(Els)), + get_items(Host, Node, From, SubId, MaxItems, ItemIDs); {get, "subscriptions"} -> get_subscriptions(Host, From, Plugins); {get, "affiliations"} -> @@ -1436,7 +1447,7 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> Action = fun(#pubsub_node{options = Options, type = Type}) -> Features = features(Type), PublishFeature = lists:member("publish", Features), - Model = get_option(Options, publish_model), + PublishModel = get_option(Options, publish_model), MaxItems = max_items(Options), PayloadSize = size(term_to_binary(Payload)), PayloadMaxSize = get_option(Options, max_payload_size), @@ -1459,7 +1470,7 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> %% % Publisher attempts to publish to transient notification node with item %% {error, extended_error(?ERR_BAD_REQUEST, "item-forbidden")}; true -> - node_call(Type, publish_item, [Host, Node, Publisher, Model, MaxItems, ItemId, Payload]) + node_call(Type, publish_item, [Host, Node, Publisher, PublishModel, MaxItems, ItemId, Payload]) end end, %%ejabberd_hooks:run(pubsub_publish_item, Host, [Host, Node, JID, service_jid(Host), ItemId, Payload]), @@ -1622,7 +1633,7 @@ purge_node(Host, Node, Owner) -> %%

      The permission are not checked in this function.

      %% @todo We probably need to check that the user doing the query has the right %% to read the items. -get_items(Host, Node, _JID, SMaxItems) -> +get_items(Host, Node, From, SubId, SMaxItems, ItemIDs) -> MaxItems = if SMaxItems == "" -> ?MAXITEMS; @@ -1636,24 +1647,60 @@ get_items(Host, Node, _JID, SMaxItems) -> {error, Error} -> {error, Error}; _ -> - case get_items(Host, Node) of - [] -> - {error, ?ERR_ITEM_NOT_FOUND}; - Items -> + Action = fun(#pubsub_node{options = Options, type = Type}) -> + 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), + {PresenceSubscription, RosterGroup} = + case Host of + {OUser, OServer, _} -> + get_roster_info(OUser, OServer, + jlib:jid_tolower(From), AllowedGroups); + _ -> + {true, true} + end, + if + not RetreiveFeature -> + %% Item Retrieval Not Supported + {error, extended_error(?ERR_FEATURE_NOT_IMPLEMENTED, unsupported, "retrieve-items")}; + not PersistentFeature -> + %% Persistent Items Not Supported + {error, extended_error(?ERR_FEATURE_NOT_IMPLEMENTED, unsupported, "persistent-items")}; + true -> + node_call(Type, get_items, + [Host, Node, From, + AccessModel, PresenceSubscription, RosterGroup, + SubId]) + end + end, + case transaction(Host, Node, Action, sync_dirty) of + {error, Reason} -> + {error, Reason}; + {result, Items} -> + SendItems = case ItemIDs of + [] -> + Items; + _ -> + lists:filter(fun(Item) -> + lists:member(Item, ItemIDs) + end, Items) + end, %% Generate the XML response (Item list), limiting the %% number of items sent to MaxItems: ItemsEls = lists:map( - fun(#pubsub_item{itemid = {ItemId, _}, - payload = Payload}) -> - ItemAttrs = case ItemId of - "" -> []; - _ -> [{"id", ItemId}] - end, - {xmlelement, "item", ItemAttrs, Payload} - end, lists:sublist(Items, MaxItems)), + fun(#pubsub_item{itemid = {ItemId, _}, + payload = Payload}) -> + ItemAttrs = case ItemId of + "" -> []; + _ -> [{"id", ItemId}] + end, + {xmlelement, "item", ItemAttrs, Payload} + end, lists:sublist(SendItems, MaxItems)), {result, [{xmlelement, "pubsub", [{"xmlns", ?NS_PUBSUB}], - [{xmlelement, "items", [{"node", node_to_string(Node)}], - ItemsEls}]}]} + [{xmlelement, "items", [{"node", node_to_string(Node)}], + ItemsEls}]}]} end end. @@ -1809,7 +1856,7 @@ set_affiliations(Host, Node, From, EntitiesEls) -> end, Entities), {result, []}; _ -> - {error, ?ERR_NOT_ALLOWED} + {error, ?ERR_FORBIDDEN} end end, transaction(Host, Node, Action, sync_dirty) @@ -1870,7 +1917,7 @@ get_subscriptions(Host, Node, JID) -> %% Service does not support manage subscriptions {error, extended_error(?ERR_FEATURE_NOT_IMPLEMENTED, unsupported, "manage-affiliations")}; Affiliation /= {result, owner} -> - % Entity is not an owner + %% Entity is not an owner {error, ?ERR_FORBIDDEN}; true -> node_call(Type, get_node_subscriptions, [Host, Node]) @@ -1938,7 +1985,7 @@ set_subscriptions(Host, Node, From, EntitiesEls) -> end, Entities), {result, []}; _ -> - {error, ?ERR_NOT_ALLOWED} + {error, ?ERR_FORBIDDEN} end end, transaction(Host, Node, Action, sync_dirty) @@ -2352,7 +2399,10 @@ get_configure(Host, Node, From, Lang) -> transaction(Host, Node, Action, sync_dirty). get_default(Host, _Node, _From, Lang) -> - Type = hd(plugins(Host)), % first configured plugin is default + Type = case Host of + {_, _, _} -> ?PEPNODE; + _ -> hd(plugins(Host)) + end, Options = node_options(Type), {result, [{xmlelement, "pubsub", [{"xmlns", ?NS_PUBSUB_OWNER}], [{xmlelement, "default", [], @@ -2435,6 +2485,7 @@ get_configure_xfields(_Type, Options, Lang, _Owners) -> ?BOOL_CONFIG_FIELD("Notify subscribers when the node is deleted", notify_delete), ?BOOL_CONFIG_FIELD("Notify subscribers when items are removed from the node", notify_retract), ?BOOL_CONFIG_FIELD("Persist items to storage", persist_items), + ?STRING_CONFIG_FIELD("A friendly name for the node", title), ?INTEGER_CONFIG_FIELD("Max # of items to persist", max_items), ?BOOL_CONFIG_FIELD("Whether to allow subscriptions", subscribe), ?ALIST_CONFIG_FIELD("Specify the access model", access_model, @@ -2551,7 +2602,7 @@ set_xoption([], NewOpts) -> NewOpts; set_xoption([{"FORM_TYPE", _} | Opts], NewOpts) -> set_xoption(Opts, NewOpts); -set_xoption([{"pubsub#roster_groups_allowed", Value} | Opts], NewOpts) -> +set_xoption([{"pubsub#roster_groups_allowed", _Value} | Opts], NewOpts) -> ?SET_LIST_XOPT(roster_groups_allowed, []); % XXX: waiting for EJAB-659 to be solved set_xoption([{"pubsub#deliver_payloads", [Val]} | Opts], NewOpts) -> ?SET_BOOL_XOPT(deliver_payloads, Val); @@ -2602,7 +2653,7 @@ features() -> [ %"access-authorize", % OPTIONAL "access-open", % OPTIONAL this relates to access_model option in node_default - %"access-presence", % OPTIONAL + "access-presence", % OPTIONAL this relates to access_model option in node_pep %"access-roster", % OPTIONAL %"access-whitelist", % OPTIONAL % see plugin "auto-create", % OPTIONAL @@ -2616,7 +2667,7 @@ features() -> % see plugin "filtered-notifications", % RECOMMENDED %TODO "get-pending", % OPTIONAL % see plugin "instant-nodes", % RECOMMENDED - %TODO "item-ids", % RECOMMENDED + "item-ids", % RECOMMENDED "last-published", % RECOMMENDED %TODO "cache-last-item", %TODO "leased-subscription", % OPTIONAL diff --git a/src/mod_pubsub/node.template b/src/mod_pubsub/node.template index 850a38ec9..973aa38a4 100644 --- a/src/mod_pubsub/node.template +++ b/src/mod_pubsub/node.template @@ -61,7 +61,9 @@ get_states/2, get_state/3, set_state/1, + get_items/7, get_items/2, + get_item/8, get_item/3, set_item/1 ]). @@ -94,7 +96,6 @@ features() -> ["create-nodes", "delete-nodes", "instant-nodes", - "item-ids", "outcast-affiliation", "persistent-items", "publish", @@ -170,8 +171,14 @@ set_state(State) -> get_items(Host, Node) -> node_default:get_items(Host, Node). +get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) + node_default:get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + get_item(Host, Node, ItemId) -> node_default:get_item(Host, Node, ItemId). +get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + set_item(Item) -> node_default:set_item(Item). diff --git a/src/mod_pubsub/node_buddy.erl b/src/mod_pubsub/node_buddy.erl index cdf3a696f..cd051b66f 100644 --- a/src/mod_pubsub/node_buddy.erl +++ b/src/mod_pubsub/node_buddy.erl @@ -62,7 +62,9 @@ get_states/2, get_state/3, set_state/1, + get_items/7, get_items/2, + get_item/8, get_item/3, set_item/1, get_item_name/3 @@ -172,9 +174,15 @@ set_state(State) -> get_items(Host, Node) -> node_default:get_items(Host, Node). +get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + get_item(Host, Node, ItemId) -> node_default:get_item(Host, Node, ItemId). +get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + set_item(Item) -> node_default:set_item(Item). diff --git a/src/mod_pubsub/node_club.erl b/src/mod_pubsub/node_club.erl index d927053fb..155edc10a 100644 --- a/src/mod_pubsub/node_club.erl +++ b/src/mod_pubsub/node_club.erl @@ -62,7 +62,9 @@ get_states/2, get_state/3, set_state/1, + get_items/7, get_items/2, + get_item/8, get_item/3, set_item/1, get_item_name/3 @@ -96,7 +98,6 @@ features() -> ["create-nodes", "delete-nodes", "instant-nodes", - "item-ids", "outcast-affiliation", "persistent-items", "publish", @@ -172,9 +173,15 @@ set_state(State) -> get_items(Host, Node) -> node_default:get_items(Host, Node). +get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + get_item(Host, Node, ItemId) -> node_default:get_item(Host, Node, ItemId). +get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + set_item(Item) -> node_default:set_item(Item). diff --git a/src/mod_pubsub/node_default.erl b/src/mod_pubsub/node_default.erl index fc4194c32..491676269 100644 --- a/src/mod_pubsub/node_default.erl +++ b/src/mod_pubsub/node_default.erl @@ -69,7 +69,9 @@ get_states/2, get_state/3, set_state/1, + get_items/7, get_items/2, + get_item/8, get_item/3, set_item/1, get_item_name/3 @@ -158,7 +160,6 @@ features() -> "auto-create", "delete-nodes", "instant-nodes", - "item-ids", "manage-subscriptions", "modify-affiliations", "outcast-affiliation", @@ -192,18 +193,14 @@ features() -> %% module by implementing this function like this: %% ```check_create_user_permission(Host, Node, Owner, Access) -> %% node_default:check_create_user_permission(Host, Node, Owner, Access).'''

      -create_node_permission(Host, ServerHost, Node, _ParentNode, Owner, Access) -> +create_node_permission(_Host, ServerHost, Node, _ParentNode, Owner, Access) -> LOwner = jlib:jid_tolower(Owner), {User, Server, _Resource} = LOwner, Allowed = case acl:match_rule(ServerHost, Access, LOwner) of allow -> - if Server == Host -> %% Server == ServerHost ?? - true; - true -> - case Node of - ["home", Server, User | _] -> true; - _ -> false - end + case Node of + ["home", Server, User | _] -> true; + _ -> false end; _ -> case Owner of @@ -211,8 +208,7 @@ create_node_permission(Host, ServerHost, Node, _ParentNode, Owner, Access) -> _ -> false end end, - ChildOK = true, %% TODO test with ParentNode - {result, Allowed and ChildOK}. + {result, Allowed}. %% @spec (Host, Node, Owner) -> %% {result, Result} | exit @@ -297,12 +293,12 @@ subscribe_node(Host, Node, Sender, Subscriber, AccessModel, not Authorized -> %% JIDs do not match {error, ?ERR_EXTENDED(?ERR_BAD_REQUEST, "invalid-jid")}; - Subscription == pending -> - %% Requesting entity has pending subscription - {error, ?ERR_EXTENDED(?ERR_NOT_AUTHORIZED, "pending-subscription")}; Affiliation == outcast -> %% Requesting entity is blocked {error, ?ERR_FORBIDDEN}; + Subscription == pending -> + %% Requesting entity has pending subscription + {error, ?ERR_EXTENDED(?ERR_NOT_AUTHORIZED, "pending-subscription")}; (AccessModel == presence) and (not PresenceSubscription) -> %% Entity is not authorized to create a subscription (presence subscription required) {error, ?ERR_EXTENDED(?ERR_NOT_AUTHORIZED, "presence-subscription-required")}; @@ -446,6 +442,7 @@ publish_item(Host, Node, Publisher, PublishModel, MaxItems, ItemId, Payload) -> {error, ?ERR_FORBIDDEN}; true -> PubId = {PublisherKey, now()}, + %% TODO: check creation, presence, roster (EJAB-663) Item = case get_item(Host, Node, ItemId) of {error, ?ERR_ITEM_NOT_FOUND} -> #pubsub_item{itemid = {ItemId, {Host, Node}}, @@ -501,7 +498,7 @@ remove_extra_items(Host, Node, MaxItems, ItemIds) -> %% ItemId = string() %% @doc

      Triggers item deletion.

      %%

      Default plugin: The user performing the deletion must be the node owner -%% or a node publisher e item publisher.

      +%% or a publisher.

      delete_item(Host, Node, Publisher, ItemId) -> PublisherKey = jlib:jid_tolower(jlib:jid_remove_resource(Publisher)), State = case get_state(Host, Node, PublisherKey) of @@ -542,17 +539,16 @@ delete_item(Host, Node, Publisher, ItemId) -> purge_node(Host, Node, Owner) -> OwnerKey = jlib:jid_tolower(jlib:jid_remove_resource(Owner)), case get_state(Host, Node, OwnerKey) of - {error, ?ERR_ITEM_NOT_FOUND} -> - %% This should not append (case node does not exists) - {error, ?ERR_ITEM_NOT_FOUND}; {result, #pubsub_state{items = Items, affiliation = owner}} -> lists:foreach(fun(ItemId) -> mnesia:delete({pubsub_item, {ItemId, {Host, Node}}}) end, Items), {result, {default, broadcast}}; + {result, _} -> + %% Entity is not owner + {error, ?ERR_FORBIDDEN}; _ -> - %% Entity is not an owner - {error, ?ERR_FORBIDDEN} + {error, ?ERR_ITEM_NOT_FOUND} end. %% @spec (Host, JID) -> [{Node,Affiliation}] @@ -588,7 +584,7 @@ get_affiliation(Host, Node, Owner) -> OwnerKey = jlib:jid_tolower(jlib:jid_remove_resource(Owner)), Affiliation = case get_state(Host, Node, OwnerKey) of {result, #pubsub_state{affiliation = A}} -> A; - _ -> unknown + _ -> none end, {result, Affiliation}. @@ -638,7 +634,7 @@ get_subscription(Host, Node, Owner) -> OwnerKey = jlib:jid_tolower(jlib:jid_remove_resource(Owner)), Subscription = case get_state(Host, Node, OwnerKey) of {result, #pubsub_state{subscription = S}} -> S; - _ -> unknown + _ -> none end, {result, Subscription}. @@ -713,6 +709,44 @@ get_items(Host, Node) -> Items = mnesia:match_object( #pubsub_item{itemid = {'_', {Host, Node}}, _ = '_'}), {result, Items}. +get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) -> + {Affiliation, Subscription} = + case get_state(Host, Node, jlib:jid_tolower(jlib:jid_remove_resource(JID))) of + {result, #pubsub_state{affiliation = A, subscription = S}} -> {A, S}; + _ -> {none, none} + end, + Subscribed = not ((Subscription == none) or (Subscription == pending)), + if + %%SubID == "", ?? -> + %% Entity has multiple subscriptions to the node but does not specify a subscription ID + %{error, ?ERR_EXTENDED(?ERR_BAD_REQUEST, "subid-required")}; + %%InvalidSubID -> + %% Entity is subscribed but specifies an invalid subscription ID + %{error, ?ERR_EXTENDED(?ERR_NOT_ACCEPTABLE, "invalid-subid")}; + Affiliation == outcast -> + %% Requesting entity is blocked + {error, ?ERR_FORBIDDEN}; + (AccessModel == open) and (not Subscribed) -> + %% Entity is not subscribed + {error, ?ERR_EXTENDED(?ERR_NOT_AUTHORIZED, "not-subscribed")}; + (AccessModel == presence) and (not PresenceSubscription) -> + %% Entity is not authorized to create a subscription (presence subscription required) + {error, ?ERR_EXTENDED(?ERR_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(?ERR_NOT_AUTHORIZED, "not-in-roster-group")}; + (AccessModel == whitelist) -> % TODO: to be done + %% Node has whitelist access model + {error, ?ERR_EXTENDED(?ERR_NOT_ALLOWED, "closed-node")}; + (AccessModel == authorize) -> % TODO: to be done + %% Node has authorize access model + {error, ?ERR_FORBIDDEN}; + %%MustPay -> + %% % Payment is required for a subscription + %% {error, ?ERR_PAYMENT_REQUIRED}; + true -> + get_items(Host, Node) + end. %% @spec (Host, Node, ItemId) -> [Item] | [] %% Host = mod_pubsub:host() @@ -727,6 +761,44 @@ get_item(Host, Node, ItemId) -> _ -> {error, ?ERR_ITEM_NOT_FOUND} end. +get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) -> + {Affiliation, Subscription} = + case get_state(Host, Node, jlib:jid_tolower(jlib:jid_remove_resource(JID))) of + {result, #pubsub_state{affiliation = A, subscription = S}} -> {A, S}; + _ -> {none, none} + end, + Subscribed = not ((Subscription == none) or (Subscription == pending)), + if + %%SubID == "", ?? -> + %% Entity has multiple subscriptions to the node but does not specify a subscription ID + %{error, ?ERR_EXTENDED(?ERR_BAD_REQUEST, "subid-required")}; + %%InvalidSubID -> + %% Entity is subscribed but specifies an invalid subscription ID + %{error, ?ERR_EXTENDED(?ERR_NOT_ACCEPTABLE, "invalid-subid")}; + Affiliation == outcast -> + %% Requesting entity is blocked + {error, ?ERR_FORBIDDEN}; + (AccessModel == open) and (not Subscribed) -> + %% Entity is not subscribed + {error, ?ERR_EXTENDED(?ERR_NOT_AUTHORIZED, "not-subscribed")}; + (AccessModel == presence) and (not PresenceSubscription) -> + %% Entity is not authorized to create a subscription (presence subscription required) + {error, ?ERR_EXTENDED(?ERR_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(?ERR_NOT_AUTHORIZED, "not-in-roster-group")}; + (AccessModel == whitelist) -> % TODO: to be done + %% Node has whitelist access model + {error, ?ERR_EXTENDED(?ERR_NOT_ALLOWED, "closed-node")}; + (AccessModel == authorize) -> % TODO: to be done + %% Node has authorize access model + {error, ?ERR_FORBIDDEN}; + %%MustPay -> + %% % Payment is required for a subscription + %% {error, ?ERR_PAYMENT_REQUIRED}; + true -> + get_item(Host, Node, ItemId) + end. %% @spec (Item) -> ok | {error, Reason::stanzaError()} %% Item = mod_pubsub:pubsubItems() diff --git a/src/mod_pubsub/node_dispatch.erl b/src/mod_pubsub/node_dispatch.erl index 3b4418c3e..0532826d2 100644 --- a/src/mod_pubsub/node_dispatch.erl +++ b/src/mod_pubsub/node_dispatch.erl @@ -60,7 +60,9 @@ get_states/2, get_state/3, set_state/1, + get_items/7, get_items/2, + get_item/8, get_item/3, set_item/1, get_item_name/3 @@ -94,7 +96,6 @@ features() -> ["create-nodes", "delete-nodes", "instant-nodes", - "item-ids", "outcast-affiliation", "persistent-items", "publish", @@ -175,9 +176,15 @@ set_state(State) -> get_items(Host, Node) -> node_default:get_items(Host, Node). +get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + get_item(Host, Node, ItemId) -> node_default:get_item(Host, Node, ItemId). +get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + set_item(Item) -> node_default:set_item(Item). diff --git a/src/mod_pubsub/node_pep.erl b/src/mod_pubsub/node_pep.erl index 97bf1b2fa..2c648148d 100644 --- a/src/mod_pubsub/node_pep.erl +++ b/src/mod_pubsub/node_pep.erl @@ -29,6 +29,7 @@ -module(node_pep). -author('christophe.romain@process-one.net'). +-include("ejabberd.hrl"). -include("pubsub.hrl"). -include("jlib.hrl"). @@ -57,7 +58,9 @@ get_states/2, get_state/3, set_state/1, + get_items/7, get_items/2, + get_item/8, get_item/3, set_item/1, get_item_name/3 @@ -65,6 +68,7 @@ init(Host, ServerHost, Opts) -> node_default:init(Host, ServerHost, Opts), + complain_if_modcaps_disabled(ServerHost), ok. terminate(Host, ServerHost) -> @@ -94,7 +98,6 @@ features() -> "auto-subscribe", %* "delete-nodes", %* "filtered-notifications", %* - "item-ids", "modify-affiliations", "outcast-affiliation", "persistent-items", @@ -183,7 +186,7 @@ get_node_subscriptions(_Host, _Node) -> {result, []}. get_subscription(_Host, _Node, _Owner) -> - {result, unknown}. + {result, none}. set_subscription(_Host, _Node, _Owner, _Subscription) -> ok. @@ -200,11 +203,39 @@ set_state(State) -> get_items(Host, Node) -> node_default:get_items(Host, Node). +get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + get_item(Host, Node, ItemId) -> node_default:get_item(Host, Node, ItemId). +get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + set_item(Item) -> node_default:set_item(Item). get_item_name(Host, Node, Id) -> node_default:get_item_name(Host, Node, Id). + + +%%% +%%% Internal +%%% + +%% @doc Check mod_caps is enabled, otherwise show warning. +%% 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. +complain_if_modcaps_disabled(ServerHost) -> + Modules = ejabberd_config:get_local_option({modules, ServerHost}), + ModCaps = [mod_caps_enabled || {mod_caps, _Opts} <- Modules], + case ModCaps of + [] -> + ?WARNING_MSG("The PEP plugin is enabled in mod_pubsub of host ~p. " + "This plugin requires mod_caps to be enabled, " + "but it isn't.", [ServerHost]); + _ -> + ok + end. + diff --git a/src/mod_pubsub/node_private.erl b/src/mod_pubsub/node_private.erl index 35f63c925..00e952392 100644 --- a/src/mod_pubsub/node_private.erl +++ b/src/mod_pubsub/node_private.erl @@ -62,7 +62,9 @@ get_states/2, get_state/3, set_state/1, + get_items/7, get_items/2, + get_item/8, get_item/3, set_item/1, get_item_name/3 @@ -96,7 +98,6 @@ features() -> ["create-nodes", "delete-nodes", "instant-nodes", - "item-ids", "outcast-affiliation", "persistent-items", "publish", @@ -175,9 +176,15 @@ set_state(State) -> get_items(Host, Node) -> node_default:get_items(Host, Node). +get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + get_item(Host, Node, ItemId) -> node_default:get_item(Host, Node, ItemId). +get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + set_item(Item) -> node_default:set_item(Item). diff --git a/src/mod_pubsub/node_public.erl b/src/mod_pubsub/node_public.erl index 1586abe86..ab4107a76 100644 --- a/src/mod_pubsub/node_public.erl +++ b/src/mod_pubsub/node_public.erl @@ -62,7 +62,9 @@ get_states/2, get_state/3, set_state/1, + get_items/7, get_items/2, + get_item/8, get_item/3, set_item/1, get_item_name/3 @@ -96,7 +98,6 @@ features() -> ["create-nodes", "delete-nodes", "instant-nodes", - "item-ids", "outcast-affiliation", "persistent-items", "publish", @@ -172,9 +173,15 @@ set_state(State) -> get_items(Host, Node) -> node_default:get_items(Host, Node). +get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + get_item(Host, Node, ItemId) -> node_default:get_item(Host, Node, ItemId). +get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + set_item(Item) -> node_default:set_item(Item). diff --git a/src/mod_pubsub/node_zoo.erl b/src/mod_pubsub/node_zoo.erl new file mode 100644 index 000000000..45e601ed7 --- /dev/null +++ b/src/mod_pubsub/node_zoo.erl @@ -0,0 +1,181 @@ +%%% ==================================================================== +%%% ``The contents of this file are subject to the Erlang Public License, +%%% Version 1.1, (the "License"); you may not use this file except in +%%% compliance with the License. You should have received a copy of the +%%% Erlang Public License along with this software. If not, it can be +%%% retrieved via the world wide web at http://www.erlang.org/. +%%% +%%% Software distributed under the License is distributed on an "AS IS" +%%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +%%% the License for the specific language governing rights and limitations +%%% under the License. +%%% +%%% The Initial Developer of the Original Code is Process-one. +%%% Portions created by Process-one are Copyright 2006-2008, Process-one +%%% All Rights Reserved.'' +%%% This software is copyright 2006-2008, Process-one. +%%% +%%% @copyright 2006-2008 Process-one +%%% @author Christophe romain +%%% [http://www.process-one.net/] +%%% @version {@vsn}, {@date} {@time} +%%% @end +%%% ==================================================================== + +-module(node_zoo). +-author('christophe.romain@process-one.net'). + +-include("pubsub.hrl"). +-include("jlib.hrl"). + +-behaviour(gen_pubsub_node). + +%% API definition +-export([init/3, terminate/2, + options/0, features/0, + create_node_permission/6, + create_node/3, + delete_node/2, + purge_node/3, + subscribe_node/8, + unsubscribe_node/5, + publish_item/7, + delete_item/4, + remove_extra_items/4, + get_entity_affiliations/2, + get_node_affiliations/2, + get_affiliation/3, + set_affiliation/4, + get_entity_subscriptions/2, + get_node_subscriptions/2, + get_subscription/3, + set_subscription/4, + get_states/2, + get_state/3, + set_state/1, + get_items/7, + get_items/2, + get_item/8, + get_item/3, + set_item/1, + get_item_name/3 + ]). + + +init(Host, ServerHost, Opts) -> + node_default:init(Host, ServerHost, Opts). + +terminate(Host, ServerHost) -> + node_default:terminate(Host, ServerHost). + +options() -> + [{node_type, zoo}, + {deliver_payloads, true}, + {notify_config, false}, + {notify_delete, false}, + {notify_retract, true}, + {persist_items, true}, + {max_items, ?MAXITEMS div 2}, + {subscribe, true}, + {access_model, open}, + {roster_groups_allowed, []}, + {publish_model, publishers}, + {max_payload_size, ?MAX_PAYLOAD_SIZE}, + {send_last_published_item, never}, + {deliver_notifications, true}, + {presence_based_delivery, false}]. + +features() -> + node_default:features(). + +%% use same code as node_default, 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:jid_tolower(Owner), + %%{_User, _Server, _Resource} = LOwner, + Allowed = case acl:match_rule(ServerHost, Access, LOwner) of + allow -> + true; + _ -> + case Owner of + {jid, "", _, "", "", _, ""} -> true; + _ -> false + end + end, + {result, Allowed}. + +create_node(Host, Node, Owner) -> + node_default:create_node(Host, Node, Owner). + +delete_node(Host, Removed) -> + node_default:delete_node(Host, Removed). + +subscribe_node(Host, Node, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup) -> + node_default:subscribe_node(Host, Node, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup). + +unsubscribe_node(Host, Node, Sender, Subscriber, SubID) -> + node_default:unsubscribe_node(Host, Node, Sender, Subscriber, SubID). + +publish_item(Host, Node, Publisher, Model, MaxItems, ItemId, Payload) -> + node_default:publish_item(Host, Node, Publisher, Model, MaxItems, ItemId, Payload). + +remove_extra_items(Host, Node, MaxItems, ItemIds) -> + node_default:remove_extra_items(Host, Node, MaxItems, ItemIds). + +delete_item(Host, Node, JID, ItemId) -> + node_default:delete_item(Host, Node, JID, ItemId). + +purge_node(Host, Node, Owner) -> + node_default:purge_node(Host, Node, Owner). + +get_entity_affiliations(Host, Owner) -> + node_default:get_entity_affiliations(Host, Owner). + +get_node_affiliations(Host, Node) -> + node_default:get_node_affiliations(Host, Node). + +get_affiliation(Host, Node, Owner) -> + node_default:get_affiliation(Host, Node, Owner). + +set_affiliation(Host, Node, Owner, Affiliation) -> + node_default:set_affiliation(Host, Node, Owner, Affiliation). + +get_entity_subscriptions(Host, Owner) -> + node_default:get_entity_subscriptions(Host, Owner). + +get_node_subscriptions(Host, Node) -> + node_default:get_node_subscriptions(Host, Node). + +get_subscription(Host, Node, Owner) -> + node_default:get_subscription(Host, Node, Owner). + +set_subscription(Host, Node, Owner, Subscription) -> + node_default:set_subscription(Host, Node, Owner, Subscription). + +get_states(Host, Node) -> + node_default:get_states(Host, Node). + +get_state(Host, Node, JID) -> + node_default:get_state(Host, Node, JID). + +set_state(State) -> + node_default:set_state(State). + +get_items(Host, Node) -> + node_default:get_items(Host, Node). + +get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_items(Host, Node, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + +get_item(Host, Node, ItemId) -> + node_default:get_item(Host, Node, ItemId). + +get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_default:get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + +set_item(Item) -> + node_default:set_item(Item). + +get_item_name(Host, Node, Id) -> + node_default:get_item_name(Host, Node, Id). diff --git a/src/mod_register.erl b/src/mod_register.erl index a936ea5e1..21080c8a2 100644 --- a/src/mod_register.erl +++ b/src/mod_register.erl @@ -241,12 +241,13 @@ send_welcome_message(JID) -> {"", ""} -> ok; {Subj, Body} -> + BodyFormatted = io_lib:format(Body, []), ejabberd_router:route( jlib:make_jid("", Host, ""), JID, {xmlelement, "message", [{"type", "normal"}], [{xmlelement, "subject", [], [{xmlcdata, Subj}]}, - {xmlelement, "body", [], [{xmlcdata, Body}]}]}); + {xmlelement, "body", [], [{xmlcdata, BodyFormatted}]}]}); _ -> ok end. diff --git a/src/mod_roster.erl b/src/mod_roster.erl index f1f59665a..038de586a 100644 --- a/src/mod_roster.erl +++ b/src/mod_roster.erl @@ -40,6 +40,7 @@ set_items/3, remove_user/2, get_jid_info/4, + item_to_xml/1, webadmin_page/3, webadmin_user/4]). diff --git a/src/mod_shared_roster.erl b/src/mod_shared_roster.erl index 7b8558cf5..ff378010d 100644 --- a/src/mod_shared_roster.erl +++ b/src/mod_shared_roster.erl @@ -155,12 +155,12 @@ get_user_roster(Items, US) -> {{U1, S1}, GroupNames} <- dict:to_list(SRUsersRest)], SRItems ++ NewItems1. -%% This function in use to rewrite the roster entries when moving or renaming +%% This function rewrites the roster entries when moving or renaming %% them in the user contact list. process_item(RosterItem, Host) -> - USFrom = RosterItem#roster.us, - {User,Server,_Resource} = RosterItem#roster.jid, - USTo = {User,Server}, + USFrom = {UserFrom, ServerFrom} = RosterItem#roster.us, + {UserTo, ServerTo, ResourceTo} = RosterItem#roster.jid, + USTo = {UserTo, ServerTo}, DisplayedGroups = get_user_displayed_groups(USFrom), CommonGroups = lists:filter(fun(Group) -> is_user_in_group(USTo, Group, Host) @@ -174,9 +174,83 @@ process_item(RosterItem, Host) -> end, CommonGroups), RosterItem#roster{subscription = both, ask = none, groups=[GroupNames]}; - _ -> RosterItem#roster{subscription = both, ask = none} + %% Both users have at least a common shared group, + %% So each user can see the other + _ -> + %% Check if the list of groups of the new roster item + %% include at least a new one + case lists:subtract(RosterItem#roster.groups, CommonGroups) of + [] -> + RosterItem#roster{subscription = both, ask = none}; + %% If so, it means the user wants to add that contact + %% to his personal roster + PersonalGroups -> + %% Store roster items in From and To rosters + set_new_rosteritems(UserFrom, ServerFrom, + UserTo, ServerTo, ResourceTo, + PersonalGroups) + end end. +build_roster_record(User1, Server1, User2, Server2, Groups) -> + USR2 = {User2, Server2, ""}, + #roster{usj = {User1, Server1, USR2}, + us = {User1, Server1}, + jid = USR2, + name = User2, + subscription = both, + ask = none, + groups = Groups + }. + +set_new_rosteritems(UserFrom, ServerFrom, + UserTo, ServerTo, ResourceTo, GroupsFrom) -> + Mod = case lists:member(mod_roster_odbc, + gen_mod:loaded_modules(ServerFrom)) of + true -> mod_roster_odbc; + false -> mod_roster + end, + + RIFrom = build_roster_record(UserFrom, ServerFrom, + UserTo, ServerTo, GroupsFrom), + set_item(UserFrom, ServerFrom, ResourceTo, RIFrom), + JIDTo = jlib:make_jid(UserTo, ServerTo, ""), + + JIDFrom = jlib:make_jid(UserFrom, ServerFrom, ""), + RITo = build_roster_record(UserTo, ServerTo, + UserFrom, ServerFrom, []), + set_item(UserTo, ServerTo, "", RITo), + + %% From requests + Mod:out_subscription(UserFrom, ServerFrom, JIDTo, subscribe), + Mod:in_subscription(aaa, UserTo, ServerTo, JIDFrom, subscribe, ""), + + %% To accepts + Mod:out_subscription(UserTo, ServerTo, JIDFrom, subscribed), + Mod:in_subscription(aaa, UserFrom, ServerFrom, JIDTo, subscribed, ""), + + %% To requests + Mod:out_subscription(UserTo, ServerTo, JIDFrom, subscribe), + Mod:in_subscription(aaa, UserFrom, ServerFrom, JIDTo, subscribe, ""), + + %% From accepts + Mod:out_subscription(UserFrom, ServerFrom, JIDTo, subscribed), + Mod:in_subscription(aaa, UserTo, ServerTo, JIDFrom, subscribed, ""), + + RIFrom. + +set_item(User, Server, Resource, Item) -> + ResIQ = #iq{type = set, xmlns = ?NS_ROSTER, + id = "push", + sub_el = [{xmlelement, "query", + [{"xmlns", ?NS_ROSTER}], + [mod_roster:item_to_xml(Item)]}]}, + ejabberd_router:route( + jlib:make_jid(User, Server, Resource), + jlib:make_jid("", Server, ""), + jlib:iq_to_xml(ResIQ)). + + get_subscription_lists({F, T}, User, Server) -> LUser = jlib:nodeprep(User), LServer = jlib:nameprep(Server), @@ -414,10 +488,10 @@ get_user_displayed_groups(US) -> end, get_user_groups(US))), [Group || Group <- DisplayedGroups1, is_group_enabled(Host, Group)]. -is_user_in_group(US, Group, Host) -> +is_user_in_group({_U, S} = US, Group, Host) -> case catch mnesia:dirty_match_object( #sr_user{us=US, group_host={Group, Host}}) of - [] -> false; + [] -> lists:member(US, get_group_users(S, Group)); _ -> true end. diff --git a/src/web/ejabberd_http.erl b/src/web/ejabberd_http.erl index a53910803..34eeef739 100644 --- a/src/web/ejabberd_http.erl +++ b/src/web/ejabberd_http.erl @@ -271,13 +271,14 @@ process(Handlers, Request) -> process(HandlersLeft, Request) end. -process_request(#state{request_method = 'GET', +process_request(#state{request_method = Method, request_path = {abs_path, Path}, request_auth = Auth, request_lang = Lang, request_handlers = RequestHandlers, sockmod = SockMod, - socket = Socket} = State) -> + socket = Socket} = State) + when Method=:='GET' orelse Method=:='HEAD' orelse Method=:='DELETE' -> case (catch url_decode_q_split(Path)) of {'EXIT', _} -> process_request(false); @@ -289,19 +290,19 @@ process_request(#state{request_method = 'GET', LQ end, LPath = string:tokens(NPath, "/"), - {ok, {IP, _Port}} = + {ok, IP} = case SockMod of gen_tcp -> inet:peername(Socket); _ -> SockMod:peername(Socket) end, - Request = #request{method = 'GET', + Request = #request{method = Method, path = LPath, q = LQuery, auth = Auth, lang = Lang, - ip=IP}, + ip = IP}, %% XXX bard: This previously passed control to %% ejabberd_web:process_get, now passes it to a local %% procedure (process) that handles dispatching based on @@ -319,7 +320,7 @@ process_request(#state{request_method = 'GET', end end; -process_request(#state{request_method = 'POST', +process_request(#state{request_method = Method, request_path = {abs_path, Path}, request_auth = Auth, request_content_length = Len, @@ -327,7 +328,7 @@ process_request(#state{request_method = 'POST', sockmod = SockMod, socket = Socket, request_handlers = RequestHandlers} = State) - when is_integer(Len) -> + when (Method=:='POST' orelse Method=:='PUT') andalso is_integer(Len) -> case SockMod of gen_tcp -> inet:setopts(Socket, [{packet, 0}]); @@ -347,12 +348,20 @@ process_request(#state{request_method = 'POST', LQ -> LQ end, - Request = #request{method = 'POST', + {ok, IP} = + case SockMod of + gen_tcp -> + inet:peername(Socket); + _ -> + SockMod:peername(Socket) + end, + Request = #request{method = Method, path = LPath, q = LQuery, auth = Auth, data = Data, - lang = Lang}, + lang = Lang, + ip = IP}, case process(RequestHandlers, Request) of El when element(1, El) == xmlelement -> make_xhtml_output(State, 200, [], El); diff --git a/src/web/ejabberd_http_poll.erl b/src/web/ejabberd_http_poll.erl index f5b419275..ad6c46b77 100644 --- a/src/web/ejabberd_http_poll.erl +++ b/src/web/ejabberd_http_poll.erl @@ -50,13 +50,16 @@ -record(http_poll, {id, pid}). +-define(NULL_PEER, {{0, 0, 0, 0}, 0}). + -record(state, {id, key, output = "", input = "", waiting_input = false, %% {ReceiverPid, Tag} last_receiver, - timer}). + timer, + ip = ?NULL_PEER }). %-define(DBGFSM, true). @@ -94,11 +97,16 @@ setopts({http_poll, FsmRef}, Opts) -> ok end. -sockname(_Socket) -> - {ok, {{0, 0, 0, 0}, 0}}. +sockname(_) -> + {ok, ?NULL_PEER}. -peername(_Socket) -> - {ok, {{0, 0, 0, 0}, 0}}. +peername({http_poll, FsmRef}) -> + case catch gen_fsm:sync_send_all_state_event(FsmRef, peername, 1000) of + {ok, IP} -> {ok, IP}; + _ -> {ok, ?NULL_PEER} + end; +peername(_) -> + {ok, ?NULL_PEER}. controlling_process(_Socket, _Pid) -> ok. @@ -107,7 +115,7 @@ close({http_poll, FsmRef}) -> catch gen_fsm:sync_send_all_state_event(FsmRef, close). -process([], #request{data = Data} = _Request) -> +process([], #request{data = Data, ip = IP} = _Request) -> case catch parse_request(Data) of {ok, ID1, Key, NewKey, Packet} -> ID = if @@ -123,7 +131,7 @@ process([], #request{data = Data} = _Request) -> true -> ID1 end, - case http_put(ID, Key, NewKey, Packet) of + case http_put(ID, Key, NewKey, Packet, IP) of {error, not_exists} -> {200, ?BAD_REQUEST, ""}; {error, bad_key} -> @@ -249,7 +257,7 @@ handle_sync_event(stop, _From, _StateName, StateData) -> Reply = ok, {stop, normal, Reply, StateData}; -handle_sync_event({http_put, Key, NewKey, Packet}, +handle_sync_event({http_put, Key, NewKey, Packet, IP}, _From, StateName, StateData) -> Allow = case StateData#state.key of "" -> @@ -271,7 +279,8 @@ handle_sync_event({http_put, Key, NewKey, Packet}, Input = [StateData#state.input|Packet], Reply = ok, {reply, Reply, StateName, StateData#state{input = Input, - key = NewKey}}; + key = NewKey, + ip = IP}}; {Receiver, _Tag} -> Receiver ! {tcp, {http_poll, self()}, list_to_binary(Packet)}, @@ -282,7 +291,8 @@ handle_sync_event({http_put, Key, NewKey, Packet}, StateData#state{waiting_input = false, last_receiver = Receiver, key = NewKey, - timer = Timer}} + timer = Timer, + ip = IP}} end; true -> Reply = {error, bad_key}, @@ -293,6 +303,10 @@ handle_sync_event(http_get, _From, StateName, StateData) -> Reply = {ok, StateData#state.output}, {reply, Reply, StateName, StateData#state{output = ""}}; +handle_sync_event(peername, _From, StateName, StateData) -> + Reply = {ok, StateData#state.ip}, + {reply, Reply, StateName, StateData}; + handle_sync_event(_Event, _From, StateName, StateData) -> Reply = ok, {reply, Reply, StateName, StateData}. @@ -343,13 +357,13 @@ terminate(_Reason, _StateName, StateData) -> %%% Internal functions %%%---------------------------------------------------------------------- -http_put(ID, Key, NewKey, Packet) -> +http_put(ID, Key, NewKey, Packet, IP) -> case mnesia:dirty_read({http_poll, ID}) of [] -> {error, not_exists}; [#http_poll{pid = FsmRef}] -> gen_fsm:sync_send_all_state_event( - FsmRef, {http_put, Key, NewKey, Packet}) + FsmRef, {http_put, Key, NewKey, Packet, IP}) end. http_get(ID) -> diff --git a/src/web/ejabberd_web_admin.erl b/src/web/ejabberd_web_admin.erl index abc1ac871..d133fa14d 100644 --- a/src/web/ejabberd_web_admin.erl +++ b/src/web/ejabberd_web_admin.erl @@ -2022,7 +2022,7 @@ node_backup_parse_query(Node, Query) -> rpc:call(Node, mnesia, install_fallback, [Path]); "dump" -> - rpc:call(Node, mnesia, + rpc:call(Node, ejabberd_ctl, dump_to_textfile, [Path]); "load" -> rpc:call(Node, mnesia, diff --git a/tools/ejabberdctl b/tools/ejabberdctl index 9d3f7bd5a..c821e8081 100755 --- a/tools/ejabberdctl +++ b/tools/ejabberdctl @@ -4,7 +4,8 @@ NODE=ejabberd HOST=localhost # Define ejabberd environment -base="`dirname $(which "$0")`/.." +here=`which "$0" 2>/dev/null || echo .` +base="`dirname $here`/.." ROOTDIR=`(cd "$base"; echo $PWD)` SASL_LOG_PATH=$ROOTDIR/sasl.log EJABBERD_DB=$ROOTDIR/database/$NODE