2 Bacula® - The Network Backup Solution
4 Copyright (C) 2002-2008 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 Kern Sibbald.
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 #define plug(st, val) st = val
232 /* Use templates to do the casting */
233 template <class T> void plug(T &st, uint64_t val)
234 { st = static_cast<T>(val); }
239 /* Decode a stat packet from base64 characters */
240 int decode_stat(char *buf, struct stat *statp, int32_t *LinkFI)
245 p += from_base64(&val, p);
246 plug(statp->st_dev, val);
248 p += from_base64(&val, p);
249 plug(statp->st_ino, val);
251 p += from_base64(&val, p);
252 plug(statp->st_mode, val);
254 p += from_base64(&val, p);
255 plug(statp->st_nlink, val);
257 p += from_base64(&val, p);
258 plug(statp->st_uid, val);
260 p += from_base64(&val, p);
261 plug(statp->st_gid, val);
263 p += from_base64(&val, p);
264 plug(statp->st_rdev, val);
266 p += from_base64(&val, p);
267 plug(statp->st_size, val);
270 p += from_base64(&val, p);
271 plug(statp->st_blksize, val);
273 p += from_base64(&val, p);
274 plug(statp->st_blocks, val);
277 p += from_base64(&val, p);
278 // plug(statp->st_blksize, val);
280 p += from_base64(&val, p);
281 // plug(statp->st_blocks, val);
284 p += from_base64(&val, p);
285 plug(statp->st_atime, val);
287 p += from_base64(&val, p);
288 plug(statp->st_mtime, val);
290 p += from_base64(&val, p);
291 plug(statp->st_ctime, val);
293 /* Optional FileIndex of hard linked file data */
294 if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
296 p += from_base64(&val, p);
297 *LinkFI = (uint32_t)val;
303 /* FreeBSD user flags */
304 if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
306 p += from_base64(&val, p);
308 plug(statp->st_flags, val);
314 /* Look for data stream id */
315 if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
317 p += from_base64(&val, p);
324 /* Decode a LinkFI field of encoded stat packet */
325 int32_t decode_LinkFI(char *buf, struct stat *statp)
330 skip_nonspaces(&p); /* st_dev */
331 p++; /* skip space */
332 skip_nonspaces(&p); /* st_ino */
334 p += from_base64(&val, p);
335 plug(statp->st_mode, val); /* st_mode */
337 skip_nonspaces(&p); /* st_nlink */
339 skip_nonspaces(&p); /* st_uid */
341 skip_nonspaces(&p); /* st_gid */
343 skip_nonspaces(&p); /* st_rdev */
345 skip_nonspaces(&p); /* st_size */
347 skip_nonspaces(&p); /* st_blksize */
349 skip_nonspaces(&p); /* st_blocks */
351 skip_nonspaces(&p); /* st_atime */
353 skip_nonspaces(&p); /* st_mtime */
355 skip_nonspaces(&p); /* st_ctime */
357 /* Optional FileIndex of hard linked file data */
358 if (*p == ' ' || (*p != 0 && *(p+1) == ' ')) {
360 p += from_base64(&val, p);
367 * Set file modes, permissions and times
369 * fname is the original filename
370 * ofile is the output filename (may be in a different directory)
372 * Returns: true on success
375 bool set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd)
388 #if defined(HAVE_WIN32)
389 if (attr->stream == STREAM_UNIX_ATTRIBUTES_EX &&
390 set_win32_attributes(jcr, attr, ofd)) {
394 pm_strcpy(attr->ofname, "*none*");
397 if (attr->data_stream == STREAM_WIN32_DATA ||
398 attr->data_stream == STREAM_WIN32_GZIP_DATA) {
402 pm_strcpy(attr->ofname, "*none*");
408 * If Windows stuff failed, e.g. attempt to restore Unix file
409 * to Windows, simply fall through and we will do it the
416 char ec1[50], ec2[50];
417 fsize = blseek(ofd, 0, SEEK_END);
418 bclose(ofd); /* first close file */
419 if (attr->type == FT_REG && fsize > 0 && attr->statp.st_size > 0 &&
420 fsize != (boffset_t)attr->statp.st_size) {
421 Jmsg3(jcr, M_ERROR, 0, _("File size of restored file %s not correct. Original %s, restored %s.\n"),
422 attr->ofname, edit_uint64(attr->statp.st_size, ec1),
423 edit_uint64(fsize, ec2));
428 * We do not restore sockets, so skip trying to restore their
431 if (attr->type == FT_SPEC && S_ISSOCK(attr->statp.st_mode)) {
435 ut.actime = attr->statp.st_atime;
436 ut.modtime = attr->statp.st_mtime;
438 /* ***FIXME**** optimize -- don't do if already correct */
440 * For link, change owner of link using lchown, but don't
441 * try to do a chmod as that will update the file behind it.
443 if (attr->type == FT_LNK) {
444 /* Change owner of link, not of real file */
445 if (lchown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0 && my_uid == 0) {
447 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
448 attr->ofname, be.bstrerror());
452 if (chown(attr->ofname, attr->statp.st_uid, attr->statp.st_gid) < 0 && my_uid == 0) {
454 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file owner %s: ERR=%s\n"),
455 attr->ofname, be.bstrerror());
458 if (chmod(attr->ofname, attr->statp.st_mode) < 0 && my_uid == 0) {
460 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file modes %s: ERR=%s\n"),
461 attr->ofname, be.bstrerror());
468 if (utime(attr->ofname, &ut) < 0 && my_uid == 0) {
470 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file times %s: ERR=%s\n"),
471 attr->ofname, be.bstrerror());
478 * Note, this should really be done before the utime() above,
479 * but if the immutable bit is set, it will make the utimes()
482 if (chflags(attr->ofname, attr->statp.st_flags) < 0 && my_uid == 0) {
484 Jmsg2(jcr, M_ERROR, 0, _("Unable to set file flags %s: ERR=%s\n"),
485 attr->ofname, be.bstrerror());
492 pm_strcpy(attr->ofname, "*none*");
498 /*=============================================================*/
500 /* * * * U n i x * * * * */
502 /*=============================================================*/
504 #if !defined(HAVE_WIN32)
507 * It is possible to piggyback additional data e.g. ACLs on
508 * the encode_stat() data by returning the extended attributes
509 * here. They must be "self-contained" (i.e. you keep track
510 * of your own length), and they must be in ASCII string
511 * format. Using this feature is not recommended.
512 * The code below shows how to return nothing. See the Win32
513 * code below for returning something in the attributes.
515 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
517 #ifdef HAVE_DARWIN_OS
519 * We save the Mac resource fork length so that on a
520 * restore, we can be sure we put back the whole resource.
524 if (ff_pkt->flags & FO_HFSPLUS) {
525 p += to_base64((uint64_t)(ff_pkt->hfsinfo.rsrclength), p);
529 *attribsEx = 0; /* no extended attributes */
531 return STREAM_UNIX_ATTRIBUTES;
538 /*=============================================================*/
540 /* * * * W i n 3 2 * * * * */
542 /*=============================================================*/
544 #if defined(HAVE_WIN32)
546 int encode_attribsEx(JCR *jcr, char *attribsEx, FF_PKT *ff_pkt)
549 WIN32_FILE_ATTRIBUTE_DATA atts;
552 attribsEx[0] = 0; /* no extended attributes */
554 if (jcr->cmd_plugin) {
555 return STREAM_UNIX_ATTRIBUTES;
558 unix_name_to_win32(&ff_pkt->sys_fname, ff_pkt->fname);
560 // try unicode version
561 if (p_GetFileAttributesExW) {
562 POOLMEM* pwszBuf = get_pool_memory(PM_FNAME);
563 make_win32_path_UTF8_2_wchar(&pwszBuf, ff_pkt->fname);
565 BOOL b=p_GetFileAttributesExW((LPCWSTR)pwszBuf, GetFileExInfoStandard,
567 free_pool_memory(pwszBuf);
570 win_error(jcr, "GetFileAttributesExW:", ff_pkt->sys_fname);
571 return STREAM_UNIX_ATTRIBUTES;
575 if (!p_GetFileAttributesExA)
576 return STREAM_UNIX_ATTRIBUTES;
578 if (!p_GetFileAttributesExA(ff_pkt->sys_fname, GetFileExInfoStandard,
580 win_error(jcr, "GetFileAttributesExA:", ff_pkt->sys_fname);
581 return STREAM_UNIX_ATTRIBUTES;
585 p += to_base64((uint64_t)atts.dwFileAttributes, p);
586 *p++ = ' '; /* separate fields with a space */
587 li.LowPart = atts.ftCreationTime.dwLowDateTime;
588 li.HighPart = atts.ftCreationTime.dwHighDateTime;
589 p += to_base64((uint64_t)li.QuadPart, p);
591 li.LowPart = atts.ftLastAccessTime.dwLowDateTime;
592 li.HighPart = atts.ftLastAccessTime.dwHighDateTime;
593 p += to_base64((uint64_t)li.QuadPart, p);
595 li.LowPart = atts.ftLastWriteTime.dwLowDateTime;
596 li.HighPart = atts.ftLastWriteTime.dwHighDateTime;
597 p += to_base64((uint64_t)li.QuadPart, p);
599 p += to_base64((uint64_t)atts.nFileSizeHigh, p);
601 p += to_base64((uint64_t)atts.nFileSizeLow, p);
603 return STREAM_UNIX_ATTRIBUTES_EX;
606 /* Define attributes that are legal to set with SetFileAttributes() */
607 #define SET_ATTRS ( \
608 FILE_ATTRIBUTE_ARCHIVE| \
609 FILE_ATTRIBUTE_HIDDEN| \
610 FILE_ATTRIBUTE_NORMAL| \
611 FILE_ATTRIBUTE_NOT_CONTENT_INDEXED| \
612 FILE_ATTRIBUTE_OFFLINE| \
613 FILE_ATTRIBUTE_READONLY| \
614 FILE_ATTRIBUTE_SYSTEM| \
615 FILE_ATTRIBUTE_TEMPORARY)
619 * Set Extended File Attributes for Win32
621 * fname is the original filename
622 * ofile is the output filename (may be in a different directory)
624 * Returns: true on success
627 static bool set_win32_attributes(JCR *jcr, ATTR *attr, BFILE *ofd)
629 char *p = attr->attrEx;
631 WIN32_FILE_ATTRIBUTE_DATA atts;
633 POOLMEM *win32_ofile;
635 // if we have neither ansi nor wchar version, we leave
636 if (!(p_SetFileAttributesW || p_SetFileAttributesA)) {
640 if (!p || !*p) { /* we should have attributes */
641 Dmsg2(100, "Attributes missing. of=%s ofd=%d\n", attr->ofname, ofd->fid);
647 Dmsg2(100, "Attribs %s = %s\n", attr->ofname, attr->attrEx);
650 p += from_base64(&val, p);
651 plug(atts.dwFileAttributes, val);
652 p++; /* skip space */
653 p += from_base64(&val, p);
655 atts.ftCreationTime.dwLowDateTime = li.LowPart;
656 atts.ftCreationTime.dwHighDateTime = li.HighPart;
657 p++; /* skip space */
658 p += from_base64(&val, p);
660 atts.ftLastAccessTime.dwLowDateTime = li.LowPart;
661 atts.ftLastAccessTime.dwHighDateTime = li.HighPart;
662 p++; /* skip space */
663 p += from_base64(&val, p);
665 atts.ftLastWriteTime.dwLowDateTime = li.LowPart;
666 atts.ftLastWriteTime.dwHighDateTime = li.HighPart;
668 p += from_base64(&val, p);
669 plug(atts.nFileSizeHigh, val);
671 p += from_base64(&val, p);
672 plug(atts.nFileSizeLow, val);
674 /* Convert to Windows path format */
675 win32_ofile = get_pool_memory(PM_FNAME);
676 unix_name_to_win32(&win32_ofile, attr->ofname);
678 /* At this point, we have reconstructed the WIN32_FILE_ATTRIBUTE_DATA pkt */
680 if (!is_bopen(ofd)) {
681 Dmsg1(100, "File not open: %s\n", attr->ofname);
682 bopen(ofd, attr->ofname, O_WRONLY|O_BINARY, 0); /* attempt to open the file */
686 Dmsg1(100, "SetFileTime %s\n", attr->ofname);
687 if (!SetFileTime(bget_handle(ofd),
688 &atts.ftCreationTime,
689 &atts.ftLastAccessTime,
690 &atts.ftLastWriteTime)) {
691 win_error(jcr, "SetFileTime:", win32_ofile);
696 Dmsg1(100, "SetFileAtts %s\n", attr->ofname);
697 if (!(atts.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
698 if (p_SetFileAttributesW) {
699 POOLMEM* pwszBuf = get_pool_memory(PM_FNAME);
700 make_win32_path_UTF8_2_wchar(&pwszBuf, attr->ofname);
702 BOOL b=p_SetFileAttributesW((LPCWSTR)pwszBuf, atts.dwFileAttributes & SET_ATTRS);
703 free_pool_memory(pwszBuf);
706 win_error(jcr, "SetFileAttributesW:", win32_ofile);
709 if (!p_SetFileAttributesA(win32_ofile, atts.dwFileAttributes & SET_ATTRS)) {
710 win_error(jcr, "SetFileAttributesA:", win32_ofile);
714 free_pool_memory(win32_ofile);
718 void win_error(JCR *jcr, char *prefix, POOLMEM *win32_ofile)
720 DWORD lerror = GetLastError();
722 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
723 FORMAT_MESSAGE_FROM_SYSTEM,
730 Dmsg3(100, "Error in %s on file %s: ERR=%s\n", prefix, win32_ofile, msg);
731 strip_trailing_junk(msg);
732 Jmsg(jcr, M_ERROR, 0, _("Error in %s file %s: ERR=%s\n"), prefix, win32_ofile, msg);
736 void win_error(JCR *jcr, char *prefix, DWORD lerror)
739 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
740 FORMAT_MESSAGE_FROM_SYSTEM,
747 strip_trailing_junk(msg);
749 Jmsg2(jcr, M_ERROR, 0, _("Error in %s: ERR=%s\n"), prefix, msg);
751 MessageBox(NULL, msg, prefix, MB_OK);
755 #endif /* HAVE_WIN32 */