2 * Bacula File Daemon restore.c Restorefiles.
4 * Kern Sibbald, November MM
10 Copyright (C) 2000-2003 Kern Sibbald and John Walker
12 This program is free software; you can redistribute it and/or
13 modify it under the terms of the GNU General Public License as
14 published by the Free Software Foundation; either version 2 of
15 the License, or (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 General Public License for more details.
22 You should have received a copy of the GNU General Public
23 License along with this program; if not, write to the Free
24 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
32 /* Data received from Storage Daemon */
33 static char rec_header[] = "rechdr %ld %ld %ld %ld %ld";
35 /* Forward referenced functions */
36 static void print_ls_output(JCR *jcr, char *fname, char *lname, int type, struct stat *statp);
38 #define RETRY 10 /* retry wait time */
41 * Restore the requested files.
44 void do_restore(JCR *jcr)
48 POOLMEM *fname; /* original file name */
49 POOLMEM *ofile; /* output name with possible prefix */
50 POOLMEM *lname; /* link name with possible prefix */
51 POOLMEM *attribsEx; /* Extended attributes (Win32) */
54 uint32_t VolSessionId, VolSessionTime, file_index;
55 uint32_t record_file_index;
60 uint32_t total = 0; /* Job total but only 32 bits for debug */
61 char *wbuf; /* write buffer */
62 uint32_t wsize; /* write size */
63 uint64_t fileAddr = 0; /* file write address */
65 wherelen = strlen(jcr->where);
67 binit(&bfd, jcr->use_win_backup_api);
68 sd = jcr->store_bsock;
69 set_jcr_job_status(jcr, JS_Running);
71 if (!bnet_set_buffer_size(sd, MAX_NETWORK_BUFFER_SIZE, BNET_SETBUF_READ)) {
72 set_jcr_job_status(jcr, JS_ErrorTerminated);
75 jcr->buf_size = sd->msglen;
77 fname = get_pool_memory(PM_FNAME);
78 ofile = get_pool_memory(PM_FNAME);
79 lname = get_pool_memory(PM_FNAME);
80 attribsEx = get_pool_memory(PM_FNAME);
83 uint32_t compress_buf_size = jcr->buf_size + 12 + ((jcr->buf_size+999) / 1000) + 100;
84 jcr->compress_buf = (char *)bmalloc(compress_buf_size);
88 * Get a record from the Storage daemon. We are guaranteed to
89 * receive records in the following order:
90 * 1. Stream record header
92 * a. Attributes (Unix or Win32)
93 * or b. File data for the file
94 * or c. Possibly MD5 or SHA1 record
97 while (bnet_recv(sd) >= 0 && !job_canceled(jcr)) {
99 * First we expect a Stream Record Header
101 if (sscanf(sd->msg, rec_header, &VolSessionId, &VolSessionTime, &file_index,
102 &stream, &size) != 5) {
103 Jmsg1(jcr, M_FATAL, 0, _("Record header scan error: %s\n"), sd->msg);
106 Dmsg2(30, "Got hdr: FilInx=%d Stream=%d.\n", file_index, stream);
109 * Now we expect the Stream Data
111 if (bnet_recv(sd) < 0) {
112 Jmsg1(jcr, M_FATAL, 0, _("Data record error. ERR=%s\n"), bnet_strerror(sd));
115 if (size != (uint32_t)sd->msglen) {
116 Jmsg2(jcr, M_FATAL, 0, _("Actual data size %d not same as header %d\n"), sd->msglen, size);
119 Dmsg1(30, "Got stream data, len=%d\n", sd->msglen);
121 /* File Attributes stream */
122 if (stream == STREAM_UNIX_ATTRIBUTES || stream == STREAM_WIN32_ATTRIBUTES) {
123 char *ap, *lp, *fp, *apex;
126 Dmsg1(30, "Stream=Unix Attributes. extract=%d\n", extract);
127 /* If extracting, it was from previous stream, so
128 * close the output file.
131 if (!is_bopen(&bfd)) {
132 Jmsg0(jcr, M_ERROR, 0, _("Logic error output file should be open\n"));
134 set_attributes(jcr, fname, ofile, lname, type, stream,
135 &statp, attribsEx, &bfd);
137 Dmsg0(30, "Stop extracting.\n");
140 if ((int)sizeof_pool_memory(fname) < sd->msglen) {
141 fname = realloc_pool_memory(fname, sd->msglen + 1);
143 if ((int)sizeof_pool_memory(ofile) < sd->msglen + wherelen + 1) {
144 ofile = realloc_pool_memory(ofile, sd->msglen + wherelen + 1);
146 if ((int)sizeof_pool_memory(lname) < sd->msglen + wherelen + 1) {
147 lname = realloc_pool_memory(lname, sd->msglen + wherelen + 1);
153 * An Attributes record consists of:
158 * Link name (if file linked i.e. FT_LNK)
159 * Extended attributes (Win32)
162 Dmsg1(100, "Attr: %s\n", sd->msg);
163 if (sscanf(sd->msg, "%d %d", &record_file_index, &type) != 2) {
164 Jmsg(jcr, M_FATAL, 0, _("Error scanning attributes: %s\n"), sd->msg);
165 Dmsg1(100, "\nError scanning attributes. %s\n", sd->msg);
168 Dmsg2(100, "Got Attr: FilInx=%d type=%d\n", record_file_index, type);
169 if (record_file_index != file_index) {
170 Jmsg(jcr, M_FATAL, 0, _("Record header file index %ld not equal record index %ld\n"),
171 file_index, record_file_index);
172 Dmsg0(100, "File index error\n");
176 while (*ap++ != ' ') /* skip record file index */
178 while (*ap++ != ' ') /* skip type */
180 /* Save filename and position to attributes */
183 *fp++ = *ap++; /* copy filename to fname */
185 *fp = *ap++; /* terminate filename & point to attribs */
187 /* Skip to Link name */
188 if (type == FT_LNK || type == FT_LNKSAVED) {
197 if (stream == STREAM_WIN32_ATTRIBUTES) {
198 apex = ap; /* start at attributes */
199 while (*apex++ != 0) { /* skip attributes */
202 while (*apex++ != 0) { /* skip link name */
205 pm_strcpy(&attribsEx, apex); /* make a copy */
207 *attribsEx = 0; /* no extended attributes */
210 Dmsg3(200, "File %s\nattrib=%s\nattribsEx=%s\n", fname, ap, attribsEx);
212 decode_stat(ap, &statp, &LinkFI);
214 * Prepend the where directory so that the
215 * files are put where the user wants.
217 * We do a little jig here to handle Win32 files with
218 * a drive letter -- we simply strip the drive: from
219 * every filename if a prefix is supplied.
222 if (jcr->where[0] == 0) {
223 strcpy(ofile, fname);
227 strcpy(ofile, jcr->where); /* copy prefix */
228 if (win32_client && fname[1] == ':') {
229 fn = fname+2; /* skip over drive: */
231 fn = fname; /* take whole name */
233 /* Ensure where is terminated with a slash */
234 if (jcr->where[wherelen-1] != '/' && fn[0] != '/') {
237 strcat(ofile, fn); /* copy rest of name */
239 * Fixup link name -- if it is an absolute path
241 if (type == FT_LNKSAVED || type == FT_LNK) {
243 /* Always add prefix to hard links (FT_LNKSAVED) and
244 * on user request to soft links
247 (type == FT_LNKSAVED || jcr->prefix_links)) {
248 strcpy(lname, jcr->where);
254 if (win32_client && lp[1] == ':') {
255 fn = lp+2; /* skip over drive: */
257 fn = lp; /* take whole name */
259 /* Ensure where is terminated with a slash */
260 if (add_link && jcr->where[wherelen-1] != '/' && fn[0] != '/') {
263 strcat(lname, fn); /* copy rest of link */
267 Dmsg1(30, "Outfile=%s\n", ofile);
270 stat = create_file(jcr, fname, ofile, lname, type,
271 stream, &statp, attribsEx, &bfd, jcr->replace,
272 jcr->use_win_backup_api);
280 pm_strcpy(&jcr->last_fname, ofile);
284 print_ls_output(jcr, ofile, lname, type, &statp);
285 /* Set attributes after file extracted */
290 print_ls_output(jcr, ofile, lname, type, &statp);
291 /* set attributes now because file will not be extracted */
292 set_attributes(jcr, fname, ofile, lname, type, stream,
293 &statp, attribsEx, &bfd);
297 jcr->num_files_examined++;
300 } else if (stream == STREAM_FILE_DATA || stream == STREAM_SPARSE_DATA) {
302 if (stream == STREAM_SPARSE_DATA) {
307 wbuf = sd->msg + SPARSE_FADDR_SIZE;
308 wsize = sd->msglen - SPARSE_FADDR_SIZE;
309 ser_begin(sd->msg, SPARSE_FADDR_SIZE);
311 if (fileAddr != faddr) {
313 if (blseek(&bfd, (off_t)fileAddr, SEEK_SET) < 0) {
314 Jmsg3(jcr, M_ERROR, 0, _("Seek to %s error on %s: ERR=%s\n"),
315 edit_uint64(fileAddr, ec1), ofile, berror(&bfd));
323 Dmsg2(30, "Write %u bytes, total before write=%u\n", wsize, total);
324 if ((uint32_t)bwrite(&bfd, wbuf, wsize) != wsize) {
325 Dmsg0(0, "===Write error===\n");
326 Jmsg2(jcr, M_ERROR, 0, _("Write error on %s: %s\n"), ofile, berror(&bfd));
330 jcr->JobBytes += wsize;
334 /* GZIP data stream */
335 } else if (stream == STREAM_GZIP_DATA || stream == STREAM_SPARSE_GZIP_DATA) {
344 if (stream == STREAM_SPARSE_GZIP_DATA) {
345 wbuf = sd->msg + SPARSE_FADDR_SIZE;
346 wsize = sd->msglen - SPARSE_FADDR_SIZE;
347 ser_begin(sd->msg, SPARSE_FADDR_SIZE);
349 if (fileAddr != faddr) {
351 if (blseek(&bfd, (off_t)fileAddr, SEEK_SET) < 0) {
352 Jmsg3(jcr, M_ERROR, 0, _("Seek to %s error on %s: ERR=%s\n"),
353 edit_uint64(fileAddr, ec1), ofile, berror(&bfd));
361 compress_len = compress_buf_size;
362 Dmsg2(100, "Comp_len=%d msglen=%d\n", compress_len, wsize);
363 if ((stat=uncompress((Byte *)jcr->compress_buf, &compress_len,
364 (const Byte *)wbuf, (uLong)wsize)) != Z_OK) {
365 Jmsg(jcr, M_ERROR, 0, _("Uncompression error. ERR=%d\n"), stat);
369 Dmsg2(100, "Write uncompressed %d bytes, total before write=%d\n", compress_len, total);
370 if ((uLong)bwrite(&bfd, jcr->compress_buf, compress_len) != compress_len) {
371 Dmsg0(0, "===Write error===\n");
372 Jmsg2(jcr, M_ERROR, 0, "Write error on %s: %s\n", ofile, berror(&bfd));
375 total += compress_len;
376 jcr->JobBytes += compress_len;
377 fileAddr += compress_len;
381 Jmsg(jcr, M_ERROR, 0, "GZIP data stream found, but GZIP not configured!\n");
385 /* If extracting, wierd stream (not 1 or 2), close output file anyway */
386 } else if (extract) {
387 Dmsg1(30, "Found wierd stream %d\n", stream);
388 if (!is_bopen(&bfd)) {
389 Jmsg0(jcr, M_ERROR, 0, _("Logic error output file should be open but is not.\n"));
391 set_attributes(jcr, fname, ofile, lname, type, stream,
392 &statp, attribsEx, &bfd);
394 } else if (!(stream == STREAM_MD5_SIGNATURE || stream == STREAM_SHA1_SIGNATURE)) {
395 Dmsg2(0, "None of above!!! stream=%d data=%s\n", stream,sd->msg);
399 /* If output file is still open, it was the last one in the
400 * archive since we just hit an end of file, so close the file.
402 if (is_bopen(&bfd)) {
403 set_attributes(jcr, fname, ofile, lname, type, stream,
404 &statp, attribsEx, &bfd);
406 set_jcr_job_status(jcr, JS_Terminated);
410 set_jcr_job_status(jcr, JS_ErrorTerminated);
412 if (jcr->compress_buf) {
413 free(jcr->compress_buf);
414 jcr->compress_buf = NULL;
416 free_pool_memory(fname);
417 free_pool_memory(ofile);
418 free_pool_memory(lname);
419 free_pool_memory(attribsEx);
420 Dmsg2(10, "End Do Restore. Files=%d Bytes=%" lld "\n", jcr->JobFiles,
424 extern char *getuser(uid_t uid);
425 extern char *getgroup(gid_t gid);
428 * Print an ls style message, also send INFO
430 static void print_ls_output(JCR *jcr, char *fname, char *lname, int type, struct stat *statp)
437 p = encode_mode(statp->st_mode, buf);
438 n = sprintf(p, " %2d ", (uint32_t)statp->st_nlink);
440 n = sprintf(p, "%-8.8s %-8.8s", getuser(statp->st_uid), getgroup(statp->st_gid));
442 n = sprintf(p, "%8.8s ", edit_uint64(statp->st_size, ec1));
444 p = encode_time(statp->st_ctime, p);
447 for (f=fname; *f && (p-buf) < (int)sizeof(buf)-10; ) {
450 if (type == FT_LNK) {
456 for (f=lname; *f && (p-buf) < (int)sizeof(buf)-10; ) {
463 Jmsg(jcr, M_RESTORED, 0, "%s", buf);