Re: untar.m on Solaris with non-GNU tar

[Bill Denney]

John W. Eaton wrote:
> Yes, I think it is OK.  Can you make the changes I suggested
> (eliminate varargin, only compute and return the file list if it is
> requested) and submit new versions?  Then I'll check in the changes.
>   
OK, here is everything.

Bill

## Copyright (C) 2006 Bill Denney
## 
## 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 2, 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, write to the Free
## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
## 02110-1301, USA.

## -*- texinfo -*-
## @deftypefn {Function File} address@hidden =} unpack (@var{file}, @var{dir})
## @deftypefnx {Function File} address@hidden =} unpack (@var{file}, @var{dir}, 
@var{filetype})
## Unpack the archive @var{file} based on its extension to the directory
## @var{dir}.  If @var{file} is a cellstr, then all files will be
## handled individually.  If @var{dir} is not specified, it defaults to
## the current directory.  It returns a list of @var{files}
## unpacked. If a directory is in the file list, then the
## @var{filetype} to unpack must also be specified.
##
## The @var{files} includes the entire path to the output files.
## @seealso{bzip2,bunzip2,tar,untar,gzip,gunzip,zip,unzip}
## @end deftypefn

## Author: Bill Denney <address@hidden>

function varargout = unpack (file, directory, filetype)

  if (nargin < 1 || nargin > 3)
    print_usage ();
  endif

  if (nargin < 2)
    directory = ".";
  endif
  if (nargin < 3)
    filetype = "";
  endif

  if ischar (file)
    if isdir (file)
      if isempty (filetype)
        error ("unpack: filetype must be given for a directory");
      elseif ~ any (strcmpi (filetype, "gunzip"))
        error ("unpack: filetype must be gunzip for a directory");
      endif
    else
      [pathstr, name, ext] = fileparts (file);

      ## check to see if it's .tar.gz, .tar.Z, etc.
      if any (strcmpi ({".gz" ".Z" ".bz2" ".bz"}, ext))
        [tmppathstr, tmpname, tmpext] = fileparts (name);
        if strcmpi (tmpext, ".tar")
          name = tmpname;
          ext = [tmpext ext];
        endif
      endif

      ## if the file is a url, download it and then work with that
      ## file
      if ~ isempty (strfind (file, "://"))
        ## FIXME: the above is not a perfect test for a url
        urlfile = file;
        ## FIXME: should we name the file that we download with the
        ## same file name as the url requests?
        tmpfile = [tmpnam() ext];
        [file, success, msg] = urlwrite (urlfile, tmpfile);
        if (~ success)
          error ("unpack: could not get \"%s\": %s", urlfile, msg);
        endif
      endif

    endif

    ## canonicalize_file_name returns empty if the file isn't found, so
    ## use that to check for existence
    cfile = canonicalize_file_name (file);

    if isempty (cfile)
      error ("unpack: file \"%s\" not found.", file)
    else
      file = cfile;
    endif

  elseif iscellstr (file)
    files = {};
    for i = 1:numel (file)
      tmpfiles = unpack (file{i}, directory);
      files = {files{:} tmpfiles{:}};
    endfor

  else
    error ("unpack: invalid input file class, %s", class(file));
  endif

  ## Instructions on what to do for any extension.
  ##
  ## The field names are the file extension without periods.
  ## The first cell is what is executed to unpack an archive verbosely.
  ## The second cell is what is executed to unpack an archive quietly.
  ## The third cell is the function to execute on output to get the
  ##   files list.
  ## The fourth cell indicates if the files may need to be manually moved
  ##   (i.e. tar and unzip decompress into the current directory while
  ##   bzip2 and gzip decompress the file at its location).
  persistent commandlist;
  if (isempty (commandlist))
    commandlist.gz = {"gunzip -v -r \"%s\"", ...
                      "gunzip -r \"%s\"", ...
                      @__parse_gzip__, true};
    commandlist.z = commandlist.gz;
    commandlist.bz2 = {"bunzip2 -v \"%s\"", ...
                       "bunzip2 \"%s\"", ...
                       @__parse_bzip2__, true};
    commandlist.bz = commandlist.bz2;
    commandlist.tar = {"tar -x -v -f \"%s\"", ...
                       "tar -x -f \"%s\"", ...
                       @__parse_tar__, false};
    commandlist.targz = {"gunzip -c \"%s\" | tar -x -v", ...
                         "gunzip -c \"%s\" | tar -x", ...
                         @__parse_tar__, false};
    commandlist.tgz = commandlist.targz;
    commandlist.tarbz2 = {"bunzip2 -c \"%s\" | tar -x -v", ...
                          "bunzip2 -c \"%s\" | tar -x", ...
                          @__parse_tar__, false};
    commandlist.tarbz = commandlist.tarbz2;
    commandlist.tbz2 = commandlist.tarbz2;
    commandlist.tbz = commandlist.tarbz2;
    commandlist.zip = {"unzip \"%s\"", ...
                       "unzip -q \"%s\"", ...
                       @__parse_zip__, false};
  endif

  nodotext = ext(~ ismember (ext, "."));
  
  origdir = pwd ();

  if isfield (commandlist, nodotext)
    [commandv, commandq, parser, move] = deal (commandlist.(nodotext){:});
    cstartdir = canonicalize_file_name (origdir);
    cenddir = canonicalize_file_name (directory);
    needmove = move && ! strcmp (cstartdir, cenddir);
    if (nargout > 0) || needmove
      command = commandv;
    else
      command = commandq;
    endif
  else
    warning ("unpack:filetype", "unrecognised file type, %s", ext);
    files = file;
    return;
  endif

  ## create the directory if necessary
  s = stat (directory);
  if (isempty (s))
    [status, msg] = mkdir (directory);
    if (! status)
      error ("unpack: mkdir failed to create %s: %s", directory, msg);
    endif
  elseif (! S_ISDIR (s.mode))
    error ("unpack: %s: not a directory", directory);
  endif

  unwind_protect
    cd (directory);
    [status, output] = system (sprintf ([command " 2>&1"], file));
  unwind_protect_cleanup
    cd (origdir);
  end_unwind_protect

  if status
    error ("unpack: unarchiving program exited with status: %d\n%s", ...
           status, output);
  endif

  ## trim the last cr if needed
  ## FIXME: will this need to change to a check for "\r\n" for windows?
  if (output(length (output)) == "\n")
    output(length (output)) = [];
  endif
  files = parser (cellstr (split (output, "\n")))';

  ## move files if necessary
  if needmove
    [st, msg, msgid] = movefile (files, directory);
    if ~ st
      error ("unpack: unable to move files to \"%s\": %s", ...
             directory, msg);
    endif

    ## fix the names for the files since they were moved.
    for i = 1:numel (files)
      files{i} = strrep (files{i}, cstartdir, cenddir);
    endfor
  endif

  ## return output if requested
  if (nargout > 0)
    varargout{1} = files;
  endif
endfunction

function files = __parse_zip__ (output)
  ## parse the output from zip and unzip

  for i = 1:length (output)
    files{i} = output{i}(14:length(output{i}));
  endfor
endfunction

## this is a noop, but it makes things simpler for other cases
function output = __parse_tar__ (output)
endfunction

function files = __parse_gzip__ (output)
  ## parse the output from gzip and gunzip returning the files
  ## commpressed (or decompressed)

  files = {};
  ## the middle ": " should indicate a good place to start looking for
  ## the filename
  for i = 1:length (output)
    colons = strfind(output{i}, ":");
    if isempty (colons)
      warning ("unpack:parsing", "Unable to parse line (gzip missing 
colon):\n%s", output{i})
    else
      midcolon = colons(ceil (length (colons)/2));
      thisstr = output{i}(midcolon+2:length(output{i}));
      idx = index (thisstr, "with") + 5;
      if isempty (idx)
        warning ("unpack:parsing", "Unable to parse line (gzip missing 
with):\n%s", output{i});
      else
        files{i} = thisstr(idx:length (thisstr));
      endif
    endif
  endfor
endfunction

function files = __parse_bzip2__ (output)
  ## parse the output from bzip2 and bunzip2 returning the files
  ## commpressed (or decompressed)

  files = {};
  for i = 1:length (output)
    ## the -5 is to remove the ".bz2:"
    endoffilename = rindex (output{i}, ": ") - 5;
    if isempty(endoffilename)
      warning("unpack:parsing", "Unable to parse line:\n%s", output{i});
    else
      files{i} = output{i}(3:endoffilename);
    endif
  endfor
endfunction

## Copyright (C) 2006 Bill Denney
## 
## 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 2, 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, write to the Free
## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
## 02110-1301, USA.

## -*- texinfo -*-
## @deftypefn {Function File} bunzip2 (@var{bzfile}, @var{dir})
## Unpack the bzip2 archive @var{bzfile} to the directory @var{dir}. If
## @var{dir} is not specified, it defaults to the current directory.
## @seealso{unpack, bzip2, tar, untar, gzip, gunzip, zip, unzip}
## @end deftypefn

## Author: Bill Denney <address@hidden>

function varargout = bunzip2 (files, outputdir)

  if ! (nargin == 1 || nargin == 2)
    print_usage ();
  endif

  if (nargin == 1)
    outputdir = ".";
  endif
  varargout = cell (1, nargout);
  [varargout{:}] = unpack (files, outputdir, mfilename ());

endfunction

## Copyright (C) 2006 Bill Denney
## 
## 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 2, 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, write to the Free
## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
## 02110-1301, USA.

## -*- texinfo -*-
## @deftypefn {Function File} gunzip (@var{gzfile}, @var{dir})
## Unpack the gzip archive @var{gzfile} to the directory @var{dir}. If
## @var{dir} is not specified, it defaults to the current directory. If
## the @var{gzfile} is a directory, all files in the directory will be
## recursively gunzipped.
## @seealso{unpack, bzip2, bunzip2, tar, untar, gzip, gunzip, zip, unzip}
## @end deftypefn

## Author: Bill Denney <address@hidden>

function varargout = gunzip (files, outputdir)

  if ! (nargin == 1 || nargin == 2)
    print_usage ();
  endif

  if (nargin == 1)
    outputdir = ".";
  endif
  varargout = cell (1, nargout);
  [varargout{:}] = unpack (files, outputdir, mfilename ());

endfunction

Index: untar.m
===================================================================
RCS file: /cvs/octave/scripts/miscellaneous/untar.m,v
retrieving revision 1.4
diff -u -r1.4 untar.m
--- untar.m     13 Oct 2006 14:32:15 -0000      1.4
+++ untar.m     25 Oct 2006 03:16:04 -0000
@@ -21,75 +21,22 @@
 ## @deftypefn {Function File} untar (@var{tarfile}, @var{dir})
 ## Unpack the TAR archive @var{tarfile} to the directory @var{dir}.
 ## If @var{dir} is not specified, it defaults to the current directory.
-## @seealso{tar, gzip, gunzip, zip, unzip}
+## @seealso{unpack, bzip2, bunzip2, tar, gzip, gunzip, zip, unzip}
 ## @end deftypefn
 
 ## Author: Søren Hauberg <address@hidden>
-## Adapted-By: jwe
+## Adapted-By: jwe, Bill Denney
 
-function files = untar (tarfile, directory)
+function varargout = untar (files, outputdir)
 
-  if (nargin == 1 || nargin == 2)
-
-    if (nargin == 1)
-      directory = ".";
-    endif
-
-    ## The file must exist (and be a file) and the directory must be a
-    ## string.
-    if (exist (tarfile, "file") && ischar (directory))
-
-      orig_dir = pwd ();
-
-      tarfile = canonicalize_file_name (tarfile);
-
-      s = stat (directory);
-      if (isempty (s))
-       [status, msg] = mkdir (directory);
-       if (! status)
-         error ("untar: mkdir failed to create %s: %s", directory, msg);
-       endif
-      elseif (! S_ISDIR (s.mode))
-       error ("untar: %s: not a directory", directory);
-      endif
-
-      unwind_protect
-       chdir (directory);
-       [status, output] = system (sprintf ("tar -x -v -f %s", tarfile));
-      unwind_protect_cleanup
-       chdir (orig_dir);
-      end_unwind_protect
-
-      if (status == 0)
-       if (nargout > 0)
-         fs = filesep ();
-         if (directory(end) != fs)
-           directory = strcat (directory, fs);
-         endif
-         ## Sadly not reliable if a filename contains a newline
-         ## character!
-         if (output(end) == "\n")
-           output(end) = [];
-         endif
-         files = cellstr (split (output, "\n"));
-         if (! strcmp (directory, "."))
-           nf = length (files);
-           for i = 1:nf
-             files{i} = strcat (directory, files{i});
-           endfor
-         endif
-         files = files';
-       endif
-      else
-       error ("tar: tar exited with status = %s", status);
-      endif
-
-    else
-      error ("untar: expecting arguments to be character strings");
-    endif
+  if ! (nargin == 1 || nargin == 2)
+    print_usage ();
+  endif
 
-  else
-    print_usage ("untar");
+  if (nargin == 1)
+    outputdir = ".";
   endif
+  varargout = cell (1, nargout);
+  [varargout{:}] = unpack (files, outputdir, mfilename ());
 
 endfunction
Index: unzip.m
===================================================================
RCS file: /cvs/octave/scripts/miscellaneous/unzip.m,v
retrieving revision 1.3
diff -u -r1.3 unzip.m
--- unzip.m     13 Oct 2006 14:32:15 -0000      1.3
+++ unzip.m     25 Oct 2006 03:16:04 -0000
@@ -21,42 +21,22 @@
 ## @deftypefn {Function File} unzip (@var{zipfile}, @var{dir})
 ## Unpack the ZIP archive @var{zipfile} to the directory @var{dir}.
 ## If @var{dir} is not specified, it defaults to the current directory.
-## @seealso{tar, untar, gzip, gunzip, zip}
+## @seealso{unpack, bzip2, bunzip2, tar, untar, gzip, gunzip, zip}
 ## @end deftypefn
 
 ## Author: Søren Hauberg <address@hidden>
-## Adapted-By: jwe
+## Adapted-By: jwe, Bill Denney
 
-function files = unzip (zipfile, dir)
+function varargout = unzip (files, outputdir)
 
-  if (nargin == 1 || nargin == 2)
-
-    if (nargin == 1)
-      dir = ".";
-    endif
-
-    if (ischar (zipfile) && ischar (dir))
-
-      [status, output] = system (sprintf ("unzip %s -d %s", zipfile, dir));
-
-      if (status == 0)
-       if (nargout > 0)
-         ## Create list of extracted files.  It blows that there seems
-         ## to be no way to get unzip to print a simple list of file
-         ## names.
-         files = strrep (output, "  inflating: ", "");
-         files = cellstr (split (files, "\n"));
-         files = files(2:end-1,:);
-         files = files';
-       endif
-      else
-       error ("unzip: unzip exited with status = %d", status);
-      endif
-    endif
+  if ! (nargin == 1 || nargin == 2)
+    print_usage ();
+  endif
 
-  else
-    print_usage ("unzip");
+  if (nargin == 1)
+    outputdir = ".";
   endif
+  varargout = cell (1, nargout);
+  [varargout{:}] = unpack (files, outputdir, mfilename ());
 
 endfunction
-