lib/zip_source_file_stdio_named.c - third_party/libzip - Git at Google

 /*
   zip_source_file_stdio_named.c -- source for stdio file opened by name
   Copyright (C) 1999-2021 Dieter Baron and Thomas Klausner

   This file is part of libzip, a library to manipulate ZIP archives.
   The authors can be contacted at <libzip@nih.at>

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:
   1. Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
   2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in
      the documentation and/or other materials provided with the
      distribution.
   3. The names of the authors may not be used to endorse or promote
      products derived from this software without specific prior
      written permission.

   THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
   OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
   DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
   IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
   OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
   IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

 #include "zipint.h"

 #include "zip_source_file.h"
 #include "zip_source_file_stdio.h"

 #include <fcntl.h>
 #include <stdlib.h>
 #include <sys/stat.h>
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #endif

 #ifdef HAVE_CLONEFILE
 #include <sys/attr.h>
 #include <sys/clonefile.h>
 #define CAN_CLONE
 #endif
 #ifdef HAVE_FICLONERANGE
 #include <linux/fs.h>
 #include <sys/ioctl.h>
 #define CAN_CLONE
 #endif

 static int create_temp_file(zip_source_file_context_t *ctx, bool create_file);

 static zip_int64_t _zip_stdio_op_commit_write(zip_source_file_context_t *ctx);
 static zip_int64_t _zip_stdio_op_create_temp_output(zip_source_file_context_t *ctx);
 #ifdef CAN_CLONE
 static zip_int64_t _zip_stdio_op_create_temp_output_cloning(zip_source_file_context_t *ctx, zip_uint64_t offset);
 #endif
 static bool _zip_stdio_op_open(zip_source_file_context_t *ctx);
 static zip_int64_t _zip_stdio_op_remove(zip_source_file_context_t *ctx);
 static void _zip_stdio_op_rollback_write(zip_source_file_context_t *ctx);
 static char *_zip_stdio_op_strdup(zip_source_file_context_t *ctx, const char *string);
 static zip_int64_t _zip_stdio_op_write(zip_source_file_context_t *ctx, const void *data, zip_uint64_t len);

 /* clang-format off */
 static zip_source_file_operations_t ops_stdio_named = {
     _zip_stdio_op_close,
     _zip_stdio_op_commit_write,
     _zip_stdio_op_create_temp_output,
 #ifdef CAN_CLONE
     _zip_stdio_op_create_temp_output_cloning,
 #else
     NULL,
 #endif
     _zip_stdio_op_open,
     _zip_stdio_op_read,
     _zip_stdio_op_remove,
     _zip_stdio_op_rollback_write,
     _zip_stdio_op_seek,
     _zip_stdio_op_stat,
     _zip_stdio_op_strdup,
     _zip_stdio_op_tell,
     _zip_stdio_op_write
 };
 /* clang-format on */

 ZIP_EXTERN zip_source_t *
 zip_source_file(zip_t *za, const char *fname, zip_uint64_t start, zip_int64_t len) {
     if (za == NULL)
         return NULL;

     return zip_source_file_create(fname, start, len, &za->error);
 }


 ZIP_EXTERN zip_source_t *
 zip_source_file_create(const char *fname, zip_uint64_t start, zip_int64_t length, zip_error_t *error) {
     if (fname == NULL || length < -1) {
         zip_error_set(error, ZIP_ER_INVAL, 0);
         return NULL;
     }

     return zip_source_file_common_new(fname, NULL, start, length, NULL, &ops_stdio_named, NULL, error);
 }


 static zip_int64_t
 _zip_stdio_op_commit_write(zip_source_file_context_t *ctx) {
     if (fclose(ctx->fout) < 0) {
         zip_error_set(&ctx->error, ZIP_ER_WRITE, errno);
         return -1;
     }
     if (rename(ctx->tmpname, ctx->fname) < 0) {
         zip_error_set(&ctx->error, ZIP_ER_RENAME, errno);
         return -1;
     }

     return 0;
 }


 static zip_int64_t
 _zip_stdio_op_create_temp_output(zip_source_file_context_t *ctx) {
     int fd = create_temp_file(ctx, true);

     if (fd < 0) {
         return -1;
     }

     if ((ctx->fout = fdopen(fd, "r+b")) == NULL) {
         zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
         close(fd);
         (void)remove(ctx->tmpname);
         free(ctx->tmpname);
         ctx->tmpname = NULL;
         return -1;
     }

     return 0;
 }

 #ifdef CAN_CLONE
 static zip_int64_t
 _zip_stdio_op_create_temp_output_cloning(zip_source_file_context_t *ctx, zip_uint64_t offset) {
     FILE *tfp;

     if (offset > ZIP_OFF_MAX) {
         zip_error_set(&ctx->error, ZIP_ER_SEEK, E2BIG);
         return -1;
     }

 #ifdef HAVE_CLONEFILE
     /* clonefile insists on creating the file, so just create a name */
     if (create_temp_file(ctx, false) < 0) {
         return -1;
     }

     if (clonefile(ctx->fname, ctx->tmpname, 0) < 0) {
         zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
         free(ctx->tmpname);
         ctx->tmpname = NULL;
         return -1;
     }
     if ((tfp = _zip_fopen_close_on_exec(ctx->tmpname, true)) == NULL) {
         zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
         (void)remove(ctx->tmpname);
         free(ctx->tmpname);
         ctx->tmpname = NULL;
         return -1;
     }
 #else
     {
         int fd;
         struct file_clone_range range;
         struct stat st;

         if (fstat(fileno(ctx->f), &st) < 0) {
             zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
             return -1;
         }

         if ((fd = create_temp_file(ctx, true)) < 0) {
             return -1;
         }

         range.src_fd = fileno(ctx->f);
         range.src_offset = 0;
         range.src_length = ((offset + st.st_blksize - 1) / st.st_blksize) * st.st_blksize;
         if (range.src_length > st.st_size) {
             range.src_length = 0;
         }
         range.dest_offset = 0;
         if (ioctl(fd, FICLONERANGE, &range) < 0) {
             zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
             (void)close(fd);
             (void)remove(ctx->tmpname);
             free(ctx->tmpname);
             ctx->tmpname = NULL;
             return -1;
         }

         if ((tfp = fdopen(fd, "r+b")) == NULL) {
             zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
             (void)close(fd);
             (void)remove(ctx->tmpname);
             free(ctx->tmpname);
             ctx->tmpname = NULL;
             return -1;
         }
     }
 #endif

     if (ftruncate(fileno(tfp), (off_t)offset) < 0) {
         (void)fclose(tfp);
         (void)remove(ctx->tmpname);
         free(ctx->tmpname);
         ctx->tmpname = NULL;
         return -1;
     }
     if (fseeko(tfp, (off_t)offset, SEEK_SET) < 0) {
         zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
         (void)fclose(tfp);
         (void)remove(ctx->tmpname);
         free(ctx->tmpname);
         ctx->tmpname = NULL;
         return -1;
     }

     ctx->fout = tfp;

     return 0;
 }
 #endif

 static bool
 _zip_stdio_op_open(zip_source_file_context_t *ctx) {
     if ((ctx->f = _zip_fopen_close_on_exec(ctx->fname, false)) == NULL) {
         zip_error_set(&ctx->error, ZIP_ER_OPEN, errno);
         return false;
     }
     return true;
 }


 static zip_int64_t
 _zip_stdio_op_remove(zip_source_file_context_t *ctx) {
     if (remove(ctx->fname) < 0) {
         zip_error_set(&ctx->error, ZIP_ER_REMOVE, errno);
         return -1;
     }
     return 0;
 }


 static void
 _zip_stdio_op_rollback_write(zip_source_file_context_t *ctx) {
     if (ctx->fout) {
         fclose(ctx->fout);
     }
     (void)remove(ctx->tmpname);
 }

 static char *
 _zip_stdio_op_strdup(zip_source_file_context_t *ctx, const char *string) {
     return strdup(string);
 }


 static zip_int64_t
 _zip_stdio_op_write(zip_source_file_context_t *ctx, const void *data, zip_uint64_t len) {
     size_t ret;

     clearerr((FILE *)ctx->fout);
     ret = fwrite(data, 1, len, (FILE *)ctx->fout);
     if (ret != len || ferror((FILE *)ctx->fout)) {
         zip_error_set(&ctx->error, ZIP_ER_WRITE, errno);
         return -1;
     }

     return (zip_int64_t)ret;
 }


 static int create_temp_file(zip_source_file_context_t *ctx, bool create_file) {
     char *temp;
     int mode;
     struct stat st;
     int fd;
     char *start, *end;

     if (stat(ctx->fname, &st) == 0) {
         mode = st.st_mode;
     }
     else {
         mode = -1;
     }

     if ((temp = (char *)malloc(strlen(ctx->fname) + 13)) == NULL) {
         zip_error_set(&ctx->error, ZIP_ER_MEMORY, 0);
         return -1;
     }
     sprintf(temp, "%s.XXXXXX.part", ctx->fname);
     end = temp + strlen(temp) - 5;
     start = end - 6;

     for (;;) {
         zip_uint32_t value = zip_random_uint32();
         char *xs = start;

         while (xs < end) {
             char digit = value % 36;
             if (digit < 10) {
                 *(xs++) = digit + '0';
             }
             else {
                 *(xs++) = digit - 10 + 'a';
             }
             value /= 36;
         }

         if (create_file) {
             if ((fd = open(temp, O_CREAT | O_EXCL | O_RDWR | O_CLOEXEC, mode == -1 ? 0666 : (mode_t)mode)) >= 0) {
                 if (mode != -1) {
                     /* open() honors umask(), which we don't want in this case */
 #ifdef HAVE_FCHMOD
                     (void)fchmod(fd, (mode_t)mode);
 #else
                     (void)chmod(temp, (mode_t)mode);
 #endif
                 }
                 break;
             }
             if (errno != EEXIST) {
                 zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
                 free(temp);
                 return -1;
             }
         }
         else {
             if (stat(temp, &st) < 0) {
                 if (errno == ENOENT) {
                     break;
                 }
                 else {
                     zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
                     free(temp);
                     return -1;
                 }
             }
         }
     }

     ctx->tmpname = temp;

     return create_file ? fd : 0;
 }
	/*
	zip_source_file_stdio_named.c -- source for stdio file opened by name
	Copyright (C) 1999-2021 Dieter Baron and Thomas Klausner

	This file is part of libzip, a library to manipulate ZIP archives.
	The authors can be contacted at <libzip@nih.at>

	Redistribution and use in source and binary forms, with or without
	modification, are permitted provided that the following conditions
	are met:
	1. Redistributions of source code must retain the above copyright
	notice, this list of conditions and the following disclaimer.
	2. Redistributions in binary form must reproduce the above copyright
	notice, this list of conditions and the following disclaimer in
	the documentation and/or other materials provided with the
	distribution.
	3. The names of the authors may not be used to endorse or promote
	products derived from this software without specific prior
	written permission.

	THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
	OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
	WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
	DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
	GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
	IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
	OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
	IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	*/

	#include "zipint.h"

	#include "zip_source_file.h"
	#include "zip_source_file_stdio.h"

	#include <fcntl.h>
	#include <stdlib.h>
	#include <sys/stat.h>
	#ifdef HAVE_UNISTD_H
	#include <unistd.h>
	#endif

	#ifdef HAVE_CLONEFILE
	#include <sys/attr.h>
	#include <sys/clonefile.h>
	#define CAN_CLONE
	#endif
	#ifdef HAVE_FICLONERANGE
	#include <linux/fs.h>
	#include <sys/ioctl.h>
	#define CAN_CLONE
	#endif

	static int create_temp_file(zip_source_file_context_t *ctx, bool create_file);

	static zip_int64_t _zip_stdio_op_commit_write(zip_source_file_context_t *ctx);
	static zip_int64_t _zip_stdio_op_create_temp_output(zip_source_file_context_t *ctx);
	#ifdef CAN_CLONE
	static zip_int64_t _zip_stdio_op_create_temp_output_cloning(zip_source_file_context_t *ctx, zip_uint64_t offset);
	#endif
	static bool _zip_stdio_op_open(zip_source_file_context_t *ctx);
	static zip_int64_t _zip_stdio_op_remove(zip_source_file_context_t *ctx);
	static void _zip_stdio_op_rollback_write(zip_source_file_context_t *ctx);
	static char _zip_stdio_op_strdup(zip_source_file_context_t ctx, const char *string);
	static zip_int64_t _zip_stdio_op_write(zip_source_file_context_t ctx, const void data, zip_uint64_t len);

	/* clang-format off */
	static zip_source_file_operations_t ops_stdio_named = {
	_zip_stdio_op_close,
	_zip_stdio_op_commit_write,
	_zip_stdio_op_create_temp_output,
	#ifdef CAN_CLONE
	_zip_stdio_op_create_temp_output_cloning,
	#else
	NULL,
	#endif
	_zip_stdio_op_open,
	_zip_stdio_op_read,
	_zip_stdio_op_remove,
	_zip_stdio_op_rollback_write,
	_zip_stdio_op_seek,
	_zip_stdio_op_stat,
	_zip_stdio_op_strdup,
	_zip_stdio_op_tell,
	_zip_stdio_op_write
	};
	/* clang-format on */

	ZIP_EXTERN zip_source_t *
	zip_source_file(zip_t za, const char fname, zip_uint64_t start, zip_int64_t len) {
	if (za == NULL)
	return NULL;

	return zip_source_file_create(fname, start, len, &za->error);
	}


	ZIP_EXTERN zip_source_t *
	zip_source_file_create(const char fname, zip_uint64_t start, zip_int64_t length, zip_error_t error) {
	if (fname == NULL \|\| length < -1) {
	zip_error_set(error, ZIP_ER_INVAL, 0);
	return NULL;
	}

	return zip_source_file_common_new(fname, NULL, start, length, NULL, &ops_stdio_named, NULL, error);
	}


	static zip_int64_t
	_zip_stdio_op_commit_write(zip_source_file_context_t *ctx) {
	if (fclose(ctx->fout) < 0) {
	zip_error_set(&ctx->error, ZIP_ER_WRITE, errno);
	return -1;
	}
	if (rename(ctx->tmpname, ctx->fname) < 0) {
	zip_error_set(&ctx->error, ZIP_ER_RENAME, errno);
	return -1;
	}

	return 0;
	}


	static zip_int64_t
	_zip_stdio_op_create_temp_output(zip_source_file_context_t *ctx) {
	int fd = create_temp_file(ctx, true);

	if (fd < 0) {
	return -1;
	}

	if ((ctx->fout = fdopen(fd, "r+b")) == NULL) {
	zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
	close(fd);
	(void)remove(ctx->tmpname);
	free(ctx->tmpname);
	ctx->tmpname = NULL;
	return -1;
	}

	return 0;
	}

	#ifdef CAN_CLONE
	static zip_int64_t
	_zip_stdio_op_create_temp_output_cloning(zip_source_file_context_t *ctx, zip_uint64_t offset) {
	FILE *tfp;

	if (offset > ZIP_OFF_MAX) {
	zip_error_set(&ctx->error, ZIP_ER_SEEK, E2BIG);
	return -1;
	}

	#ifdef HAVE_CLONEFILE
	/* clonefile insists on creating the file, so just create a name */
	if (create_temp_file(ctx, false) < 0) {
	return -1;
	}

	if (clonefile(ctx->fname, ctx->tmpname, 0) < 0) {
	zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
	free(ctx->tmpname);
	ctx->tmpname = NULL;
	return -1;
	}
	if ((tfp = _zip_fopen_close_on_exec(ctx->tmpname, true)) == NULL) {
	zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
	(void)remove(ctx->tmpname);
	free(ctx->tmpname);
	ctx->tmpname = NULL;
	return -1;
	}
	#else
	{
	int fd;
	struct file_clone_range range;
	struct stat st;

	if (fstat(fileno(ctx->f), &st) < 0) {
	zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
	return -1;
	}

	if ((fd = create_temp_file(ctx, true)) < 0) {
	return -1;
	}

	range.src_fd = fileno(ctx->f);
	range.src_offset = 0;
	range.src_length = ((offset + st.st_blksize - 1) / st.st_blksize) * st.st_blksize;
	if (range.src_length > st.st_size) {
	range.src_length = 0;
	}
	range.dest_offset = 0;
	if (ioctl(fd, FICLONERANGE, &range) < 0) {
	zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
	(void)close(fd);
	(void)remove(ctx->tmpname);
	free(ctx->tmpname);
	ctx->tmpname = NULL;
	return -1;
	}

	if ((tfp = fdopen(fd, "r+b")) == NULL) {
	zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
	(void)close(fd);
	(void)remove(ctx->tmpname);
	free(ctx->tmpname);
	ctx->tmpname = NULL;
	return -1;
	}
	}
	#endif

	if (ftruncate(fileno(tfp), (off_t)offset) < 0) {
	(void)fclose(tfp);
	(void)remove(ctx->tmpname);
	free(ctx->tmpname);
	ctx->tmpname = NULL;
	return -1;
	}
	if (fseeko(tfp, (off_t)offset, SEEK_SET) < 0) {
	zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
	(void)fclose(tfp);
	(void)remove(ctx->tmpname);
	free(ctx->tmpname);
	ctx->tmpname = NULL;
	return -1;
	}

	ctx->fout = tfp;

	return 0;
	}
	#endif

	static bool
	_zip_stdio_op_open(zip_source_file_context_t *ctx) {
	if ((ctx->f = _zip_fopen_close_on_exec(ctx->fname, false)) == NULL) {
	zip_error_set(&ctx->error, ZIP_ER_OPEN, errno);
	return false;
	}
	return true;
	}


	static zip_int64_t
	_zip_stdio_op_remove(zip_source_file_context_t *ctx) {
	if (remove(ctx->fname) < 0) {
	zip_error_set(&ctx->error, ZIP_ER_REMOVE, errno);
	return -1;
	}
	return 0;
	}


	static void
	_zip_stdio_op_rollback_write(zip_source_file_context_t *ctx) {
	if (ctx->fout) {
	fclose(ctx->fout);
	}
	(void)remove(ctx->tmpname);
	}

	static char *
	_zip_stdio_op_strdup(zip_source_file_context_t ctx, const char string) {
	return strdup(string);
	}


	static zip_int64_t
	_zip_stdio_op_write(zip_source_file_context_t ctx, const void data, zip_uint64_t len) {
	size_t ret;

	clearerr((FILE *)ctx->fout);
	ret = fwrite(data, 1, len, (FILE *)ctx->fout);
	if (ret != len \|\| ferror((FILE *)ctx->fout)) {
	zip_error_set(&ctx->error, ZIP_ER_WRITE, errno);
	return -1;
	}

	return (zip_int64_t)ret;
	}


	static int create_temp_file(zip_source_file_context_t *ctx, bool create_file) {
	char *temp;
	int mode;
	struct stat st;
	int fd;
	char start, end;

	if (stat(ctx->fname, &st) == 0) {
	mode = st.st_mode;
	}
	else {
	mode = -1;
	}

	if ((temp = (char *)malloc(strlen(ctx->fname) + 13)) == NULL) {
	zip_error_set(&ctx->error, ZIP_ER_MEMORY, 0);
	return -1;
	}
	sprintf(temp, "%s.XXXXXX.part", ctx->fname);
	end = temp + strlen(temp) - 5;
	start = end - 6;

	for (;;) {
	zip_uint32_t value = zip_random_uint32();
	char *xs = start;

	while (xs < end) {
	char digit = value % 36;
	if (digit < 10) {
	*(xs++) = digit + '0';
	}
	else {
	*(xs++) = digit - 10 + 'a';
	}
	value /= 36;
	}

	if (create_file) {
	if ((fd = open(temp, O_CREAT \| O_EXCL \| O_RDWR \| O_CLOEXEC, mode == -1 ? 0666 : (mode_t)mode)) >= 0) {
	if (mode != -1) {
	/* open() honors umask(), which we don't want in this case */
	#ifdef HAVE_FCHMOD
	(void)fchmod(fd, (mode_t)mode);
	#else
	(void)chmod(temp, (mode_t)mode);
	#endif
	}
	break;
	}
	if (errno != EEXIST) {
	zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
	free(temp);
	return -1;
	}
	}
	else {
	if (stat(temp, &st) < 0) {
	if (errno == ENOENT) {
	break;
	}
	else {
	zip_error_set(&ctx->error, ZIP_ER_TMPOPEN, errno);
	free(temp);
	return -1;
	}
	}
	}
	}

	ctx->tmpname = temp;

	return create_file ? fd : 0;
	}