/
mod_http_upload.erl
272 lines (217 loc) · 11.6 KB
/
mod_http_upload.erl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
%%==============================================================================
%% Copyright 2016 Erlang Solutions Ltd.
%%
%% 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(mod_http_upload).
-author('konrad.zemek@erlang-solutions.com').
-behaviour(gen_mod).
-xep([{xep, 363}, {version, "0.2.5"}]).
-xep([{xep, 363}, {version, "0.3.0"}]).
-include("jlib.hrl").
-include("ejabberd.hrl").
-define(DEFAULT_TOKEN_BYTES, 32).
-define(DEFAULT_MAX_FILE_SIZE, 10 * 1024 * 1024). % 10 MB
-define(DEFAULT_SUBHOST, <<"upload.@HOST@">>).
-export([start/2, stop/1, iq_handler/3]).
%% Hook implementations
-export([get_disco_identity/5, get_disco_items/5, get_disco_features/5, get_disco_info/5]).
%%--------------------------------------------------------------------
%% Callbacks
%%--------------------------------------------------------------------
-callback create_slot(UTCDateTime :: calendar:datetime(), UUID :: binary(),
Filename :: unicode:unicode_binary(), ContentType :: binary(),
Size :: pos_integer(), Opts :: proplists:proplist()) ->
{PUTURL :: binary(), GETURL :: binary(), Headers :: #{binary() => binary()}}.
%%--------------------------------------------------------------------
%% API
%%--------------------------------------------------------------------
-spec start(Host :: ejabberd:server(), Opts :: list()) -> any().
start(Host, Opts) ->
IQDisc = gen_mod:get_opt(iqdisc, Opts, one_queue),
SubHost = subhost(Host),
mod_disco:register_subhost(Host, SubHost),
mongoose_subhosts:register(Host, SubHost),
ejabberd_hooks:add(disco_local_features, SubHost, ?MODULE, get_disco_features, 90),
ejabberd_hooks:add(disco_local_identity, SubHost, ?MODULE, get_disco_identity, 90),
ejabberd_hooks:add(disco_info, SubHost, ?MODULE, get_disco_info, 90),
ejabberd_hooks:add(disco_local_items, Host, ?MODULE, get_disco_items, 90),
gen_iq_handler:add_iq_handler(ejabberd_local, SubHost, ?NS_HTTP_UPLOAD_025, ?MODULE,
iq_handler, IQDisc),
gen_iq_handler:add_iq_handler(ejabberd_local, SubHost, ?NS_HTTP_UPLOAD_030, ?MODULE,
iq_handler, IQDisc),
gen_mod:start_backend_module(?MODULE, with_default_backend(Opts), [create_slot]).
-spec stop(Host :: ejabberd:server()) -> any().
stop(Host) ->
SubHost = subhost(Host),
gen_iq_handler:remove_iq_handler(ejabberd_local, SubHost, ?NS_HTTP_UPLOAD_030),
gen_iq_handler:remove_iq_handler(ejabberd_local, SubHost, ?NS_HTTP_UPLOAD_025),
ejabberd_hooks:delete(disco_local_items, Host, ?MODULE, get_disco_items, 90),
ejabberd_hooks:delete(disco_info, SubHost, ?MODULE, get_disco_info, 90),
ejabberd_hooks:delete(disco_local_identity, SubHost, ?MODULE, get_disco_identity, 90),
ejabberd_hooks:delete(disco_local_features, SubHost, ?MODULE, get_disco_features, 90),
mongoose_subhosts:unregister(SubHost),
mod_disco:unregister_subhost(Host, SubHost).
-spec iq_handler(From :: ejabberd:jid(), To :: ejabberd:jid(), IQ :: ejabberd:iq()) ->
ejabberd:iq() | ignore.
iq_handler(_From, _To, IQ = #iq{type = set, sub_el = SubEl}) ->
IQ#iq{type = error, sub_el = [SubEl, ?ERR_NOT_ALLOWED]};
iq_handler(_From, _To = #jid{lserver = SubHost}, IQ = #iq{type = get, sub_el = Request}) ->
{ok, Host} = mongoose_subhosts:get_host(SubHost),
case parse_request(Request) of
{Filename, Size, ContentType, Namespace} ->
MaxFileSize = max_file_size(Host),
case MaxFileSize =:= undefined orelse Size =< MaxFileSize of
true ->
UTCDateTime = calendar:universal_time(),
Token = generate_token(Host),
Opts = module_opts(Host),
{PutUrl, GetUrl, Headers} =
mod_http_upload_backend:create_slot(UTCDateTime, Token, Filename,
ContentType, Size, Opts),
compose_iq_reply(IQ, Namespace, PutUrl, GetUrl, Headers);
false ->
IQ#iq{type = error, sub_el = [file_too_large_error(MaxFileSize, Namespace)]}
end;
bad_request ->
IQ#iq{type = error, sub_el = [Request, ?ERR_BAD_REQUEST]}
end.
-spec get_disco_identity(Acc :: term(), From :: ejabberd:jid(), To :: ejabberd:jid(),
Node :: binary(), ejabberd:lang()) -> [jlib:xmlel()] | term().
get_disco_identity(Acc, _From, _To, _Node = <<>>, Lang) ->
[#xmlel{name = <<"identity">>,
attrs = [{<<"category">>, <<"store">>},
{<<"type">>, <<"file">>},
{<<"name">>, my_disco_name(Lang)}]} | Acc];
get_disco_identity(Acc, _From, _To, _Node, _Lang) ->
Acc.
-spec get_disco_items(Acc :: term(), From :: ejabberd:jid(), To :: ejabberd:jid(),
Node :: binary(), ejabberd:lang()) -> {result, [jlib:xmlel()]} | term().
get_disco_items({result, Nodes}, _From, #jid{lserver = Host} = _To, <<"">>, Lang) ->
Item = #xmlel{name = <<"item">>,
attrs = [{<<"jid">>, subhost(Host)}, {<<"name">>, my_disco_name(Lang)}]},
{result, [Item | Nodes]};
get_disco_items(empty, From, To, Node, Lang) ->
get_disco_items({result, []}, From, To, Node, Lang);
get_disco_items(Acc, _From, _To, _Node, _Lang) ->
Acc.
-spec get_disco_features(Acc :: term(), From :: ejabberd:jid(), To :: ejabberd:jid(),
Node :: binary(), ejabberd:lang()) -> {result, [jlib:xmlel()]} | term().
get_disco_features({result, Nodes}, _From, _To, _Node = <<>>, _Lang) ->
{result, [?NS_HTTP_UPLOAD_025, ?NS_HTTP_UPLOAD_030 | Nodes]};
get_disco_features(empty, From, To, Node, Lang) ->
get_disco_features({result, []}, From, To, Node, Lang);
get_disco_features(Acc, _From, _To, _Node, _Lang) ->
Acc.
-spec get_disco_info(Acc :: [jlib:xmlel()], ejabberd:server(), module(), Node :: binary(),
Lang :: ejabberd:lang()) -> [jlib:xmlel()].
get_disco_info(Acc, SubHost, _Mod, _Node = <<>>, _Lang) ->
{ok, Host} = mongoose_subhosts:get_host(SubHost),
case max_file_size(Host) of
undefined -> Acc;
MaxFileSize ->
MaxFileSizeBin = integer_to_binary(MaxFileSize),
[get_disco_info_form(?NS_HTTP_UPLOAD_025, MaxFileSizeBin),
get_disco_info_form(?NS_HTTP_UPLOAD_030, MaxFileSizeBin) | Acc]
end;
get_disco_info(Acc, _Host, _Mod, _Node, _Lang) ->
Acc.
%%--------------------------------------------------------------------
%% Helpers
%%--------------------------------------------------------------------
-spec subhost(Host :: ejabberd:server()) -> binary().
subhost(Host) ->
gen_mod:get_module_opt_subhost(Host, ?MODULE, ?DEFAULT_SUBHOST).
-spec my_disco_name(ejabberd:lang()) -> binary().
my_disco_name(Lang) ->
translate:translate(Lang, <<"HTTP File Upload">>).
-spec compose_iq_reply(IQ :: ejabberd:iq(), Namespace :: binary(),
PutUrl :: binary(), GetUrl :: binary(),
Headers :: #{binary() => binary()}) ->
Reply :: ejabberd:iq().
compose_iq_reply(IQ, Namespace, PutUrl, _GetUrl, Headers) ->
Slot = #xmlel{
name = <<"slot">>,
attrs = [{<<"xmlns">>, Namespace}],
children = [create_url_xmlel(<<"put">>, PutUrl, Headers, Namespace),
create_url_xmlel(<<"get">>, GetUrl, #{}, Namespace)]},
IQ#iq{type = result, sub_el =[Slot]}.
-spec token_bytes(ejabberd:server()) -> pos_integer().
token_bytes(Host) ->
gen_mod:get_module_opt(Host, ?MODULE, token_bytes, ?DEFAULT_TOKEN_BYTES).
-spec max_file_size(ejabberd:server()) -> pos_integer() | undefined.
max_file_size(Host) ->
gen_mod:get_module_opt(Host, ?MODULE, max_file_size, ?DEFAULT_MAX_FILE_SIZE).
-spec with_default_backend(Opts :: proplists:proplist()) -> proplists:proplist().
with_default_backend(Opts) ->
case lists:keyfind(backend, 1, Opts) of
false -> [{backend, s3} | Opts];
_ -> Opts
end.
-spec module_opts(ejabberd:server()) -> proplists:proplist().
module_opts(Host) ->
gen_mod:get_module_opts(Host, ?MODULE).
-spec generate_token(ejabberd:server()) -> binary().
generate_token(Host) ->
base16:encode(crypto:strong_rand_bytes(token_bytes(Host))).
-spec file_too_large_error(MaxFileSize :: non_neg_integer(), Namespace :: binary()) -> jlib:exml().
file_too_large_error(MaxFileSize, Namespace) ->
MaxFileSizeBin = integer_to_binary(MaxFileSize),
MaxSizeEl = #xmlel{name = <<"max-file-size">>,
children = [#xmlcdata{content = MaxFileSizeBin}]},
FileTooLargeEl = #xmlel{name = <<"file-too-large">>,
attrs = [{<<"xmlns">>, Namespace}],
children = [MaxSizeEl]},
Error0 = ?ERR_NOT_ACCEPTABLE,
Error0#xmlel{children = [FileTooLargeEl | Error0#xmlel.children]}.
-spec parse_request(Request :: exml:element()) ->
{Filename :: binary(), Size :: integer(),
ContentType :: binary() | undefined, Namespace :: binary()} |
bad_request.
parse_request(Request) ->
Namespace = exml_query:attr(Request, <<"xmlns">>),
Keys = [<<"filename">>, <<"size">>, <<"content-type">>],
[Filename, SizeBin, ContentType] =
case Namespace of
?NS_HTTP_UPLOAD_025 -> [exml_query:path(Request, [{element, K}, cdata]) || K <- Keys];
?NS_HTTP_UPLOAD_030 -> [exml_query:attr(Request, K) || K <- Keys]
end,
Size = (catch erlang:binary_to_integer(SizeBin)),
case is_nonempty_binary(Filename) andalso is_positive_integer(Size) of
false -> bad_request;
true -> {Filename, Size, ContentType, Namespace}
end.
-spec get_disco_info_form(Namespace :: binary(), MaxFileSizeBin :: binary()) -> exml:element().
get_disco_info_form(Namespace, MaxFileSizeBin) ->
#xmlel{name = <<"x">>,
attrs = [{<<"xmlns">>, ?NS_XDATA}, {<<"type">>, <<"result">>}],
children = [jlib:form_field({<<"FORM_TYPE">>, <<"hidden">>, Namespace}),
jlib:form_field({<<"max-file-size">>, MaxFileSizeBin})]}.
-spec header_to_xmlel({Key :: binary(), Value :: binary()}) -> exml:element().
header_to_xmlel({Key, Value}) ->
#xmlel{name = <<"header">>,
attrs = [{<<"name">>, Key}],
children = [#xmlcdata{content = Value}]}.
-spec create_url_xmlel(Name :: binary(), Url :: binary(), Headers :: #{binary() => binary()},
Namespace :: binary()) -> exml:element().
create_url_xmlel(Name, Url, _Headers, ?NS_HTTP_UPLOAD_025) ->
#xmlel{name = Name, children = [#xmlcdata{content = Url}]};
create_url_xmlel(Name, Url, Headers, ?NS_HTTP_UPLOAD_030) ->
HeadersXml = [header_to_xmlel(H) || H <- maps:to_list(Headers)],
#xmlel{name = Name, attrs = [{<<"url">>, Url}], children = HeadersXml}.
-spec is_nonempty_binary(term()) -> boolean().
is_nonempty_binary(<<_, _/binary>>) -> true;
is_nonempty_binary(_) -> false.
-spec is_positive_integer(term()) -> boolean().
is_positive_integer(X) when is_integer(X) -> X > 0;
is_positive_integer(_) -> false.