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) {
244 pm_strcpy(&attr->ofname, "*none*");
248 if (attr->stream == STREAM_UNIX_ATTRIBUTES_EX &&
249 set_win32_attributes(jcr, attr, ofd)) {
253 pm_strcpy(&attr->ofname, "*none*");
257 * If Windows stuff failed, e.g. attempt to restore Unix file
258 * to Windows, simply fall through and we will do it the
265 bclose(ofd); /* first close file */
268 ut.actime = attr->statp.st_atime;
269 ut.modtime = attr->statp.st_mtime;
271 /* ***FIXME**** optimize -- don't do if already correct */
273 * For link, change owner of link using lchown, but don't
274 * try to do a chmod as that will update the file behind it.
276 if (attr->type == FT_LNK) {
277 /* Change owner of link, not of real file */
278 if (lchown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0) {
279 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
280 attr->ofname, strerror(errno));
284 if (chown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0) {
285 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
286 attr->ofname, strerror(errno));
289 if (chmod(attr->ofname, attr->statp.st_mode) < 0) {
290 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file modes %s: ERR=%s\n"),
291 attr->ofname, strerror(errno));
295 /* FreeBSD user flags */
297 if (chflags(attr->ofname, attr->statp.st_flags) < 0) {
298 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file flags %s: ERR=%s\n"),
299 attr->ofname, strerror(errno));
306 if (utime(attr->ofname, &ut) < 0) {
307 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file times %s: ERR=%s\n"),
308 attr->ofname, strerror(errno));
312 pm_strcpy(&attr->ofname, "*none*");
318 /*=============================================================*/
320 /* * * * U n i x * * * * */
322 /*=============================================================*/
327 * It is possible to piggyback additional data e.g. ACLs on
328 * the encode_stat() data by returning the extended attributes
329 * here. They must be "self-contained" (i.e. you keep track
330 * of your own length), and they must be in ASCII string
331 * format. Using this feature is not recommended.
332 * The code below shows how to return nothing. See the Win32
333 * code below for returning something in the attributes.
335 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
337 *attribsEx = 0; /* no extended attributes */
338 return STREAM_UNIX_ATTRIBUTES;
345 /*=============================================================*/
347 /* * * * W i n 3 2 * * * * */
349 /*=============================================================*/
353 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
356 WIN32_FILE_ATTRIBUTE_DATA atts;
359 attribsEx[0] = 0; /* no extended attributes */
361 if (!p_GetFileAttributesEx) {
362 return STREAM_UNIX_ATTRIBUTES;
365 unix_name_to_win32(&ff_pkt->sys_fname, ff_pkt->fname);
366 if (!p_GetFileAttributesEx(ff_pkt->sys_fname, GetFileExInfoStandard,
368 win_error(jcr, "GetFileAttributesEx:", ff_pkt->sys_fname);
369 return STREAM_UNIX_ATTRIBUTES;
372 p += to_base64((uint64_t)atts.dwFileAttributes, p);
373 *p++ = ' '; /* separate fields with a space */
374 li.LowPart = atts.ftCreationTime.dwLowDateTime;
375 li.HighPart = atts.ftCreationTime.dwHighDateTime;
376 p += to_base64((uint64_t)li.QuadPart, p);
378 li.LowPart = atts.ftLastAccessTime.dwLowDateTime;
379 li.HighPart = atts.ftLastAccessTime.dwHighDateTime;
380 p += to_base64((uint64_t)li.QuadPart, p);
382 li.LowPart = atts.ftLastWriteTime.dwLowDateTime;
383 li.HighPart = atts.ftLastWriteTime.dwHighDateTime;
384 p += to_base64((uint64_t)li.QuadPart, p);
386 p += to_base64((uint64_t)atts.nFileSizeHigh, p);
388 p += to_base64((uint64_t)atts.nFileSizeLow, p);
390 return STREAM_UNIX_ATTRIBUTES_EX;
393 /* Define attributes that are legal to set with SetFileAttributes() */
394 #define SET_ATTRS ( \
395 FILE_ATTRIBUTE_ARCHIVE| \
396 FILE_ATTRIBUTE_HIDDEN| \
397 FILE_ATTRIBUTE_NORMAL| \
398 FILE_ATTRIBUTE_NOT_CONTENT_INDEXED| \
399 FILE_ATTRIBUTE_OFFLINE| \
400 FILE_ATTRIBUTE_READONLY| \
401 FILE_ATTRIBUTE_SYSTEM| \
402 FILE_ATTRIBUTE_TEMPORARY)
406 * Set Extended File Attributes for Win32
408 * fname is the original filename
409 * ofile is the output filename (may be in a different directory)
411 * Returns: 1 on success
414 static int set_win32_attributes(JCR *jcr, ATTR *attr, BFILE *ofd)
416 char *p = attr->attrEx;
418 WIN32_FILE_ATTRIBUTE_DATA atts;
420 POOLMEM *win32_ofile;
422 if (!p_GetFileAttributesEx) {
426 if (!p || !*p) { /* we should have attributes */
427 Dmsg2(100, "Attributes missing. of=%s ofd=%d\n", attr->ofname, ofd->fid);
433 Dmsg2(100, "Attribs %s = %s\n", attr->ofname, attr->attrEx);
436 p += from_base64(&val, p);
437 atts.dwFileAttributes = val;
438 p++; /* skip space */
439 p += from_base64(&val, p);
441 atts.ftCreationTime.dwLowDateTime = li.LowPart;
442 atts.ftCreationTime.dwHighDateTime = li.HighPart;
443 p++; /* skip space */
444 p += from_base64(&val, p);
446 atts.ftLastAccessTime.dwLowDateTime = li.LowPart;
447 atts.ftLastAccessTime.dwHighDateTime = li.HighPart;
448 p++; /* skip space */
449 p += from_base64(&val, p);
451 atts.ftLastWriteTime.dwLowDateTime = li.LowPart;
452 atts.ftLastWriteTime.dwHighDateTime = li.HighPart;
454 p += from_base64(&val, p);
455 atts.nFileSizeHigh = val;
457 p += from_base64(&val, p);
458 atts.nFileSizeLow = val;
460 /* Convert to Windows path format */
461 win32_ofile = get_pool_memory(PM_FNAME);
462 unix_name_to_win32(&win32_ofile, attr->ofname);
466 /* At this point, we have reconstructed the WIN32_FILE_ATTRIBUTE_DATA pkt */
468 if (!is_bopen(ofd)) {
469 Dmsg1(100, "File not open: %s\n", attr->ofname);
470 bopen(ofd, attr->ofname, O_WRONLY|O_BINARY, 0); /* attempt to open the file */
474 Dmsg1(100, "SetFileTime %s\n", attr->ofname);
475 if (!SetFileTime(bget_handle(ofd),
476 &atts.ftCreationTime,
477 &atts.ftLastAccessTime,
478 &atts.ftLastWriteTime)) {
479 win_error(jcr, "SetFileTime:", win32_ofile);
484 Dmsg1(100, "SetFileAtts %s\n", attr->ofname);
485 if (!(atts.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
486 if (!SetFileAttributes(win32_ofile, atts.dwFileAttributes & SET_ATTRS)) {
487 win_error(jcr, "SetFileAttributes:", win32_ofile);
490 free_pool_memory(win32_ofile);
494 void win_error(JCR *jcr, char *prefix, POOLMEM *win32_ofile)
496 DWORD lerror = GetLastError();
498 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
499 FORMAT_MESSAGE_FROM_SYSTEM,
506 Dmsg3(100, "Error in %s on file %s: ERR=%s\n", prefix, win32_ofile, msg);
507 strip_trailing_junk(msg);
508 Jmsg(jcr, M_ERROR, 0, _("Error in %s file %s: ERR=%s\n"), prefix, win32_ofile, msg);
512 void win_error(JCR *jcr, char *prefix, DWORD lerror)
515 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
516 FORMAT_MESSAGE_FROM_SYSTEM,
523 strip_trailing_junk(msg);
525 Jmsg2(jcr, M_ERROR, 0, _("Error in %s: ERR=%s\n"), prefix, msg);
527 MessageBox(NULL, msg, prefix, MB_OK);
533 /* Cygwin API definition */
534 extern "C" void cygwin_conv_to_win32_path(const char *path, char *win32_path);
536 void unix_name_to_win32(POOLMEM **win32_name, char *name)
538 /* One extra byte should suffice, but we double it */
539 *win32_name = check_pool_memory_size(*win32_name, 2*strlen(name)+1);
540 cygwin_conv_to_win32_path(name, *win32_name);
543 #endif /* HAVE_CYGWIN */