Preliminary release notes for 3.0.0

Originally reported in
http://yo.jabber.ru/bugzilla/show_bug.cgi?id=251

Implements:
http://tools.ietf.org/html/rfc3920#section-6.2
If Use of TLS (Section 5) needs to be
established before a particular authentication mechanism may be used, the
receiving entity MUST NOT provide that mechanism in the list of available SASL
authentication mechanisms prior to TLS negotiation.

README

@@ -2,37 +2,50 @@ ejabberd - High-Performance Enterprise Instant Messaging Server
 
 Quickstart guide
 
-0. Dependancies
 
-To build ejabberd, you need:
+0. Requirements
+
+To compile ejabberd you need:
  - GNU Make
  - GCC
- - libexpat 1.95 or higher
- - Erlang/OTP R9C-2 or higher
- - OpenSSL 0.9.6 or higher (optional)
- - Zlib 1.2.3 or higher (optional)
- - GNU Iconv 1.8 or higher (optional, not needed on systems with GNU libc)
+ - Erlang/OTP R12B-5 or higher.
+ - exmpp 0.9.5 or higher
+ - 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).
+ - ESASL library. Optional. For SASL GSSAPI authentication.
+ - ImageMagick's Convert program. Optional. For CAPTCHA challenges.
 
-1. Build and install on *nix systems
 
-To build ejabberd, please go into the src directory and type the 
-following commands:
- ./configure && make
- sudo make install
+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 a startup script into the directory /usr/sbin,
- - install ejabberd into the directory /var/lib/ejabberd,
- - install the configuration file into /etc/ejabberd,
- - create a directory called /var/log/ejabberd to store log files.
+ - 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/
 
-Note: "sudo make install" means that the "make install" command should
-      be run with system administrator rights (root).
 
-2. Run
+2. Start ejabberd
 
-To run ejabberd, type the following command:
- erl -pa /var/lib/ejabberd/ebin -sname ejabberd -s ejabberd
+You can use the ejabberdctl command line administration script to
+start and stop ejabberd. For example:
+  ejabberdctl start
 
-For detailled informations, please refer to:
-http://www.process-one.net/en/projects/ejabberd/docs/guide_en.html
+
+For detailed information please refer to the
+ejabberd Installation and Operation Guide

contrib/ejabberd-modules.repo

@@ -1,5 +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/tags/ejabberd-2.0.0-beta1
-https://svn.process-one.net/ejabberd-modules/mod_http_fileserver/tags/ejabberd-2.0.0-beta1
+%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);
@@ -50,7 +55,11 @@ process(Dir, File, Used) ->
 		unused ->
 		    ets:foldl(fun({Key, _}, _) ->
 				      io:format("~p~n", [Key])
-			      end, ok, translations); 
+			      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
 		[{_}] ->
@@ -127,6 +144,15 @@ process_string(_Dir, File, Str, Used) ->
 		_ -> 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.
@@ -140,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 ->
@@ -191,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) ->
+    StrQ = re:replace(Str, "\\\"", "\\\\\\\"", [global, {return, list}]),
+    StrTQ = re:replace(StrT, "\\\"", "\\\\\\\"", [global, {return, list}]),
+    io:format("#: ~s:~p~nmsgid \"~s\"~nmsgstr \"~s\"~n~n", [File, Line, StrQ, StrTQ]).
+
+print_translation_obsolete(Str, StrT) ->
+    File = "unknown.erl",
+    Line = 1,
+    StrQ = re:replace(Str, "\\\"", "\\\\\\\"", [global, {return, list}]),
+    StrTQ = re:replace(StrT, "\\\"", "\\\\\\\"", [global, {return, list}]),
+    io:format("#: ~s:~p~n#~~ msgid \"~s\"~n#~~ msgstr \"~s\"~n~n", [File, Line, StrQ, StrTQ]).
+

contrib/extract_translations/prepare-translation.sh

@@ -3,16 +3,24 @@
 # Frontend for ejabberd's extract_translations.erl
 # by Badlop
 
+# 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_DIR=`pwd`/../..
+	EJA_SRC_DIR=$EJA_DIR/src/
+	EJA_MSGS_DIR=$EJA_SRC_DIR/msgs/
 	EXTRACT_DIR=$EJA_DIR/contrib/extract_translations/
-	EXTRACT_ERL=extract_translations.erl
-	EXTRACT_BEAM=extract_translations.beam
-	SRC_DIR=$EJA_DIR/src
+	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 ]])
@@ -22,9 +30,7 @@ prepare_dirs ()
 
 	if !([[ -x $EXTRACT_BEAM ]])
 	then 
-	echo -n "Compiling extract_translations.erl: "
 	sh -c "cd $EXTRACT_DIR; $ERL -compile $EXTRACT_ERL"
-	echo "ok"
 	fi
 }
 
@@ -76,14 +82,14 @@ extract_lang ()
 extract_lang_all ()
 {
 	cd $MSGS_DIR
-	for i in *.msg; do 
+	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 *.msg; do 
+	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'`
@@ -91,7 +97,7 @@ extract_lang_all ()
 	done
 
 	cd $MSGS_DIR
-	REVISION=`svn info | grep "^Rev" | head -1 | awk '{print $2}'`
+	REVISION=`git describe --always`
 	zip $HOME/ejabberd-langs-$REVISION.zip *.translate;
 
 	rm *.translate
@@ -140,6 +146,130 @@ find_unused_full ()
 	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 ""
@@ -158,34 +288,76 @@ translation_instructions ()
 	echo "  $MSGS_PATH"
 }
 
-case "$1" in
-	-help)
-		echo "Options:"
-		echo "  -langall"
-		echo "  -lang LANGUAGE_FILE"
-		echo ""
-		echo "Example:"
-		echo "  ./prepare-translation.sh -lang es.msg"
-		exit 0
+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=$2
+		LANGU=$1
 		prepare_dirs
 		extract_lang $LANGU
 		shift
-		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 "unknown option: '$1 $2'"
-		shift
-		shift
+		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
-
-echo ""
-echo "End."
+    esac
+done

doc/Makefile

@@ -1,12 +1,9 @@
-# $Id$
+SHELL = /bin/bash
 
 CONTRIBUTED_MODULES = ""
-ifeq ($(shell ls mod_http_bind.tex),mod_http_bind.tex)
-	CONTRIBUTED_MODULES += "\\r\\n\\setboolean{modhttpbind}{true}"
-endif
-ifeq ($(shell ls mod_http_fileserver.tex),mod_http_fileserver.tex)
-	CONTRIBUTED_MODULES += "\\r\\n\\setboolean{modhttpfileserver}{true}"
-endif
+#ifeq ($(shell ls mod_http_bind.tex),mod_http_bind.tex)
+#	CONTRIBUTED_MODULES += "\\n\\setboolean{modhttpbind}{true}"
+#endif
 
 
 all:	release pdf html
@@ -14,14 +11,14 @@ 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 update the version number in src/ejabberd.hrl!"
+	@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)."
 	@echo "Press any key to continue"
-	@read foo
+	##@read foo
 	@echo "% ejabberd version (automatically generated)." > version.tex
-	@echo "\\\newcommand{\\\version}{"`cat ../src/ejabberd.hrl | grep VERSION | sed s/-define\(VERSION,\ \"//g | sed s/\"\).//g`"}" >> 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 "$(CONTRIBUTED_MODULES)" >> contributed_modules.tex
+	@echo -e "$(CONTRIBUTED_MODULES)" >> contributed_modules.tex
 
 html:	guide.html dev.html features.html
 
@@ -30,7 +27,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
@@ -39,15 +35,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 -fix -noiso -pedantic guide.tex
+		hevea -fix -pedantic guide.tex
 
 dev.html:	dev.tex
-		hevea -fix -noiso -pedantic dev.tex
+		hevea -fix -pedantic dev.tex
 
 features.html:	features.tex
-		hevea -fix -noiso -pedantic features.tex
+		hevea -fix -pedantic features.tex
 
 guide.pdf:	guide.tex
 		pdflatex guide.tex

doc/api/Makefile

@@ -1,17 +0,0 @@
-APPNAME = ejabberd
-VSN = SVN
-
-DOCDIR=.
-SRCDIR=../../src
-
-.PHONY = all
-
-all: docs
-
-clean:
-	rm -f *.html
-	rm edoc-info
-
-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

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

doc/dev.html

@@ -2,7 +2,7 @@
             "http://www.w3.org/TR/REC-html40/loose.dtd">
 <HTML>
 <HEAD>
-<TITLE>Ejabberd 2.0.0-beta1 Developers Guide
+<TITLE>Ejabberd 3.0.0-prealpha Developers Guide
 </TITLE>
 
 <META http-equiv="Content-Type" content="text/html; charset=US-ASCII">
@@ -46,10 +46,10 @@ TD P{margin:0px;}
 </STYLE>
 </HEAD>
 <BODY >
-<!--HEVEA command line is: /usr/bin/hevea -fix -noiso -pedantic dev.tex -->
+<!--HEVEA command line is: /usr/bin/hevea -fix -pedantic dev.tex -->
 <!--CUT DEF section 1 --><P><A NAME="titlepage"></A>
 
-</P><TABLE CLASS="title"><TR><TD><H1 CLASS="titlemain">Ejabberd 2.0.0-beta1 Developers Guide</H1><H3 CLASS="titlerest">Alexey Shchepin<BR>
+</P><TABLE CLASS="title"><TR><TD><H1 CLASS="titlemain">Ejabberd 3.0.0-prealpha Developers Guide</H1><H3 CLASS="titlerest">Alexey Shchepin<BR>
  <A HREF="mailto:alexey@sevcom.net"><TT>mailto:alexey@sevcom.net</TT></A><BR>
  <A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT></A></H3></TD></TR>
 </TABLE><DIV CLASS="center">
@@ -84,7 +84,7 @@ Kevin Smith, Current maintainer of the Psi project</I></BLOCKQUOTE><!--TOC secti
 </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</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-->
+<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:
@@ -92,13 +92,13 @@ Kevin Smith, Current maintainer of the Psi project</I></BLOCKQUOTE><!--TOC secti
 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><LI CLASS="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows. </LI><LI CLASS="li-itemize">Web interface for administration tasks.
+</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 17 languages. </LI><LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>.
+Translated to 24 languages. </LI><LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>.
 </LI></UL></LI><LI CLASS="li-itemize">Open Standards: <TT>ejabberd</TT> is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
 <UL CLASS="itemize"><LI CLASS="li-itemize">
 Fully XMPP compliant.
@@ -118,35 +118,34 @@ Load only the modules you want.
 <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 interface accessible via HTTPS secure access.
+</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 MySQL support.
+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">Mnesia.
 </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">
-PAM, LDAP and ODBC. </LI><LI CLASS="li-itemize">External Authentication script.
-</LI><LI CLASS="li-itemize">Internal Authentication.
+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">
-Compressing XML streams with Stream Compression (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>).
-</LI><LI CLASS="li-itemize">Interface with networks such as AIM, ICQ and MSN.
+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 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.
-</LI><LI CLASS="li-itemize">Support for virtual hosting.
-</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> service.
-</LI><LI CLASS="li-itemize">IRC transport.
+</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with support for clustering and HTML logging. </LI><LI CLASS="li-itemize">Users Directory based on users vCards.
+</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component with support for <A HREF="http://www.xmpp.org/extensions/xep-0163.html">Personal Eventing via Pubsub</A>.
+</LI><LI CLASS="li-itemize">Support for web clients: <A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> and <A HREF="http://www.xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</A> services.
+</LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports.
 </LI></UL>
 </LI></UL><!--TOC section How it Works-->
 <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc3">3</A>&#XA0;&#XA0;How it Works</H2><!--SEC END --><P>
-<A NAME="howitworks"></A></P><P>A Jabber domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can
+<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
@@ -159,7 +158,7 @@ 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 Jabber packets on each node. It routes
+<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
@@ -173,7 +172,7 @@ session manager, else it is processed depending on it&#X2019;s content.</P><!--T
 packet must be sended via presence table. If this resource is connected to
 this node, it is routed to C2S process, if it connected via another node, then
 the packet is sent to session manager on that node.</P><!--TOC subsection S2S Manager-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7">3.4</A>&#XA0;&#XA0;S2S Manager</H3><!--SEC END --><P>This module routes packets to other Jabber servers. First, it checks if an
+<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
@@ -194,6 +193,9 @@ operation are as follows:
 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

doc/dev.tex

@@ -26,6 +26,7 @@
 \newcommand{\ns}[1]{\texttt{#1}}
 \newcommand{\ejabberd}{\texttt{ejabberd}}
 \newcommand{\Jabber}{Jabber}
+\newcommand{\XMPP}{XMPP}
 
 %% Modules
 \newcommand{\module}[1]{\texttt{#1}}
@@ -100,7 +101,7 @@
 \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
@@ -121,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
@@ -147,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
@@ -175,6 +176,9 @@ That script is supposed to do theses actions, in an infinite loop:
     \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

doc/devdoc/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,false},{private,true},{def,{vsn,"$(VSN)"}},{stylesheet,"process-one.css"},{overview,"$(DOCDIR)/overview.edoc"}]' -s init stop

doc/devdoc/escobar.css

@@ -0,0 +1,19 @@
+.comment {color: brown}
+.export {color: darkorchid}
+.import {color: darkorchid}
+.string {color: maroon}
+.builtin {color: dodgerblue}
+.guard {color: mediumturquoise}
+.function {color: blue}
+.variable {color: green}
+.macro {color: mediumpurple}
+.record {color: orangered}
+.call {color: purple}
+.attribute {color: firebrick}
+.error{color: red}
+.l {
+ font-style: normal;
+ font-weight: normal;
+ text-decoration: none;
+ color: gray;
+}

doc/devdoc/escobar_hilite.erl

@@ -0,0 +1,356 @@
+%%%-------------------------------------------------------------------
+%%% File    : escobar_hiliter.erl
+%%% Author  : Mats Cronqvist <mats.cronqvist@gmail.com>
+%%% Description :
+%%%
+%%% Created :  6 Jun 2005 by Mats Cronqvist <mats.cronqvist@gmail.com>
+%%%
+%%%
+%%% Escobar, Copyright (c) 2005-2009 Mats Cronqvist
+%%%
+%%% MIT License:
+%%%
+%%% 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.
+%%%
+%%%-------------------------------------------------------------------
+
+-module(escobar_hilite).
+
+-export([file/1,tree/1,string/1,out/2]).
+
+-define(LOG(T),escobar:log(process_info(self()),T)).
+
+-import(erl_syntax, 
+	[get_ann/1,add_ann/2,subtrees/1,update_tree/2,type/1,get_pos/1,
+	 application/2,application_arguments/1,application_operator/1,
+	 arity_qualifier_argument/1,arity_qualifier_body/1,
+	 atom_name/1,atom_value/1,
+	 attribute/2,attribute_name/1,attribute_arguments/1,
+         clause/3,clause_patterns/1,clause_guard/1,clause_body/1,
+	 comment/2,comment_text/1,comment_padding/1,
+	 function/2,function_name/1,function_clauses/1,function_arity/1,
+	 integer_literal/1,
+	 list/1,list_elements/1,
+	 macro/2,macro_name/1,macro_arguments/1,
+	 module_qualifier_body/1, module_qualifier_argument/1,
+	 string_value/1,string_literal/1,
+	 variable_literal/1,variable_name/1,
+	 record_access/3, record_access_argument/1, 
+	 record_access_field/1,record_access_type/1,
+	 record_expr/3, record_expr_argument/1, 
+	 record_expr_fields/1, record_expr_type/1,
+	 record_index_expr/2, record_index_expr_field/1,
+	 record_index_expr_type/1,
+         form_list/1,
+	 get_precomments/1,get_postcomments/1,has_comments/1, 
+	 copy_comments/2,remove_comments/1]).
+
+-import(prettypr,
+	[above/2,follow/2,beside/2,empty/0,
+	 null_text/1,break/1,floating/3,text/1,floating/1]).
+
+-import(lists,[flatten/1,duplicate/2,keysearch/3,member/2,usort/1,reverse/1]).
+
+-import(filename,[join/1,basename/1]).
+
+out(File,HtmlString) ->
+  {ok,FD}=file:open(File,[write]),
+  try
+    io:fwrite(FD,"<html>",[]),
+    io:fwrite(FD,"<link rel=\"stylesheet\" type=\"text/css\"",[]),
+    io:fwrite(FD,"href=\"escobar.css\"></link><body><pre>",[]),
+    io:fwrite(FD,"~s",[HtmlString]),
+    io:fwrite(FD,"</pre></body></html>",[])
+  after 
+    file:close(FD)
+  end.
+
+string(Str) ->
+  tree(form_list(scan_and_parse(Str,1,[]))).
+
+scan_and_parse([],_Line,Forms) -> reverse(Forms);
+scan_and_parse(Text,Line,Forms) ->
+    {done,{ok,Toks,NLine},Cont} = erl_scan:tokens([],Text,Line),
+    {ok,Form} = erl_parse:parse_form(Toks),
+    scan_and_parse(Cont,NLine,[Form|Forms]).
+
+file(FileName) ->
+  case filelib:is_regular(FileName) of
+    true -> 
+      case filename:extension(FileName) of
+        ".beam"-> tree(get_tree_beam(FileName));
+        ".erl" -> tree(get_comm_tree_erl(FileName));
+        ".hrl" -> tree(get_comm_tree_erl(FileName));
+        X -> erlang:error({unknown_extension,X})
+      end;
+    false->
+      erlang:error({no_file,FileName})
+  end.
+
+get_comm_tree_erl(Filename) ->
+  Comms = erl_comment_scan:file(Filename),
+  Forms = get_forms_erl(Filename),
+  erl_recomment:recomment_forms(Forms,Comms).
+
+get_tree_beam(Filename) ->
+  case beam_lib:chunks(Filename,["Abst"]) of
+    {ok,{_,[{"Abst",AChunk}]}} ->
+      {_,Forms} = binary_to_term(AChunk),
+      form_list(Forms);
+    _ ->
+      erlang:error({no_debuginfo,Filename})
+  end.
+
+get_forms_erl(Filename) ->
+  {ok,Fs} = epp_dodger:parse_file(Filename,[{no_fail, true}]),
+  Fs.
+
+%%% # tree
+%%% turn a syntax tree into html by annotating and pretty-printing
+%%% with a hook function
+
+tree(Tree) -> 
+  pout(ann(type(Tree),Tree)).
+
+%%lists:foldl(fun(Form,Acc) -> [pout(ann(Form))|Acc] end, [], Tree).
+
+pout(Form) ->
+  erl_prettypr:format(Form,[{hook,fun tag/3},{paper,90},{ribbon,650}]).
+
+%%% ## formatting
+%%% ### 'tag' - the format hook function
+tag(Node,Ctxt,Cont) ->
+  Tags = get_ann(Node),
+  case member(has_comment,Tags) of
+    true ->
+      PreC = get_precomments(Node),
+      PostC = get_postcomments(Node),
+      Nod = remove_comments(Node),
+      Doc0 = tagit(Tags--[has_comment],Cont(Nod,Ctxt)),
+      postcomment(precomment(Doc0,PreC),PostC);
+    false ->
+      Doc0 = Cont(Node,Ctxt),
+      tagit(Tags,Doc0)
+  end.
+
+tagit([],Doc0) -> 
+  Doc0;
+tagit(["binary"],{beside,_,{beside,Doc,_}}) -> 
+  beside(floating(text("&lt;&lt;")),beside(Doc,floating(text("&gt;&gt;"))));
+tagit([Tag],Doc0) -> 
+  beside(null_text(Tag),beside(Doc0,null_text(etag(Tag)))).
+
+etag("<"++Tag) -> "</"++hd(string:tokens(Tag," "))++">".
+  
+%%%### comment stuff
+precomment(Doc,PreC) ->
+  above(floating(break(stack(PreC)), -1, -1), Doc).
+postcomment(Doc,PostC) ->
+  beside(Doc, floating(break(stack(PostC)), 1, 0)).
+
+stack([]) -> empty();
+stack([Comm|Comms]) ->
+  Doc = maybe_pad(stack_comment_lines(comment_text(Comm)),Comm),
+  case Comms of 
+    [] -> Doc;
+    _ -> above(Doc, stack(Comms))
+  end.
+
+maybe_pad(Doc,Comm) ->
+  case comment_padding(Comm) of
+    I when is_integer(I), 0 < I -> beside(text(duplicate(I,$ )), Doc);
+    _ -> Doc
+  end.
+
+%%% stolen with pride from erl_prettypr
+%%% Stack lines of text above each other and prefix each string in
+%%% the list with a single `%' character.
+
+stack_comment_lines([S | Ss]) ->
+  D = tagit([dehtml('span', [{class,comment}])],text("%"++debracket(S))),
+  case Ss of
+    [] -> D;
+    _ -> above(D, stack_comment_lines(Ss))
+  end;
+stack_comment_lines([]) ->
+  empty().
+
+%%% annotate nodes that should be hilited
+%%% the annotation is put on the subtree that should be marked up 
+%%% the annotation is; 
+%%% has_comments|Markup
+%%% if a node already has an annotation the new one is dropped, except
+%%% if either the new or the old one is has_comments
+
+ann(binary,Tree) ->
+  new_tree(Tree,add_anno("binary",Tree));
+ann(application,Tree) ->
+  Op = application_operator(Tree),
+  Args = application_arguments(Tree),
+  new_tree(Tree,application(add_anno(mu(application,Tree),Op),Args));
+ann(attribute,Tree) ->
+  Name = attribute_name(Tree),
+  case atom_value(Name) of
+    export ->
+      AQs = list_elements(hd(attribute_arguments(Tree))),
+      Args = [list([add_anno(mu(export,Tree),AQ) || AQ <- AQs])];
+    import ->
+      [ImportMod,ImportFAs] = attribute_arguments(Tree),
+      AQs = list_elements(ImportFAs),
+      Args = [ImportMod,list([add_anno(mu(import,Tree),AQ) || AQ <- AQs])];
+    define ->
+      [Macro|Rest] = attribute_arguments(Tree),
+      case type(Macro) of
+        application ->
+          Op = application_operator(Macro),
+          As = application_arguments(Macro),
+          Args = [application(add_anno(mu(macro,Tree),Op),As)|Rest];
+        _ ->
+          Args = [add_anno(mu(macro,Tree),Macro)|Rest]
+      end;
+    record ->
+      [Rec|Rest] = attribute_arguments(Tree),
+      Args = [add_anno(mu(record,Tree),Rec)|Rest];
+    _ ->
+      Args = attribute_arguments(Tree)
+  end,
+  new_tree(Tree,attribute(add_anno(mu(attribute,Tree),Name),Args));
+ann(record_access,Tree) ->
+  Arg = record_access_argument(Tree),
+  Type = record_access_type(Tree),
+  Field = record_access_field(Tree),
+  new_tree(Tree,record_access(Arg,add_anno(mu(record,Tree),Type),Field));
+ann(record_expr,Tree) ->
+  Arg = record_expr_argument(Tree),
+  Type = record_expr_type(Tree),
+  Fields = record_expr_fields(Tree),
+  new_tree(Tree,record_expr(Arg,add_anno(mu(record,Tree),Type),Fields));
+ann(record_index_expr,Tree) ->
+  Type = record_index_expr_type(Tree),
+  Field = record_index_expr_field(Tree),
+  new_tree(Tree,record_index_expr(add_anno(mu(record,Tree),Type),Field));
+ann(function,Tree) ->
+  Name = function_name(Tree),
+  Clauses = function_clauses(Tree),
+  new_tree(Tree,function(add_anno(mu(function,Tree),Name),Clauses));
+ann(macro,Tree) ->
+  Name = macro_name(Tree),
+  Args = macro_arguments(Tree),
+  new_tree(Tree,macro(add_anno(mu(macro,Tree),Name), Args));
+ann(string,OTree) ->
+  Tree = erl_syntax:string(debracket(string_value(OTree))),
+  new_tree(OTree,add_anno(mu(string,OTree),Tree));
+ann(variable,Tree) ->
+  new_tree(Tree,add_anno(mu(variable,Tree),Tree));
+ann(text,Tree) ->
+  new_tree(Tree,add_anno(mu(error,Tree),Tree));
+ann(comment,OTree) ->
+  Pad = comment_padding(OTree),
+  Text = [debracket(S) || S <- comment_text(OTree)],
+  Tree = comment(Pad,Text),
+  new_tree(OTree,add_anno(mu(comment,OTree),Tree));
+ann(_Typ,Tree) ->
+  new_tree(Tree,Tree).
+
+new_tree(OTree,NTree) ->
+  Tree = 
+    case has_comments(OTree) of
+      true -> add_ann(has_comment,copy_comments(OTree,NTree));
+      false -> NTree
+    end,
+  SubTrees = subtrees(Tree),
+  case [[ann(type(SubT),SubT) || SubT<-Group] || Group<-SubTrees] of
+    [] -> Tree;
+    NSubtrees -> update_tree(Tree,NSubtrees)
+  end.
+
+debracket([]) -> [];
+debracket([$>|Str]) -> "&gt;"++debracket(Str);
+debracket([$<|Str]) -> "&lt;"++debracket(Str);
+debracket([C|Str]) -> [C|debracket(Str)].
+
+add_anno(nil,Tree) -> Tree;
+add_anno(Ann,Tree) -> 
+  case get_ann(Tree) of
+    [] -> add_ann(Ann,Tree);
+    [has_comment] -> add_ann(Ann,Tree);
+    _OAnn -> Tree
+  end.
+
+%%%### the markups
+mu(application,Node) ->
+  Op = application_operator(Node),
+  Ar = length(application_arguments(Node)),
+  case type(Op) of
+%%     variable ->
+%%       dehtml('span', [{class,variable}]);
+    atom -> 
+      case is_guard_or_builtin(atom_value(Op),Ar) of
+        guard -> dehtml('span', [{class,guard}]);
+        builtin->dehtml('span', [{class,builtin}]);
+        neither->dehtml('span', [{class,call}])
+      end;
+    module_qualifier -> 
+      Mod = module_qualifier_argument(Op),
+      Fun = module_qualifier_body(Op),
+      case {type(Mod),type(Fun)} of
+        {atom,atom} -> 
+          case atom_value(Mod) of
+            erlang -> dehtml('span', [{class,builtin}]);
+            _ -> dehtml('span', [{class,call}])
+          end;
+        _ ->
+          nil
+      end;
+    _ ->
+      nil
+  end;
+mu(function = Class, {tree, function, _, {function, _, [{tree, clause, _, {clause, Vars, _, _}} | _]}}) ->
+  dehtml('span', [{class,Class}, {arity,length(Vars)}]);
+mu(Class,_Node) -> 
+  dehtml('span', [{class,Class}]).
+
+dehtml(Tag,Atts) ->
+  flatten([$<,str(Tag),$ ,[[str(A),"=\"",str(V),"\" "]||{A,V}<-Atts],$>]).
+
+str(I) when is_integer(I) -> integer_to_list(I);
+str(A) when is_atom(A) -> atom_to_list(A);
+str(L) when is_list(L) -> L.
+
+is_guard_or_builtin(atom,1)      ->guard;
+is_guard_or_builtin(binary,1)    ->guard;
+is_guard_or_builtin(constant,1)  ->guard;
+is_guard_or_builtin(float,1)     ->guard;
+is_guard_or_builtin(function,1)  ->guard;
+is_guard_or_builtin(function,2)  ->guard;
+is_guard_or_builtin(integer,1)   ->guard;
+is_guard_or_builtin(list,1)      ->guard;
+is_guard_or_builtin(number,1)    ->guard;
+is_guard_or_builtin(pid,1)       ->guard;
+is_guard_or_builtin(port,1)      ->guard;
+is_guard_or_builtin(reference,1) ->guard;
+is_guard_or_builtin(tuple,1)     ->guard;
+is_guard_or_builtin(record,2)    ->guard;
+is_guard_or_builtin(record,3)    ->guard;
+is_guard_or_builtin(F,A) ->
+  case erlang:function_exported(erlang,F,A) orelse 
+    erlang:is_builtin(erlang,F,A) of
+    true -> builtin;
+    false-> neither
+  end.

doc/devdoc/escobar_run.erl

@@ -0,0 +1,54 @@
+%%%-------------------------------------------------------------------
+%%% File    : escobar_run.erl
+%%% Author  : Badlop <badlop@process-one.net>
+%%% Purpose : Frontend to run Escobar
+%%% Created : 16 Apr 2008 by Badlop <badlop@process-one.net>
+%%%-------------------------------------------------------------------
+-module(escobar_run).
+
+%%% Download ejabberd_hilite.erl from http://code.google.com/p/erl-escobar/
+
+%%% Example calls:
+%%% escobar_run:file("escobar_run.erl", "../ejascobar/").
+%%% escobar_run:dir(".", "../ejascobar/").
+%%% escobar_run:dir(".", "../doc/api/").
+%%% find ./ -type f -name '*.html' -exec sed -i 's/class="function" >\([a-z0-9]*\)</class="function" id="\1">\1</;' {} \;
+
+-export([file/2, file/1, dir/1]).
+
+file([F, OutDir]) ->
+    file(F, OutDir).
+
+file(F, OutDir) ->
+    String = escobar_hilite:file(F),
+    FB = filename:basename(F),
+    FilenameHTML = filename:join(OutDir, FB ++ ".html"),
+    escobar_hilite:out(FilenameHTML, String).
+
+dir([SrcDir, OutDir]) ->
+    SrcDirAbs = filename:absname(SrcDir),
+    OutDirAbs = filename:absname(OutDir),
+    Files = get_files([SrcDirAbs]),
+    lists:foreach(
+      fun(F) ->
+	      case filename:extension(F) of
+		  ".erl" ->
+		      file(F, OutDirAbs);
+		  ".hrl" ->
+		      file(F, OutDirAbs);
+		  _ ->
+		      ok
+	      end
+      end,
+      Files).
+
+get_files([]) ->
+    [];
+get_files([FHead | FTail]) ->
+    case catch file:list_dir(FHead) of
+	{ok, Files} ->
+	    FilesHead = [filename:join(FHead, FilesN) || FilesN <- Files],
+	    get_files(FilesHead ++ FTail);
+	{error, enotdir} ->
+	    [FHead] ++ get_files(FTail)
+    end.

doc/devdoc/funrelg.erl

@@ -0,0 +1,522 @@
+%%%----------------------------------------------------------------------
+%%% File    : funrelg.erl
+%%% Author  : Badlop <badlop@process-one.net>
+%%% Purpose : Function Relation Graph
+%%% Created : 3 Apr 2007 by Badlop <badlop@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2009   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(funrelg).
+
+-author('badlop@process-one.net').
+
+-export([dir/1, file/1, g/0, g/1, gc/0, gc/1, d/0]).
+
+-record(mfa, {mod, func, arity}).
+-record(arcs, {id, from, to, occ}).
+
+%% The functions that are not in export and don't call anybody are not drawn
+%% The calls to this module that use Mod:Func are drawn as external calls
+
+%%-----------------------------
+%% Module handlers
+%%-----------------------------
+
+dir([SrcDir, OutDir]) ->
+    SrcDirAbs = filename:absname(SrcDir),
+    OutDirAbs = filename:absname(OutDir),
+    Files = get_files([SrcDirAbs]),
+    lists:foreach(
+      fun(F) ->
+	      file(F, OutDirAbs)
+      end,
+      Files).
+
+file([SrcDir, OutDir]) ->
+    SrcFilAbs = filename:absname(SrcDir),
+    OutDirAbs = filename:absname(OutDir),
+    file(SrcFilAbs, OutDirAbs).
+
+file(SrcFile, OutDir) ->
+    case {filename:extension(SrcFile), filename:basename(SrcFile)} of
+	%% The file must by *.erl, and the first character must be a-z
+	{".erl", [FirstChar | _]} when (FirstChar >= 97) and (FirstChar =< 122) ->
+	    make_file(SrcFile, OutDir),
+	    d();
+	_ ->
+	    ok
+    end.
+
+get_files([]) ->
+    [];
+get_files([FHead | FTail]) ->
+    case catch file:list_dir(FHead) of
+	{ok, Files} ->
+	    FilesHead = [filename:join(FHead, FilesN) || FilesN <- Files],
+	    get_files(FilesHead ++ FTail);
+	{error, enotdir} ->
+	    [FHead] ++ get_files(FTail)
+    end.
+
+make_file(File, OutDir) ->
+    FB = filename:basename(File),
+    FileDot = filename:join(OutDir, FB ++ ".dot"),
+    Text = gc(File),
+    {ok,FO}=file:open(FileDot,[write]),
+    try
+	io:fwrite(FO,"~s",[Text])
+	after
+	    file:close(FO)
+	end,
+    FileSvg = filename:join(OutDir, filename:basename(File, ".erl") ++ ".svg"),
+    case os:cmd("dot -Tsvg " ++ FileDot ++ " -o " ++ FileSvg) of
+	"" -> ok;
+	ShellResult ->
+	    io:format("Trying to run 'dot', we got this result:~n  ~s~n"
+		      "Remember that you need to have Graphviz 'dot' installed.~n", [ShellResult])
+    end,
+    ok.
+
+%%====================================================================
+%% Internal functions
+%%====================================================================
+
+g() ->
+    g("a.erl").
+g(Filename) ->
+    gc(Filename),
+    halt().
+
+gc() ->
+    gc("a.erl").
+gc(Filename) ->
+    {ok, File} = epp_dodger:parse_file(Filename),
+
+    ets:new(arcs, [set, public, named_table, {keypos, 2}]),
+    ets:new(mfa_conversion, [set, public, named_table, {keypos, 1}]),
+    ets:new(counters, [set, public, named_table]),
+    ets:insert(counters, {arcs_id, 0}),
+
+    ModuleName = get_module_name(File),
+    Exports = lists:usort(get_exports(File)),
+    Functions = get_functions(File),
+    FunctionsParsed = lists:usort(parse_functions(Functions)), % side effects: stores on ets
+    Privates = FunctionsParsed -- Exports,
+    %%Externals = get_externals(),
+
+    MFAs = get_func_calls(),
+
+    AppModules1 = os:cmd("ls -1 ../doc/devdoc/*.html | tr \".\" \" \" | tr \"/\" \" \" | awk '{print $3}'"),
+    AppModules = [list_to_atom(Str) || Str <- string:tokens(AppModules1, [10])],
+
+    ExternalTypes1 = [mfa_to_externaltype(MFA, ModuleName, AppModules, FunctionsParsed) || MFA <- MFAs],
+    ExternalTypes = lists:usort(ExternalTypes1),
+    AppExternals = [Function || {Type, Function} <- ExternalTypes, Type == app],
+    ExmppExternals = [Function || {Type, Function} <- ExternalTypes, Type == exmpp],
+    OTPExternals = [Function || {Type, Function} <- ExternalTypes, Type == other],
+
+    textize(ModuleName, Exports, Privates, AppExternals, ExmppExternals, OTPExternals).
+
+get_arcs_id() ->
+    ets:update_counter(counters, arcs_id, 1).
+
+insert_arc_normal(FromFunc, FromArity, ToFunc, ToArity) ->
+    From = #mfa{mod = -1, func = FromFunc, arity = FromArity},
+    To = #mfa{mod = -1, func = ToFunc, arity = ToArity},
+    insert_arc(From, To).
+
+insert_arc_external(FromFunc, FromArity, ToMod, ToFunc, ToArity) ->
+    From = #mfa{mod = -1, func = FromFunc, arity = FromArity},
+    To = #mfa{mod = ToMod, func = ToFunc, arity = ToArity},
+    insert_arc(From, To).
+
+insert_arc(From, To) ->
+    Match = #arcs{
+      from = From,
+      to = To,
+      id='$1',
+      _='_'},
+    Select = [{Match, [], ['$1']}],
+    Ids = ets:select(arcs, Select),
+    case Ids of
+	[] ->
+	    ets:insert(arcs,
+		       #arcs{
+			 id = get_arcs_id(),
+			 from = From,
+			 to = To,
+			 occ = 1
+			}
+		      );
+	[Id] ->
+	    [Arc] = ets:lookup(arcs, Id),
+	    Arc2 = Arc#arcs{occ = Arc#arcs.occ+1},
+	    ets:insert(arcs, Arc2)
+    end.
+
+read_arc(Id) ->
+    ets:lookup(arcs, Id).
+
+d() ->
+    ets:delete(arcs),
+    ets:delete(mfa_conversion),
+    ets:delete(counters).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Get
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+get_module_name(File) ->
+    Attributes = get_elements(attribute, File),
+    get_attribute(module, Attributes).
+
+get_exports(File) ->
+    Attributes = get_elements(attribute, File),
+    Exports = get_attribute(export, Attributes),
+    parse_export(Exports).
+
+get_functions(File) ->
+    get_elements(function, File).
+
+get_elements(Type, L) -> get_elements(Type, L, []).
+get_elements(_, [], Res) -> Res;
+get_elements(Type, [{tree, Type, _, A} | L], Res) ->
+    get_elements(Type, L, Res++[A]);
+get_elements(Type, [_ | L], Res) ->
+    get_elements(Type, L, Res).
+
+get_attribute(_, []) -> [];
+get_attribute(Name, [{attribute, {tree, atom, _, Name}, [Al]} | As]) ->
+    case Name of
+	module ->
+	    {tree, atom, _, Mn} = Al,
+	    Mn;
+	export ->
+	    {tree, list, _, {list, Exports, _}} = Al,
+	    Exports++get_attribute(Name, As);
+	_ -> ok
+    end;
+get_attribute(Name, [_ | As]) ->
+    get_attribute(Name, As).
+
+parse_export(Ex) ->
+    lists:foldl(
+      fun(Aq, Res) ->
+	      {tree, arity_qualifier, _, {arity_qualifier, Atom, Inte}} = Aq,
+	      {tree, atom, _, An} = Atom,
+	      {tree, integer, _, In} = Inte,
+	      Res++[{An, In}]
+      end,
+      [],
+      Ex).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Parse
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+parse_functions(Functions) ->
+    lists:map(
+      fun(E) ->
+	      {function, {_, _, _, Fn}, Clauses} = E,
+	      Arity = get_function_arity(Clauses),
+	      parse_clauses(Fn, Clauses),
+	      {Fn, Arity}
+      end,
+      Functions).
+
+parse_clauses(Fn, Clauses) ->
+    lists:foreach(
+      fun(E) ->
+	      {tree, clause, L, C} = E,
+	      {attr, _Ln, _, _} = L,
+	      {clause, Parameters, _, Contents} = C,
+	      Fa = length(Parameters),
+	      parse_contents({Fn, Fa}, Contents)
+      end,
+      Clauses).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% OLD
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+parse_contents(F, Contents) ->
+    {_, Res} = lists:foldl(
+		 fun(C, {Fu, R}) ->
+			 {Fu, R++parse_content(F, C)}
+		 end,
+		 {F, []},
+		 Contents),
+    Res.
+
+parse_content(F, {tree, application, L, A}) ->
+    {attr, _Ln, _, _} = L,
+    parse_application(F, A);
+parse_content(F, {tree, list, _, {list, [L], Ls}}) ->
+    RL = parse_content(F, L),
+    RL++parse_content(F, Ls);
+parse_content(F, {tree, tuple, _, T}) ->
+    parse_contents(F, T);
+parse_content(F, {tree, match_expr, _, M}) ->
+    {match_expr, _, Value} = M,
+    parse_content(F, Value);
+parse_content(F, {tree, try_expr, _, T}) ->
+    {try_expr, As, Bs, Cs, Ds} = T,
+    RAs = parse_contents(F, As),
+    RBs = parse_contents(F, Bs),
+    RDs = parse_contents(F, Ds),
+    RAs++RBs++RDs++parse_contents(F, Cs);
+parse_content(F, {tree, block_expr, _, Ts}) ->
+    parse_contents(F, Ts);
+parse_content(F, {tree, catch_expr, _, C}) ->
+    parse_content(F, C);
+parse_content(F, {tree, case_expr, _, C}) ->
+    {case_expr, Case, Cases} = C,
+    R2 = parse_content(F, Case),
+    R2++parse_contents(F, Cases);
+parse_content(F, {tree, if_expr, _, Cases}) ->
+    parse_contents(F, Cases);
+parse_content(F, {tree, disjunction, _, Cases}) ->
+    parse_contents(F, Cases);
+parse_content(F, {tree, conjunction, _, Cases}) ->
+    parse_contents(F, Cases);
+parse_content(F, {tree, list_comp, _, L}) ->
+    {list_comp, A, Bs} = L,
+    RA = parse_content(F, A),
+    RA++parse_contents(F, Bs);
+parse_content(F, {tree, generator, _, G}) ->
+    {generator, _, Gen} = G,
+    parse_content(F, Gen);
+parse_content(F, {tree, clause, _, C}) ->
+    {clause, Clause, When, Second} = C,
+    R2 = parse_contents(F, Clause),
+    R3 = parse_content(F, When),
+    R2++R3++parse_contents(F, Second);
+parse_content(F, {tree, fun_expr, _, E}) ->
+    parse_contents(F, E);
+parse_content(F, {tree, record_expr, _, E}) ->
+    {record_expr, _, _, Records} = E,
+    parse_contents(F, Records);
+parse_content(F, {tree, record_field, _, R}) ->
+    {record_field, F1, F2} = R,
+    R2 = parse_content(F, F1),
+    R2++parse_content(F, F2);
+parse_content(F, {tree, receive_expr, _, E}) ->
+    {receive_expr, E1, _, _} = E,
+    parse_contents(F, E1);
+parse_content(F, {tree, infix_expr, _, I}) ->
+    {infix_expr, _Operator, T1, T2} = I,
+    R = parse_content(F, T1),
+    R++parse_content(F, T2);
+parse_content(_F, {tree, prefix_expr, _, _P}) ->
+    [];
+parse_content(_F, {tree, class_qualifier, _, _}) -> [];
+parse_content(_F, {tree, implicit_fun, _, _}) -> [];
+parse_content(_F, {tree, record_access, _, _}) -> [];
+parse_content(_F, {tree, record_index_expr, _, _}) -> [];
+parse_content(_F, {tree, macro, _, _}) -> [];
+parse_content(_F, {tree, binary, _, _}) -> [];
+parse_content(_F, {tree, binary_generator, _, _}) -> [];
+parse_content(_F, {tree, binary_comp, _, _}) -> [];
+parse_content(_F, {integer, _, _I}) -> [];
+parse_content(_F, {float, _, _I}) -> [];
+parse_content(_F, {string, _, _S}) -> [];
+parse_content(_F, {char, _, _S}) -> [];
+parse_content(_F, {atom, _, _A}) -> [];
+parse_content(_F, {var, _, _V}) -> [];
+parse_content(_F, {nil, _}) -> [];
+parse_content(_F, none) -> [];
+parse_content(_F, C) -> io:format("Unknown content: ~p~n", [C]), [].
+
+parse_application({Fn, Fa}, {application, {atom, _, Name}, Valores}) ->
+    Arity = length(Valores),
+    insert_arc_normal(Fn, Fa, Name, Arity),
+    Ra = [{arc_normal, Fn, Name}],
+    Ra++parse_contents({Fn, Fa}, Valores);
+parse_application({Fn, Fa}, {application, {tree, module_qualifier, _, M}, Tree2}) ->
+    case M of
+	{module_qualifier, {_, _, Tf1}, {_, _, Tf2}} ->
+	    ToArity = length(Tree2),
+	    insert_arc_external(Fn, Fa, Tf1, Tf2, ToArity),
+	    parse_contents({Fn, Fa}, Tree2);
+	_Other ->
+	    %%io:format("Unknown application module_qualifier: ~p~n", [M]),
+	    parse_contents({Fn, Fa}, Tree2)
+    end;
+parse_application({Fn, Fa}, {application, {tree, record_access, _, _}, Tree2}) ->
+    parse_contents({Fn, Fa}, Tree2);
+parse_application({Fn, Fa}, {application, {var, _, _}, Tree2}) ->
+    parse_contents({Fn, Fa}, Tree2);
+parse_application({Fn, Fa}, {application, Other, Tree2}) ->
+    io:format("Unknown application tree: ~p~n", [Other]),
+    parse_contents({Fn, Fa}, Tree2).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Textize
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+textize(ModuleName, Exports, Privates, AppExternals, ExmppExternals, OTPExternals) ->
+    ExportsS = textize_exports(Exports),
+    PrivatesS = textize_exports(Privates),
+    AppExternalsS = textize_externals(AppExternals),
+    ExmppExternalsS = textize_externals(ExmppExternals),
+    OTPExternalsS = textize_externals(OTPExternals),
+    Arcs = textize_arcs(),
+    io_lib:format(
+      "digraph ~p {~n"++
+      "  label = \"Module ~p\";~n"++
+      "  labelloc = \"t\";~n"++
+      "  fontname = Helvetica;~n"++
+      "  rankdir = LR;~n"++
+      "  ratio = fill;~n"++
+      %%"  node [shape = box, style = filled, color = olivedrab1, fontsize=40];~s~n"++
+      %%"  node [shape = parallelogram, style = filled, color = rosybrown1, fontsize=40];~s~n"++
+      %%"  node [shape = ellipse, style = filled, color = slategray1, peripheries=3, fontsize=40];~n"++
+      "  node [shape = box, color=darkgreen, fillcolor=Honeydew,    style=filled, href=\"PRI~p.html#\\N\"];~s~n"++
+      "  node [shape = box, color=darkgreen, fillcolor=PaleGreen,   style=filled, href=\"EXP~p.html#\\N\"];~s~n"++
+      "  node [shape = box, color=darkgreen, fillcolor=Aquamarine,  style=filled, href=\"APP\\N\"];~s~n"++
+      "  node [shape = box, color=darkblue,  fillcolor=LightSkyBlue,style=filled, href=\"EXM\\N\"];~s~n"++
+      "  node [shape = box, color=darkred,   fillcolor=PeachPuff,   style=filled, href=\"OTP\\N\"];~s~n"++
+      "  node [shape = box];~n"++
+      "~s"++
+      "}~n",
+      [ModuleName, ModuleName,
+       ModuleName, PrivatesS,
+       ModuleName, ExportsS,
+       AppExternalsS,
+       ExmppExternalsS,
+       OTPExternalsS,
+       Arcs]).
+
+textize_exports(Exports) ->
+    lists:foldl(
+      fun({Func, Arity}, R) ->
+	      string:concat(R, io_lib:format(" \"~p/~p\";", [Func, Arity]))
+      end,
+      "",
+      Exports).
+
+textize_externals(Externals) ->
+    lists:foldl(
+      fun({Mod, Func, Arity}, R) ->
+	      string:concat(R, io_lib:format(" \"~p:~p/~p\";", [Mod, Func, Arity]));
+         ({Func, Arity}, R) ->
+	      string:concat(R, io_lib:format(" \"~p/~p\";", [Func, Arity]))
+      end,
+      "",
+      Externals).
+
+textize_arcs() ->
+    Id = ets:first(arcs),
+    textize_arcs(Id, []).
+
+textize_arcs('$end_of_table', Res) -> Res;
+textize_arcs(Id, Res) ->
+    [Arc] = read_arc(Id),
+    From = mfa_prepare(Arc#arcs.from),
+    To = mfa_prepare(Arc#arcs.to),
+    Edge_attrs = check_loop(From, To)++check_occu(Arc#arcs.occ)++check_external(Arc#arcs.to),
+    Res2 = io_lib:format("  ~s -> ~s~s;~n", [From, To, Edge_attrs]),
+    Id_next = ets:next(arcs, Id),
+    textize_arcs(Id_next, string:concat(Res2, Res)).
+
+get_func_calls() ->
+    Id = ets:first(arcs),
+    get_func_calls(Id, []).
+
+get_func_calls('$end_of_table', Res) -> Res;
+get_func_calls(Id, Res) ->
+    [Arc] = read_arc(Id),
+    MFA = Arc#arcs.to,
+    Call = MFA,
+    Id_next = ets:next(arcs, Id),
+    get_func_calls(Id_next, [Call | Res]).
+
+mfa_prepare(MFAinitial) ->
+    MFA = try_mfa_conversion(MFAinitial),
+    Mod = case MFA#mfa.mod of
+	      -1 -> "\"";
+	      M -> io_lib:format("\"~p:", [M])
+	  end,
+    Func = io_lib:format("~p", [MFA#mfa.func]),
+    Arity = case MFA#mfa.arity of
+		-1 -> "\"";
+		A -> io_lib:format("/~p\"", [A])
+	    end,
+    string:concat(Mod, string:concat(Func, Arity)).
+
+%% noexternal | app | exmpp | other
+mfa_to_externaltype(MFA, ModuleName, AppModules, Functions) ->
+    case MFA of
+	{mfa, -1, Fu, Ar} ->
+	    case {is_internal, lists:member({Fu, Ar}, Functions)} of
+		{is_internal, true} ->
+		    {noexternal, {Fu, Ar}};
+		{is_internal, false} ->
+		    store_mfa_conversion(MFA, {mfa, -1, Fu, Ar}),
+		    {other, {Fu, Ar}}
+	    end;
+	{mfa, Mo, Fu, Ar} when Mo == ModuleName ->
+	    store_mfa_conversion(MFA, {mfa, -1, Fu, Ar}),
+	    {noexternal, {Fu, Ar}};
+	{mfa, Mo, Fu, Ar} ->
+	    Type = case {is_app, lists:member(Mo, AppModules)} of
+		       {is_app, true} -> app;
+		       {is_app, false} ->
+			   case string:str(atom_to_list(Mo), "exmpp") of
+			       0 -> other;
+			       N when is_integer(N) -> exmpp
+			   end
+		   end,
+	    {Type, {Mo, Fu, Ar}}
+    end.
+
+get_function_arity([{tree, clause, _, {clause, Vars, _, _}} | _]) ->
+    length(Vars);
+get_function_arity(E) ->
+    io:format("Unknown function arity: ~p~n", [E]).
+
+store_mfa_conversion(MFA1, MFA2) ->
+    ets:insert(mfa_conversion, {MFA1, MFA2}).
+
+try_mfa_conversion(MFA) ->
+    case ets:lookup(mfa_conversion, MFA) of
+	[{MFA,MFA2}] ->
+	    MFA2;
+	[] ->
+	    MFA
+    end.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Utils
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%%check_loop(I, I) -> " [color = sandybrown]";
+check_loop(I, I) -> "";
+check_loop(_, _) -> "".
+
+check_occu(1) -> "";
+check_occu(Occ) -> io_lib:format(" [label=\"~p\"]", [Occ]).
+
+check_external(To) ->
+    case To#mfa.mod of
+	-1 -> " [style = bold]";
+	_ -> ""
+    end.

doc/devdoc/process-one.css

@@ -1,3 +1,25 @@
+div.navbar table tr td a[target="_parent"] {
+  background: transparent url("ejabberd-devdoc.png") no-repeat;
+  display: block;
+  font-size: 0%;
+  top: 0;
+  left: 0;
+  padding: 0;
+  margin: 0;
+  width: 192px;
+  height: 42px;
+}
+
+div.navbar table tr td a img {
+  border: 0;
+  padding: 0 0 0 10;
+  float: right;
+}
+
+p i {
+  display: none;
+}
+
 html, body {
   font-family: Verdana, sans-serif;
   color: #000;
@@ -5,19 +27,20 @@ html, body {
 }
 
 h1 {
+  font-size: 20px;
   color: #4a5389;
   border-bottom: solid 1px #000;
 }
 
 h2 {
-  font-size: 24px;
+  font-size: 18px;
   text-align: right;
   color: #4a5389;
   border-bottom: 1px solid #000;
 }
 
 h3 {
-  font-size: 18px;
+  font-size: 16px;
   color: #900;
 }
 
@@ -71,10 +94,22 @@ pre, tt, code {
 }
 
 pre {
-  margin-left: 1em;
+  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/features.html

@@ -2,7 +2,7 @@
             "http://www.w3.org/TR/REC-html40/loose.dtd">
 <HTML>
 <HEAD>
-<TITLE>Ejabberd 2.0.0-beta1 Feature Sheet
+<TITLE>Ejabberd 3.0.0-prealpha Feature Sheet
 </TITLE>
 
 <META http-equiv="Content-Type" content="text/html; charset=US-ASCII">
@@ -47,10 +47,10 @@ SPAN{width:20%; float:right; text-align:left; margin-left:auto;}
 </STYLE>
 </HEAD>
 <BODY >
-<!--HEVEA command line is: /usr/bin/hevea -fix -noiso -pedantic features.tex -->
+<!--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.0.0-beta1 Feature Sheet</H1><H3 CLASS="titlerest">Sander Devrieze<BR>
+</P><TABLE CLASS="title"><TR><TD><H1 CLASS="titlemain">Ejabberd 3.0.0-prealpha Feature Sheet</H1><H3 CLASS="titlerest">Sander Devrieze<BR>
  <A HREF="mailto:s.devrieze@pandora.be"><TT>mailto:s.devrieze@pandora.be</TT></A><BR>
  <A HREF="xmpp:sander@devrieze.dyndns.org"><TT>xmpp:sander@devrieze.dyndns.org</TT></A></H3></TD></TR>
 </TABLE><DIV CLASS="center">
@@ -61,7 +61,7 @@ SPAN{width:20%; float:right; text-align:left; margin-left:auto;}
 </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</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-->
+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;
@@ -70,13 +70,13 @@ Peter Saint-Andr&#XE9;, Executive Director of the Jabber Software Foundation</I>
 <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 interface for administration tasks.
+</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 in 17 languages. </LI><LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>.
+Translated to 24 languages. </LI><LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>.
 </LI></UL></LI><LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Open Standards:</FONT></FONT></B> <TT>ejabberd</TT> is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
 <UL CLASS="itemize"><LI CLASS="li-itemize">
 Fully XMPP compliant.
@@ -97,31 +97,30 @@ Load only the modules you want.
 <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 interface accessible via HTTPS secure access.
+</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 MySQL support.
+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">Mnesia.
 </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">
-PAM, LDAP and ODBC. </LI><LI CLASS="li-itemize">External Authentication script.
-</LI><LI CLASS="li-itemize">Internal Authentication.
+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">
-Compressing XML streams with Stream Compression (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>).
-</LI><LI CLASS="li-itemize">Interface with networks such as AIM, ICQ and MSN.
+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 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.
-</LI><LI CLASS="li-itemize">Support for virtual hosting.
-</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> service.
-</LI><LI CLASS="li-itemize">IRC transport.
+</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with support for clustering and HTML logging. </LI><LI CLASS="li-itemize">Users Directory based on users vCards.
+</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component with support for <A HREF="http://www.xmpp.org/extensions/xep-0163.html">Personal Eventing via Pubsub</A>.
+</LI><LI CLASS="li-itemize">Support for web clients: <A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> and <A HREF="http://www.xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</A> services.
+</LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports.
 </LI></UL>
 </LI></UL><!--CUT END -->
 <!--HTMLFOOT-->

doc/features.tex

@@ -70,7 +70,7 @@
 %% 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}
@@ -133,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

@@ -8,7 +8,7 @@ Joeri}
 
 %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 a \marking{free and open source} instant messaging server written in \footahref{http://www.erlang.org/}{Erlang}.
+\ejabberd{} is a \marking{free and open source} instant messaging server written in \footahref{http://www.erlang.org/}{Erlang/OTP}.
 
 \ejabberd{} is \marking{cross-platform}, distributed, fault-tolerant, and based on open standards to achieve real-time communication.
 
@@ -59,7 +59,7 @@ Peter Saint-Andr\'e, Executive Director of the Jabber Software Foundation}
 \begin{itemize}
 \item Comprehensive documentation.
 \item Straightforward installers for Linux, Mac OS X, and Windows. %%\improved{}
-\item Web interface for administration tasks.
+\item Web Administration.
 \item Shared Roster Groups.
 \item Command line administration tool. %%\improved{}
 \item Can integrate with existing authentication mechanisms.
@@ -68,7 +68,7 @@ Peter Saint-Andr\'e, Executive Director of the Jabber Software Foundation}
 
 \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 17 languages. %%\improved{}
+\item Translated to 24 languages. %%\improved{}
 \item Support for \footahref{http://www.ietf.org/rfc/rfc3490.txt}{IDNA}.
 \end{itemize}
 
@@ -101,7 +101,7 @@ Moreover, \ejabberd{} comes with a wide range of other state-of-the-art features
 \begin{itemize}
 \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}
@@ -125,9 +125,8 @@ Moreover, \ejabberd{} comes with a wide range of other state-of-the-art features
 \item IPv6 support both for c2s and s2s connections.
 \item \txepref{0045}{Multi-User Chat} module with support for clustering and HTML logging. %%\improved{}
 \item Users Directory based on users vCards.
-\item \txepref{0060}{Publish-Subscribe} component with support for \txepref{00163}{Personal Eventing via Pubsub}.
+\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}

doc/release_notes_2.0.0.txt

@@ -1,17 +1,18 @@
-			      Release Notes
-			   ejabberd 2.0.0 beta 1
-			     24 december 2007
+
+                              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 near that 200 improvements over ejabberd
+  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 download page:
-     http://www.process-one.net/en/projects/ejabberd/
+  The new code can be downloaded from ejabberd downloads page:
+     http://www.process-one.net/en/ejabberd/
 
 
    Recent changes include:
@@ -61,21 +62,21 @@
 - Support for LDAP servers pool.
 - Simplified use of virtual hosting with LDAP with domain substitution
   in config.
-- Ability to match on several userid attibutes.
+- Ability to match on several userid attributes.
 
 
-* Multi-user chat
+* 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 autorized users.
+  . 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
+* File Transfer
 
 - XEP-0065 - Proxy65 file transfer proxy. The proxy can run in
   cluster mode.
@@ -87,14 +88,14 @@
 - External Authentication protocol is now fully documented.
 
 
-* Web client support
+* 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 Web2.0 chat
+  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.
@@ -102,23 +103,24 @@
   (bandwidth, packet size).
 
 
-* System administration
+* System Administration
 
 - XEP-0133 - Service administration support. System administrators can
-  now performs lot of ejabberd related admin tasks from their XMPP
+  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 penality is
-  involved when
-- Better command-line tool, with more options available.
+  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 available in 22 languages: Catalan, Chinese, Czech,
-  Dutch, French, Galicia, German, Italian, Japanese, Polish,
-  Portuguese, Portuguese (Brazil), Russian, Slovak, Spanish, Swedish,
-  Thai, Turkish, Ukrainian, Vietnamese, Wallon.
+- 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
@@ -126,11 +128,11 @@
 - 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
+- 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
@@ -141,13 +143,66 @@
 
 * Bugfixes
 
-- ejabberd 2.0 also fixes numerous small bugs :) Read the full
+- ejabberd 2.0.0 also fixes numerous small bugs :) Read the full
   changelog for details.
 
 
-Bugs report
+
+   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
+
+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.5
+
+  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/release_notes_3.0.0.txt

@@ -0,0 +1,104 @@
+
+******************************************************************************
+* These are the preliminary release notes of ejabberd 3.0.0.
+*
+* The download page for preliminary releases is:
+*   http://download.process-one.net/ejabberd/
+*
+*     WARNING!!!  PRELIMINARY DATABASE SCHEMA !!!
+* The database schema may change before ejabberd 3.0.0 is released,
+*   and no migration code will be developed for this preliminary schema.
+* The only supported migrations are
+*   from any ejabberd 0.9.0 ... 2.1.5 to the final 3.0.0.
+* Don't use this preliminary ejabberd release for a production server.
+* You can test this release with a blank database or with a copy of your
+*   production database, but don't let your users connect to this copy
+*   because their changes may get lost when you upgrade to the final 3.0.0.
+******************************************************************************
+
+
+                              Release Notes
+                             ejabberd 3.0.0
+
+  ejabberd 3.0.0 is the first release in the brand new 3.x.x branch,
+  and includes several minor bugfixes and a few improvements.
+
+  Read more details about the changes in:
+    http://redir.process-one.net/ejabberd-3.0.0
+
+  Download the source code and installers from:
+    http://www.process-one.net/en/ejabberd/
+
+
+ejabberd 3.0.0 includes three major changes:
+
+* exmpp is now extensively used in ejabberd for parsing stanzas, and many more.
+
+* gen_storage (abbreviated GS) provides a database abstraction layer,
+  which supports storage in Mnesia and in ODBC databases.
+  Several ejabberd modules use GS, like mod_roster and ejabberd_auth_storage.
+  The schema of the tables stored by those modules have changed,
+  and ejabberd migrates automatically your mnesia and ODBC
+  tables from previous ejabberd releases.
+
+* Massive Hosting (abbreviated MH) is preliminary implemented in ejabberd,
+  but it is still incomplete, untested and undocumented.
+
+
+This is a more detailed list of changes since ejabberd 2.1.5:
+
+* Requirements
+- Erlang/OTP R12B-5 or higher is required
+- exmpp 0.9.5 or higher is required, not optional
+- ESASL library is optional, for SASL GSSAPI authentication
+- Libexpat not required by ejabberd, it uses exmpp now (EJAB-1111)
+- GNU Iconv not required, because mod_irc isn't included anymore (EJAB-954)
+- Only database migration from ejabberd 0.9.0 up to 2.1.5 is supported
+- ejabberd modules developed for previous releases need to be upgraded to exmpp
+
+* Configuration
+- New option clusterid
+- New option that can't be used yet: static_modules
+- ejabberd_auth_storage: new option auth_storage
+- mod_muc_log: option spam_prevention is now link_nofollow (EJAB-1141)
+- mod_roster: new access option (EJAB-72)
+- S2S: allow definition of local address for outgoing connections (EJAB-418)
+
+* Database
+- New gen_storage that provides a database storage abstraction layer (EJAB-1102)
+- mod_*_odbc are obsolete, use the normal ones with the option {backend, odbc}
+- New ejabberd_auth_storage that supports internal and odbc databases
+
+* XEP support
+- Removed support for the deprecated XEP-0018 Invisible Presence (EJAB-810)
+- mod_multicast: service for XEP-0033: Extended Stanza Addressing (EJAB-265)
+- New ejabberd router for multicast packets (XEP-0033) (EJAB-329)
+- ejabberd_c2s uses XEP-0033 if mod_multicast is enabled (EJAB-267)
+- mod_muc uses XEP-0033 if mod_multicast is enabled (EJAB-266)
+
+* Pubsub/PEP/Caps
+- Allow distinguish between leafs and items (EJAB-1027)
+- Enforce disco features results (EJAB-1033, EJAB-1228, EJAB-1238)
+- Enforce pubsub#presence_based_delivery (EJAB-1221)
+- Improve get_caps while still waiting for initial presence (EJAB-934)
+- Make nodetree_tree implicitly create parent node if required (EJAB-944)
+- Only use binary() instead of string() in Host and ServerHost (EJAB-1244)
+- Rename NodeId (pubsub_node.id) bindings to Nidx (EJAB-1000)
+- node_flat becomes default; it has the code instead of hometree (EJAB-1077)
+- pubsub#notify_sub node option (EJAB-1230)
+- pubsub#type node config and payload namespace (EJAB-1083)
+
+* Miscellanea
+- Bugfix handling Service Discovery to contacts (EJAB-1207)
+- Bugfix: external contacts were offline after unavailable presence (EJAB-943)
+- Don't offer SASL auth before doing TLS if TLS is required
+- Experimental support for GSSAPI auth, requires esasl library (EJAB-831)
+- Use binaries instead of lists where possible (EJAB-17)
+- Windows ejabberdctl.cmd only handles up to 4 arguments (EJAB-1216)
+- ejabberdctl: when starting, check it isn't already running
+
+
+  Bug reports
+
+  You can officially report bugs on ProcessOne support site:
+  http://support.process-one.net/

doc/version.tex

@@ -1,2 +1,2 @@
 % ejabberd version (automatically generated).
-\newcommand{\version}{2.0.0-beta1}
+\newcommand{\version}{3.0.0-alpha-x}

examples/mtr/ejabberd-netbsd.sh

@@ -70,7 +70,7 @@ done
 echo '7. compile ejabberd'
 
 gmake
-for A in mod_irc mod_muc mod_pubsub; do
+for A in mod_muc mod_pubsub; do
     (cd $A; gmake)
 done
 

src/Makefile.in

@@ -1,79 +1,145 @@
-# $Id$
-
 CC = @CC@
 CFLAGS = @CFLAGS@
 CPPFLAGS = @CPPFLAGS@
 LDFLAGS = @LDFLAGS@
 LIBS = @LIBS@
 
-EXPAT_CFLAGS = @EXPAT_CFLAGS@
 ERLANG_CFLAGS= @ERLANG_CFLAGS@
 
-EXPAT_LIBS = @EXPAT_LIBS@
 ERLANG_LIBS = @ERLANG_LIBS@
 
 ASN_FLAGS = -bber_bin +der +compact_bit_string +optimize +noobj
-# make debug=true to compile Erlang module with debug informations.
-ifdef debug
-  ERLC_FLAGS+=+debug_info
+
+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 += -pa .
+
+# make debug=true to compile Erlang module with debug informations.
+ifdef debug
+  EFLAGS+=+debug_info +export_all
+endif
+
+DEBUGTOOLS = p1_prof.erl etop_tr.erl
+ifdef debugtools
+  SOURCES+=$(DEBUGTOOLS)
 endif
 
 ifeq (@hipe@, true)
-  ERLC_FLAGS+=+native
+  EFLAGS+=+native
 endif
 
 ifeq (@roster_gateway_workaround@, true)
-  ERLC_FLAGS+=-DROSTER_GATEWAY_WORKAROUND
+  EFLAGS+=-DROSTER_GATEWAY_WORKAROUND
 endif
 
 ifeq (@full_xml@, true)
-  ERLC_FLAGS+=-DFULL_XML_SUPPORT
+  EFLAGS+=-DFULL_XML_SUPPORT
 endif
 
 ifeq (@transient_supervisors@, false)
-  ERLC_FLAGS+=-DNO_TRANSIENT_SUPERVISORS
+  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@ @mod_proxy65@ @eldap@ @pam@ @web@ stringprep @tls@ @odbc@ @ejabberd_zlib@
-ERLSHLIBS = expat_erl.so
+SUBDIRS = stun @mod_pubsub@ @mod_muc@ @mod_proxy65@ @eldap@ @pam@ @web@ @tls@ @odbc@ @ejabberd_zlib@
+ERLSHLIBS =
 ERLBEHAVS = cyrsasl.erl gen_mod.erl p1_fsm.erl
-SOURCES = $(ERLBEHAVS) $(wildcard *.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
-SBINDIR = $(DESTDIR)@prefix@/sbin
 
-ifeq ($(shell uname),Darwin)
-DYNAMIC_LIB_CFLAGS = -fPIC -bundle -flat_namespace -undefined suppress
-else
+# /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 \
-clean-recursive distclean-recursive \
+clean-recursive distclean-recursive devdoc-recursive \
 mostlyclean-recursive maintainer-clean-recursive:
 	@subdirs="$(SUBDIRS)"; for subdir in $$subdirs; do \
 	target=`echo $@|sed 's,-recursive,,'`; \
@@ -84,52 +150,137 @@ mostlyclean-recursive maintainer-clean-recursive:
 
 %.hrl: %.asn1
 	@ERLC@ $(ASN_FLAGS) $<
-	@ERLC@ -W $(ERLC_FLAGS) $*.erl
+	@ERLC@ -W $(EFLAGS) $*.erl
 
 $(ERLSHLIBS):	%.so:	%.c
-			$(CC) $(CFLAGS) $(LDFLAGS) $(LIBS) \
-			$(subst ../,,$(subst .so,.c,$@)) \
-			$(EXPAT_LIBS) $(EXPAT_CFLAGS) \
-			$(ERLANG_LIBS) $(ERLANG_CFLAGS) \
-			-o $@ $(DYNAMIC_LIB_CFLAGS)
+	$(CC) $(CFLAGS) $(LDFLAGS) $(LIBS) \
+		$(subst ../,,$(subst .so,.c,$@)) \
+		$(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)
-	-install -m 750 epam $(SODIR)
+	#
+	# Translated strings
 	install -d $(MSGSDIR)
 	install -m 644 msgs/*.msg $(MSGSDIR)
-	install -d $(ETCDIR)
-	[ -f $(ETCDIR)/ejabberd.cfg ] && install -b -m 644 ejabberd.cfg.example $(ETCDIR)/ejabberd.cfg-new || install -b -m 644 ejabberd.cfg.example $(ETCDIR)/ejabberd.cfg
-	sed -e "s*@rootdir@*@prefix@*" ejabberdctl.template > ejabberdctl.example
-	[ -f $(ETCDIR)/ejabberdctl.cfg ] && install -b -m 644 ejabberdctl.cfg.example $(ETCDIR)/ejabberdctl.cfg-new || install -b -m 644 ejabberdctl.cfg.example $(ETCDIR)/ejabberdctl.cfg
-	install -b -m 644 ejabberd.inetrc $(ETCDIR)/ejabberd.inetrc
-	install -d $(SBINDIR)
-	install -m 755 ejabberdctl.example $(SBINDIR)/ejabberdctl
-	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 -rf $(BEAMDIR)
-	rm -rf $(SODIR)
-	rm -rf $(MSGSDIR)
-	rm -rf $(PRIVDIR)
-	rm -rf $(SBINDIR)/ejabberdctl
+	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 $(LOGDIR)
 	rm -rf $(EJABBERDDIR)
+	rm -rf $(SPOOLDIR)
+	rm -rf $(CTLLOCKDIR)
+	rm -rf $(LOGDIR)
 
-clean: clean-recursive clean-local
+clean: clean-recursive clean-local clean-devdoc
 
 clean-local:
-	rm -f *.beam $(ERLSHLIBS) epam
+	rm -f *.beam $(ERLSHLIBS) epam ejabberdctl.example
 	rm -f XmppAddr.asn1db XmppAddr.erl XmppAddr.hrl
 
 distclean: distclean-recursive clean-local
@@ -145,3 +296,89 @@ Makefile: Makefile.in
 dialyzer: $(BEAMS)
 	@dialyzer -c .
 
+## Devdoc definitions
+SRCDIR=.
+DDTDIR=.
+DEVDOCDIR=../doc/devdoc
+DEVDOC_ERLS = $(wildcard ../doc/devdoc/*.erl)
+DEVDOC_BEAMS = $(DEVDOC_ERLS:.erl=.beam)
+APPNAME = ejabberd
+VSN = $(shell sed '/vsn/!d;s/\(.*\)"\(.*\)"\(.*\)/\2/' ./ejabberd.app)
+.PHONY = all
+HTMLS = $(SOURCES:%.erl=../doc/devdoc/%.html)
+ERLHTMLS = $(SOURCES:%.erl=../doc/devdoc/%.erl.html)
+SVGS = $(SOURCES:%.erl=../doc/devdoc/%.svg)
+EDOCINDEX = $(DEVDOCDIR)/index.html
+
+## Devdoc rules
+devdoc: compile-devdoc devdoc-root devdoc-recursive
+	$(devdoc-customize)
+	$(devdoc-move)
+devdoc-root: $(EDOCINDEX) $(HTMLS) $(ERLHTMLS) $(SVGS)
+
+define devdoc-customize
+find $(DDTDIR) -type f -name '*.erl.html' -exec sed -i 's/<span class="attribute" >module<\/span>(\([A-Za-z0-9_]*\))/<span class="attribute" >module<\/span>(<a href="\1.html">\1<\/a>)/g;' {} \;
+find $(DDTDIR) -type f -name '*.erl.html' -exec sed -i 's/arity="\([0-9]*\)" >\([A-Za-z0-9_]*\)</><a class="function" id="\2-\1" href="EDOCFILENAME#\2-\1">\2<\/a></g;' {} \;
+find $(DDTDIR) -type f -name '*.erl.html' -exec sed -i 's/class="export" >\([A-Za-z0-9_]*\)\/\([0-9]*\)</class="export" ><a href="#\1-\2">\1\/\2<\/a></g;' {} \;
+for fn in *.erl.html; do \
+    sed -i 's/EDOCFILENAME/'$${fn%.erl.html}.html'/g;' $${fn} ; \
+    sed = $${fn} | sed 'N;s/\n/ /;s/^\([0-9_]*\)/<a href="#\1" name="\1" class="l">\1<\/a>/' >$${fn}.tmp ; \
+    mv $${fn}.tmp $${fn} ; \
+    sed -i 's/<a href="#1" name="1" class="l">1<\/a> <html><link rel="stylesheet" type="text\/css"href="escobar.css"><\/link><body><pre><span class="comment" >/<html><link rel="stylesheet" type="text\/css" href="escobar.css"><\/link><body><pre><span class="comment" ><a href="#1" name="1" class="l">1<\/a> /g;' $${fn} ; \
+done
+-mv *.erl.html $(DEVDOCDIR)
+
+find $(DDTDIR) -type f -name '*.html' -exec sed -i 's/<a href="overview-summary.html" target="overviewFrame">/<a href="index.html" target="_parent">/g;' {} \;
+find $(DDTDIR) -type f -name '*.html' -exec sed -i 's/align=\"right\" border=\"0\" alt=\"erlang logo\"/alt=\"erlang logo\"><\/a><a href=\"http:\/\/www.ejabberd.im\/\"><img src=\"ejabberd-im.png\" alt=\"ejabberd Community\"><\/a><a href=\"http:\/\/www.process-one.net\/en\/ejabberd\/\"><img src=\"ejabberd-p1.png\" alt=\"ejabberd home\"><\/a><a href=\"http:\/\/www.process-one.net\/\"><img src=\"process-one.png\" alt=\"ProcessOne\"/g;' {} \;
+find $(DDTDIR) -type f -name '*.html' -exec sed -i 's/^<h1>Module \([A-Za-z0-9_]*\)<\/h1>/<h1>Module \1 [<a href="\1.erl.html">erl<\/a> <a href="\1.svg">svg<\/a>]<\/h1>/g;' {} \;
+find $(DDTDIR) -type f -name '*.html' -exec sed -i 's/class="function"><a name="\([A-Za-z0-9_]*\)-\([0-9_]*\)">/class="function"><a name="\1-\2" href="ESCOFILENAME#\1-\2">/g;' {} \;
+-for fn in *.html; do sed -i 's/ESCOFILENAME/'$${fn%.html}.erl.html'/g;' $${fn} ; done
+
+find $(DDTDIR) -type f -name '*.svg' -exec sed -i 's/xlink:href="EXP\([A-Za-z0-9_]*\).html#\([A-Za-z0-9_]*\)\/\([0-9_]*\)"/xlink:href="\1.html#\2-\3"/g;' {} \;
+find $(DDTDIR) -type f -name '*.svg' -exec sed -i 's/xlink:href="PRI\([A-Za-z0-9_]*\).html#\([A-Za-z0-9_]*\)\/\([0-9_]*\)"/xlink:href="\1.html#\2-\3"/g;' {} \;
+find $(DDTDIR) -type f -name '*.svg' -exec sed -i 's/xlink:href="APP\([A-Za-z0-9_]*\):\([A-Za-z0-9_]*\)\/\([0-9_]*\)"/xlink:href="\1.html#\2-\3"/g;' {} \;
+find $(DDTDIR) -type f -name '*.svg' -exec sed -i 's/xlink:href="EXM\([A-Za-z0-9_]*\):\([A-Za-z0-9_]*\)\/\([0-9_]*\)"/xlink:href="http:\/\/www.process-one.net\/docs\/exmpp\/devdoc\/trunk\/\1.html#\2-\3"/g;' {} \;
+find $(DDTDIR) -type f -name '*.svg' -exec sed -i 's/xlink:href="OTP\([A-Za-z0-9_]*\):\([A-Za-z0-9_]*\)\/\([0-9_]*\)"/xlink:href="http:\/\/www.erlang.org\/doc\/man\/\1.html#\2-\3"/g;' {} \;
+find $(DDTDIR) -type f -name '*.svg' -exec sed -i 's/xlink:href="OTP\([A-Za-z0-9_]*\)\/\([0-9_]*\)"/xlink:href="http:\/\/www.erlang.org\/doc\/man\/erlang.html#\1-\2"/g;' {} \;
+endef
+
+define devdoc-move
+-rm *.dot
+-mv *.html $(DEVDOCDIR)
+-mv *.svg $(DEVDOCDIR)
+endef
+
+compile-devdoc: $(DEVDOC_BEAMS)
+	[ ! -f funrelg.beam ] || mv funrelg.beam $(DEVDOCDIR)
+	[ ! -f escobar_hilite.beam ] || mv escobar_hilite.beam $(DEVDOCDIR)
+	[ ! -f escobar_run.beam ] || mv escobar_run.beam $(DEVDOCDIR)
+
+$(EDOCINDEX): 
+	@ERL@ -noshell -run edoc_run application "'$(APPNAME)'" '"$(SRCDIR)"' \
+	'[{dir,"$(DDTDIR)"},{packages,false},{todo,true},{private,true},{def,{vsn,"$(VSN)"}},{stylesheet,"process-one.css"},{overview,"overview.edoc"}]' -s init stop
+	sed -i 's/<title>The ejabberd application<\/title>/<title>ejabberd devdoc<\/title><link rel="shortcut icon" href="favicon.ico" type="image\/x-icon"\/>/g;' $(DDTDIR)/index.html
+	mv edoc-info $(DEVDOCDIR)
+	mv *.png $(DEVDOCDIR)
+	cp *.html $(DEVDOCDIR)
+	@ERL@ -noshell -pa $(DEVDOCDIR) -run escobar_run dir $(SRCDIR) $(SRCDIR) -s init stop
+	@ERL@ -noshell -pa $(DEVDOCDIR) -run funrelg dir $(SRCDIR) $(SRCDIR) -s init stop
+	$(devdoc-customize)
+	$(devdoc-move)
+
+$(DEVDOCDIR)/%.erl.html: %.erl
+	@ERL@ -noshell -pa $(DEVDOCDIR) -run escobar_run file $< $(SRCDIR) -s init stop
+
+$(DEVDOCDIR)/%.html: %.erl
+	@ERL@ -noshell -run edoc_run file $< \
+	'[{dir,"$(DDTDIR)"},{packages,false},{todo,true},{private,true},{def,{vsn,"$(VSN)"}},{stylesheet,"process-one.css"},{overview,"overview.edoc"}]' -s init stop
+
+$(DEVDOCDIR)/%.svg: %.erl
+	@ERL@ -noshell -pa $(DEVDOCDIR) -run funrelg file $< $(SRCDIR) -s init stop
+
+clean-devdoc:
+	rm -f $(DEVDOCDIR)/edoc-info
+	rm -f $(DEVDOCDIR)/erlang.png
+	rm -f $(DEVDOCDIR)/*.beam
+	rm -f $(DEVDOCDIR)/*.dot
+	rm -f $(DEVDOCDIR)/*.html
+	rm -f $(DEVDOCDIR)/*.svg

src/Makefile.win32

@@ -52,9 +52,6 @@ release : build release_clean
 	mkdir $(SRC_DIR)\eldap
 	copy eldap\eldap.* $(SRC_DIR)\eldap
 	copy eldap\ELDAPv3.asn $(SRC_DIR)\eldap
-	mkdir $(SRC_DIR)\mod_irc
-	copy mod_irc\*.erl $(SRC_DIR)\mod_irc
-	copy mod_irc\*.c $(SRC_DIR)\mod_irc
 	mkdir $(SRC_DIR)\mod_muc
 	copy mod_muc\*.erl $(SRC_DIR)\mod_muc
 	mkdir $(SRC_DIR)\mod_pubsub
@@ -66,6 +63,9 @@ release : build release_clean
 	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
@@ -82,17 +82,15 @@ release : build release_clean
 	copy ..\doc\*.html $(DOC_DIR)
 	copy ..\doc\*.png $(DOC_DIR)
 
-SOURCE = expat_erl.c
-OBJECT = expat_erl.o
-DLL    = expat_erl.dll
+SOURCE =
+OBJECT =
+DLL    =
 
 build : $(DLL) compile-beam all-recursive
 
 all-recursive :
 	cd eldap
 	nmake -nologo -f Makefile.win32
-	cd ..\mod_irc
-	nmake -nologo -f Makefile.win32
 	cd ..\mod_muc
 	nmake -nologo -f Makefile.win32
 	cd ..\mod_pubsub
@@ -101,6 +99,8 @@ all-recursive :
 	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
@@ -122,8 +122,6 @@ CLEAN : clean-recursive clean-local
 clean-local :
 	-@erase $(OBJECT)
 	-@erase $(DLL)
-	-@erase expat_erl.exp
-	-@erase expat_erl.lib
 	-@erase *.beam
 	-@erase XmppAddr.asn1db
 	-@erase XmppAddr.erl
@@ -132,8 +130,6 @@ clean-local :
 clean-recursive :
 	cd eldap
 	nmake -nologo -f Makefile.win32 clean
-	cd ..\mod_irc
-	nmake -nologo -f Makefile.win32 clean
 	cd ..\mod_muc
 	nmake -nologo -f Makefile.win32 clean
 	cd ..\mod_pubsub
@@ -142,6 +138,8 @@ clean-recursive :
 	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
@@ -157,14 +155,13 @@ distclean : release_clean clean
 	-@erase Makefile.inc
 
 CC=cl.exe
-CC_FLAGS=-nologo -D__WIN32__ -DWIN32 -DWINDOWS -D_WIN32 -DNT $(EXPAT_FLAG) -MD -Ox -I"$(ERLANG_DIR)\usr\include" -I"$(EI_DIR)\include" -I"$(EXPAT_DIR)\source\lib"
+CC_FLAGS=-nologo -D__WIN32__ -DWIN32 -DWINDOWS -D_WIN32 -DNT -MD -Ox -I"$(ERLANG_DIR)\usr\include" -I"$(EI_DIR)\include"
 
 LD=link.exe
-LD_FLAGS=-release -nologo -incremental:no -dll "$(EI_DIR)\lib\ei_md.lib" "$(EI_DIR)\lib\erl_interface_md.lib" "$(EXPAT_LIB)" MSVCRT.LIB kernel32.lib advapi32.lib gdi32.lib user32.lib comctl32.lib comdlg32.lib shell32.lib
+LD_FLAGS=-release -nologo -incremental:no -dll "$(EI_DIR)\lib\ei_md.lib" "$(EI_DIR)\lib\erl_interface_md.lib" MSVCRT.LIB kernel32.lib advapi32.lib gdi32.lib user32.lib comctl32.lib comdlg32.lib shell32.lib
 
 $(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

@@ -5,7 +5,7 @@
 %%% Created : 18 Jan 2003 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -32,13 +32,45 @@
 	 add/3,
 	 add_list/3,
 	 match_rule/3,
+	 for_host/1,
 	 % for debugging only
 	 match_acl/3]).
 
 -include("ejabberd.hrl").
+-include_lib("stdlib/include/ms_transform.hrl").
+
+%% @type aclspec() = all | JID_Exact | JID_Regexp | JID_Glob | Shared_Group
+%%     JID_Exact = {user, U} | {user, U, S} | {server, S} | {resource, R}
+%%         U = string()
+%%         S = string()
+%%         R = string()
+%%     JID_Regexp = {user_regexp, UR} | {user_regexp, UR, S} | {server_regexp, SR} | {resource_regexp, RR} | {node_regexp, UR, SR}
+%%         UR = string()
+%%         SR = string()
+%%         RR = string()
+%%     JID_Glob = {user_glob, UG} | {user_glob, UG, S} | {server_glob, SG} | {resource_glob, RG} | {node_glob, UG, SG}
+%%         UG = string()
+%%         SG = string()
+%%         RG = string()
+%%     Shared_Group = {shared_group, G} | {shared_group, G, H}
+%%         G = string()
+%%         H = string().
+
+%% @type acl() = {acl, ACLName, ACLSpec}
+%%     ACLName = atom()
+%%     ACLSpec = aclspec().
+%% Record in its Ejabberd-configuration-file variant.
+
+%% @type storedacl() = {acl, {ACLName, Host}, ACLSpec}
+%%     ACLName = atom()
+%%     Host = global | string()
+%%     ACLSpec = aclspec().
+%% Record in its Mnesia-table-record variant.
 
 -record(acl, {aclname, aclspec}).
 
+%% @spec () -> ok
+
 start() ->
     mnesia:create_table(acl,
 			[{disc_copies, [node()]},
@@ -47,16 +79,32 @@ start() ->
     mnesia:add_table_copy(acl, node(), ram_copies),
     ok.
 
+%% @spec (Host, ACLName, ACLSpec) -> storedacl()
+%%     Host = global | string()
+%%     ACLName = atom()
+%%     ACLSpec = aclspec()
+
 to_record(Host, ACLName, ACLSpec) ->
-    #acl{aclname = {ACLName, Host}, aclspec = ACLSpec}.
+    #acl{aclname = {ACLName, Host}, aclspec = normalize_spec(ACLSpec)}.
+
+%% @spec (Host, ACLName, ACLSpec) -> {atomic, ok} | {aborted, Reason}
+%%     Host = global | string()
+%%     ACLName = atom()
+%%     ACLSpec = all | none | aclspec()
+%%     Reason = term()
 
 add(Host, ACLName, ACLSpec) ->
     F = fun() ->
 		mnesia:write(#acl{aclname = {ACLName, Host},
-				  aclspec = ACLSpec})
+				  aclspec = normalize_spec(ACLSpec)})
 	end,
     mnesia:transaction(F).
 
+%% @spec (Host, ACLs, Clear) -> ok | false
+%%     Host = global | string()
+%%     ACLs = [acl()]
+%%     Clear = bool()
+
 add_list(Host, ACLs, Clear) ->
     F = fun() ->
 		if
@@ -75,7 +123,7 @@ add_list(Host, ACLs, Clear) ->
 					       aclspec = ACLSpec} ->
 					      mnesia:write(
 						#acl{aclname = {ACLName, Host},
-						     aclspec = ACLSpec})
+						     aclspec = normalize_spec(ACLSpec)})
 				      end
 			      end, ACLs)
 	end,
@@ -86,7 +134,33 @@ add_list(Host, ACLs, Clear) ->
 	    false
     end.
 
+%% @spec (String) -> Prepd_String
+%%     String = string()
+%%     Prepd_String = string()
 
+normalize(String) ->
+    exmpp_stringprep:nodeprep(String).
+
+%% @spec (ACLSpec) -> Normalized_ACLSpec
+%%     ACLSpec = all | none | aclspec()
+%%     Normalized_ACLSpec = aclspec()
+
+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.
+
+
+
+%% @spec (Host, Rule, JID) -> Access
+%%     Host = global | string()
+%%     Rule = all | none | atom()
+%%     JID = exmpp_jid:jid()
+%%     Access = allow | deny | atom()
 
 match_rule(global, Rule, JID) ->
     case Rule of
@@ -132,23 +206,37 @@ match_rule(Host, Rule, JID) ->
 	    end
     end.
 
+%% @spec (ACLs, JID, Host) -> Access
+%%     ACLs = [{Access, ACLName}]
+%%         Access = deny | atom()
+%%         ACLName = atom()
+%%     JID = exmpp_jid:jid()
+%%     Host = string()
+
 match_acls([], _, _Host) ->
     deny;
-match_acls([{Access, ACL} | ACLs], JID, Host) ->
-    case match_acl(ACL, JID, Host) of
+match_acls([{Access, ACLName} | ACLs], JID, Host) ->
+    case match_acl(ACLName, JID, Host) of
 	true ->
 	    Access;
 	_ ->
 	    match_acls(ACLs, JID, Host)
     end.
 
-match_acl(ACL, JID, Host) ->
-    case ACL of
+%% @spec (ACLName, JID, Host) -> bool()
+%%     ACLName = all | none | atom()
+%%     JID = exmpp_jid:jid()
+%%     Host = string()
+
+match_acl(ACLName, JID, Host) ->
+    case ACLName of
 	all -> true;
 	none -> false;
 	_ ->
-	    {User, Server, _Resource} = jlib:jid_tolower(JID),
-	    lists:any(fun(#acl{aclspec = Spec}) ->
+	    User = exmpp_jid:prep_node_as_list(JID),
+	    Server = exmpp_jid:prep_domain_as_list(JID),
+	    Resource = exmpp_jid:prep_resource_as_list(JID),
+	    lists:any(fun(#acl{aclname=Name, aclspec = Spec}) ->
 			      case Spec of
 				  all ->
 				      true;
@@ -157,28 +245,40 @@ match_acl(ACL, JID, Host) ->
 					  andalso
 					    ((Host == Server) orelse
 					     ((Host == global) andalso
-					      lists:member(Server, ?MYHOSTS)));
+					      ?IS_MY_HOST(Server)));
 				  {user, U, S} ->
 				      (U == User) andalso (S == Server);
 				  {server, S} ->
 				      S == Server;
+				  {resource, R} ->
+				      R == Resource;
+                                  {user_regexp, UR} when is_tuple(Name),
+                                                         element(2, Name) =:= global ->
+                                      ?IS_MY_HOST(Server)
+					  andalso is_regexp_match(User, UR);
 				  {user_regexp, UR} ->
 				      ((Host == Server) orelse
 				       ((Host == global) andalso
-					lists:member(Server, ?MYHOSTS)))
+					?IS_MY_HOST(Server)))
 					  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);
 				  {user_glob, UR} ->
 				      ((Host == Server) orelse
 				       ((Host == global) andalso
-					lists:member(Server, ?MYHOSTS)))
+					?IS_MY_HOST(Server)))
 					  andalso
 					  is_glob_match(User, UR);
 				  {user_glob, UR, S} ->
@@ -186,6 +286,8 @@ 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);
@@ -197,24 +299,41 @@ match_acl(ACL, JID, Host) ->
 				      false
 			      end
 		      end,
-		      ets:lookup(acl, {ACL, global}) ++
-		      ets:lookup(acl, {ACL, Host}))
+		      ets:lookup(acl, {ACLName, global}) ++
+		      ets:lookup(acl, {ACLName, Host}))
     end.
 
+%% @spec (String, RegExp) -> bool()
+%%     String = string() | undefined
+%%     RegExp = string()
+
+is_regexp_match(undefined, _RegExp) ->
+    false;
 is_regexp_match(String, RegExp) ->
-    case regexp:first_match(String, RegExp) of
+    try re:run(String, RegExp, [{capture, none}]) of
 	nomatch ->
 	    false;
-	{match, _, _} ->
-	    true;
-	{error, ErrDesc} ->
+	match ->
+	    true
+    catch
+	_:ErrDesc ->
 	    ?ERROR_MSG(
-	       "Wrong regexp ~p in ACL: ~p",
-	       [RegExp, lists:flatten(regexp:format_error(ErrDesc))]),
+	       "Wrong regexp ~p in ACL:~n~p",
+	       [RegExp, ErrDesc]),
 	    false
     end.
 
+%% @spec (String, Glob) -> bool()
+%%     String = string() | undefined
+%%     Glob = string()
+
 is_glob_match(String, Glob) ->
-    is_regexp_match(String, regexp:sh_to_awk(Glob)).
+    is_regexp_match(String, xmerl_regexp:sh_to_awk(Glob)).
 
 
+for_host(Host) ->
+    mnesia:select(acl,
+		ets:fun2ms(fun (#acl{aclname = {_ACLName, H}}) 
+		                when H =:= Host ->
+				    object()
+		end)).

src/aclocal.m4

@@ -1,55 +1,22 @@
-AC_DEFUN(AM_WITH_EXPAT,
-[ AC_ARG_WITH(expat,
-	      [  --with-expat=PREFIX	prefix where EXPAT is installed])
-
-  EXPAT_CFLAGS=
-  EXPAT_LIBS=
-	if test x"$with_expat" != x; then
-		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])
-	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)
-])
-
 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"
@@ -57,33 +24,34 @@ AC_DEFUN(AM_WITH_ZLIB,
        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,
-	      [  --with-pam=PREFIX	prefix where PAM is installed])
-
+	      [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_WARN([Could not find the PAM library])
+		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"
@@ -91,29 +59,30 @@ AC_DEFUN(AM_WITH_PAM,
        CPPFLAGS="$CPPFLAGS $PAM_CFLAGS"
 	AC_CHECK_HEADERS(security/pam_appl.h, , pam_found=no)
 	if test $pam_found = no; then
-		AC_MSG_WARN([Could not find security/pam_appl.h])
+		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)
-   
+
    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').
 
@@ -122,8 +91,14 @@ AC_DEFUN(AM_WITH_ERLANG,
 start() ->
     EIDirS = code:lib_dir("erl_interface") ++ "\n",
     EILibS =  libpath("erl_interface") ++ "\n",
+    EXMPPDir = code:lib_dir("exmpp"),
+    case EXMPPDir of
+        {error, bad_name} -> exit("exmpp not found");
+        _                 -> ok
+    end,
+    EXMPPDirS = EXMPPDir ++ "\n",
     RootDirS = code:root_dir() ++ "\n",
-    file:write_file("conftest.out", list_to_binary(EIDirS ++ EILibS ++ RootDirS)),
+    file:write_file("conftest.out", list_to_binary(EIDirS ++ EILibS ++ EXMPPDirS ++ RootDirS)),
     halt().
 
 %% return physical architecture based on OS/Processor
@@ -154,45 +129,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_EXMPP=`cat conftest.out | head -n 3 | tail -n 1`
+   # End line
    ERLANG_DIR=`cat conftest.out | tail -n 1`
-   
+
    ERLANG_CFLAGS="-I$ERLANG_EI_DIR/include -I$ERLANG_DIR/usr/include"
    ERLANG_LIBS="-L$ERLANG_EI_LIB -lerl_interface -lei"
-   
+
    AC_SUBST(ERLANG_CFLAGS)
    AC_SUBST(ERLANG_LIBS)
+   AC_SUBST(ERLANG_EXMPP)
    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
@@ -205,100 +182,10 @@ AC_SUBST(make_$1)
 
 ])
 
-
-dnl From Bruno Haible.
-
-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], [
-    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
-      if test -d $dir/lib; then LDFLAGS="$LDFLAGS -L$dir/lib"; fi
-    done
-   ])
-
-  AC_CACHE_CHECK(for iconv, am_cv_func_iconv, [
-    am_cv_func_iconv="no, consider installing GNU libiconv"
-    am_cv_lib_iconv=no
-    AC_TRY_LINK([#include <stdlib.h>
-#include <iconv.h>],
-     [iconv_t cd = iconv_open("","");
-       iconv(cd,NULL,NULL,NULL,NULL);
-       iconv_close(cd);],
-       am_cv_func_iconv=yes)
-    if test "$am_cv_func_iconv" != yes; then
-      am_save_LIBS="$LIBS"
-      LIBS="$LIBS -liconv"
-      AC_TRY_LINK([#include <stdlib.h>
-#include <iconv.h>],
-        [iconv_t cd = iconv_open("","");
-         iconv(cd,NULL,NULL,NULL,NULL);
-         iconv_close(cd);],
-        am_cv_lib_iconv=yes
-        am_cv_func_iconv=yes)
-      LIBS="$am_save_LIBS"
-    fi
-	dnl trying /usr/local
-    if test "$am_cv_func_iconv" != yes; then
-      am_save_LIBS="$LIBS"
-	  am_save_CFLAGS="$CFLAGS"
-	  am_save_LDFLAGS="$LDFLAGS"
-      LIBS="$LIBS -liconv"
-	  LDFLAGS="$LDFLAGS -L/usr/local/lib"
-	  CFLAGS="$CFLAGS -I/usr/local/include"
-      AC_TRY_LINK([#include <stdlib.h>
-#include <iconv.h>],
-        [iconv_t cd = iconv_open("","");
-         iconv(cd,NULL,NULL,NULL,NULL);
-         iconv_close(cd);],
-        am_cv_lib_iconv=yes
-        am_cv_func_iconv=yes
-		CPPFLAGS="$CPPFLAGS -I/usr/local/include",
-		LDFLAGS="$am_save_LDFLAGS"
-		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.])
-    AC_MSG_CHECKING([for iconv declaration])
-    AC_CACHE_VAL(am_cv_proto_iconv, [
-      AC_TRY_COMPILE([
-#include <stdlib.h>
-#include <iconv.h>
-extern
-#ifdef __cplusplus
-"C"
-#endif
-#if defined(__STDC__) || defined(__cplusplus)
-size_t iconv (iconv_t cd, char * *inbuf, size_t *inbytesleft, char * *outbuf, size_t *outbytesleft);
-#else
-size_t iconv();
-#endif
-], [], am_cv_proto_iconv_arg1="", am_cv_proto_iconv_arg1="const")
-      am_cv_proto_iconv="extern size_t iconv (iconv_t cd, $am_cv_proto_iconv_arg1 char * *inbuf, size_t *inbytesleft, char * *outbuf, size_t *outbytesleft);"])
-    am_cv_proto_iconv=`echo "[$]am_cv_proto_iconv" | tr -s ' ' | sed -e 's/( /(/'`
-    AC_MSG_RESULT([$]{ac_t:-
-         }[$]am_cv_proto_iconv)
-    AC_DEFINE_UNQUOTED(ICONV_CONST, $am_cv_proto_iconv_arg1,
-      [Define as const if the declaration of iconv() needs const.])
-  fi
-  LIBICONV=
-  if test "$am_cv_lib_iconv" = yes; then
-    LIBICONV="-liconv"
-  fi
-  AC_SUBST(LIBICONV)
-])
-
 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
@@ -328,7 +215,7 @@ if test x"$tls" != x; then
         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,11 +1,11 @@
 %%%----------------------------------------------------------------------
 %%% 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>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -31,47 +31,52 @@
 	 produce_response/2,
 	 produce_response/1]).
 
+-include_lib("exmpp/include/exmpp.hrl").
+
 -include("ejabberd.hrl").
--include("jlib.hrl").
 -include("adhoc.hrl").
 
 %% Parse an ad-hoc request.  Return either an adhoc_request record or
 %% an {error, ErrorType} tuple.
-parse_request(#iq{type = set, lang = Lang, sub_el = SubEl, xmlns = ?NS_COMMANDS}) ->
-    ?DEBUG("entering parse_request...", []),
-    Node = xml:get_tag_attr_s("node", SubEl),
-    SessionID = xml:get_tag_attr_s("sessionid", SubEl),
-    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
-    end,
+parse_request(#iq{type = Type, ns = NS, payload = SubEl, lang = Lang}) ->
+    try
+	case {Type, NS} of
+	    {set, ?NS_ADHOC} ->
+		?DEBUG("entering parse_request...", []),
+		Node = exmpp_xml:get_attribute_as_list(SubEl, 'node', ""),
+		SessionID = exmpp_xml:get_attribute_as_list(SubEl, 'sessionid', ""),
+		Action = exmpp_xml:get_attribute_as_list(SubEl, 'action', ""),
+		XData = find_xdata_el(SubEl),
+		AllEls = exmpp_xml:get_child_elements(SubEl),
+		Others = case XData of
+		    false ->
+			AllEls;
+		    _ ->
+			lists:delete(XData, AllEls)
+		end,
 
-    #adhoc_request{lang = Lang,
-		   node = Node,
-		   sessionid = SessionID,
-		   action = Action,
-		   xdata = XData,
-		   others = Others};
-parse_request(_) ->
-    {error, ?ERR_BAD_REQUEST}.
+		#adhoc_request{lang = Lang,
+			       node = Node,
+			       sessionid = SessionID,
+			       action = Action,
+			       xdata = XData,
+			       others = Others};
+	    _ ->
+		{error, 'bad-request'}
+	end
+    catch
+	_ ->
+	    {error, 'bad-request'}
+    end.
 
 %% Borrowed from mod_vcard.erl
-find_xdata_el({xmlelement, _Name, _Attrs, SubEls}) ->
+find_xdata_el(#xmlel{children = SubEls}) ->
     find_xdata_el1(SubEls).
 
 find_xdata_el1([]) ->
     false;
-find_xdata_el1([{xmlelement, Name, Attrs, SubEls} | Els]) ->
-    case xml:get_attr_s("xmlns", Attrs) of
-	?NS_XDATA ->
-	    {xmlelement, Name, Attrs, SubEls};
-	_ ->
-	    find_xdata_el1(Els)
-    end;
+find_xdata_el1([#xmlel{ns = ?NS_DATA_FORMS} = El | _Els]) ->
+    El;
 find_xdata_el1([_ | Els]) ->
     find_xdata_el1(Els).
 
@@ -109,20 +114,19 @@ produce_response(#adhoc_response{lang = _Lang,
 		"" ->
 		    ActionsElAttrs = [];
 		_ ->
-		    ActionsElAttrs = [{"execute", DefaultAction}]
+		    ActionsElAttrs = [?XMLATTR('execute', DefaultAction)]
 	    end,
-	    ActionsEls = [{xmlelement, "actions",
-			   ActionsElAttrs,
-			   [{xmlelement, Action, [], []} || Action <- Actions]}]
+	    ActionsEls = [#xmlel{ns = ?NS_ADHOC, name = 'actions', attrs =
+			   ActionsElAttrs, children =
+			   [#xmlel{ns = ?NS_ADHOC, name = Action} || Action <- Actions]}]
     end,
     NotesEls = lists:map(fun({Type, Text}) ->
-				 {xmlelement, "note",
-				  [{"type", Type}],
-				  [{xmlcdata, Text}]}
+				 #xmlel{ns = ?NS_ADHOC, name = 'note', attrs =
+				  [?XMLATTR('type', Type)],
+				  children = [#xmlcdata{cdata = list_to_binary(Text)}]}
 			 end, Notes),
-    {xmlelement, "command",
-     [{"xmlns", ?NS_COMMANDS},
-      {"sessionid", SessionID},
-      {"node", Node},
-      {"status", atom_to_list(Status)}],
+    #xmlel{ns = ?NS_ADHOC, name = 'command', attrs =
+     [?XMLATTR('sessionid', SessionID),
+      ?XMLATTR('node', Node),
+      ?XMLATTR('status', Status)], children =
      ActionsEls ++ NotesEls ++ Elements}.

src/adhoc.hrl

@@ -1,6 +1,6 @@
 %%%----------------------------------------------------------------------
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -11,7 +11,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA

src/configure.ac

@@ -2,7 +2,7 @@
 # Process this file with autoconf to produce a configure script.
 
 AC_PREREQ(2.53)
-AC_INIT(ejabberd.erl,, ejabberd@process-one.net)
+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
@@ -14,18 +14,13 @@ fi
 
 #locating erlang
 AM_WITH_ERLANG
-#locating iconv
-AM_ICONV
-#locating libexpat
-AM_WITH_EXPAT
-#locating zlib
-AM_WITH_ZLIB
-#locating PAM
-AM_WITH_PAM
 
 # Checks for typedefs, structures, and compiler characteristics.
 AC_C_CONST
 
+# Check Erlang headers are installed
+#AC_CHECK_HEADER(erl_driver.h,,[AC_MSG_ERROR([cannot find Erlang header files])])
+
 # Change default prefix
 AC_PREFIX_DEFAULT(/)
 
@@ -33,19 +28,24 @@ AC_PREFIX_DEFAULT(/)
 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(pam, no)
-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,
-[  --enable-hipe        Compile natively with HiPE, not recommended (default: no)],
+[AC_HELP_STRING([--enable-hipe], [compile natively with HiPE, not recommended (default: no)])],
 [case "${enableval}" in
   yes) hipe=true ;;
   no)  hipe=false ;;
@@ -54,7 +54,7 @@ esac],[hipe=false])
 AC_SUBST(hipe)
 
 AC_ARG_ENABLE(roster_gateway_workaround,
-[  --enable-roster-gateway-workaround    Turn on workaround for processing gateway subscriptions (default: no)],
+[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 ;;
@@ -63,7 +63,7 @@ esac],[roster_gateway_workaround=false])
 AC_SUBST(roster_gateway_workaround)
 
 AC_ARG_ENABLE(mssql,
-[  --enable-mssql    Use Microsoft SQL Server database (default: no, requires --enable-odbc)],
+[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 ;;
@@ -72,16 +72,16 @@ esac],[db_type=generic])
 AC_SUBST(db_type)
 
 AC_ARG_ENABLE(transient_supervisors,
-[  --enable-transient_supervisors    Use Erlang supervision for transient process (default: yes)],
+[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-full-xml) ;;
+  *) AC_MSG_ERROR(bad value ${enableval} for --enable-transient_supervisors) ;;
 esac],[transient_supervisors=true])
 AC_SUBST(transient_supervisors)
 
 AC_ARG_ENABLE(full_xml,
-[  --enable-full-xml    Use XML features in XMPP stream (ex: CDATA) (default: no, requires XML compliant clients)],
+[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 ;;
@@ -90,14 +90,13 @@ esac],[full_xml=false])
 AC_SUBST(full_xml)
 
 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])
@@ -119,4 +118,54 @@ else
 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
+
+echo
+echo "********************** WARNING ! ************************"
+echo "*  ejabberd master is NOT ready for real usage yet,     *"
+echo "*  because it is still in heavy development.            *"
+echo "*  Don't use ejabberd master, it is still alpha code!   *"
+echo "*  Please use ejabberd 2.1.x branch instead.            *"
+echo "*********************************************************"
+echo

src/configure.erl

@@ -1,11 +1,11 @@
 %%%----------------------------------------------------------------------
 %%% File    : configure.erl
 %%% Author  : Alexey Shchepin <alexey@process-one.net>
-%%% Purpose : 
+%%% Purpose :
 %%% Created : 27 Jan 2003 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -42,31 +42,24 @@ start() ->
 	     end,
     case Static of
 	true ->
-	    ExpatLib  = "EXPAT_LIB = $(EXPAT_DIR)\\StaticLibs\\libexpatMT.lib\n",
-	    ExpatFlag = "EXPAT_FLAG = -DXML_STATIC\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:\\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:\\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 ++
@@ -77,13 +70,6 @@ start() ->
 				   StdLibDir ++
 				   OpenSSLDir ++
 				   DBType ++
-				   ExpatDir ++
-				   ExpatLib ++
-				   ExpatFlag ++
-				   IconvDir ++
-				   IconvLib ++
 				   ZlibDir ++
 				   ZlibLib)),
     halt().
-
-

src/cyrsasl.erl

@@ -5,7 +5,7 @@
 %%% Created :  8 Mar 2003 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -30,22 +30,46 @@
 -export([start/0,
 	 register_mechanism/3,
 	 listmech/1,
-	 server_new/6,
+	 server_new/8,
 	 server_start/3,
 	 server_step/2]).
 
+-include("cyrsasl.hrl").
+-include("ejabberd.hrl").
+
+%% @type saslmechanism() = {sasl_mechanism, Mechanism, Module, Require_Plain}
+%%     Mechanism = string()
+%%     Module = atom()
+%%     Require_Plain = bool().
+%% Registry entry of a supported SASL mechanism.
+
 -record(sasl_mechanism, {mechanism, module, require_plain_password}).
--record(sasl_state, {service, myname, realm,
-		     get_password, check_password,
-		     mech_mod, mech_state}).
+
+%% @type saslstate() = {sasl_state, Service, Myname, Realm, GetPassword, CheckPassword, CheckPasswordDigest, Mech_Mod, Mech_State}
+%%     Service = string()
+%%     Myname = string()
+%%     Realm = string()
+%%     GetPassword = function()
+%%     CheckPassword = function()
+%%     CheckPasswordDigest = any()
+%%     Mech_Mod = atom()
+%%     Mech_State = term().
+%% State of this process.
+
+-record(sasl_state, {service, myname,
+		     mech_mod, mech_state, params}).
 
 -export([behaviour_info/1]).
 
+%% @hidden
+
 behaviour_info(callbacks) ->
-    [{mech_new, 3}, {mech_step, 2}];
+    [{mech_new, 1}, {mech_step, 2}];
 behaviour_info(_Other) ->
     undefined.
 
+%% @spec () -> ok
+
 start() ->
     ets:new(sasl_mechanism, [named_table,
 			     public,
@@ -53,49 +77,81 @@ start() ->
     cyrsasl_plain:start([]),
     cyrsasl_digest:start([]),
     cyrsasl_anonymous:start([]),
+    maybe_try_start_gssapi(),
     ok.
 
+maybe_try_start_gssapi() ->
+    case os:getenv("KRB5_KTNAME") of
+        false ->
+	    ok;
+        _String ->
+	    try_start_gssapi()
+    end.
+
+try_start_gssapi() ->
+    case code:load_file(esasl) of
+	{module, _Module} ->
+	    cyrsasl_gssapi:start([]);
+	{error, What} ->
+	    ?ERROR_MSG("Support for GSSAPI not started because esasl.beam was not found: ~p", [What])
+    end.
+
+%% @spec (Mechanism, Module, Require_Plain) -> true
+%%     Mechanism = string()
+%%     Module = atom()
+%%     Require_Plain = bool()
+
 register_mechanism(Mechanism, Module, RequirePlainPassword) ->
     ets:insert(sasl_mechanism,
 	       #sasl_mechanism{mechanism = Mechanism,
 			       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:short_prepd_jid(JID),
+%	    case R of
+%		"" ->
+%		    {error, "invalid-authzid"};
+%		_ ->
+%		    case {LUser, ?MYNAME} of
+%			{U, S} ->
+%			    ok;
+%			_ ->
+%			    {error, "invalid-authzid"}
+%		    end
+%	    end
+%    end.
+
+%% @spec (State, Props) -> ok | {error, 'not-authorized'}
+%%     State = saslstate()
+%%     Props = [{Key, Value}]
+%%         Key = atom()
+%%         Value = string()
 
 check_credentials(_State, Props) ->
-    User = xml:get_attr_s(username, Props),
-    case jlib:nodeprep(User) of
-	error ->
-	    {error, "not-authorized"};
-	"" ->
-	    {error, "not-authorized"};
-	_LUser ->
-	    ok
+    case proplists:get_value(username, Props) of
+	undefined ->
+	    {error, 'not-authorized'};
+	User ->
+	    case exmpp_stringprep:is_node(User) of
+		false -> {error, 'not-authorized'};
+		true  -> ok
+	    end
     end.
 
+%% @spec (Host) -> [Mechanism]
+%%     Host = string()
+%%     Mechanism = string()
+
 listmech(Host) ->
     RequirePlainPassword = ejabberd_auth:plain_password_required(Host),
 
@@ -112,33 +168,78 @@ listmech(Host) ->
 			 ['$1']}]),
     filter_anonymous(Host, Mechs).
 
+%% @spec (Service, ServerFQDN, UserRealm, SecFlags, GetPassword, CheckPassword, CheckPasswordDigest, Socket) -> saslstate()
+%%     Service = string()
+%%     ServerFQDN = string()
+%%     UserRealm = string()
+%%     SecFlags = [term()]
+%%     GetPassword = function()
+%%     CheckPassword = function()
+
 server_new(Service, ServerFQDN, UserRealm, _SecFlags,
-	   GetPassword, CheckPassword) ->
+	   GetPassword, CheckPassword, CheckPasswordDigest, Socket) ->
+    Params = #sasl_params{
+      host = ServerFQDN,
+      realm = UserRealm,
+      get_password = GetPassword,
+      check_password = CheckPassword,
+      check_password_digest= CheckPasswordDigest,
+      socket = Socket
+     },
+
     #sasl_state{service = Service,
 		myname = ServerFQDN,
-		realm = UserRealm,
-		get_password = GetPassword,
-		check_password = CheckPassword}.
+		params = Params}.
+
+
+%% @spec (State, Mech, ClientIn) -> Ok | Continue | Error
+%%     State = saslstate()
+%%     Mech = string()
+%%     ClientIn = string()
+%%     Ok = {ok, Props}
+%%         Props = [Prop]
+%%         Prop = [{Key, Value}]
+%%         Key = atom()
+%%         Value = string()
+%%     Continue = {continue, ServerOut, New_State}
+%%         ServerOut = string()
+%%         New_State = saslstate()
+%%     Error = {error, Reason} | {error, Username, Reason}
+%%         Reason = term()
+%%         Username = string()
 
 server_start(State, Mech, ClientIn) ->
     case lists:member(Mech, listmech(State#sasl_state.myname)) of
 	true ->
 	    case ets:lookup(sasl_mechanism, Mech) of
 		[#sasl_mechanism{module = Module}] ->
-		    {ok, MechState} = Module:mech_new(
-					State#sasl_state.myname,
-					State#sasl_state.get_password,
-					State#sasl_state.check_password),
+		    {ok, MechState} =
+			Module:mech_new(State#sasl_state.params),
 		    server_step(State#sasl_state{mech_mod = Module,
 						 mech_state = MechState},
 				ClientIn);
 		_ ->
-		    {error, "no-mechanism"}
+		    {error, 'invalid-mechanism'}
 	    end;
 	false ->
-	    {error, "no-mechanism"}
+	    {error, 'invalid-mechanism'}
     end.
 
+%% @spec (State, ClientIn) -> Ok | Continue | Error
+%%     State = saslstate()
+%%     ClientIn = string()
+%%     Ok = {ok, Props}
+%%         Props = [Prop]
+%%         Prop = [{Key, Value}]
+%%         Key = atom()
+%%         Value = string()
+%%     Continue = {continue, ServerOut, New_State}
+%%         ServerOut = string()
+%%         New_State = saslstate()
+%%     Error = {error, Reason} | {error, Username, Reason}
+%%         Reason = term()
+%%         Username = string()
+
 server_step(State, ClientIn) ->
     Module = State#sasl_state.mech_mod,
     MechState = State#sasl_state.mech_state,
@@ -159,8 +260,15 @@ server_step(State, ClientIn) ->
 	    {error, Error}
     end.
 
-%% Remove the anonymous mechanism from the list if not enabled for the given
-%% host
+%% @spec (Host, Mechs) -> [Filtered_Mechs]
+%%     Host = string()
+%%     Mechs = [Mech]
+%%         Mech = string()
+%%     Filtered_Mechs = [Mech]
+%%
+%% @doc Remove the anonymous mechanism from the list if not enabled for
+%% the given host.
+
 filter_anonymous(Host, Mechs) ->
     case ejabberd_auth_anonymous:is_sasl_anonymous_enabled(Host) of
 	true  -> Mechs;

src/cyrsasl.hrl

@@ -0,0 +1,15 @@
+%% @type saslparams() = {sasl_params, Host, Realm, GetPassword, CheckPassword, CheckPasswordDigest}
+%%     Host = string()
+%%     Realm = string()
+%%     GetPassword = function()
+%%     CheckPassword = function()
+%%     CheckPasswordDigest = any().
+%% Parameters for SASL.
+
+-record(sasl_params, {
+	  host,
+	  realm,
+	  get_password,
+	  check_password,
+	  check_password_digest,
+	  socket}).

src/cyrsasl_anonymous.erl

@@ -6,7 +6,7 @@
 %%% Created : 23 Aug 2005 by Magnus Henoch <henoch@dtek.chalmers.se>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -17,7 +17,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -27,22 +27,42 @@
 
 -module(cyrsasl_anonymous).
 
--export([start/1, stop/0, mech_new/3, mech_step/2]).
+-export([start/1, stop/0, mech_new/1, mech_step/2]).
+
+-include("cyrsasl.hrl").
 
 -behaviour(cyrsasl).
 
+%% @type mechstate() = {state, Server}
+%%     Server = string().
+
 -record(state, {server}).
 
+%% @spec (Opts) -> true
+%%     Opts = term()
+
 start(_Opts) ->
     cyrsasl:register_mechanism("ANONYMOUS", ?MODULE, false),
     ok.
 
+%% @spec () -> ok
+
 stop() ->
     ok.
 
-mech_new(Host, _GetPassword, _CheckPassword) ->
+mech_new(#sasl_params{host=Host}) ->
     {ok, #state{server = Host}}.
 
+%% @spec (State, ClientIn) -> Ok | Error
+%%     State = mechstate()
+%%     ClientIn = string()
+%%     Ok = {ok, Props}
+%%         Props = [Prop]
+%%         Prop = {username, Username} | {auth_module, AuthModule}
+%%         Username = string()
+%%         AuthModule = ejabberd_auth_anonymous
+%%     Error = {error, 'not-authorized'}
+
 mech_step(State, _ClientIn) ->
     %% We generate a random username:
     User = lists:concat([randoms:get_string() | tuple_to_list(now())]),
@@ -50,6 +70,7 @@ 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}]}
+	true  -> {error, 'not-authorized'};
+	false -> {ok, [{username, User},
+		       {auth_module, ejabberd_auth_anonymous}]}
     end.

src/cyrsasl_digest.erl

@@ -3,7 +3,25 @@
 %%% 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).
@@ -11,23 +29,59 @@
 
 -export([start/1,
 	 stop/0,
-	 mech_new/3,
+	 mech_new/1,
 	 mech_step/2]).
 
+-include("ejabberd.hrl").
+-include("cyrsasl.hrl").
+
 -behaviour(cyrsasl).
 
--record(state, {step, nonce, username, authzid, get_password}).
+%% @type mechstate() = {state, Step, Nonce, Username, AuthzId, GetPassword, CheckPassword, AuthModule, Host}
+%%     Step = 1 | 3 | 5
+%%     Nonce = string()
+%%     Username = string()
+%%     AuthzId = string()
+%%     GetPassword = function()
+%%     AuthModule = atom()
+%%     Host = string().
+
+-record(state, {step, nonce, username, authzid, get_password, check_password, auth_module,
+		host}).
+
+%% @spec (Opts) -> true
+%%     Opts = term()
 
 start(_Opts) ->
     cyrsasl:register_mechanism("DIGEST-MD5", ?MODULE, true).
 
+%% @spec () -> ok
+
 stop() ->
     ok.
 
-mech_new(_Host, GetPassword, _CheckPassword) ->
+mech_new(#sasl_params{host=Host, get_password=GetPassword,
+		      check_password_digest=CheckPasswordDigest}) ->
     {ok, #state{step = 1,
 		nonce = randoms:get_string(),
-		get_password = GetPassword}}.
+		host = Host,
+		get_password = GetPassword,
+		check_password = CheckPasswordDigest}}.
+
+%% @spec (State, ClientIn) -> Ok | Continue | Error
+%%     State = mechstate()
+%%     ClientIn = string()
+%%     Ok = {ok, Props}
+%%         Props = [Prop]
+%%         Prop = {username, Username} | {authzid, AuthzId} | {auth_module, AuthModule}
+%%         Username = string()
+%%         AuthzId = string()
+%%         AuthModule = atom()
+%%     Continue = {continue, ServerOut, New_State}
+%%         ServerOut = string()
+%%         New_State = mechstate()
+%%     Error = {error, Reason} | {error, Reason, Username}
+%%         Reason = term()
 
 mech_step(#state{step = 1, nonce = Nonce} = State, _) ->
     {continue,
@@ -37,43 +91,63 @@ mech_step(#state{step = 1, nonce = Nonce} = State, _) ->
 mech_step(#state{step = 3, nonce = Nonce} = State, ClientIn) ->
     case parse(ClientIn) of
 	bad ->
-	    {error, "bad-protocol"};
+	    {error, 'bad-protocol'};
 	KeyVals ->
-	    UserName = xml:get_attr_s("username", KeyVals),
-	    AuthzId = xml:get_attr_s("authzid", KeyVals),
-	    case (State#state.get_password)(UserName) of
+	    DigestURI = proplists:get_value("digest-uri", KeyVals, ""),
+	    UserName = proplists:get_value("username", KeyVals, ""),
+	    case is_digesturi_valid(DigestURI, State#state.host) of
 		false ->
-		    {error, "not-authorized", UserName};
-		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", UserName}
+		    ?DEBUG("User login not authorized because digest-uri "
+			   "seems invalid: ~p", [DigestURI]),
+		    {error, 'not-authorized', UserName};
+		true ->
+		    AuthzId = proplists:get_value("authzid", KeyVals, ""),
+		    case (State#state.get_password)(UserName) of
+			{false, _} ->
+			    {error, 'not-authorized', UserName};
+			{Passwd, AuthModule} ->
+				case (State#state.check_password)(UserName, "",
+					proplists:get_value("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]),
-    {error, "bad-protocol"}.
+    ?DEBUG("SASL DIGEST: A ~p B ~p", [A,B]),
+    {error, 'bad-protocol'}.
 
+%% @spec (S) -> [{Key, Value}] | bad
+%%     S = string()
+%%     Key = string()
+%%     Value = string()
 
 parse(S) ->
     parse1(S, "", []).
 
+%% @hidden
+
 parse1([$= | Cs], S, Ts) ->
     parse2(Cs, lists:reverse(S), "", Ts);
 parse1([$, | Cs], [], Ts) ->
@@ -87,20 +161,28 @@ parse1([], [], T) ->
 parse1([], _S, _T) ->
     bad.
 
-parse2([$" | Cs], Key, Val, Ts) ->
+%% @hidden
+
+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) ->
+%% @hidden
+
+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([], _, _, _) ->
     bad.
 
+%% @hidden
+
 parse4([$, | Cs], Key, Val, Ts) ->
     parse1(Cs, "", [{Key, lists:reverse(Val)} | Ts]);
 parse4([$\s | Cs], Key, Val, Ts) ->
@@ -111,18 +193,46 @@ parse4([], Key, Val, Ts) ->
     parse1([], "", [{Key, lists:reverse(Val)} | Ts]).
 
 
+%% @spec (DigestURICase, JabberHost) -> bool()
+%%     DigestURICase = string()
+%%     JabberHost = string()
+%%
+%% @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 = exmpp_stringprep:to_lower(DigestURICase),
+    case catch string:tokens(DigestURI, "/") of
+	["xmpp", Host] when Host == JabberHost ->
+	    true;
+	["xmpp", _Host, ServName] when ServName == JabberHost ->
+	    true;
+	_ ->
+	    false
+    end.
 
 
 
 
+%% @hidden
+
 digit_to_xchar(D) when (D >= 0) and (D < 10) ->
     D + 48;
 digit_to_xchar(D) ->
     D + 87.
 
+%% @hidden
+
 hex(S) ->
     hex(S, []).
 
+%% @hidden
+
 hex([], Res) ->
     lists:reverse(Res);
 hex([N | Ns], Res) ->
@@ -130,12 +240,22 @@ hex([N | Ns], Res) ->
 	     digit_to_xchar(N div 16) | Res]).
 
 
+%% @spec (KeyVals, User, Passwd, Nonce, AuthzId, A2Prefix) -> string()
+%%     KeyVals = [{Key, Value}]
+%%         Key = string()
+%%         Value = string()
+%%     User = string()
+%%     Passwd = string()
+%%     Nonce = string()
+%%     AuthzId = nil() | string()
+%%     A2Prefix = string()
+
 response(KeyVals, User, Passwd, Nonce, AuthzId, A2Prefix) ->
-    Realm = xml:get_attr_s("realm", KeyVals),
-    CNonce = xml:get_attr_s("cnonce", KeyVals),
-    DigestURI = xml:get_attr_s("digest-uri", KeyVals),
-    NC = xml:get_attr_s("nc", KeyVals),
-    QOP = xml:get_attr_s("qop", KeyVals),
+    Realm = proplists:get_value("realm", KeyVals, ""),
+    CNonce = proplists:get_value("cnonce", KeyVals, ""),
+    DigestURI = proplists:get_value("digest-uri", KeyVals, ""),
+    NC = proplists:get_value("nc", KeyVals, ""),
+    QOP = proplists:get_value("qop", KeyVals, ""),
     A1 = case AuthzId of
 	     "" ->
 		 binary_to_list(

src/cyrsasl_gssapi.erl

@@ -0,0 +1,164 @@
+%%%----------------------------------------------------------------------
+%%% File    : cyrsasl_gssapi.erl
+%%% Author  : Mikael Magnusson <mikma@users.sourceforge.net>
+%%% Purpose : GSSAPI SASL mechanism
+%%% Created : 1 June 2007 by Mikael Magnusson <mikma@users.sourceforge.net>
+%%%----------------------------------------------------------------------
+%%%
+%%% Copyright (C) 2007-2009  Mikael Magnusson <mikma@users.sourceforge.net>
+%%%
+%%% 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.
+%%%
+
+%%%
+%%% configuration options:
+%%% {sasl_realm, "<Kerberos realm>"}.
+%%%
+%%% environment variables:
+%%% KRB5_KTNAME
+%%%
+
+-module(cyrsasl_gssapi).
+-author('mikma@users.sourceforge.net').
+
+-export([start/1,
+	 stop/0,
+	 mech_new/1,
+	 mech_step/2]).
+
+-include("ejabberd.hrl").
+-include("cyrsasl.hrl").
+
+-behaviour(cyrsasl).
+
+-define(SERVER, ?MODULE).
+-define(SERVICE, "xmpp").
+
+-record(state, {sasl,
+		needsmore=true,
+		step=0,
+		host,
+		realm,
+		authid,
+		authzid,
+		authrealm,
+		error}).
+
+start(_Opts) ->
+    ChildSpec =
+	{?SERVER,
+	 {esasl, start_link, [{local, ?SERVER}]},
+	 transient,
+	 1000,
+	 worker,
+	 [esasl]},
+
+    case supervisor:start_child(ejabberd_sup, ChildSpec) of
+	{ok, _Pid} ->
+	    cyrsasl:register_mechanism("GSSAPI", ?MODULE, false);
+	{error, Error} = E ->
+	    ?ERROR_MSG("esasl failed: ~p", [Error]),
+	    E
+    end.
+
+
+stop() ->
+    catch esasl:stop(?SERVER),
+    supervisor:terminate_child(ejabberd_sup, ?SERVER),
+    supervisor:delete_child(ejabberd_sup, ?SERVER).
+
+mech_new(#sasl_params{host=Host, realm=Realm, socket=Socket}) ->
+    case ejabberd_socket:gethostname(Socket) of
+	{ok, FQDN} ->
+	    ?DEBUG("mech_new ~p ~p ~p~n", [Host, Realm, FQDN]),
+	    case esasl:server_start(?SERVER, "GSSAPI", ?SERVICE, FQDN) of
+		{ok, Sasl} ->
+		    {ok, #state{sasl=Sasl,host=Host,realm=Realm}};
+		{error, {gsasl_error, Error}} ->
+		    {ok, Str} = esasl:str_error(?SERVER, Error),
+		    ?DEBUG("esasl error: ~p", [Str]),
+		    {ok, #state{needsmore=error,error="internal-server-error"}};
+		{error, Error} ->
+		    ?DEBUG("esasl error: ~p", [Error]),
+		    {ok, #state{needsmore=error,error="internal-server-error"}}
+	    end;
+	{error, Error} ->
+	    ?DEBUG("gethostname error: ~p", [Error]),
+	    {ok, #state{needsmore=error,error="internal-server-error"}}
+    end.
+
+mech_step(State, ClientIn) when is_list(ClientIn) ->
+    catch do_step(State, ClientIn).
+
+do_step(#state{needsmore=error,error=Error}=_State, _) ->
+    {error, Error};
+do_step(#state{needsmore=false}=State, _) ->
+    check_user(State);
+do_step(#state{needsmore=true,sasl=Sasl,step=Step}=State, ClientIn) ->
+    ?DEBUG("mech_step~n", []),
+    case esasl:step(Sasl, list_to_binary(ClientIn)) of
+	{ok, RspAuth} ->
+	    ?DEBUG("ok~n", []),
+	    {ok, Display_name} = esasl:property_get(Sasl, gssapi_display_name),
+	    {ok, Authzid} = esasl:property_get(Sasl, authzid),
+	    {Authid, [$@ | Auth_realm]} =
+		lists:splitwith(fun(E)->E =/= $@ end, Display_name),
+	    State1 = State#state{authid=Authid,
+				 authzid=Authzid,
+				 authrealm=Auth_realm},
+	    handle_step_ok(State1, binary_to_list(RspAuth));
+	{needsmore, RspAuth} ->
+	    ?DEBUG("needsmore~n", []),
+	    if (Step > 0) and (ClientIn =:= []) and (RspAuth =:= <<>>) ->
+		    {error, "not-authorized"};
+		true ->
+		    {continue, binary_to_list(RspAuth),
+		     State#state{step=Step+1}}
+	    end;
+	{error, _} ->
+	    {error, "not-authorized"}
+    end.
+
+handle_step_ok(State, []) ->
+    check_user(State);
+handle_step_ok(#state{step=Step}=State, RspAuth) ->
+    ?DEBUG("continue~n", []),
+    {continue, RspAuth, State#state{needsmore=false,step=Step+1}}.
+
+check_user(#state{authid=Authid,authzid=Authzid,
+		  authrealm=Auth_realm,host=Host,realm=Realm}) ->
+    if Realm =/= Auth_realm ->
+	    ?DEBUG("bad realm ~p (expected ~p)~n",[Auth_realm, Realm]),
+	    throw({error, "not-authorized"});
+       true ->
+	    ok
+    end,
+
+    case ejabberd_auth:is_user_exists(Authid, Host) of
+	false ->
+	    ?DEBUG("bad user ~p~n",[Authid]),
+	    throw({error, "not-authorized"});
+	true ->
+	    ok
+    end,
+
+    ?DEBUG("GSSAPI authenticated ~p ~p~n", [Authid, Authzid]),
+    {ok, [{username, Authid}, {authzid, Authzid}]}.

src/cyrsasl_plain.erl

@@ -5,7 +5,7 @@
 %%% Created :  8 Mar 2003 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -27,39 +27,84 @@
 -module(cyrsasl_plain).
 -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/1, mech_step/2, parse/1]).
+
+-include("cyrsasl.hrl").
 
 -behaviour(cyrsasl).
 
+%% @type mechstate() = {state, CheckPassword}
+%%     CheckPassword = function().
+
 -record(state, {check_password}).
 
+%% @spec (Opts) -> true
+%%     Opts = term()
+
 start(_Opts) ->
     cyrsasl:register_mechanism("PLAIN", ?MODULE, false),
     ok.
 
+%% @spec () -> ok
+
 stop() ->
     ok.
 
-mech_new(_Host, _GetPassword, CheckPassword) ->
+mech_new(#sasl_params{check_password = CheckPassword}) ->
     {ok, #state{check_password = CheckPassword}}.
 
+%% @spec (State, ClientIn) -> Ok | Error
+%%     State = mechstate()
+%%     ClientIn = string()
+%%     Ok = {ok, Props}
+%%         Props = [Prop]
+%%         Prop = {username, Username} | {authzid, AuthzId} | {auth_module, AuthModule}
+%%         Username = string()
+%%         AuthzId = string()
+%%         AuthModule = atom()
+%%     Error = {error, Reason} | {error, Reason, Username}
+%%         Reason = term()
+
 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, "not-authorized", User}
+		    {error, 'not-authorized', User}
 	    end;
 	_ ->
-	    {error, "bad-protocol"}
+	    {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.
 
 
+%% @hidden
+
 parse(S) ->
     parse1(S, "", []).
 
+%% @hidden
+
 parse1([0 | Cs], S, T) ->
     parse1(Cs, "", [lists:reverse(S) | T]);
 parse1([C | Cs], S, T) ->
@@ -70,5 +115,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,8 +1,6 @@
-%% $Id$
-
 {application, ejabberd,
  [{description, "ejabberd"},
-  {vsn, "2.0.0"},
+  {vsn, "3.0.0-alpha-x"},
   {modules, [acl,
 	     adhoc,
 	     configure,
@@ -15,10 +13,9 @@
 	     ejabberd_auth_anonymous,
 	     ejabberd_auth,
 	     ejabberd_auth_external,
-	     ejabberd_auth_internal,
 	     ejabberd_auth_ldap,
-	     ejabberd_auth_odbc,
 	     ejabberd_auth_pam,
+	     ejabberd_auth_storage,
 	     ejabberd,
 	     ejabberd_c2s,
 	     ejabberd_c2s_config,
@@ -37,6 +34,7 @@
 	     ejabberd_rdbms,
 	     ejabberd_receiver,
 	     ejabberd_router,
+	     ejabberd_router_multicast,
 	     ejabberd_s2s,
 	     ejabberd_s2s_in,
 	     ejabberd_s2s_out,
@@ -61,7 +59,6 @@
 	     gen_mod,
 	     gen_pubsub_node,
 	     gen_pubsub_nodetree,
-	     iconv,
 	     idna,
 	     jd2ejd,
 	     jlib,
@@ -74,19 +71,13 @@
 	     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,
@@ -95,14 +86,12 @@
 	     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,
@@ -115,7 +104,7 @@
 	     nodetree_virtual,
 	     p1_fsm,
 	     p1_mnesia,
-	     ram_file_io_server,
+	     p1_prof,
 	     randoms,
 	     sha,
 	     shaper,
@@ -124,13 +113,13 @@
 	     tls,
 	     translate,
 	     xml,
-	     xml_stream,
 	     'XmppAddr'
 	    ]},
   {registered, [ejabberd,
 		ejabberd_sup,
 		ejabberd_auth,
 		ejabberd_router,
+		ejabberd_router_multicast,
 		ejabberd_sm,
 		ejabberd_s2s,
 		ejabberd_local,
@@ -143,7 +132,6 @@
 		ejabberd_mod_roster,
 		ejabberd_mod_echo,
 		ejabberd_mod_pubsub,
-		ejabberd_mod_irc,
 		ejabberd_mod_muc,
 		ejabberd_offline,
 		random_generator

src/ejabberd.cfg.example

@@ -1,10 +1,11 @@
 %%%
 %%%               ejabberd configuration file
 %%%
+%%%'
 
 %%% 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 in 
+%%% 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/
 
@@ -16,26 +17,26 @@
 %%%  - Each term ends in a dot, for example:
 %%%      override_global.
 %%%
-%%%  - A tuple has a fixed definition, its elements are 
+%%%  - 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, 
+%%%  - 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. 
-%%%    The strings are enclosed in "" and can have spaces, dots...
+%%%  - 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"}. 
+%%%      {ldap_rootdn, "dc=example,dc=com"}.
 %%%
-%%%  - This term includes a tuple, a keyword, a list and two strings:
+%%%  - This term includes a tuple, a keyword, a list, and two strings:
 %%%      {hosts, ["jabber.example.net", "im.example.com"]}.
 %%%
 
 
-%%%   =======================
-%%%   OVERRIDE STORED OPTIONS
+%%%.   =======================
+%%%'   OVERRIDE STORED OPTIONS
 
 %%
 %% Override the old values stored in the database.
@@ -57,8 +58,8 @@
 %%override_acls.
 
 
-%%%   =========
-%%%   DEBUGGING
+%%%.   =========
+%%%'   DEBUGGING
 
 %%
 %% loglevel: Verbosity of log files generated by ejabberd.
@@ -72,36 +73,47 @@
 {loglevel, 4}.
 
 %%
-%% watchdog_admins: If an ejabberd process consumes too much memory, 
-%% send live notifications to those Jabber accounts.
+%% 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"]}.
 
 
-%%%   ================
-%%%   SERVED HOSTNAMES
+%%%.   =====================
+%%%'   CLUSTER CONFIGURATION
+
+%% clusterid: the integer id of the cluster of nodes this node will
+%% belong to.
+{clusterid, 1}.
+
+
+%%%.   ================
+%%%'   SERVED HOSTNAMES
 
 %%
 %% hosts: Domains served by ejabberd.
 %% You can define one or several, for example:
-%% {hosts, ["example.net", "example.com", "example.org"]}.
+%% {hosts, ["localhost", "example.net", "example.com", "example.org"]}.
 %%
+%% Additional hosts will be discovered from the 'hosts' database table
+%% configured for the first host.
 {hosts, ["localhost"]}.
 
 %%
-%% route_subdomains: Delegate subdomains to other Jabber server.
+%% route_subdomains: Delegate subdomains to other XMPP servers.
 %% For example, if this ejabberd serves example.org and you want
-%% to allow communication with a Jabber server called im.example.org.
+%% to allow communication with an XMPP server called im.example.org.
 %%
 %%{route_subdomains, s2s}.
 
 
-%%%   ===============
-%%%   LISTENING PORTS
+%%%.   ===============
+%%%'   LISTENING PORTS
 
 %%
-%% listen: Which ports will ejabberd listen, which service handles it
-%% and what options to start it with.
+%% listen: The ports ejabberd will listen on, which service each is handled
+%% by and what options to start it with.
 %%
 {listen,
  [
@@ -109,8 +121,8 @@
   {5222, ejabberd_c2s, [
 
 			%%
-			%% If TLS is compiled and you installed a SSL
-			%% certificate, put the correct path to the 
+			%% 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,
@@ -121,7 +133,7 @@
 		       ]},
 
   %%
-  %% To enable the old SSL connection method in port 5223:
+  %% To enable the old SSL connection method on port 5223:
   %%
   %%{5223, ejabberd_c2s, [
   %%			{access, c2s},
@@ -136,10 +148,10 @@
 			  ]},
 
   %%
-  %% ejabberd_service: Interact with external components (transports...)
+  %% ejabberd_service: Interact with external components (transports, ...)
   %%
   %%{8888, ejabberd_service, [
-  %%			    {access, all}, 
+  %%			    {access, all},
   %%			    {shaper_rule, fast},
   %%			    {ip, {127, 0, 0, 1}},
   %%			    {hosts, ["icq.example.org", "sms.example.org"],
@@ -147,8 +159,19 @@
   %%			    }
   %%			   ]},
 
+  %%
+  %% ejabberd_stun: Handles STUN Binding requests
+  %%
+  %%{{3478, udp}, ejabberd_stun, []},
+
   {5280, ejabberd_http, [
-			 http_poll, 
+			 %%{request_handlers,
+			 %% [
+			 %%  {["pub", "archive"], mod_http_fileserver}
+			 %% ]},
+			 captcha,
+			 http_bind,
+			 http_poll,
 			 web_admin
 			]}
 
@@ -185,17 +208,33 @@
 %%{{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
+
+%%%.   ==============
+%%%'   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.
+%% The default method is the internal Mnesia database storage.
+%% If you want to use a different method,
+%% comment those lines and enable the desired lines later.
 %%
-{auth_method, internal}.
+{auth_method, storage}.
+{auth_storage, mnesia}.
+
+%%
+%% Authentication using ODBC
+%% Remember to setup a database in the next section.
+%%
+%%{auth_method, storage}.
+%%{auth_storage, odbc}.
 
 %%
 %% Authentication using external script
@@ -204,12 +243,6 @@
 %%{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
 %%
@@ -222,19 +255,30 @@
 %%{auth_method, ldap}.
 %%
 %% List of LDAP servers:
-%%{ldap_servers, ["localhost"]}.    
+%%{ldap_servers, ["localhost"]}.
 %%
-%% LDAP attribute that holds user ID:
-%%{ldap_uids, [{"mail", "%u@mail.example.org"}]}. 
+%% Encryption of connection to LDAP servers:
+%%{ldap_encrypt, none}.
+%%{ldap_encrypt, tls}.
 %%
-%% Search base of LDAP directory:
-%%{ldap_base, "dc=example,dc=com"}. 
+%% Port to connect to on LDAP servers:
+%%{ldap_port, 389}.
+%%{ldap_port, 636}.
 %%
 %% LDAP manager:
-%%{ldap_rootdn, "dc=example,dc=com"}. 
+%%{ldap_rootdn, "dc=example,dc=com"}.
 %%
-%% Password to LDAP manager:
-%%{ldap_password, "******"}. 
+%% 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:
@@ -251,31 +295,41 @@
 %%{host_config, "public.example.org", [{auth_method, [internal, anonymous]}]}.
 
 
-%%%   ==============
-%%%   DATABASE SETUP
+%%%.   ==============
+%%%'   DATABASE SETUP
 
-%% ejabberd uses by default the internal Mnesia database,
-%% so you can avoid this section.
+%% 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 about database creation.
+%% Please consult the ejabberd Guide for details on database creation.
 
+%% Template host ODBC configuration.
+%% The host specified here will be used by default for all discovered vhosts.
+%% The actual ODBC server configuration must be provided in a host_config directive.
+{odbc_server, {host, "localhost"}}.
+
+{host_config, "localhost",
+ [
 %%
 %% MySQL server:
 %%
-%%{odbc_server, {mysql, "server", "database", "username", "password"}}.
+%%{odbc_server, {mysql, "server", "database", "username", "password"}}
 %%
 %% If you want to specify the port:
-%%{odbc_server, {mysql, "server", 1234, "database", "username", "password"}}.
+%%{odbc_server, {mysql, "server", 1234, "database", "username", "password"}}
 
 %%
 %% PostgreSQL server:
 %%
-%%{odbc_server, {pgsql, "server", "database", "username", "password"}}.
+%%{odbc_server, {pgsql, "server", "database", "username", "password"}}
 %%
 %% If you want to specify the port:
-%%{odbc_server, {pgsql, "server", 1234, "database", "username", "password"}}.
+%%{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"
 %%
@@ -286,27 +340,44 @@
 %%
 %%{odbc_server, "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"}.
 
-
-%%%   ===============
-%%%   TRAFFIC SHAPERS
+%%
+%% Number of connections to open to the database for each virtual host
+%%
+%%{odbc_pool_size, 10}.
 
 %%
-%% The "normal" shaper limits traffic speed to 1.000 B/s
+%% 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 50.000 B/s
+%% 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
+
+%%%.   ====================
+%%%'   ACCESS CONTROL LISTS
 
 %%
-%% The 'admin' ACL grants administrative privileges to Jabber accounts.
-%% You can put as many accounts as you want.
+%% 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"}}.
@@ -330,13 +401,25 @@
 %%{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
 
-%% Define the maximum number of time a single user is allowed to connect:
+%%%.   ============
+%%%'   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}]}.
 
@@ -344,85 +427,134 @@
 {access, c2s, [{deny, blocked},
 	       {allow, all}]}.
 
-%% For all users except admins used "normal" shaper
+%% For C2S connections, all users except admins use the "normal" shaper
 {access, c2s_shaper, [{none, admin},
 		      {normal, all}]}.
 
-%% For all S2S connections used "fast" shaper
+%% 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 configuration interface:
+%% Only admins can use the configuration interface:
 {access, configure, [{allow, admin}]}.
 
-%% Admins of this server are also admins of MUC service:
+%% Admins of this server are also admins of the MUC service:
 {access, muc_admin, [{allow, admin}]}.
 
-%% All users are allowed to use MUC service:
+%% 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}]}.
 
-%% Every username can be registered via in-band registration:
+%% 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}]}.
 
-%% Everybody can create pubsub nodes
-{access, pubsub_createnode, [{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
+%%%.   =======
+%%%'   CAPTCHA
+
+%%
+%% 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"}.
+
+
+%%%.   ================
+%%%'   DEFAULT LANGUAGE
 
 %%
 %% language: Default language used for server messages.
 %%
 {language, "en"}.
 
+%%
+%% Set a different default language in a virtual host.
+%%
+%%{host_config, "localhost",
+%% [{language, "ru"}]
+%%}.
 
-%%%   =======
-%%%   MODULES
+
+%%%.   ================
+%%%'   INSTANCE MODULES
 
 %%
-%% Modules enabled in all ejabberd virtual hosts.
+%% Modules to start for every virtual host.
+%%
+%% Note: One copy of each module will be started for each host.
 %%
 {modules,
  [
   {mod_adhoc,    []},
-  {mod_announce, [{access, announce}]}, % requires mod_adhoc
-  {mod_caps,     []}, 
+  {mod_announce, [{access, announce}]}, % recommends mod_adhoc
+  {mod_caps,     []}, % 1 proc/host
   {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},
-		  {access_persistent, muc},
-		  {access_admin, muc_admin}
-		 ]},
+  {mod_muc,      [ % 1 proc/host
+  		  {host, "conference.@HOST@"},
+  		  {access, muc},
+  		  {access_create, muc_create},
+  		  {access_persistent, muc_create},
+  		  {access_admin, muc_admin}
+  		 ]},
   %%{mod_muc_log,[]},
-  {mod_offline,  []},
+  %%{mod_multicast,[]},
+  {mod_offline,  [{access_max_user_messages, max_user_offline_messages}]},
+  {mod_ping,     []},
   {mod_privacy,  []},
   {mod_private,  []},
   %%{mod_proxy65,[]},
-  {mod_pubsub,   [ % requires mod_caps
-		  {access_createnode, pubsub_createnode},
-		  {plugins, ["default", "pep"]}
-		 ]},
+  %%{mod_pubsub, [ % 1 proc/host
+  %%		  {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", "pep"]}  % pep requires mod_caps
+  %%		 ]},
   {mod_register, [
 		  %%
-		  %% After successful registration, the user receives 
+		  %% After successful registration, the user receives
 		  %% a message with this subject and body.
 		  %%
-		  {welcome_message, {"Welcome!", 
-				     "Welcome to this Jabber server."}},
+		  {welcome_message, {"Welcome!",
+				     "Hi.\nWelcome to this XMPP server."}},
 
 		  %%
-		  %% When a user registers, send a notification to 
-		  %% these Jabber accounts.
+		  %% When a user registers, send a notification to
+		  %% these XMPP accounts.
 		  %%
 		  %%{registration_watchers, ["admin1@example.org"]},
 
@@ -433,14 +565,44 @@
   {mod_shared_roster,[]},
   {mod_stats,    []},
   {mod_time,     []},
-  {mod_vcard,    []},
+  {mod_vcard,    []}, % 1 proc/host
   {mod_version,  []}
  ]}.
 
 
-%%% $Id$
+%%%.
+%%%'   STATIC MODULES
+
+%%
+%% Modules to start for the global virtual host ("localhost").
+%%
+%% The functionality of these modules will be enabled in all ejabberd
+%% virtual hosts without consuming more resources.
+%%
+{static_modules,
+ [
+ ]}.
+
+
+%%%.
+%%%'   HOST SPECIFIC MODULES
+
+%%
+%% 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:
-%%% vim: set filetype=erlang tabstop=8:
+%%% vim: set filetype=erlang tabstop=8 foldmarker=%%%',%%%. foldmethod=marker:

src/ejabberd.erl

@@ -5,7 +5,7 @@
 %%% Created : 16 Nov 2002 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -28,14 +28,22 @@
 -author('alexey@process-one.net').
 
 -export([start/0, stop/0,
-	 get_so_path/0]).
+	 get_so_path/0,
+         get_bin_path/0,
+         get_pid_file/0,
+	 is_my_host/1,
+	 normalize_host/1
+	]).
+
+-include("ejabberd.hrl").
 
 start() ->
+    %%ejabberd_cover:start(),
     application:start(ejabberd).
 
 stop() ->
     application:stop(ejabberd).
-
+    %%ejabberd_cover:stop().
 
 get_so_path() ->
     case os:getenv("EJABBERD_SO_PATH") of
@@ -49,3 +57,54 @@ 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.
+
+is_my_host([$* | _]) ->
+    false;
+is_my_host(Host) ->
+    case ejabberd_config:get_local_option({Host, host}) of
+	undefined ->
+	    WCHost = re:replace(Host, "^[^.]*\.", "*.", [{return, list}]),
+	    case ejabberd_config:get_local_option({WCHost, host}) of
+		undefined ->
+		    false;
+		_ ->
+		    true
+	    end;
+	_ ->
+	    true
+    end.
+
+normalize_host(global) ->
+    global;
+normalize_host(Host) ->
+    WCHost = re:replace(Host, "^[^.]*\.", "*.", [{return, list}]),
+    case ejabberd_config:get_local_option({WCHost, host}) of
+	undefined ->
+	    Host;
+	_ ->
+	    WCHost
+    end.
+
+%% @spec () -> false | string()
+get_pid_file() ->
+    case os:getenv("EJABBERD_PID_PATH") of
+	false ->
+	    false;
+	"" ->
+	    false;
+	Path ->
+	    Path
+    end.

src/ejabberd.hrl

@@ -1,6 +1,6 @@
 %%%----------------------------------------------------------------------
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -11,7 +11,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -19,14 +19,34 @@
 %%%
 %%%----------------------------------------------------------------------
 
-%-define(ejabberd_debug, true).
-%-define(DBGFSM, true).
+%% 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(VERSION, "2.0.0-beta1").
+-define(IS_MY_HOST(Host), ejabberd:is_my_host(Host)).
+-define(MYHOSTS, ejabberd_config:get_global_option(hosts)). %% Deprecated
+-define(MYNAME, hd(ejabberd_config:get_global_option(hosts))).
+-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(S2STIMEOUT, 600000).
+
+-define(PRIVACY_SUPPORT, true).
+
+%%-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)).
 
@@ -41,16 +61,3 @@
 
 -define(CRITICAL_MSG(Format, Args),
     ejabberd_logger:critical_msg(?MODULE,?LINE,Format, Args)).
-
--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(PRIVACY_SUPPORT, true).
-
--define(EJABBERD_URI, "http://www.process-one.net/en/ejabberd/").

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

@@ -1,15 +1,11 @@
 %%%-------------------------------------------------------------------
 %%% File    : ejabberd_admin.erl
 %%% Author  : Mickael Remond <mremond@process-one.net>
-%%% Description : This module gathers admin functions used by different
-%%%               access method:
-%%%               - ejabberdctl command-line tool
-%%%               - web admin interface
-%%%               - adhoc mode
+%%% Purpose : Administrative functions and commands
 %%% Created :  7 May 2006 by Mickael Remond <mremond@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -20,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -31,9 +27,420 @@
 -module(ejabberd_admin).
 -author('mickael.remond@process-one.net').
 
--export([restore/1]).
+-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,
+	 %% For debugging gen_storage 
+	 get_last_info/0,
+	 get_last_info/2,
+	 %% 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 = gli, tags = [accounts],
+			desc = "Get information about last access of an account",
+			module = ?MODULE, function = get_last_info,
+			args = [],
+                        result = {lastinfo, {tuple, [{timestamp, integer},
+                                                       {status, string}
+                                                      ]}}},
+     #ejabberd_commands{name = get_last_info, tags = [accounts],
+			desc = "Get information about last access of an account",
+			module = ?MODULE, function = get_last_info,
+			args = [{user, string}, {host, string}],
+                        result = {lastinfo, {tuple, [{timestamp, integer},
+                                                       {status, 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 = 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@"),
+	      MUCHostB = list_to_binary(MUCHost),
+	      mod_muc:broadcast_service_message(MUCHostB, 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).
+
+get_last_info() -> get_last_info("badlop", "localhost").
+get_last_info(User, Server) ->
+    case mod_last:get_last_info(User, Server) of
+	{ok, TimeStamp, Status} -> {TimeStamp, Status};
+	not_found -> {"never", ""}
+    end.
+
+%%%
+%%% 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
@@ -71,3 +478,127 @@ 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,11 +1,11 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_app.erl
 %%% Author  : Alexey Shchepin <alexey@process-one.net>
-%%% Purpose : ejabberd OTP application definition.
+%%% Purpose : ejabberd's application callback module
 %%% Created : 31 Jan 2003 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -29,41 +29,74 @@
 
 -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),
+    application:start(exmpp),
     randoms:start(),
     db_init(),
     sha:start(),
-    catch ssl:start(),
-    stringprep_sup:start_link(),
+    start(),
     translate:start(),
     acl:start(),
     ejabberd_ctl:init(),
+    ejabberd_commands:init(),
+    ejabberd_admin:start(),
     gen_mod:start(),
     ejabberd_config:start(),
-    start(),
+    ejabberd_check:config(),
     connect_nodes(),
+    %% Loading ASN.1 driver explicitly to avoid races in LDAP
+    catch asn1rt:load_driver(),
     Sup = ejabberd_sup:start_link(),
     ejabberd_rdbms:start(),
     ejabberd_auth:start(),
     cyrsasl:start(),
     % Profiling
-    %eprof:start(),
-    %eprof:profile([self()]),
-    %fprof:trace(start, "/tmp/fprof"),
-    load_modules(),
+    %ejabberd_debug:eprof_start(),
+    %ejabberd_debug:fprof_start(),
+    maybe_add_nameservers(),
+    start_modules(),
+    ejabberd_cluster:announce(),
+    ejabberd_node_groups:start(),
+    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, []).
 
@@ -71,33 +104,10 @@ 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
-	ok -> ok;
-	{error, already_loaded} -> ok
-    end,
-    Port = open_port({spawn, expat_erl}, [binary]),
-    loop(Port).
-
-
-loop(Port) ->
-    receive
-	_ ->
-	    loop(Port)
-    end.
+    ok.
 
 db_init() ->
     case mnesia:system_info(extra_db_nodes) of
@@ -106,10 +116,20 @@ 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() ->
+    case ejabberd_config:get_local_option({static_modules, global}) of
+	undefined ->
+	    ok;
+	StaticModules ->
+	    lists:foreach(
+	      fun({Module, Args}) ->
+		      gen_mod:start_module(global, Module, Args)
+	      end, StaticModules)
+    end,
     lists:foreach(
       fun(Host) ->
 	      case ejabberd_config:get_local_option({modules, Host}) of
@@ -123,6 +143,21 @@ 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 ->
@@ -133,5 +168,72 @@ connect_nodes() ->
 			  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

@@ -5,7 +5,7 @@
 %%% Created : 23 Nov 2002 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -34,6 +34,8 @@
 	 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,
@@ -42,50 +44,150 @@
 	 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([start/1
+         ,start_module/2
+         ,stop_module/2
+         ,start_modules/2
+         ,start_method/2
+         ,stop_method/2
+         ,start_methods/2
+        ]).
+
 -export([auth_modules/1]).
 
 -include("ejabberd.hrl").
--include("ejabberd_ctl.hrl").
+
+%% @type authmodule() = ejabberd_auth_anonymous | ejabberd_auth_external |
+%%                      ejabberd_auth_ldap | ejabberd_auth_pam |
+%%                      ejabberd_auth_storage | atom().
 
 %%%----------------------------------------------------------------------
 %%% API
 %%%----------------------------------------------------------------------
-start() ->
-    lists:foreach(
-      fun(Host) ->
-	      lists:foreach(
-		fun(M) ->
-			M:start(Host)
-		end, auth_modules(Host))
-      end, ?MYHOSTS).
 
-plain_password_required(Server) ->
+%% @spec () -> term()
+
+start() ->
+    ?DEBUG("About to start auth modules. Hosts: ~p", ?MYHOSTS),
+    lists:foreach(fun start/1, ?MYHOSTS).
+
+start(Host) ->
+    start_modules(Host, auth_modules(Host)).
+
+start_modules(Host, Modules) when is_list(Modules) ->
+    lists:foreach(fun (M) -> start_module(Host, M) end, Modules).
+start_module(Host, Module) when is_atom(Module) ->
+    Module:start(Host).
+stop_module(Host, Module) when is_atom(Module) ->
+    Module:stop(Host).
+
+start_methods(Host, Methods) when is_list(Methods) ->
+    lists:foreach(fun (M) -> start_method(Host, M) end, Methods).
+start_method(Host, Method) when is_atom(Method) ->
+    start_module(Host, module_name(Method)).
+stop_method(Host, Method) when is_atom(Method) ->
+    stop_module(Host, module_name(Method)).
+
+
+%% @spec (Server) -> bool()
+%%     Server = string()
+
+plain_password_required(Server) when is_list(Server) ->
     lists:any(
       fun(M) ->
 	      M:plain_password_required()
       end, auth_modules(Server)).
 
-check_password(User, Server, Password) ->
-    lists:any(
-      fun(M) ->
-	      M:check_password(User, Server, Password)
-      end, auth_modules(Server)).
+%% @spec (User, Server, Password) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%% @doc Check if the user and password can login in server.
 
-check_password(User, Server, Password, StreamID, Digest) ->
-    lists:any(
-      fun(M) ->
-	      M:check_password(User, Server, Password, StreamID, Digest)
-      end, auth_modules(Server)).
+check_password(User, Server, Password)
+  when is_list(User), is_list(Server), is_list(Password) ->
+    case check_password_with_authmodule(User, Server, Password) of
+	{true, _AuthModule} -> true;
+	false -> false
+    end.
 
-set_password(User, Server, Password) ->
+%% @spec (User, Server, Password, Digest, DigestGen) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%%     Digest = string()
+%%     DigestGen = function()
+%% @doc Check if the user and password can login in server.
+
+check_password(User, Server, Password, Digest, DigestGen)
+  when is_list(User), is_list(Server), is_list(Password),
+  is_list(Digest), is_function(DigestGen) ->
+    case check_password_with_authmodule(User, Server, Password,
+					Digest, DigestGen) of
+	{true, _AuthModule} -> true;
+	false -> false
+    end.
+
+%% @spec (User, Server, Password) -> {true, AuthModule} | false
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%%     AuthModule = authmodule()
+%% @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.
+
+check_password_with_authmodule(User, Server, Password)
+  when is_list(User), is_list(Server), is_list(Password) ->
+    check_password_loop(auth_modules(Server), [User, Server, Password]).
+
+%% @spec (User, Server, Password, Digest, DigestGen) -> {true, AuthModule} | false
+%%     User = string()
+%%     Server = string()
+%%     Password = string() | undefined
+%%     Digest = string() | undefined
+%%     DigestGen = function()
+%%     AuthModule = authmodule()
+%% @doc Check the password is valid and also return the authentication module that accepts it.
+%% The password is 'undefined' if the client
+%% authenticates using the digest method as defined in
+%% XEP-0078: Non-SASL Authentication
+
+check_password_with_authmodule(User, Server, Password, Digest, DigestGen)
+  when is_list(User), is_list(Server), (is_list(Password) orelse Password == 'undefined'),
+  is_function(DigestGen), (is_list(Digest) orelse Digest == 'undefined')->
+    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, Server, Password) -> ok | {error, ErrorType}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%%     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)
+  when is_list(User), is_list(Server), is_list(Password) ->
     lists:foldl(
       fun(M, {error, _}) ->
 	      M:set_password(User, Server, Password);
@@ -93,45 +195,88 @@ set_password(User, Server, Password) ->
 	      Res
       end, {error, not_allowed}, auth_modules(Server)).
 
-try_register(User, Server, Password) ->
-    case is_user_exists(User,Server) of
+%% @spec (User, Server, Password) -> {atomic, ok} | {atomic, exists} | {error, not_allowed}
+%%     User = string()
+%%     Server = string()
+%%     Password = string() | nil()
+try_register(_User, _Server, "") ->
+    %% We do not allow empty password
+    {error, not_allowed};
+try_register(User, Server, Password)
+  when is_list(User), is_list(Server), is_list(Password) ->
+    case is_user_exists(User, Server) of
 	true ->
 	    {atomic, exists};
 	false ->
-	    case lists:member(jlib:nameprep(Server), ?MYHOSTS) of
+	    case ?IS_MY_HOST(exmpp_stringprep:nameprep(Server)) of
 		true ->
-		    lists:foldl(
-		      fun(_M, {atomic, ok} = Res) ->
-			      Res;
-			 (M, _) ->
-			      M:try_register(User, Server, Password)
-		      end, {error, not_allowed}, auth_modules(Server));
+		    Res = lists:foldl(
+			    fun (_M, {atomic, ok} = Res) ->
+				    Res;
+				(M, _) ->
+				    M:try_register(User, Server, Password)
+			    end, {error, not_allowed}, auth_modules(Server)),
+		    trigger_register_hooks(Res, User, Server);
 		false ->
 		    {error, not_allowed}
 	    end
     end.
 
-%% Registered users list do not include anonymous users logged
+trigger_register_hooks({atomic, ok} = Res, User, Server) ->
+    ejabberd_hooks:run(register_user, list_to_binary(Server),
+		       [User, Server]),
+    Res;
+trigger_register_hooks(Res, _User, _Server) ->
+    Res.
+
+%% @spec () -> [{LUser, LServer}]
+%%     LUser = string()
+%%     LServer = string()
+%% @doc Registered users list do not include anonymous users logged.
+
 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) ->
+%% @spec (Server) -> [{LUser, LServer}]
+%%     Server = string()
+%%     LUser = string()
+%%     LServer = string()
+%% @doc Registered users list do not include anonymous users logged.
+
+get_vh_registered_users(Server) when is_list(Server) ->
     lists:flatmap(
       fun(M) ->
 	      M:get_vh_registered_users(Server)
       end, auth_modules(Server)).
 
-get_vh_registered_users(Server, Opts) ->
+%% @spec (Server, Opts) -> [{LUser, LServer}]
+%%     Server = string()
+%%     Opts = [{Opt, Val}]
+%%         Opt = atom()
+%%         Val = term()
+%%     LUser = string()
+%%     LServer = string()
+
+get_vh_registered_users(Server, Opts) when is_list(Server) ->
     lists:flatmap(
       fun(M) ->
-	      M:get_vh_registered_users(Server, Opts)
+		case erlang:function_exported(
+		       M, get_vh_registered_users_number, 2) of
+		    true ->
+			M:get_vh_registered_users_number(Server, Opts);
+		    false ->
+			M:get_vh_registered_users_number(Server)
+		end
       end, auth_modules(Server)).
 
-get_vh_registered_users_number(Server) ->
+%% @spec (Server) -> Users_Number
+%%     Server = string()
+%%     Users_Number = integer()
+
+get_vh_registered_users_number(Server) when is_list(Server) ->
     lists:sum(
       lists:map(
 	fun(M) ->
@@ -144,7 +289,14 @@ get_vh_registered_users_number(Server) ->
 		end
 	end, auth_modules(Server))).
 
-get_vh_registered_users_number(Server, Opts) ->
+%% @spec (Server, Opts) -> Users_Number
+%%     Server = string()
+%%     Opts = [{Opt, Val}]
+%%         Opt = atom()
+%%         Val = term()
+%%     Users_Number = integer()
+
+get_vh_registered_users_number(Server, Opts) when is_list(Server) ->
     lists:sum(
       lists:map(
 	fun(M) ->
@@ -157,7 +309,13 @@ get_vh_registered_users_number(Server, Opts) ->
 		end
 	end, auth_modules(Server))).
 
-get_password(User, Server) ->
+%% @spec (User, Server) -> Password | false
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%% @doc Get the password of the user.
+
+get_password(User, Server) when is_list(User), is_list(Server) ->
     lists:foldl(
       fun(M, false) ->
 	      M:get_password(User, Server);
@@ -165,7 +323,13 @@ get_password(User, Server) ->
 	      Password
       end, false, auth_modules(Server)).
 
-get_password_s(User, Server) ->
+%% @spec (User, Server) -> Password | nil()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%% @doc Get the password of the user.
+
+get_password_s(User, Server) when is_list(User), is_list(Server) ->
     case get_password(User, Server) of
 	false ->
 	    "";
@@ -173,54 +337,141 @@ get_password_s(User, Server) ->
 	    Password
     end.
 
-%% 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) ->
+%% @spec (User, Server) -> {Password, AuthModule} | {false, none}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%%     AuthModule = authmodule()
+%% @doc Get the password of the user and the auth module.
+
+get_password_with_authmodule(User, Server)
+  when is_list(User), is_list(Server) ->
+    lists:foldl(
+      fun(M, {false, _}) ->
+	      {M:get_password(User, Server), M};
+	 (_M, {Password, AuthModule}) ->
+	      {Password, AuthModule}
+      end, {false, none}, auth_modules(Server)).
+
+%% @spec (User, Server) -> bool()
+%%     User = string()
+%%     Server = string()
+%% @doc 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) when is_list(User), is_list(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
-is_user_exists_in_other_modules(Module, User, Server) ->
-    lists:any(
-      fun(M) ->
-	      M:is_user_exists(User, Server)
-      end, auth_modules(Server)--[Module]).
+%% @spec (Module, User, Server) -> true | false | maybe
+%%     Module = authmodule()
+%%     User = string()
+%%     Server = string()
+%% @doc Check if the user exists in all authentications module except
+%% the module passed as parameter.
 
-remove_user(User, Server) ->
-    lists:foreach(
-      fun(M) ->
-	      M:remove_user(User, Server)
-      end, auth_modules(Server)).
+is_user_exists_in_other_modules(Module, User, Server)
+  when is_list(User), is_list(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.
 
-remove_user(User, Server, Password) ->
-    lists:foreach(
-      fun(M) ->
+
+%% @spec (User, Server) -> ok | error | {error, not_allowed}
+%%     User = string()
+%%     Server = string()
+%% @doc Remove user.
+%% TODO: Fix me: It always return ok even if there was some problem removing the user.
+%% dialyzer warning
+%% ejabberd_auth.erl:388: The variable _ can never match since previous clauses completely covered the type 'ok'
+
+remove_user(User, Server) when is_list(User), is_list(Server) ->
+    R = lists:foreach(
+	  fun(M) ->
+		  M:remove_user(User, Server)
+	  end, auth_modules(Server)),
+    ejabberd_hooks:run(remove_user, list_to_binary(exmpp_stringprep:nameprep(Server)),
+				 [list_to_binary(User), list_to_binary(Server)]),
+    R.
+
+%% @spec (User, Server, Password) -> ok | not_exists | not_allowed | bad_request | error
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%% @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)
+  when is_list(User), is_list(Server), is_list(Password) ->
+    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, list_to_binary(exmpp_stringprep:nameprep(Server)),
+                                    [list_to_binary(User), list_to_binary(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
 %%%----------------------------------------------------------------------
-auth_modules(Server) ->
-    LServer = jlib:nameprep(Server),
-    Method = ejabberd_config:get_local_option({auth_method, LServer}),
+
+%% @spec () -> [authmodule()]
+%% @doc 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)).
+
+%% @spec (Server) -> [authmodule()]
+%%     Server = string()
+%% @doc Return the list of authenticated modules for a given host.
+
+auth_modules(Server) when is_list(Server) ->
+    LServer = exmpp_stringprep:nameprep(Server),
+    Method = ejabberd_config:get_local_option({auth_method, ejabberd:normalize_host(LServer)}),
     Methods = if
 		  Method == undefined -> [];
 		  is_list(Method) -> Method;
 		  is_atom(Method) -> [Method]
 	      end,
-    [list_to_atom("ejabberd_auth_" ++ atom_to_list(M)) || M <- Methods].
+    [module_name(M) || M <- Methods].
+
+module_name(Method) when is_atom(Method) ->
+    list_to_atom("ejabberd_auth_" ++ atom_to_list(Method)).

src/ejabberd_auth_anonymous.erl

@@ -5,7 +5,7 @@
 %%% Created : 17 Feb 2006 by Mickael Remond <mremond@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -33,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
 	]).
 
 
@@ -53,33 +53,48 @@
 	 remove_user/3,
 	 plain_password_required/0]).
 
+-include_lib("exmpp/include/exmpp.hrl").
+
 -include("ejabberd.hrl").
--include("jlib.hrl").
 -record(anonymous, {us, sid}).
 
-%% Create the anonymous table if at least one virtual host has anonymous features enabled
-%% Register to login / logout events
-start(Host) ->
+%% @spec (Host) -> ok
+%%     Host = string()
+%% @doc Create the anonymous table if at least one virtual host has
+%% anonymous features enabled.
+%% Register to login / logout events.
+
+start(Host) when is_list(Host) ->
+    HostB = list_to_binary(Host),
     %% TODO: Check cluster mode
+    update_tables(),
     mnesia:create_table(anonymous, [{ram_copies, [node()]},
-				    {type, bag},
-				    {attributes, record_info(fields, anonymous)}]),
+				    {type, bag}, {local_content, true},
+                                    {attributes, record_info(fields, anonymous)}]),
+    mnesia:add_table_copy(anonymous, node(), ram_copies),
     %% The hooks are needed to add / remove users from the anonymous tables
-    ejabberd_hooks:add(sm_register_connection_hook, Host,
+    ejabberd_hooks:add(sm_register_connection_hook, HostB,
 		       ?MODULE, register_connection, 100),
-    ejabberd_hooks:add(sm_remove_connection_hook, Host,
+    ejabberd_hooks:add(sm_remove_connection_hook, HostB,
 		       ?MODULE, unregister_connection, 100),
     ok.
 
-%% Return true if anonymous is allowed for host or false otherwise
-allow_anonymous(Host) ->
+%% @spec (Host) -> bool()
+%%     Host = string()
+%% @doc Return true if anonymous is allowed for host or false otherwise.
+
+allow_anonymous(Host) when is_list(Host) ->
     lists:member(?MODULE, ejabberd_auth:auth_modules(Host)).
 
-%% Return true if anonymous mode is enabled and if anonymous protocol is SASL
-%% anonymous protocol can be: sasl_anon|login_anon|both
-is_sasl_anonymous_enabled(Host) ->
+%% @spec (Host) -> bool()
+%%     Host = string()
+%% @doc Return true if anonymous mode is enabled and if anonymous
+%% protocol is SASL anonymous.
+%% protocol can be: sasl_anon|login_anon|both
+
+is_sasl_anonymous_enabled(Host) when is_list(Host) ->
     case allow_anonymous(Host) of
-	false -> false;	    
+	false -> false;
 	true ->
 	    case anonymous_protocol(Host) of
 		sasl_anon -> true;
@@ -88,23 +103,29 @@ is_sasl_anonymous_enabled(Host) ->
 	    end
     end.
 
-%% Return true if anonymous login is enabled on the server
+%% @spec (Host) -> bool()
+%%     Host = string()
+%% @doc Return true if anonymous login is enabled on the server.
 %% anonymous login can be use using standard authentication method (i.e. with
 %% clients that do not support anonymous login)
-is_login_anonymous_enabled(Host) ->
+
+is_login_anonymous_enabled(Host) when is_list(Host) ->
     case allow_anonymous(Host) of
 	false -> false;
 	true  ->
 	    case anonymous_protocol(Host) of
 		login_anon -> true;
-		both       -> true;		
+		both       -> true;
 		_Other     -> false
 	    end
     end.
 
-%% Return the anonymous protocol to use: sasl_anon|login_anon|both
+%% @spec (Host) -> sasl_anon | login_anon | both
+%%     Host = string()
+%% @doc Return the anonymous protocol to use: sasl_anon|login_anon|both.
 %% defaults to login_anon
-anonymous_protocol(Host) ->
+
+anonymous_protocol(Host) when is_list(Host) ->
     case ejabberd_config:get_local_option({anonymous_protocol, Host}) of
 	sasl_anon  -> sasl_anon;
 	login_anon -> login_anon;
@@ -112,18 +133,24 @@ anonymous_protocol(Host) ->
 	_Other     -> sasl_anon
     end.
 
-%% Return true if multiple connections have been allowed in the config file
+%% @spec (Host) -> bool()
+%%     Host = string()
+%% @doc 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.
 
-%% Check if user exist in the anonymus database
-anonymous_user_exist(User, Server) ->
-    LUser = jlib:nodeprep(User),
-    LServer = jlib:nameprep(Server),
+allow_multiple_connections(Host) when is_list(Host) ->
+    ejabberd_config:get_local_option(
+      {allow_multiple_connections, Host}) =:= true.
+
+%% @spec (User, Server) -> bool()
+%%     User = string()
+%%     Server = string()
+%% @doc Check if user exist in the anonymous database.
+
+anonymous_user_exist(User, Server) when is_list(User), is_list(Server) ->
+    LUser = exmpp_stringprep:nodeprep(User),
+    LServer = exmpp_stringprep:nameprep(Server),
     US = {LUser, LServer},
     case catch mnesia:dirty_read({anonymous, US}) of
 	[] ->
@@ -132,50 +159,93 @@ anonymous_user_exist(User, Server) ->
 	    true
     end.
 
-%% Remove connection from Mnesia tables
-remove_connection(SID, LUser, LServer) ->
+%% @spec (SID, LUser, LServer) -> term()
+%%     SID = term()
+%%     LUser = string()
+%%     LServer = string()
+%% @doc Remove connection from Mnesia tables.
+
+remove_connection(SID, LUser, LServer) when is_list(LUser), is_list(LServer) ->
     US = {LUser, LServer},
     F = fun() ->
 		mnesia:delete_object({anonymous, US, SID})
         end,
-    mnesia:transaction(F).
+    mnesia:async_dirty(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).
+%% @spec (SID, JID, Info) -> term()
+%%     SID = term()
+%%     JID = exmpp_jid:jid()
+%%     Info = [term()]
+%% @doc Register connection.
 
-%% Remove an anonymous user from the anonymous users table
-unregister_connection(SID, #jid{luser = LUser, lserver = LServer}) ->
+register_connection(SID, JID, Info) when ?IS_JID(JID) ->
+    LUser = exmpp_jid:prep_node(JID),
+    LServer = exmpp_jid:prep_domain(JID),
+    case proplists:get_value(auth_module, Info) of
+        undefined ->
+            ok;
+        ?MODULE ->
+	    ejabberd_hooks:run(register_user, LServer, [LUser, LServer]),
+	    US = {LUser, LServer},
+	    mnesia:async_dirty(
+	      fun() -> mnesia:write(#anonymous{us = US, sid=SID})
+	      end);
+        _ ->
+            ok
+    end.
+
+%% @spec (SID, JID, Ignored) -> term()
+%%     SID = term()
+%%     JID = exmpp_jid:jid()
+%%     Ignored = term()
+%% @doc Remove an anonymous user from the anonymous users table.
+
+unregister_connection(SID, JID, _) when ?IS_JID(JID) ->
+    LUser = exmpp_jid:prep_node_as_list(JID),
+    LServer = exmpp_jid:prep_domain_as_list(JID),
     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
+%% @spec (bool(), LUser, LServer) -> term()
+%%     LUser = string()
+%%     LServer = string()
+%% @doc 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]).
+purge_hook(true, LUser, LServer) when is_list(LUser), is_list(LServer) ->
+    ejabberd_hooks:run(anonymous_purge_hook, list_to_binary(LServer), [LUser, LServer]).
 
 %% ---------------------------------
 %% Specific anonymous auth functions
 %% ---------------------------------
 
-%% When anonymous login is enabled, check the password for permenant users
-%% before allowing access
+%% @spec (User, Server, Password) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%% @doc When anonymous login is enabled, check the password for
+%% permenant users 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_in_other_modules(?MODULE, 
+    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.
 
+%% @spec (User, Server) -> bool()
+%%     User = string()
+%%     Server = string()
+
 login(User, Server) ->
     case is_login_anonymous_enabled(Server) of
 	false -> false;
@@ -190,8 +260,13 @@ login(User, Server) ->
 	    end
     end.
 
-%% When anonymous login is enabled, check that the user is permanent before
-%% changing its password
+%% @spec (User, Server, Password) -> ok | {error, not_allowed}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%% @doc When anonymous login is enabled, check that the user is
+%% permanent before changing its password.
+
 set_password(User, Server, _Password) ->
     case anonymous_user_exist(User, Server) of
 	true ->
@@ -200,24 +275,43 @@ set_password(User, Server, _Password) ->
 	    {error, not_allowed}
     end.
 
-%% When anonymous login is enabled, check if permanent users are allowed on
-%% the server:
+%% @spec (User, Server, Password) -> {error, not_allowed}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%% @doc When anonymous login is enabled, check if permanent users are
+%% allowed on the server:
+
 try_register(_User, _Server, _Password) ->
     {error, not_allowed}.
 
+%% @spec () -> nil()
+
 dirty_get_registered_users() ->
     [].
 
-get_vh_registered_users(_Server) ->
-    [].
+%% @spec (Server) -> nil()
+%%     Server = string()
 
+get_vh_registered_users(Server) ->
+    [{U, S} || {U, S, _R} <- ejabberd_sm:get_vh_session_list(list_to_binary(Server))].
+
+%% @spec (User, Server) -> Password | false
+%%     User = string()
+%%     Server = string()
+%%     Password = nil()
+%% @doc Return password of permanent user or false for anonymous users.
 
-%% Return password of permanent user or false for anonymous users
 get_password(User, Server) ->
     get_password(User, Server, "").
 
+%% @spec (User, Server, DefaultValue) -> DefaultValue | false
+%%     User = string()
+%%     Server = string()
+%%     DefaultValue = string()
+
 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;
@@ -226,17 +320,39 @@ get_password(User, Server, DefaultValue) ->
 	    false
     end.
 
-%% Returns true if the user exists in the DB or if an anonymous user is logged
-%% under the given name
+%% @spec (User, Server) -> bool()
+%%     User = string()
+%%     Server = string()
+%% @doc 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) ->
     anonymous_user_exist(User, Server).
 
+%% @spec (User, Server) -> {error, not_allowed}
+%%     User = string()
+%%     Server = string()
+
 remove_user(_User, _Server) ->
     {error, not_allowed}.
 
+%% @spec (User, Server, Password) -> {error, not_allowed}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 remove_user(_User, _Server, _Password) ->
     not_allowed.
 
+%% @spec () -> bool()
+
 plain_password_required() ->
     false.
 
+update_tables() ->
+    case catch mnesia:table_info(anonymous, local_content) of
+	false ->
+	    mnesia:delete_table(anonymous);
+	_ ->
+	    ok
+    end.

src/ejabberd_auth_external.erl

@@ -5,7 +5,7 @@
 %%% Created : 12 Dec 2004 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -35,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,
@@ -43,47 +46,316 @@
 	 plain_password_required/0
 	]).
 
+-include("ejabberd.hrl").
+
 %%%----------------------------------------------------------------------
 %%% API
 %%%----------------------------------------------------------------------
+
+%% @spec (Host) -> ok
+%%     Host = string()
+
 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_storage: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.
+
+%% @spec () -> bool()
 
 plain_password_required() ->
     true.
 
-check_password(User, Server, Password) ->
-    extauth:check_password(User, Server, Password).
+%% @spec (User, Server, Password) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
 
-check_password(User, Server, Password, _StreamID, _Digest) ->
+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.
+
+%% @spec (User, Server, Password, Digest, DigestGen) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%%     Digest = string()
+%%     DigestGen = function()
+
+check_password(User, Server, Password, _Digest, _DigestGen) ->
     check_password(User, Server, Password).
 
-set_password(User, Server, Password) ->
-    extauth:set_password(User, Server, Password).
+%% @spec (User, Server, Password) -> ok | {error, unknown_problem}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
 
-try_register(_User, _Server, _Password) ->
-    {error, not_allowed}.
+set_password(User, Server, Password) ->
+    case extauth:set_password(User, Server, Password) of
+	true -> set_password_storage(User, Server, Password),
+		ok;
+	_ -> {error, unknown_problem}
+    end.
+
+%% @spec (User, Server, Password) -> {error, not_allowed}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
+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.
+
+%% @spec () -> nil()
+%% @todo Write it.
+%% @doc Return the list of all users handled by external.
 
 dirty_get_registered_users() ->
-    [].
+    ejabberd_auth_storage:dirty_get_registered_users().
 
-get_vh_registered_users(_Server) ->
-    [].
+get_vh_registered_users(Server) ->
+    ejabberd_auth_storage:get_vh_registered_users(Server).
 
-get_password(_User, _Server) ->
-    false.
+get_vh_registered_users(Server, Data)  ->
+    ejabberd_auth_storage:get_vh_registered_users(Server, Data).
 
-get_password_s(_User, _Server) ->
-    "".
+%% @spec (Server) -> nil()
+%%     Server = string()
+
+get_vh_registered_users_number(Server) ->
+    ejabberd_auth_storage:get_vh_registered_users_number(Server).
+
+get_vh_registered_users_number(Server, Data) ->
+    ejabberd_auth_storage:get_vh_registered_users_number(Server, Data).
+
+%% @spec (User, Server) -> bool()
+%%     User = string()
+%%     Server = string()
+%% @doc Get the user cached password, if possible.
+%% 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.
+
+%% @spec (User, Server) -> nil()
+%%     User = string()
+%%     Server = string()
+
+get_password_s(User, Server) ->
+    case get_password(User, Server) of
+	false -> [];
+	Other -> Other
+    end.
+
+%% @spec (User, Server) -> true | false | {error, Error}
+%%     User = string()
+%%     Server = string()
 
 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}.
+%% @spec (User, Server) -> {error, not_allowed}
+%%     User = string()
+%%     Server = string()
 
-remove_user(_User, _Server, _Password) ->
-    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_storage:remove_user(User, Server)
+	    end
+    end.
 
+%% @spec (User, Server, Password) -> not_allowed
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
+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_storage: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_storage(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_storage(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_storage(User, Server) ->
+    ejabberd_auth_storage:get_password(User, Server).
+
+%% @spec (User, Server, CacheTime) -> Password::string() | false
+get_password_cache(User, Server, CacheTime) ->
+    case get_last_access(User, Server) of
+	online ->
+	    get_password_storage(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_storage(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_storage(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_storage(User, Server, Password),
+	    R;
+	_ -> {error, not_allowed}
+    end.
+
+%% @spec (User, Server, Password) -> true | false
+check_password_storage(User, Server, Password) ->
+    ejabberd_auth_storage:check_password(User, Server, Password).
+
+%% @spec (User, Server, Password) -> ok | {error, invalid_jid}
+set_password_storage(User, Server, Password) ->
+    ejabberd_auth_storage: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) -> TimeStamp::integer() | online | never | mod_last_required
+get_last_access(UserS, ServerS) ->
+    %% Code copied from mod_configure.erl
+    %% Code copied from web/ejabberd_web_admin.erl
+    %% TODO: Update time format to XEP-0202: Entity Time
+    User = list_to_binary(UserS),
+    Server = list_to_binary(ServerS),
+    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);
+	no_mod_last -> mod_last_required
+    end.
+
+%% @spec (Server) -> mod_last | no_mod_last
+get_mod_last_enabled(ServerB) when is_binary(ServerB)->
+    Server = binary_to_list(ServerB),
+    get_mod_last_enabled(Server);
+get_mod_last_enabled(Server) ->
+    case lists:member(mod_last, gen_mod:loaded_modules(Server)) of
+	true -> mod_last;
+	false -> no_mod_last
+    end.

src/ejabberd_auth_internal.erl

@@ -1,11 +1,11 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_auth_internal.erl
 %%% Author  : Alexey Shchepin <alexey@process-one.net>
-%%% Purpose : Authentification via mnesia
+%%% Purpose : Authentification via mnesia (obsolete)
 %%% Created : 12 Dec 2004 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -49,43 +49,72 @@
 -include("ejabberd.hrl").
 
 -record(passwd, {us, password}).
+-record(reg_users_counter, {vhost, count}).
 
 %%%----------------------------------------------------------------------
 %%% API
 %%%----------------------------------------------------------------------
+
+%% @spec (Host) -> ok
+%%     Host = string()
+
 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 = exmpp_jid:prep_domain(exmpp_jid:parse(Server)),
+    F = fun() ->
+        mnesia:write(#reg_users_counter{vhost = LServer,
+					count = Size})
+    end,
+    mnesia:sync_dirty(F).
+
+%% @spec () -> bool()
+
 plain_password_required() ->
     false.
 
+%% @spec (User, Server, Password) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 check_password(User, Server, Password) ->
-    LUser = jlib:nodeprep(User),
-    LServer = jlib:nameprep(Server),
+    LUser = exmpp_stringprep:nodeprep(User),
+    LServer = exmpp_stringprep:nameprep(Server),
     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) ->
-    LUser = jlib:nodeprep(User),
-    LServer = jlib:nameprep(Server),
+%% @spec (User, Server, Password, Digest, DigestGen) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%%     Digest = string()
+%%     DigestGen = function()
+
+check_password(User, Server, Password, Digest, DigestGen) ->
+    LUser = exmpp_stringprep:nodeprep(User),
+    LServer = exmpp_stringprep:nameprep(Server),
     US = {LUser, LServer},
     case catch mnesia:dirty_read({passwd, US}) of
 	[#passwd{password = Passwd}] ->
 	    DigRes = if
 			 Digest /= "" ->
-			     Digest == sha:sha(StreamID ++ Passwd);
+			     Digest == DigestGen(Passwd);
 			 true ->
 			     false
 		     end,
@@ -98,35 +127,50 @@ check_password(User, Server, Password, StreamID, Digest) ->
 	    false
     end.
 
+%% @spec (User, Server, Password) -> ok | {error, invalid_jid}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 set_password(User, Server, Password) ->
-    LUser = jlib:nodeprep(User),
-    LServer = jlib:nameprep(Server),
-    US = {LUser, LServer},
-    if
-	(LUser == error) or (LServer == error) ->
+    LUser = (catch exmpp_stringprep:nodeprep(User)),
+    LServer = (catch exmpp_stringprep:nameprep(Server)),
+    case {LUser, LServer} of
+	{{stringprep, _, invalid_string, _}, _} ->
 	    {error, invalid_jid};
-	true ->
+	{_, {stringprep, _, invalid_string, _}} ->
+	    {error, invalid_jid};
+	US ->
 	    F = fun() ->
 			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}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
 
 try_register(User, Server, Password) ->
-    LUser = jlib:nodeprep(User),
-    LServer = jlib:nameprep(Server),
-    US = {LUser, LServer},
-    if
-	(LUser == error) or (LServer == error) ->
+    LUser = (catch exmpp_stringprep:nodeprep(User)),
+    LServer = (catch exmpp_stringprep:nameprep(Server)),
+    case {LUser, LServer} of
+	{{stringprep, _, invalid_string, _}, _} ->
 	    {error, invalid_jid};
-	true ->
+	{_, {stringprep, _, invalid_string, _}} ->
+	    {error, invalid_jid};
+	US ->
 	    F = fun() ->
 			case mnesia:read({passwd, US}) of
 			    [] ->
 				mnesia:write(#passwd{us = US,
 						     password = Password}),
+				mnesia:dirty_update_counter(
+						    reg_users_counter,
+						    exmpp_jid:prep_domain(exmpp_jid:parse(Server)), 1),
 				ok;
 			    [_E] ->
 				exists
@@ -135,17 +179,45 @@ try_register(User, Server, Password) ->
 	    mnesia:transaction(F)
     end.
 
+%% @spec () -> [{LUser, LServer}]
+%%     LUser = string()
+%%     LServer = string()
+%% @doc Get all registered users in Mnesia.
+
 dirty_get_registered_users() ->
     mnesia:dirty_all_keys(passwd).
 
+%% @spec (Server) -> [{LUser, LServer}]
+%%     Server = string()
+%%     LUser = string()
+%%     LServer = string()
+
 get_vh_registered_users(Server) ->
-    LServer = jlib:nameprep(Server),
+    LServer = exmpp_stringprep:nameprep(Server),
     mnesia:dirty_select(
       passwd,
       [{#passwd{us = '$1', _ = '_'}, 
 	[{'==', {element, 2, '$1'}, LServer}], 
 	['$1']}]).
 
+%% @spec (Server, Opts) -> [{LUser, LServer}]
+%%     Server = string()
+%%     Opts = [{Opt, Val}]
+%%         Opt = atom()
+%%         Val = term()
+%%     LUser = string()
+%%     LServer = string()
+%% @doc Return the registered users for the specified host.
+%%
+%% `Opts' can be one of the following:
+%% <ul>
+%% <li>`[{from, integer()}, {to, integer()}]'</li>
+%% <li>`[{limit, integer()}, {offset, integer()}]'</li>
+%% <li>`[{prefix, string()}]'</li>
+%% <li>`[{prefix, string()}, {from, integer()}, {to, integer()}]'</li>
+%% <li>`[{prefix, string()}, {limit, integer()}, {offset, integer()}]'</li>
+%% </ul>
+
 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}]);
@@ -192,9 +264,27 @@ get_vh_registered_users(Server, [{prefix, Prefix}, {limit, Limit}, {offset, Offs
 get_vh_registered_users(Server, _) ->
     get_vh_registered_users(Server).
 
+%% @spec (Server) -> Users_Number
+%%     Server = string()
+%%     Users_Number = integer()
+
 get_vh_registered_users_number(Server) ->
-    Set = get_vh_registered_users(Server),
-    length(Set).
+    LServer = exmpp_jid:prep_domain(exmpp_jid:parse(Server)),
+    Query = mnesia:dirty_select(
+		reg_users_counter,
+		[{#reg_users_counter{vhost = LServer, count = '$1'},
+		  [],
+		  ['$1']}]),
+    case Query of
+	[Count] ->
+	    Count;
+	_ -> 0
+    end.
+
+%% @spec (Server, [{prefix, Prefix}]) -> Users_Number
+%%     Server = string()
+%%     Prefix = string()
+%%     Users_Number = integer()
 
 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)],
@@ -203,81 +293,139 @@ get_vh_registered_users_number(Server, [{prefix, Prefix}]) when is_list(Prefix)
 get_vh_registered_users_number(Server, _) ->
     get_vh_registered_users_number(Server).
 
+%% @spec (User, Server) -> Password | false
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 get_password(User, Server) ->
-    LUser = jlib:nodeprep(User),
-    LServer = jlib:nameprep(Server),
-    US = {LUser, LServer},
-    case catch mnesia:dirty_read(passwd, US) of
-	[#passwd{password = Password}] ->
-	    Password;
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	LServer = exmpp_stringprep:nameprep(Server),
+	US = {LUser, LServer},
+	case catch mnesia:dirty_read(passwd, US) of
+	    [#passwd{password = Password}] ->
+		Password;
+	    _ ->
+		false
+	end
+    catch
 	_ ->
 	    false
     end.
 
+%% @spec (User, Server) -> Password | nil()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 get_password_s(User, Server) ->
-    LUser = jlib:nodeprep(User),
-    LServer = jlib:nameprep(Server),
-    US = {LUser, LServer},
-    case catch mnesia:dirty_read(passwd, US) of
-	[#passwd{password = Password}] ->
-	    Password;
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	LServer = exmpp_stringprep:nameprep(Server),
+	US = {LUser, LServer},
+	case catch mnesia:dirty_read(passwd, US) of
+	    [#passwd{password = Password}] ->
+		Password;
+	    _ ->
+		[]
+	end
+    catch
 	_ ->
 	    []
     end.
 
+%% @spec (User, Server) -> true | false | {error, Error}
+%%     User = string()
+%%     Server = string()
+
 is_user_exists(User, Server) ->
-    LUser = jlib:nodeprep(User),
-    LServer = jlib:nameprep(Server),
-    US = {LUser, LServer},
-    case catch mnesia:dirty_read({passwd, US}) of
-	[] ->
-	    false;
-	[_] ->
-	    true;
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	LServer = exmpp_stringprep:nameprep(Server),
+	US = {LUser, LServer},
+	case catch mnesia:dirty_read({passwd, US}) of
+	    [] ->
+		false;
+	    [_] ->
+		true;
+	    Other ->
+		{error, Other}
+	end
+    catch
 	_ ->
 	    false
     end.
 
+%% @spec (User, Server) -> ok
+%%     User = string()
+%%     Server = string()
+%% @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})
-        end,
-    mnesia:transaction(F),
-    ejabberd_hooks:run(remove_user, LServer, [User, Server]).
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	LServer = exmpp_stringprep:nameprep(Server),
+	US = {LUser, LServer},
+	F = fun() ->
+		    mnesia:delete({passwd, US}),
+		    mnesia:dirty_update_counter(reg_users_counter,
+						exmpp_jid:prep_domain(exmpp_jid:parse(Server)), -1)
+	    end,
+	mnesia:transaction(F),
+	ok
+    catch
+	_ ->
+	    ok
+    end.
+
+%% @spec (User, Server, Password) -> ok | not_exists | not_allowed | bad_request
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%% @doc Remove user if the provided password is correct.
 
 remove_user(User, Server, Password) ->
-    LUser = jlib:nodeprep(User),
-    LServer = jlib:nameprep(Server),
-    US = {LUser, LServer},
-    F = fun() ->
-		case mnesia:read({passwd, US}) of
-		    [#passwd{password = Password}] ->
-			mnesia:delete({passwd, US}),
-			ok;
-		    [_] ->
-			not_allowed;
-		    _ ->
-			not_exists
-		end
-        end,
-    case mnesia:transaction(F) of
-	{atomic, ok} ->
-	    ejabberd_hooks:run(remove_user, LServer, [User, Server]),
-	    ok;
-	{atomic, Res} ->
-	    Res;
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	LServer = exmpp_stringprep:nameprep(Server),
+	US = {LUser, LServer},
+	F = fun() ->
+		    case mnesia:read({passwd, US}) of
+			[#passwd{password = Password}] ->
+			    mnesia:delete({passwd, US}),
+			    mnesia:dirty_update_counter(reg_users_counter,
+							exmpp_jid:prep_domain(exmpp_jid:parse(Server)), -1),
+			    ok;
+			[_] ->
+			    not_allowed;
+			_ ->
+			    not_exists
+		    end
+	    end,
+	case mnesia:transaction(F) of
+	    {atomic, ok} ->
+		ok;
+	    {atomic, Res} ->
+		Res;
+	    _ ->
+		bad_request
+	end
+    catch
 	_ ->
 	    bad_request
     end.
 
+%% @spec () -> term()
 
 update_table() ->
     Fields = record_info(fields, passwd),
     case mnesia:table_info(passwd, attributes) of
 	Fields ->
+	    % No conversion is needed when the table comes from an exmpp-less
+	    % Ejabberd because ejabberd_auth* modules use string() and not
+	    % binary().
 	    ok;
 	[user, password] ->
 	    ?INFO_MSG("Converting passwd table from "

src/ejabberd_auth_ldap.erl

@@ -5,7 +5,7 @@
 %%% Created : 12 Dec 2004 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -48,6 +48,7 @@
 	 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,
@@ -65,12 +66,12 @@
 		servers,
 		backups,
 		port,
+		tls_options,
 		dn,
 		password,
 		base,
 		uids,
 		ufilter,
-		sfilter,
 		lfilter, %% Local filter (performed by ejabberd, not LDAP)
 		dn_filter,
 		dn_filter_attrs
@@ -85,33 +86,69 @@ handle_info(_Info, State) ->
     {noreply, State}.
 %% -----
 
+
+-define(LDAP_SEARCH_TIMEOUT, 5). % Timeout for LDAP search queries in seconds
+
+
 %%%----------------------------------------------------------------------
 %%% API
 %%%----------------------------------------------------------------------
 
+%% @spec (Host) -> term()
+%%     Host = string()
+
 start(Host) ->
-    Proc = gen_mod:get_module_proc(Host, ?MODULE),
-    ChildSpec = {
-      Proc, {?MODULE, start_link, [Host]},
-      transient, 1000, worker, [?MODULE]
-     },
-    supervisor:start_child(ejabberd_sup, ChildSpec).
+    ?DEBUG("Starting ~p for ~p.", [?MODULE, Host]),
+    case ejabberd_config:get_host_option(Host, ldap_servers) of
+	undefined -> check_bad_config(Host);
+	{host, _Host} -> ok;
+	_ ->
+	    Proc = gen_mod:get_module_proc(Host, ?MODULE),
+	    ChildSpec = {
+		Proc, {?MODULE, start_link, [Host]},
+		transient, 1000, worker, [?MODULE]
+	    },
+	    supervisor:start_child(ejabberd_sup, ChildSpec)
+    end.
+
+check_bad_config(Host) ->
+    case ejabberd_config:get_local_option({ldap_servers, Host}) of
+	undefined ->
+	    ?ERROR_MSG("Can't start ~p for host ~p: missing ldap_servers configuration",
+	               [?MODULE, Host]),
+	    {error, bad_config};
+	_ -> ok
+    end.
+
+%% @spec (Host) -> term()
+%%     Host = string()
 
 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).
+    case ejabberd_config:get_host_option(Host, ldap_servers) of
+	undefined -> ok;
+	{host, _Host} -> ok;
+	_ ->
+	    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)
+    end.
+
+%% @spec (Host) -> term()
+%%     Host = string()
 
 start_link(Host) ->
     Proc = gen_mod:get_module_proc(Host, ?MODULE),
     gen_server:start_link({local, Proc}, ?MODULE, Host, []).
 
-terminate(_Reason, State) ->
-    ejabberd_ctl:unregister_commands(
-      State#state.host,
-      [{"registered-users", "list all registered users"}],
-      ejabberd_auth, ctl_process_get_registered).
+%% @hidden
+
+terminate(_Reason, _State) ->
+    ok.
+
+%% @spec (Host) -> {ok, State}
+%%     Host = string()
+%%     State = term()
 
 init(Host) ->
     State = parse_options(Host),
@@ -120,22 +157,27 @@ init(Host) ->
 		     State#state.backups,
 		     State#state.port,
 		     State#state.dn,
-		     State#state.password),
+		     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),
-    ejabberd_ctl:register_commands(
-      Host,
-      [{"registered-users", "list all registered users"}],
-      ejabberd_auth, ctl_process_get_registered),
+		     State#state.password,
+		     State#state.tls_options),
     {ok, State}.
 
+%% @spec () -> true
+
 plain_password_required() ->
     true.
 
+%% @spec (User, Server, Password) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 check_password(User, Server, Password) ->
     %% In LDAP spec: empty password means anonymous authentication.
     %% As ejabberd is providing other anonymous authentication mechanisms
@@ -149,17 +191,54 @@ check_password(User, Server, Password) ->
         end
     end.
 
-check_password(User, Server, Password, _StreamID, _Digest) ->
+%% @spec (User, Server, Password, Digest, DigestGen) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%%     Digest = string()
+%%     DigestGen = function()
+
+check_password(User, Server, Password, _Digest, _DigestGen) ->
     check_password(User, Server, Password).
 
-set_password(_User, _Server, _Password) ->
-    {error, not_allowed}.
+%% @spec (User, Server, Password) -> {error, Reason} | ok
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%%     Reason = term()
+
+set_password(User, Server, Password) ->
+    {ok, State} = eldap_utils:get_state(Server, ?MODULE),
+    case find_user_dn(User, Server, 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}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
 
 try_register(_User, _Server, _Password) ->
     {error, not_allowed}.
 
+%% @spec () -> [{LUser, LServer}]
+%%     LUser = string()
+%%     LServer = string()
+
 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).
+
+%% @spec (Server) -> [{LUser, LServer}]
+%%     Server = string()
+%%     LUser = string()
+%%     LServer = string()
 
 get_vh_registered_users(Server) ->
     case catch get_vh_registered_users_ldap(Server) of
@@ -167,32 +246,66 @@ get_vh_registered_users(Server) ->
 	Result -> Result
 	end.
 
+%% @spec (Server) -> Users_Number
+%%     Server = string()
+%%     Users_Number = integer()
+
+get_vh_registered_users_number(Server) ->
+    length(get_vh_registered_users(Server)).
+
+%% @spec (User, Server) -> bool()
+%%     User = string()
+%%     Server = string()
+
 get_password(_User, _Server) ->
     false.
 
+%% @spec (User, Server) -> nil()
+%%     User = string()
+%%     Server = string()
+
 get_password_s(_User, _Server) ->
     "".
 
+%% @spec (User, Server) -> true | false | {error, Error}
+%%     User = string()
+%%     Server = string()
+
 is_user_exists(User, Server) ->
     case catch is_user_exists_ldap(User, Server) of
-	{'EXIT', _} ->
-	    false;
+	{'EXIT', Error} ->
+	    {error, Error};
 	Result ->
 	    Result
     end.
 
+%% @spec (User, Server) -> {error, not_allowed}
+%%     User = string()
+%%     Server = string()
+
 remove_user(_User, _Server) ->
     {error, not_allowed}.
 
+%% @spec (User, Server, Password) -> not_allowed
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 remove_user(_User, _Server, _Password) ->
     not_allowed.
 
 %%%----------------------------------------------------------------------
 %%% Internal functions
 %%%----------------------------------------------------------------------
+
+%% @spec (User, Server, Password) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 check_password_ldap(User, Server, Password) ->
-	{ok, State} = eldap_utils:get_state(Server, ?MODULE),
-	case find_user_dn(User, State) of
+    {ok, State} = get_state(Server),
+    case find_user_dn(User, Server, State) of
 	false ->
 	    false;
 	DN ->
@@ -200,24 +313,44 @@ check_password_ldap(User, Server, Password) ->
 		ok -> true;
 		_ -> false
 	    end
-	end.
+    end.
+
+%% We need an ?MODULE server state to use for queries. This will
+%% either be Server if this is a statically configured host or the
+%% Server for a different host if this is a dynamically configured
+%% vhost.
+%% The {ldap_vhost, Server} -> Host. ejabberd config option specifies
+%% which actual ?MODULE server to use for a particular Host. The value
+%% of the option if it is defined or Server by default.
+get_state(Server) ->
+    Host = case ejabberd_config:get_local_option({ldap_servers, Server}) of
+	    {host, H} -> H;
+	    _ -> Server
+	end,
+    eldap_utils:get_state(Host, ?MODULE).
+
+%% @spec (Server) -> [{LUser, LServer}]
+%%     Server = string()
+%%     LUser = string()
+%%     LServer = string()
 
 get_vh_registered_users_ldap(Server) ->
     {ok, State} = eldap_utils:get_state(Server, ?MODULE),
-    UIDs = State#state.uids,
+    UIDs = eldap_utils:uids_domain_subst(Server, State#state.uids),
     Eldap_ID = State#state.eldap_id,
-    Server = State#state.host,
-    SortedDNAttrs = eldap_utils:usort_attrs(State#state.dn_filter_attrs),
-    case eldap_filter:parse(State#state.sfilter) of
+    SearchFilter = build_sfilter(State, UIDs),
+    ResAttrs = result_attrs(State),
+    case eldap_filter:parse(SearchFilter) of
 		{ok, EldapFilter} ->
 		    case eldap_pool:search(Eldap_ID, [{base, State#state.base},
 						 {filter, EldapFilter},
-						 {attributes, SortedDNAttrs}]) of
+						 {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
+				      case is_valid_dn(DN, Server, Attrs, State) of
 					  false -> [];
 					  _ ->
 					      case eldap_utils:find_ldap_attrs(UIDs, Attrs) of
@@ -225,9 +358,11 @@ get_vh_registered_users_ldap(Server) ->
 						  {User, UIDFormat} ->
 						      case eldap_utils:get_user_part(User, UIDFormat) of
 							  {ok, U} ->
-							      case jlib:nodeprep(U) of
-								  error -> [];
-								  LU -> [{LU, jlib:nameprep(Server)}]
+							      try
+								  [{exmpp_stringprep:nodeprep(U), exmpp_stringprep:nameprep(Server)}]
+							      catch
+								  _ ->
+								      []
 							      end;
 							  _ -> []
 						      end
@@ -241,9 +376,13 @@ get_vh_registered_users_ldap(Server) ->
 		    []
 	end.
 
+%% @spec (User, Server) -> bool()
+%%     User = string()
+%%     Server = string()
+
 is_user_exists_ldap(User, Server) ->
     {ok, State} = eldap_utils:get_state(Server, ?MODULE),
-    case find_user_dn(User, State) of
+    case find_user_dn(User, Server, State) of
 		false -> false;
 		_DN -> true
 	end.
@@ -257,16 +396,17 @@ handle_call(stop, _From, State) ->
 handle_call(_Request, _From, State) ->
     {reply, bad_request, State}.
 
-find_user_dn(User, State) ->
-    DNAttrs = eldap_utils:usort_attrs(State#state.dn_filter_attrs),
-    case eldap_filter:parse(State#state.ufilter, [{"%u", User}]) of
+find_user_dn(User, Server, State) ->
+    ResAttrs = result_attrs(State),
+    UserFilter = build_ufilter(State, Server),
+    case eldap_filter:parse(UserFilter, [{"%u", User}]) of
 	{ok, Filter} ->
 	    case eldap_pool:search(State#state.eldap_id, [{base, State#state.base},
 						     {filter, Filter},
-						     {attributes, DNAttrs}]) of
+						     {attributes, ResAttrs}]) of
 		#eldap_search_result{entries = [#eldap_entry{attributes = Attrs,
 							     object_name = DN} | _]} ->
-			dn_filter(DN, Attrs, State);
+			dn_filter(DN, Server, Attrs, State);
 		_ ->
 		    false
 	    end;
@@ -275,20 +415,20 @@ find_user_dn(User, State) ->
     end.
 
 %% apply the dn filter and the local filter:
-dn_filter(DN, Attrs, State) ->
+dn_filter(DN, Server, 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)
+        true -> is_valid_dn(DN, Server, Attrs, State)
     end.
 
 %% Check that the DN is valid, based on the dn filter
-is_valid_dn(DN, _, #state{dn_filter = undefined}) ->
+is_valid_dn(DN, _, _, #state{dn_filter = undefined}) ->
     DN;
 
-is_valid_dn(DN, Attrs, State) ->
+is_valid_dn(DN, Server, Attrs, State) ->
     DNAttrs = State#state.dn_filter_attrs,
-    UIDs = State#state.uids,
+    UIDs = eldap_utils:uids_domain_subst(Server, 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;
@@ -335,6 +475,30 @@ local_filter(equal, Attrs, FilterMatch) ->
 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).
+
+build_ufilter(State, VHost) ->
+    UIDs = eldap_utils:uids_domain_subst(VHost, State#state.uids),
+    SubFilter = lists:flatten(eldap_utils:generate_subfilter(UIDs)),
+    case State#state.ufilter of
+	"" -> SubFilter;
+	F -> "(&" ++ SubFilter ++ F ++ ")"
+    end.
+
+build_sfilter(State, FormattedUIDs) ->
+    SubFilter = lists:flatten(eldap_utils:generate_subfilter(FormattedUIDs)),
+    UserFilter = case State#state.ufilter of
+		     "" -> SubFilter;
+		     F -> "(&" ++ SubFilter ++ F ++ ")"
+		 end,
+    eldap_filter:do_sub(UserFilter, [{"%u", "*"}]).
+
 %%%----------------------------------------------------------------------
 %%% Auxiliary functions
 %%%----------------------------------------------------------------------
@@ -346,8 +510,14 @@ parse_options(Host) ->
 		   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 -> 389;
+		   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
@@ -360,20 +530,21 @@ parse_options(Host) ->
 	       end,
     UIDs = case ejabberd_config:get_local_option({ldap_uids, Host}) of
 	       undefined -> [{"uid", "%u"}];
-	       UI -> eldap_utils:uids_domain_subst(Host, UI)
+	       UI -> 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 ++ ")"
+		     undefined -> "";
+		     F -> 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, undefined};
-	    {DNF, DNFA} -> {DNF, DNFA}
+	    undefined ->
+		{undefined, []};
+	    {DNF, undefined} ->
+		{DNF, []};
+	    {DNF, DNFA} ->
+		{DNF, DNFA}
 	end,
 	LocalFilter = ejabberd_config:get_local_option({ldap_local_filter, Host}),
     #state{host = Host,
@@ -382,12 +553,13 @@ parse_options(Host) ->
 	   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,11 +1,11 @@
 %%%----------------------------------------------------------------------
 %%% File    : ejabberd_auth_odbc.erl
 %%% Author  : Alexey Shchepin <alexey@process-one.net>
-%%% Purpose : Authentification via ODBC
+%%% Purpose : Authentification via ODBC (obsolete)
 %%% Created : 12 Dec 2004 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -29,6 +29,7 @@
 
 %% External exports
 -export([start/1,
+	 stop/1,
 	 set_password/3,
 	 check_password/3,
 	 check_password/5,
@@ -51,89 +52,152 @@
 %%%----------------------------------------------------------------------
 %%% API
 %%%----------------------------------------------------------------------
+
+%% @spec (Host) -> ok
+%%     Host = string()
+
 start(Host) ->
-    ejabberd_ctl:register_commands(
-      Host,
-      [{"registered-users", "list all registered users"}],
-      ejabberd_auth, ctl_process_get_registered),
-    ok.
+    case ejabberd_odbc:running(Host) of
+	true -> ok;
+	false -> ejabberd_rdbms:start_odbc(Host)
+    end.
+  
+stop(Host) ->
+    ejabberd_rdbms:stop_odbc(Host).
+
+%% @spec () -> bool()
 
 plain_password_required() ->
     false.
 
+%% @spec (User, Server, Password) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 check_password(User, Server, Password) ->
-    case jlib:nodeprep(User) of
-	error ->
-	    false;
-	LUser ->
-	    Username = ejabberd_odbc:escape(LUser),
-	    LServer = jlib:nameprep(Server),
-	    case catch odbc_queries:get_password(LServer, Username) of
-		{selected, ["password"], [{Password}]} ->
-		    true;
-		_ ->
-		    false
-	    end
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	Username = ejabberd_odbc:escape(LUser),
+	LServer = exmpp_stringprep:nameprep(Server),
+	try odbc_queries:get_password(LServer, Username) of
+	    {selected, ["password"], [{Password}]} ->
+		    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
+    catch
+	_ ->
+	    false
     end.
 
-check_password(User, Server, Password, StreamID, Digest) ->
-    case jlib:nodeprep(User) of
-	error ->
-	    false;
-	LUser ->
-	    Username = ejabberd_odbc:escape(LUser),
-	    LServer = jlib:nameprep(Server),
-	    case catch odbc_queries:get_password(LServer, Username) of
-		{selected, ["password"], [{Passwd}]} ->
-		    DigRes = if
-				 Digest /= "" ->
-				     Digest == sha:sha(StreamID ++ Passwd);
-				 true ->
-				     false
-			     end,
-		    if DigRes ->
-			    true;
-		       true ->
-			    (Passwd == Password) and (Password /= "")
-		    end;
-		_ ->
-		    false
-	    end
+%% @spec (User, Server, Password, Digest, DigestGen) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%%     Digest = string()
+%%     DigestGen = function()
+
+check_password(User, Server, Password, Digest, DigestGen) ->
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	Username = ejabberd_odbc:escape(LUser),
+	LServer = exmpp_stringprep:nameprep(Server),
+	try odbc_queries:get_password(LServer, Username) of
+		%% Account exists, check if password is valid
+	    {selected, ["password"], [{Passwd}]} ->
+		DigRes = if
+		    Digest /= "" ->
+				     Digest == DigestGen(Passwd);
+		    true ->
+			false
+		end,
+		if DigRes ->
+			true;
+		    true ->
+			(Passwd == Password) and (Password /= "")
+		end;
+		{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
+    catch
+	_ ->
+	    false
     end.
 
+%% @spec (User, Server, Password) -> ok | {error, invalid_jid}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 set_password(User, Server, Password) ->
-    case jlib:nodeprep(User) of
-	error ->
-	    {error, invalid_jid};
-	LUser ->
-	    Username = ejabberd_odbc:escape(LUser),
-	    Pass = ejabberd_odbc:escape(Password),
-	    LServer = jlib:nameprep(Server),
-	    catch odbc_queries:set_password_t(LServer, Username, Pass)
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	Username = ejabberd_odbc:escape(LUser),
+	Pass = ejabberd_odbc:escape(Password),
+	LServer = exmpp_stringprep:nameprep(Server),
+	case catch odbc_queries:set_password_t(LServer, Username, Pass) of
+	    {atomic, ok} -> ok;
+	    Other -> {error, Other}
+	end
+    catch
+	_ ->
+	    {error, invalid_jid}
     end.
 
 
+%% @spec (User, Server, Password) -> {atomic, ok} | {atomic, exists} | {error, invalid_jid}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 try_register(User, Server, Password) ->
-    case jlib:nodeprep(User) of
-	error ->
-	    {error, invalid_jid};
-	LUser ->
-	    Username = ejabberd_odbc:escape(LUser),
-	    Pass = ejabberd_odbc:escape(Password),
-	    LServer = jlib:nameprep(Server),
-	    case catch odbc_queries:add_user(LServer, Username, Pass) of
-		{updated, 1} ->
-		    {atomic, ok};
-		_ ->
-		    {atomic, exists}
-	    end
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	Username = ejabberd_odbc:escape(LUser),
+	Pass = ejabberd_odbc:escape(Password),
+	LServer = exmpp_stringprep:nameprep(Server),
+	case catch odbc_queries:add_user(LServer, Username, Pass) of
+	    {updated, 1} ->
+		{atomic, ok};
+	    _ ->
+		{atomic, exists}
+	end
+    catch
+	_ ->
+	    {error, invalid_jid}
     end.
 
+%% @spec () -> [{LUser, LServer}]
+%%     LUser = string()
+%%     LServer = string()
+
 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).
+
+%% @spec (Server) -> [{LUser, LServer}]
+%%     Server = string()
+%%     LUser = string()
+%%     LServer = string()
 
 get_vh_registered_users(Server) ->
-    LServer = jlib:nameprep(Server),
+    LServer = exmpp_stringprep:nameprep(Server),
     case catch odbc_queries:list_users(LServer) of
 	{selected, ["username"], Res} ->
 	    [{U, LServer} || {U} <- Res];
@@ -141,8 +205,16 @@ get_vh_registered_users(Server) ->
 	    []
     end.
 
+%% @spec (Server, Opts) -> [{LUser, LServer}]
+%%     Server = string()
+%%     Opts = [{Opt, Val}]
+%%         Opt = atom()
+%%         Val = term()
+%%     LUser = string()
+%%     LServer = string()
+
 get_vh_registered_users(Server, Opts) ->
-    LServer = jlib:nameprep(Server),
+    LServer = exmpp_stringprep:nameprep(Server),
     case catch odbc_queries:list_users(LServer, Opts) of
 	{selected, ["username"], Res} ->
 	    [{U, LServer} || {U} <- Res];
@@ -150,8 +222,12 @@ get_vh_registered_users(Server, Opts) ->
 	    []
     end.
 
+%% @spec (Server) -> Users_Number
+%%     Server = string()
+%%     Users_Number = integer()
+
 get_vh_registered_users_number(Server) ->
-    LServer = jlib:nameprep(Server),
+    LServer = exmpp_stringprep:nameprep(Server),
     case catch odbc_queries:users_number(LServer) of
 	{selected, [_], [{Res}]} ->
 	    list_to_integer(Res);
@@ -159,8 +235,15 @@ get_vh_registered_users_number(Server) ->
 	    0
     end.
 
+%% @spec (Server, Opts) -> Users_Number
+%%     Server = string()
+%%     Opts = [{Opt, Val}]
+%%         Opt = atom()
+%%         Val = term()
+%%     Users_Number = integer()
+
 get_vh_registered_users_number(Server, Opts) ->
-    LServer = jlib:nameprep(Server),
+    LServer = exmpp_stringprep:nameprep(Server),
     case catch odbc_queries:users_number(LServer, Opts) of
 	{selected, [_], [{Res}]} ->
 	    list_to_integer(Res);
@@ -168,85 +251,118 @@ get_vh_registered_users_number(Server, Opts) ->
 	    0
     end.
 
+%% @spec (User, Server) -> Password | false
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 get_password(User, Server) ->
-    case jlib:nodeprep(User) of
-	error ->
-	    false;
-	LUser ->
-	    Username = ejabberd_odbc:escape(LUser),
-	    LServer = jlib:nameprep(Server),
-	    case catch odbc_queries:get_password(LServer, Username) of
-		{selected, ["password"], [{Password}]} ->
-		    Password;
-		_ ->
-		    false
-	    end
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	Username = ejabberd_odbc:escape(LUser),
+	LServer = exmpp_stringprep:nameprep(Server),
+	case catch odbc_queries:get_password(LServer, Username) of
+	    {selected, ["password"], [{Password}]} ->
+		Password;
+	    _ ->
+		false
+	end
+    catch
+	_ ->
+	    false
     end.
 
+%% @spec (User, Server) -> Password | nil()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 get_password_s(User, Server) ->
-    case jlib:nodeprep(User) of
-	error ->
-	    "";
-	LUser ->
-	    Username = ejabberd_odbc:escape(LUser),
-	    LServer = jlib:nameprep(Server),
-	    case catch odbc_queries:get_password(LServer, Username) of
-		{selected, ["password"], [{Password}]} ->
-		    Password;
-		_ ->
-		    ""
-	    end
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	Username = ejabberd_odbc:escape(LUser),
+	LServer = exmpp_stringprep:nameprep(Server),
+	case catch odbc_queries:get_password(LServer, Username) of
+	    {selected, ["password"], [{Password}]} ->
+		Password;
+	    _ ->
+		""
+	end
+    catch
+	_ ->
+	    ""
     end.
 
+%% @spec (User, Server) -> true | false | {error, Error}
+%%     User = string()
+%%     Server = string()
+
 is_user_exists(User, Server) ->
-    case jlib:nodeprep(User) of
-	error ->
-	    false;
-	LUser ->
-	    Username = ejabberd_odbc:escape(LUser),
-	    LServer = jlib:nameprep(Server),
-	    case catch odbc_queries:get_password(LServer, Username) of
-		{selected, ["password"], [{_Password}]} ->
-		    true;
-		_ ->
-		    false
-	    end
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	Username = ejabberd_odbc:escape(LUser),
+	LServer = exmpp_stringprep:nameprep(Server),
+	try odbc_queries:get_password(LServer, Username) of
+	    {selected, ["password"], [{_Password}]} ->
+		    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
+    catch
+	_ ->
+	    false
     end.
 
+%% @spec (User, Server) -> ok | error
+%%     User = string()
+%%     Server = string()
+%% @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),
-	    LServer = jlib:nameprep(Server),
-	    catch odbc_queries:del_user(LServer, Username),
-	    ejabberd_hooks:run(remove_user, jlib:nameprep(Server),
-			       [User, Server])
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	Username = ejabberd_odbc:escape(LUser),
+	LServer = exmpp_stringprep:nameprep(Server),
+	catch odbc_queries:del_user(LServer, Username),
+        ok
+    catch
+	_ ->
+	    error
     end.
 
+%% @spec (User, Server, Password) -> ok | error | not_exists | not_allowed
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%% @doc Remove user if the provided password is correct.
+
 remove_user(User, Server, Password) ->
-    case jlib:nodeprep(User) of
-	error ->
-	    error;
-	LUser ->
-	    Username = ejabberd_odbc:escape(LUser),
-	    Pass = ejabberd_odbc:escape(Password),
-	    LServer = jlib:nameprep(Server),
-	    F = fun() ->
-			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;
-			    _ ->
-				not_allowed
-			end
-		end,
-	    {atomic, Result} = odbc_queries:sql_transaction(LServer, F),
-	    Result
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	Username = ejabberd_odbc:escape(LUser),
+	Pass = ejabberd_odbc:escape(Password),
+	LServer = exmpp_stringprep:nameprep(Server),
+	F = fun() ->
+		    Result = odbc_queries:del_user_return_password(
+			       LServer, Username, Pass),
+		    case Result of
+			{selected, ["password"], [{Password}]} ->
+			    ok;
+			{selected, ["password"], []} ->
+			    not_exists;
+			_ ->
+			    not_allowed
+		    end
+	    end,
+	{atomic, Result} = odbc_queries:sql_transaction(LServer, F),
+	Result
+    catch
+	_ ->
+	    error
     end.

src/ejabberd_auth_pam.erl

@@ -5,7 +5,7 @@
 %%% Created : 5 Jul 2007 by Evgeniy Khramtsov <xram@jabber.ru>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -45,6 +45,10 @@
 %%====================================================================
 %% API
 %%====================================================================
+
+%% @spec (Host) -> ok | term()
+%%     Host = string()
+
 start(_Host) ->
     case epam:start() of
 	{ok, _} -> ok;
@@ -52,46 +56,112 @@ start(_Host) ->
 	Err -> Err
     end.
 
+%% @spec (User, Server, Password) -> {error, not_allowed}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 set_password(_User, _Server, _Password) ->
     {error, not_allowed}.
 
+%% @spec (User, Server, Password, Digest, DigestGen) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%%     Digest = string()
+%%     DigestGen = function()
+
 check_password(User, Server, Password, _StreamID, _Digest) ->
     check_password(User, Server, Password).
 
-check_password(User, Host, Password) ->
-    Service = get_pam_service(Host),
-    case catch epam:authenticate(Service, User, Password) of
+%% @spec (User, Server, Password) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
+check_password(User, Server, Password) ->
+    Service = get_pam_service(Server),
+    UserInfo = case get_pam_userinfotype(Server) of
+	username -> User;
+	jid -> User++"@"++Server
+    end,
+    case catch epam:authenticate(Service, UserInfo, Password) of
 	true -> true;
 	_    -> false
     end.
 
+%% @spec (User, Server, Password) -> {error, not_allowed}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 try_register(_User, _Server, _Password) ->
     {error, not_allowed}.
 
+%% @spec () -> [{LUser, LServer}]
+%%     LUser = string()
+%%     LServer = string()
+
 dirty_get_registered_users() ->
     [].
 
-get_vh_registered_users(_Host) ->
+%% @spec (Server) -> [{LUser, LServer}]
+%%     Server = string()
+%%     LUser = string()
+%%     LServer = string()
+
+get_vh_registered_users(_Server) ->
     [].
 
+%% @spec (User, Server) -> Password | false
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 get_password(_User, _Server) ->
     false.
 
+%% @spec (User, Server) -> Password | nil()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 get_password_s(_User, _Server) ->
     "".
 
-is_user_exists(User, Host) ->
-    Service = get_pam_service(Host),
-    case catch epam:acct_mgmt(Service, User) of
+%% @spec (User, Server) -> true | false | {error, Error}
+%%     User = string()
+%%     Server = string()
+%% TODO: Improve this function to return an error instead of 'false' when
+%% connection to PAM failed
+
+is_user_exists(User, Server) ->
+    Service = get_pam_service(Server),
+    UserInfo = case get_pam_userinfotype(Server) of
+	username -> User;
+	jid -> User++"@"++Server
+    end,
+    case catch epam:acct_mgmt(Service, UserInfo) of
 	true -> true;
 	_    -> false
     end.
 
+%% @spec (User, Server) -> {error, not_allowed}
+%%     User = string()
+%%     Server = string()
+
 remove_user(_User, _Server) ->
     {error, not_allowed}.
 
+%% @spec (User, Server, Password) -> not_allowed
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
 remove_user(_User, _Server, _Password) ->
-    {error, not_allowed}.
+    not_allowed.
+
+%% @spec () -> bool()
 
 plain_password_required() ->
     true.
@@ -99,8 +169,17 @@ plain_password_required() ->
 %%====================================================================
 %% Internal functions
 %%====================================================================
-get_pam_service(Host) ->
-    case ejabberd_config:get_local_option({pam_service, Host}) of
+
+%% @spec (Server) -> string()
+%%     Server = string()
+
+get_pam_service(Server) ->
+    case ejabberd_config:get_local_option({pam_service, Server}) 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_auth_storage.erl

@@ -0,0 +1,475 @@
+%%%----------------------------------------------------------------------
+%%% File    : ejabberd_auth_storage.erl
+%%% Author  : Alexey Shchepin <alexey@process-one.net>, Stephan Maka
+%%% Purpose : Authentification via gen_storage
+%%% 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
+%%%
+%%%----------------------------------------------------------------------
+
+%%% Database schema (version / storage / table)
+%%%
+%%% 2.1.x / mnesia / passwd
+%%%  us = {Username::string(), Host::string()}
+%%%  password = string()
+%%%
+%%% 2.1.x / odbc / users
+%%%  username = varchar250
+%%%  password = text
+%%%
+%%% 3.0.0-prealpha / mnesia / passwd
+%%%  Same as 2.1.x
+%%%
+%%% 3.0.0-prealpha / odbc / users
+%%%  Same as 2.1.x
+%%%
+%%% 3.0.0-alpha / mnesia / passwd
+%%%  user_host = {Username::string(), Host::string()}
+%%%  password = string()
+%%%
+%%% 3.0.0-alpha / odbc / passwd
+%%%  user = varchar150
+%%%  host = varchar150
+%%%  password = text
+
+-module(ejabberd_auth_storage).
+-author('alexey@process-one.net').
+
+%% 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_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,
+	 remove_user/2,
+	 remove_user/3,
+	 plain_password_required/0
+	]).
+
+-include("ejabberd.hrl").
+
+-record(passwd, {user_host, password}).
+-record(reg_users_counter, {vhost, count}).
+
+%%%----------------------------------------------------------------------
+%%% API
+%%%----------------------------------------------------------------------
+
+%% @spec (Host) -> ok
+%%     Host = string()
+
+start(Host) ->
+    Backend =
+	case ejabberd_config:get_local_option({auth_storage, Host}) of
+	    undefined -> mnesia;
+	    B -> B
+	end,
+    HostB = list_to_binary(Host),
+    gen_storage:create_table(Backend, HostB, passwd,
+			     [{odbc_host, Host},
+			      {disc_copies, [node()]},
+			      {attributes, record_info(fields, passwd)},
+			      {types, [{user_host, {text, text}}]}
+			     ]),
+    update_table(Host, Backend),
+    mnesia:create_table(reg_users_counter,
+			[{ram_copies, [node()]},
+			 {attributes, record_info(fields, reg_users_counter)}]),
+    update_reg_users_counter_table(Host),
+    ok.
+
+update_reg_users_counter_table(Server) ->
+    Set = get_vh_registered_users(Server),
+    Size = length(Set),
+    LServer = exmpp_jid:prep_domain(exmpp_jid:parse(Server)),
+    F = fun() ->
+        mnesia:write(#reg_users_counter{vhost = LServer,
+					count = Size})
+    end,
+    mnesia:sync_dirty(F).
+
+%% @spec () -> bool()
+
+plain_password_required() ->
+    false.
+
+%% @spec (User, Server, Password) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
+check_password(User, Server, Password) ->
+    LUser = exmpp_stringprep:nodeprep(User),
+    LServer = exmpp_stringprep:nameprep(Server),
+    US = {LUser, LServer},
+    case catch gen_storage:dirty_read(LServer, {passwd, US}) of
+	[#passwd{password = Password}] ->
+	    Password /= "";
+	_ ->
+	    false
+    end.
+
+%% @spec (User, Server, Password, Digest, DigestGen) -> bool()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%%     Digest = string()
+%%     DigestGen = function()
+
+check_password(User, Server, Password, Digest, DigestGen) ->
+    LUser = exmpp_stringprep:nodeprep(User),
+    LServer = exmpp_stringprep:nameprep(Server),
+    US = {LUser, LServer},
+    case catch gen_storage:dirty_read(LServer, {passwd, US}) of
+	[#passwd{password = Passwd}] ->
+	    DigRes = if
+			 Digest /= "" ->
+			     Digest == DigestGen(Passwd);
+			 true ->
+			     false
+		     end,
+	    if DigRes ->
+		    true;
+	       true ->
+		    (Passwd == Password) and (Password /= "")
+	    end;
+	_ ->
+	    false
+    end.
+
+%% @spec (User, Server, Password) -> ok | {error, invalid_jid}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
+set_password(User, Server, Password) ->
+    LUser = (catch exmpp_stringprep:nodeprep(User)),
+    LServer = (catch exmpp_stringprep:nameprep(Server)),
+    case {LUser, LServer} of
+	{{stringprep, _, invalid_string, _}, _} ->
+	    {error, invalid_jid};
+	{_, {stringprep, _, invalid_string, _}} ->
+	    {error, invalid_jid};
+	US ->
+	    %% TODO: why is this a transaction?
+	    F = fun() ->
+			gen_storage:write(LServer,
+					  #passwd{user_host = US,
+						  password = Password})
+		end,
+	    {atomic, ok} = gen_storage:transaction(LServer, passwd, F),
+	    ok
+    end.
+
+%% @spec (User, Server, Password) -> {atomic, ok} | {atomic, exists} | {error, invalid_jid} | {aborted, Reason}
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
+try_register(User, Server, Password) ->
+    LUser = (catch exmpp_stringprep:nodeprep(User)),
+    LServer = (catch exmpp_stringprep:nameprep(Server)),
+    case {LUser, LServer} of
+	{{stringprep, _, invalid_string, _}, _} ->
+	    {error, invalid_jid};
+	{_, {stringprep, _, invalid_string, _}} ->
+	    {error, invalid_jid};
+	US ->
+	    F = fun() ->
+			case gen_storage:read(LServer, {passwd, US}) of
+			    [] ->
+				gen_storage:write(LServer,
+						  #passwd{user_host = US,
+							  password = Password}),
+				mnesia:dirty_update_counter(
+						    reg_users_counter,
+						    exmpp_jid:prep_domain(exmpp_jid:parse(Server)), 1),
+				ok;
+			    [_E] ->
+				exists
+			end
+		end,
+	    %% TODO: transaction return value?
+	    gen_storage:transaction(LServer, passwd, F)
+    end.
+
+%% @spec () -> [{LUser, LServer}]
+%%     LUser = string()
+%%     LServer = string()
+%% @doc Get all registered users in Mnesia.
+
+dirty_get_registered_users() ->
+    %% TODO:
+    exit(not_implemented).
+
+%% @spec (Server) -> [{LUser, LServer}]
+%%     Server = string()
+%%     LUser = string()
+%%     LServer = string()
+
+get_vh_registered_users(Server) ->
+    LServer = exmpp_stringprep:nameprep(Server),
+    lists:map(fun(#passwd{user_host = US}) ->
+		      US
+	      end,
+	      gen_storage:dirty_select(LServer, passwd,
+				       [{'=', user_host, {'_', LServer}}])).
+
+%% @spec (Server, Opts) -> [{LUser, LServer}]
+%%     Server = string()
+%%     Opts = [{Opt, Val}]
+%%         Opt = atom()
+%%         Val = term()
+%%     LUser = string()
+%%     LServer = string()
+%% @doc Return the registered users for the specified host.
+%%
+%% `Opts' can be one of the following:
+%% <ul>
+%% <li>`[{from, integer()}, {to, integer()}]'</li>
+%% <li>`[{limit, integer()}, {offset, integer()}]'</li>
+%% <li>`[{prefix, string()}]'</li>
+%% <li>`[{prefix, string()}, {from, integer()}, {to, integer()}]'</li>
+%% <li>`[{prefix, string()}, {limit, integer()}, {offset, integer()}]'</li>
+%% </ul>
+
+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).
+
+%% @spec (Server) -> Users_Number
+%%     Server = string()
+%%     Users_Number = integer()
+
+get_vh_registered_users_number(Server) ->
+    LServer = exmpp_jid:prep_domain(exmpp_jid:parse(Server)),
+    Query = mnesia:dirty_select(
+		reg_users_counter,
+		[{#reg_users_counter{vhost = LServer, count = '$1'},
+		  [],
+		  ['$1']}]),
+    case Query of
+	[Count] ->
+	    Count;
+	_ -> 0
+    end.
+
+%% @spec (Server, [{prefix, Prefix}]) -> Users_Number
+%%     Server = string()
+%%     Prefix = string()
+%%     Users_Number = integer()
+
+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).
+
+%% @spec (User, Server) -> Password | false
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
+get_password(User, Server) ->
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	LServer = exmpp_stringprep:nameprep(Server),
+	US = {LUser, LServer},
+        case catch gen_storage:dirty_read(LServer, passwd, US) of
+	    [#passwd{password = Password}] ->
+		Password;
+	    _ ->
+		false
+	end
+    catch
+	_ ->
+	    false
+    end.
+
+%% @spec (User, Server) -> Password | nil()
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+
+get_password_s(User, Server) ->
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	LServer = exmpp_stringprep:nameprep(Server),
+	US = {LUser, LServer},
+        case catch gen_storage:dirty_read(LServer, passwd, US) of
+	    [#passwd{password = Password}] ->
+		Password;
+	    _ ->
+		[]
+	end
+    catch
+	_ ->
+	    []
+    end.
+
+%% @spec (User, Server) -> true | false | {error, Error}
+%%     User = string()
+%%     Server = string()
+
+is_user_exists(User, Server) ->
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	LServer = exmpp_stringprep:nameprep(Server),
+	US = {LUser, LServer},
+        case catch gen_storage:dirty_read(LServer, {passwd, US}) of
+	    [] ->
+		false;
+	    [_] ->
+		true;
+	    Other ->
+		{error, Other}
+	end
+    catch
+	_ ->
+	    false
+    end.
+
+%% @spec (User, Server) -> ok
+%%     User = string()
+%%     Server = string()
+%% @doc Remove user.
+%% Note: it returns ok even if there was some problem removing the user.
+
+remove_user(User, Server) ->
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	LServer = exmpp_stringprep:nameprep(Server),
+	US = {LUser, LServer},
+	F = fun() ->
+		    gen_storage:delete(LServer, {passwd, US}),
+		    mnesia:dirty_update_counter(reg_users_counter,
+						exmpp_jid:prep_domain(exmpp_jid:parse(Server)), -1)
+	    end,
+        gen_storage:transaction(LServer, passwd, F),
+	ok
+    catch
+	_ ->
+	    ok
+    end.
+
+%% @spec (User, Server, Password) -> ok | not_exists | not_allowed | bad_request
+%%     User = string()
+%%     Server = string()
+%%     Password = string()
+%% @doc Remove user if the provided password is correct.
+
+remove_user(User, Server, Password) ->
+    try
+	LUser = exmpp_stringprep:nodeprep(User),
+	LServer = exmpp_stringprep:nameprep(Server),
+	US = {LUser, LServer},
+	F = fun() ->
+		    case gen_storage:read(LServer, {passwd, US}) of
+			[#passwd{password = Password}] ->
+			    gen_storage:delete(LServer, {passwd, US}),
+			    mnesia:dirty_update_counter(reg_users_counter,
+							exmpp_jid:prep_domain(exmpp_jid:parse(Server)), -1),
+			    ok;
+			[_] ->
+			    not_allowed;
+			_ ->
+			    not_exists
+		    end
+	    end,
+        case gen_storage:transaction(LServer, passwd, F) of
+	    {atomic, ok} ->
+		ok;
+	    {atomic, Res} ->
+		Res;
+	    _ ->
+		bad_request
+	end
+    catch
+	_ ->
+	    bad_request
+    end.
+
+update_table(Host, mnesia) ->
+    gen_storage_migration:migrate_mnesia(
+      Host, passwd,
+      [{passwd, [us, password],
+	fun({passwd, {User, _Host}, Password}) ->
+		#passwd{user_host = {User, Host},
+			password = Password}
+	end}]);
+update_table(Host, odbc) ->
+    gen_storage_migration:migrate_odbc(
+      Host, [passwd],
+      [{"users", ["username", "password"],
+	fun(_, User, Password) ->
+		#passwd{user_host = {User, Host},
+			password = Password}
+	end}]).

src/ejabberd_c2s_config.erl

@@ -6,7 +6,7 @@
 %%% Created :  2 Nov 2007 by Mickael Remond <mremond@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -17,7 +17,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA

src/ejabberd_captcha.erl

@@ -0,0 +1,670 @@
+%%%-------------------------------------------------------------------
+%%% 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/5, build_captcha_html/2, check_captcha/2,
+	 process_reply/1, process/2, is_feature_available/0]).
+
+-include_lib("exmpp/include/exmpp.hrl").
+
+-include("jlib.hrl").
+-include("ejabberd.hrl").
+-include("web/ejabberd_http.hrl").
+
+-define(VFIELD(Type, Var, Value),
+  #xmlel{name = 'field',
+         attrs = [
+           #xmlattr{
+             name = 'type',
+             value = Type
+           },
+           #xmlattr{
+             name = 'var',
+             value = Var
+           }
+         ],
+         children = [
+           #xmlel{
+             name = 'value',
+             children = [Value]
+           }
+         ]}).
+
+-define(CAPTCHA_TEXT(Lang), translate:translate(Lang, "Enter the text you see")).
+-define(CAPTCHA_LIFETIME, 120000). % two minutes
+-define(RPC_TIMEOUT, 5000).
+
+-record(state, {}).
+-record(captcha, {id, pid, key, tref, args}).
+
+%%====================================================================
+%% API
+%%====================================================================
+%%--------------------------------------------------------------------
+%% Function: start_link() -> {ok,Pid} | ignore | {error,Error}
+%% Description: Starts the server
+%%--------------------------------------------------------------------
+start_link() ->
+    gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
+
+create_captcha(SID, From, To, Lang, Args)
+  when is_binary(Lang), is_list(SID) ->
+    case create_image() of
+	{ok, Type, Key, Image} ->
+	    Id = randoms:get_string() ++ "-" ++ ejabberd_cluster:node_id(),
+	    B64Image = jlib:encode_base64(binary_to_list(Image)),
+	    JID = exmpp_jid:to_list(From),
+	    CID = "sha1+" ++ sha:sha(Image) ++ "@bob.xmpp.org",
+%	    Data = {xmlelement, "data",
+%		    [{"xmlns", ?NS_BOB}, {"cid", CID},
+%		     {"max-age", "0"}, {"type", Type}],
+%		    [{xmlcdata, B64Image}]},
+	    Data =
+	      #xmlel{
+	        name = 'data',
+	        ns = ?NS_BOB,
+	        attrs = [
+	          #xmlattr{
+	            name = 'cid',
+	            value = CID
+	          },
+	          #xmlattr{
+	            name = 'max-age',
+	            value = "0"
+	          },
+	          #xmlattr{
+	            name = 'type',
+	            value = Type	                    
+	          }
+	        ],
+	        children = [#xmlcdata{cdata = B64Image}]},
+%		{xmlelement, "captcha", [{"xmlns", ?NS_CAPTCHA}],
+%		 %% ?NS_DATA_FORMS is 'jabber:x:data'
+%		 [{xmlelement, "x", [{"xmlns", "jabber:x:data"}, {"type", "form"}],
+%		   [?VFIELD("hidden", "FORM_TYPE", {xmlcdata, ?NS_CAPTCHA}),
+%		    ?VFIELD("hidden", "from", {xmlcdata, exmpp_jid:to_list(To)}),
+%		    ?VFIELD("hidden", "challenge", {xmlcdata, Id}),
+%		    ?VFIELD("hidden", "sid", {xmlcdata, SID}),
+%		    {xmlelement, "field", [{"var", "ocr"}, {"label", ?CAPTCHA_TEXT(Lang)}],
+%		     [{xmlelement, "media", [{"xmlns", ?NS_DATA_FORMS_MEDIA_s}],
+%		       [{xmlelement, "uri", [{"type", Type}],
+%			 [{xmlcdata, "cid:" ++ CID}]}]}]}]}]},
+%% TODO : kael : write exmpp_captcha.erl
+	    Captcha =
+	  #xmlel{
+	    name = 'captcha',
+	    ns = ?NS_CAPTCHA,
+	    children = [
+	      #xmlel{
+	        name = 'x',
+	        ns = ?NS_DATA_FORMS_s,
+	        attrs = [
+	          #xmlattr{
+	            name = 'type',
+	            value = "form"	                      
+	          }
+	        ],
+	        children = [
+	          ?VFIELD("hidden", "FORM_TYPE", #xmlcdata{cdata = ?NS_CAPTCHA}),
+	          ?VFIELD("hidden", "from", #xmlcdata{cdata = exmpp_jid:to_list(To)}),
+	          ?VFIELD("hidden", "challenge", #xmlcdata{cdata = Id}),
+	          ?VFIELD("hidden", "sid", #xmlcdata{cdata = SID}),
+	          #xmlel{
+	            name = 'field',
+	            attrs = [
+	              #xmlattr{
+	                name = 'var',
+	                value = "ocr"
+	              },
+	              #xmlattr{
+	                name = 'label',
+	                value = ?CAPTCHA_TEXT(Lang)
+	              }	                      
+	            ],
+	            children = [
+	              #xmlel{
+	                name = 'media',
+	                ns = ?NS_DATA_FORMS_MEDIA_s,
+	                children = [
+	                  #xmlel{
+	                    name = 'uri',
+	                    attrs = [
+	                      #xmlattr{
+	                        name = 'type',
+	                        value = Type
+	                      }
+	                    ],
+	                    children = [
+	                      #xmlcdata{cdata = "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 =
+        #xmlel{
+          name = 'body',
+          children = [
+            #xmlcdata{
+              cdata = BodyString
+            }
+          ]
+        },
+      OOB =
+        #xmlel{
+          name = 'x',
+          ns = ?NS_OOBD_X_s,
+          children = [
+            #xmlel{
+              name = 'url',
+              children = [
+                #xmlcdata{
+                  cdata = get_url(Id)}
+              ]
+            }
+          ]
+        },
+	    %Body = {xmlelement, "body", [],
+		  %  [{xmlcdata, BodyString}]},
+	    %OOB = {xmlelement, "x", [{"xmlns", ?NS_OOBD_X_s}],
+		  % [{xmlelement, "url", [], [{xmlcdata, get_url(Id)}]}]},
+	    Tref = erlang:send_after(?CAPTCHA_LIFETIME, ?MODULE, {remove_id, Id}),
+	    ets:insert(captcha, #captcha{id=Id, pid=self(), key=Key,
+					 tref=Tref, args=Args}),
+	    {ok, Id, [Body, OOB, Captcha, Data]};
+	_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 lookup_captcha(Id) of
+	{ok, _} ->
+	    %ImgEl = {xmlelement, "img", [{"src", get_url(Id ++ "/image")}], []},
+	    ImgEl =
+	      #xmlel{
+	        name = 'img',
+          attrs = [
+            #xmlattr{
+              name = 'src',
+              value = get_url(Id ++ "/image")
+            }
+          ]
+        },
+	    %TextEl = {xmlcdata, ?CAPTCHA_TEXT(Lang)},
+	    TextEl = #xmlcdata{cdata = ?CAPTCHA_TEXT(Lang)},
+	    %IdEl = {xmlelement, "input", [{"type", "hidden"},
+			%		  {"name", "id"},
+			%		  {"value", Id}], []},
+	    IdEl = 
+	      #xmlel{
+	        name = 'input',
+	        attrs = [
+	          #xmlattr{
+	            name = 'type',
+	            value = "hidden"
+	          },
+	          #xmlattr{
+	            name = 'name',
+	            value = "id"
+	          },
+	          #xmlattr{
+	            name = 'value',
+	            value = Id
+	          }
+	        ]
+	      },
+	    %KeyEl = {xmlelement, "input", [{"type", "text"},
+			%		   {"name", "key"},
+			%		   {"size", "10"}], []},
+			KeyEl =
+			  #xmlel{
+			    name = 'input',
+			    attrs = [
+			      #xmlattr{
+			        name = 'type',
+			        value = "text"
+			      },
+			      #xmlattr{
+			        name = 'name',
+			        value = "key"
+			      },
+			      #xmlattr{
+			        name = 'size',
+			        value = "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 = 
+			  #xmlel{
+			    name = 'form',
+			    attrs = [
+			      #xmlattr{
+			        name = 'action',
+			        value = get_url(Id)
+			      },
+			      #xmlattr{
+			        name = 'name',
+			        value = "captcha"
+			      },
+			      #xmlattr{
+			        name = 'method',
+			        value = "POST"
+			      }
+			    ],
+			    children = [
+			      ImgEl,
+			      #xmlel{
+			        name = 'br'
+			      },
+			      TextEl,
+			      #xmlel{
+			        name = 'br'
+			      },
+			      IdEl,
+			      KeyEl,
+			      #xmlel{
+			        name = 'br'
+			      },
+			      #xmlel{
+			        name = 'input',
+			        attrs = [
+			          #xmlattr{
+			            name = 'type',
+			            value = "submit"
+			          },
+			          #xmlattr{
+			            name = 'name',
+			            value = "enter"
+			          },
+			          #xmlattr{
+			            name = 'value',
+			            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) ->
+    case string:tokens(Id, "-") of
+	[_, NodeID] ->
+	    case ejabberd_cluster:get_node_by_id(NodeID) of
+		Node when Node == node() ->
+		    do_check_captcha(Id, ProvidedKey);
+		Node ->
+		    case catch rpc:call(Node, ?MODULE, check_captcha,
+					[Id, ProvidedKey], ?RPC_TIMEOUT) of
+			{'EXIT', _} ->
+			    captcha_not_found;
+			{badrpc, _} ->
+			    captcha_not_found;
+			Res ->
+			    Res
+		    end
+	    end;
+	_ ->
+	    captcha_not_found
+    end.
+
+process_reply(El) ->
+    case {exmpp_xml:element_matches(El, captcha),
+	  exmpp_xml:get_element(El, x)} of
+	{false, _} ->
+	    {error, malformed};
+	{_, undefined} ->
+	    {error, malformed};
+	{true, Xdata} ->
+	    Fields = jlib:parse_xdata_submit(Xdata),
+	    case {proplists:get_value("challenge", Fields),
+		  proplists:get_value("ocr", Fields)} of
+		{[Id|_], [OCR|_]} ->
+		    case check_captcha(Id, OCR) of
+			captcha_valid ->
+			    ok;
+			captcha_non_valid ->
+			    {error, bad_match};
+			captcha_not_found ->
+			    {error, not_found}
+		    end;
+		_ ->
+		    {error, malformed}
+	    end
+    end.
+
+
+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]},
+	  #xmlel{
+	    name = 'div',
+	    attrs = [
+	      #xmlattr{
+	        name = 'align',
+	        value = "center"
+	      }
+	    ],
+	    children = [FormEl]
+	  },
+	    ejabberd_web:make_xhtml([Form]);
+	captcha_not_found ->
+	    ejabberd_web:error(not_found)
+    end;
+
+process(_Handlers, #request{method='GET', path=[_, Id, "image"]}) ->
+    case lookup_captcha(Id) of
+	{ok, #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.")
+		%  }]},
+	  #xmlel{
+	    name = 'p',
+	    children = [
+	      #xmlcdata{
+	        cdata = 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:delete_table(captcha),
+    ets:new(captcha, [named_table, public, {keypos, #captcha.id}]),
+    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]),
+    case ets:lookup(captcha, Id) of
+	[#captcha{args=Args, pid=Pid}] ->
+	    Pid ! {captcha_failed, Args},
+	    ets: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.
+
+lookup_captcha(Id) ->
+    case string:tokens(Id, "-") of
+	[_, NodeID] ->
+	    case ejabberd_cluster:get_node_by_id(NodeID) of
+		Node when Node == node() ->
+		    case ets:lookup(captcha, Id) of
+			[C] ->
+			    {ok, C};
+			_ ->
+			    {error, enoent}
+		    end;
+		Node ->
+		    case catch rpc:call(Node, ets, lookup,
+					[captcha, Id], ?RPC_TIMEOUT) of
+			[C] ->
+			    {ok, C};
+			_ ->
+			    {error, enoent}
+		    end
+	    end;
+	_ ->
+	    {error, enoent}
+    end.
+
+do_check_captcha(Id, ProvidedKey) ->
+    case ets:lookup(captcha, Id) of
+	[#captcha{pid = Pid, args = Args, key = ValidKey, tref = Tref}] ->
+	    ets:delete(captcha, Id),
+	    erlang:cancel_timer(Tref),
+	    if ValidKey == ProvidedKey ->
+		    Pid ! {captcha_succeed, Args},
+		    captcha_valid;
+	       true ->
+		    Pid ! {captcha_failed, Args},
+		    captcha_non_valid
+	    end;
+	_ ->
+	    captcha_not_found
+    end.

src/ejabberd_check.erl

@@ -0,0 +1,114 @@
+%%%----------------------------------------------------------------------
+%%% 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(host) ->
+    ok;
+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_cluster.erl

@@ -0,0 +1,177 @@
+%%%-------------------------------------------------------------------
+%%% File    : ejabberd_cluster.erl
+%%% Author  : Evgeniy Khramtsov <ekhramtsov@process-one.net>
+%%% Description : 
+%%%
+%%% Created :  2 Apr 2010 by Evgeniy Khramtsov <ekhramtsov@process-one.net>
+%%%-------------------------------------------------------------------
+-module(ejabberd_cluster).
+
+-behaviour(gen_server).
+
+%% API
+-export([start_link/0, get_node/1, get_node_new/1, announce/0,
+	 node_id/0, get_node_by_id/1, get_nodes/0, rehash_timeout/0]).
+
+%% gen_server callbacks
+-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
+	 terminate/2, code_change/3]).
+
+-include("ejabberd.hrl").
+
+-define(HASHTBL, nodes_hash).
+-define(HASHTBL_NEW, nodes_hash_new).
+-define(POINTS, 16).
+-define(REHASH_TIMEOUT, 5000).
+
+-record(state, {}).
+
+%%====================================================================
+%% API
+%%====================================================================
+start_link() ->
+    gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
+
+get_node(Key) ->
+    Hash = erlang:phash2(Key),
+    get_node_by_hash(?HASHTBL, Hash).
+
+get_node_new(Key) ->
+    Hash = erlang:phash2(Key),
+    get_node_by_hash(?HASHTBL_NEW, Hash).
+
+get_nodes() ->
+    %% TODO
+    mnesia:system_info(running_db_nodes).
+
+announce() ->
+    gen_server:call(?MODULE, announce, infinity).
+
+node_id() ->
+    integer_to_list(erlang:phash2(node())).
+
+rehash_timeout() ->
+    ?REHASH_TIMEOUT.
+
+get_node_by_id(NodeID) when is_list(NodeID) ->
+    case catch list_to_existing_atom(NodeID) of
+	{'EXIT', _} ->
+	    node();
+	Res ->
+	    get_node_by_id(Res)
+    end;
+get_node_by_id(NodeID) ->
+    case global:whereis_name(NodeID) of
+	Pid when is_pid(Pid) ->
+	    node(Pid);
+	_ ->
+	    node()
+    end.
+
+%%====================================================================
+%% gen_server callbacks
+%%====================================================================
+init([]) ->
+    net_kernel:monitor_nodes(true, [{node_type, visible}]),
+    ets:new(?HASHTBL, [named_table, public, ordered_set]),
+    ets:new(?HASHTBL_NEW, [named_table, public, ordered_set]),
+    register_node(),
+    AllNodes = mnesia:system_info(running_db_nodes),
+    OtherNodes = case AllNodes of
+		     [_] ->
+			 AllNodes;
+		     _ ->
+			 AllNodes -- [node()]
+		 end,
+    append_nodes(?HASHTBL, OtherNodes),
+    append_nodes(?HASHTBL_NEW, AllNodes),
+    {ok, #state{}}.
+
+handle_call(announce, _From, State) ->
+    case mnesia:system_info(running_db_nodes) of
+	[_MyNode] ->
+	    ok;
+	Nodes ->
+	    OtherNodes = Nodes -- [node()],
+	    lists:foreach(
+	      fun(Node) ->
+		      {?MODULE, Node} ! {node_ready, node()}
+	      end, OtherNodes),
+	    ?INFO_MSG("waiting for migration from nodes: ~w",
+		      [OtherNodes]),
+	    timer:sleep(?REHASH_TIMEOUT),
+	    append_node(?HASHTBL, node())
+    end,
+    {reply, ok, State};
+handle_call(_Request, _From, State) ->
+    Reply = ok,
+    {reply, Reply, State}.
+
+handle_cast(_Msg, State) ->
+    {noreply, State}.
+
+handle_info({node_ready, Node}, State) ->
+    ?INFO_MSG("node ~p is ready, starting migration", [Node]),
+    append_node(?HASHTBL_NEW, Node),
+    ejabberd_hooks:run(node_hash_update, [?REHASH_TIMEOUT]),
+    timer:sleep(?REHASH_TIMEOUT),
+    ?INFO_MSG("adding node ~p to hash", [Node]),
+    append_node(?HASHTBL, Node),
+    {noreply, State};
+handle_info({nodedown, Node, _}, State) ->
+    ?INFO_MSG("node ~p goes down", [Node]),
+    delete_node(?HASHTBL, Node),
+    delete_node(?HASHTBL_NEW, Node),
+    {noreply, State};
+handle_info(_Info, State) ->
+    {noreply, State}.
+
+terminate(_Reason, _State) ->
+    ok.
+
+code_change(_OldVsn, State, _Extra) ->
+    {ok, State}.
+
+%%--------------------------------------------------------------------
+%% Internal functions
+%%--------------------------------------------------------------------
+append_nodes(Tab, Nodes) ->
+    lists:foreach(
+      fun(Node) ->
+	      append_node(Tab, Node)
+      end, Nodes).
+
+append_node(Tab, Node) ->
+    lists:foreach(
+      fun(I) ->
+	      Hash = erlang:phash2({I, Node}),
+	      ets:insert(Tab, {Hash, Node})
+      end, lists:seq(1, ?POINTS)).
+
+delete_node(Tab, Node) ->
+    lists:foreach(
+      fun(I) ->
+	      Hash = erlang:phash2({I, Node}),
+	      ets:delete(Tab, Hash)
+      end, lists:seq(1, ?POINTS)).
+
+get_node_by_hash(Tab, Hash) ->
+    NodeHash = case ets:next(Tab, Hash) of
+		   '$end_of_table' ->
+		       ets:first(Tab);
+		   NH ->
+		       NH
+	       end,
+    if NodeHash == '$end_of_table' ->
+	    erlang:error(no_running_nodes);
+       true ->
+	    case ets:lookup(Tab, NodeHash) of
+		[] ->
+		    get_node_by_hash(Tab, Hash);
+		[{_, Node}] ->
+		    Node
+	    end
+    end.
+
+register_node() ->
+    global:register_name(list_to_atom(node_id()), self()).

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, exmpp_jid:make(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

@@ -5,7 +5,7 @@
 %%% Created : 14 Dec 2002 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -27,12 +27,40 @@
 -module(ejabberd_config).
 -author('alexey@process-one.net').
 
--export([start/0, load_file/1,
+-export([start/0, load_file/1, get_host_option/2,
 	 add_global_option/2, add_local_option/2,
+         mne_add_local_option/2, mne_del_local_option/1,
+	 del_global_option/1, del_local_option/1,
 	 get_global_option/1, get_local_option/1]).
 
+-export([for_host/1
+         ,configure_host/2
+         ,delete_host/1
+        ]).
+
+-export([search/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").
+-include_lib("stdlib/include/ms_transform.hrl").
+
+-record(state, {opts = [],
+		hosts = [],
+		override_local = false,
+		override_global = false,
+		override_acls = false}).
+
+%% @type macro() = {macro_key(), macro_value()}
+
+%% @type macro_key() = atom().
+%% The atom must have all characters in uppercase.
+
+%% @type macro_value() = term().
+
 
 start() ->
     mnesia:create_table(config,
@@ -44,30 +72,76 @@ 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 ++ ": " ++ 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} ->
@@ -93,7 +167,16 @@ search_hosts(Term, State) ->
     end.
 
 add_hosts_to_option(Hosts, State) ->
-    PrepHosts = normalize_hosts(Hosts),
+    PrepHosts1 = normalize_hosts(Hosts),
+    PrepHosts = ensure_localhost_is_first(PrepHosts1),
+    mnesia:transaction(
+      fun() ->
+	      lists:foreach(
+		fun(H) ->
+			mnesia:write(#local_config{key = {H, host},
+						   value = []})
+		end, PrepHosts)
+      end),
     add_option(hosts, PrepHosts, State#state{hosts = PrepHosts}).
 
 normalize_hosts(Hosts) ->
@@ -101,15 +184,213 @@ normalize_hosts(Hosts) ->
 normalize_hosts([], PrepHosts) ->
     lists:reverse(PrepHosts);
 normalize_hosts([Host|Hosts], PrepHosts) ->
-    case jlib:nodeprep(Host) of
-	error ->
+    try
+	PrepHost = exmpp_stringprep:nodeprep(Host),
+	normalize_hosts(Hosts, [PrepHost|PrepHosts])
+    catch
+	_ ->
 	    ?ERROR_MSG("Can't load config file: "
 		       "invalid host name [~p]", [Host]),
-	    exit("invalid hostname");
-	PrepHost ->
-	    normalize_hosts(Hosts, [PrepHost|PrepHosts])
+	    exit("invalid hostname")
     end.
 
+ensure_localhost_is_first(["localhost" | _] = Hosts) ->
+    Hosts;
+ensure_localhost_is_first(Hosts) ->
+    case lists:member("localhost", Hosts) of
+	true ->
+	    ["localhost" | lists:delete("localhost", Hosts)];
+	false ->
+	    ?INFO_MSG("ejabberd added the default virtual host \"localhost\""
+		      " to the list of hosts.", []),
+	    ["localhost" | Hosts]
+    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 ->
@@ -133,18 +414,46 @@ process_term(Term, 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);
+	{clusterid, ClusterID} ->
+	    add_option(clusterid, ClusterID, 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);
+ 	{outgoing_s2s_local_address, Addr} ->
+ 	    add_option(outgoing_s2s_local_address, Addr, 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);
+	    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} ->
@@ -155,12 +464,23 @@ process_term(Term, State) ->
 	    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);
+	{ejabberdctl_access_commands, ACs} ->
+	    add_option(ejabberdctl_access_commands, ACs, State);
+	{captcha_cmd, Cmd} ->
+	    add_option(captcha_cmd, Cmd, State);
+	{captcha_host, Host} ->
+	    add_option(captcha_host, Host, 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)
+	    process_host_term(Term, global, State)
     end.
 
 process_host_term(Term, Host, State) ->
@@ -181,8 +501,16 @@ process_host_term(Term, Host, State) ->
 	{hosts, _Hosts} ->
 	    State;
 	{odbc_server, ODBC_server} ->
-	    odbc_modules_found = check_odbc_modules(ODBC_server),
 	    add_option({odbc_server, Host}, ODBC_server, State);
+	{auth_method, Methods} ->
+	    {Methods2, StorageOption} = replace_storage_auth(Host, Methods),
+	    State2 = case StorageOption of
+		{auth_storage, Storage} ->
+		    add_option({auth_storage, Host}, Storage, State);
+		undefined -> 
+		    State
+	    end,
+	    add_option({auth_method, Host}, Methods2, State2);
 	{Opt, Val} ->
 	    add_option({Opt, Host}, Val, State)
     end.
@@ -211,11 +539,16 @@ add_option(Opt, Val, State) ->
 	    end
     end.
 
-compact(Opt, Val, [], Os) ->
+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 O#local_config.key of
+    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;
@@ -281,20 +614,47 @@ add_global_option(Opt, Val) ->
 		       end).
 
 add_local_option(Opt, Val) ->
+    mnesia:transaction(fun mne_add_local_option/2, [Opt, Val]).
+
+mne_add_local_option(Opt, Val) ->
+    mnesia:write(#local_config{key = Opt,
+                               value = Val}).
+
+del_global_option(Opt) ->
     mnesia:transaction(fun() ->
-			       mnesia:write(#local_config{key = Opt,
-							  value = Val})
+			       mnesia:delete({config, Opt})
+		       end).
+
+del_local_option(Opt) ->
+    mnesia:transaction(fun() ->
+			       mnesia:delete({local_config, Opt})
 		       end).
 
 
+get_global_option({Opt1, Host} = Opt) when is_list(Host) ->
+    case ets:lookup(config, Opt) of
+	[#config{value = Val}] ->
+	    Val;
+	_ ->
+	    get_global_option({Opt1, global})
+    end;
 get_global_option(Opt) ->
     case ets:lookup(config, Opt) of
+	[#config{value = Val}] when Opt == hosts ->
+	    ensure_localhost_is_first(Val);
 	[#config{value = Val}] ->
 	    Val;
 	_ ->
 	    undefined
     end.
 
+get_local_option({Opt1, Host} = Opt) when is_list(Host) ->
+    case ets:lookup(local_config, Opt) of
+	[#local_config{value = Val}] ->
+	    Val;
+	_ ->
+	    get_local_option({Opt1, global})
+    end;
 get_local_option(Opt) ->
     case ets:lookup(local_config, Opt) of
 	[#local_config{value = Val}] ->
@@ -303,33 +663,115 @@ get_local_option(Opt) ->
 	    undefined
     end.
 
-
-check_odbc_modules(ODBC_server) ->
-    case catch check_odbc_modules2(ODBC_server) of
-	{'EXIT', {undef, [{Module, module_info, []} | _]}} ->
-	    ?CRITICAL_MSG("ejabberd is configured to use ODBC, but the Erlang module '~p' is not installed.", [Module]),
-	    odbc_module_not_found;
-	_ -> odbc_modules_found
+get_host_option(Host, Option) ->
+    case ets:lookup(local_config, {Option, Host}) of
+        [#local_config{value=V}] -> V;
+        _ -> undefined
     end.
 
-check_odbc_modules2(ODBC_server) ->
-    check_modules_exists([ejabberd_odbc, ejabberd_odbc_sup, odbc_queries]),
-    case ODBC_server of
-	{mysql, _Server, _DB, _Username, _Password} ->
-	    check_modules_exists([mysql, mysql_auth, mysql_conn, mysql_recv]);
+mne_del_local_option({_OptName, Host} = Opt) when is_list(Host) ->
+    mnesia:delete({local_config, Opt});
+mne_del_local_option({Host, host} = Opt) when is_list(Host) ->
+    mnesia:delete({local_config, Opt}).
 
-	{mysql, _Server, _Port, _DB, _Username, _Password} ->
-	    check_modules_exists([mysql, mysql_auth, mysql_conn, mysql_recv]);
+%% 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']}]).
 
-	{pgsql, _Server, _DB, _Username, _Password} ->
-	    check_modules_exists([pgsql, pgsql_proto, pgsql_tcp, pgsql_util]);
-
-	{pgsql, _Server, _Port, _DB, _Username, _Password} ->
-	    check_modules_exists([pgsql, pgsql_proto, pgsql_tcp, pgsql_util]);
-
-	Server when is_list(Server) ->
-	    ok
+%% @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.
 
-check_modules_exists(Modules) ->
-    [true = is_list(Module:module_info()) || Module <- Modules].
+search(Pattern) ->
+    {atomic, Res} = mnesia:transaction(fun mnesia:select/2, [local_config, Pattern]),
+    Res.
+
+for_host(Host) ->
+    mnesia:read({local_config, {Host, host}})
+        ++ mnesia:select(local_config,
+                  ets:fun2ms(fun (#local_config{key={_, H}})
+                                 when H =:= Host ->
+                                     object()
+                             end))
+        ++ acl:for_host(Host).
+
+delete_host(Host) ->
+    mnesia_delete_objects(for_host(Host)),
+    ok.
+
+configure_host(Host, Config) ->
+    HostExistenceTerm = {{Host, host}, []},
+    Records = host_terms_to_records(Host, [HostExistenceTerm | Config]),
+    mnesia_write_objects(Records),
+    ok.
+
+host_terms_to_records(Host, Terms) ->
+    lists:foldl(fun (Term, Acc) ->
+                        host_term_to_record(Term, Host, Acc)
+                end, [], Terms).
+
+host_term_to_record({acl, ACLName, ACLData}, Host, Acc) ->
+    [acl:to_record(Host, ACLName, ACLData) | Acc];
+host_term_to_record({access, RuleName, Rules}, Host, Acc) ->
+    [#config{key={access, RuleName, Host}, value=Rules} | Acc];
+host_term_to_record({shaper, Name, Data}, Host, Acc) ->
+    [#config{key={shaper, Name, Host}, value=Data} | Acc];
+host_term_to_record({host, _}, _Host, Acc) -> Acc;
+host_term_to_record({hosts, _}, _Host, Acc) -> Acc;
+host_term_to_record({{Host, host}, []}, Host, Acc) ->
+    [#local_config{key={Host, host}, value=[]} | Acc];
+host_term_to_record({Opt, Val}, Host, Acc) when is_atom(Opt) ->
+    [#local_config{key={Opt, Host}, value=Val} | Acc].
+
+    
+mnesia_delete_objects(List) when is_list(List) ->
+    true = lists:all(fun (I) ->
+                             ok =:= mnesia:delete_object(I)
+                     end, List).
+mnesia_write_objects(List) when is_list(List) ->
+    true = lists:all(fun (I) ->
+                             ok =:= mnesia:write(I)
+                     end, List).
+
+%% Replace internal and odbc auth_methods with storage.
+%% Only one storage type can be used, either internal or odbc.
+replace_storage_auth(Host, Val) when not is_list(Val) ->
+    replace_storage_auth(Host, [Val]);
+replace_storage_auth(Host, Val) ->
+    replace_storage_auth(Host, Val, [], undefined).
+
+replace_storage_auth(_Host, [], Val2, Storage) ->
+    {lists:reverse(Val2), Storage};
+
+replace_storage_auth(Host, [internal = Val | ValT], Val2, undefined) ->
+    Storage = {auth_storage, mnesia},
+    ?WARNING_MSG("The auth method '~p' is deprecated.~nReplace it with 'storage'"
+		 " and also add this option: ~n~p.", [Val, Storage]),
+    replace_storage_auth(Host, ValT, [storage | Val2], Storage);
+
+replace_storage_auth(Host, [odbc = Val | ValT], Val2, undefined) ->
+    Storage = {auth_storage, odbc},
+    ?WARNING_MSG("The auth method '~p' is deprecated.~nReplace it with 'storage'"
+		 " and also add this option: ~n~p.", [Val, Storage]),
+    replace_storage_auth(Host, ValT, [storage | Val2], Storage);
+
+replace_storage_auth(Host, [Val | ValT], Val2, Storage)
+  when (Val /= internal) and (Val /= odbc) ->
+    replace_storage_auth(Host, ValT, [Val | Val2], Storage);
+
+replace_storage_auth(Host, [Val | _ValT], _Val2, Storage) ->
+    ?CRITICAL_MSG("The auth method '~p' conflicts with~n~p in the host \"~p\"."
+		  "~nOnly one of them can be used in each host.",
+		  [Val, Storage, Host]),
+    throw({unacceptable_auth_conflict, Host, Val, Storage}).

src/ejabberd_config.hrl

@@ -1,6 +1,6 @@
 %%%----------------------------------------------------------------------
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -11,7 +11,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -21,8 +21,3 @@
 
 -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,6 +1,6 @@
 %%%----------------------------------------------------------------------
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -11,7 +11,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA

src/ejabberd_frontend_socket.erl

@@ -5,7 +5,7 @@
 %%% Created : 23 Aug 2006 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -45,6 +45,8 @@
 	 get_peer_certificate/1,
 	 get_verify_result/1,
 	 close/1,
+	 setopts/2,
+	 change_controller/2,
 	 sockname/1, peername/1]).
 
 %% gen_server callbacks
@@ -53,6 +55,8 @@
 
 -record(state, {sockmod, socket, receiver}).
 
+-define(HIBERNATE_TIMEOUT, 90000).
+
 %%====================================================================
 %% API
 %%====================================================================
@@ -93,16 +97,14 @@ start(Module, SockMod, Socket, Opts) ->
     end.
 
 starttls(FsmRef, TLSOpts) ->
-    gen_server:call(FsmRef, {starttls, TLSOpts}),
-    FsmRef.
+    starttls(FsmRef, TLSOpts, undefined).
 
 starttls(FsmRef, TLSOpts, Data) ->
     gen_server:call(FsmRef, {starttls, TLSOpts, Data}),
     FsmRef.
 
 compress(FsmRef) ->
-    gen_server:call(FsmRef, compress),
-    FsmRef.
+    compress(FsmRef, undefined).
 
 compress(FsmRef, Data) ->
     gen_server:call(FsmRef, {compress, Data}),
@@ -135,10 +137,15 @@ close(FsmRef) ->
 sockname(FsmRef) ->
     gen_server:call(FsmRef, sockname).
 
+setopts(FsmRef, Opts) ->
+    gen_server:call(FsmRef, {setopts, Opts}).
+
+change_controller(FsmRef, C2SPid) ->
+    gen_server:call(FsmRef, {change_controller, C2SPid}).
+
 peername(FsmRef) ->
     gen_server:call(FsmRef, peername).
 
-
 %%====================================================================
 %% gen_server callbacks
 %%====================================================================
@@ -153,11 +160,19 @@ peername(FsmRef) ->
 init([Module, SockMod, Socket, Opts, Receiver]) ->
     %% TODO: monitor the receiver
     Node = ejabberd_node_groups:get_closest_node(backend),
+    IP = case peername(SockMod, Socket) of
+	     {ok, IP1} ->
+		 IP1;
+	     _ ->
+		 undefined
+	 end,
+    {SockMod2, Socket2} = check_starttls(SockMod, Socket, Receiver, Opts),
     {ok, Pid} =
-	rpc:call(Node, Module, start, [{?MODULE, self()}, Opts]),
+	rpc:call(Node, Module, start,
+		 [{?MODULE, self()}, [{frontend_ip, IP} | Opts]]),
     ejabberd_receiver:become_controller(Receiver, Pid),
-    {ok, #state{sockmod = SockMod,
-		socket = Socket,
+    {ok, #state{sockmod = SockMod2,
+		socket = Socket2,
 		receiver = Receiver}}.
 
 %%--------------------------------------------------------------------
@@ -169,65 +184,47 @@ init([Module, SockMod, Socket, Opts, Receiver]) ->
 %%                                      {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}};
-
 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),
+    {ok, TLSSocket} = ejabberd_receiver:starttls(
+			State#state.receiver, TLSOpts, Data),
     Reply = ok,
-    {reply, Reply, State#state{socket = TLSSocket, sockmod = tls}};
-
-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}};
+    {reply, Reply, State#state{socket = TLSSocket, sockmod = tls},
+     ?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),
+    {ok, ZlibSocket} = ejabberd_receiver:compress(
+			 State#state.receiver, Data),
     Reply = ok,
-    {reply, Reply, State#state{socket = ZlibSocket, sockmod = ejabberd_zlib}};
+    {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};
+    {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};
+    {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};
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT};
 
 handle_call(get_sockmod, _From, State) ->
     Reply = State#state.sockmod,
-    {reply, Reply, State};
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT};
 
 handle_call(get_peer_certificate, _From, State) ->
     Reply = tls:get_peer_certificate(State#state.socket),
-    {reply, Reply, State};
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT};
 
 handle_call(get_verify_result, _From, State) ->
     Reply = tls:get_verify_result(State#state.socket),
-    {reply, Reply, State};
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT};
 
 handle_call(close, _From, State) ->
     ejabberd_receiver:close(State#state.receiver),
@@ -236,14 +233,8 @@ handle_call(close, _From, 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};
+    Reply = peername(SockMod, Socket),
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT};
 
 handle_call(peername, _From, State) ->
     #state{sockmod = SockMod, socket = Socket} = State,
@@ -254,11 +245,19 @@ handle_call(peername, _From, State) ->
 	    _ ->
 		SockMod:peername(Socket)
 	end,
-    {reply, Reply, State};
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT};
+
+handle_call({setopts, Opts}, _From, State) ->
+    ejabberd_receiver:setopts(State#state.receiver, Opts),
+    {reply, ok, State, ?HIBERNATE_TIMEOUT};
+
+handle_call({change_controller, Pid}, _From, State) ->
+    ejabberd_receiver:change_controller(State#state.receiver, Pid),
+    {reply, ok, State, ?HIBERNATE_TIMEOUT};
 
 handle_call(_Request, _From, State) ->
     Reply = ok,
-    {reply, Reply, State}.
+    {reply, Reply, State, ?HIBERNATE_TIMEOUT}.
 
 %%--------------------------------------------------------------------
 %% Function: handle_cast(Msg, State) -> {noreply, State} |
@@ -267,7 +266,7 @@ handle_call(_Request, _From, State) ->
 %% Description: Handling cast messages
 %%--------------------------------------------------------------------
 handle_cast(_Msg, State) ->
-    {noreply, State}.
+    {noreply, State, ?HIBERNATE_TIMEOUT}.
 
 %%--------------------------------------------------------------------
 %% Function: handle_info(Info, State) -> {noreply, State} |
@@ -275,8 +274,11 @@ handle_cast(_Msg, State) ->
 %%                                       {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}.
+    {noreply, State, ?HIBERNATE_TIMEOUT}.
 
 %%--------------------------------------------------------------------
 %% Function: terminate(Reason, State) -> void()
@@ -298,3 +300,23 @@ code_change(_OldVsn, State, _Extra) ->
 %%--------------------------------------------------------------------
 %%% 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} = ejabberd_receiver:starttls(Receiver, TLSOpts),
+	    {tls, TLSSocket};
+	true ->
+	    {SockMod, Socket}
+    end.
+
+peername(SockMod, Socket) ->
+    case SockMod of
+	gen_tcp ->
+	    inet:peername(Socket);
+	_ ->
+	    SockMod:peername(Socket)
+    end.

src/ejabberd_global_router.erl

@@ -0,0 +1,280 @@
+%%%----------------------------------------------------------------------
+%%% File    : ejabberd_global_router.erl
+%%% Author  : Geoff Cant <gcant@process-one.net>
+%%% Purpose : Router for virtual global routes
+%%% Created : 07 Aug 2002 by Geoff Cant <gcant@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2009   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_global_router).
+
+-behaviour(gen_server).
+
+-include("ejabberd.hrl").
+-include("ejabberd_global_router.hrl").
+
+%% API
+-export([start_link/0
+         ,route/3
+         ,route/4
+         ,find_route/1
+         ,register_route/1
+         ,register_route/2
+         ,unregister_route/1
+         ,unregister_route/2
+         ,expand_routes/1
+         ,all_prefixes/0
+         ,server_host/2
+        ]).
+
+%% Eunit test exports.
+-export([remove_prefix/2
+         ,find_prefix/2
+         ]).
+
+%% gen_server callbacks
+-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
+         terminate/2, code_change/3]).
+
+-record(state, {}).
+
+%%====================================================================
+%% API
+%%====================================================================
+%%--------------------------------------------------------------------
+%% @spec start_link() -> {ok,Pid} | ignore | {error,Error}
+%% @doc Starts the server
+%% @end
+%%--------------------------------------------------------------------
+start_link() ->
+    gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
+
+route(From, To, Packet) ->
+    case find_route(To) of
+        Route = #global_route{} ->
+            route(Route, From, To, Packet);
+        no_route ->
+            ok
+    end.
+
+route(#global_route{pids=Pids}, From, To, Packet) ->
+    Pid = pick_route(Pids),
+    Pid ! {route, From, To, Packet},
+    ok.
+
+find_route(Domain) ->
+    case prefix_match(Domain, all_prefixes()) of
+        nomatch ->
+            no_route;
+        Prefix when is_list(Prefix) ->
+             dirty_get_route(Prefix)
+    end.
+
+register_route(Prefix) ->
+    register_route(Prefix, self()).
+
+register_route(Prefix, Pid) ->
+    Route = #global_route{prefix=Prefix,
+                          pids=[Pid]},
+    {atomic, ok} = mnesia:transaction(fun write_route/1,
+                                      [Route]),
+    ok.
+
+unregister_route(Prefix) ->
+    unregister_route(Prefix, self()).
+
+unregister_route(Prefix, Pid) ->
+    mnesia:transaction(fun delete_route/2, [Prefix, Pid]).
+
+expand_routes(Domain) ->
+    [expand_route(Prefix, Domain) || Prefix <- all_prefixes()].
+
+expand_route(Prefix, Domain) ->
+    lists:append([Prefix, ".", Domain]).
+
+all_prefixes() ->
+    mnesia:dirty_all_keys(global_route).
+
+server_host(Host, Pid) ->
+    #global_route{prefix=P,pids=Pids} = find_route(Host),
+    true = lists:member(Pid, Pids),
+    remove_prefix(P, Host).
+
+%%====================================================================
+%% gen_server callbacks
+%%====================================================================
+
+%%--------------------------------------------------------------------
+%% @private
+%% @spec init(Args) -> {ok, State} |
+%%                     {ok, State, Timeout} |
+%%                     ignore               |
+%%                     {stop, Reason}
+%% @doc Initialises the server's state
+%% @end
+%%--------------------------------------------------------------------
+init([]) ->
+    update_tables(),
+    mnesia:create_table(global_route,
+			[{ram_copies, [node()]},
+			 {type, set},
+			 {attributes,
+			  record_info(fields, global_route)}]),
+    mnesia:add_table_copy(global_route, node(), ram_copies),
+    {ok, #state{}}.
+
+%%--------------------------------------------------------------------
+%% @private
+%% @spec
+%% handle_call(Request, From, State) -> {reply, Reply, State} |
+%%                                      {reply, Reply, State, Timeout} |
+%%                                      {noreply, State} |
+%%                                      {noreply, State, Timeout} |
+%%                                      {stop, Reason, Reply, State} |
+%%                                      {stop, Reason, State}
+%% @doc Call message handler callbacks
+%% @end
+%%--------------------------------------------------------------------
+handle_call(Call, _From, State) ->
+    ?WARNING_MSG("Unexpected call ~p.", [Call]),
+    {noreply, State}.
+
+%%--------------------------------------------------------------------
+%% @private
+%% @spec
+%% handle_cast(Msg, State) -> {noreply, State} |
+%%                            {noreply, State, Timeout} |
+%%                            {stop, Reason, State}
+%% @doc Cast message handler callbacks
+%% @end
+%%--------------------------------------------------------------------
+handle_cast(Msg, State) ->
+    ?WARNING_MSG("Unexpected cast ~p", [Msg]),
+    {noreply, State}.
+
+%%--------------------------------------------------------------------
+%% @private
+%% @spec
+%% handle_info(Info, State) -> {noreply, State} |
+%%                             {noreply, State, Timeout} |
+%%                             {stop, Reason, State}
+%% @doc Non gen-server message handler callbacks
+%% @end
+%%--------------------------------------------------------------------
+handle_info(Info, State) ->
+    ?WARNING_MSG("Unexpected info ~p", [Info]),
+    {noreply, State}.
+
+%%--------------------------------------------------------------------
+%% @private
+%% @spec terminate(Reason, State) -> void()
+%% @doc 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.
+%% @end
+%%--------------------------------------------------------------------
+terminate(_Reason, _State) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% @private
+%% @spec code_change(OldVsn, State, Extra) -> {ok, NewState}
+%% @doc Convert process state when code is changed
+%% @end
+%%--------------------------------------------------------------------
+code_change(_OldVsn, State, _Extra) ->
+    {ok, State}.
+
+pick_route(Pids) when is_list(Pids) ->
+    pick_local_route(Pids).
+
+pick_local_route(Pids) when is_list(Pids) ->
+    case [Pid || Pid <- Pids,
+                 node(Pid) =:= node()] of
+        [] -> pick_remote_route(Pids);
+        LocalPids -> pick_one_route(LocalPids)
+    end.
+
+pick_remote_route(Pids) when is_list(Pids) -> pick_one_route(Pids).
+
+pick_one_route(Pids) when is_list(Pids) ->
+    hd(Pids). % should pick random pid?
+
+
+update_tables() ->
+    CorrectAttributes = record_info(fields, global_route),
+    case catch mnesia:table_info(global_route, attributes) of
+        CorrectAttributes ->
+            ok;
+        IncorrectAttributes when is_list(IncorrectAttributes) ->
+	    mnesia:delete_table(global_route);
+	{'EXIT', _} ->
+	    ok
+    end.
+
+write_route(R = #global_route{prefix=Prefix}) ->
+    NewRoute = case mnesia:read({global_route, Prefix}) of
+                   [] -> R;
+                   [OldRoute] ->
+                       combine_routes(OldRoute, R)
+               end,
+    ok = mnesia:write(NewRoute).
+
+delete_route(Prefix, Pid) ->
+    case mnesia:read({global_route, Prefix}, write) of
+        [] -> ok;
+        [#global_route{pids=[Pid]}] ->
+            mnesia:delete({global_route, Prefix});
+        [Route = #global_route{pids=Pids}] ->
+            mnesia:write(Route#global_route{pids=Pids -- [Pid]})
+    end.
+
+combine_routes(R = #global_route{prefix=P, pids=APids},
+               #global_route{prefix=P, pids=BPids}) ->
+    R#global_route{pids=lists:usort(APids ++ BPids)}.
+
+prefix_match(Domain, Prefixes) ->
+    case find_prefix(Domain, Prefixes) of
+        [] -> nomatch;
+        [Prefix] -> Prefix;
+        _Prefixes ->
+            erlang:error(multiple_prefix_matches)
+    end.
+
+dirty_get_route(Prefix) ->
+    case mnesia:dirty_read({global_route, Prefix}) of
+        [Route = #global_route{}] ->
+            Route;
+        _ -> no_route
+    end.
+
+find_prefix(Domain, PossiblePrefixes) ->
+    [Prefix
+     || Prefix <- PossiblePrefixes,
+        lists:prefix(Prefix, Domain)].
+
+remove_prefix(Prefix, Domain) ->
+    [$. | BareDomain] = Domain -- Prefix,
+    BareDomain.
+
+%%--------------------------------------------------------------------
+%%% Eunit Tests.
+%%--------------------------------------------------------------------

src/ejabberd_global_router.hrl

@@ -0,0 +1,27 @@
+%%%----------------------------------------------------------------------
+%%% File    : ejabberd_global_router.hrl
+%%% Author  : Geoff Cant <gcant@process-one.net>
+%%% Purpose : Virtual global routes record definitions
+%%% Created : 08 Aug 2002 by Geoff Cant <gcant@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2009   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(global_route, {prefix, pids}).

src/ejabberd_hooks.erl

@@ -5,7 +5,7 @@
 %%% Created :  8 Aug 2004 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -31,12 +31,18 @@
 
 %% 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]).
 
@@ -50,6 +56,9 @@
 
 -include("ejabberd.hrl").
 
+%% Timeout of 5 seconds in calls to distributed hooks
+-define(TIMEOUT_DISTRIBUTED_HOOK, 5000).
+
 -record(state, {}).
 
 %%%----------------------------------------------------------------------
@@ -58,38 +67,111 @@
 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) ->
+add(Hook, Host, Module, Function, Seq) 
+     when is_binary(Host) orelse is_atom(Host) ->
     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) ->
+delete(Hook, Host, Module, Function, Seq) 
+     when is_binary(Host) orelse is_atom(Host) ->
     gen_server:call(ejabberd_hooks, {delete, Hook, Host, Module, Function, Seq}).
 
-run(Hook, Args) ->
-    run(Hook, global, Args).
+delete_dist(Hook, Node, Module, Function, Seq) ->
+    delete_dist(Hook, global, Node, Module, Function, Seq).
 
-run(Hook, Host, Args) ->
-    case ets:lookup(hooks, {Hook, Host}) of
+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) ->
+    runx(Hook, global, Args).
+
+run(Hook, Host, Args) when is_binary(Host) ->
+    case runx(Hook, Host, Args) of
+	stop -> stop;
+	_ -> runx(Hook, global, Args)
+    end;
+run(Hook, Host, Args) when Host == global ->
+    runx(Hook, Host, Args).
+
+runx(Hook, Host, Args) when is_binary(Host) orelse is_atom(Host) ->
+    case ets:lookup(hooks, {Hook, ejabberd:normalize_host(Host)}) of
 	[{_, Ls}] ->
 	    run1(Ls, Hook, Args);
 	[] ->
-	    ok
+	    case ets:lookup(hooks, {Hook, global}) of
+		[{_, Ls}] ->
+		    run1(Ls, Hook, Args);
+		[] ->
+		    ok
+	    end
     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).
+    run_foldx(Hook, global, Val, Args).
 
-run_fold(Hook, Host, Val, Args) ->
-    case ets:lookup(hooks, {Hook, Host}) of
+%% @spec (Hook::atom(), Host, Val, Args) -> Val | stopped | NewVal
+%% Host = global | binary()
+run_fold(Hook, Host, Val, Args) when is_binary(Host) ->
+    case run_foldx(Hook, Host, Val, Args) of
+	stopped -> stopped;
+	Val2 -> run_foldx(Hook, global, Val2, Args)
+    end;
+run_fold(Hook, Host, Val, Args) when Host == global ->
+    run_foldx(Hook, Host, Val, Args).
+
+run_foldx(Hook, Host, Val, Args) ->
+    case ets:lookup(hooks, {Hook, ejabberd:normalize_host(Host)}) of
 	[{_, Ls}] ->
 	    run_fold1(Ls, Hook, Val, Args);
 	[] ->
-	    Val
+	    case ets:lookup(hooks, {Hook, global}) of
+		[{_, Ls}] ->
+		    run_fold1(Ls, Hook, Val, Args);
+		[] ->
+		    Val
+	    end
     end.
 
 %%%----------------------------------------------------------------------
@@ -117,9 +199,28 @@ init([]) ->
 %%          {stop, Reason, State}            (terminate/2 is called)
 %%----------------------------------------------------------------------
 handle_call({add, Hook, Host, Module, Function, Seq}, _From, State) ->
-    Reply = case ets:lookup(hooks, {Hook, Host}) of
+    NHost = ejabberd:normalize_host(Host),
+    Reply = case ets:lookup(hooks, {Hook, NHost}) of
 		[{_, Ls}] ->
 		    El = {Seq, Module, Function},
+		    case lists:member(El, Ls) of
+			true ->
+			    ok;
+			false ->
+			    NewLs = lists:merge(Ls, [El]),
+			    ets:insert(hooks, {{Hook, NHost}, NewLs}),
+			    ok
+		    end;
+		[] ->
+		    NewLs = [{Seq, Module, Function}],
+		    ets:insert(hooks, {{Hook, NHost}, NewLs}),
+		    ok
+	    end,
+    {reply, Reply, 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;
@@ -129,15 +230,26 @@ handle_call({add, Hook, Host, Module, Function, Seq}, _From, State) ->
 			    ok
 		    end;
 		[] ->
-		    NewLs = [{Seq, Module, Function}],
+		    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
+    NHost = ejabberd:normalize_host(Host),
+    Reply = case ets:lookup(hooks, {Hook, NHost}) of
 		[{_, Ls}] ->
 		    NewLs = lists:delete({Seq, Module, Function}, Ls),
+		    ets:insert(hooks, {{Hook, NHost}, NewLs}),
+		    ok;
+		[] ->
+		    ok
+	    end,
+    {reply, Reply, 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;
 		[] ->
@@ -184,14 +296,38 @@ code_change(_OldVsn, State, _Extra) ->
 
 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}]),
 	    run1(Ls, Hook, Args);
 	stop ->
-	    ok;
+	    stop;
 	_ ->
 	    run1(Ls, Hook, Args)
     end.
@@ -199,8 +335,34 @@ run1([{_Seq, Module, Function} | Ls], Hook, 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}]),
@@ -212,6 +374,3 @@ run_fold1([{_Seq, Module, Function} | Ls], Hook, Val, Args) ->
 	NewVal ->
 	    run_fold1(Ls, Hook, NewVal, Args)
     end.
-
-
-

src/ejabberd_hosts.erl

@@ -0,0 +1,436 @@
+%%%-------------------------------------------------------------------
+%%% File    : ejabberd_hosts.erl
+%%% Author  : Alexey Shchepin <alexey@process-one.net>
+%%% Description : Synchronises running VHosts with the hosts table in the Mnesia database.
+%%% Created : 16 Nov 2007 by Alexey Shchepin <alexey@process-one.net>
+%%%-------------------------------------------------------------------
+
+%%% Database schema (version / storage / table)
+%%%
+%%% 3.0.0-alpha-x / mnesia / hosts
+%%%  host = string()
+%%%  clusterid = integer()
+%%%  config = string() 
+%%%
+%%% 3.0.0-alpha-x / odbc / hosts
+%%%  host = varchar150
+%%%  clusterid = integer
+%%%  config = text 
+
+-module(ejabberd_hosts).
+
+-behaviour(gen_server).
+
+%% External API
+-export([start_link/0
+         ,reload/0
+        ]).
+
+%% Host Registration API
+-export([register/1
+         ,register/2
+         ,registered/1
+         ,running/1
+         ,registered/0
+         ,remove/1
+        ]).
+
+%% Host control API
+-export([start_host/1
+         ,start_hosts/1
+         ,stop_host/1
+         ,stop_hosts/1
+         ,load_host_cert/2
+         ]).
+
+%% Private utility functions
+-export([get_hosts/1
+         ,config_from_string/2
+         ,get_host_config/2
+         ,diff_hosts/0
+         ,diff_hosts/1
+         ,diff_hosts/2
+         ,reload_hosts/0
+         ,delete_host_config/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("ejabberd_config.hrl").
+-include_lib("stdlib/include/ms_transform.hrl").
+
+-record(state, {state=wait_odbc,
+                backend=mnesia,
+                odbc_wait_time=120}).
+-record(hosts, {host, clusterid, config}).
+
+-define(RELOAD_INTERVAL, timer:seconds(60)).
+-define(ODBC_STARTUP_TIME, 120). % 2minute limit for ODBC startup.
+
+%%====================================================================
+%% API
+%%====================================================================
+
+reload() ->
+    ?MODULE ! reload.
+
+%% Creates a vhost in the system.
+register(Host) when is_list(Host) -> ?MODULE:register(Host, "").
+register(Host, Config) when is_list(Host), is_list(Config) ->
+    true = exmpp_stringprep:is_node(Host),
+    ID = get_clusterid(),
+    H = #hosts{host = Host, clusterid = ID, config = Config},
+    ok = gen_storage:dirty_write(Host, H),
+    reload(),
+    ok.
+
+%% Removes a vhost from the system,
+%% XXX deleting all ODBC data.
+remove(Host) when is_list(Host) ->
+    true = exmpp_stringprep:is_node(Host),
+    ID = get_clusterid(),
+    gen_storage:dirty_delete_where(
+	Host, hosts,
+	[{'andalso',
+	    {'==', clusterid, ID},
+	    {'==', host, Host}}]),
+    reload(),
+    ok.
+
+registered() ->
+    mnesia:dirty_select(local_config,
+                        ets:fun2ms(fun (#local_config{key={Host, host}}) ->
+                                           Host
+                                   end)).
+
+registered(Host) when is_list(Host) ->
+    case mnesia:dirty_read({local_config, {Host, host}}) of
+        [{local_config, {Host, host}, _}] -> true;
+        [] -> false
+    end.
+
+running(global) -> true;
+running(Host) ->
+    Routes = [H
+              || {H, _, {apply, ejabberd_local, route}} <- ejabberd_router:read_route(Host),
+                 H =:= Host],
+    Routes =/= [].
+
+
+load_host_cert(Host, PemData) ->
+    File = cert_filename(Host),
+    ok = file:write_file(File, PemData),
+    configure_host_cert(Host, File).
+
+%%--------------------------------------------------------------------
+%% Function: start_link() -> {ok,Pid} | ignore | {error,Error}
+%% Description: Starts the server
+%%--------------------------------------------------------------------
+start_link() ->
+    gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
+
+%%====================================================================
+%% gen_server callbacks
+%%====================================================================
+
+%%--------------------------------------------------------------------
+%% Function: init(Args) -> {ok, State} |
+%%                         {ok, State, Timeout} |
+%%                         ignore               |
+%%                         {stop, Reason}
+%% Description: Initiates the server
+%%--------------------------------------------------------------------
+init([]) ->
+    Backend = mnesia, %%+++ TODO: allow to configure this in ejabberd.cfg
+    configure_static_hosts(),
+    get_clusterid(), %% this is to report an error if the option wasn't configured
+    %% Wait up to 120 seconds for odbc to start
+    {ok, #state{state=wait_odbc,backend=Backend,odbc_wait_time=?ODBC_STARTUP_TIME}, timer:seconds(1)}.
+
+%%--------------------------------------------------------------------
+%% 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
+%%--------------------------------------------------------------------
+%% Wait for odbc to start.
+handle_info(timeout, State = #state{state=wait_odbc,backend=Backend,odbc_wait_time=N}) when N > 0 ->
+    case (Backend /= odbc) orelse ejabberd_odbc:running(?MYNAME) of
+        true ->
+            ?DEBUG("ejabberd_hosts: odbc now running.",[]),
+
+	    %% The table 'hosts' is defined in gen_storage as being for the "localhost" vhost
+	    Host = ?MYNAME,
+	    HostB = list_to_binary(Host),
+	    gen_storage:create_table(Backend, HostB, hosts,
+				     [{disc_only_copies, [node()]},
+				      {odbc_host, Host},
+				      {attributes, record_info(fields, hosts)},
+				      {types, [{host, text},
+					       {clusterid, int},
+					       {config, text}]}]),
+
+	    %% Now let's add the default vhost: "localhost"
+	    gen_storage:dirty_write(Host, #hosts{host = Host,
+							clusterid = 1,
+							config = ""}),
+
+            self() ! reload,
+            timer:send_interval(?RELOAD_INTERVAL, reload),
+            {noreply, State#state{state=running,odbc_wait_time=0}};
+        false ->
+            {noreply,State#state{odbc_wait_time=N-1},timer:seconds(1)}
+    end;
+handle_info(timeout, State=#state{state=running}) ->
+    ?WARNING_MSG("Spurious timeout message when odbc is already running.", []),
+    {noreply, State};
+
+handle_info(reload, State = #state{state=running}) ->
+    try reload_hosts()
+    catch
+        Class:Error ->
+            StackTrace = erlang:get_stacktrace(),
+            ?ERROR_MSG("~p while synchonising running vhosts with database: ~p~n~p", [Class, Error, StackTrace])
+    end,
+    {noreply, State};
+handle_info(reload, State = #state{state=wait_odbc}) ->
+    ?ERROR_MSG("Tried to reload vhosts while waiting for odbc startup.", []),
+    handle_info(timeout, 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
+%%--------------------------------------------------------------------
+
+reload_hosts() ->
+    reload_hosts(get_hosts(odbc)).
+
+reload_hosts(NewHosts) ->
+    {AddedHosts,RemovedHosts} = diff_hosts(NewHosts),
+    %% Avoid removing permanent hosts (staticly configured hosts)
+    DeletedHosts = [H || H <- RemovedHosts,
+                         ejabberd_config:get_host_option(H, permanent) =/= true],
+    AddHostConfig = lists:map(fun (Host) ->
+                                      {Host, get_host_config(odbc,Host)}
+                              end, AddedHosts),
+    update_config(AddHostConfig,DeletedHosts),
+    ejabberd_config:add_global_option(hosts, NewHosts), % overwrite hosts list
+    stop_hosts(DeletedHosts),
+    start_hosts(AddedHosts),
+    ejabberd_local:refresh_iq_handlers(),
+    {DeletedHosts, AddedHosts}.
+
+%% Apply the vhost changes (new, removed vhosts, configuration) to mnesia
+update_config(AddHostConfig, RemoveHosts) ->
+    F = fun() ->
+                mnesia:write_lock_table(local_config),
+                lists:foreach(fun configure_new_host/1, AddHostConfig),
+                lists:foreach(fun delete_host_config/1, RemoveHosts),
+                ok
+        end,
+    {atomic, ok} = mnesia:transaction(F).
+
+%% Write the configuration data for a new vhost to mnesia (currently only modules)
+configure_new_host({H, Config}) when is_list(Config) ->
+    reconfigure_host_cert(H),
+    ejabberd_config:configure_host(H, Config).
+
+%% Delete the mnesia config data for a vhost.
+%% Needs to mirror any data we insert in configure_new_host (currently only modules)
+delete_host_config(Host) ->
+    ejabberd_config:delete_host(Host).
+
+%% Startup a list of vhosts
+start_hosts([]) -> ok;
+start_hosts(AddHosts) when is_list(AddHosts) ->
+    ?DEBUG("ejabberd_hosts adding hosts: ~P", [AddHosts, 10]),
+    lists:foreach(fun start_host/1, AddHosts).
+
+%% Start a single vhost (route, modules)
+start_host(Host) ->
+    ?DEBUG("Starting host ~p", [Host]),
+    ejabberd_router:register_route(Host, {apply, ejabberd_local, route}),
+    case ejabberd_config:get_local_option({modules, Host}) of
+        undefined -> ok;
+        Modules when is_list(Modules) ->
+            lists:foreach(
+              fun({Module, Args}) ->
+                      gen_mod:start_module(Host, Module, Args)
+              end, Modules)
+    end,
+    case auth_method(Host) of
+        {host_method, HostMethod} ->
+            ejabberd_auth:start_method(Host, HostMethod);
+        _ -> ignore
+    end,
+    ok.
+
+
+%% Shut down a list of vhosts.
+stop_hosts([]) -> ok;
+stop_hosts(RemoveHosts) when is_list(RemoveHosts)->
+    ?DEBUG("ejabberd_hosts removing hosts: ~p", [RemoveHosts]),
+    lists:foreach(fun stop_host/1, RemoveHosts).
+
+%% Shut down a single vhost. (Routes, modules)
+stop_host(Host) ->
+    ?DEBUG("Stopping host ~p", [Host]),
+    ejabberd_router:force_unregister_route(Host),
+    lists:foreach(fun(Module) ->
+                          gen_mod:stop_module(Host, Module)
+                  end, gen_mod:loaded_modules(Host)),
+    case auth_method(Host) of
+        use_global_auth_method -> ok;
+        {host_method, Method} ->
+            ejabberd_auth:stop_method(Host, Method)
+    end.
+
+%% Get the current vhost list from a variety of sources (ODBC, internal)
+get_hosts(ejabberd) -> ?MYHOSTS;
+get_hosts(odbc) ->
+    ClusterID = get_clusterid(),
+    case gen_storage:dirty_select(?MYNAME, hosts, [{'=', clusterid, ClusterID}]) of
+            Hosts when is_list(Hosts) ->
+		lists:map(fun (#hosts{host = Host}) ->
+                              case exmpp_stringprep:nameprep(Host) of
+                                  error ->
+                                      erlang:error({bad_vhost_name, Host});
+                                  Name ->
+                                      Name
+                              end
+                      end, Hosts);
+            E ->
+		erlang:error({get_hosts_error, E})
+    end.
+
+%% Retreive the text format config for host Host from ODBC and covert
+%% it into a {host, Host, Config} tuple.
+get_host_config(odbc, Host) ->
+    case gen_storage:dirty_read(?MYNAME, hosts, Host) of
+        [] ->
+            erlang:error({no_such_host, Host});
+        [H] ->
+            config_from_string(Host, H#hosts.config);
+        E ->
+            erlang:error({host_config_error, E})
+    end.
+
+%% Convert a plaintext string into a host config tuple.
+config_from_string(_Host, "") -> [];
+config_from_string(_Host, Config) ->
+    {ok, Tokens, _} = erl_scan:string(Config),
+    case erl_parse:parse_term(Tokens) of
+        {ok, List} when is_list(List) ->
+            List;
+        E ->
+            erlang:error({bad_host_config, Config, E})
+    end.
+
+diff_hosts() ->
+    diff_hosts(get_hosts(odbc)).
+
+diff_hosts(NewHosts) ->
+    diff_hosts(NewHosts, get_hosts(ejabberd)).
+
+%% Given the new list of vhosts and the old list, return the list of
+%% hosts added since last time and the list of hosts that have been
+%% removed.
+diff_hosts(NewHosts, OldHosts) ->
+    RemoveHosts = OldHosts -- NewHosts,
+    AddHosts = NewHosts -- OldHosts,
+    {AddHosts,RemoveHosts}.    
+
+%% XXX - this should be part of auth, not hosts.
+auth_method(Host) ->
+    case ejabberd_config:get_host_option(Host, auth_method) of
+        undefined ->
+            use_global_auth_method;
+        Other ->
+            {host_method, Other}
+    end.
+
+configure_static_hosts() ->
+    ?DEBUG("Node startup - configuring hosts: ~p", [?MYHOSTS]),
+    %% Add a null configuration for all MYHOSTS - this ensures
+    %% the 'I'm a host' term gets written to the config table.
+    %% We don't need any configuration options because these are
+    %% statically configured hosts already configured by ejabberd_config.
+    F = fun () ->
+                lists:foreach(fun (H) -> ejabberd_config:configure_host(H, [{permanent, true}]) end,
+                              ?MYHOSTS)
+        end,
+    mnesia:transaction(F).
+
+cert_filename(Host) ->
+    Dir = ejabberd_config:get_local_option({domain_certdir, global}),
+    filename:join(Dir, Host ++ ".pem").
+
+configure_host_cert(Host, File) ->
+    ejabberd_config:add_local_option({domain_certfile, Host}, File),
+    ok.
+
+reconfigure_host_cert(Host) ->
+    File = cert_filename(Host),
+    case ejabberd_config:is_file_readable(File) of
+        true ->
+            ejabberd_config:mne_add_local_option({domain_certfile, Host}, File),
+            ok;
+        false ->
+            no_cert
+    end.
+
+get_clusterid() ->
+    case ejabberd_config:get_local_option(clusterid) of
+	ID when is_integer(ID) ->
+	    ID;
+	undefined ->
+	    ?ERROR_MSG("Please add to your ejabberd.cfg the line: ~n  {clusterid, 1}.", []),
+	    1;
+	Other ->
+	    ?ERROR_MSG("Change your misconfigured {clusterid, ~p} to the value: ~p", [Other, 1]),
+	    1
+    end.

src/ejabberd_listener.erl

@@ -5,7 +5,7 @@
 %%% Created : 16 Nov 2002 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -29,82 +29,204 @@
 
 -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,
+	 rate_limit/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) ->
-    SSLError = "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'.",
-    case lists:keysearch(ssl, 1, Opts) of
-	{value, {ssl, _SSLOpts}} ->
-	    %%{ok, proc_lib:spawn_link(?MODULE, init_ssl,
-	    %%		     [Port, Module, Opts, SSLOpts])};
-	    ?ERROR_MSG(SSLError, []),
-	    {error, SSLError};
-	_ ->
-	    case lists:member(ssl, Opts) of
-		true ->
-		    %%{ok, proc_lib:spawn_link(?MODULE, init_ssl,
-		    %%		     [Port, Module, Opts, []])};
-		    ?ERROR_MSG(SSLError, []),
-		    {error, SSLError};
-		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 = case erlang:system_info(otp_release) >= "R13B" of
+	true -> [{send_timeout_close, true} | SockOpts];
+	false -> SockOpts
+    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) ->
+    accept(ListenSocket, Module, Opts, 0).
+accept(ListenSocket, Module, Opts, Interval) ->
+    NewInterval = check_rate_limit(Interval),
     case gen_tcp:accept(ListenSocket) of
 	{ok, Socket} ->
 	    case {inet:sockname(Socket), inet:peername(Socket)} of
@@ -114,71 +236,71 @@ accept(ListenSocket, Module, Opts) ->
 		_ ->
 		    ok
 	    end,
-	    case Module of
-		{frontend, Mod} ->
-		    ejabberd_frontend_socket:start(Mod, gen_tcp, Socket, Opts);
-		_ ->
-		    ejabberd_socket:start(Module, gen_tcp, Socket, Opts)
-	    end,
-	    accept(ListenSocket, Module, Opts);
+	    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, NewInterval);
 	{error, Reason} ->
 	    ?INFO_MSG("(~w) Failed TCP accept: ~w",
 		      [ListenSocket, Reason]),
-	    accept(ListenSocket, Module, Opts)
+	    accept(ListenSocket, Module, Opts, NewInterval)
     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,
@@ -187,30 +309,203 @@ 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.
+
+%% Set interval between two accepts on given port
+rate_limit([], _Interval) ->
+    ok;
+rate_limit([Port|Ports], Interval) ->
+    rate_limit(Port, Interval),
+    rate_limit(Ports, Interval);
+rate_limit(Port, Interval) ->
+    case get_listener_pid_by_port(Port) of
+	undefined -> no_listener;
+	Pid -> Pid ! {rate_limit, Interval}, ok
+    end.
+
+get_listener_pid_by_port(Port) ->
+    ListenerPids = [Pid || {{P,_,_},Pid,_,_} <-
+			       supervisor:which_children(erlang:whereis(ejabberd_listeners)),
+			   P == Port],
+    ListenerPid = case ListenerPids of
+		      [] -> undefined;
+		      [LPid|_] -> LPid
+		  end,
+    ListenerPid.
+
+check_rate_limit(Interval) ->
+    NewInterval = receive
+		      {rate_limit, AcceptInterval} ->
+			  AcceptInterval
+		  after 0 ->
+			  Interval
+		  end,
+    case NewInterval of
+	0  -> ok;
+	Ms ->
+	    timer:sleep(Ms)
+    end,
+    NewInterval.

src/ejabberd_local.erl

@@ -5,7 +5,7 @@
 %%% Created : 30 Nov 2002 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -33,10 +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
 	]).
@@ -45,15 +48,26 @@
 -export([init/1, handle_call/3, handle_cast/2, handle_info/2,
 	 terminate/2, code_change/3]).
 
+-include_lib("exmpp/include/exmpp.hrl").
+
 -include("ejabberd.hrl").
--include("jlib.hrl").
 
 -record(state, {}).
 
--record(iq_response, {id, module, function}).
+-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).
+
+% These are the namespace already declared by the stream opening. This is
+% used at serialization time.
+-define(DEFAULT_NS, ?NS_JABBER_CLIENT).
+-define(PREFIXED_NS, [
+  {?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx}
+]).
+
 %%====================================================================
 %% API
 %%====================================================================
@@ -65,61 +79,65 @@ start_link() ->
     gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
 
 process_iq(From, To, Packet) ->
-    IQ = jlib:iq_query_info(Packet),
-    case IQ of
-	#iq{xmlns = XMLNS} ->
-	    Host = To#jid.lserver,
-	    case ets:lookup(?IQTABLE, {XMLNS, Host}) of
+    case exmpp_iq:xmlel_to_iq(Packet) of
+	#iq{kind = request, ns = XMLNS} = IQ_Rec ->
+	    Host = exmpp_jid:prep_domain(To),
+	    case ets:lookup(?IQTABLE, {XMLNS, ejabberd:normalize_host(Host)}) of
 		[{_, Module, Function}] ->
-		    ResIQ = Module:Function(From, To, IQ),
+		    ResIQ = Module:Function(From, To, IQ_Rec),
 		    if
 			ResIQ /= ignore ->
-			    ejabberd_router:route(
-			      To, From, jlib:iq_to_xml(ResIQ));
+			    Reply = exmpp_iq:iq_to_xmlel(ResIQ, To, From),
+			    ejabberd_router:route(To, From, Reply);
 			true ->
 			    ok
 		    end;
 		[{_, Module, Function, Opts}] ->
 		    gen_iq_handler:handle(Host, Module, Function, Opts,
-					  From, To, IQ);
+					  From, To, IQ_Rec);
 		[] ->
-		    Err = jlib:make_error_reply(
-			    Packet, ?ERR_FEATURE_NOT_IMPLEMENTED),
-		    ejabberd_router:route(To, From, Err)
+		    case ets:lookup(?IQTABLE, {XMLNS, global}) of
+			[{_, Module, Function, Opts}] ->
+			    gen_iq_handler:handle(
+			      global, Module, Function, Opts,
+			      From, To, IQ_Rec);
+			[] ->
+			    Err = exmpp_iq:error(Packet, 'feature-not-implemented'),
+			    ejabberd_router:route(To, From, Err)
+		    end
 	    end;
-	reply ->
-	    process_iq_reply(From, To, Packet);
+        #iq{kind = response} = IQReply ->
+ 	    %%IQReply = jlib:iq_query_or_response_info(IQ_Rec),
+ 	    process_iq_reply(From, To, IQReply);
 	_ ->
-	    Err = jlib:make_error_reply(Packet, ?ERR_BAD_REQUEST),
+	    Err = exmpp_iq:error(Packet, 'bad-request'),
 	    ejabberd_router:route(To, From, Err),
 	    ok
     end.
 
-process_iq_reply(From, To, Packet) ->
-    IQ = jlib:iq_query_or_response_info(Packet),
-    #iq{id = ID} = IQ,
-    case catch mnesia:dirty_read(iq_response, ID) of
-	[] ->
+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;
 	_ ->
-	    F = fun() ->
-			case mnesia:read({iq_response, ID}) of
-			    [] ->
-				nothing;
-			    [#iq_response{module = Module,
-					  function = Function}] ->
-				mnesia:delete({iq_response, ID}),
-				{Module, Function}
-			end
-		end,
-	    case mnesia:transaction(F) of
-		{atomic, {Module, Function}} ->
-		    Module:Function(From, To, IQ);
-		_ ->
-		    ok
-	    end
+	    nothing
     end.
-
+  
+%% #xmlelement{} used for retro-compatibility
+route(FromOld, ToOld, #xmlelement{} = PacketOld) ->
+    catch throw(for_stacktrace), % To have a stacktrace.
+    io:format("~nLOCAL: old #xmlelement:~n~p~n~p~n~n",
+      [PacketOld, erlang:get_stacktrace()]),
+    % XXX OLD FORMAT: From, To, Packet.
+    From = jlib:from_old_jid(FromOld),
+    To = jlib:from_old_jid(ToOld),
+    Packet = exmpp_xml:xmlelement_to_xmlel(PacketOld, [?NS_JABBER_CLIENT],
+      [{?NS_XMPP, ?NS_XMPP_pfx}]),
+    route(From, To, Packet);
 route(From, To, Packet) ->
     case catch do_route(From, To, Packet) of
 	{'EXIT', Reason} ->
@@ -129,8 +147,23 @@ route(From, To, Packet) ->
 	    ok
     end.
 
-register_iq_response_handler(Host, ID, Module, Fun) ->
-    ejabberd_local ! {register_iq_response_handler, Host, ID, Module, Fun}.
+route_iq(From, To, #iq{type = Type} = IQ, F) when is_function(F) ->
+    Packet = if Type == set; Type == get ->
+		     ID = list_to_binary(ejabberd_router:make_id()),
+		     Host = exmpp_jid:prep_domain(From),
+		     register_iq_response_handler(Host, ID, undefined, F),
+		     exmpp_iq:iq_to_xmlel(IQ#iq{id = ID});
+		true ->
+		     exmpp_iq:iq_to_xmlel(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),
+    ets:insert(iq_response, #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}.
@@ -138,6 +171,10 @@ 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}.
 
@@ -145,7 +182,7 @@ refresh_iq_handlers() ->
     ejabberd_local ! refresh_iq_handlers.
 
 bounce_resource_packet(From, To, Packet) ->
-    Err = jlib:make_error_reply(Packet, ?ERR_ITEM_NOT_FOUND),
+    Err = exmpp_stanza:reply_with_error(Packet, 'item-not-found'),
     ejabberd_router:route(To, From, Err),
     stop.
 
@@ -163,14 +200,14 @@ bounce_resource_packet(From, To, Packet) ->
 init([]) ->
     lists:foreach(
       fun(Host) ->
-	      ejabberd_router:register_route(Host, {apply, ?MODULE, route}),
-	      ejabberd_hooks:add(local_send_to_resource_hook, Host,
-				 ?MODULE, bounce_resource_packet, 100)
+	      ejabberd_router:register_route(Host, {apply, ?MODULE, route})
       end, ?MYHOSTS),
+    ejabberd_hooks:add(local_send_to_resource_hook, global,
+			?MODULE, bounce_resource_packet, 100),
     catch ets:new(?IQTABLE, [named_table, public]),
-    mnesia:create_table(iq_response,
-			[{ram_copies, [node()]},
-			 {attributes, record_info(fields, iq_response)}]),
+    mnesia:delete_table(iq_response),
+    catch ets:new(iq_response, [named_table, public,
+				{keypos, #iq_response.id}]),
     {ok, #state{}}.
 
 %%--------------------------------------------------------------------
@@ -201,6 +238,18 @@ handle_cast(_Msg, State) ->
 %%                                       {stop, Reason, State}
 %% Description: Handling all non call/cast messages
 %%--------------------------------------------------------------------
+
+%% #xmlelement{} used for retro-compatibility
+handle_info({route, FromOld, ToOld, #xmlelement{} = PacketOld}, State) ->
+    catch throw(for_stacktrace), % To have a stacktrace.
+    io:format("~nLOCAL: old #xmlelement:~n~p~n~p~n~n",
+      [PacketOld, erlang:get_stacktrace()]),
+    % XXX OLD FORMAT: From, To, Packet.
+    From = jlib:from_old_jid(FromOld),
+    To = jlib:from_old_jid(ToOld),
+    Packet = exmpp_xml:xmlelement_to_xmlel(PacketOld, [?NS_JABBER_CLIENT],
+      [{?NS_XMPP, ?NS_XMPP_pfx}]),
+    handle_info({route, From, To, Packet}, State);
 handle_info({route, From, To, Packet}, State) ->
     case catch do_route(From, To, Packet) of
 	{'EXIT', Reason} ->
@@ -210,25 +259,22 @@ handle_info({route, From, To, Packet}, State) ->
 	    ok
     end,
     {noreply, State};
-handle_info({register_iq_response_handler, _Host, ID, Module, Function}, State) ->
-    mnesia:dirty_write(#iq_response{id = ID, module = Module, function = Function}),
-    {noreply, State};
 handle_info({register_iq_handler, Host, XMLNS, Module, Function}, State) ->
-    ets:insert(?IQTABLE, {{XMLNS, Host}, Module, Function}),
+    ets:insert(?IQTABLE, {{XMLNS, ejabberd:normalize_host(Host)}, Module, Function}),
     catch mod_disco:register_feature(Host, XMLNS),
     {noreply, State};
 handle_info({register_iq_handler, Host, XMLNS, Module, Function, Opts}, State) ->
-    ets:insert(?IQTABLE, {{XMLNS, Host}, Module, Function, Opts}),
+    ets:insert(?IQTABLE, {{XMLNS, ejabberd:normalize_host(Host)}, Module, Function, Opts}),
     catch mod_disco:register_feature(Host, XMLNS),
     {noreply, State};
 handle_info({unregister_iq_handler, Host, XMLNS}, State) ->
-    case ets:lookup(?IQTABLE, {XMLNS, Host}) of
+    case ets:lookup(?IQTABLE, {XMLNS, ejabberd:normalize_host(Host)}) of
 	[{_, Module, Function, Opts}] ->
 	    gen_iq_handler:stop_iq_handler(Module, Function, Opts);
 	_ ->
 	    ok
     end,
-    ets:delete(?IQTABLE, {XMLNS, Host}),
+    ets:delete(?IQTABLE, {XMLNS, ejabberd:normalize_host(Host)}),
     catch mod_disco:unregister_feature(Host, XMLNS),
     {noreply, State};
 handle_info(refresh_iq_handlers, State) ->
@@ -244,6 +290,9 @@ handle_info(refresh_iq_handlers, State) ->
 	      end
       end, ets:tab2list(?IQTABLE)),
     {noreply, State};
+handle_info({timeout, _TRef, ID}, State) ->
+    spawn(fun() -> process_iq_timeout(ID) end),
+    {noreply, State};
 handle_info(_Info, State) ->
     {noreply, State}.
 
@@ -270,30 +319,62 @@ code_change(_OldVsn, State, _Extra) ->
 do_route(From, To, Packet) ->
     ?DEBUG("local route~n\tfrom ~p~n\tto ~p~n\tpacket ~P~n",
 	   [From, To, Packet, 8]),
+    
+    LNode = exmpp_jid:prep_node(To),
+    LResource = exmpp_jid:prep_resource(To),
     if
-	To#jid.luser /= "" ->
+	LNode /= undefined ->
 	    ejabberd_sm:route(From, To, Packet);
-	To#jid.lresource == "" ->
-	    {xmlelement, Name, _Attrs, _Els} = Packet,
-	    case Name of
-		"iq" ->
+	LResource == undefined ->
+	    case Packet of
+		_ when ?IS_IQ(Packet) ->
 		    process_iq(From, To, Packet);
-		"message" ->
+		_ when ?IS_MESSAGE(Packet) ->
 		    ok;
-		"presence" ->
+		_ when ?IS_PRESENCE(Packet) ->
 		    ok;
 		_ ->
 		    ok
 	    end;
 	true ->
-	    {xmlelement, _Name, Attrs, _Els} = Packet,
-	    case xml:get_attr_s("type", Attrs) of
-		"error" -> ok;
-		"result" -> ok;
+            case exmpp_stanza:get_type(Packet) of
+		<<"error">> -> ok;
+		<<"result">> -> ok;
 		_ ->
 		    ejabberd_hooks:run(local_send_to_resource_hook,
-				       To#jid.lserver,
+				       exmpp_jid:prep_domain(To),
 				       [From, To, Packet])
 	    end
 	end.
 
+get_iq_callback(ID) ->
+    case ets:lookup(iq_response, ID) of
+	[#iq_response{module = Module, timer = TRef,
+		      function = Function}] ->
+	    cancel_timer(TRef),
+	    ets:delete(iq_response, ID),
+	    {ok, Module, Function};
+	_ ->
+	    error
+    end.
+
+process_iq_timeout(ID) ->
+    case get_iq_callback(ID) of
+	{ok, undefined, Function} ->
+	    Function(timeout);
+	_ ->
+	    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

@@ -5,7 +5,7 @@
 %%% Created : 23 Oct 2003 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -31,7 +31,7 @@
 
 %% 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}).
 
@@ -117,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),
@@ -126,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]))
@@ -145,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),
@@ -154,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]);
@@ -171,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"]);
@@ -183,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);
@@ -192,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
@@ -206,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

@@ -9,7 +9,7 @@
 %%% Created : 29 Nov 2006 by Mickael Remond <mremond@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -20,7 +20,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -31,62 +31,51 @@
 -module(ejabberd_loglevel).
 -author('mickael.remond@process-one.net').
 
--export([set/1]).
+-export([set/1, get/0]).
+
+-include("ejabberd.hrl").
 
 -define(LOGMODULE, "error_logger").
 
 %% Error levels:
-%% 0 -> No log
-%% 1 -> Critical
-%% 2 -> Error
-%% 3 -> Warning
-%% 4 -> Info
-%% 5 -> Debug
+-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) ->
-   Forms = compile_string(?LOGMODULE, ejabberd_logger_src(Loglevel)),
-   load_logger(Forms, ?LOGMODULE, 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").
-                
-%% --------------------------------------------------------------  
-%% Compile a string into a module and returns the binary
-compile_string(Mod, Str) ->
-    Fname = Mod ++ ".erl",
-    {ok, Fd} = open_ram_file(Fname),
-    file:write(Fd, Str),
-    file:position(Fd, 0),
-    case epp_dodger:parse(Fd) of
-	{ok, Tree} ->
-	    Forms = revert_tree(Tree),
-	    close_ram_file(Fd),
-	    Forms;
-	Error ->
-	    close_ram_file(Fd),
-	    Error
-    end.
-   
-open_ram_file(Fname) ->
-    ram_file_io_server:start(self(), Fname, [read,write]).
 
-close_ram_file(Fd) ->
-    file:close(Fd).
-
-revert_tree(Tree) ->
-    [erl_syntax:revert(T) || T <- Tree].
-
-load_logger(Forms, Mod, Loglevel) ->
-    Fname = Mod ++ ".erl",
-    case compile:forms(Forms, [binary, {d,'LOGLEVEL',Loglevel}]) of
-        {ok, M, Bin} ->
-            code:load_binary(M, Fname, Bin);
-        Error ->
-            io:format("Error ~p~n", [Error])
+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.        
+%% very efficient code.
 ejabberd_logger_src(Loglevel) ->
     L = integer_to_list(Loglevel),
     "-module(ejabberd_logger).
@@ -96,7 +85,10 @@ ejabberd_logger_src(Loglevel) ->
              info_msg/4,
              warning_msg/4,
              error_msg/4,
-             critical_msg/4]).
+             critical_msg/4,
+             get/0]).
+
+   get() -> "++ L ++".
 
     %% Helper functions
     debug_msg(Module, Line, Format, Args) when " ++ L ++ " >= 5 ->

src/ejabberd_node_groups.erl

@@ -5,7 +5,7 @@
 %%% Created :  1 Nov 2006 by Alexey Shchepin <alexey@process-one.net>
 %%%
 %%%
-%%% ejabberd, Copyright (C) 2002-2007   Process-one
+%%% 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
@@ -16,7 +16,7 @@
 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 %%% General Public License for more details.
-%%%                         
+%%%
 %%% You should have received a copy of the GNU General Public License
 %%% along with this program; if not, write to the Free Software
 %%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
@@ -31,6 +31,7 @@
 
 %% API
 -export([start_link/0,
+	 start/0,
 	 join/1,
 	 leave/1,
 	 get_members/1,
@@ -40,7 +41,7 @@
 -export([init/1, handle_call/3, handle_cast/2, handle_info/2,
 	 terminate/2, code_change/3]).
 
--record(state, {}).
+-record(state, {groups = []}).
 
 %%====================================================================
 %% API
@@ -49,6 +50,15 @@
 %% Function: start_link() -> {ok,Pid} | ignore | {error,Error}
 %% Description: Starts the server
 %%--------------------------------------------------------------------
+start() ->
+    ChildSpec = {?MODULE,
+		 {?MODULE, start_link, []},
+		 permanent,
+		 brutal_kill,
+		 worker,
+		 [?MODULE]},
+    supervisor:start_child(ejabberd_sup, ChildSpec).
+
 start_link() ->
     gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
 
@@ -81,30 +91,19 @@ get_closest_node(Name) ->
 %% Description: Initiates the server
 %%--------------------------------------------------------------------
 init([]) ->
-    {FE, BE} =
+    Groups =
 	case ejabberd_config:get_local_option(node_type) of
 	    frontend ->
-		{true, false};
+		[frontend];
 	    backend ->
-		{false, true};
+		[backend];
 	    generic ->
-		{true, true};
+		[frontend, backend];
 	    undefined ->
-		{true, true}
+		[frontend, backend]
 	end,
-    if
-	FE ->
-	    join(frontend);
-	true ->
-	    ok
-    end,
-    if
-	BE ->
-	    join(backend);
-	true ->
-	    ok
-    end,
-    {ok, #state{}}.
+    lists:foreach(fun join/1, Groups),
+    {ok, #state{groups = Groups}}.
 
 %%--------------------------------------------------------------------
 %% Function: %% handle_call(Request, From, State) -> {reply, Reply, State} |
@@ -144,7 +143,8 @@ handle_info(_Info, State) ->
 %% cleaning up. When it returns, the gen_server terminates with Reason.
 %% The return value is ignored.
 %%--------------------------------------------------------------------
-terminate(_Reason, _State) ->
+terminate(_Reason, #state{groups = Groups}) ->
+    lists:foreach(fun leave/1, Groups),
     ok.
 
 %%--------------------------------------------------------------------

src/ejabberd_piefxis.erl

@@ -0,0 +1,651 @@
+%%%----------------------------------------------------------------------
+%%% 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:
+%%% - 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 mod_private.erl
+-record(private_storage, {user_host_ns, 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) ->
+    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=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, User, 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(?BTL(User),?BTL(Domain),?BTL(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]) of
+	{ok, M} ->
+	    case M:set_items(User, Domain, 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("Module not loaded: mod_roster ~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]) of
+	{ok, M}  ->  FullUser = exmpp_jid:make(User, Domain),
+		     IQ = #iq{kind=request, 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("Module not loaded: mod_vcard ~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]) of
+	{ok, M} ->
+	    ok = exmpp_xml:foreach(
+		   fun (_Element, {xmlcdata, _}) ->
+			   ok;
+		       (_Element, Child) ->
+			   From  = exmpp_xml:get_attribute(Child,from,none),
+			   FullFrom = exmpp_jid:parse(From),
+			   FullUser = exmpp_jid:make(User, Domain),
+			   _R = M:store_packet(FullFrom, FullUser, Child)
+		   end, El), io:format(" DONE.~n",[]);
+	_ ->
+	    io:format(" ERROR.~n",[]),
+	    ?ERROR_MSG("Module not loaded: mod_offline ~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]) of
+	{ok, M} ->
+	    FullUser = exmpp_jid:make(User, Domain),
+	    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("Module not loaded: mod_private ~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) when is_binary(Domain) ->
+    loaded_module(?BTL(Domain),Options);
+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.
+
+%%%==================================
+
+%%%% 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 when is_list(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]) of
+	{ok, M} ->
+	    From = To = exmpp_jid:make(Username, Host, ""),
+	    SubelGet = exmpp_xml:element(?NS_ROSTER, 'query', [], []),
+	    IQGet = #iq{kind=request, type=get, ns=?NS_ROSTER, payload=SubelGet},
+	    Res = M:process_local_iq(From, To, IQGet),
+	    case Res#iq.payload of
+		undefined -> "";
+		El -> exmpp_xml:document_to_list(El)
+	    end;
+	_E ->
+	    ""
+    end;
+
+extract_user_info(offline, Username, Host) ->
+    case loaded_module(Host,[mod_offline]) of
+	{ok, mod_offline} ->
+	    Els = mnesia_pop_offline_messages([], Username, Host),
+	    case Els of
+		[] -> "";
+		Els ->
+                    OfEl = #xmlel{name = 'offline-messages',
+                                  children = Els},
+		    %OfEl = {xmlelement, "offline-messages", [], Els},
+		    exmpp_xml:document_to_list(OfEl)
+	    end;
+	_E ->
+	    ""
+    end;
+
+extract_user_info(private, Username, Host) ->
+    case loaded_module(Host,[mod_private]) of
+	{ok, mod_private} ->
+	    get_user_private_mnesia(Username, Host);
+	_E ->
+	    ""
+    end;
+
+extract_user_info(vcard, Username, Host) ->
+    case loaded_module(Host,[mod_vcard]) of
+	{ok, M} ->
+	    From = To = exmpp_jid:make(Username, Host, ""),
+	    SubelGet = exmpp_xml:element(?NS_VCARD, 'vCard', [], []),
+	    IQGet = #iq{kind=request, type=get, ns=?NS_VCARD, payload=SubelGet},
+	    Res = M:process_sm_iq(From, To, IQGet),
+	    case Res#iq.payload of
+		undefined -> "";
+		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, {user_host, timestamp, expire, from, to, packet}).
+mnesia_pop_offline_messages(Ls, User, Server) ->
+    try
+	LUser = User,
+	LServer = 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 = make_timestamp(),
+		Ls ++ lists:map(
+			fun(R) ->
+				[Packet] = exmpp_xml:parse_document(R#offline_msg.packet, [names_as_atom]),
+				FromString = exmpp_jid:prep_to_list(R#offline_msg.from),
+				Packet2 = exmpp_xml:set_attribute(Packet, "from", FromString),
+				Packet3 = Packet2#xmlel{ns = ?NS_JABBER_CLIENT},
+				exmpp_xml:append_children(
+				  Packet3,
+				  [jlib:timestamp_to_xml(
+				     calendar:gregorian_seconds_to_datetime(
+				       R#offline_msg.timestamp),
+				     utc,
+				     exmpp_jid:make("", Server, ""),
+				     "Offline Storage"),
+				   %% TODO: Delete the next three lines once XEP-0091 is Obsolete
+				   jlib:timestamp_to_xml(
+				     calendar:gregorian_seconds_to_datetime(
+				       R#offline_msg.timestamp))]
+				 )
+			end,
+			lists:filter(
+			  fun(R) ->
+				  case R#offline_msg.expire of
+				      0 ->
+					  true;
+				      TimeStamp ->
+					  TS < TimeStamp
+				  end
+			  end,
+			  lists:keysort(#offline_msg.timestamp, Rs)));
+	    _ ->
+		Ls
+	end
+    catch
+	_ ->
+	    Ls
+    end.
+
+make_timestamp() ->
+    {MegaSecs, Secs, _MicroSecs} = now(),
+    MegaSecs * 1000000 + Secs.
+
+%%%==================================
+%%%% Interface with ejabberd private storage
+
+get_user_private_mnesia(Username, Host) ->
+    ListNsEl = mnesia:dirty_select(private_storage,
+				   [{#private_storage{user_host_ns={?LTB(Username), ?LTB(Host), '$1'}, xml = '$2'},
+				     [], ['$$']}]),
+    Els = [lists:flatten(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: