badwolf/downloads.c

// BadWolf: Minimalist and privacy-oriented WebKitGTK+ browser
// SPDX-FileCopyrightText: 2019-2022 Badwolf Authors <https://hacktivis.me/projects/badwolf>
// SPDX-License-Identifier: BSD-3-Clause

#include "downloads.h"

#include "badwolf.h"
#include "config.h"

#include <assert.h>
#include <glib/gi18n.h> /* _() and other internationalization/localization helpers */

static void
download_stop_iconCb_clicked(GtkButton *UNUSED(stop_icon), gpointer user_data)
{
	WebKitDownload *webkit_download = (WebKitDownload *)user_data;

	webkit_download_cancel(webkit_download);
}

void
download_format_elapsed(char *restrict formatted,
                        size_t formatted_size,
                        char *restrict format,
                        int total)
{
	/* flawfinder: ignore, format string only passed by ourselves */
	snprintf(formatted,
	         formatted_size,
	         format,
	         total / 3600,        /* hours */
	         (total % 3600) / 60, /* minutes */
	         total % 60);         /* seconds */
}

void
download_new_entry(WebKitDownload *webkit_download, struct Download *download)
{
	download->error     = 0;
	download->container = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, BADWOLF_DOWNLOAD_PADDING);
	download->progress  = gtk_progress_bar_new();
	download->file_path = gtk_label_new(NULL);
	download->status    = gtk_label_new(_("Download starting…"));
	download->icon      = gtk_image_new_from_icon_name("network-idle-symbolic");
	download->stop_icon = gtk_button_new_from_icon_name("process-stop");

	gtk_progress_bar_set_show_text(GTK_PROGRESS_BAR(download->progress), TRUE);
	gtk_label_set_ellipsize(GTK_LABEL(download->file_path), BADWOLF_DOWNLOAD_FILE_PATH_ELLIPSIZE);

	g_signal_connect(
	    download->stop_icon, "clicked", G_CALLBACK(download_stop_iconCb_clicked), webkit_download);

	gtk_box_append(GTK_BOX(download->container), download->icon);
	gtk_box_append(GTK_BOX(download->container), download->progress);
	gtk_box_append(GTK_BOX(download->container), download->stop_icon);
	gtk_box_append(GTK_BOX(download->container), download->status);
	gtk_box_append(GTK_BOX(download->container), download->file_path);

	gtk_list_box_insert(GTK_LIST_BOX(window->downloads_tab), download->container, -1);
}

void
downloadCb_created_destination(WebKitDownload *UNUSED(webkit_download),
                               gchar *destination,
                               gpointer user_data)
{
	char *markup;
	struct Download *download = (struct Download *)user_data;

	markup = g_markup_printf_escaped(
	    "<a href=\"%s\">%s</a>", destination, webkit_uri_for_display(destination));

	gtk_label_set_markup(GTK_LABEL(download->file_path), markup);
	g_free(markup);
}

static void
file_chooserCb_response(GtkNativeDialog *file_chooser, int response, gpointer user_data)
{
	WebKitDownload *webkit_download = (WebKitDownload *)user_data;

	if(response != GTK_RESPONSE_ACCEPT) webkit_download_cancel(webkit_download);

	// FIXME: Check if it works with both existing files and not-existing files
	GFile *destination = gtk_file_chooser_get_file(file_chooser);
	webkit_download_set_destination(webkit_download, g_file_get_path(destination));
}

gboolean
downloadCb_decide_destination(WebKitDownload *webkit_download,
                              gchar *suggested_filename,
                              gpointer UNUSED(user_data))
{
	GtkWindow *parent_window = GTK_WINDOW(window->main_window);

	GtkFileChooserNative *file_dialog =
	    gtk_file_chooser_native_new(NULL, parent_window, GTK_FILE_CHOOSER_ACTION_SAVE, NULL, NULL);
	GtkFileChooser *file_chooser = GTK_FILE_CHOOSER(file_dialog);

	gtk_file_chooser_set_current_name(file_chooser, suggested_filename);
	webkit_download_set_allow_overwrite(webkit_download, TRUE);

	g_signal_connect(file_chooser, "response", G_CALLBACK(file_chooserCb_response), webkit_download);

	gtk_native_dialog_show(GTK_NATIVE_DIALOG(file_dialog));

	return TRUE; /* async */
}

void
downloadCb_failed(WebKitDownload *webkit_download, GError *error, gpointer user_data)
{
	struct Download *download = (struct Download *)user_data;
	/* flawfinder: ignore. proper buffer limits are used */
	char formatted[BUFSIZ];
	int total = (int)webkit_download_get_elapsed_time(webkit_download);
	char *format;

	download->error = error;

	if(g_error_matches(error, WEBKIT_DOWNLOAD_ERROR, WEBKIT_DOWNLOAD_ERROR_CANCELLED_BY_USER))
		format = _("%02i:%02i:%02i Download cancelled");
	else
		format = _("%02i:%02i:%02i Download error");

	download_format_elapsed(formatted, sizeof(formatted), format, total);

	gtk_label_set_text(GTK_LABEL(download->status), formatted);

	gtk_image_set_from_icon_name(GTK_IMAGE(download->icon), "network-error-symbolic");
}

void
downloadCb_finished(WebKitDownload *webkit_download, gpointer user_data)
{
	struct Download *download = (struct Download *)user_data;
	/* flawfinder: ignore. proper buffer limits are used */
	char formatted[BUFSIZ];
	int total = (int)webkit_download_get_elapsed_time(webkit_download);

	gchar *format_size = g_format_size(webkit_download_get_received_data_length(webkit_download));

	download_format_elapsed(
	    formatted, sizeof(formatted), _("%02i:%02i:%02i Download finished"), total);

	gtk_widget_destroy(download->stop_icon);

	if(download->error == 0)
	{
		gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(download->progress), 1);
		gtk_progress_bar_set_text(GTK_PROGRESS_BAR(download->progress), format_size);
		gtk_label_set_text(GTK_LABEL(download->status), formatted);
		gtk_image_set_from_icon_name(GTK_IMAGE(download->icon), "network-idle-symbolic");
	}

	// TODO: Send notification
}

void
downloadCb_received_data(WebKitDownload *webkit_download,
                         guint64 UNUSED(data_lenght),
                         gpointer user_data)
{
	struct Download *download = (struct Download *)user_data;
	/* flawfinder: ignore. proper buffer limits are used */
	char formatted[BUFSIZ];
	int total = (int)webkit_download_get_elapsed_time(webkit_download);

	gchar *format_size = g_format_size(webkit_download_get_received_data_length(webkit_download));

	download_format_elapsed(formatted, sizeof(formatted), _("%02i:%02i:%02i Downloading…"), total);

	gtk_image_set_from_icon_name(GTK_IMAGE(download->icon), "network-receive-symbolic");
	gtk_label_set_text(GTK_LABEL(download->status), formatted);
	gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(download->progress),
	                              webkit_download_get_estimated_progress(webkit_download));
	gtk_progress_bar_set_text(GTK_PROGRESS_BAR(download->progress), format_size);

	g_free(format_size);
}

GtkWidget *
badwolf_downloads_tab_new()
{
	return gtk_list_box_new();
}

void
badwolf_downloads_tab_attach()
{
	assert(window != NULL);

	GtkWidget *scrolled_window = gtk_scrolled_window_new();
	gtk_widget_set_name(scrolled_window, "browser__scrollwin_downloads");
	gtk_scrolled_window_set_child(scrolled_window, window->downloads_tab);
	gtk_notebook_insert_page(GTK_NOTEBOOK(window->notebook), scrolled_window, NULL, 0);

	gtk_notebook_set_tab_reorderable(GTK_NOTEBOOK(window->notebook), scrolled_window, TRUE);

	GtkWidget *tab_box = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
	gtk_widget_set_name(tab_box, "browser__tabbox");
	GtkWidget *icon = gtk_image_new_from_icon_name("emblem-downloads");
	gtk_widget_set_name(icon, "browser__tabbox__icon");
	GtkWidget *label = gtk_label_new(_("Badwolf Downloads"));
	gtk_widget_set_name(label, "browser__tabbox__label");

#ifdef BADWOLF_TAB_BOX_WIDTH
	gtk_widget_set_size_request(label, BADWOLF_TAB_BOX_WIDTH, -1);
#endif
#ifdef BADWOLF_TAB_LABEL_CHARWIDTH
	gtk_label_set_width_chars(GTK_LABEL(label), BADWOLF_TAB_LABEL_CHARWIDTH);
#endif
	gtk_widget_set_hexpand(tab_box, BADWOLF_TAB_HEXPAND);

	gtk_label_set_ellipsize(GTK_LABEL(label), BADWOLF_TAB_LABEL_ELLIPSIZE);
	gtk_label_set_single_line_mode(GTK_LABEL(label), TRUE);

	gtk_box_append(GTK_BOX(tab_box), icon);
	gtk_box_append(GTK_BOX(tab_box), label);

	gtk_widget_set_tooltip_text(tab_box, _("Badwolf Downloads"));
	gtk_notebook_set_tab_label(GTK_NOTEBOOK(window->notebook), scrolled_window, tab_box);
	gtk_notebook_set_menu_label_text(
	    GTK_NOTEBOOK(window->notebook), scrolled_window, _("Badwolf Downloads"));
}