path: root/browse.c

/*
 * Copyright 2023, Vincent Douillet <vincent@vdouillet.fr>
 *
 * 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. Neither the name of the copyright holder nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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 <sys/queue.h>

#include <dirent.h>
#include <kcgi.h>
#include <kcgihtml.h>
#include <limits.h>
#include <stdbool.h>
#include <stdlib.h>
#include <string.h>

#include "browse.h"
#include "cgi.h"
#include "config.h"
#include "download.h"
#include "file.h"
#include "http.h"
#include "str.h"
#include "template.h"
#include "upload.h"
#include "url.h"

/*
 * a list of files
 */
SLIST_HEAD(, file) list;

/*
 * browse url = r->pname / BROWSE_URL / file->path
 */
size_t
build_browse_url(struct kreq * r, struct file * file)
{
	char 	action_url[PATH_MAX];
	size_t 	action_url_len;

	if (!file->is_dir)
		return 0;

	action_url_len = url_build(action_url, PATH_MAX, r->pname, BROWSE_URL,
				   file->path, NULL);
	if (action_url_len == 0 || action_url_len >= PATH_MAX) {
		kutil_warn(r, NULL,
			   "browse: action URL overflow: %s", action_url);
		return 0;
	}
	file->action_url = strndup(action_url, action_url_len);
	if (file->action_url == NULL) {
		kutil_warn(r, NULL,
			   "browse: unable to allocate file url buffer: %s",
			   action_url);
		return 0;
	}
	return action_url_len;
}

static int
build_file_list(struct kreq * r, const struct file * request_dir)
{
	bool 	action_url_ok;
	char 	file_path[PATH_MAX], request_dir_path[PATH_MAX];
	DIR    *data_dir;
	size_t 	file_path_len, request_dir_len;
	struct dirent *dir;
	struct file *file;
	struct file *last_file;

	request_dir_len = file_get_data_path(request_dir, request_dir_path,
					     PATH_MAX, NULL);
	if (request_dir_len == 0) {
		kutil_warn(r, NULL,
			   "browse: Unable to build request dir path: %s",
			   request_dir_path);
		return -1;
	}
	data_dir = opendir(request_dir_path);
	if (NULL == data_dir)
		return -1;

	SLIST_INIT(&list);
	last_file = NULL;
	while ((dir = readdir(data_dir)) != NULL) {
		/* ignore special . and .. folders */
		if (strcmp(".", dir->d_name) == 0
		    || strcmp("..", dir->d_name) == 0)
			continue;
		/* build file path */
		file_path_len = path_build(file_path, PATH_MAX, r->path,
					   dir->d_name, NULL);
		if (file_path_len == 0 || file_path_len >= PATH_MAX) {
			kutil_warn(r, NULL,
				 "browse: unable to build file, skipping %s",
				   dir->d_name);
			continue;
		}
		/* build file */
		file = file_new(file_path);
		if (file == NULL) {
			kutil_warn(r, NULL,
			      "browse: unable to allocate file, skipping %s",
				   dir->d_name);
			continue;
		}
		/* build action url */
		if (file->is_dir)
			action_url_ok = build_browse_url(r, file) > 0;
		else
			action_url_ok = build_download_url(r, file) > 0;
		if (!action_url_ok) {
			kutil_warn(r, NULL,
			   "browse: unable to build action url, skipping %s",
				   dir->d_name);
			file_free(file);
			continue;
		}
		/* add file to list */
		if (last_file == NULL)
			SLIST_INSERT_HEAD(&list, file, files);
		else
			SLIST_INSERT_AFTER(last_file, file, files);

		last_file = file;
	}

	closedir(data_dir);
	return 0;
}

/*
 * data required in the template functions
 */
struct template_data {
	struct kreq *r;
	struct khtmlreq *html;
	struct file *f;
};

static const char *const header_template_keys[] = {"upload_url"};

static int
header_template_callback(size_t index, void *arg)
{
	struct kreq *r;
	struct khtmlreq *html;
	struct template_data *data;

	if (arg == NULL) {
		kutil_warn(NULL, NULL,
			   "Invalid data for browse header template");
		return 0;
	}
	data = arg;
	r = data->r;
	html = data->html;

	switch (index) {
	case 0:
		/* upload_url */
		K_OK(khtml_puts(html, data->f->action_url), r);
		break;
	default:
		kutil_warnx(r, NULL,
			 "Invalid key index for browse header template: %zd",
			    index);
		return 0;
	}

	return 1;
}

static const char *const file_template_keys[] = {"icon", "name", "url", "size"};

static int
file_template_callback(size_t index, void *arg)
{
	char   *basename;
	struct kreq *r;
	struct khtmlreq *html;
	struct template_data *data;
	float 	file_size;
	int 	i;
	char 	size_read[] = {'k', 'M', 'G'};

	if (arg == NULL) {
		kutil_warn(NULL, NULL, "Invalid data for browse file template");
		return 0;
	}
	data = arg;
	r = data->r;
	html = data->html;

	switch (index) {
	case 0:
		/* icon */
		K_OK(khtml_puts(html, data->f->is_dir ? "folder" : "file"), r);
		break;
	case 1:
		/* name */
		basename = file_get_basename(data->f);
		if (basename == NULL) {
			kutil_warnx(r, NULL,
				    "browse: unable to get file name: %s",
				    data->f->path);
			break;
		}
		K_OK(khtml_puts(html, basename), r);
		break;
	case 2:
		/* url */
		K_OK(khtml_puts(html, data->f->action_url), r);
		break;
	case 3:
		/* size, print as human readable */
		file_size = data->f->size;
		i = 0;
		while (file_size > 1024 && i < 3) {
			file_size /= 1024;
			i++;
		}
		if (i == 0) {
			K_OK(khtml_printf(html, "%zu B", data->f->size), r);
		} else {
			K_OK(khtml_printf(html, "%.1f %cB", file_size,
					  size_read[i - 1]), r);
		}
		break;
	default:
		kutil_warnx(r, NULL,
			    "Invalid key index for browse file template: %zd",
			    index);
		return 0;
	}

	return 1;
}

struct http_ret
browse(struct kreq * r)
{
	struct file *file;
	struct page_template *tmpl;
	struct http_ret ret;
	struct khtmlreq html;
	struct ktemplate template;
	struct template_data data;

	/* initialize vars */
	file = NULL;
	tmpl = NULL;

	/* initialize return structure for success */
	ret = (struct http_ret) {
		KHTTP_200, ""
	};

	/* check that the requested URL can be safely processed */
	if (!check_request_path(r->path, r->suffix)) {
		ret = (struct http_ret) {
			KHTTP_400,
			"browse: Invalid request path"
		};
		goto end;
	}
	/* list requested directory content */
	file = file_new(r->path);
	if (file == NULL) {
		ret = (struct http_ret) {
			KHTTP_404,
			"browse: Unable to build data file"
		};
		goto end;
	}
	if (!file->is_dir) {
		ret = (struct http_ret) {
			KHTTP_404,
			"browse: Invalid data file"
		};
		goto end;
	}
	if (build_upload_url(r, file) == 0) {
		ret = (struct http_ret) {
			KHTTP_500,
			"browse: Can't build upload url"
		};
		goto end;
	}

	if (build_file_list(r, file) < 0) {
		ret = (struct http_ret) {
			KHTTP_500,
			"browse: Unable to build file list"
		};
		goto end;
	}

	/* read template */
	tmpl = page_template_new(BROWSE_URL);
	if (tmpl == NULL) {
		ret = (struct http_ret) {
			KHTTP_500,
			"browse: Unable to read template"
		};
		goto end;
	}

	/* we have all the data we need, we can start to write output page */
	http_open(r, KHTTP_200, r->mime);

	K_OK(khttp_puts(r, tmpl->header), r);

	K_OK(khtml_open(&html, r, 0), r);

	/* print browse header with action buttons for current dir */
	template.key = header_template_keys;
	template.keysz = 1;
	template.cb = header_template_callback;
	template.arg = &data;
	data.r = r;
	data.html = &html;
	data.f = file;
	K_OK(khttp_template_buf(r, &template, tmpl->page_header,
				strlen(tmpl->page_header)), r);

	/* print file list */
	template.key = file_template_keys;
	template.keysz = 4;
	template.cb = file_template_callback;

	SLIST_FOREACH(file, &list, files) {
		data.f = file;
		K_OK(khttp_template_buf(r, &template, tmpl->page_item,
					strlen(tmpl->page_item)), r);
	}

	K_OK(khttp_puts(r, tmpl->page_footer), r);
	K_OK(khttp_puts(r, tmpl->footer), r);

	K_OK(khtml_close(&html), r);

	/* free page template and file list */
end:
	page_template_free(tmpl);
	if (file != NULL) {
		file_free(file);
		file = NULL;
	}
	while (!SLIST_EMPTY(&list)) {
		file = SLIST_FIRST(&list);
		SLIST_REMOVE_HEAD(&list, files);
		file_free(file);
		file = NULL;
	}

	return ret;
}