feat: packaging stats per parent materials (#8594)

lib/ProductOpener/KnowledgePanels.pm

@@ -703,10 +703,16 @@ sub create_environment_card_panel ($product_ref, $target_lc, $target_cc, $option
 			$panel_data_ref, $product_ref, $target_lc, $target_cc, $options_ref);
 	}
 
-	# Create panel for packaging recycling
+	# Create panel for packaging components, and packaging materials
 	create_panel_from_json_template("packaging_recycling",
 		"api/knowledge-panels/environment/packaging_recycling.tt.json",
 		$panel_data_ref, $product_ref, $target_lc, $target_cc, $options_ref);
+	create_panel_from_json_template("packaging_materials",
+		"api/knowledge-panels/environment/packaging_materials.tt.json",
+		$panel_data_ref, $product_ref, $target_lc, $target_cc, $options_ref);
+	create_panel_from_json_template("packaging_components",
+		"api/knowledge-panels/environment/packaging_components.tt.json",
+		$panel_data_ref, $product_ref, $target_lc, $target_cc, $options_ref);
 
 	# Create panel for manufacturing place
 	create_manufacturing_place_panel($product_ref, $target_lc, $target_cc, $options_ref);

lib/ProductOpener/Packaging.pm

@@ -49,6 +49,7 @@ BEGIN {
 		&parse_packaging_component_data_from_text_phrase
 		&guess_language_of_packaging_text
 		&apply_rules_to_augment_packaging_component_data
+		&aggregate_packaging_by_parent_materials
 
 		%packaging_taxonomies
 	);    # symbols to export on request
@@ -66,6 +67,9 @@ use ProductOpener::Numbers qw/:all/;
 use ProductOpener::Units qw/:all/;
 use ProductOpener::ImportConvert qw/:all/;
 
+use Data::DeepAccess qw(deep_get deep_val);
+use List::Util qw(first);
+
 =head1 FUNCTIONS
 
 =head2 extract_packagings_from_image( $product_ref $id $ocr_engine $results_ref )
@@ -776,27 +780,29 @@ Set some tags in the /misc/ facet so that we can track the products that have
 
 sub set_packaging_misc_tags ($product_ref) {
 
-	remove_tag($product_ref, "misc", "en:packagings-complete");
-	remove_tag($product_ref, "misc", "en:packagings-not-complete");
-	remove_tag($product_ref, "misc", "en:packagings-empty");
-	remove_tag($product_ref, "misc", "en:packagings-not-empty");
-	remove_tag($product_ref, "misc", "en:packagings-not-empty-but-not-complete");
-	remove_tag($product_ref, "misc", "en:packagings-with-weights");
-	remove_tag($product_ref, "misc", "en:packagings-with-all-weights");
-	remove_tag($product_ref, "misc", "en:packagings-with-all-weights-complete");
-	remove_tag($product_ref, "misc", "en:packagings-with-all-weights-not-complete");
-	remove_tag($product_ref, "misc", "en:packagings-with-some-but-not-all-weights");
+	if (defined $product_ref->{misc_tags}) {
+		remove_tag($product_ref, "misc", "en:packagings-complete");
+		remove_tag($product_ref, "misc", "en:packagings-not-complete");
+		remove_tag($product_ref, "misc", "en:packagings-empty");
+		remove_tag($product_ref, "misc", "en:packagings-not-empty");
+		remove_tag($product_ref, "misc", "en:packagings-not-empty-but-not-complete");
+		remove_tag($product_ref, "misc", "en:packagings-with-weights");
+		remove_tag($product_ref, "misc", "en:packagings-with-all-weights");
+		remove_tag($product_ref, "misc", "en:packagings-with-all-weights-complete");
+		remove_tag($product_ref, "misc", "en:packagings-with-all-weights-not-complete");
+		remove_tag($product_ref, "misc", "en:packagings-with-some-but-not-all-weights");
+
+		# Remove previous misc tag for the number of components
+		foreach my $tag ($product_ref->{misc_tags}) {
+			if ($tag =~ /^en:packagings-number-of-components-/) {
+				remove_tag($product_ref, "misc", $tag);
+			}
+		}
+	}
 
 	# Number of packaging components
 	my $number_of_packaging_components
 		= (defined $product_ref->{packagings} ? scalar @{$product_ref->{packagings}} : 0);
-
-	# Remove previous misc tag for the number of components
-	foreach my $tag ($product_ref->{misc_tags}) {
-		if ($tag =~ /^en:packagings-number-of-components-/) {
-			remove_tag($product_ref, "misc", $tag);
-		}
-	}
 	# Add the tag for the new number of components
 	add_tag($product_ref, "misc", "en:packagings-number-of-components-" . $number_of_packaging_components);
 
@@ -846,6 +852,73 @@ sub set_packaging_misc_tags ($product_ref) {
 	return;
 }
 
+=head2 aggregate_packaging_by_parent_materials ($product_ref)
+
+Aggregate the weights of each packaging component by parent material (glass, plastics, metal, paper or cardboard)
+
+=cut
+
+sub aggregate_packaging_by_parent_materials ($product_ref) {
+
+	delete $product_ref->{packagings_materials};
+
+	# We will return an empty hash if we have no packagings components
+	my $packagings_materials_ref = {};
+
+	if ((defined $product_ref->{packagings}) and (scalar @{$product_ref->{packagings}} > 0)) {
+
+		# If we have packaging components, we will also return a total entry for all materials
+		$packagings_materials_ref->{"all"} = {};
+
+		# Iterate over each packaging component
+		foreach my $packaging_ref (@{$product_ref->{packagings}}) {
+
+			# Determine what is the parent material for the component
+			my $material = $packaging_ref->{material};
+			my $parent_material = "en:unknown";
+			if (defined $material) {
+				$parent_material = (first {is_a("packaging_materials", $material, $_)}
+						("en:paper-or-cardboard", "en:plastic", "en:glass", "en:metal")) // "en:unknown";
+			}
+
+			# Initialize the entry for the parent material if needed (even if we have no weight,
+			# it is useful to know that there is some parent material used)
+			if (not defined $packagings_materials_ref->{$parent_material}) {
+				$packagings_materials_ref->{$parent_material} = {};
+			}
+
+			# Weight per unit
+			my $weight = $packaging_ref->{weight_specified} // $packaging_ref->{weight_measured};
+			if (defined $weight) {
+				# Assume we have 1 unit if not specified
+				my $total_weight = ($packaging_ref->{number_of_units} || 1) * $weight;
+
+				# Add the weight to the parent material, and to a special "all" entry for all materials
+				deep_val($packagings_materials_ref, $parent_material, "weight") += $total_weight;
+				deep_val($packagings_materials_ref, "all", "weight") += $total_weight;
+			}
+		}
+
+		# Iterate over each parent material to compute weight statistics
+		my $total_weight = deep_get($packagings_materials_ref, "all", "weight");
+		foreach my $parent_material_ref (values %$packagings_materials_ref) {
+			if (defined $parent_material_ref->{weight}) {
+				if ($total_weight) {
+					$parent_material_ref->{weight_percent} = $parent_material_ref->{weight} / $total_weight * 100;
+				}
+				if ($product_ref->{product_quantity}) {
+					$parent_material_ref->{weight_100g}
+						= $parent_material_ref->{weight} / $product_ref->{product_quantity} * 100;
+				}
+			}
+		}
+	}
+
+	$product_ref->{packagings_materials} = $packagings_materials_ref;
+
+	return;
+}
+
 =head2 initialize_packagings_structure_with_data_from_packaging_text ($product_ref, $response_ref) 
 
 This function populates the packagings structure with data extracted from the packaging_text field.
@@ -962,6 +1035,9 @@ sub analyze_and_combine_packaging_data ($product_ref, $response_ref) {
 	# Set packaging facets tags for shape, material and recycling
 	set_packaging_facets_tags($product_ref);
 
+	# Aggregate data per parent material
+	aggregate_packaging_by_parent_materials($product_ref);
+
 	$log->debug("analyze_and_combine_packaging_data - done",
 		{packagings => $product_ref->{packagings}, response => $response_ref})
 		if $log->is_debug();

po/common/common.pot

@@ -6698,3 +6698,19 @@ msgstr "Sugars should not be higher than carbohydrates."
 msgctxt "product_js_saturated_fat_warning"
 msgid "Saturated fat should not be higher than fat."
 msgstr "Saturated fat should not be higher than fat."
+
+msgctxt "packaging_materials"
+msgid "Packaging materials"
+msgstr "Packaging materials"
+
+msgctxt "packaging_weight_total"
+msgid "Packaging weight"
+msgstr "Packaging weight"
+
+msgctxt "packaging_weight_100g"
+msgid "Packaging weight per 100 g of product"
+msgstr "Packaging weight per 100 g of product"
+
+msgctxt "total"
+msgid "Total"
+msgstr "Total"

po/common/en.po

@@ -6708,3 +6708,19 @@ msgstr "Sugars should not be higher than carbohydrates."
 msgctxt "product_js_saturated_fat_warning"
 msgid "Saturated fat should not be higher than fat."
 msgstr "Saturated fat should not be higher than fat."
+
+msgctxt "packaging_materials"
+msgid "Packaging materials"
+msgstr "Packaging materials"
+
+msgctxt "packaging_weight_total"
+msgid "Packaging weight"
+msgstr "Packaging weight"
+
+msgctxt "packaging_weight_100g"
+msgid "Packaging weight per 100 g of product"
+msgstr "Packaging weight per 100 g of product"
+
+msgctxt "total"
+msgid "Total"
+msgstr "Total"

po/common/fr.po

@@ -6534,3 +6534,18 @@ msgctxt "join_the_next_pros_meet_up"
 msgid "Join the next Pros' Meet-up"
 msgstr "Rejoignez la prochaine rencontre des professionnels"
 
+msgctxt "packaging_materials"
+msgid "Packaging materials"
+msgstr "Matières d'emballage"
+
+msgctxt "packaging_weight_total"
+msgid "Packaging weight"
+msgstr "Poids de l'emballage"
+
+msgctxt "packaging_weight_100g"
+msgid "Packaging weight per 100 g of product"
+msgstr "Poids de l'emballage pour 100 g de produit"
+
+msgctxt "total"
+msgid "Total"
+msgstr "Total"

taxonomies/packaging_materials.txt

@@ -1049,6 +1049,10 @@ pt:Bateria de zinco-carbono, pilha de zinco-carbono
 xx:14 CZ, CZ 14
 wikidata:en:Q28765
 
+en:Paper or cardboard
+fr:Papier ou carton
+
+<en:Paper or cardboard
 en:Cardboard, fiberboard, fibreboard
 bg:Картон
 ca:cartó
@@ -1152,6 +1156,7 @@ pt:Cartão FSC
 en:Grass carton
 de:Graskarton
 
+<en:Paper or cardboard
 en:Paper
 bg:Хартия
 da:Papir

templates/api/knowledge-panels/environment/environment_card.tt.json

@@ -38,7 +38,7 @@
                 "title": "[% lang('ecoscore_packaging') %]",
                 "panel_group_id": "packaging_recycling",
                 "panel_ids": [
-                    "packaging_recycling"
+                    "packaging_recycling",
                 ],
                 [% IF panel.packaging_image.defined %]
                 "image": [% encode_json(panel.packaging_image) %],

templates/api/knowledge-panels/environment/packaging_components.tt.json

@@ -0,0 +1,65 @@
+// Create a structure so that we can display the packaging components for each recycling type
+[% SET recycling_types = {} %]
+[% SET unknown = "en:unknown" %]
+[% IF product.packagings %]
+    [%# Check which of recycling / discard / unknown packaging types we have to build each panel (one for each) %]
+    [% FOREACH packaging IN product.packagings %]
+        [% IF packaging.recycling.defined AND ((packaging.recycling == "en:discard") OR (packaging.recycling == "en:recycle")) %]
+            [% SET recycling_types.${packaging.recycling} = 1 %]
+        [% ELSE %]
+            [% SET recycling_types.$unknown = 1 %]
+        [% END %]
+    [% END %]
+[% END %]
+
+{
+    "level" :"info",
+    "topics": [
+        "environment"
+    ],
+    "title_element": {
+        "title": "[% lang('packaging_parts') %]",           
+    },    
+    "expanded": true,
+    "elements": [
+        [% FOREACH recycling_type IN ["en:recycle", "en:discard", "en:unknown"] %]
+            [% IF recycling_types.$recycling_type.defined %]
+            {
+                "element_type": "text",
+                "text_element": {
+                    "type": "summary",
+                    "icon_color_from_evaluation": true,
+                    [% IF recycling_type == "en:recycle" %]
+                    "evaluation": "good",
+                    "icon_url": "[% static_subdomain %]/images/icons/dist/recycle-variant.svg",
+                    "icon_alt": "[% display_taxonomy_tag_name("packaging_recycling",recycling_type) %]",
+                    [% ELSIF recycling_type == "en:discard" %]
+                    "evaluation": "bad",
+                    "icon_url": "[% static_subdomain %]/images/icons/dist/delete.svg",
+                    "icon_alt": "[% display_taxonomy_tag_name("packaging_recycling",recycling_type) %]",
+                    [% ELSE %]
+                    "evaluation": "neutral",
+                    "icon_url": "[% static_subdomain %]/images/icons/dist/help.svg",
+                    "icon_alt": "[% lang('unknown') %]",
+                    [% END %]                
+                    "html": `
+                        [% FOREACH packaging IN product.packagings %]
+                            [% IF packaging.recycling == recycling_type OR (recycling_type == "en:unknown" AND ((NOT packaging.recycling.defined) OR ((packaging.recycling != "en:discard") AND (packaging.recycling != "en:recycle")))) %]
+                                [% IF packaging.number_of_units %][% packaging.number_of_units %] x [% END %]
+                                <strong>
+                                    [% display_taxonomy_tag_name('packaging_shapes',packaging.shape) %]
+                                    [% IF packaging.quantity_per_unit %][% packaging.quantity_per_unit %] [% END %]
+                                </strong>
+                                    [% IF packaging.material %]
+                                        ([% display_taxonomy_tag_name('packaging_materials',packaging.material) %][% IF packaging.weight_specified %][% sep %]: [% packaging.weight_specified %] g[% ELSIF packaging.weight_measured %][% sep %]: [% packaging.weight_measured %] g[% END %])
+                                    [% END %]
+                                    <br>
+                            [% END %]
+                        [% END %]
+                        `
+                }
+            },
+            [% END %]
+        [% END %]
+    ]
+}