Mercurial > octave-antonio
view scripts/miscellaneous/tar.m @ 19258:a4e993343e93
Overhaul the archive family (bzip2, gzip, zip, tar) of m-files.
* NEWS: Announce changes to archive family of functions.
* bunzip2.m: Redo docstring. Use common variable names between docstring and
function. Remove file from test statistics. Default to placing uncompressed
files in same directory as the compressed one.
* bzip2.m: Redo docstring. Use common variable names between docstring and
function. Add extensive BIST test.
* gunzip.m: Redo docstring. Use common variable names between docstring and
function. Remove file from test statistics. Default to placing uncompressed
files in same directory as the compressed one.
* gzip.m: Redo docstring. Remove input validation test that is no longer
applicable.
* __xzip__.m: Create output directory if it is named, but does not yet exist.
Check return code of mkdir and issue an error if it is unsuccesful. Use the
caller's name (gzip or bzip2) in error messages. Rename subfunction myfileparts
to fname_only for slightly more clarity. Add FIXME note that compression of
directories does not work.
* tar.m: Redo docstring. Use common variable names between docstring and
function. Add extensive BIST test.
* untar.m: Redo docstring. Use common variable names between docstring and
function. Remove file from test statistics. Default to placing uncompressed
files in same directory as the compressed one.
* unzip.m: Redo docstring. Use common variable names between docstring and
function. Remove file from test statistics. Default to placing uncompressed
files in same directory as the zip archive.
* zip.m: Redo docstring. Use common variable names between docstring and
function. Add extensive BIST test.
author | Rik <rik@octave.org> |
---|---|
date | Fri, 17 Oct 2014 10:45:25 -0700 |
parents | d63878346099 |
children | 827cc33ae05c |
line wrap: on
line source
## Copyright (C) 2005-2013 Søren Hauberg ## ## 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 ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {@var{filelist} =} tar (@var{tarfile}, @var{files}) ## @deftypefnx {Function File} {@var{filelist} =} tar (@var{tarfile}, @var{files}, @var{rootdir}) ## Pack the list of files and directories specified in @var{files} into the ## TAR archive @var{tarfile}. ## ## @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 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{untar, unpack, bzip2, gzip, zip} ## @end deftypefn ## Author: Søren Hauberg <hauberg@gmail.com> function filelist = tar (tarfile, files, rootdir = ".") if (nargin < 2 || nargin > 3) print_usage (); endif if (! ischar (tarfile)) error ("tar: TARFILE must be a string"); elseif (ischar (files)) files = cellstr (files); elseif (! iscellstr (files)) error ("tar: FILES must be a character array or cellstr"); endif rootdir = tilde_expand (rootdir); tarfile = make_absolute_filename (tarfile); cmd = sprintf ("tar cvf %s -C %s %s", tarfile, rootdir, sprintf (" %s", files{:})); [status, output] = system (cmd); if (status) error ("tar: tar exited with status = %d", status); endif if (nargout > 0) if (output(end) == "\n") output(end) = []; endif filelist = ostrsplit (output, "\n"); filelist = filelist'; endif endfunction %!xtest %! ## test gzip together with gunzip %! unwind_protect %! dirname = tempname; %! assert (mkdir (dirname)); %! dirname2 = fullfile (dirname, "dir2"); %! assert (mkdir (dirname2)); %! fname1 = fullfile (dirname, "f1"); %! fname2 = fullfile (dirname2, "f2"); %! fid = fopen (fname1, "wt"); %! assert (fid >= 0); %! fdisp (fid, "Hello World"); %! fclose (fid); %! fid = fopen (fname2, "wt"); %! assert (fid >= 0); %! fdisp (fid, "Goodbye World"); %! fclose (fid); %! tarname = [tempname ".tar"]; %! filelist = tar (tarname, {dirname2, fname1}); %! if (! strcmp (filelist{3}, fname1)) %! error ("tar file contents does not match expected file"); %! endif %! if (! exist (tarname, "file")) %! error ("tar archive file cannot be found!"); %! endif %! outdir = tempname; %! untar (tarname, outdir); %! fid = fopen (fullfile (outdir, fname1), "rt"); %! assert (fid >= 0); %! str = fgetl (fid); %! fclose (fid); %! assert (str, "Hello World"); %! fid = fopen (fullfile (outdir, fname2), "rt"); %! assert (fid >= 0); %! str = fgetl (fid); %! fclose (fid); %! assert (str, "Goodbye World"); %! unwind_protect_cleanup %! delete (tarname); %! confirm_recursive_rmdir (false, "local"); %! rmdir (dirname, "s"); %! rmdir (outdir, "s"); %! end_unwind_protect ## Test input validation %!error tar () %!error tar (1) %!error tar (1,2,3,4) %!error <TARFILE must be a string> tar (1, "foobar") %!error <FILES must be a character array or cellstr> tar ("foobar", 1)