From 6a7436dbf04b13e4cef0ba0342c55a8d5b43e720 Mon Sep 17 00:00:00 2001
From: Bernd Bestel <bernd@berrnd.de>
Date: Mon, 3 Feb 2025 18:36:10 +0100
Subject: [PATCH] Persist shopping list print settings (closes #2667)

---
 changelog/79_UNRELEASED_xx-xx-xxxx.md |  2 +-
 config-dist.php                       |  3 ++
 public/viewjs/shoppinglist.js         | 73 +++++++++++++++++----------
 3 files changed, 51 insertions(+), 27 deletions(-)

diff --git a/changelog/79_UNRELEASED_xx-xx-xxxx.md b/changelog/79_UNRELEASED_xx-xx-xxxx.md
index 12582126..b810926f 100644
--- a/changelog/79_UNRELEASED_xx-xx-xxxx.md
+++ b/changelog/79_UNRELEASED_xx-xx-xxxx.md
@@ -14,7 +14,7 @@
 
 ### Shopping list
 
-- xxx
+- The print options (show header, layout type etc.) are now saved (as user settings, so global defaults can also defined in `config.php` as usual)
 
 ### Recipes
 
diff --git a/config-dist.php b/config-dist.php
index 4267c75e..717222ca 100644
--- a/config-dist.php
+++ b/config-dist.php
@@ -202,6 +202,9 @@ DefaultUserSetting('shopping_list_show_calendar', false); // When enabled, a sma
 DefaultUserSetting('shopping_list_round_up', false); // When enabled, all quantity amounts on the shopping list are always displayed rounded up to the nearest whole number
 DefaultUserSetting('shopping_list_auto_add_below_min_stock_amount', false); // If products should be automatically added to the shopping list when they are below their min. stock amount
 DefaultUserSetting('shopping_list_auto_add_below_min_stock_amount_list_id', 1); // When the above setting is enabled, the id of the shopping list to which the products will be added
+DefaultUserSetting('shopping_list_print_show_header', true); // Default for the shopping list print option "Show header"
+DefaultUserSetting('shopping_list_print_group_by_product_group', true); // Default for the shopping list print option "Group by product group"
+DefaultUserSetting('shopping_list_print_layout_type', 'table'); // Default for the shopping list print option "Layout type" (table or list)
 
 // Recipe settings
 DefaultUserSetting('recipe_ingredients_group_by_product_group', false); // Group recipe ingredients by their product group
diff --git a/public/viewjs/shoppinglist.js b/public/viewjs/shoppinglist.js
index 51c169c7..8da79494 100644
--- a/public/viewjs/shoppinglist.js
+++ b/public/viewjs/shoppinglist.js
@@ -375,12 +375,38 @@ OnListItemRemoved();
 
 $(document).on("click", "#print-shopping-list-button", function(e)
 {
+	var checkedPrintShowHeader = "";
+	if (BoolVal(Grocy.UserSettings.shopping_list_print_show_header))
+	{
+		checkedPrintShowHeader = "checked";
+	}
+
+	var checkedGroupByProductGroup = "";
+	if (BoolVal(Grocy.UserSettings.shopping_list_print_group_by_product_group))
+	{
+		checkedGroupByProductGroup = "checked";
+	}
+
+	var checkedLayoutTypeTable = "";
+	var checkedLayoutTypeList = "";
+	if (Grocy.UserSettings.shopping_list_print_layout_type == "table")
+	{
+		checkedLayoutTypeTable = "checked";
+		checkedLayoutTypeList = "";
+	}
+	else
+	{
+		checkedLayoutTypeTable = "";
+		checkedLayoutTypeList = "checked";
+	}
+
 	var dialogHtml = ' \
 	<div class="text-center"><h5>' + __t('Print options') + '</h5><hr></div> \
 	<div class="custom-control custom-checkbox"> \
 		<input id="print-show-header" \
-			 checked \
-			class="form-check-input custom-control-input" \
+			 ' + checkedPrintShowHeader + ' \
+			class="form-check-input custom-control-input user-setting-control" \
+			data-setting-key="shopping_list_print_show_header" \
 			type="checkbox" \
 			value="1"> \
 		<label class="form-check-label custom-control-label" \
@@ -389,8 +415,9 @@ $(document).on("click", "#print-shopping-list-button", function(e)
 	</div> \
 	<div class="custom-control custom-checkbox"> \
 		<input id="print-group-by-product-group" \
-			 checked \
-			class="form-check-input custom-control-input" \
+			 ' + checkedGroupByProductGroup + ' \
+			class="form-check-input custom-control-input user-setting-control" \
+			data-setting-key="shopping_list_print_group_by_product_group" \
 			type="checkbox" \
 			value="1"> \
 		<label class="form-check-label custom-control-label" \
@@ -400,21 +427,24 @@ $(document).on("click", "#print-shopping-list-button", function(e)
 	<h5 class="pt-3 pb-0">' + __t('Layout type') + '</h5> \
 	<div class="custom-control custom-radio"> \
 		<input id="print-layout-type-table" \
-			checked \
-			class="custom-control-input" \
+			' + checkedLayoutTypeTable + ' \
+			class="custom-control-input user-setting-control" \
+			data-setting-key="shopping_list_print_layout_type" \
 			type="radio" \
 			name="print-layout-type" \
-			value="print-layout-type-table"> \
+			value="table"> \
 		<label class="custom-control-label" \
 			for="print-layout-type-table">' + __t('Table') + ' \
 		</label> \
 	</div> \
 	<div class="custom-control custom-radio"> \
 		<input id="print-layout-type-list" \
-			class="custom-control-input" \
+		' + checkedLayoutTypeList + ' \
+			class="custom-control-input user-setting-control" \
+			data-setting-key="shopping_list_print_layout_type" \
 			type="radio" \
 			name="print-layout-type" \
-			value="print-layout-type-list"> \
+			value="list"> \
 		<label class="custom-control-label" \
 			for="print-layout-type-list">' + __t('List') + ' \
 		</label> \
@@ -442,7 +472,7 @@ $(document).on("click", "#print-shopping-list-button", function(e)
 					message: '<p><i class="fa fa-spin fa-spinner"></i> ' + __t('Connecting to printer...') + '</p>'
 				});
 
-				//Delaying for one second so that the alert can be closed
+				// Delaying for one second so that the alert can be closed
 				setTimeout(function()
 				{
 					Grocy.Api.Get('print/shoppinglist/thermal?list=' + $("#selected-shopping-list").val() + '&printHeader=' + printHeader,
@@ -454,17 +484,21 @@ $(document).on("click", "#print-shopping-list-button", function(e)
 						{
 							console.error(xhr);
 							var validResponse = true;
+
 							try
 							{
 								var jsonError = JSON.parse(xhr.responseText);
-							} catch (e)
+							}
+							catch (e)
 							{
 								validResponse = false;
 							}
+
 							if (validResponse)
 							{
 								thermalPrintDialog.find('.bootbox-body').html(__t('Unable to print') + '<br><pre><code>' + jsonError.error_message + '</pre></code>');
-							} else
+							}
+							else
 							{
 								thermalPrintDialog.find('.bootbox-body').html(__t('Unable to print') + '<br><pre><code>' + xhr.responseText + '</pre></code>');
 							}
@@ -500,7 +534,7 @@ $(document).on("click", "#print-shopping-list-button", function(e)
 				}
 
 				$(".print-layout-container").addClass("d-none");
-				$("." + $("input[name='print-layout-type']:checked").val()).removeClass("d-none");
+				$(".print-layout-type-" + $("input[name='print-layout-type']:checked").val()).removeClass("d-none");
 
 				window.print();
 			}
@@ -523,19 +557,6 @@ $(document).on("click", "#print-shopping-list-button", function(e)
 	});
 });
 
-$(document).on("change", "input[name='print-layout-type']", function(e)
-{
-	if (this.value == "print-layout-type-list")
-	{
-		$("#print-group-by-product-group").prop("checked", false);
-		$("#print-group-by-product-group").attr("disabled", "");
-	}
-	else
-	{
-		$("#print-group-by-product-group").removeAttr("disabled");
-	}
-});
-
 $("#description").on("summernote.change", function()
 {
 	$("#save-description-button").removeClass("disabled");