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
|
########################################################################
##
## Copyright (C) 2006-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {@var{filelist} =} zip (@var{zipfile}, @var{files})
## @deftypefnx {} {@var{filelist} =} zip (@var{zipfile}, @var{files}, @var{rootdir})
## Compress the list of files and directories specified in @var{files} into the
## ZIP archive @var{zipfile}.
##
## @var{files} is a character array or cell array of strings. Shell
## wildcards in the filename such as @samp{*} or @samp{?} are accepted and
## expanded. Directories are recursively traversed and all files are
## compressed and added to the archive.
##
## If @var{rootdir} is defined then any files without absolute pathnames are
## located relative to @var{rootdir} rather than the current directory.
##
## The optional output @var{filelist} is a list of the files that were included
## in the archive.
## @seealso{unzip, unpack, bzip2, gzip, tar}
## @end deftypefn
function filelist = zip (zipfile, files, rootdir = ".")
if (nargin < 2)
print_usage ();
endif
if (! ischar (zipfile))
error ("zip: ZIPFILE must be a string");
elseif (ischar (files))
files = cellstr (files);
elseif (! iscellstr (files))
error ("zip: FILES must be a character array or cellstr");
endif
rootdir = tilde_expand (rootdir);
zipfile = make_absolute_filename (zipfile);
## FIXME: This is a lot of processing that could be done by the shell
## if Octave had a way to call system without passing a single string.
## Escape bad shell characters
files = regexprep (files, "([|&;<>()$`\\'\" ])", '\\$1');
files = sprintf (' %s', files{:}); # convert to space separated list
zipfile = regexprep (zipfile, "'", "\\'"); # escape single quotes
cmd = sprintf ("zip -r '%s' %s", zipfile, files);
if (ispc () && ! isunix ())
cmd = strrep (cmd, '\', '/');
endif
origdir = pwd ();
cd (rootdir);
[status, output] = system (cmd);
cd (origdir);
if (status)
error ("zip: zip failed with exit status = %d", status);
endif
if (nargout > 0)
cmd = sprintf ("unzip -Z -1 '%s'", zipfile);
[status, filelist] = system (cmd);
if (status)
error ("zip: zipinfo failed with exit status = %d", status);
endif
filelist = ostrsplit (filelist, "\r\n", true);
endif
endfunction
## FIXME: This test may fail if the zip or unzip command is not installed.
## If this test fails, it might be better to change it into a testif
## with a runtime condition on the zip and unzip programs.
%!test
%! ## test zip together with unzip
%! unwind_protect
%! filename = tempname ();
%! tmp_var = pi;
%! save (filename, "tmp_var");
%! dirname = tempname ();
%! mkdir (dirname);
%! zipfile = tempname ();
%! [~, basename, ext] = fileparts (filename);
%! filelist = zip (zipfile, [basename ext], tempdir);
%! filelist = filelist{1};
%! if (! strcmp (filelist, [basename ext]))
%! error ("zip archive does not contain expected name!");
%! endif
%! if (! exist ([zipfile ".zip"], "file"))
%! error ("zip file cannot be found!");
%! endif
%! unzip ([zipfile ".zip"], dirname);
%! fid = fopen (filename, "rb");
%! assert (fid >= 0);
%! orig_data = fread (fid);
%! fclose (fid);
%! fid = fopen ([dirname filesep basename ext], "rb");
%! assert (fid >= 0);
%! new_data = fread (fid);
%! fclose (fid);
%! if (orig_data != new_data)
%! error ("unzipped file not equal to original file!");
%! endif
%! unwind_protect_cleanup
%! sts = unlink (filename);
%! sts = unlink ([dirname, filesep, basename, ext]);
%! sts = unlink (zipfile);
%! sts = unlink ([zipfile ".zip"]);
%! sts = rmdir (dirname);
%! end_unwind_protect
## Test input validation
%!error <Invalid call> zip ()
%!error <Invalid call> zip (1)
%!error <ZIPFILE must be a string> zip (1, "foobar")
%!error <FILES must be a character array or cellstr> zip ("foobar", 1)
|
