100 lines
3.7 KiB
Erlang
100 lines
3.7 KiB
Erlang
%%--------------------------------------------------------------------
|
|
%% Copyright (c) 2020-2022 EMQ Technologies Co., Ltd. All Rights Reserved.
|
|
%%
|
|
%% Licensed under the Apache License, Version 2.0 (the "License");
|
|
%% you may not use this file except in compliance with the License.
|
|
%% You may obtain a copy of the License at
|
|
%%
|
|
%% http://www.apache.org/licenses/LICENSE-2.0
|
|
%%
|
|
%% Unless required by applicable law or agreed to in writing, software
|
|
%% distributed under the License is distributed on an "AS IS" BASIS,
|
|
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
%% See the License for the specific language governing permissions and
|
|
%% limitations under the License.
|
|
%%--------------------------------------------------------------------
|
|
|
|
-module(emqx_auto_subscribe_api).
|
|
|
|
-behaviour(minirest_api).
|
|
|
|
-export([api_spec/0]).
|
|
|
|
-export([auto_subscribe/2]).
|
|
|
|
-define(INTERNAL_ERROR, 'INTERNAL_ERROR').
|
|
-define(EXCEED_LIMIT, 'EXCEED_LIMIT').
|
|
-define(BAD_REQUEST, 'BAD_REQUEST').
|
|
|
|
-include_lib("emqx/include/emqx_placeholder.hrl").
|
|
|
|
api_spec() ->
|
|
{[auto_subscribe_api()], []}.
|
|
|
|
schema() ->
|
|
case emqx_mgmt_api_configs:gen_schema(emqx:get_config([auto_subscribe, topics])) of
|
|
#{example := <<>>, type := string} ->
|
|
emqx_mgmt_util:schema(auto_subscribe_conf_example());
|
|
Example ->
|
|
emqx_mgmt_util:schema(Example)
|
|
end.
|
|
|
|
auto_subscribe_conf_example() ->
|
|
#{
|
|
type => array,
|
|
items => #{
|
|
type => object,
|
|
properties =>#{
|
|
topic => #{
|
|
type => string,
|
|
example => <<
|
|
"/clientid/", ?PH_S_CLIENTID,
|
|
"/username/", ?PH_S_USERNAME,
|
|
"/host/", ?PH_S_HOST,
|
|
"/port/", ?PH_S_PORT>>},
|
|
qos => #{example => 0, type => number, enum => [0, 1, 2]},
|
|
rh => #{example => 0, type => number, enum => [0, 1, 2]},
|
|
nl => #{example => 0, type => number, enum => [0, 1]},
|
|
rap => #{example => 0, type => number, enum => [0, 1]}
|
|
}
|
|
}
|
|
}.
|
|
|
|
auto_subscribe_api() ->
|
|
Metadata = #{
|
|
get => #{
|
|
description => <<"Auto subscribe list">>,
|
|
responses => #{
|
|
<<"200">> => schema()}},
|
|
put => #{
|
|
description => <<"Update auto subscribe topic list">>,
|
|
'requestBody' => schema(),
|
|
responses => #{
|
|
<<"200">> => schema(),
|
|
<<"400">> => emqx_mgmt_util:error_schema(
|
|
<<"Request body required">>, [?BAD_REQUEST]),
|
|
<<"409">> => emqx_mgmt_util:error_schema(
|
|
<<"Auto Subscribe topics max limit">>, [?EXCEED_LIMIT])}}
|
|
},
|
|
{"/mqtt/auto_subscribe", Metadata, auto_subscribe}.
|
|
|
|
%%%==============================================================================================
|
|
%% api apply
|
|
auto_subscribe(get, _) ->
|
|
{200, emqx_auto_subscribe:list()};
|
|
|
|
auto_subscribe(put, #{body := #{}}) ->
|
|
{400, #{code => ?BAD_REQUEST, message => <<"Request body required">>}};
|
|
auto_subscribe(put, #{body := Params}) ->
|
|
case emqx_auto_subscribe:update(Params) of
|
|
{error, quota_exceeded} ->
|
|
Message = list_to_binary(io_lib:format("Max auto subscribe topic count is ~p",
|
|
[emqx_auto_subscribe:max_limit()])),
|
|
{409, #{code => ?EXCEED_LIMIT, message => Message}};
|
|
{error, Reason} ->
|
|
Message = list_to_binary(io_lib:format("Update config failed ~p", [Reason])),
|
|
{500, #{code => ?INTERNAL_ERROR, message => Message}};
|
|
{ok, NewTopics} ->
|
|
{200, NewTopics}
|
|
end.
|