Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove HTTP File Upload 0.2.5 support #2989

Merged
merged 6 commits into from
Jan 4, 2021
Merged

Remove HTTP File Upload 0.2.5 support #2989

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
62a07af
Remove HTTP Upload 0.2.5 checks from the test suite
fenek Dec 21, 2020
7642ac1
Replace deprecated function in mod_http_upload_SUITE
fenek Dec 21, 2020
8c27808
Eradicate export_all from mod_http_upload_SUITE
fenek Dec 21, 2020
54c9a81
Remove HTTP Upload support for pre-0.3.0 XEPs
fenek Dec 21, 2020
726e11e
Update HTTP File Upload and migration docs about the removed version
fenek Dec 21, 2020
bab8ed9
[skip ci] Fix minor cosmetic issues
fenek Dec 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
205 changes: 100 additions & 105 deletions big_tests/tests/mod_http_upload_SUITE.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
-module(mod_http_upload_SUITE).

-compile(export_all).
-include_lib("escalus/include/escalus.hrl").
-include_lib("common_test/include/ct.hrl").
-include_lib("eunit/include/eunit.hrl").
-include_lib("escalus/include/escalus_xmlns.hrl").
-include_lib("exml/include/exml.hrl").

-define(NS_XDATA, <<"jabber:x:data">>).
-define(NS_HTTP_UPLOAD_025, <<"urn:xmpp:http:upload">>).
-define(NS_HTTP_UPLOAD_030, <<"urn:xmpp:http:upload:0">>).

-define(S3_HOSTNAME, "http://bucket.s3-eu-east-25.example.com").
Expand All @@ -31,6 +29,32 @@
]}
]).

-export([all/0, groups/0, suite/0,
init_per_suite/1, end_per_suite/1,
init_per_group/2, end_per_group/2,
init_per_testcase/2, end_per_testcase/2]).

-export([
does_not_advertise_max_size_if_unset/1,

test_minio_upload_without_content_type/1,
test_minio_upload_with_content_type/1,

http_upload_item_discovery/1,
http_upload_feature_discovery/1,
advertises_max_file_size/1,
request_slot/1,
rejects_set_iq/1,
get_url_ends_with_filename/1,
urls_contain_s3_hostname/1,
rejects_empty_filename/1,
rejects_negative_filesize/1,
rejects_invalid_size_type/1,
denies_slots_over_max_file_size/1,
sends_different_put_and_get_urls/1,
escapes_urls_once/1
]).

%%--------------------------------------------------------------------
%% Suite configuration
%%--------------------------------------------------------------------
Expand Down Expand Up @@ -123,26 +147,26 @@ http_upload_item_discovery(Config) ->
end).

http_upload_feature_discovery(Config) ->
namespaced_story(
escalus:story(
Config, [{bob, 1}],
fun(Namespace, Bob) ->
fun(Bob) ->
ServJID = escalus_client:server(Bob),
Result = escalus:send_and_wait(Bob, escalus_stanza:disco_info(ServJID)),
escalus:assert(fun has_no_feature/2, [Namespace], Result),
escalus:assert(fun has_no_feature/2, [ns()], Result),
SubServJID = upload_service(Bob),
SubResult = escalus:send_and_wait(Bob, escalus_stanza:disco_info(SubServJID)),
escalus:assert(has_feature, [Namespace], SubResult)
escalus:assert(has_feature, [ns()], SubResult)
end).

advertises_max_file_size(Config) ->
namespaced_story(
escalus:story(
Config, [{bob, 1}],
fun(Namespace, Bob) ->
fun(Bob) ->
ServJID = upload_service(Bob),
Result = escalus:send_and_wait(Bob, escalus_stanza:disco_info(ServJID)),
Forms = exml_query:paths(Result, [{element, <<"query">>}, {element, <<"x">>}]),
[Form] = lists:filter(
fun(F) -> has_field(<<"FORM_TYPE">>, <<"hidden">>, Namespace, F) end,
fun(F) -> has_field(<<"FORM_TYPE">>, <<"hidden">>, ns(), F) end,
Forms),

escalus:assert(has_type, [<<"result">>], Form),
Expand All @@ -160,50 +184,48 @@ does_not_advertise_max_size_if_unset(Config) ->
end).

rejects_set_iq(Config) ->
namespaced_story(
escalus:story(
Config, [{bob, 1}],
fun(Namespace, Bob) ->
fun(Bob) ->
ServJID = upload_service(Bob),
IQ = escalus_stanza:iq_set(Namespace, []),
IQ = escalus_stanza:iq_set(ns(), []),
Request = escalus_stanza:to(IQ, ServJID),
Result = escalus:send_and_wait(Bob, Request),
escalus_assert:is_error(Result, <<"cancel">>, <<"not-allowed">>)
end).

request_slot(Config) ->
namespaced_story(
escalus:story(
Config, [{bob, 1}],
fun(Namespace, Bob) ->
fun(Bob) ->
ServJID = upload_service(Bob),
Request = create_slot_request_stanza(ServJID, <<"filename.jpg">>, 123,
undefined, Namespace),
Request = create_slot_request_stanza(ServJID, <<"filename.jpg">>, 123, undefined),
Result = escalus:send_and_wait(Bob, Request),
escalus:assert(is_iq_result, Result),
escalus:assert(fun has_namespace/2, [Namespace], Result),
escalus:assert(fun has_put_and_get_fields/2, [Namespace], Result)
escalus:assert(fun has_upload_namespace/1, Result),
escalus:assert(fun has_put_and_get_fields/1, Result)
end).

get_url_ends_with_filename(Config) ->
namespaced_story(
escalus:story(
Config, [{bob, 1}],
fun(Namespace, Bob) ->
fun(Bob) ->
ServJID = upload_service(Bob),
Filename = <<"filename.jpg">>,
Request = create_slot_request_stanza(ServJID, Filename, 123, undefined, Namespace),
Request = create_slot_request_stanza(ServJID, Filename, 123, undefined),
Result = escalus:send_and_wait(Bob, Request),
escalus:assert(fun path_ends_with/4, [<<"get">>, Filename, Namespace], Result)
escalus:assert(fun path_ends_with/3, [<<"get">>, Filename], Result)
end).

urls_contain_s3_hostname(Config) ->
namespaced_story(
escalus:story(
Config, [{bob, 1}],
fun(Namespace, Bob) ->
fun(Bob) ->
ServJID = upload_service(Bob),
Request = create_slot_request_stanza(ServJID, <<"filename.jpg">>, 123,
undefined, Namespace),
Request = create_slot_request_stanza(ServJID, <<"filename.jpg">>, 123, undefined),
Result = escalus:send_and_wait(Bob, Request),
escalus:assert(fun url_contains/4, [<<"get">>, <<?S3_HOSTNAME>>, Namespace], Result),
escalus:assert(fun url_contains/4, [<<"put">>, <<?S3_HOSTNAME>>, Namespace], Result)
escalus:assert(fun url_contains/3, [<<"get">>, <<?S3_HOSTNAME>>], Result),
escalus:assert(fun url_contains/3, [<<"put">>, <<?S3_HOSTNAME>>], Result)
end).

test_minio_upload_without_content_type(Config) ->
Expand All @@ -213,16 +235,15 @@ test_minio_upload_with_content_type(Config) ->
test_minio_upload(Config, <<"text/plain">>).

test_minio_upload(Config, ContentType) ->
namespaced_story(
escalus:story(
Config, [{bob, 1}],
fun(Namespace, Bob) ->
fun(Bob) ->
ServJID = upload_service(Bob),
FileSize = length(?MINIO_TEST_DATA),
Request = create_slot_request_stanza(ServJID, <<"somefile.txt">>, FileSize,
ContentType, Namespace),
Request = create_slot_request_stanza(ServJID, <<"file.txt">>, FileSize, ContentType),
Result = escalus:send_and_wait(Bob, Request),
GetUrl = binary_to_list(extract_url(Result, <<"get">>, Namespace)),
PutUrl = binary_to_list(extract_url(Result, <<"put">>, Namespace)),
GetUrl = binary_to_list(extract_url(Result, <<"get">>)),
PutUrl = binary_to_list(extract_url(Result, <<"put">>)),
Header = generate_header(Config, ContentType),
PutRetValue = ibrowse:send_req(PutUrl, Header, put, ?MINIO_TEST_DATA),
?assertMatch({ok, "200", _, []}, PutRetValue),
Expand All @@ -241,44 +262,41 @@ generate_header(Config, ContentType) ->
[{<<"Content-Type">>, ContentType} | generate_header(Config, undefined)].

rejects_empty_filename(Config) ->
namespaced_story(
escalus:story(
Config, [{bob, 1}],
fun(Namespace, Bob) ->
fun(Bob) ->
ServJID = upload_service(Bob),
Request = create_slot_request_stanza(ServJID, <<>>, 123, undefined, Namespace),
Request = create_slot_request_stanza(ServJID, <<>>, 123, undefined),
Result = escalus:send_and_wait(Bob, Request),
escalus_assert:is_error(Result, <<"modify">>, <<"bad-request">>)
end).

rejects_negative_filesize(Config) ->
namespaced_story(
escalus:story(
Config, [{bob, 1}],
fun(Namespace, Bob) ->
fun(Bob) ->
ServJID = upload_service(Bob),
Request = create_slot_request_stanza(ServJID, <<"filename.jpg">>, -1,
undefined, Namespace),
Request = create_slot_request_stanza(ServJID, <<"filename.jpg">>, -1, undefined),
Result = escalus:send_and_wait(Bob, Request),
escalus_assert:is_error(Result, <<"modify">>, <<"bad-request">>)
end).

rejects_invalid_size_type(Config) ->
namespaced_story(
escalus:story(
Config, [{bob, 1}],
fun(Namespace, Bob) ->
fun(Bob) ->
ServJID = upload_service(Bob),
Request = create_slot_request_stanza(ServJID, <<"filename.jpg">>,
<<"filesize">>, undefined, Namespace),
Request = create_slot_request_stanza(ServJID, <<"a.jpg">>, <<"filesize">>, undefined),
Result = escalus:send_and_wait(Bob, Request),
escalus_assert:is_error(Result, <<"modify">>, <<"bad-request">>)
end).

denies_slots_over_max_file_size(Config) ->
namespaced_story(
escalus:story(
Config, [{bob, 1}],
fun(Namespace, Bob) ->
fun(Bob) ->
ServJID = upload_service(Bob),
Request = create_slot_request_stanza(ServJID, <<"filename.jpg">>, 54321,
undefined, Namespace),
Request = create_slot_request_stanza(ServJID, <<"filename.jpg">>, 54321, undefined),
Result = escalus:send_and_wait(Bob, Request),
escalus:assert(is_error, [<<"modify">>, <<"not-acceptable">>], Result),
<<"1234">> = exml_query:path(Result, [{element, <<"error">>},
Expand All @@ -288,25 +306,23 @@ denies_slots_over_max_file_size(Config) ->
end).

sends_different_put_and_get_urls(Config) ->
namespaced_story(
escalus:story(
Config, [{bob, 1}],
fun(Namespace, Bob) ->
fun(Bob) ->
ServJID = upload_service(Bob),
Request = create_slot_request_stanza(ServJID, <<"filename.jpg">>, 123,
undefined, Namespace),
Request = create_slot_request_stanza(ServJID, <<"filename.jpg">>, 123, undefined),
Result = escalus:send_and_wait(Bob, Request),
escalus:assert(fun urls_not_equal/2, [Namespace], Result)
escalus:assert(fun urls_not_equal/1, Result)
end).

escapes_urls_once(Config) ->
namespaced_story(
escalus:story(
Config, [{bob, 1}],
fun(Namespace, Bob) ->
fun(Bob) ->
ServJID = upload_service(Bob),
Request = create_slot_request_stanza(ServJID, <<"filename.jpg">>, 123,
undefined, Namespace),
Request = create_slot_request_stanza(ServJID, <<"filename.jpg">>, 123, undefined),
Result = escalus:send_and_wait(Bob, Request),
escalus:assert(fun url_contains/4, [<<"put">>, <<"%3Bx-amz-acl">>, Namespace], Result)
escalus:assert(fun url_contains/3, [<<"put">>, <<"%3Bx-amz-acl">>], Result)
end).

%%--------------------------------------------------------------------
Expand All @@ -321,72 +337,57 @@ is_minio_running(Config) ->
lists:member(minio, DBs)
end.

create_slot_request_stanza(Server, Filename, Size, ContentType, Namespace) when is_integer(Size) ->
create_slot_request_stanza(Server, Filename, integer_to_binary(Size), ContentType, Namespace);
create_slot_request_stanza(Server, Filename, BinSize, ContentType, Namespace) ->
create_slot_request_stanza(Server, Filename, Size, ContentType) when is_integer(Size) ->
create_slot_request_stanza(Server, Filename, integer_to_binary(Size), ContentType);
create_slot_request_stanza(Server, Filename, BinSize, ContentType) ->
#xmlel{name = <<"iq">>,
attrs = [{<<"type">>, <<"get">>}, {<<"to">>, Server}],
children = [create_request_for_namespace(Filename, BinSize, ContentType, Namespace)]}.
children = [create_request_element(Filename, BinSize, ContentType)]}.

create_request_for_namespace(Filename, BinSize, ContentType, Namespace = ?NS_HTTP_UPLOAD_025) ->
ContentTypeEl =
case ContentType of
undefined -> [];
_ -> [#xmlel{name = <<"content-type">>, children = [#xmlcdata{content = ContentType}]}]
end,
#xmlel{name = <<"request">>,
attrs = [{<<"xmlns">>, Namespace}],
children =
[#xmlel{name = <<"filename">>, children = [#xmlcdata{content = Filename}]},
#xmlel{name = <<"size">>, children = [#xmlcdata{content = BinSize}]}
| ContentTypeEl]};
create_request_for_namespace(Filename, BinSize, ContentType, Namespace = ?NS_HTTP_UPLOAD_030) ->
create_request_element(Filename, BinSize, ContentType) ->
ContentTypeEl = case ContentType of
undefined -> [];
_ -> [{<<"content-type">>, ContentType}]
end,
#xmlel{name = <<"request">>,
attrs = [{<<"xmlns">>, Namespace},
attrs = [{<<"xmlns">>, ?NS_HTTP_UPLOAD_030},
{<<"filename">>, Filename},
{<<"size">>, BinSize}
| ContentTypeEl]}.

has_namespace(Namespace, #xmlel{name = <<"iq">>, children = [Slot]}) ->
case Slot of
#xmlel{name = <<"slot">>, attrs = [{<<"xmlns">>, Namespace}]} -> true;
_ -> false
end;
has_namespace(_Namespace, _) ->
has_upload_namespace(#xmlel{name = <<"iq">>, children = [#xmlel{ name = <<"slot">> } = Slot]}) ->
?NS_HTTP_UPLOAD_030 == exml_query:attr(Slot, <<"xmlns">>);
has_upload_namespace(_) ->
false.

has_no_feature(Feature, Stanza) ->
not escalus_pred:has_feature(Feature, Stanza).

has_put_and_get_fields(Namespace, Elem = #xmlel{name = <<"iq">>}) ->
PutUrl = extract_url(Elem, <<"put">>, Namespace),
GetUrl = extract_url(Elem, <<"get">>, Namespace),
has_put_and_get_fields(Elem = #xmlel{name = <<"iq">>}) ->
PutUrl = extract_url(Elem, <<"put">>),
GetUrl = extract_url(Elem, <<"get">>),
is_binary(PutUrl) andalso is_binary(GetUrl)
andalso byte_size(PutUrl) > 0 andalso byte_size(GetUrl) > 0;
has_put_and_get_fields(_Namespace, _Elem) ->
has_put_and_get_fields(_Elem) ->
false.

path_ends_with(UrlType, Filename, Namespace, Result) ->
Url = extract_url(Result, UrlType, Namespace),
{ok, {_, _, _, _, PathList, _}} = http_uri:parse(binary_to_list(Url)),
path_ends_with(UrlType, Filename, Result) ->
Url = extract_url(Result, UrlType),
#{ path := Path } = uri_string:parse(Url),
FilenameSize = byte_size(Filename),
ReverseFilename = reverse(Filename),
case reverse(PathList) of
case reverse(Path) of
<<ReverseFilename:FilenameSize/binary, _/binary>> -> true;
_ -> false
end.

url_contains(UrlType, Filename, Namespace, Result) ->
Url = extract_url(Result, UrlType, Namespace),
url_contains(UrlType, Filename, Result) ->
Url = extract_url(Result, UrlType),
binary:match(Url, Filename) =/= nomatch.

urls_not_equal(Namespace, Result) ->
Get = extract_url(Result, <<"get">>, Namespace),
Put = extract_url(Result, <<"put">>, Namespace),
urls_not_equal(Result) ->
Get = extract_url(Result, <<"get">>),
Put = extract_url(Result, <<"put">>),
Get =/= Put.

reverse(List) when is_list(List) ->
Expand All @@ -412,14 +413,8 @@ has_field(Var, Type, Value, Form) ->
host() ->
ct:get_config({hosts, mim, domain}).

extract_url(Result, UrlType, ?NS_HTTP_UPLOAD_025) ->
exml_query:path(Result, [{element, <<"slot">>}, {element, UrlType}, cdata]);
extract_url(Result, UrlType, ?NS_HTTP_UPLOAD_030) ->
extract_url(Result, UrlType) ->
exml_query:path(Result, [{element, <<"slot">>}, {element, UrlType}, {attr, <<"url">>}]).

namespaced_story(Config, Users, Story) ->
lists:foreach(
fun(Namespace) ->
escalus:story(Config, Users, fun(User) -> Story(Namespace, User) end)
end,
[?NS_HTTP_UPLOAD_025, ?NS_HTTP_UPLOAD_030]).
ns() -> ?NS_HTTP_UPLOAD_030.

1 change: 0 additions & 1 deletion include/mongoose_ns.hrl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@
-define(NS_SERVERINFO, <<"http://jabber.org/network/serverinfo">>).
-define(NS_MAM_04, <<"urn:xmpp:mam:1">>). % MAM 0.4.1 or 0.5
-define(NS_MAM_06, <<"urn:xmpp:mam:2">>). % MAM 0.6
-define(NS_HTTP_UPLOAD_025, <<"urn:xmpp:http:upload">>).
-define(NS_HTTP_UPLOAD_030, <<"urn:xmpp:http:upload:0">>).
-define(NS_PUSH, <<"urn:xmpp:push:0">>). % Push Notifications v0.2.1
-define(NS_STANZAID, <<"urn:xmpp:sid:0">>).
Expand Down
Loading