2 * Encode and decode standard Unix attributes and
3 * Extended attributes for Win32 and
4 * other non-Unix systems, or Unix systems with ACLs, ...
6 * Kern Sibbald, October MMII
12 Copyright (C) 2000-2003 Kern Sibbald and John Walker
14 This program is free software; you can redistribute it and/or
15 modify it under the terms of the GNU General Public License as
16 published by the Free Software Foundation; either version 2 of
17 the License, or (at your option) any later version.
19 This program is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 General Public License for more details.
24 You should have received a copy of the GNU General Public
25 License along with this program; if not, write to the Free
26 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
38 /* Forward referenced subroutines */
40 int set_win32_attributes(void *jcr, char *fname, char *ofile, char *lname,
41 int type, int stream, struct stat *statp,
42 char *attribsEx, BFILE *ofd);
43 void unix_name_to_win32(POOLMEM **win32_name, char *name);
44 extern "C" HANDLE get_osfhandle(int fd);
45 void win_error(void *jcr, char *prefix, POOLMEM *ofile);
48 /* For old systems that don't have lchown() use chown() */
53 /*=============================================================*/
55 /* *** A l l S y s t e m s *** */
57 /*=============================================================*/
60 /* Encode a stat structure into a base64 character string */
61 void encode_stat(char *buf, struct stat *statp, uint32_t LinkFI)
65 * NOTE: we should use rdev as major and minor device if
66 * it is a block or char device (S_ISCHR(statp->st_mode)
67 * or S_ISBLK(statp->st_mode)). In all other cases,
71 p += to_base64((int64_t)statp->st_dev, p);
72 *p++ = ' '; /* separate fields with a space */
73 p += to_base64((int64_t)statp->st_ino, p);
75 p += to_base64((int64_t)statp->st_mode, p);
77 p += to_base64((int64_t)statp->st_nlink, p);
79 p += to_base64((int64_t)statp->st_uid, p);
81 p += to_base64((int64_t)statp->st_gid, p);
83 p += to_base64((int64_t)statp->st_rdev, p);
85 p += to_base64((int64_t)statp->st_size, p);
87 p += to_base64((int64_t)statp->st_blksize, p);
89 p += to_base64((int64_t)statp->st_blocks, p);
91 p += to_base64((int64_t)statp->st_atime, p);
93 p += to_base64((int64_t)statp->st_mtime, p);
95 p += to_base64((int64_t)statp->st_ctime, p);
97 p += to_base64((int64_t)LinkFI, p);
98 /* FreeBSD function */
101 p += to_base64((int64_t)statp->st_flags, p);
109 /* Decode a stat packet from base64 characters */
111 decode_stat(char *buf, struct stat *statp, uint32_t *LinkFI)
116 p += from_base64(&val, p);
118 p++; /* skip space */
119 p += from_base64(&val, p);
122 p += from_base64(&val, p);
123 statp->st_mode = val;
125 p += from_base64(&val, p);
126 statp->st_nlink = val;
128 p += from_base64(&val, p);
131 p += from_base64(&val, p);
134 p += from_base64(&val, p);
135 statp->st_rdev = val;
137 p += from_base64(&val, p);
138 statp->st_size = val;
140 p += from_base64(&val, p);
141 statp->st_blksize = val;
143 p += from_base64(&val, p);
144 statp->st_blocks = val;
146 p += from_base64(&val, p);
147 statp->st_atime = val;
149 p += from_base64(&val, p);
150 statp->st_mtime = val;
152 p += from_base64(&val, p);
153 statp->st_ctime = val;
154 /* Optional FileIndex of hard linked file data */
155 if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
157 p += from_base64(&val, p);
158 *LinkFI = (uint32_t)val;
162 /* FreeBSD user flags */
164 if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
166 p += from_base64(&val, p);
167 statp->st_flags = (uint32_t)val;
175 * Set file modes, permissions and times
177 * fname is the original filename
178 * ofile is the output filename (may be in a different directory)
180 * Returns: 1 on success
183 int set_attributes(void *jcr, char *fname, char *ofile, char *lname,
184 int type, int stream, struct stat *statp,
185 char *attribsEx, BFILE *ofd)
192 if (set_win32_attributes(jcr, fname, ofile, lname, type, stream,
193 statp, attribsEx, ofd)) {
197 * If Windows stuff failed, e.g. attempt to restore Unix file
198 * to Windows, simply fall through and we will do it the
205 bclose(ofd); /* first close file */
208 ut.actime = statp->st_atime;
209 ut.modtime = statp->st_mtime;
211 /* ***FIXME**** optimize -- don't do if already correct */
213 * For link, change owner of link using lchown, but don't
214 * try to do a chmod as that will update the file behind it.
216 if (type == FT_LNK) {
217 /* Change owner of link, not of real file */
218 if (lchown(ofile, statp->st_uid, statp->st_gid) < 0) {
219 Jmsg2(jcr, M_WARNING, 0, "Unable to set file owner %s: ERR=%s\n",
220 ofile, strerror(errno));
224 if (chown(ofile, statp->st_uid, statp->st_gid) < 0) {
225 Jmsg2(jcr, M_WARNING, 0, "Unable to set file owner %s: ERR=%s\n",
226 ofile, strerror(errno));
229 if (chmod(ofile, statp->st_mode) < 0) {
230 Jmsg2(jcr, M_WARNING, 0, "Unable to set file modes %s: ERR=%s\n",
231 ofile, strerror(errno));
235 /* FreeBSD user flags */
237 if (chflags(ofile, statp->st_flags) < 0) {
238 Jmsg2(jcr, M_WARNING, 0, "Unable to set file flags %s: ERR=%s\n",
239 ofile, strerror(errno));
247 if (utime(ofile, &ut) < 0) {
248 Jmsg2(jcr, M_ERROR, 0, "Unable to set file times %s: ERR=%s\n",
249 ofile, strerror(errno));
258 /*=============================================================*/
260 /* * * * U n i x * * * * */
262 /*=============================================================*/
267 * If you have a Unix system with extended attributes (e.g.
268 * ACLs for Solaris, do it here.
270 int encode_attribsEx(void *jcr, char *attribsEx, FF_PKT *ff_pkt)
272 *attribsEx = 0; /* no extended attributes */
273 return STREAM_UNIX_ATTRIBUTES;
280 /*=============================================================*/
282 /* * * * W i n 3 2 * * * * */
284 /*=============================================================*/
288 int NoGetFileAttributesEx = 0;
290 int encode_attribsEx(void *jcr, char *attribsEx, FF_PKT *ff_pkt)
293 WIN32_FILE_ATTRIBUTE_DATA atts;
296 attribsEx[0] = 0; /* no extended attributes */
298 if (NoGetFileAttributesEx) {
299 return STREAM_UNIX_ATTRIBUTES;
302 unix_name_to_win32(&ff_pkt->sys_fname, ff_pkt->fname);
303 if (!GetFileAttributesEx(ff_pkt->sys_fname, GetFileExInfoStandard,
305 win_error(jcr, "GetFileAttributesEx:", ff_pkt->sys_fname);
306 return STREAM_WIN32_ATTRIBUTES;
309 p += to_base64((uint64_t)atts.dwFileAttributes, p);
310 *p++ = ' '; /* separate fields with a space */
311 li.LowPart = atts.ftCreationTime.dwLowDateTime;
312 li.HighPart = atts.ftCreationTime.dwHighDateTime;
313 p += to_base64((uint64_t)li.QuadPart, p);
315 li.LowPart = atts.ftLastAccessTime.dwLowDateTime;
316 li.HighPart = atts.ftLastAccessTime.dwHighDateTime;
317 p += to_base64((uint64_t)li.QuadPart, p);
319 li.LowPart = atts.ftLastWriteTime.dwLowDateTime;
320 li.HighPart = atts.ftLastWriteTime.dwHighDateTime;
321 p += to_base64((uint64_t)li.QuadPart, p);
323 p += to_base64((uint64_t)atts.nFileSizeHigh, p);
325 p += to_base64((uint64_t)atts.nFileSizeLow, p);
327 return STREAM_WIN32_ATTRIBUTES;
330 /* Define attributes that are legal to set with SetFileAttributes() */
331 #define SET_ATTRS ( \
332 FILE_ATTRIBUTE_ARCHIVE| \
333 FILE_ATTRIBUTE_HIDDEN| \
334 FILE_ATTRIBUTE_NORMAL| \
335 FILE_ATTRIBUTE_NOT_CONTENT_INDEXED| \
336 FILE_ATTRIBUTE_OFFLINE| \
337 FILE_ATTRIBUTE_READONLY| \
338 FILE_ATTRIBUTE_SYSTEM| \
339 FILE_ATTRIBUTE_TEMPORARY)
343 * Set Extended File Attributes for Win32
345 * fname is the original filename
346 * ofile is the output filename (may be in a different directory)
348 * Returns: 1 on success
352 int set_win32_attributes(void *jcr, char *fname, char *ofile, char *lname,
353 int type, int stream, struct stat *statp,
354 char *attribsEx, BFILE *ofd)
358 WIN32_FILE_ATTRIBUTE_DATA atts;
361 POOLMEM *win32_ofile;
363 if (!p || !*p) { /* we should have attributes */
364 Dmsg2(100, "Attributes missing. of=%s ofd=%d\n", ofile, ofd->fid);
370 Dmsg2(100, "Attribs %s = %s\n", ofile, attribsEx);
373 p += from_base64(&val, p);
374 atts.dwFileAttributes = val;
375 p++; /* skip space */
376 p += from_base64(&val, p);
378 atts.ftCreationTime.dwLowDateTime = li.LowPart;
379 atts.ftCreationTime.dwHighDateTime = li.HighPart;
380 p++; /* skip space */
381 p += from_base64(&val, p);
383 atts.ftLastAccessTime.dwLowDateTime = li.LowPart;
384 atts.ftLastAccessTime.dwHighDateTime = li.HighPart;
385 p++; /* skip space */
386 p += from_base64(&val, p);
388 atts.ftLastWriteTime.dwLowDateTime = li.LowPart;
389 atts.ftLastWriteTime.dwHighDateTime = li.HighPart;
391 p += from_base64(&val, p);
392 atts.nFileSizeHigh = val;
394 p += from_base64(&val, p);
395 atts.nFileSizeLow = val;
397 /* At this point, we have reconstructed the WIN32_FILE_ATTRIBUTE_DATA pkt */
399 /* Convert to Windows path format */
400 win32_ofile = get_pool_memory(PM_FNAME);
401 unix_name_to_win32(&win32_ofile, ofile);
403 if (!is_bopen(ofd)) {
404 Dmsg1(100, "File not open: %s\n", ofile);
405 bopen(ofd, ofile, O_RDWR|O_BINARY, 0); /* attempt to open the file */
409 Dmsg1(100, "SetFileTime %s\n", ofile);
410 stat = SetFileTime(get_osfhandle(ofd->fid),
411 &atts.ftCreationTime,
412 &atts.ftLastAccessTime,
413 &atts.ftLastWriteTime);
415 win_error(jcr, "SetFileTime:", win32_ofile);
420 Dmsg1(100, "SetFileAtts %s\n", ofile);
421 stat = SetFileAttributes(win32_ofile, atts.dwFileAttributes & SET_ATTRS);
423 win_error(jcr, "SetFileAttributes:", win32_ofile);
425 free_pool_memory(win32_ofile);
429 void win_error(void *vjcr, char *prefix, POOLMEM *win32_ofile)
431 JCR *jcr = (JCR *)vjcr;
432 DWORD lerror = GetLastError();
434 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
435 FORMAT_MESSAGE_FROM_SYSTEM,
442 Dmsg3(100, "Error in %s on file %s: ERR=%s\n", prefix, win32_ofile, msg);
443 Jmsg3(jcr, M_INFO, 0, _("Error in %s file %s: ERR=%s\n"), prefix, win32_ofile, msg);
447 /* Cygwin API definition */
448 extern "C" void cygwin_conv_to_win32_path(const char *path, char *win32_path);
450 void unix_name_to_win32(POOLMEM **win32_name, char *name)
452 /* One extra byte should suffice, but we double it */
453 *win32_name = check_pool_memory_size(*win32_name, 2*strlen(name)+1);
454 cygwin_conv_to_win32_path(name, *win32_name);
457 #endif /* HAVE_CYGWIN */