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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
########################################################################
##
## Copyright (C) 2005-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 {} {} 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 logical 1, and @var{msg}, @var{msgid} are
## empty character strings (""). Otherwise, @var{status} is logical 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)
print_usage ();
endif
max_cmd_line = 1024;
sts = true;
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 = false;
msg = "when copying multiple files, F2 must be a directory";
msgid = "copyfile";
return;
endif
endif
## Protect the filename(s).
if (ispc ())
f1 = __wglob__ (f1);
else
f1 = glob (f1);
endif
if (isempty (f1))
if (nargout == 0)
error ("copyfile: no files to move");
else
status = false;
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 = false;
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 = false;
msgid = "copyfile";
endif
endif
if (nargout == 0)
if (! sts)
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 <Invalid call> copyfile ()
%!error <Invalid call> copyfile (1)
%!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_%")
|
