#include "system.h"
#include <signal.h>
#include <fnmatch.h>
#include <human.h>
#include <quotearg.h>
#include "common.h"
#include "rmt.h"
#define READ_ERROR_MAX 10
#define VOLUME_LABEL_APPEND " Volume [1-9]*"
static tarlong prev_written;
static tarlong bytes_written;
union block *record_start;
union block *record_end;
union block *current_block;
enum access_mode access_mode;
off_t records_read;
off_t records_written;
static off_t record_start_block;
FILE *stdlis;
static void backspace_output (void);
static bool new_volume (enum access_mode);
static pid_t child_pid;
static int read_error_count;
static int hit_eof;
static int checkpoint;
extern bool time_to_start_writing;
static int volno = 1;
static int global_volno = 1;
char *save_name;
off_t save_totsize;
off_t save_sizeleft;
bool write_archive_to_stdout;
static char *real_s_name;
static off_t real_s_totsize;
static off_t real_s_sizeleft;
void
clear_read_error_count (void)
{
read_error_count = 0;
}
void
print_total_written (void)
{
tarlong written = prev_written + bytes_written;
char bytes[sizeof (tarlong) * CHAR_BIT];
char abbr[LONGEST_HUMAN_READABLE + 1];
char rate[LONGEST_HUMAN_READABLE + 1];
double seconds;
int human_opts = human_autoscale | human_base_1024 | human_SI | human_B;
#if HAVE_CLOCK_GETTIME
struct timespec now;
if (clock_gettime (CLOCK_REALTIME, &now) == 0)
seconds = ((now.tv_sec - start_timespec.tv_sec)
+ (now.tv_nsec - start_timespec.tv_nsec) / 1e9);
else
#endif
seconds = time (0) - start_time;
sprintf (bytes, TARLONG_FORMAT, written);
fprintf (stderr, _("Total bytes written: %s (%s, %s/s)\n"), bytes,
human_readable (written, abbr, human_opts, 1, 1),
(0 < seconds && written / seconds < (uintmax_t) -1
? human_readable (written / seconds, rate, human_opts, 1, 1)
: "?"));
}
off_t
current_block_ordinal (void)
{
return record_start_block + (current_block - record_start);
}
void
reset_eof (void)
{
if (hit_eof)
{
hit_eof = 0;
current_block = record_start;
record_end = record_start + blocking_factor;
access_mode = ACCESS_WRITE;
}
}
union block *
find_next_block (void)
{
if (current_block == record_end)
{
if (hit_eof)
return 0;
flush_archive ();
if (current_block == record_end)
{
hit_eof = 1;
return 0;
}
}
return current_block;
}
void
set_next_block_after (union block *block)
{
while (block >= current_block)
current_block++;
if (current_block > record_end)
abort ();
}
size_t
available_space_after (union block *pointer)
{
return record_end->buffer - pointer->buffer;
}
void
xclose (int fd)
{
if (close (fd) != 0)
close_error (_("(pipe)"));
}
static bool
check_label_pattern (union block *label)
{
char *string;
bool result;
if (! memchr (label->header.name, '\0', sizeof label->header.name))
return false;
if (fnmatch (volume_label_option, label->header.name, 0) == 0)
return true;
if (!multi_volume_option)
return false;
string = xmalloc (strlen (volume_label_option)
+ sizeof VOLUME_LABEL_APPEND + 1);
strcpy (string, volume_label_option);
strcat (string, VOLUME_LABEL_APPEND);
result = fnmatch (string, label->header.name, 0) == 0;
free (string);
return result;
}
void
open_archive (enum access_mode wanted_access)
{
int backed_up_flag = 0;
if (index_file_name)
{
stdlis = fopen (index_file_name, "w");
if (! stdlis)
open_error (index_file_name);
}
else
stdlis = to_stdout_option ? stderr : stdout;
if (record_size == 0)
FATAL_ERROR ((0, 0, _("Invalid value for record_size")));
if (archive_names == 0)
FATAL_ERROR ((0, 0, _("No archive name given")));
tar_stat_destroy (¤t_stat_info);
save_name = 0;
real_s_name = 0;
if (multi_volume_option)
{
record_start = valloc (record_size + (2 * BLOCKSIZE));
if (record_start)
record_start += 2;
}
else
record_start = valloc (record_size);
if (!record_start)
FATAL_ERROR ((0, 0, _("Cannot allocate memory for blocking factor %d"),
blocking_factor));
current_block = record_start;
record_end = record_start + blocking_factor;
access_mode = wanted_access == ACCESS_UPDATE ? ACCESS_READ : wanted_access;
if (use_compress_program_option)
{
switch (wanted_access)
{
case ACCESS_READ:
child_pid = sys_child_open_for_uncompress ();
read_full_records_option = false;
break;
case ACCESS_WRITE:
child_pid = sys_child_open_for_compress ();
break;
case ACCESS_UPDATE:
abort ();
break;
}
if (wanted_access == ACCESS_WRITE
&& strcmp (archive_name_array[0], "-") == 0)
stdlis = stderr;
}
else if (strcmp (archive_name_array[0], "-") == 0)
{
read_full_records_option = true;
if (verify_option)
FATAL_ERROR ((0, 0, _("Cannot verify stdin/stdout archive")));
switch (wanted_access)
{
case ACCESS_READ:
archive = STDIN_FILENO;
break;
case ACCESS_WRITE:
archive = STDOUT_FILENO;
stdlis = stderr;
break;
case ACCESS_UPDATE:
archive = STDIN_FILENO;
stdlis = stderr;
write_archive_to_stdout = true;
break;
}
}
else if (verify_option)
archive = rmtopen (archive_name_array[0], O_RDWR | O_CREAT | O_BINARY,
MODE_RW, rsh_command_option);
else
switch (wanted_access)
{
case ACCESS_READ:
archive = rmtopen (archive_name_array[0], O_RDONLY | O_BINARY,
MODE_RW, rsh_command_option);
break;
case ACCESS_WRITE:
if (backup_option)
{
maybe_backup_file (archive_name_array[0], 1);
backed_up_flag = 1;
}
archive = rmtcreat (archive_name_array[0], MODE_RW,
rsh_command_option);
break;
case ACCESS_UPDATE:
archive = rmtopen (archive_name_array[0], O_RDWR | O_CREAT | O_BINARY,
MODE_RW, rsh_command_option);
break;
}
if (archive < 0
|| (! _isrmt (archive) && !sys_get_archive_stat ()))
{
int saved_errno = errno;
if (backed_up_flag)
undo_last_backup ();
errno = saved_errno;
open_fatal (archive_name_array[0]);
}
sys_detect_dev_null_output ();
sys_save_archive_dev_ino ();
SET_BINARY_MODE (archive);
switch (wanted_access)
{
case ACCESS_UPDATE:
records_written = 0;
case ACCESS_READ:
records_read = 0;
record_end = record_start;
find_next_block ();
if (volume_label_option)
{
union block *label = find_next_block ();
if (!label)
FATAL_ERROR ((0, 0, _("Archive not labeled to match %s"),
quote (volume_label_option)));
if (!check_label_pattern (label))
FATAL_ERROR ((0, 0, _("Volume %s does not match %s"),
quote_n (0, label->header.name),
quote_n (1, volume_label_option)));
}
break;
case ACCESS_WRITE:
records_written = 0;
if (volume_label_option)
{
memset (record_start, 0, BLOCKSIZE);
if (multi_volume_option)
sprintf (record_start->header.name, "%s Volume 1",
volume_label_option);
else
strcpy (record_start->header.name, volume_label_option);
assign_string (¤t_stat_info.file_name,
record_start->header.name);
current_stat_info.had_trailing_slash =
strip_trailing_slashes (current_stat_info.file_name);
record_start->header.typeflag = GNUTYPE_VOLHDR;
TIME_TO_CHARS (start_time, record_start->header.mtime);
finish_header (¤t_stat_info, record_start, -1);
}
break;
}
}
void
flush_write (void)
{
int copy_back;
ssize_t status;
if (checkpoint_option && !(++checkpoint % 10))
WARN ((0, 0, _("Write checkpoint %d"), checkpoint));
if (tape_length_option && tape_length_option <= bytes_written)
{
errno = ENOSPC;
status = 0;
}
else if (dev_null_output)
status = record_size;
else
status = sys_write_archive_buffer ();
if (status != record_size && !multi_volume_option)
archive_write_error (status);
if (status > 0)
{
records_written++;
bytes_written += status;
}
if (status == record_size)
{
if (multi_volume_option)
{
if (save_name)
{
assign_string (&real_s_name, safer_name_suffix (save_name, false));
real_s_totsize = save_totsize;
real_s_sizeleft = save_sizeleft;
}
else
{
assign_string (&real_s_name, 0);
real_s_totsize = 0;
real_s_sizeleft = 0;
}
}
return;
}
if (status < 0 && errno != ENOSPC && errno != EIO && errno != ENXIO)
archive_write_error (status);
if (!new_volume (ACCESS_WRITE))
return;
if (totals_option)
prev_written += bytes_written;
bytes_written = 0;
if (volume_label_option && real_s_name)
{
copy_back = 2;
record_start -= 2;
}
else if (volume_label_option || real_s_name)
{
copy_back = 1;
record_start--;
}
else
copy_back = 0;
if (volume_label_option)
{
memset (record_start, 0, BLOCKSIZE);
sprintf (record_start->header.name, "%s Volume %d",
volume_label_option, volno);
TIME_TO_CHARS (start_time, record_start->header.mtime);
record_start->header.typeflag = GNUTYPE_VOLHDR;
finish_header (¤t_stat_info, record_start, -1);
}
if (real_s_name)
{
int tmp;
if (volume_label_option)
record_start++;
memset (record_start, 0, BLOCKSIZE);
strcpy (record_start->header.name, real_s_name);
record_start->header.typeflag = GNUTYPE_MULTIVOL;
OFF_TO_CHARS (real_s_sizeleft, record_start->header.size);
OFF_TO_CHARS (real_s_totsize - real_s_sizeleft,
record_start->oldgnu_header.offset);
tmp = verbose_option;
verbose_option = 0;
finish_header (¤t_stat_info, record_start, -1);
verbose_option = tmp;
if (volume_label_option)
record_start--;
}
status = sys_write_archive_buffer ();
if (status != record_size)
archive_write_error (status);
bytes_written += status;
if (copy_back)
{
record_start += copy_back;
memcpy (current_block,
record_start + blocking_factor - copy_back,
copy_back * BLOCKSIZE);
current_block += copy_back;
if (real_s_sizeleft >= copy_back * BLOCKSIZE)
real_s_sizeleft -= copy_back * BLOCKSIZE;
else if ((real_s_sizeleft + BLOCKSIZE - 1) / BLOCKSIZE <= copy_back)
assign_string (&real_s_name, 0);
else
{
assign_string (&real_s_name, safer_name_suffix (save_name, false));
real_s_sizeleft = save_sizeleft;
real_s_totsize = save_totsize;
}
copy_back = 0;
}
}
void
archive_write_error (ssize_t status)
{
if (totals_option)
{
int e = errno;
print_total_written ();
errno = e;
}
write_fatal_details (*archive_name_cursor, status, record_size);
}
void
archive_read_error (void)
{
read_error (*archive_name_cursor);
if (record_start_block == 0)
FATAL_ERROR ((0, 0, _("At beginning of tape, quitting now")));
if (read_error_count++ > READ_ERROR_MAX)
FATAL_ERROR ((0, 0, _("Too many errors, quitting")));
return;
}
static void
short_read (size_t status)
{
size_t left;
char *more;
more = record_start->buffer + status;
left = record_size - status;
while (left % BLOCKSIZE != 0
|| (left && status && read_full_records_option))
{
if (status)
while ((status = rmtread (archive, more, left)) == SAFE_READ_ERROR)
archive_read_error ();
if (status == 0)
{
char buf[UINTMAX_STRSIZE_BOUND];
WARN((0, 0, _("Read %s bytes from %s"),
STRINGIFY_BIGINT (record_size - left, buf),
*archive_name_cursor));
break;
}
if (! read_full_records_option)
{
unsigned long rest = record_size - left;
FATAL_ERROR ((0, 0,
ngettext ("Unaligned block (%lu byte) in archive",
"Unaligned block (%lu bytes) in archive",
rest),
rest));
}
left -= status;
more += status;
}
if (!read_full_records_option && verbose_option > 1
&& record_start_block == 0 && status != 0)
{
unsigned long rsize = (record_size - left) / BLOCKSIZE;
WARN ((0, 0,
ngettext ("Record size = %lu block",
"Record size = %lu blocks",
rsize),
rsize));
}
record_end = record_start + (record_size - left) / BLOCKSIZE;
records_read++;
}
void
flush_read (void)
{
size_t status;
if (checkpoint_option && !(++checkpoint % 10))
WARN ((0, 0, _("Read checkpoint %d"), checkpoint));
read_error_count = 0;
if (write_archive_to_stdout && record_start_block != 0)
{
archive = STDOUT_FILENO;
status = sys_write_archive_buffer ();
archive = STDIN_FILENO;
if (status != record_size)
archive_write_error (status);
}
if (multi_volume_option)
{
if (save_name)
{
assign_string (&real_s_name, safer_name_suffix (save_name, false));
real_s_sizeleft = save_sizeleft;
real_s_totsize = save_totsize;
}
else
{
assign_string (&real_s_name, 0);
real_s_totsize = 0;
real_s_sizeleft = 0;
}
}
error_loop:
status = rmtread (archive, record_start->buffer, record_size);
if (status == record_size)
{
records_read++;
return;
}
if ((status == 0
|| (status == SAFE_READ_ERROR && errno == ENOSPC))
&& multi_volume_option)
{
union block *cursor;
try_volume:
switch (subcommand_option)
{
case APPEND_SUBCOMMAND:
case CAT_SUBCOMMAND:
case UPDATE_SUBCOMMAND:
if (!new_volume (ACCESS_UPDATE))
return;
break;
default:
if (!new_volume (ACCESS_READ))
return;
break;
}
while ((status = rmtread (archive, record_start->buffer, record_size))
== SAFE_READ_ERROR)
archive_read_error ();
if (status != record_size)
short_read (status);
cursor = record_start;
if (cursor->header.typeflag == GNUTYPE_VOLHDR)
{
if (volume_label_option)
{
if (!check_label_pattern (cursor))
{
WARN ((0, 0, _("Volume %s does not match %s"),
quote_n (0, cursor->header.name),
quote_n (1, volume_label_option)));
volno--;
global_volno--;
goto try_volume;
}
}
if (verbose_option)
fprintf (stdlis, _("Reading %s\n"), quote (cursor->header.name));
cursor++;
}
else if (volume_label_option)
WARN ((0, 0, _("WARNING: No volume header")));
if (real_s_name)
{
uintmax_t s1, s2;
if (cursor->header.typeflag != GNUTYPE_MULTIVOL
|| strcmp (cursor->header.name, real_s_name))
{
WARN ((0, 0, _("%s is not continued on this volume"),
quote (real_s_name)));
volno--;
global_volno--;
goto try_volume;
}
s1 = UINTMAX_FROM_HEADER (cursor->header.size);
s2 = UINTMAX_FROM_HEADER (cursor->oldgnu_header.offset);
if (real_s_totsize != s1 + s2 || s1 + s2 < s2)
{
char totsizebuf[UINTMAX_STRSIZE_BOUND];
char s1buf[UINTMAX_STRSIZE_BOUND];
char s2buf[UINTMAX_STRSIZE_BOUND];
WARN ((0, 0, _("%s is the wrong size (%s != %s + %s)"),
quote (cursor->header.name),
STRINGIFY_BIGINT (save_totsize, totsizebuf),
STRINGIFY_BIGINT (s1, s1buf),
STRINGIFY_BIGINT (s2, s2buf)));
volno--;
global_volno--;
goto try_volume;
}
if (real_s_totsize - real_s_sizeleft
!= OFF_FROM_HEADER (cursor->oldgnu_header.offset))
{
WARN ((0, 0, _("This volume is out of sequence")));
volno--;
global_volno--;
goto try_volume;
}
cursor++;
}
current_block = cursor;
records_read++;
return;
}
else if (status == SAFE_READ_ERROR)
{
archive_read_error ();
goto error_loop;
}
short_read (status);
}
void
flush_archive (void)
{
record_start_block += record_end - record_start;
current_block = record_start;
record_end = record_start + blocking_factor;
if (access_mode == ACCESS_READ && time_to_start_writing)
{
access_mode = ACCESS_WRITE;
time_to_start_writing = false;
backspace_output ();
}
switch (access_mode)
{
case ACCESS_READ:
flush_read ();
break;
case ACCESS_WRITE:
flush_write ();
break;
case ACCESS_UPDATE:
abort ();
}
}
static void
backspace_output (void)
{
#ifdef MTIOCTOP
{
struct mtop operation;
operation.mt_op = MTBSR;
operation.mt_count = 1;
if (rmtioctl (archive, MTIOCTOP, (char *) &operation) >= 0)
return;
if (errno == EIO && rmtioctl (archive, MTIOCTOP, (char *) &operation) >= 0)
return;
}
#endif
{
off_t position = rmtlseek (archive, (off_t) 0, SEEK_CUR);
position -= record_size;
if (position < 0)
position = 0;
if (rmtlseek (archive, position, SEEK_SET) != position)
{
WARN ((0, 0,
_("Cannot backspace archive file; it may be unreadable without -i")));
if (record_start->buffer != output_start)
memset (record_start->buffer, 0,
output_start - record_start->buffer);
}
}
}
void
close_archive (void)
{
if (time_to_start_writing || access_mode == ACCESS_WRITE)
flush_archive ();
sys_drain_input_pipe ();
if (verify_option)
verify_volume ();
if (rmtclose (archive) != 0)
close_warn (*archive_name_cursor);
sys_wait_for_child (child_pid);
tar_stat_destroy (¤t_stat_info);
if (save_name)
free (save_name);
if (real_s_name)
free (real_s_name);
free (multi_volume_option ? record_start - 2 : record_start);
}
void
init_volume_number (void)
{
FILE *file = fopen (volno_file_option, "r");
if (file)
{
if (fscanf (file, "%d", &global_volno) != 1
|| global_volno < 0)
FATAL_ERROR ((0, 0, _("%s: contains invalid volume number"),
quotearg_colon (volno_file_option)));
if (ferror (file))
read_error (volno_file_option);
if (fclose (file) != 0)
close_error (volno_file_option);
}
else if (errno != ENOENT)
open_error (volno_file_option);
}
void
closeout_volume_number (void)
{
FILE *file = fopen (volno_file_option, "w");
if (file)
{
fprintf (file, "%d\n", global_volno);
if (ferror (file))
write_error (volno_file_option);
if (fclose (file) != 0)
close_error (volno_file_option);
}
else
open_error (volno_file_option);
}
static bool
new_volume (enum access_mode mode)
{
static FILE *read_file;
static int looped;
if (!read_file && !info_script_option)
read_file = archive == STDIN_FILENO ? fopen (TTY_NAME, "r") : stdin;
if (now_verifying)
return false;
if (verify_option)
verify_volume ();
if (rmtclose (archive) != 0)
close_warn (*archive_name_cursor);
global_volno++;
if (global_volno < 0)
FATAL_ERROR ((0, 0, _("Volume number overflow")));
volno++;
archive_name_cursor++;
if (archive_name_cursor == archive_name_array + archive_names)
{
archive_name_cursor = archive_name_array;
looped = 1;
}
tryagain:
if (looped)
{
if (info_script_option)
{
if (volno_file_option)
closeout_volume_number ();
if (system (info_script_option) != 0)
FATAL_ERROR ((0, 0, _("`%s' command failed"), info_script_option));
}
else
while (1)
{
char input_buffer[80];
fputc ('\007', stderr);
fprintf (stderr,
_("Prepare volume #%d for %s and hit return: "),
global_volno, quote (*archive_name_cursor));
fflush (stderr);
if (fgets (input_buffer, sizeof input_buffer, read_file) == 0)
{
WARN ((0, 0, _("EOF where user reply was expected")));
if (subcommand_option != EXTRACT_SUBCOMMAND
&& subcommand_option != LIST_SUBCOMMAND
&& subcommand_option != DIFF_SUBCOMMAND)
WARN ((0, 0, _("WARNING: Archive is incomplete")));
fatal_exit ();
}
if (input_buffer[0] == '\n'
|| input_buffer[0] == 'y'
|| input_buffer[0] == 'Y')
break;
switch (input_buffer[0])
{
case '?':
{
fprintf (stderr, _("\
n [name] Give a new file name for the next (and subsequent) volume(s)\n\
q Abort tar\n\
! Spawn a subshell\n\
? Print this list\n"));
}
break;
case 'q':
WARN ((0, 0, _("No new volume; exiting.\n")));
if (subcommand_option != EXTRACT_SUBCOMMAND
&& subcommand_option != LIST_SUBCOMMAND
&& subcommand_option != DIFF_SUBCOMMAND)
WARN ((0, 0, _("WARNING: Archive is incomplete")));
fatal_exit ();
case 'n':
{
char *name = &input_buffer[1];
char *cursor;
for (name = input_buffer + 1;
*name == ' ' || *name == '\t';
name++)
;
for (cursor = name; *cursor && *cursor != '\n'; cursor++)
;
*cursor = '\0';
*archive_name_cursor = xstrdup (name);
}
break;
case '!':
sys_spawn_shell ();
break;
}
}
}
if (strcmp (archive_name_cursor[0], "-") == 0)
{
read_full_records_option = true;
archive = STDIN_FILENO;
}
else if (verify_option)
archive = rmtopen (*archive_name_cursor, O_RDWR | O_CREAT, MODE_RW,
rsh_command_option);
else
switch (mode)
{
case ACCESS_READ:
archive = rmtopen (*archive_name_cursor, O_RDONLY, MODE_RW,
rsh_command_option);
break;
case ACCESS_WRITE:
if (backup_option)
maybe_backup_file (*archive_name_cursor, 1);
archive = rmtcreat (*archive_name_cursor, MODE_RW,
rsh_command_option);
break;
case ACCESS_UPDATE:
archive = rmtopen (*archive_name_cursor, O_RDWR | O_CREAT, MODE_RW,
rsh_command_option);
break;
}
if (archive < 0)
{
open_warn (*archive_name_cursor);
if (!verify_option && mode == ACCESS_WRITE && backup_option)
undo_last_backup ();
goto tryagain;
}
SET_BINARY_MODE (archive);
return true;
}