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,
36 /* Forward referenced subroutines */
37 static int set_win32_attributes(JCR *jcr, ATTR *attr, BFILE *ofd);
38 void unix_name_to_win32(POOLMEM **win32_name, char *name);
39 void win_error(JCR *jcr, char *prefix, POOLMEM *ofile);
40 HANDLE bget_handle(BFILE *bfd);
43 /* For old systems that don't have lchown() use chown() */
48 /*=============================================================*/
50 /* *** A l l S y s t e m s *** */
52 /*=============================================================*/
55 * Return the data stream that will be used
57 int select_data_stream(FF_PKT *ff_pkt)
61 /* Note, no sparse option for win32_data */
62 if (!is_portable_backup(&ff_pkt->bfd)) {
63 stream = STREAM_WIN32_DATA;
64 ff_pkt->flags &= ~FO_SPARSE;
65 } else if (ff_pkt->flags & FO_SPARSE) {
66 stream = STREAM_SPARSE_DATA;
68 stream = STREAM_FILE_DATA;
71 if (ff_pkt->flags & FO_GZIP) {
72 if (stream == STREAM_WIN32_DATA) {
73 stream = STREAM_WIN32_GZIP_DATA;
74 } else if (stream == STREAM_FILE_DATA) {
75 stream = STREAM_GZIP_DATA;
77 stream = STREAM_SPARSE_GZIP_DATA;
86 * Encode a stat structure into a base64 character string
87 * All systems must create such a structure.
88 * In addition, we tack on the LinkFI, which is non-zero in
89 * the case of a hard linked file that has no data. This
90 * is a File Index pointing to the link that does have the
91 * data (always the first one encountered in a save).
92 * You may piggyback attributes on this packet by encoding
93 * them in the encode_attribsEx() subroutine, but this is
96 void encode_stat(char *buf, FF_PKT *ff_pkt, int data_stream)
99 struct stat *statp = &ff_pkt->statp;
101 * Encode a stat packet. I should have done this more intelligently
102 * with a length so that it could be easily expanded.
104 p += to_base64((int64_t)statp->st_dev, p);
105 *p++ = ' '; /* separate fields with a space */
106 p += to_base64((int64_t)statp->st_ino, p);
108 p += to_base64((int64_t)statp->st_mode, p);
110 p += to_base64((int64_t)statp->st_nlink, p);
112 p += to_base64((int64_t)statp->st_uid, p);
114 p += to_base64((int64_t)statp->st_gid, p);
116 p += to_base64((int64_t)statp->st_rdev, p);
118 p += to_base64((int64_t)statp->st_size, p);
120 p += to_base64((int64_t)statp->st_blksize, p);
122 p += to_base64((int64_t)statp->st_blocks, p);
124 p += to_base64((int64_t)statp->st_atime, p);
126 p += to_base64((int64_t)statp->st_mtime, p);
128 p += to_base64((int64_t)statp->st_ctime, p);
130 p += to_base64((int64_t)ff_pkt->LinkFI, p);
134 /* FreeBSD function */
135 p += to_base64((int64_t)statp->st_flags, p); /* output st_flags */
137 p += to_base64((int64_t)0, p); /* output place holder */
140 p += to_base64((int64_t)data_stream, p);
147 /* Decode a stat packet from base64 characters */
148 int decode_stat(char *buf, struct stat *statp, int32_t *LinkFI)
153 p += from_base64(&val, p);
155 p++; /* skip space */
156 p += from_base64(&val, p);
159 p += from_base64(&val, p);
160 statp->st_mode = val;
162 p += from_base64(&val, p);
163 statp->st_nlink = val;
165 p += from_base64(&val, p);
168 p += from_base64(&val, p);
171 p += from_base64(&val, p);
172 statp->st_rdev = val;
174 p += from_base64(&val, p);
175 statp->st_size = val;
177 p += from_base64(&val, p);
178 statp->st_blksize = val;
180 p += from_base64(&val, p);
181 statp->st_blocks = val;
183 p += from_base64(&val, p);
184 statp->st_atime = val;
186 p += from_base64(&val, p);
187 statp->st_mtime = val;
189 p += from_base64(&val, p);
190 statp->st_ctime = val;
192 /* Optional FileIndex of hard linked file data */
193 if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
195 p += from_base64(&val, p);
196 *LinkFI = (uint32_t)val;
202 /* FreeBSD user flags */
203 if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
205 p += from_base64(&val, p);
207 statp->st_flags = (uint32_t)val;
213 /* Look for data stream id */
214 if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
216 p += from_base64(&val, p);
224 * Set file modes, permissions and times
226 * fname is the original filename
227 * ofile is the output filename (may be in a different directory)
229 * Returns: 1 on success
232 int set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd)
239 if (attr->data_stream == STREAM_WIN32_DATA ||
240 attr->data_stream == STREAM_WIN32_GZIP_DATA) {
247 if (attr->stream == STREAM_UNIX_ATTRIBUTES_EX &&
248 set_win32_attributes(jcr, attr, ofd)) {
255 * If Windows stuff failed, e.g. attempt to restore Unix file
256 * to Windows, simply fall through and we will do it the
263 bclose(ofd); /* first close file */
266 ut.actime = attr->statp.st_atime;
267 ut.modtime = attr->statp.st_mtime;
269 /* ***FIXME**** optimize -- don't do if already correct */
271 * For link, change owner of link using lchown, but don't
272 * try to do a chmod as that will update the file behind it.
274 if (attr->type == FT_LNK) {
275 /* Change owner of link, not of real file */
276 if (lchown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0) {
277 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
278 attr->ofname, strerror(errno));
282 if (chown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0) {
283 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
284 attr->ofname, strerror(errno));
287 if (chmod(attr->ofname, attr->statp.st_mode) < 0) {
288 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file modes %s: ERR=%s\n"),
289 attr->ofname, strerror(errno));
293 /* FreeBSD user flags */
295 if (chflags(attr->ofname, attr->statp.st_flags) < 0) {
296 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file flags %s: ERR=%s\n"),
297 attr->ofname, strerror(errno));
304 if (utime(attr->ofname, &ut) < 0) {
305 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file times %s: ERR=%s\n"),
306 attr->ofname, strerror(errno));
315 /*=============================================================*/
317 /* * * * U n i x * * * * */
319 /*=============================================================*/
324 * It is possible to piggyback additional data e.g. ACLs on
325 * the encode_stat() data by returning the extended attributes
326 * here. They must be "self-contained" (i.e. you keep track
327 * of your own length), and they must be in ASCII string
328 * format. Using this feature is not recommended.
329 * The code below shows how to return nothing. See the Win32
330 * code below for returning something in the attributes.
332 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
334 *attribsEx = 0; /* no extended attributes */
335 return STREAM_UNIX_ATTRIBUTES;
342 /*=============================================================*/
344 /* * * * W i n 3 2 * * * * */
346 /*=============================================================*/
350 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
353 WIN32_FILE_ATTRIBUTE_DATA atts;
356 attribsEx[0] = 0; /* no extended attributes */
358 if (!p_GetFileAttributesEx) {
359 return STREAM_UNIX_ATTRIBUTES;
362 unix_name_to_win32(&ff_pkt->sys_fname, ff_pkt->fname);
363 if (!p_GetFileAttributesEx(ff_pkt->sys_fname, GetFileExInfoStandard,
365 win_error(jcr, "GetFileAttributesEx:", ff_pkt->sys_fname);
366 return STREAM_UNIX_ATTRIBUTES;
369 p += to_base64((uint64_t)atts.dwFileAttributes, p);
370 *p++ = ' '; /* separate fields with a space */
371 li.LowPart = atts.ftCreationTime.dwLowDateTime;
372 li.HighPart = atts.ftCreationTime.dwHighDateTime;
373 p += to_base64((uint64_t)li.QuadPart, p);
375 li.LowPart = atts.ftLastAccessTime.dwLowDateTime;
376 li.HighPart = atts.ftLastAccessTime.dwHighDateTime;
377 p += to_base64((uint64_t)li.QuadPart, p);
379 li.LowPart = atts.ftLastWriteTime.dwLowDateTime;
380 li.HighPart = atts.ftLastWriteTime.dwHighDateTime;
381 p += to_base64((uint64_t)li.QuadPart, p);
383 p += to_base64((uint64_t)atts.nFileSizeHigh, p);
385 p += to_base64((uint64_t)atts.nFileSizeLow, p);
387 return STREAM_UNIX_ATTRIBUTES_EX;
390 /* Define attributes that are legal to set with SetFileAttributes() */
391 #define SET_ATTRS ( \
392 FILE_ATTRIBUTE_ARCHIVE| \
393 FILE_ATTRIBUTE_HIDDEN| \
394 FILE_ATTRIBUTE_NORMAL| \
395 FILE_ATTRIBUTE_NOT_CONTENT_INDEXED| \
396 FILE_ATTRIBUTE_OFFLINE| \
397 FILE_ATTRIBUTE_READONLY| \
398 FILE_ATTRIBUTE_SYSTEM| \
399 FILE_ATTRIBUTE_TEMPORARY)
403 * Set Extended File Attributes for Win32
405 * fname is the original filename
406 * ofile is the output filename (may be in a different directory)
408 * Returns: 1 on success
411 static int set_win32_attributes(JCR *jcr, ATTR *attr, BFILE *ofd)
413 char *p = attr->attrEx;
415 WIN32_FILE_ATTRIBUTE_DATA atts;
417 POOLMEM *win32_ofile;
419 if (!p_GetFileAttributesEx) {
423 if (!p || !*p) { /* we should have attributes */
424 Dmsg2(100, "Attributes missing. of=%s ofd=%d\n", attr->ofname, ofd->fid);
430 Dmsg2(100, "Attribs %s = %s\n", attr->ofname, attr->attrEx);
433 p += from_base64(&val, p);
434 atts.dwFileAttributes = val;
435 p++; /* skip space */
436 p += from_base64(&val, p);
438 atts.ftCreationTime.dwLowDateTime = li.LowPart;
439 atts.ftCreationTime.dwHighDateTime = li.HighPart;
440 p++; /* skip space */
441 p += from_base64(&val, p);
443 atts.ftLastAccessTime.dwLowDateTime = li.LowPart;
444 atts.ftLastAccessTime.dwHighDateTime = li.HighPart;
445 p++; /* skip space */
446 p += from_base64(&val, p);
448 atts.ftLastWriteTime.dwLowDateTime = li.LowPart;
449 atts.ftLastWriteTime.dwHighDateTime = li.HighPart;
451 p += from_base64(&val, p);
452 atts.nFileSizeHigh = val;
454 p += from_base64(&val, p);
455 atts.nFileSizeLow = val;
457 /* Convert to Windows path format */
458 win32_ofile = get_pool_memory(PM_FNAME);
459 unix_name_to_win32(&win32_ofile, attr->ofname);
463 /* At this point, we have reconstructed the WIN32_FILE_ATTRIBUTE_DATA pkt */
465 if (!is_bopen(ofd)) {
466 Dmsg1(100, "File not open: %s\n", attr->ofname);
467 bopen(ofd, attr->ofname, O_WRONLY|O_BINARY, 0); /* attempt to open the file */
471 Dmsg1(100, "SetFileTime %s\n", attr->ofname);
472 if (!SetFileTime(bget_handle(ofd),
473 &atts.ftCreationTime,
474 &atts.ftLastAccessTime,
475 &atts.ftLastWriteTime)) {
476 win_error(jcr, "SetFileTime:", win32_ofile);
481 Dmsg1(100, "SetFileAtts %s\n", attr->ofname);
482 if (!(atts.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
483 if (!SetFileAttributes(win32_ofile, atts.dwFileAttributes & SET_ATTRS)) {
484 win_error(jcr, "SetFileAttributes:", win32_ofile);
487 free_pool_memory(win32_ofile);
491 void win_error(JCR *jcr, char *prefix, POOLMEM *win32_ofile)
493 DWORD lerror = GetLastError();
495 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
496 FORMAT_MESSAGE_FROM_SYSTEM,
503 Dmsg3(100, "Error in %s on file %s: ERR=%s\n", prefix, win32_ofile, msg);
504 strip_trailing_junk(msg);
505 Jmsg(jcr, M_ERROR, 0, _("Error in %s file %s: ERR=%s\n"), prefix, win32_ofile, msg);
509 void win_error(JCR *jcr, char *prefix, DWORD lerror)
512 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
513 FORMAT_MESSAGE_FROM_SYSTEM,
520 strip_trailing_junk(msg);
522 Jmsg2(jcr, M_ERROR, 0, _("Error in %s: ERR=%s\n"), prefix, msg);
524 MessageBox(NULL, msg, prefix, MB_OK);
530 /* Cygwin API definition */
531 extern "C" void cygwin_conv_to_win32_path(const char *path, char *win32_path);
533 void unix_name_to_win32(POOLMEM **win32_name, char *name)
535 /* One extra byte should suffice, but we double it */
536 *win32_name = check_pool_memory_size(*win32_name, 2*strlen(name)+1);
537 cygwin_conv_to_win32_path(name, *win32_name);
540 #endif /* HAVE_CYGWIN */