Mercurial > octave
view scripts/miscellaneous/copyfile.m @ 28103:1cb3c33f97dc
copyfile.m: throw error if operation fails and nargout == 0 (bug #57830).
* copyfile.m: New internal variable "sts" to hold status of function.
When internal checks fail, check nargout == 0, and throw an error. Otherwise,
set output variables "status", "msg", "msgid" and immediately return from
function. Att end of function, based on nargout variable, either throw an
error if operation failed (sts = 0), or set output "status" to value of "sts"
and return information in outputs.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 18 Feb 2020 17:22:40 -0800 |
parents | bd51beb6205e |
children | 28de41192f3c |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2005-2020 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 {} {} copyfile @var{f1} @var{f2} ## @deftypefnx {} {} copyfile @var{f1} @var{f2} f ## @deftypefnx {} {} copyfile (@var{f1}, @var{f2}) ## @deftypefnx {} {} copyfile (@var{f1}, @var{f2}, 'f') ## @deftypefnx {} {[@var{status}, @var{msg}, @var{msgid}] =} copyfile (@dots{}) ## Copy the source file(s) or directory @var{f1} to the destination @var{f2}. ## ## The name @var{f1} may contain globbing patterns, or may be a cell array of ## strings. If @var{f1} expands to multiple filenames, @var{f2} must be a ## directory. ## ## When the force flag @qcode{'f'} is given any existing files will be ## overwritten without prompting. ## ## If successful, @var{status} is 1, and @var{msg}, @var{msgid} are empty ## character strings (""). Otherwise, @var{status} is 0, @var{msg} contains a ## system-dependent error message, and @var{msgid} contains a unique message ## identifier. Note that the status code is exactly opposite that of the ## @code{system} command. ## @seealso{movefile, rename, unlink, delete, glob} ## @end deftypefn function [status, msg, msgid] = copyfile (f1, f2, force) if (nargin < 2 || nargin > 3) print_usage (); endif max_cmd_line = 1024; sts = 1; msg = ""; msgid = ""; ## FIXME: Maybe use the same method as in ls to allow users control ## over the command that is executed. if (ispc () && ! isunix () && isempty (file_in_path (getenv ("PATH"), "cp.exe"))) ## Windows. cmd = "cmd /C xcopy /E"; cmd_force_flag = "/Y"; else cmd = "cp -r"; cmd_force_flag = "-f"; endif ## Input type check. if (ischar (f1)) f1 = cellstr (f1); elseif (! iscellstr (f1)) error ("copyfile: F1 must be a string or a cell array of strings"); endif if (! ischar (f2)) error ("copyfile: F2 must be a string"); endif if (nargin == 3 && strcmp (force, "f")) cmd = [cmd " " cmd_force_flag]; endif ## If f1 has more than 1 element then f2 must be a directory isdir = isfolder (f2); if (numel (f1) > 1 && ! isdir) if (nargout == 0) error ("copyfile: when copying multiple files, F2 must be a directory"); else status = 0; msg = "when copying multiple files, F2 must be a directory"; msgid = "copyfile"; return; endif endif ## Protect the filename(s). f1 = glob (f1); if (isempty (f1)) if (nargout == 0) error ("copyfile: no files to move"); else status = 0; msg = "no files to move"; msgid = "copyfile"; return; endif endif p1 = sprintf ('"%s" ', f1{:}); p2 = tilde_expand (f2); if (isdir && length (p1) > max_cmd_line) l2 = length (p2) + length (cmd) + 6; while (! isempty (f1)) p1 = sprintf ('"%s" ', f1{1}); f1(1) = []; while (! isempty (f1) && (length (p1) + length (f1{1}) + l2 < max_cmd_line)) p1 = sprintf ('%s"%s" ', p1, f1{1}); f1(1) = []; endwhile if (ispc () && ! isunix () && ! isempty (file_in_path (getenv ("PATH"), "cp.exe"))) p1 = strrep (p1, '\', '/'); p2 = strrep (p2, '\', '/'); endif ## Copy the files. [err, msg] = system (sprintf ('%s %s"%s"', cmd, p1, p2)); if (err != 0) sts = 0; msgid = "copyfile"; break; endif endwhile else if (ispc () && ! isunix () && ! isempty (file_in_path (getenv ("PATH"), "cp.exe"))) p1 = strrep (p1, '\', '/'); p2 = strrep (p2, '\', '/'); endif ## Copy the files. [err, msg] = system (sprintf ('%s %s"%s"', cmd, p1, p2)); if (err != 0) sts = 0; msgid = "copyfile"; endif endif if (nargout == 0) if (sts == 0) error ("copyfile: operation failed: %s", msg); endif else status = sts; endif endfunction %!test %! unwind_protect %! f1 = tempname; %! tmp_var = pi; %! save (f1, "tmp_var"); %! f2 = tempname; %! assert (copyfile (f1, f2)); %! assert (exist (f2, "file")); %! fid = fopen (f1, "rb"); %! assert (fid >= 0); %! orig_data = fread (fid); %! fclose (fid); %! fid = fopen (f2, "rb"); %! assert (fid >= 0); %! new_data = fread (fid); %! fclose (fid); %! if (orig_data != new_data) %! error ("copied file not equal to original file!"); %! endif %! unwind_protect_cleanup %! delete (f1); %! delete (f2); %! end_unwind_protect ## Test input validation %!error copyfile () %!error copyfile (1) %!error copyfile (1,2,3,4) %!error <F1 must be a string> copyfile (1, "foobar") %!error <F2 must be a string> copyfile ("foobar", 1) %!error <F2 must be a directory> copyfile ({"a", "b"}, "%_NOT_A_DIR_%") %!error <no files to move> copyfile ("%_NOT_A_FILENAME1_%", "%_NOT_A_FILENAME2_%")