Add commands for new dataabase export/import

Author: prefiks

src/ejabberd_admin.erl

@@ -457,6 +457,70 @@ get_commands_spec() ->
 			result_desc = "Status text",
 			result_example = "Operation aborted"},
 
+     #ejabberd_commands{name = export_db, tags = [db],
+			desc = "Export database records for host to files",
+			note = "added in 25.XX",
+			module = ejabberd_db_serialize, function = export,
+			args_desc = ["Name of host that should be exported",
+				     "Directory name where exported files should be created"],
+			args_example = [<<"localhost">>, <<"/home/ejabberd/export">>],
+			args = [{host, binary}, {dir, binary}],
+			result = {res, restuple},
+			result_desc = "Result tuple",
+			result_example = {ok, <<"Export started">>}},
+     #ejabberd_commands{name = export_db_status, tags = [db],
+			desc = "Return current status of export operation",
+			note = "added in 22.XX",
+			module = ejabberd_db_serialize, function = export_status,
+			args_desc = ["Name of host where export is performed"],
+			args_example = [<<"localhost">>],
+			args = [{host, binary}],
+			result = {status, binary},
+			result_desc = "Current operation status",
+			result_example = "Operation in progress: 'Exporting mod_mam', exported 5000 records so far"},
+     #ejabberd_commands{name = export_db_abort, tags = [db],
+			desc = "Abort currently running export peration",
+			note = "added in 22.XX",
+			module = ejabberd_db_serialize, function = export_abort,
+			args_desc = ["Name of host where export is performed"],
+			args_example = [<<"localhost">>],
+			args = [{host, binary}],
+			result = {status, binary},
+			result_desc = "Operation status",
+			result_example = "Operation aborted"},
+
+     #ejabberd_commands{name = import_db, tags = [db],
+			desc = "Import database records for host to files",
+			note = "added in 25.XX",
+			module = ejabberd_db_serialize, function = import,
+			args_desc = ["Name of host that should be imported",
+				     "Directory name where imported files should be created"],
+			args_example = [<<"localhost">>, <<"/home/ejabberd/export">>],
+			args = [{host, binary}, {dir, binary}],
+			result = {res, restuple},
+			result_desc = "Result tuple",
+			result_example = {ok, <<"Import started">>}},
+     #ejabberd_commands{name = import_db_status, tags = [db],
+			desc = "Return current status of import operation",
+			note = "added in 22.XX",
+			module = ejabberd_db_serialize, function = import_status,
+			args_desc = ["Name of host where import is performed"],
+			args_example = [<<"localhost">>],
+			args = [{host, binary}],
+			result = {status, binary},
+			result_desc = "Current operation status",
+			result_example = "Operation in progress: 'Importing mod_mam', imported 5000 records so far"},
+     #ejabberd_commands{name = import_db_abort, tags = [db],
+			desc = "Abort currently running import peration",
+			note = "added in 22.XX",
+			module = ejabberd_db_serialize, function = import_abort,
+			args_desc = ["Name of host where import is performed"],
+			args_example = [<<"localhost">>],
+			args = [{host, binary}],
+			result = {status, binary},
+			result_desc = "Operation status",
+			result_example = "Operation aborted"},
+
      #ejabberd_commands{name = export2sql, tags = [mnesia],
 			desc = "Export virtual host information from Mnesia tables to SQL file",
 			longdesc = "Configure the modules to use SQL, then call this command. "
@@ -1027,13 +1091,13 @@ delete_old_messages_batch(Server, Days, BatchSize, Rate) ->
 					      {true, _} ->
 						  case Mod:remove_old_messages_batch(L, Da, B) of
 						      {ok, Count} ->
-							  {ok, S, Count};
+							  {ok, S, Count, undefined};
 						      {error, _} = E ->
 							  E
 						  end;
 					      {_, true} ->
 						  case Mod:remove_old_messages_batch(L, Da, B, IS) of
-						      {ok, IS2, Count} ->
+						      {ok, IS2, Count, undefined} ->
 							  {ok, {L, Da, B, IS2}, Count};
 						      {error, _} = E ->
 							  E
@@ -1056,13 +1120,13 @@ delete_old_messages_status(Server) ->
 	      {failed, Steps, Error} ->
 		  io_lib:format("Operation failed after deleting ~p messages with error ~p",
 				[Steps, misc:format_val(Error)]);
-	      {aborted, Steps} ->
+	      {aborted, Steps, _} ->
 		  io_lib:format("Operation was aborted after deleting ~p messages",
 				[Steps]);
-	      {working, Steps} ->
+	      {working, Steps, _} ->
 		  io_lib:format("Operation in progress, deleted ~p messages",
 				[Steps]);
-	      {completed, Steps} ->
+	      {completed, Steps, _} ->
 		  io_lib:format("Operation was completed after deleting ~p messages",
 				[Steps])
 	  end,

src/ejabberd_batch.erl

@@ -41,7 +41,7 @@
 -define(SERVER, ?MODULE).
 
 -record(state, {tasks = #{}}).
--record(task, {state = not_started, pid, steps, done_steps}).
+-record(task, {state = not_started, pid, steps, done_steps, last_message}).
 
 %%%===================================================================
 %%% API
@@ -99,14 +99,14 @@ handle_call({task_status, Type}, _From, #state{tasks = Tasks} = State) ->
 	    {reply, not_started, State};
 	#task{state = not_started} ->
 	    {reply, not_started, State};
-	#task{state = failed, done_steps = Steps, pid = Error} ->
+	#task{state = failed, done_steps = Steps, last_message = Error} ->
 	    {reply, {failed, Steps, Error}, State};
-	#task{state = aborted, done_steps = Steps} ->
-	    {reply, {aborted, Steps}, State};
-	#task{state = working, done_steps = Steps} ->
-	    {reply, {working, Steps}, State};
-	#task{state = completed, done_steps = Steps} ->
-	    {reply, {completed, Steps}, State}
+	#task{state = aborted, done_steps = Steps, last_message = Msg} ->
+	    {reply, {aborted, Steps, Msg}, State};
+	#task{state = working, done_steps = Steps, last_message = Msg} ->
+	    {reply, {working, Steps, Msg}, State};
+	#task{state = completed, done_steps = Steps, last_message = Msg} ->
+	    {reply, {completed, Steps, Msg}, State}
     end;
 handle_call({abort_task, Type}, _From, #state{tasks = Tasks} = State) ->
     case maps:get(Type, Tasks, none) of
@@ -126,26 +126,26 @@ handle_call(_Request, _From, State = #state{}) ->
     {noreply, NewState :: #state{}} |
     {noreply, NewState :: #state{}, timeout() | hibernate} |
     {stop, Reason :: term(), NewState :: #state{}}).
-handle_cast({task_finished, Type, Pid}, #state{tasks = Tasks} = State) ->
+handle_cast({task_finished, Type, Pid, Msg}, #state{tasks = Tasks} = State) ->
     case maps:get(Type, Tasks, none) of
 	#task{state = working, pid = Pid2} = T when Pid == Pid2  ->
-	    Tasks2 = maps:put(Type, T#task{state = completed, pid = none}, Tasks),
+	    Tasks2 = maps:put(Type, T#task{state = completed, pid = none, last_message = Msg}, Tasks),
 	    {noreply, State#state{tasks = Tasks2}};
 	_ ->
 	    {noreply, State}
     end;
-handle_cast({task_progress, Type, Pid, Count}, #state{tasks = Tasks} = State) ->
+handle_cast({task_progress, Type, Pid, Count, Msg}, #state{tasks = Tasks} = State) ->
     case maps:get(Type, Tasks, none) of
 	#task{state = working, pid = Pid2, done_steps = Steps} = T when Pid == Pid2  ->
-	    Tasks2 = maps:put(Type, T#task{done_steps = Steps + Count}, Tasks),
+	    Tasks2 = maps:put(Type, T#task{done_steps = Steps + Count, last_message = Msg}, Tasks),
 	    {noreply, State#state{tasks = Tasks2}};
 	_ ->
 	    {noreply, State}
     end;
 handle_cast({task_error, Type, Pid, Error}, #state{tasks = Tasks} = State) ->
     case maps:get(Type, Tasks, none) of
 	#task{state = working, pid = Pid2} = T when Pid == Pid2  ->
-	    Tasks2 = maps:put(Type, T#task{state = failed, pid = Error}, Tasks),
+	    Tasks2 = maps:put(Type, T#task{state = failed, last_message = Error}, Tasks),
 	    {noreply, State#state{tasks = Tasks2}};
 	_ ->
 	    {noreply, State}
@@ -186,20 +186,24 @@ code_change(_OldVsn, State = #state{}, _Extra) ->
 
 work_loop(Task, JobState, JobFun, Rate, StartDate, CurrentProgress) ->
     try JobFun(JobState) of
-	{ok, _NewState, 0} ->
-	    gen_server:cast(?MODULE, {task_finished, Task, self()});
-	{ok, NewState, Count} ->
-	    gen_server:cast(?MODULE, {task_progress, Task, self(), Count}),
+	{ok, _NewState, 0, Msg} ->
+	    gen_server:cast(?MODULE, {task_finished, Task, self(), Msg});
+	{ok, NewState, Count, Msg} ->
+	    gen_server:cast(?MODULE, {task_progress, Task, self(), Count, Msg}),
 	    NewProgress = CurrentProgress + Count,
-	    TimeSpent = erlang:monotonic_time(second) - StartDate,
-	    SleepTime = max(0, NewProgress/Rate*60 - TimeSpent),
+	    SleepTime = case Rate of
+			    infinity -> 0;
+			    _ ->
+				TimeSpent = erlang:monotonic_time(second) - StartDate,
+				max(0, NewProgress/Rate*60 - TimeSpent)
+			end,
 	    receive
 		abort -> ok
 	    after round(SleepTime*1000) ->
 		work_loop(Task, NewState, JobFun, Rate, StartDate, NewProgress)
 	    end;
 	{error, Error} ->
 	    gen_server:cast(?MODULE, {task_error, Task, self(), Error})
-    catch _:_ ->
-	gen_server:cast(?MODULE, {task_error, Task, self(), internal_error})
+    catch T:E:S ->
+	gen_server:cast(?MODULE, {task_error, Task, self(), {internal_error, T, E, S}})
     end.