Update ejabberd version number to 2.1.5

http://www.ejabberd.im/node/4120

README

@@ -0,0 +1,53 @@
+ejabberd - High-Performance Enterprise Instant Messaging Server 
+
+Quickstart guide
+
+
+0. Requirements
+
+To compile ejabberd you need:
+ - GNU Make
+ - GCC
+ - Libexpat 1.95 or higher
+ - Erlang/OTP R10B-9 or higher. Recommended versions: R12B-5 and R13B04
+ - OpenSSL 0.9.8 or higher, for STARTTLS, SASL and SSL encryption.
+ - Zlib 1.2.3 or higher, for Stream Compression support
+   (XEP-0138). Optional.
+ - Erlang mysql library. Optional. MySQL authentication/storage.
+ - Erlang pgsql library. Optional. PostgreSQL authentication/storage.
+ - PAM library. Optional. For Pluggable Authentication Modules (PAM).
+ - GNU Iconv 1.8 or higher, for the IRC Transport
+   (mod_irc). Optional. Not needed on systems with GNU Libc.
+ - ImageMagick's Convert program. Optional. For CAPTCHA challenges.
+ - exmpp 0.9.2 or higher. Optional. For import/export XEP-0227 files. 
+
+
+1. Compile and install on *nix systems
+
+To compile ejabberd, go to the directory src/ and execute the commands:
+  ./configure
+  make
+
+To install ejabberd, run this command with system administrator rights
+(root user):
+
+  sudo make install
+
+These commands will:
+ - Install the configuration files in /etc/ejabberd/
+ - Install ejabberd binary, header and runtime files in /lib/ejabberd/
+ - Install the administration script: /sbin/ejabberdctl
+ - Install ejabberd documentation in /share/doc/ejabberd/
+ - Create a spool directory: /var/lib/ejabberd/
+ - Create a directory for log files: /var/log/ejabberd/
+
+
+2. Start ejabberd
+
+You can use the ejabberdctl command line administration script to
+start and stop ejabberd. For example:
+  ejabberdctl start
+
+
+For detailed information please refer to the
+ejabberd Installation and Operation Guide

TODO

@@ -1,14 +0,0 @@
-Win32 build: Make it possible to compile with +debug_info flag.
-
-admin interface
-	users management
-		statistics about each user
-		statistics about each connection
-
-S2S:
-	check "id" attributes in db:verify packets
-
-make roster set to work in one transaction
-add traffic shapers to c2s connection before authentification
-more traffic shapers
-SNMP

contrib/ejabberd-modules.repo

@@ -0,0 +1,5 @@
+% List of ejabberd-modules to add for ejabberd packaging (source archive and installer)
+%
+% HTTP-binding:
+%https://svn.process-one.net/ejabberd-modules/http_bind/trunk
+%https://svn.process-one.net/ejabberd-modules/mod_http_fileserver/trunk

contrib/extract_translations/extract_translations.erl

@@ -20,9 +20,14 @@
 
 start() ->
     ets:new(translations, [named_table, public]),
+    ets:new(translations_obsolete, [named_table, public]),
     ets:new(files, [named_table, public]),
     ets:new(vars, [named_table, public]),
     case init:get_plain_arguments() of
+	["-srcmsg2po", Dir, File] ->
+	    print_po_header(File),
+	    Status = process(Dir, File, srcmsg2po),
+	    halt(Status);
 	["-unused", Dir, File] ->
 	    Status = process(Dir, File, unused),
 	    halt(Status);
@@ -49,8 +54,12 @@ process(Dir, File, Used) ->
 	    case Used of
 		unused ->
 		    ets:foldl(fun({Key, _}, _) ->
-				    io:format("~p~n", [Key])
-			      end, ok, translations); 
+				      io:format("~p~n", [Key])
+			      end, ok, translations);
+		srcmsg2po ->
+		    ets:foldl(fun({Key, Trans}, _) ->
+				      print_translation_obsolete(Key, Trans)
+			      end, ok, translations_obsolete);
 		_ ->
 		    ok
 	    end,
@@ -59,7 +68,7 @@ process(Dir, File, Used) ->
 
 parse_file(Dir, File, Used) ->
     ets:delete_all_objects(vars),
-    case epp:parse_file(File, [Dir, filename:dirname(File)], []) of
+    case epp:parse_file(File, [Dir, filename:dirname(File) | code:get_path()], []) of
 	{ok, Forms} ->
 	    lists:foreach(
 	      fun(F) ->
@@ -71,49 +80,57 @@ parse_file(Dir, File, Used) ->
 
 parse_form(Dir, File, Form, Used) ->
     case Form of
+	%%{undefined, Something} ->
+        %% io:format("Undefined: ~p~n", [Something]);
 	{call,
 	 _,
 	 {remote, _, {atom, _, translate}, {atom, _, translate}},
-	 [_, {string, _, Str}]
+	 [_, {string, Line, Str}]
 	} ->
-	    process_string(Dir, File, Str, Used);
+	    process_string(Dir, File, Line, Str, Used);
 	{call,
 	 _,
 	 {remote, _, {atom, _, translate}, {atom, _, translate}},
 	 [_, {var, _, Name}]
 	} ->
 	    case ets:lookup(vars, Name) of
-		[{_Name, Value}] ->
-		    process_string(Dir, File, Value, Used);
+		[{_Name, Value, Line}] ->
+		    process_string(Dir, File, Line, Value, Used);
 		_ ->
 		    ok
 	    end;
 	{match,
 	 _,
 	 {var, _, Name},
-	 {string, _, Value}
+	 {string, Line, Value}
 	} ->
-	    ets:insert(vars, {Name, Value});
+	    ets:insert(vars, {Name, Value, Line});
 	L when is_list(L) ->
 	    lists:foreach(
 	      fun(F) ->
-		    parse_form(Dir, File, F, Used)
+		      parse_form(Dir, File, F, Used)
 	      end, L);
 	T when is_tuple(T) ->
 	    lists:foreach(
 	      fun(F) ->
-		    parse_form(Dir, File, F, Used)
+		      parse_form(Dir, File, F, Used)
 	      end, tuple_to_list(T));
 	_ ->
 	    ok
     end.
 	    
-process_string(_Dir, File, Str, Used) ->
+process_string(_Dir, _File, _Line, "", _Used) ->
+    ok;
+
+process_string(_Dir, File, Line, Str, Used) ->
     case {ets:lookup(translations, Str), Used} of
 	{[{_Key, _Trans}], unused} ->
 	    ets:delete(translations, Str);
 	{[{_Key, _Trans}], used} ->
 	    ok;
+	{[{_Key, Trans}], srcmsg2po} ->
+	    ets:delete(translations_obsolete, Str),
+	    print_translation(File, Line, Str, Trans);
 	{_, used} ->
 	    case ets:lookup(files, File) of
 		[{_}] ->
@@ -122,8 +139,20 @@ process_string(_Dir, File, Str, Used) ->
 		    io:format("~n% ~s~n", [File]),
 		    ets:insert(files, {File})
 	    end,
-	    io:format("{~p, \"\"}.~n", [Str]),
+	    case Str of
+		[] -> ok;
+		_ -> io:format("{~p, \"\"}.~n", [Str])
+	    end,
 	    ets:insert(translations, {Str, ""});
+	{_, srcmsg2po} ->
+	    case ets:lookup(files, File) of
+		[{_}] ->
+		    ok;
+		_ ->
+		    ets:insert(files, {File})
+	    end,
+	    ets:insert(translations, {Str, ""}),
+	    print_translation(File, Line, Str, "");
 	_ ->
 	    ok
     end.
@@ -137,7 +166,8 @@ load_file(File) ->
 			"" ->
 			    ok;
 			_ ->
-			    ets:insert(translations, {Orig, Trans})
+			    ets:insert(translations, {Orig, Trans}),
+			    ets:insert(translations_obsolete, {Orig, Trans})
 		    end
 	      end, Terms);
 	Err ->
@@ -188,3 +218,77 @@ print_usage() ->
       "  extract_translations . ./msgs/ru.msg~n"
      ).
 
+
+%%%
+%%% Gettext
+%%%
+
+print_po_header(File) ->
+    MsgProps = get_msg_header_props(File),
+    {Language, [LastT | AddT]} = prepare_props(MsgProps),
+    application:load(ejabberd),
+    {ok, Version} = application:get_key(ejabberd, vsn),
+    print_po_header(Version, Language, LastT, AddT).
+
+get_msg_header_props(File) ->
+    {ok, F} = file:open(File, [read]),
+    Lines = get_msg_header_props(F, []),
+    file:close(F),
+    Lines.
+
+get_msg_header_props(F, Lines) ->
+    String = io:get_line(F, ""),
+    case io_lib:fread("% ", String) of
+	{ok, [], RemString} ->
+	    case io_lib:fread("~s", RemString) of
+		{ok, [Key], Value} when Value /= "\n" ->
+		    %% The first character in Value is a blankspace:
+		    %% And the last characters are 'slash n'
+		    ValueClean = string:substr(Value, 2, string:len(Value)-2),
+		    get_msg_header_props(F, Lines ++ [{Key, ValueClean}]);
+		_ ->
+		    get_msg_header_props(F, Lines)
+	    end;
+	_ ->
+	    Lines
+    end.
+
+prepare_props(MsgProps) ->
+    Language = proplists:get_value("Language:", MsgProps),
+    Authors = proplists:get_all_values("Author:", MsgProps),
+    {Language, Authors}.
+
+print_po_header(Version, Language, LastTranslator, AdditionalTranslatorsList) ->
+    AdditionalTranslatorsString = build_additional_translators(AdditionalTranslatorsList),
+    HeaderString =
+	"msgid \"\"\n"
+	"msgstr \"\"\n"
+	"\"Project-Id-Version: " ++ Version ++ "\\n\"\n"
+	++ "\"X-Language: " ++ Language ++ "\\n\"\n"
+	"\"Last-Translator: " ++ LastTranslator ++ "\\n\"\n"
+	++ AdditionalTranslatorsString ++
+	"\"MIME-Version: 1.0\\n\"\n"
+	"\"Content-Type: text/plain; charset=UTF-8\\n\"\n"
+	"\"Content-Transfer-Encoding: 8bit\\n\"\n",
+    io:format("~s~n", [HeaderString]).
+
+build_additional_translators(List) ->
+    lists:foldl(
+      fun(T, Str) ->
+	      Str ++ "\"X-Additional-Translator: " ++ T ++ "\\n\"\n"
+      end,
+      "",
+      List).
+
+print_translation(File, Line, Str, StrT) ->
+    {ok, StrQ, _} = regexp:gsub(Str, "\"", "\\\""),
+    {ok, StrTQ, _} = regexp:gsub(StrT, "\"", "\\\""),
+    io:format("#: ~s:~p~nmsgid \"~s\"~nmsgstr \"~s\"~n~n", [File, Line, StrQ, StrTQ]).
+
+print_translation_obsolete(Str, StrT) ->
+    File = "unknown.erl",
+    Line = 1,
+    {ok, StrQ, _} = regexp:gsub(Str, "\"", "\\\""),
+    {ok, StrTQ, _} = regexp:gsub(StrT, "\"", "\\\""),
+    io:format("#: ~s:~p~n#~~ msgid \"~s\"~n#~~ msgstr \"~s\"~n~n", [File, Line, StrQ, StrTQ]).
+

contrib/extract_translations/prepare-translation.sh

@@ -2,100 +2,362 @@
 
 # Frontend for ejabberd's extract_translations.erl
 # by Badlop
-# last updated: 8 December 2005
 
-while [ "$1" != "" ] 
-do
-    case "$1" in
-        -help)
-            echo "Options:"
-            echo "  -lang LANGUAGE"
-            echo "  -src FULL_PATH_EJABBERD"
-            echo ""
-            echo "Example:"
-            echo "  ./prepare-translation.sh -lang es -src /home/admin/ejabberd"
-            exit 0
-            ;;
-        -lang)
-            # This is the language to be extracted
-            LANGU=$2
-            shift
-            shift
-            ;;
-        -src)
-            # This is the path to the ejabberd source dir
-            EJA_DIR=$2
-            shift
-            shift
-            ;;
-        *)
-            echo "unknown option: '$1 $2'"
-            shift
-            shift
-            ;;
+# How to create template files for a new language:
+# NEWLANG=zh
+# cp msgs/ejabberd.pot msgs/$NEWLANG.po
+# echo \{\"\",\"\"\}. > msgs/$NEWLANG.msg
+# ../../extract_translations/prepare-translation.sh -updateall
+
+prepare_dirs ()
+{
+	# Where is Erlang binary
+	ERL=`which erl`
+
+	EJA_SRC_DIR=$EJA_DIR/src/
+	EJA_MSGS_DIR=$EJA_SRC_DIR/msgs/
+	EXTRACT_DIR=$EJA_DIR/contrib/extract_translations/
+	EXTRACT_ERL=$EXTRACT_DIR/extract_translations.erl
+	EXTRACT_BEAM=$EXTRACT_DIR/extract_translations.beam
+
+	SRC_DIR=$RUN_DIR/src
+	MSGS_DIR=$SRC_DIR/msgs
+
+	if !([[ -n $EJA_DIR ]])
+	then 
+	echo "ejabberd dir does not exist: $EJA_DIR"
+	fi
+
+	if !([[ -x $EXTRACT_BEAM ]])
+	then 
+	sh -c "cd $EXTRACT_DIR; $ERL -compile $EXTRACT_ERL"
+	fi
+}
+
+extract_lang ()
+{
+	MSGS_FILE=$1
+	MSGS_FILE2=$MSGS_FILE.translate
+	MSGS_PATH=$MSGS_DIR/$MSGS_FILE
+	MSGS_PATH2=$MSGS_DIR/$MSGS_FILE2
+
+	echo -n "Extracting language strings for '$MSGS_FILE':"
+
+	echo -n " new..."
+	cd $SRC_DIR
+	$ERL -pa $EXTRACT_DIR -noinput -noshell -s extract_translations -s init stop -extra . $MSGS_PATH >$MSGS_PATH.new
+	sed -e 's/^% \.\//% /g;' $MSGS_PATH.new > $MSGS_PATH.new2
+	mv $MSGS_PATH.new2 $MSGS_PATH.new 
+
+	echo -n " old..."
+	$ERL -pa $EXTRACT_DIR -noinput -noshell -s extract_translations -s init stop -extra -unused . $MSGS_PATH >$MSGS_PATH.unused
+	find_unused_full $MSGS_FILE $MSGS_FILE.unused
+
+	echo "" >$MSGS_PATH2
+	echo "    ***** Translation file for ejabberd ***** " >>$MSGS_PATH2
+	echo "" >>$MSGS_PATH2
+
+	echo "" >>$MSGS_PATH2
+	echo "    *** New strings: Can you please translate them? *** " >>$MSGS_PATH2
+	cat $MSGS_PATH.new >>$MSGS_PATH2
+
+	echo "" >>$MSGS_PATH2
+	echo "" >>$MSGS_PATH2
+	echo "    *** Unused strings: They will be removed automatically *** " >>$MSGS_PATH2
+	cat $MSGS_PATH.unused.full >>$MSGS_PATH2
+
+	echo "" >>$MSGS_PATH2
+	echo "" >>$MSGS_PATH2
+	echo "    *** Already translated strings: you can also modify any of them if you want *** " >>$MSGS_PATH2
+	echo "" >>$MSGS_PATH2
+	cat $MSGS_PATH.old_cleaned >>$MSGS_PATH2
+
+	echo " ok"
+
+	rm $MSGS_PATH.new
+	rm $MSGS_PATH.old_cleaned
+	rm $MSGS_PATH.unused.full
+}
+
+extract_lang_all ()
+{
+	cd $MSGS_DIR
+	for i in $( ls *.msg ) ; do
+		extract_lang $i;
+	done
+
+	echo -e "File\tMissing\tLanguage\t\tLast translator"
+	echo -e "----\t-------\t--------\t\t---------------"
+	cd $MSGS_DIR
+	for i in $( ls *.msg ) ; do
+		MISSING=`cat $i.translate | grep "\", \"\"}." | wc -l`
+		LANGUAGE=`grep "Language:" $i.translate | sed 's/% Language: //g'`
+		LASTAUTH=`grep "Author:" $i.translate | head -n 1 | sed 's/% Author: //g'`
+		echo -e "$i\t$MISSING\t$LANGUAGE\t$LASTAUTH"
+	done
+
+	cd $MSGS_DIR
+	REVISION=`git describe --always`
+	zip $HOME/ejabberd-langs-$REVISION.zip *.translate;
+
+	rm *.translate
+}
+
+find_unused_full ()
+{
+	DATFILE=$1
+	DATFILEI=$1.old_cleaned
+	DELFILE=$2
+	cd msgs
+
+	DATFILE1=$DATFILE.t1
+	DATFILE2=$DATFILE.t2
+
+	DELFILE1=$DELFILE.t1
+	DELFILE2=$DELFILE.t2
+	DELFILEF=$DATFILE.unused.full
+	echo "" >$DELFILEF
+
+	grep -v "\\\\" $DELFILE >$DELFILE2
+	echo ENDFILEMARK >>$DELFILE2
+	cp $DATFILE $DATFILEI
+	cp $DATFILE $DATFILE2
+
+	cp $DELFILE2 $DELFILE1
+	STRING=`head -1 $DELFILE1`
+	until [[ $STRING == ENDFILEMARK ]]; do 
+		cp $DELFILE2 $DELFILE1
+		cp $DATFILE2 $DATFILE1
+
+		STRING=`head -1 $DELFILE1`
+
+		cat $DATFILE1 | grep "$STRING" >>$DELFILEF
+		cat $DATFILE1 | grep -v "$STRING" >$DATFILE2
+		cat $DELFILE1 | grep -v "$STRING" >$DELFILE2
+	done
+
+	mv $DATFILE2 $DATFILEI
+
+	rm -f $MSGS_PATH.t1
+	rm $MSGS_PATH.unused
+	rm -f $MSGS_PATH.unused.t1
+	rm $MSGS_PATH.unused.t2
+
+	cd ..
+}
+
+extract_lang_srcmsg2po ()
+{
+	LANG=$1
+	LANG_CODE=$LANG.$PROJECT
+	MSGS_PATH=$MSGS_DIR/$LANG_CODE.msg
+	PO_PATH=$MSGS_DIR/$LANG_CODE.po
+
+	echo $MSGS_PATH
+
+	$ERL -pa $EXTRACT_DIR -pa $SRC_DIR -pa $EJA_SRC_DIR -pa /lib/ejabberd/include -noinput -noshell -s extract_translations -s init stop -extra -srcmsg2po . $MSGS_PATH >$PO_PATH.1
+	sed -e 's/ \[\]$/ \"\"/g;' $PO_PATH.1 > $PO_PATH.2
+	msguniq --sort-by-file $PO_PATH.2 --output-file=$PO_PATH
+	
+	rm $PO_PATH.*
+}
+
+extract_lang_src2pot ()
+{
+	LANG_CODE=$PROJECT
+	MSGS_PATH=$MSGS_DIR/$LANG_CODE.msg
+	POT_PATH=$MSGS_DIR/$LANG_CODE.pot
+
+	echo -n "" >$MSGS_PATH
+	echo "% Language: Language Name" >>$MSGS_PATH
+	echo "% Author: Translator name and contact method" >>$MSGS_PATH
+	echo "" >>$MSGS_PATH
+
+	cd $SRC_DIR
+	$ERL -pa $EXTRACT_DIR -pa $SRC_DIR -pa $EJA_SRC_DIR -pa /lib/ejabberd/include -noinput -noshell -s extract_translations -s init stop -extra -srcmsg2po . $MSGS_PATH >$POT_PATH.1
+	sed -e 's/ \[\]$/ \"\"/g;' $POT_PATH.1 > $POT_PATH.2
+
+	#msguniq --sort-by-file $POT_PATH.2 $EJA_MSGS_DIR --output-file=$POT_PATH
+	msguniq --sort-by-file $POT_PATH.2 --output-file=$POT_PATH
+
+	rm $POT_PATH.*
+	rm $MSGS_PATH
+
+	# If the project is a specific module, not the main ejabberd
+	if [[ $PROJECT != ejabberd ]] ; then
+	    # Remove from project.pot the strings that are already present in the general ejabberd
+	    EJABBERD_MSG_FILE=$EJA_MSGS_DIR/es.po # This is just some file with translated strings
+	    POT_PATH_TEMP=$POT_PATH.temp
+	    msgattrib --set-obsolete --only-file=$EJABBERD_MSG_FILE -o $POT_PATH_TEMP $POT_PATH
+	    mv $POT_PATH_TEMP $POT_PATH
+	fi
+}
+
+extract_lang_popot2po ()
+{
+	LANG_CODE=$1
+	PO_PATH=$MSGS_DIR/$LANG_CODE.po
+	POT_PATH=$MSGS_DIR/$PROJECT.pot
+
+	msgmerge $PO_PATH $POT_PATH >$PO_PATH.translate 2>/dev/null
+	mv $PO_PATH.translate $PO_PATH 
+}
+
+extract_lang_po2msg ()
+{
+	LANG_CODE=$1
+	PO_PATH=$LANG_CODE.po
+	MS_PATH=$PO_PATH.ms
+	MSGID_PATH=$PO_PATH.msgid
+	MSGSTR_PATH=$PO_PATH.msgstr
+	MSGS_PATH=$LANG_CODE.msg
+
+	cd $MSGS_DIR
+
+	# Check PO has correct ~
+	# Let's convert to C format so we can use msgfmt
+	PO_TEMP=$LANG_CODE.po.temp
+	cat $PO_PATH | sed 's/%/perc/g' | sed 's/~/%/g' | sed 's/#:.*/#, c-format/g' >$PO_TEMP
+	msgfmt $PO_TEMP --check-format
+	result=$?
+	rm $PO_TEMP
+	if [ $result -ne 0 ] ; then
+		exit 1
+	fi
+
+	msgattrib $PO_PATH --translated --no-fuzzy --no-obsolete --no-location --no-wrap | grep "^msg" | tail --lines=+3 >$MS_PATH
+	grep "^msgid" $PO_PATH.ms | sed 's/^msgid //g' >$MSGID_PATH
+	grep "^msgstr" $PO_PATH.ms | sed 's/^msgstr //g' >$MSGSTR_PATH
+	paste $MSGID_PATH $MSGSTR_PATH --delimiter=, | awk '{print "{" $0 "}."}' | sort -g >$MSGS_PATH
+
+	rm $MS_PATH
+	rm $MSGID_PATH
+	rm $MSGSTR_PATH
+}
+
+extract_lang_updateall ()
+{
+	echo "Generating POT"
+	extract_lang_src2pot 
+
+	cd $MSGS_DIR
+	echo ""
+	echo -e "File Missing Language     Last translator"
+	echo -e "---- ------- --------     ---------------"
+	for i in $( ls *.msg ) ; do
+                LANG_CODE=${i%.msg}
+		echo -n $LANG_CODE | awk '{printf "%-6s", $1 }'
+
+		# Convert old MSG file to PO
+		PO=$LANG_CODE.po
+		[ -f $PO ] || extract_lang_srcmsg2po $LANG_CODE
+
+		extract_lang_popot2po $LANG_CODE
+		extract_lang_po2msg $LANG_CODE
+
+		MISSING=`msgfmt --statistics $PO 2>&1 | awk '{printf "%5s", $4 }'`
+		echo -n " $MISSING"
+
+		LANGUAGE=`grep "Language:" $PO | sed 's/\"X-Language: //g' | sed 's/\\\\n\"//g' | awk '{printf "%-12s", $1}'`
+		echo -n " $LANGUAGE"
+
+		LASTAUTH=`grep "Last-Translator" $PO | sed 's/\"Last-Translator: //g' | sed 's/\\\\n\"//g'`
+		echo " $LASTAUTH"
+	done
+	echo ""
+	rm messages.mo
+
+	cd ..
+}
+
+translation_instructions ()
+{
+	echo ""
+	echo "  A new file has been created for you, with the current, the new and the deprecated strings:"
+	echo "  $MSGS_PATH2"
+	echo ""
+	echo "  At the end of that file you will find the strings you must update:"
+	echo "   - Untranslated strings are like this: {"March", ""}."
+	echo "     To translate the string, add the text inside the commas. Example:"
+	echo "     {"March", "Marzo"}."
+	echo "   - Old strings that are not used: "Woowoa""
+	echo "     Search the entire file for those strings and remove them"
+	echo ""
+	echo "  Once you have translated all the strings and removed all the old ones,"
+	echo "  rename the file to overwrite the previous one:"
+	echo "  $MSGS_PATH"
+}
+
+EJA_DIR=`pwd`/..
+RUN_DIR=`pwd`/..
+PROJECT=ejabberd
+
+while [ $# -ne 0 ] ; do
+    PARAM=$1
+    shift
+    case $PARAM in
+        --) break ;;
+	-project)
+		PROJECT=$1
+		shift
+		;;
+	-ejadir)
+		EJA_DIR=$1
+		shift
+		;;
+	-rundir)
+		RUN_DIR=$1
+		shift
+		;;
+	-lang)
+		LANGU=$1
+		prepare_dirs
+		extract_lang $LANGU
+		shift
+		;;
+	-langall)
+		prepare_dirs
+		extract_lang_all
+		;;
+	-srcmsg2po)
+		LANG_CODE=$1
+		prepare_dirs
+		extract_lang_srcmsg2po $LANG_CODE
+		shift
+		;;
+	-popot2po)
+		LANG_CODE=$1
+		prepare_dirs
+		extract_lang_popot2po $LANG_CODE
+		shift
+		;;
+	-src2pot)
+		prepare_dirs
+		extract_lang_src2pot 
+		;;
+	-po2msg)
+		LANG_CODE=$1
+		prepare_dirs
+		extract_lang_po2msg $LANG_CODE
+		shift
+		;;
+	-updateall)
+		prepare_dirs
+		extract_lang_updateall
+		;;
+	*)
+		echo "Options:"
+		echo "  -langall"
+		echo "  -lang LANGUAGE_FILE"
+		echo "  -srcmsg2po LANGUAGE   Construct .msg file using source code to PO file"
+		echo "  -src2pot              Generate template POT file from source code"
+		echo "  -popot2po LANGUAGE    Update PO file with template POT file"
+		echo "  -po2msg LANGUAGE      Export PO file to MSG file"
+		echo "  -updateall            Generate POT and update all PO"
+		echo ""
+		echo "Example:"
+		echo "  ./prepare-translation.sh -lang es.msg"
+		exit 0
+		;;
     esac
 done
-
-# Where is Erlang binary
-ERL=`which erl`
-
-EXTRACT_DIR=$EJA_DIR/contrib/extract_translations/
-EXTRACT_ERL=extract_translations.erl
-EXTRACT_BEAM=extract_translations.beam
-SRC_DIR=$EJA_DIR/src
-MSGS_DIR=$SRC_DIR/msgs
-MSGS_FILE=$LANGU.msg
-MSGS_FILE2=$LANGU.msg.translate
-MSGS_PATH=$MSGS_DIR/$MSGS_FILE
-MSGS_PATH2=$MSGS_DIR/$MSGS_FILE2
-
-if !([[ -n $EJA_DIR ]])
-then 
-echo "ejabberd dir does not exist: $EJA_DIR"
-fi
-
-if !([[ -x $EXTRACT_BEAM ]])
-then 
-echo -n "Compiling extract_translations.erl: "
-sh -c "cd $EXTRACT_DIR; $ERL -compile $EXTRACT_ERL"
-fi
-
-echo ""
-echo -n "Extracting language strings for '$LANGU':"
-
-echo -n " new..."
-$ERL -pa $EXTRACT_DIR -noinput -noshell -s extract_translations -s init stop -extra $SRC_DIR $MSGS_PATH >$MSGS_PATH.new
-
-echo -n " old..."
-$ERL -pa $EXTRACT_DIR -noinput -noshell -s extract_translations -s init stop -extra -unused $SRC_DIR $MSGS_PATH >$MSGS_PATH.unused
-
-cat $MSGS_PATH >$MSGS_PATH2
-
-echo "" >>$MSGS_PATH2
-
-cat $MSGS_PATH.new >>$MSGS_PATH2
-rm $MSGS_PATH.new
-echo "" >>$MSGS_PATH2
-
-cat $MSGS_PATH.unused >>$MSGS_PATH2
-rm $MSGS_PATH.unused
-
-echo " ok"
-
-echo ""
-echo "Process completed."
-
-echo ""
-echo "  A new file has been created for you, with the current, the new and the deprecated strings:"
-echo "  $MSGS_PATH2"
-echo ""
-echo "  At the end of that file you will find the strings you must update:"
-echo "   - Untranslated strings are like this: {"March", ""}."
-echo "     To translate the string, add the text inside the commas. Example:"
-echo "     {"March", "Marzo"}."
-echo "   - Old strings that are not used: "Woowoa""
-echo "     Search the entire file for those strings and remove them"
-echo ""
-echo "  Once you have translated all the strings and removed all the old ones,"
-echo "  rename the file to overwrite the previous one:"
-echo "  $MSGS_PATH"

doc/Makefile

@@ -1,13 +1,26 @@
 # $Id$
 
+SHELL = /bin/bash
+
+CONTRIBUTED_MODULES = ""
+#ifeq ($(shell ls mod_http_bind.tex),mod_http_bind.tex)
+#	CONTRIBUTED_MODULES += "\\n\\setboolean{modhttpbind}{true}"
+#endif
+
+
 all:	release pdf html
 
 release:
 	@echo "Notes for the releaser:"
 	@echo "* Do not forget to add a link to the release notes in guide.tex"
-	@echo "* Do not forget to change the version number in version.tex"
+	@echo "* Do not forget to update the version number in src/ejabberd.app!"
 	@echo "* Do not forget to update the features in introduction.tex (including \new{} and \improved{} tags)."
-	@read -p "press any key to continue"
+	@echo "Press any key to continue"
+	##@read foo
+	@echo "% ejabberd version (automatically generated)." > version.tex
+	@echo "\newcommand{\version}{"`sed '/vsn/!d;s/\(.*\)"\(.*\)"\(.*\)/\2/' ../src/ejabberd.app`"}" >> version.tex
+	@echo -n "% Contributed modules (automatically generated)."  > contributed_modules.tex
+	@echo -e "$(CONTRIBUTED_MODULES)" >> contributed_modules.tex
 
 html:	guide.html dev.html features.html
 
@@ -16,7 +29,6 @@ pdf:	guide.pdf features.pdf
 clean:
 	rm -f *.aux
 	rm -f *.haux
-	rm -f *.html
 	rm -f *.htoc
 	rm -f *.idx
 	rm -f *.ilg
@@ -25,18 +37,19 @@ clean:
 	rm -f *.out
 	rm -f *.pdf
 	rm -f *.toc
+	[ ! -f contributed_modules.tex ] || rm contributed_modules.tex
+
+distclean: clean
+	rm -f *.html
 
 guide.html:	guide.tex
-		hevea guide.tex
-		hevea guide.tex
+		hevea -fix -pedantic guide.tex
 
 dev.html:	dev.tex
-		hevea dev.tex
-		hevea dev.tex
+		hevea -fix -pedantic dev.tex
 
 features.html:	features.tex
-		hevea features.tex
-		hevea features.tex
+		hevea -fix -pedantic features.tex
 
 guide.pdf:	guide.tex
 		pdflatex guide.tex

doc/api/Makefile

@@ -0,0 +1,18 @@
+APPNAME = ejabberd
+VSN = $(shell sed '/vsn/!d;s/\(.*\)"\(.*\)"\(.*\)/\2/' ../../src/ejabberd.app)
+
+DOCDIR=.
+SRCDIR=../../src
+
+.PHONY = all
+
+all: docs
+
+clean:
+	rm -f *.html
+	rm edoc-info
+	rm erlang.png
+
+docs:
+	erl -noshell -run edoc_run application \
+	"'$(APPNAME)'" '"$(SRCDIR)"' '[{dir,"$(DOCDIR)"},{packages, false},{todo,true},{private,true},{def,{vsn,"$(VSN)"}},{stylesheet,"process-one.css"},{overview,"$(DOCDIR)/overview.edoc"}]' -s init stop

doc/api/overview.edoc

@@ -0,0 +1,10 @@
+@author Mickael Remond <mickael.remond@process-one.net>
+  [http://www.process-one.net/]
+@copyright 2007 ProcessOne
+@version {@vsn}, {@date} {@time}
+@title ejabberd Development API Documentation
+
+@doc
+== Introduction ==
+
+TODO: Insert content from Jerome documentation.

doc/api/process-one.css

@@ -0,0 +1,92 @@
+html, body {
+  font-family: Verdana, sans-serif;
+  color: #000;
+  background-color: #fff;
+}
+
+h1 {
+  color: #4a5389;
+  border-bottom: solid 1px #000;
+}
+
+h2 {
+  font-size: 24px;
+  text-align: right;
+  color: #4a5389;
+  border-bottom: 1px solid #000;
+}
+
+h3 {
+  font-size: 18px;
+  color: #900;
+}
+
+h4 {
+  font-size: 14px;
+  color: #000;
+}
+
+a[href] {
+  color: #4a5389;
+}
+
+a[href]:hover {
+  background-color: #ecefff;
+}
+
+p, li, dd {
+  text-align: justify;
+}
+
+li {
+  margin-top: 0.3em;
+}
+
+li:first-child {
+  margin-top: 0px;
+}
+
+blockquote {
+  color: #555;
+}
+
+caption {
+  font-style: italic;
+  color: #009;
+  text-align: left;
+  margin-left: 20px;
+}
+
+table[border="1"] {
+  border-collapse: collapse;
+  margin-bottom: 1em;
+}
+
+table[border="1"] td {
+  border: 1px solid #ddd;
+}
+
+pre, tt, code {
+  color: #461b7e;
+}
+
+pre {
+  margin:1ex 2ex;
+  border:1px dashed lightgrey;
+  background-color:#f9f9f9;
+  padding:0.5ex;
+}
+
+pre em {
+  font-style: normal;
+  font-weight: bold;
+}
+
+dt {
+  margin:0ex 2ex;
+  font-weight:bold;
+}
+
+dd {
+  margin:0ex 0ex 1ex 4ex;
+}

doc/dev.html

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

doc/dev.tex

@@ -26,27 +26,35 @@
 \newcommand{\ns}[1]{\texttt{#1}}
 \newcommand{\ejabberd}{\texttt{ejabberd}}
 \newcommand{\Jabber}{Jabber}
+\newcommand{\XMPP}{XMPP}
 
 %% Modules
 \newcommand{\module}[1]{\texttt{#1}}
+\newcommand{\modadhoc}{\module{mod\_adhoc}}
 \newcommand{\modannounce}{\module{mod\_announce}}
 \newcommand{\modconfigure}{\module{mod\_configure}}
 \newcommand{\moddisco}{\module{mod\_disco}}
+\newcommand{\modecho}{\module{mod\_echo}}
 \newcommand{\modirc}{\module{mod\_irc}}
 \newcommand{\modlast}{\module{mod\_last}}
+\newcommand{\modlastodbc}{\module{mod\_last\_odbc}}
 \newcommand{\modmuc}{\module{mod\_muc}}
-\newcommand{\modecho}{\module{mod\_echo}}
+\newcommand{\modmuclog}{\module{mod\_muc\_log}}
 \newcommand{\modoffline}{\module{mod\_offline}}
+\newcommand{\modofflineodbc}{\module{mod\_offline\_odbc}}
 \newcommand{\modprivacy}{\module{mod\_privacy}}
 \newcommand{\modprivate}{\module{mod\_private}}
 \newcommand{\modpubsub}{\module{mod\_pubsub}}
 \newcommand{\modregister}{\module{mod\_register}}
 \newcommand{\modroster}{\module{mod\_roster}}
+\newcommand{\modrosterodbc}{\module{mod\_roster\_odbc}}
 \newcommand{\modservicelog}{\module{mod\_service\_log}}
 \newcommand{\modsharedroster}{\module{mod\_shared\_roster}}
 \newcommand{\modstats}{\module{mod\_stats}}
 \newcommand{\modtime}{\module{mod\_time}}
 \newcommand{\modvcard}{\module{mod\_vcard}}
+\newcommand{\modvcardldap}{\module{mod\_vcard\_ldap}}
+\newcommand{\modvcardodbc}{\module{mod\_vcard\_odbc}}
 \newcommand{\modversion}{\module{mod\_version}}
 
 %% Title page
@@ -64,12 +72,12 @@
 \newcommand{\moreinfo}[1]{} % Hide details
 
 %% Footnotes
-\newcommand{\tjepref}[2]{\footahref{http://www.jabber.org/jeps/jep-#1.html}{#2}}
-\newcommand{\jepref}[1]{\tjepref{#1}{JEP-#1}}
+\newcommand{\txepref}[2]{\footahref{http://www.xmpp.org/extensions/xep-#1.html}{#2}}
+\newcommand{\xepref}[1]{\txepref{#1}{XEP-#1}}
 
 \begin{document}
 
-\label{sec:titlepage}
+\label{titlepage}
 \begin{titlepage}
   \maketitle{}
 
@@ -89,11 +97,11 @@
 % Input introduction.tex
 \input{introduction}
 
-\section{How it works}
-\label{sec:howitworks}
+\section{How it Works}
+\label{howitworks}
 
 
-A \Jabber{} domain is served by one or more \ejabberd{} nodes.  These nodes can
+A \XMPP{} domain is served by one or more \ejabberd{} nodes.  These nodes can
 be run on different machines that are connected via a network.  They all must
 have the ability to connect to port 4369 of all another nodes, and must have
 the same magic cookie (see Erlang/OTP documentation, in other words the file
@@ -114,7 +122,7 @@ Each \ejabberd{} node have following modules:
 
 \subsection{Router}
 
-This module is the main router of \Jabber{} packets on each node.  It routes
+This module is the main router of \XMPP{} packets on each node.  It routes
 them based on their destinations domains.  It has two tables: local and global
 routes.  First, domain of packet destination searched in local table, and if it
 found, then the packet is routed to appropriate process.  If no, then it
@@ -140,7 +148,7 @@ the packet is sent to session manager on that node.
 
 \subsection{S2S Manager}
 
-This module routes packets to other \Jabber{} servers.  First, it checks if an
+This module routes packets to other \XMPP{} servers.  First, it checks if an
 open S2S connection from the domain of the packet source to the domain of
 packet destination already exists. If it is open on another node, then it
 routes the packet to S2S manager on that node, if it is open on this node, then
@@ -148,10 +156,81 @@ it is routed to the process that serves this connection, and if a connection
 does not exist, then it is opened and registered.
 
 
+\section{Authentication}
 
+\subsubsection{External}
+\label{externalauth}
+\ind{external authentication}
 
-\section{XML representation}
-\label{sec:xmlrepr}
+The external authentication script follows
+\footahref{http://www.erlang.org/doc/tutorial/c_portdriver.html}{the erlang port driver API}.
+
+That script is supposed to do theses actions, in an infinite loop:
+\begin{itemize}
+\item read from stdin: AABBBBBBBBB.....
+    \begin{itemize}
+    \item A: 2 bytes of length data (a short in network byte order)
+    \item B: a string of length found in A that contains operation in plain text
+    operation are as follows:
+    \begin{itemize}
+    \item auth:User:Server:Password (check if a username/password pair is correct)
+    \item isuser:User:Server (check if it's a valid user)
+    \item setpass:User:Server:Password (set user's password)
+    \item tryregister:User:Server:Password (try to register an account)
+    \item removeuser:User:Server (remove this account)
+    \item removeuser3:User:Server:Password (remove this account if the password is correct)
+    \end{itemize}
+    \end{itemize}
+\item write to stdout: AABB
+    \begin{itemize}
+    \item A: the number 2 (coded as a short, which is bytes length of following result)
+    \item B: the result code (coded as a short), should be 1 for success/valid, or 0 for failure/invalid
+    \end{itemize}
+\end{itemize}
+
+Example python script
+\begin{verbatim}
+#!/usr/bin/python
+
+import sys
+from struct import *
+
+def from_ejabberd():
+    input_length = sys.stdin.read(2)
+    (size,) = unpack('>h', input_length)
+    return sys.stdin.read(size).split(':')
+
+def to_ejabberd(bool):
+    answer = 0
+    if bool:
+        answer = 1
+    token = pack('>hh', 2, answer)
+    sys.stdout.write(token)
+    sys.stdout.flush()
+
+def auth(username, server, password):
+    return True
+
+def isuser(username, server):
+    return True
+
+def setpass(username, server, password):
+    return True
+
+while True:
+    data = from_ejabberd()
+    success = False
+    if data[0] == "auth":
+        success = auth(data[1], data[2], data[3])
+    elif data[0] == "isuser":
+        success = isuser(data[1], data[2])
+    elif data[0] == "setpass":
+        success = setpass(data[1], data[2], data[3])
+    to_ejabberd(success)
+\end{verbatim}
+
+\section{XML Representation}
+\label{xmlrepr}
 
 Each XML stanza is represented as the following tuple:
 \begin{verbatim}
@@ -183,7 +262,7 @@ is represented as the following structure:
 
 
 \section{Module \texttt{xml}}
-\label{sec:xmlmod}
+\label{xmlmod}
 
 \begin{description}
 \item{\verb|element_to_string(El) -> string()|}
@@ -241,7 +320,7 @@ Res = string() | XMLElement
 
 
 \section{Module \texttt{xml\_stream}}
-\label{sec:xmlstreammod}
+\label{xmlstreammod}
 
 \begin{description}
 \item{\verb!parse_element(Str) -> XMLElement | {error, Err}!}
@@ -254,17 +333,17 @@ Err = term()
 \end{description}
 
 
-\section{\ejabberd{} modules}
-\label{sec:emods}
+\section{Modules}
+\label{emods}
 
 
-\subsection{gen\_mod behaviour}
-\label{sec:genmod}
+%\subsection{gen\_mod behaviour}
+%\label{genmod}
 
-TBD
+%TBD
 
 \subsection{Module gen\_iq\_handler}
-\label{sec:geniqhandl}
+\label{geniqhandl}
 
 The module \verb|gen_iq_handler| allows to easily write handlers for IQ packets
 of particular XML namespaces that addressed to server or to users bare JIDs.
@@ -343,12 +422,12 @@ process_local_iq(From, To, {iq, ID, Type, XMLNS, SubEl}) ->
 
 
 \subsection{Services}
-\label{sec:services}
+\label{services}
 
-TBD
+%TBD
 
 
-TODO: use \verb|proc_lib|
+%TODO: use \verb|proc_lib|
 \begin{verbatim}
 -module(mod_echo).
 

doc/features.html

@@ -0,0 +1,132 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
+            "http://www.w3.org/TR/REC-html40/loose.dtd">
+<HTML>
+<HEAD>
+<TITLE>Ejabberd 2.1.5 Feature Sheet
+</TITLE>
+
+<META http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<META name="GENERATOR" content="hevea 1.10">
+<STYLE type="text/css">
+.li-itemize{margin:1ex 0ex;}
+.li-enumerate{margin:1ex 0ex;}
+.dd-description{margin:0ex 0ex 1ex 4ex;}
+.dt-description{margin:0ex;}
+.toc{list-style:none;}
+.thefootnotes{text-align:left;margin:0ex;}
+.dt-thefootnotes{margin:0em;}
+.dd-thefootnotes{margin:0em 0em 0em 2em;}
+.footnoterule{margin:1em auto 1em 0px;width:50%;}
+.caption{padding-left:2ex; padding-right:2ex; margin-left:auto; margin-right:auto}
+.title{margin:2ex auto;text-align:center}
+.center{text-align:center;margin-left:auto;margin-right:auto;}
+.flushleft{text-align:left;margin-left:0ex;margin-right:auto;}
+.flushright{text-align:right;margin-left:auto;margin-right:0ex;}
+DIV TABLE{margin-left:inherit;margin-right:inherit;}
+PRE{text-align:left;margin-left:0ex;margin-right:auto;}
+BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}
+TD P{margin:0px;}
+.boxed{border:1px solid black}
+.textboxed{border:1px solid black}
+.vbar{border:none;width:2px;background-color:black;}
+.hbar{border:none;height:2px;width:100%;background-color:black;}
+.hfill{border:none;height:1px;width:200%;background-color:black;}
+.vdisplay{border-collapse:separate;border-spacing:2px;width:auto; empty-cells:show; border:2px solid red;}
+.vdcell{white-space:nowrap;padding:0px;width:auto; border:2px solid green;}
+.display{border-collapse:separate;border-spacing:2px;width:auto; border:none;}
+.dcell{white-space:nowrap;padding:0px;width:auto; border:none;}
+.dcenter{margin:0ex auto;}
+.vdcenter{border:solid #FF8000 2px; margin:0ex auto;}
+.minipage{text-align:left; margin-left:0em; margin-right:auto;}
+.marginpar{border:solid thin black; width:20%; text-align:left;}
+.marginparleft{float:left; margin-left:0ex; margin-right:1ex;}
+.marginparright{float:right; margin-left:1ex; margin-right:0ex;}
+.theorem{text-align:left;margin:1ex auto 1ex 0ex;}
+.part{margin:2ex auto;text-align:center}
+SPAN{width:20%; float:right; text-align:left; margin-left:auto;}
+</STYLE>
+</HEAD>
+<BODY >
+<!--HEVEA command line is: /usr/bin/hevea -fix -pedantic features.tex -->
+<!--CUT DEF section 1 --><P><A NAME="titlepage"></A>
+
+</P><TABLE CLASS="title"><TR><TD><H1 CLASS="titlemain">Ejabberd 2.1.5 Feature Sheet</H1><H3 CLASS="titlerest">Sander Devrieze<BR>
+ <A HREF="mailto:s.devrieze@pandora.be"><TT>mailto:s.devrieze@pandora.be</TT></A><BR>
+ <A HREF="xmpp:sander@devrieze.dyndns.org"><TT>xmpp:sander@devrieze.dyndns.org</TT></A></H3></TD></TR>
+</TABLE><DIV CLASS="center">
+
+<IMG SRC="logo.png" ALT="logo.png">
+
+
+</DIV><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>I can thoroughly recommend ejabberd for ease of setup &#X2013;
+Kevin Smith, Current maintainer of the Psi project</I></FONT></BLOCKQUOTE><P>Introduction
+<A NAME="intro"></A></P><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>I just tried out ejabberd and was impressed both by ejabberd itself and the language it is written in, Erlang. &#X2014;
+Joeri</I></FONT></BLOCKQUOTE><P><TT>ejabberd</TT> is a <B><FONT SIZE=4><FONT COLOR="#001376">free and open source</FONT></FONT></B> instant messaging server written in <A HREF="http://www.erlang.org/">Erlang/OTP</A>.</P><P><TT>ejabberd</TT> is <B><FONT SIZE=4><FONT COLOR="#001376">cross-platform</FONT></FONT></B>, distributed, fault-tolerant, and based on open standards to achieve real-time communication.</P><P><TT>ejabberd</TT> is designed to be a <B><FONT SIZE=4><FONT COLOR="#001376">rock-solid and feature rich</FONT></FONT></B> XMPP server.</P><P><TT>ejabberd</TT> is suitable for small deployments, whether they need to be <B><FONT SIZE=4><FONT COLOR="#001376">scalable</FONT></FONT></B> or not, as well as extremely big deployments.</P><!--TOC section Key Features-->
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc1"></A>Key Features</H2><!--SEC END --><P>
+<A NAME="keyfeatures"></A>
+</P><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>Erlang seems to be tailor-made for writing stable, robust servers. &#X2014;
+Peter Saint-Andr&#XE9;, Executive Director of the Jabber Software Foundation</I></FONT></BLOCKQUOTE><P><TT>ejabberd</TT> is:
+</P><UL CLASS="itemize"><LI CLASS="li-itemize">
+<B><FONT SIZE=4><FONT COLOR="#001376">Cross-platform:</FONT></FONT></B> <TT>ejabberd</TT> runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.</LI><LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Distributed:</FONT></FONT></B> You can run <TT>ejabberd</TT> on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.</LI><LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Fault-tolerant:</FONT></FONT></B> You can deploy an <TT>ejabberd</TT> cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced &#X2018;on the fly&#X2019;.</LI><LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Administrator Friendly:</FONT></FONT></B> <TT>ejabberd</TT> is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include:
+<UL CLASS="itemize"><LI CLASS="li-itemize">
+Comprehensive documentation.
+</LI><LI CLASS="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows. </LI><LI CLASS="li-itemize">Web Administration.
+</LI><LI CLASS="li-itemize">Shared Roster Groups.
+</LI><LI CLASS="li-itemize">Command line administration tool. </LI><LI CLASS="li-itemize">Can integrate with existing authentication mechanisms.
+</LI><LI CLASS="li-itemize">Capability to send announce messages.
+</LI></UL></LI><LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Internationalized:</FONT></FONT></B> <TT>ejabberd</TT> leads in internationalization. Hence it is very well suited in a globalized world. Related features are:
+<UL CLASS="itemize"><LI CLASS="li-itemize">
+Translated to 25 languages. </LI><LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>.
+</LI></UL></LI><LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Open Standards:</FONT></FONT></B> <TT>ejabberd</TT> is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
+<UL CLASS="itemize"><LI CLASS="li-itemize">
+Fully XMPP compliant.
+</LI><LI CLASS="li-itemize">XML-based protocol.
+</LI><LI CLASS="li-itemize"><A HREF="http://www.ejabberd.im/protocols">Many protocols supported</A>.
+</LI></UL></LI></UL><!--TOC section Additional Features-->
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc2"></A>Additional Features</H2><!--SEC END --><P>
+<A NAME="addfeatures"></A>
+</P><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>ejabberd is making inroads to solving the "buggy incomplete server" problem &#X2014;
+Justin Karneges, Founder of the Psi and the Delta projects</I></FONT></BLOCKQUOTE><P>Moreover, <TT>ejabberd</TT> comes with a wide range of other state-of-the-art features:
+</P><UL CLASS="itemize"><LI CLASS="li-itemize">
+Modular
+<UL CLASS="itemize"><LI CLASS="li-itemize">
+Load only the modules you want.
+</LI><LI CLASS="li-itemize">Extend <TT>ejabberd</TT> with your own custom modules.
+</LI></UL>
+</LI><LI CLASS="li-itemize">Security
+<UL CLASS="itemize"><LI CLASS="li-itemize">
+SASL and STARTTLS for c2s and s2s connections.
+</LI><LI CLASS="li-itemize">STARTTLS and Dialback s2s connections.
+</LI><LI CLASS="li-itemize">Web Admin accessible via HTTPS secure access.
+</LI></UL>
+</LI><LI CLASS="li-itemize">Databases
+<UL CLASS="itemize"><LI CLASS="li-itemize">
+Internal database for fast deployment (Mnesia).
+</LI><LI CLASS="li-itemize">Native MySQL support.
+</LI><LI CLASS="li-itemize">Native PostgreSQL support.
+</LI><LI CLASS="li-itemize">ODBC data storage support.
+</LI><LI CLASS="li-itemize">Microsoft SQL Server support. </LI></UL>
+</LI><LI CLASS="li-itemize">Authentication
+<UL CLASS="itemize"><LI CLASS="li-itemize">
+Internal Authentication.
+</LI><LI CLASS="li-itemize">PAM, LDAP and ODBC. </LI><LI CLASS="li-itemize">External Authentication script.
+</LI></UL>
+</LI><LI CLASS="li-itemize">Others
+<UL CLASS="itemize"><LI CLASS="li-itemize">
+Support for virtual hosting.
+</LI><LI CLASS="li-itemize">Compressing XML streams with Stream Compression (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>).
+</LI><LI CLASS="li-itemize">Statistics via Statistics Gathering (<A HREF="http://www.xmpp.org/extensions/xep-0039.html">XEP-0039</A>).
+</LI><LI CLASS="li-itemize">IPv6 support both for c2s and s2s connections.
+</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with support for clustering and HTML logging. </LI><LI CLASS="li-itemize">Users Directory based on users vCards.
+</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component with support for <A HREF="http://www.xmpp.org/extensions/xep-0163.html">Personal Eventing via Pubsub</A>.
+</LI><LI CLASS="li-itemize">Support for web clients: <A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> and <A HREF="http://www.xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</A> services.
+</LI><LI CLASS="li-itemize">IRC transport.
+</LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports.
+</LI></UL>
+</LI></UL><!--CUT END -->
+<!--HTMLFOOT-->
+<!--ENDHTML-->
+<!--FOOTER-->
+<HR SIZE=2><BLOCKQUOTE CLASS="quote"><EM>This document was translated from L<sup>A</sup>T<sub>E</sub>X by
+</EM><A HREF="http://hevea.inria.fr/index.html"><EM>H</EM><EM><FONT SIZE=2><sup>E</sup></FONT></EM><EM>V</EM><EM><FONT SIZE=2><sup>E</sup></FONT></EM><EM>A</EM></A><EM>.</EM></BLOCKQUOTE></BODY>
+</HTML>

doc/features.tex

@@ -9,7 +9,7 @@
         Feature\ Sheet,pdfauthor=Sander\
         Devrieze,pdfsubject=ejabberd,pdfkeywords=ejabberd]{hyperref}
 \usepackage{verbatim}
-\usepackage{xcolor}
+\usepackage{color}
 
 %% Index
 % Remove the index anchors from the HTML version to save size and bandwith.
@@ -49,11 +49,14 @@
 % Options
 \newcommand{\marking}[1]{\textbf{\begin{large}\textcolor{ejblue}{#1}\end{large}}} % Marking enabled
 \newcommand{\quoting}[2][yozhik]{\begin{quotation}\textcolor{#1}{\textit{#2}}\end{quotation}} % Quotes enabled
-\newcommand{\new}{\begin{latexonly}\marginpar{\textcolor{red}{\textsc{new}}}\end{latexonly}} % Highlight new features
-\newcommand{\improved}{\begin{latexonly}\marginpar{\textcolor{orange}{\textsc{improved}}}\end{latexonly}} % Highlight improved features
-\newcommand{\moreinfo}[1]{} % Hide details
+\newcommand{\new}{\marginpar{\textcolor{red}{\textsc{new}}}} % Highlight new features
+\newcommand{\improved}{\marginpar{\textcolor{orange}{\textsc{improved}}}} % Highlight improved features
 \setcounter{secnumdepth}{-1} % Disable section numbering
 
+%% To by-pass errors in the HTML version.
+\newstyle{SPAN}{width:20\%; float:right; text-align:left; margin-left:auto;}
+\definecolor{orange}       {cmyk}{0.000,0.333,1.000,0.000}
+
 %% Footnotes
 \begin{latexonly}
 \global\parskip=9pt plus 3pt minus 1pt
@@ -61,13 +64,13 @@
 \gdef\ahrefurl#1{\href{#1}{\texttt{#1}}}
 \gdef\footahref#1#2{#2\footnote{\href{#1}{\texttt{#1}}}}
 \end{latexonly}
-\newcommand{\tjepref}[2]{\footahref{http://www.jabber.org/jeps/jep-#1.html}{#2}}
-\newcommand{\jepref}[1]{\tjepref{#1}{JEP-#1}}
+\newcommand{\txepref}[2]{\footahref{http://www.xmpp.org/extensions/xep-#1.html}{#2}}
+\newcommand{\xepref}[1]{\txepref{#1}{XEP-#1}}
 
 %% Fancy header
 \fancyhf{}
 \pagestyle{fancy}
-\rhead{\textcolor{ejblue}{The expandable Jabber daemon.}}
+\rhead{\textcolor{ejblue}{The Expandable Jabber/XMPP Daemon.}}
 \renewcommand{\headrule}{{\color{ejblue}%
 \hrule width\headwidth height\headrulewidth \vskip-\headrulewidth}}
 \lhead{\setlength{\unitlength}{-6mm}
@@ -85,7 +88,7 @@
 
 \begin{document}
 
-\label{sec:titlepage}
+\label{titlepage}
 \begin{titlepage}
   \maketitle{}
 
@@ -107,9 +110,8 @@
 % the same identifier".
 \begin{latexonly}
 \setcounter{page}{2}
-\end{latexonly}
-
 \pagecolor{ejgreenwhite}
+\end{latexonly}
 
 % Input introduction.tex
 \input{introduction}
@@ -131,4 +133,4 @@
 %   "What I find interesting is that *no* XMPP servers truly provide clustering. This includes all the commercial
 %   servers. The one partial exception appears to be ejabberd, which can cluster certain data such as sessions,
 %   but not all services such as MUC."
-% * try it today: links to migration tutorials
+% * try it today: links to migration tutorials

doc/introduction.tex

@@ -1,25 +1,33 @@
-\section{Introduction}
-\label{sec:intr}
+\chapter{Introduction}
+\label{intro}
 
-\quoting{I just tried out ejabberd and was impressed both by ejabberd itself and the language it is written in, Erlang. --
+%% TODO: improve the feature sheet with a nice table to highlight new features.
+
+\quoting{I just tried out ejabberd and was impressed both by ejabberd itself and the language it is written in, Erlang. ---
 Joeri} 
 
-\ejabberd{} is a free (GPL) distributed fault-tolerant \Jabber{}/XMPP server and is mainly written in \footahref{http://www.erlang.org/}{Erlang}.
+%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 (Jabber/XMPP).
 
-\ejabberd{} is designed to be a \marking{stable}, \marking{standards compliant}, and \marking{\mbox{feature rich}} \Jabber{}/XMPP server.
+\ejabberd{} is a \marking{free and open source} instant messaging server written in \footahref{http://www.erlang.org/}{Erlang/OTP}.
 
-\ejabberd{} is suitable for small servers, whether they need to be scalable or not, as well as extremely big servers.
+\ejabberd{} is \marking{cross-platform}, distributed, fault-tolerant, and based on open standards to achieve real-time communication.
+
+\ejabberd{} is designed to be a \marking{rock-solid and feature rich} XMPP server.
+
+\ejabberd{} is suitable for small deployments, whether they need to be \marking{scalable} or not, as well as extremely big deployments.
 
 %\subsection{Layout with example deployment (title needs a better name)}
+%\label{layout}
 
 %In this section there will be a graphical overview like these:\\
 %\verb|http://www.tipic.com/var/timp/timp_dep.gif| \\
 %\verb|http://www.jabber.com/images/jabber_Com_Platform.jpg| \\
 %\verb|http://www.antepo.com/files/OPN45systemdatasheet.pdf| \\
 
-%Some small images of Jabber clients that are known to work greatly with ejabberd. Less text!!!
+%A page full with names of Jabber client that are known to work with ejabberd. \begin{tiny}tiny font\end{tiny}
 
 %\subsection{Try It Today}
+%\label{trytoday}
 
 %(Not sure if I will include/finish this section for the next version.)
 
@@ -32,93 +40,94 @@ Joeri}
 %\end{itemize}
 
 \newpage
-\subsection{Key Features}
-\label{sec:keyfeatures}
+\section{Key Features}
+\label{keyfeatures}
 \ind{features!key features}
 
-\quoting{Erlang seems to be tailor-made for writing stable, robust servers. --
+\quoting{Erlang seems to be tailor-made for writing stable, robust servers. ---
 Peter Saint-Andr\'e, Executive Director of the Jabber Software Foundation}
 
 \ejabberd{} is:
 \begin{itemize}
-\item \marking{Multiplatform:} \ejabberd{} runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
+\item \marking{Cross-platform:} \ejabberd{} runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
 
 \item \marking{Distributed:} You can run \ejabberd{} on a cluster of machines and all of them will serve the same \Jabber{} domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
 
-\item \marking{Fault-tolerant:} You can deploy an \ejabberd{} cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ``on the fly''.
+\item \marking{Fault-tolerant:} You can deploy an \ejabberd{} cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced `on the fly'.
 
 \item \marking{Administrator Friendly:} \ejabberd{} is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include:
 \begin{itemize}
-\item Comprehensive documentation.\moreinfo{ --- You can start in the \footahref{http://ejabberd.jabber.ru/book}{ejabberd Book}.}
-\item Straightforward installers for Linux, Mac OS X, and Windows.\improved{}\moreinfo{ --- (\footahref{http://ejabberd.jabber.ru/screenshots-linux-installer}{Screenshots}).}
-\item Web interface for administration tasks.\moreinfo{ --- With HTTPS secure access. \footahref{http://ejabberd.jabber.ru/online-demo-webadmin}{Demo}.}
-\item Shared Roster Groups.\moreinfo{ --- The administrator can setup a common list of \Jabber{} users for all users on the server. Those users are virtually added to all rosters. They cannot be removed, but can be renamed or moved into different roster groups. Does not require client implementation. Not related to \jepref{0144} (Roster Item Exchange).\footahref{http://ejabberd.jabber.ru/screenshots-shared-roster-groups}{Screenshots})}
-\item Command line administration tool.\improved{}\moreinfo{ --- Some basic administration tasks can be acomplished using the command line: register/remove users, backup/restore database, amongst others (\footahref{http://ejabberd.jabber.ru/screenshots-administration#ejabberdctl}{Screenshots}).}
+\item Comprehensive documentation.
+\item Straightforward installers for Linux, Mac OS X, and Windows. %%\improved{}
+\item Web Administration.
+\item Shared Roster Groups.
+\item Command line administration tool. %%\improved{}
 \item Can integrate with existing authentication mechanisms.
-\item Capability to send announce messages.\improved{}
+\item Capability to send announce messages.
 \end{itemize}
 
 \item \marking{Internationalized:} \ejabberd{} leads in internationalization. Hence it is very well suited in a globalized world. Related features are:
 \begin{itemize}
-\item Translated in 11 languages.\moreinfo{ --- More information is available \footahref{http://ejabberd.jabber.ru/localization}{here}.}
+\item Translated to 25 languages. %%\improved{}
 \item Support for \footahref{http://www.ietf.org/rfc/rfc3490.txt}{IDNA}.
 \end{itemize}
 
 \item \marking{Open Standards:} \ejabberd{} is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
 \begin{itemize}
-\item Fully XMPP compliant \moreinfo{ --- ejabberd is fully compliant with XMPP Core 1.0 and XMPP IM 1.0. Check the \footahref{http://ejabberd.jabber.ru/protocols}{supported protocols}.}
-\item XML-based protocol
-\item \footahref{http://ejabberd.jabber.ru/protocols}{Many JEPs supported}.
+\item Fully XMPP compliant.
+\item XML-based protocol.
+\item \footahref{http://www.ejabberd.im/protocols}{Many protocols supported}.
 \end{itemize}
 
 \end{itemize}
 
 \newpage
 
-\subsection{Additional Features}
-\label{sec:addfeatures}
+\section{Additional Features}
+\label{addfeatures}
 \ind{features!additional features}
 
-\quoting{ejabberd is making inroads to solving the "buggy incomplete server" problem --
+\quoting{ejabberd is making inroads to solving the "buggy incomplete server" problem ---
 Justin Karneges, Founder of the Psi and the Delta projects}
 
-Besides common \Jabber{} server features, \ejabberd{} comes with a wide range of other features:
+Moreover, \ejabberd{} comes with a wide range of other state-of-the-art features:
 \begin{itemize}
 \item Modular
 \begin{itemize}
 \item Load only the modules you want.
-\item Extend \ejabberd{} with your own custom modules.\moreinfo{ --- A list of contributed modules and patches is available on the \footahref{http://ejabberd.jabber.ru/contributions}{contributions page}.}
+\item Extend \ejabberd{} with your own custom modules.
 \end{itemize}
 \item Security
 \begin{itemize}
-\item SASL and STARTTLS for c2s and s2s connections.\improved{}
+\item SASL and STARTTLS for c2s and s2s connections.
 \item STARTTLS and Dialback s2s connections.
-\item Web interface accessible via HTTPS secure access.
+\item Web Admin accessible via HTTPS secure access.
 \end{itemize}
 \item Databases
 \begin{itemize}
-\item Native MySQL support.\new{}
+\item Internal database for fast deployment (Mnesia).
+\item Native MySQL support.
 \item Native PostgreSQL support.
-\item Mnesia.
-\item ODBC data storage support. \moreinfo{ --- ODBC requests can be load balanced between several connections.}
+\item ODBC data storage support.
+\item Microsoft SQL Server support. %%\new{}
 \end{itemize}
 \item Authentication
 \begin{itemize}
-\item LDAP and ODBC. \moreinfo{ --- Accounts can authenticate in a LDAP server.}
-\item External Authentication script.
 \item Internal Authentication.
+\item PAM, LDAP and ODBC.  %%\improved{}
+\item External Authentication script.
 \end{itemize}
 \item Others
 \begin{itemize}
-\item Compressing XML streams with Stream Compression (\jepref{0138}).\new{}
-\item Interface with networks such as AIM, ICQ and MSN.
-\item Statistics via Statistics Gathering (\jepref{0039}).
+\item Support for virtual hosting.
+\item Compressing XML streams with Stream Compression (\xepref{0138}).
+\item Statistics via Statistics Gathering (\xepref{0039}).
 \item IPv6 support both for c2s and s2s connections.
-\item \tjepref{0045}{Multi-User Chat} module with logging.\improved{}
+\item \txepref{0045}{Multi-User Chat} module with support for clustering and HTML logging. %%\improved{}
 \item Users Directory based on users vCards.
-\item \tjepref{0060}{Publish-Subscribe} component.
-\item Support for virtual hosting. \moreinfo{ --- Several \Jabber{} hosts can be hosted on the same \ejabberd{} instance. As simple as adding a new domain name to the list of hosts in the configuration file.}
-\item \tjepref{0025}{HTTP Polling} service.
-\item IRC transport.\improved{}
+\item \txepref{0060}{Publish-Subscribe} component with support for \txepref{0163}{Personal Eventing via Pubsub}.
+\item Support for web clients: \txepref{0025}{HTTP Polling} and \txepref{0206}{HTTP Binding (BOSH)} services.
+\item IRC transport.
+\item Component support: interface with networks such as AIM, ICQ and MSN installing special tranports.
+\end{itemize}
 \end{itemize}
-\end{itemize}

doc/release_notes_1.1.1.txt

@@ -9,7 +9,7 @@
 
    This release fix a security issue introduced in ejabberd 1.1.0. In SASL
    mode, anonymous login was enabled as a default. Upgrading ejabberd 1.1.0 to
-   ejabberd 1.1.1 is highly recommanded.
+   ejabberd 1.1.1 is highly recommended.
 
    ejabberd can be downloaded from the Process-one website:
    http://www.process-one.net/en/projects/ejabberd/

doc/release_notes_1.1.2.txt

@@ -0,0 +1,119 @@
+				Release Notes
+				ejabberd 1.1.2
+			      27 September 2006
+
+   This document describes the main changes in ejabberd 1.1.2.
+
+   This version is a major improvement over ejabberd 1.1.1, improving the
+   overall behaviour of the server in many areas. Users of ejabberd 1.1.1
+   should upgrade to this new release for improved robustness and compliance.
+
+   ejabberd can be downloaded from the Process-one website:
+   http://www.process-one.net/en/projects/ejabberd/
+
+   Detailed information can be found in the Feature Sheet and in the
+   Installation and Operation Guide which are both available on the
+   Process-one website:
+   http://www.process-one.net/en/projects/ejabberd/docs.html
+
+   ejabberd includes 44 improvements. A complete list of changes can be
+   retrieved from:
+   http://redir.process-one.net/ejabberd-1.1.2
+
+
+   Recent changes include:
+
+LDAP Improvements
+
+  - Major improvements have been made on the LDAP module. It is now more
+    flexible and more robust.
+
+HTTP Polling Fixes
+
+  - The HTTP polling modules have been fixed and improved: the connections are
+    closed properly and polled messages cannot be lost anymore.
+
+Roster Management Improvement
+
+  - Roster management improvements increase reliability, especially in cases
+  where users are on different servers.
+  - Shared rosters are more reliable.
+
+Improved Robustness
+
+  - It is now possible to limit the number of opened connections for a single
+  user.
+
+Relational databases
+
+  - Database support: Microsoft SQL Server is now officially supported in ODBC
+  mode.
+
+Publish-Subscribe Improvement
+
+  - Restricting node creation with a dedicated ACL rule is now possible.
+
+Localization
+
+  - A Czech translation has been added.
+  - Translations have been updated.
+
+Binary Installer
+
+  - New binary installer for Windows including all requirements.
+  - Improved installers for Linux and MacOSX (PowerPC)
+
+XMPP Compliancy
+
+  - Some protocol compliance fix have been added, after the Portland XMPP
+    Interop Meeting in July.
+
+Miscelanous
+
+  - MUC have been improved (logging rendering).
+  - The command line tool ejabberdctl has been improved.
+  - The build chain has been improved, including MacOSX support.
+  - The documentation has been improved and updated to describe the new
+    features.
+
+Bugfixes
+
+   - Anonymous login bugfixes.
+   - Please refer to the ChangeLog file supplied with this release regarding
+     all improvements in ejabberd.
+
+
+   Installation Notes
+
+Supported Erlang Version
+
+   - You need at least Erlang/OTP R9C-2 to run ejabberd 1.1.2.
+   - The recommanded version is Erlang/OTP R10B-10.
+   - Erlang/OTP R11B has not yet been fully certified for ejabberd.
+
+Installation
+
+   Installers are provided for Microsoft Windows, Linux/x86 and MacOSX/PPC.
+   They can be retrieved from:
+   http://www.process-one.net/en/projects/ejabberd/download.html
+
+Migration Notes
+
+   - Before any migration, ejabberd system and database must be properly
+   backed up.
+   - The relational database schema has changed between version 1.1.1 and
+   1.1.2. An "askmessage" column needs to be added in the "rosterusers" table
+   to perform the migration.
+
+
+References
+
+   Contributed tutorials and documents of interest are:
+   - Migration from other XMPP servers to ejabberd:
+     http://ejabberd.jabber.ru/migrate-to-ejabberd     
+   - Transport configuration for connecting to other networks:
+     http://ejabberd.jabber.ru/tutorials-transports
+   - Frequently Asked Questions:
+     http://ejabberd.jabber.ru/faq
+
+END

doc/release_notes_1.1.3.txt

@@ -0,0 +1,14 @@
+			    Release Notes
+			    ejabberd 1.1.3
+			   2 February 2007
+
+  ejabberd 1.1.3 is a security fix release for ejabberd roster ODBC
+  module.
+
+  The upgrade is only necessary if you are using ejabberd with the
+  mod_roster_odbc.
+
+  The new code can be downloaded from ejabberd download page:
+     http://www.process-one.net/en/projects/ejabberd/
+
+END

doc/release_notes_1.1.4.txt

@@ -0,0 +1,31 @@
+			      Release Notes
+			      ejabberd 1.1.4
+			   3 september 2007
+
+  ejabberd 1.1.4 is a bugfix release for ejabberd 1.1.x branch.
+
+  ejabberd 1.1.4 includes 10 improvements. A complete list of changes
+  can be retrieved from:
+   http://redir.process-one.net/ejabberd-1.1.4
+
+  The new code can be downloaded from ejabberd download page:
+     http://www.process-one.net/en/projects/ejabberd/
+
+
+   Recent changes include:
+
+- Better LDAP support.
+- Support for UTF-8 with MySQL 5.
+- Roster migration script bugfixes.
+- Performance improvements on user removal.
+- Traffic shapers bugfix.
+- Configuration: host value is now case insensitive.
+- Build: ejabberd.cfg file is not overwritten with 'make install' command.
+
+
+Bugs report
+
+  You can officially report bugs on Process-one support site:
+  http://support.process-one.net/
+
+END

doc/release_notes_2.0.0.txt

@@ -0,0 +1,208 @@
+
+                              Release Notes
+                             ejabberd 2.0.0
+                            21 February 2008
+
+  ejabberd 2.0.0 is a major new version for ejabberd adding plenty of
+  new features, performance and scalability improvements and
+  architectural changes.
+
+  ejabberd 2.0.0 includes more than 200 improvements over ejabberd
+  1.1.x. A complete list of changes can be retrieved from:
+   http://redir.process-one.net/ejabberd-2.0.0
+
+  The new code can be downloaded from ejabberd downloads page:
+     http://www.process-one.net/en/ejabberd/
+
+
+   Recent changes include:
+
+
+* Clustering and Architecture
+
+- New front-end and back-end cluster architecture for better
+  scalability and robustness. Back-end nodes are able to run a fully
+  fault-tolerant XMPP router and services, but you can now deploy
+  many front-end nodes to share the load without needing to synchronize
+  any state with the back-ends.
+- All components now run in cluster mode (For example, Multi-User chat
+  service and file transfer proxy).
+- New load balancing algorithm to support Multi-User chat and gateways
+  clustering. More generally it supports any external component load
+  balancing.
+- ejabberd watchdog to receive warning on suspicious resources consumption.
+- Traffic shapers are now supported on components. This protect
+  ejabberd from components and gateways abuses.
+
+
+* Publish and Subscribe
+
+- Complete rewrite of the PubSub module. The new PubSub module is
+  plugin-based, allowing developers to create new nodes type. Any
+  application can be plugged to ejabberd and can provide rich presence
+  as a pubsub plugin.
+- Personal Eventing via Pubsub support (XEP-0163). This module is
+  implemented as a PubSub service. It supports user mood (XEP-107),
+  User Tune (XEP-118), user location (XEP-0080) or user avatar
+  (XEP-0084) for example.
+
+
+* Server to Server (s2s)
+
+- More robust code with connection timeout implementation.
+- Support for multiple s2s connections per domain.
+- s2s whitelist and blacklist support.
+- s2s retrial interval.
+
+
+* LDAP
+
+- Many enterprise-class enhancements such as better behaviour under
+  heavy load.
+- Support for LDAP servers pool.
+- Simplified use of virtual hosting with LDAP with domain substitution
+  in config.
+- Ability to match on several userid attributes.
+
+
+* Multi-User Chat
+
+- Clustering and load balancing support.
+- Ability to define default room configuration in ejabberd config file.
+- Many anti abuse features have been added:
+  . New ACL to limit the creation of persistent room to authorized users.
+  . Ability to define the maximum number of users per room.
+  . Limitation of the rate of message and presence packets.
+  . Limitation of the maximum number of room a user can join at the same time.
+
+
+* File Transfer
+
+- XEP-0065 - Proxy65 file transfer proxy. The proxy can run in
+  cluster mode.
+
+
+* Authentication
+
+- PAM (Pluggable Authentication Modules) support on *nix systems.
+- External Authentication protocol is now fully documented.
+
+
+* Web Client Support
+
+- XEP-0124 - BOSH support: BOSH (Bidirectional-streams Over
+  Synchronous HTTP) was formerly known as "HTTP binding". It provides
+  an efficient alternative to HTTP polling for scalable Web based chat
+  solutions.
+- HTTP module can now serve static documents (with
+  mod_http_fileserver). It is needed for high-performance Web 2.0 chat
+  / IM application. System administrators can now avoid using a proxy
+  (like Apache) that handles much less simultaneous than ejabberd HTTP
+  module.
+- Added limitations enforcement on HTTP poll and HTTP bind modules
+  (bandwidth, packet size).
+
+
+* System Administration
+
+- XEP-0133 - Service administration support. System administrators can
+  now perform lot of ejabberd related admin tasks from their XMPP
+  client, through adhoc commands.
+- Dynamic log levels: Improved logging with more log levels. You can
+  now change the loglevel at run time. No performance penalty is
+  involved when less verbose levels are used.
+- The ejabberdctl command-line administration script now can start 
+  and stop ejabberd. It also includes other useful options.
+
+
+* Localization
+
+- ejabberd is now translated to 24 languages: Catalan, Chinese, Czech,
+  Dutch, English, Esperanto, French, Galician, German, Italian, Japanese, 
+  Norwegian, Polish, Portuguese, Portuguese (Brazil), Russian, Slovak, 
+  Spanish, Swedish, Thai, Turkish, Ukrainian, Vietnamese, Walloon.
+
+
+* Build and Installer
+
+- Many launch script improvements.
+- New translations. The binary installer is now available in Chinese,
+  Dutch, English, French, German, Spanish, Russian.
+- Makefile now implements uninstall command.
+- Full MacOSX compliance in Makefile.
+- Configure script is clever at finding libraries in unusual places.
+
+
+* Development API
+
+- Several hooks have been added for module developers (most notably
+  presence related hooks).
+- HTTP request handler to write HTTP based plugins.
+- Manage connections IP address.
+
+
+* Bugfixes
+
+- ejabberd 2.0.0 also fixes numerous small bugs :) Read the full
+  changelog for details.
+
+
+
+   Important Note:
+
+- Since this release, ejabberd requires Erlang R10B-5 or higher. 
+  R11B-5 is the recommended version. R12 is not yet officially 
+  supported, and is not recommended for production servers.
+
+
+
+   Upgrading From ejabberd 1.x:
+
+- If you upgrade from a version older than 1.1.4, please check the
+  Release Notes of the intermediate versions for additional
+  information about database or configuration changes.
+
+- The database schemas didn't change since ejabberd 1.1.4. Of course,
+  you are encouraged to make a database backup of your SQL database,
+  or your Mnesia spool directory before upgrading ejabberd.
+
+- The ejabberdctl command line administration script is improved in
+  ejabberd 2.0.0, and now it can start and stop ejabberd. If you
+  already wrote your own start script for ejabberd 1.x, you can
+  continue using it, or try ejabberdctl. For your convenience, the
+  ejabberd Guide describes all the ejabberd and Erlang options used by
+  ejabberdctl.
+
+- The example ejabberd.cfg file has been reorganized, but its format
+  and syntax rules are the same. So, you can continue using your
+  ejabberd.cfg file from 1.x if you want. The most important changes
+  are described now.
+
+- The 'ssl' option is no longer available in the listening ports. For
+  legacy SSL encryption use the option 'tls'. For STARTTLS encryption
+  as defined in RFC 3920 XMPP-CORE use the option 'starttls'. Check
+  the ejabberd Guide for more information about configuring listening
+  ports.
+
+- The options 'welcome_message' and 'registration_watchers' are now
+  options of the module mod_register. Check in the ejabberd Guide how
+  to configure that module.
+
+- To enable PEP support in mod_pubsub, you need to enable it in the
+  mod_pubsub configuration, and also enable the new module
+  mod_caps. Check the section about mod_pubsub in the ejabberd Guide.
+
+- Other new features and improvements also require changes in the
+  ejabberd.cfg, like mod_http_bind, mod_http_fileserver, mod_proxy65,
+  loglevel, pam_service, and watchdog_admins. Search for those words
+  in the ejabberd Guide and the example ejabberd.cfg.
+
+
+
+   Bug Reports
+
+  You can officially report bugs on Process-one support site:
+  https://support.process-one.net/
+
+
+END

doc/release_notes_2.0.1.txt

@@ -0,0 +1,30 @@
+
+                              Release Notes
+                             ejabberd 2.0.1
+                               20 May 2008
+
+  ejabberd 2.0.1 is a bugfix release for ejabberd 2.0.x branch.
+
+  ejabberd 2.0.1 includes 10 improvements and 32 bugfixes.
+  A complete list of changes can be retrieved from:
+     http://redir.process-one.net/ejabberd-2.0.1
+
+  The new code can be downloaded from ejabberd download page:
+     http://www.process-one.net/en/projects/ejabberd/
+
+
+   Recent changes include:
+
+- Erlang R12 support.
+- Better LDAP handling.
+- PubSub bugfixes.
+- Documentation improvements.
+- inband registration limitation per IP.
+- s2s improvements.
+
+Bugs report
+
+  You can officially report bugs on Process-one support site:
+  http://support.process-one.net/
+
+END

doc/release_notes_2.0.2.txt

@@ -0,0 +1,34 @@
+
+                              Release Notes
+                             ejabberd 2.0.2
+                             28 August 2008
+
+  ejabberd 2.0.2 is the second bug fix release for ejabberd 2.0.x branch.
+
+  ejabberd 2.0.2 includes many bugfixes and a few improvements.
+  A complete list of changes can be retrieved from:
+     http://redir.process-one.net/ejabberd-2.0.2
+
+  The new code can be downloaded from ejabberd download page:
+     http://www.process-one.net/en/ejabberd/
+
+
+  Recent changes include:
+
+- Anti-abuse feature: client blacklist support by IP.
+- Guide: new section Securing ejabberd; improved usability.
+- LDAP filter optimisation: ability to filter user in ejabberd and not LDAP.
+- MUC improvements: room options to restrict visitors; broadcast reasons.
+- Privacy rules: fix MySQL storage.
+- Pub/Sub and PEP: many improvements in implementation and protocol compliance.
+- Proxy65: send valid SOCKS5 reply (removed support for Psi < 0.10).
+- Web server embedded: better support for HTTPS.
+- Binary installers: SMP on Windows; don't remove config when uninstalling.
+
+
+  Bug reports
+
+  You can officially report bugs on ProcessOne support site:
+  http://support.process-one.net/
+
+END

doc/release_notes_2.0.3.txt

@@ -0,0 +1,35 @@
+
+                              Release Notes
+                             ejabberd 2.0.3
+                             14 January 2009
+
+  ejabberd 2.0.3 is the third bugfix release for ejabberd 2.0.x branch.
+
+  ejabberd 2.0.3 includes several bugfixes and a few improvements.
+  A complete list of changes can be retrieved from:
+     http://redir.process-one.net/ejabberd-2.0.3
+
+  The new code can be downloaded from ejabberd download page:
+     http://www.process-one.net/en/ejabberd/
+
+
+  Recent changes include:
+
+- Do not ask certificate for client (c2s)
+- Check digest-uri in SASL digest authentication
+- Use send timeout to avoid locking on gen_tcp:send
+- Fix ejabberd reconnection to database
+- HTTP-Bind: handle wrong order of packets
+- MUC: Improve traffic regulation management
+- PubSub: Several bugfixes and improvements for best coverage of XEP-0060 v1.12
+- Shared Roster Groups: push immediately membership changes
+- Rotate also sasl.log on "reopen-log" command
+- Binary Windows installer: better detect "Error running Post Install Script"
+
+
+  Bug reports
+
+  You can officially report bugs on ProcessOne support site:
+  http://support.process-one.net/
+
+END

doc/release_notes_2.0.4.txt

@@ -0,0 +1,44 @@
+
+                              Release Notes
+                             ejabberd 2.0.4
+
+  ejabberd 2.0.4 is the fourth bugfix release for ejabberd 2.0.x branch.
+
+  ejabberd 2.0.4 includes several bugfixes.
+  A detailed list of changes can be retrieved from:
+     http://redir.process-one.net/ejabberd-2.0.4
+
+  The new code can be downloaded from ejabberd download page:
+     http://www.process-one.net/en/ejabberd/
+
+
+  The changes are:
+
+- Ensure ID attribute in roster push is unique
+- Authentication: Fix Anonymous auth when enabled with broken ODBC
+- Authentication: Unquote correctly backslash in DIGEST-MD5 SASL responses
+- Authentication: Cancel presence subscriptions on account deletion
+- LDAP: Close a connection on tcp_error
+- LDAP: Implemented queue for pending queries
+- LDAP: On failure of LDAP connection, waiting is done on pending queue
+- MUC: Owner of a password protected room must also provide the password
+- MUC: Prevent XSS in MUC logs by linkifying only a few known protocols
+- Privacy rules: Items are now processed in the specified order
+- Privacy rules: Fix to correctly block subscription requests
+- Proxy65: If ip option is not defined, take an IP address of a local hostname
+- PubSub: Add roster subscription handling; send PEP events to all resources
+- PubSub: Allow node creation without configure item
+- PubSub: Requesting items on a node which exists, but empty returns an error
+- PEP: Fix sending notifications to other domains and s2s
+- S2S: Fix problem with encrypted connection to Gtalk and recent Openfire
+- S2S: Workaround to get DNS SRV lookup to work on Windows machine
+- Shared Roster Groups: Fix to not resend authorization request
+- WebAdmin: Fix encryption problem for ejabberd_http after timeout
+
+
+  Bug reports
+
+  You can officially report bugs on ProcessOne support site:
+  http://support.process-one.net/
+
+END

doc/release_notes_2.0.5.txt

@@ -0,0 +1,33 @@
+
+                              Release Notes
+                             ejabberd 2.0.5
+
+  ejabberd 2.0.5 is the fifth bugfix release in ejabberd 2.0.x branch.
+
+  ejabberd 2.0.5 includes three bugfixes.
+  More details of those fixes can be retrieved from:
+     http://redir.process-one.net/ejabberd-2.0.5
+
+  The new code can be downloaded from ejabberd download page:
+     http://www.process-one.net/en/ejabberd/
+
+
+  The changes are:
+
+- Fix two problems introduced in ejabberd 2.0.4: subscription request
+  produced many authorization requests with some clients and
+  transports; and subscription requests were not stored for later
+  delivery when receiver was offline.
+
+- Fix warning in expat_erl.c about implicit declaration of x_fix_buff
+
+- HTTP-Bind (BOSH): Fix a missing stream:error in the returned
+  remote-stream-error stanza
+
+
+  Bug reports
+
+  You can officially report bugs on ProcessOne support site:
+  http://support.process-one.net/
+
+END

doc/release_notes_2.1.0.txt

@@ -0,0 +1,281 @@
+
+                              Release Notes
+                             ejabberd 2.1.0
+
+  ejabberd 2.1.0 is a major new version for ejabberd adding many
+  new features, performance and scalability improvements.
+
+  ejabberd 2.1.0 includes many new features, improvements and bug fixes.
+  A complete list of changes can be retrieved from:
+   http://redir.process-one.net/ejabberd-2.1.0
+
+  The new code can be downloaded from ejabberd download page:
+     http://www.process-one.net/en/ejabberd/
+
+
+  New features and improvements:
+
+* Anti-abuse
+- Captcha support (XEP-0158). The example script uses ImageMagick.
+- New option: registration_timeout to limit registrations by time
+- Use send timeout to avoid locking on gen_tcp:send
+- mod_ip_blacklist: client blacklist support by IP
+
+* API
+- ejabberd_http provides Host, Port, Headers and Protocol in HTTP requests
+- Export function to create MUC room
+- New events: s2s_send_packet and s2s_receive_packet
+- New event: webadmin_user_parse_query when POST in web admin user page
+- Support distributed hooks over the cluster
+
+* Authentification
+- Extauth responses: log strange responses and add timeout
+
+* Binary Installer
+- Includes exmpp library to support import/export XML files
+
+* Caps
+- Remove useless caps tables entries
+- mod_caps must handle correctly external contacts with several resources
+- Complain if mod_caps disabled and mod_pubsub has PEP plugin enabled
+
+* Clustering and Architecture
+
+* Configuration
+- Added option access_max_user_messages for mod_offline
+- Added option backlog for ejabberd_listener to increase TCP backlog
+- Added option define_macro and use_macro
+- Added option include_config_file to include additional configuration files
+- Added option max_fsm_queue
+- Added option outgoing_s2s_options to define IP address families and timeout
+- Added option registration_timeout to ejabberd.cfg.example
+- Added option s2s_dns_options to define DNS timeout and retries
+- Added option ERL_OPTIONS to ejabberdctl.cfg
+- Added option FIREWALL_WINDOW to ejabberdctl.cfg
+- Added option EJABBERD_PID_PATH to ejabberdctl.cfg
+- Deleted option user_max_messages of mod_offline
+- Check certfiles are readable on server start and listener start
+- Config file management mix file reading and sanity check
+- Include example PAM configuration file: ejabberd.pam
+- New ejabberd listener: ejabberd_stun
+- Support to bind the same port to multiple interfaces
+- New syntax to specify the IP address and IPv6 in listeners
+  configuration. The old options {ip,{1,2,3,4}} and inet6 are
+  supported even if they aren't documented.
+- New syntax to specify the network protocol: tcp or udp
+- Report error at startup if a listener module isn't available
+- Only listen in a port when actually ready to serve requests
+- In default config, only local accounts can create rooms and PubSub nodes
+
+* Core architecture
+- More verbose error reporting for xml:element_to_string
+- Deliver messages when first presence is Invisible
+- Better log message when config file is not found
+- Include original timestamp on delayed presences
+
+* Crypto
+- Do not ask certificate for client (c2s)
+- SSL code remove from ejabberd in favor of TLS
+- Support Zlib compression after STARTTLS encryption
+- tls v1 client hello
+
+* Documentation
+- Document possible default MUC room options
+- Document service_check_from in the Guide
+- Document s2s_default_policy and s2s_host in the Guide
+- new command and guide instructions to change node name in a Mnesia database
+
+* ejabberd commands
+- ejabberd commands: separate command definition and calling interface
+- access_commands restricts who can execute what commands and arguments
+- ejabberdctl script now displays help and categorization of commands
+
+* HTTP Binding and HTTP Polling
+- HTTP-Bind: module optimization and clean-up
+- HTTP-Bind: allow configuration of max_inactivity timeout
+- HTTP-Poll: turn session timeout into a config file parameter
+
+* Jingle
+- STUN server that facilitates the client-to-client negotiation process
+
+* LDAP
+- Faster reconnection to LDAP servers
+- LDAP filter optimisation: Add ability to filter user in ejabberd and not LDAP
+- LDAP differentiates failed auth and unavailable auth service
+- Improve LDAP logging
+- LDAPS support using TLS.
+
+* Localization
+- Use Gettext PO for translators, export to ejabberd MSG
+- Support translation files for additional projects
+- Most translations are updated to latest code
+- New translation to Greek language
+
+* Multi-User Chat (MUC)
+- Allow admins to send messages to rooms
+- Allow to store room description
+- Captcha support in MUC: the admin of a room can configure it to
+  require participants to fill a captcha to join the room.
+- Limit number of characters in Room ID, Name and Description
+- Prevent unvoiced occupants from changing nick
+- Support Result Set Management (XEP-0059) for listing rooms
+- Support for decline of invitation to MUC room
+- mod_muc_log options: plaintext format; filename with only room name
+
+* Performance
+- Run roster_get_jid_info only if privacy list has subscription or group item
+- Significant PubSub performance improvements
+
+* Publish-Subscribe
+- Add nodetree filtering/authorization
+- Add subscription option support for collection nodes
+- Allow Multiple Subscriptions
+- Check option of the nodetree instead of checking configuration
+- Implement whitelist authorize and roster access model
+- Implicit item deletion is not notified when deleting node
+- Make PubSub x-data configuration form handles list value
+- Make default node name convention XEP-compatible, document usage of hierarchy
+- Node names are used verbatim, without separating by slash, unless a
+  node plugin uses its own separator
+- Send authorization update event (XEP-0060, 8.6)
+- Support of collection node subscription options
+- Support ODBC storage. Experimental, needs more testing.
+
+* Relational databases:
+- Added MSSQL 2000 and 2005
+- Privacy rules storage in MySQL
+- Implement reliable ODBC transaction nesting
+
+* Source Package
+- Default installation directories changed. Please see the upgrade notes below.
+- Allow more environment variable overrides in ejabberdctl
+- ChangeLog is not edited manually anymore; it's generated automatically.
+- Install the ejabberd Guide
+- Install the ejabberd include files
+- New option for the 'configure' script: --enable-user which installs
+  ejabberd granting permission to manage it to a regular system user;
+  no need to use root account to.
+- Only try to install epam if pam was enabled in configure script
+- Spool, config and log dirs: owner writes, group reads, others do nothing.
+- Provides an example ejabberd.init file
+
+* S2S
+- Option to define s2s outgoing behaviour: IPv4, IPv6 and timeout
+- DNS timeout and retries, configurable with s2s_dns_options.
+
+* Shared rosters
+- When a member is added/removed to group, send roster upgrade to group members
+
+* Users management
+- When account is deleted, cancel presence subscription for all roster items
+
+* XEP Support
+- Added XEP-0059 Result Set Management (for listing rooms)
+- Added XEP-0082 Date Time
+- Added XEP-0085 Chat State Notifications
+- Added XEP-0157 Contact Addresses for XMPP Services
+- Added XEP-0158 CAPTCHA Forms (in MUC rooms)
+- Added STUN server, for XEP-0176: Jingle ICE-UDP Transport Method
+- Added XEP-0199 XMPP Ping
+- Added XEP-0202 Entity Time
+- Added XEP-0203 Delayed Delivery
+- Added XEP-0227 Portable Import/Export Format for XMPP-IM Servers
+- Added XEP-0237 Roster Versioning
+
+* Web Admin
+- Display the connection method of user sessions
+- Cross link of ejabberd users in the list of users and rosters
+- Improved the browsing menu: don't disappear when browsing a host or node
+- Include Last-Modified HTTP header in responses to allow caching
+- Make some Input areas multiline: options of listening ports and modules
+- Support PUT and DELETE methods in ejabberd_http
+- WebAdmin serves Guide and links to related sections
+
+* Web plugins
+- mod_http_fileserver: new option directory_indices, and improve logging
+
+
+   Important Notes:
+
+- ejabberd 2.1.0 requires Erlang R10B-9 or higher.
+  R12B-5 is the recommended version. Support for R13B is experimental.
+
+
+   Upgrading From ejabberd 1.x.x:
+
+- Check the Release Notes of the intermediate versions for additional
+  information about database or configuration changes.
+
+
+   Upgrading From ejabberd 2.0.x:
+
+- The database schemas have three changes since ejabberd 2.0.x.
+  Check the database creation SQL files and update your database.
+  1) New table roster_version to support roster versioning.
+  2) Six new tables for optional pubsub ODBC storage.
+  3) Some tables in the MySQL database have a new created_at column.
+
+- As usual, it is recommended to backup the Mnesia spool directory and
+  your SQL database (if used) before upgrading ejabberd.
+
+- Between ejabberd 2.0.0 and 2.0.5, mod_pubsub used "default" as the
+  default node plugin. But in 2.1.0 this is renamed to "hometree".
+  You have to edit your ejabberd config file and replace those names.
+  If you used ejabberd 2.0.5 or older, the database will be updated
+  automatically. But if you were using ejabberd from SVN, you must
+  manually run ejabberdctl with the command: rename_default_nodeplugin.
+  Running this command on already updated database does nothing.
+
+- The listener options 'ip' and 'inet6' are not documented anymore
+  but they are supported and you can continue using them.
+  There is a new syntax to define IP address and IP version.
+  As usual, check the ejabberd Guide for more information.
+
+- The log file sasl.log is now called erlang.log
+
+- ejabberdctl commands now have _ characters instead of -.
+  For backwards compatibility, it is still supported -.
+
+- mod_offline has a new option: access_max_user_messages.
+  The old option user_max_messages is no longer supported.
+
+- If you upgrade from ejabberd trunk SVN, you must execute this:
+  $ ejabberdctl rename_default_nodeplugin
+
+- Default installation directories changed a bit:
+  * The Mnesia spool files that were previously stored in
+      /var/lib/ejabberd/db/NODENAME/*
+    are now stored in
+      /var/lib/ejabberd/*
+  * The directories
+      /var/lib/ejabberd/ebin
+      /var/lib/ejabberd/priv
+    and their content is now installed as
+      /lib/ejabberd/ebin
+      /lib/ejabberd/priv
+  * There is a new directory with Erlang header files:
+      /lib/ejabberd/include
+  * There is a new directory for ejabberd documentation,
+    which includes the Admin Guide and the release notes::
+      /share/doc/ejabberd
+
+- How to upgrade from previous version to ejabberd 2.1.0:
+  1. Stop the old instance of ejabberd.
+  2. Run 'make install' of new ejabberd 2.1.0 to create the new directories.
+  3. Copy the content of your old directory:
+       /var/lib/ejabberd/db/NODENAME/
+     to the new location:
+       /var/lib/ejabberd/
+     so you will have the files like this:
+       /var/lib/ejabberd/acl.DCD ...
+  4. You can backup the content of those directories and delete them:
+       /var/lib/ejabberd/ebin
+       /var/lib/ejabberd/priv
+       /var/lib/ejabberd/db
+  5. Now try to start your new ejabberd 2.1.0.
+
+
+  Bug reports
+
+  You can officially report bugs on ProcessOne support site:
+  http://support.process-one.net/

doc/release_notes_2.1.1.txt

@@ -0,0 +1,47 @@
+
+                              Release Notes
+                             ejabberd 2.1.1
+
+  ejabberd 2.1.1 is the first bugfix release in ejabberd 2.1.x branch.
+
+  ejabberd 2.1.1 includes several important bugfixes.
+  More details of those fixes can be retrieved from:
+     http://redir.process-one.net/ejabberd-2.1.1
+
+  The new code can be downloaded from ejabberd download page:
+     http://www.process-one.net/en/ejabberd/
+
+
+  The changes are:
+
+* Core
+- Call ejabberd_router:route/3 instead of sending a message
+- Can't connect if starttls_required and zlib are set
+- Routes vCard request to the occupant full JID, but should to bare JID
+- S2S: fix allow_host/2 on subdomains. added hook s2s_allow_host
+
+* MUC
+- Support converting one-to-one chat to MUC
+- Add support for serving a Unique Room Name
+
+* Publish Subscribe
+- Receive same last published PEP items at reconnect if several resources online
+- Typo in mod_pubsub_odbc breaks Service Discovery and more
+
+* Web
+- Fix memory and port leak when TLS is enabled in HTTP
+- WebAdmin doesn't report correct last activity with postgresql backend
+- Option to define custom HTTP headers in mod_http_fileserver
+- Show informative webpage when browsing the HTTP-Poll page
+
+* Other
+- Change captcha.sh to not depend on bash
+- Generate main XML file also when exporting only a vhost
+- Fix last newline in ejabberdctl result
+- Guide: fix -setcookie, mod_pubsub_odbc host, content_types
+
+
+  Bug reports
+
+  You can officially report bugs on ProcessOne support site:
+  http://support.process-one.net/

doc/release_notes_2.1.2.txt

@@ -0,0 +1,51 @@
+
+                              Release Notes
+                             ejabberd 2.1.2
+
+  ejabberd 2.1.2 is the second bugfix release in ejabberd 2.1.x branch.
+
+  ejabberd 2.1.2 includes several bugfixes.
+  More details of those fixes can be retrieved from:
+     http://redir.process-one.net/ejabberd-2.1.2
+
+  The new code can be downloaded from ejabberd download page:
+     http://www.process-one.net/en/ejabberd/
+
+
+  The major changes are:
+
+* Core
+- Close sessions that were half connected
+- Fix SASL PLAIN authentication message for RFC4616 compliance
+- Fix support for old Erlang/OTP R10 and R11
+- Return proper error (not 'conflict') when register is forbidden by ACL
+- When ejabberd stops, send stream close to clients
+
+* ejabberdctl
+- Check for EGID in ejabberdctl command
+- Command to stop ejabberd informing users, with grace period
+- If there's a problem in config file, display config lines and stop node
+
+* MUC
+- Kick occupants with reason when room is stopped due to MUC shutdown
+- Write in room log when a room is created, destroyed, started, stopped
+
+* PubSub and PEP
+- Don't call gen_server on internal event (improves performance and scalability)
+- Fix duplicate SHIM header in Pubsub message
+- Notification messages of Pubsub node config change contained a SHIM header
+- SubID SHIM header missing in Pubsub message with multiple
+  subscriptions on the same node
+- PEP: last published item not sent from unavailable users when the
+  subscription is implicit (XEP-0115)
+- pep_mapping not working due to Node type mismatch
+
+* WebAdmin
+- If big offline message queue, show only subset on WebAdmin
+- Support in user list page of WebAdmin when mod_offline is disabled
+
+
+  Bug reports
+
+  You can officially report bugs on ProcessOne support site:
+  http://support.process-one.net/

doc/release_notes_2.1.3.txt

@@ -0,0 +1,91 @@
+
+                              Release Notes
+                             ejabberd 2.1.3
+
+  ejabberd 2.1.3 is the third release in ejabberd 2.1.x branch.
+
+  ejabberd 2.1.3 includes many bugfixes, and some improvements.
+  More details of those fixes can be retrieved from:
+     http://redir.process-one.net/ejabberd-2.1.3
+
+  The new code can be downloaded from ejabberd download page:
+     http://www.process-one.net/en/ejabberd/
+
+
+  This is the full list of changes:
+
+* Client connections
+- Avoid 'invalid' value in iq record
+- Avoid resending stream:error stanzas on terminate (EJAB-1180)
+- Close also legacy sessions that were half connected (EJAB-1165)
+- iq_query_info/1 now returns 'invalid' if XMLNS is invalid
+- New ejabberd_c2s option support: max_fsm_queue
+- Rewrite mnesia counter functions to use dirty_update_counter (EJAB-1177)
+- Run user_receive_packet also when sending offline messages (EJAB-1193)
+- Use p1_fsm behaviour in c2s FSM (EJAB-1173)
+
+* Clustering
+- Fix cluster race condition in route read
+- New command to set master Mnesia node
+- Use mnesia:async_dirty when cleaning table from failed node
+
+* Documentation
+- Add quotes in documentation of some erl arguments (EJAB-1191)
+- Add option access_from (EJAB-1187)
+- Add option max_fsm_queue (EJAB-1185)
+- Fix documentation installation, no need for executable permission (EJAB-1170)
+- Fix typo in EJABBERD_BIN_PATH (EJAB-891)
+- Fix typos in example config comments (EJAB-1192)
+
+* ejabberdctl
+- Support concurrent connections with bound connection names
+- Add support for Jot in ctl and TTY in debug
+- Support help command names with old - characters
+- Fix to really use the variable ERL_PROCESSES
+
+* Erlang compatibility
+- Don't call queue:filter/2 to keep compatibility with older Erlang versions
+- Use alternative of file:read_line/1 to not require R13B02
+
+* HTTP
+- Add new debugging hook to the http receiving process
+- Allow a request_handler to serve a file in root of HTTP
+
+* HTTP-Bind (BOSH)
+- Cross-domain HTTP-Bind support (EJAB-1168)
+- Hibernate http-bind process after handling a request
+- Reduce verbosity of HTTP Binding log messages
+
+* LDAP
+- Document ldap_dn_filter, fetch only needed attributes in search (EJAB-1204)
+- Use "%u" pattern as default for ldap_uids (EJAB-1203)
+
+* Localization
+- Fix German translation (EJAB-1195)
+- Fix Russian translation
+
+* ODBC
+- Fix MSSQL support, which was broken (EJAB-1201)
+- Improved SQL reconnect behaviour
+
+* Pubsub, PEP and Caps
+- Add extended stanza addressing 'replyto' on PEP (EJAB-1198)
+- Add pubsub#purge_offline (EJAB-1186)
+- Fix pubsub#title option (EJAB-1190)
+- Fix remove_user for node subscriptions (EJAB-1172)
+- Optimizations in mod_caps
+
+* Other
+- mod_register: Add new acl access_from, default is to deny
+- mod_sic: new module for the experimental XEP-0279 Server IP Check (EJAB-1205)
+- PIEFXIS: Catch errors when exporting to PIEFXIS file (EJAB-1178)
+- Proxy65: new option "hostname" (EJAB-838)
+- Roster: Fix resending authorization problem
+- Shared Roster Groups: get contacts nickname from vcard (EJAB-114)
+- S2S: Improved s2s connections clean up (EJAB-1202)
+
+
+  Bug reports
+
+  You can officially report bugs on ProcessOne support site:
+  http://support.process-one.net/

doc/release_notes_2.1.4.txt

@@ -0,0 +1,80 @@
+
+                              Release Notes
+                             ejabberd 2.1.4
+
+  ejabberd 2.1.4 is the fourth release in ejabberd 2.1.x branch,
+  and includes many small bugfixes and improvements.
+
+  Read more details about the changes in:
+    http://redir.process-one.net/ejabberd-2.1.4
+
+  Download the source code and installers from:
+    http://www.process-one.net/en/ejabberd/
+
+
+  This is the full list of changes:
+
+* Authentication
+- Extauth: Optionally cache extauth users in mnesia (EJAB-641)
+- LDAP: Allow inband password change (EJAB-199)
+- LDAP: Extensible match support (EJAB-722)
+- LDAP: New option ldap_tls_verify is added (EJAB-1229)
+- PAM: New option pam_userinfotype to provide username or JID (EJAB-652)
+
+* HTTP
+- Add xml default content type
+- Don't show HTTP request in logs, because reveals password (EJAB-1231)
+- Move HTTP session timeout log from warning level to info
+- New Access rule webadmin_view for read-only
+
+* HTTP-Bind (BOSH)
+- Change max inactivity from 30 to 120 seconds
+- Export functions to facilitate prebinding methods
+- Use dirty_delete when removing the session
+- Remove an unneeded delay of 100 milliseconds
+
+* Pubsub, PEP and Caps
+- Enforce pubsub#presence_based_delivery (EJAB-1221)
+- Enforce pubsub#show_values subscription option (EJAB-1096)
+- Fix error code when unsubscribing from a non-existent node
+- Fix to send node notifications (EJAB-1225)
+- Full support for XEP-0115 v1.5 (EJAB-1223)(EJAB-1189)
+- Make last_item_cache feature to be cluster aware
+- Prevent orphaned pubsub node (EJAB-1233)
+- Send created node notifications
+
+* Other
+- Bounce messages when closing c2s session
+- Bugfixes when handling Service Discovery to contacts (EJAB-1207)
+- Compilation of ejabberd_debug.erl is now optional
+- Don't send error stanza as reply to error stanza (EJAB-930)
+- Don't store blocked messages in offline queue
+- Reduce verbosity of log when captcha_cmd is checked but not configured
+- Use a standard method to get a random seed (EJAB-1229)
+- Commands: new update_list and update to update modified modules (EJAB-1237)
+- Localization: Updated most translations
+- MUC: Refactor code to reduce calls to get_affiliation and get_role
+- ODBC: Add created_at column also to PostgreSQL schema
+- Vcard: Automatic vcard avatar addition in presence
+
+
+   Upgrading From previous ejabberd releases:
+
+- If you use PostgreSQL, maybe you want to add the column created_at
+  to several tables. This is only a suggestion; ejabberd doesn't use
+  that column.  Add it to your existing database executing those SQL
+  statements:
+
+ALTER TABLE users ADD COLUMN created_at TIMESTAMP NOT NULL DEFAULT now();
+ALTER TABLE rosterusers ADD COLUMN created_at TIMESTAMP NOT NULL DEFAULT now();
+ALTER TABLE spool ADD COLUMN created_at TIMESTAMP NOT NULL DEFAULT now();
+ALTER TABLE vcard ADD COLUMN created_at TIMESTAMP NOT NULL DEFAULT now();
+ALTER TABLE privacy_list ADD COLUMN created_at TIMESTAMP NOT NULL DEFAULT now();
+ALTER TABLE privacy_storage ADD COLUMN created_at TIMESTAMP NOT NULL DEFAULT now();
+
+
+  Bug reports
+
+  You can officially report bugs on ProcessOne support site:
+  http://support.process-one.net/
+

doc/release_notes_2.1.5.txt

@@ -0,0 +1,70 @@
+
+                              Release Notes
+                             ejabberd 2.1.5
+
+  ejabberd 2.1.5 is the fifth release in ejabberd 2.1.x branch,
+  and includes several minor bugfixes and a few improvements.
+
+  Read more details about the changes in:
+    http://redir.process-one.net/ejabberd-2.1.4
+
+  Download the source code and installers from:
+    http://www.process-one.net/en/ejabberd/
+
+
+  This is the full list of changes:
+
+* Authentication
+- Extauth: Support parallel script running (EJAB-1280)
+- mod_register: Return Registered element when account exists
+
+* ejabberdctl
+- Fix print of command result that contains ~
+- Fix problem when FIREWALL_WINDOW options for erl kernel were used
+- Fix typo in update_list command (EJAB-1237)
+- Some systems delete the lock dir; in such case don't use flock at all
+- The command Update now returns meaningful message and exit-status (EJAB-1237)
+
+* HTTP-Bind (BOSH)
+- Don't say v1.2 in the Bind HTTP page
+- New optional BOSH connection attribute process-delay (EJAB-1257)
+
+* MUC
+- Document the mod_muc option captcha_protected
+- Now admins are able to see private rooms in disco (EJAB-1269)
+- Show some more room options in the log file
+
+* ODBC
+- Correct handling of SQL boolean types (EJAB-1275)
+- Discard too old queued requests (the caller has already got a timeout)
+- Fixes wrong SQL escaping when --enable-full-xml is set
+- Use ets insead of asking supervisor in ejabberd_odbc_sup:get_pids/1
+
+* Pubsub, PEP and Caps
+- Enforce disco features results (EJAB-1033, EJAB-1228, EJAB-1238)
+- Support all the hash functions required by Caps XEP-0115
+
+* Requirements
+- Fixed support for Erlang R12; which doesn't support: true andalso ok
+- Support OTP R14A by using public_key library instead of old ssl (EJAB-953)
+- Requirement of OpenSSL increased from 0.9.6 to 0.9.8
+- OpenSSL is now required, not optional
+
+* Other
+- Don't ask for client certificate when using tls (EJAB-1267)
+- Fix typo in --enable-transient_supervisors
+- Fix privacy check when serving local Last (EJAB-1271)
+- Inform client that SSL session caching is disabled
+- New configure option: --enable-nif
+- Use driver allocator in C files for reflecting memory in erlang:memory(system)
+- Debug: New p1_prof compiled with: make debugtools=true
+- Debug: Added functions to collect stats about queues, memory, reductions etc
+- HTTP: Log error if request has ambiguous Host header (EJAB-1261)
+- Logs: When logging s2s out connection attempt or success, log if TLS is used
+- Shared Rosters: When account is deleted, delete also member of stored rosters
+
+
+  Bug reports
+
+  You can officially report bugs on ProcessOne support site:
+  http://support.process-one.net/

doc/version.tex

@@ -1,2 +1,2 @@
-% Define ejabberd version here.
-\newcommand{\version}{1.1.1}
+% ejabberd version (automatically generated).
+\newcommand{\version}{2.1.5}

examples/extauth/check_pass_null.pl

@@ -1,4 +1,4 @@
-#!/usr/local/bin/perl
+#!/usr/bin/perl
 
 use Unix::Syslog qw(:macros :subs);
 
@@ -18,7 +18,7 @@ while(1)
     my $len = unpack "n",$buf;
     my $nread = sysread STDIN,$buf,$len;
 
-    my ($op,$user,$password) = split /:/,$buf;
+    my ($op,$user,$host,$password) = split /:/,$buf;
     #$user =~ s/\./\//og;
     my $jid = "$user\@$domain";
     my $result;

src/.cvsignore

@@ -1 +0,0 @@
-*.beam

src/Makefile.in

@@ -12,44 +12,139 @@ ERLANG_CFLAGS= @ERLANG_CFLAGS@
 EXPAT_LIBS = @EXPAT_LIBS@
 ERLANG_LIBS = @ERLANG_LIBS@
 
-# make debug=true to compile Erlang module with debug informations.
-ifdef debug
-  ERLC_FLAGS+=+debug_info
+ASN_FLAGS = -bber_bin +der +compact_bit_string +optimize +noobj
+
+INSTALLUSER=@INSTALLUSER@
+# if no user was enabled, don't set privileges or ownership
+ifeq ($(INSTALLUSER),)
+  O_USER=
+  G_USER=
+  CHOWN_COMMAND=echo
+  CHOWN_OUTPUT=/dev/null
+  INIT_USER=root
+else
+  O_USER=-o $(INSTALLUSER)
+  G_USER=-g $(INSTALLUSER)
+  CHOWN_COMMAND=chown
+  CHOWN_OUTPUT=&1
+  INIT_USER=$(INSTALLUSER)
 endif
 
-ifdef ejabberd_debug
-  ERLC_FLAGS+=-Dejabberd_debug
+EFLAGS += @ERLANG_SSLVER@ -pa .
+
+# make debug=true to compile Erlang module with debug informations.
+ifdef debug
+  EFLAGS+=+debug_info +export_all
+endif
+
+DEBUGTOOLS = p1_prof.erl
+ifdef debugtools
+  SOURCES+=$(DEBUGTOOLS)
+endif
+
+ifeq (@hipe@, true)
+  EFLAGS+=+native
 endif
 
 ifeq (@roster_gateway_workaround@, true)
-  ERLC_FLAGS+=-DROSTER_GATEWAY_WORKAROUND
+  EFLAGS+=-DROSTER_GATEWAY_WORKAROUND
+endif
+
+ifeq (@full_xml@, true)
+  EFLAGS+=-DFULL_XML_SUPPORT
+endif
+
+ifeq (@nif@, true)
+  EFLAGS+=-DNIF
+  ERLSHLIBS=xml.so
+endif
+
+ifeq (@transient_supervisors@, false)
+  EFLAGS+=-DNO_TRANSIENT_SUPERVISORS
+endif
+
+INSTALL_EPAM=
+ifeq (@pam@, pam)
+  INSTALL_EPAM=install -m 750 $(O_USER) epam $(PBINDIR)
 endif
 
 prefix = @prefix@
+exec_prefix = @exec_prefix@
 
-SUBDIRS = @mod_irc@ @mod_pubsub@ @mod_muc@ @eldap@ @web@ stringprep @tls@ @odbc@ @ejabberd_zlib@
-ERLSHLIBS = expat_erl.so
-SOURCES = $(wildcard *.erl)
+SUBDIRS = @mod_irc@ @mod_pubsub@ @mod_muc@ @mod_proxy65@ @eldap@ @pam@ @web@ stringprep stun @tls@ @odbc@ @ejabberd_zlib@
+ERLSHLIBS += expat_erl.so
+ERLBEHAVS = cyrsasl.erl gen_mod.erl p1_fsm.erl
+SOURCES_ALL = $(wildcard *.erl)
+SOURCES_MISC = $(ERLBEHAVS) $(DEBUGTOOLS)
+SOURCES += $(filter-out $(SOURCES_MISC),$(SOURCES_ALL))
+ERLBEHAVBEAMS = $(ERLBEHAVS:.erl=.beam)
 BEAMS = $(SOURCES:.erl=.beam)
 
-DESTDIR = 
+DESTDIR =
 
-EJABBERDDIR = $(DESTDIR)@prefix@/var/lib/ejabberd
+# /etc/ejabberd/
+ETCDIR = $(DESTDIR)@sysconfdir@/ejabberd
+
+# /sbin/
+SBINDIR = $(DESTDIR)@sbindir@
+
+# /lib/ejabberd/
+EJABBERDDIR = $(DESTDIR)@libdir@/ejabberd
+
+# /share/doc/ejabberd
+PACKAGE_TARNAME = @PACKAGE_TARNAME@
+datarootdir = @datarootdir@
+DOCDIR = $(DESTDIR)@docdir@
+
+# /usr/lib/ejabberd/ebin/
 BEAMDIR = $(EJABBERDDIR)/ebin
-PRIVDIR = $(EJABBERDDIR)/priv
-SODIR = $(PRIVDIR)/lib
-MSGSDIR = $(PRIVDIR)/msgs
-LOGDIR = $(DESTDIR)@prefix@/var/log/ejabberd
-ETCDIR = $(DESTDIR)@prefix@/etc/ejabberd
 
-ASN_FLAGS = -bber_bin +der +compact_bit_string +optimize +noobj
+# /usr/lib/ejabberd/include/
+INCLUDEDIR = $(EJABBERDDIR)/include
+
+# /usr/lib/ejabberd/priv/
+PRIVDIR = $(EJABBERDDIR)/priv
+
+# /usr/lib/ejabberd/priv/bin
+PBINDIR = $(PRIVDIR)/bin
+
+# /usr/lib/ejabberd/priv/lib
+SODIR = $(PRIVDIR)/lib
+
+# /usr/lib/ejabberd/priv/msgs
+MSGSDIR = $(PRIVDIR)/msgs
+
+# /var/lib/ejabberd/
+SPOOLDIR = $(DESTDIR)@localstatedir@/lib/ejabberd
+
+# /var/lock/ejabberdctl
+CTLLOCKDIR = $(DESTDIR)@localstatedir@/lock/ejabberdctl
+
+# /var/lib/ejabberd/.erlang.cookie
+COOKIEFILE = $(SPOOLDIR)/.erlang.cookie
+
+# /var/log/ejabberd/
+LOGDIR = $(DESTDIR)@localstatedir@/log/ejabberd
+
+# Assume Linux-style dynamic library flags
+DYNAMIC_LIB_CFLAGS = -fpic -shared
+ifeq ($(shell uname),Darwin)
+    DYNAMIC_LIB_CFLAGS = -fPIC -bundle -flat_namespace -undefined suppress
+endif
+ifeq ($(shell uname),SunOs)
+    DYNAMIC_LIB_CFLAGS = -KPIC -G -z text
+endif
 
 all: $(ERLSHLIBS) compile-beam all-recursive
 
-compile-beam: XmppAddr.hrl $(BEAMS)
+compile-beam: XmppAddr.hrl $(ERLBEHAVBEAMS) $(BEAMS)
+
+$(BEAMS): $(ERLBEHAVBEAMS)
+
+all-recursive: $(ERLBEHAVBEAMS)
 
 %.beam:       %.erl
-	@ERLC@ -W $(ERLC_FLAGS) $<
+	@ERLC@ -W $(EFLAGS) $<
 
 
 all-recursive install-recursive uninstall-recursive \
@@ -64,39 +159,151 @@ mostlyclean-recursive maintainer-clean-recursive:
 
 %.hrl: %.asn1
 	@ERLC@ $(ASN_FLAGS) $<
+	@ERLC@ -W $(EFLAGS) $*.erl
 
 $(ERLSHLIBS):	%.so:	%.c
-			gcc -Wall $(CFLAGS) $(LDFLAGS) $(LIBS) \
-			$(subst ../,,$(subst .so,.c,$@)) \
-			$(EXPAT_LIBS) $(EXPAT_CFLAGS) \
-			$(ERLANG_LIBS) $(ERLANG_CFLAGS) \
-			-o $@ -fpic -shared
+	$(CC) $(CFLAGS) $(LDFLAGS) $(LIBS) \
+		$(subst ../,,$(subst .so,.c,$@)) \
+		$(EXPAT_LIBS) \
+		$(EXPAT_CFLAGS) \
+		$(ERLANG_LIBS) \
+		$(ERLANG_CFLAGS) \
+		-o $@ \
+		$(DYNAMIC_LIB_CFLAGS)
+
+translations:
+	../contrib/extract_translations/prepare-translation.sh -updateall
 
 install: all
+	#
+	# Configuration files
+	install -d -m 750 $(G_USER) $(ETCDIR)
+	[ -f $(ETCDIR)/ejabberd.cfg ] \
+		&& install -b -m 640 $(G_USER) ejabberd.cfg.example $(ETCDIR)/ejabberd.cfg-new \
+		|| install -b -m 640 $(G_USER) ejabberd.cfg.example $(ETCDIR)/ejabberd.cfg
+	sed -e "s*@rootdir@*@prefix@*" \
+		-e "s*@installuser@*@INSTALLUSER@*" \
+		-e "s*@LIBDIR@*@libdir@*" \
+		-e "s*@SYSCONFDIR@*@sysconfdir@*" \
+		-e "s*@LOCALSTATEDIR@*@localstatedir@*" \
+		-e "s*@DOCDIR@*@docdir@*" \
+		-e "s*@erl@*@ERL@*" ejabberdctl.template \
+		> ejabberdctl.example
+	[ -f $(ETCDIR)/ejabberdctl.cfg ] \
+		&& install -b -m 640 $(G_USER) ejabberdctl.cfg.example $(ETCDIR)/ejabberdctl.cfg-new \
+		|| install -b -m 640 $(G_USER) ejabberdctl.cfg.example $(ETCDIR)/ejabberdctl.cfg
+	install -b -m 644 $(G_USER) inetrc $(ETCDIR)/inetrc
+	#
+	# Administration script
+	[ -d $(SBINDIR) ] || install -d -m 755 $(SBINDIR)
+	install -m 550 $(G_USER) ejabberdctl.example $(SBINDIR)/ejabberdctl
+	#
+	# Init script
+	sed -e "s*@ctlscriptpath@*$(SBINDIR)*" \
+		-e "s*@installuser@*$(INIT_USER)*" ejabberd.init.template \
+		> ejabberd.init
+	#
+	# Binary Erlang files
 	install -d $(BEAMDIR)
+	install -m 644 *.app $(BEAMDIR)
 	install -m 644 *.beam $(BEAMDIR)
 	rm -f $(BEAMDIR)/configure.beam
-	install -m 644 *.app $(BEAMDIR)
+	#
+	# ejabberd header files
+	install -d $(INCLUDEDIR)
+	install -m 644 *.hrl $(INCLUDEDIR)
+	install -d $(INCLUDEDIR)/eldap/
+	install -m 644 eldap/*.hrl $(INCLUDEDIR)/eldap/
+	install -d $(INCLUDEDIR)/mod_muc/
+	install -m 644 mod_muc/*.hrl $(INCLUDEDIR)/mod_muc/
+	install -d $(INCLUDEDIR)/mod_proxy65/
+	install -m 644 mod_proxy65/*.hrl $(INCLUDEDIR)/mod_proxy65/
+	install -d $(INCLUDEDIR)/mod_pubsub/
+	install -m 644 mod_pubsub/*.hrl $(INCLUDEDIR)/mod_pubsub/
+	install -d $(INCLUDEDIR)/web/
+	install -m 644 web/*.hrl $(INCLUDEDIR)/web/
+	#
+	# Binary C programs
+	install -d $(PBINDIR)
+	install -m 750 $(O_USER) ../tools/captcha.sh $(PBINDIR)
+	$(INSTALL_EPAM)
+	#
+	# Binary system libraries
 	install -d $(SODIR)
 	install -m 644 *.so $(SODIR)
+	#
+	# Translated strings
 	install -d $(MSGSDIR)
 	install -m 644 msgs/*.msg $(MSGSDIR)
-	install -d $(ETCDIR)
-	install -b -m 644 ejabberd.cfg.example $(ETCDIR)/ejabberd.cfg
-	install -d $(LOGDIR)
+	#
+	# Spool directory
+	install -d -m 750 $(O_USER) $(SPOOLDIR)
+	$(CHOWN_COMMAND) -R @INSTALLUSER@ $(SPOOLDIR) >$(CHOWN_OUTPUT)
+	chmod -R 750 $(SPOOLDIR)
+	[ ! -f $(COOKIEFILE) ] || { $(CHOWN_COMMAND) @INSTALLUSER@ $(COOKIEFILE) >$(CHOWN_OUTPUT) ; chmod 400 $(COOKIEFILE) ; }
+	#
+	# ejabberdctl lock directory
+	install -d -m 750 $(O_USER) $(CTLLOCKDIR)
+	$(CHOWN_COMMAND) -R @INSTALLUSER@ $(CTLLOCKDIR) >$(CHOWN_OUTPUT)
+	chmod -R 750 $(CTLLOCKDIR)
+	#
+	# Log directory
+	install -d -m 750 $(O_USER) $(LOGDIR)
+	$(CHOWN_COMMAND) -R @INSTALLUSER@ $(LOGDIR) >$(CHOWN_OUTPUT)
+	chmod -R 750 $(LOGDIR)
+	#
+	# Documentation
+	install -d $(DOCDIR)
+	install -m 644 ../doc/dev.html $(DOCDIR)
+	install -m 644 ../doc/guide.html $(DOCDIR)
+	install -m 644 ../doc/*.png $(DOCDIR)
+	install -m 644 ../doc/*.txt $(DOCDIR)
+	[ -f ../doc/guide.pdf ] \
+		&& install -m 644 ../doc/guide.pdf $(DOCDIR) \
+		|| echo "No ../doc/guide.pdf was built"
+	install -m 644 ../COPYING $(DOCDIR)
+
+uninstall: uninstall-binary
+
+uninstall-binary:
+	rm -f  $(SBINDIR)/ejabberdctl
+	rm -fr $(DOCDIR)
+	rm -f  $(BEAMDIR)/*.beam
+	rm -f  $(BEAMDIR)/*.app
+	rm -fr $(BEAMDIR)
+	rm -f  $(INCLUDEDIR)/*.hrl
+	rm -fr $(INCLUDEDIR)
+	rm -fr $(PBINDIR)
+	rm -f  $(SODIR)/*.so
+	rm -fr $(SODIR)
+	rm -f  $(MSGSDIR)/*.msgs
+	rm -fr $(MSGSDIR)
+	rm -fr $(PRIVDIR)
+	rm -fr $(EJABBERDDIR)
+
+uninstall-all: uninstall-binary
+	rm -rf $(ETCDIR)
+	rm -rf $(EJABBERDDIR)
+	rm -rf $(SPOOLDIR)
+	rm -rf $(CTLLOCKDIR)
+	rm -rf $(LOGDIR)
 
 clean: clean-recursive clean-local
 
 clean-local:
-	rm -f *.beam $(ERLSHLIBS)
+	rm -f *.beam $(ERLSHLIBS) epam ejabberdctl.example
 	rm -f XmppAddr.asn1db XmppAddr.erl XmppAddr.hrl
 
 distclean: distclean-recursive clean-local
 	rm -f config.status
 	rm -f config.log
 	rm -f Makefile
+	[ ! -f ../ChangeLog ] || rm -f ../ChangeLog
 
 TAGS:
 	etags *.erl
 
 Makefile: Makefile.in
+
+dialyzer: $(BEAMS)
+	@dialyzer -c .

src/Makefile.win32

@@ -59,10 +59,16 @@ release : build release_clean
 	copy mod_muc\*.erl $(SRC_DIR)\mod_muc
 	mkdir $(SRC_DIR)\mod_pubsub
 	copy mod_pubsub\*.erl $(SRC_DIR)\mod_pubsub
+	mkdir $(SRC_DIR)\mod_proxy65
+	copy mod_proxy65\*.erl $(SRC_DIR)\mod_proxy65
+	copy mod_proxy65\*.hrl $(SRC_DIR)\mod_proxy65
 	mkdir $(SRC_DIR)\stringprep
 	copy stringprep\*.erl $(SRC_DIR)\stringprep
 	copy stringprep\*.c $(SRC_DIR)\stringprep
 	copy stringprep\*.tcl $(SRC_DIR)\stringprep
+	mkdir $(SRC_DIR)\stun
+	copy stun\*.erl $(SRC_DIR)\stun
+	copy stun\*.hrl $(SRC_DIR)\stun
 	mkdir $(SRC_DIR)\tls
 	copy tls\*.erl $(SRC_DIR)\tls
 	copy tls\*.c $(SRC_DIR)\tls
@@ -94,8 +100,12 @@ all-recursive :
 	nmake -nologo -f Makefile.win32
 	cd ..\mod_pubsub
 	nmake -nologo -f Makefile.win32
+	cd ..\mod_proxy65
+	nmake -nologo -f Makefile.win32
 	cd ..\stringprep
 	nmake -nologo -f Makefile.win32
+	cd ..\stun
+	nmake -nologo -f Makefile.win32
 	cd ..\tls
 	nmake -nologo -f Makefile.win32
 	cd ..\ejabberd_zlib
@@ -133,8 +143,12 @@ clean-recursive :
 	nmake -nologo -f Makefile.win32 clean
 	cd ..\mod_pubsub
 	nmake -nologo -f Makefile.win32 clean
+	cd ..\mod_proxy65
+	nmake -nologo -f Makefile.win32 clean
 	cd ..\stringprep
 	nmake -nologo -f Makefile.win32 clean
+	cd ..\stun
+	nmake -nologo -f Makefile.win32 clean
 	cd ..\tls
 	nmake -nologo -f Makefile.win32 clean
 	cd ..\ejabberd_zlib
@@ -159,5 +173,4 @@ $(DLL) : $(OBJECT)
 	$(LD) $(LD_FLAGS) -out:$(DLL) $(OBJECT)
 
 $(OBJECT) : $(SOURCE)
-    	$(CC) $(CC_FLAGS) -c -Fo$(OBJECT) $(SOURCE) 
-
+	$(CC) $(CC_FLAGS) -c -Fo$(OBJECT) $(SOURCE)

src/acl.erl

@@ -1,14 +1,31 @@
 %%%----------------------------------------------------------------------
 %%% File    : acl.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : ACL support
-%%% Created : 18 Jan 2003 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created : 18 Jan 2003 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(acl).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -export([start/0,
 	 to_record/3,
@@ -31,12 +48,12 @@ start() ->
     ok.
 
 to_record(Host, ACLName, ACLSpec) ->
-    #acl{aclname = {ACLName, Host}, aclspec = ACLSpec}.
+    #acl{aclname = {ACLName, Host}, aclspec = normalize_spec(ACLSpec)}.
 
 add(Host, ACLName, ACLSpec) ->
     F = fun() ->
 		mnesia:write(#acl{aclname = {ACLName, Host},
-				  aclspec = ACLSpec})
+				  aclspec = normalize_spec(ACLSpec)})
 	end,
     mnesia:transaction(F).
 
@@ -58,7 +75,7 @@ add_list(Host, ACLs, Clear) ->
 					       aclspec = ACLSpec} ->
 					      mnesia:write(
 						#acl{aclname = {ACLName, Host},
-						     aclspec = ACLSpec})
+						     aclspec = normalize_spec(ACLSpec)})
 				      end
 			      end, ACLs)
 	end,
@@ -69,6 +86,17 @@ add_list(Host, ACLs, Clear) ->
 	    false
     end.
 
+normalize(A) ->
+    jlib:nodeprep(A).
+normalize_spec({A, B}) ->
+    {A, normalize(B)};
+normalize_spec({A, B, C}) ->
+    {A, normalize(B), normalize(C)};
+normalize_spec(all) ->
+    all;
+normalize_spec(none) ->
+    none.
+
 
 
 match_rule(global, Rule, JID) ->
@@ -115,7 +143,7 @@ match_rule(Host, Rule, JID) ->
 	    end
     end.
 
-match_acls([], _, Host) ->
+match_acls([], _, _Host) ->
     deny;
 match_acls([{Access, ACL} | ACLs], JID, Host) ->
     case match_acl(ACL, JID, Host) of
@@ -145,16 +173,24 @@ match_acl(ACL, JID, Host) ->
 				      (U == User) andalso (S == Server);
 				  {server, S} ->
 				      S == Server;
+				  {resource, R} ->
+				      R == Resource;
 				  {user_regexp, UR} ->
 				      ((Host == Server) orelse
 				       ((Host == global) andalso
 					lists:member(Server, ?MYHOSTS)))
 					  andalso is_regexp_match(User, UR);
+				  {shared_group, G} ->
+				      mod_shared_roster:is_user_in_group({User, Server}, G, Host);
+				  {shared_group, G, H} ->
+				      mod_shared_roster:is_user_in_group({User, Server}, G, H);
 				  {user_regexp, UR, S} ->
 				      (S == Server) andalso
 					  is_regexp_match(User, UR);
 				  {server_regexp, SR} ->
 				      is_regexp_match(Server, SR);
+				  {resource_regexp, RR} ->
+				      is_regexp_match(Resource, RR);
 				  {node_regexp, UR, SR} ->
 				      is_regexp_match(Server, SR) andalso
 					  is_regexp_match(User, UR);
@@ -169,9 +205,17 @@ match_acl(ACL, JID, Host) ->
 					  is_glob_match(User, UR);
 				  {server_glob, SR} ->
 				      is_glob_match(Server, SR);
+				  {resource_glob, RR} ->
+				      is_glob_match(Resource, RR);
 				  {node_glob, UR, SR} ->
 				      is_glob_match(Server, SR) andalso
-					  is_glob_match(User, UR)
+					  is_glob_match(User, UR);
+				  WrongSpec ->
+				      ?ERROR_MSG(
+					 "Wrong ACL expression: ~p~n"
+					 "Check your config file and reload it with the override_acls option enabled",
+					 [WrongSpec]),
+				      false
 			      end
 		      end,
 		      ets:lookup(acl, {ACL, global}) ++

src/aclocal.m4

@@ -1,6 +1,6 @@
 AC_DEFUN(AM_WITH_EXPAT,
 [ AC_ARG_WITH(expat,
-	      [  --with-expat=PREFIX	prefix where EXPAT is installed])
+	      [AC_HELP_STRING([--with-expat=PREFIX], [prefix where EXPAT is installed])])
 
   EXPAT_CFLAGS=
   EXPAT_LIBS=
@@ -8,22 +8,25 @@ AC_DEFUN(AM_WITH_EXPAT,
 		EXPAT_CFLAGS="-I$with_expat/include"
 		EXPAT_LIBS="-L$with_expat/lib"
 	fi
-	
+
 	AC_CHECK_LIB(expat, XML_ParserCreate,
 		     [ EXPAT_LIBS="$EXPAT_LIBS -lexpat"
 		       expat_found=yes ],
 		     [ expat_found=no ],
 		     "$EXPAT_LIBS")
 	if test $expat_found = no; then
-		AC_MSG_ERROR([Could not find the Expat library])
+		AC_MSG_ERROR([Could not find development files of Expat library])
 	fi
 	expat_save_CFLAGS="$CFLAGS"
 	CFLAGS="$CFLAGS $EXPAT_CFLAGS"
+       expat_save_CPPFLAGS="$CPPFLAGS"
+       CPPFLAGS="$CPPFLAGS $EXPAT_CFLAGS"
 	AC_CHECK_HEADERS(expat.h, , expat_found=no)
 	if test $expat_found = no; then
 		AC_MSG_ERROR([Could not find expat.h])
 	fi
 	CFLAGS="$expat_save_CFLAGS"
+       CPPFLAGS="$expat_save_CPPFLAGS"
 
   AC_SUBST(EXPAT_CFLAGS)
   AC_SUBST(EXPAT_LIBS)
@@ -31,50 +34,89 @@ AC_DEFUN(AM_WITH_EXPAT,
 
 AC_DEFUN(AM_WITH_ZLIB,
 [ AC_ARG_WITH(zlib,
-	      [  --with-zlib=PREFIX	prefix where zlib is installed])
+	      [AC_HELP_STRING([--with-zlib=PREFIX], [prefix where zlib is installed])])
 
+if test x"$ejabberd_zlib" != x; then
   ZLIB_CFLAGS=
   ZLIB_LIBS=
 	if test x"$with_zlib" != x; then
 		ZLIB_CFLAGS="-I$with_zlib/include"
 		ZLIB_LIBS="-L$with_zlib/lib"
 	fi
-	
+
 	AC_CHECK_LIB(z, gzgets,
 		     [ ZLIB_LIBS="$ZLIB_LIBS -lz"
 		       zlib_found=yes ],
 		     [ zlib_found=no ],
 		     "$ZLIB_LIBS")
 	if test $zlib_found = no; then
-		AC_MSG_ERROR([Could not find the zlib library])
+		AC_MSG_ERROR([Could not find development files of zlib library. Install them or disable `ejabberd_zlib' with: --disable-ejabberd_zlib])
 	fi
 	zlib_save_CFLAGS="$CFLAGS"
 	CFLAGS="$CFLAGS $ZLIB_CFLAGS"
+       zlib_save_CPPFLAGS="$CFLAGS"
+       CPPFLAGS="$CPPFLAGS $ZLIB_CFLAGS"
 	AC_CHECK_HEADERS(zlib.h, , zlib_found=no)
 	if test $zlib_found = no; then
-		AC_MSG_ERROR([Could not find zlib.h])
+		AC_MSG_ERROR([Could not find zlib.h. Install it or disable `ejabberd_zlib' with: --disable-ejabberd_zlib])
 	fi
 	CFLAGS="$zlib_save_CFLAGS"
+       CPPFLAGS="$zlib_save_CPPFLAGS"
 
   AC_SUBST(ZLIB_CFLAGS)
   AC_SUBST(ZLIB_LIBS)
+fi
+])
+
+AC_DEFUN(AM_WITH_PAM,
+[ AC_ARG_WITH(pam,
+	      [AC_HELP_STRING([--with-pam=PREFIX], [prefix where PAM is installed])])
+if test x"$pam" != x; then
+  PAM_CFLAGS=
+  PAM_LIBS=
+	if test x"$with_pam" != x; then
+		PAM_CFLAGS="-I$with_pam/include"
+		PAM_LIBS="-L$with_pam/lib"
+	fi
+
+	AC_CHECK_LIB(pam, pam_start,
+		     [ PAM_LIBS="$PAM_LIBS -lpam"
+		       pam_found=yes ],
+		     [ pam_found=no ],
+		     "$PAM_LIBS")
+	if test $pam_found = no; then
+		AC_MSG_ERROR([Could not find development files of PAM library. Install them or disable `pam' with: --disable-pam])
+	fi
+	pam_save_CFLAGS="$CFLAGS"
+	CFLAGS="$CFLAGS $PAM_CFLAGS"
+       pam_save_CPPFLAGS="$CPPFLAGS"
+       CPPFLAGS="$CPPFLAGS $PAM_CFLAGS"
+	AC_CHECK_HEADERS(security/pam_appl.h, , pam_found=no)
+	if test $pam_found = no; then
+		AC_MSG_ERROR([Could not find security/pam_appl.h. Install it or disable `pam' with: --disable-pam])
+	fi
+	CFLAGS="$pam_save_CFLAGS"
+       CPPFLAGS="$pam_save_CPPFLAGS"
+
+  AC_SUBST(PAM_CFLAGS)
+  AC_SUBST(PAM_LIBS)
+fi
 ])
 
 AC_DEFUN(AM_WITH_ERLANG,
 [ AC_ARG_WITH(erlang,
-	      [  --with-erlang=PREFIX    path to erlc and erl ])
+	      [AC_HELP_STRING([--with-erlang=PREFIX], [path to erlc and erl])])
 
+   AC_PATH_TOOL(ERLC, erlc, , $with_erlang:$with_erlang/bin:$PATH)
+   AC_PATH_TOOL(ERL, erl, , $with_erlang:$with_erlang/bin:$PATH)
 
-   AC_PATH_TOOL(ERLC, erlc, , $PATH:$with_erlang:$with_erlang/bin)
-   AC_PATH_TOOL(ERL, erl, , $PATH:$with_erlang:$with_erlang/bin)
-   
    if test "z$ERLC" = "z" || test "z$ERL" = "z"; then
    		AC_MSG_ERROR([erlang not found])
    fi
-   
-   
+
+
    cat >>conftest.erl <<_EOF
-   
+
 -module(conftest).
 -author('alexey@sevcom.net').
 
@@ -84,9 +126,17 @@ start() ->
     EIDirS = code:lib_dir("erl_interface") ++ "\n",
     EILibS =  libpath("erl_interface") ++ "\n",
     RootDirS = code:root_dir() ++ "\n",
-    file:write_file("conftest.out", list_to_binary(EIDirS ++ EILibS ++ RootDirS)),
+    file:write_file("conftest.out", list_to_binary(EIDirS ++ EILibS ++ ssldef() ++ RootDirS)),
     halt().
 
+ssldef() -> 
+   OTP = (catch erlang:system_info(otp_release)),
+   if
+	OTP >= "R14" -> "-DSSL40\n";
+	OTP >= "R12" -> "-DSSL39\n";
+        true -> ""
+   end.
+
 %% return physical architecture based on OS/Processor
 archname() ->
     ArchStr = erlang:system_info(system_architecture),
@@ -115,45 +165,47 @@ libpath(App) ->
 	%% ({error, enoent}):
 	_Error -> code:lib_dir("erl_interface") ++ "/lib"
     end.
-	   
+
 _EOF
-   
+
    if ! $ERLC conftest.erl; then
    	   AC_MSG_ERROR([could not compile sample program])
    fi
-   
+
    if ! $ERL -s conftest -noshell; then
        AC_MSG_ERROR([could not run sample program])
    fi
-   
+
    if ! test -f conftest.out; then
        AC_MSG_ERROR([erlang program was not properly executed, (conftest.out was not produced)])
    fi
-   
+
    # First line
    ERLANG_EI_DIR=`cat conftest.out | head -n 1`
    # Second line
    ERLANG_EI_LIB=`cat conftest.out | head -n 2 | tail -n 1`
    # Third line
+   ERLANG_SSLVER=`cat conftest.out | head -n 3 | tail -n 1`
+   # End line
    ERLANG_DIR=`cat conftest.out | tail -n 1`
-   
+
    ERLANG_CFLAGS="-I$ERLANG_EI_DIR/include -I$ERLANG_DIR/usr/include"
    ERLANG_LIBS="-L$ERLANG_EI_LIB -lerl_interface -lei"
-   
+
    AC_SUBST(ERLANG_CFLAGS)
    AC_SUBST(ERLANG_LIBS)
+   AC_SUBST(ERLANG_SSLVER)
    AC_SUBST(ERLC)
    AC_SUBST(ERL)
 ])
 
-
 AC_DEFUN(AC_MOD_ENABLE,
 [
 $1=
 make_$1=
 AC_MSG_CHECKING([whether build $1])
 AC_ARG_ENABLE($1,
-  [  --enable-$1        enable $1 (default: $2)],
+  [AC_HELP_STRING([--enable-$1], [enable $1 (default: $2)])],
     [mr_enable_$1="$enableval"],
      [mr_enable_$1=$2])
 if test "$mr_enable_$1" = "yes"; then
@@ -174,7 +226,7 @@ AC_DEFUN([AM_ICONV],
   dnl Some systems have iconv in libc, some have it in libiconv (OSF/1 and
   dnl those with the standalone portable GNU libiconv installed).
   AC_ARG_WITH([libiconv-prefix],
-[  --with-libiconv-prefix=PREFIX	prefix where libiconv is installed], [
+   [AC_HELP_STRING([--with-libiconv-prefix=PREFIX], [prefix where libiconv is installed])], [
     for dir in `echo "$withval" | tr : ' '`; do
       if test -d $dir/include; then CPPFLAGS="$CPPFLAGS -I$dir/include"; fi
       if test -d $dir/include; then CFLAGS="$CFLAGS -I$dir/include"; fi
@@ -223,7 +275,7 @@ AC_DEFUN([AM_ICONV],
 		CFLAGS="$am_save_CFLAGS")
       LIBS="$am_save_LIBS"
     fi
-	
+
   ])
   if test "$am_cv_func_iconv" = yes; then
     AC_DEFINE(HAVE_ICONV, 1, [Define if you have the iconv() function.])
@@ -259,33 +311,37 @@ size_t iconv();
 dnl <openssl>
 AC_DEFUN(AM_WITH_OPENSSL,
 [ AC_ARG_WITH(openssl,
-          [  --with-openssl=PREFIX    prefix where OPENSSL is installed ])
+      [AC_HELP_STRING([--with-openssl=PREFIX], [prefix where OPENSSL is installed])])
 unset SSL_LIBS;
 unset SSL_CFLAGS;
 have_openssl=no
 if test x"$tls" != x; then
     for ssl_prefix in $withval /usr/local/ssl /usr/lib/ssl /usr/ssl /usr/pkg /usr/local /usr; do
         printf "looking for openssl in $ssl_prefix...\n"
-        SSL_CFLAGS="-I$ssl_prefix/include/openssl"
+        SSL_CFLAGS="-I$ssl_prefix/include"
         SSL_LIBS="-L$ssl_prefix/lib -lcrypto"
         AC_CHECK_LIB(ssl, SSL_new, [ have_openssl=yes ], [ have_openssl=no ], [ $SSL_LIBS $SSL_CFLAGS ])
         if test x"$have_openssl" = xyes; then
             save_CPPFLAGS=$CPPFLAGS
-            CPPFLAGS="-I$ssl_prefix/lib $CPPFLAGS"
+            CPPFLAGS="-I$ssl_prefix/include $CPPFLAGS"
             AC_CHECK_HEADERS(openssl/ssl.h, have_openssl_h=yes)
             CPPFLAGS=$save_CPPFLAGS
             if test x"$have_openssl_h" = xyes; then
                 have_openssl=yes
                 printf "openssl found in $ssl_prefix\n";
                 SSL_LIBS="-L$ssl_prefix/lib -lssl -lcrypto"
-                CPPFLAGS="-I$ssl_prefix/lib $CPPFLAGS"
+                CPPFLAGS="-I$ssl_prefix/include $CPPFLAGS"
                 SSL_CFLAGS="-DHAVE_SSL"
                 break
             fi
+	else
+	    # Clear this from the autoconf cache, so in the next pass of
+	    # this loop with different -L arguments, it will test again.
+	    unset ac_cv_lib_ssl_SSL_new
         fi
     done
 if test x${have_openssl} != xyes; then
-    AC_MSG_ERROR([openssl library cannot be found. Install openssl or disable `tls' module (--disable-tls).])
+    AC_MSG_ERROR([Could not find development files of OpenSSL library. Install them or disable `tls' with: --disable-tls])
 fi
 AC_SUBST(SSL_LIBS)
 AC_SUBST(SSL_CFLAGS)

src/adhoc.erl

@@ -1,14 +1,31 @@
 %%%----------------------------------------------------------------------
 %%% File    : adhoc.erl
 %%% Author  : Magnus Henoch <henoch@dtek.chalmers.se>
-%%% Purpose : Provide helper functions for ad-hoc commands (JEP-0050)
+%%% Purpose : Provide helper functions for ad-hoc commands (XEP-0050)
 %%% Created : 31 Oct 2005 by Magnus Henoch <henoch@dtek.chalmers.se>
-%%% Id      : $Id$
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(adhoc).
 -author('henoch@dtek.chalmers.se').
--vsn('$Revision$ ').
 
 -export([parse_request/1,
 	 produce_response/2,
@@ -27,10 +44,11 @@ parse_request(#iq{type = set, lang = Lang, sub_el = SubEl, xmlns = ?NS_COMMANDS}
     Action = xml:get_tag_attr_s("action", SubEl),
     XData = find_xdata_el(SubEl),
     {xmlelement, _, _, AllEls} = SubEl,
-    if XData ->
-	    Others = lists:delete(XData, AllEls);
-       true ->
-	    Others = AllEls
+    Others = case XData of
+	false ->
+	    AllEls;
+	_ ->
+	    lists:delete(XData, AllEls)
     end,
 
     #adhoc_request{lang = Lang,

src/adhoc.hrl

@@ -1,3 +1,24 @@
+%%%----------------------------------------------------------------------
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%----------------------------------------------------------------------
+
 -record(adhoc_request, {lang,
 			node,
 			sessionid,

src/configure.ac

@@ -2,42 +2,64 @@
 # Process this file with autoconf to produce a configure script.
 
 AC_PREREQ(2.53)
-AC_INIT(FULL-PACKAGE-NAME, VERSION, BUG-REPORT-ADDRESS)
+AC_INIT(ejabberd, m4_esyscmd([grep -o -E "\{vsn,.\".*\"\}" ejabberd.app | cut -d \" -f 2 | tr -d '\n']), [ejabberd@process-one.net], [ejabberd])
 
 # Checks for programs.
 AC_PROG_CC
 AC_PROG_MAKE_SET
 
+if test "x$GCC" = "xyes"; then
+    CFLAGS="$CFLAGS -Wall"
+fi
+
 #locating erlang
 AM_WITH_ERLANG
 #locating iconv
 AM_ICONV
 #locating libexpat
 AM_WITH_EXPAT
-#locating zlib
-AM_WITH_ZLIB
 
 # 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 /
+AC_PREFIX_DEFAULT(/)
 
 # Checks for library functions.
 AC_FUNC_MALLOC
 AC_HEADER_STDC
 
-AC_MOD_ENABLE(mod_pubsub, yes)
 AC_MOD_ENABLE(mod_irc, yes)
 AC_MOD_ENABLE(mod_muc, yes)
+AC_MOD_ENABLE(mod_proxy65, yes)
+AC_MOD_ENABLE(mod_pubsub, yes)
 AC_MOD_ENABLE(eldap, yes)
-AC_MOD_ENABLE(web, yes)
-AC_MOD_ENABLE(tls, yes)
 AC_MOD_ENABLE(odbc, no)
+AC_MOD_ENABLE(tls, yes)
+AC_MOD_ENABLE(web, yes)
+
 AC_MOD_ENABLE(ejabberd_zlib, yes)
+#locating zlib
+AM_WITH_ZLIB
+
+AC_MOD_ENABLE(pam, no)
+#locating PAM
+AM_WITH_PAM
+
+AC_ARG_ENABLE(hipe,
+[AC_HELP_STRING([--enable-hipe], [compile natively with HiPE, not recommended (default: no)])],
+[case "${enableval}" in
+  yes) hipe=true ;;
+  no)  hipe=false ;;
+  *) AC_MSG_ERROR(bad value ${enableval} for --enable-hipe) ;;
+esac],[hipe=false])
+AC_SUBST(hipe)
 
 AC_ARG_ENABLE(roster_gateway_workaround,
-[  --enable-roster-gateway-workaround    Turn on workaround for processing gateway subscriptions],
+[AC_HELP_STRING([--enable-roster-gateway-workaround], [turn on workaround for processing gateway subscriptions (default: no)])],
 [case "${enableval}" in
   yes) roster_gateway_workaround=true ;;
   no)  roster_gateway_workaround=false ;;
@@ -45,16 +67,112 @@ AC_ARG_ENABLE(roster_gateway_workaround,
 esac],[roster_gateway_workaround=false])
 AC_SUBST(roster_gateway_workaround)
 
+AC_ARG_ENABLE(mssql,
+[AC_HELP_STRING([--enable-mssql], [use Microsoft SQL Server database (default: no, requires --enable-odbc)])],
+[case "${enableval}" in
+  yes) db_type=mssql ;;
+  no)  db_type=generic ;;
+  *) AC_MSG_ERROR(bad value ${enableval} for --enable-mssql) ;;
+esac],[db_type=generic])
+AC_SUBST(db_type)
+
+AC_ARG_ENABLE(transient_supervisors,
+[AC_HELP_STRING([--enable-transient_supervisors], [use Erlang supervision for transient process (default: yes)])],
+[case "${enableval}" in
+  yes) transient_supervisors=true ;;
+  no)  transient_supervisors=false ;;
+  *) AC_MSG_ERROR(bad value ${enableval} for --enable-transient_supervisors) ;;
+esac],[transient_supervisors=true])
+AC_SUBST(transient_supervisors)
+
+AC_ARG_ENABLE(full_xml,
+[AC_HELP_STRING([--enable-full-xml], [use XML features in XMPP stream (ex: CDATA) (default: no, requires XML compliant clients)])],
+[case "${enableval}" in
+  yes) full_xml=true ;;
+  no)  full_xml=false ;;
+  *) AC_MSG_ERROR(bad value ${enableval} for --enable-full-xml) ;;
+esac],[full_xml=false])
+AC_SUBST(full_xml)
+
+AC_ARG_ENABLE(nif,
+[AC_HELP_STRING([--enable-nif], [replace some functions with C equivalents. Requires Erlang R13B04 or higher (default: no)])],
+[case "${enableval}" in
+  yes) nif=true ;;
+  no)  nif=false ;;
+  *) AC_MSG_ERROR(bad value ${enableval} for --enable-nif) ;;
+esac],[nif=false])
+AC_SUBST(nif)
+
 AC_CONFIG_FILES([Makefile
                  $make_mod_irc
                  $make_mod_muc
                  $make_mod_pubsub
+                 $make_mod_proxy65
                  $make_eldap
+                 $make_pam
                  $make_web
                  stringprep/Makefile
+                 stun/Makefile
                  $make_tls
                  $make_odbc
                  $make_ejabberd_zlib])
 #openssl
 AM_WITH_OPENSSL
+# If ssl is kerberized it need krb5.h
+# On RedHat and OpenBSD, krb5.h is in an unsual place:
+KRB5_INCLUDE="`krb5-config --cflags 2>/dev/null`"
+if test -n "$KRB5_INCLUDE" ; then
+        CPPFLAGS="$CPPFLAGS $KRB5_INCLUDE"
+else
+        #         For RedHat                                  For BSD
+        for D in /usr/kerberos/include /usr/include/kerberos /usr/include/kerberosV
+        do
+                if test -d $D ; then
+                        CPPFLAGS="$CPPFLAGS -I$D"
+                fi
+        done
+fi
+AC_CHECK_HEADER(krb5.h,,)
+
+ENABLEUSER=""
+AC_ARG_ENABLE(user,
+  [AS_HELP_STRING([--enable-user[[[[=USER]]]]], [allow this system user to start ejabberd (default: no)])],
+  [case "${enableval}" in
+     yes) ENABLEUSER=`whoami` ;;
+     no) ENABLEUSER="" ;;
+     *) ENABLEUSER=$enableval
+   esac],
+  [])
+if test "$ENABLEUSER" != ""; then
+  echo "allow this system user to start ejabberd: $ENABLEUSER"
+  AC_SUBST([INSTALLUSER], [$ENABLEUSER])
+fi
+
+AC_CANONICAL_SYSTEM
+#AC_DEFINE_UNQUOTED(CPU_VENDOR_OS, "$target")
+#AC_SUBST(target_os)
+
+
+case "$target_os" in
+    *darwin10*)
+	echo "Target OS is 'Darwin10'"
+	AC_LANG(Erlang)
+	AC_RUN_IFELSE(
+	    [AC_LANG_PROGRAM([],[dnl
+	     halt(case erlang:system_info(wordsize) of
+	     8 -> 0; 4 -> 1 end)])],
+	    [AC_MSG_NOTICE(found 64-bit Erlang)
+	     CBIT=-m64],
+	    [AC_MSG_NOTICE(found 32-bit Erlang)
+	     CBIT=-m32])
+	;;
+    *)        
+	echo "Target OS is '$target_os'"
+	CBIT=""
+	;;
+esac
+CFLAGS="$CFLAGS $CBIT"
+LD_SHARED="$LD_SHARED $CBIT"
+echo "CBIT is set to '$CBIT'"
+
 AC_OUTPUT

src/configure.erl

@@ -1,14 +1,31 @@
 %%%----------------------------------------------------------------------
 %%% File    : configure.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
-%%% Purpose : 
-%%% Created : 27 Jan 2003 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
+%%% Purpose :
+%%% Created : 27 Jan 2003 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(configure).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -export([start/0]).
 
@@ -27,28 +44,31 @@ start() ->
 	true ->
 	    ExpatLib  = "EXPAT_LIB = $(EXPAT_DIR)\\StaticLibs\\libexpatMT.lib\n",
 	    ExpatFlag = "EXPAT_FLAG = -DXML_STATIC\n",
-	    IconvDir  = "ICONV_DIR = c:\\progra~1\\libiconv-1.9.1-static\n",
-	    IconvLib  = "ICONV_LIB = $(ICONV_DIR)\\lib\\iconv.lib\n",
-	    ZlibDir   = "ZLIB_DIR = c:\\progra~1\\zlib-1.2.3\n",
+	    IconvDir  = "ICONV_DIR = c:\\sdk\\GnuWin32\n",
+	    IconvLib  = "ICONV_LIB = $(ICONV_DIR)\\lib\\libiconv.lib\n",
+	    ZlibDir   = "ZLIB_DIR = c:\\sdk\\GnuWin32\n",
 	    ZlibLib   = "ZLIB_LIB = $(ZLIB_DIR)\\lib\\zlib.lib\n";
 	false ->
 	    ExpatLib  = "EXPAT_LIB = $(EXPAT_DIR)\\Libs\\libexpat.lib\n",
 	    ExpatFlag = "",
-	    IconvDir  = "ICONV_DIR = c:\\progra~1\\libiconv-1.9.1\n",
-	    IconvLib  = "ICONV_LIB = $(ICONV_DIR)\\lib\\iconv.lib\n",
-	    ZlibDir   = "ZLIB_DIR = c:\\progra~1\\zlib-1.2.3\n",
-	    ZlibLib   = "ZLIB_LIB = $(ZLIB_DIR)\\lib\\zlib1.lib\n"
+	    IconvDir  = "ICONV_DIR = c:\\sdk\\GnuWin32\n",
+	    IconvLib  = "ICONV_LIB = $(ICONV_DIR)\\lib\\libiconv.lib\n",
+	    ZlibDir   = "ZLIB_DIR = c:\\sdk\\GnuWin32\n",
+	    ZlibLib   = "ZLIB_LIB = $(ZLIB_DIR)\\lib\\zlib.lib\n"
     end,
 
     EVersion = "ERLANG_VERSION = " ++ erlang:system_info(version) ++ "\n",
-    EIDirS   = "EI_DIR = " ++ code:lib_dir("erl_interface") ++ "\n",
+    EIDirS   = "EI_DIR = " ++ code:lib_dir(erl_interface) ++ "\n",
     RootDirS = "ERLANG_DIR = " ++ code:root_dir() ++ "\n",
+    %% Load the ejabberd application description so that ?VERSION can read the vsn key
+    application:load(ejabberd),
     Version  = "EJABBERD_VERSION = " ++ ?VERSION ++ "\n",
-    ExpatDir = "EXPAT_DIR = c:\\progra~1\\expat-1.95.7\n",
-    OpenSSLDir = "OPENSSL_DIR = c:\\progra~1\\OpenSSL\n",
+    ExpatDir = "EXPAT_DIR = c:\\sdk\\Expat-2.0.0\n",
+    OpenSSLDir = "OPENSSL_DIR = c:\\sdk\\OpenSSL\n",
+    DBType = "DBTYPE = generic\n",    %% 'generic' or 'mssql'
 
-    SSLDir    = "SSLDIR = " ++ code:lib_dir("ssl") ++ "\n",
-    StdLibDir = "STDLIBDIR = " ++ code:lib_dir("stdlib") ++ "\n",
+    SSLDir    = "SSLDIR = " ++ code:lib_dir(ssl) ++ "\n",
+    StdLibDir = "STDLIBDIR = " ++ code:lib_dir(stdlib) ++ "\n",
 
     file:write_file("Makefile.inc",
 		    list_to_binary(EVersion ++
@@ -58,6 +78,7 @@ start() ->
 				   SSLDir ++
 				   StdLibDir ++
 				   OpenSSLDir ++
+				   DBType ++
 				   ExpatDir ++
 				   ExpatLib ++
 				   ExpatFlag ++
@@ -66,5 +87,3 @@ start() ->
 				   ZlibDir ++
 				   ZlibLib)),
     halt().
-
-

src/cyrsasl.erl

@@ -1,32 +1,49 @@
 %%%----------------------------------------------------------------------
 %%% File    : cyrsasl.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : Cyrus SASL-like library
-%%% Created :  8 Mar 2003 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created :  8 Mar 2003 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(cyrsasl).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -export([start/0,
 	 register_mechanism/3,
 	 listmech/1,
-	 server_new/6,
+	 server_new/7,
 	 server_start/3,
 	 server_step/2]).
 
 -record(sasl_mechanism, {mechanism, module, require_plain_password}).
 -record(sasl_state, {service, myname, realm,
-		     get_password, check_password,
+		     get_password, check_password, check_password_digest,
 		     mech_mod, mech_state}).
 
 -export([behaviour_info/1]).
 
 behaviour_info(callbacks) ->
-    [{mech_new, 3}, {mech_step, 2}];
-behaviour_info(Other) ->
+    [{mech_new, 4}, {mech_step, 2}];
+behaviour_info(_Other) ->
     undefined.
 
 start() ->
@@ -44,44 +61,44 @@ register_mechanism(Mechanism, Module, RequirePlainPassword) ->
 			       module = Module,
 			       require_plain_password = RequirePlainPassword}).
 
-% TODO: use callbacks
--include("ejabberd.hrl").
--include("jlib.hrl").
-check_authzid(State, Props) ->
-    AuthzId = xml:get_attr_s(authzid, Props),
-    case jlib:string_to_jid(AuthzId) of
-	error ->
-	    {error, "invalid-authzid"};
-	JID ->
-	    LUser = jlib:nodeprep(xml:get_attr_s(username, Props)),
-	    {U, S, R} = jlib:jid_tolower(JID),
-	    case R of
-		"" ->
-		    {error, "invalid-authzid"};
-		_ ->
-		    case {LUser, ?MYNAME} of
-			{U, S} ->
-			    ok;
-			_ ->
-			    {error, "invalid-authzid"}
-		    end
-	    end
-    end.
+%%% TODO: use callbacks
+%%-include("ejabberd.hrl").
+%%-include("jlib.hrl").
+%%check_authzid(_State, Props) ->
+%%    AuthzId = xml:get_attr_s(authzid, Props),
+%%    case jlib:string_to_jid(AuthzId) of
+%%	error ->
+%%	    {error, "invalid-authzid"};
+%%	JID ->
+%%	    LUser = jlib:nodeprep(xml:get_attr_s(username, Props)),
+%%	    {U, S, R} = jlib:jid_tolower(JID),
+%%	    case R of
+%%		"" ->
+%%		    {error, "invalid-authzid"};
+%%		_ ->
+%%		    case {LUser, ?MYNAME} of
+%%			{U, S} ->
+%%			    ok;
+%%			_ ->
+%%			    {error, "invalid-authzid"}
+%%		    end
+%%	    end
+%%    end.
 
-check_credentials(State, Props) ->
+check_credentials(_State, Props) ->
     User = xml:get_attr_s(username, Props),
     case jlib:nodeprep(User) of
 	error ->
 	    {error, "not-authorized"};
 	"" ->
 	    {error, "not-authorized"};
-	LUser ->
+	_LUser ->
 	    ok
     end.
 
 listmech(Host) ->
     RequirePlainPassword = ejabberd_auth:plain_password_required(Host),
-    
+
     Mechs = ets:select(sasl_mechanism,
 		       [{#sasl_mechanism{mechanism = '$1',
 					 require_plain_password = '$2',
@@ -95,13 +112,14 @@ listmech(Host) ->
 			 ['$1']}]),
     filter_anonymous(Host, Mechs).
 
-server_new(Service, ServerFQDN, UserRealm, SecFlags,
-	   GetPassword, CheckPassword) ->
+server_new(Service, ServerFQDN, UserRealm, _SecFlags,
+	   GetPassword, CheckPassword, CheckPasswordDigest) ->
     #sasl_state{service = Service,
 		myname = ServerFQDN,
 		realm = UserRealm,
 		get_password = GetPassword,
-		check_password = CheckPassword}.
+		check_password = CheckPassword,
+		check_password_digest= CheckPasswordDigest}.
 
 server_start(State, Mech, ClientIn) ->
     case lists:member(Mech, listmech(State#sasl_state.myname)) of
@@ -111,7 +129,8 @@ server_start(State, Mech, ClientIn) ->
 		    {ok, MechState} = Module:mech_new(
 					State#sasl_state.myname,
 					State#sasl_state.get_password,
-					State#sasl_state.check_password),
+					State#sasl_state.check_password,
+					State#sasl_state.check_password_digest),
 		    server_step(State#sasl_state{mech_mod = Module,
 						 mech_state = MechState},
 				ClientIn);
@@ -136,6 +155,8 @@ server_step(State, ClientIn) ->
 	{continue, ServerOut, NewMechState} ->
 	    {continue, ServerOut,
 	     State#sasl_state{mech_state = NewMechState}};
+	{error, Error, Username} ->
+	    {error, Error, Username};
 	{error, Error} ->
 	    {error, Error}
     end.

src/cyrsasl_anonymous.erl

@@ -2,16 +2,32 @@
 %%% File    : cyrsasl_anonymous.erl
 %%% Author  : Magnus Henoch <henoch@dtek.chalmers.se>
 %%% Purpose : ANONYMOUS SASL mechanism
+%%%  See http://www.ietf.org/internet-drafts/draft-ietf-sasl-anon-05.txt
 %%% Created : 23 Aug 2005 by Magnus Henoch <henoch@dtek.chalmers.se>
-%%% Id      : $Id$
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
-%% See http://www.ietf.org/internet-drafts/draft-ietf-sasl-anon-05.txt
-
 -module(cyrsasl_anonymous).
--vsn('$Revision$').
 
--export([start/1, stop/0, mech_new/3, mech_step/2]).
+-export([start/1, stop/0, mech_new/4, mech_step/2]).
 
 -behaviour(cyrsasl).
 
@@ -24,7 +40,7 @@ start(_Opts) ->
 stop() ->
     ok.
 
-mech_new(Host, _GetPassword, _CheckPassword) ->
+mech_new(Host, _GetPassword, _CheckPassword, _CheckPasswordDigest) ->
     {ok, #state{server = Host}}.
 
 mech_step(State, _ClientIn) ->
@@ -35,5 +51,6 @@ mech_step(State, _ClientIn) ->
     %% Checks that the username is available
     case ejabberd_auth:is_user_exists(User, Server) of
 	true  -> {error, "not-authorized"};
-	false -> {ok, [{username, User}]}
+	false -> {ok, [{username, User},
+		       {auth_module, ejabberd_auth_anonymous}]}
     end.

src/cyrsasl_digest.erl

@@ -3,21 +3,41 @@
 %%% Author  : Alexey Shchepin <alexey@sevcom.net>
 %%% Purpose : DIGEST-MD5 SASL mechanism
 %%% Created : 11 Mar 2003 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(cyrsasl_digest).
 -author('alexey@sevcom.net').
--vsn('$Revision$ ').
 
 -export([start/1,
 	 stop/0,
-	 mech_new/3,
+	 mech_new/4,
 	 mech_step/2]).
 
+-include("ejabberd.hrl").
+
 -behaviour(cyrsasl).
 
--record(state, {step, nonce, username, authzid, get_password}).
+-record(state, {step, nonce, username, authzid, get_password, check_password, auth_module,
+		host}).
 
 start(_Opts) ->
     cyrsasl:register_mechanism("DIGEST-MD5", ?MODULE, true).
@@ -25,10 +45,12 @@ start(_Opts) ->
 stop() ->
     ok.
 
-mech_new(_Host, GetPassword, _CheckPassword) ->
+mech_new(Host, GetPassword, _CheckPassword, CheckPasswordDigest) ->
     {ok, #state{step = 1,
 		nonce = randoms:get_string(),
-		get_password = GetPassword}}.
+		host = Host,
+		get_password = GetPassword,
+		check_password = CheckPasswordDigest}}.
 
 mech_step(#state{step = 1, nonce = Nonce} = State, _) ->
     {continue,
@@ -40,38 +62,51 @@ mech_step(#state{step = 3, nonce = Nonce} = State, ClientIn) ->
 	bad ->
 	    {error, "bad-protocol"};
 	KeyVals ->
+	    DigestURI = xml:get_attr_s("digest-uri", KeyVals),
 	    UserName = xml:get_attr_s("username", KeyVals),
-	    AuthzId = xml:get_attr_s("authzid", KeyVals),
-	    case (State#state.get_password)(UserName) of
+	    case is_digesturi_valid(DigestURI, State#state.host) of
 		false ->
-		    {error, "not-authorized"};
-		Passwd ->
-		    Response = response(KeyVals, UserName, Passwd,
-					Nonce, AuthzId, "AUTHENTICATE"),
-		    case xml:get_attr_s("response", KeyVals) of
-			Response ->
-			    RspAuth = response(KeyVals,
-					       UserName, Passwd,
-					       Nonce, AuthzId, ""),
-			    {continue,
-			     "rspauth=" ++ RspAuth,
-			     State#state{step = 5,
-					 username = UserName,
-					 authzid = AuthzId}};
-			_ ->
-			    {error, "not-authorized"}
+		    ?DEBUG("User login not authorized because digest-uri "
+			   "seems invalid: ~p", [DigestURI]),
+		    {error, "not-authorized", UserName};
+		true ->
+		    AuthzId = xml:get_attr_s("authzid", KeyVals),
+		    case (State#state.get_password)(UserName) of
+			{false, _} ->
+			    {error, "not-authorized", UserName};
+			{Passwd, AuthModule} ->
+				case (State#state.check_password)(UserName, "",
+					xml:get_attr_s("response", KeyVals),
+					fun(PW) -> response(KeyVals, UserName, PW, Nonce, AuthzId,
+						"AUTHENTICATE") end) of
+				{true, _} ->
+				    RspAuth = response(KeyVals,
+						       UserName, Passwd,
+						       Nonce, AuthzId, ""),
+				    {continue,
+				     "rspauth=" ++ RspAuth,
+				     State#state{step = 5,
+						 auth_module = AuthModule,
+						 username = UserName,
+						 authzid = AuthzId}};
+				false ->
+				    {error, "not-authorized", UserName};
+				{false, _} ->
+				    {error, "not-authorized", UserName}
+			    end
 		    end
 	    end
     end;
 mech_step(#state{step = 5,
+		 auth_module = AuthModule,
 		 username = UserName,
 		 authzid = AuthzId}, "") ->
-    {ok, [{username, UserName}, {authzid, AuthzId}]};
+    {ok, [{username, UserName}, {authzid, AuthzId},
+	  {auth_module, AuthModule}]};
 mech_step(A, B) ->
-    io:format("SASL DIGEST: A ~p B ~p", [A,B]),
+    ?DEBUG("SASL DIGEST: A ~p B ~p", [A,B]),
     {error, "bad-protocol"}.
 
-
 parse(S) ->
     parse1(S, "", []).
 
@@ -88,15 +123,17 @@ parse1([], [], T) ->
 parse1([], _S, _T) ->
     bad.
 
-parse2([$" | Cs], Key, Val, Ts) ->
+parse2([$\" | Cs], Key, Val, Ts) ->
     parse3(Cs, Key, Val, Ts);
 parse2([C | Cs], Key, Val, Ts) ->
     parse4(Cs, Key, [C | Val], Ts);
 parse2([], _, _, _) ->
     bad.
 
-parse3([$" | Cs], Key, Val, Ts) ->
+parse3([$\" | Cs], Key, Val, Ts) ->
     parse4(Cs, Key, Val, Ts);
+parse3([$\\, C | Cs], Key, Val, Ts) ->
+    parse3(Cs, Key, [C | Val], Ts);
 parse3([C | Cs], Key, Val, Ts) ->
     parse3(Cs, Key, [C | Val], Ts);
 parse3([], _, _, _) ->
@@ -112,6 +149,23 @@ parse4([], Key, Val, Ts) ->
     parse1([], "", [{Key, lists:reverse(Val)} | Ts]).
 
 
+%% @doc Check if the digest-uri is valid.
+%% RFC-2831 allows to provide the IP address in Host,
+%% however ejabberd doesn't allow that.
+%% If the service (for example jabber.example.org)
+%% is provided by several hosts (being one of them server3.example.org),
+%% then digest-uri can be like xmpp/server3.example.org/jabber.example.org
+%% In that case, ejabberd only checks the service name, not the host.
+is_digesturi_valid(DigestURICase, JabberHost) ->
+    DigestURI = stringprep:tolower(DigestURICase),
+    case catch string:tokens(DigestURI, "/") of
+	["xmpp", Host] when Host == JabberHost ->
+	    true;
+	["xmpp", _Host, ServName] when ServName == JabberHost ->
+	    true;
+	_ ->
+	    false
+    end.
 
 
 

src/cyrsasl_plain.erl

@@ -1,16 +1,33 @@
 %%%----------------------------------------------------------------------
 %%% File    : cyrsasl_plain.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : PLAIN SASL mechanism
-%%% Created :  8 Mar 2003 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created :  8 Mar 2003 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(cyrsasl_plain).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
--export([start/1, stop/0, mech_new/3, mech_step/2, parse/1]).
+-export([start/1, stop/0, mech_new/4, mech_step/2, parse/1]).
 
 -behaviour(cyrsasl).
 
@@ -23,22 +40,41 @@ start(_Opts) ->
 stop() ->
     ok.
 
-mech_new(_Host, _GetPassword, CheckPassword) ->
+mech_new(_Host, _GetPassword, CheckPassword, _CheckPasswordDigest) ->
     {ok, #state{check_password = CheckPassword}}.
 
 mech_step(State, ClientIn) ->
-    case parse(ClientIn) of
+    case prepare(ClientIn) of
 	[AuthzId, User, Password] ->
 	    case (State#state.check_password)(User, Password) of
-		true ->
-		    {ok, [{username, User}, {authzid, AuthzId}]};
+		{true, AuthModule} ->
+		    {ok, [{username, User}, {authzid, AuthzId},
+			  {auth_module, AuthModule}]};
 		_ ->
-		    {error, "bad-auth"}
+		    {error, "not-authorized", User}
 	    end;
 	_ ->
 	    {error, "bad-protocol"}
     end.
 
+prepare(ClientIn) ->
+    case parse(ClientIn) of
+	[[], UserMaybeDomain, Password] ->
+	    case parse_domain(UserMaybeDomain) of
+		%% <NUL>login@domain<NUL>pwd
+		[User, _Domain] ->
+		    [UserMaybeDomain, User, Password];
+		%% <NUL>login<NUL>pwd
+		[User] ->
+		    ["", User, Password]
+	    end;
+	%% login@domain<NUL>login<NUL>pwd
+	[AuthzId, User, Password] ->
+	    [AuthzId, User, Password];
+	_ ->
+	    error
+    end.
+
 
 parse(S) ->
     parse1(S, "", []).
@@ -53,5 +89,12 @@ parse1([], S, T) ->
     lists:reverse([lists:reverse(S) | T]).
 
 
+parse_domain(S) ->
+    parse_domain1(S, "", []).
 
-
+parse_domain1([$@ | Cs], S, T) ->
+    parse_domain1(Cs, "", [lists:reverse(S) | T]);
+parse_domain1([C | Cs], S, T) ->
+    parse_domain1(Cs, [C | S], T);
+parse_domain1([], S, T) ->
+    lists:reverse([lists:reverse(S) | T]).

src/dynamic_compile.erl

@@ -0,0 +1,268 @@
+%% Copyright (c) 2007
+%%          Mats Cronqvist <mats.cronqvist@ericsson.com>
+%%          Chris Newcombe <chris.newcombe@gmail.com> 
+%%          Jacob Vorreuter <jacob.vorreuter@gmail.com>
+%% 
+%% Permission is hereby granted, free of charge, to any person
+%% obtaining a copy of this software and associated documentation
+%% files (the "Software"), to deal in the Software without
+%% restriction, including without limitation the rights to use,
+%% copy, modify, merge, publish, distribute, sublicense, and/or sell
+%% copies of the Software, and to permit persons to whom the
+%% Software is furnished to do so, subject to the following
+%% conditions:
+%% 
+%% The above copyright notice and this permission notice shall be
+%% included in all copies or substantial portions of the Software.
+%% 
+%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+%% EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+%% OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+%% NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+%% HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+%% WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+%% FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+%% OTHER DEALINGS IN THE SOFTWARE.
+
+%%%-------------------------------------------------------------------
+%%% File : dynamic_compile.erl
+%%% Description :
+%%% Authors : Mats Cronqvist <mats.cronqvist@ericsson.com>
+%%%           Chris Newcombe <chris.newcombe@gmail.com> 
+%%%           Jacob Vorreuter <jacob.vorreuter@gmail.com>
+%%% TODO :
+%%% - add support for limit include-file depth (and prevent circular references)
+%%%   prevent circular macro expansion set FILE correctly when -module() is found
+%%% -include_lib support $ENVVAR in include filenames
+%%%  substitute-stringize (??MACRO)
+%%% -undef/-ifdef/-ifndef/-else/-endif
+%%% -file(File, Line)
+%%%-------------------------------------------------------------------
+-module(dynamic_compile).
+
+%% API
+-export([from_string/1, from_string/2]).
+
+-import(lists, [reverse/1, keyreplace/4]).
+
+%%====================================================================
+%% API
+%%====================================================================
+%%--------------------------------------------------------------------
+%% Function:
+%% Description:
+%%   Returns a binary that can be used with
+%%           code:load_binary(Module, ModuleFilenameForInternalRecords, Binary).
+%%--------------------------------------------------------------------
+from_string(CodeStr) ->
+    from_string(CodeStr, []).
+
+% takes Options as for compile:forms/2
+from_string(CodeStr, CompileFormsOptions) ->
+    %% Initialise the macro dictionary with the default predefined macros,
+    %% (adapted from epp.erl:predef_macros/1
+    Filename = "compiled_from_string",
+    %%Machine  = list_to_atom(erlang:system_info(machine)),
+    Ms0    = dict:new(),
+    % Ms1    = dict:store('FILE',          {[], "compiled_from_string"}, Ms0),
+    % Ms2    = dict:store('LINE',          {[], 1}, Ms1),  % actually we might add special code for this
+    % Ms3    = dict:store('MODULE',        {[], undefined},              Ms2),
+    % Ms4    = dict:store('MODULE_STRING', {[], undefined},              Ms3),
+    % Ms5    = dict:store('MACHINE',       {[], Machine},                Ms4),
+    % InitMD = dict:store(Machine,         {[], true},                   Ms5),
+    InitMD = Ms0,
+
+    %% From the docs for compile:forms:
+    %%    When encountering an -include or -include_dir directive, the compiler searches for header files in the following directories:
+    %%      1. ".", the current working directory of the file server;
+    %%      2. the base name of the compiled file;
+    %%      3. the directories specified using the i option. The directory specified last is searched first.
+    %% In this case, #2 is meaningless.
+    IncludeSearchPath = ["." | reverse([Dir || {i, Dir} <- CompileFormsOptions])],
+    {RevForms, _OutMacroDict} = scan_and_parse(CodeStr, Filename, 1, [], InitMD, IncludeSearchPath),
+    Forms = reverse(RevForms),
+
+    %% note: 'binary' is forced as an implicit option, whether it is provided or not.
+    case compile:forms(Forms, CompileFormsOptions) of
+        {ok, ModuleName, CompiledCodeBinary} when is_binary(CompiledCodeBinary) ->
+            {ModuleName, CompiledCodeBinary};
+        {ok, ModuleName, CompiledCodeBinary, []} when is_binary(CompiledCodeBinary) ->  % empty warnings list
+            {ModuleName, CompiledCodeBinary};
+        {ok, _ModuleName, _CompiledCodeBinary, Warnings} ->
+            throw({?MODULE, warnings, Warnings});
+        Other ->
+            throw({?MODULE, compile_forms, Other})
+    end.
+
+%%====================================================================
+%% Internal functions
+%%====================================================================
+%%% Code from Mats Cronqvist
+%%% See http://www.erlang.org/pipermail/erlang-questions/2007-March/025507.html
+%%%## 'scan_and_parse'
+%%%
+%%% basically we call the OTP scanner and parser (erl_scan and
+%%% erl_parse) line-by-line, but check each scanned line for (or
+%%% definitions of) macros before parsing.
+%% returns {ReverseForms, FinalMacroDict}
+scan_and_parse([], _CurrFilename, _CurrLine, RevForms, MacroDict, _IncludeSearchPath) ->
+    {RevForms, MacroDict};
+
+scan_and_parse(RemainingText, CurrFilename, CurrLine, RevForms, MacroDict, IncludeSearchPath) ->
+    case scanner(RemainingText, CurrLine, MacroDict) of
+	    {tokens, NLine, NRemainingText, Toks} ->
+	        {ok, Form} = erl_parse:parse_form(Toks),
+	        scan_and_parse(NRemainingText, CurrFilename, NLine, [Form | RevForms], MacroDict, IncludeSearchPath);
+	    {macro, NLine, NRemainingText, NMacroDict} ->
+	        scan_and_parse(NRemainingText, CurrFilename, NLine, RevForms,NMacroDict, IncludeSearchPath);
+        {include, NLine, NRemainingText, IncludeFilename} ->
+            IncludeFileRemainingTextents = read_include_file(IncludeFilename, IncludeSearchPath),
+            %%io:format("include file ~p contents: ~n~p~nRemainingText = ~p~n", [IncludeFilename,IncludeFileRemainingTextents, RemainingText]),
+            %% Modify the FILE macro to reflect the filename
+            %%IncludeMacroDict = dict:store('FILE', {[],IncludeFilename}, MacroDict),
+            IncludeMacroDict = MacroDict,
+
+            %% Process the header file (inc. any nested header files)
+            {RevIncludeForms, IncludedMacroDict} = scan_and_parse(IncludeFileRemainingTextents, IncludeFilename, 1, [], IncludeMacroDict, IncludeSearchPath),
+            %io:format("include file results = ~p~n", [R]),
+            %% Restore the FILE macro in the NEW MacroDict (so we keep any macros defined in the header file)
+            %%NMacroDict = dict:store('FILE', {[],CurrFilename}, IncludedMacroDict),
+            NMacroDict = IncludedMacroDict,
+
+            %% Continue with the original file
+	        scan_and_parse(NRemainingText, CurrFilename, NLine, RevIncludeForms ++ RevForms, NMacroDict, IncludeSearchPath);
+        done ->
+	        scan_and_parse([], CurrFilename, CurrLine, RevForms, MacroDict, IncludeSearchPath)
+    end.
+
+scanner(Text, Line, MacroDict) ->
+    case erl_scan:tokens([],Text,Line) of
+        {done, {ok,Toks,NLine}, LeftOverChars} ->
+            case pre_proc(Toks, MacroDict) of
+                {tokens,  NToks}      -> {tokens,  NLine, LeftOverChars, NToks};
+                {macro,   NMacroDict} -> {macro,   NLine, LeftOverChars, NMacroDict};
+                {include, Filename}   -> {include, NLine, LeftOverChars, Filename}
+            end;
+        {more, _Continuation} ->
+            %% This is supposed to mean "term is not yet complete" (i.e. a '.' has
+            %% not been reached yet).
+            %% However, for some bizarre reason we also get this if there is a comment after the final '.' in a file.
+            %% So we check to see if Text only consists of comments.
+            case is_only_comments(Text) of
+                true  ->
+                    done;
+                false ->
+                    throw({incomplete_term, Text, Line})
+            end
+    end.
+
+is_only_comments(Text) -> is_only_comments(Text, not_in_comment).
+
+is_only_comments([],       _)              -> true;
+is_only_comments([$   |T], not_in_comment) -> is_only_comments(T, not_in_comment); % skipping whitspace outside of comment
+is_only_comments([$\t |T], not_in_comment) -> is_only_comments(T, not_in_comment); % skipping whitspace outside of comment
+is_only_comments([$\n |T], not_in_comment) -> is_only_comments(T, not_in_comment); % skipping whitspace outside of comment
+is_only_comments([$%  |T], not_in_comment) -> is_only_comments(T, in_comment);     % found start of a comment
+is_only_comments(_,        not_in_comment) -> false;
+% found any significant char NOT in a comment
+is_only_comments([$\n |T], in_comment)     -> is_only_comments(T, not_in_comment); % found end of a comment
+is_only_comments([_   |T], in_comment)     -> is_only_comments(T, in_comment).     % skipping over in-comment chars
+
+%%%## 'pre-proc'
+%%%
+%%% have to implement a subset of the pre-processor, since epp insists
+%%% on running on a file.
+%%% only handles 2 cases;
+%% -define(MACRO, something).
+%% -define(MACRO(VAR1,VARN),{stuff,VAR1,more,stuff,VARN,extra,stuff}).
+pre_proc([{'-',_},{atom,_,define},{'(',_},{_,_,Name}|DefToks],MacroDict) ->
+    false = dict:is_key(Name, MacroDict),
+    case DefToks of
+    	[{',',_} | Macro] ->
+    	    {macro, dict:store(Name, {[], macro_body_def(Macro, [])},  MacroDict)};
+    	[{'(',_} | Macro] ->
+    	    {macro, dict:store(Name, macro_params_body_def(Macro, []), MacroDict)}
+    end;
+
+pre_proc([{'-',_}, {atom,_,include}, {'(',_}, {string,_,Filename}, {')',_}, {dot,_}], _MacroDict) ->
+    {include, Filename};
+
+pre_proc(Toks,MacroDict) ->
+    {tokens, subst_macros(Toks, MacroDict)}.
+
+macro_params_body_def([{')',_},{',',_} | Toks], RevParams) ->
+    {reverse(RevParams), macro_body_def(Toks, [])};
+macro_params_body_def([{var,_,Param} | Toks], RevParams) ->
+    macro_params_body_def(Toks, [Param | RevParams]);
+macro_params_body_def([{',',_}, {var,_,Param} | Toks], RevParams) ->
+    macro_params_body_def(Toks, [Param | RevParams]).
+
+macro_body_def([{')',_}, {dot,_}], RevMacroBodyToks) ->
+    reverse(RevMacroBodyToks);
+macro_body_def([Tok|Toks], RevMacroBodyToks) ->
+    macro_body_def(Toks, [Tok | RevMacroBodyToks]).
+
+subst_macros(Toks, MacroDict) ->
+    reverse(subst_macros_rev(Toks, MacroDict, [])).
+
+%% returns a reversed list of tokes
+subst_macros_rev([{'?',_}, {_,LineNum,'LINE'} | Toks], MacroDict, RevOutToks) ->
+    %% special-case for ?LINE, to avoid creating a new MacroDict for every line in the source file
+    subst_macros_rev(Toks, MacroDict, [{integer,LineNum,LineNum}] ++ RevOutToks);
+
+subst_macros_rev([{'?',_}, {_,_,Name}, {'(',_} = Paren | Toks], MacroDict, RevOutToks) ->
+    case dict:fetch(Name, MacroDict) of
+        {[], MacroValue} ->
+            %% This macro does not have any vars, so ignore the fact that the invocation is followed by "(...stuff"
+            %% Recursively expand any macro calls inside this macro's value
+            %% TODO: avoid infinite expansion due to circular references (even indirect ones)
+            RevExpandedOtherMacrosToks = subst_macros_rev(MacroValue, MacroDict, []),
+            subst_macros_rev([Paren|Toks], MacroDict, RevExpandedOtherMacrosToks ++ RevOutToks);
+        ParamsAndBody ->
+            %% This macro does have vars.
+            %% Collect all of the passe arguments, in an ordered list
+            {NToks, Arguments} = subst_macros_get_args(Toks, []),
+            %% Expand the varibles
+            ExpandedParamsToks = subst_macros_subst_args_for_vars(ParamsAndBody, Arguments),
+            %% Recursively expand any macro calls inside this macro's value
+            %% TODO: avoid infinite expansion due to circular references (even indirect ones)
+            RevExpandedOtherMacrosToks = subst_macros_rev(ExpandedParamsToks, MacroDict, []),
+            subst_macros_rev(NToks, MacroDict, RevExpandedOtherMacrosToks ++ RevOutToks)
+    end;
+
+subst_macros_rev([{'?',_}, {_,_,Name} | Toks], MacroDict, RevOutToks) ->
+    %% This macro invocation does not have arguments.
+    %% Therefore the definition should not have parameters
+    {[], MacroValue} = dict:fetch(Name, MacroDict),
+
+    %% Recursively expand any macro calls inside this macro's value
+    %% TODO: avoid infinite expansion due to circular references (even indirect ones)
+    RevExpandedOtherMacrosToks = subst_macros_rev(MacroValue, MacroDict, []),
+    subst_macros_rev(Toks, MacroDict, RevExpandedOtherMacrosToks ++ RevOutToks);
+
+subst_macros_rev([Tok|Toks], MacroDict,  RevOutToks) ->
+subst_macros_rev(Toks, MacroDict, [Tok|RevOutToks]);
+subst_macros_rev([], _MacroDict, RevOutToks) -> RevOutToks.
+
+subst_macros_get_args([{')',_} | Toks], RevArgs) ->
+    {Toks, reverse(RevArgs)};
+subst_macros_get_args([{',',_}, {var,_,ArgName} | Toks], RevArgs) ->
+    subst_macros_get_args(Toks, [ArgName| RevArgs]);
+subst_macros_get_args([{var,_,ArgName} | Toks], RevArgs) ->
+    subst_macros_get_args(Toks, [ArgName | RevArgs]).
+
+subst_macros_subst_args_for_vars({[], BodyToks}, []) ->
+    BodyToks;
+subst_macros_subst_args_for_vars({[Param | Params], BodyToks}, [Arg|Args]) ->
+    NBodyToks = keyreplace(Param, 3, BodyToks, {var,1,Arg}),
+    subst_macros_subst_args_for_vars({Params, NBodyToks}, Args).
+
+read_include_file(Filename, IncludeSearchPath) ->
+    case file:path_open(IncludeSearchPath, Filename, [read, raw, binary]) of
+        {ok, IoDevice, FullName} ->
+            {ok, Data} = file:read(IoDevice, filelib:file_size(FullName)),
+            file:close(IoDevice),
+            binary_to_list(Data);
+        {error, Reason} ->
+            throw({failed_to_read_include_file, Reason, Filename, IncludeSearchPath})
+    end.

src/ejabberd.app

@@ -1,51 +1,131 @@
-% $Id$
+%% $Id$
 
 {application, ejabberd,
  [{description, "ejabberd"},
-  {vsn, "1.0.0"},
+  {vsn, "2.1.5"},
   {modules, [acl,
+	     adhoc,
 	     configure,
+	     cyrsasl_anonymous,
 	     cyrsasl,
 	     cyrsasl_digest,
 	     cyrsasl_plain,
-	     ejabberd,
+	     ejabberd_admin,
 	     ejabberd_app,
+	     ejabberd_auth_anonymous,
 	     ejabberd_auth,
+	     ejabberd_auth_external,
+	     ejabberd_auth_internal,
+	     ejabberd_auth_ldap,
+	     ejabberd_auth_odbc,
+	     ejabberd_auth_pam,
+	     ejabberd,
 	     ejabberd_c2s,
+	     ejabberd_c2s_config,
 	     ejabberd_config,
+	     ejabberd_ctl,
+	     ejabberd_frontend_socket,
+	     ejabberd_hooks,
+	     ejabberd_http,
+	     ejabberd_http_bind,
+	     ejabberd_http_poll,
 	     ejabberd_listener,
-	     ejabberd_logger_h,
 	     ejabberd_local,
+	     ejabberd_logger_h,
+	     ejabberd_loglevel,
+	     ejabberd_node_groups,
+	     ejabberd_rdbms,
+	     ejabberd_receiver,
 	     ejabberd_router,
 	     ejabberd_s2s,
 	     ejabberd_s2s_in,
 	     ejabberd_s2s_out,
 	     ejabberd_service,
 	     ejabberd_sm,
+	     ejabberd_socket,
 	     ejabberd_sup,
+	     ejabberd_system_monitor,
 	     ejabberd_tmp_sup,
+	     ejabberd_update,
+	     ejabberd_web_admin,
+	     ejabberd_web,
+	     ejabberd_zlib,
+	     ejd2odbc,
+	     eldap,
+	     eldap_filter,
+	     eldap_pool,
+	     eldap_utils,
+	     'ELDAPv3',
+	     extauth,
 	     gen_iq_handler,
 	     gen_mod,
+	     gen_pubsub_node,
+	     gen_pubsub_nodetree,
+	     iconv,
+	     idna,
 	     jd2ejd,
 	     jlib,
+	     mod_adhoc,
+	     mod_announce,
+	     mod_caps,
+	     mod_configure2,
 	     mod_configure,
 	     mod_disco,
 	     mod_echo,
+	     mod_http_bind,
+	     mod_http_fileserver,
+	     mod_irc,
+	     mod_irc_connection,
 	     mod_last,
+	     mod_last_odbc,
+	     mod_muc,
+	     mod_muc_log,
+	     mod_muc_room,
 	     mod_offline,
+	     mod_offline_odbc,
+	     mod_privacy,
+	     mod_privacy_odbc,
 	     mod_private,
+	     mod_private_odbc,
+	     mod_proxy65,
+	     mod_proxy65_lib,
+	     mod_proxy65_service,
+	     mod_proxy65_sm,
+	     mod_proxy65_stream,
+	     mod_pubsub,
 	     mod_register,
 	     mod_roster,
+	     mod_roster_odbc,
+	     mod_service_log,
+	     mod_shared_roster,
 	     mod_stats,
 	     mod_time,
 	     mod_vcard,
+	     mod_vcard_ldap,
+	     mod_vcard_odbc,
 	     mod_version,
+	     node_buddy,
+	     node_club,
+	     node_default,
+	     node_dispatch,
+	     node_pep,
+	     node_private,
+	     node_public,
+	     nodetree_default,
+	     nodetree_virtual,
+	     p1_fsm,
+	     p1_mnesia,
+	     p1_prof,
 	     randoms,
 	     sha,
 	     shaper,
+	     stringprep,
+	     stringprep_sup,
+	     tls,
 	     translate,
 	     xml,
-	     xml_stream
+	     xml_stream,
+	     'XmppAddr'
 	    ]},
   {registered, [ejabberd,
 		ejabberd_sup,
@@ -73,7 +153,7 @@
   {mod, {ejabberd_app, []}}]}.
 
 
-
-% Local Variables:
-% mode: erlang
-% End:
+%% Local Variables:
+%% mode: erlang
+%% End:
+%% vim: set filetype=erlang tabstop=8:

src/ejabberd.cfg.example

@@ -1,182 +1,568 @@
-% $Id$
+%%%
+%%%               ejabberd configuration file
+%%%
+%%%'
 
-%override_acls.
+%%% The parameters used in this configuration file are explained in more detail
+%%% in the ejabberd Installation and Operation Guide.
+%%% Please consult the Guide in case of doubts, it is included with
+%%% your copy of ejabberd, and is also available online at
+%%% http://www.process-one.net/en/ejabberd/docs/
+
+%%% This configuration file contains Erlang terms.
+%%% In case you want to understand the syntax, here are the concepts:
+%%%
+%%%  - The character to comment a line is %
+%%%
+%%%  - Each term ends in a dot, for example:
+%%%      override_global.
+%%%
+%%%  - A tuple has a fixed definition, its elements are
+%%%    enclosed in {}, and separated with commas:
+%%%      {loglevel, 4}.
+%%%
+%%%  - A list can have as many elements as you want,
+%%%    and is enclosed in [], for example:
+%%%      [http_poll, web_admin, tls]
+%%%
+%%%  - A keyword of ejabberd is a word in lowercase.
+%%%    Strings are enclosed in "" and can contain spaces, dots, ...
+%%%      {language, "en"}.
+%%%      {ldap_rootdn, "dc=example,dc=com"}.
+%%%
+%%%  - This term includes a tuple, a keyword, a list, and two strings:
+%%%      {hosts, ["jabber.example.net", "im.example.com"]}.
+%%%
 
 
-% Users that have admin access.  Add line like one of the following after you
-% will be successfully registered on server to get admin access:
-%{acl, admin, {user, "aleksey"}}.
-%{acl, admin, {user, "ermine"}}.
+%%%.   =======================
+%%%'   OVERRIDE STORED OPTIONS
 
-% Blocked users:
-%{acl, blocked, {user, "test"}}.
+%%
+%% Override the old values stored in the database.
+%%
 
-% Local users:
-{acl, local, {user_regexp, ""}}.
+%%
+%% Override global options (shared by all ejabberd nodes in a cluster).
+%%
+%%override_global.
 
-% Another examples of ACLs:
-%{acl, jabberorg, {server, "jabber.org"}}.
-%{acl, aleksey, {user, "aleksey", "jabber.ru"}}.
-%{acl, test, {user_regexp, "^test"}}.
-%{acl, test, {user_glob, "test*"}}.
+%%
+%% Override local options (specific for this particular ejabberd node).
+%%
+%%override_local.
+
+%%
+%% Remove the Access Control Lists before new ones are added.
+%%
+%%override_acls.
 
 
-% Only admins can use configuration interface:
-{access, configure, [{allow, admin}]}.
+%%%.   =========
+%%%'   DEBUGGING
 
-% Every username can be registered via in-band registration:
-% You could replace {allow, all} with {deny, all} to prevent user from using
-% in-band registration
-{access, register, [{allow, all}]}.
+%%
+%% loglevel: Verbosity of log files generated by ejabberd.
+%% 0: No ejabberd log at all (not recommended)
+%% 1: Critical
+%% 2: Error
+%% 3: Warning
+%% 4: Info
+%% 5: Debug
+%%
+{loglevel, 4}.
 
-% After successful registration user will get message with following subject
-% and body:
-{welcome_message,
- {"Welcome!",
-  "Welcome to Jabber Service.  "
-  "For information about Jabber visit http://jabber.org"}}.
-% Replace them with 'none' if you don't want to send such message:
-%{welcome_message, none}.
-
-% List of people who will get notifications about registered users
-%{registration_watchers, ["admin1@localhost",
-%                         "admin2@localhost"]}.
-
-% Only admins can send announcement messages:
-{access, announce, [{allow, admin}]}.
+%%
+%% watchdog_admins: Only useful for developers: if an ejabberd process
+%% consumes a lot of memory, send live notifications to these XMPP
+%% accounts.
+%%
+%%{watchdog_admins, ["bob@example.com"]}.
 
 
-% Only non-blocked users can use c2s connections:
-{access, c2s, [{deny, blocked},
-	       {allow, all}]}.
+%%%.   ================
+%%%'   SERVED HOSTNAMES
 
-% Set shaper with name "normal" to limit traffic speed to 1000B/s
-{shaper, normal, {maxrate, 1000}}.
-
-% Set shaper with name "fast" to limit traffic speed to 50000B/s
-{shaper, fast, {maxrate, 50000}}.
-
-% For all users except admins used "normal" shaper
-{access, c2s_shaper, [{none, admin},
-		      {normal, all}]}.
-
-% For all S2S connections used "fast" shaper
-{access, s2s_shaper, [{fast, all}]}.
-
-% Admins of this server are also admins of MUC service:
-{access, muc_admin, [{allow, admin}]}.
-
-% All users are allowed to use MUC service:
-{access, muc, [{allow, all}]}.
-
-% This rule allows access only for local users:
-{access, local, [{allow, local}]}.
-
-
-% Authentication method.  If you want to use internal user base, then use
-% this line:
-{auth_method, internal}.
-
-% For LDAP authentication use these lines instead of above one:
-%{auth_method, ldap}.
-%{ldap_servers, ["localhost"]}.    % List of LDAP servers
-%{ldap_uidattr, "uid"}.            % LDAP attribute that holds user ID
-%{ldap_base, "dc=example,dc=com"}. % Search base of LDAP directory
-%{ldap_rootdn, "dc=example,dc=com"}. % LDAP manager
-%{ldap_password, "******"}. % Password to LDAP manager
-
-% For authentication via external script use the following:
-%{auth_method, external}.
-%{extauth_program, "/path/to/authentication/script"}.
-
-% For authentication via ODBC use the following:
-%{auth_method, odbc}.
-%{odbc_server, "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"}.
-
-
-% Host name:
+%%
+%% hosts: Domains served by ejabberd.
+%% You can define one or several, for example:
+%% {hosts, ["example.net", "example.com", "example.org"]}.
+%%
 {hosts, ["localhost"]}.
 
+%%
+%% route_subdomains: Delegate subdomains to other XMPP servers.
+%% For example, if this ejabberd serves example.org and you want
+%% to allow communication with an XMPP server called im.example.org.
+%%
+%%{route_subdomains, s2s}.
+
+
+%%%.   ===============
+%%%'   LISTENING PORTS
+
+%%
+%% listen: The ports ejabberd will listen on, which service each is handled
+%% by and what options to start it with.
+%%
+{listen,
+ [
+
+  {5222, ejabberd_c2s, [
+
+			%%
+			%% If TLS is compiled in and you installed a SSL
+			%% certificate, specify the full path to the
+			%% file and uncomment this line:
+			%%
+			%%{certfile, "/path/to/ssl.pem"}, starttls,
+
+			{access, c2s},
+			{shaper, c2s_shaper},
+			{max_stanza_size, 65536}
+		       ]},
+
+  %%
+  %% To enable the old SSL connection method on port 5223:
+  %%
+  %%{5223, ejabberd_c2s, [
+  %%			{access, c2s},
+  %%			{shaper, c2s_shaper},
+  %%			{certfile, "/path/to/ssl.pem"}, tls,
+  %%			{max_stanza_size, 65536}
+  %%		       ]},
+
+  {5269, ejabberd_s2s_in, [
+			   {shaper, s2s_shaper},
+			   {max_stanza_size, 131072}
+			  ]},
+
+  %%
+  %% ejabberd_service: Interact with external components (transports, ...)
+  %%
+  %%{8888, ejabberd_service, [
+  %%			    {access, all},
+  %%			    {shaper_rule, fast},
+  %%			    {ip, {127, 0, 0, 1}},
+  %%			    {hosts, ["icq.example.org", "sms.example.org"],
+  %%			     [{password, "secret"}]
+  %%			    }
+  %%			   ]},
+
+  %%
+  %% ejabberd_stun: Handles STUN Binding requests
+  %%
+  %%{{3478, udp}, ejabberd_stun, []},
+
+  {5280, ejabberd_http, [
+			 %%{request_handlers,
+			 %% [
+			 %%  {["pub", "archive"], mod_http_fileserver}
+			 %% ]},
+			 captcha,
+			 http_bind,
+			 http_poll,
+			 web_admin
+			]}
+
+ ]}.
+
+%%
+%% s2s_use_starttls: Enable STARTTLS + Dialback for S2S connections.
+%% Allowed values are: true or false.
+%% You must specify a certificate file.
+%%
+%%{s2s_use_starttls, true}.
+
+%%
+%% s2s_certfile: Specify a certificate file.
+%%
+%%{s2s_certfile, "/path/to/ssl.pem"}.
+
+%%
+%% domain_certfile: Specify a different certificate for each served hostname.
+%%
+%%{domain_certfile, "example.org", "/path/to/example_org.pem"}.
+%%{domain_certfile, "example.com", "/path/to/example_com.pem"}.
+
+%%
+%% S2S whitelist or blacklist
+%%
+%% Default s2s policy for undefined hosts.
+%%
+%%{s2s_default_policy, allow}.
+
+%%
+%% Allow or deny communication with specific servers.
+%%
+%%{{s2s_host, "goodhost.org"}, allow}.
+%%{{s2s_host, "badhost.org"}, deny}.
+
+%%
+%% Outgoing S2S options
+%%
+%% Preferred address families (which to try first) and connect timeout
+%% in milliseconds.
+%%
+%%{outgoing_s2s_options, [ipv4, ipv6], 10000}.
+
+
+%%%.   ==============
+%%%'   AUTHENTICATION
+
+%%
+%% auth_method: Method used to authenticate the users.
+%% The default method is the internal.
+%% If you want to use a different method,
+%% comment this line and enable the correct ones.
+%%
+{auth_method, internal}.
+
+%%
+%% Authentication using external script
+%% Make sure the script is executable by ejabberd.
+%%
+%%{auth_method, external}.
+%%{extauth_program, "/path/to/authentication/script"}.
+
+%%
+%% Authentication using ODBC
+%% Remember to setup a database in the next section.
+%%
+%%{auth_method, odbc}.
+
+%%
+%% Authentication using PAM
+%%
+%%{auth_method, pam}.
+%%{pam_service, "pamservicename"}.
+
+%%
+%% Authentication using LDAP
+%%
+%%{auth_method, ldap}.
+%%
+%% List of LDAP servers:
+%%{ldap_servers, ["localhost"]}.
+%%
+%% Encryption of connection to LDAP servers:
+%%{ldap_encrypt, none}.
+%%{ldap_encrypt, tls}.
+%%
+%% Port to connect to on LDAP servers:
+%%{ldap_port, 389}.
+%%{ldap_port, 636}.
+%%
+%% LDAP manager:
+%%{ldap_rootdn, "dc=example,dc=com"}.
+%%
+%% Password of LDAP manager:
+%%{ldap_password, "******"}.
+%%
+%% Search base of LDAP directory:
+%%{ldap_base, "dc=example,dc=com"}.
+%%
+%% LDAP attribute that holds user ID:
+%%{ldap_uids, [{"mail", "%u@mail.example.org"}]}.
+%%
+%% LDAP filter:
+%%{ldap_filter, "(objectClass=shadowAccount)"}.
+
+%%
 %% Anonymous login support:
-%%  auth_method: anonymous
-%%  anonymous_protocol: sasl_anon|login_anon|both
-%%  allow_multiple_connections: true|false
+%%   auth_method: anonymous
+%%   anonymous_protocol: sasl_anon | login_anon | both
+%%   allow_multiple_connections: true | false
+%%
 %%{host_config, "public.example.org", [{auth_method, anonymous},
 %%                                     {allow_multiple_connections, false},
 %%                                     {anonymous_protocol, sasl_anon}]}.
+%%
 %% To use both anonymous and internal authentication:
-%%{host_config, "public.example.org", [{auth_method, [anonymous, internal]}]}.
+%%
+%%{host_config, "public.example.org", [{auth_method, [internal, anonymous]}]}.
 
-% Default language for server messages
+
+%%%.   ==============
+%%%'   DATABASE SETUP
+
+%% ejabberd by default uses the internal Mnesia database,
+%% so you do not necessarily need this section.
+%% This section provides configuration examples in case
+%% you want to use other database backends.
+%% Please consult the ejabberd Guide for details on database creation.
+
+%%
+%% MySQL server:
+%%
+%%{odbc_server, {mysql, "server", "database", "username", "password"}}.
+%%
+%% If you want to specify the port:
+%%{odbc_server, {mysql, "server", 1234, "database", "username", "password"}}.
+
+%%
+%% PostgreSQL server:
+%%
+%%{odbc_server, {pgsql, "server", "database", "username", "password"}}.
+%%
+%% If you want to specify the port:
+%%{odbc_server, {pgsql, "server", 1234, "database", "username", "password"}}.
+%%
+%% If you use PostgreSQL, have a large database, and need a
+%% faster but inexact replacement for "select count(*) from users"
+%%
+%%{pgsql_users_number_estimate, true}.
+
+%%
+%% ODBC compatible or MSSQL server:
+%%
+%%{odbc_server, "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"}.
+
+%%
+%% Number of connections to open to the database for each virtual host
+%%
+%%{odbc_pool_size, 10}.
+
+%%
+%% Interval to make a dummy SQL request to keep the connections to the
+%% database alive. Specify in seconds: for example 28800 means 8 hours
+%%
+%%{odbc_keepalive_interval, undefined}.
+
+
+%%%.   ===============
+%%%'   TRAFFIC SHAPERS
+
+%%
+%% The "normal" shaper limits traffic speed to 1000 B/s
+%%
+{shaper, normal, {maxrate, 1000}}.
+
+%%
+%% The "fast" shaper limits traffic speed to 50000 B/s
+%%
+{shaper, fast, {maxrate, 50000}}.
+
+%%
+%% This option specifies the maximum number of elements in the queue
+%% of the FSM. Refer to the documentation for details.
+%%
+{max_fsm_queue, 1000}.
+
+
+%%%.   ====================
+%%%'   ACCESS CONTROL LISTS
+
+%%
+%% The 'admin' ACL grants administrative privileges to XMPP accounts.
+%% You can put here as many accounts as you want.
+%%
+%%{acl, admin, {user, "aleksey", "localhost"}}.
+%%{acl, admin, {user, "ermine", "example.org"}}.
+
+%%
+%% Blocked users
+%%
+%%{acl, blocked, {user, "baduser", "example.org"}}.
+%%{acl, blocked, {user, "test"}}.
+
+%%
+%% Local users: don't modify this line.
+%%
+{acl, local, {user_regexp, ""}}.
+
+%%
+%% More examples of ACLs
+%%
+%%{acl, jabberorg, {server, "jabber.org"}}.
+%%{acl, aleksey, {user, "aleksey", "jabber.ru"}}.
+%%{acl, test, {user_regexp, "^test"}}.
+%%{acl, test, {user_glob, "test*"}}.
+
+%%
+%% Define specific ACLs in a virtual host.
+%%
+%%{host_config, "localhost",
+%% [
+%%  {acl, admin, {user, "bob-local", "localhost"}}
+%% ]
+%%}.
+
+
+%%%.   ============
+%%%'   ACCESS RULES
+
+%% Maximum number of simultaneous sessions allowed for a single user:
+{access, max_user_sessions, [{10, all}]}.
+
+%% Maximum number of offline messages that users can have:
+{access, max_user_offline_messages, [{5000, admin}, {100, all}]}.
+
+%% This rule allows access only for local users:
+{access, local, [{allow, local}]}.
+
+%% Only non-blocked users can use c2s connections:
+{access, c2s, [{deny, blocked},
+	       {allow, all}]}.
+
+%% For C2S connections, all users except admins use the "normal" shaper
+{access, c2s_shaper, [{none, admin},
+		      {normal, all}]}.
+
+%% All S2S connections use the "fast" shaper
+{access, s2s_shaper, [{fast, all}]}.
+
+%% Only admins can send announcement messages:
+{access, announce, [{allow, admin}]}.
+
+%% Only admins can use the configuration interface:
+{access, configure, [{allow, admin}]}.
+
+%% Admins of this server are also admins of the MUC service:
+{access, muc_admin, [{allow, admin}]}.
+
+%% Only accounts of the local ejabberd server can create rooms:
+{access, muc_create, [{allow, local}]}.
+
+%% All users are allowed to use the MUC service:
+{access, muc, [{allow, all}]}.
+
+%% Only accounts on the local ejabberd server can create Pubsub nodes:
+{access, pubsub_createnode, [{allow, local}]}.
+
+%% In-band registration allows registration of any possible username.
+%% To disable in-band registration, replace 'allow' with 'deny'.
+{access, register, [{allow, all}]}.
+
+%% By default the frequency of account registrations from the same IP
+%% is limited to 1 account every 10 minutes. To disable, specify: infinity
+%%{registration_timeout, 600}.
+
+%%
+%% Define specific Access Rules in a virtual host.
+%%
+%%{host_config, "localhost",
+%% [
+%%  {access, c2s, [{allow, admin}, {deny, all}]},
+%%  {access, register, [{deny, all}]}
+%% ]
+%%}.
+
+
+%%%.   ================
+%%%'   DEFAULT LANGUAGE
+
+%%
+%% language: Default language used for server messages.
+%%
 {language, "en"}.
 
-% Listened ports:
-{listen,
- [{5222, ejabberd_c2s,     [{access, c2s}, {shaper, c2s_shaper},
-			    {max_stanza_size, 65536},
-			    starttls, {certfile, "./ssl.pem"}]},
-  {5223, ejabberd_c2s,     [{access, c2s},
-			    {max_stanza_size, 65536},
-			    tls, {certfile, "./ssl.pem"}]},
-  % Use these two lines instead if TLS support is not compiled
-  %{5222, ejabberd_c2s,     [{access, c2s}, {shaper, c2s_shaper}]},
-  %{5223, ejabberd_c2s,     [{access, c2s}, ssl, {certfile, "./ssl.pem"}]},
-  {5269, ejabberd_s2s_in,  [{shaper, s2s_shaper},
-			    {max_stanza_size, 131072}
-			   ]},
-  {5280, ejabberd_http,    [http_poll, web_admin]},
-  {8888, ejabberd_service, [{access, all},
-			    {hosts, ["icq.localhost", "sms.localhost"],
-			     [{password, "secret"}]}]}
- ]}.
+%%
+%% Set a different default language in a virtual host.
+%%
+%%{host_config, "localhost",
+%% [{language, "ru"}]
+%%}.
 
 
-% Use STARTTLS+Dialback for S2S connections
-{s2s_use_starttls, true}.
-{s2s_certfile, "./ssl.pem"}.
-%{domain_certfile, "example.org", "./example_org.pem"}.
-%{domain_certfile, "example.com", "./example_com.pem"}.
+%%%.   =======
+%%%'   CAPTCHA
 
-% If SRV lookup fails, then port 5269 is used to communicate with remote server
-{outgoing_s2s_port, 5269}.
+%%
+%% Full path to a script that generates the image.
+%%
+%%{captcha_cmd, "/lib/ejabberd/priv/bin/captcha.sh"}.
+
+%%
+%% Host part of the URL sent to the user.
+%%
+%%{captcha_host, "example.org:5280"}.
 
 
-% Used modules:
+%%%.   =======
+%%%'   MODULES
+
+%%
+%% Modules enabled in all ejabberd virtual hosts.
+%%
 {modules,
  [
-  {mod_register,   [{access, register}]},
-  {mod_roster,     []},
-  {mod_privacy,    []},
-  {mod_adhoc,      []},
-  {mod_configure,  []}, % Depends on mod_adhoc
-  {mod_configure2, []},
-  {mod_disco,      []},
-  {mod_stats,      []},
-  {mod_vcard,      []},
-  {mod_offline,    []},
-  {mod_announce,   [{access, announce}]}, % Depends on mod_adhoc
-  {mod_echo,       [{host, "echo.localhost"}]},
-  {mod_private,    []},
-  {mod_irc,        []},
-% Default options for mod_muc:
-%   host: "conference." ++ ?MYNAME
-%   access: all
-%   access_create: all
-%   access_admin: none (only room creator has owner privileges)
-  {mod_muc,        [{access, muc},
-		    {access_create, muc},
-		    {access_admin, muc_admin}]},
-%  {mod_muc_log,    []},
-%  {mod_shared_roster, []},
-  {mod_pubsub,     []},
-  {mod_time,       []},
-  {mod_last,       []},
-  {mod_version,    []}
+  {mod_adhoc,    []},
+  {mod_announce, [{access, announce}]}, % recommends mod_adhoc
+  {mod_caps,     []},
+  {mod_configure,[]}, % requires mod_adhoc
+  {mod_disco,    []},
+  %%{mod_echo,   [{host, "echo.localhost"}]},
+  {mod_irc,      []},
+  {mod_http_bind, []},
+  %%{mod_http_fileserver, [
+  %%                       {docroot, "/var/www"},
+  %%                       {accesslog, "/var/log/ejabberd/access.log"}
+  %%                      ]},
+  {mod_last,     []},
+  {mod_muc,      [
+		  %%{host, "conference.@HOST@"},
+		  {access, muc},
+		  {access_create, muc_create},
+		  {access_persistent, muc_create},
+		  {access_admin, muc_admin}
+		 ]},
+  %%{mod_muc_log,[]},
+  {mod_offline,  [{access_max_user_messages, max_user_offline_messages}]},
+  {mod_ping,     []},
+  {mod_privacy,  []},
+  {mod_private,  []},
+  %%{mod_proxy65,[]},
+  {mod_pubsub,   [
+		  {access_createnode, pubsub_createnode},
+		  {ignore_pep_from_offline, true}, % reduces resource comsumption, but XEP incompliant
+		  %%{ignore_pep_from_offline, false},  % XEP compliant, but increases resource comsumption
+		  {last_item_cache, false},
+		  {plugins, ["flat", "hometree", "pep"]}  % pep requires mod_caps
+		 ]},
+  {mod_register, [
+		  %%
+		  %% After successful registration, the user receives
+		  %% a message with this subject and body.
+		  %%
+		  {welcome_message, {"Welcome!",
+				     "Hi.\nWelcome to this XMPP server."}},
+
+		  %%
+		  %% When a user registers, send a notification to
+		  %% these XMPP accounts.
+		  %%
+		  %%{registration_watchers, ["admin1@example.org"]},
+
+		  {access, register}
+		 ]},
+  {mod_roster,   []},
+  %%{mod_service_log,[]},
+  {mod_shared_roster,[]},
+  {mod_stats,    []},
+  {mod_time,     []},
+  {mod_vcard,    []},
+  {mod_version,  []}
  ]}.
 
+%%
+%% Enable modules with custom options in a specific virtual host
+%%
+%%{host_config, "localhost",
+%% [{{add, modules},
+%%   [
+%%    {mod_echo, [{host, "mirror.localhost"}]}
+%%   ]
+%%  }
+%% ]}.
 
 
+%%%.
+%%%'
 
-% Local Variables:
-% mode: erlang
-% End:
+%%% $Id$
+
+%%% Local Variables:
+%%% mode: erlang
+%%% End:
+%%% vim: set filetype=erlang tabstop=8 foldmarker=%%%',%%%. foldmethod=marker:

src/ejabberd.erl

@@ -1,24 +1,43 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
-%%% Purpose : 
-%%% Created : 16 Nov 2002 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
+%%% Purpose : ejabberd wrapper: start / stop
+%%% Created : 16 Nov 2002 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -export([start/0, stop/0,
-	 get_so_path/0]).
+	 get_pid_file/0,
+	 get_so_path/0, get_bin_path/0]).
 
 start() ->
+    %%ejabberd_cover:start(),
     application:start(ejabberd).
 
 stop() ->
     application:stop(ejabberd).
-
+    %%ejabberd_cover:stop().
 
 get_so_path() ->
     case os:getenv("EJABBERD_SO_PATH") of
@@ -32,3 +51,27 @@ get_so_path() ->
 	Path ->
 	    Path
     end.
+
+get_bin_path() ->
+    case os:getenv("EJABBERD_BIN_PATH") of
+	false ->
+	    case code:priv_dir(ejabberd) of
+		{error, _} ->
+		    ".";
+		Path ->
+		    filename:join([Path, "bin"])
+	    end;
+	Path ->
+	    Path
+    end.
+
+%% @spec () -> false | string()
+get_pid_file() ->
+    case os:getenv("EJABBERD_PID_PATH") of
+	false ->
+	    false;
+	"" ->
+	    false;
+	Path ->
+	    Path
+    end.

src/ejabberd.hrl

@@ -1,41 +1,61 @@
 %%%----------------------------------------------------------------------
-%%% File    : ejabberd.hrl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
-%%% Purpose : 
-%%% Created : 17 Nov 2002 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
--define(VERSION, "1.1.1").
-
-%-define(ejabberd_debug, true).
-%-define(DBGFSM, true).
-
--ifdef(ejabberd_debug).
--define(DEBUG(Format, Args), io:format("D(~p:~p:~p) : "++Format++"~n",
-                                       [self(),?MODULE,?LINE]++Args)).
--else.
--define(DEBUG(F,A),[]).
--endif.
-
--define(ERROR_MSG(Format, Args),
-	error_logger:error_msg("E(~p:~p:~p): "++Format++"~n",
-			       [self(),?MODULE,?LINE]++Args)).
-
--define(INFO_MSG(Format, Args),
-	error_logger:info_msg("I(~p:~p:~p): "++Format++"~n",
-			      [self(),?MODULE,?LINE]++Args)).
-
+%% This macro returns a string of the ejabberd version running, e.g. "2.3.4"
+%% If the ejabberd application description isn't loaded, returns atom: undefined
+-define(VERSION, element(2, application:get_key(ejabberd,vsn))).
 
 -define(MYHOSTS, ejabberd_config:get_global_option(hosts)).
 -define(MYNAME, hd(ejabberd_config:get_global_option(hosts))).
--define(S2STIMEOUT, 600000).
 -define(MYLANG, ejabberd_config:get_global_option(language)).
 
 -define(MSGS_DIR, "msgs").
 -define(CONFIG_PATH, "ejabberd.cfg").
 -define(LOG_PATH, "ejabberd.log").
 
+-define(EJABBERD_URI, "http://www.process-one.net/en/ejabberd/").
 
--define(PRIVACY_SUPPORT, true).
+-define(S2STIMEOUT, 600000).
+
+%%-define(DBGFSM, true).
+
+%% ---------------------------------
+%% Logging mechanism
+
+%% Print in standard output
+-define(PRINT(Format, Args),
+    io:format(Format, Args)).
+
+-define(DEBUG(Format, Args),
+    ejabberd_logger:debug_msg(?MODULE,?LINE,Format, Args)).
+
+-define(INFO_MSG(Format, Args),
+    ejabberd_logger:info_msg(?MODULE,?LINE,Format, Args)).
+			      
+-define(WARNING_MSG(Format, Args),
+    ejabberd_logger:warning_msg(?MODULE,?LINE,Format, Args)).
+			      
+-define(ERROR_MSG(Format, Args),
+    ejabberd_logger:error_msg(?MODULE,?LINE,Format, Args)).
+
+-define(CRITICAL_MSG(Format, Args),
+    ejabberd_logger:critical_msg(?MODULE,?LINE,Format, Args)).
 

src/ejabberd.init.template

@@ -0,0 +1,46 @@
+#! /bin/sh
+set -o errexit
+set -o nounset
+
+DIR=@ctlscriptpath@
+CTL="$DIR"/ejabberdctl
+USER=@installuser@
+
+test -x "$CTL" || {
+	echo "ERROR: ejabberd not found: $DIR"
+	exit 1
+}
+grep ^"$USER": /etc/passwd >/dev/null || {
+	echo "ERROR: System user not found: $USER"
+	exit 2
+}
+
+export PATH="${PATH:+$PATH:}/usr/sbin:/sbin"
+
+case "$1" in
+  start)
+    test -x "$CTL" || exit 0
+    echo "Starting ejabberd..."
+    su - $USER -c "$CTL start"
+    su - $USER -c "$CTL started"
+    echo "done."
+    ;;
+  stop)
+    test -x "$CTL" || exit 0
+    echo "Stopping ejabberd..."
+    su - $USER -c "$CTL stop"
+    su - $USER -c "$CTL stopped"
+    echo "done."
+    ;;
+
+  force-reload|restart)
+    "$0" stop
+    "$0" start
+    ;;
+
+  *)
+    echo "Usage: $0 {start|stop|restart|force-reload}"
+    exit 1
+esac
+
+exit 0

src/ejabberd_admin.erl

@@ -0,0 +1,584 @@
+%%%-------------------------------------------------------------------
+%%% File    : ejabberd_admin.erl
+%%% Author  : Mickael Remond <mremond@process-one.net>
+%%% Purpose : Administrative functions and commands
+%%% Created :  7 May 2006 by Mickael Remond <mremond@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%-------------------------------------------------------------------
+
+-module(ejabberd_admin).
+-author('mickael.remond@process-one.net').
+
+-export([start/0, stop/0,
+	 %% Server
+	 status/0, reopen_log/0,
+	 stop_kindly/2, send_service_message_all_mucs/2,
+	 %% Erlang
+	 update_list/0, update/1,
+	 %% Accounts
+	 register/3, unregister/2,
+	 registered_users/1,
+	 %% Migration jabberd1.4
+	 import_file/1, import_dir/1,
+	 %% Purge DB
+	 delete_expired_messages/0, delete_old_messages/1,
+	 %% Mnesia
+	 set_master/1,
+	 backup_mnesia/1, restore_mnesia/1,
+	 dump_mnesia/1, dump_table/2, load_mnesia/1,
+	 install_fallback_mnesia/1,
+	 dump_to_textfile/1, dump_to_textfile/2,
+	 mnesia_change_nodename/4,
+	 restore/1 % Still used by some modules
+	]).
+
+-include("ejabberd.hrl").
+-include("ejabberd_commands.hrl").
+
+start() ->
+    ejabberd_commands:register_commands(commands()).
+
+stop() ->
+    ejabberd_commands:unregister_commands(commands()).
+
+%%%
+%%% ejabberd commands
+%%%
+
+commands() ->
+    [
+     %% The commands status, stop and restart are implemented also in ejabberd_ctl
+     %% They are defined here so that other interfaces can use them too
+     #ejabberd_commands{name = status, tags = [server],
+			desc = "Get status of the ejabberd server",
+			module = ?MODULE, function = status,
+			args = [], result = {res, restuple}},
+     #ejabberd_commands{name = stop, tags = [server],
+			desc = "Stop ejabberd gracefully",
+			module = init, function = stop,
+			args = [], result = {res, rescode}},
+     #ejabberd_commands{name = restart, tags = [server],
+			desc = "Restart ejabberd gracefully",
+			module = init, function = restart,
+			args = [], result = {res, rescode}},
+     #ejabberd_commands{name = reopen_log, tags = [logs, server],
+			desc = "Reopen the log files",
+			module = ?MODULE, function = reopen_log,
+			args = [], result = {res, rescode}},
+     #ejabberd_commands{name = stop_kindly, tags = [server],
+			desc = "Inform users and rooms, wait, and stop the server",
+			module = ?MODULE, function = stop_kindly,
+			args = [{delay, integer}, {announcement, string}],
+			result = {res, rescode}},
+     #ejabberd_commands{name = get_loglevel, tags = [logs, server],
+			desc = "Get the current loglevel",
+			module = ejabberd_loglevel, function = get,
+			args = [],
+                        result = {leveltuple, {tuple, [{levelnumber, integer},
+                                                       {levelatom, atom},
+                                                       {leveldesc, string}
+                                                      ]}}},
+
+     #ejabberd_commands{name = update_list, tags = [server],
+			desc = "List modified modules that can be updated",
+			module = ?MODULE, function = update_list,
+			args = [],
+			result = {modules, {list, {module, string}}}},
+     #ejabberd_commands{name = update, tags = [server],
+			desc = "Update the given module, or use the keyword: all",
+			module = ?MODULE, function = update,
+			args = [{module, string}],
+			result = {res, restuple}},
+
+     #ejabberd_commands{name = register, tags = [accounts],
+			desc = "Register a user",
+			module = ?MODULE, function = register,
+			args = [{user, string}, {host, string}, {password, string}],
+			result = {res, restuple}},
+     #ejabberd_commands{name = unregister, tags = [accounts],
+			desc = "Unregister a user",
+			module = ?MODULE, function = unregister,
+			args = [{user, string}, {host, string}],
+			result = {res, restuple}},
+     #ejabberd_commands{name = registered_users, tags = [accounts],
+			desc = "List all registered users in HOST",
+			module = ?MODULE, function = registered_users,
+			args = [{host, string}],
+			result = {users, {list, {username, string}}}},
+
+     #ejabberd_commands{name = import_file, tags = [mnesia],
+			desc = "Import user data from jabberd14 spool file",
+			module = ?MODULE, function = import_file,
+			args = [{file, string}], result = {res, restuple}},
+     #ejabberd_commands{name = import_dir, tags = [mnesia],
+			desc = "Import users data from jabberd14 spool dir",
+			module = ?MODULE, function = import_dir,
+			args = [{file, string}],
+			result = {res, restuple}},
+
+     #ejabberd_commands{name = import_piefxis, tags = [mnesia],
+			desc = "Import users data from a PIEFXIS file (XEP-0227)",
+			module = ejabberd_piefxis, function = import_file,
+			args = [{file, string}], result = {res, rescode}},
+     #ejabberd_commands{name = export_piefxis, tags = [mnesia],
+			desc = "Export data of all users in the server to PIEFXIS files (XEP-0227)",
+			module = ejabberd_piefxis, function = export_server,
+			args = [{dir, string}], result = {res, rescode}},
+     #ejabberd_commands{name = export_piefxis_host, tags = [mnesia],
+			desc = "Export data of users in a host to PIEFXIS files (XEP-0227)",
+			module = ejabberd_piefxis, function = export_host,
+			args = [{dir, string}, {host, string}], result = {res, rescode}},
+
+     #ejabberd_commands{name = delete_expired_messages, tags = [purge],
+			desc = "Delete expired offline messages from database",
+			module = ?MODULE, function = delete_expired_messages,
+			args = [], result = {res, rescode}},
+     #ejabberd_commands{name = delete_old_messages, tags = [purge],
+			desc = "Delete offline messages older than DAYS",
+			module = ?MODULE, function = delete_old_messages,
+			args = [{days, integer}], result = {res, rescode}},
+	 
+     #ejabberd_commands{name = rename_default_nodeplugin, tags = [mnesia],
+			desc = "Update PubSub table from old ejabberd trunk SVN to 2.1.0",
+			module = mod_pubsub, function = rename_default_nodeplugin,
+			args = [], result = {res, rescode}},
+
+     #ejabberd_commands{name = set_master, tags = [mnesia],
+			desc = "Set master node of the clustered Mnesia tables",
+			longdesc = "If you provide as nodename \"self\", this "
+			"node will be set as its own master.",
+			module = ?MODULE, function = set_master,
+			args = [{nodename, string}], result = {res, restuple}},
+     #ejabberd_commands{name = mnesia_change_nodename, tags = [mnesia],
+			desc = "Change the erlang node name in a backup file",
+			module = ?MODULE, function = mnesia_change_nodename,
+			args = [{oldnodename, string}, {newnodename, string},
+				{oldbackup, string}, {newbackup, string}],
+			result = {res, restuple}},
+     #ejabberd_commands{name = backup, tags = [mnesia],
+			desc = "Store the database to backup file",
+			module = ?MODULE, function = backup_mnesia,
+			args = [{file, string}], result = {res, restuple}},
+     #ejabberd_commands{name = restore, tags = [mnesia],
+			desc = "Restore the database from backup file",
+			module = ?MODULE, function = restore_mnesia,
+			args = [{file, string}], result = {res, restuple}},
+     #ejabberd_commands{name = dump, tags = [mnesia],
+			desc = "Dump the database to text file",
+			module = ?MODULE, function = dump_mnesia,
+			args = [{file, string}], result = {res, restuple}},
+     #ejabberd_commands{name = dump_table, tags = [mnesia],
+			desc = "Dump a table to text file",
+			module = ?MODULE, function = dump_table,
+			args = [{file, string}, {table, string}], result = {res, restuple}},
+     #ejabberd_commands{name = load, tags = [mnesia],
+			desc = "Restore the database from text file",
+			module = ?MODULE, function = load_mnesia,
+			args = [{file, string}], result = {res, restuple}},
+     #ejabberd_commands{name = install_fallback, tags = [mnesia],
+			desc = "Install the database from a fallback file",
+			module = ?MODULE, function = install_fallback_mnesia,
+			args = [{file, string}], result = {res, restuple}}
+    ].
+
+
+%%%
+%%% Server management
+%%%
+
+status() ->
+    {InternalStatus, ProvidedStatus} = init:get_status(),
+    String1 = io_lib:format("The node ~p is ~p. Status: ~p",
+			    [node(), InternalStatus, ProvidedStatus]),
+    {Is_running, String2} =
+	case lists:keysearch(ejabberd, 1, application:which_applications()) of
+	    false ->
+		{ejabberd_not_running, "ejabberd is not running in that node."};
+	    {value, {_, _, Version}} ->
+		{ok, io_lib:format("ejabberd ~s is running in that node", [Version])}
+	end,
+    {Is_running, String1 ++ String2}.
+
+reopen_log() ->
+    ejabberd_hooks:run(reopen_log_hook, []),
+    %% TODO: Use the Reopen log API for logger_h ?
+    ejabberd_logger_h:reopen_log(),
+    case application:get_env(sasl,sasl_error_logger) of
+	{ok, {file, SASLfile}} ->
+	    error_logger:delete_report_handler(sasl_report_file_h),
+	    ejabberd_logger_h:rotate_log(SASLfile),
+	    error_logger:add_report_handler(sasl_report_file_h,
+	        {SASLfile, get_sasl_error_logger_type()});
+	_ -> false
+	end,
+    ok.
+
+%% Function copied from Erlang/OTP lib/sasl/src/sasl.erl which doesn't export it
+get_sasl_error_logger_type () ->
+    case application:get_env (sasl, errlog_type) of
+	{ok, error} -> error;
+	{ok, progress} -> progress;
+	{ok, all} -> all;
+	{ok, Bad} -> exit ({bad_config, {sasl, {errlog_type, Bad}}});
+	_ -> all
+    end.
+
+%%%
+%%% Stop Kindly
+%%%
+
+stop_kindly(DelaySeconds, AnnouncementText) ->
+    Subject = io_lib:format("Server stop in ~p seconds!", [DelaySeconds]),
+    WaitingDesc = io_lib:format("Waiting ~p seconds", [DelaySeconds]),
+    Steps = [
+	     {"Stopping ejabberd port listeners",
+	      ejabberd_listener, stop_listeners, []},
+	     {"Sending announcement to connected users",
+	      mod_announce, send_announcement_to_all,
+	      [?MYNAME, Subject, AnnouncementText]},
+	     {"Sending service message to MUC rooms",
+	      ejabberd_admin, send_service_message_all_mucs,
+	      [Subject, AnnouncementText]},
+	     {WaitingDesc, timer, sleep, [DelaySeconds * 1000]},
+	     {"Stopping ejabberd", application, stop, [ejabberd]},
+	     {"Stopping Mnesia", mnesia, stop, []},
+	     {"Stopping Erlang node", init, stop, []}
+    ],
+    NumberLast = length(Steps),
+    TimestampStart = calendar:datetime_to_gregorian_seconds({date(), time()}),
+    lists:foldl(
+      fun({Desc, Mod, Func, Args}, NumberThis) ->
+	      SecondsDiff =
+		  calendar:datetime_to_gregorian_seconds({date(), time()})
+		  - TimestampStart,
+	      io:format("[~p/~p ~ps] ~s... ",
+			[NumberThis, NumberLast, SecondsDiff, Desc]),
+	      Result = apply(Mod, Func, Args),
+	      io:format("~p~n", [Result]),
+	      NumberThis+1
+      end,
+      1,
+      Steps),
+    ok.
+
+send_service_message_all_mucs(Subject, AnnouncementText) ->
+    Message = io_lib:format("~s~n~s", [Subject, AnnouncementText]),
+    lists:foreach(
+      fun(ServerHost) ->
+	      MUCHost = gen_mod:get_module_opt_host(
+			  ServerHost, mod_muc, "conference.@HOST@"),
+	      mod_muc:broadcast_service_message(MUCHost, Message)
+      end,
+      ?MYHOSTS).
+
+%%%
+%%% ejabberd_update
+%%%
+
+update_list() ->
+    {ok, _Dir, UpdatedBeams, _Script, _LowLevelScript, _Check} =
+	ejabberd_update:update_info(),
+    [atom_to_list(Beam) || Beam <- UpdatedBeams].
+
+update("all") ->
+    [update_module(ModStr) || ModStr <- update_list()];
+update(ModStr) ->
+    update_module(ModStr).
+
+update_module(ModuleNameString) ->
+    ModuleName = list_to_atom(ModuleNameString),
+    case ejabberd_update:update([ModuleName]) of
+          {ok, Res} -> {ok, io_lib:format("Updated: ~p", [Res])};
+          {error, Reason} -> {error, Reason}
+    end.
+
+%%%
+%%% Account management
+%%%
+
+register(User, Host, Password) ->
+    case ejabberd_auth:try_register(User, Host, Password) of
+	{atomic, ok} ->
+	    {ok, io_lib:format("User ~s@~s successfully registered", [User, Host])};
+	{atomic, exists} ->
+	    String = io_lib:format("User ~s@~s already registered at node ~p",
+				   [User, Host, node()]),
+	    {exists, String};
+	{error, Reason} ->
+	    String = io_lib:format("Can't register user ~s@~s at node ~p: ~p",
+				   [User, Host, node(), Reason]),
+	    {cannot_register, String}
+    end.
+
+unregister(User, Host) ->
+    ejabberd_auth:remove_user(User, Host),
+    {ok, ""}.
+
+registered_users(Host) ->
+    Users = ejabberd_auth:get_vh_registered_users(Host),
+    SUsers = lists:sort(Users),
+    lists:map(fun({U, _S}) -> U end, SUsers).
+
+
+%%%
+%%% Migration management
+%%%
+
+import_file(Path) ->
+    case jd2ejd:import_file(Path) of
+        ok ->
+            {ok, ""};
+        {error, Reason} ->
+            String = io_lib:format("Can't import jabberd14 spool file ~p at node ~p: ~p",
+				   [filename:absname(Path), node(), Reason]),
+	    {cannot_import_file, String}
+    end.
+
+import_dir(Path) ->
+    case jd2ejd:import_dir(Path) of
+        ok ->
+            {ok, ""};
+        {error, Reason} ->
+            String = io_lib:format("Can't import jabberd14 spool dir ~p at node ~p: ~p",
+				   [filename:absname(Path), node(), Reason]),
+	    {cannot_import_dir, String}
+    end.
+
+
+%%%
+%%% Purge DB
+%%%
+
+delete_expired_messages() ->
+    {atomic, ok} = mod_offline:remove_expired_messages(),
+    ok.
+
+delete_old_messages(Days) ->
+    {atomic, _} = mod_offline:remove_old_messages(Days),
+    ok.
+
+
+%%%
+%%% Mnesia management
+%%%
+
+set_master("self") ->
+    set_master(node());
+set_master(NodeString) when is_list(NodeString) ->
+    set_master(list_to_atom(NodeString));
+set_master(Node) when is_atom(Node) ->
+    case mnesia:set_master_nodes([Node]) of
+        ok ->
+	    {ok, ""};
+	{error, Reason} ->
+	    String = io_lib:format("Can't set master node ~p at node ~p:~n~p",
+				   [Node, node(), Reason]),
+	    {error, String}
+    end.
+
+backup_mnesia(Path) ->
+    case mnesia:backup(Path) of
+        ok ->
+	    {ok, ""};
+	{error, Reason} ->
+	    String = io_lib:format("Can't store backup in ~p at node ~p: ~p",
+				   [filename:absname(Path), node(), Reason]),
+	    {cannot_backup, String}
+    end.
+
+restore_mnesia(Path) ->
+    case ejabberd_admin:restore(Path) of
+	{atomic, _} ->
+	    {ok, ""};
+	{error, Reason} ->
+	    String = io_lib:format("Can't restore backup from ~p at node ~p: ~p",
+				   [filename:absname(Path), node(), Reason]),
+	    {cannot_restore, String};
+	{aborted,{no_exists,Table}} ->
+	    String = io_lib:format("Can't restore backup from ~p at node ~p: Table ~p does not exist.",
+				   [filename:absname(Path), node(), Table]),
+	    {table_not_exists, String};
+	{aborted,enoent} ->
+	    String = io_lib:format("Can't restore backup from ~p at node ~p: File not found.",
+				   [filename:absname(Path), node()]),
+	    {file_not_found, String}
+    end.
+
+%% Mnesia database restore
+%% This function is called from ejabberd_ctl, ejabberd_web_admin and
+%% mod_configure/adhoc 
+restore(Path) ->
+    mnesia:restore(Path, [{keep_tables,keep_tables()},
+			  {default_op, skip_tables}]).
+
+%% This function return a list of tables that should be kept from a previous
+%% version backup.
+%% Obsolete tables or tables created by module who are no longer used are not
+%% restored and are ignored.
+keep_tables() ->
+    lists:flatten([acl, passwd, config, local_config, disco_publish,
+		   keep_modules_tables()]).
+
+%% Returns the list of modules tables in use, according to the list of actually
+%% loaded modules
+keep_modules_tables() ->		      
+    lists:map(fun(Module) -> module_tables(Module) end,
+	      gen_mod:loaded_modules(?MYNAME)).
+
+%% TODO: This mapping should probably be moved to a callback function in each
+%% module.
+%% Mapping between modules and their tables
+module_tables(mod_announce) -> [motd, motd_users];
+module_tables(mod_irc) -> [irc_custom];
+module_tables(mod_last) -> [last_activity];
+module_tables(mod_muc) -> [muc_room, muc_registered];
+module_tables(mod_offline) -> [offline_msg];
+module_tables(mod_privacy) -> [privacy];
+module_tables(mod_private) -> [private_storage];
+module_tables(mod_pubsub) -> [pubsub_node];
+module_tables(mod_roster) -> [roster];
+module_tables(mod_shared_roster) -> [sr_group, sr_user];
+module_tables(mod_vcard) -> [vcard, vcard_search];
+module_tables(_Other) -> [].
+
+get_local_tables() ->
+    Tabs1 = lists:delete(schema, mnesia:system_info(local_tables)),
+    Tabs = lists:filter(
+	     fun(T) ->
+		     case mnesia:table_info(T, storage_type) of
+			 disc_copies -> true;
+			 disc_only_copies -> true;
+			 _ -> false
+		     end
+	     end, Tabs1),
+    Tabs.
+
+dump_mnesia(Path) ->
+    Tabs = get_local_tables(),
+    dump_tables(Path, Tabs).
+
+dump_table(Path, STable) ->
+    Table = list_to_atom(STable),
+    dump_tables(Path, [Table]).
+
+dump_tables(Path, Tables) ->
+    case dump_to_textfile(Path, Tables) of
+	ok ->
+	    {ok, ""};
+	{error, Reason} ->
+            String = io_lib:format("Can't store dump in ~p at node ~p: ~p",
+				   [filename:absname(Path), node(), Reason]),
+	    {cannot_dump, String}
+    end.
+
+dump_to_textfile(File) ->
+    Tabs = get_local_tables(),
+    dump_to_textfile(File, Tabs).
+
+dump_to_textfile(File, Tabs) ->
+    dump_to_textfile(mnesia:system_info(is_running), Tabs, file:open(File, [write])).
+dump_to_textfile(yes, Tabs, {ok, F}) ->
+    Defs = lists:map(
+	     fun(T) -> {T, [{record_name, mnesia:table_info(T, record_name)},
+			    {attributes, mnesia:table_info(T, attributes)}]}
+	     end,
+	     Tabs),
+    io:format(F, "~p.~n", [{tables, Defs}]),
+    lists:foreach(fun(T) -> dump_tab(F, T) end, Tabs),
+    file:close(F);
+dump_to_textfile(_, _, {ok, F}) ->
+    file:close(F),
+    {error, mnesia_not_running};
+dump_to_textfile(_, _, {error, Reason}) ->
+    {error, Reason}.
+
+dump_tab(F, T) ->
+    W = mnesia:table_info(T, wild_pattern),
+    {atomic,All} = mnesia:transaction(
+		     fun() -> mnesia:match_object(T, W, read) end),
+    lists:foreach(
+      fun(Term) -> io:format(F,"~p.~n", [setelement(1, Term, T)]) end, All).
+
+load_mnesia(Path) ->
+    case mnesia:load_textfile(Path) of
+        {atomic, ok} ->
+            {ok, ""};
+        {error, Reason} ->
+            String = io_lib:format("Can't load dump in ~p at node ~p: ~p",
+				   [filename:absname(Path), node(), Reason]),
+	    {cannot_load, String}
+    end.
+
+install_fallback_mnesia(Path) ->
+    case mnesia:install_fallback(Path) of
+	ok ->
+	    {ok, ""};
+	{error, Reason} ->
+	    String = io_lib:format("Can't install fallback from ~p at node ~p: ~p",
+				   [filename:absname(Path), node(), Reason]),
+	    {cannot_fallback, String}
+    end.
+
+mnesia_change_nodename(FromString, ToString, Source, Target) ->
+    From = list_to_atom(FromString),
+    To = list_to_atom(ToString),
+    Switch =
+	fun
+	    (Node) when Node == From ->
+		io:format("     - Replacing nodename: '~p' with: '~p'~n", [From, To]),
+		To;
+	    (Node) when Node == To ->
+		%% throw({error, already_exists});
+		io:format("     - Node: '~p' will not be modified (it is already '~p')~n", [Node, To]),
+		Node;
+	    (Node) ->
+		io:format("     - Node: '~p' will not be modified (it is not '~p')~n", [Node, From]),
+		Node
+	end,
+    Convert =
+	fun
+	    ({schema, db_nodes, Nodes}, Acc) ->
+		io:format(" +++ db_nodes ~p~n", [Nodes]),
+		{[{schema, db_nodes, lists:map(Switch,Nodes)}], Acc};
+	    ({schema, version, Version}, Acc) ->
+		io:format(" +++ version: ~p~n", [Version]),
+		{[{schema, version, Version}], Acc};
+	    ({schema, cookie, Cookie}, Acc) ->
+		io:format(" +++ cookie: ~p~n", [Cookie]),
+		{[{schema, cookie, Cookie}], Acc};
+	    ({schema, Tab, CreateList}, Acc) ->
+		io:format("~n * Checking table: '~p'~n", [Tab]),
+		Keys = [ram_copies, disc_copies, disc_only_copies],
+		OptSwitch =
+		    fun({Key, Val}) ->
+			    case lists:member(Key, Keys) of
+				true ->
+				    io:format("   + Checking key: '~p'~n", [Key]),
+				    {Key, lists:map(Switch, Val)};
+				false-> {Key, Val}
+			    end
+		    end,
+		Res = {[{schema, Tab, lists:map(OptSwitch, CreateList)}], Acc},
+		Res;
+	    (Other, Acc) ->
+		{[Other], Acc}
+	end,
+    mnesia:traverse_backup(Source, Target, Convert, switched).

src/ejabberd_app.erl

@@ -1,48 +1,99 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_app.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
-%%% Purpose : 
-%%% Created : 31 Jan 2003 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
+%%% Purpose : ejabberd's application callback module
+%%% Created : 31 Jan 2003 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_app).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -behaviour(application).
 
--export([start/2, stop/1, init/0]).
+-export([start_modules/0,start/2, get_log_path/0, prep_stop/1, stop/1, init/0]).
 
 -include("ejabberd.hrl").
 
+
+%%%
+%%% Application API
+%%%
+
 start(normal, _Args) ->
+    ejabberd_loglevel:set(4),
+    write_pid_file(),
     application:start(sasl),
     randoms:start(),
     db_init(),
     sha:start(),
-    catch ssl:start(),
+    stringprep_sup:start_link(),
+    xml:start(),
+    start(),
     translate:start(),
     acl:start(),
     ejabberd_ctl:init(),
+    ejabberd_commands:init(),
+    ejabberd_admin:start(),
     gen_mod:start(),
     ejabberd_config:start(),
+    ejabberd_check:config(),
+    connect_nodes(),
     Sup = ejabberd_sup:start_link(),
+    ejabberd_rdbms:start(),
     ejabberd_auth:start(),
     cyrsasl:start(),
     % Profiling
-    %eprof:start(),
-    %eprof:profile([self()]),
-    %fprof:trace(start, "/tmp/fprof"),
-    start(),
-    load_modules(),
+    %ejabberd_debug:eprof_start(),
+    %ejabberd_debug:fprof_start(),
+    maybe_add_nameservers(),
+    start_modules(),
+    ejabberd_listener:start_listeners(),
+    ?INFO_MSG("ejabberd ~s is started in the node ~p", [?VERSION, node()]),
     Sup;
 start(_, _) ->
     {error, badarg}.
 
-stop(_StartArgs) ->
+%% Prepare the application for termination.
+%% This function is called when an application is about to be stopped,
+%% before shutting down the processes of the application.
+prep_stop(State) ->
+    stop_modules(),
+    ejabberd_admin:stop(),
+    broadcast_c2s_shutdown(),
+    timer:sleep(5000),
+    State.
+
+%% All the processes were killed when this function is called
+stop(_State) ->
+    ?INFO_MSG("ejabberd ~s is stopped in the node ~p", [?VERSION, node()]),
+    delete_pid_file(),
+    %%ejabberd_debug:stop(),
     ok.
 
+
+%%%
+%%% Internal functions
+%%%
+
 start() ->
     spawn_link(?MODULE, init, []).
 
@@ -50,18 +101,7 @@ init() ->
     register(ejabberd, self()),
     %erlang:system_flag(fullsweep_after, 0),
     %error_logger:logfile({open, ?LOG_PATH}),
-    LogPath =
-	case application:get_env(log_path) of
-            {ok, Path} ->
-		Path;
-	    undefined ->
-		case os:getenv("EJABBERD_LOG_PATH") of
-		    false ->
-			?LOG_PATH;
-		    Path ->
-			Path
-		end
-	end,
+    LogPath = get_log_path(),
     error_logger:add_report_handler(ejabberd_logger_h, LogPath),
     erl_ddll:load_driver(ejabberd:get_so_path(), tls_drv),
     case erl_ddll:load_driver(ejabberd:get_so_path(), expat_erl) of
@@ -85,10 +125,11 @@ db_init() ->
 	_ ->
 	    ok
     end,
-    mnesia:start(),
+    application:start(mnesia, permanent),
     mnesia:wait_for_tables(mnesia:system_info(local_tables), infinity).
 
-load_modules() ->
+%% Start all the modules in all the hosts
+start_modules() ->
     lists:foreach(
       fun(Host) ->
 	      case ejabberd_config:get_local_option({modules, Host}) of
@@ -102,3 +143,97 @@ load_modules() ->
 	      end
       end, ?MYHOSTS).
 
+%% Stop all the modules in all the hosts
+stop_modules() ->
+    lists:foreach(
+      fun(Host) ->
+	      case ejabberd_config:get_local_option({modules, Host}) of
+		  undefined ->
+		      ok;
+		  Modules ->
+		      lists:foreach(
+			fun({Module, _Args}) ->
+				gen_mod:stop_module_keep_config(Host, Module)
+			end, Modules)
+	      end
+      end, ?MYHOSTS).
+
+connect_nodes() ->
+    case ejabberd_config:get_local_option(cluster_nodes) of
+	undefined ->
+	    ok;
+	Nodes when is_list(Nodes) ->
+	    lists:foreach(fun(Node) ->
+				  net_kernel:connect_node(Node)
+			  end, Nodes)
+    end.
+
+%% @spec () -> string()
+%% @doc Returns the full path to the ejabberd log file.
+%% It first checks for application configuration parameter 'log_path'.
+%% If not defined it checks the environment variable EJABBERD_LOG_PATH.
+%% And if that one is neither defined, returns the default value:
+%% "ejabberd.log" in current directory.
+get_log_path() ->
+    case application:get_env(log_path) of
+	{ok, Path} ->
+	    Path;
+	undefined ->
+	    case os:getenv("EJABBERD_LOG_PATH") of
+		false ->
+		    ?LOG_PATH;
+		Path ->
+		    Path
+	    end
+    end.
+
+
+%% If ejabberd is running on some Windows machine, get nameservers and add to Erlang
+maybe_add_nameservers() ->
+    case os:type() of
+	{win32, _} -> add_windows_nameservers();
+	_ -> ok
+    end.
+
+add_windows_nameservers() ->
+    IPTs = win32_dns:get_nameservers(),
+    ?INFO_MSG("Adding machine's DNS IPs to Erlang system:~n~p", [IPTs]),
+    lists:foreach(fun(IPT) -> inet_db:add_ns(IPT) end, IPTs).
+
+
+broadcast_c2s_shutdown() ->
+    Children = supervisor:which_children(ejabberd_c2s_sup),
+    lists:foreach(
+      fun({_, C2SPid, _, _}) ->
+	      C2SPid ! system_shutdown
+      end, Children).
+
+%%%
+%%% PID file
+%%%
+
+write_pid_file() ->
+    case ejabberd:get_pid_file() of
+	false ->
+	    ok;
+	PidFilename ->
+	    write_pid_file(os:getpid(), PidFilename)
+    end.
+
+write_pid_file(Pid, PidFilename) ->
+    case file:open(PidFilename, [write]) of
+	{ok, Fd} ->
+	    io:format(Fd, "~s~n", [Pid]),
+	    file:close(Fd);
+	{error, Reason} ->
+	    ?ERROR_MSG("Cannot write PID file ~s~nReason: ~p", [PidFilename, Reason]),
+	    throw({cannot_write_pid_file, PidFilename, Reason})
+    end.
+
+delete_pid_file() ->
+    case ejabberd:get_pid_file() of
+	false ->
+	    ok;
+	PidFilename ->
+	    file:delete(PidFilename)
+    end.

src/ejabberd_auth.erl

@@ -1,40 +1,60 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_auth.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : Authentification
-%%% Created : 23 Nov 2002 by Alexey Shchepin <alexey@sevcom.net>
-%%% Updated : 23 Feb 2006 by Mickael Remond <mremond@process-one.net>
-%%%                          for anonymous login support
-%%% Id      : $Id$
+%%% Created : 23 Nov 2002 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 %% TODO: Use the functions in ejabberd auth to add and remove users.
 
 -module(ejabberd_auth).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 %% External exports
 -export([start/0,
 	 set_password/3,
 	 check_password/3,
 	 check_password/5,
+	 check_password_with_authmodule/3,
+	 check_password_with_authmodule/5,
 	 try_register/3,
 	 dirty_get_registered_users/0,
 	 get_vh_registered_users/1,
+	 get_vh_registered_users/2,
+	 get_vh_registered_users_number/1,
+	 get_vh_registered_users_number/2,
 	 get_password/2,
 	 get_password_s/2,
+	 get_password_with_authmodule/2,
 	 is_user_exists/2,
+	 is_user_exists_in_other_modules/3,
 	 remove_user/2,
 	 remove_user/3,
-	 plain_password_required/1,
-	 ctl_process_get_registered/3
+	 plain_password_required/1
 	]).
 
 -export([auth_modules/1]).
 
 -include("ejabberd.hrl").
--include("ejabberd_ctl.hrl").
 
 %%%----------------------------------------------------------------------
 %%% API
@@ -54,18 +74,60 @@ plain_password_required(Server) ->
 	      M:plain_password_required()
       end, auth_modules(Server)).
 
+%% @doc Check if the user and password can login in server.
+%% @spec (User::string(), Server::string(), Password::string()) ->
+%%     true | false
 check_password(User, Server, Password) ->
-    lists:any(
-      fun(M) ->
-	      M:check_password(User, Server, Password)
-      end, auth_modules(Server)).
+    case check_password_with_authmodule(User, Server, Password) of
+	{true, _AuthModule} -> true;
+	false -> false
+    end.
 
-check_password(User, Server, Password, StreamID, Digest) ->
-    lists:any(
-      fun(M) ->
-	      M:check_password(User, Server, Password, StreamID, Digest)
-      end, auth_modules(Server)).
+%% @doc Check if the user and password can login in server.
+%% @spec (User::string(), Server::string(), Password::string(),
+%%        Digest::string(), DigestGen::function()) ->
+%%     true | false
+check_password(User, Server, Password, Digest, DigestGen) ->
+    case check_password_with_authmodule(User, Server, Password,
+					Digest, DigestGen) of
+	{true, _AuthModule} -> true;
+	false -> false
+    end.
 
+%% @doc Check if the user and password can login in server.
+%% The user can login if at least an authentication method accepts the user
+%% and the password.
+%% The first authentication method that accepts the credentials is returned.
+%% @spec (User::string(), Server::string(), Password::string()) ->
+%%     {true, AuthModule} | false
+%% where
+%%   AuthModule = ejabberd_auth_anonymous | ejabberd_auth_external
+%%                 | ejabberd_auth_internal | ejabberd_auth_ldap
+%%                 | ejabberd_auth_odbc | ejabberd_auth_pam
+check_password_with_authmodule(User, Server, Password) ->
+    check_password_loop(auth_modules(Server), [User, Server, Password]).
+
+check_password_with_authmodule(User, Server, Password, Digest, DigestGen) ->
+    check_password_loop(auth_modules(Server), [User, Server, Password,
+					       Digest, DigestGen]).
+
+check_password_loop([], _Args) ->
+    false;
+check_password_loop([AuthModule | AuthModules], Args) ->
+    case apply(AuthModule, check_password, Args) of
+	true ->
+	    {true, AuthModule};
+	false ->
+	    check_password_loop(AuthModules, Args)
+    end.
+
+
+%% @spec (User::string(), Server::string(), Password::string()) ->
+%%       ok | {error, ErrorType}
+%% where ErrorType = empty_password | not_allowed | invalid_jid
+set_password(_User, _Server, "") ->
+    %% We do not allow empty password
+    {error, empty_password};
 set_password(User, Server, Password) ->
     lists:foldl(
       fun(M, {error, _}) ->
@@ -74,6 +136,10 @@ set_password(User, Server, Password) ->
 	      Res
       end, {error, not_allowed}, auth_modules(Server)).
 
+%% @spec (User, Server, Password) -> {atomic, ok} | {atomic, exists} | {error, not_allowed}
+try_register(_User, _Server, "") ->
+    %% We do not allow empty password
+    {error, not_allowed};    
 try_register(User, Server, Password) ->
     case is_user_exists(User,Server) of
 	true ->
@@ -81,12 +147,19 @@ try_register(User, Server, Password) ->
 	false ->
 	    case lists:member(jlib:nameprep(Server), ?MYHOSTS) of
 		true ->
-		    lists:foldl(
+		    Res = lists:foldl(
 		      fun(_M, {atomic, ok} = Res) ->
 			      Res;
 			 (M, _) ->
 			      M:try_register(User, Server, Password)
-		      end, {error, not_allowed}, auth_modules(Server));
+		      end, {error, not_allowed}, auth_modules(Server)),
+		    case Res of
+			{atomic, ok} ->
+			    ejabberd_hooks:run(register_user, Server,
+					       [User, Server]),
+			    {atomic, ok};
+			_ -> Res
+		    end;
 		false ->
 		    {error, not_allowed}
 	    end
@@ -97,7 +170,7 @@ dirty_get_registered_users() ->
     lists:flatmap(
       fun(M) ->
 	      M:dirty_get_registered_users()
-      end, auth_modules(?MYNAME)).
+      end, auth_modules()).
 
 %% Registered users list do not include anonymous users logged
 get_vh_registered_users(Server) ->
@@ -106,6 +179,46 @@ get_vh_registered_users(Server) ->
 	      M:get_vh_registered_users(Server)
       end, auth_modules(Server)).
 
+get_vh_registered_users(Server, Opts) ->
+    lists:flatmap(
+      fun(M) ->
+		case erlang:function_exported(
+		       M, get_vh_registered_users, 2) of
+		    true ->
+			M:get_vh_registered_users(Server, Opts);
+		    false ->
+			M:get_vh_registered_users(Server)
+		end
+      end, auth_modules(Server)).
+
+get_vh_registered_users_number(Server) ->
+    lists:sum(
+      lists:map(
+	fun(M) ->
+		case erlang:function_exported(
+		       M, get_vh_registered_users_number, 1) of
+		    true ->
+			M:get_vh_registered_users_number(Server);
+		    false ->
+			length(M:get_vh_registered_users(Server))
+		end
+	end, auth_modules(Server))).
+
+get_vh_registered_users_number(Server, Opts) ->
+    lists:sum(
+      lists:map(
+	fun(M) ->
+		case erlang:function_exported(
+		       M, get_vh_registered_users_number, 2) of
+		    true ->
+			M:get_vh_registered_users_number(Server, Opts);
+		    false ->
+			length(M:get_vh_registered_users(Server))
+		end
+	end, auth_modules(Server))).
+
+%% @doc Get the password of the user.
+%% @spec (User::string(), Server::string()) -> Password::string()
 get_password(User, Server) ->
     lists:foldl(
       fun(M, false) ->
@@ -122,44 +235,108 @@ get_password_s(User, Server) ->
 	    Password
     end.
 
+%% @doc Get the password of the user and the auth module.
+%% @spec (User::string(), Server::string()) ->
+%%     {Password::string(), AuthModule::atom()} | {false, none}
+get_password_with_authmodule(User, Server) ->
+    lists:foldl(
+      fun(M, {false, _}) ->
+	      {M:get_password(User, Server), M};
+	 (_M, {Password, AuthModule}) ->
+	      {Password, AuthModule}
+      end, {false, none}, auth_modules(Server)).
+
 %% Returns true if the user exists in the DB or if an anonymous user is logged
 %% under the given name
 is_user_exists(User, Server) ->
     lists:any(
       fun(M) ->
-	      M:is_user_exists(User, Server)
+	      case M:is_user_exists(User, Server) of
+		  {error, Error} ->
+		      ?ERROR_MSG("The authentication module ~p returned an "
+				 "error~nwhen checking user ~p in server ~p~n"
+				 "Error message: ~p",
+				 [M, User, Server, Error]),
+		      false;
+		  Else ->
+		      Else
+	      end
       end, auth_modules(Server)).
 
+%% Check if the user exists in all authentications module except the module
+%% passed as parameter
+%% @spec (Module::atom(), User, Server) -> true | false | maybe
+is_user_exists_in_other_modules(Module, User, Server) ->
+    is_user_exists_in_other_modules_loop(
+      auth_modules(Server)--[Module],
+      User, Server).
+is_user_exists_in_other_modules_loop([], _User, _Server) ->
+    false;
+is_user_exists_in_other_modules_loop([AuthModule|AuthModules], User, Server) ->
+    case AuthModule:is_user_exists(User, Server) of
+	true ->
+	    true;
+	false ->
+	    is_user_exists_in_other_modules_loop(AuthModules, User, Server);
+	{error, Error} ->
+	    ?DEBUG("The authentication module ~p returned an error~nwhen "
+		   "checking user ~p in server ~p~nError message: ~p",
+		   [AuthModule, User, Server, Error]),
+	    maybe
+    end.
+
+
+%% @spec (User, Server) -> ok | error | {error, not_allowed}
+%% @doc Remove user.
+%% Note: it may return ok even if there was some problem removing the user.
 remove_user(User, Server) ->
-    lists:foreach(
+    R = lists:foreach(
       fun(M) ->
 	      M:remove_user(User, Server)
-      end, auth_modules(Server)).
+      end, auth_modules(Server)),
+    case R of
+		ok -> ejabberd_hooks:run(remove_user, jlib:nameprep(Server), [User, Server]);
+		_ -> none
+    end,
+    R.
 
+%% @spec (User, Server, Password) -> ok | not_exists | not_allowed | bad_request | error
+%% @doc Try to remove user if the provided password is correct.
+%% The removal is attempted in each auth method provided:
+%% when one returns 'ok' the loop stops;
+%% if no method returns 'ok' then it returns the error message indicated by the last method attempted.
 remove_user(User, Server, Password) ->
-    lists:foreach(
-      fun(M) ->
+    R = lists:foldl(
+      fun(_M, ok = Res) ->
+	      Res;
+	 (M, _) ->
 	      M:remove_user(User, Server, Password)
-      end, auth_modules(Server)).
+      end, error, auth_modules(Server)),
+    case R of
+		ok -> ejabberd_hooks:run(remove_user, jlib:nameprep(Server), [User, Server]);
+		_ -> none
+    end,
+    R.
 
 
-ctl_process_get_registered(_Val, Host, ["registered-users"]) ->
-    Users = ejabberd_auth:get_vh_registered_users(Host),
-    NewLine = io_lib:format("~n", []),
-    SUsers = lists:sort(Users),
-    FUsers = lists:map(fun({U, _S}) -> [U, NewLine] end, SUsers),
-    io:format("~s", [FUsers]),
-    {stop, ?STATUS_SUCCESS};
-ctl_process_get_registered(Val, _Host, _Args) ->
-    Val.
-
 %%%----------------------------------------------------------------------
 %%% Internal functions
 %%%----------------------------------------------------------------------
+%% Return the lists of all the auth modules actually used in the
+%% configuration
+auth_modules() ->
+    lists:usort(
+      lists:flatmap(
+	fun(Server) ->
+		auth_modules(Server)
+	end, ?MYHOSTS)).
+
+%% Return the list of authenticated modules for a given host
 auth_modules(Server) ->
     LServer = jlib:nameprep(Server),
     Method = ejabberd_config:get_local_option({auth_method, LServer}),
     Methods = if
+		  Method == undefined -> [];
 		  is_list(Method) -> Method;
 		  is_atom(Method) -> [Method]
 	      end,

src/ejabberd_auth_anonymous.erl

@@ -4,15 +4,28 @@
 %%% Purpose : Anonymous feature support in ejabberd
 %%% Created : 17 Feb 2006 by Mickael Remond <mremond@process-one.net>
 %%%
-%%% Anonymous support is based on the work of Magnus Henoch
-%%% <henoch@dtek.chalmers.se> and heavily extended by Process-one.
 %%%
-%%% Id      : $Id$
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_auth_anonymous).
 -author('mickael.remond@process-one.net').
--vsn('$Revision$ ').
 
 -export([start/1,
 	 allow_anonymous/1,
@@ -20,8 +33,8 @@
 	 is_login_anonymous_enabled/1,
 	 anonymous_user_exist/2,
 	 allow_multiple_connections/1,
-	 register_connection/2,
-	 unregister_connection/2
+	 register_connection/3,
+	 unregister_connection/3
 	]).
 
 
@@ -66,7 +79,7 @@ allow_anonymous(Host) ->
 %% anonymous protocol can be: sasl_anon|login_anon|both
 is_sasl_anonymous_enabled(Host) ->
     case allow_anonymous(Host) of
-	false -> false;	    
+	false -> false;
 	true ->
 	    case anonymous_protocol(Host) of
 		sasl_anon -> true;
@@ -84,7 +97,7 @@ is_login_anonymous_enabled(Host) ->
 	true  ->
 	    case anonymous_protocol(Host) of
 		login_anon -> true;
-		both       -> true;		
+		both       -> true;
 		_Other     -> false
 	    end
     end.
@@ -102,10 +115,8 @@ anonymous_protocol(Host) ->
 %% Return true if multiple connections have been allowed in the config file
 %% defaults to false
 allow_multiple_connections(Host) ->
-    case ejabberd_config:get_local_option({allow_multiple_connections, Host}) of
-	true -> true;
-	_Other -> false
-    end.
+    ejabberd_config:get_local_option(
+      {allow_multiple_connections, Host}) =:= true.
 
 %% Check if user exist in the anonymus database
 anonymous_user_exist(User, Server) ->
@@ -128,16 +139,30 @@ remove_connection(SID, LUser, LServer) ->
     mnesia:transaction(F).
 
 %% Register connection
-register_connection(SID, #jid{luser = LUser, lserver = LServer}) ->
-    US = {LUser, LServer},
-    mnesia:sync_dirty(
-      fun() -> mnesia:write(#anonymous{us = US, sid=SID})
-      end).
+register_connection(SID, #jid{luser = LUser, lserver = LServer}, Info) ->
+    AuthModule = xml:get_attr_s(auth_module, Info),
+    case AuthModule == ?MODULE of
+	true ->
+	    US = {LUser, LServer},
+	    mnesia:sync_dirty(
+	      fun() -> mnesia:write(#anonymous{us = US, sid=SID})
+	      end);
+	false ->
+	    ok
+    end.
 
 %% Remove an anonymous user from the anonymous users table
-unregister_connection(SID, #jid{luser = LUser, lserver = LServer}) ->
+unregister_connection(SID, #jid{luser = LUser, lserver = LServer}, _) ->
+    purge_hook(anonymous_user_exist(LUser, LServer),
+	       LUser, LServer),
     remove_connection(SID, LUser, LServer).
 
+%% Launch the hook to purge user data only for anonymous users
+purge_hook(false, _LUser, _LServer) ->
+    ok;
+purge_hook(true, LUser, LServer) ->
+    ejabberd_hooks:run(anonymous_purge_hook, LServer, [LUser, LServer]).
+
 %% ---------------------------------
 %% Specific anonymous auth functions
 %% ---------------------------------
@@ -146,11 +171,15 @@ unregister_connection(SID, #jid{luser = LUser, lserver = LServer}) ->
 %% before allowing access
 check_password(User, Server, Password) ->
     check_password(User, Server, Password, undefined, undefined).
-check_password(User, Server, _Password, _StreamID, _Digest) ->
+check_password(User, Server, _Password, _Digest, _DigestGen) ->
     %% We refuse login for registered accounts (They cannot logged but
     %% they however are "reserved")
-    case ejabberd_auth:is_user_exists(User, Server) of
+    case ejabberd_auth:is_user_exists_in_other_modules(?MODULE,
+						       User, Server) of
+	%% If user exists in other module, reject anonnymous authentication
 	true  -> false;
+	%% If we are not sure whether the user exists in other module, reject anon auth
+	maybe  -> false;
 	false -> login(User, Server)
     end.
 
@@ -195,7 +224,7 @@ get_password(User, Server) ->
     get_password(User, Server, "").
 
 get_password(User, Server, DefaultValue) ->
-    case anonymous_user_exist(User, Server) of
+    case anonymous_user_exist(User, Server) or login(User, Server) of
 	%% We return the default value if the user is anonymous
 	true ->
 	    DefaultValue;
@@ -217,4 +246,3 @@ remove_user(_User, _Server, _Password) ->
 
 plain_password_required() ->
     false.
-

src/ejabberd_auth_external.erl

@@ -1,14 +1,31 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_auth_external.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : Authentification via LDAP external script
-%%% Created : 12 Dec 2004 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created : 12 Dec 2004 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_auth_external).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 %% External exports
 -export([start/1,
@@ -18,6 +35,9 @@
 	 try_register/3,
 	 dirty_get_registered_users/0,
 	 get_vh_registered_users/1,
+	 get_vh_registered_users/2,
+	 get_vh_registered_users_number/1,
+	 get_vh_registered_users_number/2,
 	 get_password/2,
 	 get_password_s/2,
 	 is_user_exists/2,
@@ -26,47 +46,259 @@
 	 plain_password_required/0
 	]).
 
+-include("ejabberd.hrl").
+
 %%%----------------------------------------------------------------------
 %%% API
 %%%----------------------------------------------------------------------
 start(Host) ->
     extauth:start(
       Host, ejabberd_config:get_local_option({extauth_program, Host})),
-    ok.
+    case check_cache_last_options(Host) of
+	cache ->
+	    ok = ejabberd_auth_internal:start(Host);
+	no_cache ->
+	    ok
+    end.
+
+check_cache_last_options(Server) ->
+    %% if extauth_cache is enabled, then a mod_last module must also be enabled
+    case get_cache_option(Server) of
+	false -> no_cache;
+	{true, _CacheTime} ->
+	    case get_mod_last_enabled(Server) of
+		no_mod_last ->
+		    ?ERROR_MSG("In host ~p extauth is used, extauth_cache is enabled but "
+			       "mod_last is not enabled.", [Server]),
+		    no_cache;
+		_ -> cache
+	    end
+    end.
 
 plain_password_required() ->
     true.
 
 check_password(User, Server, Password) ->
-    extauth:check_password(User, Server, Password).
+    case get_cache_option(Server) of
+	false -> check_password_extauth(User, Server, Password);
+	{true, CacheTime} -> check_password_cache(User, Server, Password, CacheTime)
+    end.
 
-check_password(User, Server, Password, _StreamID, _Digest) ->
+check_password(User, Server, Password, _Digest, _DigestGen) ->
     check_password(User, Server, Password).
 
 set_password(User, Server, Password) ->
-    extauth:set_password(User, Server, Password).
+    case extauth:set_password(User, Server, Password) of
+	true -> set_password_internal(User, Server, Password),
+		ok;
+	_ -> {error, unknown_problem}
+    end.
 
-try_register(_User, _Server, _Password) ->
-    {error, not_allowed}.
+try_register(User, Server, Password) ->
+    case get_cache_option(Server) of
+	false -> try_register_extauth(User, Server, Password);
+	{true, _CacheTime} -> try_register_external_cache(User, Server, Password)
+    end.
 
 dirty_get_registered_users() ->
-    [].
+    ejabberd_auth_internal:dirty_get_registered_users().
 
-get_vh_registered_users(_Server) ->
-    [].
+get_vh_registered_users(Server) ->
+    ejabberd_auth_internal:get_vh_registered_users(Server).
 
-get_password(_User, _Server) ->
-    false.
+get_vh_registered_users(Server, Data)  ->
+    ejabberd_auth_internal:get_vh_registered_users(Server, Data).
 
-get_password_s(_User, _Server) ->
-    "".
+get_vh_registered_users_number(Server) ->
+    ejabberd_auth_internal:get_vh_registered_users_number(Server).
 
+get_vh_registered_users_number(Server, Data) ->
+    ejabberd_auth_internal:get_vh_registered_users_number(Server, Data).
+
+%% The password can only be returned if cache is enabled, cached info exists and is fresh enough.
+get_password(User, Server) ->
+    case get_cache_option(Server) of
+	false -> false;
+	{true, CacheTime} -> get_password_cache(User, Server, CacheTime)
+    end.
+
+get_password_s(User, Server) ->
+    case get_password(User, Server) of
+	false -> [];
+	Other -> Other
+    end.
+
+%% @spec (User, Server) -> true | false | {error, Error}
 is_user_exists(User, Server) ->
-    extauth:is_user_exists(User, Server).
+    try extauth:is_user_exists(User, Server) of
+	Res -> Res
+    catch
+	_:Error -> {error, Error}
+    end.
 
-remove_user(_User, _Server) ->
-    {error, not_allowed}.
+remove_user(User, Server) ->
+    case extauth:remove_user(User, Server) of
+	false -> false;
+	true ->
+	    case get_cache_option(Server) of
+		false -> false;
+		{true, _CacheTime} ->
+		    ejabberd_auth_internal:remove_user(User, Server)
+	    end
+    end.
 
-remove_user(_User, _Server, _Password) ->
-    not_allowed.
+remove_user(User, Server, Password) ->
+    case extauth:remove_user(User, Server, Password) of
+	false -> false;
+	true ->
+	    case get_cache_option(Server) of
+		false -> false;
+		{true, _CacheTime} ->
+		    ejabberd_auth_internal:remove_user(User, Server, Password)
+	    end
+    end.
 
+%%%
+%%% Extauth cache management
+%%%
+
+%% @spec (Host::string()) -> false | {true, CacheTime::integer()}
+get_cache_option(Host) ->
+    case ejabberd_config:get_local_option({extauth_cache, Host}) of
+	CacheTime when is_integer(CacheTime) -> {true, CacheTime};
+	_ -> false
+    end.
+
+%% @spec (User, Server, Password) -> true | false
+check_password_extauth(User, Server, Password) ->
+    extauth:check_password(User, Server, Password) andalso Password /= "".
+
+%% @spec (User, Server, Password) -> true | false
+try_register_extauth(User, Server, Password) ->
+    extauth:try_register(User, Server, Password).
+
+check_password_cache(User, Server, Password, CacheTime) ->
+    case get_last_access(User, Server) of
+	online ->
+	    check_password_internal(User, Server, Password);
+	never ->
+	    check_password_external_cache(User, Server, Password);
+	mod_last_required ->
+	    ?ERROR_MSG("extauth is used, extauth_cache is enabled but mod_last is not enabled in that host", []),
+	    check_password_external_cache(User, Server, Password);
+	TimeStamp ->
+	    %% If last access exists, compare last access with cache refresh time
+	    case is_fresh_enough(TimeStamp, CacheTime) of
+		%% If no need to refresh, check password against Mnesia
+		true ->
+		    case check_password_internal(User, Server, Password) of
+			%% If password valid in Mnesia, accept it
+			true ->
+			    true;
+			%% Else (password nonvalid in Mnesia), check in extauth and cache result
+			false ->
+			    check_password_external_cache(User, Server, Password)
+		    end;
+		%% Else (need to refresh), check in extauth and cache result
+		false ->
+		    check_password_external_cache(User, Server, Password)
+	    end
+    end.
+
+get_password_internal(User, Server) ->
+    ejabberd_auth_internal:get_password(User, Server).
+
+%% @spec (User, Server, CacheTime) -> false | Password::string()
+get_password_cache(User, Server, CacheTime) ->
+    case get_last_access(User, Server) of
+	online ->
+	    get_password_internal(User, Server);
+	never ->
+	    false;
+	mod_last_required ->
+	    ?ERROR_MSG("extauth is used, extauth_cache is enabled but mod_last is not enabled in that host", []),
+	    false;
+	TimeStamp ->
+	    case is_fresh_enough(TimeStamp, CacheTime) of
+		true ->
+		    get_password_internal(User, Server);
+		false ->
+		    false
+	    end
+    end.
+
+
+%% Check the password using extauth; if success then cache it
+check_password_external_cache(User, Server, Password) ->
+    case check_password_extauth(User, Server, Password) of
+	true ->
+	    set_password_internal(User, Server, Password), true;
+	false ->
+	    false
+    end.
+
+%% Try to register using extauth; if success then cache it
+try_register_external_cache(User, Server, Password) ->
+    case try_register_extauth(User, Server, Password) of
+	{atomic, ok} = R ->
+	    set_password_internal(User, Server, Password),
+	    R;
+	_ -> {error, not_allowed}
+    end.
+
+%% @spec (User, Server, Password) -> true | false
+check_password_internal(User, Server, Password) ->
+    ejabberd_auth_internal:check_password(User, Server, Password).
+
+%% @spec (User, Server, Password) -> ok | {error, invalid_jid}
+set_password_internal(User, Server, Password) ->
+    ejabberd_auth_internal:set_password(User, Server, Password).
+
+%% @spec (TimeLast, CacheTime) -> true | false
+%%       TimeLast = online | never | integer()
+%%       CacheTime = integer() | false
+is_fresh_enough(online, _CacheTime) ->
+    true;
+is_fresh_enough(never, _CacheTime) ->
+    false;
+is_fresh_enough(TimeStampLast, CacheTime) ->
+    {MegaSecs, Secs, _MicroSecs} = now(),
+    Now = MegaSecs * 1000000 + Secs,
+    (TimeStampLast + CacheTime > Now).
+
+%% @spec (User, Server) -> online | never | mod_last_required | TimeStamp::integer()
+%% Code copied from mod_configure.erl
+%% Code copied from web/ejabberd_web_admin.erl
+%% TODO: Update time format to XEP-0202: Entity Time
+get_last_access(User, Server) ->
+    case ejabberd_sm:get_user_resources(User, Server) of
+	[] ->
+	    _US = {User, Server},
+	    case get_last_info(User, Server) of
+		mod_last_required ->
+		    mod_last_required;
+		not_found ->
+		    never;
+		{ok, Timestamp, _Status} ->
+		    Timestamp
+	    end;
+	_ ->
+	    online
+    end.
+%% @spec (User, Server) -> {ok, Timestamp, Status} | not_found | mod_last_required
+get_last_info(User, Server) ->
+    case get_mod_last_enabled(Server) of
+	mod_last -> mod_last:get_last_info(User, Server);
+	mod_last_odbc -> mod_last_odbc:get_last_info(User, Server);
+	no_mod_last -> mod_last_required
+    end.
+
+%% @spec (Server) -> mod_last | mod_last_odbc | no_mod_last
+get_mod_last_enabled(Server) ->
+    ML = lists:member(mod_last, gen_mod:loaded_modules(Server)),
+    MLO = lists:member(mod_last_odbc, gen_mod:loaded_modules(Server)),
+    case {ML, MLO} of
+	{true, _} -> mod_last;
+	{false, true} -> mod_last_odbc;
+	{false, false} -> no_mod_last
+    end.

src/ejabberd_auth_internal.erl

@@ -1,14 +1,31 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_auth_internal.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : Authentification via mnesia
-%%% Created : 12 Dec 2004 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created : 12 Dec 2004 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_auth_internal).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 %% External exports
 -export([start/1,
@@ -18,6 +35,9 @@
 	 try_register/3,
 	 dirty_get_registered_users/0,
 	 get_vh_registered_users/1,
+	 get_vh_registered_users/2,
+	 get_vh_registered_users_number/1,
+	 get_vh_registered_users_number/2,
 	 get_password/2,
 	 get_password_s/2,
 	 is_user_exists/2,
@@ -29,6 +49,7 @@
 -include("ejabberd.hrl").
 
 -record(passwd, {us, password}).
+-record(reg_users_counter, {vhost, count}).
 
 %%%----------------------------------------------------------------------
 %%% API
@@ -36,13 +57,23 @@
 start(Host) ->
     mnesia:create_table(passwd, [{disc_copies, [node()]},
 				 {attributes, record_info(fields, passwd)}]),
+    mnesia:create_table(reg_users_counter,
+			[{ram_copies, [node()]},
+			 {attributes, record_info(fields, reg_users_counter)}]),
     update_table(),
-    ejabberd_ctl:register_commands(
-      Host,
-      [{"registered-users", "list all registered users"}],
-      ejabberd_auth, ctl_process_get_registered),
+    update_reg_users_counter_table(Host),
     ok.
 
+update_reg_users_counter_table(Server) ->
+    Set = get_vh_registered_users(Server),
+    Size = length(Set),
+    LServer = jlib:nameprep(Server),
+    F = fun() ->
+	    mnesia:write(#reg_users_counter{vhost = LServer,
+					    count = Size})
+	end,
+    mnesia:sync_dirty(F).
+
 plain_password_required() ->
     false.
 
@@ -52,12 +83,12 @@ check_password(User, Server, Password) ->
     US = {LUser, LServer},
     case catch mnesia:dirty_read({passwd, US}) of
 	[#passwd{password = Password}] ->
-	    true;
+	    Password /= "";
 	_ ->
 	    false
     end.
 
-check_password(User, Server, Password, StreamID, Digest) ->
+check_password(User, Server, Password, Digest, DigestGen) ->
     LUser = jlib:nodeprep(User),
     LServer = jlib:nameprep(Server),
     US = {LUser, LServer},
@@ -65,7 +96,7 @@ check_password(User, Server, Password, StreamID, Digest) ->
 	[#passwd{password = Passwd}] ->
 	    DigRes = if
 			 Digest /= "" ->
-			     Digest == sha:sha(StreamID ++ Passwd);
+			     Digest == DigestGen(Passwd);
 			 true ->
 			     false
 		     end,
@@ -78,6 +109,8 @@ check_password(User, Server, Password, StreamID, Digest) ->
 	    false
     end.
 
+%% @spec (User::string(), Server::string(), Password::string()) ->
+%%       ok | {error, invalid_jid}
 set_password(User, Server, Password) ->
     LUser = jlib:nodeprep(User),
     LServer = jlib:nameprep(Server),
@@ -90,10 +123,11 @@ set_password(User, Server, Password) ->
 			mnesia:write(#passwd{us = US,
 					     password = Password})
 		end,
-	    mnesia:transaction(F)
+	    {atomic, ok} = mnesia:transaction(F),
+	    ok
     end.
 
-
+%% @spec (User, Server, Password) -> {atomic, ok} | {atomic, exists} | {error, invalid_jid} | {aborted, Reason}
 try_register(User, Server, Password) ->
     LUser = jlib:nodeprep(User),
     LServer = jlib:nameprep(Server),
@@ -107,6 +141,9 @@ try_register(User, Server, Password) ->
 			    [] ->
 				mnesia:write(#passwd{us = US,
 						     password = Password}),
+				mnesia:dirty_update_counter(
+						    reg_users_counter,
+						    LServer, 1),
 				ok;
 			    [_E] ->
 				exists
@@ -115,6 +152,7 @@ try_register(User, Server, Password) ->
 	    mnesia:transaction(F)
     end.
 
+%% Get all registered users in Mnesia
 dirty_get_registered_users() ->
     mnesia:dirty_all_keys(passwd).
 
@@ -122,10 +160,76 @@ get_vh_registered_users(Server) ->
     LServer = jlib:nameprep(Server),
     mnesia:dirty_select(
       passwd,
-      [{#passwd{us = '$1', _ = '_'},
-	[{'==', {element, 2, '$1'}, LServer}],
+      [{#passwd{us = '$1', _ = '_'}, 
+	[{'==', {element, 2, '$1'}, LServer}], 
 	['$1']}]).
 
+get_vh_registered_users(Server, [{from, Start}, {to, End}]) 
+	when is_integer(Start) and is_integer(End) ->
+    get_vh_registered_users(Server, [{limit, End-Start+1}, {offset, Start}]);
+
+get_vh_registered_users(Server, [{limit, Limit}, {offset, Offset}]) 
+	when is_integer(Limit) and is_integer(Offset) ->
+    case get_vh_registered_users(Server) of
+    [] ->
+	[];
+    Users ->
+	Set = lists:keysort(1, Users),
+	L = length(Set),
+	Start = if Offset < 1 -> 1;
+	           Offset > L -> L;
+	           true -> Offset
+	        end,
+	lists:sublist(Set, Start, Limit)
+    end;
+
+get_vh_registered_users(Server, [{prefix, Prefix}]) 
+	when is_list(Prefix) ->
+    Set = [{U,S} || {U, S} <- get_vh_registered_users(Server), lists:prefix(Prefix, U)],
+    lists:keysort(1, Set);
+
+get_vh_registered_users(Server, [{prefix, Prefix}, {from, Start}, {to, End}]) 
+	when is_list(Prefix) and is_integer(Start) and is_integer(End) ->
+    get_vh_registered_users(Server, [{prefix, Prefix}, {limit, End-Start+1}, {offset, Start}]);
+
+get_vh_registered_users(Server, [{prefix, Prefix}, {limit, Limit}, {offset, Offset}]) 
+	when is_list(Prefix) and is_integer(Limit) and is_integer(Offset) ->
+    case [{U,S} || {U, S} <- get_vh_registered_users(Server), lists:prefix(Prefix, U)] of
+    [] ->
+	[];
+    Users ->
+	Set = lists:keysort(1, Users),
+	L = length(Set),
+	Start = if Offset < 1 -> 1;
+	           Offset > L -> L;
+	           true -> Offset
+	        end,
+	lists:sublist(Set, Start, Limit)
+    end;
+
+get_vh_registered_users(Server, _) ->
+    get_vh_registered_users(Server).
+
+get_vh_registered_users_number(Server) ->
+    LServer = jlib:nameprep(Server),
+    Query = mnesia:dirty_select(
+		reg_users_counter,
+		[{#reg_users_counter{vhost = LServer, count = '$1'},
+		  [],
+		  ['$1']}]),
+    case Query of
+	[Count] ->
+	    Count;
+	_ -> 0
+    end.
+
+get_vh_registered_users_number(Server, [{prefix, Prefix}]) when is_list(Prefix) ->
+    Set = [{U, S} || {U, S} <- get_vh_registered_users(Server), lists:prefix(Prefix, U)],
+    length(Set);
+    
+get_vh_registered_users_number(Server, _) ->
+    get_vh_registered_users_number(Server).
+
 get_password(User, Server) ->
     LUser = jlib:nodeprep(User),
     LServer = jlib:nameprep(Server),
@@ -148,6 +252,7 @@ get_password_s(User, Server) ->
 	    []
     end.
 
+%% @spec (User, Server) -> true | false | {error, Error}
 is_user_exists(User, Server) ->
     LUser = jlib:nodeprep(User),
     LServer = jlib:nameprep(Server),
@@ -157,20 +262,27 @@ is_user_exists(User, Server) ->
 	    false;
 	[_] ->
 	    true;
-	_ ->
-	    false
+	Other ->
+	    {error, Other}
     end.
 
+%% @spec (User, Server) -> ok
+%% @doc Remove user.
+%% Note: it returns ok even if there was some problem removing the user.
 remove_user(User, Server) ->
     LUser = jlib:nodeprep(User),
     LServer = jlib:nameprep(Server),
     US = {LUser, LServer},
     F = fun() ->
-		mnesia:delete({passwd, US})
+		mnesia:delete({passwd, US}),
+		mnesia:dirty_update_counter(reg_users_counter,
+					    LServer, -1)
         end,
     mnesia:transaction(F),
-    ejabberd_hooks:run(remove_user, LServer, [User, Server]).
+	ok.
 
+%% @spec (User, Server, Password) -> ok | not_exists | not_allowed | bad_request
+%% @doc Remove user if the provided password is correct.
 remove_user(User, Server, Password) ->
     LUser = jlib:nodeprep(User),
     LServer = jlib:nameprep(Server),
@@ -179,6 +291,8 @@ remove_user(User, Server, Password) ->
 		case mnesia:read({passwd, US}) of
 		    [#passwd{password = Password}] ->
 			mnesia:delete({passwd, US}),
+			mnesia:dirty_update_counter(reg_users_counter,
+						    LServer, -1),
 			ok;
 		    [_] ->
 			not_allowed;
@@ -188,7 +302,6 @@ remove_user(User, Server, Password) ->
         end,
     case mnesia:transaction(F) of
 	{atomic, ok} ->
-	    ejabberd_hooks:run(remove_user, LServer, [User, Server]),
 	    ok;
 	{atomic, Res} ->
 	    Res;

src/ejabberd_auth_ldap.erl

@@ -1,23 +1,54 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_auth_ldap.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : Authentification via LDAP
-%%% Created : 12 Dec 2004 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created : 12 Dec 2004 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_auth_ldap).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
+
+-behaviour(gen_server).
+
+%% gen_server callbacks
+-export([init/1,
+	 handle_info/2,
+	 handle_call/3,
+	 handle_cast/2,
+	 terminate/2,
+	 code_change/3
+	]).
 
 %% External exports
 -export([start/1,
+	 stop/1,
+	 start_link/1,
 	 set_password/3,
 	 check_password/3,
 	 check_password/5,
 	 try_register/3,
 	 dirty_get_registered_users/0,
 	 get_vh_registered_users/1,
+	 get_vh_registered_users_number/1,
 	 get_password/2,
 	 get_password_s/2,
 	 is_user_exists/2,
@@ -29,80 +60,127 @@
 -include("ejabberd.hrl").
 -include("eldap/eldap.hrl").
 
+-record(state, {host,
+		eldap_id,
+		bind_eldap_id,
+		servers,
+		backups,
+		port,
+		tls_options,
+		dn,
+		password,
+		base,
+		uids,
+		ufilter,
+		sfilter,
+		lfilter, %% Local filter (performed by ejabberd, not LDAP)
+		dn_filter,
+		dn_filter_attrs
+	       }).
+
+%% Unused callbacks.
+handle_cast(_Request, State) ->
+    {noreply, State}.
+code_change(_OldVsn, State, _Extra) ->
+    {ok, State}.
+handle_info(_Info, State) ->
+    {noreply, State}.
+%% -----
+
+
+-define(LDAP_SEARCH_TIMEOUT, 5). % Timeout for LDAP search queries in seconds
+
+
 %%%----------------------------------------------------------------------
 %%% API
 %%%----------------------------------------------------------------------
+
 start(Host) ->
-    LDAPServers = ejabberd_config:get_local_option({ldap_servers, Host}),
-    RootDN = ejabberd_config:get_local_option({ldap_rootdn, Host}),
-    Password = ejabberd_config:get_local_option({ldap_password, Host}),
-    eldap:start_link(get_eldap_id(Host, ejabberd),
-		     LDAPServers, 389, RootDN, Password),
-    eldap:start_link(get_eldap_id(Host, ejabberd_bind),
-		     LDAPServers, 389, RootDN, Password),
-    ejabberd_ctl:register_commands(
-      Host,
-      [{"registered-users", "list all registered users"}],
-      ejabberd_auth, ctl_process_get_registered),
+    Proc = gen_mod:get_module_proc(Host, ?MODULE),
+    ChildSpec = {
+      Proc, {?MODULE, start_link, [Host]},
+      transient, 1000, worker, [?MODULE]
+     },
+    supervisor:start_child(ejabberd_sup, ChildSpec).
+
+stop(Host) ->
+    Proc = gen_mod:get_module_proc(Host, ?MODULE),
+    gen_server:call(Proc, stop),
+    supervisor:terminate_child(ejabberd_sup, Proc),
+    supervisor:delete_child(ejabberd_sup, Proc).
+
+start_link(Host) ->
+    Proc = gen_mod:get_module_proc(Host, ?MODULE),
+    gen_server:start_link({local, Proc}, ?MODULE, Host, []).
+
+terminate(_Reason, _State) ->
     ok.
 
+init(Host) ->
+    State = parse_options(Host),
+    eldap_pool:start_link(State#state.eldap_id,
+			  State#state.servers,
+			  State#state.backups,
+			  State#state.port,
+			  State#state.dn,
+			  State#state.password,
+			  State#state.tls_options),
+    eldap_pool:start_link(State#state.bind_eldap_id,
+			  State#state.servers,
+			  State#state.backups,
+			  State#state.port,
+			  State#state.dn,
+			  State#state.password,
+			  State#state.tls_options),
+    {ok, State}.
+
 plain_password_required() ->
     true.
 
 check_password(User, Server, Password) ->
-    case find_user_dn(User, Server) of
-	false ->
-	    false;
-	DN ->
-	    LServer = jlib:nameprep(Server),
-	    case eldap:bind(get_eldap_id(LServer, ejabberd_bind),
-			    DN, Password) of
-		ok ->
-		    true;
-		_ ->
-		    false
-	    end
+    %% In LDAP spec: empty password means anonymous authentication.
+    %% As ejabberd is providing other anonymous authentication mechanisms
+    %% we simply prevent the use of LDAP anonymous authentication.
+    if Password == "" ->
+        false;
+    true ->
+        case catch check_password_ldap(User, Server, Password) of
+	        {'EXIT', _} -> false;
+	        Result -> Result
+        end
     end.
 
-check_password(User, Server, Password, _StreamID, _Digest) ->
+check_password(User, Server, Password, _Digest, _DigestGen) ->
     check_password(User, Server, Password).
 
-set_password(_User, _Server, _Password) ->
-    {error, not_allowed}.
+set_password(User, Server, Password) ->
+    {ok, State} = eldap_utils:get_state(Server, ?MODULE),
+    case find_user_dn(User, State) of
+	false ->
+	    {error, user_not_found};
+	DN ->
+	    eldap_pool:modify_passwd(State#state.eldap_id, DN, Password)
+    end.
 
+%% @spec (User, Server, Password) -> {error, not_allowed}
 try_register(_User, _Server, _Password) ->
     {error, not_allowed}.
 
 dirty_get_registered_users() ->
-    get_vh_registered_users(?MYNAME).
+    Servers = ejabberd_config:get_vh_by_auth_method(ldap),
+    lists:flatmap(
+      fun(Server) ->
+	      get_vh_registered_users(Server)
+      end, Servers).
 
 get_vh_registered_users(Server) ->
-    LServer = jlib:nameprep(Server),
-    Attr = ejabberd_config:get_local_option({ldap_uidattr, LServer}),
-    Filter = eldap:present(Attr),
-    Base = ejabberd_config:get_local_option({ldap_base, LServer}),
-    case eldap:search(get_eldap_id(LServer, ejabberd),
-		      [{base, Base},
-		       {filter, Filter},
-		       {attributes, [Attr]}]) of
-	#eldap_search_result{entries = Es} ->
-	    lists:flatmap(
-	      fun(E) ->
-		      case lists:keysearch(Attr, 1, E#eldap_entry.attributes) of
-			  {value, {_, [U]}} ->
-			      case jlib:nodeprep(U) of
-				  error ->
-				      [];
-				  LU ->
-				      [{LU, LServer}]
-			      end;
-			  _ ->
-			      []
-		      end
-	      end, Es);
-	_ ->
-	    []
-    end.
+    case catch get_vh_registered_users_ldap(Server) of
+	{'EXIT', _} -> [];
+	Result -> Result
+	end.
+
+get_vh_registered_users_number(Server) ->
+    length(get_vh_registered_users(Server)).
 
 get_password(_User, _Server) ->
     false.
@@ -110,12 +188,13 @@ get_password(_User, _Server) ->
 get_password_s(_User, _Server) ->
     "".
 
+%% @spec (User, Server) -> true | false | {error, Error}
 is_user_exists(User, Server) ->
-    case find_user_dn(User, Server) of
-	false ->
-	    false;
-	_DN ->
-	    true
+    case catch is_user_exists_ldap(User, Server) of
+	{'EXIT', Error} ->
+	    {error, Error};
+	Result ->
+	    Result
     end.
 
 remove_user(_User, _Server) ->
@@ -124,25 +203,230 @@ remove_user(_User, _Server) ->
 remove_user(_User, _Server, _Password) ->
     not_allowed.
 
-
 %%%----------------------------------------------------------------------
 %%% Internal functions
 %%%----------------------------------------------------------------------
+check_password_ldap(User, Server, Password) ->
+	{ok, State} = eldap_utils:get_state(Server, ?MODULE),
+	case find_user_dn(User, State) of
+	false ->
+	    false;
+	DN ->
+	    case eldap_pool:bind(State#state.bind_eldap_id, DN, Password) of
+		ok -> true;
+		_ -> false
+	    end
+	end.
 
-find_user_dn(User, Server) ->
-    LServer = jlib:nameprep(Server),
-    Attr = ejabberd_config:get_local_option({ldap_uidattr, LServer}),
-    Filter = eldap:equalityMatch(Attr, User),
-    Base = ejabberd_config:get_local_option({ldap_base, LServer}),
-    case eldap:search(get_eldap_id(LServer, ejabberd),
-		      [{base, Base},
-		       {filter, Filter},
-		       {attributes, []}]) of
-	#eldap_search_result{entries = [E | _]} ->
-	    E#eldap_entry.object_name;
+get_vh_registered_users_ldap(Server) ->
+    {ok, State} = eldap_utils:get_state(Server, ?MODULE),
+    UIDs = State#state.uids,
+    Eldap_ID = State#state.eldap_id,
+    Server = State#state.host,
+    ResAttrs = result_attrs(State),
+    case eldap_filter:parse(State#state.sfilter) of
+		{ok, EldapFilter} ->
+		    case eldap_pool:search(Eldap_ID, [{base, State#state.base},
+						 {filter, EldapFilter},
+						 {timeout, ?LDAP_SEARCH_TIMEOUT},
+						 {attributes, ResAttrs}]) of
+			#eldap_search_result{entries = Entries} ->
+			    lists:flatmap(
+			      fun(#eldap_entry{attributes = Attrs,
+					       object_name = DN}) ->
+				      case is_valid_dn(DN, Attrs, State) of
+					  false -> [];
+					  _ ->
+					      case eldap_utils:find_ldap_attrs(UIDs, Attrs) of
+						  "" -> [];
+						  {User, UIDFormat} ->
+						      case eldap_utils:get_user_part(User, UIDFormat) of
+							  {ok, U} ->
+							      case jlib:nodeprep(U) of
+								  error -> [];
+								  LU -> [{LU, jlib:nameprep(Server)}]
+							      end;
+							  _ -> []
+						      end
+					      end
+				      end
+			      end, Entries);
+			_ ->
+			    []
+		    end;
+		_ ->
+		    []
+	end.
+
+is_user_exists_ldap(User, Server) ->
+    {ok, State} = eldap_utils:get_state(Server, ?MODULE),
+    case find_user_dn(User, State) of
+		false -> false;
+		_DN -> true
+	end.
+
+handle_call(get_state, _From, State) ->
+	{reply, {ok, State}, State};
+
+handle_call(stop, _From, State) ->
+    {stop, normal, ok, State};
+
+handle_call(_Request, _From, State) ->
+    {reply, bad_request, State}.
+
+find_user_dn(User, State) ->
+    ResAttrs = result_attrs(State),
+    case eldap_filter:parse(State#state.ufilter, [{"%u", User}]) of
+	{ok, Filter} ->
+	    case eldap_pool:search(State#state.eldap_id,
+				   [{base, State#state.base},
+				    {filter, Filter},
+				    {attributes, ResAttrs}]) of
+		#eldap_search_result{entries = [#eldap_entry{attributes = Attrs,
+							     object_name = DN} | _]} ->
+		    dn_filter(DN, Attrs, State);
+		_ ->
+		    false
+	    end;
 	_ ->
 	    false
     end.
 
-get_eldap_id(Host, Name) ->
-    atom_to_list(gen_mod:get_module_proc(Host, Name)).
+%% apply the dn filter and the local filter:
+dn_filter(DN, Attrs, State) ->
+    %% Check if user is denied access by attribute value (local check)
+    case check_local_filter(Attrs, State) of
+        false -> false;
+        true -> is_valid_dn(DN, Attrs, State)
+    end.
+
+%% Check that the DN is valid, based on the dn filter
+is_valid_dn(DN, _, #state{dn_filter = undefined}) ->
+    DN;
+
+is_valid_dn(DN, Attrs, State) ->
+    DNAttrs = State#state.dn_filter_attrs,
+    UIDs = State#state.uids,
+    Values = [{"%s", eldap_utils:get_ldap_attr(Attr, Attrs), 1} || Attr <- DNAttrs],
+    SubstValues = case eldap_utils:find_ldap_attrs(UIDs, Attrs) of
+		      "" -> Values;
+		      {S, UAF} ->
+			  case eldap_utils:get_user_part(S, UAF) of
+			      {ok, U} -> [{"%u", U} | Values];
+			      _ -> Values
+			  end
+		  end ++ [{"%d", State#state.host}, {"%D", DN}],
+    case eldap_filter:parse(State#state.dn_filter, SubstValues) of
+	{ok, EldapFilter} ->
+	    case eldap_pool:search(State#state.eldap_id, [
+						     {base, State#state.base},
+						     {filter, EldapFilter},
+						     {attributes, ["dn"]}]) of
+		#eldap_search_result{entries = [_|_]} ->
+		    DN;
+		_ ->
+		    false
+	    end;
+	_ ->
+	    false
+    end.
+
+%% The local filter is used to check an attribute in ejabberd
+%% and not in LDAP to limit the load on the LDAP directory.
+%% A local rule can be either:
+%%    {equal, {"accountStatus",["active"]}}
+%%    {notequal, {"accountStatus",["disabled"]}}
+%% {ldap_local_filter, {notequal, {"accountStatus",["disabled"]}}}
+check_local_filter(_Attrs, #state{lfilter = undefined}) ->
+    true;
+check_local_filter(Attrs, #state{lfilter = LocalFilter}) ->
+    {Operation, FilterMatch} = LocalFilter,
+    local_filter(Operation, Attrs, FilterMatch).
+    
+local_filter(equal, Attrs, FilterMatch) ->
+    {Attr, Value} = FilterMatch,
+    case lists:keysearch(Attr, 1, Attrs) of
+        false -> false;
+        {value,{Attr,Value}} -> true;
+        _ -> false
+    end;
+local_filter(notequal, Attrs, FilterMatch) ->
+    not local_filter(equal, Attrs, FilterMatch).
+
+result_attrs(#state{uids = UIDs, dn_filter_attrs = DNFilterAttrs}) ->
+    lists:foldl(
+      fun({UID}, Acc) ->
+	      [UID | Acc];
+	 ({UID, _}, Acc) ->
+	      [UID | Acc]
+      end, DNFilterAttrs, UIDs).
+
+%%%----------------------------------------------------------------------
+%%% Auxiliary functions
+%%%----------------------------------------------------------------------
+parse_options(Host) ->
+    Eldap_ID = atom_to_list(gen_mod:get_module_proc(Host, ?MODULE)),
+    Bind_Eldap_ID = atom_to_list(gen_mod:get_module_proc(Host, bind_ejabberd_auth_ldap)),
+    LDAPServers = ejabberd_config:get_local_option({ldap_servers, Host}),
+    LDAPBackups = case ejabberd_config:get_local_option({ldap_backups, Host}) of
+		   undefined -> [];
+		   Backups -> Backups
+		   end,
+    LDAPEncrypt = ejabberd_config:get_local_option({ldap_encrypt, Host}),
+    LDAPTLSVerify = ejabberd_config:get_local_option({ldap_tls_verify, Host}),
+    LDAPPort = case ejabberd_config:get_local_option({ldap_port, Host}) of
+		   undefined -> case LDAPEncrypt of
+				    tls -> ?LDAPS_PORT;
+				    starttls -> ?LDAP_PORT;
+				    _ -> ?LDAP_PORT
+				end;
+		   P -> P
+	       end,
+    RootDN = case ejabberd_config:get_local_option({ldap_rootdn, Host}) of
+		 undefined -> "";
+		 RDN -> RDN
+	     end,
+    Password = case ejabberd_config:get_local_option({ldap_password, Host}) of
+		   undefined -> "";
+		   Pass -> Pass
+	       end,
+    UIDs = case ejabberd_config:get_local_option({ldap_uids, Host}) of
+	       undefined -> [{"uid", "%u"}];
+	       UI -> eldap_utils:uids_domain_subst(Host, UI)
+	   end,
+    SubFilter = lists:flatten(eldap_utils:generate_subfilter(UIDs)),
+    UserFilter = case ejabberd_config:get_local_option({ldap_filter, Host}) of
+		     undefined -> SubFilter;
+		     "" -> SubFilter;
+		     F -> "(&" ++ SubFilter ++ F ++ ")"
+		 end,
+    SearchFilter = eldap_filter:do_sub(UserFilter, [{"%u", "*"}]),
+    LDAPBase = ejabberd_config:get_local_option({ldap_base, Host}),
+    {DNFilter, DNFilterAttrs} =
+	case ejabberd_config:get_local_option({ldap_dn_filter, Host}) of
+	    undefined ->
+		{undefined, []};
+	    {DNF, undefined} ->
+		{DNF, []};
+	    {DNF, DNFA} ->
+		{DNF, DNFA}
+	end,
+	LocalFilter = ejabberd_config:get_local_option({ldap_local_filter, Host}),
+    #state{host = Host,
+	   eldap_id = Eldap_ID,
+	   bind_eldap_id = Bind_Eldap_ID,
+	   servers = LDAPServers,
+	   backups = LDAPBackups,
+	   port = LDAPPort,
+	   tls_options = [{encrypt, LDAPEncrypt},
+			  {tls_verify, LDAPTLSVerify}],
+	   dn = RootDN,
+	   password = Password,
+	   base = LDAPBase,
+	   uids = UIDs,
+	   ufilter = UserFilter,
+	   sfilter = SearchFilter,
+	   lfilter = LocalFilter,
+	   dn_filter = DNFilter,
+	   dn_filter_attrs = DNFilterAttrs
+	  }.

src/ejabberd_auth_odbc.erl

@@ -1,14 +1,31 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_auth_odbc.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : Authentification via ODBC
-%%% Created : 12 Dec 2004 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created : 12 Dec 2004 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_auth_odbc).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 %% External exports
 -export([start/1,
@@ -18,6 +35,9 @@
 	 try_register/3,
 	 dirty_get_registered_users/0,
 	 get_vh_registered_users/1,
+	 get_vh_registered_users/2,
+	 get_vh_registered_users_number/1,
+	 get_vh_registered_users_number/2,
 	 get_password/2,
 	 get_password_s/2,
 	 is_user_exists/2,
@@ -28,60 +48,52 @@
 
 -include("ejabberd.hrl").
 
--record(passwd, {user, password}).
-
 %%%----------------------------------------------------------------------
 %%% API
 %%%----------------------------------------------------------------------
-start(Host) ->
-    ChildSpec =
-	{gen_mod:get_module_proc(Host, ejabberd_odbc_sup),
-	 {ejabberd_odbc_sup, start_link, [Host]},
-	 temporary,
-	 infinity,
-	 supervisor,
-	 [ejabberd_odbc_sup]},
-    supervisor:start_child(ejabberd_sup, ChildSpec),
-    ejabberd_ctl:register_commands(
-      Host,
-      [{"registered-users", "list all registered users"}],
-      ejabberd_auth, ctl_process_get_registered),
+start(_Host) ->
     ok.
 
 plain_password_required() ->
     false.
 
+%% @spec (User, Server, Password) -> true | false | {error, Error}
 check_password(User, Server, Password) ->
     case jlib:nodeprep(User) of
 	error ->
 	    false;
 	LUser ->
 	    Username = ejabberd_odbc:escape(LUser),
-	    case catch ejabberd_odbc:sql_query(
-			 jlib:nameprep(Server),
-			 ["select password from users "
-			  "where username='", Username, "';"]) of
+	    LServer = jlib:nameprep(Server),
+	    try odbc_queries:get_password(LServer, Username) of
 		{selected, ["password"], [{Password}]} ->
-		    true;
-		_ ->
-		    false
+		    Password /= ""; %% Password is correct, and not empty
+		{selected, ["password"], [{_Password2}]} ->
+		    false; %% Password is not correct
+		{selected, ["password"], []} ->
+		    false; %% Account does not exist
+		{error, _Error} ->
+		    false %% Typical error is that table doesn't exist
+	    catch
+		_:_ ->
+		    false %% Typical error is database not accessible
 	    end
     end.
 
-check_password(User, Server, Password, StreamID, Digest) ->
+%% @spec (User, Server, Password, Digest, DigestGen) -> true | false | {error, Error}
+check_password(User, Server, Password, Digest, DigestGen) ->
     case jlib:nodeprep(User) of
 	error ->
 	    false;
 	LUser ->
 	    Username = ejabberd_odbc:escape(LUser),
-	    case catch ejabberd_odbc:sql_query(
-			 jlib:nameprep(Server),
-			 ["select password from users "
-			  "where username='", Username, "';"]) of
+	    LServer = jlib:nameprep(Server),
+	    try odbc_queries:get_password(LServer, Username) of
+		%% Account exists, check if password is valid
 		{selected, ["password"], [{Passwd}]} ->
 		    DigRes = if
 				 Digest /= "" ->
-				     Digest == sha:sha(StreamID ++ Passwd);
+				     Digest == DigestGen(Passwd);
 				 true ->
 				     false
 			     end,
@@ -90,11 +102,18 @@ check_password(User, Server, Password, StreamID, Digest) ->
 		       true ->
 			    (Passwd == Password) and (Password /= "")
 		    end;
-		_ ->
-		    false
+		{selected, ["password"], []} ->
+		    false; %% Account does not exist
+		{error, _Error} ->
+		    false %% Typical error is that table doesn't exist
+	    catch
+		_:_ ->
+		    false %% Typical error is database not accessible
 	    end
     end.
 
+%% @spec (User::string(), Server::string(), Password::string()) ->
+%%       ok | {error, invalid_jid}
 set_password(User, Server, Password) ->
     case jlib:nodeprep(User) of
 	error ->
@@ -103,14 +122,14 @@ set_password(User, Server, Password) ->
 	    Username = ejabberd_odbc:escape(LUser),
 	    Pass = ejabberd_odbc:escape(Password),
 	    LServer = jlib:nameprep(Server),
-	    catch ejabberd_odbc:sql_transaction(
-		    LServer,
-		    [["delete from users where username='", Username ,"';"],
-		     ["insert into users(username, password) "
-		      "values ('", Username, "', '", Pass, "');"]])
+	    case catch odbc_queries:set_password_t(LServer, Username, Pass) of
+	        {atomic, ok} -> ok;
+	        Other -> {error, Other}
+	    end
     end.
 
 
+%% @spec (User, Server, Password) -> {atomic, ok} | {atomic, exists} | {error, invalid_jid}
 try_register(User, Server, Password) ->
     case jlib:nodeprep(User) of
 	error ->
@@ -118,10 +137,8 @@ try_register(User, Server, Password) ->
 	LUser ->
 	    Username = ejabberd_odbc:escape(LUser),
 	    Pass = ejabberd_odbc:escape(Password),
-	    case catch ejabberd_odbc:sql_query(
-			 jlib:nameprep(Server),
-			 ["insert into users(username, password) "
-			  "values ('", Username, "', '", Pass, "');"]) of
+	    LServer = jlib:nameprep(Server),
+	    case catch odbc_queries:add_user(LServer, Username, Pass) of
 		{updated, 1} ->
 		    {atomic, ok};
 		_ ->
@@ -130,29 +147,56 @@ try_register(User, Server, Password) ->
     end.
 
 dirty_get_registered_users() ->
-    get_vh_registered_users(?MYNAME).
+    Servers = ejabberd_config:get_vh_by_auth_method(odbc),
+    lists:flatmap(
+      fun(Server) ->
+	      get_vh_registered_users(Server)
+      end, Servers).
 
 get_vh_registered_users(Server) ->
     LServer = jlib:nameprep(Server),
-    case catch ejabberd_odbc:sql_query(
-		 LServer,
-		 "select username from users") of
+    case catch odbc_queries:list_users(LServer) of
 	{selected, ["username"], Res} ->
 	    [{U, LServer} || {U} <- Res];
 	_ ->
 	    []
     end.
 
+get_vh_registered_users(Server, Opts) ->
+    LServer = jlib:nameprep(Server),
+    case catch odbc_queries:list_users(LServer, Opts) of
+	{selected, ["username"], Res} ->
+	    [{U, LServer} || {U} <- Res];
+	_ ->
+	    []
+    end.
+
+get_vh_registered_users_number(Server) ->
+    LServer = jlib:nameprep(Server),
+    case catch odbc_queries:users_number(LServer) of
+	{selected, [_], [{Res}]} ->
+	    list_to_integer(Res);
+	_ ->
+	    0
+    end.
+
+get_vh_registered_users_number(Server, Opts) ->
+    LServer = jlib:nameprep(Server),
+    case catch odbc_queries:users_number(LServer, Opts) of
+	{selected, [_], [{Res}]} ->
+	    list_to_integer(Res);
+	_Other ->
+	    0
+    end.
+
 get_password(User, Server) ->
     case jlib:nodeprep(User) of
 	error ->
 	    false;
 	LUser ->
 	    Username = ejabberd_odbc:escape(LUser),
-	    case catch ejabberd_odbc:sql_query(
-			 jlib:nameprep(Server),
-			 ["select password from users "
-			  "where username='", Username, "';"]) of
+	    LServer = jlib:nameprep(Server),
+	    case catch odbc_queries:get_password(LServer, Username) of
 		{selected, ["password"], [{Password}]} ->
 		    Password;
 		_ ->
@@ -166,10 +210,8 @@ get_password_s(User, Server) ->
 	    "";
 	LUser ->
 	    Username = ejabberd_odbc:escape(LUser),
-	    case catch ejabberd_odbc:sql_query(
-			 jlib:nameprep(Server),
-			 ["select password from users "
-			  "where username='", Username, "';"]) of
+	    LServer = jlib:nameprep(Server),
+	    case catch odbc_queries:get_password(LServer, Username) of
 		{selected, ["password"], [{Password}]} ->
 		    Password;
 		_ ->
@@ -177,36 +219,43 @@ get_password_s(User, Server) ->
 	    end
     end.
 
+%% @spec (User, Server) -> true | false | {error, Error}
 is_user_exists(User, Server) ->
     case jlib:nodeprep(User) of
 	error ->
 	    false;
 	LUser ->
 	    Username = ejabberd_odbc:escape(LUser),
-	    case catch ejabberd_odbc:sql_query(
-			 jlib:nameprep(Server),
-			 ["select password from users "
-			  "where username='", Username, "';"]) of
+	    LServer = jlib:nameprep(Server),
+	    try odbc_queries:get_password(LServer, Username) of
 		{selected, ["password"], [{_Password}]} ->
-		    true;
-		_ ->
-		    false
+		    true; %% Account exists
+		{selected, ["password"], []} ->
+		    false; %% Account does not exist
+		{error, Error} ->
+		    {error, Error} %% Typical error is that table doesn't exist
+	    catch
+		_:B ->
+		    {error, B} %% Typical error is database not accessible
 	    end
     end.
 
+%% @spec (User, Server) -> ok | error
+%% @doc Remove user.
+%% Note: it may return ok even if there was some problem removing the user.
 remove_user(User, Server) ->
     case jlib:nodeprep(User) of
 	error ->
 	    error;
 	LUser ->
 	    Username = ejabberd_odbc:escape(LUser),
-	    catch ejabberd_odbc:sql_query(
-		    jlib:nameprep(Server),
-		    ["delete from users where username='", Username ,"';"]),
-	    ejabberd_hooks:run(remove_user, jlib:nameprep(Server),
-			       [User, Server])
+	    LServer = jlib:nameprep(Server),
+	    catch odbc_queries:del_user(LServer, Username),
+		ok
     end.
 
+%% @spec (User, Server, Password) -> ok | error | not_exists | not_allowed
+%% @doc Remove user if the provided password is correct.
 remove_user(User, Server, Password) ->
     case jlib:nodeprep(User) of
 	error ->
@@ -216,16 +265,10 @@ remove_user(User, Server, Password) ->
 	    Pass = ejabberd_odbc:escape(Password),
 	    LServer = jlib:nameprep(Server),
 	    F = fun() ->
-			Result = ejabberd_odbc:sql_query_t(
-				   ["select password from users where username='",
-				    Username, "';"]),
-			ejabberd_odbc:sql_query_t(["delete from users "
-						   "where username='", Username,
-						   "' and password='", Pass, "';"]),
+			Result = odbc_queries:del_user_return_password(
+				   LServer, Username, Pass),
 			case Result of
 			    {selected, ["password"], [{Password}]} ->
-				ejabberd_hooks:run(remove_user, jlib:nameprep(Server),
-						   [User, Server]),
 				ok;
 			    {selected, ["password"], []} ->
 				not_exists;
@@ -233,6 +276,6 @@ remove_user(User, Server, Password) ->
 				not_allowed
 			end
 		end,
-	    {atomic, Result } = ejabberd_odbc:transaction(LServer, F),
+	    {atomic, Result} = odbc_queries:sql_transaction(LServer, F),
 	    Result
     end.

src/ejabberd_auth_pam.erl

@@ -0,0 +1,121 @@
+%%%-------------------------------------------------------------------
+%%% File    : ejabberd_auth_pam.erl
+%%% Author  : Evgeniy Khramtsov <xram@jabber.ru>
+%%% Purpose : PAM authentication
+%%% Created : 5 Jul 2007 by Evgeniy Khramtsov <xram@jabber.ru>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%-------------------------------------------------------------------
+-module(ejabberd_auth_pam).
+-author('xram@jabber.ru').
+
+%% External exports
+-export([start/1,
+	 set_password/3,
+	 check_password/3,
+	 check_password/5,
+	 try_register/3,
+	 dirty_get_registered_users/0,
+	 get_vh_registered_users/1,
+	 get_password/2,
+	 get_password_s/2,
+	 is_user_exists/2,
+	 remove_user/2,
+	 remove_user/3,
+	 plain_password_required/0
+	]).
+
+%%====================================================================
+%% API
+%%====================================================================
+start(_Host) ->
+    case epam:start() of
+	{ok, _} -> ok;
+	{error,{already_started, _}} -> ok;
+	Err -> Err
+    end.
+
+set_password(_User, _Server, _Password) ->
+    {error, not_allowed}.
+
+check_password(User, Server, Password, _Digest, _DigestGen) ->
+    check_password(User, Server, Password).
+
+check_password(User, Host, Password) ->
+    Service = get_pam_service(Host),
+    UserInfo = case get_pam_userinfotype(Host) of
+	username -> User;
+	jid -> User++"@"++Host
+    end,
+    case catch epam:authenticate(Service, UserInfo, Password) of
+	true -> true;
+	_    -> false
+    end.
+
+try_register(_User, _Server, _Password) ->
+    {error, not_allowed}.
+
+dirty_get_registered_users() ->
+    [].
+
+get_vh_registered_users(_Host) ->
+    [].
+
+get_password(_User, _Server) ->
+    false.
+
+get_password_s(_User, _Server) ->
+    "".
+
+%% @spec (User, Server) -> true | false | {error, Error}
+%% TODO: Improve this function to return an error instead of 'false' when connection to PAM failed
+is_user_exists(User, Host) ->
+    Service = get_pam_service(Host),
+    UserInfo = case get_pam_userinfotype(Host) of
+	username -> User;
+	jid -> User++"@"++Host
+    end,
+    case catch epam:acct_mgmt(Service, UserInfo) of
+	true -> true;
+	_    -> false
+    end.
+
+remove_user(_User, _Server) ->
+    {error, not_allowed}.
+
+remove_user(_User, _Server, _Password) ->
+    not_allowed.
+
+plain_password_required() ->
+    true.
+
+%%====================================================================
+%% Internal functions
+%%====================================================================
+get_pam_service(Host) ->
+    case ejabberd_config:get_local_option({pam_service, Host}) of
+	undefined -> "ejabberd";
+	Service   -> Service
+    end.
+get_pam_userinfotype(Host) ->
+    case ejabberd_config:get_local_option({pam_userinfotype, Host}) of
+	undefined -> username;
+	Type -> Type
+    end.

src/ejabberd_c2s_config.erl

@@ -0,0 +1,60 @@
+%%%----------------------------------------------------------------------
+%%% File    : ejabberd_c2s_config.erl
+%%% Author  : Mickael Remond <mremond@process-one.net>
+%%% Purpose : Functions for c2s interactions from other client
+%%%           connector modules
+%%% Created :  2 Nov 2007 by Mickael Remond <mremond@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%----------------------------------------------------------------------
+
+-module(ejabberd_c2s_config).
+-author('mremond@process-one.net').
+
+-export([get_c2s_limits/0]).
+
+%% Get first c2s configuration limitations to apply it to other c2s
+%% connectors.
+get_c2s_limits() ->
+    case ejabberd_config:get_local_option(listen) of
+	undefined ->
+	    [];
+	C2SFirstListen ->
+	    case lists:keysearch(ejabberd_c2s, 2, C2SFirstListen) of
+		false ->
+		    [];
+		{value, {_Port, ejabberd_c2s, Opts}} ->
+		    select_opts_values(Opts)
+	    end
+    end.
+%% Only get access, shaper and max_stanza_size values
+select_opts_values(Opts) ->
+    select_opts_values(Opts, []).
+select_opts_values([], SelectedValues) ->
+    SelectedValues;
+select_opts_values([{access,Value}|Opts], SelectedValues) ->
+    select_opts_values(Opts, [{access, Value}|SelectedValues]);
+select_opts_values([{shaper,Value}|Opts], SelectedValues) ->
+    select_opts_values(Opts, [{shaper, Value}|SelectedValues]);
+select_opts_values([{max_stanza_size,Value}|Opts], SelectedValues) ->
+    select_opts_values(Opts, [{max_stanza_size, Value}|SelectedValues]);
+select_opts_values([_Opt|Opts], SelectedValues) ->
+    select_opts_values(Opts, SelectedValues).
+

src/ejabberd_captcha.erl

@@ -0,0 +1,416 @@
+%%%-------------------------------------------------------------------
+%%% File    : ejabberd_captcha.erl
+%%% Author  : Evgeniy Khramtsov <xramtsov@gmail.com>
+%%% Purpose : CAPTCHA processing.
+%%% Created : 26 Apr 2008 by Evgeniy Khramtsov <xramtsov@gmail.com>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%-------------------------------------------------------------------
+
+-module(ejabberd_captcha).
+
+-behaviour(gen_server).
+
+%% API
+-export([start_link/0]).
+
+%% gen_server callbacks
+-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
+	 terminate/2, code_change/3]).
+
+-export([create_captcha/6, build_captcha_html/2, check_captcha/2,
+	 process_reply/1, process/2, is_feature_available/0]).
+
+-include("jlib.hrl").
+-include("ejabberd.hrl").
+-include("web/ejabberd_http.hrl").
+
+-define(VFIELD(Type, Var, Value),
+	{xmlelement, "field", [{"type", Type}, {"var", Var}],
+	 [{xmlelement, "value", [], [Value]}]}).
+
+-define(CAPTCHA_TEXT(Lang), translate:translate(Lang, "Enter the text you see")).
+-define(CAPTCHA_LIFETIME, 120000). % two minutes
+
+-record(state, {}).
+-record(captcha, {id, pid, key, tref, args}).
+
+-define(T(S),
+	case catch mnesia:transaction(fun() -> S end) of
+	    {atomic, Res} ->
+		Res;
+	    {_, Reason} ->
+		?ERROR_MSG("mnesia transaction failed: ~p", [Reason]),
+		{error, Reason}
+	end).
+
+%%====================================================================
+%% API
+%%====================================================================
+%%--------------------------------------------------------------------
+%% Function: start_link() -> {ok,Pid} | ignore | {error,Error}
+%% Description: Starts the server
+%%--------------------------------------------------------------------
+start_link() ->
+    gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
+
+create_captcha(Id, SID, From, To, Lang, Args)
+  when is_list(Id), is_list(Lang), is_list(SID),
+       is_record(From, jid), is_record(To, jid) ->
+    case create_image() of
+	{ok, Type, Key, Image} ->
+	    B64Image = jlib:encode_base64(binary_to_list(Image)),
+	    JID = jlib:jid_to_string(From),
+	    CID = "sha1+" ++ sha:sha(Image) ++ "@bob.xmpp.org",
+	    Data = {xmlelement, "data",
+		    [{"xmlns", ?NS_BOB}, {"cid", CID},
+		     {"max-age", "0"}, {"type", Type}],
+		    [{xmlcdata, B64Image}]},
+	    Captcha =
+		{xmlelement, "captcha", [{"xmlns", ?NS_CAPTCHA}],
+		 [{xmlelement, "x", [{"xmlns", ?NS_XDATA}, {"type", "form"}],
+		   [?VFIELD("hidden", "FORM_TYPE", {xmlcdata, ?NS_CAPTCHA}),
+		    ?VFIELD("hidden", "from", {xmlcdata, jlib:jid_to_string(To)}),
+		    ?VFIELD("hidden", "challenge", {xmlcdata, Id}),
+		    ?VFIELD("hidden", "sid", {xmlcdata, SID}),
+		    {xmlelement, "field", [{"var", "ocr"}, {"label", ?CAPTCHA_TEXT(Lang)}],
+		     [{xmlelement, "media", [{"xmlns", ?NS_MEDIA}],
+		       [{xmlelement, "uri", [{"type", Type}],
+			 [{xmlcdata, "cid:" ++ CID}]}]}]}]}]},
+	    BodyString1 = translate:translate(Lang, "Your messages to ~s are being blocked. To unblock them, visit ~s"),
+	    BodyString = io_lib:format(BodyString1, [JID, get_url(Id)]),
+	    Body = {xmlelement, "body", [],
+		    [{xmlcdata, BodyString}]},
+	    OOB = {xmlelement, "x", [{"xmlns", ?NS_OOB}],
+		   [{xmlelement, "url", [], [{xmlcdata, get_url(Id)}]}]},
+	    Tref = erlang:send_after(?CAPTCHA_LIFETIME, ?MODULE, {remove_id, Id}),
+	    case ?T(mnesia:write(#captcha{id=Id, pid=self(), key=Key,
+					  tref=Tref, args=Args})) of
+		ok ->
+		    {ok, [Body, OOB, Captcha, Data]};
+		_Err ->
+		    error
+	    end;
+	_Err ->
+	    error
+    end.
+
+%% @spec (Id::string(), Lang::string()) -> {FormEl, {ImgEl, TextEl, IdEl, KeyEl}} | captcha_not_found
+%% where FormEl = xmlelement()
+%%       ImgEl = xmlelement()
+%%       TextEl = xmlelement()
+%%       IdEl = xmlelement()
+%%       KeyEl = xmlelement()
+build_captcha_html(Id, Lang) ->
+    case mnesia:dirty_read(captcha, Id) of
+	[#captcha{}] ->
+	    ImgEl = {xmlelement, "img", [{"src", get_url(Id ++ "/image")}], []},
+	    TextEl = {xmlcdata, ?CAPTCHA_TEXT(Lang)},
+	    IdEl = {xmlelement, "input", [{"type", "hidden"},
+					  {"name", "id"},
+					  {"value", Id}], []},
+	    KeyEl = {xmlelement, "input", [{"type", "text"},
+					   {"name", "key"},
+					   {"size", "10"}], []},
+	    FormEl = {xmlelement, "form", [{"action", get_url(Id)},
+					   {"name", "captcha"},
+					   {"method", "POST"}],
+		      [ImgEl,
+		       {xmlelement, "br", [], []},
+		       TextEl,
+		       {xmlelement, "br", [], []},
+		       IdEl,
+		       KeyEl,
+		       {xmlelement, "br", [], []},
+		       {xmlelement, "input", [{"type", "submit"},
+					      {"name", "enter"},
+					      {"value", "OK"}], []}
+		      ]},
+	    {FormEl, {ImgEl, TextEl, IdEl, KeyEl}};
+	_ ->
+	    captcha_not_found
+    end.
+
+%% @spec (Id::string(), ProvidedKey::string()) -> captcha_valid | captcha_non_valid | captcha_not_found
+check_captcha(Id, ProvidedKey) ->
+    ?T(case mnesia:read(captcha, Id, write) of
+	   [#captcha{pid=Pid, args=Args, key=StoredKey, tref=Tref}] ->
+	       mnesia:delete({captcha, Id}),
+	       erlang:cancel_timer(Tref),
+	       if StoredKey == ProvidedKey ->
+		       Pid ! {captcha_succeed, Args},
+		       captcha_valid;
+		  true ->
+		       Pid ! {captcha_failed, Args},
+		       captcha_non_valid
+	       end;
+	   _ ->
+	       captcha_not_found
+       end).
+
+
+process_reply({xmlelement, "captcha", _, _} = El) ->
+    case xml:get_subtag(El, "x") of
+	false ->
+	    {error, malformed};
+	Xdata ->
+	    Fields = jlib:parse_xdata_submit(Xdata),
+	    case {proplists:get_value("challenge", Fields),
+		  proplists:get_value("ocr", Fields)} of
+		{[Id|_], [OCR|_]} ->
+		    ?T(case mnesia:read(captcha, Id, write) of
+			   [#captcha{pid=Pid, args=Args, key=Key, tref=Tref}] ->
+			       mnesia:delete({captcha, Id}),
+			       erlang:cancel_timer(Tref),
+			       if OCR == Key ->
+				       Pid ! {captcha_succeed, Args},
+				       ok;
+				  true ->
+				       Pid ! {captcha_failed, Args},
+				       {error, bad_match}
+			       end;
+			   _ ->
+			       {error, not_found}
+		       end);
+		_ ->
+		    {error, malformed}
+	    end
+    end;
+process_reply(_) ->
+    {error, malformed}.
+
+
+process(_Handlers, #request{method='GET', lang=Lang, path=[_, Id]}) ->
+    case build_captcha_html(Id, Lang) of
+	{FormEl, _} when is_tuple(FormEl) ->
+	    Form =
+		{xmlelement, "div", [{"align", "center"}],
+		 [FormEl]},
+	    ejabberd_web:make_xhtml([Form]);
+	captcha_not_found ->
+	    ejabberd_web:error(not_found)
+    end;
+
+process(_Handlers, #request{method='GET', path=[_, Id, "image"]}) ->
+    case mnesia:dirty_read(captcha, Id) of
+	[#captcha{key=Key}] ->
+	    case create_image(Key) of
+		{ok, Type, _, Img} ->
+		    {200,
+		     [{"Content-Type", Type},
+		      {"Cache-Control", "no-cache"},
+		      {"Last-Modified", httpd_util:rfc1123_date()}],
+		     Img};
+		_ ->
+		    ejabberd_web:error(not_found)
+	    end;
+	_ ->
+	    ejabberd_web:error(not_found)
+    end;
+
+process(_Handlers, #request{method='POST', q=Q, lang=Lang, path=[_, Id]}) ->
+    ProvidedKey = proplists:get_value("key", Q, none),
+    case check_captcha(Id, ProvidedKey) of
+	captcha_valid ->
+	    Form =
+		{xmlelement, "p", [],
+		 [{xmlcdata,
+		   translate:translate(Lang, "The captcha is valid.")
+		  }]},
+	    ejabberd_web:make_xhtml([Form]);
+	captcha_non_valid ->
+	    ejabberd_web:error(not_allowed);
+	captcha_not_found ->
+	    ejabberd_web:error(not_found)
+    end;
+
+process(_Handlers, _Request) ->
+    ejabberd_web:error(not_found).
+
+
+%%====================================================================
+%% gen_server callbacks
+%%====================================================================
+init([]) ->
+    mnesia:create_table(captcha,
+			[{ram_copies, [node()]},
+			 {attributes, record_info(fields, captcha)}]),
+    mnesia:add_table_copy(captcha, node(), ram_copies),
+    check_captcha_setup(),
+    {ok, #state{}}.
+
+handle_call(_Request, _From, State) ->
+    {reply, bad_request, State}.
+
+handle_cast(_Msg, State) ->
+    {noreply, State}.
+
+handle_info({remove_id, Id}, State) ->
+    ?DEBUG("captcha ~p timed out", [Id]),
+    _ = ?T(case mnesia:read(captcha, Id, write) of
+	       [#captcha{args=Args, pid=Pid}] ->
+		   Pid ! {captcha_failed, Args},
+		   mnesia:delete({captcha, Id});
+	       _ ->
+		   ok
+	   end),
+    {noreply, State};
+
+handle_info(_Info, State) ->
+    {noreply, State}.
+
+terminate(_Reason, _State) ->
+    ok.
+
+code_change(_OldVsn, State, _Extra) ->
+    {ok, State}.
+
+%%--------------------------------------------------------------------
+%%% Internal functions
+%%--------------------------------------------------------------------
+%%--------------------------------------------------------------------
+%% Function: create_image() -> {ok, Type, Key, Image} | {error, Reason}
+%% Type = "image/png" | "image/jpeg" | "image/gif"
+%% Key = string()
+%% Image = binary()
+%% Reason = atom()
+%%--------------------------------------------------------------------
+create_image() ->
+    %% Six numbers from 1 to 9.
+    Key = string:substr(randoms:get_string(), 1, 6),
+    create_image(Key).
+
+create_image(Key) ->
+    FileName = get_prog_name(),
+    Cmd = lists:flatten(io_lib:format("~s ~s", [FileName, Key])),
+    case cmd(Cmd) of
+	{ok, <<16#89, $P, $N, $G, $\r, $\n, 16#1a, $\n, _/binary>> = Img} ->
+	    {ok, "image/png", Key, Img};
+	{ok, <<16#ff, 16#d8, _/binary>> = Img} ->
+	    {ok, "image/jpeg", Key, Img};
+	{ok, <<$G, $I, $F, $8, X, $a, _/binary>> = Img} when X==$7; X==$9 ->
+	    {ok, "image/gif", Key, Img};
+	{error, enodata = Reason} ->
+	    ?ERROR_MSG("Failed to process output from \"~s\". "
+		       "Maybe ImageMagick's Convert program is not installed.",
+		       [Cmd]),
+	    {error, Reason};
+	{error, Reason} ->
+	    ?ERROR_MSG("Failed to process an output from \"~s\": ~p",
+		       [Cmd, Reason]),
+	    {error, Reason};
+	_ ->
+	    Reason = malformed_image,
+	    ?ERROR_MSG("Failed to process an output from \"~s\": ~p",
+		       [Cmd, Reason]),
+	    {error, Reason}
+    end.
+
+get_prog_name() ->
+    case ejabberd_config:get_local_option(captcha_cmd) of
+	FileName when is_list(FileName) ->
+	    FileName;
+	_ ->
+	    ?DEBUG("The option captcha_cmd is not configured, but some "
+			  "module wants to use the CAPTCHA feature.", []),
+	    throw({error, option_not_configured_captcha_cmd})
+    end.
+
+get_url(Str) ->
+    case ejabberd_config:get_local_option(captcha_host) of
+	Host when is_list(Host) ->
+	    "http://" ++ Host ++ "/captcha/" ++ Str;
+	_ ->
+	    "http://" ++ ?MYNAME ++ "/captcha/" ++ Str
+    end.
+
+%%--------------------------------------------------------------------
+%% Function: cmd(Cmd) -> Data | {error, Reason}
+%% Cmd = string()
+%% Data = binary()
+%% Description: os:cmd/1 replacement
+%%--------------------------------------------------------------------
+-define(CMD_TIMEOUT, 5000).
+-define(MAX_FILE_SIZE, 64*1024).
+
+cmd(Cmd) ->
+    Port = open_port({spawn, Cmd}, [stream, eof, binary]),
+    TRef = erlang:start_timer(?CMD_TIMEOUT, self(), timeout),
+    recv_data(Port, TRef, <<>>).
+
+recv_data(Port, TRef, Buf) ->
+    receive
+	{Port, {data, Bytes}} ->
+	    NewBuf = <<Buf/binary, Bytes/binary>>,
+	    if size(NewBuf) > ?MAX_FILE_SIZE ->
+		    return(Port, TRef, {error, efbig});
+	       true ->
+		    recv_data(Port, TRef, NewBuf)
+	    end;
+	{Port, {data, _}} ->
+	    return(Port, TRef, {error, efbig});
+	{Port, eof} when Buf /= <<>> ->
+	    return(Port, TRef, {ok, Buf});
+	{Port, eof} ->
+	    return(Port, TRef, {error, enodata});
+	{timeout, TRef, _} ->
+	    return(Port, TRef, {error, timeout})
+    end.
+
+return(Port, TRef, Result) ->
+    case erlang:cancel_timer(TRef) of
+	false ->
+	    receive
+		{timeout, TRef, _} ->
+		    ok
+	    after 0 ->
+		    ok
+	    end;
+	_ ->
+	    ok
+    end,
+    catch port_close(Port),
+    Result.
+
+is_feature_enabled() ->
+    try get_prog_name() of
+	Prog when is_list(Prog) -> true
+    catch 
+	_:_ -> false
+    end.
+
+is_feature_available() ->
+    case is_feature_enabled() of
+	false -> false;
+	true ->
+	    case create_image() of
+		{ok, _, _, _} -> true;
+		_Error -> false
+	    end
+    end.
+
+check_captcha_setup() ->
+    case is_feature_enabled() andalso not is_feature_available() of
+	true ->
+	    ?CRITICAL_MSG("Captcha is enabled in the option captcha_cmd, "
+			  "but it can't generate images.", []);
+	false ->
+	    ok
+    end.

src/ejabberd_check.erl

@@ -0,0 +1,112 @@
+%%%----------------------------------------------------------------------
+%%% File    : ejabberd_check.erl
+%%% Author  : Mickael Remond <mremond@process-one.net>
+%%% Purpose : Check ejabberd configuration and 
+%%% Created : 27 Feb 2008 by Mickael Remond <mremond@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%----------------------------------------------------------------------
+
+-module(ejabberd_check).
+
+-export([libs/0, config/0]).
+
+-include("ejabberd.hrl").
+-include("ejabberd_config.hrl").
+
+-compile([export_all]).
+
+%% TODO:
+%% We want to implement library checking at launch time to issue
+%% human readable user messages.
+libs() ->
+    ok.
+
+%% @doc Consistency check on ejabberd configuration
+config() ->
+    check_database_modules().
+
+check_database_modules() ->
+     [check_database_module(M)||M<-get_db_used()].
+
+check_database_module(odbc) ->
+    check_modules(odbc, [odbc, odbc_app, odbc_sup, ejabberd_odbc, ejabberd_odbc_sup, odbc_queries]);
+check_database_module(mysql) ->
+    check_modules(mysql, [mysql, mysql_auth, mysql_conn, mysql_recv]);
+check_database_module(pgsql) ->
+    check_modules(pgsql, [pgsql, pgsql_proto, pgsql_tcp, pgsql_util]).
+
+%% @doc Issue a critical error and throw an exit if needing module is
+%% missing.
+check_modules(DB, Modules) ->
+    case get_missing_modules(Modules) of
+	[] ->
+	    ok;
+	MissingModules when is_list(MissingModules) ->
+	    ?CRITICAL_MSG("ejabberd is configured to use '~p', but the following Erlang modules are not installed: '~p'", [DB, MissingModules]),
+	    exit(database_module_missing)
+    end.
+
+
+%% @doc Return the list of undefined modules
+get_missing_modules(Modules) ->
+    lists:filter(fun(Module) ->
+			 case catch Module:module_info() of
+			     {'EXIT', {undef, _}} ->
+				 true;
+			     _ -> false
+			 end
+		 end, Modules).
+
+%% @doc Return the list of databases used
+get_db_used() ->
+    %% Retrieve domains with a database configured:
+    Domains = 
+	ets:match(local_config, #local_config{key={odbc_server, '$1'},
+					      value='$2'}),
+    %% Check that odbc is the auth method used for those domains:
+    %% and return the database name
+    DBs = lists:foldr(
+	    fun([Domain, DB], Acc) ->
+		    case check_odbc_option(
+			   ejabberd_config:get_local_option(
+			     {auth_method, Domain})) of
+			true -> [get_db_type(DB)|Acc];
+			_ -> Acc
+		    end
+	    end,
+	    [], Domains),
+    lists:usort(DBs).
+
+%% @doc Depending in the DB definition, return which type of DB this is.
+%% Note that MSSQL is detected as ODBC.
+%% @spec (DB) -> mysql | pgsql | odbc
+get_db_type(DB) when is_tuple(DB) ->
+    element(1, DB);
+get_db_type(DB) when is_list(DB) ->
+    odbc.
+
+%% @doc Return true if odbc option is used
+check_odbc_option(odbc) ->
+    true;
+check_odbc_option(AuthMethods) when is_list(AuthMethods) ->
+    lists:member(odbc, AuthMethods);
+check_odbc_option(_) ->
+    false.

src/ejabberd_commands.erl

@@ -0,0 +1,429 @@
+%%%----------------------------------------------------------------------
+%%% File    : ejabberd_commands.erl
+%%% Author  : Badlop <badlop@process-one.net>
+%%% Purpose : Management of ejabberd commands
+%%% Created : 20 May 2008 by Badlop <badlop@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%----------------------------------------------------------------------
+
+%%% @headerfile "ejabberd_commands.hrl"
+
+%%% @doc Management of ejabberd commands.
+%%%
+%%% An ejabberd command is an abstract function identified by a name,
+%%% with a defined number and type of calling arguments and type of
+%%% result, that can be defined in any Erlang module and executed
+%%% using any valid frontend.
+%%%
+%%%
+%%% == Define a new ejabberd command ==
+%%%
+%%% ejabberd commands can be defined and registered in
+%%% any Erlang module.
+%%%
+%%% Some commands are procedures; and their purpose is to perform an
+%%% action in the server, so the command result is only some result
+%%% code or result tuple.  Other commands are inspectors, and their
+%%% purpose is to gather some information about the server and return
+%%% a detailed response: it can be integer, string, atom, tuple, list
+%%% or a mix of those ones.
+%%%
+%%% The arguments and result of an ejabberd command are strictly
+%%% defined.  The number and format of the arguments provided when
+%%% calling an ejabberd command must match the definition of that
+%%% command.  The format of the result provided by an ejabberd command
+%%% must be exactly its definition. For example, if a command is said
+%%% to return an integer, it must always return an integer (except in
+%%% case of a crash).
+%%%
+%%% If you are developing an Erlang module that will run inside
+%%% ejabberd and you want to provide a new ejabberd command to
+%%% administer some task related to your module, you only need to:
+%%% implement a function, define the command, and register it.
+%%%
+%%%
+%%% === Define a new ejabberd command ===
+%%%
+%%% An ejabberd command is defined using the Erlang record
+%%% 'ejabberd_commands'.  This record has several elements that you
+%%% must define. Note that 'tags', 'desc' and 'longdesc' are optional.
+%%%
+%%% For example let's define an ejabberd command 'pow' that gets the
+%%% integers 'base' and 'exponent'. Its result will be an integer
+%%% 'power':
+%%%
+%%% <pre>#ejabberd_commands{name = pow, tags = [test],
+%%%                 desc = "Return the power of base for exponent",
+%%%                 longdesc = "This is an example command. The formula is:\n"
+%%%                 "  power = base ^ exponent",
+%%%                 module = ?MODULE, function = pow,
+%%%                 args = [{base, integer}, {exponent, integer}],
+%%%                 result = {power, integer}}</pre>
+%%%
+%%%
+%%% === Implement the function associated to the command ===
+%%%
+%%% Now implement a function in your module that matches the arguments
+%%% and result of the ejabberd command.
+%%%
+%%% For example the function calc_power gets two integers Base and
+%%% Exponent. It calculates the power and rounds to an integer:
+%%%
+%%% <pre>calc_power(Base, Exponent) ->
+%%%    PowFloat = math:pow(Base, Exponent),
+%%%    round(PowFloat).</pre>
+%%%
+%%% Since this function will be called by ejabberd_commands, it must be exported.
+%%% Add to your module:
+%%% <pre>-export([calc_power/2]).</pre>
+%%%
+%%% Only some types of result formats are allowed.
+%%% If the format is defined as 'rescode', then your function must return:
+%%%   ok | true | atom()
+%%% where the atoms ok and true as considered positive answers,
+%%% and any other response atom is considered negative.
+%%%
+%%% If the format is defined as 'restuple', then the command must return:
+%%%   {rescode(), string()}
+%%%
+%%% If the format is defined as '{list, something()}', then the command
+%%% must return a list of something().
+%%%
+%%%
+%%% === Register the command ===
+%%%
+%%% Define this function and put inside the #ejabberd_command you
+%%% defined in the beginning:
+%%%
+%%% <pre>commands() ->
+%%%    [
+%%%
+%%%    ].</pre>
+%%%
+%%% You need to include this header file in order to use the record:
+%%%
+%%% <pre>-include("ejabberd_commands.hrl").</pre>
+%%%
+%%% When your module is initialized or started, register your commands:
+%%%
+%%% <pre>ejabberd_commands:register_commands(commands()),</pre>
+%%%
+%%% And when your module is stopped, unregister your commands:
+%%%
+%%% <pre>ejabberd_commands:unregister_commands(commands()),</pre>
+%%%
+%%% That's all! Now when your module is started, the command will be
+%%% registered and any frontend can access it. For example:
+%%%
+%%% <pre>$ ejabberdctl help pow
+%%%
+%%%   Command Name: pow
+%%%
+%%%   Arguments: base::integer
+%%%              exponent::integer
+%%%
+%%%   Returns: power::integer
+%%%
+%%%   Tags: test
+%%%
+%%%   Description: Return the power of base for exponent
+%%%
+%%% This is an example command. The formula is:
+%%%  power = base ^ exponent
+%%%
+%%% $ ejabberdctl pow 3 4
+%%% 81
+%%% </pre>
+%%%
+%%%
+%%% == Execute an ejabberd command ==
+%%%
+%%% ejabberd commands are mean to be executed using any valid
+%%% frontend.  An ejabberd commands is implemented in a regular Erlang
+%%% function, so it is also possible to execute this function in any
+%%% Erlang module, without dealing with the associated ejabberd
+%%% commands.
+%%%
+%%%
+%%% == Frontend to ejabberd commands ==
+%%%
+%%% Currently there are two frontends to ejabberd commands: the shell
+%%% script {@link ejabberd_ctl. ejabberdctl}, and the XML-RPC server
+%%% ejabberd_xmlrpc.
+%%%
+%%%
+%%% === ejabberdctl as a frontend to ejabberd commands ===
+%%%
+%%% It is possible to use ejabberdctl to get documentation of any
+%%% command. But ejabberdctl does not support all the argument types
+%%% allowed in ejabberd commands, so there are some ejabberd commands
+%%% that cannot be executed using ejabberdctl.
+%%%
+%%% Also note that the ejabberdctl shell administration script also
+%%% manages ejabberdctl commands, which are unrelated to ejabberd
+%%% commands and can only be executed using ejabberdctl.
+%%%
+%%%
+%%% === ejabberd_xmlrpc as a frontend to ejabberd commands ===
+%%%
+%%% ejabberd_xmlrpc provides an XML-RPC server to execute ejabberd commands.
+%%% ejabberd_xmlrpc is a contributed module published in ejabberd-modules SVN.
+%%%
+%%% Since ejabberd_xmlrpc does not provide any method to get documentation
+%%% of the ejabberd commands, please use ejabberdctl to know which
+%%% commands are available, and their usage.
+%%%
+%%% The number and format of the arguments provided when calling an
+%%% ejabberd command must match the definition of that command. Please
+%%% make sure the XML-RPC call provides the required arguments, with
+%%% the specified format. The order of the arguments in an XML-RPC
+%%% call is not important, because all the data is tagged and will be
+%%% correctly prepared by ejabberd_xmlrpc before executing the ejabberd
+%%% command.
+
+%%% TODO: consider this feature:
+%%% All commands are catched. If an error happens, return the restuple:
+%%%   {error, flattened error string}
+%%% This means that ecomm call APIs (ejabberd_ctl, ejabberd_xmlrpc) need to allows this.
+%%% And ejabberd_xmlrpc must be prepared to handle such an unexpected response.
+
+
+-module(ejabberd_commands).
+-author('badlop@process-one.net').
+
+-export([init/0,
+	 list_commands/0,
+	 get_command_format/1,
+	 get_command_definition/1,
+	 get_tags_commands/0,
+	 register_commands/1,
+	 unregister_commands/1,
+	 execute_command/2,
+	 execute_command/4
+	]).
+
+-include("ejabberd_commands.hrl").
+-include("ejabberd.hrl").
+
+
+init() ->
+    ets:new(ejabberd_commands, [named_table, set, public,
+				{keypos, #ejabberd_commands.name}]).
+
+%% @spec ([ejabberd_commands()]) -> ok
+%% @doc Register ejabberd commands.
+%% If a command is already registered, a warning is printed and the old command is preserved.
+register_commands(Commands) ->
+    lists:foreach(
+      fun(Command) ->
+	      case ets:insert_new(ejabberd_commands, Command) of
+		  true ->
+		      ok;
+		  false ->
+		      ?DEBUG("This command is already defined:~n~p", [Command])
+	      end
+      end,
+      Commands).
+
+%% @spec ([ejabberd_commands()]) -> ok
+%% @doc Unregister ejabberd commands.
+unregister_commands(Commands) ->
+    lists:foreach(
+      fun(Command) ->
+	      ets:delete_object(ejabberd_commands, Command)
+      end,
+      Commands).
+
+%% @spec () -> [{Name::atom(), Args::[aterm()], Desc::string()}]
+%% @doc Get a list of all the available commands, arguments and description.
+list_commands() ->
+    Commands = ets:match(ejabberd_commands,
+			 #ejabberd_commands{name = '$1',
+					    args = '$2',
+					    desc = '$3',
+					    _ = '_'}),
+    [{A, B, C} || [A, B, C] <- Commands].
+
+%% @spec (Name::atom()) -> {Args::[aterm()], Result::rterm()} | {error, command_unknown}
+%% @doc Get the format of arguments and result of a command.
+get_command_format(Name) ->
+    Matched = ets:match(ejabberd_commands,
+			#ejabberd_commands{name = Name,
+					   args = '$1',
+					   result = '$2',
+					   _ = '_'}),
+    case Matched of
+	[] ->
+	    {error, command_unknown};
+	[[Args, Result]] ->
+	    {Args, Result}
+    end.
+
+%% @spec (Name::atom()) -> ejabberd_commands() | command_not_found
+%% @doc Get the definition record of a command.
+get_command_definition(Name) ->
+    case ets:lookup(ejabberd_commands, Name) of
+	[E] -> E;
+	[] -> command_not_found
+    end.
+
+%% @spec (Name::atom(), Arguments) -> ResultTerm | {error, command_unknown}
+%% @doc Execute a command.
+execute_command(Name, Arguments) ->
+    execute_command([], noauth, Name, Arguments).
+
+%% @spec (AccessCommands, Auth, Name::atom(), Arguments) -> ResultTerm | {error, Error}
+%% where 
+%%       AccessCommands = [{Access, CommandNames, Arguments}]
+%%       Auth = {User::string(), Server::string(), Password::string()} | noauth
+%%       Method = atom()
+%%       Arguments = [any()]
+%%       Error = command_unknown | account_unprivileged | invalid_account_data | no_auth_provided
+execute_command(AccessCommands, Auth, Name, Arguments) ->
+    case ets:lookup(ejabberd_commands, Name) of
+	[Command] ->
+	    try check_access_commands(AccessCommands, Auth, Name, Command, Arguments) of
+		ok -> execute_command2(Command, Arguments)
+	    catch
+		{error, Error} -> {error, Error}
+	    end;
+	[] -> {error, command_unknown}
+    end.
+
+execute_command2(Command, Arguments) ->
+    Module = Command#ejabberd_commands.module,
+    Function = Command#ejabberd_commands.function,
+    ?DEBUG("Executing command ~p:~p with Args=~p", [Module, Function, Arguments]),
+    apply(Module, Function, Arguments).
+
+%% @spec () -> [{Tag::string(), [CommandName::string()]}]
+%% @doc Get all the tags and associated commands.
+get_tags_commands() ->
+    CommandTags = ets:match(ejabberd_commands,
+			    #ejabberd_commands{
+			      name = '$1',
+			      tags = '$2',
+			      _ = '_'}),
+    Dict = lists:foldl(
+	     fun([CommandNameAtom, CTags], D) ->
+		     CommandName = atom_to_list(CommandNameAtom),
+		     case CTags of
+			 [] ->
+			     orddict:append("untagged", CommandName, D);
+			 _ ->
+			     lists:foldl(
+			       fun(TagAtom, DD) ->
+				       Tag = atom_to_list(TagAtom),
+				       orddict:append(Tag, CommandName, DD)
+			       end,
+			       D,
+			       CTags)
+		     end
+	     end,
+	     orddict:new(),
+	     CommandTags),
+    orddict:to_list(Dict).
+
+
+%% -----------------------------
+%% Access verification
+%% -----------------------------
+
+%% @spec (AccessCommands, Auth, Method, Command, Arguments) -> ok
+%% where 
+%%       AccessCommands =  [ {Access, CommandNames, Arguments} ]
+%%       Auth = {User::string(), Server::string(), Password::string()} | noauth
+%%       Method = atom()
+%%       Arguments = [any()]
+%% @doc Check access is allowed to that command.
+%% At least one AccessCommand must be satisfied.
+%% It may throw {error, Error} where:
+%% Error = account_unprivileged | invalid_account_data
+check_access_commands([], _Auth, _Method, _Command, _Arguments) ->
+    ok;
+check_access_commands(AccessCommands, Auth, Method, Command, Arguments) ->
+    AccessCommandsAllowed =
+	lists:filter(
+	  fun({Access, Commands, ArgumentRestrictions}) ->
+		  case check_access(Access, Auth) of
+		      true ->
+			  check_access_command(Commands, Command, ArgumentRestrictions,
+					       Method, Arguments);
+		      false ->
+			  false
+		  end
+	  end,
+	  AccessCommands),
+    case AccessCommandsAllowed of
+	[] -> throw({error, account_unprivileged});
+	L when is_list(L) -> ok
+    end.
+
+check_auth(noauth) ->
+    no_auth_provided;
+check_auth({User, Server, Password}) ->
+    %% Check the account exists and password is valid
+    AccountPass = ejabberd_auth:get_password_s(User, Server),
+    AccountPassMD5 = get_md5(AccountPass),
+    case Password of
+	AccountPass -> {ok, User, Server};
+	AccountPassMD5 -> {ok, User, Server};
+	_ -> throw({error, invalid_account_data})
+    end.
+
+get_md5(AccountPass) ->
+    lists:flatten([io_lib:format("~.16B", [X])
+		   || X <- binary_to_list(crypto:md5(AccountPass))]).
+
+check_access(all, _) ->
+    true;
+check_access(Access, Auth) ->
+    {ok, User, Server} = check_auth(Auth),
+    %% Check this user has access permission
+    case acl:match_rule(Server, Access, jlib:make_jid(User, Server, "")) of
+	allow -> true;
+	deny -> false
+    end.
+
+check_access_command(Commands, Command, ArgumentRestrictions, Method, Arguments) ->
+    case Commands==all orelse lists:member(Method, Commands) of
+	true -> check_access_arguments(Command, ArgumentRestrictions, Arguments);
+	false -> false
+    end.
+
+check_access_arguments(Command, ArgumentRestrictions, Arguments) ->
+    ArgumentsTagged = tag_arguments(Command#ejabberd_commands.args, Arguments),
+    lists:all(
+      fun({ArgName, ArgAllowedValue}) ->
+	      %% If the call uses the argument, check the value is acceptable
+	      case lists:keysearch(ArgName, 1, ArgumentsTagged) of
+		  {value, {ArgName, ArgValue}} -> ArgValue == ArgAllowedValue;
+		  false -> true
+	      end
+      end, ArgumentRestrictions).
+
+tag_arguments(ArgsDefs, Args) ->
+    lists:zipwith(
+      fun({ArgName, _ArgType}, ArgValue) -> 
+	      {ArgName, ArgValue}
+      end, 
+      ArgsDefs,
+      Args).

src/ejabberd_commands.hrl

@@ -0,0 +1,52 @@
+%%%----------------------------------------------------------------------
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%----------------------------------------------------------------------
+
+-record(ejabberd_commands, {name, tags = [],
+			   desc = "", longdesc = "",
+			   module, function,
+			   args = [], result = rescode}).
+
+%% @type ejabberd_commands() = #ejabberd_commands{
+%%    name = atom(),
+%%    tags = [atom()],
+%%    desc = string(),
+%%    longdesc = string(),
+%%    module = atom(),
+%%    function = atom(),
+%%    args = [aterm()],
+%%    result = rterm()
+%%    }.
+%% desc: Description of the command
+%% args: Describe the accepted arguments.
+%% This way the function that calls the command can format the
+%% arguments before calling.
+
+%% @type atype() = integer | string | {tuple, [aterm()]} | {list, aterm()}.
+%% Allowed types for arguments are integer, string, tuple and list.
+
+%% @type rtype() = integer | string | atom | {tuple, [rterm()]} | {list, rterm()} | rescode | restuple.
+%% A rtype is either an atom or a tuple with two elements.
+
+%% @type aterm() = {Name::atom(), Type::atype()}.
+%% An argument term is a tuple with the term name and the term type.
+
+%% @type rterm() = {Name::atom(), Type::rtype()}.
+%% A result term is a tuple with the term name and the term type.

src/ejabberd_config.erl

@@ -1,28 +1,50 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_config.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : Load config file
-%%% Created : 14 Dec 2002 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created : 14 Dec 2002 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_config).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -export([start/0, load_file/1,
 	 add_global_option/2, add_local_option/2,
 	 get_global_option/1, get_local_option/1]).
+-export([get_vh_by_auth_method/1]).
+-export([is_file_readable/1]).
 
 -include("ejabberd.hrl").
+-include("ejabberd_config.hrl").
+-include_lib("kernel/include/file.hrl").
+
+
+%% @type macro() = {macro_key(), macro_value()}
+
+%% @type macro_key() = atom().
+%% The atom must have all characters in uppercase.
+
+%% @type macro_value() = term().
 
--record(config, {key, value}).
--record(local_config, {key, value}).
--record(state, {opts = [],
-		hosts = [],
-		override_local = false,
-		override_global = false,
-		override_acls = false}).
 
 start() ->
     mnesia:create_table(config,
@@ -34,36 +56,82 @@ start() ->
 			 {local_content, true},
 			 {attributes, record_info(fields, local_config)}]),
     mnesia:add_table_copy(local_config, node(), ram_copies),
-    Config = case application:get_env(config) of
-		 {ok, Path} -> Path;
-		 undefined -> 
-		     case os:getenv("EJABBERD_CONFIG_PATH") of
-			 false ->
-			     ?CONFIG_PATH;
-			 Path ->
-			     Path
-		     end
-	     end,
-    load_file(Config).
+    Config = get_ejabberd_config_path(),
+    load_file(Config),
+    %% This start time is used by mod_last:
+    add_local_option(node_start, now()),
+    ok.
 
+%% @doc Get the filename of the ejabberd configuration file.
+%% The filename can be specified with: erl -config "/path/to/ejabberd.cfg".
+%% It can also be specified with the environtment variable EJABBERD_CONFIG_PATH.
+%% If not specified, the default value 'ejabberd.cfg' is assumed.
+%% @spec () -> string()
+get_ejabberd_config_path() ->
+    case application:get_env(config) of
+	{ok, Path} -> Path;
+	undefined ->
+	    case os:getenv("EJABBERD_CONFIG_PATH") of
+		false ->
+		    ?CONFIG_PATH;
+		Path ->
+		    Path
+	    end
+    end.
 
+%% @doc Load the ejabberd configuration file.
+%% It also includes additional configuration files and replaces macros.
+%% This function will crash if finds some error in the configuration file.
+%% @spec (File::string()) -> ok
 load_file(File) ->
+    Terms = get_plain_terms_file(File),
+    State = lists:foldl(fun search_hosts/2, #state{}, Terms),
+    Terms_macros = replace_macros(Terms),
+    Res = lists:foldl(fun process_term/2, State, Terms_macros),
+    set_opts(Res).
+
+%% @doc Read an ejabberd configuration file and return the terms.
+%% Input is an absolute or relative path to an ejabberd config file.
+%% Returns a list of plain terms,
+%% in which the options 'include_config_file' were parsed
+%% and the terms in those files were included.
+%% @spec(string()) -> [term()]
+get_plain_terms_file(File1) ->
+    File = get_absolute_path(File1),
     case file:consult(File) of
 	{ok, Terms} ->
-	    State = lists:foldl(fun search_hosts/2, #state{}, Terms),
-	    Res = lists:foldl(fun process_term/2, State, Terms),
-	    set_opts(Res);
+	    include_config_files(Terms);
+	{error, {LineNumber, erl_parse, _ParseMessage} = Reason} ->
+	    ExitText = describe_config_problem(File, Reason, LineNumber),
+	    ?ERROR_MSG(ExitText, []),
+	    exit_or_halt(ExitText);
 	{error, Reason} ->
-	    ?ERROR_MSG("Can't load config file ~p: ~p", [File, Reason]),
-	    exit(file:format_error(Reason))
+	    ExitText = describe_config_problem(File, Reason),
+	    ?ERROR_MSG(ExitText, []),
+	    exit_or_halt(ExitText)
     end.
 
+%% @doc Convert configuration filename to absolute path.
+%% Input is an absolute or relative path to an ejabberd configuration file.
+%% And returns an absolute path to the configuration file.
+%% @spec (string()) -> string()
+get_absolute_path(File) ->
+    case filename:pathtype(File) of
+	absolute ->
+	    File;
+	relative ->
+	    Config_path = get_ejabberd_config_path(),
+	    Config_dir = filename:dirname(Config_path),
+	    filename:absname_join(Config_dir, File)
+    end.
+
+
 search_hosts(Term, State) ->
     case Term of
 	{host, Host} ->
 	    if
 		State#state.hosts == [] ->
-		    add_option(hosts, [Host], State#state{hosts = [Host]});
+		    add_hosts_to_option([Host], State);
 		true ->
 		    ?ERROR_MSG("Can't load config file: "
 			       "too many hosts definitions", []),
@@ -72,7 +140,7 @@ search_hosts(Term, State) ->
 	{hosts, Hosts} ->
 	    if
 		State#state.hosts == [] ->
-		    add_option(hosts, Hosts, State#state{hosts = Hosts});
+		    add_hosts_to_option(Hosts, State);
 		true ->
 		    ?ERROR_MSG("Can't load config file: "
 			       "too many hosts definitions", []),
@@ -82,6 +150,210 @@ search_hosts(Term, State) ->
 	    State
     end.
 
+add_hosts_to_option(Hosts, State) ->
+    PrepHosts = normalize_hosts(Hosts),
+    add_option(hosts, PrepHosts, State#state{hosts = PrepHosts}).
+
+normalize_hosts(Hosts) ->
+    normalize_hosts(Hosts,[]).
+normalize_hosts([], PrepHosts) ->
+    lists:reverse(PrepHosts);
+normalize_hosts([Host|Hosts], PrepHosts) ->
+    case jlib:nodeprep(Host) of
+	error ->
+	    ?ERROR_MSG("Can't load config file: "
+		       "invalid host name [~p]", [Host]),
+	    exit("invalid hostname");
+	PrepHost ->
+	    normalize_hosts(Hosts, [PrepHost|PrepHosts])
+    end.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%% Errors reading the config file
+
+describe_config_problem(Filename, Reason) ->
+    Text1 = lists:flatten("Problem loading ejabberd config file " ++ Filename),
+    Text2 = lists:flatten(" : " ++ file:format_error(Reason)),
+    ExitText = Text1 ++ Text2,
+    ExitText.
+
+describe_config_problem(Filename, Reason, LineNumber) ->
+    Text1 = lists:flatten("Problem loading ejabberd config file " ++ Filename),
+    Text2 = lists:flatten(" approximately in the line "
+			  ++ file:format_error(Reason)),
+    ExitText = Text1 ++ Text2,
+    Lines = get_config_lines(Filename, LineNumber, 10, 3),
+    ?ERROR_MSG("The following lines from your configuration file might be"
+	       " relevant to the error: ~n~s", [Lines]),
+    ExitText.
+
+get_config_lines(Filename, TargetNumber, PreContext, PostContext) ->
+    {ok, Fd} = file:open(Filename, [read]),
+    LNumbers = lists:seq(TargetNumber-PreContext, TargetNumber+PostContext),
+    NextL = io:get_line(Fd, no_prompt),
+    R = get_config_lines2(Fd, NextL, 1, LNumbers, []),
+    file:close(Fd),
+    R.
+
+get_config_lines2(_Fd, eof, _CurrLine, _LNumbers, R) ->
+    lists:reverse(R);
+get_config_lines2(_Fd, _NewLine, _CurrLine, [], R) ->
+    lists:reverse(R);
+get_config_lines2(Fd, Data, CurrLine, [NextWanted | LNumbers], R) when is_list(Data) ->
+    NextL = io:get_line(Fd, no_prompt),
+    if
+	CurrLine >= NextWanted ->
+	    Line2 = [integer_to_list(CurrLine), ": " | Data],
+	    get_config_lines2(Fd, NextL, CurrLine+1, LNumbers, [Line2 | R]);
+	true ->
+	    get_config_lines2(Fd, NextL, CurrLine+1, [NextWanted | LNumbers], R)
+    end.
+
+%% If ejabberd isn't yet running in this node, then halt the node
+exit_or_halt(ExitText) ->
+    case [Vsn || {ejabberd, _Desc, Vsn} <- application:which_applications()] of
+	[] ->
+	    timer:sleep(1000),
+	    halt(ExitText);
+	[_] ->
+	    exit(ExitText)
+    end.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%% Support for 'include_config_file'
+
+%% @doc Include additional configuration files in the list of terms.
+%% @spec ([term()]) -> [term()]
+include_config_files(Terms) ->
+    include_config_files(Terms, []).
+
+include_config_files([], Res) ->
+    Res;
+include_config_files([{include_config_file, Filename} | Terms], Res) ->
+    include_config_files([{include_config_file, Filename, []} | Terms], Res);
+include_config_files([{include_config_file, Filename, Options} | Terms], Res) ->
+    Included_terms = get_plain_terms_file(Filename),
+    Disallow = proplists:get_value(disallow, Options, []),
+    Included_terms2 = delete_disallowed(Disallow, Included_terms),
+    Allow_only = proplists:get_value(allow_only, Options, all),
+    Included_terms3 = keep_only_allowed(Allow_only, Included_terms2),
+    include_config_files(Terms, Res ++ Included_terms3);
+include_config_files([Term | Terms], Res) ->
+    include_config_files(Terms, Res ++ [Term]).
+
+%% @doc Filter from the list of terms the disallowed.
+%% Returns a sublist of Terms without the ones which first element is
+%% included in Disallowed.
+%% @spec (Disallowed::[atom()], Terms::[term()]) -> [term()]
+delete_disallowed(Disallowed, Terms) ->
+    lists:foldl(
+      fun(Dis, Ldis) ->
+	      delete_disallowed2(Dis, Ldis)
+      end,
+      Terms,
+      Disallowed).
+
+delete_disallowed2(Disallowed, [H|T]) ->
+    case element(1, H) of
+	Disallowed ->
+	    ?WARNING_MSG("The option '~p' is disallowed, "
+			 "and will not be accepted", [Disallowed]),
+	    delete_disallowed2(Disallowed, T);
+	_ ->
+	    [H|delete_disallowed2(Disallowed, T)]
+    end;
+delete_disallowed2(_, []) ->
+    [].
+
+%% @doc Keep from the list only the allowed terms.
+%% Returns a sublist of Terms with only the ones which first element is
+%% included in Allowed.
+%% @spec (Allowed::[atom()], Terms::[term()]) -> [term()]
+keep_only_allowed(all, Terms) ->
+    Terms;
+keep_only_allowed(Allowed, Terms) ->
+    {As, NAs} = lists:partition(
+		  fun(Term) ->
+			  lists:member(element(1, Term), Allowed)
+		  end,
+		  Terms),
+    [?WARNING_MSG("This option is not allowed, "
+		  "and will not be accepted:~n~p", [NA])
+     || NA <- NAs],
+    As.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%% Support for Macro
+
+%% @doc Replace the macros with their defined values.
+%% @spec (Terms::[term()]) -> [term()]
+replace_macros(Terms) ->
+    {TermsOthers, Macros} = split_terms_macros(Terms),
+    replace(TermsOthers, Macros).
+
+%% @doc Split Terms into normal terms and macro definitions.
+%% @spec (Terms) -> {Terms, Macros}
+%%       Terms = [term()]
+%%       Macros = [macro()]
+split_terms_macros(Terms) ->
+    lists:foldl(
+      fun(Term, {TOs, Ms}) ->
+	      case Term of
+		  {define_macro, Key, Value} -> 
+		      case is_atom(Key) and is_all_uppercase(Key) of
+			  true -> 
+			      {TOs, Ms++[{Key, Value}]};
+			  false -> 
+			      exit({macro_not_properly_defined, Term})
+		      end;
+		  Term ->
+		      {TOs ++ [Term], Ms}
+	      end
+      end,
+      {[], []},
+      Terms).
+
+%% @doc Recursively replace in Terms macro usages with the defined value.
+%% @spec (Terms, Macros) -> Terms
+%%       Terms = [term()]
+%%       Macros = [macro()]
+replace([], _) ->
+    [];
+replace([Term|Terms], Macros) ->
+    [replace_term(Term, Macros) | replace(Terms, Macros)].
+
+replace_term(Key, Macros) when is_atom(Key) ->
+    case is_all_uppercase(Key) of
+	true ->
+	    case proplists:get_value(Key, Macros) of
+		undefined -> exit({undefined_macro, Key});
+		Value -> Value
+	    end;
+	false ->
+	    Key
+    end;
+replace_term({use_macro, Key, Value}, Macros) ->
+    proplists:get_value(Key, Macros, Value);
+replace_term(Term, Macros) when is_list(Term) ->
+    replace(Term, Macros);
+replace_term(Term, Macros) when is_tuple(Term) ->
+    List = tuple_to_list(Term),
+    List2 = replace(List, Macros),
+    list_to_tuple(List2);
+replace_term(Term, _) ->
+    Term.
+
+is_all_uppercase(Atom) ->
+    String = erlang:atom_to_list(Atom),
+    lists:all(fun(C) when C >= $a, C =< $z -> false;
+		 (_) -> true
+	      end, String).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%% Process terms
+
 process_term(Term, State) ->
     case Term of
 	override_global ->
@@ -90,31 +362,83 @@ process_term(Term, State) ->
 	    State#state{override_local = true};
 	override_acls ->
 	    State#state{override_acls = true};
-	{acl, ACLName, ACLData} ->
+	{acl, _ACLName, _ACLData} ->
 	    process_host_term(Term, global, State);
-	{access, RuleName, Rules} ->
+	{access, _RuleName, _Rules} ->
 	    process_host_term(Term, global, State);
-	{shaper, Name, Data} ->
-	    lists:foldl(fun(Host, S) -> process_host_term(Term, Host, S) end,
-			State, State#state.hosts);
-	{host, Host} ->
+	{shaper, _Name, _Data} ->
+	    %%lists:foldl(fun(Host, S) -> process_host_term(Term, Host, S) end,
+	    %%    	State, State#state.hosts);
+	    process_host_term(Term, global, State);
+	{host, _Host} ->
 	    State;
-	{hosts, Hosts} ->
+	{hosts, _Hosts} ->
 	    State;
 	{host_config, Host, Terms} ->
 	    lists:foldl(fun(T, S) -> process_host_term(T, Host, S) end,
 			State, Terms);
-	{listen, Val} ->
-	    add_option(listen, Val, State);
+	{listen, Listeners} ->
+	    Listeners2 =
+		lists:map(
+		  fun({PortIP, Module, Opts}) ->
+			  {Port, IPT, _, _, Proto, OptsClean} =
+			      ejabberd_listener:parse_listener_portip(PortIP, Opts),
+			  {{Port, IPT, Proto}, Module, OptsClean}
+		  end,
+		  Listeners),
+	    add_option(listen, Listeners2, State);
+	{language, Val} ->
+	    add_option(language, Val, State);
 	{outgoing_s2s_port, Port} ->
 	    add_option(outgoing_s2s_port, Port, State);
+	{outgoing_s2s_options, Methods, Timeout} ->
+	    add_option(outgoing_s2s_options, {Methods, Timeout}, State);
+        {s2s_dns_options, PropList} ->
+            add_option(s2s_dns_options, PropList, State);
 	{s2s_use_starttls, Port} ->
 	    add_option(s2s_use_starttls, Port, State);
 	{s2s_certfile, CertFile} ->
-	    add_option(s2s_certfile, CertFile, State);
+	    case ejabberd_config:is_file_readable(CertFile) of
+		true -> add_option(s2s_certfile, CertFile, State);
+		false ->
+		    ErrorText = "There is a problem in the configuration: "
+			"the specified file is not readable: ",
+		    throw({error, ErrorText ++ CertFile})
+	    end;
 	{domain_certfile, Domain, CertFile} ->
-	    add_option({domain_certfile, Domain}, CertFile, State);
-	{Opt, Val} ->
+	    case ejabberd_config:is_file_readable(CertFile) of
+		true -> add_option({domain_certfile, Domain}, CertFile, State);
+		false ->
+		    ErrorText = "There is a problem in the configuration: "
+			"the specified file is not readable: ",
+		    throw({error, ErrorText ++ CertFile})
+	    end;
+	{node_type, NodeType} ->
+	    add_option(node_type, NodeType, State);
+	{cluster_nodes, Nodes} ->
+	    add_option(cluster_nodes, Nodes, State);
+	{domain_balancing, Domain, Balancing} ->
+	    add_option({domain_balancing, Domain}, Balancing, State);
+	{domain_balancing_component_number, Domain, N} ->
+	    add_option({domain_balancing_component_number, Domain}, N, State);
+	{watchdog_admins, Admins} ->
+	    add_option(watchdog_admins, Admins, State);
+	{watchdog_large_heap, LH} ->
+	    add_option(watchdog_large_heap, LH, State);
+	{registration_timeout, Timeout} ->
+	    add_option(registration_timeout, Timeout, State);
+	{captcha_cmd, Cmd} ->
+	    add_option(captcha_cmd, Cmd, State);
+	{captcha_host, Host} ->
+	    add_option(captcha_host, Host, State);
+	{ejabberdctl_access_commands, ACs} ->
+	    add_option(ejabberdctl_access_commands, ACs, State);
+	{loglevel, Loglevel} ->
+	    ejabberd_loglevel:set(Loglevel),
+	    State;
+	{max_fsm_queue, N} ->
+	    add_option(max_fsm_queue, N, State);
+	{_Opt, _Val} ->
 	    lists:foldl(fun(Host, S) -> process_host_term(Term, Host, S) end,
 			State, State#state.hosts)
     end.
@@ -123,7 +447,7 @@ process_host_term(Term, Host, State) ->
     case Term of
 	{acl, ACLName, ACLData} ->
 	    State#state{opts =
-		   [acl:to_record(Host, ACLName, ACLData) | State#state.opts]};
+			[acl:to_record(Host, ACLName, ACLData) | State#state.opts]};
 	{access, RuleName, Rules} ->
 	    State#state{opts = [#config{key = {access, RuleName, Host},
 					value = Rules} |
@@ -134,8 +458,10 @@ process_host_term(Term, Host, State) ->
 				State#state.opts]};
 	{host, Host} ->
 	    State;
-	{hosts, Hosts} ->
+	{hosts, _Hosts} ->
 	    State;
+	{odbc_server, ODBC_server} ->
+	    add_option({odbc_server, Host}, ODBC_server, State);
 	{Opt, Val} ->
 	    add_option({Opt, Host}, Val, State)
     end.
@@ -154,8 +480,31 @@ add_option(Opt, Val, State) ->
 	    State#state{opts = [#config{key = Opt, value = Val} |
 				State#state.opts]};
 	local_config ->
-	    State#state{opts = [#local_config{key = Opt, value = Val} |
-				State#state.opts]}
+	    case Opt of
+		{{add, OptName}, Host} ->
+		    State#state{opts = compact({OptName, Host}, Val,
+					       State#state.opts, [])};
+		_ ->
+		    State#state{opts = [#local_config{key = Opt, value = Val} |
+					State#state.opts]}
+	    end
+    end.
+
+compact({OptName, Host} = Opt, Val, [], Os) ->
+    ?WARNING_MSG("The option '~p' is defined for the host ~p using host_config "
+    "before the global '~p' option. This host_config option may get overwritten.", [OptName, Host, OptName]),
+    [#local_config{key = Opt, value = Val}] ++ Os;
+%% Traverse the list of the options already parsed
+compact(Opt, Val, [O | Os1], Os2) ->
+    case catch O#local_config.key of
+	%% If the key of a local_config matches the Opt that wants to be added
+	Opt ->
+	    %% Then prepend the new value to the list of old values
+	    Os2 ++ [#local_config{key = Opt,
+				  value = Val++O#local_config.value}
+		   ] ++ Os1;
+	_ ->
+	    compact(Opt, Val, Os1, Os2++[O])
     end.
 
 
@@ -193,7 +542,20 @@ set_opts(State) ->
 				      mnesia:write(R)
 			      end, Opts)
 	end,
-    {atomic, _} = mnesia:transaction(F).
+    case mnesia:transaction(F) of
+	{atomic, _} -> ok;
+	{aborted,{no_exists,Table}} ->
+	    MnesiaDirectory = mnesia:system_info(directory),
+	    ?ERROR_MSG("Error reading Mnesia database spool files:~n"
+		       "The Mnesia database couldn't read the spool file for the table '~p'.~n"
+		       "ejabberd needs read and write access in the directory:~n   ~s~n"
+		       "Maybe the problem is a change in the computer hostname,~n"
+		       "or a change in the Erlang node name, which is currently:~n   ~p~n"
+		       "Check the ejabberd guide for details about changing the~n"
+		       "computer hostname or Erlang node name.~n",
+		       [Table, MnesiaDirectory, node()]),
+	    exit("Error reading Mnesia database")
+    end.
 
 
 add_global_option(Opt, Val) ->
@@ -225,4 +587,21 @@ get_local_option(Opt) ->
 	    undefined
     end.
 
+%% Return the list of hosts handled by a given module
+get_vh_by_auth_method(AuthMethod) ->
+    mnesia:dirty_select(local_config,
+			[{#local_config{key = {auth_method, '$1'},
+					value=AuthMethod},[],['$1']}]).
 
+%% @spec (Path::string()) -> true | false
+is_file_readable(Path) ->
+    case file:read_file_info(Path) of
+	{ok, FileInfo} ->
+	    case {FileInfo#file_info.type, FileInfo#file_info.access} of
+		{regular, read} -> true;
+		{regular, read_write} -> true;
+		_ -> false
+	    end;
+	{error, _Reason} ->
+	    false
+    end.

src/ejabberd_config.hrl

@@ -0,0 +1,28 @@
+%%%----------------------------------------------------------------------
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%----------------------------------------------------------------------
+
+-record(config, {key, value}).
+-record(local_config, {key, value}).
+-record(state, {opts = [],
+		hosts = [],
+		override_local = false,
+		override_global = false,
+		override_acls = false}).

src/ejabberd_ctl.hrl

@@ -1,9 +1,22 @@
 %%%----------------------------------------------------------------------
-%%% File    : ejabberd_ctl.hrl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
-%%% Purpose : 
-%%% Created : 13 Feb 2006 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -define(STATUS_SUCCESS, 0).

src/ejabberd_frontend_socket.erl

@@ -0,0 +1,327 @@
+%%%-------------------------------------------------------------------
+%%% File    : ejabberd_frontend_socket.erl
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
+%%% Purpose : Frontend socket with zlib and TLS support library
+%%% Created : 23 Aug 2006 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%----------------------------------------------------------------------
+
+-module(ejabberd_frontend_socket).
+-author('alexey@process-one.net').
+
+-behaviour(gen_server).
+
+%% API
+-export([start/4,
+	 start_link/5,
+	 %connect/3,
+	 starttls/2,
+	 starttls/3,
+	 compress/1,
+	 compress/2,
+	 reset_stream/1,
+	 send/2,
+	 change_shaper/2,
+	 monitor/1,
+	 get_sockmod/1,
+	 get_peer_certificate/1,
+	 get_verify_result/1,
+	 close/1,
+	 sockname/1, peername/1]).
+
+%% gen_server callbacks
+-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
+	 terminate/2, code_change/3]).
+
+-record(state, {sockmod, socket, receiver}).
+
+-define(HIBERNATE_TIMEOUT, 90000).
+
+%%====================================================================
+%% API
+%%====================================================================
+%%--------------------------------------------------------------------
+%% Function: start_link() -> {ok,Pid} | ignore | {error,Error}
+%% Description: Starts the server
+%%--------------------------------------------------------------------
+start_link(Module, SockMod, Socket, Opts, Receiver) ->
+    gen_server:start_link(?MODULE,
+			  [Module, SockMod, Socket, Opts, Receiver], []).
+
+start(Module, SockMod, Socket, Opts) ->
+    case Module:socket_type() of
+	xml_stream ->
+	    MaxStanzaSize =
+		case lists:keysearch(max_stanza_size, 1, Opts) of
+		    {value, {_, Size}} -> Size;
+		    _ -> infinity
+		end,
+	    Receiver = ejabberd_receiver:start(Socket, SockMod, none, MaxStanzaSize),
+	    case SockMod:controlling_process(Socket, Receiver) of
+		ok ->
+		    ok;
+		{error, _Reason} ->
+		    SockMod:close(Socket)
+	    end,
+	    supervisor:start_child(ejabberd_frontend_socket_sup,
+				   [Module, SockMod, Socket, Opts, Receiver]);
+	raw ->
+	    %{ok, Pid} = Module:start({SockMod, Socket}, Opts),
+	    %case SockMod:controlling_process(Socket, Pid) of
+	    %    ok ->
+	    %        ok;
+	    %    {error, _Reason} ->
+	    %        SockMod:close(Socket)
+	    %end
+	    todo
+    end.
+
+starttls(FsmRef, _TLSOpts) ->
+    %% TODO: Frontend improvements planned by Aleksey
+    %%gen_server:call(FsmRef, {starttls, TLSOpts}),
+    FsmRef.
+
+starttls(FsmRef, TLSOpts, Data) ->
+    gen_server:call(FsmRef, {starttls, TLSOpts, Data}),
+    FsmRef.
+
+compress(FsmRef) ->
+    gen_server:call(FsmRef, compress),
+    FsmRef.
+
+compress(FsmRef, Data) ->
+    gen_server:call(FsmRef, {compress, Data}),
+    FsmRef.
+
+reset_stream(FsmRef) ->
+    gen_server:call(FsmRef, reset_stream).
+
+send(FsmRef, Data) ->
+    gen_server:call(FsmRef, {send, Data}).
+
+change_shaper(FsmRef, Shaper) ->
+    gen_server:call(FsmRef, {change_shaper, Shaper}).
+
+monitor(FsmRef) ->
+    erlang:monitor(process, FsmRef).
+
+get_sockmod(FsmRef) ->
+    gen_server:call(FsmRef, get_sockmod).
+
+get_peer_certificate(FsmRef) ->
+    gen_server:call(FsmRef, get_peer_certificate).
+
+get_verify_result(FsmRef) ->
+    gen_server:call(FsmRef, get_verify_result).
+
+close(FsmRef) ->
+    gen_server:call(FsmRef, close).
+
+sockname(FsmRef) ->
+    gen_server:call(FsmRef, sockname).
+
+peername(_FsmRef) ->
+    %% TODO: Frontend improvements planned by Aleksey
+    %%gen_server:call(FsmRef, peername).
+    {ok, {{0, 0, 0, 0}, 0}}.
+
+
+%%====================================================================
+%% gen_server callbacks
+%%====================================================================
+
+%%--------------------------------------------------------------------
+%% Function: init(Args) -> {ok, State} |
+%%                         {ok, State, Timeout} |
+%%                         ignore               |
+%%                         {stop, Reason}
+%% Description: Initiates the server
+%%--------------------------------------------------------------------
+init([Module, SockMod, Socket, Opts, Receiver]) ->
+    %% TODO: monitor the receiver
+    Node = ejabberd_node_groups:get_closest_node(backend),
+    {SockMod2, Socket2} = check_starttls(SockMod, Socket, Receiver, Opts),
+    {ok, Pid} =
+	rpc:call(Node, Module, start, [{?MODULE, self()}, Opts]),
+    ejabberd_receiver:become_controller(Receiver, Pid),
+    {ok, #state{sockmod = SockMod2,
+		socket = Socket2,
+		receiver = Receiver}}.
+
+%%--------------------------------------------------------------------
+%% Function: %% handle_call(Request, From, State) -> {reply, Reply, State} |
+%%                                      {reply, Reply, State, Timeout} |
+%%                                      {noreply, State} |
+%%                                      {noreply, State, Timeout} |
+%%                                      {stop, Reason, Reply, State} |
+%%                                      {stop, Reason, State}
+%% Description: Handling call messages
+%%--------------------------------------------------------------------
+handle_call({starttls, TLSOpts}, _From, State) ->
+    {ok, TLSSocket} = tls:tcp_to_tls(State#state.socket, TLSOpts),
+    ejabberd_receiver:starttls(State#state.receiver, TLSSocket),
+    Reply = ok,
+    {reply, Reply, State#state{socket = TLSSocket, sockmod = tls},
+     ?HIBERNATE_TIMEOUT};
+
+handle_call({starttls, TLSOpts, Data}, _From, State) ->
+    {ok, TLSSocket} = tls:tcp_to_tls(State#state.socket, TLSOpts),
+    ejabberd_receiver:starttls(State#state.receiver, TLSSocket),
+    catch (State#state.sockmod):send(
+	    State#state.socket, Data),
+    Reply = ok,
+    {reply, Reply, State#state{socket = TLSSocket, sockmod = tls},
+     ?HIBERNATE_TIMEOUT};
+
+handle_call(compress, _From, State) ->
+    {ok, ZlibSocket} = ejabberd_zlib:enable_zlib(
+			 State#state.sockmod,
+			 State#state.socket),
+    ejabberd_receiver:compress(State#state.receiver, ZlibSocket),
+    Reply = ok,
+    {reply, Reply, State#state{socket = ZlibSocket, sockmod = ejabberd_zlib},
+     ?HIBERNATE_TIMEOUT};
+
+handle_call({compress, Data}, _From, State) ->
+    {ok, ZlibSocket} = ejabberd_zlib:enable_zlib(
+			 State#state.sockmod,
+			 State#state.socket),
+    ejabberd_receiver:compress(State#state.receiver, ZlibSocket),
+    catch (State#state.sockmod):send(
+	    State#state.socket, Data),
+    Reply = ok,
+    {reply, Reply, State#state{socket = ZlibSocket, sockmod = ejabberd_zlib},
+     ?HIBERNATE_TIMEOUT};
+
+handle_call(reset_stream, _From, State) ->
+    ejabberd_receiver:reset_stream(State#state.receiver),
+    Reply = ok,
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT};
+
+handle_call({send, Data}, _From, State) ->
+    catch (State#state.sockmod):send(
+	    State#state.socket, Data),
+    Reply = ok,
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT};
+
+handle_call({change_shaper, Shaper}, _From, State) ->
+    ejabberd_receiver:change_shaper(State#state.receiver, Shaper),
+    Reply = ok,
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT};
+
+handle_call(get_sockmod, _From, State) ->
+    Reply = State#state.sockmod,
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT};
+
+handle_call(get_peer_certificate, _From, State) ->
+    Reply = tls:get_peer_certificate(State#state.socket),
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT};
+
+handle_call(get_verify_result, _From, State) ->
+    Reply = tls:get_verify_result(State#state.socket),
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT};
+
+handle_call(close, _From, State) ->
+    ejabberd_receiver:close(State#state.receiver),
+    Reply = ok,
+    {stop, normal, Reply, State};
+
+handle_call(sockname, _From, State) ->
+    #state{sockmod = SockMod, socket = Socket} = State,
+    Reply =
+	case SockMod of
+	    gen_tcp ->
+		inet:sockname(Socket);
+	    _ ->
+		SockMod:sockname(Socket)
+	end,
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT};
+
+handle_call(peername, _From, State) ->
+    #state{sockmod = SockMod, socket = Socket} = State,
+    Reply =
+	case SockMod of
+	    gen_tcp ->
+		inet:peername(Socket);
+	    _ ->
+		SockMod:peername(Socket)
+	end,
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT};
+
+handle_call(_Request, _From, State) ->
+    Reply = ok,
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT}.
+
+%%--------------------------------------------------------------------
+%% Function: handle_cast(Msg, State) -> {noreply, State} |
+%%                                      {noreply, State, Timeout} |
+%%                                      {stop, Reason, State}
+%% Description: Handling cast messages
+%%--------------------------------------------------------------------
+handle_cast(_Msg, State) ->
+    {noreply, State, ?HIBERNATE_TIMEOUT}.
+
+%%--------------------------------------------------------------------
+%% Function: handle_info(Info, State) -> {noreply, State} |
+%%                                       {noreply, State, Timeout} |
+%%                                       {stop, Reason, State}
+%% Description: Handling all non call/cast messages
+%%--------------------------------------------------------------------
+handle_info(timeout, State) ->
+    proc_lib:hibernate(gen_server, enter_loop, [?MODULE, [], State]),
+    {noreply, State, ?HIBERNATE_TIMEOUT};
+handle_info(_Info, State) ->
+    {noreply, State, ?HIBERNATE_TIMEOUT}.
+
+%%--------------------------------------------------------------------
+%% Function: terminate(Reason, State) -> void()
+%% Description: This function is called by a gen_server when it is about to
+%% terminate. It should be the opposite of Module:init/1 and do any necessary
+%% cleaning up. When it returns, the gen_server terminates with Reason.
+%% The return value is ignored.
+%%--------------------------------------------------------------------
+terminate(_Reason, _State) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% Func: code_change(OldVsn, State, Extra) -> {ok, NewState}
+%% Description: Convert process state when code is changed
+%%--------------------------------------------------------------------
+code_change(_OldVsn, State, _Extra) ->
+    {ok, State}.
+
+%%--------------------------------------------------------------------
+%%% Internal functions
+%%--------------------------------------------------------------------
+check_starttls(SockMod, Socket, Receiver, Opts) ->
+    TLSEnabled = lists:member(tls, Opts),
+    TLSOpts = lists:filter(fun({certfile, _}) -> true;
+			      (_) -> false
+			   end, Opts),
+    if
+	TLSEnabled ->
+	    {ok, TLSSocket} = tls:tcp_to_tls(Socket, TLSOpts),
+	    ejabberd_receiver:starttls(Receiver, TLSSocket),
+	    {tls, TLSSocket};
+	true ->
+	    {SockMod, Socket}
+    end.
+

src/ejabberd_hooks.erl

@@ -1,24 +1,48 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_hooks.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : Manage hooks
-%%% Created :  8 Aug 2004 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created :  8 Aug 2004 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_hooks).
--author('alexey@sevcom.net').
+-author('alexey@process-one.net').
 
 -behaviour(gen_server).
 
 %% External exports
 -export([start_link/0,
+	 add/3,
 	 add/4,
+	 add_dist/5,
+	 delete/3,
 	 delete/4,
+	 delete_dist/5,
 	 run/2,
 	 run_fold/3,
 	 add/5,
+	 add_dist/6,
 	 delete/5,
+	 delete_dist/6,
 	 run/3,
 	 run_fold/4]).
 
@@ -32,6 +56,9 @@
 
 -include("ejabberd.hrl").
 
+%% Timeout of 5 seconds in calls to distributed hooks
+-define(TIMEOUT_DISTRIBUTED_HOOK, 5000).
+
 -record(state, {}).
 
 %%%----------------------------------------------------------------------
@@ -40,18 +67,55 @@
 start_link() ->
     gen_server:start_link({local, ejabberd_hooks}, ejabberd_hooks, [], []).
 
+%% @spec (Hook::atom(), Function::function(), Seq::integer()) -> ok
+%% @doc See add/4.
+add(Hook, Function, Seq) when is_function(Function) ->
+    add(Hook, global, undefined, Function, Seq).
+
+add(Hook, Host, Function, Seq) when is_function(Function) ->
+    add(Hook, Host, undefined, Function, Seq);
+
+%% @spec (Hook::atom(), Module::atom(), Function::atom(), Seq::integer()) -> ok
+%% @doc Add a module and function to this hook.
+%% The integer sequence is used to sort the calls: low number is called before high number.
 add(Hook, Module, Function, Seq) ->
     add(Hook, global, Module, Function, Seq).
 
 add(Hook, Host, Module, Function, Seq) ->
     gen_server:call(ejabberd_hooks, {add, Hook, Host, Module, Function, Seq}).
 
+add_dist(Hook, Node, Module, Function, Seq) ->
+    gen_server:call(ejabberd_hooks, {add, Hook, global, Node, Module, Function, Seq}).
+
+add_dist(Hook, Host, Node, Module, Function, Seq) ->
+    gen_server:call(ejabberd_hooks, {add, Hook, Host, Node, Module, Function, Seq}).
+
+%% @spec (Hook::atom(), Function::function(), Seq::integer()) -> ok
+%% @doc See del/4.
+delete(Hook, Function, Seq) when is_function(Function) ->
+    delete(Hook, global, undefined, Function, Seq).
+
+delete(Hook, Host, Function, Seq) when is_function(Function) ->
+    delete(Hook, Host, undefined, Function, Seq);
+
+%% @spec (Hook::atom(), Module::atom(), Function::atom(), Seq::integer()) -> ok
+%% @doc Delete a module and function from this hook.
+%% It is important to indicate exactly the same information than when the call was added.
 delete(Hook, Module, Function, Seq) ->
     delete(Hook, global, Module, Function, Seq).
 
 delete(Hook, Host, Module, Function, Seq) ->
     gen_server:call(ejabberd_hooks, {delete, Hook, Host, Module, Function, Seq}).
 
+delete_dist(Hook, Node, Module, Function, Seq) ->
+    delete_dist(Hook, global, Node, Module, Function, Seq).
+
+delete_dist(Hook, Host, Node, Module, Function, Seq) ->
+    gen_server:call(ejabberd_hooks, {delete, Hook, Host, Node, Module, Function, Seq}).
+
+%% @spec (Hook::atom(), Args) -> ok
+%% @doc Run the calls of this hook in order, don't care about function results.
+%% If a call returns stop, no more calls are performed.
 run(Hook, Args) ->
     run(Hook, global, Args).
 
@@ -63,6 +127,12 @@ run(Hook, Host, Args) ->
 	    ok
     end.
 
+%% @spec (Hook::atom(), Val, Args) -> Val | stopped | NewVal
+%% @doc Run the calls of this hook in order.
+%% The arguments passed to the function are: [Val | Args].
+%% The result of a call is used as Val for the next call.
+%% If a call returns 'stop', no more calls are performed and 'stopped' is returned.
+%% If a call returns {stopped, NewVal}, no more calls are performed and NewVal is returned.
 run_fold(Hook, Val, Args) ->
     run_fold(Hook, global, Val, Args).
 
@@ -98,7 +168,7 @@ init([]) ->
 %%          {stop, Reason, Reply, State}   | (terminate/2 is called)
 %%          {stop, Reason, State}            (terminate/2 is called)
 %%----------------------------------------------------------------------
-handle_call({add, Hook, Host, Module, Function, Seq}, From, State) ->
+handle_call({add, Hook, Host, Module, Function, Seq}, _From, State) ->
     Reply = case ets:lookup(hooks, {Hook, Host}) of
 		[{_, Ls}] ->
 		    El = {Seq, Module, Function},
@@ -116,7 +186,25 @@ handle_call({add, Hook, Host, Module, Function, Seq}, From, State) ->
 		    ok
 	    end,
     {reply, Reply, State};
-handle_call({delete, Hook, Host, Module, Function, Seq}, From, State) ->
+handle_call({add, Hook, Host, Node, Module, Function, Seq}, _From, State) ->
+    Reply = case ets:lookup(hooks, {Hook, Host}) of
+		[{_, Ls}] ->
+		    El = {Seq, Node, Module, Function},
+		    case lists:member(El, Ls) of
+			true ->
+			    ok;
+			false ->
+			    NewLs = lists:merge(Ls, [El]),
+			    ets:insert(hooks, {{Hook, Host}, NewLs}),
+			    ok
+		    end;
+		[] ->
+		    NewLs = [{Seq, Node, Module, Function}],
+		    ets:insert(hooks, {{Hook, Host}, NewLs}),
+		    ok
+	    end,
+    {reply, Reply, State};
+handle_call({delete, Hook, Host, Module, Function, Seq}, _From, State) ->
     Reply = case ets:lookup(hooks, {Hook, Host}) of
 		[{_, Ls}] ->
 		    NewLs = lists:delete({Seq, Module, Function}, Ls),
@@ -126,7 +214,17 @@ handle_call({delete, Hook, Host, Module, Function, Seq}, From, State) ->
 		    ok
 	    end,
     {reply, Reply, State};
-handle_call(Request, From, State) ->
+handle_call({delete, Hook, Host, Node, Module, Function, Seq}, _From, State) ->
+    Reply = case ets:lookup(hooks, {Hook, Host}) of
+		[{_, Ls}] ->
+		    NewLs = lists:delete({Seq, Node, Module, Function}, Ls),
+		    ets:insert(hooks, {{Hook, Host}, NewLs}),
+		    ok;
+		[] ->
+		    ok
+	    end,
+    {reply, Reply, State};
+handle_call(_Request, _From, State) ->
     Reply = ok,
     {reply, Reply, State}.
 
@@ -136,7 +234,7 @@ handle_call(Request, From, State) ->
 %%          {noreply, State, Timeout} |
 %%          {stop, Reason, State}            (terminate/2 is called)
 %%----------------------------------------------------------------------
-handle_cast(Msg, State) ->
+handle_cast(_Msg, State) ->
     {noreply, State}.
 
 %%----------------------------------------------------------------------
@@ -145,7 +243,7 @@ handle_cast(Msg, State) ->
 %%          {noreply, State, Timeout} |
 %%          {stop, Reason, State}            (terminate/2 is called)
 %%----------------------------------------------------------------------
-handle_info(Info, State) ->
+handle_info(_Info, State) ->
     {noreply, State}.
 
 %%----------------------------------------------------------------------
@@ -153,7 +251,7 @@ handle_info(Info, State) ->
 %% Purpose: Shutdown the server
 %% Returns: any (ignored by gen_server)
 %%----------------------------------------------------------------------
-terminate(Reason, State) ->
+terminate(_Reason, _State) ->
     ok.
 
 
@@ -164,10 +262,34 @@ code_change(_OldVsn, State, _Extra) ->
 %%% Internal functions
 %%%----------------------------------------------------------------------
 
-run1([], Hook, Args) ->
+run1([], _Hook, _Args) ->
     ok;
+run1([{_Seq, Node, Module, Function} | Ls], Hook, Args) ->
+    case rpc:call(Node, Module, Function, Args, ?TIMEOUT_DISTRIBUTED_HOOK) of
+	timeout ->
+	    ?ERROR_MSG("Timeout on RPC to ~p~nrunning hook: ~p",
+		       [Node, {Hook, Args}]),
+	    run1(Ls, Hook, Args);
+	{badrpc, Reason} ->
+	    ?ERROR_MSG("Bad RPC error to ~p: ~p~nrunning hook: ~p",
+		       [Node, Reason, {Hook, Args}]),
+	    run1(Ls, Hook, Args);
+	stop ->
+	    ?INFO_MSG("~nThe process ~p in node ~p ran a hook in node ~p.~n"
+		      "Stop.", [self(), node(), Node]), % debug code
+	    ok;
+	Res ->
+	    ?INFO_MSG("~nThe process ~p in node ~p ran a hook in node ~p.~n"
+		      "The response is:~n~s", [self(), node(), Node, Res]), % debug code
+	    run1(Ls, Hook, Args)
+    end;
 run1([{_Seq, Module, Function} | Ls], Hook, Args) ->
-    case catch apply(Module, Function, Args) of
+    Res = if is_function(Function) ->
+		  catch apply(Function, Args);
+	     true ->
+		  catch apply(Module, Function, Args)
+	  end,
+    case Res of
 	{'EXIT', Reason} ->
 	    ?ERROR_MSG("~p~nrunning hook: ~p",
 		       [Reason, {Hook, Args}]),
@@ -179,10 +301,36 @@ run1([{_Seq, Module, Function} | Ls], Hook, Args) ->
     end.
 
 
-run_fold1([], Hook, Val, Args) ->
+run_fold1([], _Hook, Val, _Args) ->
     Val;
+run_fold1([{_Seq, Node, Module, Function} | Ls], Hook, Val, Args) ->
+    case rpc:call(Node, Module, Function, [Val | Args], ?TIMEOUT_DISTRIBUTED_HOOK) of
+	{badrpc, Reason} ->
+	    ?ERROR_MSG("Bad RPC error to ~p: ~p~nrunning hook: ~p",
+		       [Node, Reason, {Hook, Args}]),
+	    run_fold1(Ls, Hook, Val, Args);
+	timeout ->
+	    ?ERROR_MSG("Timeout on RPC to ~p~nrunning hook: ~p",
+		       [Node, {Hook, Args}]),
+	    run_fold1(Ls, Hook, Val, Args);
+	stop ->
+	    stopped;
+	{stop, NewVal} ->
+	    ?INFO_MSG("~nThe process ~p in node ~p ran a hook in node ~p.~n"
+		      "Stop, and the NewVal is:~n~p", [self(), node(), Node, NewVal]), % debug code
+	    NewVal;
+	NewVal ->
+	    ?INFO_MSG("~nThe process ~p in node ~p ran a hook in node ~p.~n"
+		      "The NewVal is:~n~p", [self(), node(), Node, NewVal]), % debug code
+	    run_fold1(Ls, Hook, NewVal, Args)
+    end;
 run_fold1([{_Seq, Module, Function} | Ls], Hook, Val, Args) ->
-    case catch apply(Module, Function, [Val | Args]) of
+    Res = if is_function(Function) ->
+		  catch apply(Function, [Val | Args]);
+	     true ->
+		  catch apply(Module, Function, [Val | Args])
+	  end,
+    case Res of
 	{'EXIT', Reason} ->
 	    ?ERROR_MSG("~p~nrunning hook: ~p",
 		       [Reason, {Hook, Args}]),
@@ -194,6 +342,3 @@ run_fold1([{_Seq, Module, Function} | Ls], Hook, Val, Args) ->
 	NewVal ->
 	    run_fold1(Ls, Hook, NewVal, Args)
     end.
-
-
-

src/ejabberd_listener.erl

@@ -1,87 +1,229 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_listener.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
-%%% Purpose : 
-%%% Created : 16 Nov 2002 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
+%%% Purpose : Manage socket listener
+%%% Created : 16 Nov 2002 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_listener).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -export([start_link/0, init/1, start/3,
 	 init/3,
-	 init_ssl/4,
+	 start_listeners/0,
 	 start_listener/3,
-	 stop_listener/1,
+	 stop_listeners/0,
+	 stop_listener/2,
+	 parse_listener_portip/2,
 	 add_listener/3,
-	 delete_listener/1
+	 delete_listener/2
 	]).
 
 -include("ejabberd.hrl").
 
+%% We do not block on send anymore.
+-define(TCP_SEND_TIMEOUT, 15000).
+
 start_link() ->
     supervisor:start_link({local, ejabberd_listeners}, ?MODULE, []).
 
 
 init(_) ->
+    {ok, {{one_for_one, 10, 1}, []}}.
+
+start_listeners() ->
     case ejabberd_config:get_local_option(listen) of
 	undefined ->
 	    ignore;
 	Ls ->
-	    {ok, {{one_for_one, 10, 1},
-		  lists:map(
-		    fun({Port, Module, Opts}) ->
-			    {Port,
-			     {?MODULE, start, [Port, Module, Opts]},
-			     transient,
-			     brutal_kill,
-			     worker,
-			     [?MODULE]}
-		    end, Ls)}}
+	    Ls2 = lists:map(
+	        fun({Port, Module, Opts}) ->
+		        case start_listener(Port, Module, Opts) of
+			    {ok, _Pid} = R -> R;
+			    {error, Error} ->
+				throw(Error)
+			end
+		end, Ls),
+	    report_duplicated_portips(Ls),
+	    {ok, {{one_for_one, 10, 1}, Ls2}}
     end.
 
+report_duplicated_portips(L) ->
+    LKeys = [Port || {Port, _, _} <- L],
+    LNoDupsKeys = proplists:get_keys(L),
+    case LKeys -- LNoDupsKeys of
+	[] -> ok;
+	Dups ->
+	    ?CRITICAL_MSG("In the ejabberd configuration there are duplicated "
+			  "Port number + IP address:~n  ~p",
+			  [Dups])
+  end.
 
 start(Port, Module, Opts) ->
-    case lists:keysearch(ssl, 1, Opts) of
-	{value, {ssl, SSLOpts}} ->
-	    {ok, proc_lib:spawn_link(?MODULE, init_ssl,
-				     [Port, Module, Opts, SSLOpts])};
-	_ ->
-	    case lists:member(ssl, Opts) of
-		true ->
-		    {ok, proc_lib:spawn_link(?MODULE, init_ssl,
-					     [Port, Module, Opts, []])};
-		false ->
-		    {ok, proc_lib:spawn_link(?MODULE, init,
-					     [Port, Module, Opts])}
-	    end
+    %% Check if the module is an ejabberd listener or an independent listener
+    ModuleRaw = strip_frontend(Module),
+    case ModuleRaw:socket_type() of
+	independent -> ModuleRaw:start_listener(Port, Opts);
+	_ -> start_dependent(Port, Module, Opts)
     end.
 
-init(Port, Module, Opts) ->
+%% @spec(Port, Module, Opts) -> {ok, Pid} | {error, ErrorMessage}
+start_dependent(Port, Module, Opts) ->
+    try check_listener_options(Opts) of
+	ok ->
+	    proc_lib:start_link(?MODULE, init, [Port, Module, Opts])
+    catch
+	throw:{error, Error} ->
+	    ?ERROR_MSG(Error, []),
+	    {error, Error}
+    end.
+
+init(PortIP, Module, RawOpts) ->
+    {Port, IPT, IPS, IPV, Proto, OptsClean} = parse_listener_portip(PortIP, RawOpts),
+    %% The first inet|inet6 and the last {ip, _} work,
+    %% so overriding those in Opts
+    Opts = [IPV | OptsClean] ++ [{ip, IPT}],
     SockOpts = lists:filter(fun({ip, _}) -> true;
 			       (inet6) -> true;
 			       (inet) -> true;
+			       ({backlog, _}) -> true;
 			       (_) -> false
 			    end, Opts),
+    if Proto == udp ->
+	    init_udp(PortIP, Module, Opts, SockOpts, Port, IPS);
+       true ->
+	    init_tcp(PortIP, Module, Opts, SockOpts, Port, IPS)
+    end.
 
+init_udp(PortIP, Module, Opts, SockOpts, Port, IPS) ->
+    case gen_udp:open(Port, [binary,
+			     {active, false},
+			     {reuseaddr, true} |
+			     SockOpts]) of
+	{ok, Socket} ->
+	    %% Inform my parent that this port was opened succesfully
+	    proc_lib:init_ack({ok, self()}),
+	    udp_recv(Socket, Module, Opts);
+	{error, Reason} ->
+	    socket_error(Reason, PortIP, Module, SockOpts, Port, IPS)
+    end.
+
+init_tcp(PortIP, Module, Opts, SockOpts, Port, IPS) ->
+    SockOpts2 = try erlang:system_info(otp_release) >= "R13B" of
+		    true -> [{send_timeout_close, true} | SockOpts];
+		    false -> SockOpts
+		catch
+		    _:_ -> []
+		end,
     Res = gen_tcp:listen(Port, [binary,
-				{packet, 0}, 
+				{packet, 0},
 				{active, false},
 				{reuseaddr, true},
 				{nodelay, true},
+				{send_timeout, ?TCP_SEND_TIMEOUT},
 				{keepalive, true} |
-				SockOpts]),
+				SockOpts2]),
     case Res of
 	{ok, ListenSocket} ->
+	    %% Inform my parent that this port was opened succesfully
+	    proc_lib:init_ack({ok, self()}),
+	    %% And now start accepting connection attempts
 	    accept(ListenSocket, Module, Opts);
 	{error, Reason} ->
-	    ?ERROR_MSG("Failed to open socket for ~p: ~p",
-		       [{Port, Module, Opts}, Reason]),
-	    error
+	    socket_error(Reason, PortIP, Module, SockOpts, Port, IPS)
     end.
 
+%% @spec (PortIP, Opts) -> {Port, IPT, IPS, IPV, OptsClean}
+%% where
+%%      PortIP = Port | {Port, IPT | IPS}
+%%      Port = integer()
+%%      IPT = tuple()
+%%      IPS = string()
+%%      IPV = inet | inet6
+%%      Opts = [IPV | {ip, IPT} | atom() | tuple()]
+%%      OptsClean = [atom() | tuple()]
+%% @doc Parse any kind of ejabberd listener specification.
+%% The parsed options are returned in several formats.
+%% OptsClean does not include inet/inet6 or ip options.
+%% Opts can include the options inet6 and {ip, Tuple},
+%% but they are only used when no IP address was specified in the PortIP.
+%% The IP version (either IPv4 or IPv6) is inferred from the IP address type,
+%% so the option inet/inet6 is only used when no IP is specified at all.
+parse_listener_portip(PortIP, Opts) ->
+    {IPOpt, Opts2} = strip_ip_option(Opts),
+    {IPVOpt, OptsClean} = case lists:member(inet6, Opts2) of
+			      true -> {inet6, Opts2 -- [inet6]};
+			      false -> {inet, Opts2}
+			  end,
+    {Port, IPT, IPS, Proto} =
+	case add_proto(PortIP, Opts) of
+	    {P, Prot} ->
+		T = get_ip_tuple(IPOpt, IPVOpt),
+		S = inet_parse:ntoa(T),
+		{P, T, S, Prot};
+	    {P, T, Prot} when is_integer(P) and is_tuple(T) ->
+		S = inet_parse:ntoa(T),
+		{P, T, S, Prot};
+	    {P, S, Prot} when is_integer(P) and is_list(S) ->
+		[S | _] = string:tokens(S, "/"),
+		{ok, T} = inet_parse:address(S),
+		{P, T, S, Prot}
+	end,
+    IPV = case size(IPT) of
+	      4 -> inet;
+	      8 -> inet6
+	  end,
+    {Port, IPT, IPS, IPV, Proto, OptsClean}.
+
+add_proto(Port, Opts) when is_integer(Port) ->
+    {Port, get_proto(Opts)};
+add_proto({Port, Proto}, _Opts) when is_atom(Proto) ->
+    {Port, normalize_proto(Proto)};
+add_proto({Port, Addr}, Opts) ->
+    {Port, Addr, get_proto(Opts)};
+add_proto({Port, Addr, Proto}, _Opts) ->
+    {Port, Addr, normalize_proto(Proto)}.
+
+strip_ip_option(Opts) ->
+    {IPL, OptsNoIP} = lists:partition(
+			fun({ip, _}) -> true;
+			   (_) -> false
+			end,
+			Opts),
+    case IPL of
+	%% Only the first ip option is considered
+	[{ip, T1} | _] when is_tuple(T1) ->
+	    {T1, OptsNoIP};
+	[] ->
+	    {no_ip_option, OptsNoIP}
+    end.
+
+get_ip_tuple(no_ip_option, inet) ->
+    {0, 0, 0, 0};
+get_ip_tuple(no_ip_option, inet6) ->
+    {0, 0, 0, 0, 0, 0, 0, 0};
+get_ip_tuple(IPOpt, _IPVOpt) ->
+    IPOpt.
+
 accept(ListenSocket, Module, Opts) ->
     case gen_tcp:accept(ListenSocket) of
 	{ok, Socket} ->
@@ -92,14 +234,11 @@ accept(ListenSocket, Module, Opts) ->
 		_ ->
 		    ok
 	    end,
-	    {ok, Pid} = Module:start({gen_tcp, Socket}, Opts),
-	    case gen_tcp:controlling_process(Socket, Pid) of
-		ok ->
-		    ok;
-		{error, _Reason} ->
-		    gen_tcp:close(Socket)
-	    end,
-	    Module:become_controller(Pid),
+	    CallMod = case is_frontend(Module) of
+			  true -> ejabberd_frontend_socket;
+			  false -> ejabberd_socket
+		      end,
+	    CallMod:start(strip_frontend(Module), gen_tcp, Socket, Opts),
 	    accept(ListenSocket, Module, Opts);
 	{error, Reason} ->
 	    ?INFO_MSG("(~w) Failed TCP accept: ~w",
@@ -107,58 +246,59 @@ accept(ListenSocket, Module, Opts) ->
 	    accept(ListenSocket, Module, Opts)
     end.
 
-
-init_ssl(Port, Module, Opts, SSLOpts) ->
-    SockOpts = lists:filter(fun({ip, _}) -> true;
-			       (inet6) -> true;
-			       (inet) -> true;
-			       ({verify, _}) -> true;
-			       ({depth, _}) -> true;
-			       ({certfile, _}) -> true;
-			       ({keyfile, _}) -> true;
-			       ({password, _}) -> true;
-			       ({cacertfile, _}) -> true;
-			       ({ciphers, _}) -> true;
-			       (_) -> false
-			    end, Opts),
-    Res = ssl:listen(Port, [binary,
-			    {packet, 0}, 
-			    {active, false},
-			    {nodelay, true} |
-			    SockOpts ++ SSLOpts]),
-    case Res of
-	{ok, ListenSocket} ->
-	    accept_ssl(ListenSocket, Module, Opts);
-	{error, Reason} ->
-	    ?ERROR_MSG("Failed to open socket for ~p: ~p",
-		       [{Port, Module, Opts}, Reason]),
-	    error
-    end.
-
-accept_ssl(ListenSocket, Module, Opts) ->
-    case ssl:accept(ListenSocket, 200) of
-	{ok, Socket} ->
-	    case {ssl:sockname(Socket), ssl:peername(Socket)} of
-		{{ok, Addr}, {ok, PAddr}} ->
-		    ?INFO_MSG("(~w) Accepted SSL connection ~w -> ~w",
-			      [Socket, PAddr, Addr]);
+udp_recv(Socket, Module, Opts) ->
+    case gen_udp:recv(Socket, 0) of
+	{ok, {Addr, Port, Packet}} ->
+	    case catch Module:udp_recv(Socket, Addr, Port, Packet, Opts) of
+		{'EXIT', Reason} ->
+		    ?ERROR_MSG("failed to process UDP packet:~n"
+			       "** Source: {~p, ~p}~n"
+			       "** Reason: ~p~n** Packet: ~p",
+			       [Addr, Port, Reason, Packet]);
 		_ ->
 		    ok
 	    end,
-	    {ok, Pid} = Module:start({ssl, Socket}, Opts),
-	    catch ssl:controlling_process(Socket, Pid),
-	    Module:become_controller(Pid),
-	    accept_ssl(ListenSocket, Module, Opts);
-	{error, timeout} ->
-	    accept_ssl(ListenSocket, Module, Opts);
+	    udp_recv(Socket, Module, Opts);
 	{error, Reason} ->
-	    ?INFO_MSG("(~w) Failed SSL handshake: ~w",
-		      [ListenSocket, Reason]),
-	    accept_ssl(ListenSocket, Module, Opts)
+	    ?ERROR_MSG("unexpected UDP error: ~s", [format_error(Reason)]),
+	    throw({error, Reason})
     end.
 
-
+%% @spec (Port, Module, Opts) -> {ok, Pid} | {error, Error}
 start_listener(Port, Module, Opts) ->
+    case start_listener2(Port, Module, Opts) of
+	{ok, _Pid} = R -> R;
+	{error, {{'EXIT', {undef, [{M, _F, _A}|_]}}, _} = Error} ->
+	    ?ERROR_MSG("Error starting the ejabberd listener: ~p.~n"
+		       "It could not be loaded or is not an ejabberd listener.~n"
+		       "Error: ~p~n", [Module, Error]),
+	    {error, {module_not_available, M}};
+	{error, {already_started, Pid}} ->
+	    {ok, Pid};
+	{error, Error} ->
+	    {error, Error}
+    end.
+
+%% @spec (Port, Module, Opts) -> {ok, Pid} | {error, Error}
+start_listener2(Port, Module, Opts) ->
+    %% It is only required to start the supervisor in some cases.
+    %% But it doesn't hurt to attempt to start it for any listener.
+    %% So, it's normal (and harmless) that in most cases this call returns: {error, {already_started, pid()}}
+    start_module_sup(Port, Module),
+    start_listener_sup(Port, Module, Opts).
+
+start_module_sup(_Port, Module) ->
+    Proc1 = gen_mod:get_module_proc("sup", Module),
+    ChildSpec1 =
+	{Proc1,
+	 {ejabberd_tmp_sup, start_link, [Proc1, strip_frontend(Module)]},
+	 permanent,
+	 infinity,
+	 supervisor,
+	 [ejabberd_tmp_sup]},
+    supervisor:start_child(ejabberd_sup, ChildSpec1).
+
+start_listener_sup(Port, Module, Opts) ->
     ChildSpec = {Port,
 		 {?MODULE, start, [Port, Module, Opts]},
 		 transient,
@@ -167,30 +307,167 @@ start_listener(Port, Module, Opts) ->
 		 [?MODULE]},
     supervisor:start_child(ejabberd_listeners, ChildSpec).
 
-stop_listener(Port) ->
-    supervisor:terminate_child(ejabberd_listeners, Port),
-    supervisor:delete_child(ejabberd_listeners, Port).
+stop_listeners() ->
+    Ports = ejabberd_config:get_local_option(listen),
+    lists:foreach(
+      fun({PortIpNetp, Module, _Opts}) ->
+	      delete_listener(PortIpNetp, Module)
+      end,
+      Ports).
 
-add_listener(Port, Module, Opts) ->
+%% @spec (PortIP, Module) -> ok
+%% where
+%%      PortIP = {Port, IPT | IPS}
+%%      Port = integer()
+%%      IPT = tuple()
+%%      IPS = string()
+%%      Module = atom()
+stop_listener(PortIP, _Module) ->
+    supervisor:terminate_child(ejabberd_listeners, PortIP),
+    supervisor:delete_child(ejabberd_listeners, PortIP).
+
+%% @spec (PortIP, Module, Opts) -> {ok, Pid} | {error, Error}
+%% where
+%%      PortIP = {Port, IPT | IPS}
+%%      Port = integer()
+%%      IPT = tuple()
+%%      IPS = string()
+%%      IPV = inet | inet6
+%%      Module = atom()
+%%      Opts = [IPV | {ip, IPT} | atom() | tuple()]
+%% @doc Add a listener and store in config if success
+add_listener(PortIP, Module, Opts) ->
+    {Port, IPT, _, _, Proto, _} = parse_listener_portip(PortIP, Opts),
+    PortIP1 = {Port, IPT, Proto},
+    case start_listener(PortIP1, Module, Opts) of
+	{ok, _Pid} ->
+	    Ports = case ejabberd_config:get_local_option(listen) of
+			undefined ->
+			    [];
+			Ls ->
+			    Ls
+		    end,
+	    Ports1 = lists:keydelete(PortIP1, 1, Ports),
+	    Ports2 = [{PortIP1, Module, Opts} | Ports1],
+	    ejabberd_config:add_local_option(listen, Ports2),
+	    ok;
+	{error, {already_started, _Pid}} ->
+	    {error, {already_started, PortIP}};
+	{error, Error} ->
+	    {error, Error}
+    end.
+
+delete_listener(PortIP, Module) ->
+    delete_listener(PortIP, Module, []).
+
+%% @spec (PortIP, Module, Opts) -> ok
+%% where
+%%      PortIP = {Port, IPT | IPS}
+%%      Port = integer()
+%%      IPT = tuple()
+%%      IPS = string()
+%%      Module = atom()
+%%      Opts = [term()]
+delete_listener(PortIP, Module, Opts) ->
+    {Port, IPT, _, _, Proto, _} = parse_listener_portip(PortIP, Opts),
+    PortIP1 = {Port, IPT, Proto},
     Ports = case ejabberd_config:get_local_option(listen) of
 		undefined ->
 		    [];
 		Ls ->
 		    Ls
 	    end,
-    Ports1 = lists:keydelete(Port, 1, Ports),
-    Ports2 = [{Port, Module, Opts} | Ports1],
-    ejabberd_config:add_local_option(listen, Ports2),
-    start_listener(Port, Module, Opts).
-
-delete_listener(Port) ->
-    Ports = case ejabberd_config:get_local_option(listen) of
-		undefined ->
-		    [];
-		Ls ->
-		    Ls
-	    end,
-    Ports1 = lists:keydelete(Port, 1, Ports),
+    Ports1 = lists:keydelete(PortIP1, 1, Ports),
     ejabberd_config:add_local_option(listen, Ports1),
-    stop_listener(Port).
+    stop_listener(PortIP1, Module).
 
+is_frontend({frontend, _Module}) -> true;
+is_frontend(_) -> false.
+
+%% @doc(FrontMod) -> atom()
+%% where FrontMod = atom() | {frontend, atom()}
+strip_frontend({frontend, Module}) -> Module;
+strip_frontend(Module) when is_atom(Module) -> Module.
+
+
+%%%
+%%% Check options
+%%%
+
+check_listener_options(Opts) ->
+    case includes_deprecated_ssl_option(Opts) of
+	false -> ok;
+	true ->
+	    Error = "There is a problem with your ejabberd configuration file: "
+		"the option 'ssl' for listening sockets is no longer available."
+		" To get SSL encryption use the option 'tls'.",
+	    throw({error, Error})
+    end,
+    case certfile_readable(Opts) of
+	true -> ok;
+	{false, Path} ->
+            ErrorText = "There is a problem in the configuration: "
+		"the specified file is not readable: ",
+	    throw({error, ErrorText ++ Path})
+    end,
+    ok.
+
+%% Parse the options of the socket,
+%% and return if the deprecated option 'ssl' is included
+%% @spec (Opts) -> true | false
+includes_deprecated_ssl_option(Opts) ->
+    case lists:keysearch(ssl, 1, Opts) of
+	{value, {ssl, _SSLOpts}} ->
+	    true;
+	_ ->
+	    lists:member(ssl, Opts)
+    end.
+
+%% @spec (Opts) -> true | {false, Path::string()}
+certfile_readable(Opts) ->
+    case proplists:lookup(certfile, Opts) of
+	none -> true;
+	{certfile, Path} ->
+	    case ejabberd_config:is_file_readable(Path) of
+		true -> true;
+		false -> {false, Path}
+	    end
+    end.
+
+get_proto(Opts) ->
+    case proplists:get_value(proto, Opts) of
+	undefined ->
+	    tcp;
+	Proto ->
+	    normalize_proto(Proto)
+    end.
+
+normalize_proto(tcp) -> tcp;
+normalize_proto(udp) -> udp;
+normalize_proto(UnknownProto) ->
+    ?WARNING_MSG("There is a problem in the configuration: "
+		 "~p is an unknown IP protocol. Using tcp as fallback",
+		 [UnknownProto]),
+    tcp.
+
+socket_error(Reason, PortIP, Module, SockOpts, Port, IPS) ->
+    ReasonT = case Reason of
+		  eaddrnotavail ->
+		      "IP address not available: " ++ IPS;
+		  eaddrinuse ->
+		      "IP address and port number already used: "
+			  ++IPS++" "++integer_to_list(Port);
+		  _ ->
+		      format_error(Reason)
+	      end,
+    ?ERROR_MSG("Failed to open socket:~n  ~p~nReason: ~s",
+	       [{Port, Module, SockOpts}, ReasonT]),
+    throw({Reason, PortIP}).
+
+format_error(Reason) ->
+    case inet:format_error(Reason) of
+	"unknown POSIX error" ->
+	    atom_to_list(Reason);
+	ReasonStr ->
+	    ReasonStr
+    end.

src/ejabberd_local.erl

@@ -1,14 +1,31 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_local.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : Route local packets
-%%% Created : 30 Nov 2002 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created : 30 Nov 2002 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_local).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -behaviour(gen_server).
 
@@ -16,9 +33,13 @@
 -export([start_link/0]).
 
 -export([route/3,
+	 route_iq/4,
+	 process_iq_reply/3,
 	 register_iq_handler/4,
 	 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
 	]).
@@ -32,8 +53,13 @@
 
 -record(state, {}).
 
+-record(iq_response, {id, module, function, timer}).
+
 -define(IQTABLE, local_iqtable).
 
+%% This value is used in SIP and Megaco for a transaction lifetime.
+-define(IQ_TIMEOUT, 32000).
+
 %%====================================================================
 %% API
 %%====================================================================
@@ -68,13 +94,26 @@ process_iq(From, To, Packet) ->
 		    ejabberd_router:route(To, From, Err)
 	    end;
 	reply ->
-	    ok;
+	    IQReply = jlib:iq_query_or_response_info(Packet),
+	    process_iq_reply(From, To, IQReply);
 	_ ->
 	    Err = jlib:make_error_reply(Packet, ?ERR_BAD_REQUEST),
 	    ejabberd_router:route(To, From, Err),
 	    ok
     end.
 
+process_iq_reply(From, To, #iq{id = ID} = IQ) ->
+    case get_iq_callback(ID) of
+	{ok, undefined, Function} ->
+	    Function(IQ),
+	    ok;
+	{ok, Module, Function} ->
+	    Module:Function(From, To, IQ),
+	    ok;
+	_ ->
+	    nothing
+    end.
+
 route(From, To, Packet) ->
     case catch do_route(From, To, Packet) of
 	{'EXIT', Reason} ->
@@ -84,12 +123,34 @@ route(From, To, Packet) ->
 	    ok
     end.
 
+route_iq(From, To, #iq{type = Type} = IQ, F) when is_function(F) ->
+    Packet = if Type == set; Type == get ->
+		     ID = randoms:get_string(),
+		     Host = From#jid.lserver,
+		     register_iq_response_handler(Host, ID, undefined, F),
+		     jlib:iq_to_xml(IQ#iq{id = ID});
+		true ->
+		     jlib:iq_to_xml(IQ)
+	     end,
+    ejabberd_router:route(From, To, Packet).
+
+register_iq_response_handler(_Host, ID, Module, Function) ->
+    TRef = erlang:start_timer(?IQ_TIMEOUT, ejabberd_local, ID),
+    mnesia:dirty_write(#iq_response{id = ID,
+				    module = Module,
+				    function = Function,
+				    timer = TRef}).
+
 register_iq_handler(Host, XMLNS, Module, Fun) ->
     ejabberd_local ! {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) ->
+    catch get_iq_callback(ID),
+    ok.
+
 unregister_iq_handler(Host, XMLNS) ->
     ejabberd_local ! {unregister_iq_handler, Host, XMLNS}.
 
@@ -120,6 +181,11 @@ init([]) ->
 				 ?MODULE, bounce_resource_packet, 100)
       end, ?MYHOSTS),
     catch ets:new(?IQTABLE, [named_table, public]),
+    update_table(),
+    mnesia:create_table(iq_response,
+			[{ram_copies, [node()]},
+			 {attributes, record_info(fields, iq_response)}]),
+    mnesia:add_table_copy(iq_response, node(), ram_copies),
     {ok, #state{}}.
 
 %%--------------------------------------------------------------------
@@ -190,6 +256,9 @@ handle_info(refresh_iq_handlers, State) ->
 	      end
       end, ets:tab2list(?IQTABLE)),
     {noreply, State};
+handle_info({timeout, _TRef, ID}, State) ->
+    process_iq_timeout(ID),
+    {noreply, State};
 handle_info(_Info, State) ->
     {noreply, State}.
 
@@ -243,3 +312,52 @@ do_route(From, To, Packet) ->
 	    end
 	end.
 
+update_table() ->
+    case catch mnesia:table_info(iq_response, attributes) of
+	[id, module, function] ->
+	    mnesia:delete_table(iq_response);
+	[id, module, function, timer] ->
+	    ok;
+	{'EXIT', _} ->
+	    ok
+    end.
+
+get_iq_callback(ID) ->
+    case mnesia:dirty_read(iq_response, ID) of
+	[#iq_response{module = Module, timer = TRef,
+		      function = Function}] ->
+	    cancel_timer(TRef),
+	    mnesia:dirty_delete(iq_response, ID),
+	    {ok, Module, Function};
+	_ ->
+	    error
+    end.
+
+process_iq_timeout(ID) ->
+    spawn(fun process_iq_timeout/0) ! ID.
+
+process_iq_timeout() ->
+    receive
+	ID ->
+	    case get_iq_callback(ID) of
+		{ok, undefined, Function} ->
+		    Function(timeout);
+		_ ->
+		    ok
+	    end
+    after 5000 ->
+	    ok
+    end.
+
+cancel_timer(TRef) ->
+    case erlang:cancel_timer(TRef) of
+	false ->
+	    receive
+                {timeout, TRef, _} ->
+                    ok
+            after 0 ->
+                    ok
+            end;
+        _ ->
+            ok
+    end.

src/ejabberd_logger_h.erl

@@ -1,21 +1,37 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_logger_h.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
-%%% Purpose : 
-%%% Created : 23 Oct 2003 by Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
+%%% Purpose : Manage Erlang logging.
+%%% Created : 23 Oct 2003 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_logger_h).
--author('alexey@sevcom.net').
-
-%%-compile(export_all).
-%%-export([Function/Arity, ...]).
+-author('alexey@process-one.net').
 
 -behaviour(gen_event).
 
 %% gen_event callbacks
 -export([init/1, handle_event/2, handle_call/2, handle_info/2, terminate/2,
-	 code_change/3, reopen_log/0]).
+	 code_change/3, reopen_log/0, rotate_log/1]).
 
 -record(state, {fd, file}).
 
@@ -101,7 +117,7 @@ reopen_log() ->
 write_event(Fd, {Time, {error, _GL, {Pid, Format, Args}}}) ->
     T = write_time(Time),
     case catch io_lib:format(add_node(Format,Pid), Args) of
-	S when list(S) ->
+	S when is_list(S) ->
 	    file:write(Fd, io_lib:format(T ++ S, []));
 	_ ->
 	    F = add_node("ERROR: ~p - ~p~n", Pid),
@@ -110,7 +126,7 @@ write_event(Fd, {Time, {error, _GL, {Pid, Format, Args}}}) ->
 write_event(Fd, {Time, {emulator, _GL, Chars}}) ->
     T = write_time(Time),
     case catch io_lib:format(Chars, []) of
-	S when list(S) ->
+	S when is_list(S) ->
 	    file:write(Fd, io_lib:format(T ++ S, []));
 	_ ->
 	    file:write(Fd, io_lib:format(T ++ "ERROR: ~p ~n", [Chars]))
@@ -129,7 +145,7 @@ write_event(Fd, {Time, {info_report, _GL, {Pid, std_info, Rep}}}) ->
 write_event(Fd, {Time, {info_msg, _GL, {Pid, Format, Args}}}) ->
     T = write_time(Time, "INFO REPORT"),
     case catch io_lib:format(add_node(Format,Pid), Args) of
-	S when list(S) ->
+	S when is_list(S) ->
 	    file:write(Fd, io_lib:format(T ++ S, []));
 	_ ->
 	    F = add_node("ERROR: ~p - ~p~n", Pid),
@@ -138,7 +154,7 @@ write_event(Fd, {Time, {info_msg, _GL, {Pid, Format, Args}}}) ->
 write_event(_, _) ->
     ok.
 
-format_report(Rep) when list(Rep) ->
+format_report(Rep) when is_list(Rep) ->
     case string_p(Rep) of
 	true ->
 	    io_lib:format("~s~n",[Rep]);
@@ -155,7 +171,7 @@ format_rep([Other|Rep]) ->
 format_rep(_) ->
     [].
 
-add_node(X, Pid) when atom(X) ->
+add_node(X, Pid) when is_atom(X) ->
     add_node(atom_to_list(X), Pid);
 add_node(X, Pid) when node(Pid) /= node() ->
     lists:concat([X,"** at node ",node(Pid)," **~n"]);
@@ -167,7 +183,7 @@ string_p([]) ->
 string_p(Term) ->
     string_p1(Term).
 
-string_p1([H|T]) when integer(H), H >= $\s, H < 255 ->
+string_p1([H|T]) when is_integer(H), H >= $\s, H < 255 ->
     string_p1(T);
 string_p1([$\n|T]) -> string_p1(T);
 string_p1([$\r|T]) -> string_p1(T);
@@ -176,7 +192,7 @@ string_p1([$\v|T]) -> string_p1(T);
 string_p1([$\b|T]) -> string_p1(T);
 string_p1([$\f|T]) -> string_p1(T);
 string_p1([$\e|T]) -> string_p1(T);
-string_p1([H|T]) when list(H) ->
+string_p1([H|T]) when is_list(H) ->
     case string_p1(H) of
 	true -> string_p1(T);
 	_    -> false
@@ -190,10 +206,11 @@ write_time({{Y,Mo,D},{H,Mi,S}}, Type) ->
     io_lib:format("~n=~s==== ~w-~.2.0w-~.2.0w ~.2.0w:~.2.0w:~.2.0w ===~n",
 		  [Type, Y, Mo, D, H, Mi, S]).
 
-%% Rename the log file if it the filename exists
+%% @doc Rename the log file if exists, to "*-old.log".
 %% This is needed in systems when the file must be closed before rotation (Windows).
 %% On most Unix-like system, the file can be renamed from the command line and
-%%the log can directly be reopened.
+%% the log can directly be reopened.
+%% @spec (Filename::string()) -> ok
 rotate_log(Filename) ->
     case file:read_file_info(Filename) of
 	{ok, _FileInfo} ->

src/ejabberd_loglevel.erl

@@ -0,0 +1,128 @@
+%%%----------------------------------------------------------------------
+%%% File    : ejabberd_loglevel.erl
+%%% Author  : Mickael Remond <mremond@process-one.net>
+%%% Purpose : Loglevel switcher.
+%%%           Be careful: you should not have any ejabberd_logger module
+%%%           as ejabberd_loglevel switcher is compiling and loading
+%%%           dynamically a "virtual" ejabberd_logger module (Described
+%%%           in a string at the end of this module).
+%%% Created : 29 Nov 2006 by Mickael Remond <mremond@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%----------------------------------------------------------------------
+
+-module(ejabberd_loglevel).
+-author('mickael.remond@process-one.net').
+
+-export([set/1, get/0]).
+
+-include("ejabberd.hrl").
+
+-define(LOGMODULE, "error_logger").
+
+%% Error levels:
+-define(LOG_LEVELS,[ {0, no_log, "No log"}
+                    ,{1, critical, "Critical"}
+                    ,{2, error, "Error"}
+                    ,{3, warning, "Warning"}
+                    ,{4, info, "Info"}
+                    ,{5, debug, "Debug"}
+                    ]).
+
+get() ->
+    Level = ejabberd_logger:get(),
+    case lists:keysearch(Level, 1, ?LOG_LEVELS) of
+        {value, Result} -> Result;
+        _ -> erlang:error({no_such_loglevel, Level})
+    end.
+
+
+set(LogLevel) when is_atom(LogLevel) ->
+    set(level_to_integer(LogLevel));
+set(Loglevel) when is_integer(Loglevel) ->
+    try
+        {Mod,Code} = dynamic_compile:from_string(ejabberd_logger_src(Loglevel)),
+        code:load_binary(Mod, ?LOGMODULE ++ ".erl", Code)
+    catch
+        Type:Error -> ?CRITICAL_MSG("Error compiling logger (~p): ~p~n", [Type, Error])
+    end;
+set(_) ->
+    exit("Loglevel must be an integer").
+
+level_to_integer(Level) ->
+    case lists:keysearch(Level, 2, ?LOG_LEVELS) of
+        {value, {Int, Level, _Desc}} -> Int;
+        _ -> erlang:error({no_such_loglevel, Level})
+    end.
+
+%% --------------------------------------------------------------
+%% Code of the ejabberd logger, dynamically compiled and loaded
+%% This allows to dynamically change log level while keeping a
+%% very efficient code.
+ejabberd_logger_src(Loglevel) ->
+    L = integer_to_list(Loglevel),
+    "-module(ejabberd_logger).
+    -author('mickael.remond@process-one.net').
+
+    -export([debug_msg/4,
+             info_msg/4,
+             warning_msg/4,
+             error_msg/4,
+             critical_msg/4,
+             get/0]).
+
+   get() -> "++ L ++".
+
+    %% Helper functions
+    debug_msg(Module, Line, Format, Args) when " ++ L ++ " >= 5 ->
+            notify(info_msg,
+                   \"D(~p:~p:~p) : \"++Format++\"~n\",
+                   [self(), Module, Line]++Args);
+    debug_msg(_,_,_,_) -> ok.
+
+    info_msg(Module, Line, Format, Args) when " ++ L ++ " >= 4 ->
+            notify(info_msg,
+                   \"I(~p:~p:~p) : \"++Format++\"~n\",
+                   [self(), Module, Line]++Args);
+    info_msg(_,_,_,_) -> ok.
+
+    warning_msg(Module, Line, Format, Args) when " ++ L ++ " >= 3 ->
+            notify(error,
+                   \"W(~p:~p:~p) : \"++Format++\"~n\",
+                   [self(), Module, Line]++Args);
+    warning_msg(_,_,_,_) -> ok.
+
+    error_msg(Module, Line, Format, Args) when " ++ L ++ " >= 2 ->
+            notify(error,
+                   \"E(~p:~p:~p) : \"++Format++\"~n\",
+                   [self(), Module, Line]++Args);
+    error_msg(_,_,_,_) -> ok.
+
+    critical_msg(Module, Line, Format, Args) when " ++ L ++ " >= 1 ->
+            notify(error,
+                   \"C(~p:~p:~p) : \"++Format++\"~n\",
+                   [self(), Module, Line]++Args);
+    critical_msg(_,_,_,_) -> ok.
+
+    %% Distribute the message to the Erlang error logger
+    notify(Type, Format, Args) ->
+            LoggerMsg = {Type, group_leader(), {self(), Format, Args}},
+            gen_event:notify(error_logger, LoggerMsg).
+    ".

src/ejabberd_node_groups.erl

@@ -0,0 +1,159 @@
+%%%----------------------------------------------------------------------
+%%% File    : ejabberd_node_groups.erl
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
+%%% Purpose : Distributed named node groups based on pg2 module
+%%% Created :  1 Nov 2006 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%----------------------------------------------------------------------
+
+-module(ejabberd_node_groups).
+-author('alexey@process-one.net').
+
+-behaviour(gen_server).
+
+%% API
+-export([start_link/0,
+	 join/1,
+	 leave/1,
+	 get_members/1,
+	 get_closest_node/1]).
+
+%% gen_server callbacks
+-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
+	 terminate/2, code_change/3]).
+
+-record(state, {}).
+
+%%====================================================================
+%% API
+%%====================================================================
+%%--------------------------------------------------------------------
+%% Function: start_link() -> {ok,Pid} | ignore | {error,Error}
+%% Description: Starts the server
+%%--------------------------------------------------------------------
+start_link() ->
+    gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
+
+join(Name) ->
+    PG = {?MODULE, Name},
+    pg2:create(PG),
+    pg2:join(PG, whereis(?MODULE)).
+
+leave(Name) ->
+    PG = {?MODULE, Name},
+    pg2:leave(PG, whereis(?MODULE)).
+
+get_members(Name) ->
+    PG = {?MODULE, Name},
+    [node(P) || P <- pg2:get_members(PG)].
+
+get_closest_node(Name) ->
+    PG = {?MODULE, Name},
+    node(pg2:get_closest_pid(PG)).
+
+%%====================================================================
+%% gen_server callbacks
+%%====================================================================
+
+%%--------------------------------------------------------------------
+%% Function: init(Args) -> {ok, State} |
+%%                         {ok, State, Timeout} |
+%%                         ignore               |
+%%                         {stop, Reason}
+%% Description: Initiates the server
+%%--------------------------------------------------------------------
+init([]) ->
+    {FE, BE} =
+	case ejabberd_config:get_local_option(node_type) of
+	    frontend ->
+		{true, false};
+	    backend ->
+		{false, true};
+	    generic ->
+		{true, true};
+	    undefined ->
+		{true, true}
+	end,
+    if
+	FE ->
+	    join(frontend);
+	true ->
+	    ok
+    end,
+    if
+	BE ->
+	    join(backend);
+	true ->
+	    ok
+    end,
+    {ok, #state{}}.
+
+%%--------------------------------------------------------------------
+%% Function: %% handle_call(Request, From, State) -> {reply, Reply, State} |
+%%                                      {reply, Reply, State, Timeout} |
+%%                                      {noreply, State} |
+%%                                      {noreply, State, Timeout} |
+%%                                      {stop, Reason, Reply, State} |
+%%                                      {stop, Reason, State}
+%% Description: Handling call messages
+%%--------------------------------------------------------------------
+handle_call(_Request, _From, State) ->
+    Reply = ok,
+    {reply, Reply, State}.
+
+%%--------------------------------------------------------------------
+%% Function: handle_cast(Msg, State) -> {noreply, State} |
+%%                                      {noreply, State, Timeout} |
+%%                                      {stop, Reason, State}
+%% Description: Handling cast messages
+%%--------------------------------------------------------------------
+handle_cast(_Msg, State) ->
+    {noreply, State}.
+
+%%--------------------------------------------------------------------
+%% Function: handle_info(Info, State) -> {noreply, State} |
+%%                                       {noreply, State, Timeout} |
+%%                                       {stop, Reason, State}
+%% Description: Handling all non call/cast messages
+%%--------------------------------------------------------------------
+handle_info(_Info, State) ->
+    {noreply, State}.
+
+%%--------------------------------------------------------------------
+%% Function: terminate(Reason, State) -> void()
+%% Description: This function is called by a gen_server when it is about to
+%% terminate. It should be the opposite of Module:init/1 and do any necessary
+%% cleaning up. When it returns, the gen_server terminates with Reason.
+%% The return value is ignored.
+%%--------------------------------------------------------------------
+terminate(_Reason, _State) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% Func: code_change(OldVsn, State, Extra) -> {ok, NewState}
+%% Description: Convert process state when code is changed
+%%--------------------------------------------------------------------
+code_change(_OldVsn, State, _Extra) ->
+    {ok, State}.
+
+%%--------------------------------------------------------------------
+%%% Internal functions
+%%--------------------------------------------------------------------

src/ejabberd_piefxis.erl

@@ -0,0 +1,695 @@
+%%%----------------------------------------------------------------------
+%%% File    : ejabberd_piefxis.erl
+%%% Author  : Pablo Polvorin, Vidal Santiago Martinez
+%%% Purpose : XEP-0227: Portable Import/Export Format for XMPP-IM Servers
+%%% Created : 17 Jul 2008 by Pablo Polvorin <pablo.polvorin@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%----------------------------------------------------------------------
+
+%%% Not implemented:
+%%% - write mod_piefxis with ejabberdctl commands
+%%% - Export from mod_offline_odbc.erl
+%%% - Export from mod_private_odbc.erl
+%%% - XEP-227: 6. Security Considerations
+%%% - Other schemas of XInclude are not tested, and may not be imported correctly.
+%%% - If a host has many users, split that host in XML files with 50 users each.
+
+%%%% Headers
+
+-module(ejabberd_piefxis).
+
+-export([import_file/1, export_server/1, export_host/2]).
+
+-record(parsing_state, {parser, host, dir}).
+
+-include("ejabberd.hrl").
+
+%%-include_lib("exmpp/include/exmpp.hrl").
+%%-include_lib("exmpp/include/exmpp_client.hrl").
+%% Copied from exmpp header files:
+-define(NS_ROSTER,                   "jabber:iq:roster").
+-define(NS_VCARD,                    "vcard-temp").
+-record(xmlcdata, {
+	  cdata = <<>>
+	 }).
+-record(xmlattr, {
+	  ns = undefined,
+	  name,
+	  value
+	 }).
+-record(xmlel, {
+	  ns = undefined,
+	  declared_ns = [],
+	  name,
+	  attrs = [],
+	  children = []
+	 }).
+-record(iq, {
+	  kind,
+	  type,
+	  id,
+	  ns,
+	  payload,
+	  error,
+	  lang,
+	  iq_ns
+	 }).
+-record(xmlendtag, {
+	  ns = undefined,
+	  name
+	 }).
+
+
+%% Copied from mod_private.erl
+-record(private_storage, {usns, xml}).
+
+%%-define(ERROR_MSG(M,Args),io:format(M,Args)).
+%%-define(INFO_MSG(M,Args),ok).
+
+-define(CHUNK_SIZE,1024*20). %20k
+
+-define(BTL, binary_to_list).
+-define(LTB, list_to_binary).
+
+-define(NS_XINCLUDE, 'http://www.w3.org/2001/XInclude').
+
+%%%==================================
+
+%%%% Import file
+
+import_file(FileName) ->
+    _ = #xmlattr{}, %% this stupid line is only to prevent compilation warning about "recod xmlattr is unused"
+    import_file(FileName, 2).
+
+import_file(FileName, RootDepth) ->
+    try_start_exmpp(),
+    Dir = filename:dirname(FileName),
+    {ok, IO} = try_open_file(FileName),
+    Parser = exmpp_xml:start_parser([{max_size,infinity},
+				     {root_depth, RootDepth},
+				     {emit_endtag,true}]),
+    read_chunks(IO, #parsing_state{parser=Parser, dir=Dir}),
+    file:close(IO),
+    exmpp_xml:stop_parser(Parser).
+
+try_start_exmpp() ->
+    try exmpp:start()
+    catch
+	error:{already_started, exmpp} -> ok;
+	  error:undef -> throw({error, exmpp_not_installed})
+    end.
+
+try_open_file(FileName) ->
+    case file:open(FileName,[read,binary]) of
+	{ok, IO} -> {ok, IO};
+	{error, enoent} -> throw({error, {file_not_found, FileName}})
+    end.
+
+%%File could be large.. we read it in chunks
+read_chunks(IO,State) ->
+    case file:read(IO,?CHUNK_SIZE) of
+        {ok,Chunk} ->
+            NewState = process_chunk(Chunk,State),
+            read_chunks(IO,NewState);
+        eof ->
+            ok
+    end.
+
+process_chunk(Chunk,S =#parsing_state{parser=Parser}) ->
+    case exmpp_xml:parse(Parser,Chunk) of
+        continue ->
+            S;
+        XMLElements ->
+            process_elements(XMLElements,S)
+    end.
+
+%%%==================================
+%%%% Process Elements
+
+process_elements(Elements,State) ->
+    lists:foldl(fun process_element/2,State,Elements).
+
+%%%==================================
+%%%% Process Element
+
+process_element(El=#xmlel{name=user, ns=_XMLNS},
+		State=#parsing_state{host=Host}) ->
+    case add_user(El,Host) of
+	{error, _Other} -> error;
+	_ -> ok
+    end,
+    State;
+
+process_element(H=#xmlel{name=host},State) ->
+    State#parsing_state{host=?BTL(exmpp_xml:get_attribute(H,"jid",none))};
+
+process_element(#xmlel{name='server-data'},State) ->
+    State;
+
+process_element(El=#xmlel{name=include, ns=?NS_XINCLUDE}, State=#parsing_state{dir=Dir}) ->
+    case exmpp_xml:get_attribute(El, href, none) of
+	none ->
+	    ok;
+	HrefB ->
+	    Href = binary_to_list(HrefB),
+	    %%?INFO_MSG("Parse also this file: ~n~p", [Href]),
+	    FileName = filename:join([Dir, Href]),
+	    import_file(FileName, 1),
+	    Href
+    end,
+    State;
+
+process_element(#xmlcdata{cdata = _CData},State) ->
+    State;
+
+process_element(#xmlendtag{ns = _NS, name='server-data'},State) ->
+    State;
+
+process_element(#xmlendtag{ns = _NS, name=_Name},State) ->
+    State;
+
+process_element(El,State) ->
+    io:format("Warning!: unknown element found: ~p ~n",[El]),
+    State.
+
+%%%==================================
+%%%% Add user
+
+add_user(El, Domain) ->
+    User = exmpp_xml:get_attribute(El,name,none),
+    Password = exmpp_xml:get_attribute(El,password,none),
+    add_user(El, Domain, ?BTL(User), ?BTL(Password)).
+
+%% @spec (El::xmlel(), Domain::string(), User::string(), Password::string())
+%%       -> ok | {atomic, exists} | {error, not_allowed}
+%% @doc Add a new user to the database.
+%% If user already exists, it will be only updated.
+add_user(El, Domain, User, Password) ->
+    case create_user(User,Password,Domain) of
+	ok ->
+	    ok = exmpp_xml:foreach(
+		   fun(_,Child) ->
+			   populate_user(User,Domain,Child)
+		   end,
+		   El),
+	    ok;
+	{atomic, exists} ->
+	    io:format("Account ~s@~s already exists, updating it...~n",
+		      [User, Domain]),
+	    io:format(""),
+	    ok = exmpp_xml:foreach(
+		   fun(_,Child) ->
+			   populate_user(User,Domain,Child)
+		   end,
+		   El);
+	{error, Other} ->
+	    ?ERROR_MSG("Error adding user ~s@~s: ~p~n", [User, Domain, Other])
+    end.
+
+%% @spec (User::string(), Password::string(), Domain::string())
+%%       -> ok | {atomic, exists} | {error, not_allowed}
+%% @doc  Create a new user
+create_user(User,Password,Domain) ->
+    case ejabberd_auth:try_register(User,Domain,Password) of
+	{atomic,ok} -> ok;
+	{atomic, exists} -> {atomic, exists};
+	{error, not_allowed} -> {error, not_allowed};
+	Other -> {error, Other}
+    end.
+
+%%%==================================
+%%%% Populate user
+
+%% @spec (User::string(), Domain::string(), El::xml())
+%%      -> ok | {error, not_found}
+%%
+%% @doc  Add a new user from a XML file with a roster list.
+%%
+%% Example of a file:
+%% ```
+%% <?xml version='1.0' encoding='UTF-8'?>
+%% <server-data xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'>
+%%   <host jid='localhost'>
+%%     <user name='juliet' password='s3crEt'>
+%%       <query xmlns='jabber:iq:roster'>
+%%         <item jid='romeo@montague.net'
+%%               name='Romeo'
+%%               subscription='both'>
+%%           <group>Friends</group>
+%%         </item>
+%%       </query>
+%%     </user>
+%%   </host>
+%%  </server-data>
+%% '''
+
+populate_user(User,Domain,El=#xmlel{name='query', ns='jabber:iq:roster'}) ->
+    io:format("Trying to add/update roster list...",[]),
+    case loaded_module(Domain,[mod_roster_odbc,mod_roster]) of
+	{ok, M} ->
+	    case M:set_items(User, Domain, exmpp_xml:xmlel_to_xmlelement(El)) of
+		{atomic, ok} ->
+		    io:format(" DONE.~n",[]),
+		    ok;
+		_ ->
+		    io:format(" ERROR.~n",[]),
+		    ?ERROR_MSG("Error trying to add a new user: ~s ~n",
+			       [exmpp_xml:document_to_list(El)]),
+		    {error, not_found}
+	    end;
+	E -> io:format(" ERROR: ~p~n",[E]),
+	     ?ERROR_MSG("No modules loaded [mod_roster, mod_roster_odbc] ~s ~n",
+			[exmpp_xml:document_to_list(El)]),
+	     {error, not_found}
+    end;
+
+
+%% @spec User   = String with the user name
+%%       Domain = String with a domain name
+%%       El     = Sub XML element with vCard tags values
+%% @ret  ok | {error, not_found}
+%% @doc  Read vcards from the XML and send it to the server
+%%
+%% Example:
+%% ```
+%% <?xml version='1.0' encoding='UTF-8'?>
+%% <server-data xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'>
+%%   <host jid='localhost'>
+%%     <user name='admin' password='s3crEt'>
+%%       <vCard xmlns='vcard-temp'>
+%%         <FN>Admin</FN>
+%%       </vCard>
+%%     </user>
+%%   </host>
+%% </server-data>
+%% '''
+
+populate_user(User,Domain,El=#xmlel{name='vCard', ns='vcard-temp'}) ->
+    io:format("Trying to add/update vCards...",[]),
+    case loaded_module(Domain,[mod_vcard,mod_vcard_odbc]) of
+	{ok, M}  ->  FullUser = jid_to_old_jid(exmpp_jid:make(User, Domain)),
+		     IQ = iq_to_old_iq(#iq{type = set, payload = El}),
+		     case M:process_sm_iq(FullUser, FullUser , IQ) of
+			 {error,_Err} ->
+			     io:format(" ERROR.~n",[]),
+			     ?ERROR_MSG("Error processing vcard ~s : ~p ~n",
+					[exmpp_xml:document_to_list(El), _Err]);
+			 _ ->
+			     io:format(" DONE.~n",[]), ok
+		     end;
+	_ ->
+	    io:format(" ERROR.~n",[]),
+	    ?ERROR_MSG("No modules loaded [mod_vcard, mod_vcard_odbc] ~s ~n",
+		       [exmpp_xml:document_to_list(El)]),
+	    {error, not_found}
+    end;
+
+%% @spec User   = String with the user name
+%%       Domain = String with a domain name
+%%       El     = Sub XML element with offline messages values
+%% @ret  ok | {error, not_found}
+%% @doc  Read off-line message from the XML and send it to the server
+
+populate_user(User,Domain,El=#xmlel{name='offline-messages'}) ->
+    io:format("Trying to add/update offline-messages...",[]),
+    case loaded_module(Domain, [mod_offline, mod_offline_odbc]) of
+	{ok, M} ->
+	    ok = exmpp_xml:foreach(
+		   fun (_Element, {xmlcdata, _}) ->
+			   ok;
+		       (_Element, Child) ->
+			   From  = exmpp_xml:get_attribute(Child,from,none),
+			   FullFrom = jid_to_old_jid(exmpp_jid:parse(From)),
+			   FullUser = jid_to_old_jid(exmpp_jid:make(User,
+								    Domain)),
+			   OldChild = exmpp_xml:xmlel_to_xmlelement(Child),
+			   _R = M:store_packet(FullFrom, FullUser, OldChild)
+		   end, El), io:format(" DONE.~n",[]);
+	_ ->
+	    io:format(" ERROR.~n",[]),
+	    ?ERROR_MSG("No modules loaded [mod_offline, mod_offline_odbc] ~s ~n",
+		       [exmpp_xml:document_to_list(El)]),
+	    {error, not_found}
+    end;
+
+%% @spec User   = String with the user name
+%%       Domain = String with a domain name
+%%       El     = Sub XML element with private storage values
+%% @ret  ok | {error, not_found}
+%% @doc  Private storage parsing
+
+populate_user(User,Domain,El=#xmlel{name='query', ns='jabber:iq:private'}) ->
+    io:format("Trying to add/update private storage...",[]),
+    case loaded_module(Domain,[mod_private_odbc,mod_private]) of
+	{ok, M} ->
+	    FullUser = jid_to_old_jid(exmpp_jid:make(User, Domain)),
+	    IQ = iq_to_old_iq(#iq{type = set,
+				  ns = 'jabber:iq:private',
+				  kind = request,
+				  iq_ns = 'jabberd:client',
+				  payload = El}),
+	    case M:process_sm_iq(FullUser, FullUser, IQ ) of
+		{error, _Err} ->
+		    io:format(" ERROR.~n",[]),
+		    ?ERROR_MSG("Error processing private storage ~s : ~p ~n",
+			       [exmpp_xml:document_to_list(El), _Err]);
+		_ ->     io:format(" DONE.~n",[]), ok
+	    end;
+	_ ->
+	    io:format(" ERROR.~n",[]),
+	    ?ERROR_MSG("No modules loaded [mod_private, mod_private_odbc] ~s ~n",
+		       [exmpp_xml:document_to_list(El)]),
+	    {error, not_found}
+    end;
+
+populate_user(_User, _Domain, #xmlcdata{cdata = _CData}) ->
+    ok;
+
+populate_user(_User, _Domain, _El) ->
+    ok.
+
+%%%==================================
+%%%% Utilities
+
+loaded_module(Domain,Options) ->
+    LoadedModules = gen_mod:loaded_modules(Domain),
+    case lists:filter(fun(Module) ->
+			      lists:member(Module, LoadedModules)
+                      end, Options) of
+        [M|_] -> {ok, M};
+        [] -> {error,not_found}
+    end.
+
+jid_to_old_jid(Jid) ->
+    {jid, to_list(exmpp_jid:node_as_list(Jid)),
+     to_list(exmpp_jid:domain_as_list(Jid)),
+     to_list(exmpp_jid:resource_as_list(Jid)),
+     to_list(exmpp_jid:prep_node_as_list(Jid)),
+     to_list(exmpp_jid:prep_domain_as_list(Jid)),
+     to_list(exmpp_jid:prep_resource_as_list(Jid))}.
+
+iq_to_old_iq(#iq{id = ID, type = Type, lang = Lang, ns= NS, payload = El }) ->
+    {iq, to_list(ID), Type, to_list(NS), to_list(Lang),
+     exmpp_xml:xmlel_to_xmlelement(El)}.
+
+to_list(L) when is_list(L) -> L;
+to_list(B) when is_binary(B) -> binary_to_list(B);
+to_list(undefined) -> "";
+to_list(B) when is_atom(B) -> atom_to_list(B).
+
+%%%==================================
+
+%%%% Export hosts
+
+%% @spec (Dir::string(), Hosts::[string()]) -> ok
+export_hosts(Dir, Hosts) ->
+    try_start_exmpp(),
+
+    FnT = make_filename_template(),
+    DFn = make_main_basefilename(Dir, FnT),
+
+    {ok, Fd} = file_open(DFn),
+    print(Fd, make_piefxis_xml_head()),
+    print(Fd, make_piefxis_server_head()),
+
+    FilesAndHosts = [{make_host_filename(FnT, Host), Host} || Host <- Hosts],
+    [print(Fd, make_xinclude(FnH)) || {FnH, _Host} <- FilesAndHosts],
+
+    print(Fd, make_piefxis_server_tail()),
+    print(Fd, make_piefxis_xml_tail()),
+    file_close(Fd),
+
+    [export_host(Dir, FnH, Host) || {FnH, Host} <- FilesAndHosts],
+
+    ok.
+
+%%%==================================
+%%%% Export server
+
+%% @spec (Dir::string()) -> ok
+export_server(Dir) ->
+    Hosts = ?MYHOSTS,
+    export_hosts(Dir, Hosts).
+
+%%%==================================
+%%%% Export host
+
+%% @spec (Dir::string(), Host::string()) -> ok
+export_host(Dir, Host) ->
+    Hosts = [Host],
+    export_hosts(Dir, Hosts).
+
+%% @spec (Dir::string(), Fn::string(), Host::string()) -> ok
+export_host(Dir, FnH, Host) ->
+
+    DFn = make_host_basefilename(Dir, FnH),
+
+    {ok, Fd} = file_open(DFn),
+    print(Fd, make_piefxis_xml_head()),
+    print(Fd, make_piefxis_host_head(Host)),
+
+    Users = ejabberd_auth:get_vh_registered_users(Host),
+    [export_user(Fd, Username, Host) || {Username, _Host} <- Users],
+    timer:sleep(500), % Delay to ensure ERROR_MSG are displayed in the shell
+
+    print(Fd, make_piefxis_host_tail()),
+    print(Fd, make_piefxis_xml_tail()),
+    file_close(Fd).
+
+%%%==================================
+%%%% PIEFXIS formatting
+
+%% @spec () -> string()
+make_piefxis_xml_head() ->
+    "<?xml version='1.0' encoding='UTF-8'?>".
+
+%% @spec () -> string()
+make_piefxis_xml_tail() ->
+    "".
+
+%% @spec () -> string()
+make_piefxis_server_head() ->
+    "<server-data"
+	" xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'"
+	" xmlns:xi='http://www.w3.org/2001/XInclude'>".
+
+%% @spec () -> string()
+make_piefxis_server_tail() ->
+    "</server-data>".
+
+%% @spec (Host::string()) -> string()
+make_piefxis_host_head(Host) ->
+    NSString =
+	" xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'"
+	" xmlns:xi='http://www.w3.org/2001/XInclude'",
+    io_lib:format("<host~s jid='~s'>", [NSString, Host]).
+
+%% @spec () -> string()
+make_piefxis_host_tail() ->
+    "</host>".
+
+%% @spec (Fn::string()) -> string()
+make_xinclude(Fn) ->
+    Base = filename:basename(Fn),
+    io_lib:format("<xi:include href='~s'/>", [Base]).
+
+%%%==================================
+%%%% Export user
+
+%% @spec (Fd, Username::string(), Host::string()) -> ok
+%% @doc Extract user information and print it.
+export_user(Fd, Username, Host) ->
+    try extract_user(Username, Host) of
+	UserString ->
+	    print(Fd, UserString)
+    catch
+	E1:E2 ->
+	    ?ERROR_MSG("The account ~s@~s is not exported because a problem "
+		       "was found in it:~n~p: ~p", [Username, Host, E1, E2])
+    end.
+
+%% @spec (Username::string(), Host::string()) -> string()
+extract_user(Username, Host) ->
+    Password = ejabberd_auth:get_password_s(Username, Host),
+    UserInfo = [extract_user_info(InfoName, Username, Host) || InfoName <- [roster, offline, private, vcard]],
+    UserInfoString = lists:flatten(UserInfo),
+    io_lib:format("<user name='~s' password='~s'>~s</user>", [Username, Password, UserInfoString]).
+
+%% @spec (InfoName::atom(), Username::string(), Host::string()) -> string()
+extract_user_info(roster, Username, Host) ->
+    case loaded_module(Host,[mod_roster_odbc,mod_roster]) of
+	{ok, M} ->
+	    From = To = jlib:make_jid(Username, Host, ""),
+	    SubelGet = {xmlelement, "query", [{"xmlns",?NS_ROSTER}], []},
+	    %%IQGet = #iq{type=get, xmlns=?NS_ROSTER, payload=SubelGet}, % this is for 3.0.0 version
+	    IQGet = {iq, "", get, ?NS_ROSTER, "" , SubelGet},
+	    Res = M:process_local_iq(From, To, IQGet),
+	    %%[El] = Res#iq.payload, % this is for 3.0.0 version
+	    {iq, _, result, _, _, Els} = Res,
+	    case Els of
+		[El] -> exmpp_xml:document_to_list(El);
+		[] -> ""
+	    end;
+	_E ->
+	    ""
+    end;
+
+extract_user_info(offline, Username, Host) ->
+    case loaded_module(Host,[mod_offline,mod_offline_odbc]) of
+	{ok, mod_offline} ->
+	    Els = mnesia_pop_offline_messages([], Username, Host),
+	    case Els of
+		[] -> "";
+		Els ->
+		    OfEl = {xmlelement, "offline-messages", [], Els},
+		    exmpp_xml:document_to_list(OfEl)
+	    end;
+	{ok, mod_offline_odbc} ->
+	    "";
+	_E ->
+	    ""
+    end;
+
+extract_user_info(private, Username, Host) ->
+    case loaded_module(Host,[mod_private,mod_private_odbc]) of
+	{ok, mod_private} ->
+	    get_user_private_mnesia(Username, Host);
+	{ok, mod_private_odbc} ->
+	    "";
+	_E ->
+	    ""
+    end;
+
+extract_user_info(vcard, Username, Host) ->
+    case loaded_module(Host,[mod_vcard, mod_vcard_odbc, mod_vcard_odbc]) of
+	{ok, M} ->
+	    From = To = jlib:make_jid(Username, Host, ""),
+	    SubelGet = {xmlelement, "vCard", [{"xmlns",?NS_VCARD}], []},
+	    %%IQGet = #iq{type=get, xmlns=?NS_VCARD, payload=SubelGet}, % this is for 3.0.0 version
+	    IQGet = {iq, "", get, ?NS_VCARD, "" , SubelGet},
+	    Res = M:process_sm_iq(From, To, IQGet),
+	    %%[El] = Res#iq.payload, % this is for 3.0.0 version
+	    {iq, _, result, _, _, Els} = Res,
+	    case Els of
+		[El] -> exmpp_xml:document_to_list(El);
+		[] -> ""
+	    end;
+	_E ->
+	    ""
+    end.
+
+%%%==================================
+%%%% Interface with ejabberd offline storage
+
+%% Copied from mod_offline.erl and customized
+-record(offline_msg, {us, timestamp, expire, from, to, packet}).
+mnesia_pop_offline_messages(Ls, User, Server) ->
+    LUser = jlib:nodeprep(User),
+    LServer = jlib:nameprep(Server),
+    US = {LUser, LServer},
+    F = fun() ->
+		Rs = mnesia:wread({offline_msg, US}),
+		%%mnesia:delete({offline_msg, US}),
+		Rs
+	end,
+    case mnesia:transaction(F) of
+	{atomic, Rs} ->
+	    TS = now(),
+	    Ls ++ lists:map(
+		    fun(R) ->
+			    {xmlelement, Name, Attrs, Els} = R#offline_msg.packet,
+			    FromString = jlib:jid_to_string(R#offline_msg.from),
+			    Attrs2 = lists:keystore("from", 1, Attrs, {"from", FromString}),
+			    Attrs3 = lists:keystore("xmlns", 1, Attrs2, {"xmlns", "jabber:client"}),
+			    {xmlelement, Name, Attrs3,
+			     Els ++
+			     [jlib:timestamp_to_xml(
+				calendar:now_to_universal_time(
+				  R#offline_msg.timestamp))]}
+		    end,
+		    lists:filter(
+		      fun(R) ->
+			      case R#offline_msg.expire of
+				  never ->
+				      true;
+				  TimeStamp ->
+				      TS < TimeStamp
+			      end
+		      end,
+		      lists:keysort(#offline_msg.timestamp, Rs)));
+	_ ->
+	    Ls
+    end.
+
+%%%==================================
+%%%% Interface with ejabberd private storage
+
+get_user_private_mnesia(Username, Host) ->
+    ListNsEl = mnesia:dirty_select(private_storage,
+				   [{#private_storage{usns={Username, Host, '$1'}, xml = '$2'},
+				     [], ['$$']}]),
+    Els = [exmpp_xml:document_to_list(El) || [_Ns, El] <- ListNsEl],
+    case lists:flatten(Els) of
+	"" -> "";
+	ElsString ->
+	    io_lib:format("<query xmlns='jabber:iq:private'>~s</query>", [ElsString])
+    end.
+
+%%%==================================
+%%%% Disk file access
+
+%% @spec () -> string()
+make_filename_template() ->
+    {{Year, Month, Day}, {Hour, Minute, Second}} = calendar:local_time(),
+    lists:flatten(
+      io_lib:format("~4..0w~2..0w~2..0w-~2..0w~2..0w~2..0w",
+		    [Year, Month, Day, Hour, Minute, Second])).
+
+%% @spec (Dir::string(), FnT::string()) -> string()
+make_main_basefilename(Dir, FnT) ->
+    Filename2 = filename:flatten([FnT, ".xml"]),
+    filename:join([Dir, Filename2]).
+
+%% @spec (FnT::string(), Host::string()) -> FnH::string()
+%% @doc Make the filename for the host.
+%% Example: ``("20080804-231550", "jabber.example.org") -> "20080804-231550_jabber_example_org.xml"''
+make_host_filename(FnT, Host) ->
+    Host2 = string:join(string:tokens(Host, "."), "_"),
+    filename:flatten([FnT, "_", Host2, ".xml"]).
+
+make_host_basefilename(Dir, FnT) ->
+    filename:join([Dir, FnT]).
+
+%% @spec (Fn::string()) -> {ok, Fd}
+file_open(Fn) ->
+    file:open(Fn, [write]).
+
+%% @spec (Fd) -> ok
+file_close(Fd) ->
+    file:close(Fd).
+
+%% @spec (Fd, String::string()) -> ok
+print(Fd, String) ->
+    io:format(Fd, String, []).
+
+%%%==================================
+
+%%% vim: set filetype=erlang tabstop=8 foldmarker=%%%%,%%%= foldmethod=marker:

src/ejabberd_rdbms.erl

@@ -0,0 +1,78 @@
+%%%----------------------------------------------------------------------
+%%% File    : ejabberd_rdbms.erl
+%%% Author  : Mickael Remond <mickael.remond@process-one.net>
+%%% Purpose : Manage the start of the database modules when needed
+%%% Created : 31 Jan 2003 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%----------------------------------------------------------------------
+
+-module(ejabberd_rdbms).
+-author('alexey@process-one.net').
+
+-export([start/0]).
+-include("ejabberd.hrl").
+
+start() ->
+    %% Check if ejabberd has been compiled with ODBC
+    case catch ejabberd_odbc_sup:module_info() of
+	{'EXIT',{undef,_}} ->
+	    ?INFO_MSG("ejabberd has not been compiled with relational database support. Skipping database startup.", []);
+	_ ->
+	    %% If compiled with ODBC, start ODBC on the needed host
+	    start_hosts()
+    end.
+
+%% Start relationnal DB module on the nodes where it is needed
+start_hosts() ->
+    lists:foreach(
+      fun(Host) ->
+	      case needs_odbc(Host) of
+		  true  -> start_odbc(Host);
+		  false -> ok
+	      end
+      end, ?MYHOSTS).
+
+%% Start the ODBC module on the given host
+start_odbc(Host) ->
+    Supervisor_name = gen_mod:get_module_proc(Host, ejabberd_odbc_sup),
+    ChildSpec =
+	{Supervisor_name,
+	 {ejabberd_odbc_sup, start_link, [Host]},
+	 transient,
+	 infinity,
+	 supervisor,
+	 [ejabberd_odbc_sup]},
+    case supervisor:start_child(ejabberd_sup, ChildSpec) of
+	{ok, _PID} ->
+	    ok;
+	_Error ->
+	    ?ERROR_MSG("Start of supervisor ~p failed:~n~p~nRetrying...~n", [Supervisor_name, _Error]),
+	    start_odbc(Host)
+    end.
+
+%% Returns true if we have configured odbc_server for the given host
+needs_odbc(Host) ->
+    LHost = jlib:nameprep(Host),
+    case ejabberd_config:get_local_option({odbc_server, LHost}) of
+	undefined ->
+	    false;
+	_ -> true
+    end.

src/ejabberd_receiver.erl

@@ -1,26 +1,43 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_receiver.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : Socket receiver for C2S and S2S connections
-%%% Created : 10 Nov 2003 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created : 10 Nov 2003 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_receiver).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -behaviour(gen_server).
 
 %% API
--export([start_link/5,
+-export([start_link/4,
 	 start/3,
 	 start/4,
 	 change_shaper/2,
 	 reset_stream/1,
 	 starttls/2,
 	 compress/2,
-	 become_controller/1,
+	 become_controller/2,
 	 close/1]).
 
 %% gen_server callbacks
@@ -37,6 +54,8 @@
 		xml_stream_state,
 		timeout}).
 
+-define(HIBERNATE_TIMEOUT, 90000).
+
 %%====================================================================
 %% API
 %%====================================================================
@@ -44,9 +63,9 @@
 %% Function: start_link() -> {ok,Pid} | ignore | {error,Error}
 %% Description: Starts the server
 %%--------------------------------------------------------------------
-start_link(Socket, SockMod, Shaper, MaxStanzaSize, C2SPid) ->
+start_link(Socket, SockMod, Shaper, MaxStanzaSize) ->
     gen_server:start_link(
-      ?MODULE, [Socket, SockMod, Shaper, MaxStanzaSize, C2SPid], []).
+      ?MODULE, [Socket, SockMod, Shaper, MaxStanzaSize], []).
 
 %%--------------------------------------------------------------------
 %% Function: start() -> {ok,Pid} | ignore | {error,Error}
@@ -58,7 +77,7 @@ start(Socket, SockMod, Shaper) ->
 start(Socket, SockMod, Shaper, MaxStanzaSize) ->
     {ok, Pid} = supervisor:start_child(
 		  ejabberd_receiver_sup,
-		  [Socket, SockMod, Shaper, MaxStanzaSize, self()]),
+		  [Socket, SockMod, Shaper, MaxStanzaSize]),
     Pid.
 
 change_shaper(Pid, Shaper) ->
@@ -73,8 +92,8 @@ starttls(Pid, TLSSocket) ->
 compress(Pid, ZlibSocket) ->
     gen_server:call(Pid, {compress, ZlibSocket}).
 
-become_controller(Pid) ->
-    gen_server:call(Pid, become_controller).
+become_controller(Pid, C2SPid) ->
+    gen_server:call(Pid, {become_controller, C2SPid}).
 
 close(Pid) ->
     gen_server:cast(Pid, close).
@@ -90,8 +109,7 @@ close(Pid) ->
 %%                         {stop, Reason}
 %% Description: Initiates the server
 %%--------------------------------------------------------------------
-init([Socket, SockMod, Shaper, MaxStanzaSize, C2SPid]) ->
-    XMLStreamState = xml_stream:new(C2SPid, MaxStanzaSize),
+init([Socket, SockMod, Shaper, MaxStanzaSize]) ->
     ShaperState = shaper:new(Shaper),
     Timeout = case SockMod of
 		  ssl ->
@@ -102,9 +120,7 @@ init([Socket, SockMod, Shaper, MaxStanzaSize, C2SPid]) ->
     {ok, #state{socket = Socket,
 		sock_mod = SockMod,
 		shaper_state = ShaperState,
-		c2s_pid = C2SPid,
 		max_stanza_size = MaxStanzaSize,
-		xml_stream_state = XMLStreamState,
 		timeout = Timeout}}.
 
 %%--------------------------------------------------------------------
@@ -120,14 +136,14 @@ handle_call({starttls, TLSSocket}, _From,
 	    #state{xml_stream_state = XMLStreamState,
 		   c2s_pid = C2SPid,
 		   max_stanza_size = MaxStanzaSize} = State) ->
-    xml_stream:close(XMLStreamState),
+    close_stream(XMLStreamState),
     NewXMLStreamState = xml_stream:new(C2SPid, MaxStanzaSize),
     NewState = State#state{socket = TLSSocket,
 			   sock_mod = tls,
 			   xml_stream_state = NewXMLStreamState},
     case tls:recv_data(TLSSocket, "") of
 	{ok, TLSData} ->
-	    {reply, ok, process_data(TLSData, NewState)};
+	    {reply, ok, process_data(TLSData, NewState), ?HIBERNATE_TIMEOUT};
 	{error, _Reason} ->
 	    {stop, normal, ok, NewState}
     end;
@@ -135,14 +151,14 @@ handle_call({compress, ZlibSocket}, _From,
 	    #state{xml_stream_state = XMLStreamState,
 		   c2s_pid = C2SPid,
 		   max_stanza_size = MaxStanzaSize} = State) ->
-    xml_stream:close(XMLStreamState),
+    close_stream(XMLStreamState),
     NewXMLStreamState = xml_stream:new(C2SPid, MaxStanzaSize),
     NewState = State#state{socket = ZlibSocket,
 			   sock_mod = ejabberd_zlib,
 			   xml_stream_state = NewXMLStreamState},
     case ejabberd_zlib:recv_data(ZlibSocket, "") of
 	{ok, ZlibData} ->
-	    {reply, ok, process_data(ZlibData, NewState)};
+	    {reply, ok, process_data(ZlibData, NewState), ?HIBERNATE_TIMEOUT};
 	{error, _Reason} ->
 	    {stop, normal, ok, NewState}
     end;
@@ -150,17 +166,21 @@ handle_call(reset_stream, _From,
 	    #state{xml_stream_state = XMLStreamState,
 		   c2s_pid = C2SPid,
 		   max_stanza_size = MaxStanzaSize} = State) ->
-    xml_stream:close(XMLStreamState),
+    close_stream(XMLStreamState),
     NewXMLStreamState = xml_stream:new(C2SPid, MaxStanzaSize),
     Reply = ok,
-    {reply, Reply, State#state{xml_stream_state = NewXMLStreamState}};
-handle_call(become_controller, _From, State) ->
-    activate_socket(State),
+    {reply, Reply, State#state{xml_stream_state = NewXMLStreamState},
+     ?HIBERNATE_TIMEOUT};
+handle_call({become_controller, C2SPid}, _From, State) ->
+    XMLStreamState = xml_stream:new(C2SPid, State#state.max_stanza_size),
+    NewState = State#state{c2s_pid = C2SPid,
+			   xml_stream_state = XMLStreamState},
+    activate_socket(NewState),
     Reply = ok,
-    {reply, Reply, State};
+    {reply, Reply, NewState, ?HIBERNATE_TIMEOUT};
 handle_call(_Request, _From, State) ->
     Reply = ok,
-    {reply, Reply, State}.
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT}.
 
 %%--------------------------------------------------------------------
 %% Function: handle_cast(Msg, State) -> {noreply, State} |
@@ -170,11 +190,11 @@ handle_call(_Request, _From, State) ->
 %%--------------------------------------------------------------------
 handle_cast({change_shaper, Shaper}, State) ->
     NewShaperState = shaper:new(Shaper),
-    {noreply, State#state{shaper_state = NewShaperState}};
+    {noreply, State#state{shaper_state = NewShaperState}, ?HIBERNATE_TIMEOUT};
 handle_cast(close, State) ->
     {stop, normal, State};
 handle_cast(_Msg, State) ->
-    {noreply, State}.
+    {noreply, State, ?HIBERNATE_TIMEOUT}.
 
 %%--------------------------------------------------------------------
 %% Function: handle_info(Info, State) -> {noreply, State} |
@@ -185,24 +205,26 @@ handle_cast(_Msg, State) ->
 handle_info({Tag, _TCPSocket, Data},
 	    #state{socket = Socket,
 		   sock_mod = SockMod} = State)
-  when (Tag == tcp) or (Tag == ssl) ->
+  when (Tag == tcp) or (Tag == ssl) or (Tag == ejabberd_xml) ->
     case SockMod of
 	tls ->
 	    case tls:recv_data(Socket, Data) of
 		{ok, TLSData} ->
-		    {noreply, process_data(TLSData, State)};
+		    {noreply, process_data(TLSData, State),
+		     ?HIBERNATE_TIMEOUT};
 		{error, _Reason} ->
 		    {stop, normal, State}
 	    end;
 	ejabberd_zlib ->
 	    case ejabberd_zlib:recv_data(Socket, Data) of
 		{ok, ZlibData} ->
-		    {noreply, process_data(ZlibData, State)};
+		    {noreply, process_data(ZlibData, State),
+		     ?HIBERNATE_TIMEOUT};
 		{error, _Reason} ->
 		    {stop, normal, State}
 	    end;
 	_ ->
-	    {noreply, process_data(Data, State)}
+	    {noreply, process_data(Data, State), ?HIBERNATE_TIMEOUT}
     end;
 handle_info({Tag, _TCPSocket}, State)
   when (Tag == tcp_closed) or (Tag == ssl_closed) ->
@@ -211,15 +233,18 @@ handle_info({Tag, _TCPSocket, Reason}, State)
   when (Tag == tcp_error) or (Tag == ssl_error) ->
     case Reason of
 	timeout ->
-	    {noreply, State};
+	    {noreply, State, ?HIBERNATE_TIMEOUT};
 	_ ->
 	    {stop, normal, State}
     end;
 handle_info({timeout, _Ref, activate}, State) ->
     activate_socket(State),
-    {noreply, State};
+    {noreply, State, ?HIBERNATE_TIMEOUT};
+handle_info(timeout, State) ->
+    proc_lib:hibernate(gen_server, enter_loop, [?MODULE, [], State]),
+    {noreply, State, ?HIBERNATE_TIMEOUT};
 handle_info(_Info, State) ->
-    {noreply, State}.
+    {noreply, State, ?HIBERNATE_TIMEOUT}.
 
 %%--------------------------------------------------------------------
 %% Function: terminate(Reason, State) -> void()
@@ -230,8 +255,13 @@ handle_info(_Info, State) ->
 %%--------------------------------------------------------------------
 terminate(_Reason, #state{xml_stream_state = XMLStreamState,
 			  c2s_pid = C2SPid} = State) ->
-    xml_stream:close(XMLStreamState),
-    gen_fsm:send_event(C2SPid, closed),
+    close_stream(XMLStreamState),
+    if
+	C2SPid /= undefined ->
+	    gen_fsm:send_event(C2SPid, closed);
+	true ->
+	    ok
+    end,
     catch (State#state.sock_mod):close(State#state.socket),
     ok.
 
@@ -248,20 +278,51 @@ code_change(_OldVsn, State, _Extra) ->
 
 activate_socket(#state{socket = Socket,
 		       sock_mod = SockMod}) ->
-    case SockMod of
-	gen_tcp ->
-	    inet:setopts(Socket, [{active, once}]);
-	_ ->
-	    SockMod:setopts(Socket, [{active, once}])
+    PeerName =
+	case SockMod of
+	    gen_tcp ->
+		inet:setopts(Socket, [{active, once}]),
+		inet:peername(Socket);
+	    _ ->
+		SockMod:setopts(Socket, [{active, once}]),
+		SockMod:peername(Socket)
+	end,
+    case PeerName of
+	{error, _Reason} ->
+	    self() ! {tcp_closed, Socket};
+	{ok, _} ->
+	    ok
     end.
 
+%% Data processing for connectors directly generating xmlelement in
+%% Erlang data structure.
+%% WARNING: Shaper does not work with Erlang data structure.
+process_data([], State) ->
+    activate_socket(State),
+    State;
+process_data([Element|Els], #state{c2s_pid = C2SPid} = State)
+  when element(1, Element) == xmlelement;
+       element(1, Element) == xmlstreamstart;
+      element(1, Element) == xmlstreamelement;
+       element(1, Element) == xmlstreamend ->
+    if
+	C2SPid == undefined ->
+	    State;
+	true ->
+	    catch gen_fsm:send_event(C2SPid, element_wrapper(Element)),
+	    process_data(Els, State)
+    end;
+%% Data processing for connectors receivind data as string.
 process_data(Data,
 	     #state{xml_stream_state = XMLStreamState,
-		    shaper_state = ShaperState} = State) ->
+		    shaper_state = ShaperState,
+		    c2s_pid = C2SPid} = State) ->
     ?DEBUG("Received XML on stream = ~p", [binary_to_list(Data)]),
     XMLStreamState1 = xml_stream:parse(XMLStreamState, Data),
     {NewShaperState, Pause} = shaper:update(ShaperState, size(Data)),
     if
+	C2SPid == undefined ->
+	    ok;
 	Pause > 0 ->
 	    erlang:start_timer(Pause, self(), activate);
 	true ->
@@ -270,3 +331,17 @@ process_data(Data,
     State#state{xml_stream_state = XMLStreamState1,
 		shaper_state = NewShaperState}.
 
+%% Element coming from XML parser are wrapped inside xmlstreamelement
+%% When we receive directly xmlelement tuple (from a socket module
+%% speaking directly Erlang XML), we wrap it inside the same
+%% xmlstreamelement coming from the XML parser.
+element_wrapper(XMLElement)
+  when element(1, XMLElement) == xmlelement ->
+    {xmlstreamelement, XMLElement};
+element_wrapper(Element) ->
+    Element.
+
+close_stream(undefined) ->
+    ok;
+close_stream(XMLStreamState) ->
+    xml_stream:close(XMLStreamState).

src/ejabberd_router.erl

@@ -1,19 +1,37 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_router.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : Main router
-%%% Created : 27 Nov 2002 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created : 27 Nov 2002 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_router).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -behaviour(gen_server).
 
 %% API
 -export([route/3,
+	 route_error/4,
 	 register_route/1,
 	 register_route/2,
 	 register_routes/1,
@@ -55,31 +73,66 @@ route(From, To, Packet) ->
 	    ok
     end.
 
-register_route(Domain) ->
-    case jlib:nameprep(Domain) of
-	error ->
-	    [] = {invalid_domain, Domain};
-	LDomain ->
-	    Pid = self(),
-	    F = fun() ->
-			mnesia:write(#route{domain = LDomain,
-					    pid = Pid})
-		end,
-	    mnesia:transaction(F)
+%% Route the error packet only if the originating packet is not an error itself.
+%% RFC3920 9.3.1
+route_error(From, To, ErrPacket, OrigPacket) ->
+    {xmlelement, _Name, Attrs, _Els} = OrigPacket,
+    case "error" == xml:get_attr_s("type", Attrs) of
+	false ->
+	    route(From, To, ErrPacket);
+	true ->
+	    ok
     end.
 
+register_route(Domain) ->
+    register_route(Domain, undefined).
+
 register_route(Domain, LocalHint) ->
     case jlib:nameprep(Domain) of
 	error ->
-	    [] = {invalid_domain, Domain};
+	    erlang:error({invalid_domain, Domain});
 	LDomain ->
 	    Pid = self(),
-	    F = fun() ->
-			mnesia:write(#route{domain = LDomain,
-					    pid = Pid,
-					    local_hint = LocalHint})
-		end,
-	    mnesia:transaction(F)
+	    case get_component_number(LDomain) of
+		undefined ->
+		    F = fun() ->
+				mnesia:write(#route{domain = LDomain,
+						    pid = Pid,
+						    local_hint = LocalHint})
+			end,
+		    mnesia:transaction(F);
+		N ->
+		    F = fun() ->
+				case mnesia:wread({route, LDomain}) of
+				    [] ->
+					mnesia:write(
+					  #route{domain = LDomain,
+						 pid = Pid,
+						 local_hint = 1}),
+					lists:foreach(
+					  fun(I) ->
+						  mnesia:write(
+						    #route{domain = LDomain,
+							   pid = undefined,
+							   local_hint = I})
+					  end, lists:seq(2, N));
+				    Rs ->
+					lists:any(
+					  fun(#route{pid = undefined,
+						     local_hint = I} = R) ->
+						  mnesia:write(
+						    #route{domain = LDomain,
+							   pid = Pid,
+							   local_hint = I}),
+						  mnesia:delete_object(R),
+						  true;
+					     (_) ->
+						  false
+					  end, Rs)
+				end
+			end,
+		    mnesia:transaction(F)
+	    end
     end.
 
 register_routes(Domains) ->
@@ -90,14 +143,41 @@ register_routes(Domains) ->
 unregister_route(Domain) ->
     case jlib:nameprep(Domain) of
 	error ->
-	    [] = {invalid_domain, Domain};
+	    erlang:error({invalid_domain, Domain});
 	LDomain ->
 	    Pid = self(),
-	    F = fun() ->
-			mnesia:delete_object(#route{domain = LDomain,
-						    pid = Pid})
-		end,
-	    mnesia:transaction(F)
+	    case get_component_number(LDomain) of
+		undefined ->
+		    F = fun() ->
+				case mnesia:match_object(
+				       #route{domain = LDomain,
+					      pid = Pid,
+					      _ = '_'}) of
+				    [R] ->
+					mnesia:delete_object(R);
+				    _ ->
+					ok
+				end
+			end,
+		    mnesia:transaction(F);
+		_ ->
+		    F = fun() ->
+				case mnesia:match_object(#route{domain=LDomain,
+								pid = Pid,
+								_ = '_'}) of
+				    [R] ->
+					I = R#route.local_hint,
+					mnesia:write(
+					  #route{domain = LDomain,
+						 pid = undefined,
+						 local_hint = I}),
+					mnesia:delete_object(R);
+				    _ ->
+					ok
+				end
+			end,
+		    mnesia:transaction(F)
+	    end
     end.
 
 unregister_routes(Domains) ->
@@ -188,9 +268,21 @@ handle_info({'DOWN', _Ref, _Type, Pid, _Info}, State) ->
 		       [{#route{pid = Pid, _ = '_'},
 			 [],
 			 ['$_']}]),
-		lists:foreach(fun(E) ->
-				      mnesia:delete_object(E)
-			      end, Es)
+		lists:foreach(
+		  fun(E) ->
+			  if
+			      is_integer(E#route.local_hint) ->
+				  LDomain = E#route.domain,
+				  I = E#route.local_hint,
+				  mnesia:write(
+				    #route{domain = LDomain,
+					   pid = undefined,
+					   local_hint = I}),
+				  mnesia:delete_object(E);
+			      true ->
+				  mnesia:delete_object(E)
+			  end
+		  end, Es)
 	end,
     mnesia:transaction(F),
     {noreply, State};
@@ -220,8 +312,7 @@ code_change(_OldVsn, State, _Extra) ->
 do_route(OrigFrom, OrigTo, OrigPacket) ->
     ?DEBUG("route~n\tfrom ~p~n\tto ~p~n\tpacket ~p~n",
 	   [OrigFrom, OrigTo, OrigPacket]),
-    LOrigDstDomain = OrigTo#jid.lserver,
-    case ejabberd_hooks:run_fold(filter_packet, LOrigDstDomain,
+    case ejabberd_hooks:run_fold(filter_packet,
 				 {OrigFrom, OrigTo, OrigPacket}, []) of
 	{From, To, Packet} ->
 	    LDstDomain = To#jid.lserver,
@@ -238,24 +329,56 @@ do_route(OrigFrom, OrigTo, OrigPacket) ->
 				_ ->
 				    Pid ! {route, From, To, Packet}
 			    end;
+			is_pid(Pid) ->
+			    Pid ! {route, From, To, Packet};
 			true ->
-			    Pid ! {route, From, To, Packet}
+			    drop
 		    end;
 		Rs ->
-		    case [R || R <- Rs, node(R#route.pid) == node()] of
-			[] ->
-			    R = lists:nth(erlang:phash(now(), length(Rs)), Rs),
+		    Value = case ejabberd_config:get_local_option(
+				   {domain_balancing, LDstDomain}) of
+				undefined -> now();
+				random -> now();
+				source -> jlib:jid_tolower(From);
+				destination -> jlib:jid_tolower(To);
+				bare_source ->
+				    jlib:jid_remove_resource(
+				      jlib:jid_tolower(From));
+				bare_destination ->
+				    jlib:jid_remove_resource(
+				      jlib:jid_tolower(To))
+			    end,
+		    case get_component_number(LDstDomain) of
+			undefined ->
+			    case [R || R <- Rs, node(R#route.pid) == node()] of
+				[] ->
+				    R = lists:nth(erlang:phash(Value, length(Rs)), Rs),
+				    Pid = R#route.pid,
+				    if
+					is_pid(Pid) ->
+					    Pid ! {route, From, To, Packet};
+					true ->
+					    drop
+				    end;
+				LRs ->
+				    R = lists:nth(erlang:phash(Value, length(LRs)), LRs),
+				    Pid = R#route.pid,
+				    case R#route.local_hint of
+					{apply, Module, Function} ->
+					    Module:Function(From, To, Packet);
+					_ ->
+					    Pid ! {route, From, To, Packet}
+				    end
+			    end;
+			_ ->
+			    SRs = lists:ukeysort(#route.local_hint, Rs),
+			    R = lists:nth(erlang:phash(Value, length(SRs)), SRs),
 			    Pid = R#route.pid,
-			    Pid ! {route, From, To, Packet};
-			LRs ->
-			    LRs,
-			    R = lists:nth(erlang:phash(now(), length(LRs)), LRs),
-			    Pid = R#route.pid,
-			    case R#route.local_hint of
-				{apply, Module, Function} ->
-				    Module:Function(From, To, Packet);
-				_ ->
-				    Pid ! {route, From, To, Packet}
+			    if
+				is_pid(Pid) ->
+				    Pid ! {route, From, To, Packet};
+				true ->
+				    drop
 			    end
 		    end
 	    end;
@@ -263,7 +386,15 @@ do_route(OrigFrom, OrigTo, OrigPacket) ->
 	    ok
     end.
 
-
+get_component_number(LDomain) ->
+    case ejabberd_config:get_local_option(
+	   {domain_balancing_component_number, LDomain}) of
+	N when is_integer(N),
+	       N > 1 ->
+	    N;
+	_ ->
+	    undefined
+    end.
 
 update_tables() ->
     case catch mnesia:table_info(route, attributes) of

src/ejabberd_s2s.erl

@@ -1,14 +1,31 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_s2s.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : S2S connections manager
-%%% Created :  7 Dec 2002 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created :  7 Dec 2002 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_s2s).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -behaviour(gen_server).
 
@@ -16,17 +33,28 @@
 -export([start_link/0,
 	 route/3,
 	 have_connection/1,
-	 get_key/1,
+	 has_key/2,
+	 get_connections_pids/1,
 	 try_register/1,
-	 remove_connection/1,
-	 dirty_get_connections/0]).
+	 remove_connection/3,
+	 dirty_get_connections/0,
+	 allow_host/2,
+	 incoming_s2s_number/0,
+	 outgoing_s2s_number/0
+	]).
 
 %% gen_server callbacks
 -export([init/1, handle_call/3, handle_cast/2, handle_info/2,
-	 terminate/2, code_change/3]).
+         terminate/2, code_change/3]).
+%% ejabberd API
+-export([get_info_s2s_connections/1]).
 
 -include("ejabberd.hrl").
 -include("jlib.hrl").
+-include("ejabberd_commands.hrl").
+
+-define(DEFAULT_MAX_S2S_CONNECTIONS_NUMBER, 1).
+-define(DEFAULT_MAX_S2S_CONNECTIONS_NUMBER_PER_NODE, 1).
 
 -record(s2s, {fromto, pid, key}).
 -record(state, {}).
@@ -43,53 +71,80 @@ start_link() ->
 
 route(From, To, Packet) ->
     case catch do_route(From, To, Packet) of
-	{'EXIT', Reason} ->
-	    ?ERROR_MSG("~p~nwhen processing: ~p",
-		       [Reason, {From, To, Packet}]);
+        {'EXIT', Reason} ->
+            ?ERROR_MSG("~p~nwhen processing: ~p",
+                       [Reason, {From, To, Packet}]);
+        _ ->
+            ok
+    end.
+
+remove_connection(FromTo, Pid, Key) ->
+    case catch mnesia:dirty_match_object(s2s, #s2s{fromto = FromTo,
+						   pid = Pid,
+						   _ = '_'}) of
+	[#s2s{pid = Pid, key = Key}] ->
+	    F = fun() ->
+			mnesia:delete_object(#s2s{fromto = FromTo,
+						  pid = Pid,
+						  key = Key})
+		end,
+	    mnesia:transaction(F);
 	_ ->
 	    ok
     end.
 
-remove_connection(FromTo) ->
-    F = fun() ->
-		mnesia:delete({s2s, FromTo})
-	end,
-    mnesia:transaction(F).
-
 have_connection(FromTo) ->
     case catch mnesia:dirty_read(s2s, FromTo) of
-	[_] ->
-	    true;
-	_ ->
-	    false
+        [_] ->
+            true;
+        _ ->
+            false
     end.
 
-get_key(FromTo) ->
-    case catch mnesia:dirty_read(s2s, FromTo) of
-	[E] ->
-	    E#s2s.key;
+has_key(FromTo, Key) ->
+    case mnesia:dirty_select(s2s,
+			     [{#s2s{fromto = FromTo, key = Key, _ = '_'},
+			       [],
+			       ['$_']}]) of
+	[] ->
+	    false;
 	_ ->
-	    error
+	    true
+    end.
+
+get_connections_pids(FromTo) ->
+    case catch mnesia:dirty_read(s2s, FromTo) of
+	L when is_list(L) ->
+	    [Connection#s2s.pid || Connection <- L];
+	_ ->
+	    []
     end.
 
 try_register(FromTo) ->
     Key = randoms:get_string(),
+    MaxS2SConnectionsNumber = max_s2s_connections_number(FromTo),
+    MaxS2SConnectionsNumberPerNode =
+	max_s2s_connections_number_per_node(FromTo),
     F = fun() ->
-		case mnesia:read({s2s, FromTo}) of
-		    [] ->
+		L = mnesia:read({s2s, FromTo}),
+		NeededConnections = needed_connections_number(
+				      L, MaxS2SConnectionsNumber,
+				      MaxS2SConnectionsNumberPerNode),
+		if
+		    NeededConnections > 0 ->
 			mnesia:write(#s2s{fromto = FromTo,
 					  pid = self(),
 					  key = Key}),
 			{key, Key};
-		    _ ->
+		    true ->
 			false
 		end
-        end,
+	end,
     case mnesia:transaction(F) of
-	{atomic, Res} ->
-	    Res;
-	_ ->
-	    false
+        {atomic, Res} ->
+            Res;
+        _ ->
+            false
     end.
 
 dirty_get_connections() ->
@@ -108,10 +163,11 @@ dirty_get_connections() ->
 %%--------------------------------------------------------------------
 init([]) ->
     update_tables(),
-    mnesia:create_table(s2s, [{ram_copies, [node()]},
+    mnesia:create_table(s2s, [{ram_copies, [node()]}, {type, bag},
 			      {attributes, record_info(fields, s2s)}]),
     mnesia:add_table_copy(s2s, node(), ram_copies),
     mnesia:subscribe(system),
+    ejabberd_commands:register_commands(commands()),
     {ok, #state{}}.
 
 %%--------------------------------------------------------------------
@@ -147,11 +203,11 @@ handle_info({mnesia_system_event, {mnesia_down, Node}}, State) ->
     {noreply, State};
 handle_info({route, From, To, Packet}, State) ->
     case catch do_route(From, To, Packet) of
-	{'EXIT', Reason} ->
-	    ?ERROR_MSG("~p~nwhen processing: ~p",
-		       [Reason, {From, To, Packet}]);
-	_ ->
-	    ok
+        {'EXIT', Reason} ->
+            ?ERROR_MSG("~p~nwhen processing: ~p",
+                       [Reason, {From, To, Packet}]);
+        _ ->
+            ok
     end,
     {noreply, State};
 handle_info(_Info, State) ->
@@ -165,6 +221,7 @@ handle_info(_Info, State) ->
 %% The return value is ignored.
 %%--------------------------------------------------------------------
 terminate(_Reason, _State) ->
+    ejabberd_commands:unregister_commands(commands()),
     ok.
 
 %%--------------------------------------------------------------------
@@ -187,24 +244,35 @@ clean_table_from_bad_node(Node) ->
 		lists:foreach(fun(E) ->
 				      mnesia:delete_object(E)
 			      end, Es)
-        end,
-    mnesia:transaction(F).
+	end,
+    mnesia:async_dirty(F).
 
 do_route(From, To, Packet) ->
     ?DEBUG("s2s manager~n\tfrom ~p~n\tto ~p~n\tpacket ~P~n",
-	   [From, To, Packet, 8]),
+           [From, To, Packet, 8]),
     case find_connection(From, To) of
-	{atomic, Pid} when pid(Pid) ->
+	{atomic, Pid} when is_pid(Pid) ->
 	    ?DEBUG("sending to process ~p~n", [Pid]),
-	    % TODO
 	    {xmlelement, Name, Attrs, Els} = Packet,
 	    NewAttrs = jlib:replace_from_to_attrs(jlib:jid_to_string(From),
 						  jlib:jid_to_string(To),
 						  Attrs),
+	    #jid{lserver = MyServer} = From,
+	    ejabberd_hooks:run(
+	      s2s_send_packet,
+	      MyServer,
+	      [From, To, Packet]),
 	    send_element(Pid, {xmlelement, Name, NewAttrs, Els}),
 	    ok;
-	{aborted, Reason} ->
-	    ?DEBUG("delivery failed: ~p~n", [Reason]),
+	{aborted, _Reason} ->
+	    case xml:get_tag_attr_s("type", Packet) of
+		"error" -> ok;
+		"result" -> ok;
+		_ ->
+		    Err = jlib:make_error_reply(
+			    Packet, ?ERR_SERVICE_UNAVAILABLE),
+		    ejabberd_router:route(To, From, Err)
+	    end,
 	    false
     end.
 
@@ -212,48 +280,264 @@ find_connection(From, To) ->
     #jid{lserver = MyServer} = From,
     #jid{lserver = Server} = To,
     FromTo = {MyServer, Server},
+    MaxS2SConnectionsNumber = max_s2s_connections_number(FromTo),
+    MaxS2SConnectionsNumberPerNode =
+	max_s2s_connections_number_per_node(FromTo),
+    ?DEBUG("Finding connection for ~p~n", [FromTo]),
     case catch mnesia:dirty_read(s2s, FromTo) of
 	{'EXIT', Reason} ->
 	    {aborted, Reason};
 	[] ->
-	    ?DEBUG("starting new s2s connection~n", []),
-	    Key = randoms:get_string(),
-	    {ok, Pid} = ejabberd_s2s_out:start(MyServer, Server, {new, Key}),
-	    F = fun() ->
-			case mnesia:read({s2s, FromTo}) of
-			    [El] ->
-				El#s2s.pid;
-			    [] ->
-				mnesia:write(#s2s{fromto = FromTo,
-						  pid = Pid,
-						  key = Key}),
-				Pid
-			end
-		end,
-	    TRes = mnesia:transaction(F),
-	    ejabberd_s2s_out:start_connection(Pid),
-	    TRes;
-	[El] ->
-	    {atomic, El#s2s.pid}
+	    %% We try to establish all the connections if the host is not a
+	    %% service and if the s2s host is not blacklisted or
+	    %% is in whitelist:
+	    case not is_service(From, To) andalso allow_host(MyServer, Server) of
+		true ->
+		    NeededConnections = needed_connections_number(
+					  [], MaxS2SConnectionsNumber,
+					  MaxS2SConnectionsNumberPerNode),
+		    open_several_connections(
+		      NeededConnections, MyServer,
+		      Server, From, FromTo,
+		      MaxS2SConnectionsNumber, MaxS2SConnectionsNumberPerNode);
+		false ->
+		    {aborted, error}
+	    end;
+	L when is_list(L) ->
+	    NeededConnections = needed_connections_number(
+				  L, MaxS2SConnectionsNumber,
+				  MaxS2SConnectionsNumberPerNode),
+	    if
+		NeededConnections > 0 ->
+		    %% We establish the missing connections for this pair.
+		    open_several_connections(
+		      NeededConnections, MyServer,
+		      Server, From, FromTo,
+		      MaxS2SConnectionsNumber, MaxS2SConnectionsNumberPerNode);
+		true ->
+		    %% We choose a connexion from the pool of opened ones.
+		    {atomic, choose_connection(From, L)}
+	    end
     end.
 
+choose_connection(From, Connections) ->
+    choose_pid(From, [C#s2s.pid || C <- Connections]).
+
+choose_pid(From, Pids) ->
+    Pids1 = case [P || P <- Pids, node(P) == node()] of
+		[] -> Pids;
+		Ps -> Ps
+	    end,
+    % Use sticky connections based on the JID of the sender (whithout
+    % the resource to ensure that a muc room always uses the same
+    % connection)
+    Pid = lists:nth(erlang:phash(jlib:jid_remove_resource(From), length(Pids1)),
+		    Pids1),
+    ?DEBUG("Using ejabberd_s2s_out ~p~n", [Pid]),
+    Pid.
+
+open_several_connections(N, MyServer, Server, From, FromTo,
+			 MaxS2SConnectionsNumber,
+			 MaxS2SConnectionsNumberPerNode) ->
+    ConnectionsResult =
+	[new_connection(MyServer, Server, From, FromTo,
+			MaxS2SConnectionsNumber, MaxS2SConnectionsNumberPerNode)
+	 || _N <- lists:seq(1, N)],
+    case [PID || {atomic, PID} <- ConnectionsResult] of
+	[] ->
+	    hd(ConnectionsResult);
+	PIDs ->
+	    {atomic, choose_pid(From, PIDs)}
+    end.
+
+new_connection(MyServer, Server, From, FromTo,
+	       MaxS2SConnectionsNumber, MaxS2SConnectionsNumberPerNode) ->
+    Key = randoms:get_string(),
+    {ok, Pid} = ejabberd_s2s_out:start(
+		  MyServer, Server, {new, Key}),
+    F = fun() ->
+		L = mnesia:read({s2s, FromTo}),
+		NeededConnections = needed_connections_number(
+				      L, MaxS2SConnectionsNumber,
+				      MaxS2SConnectionsNumberPerNode),
+		if
+		    NeededConnections > 0 ->
+			mnesia:write(#s2s{fromto = FromTo,
+					  pid = Pid,
+					  key = Key}),
+			?INFO_MSG("New s2s connection started ~p", [Pid]),
+			Pid;
+		    true ->
+			choose_connection(From, L)
+		end
+	end,
+    TRes = mnesia:transaction(F),
+    case TRes of
+	{atomic, Pid} ->
+	    ejabberd_s2s_out:start_connection(Pid);
+	_ ->
+	    ejabberd_s2s_out:stop_connection(Pid)
+    end,
+    TRes.
+
+max_s2s_connections_number({From, To}) ->
+    case acl:match_rule(
+	   From, max_s2s_connections, jlib:make_jid("", To, "")) of
+	Max when is_integer(Max) -> Max;
+	_ -> ?DEFAULT_MAX_S2S_CONNECTIONS_NUMBER
+    end.
+
+max_s2s_connections_number_per_node({From, To}) ->
+    case acl:match_rule(
+	   From, max_s2s_connections_per_node, jlib:make_jid("", To, "")) of
+	Max when is_integer(Max) -> Max;
+	_ -> ?DEFAULT_MAX_S2S_CONNECTIONS_NUMBER_PER_NODE
+    end.
+
+needed_connections_number(Ls, MaxS2SConnectionsNumber,
+			  MaxS2SConnectionsNumberPerNode) ->
+    LocalLs = [L || L <- Ls, node(L#s2s.pid) == node()],
+    lists:min([MaxS2SConnectionsNumber - length(Ls),
+	       MaxS2SConnectionsNumberPerNode - length(LocalLs)]).
+
+%%--------------------------------------------------------------------
+%% Function: is_service(From, To) -> true | false
+%% Description: Return true if the destination must be considered as a
+%% service.
+%% --------------------------------------------------------------------
+is_service(From, To) ->
+    LFromDomain = From#jid.lserver,
+    case ejabberd_config:get_local_option({route_subdomains, LFromDomain}) of
+        s2s -> % bypass RFC 3920 10.3
+            false;
+        _ ->
+            LDstDomain = To#jid.lserver,
+            P = fun(Domain) -> is_subdomain(LDstDomain, Domain) end,
+            lists:any(P, ?MYHOSTS)
+    end.
+
+%%--------------------------------------------------------------------
+%% Function: is_subdomain(Domain1, Domain2) -> true | false
+%% Description: Return true if Domain1 (a string representing an
+%% internet domain name) is a subdomain (or the same domain) of
+%% Domain2
+%% --------------------------------------------------------------------
+is_subdomain(Domain1, Domain2) ->
+    lists:suffix(string:tokens(Domain2, "."), string:tokens(Domain1, ".")).
+
 send_element(Pid, El) ->
     Pid ! {send_element, El}.
 
+
+%%%----------------------------------------------------------------------
+%%% ejabberd commands
+
+commands() ->
+    [
+     #ejabberd_commands{name = incoming_s2s_number,
+		       tags = [stats, s2s],
+		       desc = "Number of incoming s2s connections on the node",
+		       module = ?MODULE, function = incoming_s2s_number,
+		       args = [],
+		       result = {s2s_incoming, integer}},
+     #ejabberd_commands{name = outgoing_s2s_number,
+		       tags = [stats, s2s],
+		       desc = "Number of outgoing s2s connections on the node",
+		       module = ?MODULE, function = outgoing_s2s_number,
+		       args = [],
+		       result = {s2s_outgoing, integer}}
+    ].
+
+incoming_s2s_number() ->
+    length(supervisor:which_children(ejabberd_s2s_in_sup)).
+
+outgoing_s2s_number() ->
+    length(supervisor:which_children(ejabberd_s2s_out_sup)).
+
+
+%%%----------------------------------------------------------------------
+%%% Update Mnesia tables
+
 update_tables() ->
-    case catch mnesia:table_info(s2s, attributes) of
-	[fromto, node, key] ->
-	    mnesia:transform_table(s2s, ignore, [fromto, pid, key]),
-	    mnesia:clear_table(s2s);
-	[fromto, pid, key] ->
+    case catch mnesia:table_info(s2s, type) of
+	bag ->
 	    ok;
 	{'EXIT', _} ->
-	    ok
+	    ok;
+	_ ->
+	    % XXX TODO convert it ?
+	    mnesia:delete_table(s2s)
+    end,
+    case catch mnesia:table_info(s2s, attributes) of
+        [fromto, node, key] ->
+            mnesia:transform_table(s2s, ignore, [fromto, pid, key]),
+            mnesia:clear_table(s2s);
+        [fromto, pid, key] ->
+            ok;
+        {'EXIT', _} ->
+            ok
     end,
     case lists:member(local_s2s, mnesia:system_info(tables)) of
-	true ->
-	    mnesia:delete_table(local_s2s);
-	false ->
-	    ok
+        true ->
+            mnesia:delete_table(local_s2s);
+        false ->
+            ok
     end.
 
+%% Check if host is in blacklist or white list
+allow_host(MyServer, S2SHost) ->
+    case lists:filter(
+	   fun(Host) ->
+		   is_subdomain(MyServer, Host)
+	   end, ?MYHOSTS) of
+	[MyHost|_] ->
+	    allow_host1(MyHost, S2SHost);
+	[] ->
+	    allow_host1(MyServer, S2SHost)
+    end.
+
+allow_host1(MyHost, S2SHost) ->
+    case ejabberd_config:get_local_option({{s2s_host, S2SHost}, MyHost}) of
+	deny -> false;
+	allow -> true;
+	_ ->
+	    case ejabberd_config:get_local_option({s2s_default_policy, MyHost}) of
+		deny -> false;
+		_ ->
+		    case ejabberd_hooks:run_fold(s2s_allow_host, MyHost,
+						 allow, [MyHost, S2SHost]) of
+			deny -> false;
+			allow -> true;
+			_ -> true
+		    end
+	    end
+    end.
+
+%% Get information about S2S connections of the specified type.
+%% @spec (Type) -> [Info]
+%% where Type = in | out
+%%       Info = [{InfoName::atom(), InfoValue::any()}]
+get_info_s2s_connections(Type) ->
+    ChildType = case Type of
+		    in -> ejabberd_s2s_in_sup;
+		    out -> ejabberd_s2s_out_sup
+		end,
+    Connections = supervisor:which_children(ChildType),
+    get_s2s_info(Connections,Type).
+
+get_s2s_info(Connections,Type)->
+    complete_s2s_info(Connections,Type,[]).
+complete_s2s_info([],_,Result)->
+    Result;
+complete_s2s_info([Connection|T],Type,Result)->
+    {_,PID,_,_}=Connection,
+    State = get_s2s_state(PID),
+    complete_s2s_info(T,Type,[State|Result]).
+
+get_s2s_state(S2sPid)->
+    Infos = case gen_fsm:sync_send_all_state_event(S2sPid,get_state_infos) of
+		{state_infos, Is} -> [{status, open} | Is];
+		{noproc,_} -> [{status, closed}]; %% Connection closed
+		{badrpc,_} -> [{status, error}]
+	    end,
+    [{s2s_pid, S2sPid} | Infos].

src/ejabberd_s2s_in.erl

@@ -1,22 +1,39 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_s2s_in.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : Serve incoming s2s connection
-%%% Created :  6 Dec 2002 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created :  6 Dec 2002 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_s2s_in).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -behaviour(gen_fsm).
 
 %% External exports
 -export([start/2,
 	 start_link/2,
-	 become_controller/1,
-	 match_domain/2]).
+	 match_domain/2,
+	 socket_type/0]).
 
 %% gen_fsm callbacks
 -export([init/1,
@@ -31,15 +48,28 @@
 
 -include("ejabberd.hrl").
 -include("jlib.hrl").
+-ifdef(SSL40).
+-include_lib("public_key/include/public_key.hrl"). 
+-define(PKIXEXPLICIT, 'OTP-PUB-KEY').
+-define(PKIXIMPLICIT, 'OTP-PUB-KEY').
+-else.
+-ifdef(SSL39).
+-include_lib("ssl/include/ssl_pkix.hrl").
+-define(PKIXEXPLICIT, 'OTP-PKIX').
+-define(PKIXIMPLICIT, 'OTP-PKIX').
+-else.
 -include_lib("ssl/include/PKIX1Explicit88.hrl").
 -include_lib("ssl/include/PKIX1Implicit88.hrl").
+-define(PKIXEXPLICIT, 'PKIX1Explicit88').
+-define(PKIXIMPLICIT, 'PKIX1Implicit88').
+-endif.
+-endif.
 -include("XmppAddr.hrl").
 
 -define(DICT, dict).
 
 -record(state, {socket,
 		sockmod,
-		receiver,
 		streamid,
 		shaper,
 		tls = false,
@@ -59,6 +89,15 @@
 -define(FSMOPTS, []).
 -endif.
 
+%% Module start with or without supervisor:
+-ifdef(NO_TRANSIENT_SUPERVISORS).
+-define(SUPERVISOR_START, gen_fsm:start(ejabberd_s2s_in, [SockData, Opts],
+					?FSMOPTS)).
+-else.
+-define(SUPERVISOR_START, supervisor:start_child(ejabberd_s2s_in_sup,
+						 [SockData, Opts])).
+-endif.
+
 -define(STREAM_HEADER(Version),
 	("<?xml version='1.0'?>"
 	 "<stream:stream "
@@ -76,6 +115,9 @@
 -define(HOST_UNKNOWN_ERR,
 	xml:element_to_string(?SERR_HOST_UNKNOWN)).
 
+-define(INVALID_FROM_ERR,
+        xml:element_to_string(?SERR_INVALID_FROM)).
+
 -define(INVALID_XML_ERR,
 	xml:element_to_string(?SERR_XML_NOT_WELL_FORMED)).
 
@@ -83,13 +125,13 @@
 %%% API
 %%%----------------------------------------------------------------------
 start(SockData, Opts) ->
-    supervisor:start_child(ejabberd_s2s_in_sup, [SockData, Opts]).
+    ?SUPERVISOR_START.
 
 start_link(SockData, Opts) ->
     gen_fsm:start_link(ejabberd_s2s_in, [SockData, Opts], ?FSMOPTS).
 
-become_controller(Pid) ->
-    gen_fsm:send_all_state_event(Pid, become_controller).
+socket_type() ->
+    xml_stream.
 
 %%%----------------------------------------------------------------------
 %%% Callback functions from gen_fsm
@@ -100,21 +142,14 @@ become_controller(Pid) ->
 %% Returns: {ok, StateName, StateData}          |
 %%          {ok, StateName, StateData, Timeout} |
 %%          ignore                              |
-%%          {stop, StopReason}                   
+%%          {stop, StopReason}
 %%----------------------------------------------------------------------
 init([{SockMod, Socket}, Opts]) ->
-    ?INFO_MSG("started: ~p", [{SockMod, Socket}]),
+    ?DEBUG("started: ~p", [{SockMod, Socket}]),
     Shaper = case lists:keysearch(shaper, 1, Opts) of
 		 {value, {_, S}} -> S;
 		 _ -> none
 	     end,
-    MaxStanzaSize =
-	case lists:keysearch(max_stanza_size, 1, Opts) of
-	    {value, {_, Size}} -> Size;
-	    _ -> infinity
-	end,
-    ReceiverPid = ejabberd_receiver:start(
-		    Socket, SockMod, none, MaxStanzaSize),
     StartTLS = case ejabberd_config:get_local_option(s2s_use_starttls) of
 		   undefined ->
 		       false;
@@ -131,7 +166,6 @@ init([{SockMod, Socket}, Opts]) ->
     {ok, wait_for_stream,
      #state{socket = Socket,
 	    sockmod = SockMod,
-	    receiver = ReceiverPid,
 	    streamid = new_id(),
 	    shaper = Shaper,
 	    tls = StartTLS,
@@ -143,22 +177,24 @@ init([{SockMod, Socket}, Opts]) ->
 %% Func: StateName/2
 %% Returns: {next_state, NextStateName, NextStateData}          |
 %%          {next_state, NextStateName, NextStateData, Timeout} |
-%%          {stop, Reason, NewStateData}                         
+%%          {stop, Reason, NewStateData}
 %%----------------------------------------------------------------------
 
 wait_for_stream({xmlstreamstart, _Name, Attrs}, StateData) ->
     case {xml:get_attr_s("xmlns", Attrs),
 	  xml:get_attr_s("xmlns:db", Attrs),
+	  xml:get_attr_s("to", Attrs),
 	  xml:get_attr_s("version", Attrs) == "1.0"} of
-	{"jabber:server", "jabber:server:dialback", true} when
+	{"jabber:server", _, Server, true} when
 	      StateData#state.tls and (not StateData#state.authenticated) ->
 	    send_text(StateData, ?STREAM_HEADER(" version='1.0'")),
 	    SASL =
 		if
 		    StateData#state.tls_enabled ->
-			case tls:get_peer_certificate(StateData#state.socket) of
+			case (StateData#state.sockmod):get_peer_certificate(
+			       StateData#state.socket) of
 			    {ok, _Cert} ->
-				case tls:get_verify_result(
+				case (StateData#state.sockmod):get_verify_result(
 				       StateData#state.socket) of
 				    0 ->
 					[{xmlelement, "mechanisms",
@@ -183,15 +219,23 @@ wait_for_stream({xmlstreamstart, _Name, Attrs}, StateData) ->
 		       end,
 	    send_element(StateData,
 			 {xmlelement, "stream:features", [],
-			  SASL ++ StartTLS}),
+			  SASL ++ StartTLS ++
+			  ejabberd_hooks:run_fold(
+			    s2s_stream_features,
+			    Server,
+			    [], [Server])}),
 	    {next_state, wait_for_feature_request, StateData};
-	{"jabber:server", _, true} when
+	{"jabber:server", _, Server, true} when
 	      StateData#state.authenticated ->
 	    send_text(StateData, ?STREAM_HEADER(" version='1.0'")),
 	    send_element(StateData,
-			 {xmlelement, "stream:features", [], []}),
+			 {xmlelement, "stream:features", [],
+			  ejabberd_hooks:run_fold(
+			    s2s_stream_features,
+			    Server,
+			    [], [Server])}),
 	    {next_state, stream_established, StateData};
-	{"jabber:server", "jabber:server:dialback", _} ->
+	{"jabber:server", "jabber:server:dialback", _Server, _} ->
 	    send_text(StateData, ?STREAM_HEADER("")),
 	    {next_state, stream_established, StateData};
 	_ ->
@@ -215,21 +259,20 @@ wait_for_feature_request({xmlstreamelement, El}, StateData) ->
     {xmlelement, Name, Attrs, Els} = El,
     TLS = StateData#state.tls,
     TLSEnabled = StateData#state.tls_enabled,
-    SockMod = StateData#state.sockmod,
+    SockMod = (StateData#state.sockmod):get_sockmod(StateData#state.socket),
     case {xml:get_attr_s("xmlns", Attrs), Name} of
 	{?NS_TLS, "starttls"} when TLS == true,
 				   TLSEnabled == false,
 				   SockMod == gen_tcp ->
-	    ?INFO_MSG("starttls", []),
+	    ?DEBUG("starttls", []),
 	    Socket = StateData#state.socket,
 	    TLSOpts = StateData#state.tls_options,
-	    {ok, TLSSocket} = tls:tcp_to_tls(Socket, TLSOpts),
-	    ejabberd_receiver:starttls(StateData#state.receiver, TLSSocket),
-	    send_element(StateData,
-			 {xmlelement, "proceed", [{"xmlns", ?NS_TLS}], []}),
+	    TLSSocket = (StateData#state.sockmod):starttls(
+			  Socket, TLSOpts,
+			  xml:element_to_binary(
+			    {xmlelement, "proceed", [{"xmlns", ?NS_TLS}], []})),
 	    {next_state, wait_for_stream,
-	     StateData#state{sockmod = tls,
-			     socket = TLSSocket,
+	     StateData#state{socket = TLSSocket,
 			     streamid = new_id(),
 			     tls_enabled = true
 			    }};
@@ -240,9 +283,10 @@ wait_for_feature_request({xmlstreamelement, El}, StateData) ->
 		    Auth = jlib:decode_base64(xml:get_cdata(Els)),
 		    AuthDomain = jlib:nameprep(Auth),
 		    AuthRes =
-			case tls:get_peer_certificate(StateData#state.socket) of
+			case (StateData#state.sockmod):get_peer_certificate(
+			       StateData#state.socket) of
 			    {ok, Cert} ->
-				case tls:get_verify_result(
+				case (StateData#state.sockmod):get_verify_result(
 				       StateData#state.socket) of
 				    0 ->
 					case AuthDomain of
@@ -268,12 +312,12 @@ wait_for_feature_request({xmlstreamelement, El}, StateData) ->
 			end,
 		    if
 			AuthRes ->
-			    ejabberd_receiver:reset_stream(
-			      StateData#state.receiver),
+			    (StateData#state.sockmod):reset_stream(
+			      StateData#state.socket),
 			    send_element(StateData,
 					 {xmlelement, "success",
 					  [{"xmlns", ?NS_SASL}], []}),
-			    ?INFO_MSG("(~w) Accepted s2s authentication for ~s",
+			    ?DEBUG("(~w) Accepted s2s authentication for ~s",
 				      [StateData#state.socket, AuthDomain]),
 			    {next_state, wait_for_stream,
 			     StateData#state{streamid = new_id(),
@@ -315,11 +359,15 @@ stream_established({xmlstreamelement, El}, StateData) ->
     Timer = erlang:start_timer(?S2STIMEOUT, self(), []),
     case is_key_packet(El) of
 	{key, To, From, Id, Key} ->
-	    ?INFO_MSG("GET KEY: ~p", [{To, From, Id, Key}]),
+	    ?DEBUG("GET KEY: ~p", [{To, From, Id, Key}]),
 	    LTo = jlib:nameprep(To),
 	    LFrom = jlib:nameprep(From),
-	    case lists:member(LTo, ejabberd_router:dirty_get_all_domains()) of
-		true ->
+	    %% Checks if the from domain is allowed and if the to
+            %% domain is handled by this server:
+            case {ejabberd_s2s:allow_host(To, From),
+                  lists:member(LTo, ejabberd_router:dirty_get_all_domains())} of
+                {true, true} ->
+		    ejabberd_s2s_out:terminate_if_waiting_delay(To, From),
 		    ejabberd_s2s_out:start(To, From,
 					   {verify, self(),
 					    Key, StateData#state.streamid}),
@@ -330,18 +378,24 @@ stream_established({xmlstreamelement, El}, StateData) ->
 		     stream_established,
 		     StateData#state{connections = Conns,
 				     timer = Timer}};
-		_ ->
+		{_, false} ->
 		    send_text(StateData, ?HOST_UNKNOWN_ERR),
-		    {stop, normal, StateData}
+		    {stop, normal, StateData};
+                {false, _} ->
+                    send_text(StateData, ?INVALID_FROM_ERR),
+                    {stop, normal, StateData}
 	    end;
 	{verify, To, From, Id, Key} ->
-	    ?INFO_MSG("VERIFY KEY: ~p", [{To, From, Id, Key}]),
+	    ?DEBUG("VERIFY KEY: ~p", [{To, From, Id, Key}]),
 	    LTo = jlib:nameprep(To),
 	    LFrom = jlib:nameprep(From),
-	    Key1 = ejabberd_s2s:get_key({LTo, LFrom}),
-	    Type = if Key == Key1 -> "valid";
-		      true -> "invalid"
+	    Type = case ejabberd_s2s:has_key({LTo, LFrom}, Key) of
+		       true -> "valid";
+		       _ -> "invalid"
 		   end,
+	    %Type = if Key == Key1 -> "valid";
+	    % true -> "invalid"
+	    % end,
 	    send_element(StateData,
 			 {xmlelement,
 			  "db:verify",
@@ -373,6 +427,10 @@ stream_established({xmlstreamelement, El}, StateData) ->
 				    if ((Name == "iq") or
 					(Name == "message") or
 					(Name == "presence")) ->
+					    ejabberd_hooks:run(
+					      s2s_receive_packet,
+					      LTo,
+					      [From, To, NewEl]),
 					    ejabberd_router:route(
 					      From, To, NewEl);
 				       true ->
@@ -388,6 +446,10 @@ stream_established({xmlstreamelement, El}, StateData) ->
 				    if ((Name == "iq") or
 					(Name == "message") or
 					(Name == "presence")) ->
+					    ejabberd_hooks:run(
+					      s2s_receive_packet,
+					      LTo,
+					      [From, To, NewEl]),
 					    ejabberd_router:route(
 					      From, To, NewEl);
 				       true ->
@@ -400,6 +462,7 @@ stream_established({xmlstreamelement, El}, StateData) ->
 		true ->
 		    error
 	    end,
+	    ejabberd_hooks:run(s2s_loop_debug, [{xmlstreamelement, El}]),
 	    {next_state, stream_established, StateData#state{timer = Timer}}
     end;
 
@@ -456,7 +519,7 @@ stream_established(closed, StateData) ->
 %%          {reply, Reply, NextStateName, NextStateData}          |
 %%          {reply, Reply, NextStateName, NextStateData, Timeout} |
 %%          {stop, Reason, NewStateData}                          |
-%%          {stop, Reason, Reply, NewStateData}                    
+%%          {stop, Reason, Reply, NewStateData}
 %%----------------------------------------------------------------------
 %state_name(Event, From, StateData) ->
 %    Reply = ok,
@@ -466,16 +529,48 @@ stream_established(closed, StateData) ->
 %% Func: handle_event/3
 %% Returns: {next_state, NextStateName, NextStateData}          |
 %%          {next_state, NextStateName, NextStateData, Timeout} |
-%%          {stop, Reason, NewStateData}                         
+%%          {stop, Reason, NewStateData}
 %%----------------------------------------------------------------------
-handle_event(become_controller, StateName, StateData) ->
-    ok = (StateData#state.sockmod):controlling_process(
-	   StateData#state.socket,
-	   StateData#state.receiver),
-    ejabberd_receiver:become_controller(StateData#state.receiver),
-    {next_state, StateName, StateData};
 handle_event(_Event, StateName, StateData) ->
     {next_state, StateName, StateData}.
+%%----------------------------------------------------------------------
+%% Func: handle_sync_event/4
+%% Returns: The associated StateData for this connection
+%%   {reply, Reply, NextStateName, NextStateData}
+%%   Reply = {state_infos, [{InfoName::atom(), InfoValue::any()]
+%%----------------------------------------------------------------------
+handle_sync_event(get_state_infos, _From, StateName, StateData) ->
+    SockMod = StateData#state.sockmod,
+    {Addr,Port} = try SockMod:peername(StateData#state.socket) of
+		      {ok, {A,P}} ->  {A,P};
+		      {error, _} -> {unknown,unknown}
+		  catch
+		      _:_ -> {unknown,unknown}
+		  end,
+    Domains =	case StateData#state.authenticated of
+		    true -> 
+			[StateData#state.auth_domain];
+		    false ->
+			Connections = StateData#state.connections,
+			[D || {{D, _}, established} <- 
+			    dict:to_list(Connections)]
+		end,
+    Infos = [
+	     {direction, in},
+	     {statename, StateName},
+	     {addr, Addr},
+	     {port, Port},
+	     {streamid, StateData#state.streamid},
+	     {tls, StateData#state.tls},
+	     {tls_enabled, StateData#state.tls_enabled},
+	     {tls_options, StateData#state.tls_options},
+	     {authenticated, StateData#state.authenticated},
+	     {shaper, StateData#state.shaper},
+	     {sockmod, SockMod},
+	     {domains, Domains}
+	    ],
+    Reply = {state_infos, Infos},
+    {reply,Reply,StateName,StateData};
 
 %%----------------------------------------------------------------------
 %% Func: handle_sync_event/4
@@ -484,7 +579,7 @@ handle_event(_Event, StateName, StateData) ->
 %%          {reply, Reply, NextStateName, NextStateData}          |
 %%          {reply, Reply, NextStateName, NextStateData, Timeout} |
 %%          {stop, Reason, NewStateData}                          |
-%%          {stop, Reason, Reply, NewStateData}                    
+%%          {stop, Reason, Reply, NewStateData}
 %%----------------------------------------------------------------------
 handle_sync_event(_Event, _From, StateName, StateData) ->
     Reply = ok,
@@ -497,7 +592,7 @@ code_change(_OldVsn, StateName, StateData, _Extra) ->
 %% Func: handle_info/3
 %% Returns: {next_state, NextStateName, NextStateData}          |
 %%          {next_state, NextStateName, NextStateData, Timeout} |
-%%          {stop, Reason, NewStateData}                         
+%%          {stop, Reason, NewStateData}
 %%----------------------------------------------------------------------
 handle_info({send_text, Text}, StateName, StateData) ->
     send_text(StateData, Text),
@@ -517,8 +612,8 @@ handle_info(_, StateName, StateData) ->
 %% Returns: any
 %%----------------------------------------------------------------------
 terminate(Reason, _StateName, StateData) ->
-    ?INFO_MSG("terminated: ~p", [Reason]),
-    ejabberd_receiver:close(StateData#state.receiver),
+    ?DEBUG("terminated: ~p", [Reason]),
+    (StateData#state.sockmod):close(StateData#state.socket),
     ok.
 
 %%%----------------------------------------------------------------------
@@ -529,12 +624,12 @@ send_text(StateData, Text) ->
     (StateData#state.sockmod):send(StateData#state.socket, Text).
 
 send_element(StateData, El) ->
-    send_text(StateData, xml:element_to_string(El)).
+    send_text(StateData, xml:element_to_binary(El)).
 
 
 change_shaper(StateData, Host, JID) ->
     Shaper = acl:match_rule(Host, StateData#state.shaper, JID),
-    ejabberd_receiver:change_shaper(StateData#state.receiver, Shaper).
+    (StateData#state.sockmod):change_shaper(StateData#state.socket, Shaper).
 
 
 new_id() ->
@@ -574,7 +669,7 @@ get_cert_domains(Cert) ->
     lists:flatmap(
       fun(#'AttributeTypeAndValue'{type = ?'id-at-commonName',
 				   value = Val}) ->
-	      case 'PKIX1Explicit88':decode('X520CommonName', Val) of
+	      case ?PKIXEXPLICIT:decode('X520CommonName', Val) of
 		  {ok, {_, D1}} ->
 		      D = if
 			      is_list(D1) -> D1;
@@ -608,7 +703,7 @@ get_cert_domains(Cert) ->
 			     is_binary(Val) -> Val;
 			     true -> Val
 			 end,
-		  case 'PKIX1Implicit88':decode('SubjectAltName', BVal) of
+		  case ?PKIXIMPLICIT:decode('SubjectAltName', BVal) of
 		      {ok, SANs} ->
 			  lists:flatmap(
 			    fun({otherName,
@@ -683,5 +778,3 @@ match_labels([DL | DLabels], [PL | PLabels]) ->
 	false ->
 	    false
     end.
-
-

src/ejabberd_service.erl

@@ -1,23 +1,42 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_service.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
-%%% Purpose : 
-%%% Created :  6 Dec 2002 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
+%%% Purpose : External component management (XEP-0114)
+%%% Created :  6 Dec 2002 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_service).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
--behaviour(gen_fsm).
+-define(GEN_FSM, p1_fsm).
+
+-behaviour(?GEN_FSM).
 
 %% External exports
 -export([start/2,
 	 start_link/2,
 	 send_text/2,
 	 send_element/2,
-	 become_controller/1]).
+	 socket_type/0]).
 
 %% gen_fsm callbacks
 -export([init/1,
@@ -28,13 +47,15 @@
 	 handle_sync_event/4,
 	 code_change/4,
 	 handle_info/3,
-	 terminate/3]).
+	 terminate/3,
+     print_state/1]).
 
 -include("ejabberd.hrl").
 -include("jlib.hrl").
 
--record(state, {socket, receiver, streamid, sockmod,
-		hosts, password, access}).
+-record(state, {socket, sockmod, streamid,
+		hosts, password, access,
+		check_from}).
 
 %-define(DBGFSM, true).
 
@@ -55,13 +76,18 @@
 -define(STREAM_TRAILER, "</stream:stream>").
 
 -define(INVALID_HEADER_ERR,
-	"<stream:stream>"
+	"<stream:stream "
+	"xmlns:stream='http://etherx.jabber.org/streams'>"
 	"<stream:error>Invalid Stream Header</stream:error>"
 	"</stream:stream>"
        ).
 
 -define(INVALID_HANDSHAKE_ERR,
-	"<stream:error>Invalid Handshake</stream:error>"
+	"<stream:error>"
+	"<not-authorized xmlns='urn:ietf:params:xml:ns:xmpp-streams'/>"
+	"<text xmlns='urn:ietf:params:xml:ns:xmpp-streams' xml:lang='en'>"
+	"Invalid Handshake</text>"
+	"</stream:error>"
 	"</stream:stream>"
        ).
 
@@ -77,10 +103,11 @@ start(SockData, Opts) ->
     supervisor:start_child(ejabberd_service_sup, [SockData, Opts]).
 
 start_link(SockData, Opts) ->
-    gen_fsm:start_link(ejabberd_service, [SockData, Opts], ?FSMOPTS).
+    ?GEN_FSM:start_link(ejabberd_service, [SockData, Opts],
+			fsm_limit_opts(Opts) ++ ?FSMOPTS).
 
-become_controller(Pid) ->
-    gen_fsm:send_all_state_event(Pid, become_controller).
+socket_type() ->
+    xml_stream.
 
 %%%----------------------------------------------------------------------
 %%% Callback functions from gen_fsm
@@ -91,9 +118,10 @@ become_controller(Pid) ->
 %% Returns: {ok, StateName, StateData}          |
 %%          {ok, StateName, StateData, Timeout} |
 %%          ignore                              |
-%%          {stop, StopReason}                   
+%%          {stop, StopReason}
 %%----------------------------------------------------------------------
 init([{SockMod, Socket}, Opts]) ->
+    ?INFO_MSG("(~w) External service connected", [Socket]),
     Access = case lists:keysearch(access, 1, Opts) of
 		 {value, {_, A}} -> A;
 		 _ -> all
@@ -123,29 +151,41 @@ init([{SockMod, Socket}, Opts]) ->
 			false
 		end
 	end,
-    ReceiverPid = ejabberd_receiver:start(Socket, SockMod, none),
+    Shaper = case lists:keysearch(shaper_rule, 1, Opts) of
+		 {value, {_, S}} -> S;
+		 _ -> none
+	     end,
+    CheckFrom = case lists:keysearch(service_check_from, 1, Opts) of
+		 {value, {_, CF}} -> CF;
+		 _ -> true
+	     end,
+    SockMod:change_shaper(Socket, Shaper),
     {ok, wait_for_stream, #state{socket = Socket,
-				 receiver = ReceiverPid,
-				 streamid = new_id(),
 				 sockmod = SockMod,
+				 streamid = new_id(),
 				 hosts = Hosts,
 				 password = Password,
-				 access = Access
+				 access = Access,
+				 check_from = CheckFrom
 				 }}.
 
 %%----------------------------------------------------------------------
 %% Func: StateName/2
 %% Returns: {next_state, NextStateName, NextStateData}          |
 %%          {next_state, NextStateName, NextStateData, Timeout} |
-%%          {stop, Reason, NewStateData}                         
+%%          {stop, Reason, NewStateData}
 %%----------------------------------------------------------------------
 
 wait_for_stream({xmlstreamstart, _Name, Attrs}, StateData) ->
-    % TODO
     case xml:get_attr_s("xmlns", Attrs) of
 	"jabber:component:accept" ->
+	    %% Note: XEP-0114 requires to check that destination is a Jabber
+	    %% component served by this Jabber server.
+	    %% However several transports don't respect that,
+	    %% so ejabberd doesn't check 'to' attribute (EJAB-717)
+	    To = xml:get_attr_s("to", Attrs),
 	    Header = io_lib:format(?STREAM_HEADER,
-				   [StateData#state.streamid, ?MYNAME]),
+				   [StateData#state.streamid, xml:crypt(To)]),
 	    send_text(StateData, Header),
 	    {next_state, wait_for_handshake, StateData};
 	_ ->
@@ -174,7 +214,8 @@ wait_for_handshake({xmlstreamelement, El}, StateData) ->
 		    send_text(StateData, "<handshake/>"),
 		    lists:foreach(
 		      fun(H) ->
-			      ejabberd_router:register_route(H)
+			      ejabberd_router:register_route(H),
+			      ?INFO_MSG("Route registered for service ~p~n", [H])
 		      end, StateData#state.hosts),
 		    {next_state, stream_established, StateData};
 		_ ->
@@ -200,14 +241,23 @@ stream_established({xmlstreamelement, El}, StateData) ->
     NewEl = jlib:remove_attr("xmlns", El),
     {xmlelement, Name, Attrs, _Els} = NewEl,
     From = xml:get_attr_s("from", Attrs),
-    FromJID1 = jlib:string_to_jid(From),
-    FromJID = case FromJID1 of
-		  #jid{lserver = Server} ->
-		      case lists:member(Server, StateData#state.hosts) of
-			  true -> FromJID1;
-			  false -> error
-		      end;
-		  _ -> error
+    FromJID = case StateData#state.check_from of
+		  %% If the admin does not want to check the from field
+		  %% when accept packets from any address.
+		  %% In this case, the component can send packet of
+		  %% behalf of the server users.
+		  false -> jlib:string_to_jid(From);
+		  %% The default is the standard behaviour in XEP-0114
+		  _ ->
+		      FromJID1 = jlib:string_to_jid(From),
+		      case FromJID1 of
+			  #jid{lserver = Server} ->
+			      case lists:member(Server, StateData#state.hosts) of
+				  true -> FromJID1;
+				  false -> error
+			      end;
+			  _ -> error
+		      end
 	      end,
     To = xml:get_attr_s("to", Attrs),
     ToJID = case To of
@@ -247,7 +297,7 @@ stream_established(closed, StateData) ->
 %%          {reply, Reply, NextStateName, NextStateData}          |
 %%          {reply, Reply, NextStateName, NextStateData, Timeout} |
 %%          {stop, Reason, NewStateData}                          |
-%%          {stop, Reason, Reply, NewStateData}                    
+%%          {stop, Reason, Reply, NewStateData}
 %%----------------------------------------------------------------------
 %state_name(Event, From, StateData) ->
 %    Reply = ok,
@@ -257,14 +307,8 @@ stream_established(closed, StateData) ->
 %% Func: handle_event/3
 %% Returns: {next_state, NextStateName, NextStateData}          |
 %%          {next_state, NextStateName, NextStateData, Timeout} |
-%%          {stop, Reason, NewStateData}                         
+%%          {stop, Reason, NewStateData}
 %%----------------------------------------------------------------------
-handle_event(become_controller, StateName, StateData) ->
-    ok = (StateData#state.sockmod):controlling_process(
-	   StateData#state.socket,
-	   StateData#state.receiver),
-    ejabberd_receiver:become_controller(StateData#state.receiver),
-    {next_state, StateName, StateData};
 handle_event(_Event, StateName, StateData) ->
     {next_state, StateName, StateData}.
 
@@ -275,7 +319,7 @@ handle_event(_Event, StateName, StateData) ->
 %%          {reply, Reply, NextStateName, NextStateData}          |
 %%          {reply, Reply, NextStateName, NextStateData, Timeout} |
 %%          {stop, Reason, NewStateData}                          |
-%%          {stop, Reason, Reply, NewStateData}                    
+%%          {stop, Reason, Reply, NewStateData}
 %%----------------------------------------------------------------------
 handle_sync_event(_Event, _From, StateName, StateData) ->
     Reply = ok,
@@ -288,7 +332,7 @@ code_change(_OldVsn, StateName, StateData, _Extra) ->
 %% Func: handle_info/3
 %% Returns: {next_state, NextStateName, NextStateData}          |
 %%          {next_state, NextStateName, NextStateData, Timeout} |
-%%          {stop, Reason, NewStateData}                         
+%%          {stop, Reason, NewStateData}
 %%----------------------------------------------------------------------
 handle_info({send_text, Text}, StateName, StateData) ->
     send_text(StateData, Text),
@@ -303,11 +347,11 @@ handle_info({route, From, To, Packet}, StateName, StateData) ->
 	    Attrs2 = jlib:replace_from_to_attrs(jlib:jid_to_string(From),
 						jlib:jid_to_string(To),
 						Attrs),
-	    Text = xml:element_to_string({xmlelement, Name, Attrs2, Els}),
+	    Text = xml:element_to_binary({xmlelement, Name, Attrs2, Els}),
 	    send_text(StateData, Text);
 	deny ->
 	    Err = jlib:make_error_reply(Packet, ?ERR_NOT_ALLOWED),
-	    ejabberd_router:route(To, From, Err)
+	    ejabberd_router:route_error(To, From, Err, Packet)
     end,
     {next_state, StateName, StateData}.
 
@@ -328,20 +372,39 @@ terminate(Reason, StateName, StateData) ->
 	_ ->
 	    ok
     end,
-    ejabberd_receiver:close(StateData#state.receiver),
+    (StateData#state.sockmod):close(StateData#state.socket),
     ok.
 
+%%----------------------------------------------------------------------
+%% Func: print_state/1
+%% Purpose: Prepare the state to be printed on error log
+%% Returns: State to print
+%%----------------------------------------------------------------------
+print_state(State) ->
+    State.
+
 %%%----------------------------------------------------------------------
 %%% Internal functions
 %%%----------------------------------------------------------------------
 
 send_text(StateData, Text) ->
-    (StateData#state.sockmod):send(StateData#state.socket,Text).
+    (StateData#state.sockmod):send(StateData#state.socket, Text).
 
 send_element(StateData, El) ->
-    send_text(StateData, xml:element_to_string(El)).
-
+    send_text(StateData, xml:element_to_binary(El)).
 
 new_id() ->
     randoms:get_string().
 
+fsm_limit_opts(Opts) ->
+    case lists:keysearch(max_fsm_queue, 1, Opts) of
+	{value, {_, N}} when is_integer(N) ->
+	    [{max_queue, N}];
+	_ ->
+	    case ejabberd_config:get_local_option(max_fsm_queue) of
+		N when is_integer(N) ->
+		    [{max_queue, N}];
+		_ ->
+		    []
+	    end
+    end.

src/ejabberd_sm.erl

@@ -1,34 +1,59 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_sm.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : Session manager
-%%% Created : 24 Nov 2002 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created : 24 Nov 2002 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_sm).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -behaviour(gen_server).
 
 %% API
 -export([start_link/0,
 	 route/3,
-	 open_session/4, close_session/4,
+	 open_session/5, close_session/4,
+	 check_in_subscription/6,
 	 bounce_offline_message/3,
 	 disconnect_removed_user/2,
 	 get_user_resources/2,
-	 set_presence/5,
-	 unset_presence/5,
+	 set_presence/7,
+	 unset_presence/6,
 	 close_session_unset_presence/5,
 	 dirty_get_sessions_list/0,
 	 dirty_get_my_sessions_list/0,
 	 get_vh_session_list/1,
+	 get_vh_session_number/1,
 	 register_iq_handler/4,
 	 register_iq_handler/5,
 	 unregister_iq_handler/2,
-	 ctl_process/2
+	 force_update_presence/1,
+	 connected_users/0,
+	 connected_users_number/0,
+	 user_resources/2,
+	 get_session_pid/3,
+	 get_user_info/3,
+	 get_user_ip/3
 	]).
 
 %% gen_server callbacks
@@ -37,11 +62,16 @@
 
 -include("ejabberd.hrl").
 -include("jlib.hrl").
--include("ejabberd_ctl.hrl").
+-include("ejabberd_commands.hrl").
+-include("mod_privacy.hrl").
 
--record(session, {sid, usr, us, priority}).
+-record(session, {sid, usr, us, priority, info}).
+-record(session_counter, {vhost, count}).
 -record(state, {}).
 
+%% default value for the maximum number of user connections
+-define(MAX_USER_SESSIONS, infinity).
+
 %%====================================================================
 %% API
 %%====================================================================
@@ -61,20 +91,37 @@ route(From, To, Packet) ->
 	    ok
     end.
 
-open_session(SID, User, Server, Resource) ->
-    set_session(SID, User, Server, Resource, undefined),
+open_session(SID, User, Server, Resource, Info) ->
+    set_session(SID, User, Server, Resource, undefined, Info),
+    mnesia:dirty_update_counter(session_counter,
+				jlib:nameprep(Server), 1),
+    check_for_sessions_to_replace(User, Server, Resource),
     JID = jlib:make_jid(User, Server, Resource),
     ejabberd_hooks:run(sm_register_connection_hook, JID#jid.lserver,
-		       [SID, JID]).
+		       [SID, JID, Info]).
 
 close_session(SID, User, Server, Resource) ->
+    Info = case mnesia:dirty_read({session, SID}) of
+	[] -> [];
+	[#session{info=I}] -> I
+    end,
     F = fun() ->
-		mnesia:delete({session, SID})
-        end,
+		mnesia:delete({session, SID}),
+		mnesia:dirty_update_counter(session_counter,
+					    jlib:nameprep(Server), -1)
+	end,
     mnesia:sync_dirty(F),
     JID = jlib:make_jid(User, Server, Resource),
     ejabberd_hooks:run(sm_remove_connection_hook, JID#jid.lserver,
-		       [SID, JID]).
+		       [SID, JID, Info]).
+
+check_in_subscription(Acc, User, Server, _JID, _Type, _Reason) ->
+    case ejabberd_auth:is_user_exists(User, Server) of
+	true ->
+	    Acc;
+	false ->
+	    {stop, false}
+    end.
 
 bounce_offline_message(From, To, Packet) ->
     Err = jlib:make_error_reply(Packet, ?ERR_SERVICE_UNAVAILABLE),
@@ -98,11 +145,42 @@ get_user_resources(User, Server) ->
 	    [element(3, S#session.usr) || S <- clean_session_list(Ss)]
     end.
 
-set_presence(SID, User, Server, Resource, Priority) ->
-    set_session(SID, User, Server, Resource, Priority).
+get_user_ip(User, Server, Resource) ->
+    LUser = jlib:nodeprep(User),
+    LServer = jlib:nameprep(Server),
+    LResource = jlib:resourceprep(Resource),
+    USR = {LUser, LServer, LResource},
+    case mnesia:dirty_index_read(session, USR, #session.usr) of
+	[] ->
+	    undefined;
+	Ss ->
+	    Session = lists:max(Ss),
+	    proplists:get_value(ip, Session#session.info)
+    end.
 
-unset_presence(SID, User, Server, Resource, Status) ->
-    set_session(SID, User, Server, Resource, undefined),
+get_user_info(User, Server, Resource) ->
+    LUser = jlib:nodeprep(User),
+    LServer = jlib:nameprep(Server),
+    LResource = jlib:resourceprep(Resource),
+    USR = {LUser, LServer, LResource},
+    case mnesia:dirty_index_read(session, USR, #session.usr) of
+	[] ->
+	    offline;
+	Ss ->
+	    Session = lists:max(Ss),
+	    Node = node(element(2, Session#session.sid)),
+	    Conn = proplists:get_value(conn, Session#session.info),
+	    IP = proplists:get_value(ip, Session#session.info),
+	    [{node, Node}, {conn, Conn}, {ip, IP}]
+    end.
+
+set_presence(SID, User, Server, Resource, Priority, Presence, Info) ->
+    set_session(SID, User, Server, Resource, Priority, Info),
+    ejabberd_hooks:run(set_presence_hook, jlib:nameprep(Server),
+		       [User, Server, Resource, Presence]).
+
+unset_presence(SID, User, Server, Resource, Status, Info) ->
+    set_session(SID, User, Server, Resource, undefined, Info),
     ejabberd_hooks:run(unset_presence_hook, jlib:nameprep(Server),
 		       [User, Server, Resource, Status]).
 
@@ -111,6 +189,15 @@ close_session_unset_presence(SID, User, Server, Resource, Status) ->
     ejabberd_hooks:run(unset_presence_hook, jlib:nameprep(Server),
 		       [User, Server, Resource, Status]).
 
+get_session_pid(User, Server, Resource) ->
+    LUser = jlib:nodeprep(User),
+    LServer = jlib:nameprep(Server),
+    LResource = jlib:resourceprep(Resource),
+    USR = {LUser, LServer, LResource},
+    case catch mnesia:dirty_index_read(session, USR, #session.usr) of
+	[#session{sid = {_, Pid}}] -> Pid;
+	_ -> none
+    end.
 
 dirty_get_sessions_list() ->
     mnesia:dirty_select(
@@ -134,6 +221,19 @@ get_vh_session_list(Server) ->
 	[{'==', {element, 2, '$1'}, LServer}],
 	['$1']}]).
 
+get_vh_session_number(Server) ->
+    LServer = jlib:nameprep(Server),
+    Query = mnesia:dirty_select(
+		session_counter,
+		[{#session_counter{vhost = LServer, count = '$1'},
+		  [],
+		  ['$1']}]),
+    case Query of
+	[Count] ->
+	    Count;
+	_ -> 0
+    end.
+    
 register_iq_handler(Host, XMLNS, Module, Fun) ->
     ejabberd_sm ! {register_iq_handler, Host, XMLNS, Module, Fun}.
 
@@ -160,23 +260,26 @@ init([]) ->
     mnesia:create_table(session,
 			[{ram_copies, [node()]},
 			 {attributes, record_info(fields, session)}]),
+    mnesia:create_table(session_counter,
+			[{ram_copies, [node()]},
+			 {attributes, record_info(fields, session_counter)}]),
     mnesia:add_table_index(session, usr),
     mnesia:add_table_index(session, us),
     mnesia:add_table_copy(session, node(), ram_copies),
+    mnesia:add_table_copy(session_counter, node(), ram_copies),
     mnesia:subscribe(system),
     ets:new(sm_iqtable, [named_table]),
     lists:foreach(
       fun(Host) ->
+	      ejabberd_hooks:add(roster_in_subscription, Host,
+				 ejabberd_sm, check_in_subscription, 20),
 	      ejabberd_hooks:add(offline_message_hook, Host,
 				 ejabberd_sm, bounce_offline_message, 100),
 	      ejabberd_hooks:add(remove_user, Host,
 				 ejabberd_sm, disconnect_removed_user, 100)
       end, ?MYHOSTS),
-    ejabberd_ctl:register_commands(
-      [{"connected-users", "list all established sessions"},
-       {"connected-users-number", "print a number of established sessions"},
-       {"user-resources user server", "print user's connected resources"}],
-      ?MODULE, ctl_process),
+    ejabberd_commands:register_commands(commands()),
+
     {ok, #state{}}.
 
 %%--------------------------------------------------------------------
@@ -217,7 +320,7 @@ handle_info({route, From, To, Packet}, State) ->
     end,
     {noreply, State};
 handle_info({mnesia_system_event, {mnesia_down, Node}}, State) ->
-    clean_table_from_bad_node(Node),
+    recount_session_table(Node),
     {noreply, State};
 handle_info({register_iq_handler, Host, XMLNS, Module, Function}, State) ->
     ets:insert(sm_iqtable, {{XMLNS, Host}, Module, Function}),
@@ -245,6 +348,7 @@ handle_info(_Info, State) ->
 %% The return value is ignored.
 %%--------------------------------------------------------------------
 terminate(_Reason, _State) ->
+    ejabberd_commands:unregister_commands(commands()),
     ok.
 
 %%--------------------------------------------------------------------
@@ -258,7 +362,7 @@ code_change(_OldVsn, State, _Extra) ->
 %%% Internal functions
 %%--------------------------------------------------------------------
 
-set_session(SID, User, Server, Resource, Priority) ->
+set_session(SID, User, Server, Resource, Priority, Info) ->
     LUser = jlib:nodeprep(User),
     LServer = jlib:nameprep(Server),
     LResource = jlib:resourceprep(Resource),
@@ -268,27 +372,14 @@ set_session(SID, User, Server, Resource, Priority) ->
 		mnesia:write(#session{sid = SID,
 				      usr = USR,
 				      us = US,
-				      priority = Priority})
+				      priority = Priority,
+				      info = Info})
 	end,
-    mnesia:sync_dirty(F),
-    SIDs = mnesia:dirty_select(
-	     session,
-	     [{#session{sid = '$1', usr = USR, _ = '_'}, [], ['$1']}]),
-    if
-	SIDs == [] ->
-	    ok;
-	true ->
-	    MaxSID = lists:max(SIDs),
-	    lists:foreach(
-	      fun({_, Pid} = S) when S /= MaxSID ->
-		      Pid ! replaced;
-		 (_) ->
-		      ok
-	      end, SIDs)
-    end.
+    mnesia:sync_dirty(F).
 
-
-clean_table_from_bad_node(Node) ->
+%% Recalculates alive sessions when Node goes down 
+%% and updates session and session_counter tables 
+recount_session_table(Node) ->
     F = fun() ->
 		Es = mnesia:select(
 		       session,
@@ -297,13 +388,24 @@ clean_table_from_bad_node(Node) ->
 			 ['$_']}]),
 		lists:foreach(fun(E) ->
 				      mnesia:delete({session, E#session.sid})
-			      end, Es)
-        end,
-    mnesia:sync_dirty(F).
+			      end, Es),
+		%% reset session_counter table with active sessions
+		mnesia:clear_table(session_counter),
+		lists:foreach(fun(Server) ->
+				LServer = jlib:nameprep(Server),
+				Hs = mnesia:select(session,
+				    [{#session{usr = '$1', _ = '_'},
+				    [{'==', {element, 2, '$1'}, LServer}],
+				    ['$1']}]),
+				mnesia:write(
+				    #session_counter{vhost = LServer, 
+						     count = length(Hs)})
+			      end, ?MYHOSTS)
+	end,
+    mnesia:async_dirty(F).
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-
 do_route(From, To, Packet) ->
     ?DEBUG("session manager~n\tfrom ~p~n\tto ~p~n\tpacket ~P~n",
 	   [From, To, Packet, 8]),
@@ -314,76 +416,56 @@ do_route(From, To, Packet) ->
 	"" ->
 	    case Name of
 		"presence" ->
-		    {Pass, Subsc} =
+		    {Pass, _Subsc} =
 			case xml:get_attr_s("type", Attrs) of
 			    "subscribe" ->
-				{ejabberd_hooks:run_fold(
+				Reason = xml:get_path_s(
+					   Packet,
+					   [{elem, "status"}, cdata]),
+				{is_privacy_allow(From, To, Packet) andalso
+				 ejabberd_hooks:run_fold(
 				   roster_in_subscription,
 				   LServer,
 				   false,
-				   [User, Server, From, subscribe]),
+				   [User, Server, From, subscribe, Reason]),
 				 true};
 			    "subscribed" ->
-				{ejabberd_hooks:run_fold(
+				{is_privacy_allow(From, To, Packet) andalso
+				 ejabberd_hooks:run_fold(
 				   roster_in_subscription,
 				   LServer,
 				   false,
-				   [User, Server, From, subscribed]),
+				   [User, Server, From, subscribed, ""]),
 				 true};
 			    "unsubscribe" ->
-				{ejabberd_hooks:run_fold(
+				{is_privacy_allow(From, To, Packet) andalso
+				 ejabberd_hooks:run_fold(
 				   roster_in_subscription,
 				   LServer,
 				   false,
-				   [User, Server, From, unsubscribe]),
+				   [User, Server, From, unsubscribe, ""]),
 				 true};
 			    "unsubscribed" ->
-				{ejabberd_hooks:run_fold(
+				{is_privacy_allow(From, To, Packet) andalso
+				 ejabberd_hooks:run_fold(
 				   roster_in_subscription,
 				   LServer,
 				   false,
-				   [User, Server, From, unsubscribed]),
+				   [User, Server, From, unsubscribed, ""]),
 				 true};
 			    _ ->
 				{true, false}
 			end,
 		    if Pass ->
-			    LFrom = jlib:jid_tolower(From),
 			    PResources = get_user_present_resources(
 					   LUser, LServer),
-			    if
-				PResources /= [] ->
-				    lists:foreach(
-				      fun({_, R}) ->
-					      if LFrom /=
-						 {LUser, LServer, R} ->
-						      do_route(
-							From,
-							jlib:jid_replace_resource(To, R),
-							Packet);
-						 true ->
-						      ok
-					      end
-				      end, PResources);
-				true ->
-				    if
-					Subsc ->
-					    case ejabberd_auth:is_user_exists(
-						   LUser, LServer) of
-						true ->
-						    ejabberd_hooks:run(
-						      offline_subscription_hook,
-						      LServer,
-						      [From, To, Packet]);
-						_ ->
-						    Err = jlib:make_error_reply(
-							    Packet, ?ERR_SERVICE_UNAVAILABLE),
-						    ejabberd_router:route(To, From, Err)
-					    end;
-					true ->
-					    ok
-				    end
-			    end;
+			    lists:foreach(
+			      fun({_, R}) ->
+				      do_route(
+					From,
+					jlib:jid_replace_resource(To, R),
+					Packet)
+			      end, PResources);
 		       true ->
 			    ok
 		    end;
@@ -415,7 +497,7 @@ do_route(From, To, Packet) ->
 				_ ->
 				    Err =
 					jlib:make_error_reply(
-					  Packet, ?ERR_RECIPIENT_UNAVAILABLE),
+					  Packet, ?ERR_SERVICE_UNAVAILABLE),
 				    ejabberd_router:route(To, From, Err)
 			    end;
 			_ ->
@@ -429,6 +511,31 @@ do_route(From, To, Packet) ->
 	    end
     end.
 
+%% The default list applies to the user as a whole,
+%% and is processed if there is no active list set
+%% for the target session/resource to which a stanza is addressed,
+%% or if there are no current sessions for the user.
+is_privacy_allow(From, To, Packet) ->
+    User = To#jid.user,
+    Server = To#jid.server,
+    PrivacyList = ejabberd_hooks:run_fold(privacy_get_user_list, Server,
+					  #userlist{}, [User, Server]),
+    is_privacy_allow(From, To, Packet, PrivacyList).
+
+%% Check if privacy rules allow this delivery
+%% Function copied from ejabberd_c2s.erl
+is_privacy_allow(From, To, Packet, PrivacyList) ->
+    User = To#jid.user,
+    Server = To#jid.server,
+    allow == ejabberd_hooks:run_fold(
+	       privacy_check_packet, Server,
+	       allow,
+	       [User,
+		Server,
+		PrivacyList,
+		{From, To, Packet},
+		in]).
+
 route_message(From, To, Packet) ->
     LUser = To#jid.luser,
     LServer = To#jid.lserver,
@@ -443,7 +550,7 @@ route_message(From, To, Packet) ->
 		      USR = {LUser, LServer, LResource},
 		      case mnesia:dirty_index_read(session, USR, #session.usr) of
 			  [] ->
-			      ok;				% Race condition
+			      ok; % Race condition
 			  Ss ->
 			      Session = lists:max(Ss),
 			      Pid = element(2, Session#session.sid),
@@ -459,12 +566,21 @@ route_message(From, To, Packet) ->
 	    case xml:get_tag_attr_s("type", Packet) of
 		"error" ->
 		    ok;
+		"groupchat" ->
+		    bounce_offline_message(From, To, Packet);
+		"headline" ->
+		    bounce_offline_message(From, To, Packet);
 		_ ->
 		    case ejabberd_auth:is_user_exists(LUser, LServer) of
 			true ->
-			    ejabberd_hooks:run(offline_message_hook,
-					       LServer,
-					       [From, To, Packet]);
+			    case is_privacy_allow(From, To, Packet) of
+				true ->
+				    ejabberd_hooks:run(offline_message_hook,
+						       LServer,
+						       [From, To, Packet]);
+				false ->
+				    ok
+			    end;
 			_ ->
 			    Err = jlib:make_error_reply(
 				    Packet, ?ERR_SERVICE_UNAVAILABLE),
@@ -509,6 +625,64 @@ get_user_present_resources(LUser, LServer) ->
 		S <- clean_session_list(Ss), is_integer(S#session.priority)]
     end.
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%% On new session, check if some existing connections need to be replace
+check_for_sessions_to_replace(User, Server, Resource) ->
+    LUser = jlib:nodeprep(User),
+    LServer = jlib:nameprep(Server),
+    LResource = jlib:resourceprep(Resource),
+
+    %% TODO: Depending on how this is executed, there could be an unneeded
+    %% replacement for max_sessions. We need to check this at some point.
+    check_existing_resources(LUser, LServer, LResource),
+    check_max_sessions(LUser, LServer).
+
+check_existing_resources(LUser, LServer, LResource) ->
+    USR = {LUser, LServer, LResource},
+    %% A connection exist with the same resource. We replace it:
+    SIDs = mnesia:dirty_select(
+	     session,
+	     [{#session{sid = '$1', usr = USR, _ = '_'}, [], ['$1']}]),
+    if
+	SIDs == [] -> ok;
+	true ->
+	    MaxSID = lists:max(SIDs),
+	    lists:foreach(
+	      fun({_, Pid} = S) when S /= MaxSID ->
+		      Pid ! replaced;
+		 (_) -> ok
+	      end, SIDs)
+    end.
+
+check_max_sessions(LUser, LServer) ->
+    %% If the max number of sessions for a given is reached, we replace the
+    %% first one
+    SIDs = mnesia:dirty_select(
+	     session,
+	     [{#session{sid = '$1', us = {LUser, LServer}, _ = '_'}, [],
+	       ['$1']}]),
+    MaxSessions = get_max_user_sessions(LUser, LServer),
+    if
+	length(SIDs) =< MaxSessions ->
+	    ok;
+	true ->
+	    {_, Pid} = lists:min(SIDs),
+	    Pid ! replaced
+    end.
+
+
+%% Get the user_max_session setting
+%% This option defines the max number of time a given users are allowed to
+%% log in
+%% Defaults to infinity
+get_max_user_sessions(LUser, Host) ->
+    case acl:match_rule(
+	   Host, max_user_sessions, jlib:make_jid(LUser, Host, "")) of
+	Max when is_integer(Max) -> Max;
+	infinity -> infinity;
+	_ -> ?MAX_USER_SESSIONS
+    end.
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -532,7 +706,7 @@ process_iq(From, To, Packet) ->
 					  From, To, IQ);
 		[] ->
 		    Err = jlib:make_error_reply(
-			    Packet, ?ERR_FEATURE_NOT_IMPLEMENTED),
+			    Packet, ?ERR_SERVICE_UNAVAILABLE),
 		    ejabberd_router:route(To, From, Err)
 	    end;
 	reply ->
@@ -543,28 +717,57 @@ process_iq(From, To, Packet) ->
 	    ok
     end.
 
+force_update_presence({LUser, _LServer} = US) ->
+    case catch mnesia:dirty_index_read(session, US, #session.us) of
+        {'EXIT', _Reason} ->
+            ok;
+        Ss ->
+            lists:foreach(fun(#session{sid = {_, Pid}}) ->
+                                  Pid ! {force_update_presence, LUser}
+                          end, Ss)
+    end.
 
-ctl_process(_Val, ["connected-users"]) ->
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%% ejabberd commands
+
+commands() ->
+	[
+     #ejabberd_commands{name = connected_users,
+		       tags = [session],
+		       desc = "List all established sessions",
+		       module = ?MODULE, function = connected_users,
+		       args = [],
+		       result = {connected_users, {list, {sessions, string}}}},
+     #ejabberd_commands{name = connected_users_number,
+		       tags = [session, stats],
+		       desc = "Get the number of established sessions",
+		       module = ?MODULE, function = connected_users_number,
+		       args = [],
+		       result = {num_sessions, integer}},
+     #ejabberd_commands{name = user_resources,
+		       tags = [session],
+		       desc = "List user's connected resources",
+		       module = ?MODULE, function = user_resources,
+		       args = [{user, string}, {host, string}],
+		       result = {resources, {list, {resource, string}}}}
+	].
+
+connected_users() ->
     USRs = dirty_get_sessions_list(),
-    NewLine = io_lib:format("~n", []),
     SUSRs = lists:sort(USRs),
-    FUSRs = lists:map(fun({U, S, R}) -> [U, $@, S, $/, R, NewLine] end, SUSRs),
-    io:format("~s", [FUSRs]),
-    {stop, ?STATUS_SUCCESS};
-ctl_process(_Val, ["connected-users-number"]) ->
-    N = length(dirty_get_sessions_list()),
-    io:format("~p~n", [N]),
-    {stop, ?STATUS_SUCCESS};
-ctl_process(_Val, ["user-resources", User, Server]) ->
-    Resources =  get_user_resources(User, Server),
-    NewLine = io_lib:format("~n", []),
-    SResources = lists:sort(Resources),
-    FResources = lists:map(fun(R) -> [R, NewLine] end, SResources),
-    io:format("~s", [FResources]),
-    {stop, ?STATUS_SUCCESS};
-ctl_process(Val, _Args) ->
-    Val.
+    lists:map(fun({U, S, R}) -> [U, $@, S, $/, R] end, SUSRs).
 
+connected_users_number() ->
+    length(dirty_get_sessions_list()).
+
+user_resources(User, Server) ->
+    Resources =  get_user_resources(User, Server),
+    lists:sort(Resources).
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%% Update Mnesia tables
 
 update_tables() ->
     case catch mnesia:table_info(session, attributes) of
@@ -575,6 +778,8 @@ update_tables() ->
 	[usr, us, pid] ->
 	    mnesia:delete_table(session);
 	[sid, usr, us, priority] ->
+	    mnesia:delete_table(session);
+	[sid, usr, us, priority, info] ->
 	    ok;
 	{'EXIT', _} ->
 	    ok
@@ -591,4 +796,3 @@ update_tables() ->
 	false ->
 	    ok
     end.
-

src/ejabberd_socket.erl

@@ -0,0 +1,227 @@
+%%%----------------------------------------------------------------------
+%%% File    : ejabberd_socket.erl
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
+%%% Purpose : Socket with zlib and TLS support library
+%%% Created : 23 Aug 2006 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%----------------------------------------------------------------------
+
+-module(ejabberd_socket).
+-author('alexey@process-one.net').
+
+%% API
+-export([start/4,
+	 connect/3,
+	 connect/4,
+	 starttls/2,
+	 starttls/3,
+	 compress/1,
+	 compress/2,
+	 reset_stream/1,
+	 send/2,
+	 send_xml/2,
+	 change_shaper/2,
+	 monitor/1,
+	 get_sockmod/1,
+	 get_peer_certificate/1,
+	 get_verify_result/1,
+	 close/1,
+	 sockname/1, peername/1]).
+
+-include("ejabberd.hrl").
+
+-record(socket_state, {sockmod, socket, receiver}).
+
+%%====================================================================
+%% API
+%%====================================================================
+%%--------------------------------------------------------------------
+%% Function:
+%% Description:
+%%--------------------------------------------------------------------
+start(Module, SockMod, Socket, Opts) ->
+    case Module:socket_type() of
+	xml_stream ->
+	    MaxStanzaSize =
+		case lists:keysearch(max_stanza_size, 1, Opts) of
+		    {value, {_, Size}} -> Size;
+		    _ -> infinity
+		end,
+	    {ReceiverMod, Receiver, RecRef} =
+		case catch SockMod:custom_receiver(Socket) of
+		    {receiver, RecMod, RecPid} ->
+			{RecMod, RecPid, RecMod};
+		    _ ->
+			RecPid = ejabberd_receiver:start(
+				   Socket, SockMod, none, MaxStanzaSize),
+			{ejabberd_receiver, RecPid, RecPid}
+		end,
+	    SocketData = #socket_state{sockmod = SockMod,
+				       socket = Socket,
+				       receiver = RecRef},
+	    case Module:start({?MODULE, SocketData}, Opts) of
+		{ok, Pid} ->
+		    case SockMod:controlling_process(Socket, Receiver) of
+			ok ->
+			    ok;
+			{error, _Reason} ->
+			    SockMod:close(Socket)
+		    end,
+		    ReceiverMod:become_controller(Receiver, Pid);
+		{error, _Reason} ->
+		    SockMod:close(Socket)
+	    end;
+	independent ->
+	    ok;
+	raw ->
+	    case Module:start({SockMod, Socket}, Opts) of
+		{ok, Pid} ->
+		    case SockMod:controlling_process(Socket, Pid) of
+			ok ->
+			    ok;
+			{error, _Reason} ->
+			    SockMod:close(Socket)
+		    end;
+		{error, _Reason} ->
+		    SockMod:close(Socket)
+	    end
+    end.
+
+connect(Addr, Port, Opts) ->
+    connect(Addr, Port, Opts, infinity).
+
+connect(Addr, Port, Opts, Timeout) ->
+    case gen_tcp:connect(Addr, Port, Opts, Timeout) of
+	{ok, Socket} ->
+	    Receiver = ejabberd_receiver:start(Socket, gen_tcp, none),
+	    SocketData = #socket_state{sockmod = gen_tcp,
+				       socket = Socket,
+				       receiver = Receiver},
+	    Pid = self(),
+	    case gen_tcp:controlling_process(Socket, Receiver) of
+		ok ->
+		    ejabberd_receiver:become_controller(Receiver, Pid),
+		    {ok, SocketData};
+		{error, _Reason} = Error ->
+		    gen_tcp:close(Socket),
+		    Error
+	    end;
+	{error, _Reason} = Error ->
+	    Error
+    end.
+
+starttls(SocketData, TLSOpts) ->
+    {ok, TLSSocket} = tls:tcp_to_tls(SocketData#socket_state.socket, TLSOpts),
+    ejabberd_receiver:starttls(SocketData#socket_state.receiver, TLSSocket),
+    SocketData#socket_state{socket = TLSSocket, sockmod = tls}.
+
+starttls(SocketData, TLSOpts, Data) ->
+    {ok, TLSSocket} = tls:tcp_to_tls(SocketData#socket_state.socket, TLSOpts),
+    ejabberd_receiver:starttls(SocketData#socket_state.receiver, TLSSocket),
+    send(SocketData, Data),
+    SocketData#socket_state{socket = TLSSocket, sockmod = tls}.
+
+compress(SocketData) ->
+    {ok, ZlibSocket} = ejabberd_zlib:enable_zlib(
+			 SocketData#socket_state.sockmod,
+			 SocketData#socket_state.socket),
+    ejabberd_receiver:compress(SocketData#socket_state.receiver, ZlibSocket),
+    SocketData#socket_state{socket = ZlibSocket, sockmod = ejabberd_zlib}.
+
+compress(SocketData, Data) ->
+    {ok, ZlibSocket} = ejabberd_zlib:enable_zlib(
+			 SocketData#socket_state.sockmod,
+			 SocketData#socket_state.socket),
+    ejabberd_receiver:compress(SocketData#socket_state.receiver, ZlibSocket),
+    send(SocketData, Data),
+    SocketData#socket_state{socket = ZlibSocket, sockmod = ejabberd_zlib}.
+
+reset_stream(SocketData) when is_pid(SocketData#socket_state.receiver) ->
+    ejabberd_receiver:reset_stream(SocketData#socket_state.receiver);
+reset_stream(SocketData) when is_atom(SocketData#socket_state.receiver) ->
+    (SocketData#socket_state.receiver):reset_stream(
+      SocketData#socket_state.socket).
+
+%% sockmod=gen_tcp|tls|ejabberd_zlib
+send(SocketData, Data) ->
+    case catch (SocketData#socket_state.sockmod):send(
+	     SocketData#socket_state.socket, Data) of
+        ok -> ok;
+	{error, timeout} ->
+	    ?INFO_MSG("Timeout on ~p:send",[SocketData#socket_state.sockmod]),
+	    exit(normal);
+        Error ->
+	    ?DEBUG("Error in ~p:send: ~p",[SocketData#socket_state.sockmod, Error]),
+	    exit(normal)
+    end.
+
+%% Can only be called when in c2s StateData#state.xml_socket is true
+%% This function is used for HTTP bind
+%% sockmod=ejabberd_http_poll|ejabberd_http_bind or any custom module
+send_xml(SocketData, Data) ->
+    catch (SocketData#socket_state.sockmod):send_xml(
+	    SocketData#socket_state.socket, Data).
+
+change_shaper(SocketData, Shaper)
+  when is_pid(SocketData#socket_state.receiver) ->
+    ejabberd_receiver:change_shaper(SocketData#socket_state.receiver, Shaper);
+change_shaper(SocketData, Shaper)
+  when is_atom(SocketData#socket_state.receiver) ->
+    (SocketData#socket_state.receiver):change_shaper(
+      SocketData#socket_state.socket, Shaper).
+
+monitor(SocketData) when is_pid(SocketData#socket_state.receiver) ->
+    erlang:monitor(process, SocketData#socket_state.receiver);
+monitor(SocketData) when is_atom(SocketData#socket_state.receiver) ->
+    (SocketData#socket_state.receiver):monitor(
+      SocketData#socket_state.socket).
+
+get_sockmod(SocketData) ->
+    SocketData#socket_state.sockmod.
+
+get_peer_certificate(SocketData) ->
+    tls:get_peer_certificate(SocketData#socket_state.socket).
+
+get_verify_result(SocketData) ->
+    tls:get_verify_result(SocketData#socket_state.socket).
+
+close(SocketData) ->
+    ejabberd_receiver:close(SocketData#socket_state.receiver).
+
+sockname(#socket_state{sockmod = SockMod, socket = Socket}) ->
+    case SockMod of
+	gen_tcp ->
+	    inet:sockname(Socket);
+	_ ->
+	    SockMod:sockname(Socket)
+    end.
+
+peername(#socket_state{sockmod = SockMod, socket = Socket}) ->
+    case SockMod of
+	gen_tcp ->
+	    inet:peername(Socket);
+	_ ->
+	    SockMod:peername(Socket)
+    end.
+
+%%====================================================================
+%% Internal functions
+%%====================================================================

src/ejabberd_sup.erl

@@ -1,14 +1,31 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_sup.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
-%%% Purpose : 
-%%% Created : 31 Jan 2003 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
+%%% Purpose : Erlang/OTP supervisor
+%%% Created : 31 Jan 2003 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_sup).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -behaviour(supervisor).
 
@@ -17,7 +34,6 @@
 start_link() ->
     supervisor:start_link({local, ?MODULE}, ?MODULE, []).
 
-
 init([]) ->
     Hooks =
 	{ejabberd_hooks,
@@ -26,13 +42,20 @@ init([]) ->
 	 brutal_kill,
 	 worker,
 	 [ejabberd_hooks]},
-    StringPrep =
-	{stringprep,
-	 {stringprep, start_link, []},
+    NodeGroups =
+	{ejabberd_node_groups,
+	 {ejabberd_node_groups, start_link, []},
 	 permanent,
 	 brutal_kill,
 	 worker,
-	 [stringprep]},
+	 [ejabberd_node_groups]},
+    SystemMonitor =
+	{ejabberd_system_monitor,
+	 {ejabberd_system_monitor, start_link, []},
+	 permanent,
+	 brutal_kill,
+	 worker,
+	 [ejabberd_system_monitor]},
     Router =
 	{ejabberd_router,
 	 {ejabberd_router, start_link, []},
@@ -61,6 +84,13 @@ init([]) ->
 	 brutal_kill,
 	 worker,
 	 [ejabberd_local]},
+    Captcha =
+	{ejabberd_captcha,
+	 {ejabberd_captcha, start_link, []},
+	 permanent,
+	 brutal_kill,
+	 worker,
+	 [ejabberd_captcha]},
     Listener =
 	{ejabberd_listener,
 	 {ejabberd_listener, start_link, []},
@@ -123,6 +153,14 @@ init([]) ->
 	 infinity,
 	 supervisor,
 	 [ejabberd_tmp_sup]},
+    FrontendSocketSupervisor =
+	{ejabberd_frontend_socket_sup,
+	 {ejabberd_tmp_sup, start_link,
+	  [ejabberd_frontend_socket_sup, ejabberd_frontend_socket]},
+	 permanent,
+	 infinity,
+	 supervisor,
+	 [ejabberd_tmp_sup]},
     IQSupervisor =
 	{ejabberd_iq_sup,
 	 {ejabberd_tmp_sup, start_link,
@@ -131,13 +169,23 @@ init([]) ->
 	 infinity,
 	 supervisor,
 	 [ejabberd_tmp_sup]},
+    STUNSupervisor =
+	{ejabberd_stun_sup,
+	 {ejabberd_tmp_sup, start_link,
+	  [ejabberd_stun_sup, ejabberd_stun]},
+	 permanent,
+	 infinity,
+	 supervisor,
+	 [ejabberd_tmp_sup]},
     {ok, {{one_for_one, 10, 1},
 	  [Hooks,
-	   StringPrep,
+	   NodeGroups,
+	   SystemMonitor,
 	   Router,
 	   SM,
 	   S2S,
 	   Local,
+	   Captcha,
 	   ReceiverSupervisor,
 	   C2SSupervisor,
 	   S2SInSupervisor,
@@ -146,6 +194,8 @@ init([]) ->
 	   HTTPSupervisor,
 	   HTTPPollSupervisor,
 	   IQSupervisor,
+	   STUNSupervisor,
+	   FrontendSocketSupervisor,
 	   Listener]}}.
 
 

src/ejabberd_system_monitor.erl

@@ -0,0 +1,367 @@
+%%%-------------------------------------------------------------------
+%%% File    : ejabberd_system_monitor.erl
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
+%%% Description : Ejabberd watchdog
+%%% Created : 21 Mar 2007 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
+%%%-------------------------------------------------------------------
+
+-module(ejabberd_system_monitor).
+-author('alexey@process-one.net').
+
+-behaviour(gen_server).
+
+%% API
+-export([start_link/0,
+	 process_command/3,
+	 process_remote_command/1]).
+
+%% gen_server callbacks
+-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
+	 terminate/2, code_change/3]).
+
+-include("ejabberd.hrl").
+-include("jlib.hrl").
+
+-record(state, {}).
+
+%%====================================================================
+%% API
+%%====================================================================
+%%--------------------------------------------------------------------
+%% Function: start_link() -> {ok,Pid} | ignore | {error,Error}
+%% Description: Starts the server
+%%--------------------------------------------------------------------
+start_link() ->
+    LH = case ejabberd_config:get_local_option(watchdog_large_heap) of
+	I when is_integer(I) -> I;
+	_ -> 1000000
+end,
+    Opts = [{large_heap, LH}],
+    gen_server:start_link({local, ?MODULE}, ?MODULE, Opts, []).
+
+process_command(From, To, Packet) ->
+    case To of
+	#jid{luser = "", lresource = "watchdog"} ->
+	    {xmlelement, Name, _Attrs, _Els} = Packet,
+	    case Name of
+		"message" ->
+		    LFrom = jlib:jid_tolower(jlib:jid_remove_resource(From)),
+		    case lists:member(LFrom, get_admin_jids()) of
+			true ->
+			    Body = xml:get_path_s(
+				     Packet, [{elem, "body"}, cdata]),
+			    spawn(fun() ->
+					  process_flag(priority, high),
+					  process_command1(From, To, Body)
+				  end),
+			    stop;
+			false ->
+			    ok
+		    end;
+		_ ->
+		    ok
+	    end;
+	_ ->
+	    ok
+    end.
+
+%%====================================================================
+%% gen_server callbacks
+%%====================================================================
+
+%%--------------------------------------------------------------------
+%% Function: init(Args) -> {ok, State} |
+%%                         {ok, State, Timeout} |
+%%                         ignore               |
+%%                         {stop, Reason}
+%% Description: Initiates the server
+%%--------------------------------------------------------------------
+init(Opts) ->
+    LH = proplists:get_value(large_heap, Opts),
+    process_flag(priority, high),
+    erlang:system_monitor(self(), [{large_heap, LH}]),
+    lists:foreach(
+      fun(Host) ->
+	      ejabberd_hooks:add(local_send_to_resource_hook, Host,
+				 ?MODULE, process_command, 50)
+      end, ?MYHOSTS),
+    {ok, #state{}}.
+
+%%--------------------------------------------------------------------
+%% Function: %% handle_call(Request, From, State) -> {reply, Reply, State} |
+%%                                      {reply, Reply, State, Timeout} |
+%%                                      {noreply, State} |
+%%                                      {noreply, State, Timeout} |
+%%                                      {stop, Reason, Reply, State} |
+%%                                      {stop, Reason, State}
+%% Description: Handling call messages
+%%--------------------------------------------------------------------
+handle_call({get, large_heap}, _From, State) ->
+    {reply, get_large_heap(), State};
+handle_call({set, large_heap, NewValue}, _From, State) ->
+    MonSettings = erlang:system_monitor(self(), [{large_heap, NewValue}]),
+    OldLH = get_large_heap(MonSettings),
+    NewLH = get_large_heap(),
+    {reply, {lh_changed, OldLH, NewLH}, State};
+handle_call(_Request, _From, State) ->
+    Reply = ok,
+    {reply, Reply, State}.
+
+get_large_heap() ->
+    MonSettings = erlang:system_monitor(),
+    get_large_heap(MonSettings).
+get_large_heap(MonSettings) ->
+    {_MonitorPid, Options} = MonSettings,
+    proplists:get_value(large_heap, Options).
+
+%%--------------------------------------------------------------------
+%% Function: handle_cast(Msg, State) -> {noreply, State} |
+%%                                      {noreply, State, Timeout} |
+%%                                      {stop, Reason, State}
+%% Description: Handling cast messages
+%%--------------------------------------------------------------------
+handle_cast(_Msg, State) ->
+    {noreply, State}.
+
+%%--------------------------------------------------------------------
+%% Function: handle_info(Info, State) -> {noreply, State} |
+%%                                       {noreply, State, Timeout} |
+%%                                       {stop, Reason, State}
+%% Description: Handling all non call/cast messages
+%%--------------------------------------------------------------------
+handle_info({monitor, Pid, large_heap, Info}, State) ->
+    spawn(fun() ->
+		  process_flag(priority, high),
+		  process_large_heap(Pid, Info)
+	  end),
+    {noreply, State};
+handle_info(_Info, State) ->
+    {noreply, State}.
+
+%%--------------------------------------------------------------------
+%% Function: terminate(Reason, State) -> void()
+%% Description: This function is called by a gen_server when it is about to
+%% terminate. It should be the opposite of Module:init/1 and do any necessary
+%% cleaning up. When it returns, the gen_server terminates with Reason.
+%% The return value is ignored.
+%%--------------------------------------------------------------------
+terminate(_Reason, _State) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% Func: code_change(OldVsn, State, Extra) -> {ok, NewState}
+%% Description: Convert process state when code is changed
+%%--------------------------------------------------------------------
+code_change(_OldVsn, State, _Extra) ->
+    {ok, State}.
+
+%%--------------------------------------------------------------------
+%%% Internal functions
+%%--------------------------------------------------------------------
+
+process_large_heap(Pid, Info) ->
+    Host = ?MYNAME,
+    case ejabberd_config:get_local_option(watchdog_admins) of
+	JIDs when is_list(JIDs),
+		  JIDs /= [] ->
+	    DetailedInfo = detailed_info(Pid),
+	    Body = io_lib:format(
+		     "(~w) The process ~w is consuming too much memory:~n~p~n"
+		     "~s",
+		     [node(), Pid, Info, DetailedInfo]),
+	    From = jlib:make_jid("", Host, "watchdog"),
+	    lists:foreach(
+	      fun(S) ->
+		      case jlib:string_to_jid(S) of
+			  error -> ok;
+			  JID ->
+			      send_message(From, JID, Body)
+		      end
+	      end, JIDs);
+	_ ->
+	    ok
+    end.
+
+send_message(From, To, Body) ->
+    ejabberd_router:route(
+      From, To,
+      {xmlelement, "message", [{"type", "chat"}],
+       [{xmlelement, "body", [],
+	 [{xmlcdata, lists:flatten(Body)}]}]}).
+
+get_admin_jids() ->
+    case ejabberd_config:get_local_option(watchdog_admins) of
+	JIDs when is_list(JIDs) ->
+	    lists:flatmap(
+	      fun(S) ->
+		      case jlib:string_to_jid(S) of
+			  error -> [];
+			  JID -> [jlib:jid_tolower(JID)]
+		      end
+	      end, JIDs);
+	_ ->
+	    []
+    end.
+
+detailed_info(Pid) ->
+    case process_info(Pid, dictionary) of
+	{dictionary, Dict} ->
+	    case lists:keysearch('$ancestors', 1, Dict) of
+		{value, {'$ancestors', [Sup | _]}} ->
+		    case Sup of
+			ejabberd_c2s_sup ->
+			    c2s_info(Pid);
+			ejabberd_s2s_out_sup ->
+			    s2s_out_info(Pid);
+			ejabberd_service_sup ->
+			    service_info(Pid);
+			_ ->
+			    detailed_info1(Pid)
+		    end;
+		_ ->
+		    detailed_info1(Pid)
+	    end;
+	_ ->
+	    detailed_info1(Pid)
+    end.
+
+detailed_info1(Pid) ->
+    io_lib:format(
+      "~p", [[process_info(Pid, current_function),
+	      process_info(Pid, initial_call),
+	      process_info(Pid, message_queue_len),
+	      process_info(Pid, links),
+	      process_info(Pid, dictionary),
+	      process_info(Pid, heap_size),
+	      process_info(Pid, stack_size)
+	     ]]).
+
+c2s_info(Pid) ->
+    ["Process type: c2s",
+     check_send_queue(Pid),
+     "\n",
+     io_lib:format("Command to kill this process: kill ~s ~w",
+		   [atom_to_list(node()), Pid])].
+
+s2s_out_info(Pid) ->
+    FromTo = mnesia:dirty_select(
+	       s2s, [{{s2s, '$1', Pid, '_'}, [], ['$1']}]),
+    ["Process type: s2s_out",
+     case FromTo of
+	 [{From, To}] ->
+	     "\n" ++ io_lib:format("S2S connection: from ~s to ~s",
+				   [From, To]);
+	 _ ->
+	     ""
+     end,
+     check_send_queue(Pid),
+     "\n",
+     io_lib:format("Command to kill this process: kill ~s ~w",
+		   [atom_to_list(node()), Pid])].
+
+service_info(Pid) ->
+    Routes = mnesia:dirty_select(
+	       route, [{{route, '$1', Pid, '_'}, [], ['$1']}]),
+    ["Process type: s2s_out",
+     case Routes of
+	 [Route] ->
+	     "\nServiced domain: " ++ Route;
+	 _ ->
+	     ""
+     end,
+     check_send_queue(Pid),
+     "\n",
+     io_lib:format("Command to kill this process: kill ~s ~w",
+		   [atom_to_list(node()), Pid])].
+
+check_send_queue(Pid) ->
+    case {process_info(Pid, current_function),
+	  process_info(Pid, message_queue_len)} of
+	{{current_function, MFA}, {message_queue_len, MLen}} ->
+	    if
+		MLen > 100 ->
+		    case MFA of
+			{prim_inet, send, 2} ->
+			    "\nPossible reason: the process is blocked "
+				"trying to send data over its TCP connection.";
+			{M, F, A} ->
+			    ["\nPossible reason: the process can't process "
+			     "messages faster than they arrive.  ",
+			     io_lib:format("Current function is ~w:~w/~w",
+					   [M, F, A])
+			    ]
+		    end;
+		true ->
+		    ""
+	    end;
+	_ ->
+	    ""
+    end.
+
+process_command1(From, To, Body) ->
+    process_command2(string:tokens(Body, " "), From, To).
+
+process_command2(["kill", SNode, SPid], From, To) ->
+    Node = list_to_atom(SNode),
+    remote_command(Node, [kill, SPid], From, To);
+process_command2(["showlh", SNode], From, To) ->
+    Node = list_to_atom(SNode),
+    remote_command(Node, [showlh], From, To);
+process_command2(["setlh", SNode, NewValueString], From, To) ->
+    Node = list_to_atom(SNode),
+    NewValue = list_to_integer(NewValueString),
+    remote_command(Node, [setlh, NewValue], From, To);
+process_command2(["help"], From, To) ->
+    send_message(To, From, help());
+process_command2(_, From, To) ->
+    send_message(To, From, help()).
+
+
+help() ->
+    "Commands:\n"
+	"  kill <node> <pid>\n"
+	"  showlh <node>\n"
+	"  setlh <node> <integer>".
+
+
+remote_command(Node, Args, From, To) ->
+    Message =
+	case rpc:call(Node, ?MODULE, process_remote_command, [Args]) of
+	    {badrpc, Reason} ->
+		io_lib:format("Command failed:~n~p", [Reason]);
+	    Result ->
+		Result
+	end,
+    send_message(To, From, Message).
+
+process_remote_command([kill, SPid]) ->
+    exit(list_to_pid(SPid), kill),
+    "ok";
+process_remote_command([showlh]) ->
+    Res = gen_server:call(ejabberd_system_monitor, {get, large_heap}),
+    io_lib:format("Current large heap: ~p", [Res]);
+process_remote_command([setlh, NewValue]) ->
+    {lh_changed, OldLH, NewLH} = gen_server:call(ejabberd_system_monitor, {set, large_heap, NewValue}),
+    io_lib:format("Result of set large heap: ~p --> ~p", [OldLH, NewLH]);
+process_remote_command(_) ->
+    throw(unknown_command).
+

src/ejabberd_tmp_sup.erl

@@ -1,14 +1,31 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_tmp_sup.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
 %%% Purpose : Supervisor for temporary processess
-%%% Created : 18 Jul 2003 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id$
+%%% Created : 18 Jul 2003 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%----------------------------------------------------------------------
 
 -module(ejabberd_tmp_sup).
--author('alexey@sevcom.net').
--vsn('$Revision$ ').
+-author('alexey@process-one.net').
 
 -export([start_link/2, init/1]).
 

src/ejabberd_update.erl

@@ -1,20 +1,42 @@
 %%%-------------------------------------------------------------------
 %%% File    : ejabberd_update.erl
-%%% Author  : Alexey Shchepin <alexey@sevcom.net>
-%%% Purpose : Update ejabberd
-%%% Created : 27 Jan 2006 by Alexey Shchepin <alexey@sevcom.net>
-%%% Id      : $Id: ejabberd_c2s.erl 492 2006-01-25 00:35:12Z alexey $
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
+%%% Purpose : ejabberd code updater
+%%% Created : 27 Jan 2006 by Alexey Shchepin <alexey@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2010   ProcessOne
+%%%
+%%% This program is free software; you can redistribute it and/or
+%%% modify it under the terms of the GNU General Public License as
+%%% published by the Free Software Foundation; either version 2 of the
+%%% License, or (at your option) any later version.
+%%%
+%%% This program is distributed in the hope that it will be useful,
+%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+%%% General Public License for more details.
+%%%
+%%% You should have received a copy of the GNU General Public License
+%%% along with this program; if not, write to the Free Software
+%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+%%% 02111-1307 USA
+%%%
 %%%-------------------------------------------------------------------
 
 -module(ejabberd_update).
--author('alexey@sevcom.net').
+-author('alexey@process-one.net').
 
 %% API
--export([update/0, update_info/0]).
+-export([update/0, update/1, update_info/0]).
+
+-include("ejabberd.hrl").
 
 %%====================================================================
 %% API
 %%====================================================================
+
+%% Update all the modified modules
 update() ->
     case update_info() of
 	{ok, Dir, _UpdatedBeams, _Script, LowLevelScript, _Check} ->
@@ -22,54 +44,104 @@ update() ->
 		release_handler_1:eval_script(
 		  LowLevelScript, [],
 		  [{ejabberd, "", filename:join(Dir, "..")}]),
-	    io:format("eval: ~p~n", [Eval]),
+	    ?INFO_MSG("eval: ~p~n", [Eval]),
 	    Eval;
 	{error, Reason} ->
 	    {error, Reason}
     end.
 
-update_info() ->
-    Dir = filename:dirname(code:which(ejabberd)),
-    case file:list_dir(Dir) of
-	{ok, Files} ->
-	    Beams = [list_to_atom(filename:rootname(FN)) ||
-			FN <- Files, lists:suffix(".beam", FN)],
-	    UpdatedBeams =
-		lists:filter(
-		  fun(Module) ->
-			  {ok, {Module, [NewVsn]}} =
-			      beam_lib:version(code:which(Module)),
-			  case code:is_loaded(Module) of
-			      {file, _} ->
-				  Attrs = Module:module_info(attributes),
-				  {value, {vsn, [CurVsn]}} =
-				      lists:keysearch(vsn, 1, Attrs),
-				  NewVsn /= CurVsn;
-			      false ->
-				  false
-			  end
-		  end, Beams),
-	    io:format("beam files: ~p~n", [UpdatedBeams]),
-	    Script = make_script(UpdatedBeams),
-	    io:format("script: ~p~n", [Script]),
-	    LowLevelScript = make_low_level_script(UpdatedBeams, Script),
-	    io:format("low level script: ~p~n", [LowLevelScript]),
-	    Check =
-		release_handler_1:check_script(
-		  LowLevelScript,
+%% Update only the specified modules
+update(ModulesToUpdate) ->
+    case update_info() of
+	{ok, Dir, UpdatedBeamsAll, _Script, _LowLevelScript, _Check} ->
+	    UpdatedBeamsNow =
+		[A || A <- UpdatedBeamsAll, B <- ModulesToUpdate, A == B],
+	    {_, LowLevelScript, _} = build_script(Dir, UpdatedBeamsNow),
+	    Eval =
+		release_handler_1:eval_script(
+		  LowLevelScript, [],
 		  [{ejabberd, "", filename:join(Dir, "..")}]),
-	    io:format("check: ~p~n", [Check]),
-	    {ok, Dir, UpdatedBeams, Script, LowLevelScript, Check};
+	    ?INFO_MSG("eval: ~p~n", [Eval]),
+	    Eval;
 	{error, Reason} ->
 	    {error, Reason}
     end.
 
+%% Get information about the modified modules
+update_info() ->
+    Dir = filename:dirname(code:which(ejabberd)),
+    case file:list_dir(Dir) of
+	{ok, Files} ->
+	    update_info(Dir, Files);
+	{error, Reason} ->
+	    {error, Reason}
+    end.
 
 %%--------------------------------------------------------------------
 %%% Internal functions
 %%--------------------------------------------------------------------
 
-%% From systools.hrl
+update_info(Dir, Files) ->
+    Beams = lists:sort(get_beams(Files)),
+    UpdatedBeams = get_updated_beams(Beams),
+    ?DEBUG("beam files: ~p~n", [UpdatedBeams]),
+    {Script, LowLevelScript, Check} = build_script(Dir, UpdatedBeams),
+    {ok, Dir, UpdatedBeams, Script, LowLevelScript, Check}.
+
+get_beams(Files) ->
+    [list_to_atom(filename:rootname(FN))
+     || FN <- Files, lists:suffix(".beam", FN)].
+
+%% Return only the beams that have different version
+get_updated_beams(Beams) ->
+    lists:filter(
+      fun(Module) ->
+	      NewVsn = get_new_version(Module),
+	      case code:is_loaded(Module) of
+		  {file, _} ->
+		      CurVsn = get_current_version(Module),
+		      (NewVsn /= CurVsn
+		       andalso NewVsn /= unknown_version);
+		  false ->
+		      false
+	      end
+      end, Beams).
+
+get_new_version(Module) ->
+    Path = code:which(Module),
+    VersionRes = beam_lib:version(Path),
+    case VersionRes of
+	{ok, {Module, NewVsn}} -> NewVsn;
+	%% If a m1.erl has -module("m2"):
+	_ -> unknown_version
+    end.
+
+get_current_version(Module) ->
+    Attrs = Module:module_info(attributes),
+    {value, {vsn, CurVsn}} = lists:keysearch(vsn, 1, Attrs),
+    CurVsn.
+
+%% @spec(Dir::string(), UpdatedBeams::[atom()]) -> {Script,LowLevelScript,Check}
+build_script(Dir, UpdatedBeams) ->
+    Script = make_script(UpdatedBeams),
+    LowLevelScript = make_low_level_script(UpdatedBeams, Script),
+    Check =
+	release_handler_1:check_script(
+	  LowLevelScript,
+	  [{ejabberd, "", filename:join(Dir, "..")}]),
+    case Check of
+	ok -> 
+	    ?DEBUG("script: ~p~n", [Script]),
+	    ?DEBUG("low level script: ~p~n", [LowLevelScript]),
+	    ?DEBUG("check: ~p~n", [Check]);
+	_ ->
+	    ?ERROR_MSG("script: ~p~n", [Script]),
+	    ?ERROR_MSG("low level script: ~p~n", [LowLevelScript]),
+	    ?ERROR_MSG("check: ~p~n", [Check])
+    end,
+    {Script, LowLevelScript, Check}.
+
+%% Copied from Erlang/OTP file: lib/sasl/src/systools.hrl
 -record(application, 
 	{name,			%% Name of the application, atom().
          type = permanent,	%% Application start type, atom().