Add function zip:foldl/3 to iterate over zip archives

This is the public interface of prim_zip:open/3,
which has been used in earlier releases by both
erl_prim_loader and escript. The new function
can be used as a replacement for the undocumented
function escript:foldl/3 that is likely to be
removed without further notice.

The error handling of prim_zip:open/3 (and
prim_zip:foldl/3) has been improved in order to
better suite a public interface. For example it
could happen that a file or a zlib port could be
left open in some errors cases.

The documentation of the FileSpec parameter to
zip:create/3 has been updated to show that
file info can be explicitly specified. A FileSpec
may contain {Filename, binary(), #file_info{}}
elements. The function zip:create/3 was already
prepared to partly support this, but now after
a few minor fixes it is fully supported.

1 files changed, 60 insertions, 29 deletions

diff --git a/erts/preloaded/src/prim_zip.erl b/erts/preloaded/src/prim_zip.erl
index 3f5a5b9721..6a9856fdad 100644
--- a/erts/preloaded/src/prim_zip.erl
+++ b/erts/preloaded/src/prim_zip.erl
@@ -65,34 +65,55 @@ filter_fun() ->
 open(F) ->
     open(filter_fun(), undefined, F).
 
-open(FilterFun, FilterAcc, F) ->
-    case ?CATCH do_open(FilterFun, FilterAcc, F) of
-	{ok, PrimZip, Acc} ->
-	    {ok, PrimZip, Acc};
-	Error ->
-	    {error, Error}
-    end.
+open(FilterFun, FilterAcc, F) when is_function(FilterFun, 2) ->
+    try
+	do_open(FilterFun, FilterAcc, F)
+    catch
+	throw:{filter_fun_throw, Reason} ->
+	    throw(Reason);
+	throw:InternalReason ->
+	    {error, InternalReason};
+	Class:Reason ->
+	    erlang:error(erlang:raise(Class, Reason, erlang:get_stacktrace()))
+    end;
+open(_, _, _) ->
+    {error, einval}.
 
 do_open(FilterFun, FilterAcc, F) ->
     Input = get_zip_input(F),
     In0 = Input({open, F, [read, binary, raw]}, []),
     Z = zlib:open(),
     PrimZip = #primzip{files = [], zlib = Z, in = In0, input = Input},
-    {PrimZip2, FilterAcc2} = get_central_dir(PrimZip, FilterFun, FilterAcc),
-    {ok, PrimZip2, FilterAcc2}.
+    try
+	{PrimZip2, FilterAcc2} = get_central_dir(PrimZip, FilterFun, FilterAcc),
+	{ok, PrimZip2, FilterAcc2}
+    catch
+	Class:Reason ->
+	    close(PrimZip),
+	    erlang:error(erlang:raise(Class, Reason, erlang:get_stacktrace()))
+    end.
 
 %% iterate over all files in a zip archive
-foldl(FilterFun, FilterAcc, #primzip{files = Files} = PrimZip) ->
-    case ?CATCH do_foldl(FilterFun, FilterAcc, Files, [], PrimZip, PrimZip) of
-	{ok, FilterAcc2, PrimZip2} -> {ok, PrimZip2, FilterAcc2};
-	Error                      -> {error, Error}
+foldl(FilterFun, FilterAcc, #primzip{files = Files} = PrimZip)
+  when is_function(FilterFun, 2) ->
+    try
+	{ok, FilterAcc2, PrimZip2} =
+	    do_foldl(FilterFun, FilterAcc, Files, [], PrimZip, PrimZip),
+	{ok, PrimZip2, FilterAcc2}
+    catch
+	throw:{filter_fun_throw, Reason} ->
+	    throw(Reason);
+	throw:InternalReason ->
+	    {error, InternalReason};
+	Class:Reason ->
+	    erlang:error(erlang:raise(Class, Reason, erlang:get_stacktrace()))
     end;
 foldl(_, _, _) ->
     {error, einval}.
 
 do_foldl(FilterFun, FilterAcc, [PF | Tail], Acc0, PrimZip, PrimZipOrig) ->
     #primzip_file{name = F, get_info = GetInfo, get_bin = GetBin} = PF,
-    case FilterFun({F, GetInfo, GetBin}, FilterAcc) of
+    try FilterFun({F, GetInfo, GetBin}, FilterAcc) of
 	{Continue, Include, FilterAcc2} ->
 	    Acc1 = include_acc(Include, PF, Acc0),
 	    case Continue of
@@ -103,6 +124,9 @@ do_foldl(FilterFun, FilterAcc, [PF | Tail], Acc0, PrimZip, PrimZipOrig) ->
 	    end;
 	FilterRes ->
 	    throw({illegal_filter, FilterRes})
+    catch
+	throw:Reason ->
+	    throw({filter_fun_throw, Reason})
     end;
 do_foldl(_FilterFun, FilterAcc, [], Acc, PrimZip, _PrimZipOrig) ->
     {ok, FilterAcc, PrimZip#primzip{files = reverse(Acc)}}.
@@ -121,12 +145,14 @@ include_acc(Include, PF, Acc) ->
 	List when is_list(List) ->
 	    %% Add new entries
 	    Fun = fun(I, A) -> include_acc(I, PF, A) end,
-	    lists_foldl(Fun, Acc, List)
+	    lists_foldl(Fun, Acc, List);
+	Bad ->
+	    throw({illegal_filter, Bad})
     end.
 
 lists_foldl(F, Accu, [Hd|Tail]) ->
     lists_foldl(F, F(Hd, Accu), Tail);
-lists_foldl(F, Accu, []) when is_function(F, 2) -> 
+lists_foldl(F, Accu, []) when is_function(F, 2) ->
     Accu.
 
 %% close a zip archive
@@ -139,7 +165,9 @@ close(_) ->
 get_zip_input({F, B}) when is_binary(B), is_list(F) ->
     fun binary_io/2;
 get_zip_input(F) when is_list(F) ->
-    fun prim_file_io/2.
+    fun prim_file_io/2;
+get_zip_input(_) ->
+    throw(einval).
 
 %% get a file from the archive
 get_z_file(F, Offset, ChunkSize, #primzip{zlib = Z, in = In0, input = Input}) ->
@@ -218,15 +246,15 @@ get_cd_loop(N, BCD, Acc0, PrimZip, FileName, Offset, CFH, EndOffset, FilterFun,
     GetInfo = fun() -> cd_file_header_to_file_info(FileName, CFH, <<>>) end,
     GetBin = fun() -> get_z_file(FileName, Offset, Size, PrimZip) end,
     PF = #primzip_file{name = FileName, get_info = GetInfo, get_bin = GetBin},
-    case FilterFun({FileName, GetInfo, GetBin}, FilterAcc) of
+    try FilterFun({FileName, GetInfo, GetBin}, FilterAcc) of
 	{Continue, Include, FilterAcc2} ->
 	    Acc1 =
 		case Include of
-		    false -> 
+		    false ->
 			Acc0;
 		    true ->
 			[PF | Acc0];
-		    {true, Nick} -> 
+		    {true, Nick} ->
 			[PF#primzip_file{name = Nick} | Acc0];
 		    {true, Nick, GI, GB} ->
 			PF2 = #primzip_file{name = Nick, get_info = GI, get_bin = GB},
@@ -247,13 +275,16 @@ get_cd_loop(N, BCD, Acc0, PrimZip, FileName, Offset, CFH, EndOffset, FilterFun,
 	    end;
 	FilterRes ->
 	    throw({illegal_filter, FilterRes})
+    catch
+	throw:Reason ->
+	    throw({filter_fun_throw, Reason})
     end.
 
 get_file_header(BCD) ->
     BCFH =
 	case BCD of
 	    <<?CENTRAL_FILE_MAGIC:32/little,
-	     B:(?CENTRAL_FILE_HEADER_SZ-4)/binary, 
+	     B:(?CENTRAL_FILE_HEADER_SZ-4)/binary,
 	     _/binary>> ->
 		B;
 	    _ ->
@@ -266,11 +297,11 @@ get_file_header(BCD) ->
     ToGet = FileNameLen + ExtraLen + CommentLen,
     {B2, BCDRest} =
 	case BCD of
-	    <<_:?CENTRAL_FILE_HEADER_SZ/binary, 
+	    <<_:?CENTRAL_FILE_HEADER_SZ/binary,
 	     G:ToGet/binary,
-	     Rest/binary>> -> 
+	     Rest/binary>> ->
 		{G, Rest};
-	    _ -> 
+	    _ ->
 		throw(bad_central_directory)
 	end,
     FileName = get_filename_from_b2(B2, FileNameLen, ExtraLen, CommentLen),
@@ -319,9 +350,9 @@ prim_file_io({file_info, F}, _) ->
     end;
 prim_file_io({open, FN, Opts}, _) ->
     case ?CATCH prim_file:open(FN, Opts++[binary]) of
-	{ok, H} -> 
+	{ok, H} ->
 	    H;
-	{error, E} -> 
+	{error, E} ->
 	    throw(E)
     end;
 prim_file_io({read, N}, H) ->
@@ -476,7 +507,7 @@ cd_file_header_to_file_info(FileName,
 %%     FI;     % not yet supported, and not widely used
 add_extra_info(FI, _) ->
     FI.
-%% 
+%%
 %% unix_extra_field_and_var_from_bin(<<TSize:16/little,
 %% 				   ATime:32/little,
 %% 				   MTime:32/little,
@@ -500,7 +531,7 @@ dos_date_time_to_datetime(DosDate, DosTime) ->
     <<Hour:5, Min:6, Sec:5>> = <<DosTime:16>>,
     <<YearFrom1980:7, Month:4, Day:5>> = <<DosDate:16>>,
     {{YearFrom1980+1980, Month, Day},
-     {Hour, Min, Sec}}. 
+     {Hour, Min, Sec}}.
 
 cd_file_header_from_bin(<<VersionMadeBy:16/little,
 			 VersionNeeded:16/little,
@@ -622,7 +653,7 @@ reverse(X) ->
 
 reverse([H|T], Y) ->
     reverse(T, [H|Y]);
-reverse([], X) -> 
+reverse([], X) ->
     X.
 
 last([E|Es]) -> last(E, Es).