packager: Set creation time and ownership for files

[people/ms/pakfire.git] / src / libpakfire / packager.c

/*#############################################################################
#                                                                             #
# Pakfire - The IPFire package management system                              #
# Copyright (C) 2021 Pakfire development team                                 #
#                                                                             #
# This program is free software: you can redistribute it and/or modify        #
# it under the terms of the GNU General Public License as published by        #
# the Free Software Foundation, either version 3 of the License, or           #
# (at your option) any later version.                                         #
#                                                                             #
# This program is distributed in the hope that it will be useful,             #
# but WITHOUT ANY WARRANTY; without even the implied warranty of              #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               #
# GNU General Public License for more details.                                #
#                                                                             #
# You should have received a copy of the GNU General Public License           #
# along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
#                                                                             #
#############################################################################*/

#include <errno.h>
#include <fcntl.h>
#include <linux/limits.h>
#include <stdlib.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <time.h>
#include <unistd.h>

#include <archive.h>
#include <archive_entry.h>

#include <pakfire/archive.h>
#include <pakfire/constants.h>
#include <pakfire/file.h>
#include <pakfire/filelist.h>
#include <pakfire/logging.h>
#include <pakfire/package.h>
#include <pakfire/packager.h>
#include <pakfire/pakfire.h>
#include <pakfire/private.h>
#include <pakfire/pwd.h>
#include <pakfire/types.h>

#define BUFFER_SIZE 64 * 1024

struct pakfire_packager {
	Pakfire pakfire;
	int nrefs;
	time_t time_created;

	PakfirePackage pkg;
	PakfireFilelist filelist;

	// Reader
	struct archive* reader;

	// Payload
	struct archive* payload;
	FILE* fpayload;
};

static int pakfire_packager_create_payload(struct pakfire_packager* p, int compress) {
	char path[] = "/tmp/.pakfire-payload.XXXXXX";

	p->payload = archive_write_new();
	if (!p->payload) {
		ERROR(p->pakfire, "archive_write_new() failed\n");
		return 1;
	}

	// Use the PAX format
	int r = archive_write_set_format_pax(p->payload);
	if (r) {
		ERROR(p->pakfire, "Could not set format to PAX: %s\n",
			archive_error_string(p->payload));
		return r;
	}

	// Add filters to compress the payload
	if (compress) {
		// Enable Zstd
		r = archive_write_add_filter_zstd(p->payload);
		if (r) {
			ERROR(p->pakfire, "Could not enable Zstandard compression: %s\n",
				archive_error_string(p->payload));
			return r;
		}

		// Set compression level to highest
		r = archive_write_set_filter_option(p->payload, NULL, "compression-level", "19");
		if (r) {
			ERROR(p->pakfire, "Could not set Zstandard compression level: %s\n",
				archive_error_string(p->payload));
			return r;
		}
	}

	// Create a new temporary file
	int fd = mkostemp(path, O_CLOEXEC);
	if (fd < 0) {
		ERROR(p->pakfire, "mkostemp() failed: %s\n", strerror(errno));
		return 1;
	}

	// Unlink the file straight away
	unlink(path);

	// Convert the file descriptor into a file handle
	p->fpayload = fdopen(fd, "w+");
	if (!p->fpayload) {
		close(fd);

		return 1;
	}

	// Write archive to file
	r = archive_write_open_FILE(p->payload, p->fpayload);
	if (r)
		return r;

	return 0;
}

static void pakfire_packager_free(struct pakfire_packager* packager) {
	if (packager->payload)
		archive_write_free(packager->payload);

	if (packager->fpayload)
		fclose(packager->fpayload);

	if (packager->reader)
		archive_free(packager->reader);

	pakfire_filelist_unref(packager->filelist);
	pakfire_package_unref(packager->pkg);
	pakfire_unref(packager->pakfire);
}

static const char* pakfire_packager_user_lookup(void* data, la_int64_t uid) {
	Pakfire pakfire = (Pakfire)data;

	// Fast path for "root"
	if (uid == 0)
		return "root";

	// Find a matching entry in /etc/passwd
	struct passwd* entry = pakfire_getpwuid(pakfire, uid);
	if (!entry) {
		ERROR(pakfire, "Could not retrieve uname for %ld: %s\n", uid, strerror(errno));
		return 0;
	}

	DEBUG(pakfire, "Mapping UID %ld to %s\n", uid, entry->pw_name);

	return entry->pw_name;
}

static const char* pakfire_packager_group_lookup(void* data, la_int64_t gid) {
	Pakfire pakfire = (Pakfire)data;

	// Fast path for "root"
	if (gid == 0)
		return "root";

	// Find a matching entry in /etc/group
	struct group* entry = pakfire_getgrgid(pakfire, gid);
	if (!entry) {
		ERROR(pakfire, "Could not retrieve gname for %ld: %s\n", gid, strerror(errno));
		return 0;
	}

	DEBUG(pakfire, "Mapping GID %ld to %s\n", gid, entry->gr_name);

	return entry->gr_name;
}

static int pakfire_packager_create_reader(struct pakfire_packager* p) {
	// Open a reader
	p->reader = archive_read_disk_new();
	if (!p->reader) {
		ERROR(p->pakfire, "archive_read_disk_new() failed\n");
		return 1;
	}

	// Do not read fflags
	int r = archive_read_disk_set_behavior(p->reader, ARCHIVE_READDISK_NO_FFLAGS);
	if (r) {
		ERROR(p->pakfire, "Could not change behavior of reader: %s\n",
			archive_error_string(p->reader));
		return 1;
	}

	// Install our own routine for user/group lookups
	archive_read_disk_set_uname_lookup(p->reader, p->pakfire,
		pakfire_packager_user_lookup, NULL);
	archive_read_disk_set_gname_lookup(p->reader, p->pakfire,
		pakfire_packager_group_lookup, NULL);

	return 0;
}

PAKFIRE_EXPORT int pakfire_packager_create(struct pakfire_packager** packager,
		PakfirePackage pkg) {
	struct pakfire_packager* p = calloc(1, sizeof(*p));
	if (!p)
		return ENOMEM;

	// Save creation time
	p->time_created = time(NULL);

	// Initialize reference counting
	p->nrefs = 1;

	// Store a reference to Pakfire
	p->pakfire = pakfire_package_get_pakfire(pkg);

	// Store a reference to the package
	p->pkg = pakfire_package_ref(pkg);

	// Create a new filelist
	int r = pakfire_filelist_create(&p->filelist, p->pakfire);
	if (r)
		goto ERROR;

	// Create reader
	r = pakfire_packager_create_reader(p);
	if (r)
		goto ERROR;

	// Start payload
	r = pakfire_packager_create_payload(p, 1);
	if (r)
		goto ERROR;

	*packager = p;

	return 0;

ERROR:
	pakfire_packager_free(p);

	return r;
}

PAKFIRE_EXPORT struct pakfire_packager* pakfire_packager_ref(
		struct pakfire_packager* packager) {
	++packager->nrefs;

	return packager;
}

PAKFIRE_EXPORT struct pakfire_packager* pakfire_packager_unref(
		struct pakfire_packager* packager) {
	if (--packager->nrefs > 0)
		return packager;

	pakfire_packager_free(packager);

	return NULL;
}

static int pakfire_packager_copy_data(struct pakfire_packager* packager,
		struct archive* a, FILE* f) {
	char buffer[BUFFER_SIZE];

	while (!feof(f)) {
		// Read a block from file
		size_t bytes_read = fread(buffer, 1, sizeof(buffer), f);

		// Check if any error occured
		if (ferror(f)) {
			ERROR(packager->pakfire, "Error reading from file: %s\n", strerror(errno));
			return 1;
		}

		// Write the block to the archive
		ssize_t bytes_written = archive_write_data(a, buffer, bytes_read);
		if (bytes_written < 0) {
			ERROR(packager->pakfire, "Error writing data to archive: %s\n",
				archive_error_string(a));
			return 1;
		}
	}

	return 0;
}

static int pakfire_packager_write_file_from_buffer(struct pakfire_packager* packager,
		struct archive* a, const char* filename, const char* buffer) {
	// Create a new file entry
	struct archive_entry* entry = archive_entry_new();
	if (!entry)
		return 1;

	// Set filename
	archive_entry_set_pathname(entry, filename);

	// This is a regular file
    archive_entry_set_filetype(entry, AE_IFREG);
    archive_entry_set_perm(entry, 0644);

	// Set ownership
	archive_entry_set_uname(entry, "root");
	archive_entry_set_uid(entry, 0);
	archive_entry_set_gname(entry, "root");
	archive_entry_set_gid(entry, 0);

	// Set times
	archive_entry_set_birthtime(entry, packager->time_created, 0);
	archive_entry_set_ctime(entry, packager->time_created, 0);
	archive_entry_set_mtime(entry, packager->time_created, 0);
	archive_entry_set_atime(entry, packager->time_created, 0);

	// Set length
	archive_entry_set_size(entry, strlen(buffer));

	// This is the end of the header
	int r = archive_write_header(a, entry);
	if (r) {
		ERROR(packager->pakfire, "Error writing header: %s\n", archive_error_string(a));
		archive_entry_free(entry);
		return r;
	}

	// Write content
	r = archive_write_data(a, buffer, strlen(buffer));
	if (r < 0) {
		ERROR(packager->pakfire, "Error writing data: %s\n", archive_error_string(a));
		archive_entry_free(entry);
		return r;
	}

	archive_entry_free(entry);

	return 0;
}

static int pakfire_packager_write_format(struct pakfire_packager* packager,
		struct archive* a) {
	const char buffer[] = TO_STRING(PACKAGE_FORMAT) "\n";

	return pakfire_packager_write_file_from_buffer(packager, a,
		PAKFIRE_ARCHIVE_FN_FORMAT, buffer);
}

static char* pakfire_package_make_metadata(struct pakfire_packager* packager) {
	PakfirePackage pkg = packager->pkg;

	char* buffer = NULL;
	int r;

	// Print version information
	r = asprintf(&buffer, "# Pakfire %s\n\n", PACKAGE_VERSION);
	if (r < 0)
		goto ERROR;

	// Write package information
	r = asprintf(&buffer, "%s# Package information\npackage\n", buffer);
	if (r < 0)
		goto ERROR;

	// Write package name
	r = asprintf(&buffer, "%s\tname        = %s\n", buffer, pakfire_package_get_name(pkg));
	if (r < 0)
		goto ERROR;

	// Write package version
	r = asprintf(&buffer, "%s\tversion     = %s\n", buffer, pakfire_package_get_version(pkg));
	if (r < 0)
		goto ERROR;

	// Write package release
	r = asprintf(&buffer, "%s\trelease     = %s\n", buffer, pakfire_package_get_release(pkg));
	if (r < 0)
		goto ERROR;

	// Write package epoch
	r = asprintf(&buffer, "%s\tepoch       = %lu\n", buffer, pakfire_package_get_epoch(pkg));
	if (r < 0)
		goto ERROR;

	// Write package arch
	r = asprintf(&buffer, "%s\tarch        = %s\n", buffer, pakfire_package_get_arch(pkg));
	if (r < 0)
		goto ERROR;

	// Write package UUID
	r = asprintf(&buffer, "%s\tuuid        = %s\n", buffer, pakfire_package_get_uuid(pkg));
	if (r < 0)
		goto ERROR;

	// Write package groups
	const char* groups = pakfire_package_get_groups(pkg);
	if (groups) {
		r = asprintf(&buffer, "%s\tgroups      = %s\n", buffer, groups);
		if (r < 0)
			goto ERROR;
	}

	// Write package maintainer
	const char* maintainer = pakfire_package_get_maintainer(pkg);
	if (maintainer) {
		r = asprintf(&buffer, "%s\tmaintainer  = %s\n", buffer, maintainer);
		if (r < 0)
			goto ERROR;
	}

	// Write package url
	const char* url = pakfire_package_get_maintainer(pkg);
	if (url) {
		r = asprintf(&buffer, "%s\turl         = %s\n", buffer, url);
		if (r < 0)
			goto ERROR;
	}

	// Write package license
	const char* license = pakfire_package_get_license(pkg);
	if (license) {
		r = asprintf(&buffer, "%s\tlicense     = %s\n", buffer, license);
		if (r < 0)
			goto ERROR;
	}

	// Write package summary
	const char* summary = pakfire_package_get_summary(pkg);
	if (summary) {
		r = asprintf(&buffer, "%s\tsummary     = %s\n", buffer, summary);
		if (r < 0)
			goto ERROR;
	}

	// XXX description

	size_t size = pakfire_package_get_installsize(pkg);
	r = asprintf(&buffer, "%s\tsize        = %zu\n", buffer, size);
	if (r < 0)
		goto ERROR;

	// End package block
	r = asprintf(&buffer, "%send\n\n", buffer);
	if (r < 0)
		goto ERROR;

	// Write build information
	r = asprintf(&buffer, "%s# Build information\nbuild\n", buffer);
	if (r < 0)
		goto ERROR;

	// Write build host
	const char* build_host = pakfire_package_get_build_host(pkg);
	if (build_host) {
		r = asprintf(&buffer, "%s\thost        = %s\n", buffer, build_host);
		if (r < 0)
			goto ERROR;
	}

#if 0
	// Write build id
	const char* build_id = pakfire_package_get_build_id(pkg);
	if (build_id) {
		r = asprintf(&buffer, "%s\tid          = %s\n", buffer, build_id);
		if (r < 0)
			goto ERROR;
	}
#endif

	// Write build host
	time_t build_time = pakfire_package_get_build_time(pkg);
	if (build_host) {
		r = asprintf(&buffer, "%s\ttime        = %lu\n", buffer, build_time);
		if (r < 0)
			goto ERROR;
	}

	// End build block
	r = asprintf(&buffer, "%send\n\n", buffer);
	if (r < 0)
		goto ERROR;

#if 0
	// Write distribution information
	r = asprintf(&buffer, "%s# Distribution information\ndistribution\n", buffer);
	if (r < 0)
		goto ERROR;

	// End distribution block
	r = asprintf(&buffer, "%send\n\n", buffer);
	if (r < 0)
		goto ERROR;
#endif

	// Write dependency information
	r = asprintf(&buffer, "%s# Dependency information\ndependencies\n", buffer);
	if (r < 0)
		goto ERROR;

	const struct dependencies {
		const char* type;
		PakfireRelationList (*func)(PakfirePackage pkg);
	} dependencies[] = {
		{ "prerequires", pakfire_package_get_prerequires },
		{ "requires",    pakfire_package_get_requires },
		{ "provides",    pakfire_package_get_provides },
		{ "conflicts",   pakfire_package_get_conflicts },
		{ "obsoletes",   pakfire_package_get_obsoletes },
		{ "recommends",  pakfire_package_get_recommends },
		{ "suggests",    pakfire_package_get_suggests },
		{ "supplements", pakfire_package_get_supplements },
		{ "enhances",    pakfire_package_get_enhances },
		{ NULL },
	};

	for (const struct dependencies* d = dependencies; d->type; d++) {
		PakfireRelationList list = d->func(pkg);
		if (!list)
			continue;

		size_t l = pakfire_relationlist_size(list);

		// Skip for empty lists
		if (l == 0) {
			pakfire_relationlist_unref(list);
			continue;
		}

		// Write header
		r = asprintf(&buffer, "%s\t%s\n", buffer, d->type);
		if (r < 0) {
			pakfire_relationlist_unref(list);
			goto ERROR;
		}

		for (unsigned int i = 0; i < l; i++) {
			PakfireRelation rel = pakfire_relationlist_get(list, i);

			char* s = pakfire_relation_str(rel);
			if (s) {
				r = asprintf(&buffer, "%s\t\t%s\n", buffer, s);
				free(s);
				if (r < 0) {
					pakfire_relationlist_unref(list);
					pakfire_relation_unref(rel);
					goto ERROR;
				}
			}

			pakfire_relation_unref(rel);
		}

		// End block
		r = asprintf(&buffer, "%s\tend\n", buffer);
		if (r < 0)
			goto ERROR;

		pakfire_relationlist_unref(list);
	}

	// End dependencies block
	r = asprintf(&buffer, "%send\n\n", buffer);
	if (r < 0)
		goto ERROR;

	// EOF
	r = asprintf(&buffer, "%s# EOF\n", buffer);
	if (r < 0)
		goto ERROR;

	return buffer;

ERROR:
	if (buffer)
		free(buffer);

	return NULL;
}

static int pakfire_packager_write_metadata(struct pakfire_packager* packager,
		struct archive* a) {
	// Make metadata
	char* buffer = pakfire_package_make_metadata(packager);
	if (!buffer)
		return 1;

	DEBUG(packager->pakfire, "Generated package metadata:\n%s", buffer);

	// Write buffer
	int r = pakfire_packager_write_file_from_buffer(packager, a,
		PAKFIRE_ARCHIVE_FN_METADATA, buffer);

	free(buffer);

	return r;
}

static int pakfire_packager_write_payload(struct pakfire_packager* packager,
		struct archive* a) {
	struct stat st;

	// Close the payload
	if (packager->payload) {
		archive_write_free(packager->payload);
		packager->payload = NULL;
	}

	// Reset fd to beginning of the file
	rewind(packager->fpayload);

	int fd = fileno(packager->fpayload);

	// Stat the payload file
	int r = fstat(fd, &st);
	if (r) {
		ERROR(packager->pakfire, "stat() on fd %d failed: %s\n", fd, strerror(errno));
		return 1;
	}

	// Create a new file entry
	struct archive_entry* entry = archive_entry_new();
	if (!entry)
		return 1;

	// Set filename
	archive_entry_set_pathname(entry, PAKFIRE_ARCHIVE_FN_PAYLOAD);

	// This is a regular file
	archive_entry_set_filetype(entry, AE_IFREG);
	archive_entry_set_perm(entry, 0644);

	// Set the file size
	archive_entry_set_size(entry, st.st_size);

	// This is the end of the header
	r = archive_write_header(a, entry);
	if (r) {
		ERROR(packager->pakfire, "Error writing header: %s\n", archive_error_string(a));
		goto ERROR;
	}

	// Copy data
	r = pakfire_packager_copy_data(packager, a, packager->fpayload);
	if (r)
		goto ERROR;

	// Success
	r = 0;

ERROR:
	archive_entry_free(entry);

	return r;
}

/*
	This function is being called at the end when all data has been added to the package.

	It will create a new archive and write the package to the given file descriptor.
*/
PAKFIRE_EXPORT char* pakfire_packager_finish(struct pakfire_packager* packager, FILE* f) {
	char* filename = NULL;

	// Store total instal size
	pakfire_package_set_installsize(packager->pkg,
		pakfire_filelist_total_filesize(packager->filelist));

	// Open a new archive
	struct archive* a = archive_write_new();
	if (!a) {
		ERROR(packager->pakfire, "archive_write_new() failed\n");
		goto ERROR;
	}

	// Use the PAX format
	int r = archive_write_set_format_pax(a);
	if (r) {
		ERROR(packager->pakfire, "Could not set format to PAX: %s\n",
			archive_error_string(a));
		goto ERROR;
	}

	// Write archive to f
	r = archive_write_open_FILE(a, f);
	if (r) {
		ERROR(packager->pakfire, "archive_write_open_FILE() failed: %s\n",
			archive_error_string(a));
		goto ERROR;
	}

	// Start with the format file
	r = pakfire_packager_write_format(packager, a);
	if (r)
		goto ERROR;

	// Write the metadata
	r = pakfire_packager_write_metadata(packager, a);
	if (r)
		goto ERROR;

	// Write the payload
	r = pakfire_packager_write_payload(packager, a);
	if (r)
		goto ERROR;

	// XXX set filename

ERROR:
	if (a)
		archive_free(a);

	return filename;
}

PAKFIRE_EXPORT int pakfire_packager_add(struct pakfire_packager* packager,
		const char* path) {
	FILE* f = NULL;

	// Check if path is set
	if (!path)
		return EINVAL;

	// Payload has already been closed
	if (!packager->payload)
		return EINVAL;

	// Create a new file entry
	struct archive_entry* entry = archive_entry_new();
	if (!entry)
		return ENOMEM;

	// Set path in archive
	archive_entry_set_pathname(entry, path);

	// Read all attributes from file
	int r = archive_read_disk_entry_from_file(packager->reader, entry, -1, NULL);
	if (r) {
		ERROR(packager->pakfire, "Could not read attributes from %s: %s\n",
			path, strerror(errno));
		goto ERROR;
	}

	// Write the header
	r = archive_write_header(packager->payload, entry);
	if (r) {
		ERROR(packager->pakfire, "Error writing file header: %s\n",
			archive_error_string(packager->payload));
		goto ERROR;
	}

	// Copy the data of regular files
	if (archive_entry_filetype(entry) == AE_IFREG) {
		f = fopen(path, "r");
		if (!f) {
			ERROR(packager->pakfire, "Could not open %s: %s\n", path, strerror(errno));
			r = errno;
			goto ERROR;
		}

		r = pakfire_packager_copy_data(packager, packager->payload, f);
		if (r)
			goto ERROR;
	}

	// Create a file
	PakfireFile file;
	r = pakfire_file_create(&file, packager->pakfire);
	if (r)
		goto ERROR;

	r = pakfire_file_copy_archive_entry(file, entry);
	if (r)
		goto ERROR;

	// Append the file to the filelist
	pakfire_filelist_append(packager->filelist, file);

	// Successful
	r = 0;

ERROR:
	pakfire_file_unref(file);

	if (entry)
		archive_entry_free(entry);

	if (f)
		fclose(f);

	return r;
}