2 Bacula® - The Network Backup Solution
4 Copyright (C) 2002-2007 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of John Walker.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
29 * Encode and decode standard Unix attributes and
30 * Extended attributes for Win32 and
31 * other non-Unix systems, or Unix systems with ACLs, ...
33 * Kern Sibbald, October MMII
42 static uid_t my_uid = 1;
43 static gid_t my_gid = 1;
44 static bool uid_set = false;
47 #if defined(HAVE_WIN32)
48 /* Forward referenced subroutines */
49 static bool set_win32_attributes(JCR *jcr, ATTR *attr, BFILE *ofd);
50 void unix_name_to_win32(POOLMEM **win32_name, char *name);
51 void win_error(JCR *jcr, char *prefix, POOLMEM *ofile);
52 HANDLE bget_handle(BFILE *bfd);
53 #endif /* HAVE_WIN32 */
55 /* For old systems that don't have lchown() use chown() */
60 /*=============================================================*/
62 /* *** A l l S y s t e m s *** */
64 /*=============================================================*/
67 * Return the data stream that will be used
69 int select_data_stream(FF_PKT *ff_pkt)
74 * Fix all incompatible options
77 /* No sparse option for encrypted data */
78 if (ff_pkt->flags & FO_ENCRYPT) {
79 ff_pkt->flags &= ~FO_SPARSE;
82 /* Note, no sparse option for win32_data */
83 if (!is_portable_backup(&ff_pkt->bfd)) {
84 stream = STREAM_WIN32_DATA;
85 ff_pkt->flags &= ~FO_SPARSE;
86 } else if (ff_pkt->flags & FO_SPARSE) {
87 stream = STREAM_SPARSE_DATA;
89 stream = STREAM_FILE_DATA;
92 /* Encryption is only supported for file data */
93 if (stream != STREAM_FILE_DATA && stream != STREAM_WIN32_DATA &&
94 stream != STREAM_MACOS_FORK_DATA) {
95 ff_pkt->flags &= ~FO_ENCRYPT;
98 /* Compression is not supported for Mac fork data */
99 if (stream == STREAM_MACOS_FORK_DATA) {
100 ff_pkt->flags &= ~FO_GZIP;
104 * Handle compression and encryption options
107 if (ff_pkt->flags & FO_GZIP) {
109 case STREAM_WIN32_DATA:
110 stream = STREAM_WIN32_GZIP_DATA;
112 case STREAM_SPARSE_DATA:
113 stream = STREAM_SPARSE_GZIP_DATA;
115 case STREAM_FILE_DATA:
116 stream = STREAM_GZIP_DATA;
119 /* All stream types that do not support gzip should clear out
120 * FO_GZIP above, and this code block should be unreachable. */
121 ASSERT(!(ff_pkt->flags & FO_GZIP));
127 if (ff_pkt->flags & FO_ENCRYPT) {
129 case STREAM_WIN32_DATA:
130 stream = STREAM_ENCRYPTED_WIN32_DATA;
132 case STREAM_WIN32_GZIP_DATA:
133 stream = STREAM_ENCRYPTED_WIN32_GZIP_DATA;
135 case STREAM_FILE_DATA:
136 stream = STREAM_ENCRYPTED_FILE_DATA;
138 case STREAM_GZIP_DATA:
139 stream = STREAM_ENCRYPTED_FILE_GZIP_DATA;
142 /* All stream types that do not support encryption should clear out
143 * FO_ENCRYPT above, and this code block should be unreachable. */
144 ASSERT(!(ff_pkt->flags & FO_ENCRYPT));
155 * Encode a stat structure into a base64 character string
156 * All systems must create such a structure.
157 * In addition, we tack on the LinkFI, which is non-zero in
158 * the case of a hard linked file that has no data. This
159 * is a File Index pointing to the link that does have the
160 * data (always the first one encountered in a save).
161 * You may piggyback attributes on this packet by encoding
162 * them in the encode_attribsEx() subroutine, but this is
165 void encode_stat(char *buf, FF_PKT *ff_pkt, int data_stream)
168 struct stat *statp = &ff_pkt->statp;
170 * Encode a stat packet. I should have done this more intelligently
171 * with a length so that it could be easily expanded.
173 p += to_base64((int64_t)statp->st_dev, p);
174 *p++ = ' '; /* separate fields with a space */
175 p += to_base64((int64_t)statp->st_ino, p);
177 p += to_base64((int64_t)statp->st_mode, p);
179 p += to_base64((int64_t)statp->st_nlink, p);
181 p += to_base64((int64_t)statp->st_uid, p);
183 p += to_base64((int64_t)statp->st_gid, p);
185 p += to_base64((int64_t)statp->st_rdev, p);
187 p += to_base64((int64_t)statp->st_size, p);
190 p += to_base64((int64_t)statp->st_blksize, p);
192 p += to_base64((int64_t)statp->st_blocks, p);
195 p += to_base64((int64_t)0, p); /* output place holder */
197 p += to_base64((int64_t)0, p); /* output place holder */
200 p += to_base64((int64_t)statp->st_atime, p);
202 p += to_base64((int64_t)statp->st_mtime, p);
204 p += to_base64((int64_t)statp->st_ctime, p);
206 p += to_base64((int64_t)ff_pkt->LinkFI, p);
210 /* FreeBSD function */
211 p += to_base64((int64_t)statp->st_flags, p); /* output st_flags */
213 p += to_base64((int64_t)0, p); /* output place holder */
216 p += to_base64((int64_t)data_stream, p);
222 /* Do casting according to unknown type to keep compiler happy */
224 #define plug(st, val) st = (typeof st)val
226 #if !HAVE_GCC & HAVE_SUN_OS
227 /* Sun compiler does not handle templates correctly */
228 #define plug(st, val) st = val
230 /* Use templates to do the casting */
231 template <class T> void plug(T &st, uint64_t val)
232 { st = static_cast<T>(val); }
237 /* Decode a stat packet from base64 characters */
238 int decode_stat(char *buf, struct stat *statp, int32_t *LinkFI)
243 p += from_base64(&val, p);
244 plug(statp->st_dev, val);
246 p += from_base64(&val, p);
247 plug(statp->st_ino, val);
249 p += from_base64(&val, p);
250 plug(statp->st_mode, val);
252 p += from_base64(&val, p);
253 plug(statp->st_nlink, val);
255 p += from_base64(&val, p);
256 plug(statp->st_uid, val);
258 p += from_base64(&val, p);
259 plug(statp->st_gid, val);
261 p += from_base64(&val, p);
262 plug(statp->st_rdev, val);
264 p += from_base64(&val, p);
265 plug(statp->st_size, val);
268 p += from_base64(&val, p);
269 plug(statp->st_blksize, val);
271 p += from_base64(&val, p);
272 plug(statp->st_blocks, val);
275 p += from_base64(&val, p);
276 // plug(statp->st_blksize, val);
278 p += from_base64(&val, p);
279 // plug(statp->st_blocks, val);
282 p += from_base64(&val, p);
283 plug(statp->st_atime, val);
285 p += from_base64(&val, p);
286 plug(statp->st_mtime, val);
288 p += from_base64(&val, p);
289 plug(statp->st_ctime, val);
291 /* Optional FileIndex of hard linked file data */
292 if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
294 p += from_base64(&val, p);
295 *LinkFI = (uint32_t)val;
301 /* FreeBSD user flags */
302 if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
304 p += from_base64(&val, p);
306 plug(statp->st_flags, val);
312 /* Look for data stream id */
313 if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
315 p += from_base64(&val, p);
322 /* Decode a LinkFI field of encoded stat packet */
323 int32_t decode_LinkFI(char *buf, struct stat *statp)
328 skip_nonspaces(&p); /* st_dev */
329 p++; /* skip space */
330 skip_nonspaces(&p); /* st_ino */
332 p += from_base64(&val, p);
333 plug(statp->st_mode, val); /* st_mode */
335 skip_nonspaces(&p); /* st_nlink */
337 skip_nonspaces(&p); /* st_uid */
339 skip_nonspaces(&p); /* st_gid */
341 skip_nonspaces(&p); /* st_rdev */
343 skip_nonspaces(&p); /* st_size */
345 skip_nonspaces(&p); /* st_blksize */
347 skip_nonspaces(&p); /* st_blocks */
349 skip_nonspaces(&p); /* st_atime */
351 skip_nonspaces(&p); /* st_mtime */
353 skip_nonspaces(&p); /* st_ctime */
355 /* Optional FileIndex of hard linked file data */
356 if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
358 p += from_base64(&val, p);
365 * Set file modes, permissions and times
367 * fname is the original filename
368 * ofile is the output filename (may be in a different directory)
370 * Returns: true on success
373 bool set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd)
386 #if defined(HAVE_WIN32)
387 if (attr->stream == STREAM_UNIX_ATTRIBUTES_EX &&
388 set_win32_attributes(jcr, attr, ofd)) {
392 pm_strcpy(attr->ofname, "*none*");
395 if (attr->data_stream == STREAM_WIN32_DATA ||
396 attr->data_stream == STREAM_WIN32_GZIP_DATA) {
400 pm_strcpy(attr->ofname, "*none*");
406 * If Windows stuff failed, e.g. attempt to restore Unix file
407 * to Windows, simply fall through and we will do it the
414 char ec1[50], ec2[50];
415 fsize = blseek(ofd, 0, SEEK_END);
416 bclose(ofd); /* first close file */
417 if (attr->type == FT_REG && fsize > 0 && attr->statp.st_size > 0 &&
418 fsize != (boffset_t)attr->statp.st_size) {
419 Jmsg3(jcr, M_ERROR, 0, _("File size of restored file %s not correct. Original %s, restored %s.\n"),
420 attr->ofname, edit_uint64(attr->statp.st_size, ec1),
421 edit_uint64(fsize, ec2));
426 * We do not restore sockets, so skip trying to restore their
429 if (attr->type == FT_SPEC && S_ISSOCK(attr->statp.st_mode)) {
433 ut.actime = attr->statp.st_atime;
434 ut.modtime = attr->statp.st_mtime;
436 /* ***FIXME**** optimize -- don't do if already correct */
438 * For link, change owner of link using lchown, but don't
439 * try to do a chmod as that will update the file behind it.
441 if (attr->type == FT_LNK) {
442 /* Change owner of link, not of real file */
443 if (lchown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0 && my_uid == 0) {
445 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
446 attr->ofname, be.bstrerror());
450 if (chown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0 && my_uid == 0) {
452 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
453 attr->ofname, be.bstrerror());
456 if (chmod(attr->ofname, attr->statp.st_mode) < 0 && my_uid == 0) {
458 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file modes %s: ERR=%s\n"),
459 attr->ofname, be.bstrerror());
466 if (utime(attr->ofname, &ut) < 0 && my_uid == 0) {
468 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file times %s: ERR=%s\n"),
469 attr->ofname, be.bstrerror());
476 * Note, this should really be done before the utime() above,
477 * but if the immutable bit is set, it will make the utimes()
480 if (chflags(attr->ofname, attr->statp.st_flags) < 0 && my_uid == 0) {
482 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file flags %s: ERR=%s\n"),
483 attr->ofname, be.bstrerror());
490 pm_strcpy(attr->ofname, "*none*");
496 /*=============================================================*/
498 /* * * * U n i x * * * * */
500 /*=============================================================*/
502 #if !defined(HAVE_WIN32)
505 * It is possible to piggyback additional data e.g. ACLs on
506 * the encode_stat() data by returning the extended attributes
507 * here. They must be "self-contained" (i.e. you keep track
508 * of your own length), and they must be in ASCII string
509 * format. Using this feature is not recommended.
510 * The code below shows how to return nothing. See the Win32
511 * code below for returning something in the attributes.
513 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
515 #ifdef HAVE_DARWIN_OS
517 * We save the Mac resource fork length so that on a
518 * restore, we can be sure we put back the whole resource.
522 if (ff_pkt->flags & FO_HFSPLUS) {
523 p += to_base64((uint64_t)(ff_pkt->hfsinfo.rsrclength), p);
527 *attribsEx = 0; /* no extended attributes */
529 return STREAM_UNIX_ATTRIBUTES;
536 /*=============================================================*/
538 /* * * * W i n 3 2 * * * * */
540 /*=============================================================*/
542 #if defined(HAVE_WIN32)
544 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
547 WIN32_FILE_ATTRIBUTE_DATA atts;
550 attribsEx[0] = 0; /* no extended attributes */
552 unix_name_to_win32(&ff_pkt->sys_fname, ff_pkt->fname);
554 // try unicode version
555 if (p_GetFileAttributesExW) {
556 POOLMEM* pwszBuf = get_pool_memory (PM_FNAME);
557 make_win32_path_UTF8_2_wchar(&pwszBuf, ff_pkt->fname);
559 BOOL b=p_GetFileAttributesExW((LPCWSTR) pwszBuf, GetFileExInfoStandard, (LPVOID)&atts);
560 free_pool_memory(pwszBuf);
563 win_error(jcr, "GetFileAttributesExW:", ff_pkt->sys_fname);
564 return STREAM_UNIX_ATTRIBUTES;
568 if (!p_GetFileAttributesExA)
569 return STREAM_UNIX_ATTRIBUTES;
571 if (!p_GetFileAttributesExA(ff_pkt->sys_fname, GetFileExInfoStandard,
573 win_error(jcr, "GetFileAttributesExA:", ff_pkt->sys_fname);
574 return STREAM_UNIX_ATTRIBUTES;
578 p += to_base64((uint64_t)atts.dwFileAttributes, p);
579 *p++ = ' '; /* separate fields with a space */
580 li.LowPart = atts.ftCreationTime.dwLowDateTime;
581 li.HighPart = atts.ftCreationTime.dwHighDateTime;
582 p += to_base64((uint64_t)li.QuadPart, p);
584 li.LowPart = atts.ftLastAccessTime.dwLowDateTime;
585 li.HighPart = atts.ftLastAccessTime.dwHighDateTime;
586 p += to_base64((uint64_t)li.QuadPart, p);
588 li.LowPart = atts.ftLastWriteTime.dwLowDateTime;
589 li.HighPart = atts.ftLastWriteTime.dwHighDateTime;
590 p += to_base64((uint64_t)li.QuadPart, p);
592 p += to_base64((uint64_t)atts.nFileSizeHigh, p);
594 p += to_base64((uint64_t)atts.nFileSizeLow, p);
596 return STREAM_UNIX_ATTRIBUTES_EX;
599 /* Define attributes that are legal to set with SetFileAttributes() */
600 #define SET_ATTRS ( \
601 FILE_ATTRIBUTE_ARCHIVE| \
602 FILE_ATTRIBUTE_HIDDEN| \
603 FILE_ATTRIBUTE_NORMAL| \
604 FILE_ATTRIBUTE_NOT_CONTENT_INDEXED| \
605 FILE_ATTRIBUTE_OFFLINE| \
606 FILE_ATTRIBUTE_READONLY| \
607 FILE_ATTRIBUTE_SYSTEM| \
608 FILE_ATTRIBUTE_TEMPORARY)
612 * Set Extended File Attributes for Win32
614 * fname is the original filename
615 * ofile is the output filename (may be in a different directory)
617 * Returns: true on success
620 static bool set_win32_attributes(JCR *jcr, ATTR *attr, BFILE *ofd)
622 char *p = attr->attrEx;
624 WIN32_FILE_ATTRIBUTE_DATA atts;
626 POOLMEM *win32_ofile;
628 // if we have neither ansi nor wchar version, we leave
629 if (!(p_SetFileAttributesW || p_SetFileAttributesA))
632 if (!p || !*p) { /* we should have attributes */
633 Dmsg2(100, "Attributes missing. of=%s ofd=%d\n", attr->ofname, ofd->fid);
639 Dmsg2(100, "Attribs %s = %s\n", attr->ofname, attr->attrEx);
642 p += from_base64(&val, p);
643 plug(atts.dwFileAttributes, val);
644 p++; /* skip space */
645 p += from_base64(&val, p);
647 atts.ftCreationTime.dwLowDateTime = li.LowPart;
648 atts.ftCreationTime.dwHighDateTime = li.HighPart;
649 p++; /* skip space */
650 p += from_base64(&val, p);
652 atts.ftLastAccessTime.dwLowDateTime = li.LowPart;
653 atts.ftLastAccessTime.dwHighDateTime = li.HighPart;
654 p++; /* skip space */
655 p += from_base64(&val, p);
657 atts.ftLastWriteTime.dwLowDateTime = li.LowPart;
658 atts.ftLastWriteTime.dwHighDateTime = li.HighPart;
660 p += from_base64(&val, p);
661 plug(atts.nFileSizeHigh, val);
663 p += from_base64(&val, p);
664 plug(atts.nFileSizeLow, val);
666 /* Convert to Windows path format */
667 win32_ofile = get_pool_memory(PM_FNAME);
668 unix_name_to_win32(&win32_ofile, attr->ofname);
670 /* At this point, we have reconstructed the WIN32_FILE_ATTRIBUTE_DATA pkt */
672 if (!is_bopen(ofd)) {
673 Dmsg1(100, "File not open: %s\n", attr->ofname);
674 bopen(ofd, attr->ofname, O_WRONLY|O_BINARY, 0); /* attempt to open the file */
678 Dmsg1(100, "SetFileTime %s\n", attr->ofname);
679 if (!SetFileTime(bget_handle(ofd),
680 &atts.ftCreationTime,
681 &atts.ftLastAccessTime,
682 &atts.ftLastWriteTime)) {
683 win_error(jcr, "SetFileTime:", win32_ofile);
688 Dmsg1(100, "SetFileAtts %s\n", attr->ofname);
689 if (!(atts.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY))
691 if (p_SetFileAttributesW) {
692 POOLMEM* pwszBuf = get_pool_memory (PM_FNAME);
693 make_win32_path_UTF8_2_wchar(&pwszBuf, attr->ofname);
695 BOOL b=p_SetFileAttributesW((LPCWSTR)pwszBuf, atts.dwFileAttributes & SET_ATTRS);
696 free_pool_memory(pwszBuf);
699 win_error(jcr, "SetFileAttributesW:", win32_ofile);
702 if (!p_SetFileAttributesA(win32_ofile, atts.dwFileAttributes & SET_ATTRS)) {
703 win_error(jcr, "SetFileAttributesA:", win32_ofile);
707 free_pool_memory(win32_ofile);
711 void win_error(JCR *jcr, char *prefix, POOLMEM *win32_ofile)
713 DWORD lerror = GetLastError();
715 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
716 FORMAT_MESSAGE_FROM_SYSTEM,
723 Dmsg3(100, "Error in %s on file %s: ERR=%s\n", prefix, win32_ofile, msg);
724 strip_trailing_junk(msg);
725 Jmsg(jcr, M_ERROR, 0, _("Error in %s file %s: ERR=%s\n"), prefix, win32_ofile, msg);
729 void win_error(JCR *jcr, char *prefix, DWORD lerror)
732 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
733 FORMAT_MESSAGE_FROM_SYSTEM,
740 strip_trailing_junk(msg);
742 Jmsg2(jcr, M_ERROR, 0, _("Error in %s: ERR=%s\n"), prefix, msg);
744 MessageBox(NULL, msg, prefix, MB_OK);
748 #endif /* HAVE_WIN32 */