Updated a questioning comment.

[rsync/rsync.git] / batch.c

/* -*- c-file-style: "linux" -*-
   
   Weiss 1/1999
   Batch utilities for rsync.

*/

#include "rsync.h"
#include <time.h>

extern char *batch_prefix;
extern int csum_length;
extern int protocol_version;
extern struct stats stats;

struct file_list *batch_flist;

static char rsync_flist_file[] = ".rsync_flist";
static char rsync_csums_file[] = ".rsync_csums";
static char rsync_delta_file[] = ".rsync_delta";
static char rsync_argvs_file[] = ".rsync_argvs";

static int f_csums = -1;
static int f_delta = -1;

void write_batch_flist_info(int flist_count, struct file_struct **files)
{
	char filename[MAXPATHLEN];
	int i, f, save_pv;
	int64 save_written;

	snprintf(filename, sizeof filename, "%s%s",
		 batch_prefix, rsync_flist_file);

	f = do_open(filename, O_WRONLY|O_CREAT|O_TRUNC, S_IREAD|S_IWRITE);
	if (f < 0) {
		rprintf(FERROR, "Batch file %s open error: %s\n",
			filename, strerror(errno));
		exit_cleanup(1);
	}

	save_written = stats.total_written;
	save_pv = protocol_version;
	protocol_version = PROTOCOL_VERSION;
	write_int(f, protocol_version);
	write_int(f, flist_count);

	for (i = 0; i < flist_count; i++)
		send_file_entry(files[i], f, files[i]->flags & LIVE_FLAGS);
	send_file_entry(NULL, f, 0);

	protocol_version = save_pv;
	stats.total_written = save_written;

	close(f);
}


void write_batch_argvs_file(int argc, char *argv[])
{
	int f;
	int i;
	char buff[256]; /* XXX */
	char buff2[MAXPATHLEN + 6];
	char filename[MAXPATHLEN];

	/* Set up file extension */
	strlcpy(filename, batch_prefix, sizeof(filename));
	strlcat(filename, rsync_argvs_file, sizeof(filename));

	/* Open batch argvs file for writing;
	 * create it if it doesn't exist. */
	f = do_open(filename, O_WRONLY | O_CREAT | O_TRUNC,
		    S_IREAD | S_IWRITE | S_IEXEC);
	if (f < 0) {
		rprintf(FERROR, "Batch file %s open error: %s\n",
			filename, strerror(errno));
		exit_cleanup(1);
	}
	buff[0] = '\0';

	/* Write argvs info to batch file */

	for (i = 0; i < argc; ++i) {
		if (i == argc - 2) /* Skip source directory on cmdline */
		    continue;
		/*
		 * FIXME:
		 * I think directly manipulating argv[] is probably bogus
		 */
		if (!strncmp(argv[i], "--write-batch",
			strlen("--write-batch"))) {
			/* Safer to change it here than script */
			/*
			 * Change to --read-batch=prefix
			 * to get ready for remote
			 */
			strlcat(buff, "--read-batch=", sizeof(buff));
			strlcat(buff, batch_prefix, sizeof(buff));
		} else
		if (i == argc - 1) {
		    snprintf(buff2, sizeof(buff2), "${1:-%s}", argv[i]);
		    strlcat(buff, buff2, sizeof(buff));
		}
		else {
			strlcat(buff, argv[i], sizeof(buff));
		}

		if (i < (argc - 1)) {
			strlcat(buff, " ", sizeof(buff));
		}
	}
	strlcat(buff, "\n", sizeof(buff));
	if (!write(f, buff, strlen(buff))) {
		rprintf(FERROR, "Batch file %s write error: %s\n",
			filename, strerror(errno));
		close(f);
		exit_cleanup(1);
	}
	close(f);
}

struct file_list *create_flist_from_batch(void)
{
	char filename[MAXPATHLEN];
	unsigned short flags;
	int i, f, save_pv;
	int64 save_read;

	snprintf(filename, sizeof filename, "%s%s",
		 batch_prefix, rsync_flist_file);

	f = do_open(filename, O_RDONLY, 0);
	if (f < 0) {
		rprintf(FERROR, "Batch file %s open error: %s\n",
			filename, strerror(errno));
		exit_cleanup(1);
	}

	batch_flist = new(struct file_list);
	if (!batch_flist)
		out_of_memory("create_flist_from_batch");

	save_read = stats.total_read;
	save_pv = protocol_version;
	protocol_version = read_int(f);

	batch_flist->count = batch_flist->malloced = read_int(f);
	batch_flist->files = new_array(struct file_struct *,
				       batch_flist->malloced);
	if (!batch_flist->files)
		out_of_memory("create_flist_from_batch");

	for (i = 0; (flags = read_byte(f)) != 0; i++) {
		if (protocol_version >= 28 && (flags & EXTENDED_FLAGS))
			flags |= read_byte(f) << 8;
		receive_file_entry(&batch_flist->files[i], flags, f);
	}
	receive_file_entry(NULL, 0, 0); /* Signal that we're done. */

	protocol_version = save_pv;
	stats.total_read = save_read;

	return batch_flist;
}

void write_batch_csums_file(void *buff, int bytes_to_write)
{
	char filename[MAXPATHLEN];

	if (f_csums < 0) {
		strlcpy(filename, batch_prefix, sizeof(filename));
		strlcat(filename, rsync_csums_file, sizeof(filename));

		f_csums = do_open(filename, O_WRONLY | O_CREAT | O_TRUNC,
				  S_IREAD | S_IWRITE);
		if (f_csums < 0) {
			rprintf(FERROR, "Batch file %s open error: %s\n",
				filename, strerror(errno));
			close(f_csums);
			exit_cleanup(1);
		}
	}

	if (write(f_csums, buff, bytes_to_write) < 0) {
		rprintf(FERROR, "Batch file %s write error: %s\n",
			filename, strerror(errno));
		close(f_csums);
		exit_cleanup(1);
	}
}

void close_batch_csums_file(void)
{
	close(f_csums);
	f_csums = -1;
}


/**
 * Write csum info to batch file 
 *
 * @todo This will break if s->count is ever larger than maxint.  The
 * batch code should probably be changed to consistently use the
 * variable-length integer routines, which is probably a compatible
 * change.
 **/
void write_batch_csum_info(int *flist_entry, struct sum_struct *s)
{
	size_t i;
	int int_count;

	write_batch_csums_file(flist_entry, sizeof(int));
	int_count = s ? (int) s->count : 0;
	write_batch_csums_file(&int_count, sizeof int_count);
	
	if (s) {
		for (i = 0; i < s->count; i++) {
			write_batch_csums_file(&s->sums[i].sum1, sizeof(uint32));
			write_batch_csums_file(s->sums[i].sum2, csum_length);
		}
	}
}

int read_batch_csums_file(char *buff, int len)
{
	int bytes_read;
	char filename[MAXPATHLEN];

	if (f_csums < 0) {
		strlcpy(filename, batch_prefix, sizeof(filename));
		strlcat(filename, rsync_csums_file, sizeof(filename));

		f_csums = do_open(filename, O_RDONLY, 0);
		if (f_csums < 0) {
			rprintf(FERROR, "Batch file %s open error: %s\n",
				filename, strerror(errno));
			close(f_csums);
			exit_cleanup(1);
		}
	}

	bytes_read = read(f_csums, buff, len);
	if (bytes_read < 0) {
		rprintf(FERROR, "Batch file %s read error: %s\n",
			filename, strerror(errno));
		close(f_csums);
		exit_cleanup(1);
	}

	return bytes_read;
}

void read_batch_csum_info(int flist_entry, struct sum_struct *s,
			  int *checksums_match)
{
	int i;
	int file_flist_entry;
	int file_chunk_ct;
	uint32 file_sum1;
	char file_sum2[SUM_LENGTH];

	read_batch_csums_file((char *) &file_flist_entry, sizeof(int));
	if (file_flist_entry != flist_entry) {
		rprintf(FINFO, "file_flist_entry (%d) != flist_entry (%d)\n",
			file_flist_entry, flist_entry);
		close(f_csums);
		exit_cleanup(1);

	} else {
		read_batch_csums_file((char *) &file_chunk_ct,
				      sizeof(int));
		*checksums_match = 1;
		for (i = 0; i < file_chunk_ct; i++) {

			read_batch_csums_file((char *) &file_sum1,
					      sizeof(uint32));
			read_batch_csums_file(file_sum2, csum_length);

			if ((s->sums[i].sum1 != file_sum1) ||
			    (memcmp(s->sums[i].sum2, file_sum2, csum_length)
				!= 0)) {
				*checksums_match = 0;
			}
		}		/*  end for  */
	}
}

void write_batch_delta_file(char *buff, int bytes_to_write)
{
	char filename[MAXPATHLEN];

	if (f_delta < 0) {
		strlcpy(filename, batch_prefix, sizeof(filename));
		strlcat(filename, rsync_delta_file, sizeof(filename));

		f_delta = do_open(filename, O_WRONLY | O_CREAT | O_TRUNC,
				  S_IREAD | S_IWRITE);
		if (f_delta < 0) {
			rprintf(FERROR, "Batch file %s open error: %s\n",
				filename, strerror(errno));
			exit_cleanup(1);
		}
	}

	if (write(f_delta, buff, bytes_to_write) < 0) {
		rprintf(FERROR, "Batch file %s write error: %s\n",
			filename, strerror(errno));
		close(f_delta);
		exit_cleanup(1);
	}
}

void close_batch_delta_file(void)
{
	close(f_delta);
	f_delta = -1;
}

int read_batch_delta_file(char *buff, int len)
{
	int bytes_read;
	char filename[MAXPATHLEN];

	if (f_delta < 0) {
		strlcpy(filename, batch_prefix, sizeof(filename));
		strlcat(filename, rsync_delta_file, sizeof(filename));

		f_delta = do_open(filename, O_RDONLY, 0);
		if (f_delta < 0) {
			rprintf(FERROR, "Batch file %s open error: %s\n",
				filename, strerror(errno));
			close(f_delta);
			exit_cleanup(1);
		}
	}

	bytes_read = read(f_delta, buff, len);
	if (bytes_read < 0) {
		rprintf(FERROR, "Batch file %s read error: %s\n",
			filename, strerror(errno));
		close(f_delta);
		exit_cleanup(1);
	}

	return bytes_read;
}

void show_flist(int index, struct file_struct **fptr)
{
	/*  for debugging    show_flist(flist->count, flist->files * */

	int i;
	for (i = 0; i < index; i++) {
		rprintf(FINFO, "flist->flags=%#x\n", fptr[i]->flags);
		rprintf(FINFO, "flist->modtime=%#lx\n",
			(long unsigned) fptr[i]->modtime);
		rprintf(FINFO, "flist->length=%.0f\n",
			(double) fptr[i]->length);
		rprintf(FINFO, "flist->mode=%#o\n", (int) fptr[i]->mode);
		rprintf(FINFO, "flist->basename=%s\n", fptr[i]->basename);
		if (fptr[i]->dirname)
			rprintf(FINFO, "flist->dirname=%s\n",
				fptr[i]->dirname);
		if (fptr[i]->basedir)
			rprintf(FINFO, "flist->basedir=%s\n",
				fptr[i]->basedir);
	}
}

void show_argvs(int argc, char *argv[])
{
	/*  for debugging  * */

	int i;
	rprintf(FINFO, "BATCH.C:show_argvs,argc=%d\n", argc);
	for (i = 0; i < argc; i++) {
		/*    if (argv[i])   */
		rprintf(FINFO, "i=%d,argv[i]=%s\n", i, argv[i]);

	}
}