Merge pull request #4357 from badlop/adhoc_api

New mod_adhoc_api and related improvements

Author: badlop

ejabberd.yml.example

@@ -118,7 +118,12 @@ api_permissions:
     from: ejabberd_web_admin
     who: admin
     what: "*"
-  "admin access":
+  "adhoc commands":
+    from: mod_adhoc_api
+    who: admin
+    what: "*"
+  "http access":
+    from: mod_http_api
     who:
       access:
         allow:
@@ -159,6 +164,7 @@ shaper_rules:
 
 modules:
   mod_adhoc: {}
+  mod_adhoc_api: {}
   mod_admin_extra: {}
   mod_announce:
     access: announce

src/ejabberd_access_permissions.erl

@@ -344,10 +344,20 @@ validator(from) ->
     fun(L) when is_list(L) ->
 	    lists:map(
 	      fun({K, V}) -> {(econf:enum([tag]))(K), (econf:binary())(V)};
-		 (A) -> (econf:enum([ejabberd_xmlrpc, mod_cron, mod_http_api, ejabberd_ctl, ejabberd_web_admin]))(A)
+		 (A) -> (econf:enum([ejabberd_ctl,
+                                     ejabberd_web_admin,
+                                     ejabberd_xmlrpc,
+                                     mod_adhoc_api,
+                                     mod_cron,
+                                     mod_http_api]))(A)
 	      end, lists:flatten(L));
        (A) ->
-	    [(econf:enum([ejabberd_xmlrpc, mod_cron, mod_http_api, ejabberd_ctl, ejabberd_web_admin]))(A)]
+	    [(econf:enum([ejabberd_ctl,
+                          ejabberd_web_admin,
+                          ejabberd_xmlrpc,
+                          mod_adhoc_api,
+                          mod_cron,
+                          mod_http_api]))(A)]
     end;
 validator(what) ->
     econf:and_then(

src/ejabberd_admin.erl

@@ -598,8 +598,9 @@ get_commands_spec() ->
 			args = [{node, atom}, {table, binary}, {page, integer}],
 			result = {res, any}},
 
-     #ejabberd_commands{name = mnesia_list_tables, tags = [internal, mnesia],
+     #ejabberd_commands{name = mnesia_list_tables, tags = [mnesia],
                         desc = "List of Mnesia tables",
+			note = "added in 25.xx",
                         module = ?MODULE, function = mnesia_list_tables,
 			result = {tables, {list, {table, {tuple, [{name, atom},
                                                                 {storage_type, binary},
@@ -615,8 +616,10 @@ get_commands_spec() ->
                                                                 {value, binary}
                                                                ]}}}}},
 
-     #ejabberd_commands{name = mnesia_table_change_storage, tags = [internal, mnesia],
-                        desc = "Change storage type of a Mnesia table to: ram_copies, disc_copies, or disc_only_copies.",
+     #ejabberd_commands{name = mnesia_table_change_storage, tags = [mnesia],
+                        desc = "Change storage type of a Mnesia table",
+			note = "added in 25.xx",
+			longdesc = "Storage type can be: `ram_copies`, `disc_copies`, `disc_only_copies`, `remote_copy`.",
                         module = ?MODULE, function = mnesia_table_change_storage,
 			args = [{table, binary}, {storage_type, binary}],
 			result = {res, restuple}},
@@ -1281,13 +1284,12 @@ is_my_host(Host) ->
 
 %% @format-begin
 
-%% mnesia:del_table_copy(Table, Node);
-%% mnesia:change_table_copy_type(Table, Node, Type);
-
 mnesia_table_change_storage(STable, SType) ->
     Table = binary_to_existing_atom(STable, latin1),
     Type =
         case SType of
+            <<"remote_copy">> ->
+                remote_copy;
             <<"ram_copies">> ->
                 ram_copies;
             <<"disc_copies">> ->
@@ -1297,7 +1299,24 @@ mnesia_table_change_storage(STable, SType) ->
             _ ->
                 false
         end,
-    mnesia:add_table_copy(Table, node(), Type).
+    Node = node(),
+    Result =
+        case Type of
+            false ->
+                "Nothing to do";
+            remote_copy ->
+                mnesia:del_table_copy(Table, Node),
+                "Deleted table copy";
+            _ ->
+                case mnesia:add_table_copy(Table, Node, Type) of
+                    {aborted, _} ->
+                        mnesia:change_table_copy_type(Table, Node, Type),
+                        "Changed table copy type";
+                    _ ->
+                        "Added table copy"
+                end
+        end,
+    {ok, Result}.
 
 mnesia_table_clear(STable) ->
     Table = binary_to_existing_atom(STable, latin1),

src/ejabberd_commands.erl

@@ -33,6 +33,7 @@
 -export([start_link/0,
 	 list_commands/0,
 	 list_commands/1,
+	 list_commands/2,
 	 get_command_format/1,
 	 get_command_format/2,
 	 get_command_format/3,
@@ -42,7 +43,9 @@
 	 get_tags_commands/1,
 	 register_commands/1,
 	 register_commands/2,
+	 register_commands/3,
 	 unregister_commands/1,
+	 unregister_commands/3,
 	 get_commands_spec/0,
 	 get_commands_definition/0,
 	 get_commands_definition/1,
@@ -142,19 +145,34 @@ code_change(_OldVsn, State, _Extra) ->
 register_commands(Commands) ->
     register_commands(unknown, Commands).
 
+-spec register_commands(atom(), [ejabberd_commands()]) -> ok.
+
 register_commands(Definer, Commands) ->
+    ExistingCommands = list_commands(),
     lists:foreach(
       fun(Command) ->
-              %% XXX check if command exists
-              mnesia:dirty_write(register_command_prepare(Command, Definer))
-              %% ?DEBUG("This command is already defined:~n~p", [Command])
+              Name = Command#ejabberd_commands.name,
+              case lists:keyfind(Name, 1, ExistingCommands) of
+                  false ->
+                      mnesia:dirty_write(register_command_prepare(Command, Definer));
+                  _ ->
+                      OtherCommandDef = get_command_definition(Name),
+                      ?CRITICAL_MSG("Error trying to define a command: another one already exists with the same name:~n Existing: ~p~n New: ~p", [OtherCommandDef, Command])
+              end
       end,
       Commands),
     ejabberd_access_permissions:invalidate(),
     ok.
 
+-spec register_commands(binary(), atom(), [ejabberd_commands()]) -> ok.
 
-
+register_commands(Host, Definer, Commands) ->
+    case gen_mod:is_loaded_elsewhere(Host, Definer) of
+        false ->
+            register_commands(Definer, Commands);
+        true ->
+            ok
+    end.
 
 register_command_prepare(Command, Definer) ->
     Tags1 = Command#ejabberd_commands.tags,
@@ -175,6 +193,16 @@ unregister_commands(Commands) ->
       Commands),
     ejabberd_access_permissions:invalidate().
 
+-spec unregister_commands(binary(), atom(), [ejabberd_commands()]) -> ok.
+
+unregister_commands(Host, Definer, Commands) ->
+    case gen_mod:is_loaded_elsewhere(Host, Definer) of
+        false ->
+            unregister_commands(Commands);
+        true ->
+            ok
+    end.
+
 -spec list_commands() -> [{atom(), [aterm()], string()}].
 
 list_commands() ->
@@ -190,6 +218,16 @@ list_commands(Version) ->
                                               desc = Desc} <- Commands,
                            not lists:member(internal, Tags)].
 
+-spec list_commands(integer(), map()) -> [{atom(), [aterm()], string()}].
+
+list_commands(Version, CallerInfo) ->
+    lists:filter(
+      fun({Name, _Args, _Desc}) ->
+        allow == ejabberd_access_permissions:can_access(Name, CallerInfo)
+      end,
+      list_commands(Version)
+    ).
+
 -spec get_command_format(atom()) -> {[aterm()], [{atom(),atom()}], rterm()}.
 
 get_command_format(Name) ->