From 171d7e2a161ef9270240aff0fa15a285df21c1ef Mon Sep 17 00:00:00 2001
From: Siri Hansen <siri@erlang.org>
Date: Fri, 12 Feb 2016 15:04:30 +0100
Subject: [ct_netconfc] Fix XML parsing when multiple messages in package

If a ssh package contained more than one netconf end tag, then the
second end tag was never detected in ct_netconfc:handle_data. Instead
it was included in the XML data given to the xmerl parser, which then
failed with reason "\"]]>\" is not allowed in content".

This problem was introduced by OTP-13007.
---
 lib/common_test/src/ct_netconfc.erl | 44 +++++++++++++++++++++++++------------
 1 file changed, 30 insertions(+), 14 deletions(-)

(limited to 'lib/common_test/src')

diff --git a/lib/common_test/src/ct_netconfc.erl b/lib/common_test/src/ct_netconfc.erl
index 6e3d1ab1d8..3da1115c76 100644
--- a/lib/common_test/src/ct_netconfc.erl
+++ b/lib/common_test/src/ct_netconfc.erl
@@ -264,6 +264,7 @@
 		session_id,
 		msg_id = 1,
 		hello_status,
+		no_end_tag_buff = <<>>,
 		buff = <<>>,
 		pending = [],    % [#pending]
 		event_receiver}).% pid
@@ -1170,7 +1171,7 @@ handle_msg({Ref,timeout},#state{pending=Pending} = State) ->
 	end,
     %% Halfhearted try to get in correct state, this matches
     %% the implementation before this patch
-    {R,State#state{pending=Pending1, buff= <<>>}}.
+    {R,State#state{pending=Pending1, no_end_tag_buff= <<>>, buff= <<>>}}.
 
 %% @private
 %% Called by ct_util_server to close registered connections before terminate.
@@ -1205,7 +1206,7 @@ call(Client, Msg, Timeout, WaitStop) ->
 		    {error,no_such_client};
 		{error,{process_down,Pid,normal}} when WaitStop ->
 		    %% This will happen when server closes connection
-		    %% before clien received rpc-reply on
+		    %% before client received rpc-reply on
 		    %% close-session.
 		    ok;
 		{error,{process_down,Pid,normal}} ->
@@ -1372,24 +1373,37 @@ to_xml_doc(Simple) ->
 
 %%%-----------------------------------------------------------------
 %%% Parse and handle received XML data
-handle_data(NewData,#state{connection=Connection,buff=Buff0} = State0) ->
+%%% Two buffers are used:
+%%%   * 'no_end_tag_buff' contains data that is checked and does not
+%%%     contain any (part of an) end tag.
+%%%   * 'buff' contains all other saved data - it may or may not
+%%%     include (a part of) an end tag.
+%%% The reason for this is to avoid running binary:split/3 multiple
+%%% times on the same data when it does not contain an end tag. This
+%%% can be a considerable optimation in the case when a lot of data is
+%%% received (e.g. when fetching all data from a node) and the data is
+%%% sent in multiple ssh packages.
+handle_data(NewData,#state{connection=Connection} = State0) ->
     log(Connection,recv,NewData),
-    {Start,AddSz} =
-	case byte_size(Buff0) of
-	    BSz when BSz<5 -> {0,BSz};
-	    BSz -> {BSz-5,5}
-	end,
-    Length = byte_size(NewData) + AddSz,
+    NoEndTag0 = State0#state.no_end_tag_buff,
+    Buff0 = State0#state.buff,
     Data = <<Buff0/binary, NewData/binary>>,
-    case binary:split(Data,?END_TAG,[{scope,{Start,Length}}]) of
+    case binary:split(Data,?END_TAG,[]) of
 	[_NoEndTagFound] ->
-	    {noreply, State0#state{buff=Data}};
+	    NoEndTagSize = case byte_size(Data) of
+			       Sz when Sz<5 -> 0;
+			       Sz -> Sz-5
+			   end,
+	    <<NoEndTag1:NoEndTagSize/binary,Buff/binary>> = Data,
+	    NoEndTag = <<NoEndTag0/binary,NoEndTag1/binary>>,
+	    {noreply, State0#state{no_end_tag_buff=NoEndTag, buff=Buff}};
 	[FirstMsg0,Buff1] ->
-	    FirstMsg = remove_initial_nl(FirstMsg0),
+	    FirstMsg = remove_initial_nl(<<NoEndTag0/binary,FirstMsg0/binary>>),
 	    SaxArgs = [{event_fun,fun sax_event/3}, {event_state,[]}],
 	    case xmerl_sax_parser:stream(FirstMsg, SaxArgs) of
 		{ok, Simple, _Thrash} ->
-		    case decode(Simple, State0#state{buff=Buff1}) of
+		    case decode(Simple, State0#state{no_end_tag_buff= <<>>,
+						     buff=Buff1}) of
 			{noreply, #state{buff=Buff} = State} when Buff =/= <<>> ->
 			    %% Recurse if we have more data in buffer
 			    handle_data(<<>>, State);
@@ -1401,10 +1415,12 @@ handle_data(NewData,#state{connection=Connection,buff=Buff0} = State0) ->
 			   [{parse_error,Reason},
 			    {buffer, Buff0},
 			    {new_data,NewData}]),
-		    handle_error(Reason, State0#state{buff= <<>>})
+		    handle_error(Reason, State0#state{no_end_tag_buff= <<>>,
+						      buff= <<>>})
 	    end
     end.
 
+
 %% xml does not accept a leading nl and some netconf server add a nl after
 %% each ?END_TAG, ignore them
 remove_initial_nl(<<"\n", Data/binary>>) ->
-- 
cgit v1.2.3